Properties
| Name | Type | Description |
|---|---|---|
| code* | string | The unique code identifier for the invoice. |
The unique code identifier for the invoice. | ||
| invoiceNumber* | string | The customer-facing invoice number (e.g., "INV-000001"). |
The customer-facing invoice number (e.g., "INV-000001"). | ||
| companyName* | string | The company name of the invoice issuer. |
The company name of the invoice issuer. | ||
| vatNumber* | string | The VAT registration number of the invoice issuer. |
The VAT registration number of the invoice issuer. | ||
| status | enum | Defines the status of a billing invoice. |
Defines the status of a billing invoice. | ||
| subtotalAmount | number | The subtotal amount (sum of line items net amounts) before VAT, in pounds. |
The subtotal amount (sum of line items net amounts) before VAT, in pounds. | ||
| vatAmount | number | The total VAT amount (sum of line item VAT amounts) in pounds. |
The total VAT amount (sum of line item VAT amounts) in pounds. | ||
| totalAmount | number | The total amount of the invoice (subtotal + VAT) in pounds. |
The total amount of the invoice (subtotal + VAT) in pounds. | ||
| dueDate | string | The date when payment is due. |
The date when payment is due. | ||
| paidDate | string | The date and time when payment was received. |
The date and time when payment was received. | ||
| failureReason | string | The reason for payment failure, if applicable. |
The reason for payment failure, if applicable. | ||
| pdfBlobUrl | string | Time-limited URL for downloading the invoice PDF. Null if PDF has not been generated. |
Time-limited URL for downloading the invoice PDF. Null if PDF has not been generated. | ||
| lineItems | array of InvoiceLineItemResponse | The line items included in this invoice. |
The line items included in this invoice. | ||
| invoiceDate | string | The invoice date (UTC): when it was issued, or an imported invoice's own date. Null on a draft. |
The invoice date (UTC): when it was issued, or an imported invoice's own date. Null on a draft. | ||
| createdDate | string | When Account Hub created the record (a draft opens when its first line arrives). |
When Account Hub created the record (a draft opens when its first line arrives). | ||
| sourceApplicationCode | string | The application that raised an imported invoice, which Account Hub only records; null for |
The application that raised an imported invoice, which Account Hub only records; null for | ||
| accountingInvoice | AccountingLinkResponse | |
JSON Example
{
"code": "string",
"invoiceNumber": "string",
"companyName": "string",
"vatNumber": "string",
"status": "Draft"
}