LOloket
Journal run results

Get journal results for a journal run

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

Returns the journal run results for the journal run. Journal runs with journalRunStatus = 0,1,2,3 dont have results and this endpoint will return an error if called for a journal run with that status.

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

Request

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

Path parameters

journalrunIdstring uuid required

The unique identifier of the payroll run

Query parameters

consolidate'BasedOnLedgerAccountConfiguration' | 'Always' | 'Never'

Dictates how the output is consolidated

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

totalSizeinteger

Total number of records, taking into account the given filter.

pageSizeinteger

Number of records in the response

totalPagesinteger

Number of pages available

currentPageinteger

Current page returned in the response

Example response

{
  "totalSize": 650,
  "pageSize": 250,
  "totalPages": 3,
  "currentPage": 2,
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "_embedded": [
    {
      "generalLedgerAccount": {
        "key": 4,
        "code": "4002020",
        "description": "Cars"
      },
      "costCenter": {
        "key": 2,
        "code": "SAL073",
        "description": "Sales Den Bosch"
      },
      "costUnit": {
        "key": 2,
        "code": "01",
        "description": "Cars"
      },
      "payrollComponent": {
        "key": 286,
        "description": "KINDEROPV.BEL"
      },
      "debetAmount": 500.87
    }
  ]
}

Changes

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