LOloket
Journal run

Details of a journal run

Activity name : <a href="https://developer.loket.nl/Activities/GetJournalRunByJournalRunId" target="_blank">GetJournalRunByJournalRunId</a>

Returns the details of a journal run. </br>

get/v2/providers/employers/payrolladministrations/journalruns/{journalrunId}

Request

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

Path parameters

journalrunIdstring uuid required

The unique identifier of the payroll run

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

OK

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.