Overview

The Bill Payments Data Model is designed to standardise and simplify the management of bill payment information across various accounting platforms.

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

Property	Type	Description
rootfi_id	integer	Unique identifier assigned by Commenda for this bill payment
rootfi_created_at	string	Timestamp when this record was created in Commenda’s system (ISO 8601)
rootfi_updated_at	string	Timestamp when this record was last updated in Commenda’s system (ISO 8601)
rootfi_integration_type	enum
platform_id	string	Unique identifier for this bill payment in the source accounting platform
bill_id	string	The bill ID of the bill payment
payment_id	string	The payment ID of the bill payment
credit_note_id	string	The credit note ID associated with the bill payment (if paying via debit note)
amount	double	The total amount of the bill payment
payment_mode	string	The payment mode of the bill payment
currency_id	enum	ISO 4217 currency code
currency_rate	double	The currency rate of the bill payment
memo	string	The memo or notes of the bill payment
payment_date	string	The payment date of the bill payment
account_id	string	The account ID of the bill payment
contact_id	string	The contact ID of the bill payment
document_number	string	The document number of the bill payment
updated_at	string	The 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:

Property	Type	Description
platform_id	string	Unique identifier for this bill payment in the source accounting platform
bill_id	string	The bill ID of the bill payment
payment_id	string	The payment ID of the bill payment
credit_note_id	string	The credit note ID associated with the bill payment (if paying via debit note)
amount	double	The total amount of the bill payment
payment_mode	string	The payment mode of the bill payment
currency_id	enum	ISO 4217 currency code
currency_rate	double	The currency rate of the bill payment
memo	string	The memo or notes of the bill payment
payment_date	string	The payment date of the bill payment
account_id	string	The account ID of the bill payment
contact_id	string	The contact ID of the bill payment
document_number	string	The document number of the bill payment
updated_at	string	The date and time the bill payment was last updated