Loket.nl API

OpenAPI apis-guru enterprise

Is this your first time here? Please check out our

The initial loading time of this developer portal may be very long due to the large number of endpoints designs being rendered when loading the page. We are looking into an alternative solution but for now please bear in mind.

General

The Loket.nl API is a RESTful API that exposes the data and features of the Loket.nl platform. The API accepts and returns JSON and can only be accessed by registered users. This documentation describes version 2 of the API.

Are you looking to partner up and start building an integration based on the Loket RESTful API? Please check out the steps for partners on our .

Have you received your client and user credentials from us? Check out the following Postman collection to help you start making your first API calls on our acceptance environment. We would recommend to install the Postman desktop app.

Do you want to contact us with any further questions or remarks regarding the Loket RESTful API? Please send an email to , and we will get back to you.

Environments

The Loket.nl API has two different environments. The first environment is the "acceptance" environment which is used during development and returns test data. The second environment is the production environment which is to be used exclusively by approved applications. Both environments have their own URLs.

The acceptance environment can be accessed at
The production environment can be accessed at

OpenAPI documentation

The endpoints are defined using the , an industry-wide recognized standard for describing REST API's.

Please note: the endpoint documentation in this portal is not designed to be fully compatible with any automatic code generation tools.

Change policy

Over the course of time the API, and policies regarding the API can and will change. These changes are subject to the following guidelines.

The following states hold true for the change policy for this API.

Loket.nl may sometimes introduce changes to the API and policies without advance notice.
Loket.nl will try to inform users of any (breaking) change in advance.
Loket.nl will not be liable to you or any third party for such modifications or any adverse effects resulting from such modifications.
Loket.nl will try to avoid breaking changes as much as possible.

Notification periods

In regard to changes Loket.nl will strive to adhere to the following notification periods per type of change. Due to our versioning strategy at resource level this API has the possibility to run multiple versions of the same resource at one time. This allows for a window in which both the old and new version are available. Allowing for a gradual move to the new version.

Type of change	Notification period	Support period old version
Non breaking change	2 weeks	no new version
Breaking change	2 weeks	6 months
Critical	Due to the nature of these changes we might not be able to follow the normal procedure for change managment	depends on the severity of the issue

We define a non breaking change as follows. Any change to the API that does not cause failures in the applications that consume that API.

Introducing a new optional field to an existing resource
Introducing a new endpoint
Introducing a new operation (GET/PUT/POST/PATCH/DELETE)
Introducing a new optional parameter to an endpoint
Introducing a new version for a resource

We define a breaking change as follows. any change to an API that could potentially cause failures in the applications that consume that API.

Changing an existing JSON element (name, datatype, pattern, min/max length etc)
Removing a JSON element, endpoint, operation or parameter
Introducing a required JSON element
Introducing a required parameter to an endpoint
Passing the obsoleteDate of a version for a resource

Versioning

The Loket API uses two types of versioning. API versioning and resource versioning.

API versioning

API versioning is done via the path where after the domain URL (api.loket.nl) the path starts with the API version. The current version of the API is V2. The API version is expected to change rarely as resource versioning is available to tackle most issues that need versioning.

Resource versioning

Every JSON resource in the API is versioned via the Accept header. Allowing users of the API to influence what version is returned by setting the mandatory accept header. The Accept header of request should have a value like application/json;version=2018-01-01. Here, the second part of the header is used to refer to a specific version of the resource (2018-01-01). When calling the API it is possible to supply other dates rather than the exact resources version(s). The businesslogic will select the version that is ON or BEFORE the given date.

For example: let's say there are two versions of a resource. These are 2018-01-01 and 2018-09-01. When calling the API you supply application/json;version=2018-08-01, in that case the API will use the version 2018-01-01 as its the nearest version in the past.

A response returns what resourceVersion was used and the 'obsoleteDate' of that version (in most cases this is NULL). The obsoleteDate indicates when the resources version will no longer be available via the API. With the introduction of a new version of a resource the obsoleteDate for the old version will be set to 6 months after the introduction of the new resource. Allowing consumers of the resource 6 months to incorporate the change. Failure to do so will likely lead to failure in the implementation.

In this developer portal you can find the service contracts for each, active, version of a resource. If, only if, there are multiple versions of a resource you can select the corresponding schema at that resource.

Changelog

The changelog for this API can be found .

We strongly advise every user ofthe Loket REST API the subscribe to the email feed. Please check out the link on the changelog page.

Legal notices

Your use and access to the API is expressly conditioned on your compliance with the policies and restrictions related to the API. If Loket.nl believes that you have or attempted to violate any term, condition, or the spirit of these policies or agreements, your right to access and use the API may be temporarily or permanently revoked.

Authentication

Authorization in the Loket API is based on the industry-standard OAuth 2.0 protocol. For general information on OAuth 2.0 we kindly refer to the publicly-available documentation,

An authorized user is required to call the Loket API.

Note: This is an SSL-only API.

Note: Only TLS 1.2 is supported.

Environment	TokenUrl
Acceptance
Production

The following OAuth 2.0 flows are supported

Authorization Code flow (standard)
Refresh Token flow (extension on the Authorization Code Flow)
SSO flow (single sign-on)
Password flow

Authorization code flow

For most clients only the authorization_code (and thus refresh_token) will be supported. Password grant type is not available for an external client.

Please click the link below to see documentation on implementing the authorization code flow by external clients.

Refresh token flow

After the authorization code flow yields a refresh token the refresh_token grant can be used to obtain an access/bearer token. The expire time of the access/bearer is also returned in the response please take this into account. With the refresh token flow the two factor step will be skipped.

Refresh token request example:

Refresh token response example:

json

{  "access_token": "JESJDhMBy0NPTM9SiXmYAzW45clOiQ5wSyDq3VWluguGNoKym4WPSiJoTDx67TQ",  "token_type": "bearer",  "expires_in": 3599,  "refresh_token": "nGJtF6j6SeQbHAg",  "two_factor_state": "None"}

SSO flow

The SSO (single sign-on) flow is based on OAuth 2.0 and requires the authorization flow to be completed.

For more information see:

Please note: Among other things, it is possible to set up an SSO flow with both Loket en Werknemerloket.

Password flow

The password flow is typically NOT enabled for external clients. Only by exception will the password flow be enabled for security (and practical) reasons.

Password token request examples:

Whether client_secret is required is dependent on the configuration of the client.

Authorization

In this section we explain how the API authorization service determines if a request is authorized or not.

The authorization entities

Entity	Description
Client	Loket.nl used the client as an additional authorisation entity. By linking clients to activities clients can only perform those activities they are linked to.
User	Is linked to a client (by performing the authorization code flow) and to a set of rechten (configuration in loket.nl)
Module (product)	Enables certain functionality for the provider/employer. Modules can be enabled and disabled on both provider and employer level.
Role	Influences if certain "rechten" are available to the users with said role. It can also influence the scope of the data returned. For example: the API will deny an "afdelings manager" access to employee's that are not in the "afdeling" (department) that user is manager of
Activity	Every action in the API has its own activity. Using the Open API 3.0 standard these activity names are incorporated in the documentation using the `operationId` and in most cases are named in the description of an endpoint.
Rights (rechten)	Represent a group of activities.

The authorization process

This flow assumes that both user and client are correctly configured and have access to the API.

Does the client have access to the activity?
Does the user have access to the activity (through "recht")?
Does the role have access to the activity (through "recht")?
Does the provider/employer have the required module enabled for the activity?
Does the user have access to the specified entity/ID?

If the answer to all the questions above is yes then the request is authorized otherwise the request is denied with a HTTP status code 403 (Forbidden). See the simplified authorization flow in the figure below.

Side note: users are linked to rechten and clients are linked to activities. This leaves room for discrepancies. Where a client cannot perform the activity because the client is not authorized to call that activity even though the user does have the "recht" granting access to the activity.

Which users can use the API

In almost all use-cases a Loket user should meet the following requirements to successfully setup an integration with that user.

The user must be a normal Loket user (so NOT a webservice user)
The user must be active (not blocked)
The user must have access to an employer
- For provider users this is done by assigning the user to the appropriate Team(s)
- For employer users this is done by creating a user for or linking the user to the appropriate employer(s)
The user must have all appropriate rights
- For provider users this is done by assigning appropriate rights via Team (or alternatively, directly to the user)
- For employer users this is done by assigning appropriate rights to the user on employer level

How to setup an integration is described in the section.

Side notes:

A user can have access to multiple employers with different rights per employer.
Please note that users set up to use the SOAP webservices (webservicegebruikers) are in no way suited to perform calls to the RESTful API, these require entirely different user set-ups.
User management on production is typically done by the provider (i.e. the accountant) and sometimes the employer. This is NOT something Loket.nl itself can do.

Data

Data types

The Loket.nl API accepts and returns JSON. Comform the the following data types are supported:

string
number (point is used to separate the integer part from the fractional part of a number)
integer (from OpenAPI)
object
array
boolean

For most of these types, further specifications can be found in the format and pattern specifications in the service contract. For example a format: date added to a string field indicates a valid date must be supplied.

Metadata

Fields of the type 'metadata' are fields for which the possible values can be acquired via the metadata endpoint of the resource.

The metedata can be obtained by appending /metadata to the current endpoint. Using the GET verb the endpoint will return a JSON output with "all" the metadata for the given resource. In some cases multiple requests are needed to obtain all the metadata required, an exmple is given below. Typically different metadata endpoints are availalbe for the POST and the PUT endpoint.

If metadata endpoints are avaible for a given endpoint/resource is mentioned in the description of that endpoint.

Example response

json

{[  {      "field": "gender"      options: [          {          "key": 1,          "value":"Man"          }          {          "key": 2,          "value":"Vrouw"          }      ]   },   {      "field": "country"      options: [          {          "isoCode":"NL",          "key": 530,          "value":"Nederland"          }          {          "isoCode":"BE",          "key": 540,          "value":"België"          }      ]   }
]}

Example urls

Acquiring metadata for a POST Wage

Acquiring metadata for a PUT employee

Multiple requests to get all the metadata

In some cases there are metadata fields dependant on the selected value off another metadata field. Such is the case when adding a new concept employee. This is done in the employer context while several of the metadata fields are dependant on the payrollAdministration context.

For example:

Request 1, first of a normal metadata request is performed. The response for this request will contain a list of payrolladministration for the given employer.

Request 2, when a payrolladministration is selected perform a second request to acquire the payrolladministration specific metadata.

Request 3, if a payScale is selected perform a third request to acquire the payGrade for that payScale.

Types of metadata

We diferentiate between two types of metadata.

Generic metadata field. The possible values for these fields are the same for every object no matter the provider, employer or employee etc. Examples are: country, gender and nationality.
Context specific metadata field. Examples of contexts are employer, payroll administration, provider and Loket.nl. In most cases the possible values for these field are resources in themselves and can be managed via the API. If a metadata field is context specific the context is given in the description of the field. Examples are: function, department and leaveType.

Note: some context specific metadata field can have multiple contexts.

For example: it is possible to define an export set in the provider context. Making that export set available for all payroll administrations linked to the provider. It is also possible to add an export set in the payroll administration context. That export set is only available to that payroll administration. When requesting the metadata of export set the user will be presented with a combined list of the provider and payroll administration export sets.

Default values

Many fields in the API have a default value. In order to assist our API users to adhere to these defaults when creating a record (POST) we provide /defaults endpoints.

An object returned by the defaultsendpoint resembles a fully expanded GET-object of that resource. The only case when a part of the object is NOT fully expanded is for a metaData-object that does not have a default value (for example '"gender":NULL').
- Whether an object within the resource is of the type metaData is indicated in the service contracts of that resource.
Context is determined by the GUID given in the Path. Examples are employer, payroll administration, employee and employment.
A scope is sometimes required to determine the defaults values. A scope could be a date by which Loket.nl can determine what default was active on that date. The scope can be set by supplying additional paraments in the request. If a scope is required but none is given the currently active or last know value is returned.
The fields with no default will be set to null (even if the field is normally non-nullable).
Because the GET-object is returned the readonly fields are also returned.

An example endpoint would be:

resulting in the following output:

json

{  "payrollPeriod": null,  "shift": {      "shiftNumber": 1  },  "payslipType": {      "key": 2  },  "payslipText": null,  "distributionUnit": {      "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"  },  "costCenter": {      "key": 2  },  "costUnit": {      "key": 2  },  "payrollComponents": []}

Note: Defaults endpoints are not yet generically available. If a Defaults endpoint exists this will be explicitly stated at that specific resource.

Date chains

For most of the resources with a startDate and endDate a chain is maintained. Chain meaning that no records can overlap in time. Loket.nl has two types of chains.

Broken chain: It is posible for gaps te exist between the records. It is also posible to add new records in between or before existing records aslong as no overlap occures.
Linked chain: No gaps between records are allowed. Its only posible to add new records to the end of the chain resulting in the closing of the reviouse record with the start date -1 as end date.

Note: Chains are sometimes maintained with an additional context. For example, For benefits and deductions the broken chain is maintained per payrollComponent. It is possible to have multiple active records for different payrollComponent never two active records for the same payrollComponent.

Custom export

For some GET (list) endpoints the API supports exporting (part of) the output JSON as a XML/CSV file. This is done by setting the X-ReportInput and Accept header.

The Accept header supports the following 2 options:

CSV (text/csv;version=yyyy-MM-dd)
Excel (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;version=yyyy-MM-dd)

The X-ReportInput is a custom header that requires a JSON object with the following structure as input.

The filename without extension for the report 'FileNameWithoutExtension' delimiter --> The delimiter to be used. If not set "," is used Array of objects 'fields' with 2 fields:

fieldName --> A Xpath reference to the field to be included in the export
reportColumnName --> The column name for the field
format --> Allows only for date formatting. e.g. dd-MM-yyyy for csv or dd-mm-yyyy for Excel (Excel only usses lowercase) 3.1 For CSV: see 3.2 For Excel:

Example X-ReportInput:

json

{"fileNameWithoutExtension":"MyExport","delimiter": ";","fields":  [    {      "fieldName": "startDate",      "reportColumnName": "In dienst datum",      "format": "dd-MM-yyyy"    },    {      "fieldName": "personalDetails.firstName",      "reportColumnName": "First Name"    },    {      "fieldName": "personalDetails.lastName",      "reportColumnName": "Last Name"    }  ]}

Example request:

CURL

curl --location --request GET 'https://api.loket.nl/v2/providers/employers/155c8440-8ff6-4776-98db-5d2243a073e3/employees?orderby=employeeNumber' \--header 'Content-Type: application/json' \--header 'Accept: text/csv;version=2020-08-18' \--header 'X-ReportInput: {"FileNameWithoutExtension":"MyExport","Fields":[{"fieldName":"personalDetails.initials","reportColumnName":"Initials"},{"fieldName":"personalDetails.firstName","reportColumnName":"First name"},{"fieldName":"personalDetails.lastName","reportColumnName":"Last name"}]}' \--header 'Authorization: Bearer ZKoiC_g_NfYA3v0' \

Request

A request to the Loket.nl API consists of several components. Each of these components are discussed in this section.

Base URL

The API can be accessed at . The version of the API is specified in the URL. The current version of the Loket.nl API is version 2. To access version 2 of the API, one simply appends v2 to the base URL. The full base URL of the API is therefore .

Endpoints

The endpoints defined in the OpenAPI definition of the Loket.nl API are appended to the base URL. For example, the endpoint /providers/employers/{employerId}/employees can be accessed at .

Path parameters

Most endpoints require path parameter(s) in order to specify the context of the request. For example, the endpoint /providers/employers/{employerId}/employees contains the employerId path parameter. A path parameter is a unique identifier that identifies a specific resource, in this case an employer.

Pagination

The API supports two query parameters to control the pagination of the results: pageNumber and pageSize. Both of these query parameters only apply to endpoints that return lists of entities.

The pageNumber query parameter specifies which page of the collection to return. By default pageNumber is set to 1 which returns the first page of the collection. Note: the pageNumber refers to the page (with a given number of entities), NOT to a specific entity within a page!

The pageSize query parameter influences the number of entities per page. By default pageSize is set to 250. Note that this default may change in the future. It is not recommended to depend on this default when developing for the Loket.nl API.

Examples:

?pageNumber=2 to return the second page
?pageSize=2 to set the page size to two

Filtering

The API supports output filtering via the querystring parameter filter.

Filtering is possible on all fields of the following datatypes:

string
integer
boolean
date-time
decimals

The following operators are available:

Operator	Description	Example
Comparison Operators
eq	Equal	`city eq 'Redmond'`
ne	Not equal	`city ne 'London'`
lk	Like	`city lk 'Lond'`
gt	Greater than	`price gt 20`
ge	Greater than or equal	`price ge 10`
lt	Less than	`price lt 20`
le	Less than or equal	`price le 100`
Logical Operators
and	Logical and	`price le 200 and price gt 3.5`
or	Logical or	`price le 3.5 or price gt 200`

Both field names and values are case insensitive. It is possible to filter on nested fields by adding the parent object before the field with a '.' to separate them. Do remember to URL encode the filter parameters.

Examples

All employments with a cancellation periode in months (the value 4 corresponds to months time unit).

All employments with no endDate.s

All employments with an end date less or equal to 2017-01-01

All employees with a employee number greater or equal 1 and less or equal 5

Ordering

All Loket.nl API resources support ordering of the elements in the response on a specific field. All fields can be used in ordering. The list can be ordered in ascending or descending order, with ascending being the default one. Ordering on multiple fields is also by using a ',' as a separator.

Examples

Order employers by company name ascending

Order employers by company name descending

Order employers by company name descending then by house number ascending

Headers

In order to access the endpoints of the Loket.nl API, at least two request headers need to be set.

1) the Authorization header is required in order to authorize the API call. The value of this header is the word Bearer followed by a space and the access token acquired from the /token endpoint. For example, if the acquired access token is AbCdEf123456, the value of the Authorization headers would be:

2) The second header that is required for proper usage of the API, is the Accept header. This header is used for the resource versioning feature and is therefore crucial for making sure the response remains the same when new resource versions are introduced. The value of the Accept header differs per endpoint is defined in the OpenAPI documentation of the endpoints.

3) In case of a PUT and sometimes a PATCH a third header is optional the if-match header. This header is used for concurrency control. Even though the header is optional we advise using this header on every PUT(PATCH) to ensure not losing data.

Response

In addition to the responses defined in the OpenAPI documentation, the Loket.nl API also provides additional fields that give more information about the response and the entities requested. This section will explain the full response given by the Loket.nl API by examining the example response below.

Example 400 response

json


