v3

latestOpenAPI 3.1.02026-07-311,0939714.5 MB
Initialise Payroll Period

Initialise Payroll Period (automatische processen)

Activity name : <a href="https://developer.loket.nl/Activities/PostInitialisePayrollPeriodByPayrollAdministrationId" target="_blank">PostInitialisePayrollPeriodByPayrollAdministrationId</a> This is a controller endpoint to perform an action.<br><br><br>In the older Loket GUI this specific action is referred to as 'Automatische processen activeren'. If this action is performed for the chosen payroll period then certain calculations will be performed on the background. The execution depends on the input parameters and the payroll configuration in the given situation.<br><br><br>This action may be performed for all payroll periods that are available for the payroll administration AND that meet one of the following requirements;<br>* Payroll periods for which an approved payroll run (status = 9) is available<br>* The very first payroll period in time that does not yet have an approved payroll run(i.e. last payroll period with approved run + 1). Within each year, if available.<br><br>In practice, in many instances the second option will be most relevant. Please note that if the action is performed for a year that is not the current active year of payrolling, then the resulting changes may not be fully processed in regards to the full payroll process.<br><br><br>Metadata : No metadata endpoint available for this controller endpoint.<br><br>Defaults : Defaults endpoint is available for this controller endpoint.

post/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods/initialise

Path parameters

payrollAdministrationIdstring uuid required

The unique identifier of an administration

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

Created