Newer Version Available

This content describes an older version of this product. View Latest

Address

Represents a mailing, billing, or home address.

Supported Calls

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

Special Access Rules

Field Service Lightning must be enabled.

Fields

Field Name Details
Address
Type
address
Properties
Filter, Nillable
Description
The full address.
AddressType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Picklist of address types. The values are:
  • Mailing
  • Shipping
  • Billing
  • Home
City
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The address city.
Country
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The address country.
Description
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A brief description of the address.
DrivingDirections
Type
string
Properties
Create, Filter, Nillable, Sort, Update
Description
Directions to the address.
GeocodeAccuracy
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The level of accuracy of a location’s geographical coordinates compared with its physical address. A geocoding service typically provides this value based on the address’s latitude and longitude coordinates.
Latitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with Longitude to specify the precise geolocation of the address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places.
LocationType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Picklist of location types. The values are:
  • Warehouse (default)
  • Site
  • Van
  • Plant
Longitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with Latitude to specify the precise geolocation of the address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, Sort
Description
An auto-generated number identifying the address.
ParentId
Type
reference
Properties
Create, Filter, Group, Sort
Description
A lookup field to the parent address. For example, if the address is a billing address, its parents address might be the address of the associated warehouse.
PostalCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The address postal code.
State
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The address state.
Street
Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The address street.
TimeZone
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Picklist of available time zones.

Usage

“Address” in Salesforce can also refer to the Address compound field found on many standard objects. When referencing the Address object in your Apex code, always use Schema.Address instead of Address to prevent confusion with the standard Address compound field. If referencing both the address object and the Address field in the same snippet, you can differentiate between the two by using System.Address for the field and Schema.Address for the object.

Important