Sign in

v1

latestOpenAPI 3.0.32026-07-26208618579.9 KB
Get invoice information

Get invoice for given reference number

This operation will respond with an invoice given invoice reference number (payment reference number)

get/v1/referenceNumber/{referenceNumber}

Path parameters

referenceNumberstring required

Invoice reference number for given invoice

Query parameters

auditUserstring required

The audit user to log the request

Response

Successful lookup of invoice for given reference number

currencystring

A valid ISO 4217 currency code

amountnumber

Total amount of this invoice

createdDatestring date-time

Date when invoice was created

dueDatestring date

The due date

idstring

Unique transaction id

paidAmountnumber

The paid amount.

status'CLOSED' | 'OPEN' | 'OVERDUE' | 'PAID' | 'PAID_PARTIALLY' | 'WRITE-OFF'
invoiceNumberstring

Number of the invoice

accountIdstring

The account id card is linked to

Example response

{
  "currency": "EUR",
  "createdDate": "2019-11-27T05:08:31",
  "paidAmount": 20,
  "period": {
    "start": "2020-01-01",
    "end": "2020-01-31"
  },
  "dunning": {
    "reminder1TriggerDate": "2019-11-27",
    "blockTriggerDate": "2019-11-27",
    "reminder2TriggerDate": "2019-11-27",
    "collectionTriggerDate": "2019-11-27"
  },
  "accountId": "1234567890"
}