Skip to main content
The Purchase Orders Data Model simplifies the management and access of purchase order information across various accounting platforms.
  • Unified purchase order properties: The model consolidates essential details, such as contact information, document number, dates, description, payment mode, and currency, to provide a complete view of each purchase order.
  • Financial calculations: The model includes properties for tax amount, discounts, subtotals, and total amounts, enabling accurate financial calculations and reporting.
  • Association with bills: The bills property links purchase orders to their associated bills, facilitating the tracking and management of related financial transactions.

​
Attributes

​
Properties Supported

PropertyTypeDescription
platform_idstringPlatform’s ID for the purchase order
contact_idstringThe accounting platform’s unique ID of the contact associated with this purchase order
document_numberstringReference number for the purchase order
posted_datestringDate of creation of the purchase order
delivery_datestringThe delivery date for the purchase order
descriptionstringDescription of the purchase 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 purchase order. Values are: DRAFT, SUBMITTED, PARTIALLY_PAID, PAID, OVERDUE, VOID, UNKNOWN
total_discountfloatTotal value of discounts applied to the purchase order
tax_amountfloatTotal tax amount levied on the purchase order
sub_totalfloatTotal pre tax value of the purchase order
total_amountfloatTotal value of the purchase order
line_itemsLine ItemArray of Purchase Order Line items associated with the purchase order
billsBillArray of Bills associated with the purchase order
addressesAddressArray of addresses associated with this purchase order
contactContactThe contact associated with this purchase order
updated_atstringThe date at which the information was updated on the accounting platform
{
  "platform_id": "3770712000001722009",
  "contact_id": "3770712000000080863",
  "currency_id": "3770712000000000099",
  "bill_ids": ["3770712000001722013"],
  "document_number": "PO-00075",
  "posted_date": "2023-04-01T00:00:00.000Z",
  "delivery_date": "2023-05-01T00:00:00.000Z",
  "description": "Purchase Order for Products",
  "payment_mode": "Cash",
  "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": 2.28,
  "sub_total": 19.0,
  "total_amount": 21.28,
  "line_items": {
    "data": [
      {
        "platform_id": "3770712000001722011",
        "line_item_type": "PURCHASE_ORDERS",
        "line_item_type_id": "3770712000001722009",
        "tracking_category_ids": [],
        "item_id": "3770712000000085075",
        "tax_id": "3770712000000106071",
        "account_id": "3770712000000034003",
        "description": "Ted's Products (2 units)",
        "quantity": 2,
        "unit_amount": 10.0,
        "total_amount": 21.28,
        "sub_total": 19.0,
        "tax_amount": 2.28,
        "total_discount": 1.0,
        "updated_at": "2023-11-05T00:00:00.000Z"
      }
    ]
  },
  "addresses": {
    "data": [
      {
        "platform_id": "_PURCHASE_ORDERS_3770712000001722009_BILLING",
        "type": "BILLING",
        "data_model": "PURCHASE_ORDERS",
        "data_model_id": "3770712000001722009",
        "street": "123 Main Street",
        "locality": "Downtown",
        "city": "Metropolis",
        "state": "Stateville",
        "country": "Countryland",
        "pincode": "12345",
        "updated_at": "2023-11-05T00:00:00.000Z"
      }
    ]
  },
  "contact": null,
  "updated_at": "2023-11-05T00:00:00.000Z"
}