Overview

A record of goods or services sold to a customer.

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 Orders 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_integration_type	enum
platform_id	string	Unique identifier for this sales order in the source accounting platform
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
document_number	string	The document number of the sales order
currency_id	enum	ISO 4217 currency code
currency_rate	double	The currency rate of the sales order
sub_total	double	The sub total of the sales order
tax_amount	double	The tax amount of the sales order
total_discount	double	The total discount of the sales order
total_amount	double	The total amount of the sales order
payment_mode	string	The payment mode of the sales order
status	enum	The status of the sales order
contact_id	string	The contact ID of the sales order
invoice_ids	array	The invoice IDs associated with the sales order
updated_at	string	The date and time the sales order was last updated

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 canceled
UNKNOWN	Status cannot be determined from the platform

Expandable Attributes

Use the expand query parameter to include related objects:

• expand=line_items — includes the related Line Items object(s).
• expand=contact — includes the related Contact object(s).
• expand=currency — includes the related Currency object(s).

Properties Supported

Fields accepted when creating or updating a record:

Property	Type	Description
platform_id	string	Unique identifier for this sales order in the source accounting platform
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
document_number	string	The document number of the sales order
currency_id	enum	ISO 4217 currency code
currency_rate	double	The currency rate of the sales order
sub_total	double	The sub total of the sales order
tax_amount	double	The tax amount of the sales order
total_discount	double	The total discount of the sales order
total_amount	double	The total amount of the sales order
payment_mode	string	The payment mode of the sales order
status	enum	The status of the sales order
contact_id	string	The contact ID of the sales order
invoice_ids	array	The invoice IDs associated with the sales order
updated_at	string	The date and time the sales order was last updated