| AccountId |
- Type
- reference
- Properties
- Filter, Group, Nillable, Sort
- Description
- (Read only) The account associated with the appointment.
If the parent record is a work order or work order line
item, this field’s value is inherited from the parent.
Otherwise, it remains blank.
- This is a relationship field.
- Relationship Name
- Account
- Relationship Type
- Lookup
- Refers To
- Account
|
| ActualDuration |
- Type
- double
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- The number of minutes that it took the resource to
complete the appointment after arriving at the address.
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.
|
| Address |
- Type
- address
- Properties
- Filter
- Description
- The address where the appointment is taking place. The
address is inherited from the parent record if the
parent record is a work order or work order line
item.
|
| 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. This window is typically larger than the Scheduled
Start and End window to allow time for delays and
scheduling changes. You may choose to share the
Arrival Window Start and End with the customer, but
keep the Scheduled Start and End
internal-only.
|
| 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. This window is typically larger than the Scheduled
Start and End window to allow time for delays and
scheduling changes. You may choose to share the
Arrival Window Start and End with the customer, but
keep the Scheduled Start and End
internal-only.
|
| BundlePolicyId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Reference to the bundle policy associated with this
service appointment.
- This is a relationship field.
- Relationship Name
- BundlePolicy
- Relationship Type
- Lookup
- Refers To
- ApptBundlePolicy
|
| City |
- Type
- string
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The city where the appointment is completed. Maximum
length is 40 characters.
|
| ContactId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The contact associated with the parent record. If
needed, you can manually update the service appointment
contact.
- This is a relationship field.
- Relationship Name
- Contact
- Relationship Type
- Lookup
- Refers To
- Contact
|
| Country |
- Type
- string
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The country where the work order 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.
Earliest Start Permitted and Due Date typically reflect
terms in the customer’s service-level agreement.
|
| Duration |
- Type
- double
- Properties
- Create, Nillable, Filter, Sort, Update
- Description
- The estimated length of the appointment. If the parent
record is work order or work order line item, the
appointment inherits its parent’s duration, but it can
be manually updated. 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 the Duration: Minutes or Hours.
|
| EarliestStartTime |
- Type
- dateTime
- Properties
- Create, Filter, Sort, Update
- Description
- The date after which the appointment must be completed.
Earliest Start Permitted and Due Date typically reflect
terms in the customer’s service-level agreement.
|
| 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.
This field is available in the API
only.
|
| IsAnonymousBooking |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort,
Update
- Description
- Indicates whether a service resource was automatically
assigned to the appointment. The default value is
false.
- This field is available in API version 49.0 and
later.
|
| IsBundle |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort,
Update
- Description
- Indicates if this service appointment is a bundle
service appointment. The default value is false.
- This field is available in API version 54.0 and
later.
|
| IsBundleMember |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort,
Update
- Description
- Indicates if this service appointment is a bundle member
service appointment. The default value is false.
- This field is available in API version 54.0 and
later.
|
| IsManuallyBundled |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort,
Update
- Description
- Indicates if this bundle was created manually. The
default value is false.
- This field is available in API version 54.0 and
later.
|
| IsOffsiteAppointment |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort,
Update
- Description
- Any type of work that can be done remotely.
- This field is available in API version 58.0 and
later.
|
| LastReferencedDate |
- Type
- dateTime
- Properties
- Filter, Nillable, Sort
- Description
- The date when the service appointment was last modified.
Its label in the user interface is Last
Modified Date.
|
| 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.
To integrate data from an external data source for
latitude, map your data to the
ServiceAppointment.Latitude and not the
ServiceAppointment.FSL__InternalSLRGeolocation__Latitude__s
field.
This field is available in the API
only.
|
| 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.
To integrate data from an external data source for
longitude, map your data to the
ServiceAppointment.Longitude
and not the
ServiceAppointment.FSL__InternalSLRGeolocation__Longitude__s
field.
This field is available in the API
only.
|
| OwnerId |
- Type
- reference
- Properties
- Create, Defaulted on create, Filter, Group, Sort,
Update
- Description
- The owner of the service appointment.
- This 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 associated with the appointment. The
parent record can’t be updated after the service
appointment is created.
- This is a polymorphic relationship field.
- Relationship Name
- ParentRecord
- Relationship Type
- Lookup
- Refers To
- Account, Asset, Lead, Opportunity,
ServiceAppointmentGroup, WorkOrder,
WorkOrderLineItem
|
| ParentRecordStatusCategory |
- Type
- picklist
- Properties
- Defaulted on create, Filter, Group, Nillable, Restricted
picklist, Sort
- Description
- (Read only) The Status Category of
the parent record. If the parent record is a work order
or work order line item, this field is populated;
otherwise, it remains blank.
|
| ParentRecordType |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- (Read only) The type of parent record: Account, Asset,
Lead, Opportunity, Work Order, or Work Order Line
Item.
|
| PostalCode |
- Type
- string
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The postal code where the work order is completed.
Maximum length is 20 characters.
|
| RelatedBundleId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The bundle that this service appointment is a member
of.
- This is a relationship field.
- Relationship Name
- RelatedBundle
- Relationship Type
- Lookup
- Refers To
- ServiceAppointment
|
| SchedEndTime |
- Type
- dateTime
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- The time at which the appointment is scheduled to end.
If you are using the Field
Service managed package with the scheduling
optimizer, this field is populated once the
appointment is assigned to a resource.
Scheduled End –
Scheduled Start =
Estimated Duration.
|
| SchedStartTime |
- Type
- dateTime
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- The time at which the appointment is scheduled to start.
If you are using the Field Service managed package with
the scheduling optimizer, this field is populated once
the appointment is assigned to a resource.
|
| ServiceDocumentTemplate |
- Type
- string
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The template ID which sets the template for each service
document for the Document Builder feature.
|
| ServiceTerritoryId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The service territory associated with the appointment.
If the parent record is a work order or work order line
item, the appointment inherits its parent’s service
territory.
- This 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 includes the
following values, which can be customized:
-
None—Default
value.
-
Scheduled—Appointment
has been assigned to a service resource.
-
Dispatched—Assigned
service resource has been notified about their
assignment.
-
In Progress—Work has
begun.
-
Completed—Work is
complete.
-
Cannot Complete—Work
could not be completed.
-
Canceled—Work is
canceled, typically before any work began
While you can set the status to null via the
API, setting the status to null returns an error. To
prevent errors, use one of the picklist
values.
|
| 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.
If you create
custom Status values, you must
indicate which category it belongs to. For example,
if you create a Customer
Absent value, you may decide that it
belongs in the Cannot
Complete category. To learn which
processes reference StatusCategory, see How are Status Categories Used?
|
| 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
- A short phrase describing the appointment.
|
| Transaction |
- Type
- string
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The last transaction ID of the scheduling and
optimization request that updated this object. The
transaction ID is automatically generated and populated
by the Enhanced Scheduling and Optimization engine.
Available in API version 63.0 and later.
|
| WorkTypeId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The work type associated with the service appointment.
The work type is inherited from the appointment’s parent
record if the parent is a work order or work order line
item.
If Lightning Scheduler is also in use,
this field is editable. However, users see an error
if they update it to list a different work type than
the parent record’s work type.
- This is a relationship field.
- Relationship Name
- WorkType
- Relationship Type
- Lookup
- Refers To
- WorkType
|
j