# List payroll payments

Operation ID: `payrollPayments`

Group: Accounting › Payroll Payments

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

`GET /accounting/payroll-payments`

Read-only: Reads and returns; changes nothing.

Lists payroll payments, without their applications. To get the applications, use GET accounting/payroll-payments/:id or POST accounting/payroll-payments/search.

## 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`. |

## Query surface

- `id` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- `payrollPaymentNumber` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- `paymentDate` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
- `paymentCurrency` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- `paymentType` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- `status` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- `approvalStatus` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- `externalId` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- `lastModifiedDate` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
- Orderable: id, payrollPaymentNumber, paymentDate, paymentCurrency, paymentType, status, totalPaid, lastModifiedDate
- Selectable: id, payrollPaymentNumber, paymentDate, paymentCurrency, paymentType, status, approvalStatus, description, totalPaid, externalId, paymentAccountName, entityName, lastModifiedDate
- `page[size]` — Page size
- `page[cursor]` — Opaque continuation cursor

## Response

`200` Success

Under `data`, an array of payrollPaymentsRow:

| Field | Type | Required | Filter | Sort | Description |
| --- | --- | --- | --- | --- | --- |
| `id` | string | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`), Pattern (`like`) | yes | The unique identifier for the payroll payment. |
| `payrollPaymentNumber` | string \| null | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`), Pattern (`like`) | yes | The payment number. Absent until a number has been assigned. |
| `paymentDate` | date | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`) | yes | The date the payment is made. Format YYYY-MM-DD. |
| `paymentCurrency` | string | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`), Pattern (`like`) | yes | The currency the payment is made in. Format ISO 4217, for example 'USD'. Governs totalPaid. |
| `paymentType` | string | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`), Pattern (`like`) | yes | How the payment was made: the instrument, not the origin. Values include 'manual' and 'bank'. |
| `status` | string | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`), Pattern (`like`) | yes | The status of the payment. Values include 'successful', 'rejected', 'cancelled', 'processing', 'partiallySuccessful', 'unknown', 'unsigned', 'manuallyRecorded', 'scheduled' and 'voided'. |
| `approvalStatus` | string \| null | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`), Pattern (`like`) | no | The approval status of the payment. |
| `description` | string \| null | no | no | no | A description recorded on the payment. |
| `totalPaid` | decimal \| null | no | no | yes | The total amount paid, in paymentCurrency. |
| `externalId` | string \| null | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`), Pattern (`like`) | no | The identifier this payment has in the upstream system that produced it. It is not unique. |
| `paymentAccountName` | string \| null | no | no | no | The name of the general ledger account the payment is booked against. |
| `entityName` | string \| null | no | no | no | The name of the legal entity that made the payment. |
| `lastModifiedDate` | date-time \| null | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`) | yes | The date and time the payroll payment last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |

```json
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "payrollPaymentNumber": "<payrollPaymentNumber>",
      "paymentDate": "2026-01-15",
      "paymentCurrency": "<paymentCurrency>",
      "paymentType": "<paymentType>",
      "status": "<status>",
      "approvalStatus": "<approvalStatus>",
      "description": "<description>",
      "totalPaid": "19.99",
      "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "paymentAccountName": "<paymentAccountName>",
      "entityName": "<entityName>",
      "lastModifiedDate": "2026-01-15T09:30:00.000Z"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "<nextCursor>"
  }
}
```

## Statuses

- `400` — Invalid request or business failure
- `401` — The request carries no valid access token.
- `403` — Not authorized
- `404` — Not found
- `429` — Too many requests from this client address. The response has no body and no `Retry-After` header.
- `500` — Internal server error