Skip to main content
List ledger accounts

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Query Parameters

fields
string[]

Return only these fields of each row; use dots for nested fields, such as companies.company_id. Fields: number, name, description, type, source_type, saft_code, subledger, is_active, vat_locked, companies.

limit
integer
default:50
Required range: 1 <= x <= 1000
cursor
string
Maximum string length: 4096
company_ids
string<uuid>[]

Only these workspace companies’ rows. Coding an invoice or order uses its company’s. Without it, every company you can access.

Required array length: 1 - 1000 elements

Words that each appear in the number or code, or in the name.

Required string length: 1 - 200
active
boolean

Only active (true) or inactive (false) rows.

ids
string<uuid>[]

Only these records, by id; a row then lists only them.

Required array length: 1 - 1000 elements
sort
enum<string>
default:code

code: by number or code. recent_use: as a picker offers them: a code equal to the search first, then those on the caller’s invoice and order lines of the last 180 days, then on everyone’s, then codes starting with the search, then by code. Counts can change between pages.

Available options:
code,
recent_use
types
enum<string>[]

Only accounts of these types.

Available options:
asset,
liability,
equity,
revenue,
expense
classes
enum<string>[]

Only accounts whose number starts with these digits (the account classes).

Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9
required_dimension_source_ids
string[]

Only accounts that require any of these dimensions, by their source_id.

Required string length: 1 - 200
subledgers
enum<string>[]

Only accounts in these subledgers.

Available options:
general,
customer,
supplier,
employee,
asset
vat_code_ids
string<uuid>[]

Only accounts that can use any of these VAT codes (companies[].id of listVatCodes), as default or allowed, each in its own company.

Required array length: 1 - 1000 elements

Response

One page.

data
object[]
required
Maximum array length: 1000
next_cursor
string | null
required