LOloket
Payroll process status

Payroll status for each administration.

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

Returns an array of payrollAdministrations. Each object contains information about the payrolladministration and the payroll run status for an payroll period.

get/v2/providers/employers/payrolladministrations/payrollperiods/{payrollPeriodId}/payrollruns/status

Request

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

Path parameters

payrollPeriodIdinteger required

The unique identifier of the payroll period to return.

Query parameters

filterstring
Example:cancellationPeriodTimeUnit.key eq 4

Filter the collection

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

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": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "employerLogo": "https://api.loket.nl/v2/v2/providers/employers/{guid}/logo/{version}",
      "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "name": "VST Consultancy",
      "administrationNumber": "134.26.94",
      "description": "VST Consultancy",
      "clientNumber": 465,
      "payrollPeriodType": {
        "key": 2,
        "value": "month"
      },
      "cao": {
        "key": 115,
        "value": "18 Vishandel"
      },
      "loonmodel": {
        "key": 929,
        "value": "Vishandel monthly payrolling"
      },
      "groupClassification": {
        "key": 3,
        "value": "South"
      },
      "groupCode": 40,
      "shortName": "VST",
      "payrollPeriod": {
        "year": 2020,
        "periodNumber": 4,
        "payrollPeriodId": 202004,
        "periodStartDate": "2020-04-01",
        "periodEndDate": "2020-06-30"
      },
      "payroll": {
        "methodOfCreation": {
          "key": 2,
          "value": "Individueel"
        },
        "automaticStartDate": "2025-01-18",
        "automaticApproveDate": "2025-01-25",
        "status": {
          "key": 6,
          "value": "geannuleerde loonrun"
        },
        "possibleActions": {
          "value": "None"
        }
      },
      "numberOfUnreadNotifications": 2,
      "numberOfUnreadUnexpiredAnnouncements": 2
    }
  ]
}

Changes

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