PLpleo
Accounts

Fetch a list of accounts

Retrieves a list of accounts with optional filters for companyId, ids, name, code and archived status. Results are paginated.

post/v1-beta/accounts:search

Request

Query parameters

beforestring

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

afterstring

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

offsetinteger

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

limitinteger

The maximum amount of items to return

sorting_keysstring[]

The keys to sort the results by

sorting_orderPageOrder[]

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

Request body

archivedboolean nullable

Filter by archived status.

codestring nullable

Search by code.

companyIdstring uuid required

Filter by company ID.

externalIdstring nullable

Search by external id.

idsstring[] nullable

Filter by a list of account IDs.

namestring nullable

Search by name.

Example request

{
  "code": "2001",
  "companyId": "123e4567-e89b-12d3-a456-426614174011",
  "externalId": "123e4567-e89b-12d3-a456-426614174011",
  "name": "Bank Charges"
}

Response

Fetch of accounts successful.

Changes

No recorded changes to this operation across all 1 revision of this API.