{
  "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": {
    "data": {
      "platform_id": "3770712000000000099",
      "name": "Indian Rupee",
      "code": "INR",
      "symbol": "₹",
      "is_base_currency": true,
      "exchange_rate": 1.0,
      "updated_at": "2023-11-05T00:00:00.000Z"
    }
  },
  "currency_rate": 1.0,
  "status": "DRAFT",
  "total_discount": 1.0,
  "tax_amount": 0.0,
  "sub_total": 19.0,
  "total_amount": 19.0,
  "line_items": {
    "data": [
      {
        "platform_id": "3770712000001720012",
        "line_item_type": "SALES_ORDERS",
        "line_item_type_id": "3770712000001720008",
        "tracking_category_ids": [],
        "item_id": "3770712000000085075",
        "tax_id": "3770712000000106067",
        "account_id": null,
        "description": "Yoyo Products (2 units)",
        "quantity": 2,
        "unit_amount": 10.0,
        "total_amount": 19.0,
        "sub_total": 19.0,
        "tax_amount": 0.0,
        "total_discount": 1.0,
        "updated_at": "2023-11-05T00:00:00.000Z"
      }
    ]
  },
  "addresses": {
    "data": [
      {
        "platform_id": "_SALES_ORDERS_3770712000001720008_SHIPPING",
        "type": "SHIPPING",
        "data_model": "SALES_ORDERS",
        "data_model_id": "3770712000001720008",
        "street": "L House",
        "locality": "Kadubesanhalli",
        "city": "Hyderabad",
        "state": "KL",
        "country": "India",
        "pincode": "500098",
        "updated_at": "2023-11-05T00:00:00.000Z"
      },
      {
        "platform_id": "_SALES_ORDERS_3770712000001720008_BILLING",
        "type": "BILLING",
        "data_model": "SALES_ORDERS",
        "data_model_id": "3770712000001720008",
        "street": "D Zone",
        "locality": "Bellandur",
        "city": "Visakhapatnam",
        "state": "AP",
        "country": "India",
        "pincode": "500003",
        "updated_at": "2023-11-05T00:00:00.000Z"
      }
    ]
  },
  "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.

​
Attributes

​
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
line_itemsLine ItemArray of Sales Order Line items associated with the purchase order
invoicesInvoiceArray of invoices associated with the sales order
addressesAddressArray of addresses associated with this sales order
contactContactThe contact associated with this sales order
{
  "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": {
    "data": {
      "platform_id": "3770712000000000099",
      "name": "Indian Rupee",
      "code": "INR",
      "symbol": "₹",
      "is_base_currency": true,
      "exchange_rate": 1.0,
      "updated_at": "2023-11-05T00:00:00.000Z"
    }
  },
  "currency_rate": 1.0,
  "status": "DRAFT",
  "total_discount": 1.0,
  "tax_amount": 0.0,
  "sub_total": 19.0,
  "total_amount": 19.0,
  "line_items": {
    "data": [
      {
        "platform_id": "3770712000001720012",
        "line_item_type": "SALES_ORDERS",
        "line_item_type_id": "3770712000001720008",
        "tracking_category_ids": [],
        "item_id": "3770712000000085075",
        "tax_id": "3770712000000106067",
        "account_id": null,
        "description": "Yoyo Products (2 units)",
        "quantity": 2,
        "unit_amount": 10.0,
        "total_amount": 19.0,
        "sub_total": 19.0,
        "tax_amount": 0.0,
        "total_discount": 1.0,
        "updated_at": "2023-11-05T00:00:00.000Z"
      }
    ]
  },
  "addresses": {
    "data": [
      {
        "platform_id": "_SALES_ORDERS_3770712000001720008_SHIPPING",
        "type": "SHIPPING",
        "data_model": "SALES_ORDERS",
        "data_model_id": "3770712000001720008",
        "street": "L House",
        "locality": "Kadubesanhalli",
        "city": "Hyderabad",
        "state": "KL",
        "country": "India",
        "pincode": "500098",
        "updated_at": "2023-11-05T00:00:00.000Z"
      },
      {
        "platform_id": "_SALES_ORDERS_3770712000001720008_BILLING",
        "type": "BILLING",
        "data_model": "SALES_ORDERS",
        "data_model_id": "3770712000001720008",
        "street": "D Zone",
        "locality": "Bellandur",
        "city": "Visakhapatnam",
        "state": "AP",
        "country": "India",
        "pincode": "500003",
        "updated_at": "2023-11-05T00:00:00.000Z"
      }
    ]
  },
  "updated_at": "2023-11-05T00:00:00.000Z"
}