Update Payroll Payment

PATCH /accounting/payroll-payments/{id}

Group: Accounting › Payroll Payments · Operation ID: updatePayrollPayment

Updates the payroll payment with the given identifier. Only the fields in the request body change.

Only the fields in the request body change. entityId cannot be changed. Applications change through three arrays, applied in the order delete, then update, then create. updateApplications and deleteApplications address applications by the id this payment publishes, and an id belonging to another payment is refused with APPLICATION_NOT_FOUND. A change that would leave the payment with no applications is refused with NO_APPLICATIONS. Delete the payment instead. Only a payment that has not moved money can be changed. Anything else is refused with PAYMENT_NOT_EDITABLE. The response is empty. Read the record with GET accounting/payroll-payments/:id.

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.
id path string yes The unique identifier for the payroll payment to update.

Request body

Required, application/json: updatePayrollPaymentInput.

Field Type Required Description
paymentDate string (date) no The date the payment is made. Use format YYYY-MM-DD. Omit to leave unchanged.
paymentCurrency string no The currency of the payment. Format ISO 4217, for example 'USD'. Omit to leave unchanged.
paymentStatus string no The status of the payment, for example 'manuallyRecorded' or 'scheduled'. Omit to leave unchanged.
paymentType string no How the payment is made. Values include 'manual' and 'bank'. Omit to leave unchanged.
accountId string no The bank or cash account the payment is drawn from. See id on GET accounting/accounts/:id. Omit to leave unchanged.
commonDescription string no A description applied to the payment as a whole. Omit to leave unchanged.
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.
createApplications array of object no Applications to add to this payment, each with the same shape as on create and no id. Omit for no additions.
createApplications[].payrollDetailId string yes The payroll detail being paid. See id on GET accounting/payroll-details/:id.
createApplications[].accountId string yes The account the payment is booked against. See id on GET accounting/accounts/:id.
createApplications[].payeeCode string yes The payee, as a payroll-payee code from your tenant's configuration, for example 'employee' or 'taxOffice'.
createApplications[].amountPaid string (decimal) yes The amount applied to this payroll detail, as a decimal in the payment's currency.
createApplications[].vendorId string no The vendor being paid, when the payee is a third party. See id on GET accounting/vendors/:id.
createApplications[].employeeId string no The employee being paid. There is no endpoint for it.
createApplications[].description string no A description for this application.
updateApplications array of object no Applications to change, each addressed by the id this payment publishes. Every field but the id is optional and left unchanged when omitted. Omit for no changes.
updateApplications[].id string yes The unique identifier for the application to change. It must belong to this payment.
updateApplications[].payrollDetailId string no The payroll detail being paid. See id on GET accounting/payroll-details/:id. Omit to leave unchanged.
updateApplications[].accountId string no The account the payment is booked against. See id on GET accounting/accounts/:id. Omit to leave unchanged.
updateApplications[].payeeCode string no The payee, as a payroll-payee code from your tenant's configuration. Omit to leave unchanged.
updateApplications[].amountPaid string (decimal) no The amount applied to this payroll detail, as a decimal. Omit to leave unchanged.
updateApplications[].vendorId string no The vendor being paid, when the payee is a third party. See id on GET accounting/vendors/:id.
updateApplications[].employeeId string no The employee being paid. There is no endpoint for it.
updateApplications[].description string no A description for this application.
deleteApplications array of string no The identifiers of applications to remove, applied before the updates and creates. Each must belong to this payment. Removing them all is refused. Delete the payment instead.

Example:

{
  "paymentDate": "2026-01-15",
  "paymentCurrency": "<paymentCurrency>",
  "paymentStatus": "<paymentStatus>",
  "paymentType": "<paymentType>",
  "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "commonDescription": "August payroll run (revised)",
  "origin": "<origin>",
  "createApplications": [
    {
      "payrollDetailId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "payeeCode": "<payeeCode>",
      "amountPaid": "19.99",
      "vendorId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "employeeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "description": "<description>"
    }
  ],
  "updateApplications": [
    {
      "id": "9b2d5e10-4c78-4a36-8f51-6e0a3c7b2d95",
      "amountPaid": "12750.00"
    }
  ],
  "deleteApplications": [
    "<deleteApplications>"
  ]
}

Response

200 Success

Response headers

Errors

Code Status
NOT_FOUND 400
REFERENCE_NOT_FOUND 400
APPLICATION_NOT_FOUND 400
NO_APPLICATIONS 400
UNSUPPORTED_PAYMENT_TYPE 400
PAYMENT_NOT_EDITABLE 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses