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 Orders 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_integration_typeenum
platform_idstringUnique identifier for this purchase order in the source accounting platform
descriptionstringThe description 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
currency_idenumISO 4217 currency code
currency_ratedoubleThe currency rate of the purchase order
sub_totaldoubleThe sub total of the purchase order
tax_amountdoubleThe tax amount of the purchase order
total_discountdoubleThe total discount of the purchase order
total_amountdoubleThe total amount of the purchase order
payment_modestringThe payment mode of the purchase order
statusenumThe status of the purchase order
contact_idstringThe contact ID of the purchase order
bill_idsarrayThe bill IDs associated with the purchase order
updated_atstringThe date and time the purchase order was last updated

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 canceled
UNKNOWNStatus cannot be determined from the platform

Expandable Attributes

Use the expand query parameter to include related objects:
  • expand=line_items — includes the related Line Items object(s).
  • expand=contact — includes the related Contact object(s).
  • expand=currency — includes the related Currency object(s).

Properties Supported

Fields accepted when creating or updating a record:
PropertyTypeDescription
platform_idstringUnique identifier for this purchase order in the source accounting platform
descriptionstringThe description 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
currency_idenumISO 4217 currency code
currency_ratedoubleThe currency rate of the purchase order
sub_totaldoubleThe sub total of the purchase order
tax_amountdoubleThe tax amount of the purchase order
total_discountdoubleThe total discount of the purchase order
total_amountdoubleThe total amount of the purchase order
payment_modestringThe payment mode of the purchase order
statusenumThe status of the purchase order
contact_idstringThe contact ID of the purchase order
bill_idsarrayThe bill IDs associated with the purchase order
updated_atstringThe date and time the purchase order was last updated