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.
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
Property Type Description rootfi_id integer Unique identifier assigned by Commenda for this account 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_company_id integer Company identifier this account belongs to within Commenda platform_id string Unique identifier for this account in the source accounting platform name string The name of the account description string The description of the account nominal_code string The nominal code of the account current_balance double The current balance of the account updated_at string The date and time the account was last updated status enum The status of the account category enum The category of the account sub_category string The sub category of the account currency_id string The currency ID of the account parent_account_id string The parent account ID of the account
Status Enum Values
Value Description ACTIVEAccount is active and in use ARCHIVEDAccount has been archived UNKNOWNStatus cannot be determined from the platform
Category Enum Values
Value Description ASSETAccount represents an asset (e.g., cash, inventory, property) EXPENSEAccount represents an expense LIABILITYAccount represents a liability (e.g., loans, accounts payable) EQUITYAccount represents equity (e.g., retained earnings, capital) INCOMEAccount represents income or revenue BANKAccount represents a bank account 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
Property Type Description platform_id string The Platform’s ID to identify this account name string The name of the account description string The description of the account nominal_code string The nominal code of the account current_balance double The current balance of the account status enum The status of the account category enum The category of the account sub_category string The sub category of the account currency_id string The currency ID of the account parent_account_id string The parent account ID of the account updated_at string The date and time the account was last updated
The Account Response Object
{
"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" ,
"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
}