latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Vehicles

Update a vehicle

Update the details of a single vehicle (required scope vehicles:write)

patch/v1/vehicles/{vehicleId}

Path parameters

vehicleIdinteger required

Headers

Customer-Idinteger required

The customer identifier

Request body

groupIdinteger

The unique identifier of the group that the vehicle belongs to Optional: Omit to retain current value

Enumeration representing different types of vehiclesPossible values:<ul><li>motorcycle: Motorcycle vehicle type</li><li>car: Car vehicle type</li><li>trailer: Trailer vehicle type</li><li>bus: Bus vehicle type</li><li>emergency: Emergency vehicle type</li><li>goodsLess7_5T: Goods vehicle type with weight less than 7.5 tons</li><li>goodsMore7_5T: Goods vehicle type with weight more than or equal to 7.5 tons</li><li>busLess12: Bus vehicle type with less than 12 seats</li></ul>

fixedResourceIdinteger nullable

The unique identifier of the resource who this vehicle is assigned to Optional: Omit to retain current value or provide null to unset

referencestring nullable

The internal reference of the vehicle - should usually be unique Optional: Omit to retain current value or provide null to unset

registrationstring

The registration number of the vehicle Optional: Omit to retain current value

makestring nullable

The manufacturer of the vehicle Optional: Omit to retain current value or provide null to unset

modelstring nullable

The model of the vehicle Optional: Omit to retain current value or provide null to unset

registrationYearinteger nullable

The year that the vehicle was first registered as new Optional: Omit to retain current value or provide null to unset

isSchedulableboolean

Indicates whether this vehicle can be scheduled jobs Optional: Omit to retain current value

idlingFuelConsumptionRatenumber double nullable

The litre fuel consumption of the vehicle used when idling per minute Optional: Omit to retain current value or provide null to unset

costPerKmnumber double nullable

The running cost of the vehicle per kilometre, expressed in costPerKmCurrencyCode Optional: Omit to retain current value or provide null to unset

costPerDaynumber double nullable

The running cost of the vehicle per day, expressed in costPerDayCurrencyCode Optional: Omit to retain current value or provide null to unset

costPerKmCurrencyCode'EUR' | 'AUD' | 'GBP' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ILS' | 'LVL' | 'LTL' | 'MXN' | 'NZD' | 'NOK' | 'PLN' | 'RON' | 'RUB' | 'ZAR' | 'SEK' | 'CHF' | 'AED' | 'USD'

CurrencyCode definitions enum, matches currencies available in the BigChange Client SitePossible values:<ul><li>EUR: Euro</li><li>AUD: Australian Dollar</li><li>GBP: Pound Sterling</li><li>BGN: Bulgarian Lev</li><li>CAD: Canadian Dollar</li><li>CZK: Czech Koruna</li><li>DKK: Danish Krone</li><li>HUF: Forint</li><li>ILS: New Israeli Sheqel</li><li>LVL: Latvian Lats - replaced by Euro</li><li>LTL: Lithuanian Litas - replaced by Euro</li><li>MXN: Mexican Peso</li><li>NZD: New Zealand Dollar</li><li>NOK: Norwegian Krone</li><li>PLN: Zloty</li><li>RON: Romanian Leu</li><li>RUB: Russian Ruble</li><li>ZAR: Rand</li><li>SEK: Swedish Krona</li><li>CHF: Swiss Franc</li><li>AED: UAE Dirham</li><li>USD: US Dollar</li></ul>

costPerDayCurrencyCode'EUR' | 'AUD' | 'GBP' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ILS' | 'LVL' | 'LTL' | 'MXN' | 'NZD' | 'NOK' | 'PLN' | 'RON' | 'RUB' | 'ZAR' | 'SEK' | 'CHF' | 'AED' | 'USD'

odometerUnit'miles' | 'kilometres'

The unit of measure for distance presented by the vehicles odometerPossible values:<ul><li>miles</li><li>kilometres</li></ul>

odometerinteger

The latest reading from the vehicles odometer. If provided with a value, the new odometer reading will be recorded even if the value hasn't changed Optional: Omit to retain current value

roadSafetyExpiresAtstring date nullable

The date of when the vehicles road safety test expires (eg. UK MOT test) Optional: Omit to retain current value or provide null to unset

roadTaxExpiresAtstring date nullable

The date of when the vehicles road tax expires Optional: Omit to retain current value or provide null to unset

serviceDueAtstring date nullable

The date of when the vehicles next service is due Optional: Omit to retain current value or provide null to unset

insuranceDueAtstring date nullable

The date of when the vehicles insurance is due for renewal Optional: Omit to retain current value or provide null to unset

co2EmissionsGramsPerKminteger nullable

The vehicle co2 emission rate as (grams per km). Mutually exclusive with Co2EmissionsKilogramsPerLitre. Setting this property with a non-null value will nullify the Co2EmissionsKilogramsPerLitre property, if previously set. To retain the current value, omit both Co2EmissionsGramsPerKm and Co2EmissionsKilogramsPerLitre Optional: Omit to retain current value or provide null to unset

co2EmissionsKilogramsPerLitrenumber double nullable

The vehicle co2 emission rate as (kilograms per litre). Mutually exclusive with Co2EmissionsGramsPerKm. Setting this property with a non-null value will nullify the Co2EmissionsGramsPerKm property, if previously set. To retain the current value, omit both Co2EmissionsGramsPerKm and Co2EmissionsKilogramsPerLitre Optional: Omit to retain current value or provide null to unset

Example request

{
  "groupId": 7927,
  "vehicleType": "motorcycle",
  "fixedResourceId": 110841,
  "reference": "ABC5514123",
  "registration": "BC24 BIG",
  "make": "Ford",
  "model": "Transit",
  "registrationYear": 2012,
  "isSchedulable": true,
  "idlingFuelConsumptionRate": 0.1,
  "costPerKm": 0.25,
  "costPerDay": 0.25,
  "costPerKmCurrencyCode": "EUR",
  "costPerDayCurrencyCode": "EUR",
  "odometerUnit": "miles",
  "odometer": 51023,
  "roadSafetyExpiresAt": "2022-11-29",
  "roadTaxExpiresAt": "2022-11-29",
  "serviceDueAt": "2022-11-29",
  "insuranceDueAt": "2022-11-29",
  "co2EmissionsGramsPerKm": 5,
  "co2EmissionsKilogramsPerLitre": 5.5,
  "customFields": [
    {
      "definitionId": 5514123,
      "value": "High net worth"
    }
  ]
}

Response

No Content