1. SOAP Web Services for Sales and Fusion Service
  2. Household

Household

The trading community group information.

QName: {http://xmlns.oracle.com/apps/cdm/foundation/parties/groupService/}Group

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

Preference

Contains

Financial Profile

Contains

Relationship

Contains

Contact Language

Contains

Additional Household Name

Contains

E-Mail

Contains

Phone

Contains

Certification

Contains

Classification Assignment

Contains

Additional Identifier

Contains

Instant Messaging

Contains

E-Mail Domain

Contains

Source System Reference

Contains

Contact Preference

Contains

Usage Assignment

Contains

Address

Contains

Web

Contained by

Sales Party

Contained by

Sales Party Resource

Contained by

My Sales Account

Contained by

Sales Account

Contained by

Sales Party Territory

Handled by

Trading Community Group

Handled by

Sales Account Service

Handled by

Sales Party

Handled by

Sales Party Resource Service

Handled by

Sales Party Territory service

Attributes

The following table describes attributes in the service data object.

Name Type Description

AdditionalGroupName

Additional Household Name

Additional name associated with the group.

AdditionalPartyId

Additional Identifier

Additional Identifier for the group.

AnnualExpenses

long

Household annual expenses.

AnnualIncome

long

The value for annual income.

AverageAge

long

Household average age.

Certification

Certification

Certification information associated with the group.

CertificationLevel

string

The certification level the organization party as indicated in the HZ_PARTY_CERT_LEVEL lookup type.

CertificationReasonCode

string

Reason for group party's current certification level assignment. HZ_PARTY_CERT_REASON lookup type.

Child0to6Number

long

The number of children between 0 and 6 years.

Child13to18Number

long

The number of children between 13 and 18 years.

Child7to12Number

long

The number of children between 7 and 12 years.

CodeAssignment

Classification Assignment

Classification code assigned to the group.

Comments

string

The comments for the record.

ContactPreference

Contact Preference

The contact preference associated with the record.

CorpCurrencyCode

string

The corporate currency code associated with the record. This attribute is used by CRM Extensibility framework.

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.

DependentsNumber

long

The number of dependents.

EffectiveEndDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

The date at the end of the date range within which the row is effective.

EffectiveLatestChange

string

Not Used.

EffectiveSequence

int

Not Used.

EffectiveStartDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

The date at the beginning of the date range within which the row is effective.

Email

E-Mail

The email address associated with the record.

EmailDomain

E-Mail Domain

Email domain information for the group.

FinancialProfile

Financial Profile

Financial Profile information of the group.

GroupName

string

Name of this group.

GroupSize

long

Size of the group.

GroupType

string

The party type can only be person, organization, group.

InstantMessaging

Instant Messaging

The instant messaging information related to the record.

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.

MedianAge

long

The age of the median.

OriginalSystemReference

Source System Reference

The identifier for the record from the original system.

PartyId

long
The unique identifier of the contact party.

  • Primary Key

PartyNumber

string

The unique identification number for the party.

PartyPreference

Preference

Preference information of the group.

PartySite

Address

Address information associated with the group.

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.

PartyUsageAssignment

Usage Assignment

Party usage assigned to the group.

PersonLanguage

Contact Language

Language information associated with a group.

Phone

Phone

The phone information for the entity.

PreferredContactMethod

string

The preferred contact method for a person or organization. It is validated against lookup HZ_PREFERRED_CONTACT_METHOD.

PreferredContactPersonEmail

string

The E-Mail of the preferred contact person.

PreferredContactPersonId

long

The PARTY_ID of a preferred contact for a given party. There should be a valid relationship.

PreferredContactPersonName

string

The name of the preferred contact person.

PreferredContactPersonPhone

string

The phone number of the preferred contact person.

PreferredContactPersonURL

string

The URL of the preferred contact person.

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.

PreferredName

string

The denormalized value of the PARTY_NAME field in HZ_ADDTNL_PARTY_NAMES identified by PREFERRED_NAME_ID.

PreferredNameId

long

The foreign key to PARTY_NAME_ID in HZ_ADDTNL_PARTY_NAMES. It contains the ID of the referred name for the party. If it is NULL the Profile Name will be used as preferred name. By default the value is NULL.

PrimaryAddressCity

string

The city of the primary address.

PrimaryAddressCountry

string

The country for the primary address.

PrimaryAddressCounty

string

The country of the primary address.

PrimaryAddressLine1

string

Line one of the primary address.

PrimaryAddressLine2

string

Line two of the primary address.

PrimaryAddressLine3

string

Line three of the primary address.

PrimaryAddressLine4

string

Line four of the primary address.

PrimaryAddressLocationId

long

The unique identification number for the primary address location.

PrimaryAddressPartySiteId

long

The unique identifier for the primary address party site.

PrimaryAddressPostalCode

string

The postal code of the primary address.

PrimaryAddressProvince

string

The province of the primary address.

PrimaryAddressState

string

The state of the primary address.

PrimaryEmail

string

Primary E-Mail Address of the Group.

PrimaryEmailId

long

Primary E-Mail ID.

PrimaryFormattedAddress

string

Primary formatted address for the group.

PrimaryFormattedMultilineAddress

string

Primary formatted multiline address for the group.

PrimaryFormattedPhoneNumber

string

Primary formatted phone number for the group.

PrimaryLanguage

string

Standard name for a primary language.

PrimaryPhoneAreaCode

string

The area code within a country code.

PrimaryPhoneCountryCode

string

The international country code for a telephone number. For example, it is 33 for France.

PrimaryPhoneExtension

string

The additional number required after initial connection to an internal telephone system.

PrimaryPhoneId

long

The unique identification number for the primary phone.

PrimaryPhoneLineType

string

The lookup code for the type of phone line. For example, general, fax, inbound or outbound, and so on.

PrimaryPhoneNumber

string

The telephone number in local format. The number should not include country code, area code, or extension.

PrimaryPhonePurpose

string

The contact point type, such as business or personal.

PrimaryURL

string

Primary URL.

PrimaryWebId

long

Primary Web ID.

ProfileCreatedBy

string

The user who created the row.

ProfileCreatedByModule

string

The module that created the profile.

ProfileCreationDate

{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp

The date and time of the creation of the row.

ProfileLastUpdateDate

{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp

The date and time of the last update of the row.

ProfileLastUpdateLogin

string

The session login associated to the user who last updated the row.

ProfileLastUpdatedBy

string

The user who last updated the row.

Relationship

Relationship

Relationship information for the group.

RequestId

long

A system-generated read-only attribute used by the application framework.

Status

string

The status of the record.

SuffixOverriddenFlag

boolean

This will have Y if the suffix is overridden by user N if not.

UniqueNameSuffix

string

System generated or manually overridden suffix.

ValidatedFlag

boolean

Indicates whether the entity was validated. If the value is Y then the entity was validated.

WealthAmount

{http://xmlns.oracle.com/adf/svc/types/}AmountType

Household wealth amount or net worth.

Web

Web

The web information related to the record.