LOloket
Provider payroll administration reports

List of payslips per type for all payroll administrations of the provider

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

get/provider/providers/{providerId}/payrollAdministrations/Payslips

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/provider/providers/{providerId}/payrollAdministrations/Payslips
  • Auth
    none required

Path parameters

providerIdstring uuid required

The unique identifier of a provider

Query parameters

startDatestring required
Example:2020-08-01

The start date

endDatestring required
Example:2020-08-31

The end date

testYearboolean
Example:true

If set to true, only payroll periods that are part of a test year are included in the result. If set to false, only payroll periods not part of a test year are included in the result.

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": [
    {
      "employer": {
        "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "companyName": "Voorbeeld B.V.",
        "employerNumber": 20720,
        "administrationNumber": "SR2",
        "groupCode": 40
      },
      "payrollAdministration": {
        "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "name": "Voorbeeld B.V. - Payroll",
        "shortName": "ABC adm",
        "administrationNumber": "SR2",
        "clientNumber": 1234,
        "groupCode": 40,
        "groupClassification": {
          "key": 3,
          "value": "South"
        },
        "payrollPeriodType": {
          "key": 2,
          "value": "month"
        },
        "cla": {
          "key": 184,
          "value": "Agriculture"
        },
        "wagemodel": {
          "key": 184,
          "value": "Foresting monthly payrolling"
        }
      },
      "payrollPeriods": [
        {
          "year": 2025,
          "period": 1,
          "totalNumberOfPayslips": 10,
          "numberOfNormalPayslips": 8,
          "numberOfSpecialRatePayslips": 2,
          "numberOfRecalculatedPayslips": 1
        }
      ],
      "totalNumberOfPayslips": 100,
      "numberOfNormalPayslips": 80,
      "numberOfSpecialRatePayslips": 20,
      "numberOfRecalculatedPayslips": 1
    }
  ]
}

Changes

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