Skip to main content

Get Current Invoice

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, PaymentReferenceNo and, if a payment has been moved, MovedToPaymentRef are returned. The account can be identified either by providing the InvoiceNo or the PaymentReference in the request, but not both.

Request Parameters

Password1false50stringThe password used to authorize the request.
Username1false50stringThe username used to authorize the request.
CorrelationId1true50stringCorrelationID is sent back in the response.
CountryCode1false2stringThe country code (ISO 3166-1 alpha-2) for the country.
InvoiceNo1true50intThe invoice number. Either InvoiceNo or PaymentReference must be set, but not both.
PaymentReference1true50stringThe payment reference. Either PaymentReference or InvoiceNo must be set, but not both.
StoreId1true-intThe StoreId used for identification of store.

Response Parameters

CorrelationId1true50stringCorrelationID from the request if any.
CreditTime1false2intThe remaining credit time, in months, of the invoice.
Currency1false3stringThe Currency Code (ISO 4217 alpha-3)
DueDate1false-datetimeThe date the invoice is due.
InvoiceNo1false50stringInvoice number of the latest invoice
InvoiceURL1false-stringURL to the invoice
LowestAmountToPay1false6,2decimalLowest amount to pay on the invoice.
MovedToPaymentRef1true-stringIf 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.
NotificationDate1false-datetimeThe notification date of the invoice.
NotificationType1false-stringThe type of invoice, possible values see below.
NumberOfReminders1false1intNumber of reminders if any.
OrderNo1true20stringThe invoice order number if any.
PaymentPlan1true6,2decimalThe lowest amount to pay to stay on the current payment plan.
PaymentReference1false50stringThe invoices payment reference.
PaymentStatus1false-stringStatus of invoice payment, possible values see below.
TotalAmount1false6,2decimalInvoice total amount.

Notification Types

  • Direct Invoice
  • Direct Invoice Reminder
  • Invoice
  • Invoice Reminder
  • Part Payment
  • Part Payment Reminder
  • Credit Account Invoice
  • Credit Account Invoice Reminder
  • Interest Free
  • Interest Free Part Payment
  • Interest Free Part Payment Reminder
  • Annuity
  • Annuity Reminder

Payment Status

  • In Debt
  • Not Paid
  • Partially Paid
  • Fully Paid

Example Requests

Description:The operation returns details of the Specified invoice.

<soapenv:Envelope xmlns:soapenv="" xmlns:inf="">
<inf:CorrelationId xsi:nil="true" xmlns:xsi=""/>
<inf:PaymentReference xsi:nil="true" xmlns:xsi=""/>

Error Codes

Fault CodeDescription
AUTHORIZATION_FAILEDCould not authorize the request, check your login credentials. Please contact Collector for more help.
INVOICE_NOT_FOUNDSpecified Invoice could not be found.

If the error code you are looking for is not in the list above Please see separate page Error Codes