Wage projection

Perform a wage projection

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

This endpoint can only be used for employments that are already known in the Loket system.

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

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/employees/employments/{employmentId}/wageprojection
  • 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

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

{
  "deviations": {
    "startDate": "1995-05-21",
    "percentageChange": 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.