Cmdlets for Oracle Sales Cloud

Build 20.0.7654

Contacts

Table resource items include attributes used to store values while creating or updating a contact.

Columns

Name Type ReadOnly References Description
PartyNumber [KEY] String False

The unique alternate identifier for the contact party. The default value for PartyNumber is the value specified in the profile option HZ_GENERATE_PARTY_NUMBER. You can update the PartyNumber depending on the profile option HZ_GENERATE_PARTY_NUMBER. A list of accepted values is defined in the profile option HZ_GENERATE_PARTY_NUMBER. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task.

AcademicTitle String False

The part of the person's title that denotes the academic qualification, such as Dr. Jane Smith.

AccountName String False

The name of the sales account that this contact belongs to.

AccountPartyId Long False

The unique identifier of sales account that this contact belongs to. To specify the account for a contact, you can provide an Account's party ID, PartyNumber, SourceSystem, or SourceSystemReference.

AccountPartyNumber String False

The party number of the sales account that this contact belongs to. To specify the account for a contact, you can provide an Account's party ID, PartyNumber, SourceSystem, or SourceSystemReference.

AccountSourceSystem String False

The Source System code of the sales account that this contact belongs to. To specify the account for a contact, you can provide an Account's party ID, PartyNumber, SourceSystem, or SourceSystemReference.

AccountSourceSystemReferenceValue String False

The Source System Reference value of the sales account that this contact belongs to. To specify the account for a contact, you can provide an Account's party ID, PartyNumber, SourceSystem, or SourceSystemReference.

AddressElementAttribute1 String False

Additional address element to support flexible address format

AddressElementAttribute2 String False

Additional address element to support flexible address format

AddressElementAttribute3 String False

Additional address element to support flexible address format

AddressElementAttribute4 String False

Additional address element to support flexible address format

AddressElementAttribute5 String False

Additional address element to support flexible address format

AddressLine1 String False

First line of address.

AddressLine2 String False

Second line of address.

AddressLine3 String False

Third line of address.

AddressLine4 String False

Fourth line of address.

AddressLinesPhonetic String False

The phonetic or Kana representation of the Kanji address lines (used in Japan).

AddressNumber String False

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 False

Additional information as type of address like BillTo, ShipTo.

AssignmentExceptionFlag Bool False

Indicates whether the sales account has the required dimensions to allow assignment manager to assign territories to the sales account. If the value is True, then the sales account has the required dimensions. The default is false.

Building String False

Specific building name or number at a given address.

CertificationLevel String False

The certification level of a contact. A list of accepted values are defined in the lookup HZ_PARTY_CERT_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.

CertificationReasonCode String False

The reason for the contact's current certification level assignment. A list of accepted values are defined using the lookup HZ_PARTY_CERT_REASON. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.

City String False

The city element of address.

ClassificationCategory String False

A valid classification category code for the contact. This is defined by an admin and is marked as primary.

ClassificationCode String False

A valid classification code corresponding to the classification category, which is marked as primary.

Comments String False

The textual comments about a contact.

ContactIsPrimaryForAccount String False

The preferred contact for the account.

ContactName String False

The derived name of the contact.

ContactRole String False

Specifies the role of the contact

ContactUniqueName String False

The unique contact name displayed on contact related screens. The default value for ContactUniqueName is the concatenation of attributes ContactName and UniqueNameSuffix. If the attribute UniqueNameSuffix is nil, then the ContactName is concatenated with a system generated number.

Country String False

Country code of the address.

County String False

County element of address.

CreatedBy String False

The user who created the contact record.

CreatedByModule String False

The application module that created this contact record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. Review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task.

CreationDate Datetime False

The date and time when the contact record was created.

CurrencyCode String False

The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.

DataCloudStatus String False

The enrichment status of the contact record from Data cloud. A list of accepted values are defined in the lookup DATA_CLOUD_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.

DateOfBirth Date False

The date when the person was born.

DateOfDeath Date False

Date the person died.

DeceasedFlag Bool False

Indicates whether the person is deceased or not. If the value is True, then the person is deceased. The default is False.

DeclaredEthnicity String False

The declared ethnicity of the person.

DeleteFlag Bool False

This flag controls if the user has access to delete the record

Department String False

The free form text used to name the department for the contact.

DepartmentCode String False

The department code for the contact. A list of accepted values is defined in the lookup DEPARTMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.

DoNotCallFlag Bool False

Indicates if the user can call the person or not. If the value is True, then the user must not call the person. The default is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task.

DoNotContactFlag Bool False

Indicates if the user can contact the person or not by phone, e-mail, or mail. If the value is True, then the user must not contact the person. The default is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task.

