ServiceAppointment

Represents a service appointment booked through Automotive Scheduler, for test drives or vehicle services. This object is available in API version 58.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Special Access Rules

Automotive and Automotive Scheduler must be enabled.

Fields

Field	Details
ActualDuration	Type double Properties Create, Filter, Nillable, Sort, Update Description The number of minutes that it took the resource to complete the appointment. When values are first added to the Actual Start and Actual End fields, the Actual Duration is automatically populated to list the difference between the Actual Start and Actual End. If the Actual Start and Actual End fields are subsequently updated, the Actual Duration field doesn’t re-update, but you can manually update it.
ActualEndTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The actual date and time the appointment ended.
ActualStartTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The actual date and time the appointment started.
AdditionalInformation	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Represents additional information about the service appointment.
Address	Type address Properties Filter Description The address where the appointment is taking place.
AppointmentNumber	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-assigned number that identifies the appointment.
ArrivalWindowEndTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The end of the window of time in which the technician is scheduled to arrive at the site.
ArrivalWindowStartTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The beginning of the window of time in which the technician is scheduled to arrive at the site.
CancellationReason	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The reason for the service appointment cancellation.
City	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city where the appointment is completed. Maximum length is 40 characters.
Comments	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The comments for the service appointment.
Country	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country where the appointment is completed. Maximum length is 80 characters.
Description	Type textarea Properties Create, Nillable, Update Description The description of the appointment.
DueDate	Type dateTime Properties Create, Filter, Sort, Update Description The date by which the appointment must be completed.
Duration	Type double Properties Create, Filter, Nillable, Sort, Update Description The estimated length of the appointment as derived from the associated work type. The duration is in minutes or hours based on the value selected in the Duration Type field.
DurationType	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The unit of duration as specified for the associated work type. Possible values are: `Hours` `Minutes` The default value is `Hours`.
EarliestStartTime	Type dateTime Properties Create, Filter, Sort, Update Description The date after which the appointment must be completed.
GeocodeAccuracy	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The level of accuracy of a location’s geographical coordinates compared with its physical address. Usually provided by a geocoding service based on the address’s latitude and longitude coordinates. Possible values are: `Address` `Block` `City` `County` `ExtendedZip` `NearAddress` `Neighborhood` `State` `Street` `Unknown` `Zip`
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The date when the service appointment was last modified.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The date when the service appointment was last viewed.
Latitude	Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the address where the service appointments is completed. Acceptable values are numbers between –90 and 90 with up to 15 decimal places.
Longitude	Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the address where the service appointment is completed. Acceptable values are numbers between –180 and 180 with up to 15 decimal places.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the appointment. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User
ParentRecordId	Type reference Properties Create, Filter, Group, Nillable, Sort Description The parent record related to the appointment. The parent record can’t be updated after the service appointment is created. For test drive appointments, the parent record is a lead or an opportunity. For vehicle service appointments, theparent record is an asset that’s related to the vehicle. This field is a polymorphic relationship field. Relationship Name ParentRecord Relationship Type Lookup Refers To Account, Asset, Case, Lead, Opportunity, WorkOrder, WorkOrderLineItem
ParentRecordType	Type string Properties Filter, Group, Nillable, Sort Description (Read only) The type of parent record that provides context for the appointment, such as Asset, Lead, or Opportunity.
PostalCode	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code where the appointment is completed. Maximum length is 20 characters.
SchedEndTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time at which the appointment is scheduled to end.
SchedStartTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time at which the appointment is scheduled to start.
ServiceTerritoryId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The service territory associated with the appointment. This field is a relationship field. Relationship Name ServiceTerritory Relationship Type Lookup Refers To ServiceTerritory
State	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state where the service appointment is completed. Maximum length is 80 characters.
Status	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The status of the appointment. The picklist values can be customized. Possible values are: `Canceled` `Cannot Complete` `Checked In` `Completed` `Dispatched` `In Progress` `None` `Scheduled` The default value is `None`.
StatusCategory	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The category that each Status value falls into. The Status Category field’s values are identical to the default Status values. Possible values are: `Canceled`—Canceled `CannotComplete`—Cannot Complete `CheckedIn`—Checked In `Completed` `Dispatched` `InProgress`—In Progress `None` `Scheduled` The default value is `None`.
Street	Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street number and name where the service appointment is completed.
Subject	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An autopopulated phrase describing the type of appointment, such as Test Drive Appointment or Vehicle Service Appointment.
WorkTypeId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work type associated with the service appointment. This field is a relationship field. Relationship Name WorkType Relationship Type Lookup Refers To WorkType

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

ServiceAppointmentChangeEvent: Change events are available for the object.
ServiceAppointmentFeed: Feed tracking is available for the object.
ServiceAppointmentHistory: History is available for tracked fields of the object.
ServiceAppointmentOwnerSharingRule: Sharing rules are available for the object.
ServiceAppointmentShare: Sharing is available for the object.

Automotive Cloud Developer Guide

ServiceAppointment

Supported Calls

Special Access Rules

Fields

Associated Objects