Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Vehicles

Create a vehicle

Create a new vehicle (required scope vehicles:write)

post/v1/vehicles

Headers

Customer-Idinteger required

The customer identifier

Request body

groupIdinteger required

The unique identifier of the group that the vehicle belongs to

vehicleType'motorcycle' | 'car' | 'trailer' | 'bus' | 'emergency' | 'goodsLess7_5T' | 'goodsMore7_5T' | 'busLess12' required

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

fixedResourceIdinteger nullable

The unique identifier of the resource who this vehicle is assigned to

referencestring nullable

The internal reference of the vehicle - should usually be unique

registrationstring required

The registration number of the vehicle

makestring nullable

The manufacturer of the vehicle

modelstring nullable

The model of the vehicle

registrationYearinteger nullable

The year that the vehicle was first registered as new

isSchedulableboolean

Indicates whether this vehicle can be scheduled jobs

idlingFuelConsumptionRatenumber double nullable

The litre fuel consumption of the vehicle used when idling per minute

costPerKmnumber double nullable

The running cost of the vehicle per kilometre, expressed in costPerKmCurrencyCode

costPerDaynumber double nullable

The running cost of the vehicle per day, expressed in costPerDayCurrencyCode

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 Site<p>Possible values:</p><ul><li><b>EUR</b>: Euro</li><li><b>AUD</b>: Australian Dollar</li><li><b>GBP</b>: Pound Sterling</li><li><b>BGN</b>: Bulgarian Lev</li><li><b>CAD</b>: Canadian Dollar</li><li><b>CZK</b>: Czech Koruna</li><li><b>DKK</b>: Danish Krone</li><li><b>HUF</b>: Forint</li><li><b>ILS</b>: New Israeli Sheqel</li><li><b>LVL</b>: Latvian Lats - replaced by Euro</li><li><b>LTL</b>: Lithuanian Litas - replaced by Euro</li><li><b>MXN</b>: Mexican Peso</li><li><b>NZD</b>: New Zealand Dollar</li><li><b>NOK</b>: Norwegian Krone</li><li><b>PLN</b>: Zloty</li><li><b>RON</b>: Romanian Leu</li><li><b>RUB</b>: Russian Ruble</li><li><b>ZAR</b>: Rand</li><li><b>SEK</b>: Swedish Krona</li><li><b>CHF</b>: Swiss Franc</li><li><b>AED</b>: UAE Dirham</li><li><b>USD</b>: 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'

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

odometerUnit'miles' | 'kilometres'

The unit of measure for distance presented by the vehicles odometer<p>Possible values:</p><ul><li><b>miles</b></li><li><b>kilometres</b></li></ul>

odometerinteger nullable

The latest reading from the vehicles odometer

roadSafetyExpiresAtstring date nullable

The date of when the vehicles road safety test expires (eg. UK MOT test)

roadTaxExpiresAtstring date nullable

The date of when the vehicles road tax expires

serviceDueAtstring date nullable

The date of when the vehicles next service is due

insuranceDueAtstring date nullable

The date of when the vehicles insurance is due for renewal

co2EmissionsGramsPerKminteger nullable

The vehicle co2 emission rate as (grams per km). Mutually exclusive with Co2EmissionsKilogramsPerLitre

co2EmissionsKilogramsPerLitrenumber double nullable

The vehicle co2 emission rate as (kilograms per litre). Mutually exclusive with Co2EmissionsGramsPerKm

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

Created

idinteger

Identifier of the newly created record