LOloket
Payroll simulator

Overview of the data used in a payroll simulation

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

Get an overview of the data used in a payroll simulation

get/v2/providers/employers/employees/employments/{employmentId}/payrollSimulatorData

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/employees/employments/{employmentId}/payrollSimulatorData
  • Auth
    none required

Path parameters

employmentIdstring uuid required

The unique identifier of the employment

Query parameters

filterstring
Example:cancellationPeriodTimeUnit.key eq 4

Filter the collection

orderBystring
Example:-companyName,address.houseNumber

Order the collection on one or more fields

pageNumberinteger
Example:2

Specifies which page should be returned

pageSizeinteger
Example:20

Specifies the number of objects per page

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

Response

OK

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "wage": {
      "currentWage": 2300,
      "type": {
        "key": 2,
        "value": "hourly"
      },
      "class": "Basisloon"
    },
    "payrollPeriodType": {
      "key": 2,
      "value": "month"
    },
    "workingHours": {
      "currentHoursPerWeek": 41,
      "shift": {
        "fullTimeHoursPerWeek": 40
      }
    },
    "startDateDeviations": "2022-08-01"
  }
}

Changes

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