Skip to main content
The Bills Data Model represents a record of goods or services purchased from a vendor. This unified model simplifies handling bill-related information across various accounting platforms.
  • Unified bill properties: Essential bill information such as vendor, account, dates, currency, and amounts are standardized across different accounting platforms
  • Status tracking: The model supports tracking the status of a bill, including draft, submitted, partially paid, paid, overdue, void, or unknown, for better bill management and reporting
  • Relationship with other data models: The model allows for the inclusion of associated line items, bill payments, and purchase orders, providing a complete picture of each bill
  • Currency conversion: The currency_rate property allows for easy currency conversion between the payment currency and the base currency, ensuring accurate financial reporting and analysis

​
Attributes

​
Bill Attributes

PropertyTypeDescription
rootfi_idintegerUnique identifier assigned by Commenda for this bill
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 bill belongs to within Commenda
platform_idstringUnique identifier for this bill in the source accounting platform
platform_unique_idstringAlternative unique identifier from the platform (some platforms provide multiple IDs)
contact_idstringThe contact ID of the bill
currency_idstringThe currency ID of the bill
document_numberstringThe document number of the bill
posted_datestringThe posted date of the bill
due_datestringThe due date of the bill
statusenumThe status of the bill
total_discountdoubleThe total discount of the bill
sub_totaldoubleThe sub total of the bill
tax_amountdoubleThe tax amount of the bill
total_amountdoubleThe total amount of the bill
amount_duedoubleThe amount due of the bill
memostringThe memo or notes of the bill
updated_atstringThe date and time the bill was last updated
currency_ratedoubleThe currency rate of the bill
purchase_order_idsarrayThe purchase order IDs associated with the bill
line_itemsarrayThe line items of the bill

​
Status Enum Values

ValueDescription
draftBill is in draft status and has not been finalized
submittedBill has been submitted but not yet paid
partially_paidBill has received partial payment
paidBill has been fully paid
overdueBill has passed its due date without payment
voidBill has been voided or cancelled
unknownStatus cannot be determined from the platform

​
Expandable Attributes

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

​
Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID for the bill
contact_idstringThe contact ID of the bill
currency_idstringThe currency ID of the bill
document_numberstringThe document number of the bill
posted_datestringThe posted date of the bill
due_datestringThe due date of the bill
statusenumThe status of the bill
total_discountdoubleThe total discount of the bill
sub_totaldoubleThe sub total of the bill
tax_amountdoubleThe tax amount of the bill
total_amountdoubleThe total amount of the bill
amount_duedoubleThe amount due of the bill
memostringThe memo or notes of the bill
currency_ratedoubleThe currency rate of the bill
purchase_order_idsarrayThe purchase order IDs associated with the bill
line_itemsarrayThe line items of the bill
updated_atstringThe date and time the bill 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",
  "document_number": "AO-0001",
  "posted_date": "2024-01-25T09:00:00Z",
  "due_date": "2024-01-25T09:00:00Z",
  "status": "paid",
  "total_discount": 0.0,
  "sub_total": 150.0,
  "tax_amount": 0.0,
  "total_amount": 150.0,
  "amount_due": 0.0,
  "memo": null,
  "updated_at": "2024-01-25T09:00:00Z",
  "currency_rate": 1.0,
  "purchase_order_ids": ["123456"],
  "line_items": []
}