Replace an advance payment category

Operation ID: updateAdvancePaymentCategory

Group: Accounting › Advance Payment Categories

Open in the interactive reference

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

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Replaces an advance payment category. A field you leave out goes back to its default: allowManualPayment goes back to true and status goes back to 'active'. name is required.

Each request deletes all of the category's bank and offset accounts, and this endpoint can't set them again. Until they're set again in the application, employee advances in this category can't be issued.

The legal entity can't be changed.

The response is empty. Read the updated record with GET accounting/advance-payment-categories/:id.

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.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.
id path string yes Id (a UUID) of the advance payment category to update; bound from the :id path segment. Example: "b81f4a22-6d90-4c53-8e17-9f2a4b6c8d05".

Request body

Required, application/json: updateAdvancePaymentCategoryInput.

Field Type Required Description
name string yes Display name of the category. Required — renaming is the primary purpose of an update call. Example: "Standard Advance (renamed)".
allowManualPayment boolean no Whether an employee may be paid this advance manually (outside the standard payment run). Omit to default to true. Example: true.
status string no Lifecycle status. Accepted values: 'active', 'inactive'. Omit to default to 'active'. Example: "active". 
{
  "name": "Standard Advance (renamed)",
  "allowManualPayment": true,
  "status": "active"
}

Response

200 Success

{
  "data": {},
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
CATEGORY_NOT_FOUND 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses