Establishing a Connection

Adding a Connection to Oracle Sales

To add a connection to Oracle Sales:

In the application console, navigate to the Connections page.
At the Add Connections panel, select the icon for the connection you want to add.
If the Oracle Sales icon is not available, click the Add More icon to download and install the Oracle Sales connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Oracle Sales uses Basic authentication over SSL; after setting the following connection properties, you are ready to connect:

Username: Set this to the user name that you use to log into your Oracle Cloud service.
Password: Set this to your password.
HostURL: Set this to the Web address (URL) of your Oracle Cloud service.

Custom Fields and Objects

Schemas for standard Oracle Sales tables are internally stored in CData Sync App and used to minimize the amount of sent requests and payload received. By default, CData Sync App will use these tables and not expose any of your instance's custom objects. While custom fields are exposed since IncludeCustomFields defaults to true.

The CData Sync App supports dynamically retrieving schemas for objects and custom fields from within your Oracle Sales specific instance by following the steps described below.

Including Custom Fields

In case your schema needs to include custom fields (columns) added to Oracle Sales standard objects (tables), you can use the IncludeCustomFields connection property. Setting this property to true will result in one or more extra calls being issued and will affect CData Sync App behavior in the following ways:

Custom fields will be retrieved and listed along with the rest of the columns in your schema.
All internally stored columns will be replaced with dynamically generated columns based on the latest API version.

Set IncludeCustomFields to false to improve performance.

Including Custom Objects

In case you need to access custom objects (tables), created to your Oracle Sales instance, you can use the IncludeCustomObjects connection property. By default, this property is set to false, and when queries are attempted on custom objects, they will fail to execute due to the internal schema being used. Similarly to IncludeCustomFields, setting this property to true, will issue one or more extra requests.

Generating Schema Files

If you need to regularly work with custom fields and/or custom objects, you can use the GenerateSchemaFiles connection property to store locally a dynamically generated schema and avoid constantly using IncludeCustomFields and IncludeCustomObjects, which in return will decrease execution time and payload.

Note: Setting GenerateSchemaFiles=OnStart/OnUse alone, will only generate a schema containing custom fields for all standard tables but not any custom tables. Using GenerateSchemaFiles combined with IncludeCustomObjects enables you to generate a schema containing both custom fields and objects.

Advanced Features

This section details a selection of advanced features of the Oracle Sales Sync App.

User Defined Views

The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Oracle Sales and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

SSL Configuration

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort: the TCP port that the proxy server is running on.
ProxyAuthScheme: the authentication method the Sync App uses when authenticating to the proxy server.
ProxyUser: the username of a user account registered with the proxy server.
ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
To tunnel the connection, set FirewallType to TUNNEL.
To authenticate, specify FirewallUser and FirewallPassword.
To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Data Model

The CData Sync App models the Oracle Sales objects as relational tables. Tables support both retrieving and updating data.

You can work with all the tables in your account. The Sync App connects to Oracle Sales and gets the list of tables and the metadata for the tables by calling the appropriate Web services. Any changes you make to your Oracle Sales account, such as adding a new table, adding new columns, or changing the data type of a column, will immediately be reflected when you use the Sync App to connect.

Tables

Oracle Sales objects have relationships to other objects; in the tables, these relationships are expressed through foreign keys. Oracle Sales objects are also part of an application that the account contains. For example, the table Opportunities represents the Opportunity object, which is part of the Sales application.

Tables

The Sync App models the data in Oracle Sales as a list of tables in a relational database that can be queried using standard SQL statements.

Oracle Sales Connector for CData Sync Tables


Name	Description
AccountAddresses	The address resource is used to view, create, and update addresses of an account. An address represents the location information of an account.
AccountAddressPurposes	The address purpose resource is used to view, create, or modify the address purpose. The address purpose describes the use of an address, such as shipping address or billing address.
AccountContactPoints	The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on.
AccountNotes	The note resource is used to capture comments, information, or instructions for an account.
AccountOrganizationContacts	The account contacts resource is used to view, create, update, and delete an account contact. It refers to a person who functions as a contact for an account.
AccountPrimaryAddresses	The primary address resource is used to view, create, and update primary address of an account. A primary address is the default communication address of an account.
AccountRelationships	The relationship resource is used to view, create, and update account relationships.
AccountResources	The sales team member resource represents a resource party and is assigned to a sales account team. A sales account team member has a defined access role for the sales account.
Accounts	The sales team member resource represents a resource party and is assigned to a sales account team. A sales account team member has a defined access role for the sales account.
Activities	Table to capture task and appointment information.
ActivityAssignees	Table used to capture the assignees/resources associated to the activity.
ActivityContacts	Table used to capture the contacts associated to the activity.
ActivityNotes	Note data objects that capture comments, information or instructions for an Oracle Fusion Applications business object.
ActivityObjectives	Table used to capture the objectives associated to the activity.
Assets	Usage information for the operation Assets.rsd.
CompetitorAccounts	The competitor accounts resource is used to view, create, and update a competitor account and manage competitor details.
ContactAddresses	Table that includes attributes used to store values while creating or updating an address. An address represents the location information of an account, contact or household.
ContactAddressPurposes	The address purpose resource is used to view, create, or modify the address purpose. The address purpose describes the use of an address, such as shipping address or billing address.
ContactContactPoints	The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on.
ContactNotes	The note resource is used to capture comments, information, or instructions for a contact.
ContactPrimaryAddresses	The primary address resource is used to view, create, or modify a primary address of a contact. A primary address is the default communication address of an entity.
ContactRelationships	The relationship resource includes attributes that are used to store values while viewing, creating, or updating a relationship.
Contacts	Table resource items include attributes used to store values while creating or updating a contact.
ContactSalesAccountResources	The sales team member resource represents a resource party and is assigned to a sales account team. A sales account team member has a defined access role for the sales account.
Leads	Usage information for the operation Leads.rsd.
LightboxDocuments	Usage information for the operation LightboxDocuments.rsd.
Opportunities	The opportunity competitor resource is used to view, create, and update the competitors for an opportunity. The opportunity competitors is used to store information about the competitors associated with the opportunity.
OpportunityAssessments	The assessments resource is used to view, create, update, and delete the assessment of an opportunity.
OpportunityCampaigns	The opportunity campaigns resource is used to view, create, update, and delete campaigns associated with an opportunity.
OpportunityCompetitors	The opportunity competitor resource is used to view, create, and update the competitors for an opportunity. The opportunity competitors is used to store information about the competitors associated with the opportunity.
OpportunityContacts	The opportunity contact resource is used to view, create, and update the contacts of an opportunity.The contact associated with the opportunity. You can specify a contact's role, affinity, and influence level on an opportunity. A single contact can be marked as primary.
OpportunityLeads	The opportunity lead resource is used to view, create, and update the lead that resulted in an opportunity.
OpportunityNotes	The note resource is used to capture comments, information, or instructions for an opportunity.
OpportunityPartners	The opportunity partner resource is used to view, create, and update the partners associated with this opportunity.The opportunity partner is used to store information about partners who are contributing to the selling effort of the current opportunity.
OpportunityRevenueItems	The revenue items resource is used to view, create, and update revenue items of an opportunity. The revenue items associated with opportunities are products, services, or other items a customer might be interested in purchasing. You add revenue items by selecting a product group or product to associate with an opportunity.
OpportunityRevenueItemsChildSplitRevenue	The child split revenue resource is used to view, create, update, and delete a split revenue. The revenue or nonrevenue credit is allocated to the resource which has contributed to the selling effort for an opportunity revenue line.
OpportunityRevenueItemsRecurringRevenues	The recurring revenues resource is used to view, create, update, and delete a recurring revenue. The revenues that span over a period of time sourced from the same product on an opportunity.
OpportunityRevenueTerritories	The opportunity revenue territories resource is used to view, create, and update the revenue territories of an opportunity. The territories assigned to an opportunity revenue line. The territories provide the rules for automatically assigning salespeople and other resources to customers, partners, leads, and opportunity line items.
OpportunitySources	The opportunity source resource is used to view, create, and update the source of an opportunity.The opportunity source is used to capture the marketing or sales campaign that resulted in this opportunity.
OpportunityTeamMembers	The opportunity team members resource is used to view, create, and update the team members associated with an opportunity. The opportunity team member of the deploying organization associated with the opportunity.
PartnerContacts	Usage information for the operation PartnerContacts.rsd.
PartnerProgramBenefits	Usage information for the operation PartnerProgramBenefits.rsd.
PartnerPrograms	Usage information for the operation PartnerPrograms.rsd.
Partners	Usage information for the operation Partners.rsd.
ProgramEnrollments	Usage information for the operation ProgramEnrollments.rsd.
Proposals	Usage information for the operation Proposals.rsd.
ResourceUsers	The resource users REST resource is used to view, create, update, and delete a resource user. Note that this REST resource should be used only to work with Oracle CX Sales and B2B Service, and not for any other product family.
SalesLeadContacts	The sales lead contacts resource is used to capture a contact associated with the sales lead.
SalesLeadResources	The sales lead resources data object (resource) is used to capture a resource associated with the sales lead team.
SalesLeads	The sales lead resource is used to view, create, or modify a lead. A lead is a transaction record created when a party has expressed an interest in a product or service. It represents a selling opportunity.
SalesLeadsLeadCampaigns	The lead campaign resource is used to view, create, update, and delete the association of a campaign with a lead.
SalesLeadsLeadCompetitors	The lead competitors resource is used to view, create, update, and delete the association of a campaign with a lead.
SalesLeadsLeadQualifications	The assessments resource is used to view, create and update qualifications of a lead.
SalesLeadsNotes	The note resource is used to capture comments, information, or instructions for a sales lead.
SalesOrders	Usage information for the operation SalesOrders.rsd.
ServiceProviders	Usage information for the operation ServiceProviders.rsd.
Signatures	The signatures resource is used to view, create, update, and delete a signature for an agent
Territories	The sales territories resource represents the list of sales territories that the logged-in user can view. A sales territory is an organizational domain with boundaries defined by attributes of customers, products, services, resources, and so on. Sales territories can be created based on multiple criteria including postal code, area code, country, vertical market, size of company, product expertise, and geographical location. Sales territories form the fundamental infrastructure of sales management as they define the jurisdiction that salespeople have over sales accounts, or the jurisdiction that channel sales managers have over partners and partner transactions.
TerritoryForecasts	The forecasts resource is used to view or modify a forecast territory.
TerritoryResources	The resources resource is used to view the resources, such as owner or sales people associated with a sales territory.

AccountAddresses

The address resource is used to view, create, and update addresses of an account. An address represents the location information of an account.

Columns


Name	Type	ReadOnly	References	Description
AddressNumber [KEY]	String	False		This is the primary key of the addresses table.
PartyNumber [KEY]	String	False	Accounts.PartyNumber	The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number.
AddrElementAttribute1	String	False		An additional address element to support flexible address format.
AddrElementAttribute2	String	False		An additional address element to support flexible address format.
AddrElementAttribute3	String	False		An additional address element to support flexible address format.
AddrElementAttribute4	String	False		An additional address element to support flexible address format.
AddrElementAttribute5	String	False		An additional address element to support flexible address format.
Address1	String	False		The first line for address.
Address2	String	False		The second line for address.
Address3	String	False		The third line for address.
Address4	String	False		The fourth line for address.
AddressId	Long	False		The unique identifier of the address.
AddressLinesPhonetic	String	False		The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan.
Building	String	False		The building name or number in the address.
City	String	False		The city in the address.
ClliCode	String	False		The Common Language Location Identifier (CLLI) code of the address. The code is used within the North American to specify the location of the address.
Comments	String	False		The user-provided comments for the address.
CorpCurrencyCode	String	False		The corporate currency code used by the CRM Extensibility framework.
Country	String	False		The country code of the address. Review the list of country codes using the Manage Geographies task.
CreatedBy	String	False		The user who created the account record.
CreatedByModule	String	False		The module that created the account record.
CreationDate	Datetime	False		The date when the record was created.
CurcyConvRateType	String	False		The currency conversion rate type. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
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.
DateValidated	Date	False		The date when the address was last validated.
Description	String	False		The description of the location.
DoNotMailFlag	Boolean	False		Indicates whether the address should not be used for mailing.
EffectiveDate	Date	False		The date when the address becomes active.
EndDateActive	Date	False		The date after which the address becomes inactive.
FloorNumber	String	False		The floor number of the address.
FormattedAddress	String	False		The formatted version of the address.
FormattedMultilineAddress	String	False		The formatted multiline version of the address.
HouseType	String	False		Indicates the building type for the building in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the record.
LastUpdateLogin	String	False		The login of the user who last updated the record.
Latitude	Double	False		The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes.
LocationDirections	String	False		The directions to the address location.
LocationId	Long	False		The unique identifier for the location.
Longitude	Double	False		The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes.
Mailstop	String	False		The user-defined code that indicates a mail drop point within the organization.
ObjectVersionNumber	Long	False		The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
PartyId	Long	False		The unique identifier of the account associated with the address.
PartySourceSystem	String	False		The name of external source system where the account, associated with the address, party is imported from. The values configured in setup task Trading Community Source System.
PartySourceSystemReferenceValue	String	False		The unique identifier for the account, associated with the address, from the external source system specified in the attribute PartySourceSystem.
PostalCode	String	False		The postal code of the address.
PostalPlus4Code	String	False		The four-digit extension to the United States Postal ZIP code for the address.
PrimaryFlag	Boolean	False		Indicates whether this is the primary address of the account. If the value is Y, this address is the primary address of the account. The default value is N.
Province	String	False		The province of the address.
SourceSystem	String	False		The name of external source system where the address is imported from. The values configured in setup task Trading Community Source System.
SourceSystemReferenceValue	String	False		The unique identifier for the address from the external source system specified in the attribute PartySourceSystem.
StartDateActive	Date	False		The date when the address becomes active.
State	String	False		The state of the address.
Status	String	False		The internal flag indicating status of the address. The status codes are defined by the lookup HZ_STATUS.
ValidatedFlag	Boolean	False		Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N.
ValidationStartDate	Date	False		The date when the validation becomes active. The value is internally set by system during address cleansing.
ValidationStatusCode	String	False		A standardized status code describing the results of the validation. The value is internally set by system during address cleansing.
AccountLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
FocusPartyId	String	The unique identifier of the child account to be returned at the top by the Direct Accounts finder.
ParentPartyId	String	The unique identifier of the account used to search the direct child accounts.
BindUserPartyId	String	The unique identifier of the party. Used in MyAccounts finder.
OrganizationProfileId	String	The unique identifier of the organization.

AccountAddressPurposes

The address purpose resource is used to view, create, or modify the address purpose. The address purpose describes the use of an address, such as shipping address or billing address.

Columns


Name	Type	ReadOnly	References	Description
AddressPurposeId [KEY]	Long	False		This is the primary key of the address purpose table.
PartyNumber [KEY]	String	False	Accounts.PartyNumber
AddressNumber [KEY]	String	False	AccountAddresses.AddressNumber
DeleteFlag	Boolean	False		Indicates whether the address purpose is to be deleted. If the value is Y, then the address purpose has to be deleted. The default value is N.
Purpose	String	False		The purpose of the address. A list of valid values is defined in the lookup PARTY_SITE_USE_CODE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
AccountLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.
SourceSystem	String	False		The name of external source system for the address purpose denoted by a code, which is defined by an administrator as part of system setup.
SourceSystemReferenceValue	String	False		The unique identifier for the address purpose from the external source.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
FocusPartyId	String	The unique identifier of the child account to be returned at the top by the Direct Accounts finder.
ParentPartyId	String	The unique identifier of the account used to search the direct child accounts.
PartyId	String	The unique identifier of the account.
BindUserPartyId	String	The unique identifier of the party. Used in MyAccounts finder.
OrganizationProfileId	String	The unique identifier of the organization.

AccountContactPoints

The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on.

Columns


Name	Type	ReadOnly	References	Description
ContactPointId [KEY]	Long	True		The unique identifier of the contact point.
PartyNumber [KEY]	String	False	Accounts.PartyNumber	The unique alternate identifier for the account party.
ConflictId	Long	False		The unique identifier of the conflict for the contact point record. This number is used by mobile or portable applications that consume the web service.
ContactPointType	String	False		The type of Contact Point record. The accepted values are defined in the lookup type COMMUNICATION_TYPE. Sample values include PHONE, EMAIL, and WEB.
CreatedBy	String	True		The user who created the contact point record.
CreatedByModule	String	False		The application module that created this contact point record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
CreationDate	Datetime	True		The date when the record was created.
DoContactPreferenceFlag	Bool	False		Indicates whether to use a particular contact method. Defaulted to false.
DoNotContactPreferenceFlag	Bool	False		Indicates whether the record can be contacted.
DoNotContactReason	String	False		The reason code for the contact preference.
EmailAddress	String	False		The email address of the contact point record of type email.
EmailPurpose	String	False		The purpose of using the EMAIL contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE. The values can be ASSISTANT, PERSONAL, HOME_BUSINESS, BUSINESS, and so on.
FormattedPhoneNumber	String	True		The formatted phone number of the contact point.
LastUpdateDate	Datetime	True		The date when the record was last updated.
LastUpdateLogin	String	True		The login of the user who last updated the record.
LastUpdatedBy	String	True		The user who last updated the contact point record.
ObjectVersionNumber	Int	False		The number used to implement optimistic locking for contact point record. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
PartySourceSystem	String	False		The name of external source system of the account, contact or household with which the contact point is associated. Part of alternate key for the account, contact or household record along with PartyourceSystemReferenceValue. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
PartySourceSystemReferenceValue	String	False		The unique identifier from external source system for the account, contact or household with which the address is associated. Part of alternate key along with PartySourceSystem. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated.
PhoneAreaCode	String	False		The area code for the phone number.
PhoneCountryCode	String	False		The country code of the phone number.
PhoneExtension	String	False		The extension number of the phone line number like office desk extension.
PhoneNumber	String	False		The phone number of the contact point.
PhonePurpose	String	False		Defines the purpose of using the PHONE contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.
PhoneType	String	False		The type of phone contact point. The accepted values are defined in the lookup type ORA_HZ_PHONE_TYPE. The values can be WORK, HOME, FAX, and so on.
PreferenceRequestedBy	String	False		Indicates if the permission or restriction was created internally or requested by the party. The list of accepted values are defined in the REQUESTED_BY lookup.
PrimaryFlag	Bool	False		Indicates whether this is the primary contact point of the associated object. If the value is True, then this is the primary contact point. The default value is False. If this attribute isn't explicitly mentioned in the payload, then the value of this attribute is set to null.
RawPhoneNumber	String	False		The raw phone number on the contact point record of type phone.
SocialNetworkId	String	False		The unique identifier of the social network.
SocialNetworkName	String	False		The name of the social network.
SocialNetworkPurpose	String	False		Defines the purpose of using the IM contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.
SourceSystem	String	False		The name of external source system, which is defined by an administrator as part of system setup. It's part of alternate key along with SourceSystemReference, and is mandatory if PK or partyNumberBusinessKey isn't passed in update.
SourceSystemReferenceValue	String	False		The unique identifier for the contacts party from the external source system specified in the attribute SourceSystem. It's part of alternate key along with SourceSystemReference, and is mandatory if PK or partyNumberBusinessKey isn't passed in update.
Status	String	False		Indicates the status of the contact point. The status codes are defined in the lookup HZ_STATUS. The default value is A.
URL	String	False		The URL of the contact point.
VerificationDate	Date	False		The date of verification of the phone or email contact point.
VerificationStatus	String	False		The status of the verification for phone or email contact points. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. The value ORA_PARTIALLY_VALID is applicable only for email. Default value is blank which indicates that values aren't verified.
WebPurpose	String	False		Defines the purpose of using the WEB contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE_WEB.Sample values: HOMEPAGE,SALESURL,MARKETINGURL,SUPPORTURL,RSS_FEED etc.
AccountLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
FocusPartyId	String	The unique identifier of the child account to be returned at the top by the Direct Accounts finder.
PartyId	String	The unique identifier of the party associated to the given account.
ParentPartyId	String	The unique identifier of the account used to search the direct child accounts.
BindUserPartyId	String	The unique identifier of the party. Used in MyAccounts finder.
OrganizationProfileId	String	The unique identifier of the organization.

AccountNotes

The note resource is used to capture comments, information, or instructions for an account.

Columns


Name	Type	ReadOnly	References	Description
NoteId [KEY]	Long	False		This is the primary key of the notes table.
PartyNumber [KEY]	String	False	Accounts.PartyNumber	The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number.
ContactRelationshipId	Long	False		The relationship ID populated when the note is associated with a contact.
CorpCurrencyCode	String	False		Holds Corporate Currency Code from profile.
CreatedBy	String	False		Indicates the user who created the row.
CreationDate	Datetime	False		Indicates the date and time of the creation of the row.
CreatorPartyId	Long	False		This is Party Id for the Note Creator.
CurcyConvRateType	String	False		Holds Currency Conversion Rate Type from profile.
CurrencyCode	String	False		Holds currency code of a record.
LastUpdateDate	Datetime	False		Indicates the date and time of the last update of the row.
AccountLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.
NoteTxt	String	False		This is the column which will store the actual note text.
NoteTypeCode	String	False		This is the note type code for categorization of note.
PartyId	Long	False		Party identifier.
PartyName	String	False		Name of this party.
SourceObjectCode	String	False		This is the source_object_code for the source object as defined in OBJECTS Metadata.
SourceObjectId	String	False		This is the source_object_Uid for the source object (such as Activities, Opportunities etc) as defined in OBJECTS Metadata.
VisibilityCode	String	False		This is the attribute to specify the visibility level of the note.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
FocusPartyId	String	The unique identifier of the child account to be returned at the top by the Direct Accounts finder.
ParentPartyId	String	The unique identifier of the account used to search the direct child accounts.
BindUserPartyId	String	The unique identifier of the party. Used in MyAccounts finder.
SourceSystem	String	Name of external source system.
SourceSystemReferenceValue	String	Identifier for this record from external source system.
OrganizationProfileId	String	The unique identifier of the organization.

AccountOrganizationContacts

The account contacts resource is used to view, create, update, and delete an account contact. It refers to a person who functions as a contact for an account.

Columns


Name	Type	ReadOnly	References	Description
AccountContactId [KEY]	Long	True		The unique identifier of the account contact.
PartyNumber [KEY]	String	False	Accounts.PartyNumber	The unique alternate identifier for the account party.
AccountName	String	True		The name of the account.
AccountPartyId	Long	False		The primary key identifier of the object in this relationship.AC Either one of ObjectPartyId, ObjectPartyNumber, and combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.
AccountPartyNumber	String	False		The public unique identification number for the object party of the relationship. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.
AccountSourceSystem	String	False		The name of external source system for the object party in the relationship, which are defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
AccountSourceSystemReferenceValue	String	False		The identifier for the object party in the relationship from external source system. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.
AccountUniqueName	String	True		The unique name of the account.
Comments	String	False		The comments of the user.
ContactFirstName	String	True		The first name of the contact record.
ContactLastName	String	True		The last name of the contact record.
ContactLastUpdateDate	Datetime	True		The date when the contact record was last updated.
ContactName	String	True		The name of the contact.
ContactNumber	String	False		The user-defined identification number for this contact.
ContactPartyId	Long	False		The primary key identifier of the subject in this relationship. Either one of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.
ContactPartyNumber	String	False		The public key identifier for the subject party of the relationship. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.
ContactSourceSystem	String	False		The name of external source system for the subject party in the relationship, which are defined by an administrator as part of system setup. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
ContactSourceSystemReferenceValue	String	False		The identifier for the subject party in the relationship from external source system. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.
CreatedBy	String	True		The user who created the row.
CreatedByModule	String	False		The application module that created the record. It's defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
CreationDate	Datetime	True		The date and time when the row was created.
DecisionMakerFlag	Bool	False		Indicates whether this contact is a decision maker. The values are Y for a decision maker, N for someone who's not the decision maker.
Department	String	False		The free form text used to name the department for the contact.
DepartmentCode	String	False		The value of the department code for the contact.
DoCallFlag	Bool	True		Indicates whether the user can call the contact of an account. The accepted values are True and False or Y and N. Default is False or N.
DoEmailFlag	Bool	True		Indicates whether the user can email the contact of an account. The accepted values are True and False or Y and N. Default is False or N.
DoNotCallFlag	Bool	True		Indicates whether you can call the account contact. The accepted values are True and False or Y and N. Default is False or N.
DoNotEmailFlag	Bool	True		Indicates whether you can email the account contact. The accepted values are True and False or Y and N. Default is False or N.
EmailAddress	String	True		The e-mail address of the contact person for the account.
EmailVerificationDate	Date	True		The date of the verification for the email.
EmailVerificationStatus	String	True		The status of the verification for email. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. Default value is blank which indicates that values aren't verified.
FormattedAddress	String	True		The formatted address of the contact.
FormattedPhoneNumber	String	True		The primary formatted phone number for the contact person.
InfluenceLevelCode	String	False		The contact's level of influence in the buying process.
JobTitle	String	False		The free form text for job title for the contact associated to an account.
JobTitleCode	String	False		The value of the code for the job title of the contact person.
LastUpdateDate	Datetime	True		The date and time when the record was last updated.
LastUpdateLogin	String	True		The login of the user who last updated the row.
LastUpdatedBy	String	True		The user who last updated the record.
PersonBuyingRole	String	True		Describes a contact's role in a buying relationship. Sample values are key decision maker, supporting decision maker.
PersonJobTitle	String	True		The title of the contact's job with deploying organization.
PersonSalesAffinityCode	String	True		The contact's affinity for the deploying organization.
PhoneVerificationDate	Date	True		The date of the verification for phone.
PhoneVerificationStatus	String	True		The status of the verification for phone. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID and ORA_INVALID. Default value is blank which indicates that values aren't verified.
PreferredContactFlag	Bool	False		Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N.
PreferredContactMethod	String	True		The person's or organization's preferred contact method.
PrimaryCustomerFlag	Bool	False		Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N.
ReferenceUseFlag	Bool	False		Indicates if this contact can be used as a reference. The values are Y for a contact who will act as a reference, N for a contact who can't act as a reference.
RelationshipId	Long	True		The unique identifier of the relationship associated with account contact record.
RelationshipRecId	Long	False		Finds an account contact with the relationship record identifier.
RelationshipSourceSystem	String	False		The name of external source system for the relationship, which is defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
RelationshipSourceSystemReferenceValue	String	False		The identifier for the relationship with the external source system.
SalesAffinityCode	String	False		The contact's affinity for the deploying organization.
SalesAffinityComments	String	False		The comments describing the contact's affinity for the deploying organization.
SalesBuyingRoleCode	String	False		The contact's role in the buying process.
Status	String	False		Indicates whether this is an active or inactive relationship. The values are A for active, I for inactive. This is an internal column and you're not expected to pass in a value. A list of valid values is defined in the lookup HZ_STATUS. You can review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. Default value is A.
AccountLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
FocusPartyId	String	The unique identifier of the child account to be returned at the top by the Direct Accounts finder.
ParentPartyId	String	The unique identifier of the account used to search the direct child accounts.
BindUserPartyId	String	The unique identifier of the party. Used in MyAccounts finder.
OrganizationProfileId	String	The unique identifier of the organization.
PartyId	String	The unique identifier of the party associated to the given account.
SourceSystem	String	Name of external source system.
SourceSystemReferenceValue	String	Identifier for this record from external source system.

AccountPrimaryAddresses

The primary address resource is used to view, create, and update primary address of an account. A primary address is the default communication address of an account.

Columns


Name	Type	ReadOnly	References	Description
AddressNumber [KEY]	String	False		This is the primary key of the primary addresses table.
PartyNumber [KEY]	String	False	Accounts.PartyNumber
AddressElementAttribute1	String	False		An additional address element to support flexible address format.
AddressElementAttribute2	String	False		An additional address element to support flexible address format.
AddressElementAttribute3	String	False		An additional address element to support flexible address format.
AddressElementAttribute4	String	False		An additional address element to support flexible address format.
AddressElementAttribute5	String	False		An additional address element to support flexible address format.
AddressId	Long	False		The unique identifier of the primary address.
AddressLine1	String	False		The first line of the primary address.
AddressLine2	String	False		The second line of the primary address.
AddressLine3	String	False		The third line of the primary address.
AddressLine4	String	False		The fourth line of the primary address.
AddressLinesPhonetic	String	False		The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan.
Building	String	False		The building name or number in the primary address.
City	String	False		The building name or number in the primary address.
Comments	String	False		The user-provided comments for the primary address.
CorpCurrencyCode	String	False		The corporate currency code used by the CRM Extensibility framework.
Country	String	False		The country code of the primary address. Review the list of country codes using the Manage Geographies task.
County	String	False		The county of the primary address.
CreatedBy	String	False		The user who created the primary address record.
CreationDate	Datetime	False		The date when the record was created.
CurcyConvRateType	String	False		The currency conversion rate type. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
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.
DateValidated	Date	False		The date when the primary address was last validated.
DeleteFlag	Boolean	False		Indicates whether the primary address is to be deleted. If the value is Y, then the primary address has to be deleted. The default value is N.
Description	String	False		The description of the location.
FloorNumber	String	False		The floor number of the primary address.
FormattedAddress	String	False		The formatted version of the primary address.
FormattedMultiLineAddress	String	False		The formatted multiline version of the primary address.
HouseType	String	False		Indicates the building type for the building in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the record.
LastUpdateLogin	String	False		The login of the user who last updated the record.
Latitude	Double	False		The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes.
LocationDirections	String	False		The directions to the address location.
LocationId	Long	False		The unique identifier for the location.
Longitude	Double	False		The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes.
Mailstop	String	False		The user-defined code that indicates a mail drop point within the organization.
PartyId	Long	False		The unique identifier of the account associated with the address.
PostalCode	String	False		The postal code of the address.
PostalPlus4Code	String	False		The four-digit extension to the United States Postal ZIP code for the address.
Province	String	False		The province of the address.
SourceSystem	String	False		The name of external source system where the address is imported from. The values configured in setup task Trading Community Source System.
SourceSystemReferenceValue	String	False		The unique identifier for the address from the external source system specified in the attribute PartySourceSystem.
State	String	False		The state of the address.
ValidatedFlag	Boolean	False		Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N.
ValidationStatusCode	String	False		A standardized status code describing the results of the validation. The value is internally set by system during address cleansing.
AccountLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
FocusPartyId	String	The unique identifier of the child account to be returned at the top by the Direct Accounts finder.
ParentPartyId	String	The unique identifier of the account used to search the direct child accounts.
BindUserPartyId	String	The unique identifier of the party. Used in MyAccounts finder.
OrganizationProfileId	String	The unique identifier of the organization.

AccountRelationships

The relationship resource is used to view, create, and update account relationships.

Columns


Name	Type	ReadOnly	References	Description
RelationshipRecId [KEY]	Long	False		This is the primary key of the relationships table.
PartyNumber [KEY]	String	False	Accounts.PartyNumber
Comments	String	False		The user-provided comments for the relationship.
CreatedBy	String	False		The user who created the record.
CreatedByModule	String	False		The module that created the account record.
CreationDate	Datetime	False		The date when the record was created.
EndDate	Date	False		The date when the relationship ends.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the record.
LastUpdateLogin	String	False		The login of the user who last updated the record.
ObjectPartyId	Long	False		The unique identifier of the object party in this relationship.
ObjectPartyNumber	String	False		The alternate key identifier for the object party of the relationship.
ObjectSourceSystem	String	False		The name of the external source system for the object party in the relationship.
ObjectSourceSystemReferenceValue	String	False		The identifier for the object party in the relationship from the external source system.
RelationshipCode	String	False		The code of the relationship that specifies if this is a forward or a backward relationship code. A list of valid relationship codes is defined in the lookup PARTY_RELATIONS_TYPE. Review and update the codes using the Setup and Maintenance task, Manage Relationship Lookups.
RelationshipSourceSystem	String	False		The name of external source system where the relationship is imported from. The values configured in setup task Trading Community Source System.
RelationshipSourceSystemReferenceValue	String	False		The unique identifier for the relationship from the external source system specified in the attribute RelationshipSourceSystem.
RelationshipType	String	False		The relationship type such as CUSTOMER_SUPPLIER. A list of valid relationship types is defined in the lookup HZ_RELATIONSHIP_TYPE. Review and update the codes using the Setup and Maintenance task, Manage Relationship Lookups.
StartDate	Date	False		The date when the relationship was created.
Status	String	False		Indicates if the relationship is active or inactive, such as A for active and I for inactive. A list of valid values is defined in the lookup HZ_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
SubjectPartyId	Long	False		The unique identifier of the subject party in this relationship.
SubjectPartyNumber	String	False		The alternate key identifier for the subject party of the relationship.
SubjectSourceSystem	String	False		The name of the external source system for the subject party in the relationship.
SubjectSourceSystemReferenceValue	String	False		The identifier for the subject party in the relationship from the external source system.
AccountLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.
PartyId	Long	False		The unique identifier of the party.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
FocusPartyId	String	The unique identifier of the child account to be returned at the top by the Direct Accounts finder.
ParentPartyId	String	The unique identifier of the account used to search the direct child accounts.
BindUserPartyId	String	The unique identifier of the party. Used in MyAccounts finder.
OrganizationProfileId	String	The unique identifier of the organization.

AccountResources

