Returns the chart of accounts with the given identifier.

GET /accounting/chart-of-accounts/{id}

Group: Accounting › Charts of Accounts · Operation ID: getChartOfAccounts

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.
id path string yes The unique identifier for the chart of accounts to return.

Response

200 Success

Under data (getChartOfAccountsOutput):

Field Type Required Description
id string yes The unique identifier for the chart of accounts.
name string yes The display name of the chart of accounts.
accountNumbering string yes 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 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 no A free-form description of the chart of accounts. Absent when none was set.
lastModifiedDate string (date-time) yes The date and time the chart-of-accounts record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Errors

Code Status
NOT_FOUND 400

Statuses