Loket

Loket.nl API

Is this your first time here? Please check out our [introduction to Loket (API)](./Introduction) The initial loading time of this developer portal may be very…

Other#openapi#enterprise

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Is this your first time here? Please check out our introduction to Loket (API)

**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 website .

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.

[](https://god.gw.postman.com/run-collection/19604713-42728000-2df3-4ff0-908e-dc6ab410990c?action=collection%2Ffork&collection-url=entityId%3D19604713-42728000-2df3-4ff0-908e-dc6ab410990c%26entityType%3Dcollection%26workspaceId%3Ddde2c409-9fb2-4f40-9981-f937f73750ea#?env%5BLoket.nl%20Test%20Environment%5D=W3sia2V5IjoiQXV0aGVudGljYXRpb25TZXJ2ZXJVcmwiLCJ2YWx1ZSI6Imh0dHBzOi8vb2F1dGgubG9rZXQtYWNjLm5sLyIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJ0ZXh0Iiwic2Vzc2lvblZhbHVlIjoiaHR0cHM6Ly9vYXV0aC5sb2tldC1hY2MubmwvIiwic2Vzc2lvbkluZGV4IjowfSx7ImtleSI6Ikxva2V0QXBpVXJsIiwidmFsdWUiOiJodHRwczovL2FwaS5sb2tldC1hY2MubmwvIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6InRleHQiLCJzZXNzaW9uVmFsdWUiOiJodHRwczovL2FwaS5sb2tldC1hY2MubmwvIiwic2Vzc2lvbkluZGV4IjoxfSx7ImtleSI6IkNsaWVudF9JZCIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6InRleHQiLCJzZXNzaW9uVmFsdWUiOiIiLCJzZXNzaW9uSW5kZXgiOjJ9LHsia2V5IjoiQ2xpZW50X1NlY3JldCIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6InRleHQiLCJzZXNzaW9uVmFsdWUiOiIiLCJzZXNzaW9uSW5kZXgiOjN9LHsia2V5IjoiUmVkaXJlY3RfVXJpIiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoidGV4dCIsInNlc3Npb25WYWx1ZSI6IiIsInNlc3Npb25JbmRleCI6NH0seyJrZXkiOiJyZWZyZXNoX3Rva2VuIiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoidGV4dCIsInNlc3Npb25WYWx1ZSI6IiIsInNlc3Npb25JbmRleCI6NX0seyJrZXkiOiJ0b2tlbiIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6InRleHQiLCJzZXNzaW9uVmFsdWUiOiIiLCJzZXNzaW9uSW5kZXgiOjZ9XQ==)

Do you want to contact us with any further questions or remarks regarding the Loket RESTful API? Please send an email to api@loket.nl, 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 https://api.loket-acc.nl/v2/
  • The production environment can be accessed at https://api.loket.nl/v2/

OpenAPI documentation

The endpoints are defined using the OpenAPI 3.0 specification,
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 changeNotification periodSupport period old version
Non breaking change2 weeksno new version
Breaking change2 weeks6 months
CriticalDue to the nature of these changes we might not be able to follow the normal procedure for change managmentdepends 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…

Endpoints 400

Absence

  • GETDetails of an Absence/providers/employers/employees/absences/:absenceId__Activity name :__ GetAbsenceByAbsenceId Get the details of an Absence
  • PUTEdit the details of a Absence/providers/employers/employees/absences/:absenceId__Activity name :__ PutAbsenceByAbsenceId __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the…
  • DELETEDelete a specific absence record/providers/employers/employees/absences/:absenceId__Activity name :__ DeleteAbsenceByAbsenceId Delete an existing absence (for an employee). If succesfull, this function also deletes the underlying absence…
  • PATCHClose an absence/providers/employers/employees/absences/:absenceId/closeabsence__Activity name :__ PatchCloseAbsenceByAbsenceId A succesfull call to this endpoint will close the absence and the underlying absence progress (with an empty…
  • PATCHReopen an absence/providers/employers/employees/absences/:absenceId/reopenabsence__Activity name :__ PatchReopenAbsenceByAbsenceId When performing a succesfull call to this endpoint, then the absence and the underlying absence progress…
  • GETList of absences for an employee/providers/employers/employees/:employeeId/absences?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetAbsencesByEmployeeId Get a list of all absences for the given employee
  • POSTCreate an Absence for an employee/providers/employers/employees/:employeeId/absences__Activity name :__ PostAbsenceByEmployeeId __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the…
  • GETDownload the absence overview for an employee/providers/employers/employees/:employeeId/absences/overview?startDate=2020-08-01&endDate=2020-08-31__Activity name :__ GetAbsenceOverviewByEmployeeId Download the absence overview (verzuim) for a given time frame __Metadata :__ No metadata

Absence Progress

  • GETDetails of an Absence Progress/providers/employers/employees/absences/absenceprogress/:absenceProgressId__Activity name :__ GetAbsenceProgressByAbsenceProgressId Get the details of an Absence Progress
  • PUTEdit the details of an absence progress/providers/employers/employees/absences/absenceprogress/:absenceProgressId__Activity name :__ PutAbsenceProgressByAbsenceProgressId __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding…
  • DELETEDelete a specific Absence Progress record/providers/employers/employees/absences/absenceprogress/:absenceProgressId__Activity name :__ DeleteAbsenceProgressByAbsenceProgressId Delete an existing Absence Progress (for an employee). There always has to remain one record of…
  • GETList of absence progress for an absence/providers/employers/employees/absences/:absenceId/absenceprogress?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetAbsenceProgressByAbsenceId Get a list of absence progress (verzuimverloop) for a specific absence (verzuimmelding).
  • POSTCreate an Absence Progress for an Absence/providers/employers/employees/absences/:absenceId/absenceprogress__Activity name :__ PostAbsenceProgressByAbsenceId __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata…

Contact history

  • GETDetails of a contact history/providers/employers/employees/absences/absencecontactHistory/:absencecontactHistoryId__Activity name :__ GetAbsenceContactHistoryByAbsenceContactHistoryId Get the details of a contact
  • PUTEdit the details of a contact history/providers/employers/employees/absences/absencecontactHistory/:absencecontactHistoryId__Activity name :__ PutAbsenceContactHistoryByAbsenceContactHistoryId __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET)…
  • DELETEDelete a specific record/providers/employers/employees/absences/absencecontactHistory/:absencecontactHistoryId__Activity name :__ DeleteAbsenceContactHistoryByAbsenceContactHistoryId Delete an existing record from the contact history
  • GETContact history for an absence/providers/employers/employees/absences/:absenceId/absencecontactHistory?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetAbsenceContactHistoryByAbsenceId Get the contacts history for a specific absence (verzuimmelding).
  • POSTCreate a contact history for an Absence/providers/employers/employees/absences/:absenceId/absencecontactHistory__Activity name :__ PostAbsenceContactHistoryByAbsenceId __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding…

Leave

  • GETA single leave entry/providers/employers/employees/employments/leave/:leaveId?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetLeaveByLeaveId Returns one leave entry (either addition or subtraction).
  • PUTEdit the details of a leave/providers/employers/employees/employments/leave/:leaveId__Activity name :__ PutLeaveByLeaveId Edit the details of a leave
  • DELETEDelete a specific leave record/providers/employers/employees/employments/leave/:leaveId__Activity name :__ DeleteLeaveByLeaveId Delete an existing Leave record
  • GETGet the values for the metadata fields/providers/employers/employees/employments/leave/:leaveId/metadata?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetLeaveMetadataByLeaveId Returns the metadata values for all the metadata fields.
  • GETList of all the leave entries/providers/employers/employees/employments/:employmentId/leave?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetLeaveByEmploymentId <br/> <br/> Returns all the leave entries (both addition and subtraction) for the given employment.
  • POSTCreate a leave record for an employment/providers/employers/employees/employments/:employmentId/leave__Activity name :__ PostLeaveByEmploymentId Add a Leave record for an employment
  • GETGet the default values to be used when POSTing a new record/providers/employers/employees/employments/:employmentId/leave/defaults?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetLeaveDefaultsByEmploymentId Returns the default values for all the fields. In case no default is present null will be returned.
  • GETGet the values for the metadata fields/providers/employers/employees/employments/:employmentId/leave/metadata?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetLeaveMetadataByEmploymentId Returns the metadata values for all the metadata fields.
  • GETDownload the leave overview for an employment and year/providers/employers/employees/employments/:employmentId/leave/overview/:year__Activity name :__ GetLeaveOverviewByEmploymentIdandYear Download the leave overview for a year in a single PDF __Metadata :__ Possible options for year can…
  • GETGet the proposed number of leave hours for an employment/providers/employers/employees/employments/:employmentId/leave/proposedleavehours?startDate=2022-08-01&endDate=2022-08-07&filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetProposedLeaveHoursByEmploymentId Returns the numberOfHours (only in hours) calculated based on the employments working- hours/schedual…
  • GETGet the proposed number of leave hours for all employments of an employer/providers/employers/:employerId/leave/proposedleavehours?startDate=2022-08-01&endDate=2022-08-07&filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetProposedLeaveHoursByEmployerId Returns the numberOfHours (only in hours) calculated based on the employments working- hours/schedual…

Leave request

  • PATCHChange the status of leave requests/providers/employers/employees/employments/leaverequests__Activity name :__ PatchLeaveRequestsByLeaveRequestIds This endpoints changes the status of the list of leave requests provided in the request body to the…
  • GETDetails of a leave request/providers/employers/employees/employments/leaverequests/:leaveRequestId?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetLeaveRequestByLeaveRequestId Get the details of a single leave request
  • PUTChange the details of a leave request/providers/employers/employees/employments/leaverequests/:leaveRequestId__Activity name :__ PutLeaveRequestByLeaveRequestId Change the details of a Leave request __Important:__ A PUT is only allowed when the leave requests is in…
  • GETleave requests by employment/providers/employers/employees/employments/:employmentId/leaverequests?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetLeaveRequestsByEmploymentId Get a list of all leave requests for the given employment
  • GETList of leave requests for the employees of an employer/providers/employers/:employerId/employees/employments/leaverequests?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetLeaveRequestsByEmployerId Returns a list of leave requests for the employments of the employer

Leave balance

  • GETList of yearly leave balances for each leave type./providers/employers/employees/employments/:employmentId/leavebalances?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetLeaveBalancesByEmploymentId <br/> <br/> Returns the yearly leave balances for each leave type.
  • GETThe leave balance for all employments/providers/employers/:employerId/leavebalances?referenceDate=2020-12-31&leaveType=1,15,99&filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetLeaveBalancesByEmployerId <br/> <br/> Returns the yearly leave balances for all employments
  • GETSummed up leave balance total and grouped by/providers/employers/:employerId/leavebalances/grouped?referenceDate=2020-12-31&leaveType=1,15,99&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20&groupBy=Department__Activity name :__ GetLeaveBalancesGroupedByEmployerId <br/> <br/> Returns the yearly leave balances total per leave type and total per groupBy

Leave policy

  • GETAn age based leave record/providers/employers/leavePolicies/agebasedleave/:ageBasedLeaveId?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetAgeBasedLeaveByAgeBasedLeaveId Returns one leave age based leave record
  • PUTEdit the details of an age based leave/providers/employers/leavePolicies/agebasedleave/:ageBasedLeaveId__Activity name :__ PutAgeBasedLeaveByAgeBasedLeaveId Edit the details of an age based leave record
  • DELETEDelete an age based leave record/providers/employers/leavePolicies/agebasedleave/:ageBasedLeaveId__Activity name :__ DeleteAgeBasedLeaveByAgeBasedLeaveId Delete an age based leave record
  • GETA wage based leave record/providers/employers/leavePolicies/wagebasedleave/:wageBasedLeaveId?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetWageBasedLeaveByAgeBasedLeaveId Returns one leave wage based leave record
  • PUTEdit the details of a wage based leave/providers/employers/leavePolicies/wagebasedleave/:wageBasedLeaveId__Activity name :__ PutWageBasedLeaveByWageBasedLeaveId Edit the details of a wage based leave record
  • DELETEDelete a wage based leave record/providers/employers/leavePolicies/wagebasedleave/:wageBasedLeaveId__Activity name :__ DeleteWageBasedLeaveByWageBasedLeaveId Delete a wage based leave record
  • GETA years of service based leave record/providers/employers/leavePolicies/yearsofservicebasedleave/:yearsOfServiceBasedLeaveId?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetYearsOfServiceBasedLeaveByYearsOfServiceBasedLeaveId Returns one leave years of service based leave record
  • PUTEdit the details of a years of service based leave/providers/employers/leavePolicies/yearsofservicebasedleave/:yearsOfServiceBasedLeaveId__Activity name :__ PutYearsOFServiceBasedLeaveByYearsOfServiceBasedLeaveId Edit the details of a years of service based leave record
  • DELETEDelete an years of service based leave record/providers/employers/leavePolicies/yearsofservicebasedleave/:yearsOfServiceBasedLeaveId__Activity name :__ DeleteYearsOfServiceBasedLeaveByYearsOfServiceBasedLeaveId Delete an years of service based leave record
  • GETA single leave policy/providers/employers/leavePolicies/:leavePolicyId?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetLeavePolicyByLeavePolicyId Returns one leave policy
  • PUTEdit the details of a leave policy/providers/employers/leavePolicies/:leavePolicyId__Activity name :__ PutLeavePolicyByLeavePolicyId Edit the details of a leave policy
  • DELETEDelete a leave policy/providers/employers/leavePolicies/:leavePolicyId__Activity name :__ DeleteLeavePolicyByLeavePolicyId Delete a Leave policy
  • GETAge based leave/providers/employers/leavePolicies/:leavePolicyId/agebasedleave?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetAgeBasedLeaveByLeavePolicyId <br/> <br/> Returns the age based leave for the given leave policy.
  • POSTCreate an age based leave record/providers/employers/leavePolicies/:leavePolicyId/agebasedleave__Activity name :__ PostAgeBasedLeaveByLeavePolicyId Add an age based leave
  • GETWage based leave/providers/employers/leavePolicies/:leavePolicyId/wagebasedleave?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetWageBasedLeaveByLeavePolicyId <br/> <br/> Returns the wage based leave for the given leave policy.
  • POSTCreate a wage based leave record/providers/employers/leavePolicies/:leavePolicyId/wagebasedleave__Activity name :__ PostWageBasedLeaveByLeavePolicyId Add a wage based leave
  • GETyears of service based leave/providers/employers/leavePolicies/:leavePolicyId/yearsofservicebasedleave?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetYearsOfServiceBasedLeaveByLeavePolicyId <br/> <br/> Returns the years of service based leave for the given leave policy.
  • POSTCreate a years of service based leave record/providers/employers/leavePolicies/:leavePolicyId/yearsofservicebasedleave__Activity name :__ PostYearsOfServiceBasedLeaveByLeavePolicyId Add a years of service based leave
  • GETList of all the leave policies/providers/employers/:employerId/leavePolicies?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetLeavePoliciesByEmployerId <br/> <br/> Returns all the leave policies for the given employer.
  • POSTCreate a leave policy/providers/employers/:employerId/leavePolicies__Activity name :__ PostLeavePolicyByEmployerId Add a leave policy
  • PATCHCreate a leave policy based on an existing leave policy/providers/employers/:employerId/leavePolicies__Activity name :__ PatchCopyLeavePolicyByEmployerId Add a leave policy based on an existing leave policy at providerlevel. (Create a copy)

Provider leave policy

  • GETA single leave policy/providers/leavePolicies/:leavePolicyId?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetProviderLeavePolicyByLeavePolicyId Returns one leave policy
  • GETAge based leave/providers/leavePolicies/:leavePolicyId/agebasedleave?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetProviderAgeBasedLeaveByLeavePolicyId <br/> <br/> Returns the age based leave for the given leave policy at provider level.
  • GETWage based leave/providers/leavePolicies/:leavePolicyId/wagebasedleave?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetProviderWageBasedLeaveByLeavePolicyId <br/> <br/> Returns the wage based leave for the given leave policy at provider level.
  • GETyears of service based leave/providers/leavePolicies/:leavePolicyId/yearsofservicebasedleave?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetProviderYearsOfServiceBasedLeaveByLeavePolicyId <br/> <br/> Returns the years of service based leave for the given leave policy at…
  • GETList of all the leave policies at provider level./providers/:providerId/leavePolicies?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetProviderLeavePoliciesByProviderId <br/> <br/> Returns all the leave policies for the given provider. These leave policies can be used…

Leave policy and employment links

  • GETGet list of linked leave policies for the employment/providers/employers/employees/employments/:employmentId/leavepolicies?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name:__ GetLeavePoliciesByEmploymentId Get the list of leave policies linked to the employment. If a leave policy and employment are linked, that…
  • PATCHLink or unlink leave policies for the employment/providers/employers/employees/employments/:employmentId/leavepolicies__Activity name:__ PatchLeavePoliciesByEmploymentId __Metadata :__ Possible options can be acquired (GET) by adding /metadata to the POST URL. This endpoint…
  • GETGet list of linked employments for the leave policy/providers/employers/leavepolicies/:leavePolicyId/employments?orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name:__ GetEmploymentsByLeavePolicyId Get the list of employments that are linked for this leave policy. When a leave policy and an employment are…
  • PATCHCreate or delete multiple linked employments for the leave policy/providers/employers/leavepolicies/:leavePolicyId/employments__Activity name:__ PatchEmploymentsByLeavePolicyId This endpoint enables the user to create or delete multiple 'linkages' with one call. This is mostly useful…

Collective leave

  • POSTPost leave for multiple employments./providers/employers/:employerId/leave__Activity name:__ PostCollectiveLeaveByEmployerId Post leave for a set of employments under an employer. __Metadata :__ There is no metadata endpoint for…

Administration

  • GETList of administrations for an employer/providers/employers/:employerId/administrations?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetAdministrationsByEmployerId Get a list of all administrations (both payroll and non-payroll) for an employer. This endpoint only…

Payroll administration

  • GETList of payroll administrations for an employer/providers/employers/:employerId/payrolladministrations?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetPayrollAdministrationsByEmployerId Get a list of all payroll administrations for an employer

Payroll administration process overview

  • GETProcess Information about a payroll on administration level/providers/employers/payrolladministrations/:payrollAdministrationId/payrollprocessoverview?payrollPeriodIdStart=202004&payrollPeriodIdEnd=202006__Activity name :__ GetPayrollProcessOverviewByPayrollAdministrationId Get an overview of the status and possible actions for the specified period, including…

Payroll administration reports

  • GETDownload accumulated basic journal results report/providers/employers/payrolladministrations/:payrollAdministrationId/accumulatedbasicjournalresultsreport?reportType=nonAggregated&groupingType=perPeriod&startPeriod=201901&endPeriod=201912__Activity name :__ GetAccumulatedBasicJournalResultsReportByPayrollAdministrationId Acquire accumulated basic journal results reports (cumulatief journaal…
  • GETDownload accumulations and balances reports/providers/employers/payrolladministrations/:payrollAdministrationId/accumulationsandbalancesreport?reportType=baseForCalculationBalancesAtStartOfYear&reportYear=2023&includeEmploymentsThatEndedBeforeStartOfTheYear=false__Activity name :__ GetAccumulationsAndBalancesReportByPayrollAdministrationId Acquire the reports for either accumulations or balances at the payroll…
  • GETDownload annual payroll tax return report/providers/employers/payrolladministrations/:payrollAdministrationId/annualpayrolltaxreturnreport?reportYear=2023__Activity name :__ GetAnnualPayrollTaxReturnReportByPayrollAdministrationId Acquire the annual payroll tax return report (jaaroverzicht loongaangiftestaat)…
  • GETDownload annual wage sheet report/providers/employers/payrolladministrations/:payrollAdministrationId/annualwagesheetreport?reportYear=2023&startPeriod=201901&endPeriod=201912__Activity name :__ GetAnnualWagesheetReportByPayrollAdministrationId Acquire the annual wage sheet report (verzamelloonstaat) on payroll administration…
  • GETDownload attachment of earnings report/providers/employers/payrolladministrations/:payrollAdministrationId/attachmentsofearningsreport?reportYear=2023__Activity name :__ GetAttachmentsOfEarningsReportByPayrollAdministrationId Download the attachment of earnings report for the administration
  • GETDownload WAB deviations report/providers/employers/payrolladministrations/:payrollAdministrationId/deviatingpremiumswab?reportYear=2023__Activity name :__ GetDeviatingPremiumsWabReportByPayrollAdministrationId The percentage deviation between the contract hours and the actual standard hours…
  • GETDownload payroll administration configuration report/providers/employers/payrolladministrations/:payrollAdministrationId/payrolladministrationsettingsreport?reportYear=2023__Activity name :__ GetPayrollAdministrationSettingsReportByPayrollAdministrationId Acquire the payroll administration configuration report (overzicht…

Payroll component set

  • GETAvailable payroll component sets/providers/employers/payrolladministrations/:payrollAdministrationId/availablepayrollcomponentsets__Activity name :__ GetAvailablePayrollComponentSetsByPayrollAdministrationId Get the available payroll components sets that are available at this level. A…

Calendar

  • GETList absences per employment (for calendar)/providers/employers/:employerId/employees/employments/calendar/absences?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20&startDate=2024-01-01&endDate=2024-01-01__Activity name :__ GetCalendarAbsencesByEmployerId For a calendar, this endpoint return the absence calendar items PER specific employment. This endpoint…
  • GETList available hours per employment (for calendar)/providers/employers/:employerId/employees/employments/calendar/availablehours?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20&startDate=2024-01-01&endDate=2024-01-01__Activity name :__ GetCalendarAvailableHoursByEmployerId For a calendar, this endpoint returns the availability of an employment expressed as a pattern for…
  • GETList leave per employment (for calendar)/providers/employers/:employerId/employees/employments/calendar/leave?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20&startDate=2024-01-01&endDate=2024-01-01__Activity name :__ GetCalendarLeaveByEmployerId This endpoint return the leave calendar items for each employment. Please note: this endpoint only will…
  • GETList leave requests per employment (for calendar)/providers/employers/:employerId/employees/employments/calendar/leaverequests?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20&startDate=2024-01-01&endDate=2024-01-01__Activity name :__ GetCalendarLeaveRequestsByEmployerId For a calendar, this endpoint return the leave requests calendar items PER specific employment.…

Employee

  • GETDetails of an employee/providers/employers/employees/:employeeId__Activity name :__ GetEmployeeByEmployeeId Get the details of a single employee
  • PUTEdit the details of an employee/providers/employers/employees/:employeeId__Activity name :__ PutEmployeeByEmployeeId Edit the employee details <br /> Possible values for fields of the type 'metadata' can be acquired (GET) by adding…
  • GETCitizen service number of an employee/providers/employers/employees/:employeeId/citizenservicenumber__Activity name :__ GetCitizenServiceNumberByEmployeeId Get the citizen service number of an employee. BSN is separately authorized in Loket and is therefore…
  • PUTUpdate the citizen service number of an employee/providers/employers/employees/:employeeId/citizenservicenumber__Activity name :__ PutCitizenServiceNumberByEmployeeId Update the citizen service number of an employee. BSN is separately authorized in Loket and is…
  • GETPhoto of an employee/providers/employers/employees/:employeeId/photo__Activity name :__ GetEmployeePhotoByEmployeeId Photo of the employee to use as an avatar/profile picture __Caching:__ This resource changes very…
  • POSTPost employee photo/providers/employers/employees/:employeeId/photo__Activity name :__ PostEmployeePhotoByEmployeeId Photo of the employee to use as an avatar/profile picture
  • DELETEDelete employee photo/providers/employers/employees/:employeeId/photo__Activity name :__ DeleteEmployeePhotoByEmployeeId Photo of the employee to use as an avatar/profile picture
  • GETPhoto of an employee/providers/employers/employees/:employeeId/photo/:version__Activity name :__ GetEmployeePhotoByEmployeeIdAndVersion Photo of the employee to use as an avatar/profile picture __Caching:__ This resource changes very…
  • PATCHSet the date on which to revoke ESS access/providers/employers/employees/:employeeId/revokeEmployeeSelfServiceAccess__Activity name :__ PatchRevokeEmployeeSelfServiceAccessByEmployeeId This endpoint allows the user to set the 'revokeEmployeeSelfServiceAccessOn'. This date…
  • GETList of employees for an employer/providers/employers/:employerId/employees?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetEmployeesByEmployerId Get a list of all employees for the given employer

Contact

  • GETDetails of a single contact/providers/employers/employees/contacts/:contactId__Activity name :__ GetContactByContactId Get the details of a single contact
  • PUTEdit a contact/providers/employers/employees/contacts/:contactId__Activity name :__ PutContactByContactId __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the…
  • DELETEDelete a specific contact/providers/employers/employees/contacts/:contactId__Activity name :__ DeleteContactByContactId Delete an existing Contact (for an employee)
  • GETList of contacts for an employee/providers/employers/employees/:employeeId/contacts?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetContactsByEmployeeId Get list of contacts for an employee
  • POSTCreate a contact for an employee/providers/employers/employees/:employeeId/contacts__Activity name :__ PostContactByEmployeeId __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the…

Occupational disability

  • GETList of occupational disabilities for an employee/providers/employers/employees/:employeeId/occupationaldisabilities?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetOccupationalDisabilitiesByEmployeeId Get the list of occupational disabilities for an employee. This endpoint returns occupational…

Change address request

  • POSTStart the change address workflow for an employee/providers/employers/employees/:employeeId/changeaddressrequest__Activity name:__ PostChangeAddressRequestByEmployeeId Allows the user to submit a change address request. Request because this request will trigger a…

Change contactinformation request

  • POSTStart the change contactinformation workflow for an employee/providers/employers/employees/:employeeId/changecontactinformationrequest__Activity name:__ PostChangeContactInformationRequestByEmployeeId Allows the user to submit a change contactinformation request. Request because this request…

Employer

  • GETList of employers/providers/employers?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetEmployersByUserId Get a list of all employers accessible to the current user Please note the following general remark regarding the…
  • GETList of employers with fewer fields for performance reasons/providers/employers/minimized?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetEmployersMinimizedByUser Get a list of all employers accessible to the current user. With this endpoint we introduced the "Minimized"…
  • GETDetails of an employer/providers/employers/:employerId__Activity name :__ GetEmployerByEmployerId Get the details of a single employers
  • PUTEdit the details of an employer/providers/employers/:employerId__Activity name:__ PutEmployerByEmployerId Edit the details of an employer Possible options for fields of the type 'metadata' can be acquired (GET) by adding…
  • GETLogo of an employer/providers/employers/:employerId/logo__Activity name :__ GetEmployerLogoByEmployerId This activity is listed twice in the documentation due to the specified version caching path parameter.…
  • POSTUpload a logo for the employer/providers/employers/:employerId/logo__Activity name :__ PostEmployerLogoByEmployerId Upload a logo for the employer.
  • DELETEDelete the employer logo/providers/employers/:employerId/logo__Activity name:__ DeleteEmployerLogoByEmployerId Delete the logo of an employer
  • GETLogo of an employer/providers/employers/:employerId/logo/:version__Activity name :__ GetEmployerLogoByEmployerId This activity is listed twice in the documentation due to the specified version caching path parameter.…
  • GETProvider logo/providers/employers/:employerId/providerlogo__Activity name :__ GetProviderLogoByEmployerId This activity is listed twice in the documentation due to the specified version caching path parameter.…
  • GETProvider logo/providers/employers/:employerId/providerlogo/:version__Activity name :__ GetProviderLogoByEmployerId This activity is listed twice in the documentation due to the specified version caching path parameter.…
  • POSTCreate an employer/providers/:providerId/employers__Activity name :__ PostEmployerByProviderId Create an employee for the provider (administratiekantoor) identified by the given providerId. Please take note…

Authorizations

  • GETList of authorized activities with regard to the employer/providers/employers/:employerId/authorizations__Activity name :__ GetAuthorizationsByEmployerId Get the array of activities the user is authenticated for with regard to the specified employer
  • GETList of authorized activities with regard to the provider/providers/:providerId/authorizations__Activity name :__ GetAuthorizationsByProviderId Get the array of activities the user is authenticated for with regard to the specified provider. This…

Concept employee

  • GETDetails of a concept employee with fewer fields./providers/employers/conceptemployees/minimized/:conceptEmployeeId__Activity name :__ GetConceptEmployeeMinimizedByConceptEmployeeId Get the details of a concept employee with fewer fields
  • PUTEdit the details of a concept employee with fewer fields./providers/employers/conceptemployees/minimized/:conceptEmployeeId__Activity name :__ PutConceptEmployeeMinimizedByConceptEmployeeId Edit the details of a concept employee with fewer fields. * Possible options (metadata) for…
  • GETDetails of a concept employee/providers/employers/conceptemployees/:conceptEmployeeId__Activity name :__ GetConceptEmployeeByConceptEmployeeId Get the details of a concept employee
  • PUTEdit the details of a concept employee/providers/employers/conceptemployees/:conceptEmployeeId__Activity name :__ PutConceptEmployeeByConceptEmployeeId Edit the details of a concept employee * Possible options (metadata) for generic fields of the type…
  • DELETEDelete a concept employee/providers/employers/conceptemployees/:conceptEmployeeId__Activity name :__ DeleteConceptEmployeeByConceptEmployeeId Delete a concept employee
  • GETCitizen service number of a concept employee/providers/employers/conceptemployees/:conceptEmployeeId/citizenservicenumber__Activity name :__ GetCitizenServiceNumberByConceptEmployeeId Get the citizen service number (BSN) of a concept employee. BSN is separately authorized in…
  • PUTUpdate the citizen service number of a concept employee/providers/employers/conceptemployees/:conceptEmployeeId/citizenservicenumber__Activity name :__ PutCitizenServiceNumberByConceptEmployeeId Update the citizen service number (BSN) of a concept employee BSN is separately authorized in…
  • PATCHConvert a concept employee to an employee/providers/employers/conceptemployees/:conceptEmployeeId/convertToEmployee__Activity name :__ PatchConvertToEmployeeByConceptEmployeeId This endpoint "converts" the conceptEmployee to an actual employee in Loket. This means creating…
  • GETList of concept employee for an employer/providers/employers/:employerId/conceptemployees?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetConceptEmployeesByEmployerId Get a list of all concept employee for the given employer. Concept employee can be used as a…
  • POSTCreate a concept employee for an employer/providers/employers/:employerId/conceptemployees__Activity name :__ PostConceptEmployeeByEmployerId Create a concept employee for an employer * Possible options (metadata) for generic fields of the type…

Notification

  • PATCHMark one or more notifications as read./providers/employers/notifications__Activity name :__ PatchNotificationsByEmployerId Mark notifications as read
  • GETGet a list of notifications for an employer./providers/employers/:employerId/notifications?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetNotificationsByEmployerId Get a list of unread notifications for an employer

Announcement

  • PATCHMark one or more announcements as read./providers/employers/announcements__Activity name :__ PatchAnnouncementsByEmployerId Mark announcements as read
  • GETGet a list of announcements for an employer./providers/employers/:employerId/announcements?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetAnnouncementsByEmployerId Get a list of announcements for an employer. The list contains a isRead parameter.

Employer dashboard

  • GETDashboard of an employer/providers/employers/:employerId/dashboard__Activity name :__ GetEmployerDashboardByEmployerId Get the url for the Qlik dashboard for this employer. Please note: the Qlik dashboard is only accessible…

Data New Business

  • GETGet a list of functions/datanewbusiness/functions__Activity name :__ GetDataNewBusinessFunctions <br/> Get a list of functions known by Data New Business. <br/>
  • GETGet Data New Business token/datanewbusiness/token__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…
  • GETGet Data New Business token for an employer/providers/employers/:employerId/datanewbusinesstoken__Activity name :__ GetDataNewBusinessTokenByEmployerId Get a token for calling the Data New Business (DNB) API. DNB is a part of Van Spaendonck and with its…

Functions

  • GETDetails of a function/providers/employers/functions/:functionId__Activity name:__ GetFunctionByFunctionId Get the details of function
  • PUTEdit the details of a function/providers/employers/functions/:functionId__Activity name:__ PutFunctionByFunctionId Edit the details for a function __Metadata:__ No metadata
  • GETList of functions/providers/employers/:employerId/functions?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetFunctionsByEmployerId Get a list of all functions for the employer. This is the point where the functions available for use at…
  • POSTCreate a function for an employer/providers/employers/:employerId/functions__Activity name:__ PostFunctionByEmployerId Create a function for an employer __Metadata:__ No metadata __Defaults:__ No default values

Departments

  • GETDetails of a department/providers/employers/departments/:departmentId__Activity name:__ GetDepartmentByDepartmentId Get the details of department
  • PUTEdit the details of a department/providers/employers/departments/:departmentId__Activity name:__ PutDepartmentByDepartmentId Edit the details for a department __Metadata :__ Possible options for fields of the type 'metadata' can be…
  • GETList of departments/providers/employers/:employerId/departments?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetDepartmentsByEmployerId Get a list of all departments for the employer. This is the point where the departments available for use at…
  • POSTCreate a department for an employer/providers/employers/:employerId/departments__Activity name:__ PostDepartmentByEmployerId Create a department for an employer __Metadata :__ Possible options for fields of the type 'metadata' can be…
  • GETList of user accessible departments/providers/employers/:employerId/useraccessibledepartments?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetUserAccessibleDepartmentsByEmployerId Get a list of all departments for the employer, which are accesible for the current user.

Workflow trigger mapping

  • GETDetails of a workflow trigger mapping record/providers/employers/workflowtriggermappings/:workflowTriggerMappingId__Activity name:__ GetWorkflowTriggerMappingByWorkflowTriggerMappingId Get the details of a workflow trigger mapping
  • PUTEdit the details of a workflow trigger mapping record/providers/employers/workflowtriggermappings/:workflowTriggerMappingId__Activity name:__ PutWorkflowTriggerMappingByWorkflowTriggerMappingId Edit the details for a workflow trigger mapping record Possible options for fields of…
  • DELETEDelete a specific workflow trigger mapping record/providers/employers/workflowtriggermappings/:workflowTriggerMappingId__Activity name:__ DeleteWorkflowTriggerMappingByWorkflowTriggerMappingId Delete a workflow trigger mapping record for the employer
  • GETWorkflowtrigger to workflowtemplate mapping/providers/employers/:employerId/workflowtriggermappings?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name:__ GetWorkflowTriggerMappingsByEmployerId Get the list workflow triggers that are mapped to a workflowTemplate. Workflow triggers are triggers…
  • POSTCreate a workflow trigger mapping record for an employer/providers/employers/:employerId/workflowtriggermappings__Activity name:__ PostWorkflowTriggerMappingByEmployerId Create a workflow trigger mapping record for an employer __Metadata :__ Possible options for fields…

Custom holiday

  • GETDetails of a custom holiday/providers/employers/customholidays/:customHolidayId?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetCustomHolidayByCustomHolidayId Get the details of a custom holiday
  • PUTEdit a custom holiday record/providers/employers/customholidays/:customHolidayId__Activity name :__ PutCustomHolidayByCustomHolidayId
  • DELETEDelete a custom holiday record/providers/employers/customholidays/:customHolidayId__Activity name :__ DeleteCustomHolidayByCustomHolidayId Delete an existing custom holiday record
  • GETList custom holidays for an employer/providers/employers/:employerId/customholidays?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetCustomHolidaysByEmployerId Get a list of the custom holidays for an employer. __Note:__ The custom holidays defined at the employer…
  • POSTAdd a custom holiday for an employer/providers/employers/:employerId/customholidays__Activity name :__ PostCustomHolidayByEmployerId

National holiday

  • GETList of national holidays/providers/employers/:employerId/nationalholidays?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetNationalHolidaysByEmployerId Get a list of all national holidays for the employer
  • GETDetails of a national holiday/providers/employers/:employerId/nationalholidays/:nationalHolidayId__Activity name:__ GetNationalHolidaysByEmployerIdAndNationalHolidayId Get the details of a national holiday
  • PUTEdit the details of a national holidays/providers/employers/:employerId/nationalholidays/:nationalHolidayId__Activity name:__ PutNationalHolidayByEmployerIdAndNationalHolidayId Edit the details for a national holiday __Metadata :__ There is no metadata endpoint for…

Billable item

  • GETList of billable items/providers/employers/:employerId/billableitems?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetBillableItemsByEmployerId Get a list of all billable items for the employer.

Preboarding trajectory

  • POSTAdd a preboarding trajectory/providers/employers/conceptemployees/:conceptEmployeeId/preboardingtrajectory__Activity name :__ PostPreboardingTrajectoryByConceptEmployeeId
  • PATCHChange status of a preboarding trajectory/providers/employers/conceptemployees/:conceptEmployeeId/preboardingtrajectory__Activity name :__ PatchPreboardingTrajectoryByConceptEmployeeId

Employment

  • GETDetails of an employment/providers/employers/employees/employments/:employmentId__Activity name :__ GetEmploymentByEmploymentId Get the details for an employment
  • PUTEdit the details of an employment/providers/employers/employees/employments/:employmentId__Activity name :__ PutEmploymentByEmploymentId Edit the details of an employment Possible values for fields of the type 'metadata' can be acquired (GET) by…
  • PATCHEdit the type of an employment/providers/employers/employees/employments/:employmentId__Activity name :__ PatchTypeOfEmploymentCategoryTypeFieldsByEmploymentId Edit a small subset of fields of an employment. Possible values for fields of the…
  • PATCHCorrect the start (employment) date for an employment./providers/employers/employees/employments/:employmentId/correctstartdate__Activity name :__ PatchCorrectStartDateByEmploymentId Edit the starting date (i.e. the official first day of a contract) of an employment. Please note that…
  • PATCHUndo termination for an employment./providers/employers/employees/employments/:employmentId/reinstate__Activity name :__ PatchReinstateByEmploymentId reinstate for an employment. <br/> Effectively, termination is reversed by using this endpoint and therefore…
  • PATCHTerminate an employment./providers/employers/employees/employments/:employmentId/terminate__Activity name :__ PatchTerminateByEmploymentId Terminate an employment. Effectively, the endDate of the employment will be set to the given date.<br/>…
  • GETList of employments for an employee/providers/employers/employees/:employeeId/employments?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetEmploymentsByEmployeeId Get the list of employments for an employee
  • GETList of employments for an employer/providers/employers/:employerId/employees/employments?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetEmploymentsByEmployerId Get a list of employments for an employer This endpoint only returns the employments that meet the filter…
  • GETList of employments with additional entities/providers/employers/:employerId/employees/employments/comprehensive?referenceDate=2022-01-01&filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetEmploymentsComprehensiveByEmployerId Get a list of employments for an employer. With this version we introduced the "Comprehensive"…
  • GETList of employments with fewer fields for performance reasons/providers/employers/:employerId/employees/employments/minimized?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetEmploymentsMinimizedByEmployerId Get a list of employments for an employer. With this version we introduced the "Minimized" resource…

Organizational entity

  • GETDetails of an organizational entity/providers/employers/employees/employments/organizationalentities/:organizationalEntityId__Activity name:__ GetOrganizationalEntityByOrganizationalEntityId Get the details of organizational entity
  • PUTEdit the details of an organizational entity/providers/employers/employees/employments/organizationalentities/:organizationalEntityId__Activity name:__ PutOrganizationalEntityByOrganizationalEntityId Edit the details for an organizational entity Possible options for fields of the type…
  • DELETEDelete a specific organizational entity record/providers/employers/employees/employments/organizationalentities/:organizationalEntityId__Activity name:__ DeleteOrganizationalEntityByOrganizationalEntityId Delete a organizational entity for the employment
  • GETList of organizational entities for an employment/providers/employers/employees/employments/:employmentId/organizationalentities?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name:__ GetOrganizationalEntitiesByEmploymentId Get the list of organizational entities for an employment
  • POSTCreate an organizational entity for an employment/providers/employers/employees/employments/:employmentId/organizationalentities__Activity name:__ PostOrganizationalEntityByEmploymentId Create an organizational entity for an employment __Metadata :__ Possible options for fields of the…

Payroll period data

  • GETDetails of a payroll period data/providers/employers/employees/employments/payrollperioddata/:payrollperioddataId__Activity name :__ GetPayrollPeriodDataByPayrollPeriodDataId <br/> <br/> Get the details of payroll period data
  • PUTEdit the details of an payroll period data/providers/employers/employees/employments/payrollperioddata/:payrollperioddataId__Activity name :__ PutPayrollPeriodDataByPayrollPeriodDataId <br/> <br/> Edit the details for payroll period data <br/> <br/> __Metadata :__ <br/> Possible…
  • DELETEDelete a specific payroll period data record/providers/employers/employees/employments/payrollperioddata/:payrollperioddataId__Activity name:__ DeletePayrollPeriodDataByPayrollPeriodDataId Delete a payroll period data record for the employment
  • GETlist of payroll period data/providers/employers/employees/employments/:employmentId/payrollperioddata?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetPayrollPeriodDataByEmploymentId <br/> <br/> Get a list of all payroll period data for an employment. Payroll period data relates to a…
  • POSTCreate an payroll period data record for an employment/providers/employers/employees/employments/:employmentId/payrollperioddata__Activity name :__ PostPayrollPeriodDataByEmploymentId <br/> <br/> Create a payroll period date record for an employment <br/> <br/> __Metadata :__ <br/>…
  • PATCHInsert or update payroll period data/providers/employers/employees/employments/:employmentId/payrollperioddata?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20This endpoint is the REST alternative to the ImporteerGegevens (Variabele Gegevens) SOAP webservice functionality <br/> <br/> __Activity name :__…

Benefits and deductions

  • GETDetail of a benefit or deduction record/providers/employers/employees/employments/benefitsAndDeductions/:benefitsanddeductionsId__Activity name :__ GetBenefitsAndDeductionsBybenefitsAndDeductionsId Get a benefit or deduction for the employment
  • PUTEdit the details of a benefit or deduction record/providers/employers/employees/employments/benefitsAndDeductions/:benefitsanddeductionsId__Activity name :__ PutBenefitsAndDeductionsByBenefitsAndDeductionsId Update a benefit or deduction for the employment __Metadata :__ Possible options for…
  • DELETEDelete a specific benefit or deduction record/providers/employers/employees/employments/benefitsAndDeductions/:benefitsanddeductionsId__Activity name :__ DeleteBenefitsAndDeductionsByBenefitsAndDeductionsId Delete a benefit or deduction for the employment
  • GETlist of benefits and deductions/providers/employers/employees/employments/:employmentId/benefitsanddeductions?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetBenefitsAndDeductionsByEmploymentId Get a list of benefits and deductions for the employment
  • POSTAdd a benefit or deduction record for the employment/providers/employers/employees/employments/:employmentId/benefitsanddeductions__Activity name :__ PostBenefitsAndDeductionsByEmploymentId Add a benefit or deduction for the employment __Metadata :__ Possible options for fields of the…

Wage

  • GETDetails of a single wage/providers/employers/employees/employments/wages/:wageId__Activity name :__ GetWageByWageId Get the details of a single wage
  • PUTEdit a wage/providers/employers/employees/employments/wages/:wageId__Activity name :__ PutWageByWageId Edit the details of a wage __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by…
  • DELETEDelete a specific wage record/providers/employers/employees/employments/wages/:wageId__Activity name :__ DeleteWageByWageId Delete a wage record for the employment
  • GETList of wages for an employment/providers/employers/employees/employments/:employmentId/wages?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetWagesByEmploymentId Get the list of wages for the employment
  • POSTCreate an wage for an employment/providers/employers/employees/employments/:employmentId/wages__Activity name :__ PostWageByEmploymentId Create a new wage record for the given employment __Metadata :__ Possible options for fields of the type 'metadata'…

Working hours

  • GETDetails of the working hours/providers/employers/employees/employments/workinghours/:workinghoursId__Activity name :__ GetWorkingHoursByWorkingHoursId <br/> <br/> Get the details of a working hours record
  • PUTEdit the working hours/providers/employers/employees/employments/workinghours/:workinghoursId__Activity name :__ PutWorkingHoursByWorkingHoursId <br/> <br/> Create a new working hours record for an employment<br/> Please note that so-called chain…
  • DELETEDelete a specific working hours record/providers/employers/employees/employments/workinghours/:workinghoursId__Activity name :__ DeleteWorkingHoursByWorkingHoursId <br/> <br/> Delete an existing working hours record (for an employment)
  • GETList of working hours for an employment/providers/employers/employees/employments/:employmentId/workinghours?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetWorkingHoursByEmploymentId <br/> <br/> Get the list of working hours for an employment <br/>
  • POSTCreate the working hours for an employment/providers/employers/employees/employments/:employmentId/workinghours__Activity name :__ PostWorkingHoursByEmploymentId <br/> <br/> Create a new working hours record for an employment<br/> Please note that so-called chain…

Payslip

  • GETGet payroll period results of an employment for a year/providers/employers/employees/employments/:employmentId/payrollperiodresults/year/:year__Activity name :__ GetPayrollPeriodResultsByEmploymentIdAndYear Download the payroll results (conform overzicht strook) of an employment per payroll period…
  • GETList of payslips for an employment/providers/employers/employees/employments/:employmentId/payslips?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetPayslipsByEmploymentId Get a list of payslips for the specified employment, including the GUID of the corresponding payroll run. The…
  • GETDownload a cummulative payslip for a single payroll period/providers/employers/employees/employments/:employmentId/payslips/summary/:payrollPeriodId__Activity name :__ GetPayrollPeriodSummaryByEmploymentIdAndPayrollPeriodId Download a cummulative payslip for a single payroll period in a single PDF. e.g.…
  • GETDownload payslips of an employment for a payrollrun/providers/employers/employees/employments/:employmentId/payslips/:payrollrunId__Activity name :__ GetPayslipsByEmploymentIdAndPayrollRunId Download the payslips or its underlying payroll results of an employment for the specified…
  • GETDownload payslips for an employment and year/providers/employers/employees/employments/:employmentId/payslips/:year__Activity name :__ GetPayslipsByEmploymentIdAndYear Download the payslips for a payroll year in a single PDF __Metadata :__ Possible options for year can be…
  • GETDownload wage sheets for an employment/providers/employers/employees/employments/:employmentId/wagesheet/:year__Activity name :__ GetWageSheetByEmploymentIdAndYear Download the wagesheet (loonstaat) for a payroll year __Metadata :__ Possible options for year can be…

Year-end statement

  • GETYear-end statements for the employment/providers/employers/employees/employments/:employmentId/yearendstatements?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetYearEndStatementsByEmploymentId Get a list of year-end statements (i.e. list of years for which year-end statements are available) for…
  • GETDownload year-end statement of an employment for a year/providers/employers/employees/employments/:employmentId/yearendstatements/:year__Activity name :__ GetYearEndStatementForYearByEmploymentId Download the year-end statement of an employment for a year.

Year-end statement at administration level

  • GETYear-end statements for the payroll administration/providers/employers/payrolladministrations/:payrollAdministrationId/yearendstatements?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetYearEndStatementsByPayrollAdministrationId Get a list of year-end statements (i.e. list of years for which year-end statements are…
  • GETDownload year-end statement of a payroll administration for a year/providers/employers/payrolladministrations/:payrollAdministrationId/yearendstatements/:year?includeEmployeeSelfService=true__Activity name :__ GetYearEndStatementForYearByPayrollAdministrationId Download the year-end statements of a payroll administration (of its underlying…

Payment information

  • GETGet the details of a payment information sepa/providers/employers/employees/employments/paymentinformationsepa/:paymentInformationSepaId__Activity name :__ GetPaymentInformationSepaBypaymentInformationSepaId Get the detail of a payment information SEPA record. For a specific payroll component,…
  • PUTchange the details of a payment information sepa/providers/employers/employees/employments/paymentinformationsepa/:paymentInformationSepaId__Activity name :__ PutPaymentInformationSepaByPaymentInformationSepaId Edit an existing SEPA payment-record (for an employment). For each unique payroll…
  • DELETEDelete a specific SEPA payment-record record/providers/employers/employees/employments/paymentinformationsepa/:paymentInformationSepaId__Activity name :__ DeletePaymentInformationSepaByPaymentInformationSepaId Delete an existing SEPA payment-record (for an employment)
  • GETGet a list of payment information sepa/providers/employers/employees/employments/:employmentId/paymentinformationsepa?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetPaymentInformationSepaByEmploymentId Get a list of payment information for SEPA bank accounts (IBAN's) for an employment. For a…
  • POSTcreate a new payment information sepa record/providers/employers/employees/employments/:employmentId/paymentinformationsepa__Activity name :__ PostPaymentInformationSepaByEmploymentId Create a new Payment information SEPA record for an employment.<br/> For each unique payroll…

Payment information separate payments

  • GETGet the details of a payment information SEPA separate payment record/providers/employers/employees/employments/paymentinformationsepaseparatepayments/:paymentInformationSepaSeparatePaymentId__Activity name :__ GetPaymentInformationSepaSeparatePaymentByPaymentInformationSepaSeparatePaymentId Get the detail of a payment information SEPA record. For…
  • PUTEdit the details of a payment information separate payment record/providers/employers/employees/employments/paymentinformationsepaseparatepayments/:paymentInformationSepaSeparatePaymentId__Activity name :__ PutPaymentInformationSepaSeparatePaymentByPaymentInformationSepaSeparatePaymentId Edit an existing separate payment-record (for an…
  • DELETEDelete a payment information SEPA separate payment record/providers/employers/employees/employments/paymentinformationsepaseparatepayments/:paymentInformationSepaSeparatePaymentId__Activity name :__ DeletePaymentInformationSepaSeparatePaymentByPaymentInformationSepaSeparatePaymentId Delete an existing SEPA payment-record (for an…
  • GETGet a list of payment information SEPA separate payment records/providers/employers/employees/employments/:employmentId/paymentinformationsepaseparatepayments?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetPaymentInformationSepaSeparatePaymentByEmploymentId Get a list of records that indicate, if applicable, the bank account(s) (i.e.…
  • POSTCreate a new payment information SEPA separate payment record/providers/employers/employees/employments/:employmentId/paymentinformationsepaseparatepayments__Activity name :__ PostPaymentInformationSepaSeparatePaymentByEmploymentId Create a new payment information SEPA separate payment record for an…

Payment information non-SEPA

  • GETGet the details of a payment information non-SEPA/providers/employers/employees/employments/paymentinformationnonsepa/:paymentInformationNonSepaId__Activity name :__ GetPaymentInformationNonSepaByPaymentInformationNonSepaId Get the detail of a payment information non-SEPA record. For a specific payroll…
  • PUTChange the details of a payment information non-SEPA/providers/employers/employees/employments/paymentinformationnonsepa/:paymentInformationNonSepaId__Activity name :__ PutPaymentInformationNonSepaByPaymentInformationNonSepaId Edit an existing payment information non-SEPA record (for an employment). For…
  • DELETEDelete a payment information non-SEPA record/providers/employers/employees/employments/paymentinformationnonsepa/:paymentInformationNonSepaId__Activity name :__ DeletePaymentInformationNonSepaByPaymentInformationNonSepaId Delete a payment information non-SEPA record (for an employment)
  • GETGet a list of payment information non-SEPA/providers/employers/employees/employments/:employmentId/paymentinformationnonsepa?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetPaymentInformationNonSepaByEmploymentId Get a list of payment information for non-SEPA bank accounts for an employment. These are…
  • POSTCreate a new payment information non-SEPA record/providers/employers/employees/employments/:employmentId/paymentinformationnonsepa__Activity name :__ PostPaymentInformationNonSepaByEmploymentId Create a new payment information non-SEPA record for an employment. For each unique payroll…

Fiscal properties

  • GETDetails of a fiscal record/providers/employers/employees/employments/fiscalproperties/:fiscalPropertiesId__Activity name:__ GetFiscalPropertiesByFiscalPropertiesId Get the details of fiscal
  • PUTEdit the details of a fiscal record/providers/employers/employees/employments/fiscalproperties/:fiscalPropertiesId__Activity name:__ PutFiscalPropertiesByFiscalPropertiesId Edit the details for a fiscal properties record Possible options for fields of the type 'metadata'…
  • DELETEDelete a specific fiscal properties record/providers/employers/employees/employments/fiscalproperties/:fiscalPropertiesId__Activity name:__ DeleteFiscalPropertiesByFiscalPropertiesId Delete a fiscal properties record for the employment
  • GETList of fiscal properties for an employment/providers/employers/employees/employments/:employmentId/fiscalproperties?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name:__ GetFiscalPropertiesByEmploymentId Get the list of fiscal properties for an employment
  • POSTCreate a fiscal record for an employment/providers/employers/employees/employments/:employmentId/fiscalproperties__Activity name:__ PostFiscalPropertiesByEmploymentId Create a fiscal properties record for an employment __Metadata :__ Possible options for fields of the…

Fiscal company car

  • GETDetails of a fiscal company car record/providers/employers/employees/employments/fiscalcompanycars/:fiscalCompanyCarId__Activity name:__ GetFiscalCompanyCarByFiscalCompanyCarId Get the details of fiscal company car Please note this resource is related for the registration of…
  • PUTEdit the details of a fiscal company car record/providers/employers/employees/employments/fiscalcompanycars/:fiscalCompanyCarId__Activity name:__ PutFiscalCompanyCarByFiscalCompanyCarId Edit the details for a fiscal company car record. Please note this resource is related for the…
  • DELETEDelete a specific fiscal company car record/providers/employers/employees/employments/fiscalcompanycars/:fiscalCompanyCarId__Activity name:__ DeleteFiscalCompanyCarByFiscalCompanyCarId Delete a fiscal company car record for the employment Please note this resource is related for…
  • GETList of fiscal company cars for an employment/providers/employers/employees/employments/:employmentId/fiscalcompanycars?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name:__ GetFiscalCompanyCarsByEmploymentId Get the list of fiscal company cars for an employment. Please note this resource is related for the…
  • POSTCreate a fiscal company car record for an employment/providers/employers/employees/employments/:employmentId/fiscalcompanycars__Activity name:__ PostFiscalCompanyCarByEmploymentId Create a fiscal company cars record for an employment. Please note this resource is related for the…
  • GETAcquire the additional tax liability by the license plate number (company car)/rdwservices/additionaltaxliability?licensePlateNumber=52LRX4__Activity name:__ GetAdditionalTaxliabilityByLicensePlateNumber This endpoint allows the user to acquire values for specific properties in the company car…

Company car

  • GETDetails of a company car record/providers/employers/employees/employments/companycars/:companyCarId__Activity name:__ GetCompanyCarByCompanyCarId Get the details of a company car Please note this resource is related for the registration of the company car…
  • PUTEdit the details of a company car record/providers/employers/employees/employments/companycars/:companyCarId__Activity name:__ PutCompanyCarByCompanyCarId Edit the details for a company car record. Please note this resource is related for the registration of the…
  • DELETEDelete a specific company car record/providers/employers/employees/employments/companycars/:companyCarId__Activity name:__ DeleteCompanyCarByCompanyCarId Delete a company car record for the employment Please note this resource is related for the registration of…
  • GETList of company cars for an employment/providers/employers/employees/employments/:employmentId/companycars?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name:__ GetCompanyCarsByEmploymentId Get the list of company cars for an employment. Please note this resource is related for the registration of…
  • POSTCreate a company car record for an employment/providers/employers/employees/employments/:employmentId/companycars__Activity name:__ PostCompanyCarByEmploymentId Create a company car record for an employment. Please note this resource is related for the registration of…

Other payroll variables

  • GETDetails of other payroll variables for an employment/providers/employers/employees/employments/otherPayrollVariables/:otherPayrollVariablesId?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetOtherPayrollVariablesByOtherPayrollVariablesId Get the details of other payroll variables for an employment
  • PUTChange the details of an other payroll variables record/providers/employers/employees/employments/otherPayrollVariables/:otherPayrollVariablesId__Activity name :__ PutOtherPayrollVariablesByOtherPayrollVariablesId Change the details of an other payroll variables record __Metadata :__ Possible options…
  • DELETEDelete a specific other payroll variables record/providers/employers/employees/employments/otherPayrollVariables/:otherPayrollVariablesId__Activity name :__ DeleteOtherPayrollVariablesByOtherPayrollVariablesId Delete an existing other payroll variables record (for an employment)
  • GETList of other payroll variables for an employment/providers/employers/employees/employments/:employmentId/otherPayrollVariables?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetOtherPayrollVariablesByEmploymentId Get a list of the other payroll variables for an employment Other payroll variables are a set of…
  • POSTAdd other payroll variables for an employment/providers/employers/employees/employments/:employmentId/otherPayrollVariables__Activity name :__ PostOtherPayrollVariablesByEmploymentId Add other payroll variables for an employment. __Metadata :__ Possible options for fields of the…

Chamber of commerce

  • GETAcquire company information/chamberofcommerce/:chamberOfCommerceNumber/companyinformation__Activity name:__ GetCompanyInformationByChamberOfCommerceNumber This endpoint allows the user to acquire basic company information for a specific chamber of…

Employment funds

  • GETDetails of an employment fund/providers/employers/employees/employments/employmentfunds/:employmentFundId?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetEmploymentFundByEmploymentFundId Get the details of an employment fund
  • PUTEdit a employment fund record/providers/employers/employees/employments/employmentfunds/:employmentFundId__Activity name :__ PutEmploymentFundByEmploymentFundId __Metadata :__ Possible options for fields of the type "metadata" can be acquired (GET) by adding…
  • DELETEDelete a specific employment fund record/providers/employers/employees/employments/employmentfunds/:employmentFundId__Activity name :__ DeleteEmploymentFundByEmploymentFundId Delete an existing employment fund record.
  • GETList of funds the employment partakes in/providers/employers/employees/employments/:employmentId/employmentfunds?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetEmploymentFundsByEmploymentId Get a list of the funds the employment partakes in.
  • POSTActivate a fund for an employment/providers/employers/employees/employments/:employmentId/employmentfunds__Activity name :__ PostEmploymentFundByEmploymentId __Metadata :__ Possible options for fields of the type "metadata" can be acquired (GET) by adding…

Abp funds

  • GETDetails of an abp fund/providers/employers/employees/employments/abpfunds/:abpFundId?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetAbpFundByAbpFundId Get the details of an abp fund
  • PUTEdit a abp fund record/providers/employers/employees/employments/abpfunds/:abpFundId__Activity name :__ PutAbpFundByAbpFundId __Metadata :__ Possible options for fields of the type "metadata" can be acquired (GET) by adding /metadata to the…
  • DELETEDelete a specific abp fund record/providers/employers/employees/employments/abpfunds/:abpFundId__Activity name :__ DeleteAbpFundByAbpFundId Delete an existing abp fund record.
  • GETList of abp funds the employment partakes in/providers/employers/employees/employments/:employmentId/abpfunds?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetAbpFundsByEmploymentId Get a list of the abp funds the employment partakes in.
  • POSTActivate an abp fund for an employment/providers/employers/employees/employments/:employmentId/abpfunds__Activity name :__ PostAbpFundByEmploymentId __Metadata :__ Possible options for fields of the type "metadata" can be acquired (GET) by adding /metadata to…

Base for employment fund calculation

  • GETDetails of an base for employment fund calculations/providers/employers/employees/employments/basesforemploymentfundcalculation/:baseforemploymentfundcalculationId?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetBaseForEmploymentFundCalculationByBaseForEmploymentFundCalculationId Get the details of a base for employment fund calculations.
  • PUTChange the properties of a base for employment fund calculation/providers/employers/employees/employments/basesforemploymentfundcalculation/:baseforemploymentfundcalculationId__Activity name :__ PutBaseForEmploymentFundCalculationByBaseForEmploymentFundCalculationId __Metadata :__ Possible options for fields of the type "metadata"…
  • DELETEDelete a specific record/providers/employers/employees/employments/basesforemploymentfundcalculation/:baseforemploymentfundcalculationId__Activity name :__ DeleteBaseForEmploymentFundCalculationByBaseForEmploymentFundCalculationId Delete an existing base for employment fund calculation
  • GETList of bases for employment fund calculations./providers/employers/employees/employments/:employmentId/basesforemploymentfundcalculation?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetBasesForEmploymentFundCalculationByEmploymentId Get a list of the bases (money) that are used in employment fund calculations.
  • POSTAdd a base for employment fund calculation/providers/employers/employees/employments/:employmentId/basesforemploymentfundcalculation__Activity name :__ PostBaseForEmploymentFundCalculationByEmploymentId __Metadata :__ Possible options for fields of the type "metadata" can be acquired (GET)…

Base for calculation

  • GETDetails of an base for employment fund calculations/providers/employers/employees/employments/basesforcalculation/:baseforcalculationId?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetBaseForCalculationByBaseForCalculationId Get the details of a base for employment fund calculations.
  • PUTChange the properties of a base for calculation/providers/employers/employees/employments/basesforcalculation/:baseforcalculationId__Activity name :__ PutBaseForCalculationByBaseForCalculationId __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by…
  • DELETEDelete a specific record/providers/employers/employees/employments/basesforcalculation/:baseforcalculationId__Activity name :__ DeleteBaseForCalculationByBaseForCalculationId Delete an existing base for calculation
  • GETList of bases for employment fund calculations./providers/employers/employees/employments/:employmentId/basesforcalculation?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetBasesForCalculationByEmploymentId Get a list of the bases (money) that are used as the base for certain calculations.
  • POSTAdd a base for calculation/providers/employers/employees/employments/:employmentId/basesforcalculation__Activity name :__ PostBaseForCalculationByEmploymentId __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding…

Social security

  • GETDetails of a social security record/providers/employers/employees/employments/socialsecurityconfigurations/:socialSecurityConfigurationId__Activity name:__ GetSocialSecurityConfigurationBySocialSecurityConfigurationId Get the details of a social security configuration record
  • PUTEdit the details of a social security record/providers/employers/employees/employments/socialsecurityconfigurations/:socialSecurityConfigurationId__Activity name:__ PutSocialSecurityConfigurationBySocialSecurityConfigurationId Edit the details for a social security record
  • DELETEDelete a specific social security record/providers/employers/employees/employments/socialsecurityconfigurations/:socialSecurityConfigurationId__Activity name:__ DeleteSocialSecurityConfigurationBySocialSecurityConfigurationId Delete a social security record for the employment
  • GETList of social security records for an employment/providers/employers/employees/employments/:employmentId/socialsecurityconfigurations?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name:__ GetSocialSecurityConfigurationsByEmploymentId Get the list of social security configuration records for an employment
  • POSTCreate a social security record for an employment/providers/employers/employees/employments/:employmentId/socialsecurityconfigurations__Activity name:__ PostSocialSecurityConfigurationByEmploymentId Create a social security configuration record for an employment __Defaults :__ Default values…

Social security benefits

  • GETDetails of a social security benefits record/providers/employers/employees/employments/socialsecuritybenefits/:socialSecurityBenefitId__Activity name:__ GetSocialSecurityBenefitBySocialSecurityBenefitId Get the details of a social security benefits record
  • PUTEdit the details of a social security benefits record/providers/employers/employees/employments/socialsecuritybenefits/:socialSecurityBenefitId__Activity name:__ PutSocialSecurityBenefitBySocialSecurityBenefitId __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET)…
  • DELETEDelete a specific social security benefits record/providers/employers/employees/employments/socialsecuritybenefits/:socialSecurityBenefitId__Activity name:__ DeleteSocialSecurityBenefitBySocialSecurityBenefitId Delete a social security record for the employment
  • GETList of social security benefits records for an employment/providers/employers/employees/employments/:employmentId/socialsecuritybenefits?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name:__ GetSocialSecurityBenefitsByEmploymentId Get the list of social security benefits records for an employment
  • POSTCreate a social security benefits record for an employment/providers/employers/employees/employments/:employmentId/socialsecuritybenefits__Activity name:__ PostSocialSecurityBenefitByEmploymentId Create a social security benefits record for an employment __Metadata :__ Possible options for…

Healthcare Insurance Act

  • GETDetails of a Healthcare Insurance Act record/providers/employers/employees/employments/healthcareinsuranceactconfigurations/:healthcareInsuranceActConfigurationId__Activity name:__ GetHealthcareInsuranceActConfigurationByHealthcareInsuranceActConfigurationId Get the details of a Healthcare Insurance Act configuration…
  • PUTEdit the details of a Healthcare Insurance Act record/providers/employers/employees/employments/healthcareinsuranceactconfigurations/:healthcareInsuranceActConfigurationId__Activity name:__ PutHealthcareInsuranceActConfigurationByHealthcareInsuranceActConfigurationId Edit the details for a Healthcare Insurance Act record…
  • DELETEDelete a specific Healthcare Insurance Act record/providers/employers/employees/employments/healthcareinsuranceactconfigurations/:healthcareInsuranceActConfigurationId__Activity name:__ DeleteHealthcareInsuranceActConfigurationByHealthcareInsuranceActConfigurationId Delete a Healthcare Insurance Act record for the employment
  • GETList of Healthcare Insurance Act records for an employment/providers/employers/employees/employments/:employmentId/healthcareinsuranceactconfigurations?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name:__ GetHealthcareInsuranceActConfigurationsByEmploymentId Get the list of Healthcare Insurance Act configuration records for an employment
  • POSTCreate a Healthcare Insurance Act record for an employment/providers/employers/employees/employments/:employmentId/healthcareinsuranceactconfigurations__Activity name:__ PostHealthcareInsuranceActConfigurationByEmploymentId Create a Healthcare Insurance Act configuration record for an employment __Metadata…

Attachment of earnings

  • GETGet the details of an attachment of earnings record/providers/employers/employees/employments/attachmentsofearnings/:attachmentOfEarningsId__Activity name :__ GetAttachmentOfEarningsByAttachmentOfEarningsId Get the details of an attachment of earnings record
  • PUTEdit the details of an attachment of earnings record/providers/employers/employees/employments/attachmentsofearnings/:attachmentOfEarningsId__Activity name :__ PutAttachmentOfEarningsByAttachmentOfEarningsId Update the details of a single attachment of earnings record __Metadata :__ Possible…
  • DELETEDelete an attachment of earnings record/providers/employers/employees/employments/attachmentsofearnings/:attachmentOfEarningsId__Activity name :__ DeleteAttachmentOfEarningsByAttachmentOfEarningsId Delete an existing attachment of earnings record
  • GETGet a list of attachment of earnings records/providers/employers/employees/employments/:employmentId/attachmentsofearnings?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetAttachmentOfEarningsByEmploymentId Get a list of attachment of earnings records
  • POSTCreate a new attachment of earnings record/providers/employers/employees/employments/:employmentId/attachmentsofearnings__Activity name :__ PostAttachmentOfEarningsByEmploymentId Create a new attachment of earnings record for an employment. __Metadata :__ Possible values for…

Protected earnings

  • GETGet the details of an protected earnings record/providers/employers/employees/employments/protectedearnings/:protectedEarningsId__Activity name :__ GetProtectedEarningsByProtectedEarningsId Get the details of an protected earnings record
  • PUTEdit the details of an protected earnings record/providers/employers/employees/employments/protectedearnings/:protectedEarningsId__Activity name :__ PutProtectedEarningsByProtectedEarningsId Update the details of a single protected earnings record __Metadata :__ There is no metadata for…
  • DELETEDelete an protected earnings record/providers/employers/employees/employments/protectedearnings/:protectedEarningsId__Activity name :__ DeleteProtectedEarningsByProtectedEarningsId Delete an existing protected earnings record
  • GETGet a list of protected earnings records/providers/employers/employees/employments/:employmentId/protectedearnings?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetProtectedEarningsByEmploymentId Get a list of protected earnings records
  • POSTCreate a new protected earnings record/providers/employers/employees/employments/:employmentId/protectedearnings__Activity name :__ PostProtectedEarningsByEmploymentId Create a new protected earnings record for an employment. __Metadata :__ There is no metadata for this…

Deviating AWF Contribution

  • GETDetails of a Deviating AWF contributions record/providers/employers/employees/employments/deviatingawfcontributions/:deviatingAwfContributionId__Activity name:__ GetDeviatingAwfContributionByDeviatingAwfContributionId Get the details of a Deviating AWF contributions record
  • PUTEdit the details of a Deviating AWF contributions record/providers/employers/employees/employments/deviatingawfcontributions/:deviatingAwfContributionId__Activity name:__ PutDeviatingAwfContributionByDeviatingAwfContributionId __Metadata :__ Possible options for fields of the type 'metadata' can be acquired…
  • DELETEDelete a specific Deviating AWF contributions record/providers/employers/employees/employments/deviatingawfcontributions/:deviatingAwfContributionId__Activity name:__ DeleteDeviatingAwfContributionByDeviatingAwfContributionId Delete a Deviating AWF contribution record for the employment
  • GETList of Deviating AWF contributions records for an employment/providers/employers/employees/employments/:employmentId/deviatingawfcontributions?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name:__ GetDeviatingAwfContributionsByEmploymentId Get the list of Deviating AWF contributions records for an employment
  • POSTCreate a Deviating AWF contributions record for an employment/providers/employers/employees/employments/:employmentId/deviatingawfcontributions__Activity name:__ PostDeviatingAwfContributionByEmploymentId Create a Deviating AWF contributions record for an employment __Metadata:__ Possible options for…

Transition compensation

  • POSTCalculate transition compensation/providers/employers/employees/employments/:employmentId/transitioncompensation/calculateThis is a controller endpoint to perform a calculation. No actual data will be stored as a result of these actions. __Activity name :__…
  • GETGet default input parameters transition compensation/providers/employers/employees/employments/:employmentId/transitioncompensation/calculate/defaults__Activity name :__ GetCalculateTransitionCompensationDefaultsByEmploymentId Get the default values of the input parameters for the POST action.

Activate employee profile

  • PATCHActivate employee profile for the employment/providers/employers/employees/employments/:employmentId/employeeprofile__Activity name :__ PatchEmployeeProfileByEmploymentId Create Fondsen, Grondslagen and toeslagen based on the employment's employeeProfile.

Pension benefit

  • GETDetails of an pension benefit/providers/employers/employees/employments/pensionbenefits/:pensionBenefitId?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetPensionBenefitByPensionBenefitId Get the details of a pension benefit
  • PUTEdit a pension benefit record/providers/employers/employees/employments/pensionbenefits/:pensionBenefitId__Activity name :__ PutPensionBenefitByPensionBenefitId __Metadata :__ No metadata
  • DELETEDelete a pension benefit record/providers/employers/employees/employments/pensionbenefits/:pensionBenefitId__Activity name :__ DeletePensionBenefitByPensionBenefitId Delete an existing pension benefit record
  • GETList pension benefit/providers/employers/employees/employments/:employmentId/pensionbenefits?filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name :__ GetPensionBenefitsByEmploymentId Get a list of the pension benefits of the employment. __Note:__ Loket.nl has different ways to register…
  • POSTAdd a pension benefit for an employment/providers/employers/employees/employments/:employmentId/pensionbenefits__Activity name :__ PostPensionBenefitByEmploymentId __Metadata :__ No metadata __Defaults :__ No default values

Actuals

  • GETList of actual organizational entities for an employer/providers/employers/:employerId/actualorganizationalentities?referenceDate=2022-01-01&filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name:__ GetActualOrganizationalEntitiesByEmployerId Get the list of actual organizational entities for an employer
  • GETList of actual wages for an employer/providers/employers/:employerId/actualwages?referenceDate=2022-01-01&filter=cancellationPeriodTimeUnit.key eq 4&orderBy=-companyName,address.houseNumber&pageNumber=2&pageSize=20__Activity name:__ GetActualWagesByEmployerId Get the list of actual wages for an employer

Showing 300 of 400 endpoints. Fork the collection to see all of them.

API details

Base URL
https://api.loket.nl/v2
https://api.loket-acc.nl/v2
Authentication
None declared in the description
Operations
641 operations on 407 pathsGET 340POST 111PUT 80DELETE 74PATCH 36
Main resources
Leave policy 21Payroll run downloads 12Employer 11Leave 11Concept employee 10Employee 10Employment 10User 10Absence 8Applicationsets 8
Response formats
application/json application/json;version=2018-01-01 application/json;version=2020-03-16 application/pdf
Description format
OpenAPI 3.0.2, API version V2
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Loket.nl API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Loket.nl API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Details of an Absence” (GET /providers/employers/employees/absences/:absenceId), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Loket.nl API?

Is this your first time here? Please check out our [introduction to Loket (API)](./Introduction) The initial loading time of this developer portal may be very… It is listed under Other and has 641 endpoints.

Who publishes the Loket.nl API?

It is listed from Loket's public API description (an OpenAPI document), not published by Loket on Swastik Codes. Anyone who controls loket.nl can claim the profile by adding a DNS TXT record.

What is the base URL of the Loket.nl API?

Its description lists 2 base URLs: https://api.loket.nl/v2, https://api.loket-acc.nl/v2. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Loket.nl API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Loket.nl API have?

641 operations on 407 paths (340 GET, 111 POST, 80 PUT, 74 DELETE, 36 PATCH). The largest groups are Leave policy, Payroll run downloads, Employer, Leave. This listing's collection holds the first 400.

Is forking the Loket.nl API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.