{    "version": {        "obsoleteDate": null,        "versionNumber": "2018-01-01,    },    "messages": [        {            "code": 83,            "id": null,            "type": "BrokenBusinessRule",            "description": "[field] has an invalid length",            "properties": []        }    ],    "_embedded": []}

Example 200 response

json


  {      "totalSize": 1,      "pageSize": 250,      "totalPages": 1,      "currentPage": 1,      "version": {          "obsoleteDate": null,          "resourceVersion": "2018-01-01"      },      "messages": [],      "content": {          "id": "2b4c119c-527c-4cbb-a5b2-f3a11e4b76cx",          ...      }  }

Paging

totalSize has an integer value indicating the total number of entities irrespective of the page size.
pageSize has an integer value indicating the maximum number of entities returned per page. The page size can be influenced by setting the pageSize query parameter. See the section Query Parameters for more information.
totalPages has an integer value indicating the number of pages the requested collection holds given the specific pagesize.
currentPage has an integer value indicating the current page number. The current page number can be influenced by setting the pageNumber query parameter. See the section Query Parameters for more information.

Version

The version object provides information regarding the resource version of the entity requested.

obsoleteDate contains the date of discontinuation for the requested resource version. The value of this field can be null indicating that the requested resource version is not planned to be obsoleted at the time of the request.
resourceVersion shows the version of the requested entity. The resource version can be influenced by setting the Accept header.

Messages

The messages field contains a list of message objects related to the request made. Any warnings and errors will be communicated in this list of messages

type has a string value indicating the type of message. At this time the Loket.nl API supports five types of messages: BrokenBusinessRule, Warning, Exception, ConcurrencyViolation and NotFound .
description has a string value that describes the message that has occurred.
code is an identifying code for the message. Please note that this code may change in the future. See the documentation portal for possible message codes for an endpoint.
id relates the message to a specific entity in the reponse list. For example, in cases where a warning occurs for one of the entities in a list, the value of this field can be used to identify to which entity the warning applies. Currently implemented for endpoints where a multi-patch is performed (multiple actions are performed within one call) for example updating the status of one or more leaveRequests.
properties an array that can contain additional information regarding the message. Currently not yet fully implemented.
_embedded contains the list of entities as defined for each endpoint in the OpenAPI documentation. Please refer to that documentation for the contents of the _embedded field for each endpoint. For endpoints that return only one entity (detail endpoints) the _embedded field is replaced with a content field. The content of this field can also be found in the documentation for each endpoint.

Headers

etag header is returned with every GET of a detail (single resource). This header is used for concurrency controle
Expires header is returned with every response to indicate how long a response can be cached
Content-Disposition header is used in case of downloads to provide a file name

HTTP status codes

The Loket.nl API supports the following http status codes.

Code	Is returned when
200	The request to GET, PUT, PATCH or DELETE and object was recived and processed succesfully. The response might still contain messages of the type warning.
201	The request to insert (POST) a new object was recived and processed succesfully. The response might still contain messages of the type warning.
400	The request was received but could not be processed. The reason(s) will be given in the response. The content type of the response may be text/plain for API-level error messages, such as when trying to call the API without SSL otherwise the content will be application/json.
401	The bearer token provided in the authorization header is invalid. Do not retry the request until a new (valid) bearer token is acquired.
403	The user is not authorized to access the resource. The reason will be given in the response. Do not retry the request until the, configuration, issue is resolved.
404	The resource requested was not found/does not exist.
409	The give if-match header in a PUT request no longer represents the current state of the object. Please acquire the current state off the object, via a GET, and resolve the differences then try again.
50*	A unforseen error occurred. Please check the request if everything seems te be in order on your side contact the support team. Provide as much information as possible to resolve the issue.

Note: for a limited number of endpoint a so-called multi-patch may be performed (multiple actions within one call). In that case the status code will be 200 if at least on of the actions succeeds, if other any action(s) in that call fail(s) a message will be returned including the given id of that entity.

Caching

The API uses the Expires header to indicate how long the item can be reused from the local cache. In most cases caching is not allowed for resources. Exceptions excist, such as pictures like the employer logo and the employee photo, in these cases the cache duration is mentioned in the description of the resource. *_

{[  {      "field": "gender"      options: [          {          "key": 1,          "value":"Man"          }          {          "key": 2,          "value":"Vrouw"          }      ]   },   {      "field": "country"      options: [          {          "isoCode":"NL",          "key": 530,          "value":"Nederland"          }          {          "isoCode":"BE",          "key": 540,          "value":"België"          }      ]   }
]}

{  "payrollPeriod": null,  "shift": {      "shiftNumber": 1  },  "payslipType": {      "key": 2  },  "payslipText": null,  "distributionUnit": {      "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"  },  "costCenter": {      "key": 2  },  "costUnit": {      "key": 2  },  "payrollComponents": []}

{"fileNameWithoutExtension":"MyExport","delimiter": ";","fields":  [    {      "fieldName": "startDate",      "reportColumnName": "In dienst datum",      "format": "dd-MM-yyyy"    },    {      "fieldName": "personalDetails.firstName",      "reportColumnName": "First Name"    },    {      "fieldName": "personalDetails.lastName",      "reportColumnName": "Last Name"    }  ]}

curl --location --request GET 'https://api.loket.nl/v2/providers/employers/155c8440-8ff6-4776-98db-5d2243a073e3/employees?orderby=employeeNumber' \--header 'Content-Type: application/json' \--header 'Accept: text/csv;version=2020-08-18' \--header 'X-ReportInput: {"FileNameWithoutExtension":"MyExport","Fields":[{"fieldName":"personalDetails.initials","reportColumnName":"Initials"},{"fieldName":"personalDetails.firstName","reportColumnName":"First name"},{"fieldName":"personalDetails.lastName","reportColumnName":"Last name"}]}' \--header 'Authorization: Bearer ZKoiC_g_NfYA3v0' \


{    "version": {        "obsoleteDate": null,        "versionNumber": "2018-01-01,    },    "messages": [        {            "code": 83,            "id": null,            "type": "BrokenBusinessRule",            "description": "[field] has an invalid length",            "properties": []        }    ],    "_embedded": []}


  {      "totalSize": 1,      "pageSize": 250,      "totalPages": 1,      "currentPage": 1,      "version": {          "obsoleteDate": null,          "resourceVersion": "2018-01-01"      },      "messages": [],      "content": {          "id": "2b4c119c-527c-4cbb-a5b2-f3a11e4b76cx",          ...      }  }

Homepage: https://api.apis.guru/v2/specs/loket.nl/V2.json
Provider: loket.nl
OpenAPI version: 3.0.2
Spec (JSON): https://api.apis.guru/v2/specs/loket.nl/V2/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/loket.nl/V2/openapi.yaml

Tools (643)

Extracted live via the executor SDK.

abpFunds.deleteAbpFundByAbpFundId

Activity name : DeleteAbpFundByAbpFundId
Delete an existing abp fund record.
abpFunds.getAbpFundByAbpFundId

Activity name : GetAbpFundByAbpFundId
Get the details of an abp fund
abpFunds.getAbpFundsByEmploymentId

Activity name : GetAbpFundsByEmploymentId
Get a list of the abp funds the employment partakes in.
abpFunds.postAbpFundByEmploymentId

Activity name : PostAbpFundByEmploymentId
Metadata : Possible options for fields of the type "metadata" can be acquired (GET) by adding /metadata to the POST URL.
Defaults : Default values for a new object can be acquired by adding `/defaults" to the POST URL.
Activate an abp fund for an employment`
abpFunds.putAbpFundByAbpFundId

Activity name : PutAbpFundByAbpFundId
Metadata : Possible options for fields of the type "metadata" can be acquired (GET) by adding /metadata to the PUT URL.
absence.deleteAbsenceByAbsenceId

Activity name : DeleteAbsenceByAbsenceId
Delete an existing absence (for an employee). If succesfull, this function also deletes the underlying absence progress records
absence.getAbsenceByAbsenceId

Activity name : GetAbsenceByAbsenceId
Get the details of an Absence
absence.getAbsenceOverviewByEmployeeId

Activity name : GetAbsenceOverviewByEmployeeId
Download the absence overview (verzuim) for a given time frame
Metadata : No metadata
absence.getAbsencesByEmployeeId

Activity name : GetAbsencesByEmployeeId
Get a list of all absences for the given employee
absence.patchCloseAbsenceByAbsenceId

Activity name : PatchCloseAbsenceByAbsenceId
A succesfull call to this endpoint will close the absence and the underlying absence progress (with an empty endDate).
absence.patchReopenAbsenceByAbsenceId

Activity name : PatchReopenAbsenceByAbsenceId
When performing a succesfull call to this endpoint, then the absence and the underlying absence progress will we reopend. Both endOfAbsenceDate and endOfAbsenceReason will be set to null
absence.postAbsenceByEmployeeId

Activity name : PostAbsenceByEmployeeId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
Defaults : Default values for a new object can be acquired by adding `/defaults' to the POST URL.
Add an Absence (=verzuimmelding) for an employee.
Please note that if this endpoint is called succesfully both an absence (=verzuimmelding) AND one underlying absence progress (=verzuimverloop) will be created. `
absence.putAbsenceByAbsence

Activity name : PutAbsenceByAbsenceId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL.
Edit the details of am Absence
absenceProgress.deleteAbsenceProgressByAbsenceProgressId

Activity name : DeleteAbsenceProgressByAbsenceProgressId
Delete an existing Absence Progress (for an employee). There always has to remain one record of absence progress for an absence. This last record is removed when the absence is deleted.
absenceProgress.getAbsenceProgressByAbsenceId

Activity name : GetAbsenceProgressByAbsenceId
Get a list of absence progress (verzuimverloop) for a specific absence (verzuimmelding).
absenceProgress.getAbsenceProgressByAbsenceProgressId

Activity name : GetAbsenceProgressByAbsenceProgressId
Get the details of an Absence Progress
absenceProgress.postAbsenceProgressByAbsenceId

Activity name : PostAbsenceProgressByAbsenceId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
Defaults : Default values for a new object can be acquired by adding `/defaults' to the POST URL.
Add an Absence Progress (=Ziekteverloop) for an employee. As is common with closed chain entities, the endDate of the previous record will be filled depending on the startDate of the new one.
Practically this means that a full recovery notification has been performed. `
absenceProgress.putAbsenceProgressByAbsenceProgress

Activity name : PutAbsenceProgressByAbsenceProgressId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL.
Edit the details of an absence progress
achmea.getAchmeaInsuranceContractsByUserId

Activity name : GetAchmeaInsuranceContractsByUserId Get a list of all Achmea insurance contracts accessible to the current user
achmea.getWagePercentagesByAchmeaInsuranceContractId

Activity name : GetWagePercentagesByAchmeaInsuranceContractId
Get a list of all wage percentages (year-end bonus and holiday allowance percentages) for an Achmea insurance contract.
activateEmployeeProfile.patchEmployeeProfileByEmploymentId

Activity name : PatchEmployeeProfileByEmploymentId
Create Fondsen, Grondslagen and toeslagen based on the employment's employeeProfile.
actuals.getActualBenefitsAndDeductionsByEmployerId

Activity name: GetActualBenefitsAndDeductionsByEmployerId
Get the list of actual benefitsanddeductions for an employer
actuals.getActualOrganizationalEntitiesByEmployerId

Activity name: GetActualOrganizationalEntitiesByEmployerId
Get the list of actual organizational entities for an employer
actuals.getActualPartnersByEmployerId

Activity name: GetActualPartnersByEmployerId
Get the list of Actual partners for all employees of an employer
actuals.getActualWagesByEmployerId

Activity name: GetActualWagesByEmployerId
Get the list of actual wages for an employer
actuals.getActualWorkingHoursByEmployerId

Activity name: GetActualWorkingHoursByEmployerId
Get the list of actual working hours for an employer
actuals.getChildrenByEmployerId

Activity name: GetChildrenByEmployerId
Get the list of Children for all employees of an employer
actuals.getContactsByEmployerId

Activity name: GetContactsByEmployerId
Get the list of Contacts for all employees of an employer
address.getAddressByPostalCodeAndHouseNumber

Activity name : GetAddressyByPostalCodeAndHouseNumber
Acquire the address for a combination of postalCode and houseNumber. Only Dutch addresses are supported. Both the postalCode and houseNumber have to be specified as query parameters to perform a succesful call to this endpoint. The city and street name returned by this endpoint are according to the nen standard
administration.getAdministrationsByEmployerId

Activity name : GetAdministrationsByEmployerId
Get a list of all administrations (both payroll and non-payroll) for an employer. This endpoint only returns properties that are shared between payroll and non-payroll administrations. For more detailed properties, use the respective endpoints for payroll and non-payroll administrations.
announcement.getAnnouncementsByEmployerId

Activity name : GetAnnouncementsByEmployerId
Get a list of announcements for an employer. The list contains a isRead parameter.
announcement.patchAnnouncements

Activity name : PatchAnnouncementsByEmployerId
Mark announcements as read
aowDate.getAowDateByDateOfBirth

Activity name: GetAowDateByDateOfBirth
This endpoint allows the user to acquire the AOW date of an employee.
apgPensionDeclaration.getApgPensionDeclarationByApgPensionDeclarationId

Activity name : GetApgPensionDeclarationByApgPensionDeclarationId
Details of APG pension declaration
apgPensionDeclaration.getApgPensionDeclarationsByPayrollAdministrationId

Activity name : GetApgPensionDeclarationsByPayrollAdministrationId
A list of APG pension declarations for an administration
apgPensionDeclaration.getMessageByApgPensionDeclarationId

Activity name : GetMessageByApgPensionDeclarationId
Download the message of the APG pension declaration (pensioenaangiftebericht) in xml. Please note that this does NOT refer to the response message, but to the initial message i.e. pensioenaangiftebericht.
apgPensionDeclaration.getOverviewByApgPensionDeclarationId

Activity name : GetOverviewByApgPensionDeclarationId
Download the APG pension declaration overiew
apgPensionDeclaration.patchApgPensionDeclarationByApgPensionDeclarationId

Activity name : PatchApgPensionDeclarationByApgPensionDeclarationId
This endpoints changes the status of the Apg pensiondeclaration based on the provided action.
apgPensionDeclaration.postInitiateApgPensionDeclarationByPayrollAdministrationId

Activity name : PostInitiateApgPensionDeclarationByPayrollAdministrationId
Initiate the pension declaration for the next available period for the payrolladministration. Information about the next available periode can be obtained using the defaults endpoint (/defaults)
application.getApplicationAuthorizationsByApplicationId

Activity name : GetApplicationAuthorizationsByApplicationId
Get the authorizations of the application. We expose which activities are accessable by the application and which "rechten" and "producten" are required for the user/employer to enable those activities.
application.getApplicationLogo

Activity name : GetApplicationLogo
This activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour.
Caching: This resource changes very infrequently and can be cached for a longer time.
Get the logo of the application. In case no logo is know the service will return a 404.
application.getAvailableApplicationsByEmployerId

Activity name: GetAvailableApplicationsByEmployerId
List of all the applications available to the employer.
application.getLinkedUsersByEmployerIdAndApplicationId

Activity name: GetLinkedUsersByEmployerIdAndApplicationId
List of all users that are configred to have both access to the employer and have an connection with the application.
applicationsets.deleteProviderApplicationSetByApplicationSetId

Activity name: DeleteProviderApplicationSetByApplicationSetId
Delete an applicationset for the provider
applicationsets.deleteUserApplicationSetByApplicationSetId

Activity name: DeleteUserApplicationSetByApplicationSetId
Delete an applicationset for the user
applicationsets.getApplicationsetsByProviderId

Activity name: GetApplicationsetsByProviderId
Get the list of Applicationsets for a provider.
applicationsets.getApplicationsetsByUserId

Activity name: GetApplicationsetsByUserId
Get the list of Applicationsets for a user.
applicationsets.postApplicationSetByProviderId

Activity name: PostApplicationSetByProviderId
Create an applicationset for a provider.
applicationsets.postApplicationSetByUserId

Activity name: PostApplicationSetByUserId
Create an applicationset for a user.
applicationsets.putProviderApplicationSetByApplicationSetId

Activity name: PutProviderApplicationSetByApplicationSetId
Edit the details for an applicationset.
applicationsets.putUserApplicationSetByApplicationSetId

Activity name: PutUserApplicationSetByApplicationSetId
Edit the details for an applicationset.
assessment.getAssessmentsByEmployerId

Activity name : GetAssessmentsByEmployerId
Retrieve a list of assessments.
assessment.postInitiateAssessmentByConceptEmployeeId

Activity name : PostInitiateAssessmentByConceptEmployeeId
Metadata: No metadata available. No defaults available.
Initiate the proces to perform an assessment for a concept employee.
attachmentOfEarnings.deleteAttachmentOfEarningsByAttachmentOfEarningsId

Activity name : DeleteAttachmentOfEarningsByAttachmentOfEarningsId
Delete an existing attachment of earnings record
attachmentOfEarnings.getAttachmentOfEarningsByAttachmentOfEarningsId

Activity name : GetAttachmentOfEarningsByAttachmentOfEarningsId
Get the details of an attachment of earnings record
attachmentOfEarnings.getAttachmentOfEarningsByEmploymentId

Activity name : GetAttachmentOfEarningsByEmploymentId
Get a list of attachment of earnings records
attachmentOfEarnings.postAttachmentOfEarningsByEmploymentId

Activity name : PostAttachmentOfEarningsByEmploymentId
Create a new attachment of earnings record for an employment.
Metadata : Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the URL
Defaults : Default values for a new object can be acquired by adding /defaults' to the POST URL.
attachmentOfEarnings.putAttachmentOfEarningsByAttachmentOfEarningsId

Activity name : PutAttachmentOfEarningsByAttachmentOfEarningsId
Update the details of a single attachment of earnings record
Metadata : Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the URL
auditTrail.getEmployeeDataAuditTrailByEmployerId

Activity name : GetEmployeeDataAuditTrailByEmployerId
Get the mutations for the all the tables linked to the employee (this includes employment and underlying entities).
auditTrail.getPayrollPeriodDataAuditTrailByPayrollAdministrationId

Activity name : GetPayrollPeriodDataAuditTrailByPayrollAdministrationId
Returns the changes that were made in the payroll period data from the given start up to and including the given end date.
auditTrail.getProvidersEmployersPayrolladministrationsPayrollAdministrationIdAuditTrailPayrollPeriodData

Activity name : GetPayrollPeriodDataAuditTrailByPayrollAdministrationId
Get the audit trail for the payroll period data.
auditTrailPayrollRun.getEmploymentPayrollDataAuditTrailByPayrollAdministrationId
Activity name : GetEmploymentPayrollDataAuditTrailByPayrollAdministrationId
Returns the changes that were made in the payroll data for the employments.
This includes resources such as (allmost all payroll related resources except payroll period data which has its own audit trail download):
- Wage
- Working hours
- Bennefits and deductions
- Employment
- Fiscal properties
- Organizational entity
authorizations.getAuthorizationsByEmployerId

Activity name : GetAuthorizationsByEmployerId
Get the array of activities the user is authenticated for with regard to the specified employer
authorizations.getAuthorizationsByProviderId

Activity name : GetAuthorizationsByProviderId
Get the array of activities the user is authenticated for with regard to the specified provider. This endpoint is only accessible for providerusers.
authorizationSets.getAuthorizationSetsByAuthorizationSetId

Activity name : GetAuthorizationSetsByAuthorizationSetId
Details of an authorization set.
authorizationSets.getAuthorizationSetsByProviderId

Activity name : GetAuthorizationSetsByProviderId
List the available authorization sets.
baseForCalculation.deleteBaseForCalculationByBaseForCalculationId

Activity name : DeleteBaseForCalculationByBaseForCalculationId
Delete an existing base for calculation
baseForCalculation.getBaseForCalculationByBaseForCalculationId

Activity name : GetBaseForCalculationByBaseForCalculationId
Get the details of a base for employment fund calculations.
baseForCalculation.getBasesForCalculationByEmploymentId

Activity name : GetBasesForCalculationByEmploymentId
Get a list of the bases (money) that are used as the base for certain calculations.
baseForCalculation.postBaseFundCalculationByEmploymentId

Activity name : PostBaseForCalculationByEmploymentId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
Defaults : Default values for a new object can be acquired by adding /defaults to the POST URL.
Add a base for calculation record.
baseForCalculation.putBaseForCalculationByBaseForCalculationId

Activity name : PutBaseForCalculationByBaseForCalculationId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL.
Edit the properties of a base for calculation
baseForEmploymentFundCalculation.deleteBaseForEmploymentFundCalculationByBaseForEmploymentFundCalculationId

Activity name : DeleteBaseForEmploymentFundCalculationByBaseForEmploymentFundCalculationId
Delete an existing base for employment fund calculation
baseForEmploymentFundCalculation.getBaseForEmploymentFundCalculationByBaseForEmploymentFundCalculationId

Activity name : GetBaseForEmploymentFundCalculationByBaseForEmploymentFundCalculationId
Get the details of a base for employment fund calculations.
baseForEmploymentFundCalculation.getBasesForEmploymentFundCalculationByEmploymentId

Activity name : GetBasesForEmploymentFundCalculationByEmploymentId
Get a list of the bases (money) that are used in employment fund calculations.
baseForEmploymentFundCalculation.postBaseForEmploymentFundCalculationByEmploymentId

Activity name : PostBaseForEmploymentFundCalculationByEmploymentId
Metadata : Possible options for fields of the type "metadata" can be acquired (GET) by adding /metadata to the POST URL.
Defaults : Default values for a new object can be acquired by adding `/defaults" to the POST URL.
Add a base for employment fund calculation. `
baseForEmploymentFundCalculation.putBaseForEmploymentFundCalculationByBaseForEmploymentFundCalculationId

Activity name : PutBaseForEmploymentFundCalculationByBaseForEmploymentFundCalculationId
Metadata : Possible options for fields of the type "metadata" can be acquired (GET) by adding /metadata to the PUT URL.
Edit the properties of a base for employment calculation
benefitInKind.deleteBenefitInKindByBenefitInKindId

Activity name : DeleteBenefitInKindByBenefitInKindId
Delete an existing benefit in kind record
benefitInKind.getBenefitInKindByBenefitInKindId

Activity name : GetBenefitInKindByBenefitInKindId
Get the details of a benefit in kind
benefitInKind.getBenefitsInKindByEmploymentId

Activity name: GetBenefitsInKindByEmploymentId Get a list of the Benefits in kind of the employment.
benefitInKind.postBenefitInKindByEmploymentId

Activity name : PostBenefitInKindByEmploymentId
Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata to the POST URL.
Defaults: Default values for a new object can be acquired by adding /defaults' to the POST URL.
benefitInKind.putBenefitInKindByBenefitInKindId

Activity name : PutBenefitInKindByBenefitInKindId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding / metadata to the PUT URL.
benefitInKindType.deleteBenefitInKindTypeByBenefitInKindTypeId

Activity name : DeleteBenefitInKindTypeByBenefitInKindTypeId
Delete an existing benefit in kind type record
benefitInKindType.getBenefitInKindTypeByBenefitInKindTypeId

Activity name : GetBenefitInKindTypeByBenefitInKindTypeId
Get the details of an benefit in kind type
benefitInKindType.getBenefitInKindTypesByEmployerId

Activity name : GetBenefitInKindTypesByEmployerId
Get a list of the benefit in kind types for an employer.
Note: The benefit in kind types defined at the employer level can be used as value for the field typeOfBenefitInKind in the BenefitInKind resource at the employment level.
benefitInKindType.postBenefitInKindTypeByEmployerId

Activity name : PostBenefitInKindTypeByEmployerId
benefitInKindType.putBenefitInKindTypeByBenefitInKindTypeId

Activity name : PutBenefitInKindTypeByBenefitInKindTypeId
benefitsAndDeductions.deleteBenefitsAndDeductionsByBenefitsAndDeductionsId

Activity name : DeleteBenefitsAndDeductionsByBenefitsAndDeductionsId
Delete a benefit or deduction for the employment
benefitsAndDeductions.getBenefitsAndDeductionsBybenefitsAndDeductionsId

Activity name : GetBenefitsAndDeductionsBybenefitsAndDeductionsId
Get a benefit or deduction for the employment
benefitsAndDeductions.getBenefitsAndDeductionsByEmploymentId

Activity name : GetBenefitsAndDeductionsByEmploymentId
Get a list of benefits and deductions for the employment
benefitsAndDeductions.postbenefitsAndDeductionsByEmploymentId

Activity name : PostBenefitsAndDeductionsByEmploymentId
Add a benefit or deduction for the employment
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
Defaults : Default values for a new object can be acquired by adding /defaults to the POST URL.
benefitsAndDeductions.putBenefitsAndDeductionsByBenefitsAndDeductionsId

Activity name : PutBenefitsAndDeductionsByBenefitsAndDeductionsId
Update a benefit or deduction for the employment Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
billableItem.getBillableItemsByEmployerId

Activity name : GetBillableItemsByEmployerId
Get a list of all billable items for the employer.
billableItems.getBillableItemsByProviderId

Activity name : GetBillableItemsByProviderId
Get a list of all billable items for the provider.
calendar.getCalendarAbsencesByEmployerId

Activity name : GetCalendarAbsencesByEmployerId
For a calendar, this endpoint return the absence calendar items PER specific employment.
This endpoint only returns objects for which the employment meets the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.
calendar.getCalendarAvailableHoursByEmployerId

Activity name : GetCalendarAvailableHoursByEmployerId
For a calendar, this endpoint returns the availability of an employment expressed as a pattern for both odd and even weeks. Note that multiple patterns can be active in the time period that is requested using the query parameter startDate and endDate. While multiple patterns can be returned, on any date only one pattern is active. The patterns do not overlap.
The available hours for a day are determined by the bi-weekly work pattern (as defined in the Working Hours resource) if such a work pattern is present for the employment. If no bi-weekly work pattern is present and the employment is NOT an on-call employment than the number of standard hours (either shiftHours or deviatingHoursPerWeek) is equally divided over the working days within each week (Monday through Friday).
This endpoint only returns objects for which the employment meets the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.
calendar.getCalendarLeaveByEmployerId

Activity name : GetCalendarLeaveByEmployerId
This endpoint return the leave calendar items for each employment. Please note: this endpoint only will return calendar items based on leave of the type 'opname'.
This endpoint only returns objects for which the employment meets the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.
calendar.getCalendarLeaveRequestsByEmployerId

Activity name : GetCalendarLeaveRequestsByEmployerId
For a calendar, this endpoint return the leave requests calendar items PER specific employment.
Please note: this endpoint only will return calendar items based on leave request with status 'ingediend'.
This endpoint only returns objects for which the employment meets the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.
chamberOfCommerce.getCompanyInformationByChamberOfCommerceNumber

Activity name: GetCompanyInformationByChamberOfCommerceNumber
This endpoint allows the user to acquire basic company information for a specific chamber of commerce number.
changeAddressRequest.postChangeAddressRequestByEmployeeId

Activity name: PostChangeAddressRequestByEmployeeId
Allows the user to submit a change address request. Request because this request will trigger a workflow that might require the change to be approved.
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
Defaults : Default values for a new object can be acquired by adding /defaults' to the POST URL.
changeContactinformationRequest.postChangeContactInformationRequestByEmployeeId

Activity name: PostChangeContactInformationRequestByEmployeeId
Allows the user to submit a change contactinformation request. Request because this request will trigger a workflow that might require the change to be approved.
child.deleteChildByChildId

Activity name : DeleteChildByChildId
Delete an existing child (for an employee)
child.getChildByChildId

Activity name : GetChildByChildId
Get the details of a child
child.getChildrenByEmployeeId

Activity name : GetChildrenByEmployeeId
Get the list of children of the employee
child.postChildByEmployeeId

Activity name : PostChildByEmployeeId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
Defaults : Default values for a new object can be acquired by adding `/defaults' to the POST URL.
Add a child for an employee `
child.putChildByChildId

Activity name : PutChildByChildId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL.
Edit the details of a child
collectiveBenefitsAndDeductions.postCollectiveBenefitsAndDeductionsByEmployerId

Activity name : PostCollectiveBenefitsAndDeductionsByEmployerId
Create new benefits and deduction records for multiple employments of an employer
collectiveLeave.postCollectiveLeaveByEmployerId

Activity name: PostCollectiveLeaveByEmployerId
Post leave for a set of employments under an employer.
Metadata : There is no metadata endpoint for this resource.
Defaults : Defaults are available at /defaults.
collectiveWage.postCollectiveWageByEmployerId

Activity name : PostCollectiveWageByEmployerId
Create new grosswage records for multiple employments of an employer
companyCar.deleteCompanyCarByCompanyCarId

Activity name: DeleteCompanyCarByCompanyCarId
Delete a company car record for the employment
Please note this resource is related for the registration of the company car for HRM purposes. This resource is NOT related to the registration of the fiscal company car(s) which is used in salary calculations.
companyCar.getCompanyCarByCompanyCarId

Activity name: GetCompanyCarByCompanyCarId
Get the details of a company car
Please note this resource is related for the registration of the company car for HRM purposes. This resource is NOT related to the registration of the fiscal company car(s) which is used in salary calculations.
companyCar.getCompanyCarsByEmploymentId

Activity name: GetCompanyCarsByEmploymentId
Get the list of company cars for an employment.
Please note this resource is related for the registration of the company car for HRM purposes. This resource is NOT related to the registration of the fiscal company car(s) which is used in salary calculations.
companyCar.postCompanyCarByEmploymentId

Activity name: PostCompanyCarByEmploymentId
Create a company car record for an employment.
Please note this resource is related for the registration of the company car for HRM purposes. This resource is NOT related to the registration of the fiscal company car(s) which is used in salary calculations.
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
Defaults : There are no defaults available.
companyCar.putCompanyCarByCompanyCarId

Activity name: PutCompanyCarByCompanyCarId
Edit the details for a company car record.
Please note this resource is related for the registration of the company car for HRM purposes. This resource is NOT related to the registration of the fiscal company car(s) which is used in salary calculations.
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL.
conceptEmployee.deleteConceptEmployeeByConceptEmployeeId

Activity name : DeleteConceptEmployeeByConceptEmployeeId
Delete a concept employee
conceptEmployee.getCitizenServiceNumberByConceptEmployeeId

Activity name : GetCitizenServiceNumberByConceptEmployeeId
Get the citizen service number (BSN) of a concept employee. BSN is separately authorized in Loket and is therefore designed to have its own activities.
conceptEmployee.getConceptEmployeeByConceptEmployeeId

Activity name : GetConceptEmployeeByConceptEmployeeId
Get the details of a concept employee
conceptEmployee.getConceptEmployeeMinimizedByConceptEmployeeId

Activity name : GetConceptEmployeeMinimizedByConceptEmployeeId
Get the details of a concept employee with fewer fields
conceptEmployee.getConceptEmployeesByEmployerId

Activity name : GetConceptEmployeesByEmployerId
Get a list of all concept employee for the given employer. Concept employee can be used as a template/prefill when creating a new employee/employment.
This function may also be used in case one does not have all the required fields to create a new employee/employment. The validations are disabled for a concept employee allowing one to create a concept employee filling only a subset of available fields, then later "promoting" the Concept employee in loket.nl to employee/employment.
conceptEmployee.patchConvertToEmployeeByConceptEmployeeId
Activity name : PatchConvertToEmployeeByConceptEmployeeId
This endpoint "converts" the conceptEmployee to an actual employee in Loket. This means creating a number of records including Employee, Employment, WorkingHours, Wage etc. If the promotion is succesful the concept employee record will be deleted.
The GUID of the conceptEmployee will be copied over to the GUID of the newly created Employee.
Before performing these steps, quite a number of validations are performed to ensure that the provided information can be used to create a functionally valid employee.
If the employeeNumber is empty then this will be set automatically for the employee. (i.e. highest available number +1)
Additional functionality :
- It is possible to call an alternative functionality closely related to this functionality. This additional functionality will perform the validation ONLY, and it will NOT convert the conceptEmployee to an actual employee even when all validation rules are successful. Other than not performing the actual step of converting the employee the endpoint will behave identically to the actual endpoint.
- This functionality can be applied by setting the optional X-ValidateOnly header to true
conceptEmployee.postConceptEmployeeByEmployerId
Activity name : PostConceptEmployeeByEmployerId
Create a concept employee for an employer
- Possible options (metadata) for generic fields of the type "metadata" can be acquired (GET) by adding /metadata to the URL.
- Possible options dependent on a specific payrollAdministration can be acquired via ../providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}.
- Possible options for payGrade can be acquired via ../providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}. A payGrade has time based values dictating the wage for a given period. These values can be acquired by performing another metadata request to GET ../providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}/paygrade/{payGradeKey}. This endpoint has the optional parameter "date" that may be used to specifying a measure date.
Defaults : Default values for a new object can be acquired by adding /defaults to the POST URL.
Default values that are dependent on the selected payroll administration can be acquired by adding /providers/employers/conceptemployees/defaults/payrolladministration/{payrollAdministrationId} to the POST URL.
NonPayrollAdministrations For nonPayrollAdministrations the equivalent MetaData-endpoints are also available as described above. However NO specific defaults endpoint is available for the nonPayrollAdministration.
conceptEmployee.putCitizenServiceNumberByConceptEmployeeId

Activity name : PutCitizenServiceNumberByConceptEmployeeId
Update the citizen service number (BSN) of a concept employee BSN is separately authorized in Loket and is therefore designed to have its own activities.
conceptEmployee.putConceptEmployeeByConceptEmployeeId
Activity name : PutConceptEmployeeByConceptEmployeeId
Edit the details of a concept employee
- Possible options (metadata) for generic fields of the type "metadata" can be acquired (GET) by adding /metadata to the URL.
- Possible options dependent on a specific payrollAdministration can be acquired via ../providers/employers/conceptemployees/metadata/payrollAdministration/{payrollAdministrationId}.
- Possible options for payGrade can be acquired via ../providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}.
A payGrade has time based values dictating the wage for a given period. These values can be acquired by performing another metadata request ../providers/employers/conceptemployees/metadata/payscale/{payScaleKey}/paygrade/{payGradeKey}.
NonPayrollAdministrations For nonPayrollAdministrations the equivalent MetaData-endpoints are also available as described above. However NO specific defaults endpoint is available for the nonPayrollAdministration.
conceptEmployee.putConceptEmployeeMinizedByConceptEmployeeId
Activity name : PutConceptEmployeeMinimizedByConceptEmployeeId
Edit the details of a concept employee with fewer fields.
- Possible options (metadata) for generic fields of the type "metadata" can be acquired (GET) by adding /metadata to the URL.
conceptEmployeeDossier.deleteDocumentByConceptEmployeeIdAndDocumentId

