Skip to main content
The Accounts Data Model represents a record in an accounting system that tracks the financial activities of a specific asset, liability, equity, revenue, or expense. These records increase and decrease as transactions occur throughout the accounting period. The aggregation of each Account object is often referred to as the Chart of Accounts.
  • Unified account properties: Essential account details like name, description, currency, and current balance are standardized across different accounting platforms
  • Hierarchical structure: Accounts can be linked to parent accounts using the parent_account_id, enabling the representation of complex account structures and relationships
  • Categorisation and status: The model supports account categorisation with main categories (asset, liability, equity, revenue, or expense) and subcategories, as well as tracking account status for better organisation and reporting

Attributes

Account Attributes

PropertyTypeDescription
rootfi_idintegerUnique identifier assigned by Commenda for this account
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 account belongs to within Commenda
platform_idstringUnique identifier for this account in the source accounting platform
platform_unique_idstringAlternative unique identifier from the platform (some platforms provide multiple IDs)
namestringThe name of the account
descriptionstringThe description of the account
nominal_codestringThe nominal code of the account
current_balancedoubleThe current balance of the account
updated_atstringThe date and time the account was last updated
statusenumThe status of the account
categoryenumThe category of the account
sub_categorystringThe sub category of the account
currency_idstringThe currency ID of the account
parent_account_idstringThe parent account ID of the account

Status Enum Values

ValueDescription
activeAccount is active and in use
archivedAccount has been archived
unknownStatus cannot be determined from the platform

Category Enum Values

ValueDescription
assetAccount represents an asset (e.g., cash, inventory, property)
liabilityAccount represents a liability (e.g., loans, accounts payable)
equityAccount represents equity (e.g., retained earnings, capital)
incomeAccount represents income or revenue
expenseAccount represents an expense
unknownCategory cannot be determined from the platform

Expandable Attributes

Use the expand query parameter to include related objects:
  • expand=currency - Includes full Currency object details
  • expand=parent_account - Includes full parent Account object details

Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID to identify this account
namestringThe name of the account
descriptionstringThe description of the account
nominal_codestringThe nominal code of the account
current_balancedoubleThe current balance of the account
statusenumThe status of the account
categoryenumThe category of the account
sub_categorystringThe sub category of the account
currency_idstringThe currency ID of the account
parent_account_idstringThe parent account ID of the account
updated_atstringThe date and time the account was last updated
{
  "rootfi_id": 157,
  "rootfi_created_at": "2024-01-22T05:07:31.465Z",
  "rootfi_updated_at": "2024-01-22T05:07:31.000Z",
  "rootfi_company_id": 1089,
  "platform_id": "123456_1",
  "platform_unique_id": "123456",
  "name": "Professional Services Account",
  "description": "Account for professional consulting services",
  "nominal_code": "A0123",
  "current_balance": 5000.0,
  "updated_at": "2024-01-22T05:07:31.000Z",
  "status": "active",
  "category": "expense",
  "sub_category": "other_expense",
  "currency_id": "123456",
  "parent_account_id": null
}