Charts Of Accounts
GET /accounting/chart-of-accounts
Group: Accounting › Charts of Accounts · Operation ID: chartsOfAccounts
Returns a list of charts of accounts, ordered by name. To match on name or description, use POST accounting/chart-of-accounts/search.
Open in the interactive reference
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, likeaccountNumbering— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likeaccountNumberingDigits— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likelastModifiedDate— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like- Orderable: id, name, accountNumbering, accountNumberingDigits, lastModifiedDate
- Selectable: id, name, accountNumbering, accountNumberingDigits, description, lastModifiedDate
Response
200 Success
Under data, an array of chartsOfAccountsRow:
| Field | Type | Required | Description |
|---|---|---|---|
id |
string | no | The unique identifier for the chart of accounts. |
name |
string | no | The display name of the chart of accounts. |
accountNumbering |
string | no | How account numbers are assigned within this chart of accounts. Possible values: 'hierarchical' (numbers follow the account's position in the hierarchy), 'manual' (numbers are assigned by hand). |
accountNumberingDigits |
string or null | no | The total width of an account number, which caps how deep the hierarchy can go. Possible values: 'sixDigits' (up to 4 levels), 'sevenDigits' (5), 'eightDigits' (6), 'nineDigits' (7), 'tenDigits' (8). Absent when no width was set. A width and the numbering strategy are independent, so check this field directly rather than inferring it from accountNumbering. |
description |
string or null | no | A free-form description of the chart of accounts. Absent when none was set. |
lastModifiedDate |
string (date-time) or null | no | The date and time the chart-of-accounts record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |
Statuses
400— Invalid request or business failure401— Missing or invalid access token403— Not authorized404— Not found429— Too many requests500— Internal server error