---
schema_version: "1"
id: 8d17c1e6e12a97dc561d54194dea2282eb21a037ae9ae93e4c897aa92cd081c7
title: ServiceAppointmentStatus
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_serviceappointmentstatus.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_serviceappointmentstatus.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: ed1b07e33810633836e8c4d0dbf0859a24a5eae13ca0800775834d10badfd91a
description: Represents a possible status of a service appointment in field service.
---
# 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.

![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png)

#### Important

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.

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.

![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png)

#### Note

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?](https://help.salesforce.com/articleView?id=fs_status_categories.htm&language=en_US)