Create an advance payment category

Operation ID: createAdvancePaymentCategory

Group: Accounting › Advance Payment Categories

Open in the interactive reference

POST /accounting/advance-payment-categories

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

Creates an advance payment category for a legal entity. A legal entity can have only one category. The response is only the new category's id.

The category's bank and offset accounts for each chart of accounts can't be set through this endpoint. Until they're set in the application, employee advances in this category can't be issued.

Read the new record with GET accounting/advance-payment-categories/:id. To change a legal entity's existing category, use PATCH 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.

Request body

Required, application/json: createAdvancePaymentCategoryInput.

Field Type Required Description
entityId string yes Id (a UUID) of the legal entity this category belongs to. An entity has at most one advance payment category. Example: "7c1a9e40-2b53-4d68-9f01-3a5b7c9d1e24".
name string yes Display name of the category. Required. Example: "Standard Advance".
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". 
{
  "entityId": "7c1a9e40-2b53-4d68-9f01-3a5b7c9d1e24",
  "name": "Standard Advance",
  "allowManualPayment": true,
  "status": "active"
}

Response

200 Success

Under data (createAdvancePaymentCategoryOutput):

Field Type Required Description
id string yes Id (a UUID) of the newly created advance payment category. This is the only field a write returns; read the record back with GET accounting/advance-payment-categories/{id} if you need its stored state. Example: "b81f4a22-6d90-4c53-8e17-9f2a4b6c8d05". 
{
  "data": {
    "id": "b81f4a22-6d90-4c53-8e17-9f2a4b6c8d05"
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
REFERENCE_NOT_FOUND 400
CATEGORY_ALREADY_EXISTS 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses