Oracle CRM On Demand Documentation Library: Household

Oracle Web Services On Demand Guide > Oracle CRM On Demand Objects Accessible Through Web Services > Financial Services Edition Parent Objects (Web Services v2.0) >

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 Objects

Activity, Contact, Claim, Financial Account, Financial Account Holder, Financial Plan, Lead, Note, Opportunity, Policy, Policy Holder, Portfolio, Service Request, Team.

Methods Called

Table 697 details the methods called by the Household service.

Table 697. Methods Called by Household Service
Method	Name as Defined in Service
Delete	HouseholdDelete
Execute	HouseholdExecute
Insert	HouseholdInsert
QueryPage	HouseholdQueryPage
Update	HouseholdUpdate

Fields

Table 698 details the required and read-only fields for the household object.

Table 698. Required and Read-Only Fields for the Household Object
Field Name	Type
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
Audit Fields	Read-only

Table 699 details the pick map fields for the household object.

Table 699. Pick Map Field for the Household Object
Pick Map Field	Maps To
ContactExternalId	ContactId
ContactIntegrationId	ContactId

Table 700 provides a list of the user key combinations for the household object.

Table 700. User Key Fields on the Household Object
User Key Field Combinations
HouseholdName
Id
ExternalSystemId

Table 701 details the picklists available for the household object.

Table 701. Picklists Available for the Household Object
Field Name
Segment
Type

Oracle Web Services On Demand Guide, Version 25.0 (Oracle CRM On Demand Release 37)		Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.