The Accounts object

An account object represents a single entry in the chart of accounts. The code is unique within the organisation and drives sort order. The account type is immutable on system accounts and determines balance direction in reports.

Attributes

id string
Prefixed account ID (e.g. acc_1200). Immutable after creation.
code string
Unique account code within the organisation (e.g. 1200, 4000). Drives sort order and report positioning. Max 20 characters.
name string
Display name (e.g. Trade Debtors, Sales). Max 200 characters.
accountType string
One of asset, liability, equity, revenue, or expense. Determines balance direction and report section. Immutable on system accounts.
parentId string
Prefixed ID of the parent account (e.g. acc_100), or null for root accounts. Parent must share the same account type.
description string
Optional description of the account's purpose. Max 500 characters.
defaultVatRate string
Default VAT rate as a whole percentage (e.g. 20 for 20%). Applied as a suggestion when creating transaction lines against this account. Optional.
isActive string
Whether the account is active. Inactive accounts are excluded from selection lists but retained for reporting on historical transactions.
isSystem string
Whether the account was seeded during organisation setup. System accounts cannot be modified (except isActive) or deleted. Read-only.
isControlAccount string
Whether this is a control account used in automated journal creation (e.g. Trade Debtors for invoice finalisation).
controlType string
The control account category (e.g. trade_debtors, trade_creditors, vat_control). Only meaningful when isControlAccount is true.
createdAt string
ISO 8601 creation timestamp.
updatedAt string
ISO 8601 last-updated timestamp.