Activity name: DeleteDocumentByConceptEmployeeIdAndDocumentId
Delete a document in the concept employee dossier
conceptEmployeeDossier.deleteDossierByConceptEmployeeId

Activity name: DeleteDossierByConceptEmployeeId
Delete a complete dossier, with all documents in it, for the concept employee
conceptEmployeeDossier.getAuditTrailByConceptEmployeeIdAndDocumentId

Activity name : GetAuditTrailByConceptEmployeeIdAndDocumentId
Get audittrail for the document in the concept employee dossier.
conceptEmployeeDossier.getDocumentByConceptEmployeeIdAndDocumentId

Activity name : GetDocumentByConceptEmployeeIdAndDocumentId
Download the file of a given concept employee dossier entry. Via Qwoater.
conceptEmployeeDossier.getDocumentCountByConceptEmployeeId

Activity name : GetDocumentCountByConceptEmployeeId
Get a count of the number of documents in the dossier. Via Qwoater.
conceptEmployeeDossier.getDocumentsByConceptEmployeeId

Activity name : GetDocumentsByConceptEmployeeId
Get a list of documents within the concept employee's dossier (werknemerdossier). Via Qwoater.
conceptEmployeeDossier.postDocumentByConceptEmployeeId

Activity name : PostDocumentByConceptEmployeeId
Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata to the POST URL.
Upload a document within the concept employee's dossier (werknemerdossier). Via Qwoater.
conceptEmployeeDossier.putDocumentByConceptEmployeeIdAndDocumentId

Activity name: PutDocumentByConceptEmployeeIdAndDocumentId
Edit the details for a document in the concept employee dossier
conceptEmployeeSelfService.getConceptEmployeeSelfServiceByConceptEmployeeId

Activity name : GetConceptEmployeeSelfServiceByConceptEmployeeId
Get the details of a Concept employee with regards to ESS access
conceptEmployeeSelfService.getConceptEmployeeSelfServiceByEmployerId

Activity name : GetConceptEmployeeSelfServiceByEmployerId
Get a list of all the Concept employee's and their status regarding to ESS (werknemer.loket).
contact.deleteContactByContactId

Activity name : DeleteContactByContactId
Delete an existing Contact (for an employee)
contact.getContactByContactId

Activity name : GetContactByContactId
Get the details of a single contact
contact.getContactsByEmployeeId

Activity name : GetContactsByEmployeeId
Get list of contacts for an employee
contact.postContactByEmployeeId

Activity name : PostContactByEmployeeId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
Defaults : No default values
Create a new contact for an employee
contact.putContactByContactId

Activity name : PutContactByContactId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL.
Edit the details of a contact
contactHistory.deleteAbsenceContactHistoryByAbsenceContactHistoryId

Activity name : DeleteAbsenceContactHistoryByAbsenceContactHistoryId
Delete an existing record from the contact history
contactHistory.getAbsenceContactHistoryByAbsenceContactHistoryId

Activity name : GetAbsenceContactHistoryByAbsenceContactHistoryId
Get the details of a contact
contactHistory.getAbsenceContactsHistoryByAbsenceId

Activity name : GetAbsenceContactHistoryByAbsenceId
Get the contacts history for a specific absence (verzuimmelding).
contactHistory.postAbsenceContactHistoryByAbsenceId

Activity name : PostAbsenceContactHistoryByAbsenceId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
Defaults : Default values for a new object can be acquired by adding /defaults' to the POST URL.
contactHistory.putAbsenceContactHistoryByAbsenceContactHistoryId

Activity name : PutAbsenceContactHistoryByAbsenceContactHistoryId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL.
Edit the details of a contact history
contractCode.deleteContractCodeByContractCodeId

Activity name : DeleteContractCodeByContractCodeId
Delete an existing contract code record
contractCode.getContractCodeByContractCodeId

Activity name : GetContractCodeByContractCodeId
Get the details of a contract code
contractCode.getContractCodesByEmployerId

Activity name : GetContractCodesByEmployerId
Get a list of the contract codes for an employer.
Note: The contract codes defined at the employer level can be used as value for the field contractCode in the WorkingHours and ConceptEmployee resource.
contractCode.postContractCodeByEmployerId

Activity name : PostContractCodeByEmployerId
contractCode.putContractCodeByContractCodeId

Activity name : PutContractCodeByContractCodeId
costPerHour.deleteCostPerHourByCostPerHourId

Activity name : DeleteCostPerHourByCostPerHourId
Delete an existing cost per hour record
costPerHour.getCostPerHourByCostPerHourId

Activity name : GetCostPerHourByCostPerHourId
Get the details of a cost per hour record
costPerHour.getCostPerHourByEmploymentId

Activity name: GetCostPerHourByEmploymentId
Get the list of costs per hour for an employment
costPerHour.postCostPerHourByEmploymentId

Activity name : PostCostPerHourByEmploymentId
Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata to the POST URL.
Defaults: Defaults can be acquired(GET)by adding /defaults to the POST URL.
costPerHour.putCostperhourByCostperhourId

Activity name : PutCostperhourByCostperhourId
Metadata : No metadata.
createEmployment.postEmploymentByEmployeeId
Activity name : PostEmploymentByEmployeeId
Create an additional employment for an already existing employee.
Please note that the creation of an Employment is not RESTful by design.
In Loket, when a new Employee is created it will have to be created including its underlying Employment and its accessory resources. This specific endpoint is relevant in the following scenario: there is already an Employee with at least one Employment, and one wishes to create an additional Employment for that currently existing Employee. When successfully calling this endpoint, an Employment with its accessory resources will be created.
Metadata :
- Possible options (metadata) for generic fields of the type "metadata" can be acquired (GET) by adding /metadata to the URL.
- Possible options dependent on a specific payrollAdministration can be acquired by adding /metadata/payrolladministration/{payrollAdministrationId} to the url.
- Possible options for payGrade can be acquired by adding metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey} to the url.
A payGrade has time based values dictating the wage for a given period. These values can be acquired by performing another metadata request by adding /metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}/paygrade/{payGradeKey} to the url. This endpoint has the optional parameter "date" that may be used to specifying a measure date.
Defaults : Default values for a new object can be acquired by adding /defaults to the URL.
Default values that are dependent on the selected payroll administration can be acquired by adding ../providers/employers/employees/employments/defaults/payrolladministration/{payrollAdministrationId} to the URL.
NonPayrollAdministrations For nonPayrollAdministrations the equivalent metaData-endpoints are also available as described above. Also, a defaults endpoint is available for the nonPayrollAdministration. Please note that this requires ../nonpayrolladministrations/{nonPayrollAdministrationId} in the path.
createEmployment.postTransitionCompensationEmploymentByEmploymentId

Activity name : PostTransitionCompensationEmploymentByEmploymentId
Create an additional employment for an already existing and terminated employment with the sole purpose to pay out a transition compensation.
customField.deleteCustomFieldByCustomFieldId

Activity name : DeleteCustomFieldByCustomFieldId
Delete an existing custom field record
customField.getCustomFieldByCustomFieldId

Activity name : GetCustomFieldByCustomFieldId
Get the details of a custom field
customField.getCustomFieldsByEmployerId

Activity name : GetCustomFieldsByEmployerId
Get a list of the custom fields for an employer.
Note: The custom fields defined at the employer level can be used at the employee and employment level.
customField.postCustomFieldByEmployerId

Activity name : PostCustomFieldByEmployerId
customField.putCustomFieldByCustomFieldId

Activity name : PutCustomFieldByCustomFieldId
customHoliday.deleteCustomHolidayByCustomHolidayId

Activity name : DeleteCustomHolidayByCustomHolidayId
Delete an existing custom holiday record
customHoliday.getCustomHolidayByCustomHolidayId

Activity name : GetCustomHolidayByCustomHolidayId
Get the details of a custom holiday
customHoliday.getCustomHolidaysByEmployerId

Activity name : GetCustomHolidaysByEmployerId
Get a list of the custom holidays for an employer.
Note: The custom holidays defined at the employer level can be used at the employee and employment level.
customHoliday.postCustomHolidayByEmployerId

Activity name : PostCustomHolidayByEmployerId
customHoliday.putCustomHolidayByCustomHolidayId

Activity name : PutCustomHolidayByCustomHolidayId
customNotification.deleteCustomNotificationByCustomNotificationId

Activity name : DeleteCustomNotificationByCustomNotificationId
Delete an existing custom notification record
customNotification.getCustomNotificationByCustomNotificationId

Activity name : GetCustomNotificationByCustomNotificationId
Get the details of a custom notification
customNotification.getCustomNotificationsByEmploymentId

Activity name : GetCustomNotificationsByEmploymentId Get a list of the custom notifications of the employment. Note: custom notifications are user defined for a specific employment.
customNotification.postCustomNotificationByEmploymentId

Activity name : PostCustomNotificationByEmploymentId
Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata to the POST URL.
Defaults: Default values for a new object can be acquired by adding /defaults' to the POST URL.
customNotification.putCustomNotificationByCustomNotificationId

Activity name : PutCustomNotificationByCustomNotificationId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding / metadata to the PUT URL.
dashboardLicenses.getDashboardLicensesByEmployerId

Activity name : GetDashboardLicensesByEmployerId
Get the list dashboard licenses
dashboardLicenses.putDashboardLicensesByEmployerId

Activity name: PutDashboardLicensesByEmployerId
Edit the dashboard licenses
Metadata : There is no metadata endpoint for this resource.
dataNewBusiness.getDataNewBusinessFunctions

Activity name : GetDataNewBusinessFunctions
Get a list of functions known by Data New Business.
dataNewBusiness.getDataNewBusinessToken

Activity name : GetDataNewBusinessToken
Get a token for calling the Data New Business (DNB) API. DNB is a part of Van Spaendonck and with its API, DNB provides users data-based insights such as the salary checker.
dataNewBusiness.getDataNewBusinessTokenByEmployerId

Activity name : GetDataNewBusinessTokenByEmployerId
Get a token for calling the Data New Business (DNB) API. DNB is a part of Van Spaendonck and with its API, DNB provides users data-based insights such as the salary checker.
declarations.getDeclarationAuditTrailByDeclarationId

Activity name : GetDeclarationAuditTrailByDeclarationId
Get the audit trail of a declaration
declarations.getDeclarationsByDeclarationId

Activity name : GetDeclarationsByDeclarationId
Get the details of a declaration
declarations.getDeclarationsByEmploymentId

Activity name : GetDeclarationsByEmploymentId
Returns a list of declarations for the employments of the employer
declarations.getDeclarationsForEmployerId

Activity name : GetDeclarationsByEmployerId
Returns a list of declarations for the employments of the employer
declarations.patchProcessDeclarationsByDeclarationId

Activity name : PatchProcessDeclarationsByDeclarationId
Process approved declarations into the payrolling data.
Please check the description of the status-field in this resource to read about the workflow of declarations.
declarations.patchReviewDeclarationsByDeclarationIds

Activity name : PatchReviewDeclarationsByDeclarationIds
Review (accept or reject) open declarations
Please check the description of the status-field in this resource to read about the workflow of declarations.
declarationsAttachments.getAttachmentByDeclarationId

Activity name : GetAttachmentByDeclarationId
Download the attachment (via Qwoater) for the given declarationId. In case no attachment is know the service will return a 404.
declarationsAttachments.getDeclarationsWithAttachmentByEmployerId

Activity name : GetDeclarationsWithAttachmentByEmployerId
Get a list of all declarationId's of declarations that have an attachment to it.
The attachment is stored in Qwoater, and thus on the background a call to Qwoater will be performed to check whether an attachment is available for a declaration.
If an attachment is available then a call may be performed to the other endpoint to actually start downloading the attachment for this declaration.
departments.getDepartmentByDepartmentId

Activity name: GetDepartmentByDepartmentId
Get the details of department
departments.getDepartmentsByEmployerId

Activity name : GetDepartmentsByEmployerId
Get a list of all departments for the employer. This is the point where the departments available for use at employment level (organizational entity) are managed.
departments.getUserAccessibleDepartmentsByEmployerId

Activity name : GetUserAccessibleDepartmentsByEmployerId
Get a list of all departments for the employer, which are accesible for the current user.
departments.postDepartmentByEmployerId

Activity name: PostDepartmentByEmployerId
Create a department for an employer
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
Defaults: No default values
departments.putDepartmentByDepartmentId

Activity name: PutDepartmentByDepartmentId
Edit the details for a department
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
deviatingAwfContribution.deleteDeviatingAwfContributionByDeviatingAwfContributionId

Activity name: DeleteDeviatingAwfContributionByDeviatingAwfContributionId
Delete a Deviating AWF contribution record for the employment
deviatingAwfContribution.getDeviatingAwfContributionByDeviatingAwfContributionId

Activity name: GetDeviatingAwfContributionByDeviatingAwfContributionId
Get the details of a Deviating AWF contributions record
deviatingAwfContribution.getDeviatingAwfContributionByEmploymentId

Activity name: GetDeviatingAwfContributionsByEmploymentId Get the list of Deviating AWF contributions records for an employment
deviatingAwfContribution.postDeviatingAwfContributionByEmploymentId

Activity name: PostDeviatingAwfContributionByEmploymentId Create a Deviating AWF contributions record for an employment
Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata to the POST URL.
Defaults: Default values for a new object can be acquired by adding /defaults' to the POST URL.
deviatingAwfContribution.putDeviatingAwfContributionByDeviatingAwfContributionId

Activity name: PutDeviatingAwfContributionByDeviatingAwfContributionId Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding / metadata to the PUT URL.
Edit the details for a Deviating AWF contribution record
deviatingHourlyWage.deleteDeviatingHourlyWageByDeviatingHourlyWageId

Activity name : DeleteDeviatingHourlyWageByDeviatingHourlyWageId
Delete an existing deviating hourly wage record
deviatingHourlyWage.getDeviatingHourlyWageByDeviatingHourlyWageId

Activity name : GetDeviatingHourlyWageByDeviatingHourlyWageId
Get the details of a deviating hourly wage
deviatingHourlyWage.getDeviatingHourlyWagesByEmploymentId

