{
  "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"
}

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

PropertyTypeDescription
platform_idstringPlatform’s ID for the sales order
contact_idstringThe accounting platform’s unique ID of the contact associated with this sales order
document_numberstringReference number for the sales order
posted_datestringDate of creation of the sales order
delivery_datestringThe delivery date for the sales order
descriptionstringDescription of the sales order
payment_modestringThe payment mode from which the payment was made
currencystringThe ISO-4217 currency code
currency_ratefloatRate between the currency of the payment and the base currency
statusenumThe status of the sales order. Values are: DRAFT, SUBMITTED, PARTIALLY_PAID, PAID, OVERDUE, VOID, UNKNOWN
total_discountfloatTotal value of discounts applied to the sales order
tax_amountfloatTotal tax amount levied on the sales order
sub_totalfloatTotal pre tax value of the sales order
total_amountfloatTotal value of the sales order
updated_atdateThe date at which the information was updated on the accounting platform

​
Expandable Attributes

You can expand the following attributes to get the related data

PropertyData ModelDescription
contactContactsThe contact that made the sales order
currencyCurrenciesThe currency of the sales order
documentsDocumentsThe documents attached to the sales order
addressesAddressesThe addresses associated with the sales order
line_itemsLine ItemsThe line items associated with the sales order

​
Addresses

PropertyTypeDescription
platform_idstringPlatform's ID for the address
typeenumThe type of address. Values are: BILLING, SHIPPING.
data_modelstringThe 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_idstringThe unique identifier for the data model associated with this address
streetstringThe street information of the address
localitystringThe locality or neighborhood information of the address
citystringThe city information of the address
statestringThe state or region information of the address
countrystringThe country information of the address
pincodestringThe postal or zip code of the address
updated_atdateThe date and time at which the address information was last updated in the accounting platform

​
Line Items

PropertyTypeDescription
platform_idstringPlatform ID associated with this line item
item_idstringThe platform ID of the item associated with this line item
tax_idstringThe platform ID of the tax associated with this line item
account_idstringThe platform ID of the account associated with this line item
line_item_typeenumThe 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_idstringThe platform ID of the associated data model
descriptionstringThe description for this line item
quantityfloatThe quantity of the product/service for this line item
unit_amountfloatPrice per unit for this line item
sub_totalfloatThe pre tax total value for this line item
tax_amountfloatThe tax amount for this line item
total_amountfloatThe total value of this line item
tracking_category_idsobjectThe 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

PropertyData ModelDescription
itemItemsThe item associated with this line item
tax_rateTax RatesThe tax associated with this line item
accountAccountsThe account associated to the invoice
{
  "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"
}