Skip to main content
The Invoice Payments Data Model streamlines the representation and management of invoice payment information across multiple accounting platforms.
  • Unified payment properties: The model consolidates essential payment details, such as amount, currency, payment date, and payment mode, simplifying the handling of payment data from different 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.

​
Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID for this invoice payment
contact_idstringThe platform’s ID for the contact that makes the payment
account_idstringThe platform’s ID for the account to which this payment belongs
invoice_idstringThe platform’s ID for the invoice which this payment is associated with
currency_idstringThe Platform’s ID of the currency for the invoice payment
amountfloatThe total value of this payment
currency_ratefloatRate between the currency of the payment and the base currency
payment_datedateThe date on which the payment was made
payment_modestringThe payment mode from which the payment was made
memostringOptional description for the payment
updated_atdateThe date at which the information was updated on the accounting platform

​
Expandable Attributes

You can expand the following attributes to get the related data
PropertyData ModelDescription
invoiceInvoicesThe invoice associated with the payment
contactContactsThe contact that made the invoice payment
currencyCurrenciesThe currency of the invoice payment
accountAccountsThe account associated to the invoice
{
  "platform_id": "3770712000001726003",
  "contact_id": "3770712000000226001",
  "account_id": "3770712000000000361",
  "payment_id": "3770712000001726001",
  "invoice_id": "3770712000000707001",
  "currency_id": "3770712000000000099",
  "amount": 19,
  "document_number": "S78",
  "currency_rate": 1,
  "payment_date": "2023-03-01T00:00:00.000Z",
  "payment_mode": "Cash",
  "memo": "Test Description",
  "updated_at": "2023-09-27T00:00:00.000Z"
}