MAmaqqie
Registration

Register kilometer allowance

Changed on

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

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
}

Changes

  • f9510f3f4b22Revision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      the request's body type changed from no type to object

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to string for status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

  • 3352b56bb8feRevision changes
    • breaking

      the request's body type changed from object to no type

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the response's body type changed from string to no type for status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      response schema application/json enum value removed COMPANY_IS_BLACKLISTED_FOR_TIME_WRITING

    • info

      response schema application/json enum value removed DUPLICATE_REGISTRATION

    • info

      response schema application/json enum value removed INVALID_ADDRESS

    • info

      response schema application/json enum value removed INVALID_DATE

    • info

      response schema application/json enum value removed KILOMETER_ALLOWANCE_NOT_FOUND

    • info

      response schema application/json enum value removed PLACEMENT_DELETED

    • info

      response schema application/json enum value removed WORKER_IS_BLACKLISTED_FOR_TIME_WRITING