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

> Balances are the amount of money in an account, equal to the net of credits and debits at that point in time for that account.

**The Balances Data Model** simplifies the handling and retrieval of Balances data for your application. The model provides a unified representation of balances data across different platforms, enabling you to easily access and manage balances data from different platforms.

* Unified Balances properties: The model provides a unified representation of balances properties across different platforms, enabling you to easily access and manage balances data from different platforms.
* Comprehensive balances information: The model provides a comprehensive representation of balances data, including all the properties and relationships that you can retrieve for a balance.

## Attributes

### Balance Attributes

| Property             | Type    | Description                                                           |
| -------------------- | ------- | --------------------------------------------------------------------- |
| rootfi\_id           | integer | The RootFi ID of the balance                                          |
| rootfi\_created\_at  | string  | The ISO 8601 timestamp at which the record was created in RootFi      |
| rootfi\_updated\_at  | string  | The ISO 8601 timestamp at which the record was last updated in RootFi |
| rootfi\_company\_id  | integer | The RootFi company ID associated with the balance                     |
| platform\_id         | string  | The Platform's ID for the Balance                                     |
| platform\_unique\_id | string  | The platform's unique identifier for the balance                      |
| total\_balance       | number  | The total balance of the account                                      |
| available\_balance   | number  | The available balance of the account                                  |
| pending\_balance     | number  | The pending balance of the account                                    |
| currency\_id         | string  | The currency ID of the account                                        |

## Properties Supported

| Property           | Type   | Description                          |
| ------------------ | ------ | ------------------------------------ |
| platform\_id       | string | The Platform's ID for the Balance    |
| total\_balance     | number | The total balance of the account     |
| available\_balance | number | The available balance of the account |
| pending\_balance   | number | The pending balance of the account   |
| currency\_id       | string | The currency ID of the account       |

<ResponseExample name="The Balances Object">
  ```json The Balances Response Object theme={null}
  {
    "rootfi_id": 157,
    "rootfi_deleted_at": null,
    "rootfi_created_at": "2024-01-22T05:07:31.465Z",
    "rootfi_updated_at": "2024-01-22T05:07:31.000Z",
    "rootfi_company_id": 1089,
    "platform_id": "bal_123456",
    "total_balance": 10000.00,
    "available_balance": 8500.00,
    "pending_balance": 1500.00,
    "currency_id": "USD"
  }
  ```
</ResponseExample>
