---
title: "List of all the payroll runs for the pension wage statement PGGM"
method: GET
path: "/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/pensionWageStatement/Pggm/payrollRuns"
tags: ["Pension wage statement"]
---

# List of all the payroll runs for the pension wage statement PGGM

`GET /v2/providers/employers/payrolladministrations/{payrollAdministrationId}/pensionWageStatement/Pggm/payrollRuns`

## Request

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

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

The list of all the payroll runs that will be included in the next pension wage statement (PLO) for PGGM.

## Path parameters

- `payrollAdministrationId` string, uuid, required

## Query parameters

- `referenceDate` string, date
- `process` 'Delete' | 'Initiate', required
- `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` PggmDownloadInformation[]
    - `payrollRun` object
      - `payrollRunId` string, uuid: The unique identifier of an object (GUID/UUID)
      - `payrollPeriod` PayrollPeriod2
        - `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
        - `periodStartDate` string, date: The first day of the period for which the tax return message was created
        - `periodEndDate` string, date: The last day of the period for which the tax return message was created
        - `testYear` boolean: Indicates whether the payroll periode is part of a test year. In Loket it is possible to run a year of a payrollAdministration as a so-called test year. This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data.
      - `sequenceNumberApproved` integer: Ascending sequence number related to an approved payrol run. A payroll run may have more than one journal run. With this number the journal run may be linked to the specific payroll run.
      - `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

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