LOloket
Journal run

Change the status of a journal run

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

Update the status of a journal run

  • Action 'markAsSuccessfullyExported'; will change the status of the journal run to 'exported'. Please note this action will not perform an actual export, but simply allows the user the manage status to match their actualities.</br>
  • Action 'MarkAsProcessingFailed'; will change the status of the journal run to 'export failed'. Please note this action will not perform an actual export, but simply allows the user the manage status to match their actualities.
patch/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

Request body

action'MarkAsProcessed' | 'MarkAsProcessingFailed'

The action to perform on the journal run

  • MarkAsProcessed --> (from the Loket point of view) Indicates that the client successfully processed the data (indicating that the results were imported in the financial application).
  • MarkAsProcessingFailed --> (from the Loket point of view) Indicates that the client was unable to process the results. Use the message field to communicate the error(s).
messagestring nullable

Message to be displayed to the Loket user

Example request

{
  "application": {
    "key": 2,
    "value": "Financieel pakket 1"
  }
}

Response

OK

contentobject

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ]
}

Changes

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