Pension benefit

Edit a pension benefit record

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

Metadata : No metadata

put/v2/providers/employers/employees/employments/pensionbenefits/{pensionBenefitId}

Request

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

Path parameters

pensionBenefitIdstring uuid required

The unique identifier of the record

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 date on which this pension benefit starts

A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.

endDatestring date nullable

The end date of the entity. The date is up to and including.

payoutnumber double

The ammount of (gross) pension received

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "startDate": "2018-01-01",
  "endDate": "2018-10-23",
  "payout": 2569
}

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": "2018-01-01",
    "endDate": "2018-10-23",
    "payout": 2569
  }
}

Changes

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