---
title: "Overview of the data used in a payroll simulation"
method: GET
path: "/v2/providers/employers/employees/employments/{employmentId}/payrollSimulatorData"
tags: ["Payroll simulator"]
---

# 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

__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

## Path parameters

- `employmentId` string, uuid, required

## Query parameters

- `filter` string
- `orderBy` string
- `pageNumber` integer
- `pageSize` integer

## Headers

- `Authorization` string, required
- `Accept` string, required

## 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` PayrollSimulatorData
    - `wage` object
      - `currentWage` number, double, nullable: The gross wage for the employee
      - `type` object: Indicates whether the `value` 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
      - `class` 'Basisloon' | 'Nettoloon' | 'Loonkosten': The class of the wage
    - `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
    - `workingHours` object
      - `currentHoursPerWeek` number, nullable: The hours per week de employment currently works
      - `shift` object: The shift determines the full-time hours and bonus percentage. `shift` is a metadata field within the payroll administration context. Possible values can be managed by the user.
        - `fullTimeHoursPerWeek` number: The full time hours for an employment that is linked to this shift.
    - `startDateDeviations` string, date: The date to be used when calling the wageprojection endpoint

## 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)