--- title: "Add a payroll administration" method: POST path: "/v2/providers/employers/{employerId}/payrolladministrations" tags: ["Payroll administration"] --- # Add a payroll administration `POST /v2/providers/employers/{employerId}/payrolladministrations` ## Request - Base URL: `https://api.loket.nl` - URL: `https://api.loket.nl/v2/providers/employers/{employerId}/payrolladministrations` - Auth: none required __Activity name :__ PostPayrollAdministrationByEmployerId Add a payroll administration. ## Path parameters - `employerId` string, uuid, required ## Headers - `Authorization` string, required - `Accept` string, required ## Request body - PayrollAdministrationPost - `wageModel` WageModelPost: 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. - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `value` string - `firstPayrollYear` integer: The first year the wage model is/was active. - `currentPayrollYear` integer: Current year the wage model is active. - `cla` object: The CAO (CLA -> collective labor agrement) of the "loonmodel" the payroll administration is linked to. - `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 - `administrationNumber` string, nullable: The administration number is a free field commonly used to register the debtors number. - `groupCode` integer, nullable: Number (integer) used for grouping administrations. - `name` string: Name of the administration - `shortName` string, nullable: Shortened name of the administration - `description` string: Description of the administration - `withholdingParty` string, nullable: Deviating name of the administration for the payroll tax return - `groupClassification` GroupClassification, 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 - `payrollYear` integer: The first year the payroll administration is active. - `isInternalPayrollAdministration` boolean: Indicates if the payroll administration is used for internal payroll purposes. - `testYear` boolean: Indicates if the firstPayrollYear for the payroll administration is a test year. - `synchronize` Synchronize - `contactInformation` boolean: Synchronize contact information from employer to administration - `nameAndAddress` boolean: Synchronize name and address information from employer to administration - `address` Address - `street` string: Streetname of the address - `city` string: City of the address - `houseNumber` integer: House number of the address - `houseNumberAddition` string, nullable: An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number. - `furtherIndication` object, nullable - `key` integer: The key of the further indication. Possible values can be aquired via the metadata endpoint - `value` string: The description of the further indication, the possible values are "WW" and "AB" - `postalCode` string: The postal code of the address - `location` string, nullable: The location like to further specify the address - `country` object - `key` integer: The key for the country. Possible values can be aquired via the metadata endpoint - `value` string: The name of the country - `isoCode` string: The ISO 3166-1 alpha-2 value for the country - `province` object, nullable: A Dutch province - `key` integer, nullable: The key for the province. Possible values can be aquired via the metadata endpoint - `value` string, nullable: The name of the province. Only the Dutch provices are supported and not translated - `deviatingPostalAddress` DeviatingPostalAddress, nullable - `street` string, nullable: Streetname of the address - `city` string: City of the address - `houseNumber` integer, nullable: House number of the address - `houseNumberAddition` string, nullable: An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number. - `furtherIndication` object, nullable - `key` integer: The key of the further indication. Possible values can be aquired by the metadata endpoint - `value` string: The description of the further indication, the possible values are "WW" and "AB" - `postalCode` string, nullable: The postal code of the address, only nullable if country is not The Netherlands (NL). - `location` string, nullable: The location like to further specify the address - `country` object - `key` integer: The key for the country. Possible values can be aquired by the metadata endpoint - `value` string: The name of the country - `isoCode` string: The ISO 3166-1 alpha-2 value for the country - `poBox` integer, nullable: Post office box - `contact` Contact, nullable - `name` string, nullable: Name of the contact of the administration - `phoneNumber` string, nullable: The general phone number of the administration - `payrollTaxesNumber` string, nullable: The payroll tax number, loonheffingennummer, is the number that is used for the Loonaangifte for the Belastingdienst. - `wageTaxTableColor` WageTaxTableColor: The wage tax table color of the payroll administration. - `key` integer - `value` string - `premiumGroup` PremiumGroup, nullable: Premium group (premiegroep) of the payroll administration. - `key` integer - `value` string - `premiumGroupUszo` PremiumGroupUszo, nullable: Premium group uszo (premiegroep USZO) of the payroll administration. - `key` integer - `value` string - `methodOfCreationPayrollTaxReturn` MethodOfCreationPayrollTaxReturn, nullable: The method of creation of the payroll tax return. - `key` integer - `value` string - `annualPayrollTaxReturn` boolean: Indicates if the payroll administration uses an annual payroll tax return. - `payrollTaxReturnProcessedBy` PayrollTaxReturnProcessedBy, nullable: The application that is responsible for the processing (approve or reject) of the payroll tax return. - `key` integer - `value` string - `aofPremiumType` AofPremiumType: The AOF premium type of the payroll administration. - `key` integer - `value` string - `claTaxReturnCBSCode` integer: The CBS code of the CLA (NL: CAO nummer), which is used for payroll tax return purposes. If no CLA is applicable than use the value 9999. - `iban` string, nullable: IBAN - `totalSepaFile` boolean: Indicates if the total (a single instead of separate files) SEPA file is used. This is the file that is used for the payment of wages. - `payslip` Payslip - `template` object: The template of the payslip. This is a metadata field within the provider context. Possible values can be managed by the user. - `key` integer - `value` string - `displaySalutation` boolean: Display salutation on the payslip (yes or no). - `displaydisplayPayScale` boolean: Display pay scale on the payslip (yes or no). - `displayDepartment` boolean: Display department on the payslip (yes or no). - `addressLocation` object: The location of the address on the payslip. - `key` integer - `value` string - `employeeNumberDisplayMethod` object: The employee identification to use on the payslip. - `key` integer - `value` string - `functionDisplayMethod` object: The way the function is displayed on the payslip - `key` integer - `value` string - `hourlyWageDisplayMethod` object: The way the hourly wage is displayed on the payslip - `key` integer - `value` string - `employmentStartDateDisplayMethod` object: The employment start date to use on the payslip. - `key` integer - `value` string - `employeeNameDisplayMethod` object: The way the employee name is displayed on the payslip - `key` integer - `value` string - `defaults` Defaults - `mdvNotification` boolean: Indicate if a Mdv (melding dienstverband) should be send. - `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 - `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)! ## Response `201` Created - object: a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour. - `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 - `content` PayrollAdministrationPostResponse - `id` string, uuid: The unique identifier of an object (GUID/UUID) ## 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)