Sales Cloud Household
An object that includes attributes used to store values while creating or updating a household. A household is a group that has a relationship with either an account or a contact.
QName: {http://xmlns.oracle.com/apps/crmCommon/salesParties/householdService/}Household
Relationships
The following table describes how this service data object is related to other service data objects or business object services.
| Relationship Type | Object or Service |
|---|---|
|
Contains |
|
|
Contains |
|
|
Contains |
|
|
Handled by |
Attributes
The following table describes attributes in the service data object.
| Name | Type | Description |
|---|---|---|
|
AddressElementAttribute1 |
string |
Additional address element to support flexible address format |
|
AddressElementAttribute2 |
string |
Additional address element to support flexible address format |
|
AddressElementAttribute3 |
string |
Additional address element to support flexible address format |
|
AddressElementAttribute4 |
string |
Additional address element to support flexible address format |
|
AddressElementAttribute5 |
string |
Additional address element to support flexible address format |
|
AddressLine1 |
string |
First line of address. |
|
AddressLine2 |
string |
Second line of address. |
|
AddressLine3 |
string |
Third line of address. |
|
AddressLine4 |
string |
Fourth line of address. |
|
AddressLinesPhonetic |
string |
Phonetic or Kana representation of the Kanji address lines (used in Japan) |
|
AddressNumber |
string |
Alternate unique identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. Prefix defined as in profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number. |
|
AddressType |
string |
Additional information as type of address like BillTo, ShipTo. |
|
AnnualIncome |
long |
The annual income of the household. If not provided, then the value is NULL. |
|
AssignmentExceptionFlag |
boolean |
Indicates whether the sales account had the required dimensions to allow assignment manager to assign territories to the sales account. Possible values are True or False. |
|
AverageAge |
long |
The average age of the members of the household. |
|
Building |
string |
Specific building name or number at a given address. |
|
CertificationLevel |
string |
The certification level the organization party as indicated in the HZ_PARTY_CERT_LEVEL lookup type. |
|
CertificationReasonCode |
string |
The reason for the household current certification level assignment. A list of valid certification reason codes are defined using the lookup HZ_PARTY_CERT_REASON. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. |
|
Child0to6Number |
long |
The number of children in the household less than 6 years of age. |
|
Child13to18Number |
long |
The number of children in the household between the age of 13 and 18. |
|
Child7to12Number |
long |
The number of children in the household between the age of 7 and 12. |
|
City |
string |
The city element of address. |
|
ClassificationCategory |
string |
A valid classification category code for the household which will be marked as primary and is defined by an admin. |
|
ClassificationCode |
string |
A valid classification code corresponding to the classification category and which will be marked as primary. |
|
Comments |
string |
The comments for the record. |
|
CorpCurrencyCode |
string |
The corporate currency code associated with the record. This attribute is used by CRM Extensibility framework. |
|
Country |
string |
Country code of the address. |
|
County |
string |
County element of address. |
|
CreatedBy |
string |
The user who created the record. |
|
CreatedByModule |
string |
The module that created the record. |
|
CreationDate |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
The date when the record was created. |
|
CurcyConvRateType |
string |
The currency conversion rate associated with the record. This attribute is used by CRM Extensibility framework. |
|
CurrencyCode |
string |
The currency code. This attribute is used by CRM Extensibility framework. |
|
DeleteFlag |
boolean |
Indicates whether the record can be deleted or not. |
|
DependentsNumber |
long |
The number of dependents in the household. |
|
EmailAddress |
string |
The email address associated with the record. |
|
EmailFormat |
string |
Indicates the preferred format for email, such as HTML or ASCII. |
|
ExistingCustomerFlag |
boolean |
Indicates whether there is an existing selling or billing relationship with the sales account. If the value is True, then there is an existing relationship with the sales account. The default value is False. |
|
ExistingCustomerFlagLastUpdateDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
The date when the ExistingCustomerFlag was last modified. It is internally populated by the application. |
|
FavoriteHouseholdFlag |
boolean |
Indicator to determine if a household is a favorite. |
|
FloorNumber |
string |
The specific floor number at a given address or in a particular building when the building number is provided. |
|
FormattedPhoneNumber |
string |
The formatted phone number. |
|
HouseholdName |
string |
The unique identification number for this party. Data stored in this attribute comes from PARTY_NUMBER in HZ_PARTIES. |
|
HouseholdSize |
long |
The size of the household or group. |
|
LastAssignmentDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
The date when the sales account territory assignment was last run by assignment manager. |
|
LastAssignmentDateTime |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
The date and time during which the sales account territory assignment was last run by assignment manager. |
|
LastUpdateDate |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
The date when the record was last updated. |
|
LastUpdateLogin |
string |
The login of the user who last updated the record. |
|
LastUpdatedBy |
string |
The user who last updated the record. |
|
Mailstop |
string |
A user-defined code to indicate a mail drop point within their organization |
|
MedianAge |
long |
The median age of the members of the household. |
|
NamedFlag |
boolean |
Indicates whether a sales account is a named sales account. Possible values are True or False. If the value is True, then the sales account is a named sales account. |
|
Note |
The note about the household. |
|
|
OwnerEmailAddress |
string |
The email address of valid employee resource that owns and manages the sales account. To assign an owner to the sales account, you can either provide owner's party ID, PartyNumber, or Email Address. |
|
OwnerName |
string |
The name of a valid employee resource who owns and manages the sales account. |
|
OwnerPartyId |
long |
The unique identifier of a valid employee resource who owns and manages the sales account. To assign an owner to the sales account, you must provide either owner's party identifier, party number, or email address. |
|
OwnerPartyNumber |
string |
Party number of a valid employee resource who owns and manages the sales account. To assign an owner to the sales account, you can either provide owner's party ID, PartyNumber, or Email Address. |
|
PartyId |
long |
The unique identifier of the contact party.
|
|
PartyNumber |
string |
The unique identification number for the party. |
|
PartyStatus |
string |
The status of the household. This is an internal column and you are not expected to pass in a value. A list of valid statuses are defined in the lookup HZ_STATUS. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. |
|
PartyUniqueName |
string |
This is a derived column. For Organization, it is concatenation of unique_name_alias and suffix. For Person, it is concatenation of person_name and suffix. |
|
PhoneAreaCode |
string |
The area code prefix for the phone number. |
|
PhoneCountryCode |
string |
The country code prefix for the phone number. |
|
PhoneExtension |
string |
The additional number addressed after initial connection to an internal telephone system. |
|
PhoneNumber |
string |
The telephone number in the local format. The number should not include area code, country code, or extension. |
|
PostalCode |
string |
The postal code as defined by the formal countrywide postal system. |
|
PostalPlus4Code |
string |
Four digit extension to the United States Postal ZIP code. |
|
PreferredContactMethod |
string |
The preferred contact method for a person or organization. It is validated against lookup HZ_PREFERRED_CONTACT_METHOD. |
|
PreferredFunctionalCurrency |
string |
The preferred functional currency for the person or organization. The denormalized value of the PREF_FUNCTIONAL_CURRENCY in HZ_PERSON_PROFILES/HZ_ORGANIZATION_PROFILES. |
|
PrimaryAddress |
The primary address of the household. Address attributes of the household are grouped under a PrimaryAddress entity for clarity. |
|
|
PrimaryContactEmail |
string |
The email address of the primary contact. |
|
PrimaryContactName |
string |
The name of the primary contact. |
|
PrimaryContactPartyId |
long |
The unique identifier of the primary contact. To specify the contact for a household, you can provide Contact's party ID, PartyNumber, or a combination of SourceSystem and SourceSystemReference. |
|
PrimaryContactPartyNumber |
string |
The party number of the primary contact. To specify the contact for a household, you can either provide Contact's party ID, PartyNumber, or a combination of SourceSystem and SourceSystemReference. |
|
PrimaryContactPhone |
string |
The phone number of the primary contact. |
|
PrimaryContactSourceSystem |
string |
The source system of the primary contact. To specify the contact for a household, you can either provide Contact's party ID, PartyNumber, or a combination of SourceSystem and SourceSystemReference. |
|
PrimaryContactSourceSystemReferenceValue |
string |
The source system reference of the primary contact. To specify the contact for a household, you can either provide Contact's party ID, PartyNumber, or a combination of SourceSystem and SourceSystemReference. |
|
Province |
string |
The province element of address. |
|
RawPhoneNumber |
string |
The unformatted phone number information. |
|
RecordSet |
string |
The selected record set under which the search results are displayed. |
|
SalesProfileStatus |
string |
A valid user-defined status of the sales account that this household belongs to. |
|
SalesTeamMember |
The sales team member who is associated to a sales account. |
|
|
SourceSystem |
string |
The source system name where the record originated. |
|
SourceSystemReferenceValue |
string |
The identifier for the record from an external source system. |
|
State |
string |
The state element of address. |
|
Type |
string |
The household party type that defines whether the household is a sales account or a prospect or any other user-defined party type as specified using the lookup type ZCA_ HOUSEHOLD _TYPE. It is defaulted to ZCA_CUSTOMER if no value is provided. Possible values are CUSTOMER or PROSPECT. A list of valid values is defined in the lookup ZCA_HOUSEHOLD_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. |
|
UniqueNameSuffix |
string |
The suffix used to generate the attribute PartyUniqueName. The suffix is concatenated to the householdName attribute to generate the PartyUniqueName. The primary address is defaulted as the suffix. |
|
UpdateFlag |
boolean |
This flag controls if the user has access to update the record. |
|
WealthAmount |
{http://xmlns.oracle.com/adf/svc/types/}AmountType |
The household's wealth amount or net worth. The value is NULL if not given. |