Activity name : GetDeviatingHourlyWagesByEmploymentId
Get a list of the deviating hourly wages of the employment.
Note: Loket.nl has different ways to register deviating hourly wage.
deviatingHourlyWage.postDeviatingHourlyWageByEmploymentId

Activity name : PostDeviatingHourlyWageByEmploymentId Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata to the POST URL. Defaults: Default values for a new object can be acquired by adding /defaults' to the POST URL.
deviatingHourlyWage.putDeviatingHourlyWageByDeviatingHourlyWageId

Activity name : PutDeviatingHourlyWageByDeviatingHourlyWageId
Metadata : No metadata as payrollComponent is read only in the PUT.
documentManagement.deleteCompleteDossierByEmployerId

Activity name: DeleteCompleteDossierByEmployerId
Delete all documents in the dossier of an employer and the underlying employments
documentManagement.getDossierAuthorizationsByEmployerId

Activity name : GetDossierAuthorizationsByEmployerId
Get the authorizations per role and per category. Via Qwoater.
documentManagement.postInitiateCompleteDossierByEmployerId

Activity name: PostInitiateCompleteDossierByEmployerId
Initiate the proces to generate a zip file containing the complete dossier. (via Qwoater)
documentManagement.putDossierAuthorizationsByEmployerId

Activity name: PutDossierAuthorizationsByEmployerId
Edit the authorizations. Categories not included in de request will be set to inaccessible for all roles.
documentTemplate.deleteDocumentTemplateByEmployerIdAndDocumentId

Activity name: DeleteDocumentTemplateByEmployerIdAndDocumentId
Delete a document template in the employer dossier
documentTemplate.getDocumentTemplateByEmployerIdAndDocumentId

Activity name : GetDocumentTemplateByEmployerIdAndDocumentId
Download the document template of a given template entry. Via Qwoater.
documentTemplate.getDocumentTemplatesByEmployerId

Activity name : GetDocumentTemplatesByEmployerId
Get a list of document templates within the employer dossier (werkgeverdossier). Via Qwoater. Note that the 'category' field contains the category of the template.
documentTemplate.postDocumentTemplateByEmployerId

Activity name : PostDocumentTemplateByEmployerId
Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata to the POST URL.
Upload a document template within the employer dossier (werkgeverdossier). Via Qwoater.
documentTemplate.putDocumentTemplateByEmployerIdAndDocumentId

Activity name: PutDocumentTemplateByEmployerIdAndDocumentId
Edit the details for a document template in the employer dossier
downloadRequest.deleteDownloadRequestByDownloadRequestId

Activity name: DeleteDownloadRequestByDownloadRequestId
Delete a download request for the employment
downloadRequest.getDownloadRequestByDownloadRequestId

Activity name: GetDownloadRequestByDownloadRequestId
Get the details of a download request record
downloadRequest.getDownloadRequestsByBearerToken

Activity name: GetDownloadRequestsByBearerToken
Get the list of download requests for an employment
Note: The module (product) has to be activited for all the employers the user has access to. The same holds true for the permissions (rechten) of the users for these employers.
downloadRequest.getFileByDownloadRequestId

Activity name: GetFileByDownloadRequestId
Download the file of a download request record
downloadRequest.postDownloadRequestByBearerToken

Activity name: PostDownloadRequestByBearerToken
Create a download request for an employment
education.deleteEducationByEducationId

Activity name : DeleteEducationByEducationId
Delete an existing Education (for an employee)
education.getEducationByEducationId

Activity name : GetEducationByEducationId
Get the details of a single education
education.getEducationsByEmployeeId

Activity name : GetEducationsByEmployeeId
Get list of educations for an employee
education.postEducationByEmployeeId

Activity name : PostEducationByEmployeeId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
Defaults : No default values
Create a new education for an employee
education.putEducationByEducationId

Activity name : PutEducationByEducationId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL.
Edit the details of a education
educationFurtherIndication.deleteEducationFurtherIndicationByEducationFurtherIndicationId

Activity name : DeleteEducationFurtherIndicationByEducationFurtherIndicationId
Delete an existing education further indication record
educationFurtherIndication.getEducationFurtherIndicationByEducationFurtherIndicationId

Activity name : GetEducationFurtherIndicationByEducationFurtherIndicationId
Get the details of an education further indication
educationFurtherIndication.getEducationFurtherIndicationsByEmployerId

Activity name : GetEducationFurtherIndicationsByEmployerId
Get a list of the education further indications for an employer.
Note: The education further indications defined at the employer level can be used as value for the field furtherIndication in the Education resource at the employee level.
educationFurtherIndication.postEducationFurtherIndicationByEmployerId

Activity name : PostEducationFurtherIndicationByEmployerId
educationFurtherIndication.putEducationFurtherIndicationByEducationFurtherIndicationId

Activity name : PutEducationFurtherIndicationByEducationFurtherIndicationId
educationType.deleteEducationTypeByEducationTypeId

Activity name : DeleteEducationTypeByEducationTypeId
Delete an existing education type record
educationType.getEducationTypeByEducationTypeId

Activity name : GetEducationTypeByEducationTypeId
Get the details of an education type
educationType.getEducationTypesByEmployerId

Activity name : GetEducationTypesByEmployerId
Get a list of the education types for an employer.
Note: The education types defined at the employer level can be used as value for the field typeOfEducation in the Education resource at the employee level.
educationType.postEducationTypeByEmployerId

Activity name : PostEducationTypeByEmployerId
educationType.putEducationTypeByEducationTypeId

Activity name : PutEducationTypeByEducationTypeId
emailIdentities.deleteEmailIdentityByEmailIdentityId

Activity name: DeleteEmailIdentityByEmailIdentityId
Delete an EmailIdentity for a provider. An EmailIdentity can only be deleted when it's not used in an emailTemplate.
emailIdentities.deleteProvidersEmployersEmailidentitiesEmailIdentityId

Activity name: DeleteEmailIdentityByEmailIdentityId
Delete an EmailIdentity for an employer. An EmailIdentity can only be deleted when it's not used in an emailTemplate.
emailIdentities.getEmailIdentitiesByEmployerId

Activity name: GetEmailIdentitiesByEmployerId
Get the list of EmailIdentities for an employer.
emailIdentities.getEmailIdentitiesByProviderId

Activity name: GetEmailIdentitiesByProviderId
Get the list of EmailIdentities for a provider.
emailIdentities.postEmailIdentityByEmployerId

Activity name: PostEmailIdentityByEmployerId
Create an EmailIdentity for an employer.
emailIdentities.postEmailIdentityByProviderId

Activity name: PostEmailIdentityByProviderId
Create an EmailIdentity for a provider.
emailIdentities.postSendEmployerTestemailByEmailIdentityId

Activity name: PostSendEmployerTestemailByEmailIdentityId
Send an email to test the email identity configuration.
emailIdentities.postSendProviderTestemailByEmailIdentityId

Activity name: PostSendProviderTestemailByEmailIdentityId
Send an email to test the email identity configuration.
emailIdentities.postVerifyEmailIdentityByEmployerId

Activity name: PostVerifyEmailIdentityByEmployerId
Verify an EmailIdentity for an employer. The verficationstatus will we saved and used by Loket when sending email.
emailIdentities.postVerifyEmailIdentityByProviderId

Activity name: PostVerifyEmailIdentityByProviderId
Verify an EmailIdentity for a provider. The verficationstatus will we saved and used by Loket when sending email.
emailTemplates.deleteEmailTemplateByEmployerIdAndEmailTemplateId

Activity name : DeleteEmailTemplateByEmployerIdAndEmailTemplateId
Delete an existing email template record
emailTemplates.getEmailTemplateByEmployerIdAndEmailTemplateId

Activity name : GetEmailTemplateByEmployerIdAndEmailTemplateId
Get the details of an email template. The available email template placeholders can be aquired by adding /metadata to the url.
emailtemplates.getEmailTemplateByProviderIdAndEmailTemplateId

Activity name : GetEmailTemplateByProviderIdAndEmailTemplateId
Get the details of an email template. The available email template placeholders can be aquired by adding /metadata to the url.
emailTemplates.getEmailTemplatesByEmployerId

Activity name : GetEmailTemplatesByEmployerId
Get a list of the email templates for an employer.
Note: Email templates can be defined on employer, provider and loket level. This endpoint returns for each emailtype the email template which is currently in use for the employer.
emailtemplates.getEmailTemplatesByProviderId

Activity name : GetEmailTemplatesByProviderId
Get a list of the email templates for an provider.
Note: Email templates can be defined on employer, provider and loket level. This endpoint returns for each emailtype the email template which is currently in use for the provider.
emailTemplates.putEmailTemplateByEmployerIdAndEmailTemplateId

Activity name : PutEmailTemplateByEmployerIdAndEmailTemplateId
Edit the email template. The subject, body and senderEmail can be editted.
employee.deleteEmployeePhotoByEmployeeId

Activity name : DeleteEmployeePhotoByEmployeeId
Photo of the employee to use as an avatar/profile picture
employee.getCitizenServiceNumberByEmployeeId

Activity name : GetCitizenServiceNumberByEmployeeId
Get the citizen service number of an employee. BSN is separately authorized in Loket and is therefore designed to have its own activities.
employee.getEmployeeByEmployeeId

Activity name : GetEmployeeByEmployeeId
Get the details of a single employee
employee.getEmployeePhotoByEmployeeId

Activity name : GetEmployeePhotoByEmployeeId
Photo of the employee to use as an avatar/profile picture
Caching: This resource changes very infrequently and can be cached for a longer time.
employee.getEmployeePhotoByEmployeeIdAndVersion

Activity name : GetEmployeePhotoByEmployeeIdAndVersion
Photo of the employee to use as an avatar/profile picture
Caching: This resource changes very infrequently and can be cached for a longer time.
employee.getEmployeesByEmployerId

Activity name : GetEmployeesByEmployerId
Get a list of all employees for the given employer
employee.patchRevokeEmployeeSelfServiceAccessByEmployeeId

Activity name : PatchRevokeEmployeeSelfServiceAccessByEmployeeId
This endpoint allows the user to set the 'revokeEmployeeSelfServiceAccessOn'. This date indicates on what day the access to WerknemerLoket (Employee Self Service) will be revoked (this is done by scheduled tasks that run during the night). This is particularly useful for situations where for example the employer wants to restrict access at a specific date in the future, for example 1st of May in the next year.
The value may be set to NULL and thus clearing the date on which access would be revoked. Please note that this endpoint will not automatically 'unblock' an Employee, as that would require a specific action.
employee.postEmployeePhotoByEmployeeId

Activity name : PostEmployeePhotoByEmployeeId
Photo of the employee to use as an avatar/profile picture
employee.putCitizenServiceNumberByEmployeeId

Activity name : PutCitizenServiceNumberByEmployeeId
Update the citizen service number of an employee. BSN is separately authorized in Loket and is therefore designed to have its own activities.
employee.putEmployeeByEmployeeId

Activity name : PutEmployeeByEmployeeId
Edit the employee details
Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the URL
employeeBenefits.getBenifyUrlByEmployeeId

Activity name : GetBenifyUrlByEmployeeId
Get a URL to access the Benify portal for an employee.
employeeBenefits.getYourcampusUrlByUserId

Activity name : GetYourcampusUrlByUserId
Get a URL to access the Yourcampus portal for a user
employeeCustomField.deleteEmployeeCustomFieldByEmployeeCustomFieldId

Activity name : DeleteEmployeeCustomFieldByEmployeeCustomFieldId
Delete an existing custom field record
employeeCustomField.getEmployeeCustomFieldByEmployeeCustomFieldId

Activity name : GetEmployeeCustomFieldByEmployeeCustomFieldId
Get the details of a custom field
employeeCustomField.getEmployeeCustomFieldssByEmployeeId

Activity name : GetEmployeeCustomFieldsByEmployeeId
Get a list of the custom fields for an employee.
Note: custom fields are user defined at the employer level.
employeeCustomField.postEmployeeCustomFieldByEmployeeId

Activity name : PostEmployeeCustomFieldByEmployeeId
Metadata: Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
employeeCustomField.putEmployeeCustomFieldByEmployeeCustomFieldId

Activity name : PutEmployeeCustomFieldByEmployeeCustomFieldId
Metadata : No metadata available for this endpoint
employeeNotes.deleteEmployeeNoteByNoteId

Activity name : DeleteEmployeeNoteByNoteId
Delete an existing note record
employeeNotes.getEmployeeNoteByNoteId

Activity name : GetEmployeeNoteByNoteId
Get the details of a note
employeeNotes.getEmployeeNotesByEmployeeId

Activity name : GetEmployeeNotesByEmployeeId
Get a list of notes, available for the user, for the employee.
employeeNotes.postEmployeeNoteByEmployeeId

Activity name : PostEmployeeNoteByEmployeeId
Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata to the POST URL.
Defaults: Default values for a new object can be acquired by adding /defaults' to the POST URL.
employeeNotes.putEmployeeNoteByNoteId

Activity name : PutEmployeeNoteByNoteId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding / metadata to the PUT URL.
employeeSelfService.getEmployeeSelfServiceByEmployeeId

Activity name : GetEmployeeSelfServiceByEmployeeId
Get the details of an employee with regards to ESS access
employeeSelfService.getEmployeeSelfServiceByEmployerId

Activity name : GetEmployeeSelfServiceByEmployerId
Get a list of all the employee's and their status regarding to ESS (werknemer.loket).
employeeSelfService.patchEmployeeSelfServiceAccessByEmployeeId

Activity name : PatchEmployeeSelfServiceAccessByEmployeeId
This endpoint allows the user to change the status of access for the employee's to ESS (Werknemer.loket).
employeeSelfService.patchEmployeeSelfServiceAccessByEmployerId

Activity name : PatchEmployeeSelfServiceAccessByEmployerId
This endpoint allows the user to change the status of access to ESS for several employees of the employer.
employer.deleteEmployerLogoByEmployerId

Activity name: DeleteEmployerLogoByEmployerId
Delete the logo of an employer
employer.getEmployerByEmployerId

Activity name : GetEmployerByEmployerId
Get the details of a single employers
employer.getEmployerLogoByEmployerId

Activity name : GetEmployerLogoByEmployerId
This activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour.
Caching: This resource changes very infrequently and can be cached for a longer period.
Get the logo of the employer. In case no logo is know the service will return a 404.
employer.getEmployerLogoByEmployerIdAndVersion

Activity name : GetEmployerLogoByEmployerId
This activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour.
Caching: This resource changes very infrequently and can be cached for a longer period.
Get the logo of the employer. In case no logo is know the service will return a 404.
employer.getEmployersByUserId

Activity name : GetEmployersByUserId
Get a list of all employers accessible to the current user
Please note the following general remark regarding the Loket API. If an id is required as a path parameter, in almost all cases the UUID of the specific resource should be used. In the employer resource this corresponds to the the 'id' field, as is typical. (so do NOT use employerNumber as your path parameter for any following requests)
employer.getEmployersMinimizedByUser

Activity name : GetEmployersMinimizedByUser
Get a list of all employers accessible to the current user. With this endpoint we introduced the "Minimized" resource which contains fewer fields then /providers/employers. This version should increase performance when requesting employments for large employers.
employer.getProviderLogoByEmployerId

Activity name : GetProviderLogoByEmployerId
This activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour.
Get the (deviating) provider logo of the employers. In case no logo is know the service will return a 404.
Caching: This resource changes very infrequently and can be cached for a longer time.
employer.getProviderLogoByEmployerIdAndVersion

Activity name : GetProviderLogoByEmployerId
This activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour.
Get the (deviating) provider logo of the employers. In case no logo is know the service will return a 404.
Caching: This resource changes very infrequently and can be cached for a longer time.
employer.postEmployerByProviderId

Activity name : PostEmployerByProviderId
Create an employee for the provider (administratiekantoor) identified by the given providerId. Please take note of the following; a newly created Employer is not immediately accessible for the user. As this would require adding the Employer to a specific Loket team (which is a separate activity)
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
Defaults : Default values for a new object can be acquired by adding /defaults' to the POST URL.
employer.postEmployerLogoByEmployerId

Activity name : PostEmployerLogoByEmployerId
Upload a logo for the employer.
employer.putEmployerByEmployerId

Activity name: PutEmployerByEmployerId
Edit the details of an employer
Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL.
employerDashboard.getEmployerDashboardByEmployerId

Activity name : GetEmployerDashboardByEmployerId
Get the url for the Qlik dashboard for this employer. Please note: the Qlik dashboard is only accessible for users with an assigned Qlik dashboard licenses.
employerDossier.deleteDocumentByEmployerIdAndDocumentId

Activity name: DeleteDocumentByEmployerIdAndDocumentId
Delete a document in the employer dossier
employerDossier.getAuditTrailByEmployerIdAndDocumentId

Activity name : GetAuditTrailByEmployerIdAndDocumentId
Get audittrail for the document in the employer dossier.
employerDossier.getDocumentByEmployerIdAndDocumentId

Activity name : GetDocumentByEmployerIdAndDocumentId
Download the file of a given employer dossier entry. Via Qwoater.
employerDossier.getDocumentsByEmployerId

Activity name : GetDocumentsByEmployerId
Get a list of documents within the employer dossier (werkgeverdossier). Via Qwoater.
employerDossier.postDocumentByEmployerId

Activity name : PostDocumentByEmployerId
Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata to the POST URL.
Upload a document within the employer dossier (werkgeverdossier). Via Qwoater.
employerDossier.putDocumentByEmployerIdAndDocumentId

Activity name: PutDocumentByEmployerIdAndDocumentId
Edit the details for a document in the employer dossier
employerNotes.deleteEmployerNoteByNoteId

Activity name : DeleteEmployerNoteByNoteId
Delete an existing note record
employerNotes.getEmployerNoteByNoteId

Activity name : GetEmployerNoteByNoteId
Get the details of a note
employerNotes.getEmployerNotesByEmployerId

Activity name : GetEmployerNotesByEmployerId
Get a list of notes, available for the user, for the employer.
employerNotes.postEmployerNoteByEmployerId

Activity name : PostEmployerNoteByEmployerId
Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata to the POST URL.
Defaults: Default values for a new object can be acquired by adding /defaults' to the POST URL.
employerNotes.putEmployerNoteByNoteId

Activity name : PutEmployerNoteByNoteId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding / metadata to the PUT URL.
employerUser.deleteEmployerUserByUserId

Activity name : DeleteEmployerUserByUserId
Delete an existing user
employerUser.getEmployerUserByUserId

Activity name : GetEmployerUserByUserId
Get the details of an user
employerUser.getEmployerUsersByEmployerId

Activity name : GetEmployerUsersByEmployerId
Get the list of users of the employer
employerUser.patchEmployerUserInviteByUserId

Activity name : PatchEmployerUserInviteByUserId
Metadata : Possible options for fields of the type 'metadata' can be acquired via /providers/employers/{employerId}/users/metadata
Defaults : No defaults
Resend or change the status of an invite for an employer user.
employerUser.postEmployerUserByEmployerId

Activity name : PostEmployerUserByEmployerId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
Defaults : Default values for a new object can be acquired by adding `/defaults' to the POST URL.
Add an SSO or Azure AD user for an employer. `
employerUser.postInviteEmployerUserByEmployerId

Activity name : PostInviteEmployerUserByEmployerId
Metadata : Possible options for fields of the type 'metadata' can be acquired via /providers/employers/{employerId}/users/metadata
Defaults : Default values for a new object can be acquired by via /providers/employers/{employerId}/users/defaults
Send an invite to an user for an employer.
employerUser.postLinkExistingUserByEmployerId

Activity name : PostLinkExistingUserByEmployerId
Metadata : No metadata endpoint
Defaults : No default values
Link an existing employer user to this employer.
employerUser.putEmployerUserByUserId

Activity name : PutEmployerUserByUserId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL.
Edit the details of an user
employerUserAuthorizations.getEmployerUserAuthorizationsByEmployerIdAndUserId

Activity name : GetEmployerUserAuthorizationsByEmployerIdAndUserId
List the available authorizations for the user - employer combination. Note that the employer user can have a different set of authorizations per employer.
=============== This endpoint is not yet available ===============
employerUserAuthorizations.patchEmployerUserAuthorizationsByUserId

Activity name : PatchEmployerUserAuthorizationsByUserId
Manage the employer user authorizations and authorizationSet.
Only the changes supplied are processed existing records not supplied in the request body will be left unchanged. e.g. If three authorizations are enabled for the user and a patch is performed with in the body one new authorization with the isEnabled = true. The result will be that the user has 4 enabled authorizations.
employerUserNotificationSettings.getEmployerUserNotificationSettingsByUserId

Activity name : GetEmployerUserNotificationSettingsByUserId
List the configuration per notification for the user
employerUserNotificationSettings.patchEmployerUserNotificationSettingsByUserId

Activity name : PatchEmployerUserNotificationSettingsByUserId
Manage the employer user notifications and notificationSet.
Note: Currently the notificationSet doesnt do anything in regard to which notifications are enabled or disabled. It only functions as a guide to the GUI to visualize and save the notifications linked to the notificationSet
Only the changes supplied are processed existing records not supplied in the request body will be left unchanged. e.g. If three notifications are enabled for the user and a patch is performed with in the body one new notification with the isEnabled = true. The result will be that the user has 4 enabled notifications.
employment.getEmploymentByEmploymentId

Activity name : GetEmploymentByEmploymentId
Get the details for an employment
employment.getEmploymentsByEmployeeId

Activity name : GetEmploymentsByEmployeeId
Get the list of employments for an employee
employment.getEmploymentsByEmployerId

Activity name : GetEmploymentsByEmployerId
Get a list of employments for an employer
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.
employment.getEmploymentsComprehensiveByEmployerId

Activity name : GetEmploymentsComprehensiveByEmployerId
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.
employment.getEmploymentsMinimizedByEmployerId

Activity name : GetEmploymentsMinimizedByEmployerId
Get a list of employments for an employer. With this version we introduced the "Minimized" resource which contains fewer fields. This version should increase performance when requesting employments for large employer.
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.
employment.patchCorrectStartDateByEmploymentId
Activity name : PatchCorrectStartDateByEmploymentId
Edit the starting date (i.e. the official first day of a contract) of an employment. Please note that changing the starting data for an employment affects multiple entities in Loket (e.g. wage-records etc).
- With a correction of the starting date, you are responsible for the associated notifications.
employment.patchReinstateByEmploymentId

