> ## 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.

# Overview

> The Bill Payments Data Model is designed to standardise and simplify the management of bill payment information across various accounting platforms. 

* 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.

## Properties Supported

| Property       | Type   | Description                                                                  |
| -------------- | ------ | ---------------------------------------------------------------------------- |
| platform\_id   | string | The Platform's ID for this bill payment                                      |
| payment\_id    | string | The Platform's ID for the payment. A payment can have multiple bill payments |
| 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 made the payment                       |
| account\_id    | string | The platform's ID of the account to which this payment belongs               |
| 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\_id   | string | The Platform's ID of the currency for the bill payment                       |
| currency\_rate | float  | Rate between the currency of the payment and the base currency               |
| memo           | string | Description of 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                            |
| -------- | -------------------------------------------------------------- | -------------------------------------- |
| bill     | [Bills](/api-reference/v3/accounting/bills/overview)           | The bill associated with the payment   |
| contact  | [Contacts](/api-reference/v3/accounting/contacts/overview)     | The contact that made the bill payment |
| currency | [Currencies](/api-reference/v3/accounting/currencies/overview) | The currency of the bill payment       |
| account  | [Accounts](/api-reference/v3/accounting/accounts/overview)     | The account associated to the bill     |

<ResponseExample name="The Bill Payments Object">
  ```json The Bill Payments Response Object theme={null}
  {
    "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_rate": 1.0,
    "memo": "Payment for Services",
    "updated_at": "2023-11-05T16:30:00.000Z"
  }
  ```
</ResponseExample>