Issue an employee advance request

Operation ID: issueEmployeeAdvanceRequest

Group: Accounting › Employee Advances

POST /accounting/employee-advances/{id}/issue

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

Issues the payment for an approved employee advance request. Creates the outbound payment and its journal entry for an approved request, links the payment to the request, and sets the request's status to 'issued'.

Only a request in 'approved' status can be issued. For any other status, the request fails with NOT_APPROVED.

The accounts and currency come from the request's category and legal entity, not from the request body. The request fails if the category has no bank and offset account for the legal entity's leading book, with an error that has no code in the error list. The response contains the payment's id. To see the payment, use GET accounting/outbound-payments/: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 approved advance request to issue. Example: `"b81f4a22-6d90-4c53-8e17-9f2a4b6c8d05"`.

Request body

Required, application/json: issueEmployeeAdvanceRequestInput.

Field	Type	Required	Description
`paymentDate`	date	no	Payment execution date. Omit to default to the appserver's current day. Example: `"2026-09-05"`.

{
  "paymentDate": "2026-09-05"
}

Response

200 Success

Under data (issueEmployeeAdvanceRequestOutput):

Field	Type	Required	Description
`outboundPaymentId`	string	yes	Id (a UUID) of the OutboundPaymentHeaderBase created for this issuance. Example: `"c3d8f4a1-7e2b-4c95-9a03-5f1d8e6b2c47"`.

{
  "data": {
    "outboundPaymentId": "c3d8f4a1-7e2b-4c95-9a03-5f1d8e6b2c47"
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Idempotency-Replayed — Present and true only when this response replays a previously stored one for the same Idempotency-Key, rather than reflecting a live execution. Absent on a live response - never sent as false.

Errors

Code	Status
`REQUEST_NOT_FOUND`	400
`NOT_APPROVED`	400
`IDEMPOTENCY_KEY_CONFLICT`	409
`IDEMPOTENCY_PAYLOAD_MISMATCH`	422

Statuses

400 — Invalid request or business failure. Codes: REQUEST_NOT_FOUND, NOT_APPROVED
401 — The request carries no valid access token.
403 — Not authorized
404 — Not found
409 — The Idempotency-Key is still being processed by another request.
422 — The Idempotency-Key was already used with a different request payload.
429 — Too many requests from this client address. The response has no body and no Retry-After header.
500 — Internal server error