GetCurrentInvoice retrieves the current invoice of the account associated with the invoice number or payment reference given in the request. If no account is found for the given request an exception will be returned.

If the specified account does not have an invoice created yet, only Currency and PaymentReferenceNo are returned. If a payment has been moved, MovedToPaymentRef, is also returned. 

The account can be identified either by providing the InvoiceNo or the PaymentReference in the request, but not both.

This method is available in the following countries:
   
Input Parameters:

Field nillable Max Type Description
Username false 50 string The username used to authorize the request.
Password false 50 string The password used to authorize the request.
CorrelationId true 50 string CorrelationID is sent back in the response.
CountryCode false 2 string The country code (ISO 3166-1 alpha-2) for the country.
InvoiceNo true 20 string The invoice number. Either InvoiceNo or PaymentReference must be set, but not both.
PaymentReference true 50 string The payment reference. Either PaymentReference or InvoiceNo must be set, but not both.
StoreId true 4 short The StoreId used for identification of store.

 

Output Parameters:

Field nillable Max Type Description
CorrelationId true 50 string CorrelationID from the request if any.
CreditTime true 2 string The remaining credit time of the invoice.
Currency false 3 string The invoices currency.
DueDate true - DateTime The date the invoice is due.
InvoiceNo true 50 string The invoice number of the invoice.
InvoiceURL true - string A URL to a pdf of the invoice.
LowestAmountToPay true 6,2 decimal The lowest amount to pay on the invoice.
MovedToPaymentRef true - string If the invoice has been moved to another account, this is the new accounts payment reference. If the invoice has not been moved, this returns null.
NotificationDate true - DateTime The notification date of the invoice.
NotificationType true - string The type of the invoice, possible values are:
  • Part Payment
  • Part Payment Reminder
  • Invoice
  • Invoice Reminder
  • Direct Invoice
  • Direct Invoice Reminder
  • Credit Account Invoice
  • Credit Account Invoice Reminder
  • Interest Free
  • Interest Free Part Payment
  • Interest Free Part Payment Reminder
NumberOfReminders true 1 int The number of reminders on the invoice.
OrderNo true 20 string The invoices order number.
PaymentPlan true 6,2 decimal The lowest amount to pay to stay on the current payment plan.
PaymentReference true 50 string The invoices payment reference.
PaymentStatus true - string The payment status of the invoice, possible values are:
  • In Debt.
  • Not Paid
  • Partially Paid
  • Fully Paid
TotalAmount true 6,2 decimal The total amount of the invoice.