--- title: "List of payroll administrations configurations for an employer" method: GET path: "/v2/providers/employers/{employerId}/payrolladministrations/configurations" tags: ["Payroll administration"] --- # List of payroll administrations configurations for an employer `GET /v2/providers/employers/{employerId}/payrolladministrations/configurations` ## Request - Base URL: `https://api.loket.nl` - URL: `https://api.loket.nl/v2/providers/employers/{employerId}/payrolladministrations/configurations` - Auth: none required __Activity name :__ GetPayrollAdministrationConfigurationsByEmployerId Get a list of all payroll administration configurations for an employer ## Path parameters - `employerId` string, uuid, required ## Query parameters - `filter` string - `orderBy` string - `pageNumber` integer - `pageSize` integer ## 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` PayrollAdministrationConfiguration[] - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `description` string: Description of the administration - `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. - `startDate` string, date: The first day the administration is active. - `endDate` string, date, nullable: The last day the administration is active. - `payrollPeriodType` object: Indicates the frequence of the payrolling process. - `key` integer - `value` string - `holidayAllowanceBaseForCalculation` object: holidayAllowanceBaseForCalculation - `key` integer - `value` string - `yearEndBaseForCalculation` object: yearEndBaseForCalculation - `key` integer - `value` string - `holidayAllowancePercentage` number, double: The percentage of the holidayAllowance. - `yearEndPercentage` number, double: The percentage of the year end bonus. - `synchronize` object - `contactInformation` boolean: Synchronize contact information from employer to administration - `nameAndAddress` boolean: Synchronize name and address information from employer to administration - `defaults` object - `employmentDurationType` object: A selection of pre defined durations for the employment. - `key` integer - `value` string - `typeOfEmployee` object: A selection of pre defined employee-types for the employment. - `key` integer - `value` string - `employmentContractType` object: The type of employment applicable for the employment. - `key` integer - `value` string - `grossWageType` object: Indicates whether the `grossWage` is an hourly wage or a Periodic wage. Periodic can represent a week, four weeks or a month. Which period is active for the employment can be found in wagePeriodType. - `key` integer - `value` string - `netWageType` object: Indicates whether the net wage is an hourly wage or a periodic wage. Periodic can represent a week, four weeks or a month. Which period is active for the employment can be found in the payroll administration resource. - `key` integer - `value` string - `mdvNotification` boolean: Indicate if a Mdv (melding dienstverband) should be send. - `calculateUsingWorkPattern` object: Indications in this objects determine whether specific values should be calculated based on the bi-weekly workPattern (specified in the `workPattern` object). - `hoursBrokenPeriod` boolean: Indicates whether the hours for the payrolling should be calculated based on the workpattern in broken periods. These are periods of in or out of service. - `hoursRegularPeriod` boolean: Indicates whether the hours for the payrolling should be calculated based on the workpattern for regular periods. - `daysDailyRate` boolean: Indicates whether the number of days of dailyrate should be calculated based on the workpattern. The number of days are normally calculated by the working hours. - `deviatingDaysAndHours` boolean: Indication whether the deviating hours per week and deviating SV-days per period are to be automatically calculated based on the workpattern. Please note (!) that any values in the deviatingHoursPerWeek and deviatingSvDaysPerPeriod fields (of this workingHours record) will be overwritten based on this calculation if true (and endDate=NULL)! - `payslipAvailableForEmployeeDay` integer: The default day (number) of the period on which payslips will be made available for employees. - `componentSet` object - `payrollPeriodDataCollectiveCategory` object, nullable: The default category for the browser variabele gegevens. Either this field or the payrollPeriodDataCollectiveComponentSet field can be filled. - `key` integer - `value` string - `payrollPeriodDataCollectiveComponentSet` object, nullable: The default exportset for the browser variabele gegevens. Either this field or the payrollPeriodDataCollectiveCategory field can be filled. - `id` string, uuid - `description` string - `registrationLevel` 'provider' | 'employer': The level at which the set is defined. - `payrollPeriodDataIndividual` object, nullable - `id` string, uuid - `description` string - `registrationLevel` 'provider' | 'employer': The level at which the set is defined. - `payrollPeriodDataLeave` object, nullable - `id` string, uuid - `description` string - `registrationLevel` 'provider' | 'employer': The level at which the set is defined. - `payrollPeriodDataWerkkosten` object, nullable - `id` string, uuid - `description` string - `registrationLevel` 'provider' | 'employer': The level at which the set is defined. - `payrollPeriodDataEmployeeSelfService` object, nullable - `id` string, uuid - `description` string - `registrationLevel` 'provider' | 'employer': The level at which the set is defined. ## 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)