Journal run

Download the journal run

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

Download a journal run to a journal application. Use the defaults and metadata to acquire the journal application settings.

post/v2/providers/employers/payrolladministrations/journalruns/{journalrunId}/download

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/payrolladministrations/journalruns/{journalrunId}/download
  • 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

Request body

datestring date

Date

includeCostCenterboolean

Indicates whether cost centers are included in the journal.

includeCostUnitboolean

Indicates whether cost units are included in the journal.

suspenseAccountstring nullable

The "number" for the suspense account (is a string)

Example request

{
  "date": "2022-01-01",
  "includeCostCenter": true,
  "suspenseAccount": "SAL-4000"
}

Response

OK

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "date": "2022-01-01",
    "includeCostCenter": true,
    "suspenseAccount": "SAL-4000"
  }
}

Changes

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