The sales team member resource represents a resource party and is assigned to a sales account team. A sales account team member has a defined access role for the sales account.

Columns


Name	Type	ReadOnly	References	Description
TeamMemberId [KEY]	Long	False		The surrogate primary key for the member of the sales account resource team.
PartyNumber [KEY]	String	False	Accounts.PartyNumber
AccessLevelCode	String	False		The access level determines the type of access granted to the resource as well as managers of the organizations. The possible values are contained in the ZCA_ACCESS_LEVEL lookup.
AssignmentTypeCode	String	False		The code indicating how the resource is assigned to the sales account team. The possible values are contained in the ZCA_ASSIGNMENT_TYPE lookup.
CreatedBy	String	False		The user who created the record.
CreationDate	Datetime	False		The date and time the record was created.
EndDateActive	Date	False		Indicates the date on which the association of resource is ended to the sales account.
LastUpdatedBy	String	False		The date on which the record is last updated.
LastUpdateLogin	String	False		The user who last updated the record.
LockAssignmentFlag	Boolean	False		The user login for the user who last updated the record.
MemberFunctionCode	String	False		The flag indicates automatic territory assignment cannot remove the sales account team resource when this flag is Y'. When a sales account team member is added manually, this flag is defaulted toY'. Otherwise,
ResourceEmailAddress	String	False		The lookup code indicating a sales account resource's role on the resource team such as Integrator, Executive Sponsor and Technical Account Manager. The code lookup is stored in FND_LOOKUPS.
ResourceId	Long	False		Unique identifier for the resource
ResourceName	String	False		The name of the sales team member.
ResourceOrgName	String	False		The name of the organization that the sales team member belongs to.
ResourcePartyNumber	String	False		Unique identifier for the resource
ResourcePhoneNumber	String	False		The primary phone number of the sales team member.
ResourceRoleName	String	False		The roles assigned to the sales team member.
SalesProfileId	Long	False		The identifier for the sales account.
StartDateActive	Date	False		Indicates the date on which the association of resource is created to the sales account.
UserLastUpdateDate	Datetime	False		The date and time of the last update from mobile.
AccountLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.
PartyId	Long	False		The unique identifier of the party.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
FocusPartyId	String	The unique identifier of the child account to be returned at the top by the Direct Accounts finder.
ParentPartyId	String	The unique identifier of the account used to search the direct child accounts.
BindUserPartyId	String	The unique identifier of the party. Used in MyAccounts finder.
SourceSystem	String	Name of external source system.
SourceSystemReferenceValue	String	Identifier for this record from external source system.
OrganizationProfileId	String	The unique identifier of the organization.

Accounts

The sales team member resource represents a resource party and is assigned to a sales account team. A sales account team member has a defined access role for the sales account.

Columns


Name	Type	ReadOnly	References	Description
PartyNumber [KEY]	String	False		The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number.
AnalysisFiscalYear	String	False		The fiscal year used as the source for financial information.
AssignmentExceptionFlag	Boolean	False		Indicates whether the sales account had 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 dimensions. The default value is False.
BusinessReport	String	False		The Dun & Bradstreet business information report.
BusinessScope	String	False		The class of business to which the account belongs, such as local, national, or international.
CEOName	String	False		The name of the organization's chief executive officer.
CEOTitle	String	False		The formal title of the chief executive officer.
CertificationLevel	String	False		The certification level the organization. A list of valid certification level codes is defined using the lookup HZ_PARTY_CERT_LEVEL. Review the Review and update the codes 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 valid certification reason codes are defined using the lookup HZ_PARTY_CERT_REASON. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
Comments	String	False		The corporate charter of the organization.
CongressionalDistrictCode	String	False		The U.S. Congressional district code for the account.
ControlYear	Long	False		The year when current ownership gained control of the organization.
CorpCurrencyCode	String	False		The corporate currency code associated with the account. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
CorporationClass	String	False		The taxation classification for corporation entities such as Chapter S in the US.
CreatedBy	String	False		The user who created the account record.
CreatedByModule	String	False		The module that created the account record.
CreationDate	Datetime	False		The date when the 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.
CurrentFiscalYearPotentialRevenueAmount	Decimal	False		The estimated revenues that can be earned by the organization during its current fiscal year.
DeleteFlag	Boolean	False		Indicates if the account can be deleted.
DisadvantageIndicator	String	False		Indicates whether the organization is considered disadvantaged by the US government under Title 8A. If the value is Yes, the organization is considered disadvantaged under Title 8A. The default value is No.
DomesticUltimateDUNSNumber	String	False		The DUNS Number for the Domestic Ultimate. A Domestic Ultimate is the highest member of the same country in the organization's hierarchy. An organization can be its own Domestic Ultimate.
DoNotConfuseWith	String	False		Indicates that there is an organization that is similarly named.
DUNSCreditRating	String	False		The Dun & Bradstreet credit rating.
DUNSNumber	String	False		The DUNS Number in freeform text format. The value not restricted to nine digit number.
EmailAddress	String	False		The e-mail address of the contact point for the organization.
EmailFormat	String	False		The preferred format for e-mail addressed to this organization, such as HTML or ASCII.
EmployeesAtPrimaryAddress	String	False		The qualifier to calculate the estimated number of employees at the primary address. A list of valid qualifier codes are defined using the lookup EMP_AT_PRIMARY_ADR_EST_IND. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
EmployeesAtPrimaryAddressEstimation	String	False		The estimated minimum number of employees at the primary address. A list of accepted values are defined in the lookup type EMP_AT_PRIMARY_ADR_MIN_IND. Review and update the values using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
EmployeesAtPrimaryAddressMinimum	String	False		The qualifier to qualify calculation of employees at the primary address as minimum.
EmployeesAtPrimaryAddressText	String	False		The number of employees at the referenced address in text format.
EmployeesTotal	Long	False		The total number of employees in the organization.
ExistingCustomerFlag	Boolean	False		Indicates if 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.
ExistingCustomerFlagLastUpdateDate	Date	False		The date when the existing customer flag was last updated.
ExportIndicator	String	False		Indicates whether the organization is an exporter. If the value is Y, then the organization is an exporter. The default value is N.
FavoriteAccountFlag	Boolean	False		Indicates if the account is a favorite.
FaxAreaCode	String	False		The area code for the fax number.
FaxCountryCode	String	False		The international country code for a fax number, such as 33 for France.
FaxExtension	String	False		The extension to the fax number of the organization.
FaxNumber	String	False		The fax number of the organization in the local format. The number should not include area code, country code, or extension.
FiscalYearendMonth	String	False		The last month of a fiscal year for the organization. The list of accepted values is defined in the lookup type MONTH.
FormattedFaxNumber	String	False		The formatted phone number of the organization.
FormattedPhoneNumber	String	False		The formatted phone number of the organization.
GeneralServicesAdministrationFlag	Boolean	False		Indicates whether organization is a US federal agency supported by the General Services Administration (GSA). If the value is Y, then the organization is supported by GSA. The default value is N.
GlobalUltimateDUNSNumber	String	False		The DUNS Number for the Global Ultimate. A Global Ultimate is the highest member in the organization's hierarchy. An organization can be its own Global Ultimate.
GrowthStrategyDescription	String	False		The user-defined description of growth strategy.
HomeCountry	String	False		The home country of the organization.
HQBranchIndicator	String	False		The status of this site, such as HQ, a branch, or a single location. A list of accepted values are defined in the lookup type HQ_BRANCH_IND.
ImportIndicator	String	False		Indicates whether the organization is an importer. If the value is Y, then the organization is an importer. The default value is N.
IndustryCode	String	False		The Industry classification code. The classification codes are defined for every classification category as specified in IndustryCodeType attribute. Review and update the codes using the Setup and Maintenance work area, Manage Classification Categories task.
IndustryCodeType	String	False		The industry classification category code type. It is defaulted to the value of profile option MOT_INDUSTRY_CLASS_CATEGORY. Review and update the codes using the Setup and Maintenance work area, Manage Classification Categories task.
LaborSurplusIndicator	String	False		Indicates whether the organization operates in an area with a labor surplus. If the value is Y, then the organization operates in an area with a labor surplus. The default value is N.
LastAssignmentDateTime	Datetime	False		The date when the Sales Account Territory Assignment was last run by Assignment Manager.
LastEnrichmentDate	Date	False		The date when the record was last enriched.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the record.
LastUpdateLogin	String	False		The login of the user who last updated the record.
LegalStatus	String	False		The legal structure of the organization such as partnership, corporation, and so on.
LineOfBusiness	String	False		The type of business activities performed at this site.
LocalActivityCode	String	False		The local activity classification code.
LocalActivityCodeType	String	False		The local activity classification code type identifier.
LocalBusinessIdentifier	String	False		The primary identifier assigned to a businesses by a government agency such as Chamber of Commerce, or other authority. It is often used by countries other than USA.
LocalBusinessIdentifierType	String	False		The lookup that represents most common business identifier in a country such as Chamber of Commerce Number in Italy, Government Registration Number in Taiwan. A list of accepted values are defined in the lookup type LOCAL_BUS_IDEN_TYPE.
MinorityOwnedIndicator	String	False		Indicates whether the organization is primarily owned by ethnic or racial minorities. If the value is Y, then the organization is owned by ethnic or racial minorities. company is primarily owned by ethnic or racial minorities. The default value is N.
MinorityOwnedType	String	False		The type of minority-owned firm.
MissionStatement	String	False		The corporate charter of organization in user-defined text format.
NamedFlag	Boolean	False		Indicates if the sales account is a named sales account. If the value is True, then the account is a named account. The default value is False.
NextFiscalYearPotentialRevenueAmount	Decimal	False		The estimated revenue of the organization to be earned during its next fiscal year.
OrganizationName	String	False		The name of the account.
OrganizationSize	String	False		The size of the organization based on its revenue, number of employees, and so on.
OrganizationType	String	False		The type of the organization.
OutOfBusinessIndicator	String	False		Indicates whether the organization is out of business. If the value is Y, then the organization is out of business. The default value is N.
OwnerEmailAddress	String	False		The e-mail address of the employee resource that owns and manages the sales account. The owner is a valid employee resource defined within Sales Cloud.
OwnerName	String	False		The name of the employee resource that owns and manages the sales account.
OwnerPartyId	Long	False		The unique identifier of a valid employee resource who owns and manages the sales account.
OwnerPartyNumber	String	False		The party number of a valid employee resource who owns and manages the sales account.
ParentAccountName	String	False		The name of the parent account in the hierarchy.
ParentAccountPartyId	Long	False		The party Id of the parent account within the hierarchy. To assign a parent account to a sales account, you must provide the parent account's party ID, party number, or source system reference.
ParentAccountPartyNumber	String	False		The party number of the parent account within the hierarchy.
ParentAccountSourceSystem	String	False		The source system of the parent account within the hierarchy.
ParentAccountSourceSystemReferenceValue	String	False		The source system reference of the parent account within the hierarchy.
ParentDUNSNumber	String	False		The DUNS Number of the organization or the parent entity that owns a majority stake of the organization's capital stock. The parent entity can be a subsidiary of another corporation. If the parent also has branches, then it is regarded as headquarters as well as a parent company.A headquarters is a business establishment that has branches or divisions reporting to it, and is financially responsible for those branches or divisions. If the headquarters has more than 50% of capital stock owned by another corporation, it also will be a subsidiary. If it owns more than 50% of capital stock of another corporation, then it is also a parent.
ParentOrSubsidiaryIndicator	String	False		Title:
PartyId	Long	False		Title:
PartyStatus	String	False		Title:
PartyUniqueName	String	False		Title:
PhoneAreaCode	String	False		Title:
PhoneCountryCode	String	False		Title:
PhoneExtension	String	False		Title:
PhoneNumber	String	False		Title:
PreferredContactMethod	String	False		Title:
PreferredFunctionalCurrency	String	False		Title:
PrimaryContactEmail	String	False		Title:
PrimaryContactName	String	False		Title:
PrimaryContactPartyId	Long	False		Title:
PrimaryContactPartyNumber	String	False		Title:
PrimaryContactPhone	String	False		Title:
PrimaryContactSourceSystem	String	False		Title:
PrimaryContactSourceSystemReferenceValue	String	False		Title:
PrincipalName	String	False		Title:
PrincipalTitle	String	False		Title:
PublicPrivateOwnershipFlag	Boolean	False		Title:
RecordSet	String	False		Title:
RegistrationType	String	False		Title:
RentOrOwnIndicator	String	False		Title:
SalesProfileStatus	String	False		Title:
SmallBusinessIndicator	String	False		Indicates whether the organization is considered as a small business. If the value is Y, then the organization is considered as a small business. The default value is N.
SourceSystem	String	False		The name of external source system where the account party is imported from. The values configured in setup task Trading Community Source System.
SourceSystemReferenceValue	String	False		The unique identifier for the account party from the external source system specified in the attribute SourceSystem.
StockSymbol	String	False		The corporate stock symbol of the organization as listed in stock exchanges.
TaxpayerIdentificationNumber	String	False		The taxpayer identification number that is often a unique identifier of the organization, such as income taxpayer Id in USA and fiscal code or NIF in Europe.
TotalEmployeesEstimatedIndicator	String	False		Indicates if the employee total is estimated. The accepted values are defined in the lookup type TOTAL_EMP_EST_IND.
TotalEmployeesIndicator	String	False		Indicates if subsidiaries are included in the calculation of total employees. The accepted values are defined in the lookup type TOTAL_EMPLOYEES_INDICATOR.
TotalEmployeesMinimumIndicator	String	False		Indicates if the number is a minimum, maximum, or average number of total employees. The accepted values are defined in the lookup type TOTAL_EMP_MIN_IND.
TotalEmployeesText	String	False		The total number of employees in text format.
Type	String	False		The account type that defines if the account is a sales account or a prospect or any other party type. The accepted values are defined in the lookup type ZCA_ACCOUNT_TYPE. It is defaulted to ZCA_CUSTOMER if no value is provided.
UniqueNameSuffix	String	False		The suffix used to generate the attribute PartyUniqueName. The suffix is concatenated to the OrganizationName attribute to generate the PartyUniqueName. The primary address is defaulted as the suffix.
UpdateFlag	Boolean	False		Indicates if the record can be updated.
URL	String	False
WomanOwnedIndicator	String	False		Indicates whether the organization is primarily owned by women. If the value is Y, then the organization is primarily owned by women. The default value is N.
YearEstablished	Int	False		The year that the organization started it business operations.
YearIncorporated	Int	False		The year that the business was formally incorporated.
OrganizationProfileId	Long	False		The unique identifier of the organization.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
FocusPartyId	String	The unique identifier of the child account to be returned at the top by the Direct Accounts finder.
ParentPartyId	String	The unique identifier of the account used to search the direct child accounts.
BindUserPartyId	String	The unique identifier of the party. Used in MyAccounts finder.

Activities

Table to capture task and appointment information.

Columns


Name	Type	ReadOnly	References	Description
ActivityNumber [KEY]	String	False		System generated or can come from external system (user key).
ActivityId	Long	False		System generated non-nullable primary key of the table.
StartDtRFAttr	Datetime	False		null
AccountAddress	String	False		null
AccountId	Long	False		Party Id of the activity account (Customer - org/person, or Partner etc.).
AccountIdAttr	Long	False		null
AccountName	String	False		Name of account associated to activity.
AccountNameOsn	String	False		null
AccountPhoneNumber	String	False		null
AccountStatus	String	False		null
AccountType	String	False		null
ActivityCreatedBy	String	False		Original Activity Created By
ActivityCreationDate	Datetime	False		Original Activity Creation Date
ActivityDescription	String	False		A text field for capturing some descriptive information about the activity.
ActivityDirection	String	False		null
ActivityEndDate	Datetime	False		The end date and time of an appointment, or the completion time of a task.
ActivityFilter	String	False		null
ActivityFunctionCode	String	False		Task vs Appointment. System use only.
ActivityFunctionCodeTrans	String	False		null
ActivityLastUpdateLogin	String	False		Original Activity Last Update Login
ActivityMtgMinutes	String	False		Activity meeting minutes
ActivityOutcome	String	False		null
ActivityPartialDescription	String	False		null
ActivityPriority	String	False		null
ActivityStartDate	Datetime	False		The start date and time of an appointment or a task. Defaulted to null for an appointment and defaulted to creation datetime for a task.
ActivityStatus	String	False		null
ActivityTimezone	String	False		Represents the time zone that the activity needs to be created in, other than the default logged in user's timezone preference.
ActivityType	String	False		null
ActivityTypeCode	String	False		The type or category of the activity.
ActivityUpdateDate	Datetime	False		Original Activity Update Date
ActivityUpdatedBy	String	False		Original Activity Updated By
ActivityUserLastUpdateDate	Datetime	False		Original Activity User Last Update Date
AllDayFlag	Bool	False		Designates that an appointment is the entire day.
ApptEndTime	Datetime	False		null
ApptStartTime	Datetime	False		null
AssessmentId	Long	False		Identifier of the Assessment to which the activity or the activity template is associated to.
AssetId	Long	False		Id of the Asset associated with the activity.
AssetName	String	False		Name of the Asset associated with the activity
AssetNumber	String	False		Asset Number.
AssetSerialNumber	String	False		Asset Serial Number.
AttachmentEntityName	String	False		null
AutoLogSource	String	False		For activities auto-generated through other systems, store the source system where it came from. We will use this information later in sync back logic to avoid double appearances of the same activity.
BpId	Long	False		Related Business plan.
BuOrgId	Long	False		null
CalendarAccess	Bool	False		null
CalendarRecurType	String	False		null
CalendarSubject	String	False		null
CalendarSubjectDay	String	False		null
CalendarTimeType	String	False		null
CallReportCount	Long	False		null
CallReportUpcomingYN	String	False		Flag to indicate Y,N,M for upcoming appointments
CallReportYN	String	False		Flag to Check if this activity has a Call Report
CampaignId	Long	False		Related Campaign.
CampaignName	String	False		Name of campaign associated to the activity.
CheckedInBy	String	False		Specifies the name of the person who checks-in to a location.
CheckedOutBy	String	False		Specifies the name of the person who checks-out to a location.
CheckinDate	Datetime	False		Stores the date and time when a user checks in to an Appointment.
CheckinLatitude	Double	False		Stores the latitude of a location where a user checks in to an Appointment.
CheckinLongitude	Double	False		Stores the longitude of a location where a user checks in to an Appointment.
CheckoutDate	Datetime	False		Stores the date and time when a user checks out of an Appointment.
CheckoutLatitude	Double	False		Stores the latitude of a location where a user checks out of an Appointment.
CheckoutLongitude	Double	False		Stores the longitude of a location where a user checks out of an Appointment.
ClaimId	Long	False		Related Claim.
ClaimName	String	False		Claim Name associated to the activity.
ConflictId	Long	False		null
ContactIDAttr	Long	False		null
CorpCurrencyCode	String	False		Holds Corporate Currency Code from profile
CreatedBy	String	False		System attribute to capture the user Id of the activity creator. This is defaulted by the system.
CreationDate	Datetime	False		System attribute to capture the Date and time the activity was created. This is defaulted by the system.
CurcyConvRateType	String	False		Holds currency code of a record
CurrencyCode	String	False		Holds Currency Conversion Rate Type from profile
CurrentDateForCallReport	Datetime	False		null
CurrentDateForCallReportAttr	Datetime	False		null
CurrentSystemDtTransient	Date	False		null
CustomerAccountId	Long	False		Id of Customer Account that the activity relates to.
DealId	Long	False		Related Deal.
DealNumber	String	False		Deal Number associated to the activity.
DelegatorId	Long	False		Activity resource that delegated activity ownership to another resource.
DelegatorName	String	False		Name of activity resource that delegated activity ownership to another resource.
DeleteFlag	Bool	False		This flag controls if the user has access to delete the record
DerivedAccountId	Long	False		null
DirectionCode	String	False		Inbound/Outbound. Optional. Default null.
DismissFlag	Bool	False		This Flag indicates if this activity is Dismissed
DoNotCallFlag	Bool	False		Flag to indicate if primary Contact can be called.
DueDate	Date	False		The date the task activity is due to be completed.
Duration	Double	False		Duration of an appt or task.
DynamicClaimLOVSwitcher	String	False		null
EmailSentDate	Datetime	False		This field is used to capture the Activity Email Notification shared date for Outlook integration
EndDateForCallReport	Datetime	False		null
EndDateForCallReportAttr	Datetime	False		null
EndDtRFAttr	Datetime	False		null
ExternalContactEmail	String	False		Indicates the Email address of an external contact.
ExternalContactName	String	False		Indicates the name of an external contact.
ExternallyOwnedFlag	Bool	False		Indicates that the activity is not created by an internal resource.
FundRequestId	Long	False		Related Fund request.
FundRequestName	String	False		Fund Request Name associated to the activity.
InstNumDerivedFrom	String	False		null
IsClientService	String	False		null
LastUpdateDate	Datetime	False		System attribute to capture the Date and Time the activity was last updated. This is defaulted by the system.
LastUpdateLogin	String	False		System attribute to capture the Id of the user who last updated the activity. This is defaulted by the system.
LastUpdatedBy	String	False		System attribute to capture the Id of the user who last updated the activity. This is defaulted by the system.
LeadId	Long	False		Related Lead.
LeadIdAttr	Long	False		null
LeadName	String	False		Lead Name
LeadNameOsn	String	False		null
Location	String	False		Appointment location.
LocationId	Long	False		Location or Address ID of the activity account or primary contact.
LoginUserRFAttr	Long	False		null
MdfRequestId	Long	False		null
MobileActivityCode	String	False		Unique identifier of external mobile device.
NotesLinkSourceCodeTransient	String	False		null
ObjectiveId	Long	False		Related Objective.
OpportunityId	Long	False		Related Opportunity.
OpportunityIdAttr	Long	False		null
OpportunityName	String	False		Name of opportunity associated to the activity.
OpportunityNameOsn	String	False		null
OrigEntityCode	String	False		null
OrigEntityNumber	String	False		null
OsnActivityId	Long	False		null
OtherPartyPhoneNumber	String	False		For inbound phone calls, the ANI or number being called from. For outbound calls, the phone number being called.
OutcomeCode	String	False		The outcome of the activity.
OutlookFlag	Bool	False		If created from Outlook and synced,
OutlookIdentifier	String	False		Unique identifier from Outlook Activity.
OwnerAddress	String	False		Activity Owner's Address.
OwnerEmailAddress	String	False		Activity Owner's Email Address.
OwnerId	Long	False		Primary resource on the activity. Supports resources only.
OwnerName	String	False		Name of primary resource of activity.
OwnerNameOsn	String	False		null
OwnerPhoneNumber	String	False		Activity Owner's Phone Number.
ParentActivityId	Long	False		Related activity Id, only applicable if the record is a follow up activity.
ParentActivityIdAttr	String	False		null
PartialMtgMinutes	String	False		null
PartnerEnrollmentId	Long	False		Related Partner Enrollment
PartnerEnrollmentNumber	String	False		null
PartnerPartyId	Long	False		Party identifier of the partner organization.
PartnerPartyName	String	False		Party name of the partner organization.
PartnerProgramId	Long	False		Related Partner Program.
PartnerProgramName	String	False		Name of partner program associated to the activity.
PartnerUsageFlag	Bool	False		Flag to indicate that the Activity has been created for an Organization Account with usage as Partner.
PercentageComplete	Double	False		Numeric Value 0-100 to reflect the percent complete status of the activity. Free form numeric. % value at end.
PrimaryContactEmailAddress	String	False		Holds Email Id of the primary contact
PrimaryContactId	Long	False		Primary contact of the activity.
PrimaryContactName	String	False		Name of primary contact.
PrimaryContactNameOsn	String	False		null
PrimaryFormattedAddress	String	False		Holds Address of the primary contact
PrimaryFormattedPhoneNumber	String	False		Holds Phone Number of the primary contact
PriorityCode	String	False		The priority of the activity. Default to 2. Possible values: 1, 2, 3.
PrivateFlag	Bool	False		This Flag indicates if this activity is private
RecordSet	String	False		null
RecurDay	Long	False		Repeat on specified day of month (for monthly appointments).
RecurEndDate	Datetime	False		Ends on a specified date.
RecurEveryOptionFlag	Bool	False		It is set to indicate if the recurrence occurs for every day, month, year, etc. For example, a daily recurring appointment can occur every day of the week or weekdays only. If it is everyday of the week, it is set to Y if it is weekdays only, it is set to N.
RecurExceptionFlag	Bool	False		Indicates if Appointment instance has been updated outside of recurring appointment series.
RecurFrequency	Double	False		Frequency that the recurring appointment series repeats.
RecurFriFlag	Bool	False		Repeat on Friday.
RecurMonFlag	Bool	False		Repeat on Monday.
RecurMonth	String	False		Repeat on specified month (for yearly appointments).
RecurNumberOfInstances	Long	False		Designates specific number of occurrences for the series to end after.
RecurOrigInstDate	Datetime	False		Original date of a recurring appointment instance.
RecurPattern	String	False		Designates which week for appointment to recur (for monthly and yearly appointments). Possible values: First, Second, Third, Fourth, Last.
RecurRecType	String	False		For Internal Use Only. Either
RecurSatFlag	Bool	False		Repeat on Saturday.
RecurSeriesId	Long	False		Series Id that links instances of a series together.
RecurSunFlag	Bool	False		Repeat on Sunday.
RecurThuFlag	Bool	False		Repeat on Thursday.
RecurTueFlag	Bool	False		Repeat on Tuesday.
RecurTypeCode	String	False		Designates how often an appointment is repeated. Possible values: Daily, Weekly, Monthly, Yearly.
RecurUpdatedAttributes	String	False		null
RecurWedFlag	Bool	False		Repeat on Wednesday.
RecurWeekday	String	False		It works in conjunction with RecurPattern attribute. Possbile values: Monday to Sunday, Weekday, Weekend, Day
ReferenceCustomerActTypeCode	String	False		Activity Type for a reference customer activity. To be used as an extension only
ReferenceCustomerId	Long	False		Id of the reference customer (party) associated with the activity.
ReminderPeriod	String	False		Reminder Period
ResponseCode	String	False		Response Code
SalesObjectiveName	String	False		Sales Objective Name associated to the activity.
SearchDate	Datetime	False		null
SelectedFlag	Bool	False		null
ShowStatus	String	False		null
ShowTimeAs	String	False		Show Time
SortDate	Datetime	False		This is an internal column which is used to sort the activity based on the due date for task and start date for activity.
SourceObjectCode	String	False		Code of the Object to which Activity will get related to
SourceObjectId	Long	False		Identifier of the Object to which Activity will get related to
SrId	Long	False		Service Request Id
SrNumber	String	False		Service Request Number
StartDateForCallReport	Datetime	False		null
StartDateForCallReportAttr	Datetime	False		null
StatusCode	String	False		Status of the activity. Defaulted to NOT_STARTED.
Subject	String	False		Subject/Name/Title of the activity.
SubmittedBy	Long	False		Call Report submitter.
SubmittedByName	String	False		Call Report submitter
SubmittedDate	Datetime	False		Call Report submission date
SwitchCallId	String	False		Unique Ientifier of the call on the external phone system.
TemplateDuration	Double	False		The duration (in days) of the template activity. This attribute is used with the start date when generating an activity from a template in order to calculate the due date.
TemplateFlag	String	False		null
TemplateId	Long	False		null
TemplateLeadTime	String	False		The lead time (in days) of the template activity. This attribute is used with the date input parameter when generating an activity from a template in order to calculate the activity start date. Activity start date = date provided as input parameter + lead time.
UpdateFlag	Bool	False		This flag controls if the user has access to update the record
UpgSourceObjectId	String	False		null
UpgSourceObjectType	String	False		null

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
DateRange	String	The date range within which you want search for appointments.
Bind_CurrentDate	String	Finds the date used to locate completed activities.
Bind_RecurSeriesType_BV	String	The recurring type code of an appointment.
Bind_TaskActFuncCd_BV	String	The activities with a function code of task.
Bind_TaskStatus_BV	String	The status of the tasks.
Bind_UserResourceId	String	Finds the resource ID of the user.
Bind_Subject	String	Open activities owned by a specified user.
Bind_LoggedInUserId_BV	String	The ID of the user who is logged into the application.
Bind_TaskStatus_Cancel_BV	String	The tasks with a cancelled status.
Bind_TaskPriority_BV	String	The priority of the task.
Bind_CurrentUPTZDate	String	The date used to locate the Tasks whose due date is before the current date.

ActivityAssignees

Table used to capture the assignees/resources associated to the activity.

Columns


Name	Type	ReadOnly	References	Description
ActivityAssigneeId [KEY]	Long	False		Activity Assignee Id.This is the surrogate primary key added for BI and Outlook.
ActivityFunctionCode	String	False		null
ActivityId [KEY]	Long	False		System generated non-nullable primary key of the Parent Activity.
ActivityNumber [KEY]	String	False
AssigneeId [KEY]	Long	False		ID of assignee associated with the activity.
AssigneeName	String	False		Assignee Name
AssigneePartyNumber	String	False		Holds Party Number of the contact
AtkMessageId	Long	False		null
AttendeeFlag	Bool	False		Flag to Check If the Contact Attended the Activity
ConflictId	Long	False		null
CorpCurrencyCode	String	False		Holds Corporate Currency Code from profile
CreatedBy	String	False		System attribute to capture the user Id of the activity assignee creator. This is defaulted by the system.
CreationDate	Datetime	False		System attribute to capture the date and time the activity assignee was created. This is defaulted by the system.
CurcyConvRateType	String	False		Holds Currency Conversion Rate Type from profile
CurrencyCode	String	False		Holds currency code of a record
DismissFlag	Bool	False		This Flag indicates if this activity is Dismissed
JobName	String	False		Job Name
LastUpdateDate	Datetime	False		System attribute to capture the date and time the activity assignee was last updated. This is defaulted by the system.
LastUpdateLogin	String	False		System attribute to capture the Id of the user who last updated the activity assignee. This is defaulted by the system.
LastUpdatedBy	String	False		System attribute to capture the Id of the user who last updated the activity assignee. This is defaulted by the system.
Phone	String	False		Holds Phone Number of the contact
PrimaryAssigneeFlag	String	False		null
PrimaryEmail	String	False		Holds Email Id of the contact
PrimaryFormattedAddress	String	False		Holds Primary Address of the resource
RecurSeriesId	Long	False		null
ReminderDatetime	Datetime	False		The date/time to send the appointment reminder.
ReminderPeriod	Int	False		Designates how soon before the appointment to send a reminder.
ResourceName	String	False		null
ResponseCode	String	False		Flag to indicate whether a reminder if needed.
SenderJobId	Long	False		null
ShowTimeAsCode	String	False		Designates how to show your appointment time on the calendar (free, busy, tentative).
SortDate	Datetime	False		null
StatusCode	String	False		null
UpgSourceObjectId	Long	False		null
UpgSourceObjectType	String	False		null
UserGuid	String	False		null
UserGuid1	String	False		null
UserLastUpdateDate	Datetime	False		Attribute to capture when the record was last updated by a user in disconnect mode.
UserName	String	False		null
ActivityLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
ContactIDAttr	String	The contact ID related to the activities.
AccountIdAttr	String	Finds the account ID related to the call reports.
LeadIdAttr	String	Finds the lead ID related to the call reports.
OpportunityIdAttr	String	Finds the opportunity ID related to the call reports.
ParentActivityIdAttr	String	The parent activity ID related to the call reports.
EndDtRFAttr	String	The appointment end date.
StartDtRFAttr	String	The appointment start date.
DateRange	String	The date range within which you want search for appointments.
Bind_CurrentDate	String	Finds the date used to locate completed activities.
Bind_RecurSeriesType_BV	String	The recurring type code of an appointment.
Bind_TaskActFuncCd_BV	String	The activities with a function code of task.
Bind_TaskStatus_BV	String	The status of the tasks.
Bind_UserResourceId	String	Finds the resource ID of the user.
Bind_Subject	String	Open activities owned by a specified user.
Bind_LoggedInUserId_BV	String	The ID of the user who is logged into the application.
Bind_TaskStatus_Cancel_BV	String	The tasks with a cancelled status.
Bind_TaskPriority_BV	String	The priority of the task.
Bind_CurrentUPTZDate	String	The date used to locate the Tasks whose due date is before the current date.

ActivityContacts

Table used to capture the contacts associated to the activity.

Columns


