Skip to main content
POST
Fetch a list of accounts

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

Represents a request to search for accounts.

companyId
string<uuid>
required

Filter by company ID.

Example:

"123e4567-e89b-12d3-a456-426614174011"

excludeIfAssignedToCategory
boolean
default:false
required

Exclude bookkeeping accounts assigned to a bookkeeping category.

Example:

false

excludeIfAssignedToContraAccount
boolean
default:false
required

Exclude bookkeeping accounts assigned to a contra account.

Example:

false

archived
boolean | null

Filter by archived status.

Example:

false

code
string | null
deprecated

Search by code.

Example:

"2001"

codes
(string | null)[] | null

Search by a list of codes.

Search by a list of codes.

externalId
string | null

Search by external id.

Example:

"123e4567-e89b-12d3-a456-426614174011"

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

Filter by a list of account IDs.

Filter by a list of account IDs.

name
string | null

Search by name.

Example:

"Bank Charges"

Response

Retrieval of accounts successful.

data
object[]
required
pagination
object
required