Workflow employment

Initiate the employment termination workflow

Activity name: <a href="https://developer.loket.nl/Activities/PostInitiateTerminateEmploymentWorkflowByEmploymentId" target="_blank">PostInitiateTerminateEmploymentWorkflowByEmploymentId</a><br> <br><br>Allows the loket user to trigger a workflow to terminate an employment contract. The workflow may require approval.<br>

post/v2/providers/employers/employees/employments/{employmentId}/workflows/initiateterminateemployment

Request

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

endDatestring date

The date on which the employment ends (=last day of the employment).

endOfEmploymentDueToIllnessboolean

Indicates whether the reason for the termination of an employment is due to long-term illness. Mandatory if endDate is filled, else leave empty.

createMdvEntryboolean

Indicates whether an MDV-entry should automatically be generated (not sent) by Loket (Melding Dienstverband). This should typically only be used for Colland-related employments and if the module MDV is active for an employer, which means in most cases this indicator should be set to false.

Next to that, a message is ONLY generated when the employment is actually terminated by performing this action (=the employment did not already have an endDate before calling this endpoint).

commentstring nullable

An extra comment for the change request

Example request

{
  "endDate": "2018-10-23",
  "endOfEmploymentReason": {
    "key": 1,
    "value": "VUT"
  },
  "endOfEmploymentReasonTaxAuthorities": {
    "key": 1,
    "value": "Opzegging door de werkgever binnen de proeftijd."
  },
  "comment": "We move house September 26th"
}

Response

Accepted

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"
  }
}

Changes

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