id
string<ulid>
required

Unique identifier for the vehicle in Terminal.

Example:

"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"

sourceId
string
required

The ID used to represent the entity in the source system.

Example:

"123456789"

provider
string
required

Every provider has a unique code to identify it across Terminal's system. You can find each provider's code under provider details.

Example:

"geotab"

status
enum<string>
required

The status in the providers system

Available options:
active,
inactive
metadata
object
required

Internal metadata about the record.

vin
string
Example:

"1HGCM82633A004352"

name
string
Example:

"Big Red"

make
string
Example:

"Peterbilt"

model
string
Example:

"Model 579"

year
integer
Example:

2016

groups
(string<ulid> | Expanded Group · object)[]
devices
(string<ulid> | Expanded Device · object)[]
licensePlate
object
fuelType
enum<string>
Available options:
gasoline,
diesel,
propane,
electric,
hybrid_gasoline,
hybrid_diesel
fuelEfficiency
number
deprecated

This field will be removed in the future as is not commonly available from providers.

Example:

27.4

fuelTankCapacity
number

Maximum amount of fuel vehicle can hold in liters.

Example:

95.33

createdAt
string<date-time>

The date and time the record was created in the provider's system. This timestamp comes directly from the source system and represents when the data was originally created there. Note: not all providers expose this.

updatedAt
string<date-time>

The date and time the record was updated in the provider's system. This timestamp comes directly from the source system and represents when the data was last updated there. Note: not all providers expose this.

raw
RawData · object[]
Example:
[]