{
  "platform_id": "3770712000001726003",
  "contact_id": "3770712000000226001",
  "account_id": "3770712000000000361",
  "payment_id": "3770712000001726001",
  "invoice_id": "3770712000000707001",
  "currency_id": "3770712000000000099",
  "amount": 19,
  "document_number": "S78",
  "currency": {
    "data": {
      "platform_id": "3770712000000000099",
      "name": "Indian Rupee",
      "code": "INR",
      "symbol": "₹",
      "is_base_currency": true,
      "exchange_rate": 0,
      "updated_at": null
    }
  },
  "currency_rate": 1,
  "payment_date": "2023-03-01T00:00:00.000Z",
  "payment_mode": "Cash",
  "memo": "Test Description",
  "invoice": {
    "data": {
      "platform_id": "3770712000000707001",
      "contact_id": "3770712000000226001",
      "sales_order_ids": [],
      "document_number": "123456",
      "posted_date": "2023-06-08T00:00:00.000Z",
      "due_date": "2023-06-08T00:00:00.000Z",
      "currency_id": "3770712000000000099",
      "currency": {
        "data": {
          "platform_id": "3770712000000000099",
          "name": "Indian Rupee",
          "code": "INR",
          "symbol": "₹",
          "is_base_currency": true,
          "exchange_rate": 0,
          "updated_at": null
        }
      },
      "currency_rate": 1,
      "status": "Overdue",
      "total_amount": 1179988.2,
      "sub_total": 1000000,
      "total_discount": 10,
      "tax_amount": 179998.2,
      "amount_due": 1158627.2,
      "memo": "Thanks for your business.",
      "updated_at": "2023-09-27T00:00:00.000Z"
    }
  },
  "updated_at": "2023-09-27T00:00:00.000Z"
}

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.

​
Attributes

​
platform_id
string
required

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

​
payment_id
string

The Accounting Platform’s unique ID for the payment

​
invoice_id
string

The platform’s ID for the invoice which this payment is associated with invoice payment.

​
currency_id
string

The Accounting Platform’s unique ID for the currency

​
amount
float

The total value of this payment

​
document_number
string

A reference number or document number associated with the payment

​
currency
Object

The currency data associated with the Invoice 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

​
invoice
Invoice

The invoice which this payment is associated with

​
updated_at
date

The date at which the information was updated on the accounting platform

​
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
amountfloatThe total value of this payment
currencystringThe ISO-4217 currency code of the account
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
invoiceInvoiceThe invoice which this payment is associated with
contactContactThe contact that makes the payment
accountAccountThe account to which this payment belongs
updated_atdateThe date at which the information was updated on the accounting platform
{
  "platform_id": "3770712000001726003",
  "contact_id": "3770712000000226001",
  "account_id": "3770712000000000361",
  "payment_id": "3770712000001726001",
  "invoice_id": "3770712000000707001",
  "currency_id": "3770712000000000099",
  "amount": 19,
  "document_number": "S78",
  "currency": {
    "data": {
      "platform_id": "3770712000000000099",
      "name": "Indian Rupee",
      "code": "INR",
      "symbol": "₹",
      "is_base_currency": true,
      "exchange_rate": 0,
      "updated_at": null
    }
  },
  "currency_rate": 1,
  "payment_date": "2023-03-01T00:00:00.000Z",
  "payment_mode": "Cash",
  "memo": "Test Description",
  "invoice": {
    "data": {
      "platform_id": "3770712000000707001",
      "contact_id": "3770712000000226001",
      "sales_order_ids": [],
      "document_number": "123456",
      "posted_date": "2023-06-08T00:00:00.000Z",
      "due_date": "2023-06-08T00:00:00.000Z",
      "currency_id": "3770712000000000099",
      "currency": {
        "data": {
          "platform_id": "3770712000000000099",
          "name": "Indian Rupee",
          "code": "INR",
          "symbol": "₹",
          "is_base_currency": true,
          "exchange_rate": 0,
          "updated_at": null
        }
      },
      "currency_rate": 1,
      "status": "Overdue",
      "total_amount": 1179988.2,
      "sub_total": 1000000,
      "total_discount": 10,
      "tax_amount": 179998.2,
      "amount_due": 1158627.2,
      "memo": "Thanks for your business.",
      "updated_at": "2023-09-27T00:00:00.000Z"
    }
  },
  "updated_at": "2023-09-27T00:00:00.000Z"
}
OverviewGet All Invoice Payments