Benefits and deductions

Edit the details of a benefit or deduction record

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

Update a benefit or deduction for the employment Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.

put/v2/providers/employers/employees/employments/benefitsAndDeductions/{benefitsanddeductionsId}

Request

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

Path parameters

benefitsanddeductionsIdstring uuid required

The unique identifier of the benefits and deductions 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)

startDatestring date

The start date for the information in the record.

A (linked chain)[./#section/Data/Date-chains] per payroll component is maintained within this resource.

endDatestring date nullable

The end date for the information in the record.

valuenumber

The value for the selected payroll component. <br/>

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "startDate": "1995-05-21",
  "payrollComponent": {
    "key": 1,
    "description": "Uren gewerkt",
    "category": {
      "key": 1,
      "value": "Uren"
    },
    "deductionOrPayment": {
      "key": 2,
      "value": "Betaling"
    }
  },
  "value": 50.87
}

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",
    "startDate": "1995-05-21",
    "payrollComponent": {
      "key": 1,
      "description": "Uren gewerkt",
      "category": {
        "key": 1,
        "value": "Uren"
      },
      "deductionOrPayment": {
        "key": 2,
        "value": "Betaling"
      }
    },
    "value": 50.87
  }
}

Changes

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