DoNotEmailFlag Bool False

Indicates if the user can e-mail the person or not. If the value is True, then the user must not contact the person by e-mail. The default is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task.

DoNotMailFlag Bool False

Indicates if the user can send mail to the person or not. If the value is True, then the user must not contact the person by mail. The default is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task.

EmailAddress String False

The e-mail address of the contact point.

EmailContactPointType String False

EmailFormat String False

The preferred format for e-mail addressed to this address such as HTML or ASCII. A list of accepted values is defined using the lookup EMAIL_FORMAT. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.

ExistingCustomerFlag Bool False

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. Such relationships are defined by the existence of a Sell_To or Bill_To address.

ExistingCustomerFlagLastUpdateDate Date False

The date when the ExistingCustomerFlag was last modified. It is internally populated by the application.

FavoriteContactFlag Bool False

Indicates whether the person is a key contact. If the value is true, then person is a key contact. The default value is False.

FaxAreaCode String False

The area code.

FaxContactPointType String False

FaxCountryCode String False

The international country code for a telephone number, such as 33 for France.

FaxExtension String False

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

FaxNumber String False

A telephone number formatted in the local format without the area code, country code, or extension.

FirstName String False

First name of the person.

FloorNumber String False

Specific floor number at a given address or in a particular building when building number is provided

FormattedFaxNumber String False

The formatted fax number information.

FormattedHomePhoneNumber String False

Formatted mobile phone number information.

FormattedMobileNumber String False

The formatted mobile phone number information.

FormattedWorkPhoneNumber String False

The formatted work phone number information.

Gender String False

The gender of the person, such as male, female, and unknown. A list of accepted values are defined in the lookup HZ_GENDER. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.

HeadOfHouseholdFlag Bool False

Indicates if the person is the head of the household. If the value is True, then the person is the head of the household. The default value is False.

HomePhoneAreaCode String False

The area code within a country code.

HomePhoneContactPointType String False

HomePhoneCountryCode String False

The international country code for a telephone number, such as 33 for France.

HomePhoneNumber String False

The home phone number formatted in the local format without the area code, country code, or extension.

HouseholdIncomeAmount Decimal False

The income of the household that this person is a part of.

HouseholdSize Long False

The size of the household this person is a part of.

Initials String False

The initials in the contact's name.

JobTitle String False

The free form text for job title.

JobTitleCode String False

Code given to the job title.

LastAssignmentDate Date False

The date when the Sales Account Territory Assignment was last run by Assignment Manager.

LastContactDate Datetime False

The date when the contact was last contacted.

LastEnrichmentDate Date False

The date when the contact record was last enriched with data from external sources by using Data-as-a-Service.

LastName String False

The last name of the person.

LastNamePrefix String False

The prefix for the last name of a person, such as fon, van. For example, if a person's name is Hans Van, the last name of the person is captured using this attribute.

LastUpdateDate Datetime False

The date and time when the contact was last updated.

LastUpdateLogin String False

Indicates the session login associated to the user who last updated the record.

LastUpdatedBy String False

The user who last updated the contact record.

Mailstop String False

A user-defined code to indicate a mail drop point within their organization

MaritalStatus String False

The marital status of the person. A list of accepted values is defined in the lookup MARITAL_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.

MaritalStatusEffectiveDate Date False

The date when the person's marital status was changed.

MiddleName String False

The middle name of the person.

MobileAreaCode String False

The area code for the contact's mobile phone.

MobileContactPointType String False

MobileCountryCode String False

The international country code for a contact's mobile phone number, such as 33 for France.

MobileExtension String False

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

MobileNumber String False

The mobile phone number formatted in the local format. The number should not include area code, country code, or extension.

NameSuffix String False

The place in a family structure. For example, in

NamedFlag Bool False

Indicates whether a sales account is a named sales account. If the value is true, then the sales account is a named sales account. The default value is False.

OverallPrimaryFormattedPhoneNumber String False

OwnerEmailAddress String False

The e-mail address of a valid employee resource who owns and manages the sales account. To assign an owner to the sales account, user can provide one of the following attributes pertaining to the owner: PartyID, PartyNumber or E-mail Address. This is provided if user wants to change the owner of the contact or create contact with a different owner than the login user. If provided, then OwnerPartyID, OwnerPartyNumber, and OwnerEmailAddress are honored in this order to determine the owner for the contact.

OwnerName String False

The name of the sales account owner.

OwnerPartyId Long False