Activity name : PatchReinstateByEmploymentId
reinstate for an employment.
Effectively, termination is reversed by using this endpoint and therefore the employment will be considered active again.
Maak een uitdienst melding ongedaan.
Effectief gezien, 'datum uit dienst' gegevens worden teruggedraaid waardoor het dienstverband weer als actief zal worden beschouwd in Loket
employment.patchTerminateByEmploymentId

Activity name : PatchTerminateByEmploymentId
Terminate an employment. Effectively, the endDate of the employment will be set to the given date.
Please note that setting the endDate for an employment affects multiple resources in Loket (e.g. wage, workingHours and absence). Note that the termination date is to be filled with the last day of employment.
If the termination needs to be reversed use the ../employments/{employmentId}/reinstate endpoint.
If the termination needs to be changed, use this endpoint to revise the termination data
The metadata for endOfEmploymentReason and endOfEmploymentReasonTaxAuthorities are included in the 'regular' metadata-endpoint of the Employment resource.
employment.patchTypeOfEmploymentCategoryTypeFieldsByEmploymentId

Activity name : PatchTypeOfEmploymentCategoryTypeFieldsByEmploymentId
Edit a small subset of fields of an employment.
Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the URL
employment.putEmploymentByEmploymentId

Activity name : PutEmploymentByEmploymentId
Edit the details of an employment
Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the URL
employmentCustomField.deleteEmploymentCustomFieldByEmploymentCustomFieldId

Activity name : DeleteEmploymentCustomFieldByEmploymentCustomFieldId
Delete an existing custom field record
employmentCustomField.getEmploymentCustomFieldByEmploymentCustomFieldId

Activity name : GetEmploymentCustomFieldByEmploymentCustomFieldId
Get the details of a custom field
employmentCustomField.getEmploymentCustomFieldssByEmploymentId

Activity name : GetEmploymentCustomFieldsByEmploymentId
Get a list of the custom fields for an employment.
Note: custom fields are user defined at the employer level.
employmentCustomField.postEmploymentCustomFieldByEmploymentId

Activity name : PostEmploymentCustomFieldByEmploymentId
Metadata: Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
employmentCustomField.putEmploymentCustomFieldByEmploymentCustomFieldId

Activity name : PutEmploymentCustomFieldByEmploymentCustomFieldId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding / metadata to the PUT URL.
employmentDossier.deleteDocumentByEmploymentIdAndDocumentId

Activity name: DeleteDocumentByEmploymentIdAndDocumentId
Delete a document in the employment dossier
employmentDossier.getAuditTrailByEmploymentIdAndDocumentId

Activity name : GetAuditTrailByEmploymentIdAndDocumentId
Get audittrail for the document in the employment dossier.
employmentDossier.getDocumentByEmploymentIdAndDocumentId

Activity name : GetDocumentByEmploymentIdAndDocumentId
Download the file of a given employment dossier entry. Via Qwoater.
employmentDossier.getDocumentsByEmploymentId

Activity name : GetDocumentsByEmploymentId
Get a list of documents within the employee's employment dossier (werknemerdossier). Via Qwoater.
employmentDossier.postDocumentByEmploymentId

Activity name : PostDocumentByEmploymentId
Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata to the POST URL.
Upload a document within the employee's employment dossier (werknemerdossier). Via Qwoater.
employmentDossier.putDocumentByEmploymentIdAndDocumentId

Activity name: PutDocumentByEmploymentIdAndDocumentId
Edit the details for a document in the employment dossier
employmentFunds.deleteEmploymentFundByEmploymentFundId

Activity name : DeleteEmploymentFundByEmploymentFundId
Delete an existing employment fund record.
employmentFunds.getEmploymentFundByEmploymentFundId

Activity name : GetEmploymentFundByEmploymentFundId
Get the details of an employment fund
employmentFunds.getEmploymentFundsByEmploymentId

Activity name : GetEmploymentFundsByEmploymentId
Get a list of the funds the employment partakes in.
employmentFunds.postEmploymentFundByEmploymentId

Activity name : PostEmploymentFundByEmploymentId
Metadata : Possible options for fields of the type "metadata" can be acquired (GET) by adding /metadata to the POST URL.
Defaults : Default values for a new object can be acquired by adding `/defaults" to the POST URL.
Activate a fund for an employment`
employmentFunds.putEmploymentFundByEmploymentFundId

Activity name : PutEmploymentFundByEmploymentFundId
Metadata : Possible options for fields of the type "metadata" can be acquired (GET) by adding /metadata to the PUT URL.
employmentNotes.deleteEmploymentNoteByNoteId

Activity name : DeleteEmploymentNoteByNoteId
Delete an existing note record
employmentNotes.getEmploymentNoteByNoteId

Activity name : GetEmploymentNoteByNoteId
Get the details of an employment note
employmentNotes.getEmploymentNotesByEmploymentId

Activity name : GetEmploymentNotesByEmploymentId
Get a list of notes, available for the user, for the employment.
employmentNotes.postEmploymentNoteByEmploymentId

Activity name : PostEmploymentNoteByEmploymentId
Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata to the POST URL.
Defaults: Default values for a new object can be acquired by adding /defaults' to the POST URL.
employmentNotes.putEmploymentNoteByNoteId

Activity name : PutEmploymentNoteByNoteId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding / metadata to the PUT URL.
employmentTemplate.getEmploymentTemplatesByEmployerId

Activity name : GetEmploymentTemplatesByEmployerId Get the employment templates that are available at this employer's level.
An employment templates (werknemersjabloon) provides as predefined set of values for a new employment. This is mostly when creating a new employee or employment as this allows the user to apply the template's values and augment this with any specific values.
externalTenant.getExternalTenantsByEmployerId

Activity name: GetExternalTenantsByEmployerId
Get a list of external tenants that are available within the scope of this employer. An external tenant may be registered for a Loket user, and may be used to login to Loket using Azure Active Directory.
externalTenant.getExternalTenantsByProviderId

Activity name: GetExternalTenantsByProviderId
Get a list of external tenants that are available within the scope of this provider. An external tenant may be registered for a Loket user, and may be used to login to Loket using Azure Active Directory.
externalTenantEmployerUser.getConfiguredExternalTenantByEmployerUserId

Activity name : GetConfiguredExternalTenantByEmployerUserId
Get the external tenant that is configured for this specific user.
externalTenantEmployerUser.patchConfiguredExternalTenantByEmployerUserId

Activity name : PatchConfiguredExternalTenantByEmployerUserId
Metadata : N/A.
Defaults : N/A.
Modify an external tenant to the list of an configured external tenants for an employer user. An configured external tenant may be removed by sending a request body with both an empty externalTenant object and an empty externalUser object.
externalTenantProviderUser.getConfiguredExternalTenantByProviderUserId

Activity name : GetConfiguredExternalTenantByProviderUserId
Get the external tenant that is configured for this specific user.
externalTenantProviderUser.patchConfiguredExternalTenantByProviderUserId

Activity name : PatchConfiguredExternalTenantByProviderUserId
Metadata : N/A.
Defaults : N/A.
Modify an external tenant to the list of an configured external tenants for an employer user. An configured external tenant may be removed by sending a request body with both an empty externalTenant object and an empty externalUser object.
fiscalCompanyCar.deleteFiscalCompanyCarByFiscalCompanyCarId

Activity name: DeleteFiscalCompanyCarByFiscalCompanyCarId
Delete a fiscal company car record for the employment
Please note this resource is related for the registration of the company car for tax purposes. This is NOT directly related to the registration of the company car(s) related to the HRM-module Verstrekking
fiscalCompanyCar.getAdditionalTaxliabilityByLicensePlateNumber

Activity name: GetAdditionalTaxliabilityByLicensePlateNumber
This endpoint allows the user to acquire values for specific properties in the company car resource. This endpoint will require a license plate number (vehicle registration number), and will return aggregated data based on its RDW-registration.
fiscalCompanyCar.getFiscalCompanyCarByFiscalCompanyCarId

Activity name: GetFiscalCompanyCarByFiscalCompanyCarId
Get the details of fiscal company car
Please note this resource is related for the registration of the company car for tax purposes. This is NOT directly related to the registration of the company car(s) related to the HRM-module Verstrekking
fiscalCompanyCar.getFiscalCompanyCarsByEmploymentId

Activity name: GetFiscalCompanyCarsByEmploymentId
Get the list of fiscal company cars for an employment.
Please note this resource is related for the registration of the company car for tax purposes. This is NOT directly related to the registration of the company car(s) related to the HRM-module 'Verstrekking'
fiscalCompanyCar.postFiscalCompanyCarByEmploymentId

Activity name: PostFiscalCompanyCarByEmploymentId
Create a fiscal company cars record for an employment.
Please note this resource is related for the registration of the company car for tax purposes and will be included in the salary calculations. This is NOT directly related to the registration of the company car(s) related to the HRM-module Verstrekking
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
Defaults : Default values for a new object can be acquired by adding /defaults' to the POST URL.
fiscalCompanyCar.putFiscalCompanyCarByFiscalCompanyCarId

Activity name: PutFiscalCompanyCarByFiscalCompanyCarId
Edit the details for a fiscal company car record.
Please note this resource is related for the registration of the company car for tax purposes. This is NOT directly related to the registration of the company car(s) related to the HRM-module Verstrekking
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL.
fiscalProperties.deleteFiscalPropertiesByFiscalPropertiesId

Activity name: DeleteFiscalPropertiesByFiscalPropertiesId
Delete a fiscal properties record for the employment
fiscalProperties.getFiscalPropertiesByEmploymentId

Activity name: GetFiscalPropertiesByEmploymentId
Get the list of fiscal properties for an employment
fiscalProperties.getFiscalPropertiesByFiscalPropertiesId

Activity name: GetFiscalPropertiesByFiscalPropertiesId
Get the details of fiscal
fiscalProperties.postFiscalPropertiesByEmploymentId

Activity name: PostFiscalPropertiesByEmploymentId
Create a fiscal properties record for an employment
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
Defaults : Default values for a new object can be acquired by adding /defaults' to the POST URL.
fiscalProperties.putFiscalPropertiesByFiscalPropertiesId

Activity name: PutFiscalPropertiesByFiscalPropertiesId
Edit the details for a fiscal properties record
Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL.
functions.getFunctionByFunctionId

Activity name: GetFunctionByFunctionId
Get the details of function
functions.getFunctionsByEmployerId

Activity name : GetFunctionsByEmployerId
Get a list of all functions for the employer. This is the point where the functions available for use at employment level (organizational entity) are managed.
functions.postFunctionByEmployerId

Activity name: PostFunctionByEmployerId
Create a function for an employer
Metadata: No metadata
Defaults: No default values
functions.putFunctionByFunctionId

Activity name: PutFunctionByFunctionId
Edit the details for a function
Metadata: No metadata
generateDocument.postGenerateDocumentByConceptEmployeeIdAndDocumentId

Activity name : PostGenerateDocumentByConceptEmployeeIdAndDocumentId
Metadata: Available templates can be acquired(GET) at Employer level(/v2/providers/employers/{conceptEmployeeId}/documenttemplates/generatedocument/metadata).
Generate a document for an concept employee and store it in the employment dossier. Via Qwoater.
generateDocument.postGenerateDocumentByEmploymentIdAndDocumentId

Activity name : PostGenerateDocumentByEmploymentIdAndDocumentId
Metadata: Available templates can be acquired(GET) at Employer level(/v2/providers/employers/{employerId}/documenttemplates/generatedocument/metadata).
Generate a document for an employment and store it in the employment dossier. Via Qwoater.
generateDocument.postGenerateDocumentPreviewByConceptEmployeeIdAndDocumentId

Activity name : PostGenerateDocumentPreviewByConceptEmployeeIdAndDocumentId
Metadata: Available templates can be acquired(GET) at Employer level(/v2/providers/employers/{employerId}/documenttemplates/generatedocument/metadata).
Generate a document for an concept employee and receive a preview. Via Qwoater.
generateDocument.postGenerateDocumentPreviewByEmploymentIdAndDocumentId

Activity name : PostGenerateDocumentPreviewByEmploymentIdAndDocumentId
Metadata: Available templates can be acquired(GET) at Employer level(/v2/providers/employers/{employerId}/documenttemplates/generatedocument/metadata).
Generate a document for an employment and receive a preview. Via Qwoater.
generateDocument.postGenerateDocumentsByEmployerIdAndDocumentId

Activity name : PostGenerateDocumentsByEmployerIdAndDocumentId
Metadata: Available templates can be acquired(GET) at Employer level(/v2/providers/employers/{employerId}/documenttemplates/generatedocument/metadata).
Generate documents for a selection of employments and store it in the employment dossier. Via Qwoater. (One document is generated and stored for each selected employment)
healthcareInsuranceAct.deleteHealthcareInsuranceActConfigurationByHealthcareInsuranceActConfigurationId

Activity name: DeleteHealthcareInsuranceActConfigurationByHealthcareInsuranceActConfigurationId
Delete a Healthcare Insurance Act record for the employment
healthcareInsuranceAct.getHealthcareInsuranceActConfigurationByEmploymentId

Activity name: GetHealthcareInsuranceActConfigurationsByEmploymentId
Get the list of Healthcare Insurance Act configuration records for an employment
healthcareInsuranceAct.getHealthcareInsuranceActConfigurationByHealthcareInsuranceActConfigurationId

Activity name: GetHealthcareInsuranceActConfigurationByHealthcareInsuranceActConfigurationId
Get the details of a Healthcare Insurance Act configuration record
healthcareInsuranceAct.postHealthcareInsuranceActConfigurationByEmploymentId

Activity name: PostHealthcareInsuranceActConfigurationByEmploymentId
Create a Healthcare Insurance Act configuration record for an employment
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
Defaults : Default values for a new object can be acquired by adding /defaults' to the POST URL.
healthcareInsuranceAct.putHealthcareInsuranceActConfigurationByHealthcareInsuranceActConfigurationId

Activity name: PutHealthcareInsuranceActConfigurationByHealthcareInsuranceActConfigurationId
Edit the details for a Healthcare Insurance Act record
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL.
import.patchImportConceptEmployeesByPayrollAdministrationId

Activity name : PatchImportConceptEmployeesByPayrollAdministrationId
Metadata: No metadata
Currently supported file is the payroll tax return XML (year 2022 or later).
initialisePayrollPeriod.postInitialisePayrollPeriodByPayrollAdministrationId
Activity name : PostInitialisePayrollPeriodByPayrollAdministrationId This is a controller endpoint to perform an action.
In the older Loket GUI this specific action is referred to as 'Automatische processen activeren'. If this action is performed for the chosen payroll period then certain calculations will be performed on the background. The execution depends on the input parameters and the payroll configuration in the given situation.
This action may be performed for all payroll periods that are available for the payroll administration AND that meet one of the following requirements;
- Payroll periods for which an approved payroll run (status = 9) is available
- The very first payroll period in time that does not yet have an approved payroll run(i.e. last payroll period with approved run + 1). Within each year, if available.
In practice, in many instances the second option will be most relevant. Please note that if the action is performed for a year that is not the current active year of payrolling, then the resulting changes may not be fully processed in regards to the full payroll process.
Metadata : No metadata endpoint available for this controller endpoint.
Defaults : Defaults endpoint is available for this controller endpoint.
initiatePayrollRun.getPayrollrunInitiationvaluesByPayrollAdministrationIdAndPeriodId

Activity name : GetPayrollrunInitiationvaluesByPayrollAdministrationIdAndPeriodId
Get the initiation values for initiating a payrollrun for a specific period.
initiatePayrollRun.postInitiatePayrollRunByPayrollAdministrationId
Activity name : PostInitiatePayrollRunByPayrollAdministrationId This is a controller endpoint to perform an action.
In the older Loket GUI this specific action is referred to as respectively 'Verlonen' / 'Verlonen periode zonder personeel' / 'Verlonen voorgaande jaren' . If this action is performed succesfully then the payroll run will be created with status 0 and will be cued for further processing. The further processing depends on the input parameters and the payroll configuration in the given situation. After the initiated run has been picked up and processed by the background process, then the status of the run will be changed accordingly.
This action may be performed for all payroll periods that are available for the payroll administration AND that meet one of the following requirements;
If typeOfInitiation = 'regular' (Verlonen);
- The very last payroll period for which an approved payroll run (status = 9) is available. Within the given year of payrolling. (This would functionally be a so-called 'correction' run)
- The very first payroll period in time that does not yet have an approved payroll run (i.e. last payroll period with approved run + 1). Within the given year of payrolling, if available
- The provided year may be a maximum of 7 years in the past (based on current datetime)
If typeOfInitiation = 'withoutEmploymentData' (Verlonen zonder personeel);
- The very first payroll period in time that does not yet have an approved payroll run (i.e. last payroll period with approved run + 1). Within the active year of payrolling
- Please note that if this type is selected then the following fields must ALL be set to null; sendEmailToEmployee, textPaySlip, textTariffPaySlip, textPayment, emailAdressPayrollRunStarted, emailFinishedPayrollRun
In general;
- It is not possible to initiate a new payroll run if there is currently a payroll run with status 0 (to be processed) or 1 (awaiting approval) within the payroll administation.
Metadata : No metadata endpoint available for this controller endpoint.
Defaults : Defaults endpoint is available for this controller endpoint by adding /defaults. Also, an endpoint is available to retrieve initiation values for a specific period.
initiatePayrollTaxReturn.postInitiatePayrollTaxReturnByPayrollAdministrationId

Activity name : PostInitiatePayrollTaxReturnByPayrollAdministrationId
This is a controller endpoint to perform an action.
Metadata :
There is a metadata endpoint that will return process information rather then true metadata. This endpoint is available by simply adding /metadata behind the URI.
Defaults : Default values for a new object can be acquired (GET) by adding /defaults' to the POST URL.
journalAllocation.deleteJournalAllocationByJournalAllocationId

Activity name: DeleteJournalAllocationByJournalAllocationId
Delete a journal allocation record
journalAllocation.getJournalAllocationByJournalAllocationId

Activity name: GetJournalAllocationByJournalAllocationId
Get the details of a financial journal allocation record (journaliseren module).
journalAllocation.getJournalAllocationsByEmploymentId

Activity name: GetJournalAllocationsByEmploymentId
Get the list of financial journal allocations (journaliseren module) for an employment.
journalAllocation.postJournalAllocationByEmploymentId

Activity name: PostJournalAllocationByEmploymentId
Create a new financial journal allocation record for an employment (journaliseren module).
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL. Possible options dependent on a specific startPeriod can be acquired via `/metadata/year/{year}/period/{period}
Defaults : There is NO /defaults endpoint available for this resource. `
journalAllocation.putJournalAllocationByJournalAllocationId
Activity name: PutJournalAllocationByJournalAllocationId
Edit the details of a financial journal allocation record (journaliseren module)
- Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL.
- Possible options dependent on a specific startPeriod can be acquired via /metadata/year/{year}/period/{period}
journalRun.getJournalRunByJournalRunId

Activity name : GetJournalRunByJournalRunId
Returns the details of a journal run.
journalRun.getJournalRunErrorsByJournalRunId

Activity name : GetJournalRunErrorsByJournalRunId
Errors that occured while processing the journalrun can be obtained via this endpoint.
journalRun.getJournalRunExportAuditTrailByJournalRunId

Activity name : GetJournalRunExportAuditTrailByJournalRunId
Returns the export audit trail for a journal run
journalRun.getJournalRunsByPayrollAdministrationId

Activity name : GetJournalRunsByPayrollAdministrationId
Returns the journal runs for a payroll administration.
journalRun.patchJournalRunByJournalRunId
Activity name : PatchJournalRunByJournalRunId
Update the status of a journal run
- Action 'markAsSuccessfullyExported'; will change the status of the journal run to 'exported'. Please note this action will not perform an actual export, but simply allows the user the manage status to match their actualities.
- Action 'MarkAsProcessingFailed'; will change the status of the journal run to 'export failed'. Please note this action will not perform an actual export, but simply allows the user the manage status to match their actualities.
journalRun.postDownloadJournalRunExportByJournalRunId

Activity name : PostDownloadJournalRunExportByJournalRunId
Download a journal run to a journal application. Use the defaults and metadata to acquire the journal application settings.
journalRun.postInitiateJournalRunByPayrollAdministrationId
Activity name : PostInitiateJournalRunByPayrollAdministrationId This is a controller endpoint to perform an action.
In the older Loket GUI this specific action is referred to as 'journaliseren' If this action is performed succesfully the journal run will be created with status 0 and will be queud for processing. After the initiated run has been picked up and processed by the background process, then the status of the run will be changed accordingly.
This action may be performed for all payroll periods that are available for the payroll administration AND that meet one of the following requirements;
- The payroll period is less then 7 years in the past
- There is a journal profile configured for the given payroll period
- There is an approved payroll run for the given payroll period that has no other journalruns except for failed or removed journalruns
- All the payroll runs are processed in order so in order to start a journalrun the previous payrollrun (that should have a journalrun) has to have a succesfull journal run in order to start the next one
Metadata : No metadata endpoint available for this controller endpoint.
Defaults : Defaults endpoint is available for this controller endpoint by adding /defaults. Also, an endpoint is available to retrieve initiation values for a specific period.
journalRun.postSendJournalRunExportByJournalRunId
Activity name : PostSendJournalRunExportByJournalRunId
Send a journal run to a journal application. Use the defaults and metadata to acquire the journal application settings. The defaults endpoint contains values for all required fields.
There are two metadata endpoints:
- /journalruns/{journalrunId}/send/metadata
- /journalruns/{journalrunId}/send/metadata/accountId/{accountId}
journalRunOverview.getRunOverviewByJournalRunId

Activity name : GetRunOverviewByJournalRunId
Returns the journal run overview in csv for the journal run. Journal runs with journalRunStatus = 0,1,2,3 dont have results and this endpoint will return an error if called for a journal run with that status.
journalRunOverview.getRunOverviewPerEmploymentByJournalRunId

Activity name : GetRunOverviewPerEmploymentByJournalRunId
Returns the journal run overview in csv for the journal run. Journal runs with journalRunStatus = 0,1,2,3 dont have results and this endpoint will return an error if called for a journal run with that status.
journalRunResults.getJournalRunResultsByJournalRunId

