Retrieve an advance payment category

Operation ID: getAdvancePaymentCategory

Group: Accounting › Advance Payment Categories

Open in the interactive reference

GET /accounting/advance-payment-categories/{id}

Read-only: Reads and returns; changes nothing.

Retrieves an advance payment category. The response gives the category's name, status, and whether manual payment is allowed.

A legal entity has at most one category. To find it by legal entity, filter GET accounting/advance-payment-categories on entityId.

The category's bank and offset accounts for each chart of accounts are not returned.

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.
id path string yes Id of the advance payment category to fetch (a UUID); bound from the :id path segment. Example: "9c1b7e40-3a6d-4f52-8f0b-1d2c7a5e93b1".

Response

200 Success

Under data (getAdvancePaymentCategoryOutput):

Field Type Required Description
id string yes Id of the advance payment category (a UUID) — the public identifier used by this route.
entityId string yes Id (a UUID) of the legal entity this category belongs to. An entity has at most one advance payment category.
name string yes Display name of the category. Renaming an existing category is done by calling upsert again with the same entityId and a new name — the underlying write is a rename in place, not a new record.
allowManualPayment boolean no Whether an employee may be paid this advance manually (outside the standard payment run). Defaults to true.
status string no Lifecycle status. Possible values: 'active', 'inactive'. Defaults to 'active'.
lastModifiedDate date-time yes Instant the advance payment category last changed, as ISO 8601 UTC (YYYY-MM-DDTHH:mm:ss.sssZ). Poll on this to sync incrementally rather than re-reading the whole collection. 
{
  "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"
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Errors

Code Status
NOT_FOUND 400

Statuses