WorkOrder

Represents a task or series of tasks to be performed, typically in field service. This object is available in API version 36.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Special Access Rules

Work orders must be enabled in your organization. Work orders are available in Enterprise, Performance, Unlimited, and Developer Editions with the Service Cloud.

Fields

Field Name	Details
AccountId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The account associated with the work order.
Address	Type address Properties Filter, Nillable Description The compound form of the address where the work order is completed.
AssetId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The asset associated with the work order.
CaseId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The case associated with the work order.
City	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city where the work order is completed. Maximum length is 40 characters.
ContactId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The contact associated with the work order.
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 work order. Try to include the steps needed to change the work order’s status to Completed.
Discount	Type percent Properties Filter, Nillable, Sort Description Read only. The weighted average of the discounts on all line items in the work order. It can be any positive number up to 100.
EndDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date when the work order is completed. This field is blank unless you set up an Apex trigger or quick action to populate it. For example, you can create a quick action that sets the EndDate to 365 days after the StartDate.
EntitlementId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The entitlement associated with the work order.
GeocodeAccuracy	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Read only. 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.
GrandTotal	Type currency Properties Filter, Nillable, Sort Description Read only. The total price of the work order with tax added.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The date when the work order 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 work order 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 work order is completed. Acceptable values are numbers between –90 and 90 with up to 15 decimal places.
LineItemCount	Type int Properties Filter, Group, Nillable, Sort Description The number of work order line items in the work order. Its label in the user interface is Line Items.
Longitude	Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the address where the work order is completed. Acceptable values are numbers between –180 and 180 with up to 15 decimal places.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The work order’s assigned owner.
ParentWorkOrderId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work order’s parent work order, if it has one. Create a custom report to view a work order’s child work orders. Tip
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.
Pricebook2Id	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The price book associated with the work order. Adding a price book to the work order lets you assign different price book entries to the work order’s line items. This is only available if Product2 is enabled.
Priority	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The priority of the work order. The picklist includes the following values, which can be customized: Low Medium High Critical
ServiceContractId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The service contract associated with the work order.
StartDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date when the work order goes into effect. This field is blank unless you set up an Apex trigger or quick action to populate it. For example, you can create a quick action that sets the StartDate to the date when the Status changes to In Progress.
State	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state where the work order 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 work order. The picklist includes the following values, which can be customized: New Scheduled Assigned In Progress Completed Closed
Street	Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street number and name where the work order is completed.
Subject	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The subject of the work order. Try to describe the nature and purpose of the job to be completed. For example, “Annual On-Site Well Maintenance.” Maximum length is 255 characters.
Subtotal	Type currency Properties Filter, Nillable, Sort Description Read only. The total of the work order line items’ subtotals before discounts and taxes are applied.
Tax	Type currency Properties Create, Filter, Nillable, Sort, Update Description The total tax on the work order. You can enter a number with or without the currency symbol and use up to two decimal places. For example, in a work order whose total price is $100, enter $10 to apply a 10% tax.
TotalPrice	Type currency Properties Filter, Nillable, Sort Description Read only. The total of the work order line items’ prices. This value has discounts applied but not tax.
WorkOrderNumber	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An eight-digit, auto-generated number that identifies the work order.

Usage

A work order can be a child record of accounts, assets, cases, contacts, entitlements, service contracts, and other work orders. We recommend adding work order line items to the work order to break the main task into smaller subtasks.

For example, suppose a customer purchased a truck from you. The truck is represented as an asset in your Salesforce org. After some time, the truck needs both headlight bulbs replaced. Here’s one way that you can use work orders to track the repair.

Create a work order named “Replace Headlight Bulbs” from the asset record detail page.
Add three work order line items to the work order: “Replace Left Headlight Bulb,” “Replace Right Headlight Bulb,” and “Test Headlights.”
Assign the work order to a technician via a queue.
As the technician completes each line item, he or she marks the item as Completed.
When all the line items are complete, the technician marks the work order as Completed.

Object Reference for Salesforce and Force.com

WorkOrder

Supported Calls

Special Access Rules

Fields

Usage