LOloket
Leave balance

Summed up leave balance total and grouped by

Activity name : <a href="https://developer.loket.nl/Activities/GetLeaveBalancesGroupedByEmployerId" target="_blank">GetLeaveBalancesGroupedByEmployerId</a> <br/> <br/> Returns the yearly leave balances total per leave type and total per groupBy

get/v2/providers/employers/{employerId}/leavebalances/grouped

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/{employerId}/leavebalances/grouped
  • Auth
    none required

Path parameters

employerIdstring uuid required

The unique identifier of the employer

Query parameters

referenceDatestring date
Example:2020-12-31

Set a reference date for the following logic

  1. To determine the active function and department of the employment
  2. To calculate usageAfterToday and usageThroughToday
  3. To determine the year for which the leave balance is returned

If not provided, "today" is used

leaveTypeinteger[]

Select which leaveType will be returned. Based on the provided 'leaveType.key'(s)

If not provided, the leaveType 16 (Verlof) is returned (16 is the sum of leaveType 1 (bovenwettelijk verlof) and 15 (wettelijk verlof))

orderBystring
Example:-companyName,address.houseNumber

Order the collection on one or more fields

pageNumberinteger
Example:2

Specifies which page should be returned

pageSizeinteger
Example:20

Specifies the number of objects per page

groupBy'Department' | 'Function' required

Select the groupBy

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

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

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

Response

OK

totalSizeinteger

Total number of records, taking into account the given filter.

pageSizeinteger

Number of records in the response

totalPagesinteger

Number of pages available

currentPageinteger

Current page returned in the response

Example response

{
  "totalSize": 650,
  "pageSize": 250,
  "totalPages": 3,
  "currentPage": 2,
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "totals": [
      {
        "year": 2019,
        "leaveType": {
          "key": 1,
          "value": "Verlof (bovenwettelijk)",
          "balanceExceedsYear": true
        },
        "balancePreviousYear": 20,
        "accrual": 30,
        "usageTotal": 10,
        "usageThroughReferenceDate": 8,
        "usageAfterReferenceDate": 2,
        "balance": 40
      }
    ],
    "groups": [
      {
        "group": {
          "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
          "description": "Verkoop Binnendienst"
        },
        "year": 2019,
        "leaveType": {
          "key": 1,
          "value": "Verlof (bovenwettelijk)",
          "balanceExceedsYear": true
        },
        "balancePreviousYear": 20,
        "accrual": 30,
        "usageTotal": 10,
        "usageThroughReferenceDate": 8,
        "usageAfterReferenceDate": 2,
        "balance": 40
      }
    ]
  }
}

Changes

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