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 v1.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 Component

Book, Contact,HouseholdTeam

Methods Called

Table 295 details the methods called by the Household service.

Table 295. Methods Called by Household Service
Method	Name as Defined in Service
Delete	HouseholdDelete
DeleteChild	HouseholdDeleteChild
Insert	HouseholdInsert
InsertChild	HouseholdInsertChild
InsertOrUpdate	HouseholdInsertOrUpdate
QueryPage	HouseholdQueryPage
Update	HouseholdUpdate
UpdateChild	HouseholdInsertChild

Fields

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

Table 296. 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
	Audit Fields	Read-only
Book	BookName	Required
	BookId	Read-only
	SystemAssociateFlag	Read-only
	ModId	Read-only
	Audit Fields	Read-only
Contact	ContactId	Required
	ContactExternalId	Required
	ContactIntegrationId	Required
	ContactFirstName	Read-only
	ContactLastName	Read-only
	ContactId	Read-only
	ContactMrMrs	Read-only
	Audit Fields	Read-only
HouseholdTeam	HouseholdAccess	Required
	UserId	Read-only
	UserAlias	Read-only
	UserEmail	Read-only

Table 297 details the status key for the household object.

Table 297. Status Key for the Household Object
Child Component	Field Name
Household (parent)	Audit Fields
	ExternalSystemId
	HouseholdId
	IntegrationID
Book	Audit Fields
	BookId
	ModId
Contact	Audit Fields
Contact	ContactId
HouseholdTeam	Audit Fields
	UserExternalSystemId
	HouseholdTeamId
	UserAlias
	UserEmail

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

Table 298. Pick Map Field for the Household Object
Child Component	Pick Map Field	Maps To
Contact	ContactExternalId	ContactId
Contact	ContactIntegrationId	ContactId
Book	BookName	BookId
HouseholdTeam	UserEmail	UserId
	UserAlias	UserId
	UserExternalSystemId	UserId
	LastName	UserId
	FirstName	UserId

Table 299 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.

Table 299. Filterable Fields and User Key Fields on the Household Object's Child Components
Child Components	Filterable Fields	User Key Field Combinations
Household (parent)	All	HouseholdId
		IntegrationID
		ExternalSystemID
Book	None	BookId
Book	None	BookName
Contact	ContactID	ContactID
	ContactExternalId	ContactExternalId
	ContactIntegrationId	ContactIntegrationId
	ModifiedDate
	RelationshipRole
HouseholdTeam	UserId	HouseholdTeamId
	UserExternalSystemId	UserExternalSystemId
	LastName	UserAlias
	FirstName	UserEmail
	TeamRole
	HouseholdAccess
	HouseholdTeamId

Table 300 details the picklists available for the household object.

Table 300. Picklists Available for the Household Object
Child Component	Field Name
Household (parent)	Segment
Household (parent)	Type
Contact	RelationshipRole
Contact	RelationshipRole
HouseholdTeam	TeamRole
HouseholdTeam	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.

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.