Skip to main content
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 Transaction Attributes

PropertyTypeDescription
rootfi_idintegerUnique identifier assigned by Commenda for this bank transaction
rootfi_created_atstringTimestamp when this record was created in Commenda’s system (ISO 8601)
rootfi_updated_atstringTimestamp when this record was last updated in Commenda’s system (ISO 8601)
rootfi_company_idintegerCompany identifier this bank transaction belongs to within Commenda
platform_idstringUnique identifier for this bank transaction in the source accounting platform
platform_unique_idstringAlternative unique identifier from the platform (some platforms provide multiple IDs)
account_idstringThe account ID of the bank transaction
from_account_idstringThe from account ID of the bank transaction
to_account_idstringThe to account ID of the bank transaction
contact_idstringThe contact ID of the bank transaction
currency_idstringThe currency ID of the bank transaction
transaction_datestringThe transaction date of the bank transaction
amountdoubleThe total amount of the bank transaction
typestringThe type of the bank transaction
statusstringThe status of the bank transaction
currency_ratedoubleThe currency rate of the bank transaction
debit_or_creditenumThe type of transaction
updated_atstringThe date and time the bank transaction was last updated

​
Debit or Credit Enum Values

ValueDescription
DEBITTransaction is a debit entry
CREDITTransaction is a credit entry

​
Expandable Attributes

Use the expand query parameter to include related objects:
  • expand=account - Includes full Account object details
  • expand=from_account - Includes full BankAccount object details for the source account
  • expand=to_account - Includes full BankAccount object details for the destination account
  • expand=contact - Includes full Contact object details
  • expand=currency - Includes full Currency object details

​
Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID for the transaction
account_idstringThe account ID of the bank transaction
from_account_idstringThe from account ID of the bank transaction
to_account_idstringThe to account ID of the bank transaction
contact_idstringThe contact ID of the bank transaction
currency_idstringThe currency ID of the bank transaction
transaction_datestringThe transaction date of the bank transaction
amountdoubleThe total amount of the bank transaction
typestringThe type of the bank transaction
statusstringThe status of the bank transaction
currency_ratedoubleThe currency rate of the bank transaction
debit_or_creditenumThe type of transaction
updated_atstringThe date and time the bank transaction was last updated
{
  "rootfi_id": 123,
  "rootfi_created_at": "2024-01-25T09:00:00Z",
  "rootfi_updated_at": "2024-01-25T09:00:00Z",
  "rootfi_company_id": 456,
  "platform_id": "123456_1",
  "platform_unique_id": "123456",
  "account_id": "123456",
  "contact_id": "123456",
  "currency_id": "123456",
  "to_account_id": "123456",
  "from_account_id": "123456",
  "transaction_date": "2022-02-17T00:00:00.000Z",
  "amount": 1234.0,
  "type": "Sales Return",
  "status": "Manually Added",
  "currency_rate": 80.0,
  "debit_or_credit": "CREDIT",
  "updated_at": "2022-02-17T00:00:00.000Z"
}