🏦 Accounts

Chart of accounts and account management

List accounts

get
/api/v1.0/organisation/{org_id}/accounts/

List all accounts (chart of accounts) for an organization

Authorizations
AuthorizationstringRequired
Path parameters
org_idstringRequired
Query parameters
account_categorystringOptional

Filter by account category

account_typestring · enumOptional

Filter by account type

Possible values:
is_activestringOptional

Filter by active status (true/false)

parent_accountstringOptional

Filter by parent account unique_id (use "null" for top-level accounts)

searchstringOptional

Search account_code or name

Responses
chevron-right
200Success
application/json
get
/api/v1.0/organisation/{org_id}/accounts/

Create account

post
/api/v1.0/organisation/{org_id}/accounts/create/

Create a new account in the chart of accounts

Authorizations
AuthorizationstringRequired
Path parameters
org_idstringRequired
Body

Comprehensive serializer for Account model. Handles chart of accounts with multilingual support and hierarchy.

unique_idstring · max: 100 · nullableOptional
namestring · min: 1Required
descriptionstring · nullableOptional
account_codestring · min: 1 · max: 20Required
account_typestring · enumRequired
  • asset - Asset
  • liability - Liability
  • equity - Equity
  • income - Income
  • expense - Expense
Possible values:
account_categorystring · enumRequired
  • current_assets - Current Assets
  • fixed_assets - Fixed Assets
  • intangible_assets - Intangible Assets
  • current_liabilities - Current Liabilities
  • long_term_liabilities - Long-term Liabilities
  • owner_equity - Owner Equity
  • retained_earnings - Retained Earnings
  • operating_income - Operating Income
  • other_income - Other Income
  • cost_of_goods_sold - Cost of Goods Sold
  • operating_expenses - Operating Expenses
  • administrative_expenses - Administrative Expenses
  • financial_expenses - Financial Expenses
  • other_expenses - Other Expenses
Possible values:
parent_account_idstring · min: 1 · nullableWrite-onlyOptional
is_activebooleanOptional
is_system_accountbooleanOptional

System accounts cannot be deleted

Responses
post
/api/v1.0/organisation/{org_id}/accounts/create/

Get account

get
/api/v1.0/organisation/{org_id}/accounts/{account_id}/

Retrieve a specific account by ID

Authorizations
AuthorizationstringRequired
Path parameters
account_idstringRequired
org_idstringRequired
Responses
chevron-right
200Success
application/json
get
/api/v1.0/organisation/{org_id}/accounts/{account_id}/

Update account

put
/api/v1.0/organisation/{org_id}/accounts/{account_id}/update/

Update an existing account

Authorizations
AuthorizationstringRequired
Path parameters
account_idstringRequired
org_idstringRequired
Body

Comprehensive serializer for Account model. Handles chart of accounts with multilingual support and hierarchy.

unique_idstring · max: 100 · nullableOptional
namestring · min: 1Required
descriptionstring · nullableOptional
account_codestring · min: 1 · max: 20Required
account_typestring · enumRequired
  • asset - Asset
  • liability - Liability
  • equity - Equity
  • income - Income
  • expense - Expense
Possible values:
account_categorystring · enumRequired
  • current_assets - Current Assets
  • fixed_assets - Fixed Assets
  • intangible_assets - Intangible Assets
  • current_liabilities - Current Liabilities
  • long_term_liabilities - Long-term Liabilities
  • owner_equity - Owner Equity
  • retained_earnings - Retained Earnings
  • operating_income - Operating Income
  • other_income - Other Income
  • cost_of_goods_sold - Cost of Goods Sold
  • operating_expenses - Operating Expenses
  • administrative_expenses - Administrative Expenses
  • financial_expenses - Financial Expenses
  • other_expenses - Other Expenses
Possible values:
parent_account_idstring · min: 1 · nullableWrite-onlyOptional
is_activebooleanOptional
is_system_accountbooleanOptional

System accounts cannot be deleted

Responses
chevron-right
200Success
application/json
put
/api/v1.0/organisation/{org_id}/accounts/{account_id}/update/

Update account

patch
/api/v1.0/organisation/{org_id}/accounts/{account_id}/update/

Update an existing account

Authorizations
AuthorizationstringRequired
Path parameters
account_idstringRequired
org_idstringRequired
Body

Comprehensive serializer for Account model. Handles chart of accounts with multilingual support and hierarchy.

unique_idstring · max: 100 · nullableOptional
namestring · min: 1Optional
descriptionstring · nullableOptional
account_codestring · min: 1 · max: 20Optional
account_typestring · enumOptional
  • asset - Asset
  • liability - Liability
  • equity - Equity
  • income - Income
  • expense - Expense
Possible values:
account_categorystring · enumOptional
  • current_assets - Current Assets
  • fixed_assets - Fixed Assets
  • intangible_assets - Intangible Assets
  • current_liabilities - Current Liabilities
  • long_term_liabilities - Long-term Liabilities
  • owner_equity - Owner Equity
  • retained_earnings - Retained Earnings
  • operating_income - Operating Income
  • other_income - Other Income
  • cost_of_goods_sold - Cost of Goods Sold
  • operating_expenses - Operating Expenses
  • administrative_expenses - Administrative Expenses
  • financial_expenses - Financial Expenses
  • other_expenses - Other Expenses
Possible values:
parent_account_idstring · min: 1 · nullableWrite-onlyOptional
is_activebooleanOptional
is_system_accountbooleanOptional

System accounts cannot be deleted

Responses
chevron-right
200Success
application/json
patch
/api/v1.0/organisation/{org_id}/accounts/{account_id}/update/

Perform account action

get
/api/v1.0/organisation/{org_id}/accounts/{account_id}/action/

Perform an action on an account using query parameter.

**Available Actions:**
- `activate` - Activate a deactivated account
- `deactivate` - Deactivate an account (soft delete, use instead of deleting accounts with transactions)

**Examples:**
- `/accounts/{id}/action?action=activate`
- `/accounts/{id}/action?action=deactivate`
Authorizations
AuthorizationstringRequired
Path parameters
account_idstringRequired
org_idstringRequired
Responses
chevron-right
200Success
application/json
get
/api/v1.0/organisation/{org_id}/accounts/{account_id}/action/

Last updated