Skip to main content

Documentation Index

Fetch the complete documentation index at: https://integrations.docs.commenda.io/llms.txt

Use this file to discover all available pages before exploring further.

The Bill Payments Data Model represents payments made against bills. This unified model standardizes and simplifies the management of bill payment information across various accounting platforms.
  • Unified bill payment properties: Essential core payment details, such as payment date, payment mode, currency, and amount, are standardized across different accounting platforms
  • Associated data linkage: The data model connects bill payments to related information, such as bills, contacts, and accounts, using platform-specific IDs for easy cross-referencing
  • Currency conversion support: The currency_rate property provides the exchange rate between the payment currency and the base currency, facilitating multi-currency payment handling and reporting

​
Attributes

​
Bill Payment Attributes

PropertyTypeDescription
rootfi_idintegerUnique identifier assigned by Commenda for this bill payment
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 payment belongs to within Commenda
platform_idstringUnique identifier for this bill payment in the source accounting platform
payment_idstringThe payment ID of the bill payment
bill_idstringThe bill ID of the bill payment
credit_note_idstringThe credit note ID associated with the bill payment (if paying via debit note)
contact_idstringThe contact ID of the bill payment
account_idstringThe account ID of the bill payment
amountdoubleThe total amount of the bill payment
payment_datestringThe payment date of the bill payment
payment_modestringThe payment mode of the bill payment
currency_idstringThe currency ID of the bill payment
currency_ratedoubleThe currency rate of the bill payment
memostringThe memo or notes of the bill payment
document_numberstringThe document number of the bill payment
updated_atstringThe date and time the bill payment was last updated

​
Expandable Attributes

Use the expand query parameter to include related objects:
  • expand=bill - Includes full Bill object details
  • expand=contact - Includes full Contact object details
  • expand=currency - Includes full Currency object details
  • expand=account - Includes full Account object details

​
Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID for this bill payment
payment_idstringThe payment ID of the bill payment
bill_idstringThe bill ID of the bill payment
credit_note_idstringThe credit note ID associated with the bill payment (if paying via debit note)
contact_idstringThe contact ID of the bill payment
account_idstringThe account ID of the bill payment
amountdoubleThe total amount of the bill payment
payment_datestringThe payment date of the bill payment
payment_modestringThe payment mode of the bill payment
currency_idstringThe currency ID of the bill payment
currency_ratedoubleThe currency rate of the bill payment
memostringThe memo or notes of the bill payment
document_numberstringThe document number of the bill payment
updated_atstringThe date and time the bill payment was last updated
{
  "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",
  "payment_id": "123456",
  "bill_id": "123456",
  "credit_note_id": null,
  "contact_id": "123456",
  "account_id": "123456",
  "currency_id": "123456",
  "amount": 1.0,
  "payment_date": "2023-03-01T00:00:00.000Z",
  "payment_mode": "Credit Card",
  "currency_rate": 1.0,
  "memo": "Payment for Services",
  "document_number": "BP-001",
  "updated_at": "2023-11-05T16:30:00.000Z"
}