Get invoice details.
Retrieves the invoice details of a single invoice.
PATH:
/v1/clients/{clientId}/invoices/{invoiceNumber}
PATH PARAMETERS:
clientId required
|
integer
Your assigned clientId. |
invoiceNumber required
|
string
The invoice number. |
HYPERMEDIA CONTROLS:
-
Pauses the dunning on an invoice.
-
Creates a credit note for an invoice.
-
Resume the dunning on an invoice.
-
Changes the due date on an invoice.
-
Sends a copy of an invoice document.
-
reset
-
customer
RESPONSES:
RESPONSE SCHEMA:
invoiceNumber |
string <= 20 characters
The unique identifier of an invoice. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoiceDate |
string date-time
Date of the invoice. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dueDate |
string date-time
Date of when the invoice is due by. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createdAt |
string date-time
Date and time of when the invoice was created. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updatedAt |
string date-time
Date and time of when the last update to the invoice occurred, if any. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
remainingAmount |
number double
Amount owed. Any credited amounts are deducted. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total object
Total amount. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
paymentMeans object
Information about payment reference of an invoice. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
references object
Customer reference. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
array of metadata
Metadata. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array () [
] |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isPaused |
boolean
Whether the dunning process is put on pause or not. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pauseEndDate |
string date-time
When the pause of the dunning process ends.If dunning process is not paused this will not be present. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
array of invoiceLines
The items that makes up the invoice. If specified on creation.Invoices might not contain any invoice lines. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array () [
] |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
array of creditNotes
Credit note that has been issued against an invoice. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array () [
] |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer object
Customer Information. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
array of _links
Links to other API endpoints which can be used to take action on this invoice. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array () [
] |
RESPONSE SCHEMA:
type |
string
no description in swagger file |
category |
string Enum: BusinessError TechnicalError
no description in swagger file |
title |
string
no description in swagger file |
message |
string
no description in swagger file |
detail |
string
There is an error message. |
customerFacingMessage |
string
no description in swagger file |
RESPONSE SCHEMA:
type |
string
no description in swagger file |
category |
string Enum: BusinessError TechnicalError
no description in swagger file |
title |
string
no description in swagger file |
message |
string
no description in swagger file |
detail |
string
There is an error message. |
customerFacingMessage |
string
no description in swagger file |
RESPONSE SCHEMA:
type |
string
no description in swagger file |
category |
string Enum: BusinessError TechnicalError
no description in swagger file |
title |
string
no description in swagger file |
message |
string
no description in swagger file |
detail |
string
There is an error message. |
customerFacingMessage |
string
no description in swagger file |
RESPONSE SCHEMA:
type |
string
no description in swagger file |
category |
string Enum: BusinessError TechnicalError
no description in swagger file |
title |
string
no description in swagger file |
message |
string
no description in swagger file |
detail |
string
There is an error message. |
customerFacingMessage |
string
no description in swagger file |
Path
/v1/clients/{clientId}/invoices/{invoiceNumber}
Response samples
200401403404500- {
- "invoiceNumber": "string",
- "invoiceDate": "string",
- "dueDate": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "remainingAmount": 1.00,
- "total": { ... },
- "paymentMeans": { ... },
- "references": { ... },
- "metadata": [ ... ],
- "isPaused": true,
- "pauseEndDate": "string",
- "invoiceLines": [ ... ],
- "creditNotes": [ ... ],
- "customer": { ... },
- "_links": [ ... ]
- {
- "type": "string",
- "category": "string",
- "title": "string",
- "message": "string",
- "detail": "string",
- "customerFacingMessage": "string"
- {
- "type": "string",
- "category": "string",
- "title": "string",
- "message": "string",
- "detail": "string",
- "customerFacingMessage": "string"
- {
- "type": "string",
- "category": "string",
- "title": "string",
- "message": "string",
- "detail": "string",
- "customerFacingMessage": "string"
- {
- "type": "string",
- "category": "string",
- "title": "string",
- "message": "string",
- "detail": "string",
- "customerFacingMessage": "string"