{
  "platform_id": "3770712000000869035",
  "payment_id": "3770712000000869033",
  "bill_id": "3770712000000860118",
  "contact_id": "3770712000000418001",
  "account_id": "3770712000000860118",
  "currency_id": "3770712000000860099",
  "amount": 1.0,
  "payment_date": "2023-03-01T00:00:00.000Z",
  "payment_mode": "Credit Card",
  "currency": {
    "data": {
      "platform_id": "3770712000000860099",
      "name": "US Dollar",
      "code": "USD",
      "symbol": "$",
      "is_base currency": true,
      "exchange_rate": 1.0,
      "updated_at": "2023-11-05T16:30:00.000Z"
    }
  },
  "currency_rate": 1.0,
  "memo": "Payment for Services",
  "bill": {
    "data": {
      "platform_id": "3770712000000860118",
      "contact_id": "3770712000000418001",
      "currency_id": "3770712000000860099",
      "document_number": "BILL-2023-001",
      "posted_date": "2023-03-17T00:00:00.000Z",
      "due_date": "2024-03-19T00:00:00.000Z",
      "currency": {
        "data": {
          "platform_id": "INR",
          "name": "Indian Rupee",
          "code": "INR",
          "symbol": "₹",
          "is_base currency": true,
          "exchange_rate": 1.0,
          "updated_at": "2023-09-27T00:00:00.000Z"
        }
      },
      "currency_rate": 1.0,
      "status": "Partially Paid",
      "total_amount": 212.8,
      "sub_total": 190.0,
      "total_discount": null,
      "tax_amount": 22.8,
      "amount_due": 202.8,
      "purchase_order_ids": [],
      "updated_at": "2023-09-27T00:00:00.000Z"
    }
  },
  "contact": {
    "data": {
      "platform_id": "3770712000000418001",
      "currency_id": "3770712000000860099",
      "name": "RootFi Corporation",
      "contact_name": "John Smith",
      "contact_type": "Vendor",
      "currency": {
        "data": {
          "platform_id": "3770712000000860099",
          "name": "US Dollar",
          "code": "USD",
          "symbol": "$",
          "is_base currency": true,
          "exchange_rate": 1.0,
          "updated_at": "2023-11-05T16:30:00.000Z"
        }
      },
      "tax_number": "12345678",
      "registration_number": "56789",
      "status": "Active",
      "updated_at": "2023-10-12T00:00:00.000Z"
    }
  },
  "account": null,
  "updated_at": "2023-11-05T16:30:00.000Z"
}
  • Unified bill payment properties: The model unifies essential core payment details, such as payment date, payment mode, currency, and amount, ensuring consistent access to payment data.
  • 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

platform_id
string
required

The accounting platforms ID for this bill payment

payment_id
string

The accounting platforms ID for the payment

bill_id
string

The platform’s ID of the bill which this payment is associated with

contact_id
string

The platform’s ID of the contact that makes the payment

account_id
string

The platform’s ID of the account to which this payment belongs

currency_id
string

The Accounting Platform’s unique ID for the currency

amount
float

The total value of this payment

payment_date
date

The date on which the payment was made

payment_mode
string

The payment method used

currency
string

The currency data associated with the bill payment.

currency_rate
float

Rate between the currency of the payment and the base currency

memo
string

Description of the payment

bill
Bill

The bill which this payment is associated with

contact
Contact

The contact that makes the payment

updated_at
date

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

raw_data
object

The raw JSON response we get from the accounting platform for that data.

Properties Supported

PropertyTypeDescription
platform_idstringThe accounting platforms ID for this bill payment
payment_idstringThe accounting platforms ID for the payment
bill_idstringThe platform’s ID of the bill which this payment is associated with
contact_idstringThe platform’s ID of the contact that makes the payment
account_idstringThe platform’s ID of the account to which this payment belongs
amountfloatThe total value of this payment
payment_datedateThe date on which the payment was made
payment_modestringThe payment method used
currencystringThe ISO-4217 currency code
currency_ratefloatRate between the currency of the payment and the base currency
memostringDescription of the payment
billBillThe bill 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