LOloket
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

Request

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

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

totalSizeinteger

Total number of records, taking into account the given filter.

pageSizeinteger

Number of records in the response

totalPagesinteger

Number of pages available

currentPageinteger

Current page returned in the response

Example response

{
  "totalSize": 650,
  "pageSize": 250,
  "totalPages": 3,
  "currentPage": 2,
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "_embedded": [
    {
      "payrollrunId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "payrollPeriod": {
        "year": 2017,
        "periodNumber": 1,
        "periodStartDate": "2018-01-01",
        "periodEndDate": "2018-01-31"
      },
      "numberOfPayslips": 1,
      "approvalTime": "2018-05-08T15:16:49+02:00"
    }
  ]
}

Changes

No recorded changes to this operation across all 6 revisions of this API.