Activity name : GetJournalRunResultsByJournalRunId
Returns the journal run results for the journal run. Journal runs with journalRunStatus = 0,1,2,3 dont have results and this endpoint will return an error if called for a journal run with that status.
lastModifiedVersionNumbers.getEmployerLastModifiedVersionNumbersByUser
Activity name : GetEmployerLastModifiedVersionNumbersByUser
What does the 'last modified' version number reflect
The sequence number of an employer is a sequential number that reflects whether any changes have occurred in any of its UNDERLYING employments.
More precisely, it reflects the sequence number after the latest change of any database record that relates to an employment within this employer. What we consider to be 'underlying' employment data is based on a predefined set of tables, and of course given id. This predefined set of tables can be found
The scope of this predefined set is to represent 'static' employment data (vaste gegevens), and thus excludes payroll period data (variabele gegevens).
When to use
This endpoint is most useful for integrations that regularly synchronize Loket employment data with another system. As there are no webhooks available, in practice these integrations would need to regularly poll all data to see whether there any changes in the employment data. The most elementary approach of getting all employment data every time you sync acquires a LOT of calls, in some cases even millions per day. Even though we can handle quite a lot, this is not always the desired way for both client and server. Hence, this endpoint enables an alternative solution to set up such an integration.
How to use
With every update (including additions and deletions) the version number will increase. I.e. the version number will NEVER decrease over time. (Please note this is not only true within the context of a single employer (or any other entity) but applies to all changes in the database). Consequently, in practice one would use this endpoint to check if any empLoyer version numbers have increased by applying the filter query parameter to the version field, for example ?filter=version gt 70429274.
Recommended usage
- Perform your regular synchronization of static employment data
- Store the highest version number, for which you have now processed all changes. (You may use the following parameter to do this ?orderBy=-lastModifiedVersionNumber )
- Next time you want to perform synchronization. Call this endpoint with parameter ?filter=lastModifiedVersionNumber gt {{YourVersionNumber}}
- Only get employment information for employers that are included in that filtered list. (exclude all other employers as you already know there have been no changes since the last synchronization)
lastModifiedVersionNumbers.getEmploymentLastModifiedVersionNumbersByUser
Activity name : GetEmploymentLastModifiedVersionNumbersByEmployerId
This endpoint is similar to the GetEmployerLastModifiedVersionNumbersByUser endpoint described above. Please check out that description for required context.
In addition to the version on employer level, this endpoint allows you to check if this employment has any changes since your last synchronization. Consequently, this endpoint may be used to further decrease the amount of required calls when performing a synchronization.
As can be seen in the set of 'underlying' tables, also changes in Employee information corresponding to the Employment is reflected in the version number.
How to use
Recommended usage
- Perform all recommended steps in the description of the employer version number endpoint
- Use the exact SAME filter parameter to this endpoint. The resulting list will contain only the employment for which changes have occured since your last synchronization.
leave.deleteLeaveByLeaveId

Activity name : DeleteLeaveByLeaveId
Delete an existing Leave record
leave.getLeaveByEmploymentId

Activity name : GetLeaveByEmploymentId

Returns all the leave entries (both addition and subtraction) for the given employment.
leave.getLeaveByLeaveId

Activity name : GetLeaveByLeaveId
Returns one leave entry (either addition or subtraction).
leave.getLeaveDefaultsByEmploymentId

Activity name : GetLeaveDefaultsByEmploymentId
Returns the default values for all the fields. In case no default is present null will be returned.
leave.getLeaveMetadataByEmploymentId

Activity name : GetLeaveMetadataByEmploymentId
Returns the metadata values for all the metadata fields.
leave.getLeaveMetadataByLeaveId

Activity name : GetLeaveMetadataByLeaveId
Returns the metadata values for all the metadata fields.
leave.getLeaveOverviewByEmploymentIdandYear

Activity name : GetLeaveOverviewByEmploymentIdandYear Download the leave overview for a year in a single PDF
Metadata : Possible options for year can be acquired (GET) the following URL /providers/employers/employees/employments/{employmentId}/leave/overview/metadata.
leave.getProposedLeaveHoursByEmployerId

Activity name : GetProposedLeaveHoursByEmployerId
Returns the numberOfHours (only in hours) calculated based on the employments working- hours/schedual
Note: The function will only work if the employment is either linked to no leave policy or linked to only leave policy(s) that use hours as the unit of leave.
Further more how the leave hours are calculated can be managed in the leave policy with the applyLeaveSchedule and working hours resource with the field calculateUsingWorkPattern.leaveHours The order is as follows. If calculateUsingWorkPattern.leaveHours is true the work patern from workinghours is used otherwise if applyLeaveSchedule is set to true the leavePattern is used otherwise the workinghours are used
leave.getProposedLeaveHoursByEmploymentId

Activity name : GetProposedLeaveHoursByEmploymentId
Returns the numberOfHours (only in hours) calculated based on the employments working- hours/schedual
Note: The function will only work if the employment is either linked to no leave policy or linked to only leave policy(s) that use hours as the unit of leave.
Further more how the leave hours are calculated can be managed in the leave policy with the applyLeaveSchedule and working hours resource with the field calculateUsingWorkPattern.leaveHours The order is as follows. If calculateUsingWorkPattern.leaveHours is true the work patern from workinghours is used otherwise if applyLeaveSchedule is set to true the leavePattern is used otherwise the workinghours are used
leave.postLeaveByEmploymentId

Activity name : PostLeaveByEmploymentId
Add a Leave record for an employment
leave.putLeaveByLeaveId

Activity name : PutLeaveByLeaveId
Edit the details of a leave
leaveBalance.getLeaveBalancesByEmployerId

Activity name : GetLeaveBalancesByEmployerId

Returns the yearly leave balances for all employments
leaveBalance.getLeaveBalancesByEmploymentId

Activity name : GetLeaveBalancesByEmploymentId

Returns the yearly leave balances for each leave type.
leaveBalance.getLeaveBalancesGroupedByEmployerId

Activity name : GetLeaveBalancesGroupedByEmployerId

Returns the yearly leave balances total per leave type and total per groupBy
leavePolicy.deleteAgeBasedLeaveByAgeBasedLeaveId

Activity name : DeleteAgeBasedLeaveByAgeBasedLeaveId
Delete an age based leave record
leavePolicy.deleteLeavePolicyByLeavePolicyId

Activity name : DeleteLeavePolicyByLeavePolicyId
Delete a Leave policy
leavePolicy.deleteWageBasedLeaveByWageBasedLeaveId

Activity name : DeleteWageBasedLeaveByWageBasedLeaveId
Delete a wage based leave record
leavePolicy.deleteYearsOfServiceBasedLeaveByYearsOfServiceBasedLeaveId

Activity name : DeleteYearsOfServiceBasedLeaveByYearsOfServiceBasedLeaveId
Delete an years of service based leave record
leavePolicy.getAgeBasedLeaveByAgeBasedLeaveId

Activity name : GetAgeBasedLeaveByAgeBasedLeaveId
Returns one leave age based leave record
leavePolicy.getAgeBasedLeaveByLeavePolicyId

Activity name : GetAgeBasedLeaveByLeavePolicyId

Returns the age based leave for the given leave policy.
leavePolicy.getLeavePoliciesByEmployerId

Activity name : GetLeavePoliciesByEmployerId

Returns all the leave policies for the given employer.
leavePolicy.getLeavePolicyByLeavePolicyId

Activity name : GetLeavePolicyByLeavePolicyId
Returns one leave policy
leavePolicy.getWageBasedLeaveByLeavePolicyId

Activity name : GetWageBasedLeaveByLeavePolicyId

Returns the wage based leave for the given leave policy.
leavePolicy.getWageBasedLeaveByWageBasedLeaveId

Activity name : GetWageBasedLeaveByAgeBasedLeaveId
Returns one leave wage based leave record
leavePolicy.getYearsOfServiceBasedLeaveByLeavePolicyId

Activity name : GetYearsOfServiceBasedLeaveByLeavePolicyId

Returns the years of service based leave for the given leave policy.
leavePolicy.getYearsOfServiceBasedLeaveByYearsOfServiceBasedLeaveId

Activity name : GetYearsOfServiceBasedLeaveByYearsOfServiceBasedLeaveId
Returns one leave years of service based leave record
leavePolicy.patchCopyLeavePolicyByEmployerId

Activity name : PatchCopyLeavePolicyByEmployerId
Add a leave policy based on an existing leave policy at providerlevel. (Create a copy)
leavePolicy.postAgeBasedLeaveByLeavePolicyId

Activity name : PostAgeBasedLeaveByLeavePolicyId
Add an age based leave
leavePolicy.postLeavePolicyByEmployerId

Activity name : PostLeavePolicyByEmployerId
Add a leave policy
leavePolicy.postWageBasedLeaveByLeavePolicyId

Activity name : PostWageBasedLeaveByLeavePolicyId
Add a wage based leave
leavePolicy.postYearsOfServiceBasedLeaveByLeavePolicyId

Activity name : PostYearsOfServiceBasedLeaveByLeavePolicyId
Add a years of service based leave
leavePolicy.putAgeBasedLeaveByAgeBasedLeaveId

Activity name : PutAgeBasedLeaveByAgeBasedLeaveId
Edit the details of an age based leave record
leavePolicy.putLeavePolicyByLeavePolicyId

Activity name : PutLeavePolicyByLeavePolicyId
Edit the details of a leave policy
leavePolicy.putWageBasedLeaveByWageBasedLeaveId

Activity name : PutWageBasedLeaveByWageBasedLeaveId
Edit the details of a wage based leave record
leavePolicy.putYearsOfServiceBasedLeaveByYearsOfServiceBasedLeaveId

Activity name : PutYearsOFServiceBasedLeaveByYearsOfServiceBasedLeaveId
Edit the details of a years of service based leave record
leavePolicyAndEmploymentLinks.getEmploymentsByLeavePolicyId

Activity name: GetEmploymentsByLeavePolicyId Get the list of employments that are linked for this leave policy. When a leave policy and an employment are linked, that means the employment will be provided with leave based on the policy.
leavePolicyAndEmploymentLinks.getLeavePoliciesByEmploymentId

Activity name: GetLeavePoliciesByEmploymentId
Get the list of leave policies linked to the employment. If a leave policy and employment are linked, that means the employment will be provided the leave based on the policy.
leavePolicyAndEmploymentLinks.patchEmploymentsByLeavePolicyId

Activity name: PatchEmploymentsByLeavePolicyId This endpoint enables the user to create or delete multiple 'linkages' with one call. This is mostly useful updating a larger number of employments for the given leave policy.
leavePolicyAndEmploymentLinks.patchLeavePoliciesByEmploymentId

Activity name: PatchLeavePoliciesByEmploymentId
Metadata : Possible options can be acquired (GET) by adding /metadata to the POST URL.
This endpoint enables the user to link or unlink multiple 'linkages' with one call.
leaveRequest.getLeaveRequestByLeaveRequestId

Activity name : GetLeaveRequestByLeaveRequestId
Get the details of a single leave request
leaveRequest.getLeaveRequestsByEmploymentId

Activity name : GetLeaveRequestsByEmploymentId
Get a list of all leave requests for the given employment
leaveRequest.getLeaveRequestsForEmployer

Activity name : GetLeaveRequestsByEmployerId
Returns a list of leave requests for the employments of the employer
leaveRequest.patchLeaveRequestsByLeaveRequestIds

Activity name : PatchLeaveRequestsByLeaveRequestIds
This endpoints changes the status of the list of leave requests provided in the request body to the provided status. The leave requests are processed one by one. The leave requests that had no error's will be commited to the database while those with an error will be skipped. If an error occured the service will return a 400 bad request with a message explaining what error occured for what ID (GUID). The leave requests that where processed succesfully will not be returned in te response.
leaveRequest.putLeaveRequestByLeaveRequestId

Activity name : PutLeaveRequestByLeaveRequestId
Change the details of a Leave request
Important: A PUT is only allowed when the leave requests is in the status "submitted"/"ingediend". Only the field of commentHandler may be editied in other statuses.
leaveTypes.getLeaveTypeByEmployerIdAndLeaveTypeId

Activity name: GetLeaveTypeByEmployerIdAndLeaveTypeId
Get the details of a leave type
leaveTypes.getLeaveTypesByEmployerId

Activity name : GetLeaveTypesByEmployerId
Get a list of all leavetypes for the employer
leaveTypes.putLeaveTypeByEmployerIdAndLeaveTypeId

Activity name: PutLeaveTypeByEmployerIdAndLeaveTypeId
Edit the details for a leave type
Metadata : There is no metadata endpoint for this resource.
linkedDepartments.getEmployerUsersLinkedDepartmentsByEmployerId

Activity name: GetEmployerUsersLinkedDepartmentsByEmployerId
Get the list of departments that the user has access to
linkedDepartments.patchEmployerUserLinkedDepartmentsByEmployerIdAndUserId

Activity name: PatchEmployerUserLinkedDepartmentsByEmployerIdAndUserId
This endpoint enables the user to link or unlink multiple 'linkages' with one call.
linkedEmployers.getLinkedEmployersByUserId

Activity name : GetLinkedEmployersByUserId
List of employers accessible by the user
mdvNotifications.patchMdvNotificationsByPayrollAdministrationId

Activity name : PatchMdvNotificationsByPayrollAdministrationId
Mdv notifications
modules.getModulesByEmployerId

Activity name : GetModulesByEmployerId
Get the array of the modules enabled for the specified employer. A module enables a certain functionality for the given employer. These are typically called 'producten' in Loket.
nationalHoliday.getNationalHolidaysByEmployerId

Activity name : GetNationalHolidaysByEmployerId
Get a list of all national holidays for the employer
nationalHoliday.getNationalHolidaysByEmployerIdAndNationalHolidayId

Activity name: GetNationalHolidaysByEmployerIdAndNationalHolidayId
Get the details of a national holiday
nationalHoliday.putNationalHolidayByEmployerIdAndNationalHolidayId

Activity name: PutNationalHolidayByEmployerIdAndNationalHolidayId
Edit the details for a national holiday
Metadata : There is no metadata endpoint for this resource.
notification.getNotificationsByEmployerId

Activity name : GetNotificationsByEmployerId
Get a list of unread notifications for an employer
notification.patchNotifications

Activity name : PatchNotificationsByEmployerId
Mark notifications as read
notificationSets.getNotificationSetByNotificationSetId

Activity name : GetNotificationSetByNotificationSetId
Details of an notification set.
notificationSets.getNotificationSetsByProviderId

Activity name : GetNotificationSetsByProviderId
List the available notification sets.
occupationalDisability.getOccupationalDisabilitiesByEmployeeId

Activity name : GetOccupationalDisabilitiesByEmployeeId
Get the list of occupational disabilities for an employee. This endpoint returns occupational disability information regarding the Occupational Disability Insurance Act (WAO) and Work Capacity Act (WIA).
organizationalEntity.deleteOrganizationalEntityByOrganizationalEntityId

Activity name: DeleteOrganizationalEntityByOrganizationalEntityId
Delete a organizational entity for the employment
organizationalEntity.getOrganizationalEntitiesByEmploymentId

Activity name: GetOrganizationalEntitiesByEmploymentId
Get the list of organizational entities for an employment
organizationalEntity.getOrganizationalEntityByOrganizationalEntityId

Activity name: GetOrganizationalEntityByOrganizationalEntityId
Get the details of organizational entity
organizationalEntity.postOrganizationalEntityByEmploymentId

Activity name: PostOrganizationalEntityByEmploymentId
Create an organizational entity for an employment
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
Defaults : Default values for a new object can be acquired by adding /defaults' to the POST URL.
organizationalEntity.putOrganizationalEntityByOrganizationalEntityId

Activity name: PutOrganizationalEntityByOrganizationalEntityId
Edit the details for an organizational entity
Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL.
otherPayrollVariables.deleteOtherPayrollVariablesByOtherPayrollVariablesId

Activity name : DeleteOtherPayrollVariablesByOtherPayrollVariablesId
Delete an existing other payroll variables record (for an employment)
otherPayrollVariables.getOtherPayrollVariablesByEmploymentId

Activity name : GetOtherPayrollVariablesByEmploymentId
Get a list of the other payroll variables for an employment Other payroll variables are a set of infrequently used properties for the payroll (wage tax and pension) proces
otherPayrollVariables.getOtherPayrollVariablesByOtherPayrollVariablesId

Activity name : GetOtherPayrollVariablesByOtherPayrollVariablesId
Get the details of other payroll variables for an employment
otherPayrollVariables.postOtherPayrollVariablesByEmploymentId

Activity name : PostOtherPayrollVariablesByEmploymentId
Add other payroll variables for an employment. Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
Defaults : Default values for a new object can be acquired by adding /defaults' to the POST URL.
otherPayrollVariables.putOtherPayrollVariablesByOtherPayrollVariablesId

Activity name : PutOtherPayrollVariablesByOtherPayrollVariablesId
Change the details of an other payroll variables record
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL.
partner.deletePartnerByPartnerId

Activity name : DeletePartnerByPartnerId
Delete an existing partner
partner.getPartnerByPartnerId

Activity name : GetPartnerByPartnerId
Get the details of a single partner
partner.getPartnersByEmployeeId

Activity name : GetPartnersByEmployeeId
Get the list of partners of the employee
partner.postPartnerByEmployeeId

Activity name : PostPartnerByEmployeeId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
Defaults : Default values for a new object can be acquired by adding `/defaults' to the POST URL.
Create the partner for an employee `
partner.putPartnerByPartnerId

Activity name : PutPartnerByPartnerId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL.
Edit the partner information
paygrade.getConceptEmployeePayGradeMetaDataByPayrollAdministrationIdAndPayscaleKeyAndPayGradeKey

Activity name : GetConceptEmployeePayGradeMetaDataByPayrollAdministrationIdAndPayscaleKeyAndPayGradeKey
Acquire data on a specific paygrade, this consists of a list of paygrade values and their respective startDates.
If a valid date parameter is included in the call, the list will consists of one item that is applicable for that date.
paymentInformation.deletePaymentInformationSepaBypaymentInformationSepaId

Activity name : DeletePaymentInformationSepaByPaymentInformationSepaId
Delete an existing SEPA payment-record (for an employment)
paymentInformation.getPaymentInformationSepaByEmploymentId

