Skip to main content

Get a list of vehicles​

Retrieve a paged collection of vehicles (required scope vehicles:read)

Query Parameters
    sortBy VehicleSortOptions

    Possible values: [createdAt, groupName, registration]

    The field to sort items in the page by

    direction SortDirection

    Possible values: [ascending, descending]

    The direction to apply the sort

    registration string[]

    Only return vehicles where registration matches with the value(s) provided

    reference string[]

    Only return vehicles where reference matches the value(s) provided

    id int64[]

    Only return resources where id matches the value(s) provided

    groupId int64[]

    Only return resources where groupId matches the value(s) provided

    pageNumber int32

    Possible values: >= 1 and <= 2147483

    The page number being requested (minimum: 1, maximum: 2147483)

    pageSize int32

    Possible values: >= 1 and <= 1000

    The page size being requested (minimum: 1, maximum: 1000)

Header Parameters
    Customer-Id int64 required

    The customer identifier

Responses

Success

Schema
    items object[]

    The items returned for the requested page

  • Array [
    • id int64

    The unique identifier of the vehicle

    createdAt date-time

    The UTC timestamp of when this vehicle was created

    groupId int64

    The unique identifier of the group that the vehicle belongs to

    vehicleType VehicleType

    Possible values: [motorcycle, car, trailer, bus, emergency, goodsLess7_5T, goodsMore7_5T, busLess12]

    Enumeration representing different types of vehicles

    Possible values:

    • motorcycle: Motorcycle vehicle type
    • car: Car vehicle type
    • trailer: Trailer vehicle type
    • bus: Bus vehicle type
    • emergency: Emergency vehicle type
    • goodsLess7_5T: Goods vehicle type with weight less than 7.5 tons
    • goodsMore7_5T: Goods vehicle type with weight more than or equal to 7.5 tons
    • busLess12: Bus vehicle type with less than 12 seats

    fixedResourceId int64 nullable

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

    groupName string

    The name of the group that the vehicle belongs to

    reference string

    The internal reference of the vehicle - should usually be unique

    registration string

    The registration number of the vehicle

    make string nullable

    The manufacturer of the vehicle

    model string nullable

    The model of the vehicle

    registrationYear int32 nullable

    The year that the vehicle was first registered as new

    isSchedulable boolean

    Indicates whether this vehicle can be scheduled jobs

    idlingFuelConsumptionRate double nullable

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

    costPerKm double nullable

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

    costPerDay double nullable

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

    costPerKmCurrencyCode CurrencyRead

    Possible values: [eur, aud, gbp, bgn, cad, czk, dkk, huf, ils, lvl, ltl, mxn, nzd, nok, pln, ron, rub, zar, sek, chf, aed, usd, unknown]

    Currency definitions enum, matches currencies available in the BigChange Client Site with an unknown value to handle unrecognised currencies returned from the database

    Possible values:

    • eur: Euro
    • aud: Australian Dollar
    • gbp: Pound Sterling
    • bgn: Bulgarian Lev
    • cad: Canadian Dollar
    • czk: Czech Koruna
    • dkk: Danish Krone
    • huf: Forint
    • ils: New Israeli Sheqel
    • lvl: Latvian Lats - replaced by Euro
    • ltl: Lithuanian Litas - replaced by Euro
    • mxn: Mexican Peso
    • nzd: New Zealand Dollar
    • nok: Norwegian Krone
    • pln: Zloty
    • ron: Romanian Leu
    • rub: Russian Ruble
    • zar: Rand
    • sek: Swedish Krona
    • chf: Swiss Franc
    • aed: UAE Dirham
    • usd: US Dollar
    • unknown: Unknown currency

    costPerDayCurrencyCode CurrencyRead

    Possible values: [eur, aud, gbp, bgn, cad, czk, dkk, huf, ils, lvl, ltl, mxn, nzd, nok, pln, ron, rub, zar, sek, chf, aed, usd, unknown]

    Currency definitions enum, matches currencies available in the BigChange Client Site with an unknown value to handle unrecognised currencies returned from the database

    Possible values:

    • eur: Euro
    • aud: Australian Dollar
    • gbp: Pound Sterling
    • bgn: Bulgarian Lev
    • cad: Canadian Dollar
    • czk: Czech Koruna
    • dkk: Danish Krone
    • huf: Forint
    • ils: New Israeli Sheqel
    • lvl: Latvian Lats - replaced by Euro
    • ltl: Lithuanian Litas - replaced by Euro
    • mxn: Mexican Peso
    • nzd: New Zealand Dollar
    • nok: Norwegian Krone
    • pln: Zloty
    • ron: Romanian Leu
    • rub: Russian Ruble
    • zar: Rand
    • sek: Swedish Krona
    • chf: Swiss Franc
    • aed: UAE Dirham
    • usd: US Dollar
    • unknown: Unknown currency

    odometerUnit OdometerUnit

    Possible values: [miles, kilometres]

    The unit of measure for distance presented by the vehicles odometer

    Possible values:

    • miles
    • kilometres

    odometerEstimate int32 nullable

    An estimate of vehicle odometer reading, based on tracked distance

    odometer int32 nullable

    The latest reading from the vehicles odometer

    odometerReadAt date-time nullable

    The UTC timestamp of when the odometer reading was last recorded

    roadSafetyExpiresAt date nullable

    The date of when the vehicle's road safety test expires (eg. UK MOT test)

    roadTaxExpiresAt date nullable

    The date of when the vehicle's road tax expires

    serviceDueAt date nullable

    The date of when the vehicle's next service is due

    insuranceDueAt date nullable

    The date of when the vehicle's insurance is due for renewal

    co2EmissionsGramsPerKm int32 nullable

    The vehicle co2 emission rate as (grams per km)

    co2EmissionsKilogramsPerLitre double nullable

    The vehicle co2 emission rate as (kilograms per litre)

    customFields object[]

    Custom fields associated with the vehicle

  • Array [
    • definitionId int64

    The unique identifier of the associated custom field definition

    value string nullable

    The current value set for the custom field

    definition object

    Represents the definition of a custom field

    caption string

    The caption of a custom field

    type CustomFieldType

    Possible values: [boolean, integer, decimal, text, list, statement, date, note, time, systemList]

    The type of the custom field. New field types may be added in the future, so integrations should be resilient to this

    Possible values:

    • boolean: Indicates a boolean field (Example: "false")
    • integer: Indicates an integer numeric field (Example: "1001")
    • decimal: Indicates a floating point numeric field (Example: "1.42")
    • text: Indicates an editable text field (Example: "Purple")
    • list: Indicates a field with a single value from a predefined list of options (Example: "Purple")
    • statement: Indicates a text field that cannot be edited. The value is always equal to the default value (Example: "By signing this you agree to the following...")
    • date: Indicates a date field, which will be represented as an RFC3339 formatted date string. The default value is not supported for this type and will always be null (Example: "2024-01-31")
    • note: Indicates a multiline, editable text field. Lines are seperated with a line feed character (Example: "This is a note.")
    • time: Indicates a time field, formatted as HH:mm. The default value is not supported for this type and will always be null (Example: "10:30")
    • systemList: Indicates the ID of a related resource, vehicle or web user (Example: "228007")

    listOptions string[] nullable

    Shows the possible values for a list type custom field. Value will be null if type is not list

    isRequired boolean

    Indicates if the field is required in the UI. This is NOT enforced in the API

    isEditable boolean

    Indicates if the field is editable

    default string nullable

    The default value of a custom field. Formatted in accordance with the rules of the field type

    systemListValueMetadata object

    Represents details of custom field value of type system list

    label string nullable

    A descriptive label for the specific resource, vehicle or web user that this system list value relates to

    entityType CustomFieldSystemListType

    Possible values: [resource, vehicle, webUser]

    The type of entity used for custom field value of type system list

    Possible values:

    • resource
    • vehicle
    • webUser

  • ]
  • ]
    • pageNumber int32

    The page number of the response where 1 is the first page

    pageSize int32

    The number of items requested for the current page

    pageItemCount int32

    The number of items returned in the current page

Loading...