Properties
| Name | Type | Description |
|---|---|---|
| id | string | The platform's identifier for the bill. |
The platform's identifier for the bill. | ||
| number | string | The supplier's own invoice number where the platform holds one, else the bill's reference. |
The supplier's own invoice number where the platform holds one, else the bill's reference. | ||
| supplierId | string | The platform's identifier for the supplier. |
The platform's identifier for the supplier. | ||
| supplierName | string | The supplier's name in the client's books. |
The supplier's name in the client's books. | ||
| totalAmount | number | Total including tax. |
Total including tax. | ||
| netAmount | number | Total before tax. |
Total before tax. | ||
| taxAmount | number | Tax (VAT) on the bill. |
Tax (VAT) on the bill. | ||
| amountDue | number | What the client still has to pay on the bill; less than the total once part-paid. |
What the client still has to pay on the bill; less than the total once part-paid. | ||
| date | string | The bill's date. |
The bill's date. | ||
| dueDate | string | When the client has to pay it by, where the bill says. |
When the client has to pay it by, where the bill says. | ||
| status | enum | Unknown Draft Unpaid Paid Overdue Void PartiallyPaid |
Unknown Draft Unpaid Paid Overdue Void PartiallyPaid | ||
| currency | string | ISO currency code of the bill, where the platform reports one. |
ISO currency code of the bill, where the platform reports one. | ||
| externalUrl | string | A link to the bill in the platform's own interface, where one can be built. |
A link to the bill in the platform's own interface, where one can be built. | ||
JSON Example
{
"id": "string",
"number": "string",
"supplierId": "string",
"supplierName": "string",
"totalAmount": 0
}