Overview

A record of goods or services sold to a customer

The Sales Orders Data Model standardises information related to sales orders across various accounting platforms, making it simpler to manage and access relevant data.

• Unified sales order properties: The model consolidates essential sales order information, such as contact ID, document number, dates, description, payment mode, and currency-related data.
• Financial calculations: The model includes properties for total discount, tax amount, sub-total, and total amount, facilitating accurate financial reporting and analysis.
• Invoice associations: The invoices property links sales orders to their corresponding invoices, enabling seamless navigation and cross-referencing between the two data models.

Properties Supported

Property	Type	Description
platform_id	string	Platform’s ID for the sales order
contact_id	string	The accounting platform’s unique ID of the contact associated with this sales order
document_number	string	Reference number for the sales order
posted_date	string	Date of creation of the sales order
delivery_date	string	The delivery date for the sales order
description	string	Description of the sales order
payment_mode	string	The payment mode from which the payment was made
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 sales order. Values are: DRAFT, SUBMITTED, PARTIALLY_PAID, PAID, OVERDUE, VOID, UNKNOWN
total_discount	float	Total value of discounts applied to the sales order
tax_amount	float	Total tax amount levied on the sales order
sub_total	float	Total pre tax value of the sales order
total_amount	float	Total value of the sales order
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 sales order
currency	Currencies	The currency of the sales order
documents	Documents	The documents attached to the sales order
addresses	Addresses	The addresses associated with the sales order
line_items	Line Items	The line items associated with the sales order

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 Sales Order Response Object

{
  "platform_id": "3770712000001720008",
  "contact_id": "3770712000000417001",
  "currency_id": "3770712000000000099",
  "invoice_ids": ["3770712000001720009"],
  "document_number": "SO-00035",
  "posted_date": "2023-04-01T00:00:00.000Z",
  "delivery_date": "2023-05-01T00:00:00.000Z",
  "description": "Sales Order for Yoyo Products",
  "payment_mode": null,
  "currency_rate": 1.0,
  "status": "DRAFT",
  "total_discount": 1.0,
  "tax_amount": 0.0,
  "sub_total": 19.0,
  "total_amount": 19.0,
  "updated_at": "2023-11-05T00:00:00.000Z"
}