LOloket
Benefit in kind

Add a Benefit in kind for an employment

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

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

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

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

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/employees/employments/{employmentId}/benefitsInKind
  • 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

idstring uuid

The unique identifier of an object (GUID/UUID)

startDatestring date

The date on which this BenefitInKind starts.

So multiple Benefits in kind can be active at the same time but one specific BenefitsInKind can never be active multiple times at the same time.

endDatestring date nullable

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

brandstring nullable

The brand of the benefit in kind.

typestring nullable

The type of the benefit in kind.

valuenumber

The value for the selected benefit of kind.

supplierstring nullable

The supplier of the benefit in kind.

particularitiesstring nullable

Extra information about the benefit in kind

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "startDate": "2018-01-01",
  "endDate": "2018-10-23",
  "benefitInKindType": {
    "id": "36530F13-59EB-4C15-B5F2-4F92B070A208",
    "description": "Mobiele telefoon"
  },
  "brand": "Apple",
  "type": "Iphone 11",
  "value": 1100,
  "supplier": "Mediamarkt",
  "particularities": "geen bijzonderheden"
}

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",
    "benefitInKindType": {
      "id": "36530F13-59EB-4C15-B5F2-4F92B070A208",
      "description": "Mobiele telefoon"
    },
    "brand": "Apple",
    "type": "Iphone 11",
    "value": 1100,
    "supplier": "Mediamarkt",
    "particularities": "geen bijzonderheden"
  }
}

Changes

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