LOloket
Leave policy entitlement

Apply the entitlement for multiple employments

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

Starts a process that will calculate and apply the leave entitlement for a set of employments, given a leavepolicy and year.

patch/v2/providers/employers/{employerId}/employees/employments/leave/entitlement

Request

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

Path parameters

employerIdstring uuid required

The unique identifier of the employer

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required
Example:application/json;version=2018-01-01

The accept header is used to influence what type of output is returned and in most cases the version of the output

Request body

employmentIdstring uuid

The unique identifier of an object (GUID/UUID)

leavePolicyIdstring uuid

The unique identifier of an object (GUID/UUID)

yearinteger

The year

monthinteger nullable

The year

includeStatutoryLeaveboolean

Set to true to calculate and apply statutory leave

includeWtrLeaveboolean

Set to true to calculate and apply wtr leave

Example request

[
  {
    "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "leavePolicyId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "year": 2023,
    "month": 12,
    "includeStatutoryLeave": true,
    "includeWtrLeave": true
  }
]

Response

OK

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "submittedOn": "2023-05-08T15:16:49+02:00",
    "itemCount": {
      "processedWithError": 10,
      "processed": 75,
      "processedWithWarning": 15,
      "total": 100
    }
  }
}

Changes

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