--- title: "Initiate journal run (journaliseren)" method: POST path: "/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/journalruns/initiate" tags: ["Journal run"] --- # Initiate journal run (journaliseren) `POST /v2/providers/employers/payrolladministrations/{payrollAdministrationId}/journalruns/initiate` ## Request - Base URL: `https://api.loket.nl` - URL: `https://api.loket.nl/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/journalruns/initiate` - Auth: none required __Activity name :__ PostInitiateJournalRunByPayrollAdministrationId This is a controller endpoint to perform an action.

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.

This action may be performed for all payroll periods that are *available for the payroll administration* AND that meet one of the following requirements;
* The payroll period is less then 7 years in the past
* There is a journal profile configured for the given payroll period
* There is an approved payroll run for the given payroll period that has no other journalruns except for failed or removed journalruns
* 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

__Metadata :__ No metadata endpoint available for this controller endpoint.

__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 - `payrollAdministrationId` string, uuid, required ## Headers - `Authorization` string, required - `Accept` string, required ## Response `202` Accepted - object: a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour. - `version` Version - `obsoleteDate` string, date, nullable: The date (can be null) on which the `resourceVersion` is no longer supported/available - `resourceVersion` string, date: The resource version of the object in the response - `messages` object[] - `type` string: Indication of the type of message. See [the general documentation for more information](./#section/Response/Messages) - `description` string: Describes the message - `id` string, uuid, nullable: In some cases when the message may relate to a specific entity, or specific group of entities, this field provides the identifier of that entity - `code` integer: Identifying code for the message - `properties` string[]: An array that can contain additional information - `content` JournalRun - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `sequenceNumber` integer: Ascending sequence number over ALL journal runs for the payroll administration. - `payrollRun` object - `payrollRunId` string, uuid: The unique identifier of an object (GUID/UUID) - `payrollPeriod` PayrollPeriod2 - `year` integer: The year of the payroll period the record relates to - `periodNumber` integer, nullable: The period number of the payroll period the record relates to - `periodStartDate` string, date: The first day of the period for which the tax return message was created - `periodEndDate` string, date: The last day of the period for which the tax return message was created - `testYear` boolean: Indicates whether the payroll periode is part of a test year. In Loket it is possible to run a year of a payrollAdministration as a so-called test year. This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data. - `sequenceNumberApproved` integer: Ascending sequence number related to an approved payrol run. A payroll run may have more than one journal run. With this number the journal run may be linked to the specific payroll run. - `journalRunStatus` object - `key` integer: Possible values for the payroll run status are; * 0 Staat klaar voor journaliseren * 1 Geen journaal resultaten * 2 Fout bij aanmaken * 3 Verwijderd door gebruiker * 4 Journaal gereed * 5 Wordt geëxporteerd * 6 Exporteren mislukt * 7 Journaal geëxporteerd - `value` string: The value describing the current status of the payroll run. - `requestTime` string, date-time: The time at which the payroll run was requested by the user - `processingFinishedTime` string, date-time, nullable: The time at which at which the journal run was finished processing - `requestedBy` UserBasicNotNullable - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `initials` string: The initials of the user - `prefix` string, nullable: The prefix of the user - `lastName` string: The last name of the user - `formattedName` string: preformated user name for displaying. \\", \"\\" \"\ - `removeTime` string, date-time, nullable: The time at which the journal run was removed. - `removedBy` UserBasic, nullable - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `initials` string: The initials of the user - `prefix` string, nullable: The prefix of the user - `lastName` string: The last name of the user - `formattedName` string: preformatted user name for displaying. \\", \"\\" \"\ - `methodOfCreation` object: Method by which the creation of the journal run was triggered. - `key` integer - `value` string ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `404`: Not Found - `500`: Internal Server Error --- [API](https://skmtc.dev/loket/apis/loket-api.md) - [All operations](https://skmtc.dev/loket/apis/loket-api/llms.txt) - [OpenAPI document](https://skmtc.dev/loket/apis/loket-api/revisions/32170564148f?raw)