Collective leave

Post leave for multiple employments.

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

Post leave for a set of employments under an employer.

Metadata : There is no metadata endpoint for this resource.

Defaults : Defaults are available at /defaults.

post/v2/providers/employers/{employerId}/leave

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/{employerId}/leave
  • 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)

startDatestring date

The start date for the leave.

endDatestring date

The end date for the leave.

leaveTypeinteger

The id of the leavetype.

isAccrualboolean

Indicates whether the leave should be added(true) or subtracted(false).

numberOfUnitsnumber double

The amount of leave.

commentsstring nullable

Any comments on the leave.

Example request

[
  {
    "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "startDate": "2022-10-21",
    "endDate": "2022-10-22",
    "leaveType": 1,
    "isAccrual": true,
    "numberOfUnits": 4.5,
    "comments": "This leave is added."
  }
]

Response

OK. the specified leave is applied to the selected employments.

Changes

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