Address (CustomerAddress) table/entity reference (Microsoft Dataverse)

Address and shipping information. Used to store additional addresses for an account or contact.

Messages

The following table lists the messages for the Address (CustomerAddress) table. Messages represent operations that can be performed on the table. They may also be events.

Name Is Event?	Web API Operation	SDK for .NET
`Associate` Event: True	Associate records	Associate records
`Create` Event: True	`POST` /customeraddresses See Create	Create records
`Delete` Event: True	`DELETE` /customeraddresses(customeraddressid) See Delete	Delete records
`Disassociate` Event: True	Disassociate records	Disassociate records
`Retrieve` Event: True	`GET` /customeraddresses(customeraddressid) See Retrieve	Retrieve records
`RetrieveMultiple` Event: True	`GET` /customeraddresses See Query data	Query data
`Update` Event: True	`PATCH` /customeraddresses(customeraddressid) See Update	Update records
`Upsert` Event: False	`PATCH` /customeraddresses(customeraddressid) See Upsert a table row	UpsertRequest

Properties

The following table lists selected properties for the Address (CustomerAddress) table.

Property	Value
DisplayName	Address
DisplayCollectionName	Addresses
SchemaName	`CustomerAddress`
CollectionSchemaName	`CustomerAddresses`
EntitySetName	`customeraddresses`
LogicalName	`customeraddress`
LogicalCollectionName	`customeraddresses`
PrimaryIdAttribute	`customeraddressid`
PrimaryNameAttribute	`name`
TableType	`Standard`
OwnershipType	`None`

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

AddressNumber
AddressTypeCode
City
Country
County
CustomerAddressId
Fax
FreightTermsCode
ImportSequenceNumber
Latitude
Line1
Line2
Line3
Longitude
Name
ObjectTypeCode
OverriddenCreatedOn
ParentId
ParentIdTypeCode
PostalCode
PostOfficeBox
PrimaryContactName
ShippingMethodCode
StateOrProvince
Telephone1
Telephone2
Telephone3
TimeZoneRuleVersionNumber
TransactionCurrencyId
UPSZone
UTCConversionTimeZoneCode
UTCOffset

AddressNumber

Property	Value
Description	Shows the number of the address, to indicate whether the address is the primary, secondary, or other address for the customer.
DisplayName	Address Number
IsValidForForm	True
IsValidForRead	True
LogicalName	`addressnumber`
RequiredLevel	None
Type	Integer
MaxValue	1000000000
MinValue	0

AddressTypeCode

Property	Value
Description	Select the address type, such as primary or billing.
DisplayName	Address Type
IsValidForForm	True
IsValidForRead	True
LogicalName	`addresstypecode`
RequiredLevel	None
Type	Picklist
DefaultFormValue	-1
GlobalChoiceName	`customeraddress_addresstypecode`

AddressTypeCode Choices/Options

Value	Label
1	Bill To
2	Ship To
3	Primary
4	Other

City

Property	Value
Description	Type the city for the customer's address to help identify the location.
DisplayName	City
IsValidForForm	True
IsValidForRead	True
LogicalName	`city`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Active
IsLocalizable	False
MaxLength	80

Country

Property	Value
Description	Type the country or region for the customer's address.
DisplayName	Country/Region
IsValidForForm	True
IsValidForRead	True
LogicalName	`country`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Active
IsLocalizable	False
MaxLength	80

County

Property	Value
Description	Type the county for the customer's address.
DisplayName	County
IsValidForForm	True
IsValidForRead	True
LogicalName	`county`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Active
IsLocalizable	False
MaxLength	50

CustomerAddressId

Property	Value
Description	Unique identifier of the customer address.
DisplayName	Address
IsValidForForm	False
IsValidForRead	True
LogicalName	`customeraddressid`
RequiredLevel	SystemRequired
Type	Uniqueidentifier

Fax

Property	Value
Description	Type the fax number associated with the customer's address.
DisplayName	Fax
IsValidForForm	True
IsValidForRead	True
LogicalName	`fax`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Inactive
IsLocalizable	False
MaxLength	50

FreightTermsCode