Name	Type	ReadOnly	References	Description
AccountId	Long	False		null
ActivityContactId [KEY]	Long	False		This is the surrogate primary key added for BI and Outlook.
ActivityId [KEY]	Long	False		System generated non-nullable primary key of the Parent Activity.
ActivityNumber [KEY]	String	False
Affinity	String	False		Contact Affinity
AttendeeFlag	Bool	False		Flag to Check If the Contact Attended the Activity
BuyingRole	String	False		Contact Buying Role
ConflictId	Long	False		null
ContactAccount	String	False		Holds the Account Name that the Contact is associated to
ContactAccountId	Long	False		Holds the Id of the Account that the Contact is associated to
ContactAccountType	String	False		null
ContactCustomer	String	False		null
ContactEmail	String	False		Holds Email Id of the contact
ContactId [KEY]	Long	False		Id of contact associated with the activity.
ContactJobTitle	String	False		Holds the Job Title of the Contact
ContactLovSwitcher	String	False		null
ContactName	String	False		Contact Name
ContactPartyNumber	String	False		Holds Party Number of the contact
ContactPhone	String	False		Holds Phone Number of the contact
CorpCurrencyCode	String	False		Holds Corporate Currency Code from profile
CreatedBy	String	False		System attribute to capture the user Id of the activity contact creator. This is defaulted by the system.
CreationDate	Datetime	False		System attribute to capture the date and time the activity contact was created. This is defaulted by the system.
CurcyConvRateType	String	False		Holds Currency Conversion Rate Type from profile
CurrencyCode	String	False		Holds currency code of a record
DoNotCallFlag	Bool	False		Flag to check if this contact can be contacted through Call
DoNotContactFlag	Bool	False		Flag to check if this contact can be contacted
DoNotEmailFlag	Bool	False		Flag to check if this contact can be contacted through Email
EmailContactPreferenceFlag	String	False		null
ExternalContactEmail	String	False		Indicates the Email address of an external contact.
ExternalContactFlag	Bool	False		Indicates that the contact does not exist in Oracle Sales.
ExternalContactName	String	False		Indicates the name of an external contact.
LastUpdateDate	Datetime	False		System attribute to capture the date and time the activity contact was last updated. This is defaulted by the system.
LastUpdateLogin	String	False		System attribute to capture the Id of the user who last updated the activity contact. This is defaulted by the system.
LastUpdatedBy	String	False		System attribute to capture the ID of the user who last updated the activity contact. This is defaulted by the system.
Name	String	False		null
PhoneContactPreferenceFlag	String	False		null
PrimaryContactFlag	Bool	False		This used of enable/disable PrimaryContactFlag for a contact.
PrimaryFormattedAddress	String	False		Holds Primary Address of the contact
RecurSeriesId	Long	False		null
RelationshipId	Long	False		Id of the relationship of the contact.
UpgSourceObjectId	Long	False		null
UpgSourceObjectType	String	False		null
UserLastUpdateDate	Datetime	False		Attribute to capture when the record was last updated by a user in disconnect mode.
ActivityLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
ContactIDAttr	String	The contact ID related to the activities.
AccountIdAttr	String	Finds the account ID related to the call reports.
LeadIdAttr	String	Finds the lead ID related to the call reports.
OpportunityIdAttr	String	Finds the opportunity ID related to the call reports.
ParentActivityIdAttr	String	The parent activity ID related to the call reports.
EndDtRFAttr	String	The appointment end date.
StartDtRFAttr	String	The appointment start date.
DateRange	String	The date range within which you want search for appointments.
Bind_CurrentDate	String	Finds the date used to locate completed activities.
Bind_RecurSeriesType_BV	String	The recurring type code of an appointment.
Bind_TaskActFuncCd_BV	String	The activities with a function code of task.
Bind_TaskStatus_BV	String	The status of the tasks.
Bind_UserResourceId	String	Finds the resource ID of the user.
Bind_Subject	String	Open activities owned by a specified user.
Bind_LoggedInUserId_BV	String	The ID of the user who is logged into the application.
Bind_TaskStatus_Cancel_BV	String	The tasks with a cancelled status.
Bind_TaskPriority_BV	String	The priority of the task.
Bind_CurrentUPTZDate	String	The date used to locate the Tasks whose due date is before the current date.

ActivityNotes

Note data objects that capture comments, information or instructions for an Oracle Fusion Applications business object.

Columns


Name	Type	ReadOnly	References	Description
NoteId [KEY]	Long	False		Unique Note Identifier. This is the primary key of the notes table.
ActivityNumber [KEY]	String	False	Activities.ActivityNumber
ContactRelationshipId	Long	False		The relationship ID populated when the note is associated with a contact.
CorpCurrencyCode	String	False		Holds Corporate Currency Code from profile
CreatedBy	String	False		Who column: indicates the user who created the row.
CreationDate	Datetime	False		Who column: indicates the date and time of the creation of the row.
CreatorPartyId	Long	False		This is Party Id for the Note Creator
CurcyConvRateType	String	False		Holds Currency Conversion Rate Type from profile
CurrencyCode	String	False		Holds currency code of a record
DeleteFlag	Bool	False		This flag controls if the user has access to delete the record
EmailAddress	String	False		Email Address of the user who created the Note
FormattedAddress	String	False		Address of the user who created the Note
FormattedPhoneNumber	String	False		Phone Number of the user who created the Note
LastUpdateDate	Datetime	False		Who column: indicates the date and time of the last update of the row.
LastUpdateLogin	String	False		System attribute to capture the Id of the user who last updated the Note. This is defaulted by the system.
LastUpdatedBy	String	False		System attribute to capture the Id of the user who last updated the Note. This is defaulted by the system.
NoteTxt	String	False		This is the column which will store the actual note text.
NoteTypeCode	String	False		This is the note type code for categorization of note.
ParentNoteId	Long	False		null
PartyId	Long	False		Party identifier
PartyName	String	False		Name of this party
SourceObjectCode	String	False		This is the source_object_code for the source object as defined in OBJECTS Metadata.
SourceObjectId	String	False		This is the source_object_Uid for the source object (such as Activities, Opportunities etc) as defined in OBJECTS Metadata.
UpdateFlag	Bool	False		This flag controls if the user has access to update the record
VisibilityCode	String	False		This is the attribute to specify the visibility level of the note.
ActivityLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
ActivityId	String	The unique identifier of the activity.
ContactIDAttr	String	The contact ID related to the activities.
AccountIdAttr	String	Finds the account ID related to the call reports.
LeadIdAttr	String	Finds the lead ID related to the call reports.
OpportunityIdAttr	String	Finds the opportunity ID related to the call reports.
ParentActivityIdAttr	String	The parent activity ID related to the call reports.
EndDtRFAttr	String	The appointment end date.
StartDtRFAttr	String	The appointment start date.
DateRange	String	The date range within which you want search for appointments.
Bind_CurrentDate	String	Finds the date used to locate completed activities.
Bind_RecurSeriesType_BV	String	The recurring type code of an appointment.
Bind_TaskActFuncCd_BV	String	The activities with a function code of task.
Bind_TaskStatus_BV	String	The status of the tasks.
Bind_UserResourceId	String	Finds the resource ID of the user.
Bind_Subject	String	Open activities owned by a specified user.
Bind_LoggedInUserId_BV	String	The ID of the user who is logged into the application.
Bind_TaskStatus_Cancel_BV	String	The tasks with a cancelled status.
Bind_TaskPriority_BV	String	The priority of the task.
Bind_CurrentUPTZDate	String	The date used to locate the Tasks whose due date is before the current date.

ActivityObjectives

Table used to capture the objectives associated to the activity.

Columns


Name	Type	ReadOnly	References	Description
ObjectiveId [KEY]	Long	False		Objective Id
ActivityNumber [KEY]	String	False	Activities.ActivityNumber
ActivityId	Long	False	Activities.ActivityId	System generated non-nullable primary key of the Parent Activity.
AttributeCategory	String	False		null
CompletedFlag	Bool	False		Completed Flag
ConflictId	Long	False		Conflict id
CorpCurrencyCode	String	False		Holds Corporate Currency Code from profile
CreatedBy	String	False		System attribute to capture the user Id of the activity assignee creator. This is defaulted by the system.
CreationDate	Datetime	False		System attribute to capture the date and time the activity assignee was created. This is defaulted by the system.
CurcyConvRateType	String	False		Holds Currency Conversion Rate Type from profile
CurrencyCode	String	False		Holds currency code of a record
LastUpdateDate	Datetime	False		System attribute to capture the date and time the activity assignee was last updated. This is defaulted by the system.
LastUpdateLogin	String	False		System attribute to capture the Id of the user who last updated the activity assignee. This is defaulted by the system.
LastUpdatedBy	String	False		System attribute to capture the Id of the user who last updated the activity assignee. This is defaulted by the system.
ObjectiveCode	String	False		Objective Code
ObjectiveFreefmtText	String	False		Objective Free Format Text
RecurSeriesId	Long	False		null
ActivityLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
ContactIDAttr	String	The contact ID related to the activities.
AccountIdAttr	String	Finds the account ID related to the call reports.
LeadIdAttr	String	Finds the lead ID related to the call reports.
OpportunityIdAttr	String	Finds the opportunity ID related to the call reports.
ParentActivityIdAttr	String	The parent activity ID related to the call reports.
EndDtRFAttr	String	The appointment end date.
StartDtRFAttr	String	The appointment start date.
DateRange	String	The date range within which you want search for appointments.
Bind_CurrentDate	String	Finds the date used to locate completed activities.
Bind_RecurSeriesType_BV	String	The recurring type code of an appointment.
Bind_TaskActFuncCd_BV	String	The activities with a function code of task.
Bind_TaskStatus_BV	String	The status of the tasks.
Bind_UserResourceId	String	Finds the resource ID of the user.
Bind_Subject	String	Open activities owned by a specified user.
Bind_LoggedInUserId_BV	String	The ID of the user who is logged into the application.
Bind_TaskStatus_Cancel_BV	String	The tasks with a cancelled status.
Bind_TaskPriority_BV	String	The priority of the task.
Bind_CurrentUPTZDate	String	The date used to locate the Tasks whose due date is before the current date.

Assets

Usage information for the operation Assets.rsd.

Columns


Name	Type	ReadOnly	References	Description
AssetId [KEY]	Long	False		The unique identifier of the Asset.
AssetAmount	Decimal	False		The cost amount of the asset in the transaction currency.
AssetDescription	String	False		The description field of the asset.
AssetGroup	String	False		The name of the asset group.
AssetName	String	False		The name that describes the asset.
AssetNumber	String	False		The number that identifies the asset.
AssetOrigSystem	String	False		A source system code that identifies the original source system of the asset
AssetOrigSystemReference	String	False		A source system reference that identifies the unique ID of the asset in user's legacy or external system.
AssetTag	String	False		The tag number associated with the asset.
AttributeCategory	String	False		Standard column used in Fusion tables.
BatchId	Long	False		The batch ID for importing process.
CompetitiveAsset	String	False		Indicates if the asset belongs to a competitor.
CorpCurrencyCode	String	False		Corporate currency code
CreatedBy	String	False		The user who created the record or imported the record.
CreationDate	Datetime	False		The time stamp when the record was created.
CrmConvRate	String	False		CRM Currency convert rate
CurcyConvRateType	String	False		Currency convert rate type
CustomerId	Long	False		The unique ID for the existing customer party record in the Oracle Fusion destination table.
CustomerPartyNumber	String	False
DeleteFlag	Bool	False		Delete Flag for soft deletes, Y for Yes and NULL or N for No
Description	String	False		Asset item description
EndDate	Date	False		The date when the asset ends.
EnteredCurrencyCode	String	False		The code that represents the currency for the asset amounts.
IBAssetId	Long	False		Unique ID of the associated Install Base asset record.
IBAssetSyncedVersionNumber	Int	False		Last synced Version Number of the Install Base Asset
InstallDate	Date	False		The date the asset was installed.
InterfaceRowId	Long	False		The interface table row's unique ID.
InventoryItemId	Long	False		The unique ID for the existing sales catalog product (item) record in the Oracle Fusion destination table.
InventoryOrgId	Long	False		Item Organization Id as created by Fusion CRM
ItemNumber	String	False		Item Number
LastUpdateDate	Datetime	False		The time stamp when the record was last updated.
LastUpdateLogin	String	False		The ID of the user who last updated the record in the interface table or submitted the import process.
LastUpdatedBy	String	False		The session sign in of the user that last updated the row.
Manufacturer	String	False		The name of the manufacturer.
Model	String	False		The name of the model.
OrganizationId	Long	False		Organization ID
PartyType	String	False
PartyUniqueName	String	False
PrContactPartyId	Long	False		The party identifier of the asset's primary contact.
PrContactPartyNumber	String	False
ProdGroupId	Long	False		Product Group ID in sales catalog
ProdGroupName	String	False		Product Group Name
ProdGroupReferenceNumber	String	False
Product	String	False		The name of the product.
ProductType	String	False
PurchaseDate	Date	False		The date the asset was purchased.
Quantity	Decimal	False		The quantity purchased.
ResourceOwnerId	Long	False		The identifier of the asset's resource owner.
ResourceOwnerPartyNumber	String	False
SearchFilter	String	False
SerialNumber	String	False		The asset's serial number.
StartDate	Date	False		The date when the asset starts.
StatusCode	String	False		The lookup code that represents the asset status, such as active or expired.
UOMCode	String	False		Unit of Measure
Version	String	False		The version of the asset product.
Year	String	False		The year of manufacture or the nominal model year of the asset product.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
PartyId	String	The unique identifier of the party used to find the account by hierarchy.
PartyIdAttribute	String	The unique identifier attribute name of the party used to find the account by hierarchy.
AttributeName	String	The rollup attribute name to find a rollups.
RollupId	String	The unique identifier of a rollup used to find the rollup.
SourceObject	String	The source object code used to find the rollup.
SourceObjectId	String	The source object identifier of the party associated with the rollup.

CompetitorAccounts

The competitor accounts resource is used to view, create, and update a competitor account and manage competitor details.

Columns


Name	Type	ReadOnly	References	Description
PartyId [KEY]	Long	False		PartyId
AnnualRevenueAmount	Double	False		AnnualRevenueAmount
CeoName	String	False		CeoName
Country	String	False		Country
CreatedBy	String	True		CreatedBy
CreatedByModule	String	False		CreatedByModule
CreationDate	Datetime	True		CreationDate
CurrencyCode	String	False		CurrencyCode
DUNSNumber	String	False		DUNSNumber
DbRating	String	False		DbRating
DeletetFlag	Bool	True		DeletetFlag
FiscalYearendMonth	String	False		FiscalYearendMonth
IncorpYear	Int	False		IncorpYear
LastUpdateDate	Datetime	True		LastUpdateDate
LastUpdateLogin	String	True		LastUpdateLogin
LastUpdatedBy	String	True		LastUpdatedBy
LineOfBusiness	String	False		LineOfBusiness
MinorityOwnedInd	String	False		MinorityOwnedInd
OrganizationName	String	False		OrganizationName
OrganizationSize	String	False		OrganizationSize
PartyName	String	False		PartyName
PartyNumber	String	False		PartyNumber
PartyType	String	False		PartyType
PublicPrivateOwnershipFlag	Bool	False		PublicPrivateOwnershipFlag
SICCode	String	False		SICCode
SmallBusInd	String	False		SmallBusInd
StatusCode	String	False		StatusCode
StockSymbol	String	False		StockSymbol
ThreatLevelCode	String	False		ThreatLevelCode
TradingPartnerIdentifier	String	False		TradingPartnerIdentifier
URL	String	False		URL
UniqueNameSuffix	String	False		UniqueNameSuffix
UpdateFlag	Bool	True		UpdateFlag
YearEstablished	Int	False		YearEstablished

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.

ContactAddresses

Table that includes attributes used to store values while creating or updating an address. An address represents the location information of an account, contact or household.

Columns


Name	Type	ReadOnly	References	Description
AddressNumber [KEY]	String	False		The unique alternate 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. A list of accepted values is defined in the profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number.
PartyNumber [KEY]	String	False	Contacts.PartyNumber	The alternate unique identifier of the contact to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the contact record with which the address is associated. The default value for PartyNumber is the value specified in the profile option ZCA_PUID_PREFIX concatenated with a unique generated sequence number. You can update the PartyNymber 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.
AddrElementAttribute1	String	False		The additional address element to support flexible address format.
AddrElementAttribute2	String	False		The additional address element to support flexible address format.
AddrElementAttribute3	String	False		The additional address element to support flexible address format.
AddrElementAttribute4	String	False		The additional address element to support flexible address format.
AddrElementAttribute5	String	False		The additional address element to support flexible address format.
Address1	String	False		The first line for address.
Address2	String	False		The second line for address.
Address3	String	False		The third line for address.
Address4	String	False		The fourth line for address.
AddressId	Long	False		The unique identifier for the address that is generated internally during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.
AddressLinesPhonetic	String	False		The phonetic or kana representation of the Kanji address lines (used in Japan).
City	String	False		The city element of Address.
ClliCode	String	False		The Common Language Location Identifier (CLLI) code.
Comments	String	False		User comments for the address.
CorpCurrencyCode	String	False		The corporate currency code associated with the addresses. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
Country	String	False		The country code of the address. This attribute is defined in the TERRITORY_CODE column in the FND_TERRITORY table.
County	String	False		The county element of Address.
CreatedBy	String	False		The user who created the address record.
CreatedByModule	String	False		The application module that created this organization record. The default value for CreatedByModule is HZ_WS for all Web service based creation.
CreationDate	Datetime	False		The date and time when the address record was created.
CurcyConvRateType	String	False		The currency conversion rate type associated with the address. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
CurrencyCode	String	False		The currency code associated with the address. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
DateValidated	Date	False		The date when the address was last validated.
Description	String	False		An extensive description of the location of the address.
DoNotMailFlag	Boolean	False		Indicates if this address should be used for mailing. If the value is True, then the address should not be used for mailing. The default value is False.
EffectiveDate	Date	False		The date when the address becomes effective.
EndDateActive	Date	False		Date on which this address is no longer active.
FloorNumber	String	False		The specific floor number at a given address or in a particular building when building number is provided.
FormattedAddress	String	False		The formatted address information.
FormattedMultilineAddress	String	False		The formatted multiple line address information.
HouseType	String	False		The type of building. A list of accepted values for this attribute is defined in the lookup HZ_HOUSE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
LastUpdateDate	Datetime	False		The date when the address data was last updated.
LastUpdatedBy	String	False		The user who last updated the address record.
LastUpdateLogin	String	False		The session login associated to the user who last updated the address record.
Latitude	Double	False		Used to store latitude information for the location for spatial proximity and containment purposes.
LocationDirections	String	False		The directions to the location.
LocationId	Long	False		The unique identifier for this location.
Longitude	Double	False		Used to store longitude information for the location for spatial proximity and containment purposes.
Mailstop	String	False		A user-defined code to indicate a mail drop point within their organization.
ObjectVersionNumber	Long	False		Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
PartyId	Long	False		The unique Identifier of the contact to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the contact record with which the address is associated.
PartySourceSystem	String	False		The name of external source system of the contact with which the address is associated. Part of Alternate Key for the contact record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the contact record with which the address is associated. A list of accepted values should be pre-defined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems task.
PartySourceSystemReferenceValue	String	False		The identifier from external source system for the contact with which the address is associated. Part of Alternate Key (along with PartySourceSystem). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the contact record with which the address is associated.
PostalCode	String	False		The postal code as defined by the formal countrywide postal system.
PostalPlus4Code	String	False		The four digit extension to the United States Postal ZIP code.
PrimaryFlag	Boolean	False		Indicates if this is the primary address of the contact irrespective of the context. If the value is True, then the address is the primary address of the contact. The default value is False.
Province	String	False		The province element of Address.
SourceSystem	String	False		The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value of SourceSystem should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
SourceSystemReferenceValue	String	False		The identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
StartDateActive	Date	False		Date on which this address becomes active.
State	String	False		The state element of Address.
Status	String	False		The status of the address. A list of accepted values is defined in the lookup HZ_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
ValidatedFlag	Boolean	False		Indicates if the location was validated. If the value is True, then the location is validated. The default value is False. The value is internally set by system during address cleansing.
ValidationStartDate	Date	False		The date when the address validation started. The value is internally set by system during address cleansing.
ValidationStatusCode	String	False		The standardized status code describing the results of the address validation. The value is internally set by system during address cleansing.
ContactLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
BindUserPartyId	String	The unique identifier of the contact.
PersonProfileId	String	The unique identifier of the contact.

ContactAddressPurposes

The address purpose resource is used to view, create, or modify the address purpose. The address purpose describes the use of an address, such as shipping address or billing address.

Columns


Name	Type	ReadOnly	References	Description
AddressPurposeId [KEY]	Long	False		This is the primary key of the contact address purposes table.
PartyNumber [KEY]	String	False	Contacts.PartyNumber
AddressNumber [KEY]	String	False	ContactAddresses.AddressNumber
DeleteFlag	Boolean	False		Indicates if the address purpose for an address was deleted. If the value is True, then the address purpose is deleted. The default value is False.
Purpose	String	False		The use or purpose of the address.
ContactLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.
SourceSystem	String	False		The name of external source system for the address purpose denoted by a code, which is defined by an administrator as part of system setup.
SourceSystemReferenceValue	String	False		The unique identifier for the address purpose from the external source.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
BindUserPartyId	String	The unique identifier of the contact.
PersonProfileId	String	The unique identifier of the contact.
PartyId	String	The unique identifier of the contact.

ContactContactPoints

The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on.

Columns


Name	Type	ReadOnly	References	Description
ContactPointId [KEY]	Long	True	Contacts.PartyNumber	The unique identifier of the contact point.
PartyNumber [KEY]	String	False		The unique alternate identifier for the account party.
ConflictId	Long	False		The unique identifier of the conflict for the contact point record. This number is used by mobile or portable applications that consume the web service.
ContactPointType	String	False		The type of Contact Point record. The accepted values are defined in the lookup type COMMUNICATION_TYPE. Sample values include PHONE, EMAIL, and WEB.
CreatedBy	String	True		The user who created the contact point record.
CreatedByModule	String	False		The application module that created this contact point record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
CreationDate	Datetime	True		The date when the record was created.
DoContactPreferenceFlag	Bool	False		Indicates whether to use a particular contact method. Defaulted to false.
DoNotContactPreferenceFlag	Bool	False		Indicates whether the record can be contacted.
DoNotContactReason	String	False		The reason code for the contact preference.
EmailAddress	String	False		The email address of the contact point record of type email.
EmailPurpose	String	False		The purpose of using the EMAIL contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE. The values can be ASSISTANT, PERSONAL, HOME_BUSINESS, BUSINESS, and so on.
FormattedPhoneNumber	String	True		The formatted phone number of the contact point.
LastUpdateDate	Datetime	True		The date when the record was last updated.
LastUpdateLogin	String	True		The login of the user who last updated the record.
LastUpdatedBy	String	True		The user who last updated the contact point record.
ObjectVersionNumber	Int	False		The number used to implement optimistic locking for contact point record. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
PartyId	Long	False		The unique identifier of the associated party record for contact point.
PartySourceSystem	String	False		The name of external source system of the account, contact or household with which the contact point is associated. Part of alternate key for the account, contact or household record along with PartyourceSystemReferenceValue. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
PartySourceSystemReferenceValue	String	False		The unique identifier from external source system for the account, contact or household with which the address is associated. Part of alternate key along with PartySourceSystem. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated.
PhoneAreaCode	String	False		The area code for the phone number.
PhoneCountryCode	String	False		The country code of the phone number.
PhoneExtension	String	False		The extension number of the phone line number like office desk extension.
PhoneNumber	String	False		The phone number of the contact point.
PhonePurpose	String	False		Defines the purpose of using the PHONE contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.
PhoneType	String	False		The type of phone contact point. The accepted values are defined in the lookup type ORA_HZ_PHONE_TYPE. The values can be WORK, HOME, FAX, and so on.
PreferenceRequestedBy	String	False		Indicates if the permission or restriction was created internally or requested by the party. The list of accepted values are defined in the REQUESTED_BY lookup.
PrimaryFlag	Bool	False		Indicates whether this is the primary contact point of the associated object. If the value is True, then this is the primary contact point. The default value is False. If this attribute isn't explicitly mentioned in the payload, then the value of this attribute is set to null.
RawPhoneNumber	String	False		The raw phone number on the contact point record of type phone.
SocialNetworkId	String	False		The unique identifier of the social network.
SocialNetworkName	String	False		The name of the social network.
SocialNetworkPurpose	String	False		Defines the purpose of using the IM contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.
SourceSystem	String	False		The name of external source system, which is defined by an administrator as part of system setup. It's part of alternate key along with SourceSystemReference, and is mandatory if PK or partyNumberBusinessKey isn't passed in update.
SourceSystemReferenceValue	String	False		The unique identifier for the contacts party from the external source system specified in the attribute SourceSystem. It's part of alternate key along with SourceSystemReference, and is mandatory if PK or partyNumberBusinessKey isn't passed in update.
Status	String	False		Indicates the status of the contact point. The status codes are defined in the lookup HZ_STATUS. The default value is A.
URL	String	False		The URL of the contact point.
VerificationDate	Date	False		The date of verification of the phone or email contact point.
VerificationStatus	String	False		The status of the verification for phone or email contact points. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. The value ORA_PARTIALLY_VALID is applicable only for email. Default value is blank which indicates that values aren't verified.
WebPurpose	String	False		Defines the purpose of using the WEB contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE_WEB.Sample values: HOMEPAGE,SALESURL,MARKETINGURL,SUPPORTURL,RSS_FEED etc.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
BindUserPartyId	String	The unique identifier of the contact.
PersonProfileId	String	The unique identifier of the contact.

ContactNotes

The note resource is used to capture comments, information, or instructions for a contact.

Columns


Name	Type	ReadOnly	References	Description
NoteId [KEY]	Long	False		This is the primary key of the notes table.
PartyNumber [KEY]	String	False	Contacts.PartyNumber
ContactRelationshipId	Long	False		The identifier of the relationship populated when the note is associated with a contact.
CorpCurrencyCode	String	False		The corporate currency code of the note associated with the contact. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
CreatedBy	String	False		The user who created the note record.
CreationDate	Datetime	False		The date and time when the note record was created.
CreatorPartyId	Long	False		The unique party identifier for the note creator.
CurcyConvRateType	String	False		The currency conversion rate type associated with the note. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
CurrencyCode	String	False		The currency code associated with the note. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
LastUpdateDate	Datetime	False		The date when the note data was last updated.
NoteTxt	String	False		The actual note text.
NoteTypeCode	String	False		This code for categorization of the note type.
PartyId	Long	False		The unique Identifier of the contact to which the note is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the contact record with which the address is associated.
PartyName	String	False		The name of a contact party.
SourceObjectCode	String	False		The code of the source object such as Activities, Opportunities, as defined in OBJECTS Metadata.
SourceObjectId	String	False		The primary key identifier of the source object such as Activities, Opportunities, as defined in OBJECTS Metadata.
VisibilityCode	String	False		The visibility level of the note.
ContactLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
BindUserPartyId	String	The unique identifier of the contact.
PersonProfileId	String	The unique identifier of the contact.
SourceSystem	String	The name of external source system where the contact party is imported from.
SourceSystemReferenceValue	String	The unique identifier for the contact party from the external source system.

ContactPrimaryAddresses

The primary address resource is used to view, create, or modify a primary address of a contact. A primary address is the default communication address of an entity.

Columns


Name	Type	ReadOnly	References	Description
AddressNumber [KEY]	String	False		This is the primary key of the contact primary addresses table.
PartyNumber [KEY]	String	False	Contacts.PartyNumber
AddressElementAttribute1	String	False		The additional address element to support flexible address format.
AddressElementAttribute2	String	False		The additional address element to support flexible address format.
AddressElementAttribute3	String	False		The additional address element to support flexible address format.
AddressElementAttribute4	String	False		The additional address element to support flexible address format.
AddressElementAttribute5	String	False		The additional address element to support flexible address format.
AddressId	Long	False		The unique identifier for the address that is generated internally during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.
AddressLine1	String	False		The first line for address.
AddressLine2	String	False		The second line for address.
AddressLine3	String	False		The third line for address.
AddressLine4	String	False		The fourth line for address.
AddressLinesPhonetic	String	False		The phonetic or kana representation of the Kanji address lines (used in Japan).
Building	String	False		The specific building name or number at a given address.
City	String	False		The city element of Address.
Comments	String	False		User comments for the address.
CorpCurrencyCode	String	False		The corporate currency code associated with the addresses. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
Country	String	False		The country code of the address. This attribute is defined in the TERRITORY_CODE column in the FND_TERRITORY table.
County	String	False		The county element of Address.
CreatedBy	String	False		The user who created the address record.
CreationDate	Datetime	False		The date and time when the address record was created.
CurcyConvRateType	String	False		The currency conversion rate type associated with the address. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
CurrencyCode	String	False		The currency code associated with the address. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
DateValidated	Date	False		The date when the address was last validated.
DeleteFlag	Boolean	False		Indicates if the primary address was deleted. If the value is True, then the primary address is deleted. The default value is False.
Description	String	False		An extensive description of the location of the address.
FloorNumber	String	False		The specific floor number at a given address or in a particular building when building number is provided.
FormattedAddress	String	False		The formatted address information.
FormattedMultiLineAddress	String	False		The formatted multiple line address information.
HouseType	String	False		The type of building. A list of accepted values is defined in the lookup HZ_HOUSE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
LastUpdateDate	Datetime	False		The date when the address data was last updated.
LastUpdatedBy	String	False		The user who last updated the address record.
LastUpdateLogin	String	False		The session login associated to the user who last updated the address record.
Latitude	Double	False		Used to store latitude information for the location for spatial proximity and containment purposes.
LocationDirections	String	False		The directions to the location.
LocationId	Long	False		The unique identifier for this location.
Longitude	Double	False		Used to store longitude information for the location for spatial proximity and containment purposes.
Mailstop	String	False		A user-defined code to indicate a mail drop point within their organization.
PartyId	Long	False		The unique Identifier of the contact to which the primary address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the contact record with which the address is associated.
PostalCode	String	False		The postal code as defined by the formal countrywide postal system.
PostalPlus4Code	String	False		The four digit extension to the United States Postal ZIP code.
Province	String	False		The province element of Address.
SourceSystem	String	False		The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value of SourceSystem should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
SourceSystemReferenceValue	String	False		The identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
State	String	False		The state element of Address.
ValidatedFlag	Boolean	False		Indicates if the location was validated. If the value is True, then the location is validated. The default value is False. The value is internally set by system during address cleansing.
ValidationStatusCode	String	False		The date when the address validation started. The value is internally set by system during address cleansing.
ContactLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
BindUserPartyId	String	The unique identifier of the contact.
PersonProfileId	String	The unique identifier of the contact.

ContactRelationships

The relationship resource includes attributes that are used to store values while viewing, creating, or updating a relationship.

Columns


Name	Type	ReadOnly	References	Description
RelationshipRecId [KEY]	Long	False		This is the primary key of the relationships table.
PartyNumber [KEY]	String	False	Contacts.PartyNumber
Comments	String	False		User comments for the relationship.
CreatedBy	String	False		The user who created the relationship record.
CreatedByModule	String	False		The application module that created this organization 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 relationship record was created.
EndDate	Date	False		The date when the relationship ends.
LastUpdateDate	Datetime	False		The date and time when the relationship data was last updated.
LastUpdatedBy	String	False		The user who last updated the relationship record.
LastUpdateLogin	String	False		The session login associated to the user who last updated the relationship record.
ObjectPartyId	Long	False		The primary key identifier of the contact, in this relationship. One of ObjectPartyId, ObjectPartyNumber and ObjectSourceSystem along with ObjectSourceSystemReferenceValue combination is used to identify the contact party of the relationship.
ObjectPartyNumber	String	False		The unique alternate identifier for the relationship of the contact party. One of ObjectPartyId, ObjectPartyNumber and ObjectSourceSystem along with ObjectSourceSystemReferenceValue combination is used to identify the object party of the relationship.
ObjectSourceSystem	String	False		The name of external source system for the contact party in the relationship, which are defined by an admin as part of system setup. One of ObjectPartyId, ObjectPartyNumber and ObjectSourceSystem along with ObjectSourceSystemReferenceValue combination is used to identify the object party of the relationship. A list of accepted values should be pre-defined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems task.
ObjectSourceSystemReferenceValue	String	False		The identifier from external source system for the relationship of the contact party. One of ObjectPartyId, ObjectPartyNumber and ObjectSourceSystem along with ObjectSourceSystemReferenceValue combination is used to identify the contact party of the relationship.
RelationshipCode	String	False		The code for a forward or a backward relationship. A list of accepted relationship values is defined in the lookup PARTY_RELATIONS_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Relationship Lookups.
RelationshipSourceSystem	String	False		The name of external source system for the relationship, which are defined by an Admin as part of system setup.
RelationshipSourceSystemReferenceValue	String	False		The identifier from external source system for the relationship.
RelationshipType	String	False		The type of relationship of a contact party, such as CUSTOMER_SUPPLIER. A list of accepted relationship type values is defined in the lookup HZ_RELATIONSHIP_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Relationship Lookups task.
StartDate	Date	False		Date on which this relationship becomes active.
Status	String	False		The status of the relationship. Indicates if this is an active or inactive relationship. The values A indicate an active relationship and I an inactive relationship. This is an internal column and user is not expected to pass in a value. A list of accepted values is defined in the lookup HZ_STATUS. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
SubjectPartyId	Long	False		The primary key identifier of the subject in this relationship. One of SubjectPartyId, SubjectPartyNumber and SubjectSourceSystem along with SubjectSourceSystemReferenceValue combination is used to identify the subject party of the relationship.
SubjectPartyNumber	String	False		The alternate unique identifier for the subject party of the relationship. One of SubjectPartyId, SubjectPartyNumber and SubjectSourceSystem along with SubjectSourceSystemReferenceValue combination is used to identify the subject party of the relationship.
SubjectSourceSystem	String	False		The name of external source system for the subject party in the relationship, which are defined by an Admin as part of system setup. One of SubjectPartyId, SubjectPartyNumber and SubjectSourceSystem along with SubjectSourceSystemReferenceValue combination is used to identify the subject party of the relationship. A list of accepted values should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems task.
SubjectSourceSystemReferenceValue	String	False		The identifier from external source system for the subject party in the relationship. One of SubjectPartyId, SubjectPartyNumber and SubjectSourceSystem along with SubjectSourceSystemReferenceValue combination is used to identify the subject party of the relationship.
ContactLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.
PartyId	Long	False		The unique identifier of the party.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
BindUserPartyId	String	The unique identifier of the contact.
PersonProfileId	String	The unique identifier of the contact.
SourceSystem	String	The name of external source system where the contact party is imported from.
SourceSystemReferenceValue	String	The unique identifier for the contact party from the external source system.

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	Double	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.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
BindUserPartyId	String	The unique identifier of the contact.

