LOloket
Employment funds

Activate a fund for an employment

Activity name : <a href="https://developer.loket-ontw.nl/Activities/PostEmploymentFundByEmploymentId" target="_blank">PostEmploymentFundByEmploymentId</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.

Activate a fund for an employment

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

Request

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

A (linked chain)[./#section/Data/Date-chains] per fund is maintained within this resource. So multiple funds can be active at the same time but one specific fund 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.

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "startDate": "2018-01-01",
  "endDate": "2018-10-23",
  "fund": {
    "key": 1,
    "description": "Ouderdomspensioen"
  },
  "deviations": {
    "employmentContributionPercentage": 11,
    "totalContributionPercentage": 12.0007
  },
  "fixedContribution": {
    "employmentContribution": 1789,
    "totalContribution": 2569
  },
  "vitalityScheme": {
    "key": 1,
    "value": "Volgens regeling"
  }
}

Response

Created

totalSizeinteger

Total number of records, taking into account the given filter.

pageSizeinteger

Number of records in the response

totalPagesinteger

Number of pages available

currentPageinteger

Current page returned in the response

Example response

{
  "totalSize": 650,
  "pageSize": 250,
  "totalPages": 3,
  "currentPage": 2,
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "_embedded": [
    {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "startDate": "2018-01-01",
      "endDate": "2018-10-23",
      "fund": {
        "key": 1,
        "description": "Ouderdomspensioen"
      },
      "deviations": {
        "employmentContributionPercentage": 11,
        "totalContributionPercentage": 12.0007
      },
      "fixedContribution": {
        "employmentContribution": 1789,
        "totalContribution": 2569
      },
      "vitalityScheme": {
        "key": 1,
        "value": "Volgens regeling"
      }
    }
  ]
}

Changes

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