LOloket
Wage projection

Perform a wage projection based on a default CLA configuration

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

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.

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

Path parameters

employmentIdstring uuid required

The unique identifier of the employment

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

Request body

grossWagenumber double

The grosswage per payroll period

hoursPerWeeknumber 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.

dateOfBirthstring date

The date of birth

applyPayrollTaxDeductionboolean nullable

Indicates whether payroll tax deduction is to be applied (loonheffingskorting)

calculateUsingNextYearsValuesboolean 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."

Example request

{
  "grossWage": 3500,
  "hoursPerWeek": 24.5,
  "dateOfBirth": "1995-05-21",
  "holidayAllowance": {
    "percentage": 8,
    "resultPayrollComponent": {
      "key": 82
    }
  },
  "additionalPayrollPeriod": {
    "percentage": 8,
    "resultPayrollComponent": {
      "key": 83
    }
  },
  "companyCar": {
    "fiscalAddition": 345.87
  },
  "deductions": {
    "net": 50.87,
    "gross": 50.87
  },
  "payments": {
    "net": 50.87,
    "gross": 50.87
  },
  "deviations": {
    "grossWagePercentageChange": 25,
    "hoursPerWeek": 37.5
  },
  "calculateUsingNextYearsValues": true
}

Response

OK

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "payrollPeriods": [
      {
        "payrollPeriod": {
          "year": 2017,
          "periodNumber": 1,
          "periodStartDate": "2018-01-01",
          "periodEndDate": "2018-01-31"
        },
        "payslipTypes": [
          {
            "payslipType": {
              "key": 1,
              "value": "Normaal strook"
            },
            "payrollComponentResults": [
              {
                "payrollComponent": {
                  "key": 1,
                  "value": "Uren gewerkt",
                  "category": {
                    "key": 1,
                    "value": "Uren"
                  },
                  "column": {
                    "key": 6,
                    "value": "Sociaalplichtig loon"
                  },
                  "costsEmployer": {
                    "key": 1,
                    "value": "+"
                  }
                },
                "value": 40,
                "valueSpecialTariff": 144
              }
            ]
          }
        ]
      }
    ]
  }
}

Changes

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