CustomerAddress Entity Reference

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

Messages

Message Web API Operation SDK Assembly
Create POST [org URI]/api/data/v9.0/customeraddresses
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/customeraddresses(customeraddressid)
See Delete
DeleteRequest or
Delete
Retrieve GET [org URI]/api/data/v9.0/customeraddresses(customeraddressid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/customeraddresses
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
Update PATCH [org URI]/api/data/v9.0/customeraddresses(customeraddressid)
See Update
UpdateRequest or
Update

Entity Properties

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

Writable attributes

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

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
Format None
IsValidForForm True
IsValidForRead True
LogicalName addressnumber
MaxValue 1000000000
MinValue 0
RequiredLevel None
Type Integer

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

AddressTypeCode 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
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName city
MaxLength 80
RequiredLevel None
Type String

Country

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

County

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

CustomerAddressId

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

Fax

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

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

FreightTermsCode 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
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

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
MaxValue 90
MinValue -90
Precision 5
RequiredLevel None
Type Double

Line1

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

Line2

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

Line3

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

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
MaxValue 180
MinValue -180
Precision 5
RequiredLevel None
Type Double

Name

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

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
DateTimeBehavior UserLocal
Description Date and time that the record was migrated.
DisplayName Record Created On
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime

ParentId

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

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
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName postalcode
MaxLength 20
RequiredLevel None
Type String

PostOfficeBox

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

PrimaryContactName

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

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

ShippingMethodCode Options

Value Label
1 Airborne
2 DHL
3 FedEx
4 UPS
5 Postal Mail
6 Full Load
7 Will Call

StateOrProvince

Property Value
Description Type the state or province of the customer's address.
DisplayName State/Province
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName stateorprovince
MaxLength 50
RequiredLevel None
Type String

Telephone1

Property Value
Description Type the primary phone number for the customer's address.
DisplayName Main Phone
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName telephone1
MaxLength 50
RequiredLevel None
Type String

Telephone2

Property Value
Description Type a second phone number for the customer's address.
DisplayName Phone 2
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName telephone2
MaxLength 50
RequiredLevel None
Type String

Telephone3

Property Value
Description Type a third phone number for the customer's address.
DisplayName Telephone 3
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName telephone3
MaxLength 50
RequiredLevel None
Type String

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

TransactionCurrencyId

Property Value
Description Choose the local currency for the record to make sure budgets are reported in the correct currency.
DisplayName Currency
IsValidForForm True
IsValidForRead True
LogicalName transactioncurrencyid
RequiredLevel None
Targets transactioncurrency
Type Lookup

UPSZone

Property Value
Description Type the UPS zone of the customer's address to make sure shipping charges are calculated correctly and deliveries are made promptly, if shipped by UPS.
DisplayName UPS Zone
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName upszone
MaxLength 4
RequiredLevel None
Type String

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

UTCOffset

Property Value
Description Select the time zone for the address.
DisplayName UTC Offset
Format TimeZone
IsValidForForm True
IsValidForRead True
LogicalName utcoffset
MaxValue 1500
MinValue -1500
RequiredLevel None
Type Integer

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

Composite

Property Value
Description Shows the complete address.
DisplayName Address
Format TextArea
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName composite
MaxLength 1000
RequiredLevel None
Type Memo

CreatedBy

Property Value
Description Shows who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel None
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Property Value
Description Shows who created the record on behalf of another user.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

ExchangeRate

Property Value
Description Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.
DisplayName Exchange Rate
IsValidForForm True
IsValidForRead True
LogicalName exchangerate
MaxValue 100000000000
MinValue 0.0000000001
Precision 10
RequiredLevel None
Type Decimal

ModifiedBy

Property Value
Description Shows who last updated the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel None
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Property Value
Description Shows who last updated the record on behalf of another user.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

OwnerId

Property Value
Description Enter the user or team who is assigned to manage the record. This field is updated every time the record is assigned to a different user.
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel ApplicationRequired
Targets systemuser,team
Type Owner

OwnerIdType

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

OwningBusinessUnit

Property Value
Description Shows the business unit that the record owner belongs to.
DisplayName Owning Business Unit
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Targets businessunit
Type Lookup

OwningUser

Property Value
Description Unique identifier of the user who owns the customer address.
DisplayName Owner
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Targets systemuser
Type Lookup

TransactionCurrencyIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName transactioncurrencyidname
MaxLength 100
RequiredLevel None
Type String

VersionNumber

Property Value
Description Version number of the customer address.
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

CustomerAddress_BulkDeleteFailures

Same as bulkdeletefailure entity CustomerAddress_BulkDeleteFailures Many-To-One relationship.

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName CustomerAddress_BulkDeleteFailures
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

CustomerAddress_SyncErrors

Same as syncerror entity CustomerAddress_SyncErrors Many-To-One relationship.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName CustomerAddress_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

CustomerAddress_AsyncOperations

Same as asyncoperation entity CustomerAddress_AsyncOperations Many-To-One relationship.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName CustomerAddress_AsyncOperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

CustomerAddress_ProcessSessions

Same as processsession entity CustomerAddress_ProcessSessions Many-To-One relationship.

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName CustomerAddress_ProcessSessions
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 110
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

customeraddress_principalobjectattributeaccess

Same as principalobjectattributeaccess entity customeraddress_principalobjectattributeaccess Many-To-One relationship.

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName customeraddress_principalobjectattributeaccess
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

lk_customeraddress_modifiedonbehalfby

See systemuser Entity lk_customeraddress_modifiedonbehalfby One-To-Many relationship.

TransactionCurrency_CustomerAddress

See transactioncurrency Entity TransactionCurrency_CustomerAddress One-To-Many relationship.

Contact_CustomerAddress

See contact Entity Contact_CustomerAddress One-To-Many relationship.

Account_CustomerAddress

See account Entity Account_CustomerAddress One-To-Many relationship.

lk_customeraddress_createdonbehalfby

See systemuser Entity lk_customeraddress_createdonbehalfby One-To-Many relationship.

lk_customeraddressbase_modifiedby

See systemuser Entity lk_customeraddressbase_modifiedby One-To-Many relationship.

lk_customeraddressbase_createdby

See systemuser Entity lk_customeraddressbase_createdby One-To-Many relationship.

See also

About the Entity Reference
Web API Reference
customeraddress EntityType