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 Invoice Payments Data Model represents payments recorded against invoices. This unified model streamlines the representation and management of invoice payment information across multiple accounting platforms.
  • Unified payment properties: Essential payment details, such as amount, currency, payment date, and payment mode, are standardized across different accounting platforms
  • Linked to contacts, accounts, and invoices: Each payment entry is connected to a specific contact, account, and invoice using their respective platform IDs, ensuring accurate data representation and easier cross-referencing
  • Currency rate conversion support: The currency_rate property enables the tracking of currency conversion rates between the payment currency and the base currency, facilitating accurate financial reporting

​
Attributes

​
Invoice Payment Attributes

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

​
Expandable Attributes

Use the expand query parameter to include related objects:
  • expand=invoice - Includes full Invoice 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 invoice payment
contact_idstringThe contact ID of the invoice payment
account_idstringThe account ID of the invoice payment
invoice_idstringThe invoice ID of the invoice payment
credit_note_idstringThe credit note ID associated with the invoice payment (if paying via credit note)
currency_idstringThe currency ID of the invoice payment
amountdoubleThe total amount of the invoice payment
currency_ratedoubleThe currency rate of the invoice payment
payment_datestringThe payment date of the invoice payment
payment_modestringThe payment mode of the invoice payment
memostringThe memo or notes of the invoice payment
document_numberstringThe document number of the invoice payment
updated_atstringThe date and time the invoice 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",
  "contact_id": "123456",
  "account_id": "123456",
  "payment_id": "123456",
  "invoice_id": "123456",
  "credit_note_id": null,
  "currency_id": "123456",
  "amount": 19.0,
  "document_number": "S78",
  "currency_rate": 1.0,
  "payment_date": "2023-03-01T00:00:00.000Z",
  "payment_mode": "Cash",
  "memo": "Test Description",
  "updated_at": "2023-09-27T00:00:00.000Z"
}