ContactSalesAccountResources

The sales team member resource represents a resource party and is assigned to a sales account team. A sales account team member has a defined access role for the sales account.

Columns


Name	Type	ReadOnly	References	Description
TeamMemberId [KEY]	Long	False		This is the primary key of the sales account resources table.
PartyNumber [KEY]	String	False	Contacts.PartyNumber
AccessLevelCode	String	False		The type of access granted to the resource as well as managers of the organizations. A list of accepted values is defined in the lookup ZCA_ACCESS_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
AssignmentTypeCode	String	False		The code indicating how the resource is assigned to the sales account team. A list of accepted values is defined in the lookup ZCA_ASSIGNMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
CreatedBy	String	False		The user who created the sales team member record.
CreationDate	Datetime	False		The date and time when the sale team member record was created.
EndDateActive	Date	False		Date on which this sales team member is no longer active.
LastUpdateDate	Datetime	False		The date when the sales team member record was last updated.
LastUpdatedBy	String	False		The user who last updated the sales team member record.
LastUpdateLogin	String	False		The session login associated to the user who last updated the sales team member record.
LockAssignmentFlag	Boolean	False		Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. The default value is False. When a sales account team member is added manually, this flag is defaulted to `Y'.
MemberFunctionCode	String	False		The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
ResourceEmailAddress	String	False		The e-mail address of the resource.
ResourceId	Long	False		The unique party ID for the existing resource record in Oracle Sales.
ResourceName	String	False		The name of the sales team member.
ResourceOrgName	String	False		The name of the organization that the sales team member belongs to.
ResourcePartyNumber	String	False		The unique public identifier of the resource record.
ResourcePhoneNumber	String	False		The primary phone number of the sales team member.
ResourceRoleName	String	False		The roles assigned to the sales team member.
SalesProfileId	Long	False		The unique identifier of the sales profile of the resource.
StartDateActive	Date	False		Date on which this sales team member becomes active.
UserLastUpdateDate	Datetime	False		The date and time when the sales team member was last updated from mobile.
ContactLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.
PartyId	Long	False		The unique identifier of the party.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
BindUserPartyId	String	The unique identifier of the contact.
PersonProfileId	String	The unique identifier of the contact.
SourceSystem	String	The name of external source system where the contact party is imported from.
SourceSystemReferenceValue	String	The unique identifier for the contact party from the external source system.

Leads

Usage information for the operation Leads.rsd.

Columns


Name	Type	ReadOnly	References	Description
LeadId [KEY]	Long	False		Partner Type. Indicates the type of partner stamped on the lead.
AcceptedDate	Date	False		The date on which lead was accepted by a resource assigned to it.
AcceptedDateTime	Datetime	False		Date and time when the sales lead is accepted by a resource assigned to it.
AccountPartyNumber	String	False
AddrElementAttribute1	String	False		Additional address element to support flexible address format.
AddrElementAttribute2	String	False		Additional address element to support flexible address format.
AddrElementAttribute3	String	False		Additional address element to support flexible address format.
AddrElementAttribute4	String	False		Additional address element to support flexible address format.
AddrElementAttribute5	String	False		Additional address element to support flexible address format.
AddressLinesPhonetic	String	False		Phonetic or Kana representation of the Kanji address lines (used in Japan).
ApprovalDate	Date	False		The date on which a partner registered lead is approved by internal channel manager.
ApprovalDateTime	Datetime	False		Date and time when the sales lead is approved. This is only applicable to deal registrations.
AssetId	Long	False		Unique identifier for the Asset associated with the Sales Lead.
AssetNumber	String	False		Unique Number for the Asset associated with the Sales Lead.
AssetSerialNumber	String	False		Serial Number for the Asset associated with the Sales Lead.
AssignmentStatusCode	String	False		Includes the current assignment related status for the lead, for example whether the lead is assigned or unassigned.
BudgetAmount	Decimal	False		Budget amount associated with this sales lead.
BudgetCurrencyCode	String	False		Currency code associated with the Budget Amount associated with this sales lead.
BudgetStatus	String	False		Budget status associated with the Budget Amount associated with this sales lead.
Building	String	False		Specific building name or number at a given address.
BusinessUnitId	Long	False		Business Unit Identifier associated with the business unit of the sales lead creator.
CampaignName	String	False		Name of the campaign associated with the sales lead.
ChannelType	String	False		Indicates the channel through which this lead contacted the company.
ClassCode1	String	False		The auxilliary dimension for the Account.
ClassCode2	String	False		The auxilliary dimension for the Account.
ClassCode3	String	False		The auxilliary dimension for the Account.
ClassCode4	String	False		The auxilliary dimension for the Account.
ContactFormattedAddress	String	False
ContactPartyNumber	String	False
ContactTimezoneCd	String	False		Preferred time zone of the contact pursued on the lead.
ConvertedDateTime	Datetime	False		Date and time when the sales lead is converted to an opportunity.
CreatedBy	String	False		Indicates the user who created this record.
CreationDate	Datetime	False		Indicates the date and time when this record is created.
CurrencyCode	String	False		Currency code for the lead.
CustomerId	Long	False		Customer Id. It is a reference to the customer record in the TCA schema.
CustomerNeed	String	False		Indicates what need the lead product serves for the lead customer.
CustomerPartyName	String	False		Name of the customer.
DealAmount	Decimal	False		The total amount attributed to a lead.
DecisionMakerIdentifiedFlag	Bool	False		Indicates if the decision maker at customer site has been identified.
DeleteFlag	Bool	False		This flag controls if the user has access to delete the record
Description	String	False		Description associated with this sales lead.
Distance	Double	False		Distance from the input location.
EstimatedCloseDate	Date	False		Estimated close date for a deal once registered
ExpirationDate	Date	False		Expiration date associated with this sales lead.
FloorNumber	String	False		Specific floor number at a given address or in a particular building when building number is provided.
FormattedPhoneNumber1	String	False
InventoryItemDescription	String	False		The description of the product added to a lead.
JobTitle	String	False		Job title of the primary contact on the sales lead.
LastAssignmentDate	Datetime	False		The date on which the lead was last reassigned.
LastUpdateDate	Datetime	False		Who column: indicates the date and time of the last update of the row.
LastUpdateLogin	String	False		Who column: indicates the login of the user who last updated the row.
LastUpdatedBy	String	False		Who column: indicates the user who last updated the row.
Latitude	Double	False		Latitude information for the location.
LeadAcceptedFlag	Bool	False		Indicates if the lead has been accepted.
LeadAging	Long	False		The number of days elapsed since the lead was created.
LeadCreatedBy	String	False		Functional WHO: Indicates the user who created this record.
LeadCreationDate	Datetime	False		Functional WHO: Indicates the date and time when this record is created.
LeadLastUpdateDate	Datetime	False		Functional WHO: Indicates the date and time of the last update of the row.
LeadLastUpdatedBy	String	False		Functional WHO: Indicates the user who last updated the row.
LeadNumber	String	False		User friendly unique identifier for a lead.
Longitude	Double	False		Longitude information for the location.
Name	String	False		Lead Name used for identifying the lead.
OrganizationSize	String	False		Organization Size
OrganizationType	String	False		Organization Type
OwnerId	Long	False		Party identifier associated with the owner of this sales lead.
OwnerPartyName	String	False		Name associated with the owner of this sales lead.
OwnerPartyNumber	String	False
PartnerCompanyNumber	String	False
PartnerId	Long	False		Unique identifier for the primary partner associated with the lead.
PartnerPartyName	String	False		Name associated with the primary partner of this sales lead. This is a deal specific attribute.
PartnerProgramId	Long	False		A reference to the partner program in which the primary partner associated with this sales lead is enrolled. This is a deal specific attribute.
PartnerProgramNumber	String	False
PartnerType	String	False		Indicates the type of the primary partner associated with this sales lead. This is a deal specific attribute.
PostalPlus4Code	String	False		Four digit extension to the United States Postal ZIP code.
PrimaryContactAddress1	String	False		The first line of address associated with the primary contact of the lead.
PrimaryContactAddress2	String	False		The second line of address associated with the primary contact of the lead.
PrimaryContactAddress3	String	False		The third line of address associated with the primary contact of the lead.
PrimaryContactAddress4	String	False		The fourth line of address associated with the primary contact of the lead.
PrimaryContactCity	String	False		The city where the primary contact of the lead is located.
PrimaryContactCountry	String	False		The country where the primary contact of the lead is located.
PrimaryContactCountryName	String	False		Full name associated with primary contact country code
PrimaryContactCounty	String	False		The county where the primary contact of the lead is located.
PrimaryContactEmailAddress	String	False		Email address for the primary sales lead contact on the lead
PrimaryContactId	Long	False		Identifer of the sales lead contact marked as a primary lead contact.
PrimaryContactPartyName	String	False		Name associated with the primary lead contact.
PrimaryContactPersonFirstName	String	False		First name of the primary contact for a lead.
PrimaryContactPersonLastName	String	False		Last name of the primary contact for a lead.
PrimaryContactPersonMiddleName	String	False		Middle name of the primary contact for a lead.
PrimaryContactPostalCode	String	False		The zip code where the primary contact of the lead is located.
PrimaryContactProvince	String	False		The province where the primary contact of the lead is located.
PrimaryContactRelationshipId	Long	False		Unique identifier of the relationship primary contact has with its parent organization.
PrimaryContactState	String	False		The state where the primary contact of the lead is located.
PrimaryInventoryItemId	Long	False		Unique identifier of the primary product associated with a lead.
PrimaryInventoryItemNumber	String	False
PrimaryInventoryOrgId	Long	False		Unique identifier of the organization to which the primary product associated with a lead belongs.
PrimaryPhoneAreaCode	String	False		Primary phone area code for the sales lead contact.
PrimaryPhoneCountryCode	String	False		Primary phone country code for the sales lead contact.
PrimaryPhoneNumber	String	False		Primary phone number for the sales lead contact.
PrimaryProductGroupId	Long	False		Unique identifier of the primary product group associated with a lead.
PrimaryProductGroupReferenceNumber	String	False
ProductGroupDescription	String	False		Description of the product or product group associated with a lead.
ProductGroupName	String	False		Name of the product group associated with a lead.
ProgramName	String	False		Name of the partner program in which the primary partner associated with this sales lead is enrolled. This is a deal specific attribute.
Project	String	False		customer project identified for this sales lead.
QualificationScore	Long	False		Qualification score for a lead.
QualifiedDate	Date	False		Indicates the date when this sales lead was qualified.
QualifiedDateTime	Datetime	False		Date and time when the sales lead is qualified.
Rank	String	False		Rank associated with this sales lead.
ReassignComment	String	False		Comment provided by a user while requesting the lead reassignment.
ReassignReasonCode	String	False		Pre-defined code used to indicate the reason for lead reassignment.
RecordSet	String	False
RegistrationNumber	String	False		Registration number of the sales lead. This unique identifier is generated when the sales lead is approved. This is a deal specific attribute.
RegistrationStatus	String	False		Approval Status of the sales lead. This is a deal specific attribute.
RegistrationType	String	False		Indicates the registration type of the sales lead. This is a deal specific attribute.
RejectByUserId	Long	False		Identifier of the sales representative who rejected this sales lead.
RejectComment	String	False		Comments provided by the sales representative who rejected this sales lead.
RejectReasonCode	String	False		Pre-defined code used to indicate the reason for rejecting a lead.
RejectedDateTime	Datetime	False		Date and time when the sales lead is rejected.
RetireComment	String	False		Comments recorded when the sales lead is moved to a retired status.
RetireReasonCode	String	False		Pre-defined code used to indicate the reason for retiring a lead.
RetiredDateTime	Datetime	False		Date and time when the sales lead is moved to a retired status.
SalesChannel	String	False		Indicates the sales channel responsible for following up on this sales lead.
Score	Long	False		The score associated with this sales lead. This score is computed based on the scoring rules.
SourceCode	String	False		Marketing source code associated with this sales lead.
StatusCode	String	False		Pre-defined code used to indicate the status of a lead.
Timeframe	String	False		Timeframe associated with this sales lead.
ToReassignFlag	Bool	False		Identifies leads that are marked for reassignment.
UpdateFlag	Bool	False		This flag controls if the user has access to update the record
WorkPhoneAreaCode	String	False		Work phone area code for the sales lead contact.
WorkPhoneCountryCode	String	False		Work phone country code for the sales lead contact.
WorkPhoneNumber	String	False		Work phone number for the sales lead contact.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
ContactId	String	The unique identifier of the Contact.
SysEffectiveDate	String	SysEffectiveDate.
ResourcePartyIdRest	String	The unique identifier of the Resource.
RestCreationDateLower	String	Finds the leads that are created before the date specified.
RestCreationDateUpper	String	Finds the leads with the specified creation date.
RestRecordSet	String	Finds the leads with the specified record set value.
RestStatusCode	String	Finds the leads with the specified status code.

LightboxDocuments

Usage information for the operation LightboxDocuments.rsd.

Columns


Name	Type	ReadOnly	References	Description
LightboxDocumentId [KEY]	String	False
CreatedBy	String	False
CreationDate	Datetime	False
CurrencyCode	String	False
CurrentRevision	String	False
DeleteFlag	Bool	False
DocumentContents	String	False
DocumentDownloadURL	String	False
DocumentDownloadedCount	Long	False
DocumentOwnerFlag	Bool	False
DocumentPageCount	Int	False
DocumentSharedToEntityCount	Long	False
DocumentSharedToUserCount	Long	False
DocumentThumbnailURL	String	False
DocumentTitle	String	False
DocumentType	String	False
DocumentTypeCode	String	False
DocumentUnsharedFromUserCount	Long	False
DocumentViewedInLightboxCount	Long	False
DocumentViewedOutsideLightboxCount	Long	False
FileName	String	False
FileSize	Long	False
IsDocumentReadyFlag	Bool	False
IsDocumentUploadInProgressFlag	Bool	False
IsSharedWithCurrentUserFlag	Bool	False
KeyPageSequenceNumber	Long	False
LastUpdateDate	Datetime	False
LastUpdateLogin	String	False
LastUpdatedBy	String	False
OriginalOwnerEmailAddress	String	False
OriginalOwnerName	String	False
OriginalOwnerPartyId	Long	False
PublicDocumentDate	String	False
PublicDocumentFlag	Bool	False
SharedDate	Datetime	False
Thumbnail	String	False
UpdateFlag	Bool	False
UploadDate	Datetime	False

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.

Opportunities

The opportunity competitor resource is used to view, create, and update the competitors for an opportunity. The opportunity competitors is used to store information about the competitors associated with the opportunity.

Columns


Name	Type	ReadOnly	References	Description
OptyNumber [KEY]	String	False		The unique alternate identifier for the opportunity.
AverageDaysAtStage	Int	False		The average duration, in number of days, the opportunity remains in the current sales stage.
BudgetAvailableDate	Date	False		The date when the budget will be available.
BudgetedFlag	Boolean	False		Indicates if the opportunity sales account has the budget approved for the potential purchase. If the value is true, then the sales account has the budget approved for the purchase. The default value is False.
ChampionFlag	Boolean	False		Indicates if the opportunity has an internal sponsor. If the value is true, then the opportunity has an internal sponsor. The default value is False.
CreatedBy	String	False		The user who created the opportunity record.
CreationDate	Datetime	False		The date and time when the record was created.
CurrencyCode	String	False		The currency used by the opportunity.
CustomerAccountId	Long	False		The customer account associated with the opportunity.
DealHorizonCode	String	False		The estimated time, in days, required to close the deal. A list of valid values is defined in the lookup MOO_SETID_DEAL_HORIZION. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
DecisionLevelCode	String	False		The job level of the person who takes the final decision for the opportunity. A list of valid values is defined in the lookup MOO_SETID_DECISION_LEVEL. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
DeleteFlag	Boolean	False		Indicates whether the opportunity can be deleted.
Description	String	False		The description of the opportunity including the sales objective. The description is added by the Sales Representative.
DescriptionText	String	False		The description of the sales objective of the opportunity.
DownsideAmount	Decimal	False		The minimum amount of revenue for the opportunity.
EffectiveDate	Date	False		The date when the opportunity may to close.
EmailAddress	String	False		The e-mail address of the employee resource that owns the opportunity.
ExpectAmount	Decimal	False		The expected revenue from the opportunity.
KeyContactId	Long	False		The unique identifier of the primary contact of the opportunity.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the opportunity record.
LastUpdateLogin	String	False		The session login associated to the user who last updated the record.
LineOfBusinessCode	String	False		The line of business that owns the opportunity.
MaximumDaysInStage	Int	False		The maximum duration, in number of days, that an opportunity can be in sales stage before it is considered stalled.
Name	String	False		The name of the opportunity.
OptyId	Long	False		The unique identifier of the opportunity.
OwnerResourcePartyId	Long	False		The unique identifier of a valid employee resource who owns and manages the opportunity.
PartyName1	String	False		The name of the opportunity owner.
PartyUniqueName1	String	False		The unique name of the primary competitor for the opportunity.
PhaseCd	String	False		The current phase of the opportunity sales stage.
PrimaryCompetitorId	Long	False		The unique identifier of the primary competitor for this opportunity.
PrimaryContactEmailAddress	String	False		The e-mail address of the primary contact for the opportunity.
PrimaryContactFormattedPhoneNumber	String	False		The formatted phone number of the primary contact for the opportunity.
PrimaryContactPartyName	String	False		The name of the opportunity's primary contact.
PrimaryOrganizationId	Long	False		The unique identifier of the business unit to which this opportunity belongs.
PrimaryPartnerId	Long	False		The unique identifier of the primary partner associated with the opportunity.
PrimaryPartnerOrgPartyName	String	False		The name of the primary partner associated with the opportunity.
PrimaryRevenueId	Long	False		The unique identifier of the summary revenue line for the opportunity. The summary revenue line stores the total revenue amount of the opportunity.
PrSrcNumber	String	False		The unique identifier number of the primary marketing source or campaign that generated this opportunity.
QuotaFactor	Decimal	False		The quota factor of the opportunity sales stage.
RcmndWinProb	Decimal	False		The recommended probability of winning the opportunity in the sales stage.
ReasonWonLostCode	String	False		The reason for winning or losing the opportunity. A list of valid values is defined in the lookup MOO_SETID_WIN_LOSS_REASON. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
Registered	String	False		Indicates whether the opportunity was registered. The valid values are Expired, Yes, and No.
RegistrationStatus	String	False		The registration status of the opportunity or deal created by a partner.
RegistrationType	String	False		The registration type used by the partner to create the opportunity or deal.
Revenue	Double	False		The estimated revenue amount from the opportunity.
RiskLevelCode	String	False		The risk level code of the opportunity. A list of valid values is defined in the lookup MOO_SETID_RISK_LEVE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
SalesAccountUniqueName	String	False		The unique name of the sales account that owns the opportunity.
SalesChannelCd	String	False		The sales channel for the opportunity.
SalesMethod	String	False		The sales method associated with the opportunity.
SalesMethodId	Long	False		The sales method identifier for this opportunity, and indicates the sales process used.
SalesStage	String	False		The current sales stage of the opportunity.
SalesStageId	Long	False		The unique identifier for the sales stage of the opportunity.
StageStatusCd	String	False		The default status for the opportunity's sales stage.
StatusCode	String	False		The status of the opportunity. A list of valid values is defined in the lookup MOO_OPTY_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
StgOrder	Decimal	False		The order of the opportunity's sales stage in the sales method.
StrategicLevelCode	String	False		The strategic value that the opportunity has for the sales account. A list of valid values is defined in the lookup MOO_SETID_STRATEGIC_VALUE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
TargetPartyId	Long	False		The unique identifier of the sales account that owns the opportunity.
TargetPartyName	String	False		The name of the sales account that owns the opportunity.
UpdateFlag	Boolean	False		Indicates whether the opportunity can be updated.
UpsideAmount	Decimal	False		The maximum amount of revenue for the opportunity.
WinProb	Long	False		The estimated probability of winning the opportunity.
ClosePeriod	String	False		The names of the filter on which opportunities can be filtered based on effective date range.
LookupCategory	String	False		The status category of the opportunity status

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.
PartyId	String	Input specifying the Party Id.
PartyIdAttribute	String	Input specifying the Party Id Attribute.
AttributeName	String	Input specifying the Attribute Name.
RollUpId	String	Input specifying the RollUp Id.
SourceObject	String	Input specifying the Source Object.
SourceObjectId	String	Input specifying the Source Object Id.
ContactPartyId	String	Input specifying the Contact Party Id.
EffectiveBeginDate	String	Input specifying the Effective BeginDate.
EffectiveEndDate	String	Input specifying the Effective EndDate.
LeadNumber	String	Input specifying the Lead Number.
OpportunityContactName	String	Input specifying the Opportunity Contact Name.
OptyStatusCode	String	Input specifying the Opty StatusCode.
Partner	String	Input specifying the Partner.
PartnerPartyId	String	Input specifying the Partner Party Id.
Product	String	Input specifying the Product.
ProductGroup	String	Input specifying the Product Group.
ReferenceName	String	Input specifying the Reference Name.
ResourcePartyId	String	Input specifying the Resource Party Id.
TeamMember	String	Input specifying the Team Member.

OpportunityAssessments

The assessments resource is used to view, create, update, and delete the assessment of an opportunity.

Columns


Name	Type	ReadOnly	References	Description
AssessmentId [KEY]	Long	False		AssessmentId
OptyNumber [KEY]	String	False	Opportunities.OptyNumber	OptyNumber
AssessTemplateId	Long	False		AssessTemplateId
AssessedLanguage	String	False		AssessedLanguage
AssessedObjTypeCode	String	False		AssessedObjTypeCode
AssessedObjectId	Long	False		AssessedObjectId
AssessmentScore	Int	False		AssessmentScore
BusinessUnit	Long	False		BusinessUnit
ConflictId	Long	False		ConflictId
CreatedBy	String	True		CreatedBy
LastUpdateDate	Datetime	True		LastUpdateDate
LastUpdatedBy	String	True		LastUpdatedBy
Name	String	False		Name
RatingFeedback	String	True		RatingFeedback
RatingTerm	String	True		RatingTerm
StatusCode	String	False		StatusCode
StatusFuse	String	True		StatusFuse
TemplateName	String	False		TemplateName
TemplateType	String	False		TemplateType
TotalAnswered	Double	False		TotalAnswered
TotalQuestions	Double	False		TotalQuestions
OpportunityLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.
PartyId	String	Input specifying the Party Id.
PartyIdAttribute	String	Input specifying the Party Id Attribute.
AttributeName	String	Input specifying the Attribute Name.
RollUpId	String	Input specifying the RollUp Id.
SourceObject	String	Input specifying the Source Object.
SourceObjectId	String	Input specifying the Source Object Id.
ClosePeriod	String	Input specifying the Close Period.
ContactPartyId	String	Input specifying the Contact Party Id.
EffectiveBeginDate	String	Input specifying the Effective BeginDate.
EffectiveEndDate	String	Input specifying the Effective EndDate.
LeadNumber	String	Input specifying the Lead Number.
LookupCategory	String	Input specifying the Lookup Category.
OpportunityContactName	String	Input specifying the Opportunity Contact Name.
OptyStatusCode	String	Input specifying the Opty StatusCode.
Partner	String	Input specifying the Partner.
PartnerPartyId	String	Input specifying the Partner Party Id.
Product	String	Input specifying the Product.
ProductGroup	String	Input specifying the Product Group.
ReferenceName	String	Input specifying the Reference Name.
ResourcePartyId	String	Input specifying the Resource Party Id.
TeamMember	String	Input specifying the Team Member.
OptyId	String	Input specifying the Opty Id.

OpportunityCampaigns

The opportunity campaigns resource is used to view, create, update, and delete campaigns associated with an opportunity.

Columns


Name	Type	ReadOnly	References	Description
OptyCampaignId [KEY]	Long	False		OptyCampaignId
OptyNumber [KEY]	String	False	Opportunities.OptyNumber	OptyNumber
CampaignEndDate	Datetime	True		CampaignEndDate
CampaignId	Long	False		CampaignId
CampaignName	String	True		CampaignName
CampaignNumber	String	False		CampaignNumber
CampaignStartDate	Datetime	True		CampaignStartDate
CampaignStatus	String	True		CampaignStatus
CampaignType	String	True		CampaignType
CreatedBy	String	True		CreatedBy
CreationDate	Datetime	True		CreationDate
LastUpdateDate	Datetime	True		LastUpdateDate
LastUpdatedBy	String	True		LastUpdatedBy
OptyCampaignNumber	String	False		OptyCampaignNumber
OptyId	Long	False		OptyId
PrimaryFlag	Bool	False		PrimaryFlag
RevenuePercentage	Double	False		RevenuePercentage
OpportunityLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.
PartyIdAttribute	String	Input specifying the Party Id Attribute.
AttributeName	String	Input specifying the Attribute Name.
RollUpId	String	Input specifying the RollUp Id.
SourceObject	String	Input specifying the Source Object.
SourceObjectId	String	Input specifying the Source Object Id.
ClosePeriod	String	Input specifying the Close Period.
ContactPartyId	String	Input specifying the Contact Party Id.
EffectiveBeginDate	String	Input specifying the Effective BeginDate.
LeadNumber	String	Input specifying the Lead Number.
LookupCategory	String	Input specifying the Lookup Category.
OpportunityContactName	String	Input specifying the Opportunity Contact Name.
OptyStatusCode	String	Input specifying the Opty StatusCode.
Partner	String	Input specifying the Partner.
PartnerPartyId	String	Input specifying the Partner Party Id.
Product	String	Input specifying the Product.
ProductGroup	String	Input specifying the Product Group.
ReferenceName	String	Input specifying the Reference Name.
ResourcePartyId	String	Input specifying the Resource Party Id.
TeamMember	String	Input specifying the Team Member.

OpportunityCompetitors

The opportunity competitor resource is used to view, create, and update the competitors for an opportunity. The opportunity competitors is used to store information about the competitors associated with the opportunity.

Columns


Name	Type	ReadOnly	References	Description
OptyCompetitorId [KEY]	Long	False		This is the primary key of the opportunity competitors table.
OptyNumber [KEY]	String	False	Opportunities.OptyNumber
CmptPartyId	Long	False		The unique identifier for the competitor party.
Comments	String	False		The user-provided comments about the opportunity's competitor.
CreatedBy	String	False		The user who created the record.
CreationDate	Datetime	False		The date and time when the contact record was created.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the record.
LastUpdateLogin	String	False		The session login associated to the user who last updated the record.
Name	String	False		The name of the opportunity.
OptyId	Long	False		The unique identifier for the opportunity.
PartyName	String	False		The name of the party.
PrimaryFlg	String	False		Indicates if the competitor is the primary competitor for the opportunity. If True, then the competitor is the primary competitor. The default value is False.
ThreatLevelCode	String	False		The level of threat or risk from the competitor. The list of valid values are Low, Medium and High. A list of accepted values are defined in the lookup Competitor Threat Level. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
OpportunityLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.
PartyId	String	Input specifying the Party Id.
PartyIdAttribute	String	Input specifying the Party Id Attribute.
AttributeName	String	Input specifying the Attribute Name.
RollUpId	String	Input specifying the RollUp Id.
SourceObject	String	Input specifying the Source Object.
SourceObjectId	String	Input specifying the Source Object Id.
ClosePeriod	String	Input specifying the Close Period.
ContactPartyId	String	Input specifying the Contact Party Id.
EffectiveBeginDate	String	Input specifying the Effective BeginDate.
EffectiveEndDate	String	Input specifying the Effective EndDate.
LeadNumber	String	Input specifying the Lead Number.
LookupCategory	String	Input specifying the Lookup Category.
OpportunityContactName	String	Input specifying the Opportunity Contact Name.
OptyStatusCode	String	Input specifying the Opty StatusCode.
Partner	String	Input specifying the Partner.
PartnerPartyId	String	Input specifying the Partner Party Id.
Product	String	Input specifying the Product.
ProductGroup	String	Input specifying the Product Group.
ReferenceName	String	Input specifying the Reference Name.
ResourcePartyId	String	Input specifying the Resource Party Id.
TeamMember	String	Input specifying the Team Member.

OpportunityContacts

The opportunity contact resource is used to view, create, and update the contacts of an opportunity.The contact associated with the opportunity. You can specify a contact's role, affinity, and influence level on an opportunity. A single contact can be marked as primary.

Columns


Name	Type	ReadOnly	References	Description
OptyConId [KEY]	Long	False		This is the primary key of the opportunity contacts table.
OptyNumber [KEY]	String	False	Opportunities.OptyNumber
AffinityLvlCd	String	False		The affinity of the opportunity 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.
Comments	String	False		The textual comments about the contact on the current opportunity.
ContactedFlg	String	False		Indicates if the contact for this opportunity has been contacted. If the value is True, then the contact was contacted. The default value is False.
ContactPointId	Long	False		The unique identifier of the contact's contact point.
CreatedBy	String	False		The user who created the opportunity contact record.
CreationDate	Datetime	False		The date and time when the contact record was created.
DoNotContactFlag	Boolean	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.
EmailAddress	String	False		The e-mail address of the contact.
FormattedAddress	String	False		The formatted address of the contact.
FormattedPhoneNumber	String	False		The formatted phone number of the contact.
InfluenceLvlCd	String	False		The influence of the opportunity contact has on the deploying organization. A list of accepted values are defined in the lookup HZ_SLS_CNTCT_INFLUENCE_LVL_CD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
JobTitle	String	False		The free form text for job title of the opportunity contact.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the record.
LastUpdateLogin	String	False		The session login associated to the user who last updated the record.
OptyId	Long	False		The unique identifier of the opportunity.
OrganizationPartyId	Long	False		The unique identifier of the contact's organization.
OrganizationPartyName	String	False		The name of the contact's organization.
OrgContactId	Long	False		The unique identifier of the organization contact for the opportunity.
PartyName	String	False		The name of the contact for the opportunity.
PartyUniqueName	String	False		The unique contact name displayed on party related screens. The default value for Contacts is the concatenation of attributes ContactName and UniqueNameSuffix. The default value for Organizations is the concatenation of the unique name alias and UniqueNameSuffix.
PERPartyId	Long	False		The unique identifier of a valid employee resource who owns and manages the opportunity.
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.
PrimaryFlg	String	False		Indicates if the contact is the primary contact for the opportunity. If the value is True, then the contact is the primary contact fo the opportunity. The default value is False.
RelationshipCode	String	False		The code for a forward or a backward relationship. A list of accepted relationship values is defined in the lookup PARTY_RELATIONS_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Relationship Lookups.
RelationshipId	Long	False		The identifier of the relationship for the opportunity contact.
RoleCd	String	False		The roles played by a contact in the opportunity. 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.
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.
SalesInfluenceLevelCode	String	False		The contact's level of influence in the buying process for the current opportunity.
OpportunityLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.
PartyId	String	Input specifying the Party Id.
PartyIdAttribute	String	Input specifying the Party Id Attribute.
AttributeName	String	Input specifying the Attribute Name.
RollUpId	String	Input specifying the RollUp Id.
SourceObject	String	Input specifying the Source Object.
SourceObjectId	String	Input specifying the Source Object Id.
ClosePeriod	String	Input specifying the Close Period.
ContactPartyId	String	Input specifying the Contact Party Id.
EffectiveBeginDate	String	Input specifying the Effective BeginDate.
EffectiveEndDate	String	Input specifying the Effective EndDate.
LeadNumber	String	Input specifying the Lead Number.
LookupCategory	String	Input specifying the Lookup Category.
OpportunityContactName	String	Input specifying the Opportunity Contact Name.
OptyStatusCode	String	Input specifying the Opty StatusCode.
Partner	String	Input specifying the Partner.
PartnerPartyId	String	Input specifying the Partner Party Id.
Product	String	Input specifying the Product.
ProductGroup	String	Input specifying the Product Group.
ReferenceName	String	Input specifying the Reference Name.
ResourcePartyId	String	Input specifying the Resource Party Id.
TeamMember	String	Input specifying the Team Member.
Name	String	Input specifying the Name.

OpportunityLeads

The opportunity lead resource is used to view, create, and update the lead that resulted in an opportunity.

Columns


Name	Type	ReadOnly	References	Description
OptyLeadId [KEY]	Long	False		This is the primary key of the opportunity leads table.
OptyNumber [KEY]	String	False	Opportunities.OptyNumber
CreatedBy	String	False		The user who created the record.
CreationDate	Datetime	False		The date and time when the record was created.
DealEstimatedCloseDate	Date	False		The date when the deal registration for the opportunity is estimated to be closed.
DealExpirationDate	Date	False		The date when the lead registration will expire.
DealPartProgramId	Long	False		The unique identifier of the partner program associated with the lead registration.
DealType	String	False		The deal or lead registration type for the opportunity.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the record.
LastUpdateLogin	String	False		The session login associated to the user who last updated the record.
LeadNumber	String	False		The unique identification number for the lead.
OptyId	Long	False		The unique identifier of the opportunity.
PartnerTypeCd	String	False		The type of the partner for the lead registration.
PrDealPartOrgPartyId	Long	False		The unique identifier for the partner on the lead registration.
PrDealPartResourcePartyId	Long	False		The unique identifier for the primary partner resource on the lead registration.
RegistrationNumber	String	False		The unique registration number of the lead for the opportunity.
UserLastUpdateDate	Datetime	False		The date and time when the opportunity lead was last updated from mobile.
OpportunityLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.
LeadNumber	String	False		The alternate key identifier of the lead.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.
PartyId	String	Input specifying the Party Id.
PartyIdAttribute	String	Input specifying the Party Id Attribute.
AttributeName	String	Input specifying the Attribute Name.
RollUpId	String	Input specifying the RollUp Id.
SourceObject	String	Input specifying the Source Object.
SourceObjectId	String	Input specifying the Source Object Id.
ClosePeriod	String	Input specifying the Close Period.
ContactPartyId	String	Input specifying the Contact Party Id.
EffectiveBeginDate	String	Input specifying the Effective BeginDate.
EffectiveEndDate	String	Input specifying the Effective EndDate.
LookupCategory	String	Input specifying the Lookup Category.
OpportunityContactName	String	Input specifying the Opportunity Contact Name.
OptyStatusCode	String	Input specifying the Opty StatusCode.
Partner	String	Input specifying the Partner.
PartnerPartyId	String	Input specifying the Partner Party Id.
Product	String	Input specifying the Product.
ProductGroup	String	Input specifying the Product Group.
ReferenceName	String	Input specifying the Reference Name.
ResourcePartyId	String	Input specifying the Resource Party Id.
TeamMember	String	Input specifying the Team Member.
Name	String	Input specifying the Name.

OpportunityNotes

The note resource is used to capture comments, information, or instructions for an opportunity.

Columns


Name	Type	ReadOnly	References	Description
NoteId [KEY]	Long	False		This is the primary key of the notes table.
OptyNumber [KEY]	String	False	Opportunities.OptyNumber
ContactRelationshipId	Long	False		The identifier of the relationship populated when the note is associated with a contact.
CorpCurrencyCode	String	False		The corporate currency code of the note associated with the contact. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
CreatedBy	String	False		The user who created the note record.
CreationDate	Datetime	False		The date and time when the note record was created.
CreatorPartyId	Long	False		The unique party identifier for the note creator.
CurcyConvRateType	String	False		The currency conversion rate type associated with the note. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
CurrencyCode	String	False		The currency code associated with the note. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
LastUpdateDate	Datetime	False		The date when the note data was last updated.
NoteTxt	String	False		The actual note text.
NoteTypeCode	String	False		This code for categorization of the note type.
PartyId	Long	False		The unique Identifier of the party to which the note is associated.
PartyName	String	False		The name of party associated with the opportunity.
SourceObjectCode	String	False		The code of the source object Opportunities, as defined in OBJECTS Metadata.
SourceObjectId	String	False		The primary key identifier of the source object Opportunities, as defined in OBJECTS Metadata.
VisibilityCode	String	False		The visibility level of the note.
OpportunityLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.
PartyId	Long	False		The unique Identifier of the party to which the note is associated.
SourceObjectId	String	False		The unique identifier of the source object as defined in OBJECTS Metadata, such as activities, opportunities, and so on.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.
PartyIdAttribute	String	Input specifying the Party Id Attribute.
AttributeName	String	Input specifying the Attribute Name.
RollUpId	String	Input specifying the RollUp Id.
SourceObject	String	Input specifying the Source Object.
ClosePeriod	String	Input specifying the Close Period.
ContactPartyId	String	Input specifying the Contact Party Id.
EffectiveBeginDate	String	Input specifying the Effective BeginDate.
EffectiveEndDate	String	Input specifying the Effective EndDate.
LeadNumber	String	Input specifying the Lead Number.
LookupCategory	String	Input specifying the Lookup Category.
OpportunityContactName	String	Input specifying the Opportunity Contact Name.
OptyStatusCode	String	Input specifying the Opty StatusCode.
Partner	String	Input specifying the Partner.
PartnerPartyId	String	Input specifying the Partner Party Id.
Product	String	Input specifying the Product.
ProductGroup	String	Input specifying the Product Group.
ReferenceName	String	Input specifying the Reference Name.
ResourcePartyId	String	Input specifying the Resource Party Id.
TeamMember	String	Input specifying the Team Member.
Name	String	Input specifying the Name.
OptyId	String	Input specifying the Opty Id.

OpportunityPartners

The opportunity partner resource is used to view, create, and update the partners associated with this opportunity.The opportunity partner is used to store information about partners who are contributing to the selling effort of the current opportunity.

Columns


Name	Type	ReadOnly	References	Description
RevnPartOrgPartyId [KEY]	Long	False		This is the primary key of the opportunity partners table.
OptyNumber [KEY]	String	False	Opportunities.OptyNumber
CreatedBy	String	False		The user who created the record.
CreationDate	Datetime	False		The date and time when the contact record was created.
DealEstCloseDate	Datetime	False		The date when the deal registration is estimated to close.
DealExpirationDate	Datetime	False		The date when the deal registration will expire.
DealType	String	False		The type of deal registration.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the record.
LastUpdateLogin	String	False		The session login associated to the user who last updated the record.
OptyId	Long	False		The unique identifier of the opportunity.
PartOrgEmailAddress	String	False		The email address of the primary partner organization for this revenue.
PartOrgFormattedPhoneNumber	String	False		The phone number of the primary partner organization for this revenue.
PartOrgPartyId	Long	False		The unique identifier of the partner organization associated with the revenue.
PartProgramId	Long	False		The unique identifier of the partner program associated with the revenue.
PartTypeCd	String	False		The type of the party associated with the summary or primary revenue of the opportunity.
PartyId	Long	False		The unique identifier of the partner party is associated with the opportunity.
PartyName	String	False		The name of the partner associated with the opportunity.
PartyName1	String	False		The name of the primary partner resource associated with the opportunity.
PreferredContactEmail	String	False		The e-mail address of the partner's primary contact.
PreferredContactName	String	False		The name of the partner's primary contact.
PreferredContactPhone	String	False		The phone number of the partner's primary contact.
PrPartResourcePartyId	Long	False		The unique identifier of the primary partner resource.
RegistrationNumber	String	False		The registration number of the deal registration.
RegistrationStatus	String	False		The registration status of the partner who create the opportunity or deal.
RevnId	Long	False		The unique identifier of the summary or primary revenue for the opportunity.
RevnPartnerNumber	String	False		The unique number of the associated between the opportunity partner and a revenue line.
OpportunityLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.
PartyIdAttribute	String	Input specifying the Party Id Attribute.
AttributeName	String	Input specifying the Attribute Name.
RollUpId	String	Input specifying the RollUp Id.
SourceObject	String	Input specifying the Source Object.
SourceObjectId	String	Input specifying the Source Object Id.
ClosePeriod	String	Input specifying the Close Period.
ContactPartyId	String	Input specifying the Contact Party Id.
EffectiveBeginDate	String	Input specifying the Effective BeginDate.
EffectiveEndDate	String	Input specifying the Effective EndDate.
LeadNumber	String	Input specifying the Lead Number.
LookupCategory	String	Input specifying the Lookup Category.
OpportunityContactName	String	Input specifying the Opportunity Contact Name.
OptyStatusCode	String	Input specifying the Opty StatusCode.
Partner	String	Input specifying the Partner.
PartnerPartyId	String	Input specifying the Partner Party Id.
Product	String	Input specifying the Product.
ProductGroup	String	Input specifying the Product Group.
ReferenceName	String	Input specifying the Reference Name.
ResourcePartyId	String	Input specifying the Resource Party Id.
TeamMember	String	Input specifying the Team Member.
Name	String	Input specifying the Name.

OpportunityRevenueItems

The revenue items resource is used to view, create, and update revenue items of an opportunity. The revenue items associated with opportunities are products, services, or other items a customer might be interested in purchasing. You add revenue items by selecting a product group or product to associate with an opportunity.

Columns


Name	Type	ReadOnly	References	Description
RevnId [KEY]	Long	False		This is the primary key of the revenue items table.
OptyNumber [KEY]	String	False	Opportunities.OptyNumber
ActualCloseDate	Date	False		The date when the revenue line was closed.
BUOrgId	Long	False		The unique identifier of the Business Unit that owns the opportunity.
CloseReasonCode	String	False		The reason for winning or losing the revenue.
Comments	String	False		The user-provided comments for the revenue line.
CommitFlag	Boolean	False		Indicates if the revenue line should be used for forecasting. If the value is true, then the revenue line should be used for forecasting. The default value is False.
ConversionRate	Double	False		The currency conversion rate for converting the revenue amount to opportunity summary currency. The rate is used if the revenue line is different from that of the opportunity.
ConversionRateType	String	False		The currency conversion rate type for converting the revenue amount to opportunity summary currency. The rate type is used if the revenue line is different from that of the opportunity. For example, the rate type can be spot, user-defined, or corporate.
CostAmount	Decimal	False		The cost amount for the opportunity.
CreatedBy	String	False		The user who created the child revenue record.
CreationDate	Datetime	False		The date when the record was created.
CreditRcptPartOrgPartyId	Long	False		Credit Recipient Partner Organization Party.
CrmConversionRate	Double	False		The currency conversion rate for converting the revenue amount to CRM common currency for the Revenue Forecast Metrics. The rate is used if the revenue line is different from that of the opportunity.
CrmConversionRateType	String	False		The currency conversion rate type for converting the revenue amount to CRM common currency for Revenue Forecast Metrics. The rate type is used if the revenue line is different from that of the opportunity. For example, the rate type can be spot, user-defined, or corporate.
CrmCurcyCode	String	False		The common CRM currency code.
CustomerAccountId	Long	False		The unique identifier of the customer account that owns the opportunity.
Description	String	False		The user-provided description of the product associated with the revenue.
Discount	Decimal	False		The discount percent.
DownsideAmount	Decimal	False		The minimum amount of revenue for the opportunity.
EffectiveDate	Date	False		The date when the child revenue closes. The default value is the opportunity's close date.
ExpectAmount	Decimal	False		The maximum amount of revenue for the opportunity.
ExpectDlvryDate	Date	False		The expected delivery date for the product in the opportunity. This used only for opportunities that include products.
ForecastOverrideCode	String	False		The code that indicates if the revenue forecast should be overridden. The valid values are ALWAYS, NEVER, and CRITERIA.
InventoryItemId	Long	False		The unique identifier of the product in the inventory.
InventoryOrgId	Long	False		The unique identifier of the organization in the inventory.
ItemNumber	String	False		The unique number of the product that is associated with the revenue.
ItemNumberInternal	String	False		The unique internal number of the product that is associated with the revenue.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the record.
LastUpdateLogin	String	False		The login of the user who last updated the record.
MarginAmount	Decimal	False		The margin amount for the opportunity.
Name1	String	False		The name of the territory.
NqSplitAllocTypeCode	String	False		The code indicating the non-quota allocation split type. The valid values are Adhoc amount and Proportional to Revenue.
OptyId	Long	False		The unique identified of the opportunity.
OptyLeadId	Long	False		Identifier for lead associated with opportunity.
OrganizationId	Long	False		The unique identifier of the organization to which the product belongs.
OwnerDealExpirationDate	Date	False		The date when the owner deal expires.
OwnerDealProtectedDate	Date	False		The date when the owner deal starts.
OwnerLockAsgnFlag	Boolean	False		Indicates if the revenue owner assignment should be locked. If the value is Y, then the owner assignment for the child revenue should be locked.
ParentRevnId	Long	False		The Parent revenue line id. Used for Lineset functionality.
PartEngagementTypeCd	String	False		Partner Engagement Type.
PartOrgPartyId	Long	False		The unique identifier of the primary revenue partner party.
PartOrgPartyName	String	False		The name of the primary partner associated with the child revenue.
PrCmptPartyId	Long	False		The unique identifier of the primary competitor of this child revenue.
PrimaryFlag	Boolean	False		Indicates if the revenue is the primary revenue. If the value is true, then the revenue is the primary revenue among all the child revenues. The default value is False.
ProdGroupId	Long	False		The unique identifier of the product group.
ProdGroupName	String	False		The name of the product group associated with the revenue.
ProductType	String	False		The type of product on the revenue line, such as item or product group.
PrPartOrgPartyId	Long	False		Primary Revenue Partner Organization Party.
PrTerritoryVersionId	Long	False		The unique identifier of the primary territory for this revenue item.
Quantity	Double	False		The quantity of product for this opportunity.
RecurDownsideAmount	Decimal	False		The minimum revenue amount from the recurrence.
RecurEndDate	Date	False		The date when the child revenue recurrence ends.
RecurFrequencyCode	String	False		The code that indicates the frequency of recurrence for the child revenue.
RecurNumberPeriods	Long	False		The number of time the child revenue should recur.
RecurParentRevnId	Long	False		The unique identifier for the parent revenue of the recurring revenue lines.
RecurPeriodOrEndDateCode	String	False		Indicates if a date or the number of recurrences are specified to end the recurrences.
RecurQuantity	Double	False		The quantity of the child revenue recurrence.
RecurRevnAmount	Decimal	False		The amount of revenue from the child revenue recurrence.
RecurStartDate	Date	False		The date when the recurrence starts.
RecurTypeCode	String	False		Indicates if the line is a standard revenue line or recurring revenue line.
RecurUnitPrice	Decimal	False		The price of each child revenue recurrence.
RecurUpsideAmount	Decimal	False		The maximum revenue amount from the recurrence.
ResourcePartyId	Long	False		The unique identifier of the revenue owner.
RevnAmount	Decimal	False		The amount of revenue that is earned from this opportunity.
RevnAmountCurcyCode	String	False		The currency code used to calculate the revenue for this opportunity.
RevnCategoryCode	String	False		The revenue category used in Revenue Line Set functionality.
RevnLineTypeCode	String	False		This denotes the type of revenue line like Opportunity Summary Revenue, Standard Revenue and so on.
RevnNumber	String	False		The user-editable unique identifier for the child revenue. The default value is the revenue identifier.
RevnSequenceNumber	Long	False		The Revenue Sequence Number
SalesAccountId	Long	False		Identifier of the opportunity sales account.
SalesChannelCd	String	False		Sales Channel Code.
SalesCreditTypeCode	String	False		The type of the sales credit, such as quota or non-quota.
SplitParentRevnId	Long	False		The unique identifier of the split parent revenue.
SplitPercent	Double	False		The percentage of split revenue.
SplitTypeCode	String	False		The code that indicates if the split is revenue or non-revenue.
StatusCode	String	False		The unique code of the status for the child revenue.
TargetPartyId	Long	False		The unique identifier of the sales account that owns the opportunity.
TypeCode	String	False		The revenue type for the revenue earned from this opportunity.
UnitPrice	Decimal	False		The estimated unit price for the product.
UOMCode	String	False		The unit of measure code for the product.
UpsideAmount	Decimal	False		The maximum amount of revenue for the opportunity.
WinProb	Long	False		The estimated probability of winning the opportunity.
OpportunityLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.
EffectiveEndDate	Datetime	False		The end date for the territory owner.
ResourcePartyId	String	False		The unique identifier of the revenue owner.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.
PartyId	String	Input specifying the Party Id.
PartyIdAttribute	String	Input specifying the Party Id Attribute.
AttributeName	String	Input specifying the Attribute Name.
RollUpId	String	Input specifying the RollUp Id.
SourceObject	String	Input specifying the Source Object.
SourceObjectId	String	Input specifying the Source Object Id.
ClosePeriod	String	Input specifying the Close Period.
ContactPartyId	String	Input specifying the Contact Party Id.
EffectiveBeginDate	String	Input specifying the Effective BeginDate.
LeadNumber	String	Input specifying the Lead Number.
LookupCategory	String	Input specifying the Lookup Category.
OpportunityContactName	String	Input specifying the Opportunity Contact Name.
OptyStatusCode	String	Input specifying the Opty StatusCode.
Partner	String	Input specifying the Partner.
PartnerPartyId	String	Input specifying the Partner Party Id.
Product	String	Input specifying the Product.
ProductGroup	String	Input specifying the Product Group.
ReferenceName	String	Input specifying the Reference Name.
TeamMember	String	Input specifying the Team Member.
Name	String	Input specifying the Name.

OpportunityRevenueItemsChildSplitRevenue

The child split revenue resource is used to view, create, update, and delete a split revenue. The revenue or nonrevenue credit is allocated to the resource which has contributed to the selling effort for an opportunity revenue line.

Columns


Name	Type	ReadOnly	References	Description
RevnId [KEY]	String	False		RevnId
ChildRevenueRevnId [KEY]	String	False	OpportunityRevenueItems.RevnId	RevnId of ChildRevenue
OptyNumber [KEY]	String	False	Opportunities.OptyNumber	OptyNumber
CreatedBy	String	False		Who column: indicates the user who created the row.
CreationDate	Datetime	False		Who column: indicates the date and time of the creation of the row.
ExtnPartyName	String	False		ExtnPartyName
ExtnPartyNameLOVSwitcher	String	False		ExtnPartyNameLOVSwitcher
ForecastTerritoryName	String	False		ForecastTerritoryName
LastUpdateDate	Datetime	False		Who column: indicates the date and time of the last update of the row.
LastUpdateLogin	String	False		Who column: indicates the session login associated to the user who last updated the row.
LastUpdatedBy	String	False		Who column: indicates the user who last updated the row.
Name	String	False		Name of the resource organization of the credit recipient.
OwnerLockAsgnFlag	Bool	False		Indicates if the credit recipients of the revenue line should be locked from re-assignment by the system.
OwnerPartyNumber	String	False		OwnerPartyNumber
PrTerritoryUpdatedByPartyName	String	False		Name of the user who last updated the forecast territory.
PrTerritoryVersionId	Long	False		Forecast territory version identifier.
PrTerritoryVersionIdForManual	String	False		Indicates the version ID of a territory that is to be manually assigned to the revenue record.
ResourcePartyId	Long	False		Resource identifier of the credit recipient.
RevnAmount	Decimal	False		Revenue amount.
RevnAmountCurcyCode	String	False		The currency the amount on this revenue line is based on.
RevnNumber	String	False		Unique number for the revenue line. Initially defaulted from the revenue identifier.
SalesCreditTypeCode	String	False		Indicates the type of sales credit - revenue or nonrevenue.
SplitPercent	Double	False		Split percent.
TerrOwnerPartyName	String	False		TerrOwnerPartyName
OpportunityLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.
PartyId	String	Input specifying the Party Id.
PartyIdAttribute	String	Input specifying the Party Id Attribute.
AttributeName	String	Input specifying the Attribute Name.
RollUpId	String	Input specifying the RollUp Id.
SourceObject	String	Input specifying the Source Object.
SourceObjectId	String	Input specifying the Source Object Id.
ClosePeriod	String	Input specifying the Close Period.
ContactPartyId	String	Input specifying the Contact Party Id.
EffectiveBeginDate	String	Input specifying the Effective BeginDate.
EffectiveEndDate	String	Input specifying the Effective EndDate.
LeadNumber	String	Input specifying the Lead Number.
LookupCategory	String	Input specifying the Lookup Category.
OpportunityContactName	String	Input specifying the Opportunity Contact Name.
OptyStatusCode	String	Input specifying the Opty StatusCode.
Partner	String	Input specifying the Partner.
PartnerPartyId	String	Input specifying the Partner Party Id.
Product	String	Input specifying the Product.
ProductGroup	String	Input specifying the Product Group.
ReferenceName	String	Input specifying the Reference Name.
TeamMember	String	Input specifying the Team Member.
OptyId	String	Input specifying the Opty Id.

OpportunityRevenueItemsRecurringRevenues

The recurring revenues resource is used to view, create, update, and delete a recurring revenue. The revenues that span over a period of time sourced from the same product on an opportunity.

Columns


Name	Type	ReadOnly	References	Description
RevnId [KEY]	String	True		RevnId
ChildRevenueRevnId [KEY]	String	False	OpportunityRevenueItems.RevnId	RevnId of ChildRevenue.
OptyNumber [KEY]	String	False	Opportunities.OptyNumber	OptyNumber
CreatedBy	String	True		Who column: indicates the user who created the row.
CreationDate	Datetime	True		Who column: indicates the date and time of the creation of the row.
EffectiveDate	Date	False		Estimated close date for this revenue - defaulted from opportunity's close date
LastUpdateDate	Datetime	True		Who column: indicates the date and time of the last update of the row.
LastUpdateLogin	String	True		Who column: indicates the session login associated to the user who last updated the row.
LastUpdatedBy	String	True		Who column: indicates the user who last updated the row.
NonRecurringRevenue	Decimal	False		Non-Recurring Revenue Amount (Net)
Quantity	Double	False		Product quantity.
RecurParentRevnId	Long	False		Indicates the parent revenue id for the recurrence
RecurRevenue	Decimal	False		The recurring revenue amount on the revenue line
RevnAmount	Decimal	False		Revenue amount.
RevnAmtCurcyCode	String	True		RevnAmtCurcyCode
RevnNumber	String	False		User editable revenue number. Defaulted from REVN_ID. Needs to be unique, cannot be NULL.
UsageRevenue	Decimal	False		The usage revenue amount on the revenue line
OpportunityLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.
PartyId	String	Input specifying the Party Id.
PartyIdAttribute	String	Input specifying the Party Id Attribute.
AttributeName	String	Input specifying the Attribute Name.
RollUpId	String	Input specifying the RollUp Id.
SourceObject	String	Input specifying the Source Object.
SourceObjectId	String	Input specifying the Source Object Id.
ClosePeriod	String	Input specifying the Close Period.
ContactPartyId	String	Input specifying the Contact Party Id.
EffectiveBeginDate	String	Input specifying the Effective BeginDate.
EffectiveEndDate	String	Input specifying the Effective EndDate.
LeadNumber	String	Input specifying the Lead Number.
LookupCategory	String	Input specifying the Lookup Category.
OpportunityContactName	String	Input specifying the Opportunity Contact Name.
OptyStatusCode	String	Input specifying the Opty StatusCode.
Partner	String	Input specifying the Partner.
PartnerPartyId	String	Input specifying the Partner Party Id.
Product	String	Input specifying the Product.
ProductGroup	String	Input specifying the Product Group.
ReferenceName	String	Input specifying the Reference Name.
TeamMember	String	Input specifying the Team Member.
OptyId	String	Input specifying the Opty Id.
ResourcePartyId	String	Input specifying the ResourcePartyId.

OpportunityRevenueTerritories

The opportunity revenue territories resource is used to view, create, and update the revenue territories of an opportunity. The territories assigned to an opportunity revenue line. The territories provide the rules for automatically assigning salespeople and other resources to customers, partners, leads, and opportunity line items.

Columns


Name	Type	ReadOnly	References	Description
RevnTerrId [KEY]	Long	False		This is the primary key of the revenue territories table.
RevnId [KEY]	Long	False
OptyNumber [KEY]	String	False
AssignmentType	String	False		The type of assignment used to assign the territory to the opportunity.
CreatedBy	String	False		The user who created the revenue territory record.
CreationDate	Datetime	False		The date when the record was created.
EffectiveEndDate	Date	False		The date when the resource organization assignment to the territory ends.
EffectiveStartDate	Date	False		The date when the resource organization for the territory was assigned to the revenue line.
ForecastParticipationCode	String	False		The code to identify the forecast type that the territory participates in. For example, Revenue, Nonrevenue, Revenue and Nonrevenue, or Nonforecasting.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the record.
LastUpdateLogin	String	False		The login of the user who last updated the record.
Name	String	False		The name of the territory that the opportunity belongs to.
Name1	String	False		The name of the organization that the territory resource belongs to.
PartyId	Long	False		The unique identifier of the resource who owns the territory.
PartyName	String	False		The name of the territory owner for the opportunity.
RoleId	Long	False		The unique identifier of the resource's role.
RoleName	String	False		The name of the resource's role.
TerritoryId	Long	False		Territory identifier.
TerritoryVersionId	Long	False		Territory version identifier.
TypeCode	String	False		The type of territory assigned to the opportunity.
OpportunityLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.
PartyId	Long	False		The unique identifier of the resource who owns the territory.
EffectiveEndDate	Datetime	False		The date when the resource organization assignment to the territory ends.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.
PartyIdAttribute	String	Input specifying the Party Id Attribute.
AttributeName	String	Input specifying the Attribute Name.
RollUpId	String	Input specifying the RollUp Id.
SourceObject	String	Input specifying the Source Object.
SourceObjectId	String	Input specifying the Source Object Id.
ClosePeriod	String	Input specifying the Close Period.
ContactPartyId	String	Input specifying the Contact Party Id.
EffectiveBeginDate	String	Input specifying the Effective BeginDate.
LeadNumber	String	Input specifying the Lead Number.
LookupCategory	String	Input specifying the Lookup Category.
OpportunityContactName	String	Input specifying the Opportunity Contact Name.
OptyStatusCode	String	Input specifying the Opty StatusCode.
Partner	String	Input specifying the Partner.
PartnerPartyId	String	Input specifying the Partner Party Id.
Product	String	Input specifying the Product.
ProductGroup	String	Input specifying the Product Group.
ReferenceName	String	Input specifying the Reference Name.
ResourcePartyId	String	Input specifying the Resource Party Id.
TeamMember	String	Input specifying the Team Member.
OptyId	String	Input specifying the Opty Id.

OpportunitySources

The opportunity source resource is used to view, create, and update the source of an opportunity.The opportunity source is used to capture the marketing or sales campaign that resulted in this opportunity.

Columns


Name	Type	ReadOnly	References	Description
OptySrcId [KEY]	Long	False		This is the primary key of the opportunity sources table.
OptyNumber	String	False
CreatedBy	String	False		The user who created the record.
CreationDate	Datetime	False		The date and time when the record was created.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the record.
LastUpdateLogin	String	False		The session login associated to the user who last updated the record.
OptyId	Long	False		The unique Identifier of the opportunity.
SrcNumber	String	False		A unique number indicating the source of the marketing event for the opportunity, such as campaign, new product line, a marketing seminar, and so on.
UserLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated from mobile.
OpportunityLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.
PartyId	String	Input specifying the Party Id.
PartyIdAttribute	String	Input specifying the Party Id Attribute.
AttributeName	String	Input specifying the Attribute Name.
RollUpId	String	Input specifying the RollUp Id.
SourceObject	String	Input specifying the Source Object.
SourceObjectId	String	Input specifying the Source Object Id.
ClosePeriod	String	Input specifying the Close Period.
ContactPartyId	String	Input specifying the Contact Party Id.
EffectiveBeginDate	String	Input specifying the Effective BeginDate.
EffectiveEndDate	String	Input specifying the Effective EndDate.
LeadNumber	String	Input specifying the Lead Number.
LookupCategory	String	Input specifying the Lookup Category.
OpportunityContactName	String	Input specifying the Opportunity Contact Name.
OptyStatusCode	String	Input specifying the Opty StatusCode.
Partner	String	Input specifying the Partner.
PartnerPartyId	String	Input specifying the Partner Party Id.
Product	String	Input specifying the Product.
ProductGroup	String	Input specifying the Product Group.
ReferenceName	String	Input specifying the Reference Name.
ResourcePartyId	String	Input specifying the Resource Party Id.
TeamMember	String	Input specifying the Team Member.
Name	String	Input specifying the Name.

OpportunityTeamMembers

The opportunity team members resource is used to view, create, and update the team members associated with an opportunity. The opportunity team member of the deploying organization associated with the opportunity.

Columns


Name	Type	ReadOnly	References	Description
OptyResourceId [KEY]	Long	False		This is the primary key of the opportunity team members table.
OptyNumber [KEY]	String	False	Opportunities.OptyNumber
AccessLevelCode	String	False		The type of access granted to the resource as well as managers of the organizations. A list of accepted values are defined in the lookup ZCA_ACCESS_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
AsgnTerritoryVersionId	Long	False		The unique identifier of the territory version for the resource that got assigned to the opportunity through territory-based assignment.
AssignmentType	String	False		The code indicating how the resource is assigned to the sales account team. A list of accepted values are defined in the lookup ZCA_ASSIGNMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
CreatedBy	String	False		The user who created the opportunity resource record.
CreationDate	Datetime	False		The date and time when the resource record was created.
DealExpirationDate	Date	False		The date on which the deal protection period of an opportunity team member ends. The date is updated for territory members when they are unassigned from a opportunity because of a territory realingment.
DealProtected	String	False		Indicates if the resource is under deal protection. If the value is True, then the resource is under deal protection. The default value is False.
DealProtectedDate	Date	False		The date on which the deal protection period of an opportunity team member starts. The date is updated for territory members when they are unassigned from a opportunity because of a territory realingment.
EmailAddress	String	False		The e-mail address of the opportunity team member.
FormattedPhoneNumber	String	False		The formatted phone number of the opportunity team member.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the record.
LastUpdateLogin	String	False		The session login associated to the user who last updated the record.
LockAssignmentFlag	Boolean	False		Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. When a sales account team member is added manually, this flag is defaulted to `Y'.
MemberFunctionCode	String	False		The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
MgrResourceId	Long	False		The unique identifier of the resource team member's manager.
OptyId	Long	False		The unique Identifier of the opportunity.
OptyResourceNumber	String	False		The label that represents the association between the opportunity and resource.
OwnerFlag	Boolean	False		Indicates if the opportunity team member is the owner of the opportunity. If the value is True, then the opportunity team member is also the owner fo the opportunity. The default value is False.
PartnerOrgId	Long	False		The unique identifier of the partner organization.
PartnerPartyName	String	False		The name of the partner associated with the partner resource.
PartyName	String	False		The name of the opportunity team member.
PersonFirstName	String	False		The first name of the opportunity team member.
PersonLastName	String	False		The last name of the opportunity team member.
ResourceId	Long	False		The unique party identifier for the existing resource record in Oracle Sales.
RoleName	String	False		The role of the opportunity team member in the resource organization.
TerritoryName	String	False		The name of the opportunity team member's territory.
OpportunityLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.
PartyId	String	Input specifying the Party Id.
PartyIdAttribute	String	Input specifying the Party Id Attribute.
AttributeName	String	Input specifying the Attribute Name.
RollUpId	String	Input specifying the RollUp Id.
SourceObject	String	Input specifying the Source Object.
SourceObjectId	String	Input specifying the Source Object Id.
ClosePeriod	String	Input specifying the Close Period.
ContactPartyId	String	Input specifying the Contact Party Id.
EffectiveBeginDate	String	Input specifying the Effective BeginDate.
EffectiveEndDate	String	Input specifying the Effective EndDate.
LeadNumber	String	Input specifying the Lead Number.
LookupCategory	String	Input specifying the Lookup Category.
OpportunityContactName	String	Input specifying the Opportunity Contact Name.
OptyStatusCode	String	Input specifying the Opty StatusCode.
Partner	String	Input specifying the Partner.
PartnerPartyId	String	Input specifying the Partner Party Id.
Product	String	Input specifying the Product.
ProductGroup	String	Input specifying the Product Group.
ReferenceName	String	Input specifying the Reference Name.
ResourcePartyId	String	Input specifying the Resource Party Id.
TeamMember	String	Input specifying the Team Member.
Name	String	Input specifying the Name.

