Skip to main content
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 Payments 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_integration_typeenum
platform_idstringUnique identifier for this bill payment in the source accounting platform
bill_idstringThe bill ID of the bill payment
payment_idstringThe payment ID of the bill payment
credit_note_idstringThe credit note ID associated with the bill payment (if paying via debit note)
amountdoubleThe total amount of the bill payment
payment_modestringThe payment mode of the bill payment
currency_idenumISO 4217 currency code
currency_ratedoubleThe currency rate of the bill payment
memostringThe memo or notes of the bill payment
payment_datestringThe payment date of the bill payment
account_idstringThe account ID of the bill payment
contact_idstringThe contact ID 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 the related Bill object(s).
  • expand=contact — includes the related Contact object(s).
  • expand=currency — includes the related Currency object(s).
  • expand=account — includes the related Account object(s).

Properties Supported

Fields accepted when creating or updating a record:
PropertyTypeDescription
platform_idstringUnique identifier for this bill payment in the source accounting platform
bill_idstringThe bill ID of the bill payment
payment_idstringThe payment ID of the bill payment
credit_note_idstringThe credit note ID associated with the bill payment (if paying via debit note)
amountdoubleThe total amount of the bill payment
payment_modestringThe payment mode of the bill payment
currency_idenumISO 4217 currency code
currency_ratedoubleThe currency rate of the bill payment
memostringThe memo or notes of the bill payment
payment_datestringThe payment date of the bill payment
account_idstringThe account ID of the bill payment
contact_idstringThe contact ID of the bill payment
document_numberstringThe document number of the bill payment
updated_atstringThe date and time the bill payment was last updated