Sign in

v3

latestOpenAPI 3.1.02026-07-311,0939714.5 MB
Payroll run downloads

Download payslips for a payroll run

Activity name : <a href="https://developer.loket.nl/Activities/GetPayslipsByPayrollRunId" target="_blank">GetPayslipsByPayrollRunId</a>

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

Returns the payslips for a payroll run as a PDF file. By default the payslips are sorted by employeeNumber.

get/v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/payslips

Path parameters

payrollrunIdstring uuid required

The unique identifier of the payroll run

Query parameters

sortOnField'employeeNumber' | 'lastName' | 'firstName'

Field on which the payslips will be sorted. By default the payslips are sorted by employeeNumber. Possible values for this parameter are:

  • employeeNumber: Sort payslips by employee number
  • name: Sort payslips by last name
includeEmploymentsWithMijnLoketAccessboolean

Indicates whether to include employments for which the employee has access to Mijn Loket. Possible values for this parameter are:

  • true: Include employments with Mijn Loket access(All employments)
  • false: Exclude employments with Mijn Loket access

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