PartnerContacts

Usage information for the operation PartnerContacts.rsd.

Columns


Name	Type	ReadOnly	References	Description
PartyId [KEY]	Long	False
AcademicTitle	String	False
AddrElementAttribute1	String	False
AddrElementAttribute2	String	False
AddrElementAttribute3	String	False
AddrElementAttribute4	String	False
AddrElementAttribute5	String	False
AddressLineFour	String	False
AddressLineOne	String	False
AddressLineThree	String	False
AddressLineTwo	String	False
Building	String	False
CertificationLevel	String	False
CertificationReasonCode	String	False
City	String	False
Comments	String	False
ContactName	String	False
Country	String	False
County	String	False
CreateUserAccountFlag	Bool	False
CreatedBy	String	False
CreationDate	Datetime	False
DateOfBirth	Date	False
DateOfDeath	Date	False
DeceasedFlag	Bool	False
DeclaredEthnicity	String	False
Department	String	False
DepartmentCode	String	False
DoNotCallFlag	Bool	False
DoNotContactFlag	Bool	False
DoNotEmailFlag	Bool	False
DoNotMailFlag	Bool	False
EmailAddress	String	False
FavoriteContactFlag	Bool	False
FirstName	String	False
FloorNumber	String	False
FormattedAddress	String	False
FormattedMobileNumber	String	False
FormattedWorkPhoneNumber	String	False
Gender	String	False
Initials	String	False
JobTitle	String	False
JobTitleCode	String	False
LastName	String	False
LastNamePrefix	String	False
LastUpdateDate	Datetime	False
LastUpdateLogin	String	False
LastUpdatedBy	String	False
Latitude	Double	False
Longitude	Double	False
Mailstop	String	False
ManagerName	String	False
ManagerPartyId	Long	False
ManagerPartyNumber	String	False
MaritalStatus	String	False
MaritalStatusEffectiveDate	Date	False
MiddleName	String	False
MobileAreaCode	String	False
MobileCountryCode	String	False
MobileExtension	String	False
MobileNumber	String	False
NameSuffix	String	False
NamedFlag	Bool	False
PartnerCompanyNumber	String	False
PartnerName	String	False
PartnerPartyId	Long	False
PartyNumber	String	False
PersonPreNameAdjunct	String	False
PlaceOfBirth	String	False
PostalCode	String	False
PostalPlus4Code	String	False
PreferredContactMethod	String	False
PreferredFunctionalCurrency	String	False
PreviousLastName	String	False
PrimaryAddressId	Long	False
PrimaryContactPartyId	Long	False
PrimaryFlag	Bool	False
Province	String	False
RentOrOwnIndicator	String	False
RoleCode	String	False
RoleId	Long	False
RoleName	String	False
SalesAffinityCode	String	False
SalesBuyingRoleCode	String	False
Salutation	String	False
SecondLastName	String	False
SourceSystem	String	False
SourceSystemReferenceValue	String	False
State	String	False
Title	String	False
Type	String	False
Username	String	False
WorkPhoneAreaCode	String	False
WorkPhoneCountryCode	String	False
WorkPhoneExtension	String	False
WorkPhoneNumber	String	False
isSelfRegistration	String	False

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
BindSourceSystem	String	The name of the external source system of the partner contact.
BindSourceSystemReferenceValue	String	The identifier of the partner contact record from the external source system.

