v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB
Accounting
Clients

Get clients

Returns a list of accounting clients

get/consumers/{consumer_id}/accounting/clients

Path parameters

consumer_idstring uuid required

Query parameters

pageinteger

Page number

sizeinteger

Page size

folder_idstring nullable

Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled.

searchstring nullable

Filter based on the following fields: name, email, first_name, last_name, external_reference, vat and company_number

updated_afterstring date-time nullable

Retrieve clients created or updated after a specific datetime (e.g. 2023-01-31T15:00:00 for 31 of January 2023 at 3PM UTC). UTC is the only format that is supported on all connectors.

Response

Successful Response

totalinteger required
pageinteger required
sizeinteger required