LOloket
Initiate payroll run

Initiationvalues of a payrollrun

Activity name : <a href="https://developer.loket.nl/Activities/GetPayrollrunInitiationvaluesByPayrollAdministrationIdAndPayrollPeriodId" target="_blank">GetPayrollrunInitiationvaluesByPayrollAdministrationIdAndPayrollPeriodId</a>

Get the initiation values for initiating a payrollrun for a specific period.

get/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollruns/{payrollPeriodId}/initiationvalues

Request

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

Path parameters

payrollAdministrationIdstring uuid required

The unique identifier of an administration

payrollPeriodIdstring uuid required

The unique identifier of an 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

Response

OK

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "payrollPeriod": {
      "year": 2017,
      "periodNumber": 1,
      "periodStartDate": "2018-01-01",
      "periodEndDate": "2018-01-31"
    },
    "availableForEmployeeDate": "2021-05-08"
  }
}

Changes

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