---
title: "List payslips"
method: GET
path: "/v1/payslips"
tags: ["Payslips"]
---

# List payslips

`GET /v1/payslips`

## Request

- Base URL: `https://gateway.remote.com`
- URL: `https://gateway.remote.com/v1/payslips`
- Auth: one of:
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `https://gateway.remote.com/company.manage`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `payslip:read`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `all:read`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `all:write`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `payslip:read`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `all:read`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `all:write`
  - HTTP bearer

Lists all payslips belonging to a company. Can also filter for a single employment belonging
to that company.

## Authentication

This endpoint accepts any one of the following token types:

- **Company-scoped access token** (`OAuth2AuthorizationCode`) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See [Authentication for partners](https://developer.remote.com/docs/authentication-for-partners).
- **Company-scoped access token (assertion)** (`OAuth2CompanyManagerAssertion`) — obtained through the `urn:ietf:params:oauth:grant-type:jwt-bearer` grant for a company manager. See [OAuth Assertion](https://developer.remote.com/docs/authorization-method-oauth-assertion).
- **Customer API token** (`CustomerAPIToken`) — generated by the customer on their Integration Settings page, with the scopes they choose there. See [Authorization for customers](https://developer.remote.com/docs/authorization-for-customers).

## Scopes

Any one of the scopes in a token type's row is enough. `all:read` and `all:write` work too.

| Token type | Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|---|
| Company-scoped access token | Manage employment documents (`employment_documents`) | View payslips (`payslip:read`) | - |
| Company-scoped access token (assertion) | Manage employment documents (`employment_documents`) | View payslips (`payslip:read`) | - |
| Customer API token | Manage employment documents (`employment_documents`) | View payslips (`payslip:read`) | - |

## Query parameters

- `employment_id` string
- `start_date` string
- `end_date` string
- `expected_payout_start_date` string
- `expected_payout_end_date` string
- `page` integer
- `page_size` integer

## Response `200`

Success

- ListPayslipsResponse: Response schema listing many payslips
  - `data` object
    - `current_page` integer: The current page among all of the total_pages
    - `payslips` Payslip[]
      - `employment_id` string, required: The unique identifier (UUID) of the employment this payslip belongs to.
      - `expected_payout_date` string, date, nullable: Optional UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
      - `id` string, required: The unique identifier (UUID) of the payslip.
      - `issued_at` string, date, required: The date the payslip was issued.
      - `net_pay_converted_amount` integer: The net pay amount converted to the company's billing currency, in cents. Only shown if available.
      - `net_pay_source_amount` integer: The net pay amount in the source (local) currency, in cents. Only shown if available.
    - `total_count` integer: The total number of records in the result
    - `total_pages` integer: The total number of pages the user can go through

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `404`: Not Found
- `422`: Unprocessable Entity
- `429`: Too many requests

---

[API](https://skmtc.dev/remote-com/apis/pay-compensation.md) - [All operations](https://skmtc.dev/remote-com/apis/pay-compensation/llms.txt) - [OpenAPI document](https://skmtc.dev/remote-com/apis/pay-compensation/revisions/ec29f1865c5e?raw)