Household
The household object allows you to define and record financial details about a group of contacts that live in the same household, for example, parents, brothers, sisters, spouses, and so on. These details include the assets of the household, the liabilities of the household, the net income of the household, and so on.
Child Component
Methods Called
The following table details the methods called by the Household service.
Method | Name as Defined in Service |
---|---|
HouseholdDelete |
|
HouseholdDeleteChild |
|
HouseholdInsert |
|
HouseholdInsertChild |
|
HouseholdInsertOrUpdate |
|
HouseholdQueryPage |
|
HouseholdUpdate |
|
HouseholdInsertChild |
Fields
The following table details the required and read-only fields for the household object.
Child Component | Field Name | Type |
---|---|---|
Household (parent) |
HouseholdName |
Required |
IntegrationID |
Required |
|
ExternalSystemID |
Required |
|
HouseholdId |
Read-only |
|
PrimaryContactId |
Read-only |
|
PrimaryContactExternalId |
Read-only |
|
PrimaryContactIntegrationId |
Read-only |
|
PrimaryContactFirstName |
Read-only |
|
PrimaryContactLastName |
Read-only |
|
Timezone |
Read-only |
|
HouseholdCurrency |
Read-only |
|
LastActivity |
Read-only |
|
HeadDOB |
Read-only |
|
TotalIncome |
Read-only |
|
TotalAssets |
Read-only |
|
TotalExpenses |
Read-only |
|
TotalLiabilities |
Read-only |
|
TotalNetWorth |
Read-only |
|
RiskProfile |
Read-only |
|
ExperienceLevel |
Read-only |
|
InvestmentHorizon |
Read-only |
|
CurrentInvestmentMix |
Read-only |
|
Objective |
Read-only |
|
PrimaryGoal |
Read-only |
|
Read-only |
||
Book |
BookName |
Required |
BookId |
Read-only |
|
SystemAssociateFlag |
Read-only |
|
ModId |
Read-only |
|
Read-only |
||
Contact |
ContactId |
Required |
ContactExternalId |
Required |
|
ContactIntegrationId |
Required |
|
ContactFirstName |
Read-only |
|
ContactLastName |
Read-only |
|
ContactId |
Read-only |
|
ContactMrMrs |
Read-only |
|
Read-only |
||
HouseholdTeam |
HouseholdAccess |
Required |
UserId |
Read-only |
|
UserAlias |
Read-only |
|
UserEmail |
Read-only |
The following table details the status key for the household object.
Child Component | Field Name |
---|---|
Household (parent) |
|
ExternalSystemId |
|
HouseholdId |
|
IntegrationID |
|
Book |
|
BookId |
|
ModId |
|
Contact |
|
ContactId |
|
HouseholdTeam |
|
UserExternalSystemId |
|
HouseholdTeamId |
|
UserAlias |
|
UserEmail |
The following table details the pick map fields for the household object.
Child Component | Pick Map Field | Maps To |
---|---|---|
Contact |
ContactExternalId |
ContactId |
ContactIntegrationId |
||
Book |
BookName |
BookId |
HouseholdTeam |
UserEmail |
UserId |
UserAlias |
UserId |
|
UserExternalSystemId |
UserId |
|
LastName |
UserId |
|
FirstName |
UserId |
The following table provides a list of the filterable fields for the child components of the household object, and a list of user key combinations for each child component.
Child Components | Filterable Fields | User Key Field Combinations |
---|---|---|
Household (parent) |
All |
HouseholdId |
IntegrationID |
||
ExternalSystemID |
||
Book |
None |
BookId |
BookName |
||
Contact |
ContactID |
ContactID |
ContactExternalId |
ContactExternalId |
|
ContactIntegrationId |
ContactIntegrationId |
|
ModifiedDate |
||
RelationshipRole |
||
HouseholdTeam |
UserId |
HouseholdTeamId |
UserExternalSystemId |
UserExternalSystemId |
|
LastName |
UserAlias |
|
FirstName |
UserEmail |
|
TeamRole |
||
HouseholdAccess |
||
HouseholdTeamId |
The following table details the picklists available for the household object.
Child Component | Field Name |
---|---|
Household (parent) |
Segment |
Type |
|
Contact |
RelationshipRole |
HouseholdTeam |
TeamRole |
HouseholdAccess |
For more information on the fields accessible through the Household Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the household object.