---
title: "List Pay Items"
method: GET
path: "/v1/pay-items"
tags: ["Pay Items"]
---

# List Pay Items

`GET /v1/pay-items`

Lists pay items for a company with optional filtering by employment, date range, and pagination.

## Scopes

| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage payroll runs (`payroll`) | View pay items (`pay_item:read`) | Manage pay items (`pay_item:write`) |

## Query parameters

- `employment_slug` string, uuid — Identifier of the employment being terminated.
- `effective_from` string, date — UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
- `effective_to` string, date — UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
- `page` integer
- `page_size` integer

## Response `200`

Success

- ListPayItemsResponse
  - `data` object, required
    - `current_page` integer, required — Current page number
    - `data` PayItem[], required — List of pay items
      - `amount` integer, required — Value of the pay item (e.g. duration in seconds, amount in cents)
      - `code` string, required — Pay item type code
      - `effective_date` string, date, required — Working day date (YYYY-MM-DD)
      - `employment_id` string, uuid, required — Identifier of the employment being terminated.
      - `provider_data` PayItemProviderData, required
        - `adjustment_effective_date` string, date — Correction date for a previously submitted day (YYYY-MM-DD)
        - `hourly_rate` integer — Hourly rate in cents
        - `hourly_rate_currency_code` string, nullable — Currency code of the SWIFT fee. Only present when processing_fee is set.
        - `is_deduction` boolean — Whether payout_amount should be considered a deduction
        - `pay_rate` number — Overtime rate multiplier (e.g. 1.5)
        - `payout_amount` integer — Associated payout or deduction in cents
        - `payout_currency_code` string, nullable — Currency code of the SWIFT fee. Only present when processing_fee is set.
        - `shift_code` string — Shift identifier from partner system
        - `work_day_duration` integer — Expected work day duration in seconds
    - `total_count` integer, required — Total number of pay items
    - `total_pages` integer, required — Total number of pages

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `422` — Unprocessable Entity

---

[API](https://skmtc.net/remote-com/apis/remote.md) · [All operations](https://skmtc.net/remote-com/apis/remote/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/remote-com/remote/revisions/7e6a0c61ac82/schema)