LOloket
Payroll periods

List of all available payroll periods and runs

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

Returns a list of all payroll periods available for the given payroll administration

get/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods
  • Auth
    none required

Path parameters

payrollAdministrationIdstring uuid required

The unique identifier of an administration

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
    }
  ],
  "_embedded": [
    {
      "id": 202001,
      "year": 2020,
      "periodNumber": 1,
      "startDate": "2020-01-01",
      "endDate": "2020-01-31",
      "automaticProcessing": {
        "createPayrollRunOn": "2020-01-18",
        "approvePayrollRunOn": "2020-01-23"
      },
      "payrollPeriodType": {
        "key": 2,
        "value": "month"
      },
      "payrollRuns": [
        {
          "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
          "payrollRunStatus": {
            "key": 9,
            "value": "Verloning goedgekeurd."
          },
          "sequenceNumber": 1,
          "sequenceNumberApproved": 3,
          "journalRuns": [
            {
              "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
              "sequenceNumber": 8,
              "journalRunStatus": {
                "key": 4,
                "value": "Journaal gereed"
              }
            }
          ]
        }
      ]
    }
  ]
}

Changes

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