LeadAddress entity reference
Address information for a lead.
Added by: Lead Management Solution
Messages
Message | SDK class or method |
---|---|
Retrieve | RetrieveRequest or Retrieve |
RetrieveMultiple | RetrieveMultipleRequest or RetrieveMultiple |
Properties
Property | Value |
---|---|
CollectionSchemaName | LeadAddresses |
DisplayCollectionName | Lead Addresses |
DisplayName | Lead Address |
EntitySetName | leadaddresses |
IsBPFEntity | False |
LogicalCollectionName | leadaddresses |
LogicalName | leadaddress |
OwnershipType | None |
PrimaryIdAttribute | leadaddressid |
PrimaryNameAttribute | name |
SchemaName | LeadAddress |
Writable attributes
These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- AddressNumber
- AddressTypeCode
- City
- Country
- County
- Fax
- ImportSequenceNumber
- Latitude
- LeadAddressId
- Line1
- Line2
- Line3
- Longitude
- Name
- OverriddenCreatedOn
- ParentId
- PostalCode
- PostOfficeBox
- ShippingMethodCode
- StateOrProvince
- Telephone1
- Telephone2
- Telephone3
- TimeZoneRuleVersionNumber
- TransactionCurrencyId
- UPSZone
- UTCConversionTimeZoneCode
- UTCOffset
AddressNumber
Property | Value |
---|---|
Description | Information about the address for the lead. |
DisplayName | Address Number |
Format | None |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | addressnumber |
MaxValue | 2147483647 |
MinValue | -2147483648 |
RequiredLevel | None |
Type | Integer |
AddressTypeCode
Property | Value |
---|---|
Description | Type of address for the lead address. |
DisplayName | Address Type |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | addresstypecode |
RequiredLevel | None |
Type | Picklist |
AddressTypeCode Choices/Options
Value | Label | Description |
---|
City
Property | Value |
---|---|
Description | City name in the address for the lead. |
DisplayName | City |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | city |
MaxLength | 80 |
RequiredLevel | None |
Type | String |
Country
Property | Value |
---|---|
Description | Country/region name in the address for the lead. |
DisplayName | Country/Region |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | country |
MaxLength | 80 |
RequiredLevel | None |
Type | String |
County
Property | Value |
---|---|
Description | County name in the address for the lead. |
DisplayName | County |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | county |
MaxLength | 50 |
RequiredLevel | None |
Type | String |
Fax
Property | Value |
---|---|
Description | Fax number for the address for the lead. |
DisplayName | Fax |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | fax |
MaxLength | 50 |
RequiredLevel | None |
Type | String |
ImportSequenceNumber
Property | Value |
---|---|
Description | Sequence number of the import 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 | Latitude for the address for the lead. |
DisplayName | Latitude |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | latitude |
MaxValue | 90 |
MinValue | -90 |
Precision | 5 |
RequiredLevel | None |
Type | Double |
LeadAddressId
Property | Value |
---|---|
Description | Unique identifier of the lead address. |
DisplayName | Address |
IsValidForForm | False |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | leadaddressid |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
Line1
Property | Value |
---|---|
Description | First line for entering address information. |
DisplayName | Street 1 |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | line1 |
MaxLength | 250 |
RequiredLevel | None |
Type | String |
Line2
Property | Value |
---|---|
Description | Second line for entering address information. |
DisplayName | Street 2 |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | line2 |
MaxLength | 250 |
RequiredLevel | None |
Type | String |
Line3
Property | Value |
---|---|
Description | Third line for entering address information. |
DisplayName | Street 3 |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | line3 |
MaxLength | 250 |
RequiredLevel | None |
Type | String |
Longitude
Property | Value |
---|---|
Description | Longitude for the address for the lead. |
DisplayName | Longitude |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | longitude |
MaxValue | 180 |
MinValue | -180 |
Precision | 5 |
RequiredLevel | None |
Type | Double |
Name
Property | Value |
---|---|
Description | Name used to identify the lead address. |
DisplayName | Address Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | name |
MaxLength | 200 |
RequiredLevel | None |
Type | String |
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 | Unique identifier of the parent object with which the lead address is associated. |
DisplayName | Parent |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | parentid |
RequiredLevel | SystemRequired |
Targets | lead |
Type | Lookup |
PostalCode
Property | Value |
---|---|
Description | ZIP Code or postal code in the address for the lead. |
DisplayName | ZIP/Postal Code |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | postalcode |
MaxLength | 20 |
RequiredLevel | None |
Type | String |
PostOfficeBox
Property | Value |
---|---|
Description | Post office box number in the address for the lead. |
DisplayName | Post Office Box |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | postofficebox |
MaxLength | 20 |
RequiredLevel | None |
Type | String |
ShippingMethodCode
Property | Value |
---|---|
Description | Method of shipment for the lead. |
DisplayName | Shipping Method |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | shippingmethodcode |
RequiredLevel | None |
Type | Picklist |
ShippingMethodCode Choices/Options
Value | Label | Description |
---|
StateOrProvince
Property | Value |
---|---|
Description | State or province in the address for the lead. |
DisplayName | State/Province |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | stateorprovince |
MaxLength | 50 |
RequiredLevel | None |
Type | String |
Telephone1
Property | Value |
---|---|
Description | First telephone number for the lead address. |
DisplayName | Main Phone |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | telephone1 |
MaxLength | 50 |
RequiredLevel | None |
Type | String |
Telephone2
Property | Value |
---|---|
Description | Second telephone number for the lead address. |
DisplayName | Phone 2 |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | telephone2 |
MaxLength | 50 |
RequiredLevel | None |
Type | String |
Telephone3
Property | Value |
---|---|
Description | Third telephone number for the lead 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 | Unique identifier of the currency associated with the leadaddress. |
DisplayName | Currency |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | transactioncurrencyid |
RequiredLevel | None |
Targets | transactioncurrency |
Type | Lookup |
UPSZone
Property | Value |
---|---|
Description | United Parcel Service (UPS) zone for the address of the lead. |
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 | UTC offset for the lead address. This is the difference between local time and standard Coordinated Universal Time. |
DisplayName | UTC Offset |
Format | None |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | utcoffset |
MaxValue | 2147483647 |
MinValue | -2147483648 |
RequiredLevel | None |
Type | Integer |
Read-only attributes
These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
- Composite
- CreatedBy
- CreatedByName
- CreatedByYomiName
- CreatedOn
- CreatedOnBehalfBy
- CreatedOnBehalfByName
- CreatedOnBehalfByYomiName
- ExchangeRate
- ModifiedBy
- ModifiedByName
- ModifiedByYomiName
- ModifiedOn
- ModifiedOnBehalfBy
- ModifiedOnBehalfByName
- ModifiedOnBehalfByYomiName
- OwnerId
- OwningBusinessUnit
- ParentIdName
- ParentIdYomiName
- TransactionCurrencyIdName
- VersionNumber
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 | Unique identifier of the user who created the lead address. |
DisplayName | Created By |
IsValidForForm | False |
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 | Date and time when the lead address was created. |
DisplayName | Created On |
Format | DateAndTime |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdon |
RequiredLevel | None |
Type | DateTime |
CreatedOnBehalfBy
Property | Value |
---|---|
Description | Unique identifier of the delegate user who created the leadaddress. |
DisplayName | Created By (Delegate) |
IsValidForForm | False |
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 | Exchange rate for the currency associated with the leadaddress with respect to the base 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 | Unique identifier of the user who last modified the lead address. |
DisplayName | Modified By |
IsValidForForm | False |
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 | Date and time when the lead address was last modified. |
DisplayName | Modified On |
Format | DateAndTime |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedon |
RequiredLevel | None |
Type | DateTime |
ModifiedOnBehalfBy
Property | Value |
---|---|
Description | Unique identifier of the delegate user who last modified the leadaddress. |
DisplayName | Modified By (Delegate) |
IsValidForForm | False |
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 | |
DisplayName | |
IsValidForForm | False |
IsValidForRead | False |
LogicalName | ownerid |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
OwningBusinessUnit
Property | Value |
---|---|
Description | |
DisplayName | |
IsValidForForm | False |
IsValidForRead | False |
LogicalName | owningbusinessunit |
RequiredLevel | None |
Type | Uniqueidentifier |
ParentIdName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | parentidname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
ParentIdYomiName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | parentidyominame |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
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 |
DisplayName | Version Number |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | versionnumber |
MaxValue | 9223372036854775807 |
MinValue | -9223372036854775808 |
RequiredLevel | None |
Type | BigInt |
One-To-Many Relationships
Listed by SchemaName.
- LeadAddress_SyncErrors
- leadaddress_AsyncOperations
- leadaddress_MailboxTrackingFolders
- leadaddress_BulkDeleteFailures
- leadaddress_PrincipalObjectAttributeAccesses
LeadAddress_SyncErrors
Added by: System Solution Solution
Same as the LeadAddress_SyncErrors many-to-one relationship for the syncerror entity.
Property | Value |
---|---|
ReferencingEntity | syncerror |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | LeadAddress_SyncErrors |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: Cascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
leadaddress_AsyncOperations
Added by: System Solution Solution
Same as the leadaddress_AsyncOperations many-to-one relationship for the asyncoperation entity.
Property | Value |
---|---|
ReferencingEntity | asyncoperation |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | leadaddress_AsyncOperations |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
leadaddress_MailboxTrackingFolders
Added by: System Solution Solution
Same as the leadaddress_MailboxTrackingFolders many-to-one relationship for the mailboxtrackingfolder entity.
Property | Value |
---|---|
ReferencingEntity | mailboxtrackingfolder |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | leadaddress_MailboxTrackingFolders |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
leadaddress_BulkDeleteFailures
Added by: System Solution Solution
Same as the leadaddress_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure entity.
Property | Value |
---|---|
ReferencingEntity | bulkdeletefailure |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | leadaddress_BulkDeleteFailures |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
leadaddress_PrincipalObjectAttributeAccesses
Added by: System Solution Solution
Same as the leadaddress_PrincipalObjectAttributeAccesses many-to-one relationship for the principalobjectattributeaccess entity.
Property | Value |
---|---|
ReferencingEntity | principalobjectattributeaccess |
ReferencingAttribute | objectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | leadaddress_PrincipalObjectAttributeAccesses |
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_leadaddressbase_createdby
- lk_leadaddress_createdonbehalfby
- lk_leadaddressbase_modifiedby
- lk_leadaddress_modifiedonbehalfby
- lead_addresses
- TransactionCurrency_LeadAddress
lk_leadaddressbase_createdby
Added by: System Solution Solution
See the lk_leadaddressbase_createdby one-to-many relationship for the systemuser entity.
lk_leadaddress_createdonbehalfby
Added by: System Solution Solution
See the lk_leadaddress_createdonbehalfby one-to-many relationship for the systemuser entity.
lk_leadaddressbase_modifiedby
Added by: System Solution Solution
See the lk_leadaddressbase_modifiedby one-to-many relationship for the systemuser entity.
lk_leadaddress_modifiedonbehalfby
Added by: System Solution Solution
See the lk_leadaddress_modifiedonbehalfby one-to-many relationship for the systemuser entity.
lead_addresses
See the lead_addresses one-to-many relationship for the lead entity.
TransactionCurrency_LeadAddress
Added by: System Solution Solution
See the TransactionCurrency_LeadAddress one-to-many relationship for the transactioncurrency entity.