---
title: "List of payroll runs for an administration"
method: GET
path: "/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollruns"
tags: ["Payroll run"]
---

# List of payroll runs for an administration

`GET /v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollruns`

## Request

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

__Activity name :__ <a href="https://developer.loket.nl/Activities/GetPayrollRunsByPayrollAdministrationId" target="_blank">GetPayrollRunsByPayrollAdministrationId</a>

A list of payroll runs for an administration

## Path parameters

- `payrollAdministrationId` 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.
  - `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` PayrollRun[]
    - `id` string, uuid: The unique identifier of an object (GUID/UUID)
    - `payrollPeriod` object
      - `year` integer: The year of the payroll period the record relates to
      - `periodNumber` integer: The period number of the payroll period the record relates to
    - `payrollRunStatus` object
      - `key` integer: The key indicating the current status of the payroll run.
      - `value` string: The value describing the current status of the payroll run. * Staat klaar voor verloning. (key = 0) * Verloning gereed. (key = 1) * Proforma verloning gereed. (key = 2) * Verwijderd door gebruiker (key = 5) * Verloning geannuleerd door gebruiker. (key = 6) * Fout tijdens verloning. (key = 7) * Geen loonresultaten, verloning geannuleerd. (key = 8) * Verloning goedgekeurd. (key = 9)
    - `textPaySlip` string, nullable: An optional text provided by an authorized user that will be displayed on the pay slip.
    - `textPayment` string, nullable: An optional text provided by an authorized user that will be displayed as a description for the payment.
    - `requestTime` string, date-time: The time at which the payroll run was requested by the user
    - `processingFinishedTime` string, date-time, nullable: Date-time when the calculations of the wages was finished
    - `approvalTime` string, date-time, nullable: The time at which the payroll run was approved by the user
    - `sequenceNumber` integer, nullable: An incremental number with a payrolling year to uniquely identify a payroll run. Null can be returned for those runs that dont contain "wages".
    - `textTariffPaySlip` string, nullable: An additional text to be displayed on the tariff payslip.
    - `availableForEmployeeDate` string, date, nullable: The date on which the pay slips will be available to employees.
    - `sendEmailToEmployee` boolean, nullable: Indicates whether an email should be sent to the employees when the pay slip is available to them. NULL will be seen as false
    - `requestedBy` UserBasicNotNullable
      - `id` string, uuid: The unique identifier of an object (GUID/UUID)
      - `initials` string: The initials of the user
      - `prefix` string, nullable: The prefix of the user
      - `lastName` string: The last name of the user
      - `formattedName` string: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
    - `approvedBy` UserBasic, nullable
      - `id` string, uuid: The unique identifier of an object (GUID/UUID)
      - `initials` string: The initials of the user
      - `prefix` string, nullable: The prefix of the user
      - `lastName` string: The last name of the user
      - `formattedName` string: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
    - `sequenceNumberApproved` integer, nullable: An incremental number with a payrolling year to uniquely identify an approved payroll run.
    - `removeTime` string, date-time, nullable: The time at which the pay roll run was removed.
    - `removedBy` UserBasic, nullable
      - `id` string, uuid: The unique identifier of an object (GUID/UUID)
      - `initials` string: The initials of the user
      - `prefix` string, nullable: The prefix of the user
      - `lastName` string: The last name of the user
      - `formattedName` string: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
    - `methodOfCreation` object
      - `key` integer: The key indicating how the payroll run was created.
      - `value` string: The value describing how the payroll run was created.
    - `errorsAndWarnings` object
      - `hasErrors` boolean: Indicates whether the payrollrun has errors
      - `hasWarnings` boolean: Indicates whether the payrollrun has warnings
    - `payrollTaxReturnPeriod` object: Indicates the payrolltaxreturn period in which the payrollrun is included.
      - `year` integer: The year of the payroll period the record relates to
      - `periodNumber` integer: The period number of the payroll period the record relates to

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