LOloket
Protected earnings

Create a new protected earnings record

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

Create a new protected earnings record for an employment.

Metadata : There is no metadata for this resource

Defaults : Default values for a new object can be acquired by adding `/defaults' to the POST URL.

post/v2/providers/employers/employees/employments/{employmentId}/protectedearnings

Request

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

Path parameters

employmentIdstring uuid required

The unique identifier of the employment

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 applicationjson;version=2018-01-01

idstring uuid

The unique identifier of an object (GUID/UUID)

startDatestring date

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

NOTE : at the moment of performing a payroll run it will be checked what record is applicable for protected earning (based on the start- and enddate, not based on the payroll period of the payroll run).

endDatestring date nullable

The end date of the record

thresholdunknown

Example request

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

Response

Created

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",
    "threshold": 50
  }
}

Changes

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