--- title: "Perform a wage projection based on a default CLA configuration" method: POST path: "/v2/providers/employers/employees/employments/{employmentId}/wageprojection/basedOnDefaultClaConfiguration" tags: ["Wage projection"] --- # Perform a wage projection based on a default CLA configuration `POST /v2/providers/employers/employees/employments/{employmentId}/wageprojection/basedOnDefaultClaConfiguration` ## Request - Base URL: `https://api.loket.nl` - URL: `https://api.loket.nl/v2/providers/employers/employees/employments/{employmentId}/wageprojection/basedOnDefaultClaConfiguration` - Auth: none required __Activity name :__ PostWageprojectionBasedOnDefaultClaConfigurationByEmploymentId This endpoint can be used to calculate a wage projection based on a default collective labor agreement (CLA) configuration. The input fields allow for certain customizations. __Metadata :__ No metadata endpoint available for this controller endpoint. __Defaults :__ No defaults endpoint available for this controller endpoint. ## Path parameters - `employmentId` string, uuid, required ## Headers - `Authorization` string, required - `Accept` string, required ## Request body - ClaWageProjectionInput - `grossWage` number, double: The grosswage per payroll period - `hoursPerWeek` number, double: The hours per week te be used in the wage calculation. Please note that currently this endpoint will always calculate as if the hours provided are full time hours. - `dateOfBirth` string, date: The date of birth - `holidayAllowance` object, nullable - `percentage` number: The percentage for the holiday bonus (vakantiegeld) - `resultPayrollComponent` object - `key` integer: The number for the payroll component. This number has meaning to payroll professionals using Loket who often know many of them by heart. - `additionalPayrollPeriod` object, nullable - `percentage` number: The percentage for the additional payroll period wage the employment receives (13e maand / extra periode loon / winstuitkering) - `resultPayrollComponent` object: A payroll component. These components are the core of the wage calculation software. `payrollComponents` is a metadata field within the payroll administration, loonmodel and cao context. Possible values can be managed by the user. - `key` integer: The number for the payroll component. This number has meaning to payroll professionals using Loket who often know many of them by heart. - `applyPayrollTaxDeduction` boolean, nullable: Indicates whether payroll tax deduction is to be applied (loonheffingskorting) - `companyCar` object, nullable - `fiscalAddition` number: The fiscal addition to the wage for the given `fiscalAdditionPeriod` for the lease/company car - `fiscalAdditionPeriod` 'Year' | 'payrollPeriod': Periodicity of the `fiscalAddition` - `deductions` object, nullable - `net` number, nullable: The net deduction from the wage - `gross` number, nullable: The gross deduction from the wage - `payments` object, nullable - `net` number, nullable: The net payment added to the wage - `gross` number, nullable: The gross payment added to the wage - `deviations` object, nullable: Deviations allow the user to calculate the difference between the current wage and the wage after certain deviations. If no deviations are required set the object to NULL - `grossWagePercentageChange` number, nullable: The percentage change used in wage calculations. - `hoursPerWeek` number, nullable: The hours per week used in wage calculations. - `calculateUsingNextYearsValues` boolean, nullable: If set to true the wage projection will use the (government) salary values of the next payroll year to calculate the wages. This gives some insight in what the employments wages will do next year based on the government's tax plans." ## Response `200` OK - 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` PayrollResults - `employmentId` string, uuid: The unique identifier of an object (GUID/UUID) - `payrollPeriods` object[] - `payrollPeriod` object - `year` integer: The year of the payroll period the record relates to - `periodNumber` integer, nullable: The period number of the payroll period the record relates to - `periodStartDate` string, date: The first day of the period for which the tax return message was created - `periodEndDate` string, date: The last day of the period for which the tax return message was created - `testYear` boolean: Indicates whether the payroll periode is part of a test year. In Loket it is possible to run a year of a payrollAdministration as a so-called test year. This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data. - `payslipTypes` object[] - `payslipType` object: The type of payslip on which underlying payroll run results will be booked. This is either normaal or bijzonder tarief. - `key` integer - `value` string - `payrollComponentResults` object[] - `payrollComponent` object: A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment. `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user. - `key` integer: The number for the payroll component. This number has meaning to payroll professionals using Loket who often know many of them by heart. - `value` string: The description of the payroll component - `category` object: The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc. - … - `column` object: The wage sheet column (kolom) of the payroll component. Kolommen are related to its specific lines on the payslip and/or wage sheet. Also this does bear some similiarties to wage sheets columns (loonstaatkolommen) used by the Belastingdienst, however the division of columns as used by Loket is not identical to that. - … - `costsEmployer` object, nullable: Indicates whether the components are costs for the employer (+) or negative costs (-, i.e. benefit) for the employer. The value could also be NULL meaning that the component is not related to actual expenses. - … - `value` number: Value/ amount (normaal tarief voor belasting, tabelloon) for the payrollcomponent. Only a 'normal' type payslip may have value for this. - `valueSpecialTariff` number: Value/ amount (speciaal tarief voor belasting) for the payrollcomponent. Both a 'normal' and 'special tariff' type payslip may a value for this. Also, both valueNormal and valueSpecialTariff may have a value at the same time. ## 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)