Sign in

v3

latestOpenAPI 3.1.02026-07-311,0939714.5 MB
Employment

List of employments with additional entities

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

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

Get a list of employments for an employer. With this version we introduced the "Comprehensive" resource which contains additional entities.

This endpoint only returns the employments that meet the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.

get/v2/providers/employers/{employerId}/employees/employments/comprehensive

Path parameters

employerIdstring uuid required

The unique identifier of the employer

Query parameters

referenceDatestring date
Example:2022-01-01

Set a reference date for choosing the date dependent data.

removeEmptyLinesboolean
Example:true

When true and combined with a X-ReportInput header, the output only contains employments for which selected underlying data, such as wage, is available.

includeHistoricAndFutureDataboolean
Example:true

If set to true, historic and future records will also be returned

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