Overview

The payments recorded against Invoices.

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

Property	Type	Description
platform_id	string	The Platform’s ID for this invoice payment
contact_id	string	The platform’s ID for the contact that makes the payment
account_id	string	The platform’s ID for the account to which this payment belongs
invoice_id	string	The platform’s ID for the invoice which this payment is associated with
currency_id	string	The Platform’s ID of the currency for the invoice payment
amount	float	The total value of this payment
currency_rate	float	Rate between the currency of the payment and the base currency
payment_date	date	The date on which the payment was made
payment_mode	string	The payment mode from which the payment was made
memo	string	Optional description for the payment
updated_at	date	The date at which the information was updated on the accounting platform

Expandable Attributes

You can expand the following attributes to get the related data

Property	Data Model	Description
invoice	Invoices	The invoice associated with the payment
contact	Contacts	The contact that made the invoice payment
currency	Currencies	The currency of the invoice payment
account	Accounts	The account associated to the invoice

The Invoice Payments Response Object

{
  "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"
}