LOloket
Payroll results

Payroll results for several periods

Activity name : <a href="https://developer.loket.nl/Activities/GetPayrollResultsByPayrollAdministrationId" target="_blank">GetPayrollResultsByPayrollAdministrationId</a> <br> <br><br>Returns the payroll results and information on the employments for all payrollruns in a given period or periods. The results are grouped by period.<br><br>Note : This endpoint is related to the GetPayrollRunResultsByPayrollRunId endpoint.<br><br>Note : This endpoint replaces the 'Export loonresultaten' report.<br>

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

Request

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

Path parameters

payrollAdministrationIdstring uuid required

The unique identifier of an administration

Query parameters

payrollPeriodIdStartinteger required

The unique identifier of the payroll period

payrollPeriodIdEndinteger required

The unique identifier of the payroll period

payrollComponentSetIdstring uuid

A predefined set of payroll components to filter what payroll components are returned

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": {
        "employerNumber": 20720,
        "companyName": "Voorbeeld B.V."
      },
      "payrollAdministration": {
        "clientNumber": 1234
      },
      "employee": {
        "employeeNumber": 156,
        "formattedName": "Wiel - van Bergen S.L. van de",
        "gender": "female",
        "dateOfBirth": "1995-05-21"
      },
      "employment": {
        "startDate": "2018-01-01",
        "endDate": "2018-10-23",
        "payrollId": 2,
        "organizationalEntity": {
          "department": {
            "code": 2,
            "description": "Verkoop"
          },
          "function": {
            "code": 2,
            "description": "Directeur"
          },
          "distributionUnit": {
            "code": 2,
            "description": "Sales"
          }
        },
        "workinghours": {
          "shift": {
            "fullTimeHoursPerWeek": 40
          },
          "deviatingHoursPerWeek": 32
        }
      },
      "payrollPeriod": {
        "year": 2017,
        "periodNumber": 1
      },
      "payrollResults": {
        "payrollComponent": {
          "key": 1,
          "value": "Uren gewerkt",
          "category": {
            "key": 1,
            "value": "Uren"
          },
          "column": {
            "key": 6
          },
          "costsEmployer": {
            "key": 1,
            "value": "+"
          }
        },
        "value": 40,
        "valueSpecialTariff": 144
      }
    }
  ]
}

Changes

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