LOloket
Declarations

Create a declaration for an employment

Changed on

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

Add a declaration for an employment. This can be only be done by the employee.

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

Request

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

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.

declarationCommentstring nullable

The comment left by the employee

dateOfSubmissionByEmployeestring date-time

The time the declaration was submitted

dateOfLastChangeByEmployeestring date-time

The time the declaration was last changed

reasonForDeviatingFromCalculatedDistancestring nullable

The reason why the employee deviated form the calculated distance.

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "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",
  "declarationComment": "Overwerk project X",
  "declarationStatus": {
    "key": 1,
    "value": "Open"
  },
  "dateOfSubmissionByEmployee": "2018-05-08T15:16:49+02:00",
  "dateOfLastChangeByEmployee": "2018-05-08T15:16:49+02:00",
  "processedInPayrollPeriod": {
    "year": 2017,
    "periodNumber": 1,
    "periodStartDate": "2018-01-01",
    "periodEndDate": "2018-01-31"
  },
  "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
      }
    }
  ]
}

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",
    "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",
    "declarationComment": "Overwerk project X",
    "declarationStatus": {
      "key": 1,
      "value": "Open"
    },
    "dateOfSubmissionByEmployee": "2018-05-08T15:16:49+02:00",
    "dateOfLastChangeByEmployee": "2018-05-08T15:16:49+02:00",
    "processedInPayrollPeriod": {
      "year": 2017,
      "periodNumber": 1,
      "periodStartDate": "2018-01-01",
      "periodEndDate": "2018-01-31"
    },
    "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
        }
      }
    ]
  }
}

Changes

  • b32a42be97f7Revision changes
    • info

      added the new optional request property

    • info

      added the optional property // to the response with the status