ServiceAppointmentStatus | Object Reference for Salesforce and Lightning Platform

Supported Calls

describeSObjects(), query(), retrieve()

Special Access Rules

Field Service Lightning must be enabled.

Fields

Field Name	Details
ApiName	Type string Properties Filter, Group, 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

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.

The Status Category field can be useful to reference in custom apps, triggers, and validation rules. Status categories let you extend and customize the work life cycle while still maintaining a consistent work classification for tracking, reporting, and business process management.

Note