The unique identifier of a valid employee resource who owns and manages the sales account. The owner is a valid employee resource defined within Sales Cloud. To assign an owner to the sales account, user can provide one of the following attributes pertaining to the owner: PartyID, PartyNumber, or E-mail Address. This is provided if user wants to change the owner of the contact or create contact with a different owner than the login user. If provided, then OwnerPartyID, OwnerPartyNumber, and OwnerEmailAddress are honored in this order to determine the owner for the contact. During create, if none of the OwnerPartyID, OwnerPartyNumber, or OwnerEmailAddress is provided, then the contact is assigned by default to the login user. The login user's partyID is used to populate OwnerPartyID.

OwnerPartyNumber String False

The party number of a valid employee resource who owns and manages the sales account. To assign an owner to the sales account, user can provide one of the following attributes pertaining to the owner: PartyID, PartyNumber, or E-mail Address. This is provided if user wants to change the owner of the contact or create contact with a different owner than the login user. If provided, then OwnerPartyID, OwnerPartyNumber, and OwnerEmailAddress are honored in this order to determine the owner for the contact.

PartyId Long False

The unique internal identifier of a contact party. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the contact party.

PartyNumberKey String False

PartyStatus String False

The status of the contact. A list of valid values are defined in the lookup HZ_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.

PartyType String False

PersonProfileId Long False

PersonalIncomeAmount Decimal False

The estimated gross annual income of the person.

PlaceOfBirth String False

The place where the person was born, such as city or country.

PostalCode String False

Postal code as defined by the formal countrywide postal system

PostalPlus4Code String False

Four digit extension to the United States Postal ZIP code.

PreferredContactMethod String False

The preferred method to contact the person. A list of accepted values is defined in the lookup HZ_PREFERRED_CONTACT_METHOD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Point Lookups task.

PreferredFunctionalCurrency String False

The default currency code for this contact. A list of accepted values is defined using the Setup and Maintenance work area, Manage Currencies task.

PreviousLastName String False

The previous last name or surname of the person.

PrimaryAddressId Long False

Province String False

Province element of address.

RawFaxNumber String False

The unformatted fax number information.

RawHomePhoneNumber String False

Unformatted home phone number information.

RawMobileNumber String False

The unformatted mobile phone number information.

RawWorkPhoneNumber String False

The unformatted work phone number information.

RecordSet String False

The search results displayed under the selected record set.

RegistrationStatus String False

Specifies the registration status of the contact

RentOrOwnIndicator String False

Indicates if this contact owns or rents his or her residence. A list of valid values for rent, own, and lease is defined in the lookup OWN_RENT_IND. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.

SalesAffinityCode String False

The affinity of a contact to the deploying organization. A list of accepted values are defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.

SalesBuyingRoleCode String False

The roles played by a contact in the buying process, for example, decision maker or supporting role. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.

SalesProfileNumber String False

SalesProfileStatus String False

A valid user defined status of the sales account.

Salutation String False

The phrase used to address a contact party in any correspondence.

SalutoryIntroduction String False

The title or a salutary introduction for a contact, such as Mr., Herr, and so on. A list of accepted values is defined in the lookup CONTACT_TITLE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.

SecondLastName String False

The second last name for a person. A list of accepted values is defined in the lookup HZ_PERSON_PROFILES. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.

SellToPartySiteId Long False

SourceObjectType String False

SourceSystem String False

The name of external source system where the contact party is imported from. The values are configured in Setup and Maintenance work area, Manage Trading Community Source Systems task.

SourceSystemReferenceValue String False

The alternate unique identifier for the contact party from the external source system specified in the attribute SourceSystem.

State String False

State element of address.

TaxpayerIdentificationNumber String False

The taxpayer identification number, which is often a unique identifier of the contact. The typical values are taxpayer Id in USA or fiscal code or NIF in Europe.

Title String False

A professional or family title, such as Don or The Right Honorable.

Type String False

The contact party type that defines whether the contact is a sales account, a prospect, a contact or any other user-defined party type. The default value is ZCA_CUSTOMER. A list of accepted values is defined in the lookup ZCA_CONTACT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.

UniqueNameSuffix String False

The system generated or manually overridden suffix. The suffix is used to generate the PartyUniqueName attribute and is concatenated to the ContactName attribute to generate the PartyUniqueName. The primary address is defaulted as the suffix.

UpdateFlag Bool False

This flag controls if the user has access to update the record

WorkPhoneAreaCode String False

The area code for the contact's work phone.

WorkPhoneContactPointType String False

WorkPhoneCountryCode String False

The international country code for a contact's work phone number, such as 33 for France.

WorkPhoneExtension String False

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

WorkPhoneNumber String False

The work phone number formatted in the local format without the area code, country code, or extension.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7654