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

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

Response Parameters

Field	Occurs	nullable	Max	Type	Description
CorrelationId	1	true	50	string	CorrelationID from the request if any.
CreditTime	1	false	2	int	The remaining credit time, in months, of the invoice.
Currency	1	false	3	string	The Currency Code (ISO 4217 alpha-3)
DueDate	1	false	-	datetime	The date the invoice is due.
InvoiceNo	1	false	50	string	Invoice number of the latest invoice
InvoiceURL	1	false	-	string	URL to the invoice
LowestAmountToPay	1	false	6,2	decimal	Lowest amount to pay on the invoice.
MovedToPaymentRef	1	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	1	false	-	datetime	The notification date of the invoice.
NotificationType	1	false	-	string	The type of invoice, possible values see below.
NumberOfReminders	1	false	1	int	Number of reminders if any.
OrderNo	1	true	20	string	The invoice order number if any.
PaymentPlan	1	true	6,2	decimal	The lowest amount to pay to stay on the current payment plan.
PaymentReference	1	false	50	string	The invoices payment reference.
PaymentStatus	1	false	-	string	Status of invoice payment, possible values see below.
TotalAmount	1	false	6,2	decimal	Invoice 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

	Value
Environment:	UAT
Service:	InformationService
URL:	https://ecommercetest.collector.se/v3.0/InformationServiceV2.svc?wsdl
Function:	GetCurrentInvoice
Description:	The operation returns details of the Specified invoice.
Notes:	N/A

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inf="http://schemas.ecommerce.collector.se/v30/InformationService">
   <soapenv:Header>
      <inf:Username>USERNAME</inf:Username>
      <inf:Password>PASSWORD</inf:Password>
   </soapenv:Header>
   <soapenv:Body>
      <inf:GetCurrentInvoiceRequest>
         <inf:CorrelationId xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
         <inf:CountryCode>SE</inf:CountryCode>
         <inf:InvoiceNo>73255093</inf:InvoiceNo>
         <inf:PaymentReference xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
         <inf:StoreId>1234</inf:StoreId>
      </inf:GetCurrentInvoiceRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <GetCurrentInvoiceResponse xmlns="http://schemas.ecommerce.collector.se/v30/InformationService">
         <CorrelationId i:nil="true" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"/>
         <CreditTime>24</CreditTime>
         <Currency>SEK</Currency>
         <DueDate>2021-01-31T23:59:59</DueDate>
         <InvoiceNo>73255093</InvoiceNo>
         <InvoiceURL>https://minasidor-UAT.tmtf.se/invoice?id=....&amp;language=sv-SE</InvoiceURL>
         <LowestAmountToPay>1205.00</LowestAmountToPay>
         <MovedToPaymentRef i:nil="true" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"/>
         <NotificationDate>2020-02-01T10:23:43.073</NotificationDate>
         <NotificationType>Direct Invoice</NotificationType>
         <NumberOfReminders>0</NumberOfReminders>
         <OrderNo>7107026119</OrderNo>
         <PaymentPlan i:nil="true" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"/>
         <PaymentReference>100002696235659</PaymentReference>
         <PaymentStatus>Not Paid</PaymentStatus>
         <TotalAmount>1205.00</TotalAmount>
      </GetCurrentInvoiceResponse>
   </s:Body>
</s:Envelope>

Error Codes

Fault Code	Description
AUTHORIZATION_FAILED	Could not authorize the request, check your login credentials. Please contact Collector for more help.
INVOICE_NOT_FOUND	Specified 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