v3

latestOpenAPI 3.1.02026-07-311,0939714.5 MB

Payroll results

Compare payrollresults for two payrollperiods at providerlevel

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

Returns the results of two given payroll periods and a comparison between them.

get/v2/providers/employers/payrolladministrations/payrollperiods/payrollresults/compare

Query parameters

payrollPeriodIdToCompareinteger required

The unique identifier of the base payroll period

payrollPeriodIdCompareTointeger required

The unique identifier of the payroll period to which the base payroll period is compared

payrollComponentIdinteger required

The component id

tableTariff'table' | 'tariff' | 'tableAndTariff' required

Indicates whether the table and/or tariff values should be included in the response.

includeFromDeviationPercentagenumber double required

Example:3.14

Indicates from deviation percentage results should be included in the response. When set to 0, all results are included.

sort'employerName' | 'administrationName' | 'clientNumber' | 'administrationNumber' | 'percentageDifference' required

Indicates on which field the results should be sorted. Default is on the payroll component.

Headers

Authorizationstring required

Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required

Example:responseType=async;text/csv

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

The output of the endpoint is provided async. The default option is responseType=async;text/csv. Two options are supported:

responseType=async;text/csv
responseType=async;application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Response

Async download

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "BrokenBusinessRule",
      "description": "Invalid value for <field>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "transactionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
  }
}