Overview

The Sales Orders Data Model represents a record of goods or services sold to a customer. This unified model standardizes information related to sales orders across various accounting platforms.

Unified sales order properties: Essential sales order information, such as contact ID, document number, dates, description, payment mode, and currency-related data, are standardized across different accounting platforms
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

Attributes

Sales Order Attributes

Property	Type	Description
rootfi_id	integer	Unique identifier assigned by Commenda for this sales order
rootfi_created_at	string	Timestamp when this record was created in Commenda’s system (ISO 8601)
rootfi_updated_at	string	Timestamp when this record was last updated in Commenda’s system (ISO 8601)
rootfi_company_id	integer	Company identifier this sales order belongs to within Commenda
platform_id	string	Unique identifier for this sales order in the source accounting platform
platform_unique_id	string	Alternative unique identifier from the platform (some platforms provide multiple IDs)
contact_id	string	The contact ID of the sales order
currency_id	string	The currency ID of the sales order
document_number	string	The document number of the sales order
posted_date	string	The posted date of the sales order
delivery_date	string	The delivery date of the sales order
description	string	The description of the sales order
payment_mode	string	The payment mode of the sales order
currency_rate	double	The currency rate of the sales order
status	enum	The status of the sales order
total_discount	double	The total discount of the sales order
tax_amount	double	The tax amount of the sales order
sub_total	double	The sub total of the sales order
total_amount	double	The total amount of the sales order
updated_at	string	The date and time the sales order was last updated
invoice_ids	array	The invoice IDs associated with the sales order
line_items	array	The line items of the sales order

Status Enum Values

Value	Description
`draft`	Sales order is in draft status and has not been finalized
`submitted`	Sales order has been submitted but not yet paid
`partially_paid`	Sales order has received partial payment
`paid`	Sales order has been fully paid
`overdue`	Sales order has passed its due date without payment
`void`	Sales order has been voided or cancelled
`unknown`	Status cannot be determined from the platform

Expandable Attributes

Use the expand query parameter to include related objects:

expand=contact - Includes full Contact object details
expand=currency - Includes full Currency object details
expand=documents - Includes all Document objects attached to the sales order
expand=line_items - Includes detailed LineItem objects

Properties Supported

Property	Type	Description
platform_id	string	The Platform’s ID for the sales order
contact_id	string	The contact ID of the sales order
currency_id	string	The currency ID of the sales order
document_number	string	The document number of the sales order
posted_date	string	The posted date of the sales order
delivery_date	string	The delivery date of the sales order
description	string	The description of the sales order
payment_mode	string	The payment mode of the sales order
currency_rate	double	The currency rate of the sales order
status	enum	The status of the sales order
total_discount	double	The total discount of the sales order
tax_amount	double	The tax amount of the sales order
sub_total	double	The sub total of the sales order
total_amount	double	The total amount of the sales order
invoice_ids	array	The invoice IDs associated with the sales order
line_items	array	The line items of the sales order
updated_at	string	The date and time the sales order was last updated

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

{
  "rootfi_id": 123,
  "rootfi_created_at": "2024-01-25T09:00:00Z",
  "rootfi_updated_at": "2024-01-25T09:00:00Z",
  "rootfi_company_id": 456,
  "platform_id": "123456_1",
  "platform_unique_id": "123456",
  "contact_id": "123456",
  "currency_id": "123456",
  "invoice_ids": ["123456"],
  "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",
  "line_items": []
}

General

Server Side SDKs

Core API

Unified API

Attributes

Sales Order Attributes

Status Enum Values

Expandable Attributes

Properties Supported

Addresses

Line Items

Line Items Expandable Attributes

General

Server Side SDKs

Core API

Unified API

​Attributes

​Sales Order Attributes

​Status Enum Values

​Expandable Attributes

​Properties Supported

​Addresses

​Line Items

​Line Items Expandable Attributes

Attributes

Sales Order Attributes

Status Enum Values

Expandable Attributes

Properties Supported

Addresses

Line Items

Line Items Expandable Attributes