LOloket
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

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/journalruns/initiate
  • Auth
    none required

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

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "sequenceNumber": 8,
    "payrollRun": {
      "payrollRunId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "payrollPeriod": {
        "year": 2017,
        "periodNumber": 1,
        "periodStartDate": "2018-01-01",
        "periodEndDate": "2018-01-31"
      },
      "sequenceNumberApproved": 6
    },
    "journalRunStatus": {
      "key": 4,
      "value": "Journaal gereed"
    },
    "requestTime": "2018-05-08T15:16:49+02:00",
    "processingFinishedTime": "2018-05-08T15:16:49+02:00",
    "requestedBy": {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "initials": "I",
      "prefix": "de",
      "lastName": "Jong",
      "formattedName": "Jong, I"
    },
    "removeTime": "2018-05-08T15:16:49+02:00",
    "removedBy": {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "initials": "I",
      "prefix": "de",
      "lastName": "Jong",
      "formattedName": "Jong, I"
    },
    "methodOfCreation": {
      "key": 2,
      "value": "Individueel"
    }
  }
}

Changes

No recorded changes to this operation across all 6 revisions of this API.