LOloket
Workflow employment

Initiate the declaration workflow for an employment

Changed on

Activity name: <a href="https://developer.loket.nl/Activities/PostInitiateDeclarationWorkflowByEmploymentId" target="_blank">PostInitiateDeclarationWorkflowByEmploymentId</a><br> <br><br>Allows the user to trigger a workflow to start a declaration for an employment. The workflow may require the change to be approved.<br><br>Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.<br><br>Defaults : none<br>

post/v2/providers/employers/employees/employments/{employmentId}/workflow/InitiateDeclaration

Request

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

calculatedDistanceByRoutingServicenumber double nullable

The value calulated by the routing service

numberOfUnitsnumber double

The number of units requested

numberOfUnitsByAnalysisnumber double nullable

The number of units scanned by the azure document intelligence analysis (uses the total value from PostAnalyzeReceiptByEmploymentId response)

declarationDatestring date

The date to which the declaration is applicable. As requested by the employee.

reasonForDeviatingFromCalculatedDistancestring nullable

The reason why the employee deviated form the calculated distance.

commentstring nullable

An extra comment for the declaration request

Example request

{
  "payrollComponent": {
    "key": 11,
    "description": "UREN TVT 130%",
    "deviatingDescription": "Uren tijd voor tijd 130%",
    "deductionOrPayment": {
      "key": 2,
      "value": "Betaling"
    },
    "routeType": {
      "key": 1,
      "value": "Snelste"
    }
  },
  "calculatedDistanceByRoutingService": 8,
  "numberOfUnits": 8,
  "numberOfUnitsByAnalysis": 8,
  "declarationDate": "2017-11-01",
  "reasonForDeviatingFromCalculatedDistance": "There were some ongoing road works i had to get around",
  "route": [
    {
      "pointOfInterest": {
        "name": "Van Spaendonck Groep"
      },
      "address": {
        "freeformAddress": "Reitseplein 1, 5037 AA Tilburg",
        "countryCode": "NL"
      },
      "position": {
        "latitude": 51.585996,
        "longitude": 5.585996
      }
    }
  ],
  "comment": "Had to park in a garage"
}

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