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 Transactions 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_integration_typeenum
platform_idstringUnique identifier for this bank transaction in the source accounting platform
contact_idstringThe contact ID of the bank 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
currency_idenumISO 4217 currency code
amountdoubleThe total amount of the bank transaction
typestringThe type of the bank transaction
debit_or_creditenumThe type of transaction
statusstringThe status of the bank transaction
currency_ratedoubleThe currency rate of the bank transaction
transaction_datestringThe transaction date of the bank transaction
updated_atstringThe date and time the bank transaction was last updated

Debit Or Credit Enum Values

ValueDescription
CREDITTransaction is a credit entry
DEBITTransaction 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:
PropertyTypeDescription
platform_idstringUnique identifier for this bank transaction in the source accounting platform
contact_idstringThe contact ID of the bank 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
currency_idenumISO 4217 currency code
amountdoubleThe total amount of the bank transaction
typestringThe type of the bank transaction
debit_or_creditenumThe type of transaction
statusstringThe status of the bank transaction
currency_ratedoubleThe currency rate of the bank transaction
transaction_datestringThe transaction date of the bank transaction
updated_atstringThe date and time the bank transaction was last updated