SOsoldo
Vehicles

Add Vehicle

Changed on

Endpoint to add a new Vehicle.

post/business/v2/vehicles

Request

Request body

number_platestring required

The plate number of the Vehicle.

descriptionstring required

The description of the Vehicle.

vat_deductible'NONE' | '40' | '80' | '100' required
fuel_type'PETROL' | 'DIESEL' | 'METHANE' | 'LPG' | 'LNG' | 'ELECTRIC' | 'UNKNOWN' required
reimbursement_ratenumber

The rate to apply for a MileageReimbursement, measured in main Wallet currency per km.

mileageinteger

The mileage of the Vehicle, measured in km.

Example request

{
  "number_plate": "AA000BB",
  "description": "Employee electric vehicle",
  "reimbursement_rate": 0.45,
  "mileage": 125000
}

Response

The returned resource is a new Vehicle.

idstring

The Vehicle ID (sortable: no).

number_platestring

The plate number of the Vehicle (sortable: yes).

descriptionstring

The description of the Vehicle (sortable: no).

vat_deductible'NONE' | '40' | '80' | '100'
fuel_type'PETROL' | 'DIESEL' | 'METHANE' | 'LPG' | 'LNG' | 'ELECTRIC' | 'UNKNOWN'
status'ACTIVE' | 'ARCHIVED'
creation_timestring

The date and time when the Vehicle was created (sortable: yes).

last_update_timestring

The last date and time when the Vehicle was updated (sortable: yes).

card_idsstring[]

The list of Card ID associated with the Vehicle (sortable: no).

reimbursement_ratenumber

The rate to apply for a MileageReimbursement, measured in main Wallet currency per km (sortable: no).

mileageinteger

The latest mileage of the Vehicle, measured in km, either manually registered or automatically updated after a Refueling transaction (sortable: no).

Example response

{
  "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
  "number_plate": "AA000BB",
  "description": "Employee electric vehicle",
  "creation_time": "2017-06-01T12:48:40Z",
  "last_update_time": "2017-06-01T12:48:40Z",
  "card_ids": [
    "7bf79328-a7ae-4222-aa54-091ff7f429a7",
    "2d65bd5e-3fdf-4002-b166-bde7fb8863fa"
  ],
  "reimbursement_rate": 0.45,
  "mileage": 125000
}

Changes

  • 4c2f28426f74Revision changes
    • warning

      changed the pattern of the request property from ^[^<>=]{0,30}$ to ^[^<>=]{0,255}$

    • info

      added the new optional request property

    • info

      the request property's maxLength was increased from 30 to 255

    • info

      added the optional property to the response with the status

  • 281d6e1cd633Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status