List the live chart of accounts

Lists the ledgers, i.e. general ledger (GL) accounts, in the organization's live chart of accounts, sorted by name. Each ledger has its id, name, sortCode (account number), type, subType, debitCredit (natural balance), financialAccountType (set when the ledger represents a bank or card account), and parentId (use it to reconstruct the hierarchy). Each ledger also says which changes the system allows before you write: isRequired and requiredLedgerPurpose mark required ledgers, which the accounting system needs and which can't be deleted; editable says whether line entries can be manually added to or removed from the ledger; deletable says whether it can be deleted now, and when it can't, deleteBlockedReason says why: required, hasActivity (it has line entries), linkedSource (it is linked to a bank or card account), or integrationMapped (an invoicing, commerce, or Plaid integration is mapped to it). Filter with type, subType, debitCredit, and ids; filters combine, so a ledger must match all of them. Results are paginated: pass a response's nextPageToken as pageToken to fetch the next page. To read one ledger by ID, use getBooksLedger.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid

The Books instance to act on. Must be the token organization's own instance, which it defaults to.

string
enum

Only return ledgers of this type.

Allowed:
string
enum

Only return ledgers of this sub-type.

string
enum

Only return ledgers with this natural balance.

Allowed:
ids
array of strings

Comma-separated list of at most 100 distinct ledger IDs. Only return these ledgers. Every ID must belong to the Books instance. Results are still paginated, so pass a limit of at least the number of IDs to get them all in one page.

ids
string

token for pagination

integer
1 to 1000
Defaults to 50

The maximum number of accounts to return per page, from 1 to 1000. Defaults to 50.

Responses

400

Invalid limit or pageToken or ids or debitCredit or subType or type or booksId

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json