v3
latestOpenAPI 3.1.02026-07-311,0939714.5 MBInitiate payroll run (verlonen)
Activity name : <a href="https://developer.loket.nl/Activities/PostInitiatePayrollRunByPayrollAdministrationId" target="_blank">PostInitiatePayrollRunByPayrollAdministrationId</a> This is a controller endpoint to perform an action.<br><br>In the older Loket GUI this specific action is referred to as respectively 'Verlonen' / 'Verlonen periode zonder personeel' / 'Verlonen voorgaande jaren' . If this action is performed successfully then the payroll run will be created with status 0 and will be cued for further processing. The further processing depends on the input parameters and the payroll configuration in the given situation. After the initiated run has been picked up and processed by the background process, then the status of the run will be changed accordingly.<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><br>If typeOfInitiation = 'regular' (Verlonen);<br>* The very last payroll period for which an approved payroll run (status = 9) is available. Within the active year of payrolling. (This would functionally be a so-called 'correction' run)<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 the active year of payrolling, if available<br>* The provided year may be a maximum of 7 years in the past (based on current datetime)<br><br>If typeOfInitiation = 'withoutEmploymentData' (Verlonen zonder personeel);<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 the active year of payrolling<br>* Please note that if this type is selected then the following fields must ALL be set to null; sendEmailToEmployee, textPaySlip, textTariffPaySlip, textPayment, emailAdressPayrollRunStarted, emailFinishedPayrollRun<br><br>If typeOfInitiation = 'previousYear' (Verlonen voorgaande jaren);<br>* The very last payroll period for which an approved payroll run (status = 9) is available. Within the given year of payrolling. (This would functionally be a so-called 'correction' run)<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 the given year of payrolling, if available<br>* The provided year may be a maximum of 7 years in the past (based on current datetime)<br><br><br>In general;<br>* It is not possible to initiate a new payroll run if there is currently a payroll run with status 0 (to be processed) or 1 (awaiting approval) within the payroll administation.<br><br><br>Metadata : No metadata endpoint available for this controller endpoint.<br><br>Defaults : Defaults endpoint is available for this controller endpoint by adding /defaults. Also, an endpoint is available to retrieve initiation values for a specific period.
Path parameters
The unique identifier of an administration
Headers
A valid Bearer token for authorizing the request.
The accept header is used to influence what type of output is returned and in most cases the version of the output
Response
Accepted