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

> Bank Transactions include the Transactional banking data for a specific company and account.

**The Bank Transactions Data Model** represents transactional banking data for a specific company and account. This unified model simplifies the management and retrieval of transaction information across different accounting platforms.

* **Unified transaction properties**: Essential transaction details such as transaction date, amount, type, and status are standardized across different accounting platforms
* **Linked account and customer data**: Transactions are associated with specific accounts and customers through the `account_id` and `contact_id` properties, facilitating easier tracking and reporting
* **Currency support and exchange rates**: The data model includes the transaction currency and exchange rate, enabling accurate representation of multi-currency transactions and conversions

## Attributes

### Bank Transactions Attributes

| Property                  | Type    | Description                                                                   |
| ------------------------- | ------- | ----------------------------------------------------------------------------- |
| `rootfi_id`               | integer | Unique identifier assigned by Commenda for this bank transaction              |
| `rootfi_created_at`       | string  | Timestamp when this record was created in Commenda's system (ISO 8601)        |
| `rootfi_updated_at`       | string  | Timestamp when this record was last updated in Commenda's system (ISO 8601)   |
| `rootfi_integration_type` | enum    |                                                                               |
| `platform_id`             | string  | Unique identifier for this bank transaction in the source accounting platform |
| `contact_id`              | string  | The contact ID of the bank transaction                                        |
| `account_id`              | string  | The account ID of the bank transaction                                        |
| `from_account_id`         | string  | The from account ID of the bank transaction                                   |
| `to_account_id`           | string  | The to account ID of the bank transaction                                     |
| `currency_id`             | enum    | ISO 4217 currency code                                                        |
| `amount`                  | double  | The total amount of the bank transaction                                      |
| `type`                    | string  | The type of the bank transaction                                              |
| `debit_or_credit`         | enum    | The type of transaction                                                       |
| `status`                  | string  | The status of the bank transaction                                            |
| `currency_rate`           | double  | The currency rate of the bank transaction                                     |
| `transaction_date`        | string  | The transaction date of the bank transaction                                  |
| `updated_at`              | string  | The date and time the bank transaction was last updated                       |

### Debit Or Credit Enum Values

| Value     | Description                   |
| --------- | ----------------------------- |
| `CREDIT`  | Transaction is a credit entry |
| `DEBIT`   | Transaction is a debit entry  |
| `UNKNOWN` |                               |

## Expandable Attributes

Use the `expand` query parameter to include related objects:

* `expand=contact` — includes the related Contact object(s).
* `expand=bank_account` — includes the related Bank Account object(s).
* `expand=currency` — includes the related Currency object(s).

## Properties Supported

Fields accepted when creating or updating a record:

| Property           | Type   | Description                                                                   |
| ------------------ | ------ | ----------------------------------------------------------------------------- |
| `platform_id`      | string | Unique identifier for this bank transaction in the source accounting platform |
| `contact_id`       | string | The contact ID of the bank transaction                                        |
| `account_id`       | string | The account ID of the bank transaction                                        |
| `from_account_id`  | string | The from account ID of the bank transaction                                   |
| `to_account_id`    | string | The to account ID of the bank transaction                                     |
| `currency_id`      | enum   | ISO 4217 currency code                                                        |
| `amount`           | double | The total amount of the bank transaction                                      |
| `type`             | string | The type of the bank transaction                                              |
| `debit_or_credit`  | enum   | The type of transaction                                                       |
| `status`           | string | The status of the bank transaction                                            |
| `currency_rate`    | double | The currency rate of the bank transaction                                     |
| `transaction_date` | string | The transaction date of the bank transaction                                  |
| `updated_at`       | string | The date and time the bank transaction was last updated                       |
