Records a payroll payment.

POST /accounting/payroll-payments

Group: Accounting › Payroll Payments · Operation ID: createPayrollPayment

The response contains only the new payment's id. Read the record with GET accounting/payroll-payments/:id if you need its stored state, where payrollPaymentNumber appears once assigned. A payment that would overpay a payroll run, per payee or overall, is refused, but the guard runs after the write and returns no declared error code.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "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: createPayrollPaymentInput.

Field Type Required Description
entityId string yes The legal entity the payment is posted under. See id on GET base/entities.
paymentDate string (date) yes The date the payment is made. Use format YYYY-MM-DD.
paymentCurrency string yes The currency of the payment. Format ISO 4217, for example 'USD'. Governs every application amount.
paymentStatus string yes The status to record the payment with, for example 'manuallyRecorded' or 'scheduled'.
paymentType string no How the payment is made. Values include 'manual' and 'bank'. Defaults to 'manual'.
accountId string no The bank or cash account the payment is drawn from. See id on GET accounting/accounts/:id.
commonDescription string no A description applied to the payment as a whole.
origin string no The source system this record came from, as free-form text, for example 'Ramp'. Omit it and it stays unset. The server does not set a value.
applications array of object yes The payroll runs this payment settles, one application per payroll detail. At least one is required.
applications[].payrollDetailId string yes The payroll detail being paid. See id on GET accounting/payroll-details/:id.
applications[].accountId string yes The account the payment is booked against. See id on GET accounting/accounts/:id.
applications[].payeeCode string yes The payee, as a payroll-payee code from your tenant's configuration, for example 'employee' or 'taxOffice'.
applications[].amountPaid string (decimal) yes The amount applied to this payroll detail, as a decimal in the payment's currency.
applications[].vendorId string no The vendor being paid, when the payee is a third party. See id on GET accounting/vendors/:id.
applications[].employeeId string no The employee being paid. There is no endpoint for it.
applications[].description string no A description for this application.

Example:

{
  "entityId": "8f2c1d40-5a6b-4c7d-9e80-1f2a3b4c5d6e",
  "paymentDate": "2026-08-31",
  "paymentCurrency": "EUR",
  "paymentStatus": "manuallyRecorded",
  "paymentType": "manual",
  "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "commonDescription": "<commonDescription>",
  "origin": "<origin>",
  "applications": [
    {
      "payrollDetailId": "b7e4c1a9-3f52-4d86-9017-5a2c8e0b4d61",
      "accountId": "7c1a9e40-2b53-4d68-9f01-3a5b7c9d1e24",
      "payeeCode": "employee",
      "amountPaid": "12500.00"
    }
  ]
}

Response

200 Success

Under data (createPayrollPaymentOutput):

Field Type Required Description
id string yes The unique identifier for the created payroll payment.

Response headers

Errors

Code Status
REFERENCE_NOT_FOUND 400
NO_APPLICATIONS 400
UNSUPPORTED_PAYMENT_TYPE 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses