LOloket
Initiate payroll run

Initiate payroll run Collective

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.
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

Path parameters

payrollPeriodIdinteger required

The unique identifier of the payroll period

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required
Example:application/json;version=2018-01-01

The accept header is used to influence what type of output is returned and in most cases the version of the output

Request body

payrollAdministrationIdstring uuid

The unique identifier of an object (GUID/UUID)

availableForEmployeeDatestring date nullable

The date on which the pay slips will be available to employees.

initialisePayrollPeriodboolean 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.

Example request

[
  {
    "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "availableForEmployeeDate": "2018-05-08"
  }
]

Response

Accepted

Example response

{
  "content": {
    "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "submittedOn": "2023-05-08T15:16:49+02:00",
    "itemCount": {
      "processedWithError": 10,
      "processed": 75,
      "processedWithWarning": 15,
      "total": 100
    }
  }
}

Changes

No recorded changes to this operation across all 6 revisions of this API.