---
title: "List of payslips for an employment"
method: GET
path: "/v2/providers/employers/employees/employments/{employmentId}/payslips"
tags: ["Payslip"]
---

# List of payslips for an employment

`GET /v2/providers/employers/employees/employments/{employmentId}/payslips`

## Request

- Base URL: `https://api.loket.nl`
- URL: `https://api.loket.nl/v2/providers/employers/employees/employments/{employmentId}/payslips`
- Auth: none required

__Activity name :__ <a href="https://developer.loket.nl/Activities/GetPayslipsByEmploymentId" target="_blank">GetPayslipsByEmploymentId</a>

__Availability:__ This is endpoint is available for the Loket application only. It is not available for external parties

Get a list of payslips for the specified employment, including the GUID of the corresponding payroll run.

The function of this endpoint is dependent on the role of the user;
* For users with the role of 'werknemer';  The endpoint only returns results for payrollruns that have the status 'approved' AND for which results of the payroll are available for ESS (based on the ESS-date of the payrollrun) .
* For users with any other role (in most cases); the endpoin returns results for approved payrollruns irregardless of the ESS date.

## Path parameters

- `employmentId` string, uuid, required

## Query parameters

- `filter` string
- `orderBy` string
- `pageNumber` integer
- `pageSize` integer

## Headers

- `Authorization` string, required
- `Accept` string, required

## Response `200`

OK

- object: a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.
  - `totalSize` integer: Total number of records, taking into account the given filter.
  - `pageSize` integer: Number of records in the response
  - `totalPages` integer: Number of pages available
  - `currentPage` integer: Current page returned in the response
  - `version` Version
    - `obsoleteDate` string, date, nullable: The date (can be null) on which the `resourceVersion` is no longer supported/available
    - `resourceVersion` string, date: The resource version of the object in the response
  - `messages` object[]
    - `type` string: Indication of the type of message. See [the general documentation for more information](./#section/Response/Messages)
    - `description` string: Describes the message
    - `id` string, uuid, nullable: In some cases when the message may relate to a specific entity, or specific group of entities, this field provides the identifier of that entity
    - `code` integer: Identifying code for the message
    - `properties` string[]: An array that can contain additional information
  - `_embedded` Payslip2[]
    - `payrollrunId` string, uuid: The unique identifier of an object (GUID/UUID)
    - `payrollPeriod` PayrollPeriod2
      - `year` integer: The year of the payroll period the record relates to
      - `periodNumber` integer, nullable: The period number of the payroll period the record relates to
      - `periodStartDate` string, date: The first day of the period for which the tax return message was created
      - `periodEndDate` string, date: The last day of the period for which the tax return message was created
      - `testYear` boolean: Indicates whether the payroll periode is part of a test year. In Loket it is possible to run a year of a payrollAdministration as a so-called test year. This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data.
    - `numberOfPayslips` integer: The number of different types of payslips for the given payroll period.
    - `approvalTime` string, date-time: The time at which the payslip was approved.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/loket/apis/loket-api.md) - [All operations](https://skmtc.dev/loket/apis/loket-api/llms.txt) - [OpenAPI document](https://skmtc.dev/loket/apis/loket-api/revisions/32170564148f?raw)