---
schema_version: "1"
id: d360f5469fe06392354f4dbd16e5e3e39b17ca7a153366068eb0b57930471a07
title: WorkOrderStatus
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_workorderstatus.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workorderstatus.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: adb238e224bfa29f87e644959392ae0a77a451987261c2afe6d53a65e9a99786
description: Represents a possible status of a work order in field service.
---
# WorkOrderStatus

Represents a possible status of a work order 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 work orders. 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 work orders comes with the following values:

- New—Work order was created, but there hasn’t yet been any activity.
- In Progress—Work has begun.
- On Hold—Work is paused.
- Completed—Work is complete.
- Cannot Complete—Work could not be completed.
- Closed—All work and associated activity is complete.
- Canceled—Work is canceled, typically before any work began.

The WorkOrderStatus object corresponds to the Status field. Adding a value to the Status field—for example, Canceled By Customer—creates a work order status record, and vice versa.

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

#### Note

Work orders 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)