v3

latestOpenAPI 3.1.02026-07-311,0939714.5 MB
Journal run

Initiate journal run (journaliseren)

Activity name : <a href="https://developer.loket.nl/Activities/PostInitiateJournalRunByPayrollAdministrationId" target="_blank">PostInitiateJournalRunByPayrollAdministrationId</a> This is a controller endpoint to perform an action.<br><br>In the older Loket GUI this specific action is referred to as 'journaliseren' If this action is performed successfully the journal run will be created with status 0 and will be queud for processing. 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>* The payroll period is less then 7 years in the past<br>* There is a journal profile configured for the given payroll period<br>* There is an approved payroll run for the given payroll period that has no other journalruns except for failed or removed journalruns<br>* All the payroll runs are processed in order so in order to start a journalrun the previous payrollrun (that should have a journalrun) has to have a successful journal run in order to start the next one<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.

post/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/journalruns/initiate

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

Accepted