Sign in

v3

latestOpenAPI 3.1.02026-07-311,0939714.5 MB
Payroll administration process overview

Process Information about a payroll on administration level

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

Get an overview of the status and possible actions for the specified period, including the preceding and subsequent period. The overview contains information about: payroll runs, payroll tax return and pension. Metadata : Possible options for the query string parameters can be acquired (GET) via the /metadata endpoint. The URI for this endpoint is ../v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollprocessoverview/metadata.

Defaults : Default values for the query string parameters can be acquired via the /defaults endpoint. The URI for this endpoint is ../v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollprocessoverview/defaults.

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

Path parameters

payrollAdministrationIdstring uuid required

The unique identifier of an administration

Query parameters

payrollPeriodIdStartinteger required

The unique identifier of the first payroll period to return

payrollPeriodIdEndinteger

The unique identifier of the last payroll period to return

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