Property	Value
Description	Select the freight terms to make sure shipping charges are processed correctly.
DisplayName	Freight Terms
IsValidForForm	True
IsValidForRead	True
LogicalName	`freighttermscode`
RequiredLevel	None
Type	Picklist
DefaultFormValue	-1
GlobalChoiceName	`customeraddress_freighttermscode`

FreightTermsCode Choices/Options

Value	Label
1	FOB
2	No Charge

ImportSequenceNumber

Property	Value
Description	Unique identifier of the data import or data migration that created this record.
DisplayName	Import Sequence Number
IsValidForForm	False
IsValidForRead	True
LogicalName	`importsequencenumber`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-2147483648

Latitude

Property	Value
Description	Type the latitude value for the customer's address, for use in mapping and other applications.
DisplayName	Latitude
IsValidForForm	True
IsValidForRead	True
LogicalName	`latitude`
RequiredLevel	None
Type	Double
ImeMode	Disabled
MaxValue	90
MinValue	-90
Precision	5

Line1

Property	Value
Description	Type the first line of the customer's address to help identify the location.
DisplayName	Street 1
IsValidForForm	True
IsValidForRead	True
LogicalName	`line1`
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Active
IsLocalizable	False
MaxLength	250

Line2

Property	Value
Description	Type the second line of the customer's address.
DisplayName	Street 2
IsValidForForm	True
IsValidForRead	True
LogicalName	`line2`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Active
IsLocalizable	False
MaxLength	250

Line3

Property	Value
Description	Type the third line of the customer's address.
DisplayName	Street 3
IsValidForForm	True
IsValidForRead	True
LogicalName	`line3`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Active
IsLocalizable	False
MaxLength	250

Longitude

Property	Value
Description	Type the longitude value for the customer's address, for use in mapping and other applications.
DisplayName	Longitude
IsValidForForm	True
IsValidForRead	True
LogicalName	`longitude`
RequiredLevel	None
Type	Double
ImeMode	Disabled
MaxValue	180
MinValue	-180
Precision	5

Name

Property	Value
Description	Type a descriptive name for the customer's address, such as Corporate Headquarters.
DisplayName	Address Name
IsValidForForm	True
IsValidForRead	True
LogicalName	`name`
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	200

ObjectTypeCode

Property	Value
Description	Shows the type code of the customer record to indicate whether the address belongs to a customer account or contact.
DisplayName	Object Type
IsValidForForm	False
IsValidForRead	True
LogicalName	`objecttypecode`
RequiredLevel	SystemRequired
Type	EntityName

OverriddenCreatedOn

Property	Value
Description	Date and time that the record was migrated.
DisplayName	Record Created On
IsValidForForm	False
IsValidForRead	True
LogicalName	`overriddencreatedon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateOnly
ImeMode	Inactive
SourceTypeMask	0

ParentId

Property	Value
Description	Choose the customer's address.
DisplayName	Parent
IsValidForForm	False
IsValidForRead	True
LogicalName	`parentid`
RequiredLevel	SystemRequired
Type	Lookup
Targets	account, contact

ParentIdTypeCode

Property	Value
Description
DisplayName	Parent Object Type
IsValidForForm	False
IsValidForRead	True
LogicalName	`parentidtypecode`
RequiredLevel	None
Type	EntityName

PostalCode

Property	Value
Description	Type the ZIP Code or postal code for the address.
DisplayName	ZIP/Postal Code
IsValidForForm	True
IsValidForRead	True
LogicalName	`postalcode`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Inactive
IsLocalizable	False
MaxLength	20

PostOfficeBox

Property	Value
Description	Type the post office box number of the customer's address.
DisplayName	Post Office Box
IsValidForForm	True
IsValidForRead	True
LogicalName	`postofficebox`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	20

PrimaryContactName

Property	Value
Description	Type the name of the primary contact person for the customer's address.
DisplayName	Address Contact
IsValidForForm	True
IsValidForRead	True
LogicalName	`primarycontactname`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	150

ShippingMethodCode

Property	Value
Description	Select a shipping method for deliveries sent to this address.
DisplayName	Shipping Method
IsValidForForm	True
IsValidForRead	True
LogicalName	`shippingmethodcode`
RequiredLevel	None
Type	Picklist
DefaultFormValue	-1
GlobalChoiceName	`customeraddress_shippingmethodcode`

ShippingMethodCode Choices/Options

Value	Label
1	Airborne
2