customeraddress EntityType

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

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

Entity Set path:[organization URI]/api/data/v8.2/customeraddresses

Base Type: crmbaseentity EntityType

Display Name: Address

Primary Key: customeraddressid

Primary Name Attribute: name

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Properties

Properties represent fields of data stored in the entity. Some properties are read-only.

Name

Type

Details

addressnumber

Edm.Int32

Description: Shows the number of the address, to indicate whether the address is the primary, secondary, or other address for the customer.

Display Name: Address Number

addresstypecode

Edm.Int32

Description: Select the address type, such as primary or billing.

Default Options:

1 : Bill To
2 : Ship To
3 : Primary
4 : Other

Display Name: Address Type

city

Edm.String

Description: Type the city for the customer's address to help identify the location.

Display Name: City

composite

Edm.String

Description: Shows the complete address.

Display Name: Address

Read-only property

country

Edm.String

Description: Type the country or region for the customer's address.

Display Name: Country/Region

county

Edm.String

Description: Type the county for the customer's address.

Display Name: County

createdon

Edm.DateTimeOffset

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.

Display Name: Created On

Read-only property

customeraddressid

Edm.Guid

Description: Unique identifier of the customer address.

Display Name: Address

exchangerate

Edm.Decimal

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.

Display Name: Exchange Rate

Read-only property

fax

Edm.String

Description: Type the fax number associated with the customer's address.

Display Name: Fax

freighttermscode

Edm.Int32

Description: Select the freight terms to make sure shipping charges are processed correctly.

Default Options:

1 : FOB
2 : No Charge

Display Name: Freight Terms

importsequencenumber

Edm.Int32

Description: Unique identifier of the data import or data migration that created this record.

Display Name: Import Sequence Number

latitude

Edm.Double

Description: Type the latitude value for the customer's address, for use in mapping and other applications.

Display Name: Latitude

line1

Edm.String

Description: Type the first line of the customer's address to help identify the location.

Display Name: Street 1

line2

Edm.String

Description: Type the second line of the customer's address.

Display Name: Street 2

line3

Edm.String

Description: Type the third line of the customer's address.

Display Name: Street 3

longitude

Edm.Double

Description: Type the longitude value for the customer's address, for use in mapping and other applications.

Display Name: Longitude

modifiedon

Edm.DateTimeOffset

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.

Display Name: Modified On

Read-only property

name

Edm.String

Description: Type a descriptive name for the customer's address, such as Corporate Headquarters.

Display Name: Address Name

objecttypecode

Edm.String

Description: Shows the type code of the customer record to indicate whether the address belongs to a customer account or contact.

Display Name: Object Type

overriddencreatedon

Edm.DateTimeOffset

Description: Date and time that the record was migrated.

Display Name: Record Created On

postalcode

Edm.String

Description: Type the ZIP Code or postal code for the address.

Display Name: ZIP/Postal Code

postofficebox

Edm.String

Description: Type the post office box number of the customer's address.

Display Name: Post Office Box

primarycontactname

Edm.String

Description: Type the name of the primary contact person for the customer's address.

Display Name: Address Contact

shippingmethodcode

Edm.Int32

Description: Select a shipping method for deliveries sent to this address.

Default Options:

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

Display Name: Shipping Method

stateorprovince

Edm.String

Description: Type the state or province of the customer's address.

Display Name: State/Province

telephone1

Edm.String

Description: Type the primary phone number for the customer's address.

Display Name: Main Phone

telephone2

Edm.String

Description: Type a second phone number for the customer's address.

Display Name: Phone 2

telephone3

Edm.String

Description: Type a third phone number for the customer's address.

Display Name: Telephone 3

timezoneruleversionnumber

Edm.Int32

Description: For internal use only.

Display Name: Time Zone Rule Version Number

upszone

Edm.String

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.

Display Name: UPS Zone

utcconversiontimezonecode

Edm.Int32

Description: Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

utcoffset

Edm.Int32

Description: Select the time zone for the address.

Display Name: UTC Offset

versionnumber

Edm.Int64

Description: Version number of the customer address.

Display Name: Version Number

Read-only property

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Retrieve data about lookup properties

Name

Single-valued navigation property

Description

_createdby_value

createdby

Shows who created the record.

_createdonbehalfby_value

createdonbehalfby

Shows who created the record on behalf of another user.

_modifiedby_value

modifiedby

Shows who last updated the record.

_modifiedonbehalfby_value

modifiedonbehalfby

Shows who last updated the record on behalf of another user.

_ownerid_value

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.

_owningbusinessunit_value

Shows the business unit that the record owner belongs to.

_owninguser_value

Unique identifier of the user who owns the customer address.

_parentid_value

parentid_account

parentid_contact

Choose the customer's address.

_transactioncurrencyid_value

transactioncurrencyid

Choose the local currency for the record to make sure budgets are reported in the correct currency.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name

Type

Partner

createdby

systemuser EntityType

lk_customeraddressbase_createdby

createdonbehalfby

systemuser EntityType

lk_customeraddress_createdonbehalfby

modifiedby

systemuser EntityType

lk_customeraddressbase_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_customeraddress_modifiedonbehalfby

parentid_account

account EntityType

Account_CustomerAddress

parentid_contact

contact EntityType

Contact_CustomerAddress

transactioncurrencyid

transactioncurrency EntityType

TransactionCurrency_CustomerAddress

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name

Type

Partner

customer_address_contract_line_items

contractdetail EntityType

serviceaddress

customer_address_contracts_as_billing_address

contract EntityType

billtoaddress

customer_address_contracts_as_service_address

contract EntityType

serviceaddress

CustomerAddress_AsyncOperations

asyncoperation EntityType

regardingobjectid_customeraddress

CustomerAddress_BulkDeleteFailures

bulkdeletefailure EntityType

regardingobjectid_customeraddress

CustomerAddress_SyncErrors

syncerror EntityType

regardingobjectid_customeraddress_syncerror

See Also

Use the Microsoft Dynamics 365 Web API
Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright