Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

ServiceAppointmentStatus

Represents a possible status of a service appointment in field service.

Supported Calls

describeSObjects(), query(), retrieve()

Special Access Rules

Field Service must be enabled.

Fields

Field Name	Details
ApiName	Type string Properties Filter, Group, idLookup, Sort Description The API name of the status value.
IsDefault	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates that the status value is the default status on service appointments. Only one status value can be the default.
MasterLabel	Type string Properties Filter, Group, Nillable, Sort Description The label for the picklist value that appears in the UI.
SortOrder	Type int Properties Filter, Group, Nillable, Sort Description The value’s position in the drop-down list of values in the UI.
StatusCode	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The status category that the value corresponds to. The Status Category field has seven values which are identical to the default Status values.

Usage

The Status field on service appointments comes with the following values:

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
CheckedIn—The customer has arrived for their scheduled appointment.

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 documented picklist values.

Important

The ServiceAppointmentStatus object corresponds to the Status field. Adding a value to the Status field—for example, Waiting—creates a service appointment status record, and vice versa.

Service appointments also come with a StatusCategory field whose 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?

Note

Field Service Developer Guide

ServiceAppointmentStatus

Supported Calls

Special Access Rules

Fields

Usage