v3

latestOpenAPI 3.1.02026-07-311,0939714.5 MB

Provider reports misc

Dossier Usage per employer.

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

Returns a list of all clients with their dossier metrics as of the referenceDate

get/qwoatermicroservice/providers/employers/dossier/usage

Query parameters

referenceDatestring date

Example:2022-01-01

Set a reference date for choosing the date dependent data.

Headers

Authorizationstring required

Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required

Example:responseType=async;text/csv

The accept header is used to influence what type of output is returned and in most cases the version of the output

The output of the endpoint is provided async. The default option is responseType=async;text/csv. Two options are supported:

responseType=async;text/csv
responseType=async;application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Response

Async download

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "BrokenBusinessRule",
      "description": "Invalid value for <field>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "transactionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
  }
}