---
title: "Payroll results for a payrollrun"
method: GET
path: "/v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/payrollresults\""
tags: ["Payroll results"]
---

# Payroll results for a payrollrun

`GET /v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/payrollresults"`

## Request

- Base URL: `https://api.loket.nl`
- URL: `https://api.loket.nl/v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/payrollresults"`
- Auth: none required

__Activity name :__ <a href="https://developer.loket.nl/Activities/GetPayrollResultsByPayrollRunId" target="_blank">GetPayrollResultsByPayrollRunId</a>  <br>  <br><br>Returns the payroll results and information on the employments for a given payrollrun.<br><br>__Note :__ This endpoint is related to the `GetPayrollResultsByPayrollAdministrationId` endpoint.<br>

## Path parameters

- `payrollrunId` string, uuid, required

## Query parameters

- `payrollComponentSetId` string, uuid

## 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.
  - `totalSize` integer: Total number of records, taking into account the given filter.
  - `pageSize` integer: Number of records in the response
  - `totalPages` integer: Number of pages available
  - `currentPage` integer: Current page returned in the response
  - `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
  - `_embedded` PayrollResults3[]
    - `employer` object
      - `employerNumber` integer: The employer number is used in various overviews and exports to identify a specific employer in Loket (please note: this is not the identifier used in the REST API).
      - `companyName` string: Name of the company
    - `payrollAdministration` object
      - `clientNumber` integer: The client number is a unique number for administrations that are used for payrolling. This field has no value if the administration is not used for payrolling.
    - `employee` object
      - `employeeNumber` integer: The employee number to uniquely identify a employee within a employer.
      - `formattedName` string: Formatted name of the employee based on the value of `howToFormatLastName`
      - `gender` string
      - `dateOfBirth` string, date: The date of birth
    - `employment` object
      - `startDate` string, date: The date on which this employment starts.
      - `endDate` string, date, nullable: The date on which the employment ends.
      - `payrollId` integer: The payrolling number for this employment of the employee. Used by the payroll engine. This number is automatically generated and cannot be changed by the user.
      - `organizationalEntity` object
        - `department` object: The department of the employment. `department` is a metadata field within the employer context. Possible values can be managed by the user.
          - `code` integer
          - `description` string
        - `function` object: The function of the employment. `function` is a metadata field within the employer context. Possible values can be managed by the user.
          - `code` integer
          - `description` string
        - `distributionUnit` object: Distribution unit, used in several reports and the "basic wage journal" functionality. Commonly used as a cost center.
          - `code` integer
          - `description` string
      - `workinghours` object
        - `shift` object
          - `fullTimeHoursPerWeek` number: The full time hours for an employment that is linked to this shift.
        - `deviatingHoursPerWeek` number, double: Fulltime hours are normally based as defined by the shift, this optional field is used to register a deviating value. The value can be less or more then the fulltime hours a week.
    - `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
    - `payrollResults` 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.
          - `key` integer
          - `value` string
        - `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.
          - `key` integer
        - `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.
          - `key` integer
          - `value` string
      - `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)