Sign in

v1

latestOpenAPI 3.0.32026-08-0645108163.2 KB
Registration

Register kilometer allowance

Registers the kilometer allowance for the worker. from and to address are optional. If they are not present, the location of the placement and the home address of the worker will be used. The distance is as determined by the Mapbox API

post/public/registrations/v1/register-kilometer-allowance

Request body

placementIdstring uuid required

The UUID of the placement for which the kilometer allowance is being registered.

projectIdstring uuid

The UUID of the project if the kilometer allowance is registered on a project.

projectNamestring

The name of the project if the hours are registered on a project. When a new project name is received, a project is automatically created. When a known project name is received, the existing project is used.

datestring date required

The date of the trip. Format: ISO 8601 (YYYY-MM-DD)

Example request

{
  "date": "2024-10-30",
  "fromAddress": {
    "houseNumber": 102,
    "houseNumberAddition": "B",
    "zipCode": "5652AA",
    "countryCode": "US"
  },
  "toAddress": {
    "houseNumber": 102,
    "houseNumberAddition": "B",
    "zipCode": "5652AA",
    "countryCode": "US"
  }
}

Response

Successfully registered kilometer allowance

registrationIdstring uuid
kilometersnumber required

The total distance registered, in kilometers. This includes the return trip, if applicable.

amountnumber

The wage for the kilometers, in €.

Example response

{
  "kilometers": 64.41,
  "amount": 24.69
}