PartnerProgramBenefits

Usage information for the operation PartnerProgramBenefits.rsd.

Columns


Name	Type	ReadOnly	References	Description
ProgramBenefitId [KEY]	Long	False
CategoryCode	String	False
CreatedBy	String	False
CreationDate	Datetime	False
DataType	String	False
DeleteFlag	Bool	False
Description	String	False
LastUpdateDate	Datetime	False
LastUpdateLogin	String	False
LastUpdatedBy	String	False
LastUpdatedByName	String	False
Name	String	False
UpdateFlag	Bool	False

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.

PartnerPrograms

Usage information for the operation PartnerPrograms.rsd.

Columns


Name	Type	ReadOnly	References	Description
PartnerProgramId [KEY]	Long	False		Primary Key: Partner Program Id
CountryNames	String	False
CreatedBy	String	False		Who column: indicates the user who created the row.
CreationDate	Datetime	False		Who column: indicates the date and time of the creation of the row.
DeleteFlag	Bool	False		An Attribute to identify if a record is deleteable.
EndDateActive	Date	False		Effective End Date of a program.
LastUpdateDate	Datetime	False		Who column: indicates the date and time of the last update of the row.
LastUpdateLogin	String	False
LastUpdatedBy	String	False		Who column: indicates the user who last updated the row.
OwnerPartyNumber	String	False		Public Unique Identifier of Owner Party on the Partner Programs.
ProgramDescription	String	False		Text describing the program.
ProgramManagerId	Long	False		Unique identifier of the manager for the partner program. This is to identify who is managing this partner program.
ProgramManagerName	String	False		Program Manager Name
ProgramName	String	False		Name of the partner program.
ProgramNumber	String	False		A unique number generated for each program.
ProgramType	String	False		Type of various partner program. Possible values are reseller, go to market.
StartDateActive	Date	False		Effective Start Date of a program.
StatusCode	String	False
UpdateFlag	Bool	False		Attribute to identify if a record is updateable.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.

Partners

Usage information for the operation Partners.rsd.

Columns


Name	Type	ReadOnly	References	Description
OrganizationProfileId [KEY]	Long	False
AccountDirectorId	Long	False
AddrElementAttribute1	String	False
AddrElementAttribute2	String	False
AddrElementAttribute3	String	False
AddrElementAttribute4	String	False
AddrElementAttribute5	String	False
AddressLineFour	String	False
AddressLineOne	String	False
AddressLineThree	String	False
AddressLineTwo	String	False
AnnualRevenue	Double	False
Building	String	False
BusinessScope	String	False
CeoName	String	False
City	String	False
CompanyNumber	String	False
ComplianceReviewedDate	Date	False
ComplianceStatus	String	False
ControlYr	Double	False
CorpCurrencyCode	String	False
Country	String	False
County	String	False
CreatedBy	String	False
CreationDate	Datetime	False
CurrencyCode	String	False
DUNSNumberC	String	False
DbRating	String	False
EligibleForPublicProfile	String	False
EmailAddress	String	False
EmailFormat	String	False
EmployeesTotal	Long	False
FaxNumber	String	False
FloorNumber	String	False
FormattedAddress	String	False
HomeCountry	String	False
IndstClassCategory	String	False
IndstClassCode	String	False
IndustryName	String	False
IsSelfRegisteredPartner	String	False
JgzzFiscalCode	String	False
LastUpdateDate	Datetime	False
LastUpdateLogin	String	False
LastUpdatedBy	String	False
Latitude	Double	False
LineOfBusiness	String	False
Longitude	Double	False
Mailstop	String	False
OpportunitiesWonPriorYear	Long	False
OpportunitiesWonYTD	Long	False
OrganizationName	String	False
OrganizationSize	String	False
OwnerName	String	False
OwnerPartyNumber	String	False
ParentPartnerId	String	False
ParentPartnerName	String	False
ParentPartnerOrigSystem	String	False
ParentPartnerOrigSystemReference	String	False
ParentPartnerPartyId	Long	False
ParentPartnerPartyNumber	String	False
PartnerLevel	String	False
PartnerSummary	String	False
PartyId	Long	False
PartyNumber	String	False
PhoneAreaCode	String	False
PhoneCountryCode	String	False
PhoneExtension	String	False
PhoneLineType	String	False
PhoneNumber	String	False
PostalCode	String	False
PostalPlus4Code	String	False
PreferredContactPersonId	Long	False
PrincipalName	String	False
Province	String	False
PublicStatus	String	False
RunDataSyncFlag	Bool	False
SSROwnerTableName	String	False
SolutionOverview	String	False
SourceSystem	String	False
SourceSystemReferenceValue	String	False
SourceType	String	False
State	String	False
Status	String	False
StockSymbol	String	False
Synergy	String	False
TierId	Long	False
TierName	String	False
URL	String	False
UpdateFlag	Bool	False
WebType	String	False
YearEstablished	Int	False

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
RecordSet	String	The value of the record set.
BindSourceSystem	String	The name of the external source system of the partner contact.
BindSourceSystemReferenceValue	String	The identifier of the partner contact record from the external source system.

ProgramEnrollments

Usage information for the operation ProgramEnrollments.rsd.

Columns


Name	Type	ReadOnly	References	Description
ProgramEnrollmentId [KEY]	Decimal	False		Unique identifier of a partner program enrollment.
ActiveEnrollment	String	False		Staus of enrollment. Possible values are active or inactive.
ApprovalDate	Date	False		Date on which enrollment is approved.
CreatedBy	String	False		Who column: indicates the user who created the row.
CreationDate	Datetime	False		Who column: indicates the date and time of the creation of the row.
EnrollmentNumber	String	False		A unique number generated for each program enrollment.
EnrollmentStatus	String	False		Status of the enrollment. Possible values are draft, pending, approved, rejected, terminated, renewed.
ExpirationDate	Date	False		Date on which enrollment is expiring.
LastUpdateDate	Datetime	False		Who column: indicates the date and time of the last update of the row.
LastUpdateLogin	String	False
LastUpdatedBy	String	False		Who column: indicates the user who last updated the row.
PartnerCompanyNumber	String	False		Public Unique Identifier of Partner company associated to the Program Enrollments.
PartnerName	String	False
PartnerPartyId	Decimal	False		Unique identifier of a partner.
PartnerPartyName	String	False		Partner Name
PartnerProgramId	Decimal	False		Unique identifier of a partner program.
PartnerTierId	Long	False
ProgramAccessable	Bool	False
ProgramDescription	String	False		Text describing the program.
ProgramName	String	False		Name of the partner program.
ProgramNumber	String	False		A unique number generated for each program.
RemainingDays	String	False		Number of days left for expiry of the enrollment.
RenewAllowed	Bool	False
RenewedEnrollment	String	False		Staus of enrollment which is of type renewal. Possible values are new or renewal.
RenewedFromEnrollmentNumber	String	False
RenewedFromId	Decimal	False		Unique identifier of the enrollment from which the renewal enrollment is copied.
StartDate	Date	False		Effective Start Date of a program enrollment.
SubmissionDate	Date	False
SubmitAllowed	Bool	False
TerminateAllowed	Bool	False
TerminationDate	Date	False		Date on which enrollment is terminated.
WithdrawAllowed	Bool	False

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.

Proposals

Usage information for the operation Proposals.rsd.

Columns


Name	Type	ReadOnly	References	Description
TerrProposalId [KEY]	Long	False		Identifier of the proposal.
ActFailureReasonCode	String	False		Failure Code for Proposal Activation
ActivationDateTime	Datetime	False
CreatedBy	String	False
CreationDate	Datetime	False
DeleteFlag	Bool	False		Access Level Indicator For Delete
Description	String	False		Brief Description of the proposal and intended changes
LastUpdateDate	Datetime	False
LastUpdateLogin	String	False
LastUpdatedBy	String	False
Name	String	False		Name of the proposal
Owner	String	False		Display name for the initiator of the proposal.
OwnerId	Long	False		Resource who initiated the proposal, Typically the owner of the territory.
OwnerNumber	String	False
PartitionCode	String	False		This identifies whether or not the proposal is a error correction proposal for territories that were made invalid by dimension/member changes by recording whether the proposal is in the 'Stage' or a 'Production' partition
ProposalNumber	String	False		Unique identification number for this proposal
StatusCode	String	False		Indicates the status of the proposal
UpdateFlag	Bool	False		Access Level Indicator For Update

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.

ResourceUsers

The resource users REST resource is used to view, create, update, and delete a resource user. Note that this REST resource should be used only to work with Oracle CX Sales and B2B Service, and not for any other product family.

Columns


Name	Type	ReadOnly	References	Description
ResourceProfileId [KEY]	Long	True		The profile identifier of the resource.
AddressLine1	String	False		The first line of the address of resource.
AddressLine2	String	False		The second line of the address of resource.
BusinessUnit	String	False		Name of the business unit of worker record of resource.
City	String	False		The name of the city for address of resource.
Country	String	False		The name of the country for address of resource.
County	String	False		Name of the county of the address of resource.
CreateUserAccountFlag	Bool	False		Indicates if a user account can be created for the resource.
CreatedBy	String	True		CreatedBy
CreationDate	Datetime	True		CreationDate
DeleteFlag	Bool	True		DeleteFlag
FaxCountryCode	String	False		The country code of the fax.
FirstName	String	False		The first name of the resource.
FormattedAddress	String	True		Primary Formatted address for the resource.
HRManagerEmailAddress	String	False		Email address of the human resource manager of worker record for resource.
HireDate	Date	False		Start date of the worker record for resource.
IndividualRoleCode	String	False		IndividualRoleCode
IndividualRoleEndDate	Date	False		IndividualRoleEndDate
IndividualRoleStartDate	Date	False		IndividualRoleStartDate
JobCode	String	False		Job code assigned to the resource.
JobTitle	String	True		Title of the job assigned to resource.
LastName	String	False		The last name of the resource.
LastUpdateDate	Datetime	True		The date when the record was last updated.
LastUpdatedBy	String	True		LastUpdatedBy
LegalEntity	String	False		Name of legal entity of the worker record for resource.
MiddleName	String	False		The lmiddle name of the resource.
MobilePhoneCountryCode	String	False		The country code associated with the mobile phone.
PartyName	String	True		A person's name
PersonNumber	String	True		Person number identifier of the worker record for resource.
PersonType	String	False		Person type of the worker record for resource.
PostalCode	String	False		The postal code for the address of resource.
Province	String	False		Name of the province for address of resource.
RawFaxNumber	String	False		The fax number of the resource in raw format.
RawMobilePhoneNumber	String	False		The mobile phone number of the resource.
RawWorkPhoneNumber	String	False		The resource's work phone number in raw format.
ResourceEmail	String	False		The email address of the resource.
ResourceEndDate	Date	False		The date up to which the resource role is active.
ResourceManagerFirstName	String	False		The first name of the reporting manager of resource.
ResourceManagerLastName	String	False		The last name of the reporting manager of resource.
ResourceManagerName	String	False		The name of the manager for the resource.
ResourceManagerPartyId	Long	True		The unique internal identifier for the reporting manager of resource.
ResourceManagerPartyNumber	String	True		The unique public identifier of the reporting manager of resource.
ResourceOrgManagerEmail	String	False		The email address of the reporting manager of resource.
ResourceOrgMemRoleEndDate	Date	False		Indicates the date when the resource organization membership of the resource ends
ResourceOrgMemRoleStartDate	Date	False		ResourceOrgMemRoleStartDate
ResourceOrgRoleCode	String	False		The code that indicates the role of the resource in association with organization membership.
ResourceOrgRoleName	String	True		The role that defines the function of the resource in an organization or hierarchy.
ResourceOrganizationName	String	False		The name of the resource organization associated to the resource.
ResourceOrganizationUsage	String	True		The usage type of the resource organization.
ResourceParentOrganizationName	String	False		The name of the parent organization of resource.
ResourcePartyId	Long	False		The unique party identifier of the person record for resource.
ResourcePartyNumber	String	False		The party number of the person record for resource.
ResourceStartDate	Date	False		Date on which the resource becomes active.
ResourceType	String	False		Describes the resource type.
State	String	False		The state in the resource's address.
TimezoneCode	String	False		The code of time zone for the resource.
Title	String	False		The title for the name of resource.
TopResourceFlag	Bool	False		TopResourceFlag
UpdateFlag	Bool	True		Indicates if the user can update the resource.
UserStatus	String	False		Indicates the the status of the user account for the resource. The supported values are A for active and S for suspended. The status is set to A for new accounts.
Username	String	False		User login account name of resource user.
WorkPhoneCountryCode	String	False		The country code associated with the work phone.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
BindPartyId	String	The unique primary key identifier of the party associated with the resource.

SalesLeadContacts

The sales lead contacts resource is used to capture a contact associated with the sales lead.

Columns


Name	Type	ReadOnly	References	Description
LeadMemberId [KEY]	Long	False		Primary Key for Lead Contact
LeadId [KEY]	String	False	SalesLeads.LeadId	LeadId
AccountName	String	True		AccountName
City	String	True		City associated with the identifying address associated with this lead contact.
ConflictId	Long	False		ConflictId
ContactDoNotCallFlag	Bool	True		Do not call flag set at person level for the sales lead contact.
ContactDoNotContactFlag	Bool	True		Do not contact flag set at person level for the sales lead contact.
ContactDoNotMailFlag	Bool	True		Do not mail flag set at person level for the sales lead contact.
ContactJobTitle	String	False		ContactJobTitle
CreatedBy	String	True		Indicates the user who created this record.
CreationDate	Datetime	True		Indicates the date and time when this record is created.
EmailAddress	String	False		Email address associated with the sales lead contact.
EmailPreference	String	True		Indicates if the lead contact has an email preference of do not email, ok to email, or no value.
FormattedPhoneNumber	String	False		Stores formatted phone number of the lead contact.
JobTitle	String	True		Job title of the sales lead contact.
LastUpdateDate	Datetime	True		System field that indicates the date and time of the last update of the row.
LastUpdateLogin	String	True		Who column: indicates the session login associated to the user who last updated the row.
LastUpdatedBy	String	True		System field that indicates the user who last updated the row.
LeadNumber	String	False		LeadNumber
OrgContactId	Long	True		Organization Contact Identifier of the sales lead contact
PartyId	Long	False		Party identifier of the lead contact.
PartyName	String	True		Party name of the lead contact.
PartyNumber	String	False		Party Number of the sales lead contact
PartyType	String	True		Indicates the type of the party recorded as lead contact. Possible values are person, organization or group.
PartyUsageCode	String	False		Party usage recorded for this lead contact in the customer master.
PersonFirstName	String	True		First name of the lead contact.
PersonLastName	String	True		Last name or surname of this lead contact.
PersonTitle	String	True		Title asscoaited with the lead contact. This is not the same as the job title.
PhonePreference	String	True		Indicates whether the lead contact has a phone preference of do not call, ok to call, or no value.
PostalCode	String	True		Postal code part of the identifying address associated with this lead contact.
PrimaryCustomerId	Long	True		PrimaryCustomerId
PrimaryFlag	Bool	False		Indicates whether this lead contact is primary. Primary lead contact is also the lead owner.
RelationshipId	Long	False		Relationship identifier for this lead contact. This represents the relation of this lead contact with lead customer.
Role	String	False		Role of lead contact in the context of this lead.
State	String	True		State part of the identifying address associated with this lead contact.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
ContactId	String	The unique identifier of the Contact.
SysEffectiveDate	String	SysEffectiveDate.
ResourcePartyIdRest	String	The unique identifier of the Resource.
RestCreationDateLower	String	Finds the leads that are created before the date specified.
RestCreationDateUpper	String	Finds the leads with the specified creation date.
RestRecordSet	String	Finds the leads with the specified record set value.
RestStatusCode	String	Finds the leads with the specified status code.
Name	String	Finds the leads with the specified name.

SalesLeadResources

The sales lead resources data object (resource) is used to capture a resource associated with the sales lead team.

Columns


Name	Type	ReadOnly	References	Description
LeadResourceId [KEY]	Long	False		Identifier of the sales lead resource.
LeadId [KEY]	String	False	SalesLeads.LeadId	LeadId
AccessLevelCode	String	False		Access level for the sale team member on the lead.
ConflictId	Long	False		ConflictId
CreatedBy	String	True		Indicates the user who created this record.
CreationDate	Datetime	True		Indicates the date and time when this record is created.
EmailAddress	String	True		Email address associated with the sales lead team resource.
FormattedPhoneNumber	String	True		Stores formatted phone number of the lead sales team resource.
FunctionalRole	String	False		Indicates the role played by this Sale team resource for the handling of this sales lead.
LastUpdateDate	Datetime	True		System field that indicates the date and time of the last update of the row.
LastUpdateLogin	String	True		LastUpdateLogin
LastUpdatedBy	String	True		System field that indicates the user who last updated the row.
LeadNumber	String	False		LeadNumber
ManagerName	String	True		Manager name of the resource
Name	String	True		Name of this lead resource.
PartyName	String	True		Party name of the lead resource.
PartyNumber	String	False		Party contact number.
PrimaryFlag	Bool	False		Indicates whether the record represents the primay resource on the lead. Primary resource on the lead is the same as the lead owner.
PrimaryPhonePurpose	String	True		Indicates Contact point type that is used for updating underlying contact point TCA data.
ResourceId	Long	False		Resource identifier associated with this lead resource.
ResourceOrgId	Long	True		Resource organization identifier associated with this lead resource.
RoleName	String	True		Name of the role of the lead resource in the context of this sales lead.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
ContactId	String	The unique identifier of the Contact.
SysEffectiveDate	String	SysEffectiveDate.
ResourcePartyIdRest	String	The unique identifier of the Resource.
RestCreationDateLower	String	Finds the leads that are created before the date specified.
RestCreationDateUpper	String	Finds the leads with the specified creation date.
RestRecordSet	String	Finds the leads with the specified record set value.
RestStatusCode	String	Finds the leads with the specified status code.

SalesLeads

The sales lead resource is used to view, create, or modify a lead. A lead is a transaction record created when a party has expressed an interest in a product or service. It represents a selling opportunity.

Columns


Name	Type	ReadOnly	References	Description
LeadId [KEY]	Long	False		Partner Type. Indicates the type of partner stamped on the lead.
AILeadScore	Double	True		AILeadScore
AcceptedDate	Date	True		The date on which lead was accepted by a resource assigned to it.
AcceptedDateTime	Datetime	True		Date and time when the sales lead is accepted by a resource assigned to it.
AccountPartyNumber	String	False		AccountPartyNumber
AddrElementAttribute1	String	False		Additional address element to support flexible address format.
AddrElementAttribute2	String	False		Additional address element to support flexible address format.
AddrElementAttribute3	String	False		Additional address element to support flexible address format.
AddrElementAttribute4	String	False		Additional address element to support flexible address format.
AddrElementAttribute5	String	False		Additional address element to support flexible address format.
AddressLinesPhonetic	String	False		Phonetic or Kana representation of the Kanji address lines (used in Japan).
ApprovalDate	Date	False		The date on which a partner registered lead is approved by internal channel manager.
ApprovalDateTime	Datetime	False		Date and time when the sales lead is approved. This is only applicable to deal registrations.
AssetId	Long	False		Unique identifier for the Asset associated with the Sales Lead.
AssetNumber	String	False		Unique Number for the Asset associated with the Sales Lead.
AssetSerialNumber	String	True		Serial Number for the Asset associated with the Sales Lead.
AssignmentStatusCode	String	False		Includes the current assignment related status for the lead, for example whether the lead is assigned or unassigned.
BudgetAmount	Decimal	False		Budget amount associated with this sales lead.
BudgetCurrencyCode	String	False		Currency code associated with the Budget Amount associated with this sales lead.
BudgetStatus	String	False		Budget status associated with the Budget Amount associated with this sales lead.
Building	String	False		Specific building name or number at a given address.
BusinessUnitId	Long	False		Business Unit Identifier associated with the business unit of the sales lead creator.
CampaignName	String	True		Name of the campaign associated with the sales lead.
ChannelType	String	False		Indicates the channel through which this lead contacted the company.
ClassCode1	String	False		The auxilliary dimension for the Account.
ClassCode2	String	False		The auxilliary dimension for the Account.
ClassCode3	String	False		The auxilliary dimension for the Account.
ClassCode4	String	False		The auxilliary dimension for the Account.
ConflictId	Long	False		ConflictId
ContactDoNotPreference	Bool	False		ContactDoNotPreference
ContactFormattedAddress	String	True		ContactFormattedAddress
ContactPartyNumber	String	False		ContactPartyNumber
ContactTimezoneCd	String	False		Preferred time zone of the contact pursued on the lead.
ConvertedDateTime	Datetime	False		Date and time when the sales lead is converted to an opportunity.
CreatedBy	String	True		Indicates the user who created this record.
CreationDate	Datetime	True		Indicates the date and time when this record is created.
CurrencyCode	String	False		Currency code for the lead.
CustPartyType	String	False		CustPartyType
CustomerId	Long	False		Customer Id. It is a reference to the customer record in the TCA schema.
CustomerNeed	String	False		Indicates what need the lead product serves for the lead customer.
CustomerPartyName	String	False		Name of the customer.
DealAmount	Decimal	False		The total amount attributed to a lead.
DecisionMakerIdentifiedFlag	Bool	False		Indicates if the decision maker at customer site has been identified.
DeleteFlag	Bool	True		This flag controls if the user has access to delete the record
Description	String	False		Description associated with this sales lead.
Distance	Double	True		Distance from the input location.
EligibleForConversionFlag	Bool	False		EligibleForConversionFlag
EnableCreateAccount	String	False		EnableCreateAccount
EnableCreateContact	String	False		EnableCreateContact
EstimatedCloseDate	Date	False		Estimated close date for a deal once registered
ExpirationDate	Date	False		Expiration date associated with this sales lead.
FloorNumber	String	False		Specific floor number at a given address or in a particular building when building number is provided.
FollowupTimestamp	Date	False		Indicates when the sales lead needs to be followed up.
FormattedPhoneNumber1	String	True		FormattedPhoneNumber1
IBAssetId	Long	False		Unique identifier for the IB Asset associated with the Sales Lead.
IBAssetNumber	String	True		Unique number for the IB Asset associated with the Sales Lead.
IBAssetSerialNumber	String	True		Unique serial number for the IB Asset associated with the Sales Lead.
InventoryItemDescription	String	False		The description of the product added to a lead.
JobTitle	String	False		Job title of the primary contact on the sales lead.
LastAssignmentDate	Datetime	False		The date on which the lead was last reassigned.
LastUpdateDate	Datetime	True		Who column: indicates the date and time of the last update of the row.
LastUpdateLogin	String	True		Who column: indicates the login of the user who last updated the row.
LastUpdatedBy	String	True		Who column: indicates the user who last updated the row.
Latitude	Double	False		Latitude information for the location.
LeadAcceptedFlag	Bool	False		Indicates if the lead has been accepted.
LeadAging	Double	True		The number of days elapsed since the lead was created.
LeadCreatedBy	String	False		Functional WHO: Indicates the user who created this record.
LeadCreationDate	Datetime	False		Functional WHO: Indicates the date and time when this record is created.
LeadLastUpdateDate	Datetime	False		Functional WHO: Indicates the date and time of the last update of the row.
LeadLastUpdatedBy	String	False		Functional WHO: Indicates the user who last updated the row.
LeadNumber	String	False		User friendly unique identifier for a lead.
LeadOrigin	String	False		Origin of the Lead
Longitude	Double	False		Longitude information for the location.
Name	String	False		Lead Name used for identifying the lead.
OpportunityName	String	False		OpportunityName
OpportunityOwnerNumber	String	False		OpportunityOwnerNumber
OrganizationSize	String	False		Organization Size
OrganizationType	String	False		Organization Type
OwnerId	Long	False		Party identifier associated with the owner of this sales lead.
OwnerPartyName	String	False		Name associated with the owner of this sales lead.
OwnerPartyNumber	String	False		OwnerPartyNumber
PartnerCompanyNumber	String	False		PartnerCompanyNumber
PartnerId	Long	False		Unique identifier for the primary partner associated with the lead.
PartnerPartyName	String	False		Name associated with the primary partner of this sales lead. This is a deal specific attribute.
PartnerProgramId	Long	False		A reference to the partner program in which the primary partner associated with this sales lead is enrolled. This is a deal specific attribute.
PartnerProgramNumber	String	False		PartnerProgramNumber
PartnerType	String	False		Indicates the type of the primary partner associated with this sales lead. This is a deal specific attribute.
PostalPlus4Code	String	False		Four digit extension to the United States Postal ZIP code.
PrimaryCampaignId	Long	False		PrimaryCampaignId
PrimaryCampaignName	String	False		PrimaryCampaignName
PrimaryCampaignNumber	String	False		PrimaryCampaignNumber
PrimaryCompetitorName	String	False		PrimaryCompetitorName
PrimaryCompetitorPartyId	Long	False		PrimaryCompetitorPartyId
PrimaryCompetitorPartyNumber	String	False		PrimaryCompetitorPartyNumber
PrimaryContactAddress1	String	False		The first line of address associated with the primary contact of the lead.
PrimaryContactAddress2	String	False		The second line of address associated with the primary contact of the lead.
PrimaryContactAddress3	String	False		The third line of address associated with the primary contact of the lead.
PrimaryContactAddress4	String	False		The fourth line of address associated with the primary contact of the lead.
PrimaryContactCity	String	False		The city where the primary contact of the lead is located.
PrimaryContactCountry	String	False		The country where the primary contact of the lead is located.
PrimaryContactCountryName	String	True		Full name associated with primary contact country code
PrimaryContactCounty	String	False		The county where the primary contact of the lead is located.
PrimaryContactEmailAddress	String	False		Email address for the primary sales lead contact on the lead
PrimaryContactEmailPreference	String	False		PrimaryContactEmailPreference
PrimaryContactEmailVerificationDate	Datetime	False		PrimaryContactEmailVerificationDate
PrimaryContactEmailVerificationStatus	String	False		PrimaryContactEmailVerificationStatus
PrimaryContactId	Long	False		Identifer of the sales lead contact marked as a primary lead contact.
PrimaryContactMailPreference	String	False		PrimaryContactMailPreference
PrimaryContactPartyName	String	False		Name associated with the primary lead contact.
PrimaryContactPersonFirstName	String	False		First name of the primary contact for a lead.
PrimaryContactPersonLastName	String	False		Last name of the primary contact for a lead.
PrimaryContactPersonMiddleName	String	False		Middle name of the primary contact for a lead.
PrimaryContactPhonePreference	String	False		PrimaryContactPhonePreference
PrimaryContactPostalCode	String	False		The zip code where the primary contact of the lead is located.
PrimaryContactProvince	String	False		The province where the primary contact of the lead is located.
PrimaryContactRelationshipId	Long	False		Unique identifier of the relationship primary contact has with its parent organization.
PrimaryContactState	String	False		The state where the primary contact of the lead is located.
PrimaryInventoryItemId	Long	False		Unique identifier of the primary product associated with a lead.
PrimaryInventoryItemNumber	String	False		PrimaryInventoryItemNumber
PrimaryInventoryOrgId	Long	False		Unique identifier of the organization to which the primary product associated with a lead belongs.
PrimaryPhoneAreaCode	String	False		Primary phone area code for the sales lead contact.
PrimaryPhoneCountryCode	String	False		Primary phone country code for the sales lead contact.
PrimaryPhoneNumber	String	False		Primary phone number for the sales lead contact.
PrimaryPhoneVerificationDate	Datetime	False		PrimaryPhoneVerificationDate
PrimaryPhoneVerificationStatus	String	False		PrimaryPhoneVerificationStatus
PrimaryProductGroupId	Long	False		Unique identifier of the primary product group associated with a lead.
PrimaryProductGroupReferenceNumber	String	False		PrimaryProductGroupReferenceNumber
ProductGroupDescription	String	True		Description of the product or product group associated with a lead.
ProductGroupName	String	False		Name of the product group associated with a lead.
ProductType	String	False		ProductType
ProgramName	String	False		Name of the partner program in which the primary partner associated with this sales lead is enrolled. This is a deal specific attribute.
Project	String	False		customer project identified for this sales lead.
QualificationScore	Int	True		Qualification score for a lead.
QualifiedDate	Date	False		Indicates the date when this sales lead was qualified.
QualifiedDateTime	Datetime	False		Date and time when the sales lead is qualified.
Rank	String	False		Rank associated with this sales lead.
RawPrimaryPhoneNumber	String	False		RawPrimaryPhoneNumber
ReassignComment	String	False		Comment provided by a user while requesting the lead reassignment.
ReassignReasonCode	String	False		Pre-defined code used to indicate the reason for lead reassignment.
RecordSet	String	True		RecordSet
RegistrationNumber	String	False		Registration number of the sales lead. This unique identifier is generated when the sales lead is approved. This is a deal specific attribute.
RegistrationStatus	String	False		Approval Status of the sales lead. This is a deal specific attribute.
RegistrationType	String	False		Indicates the registration type of the sales lead. This is a deal specific attribute.
RejectByUserId	Long	False		Identifier of the sales representative who rejected this sales lead.
RejectComment	String	False		Comments provided by the sales representative who rejected this sales lead.
RejectReasonCode	String	False		Pre-defined code used to indicate the reason for rejecting a lead.
RejectedDateTime	Datetime	False		Date and time when the sales lead is rejected.
RetireComment	String	False		Comments recorded when the sales lead is moved to a retired status.
RetireReasonCode	String	False		Pre-defined code used to indicate the reason for retiring a lead.
RetiredDateTime	Datetime	False		Date and time when the sales lead is moved to a retired status.
SalesChannel	String	False		Indicates the sales channel responsible for following up on this sales lead.
SalesTargetLeadEloquaSyncDate	Datetime	False		SalesTargetLeadEloquaSyncDate
SalesTargetLeadOptOutComment	String	False		SalesTargetLeadOptOutComment
SalesTargetLeadOptOutDate	Datetime	False		SalesTargetLeadOptOutDate
SalesTargetLeadOptOutReasonCode	String	False		SalesTargetLeadOptOutReasonCode
SalesTargetLeadStage	String	False		SalesTargetLeadStage
SalesTargetLeadValidationDueDate	Datetime	False		SalesTargetLeadValidationDueDate
Score	Int	False		The score associated with this sales lead. This score is computed based on the scoring rules.
SourceCode	String	False		Marketing source code associated with this sales lead.
StatusCode	String	False		Pre-defined code used to indicate the status of a lead.
Timeframe	String	False		Timeframe associated with this sales lead.
ToReassignFlag	Bool	False		Identifies leads that are marked for reassignment.
UpdateFlag	Bool	True		This flag controls if the user has access to update the record
WorkPhoneAreaCode	String	False		Work phone area code for the sales lead contact.
WorkPhoneCountryCode	String	False		Work phone country code for the sales lead contact.
WorkPhoneNumber	String	False		Work phone number for the sales lead contact.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
ContactId	String	The unique identifier of the Contact.
SysEffectiveDate	String	SysEffectiveDate.
ResourcePartyIdRest	String	The unique identifier of the Resource.
RestCreationDateLower	String	Finds the leads that are created before the date specified.
RestCreationDateUpper	String	Finds the leads with the specified creation date.
RestRecordSet	String	Finds the leads with the specified record set value.
RestStatusCode	String	Finds the leads with the specified status code.

SalesLeadsLeadCampaigns

The lead campaign resource is used to view, create, update, and delete the association of a campaign with a lead.

Columns


