LOloket
Payroll period data

Edit the details of an payroll period data

Activity name : <a href="https://developer.loket.nl/Activities/PutPayrollPeriodDataByPayrollPeriodDataId" target="_blank">PutPayrollPeriodDataByPayrollPeriodDataId</a> <br/> <br/> Edit the details for payroll period data <br/> <br/> Metadata : <br/> Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL <br/> Possible values for fields of the type 'metadata' that are PERIOD-specific can be acquired (GET) by adding /metadata/year/{year}/period/{periodNumber} to the PUT URL <br/>

put/v2/providers/employers/employees/employments/payrollperioddata/{payrollperioddataId}

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/employees/employments/payrollperioddata/{payrollperioddataId}
  • Auth
    none required

Path parameters

payrollperioddataIdstring uuid required

The unique identifier of the payroll period data

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

idstring uuid

The unique identifier of an object (GUID/UUID)

payslipTextstring nullable

A custom text to be displayed on the payslip.

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "payrollPeriod": {
    "year": 2017,
    "periodNumber": 1,
    "periodStartDate": "2018-01-01",
    "periodEndDate": "2018-01-31"
  },
  "shift": {
    "shiftNumber": 1,
    "fullTimeHoursPerWeek": 40,
    "bonusPercentage": 12
  },
  "payslipType": {
    "key": 2,
    "value": "Bijzonder tarief strook"
  },
  "payslipText": "Additional payslip for bonus",
  "distributionUnit": {
    "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "code": 2,
    "description": "Sales"
  },
  "costCenter": {
    "key": 2,
    "code": "SAL073",
    "description": "Sales Den Bosch"
  },
  "costUnit": {
    "key": 2,
    "code": "01",
    "description": "Cars"
  },
  "payrollComponents": [
    {
      "payrollComponent": {
        "key": 1,
        "description": "Uren gewerkt",
        "category": {
          "key": 1,
          "value": "Uren"
        },
        "deductionOrPayment": {
          "key": 2,
          "value": "Betaling"
        }
      },
      "value": 144
    }
  ]
}

Response

OK

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "payrollPeriod": {
      "year": 2017,
      "periodNumber": 1,
      "periodStartDate": "2018-01-01",
      "periodEndDate": "2018-01-31"
    },
    "shift": {
      "shiftNumber": 1,
      "fullTimeHoursPerWeek": 40,
      "bonusPercentage": 12
    },
    "payslipType": {
      "key": 2,
      "value": "Bijzonder tarief strook"
    },
    "payslipText": "Additional payslip for bonus",
    "distributionUnit": {
      "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "code": 2,
      "description": "Sales"
    },
    "costCenter": {
      "key": 2,
      "code": "SAL073",
      "description": "Sales Den Bosch"
    },
    "costUnit": {
      "key": 2,
      "code": "01",
      "description": "Cars"
    },
    "payrollComponents": [
      {
        "payrollComponent": {
          "key": 1,
          "description": "Uren gewerkt",
          "category": {
            "key": 1,
            "value": "Uren"
          },
          "deductionOrPayment": {
            "key": 2,
            "value": "Betaling"
          }
        },
        "value": 144
      }
    ]
  }
}

Changes

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