Skip to main content
GET
/
v1
/
referenceNumber
/
{referenceNumber}
Get invoice for given reference number
curl --request GET \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/invoice/v1/referenceNumber/{referenceNumber}' \
  --header 'Authorization: Basic <encoded-value>'
{
  "amount": 123,
  "createdDate": "2019-11-27T05:08:31",
  "dueDate": "2019-11-27",
  "id": "<string>",
  "paidAmount": 123,
  "paymentReference": {
    "number": 1234567897
  },
  "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"
  },
  "invoiceNumber": "<string>",
  "accountId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
referenceNumber
string
required

Invoice reference number for given invoice

Query Parameters

​
auditUser
string
required

The audit user to log the request

Response

Successful lookup of invoice for given reference number

​
amount
number

Total amount of this invoice

​
createdDate
string<date-time>

Date when invoice was created

Example:

"2019-11-27T05:08:31"

​
dueDate
string<date>

Date when invoice is due

Example:

"2019-11-27"

​
id
string

Unique id for invoice

​
paidAmount
number

Total amount that is paid of this invoice

​
paymentReference
object

Number connected to account that will be used to map incoming payments to

​
period
object
​
status
enum<string>
  • OPEN Open
  • OVERDUE Overdue
  • PAID Paid
  • PAID_PARTIALLY Partially Paid
  • WRITE-OFF Written Off
Available options:
OPEN,
OVERDUE,
PAID,
PAID_PARTIALLY,
WRITE-OFF
​
dunning
dunning · object

Dunning details, this should only be populated if invoice status is overdue

​
invoiceNumber
string

Number of the invoice

​
accountId
string

Account id this invoice belongs to