Vehicle
The vehicle object contains information about a vehicle record.
Vehicles are typically bookable resources for services. They live in Resources > Vehicles, but under the hood they're member records so share attributes with other objects in People & Organizations.
Vehicles have contact information against them because newer smart trucks for business have cell phone numbers and email addresses built into their trip computers. Some customers email PDFs or send messages with information about jobs to trucks.
Members
Contacts, organizations, vehicles, venues, and users are all known as members in the database. Members have some shared attributes, along with attributes that are specific to that particular member type.
When you're checking a list of members, you can use the type object to determine what type of member you're working with.
For example, the participants object against an opportunity returns participant objects for any members who are participants on the opportunity. To print only users:
Document layouts
The vehicle
object can be accessed in document layouts created against the following modules:
Member
From a vehicle record:
Opportunity
To print vehicles that are are bookable resources for service items:
Discussion templates
The vehicle
object can be accessed in discussion templates created against the following modules:
Member
From a vehicle record:
Opportunity
To print vehicles that are are bookable resources for service items:
activities
activities
Returns activity objects for the activities relating to a vehicle.
Input
Output
attachments
attachments
Returns attachment objects for attachments stored against a vehicle.
Input
Output
description
description
Returns a vehicle's description.
Input
Output
email
email
Returns the first work email address stored against a vehicle.
Input
Output
emails
emails
Returns email objects for email addresses stored against a vehicle.
Input
Output
height
height
Returns a vehicle's height.
Input
Output
icon_url
icon_url
Returns a URL pointing at the vehicle's picture. The full size image is returned.
Input
Output
image_attachments
image_attachments
Returns attachment objects for attachments stored against a vehicle. Only returns those that have a file type of image.
Input
Output
id
id
Returns a vehicle ID.
The ID is an internal reference for a record. It's not exposed in our web interface.
Input
Output
length
length
Returns a vehicle's length.
Input
Output
location_type
location_type
Returns a vehicle's location type ID.
Input
Output
location_type_name
location_type_name
Returns a vehicle's location type name.
Internal
External
Input
Output
mobile
mobile
Returns a vehicle's cell phone number. The first telephone number with the type “cell” or “mobile” is returned.
Input
Output
name
name
Returns a vehicle's name.
Input
Output
payload
payload
Returns a vehicle's maximum payload.
Input
Output
Use weight_unit
against the company object to print your system weight unit.
phones
phones
Returns telephone objects for telephone numbers stored against a vehicle.
Input
Output
plate
plate
Returns a vehicle's licence plate.
Input
Output
telephone
telephone
Returns a vehicle's telephone. The first telephone number with the type “work” is returned.
Input
Output
volume
volume
Returns a vehicle's volume.
Input
Output
width
width
Returns a vehicle's width.
Input
Output
Last updated