v3

latestOpenAPI 3.1.02026-07-311,0939714.5 MB
Payroll results

Get payroll results for the given payroll period

Activity name : <a href="https://developer.loket.nl/Activities/GetPayrollPeriodResultsByPayrollAdministrationIdAndPayrollPeriodId" target="_blank">GetPayrollPeriodResultsByPayrollAdministrationIdAndPayrollPeriodId</a> <br> <br><br>Returns the payroll results for the payroll period.<br><br>Note : This endpoint is related to the GetPayrollRunResultsByPayrollRunId endpoint.<br>Both endpoints return the same output just in a different way. This endpoint returns the current state of the payroll results for the given period where as GetPayrollRunResultsByPayrollRunId returns the payroll results for the given payroll run (a payroll run can contain payroll results for multiple payroll periods). It's possible for payroll results to be created after the end of the payroll period it zelf. For example, the payroll periode 01-2020 ends at 31-01-2020 (in case of a monthly payroll period) it is possible that the payroll run for period 07-2020 contains payroll results for the period 01-2020 due to a retroactivity change for that period. This change in the payroll run for payroll period 07-2020 would require the system to reaquire the results for period 01-2020 (as they changed).<br>

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

Path parameters

payrollAdministrationIdstring uuid required

The unique identifier of an administration

payrollPeriodIdinteger required

The unique identifier of the payroll period

Query parameters

payrollComponentsinteger[]

Can be used to filter what payroll components are returned. Cannot be used in combination with payrollComponentSet.

payrollComponentSetstring 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