Accounts

GET /accounting/accounts

Group: Accounting › Accounts · Operation ID: accounts

Returns a list of accounts. To match on name or by external identifier, use POST accounting/accounts/search.

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
accountNumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
accountType — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
accountSubType — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
accountStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
chartOfAccountsId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
parentAccountId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
groupingAccount — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
entityId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
currency — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
revaluation — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
payOnBehalf — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
elimination — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
exchangeRateType — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, accountNumber, accountType, accountSubType, accountStatus, chartOfAccountsId, groupingAccount, entityId, currency, lastModifiedDate
Selectable: id, accountNumber, accountName, accountType, accountSubType, accountStatus, description, chartOfAccountsId, parentAccountId, groupingAccount, entityId, currency, revaluation, payOnBehalf, elimination, exchangeRateType, lastModifiedDate

Response

200 Success

Under data, an array of accountsRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the account.
`accountNumber`	string	no	The account number, unique within its chart of accounts.
`accountName`	string	no	The display name of the account.
`accountType`	string	no	The top-level classification of the account. Possible values: 'asset', 'liability', 'equity', 'income', 'costOfGoodsSold', 'expense', 'otherIncome', 'otherExpense'.
`accountSubType`	string or null	no	A finer classification within accountType. Possible values: 'bank', 'accountsReceivable', 'fixedAsset', 'cip', 'prepaidExpenses', 'deferredExpenses', 'otherCurrentAsset', 'otherAsset', 'unbilledReceivable', 'longTermAsset', 'accountsPayable', 'creditCard', 'deferredRevenue', 'otherCurrentLiability', 'longTermLiability', 'equity', 'income', 'costOfGoodsSold', 'expense', 'otherIncome', 'otherExpense', 'otherComprehensiveIncome'. Absent when none is assigned.
`accountStatus`	string or null	no	The lifecycle status of the account. Possible values: 'enabled' (available on transactions), 'disabled' (not available for new transactions), 'draft' (created but not yet reviewed), 'draftErrors' (a draft with validation errors to resolve before it can be enabled).
`description`	string or null	no	A free-form description of the account. Absent when none was set.
`chartOfAccountsId`	string or null	no	The identifier of the chart of accounts this account belongs to. An account belongs to exactly one. See id on GET accounting/chart-of-accounts/:id.
`parentAccountId`	string or null	no	The identifier of the parent account this account rolls up to. Absent for a top-level account. See id on GET accounting/accounts/:id.
`groupingAccount`	boolean	no	Whether this is a grouping (rollup) account. Balances from child accounts aggregate here, and journal entries cannot be posted to it directly.
`entityId`	string or null	no	The identifier of the legal entity this account is denominated for. Set only on bank and credit-card accounts. See id on GET base/entities.
`currency`	string or null	no	The account's currency. Format ISO 4217, for example 'USD'. Set only on accounts linked to a cash account, alongside entityId.
`revaluation`	boolean or null	no	Whether balances on this account are revalued for exchange-rate changes.
`payOnBehalf`	boolean or null	no	Whether this account takes part in pay-on-behalf accounting.
`elimination`	boolean or null	no	Whether this account is eliminated during consolidation.
`exchangeRateType`	string or null	no	Which rate translates this account's amounts on revaluation. Possible values: 'historical', 'average', 'current'. Absent on grouping accounts.
`lastModifiedDate`	string (date-time) or null	no	The date and time the account record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error