---
title: "Initiate payroll run Collective"
method: POST
path: "/v2/providers/employers/payrolladministrations/payrollperiods/{payrollPeriodId}/payrollruns"
tags: ["Initiate payroll run"]
---

# Initiate payroll run Collective

`POST /v2/providers/employers/payrolladministrations/payrollperiods/{payrollPeriodId}/payrollruns`

## Request

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

__Activity name :__ PostPayrollRunCollectiveByBearerToken This is a controller endpoint to perform an action.

* The endpoint starts multiple payrollruns within one provider.
* Only one payrollrun per payrolladministration can be started.

## Path parameters

- `payrollPeriodId` integer, required

## Headers

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

## Request body

- PostPayrollRunCollective[]
  - `payrollAdministrationId` string, uuid: The unique identifier of an object (GUID/UUID)
  - `availableForEmployeeDate` string, date, nullable: The date on which the pay slips will be available to employees.
  - `initialisePayrollPeriod` boolean, nullable: Indicates whether the initiase (berekenen uren) proces should be started. When set to true or not set, the initialising proces will be started with the default settings.

## Response `202`

Accepted

- object
  - `content` CollectiveAction2
    - `collectiveActionId` string, uuid: The unique identifier of an object (GUID/UUID)
    - `collectiveActionParentId` string, uuid: The parentId is used to link the collectiveAction to a parent collectiveAction.
    - `employerId` string, uuid: The employer for which the collectiveAction was submitted.
    - `payrollAdministrationId` string, uuid: The payroll administration for which the collectiveAction was submitted.
    - `submittedByUserId` string, uuid: The user who submitted the collectiveAction.
    - `submittedOn` string, date-time: Date-time when the collectiveAction was submitted.
    - `status` 'Completed' | 'NotStarted' | 'InProgress': status of the collectiveAction
    - `type` 'Werknemerloket' | 'Beloning': the type of collectiveAction
    - `itemCount` object: Summary of the items in the collective action.
      - `processedWithError` integer: The number of items in the collectiveAction that were processed unsuccessfully and resulted in an error.
      - `processed` integer: The number of items in the collectiveAction that were processed successfully without a warning.
      - `processedWithWarning` integer: The number of items in the collectiveAction that were processed successfully with a warning.
      - `total` integer: The total number of items in the collectiveAction.

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