---
title: "List of all available payroll periods and runs"
method: GET
path: "/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods"
tags: ["Payroll periods"]
---

# List of all available payroll periods and runs

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

## Request

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

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

Returns a list of all payroll periods available for the given payroll administration

## Path parameters

- `payrollAdministrationId` string, uuid, required

## 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` PayrollPeriods[]
    - `id` integer: The id for this specific payroll period.
    - `year` integer: The payroll year
    - `periodNumber` integer: The period number of the payroll period
    - `startDate` string, date: The first day of the payroll period
    - `endDate` string, date: The last day of the payroll period
    - `automaticProcessing` AutomaticProcessing, nullable
      - `createPayrollRunOn` string, date, nullable: The date on which the payroll run for this period is automatically created (if all prerequisite are met).
      - `hasAutomaticPayrollRunCreationBeenExecuted` boolean
      - `approvePayrollRunOn` string, date, nullable: The date on which the payroll run for this period is automatically approved (if all prerequisite are met).
      - `hasAutomaticPayrollRunApprovalBeenExecuted` boolean
    - `payrollPeriodType` PayrollPeriodType2: Indicates the frequence of the payrolling process. Payrolling can be done on a montly, 4-weekly or weekly basis.
      - `key` integer
      - `value` string
    - `testYear` boolean: Indicates whether the payroll year is 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.
    - `payrollRuns` object[]
      - `id` string, uuid: The unique identifier of an object (GUID/UUID)
      - `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.
      - `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".
      - `sequenceNumberApproved` integer, nullable: An incremental number with a payrolling year to uniquely identify an approved payroll run.
      - `journalRuns` object[]
        - `id` string, uuid: The unique identifier of an object (GUID/UUID)
        - `sequenceNumber` integer: Ascending sequence number over ALL journal runs for the payroll administration.
        - `journalRunStatus` object
          - `key` integer: The key indicating the current status of the journal run.
          - `value` string: The value describing the current status of the payroll run.

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