Overview

A record of goods or services purchased from a vendor

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.

Properties Supported

Property	Type	Description
platform_id	string	The Platform’s ID for the purchase order
contact_id	string	The Platform’s unique ID of the contact associated with this purchase order
currency_id	string	The Platform’s ID of the currency for the purchase order
document_number	string	Reference number for the purchase order
posted_date	string	Date of creation of the purchase order
delivery_date	string	The delivery date for the purchase order
description	string	Description of the purchase order
payment_mode	string	The payment mode from which the payment was made
currency_rate	float	Rate between the currency of the payment and the base currency
status	enum	The status of the purchase order. Values are: DRAFT, SUBMITTED, PARTIALLY_PAID, PAID, OVERDUE, VOID, UNKNOWN
total_discount	float	Total value of discounts applied to the purchase order
tax_amount	float	Total tax amount levied on the purchase order
sub_total	float	Total pre tax value of the purchase order
total_amount	float	Total value of the purchase order
updated_at	date	The date at which the information was updated on the accounting platform

Expandable Attributes

You can expand the following attributes to get the related data

Property	Data Model	Description
contact	Contacts	The contact that made the purchase order
currency	Currencies	The currency of the purchase order
documents	Documents	The documents attached to the purchase order
addresses	Addresses	The addresses associated with the purchase order
line_items	Line Items	The line items associated with the purchase order

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

The Purchase Order Response Object

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