List advance payment categories
Operation ID: advancePaymentCategories
Group: Accounting › Advance Payment Categories
Open in the interactive reference
GET /accounting/advance-payment-categories
Read-only: Reads and returns; changes nothing.
Lists advance payment categories.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Api-Version |
header | string · v1 | yes | The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1. |
Query surface
id— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likeentityId— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likename— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likeallowManualPayment— filter by eq, ne, gt, gte, lt, lte, in, notIn, betweenstatus— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likelastModifiedDate— filter by eq, ne, gt, gte, lt, lte, in, notIn, between- Orderable: id, name, status, lastModifiedDate
- Selectable: id, entityId, name, allowManualPayment, status, lastModifiedDate
page[size]— Page sizepage[cursor]— Opaque continuation cursor
Response
200 Success
Under data, an array of advancePaymentCategoriesRow:
| Field | Type | Required | Filter | Sort | Description |
|---|---|---|---|---|---|
id |
string | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | Stable, platform-assigned id (a UUID) of the advance payment category — the public identifier used by GET accounting/advance-payment-categories/:id. Filter e.g. filter[id][in]=<id1>,<id2>. |
entityId |
string | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
no | Id (a UUID) of the legal entity this category belongs to. An entity has at most one advance payment category, so filter[entityId][eq]=<entityUuid> is the way to find 'the' category for an entity. |
name |
string | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | Display name of the category. Filter target: filter[name][like]=Standard, or filter[name][eq]=Standard Advance. |
allowManualPayment |
boolean | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) |
no | Whether an employee may be paid this advance manually (outside the standard payment run). Filter target: filter[allowManualPayment][eq]=true. |
status |
string | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | Lifecycle status. Possible values: 'active', 'inactive'. Filter target: filter[status][eq]=active. |
lastModifiedDate |
date-time | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) |
yes | Instant the advance payment category last changed, as ISO 8601 UTC (YYYY-MM-DDTHH:mm:ss.sssZ). filter[lastModifiedDate][gte]=… plus sort=lastModifiedDate is a complete incremental-sync cursor. |
{
"data": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "<name>",
"allowManualPayment": true,
"status": "<status>",
"lastModifiedDate": "2026-01-15T09:30:00.000Z"
}
],
"pagination": {
"hasMore": true,
"nextCursor": "<nextCursor>"
}
}
Statuses
400— Invalid request or business failure401— The request carries no valid access token.403— Not authorized404— Not found429— Too many requests from this client address. The response has no body and noRetry-Afterheader.500— Internal server error