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:
<ul>
{% for participant in order.participants %}
{% if participant.type == "Vehicle" %}
<li>{{ participant.name }}</li>
{% endif %}
{% endfor %}
</ul>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
activitiesReturns activity objects for the activities relating to a vehicle.
Input
Output
Activityattachments
attachmentsReturns attachment objects for attachments stored against a vehicle.
Input
Output
Attachmentsdescription
descriptionReturns a vehicle's description.
Input
Output
email
emailReturns the first work email address stored against a vehicle.
Input
Output
emails
emailsReturns email objects for email addresses stored against a vehicle.
Input
Output
Emailsheight
heightReturns a vehicle's height.
Input
Output
icon_url
icon_urlReturns a URL pointing at the vehicle's picture. The full size image is returned.
Input
Output
image_attachments
image_attachmentsReturns attachment objects for attachments stored against a vehicle. Only returns those that have a file type of image.
Input
Output
Attachmentsid
idReturns a vehicle ID.
Input
Output
length
lengthReturns a vehicle's length.
Input
Output
location_type
location_type Returns a vehicle's location type ID.
Type
Location type
0
Internal
1
External
Input
Output
location_type_name
location_type_nameReturns a vehicle's location type name.
Internal
External
Input
Output
mobile
mobileReturns a vehicle's cell phone number. The first telephone number with the type “cell” or “mobile” is returned.
Input
Output
name
nameReturns a vehicle's name.
Input
Output
payload
payloadReturns a vehicle's maximum payload.
Input
Output
phones
phonesReturns telephone objects for telephone numbers stored against a vehicle.
Input
Output
Phonesplate
plateReturns a vehicle's licence plate.
Input
Output
telephone
telephoneReturns a vehicle's telephone. The first telephone number with the type “work” is returned.
Input
Output
volume
volumeReturns a vehicle's volume.
Input
Output
width
widthReturns a vehicle's width.
Input
Output
Last updated
Was this helpful?