Name	Type	ReadOnly	References	Description
LeadCampaignId [KEY]	Long	True		LeadCampaignId
LeadId [KEY]	String	True	SalesLeads.LeadId	LeadId
CampaignEndDate	Datetime	True		CampaignEndDate
CampaignId	Long	False		CampaignId
CampaignName	String	True		CampaignName
CampaignNumber	String	False		CampaignNumber
CampaignStartDate	Datetime	True		CampaignStartDate
CampaignStatus	String	True		CampaignStatus
CampaignType	String	True		CampaignType
CreatedBy	String	True		CreatedBy
CreationDate	Datetime	True		CreationDate
LastUpdateDate	Datetime	True		LastUpdateDate
LastUpdatedBy	String	True		LastUpdatedBy
LeadCampaignNumber	String	False		LeadCampaignNumber
LeadNumber	String	False		LeadNumber
PrimaryFlag	Bool	False		PrimaryFlag

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
ContactId	String	The unique identifier of the Contact.
SysEffectiveDate	String	SysEffectiveDate.
ResourcePartyIdRest	String	The unique identifier of the Resource.
RestCreationDateLower	String	Finds the leads that are created before the date specified.
RestCreationDateUpper	String	Finds the leads with the specified creation date.
RestRecordSet	String	Finds the leads with the specified record set value.
RestStatusCode	String	Finds the leads with the specified status code.
Name	String	Input specifying the name.

SalesLeadsLeadCompetitors

The lead competitors resource is used to view, create, update, and delete the association of a campaign with a lead.

Columns


Name	Type	ReadOnly	References	Description
LeadCompetitorId [KEY]	Long	False		LeadCompetitorId
LeadId [KEY]	String	False	SalesLeads.LeadId	LeadId
Comments	String	False		Comments
CompetitorPartyId	Long	False		CompetitorPartyId
CompetitorPartyName	String	True		CompetitorPartyName
CompetitorPartyNumber	String	False		CompetitorPartyNumber
CreatedBy	String	True		CreatedBy
CreationDate	Datetime	True		CreationDate
LastUpdateDate	Datetime	True		LastUpdateDate
LastUpdateLogin	String	True		LastUpdateLogin
LastUpdatedBy	String	True		LastUpdatedBy
LeadCompetitorNumber	String	False		LeadCompetitorNumber
LeadNumber	String	False		LeadNumber
PrimaryFlag	Bool	False		PrimaryFlag
ThreatLevelCode	String	False		ThreatLevelCode

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
ContactId	String	The unique identifier of the Contact.
SysEffectiveDate	String	SysEffectiveDate.
ResourcePartyIdRest	String	The unique identifier of the Resource.
RestCreationDateLower	String	Finds the leads that are created before the date specified.
RestCreationDateUpper	String	Finds the leads with the specified creation date.
RestRecordSet	String	Finds the leads with the specified record set value.
RestStatusCode	String	Finds the leads with the specified status code.
Name	String	Finds the leads with the specified name.

SalesLeadsLeadQualifications

The assessments resource is used to view, create and update qualifications of a lead.

Columns


Name	Type	ReadOnly	References	Description
AssessmentId [KEY]	Long	False		AssessmentId
LeadId [KEY]	String	False	SalesLeads.LeadId	LeadId
AssessTemplateId	Long	False		AssessTemplateId
AssessedLanguage	String	False		AssessedLanguage
AssessedObjTypeCode	String	False		AssessedObjTypeCode
AssessedObjectId	Long	False		AssessedObjectId
AssessmentScore	Int	False		AssessmentScore
BusinessUnit	Long	False		BusinessUnit
ConflictId	Long	False		ConflictId
CreatedBy	String	True		CreatedBy
LastUpdateDate	Datetime	True		LastUpdateDate
LastUpdatedBy	String	True		LastUpdatedBy
Name	String	False		Name
RatingFeedback	String	True		RatingFeedback
RatingTerm	String	True		RatingTerm
StatusCode	String	False		StatusCode
StatusFuse	String	True		StatusFuse
TemplateName	String	False		TemplateName
TemplateType	String	False		TemplateType
TotalAnswered	Double	False		TotalAnswered
TotalQuestions	Double	False		TotalQuestions

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
ContactId	String	The unique identifier of the Contact.
SysEffectiveDate	String	SysEffectiveDate.
ResourcePartyIdRest	String	The unique identifier of the Resource.
RestCreationDateLower	String	Finds the leads that are created before the date specified.
RestCreationDateUpper	String	Finds the leads with the specified creation date.
RestRecordSet	String	Finds the leads with the specified record set value.
RestStatusCode	String	Finds the leads with the specified status code.
LeadNumber	String	Finds the leads with the lead number.

SalesLeadsNotes

The note resource is used to capture comments, information, or instructions for a sales lead.

Columns


Name	Type	ReadOnly	References	Description
NoteId [KEY]	Long	True		The unique identifier of the note. This is the primary key of the notes table.
LeadId [KEY]	String	False	SalesLeads.LeadId	LeadId
ContactRelationshipId	Long	False		The relationship ID populated when the note is associated with a contact.
CorpCurrencyCode	String	False		The corporate currency code for extensibility.
CreatedBy	String	True		The user who created the record.
CreationDate	Datetime	True		The date when the record was created.
CreatorPartyId	Long	False		The unique identifier of the party.
CurcyConvRateType	String	False		The currency conversion rate type for extensibility.
CurrencyCode	String	False		The currency code for extensibility.
DeleteFlag	Bool	True		Indicates whether the user has access to delete the note.
EmailAddress	String	True		The email address of the user who created the note.
FormattedAddress	String	True		The address of the user who created the note.
FormattedPhoneNumber	String	True		The phone number of the user who created the note.
LastUpdateDate	Datetime	True		The date when the record was last updated.
LastUpdateLogin	String	True		The login of the user who last updated the record.
LastUpdatedBy	String	True		The unique identifier of the note. This is the primary key of the notes table.
NoteNumber	String	False		The alternate unique identifier of the note. A user key that's system generated or from an external system.
NoteTitle	String	False		The title of the note entered by the user.
NoteTxt	String	False		The column which stores the actual note text.
NoteTypeCode	String	False		The note type code for categorization of note.
ParentNoteId	Long	False		The unique identifier of the note. This is the primary key of the notes table.
PartyId	Long	True		The unique identifier of the party.
PartyName	String	True		The name of the party.
SourceObjectCode	String	False		This is the source object code for the source object as defined in OBJECTS Metadata.
SourceObjectId	String	False		The unique identifier of the parent source object associated to the note.
UpdateFlag	Bool	True		Indicates whether the user can update the note.
VisibilityCode	String	False		The attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
ContactId	String	The unique identifier of the Contact.
SysEffectiveDate	String	SysEffectiveDate.
ResourcePartyIdRest	String	The unique identifier of the Resource.
RestCreationDateLower	String	Finds the leads that are created before the date specified.
RestCreationDateUpper	String	Finds the leads with the specified creation date.
RestRecordSet	String	Finds the leads with the specified record set value.
RestStatusCode	String	Finds the leads with the specified status code.
Name	String	Finds the leads with the specified name.
LeadNumber	String	Finds the leads with the specified lead number.

SalesOrders

Usage information for the operation SalesOrders.rsd.

Columns


Name	Type	ReadOnly	References	Description
OrderHeaderId [KEY]	Long	False		Unique identifier for the quote or Order
ActiveVersionFlag	Bool	False		active version flag
CreatedBy	String	False
CreationDate	Datetime	False
CrmConversionRate	Double	False
CurrencyCode	String	False		Currency code
DeleteFlag	Bool	False		This flag controls if the user has access to delete the record
Description	String	False		Quote Description
ExpirationDate	Datetime	False		Expiration Date of the Quote or Order
ExternalQuoteNumber	String	False		Identifier from source system that created this Quote
ExternalReferenceNumber	String	False		Identifier for the External Quote/Order
ExternalSystemReferenceCode	String	False		External reference(Third party) type for the Quote or Order. Big machines will pass BMQUOTE
LastOptySyncDate	Datetime	False		Last Opportunity Sync date for the quote to identify the Active version of the quote for the opportunity.
LastUpdateDate	Datetime	False		last update date when record was updated
LastUpdateLogin	String	False
LastUpdatedBy	String	False
Name	String	False		Store the Quote/Order Name
OptyId	Long	False		Opportunity Id for the Quote is created
OptyNumber	String	False
OrderHeaderNumber	String	False
OrderTotal	Double	False		Total Amount
Owner	String	False		Quote Owner
PlacedOnDate	Datetime	False		Date on which Order was placed
ProposalExistFlag	Bool	False		Flag to identify the associated proposal for the Quote. Valid values are Y or N
ProposalUrl	String	False		URL to fetch quote proposal document
SalesAccountId	Long	False
SalesAccountUniqueName	String	False		Name of the customer account
SoldContactPartyId	Long	False		Customer Contact Party Identifier
SoldContactPartyNumber	String	False
SoldCustPartyNumber	String	False
SoldCustomerPartyId	Long	False		Customer Party Identifier
SoldPartySiteId	Long	False		Customer Address Identifier
Status	String	False		The exact quote status sent by BM
UpdateFlag	Bool	False		This flag controls if the user has access to update the record
VersionNumber	Long	False		Version Number of the Quote/Order
WinStatusCode	String	False		Lookup code for lookup type=ORA_ZCA_WIN_STATUS

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.

ServiceProviders

Usage information for the operation ServiceProviders.rsd.

Columns


Name	Type	ReadOnly	References	Description
ProviderId [KEY]	Long	False
CreatedBy	String	False
CreationDate	Datetime	False
ImposedEstimatedStartTime	Datetime	False
ImposedServiceStateCd	String	False
LastUpdateDate	Datetime	False
LastUpdateLogin	String	False
LastUpdatedBy	String	False
PassiveBeaconURL	String	False
ProviderAPPKey	String	False
ProviderName	String	False

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.

Signatures

The signatures resource is used to view, create, update, and delete a signature for an agent

Columns


Name	Type	ReadOnly	References	Description
SignatureId [KEY]	Long	True		The unique identifier of the signature.
ChannelId	Long	False		The unique identifier of the channel associated to a signature.
CreatedBy	String	True		The user who created the signature.
CreationDate	Datetime	True		The date when the signature record was created.
DefaultFlag	Bool	False		Indicates whether the signature is the default signature.
LastUpdateDate	Datetime	True		The date when the signature was last updated.
LastUpdateLogin	String	True		The login of the user who last updated the signature.
LastUpdatedBy	String	True		The user who last updated the signature.
SignatureContent	String	False		The content of the signature.
SignatureName	String	False		The name of the signature.
SignatureNumber	String	False		The alternate key identifier of the signature.
UserPartyId	Long	False		The unique party identifier of the user who associated to a signature.

Territories

The sales territories resource represents the list of sales territories that the logged-in user can view. A sales territory is an organizational domain with boundaries defined by attributes of customers, products, services, resources, and so on. Sales territories can be created based on multiple criteria including postal code, area code, country, vertical market, size of company, product expertise, and geographical location. Sales territories form the fundamental infrastructure of sales management as they define the jurisdiction that salespeople have over sales accounts, or the jurisdiction that channel sales managers have over partners and partner transactions.

Columns


Name	Type	ReadOnly	References	Description
TerritoryVersionId [KEY]	Long	False		The unique identifier of the territory version.
CoverageModel	String	False		Indicates if the dimensions of the territory are based on account attributes or partner attributes.
DeleteFlag	Boolean	False		Indicates if the logged-in user can delete the territory.
Description	String	False		The description of the territory.
EffectiveEndDate	Date	False		The date and time when the territory version becomes active.
EffectiveStartDate	Date	False		The date and time when the territory version becomes active.
EligibleForQuotaFlag	Boolean	False		Indicates whether the territory is going to change during a territory realignment. If the value is True, then the territory is unlikely to change during a major realignment and therefore a quota can be entered against the proposed definition.
ForecastedByParentTerritoryFlag	Boolean	False		Indicates if the forecast for the territory is made by its parent territory.
ForecastParticipationCode	String	False		The code for the forecast participation. The accepted values are: REVENUE, NONREVENUE, REVENUE_AND_NONREVENUE, and NON_FORECASTING.
LatestVersionFlag	Boolean	False		Indicates the latest active version of the territory. If the value is True, then the territory version is the latest active version of the territory.
Name	String	False		The name of the territory.
OrganizationName	String	False		The name of the organization to which the owner belongs.
OwnerResourceId	Long	False		The unique identifier of the owner resource.
ParentTerritoryId	Long	False		The unique identifier of the parent territory.
PartnerId	Long	False		The unique identifier of the partner associated with the territory.
PartnerProgramId	Long	False		The unique identifier of the partner program to which the partner is enrolled.
ProgramName	String	False		The name of the partner program to which the partner is enrolled.
ReviseQuotaFlag	Boolean	False		Indicates whether a submitted quota needs to be revised.
RevisionDescription	String	False		The description of the reason for revising the quota.
RevisionReason	String	False		The user-defined reason for revising the quota.
SourceTerrId	Long	False		The identifier of the territory from which the dimensions are inherited.
SourceTerrLastUpdateDate	Datetime	False		The date and time when the source territory was last updated. This attribute is related to the inheritance of dimensions by recipient territories from source territories.
SourceTerrName	String	False		The name of the territory from which the selected dimensions are inherited.
SourceTerrVersionId	Long	False		The unique identifier of the source territory version.
StatusCode	String	False		The code for the territory status.
TerritoryId	Long	False		The unique identifier of the territory.
TerritoryLevel	Long	False		The level of the territory in the territory hierarchy.
TerritoryNumber	String	False		The unique alternate identification number for the territory.
TerrProposalId	Long	False		The unique identifier of the territory proposal.
TypeCode	String	False		The code for the territory type.
UpdateFlag	Boolean	False		Indicates if the logged-in user can update the territory.
UniqueTerritoryNumber	String	False		The unique territory number of the territory.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.

TerritoryForecasts

The forecasts resource is used to view or modify a forecast territory.

Columns


Name	Type	ReadOnly	References	Description
ForecastParticipantId [KEY]	Long	False		The unique identifier of the territory forecast.
AdjustedBestCase	Double	False		The best case value of the forecast after adjustments.
AdjustedForecast	Double	False		The value of the territory forecast after adjustments.
AdjustedQuantity	Double	False		The value of the adjusted quantity.
AdjustedWorstCase	Double	False		The worst case value of the forecast after adjustments.
DueDate	Date	False		The due date for the forecast.
EndDate	Date	False		The end date for the forecast.
ForecastHeaderId	Long	False		The unique identifier of the forecast.
ForecastName	String	False		The name of the forecast.
ForecastParticipationCode	String	False		The participation code for the forecast. The accepted values are: Revenue and Non-Revenue, Revenue (for revenue forecasts), and Non-Revenue (for overlay forecasts).
ForecastType	String	False		The type of the forecast. The accepted values are: Revenue and Overlay.
Meaning	String	False		The status of the forecast. The accepted values are: Submitted, Unsubmitted, and Rejected.
OwnerResourceId	Long	False		The unique identifier of the party that owns the territory.
ParentTerritoryOwnerResourceId	Long	False		The resource identifier of the parent territory owner.
PseudoTerritoryFlag	Boolean	False		Indicates if the territory is a manager territory.
StartDate	Date	False		The start date for the forecast.
StatusCode	String	False		The status code of the forecast. The accepted values are: SUBMITTED, UNSUBMITTED, and REJECTED.
SubmittedBy	String	False		The name of the user who submitted the forecast.
SubmittedOn	Datetime	False		The submission date of the forecast.
TerritoryHierarchyFreezeDate	Date	False		The date on which the territory hierarchy is frozen. The forecast for a period is editable only after the territory hierarchy has been frozen for that forecasting period.
TerritoryId	Long	False		The unique identifier of the territory.
TerritoryLevel	Number	False		The level of the territory in the territory hierarchy.
TerritoryName	String	False		The name of the forecast territory.
TerritoryVersionId	Long	False		The unique identifier of the territory version.
UpdateFlag	Boolean	False		Indicates if the user has access to update the record.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
TrStatus	String	The accepted values for TrStatus are ACTIVE, PAST, and FUTURE. The forecast records for the given user are filtered based on the specified territory forecast status value. The allowed values are ACTIVE, PAST, FUTURE.

TerritoryResources

The resources resource is used to view the resources, such as owner or sales people associated with a sales territory.

Columns


Name	Type	ReadOnly	References	Description
TerrResourceId [KEY]	Long	False		Identifier of the resource.
TerritoryVersionId [KEY]	String	True	Territories.TerritoryVersionId	TerritoryVersionId
AdministratorFlag	Bool	False		Indicates that the resource is an administrator in the given territory.
CreatedBy	String	True		CreatedBy
CreationDate	Datetime	True		CreationDate
Email	String	True		Email
FunctionCode	String	False		Stores the function of the resource in the Territory.
LastUpdateDate	Datetime	True		LastUpdateDate
LastUpdateLogin	String	True		LastUpdateLogin
LastUpdatedBy	String	True		LastUpdatedBy
ManageForecastFlag	Bool	False		Indicates that a Territory Resource has been given the responsibility to manage the corresponding Territory Forecast on behalf of the owner of the Territory.
Manager	String	True		Name of the Manager.
OrganizationName	String	True		Name of the Organization.
OwnerFlag	Bool	True		OwnerFlag
ResourceId	Long	False		Identifier of the resource from resource manager ie. party model.
ResourceName	String	True		Name of the resource.
ResourceNumber	String	False		ResourceNumber
RoleName	String	True		Role associated to the resource.
UniqueTerritoryNumber	String	False		UniqueTerritoryNumber

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String	Input specifying the Finder type.
TrStatus	String	The accepted values for TrStatus are ACTIVE, PAST, and FUTURE. The forecast records for the given user are filtered based on the specified territory forecast status value. The allowed values are ACTIVE, PAST, FUTURE.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Oracle Sales Connector for CData Sync Views


Name	Description
AccountAttachments	An attachment includes additional information about an account.
AccountHierarchy	The account hierarchy summaries resource is used to view the account hierarchy information.
ActivityAttachments	An attachment includes additional information about an activity
ActivityFunctionLookups	Usage information for the operation ActivityFunctionLookups.rsd.
CatalogProductGroups	Usage information for the operation CatalogProductGroups.rsd.
ContactAttachments	An attachment includes additional information about a contact.
ContactsPictureAttachments	The contact picture attachment resource is used to view, create, and update the resource's picture.Get a resource's picture
EmployeeResourceAttachments	The contact picture attachment resource is used to view, create, and update the resource's picture.Get a resource's picture
EmployeeResources	The resources resource is used to view, create, and update a resource. A resource is a person within the deploying company who can be assigned work to accomplish business objectives, such as sales persons or partner members. The EmployeeResources is deprecated, please use Resources view to access resource data.
OpportunityAttachments	An attachment includes additional information about an opportunity.
OpportunityDeals	A deal associated with the opportunity.
OpportunityRevenueProductGroups	The product group resource is used to view, create, and update the product groups associated with an opportunity. The product group let you categorize products and services that you sell.
OpportunityRevenueProducts	The following table describes the default response for this task.
Resources	The resources resource is used to view, create, and update a resource. A resource is a person within the deploying company who can be assigned work to accomplish business objectives, such as sales persons or partner members.
ResourceUsersResourceRoleAssignments	The resource role assignments resource is used to view the role assigned to a resource, such as implementer, reseller, and so on.
SalesLeadAttachments	The attachment resource is used to view, create, and update attachments of a sales lead.
SalesLeadsLeadOpportunity	The opportunity resource is used to view, create, or modify an opportunity generated from a lead. An opportunity list associated with the lead represents leads that have already been converted to the list of opportunities.
SalesLeadsLeadTeam	The lead teams resource is used to view the team members and territory team members associated with a lead.
SalesLeadsProductGroups	The product groups resource is used to capture the name of the product group associated with the sales lead.
SalesLeadsProducts	The product resource is used to capture the name of the product associated with the sales lead.
SalesLeadTerritories	The sales lead territories resource is used to view the associated sales lead territories.
ServiceDetails	Usage information for the operation ServiceDetails.rsd.

AccountAttachments

An attachment includes additional information about an account.

Columns


Name	Type	References	Description
AttachedDocumentId [KEY]	Long		The unique identifier of the attached document.
PartyNumber [KEY]	String	Accounts.PartyNumber	The unique alternate identifier for the account party.
AsyncTrackerId	String		Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
CategoryName	String		The category of the attachment.
ContentRepositoryFileShared	Bool		Indicates whether the attachment is shared
CreatedBy	String		The user who created the record.
CreatedByUserName	String		The user name who created the record.
CreationDate	Datetime		The date when the record was created.
DatatypeCode	String		A value that indicates the data type.
Description	String		The description of the attachment.
DmDocumentId	String		The document ID from which the attachment is created.
DmFolderPath	String		The folder path from which the attachment is created.
DmVersionNumber	String		The document version number from which the attachment is created.
DownloadInfo	String		JSON object represented as a string containing information used to programmatically retrieve a file attachment.
ErrorStatusCode	String		The error code, if any, for the attachment.
ErrorStatusMessage	String		The error message, if any, for the attachment.
ExpirationDate	Datetime		The expiration date of the contents in the attachment.
FileContents	String		The contents of the attachment.
FileName	String		The file name of the attachment.
FileUrl	String		The URI of the file.
FileWebImage	String		The base64 encoded image of the file displayed in .png format if the source is a convertible image.
LastUpdateDate	Datetime		The date when the record was last updated.
LastUpdatedBy	String		The user who last updated the record.
LastUpdatedByUserName	String		The user name who last updated the record.
PostProcessingAction	String		The name of the action that can be performed after an attachment is uploaded.
Title	String		The title of the attachment.
UploadedFileContentType	String		The content type of the attachment.
UploadedFileLength	Long		The size of the attachment file.
UploadedFileName	String		The name to assign to a new attachment file.
UploadedText	String		The text content for a new text attachment.
Uri	String		The URI of a Topology Manager type attachment.
Url	String		The URL of a web page type attachment.
UserName	String		The login credentials of the user who created the attachment.
AccountLastUpdateDate	Datetime		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String		Input specifying the Finder type.
FocusPartyId	String		The unique identifier of the child account to be returned at the top by the Direct Accounts finder.
ParentPartyId	String		The unique identifier of the account used to search the direct child accounts.
BindUserPartyId	String		The unique identifier of the party. Used in MyAccounts finder.
OrganizationProfileId	String		The unique identifier of the organization.
PartyId	String		The unique identifier of the party associated to the given account.
SourceSystem	String		Name of external source system.
SourceSystemReferenceValue	String		Identifier for this record from external source system.

AccountHierarchy

The account hierarchy summaries resource is used to view the account hierarchy information.

Columns


Name	Type	References	Description
PartyId [KEY]	Long		The unique identifier of the party associated to the given account.
PartyNumber [KEY]	String	Accounts.PartyNumber	The unique alternate identifier for the account party.
CreatedBy	String		The user who created the account hierarchy summary.
CreationDate	Datetime		The date and time when the account hierarchy summary was created.
LastUpdateDate	Datetime		The date and time when the account hierarchy summary was last updated.
LastUpdatedBy	String		The user who last updated the account hierarchy summary.
ParentAccountList	String		List of all the parent accounts till the top node in the account hierarchy.
ParentAccountName	String		The parent account name of the given account.
ParentAccountPartyId	Long		The parent account identifier of the given account.
ParentAccountPartyNumber	String		The parent account registry identifier of given account.
PartyUniqueName	String		The unique party name of the party record.
TotalChildAccounts	Int		The total number of child accounts.
TotalImmediateChildAccounts	Int		Total number of immediate child of given account.
UltimateParentName	String		The ultimate parent account name of given account.
UltimateParentPartyId	Long		The ultimate parent account identifier of given account.
UltimateParentPartyNumber	String		The ultimate parent account registry identifier of given account.
AccountLastUpdateDate	Datetime		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String		Input specifying the Finder type.
FocusPartyId	String		The unique identifier of the child account to be returned at the top by the Direct Accounts finder.
ParentPartyId	String		The unique identifier of the account used to search the direct child accounts.
BindUserPartyId	String		The unique identifier of the party. Used in MyAccounts finder.
OrganizationProfileId	String		The unique identifier of the organization.
SourceSystem	String		Name of external source system.
SourceSystemReferenceValue	String		Identifier for this record from external source system.

ActivityAttachments

An attachment includes additional information about an activity

Columns


Name	Type	References	Description
AttachedDocumentId [KEY]	Long		The unique identifier of the attached document.
ActivityNumber [KEY]	String	Activities.ActivityNumber	ActivityNumber
AsyncTrackerId	String		Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
CategoryName	String		The category of the attachment.
ContentRepositoryFileShared	Bool		Indicates whether the attachment is shared
CreatedBy	String		The user who created the record.
CreatedByUserName	String		The user name who created the record.
CreationDate	Datetime		The date when the record was created.
DatatypeCode	String		A value that indicates the data type.
Description	String		The description of the attachment.
DmDocumentId	String		The document ID from which the attachment is created.
DmFolderPath	String		The folder path from which the attachment is created.
DmVersionNumber	String		The document version number from which the attachment is created.
DownloadInfo	String		JSON object represented as a string containing information used to programmatically retrieve a file attachment.
ErrorStatusCode	String		The error code, if any, for the attachment.
ErrorStatusMessage	String		The error message, if any, for the attachment.
ExpirationDate	Datetime		The expiration date of the contents in the attachment.
FileContents	String		The contents of the attachment.
FileName	String		The file name of the attachment.
FileUrl	String		The URI of the file.
FileWebImage	String		The base64 encoded image of the file displayed in .png format if the source is a convertible image.
LastUpdateDate	Datetime		The date when the record was last updated.
LastUpdatedBy	String		The user who last updated the record.
LastUpdatedByUserName	String		The user name who last updated the record.
PostProcessingAction	String		The name of the action that can be performed after an attachment is uploaded.
Title	String		The title of the attachment.
UploadedFileContentType	String		The content type of the attachment.
UploadedFileLength	Long		The size of the attachment file.
UploadedFileName	String		The name to assign to a new attachment file.
UploadedText	String		The text content for a new text attachment.
Uri	String		The URI of a Topology Manager type attachment.
Url	String		The URL of a web page type attachment.
UserName	String		The login credentials of the user who created the attachment.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String		Input specifying the Finder type.
ContactIDAttr	String		The contact ID related to the activities.
ActivityId	String		Activity Id.
AccountIdAttr	String		Finds the account ID related to the call reports.
LeadIdAttr	String		Finds the lead ID related to the call reports.
OpportunityIdAttr	String		Finds the opportunity ID related to the call reports.
ParentActivityIdAttr	String		The parent activity ID related to the call reports.
EndDtRFAttr	String		The appointment end date.
StartDtRFAttr	String		The appointment start date.
DateRange	String		The date range within which you want search for appointments.
Bind_CurrentDate	String		Finds the date used to locate completed activities.
Bind_RecurSeriesType_BV	String		The recurring type code of an appointment.
Bind_TaskActFuncCd_BV	String		The activities with a function code of task.
Bind_TaskStatus_BV	String		The status of the tasks.
Bind_UserResourceId	String		Finds the resource ID of the user.
Bind_Subject	String		Open activities owned by a specified user.
Bind_LoggedInUserId_BV	String		The ID of the user who is logged into the application.
Bind_TaskStatus_Cancel_BV	String		The tasks with a cancelled status.
Bind_TaskPriority_BV	String		The priority of the task.
Bind_CurrentUPTZDate	String		The date used to locate the Tasks whose due date is before the current date.

ActivityFunctionLookups

Usage information for the operation ActivityFunctionLookups.rsd.

Columns


Name	Type	References	Description
LookupCode [KEY]	String
EnabledFlag	Bool
LookupType	String
Meaning	String
SetId	Long
Tag	String
ViewApplicationId	Long

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String		Input specifying the Finder type.

CatalogProductGroups

Usage information for the operation CatalogProductGroups.rsd.

Columns

References Description Long String String Long String Long String Datetime String String Long Long Long String Long String String String String String String String String

Pseudo-Columns

/>


Name	Type style="white-space:nowrap">ProductGroupDenormId	Product Group denorm identifier. style="white-space:nowrap">AllowDuplicateContentFlag
AttachmentEntityName
Depth	Difference in level from the first product group to the last Product Group in the path. style="white-space:nowrap">FilterByTM
FirstProdGrpId
InternalName	Internal name of the Product Group. style="white-space:nowrap">LastUpdateDate
ModelConfigAttributes
ModelName
ParentProductGroupId	Product Group identifier for the penultimate node in the path. style="white-space:nowrap">PathId	Persistent identifier for the path. style="white-space:nowrap">ProdGrpDetailsId
ProductGroupDescription	Translated Product Group description used for runtime display. style="white-space:nowrap">ProductGroupId	Product Group identifier. style="white-space:nowrap">ProductGroupName	Translated name of the Product Group used for runtime display. style="white-space:nowrap">ProductGroupReferenceNumber
ReferenceNumber	Identifier used for integration with external systems. style="white-space:nowrap">RevenueCategoryCode
RevenueRoleCode
UsageCode
UsageModeCode
UsageRootFlag

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String		Input specifying the Finder type.
Bind_InventoryItemId	String		Bind InventoryItemId.
Bind_ProductGroupId	String		Bind ProductGroupId.
Bind_UsageCode	String		Bind UsageCode.
Bind_UsageModeCode	String		Bind UsageModeCode.

ContactAttachments

An attachment includes additional information about a contact.

Columns


Name	Type	References	Description
AttachedDocumentId [KEY]	Long		The unique identifier of the attached document.
PartyNumber [KEY]	String	Contacts.PartyNumber	PartyNumber
AsyncTrackerId	String		Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
CategoryName	String		The category of the attachment.
ContentRepositoryFileShared	Bool		Indicates whether the attachment is shared
CreatedBy	String		The user who created the record.
CreatedByUserName	String		The user name who created the record.
CreationDate	Datetime		The date when the record was created.
DatatypeCode	String		A value that indicates the data type.
Description	String		The description of the attachment.
DmDocumentId	String		The document ID from which the attachment is created.
DmFolderPath	String		The folder path from which the attachment is created.
DmVersionNumber	String		The document version number from which the attachment is created.
DownloadInfo	String		JSON object represented as a string containing information used to programmatically retrieve a file attachment.
ErrorStatusCode	String		The error code, if any, for the attachment.
ErrorStatusMessage	String		The error message, if any, for the attachment.
ExpirationDate	Datetime		The expiration date of the contents in the attachment.
FileContents	String		The contents of the attachment.
FileName	String		The file name of the attachment.
FileUrl	String		The URI of the file.
FileWebImage	String		The base64 encoded image of the file displayed in .png format if the source is a convertible image.
LastUpdateDate	Datetime		The date when the record was last updated.
LastUpdatedBy	String		The user who last updated the record.
LastUpdatedByUserName	String		The user name who last updated the record.
PostProcessingAction	String		The name of the action that can be performed after an attachment is uploaded.
Title	String		The title of the attachment.
UploadedFileContentType	String		The content type of the attachment.
UploadedFileLength	Long		The size of the attachment file.
UploadedFileName	String		The name to assign to a new attachment file.
UploadedText	String		The text content for a new text attachment.
Uri	String		The URI of a Topology Manager type attachment.
Url	String		The URL of a web page type attachment.
UserName	String		The login credentials of the user who created the attachment.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String		Input specifying the Finder type.
BindUserPartyId	String		The unique identifier of the contact.
PartyId	String		The unique identifier of the contact.
PersonProfileId	String		The unique identifier of the contact.
SourceSystem	String		The name of external source system where the contact party is imported from.
SourceSystemReferenceValue	String		The unique identifier for the contact party from the external source system.

ContactsPictureAttachments

The contact picture attachment resource is used to view, create, and update the resource's picture.Get a resource's picture

Columns


Name	Type	References	Description
AttachedDocumentId [KEY]	Long		The Id of Attachment.
PartyNumber [KEY]	String	Contacts.PartyNumber	The unique identifier for the resource party.
ContentRepositoryFileShared	Boolean		Indicates if the attachment is shared.
CreatedBy	String		The user who uploaded the picture attachment.
CreationDate	Datetime		The date when the picture attachment was uploaded.
DatatypeCode	String		The data type for the picture attachment.
Description	String		The description of the picture attachment.
DmFolderPath	String		The folder path where the picture attachment exists.
ErrorStatusCode	String		The error code, if any, for the attachment.
ErrorStatusMessage	String		The error message, if any, for the attachment.
ExpirationDate	Datetime		The expiration date of the contents in the attachment.
FileContents	String		The contents of the attachment.
FileName	String		The name of the attachment file.
FileUrl	String		The URL of the attachment file.
LastUpdateDate	Datetime		The date when the record was last updated.
LastUpdatedBy	String		The user who last updated the record.
Title	String		The title of the attachment.
UploadedFileContentType	String		The content type of the attachment.
UploadedFileLength	Long		The length of the attachment file.
UploadedFileName	String		The name of the attachment file.
UploadedText	String		The text uploaded in the attachment.
Uri	String		The URI of the attachment.
Url	String		The URL of the attachment.
UserName	String		The login associated with the attachment.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String		Input specifying the Finder type.
BindUserPartyId	String		The unique identifier of the contact.
PartyId	String		The unique identifier of the contact.
PersonProfileId	String		The unique identifier of the contact.
SourceSystem	String		The name of external source system where the contact party is imported from.
SourceSystemReferenceValue	String		The unique identifier for the contact party from the external source system.

EmployeeResourceAttachments

The contact picture attachment resource is used to view, create, and update the resource's picture.Get a resource's picture

Columns


