Location

Represents a warehouse, service vehicle, work site, or other element of the region where your team performs field service work. This object is available in API version 59.0 and later.

The standard fields are documented in the Location object reference.

Supported Calls

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

Fields

ActivationDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date on which service was started at this location.

BusinessHoursId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The Business Hours object associated with the Location This field is a relationship field.
Relationship Name: BusinessHours
Refers To: BusinessHours

DistributionArea

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The electricity, gas, or water distribution area this location belongs to.

GrossFloorArea

Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The value of the sum of the floor area of the spaces within the location

GrossFloorAreaUom

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Specifies the unit of measure for Gross Floor Area of the location
Possible values:
- Square Feet
- Square Meters

HasLifeSupport

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the location has life-support equipment.
Default value: false

HasSensitiveLoad

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the location has sensitive load equipment.
Default value: false

IsKeyAtPremises

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the key is available at the location
Default value: false

IsOkToEnter

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the field service representative has permission to enter the location
Default value: false

IsSupplyGuaranteed

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether supply is guaranteed at the location
Default value: false

MeterReadInstructions

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The instructions for the field service representative on where to find the meter in this location

MeterReadWarning

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The warnings for the field service representative of potentially dangerous situations or conditions at this location

NumberOfOccupants

Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The number of occupants at this location.

PrimaryPropertyFunction

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Specifies the primary use of the location
Possible values:
- Bank
- Education
- Grocery
- Hotel
- Manufacturing
- Public Assembly
- Recreation
- Residential
- Restaurant

PropertyOwnerAccountId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The Account object associated with the Location This field is a relationship field.
Relationship Name: PropertyOwnerAccount
Refers To: Account

Status

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Specifies the status of the location.
Possible values:
- Active
- Demolished
- Inactive
- Under Construction

SupplyGuaranteeReason

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The reason for which supply is guaranteed at the location

ExternalReference

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Identifier of a location.

IsInventoryLocation

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the location stores parts. This field must be selected if you want to associate the location with product items.
Default value: false

IsMobile

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the location moves. For example, a truck or tool box.
Default value: false

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The date when the location was last modified. Its label in the user interface is Last Modified Date.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The date the location was last viewed.

LocationType

Type: picklist
Properties: Create, Filter, Group, Sort, Update
Description: Picklist of location types. It has no default values, so you must populate it before creating any location records.

LogoId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: A ContentAsset representing a logo for the location. This field is a relationship field.
Relationship Name: Logo
Relationship Type: Lookup
Refers To: ContentAsset

Name

Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: The name of the location. For example, Service Van #4.

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The location’s owner or driver. This field is a polymorphic relationship field.
Relationship Name: Owner
Relationship Type: Lookup
Refers To: Group, User

RootLocationId

Type: reference
Properties: Filter, Group, Nillable, Sort
Description: (Read Only) The top-level location in the location’s hierarchy. This field is a relationship field.
Relationship Name: RootLocation
Relationship Type: Lookup
Refers To: Location