Skip to main content
The Purchase Orders Data Model represents a record of goods or services purchased from a vendor. This unified model simplifies the management and access of purchase order information across various accounting platforms.
  • Unified purchase order properties: Essential details, such as contact information, document number, dates, description, payment mode, and currency, are standardized across different accounting platforms
  • 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

​
Purchase Order Attributes

PropertyTypeDescription
rootfi_idintegerUnique identifier assigned by Commenda for this purchase order
rootfi_created_atstringTimestamp when this record was created in Commenda’s system (ISO 8601)
rootfi_updated_atstringTimestamp when this record was last updated in Commenda’s system (ISO 8601)
rootfi_company_idintegerCompany identifier this purchase order belongs to within Commenda
platform_idstringUnique identifier for this purchase order in the source accounting platform
platform_unique_idstringAlternative unique identifier from the platform (some platforms provide multiple IDs)
contact_idstringThe contact ID of the purchase order
currency_idstringThe currency ID of the purchase order
document_numberstringThe document number of the purchase order
posted_datestringThe posted date of the purchase order
delivery_datestringThe delivery date of the purchase order
descriptionstringThe description of the purchase order
payment_modestringThe payment mode of the purchase order
currency_ratedoubleThe currency rate of the purchase order
statusenumThe status of the purchase order
total_discountdoubleThe total discount of the purchase order
tax_amountdoubleThe tax amount of the purchase order
sub_totaldoubleThe sub total of the purchase order
total_amountdoubleThe total amount of the purchase order
updated_atstringThe date and time the purchase order was last updated
bill_idsarrayThe bill IDs associated with the purchase order
line_itemsarrayThe line items of the purchase order

​
Status Enum Values

ValueDescription
draftPurchase order is in draft status and has not been finalized
submittedPurchase order has been submitted but not yet paid
partially_paidPurchase order has received partial payment
paidPurchase order has been fully paid
overduePurchase order has passed its due date without payment
voidPurchase order has been voided or cancelled
unknownStatus cannot be determined from the platform

​
Expandable Attributes

Use the expand query parameter to include related objects:
  • expand=contact - Includes full Contact object details
  • expand=currency - Includes full Currency object details
  • expand=documents - Includes all Document objects attached to the purchase order
  • expand=line_items - Includes detailed LineItem objects

​
Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID for the purchase order
contact_idstringThe contact ID of the purchase order
currency_idstringThe currency ID of the purchase order
document_numberstringThe document number of the purchase order
posted_datestringThe posted date of the purchase order
delivery_datestringThe delivery date of the purchase order
descriptionstringThe description of the purchase order
payment_modestringThe payment mode of the purchase order
currency_ratedoubleThe currency rate of the purchase order
statusenumThe status of the purchase order
total_discountdoubleThe total discount of the purchase order
tax_amountdoubleThe tax amount of the purchase order
sub_totaldoubleThe sub total of the purchase order
total_amountdoubleThe total amount of the purchase order
bill_idsarrayThe bill IDs associated with the purchase order
line_itemsarrayThe line items of the purchase order
updated_atstringThe date and time the purchase order was last updated

​
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
{
  "rootfi_id": 123,
  "rootfi_created_at": "2024-01-25T09:00:00Z",
  "rootfi_updated_at": "2024-01-25T09:00:00Z",
  "rootfi_company_id": 456,
  "platform_id": "123456_1",
  "platform_unique_id": "123456",
  "contact_id": "123456",
  "currency_id": "123456",
  "bill_ids": ["123456"],
  "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_rate": 1.0,
  "status": "draft",
  "total_discount": 1.0,
  "tax_amount": 2.28,
  "sub_total": 19.0,
  "total_amount": 21.28,
  "updated_at": "2023-11-05T00:00:00.000Z",
  "line_items": []
}