Skip to main content
POST
Fetch a list of bookkeeping categories

Authorizations

Authorization
string
header
required

JWT Bearer token authentication. Include the token in the Authorization header as: Bearer <token>

Query Parameters

before
string

Lower bound of the page of data to return (cannot be used together with [after] or [offset]).

Pattern: ^[A-Z2-7=~]+$
after
string

Upper bound of the page of data to return (cannot be used together with [before] or [offset]).

Pattern: ^[A-Z2-7=~]+$
offset
integer<int64>

Offset of the page of data to return (cannot be used together with [before] or [after]).

Required range: x >= 0
limit
integer<int32>

The maximum amount of items to return.

Required range: x >= 0
sorting_keys
string[]

The keys to sort the results by.

sorting_order
enum<string>[]

The order to sort the results by. Must be the same length as [sortingKeys]; one order per key.

Available options:
ASC,
ASC_NULLS_FIRST,
ASC_NULLS_LAST,
DESC,
DESC_NULLS_FIRST,
DESC_NULLS_LAST

Body

application/json;charset=UTF-8
companyId
string<uuid>
required

Filter by company ID.

accountIds
(string<uuid> | null)[] | null

Filter by a list of bookkeeping account IDs.

Filter by a list of bookkeeping account IDs.

archived
boolean | null

Filter by archived status.

categoryGroupIds
(string<uuid> | null)[] | null

Filter by a list of bookkeeping category group IDs.

Filter by a list of bookkeeping category group IDs.

ids
(string<uuid> | null)[] | null

Filter by a list of bookkeeping category IDs.

Filter by a list of bookkeeping category IDs.

name
string | null

Search by bookkeeping category name.

Response

200 - application/json

Bookkeeping categories fetched successfully.

data
object[]
required
pagination
object
required