# Update a payroll payment

Operation ID: `updatePayrollPayment`

Group: Accounting › Payroll Payments

[Open in the interactive reference](https://docs.api.lensing.ai/lensing/v1/endpoints/updatePayrollPayment)

`PATCH /accounting/payroll-payments/{id}`

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

Updates a payroll payment with the fields you send. A field you leave out keeps its current value.

Use the payroll payment's id, not its payrollPaymentNumber.

Applications change through three separate arrays, applied in this order: deleteApplications, updateApplications, createApplications. Leave out all three to keep the applications as they are.

The payment's applications can change too. The legal entity can't be changed.

The payment's status must be 'manuallyRecorded', 'scheduled', 'unknown', 'rejected', or 'cancelled', or the request fails with PAYMENT_NOT_EDITABLE. An update that would overpay a payroll detail is refused with an error that has no code in the error list.

The payment must keep at least one application. To remove every application, delete the payment instead.

The response is empty. To see the updated payment, use GET accounting/payroll-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 | The unique identifier of the payroll payment you want to update. Example: `"3f1a8c25-9d47-4e60-b892-0c5a7e3b1d84"`. |

## Request body

Required, `application/json`: updatePayrollPaymentInput.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `paymentDate` | 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. Example: `"August payroll run (revised)"`. |
| `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<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` | 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<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. Example: `[{"id":"9b2d5e10-4c78-4a36-8f51-6e0a3c7b2d95","amountPaid":"12750.00"}]`. |
| `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` | 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<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. |

```json
{
  "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

```json
{
  "data": {},
  "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 |
| --- | --- |
| `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

- `400` — Invalid request or business failure. Codes: NOT_FOUND, REFERENCE_NOT_FOUND, APPLICATION_NOT_FOUND, NO_APPLICATIONS, UNSUPPORTED_PAYMENT_TYPE, PAYMENT_NOT_EDITABLE
- `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