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

idstring
Prefixed account ID (e.g. acc_6000). Immutable after creation.
codestring
Unique account code within the organisation (e.g. 1100, 6000). Drives sort order and report positioning. Max 20 characters.
namestring
Display name (e.g. Trade Debtors, Marketing). Max 200 characters.
accountTypestring
One of asset, liability, equity, revenue, or expense. Determines balance direction and report section. Immutable on system accounts.
parentIdstring
Prefixed ID of the parent account (e.g. acc_100), or null for root accounts. Parent must share the same account type.
descriptionstring
Optional description of the account's purpose. Max 500 characters.
defaultVatRatestring
Default VAT rate as a whole percentage (e.g. 20 for 20%). Applied as a suggestion when creating transaction lines against this account. Optional.
isActivestring
Whether the account is active. Inactive accounts are excluded from selection lists but retained for reporting on historical transactions.
isSystemstring
Whether the account is a protected system account. System accounts cannot be modified (except isActive) or deleted. Not every seeded account is a system account. Read-only.
isControlAccountstring
Whether the account is tagged as a system-managed control account. This flags the account's role; it does not by itself restrict posting. Posting restrictions apply only to the strict subledger controls (Trade Debtors, Trade Creditors, the VAT accounts, and Bad Debts).
controlTypestring
The control account category, an uppercase tag such as TRADE_DEBTORS, TRADE_CREDITORS, TAX_ON_SALES, TAX_ON_PURCHASES, TAX_LIABILITY, or SUSPENSE. Only meaningful when isControlAccount is true.
createdAtstring
ISO 8601 creation timestamp.
updatedAtstring
ISO 8601 last-updated timestamp.