--- title: "List modules per employer for all employers of the provider" method: GET path: "/provider/providers/{providerId}/employers/modules" tags: ["Provider employer reports"] --- # List modules per employer for all employers of the provider `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 __Activity name :__ GetEmployersModulesByProviderId ## Path parameters - `providerId` string, uuid, required ## Query parameters - `modules` string[], required - `moduleIds` string[] ## Headers - `Authorization` string, required - `Accept` string, required ## Response `200` OK - object: a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour. - `totalSize` integer: Total number of records, taking into account the given filter. - `pageSize` integer: Number of records in the response - `totalPages` integer: Number of pages available - `currentPage` integer: Current page returned in the response - `version` Version - `obsoleteDate` string, date, nullable: The date (can be null) on which the `resourceVersion` is no longer supported/available - `resourceVersion` string, date: The resource version of the object in the response - `messages` object[] - `type` string: Indication of the type of message. See [the general documentation for more information](./#section/Response/Messages) - `description` string: Describes the message - `id` string, uuid, nullable: In some cases when the message may relate to a specific entity, or specific group of entities, this field provides the identifier of that entity - `code` integer: Identifying code for the message - `properties` string[]: An array that can contain additional information - `_embedded` ModulesEmployersReport[] - `employer` Employer2 - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `companyName` string: Name of the company - `employerNumber` integer: The employer number is used in various overviews and exports to identify a specific employer in Loket (please note: this is not the identifier used in the REST API). - `administrationNumber` string, nullable: A free field that is most commonly used to store the Debtors Number the provider uses for the employer. This field is used as a key field in some of the existing SOAP webservices. - `groupCode` integer, nullable: The groupcode is used for grouping employers. It is used for filtering output and processes (only include employers in group 40 in this report). - `payrollAdministration` PayrollAdministration, nullable - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `name` string: The name of the payroll administration. This is the name that is used in the Loket interface. - `shortName` string, nullable: Shortened name of the administration - `administrationNumber` string, nullable: A free field that is most commonly used to store the Debtors Number the provider uses for the employer. This field is used as a key field in some of the existing SOAP webservices. - `clientNumber` integer: The client number is a unique number for administrations that are used for payrolling. This field has no value if the administration is not used for payrolling. - `groupCode` integer, nullable: The groupcode is used for grouping employers. It is used for filtering output and processes (only include employers in group 40 in this report). - `groupClassification` object, nullable: The group classification for the payroll administration. This field is used for filtering and grouping within the interface. `groupClassification` is a metadata field within the provider context. Possible values can be managed by the user. - `key` integer - `value` string - `payrollPeriodType` object: Indicates the frequence of the payrolling process. Payrolling can be done on a montly (key 1), 4-weekly (key 3) or weekly basis (key 4). - `key` integer - `value` string - `cla` object: The CAO (CLA -> collective labor agrement) of the "loonmodel" the payroll administration is linked to. - `key` integer - `value` string - `wagemodel` object: The "loonmodel" (this is a Loket term) the payroll administration inherits the payrolling configuration from. Deviating from the loonmodel configuration on payrol administration level is possible. `loonmodel` is a metadata field within the provider context. Possible values can be managed by the user. - `key` integer - `value` string - `moduleSet` object, nullable: The module set is a collection of modules. It contains the id and description of the module set. It is prosible to deviate for the set by manualy enabling of disabling modules. - `id` string, uuid: The unique identifier of the module set (GUID/UUID) - `description` string - `modules` object[] - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `description` string - `number` number: the module number - `isEnabled` boolean: Indicates whether the module is enabled for the employer. - `userHasAccess` boolean: Indicates whether the user has access to the module for the employer. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `404`: Not Found - `500`: Internal Server Error --- [API](https://skmtc.dev/loket/apis/loket-api.md) - [All operations](https://skmtc.dev/loket/apis/loket-api/llms.txt) - [OpenAPI document](https://skmtc.dev/loket/apis/loket-api/revisions/32170564148f?raw)