LOloket
Payroll results

Get the results of the given payroll period and the one before

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

Returns the results of given payroll period and the one before so a comparison can be made. Currently only the components 260, 495, 257 are returned

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

Request

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

Path parameters

payrollAdministrationIdstring uuid required

The unique identifier of an administration

Query parameters

payrollPeriodIdinteger required

The unique identifier of the payroll period

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": [
    {
      "payrollPeriod": {
        "year": 2017,
        "periodNumber": 1,
        "periodStartDate": "2018-01-01",
        "periodEndDate": "2018-01-31"
      },
      "numberOfPayrolledEmployments": 34,
      "payrollComponentResults": [
        {
          "payrollComponent": {
            "key": 1,
            "value": "Uren gewerkt",
            "category": {
              "key": 1,
              "value": "Uren"
            },
            "column": {
              "key": 6,
              "value": "Sociaalplichtig loon"
            },
            "costsEmployer": {
              "key": 1,
              "value": "+"
            }
          },
          "value": 40,
          "valueSpecialTariff": 144
        }
      ]
    }
  ]
}

Changes

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