Social security benefits

Edit the details of a social security benefits record

Activity name: <a href="https://developer.loket.nl/Activities/PutSocialSecurityBenefitBySocialSecurityBenefitId" target="_blank">PutSocialSecurityBenefitBySocialSecurityBenefitId</a> Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL.

Edit the details for a social security record

put/v2/providers/employers/employees/employments/socialsecuritybenefits/{socialSecurityBenefitId}

Request

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

Path parameters

socialSecurityBenefitIdstring uuid required

The unique identifier of the social security 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 start date of the entity. Valide values are either the startDate of the employment or the firstday of a payrolling year.

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.

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "startDate": "2018-01-01",
  "endDate": "2018-10-23",
  "supplementation": {
    "type": {
      "key": 3,
      "value": "Suppleren (bruto)"
    },
    "percentage": 35
  },
  "benefit": {
    "percentage": 35
  }
}

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",
    "supplementation": {
      "type": {
        "key": 3,
        "value": "Suppleren (bruto)"
      },
      "percentage": 35
    },
    "benefit": {
      "type": {
        "key": 1,
        "value": "ZW eigen risico"
      },
      "percentage": 35
    }
  }
}

Changes

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