Skip to main content
List VAT codes

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: code, name, rate, is_active, 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
rates
string[]

Only VAT codes with these rates, in percent.

Pattern: ^-?\d+(\.\d+)?$

Response

One page.

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