v3

latestOpenAPI 3.1.02026-07-311,0939714.5 MB
Payslip

List of payslips for an employment

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.
get/v2/providers/employers/employees/employments/{employmentId}/payslips

Path parameters

employmentIdstring uuid required

The unique identifier of the employment

Query parameters

filterstring
Example:cancellationPeriodTimeUnit.key eq 4

Filter the collection

orderBystring
Example:-companyName,address.houseNumber

Order the collection on one or more fields

pageNumberinteger
Example:2

Specifies which page should be returned

pageSizeinteger
Example:20

Specifies the number of objects per page

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required
Example:application/json;version=2018-01-01

The accept header is used to influence what type of output is returned and in most cases the version of the output

Response

OK