Activity name : GetPaymentInformationSepaByEmploymentId
Get a list of payment information for SEPA bank accounts (IBAN's) for an employment.
For a specific payroll component, the record indicates to which IBAN payments will be made. This includes, but is not limited to, the payment of wages for an employment.
For each payroll component there can only be one payment information record per employment.
paymentInformation.getPaymentInformationSepaBypaymentInformationSepaId

Activity name : GetPaymentInformationSepaBypaymentInformationSepaId
Get the detail of a payment information SEPA record.
For a specific payroll component, the record indicates to which IBAN account number it should be related for the purpose of outgoing payments. This includes, but is not limited to, the payment of wages for an employment. For each payroll component there can only be one outgoing payment record per employment.
paymentInformation.postPaymentInformationSepaByEmploymentId

Activity name : PostPaymentInformationSepaByEmploymentId
Create a new Payment information SEPA record for an employment.
For each unique payroll component there can only be one payment record per employment.
Metadata : Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the URL
Defaults : Default values for a new object can be acquired by adding /defaults' to the POST URL.
paymentInformation.putPaymentInformationSepaByPaymentInformationSepaId

Activity name : PutPaymentInformationSepaByPaymentInformationSepaId
Edit an existing SEPA payment-record (for an employment). For each unique payroll component there can only be one payment record per employment. Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the URL
paymentInformationNonSepa.deletePaymentInformationNonSepaByPaymentInformationNonSepaId

Activity name : DeletePaymentInformationNonSepaByPaymentInformationNonSepaId
Delete a payment information non-SEPA record (for an employment)
paymentInformationNonSepa.getPaymentInformationNonSepaByEmploymentId

Activity name : GetPaymentInformationNonSepaByEmploymentId
Get a list of payment information for non-SEPA bank accounts for an employment. These are payments to be performed that will NOT be based on an IBAN (which is the standard), so this is mostly useful for foreign payments that are not based within a SEPA-country.
For a specific payroll component, the record indicates to which account payments will be made. This includes, but is not limited to, the payment of wages for an employment.
For each payroll component there can only be one payment Information record per employment.
paymentInformationNonSepa.getPaymentInformationNonSepaBypaymentInformationNonSepaId

Activity name : GetPaymentInformationNonSepaByPaymentInformationNonSepaId
Get the detail of a payment information non-SEPA record. For a specific payroll component, the record indicates to which IBAN account number it should be related for the purpose of outgoing payments. This includes, but is not limited to, the payment of wages for an employment. For each payroll component there can only be one outgoing payment record per employment.
paymentInformationNonSepa.postPaymentInformationNonSepaByEmploymentId

Activity name : PostPaymentInformationNonSepaByEmploymentId
Create a new payment information non-SEPA record for an employment. For each unique payroll component there can only be one payment information non-SEPA record per employment.
Metadata : Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the URL
Defaults : Default values for a new object can be acquired by adding /defaults' to the POST URL.
paymentInformationNonSepa.putPaymentInformationNonSepaByPaymentInformationNonSepaId

Activity name : PutPaymentInformationNonSepaByPaymentInformationNonSepaId
Edit an existing payment information non-SEPA record (for an employment). For each unique payroll component there can only be one payment record per employment.
Metadata : Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the URL
paymentInformationSeparatePayments.deletePaymentInformationSepaSeparatePaymentByPaymentInformationSepaSeparatePaymentId

Activity name : DeletePaymentInformationSepaSeparatePaymentByPaymentInformationSepaSeparatePaymentId
Delete an existing SEPA payment-record (for an employment)
paymentInformationSeparatePayments.getPaymentInformationSepaSeparatePaymentByEmploymentId

Activity name : GetPaymentInformationSepaSeparatePaymentByEmploymentId
Get a list of records that indicate, if applicable, the bank account(s) (i.e. IBAN's) where a given amount of the net salary for this employment will be paid to.
paymentInformationSeparatePayments.getPaymentInformationSepaSeparatePaymentByPaymentInformationSepaSeparatePaymentId

Activity name : GetPaymentInformationSepaSeparatePaymentByPaymentInformationSepaSeparatePaymentId
Get the detail of a payment information SEPA record. For a specific payroll component, the record indicates to which IBAN account number it should be related for the purpose of outgoing payments. This includes, but is not limited to, the payment of wages for an employment. For each payroll component there can only be one outgoing payment record per employment.
paymentInformationSeparatePayments.postPaymentInformationSepaSeparatePaymentByEmploymentId

Activity name : PostPaymentInformationSepaSeparatePaymentByEmploymentId
Create a new payment information SEPA separate payment record for an employment.
Metadata : Not applicable for this resource.
Defaults : Default values for a new object can be acquired by adding /defaults' to the POST URL.
paymentInformationSeparatePayments.putPaymentInformationSepaSeparatePaymentByPaymentInformationSepaSeparatePaymentId

Activity name : PutPaymentInformationSepaSeparatePaymentByPaymentInformationSepaSeparatePaymentId
Edit an existing separate payment-record (for an employment). For each unique payroll component there can only be one payment record per employment.
Metadata : Not applicable for this resource.
payrollAdministration.getPayrollAdministrationsByEmployerId

Activity name : GetPayrollAdministrationsByEmployerId
Get a list of all payroll administrations for an employer
payrollAdministrationProcessOverview.getPayrollProcessOverviewByPayrollAdministrationId

Activity name : GetPayrollProcessOverviewByPayrollAdministrationId
Get an overview of the status and possible actions for the specified period, including the preceding and subsequent period. The overview contains information about: payroll runs, payroll tax return and pension. Metadata : Possible options for the query string parameters can be acquired (GET) via the /metadata endpoint. The URI for this endpoint is ../providers/employers/payrolladministrations/{payrollAdministrationId}/payrollprocessoverview/metadata.
Defaults : Default values for the query string parameters can be acquired via the /defaults endpoint. The URI for this endpoint is ../providers/employers/payrolladministrations/{payrollAdministrationId}/payrollprocessoverview/defaults.
payrollAdministrationReports.getAccumulatedBasicJournalResultsReportByPayrollAdministrationId

Activity name : GetAccumulatedBasicJournalResultsReportByPayrollAdministrationId
Acquire accumulated basic journal results reports (cumulatief journaal niet-verdicht en verdicht) at the payroll administration level. Currently this endpoint supports following report types to be requested: Please note: this endpoint may only be used to acquire a report in the pdf-type format
payrollAdministrationReports.getAccumulationsAndBalancesReportByPayrollAdministrationId
Activity name : GetAccumulationsAndBalancesReportByPayrollAdministrationId
Acquire the reports for either accumulations or balances at the payroll administration level. Currently this endpoint supports following report types to be requested:
- baseForCalculationBalancesAtStartOfYear (grondslag begin jaar)
- leaveBalancesAtStartOfYear (verlof begin jaar)
- leaveAccrualWithinYear (opbouw verlof ulsa)
payrollAdministrationReports.getAnnualPayrollTaxReturnReportByPayrollAdministrationId

Activity name : GetAnnualPayrollTaxReturnReportByPayrollAdministrationId
Acquire the annual payroll tax return report (jaaroverzicht loongaangiftestaat) on payroll administration level, as generated by the reporting service.
Please note: this endpoint may only be used to acquire a report in the pdf-type format
payrollAdministrationReports.getAnnualWagesheetReportByPayrollAdministrationId

Activity name : GetAnnualWagesheetReportByPayrollAdministrationId
Acquire the annual wage sheet report (verzamelloonstaat) on payroll administration level, as generated by the reporting service.
__Note: __ For the querystring parameters take note of the following logic either reportYear has a value or start and endperiod have a value
payrollAdministrationReports.getAttachmentsOfEarningsReportByPayrollAdministrationId

Activity name : GetAttachmentsOfEarningsReportByPayrollAdministrationId
Download the attachment of earnings report for the administration
payrollAdministrationReports.getDeviatingPremiumsWabReportByPayrollAdministrationId

Activity name : GetDeviatingPremiumsWabReportByPayrollAdministrationId
The percentage deviation between the contract hours and the actual standard hours to assess whether the low wab premium should be revised to the high wab premium.
payrollAdministrationReports.getPayrollAdministrationSettingsReportByPayrollAdministrationId

Activity name : GetPayrollAdministrationSettingsReportByPayrollAdministrationId
Acquire the payroll administration configuration report (overzicht inrichting salarisverwerking) on payroll administration level for a year, as generated by the reporting service.
Please note: this endpoint may only be used to acquire a report in the pdf-type format
payrollComponents.getPayrollComponentsByPayrollAdministrationIdAndYear

Activity name : GetPayrollComponentsByPayrollAdministrationIdAndYear Get the available payroll components for an administration.
payrollComponentSet.getAvailablePayrollComponentSetsByPayrollAdministrationId

Activity name : GetAvailablePayrollComponentSetsByPayrollAdministrationId Get the available payroll components sets that are available at this level. A payroll component set defines a set of payroll components to be used as a sjabloon preventing the need for users to constatnly select the same set of payroll components. Payroll component set are commonly used when entering payroll period data (variabele gegevens) either for a single employment or for multiple employments (browser variabele gegevens). They are also used as a filter when exporting payroll run results.
Both at the provider level and payroll administration the user may define sets and which components it includes. This endpoint will return an aggregated view of the applicable sets and its corresponding component based on the defined sets at provider and administration level.
payrollPeriodData.deletePayrollPeriodDataByPayrollPeriodDataId

Activity name: DeletePayrollPeriodDataByPayrollPeriodDataId
Delete a payroll period data record for the employment
payrollPeriodData.getPayrollPeriodDataByEmploymentId

Activity name : GetPayrollPeriodDataByEmploymentId

Get a list of all payroll period data for an employment. Payroll period data relates to a single payroll period.
payrollPeriodData.getPayrollPeriodDataByPayrollPeriodDataId

Activity name : GetPayrollPeriodDataByPayrollPeriodDataId

Get the details of payroll period data
payrollPeriodData.patchPayrollPeriodDataByEmploymentId
This endpoint is the REST alternative to the ImporteerGegevens (Variabele Gegevens) SOAP webservice functionality

Activity name : PatchPayrollPeriodDataByEmploymentId

This endpoint is typically used by applications that are considered to be leading in regard to the values for the payroll components they manage. For most (external) applications this will the most viable endpoint to achieve that functionality. Loket considers these parties as not interested in the current state of the payroll period data in the Loket.nl database. This endpoint is provided to make these scenarios easier to implement since no GET call is required to determine whether a POST or PUT call is to be performed to either insert or update payroll period data. Based on the current state of the database Loket.nl will either insert a new record or update the existing record with the supplied data.
- A new record is created when the combination of payrollPeriod, shift, payslipType, distributionUnit, costCenter and costUnit is valid and does not exist for the employment. Next to that, the objects consisting of payrollComponent, value and attribute are inserted into the database.
- An update is performed when the combination of payrollPeriod, shift, payslipType, distributionUnit, costCenter and costUnit does exist for the employment. In that case the specified objects consisting of payrollComponent, value and attribute are inserted into the database, overwriting existing values. Existing records with a payrollComponent.key that is not supplied in the request are not modified.
  
  Metadata :
  Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PATCH URL
  Possible values for fields of the type 'metadata' that are PERIOD-specific can be acquired (GET) by adding /metadata/year/{year}/period/{periodNumber} to the PATCH URL
  
  Default values :
  Default values may be acquired by adding /defaults (GET) to the PATCH url . It is very much (!!!) recommended to acquire the defaults-objects first and use that information when inserting data for this employment. I.e. use the default values for costCenter, shift etcetera and the complement the object with the payroll components you want to provide.
  
  Extra background reading :
  It may be useful to read more about payroll period data (variabele gegevens, mutaties) on the Loket.nl . Please note that this information is in Dutch and access is required.
payrollPeriodData.postPayrollPeriodDataByEmploymentId

Activity name : PostPayrollPeriodDataByEmploymentId

Create a payroll period date record for an employment

Metadata :
Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL
Possible values for fields of the type 'metadata' that are PERIOD-specific can be acquired (GET) by adding /metadata/year/{year}/period/{periodNumber} to the POST URL
Default values :
* Default values may be acquired by adding /defaults (GET) to the POST url
payrollPeriodData.putPayrollPeriodDataByPayrollPeriodDataId

Activity name : PutPayrollPeriodDataByPayrollPeriodDataId

Edit the details for payroll period data

Metadata :
Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL
Possible values for fields of the type 'metadata' that are PERIOD-specific can be acquired (GET) by adding /metadata/year/{year}/period/{periodNumber} to the PUT URL
payrollPeriodDataOnAdministrationLevel.getPayrollPeriodDataByPayrollAdministrationIdAndPayrollPeriodId

Activity name : GetPayrollPeriodDataByPayrollAdministrationIdAndPayrollPeriodId
Get a list of all payroll period data for all the active employment in the given payroll period for the give payroll administration. Payroll period data relates to a single payroll period.
This endpoint only returns objects for which the employment meets the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.
Metadata : Possible options for the query string parameters can be acquired (GET) via the /metadata endpoint. The URI for this endpoint is ../providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/payrollperioddata/metadata.
Defaults : Default values for the query string parameters can be acquired via the /defaults endpoint. The URI for this endpoint is ../providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/payrollperioddata/defaults.
payrollPeriods.getPayrollPeriodsByPayrollAdministrationId

Activity name : GetPayrollPeriodsByPayrollAdministrationId
Returns a list of all payroll periods available for the given payroll administration
payrollPeriods.getPayrollPeriodsMinimizedByPayrollAdministrationId

Activity name : GetPayrollPeriodsMinimizedByPayrollAdministrationId
Returns a list of all payroll periods available for the given payroll administration
payrollProcessStatus.getPayrollProcessStatusByProviderId

Activity name : GetPayrollProcessStatusByProviderId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
Defaults : The default value for payrollPeriod.payrollPeriodId can be acquired by adding `/defaults' to the POST URL.
Returns an array of objects. Each object contains information about the payroll administration and the payroll processes status. `
payrollResults.getComparePayrollPeriodsByPayrollAdministrationId

Activity name : GetComparePayrollPeriodsByPayrollAdministrationId
Returns the results of given payroll period and the one before so a comparison can be made. Currently only the components 260, 495, 257 are returned
payrollResults.getPayrollPeriodResultsByPayrollAdministrationIdAndPayrollPeriodId

Activity name : GetPayrollPeriodResultsByPayrollAdministrationIdAndPayrollPeriodId
Returns the payroll results for the payroll period.
Note : This endpoint is related to the GetPayrollRunResultsByPayrollRunId endpoint. Both endpoints return the same output just in a different way. This endpoint returns the current state of the payroll results for the given period where as GetPayrollRunResultsByPayrollRunId returns the payroll results for the given payroll run (a payroll run can contain payroll results for multiple payroll periods). It's posible for payroll results to be created after the end of the payroll period it zelf. For example, the payroll periode 01-2020 ends at 31-01-2020 (in case of a monthly payroll period) it is posible that the payroll run for period 07-2020 contains payroll results for the period 01-2020 due to a retroactivity change for that period. This change in the payroll run for payroll period 07-2020 would require the system to reaquire the results for period 01-2020 (as they changed).
payrollRun.getPayrollRunByPayrollRunId

Activity name : GetPayrollRunByPayrollRunId
Get the details of a single payrollrun
payrollRun.getPayrollRunsByPayrollAdministrationId

Activity name : GetPayrollRunsByPayrollAdministrationId
A list of payroll runs for an administration
payrollRunDownloads.getDefaultSetByPayrollRunId

Returns the default set of downloads for the payroll run as a PDF file. The default set of downloads can be defined by the user.
payrollRunDownloads.getErrorsAndWarningsByPayrollRunId

Activity name : GetErrorsAndWarningsByPayrollRunId
Returns an overview of errors and warnings that occurred during the payroll run as a PDF file.
payrollRunDownloads.getJournalEntriesPerDistributionUnitOverviewsByPayrollRunId

Activity name : GetJournalEntriesPerDistributionUnitOverviewsByPayrollRunId
Returns the journal entries by distribution Unit for a payroll run as a PDF file.
payrollRunDownloads.getPaymentOverviewsByPayrollRunId

Activity name : GetPaymentOverviewsByPayrollRunId
Returns payment overviews for a payroll run as a PDF file. By default the payment overview 1 is returned.
payrollRunDownloads.getPayrollControlRegisterByPayrollRunId

Activity name : GetPayrollControlRegisterByPayrollRunId
Returns payroll control register for a payroll run as a PDF file.
payrollRunDownloads.getPayrollRunBalanceSheetByPayrollRunId

Activity name : GetPayrollRunBalanceSheetByPayrollRunId
This endpoint returns per payroll components, marked as relevant for the general ledge (balance sheet), the sum of the values.
If for the given payroll period of the payroll run a "journal profile" is configured the endpoint also returns the ledger account and costcenter/costunit linked to the given payroll component in the "journal profile"
payrollRunDownloads.getPayslipsByPayrollRunId

Activity name : GetPayslipsByPayrollRunId
Returns the payslips for a payroll run as a PDF file. By default the payslips are sorted by employeeNumber.
payrollRunDownloads.getRunOverviewsByPayrollRunId

Activity name : GetRunOverviewsByPayrollRunId
Returns run overviews for a payroll run as a PDF file.
payrollRunDownloads.getSepaFileBySepaFileId

Activity name : GetSepaFileBySepaFileId
Returns the specified SEPA payments file as a XML file.
payrollRunDownloads.getSepaFilesByPayrollRunId

Activity name : GetSepaFilesByPayrollRunId
Returns the SEPA file(s) for the specified payroll run.
payrollRunDownloads.getTotalSepaFileByPayrollRunId

Activity name : GetTotalSepaFileByPayrollRunId
Returns the total SEPA payments file as a XML file. This file contains the payments of all the available SEPA payment files available for the specified payroll run.
payrollRunDownloads.getWageSheetsByPayrollRunId

Activity name : GetWageSheetsByPayrollRunId
Returns the wage sheets for a payroll run as a PDF file or XLSX file. By default the wage sheets contain information on both the employer and the employees.
payrollRunNotes.deletePayrollRunNoteByNoteId

Activity name : DeletePayrollRunNoteByNoteId
Delete an existing note record
payrollRunNotes.getPayrollRunNoteByNoteId

Activity name : GetPayrollRunNoteByNoteId
Get the details of a note
payrollRunNotes.getPayrollRunNotesByPayrollRunId

Activity name : GetPayrollRunNotesByPayrollRunId
Get a list of notes, available for the user, for the payroll run.
payrollRunNotes.postPayrollRunNoteByPayrollRunId

Activity name : PostPayrollRunNoteByPayrollRunId
Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata to the POST URL.
Defaults: Default values for a new object can be acquired by adding /defaults' to the POST URL.
payrollRunNotes.putPayrollRunNoteByNoteId

Activity name : PutPayrollRunNoteByNoteId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding / metadata to the PUT URL.
payrollRunResults.getPayrollRunResultsByPayrollRunId

Activity name : GetPayrollRunResultsByPayrollRunId
Returns the results for the payroll run
payrollSimulator.getPayrollSimulatorDataByEmploymentId

Activity name : GetPayrollSimulatorDataByEmploymentId
Get an overview of the data used in a payroll simulation
payrollTaxReturn.getIdealPaymentStatusByPayrollTaxReturnId

Activity name : GetIdealPaymentStatusByPayrollTaxReturnId
Get the status of the IDEAL payment
payrollTaxReturn.getIdealUrlByPayrollTaxReturnId

Activity name : GetIdealUrlByPayrollTaxReturnId
Get URL which allows the user to pay payroll taxes via IDEAL
payrollTaxReturn.getPayrollTaxReturnByPayrollTaxReturnId

Activity name : GetPayrollTaxReturnByPayrollTaxReturnId
The details of a tax return for an administration
payrollTaxReturn.getPayrollTaxReturnsByPayrollAdministrationId

Activity name : GetPayrollTaxReturnsByPayrollAdministrationId
A list of tax returns for an administration
payrollTaxReturn.patchPayrollTaxReturnsByPayrollTaxReturnIds

Activity name : PatchPayrollTaxReturnsByPayrollTaxReturnIds
This endpoints changes the status of the list of the payroll tax returns provided in the request body based on the provided action.
payrollTaxReturnByMessageReference.patchPayrollTaxReturnByMessageReference

Activity name : PatchPayrollTaxReturnByMessageReference
This endpoints changes the status of the payroll tax returns provided in the path parameters based on the provided action.
Functionally, this endpoint is very similar to PatchPayrollTaxReturnsByPayrollTaxReturnIds endpoint, however this endpoint takes the messageReference (NL: BERICHTKENMERK) as path id. Instead of payrollTaxReturnId (GUID). AND, in contrast, this endpoint is a SINGLE PATCH endpoint which consumes a path id.
payrollTaxReturnByMessageReference.postSendResponseMessageByMessageReference

Activity name : PostSendResponseMessageByMessageReference
This endpoint is identical to PostSendResponseMessageByPayrollTaxReturnId endpoint, however this endpoint takes the messageReference (NL: BERICHTKENMERK) as path id. Instead of payrollTaxReturnId (GUID).
payrollTaxReturnDownloads.getMessageByPayrollTaxReturnId

Activity name : GetMessageByPayrollTaxReturnId
Download the message of the payroll tax return (loonaangiftebericht) in xml. Please note that this does NOT refer to the response message, but to the initial message i.e. loonaangiftebericht.
payrollTaxReturnDownloads.getOverviewByPayrollTaxReturnId

Activity name : GetOverviewByPayrollTaxReturnId
Download the payroll tax return overiew
payrollTaxReturnDownloads.getSepaFileByPayrollAdministrationIdAndPayrollTaxReturnId

Activity name : GetSepaFileByPayrollAdministrationIdAndPayrollTaxReturnId
Get the Sepa file for the payroll tax return
payrollTaxReturnResponseMessage.postSendResponseMessageByPayrollTaxReturnId
Activity name : PostSendResponseMessageByPayrollTaxReturnId
Send the response message of the payroll tax return (loonaangifte) that was received from the Belastingdienst, to Loket.nl . This is ONLY applicable for the limited group of parties that send and receive the payroll tax return themselves to the Belastingdienst. For the purposes of having those results visible in Loket the corresponding response message can be send to Loket via this endpoint.
What this endpoint does is the following:
- It will receive the xml response message. For the schema (XSD) of this xml response message we refer to the documentation by the Belastingdienst itself
- A set of input validations will be performed.
- If those steps are succesful the xml response message will placed in a designated directory. Where it will be picked up for final processing by a proces that runs about every 15 minutes
- In other words; the result of this action will NOT be immediately visible
payslip.getPayrollPeriodResultsByEmploymentIdAndYear
Activity name : GetPayrollPeriodResultsByEmploymentIdAndYear
Download the payroll results (conform overzicht strook) of an employment per payroll period for the provided year.
Please note the following: There is a major functional difference between acquiring the payslips per payroll run or acquiring payroll results per payroll period(in this case a year). In Loket, for each (approved) run there will be payroll results for that run. Each employment with any results in that payroll run will have (one or more) payslips, these are the payroll results/ payslips for that run. Often these results relate to the payroll period for which that payroll run is performed, but the results may apply to other payroll periods. For example: the payroll run for March may contain results that apply to the months January and/or February. (this may occur within a specific year)
- Requesting payslips/results per RUN will provide you all payroll results from that specific payrollrun regardless of the period it applies to.
- Requesting PERIOD results will provide you all (approved) payroll results for that period regardless of the payroll run it comes from.
De facto the payslips/results per RUN are your actual payslips (loonstrook). The results per period are more useful as an overview per period (overzichtstrook).
One more remark: the response of this endpoint is dependent on the role of the user. If the user has role 'werknemer' than the results shown are only based on those approved payroll runs where the ESS-date is on or before today. For other users the results will contain data from all approved payroll runs regardless of ESS-date.
payslip.getPayrollPeriodSummaryByEmploymentIdAndPayrollPeriodId
Activity name : GetPayrollPeriodSummaryByEmploymentIdAndPayrollPeriodId
Download a cummulative payslip for a single payroll period in a single PDF.
e.g. If the employment has to payslips for a single period this endpoint will return one (summary)payslip that is the cummaltion of both the payslips.
Metadata : Possible options for payrollPeriodId can be acquired (GET) the following URL /providers/employers/employees/employments/{employmentId}/payslips/summary/metadata. Please note that the returned payroll periods are dependend on the year filter setting for the employer. The options are, return payroll periodes for:
- current payroll year * current and previous payroll year * all payroll years
payslip.getPayslipsByEmploymentId
Activity name : GetPayslipsByEmploymentId
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.
payslip.getPayslipsByEmploymentIdAndPayrollRunId
Activity name : GetPayslipsByEmploymentIdAndPayrollRunId
Download the payslips or its underlying payroll results of an employment for the specified payrollrun
Please note: this endpoint has two types of output:
- the payslip(s) as a single PDF-file
- the underlying payroll result data for the payslip(s) in JSON-format
This may be specified by providing the desired format in the Accept header of your request.
payslip.getPayslipsByEmploymentIdAndYear

Activity name : GetPayslipsByEmploymentIdAndYear
Download the payslips for a payroll year in a single PDF
Metadata : Possible options for year can be acquired (GET) the following URL /providers/employers/employees/employments/{employmentId}/payslips/metadata.
payslip.getWageSheetByEmploymentIdAndYear

Activity name : GetWageSheetByEmploymentIdAndYear
Download the wagesheet (loonstaat) for a payroll year
Metadata : Possible options for year can be acquired (GET) the following URL /providers/employers/employees/employments/{employmentId}/wagesheet/metadata.
Returns the wage sheets for an employment
pensionBenefit.deletePensionBenefitByPensionBenefitId

Activity name : DeletePensionBenefitByPensionBenefitId
Delete an existing pension benefit record
pensionBenefit.getPensionBenefitByPensionBenefitId

Activity name : GetPensionBenefitByPensionBenefitId
Get the details of a pension benefit
pensionBenefit.getPensionBenefitsByEmploymentId

Activity name : GetPensionBenefitsByEmploymentId
Get a list of the pension benefits of the employment.
Note: Loket.nl has different ways to register pension benefit.
pensionBenefit.postPensionBenefitByEmploymentId

Activity name : PostPensionBenefitByEmploymentId
Metadata : No metadata
Defaults : No default values
pensionBenefit.putPensionBenefitByPensionBenefitId

Activity name : PutPensionBenefitByPensionBenefitId
Metadata : No metadata
periodReadyForPayroll.postPeriodReadyForPayrollByPayrollAdministrationId

Activity name : PostPeriodReadyForPayrollByPayrollAdministrationId
Send an email to inform that the period is ready for payrolling.
preboardingTrajectory.patchPreboardingTrajectoryByConceptEmployeeId

Activity name : PatchPreboardingTrajectoryByConceptEmployeeId
preboardingTrajectory.postPreboardingTrajectoryByConceptEmployeeId

Activity name : PostPreboardingTrajectoryByConceptEmployeeId
proforma.getProformaStatusByEmployerId

Activity name : GetProformaStatusByEmployerId
Get the status of proforma for this employer
proforma.postInitializeProformaByEmployerId

Activity name: PostInitializeProformaByEmployerId
Initialize a proforma environment (request the copying of data from live to proforma).
Metadata : None
Defaults : None
protectedEarnings.deleteProtectedEarningsByProtectedEarningsId

Activity name : DeleteProtectedEarningsByProtectedEarningsId
Delete an existing protected earnings record
protectedEarnings.getProtectedEarningsByEmploymentId

Activity name : GetProtectedEarningsByEmploymentId
Get a list of protected earnings records
protectedEarnings.getProtectedEarningsByProtectedEarningsId

Activity name : GetProtectedEarningsByProtectedEarningsId
Get the details of an protected earnings record
protectedEarnings.postProtectedEarningsByEmploymentId

Activity name : PostProtectedEarningsByEmploymentId
Create a new protected earnings record for an employment.
Metadata : There is no metadata for this resource
Defaults : Default values for a new object can be acquired by adding /defaults' to the POST URL.
protectedEarnings.putProtectedEarningsByProtectedEarningsId

Activity name : PutProtectedEarningsByProtectedEarningsId
Update the details of a single protected earnings record
Metadata : There is no metadata for this resource
provider.getProviderLogo

Activity name : GetProviderLogo
This activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour.
Caching: This resource changes very infrequently and can be cached for a longer time.
Get the logo of the provider of the user. In case no logo is know the service will return a 404.
provider.getProviderLogoByVersion

Activity name : GetProviderLogo
This activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour.
Caching: This resource changes very infrequently and can be cached for a longer time.
Get the logo of the provider of the user. In case no logo is know the service will return a 404.
provider.getProvidersByUser

Activity name : GetProvidersByUser
Get a list of all providers accessible to the current user. Note: With the current functioning of Loket, the list will always contain 1 provider.
Note: This endpoint is typically not relevant for most external parties, as the GetEmployerByUser endpoint will be much more relevant as starting point.
providerLeavePolicy.getProviderAgeBasedLeaveByLeavePolicyId

Activity name : GetProviderAgeBasedLeaveByLeavePolicyId

Returns the age based leave for the given leave policy at provider level.
providerLeavePolicy.getProviderLeavePoliciesByProviderId

Activity name : GetProviderLeavePoliciesByProviderId

Returns all the leave policies for the given provider. These leave policies can be used to define a leave policy at employer level.
providerLeavePolicy.getProviderLeavePolicyByLeavePolicyId

Activity name : GetProviderLeavePolicyByLeavePolicyId
Returns one leave policy
providerLeavePolicy.getProviderWageBasedLeaveByLeavePolicyId

Activity name : GetProviderWageBasedLeaveByLeavePolicyId

Returns the wage based leave for the given leave policy at provider level.
providerLeavePolicy.getProviderYearsOfServiceBasedLeaveByLeavePolicyId

Activity name : GetProviderYearsOfServiceBasedLeaveByLeavePolicyId

Returns the years of service based leave for the given leave policy at providerlevel.
qwoater.getQwoaterEmployersByUser
Activity name : GetQwoaterEmployersByUser
Returns a list of employerIds that have at least one Qwoater product enabled with the corresponding providerId and lastModifiedVersionNumber for the employer.
What does the 'last modified' version number reflect
The sequence number of an employer is a sequential number that reflects whether any changes have occurred in any of its UNDERLYING employments.
More precisely, it reflects the sequence number after the latest change of any database record that relates to an employment within this employer. What we consider to be 'underlying' employment data is based on a predefined set of tables, and of course given id. This predefined set of tables can be found
The scope of this predefined set is to represent 'static' employment data (vaste gegevens), and thus excludes payroll period data (variabele gegevens).
When to use
This endpoint is most useful for integrations that regularly synchronize Loket employment data with another system. As there are no webhooks available, in practice these integrations would need to regularly poll all data to see whether there any changes in the employment data. The most elementary approach of getting all employment data every time you sync acquires a LOT of calls, in some cases even millions per day. Even though we can handle quite a lot, this is not always the desired way for both client and server. Hence, this endpoint enables an alternative solution to set up such an integration.
How to use
With every update (including additions and deletions) the version number will increase. I.e. the version number will NEVER decrease over time. (Please note this is not only true within the context of a single employer (or any other entity) but applies to all changes in the database). Consequently, in practice one would use this endpoint to check if any empLoyer version numbers have increased by applying the filter query parameter to the version field, for example ?filter=lastModifiedVersionNumber gt 70429274.
Recommended usage
- Perform your regular synchronization of static employment data
- Store the highest version number, for which you have now processed all changes. (You may use the following parameter to do this ?orderBy=-lastModifiedVersionNumber )
- Next time you want to perform synchronization. Call this endpoint with parameter ?filter=lastModifiedVersionNumber gt {{YourVersionNumber}}
- Only get employment information for employers that are included in that filtered list. (exclude all other employers as you already know there have been no changes since the last synchronization)
reviewPayrollRun.patchPayrollrunsByPayrollRunIds
Activity name : PatchPayrollrunsByPayrollRunIds
This action may only be performed succesfully of the following requirements are met;
- The payroll run is ready for approval (status 1)
Update the status of one or more payrollruns
signDocument.deleteSignatureByConceptEmployeeIdAndDocumentId

Activity name : DeleteSignatureByConceptEmployeeIdAndDocumentId
Metadata: No metadata available.
Delete the proces to sign a document for an Conceptemployee.
signDocument.deleteSignatureByEmploymentIdAndDocumentId

Activity name : DeleteSignatureByEmploymentIdAndDocumentId
Metadata: No metadata available.
Delete the proces to sign a document for an employment.
signDocument.getSignatureByConceptEmployeeIdAndDocumentId

Activity name : GetSignatureByConceptEmployeeIdAndDocumentId
Metadata: No metadata available.
Retrieve the status of the signing.
signDocument.getSignatureByEmploymentIdAndDocumentId

Activity name : GetSignatureByEmploymentIdAndDocumentId
Metadata: No metadata available.
Retrieve the status of the signing.
signDocument.getSignatureReportByConceptEmployeeIdAndDocumentId

Activity name : GetSignatureReportByConceptEmployeeIdAndDocumentId
Metadata: No metadata available.
Report of the signature.
signDocument.getSignatureReportByEmploymentIdAndDocumentId

Activity name : GetSignatureReportByEmploymentIdAndDocumentId
Metadata: No metadata available.
Report of the signature.
signDocument.postInitiateSignatureByConceptEmployeeIdAndDocumentId

Activity name : PostInitiateSignatureByConceptEmployeeIdAndDocumentId
Metadata: No metadata available. Defaults are available by adding /defaults to the path.
Initiate the proces to sign a document for an employment by one or more signers.
signDocument.postInitiateSignatureByEmploymentIdAndDocumentId

Activity name : PostInitiateSignatureByEmploymentIdAndDocumentId
Metadata: No metadata available. Defaults are available by adding /defaults to the path.
Initiate the proces to sign a document for an employment by one or more signers.
socialSecurity.deleteSocialSecurityConfigurationBySocialSecurityConfigurationId

Activity name: DeleteSocialSecurityConfigurationBySocialSecurityConfigurationId
Delete a social security record for the employment
socialSecurity.getSocialSecurityConfigurationByEmploymentId

Activity name: GetSocialSecurityConfigurationsByEmploymentId
Get the list of social security configuration records for an employment
socialSecurity.getSocialSecurityConfigurationBySocialSecurityConfigurationId

Activity name: GetSocialSecurityConfigurationBySocialSecurityConfigurationId
Get the details of a social security configuration record
socialSecurity.postSocialSecurityConfigurationByEmploymentId

Activity name: PostSocialSecurityConfigurationByEmploymentId
Create a social security configuration record for an employment
Defaults : Default values for a new object can be acquired by adding /defaults' to the POST URL.
socialSecurity.putSocialSecurityConfigurationBySocialSecurityConfigurationId

Activity name: PutSocialSecurityConfigurationBySocialSecurityConfigurationId
Edit the details for a social security record
socialSecurityBenefits.deleteSocialSecurityBenefitBySocialSecurityBenefitId

Activity name: DeleteSocialSecurityBenefitBySocialSecurityBenefitId
Delete a social security record for the employment
socialSecurityBenefits.getSocialSecurityBenefitByEmploymentId

Activity name: GetSocialSecurityBenefitsByEmploymentId
Get the list of social security benefits records for an employment
socialSecurityBenefits.getSocialSecurityBenefitBySocialSecurityBenefitId

Activity name: GetSocialSecurityBenefitBySocialSecurityBenefitId
Get the details of a social security benefits record
socialSecurityBenefits.postSocialSecurityBenefitByEmploymentId

Activity name: PostSocialSecurityBenefitByEmploymentId
Create a social security benefits record for an employment Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
Defaults : Default values for a new object can be acquired by adding /defaults' to the POST URL.
socialSecurityBenefits.putSocialSecurityBenefitBySocialSecurityBenefitId

Activity name: PutSocialSecurityBenefitBySocialSecurityBenefitId Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL.
Edit the details for a social security record
transitionCompensation.getCalculateTransitionCompensationDefaultsByEmploymentId

Activity name : GetCalculateTransitionCompensationDefaultsByEmploymentId
Get the default values of the input parameters for the POST action.
transitionCompensation.postCalculateTransitionCompensationByEmploymentId

This is a controller endpoint to perform a calculation. No actual data will be stored as a result of these actions.
Activity name : PostCalculateTransitionCompensationByEmploymentId
Defaults : Default values for a new object can be acquired by adding /defaults to the POST URL. This will only include the default values for the input parameter fields (the actual calculation of the transition compensation is not part of that)
A calculation help for determining the transition compensation amount. (rekenhulp transitievergoeding)
undoPayrollRun.undoPayrollRunByPayrollRunId
Activity name : UndoPayrollRunByPayrollRunId This is a controller endpoint to perform an action.
In the older Loket GUI this specific action is referred to as 'Verwijderen loonrun' If this action is performed succesfully then the payroll run will be 'deleted' in the sense that its results will be undone. Please note that situations where an approved payroll run would have to be 'undone' should be generally be avoided. Preferably any mistakes or consistencies should be picked out at an earlier stage in the payroll process.
This action may only be performed succesfully of the following requirements are met;
- The payroll run is the very last payroll run that has been approved within this payroll administration
- It is not possible to undo a payroll run if there is currently a payroll run with status 0 (to be processed) or 1 (awaiting approval) within the payroll administation.
- Additionally, no related (external) information should still be present for the given payroll run. This will be validated by the endpoint.
Metadata : No metadata endpoint available for this controller endpoint.
Defaults : No defaults endpoint available for this controller endpoint.
upaPensionDeclaration.getMessageByUpaPensionDeclarationId

Activity name : GetMessageByUpaPensionDeclarationId
Download the message of the UPA pension declaration (pensioenaangiftebericht) in xml. Please note that this does NOT refer to the response message, but to the initial message i.e. pensioenaangiftebericht.
upaPensionDeclaration.getUpaPensionDeclarationByUpaPensionDeclarationId

Activity name : GetUpaPensionDeclarationByUpaPensionDeclarationId
Details of UPA pension declaration
upaPensionDeclaration.getUpaPensionDeclarationsByPayrollAdministrationId

Activity name : GetUpaPensionDeclarationsByPayrollAdministrationId
A list of UPA pension declarations for an administration
upaPensionDeclaration.patchUpaPensionDeclarationByUpaPensionDeclarationId

Activity name : PatchUpaPensionDeclarationByUpaPensionDeclarationId
This endpoints changes the status of the Upa pensiondeclaration based on the provided action.
upaPensionDeclaration.postInitiateUpaPensionDeclarationByPayrollAdministrationId

Activity name : PostInitiateUpaPensionDeclarationByPayrollAdministrationId
Initiate the pension declaration for the next available period for the payrolladministration. Information about the next available periode can be obtained using the defaults endpoint (/defaults)
user.deleteEmployerUserIntegrationByUserIdAndApplicationId

Activity name: DeleteEmployerUserIntegrationByUserIdAndApplicationId
Delete an integration
user.deleteUserPhotoByToken

Activity name : DeleteUserPhotoByToken
Photo of the user to use as an avatar/profile picture
user.getEmployerUserIntegrationLogoByUserIdAndApplicationId

Activity name : GetEmployerUserIntegrationLogoByUserIdAndApplicationId
This activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour.
Caching: This resource changes very infrequently and can be cached for a longer time.
Get the logo of the application. In case no logo is know the service will return a 404.
user.getEmployerUserIntegrationsByUserId

Activity name: GetEmployerUserIntegrationsByUserId
List of all the integrations for the employer user
user.getIntegrationsByBearerToken

Activity name: GetIntegrationsByBearerToken
List of all the integrations for the logon user
user.getUserByToken

Activity name: GetUserByToken
Properties of the current user.
user.getUserPhotoByToken

Activity name : GetUserPhotoByToken
Photo of the user to use as an avatar/profile picture
Caching: This resource changes very infrequently and can be cached for a longer time.
user.postUserPhotoByToken

Activity name : PostUserPhotoByToken
Photo of the user to use as an avatar/profile picture
user.putEmployerUserIntegrationByIntegrationId

Activity name : PutEmployerUserIntegrationByUserIdAndApplicationId
Change the integration
user.putUserByToken

Activity name: PutUserByToken
Edit some of the properties of the current user. Metadata can be acquired by adding /metadata to the path.
userFilterSettings.getUserFilterSettingsByEmployerId

Activity name: GetUserFilterSettingsByEmployerId
The User Filter settings for the current user for the employer. These settings are used by the backend to automaticaly filter the list of employments.
userFilterSettings.putUserFilterSettingsByEmployerId

Activity name: PutUserFilterSettingsByEmployerId
Edit the filter settings for the current user for the employer.
Metadata can be acquired by adding /metadata to the path.
wachtgeld.deleteWachtgeldByWachtgeldId

Activity name : DeleteWachtgeldByWachtgeldId
Delete an existing wachtgeld record
wachtgeld.getWachtgeldByEmploymentId

Activity name : GetWachtgeldByEmploymentId
Get a list of wachtgeld of the employment.
Note: Wachtgeld, or redundancy pay, is an additional benefit that you receive on top of your unemployment benefit.
wachtgeld.getWachtgeldByWachtgeldId

Activity name : GetWachtgeldByWachtgeldId
Get the details of a wachtgeld record
wachtgeld.postWachtgeldByEmploymentId

Activity name : PostWachtgeldByEmploymentId Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata to the POST URL. Defaults: Default values for a new object can be acquired by adding /defaults' to the POST URL.
wachtgeld.putWachtgeldByWachtgeldId

Activity name : PutWachtgeldByWachtgeldId
Metadata : No metadata.
wage.deleteWageByWageId

Activity name : DeleteWageByWageId
Delete a wage record for the employment
wage.getWageByWageId

Activity name : GetWageByWageId
Get the details of a single wage
wage.getWagesByEmploymentId

Activity name : GetWagesByEmploymentId
Get the list of wages for the employment
wage.postWageByEmploymentId

Activity name : PostWageByEmploymentId
Create a new wage record for the given employment
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST Wage URL.
The possible options for payGrade are scoped by a payScale. To obtain the pay grades for a pay scale a metadata call has to be performed with the following format ../wages/metadata/payscale/{key}. Where {key} is the key of the payScale (obtained via the first metadata call) for which the pay grades are to be returned.
Defaults : Default values for a new object can be acquired by adding /defaults' to the POST URL and performing a GET action.
wage.putWageByWageId

Activity name : PutWageByWageId
Edit the details of a wage
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT wage URL.
The possible options for payGrade are scoped by a payScale. To obtain the pay grades for a pay scale a metadata call has to be performed with the following format ../wages/metadata/payscale/{key}. Where {key} is the key of the payScale (obtained via the first metadata call) for which the pay grades are to be returned.
wageProjection.getClaDataForWageProjectionByCollectiveLaborAgreementId

Activity name : GetClaDataForWageProjectionByCollectiveLaborAgreementId
Get de configuration of a specific Collective labor agreement. This configuration (data) can then be used (as input) to perform a wage calculation or wage projection with.
wageProjection.getCollectiveLaborAgreementsByUserId

Activity name : GetCollectiveLaborAgreementsByUserId
Get a list of all collective labor agreements (CLA) accessible to the current user
wageProjection.postWageprojectionBasedOnDefaultClaConfigurationByEmploymentId

Activity name : PostWageprojectionBasedOnDefaultClaConfigurationByEmploymentId
This endpoint can be used to calculate a wage projection based on a default collective labor agreement (CLA) configuration. The input fields allow for certain customizations.
Metadata : No metadata endpoint available for this controller endpoint.
Defaults : No defaults endpoint available for this controller endpoint.
wageProjection.postWageProjectionByEmploymentId

Activity name : PostWageProjectionByEmploymentId
This endpoint can only be used for employments that are already known in the loket.nl system.
Metadata : No metadata endpoint available for this controller endpoint.
Defaults : No defaults endpoint available for this controller endpoint.
wageProposal.getWageProposalsByEmployerId

Activity name : GetWageProposalsByEmployerId
Returns a list of wage proposals for the employments of the employer. A wage proposal is created when an employment reaches the criteria set for the next tier of wage. E.G the minimum wage is linked to the age of a person so a wage proposal is created 60 days befor the birthday of an employment linked to the minimum wage and configured for wage proposals. Via this functionality the created wage proposal can be approved or rejected resulting in either a new wage record updated to reflect the correct wage or in case of a rejection the employment is disabled for wage proposals.
wageProposal.patchWageProposalsByWageProposalId

Activity name : PatchWageProposalsByWageProposalId
Accept or reject wage proposals
workflows.getAssignedWorkflowsByEmployerId

Activity name: GetAssignedWorkflowsByEmployerId
Get the list workflows that are assigned to the user or the role of the user.
workflows.getInitiatedWorkflowsByBearerToken

Activity name: GetInitiatedWorkflowsByBearerToken
Get the workflows that are initiated by the user.
workflows.getWorkflowByWorkflowId

Activity name: GetWorkflowByWorkflowId
Get the details of a workflow
workflows.getWorkflowsByEmployerId

Activity name: GetWorkflowsByEmployerId
Get the list of all workflows for an employer. All as in both open as finished workflows are returned.
workflows.putWorkflowByWorkflowId

Activity name: PutWorkflowByWorkflowId
Allows the user to change certain asspects of the workflow
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
workflows.transitionWorkflowByWorkflowId

Activity name: TransitionWorkflowByWorkflowId
Allows the user to transition the workflow to a different state. Use the workflows endpoint and then the allowedTransitions element to determine what to submit to this endpoint.
workflowTriggerMapping.deleteFiscalPropertiesByworkflowTriggerId

Activity name: DeleteWorkflowTriggerMappingByWorkflowTriggerMappingId
Delete a workflow trigger mapping record for the employer
workflowTriggerMapping.getWorkflowTriggerMappingByWorkflowTriggerMappingId

Activity name: GetWorkflowTriggerMappingByWorkflowTriggerMappingId
Get the details of a workflow trigger mapping
workflowTriggerMapping.getWorkflowTriggerMappingsByEmployerId

Activity name: GetWorkflowTriggerMappingsByEmployerId
Get the list workflow triggers that are mapped to a workflowTemplate. Workflow triggers are triggers that trigger a workflow. With this resource one can manage which trigger will trigger what workflow.
workflowTriggerMapping.postWorkflowTriggerMappingByEmployerId

Activity name: PostWorkflowTriggerMappingByEmployerId
Create a workflow trigger mapping record for an employer
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
workflowTriggerMapping.putWorkflowTriggerByWorkflowTriggerId

Activity name: PutWorkflowTriggerMappingByWorkflowTriggerMappingId
Edit the details for a workflow trigger mapping record
Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL.
workingHours.deleteWorkingHoursByWorkingHoursId

Activity name : DeleteWorkingHoursByWorkingHoursId

Delete an existing working hours record (for an employment)
workingHours.getWorkingHoursByEmploymentId

Activity name : GetWorkingHoursByEmploymentId

Get the list of working hours for an employment
workingHours.getWorkingHoursByWorkingHoursId

Activity name : GetWorkingHoursByWorkingHoursId

Get the details of a working hours record
workingHours.postWorkingHoursByEmploymentId

Activity name : PostWorkingHoursByEmploymentId

Create a new working hours record for an employment
Please note that so-called chain validation exists for working hours records. In other words, the time periods of records for an employment cannot overlap with each other.
A new or changed startDate affects the endDate of its preceding record.
When POST-ing a new record, the startDate must be greater then the preceding record's startDate.
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.
Defaults : Default values for a new object can be acquired by adding /defaults' to the POST URL.
workingHours.putWorkingHoursByWorkingHoursId

Activity name : PutWorkingHoursByWorkingHoursId

Create a new working hours record for an employment
Please note that so-called chain validation exists for working hours records. In other words, the time periods of records for an employment cannot overlap with each other.
A new or changed startDate affects the endDate of its preceding record.
When PUT-ing a new record, the startDate must be greater then the preceding record's startDate.
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL.
yearEndStatement.getYearEndStatementForYearByEmploymentId

Activity name : GetYearEndStatementForYearByEmploymentId
Download the year-end statement of an employment for a year.
yearEndStatement.getYearEndStatementsByEmploymentId

Activity name : GetYearEndStatementsByEmploymentId
Get a list of year-end statements (i.e. list of years for which year-end statements are available) for an employment
yearEndStatementAtAdministrationLevel.getYearEndStatementForYearByPayrollAdministrationId

Activity name : GetYearEndStatementForYearByPayrollAdministrationId
Download the year-end statements of a payroll administration (of its underlying employment) for a year.
The year-end statements at administration level are effectively a collection of year-end statements for its underlying employments. With this endpoint it may also be required at the administration level in one call.
Please note: this endpoint may only be used to acquire a report in the pdf-type format
yearEndStatementAtAdministrationLevel.getYearEndStatementsByPayrollAdministrationId

Activity name : GetYearEndStatementsByPayrollAdministrationId
Get a list of year-end statements (i.e. list of years for which year-end statements are available) for a payrolladministration.
The year-end statements at administration level are effectively a collection of year-end statements for its underlying employments. However it may also be required at the administration level in one call.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools