Sign in

v3

latestOpenAPI 3.1.02026-07-311,0939714.5 MB
Year-end statement at administration level

Download year-end statement of a payroll administration for a year

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

Availability: This is endpoint is available for the Loket application only. It is not available for external parties

Download the year-end statements of a payroll administration (of its underlying employment) for a year.

The year-end statements at administration level are effectively a collection of year-end statements for its underlying employments. With this endpoint it may also be required at the administration level in one call.

Please note: this endpoint may only be used to acquire a report in the pdf-type format

get/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/yearendstatements/{year}

Path parameters

payrollAdministrationIdstring uuid required

The unique identifier of an administration

yearinteger required
Example:2018

The payroll year

Query parameters

includeEmployeeSelfServiceboolean

If true; then the year-end statements for employments of which the employee has access to the employee self service module will be included in the response. If false; this specific group will be excluded.

includeEmploymentsWithMijnLoketAccessboolean

Indicates whether to include employments for which the employee has access to Mijn Loket. Possible values for this parameter are:

  • true: Include employments with Mijn Loket access(All employments)
  • false: Exclude employments with Mijn Loket access

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