Name	Type	References	Description
AttachedDocumentId [KEY]	Long		This is the hash key of the attributes which make up the composite key--- AttachedDocumentId and DocumentId1 ---for the Attachments resource and used to uniquely identify an instance of Attachments. The client should not generate the hash key value. Instead, the client should query on the Attachments collection resource with a filter on the primary key values in order to navigate to a specific instance of Attachments.
PartyNumber [KEY]	String		The unique identifier for the resource party.
ContentRepositoryFileShared	Boolean		Indicates if the attachment is shared.
CreatedBy	String		The user who uploaded the picture attachment.
CreationDate	Datetime		The date when the picture attachment was uploaded.
DatatypeCode	String		The data type for the picture attachment.
Description	String		The description of the picture attachment.
DmFolderPath	String		The folder path where the picture attachment exists.
ErrorStatusCode	String		The error code, if any, for the attachment.
ErrorStatusMessage	String		The error message, if any, for the attachment.
ExpirationDate	Datetime		The expiration date of the contents in the attachment.
FileContents	String		The contents of the attachment.
FileName	String		The name of the attachment file.
FileUrl	String		The URL of the attachment file.
LastUpdateDate	Datetime		The date when the record was last updated.
LastUpdatedBy	String		The user who last updated the record.
Title	String		The title of the attachment.
UploadedFileContentType	String		The content type of the attachment.
UploadedFileLength	Long		The length of the attachment file.
UploadedFileName	String		The name of the attachment file.
UploadedText	String		The text uploaded in the attachment.
Uri	String		The URI of the attachment.
Url	String		The URL of the attachment.
UserName	String		The login associated with the attachment.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String		Input specifying the Finder type.
EmailAddress	String		The e-mail address of the resource.
BindSysdate	String		The identifier for the resource based on the manager reports flag.
PartyId	String		The unique identifier for the resource party.
ResourceProfileId	String		The unique primary key identifier for the resource profile.

EmployeeResources

The resources resource is used to view, create, and update a resource. A resource is a person within the deploying company who can be assigned work to accomplish business objectives, such as sales persons or partner members. The EmployeeResources is deprecated, please use Resources view to access resource data.

Columns


Name	Type	References	Description
PartyNumber [KEY]	String		Unique identification number for this party
EmailAddress	String		E-mail address
EndDateActive	Date		Indicates the date at which the resource becomes inactive
FormattedAddress	String		Primary Formatted address for the resource
FormattedPhoneNumber	String		Primary Formatted phone number for the resource
PartyId	Long		Identifier for the party. Foreign key to the HZ_PARTIES PARTY_ID.
PartyName	String		Name of the Party
PersonFirstName	String		Peron First Name
PersonLastName	String		Peron LastName
PersonLastNamePrefix	String		Resource Peron Last name
PersonMiddleName	String		Peron Middle Name.
PersonNameSuffix	String		Peron Name suffix
PersonPreNameAdjunct	String		Person Preferred Name adjacency
PersonPreviousLastName	String		perin Previous flag mage
PersonSecondLastName	String		peron secind last name
ResourceProfileId	Long		Unique identifier for the Resource Profile. Primary Key.
ResourceType	String		Type of Resource ex employee
StartDateActive	Date		Indicates the date at which the resource becomes active
Url	String		Primary URL for the resource
Usage	String		Read only party usage for resource party

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String		Input specifying the Finder type.
BindSysdate	String		The identifier for the resource based on the manager reports flag.

OpportunityAttachments

An attachment includes additional information about an opportunity.

Columns


Name	Type	References	Description
AttachedDocumentId [KEY]	Long		The unique identifier of the attached document.
OptyNumber [KEY]	String	Opportunities.OptyNumber	OptyNumber
AsyncTrackerId	String		Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
CategoryName	String		The category of the attachment.
ContentRepositoryFileShared	Bool		Indicates whether the attachment is shared
CreatedBy	String		The user who created the record.
CreatedByUserName	String		The user name who created the record.
CreationDate	Datetime		The date when the record was created.
DatatypeCode	String		A value that indicates the data type.
Description	String		The description of the attachment.
DmDocumentId	String		The document ID from which the attachment is created.
DmFolderPath	String		The folder path from which the attachment is created.
DmVersionNumber	String		The document version number from which the attachment is created.
DownloadInfo	String		JSON object represented as a string containing information used to programmatically retrieve a file attachment.
ErrorStatusCode	String		The error code, if any, for the attachment.
ErrorStatusMessage	String		The error message, if any, for the attachment.
ExpirationDate	Datetime		The expiration date of the contents in the attachment.
FileContents	String		The contents of the attachment.
FileName	String		The file name of the attachment.
FileUrl	String		The URI of the file.
FileWebImage	String		The base64 encoded image of the file displayed in .png format if the source is a convertible image.
LastUpdateDate	Datetime		The date when the record was last updated.
LastUpdatedBy	String		The user who last updated the record.
LastUpdatedByUserName	String		The user name who last updated the record.
PostProcessingAction	String		The name of the action that can be performed after an attachment is uploaded.
Title	String		The title of the attachment.
UploadedFileContentType	String		The content type of the attachment.
UploadedFileLength	Long		The size of the attachment file.
UploadedFileName	String		The name to assign to a new attachment file.
UploadedText	String		The text content for a new text attachment.
Uri	String		The URI of a Topology Manager type attachment.
Url	String		The URL of a web page type attachment.
UserName	String		The login credentials of the user who created the attachment.
OpportunityLastUpdateDate	Datetime		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String		Input specifying the resource type.
Finder	String		Input specifying the Finder type.
PartyIdAttribute	String		Input specifying the Party Id Attribute.
AttributeName	String		Input specifying the Attribute Name.
RollUpId	String		Input specifying the RollUp Id.
SourceObject	String		Input specifying the Source Object.
SourceObjectId	String		Input specifying the Source Object Id.
ClosePeriod	String		Input specifying the Close Period.
ContactPartyId	String		Input specifying the Contact Party Id.
EffectiveBeginDate	String		Input specifying the Effective BeginDate.
LeadNumber	String		Input specifying the Lead Number.
LookupCategory	String		Input specifying the Lookup Category.
OpportunityContactName	String		Input specifying the Opportunity Contact Name.
OptyStatusCode	String		Input specifying the Opty StatusCode.
Partner	String		Input specifying the Partner.
PartnerPartyId	String		Input specifying the Partner Party Id.
Product	String		Input specifying the Product.
ProductGroup	String		Input specifying the Product Group.
ReferenceName	String		Input specifying the Reference Name.
ResourcePartyId	String		Input specifying the Resource Party Id.
TeamMember	String		Input specifying the Team Member.
OptyId	String		Input specifying the Opty Id.

OpportunityDeals

A deal associated with the opportunity.

Columns


Name	Type	References	Description
OptyDealId [KEY]	Long		This is the primary key of the opportunity deals table.
OptyNumber [KEY]	String	Opportunities.OptyNumber
CreatedBy	String		The user who created the opportunity deal record.
CreationDate	Datetime		The date and time when the opportunity deal record was created.
DealId	Long		The unique identifier of the deal.
LastUpdateDate	Datetime		The date and time when the opportunity deal record was last updated.
LastUpdatedBy	String		The user who last updated the opportunity deal record.
LastUpdateLogin	String		The session login associated to the user who last updated the opportunity deal record.
OptyId	Long		The unique identifier of the opportunity.
PartyName	String		The name of the partner.
OpportunityLastUpdateDate	Datetime		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String		Input specifying the resource type.
Finder	String		Input specifying the Finder type.
PartyId	String		Input specifying the Party Id.
PartyIdAttribute	String		Input specifying the Party Id Attribute.
AttributeName	String		Input specifying the Attribute Name.
RollUpId	String		Input specifying the RollUp Id.
SourceObject	String		Input specifying the Source Object.
SourceObjectId	String		Input specifying the Source Object Id.
ClosePeriod	String		Input specifying the Close Period.
ContactPartyId	String		Input specifying the Contact Party Id.
EffectiveBeginDate	String		Input specifying the Effective BeginDate.
EffectiveEndDate	String		Input specifying the Effective EndDate.
LeadNumber	String		Input specifying the Lead Number.
LookupCategory	String		Input specifying the Lookup Category.
OpportunityContactName	String		Input specifying the Opportunity Contact Name.
OptyStatusCode	String		Input specifying the Opty StatusCode.
Partner	String		Input specifying the Partner.
PartnerPartyId	String		Input specifying the Partner Party Id.
Product	String		Input specifying the Product.
ProductGroup	String		Input specifying the Product Group.
ReferenceName	String		Input specifying the Reference Name.
ResourcePartyId	String		Input specifying the Resource Party Id.
TeamMember	String		Input specifying the Team Member.
Name	String		Input specifying the Name.

OpportunityRevenueProductGroups

The product group resource is used to view, create, and update the product groups associated with an opportunity. The product group let you categorize products and services that you sell.

Columns


Name	Type	References	Description
ProdGroupId [KEY]	Integer		This is the primary key of the revenue territories table.
RevnId [KEY]	Long
OptyNumber [KEY]	String
Description	String		The user-provided description of the product group.
DisplayName	String		The name of the product group.
LastUpdateDate	String		The date the product group was last updated.
OpportunityLastUpdateDate	Datetime		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String		Input specifying the resource type.
Finder	String		Input specifying the Finder type.
PartyId	String		Input specifying the Party Id.
PartyIdAttribute	String		Input specifying the Party Id Attribute.
AttributeName	String		Input specifying the Attribute Name.
RollUpId	String		Input specifying the RollUp Id.
SourceObject	String		Input specifying the Source Object.
SourceObjectId	String		Input specifying the Source Object Id.
ClosePeriod	String		Input specifying the Close Period.
ContactPartyId	String		Input specifying the Contact Party Id.
EffectiveBeginDate	String		Input specifying the Effective BeginDate.
EffectiveEndDate	String		Input specifying the Effective EndDate.
LeadNumber	String		Input specifying the Lead Number.
LookupCategory	String		Input specifying the Lookup Category.
OpportunityContactName	String		Input specifying the Opportunity Contact Name.
OptyStatusCode	String		Input specifying the Opty StatusCode.
Partner	String		Input specifying the Partner.
PartnerPartyId	String		Input specifying the Partner Party Id.
Product	String		Input specifying the Product.
ProductGroup	String		Input specifying the Product Group.
ReferenceName	String		Input specifying the Reference Name.
ResourcePartyId	String		Input specifying the Resource Party Id.
TeamMember	String		Input specifying the Team Member.
Name	String		Input specifying the Name.
OptyId	String		Input specifying the Opty Id.

OpportunityRevenueProducts

The following table describes the default response for this task.

Columns


Name	Type	References	Description
ProductNum [KEY]	String		The number of the product.
RevnId [KEY]	String
OptyNumber [KEY]	String
ActiveFlag	Boolean		Indicates if the product is Active.
Description	String		The description of the product associated with the opportunity.
EndDate	Datetime		The effective end date of the product.
InventoryItemId	Long		The unique identifier of the product inventory item associated with the opportunity.
InvOrgId	Long		The unique identifier of the inventory organization.
LastUpdateDate	Datetime		The date the product was last updated.
LongDescription	String		Text to describe the product.
ProdGroupId	Long		The unique identifier of the Product Group.
ProductType	String		The type of the product.
StartDate	Datetime		The effective start date of the product.
Text	String		The text or keywords associated with the product.
OpportunityLastUpdateDate	Datetime		The date and time when the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String		Input specifying the resource type.
Finder	String		Input specifying the Finder type.
PartyId	String		Input specifying the Party Id.
PartyIdAttribute	String		Input specifying the Party Id Attribute.
AttributeName	String		Input specifying the Attribute Name.
RollUpId	String		Input specifying the RollUp Id.
SourceObject	String		Input specifying the Source Object.
SourceObjectId	String		Input specifying the Source Object Id.
ClosePeriod	String		Input specifying the Close Period.
ContactPartyId	String		Input specifying the Contact Party Id.
EffectiveBeginDate	String		Input specifying the Effective BeginDate.
EffectiveEndDate	String		Input specifying the Effective EndDate.
LeadNumber	String		Input specifying the Lead Number.
LookupCategory	String		Input specifying the Lookup Category.
OpportunityContactName	String		Input specifying the Opportunity Contact Name.
OptyStatusCode	String		Input specifying the Opty StatusCode.
Partner	String		Input specifying the Partner.
PartnerPartyId	String		Input specifying the Partner Party Id.
Product	String		Input specifying the Product.
ProductGroup	String		Input specifying the Product Group.
ReferenceName	String		Input specifying the Reference Name.
ResourcePartyId	String		Input specifying the Resource Party Id.
TeamMember	String		Input specifying the Team Member.
Name	String		Input specifying the Name.
OptyId	String		Input specifying the Opty Id.

Resources

The resources resource is used to view, create, and update a resource. A resource is a person within the deploying company who can be assigned work to accomplish business objectives, such as sales persons or partner members.

Columns


Name	Type	References	Description
ResourceProfileId [KEY]	Long		Unique identifier for the Resource Profile.
CreatedBy	String		Who column: indicates the user who created the row.
CreationDate	Datetime		Who column: indicates the date and time of the creation of the row.
DeleteFlag	Bool		Indicates if the user can delete the resource.
EmailAddress	String		E-mail address
EndDateActive	Date		Indicates the date at which the resource becomes inactive
FormattedAddress	String		Primary Formatted address for the resource
FormattedPhoneNumber	String		Primary Formatted phone number for the resource
JobMeaning	String		Job for this resource if it is employee
LastUpdateDate	Datetime		Who column: indicates the date and time of the last update of the row.
LastUpdateLogin	String		Who column: indicates the session login associated to the user who last updated the row.
LastUpdatedBy	String		Who column: indicates the user who last updated the row.
Manager	String		Name of the manager for this resource
ManagerPartyId	Long
PartyId	Long		Identifier for the party. Foreign key to the HZ_PARTIES PARTY_ID.
PartyName	String		Name of the Party
PartyNumber [KEY]	String		Unique identification number for this party
PersonFirstName	String		Peron First Name
PersonLastName	String		Peron LastName
PersonLastNamePrefix	String		Resource Peron Last name
PersonMiddleName	String		Peron Middle Name.
PersonNameSuffix	String		Peron Name suffix
PersonPreNameAdjunct	String		Person Preferred Name adjacency
PersonPreviousLastName	String		perin Previous flag mage
PersonSecondLastName	String		peron secind last name
PrimaryOrganization	String		Primary organizations for this resource
RecordSet	String
ResourceType	String		Type of Resource ex employee
StartDateActive	Date		Indicates the date at which the resource becomes active
UpdateFlag	Bool		Indicates if the user can update the resource.
Url	String		Primary URL for the resource
Usage	String		Read only party usage for resource party

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String		Input specifying the Finder type.
BindSysdate	String		The identifier for the resource based on the manager reports flag.

ResourceUsersResourceRoleAssignments

The resource role assignments resource is used to view the role assigned to a resource, such as implementer, reseller, and so on.

Columns


Name	Type	References	Description
RoleRelateId [KEY]	Long		Role Relation identifier (PK)
ResourceProfileId [KEY]	String	ResourceUsers.ResourceProfileId	ResourceProfileId
EndDateActive	Date		Date this role-resource becomes inactive
PartyName	String		PartyName
RoleCode	String		RoleCode
RoleId	Long		Role identifier (foreign key to JTF_RS_ROLES)
RoleResourceId	Long		Resource identifier (foreign key to HZ_PARTIES) or (foreign key to JTF_RS_GROUPS_MEMBERS or (foreign key to JTF_RS_TEAM_MEMBERS)
StartDateActive	Date		Date this role-resource becomes active

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String		Input specifying the Finder type.
BindPartyId	String		The unique primary key identifier of the party associated with the resource.
ResourcePartyNumber	String		Input specifying the ResourcePartyNumber type.

SalesLeadAttachments

The attachment resource is used to view, create, and update attachments of a sales lead.

Columns


Name	Type	References	Description
AttachedDocumentId [KEY]	Long		The unique identifier of the attached document.
LeadId [KEY]	String	SalesLeads.LeadId	LeadId
AsyncTrackerId	String		Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
CategoryName	String		The category of the attachment.
ContentRepositoryFileShared	Bool		Indicates whether the attachment is shared
CreatedBy	String		The user who created the record.
CreatedByUserName	String		The user name who created the record.
CreationDate	Datetime		The date when the record was created.
DatatypeCode	String		A value that indicates the data type.
Description	String		The description of the attachment.
DmDocumentId	String		The document ID from which the attachment is created.
DmFolderPath	String		The folder path from which the attachment is created.
DmVersionNumber	String		The document version number from which the attachment is created.
DownloadInfo	String		JSON object represented as a string containing information used to programmatically retrieve a file attachment.
ErrorStatusCode	String		The error code, if any, for the attachment.
ErrorStatusMessage	String		The error message, if any, for the attachment.
ExpirationDate	Datetime		The expiration date of the contents in the attachment.
FileContents	String		The contents of the attachment.
FileName	String		The file name of the attachment.
FileUrl	String		The URI of the file.
FileWebImage	String		The base64 encoded image of the file displayed in .png format if the source is a convertible image.
LastUpdateDate	Datetime		The date when the record was last updated.
LastUpdatedBy	String		The user who last updated the record.
LastUpdatedByUserName	String		The user name who last updated the record.
PostProcessingAction	String		The name of the action that can be performed after an attachment is uploaded.
Title	String		The title of the attachment.
UploadedFileContentType	String		The content type of the attachment.
UploadedFileLength	Long		The size of the attachment file.
UploadedFileName	String		The name to assign to a new attachment file.
UploadedText	String		The text content for a new text attachment.
Uri	String		The URI of a Topology Manager type attachment.
Url	String		The URL of a web page type attachment.
UserName	String		The login credentials of the user who created the attachment.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String		Input specifying the Finder type.
ContactId	String		The unique identifier of the Contact.
SysEffectiveDate	String		SysEffectiveDate.
ResourcePartyIdRest	String		The unique identifier of the Resource.
RestCreationDateLower	String		Finds the leads that are created before the date specified.
RestCreationDateUpper	String		Finds the leads with the specified creation date.
RestRecordSet	String		Finds the leads with the specified record set value.
RestStatusCode	String		Finds the leads with the specified status code.
Name	String		Finds the leads with the specified name.
LeadNumber	String		Finds the leads with the specified lead number.

SalesLeadsLeadOpportunity

The opportunity resource is used to view, create, or modify an opportunity generated from a lead. An opportunity list associated with the lead represents leads that have already been converted to the list of opportunities.

Columns


Name	Type	References	Description
LeadNumber [KEY]	String		LeadNumber
LeadId [KEY]	String	SalesLeads.LeadId	LeadId
Account	String		Account
Currency	String		Currency
ExpectedAmount	Long		ExpectedAmount
LeadName	String		LeadName
OptyCloseDate	Datetime		OptyCloseDate
OptyId	Long		OptyId
OptyName	String		OptyName
OptyNumber	String		OptyNumber
OptyStatus	String		OptyStatus
RevenueAmount	Long		RevenueAmount
SalesStageId	Long		SalesStageId
SalesStageName	String		SalesStageName
WinProbability	Long		WinProbability

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String		Input specifying the Finder type.
ContactId	String		The unique identifier of the Contact.
SysEffectiveDate	String		SysEffectiveDate.
ResourcePartyIdRest	String		The unique identifier of the Resource.
RestCreationDateLower	String		Finds the leads that are created before the date specified.
RestCreationDateUpper	String		Finds the leads with the specified creation date.
RestRecordSet	String		Finds the leads with the specified record set value.
RestStatusCode	String		Finds the leads with the specified status code.
Name	String		Finds the leads with the specified name.

SalesLeadsLeadTeam

The lead teams resource is used to view the team members and territory team members associated with a lead.

Columns


Name	Type	References	Description
LeadTeamId [KEY]	Long		LeadTeamId
LeadId [KEY]	String	SalesLeads.LeadId	LeadId
AccessLevelCode	String		AccessLevelCode
AddedOnDateTime	Datetime		AddedOnDateTime
City	String		City
ConflictId	Long		ConflictId
Country	String		Country
CreatedBy	String		CreatedBy
CreationDate	Datetime		CreationDate
EmailAddress	String		EmailAddress
FormattedPhoneNumber	String		FormattedPhoneNumber
FunctionCode	String		FunctionCode
FunctionalRole	String		FunctionalRole
LastUpdateDate	Datetime		LastUpdateDate
LastUpdateLogin	String		LastUpdateLogin
LastUpdatedBy	String		LastUpdatedBy
LeadNumber	String		LeadNumber
LeadResourceId	Long		LeadResourceId
OwnerFlag	Bool		OwnerFlag
PartyId	Long		PartyId
PartyName	String		PartyName
PartyNumber	String		PartyNumber
PrimaryFlag	Bool		PrimaryFlag
PrimaryPhoneNumber	String		PrimaryPhoneNumber
PrimaryPhonePurpose	String		PrimaryPhonePurpose
ResourceId	Long		ResourceId
ResourceRoleName	String		ResourceRoleName
State	String		State
TerritoryFunctionCode	String		TerritoryFunctionCode
TerritoryName	String		TerritoryName
TerritoryNumber	String		TerritoryNumber
TerritoryOwnerFlag	Bool		TerritoryOwnerFlag
TerritoryVersionId	Double		TerritoryVersionId
TypeCode	String		TypeCode

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String		Input specifying the Finder type.
ContactId	String		The unique identifier of the Contact.
SysEffectiveDate	String		SysEffectiveDate.
ResourcePartyIdRest	String		The unique identifier of the Resource.
RestCreationDateLower	String		Finds the leads that are created before the date specified.
RestCreationDateUpper	String		Finds the leads with the specified creation date.
RestRecordSet	String		Finds the leads with the specified record set value.
RestStatusCode	String		Finds the leads with the specified status code.
Name	String		Finds the leads with the specified name.

SalesLeadsProductGroups

The product groups resource is used to capture the name of the product group associated with the sales lead.

Columns


Name	Type	References	Description
ProdGroupId [KEY]	Long		ProdGroupId
LeadId [KEY]	String	SalesLeads.LeadId	LeadId
Description	String		Description
DisplayName	String		DisplayName
LastUpdateDate	String		LastUpdateDate
ModelConfigAttributes	String		ModelConfigAttributes
ModelName	String		ModelName
QuotableFlag	Bool		QuotableFlag
ReferenceNumber	String		ReferenceNumber

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String		Input specifying the Finder type.
ContactId	String		The unique identifier of the Contact.
SysEffectiveDate	String		SysEffectiveDate.
ResourcePartyIdRest	String		The unique identifier of the Resource.
RestCreationDateLower	String		Finds the leads that are created before the date specified.
RestCreationDateUpper	String		Finds the leads with the specified creation date.
RestRecordSet	String		Finds the leads with the specified record set value.
RestStatusCode	String		Finds the leads with the specified status code.
Name	String		Finds the leads with the specified name.
LeadNumber	String		Finds the leads with the specified lead number.

SalesLeadsProducts

The product resource is used to capture the name of the product associated with the sales lead.

Columns


Name	Type	References	Description
InventoryItemId [KEY]	Long		InventoryItemId
InvOrgId [KEY]	Long		InvOrgId
LeadId [KEY]	String	SalesLeads.LeadId	LeadId
ActiveFlag	Bool		ActiveFlag
CSSEnabled	String		CSSEnabled
Description	String		Description
EndDate	Datetime		EndDate
LastUpdateDate	Datetime		LastUpdateDate
LongDescription	String		LongDescription
ProdGroupId	Long		ProdGroupId
ProductNum	String		ProductNum
ProductType	String		ProductType
ServiceRequestEnabledCode	String		ServiceRequestEnabledCode
StartDate	Datetime		StartDate
Text	String		Text

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String		Input specifying the Finder type.
ContactId	String		The unique identifier of the Contact.
SysEffectiveDate	String		SysEffectiveDate.
ResourcePartyIdRest	String		The unique identifier of the Resource.
RestCreationDateLower	String		Finds the leads that are created before the date specified.
RestCreationDateUpper	String		Finds the leads with the specified creation date.
RestRecordSet	String		Finds the leads with the specified record set value.
RestStatusCode	String		Finds the leads with the specified status code.
Name	String		Finds the leads with the specified name.
LeadNumber	String		Finds the leads with the specified lead number.

SalesLeadTerritories

The sales lead territories resource is used to view the associated sales lead territories.

Columns


Name	Type	References	Description
LeadTerritoryId [KEY]	Long		LeadTerritoryId
LeadId [KEY]	String	SalesLeads.LeadId	LeadId
ConflictId	Long		ConflictId
CreatedBy	String		CreatedBy
CreationDate	Datetime		CreationDate
LastUpdateDate	Datetime		LastUpdateDate
LastUpdateLogin	String		LastUpdateLogin
LastUpdatedBy	String		LastUpdatedBy
Name	String		Name
OwnerPartyNumber	String		OwnerPartyNumber
PartnerPartyId	Long		PartnerPartyId
PartnerPartyName	String		PartnerPartyName
PartyId	Long		PartyId
PartyName	String		PartyName
TerritoryId	Long		TerritoryId
TerritoryNumber	String		TerritoryNumber
TerritoryVersionId	Long		TerritoryVersionId
TypeCode	String		TypeCode

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String		Input specifying the Finder type.
ContactId	String		The unique identifier of the Contact.
SysEffectiveDate	String		SysEffectiveDate.
ResourcePartyIdRest	String		The unique identifier of the Resource.
RestCreationDateLower	String		Finds the leads that are created before the date specified.
RestCreationDateUpper	String		Finds the leads with the specified creation date.
RestRecordSet	String		Finds the leads with the specified record set value.
RestStatusCode	String		Finds the leads with the specified status code.
LeadNumber	String		Finds the leads with the specified lead number.

ServiceDetails

Usage information for the operation ServiceDetails.rsd.

Columns


Name	Type	References	Description
ServiceId [KEY]	Long
CreatedBy	String
CreationDate	Datetime
EstimatedStartTime	Datetime
LastAvailDate	Datetime
LastUpdateDate	Datetime
LastUpdateLogin	String
LastUpdatedBy	String
ProviderId	Long
ProviderName	String
ServiceName	String
ServiceStateCd	String

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Finder	String		Input specifying the Finder type.

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

Property	Description
HostURL	The URL to the Oracle Sales server used for logging in.
Username	The username of the Oracle Sales account used to authenticate to the server.
Password	Specifies the password of the authenticating user account.

Connection

Property	Description
IncludeCustomFields	Specifies whether custom fields must be dynamically retrieved for existing tables. With this property set to false only standard columns will be displayed for a given table.
IncludeCustomObjects	Specifies whether custom objects must be dynamically retrieved or not. Custom tables will not be displayed unless this property is set to true.

SSL

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Proxy

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Miscellaneous

Property	Description
ExpandFields	Determines whether the driver will leave the fields URL parameter blank when doing SELECT * queries.
GenerateSchemaFiles	Indicates the user preference as to when schemas should be generated and saved.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	Specifies the maximum number of results to return from Oracle Sales, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

Property	Description
HostURL	The URL to the Oracle Sales server used for logging in.
Username	The username of the Oracle Sales account used to authenticate to the server.
Password	Specifies the password of the authenticating user account.

HostURL

The URL to the Oracle Sales server used for logging in.

Remarks

The URL to the Oracle Sales server used for logging in.

Username

The username of the Oracle Sales account used to authenticate to the server.

Remarks

Together with Password, this field is used to authenticate to the Oracle Sales server specified in HostURL.

Password

Specifies the password of the authenticating user account.

Remarks

The authenticating server requires both User and Password to validate the user's identity.

Connection

This section provides a complete list of the Connection properties you can configure in the connection string for this provider.

Property	Description
IncludeCustomFields	Specifies whether custom fields must be dynamically retrieved for existing tables. With this property set to false only standard columns will be displayed for a given table.
IncludeCustomObjects	Specifies whether custom objects must be dynamically retrieved or not. Custom tables will not be displayed unless this property is set to true.

IncludeCustomFields

Specifies whether custom fields must be dynamically retrieved for existing tables. With this property set to false only standard columns will be displayed for a given table.

Remarks

See Custom Fields and Objects for detailed information.

IncludeCustomObjects

Specifies whether custom objects must be dynamically retrieved or not. Custom tables will not be displayed unless this property is set to true.

Remarks

See Custom Fields and Objects for detailed information.

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:


Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Firewall

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

FirewallType

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

The following table provides port number information for each of the supported protocols.


Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to Oracle Sales. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to Oracle Sales. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5	1080	The port where the Sync App sends data to Oracle Sales. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

FirewallServer

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPort

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallUser

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPassword

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Proxy

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

ProxyAutoDetect

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

ProxyServer

The hostname or IP address of the proxy server that you want to route HTTP traffic through.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

ProxyPort

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

ProxyAuthScheme

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

The authentication type can be one of the following:

BASIC: The Sync App performs HTTP BASIC authentication.
DIGEST: The Sync App performs HTTP DIGEST authentication.
NTLM: The Sync App retrieves an NTLM token.
NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
NONE: Set this when the ProxyServer does not require authentication.

For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

ProxyUser

The username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyUser
BASIC	The user name of a user registered with the proxy server.
DIGEST	The user name of a user registered with the proxy server.
NEGOTIATE	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NTLM	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NONE	Do not set the ProxyPassword connection property.

The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.

ProxyPassword

The password associated with the user specified in the ProxyUser connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyPassword
BASIC	The password associated with the proxy server user specified in ProxyUser.
DIGEST	The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE	The password associated with the Windows user account specified in ProxyUser.
NTLM	The password associated with the Windows user account specified in ProxyUser.
NONE	Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.

ProxySSLType

The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :


AUTO	Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

ProxyExceptions

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

LogModules

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is %APPDATA%\\CData\\OracleSalesCloud Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:


Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

Property	Description
ExpandFields	Determines whether the driver will leave the fields URL parameter blank when doing SELECT * queries.
GenerateSchemaFiles	Indicates the user preference as to when schemas should be generated and saved.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	Specifies the maximum number of results to return from Oracle Sales, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

ExpandFields

Determines whether the driver will leave the fields URL parameter blank when doing SELECT * queries.

Remarks

If ExpandFields is set to false, then the driver will leave the fields URL parameter blank when doing SELECT * queries. The field parameter filters the resource attributes. On child tables, you experience a slight hit on performance if performing a SELECT * on those tables as information from the parent tables will also be returned from Oracle Sales Cloud's API if the fields parameter is not specified. When ExpandFields is set to true, only default specified attributes are returned.

GenerateSchemaFiles

Indicates the user preference as to when schemas should be generated and saved.

Remarks

This property outputs schemas to .rsd files in the path specified by Location.

Available settings are the following:

Never: A schema file will never be generated.
OnUse: A schema file will be generated the first time a table is referenced, provided the schema file for the table does not already exist.
OnStart: A schema file will be generated at connection time for any tables that do not currently have a schema file.
OnCreate: A schema file will be generated by when running a CREATE TABLE SQL query.

Note that if you want to regenerate a file, you will first need to delete it.

Generate Schemas with SQL

When you set GenerateSchemaFiles to OnUse, the Sync App generates schemas as you execute SELECT queries. Schemas are generated for each table referenced in the query.

When you set GenerateSchemaFiles to OnCreate, schemas are only generated when a CREATE TABLE query is executed.

Generate Schemas on Connection

Another way to use this property is to obtain schemas for every table in your database when you connect. To do so, set GenerateSchemaFiles to OnStart and connect.

MaxRows

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Remarks

This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Other

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting


DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

Pagesize

Specifies the maximum number of results to return from Oracle Sales, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.

Remarks

You may want to adjust the default pagesize to optimize results for a particular object or service endpoint you are querying. Be aware that increasing the page size may improve performance, but it could also result in higher memory consumption per page.

PseudoColumns

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Remarks

This property allows you to define which pseudocolumns the Sync App exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Remarks

This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

UserDefinedViews

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:

{
	"MyView": {
		"query": "SELECT * FROM Opportunities WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.

Oracle Sales Connector for CData Sync

Oracle Sales Connector for CData Sync

Overview

Oracle Sales Version Support

Establishing a Connection

Adding a Connection to Oracle Sales

Custom Fields and Objects

Including Custom Fields

Including Custom Objects

Generating Schema Files

Advanced Features

User Defined Views

SSL Configuration

Firewall and Proxy

Query Processing

Logging

SSL Configuration

Customizing the SSL Configuration

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Tables

Tables

Oracle Sales Connector for CData Sync Tables

AccountAddresses

Columns

Pseudo-Columns

AccountAddressPurposes

Columns

Pseudo-Columns

AccountContactPoints

Columns

Pseudo-Columns

AccountNotes

Columns

Pseudo-Columns

AccountOrganizationContacts

Columns

Pseudo-Columns

AccountPrimaryAddresses

Columns

Pseudo-Columns

AccountRelationships

Columns

Pseudo-Columns

AccountResources

Columns

Pseudo-Columns

Accounts

Columns

Pseudo-Columns

Activities

Columns

Pseudo-Columns

ActivityAssignees

Columns

Pseudo-Columns

ActivityContacts

Columns

Pseudo-Columns

ActivityNotes

Columns

Pseudo-Columns

ActivityObjectives

Columns

Pseudo-Columns

Assets

Columns

Pseudo-Columns

CompetitorAccounts

Columns

Pseudo-Columns

ContactAddresses

Columns

Pseudo-Columns

ContactAddressPurposes

Columns

Pseudo-Columns