Automatic payroll configuration

edit the automatic payroll configuration

Activity name : <a href="https://developer.loket.nl/Activities/PatchAutomaticPayrollConfigurationByPayrollAdministrationId" target="_blank">PatchAutomaticPayrollConfigurationByPayrollAdministrationId</a> This endpoint edits the automatic payroll configuration for a given payroll administration.

patch/automaticpayroll/payrolladministrations/{payrollAdministrationId}/automaticpayrollconfiguration

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/automaticpayroll/payrolladministrations/{payrollAdministrationId}/automaticpayrollconfiguration
  • Auth
    none required

Path parameters

payrollAdministrationIdstring uuid required

The unique identifier of an administration

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

planDuringWeekendboolean

Indicates whether processes can be planned during the weekend.

planDuringHolidayboolean

Indicates whether processes can be planned during a holiday.

planBeforeOrAfterWeekend'Before' | 'After' nullable

Indicates whether the process should be planned before or after the weekend.

planBeforeOrAfterHoliday'Before' | 'After' nullable

Indicates whether the process should be planned before or after the holiday.

Example request

{
  "planBeforeOrAfterWeekend": "After",
  "planBeforeOrAfterHoliday": "Before",
  "processes": [
    {
      "type": {
        "key": 1,
        "value": "Verlonen"
      },
      "dayNumber": 2,
      "additionalNumberOfDaysFirstPeriod": 2,
      "additionalNumberOfDaysLastPeriod": 2
    }
  ]
}

Response

OK

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "planBeforeOrAfterWeekend": "After",
    "planBeforeOrAfterHoliday": "Before",
    "processes": [
      {
        "type": {
          "key": 1,
          "value": "Verlonen"
        },
        "dayNumber": 2,
        "additionalNumberOfDaysFirstPeriod": 2,
        "additionalNumberOfDaysLastPeriod": 2
      }
    ]
  }
}

Changes

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