Overview
An Invoice is an itemized record of goods sold or services provided to a customer.
The Invoices Data Model is designed to standardise and simplify the handling of invoice-related information across different accounting platforms.
- Unified invoice properties: The model consolidates essential invoice details, such as document number, due date, currency, status, and total amounts, making it easier to manage invoice data from various platforms.
- Linked entities: Invoices can be associated with accounts, customers, line items, payments, and sales orders, providing a complete view of the invoicing process and related transactions.
- Flexible status tracking: The model supports a range of invoice statuses, such as draft, submitted, partially paid, and overdue, for better organisation and reporting.
Attributes
The accounting Platform’s ID for this invoice
The Accounting Platform’s unique ID for the currency
Array of linked Sales Orders Id associated with this Invoice
Reference document number for the invoice
Date of the invoice as recorded by the accounting platform
The due date for the invoice as an ISO 8601 timestamp
The ISO-4217 currency
Rate between the currency of the payment and the base currency
The status of the invoice. Values are: DRAFT, SUBMITTED, PARTIALLY_PAID, PAID, OVERDUE, VOID, UNKNOWN.
Total value of discounts applied to the invoice
Total tax amount levied on the invoice
Total pre tax value of the invoice
Total value of the invoice
Total amount pending for the invoice
Description of the invoice
Array of Invoice Line items associated with the invoice.
Array of Invoice Payments associated with the Invoice.
Date the record was last updated in the accounting platform.
Properties Supported
| Property | Type | Description |
|---|---|---|
| platform_id | string | The Platform’s ID for this invoice |
| account_id | string | The platform’s ID for the account to which this invoice belongs |
| contact_id | string | The Accounting Platform’s unique ID for the contact who receives this invoice |
| document_number | string | Reference document number for the invoice |
| posted_date | date | Date of the invoice as recorded by the accounting platform |
| due_date | date | The due date for the invoice as an ISO 8601 timestamp |
| currency | string | The ISO-4217 currency code |
| currency_rate | float | Rate between the currency of the payment and the base currency |
| status | enum | The status of the invoice. Values are: DRAFT, SUBMITTED, PARTIALLY_PAID, PAID, OVERDUE, VOID, UNKNOWN |
| total_discount | float | Total value of discounts applied to the invoice |
| tax_amount | float | Total tax amount levied on the invoice |
| sub_total | float | Total pre tax value of the invoice |
| total_amount | float | Total value of the invoice |
| amount_due | float | Total amount pending for the invoice |
| memo | string | Description of the invoice |
| line_items | Line Item | Array of Invoice Line items associated with the invoice (see below) |
| payments | Invoice Payment | Array of Invoice Payments associated with the invoice |
| sales_orders | Sales Order | Array of linked Sales Orders associated with this invoice |
| documents | Document | Array of Invoice Documents associated with the invoice |
| account | Account | The account to which this invoice belongs |
| contact | Contact | The contact who receives this invoice |
| updated_at | date | Date the record was last updated in the accounting platform. |