LOloket
Provider employer reports

List modules per employer for all employers of the provider

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

get/provider/providers/{providerId}/employers/modules

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/provider/providers/{providerId}/employers/modules
  • Auth
    none required

Path parameters

providerIdstring uuid required

The unique identifier of a provider

Query parameters

modulesstring[] required

Allows the user to filter the modules.

If the option "All" is selected, all modules are returned. If "None" is selected, no modules are returned. If "Selection" is selected, only the modules that are supplied in the moduleIds querystring parameter are returnd. If "OnlyEnabled" is selected, only the modules that are enabled for the employer are returned.

moduleIdsstring[]

A comma separated list of module ids to filter the modules on. This parameter is only used when the module querystring parameter is set to "Selection".

[
  "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
]

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": [
    {
      "employer": {
        "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "companyName": "Voorbeeld B.V.",
        "employerNumber": 20720,
        "administrationNumber": "SR2",
        "groupCode": 40
      },
      "payrollAdministration": {
        "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "name": "Voorbeeld B.V. - Payroll",
        "shortName": "ABC adm",
        "administrationNumber": "SR2",
        "clientNumber": 1234,
        "groupCode": 40,
        "groupClassification": {
          "key": 3,
          "value": "South"
        },
        "payrollPeriodType": {
          "key": 2,
          "value": "month"
        },
        "cla": {
          "key": 184,
          "value": "Agriculture"
        },
        "wagemodel": {
          "key": 184,
          "value": "Foresting monthly payrolling"
        }
      },
      "moduleSet": {
        "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "description": "Personeelsregistratie"
      },
      "modules": [
        {
          "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
          "description": "Personeelsregistratie",
          "number": 40,
          "isEnabled": true
        }
      ],
      "userHasAccess": true
    }
  ]
}

Changes

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