Overview

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.

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
currency_id	string	The Platform’s ID of the currency for the 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_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
sales_orders	object	Array of linked Sales Order Ids associated with this invoice
updated_at	date	The date at which the information was updated on the accounting platform

Expandable Attributes

You can expand the following attributes to get the related data

Property	Data Model	Description
contact	Contacts	The contact that made the invoice
currency	Currencies	The currency of the invoice
invoice_payments	invoice Payments	The invoice payments associated to the invoice
documents	Documents	The documents attached to the invoice
addresses	Addresses	The addresses associated with the invoice
line_items	Line Item	The line items associated with the invoice

Addresses

Property	Type	Description
platform_id	string	Platform's ID for the address
type	enum	The type of address. Values are: BILLING, SHIPPING.
data_model	string	The data model to which this address is linked. Values are COMPANY_INFO, CONTACTS, INVOICES, BILLS, EXPENSES, BILL_CREDIT_NOTES, INVOICE_CREDIT_NOTES, SALES_ORDERS, PURCHASE_ORDERS
data_model_id	string	The unique identifier for the data model associated with this address
street	string	The street information of the address
locality	string	The locality or neighborhood information of the address
city	string	The city information of the address
state	string	The state or region information of the address
country	string	The country information of the address
pincode	string	The postal or zip code of the address
updated_at	date	The date and time at which the address information was last updated in the accounting platform

Line Items

Property	Type	Description
platform_id	string	Platform ID associated with this line item
item_id	string	The platform ID of the item associated with this line item
tax_id	string	The platform ID of the tax associated with this line item
account_id	string	The platform ID of the account associated with this line item
line_item_type	enum	The data model linked to the line item. Values are: BILLS, INVOICES, INVOICE_CREDIT_NOTES, BILL_CREDIT_NOTES, EXPENSES, PURCHASE_ORDERS,SALES_ORDERS,GOODS_RECEIPT_NOTES
line_item_type_id	string	The platform ID of the associated data model
description	string	The description for this line item
quantity	float	The quantity of the product/service for this line item
unit_amount	float	Price per unit for this line item
sub_total	float	The pre tax total value for this line item
tax_amount	float	The tax amount for this line item
total_amount	float	The total value of this line item
tracking_category_ids	object	The tracking category Ids associated with this line item

Line Items Expandable Attributes

You can expand the following attributes to get the related line item data

Property	Data Model	Description
item	Items	The item associated with this line item
tax_rate	Tax Rates	The tax associated with this line item
account	Accounts	The account associated to the invoice

The Invoice Response Object

{
  "platform_id": "1234567890123456789",
  "account_id": "1234567890123456789",
  "contact_id": "3770712000000080069",
  "currency_id": "3770712000000000099",
  "sales_order_ids": ["3770712000000080288"],
  "document_number": "INV-000001",
  "posted_date": "2022-09-28T00:00:00.000Z",
  "due_date": "2022-09-28T00:00:00.000Z",
  "currency_rate": 1,
  "status": "PAID",
  "total_discount": 10,
  "tax_amount": 0,
  "sub_total": 240,
  "total_amount": 230,
  "amount_due": 0,
  "memo": "Thanks for your business.",
  "updated_at": "2022-09-28T00:00:00.000Z"
}