7 Oracle CRM On Demand Objects Accessible Through Web Services

Child Components

Account, Attachment, Book, Contact, Opportunity, Portfolio, and Team.

CustomObject1, CustomObject2, and CustomObject3 also have child components for the other CustomObjects as follow:

CustomObject1. CustomObject2 and CustomObject3 child components.
CustomObject2. CustomObject1 and CustomObject3 child components.
CustomObject3. CustomObject1 and CustomObject2 child components.

For information about using attachments with these objects, see Using Attachments with Web Services On Demand

Note: For CustomObject3 only, the following fields are accessible: CustomObject5Id, CustomObject5Name, CustomObject5ExternalSystemId.

Methods Called

The following table details the methods called by the CustomObject1 service. The methods for CustomObject2 and CustomObject3 follow the same pattern.

Table Methods Called by CustomObJect1 Service

Method	Name as Defined in Service
Delete	CustomObject1Delete
DeleteChild	CustomObject1DeleteChild
Insert	CustomObject1Insert
InsertChild	CustomObject1InsertChild
InsertOrUpdate	CustomObject1OrUpdate
QueryPage	CustomObject1Page
Update	CustomObject1Update
UpdateChild	CustomObject1UpdateChild

Fields

The following table details the required and read-only fields for the CustomObject1 object. The fields for CustomObject2 and CustomObject3 follow a similar pattern.

Table Required and Read-Only Fields for the CustomObject1 Object

Child Component	Field Name	Type
CustomObject1 (parent)	ParentId	Required
	ParentExternalSystemID	Required
	ParentIntegrationId	Required
	ParentObject1Id	Read-only
Account	CObj1AccountCreatedById	Read-only
	CObj1AccountCreatedDate	Read-only
	CObj1AccountModifiedById	Read-only
	CObj1AccountModifiedDate	Read-only
	Region	Read-only
	AccountType	Read-only
Attachment	DisplayFileName	Required
	FileNameOrURL	Required
	FileDate	Read-only
	FileSize	Read-only
	CustomObjectId	Read-only
	Id	Read-only
	ModId	Read-only
	Audit Fields	Read-only
Book	BookName	Required
	BookId	Read-only
	SystemAssociateFlag	Read-only
	ModId	Read-only
	Audit Fields	Read-only
Contact	CObj1ContactCreatedById	Read-only
	CObj1ContactCreatedDate	Read-only
	CObj1ContactModifiedById	Read-only
	CObj1ContactModifiedDate	Read-only
	ContactFirstName	Read-only
	ContactLastName	Read-only
	ContactType	Read-only
CustomObject2	CObj1CustomObject2CreatedById	Read-only
	CObj1CustomObject2CreatedDate	Read-only
	CObj1CustomObject2ModifiedById	Read-only
	CObj1CustomObject2ModifiedDate	Read-only
	CustomObject2Id	Read-only
CustomObject3	CObj1CustomObject3CreatedById	Read-only
	CObj1CustomObject3CreatedDate	Read-only
	CObj1CustomObject3ModifiedById	Read-only
	CObj1CustomObject3ModifiedDate	Read-only
	CustomObject3Id	Read-only
Opportunity	AccountName	Read-only
	CObj1OpportunityCreatedById	Read-only
	CObj1OpportunityCreatedDate	Read-only
	CObj1OpportunityModifiedById	Read-only
	CObj1OpportunityModifiedDate	Read-only
	OpportunityName	Read-only
	Revenue	Read-only
	SalesStage	Read-only
Portfolio	AccountNumber	Read-only
	CObj1PortfolioCreatedById	Read-only
	CObj1PortfolioCreatedDate	Read-only
	CObj1PortfolioModifiedById	Read-only
	CObj1PortfolioModifiedDate	Read-only
	Revenue	Read-only
Team	CustomObject1TeamId	Read-only
	UserFirstName	Read-only
	UserLastName	Read-only

The following table details the status key for the CustomObject1 object. The status keys for CustomObject2 and CustomObject3 follow a similar pattern.

Table Status Key for the CustomObject1 Object

Child Component	Field Name
CustomObject1 (parent)	Audit Fields
	CustomObject1Id
	ExternalSystemId
	IntegrationId
Account	CustomObject1AccountId
	CObj1AccountCreatedById
	CObj1AccountCreatedDate
	CObj1AccountModifiedById
	CObj1AccountModifiedDate
Attachment	Audit Fields
	Id
	CustomObjectId
Book	Audit Fields
	BookId
	ModId
Contact	CustomObject1ContactId
	CObj1ContactCreatedById
	CObj1ContactCreatedDate
	CObj1ContactModifiedById
	CObj1ContactModifiedDate
CustomObject2	CustomObject2Id
	CObj1CustomObject2CreatedById
	CObj1CustomObject2CreatedDate
	CObj1CustomObject2ModifiedById
	CObj1CustomObject2ModifiedDate
CustomObject3	CustomObject3Id
	CObj1CustomObject3CreatedById
	CObj1CustomObject3CreatedDate
	CObj1CustomObject3ModifiedById
	CObj1CustomObject3ModifiedDate
Opportunity	OpportunityId
	CObj1OpportunityCreatedById
	CObj1OpportunityCreatedDate
	CObj1OpportunityModifiedById
	CObj1OpportunityCreatedDate
Portfolio	PortfolioId
	CObj1PortfolioCreatedById
	CObj1PortfolioCreatedDate
	CObj1PortfolioModifedById
	CObj1PortfolioModifiedDate
Team	Audit Fields
Team	CustomObject1TeamId

The following table details the pick map fields for the CustomObject1 object. The fields for CustomObject2 and CustomObject3 follow a similar pattern.

Table Pick Map Fields for the CustomObject1 Object

Child Component	Pick Map Field	Maps To
CustomObject1 (parent)	AccountExternalId	AccountId
	AccountIntegrationId	AccountId
	AccountName	AccountId
	ActivityExternalId	ActivityId
	ActivityIntegrationId	ActivityId
	ActivityName	ActivityId
	CampaignExternalId	CampaignId
	CampaignIntegrationId	CampaignId
	CampaignName	CampaignId
	ContactExternalId	ContactId
	ContactFirstName	ContactId
	ContactFullName	ContactId
	ContactIntegrationId	ContactId
	ContactLastName	ContactId
	CustomObject2ExternalId	CustomObject2Id
	CustomObject2IntegrationId	CustomObject2Id
	CustomObject2Name	CustomObject2Id
	CustomObject3ExternalId	CustomObject3Id
	CustomObject3IntegrationId	CustomObject3Id
	CustomObject3Name	CustomObject3Id
	DealerName	DealerId
	HouseholdExternalId	HouseholdId
	HouseholdIntegrationId	HouseholdId
	HouseholdName	HouseholdId
	LeadExternalId	LeadId
	LeadFirstName	LeadId
	LeadFullName	LeadId
	LeadIntegrationId	LeadId
CustomObject1 (cont.)	LeadLastName	LeadId
	Owner	OwnerId
	OpportunityExternalId	OpportunityId
	OpportunityIntegrationId	OpportunityId
	OpportunityName	OpportunityId
	ParentExternalSystemId	ParentId
	ParentIntegrationId	ParentId
	PortfolioAccountNumber	PortfolioId
	ProductExternalId	ProductId
	ProductIntegrationId	ProductId
	ProductName	ProductId
	SolutionExternalId	SolutionId
	SolutionIntegrationId	SolutionId
	SolutionTitle	SolutionId
	ServiceRequestExternalId	ServiceRequestId
	ServiceRequestIntegrationId	ServiceRequestId
	ServiceRequestName	ServiceRequestId
	VIN	VehicleId
Account	ExternalSystemId	AccountId
	IntegrationId	AccountId
	Location	AccountId
	Name	AccountId
Book	BookName	BookId
Contact	ExternalSystemId	ContactId
Contact	IntegrationId	ContactId
CustomObject2	Owner	OwnerId
CustomObject3	Owner	OwnerId
Opportunity	ExternalSystemId	OpportunityId
Opportunity	IntegrationId	OpportunityId
Portfolio	ExternalSystemId	PortfolioId
Portfolio	IntegrationId	PortfolioId
Team	UserExternalSystemId	UserId
	UserIntegrationId	UserId
	UserEmail	UserId

The following table provides a list of the filterable fields for the child components of the CustomObject1 object, and a list of user key combinations for each child component. The fields for CustomObject2 and CustomObject3 follow a similar pattern.

Table Filterable Fields and User Key Fields on the CustomObject1 Object’s Child Components

Child Components	Filterable Fields	User Key Field Combinations
CustomObject1 (parent)	All	CustomObject1Id
		ExternalSystemId
		IntegrationId
Account	AccountId	CustomObject1AccountId
	AccountType	ExternalSystemId
	CObj1AccountModifiedById	IntegrationId
	CObj1AccountModifiedDate
	ExternalSystemId
	IntegrationId
	Location
	Name
	Region
Attachment	None	Id
		ExternalSystemId
		FileNameOrURL and FileExtension
Book	None	BookId
Book	None	BookName
Contact	ContactId	CustomObject1ContactId
	CObj1ContactModifiedById	ExternalSystemId
	CObj1ContactModifiedDate	IntegrationId
	ContactType
	ExternalSystemId
	IntegrationId
CustomObject2	CustomObject2Id	CustomObject2Id
	CObj1CustomObject2ModifiedById	ExternalSystemId
	CObj1CustomObject2ModifiedDate	IntegrationId
	ExternalSystemId
	IntegrationId
	Name
	Type
CustomObject3	CustomObject3Id	CustomObject3Id
	CObj1CustomObject3ModifiedById	ExternalSystemId
	CObj1CustomObject3ModifiedDate	IntegrationId
	ExternalSystemId
	IntegrationId
	Name
	Type
Opportunity	CObj1OpportunityModifiedById	OpportunityId
	CObj1OpportunityModifiedDate	ExternalSystemId
	ExternalSystemId	IntegrationId
	IntegrationId
	OpportunityId
Portfolio	CObj1PortfolioModifiedById	PortfolioId
	CObj1PortfolioModfiedDate	ExternalSystemId
	ExternalSystemId	IntegrationId
	IntegrationId
	PortfolioId
Team	CustomObject1TeamId	CustomObject1TeamId
	UserEmail	UserExternalSystemId
	UserExternalSystemId	UserIntegrationId
	UserId
	UserIntegrationId

The following table details the picklists available for the CustomObject1 object. The fields for CustomObject2 and CustomObject3 follow a similar pattern.

Table Picklists Available for the CustomObject1 Object

Child Component	Field Name
Dealer	Type
Household	Type
Portfolio	Type
Vehicle	Type

Lead

The lead object stores information on a company or individual with whom an opportunity can be created. It allows the user to identify the companies that might be interested in a product or service. Leads are usually generated as part of a marketing campaign.

Parent Objects

Account, Campaign, Contact, Opportunity, Team

Child Components

Activity, Attachment, Book, Campaign.

For information about using attachments with this object, see Using Attachments with Web Services On Demand

Methods Called

The following table details the methods called by the Lead service.

Table Methods Called by Lead Service

Method	Name as Defined in Service
Delete	LeadDelete
DeleteChild	LeadDeleteChild
Insert	LeadInsert
InsertChild	LeadInsertChild
InsertOrUpdate	LeadInsertOrUpdate
QueryPage	LeadQueryPage
Update	LeadUpdate
UpdateChild	LeadUpdateChild

Fields

The following table details the required and read-only fields for the lead object.

Table Required and Read-Only Fields for the Lead Object

Child Component	Field Name	Type
Lead (parent)	FirstName	Required
	LastName	Required
	LeadOwner	Required
	ContactFullName	Read-only
	Audit Fields	Read-only
	LastUpdated	Read-only
	LeadConcatField	Read-only
	LeadFullName	Read-only
	ReferredById	Read-only
Activity	AccountLocation	Read-only
	CreatedDetail	Read-only
	Lead	Read-only
	LeadExternalId	Read-only
	MEEventName	Read-only
	CreatedbyEmailAddress	Read-only
	ModifiedbyEmailAddress	Read-only
	DescriptionShadow	Read-only
	Duration	Read-only
	Audit Fields	Read-only
Attachment	DisplayFileName	Required
	FileNameOrURL	Required
	FileDate	Read-only
	FileSize	Read-only
	LeadId	Read-only
	Id	Read-only
	ModId	Read-only
	Audit Fields	Read-only
Book	BookName	Required
	BookId	Read-only
	SystemAssociateFlag	Read-only
	ModId	Read-only
	Audit Fields	Read-only

The following table details the status key for the lead object.

Table Status Key for the Lead Object

Child Component	Field Name
Lead (parent)	Audit Fields
	AccountId
	CampaignId
	ContactId
	ExternalSystemId
	Id
	IntegrationId
	LastUpdated
	OpportunityId
Activity	Audit Fields
	ExternalSystemId
	Id
	IntegrationId
	LeadId
Attachment	Audit Fields
	Id
	LeadId
Book	Audit Fields
	BookId
	ModId

The following table details the pick map fields for the lead object.

Table Pick Map Fields for the Lead Object

Child Component	Pick Map Field	Maps To
Lead (parent)	Campaign	CampaignId
	OpportunityName	OpportunityId
	Owner	OwnerId
	AccountExternalSystemId	AccountId
	OpportunityExternalSystemId	OpportunityId
	ContactExternalSystemId	ContactId
	CampaignExternalSystemId	CampaignId
	ReferredByExternalSystemId	ReferredById
Activity	AccountIntegrationId	AccountId
	AccountExternalId	AccountId
	Address	AddressId
	AssignedTo	AssignedToId
	CampaignExternalId	CampaignId
	CampaignIntegrationId	CampaignId
	DelegatedBy	DelegatedById
	Dealer	DealerId
	FundRequest	FundRequestId
	OpportunityIntegrationId	OpportunityId
	OpportunityExternalId	OpportunityId
	PrimaryContactIntegrationId	PrimaryContactId
	PrimaryContactExternalId	PrimaryContactId
	LeadIntegrationId	LeadId
	LeadExternalId	LeadId
	OwnerExternalId	OwnerId
	OwnerIntegrationId	OwnerId
	SRIntegrationId	SRId
	SRExternalId	SRId
	CustomObject1Name	CustomObject1Id
	CustomObject2Name	CustomObject2Id
	CustomObject3Name	CustomObject3Id
Book	BookName	BookId

The following table provides a list of the filterable fields for the child components of the lead object, and a list of user key combinations for each child component.

Table Filterable Fields and User Key Fields on the Lead Object’s Child Components

Child Components	Filterable Fields	User Key Field Combinations
Lead (parent)	All	LeadId
		IntegrationId
		ExternalSystemId
		LeadFirstName and LeadLastName
		Description
Activity	Type	Type and Description
	Owner	IntegrationId
	Subject	ExternalSystemId
	DueDate
	Priority
	Status
Attachment	None	Id
		ExternalSystemId
		FileNameOrURL and FileExtension
Book	None	BookId
Book	None	BookName
Partner	None	PartnerIntegrationId
Partner	None	PartnerExternalSystemId

The following table details the picklists available for the lead object.

Table Picklists Available for the Lead Object

Field Name
AssessmentCategory1 through AssessmentCategory4
Country
IndexedPick0 through IndexedPick5
LeadType
MrMrs
OwnershipStatus
Rating
Source
StateProvince
Status

For more information on the fields accessible through the Lead Web service, go to the Web Services Administration page within the Oracle CRM On Demand application and generate the WSDL file for the lead object.

Note

The note object stores information about the notes available in the Message Center in the Oracle CRM On Demand application. The notes can be sent from users or can store extra information (as a note) on a parent object. This allows employees who are working on a particular record to add extra information as they see fit. For example, when talking to a contact, an employee might notice that the contact is not happy with a service provided. The employee can record this information in a note so that any other employees who talk to the contact are aware of the contact’s dissatisfaction.

The note object has no child components.

Parent Objects

Account, Campaign, Contact, Opportunity, and Service Request

Methods Called

The following table details the methods called by the Note service.

Table Methods Called by Note Service

Method	Name as Defined in Service
Delete	NoteDelete
Insert	NoteInsert
InsertOrUpdate	NoteInsertOrUpdate
QueryPage	NoteQueryPage
Update	NoteUpdate

Fields

The following table details the required and read-only fields for the note object.

Table Required and Read-Only Fields for the Note Object

Child Component	Field Name	Type
Note (parent)	Subject	Required
	NoteId	Read-only
	OwnerId	Read-only
	OwnerAlias	Read-only
	ParentNoteId	Read-only
	SourceId	Read-only
	SourceName	Read-only
	Audit Fields	Read-only

The following table details the status key for the note object.

Table Status Key for the Note Object

Child Component	Field Name
Note (parent)	Audit Fields
Note (parent)	NoteId

The following table provides a list of the filterable fields and a list of user key combinations for the note object.

Table Filterable Fields and User Key Fields on the Note Object’s Child Components

Child Components	Filterable Fields	User Key Field Combinations
Note (parent)	All	NoteId

For more information on the fields accessible through the Note Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the note object.

Opportunity

The opportunity object allows employees to identify and record a potential revenue-generating event that has arisen with an account or contact. Opportunities can be generated from marketing campaigns when leads indicate that they are interested in a product or service that has been offered.

Parent Objects

Account, Campaign, Contact, Custom Object1 - Custom Object3

Child Components

Activity, Attachment, Book, Competitor, Contact, Lead, Note, and Opportunity Team.

Note: The Revenue child object for Opportunity is actually called Product.

For information about using attachments with this object, see Using Attachments with Web Services On Demand.

Methods Called

The following table details the methods called by the Opportunity service.

Table Methods Called by Opportunity Service

Method	Name as Defined in Service
Delete	OpportunityDelete
DeleteChild	OpportunityDeleteChild
Insert	OpportunityInsert
InsertChild	OpportunityInsertChild
InsertOrUpdate	OpportunityInsertOrUpdate
QueryPage	OpportunityQueryPage
Update	OpportunityUpdate
UpdateChild	OpportunityUpdateChild

Fields

The following table details the required and read-only fields for the opportunity object.

Table Required and Read-Only Fields for the Opportunity Object

Child Component	Field Name	Type
Opportunity (parent)	AccountId	Required
	CloseDate	Required
	OpportunityName	Required
	SalesStage	Required
	Audit Fields	Read-only
	LastUpdated	Read-only
	OpportunityConcatField	Read-only
Activity	AccountLocation	Read-only
	CreatedDetail	Read-only
	MEEventName	Read-only
	Opportunity	Read-only
	OpportunityIntegrationId	Read-only
	OpportunityExternalId	Read-only
	CreatedbyEmailAddress	Read-only
	ModifiedbyEmailAddress	Read-only
	DescriptionShadow	Read-only
	Duration	Read-only
	Audit Fields	Read-only
Attachment	DisplayFileName	Required
	FileNameOrURL	Required
	FileDate	Read-only
	FileSize	Read-only
	OpportunityId	Read-only
	Id	Read-only
	ModId	Read-only
	Audit Fields	Read-only
Book	BookName	Required
	BookId	Read-only
	SystemAssociateFlag	Read-only
	ModId	Read-only
	Audit Fields	Read-only
Competitor	CompetitorId	Required
	CompetitorExternalSystemId	Required
	ReverseRelationshipRole	Required
	RelationshipRole	Required
	StartDate	Required
	OpportunityCompetitorId	Read-only
Contact	Age	Read-only
	OwnerFullName	Read-only
	CreatedbyEmailAddress	Read-only
	ModifiedbyEmailAddress	Read-only
	LastActivityDate	Read-only
	FirstNameShadow	Read-only
	LastNameShadow	Read-only
OpportunityTeam	OpportunityAccess	Required
OpportunityTeam	UserId	Required
Partner	OpportunityPartnerId	Read-only
	PartnerExternalSystemId	Required
	ReverseRelationshipRole	Required
	RelationshipRole	Required
	StartDate	Required
Product	ProductRevenueId	Read-only
	ProductCategoryId	Read-only
	ProductCategory	Read-only
	ProductPartNumber	Read-only
	ProductStatus	Read-only
	ProductType	Read-only
	OpportunityId	Read-only
	OpportunityName	Read-only
	OpportunityIntegrationID	Read-only
	OpportunityExternalSystemId	Read-only
	OpportunitySalesStage	Read-only
	OpportunityAccountId	Read-only
	OpportunityAccountName	Read-only
	OpportunityAccountLocation	Read-only
	OpportunityAccountExternalSystemId	Read-only
	OpportunityAccountIntegrationId	Read-only
	ContactFirstName	Read-only
	ContactLastName	Read-only

The following table details the status key for the opportunity object.

Table Status Key for the Opportunity Object

Child Component	Field Name
Opportunity (parent)	Audit Fields
	AccountId
	ExternalSystemId
	Id
	IntegrationId
Activity	Audit Fields
	ExternalSystemId
	Id
	IntegrationId
	OpportunityId
Attachment	Audit Fields
	Id
	OpportunityId
Book	Audit Fields
	BookId
	ModId
Competitor	Audit Fields
	OpportunityCompetitorId
	CompetitorId
	CompetitorExternalSystemId
Contact	Audit Fields
	AccountId
	ContactId
	ExternalSystemId
	IntegrationId
	OpportunityId
Lead	Audit Fields
	AccountId
	ContactId
	ExternalSystemId
	IntegrationId
	LastUpdated
	LeadId
	OpportunityId
OpportunityNote	Audit Fields
	ExternalSystemId
	Id
	IntegrationId
	OpportunityId
Partner	Audit Fields
	OpportunityPartnerId
	PartnerId
	PartnerExternalSystemId
Product	Audit Fields
	ExternalId
	ProductRevenueId
	IntegrationID

The following table details the pick map fields for the opportunity object.

Table Pick Map Fields for the Opportunity Object

Child Component	Pick Map Field	Maps To
Opportunity (parent)	Owner	OwnerId
	AccountExternalSystemId	AccountId
	Territory	TerritoryId
	KeyContactIntegrationId	KeyContactId
	KeyContactExternalSystemId	KeyContactId
Activity	AccountIntegrationId	AccountId
	AccountExternalId	AccountId
	Address	AddressId
	AssignedTo	AssignedToId
	CampaignExternalId	CampaignId
	CampaignIntegrationId	CampaignId
	Dealer	DealerId
	DelegatedBy	DelegatedById
	FundRequest	FundRequestId
	OpportunityIntegrationId	OpportunityId
	OpportunityExternalId	OpportunityId
	PrimaryContactIntegrationId	PrimaryContactId
	PrimaryContactExternalId	PrimaryContactId
	LeadIntegrationId	LeadId
	LeadExternalId	LeadId
	OwnerExternalId	OwnerId
	OwnerIntegrationId	OwnerId
	SRIntegrationId	SRId
	SRExternalId	SRId
	CustomObject1Name	CustomObject1Id
	CustomObject2Name	CustomObject2Id
	CustomObject3Name	CustomObject3Id
Book	BookName	BookId
Contact	AccountExternalSystemlId	AccountId
	AccountIntegrationId	AccountId
	ManagerExternalSystemId	ManagerId
	ManagerIntegrationId	ManagerId
	OwnerEmailAddress	OwnerId
	OwnerExternalId	OwnerId
	OwnerIntegrationId	OwnerId
	SourceCampaignName	SourceCampaignId
	SourceCampaignExternalId	SourceCampaignId
	TimeZoneName	TimeZoneId
	CustomObject1Name	CustomObject1Id
	CustomObject2Name	CustomObject2Id
	CustomObject3Name	CustomObject3Id
Competitor	PrimaryContactName	ContactId
	PartnerExternalSystemId	PartnerId
	PartnerName	PartnerId
Partner	PrimaryContactName	ContactId
	CompetitorExternalSystemId	CompetitorId
	CompetitorName	CompetitorId
Product	ProductName	ProductId
	ProductExternalSystemId	ProductId
	ProductIntegrationId	ProductId
	ContactExternalSystemId	ContactId
	ContactIntegrationId	ContactId
	Owner	OwnerId
	CustomObject5Name	CustomObject5Id
	CustomObject5ExternalSystemId	CustomObject5Id
	CustomObject6Name	CustomObject6Id
	CustomObject6ExternalSystemId	CustomObject6Id

The following table provides a list of the filterable fields for the child components of the opportunity objects, and a list of user key combinations for each child component.

Table Filterable Fields and User Key Fields on the Opportunity Object’s Child Components

Child Components	Filterable Fields	User Key Field Combinations
Opportunity (parent)	All	OpportunityId
		IntegrationId
		ExternalSystemId
Activity	Type	Type and Description
	Owner	IntegrationId
	Subject	ExternalSystemId
	DueDate
	Priority
	Status
Attachment	None	Id
		ExternalSystemId
		FileNameOrURL and FileExtension
Book	None	BookId
Book	None	BookName
Competitor	OpportunityCompetitorId	OpportunityCompetitorId
	PrimaryContactId	CompetitorExternalSystemId
	EndDate	CompetitorId
	CompetitorId
	CompetitorExternalSystemId
	ReverseRelationshipRole
	RelationshipRole
	StartDate
	ModifiedDate
Contact	ContactType	AccountName and Private
	ContactFirstName	ContactFirstName and ContactLastName and Private
	JobTitle	IntegrationId
	ContactLastName	ExternalSystemId
	Owner
	Id
Lead	Campaign	IntegrationId
	EstimatedCloseDate	ExternalSystemId
	Rating
	Source
	Status
	LeadOwner
	PotentialRevenue
	ProductInterest
	SalesPerson
	LeadId
Note	Subject	Subject and Description
		IntegrationId
		ExternalSystemId
OpportunityTeam	UserFirstName	OpportunityTeamId
	UserLastName	UserId
	ModifiedDate	UserExternalSystemId
	OpportunityAccess	UserEmail
	OpportunityAccessId	UserAlias
	OpportunityTeamId
	TeamRole
	UserExternalSystemId
	UserId
Partner	OpportunityPartnerId	OpportunityPartnerId
	PrimaryContactId	PartnerExternalSystemId
	EndDate	PartnerId
	PartnerId
	PartnerExternalSystemId
	ReverseRelationshipRole
	RelationshipRole
	StartDate
	ModifiedDate
Product	OpportunityIntegrationId	ExternalSystemId
	OpportunityExternalSystemId	OpportunityIntegrationId
	OpportunitySalesStage	ProductRevenueId
	OpportunityAccountId	IntegrationId
	OpportunityAccountName
	OpportunityAccountLocation
	OpportunityAccountExternalSystemId
	OpportunityAccountIntegrationId
	ModifiedDate
	ContactId
	ContactExternalSystemId
	ContactIntegrationId
	Contract
	OwnerId
	Owner
	SerialNumber
	Revenue
	ExpectedRevenue
	Quantity
	PurchasePrice
	PurchaseDate
	StartCloseDate
	NumberOfPeriods
	Frequency
	Probability
	Forecast
	AssetValue
	Premium
	ShipDate
	Status
	Type
	Warranty
	ProductRevenueId
	ExternalSystemId
	IntegrationId
	ProductId
	ProductName
	ProductExternalSystemID
	ProductionIntegrationId
	ProductCategoryId
	ProductCategory
	ProductPartNumber
	ProductStatus
	ProductType
	OpportunityId
	OpportunityName

The following table details the picklists available for the opportunity object.

Table Picklists Available for the Opportunity Object

Child Component	Field Name
Opportunity (parent)	LeadSource
	Priority
	Probability
	ReasonWonLost
	Status
	Type
	Year
	Make
	Model
OpportunityTeam	TeamRole
Product	Frequency
	Probability
	Status
	Type
	Warranty
	Contract

For more information on the fields accessible through the Opportunity Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the opportunity object.

Product

The product object allows you to define and record details about a product or service that your company sells to its customers, including information on product price, category, and so on. The product object does not have any child objects.

Parent Objects

Account, Campaign and Contact

Methods Called

The following table details the methods called by the Product service.

Table Methods Called by Product Service

Method	Name as Defined in Service
Insert	ProductInsert
InsertOrUpdate	ProductInsertOrUpdate
QueryPage	ProductQueryPage
Update	ProductUpdate

Fields

All fields on the product object are filterable.

The following table details the required and read-only fields for the product object.

Table Required and Read-Only Fields for the Product Object

Child Component	Field Name	Type
Product (parent)	ProductName	Required
Product (parent)	Audit Fields	Read-only

The following table details the status key for the product object.

Table Status Key for the Product Object

Child Component	Field Name
Product (parent)	Audit Fields
	Id
	IntegrationId

The following table details the pick map field for the product object.

Table Pick Map Field for the Product Object

Pick Map Field	Maps To
ParentCategory	ParentCategoryId

The following table details the user keys for the product object.

Table User Keys for the Product Object

Child Component	Field Name
Product (parent)	ProductId
	IntegrationId
	ExternalSystemId

The following table details the picklists available for the product object.

Table Picklists Available for the Product Object

Field Name
BodyStyle
Category
Class
CurrencyCode
DoorStyle
Engine
Make
Model
PriceType
ProductType
Revision
Status
SubType
TherapeuticClass
Transmission
Trim

For more information on the fields accessible through the Product Web service, go to the Web Services Administration page within the Oracle CRM On Demand application and generate the WSDL file for the product object.

Product Category

The product category object allows you to logically sort products into groups, where each product is in some way related to the other products in the category. The product category object does not have any child objects.

Parent Objects

None

Methods Called

The following table details the methods called by the Product category service.

Table Methods Called by Product Category Service

Method	Name as Defined in Service
Delete	ProductCategoryDelete
Insert	ProductCategoryInsert
InsertOrUpdate	ProductCategoryInsertOrUpdate
QueryPage	ProductCategoryQueryPage
Update	ProductCategoryUpdate

Fields

All fields on the product category object are filterable.

The following table details the required and read-only fields for the product category object.

Table Required and Read-Only Fields for the Product Category Object

Child Component	Field Name	Type
ProductCategory	CategoryName	Required
	Audit Fields	Read-only
	ModifiedByFullName	Read-only

The following table details the status key for the product category object.

Table Status Key for the Product Category Object

Child Component	Field Name
ProductCategory	Audit Fields
	ExternalSystemId
	Id
	IntegrationId
	Name

The following table details the pick map field for the product category object.

Table Pick Map Field for the Product Category Object

Pick Map Field	Maps To
ParentCategory	ParentCategoryId

The following table details the user keys for the product category object.

Table User Keys for the Product Category Object

Child Component	Field Name
ProductCategory	ProductCategoryId
	IntegrationId
	ExternalSystemId
	Name

For more information on the fields accessible through the Product category Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the product category object.

Service Request

The service request object allows customers to request information or assistance with a problem related to products or services purchased from your company. Service requests can be ranked for severity and prioritized accordingly.

Parent Objects

Account, Contact, and Solution

Child Components

Activity, Attachment, Audit Trail, Book, Note, Solution, Team

For information about using attachments with this object, see Using Attachments with Web Services On Demand.

Methods Called

The following table details the methods called by the Service request service.

Table Methods Called by Service Request Service

Method	Name as Defined in Service
Delete	ServiceRequestDelete
DeleteChild	ServiceRequestDeleteChild
Insert	ServiceRequestInsert
InsertChild	ServiceRequestInsertChild
InsertOrUpdate	ServiceRequestInsertOrUpdate
QueryPage	ServiceRequestQueryPage
Update	ServiceRequestUpdate
UpdateChild	ServiceRequestUpdateChild

Fields

The following table details the required and read-only fields for the service request object.

Table Required and Read-Only Fields for the Service Request Object

Child Component	Field Name	Type
ServiceRequest (parent)	ContactEmail	Read-only
	ContactFirstName	Read-only
	ContactFullName	Read-only
	ContactLastName	Read-only
	Audit Fields	Read-only
	LastUpdated	Read-only
	ServiceRequestConcatId	Read-only
Attachment	DisplayFileName	Required
	FileNameOrURL	Required
	FileDate	Read-only
	FileSize	Read-only
	SRId	Read-only
	Id	Read-only
	ModId	Read-only
	Audit Fields	Read-only
Book	BookName	Required
	BookId	Read-only
	SystemAssociateFlag	Read-only
	ModId	Read-only
	Audit Fields	Read-only

The following table details the status key for the service request object.

Table Status Key for the Service Request Object

Child Component	Field Name
ServiceRequest (parent)	Audit Fields
	AccountId
	ContactId
	ExternalSystemId
	Id
	IntegrationId
	LastUpdated
Activity	Audit Fields
	ExternalSystemId
	Id
	IntegrationId
Attachment	Audit Fields
	Id
	SRId
Book	Audit Fields
	BookId
	ModId
ServiceRequestNote	Audit Fields
	ExternalSystemId
	Id
	LastUpdated
	ServiceRequestId
Solution	Audit Fields
	ExternalSystemId
	Id
	IntegrationId
	LastUpdated

The following table details the pick map fields for the service request object.

Table Pick Map Fields for the Service Request Object

Child Component	Pick Map Field	Maps To
Service Request (parent)	Owner	OwnerId
	AccountExternalSystemId	AccountId
	AssetIntegrationId	AssetId
	AssetExternalSystemId	AssetId
	ProductExternalSystemId	ProductId
Book	BookName	BookId

The following table provides a list of the filterable fields for the child components of the service request object, and a list of user key combinations for each child component.

Table Filterable Fields and User Key Fields on the Service Request Object’s Child Components

Child Component	Filterable Fields	User Key Field Combinations
Service Request (parent)	All	ServiceRequestId
		IntegrationId
		ExternalSystemId
		SRNumber
Activity	Type	Type and Description
	Owner	IntegrationId
	Subject	ExternalSystemId
	DueDate
	Priority
	Status
Attachment	None	Id
		ExternalSystemId
		FileNameOrURL and FileExtension
Audit Trail	Date	None
	User
	FieldModified
Book	None	BookId
Book	None	BookName
Service Request Note	Subject	Subject and Description
Service Request Note	Subject	ExternalSystemId
Solution	Title	Title
	Published	IntegrationId
	SolutionId	ExternalSystemId
	Status
	Id

The following table details the picklists available for the service request object.

Table Picklists Available for the Service Request Object

Field Name
Area
Cause
Priority
Source
Status Note: The Status picklist is editable for users whose role includes the Customize Application - Edit Service Request 'Status' Picklist privilege.
Type

For more information on the fields accessible through the Service request Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the service request object.

Solution

The solution object stores information on solutions to customer problems or service requests. Solutions can be reused if the same problem is identified with a product or service. This prevents the duplication of work for customer service representatives.

Parent Object

Activity and Order Item

Child Component

Attachment and Order Item.

For information about using attachments with this object, see Using Attachments with Web Services On Demand.

Methods Called

The following table details the methods called by the Solution service.

Table Methods Called by Solution Service

Method	Name as Defined in Service
Delete	SolutionDelete
DeleteChild	SolutionDeleteChild
Insert	SolutionInsert
InsertChild	SolutionInsertChild
InsertOrUpdate	SolutionInsertOrUpdate
QueryPage	SolutionQueryPage
Update	SolutionUpdate
UpdateChild	SolutionUpdateChild

Fields

The following table details the required and read-only fields for the solution object.

Table Required and Read-Only Fields for the Solution Object

Child Component	Field Name	Type
Solution (parent)	Title	Required
	Audit Fields	Read-only
	CreatorId	Read-only
	LastUpdated	Read-only
Attachment	DisplayFileName	Required
	FileNameOrURL	Required
	FileDate	Read-only
	FileSize	Read-only
	SolutionId	Read-only
	Id	Read-only
	ModId	Read-only
	Audit Fields	Read-only

The following table details the status key for the solution object.

Table Status Key for the Solution Object

Child Component	Field Name
Solution (parent)	Audit Fields
	ExternalSystemId
	Id
	IntegrationId
	LastUpdated
Attachment	Audit Fields
	Id
	SolutionId
ServiceRequest	Audit Fields
	ExternalSystemId
	Id
	IntegrationId
	LastUpdated

The following table provides a list of the filterable fields for the child components of the solution objects, and a list of user key combinations for each child component.

Table Filterable Fields and User Key Fields on the Solution Object’s Child Components

Child Components	Filterable Fields	User Key Field Combinations
Solution (parent)	All	SolutionId
		IntegrationId
		ExternalSystemId
Attachment	None	Id
		ExternalSystemId
		FileNameOrURL and FileExtension
Service Request	Subject	SRNumber
	Area	IntegrationId
	Owner	ExternalSystemId
	Priority
	Type
	Cause
	Source
	Status

The following table details the picklists available for the solution object.

Table Picklists Available for the Solution Object

Field Name
Area
Cause
Priority
Source
Status
Type

For more information on the fields accessible through the Solution Web service, go to the Web Services Administration page within the Oracle CRM On Demand application and generate the WSDL file for the solution object.

Territory

The territory object allows you to store information about the sales territory that is assigned to a user. This information includes the territory name, a description, the currency code, and the sales quota for the territory. The territory object does not have any associated child objects or parent objects.

Parent Objects

None

Methods Called

The following table details the methods called by the Territory service.

Table Methods Called by Territory Service

Method	Name as Defined in Service
Delete	TerritoryDelete
Insert	TerritoryInsert
InsertOrUpdate	TerritoryInsertOrUpdate
QueryPage	TerritoryQueryPage
Update	TerritoryUpdate

Fields

All fields on the territory object are filterable. The TerritoryName, TerritoryExternalSystemId, and TerritoryIntegrationId fields are user keys for the territory object.

The following table details the required and read-only fields for the territory object.

Table Required and Read-Only Fields for the Territory Object

Child Component	Field Name	Type
Territory (parent)	TerritoryName	Required
	Territory	Read-only
	Audit Fields	Read-only

The following table details the status key for the territory object.

Table Status Key for the Territory Object

Child Component	Field Name
Territory (parent)	Audit Fields
	TerritoryExternalSystemId
	TerritoryIntegrationId
	TerritoryId

The following table details the pick map field for the territory object.

Table Pick Map Field for the Territory Object

Pick Map Field	Maps To
ParentTerritoryIntegrationId	ParentTerritoryId
ParentTerritoryExternalSystemId	ParentTerritoryId
ParentTerritoryId	ParentTerritoryId

The following table details the picklists available for the territory object.

Table Picklists Available for the Territory Object

Field Name
ParentTerritoryExternalSystemId
ParentTerritoryIntegrationId

For more information on the fields accessible through the Territory Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the territory object.

User

The user object allows you to define and record details of all users in Oracle CRM On Demand, for example, name, position, contact details, manager, and so on. It is different from the Current User object in that it is not restricted only to the currently logged in user. It enables queries to be run on all users, and enables an administrator to insert and update a user’s profile. The user object does not have any child components.

Usage

The UserLoginId and UserSignInId fields must be used as follows:

UserLoginId. Used for creating user records through the User Web service.
UserSignInId. Used as the user name for logging in and authenticating using Web services. Also, used for queries, as using UserLoginId is not allowed for queries.

Parent Object

User Group

Child Object

Address, DelegatedUser

Methods Called

The following table details the methods called by the User service.

Table Methods Called by User Service

Method	Name as Defined in Service
DeleteChild	UserDeleteChild
Insert	UserInsert
InsertChild	UserInsertChild
InsertOrUpdate	UserInsertOrUpdate
QueryPage	UserQueryPage
Update	UserUpdate
UpdateChild	UserUpdateChild

Fields

All fields on the user object are filterable.

The following table details the required and read-only fields for the user object.

Table Required and Read-Only Fields for the User Object

Child Component	Field Name	Type
User	FirstName	Required
	LastName	Required
	UserLoginId	Required
	UserSignInId	Required
	Alias	Required
	EmailAddr	Required
	Role	Required
	Status	Required
	Audit Fields	Read-only
	LastSignInDateTime	Read-only
	ManagerFullName	Read-only

The following table details the status key for the user object.

Table Status Key for the User Object

Child Component	Field Name
User	ModifiedById
	ModifiedDate
	EMailAddr
	UserId
	IntegrationId

The following table details the pick map field for the user object.

Table Pick Map Field for the User Object

Pick Map Field	Maps To
Role	RoleId

The following table provides a list of user key combinations for the user object.

Table User Key Fields on the User Object

Child Components	User Key Field Combinations
User	UserId
	ExternalSystemId
	IntegrationId
	EmailAddr
Address	IntegrationId
DelegatedUser	ExternalSystemId

For more information on the fields accessible through the User Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the user object.

User Group

The user group object allows you to create groups to which users can be added. Users can only be a member of one group, and groups can contain many users.

Parent Objects

None

Child Component

Methods Called

The following table details the methods called by the User group service.

Table Methods Called by User Group Service

Method	Name as Defined in Service
Delete	UserGroupDelete
DeleteChild	UserGroupDeleteChild
Insert	UserGroupInsert
InsertChild	UserGroupInsertChild
InsertOrUpdate	UserGroupInsertOrUpdate
QueryPage	UserGroupQueryPage
Update	UserGroupUpdate
UpdateChild	UserGroupUpdateChild

Fields

The following table details the required and read-only fields for the user group object.

Table Required and Read-Only Fields for the User Group Object

Child Component	Field Name	Type
User Group (parent)	Name	Required
	UserGroupId	Read-only
	Audit Fields	Read-only
User	UserGroupUserId	Read-only
	UserId	Read-only
	Alias	Read-only
	Email	Read-only
	Role	Read-only
	UserFirstName	Read-only
	UserLastName	Read-only
	Audit Fields	Read-only

The following table details the status key for the user group object.

Table Status Key for the User Group Object

Child Component	Field Name
UserGroup (parent)	Audit Fields
	UserGroupId
	UserGroupIntegrationId
	UserGroupExternalSystemId
User	Audit Fields
	Members_UserId
	UserExternalSystemId
	UserIntegrationId

The following table details the pick map field for the user group object.

Table Pick Map Field for the User Group Object

Child Component	Pick Map Field	Maps To
User	UserIntegrationId	UserId
User	UserExternalSystemId	UserId

The following table provides a list of the filterable fields for the child components of the user group object, and a list of user key combinations for each child component.

Table Filterable Fields and User Key Fields on the User Group Object’s Child Components

Child Component	Filterable Fields	User Key Field Combinations
User Group (parent)	All	Name
		UserGroupIntegrationId
		UserGroupExternalSystemId
User	UserGroupId	UserIntegrationId
	UserId	UserExternalSystemId
	UserIntegrationId
	UserExternalSystemId
	Alias
	Email
	Role
	UserFirstName
	UserLastName

For more information on the fields accessible through the User group Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the user group object.

Life Sciences Edition Parent Objects (Web Services v1.0)

This topic includes the parent objects available with Oracle CRM On Demand Life Sciences Edition.

To download WSDL files for these objects, you must be given access to the object. If you do not have access to the object, it is not available to download from the Web Services Administration page or available to use the Web service calls. For assistance in gaining access to the object, contact your Oracle CRM On Demand service provider.

The following objects are detailed in this topic:

Event

Event

The Event object allows you to plan and track medical events such as a medical educational seminar, a symposium, or a customer appreciation event. An event can be as simple as a lunch-and-learn session in a physician's office or as complex as a seminar series or national sales meeting.

Note: The Event Web service was labelled as the MedEvent Web service before Oracle CRM On Demand Release 25.

Child Component

Invitee

Methods Called

The following table details the methods called by the Event service.

Table Methods Called by Event Service

Method	Name as Defined in Service
Delete	MedEdDelete
DeleteChild	MedEdDeleteChild
Insert	MedEdInsert
InsertChild	MedEdInsertChild
InsertOrUpdate	MedEdInsertOrUpdate
QueryPage	MedEdQueryPage
Update	MedEdUpdate
UpdateChild	MedEdUpdateChild

Fields

The following table details the read-only fields for the Event object and its child component.

Table Read-Only Fields on the Event Object

Child Component	Field Name	Type
Event (parent)	EndDate	Required
	Name	Required
	Objective	Required
	StartDate	Required
	Audit Fields	Read-only
Invitee	Status	Required
	InviteeId	Read-only
	Audit Fields	Read-only

The following table details the status key for the Event object.

Table Status Key for the Event Object

Child Component	Field Name
Event (parent)	Audit Fields
	ExternalId
	MedEdId
Invitee	Audit Fields
	InviteeExternalSystemId
	InviteeId

The following table details the pickmap fields for the Event object and its child objects.

Table Pick Map Fields for the Event Object

Child Component	Pick Map Field	Maps To
Event (parent)	ProductExternalId	ProductId
Event (parent)	ProductIntegrationId	ProductId

The following table provides a list of the filterable fields and user key combinations for the child components of the Event object.

Table Filterable Fields and User Key Fields on the Event Object’s Child Components

Child Components	Filterable Fields	User Key Field Combinations
Event (parent)	ExternalSystemId	MedEdId
	ProductIntegrationId	ExternalSystemId
	ProductId
	ProductId
	ProductExternalId
	PrimaryOwnerId
Invitee	ContactId	InviteeId
	InviteeExternalSystemId	InviteeExternalSystemId
	Status
	Type
	ModifiedDate

The following table details the picklists available for the Event object.

Table Picklists Available for the Event Object

Child Component	Field Name
Event (parent)	EventStatusCode
Event (parent)	EventTypeCode
Invitee	InviteeStatus

For more information on the fields accessible through the Event Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the Event object.

Financial Services Edition Parent Objects (Web Services v1.0)

This topic includes the parent objects available with Oracle CRM On Demand Financial Services Edition.

Note: To download WSDL files for these objects, you must be given access to the object. If you do not have access to the object, it is not available to download from the Web Services Administration page or available to use the Web service calls. For assistance in gaining access to the objects, contact your Oracle CRM On Demand service provider.

The following objects are detailed in this topic:

Household

The household object allows you to define and record financial details about a group of contacts that live in the same household, for example, parents, brothers, sisters, spouses, and so on. These details include the assets of the household, the liabilities of the household, the net income of the household, and so on.

Child Component

Book, Contact, HouseholdTeam

Methods Called

The following table details the methods called by the Household service.

Table Methods Called by Household Service

Method	Name as Defined in Service
Delete	HouseholdDelete
DeleteChild	HouseholdDeleteChild
Insert	HouseholdInsert
InsertChild	HouseholdInsertChild
InsertOrUpdate	HouseholdInsertOrUpdate
QueryPage	HouseholdQueryPage
Update	HouseholdUpdate
UpdateChild	HouseholdInsertChild

Fields

The following table details the required and read-only fields for the household object.

Table Required and Read-Only Fields for the Household Object

Child Component	Field Name	Type
Household (parent)	HouseholdName	Required
	IntegrationID	Required
	ExternalSystemID	Required
	HouseholdId	Read-only
	PrimaryContactId	Read-only
	PrimaryContactExternalId	Read-only
	PrimaryContactIntegrationId	Read-only
	PrimaryContactFirstName	Read-only
	PrimaryContactLastName	Read-only
	Timezone	Read-only
	HouseholdCurrency	Read-only
	LastActivity	Read-only
	HeadDOB	Read-only
	TotalIncome	Read-only
	TotalAssets	Read-only
	TotalExpenses	Read-only
	TotalLiabilities	Read-only
	TotalNetWorth	Read-only
	RiskProfile	Read-only
	ExperienceLevel	Read-only
	InvestmentHorizon	Read-only
	CurrentInvestmentMix	Read-only
	Objective	Read-only
	PrimaryGoal	Read-only
	Audit Fields	Read-only
Book	BookName	Required
	BookId	Read-only
	SystemAssociateFlag	Read-only
	ModId	Read-only
	Audit Fields	Read-only
Contact	ContactId	Required
	ContactExternalId	Required
	ContactIntegrationId	Required
	ContactFirstName	Read-only
	ContactLastName	Read-only
	ContactId	Read-only
	ContactMrMrs	Read-only
	Audit Fields	Read-only
HouseholdTeam	HouseholdAccess	Required
	UserId	Read-only
	UserAlias	Read-only
	UserEmail	Read-only

The following table details the status key for the household object.

Table Status Key for the Household Object

Child Component	Field Name
Household (parent)	Audit Fields
	ExternalSystemId
	HouseholdId
	IntegrationID
Book	Audit Fields
	BookId
	ModId
Contact	Audit Fields
Contact	ContactId
HouseholdTeam	Audit Fields
	UserExternalSystemId
	HouseholdTeamId
	UserAlias
	UserEmail

The following table details the pick map fields for the household object.

Table Pick Map Field for the Household Object

Child Component	Pick Map Field	Maps To
Contact	ContactExternalId	ContactId
Contact	ContactIntegrationId	ContactId
Book	BookName	BookId
HouseholdTeam	UserEmail	UserId
	UserAlias	UserId
	UserExternalSystemId	UserId
	LastName	UserId
	FirstName	UserId

The following table provides a list of the filterable fields for the child components of the household object, and a list of user key combinations for each child component.

Table Filterable Fields and User Key Fields on the Household Object’s Child Components

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

The following table details the picklists available for the household object.

Table Picklists Available for the Household Object

Child Component	Field Name
Household (parent)	Segment
Household (parent)	Type
Contact	RelationshipRole
HouseholdTeam	TeamRole
HouseholdTeam	HouseholdAccess

For more information on the fields accessible through the Household Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the household object.

Portfolio

The portfolio object allows you to define and record details about the collection of financial services that you can provide to an account. Financial services include loans, credit cards, insurance, general banking, and so on.

Child Component

Book, Contact, PortfolioTeam

Methods Called

The following table details the methods called by the Portfolio service.

Table Methods Called by Portfolio Service

Method	Name as Defined in Service
Delete	PortfolioDelete
DeleteChild	PortfolioDeleteChild
Insert	PortfolioInsert
InsertChild	PortfolioInsertChild
InsertOrUpdate	PortfolioInsertOrUpdate
QueryPage	PortfolioQueryPage
Update	PortfolioUpdate
UpdateChild	PortfolioUpdateChild

Fields

The following table details the read-only fields for the portfolio object and its child component.

Table Required and Read-Only Fields on the Portfolio Object

Child Component	Field Name	Type
Portfolio (parent)	PortfolioId	Read-only
	Owner	Read-only
	OwnerId	Read-only
	PrimaryContact	Read-only
	Audit Fields	Read-only
Book	BookName	Required
	BookId	Read-only
	SystemAssociateFlag	Read-only
	ModId	Read-only
	Audit Fields	Read-only
Contact	ContactId	Read-only
	ContactFirstName	Read-only
	ContactLastName	Read-only
	ContactHomePhone	Read-only
	ContactEmail	Read-only
	Audit Fields	Read-only
PortfolioTeam	PortfolioAccess	Required
	UserId	Read-only
	UserAlias	Read-only
	UserEmail	Read-only

The following table details the status key for the portfolio object.

Table Status Key for the Portfolio Object

Child Component	Field Name
Portfolio (parent)	Audit Fields
	ExternalSystemId
	PortfolioId
	IntegrationId
Book	Audit Fields
	BookId
	ModId
Contact	Audit Fields
	ContactId
	Id
PortfolioTeam	Audit Fields
	UserId
	UserAlias
	UserEmail
	UserExternalSystemId

The following table details the pickmap fields for the portfolio object and its child objects.

Table Pick Map Fields for the Portfolio Object

Child Component	Pick Map Field	Maps To
Portfolio (parent)	InstitutionExternalId	InstitutionId
	InstitutionIntegrationId	InstitutionId
	InstitutionName	InstitutionId
	InstitutionLocation	InstitutionId
	Product	ProductId
	ProductExternalId	ProductId
	ProductIntegrationId	ProductId
Book	BookName	BookId
Contact	ContactExternalId	ContactId
Contact	ContactIntegrationId	ContactId
PortfolioTeam	UserEmail	UserId
	UserAlias	UserId
	UserExternalSystemId	UserId
	LastName	UserId
	FirstName	UserId
	FullName	UserId

The following table provides a list of the filterable fields and user key combinations for the child components of the portfolio object.

Table Filterable Fields and User Key Fields on the Portfolio Object’s Child Components

Child Components	Filterable Fields	User Key Field Combinations
Portfolio (parent)	All	PortfolioId
		IntegrationId
		ExternalSystemId
Book	None	BookId
Book	None	BookName
Contact	ContactId	ContactId
	ContactExternalId	ContactExternalId
	ContactIntegrationId	ContactIntegrationId
	ContactFirstName
	ContactLastName
	ContactHomePhone
	ContactEmail
	NamedInsured
	PolicyOwner
	Relationship
PortfolioTeam	UserId	UserId
	UserExternalSystemId	UserExternalSystemId
	LastName	UserAlias
	FirstName	UserEmail
	TeamRole
	PortfolioAccess

The following table details the picklists available for the portfolio object.

Table Picklists Available for the Portfolio Object

Child Component	Field Name
Portfolio (parent)	AccountType
	Status
	TermUnit
Contact	Relationship
PortfolioTeam	TeamRole
PortfolioTeam	PortfolioAccess

For more information on the fields accessible through the Portfolio Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the portfolio object.

Automotive Edition Parent Objects (Web Services v1.0)

This topic includes the parent objects available with Oracle CRM On Demand Automotive Edition.

Note: To download WSDL files for these objects, you must be given access to the object. If you do not have access to the object, it is not available to download from the Web Services Administration page or available to use the Web service calls. For assistance in gaining access to the objects, contact your Oracle CRM On Demand service provider.

The following objects are detailed in this topic:

Dealer

The dealer object stores information about dealerships in the automotive industry, for example, the name of the dealership, the identity of the parent dealership, the site on which the dealership is based, and so on. The dealer object does not have any parent objects.

Child Objects

Attachment and Book.

For information about using attachments with this object, see Using Attachments with Web Services On Demand.

Methods Called

The following table details the methods called by the Dealer service.

Table Methods Called by Dealer Service

Method	Name as Defined in Service
Delete	DealerDelete
DeleteChild	DealerDeleteChild
Insert	DealerInsert
InsertChild	DealerInsertChild
InsertOrUpdate	DealerInsertOrUpdate
QueryPage	DealerQueryPage
Update	DealerUpdate
UpdateChild	DealerUpdateChild

Fields

All fields on the dealer object are filterable.

The following table details the required and read-only fields for the dealer object.

Table Required and Read-Only Fields for the Dealer Object

Child Component	Field Name	Type
Dealer	DealerId	Required
	DealerIntegrationId	Required
	DealerExternalSystemID	Required
	DealerId	Read-only
	DealerType	Read-only
	Audit Fields	Read-only
Attachment	DisplayFileName	Required
	FileNameOrURL	Required
	FileDate	Read-only
	FileSize	Read-only
	DealerId	Read-only
	Id	Read-only
	ModId	Read-only
	Audit Fields	Read-only
Book	BookName	Required
	BookId	Read-only
	SystemAssociateFlag	Read-only
	ModId	Read-only
	Audit Fields	Read-only

The following table details the status key for the dealer object.

Table Status Key for the Dealer Object

Child Component	Field Name
Dealer (parent)	Audit Fields
	DealerId
	DealerIntegrationID
	DealerExternalSystemId
Attachment	Audit Fields
	Id
	DealerId
Book	Audit Fields
	BookId
	ModId

The following table details the pick map fields for the dealer object.

Table Pick Map Fields for the Dealer Object

Child Components	Pick Map Field	Maps To
Dealer (parent)	Owner	OwnerId
	ParentDealerExternalSystemId	ParentDealerId
	ParentDealerIntegrationId	ParentDealerId
	ParentDealerName	ParentDealerId
	ParentDealerSite	ParentDealerId
Book	BookName	BookId

The following table provides a list of the filterable fields for the child components of the dealer object, and a list of user key combinations for each child component.

Table Filterable Fields and User Key Fields on the Dealer Object’s Child Components

Child Components	Filterable Fields	User Key Field Combinations
Dealer (parent)	All	DealerId
		DealerIntegrationID
		DealerExternalSystemID
Attachment	None	Id
		ExternalSystemId
		FileNameOrURL and FileExtension
Book	None	BookId
Book	None	BookName

The following table details the picklists available for the dealer object.

Table Picklists Available for the Dealer Object

Field Name
ParentDealerName
ParentDealerSite

For more information on the fields accessible through the Dealer Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the dealer object.

Vehicle

The vehicle object allows you to create and store information about a vehicle, for example, a car, a truck, a van, and so on, that your company would like to sell to a contact or account. This information includes the vehicle’s current mileage, the invoice price, the dealership, the make, and so on.

Parent Objects

None

Child Component

Methods Called

The following table details the methods called by the Vehicle service.

Table Methods Called by Vehicle Service

Method	Name as Defined in Service
Delete	VehicleDelete
DeleteChild	VehicleDeleteChild
Insert	VehicleInsert
InsertChild	VehicleInsertChild
InsertOrUpdate	VehicleInsertOrUpdate
QueryPage	VehicleQueryPage
Update	VehicleUpdate
UpdateChild	VehicleUpdateChild

Fields

The following table details the required and read-only fields for the vehicle object.

Table Required and Read-Only Fields for the Vehicle Object

Child Component	Field Name	Type
Vehicle (parent)	VehicleId	Read-only
	Contact	Read-only
	ProductType	Read-only
	SellingDealer	Read-only
	ServicingDealer	Read-only
	Audit Fields	Read-only
Contact	ContactId	Required
	ContactExternalSystemId	Required
	ContactIntegrationId	Required
	Audit Fields	Read-only

The following table details the status key for the vehicle object.

Table Status Key for the Vehicle Object

Child Component	Field Name
Vehicle (parent)	Audit Fields
	ExternalSystemId
	IntegrationId
	VehicleId
Contact	Audit Fields
Contact	ContactId

The following table details the pick map fields for the vehicle object.

Table Pick Map Fields for the Vehicle Object

Child Component	Pick Map Field	Maps To
Vehicle (parent)	AccountName	AccountId
	AccountSite	AccountId
	AccountIntegrationId	AccountId
	AccountExternalID	AccountId
	SellingDealerExternalId	SellingDealerId
	SellingDealerIntegrationId	SellingDealerId
	ServicingDealerExternalId	ServicingDealerId
	ServicingDealerIntegrationId	ServicingDealerId
Contact	ContactExternalSystemId	ContactId
Contact	ContactIntegrationId	ContactId

The following table provides a list of the filterable fields for the child components of the vehicle object, and a list of user key combinations for each child component.

Table Filterable Fields and User Key Fields on the Vehicle Object’s Child Components

Child Component	Filterable Fields	User Key Field Combinations
Vehicle (parent)	All	VehicleId
		ExternalSystemId
		IntegrationId
Contact	ContactId	ContactId
	ContactExternalSystemId	ContactExternalSystemId
	ContactIntegrationId	ContactIntegrationId
	ContactFirstName	ContactIntegrationId

The following table details the picklists available for the vehicle object.

Table Picklists Available for the Vehicle Object

Field Name
Body
Door
Engine
ExteriorColor
InteriorColor
Location
Make
Model
VehicleOwnedBy
Status
Transmission
Trim
UsedNew
WarrantyType
Year

For more information on the fields accessible through the Vehicle Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the vehicle object.

Child Objects (Web Services v1.0)

The following is a list of child objects that are used in Oracle On Demand Web Services v1.0. These are objects that are child objects only and are not themselves parent objects:

Address

The address object stores information on the different addresses that are associated with accounts and contacts. It is used to store billing and shipping addresses for accounts. It is also used to store the personal addresses for contacts.

For information about converting unshared addresses to shared addresses using UI export functionality and Web services calls, see Converting Unshared Addresses to Shared Addresses.

Parent Objects

Attachment

The attachment object stores information about a file or URL that is attached to a record in Oracle CRM On Demand.

Parent Objects

Account, Activity, Campaign, Contact, Custom Object1 - Custom Object3, Lead, Lead, Opportunity, Order Item, and Solution.

Audit Trail

The audit trail object stores information about how a service request object is modified from the moment that it is created until a solution for the service request has been found. The audit trail object stores information, such as the created and modified dates for the service request, and also the users who created and updated the service request.

Parent Object

Order Item

BookUser

The BookUser object stores information about a book user.

For more information on the BookUser fields accessible, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the book object.

Parent Object

Competitor

The competitor object stores the information on competitors for your accounts.

Fields

The following table details the picklists available for the competitor object.

Table Picklists Available for the Competitor Object

Field Name
RelationshipRole
ReverseRelationshipRole

For more information on the competitor fields accessible, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the account object.

Parent Objects

DelegatedUser

The DelegatedUser object stores information about a user who can impersonate another user. The delegated user is added so that he or she can access a user’s data, for example, when a person is on vacation or leaves the company.

For more information on the DelegatedUser fields accessible, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the user object.

Parent Object

HouseholdTeam

The HouseholdTeam object stores the information on a team that shares household records.

For more information on the household team fields accessible, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the household object.

Parent Object

Household

Interests

The interests object stores information about things in which a contact is interested, such as products, services, or hobbies.

Parent Object

Invitee

The invitee object stores information about invitees to events, including feedback about the invitation.

Parent Object

Event

Login History

The login history object stores information about the currently logged in user, such as the amount of times that the user has logged in, and the dates and times at which the current user logged in.

Parent Object

Current User

Multiple Contact Roles

The multiple contact roles object stores information on the different roles that a contact can hold within an account. It stores information on the different types of jobs that one contact can hold within your organization. For example, the customer relations manager can also have a role within the sales team to provide valuable feedback to the sales representatives.

Parent Object

Account, Product Category

Opportunity Team

The OpportunityTeam object stores information about a team that shares opportunity records.

For more information on the opportunity team fields accessible, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the opportunity object.

Parent Object

Opportunity

PortfolioTeam

The PortfolioTeam object stores information about a team that shares portfolio records

For more information on the portfolio team fields accessible, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the portfolio object.

Parent Objects

ProductsDetailed

The ProductsDetailed object stores the information on product details for an activity. This is used, for example, to record information about products discussed on sales calls to customers.

For more information on the product detail fields accessible, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the activity object.

Parent Objects

PromotionalItemsDropped

The PromotionalItemsDropped object stores the information on promotional items dropped for an activity.

For more information on the promotional items dropped fields accessible, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the activity object.

Parent Objects

Quota

The quota object stores information about the sales targets of and sales made by the current user.

Parent Object

Current User

Recipient

The recipient object stores information about a recipient associated with a campaign.

Parent Object

Campaign

Related Account

The related account object stores information on an account that has a relationship with the parent account in question. The details of the related account child object are inherited from a particular account parent object.

Parent Object

Account

Related Contact

The related contact object stores information about a contact that has a relationship with the parent contact in question. The details of the related contact child object are inherited from a particular contact parent object.

Parent Object

Revenue

The revenue object stores monetary information about accounts, contacts, and their associated opportunities. This includes information on the revenue available, expected revenue, and also information about the products associated with the accounts, contacts, opportunities, and so on.

Note: The Revenue child object of Opportunity is actually called Product.

Parent Objects

Account, Contact and Opportunity

SampleDropped

The SampleDropped object stores the information on samples for an activity. This is used, for example, to record information about samples left with the customer on sales calls to customers.

For more information on the SampleDropped fields accessible, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the activity object.

Parent Object

Shared Address

The shared address child object stores information on addresses that can be shared between accounts and contacts that have a relationship with the parent record.

This child object is applicable only for companies that have the Enable Shared Addresses check box selected on the company profile. In this case, addresses can be associated with multiple account, and contact records.

For Web Services v1.0, the shared address child object is read only; insert, update, and delete operations are not available.

For more information about the shared address functionality, see Oracle CRM On Demand Online Help.

When the Enable Shared Addresses check box is deselected, the shared address child object cannot be used, because addresses are not being shared. Instead, the address child object is used for address operations. For information about the address child object, see Address.

Parent Objects

SubBook

The Subbook object stores information about a subbook.

For more information on the Subbook fields accessible, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the book object.

Parent Object

Business Plan, Messaging Plan, Objective

Team

The team object stores information on the team that is assigned to a particular account or contact. In this way, a team of employees can be dedicated to an account or contact, ensuring that the activities, service requests, leads, and opportunities surrounding that account or contact are always kept up-to-date and are attended to regularly.

Parent Objects

Account, Contact, and Custom Object1 - Custom Object3, Order Item, Lead

Core Parent Objects (Web Services v2.0)

This topic include the standard objects of Oracle CRM On Demand. Objects that are only available with industry-specific editions of the application are covered in the following topics:

The following Oracle CRM On Demand objects are detailed in this topic:

Objects accessible through the Web Services v2.0 API can reference other objects through a number of reference fields, which are foreign key fields for those other objects. You can determine the objects that are referenced by examining the WSDL file for the referencing object.

Note: Information about status keys is not given in this topic because a standard set of status key fields is returned for all parent and child objects accessible through the Web Services v2.0 API. For more information about status keys, see Oracle CRM On Demand Status Keys.

Account

The account object stores information about the companies that you do business with and is also used to track partners and competitors. The methods called on the account object require a list (array) of account objects as an input argument. This list of accounts identifies the records on which the operation is to be carried out.

Child Objects

Account Contact, Account Opportunity, Activity, Address, Asset, Attachment, Audit Trail,Book, Business Plan, Call Activity History, Claim, Competitor, Contact, Contact Role, Custom Object 1 through 3, Custom Object 4 through 15, Deal Registration, Event, Financial Account, Financial Account Holder, Financial Plan, Image, Lead, Note, Objective, Partner, Plan Account, Policy, Policy Holder, Revenue, Sales Assessment, Sales Assessment Value, Sample Request, Service Request, Shared Address, Special Pricing Product, Team

Note: When Enabled Shared Addresses is selected on the company profile, the address child object (<ListOfAddress>) cannot be used for insert, update, or delete operations. Only association and dissociation is allowed for the shared address child object. To update a shared address, you must access the top-level shared address object.

Methods Called

The following table details the methods called by the Account service.

Table Methods Called by Account Service

Method	Name as Defined in Service
Delete	AccountDelete
Execute	AccountExecute
Insert	AccountInsert
QueryPage	AccountQueryPage
Update	AccountUpdate

Fields

The following table details the required and read-only fields for the account object.

Table Required and Read-Only Fields for the Account Object

Field Name	Type
AccountName	Required
Audit Fields	Read-only

The following table details the pick map fields for the account object.

Table Pick Map Fields for the Account Object

Pick Map Field	Maps To
Owner	OwnerId
ParentAccount, ParentAccountLocation	ParentAccountId
ParentAccountIntegrationId	ParentAccountId
ParentAccountExternalSystemId	ParentAccountId

The following table provides a list of the user key combinations for the account object.

Table User Key Fields on the Account Object

User Key Field Combinations
Id
ExternalSystemId
AccountName and Location

The following table details the picklists available for the account object.

Table Picklists Available for the Account Object

Field Name
AccountType
AssessmentFilter1 through AssessmentFilter5
CallFrequency
IndexedPick0 through IndexedPick5
InfluenceType
MarketPotential
MarketSegment
PartnerStatus
Priority
Region
Route
Stage
Status

Adding and Updating Account Addresses

The information in this topic is applicable when the Enable Shared Addresses check box in the company profile is deselected, that is, when addresses are not shared.

Note: When Enable Shared Addresses is selected, the address child object, (<ListOfAddress>) cannot be used, and instead the shared address child object (<ListOfSharedAddress>) must be used to associate or dissociate addresses and flag addresses as billing, shipping, or primary addresses. For more information about the shared address child object, see Shared Address and for more information about the address child object, see Address.

The account object has three types of address:

Billing address
Shipping address
Simple address

The billing and shipping address correspond to fields in the account object. The address child object can correspond to a simple address, but might also correspond to a billing address or a shipping address.

You can use either AccountInsert, AccountUpdate or AccountExecute calls to insert or update billing and shipping addresses for an account. With AccountInsert or AccountUpdate calls, the account parent node with billing and shipping address fields must be present and there must not be any child node. If an address child is present, only a simple address can be added, and not billing and shipping addresses. If the address child or any other child node is not present, only billing and shipping addresses can be added, and not simple addresses.

With the AccountExecute call, both the account parent node and address child node can be present along with billing and shipping address fields at the parent level.

To distinguish whether the address in an address child node is a billing or shipping address:

If the PrimaryBillToAddressId and AddressId fields have the same value, then the address is a billing address.
If the PrimaryShipToAddressId and AddressId have the same values, the address is a shipping address.

Note: A PrimaryAddressLine1 field is used to dynamically map the primary address field from an external application to the primary address field in Oracle CRM On Demand. For more information, see Mapping Primary Address Fields Using Web Services.

Activity

The activity object stores information on an activity that a user must carry out, for example, a call-back activity for an account. When an activity is created, the user must set the Activity field explicitly to Task or Appointment.

Usage

Oracle On Demand Web Services uses activities to organize, track, and resolve a variety of tasks, from finding and pursuing opportunities to closing service requests. If a task requires multiple steps that one or more people can carry out, activities greatly simplify the job. Activities can help to:

Define and assign the task
Provide information to complete the task
Track the progress of the task
Track costs and bill for the task

Note: The Owner field is not accessible for the activity object in Web Services v2.0.

Note: The CMSId field is accessible in the WSDL file for Activity although it is not available in the Oracle CRM On Demand UI. This field is for internal use only and is not intended for use by customers.

Creating attendee calls

You can create an attendee call using the Activity service by passing an account call as the parent activity Id.

To create the attendee call, you insert an activity object where the CallType field is set to AttendeeCall and the ParentActivityId field is set to the row Id of an account call.

Support for Recurring Events

The Activity service allows access to the iCRMId field. This field is used to support the synchronization of recurring appointments between Oracle CRM On Demand Desktop and Oracle CRM On Demand.

Microsoft Outlook supports a variety of recurring appointments (for example, meetings) where an appointment can occur daily, weekly, monthly, and so on. In addition, Outlook also supports exceptions within a recurring series of appointments, for example, a meeting that occurs at the same time each day in the week apart from one day where the meeting is at a different time. However, Oracle CRM On Demand does not support recurring activities, so each occurrence of a recurring appointment is created as an individual activity in Oracle CRM On Demand.

The iCRMId field contains a representation of the recurrence parameters and is required to reassemble the recurring appointment and its exceptions within Outlook if there are any changes to the individual activities in Oracle CRM On Demand. The field is 450 characters in length, is indexed, and contains:

The unique Id of the recurring appointment generated by Outlook.

The recurrence rule (RRULE), for example:

FREQ=MONTHLY;UNTIL=20110207T144325;INTERVAL=2;BYDAY=MO,TU,WE,TH,FR;BYSETPOS=-1

VTIMEZONE, the timezone specified for each Outlook appointment, for example:

BEGIN:VTIMEZONE
TZID:(UTC+02:00)
BEGIN:STANDARD
DTSTART:16011028T040000
TZOFFSETFROM:+0300
TZOFFSETTO:+0200
END:STANDARD
BEGIN:DAYLIGHT
DTSTART:16010325T030000
TZOFFSETFROM:+0200
TZOFFSETTO:+0300
END:DAYLIGHT
END:VTIMEZONE

The offset of the occurrence from the start of the series (int).
The hash value of the original series fields (int). This includes the hash value of location, appt startdate, appt enddate, subject, and description.

For more information about the synchronization of recurring appointments between Oracle CRM On Demand Desktop and Oracle CRM On Demand, see Oracle CRM On Demand Desktop Administration Guide.

Reading Private Activities

Users who have the View Private Activities privilege and the Can Read All Records setting for the Activity record type enabled in their user role can use Web service calls to read all activities that are marked private, regardless of the owner of the activity. The ViewMode argument must have a value of Broadest (which is the default value).

The View Private Activities privilege does not allow a user to update or delete an activity that is marked private and is owned by another user.

Synchronization of Events and Appointments

If your company administrator enables the Display Events in Calendar setting in the company profile, then Oracle CRM On Demand automatically maintains an associated appointment record for an event record. When a user creates, updates, or deletes an event record through the UI, the Import Assistant, or Web services, Oracle CRM On Demand creates, updates or deletes the associated appointment record. Conversely, Oracle CRM On Demand automatically updates or deletes the original event record whenever you update or delete the corresponding appointment for the event.

The associated appointments are known as shadow appointments, and in Web service calls, are identified with the <EventMirrorApptFlag> element.

For more information about the Display Events in Calendar setting and about synchronization of events and appointments, see Oracle CRM On Demand Online Help.

Child Objects

Address, Attachment, Audit Trail, Attendee Call, Contact, Contact Best Times, Custom Object 1 through 3, Custom Object 4 through 15, Message Response, Products Detailed, Promotional Items Dropped, Sample Dropped, Sample Transaction, Sales Assessment, Sales Assessment Value, Signature, User.

Methods Called

The following table details the methods called by the Activity service.

Table Methods Called by Activity Service

Method	Name as Defined in Service
Delete	ActivityDelete
Execute	ActivityExecute
Insert	ActivityInsert
QueryPage	ActivityQueryPage
Update	ActivityUpdate

Fields

The following table details the required and read-only fields for the activity object.

Table Required and Read-Only Fields for the Activity Object

Field Name	Type
Subject	Required
Activity	Required
AccountName	Read-only
ActivityId	Read-only
AddressId	Read-only
CallType	Read-only
ContactFirstName	Read-only
ContactLastName	Read-only
LeadFirstName	Read-only
LeadLastName	Read-only
MedEdEventName	Read-only
OpportunityName	Read-only
FundRequest	Read-only
SmartCall	Read-only
AssignedQueue	Read-only
QueueHoldTime	Read-only
QueueStartTime	Read-only
TotalHoldTime	Read-only
ResolutionCode	Read-only
OwnerFullName	Read-only
ServiceRequestNumber	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the activity object.

Table Pick Map Fields for the Activity Object

Pick Map Field	Maps To
OwnerAlias	OwnerId
AccountName	AccountId
AccountLocation	AccountId
AccountExternalSystemId	AccountId
AccountIntegrationId	AccountId
CampaignExternalSystemId	CampaignId
CampaignIntegrationId	CampaignId
CampaignName	CampaignId
LeadExternalSystemId	LeadId
LeadIntegrationId	LeadId
MedEdEventExternalSystemId	MedEdEventId
MedEdEventIntegrationId	MedEdEventId
OpportunityExternalSystemId	OpportunityId
OpportunityIntegrationId	OpportunityId
PortfolioExternalSystemId	PortfolioId
PortfolioIntegrationId	PortfolioId
ServiceRequestNumber	ServiceRequestId
ServiceRequestExternalSystemId	ServiceRequestId
ServiceRequestIntegrationId	ServiceRequestId
FundRequestExternalSystemId	FundRequestId
FundRequestIntegrationId	FundRequestId

The following table provides a list of the user key combinations for the activity object.

Table User Key Fields on the Activity Object

User Key Field Combinations
Description
Id
ExternalSystemId

The following table details the picklists available for the activity object.

Table Picklists Available for the Activity Object

Field Name
ActivitySubtype
ApprovalStatus
CallResult
IndexedPick0 through IndexedPick5
Priority
Subtype
RejectReason
ResolutionCode
Status Note: The Status picklist is editable for users whose role includes the Customize Application - Edit Activity 'Status' Picklist privilege
Type

Address

The shared address object stores information about addresses that can be shared between account, contact, dealer, and partner records.

Child Objects

Account, Audit Trail,Contact, Custom Object 1 through 3, Custom Object 4 through 15, Dealer, Partner

Note: For the Account, Contact, Dealer, and Partner child objects, access is read-only.

Usage

This object is applicable only for companies that have the Enable Shared Addresses check box selected on the company profile. In this case, addresses can be associated with multiple account, contact, dealer, or partner records.

After a shared address object is inserted, it can be shared between accounts, contacts, dealers and partners by inserting a child shared address object for those record types. When a child shared address is inserted, it can be flagged as a billing address or shipping address for accounts, dealers, and partners, or as a primary contact address for contacts. When this occurs, the billing, shipping, or primary contact fields in the parent object are populated from the shared address fields. For more information about the shared address child object, see Shared Address.

Note: If the Validate Shared Addresses option is selected for the company, an address can only be shared after it is validated.

When a shared address is updated through the Address service, all shared address child objects for the address are updated. Also, the address fields in the associated account, contact, dealer, or partner objects are updated, if the address deleted was flagged as a billing, shipping, or primary contact address.

To delete a shared address, the Manage Addresses privilege is required. When a shared address is deleted through the Address service, all shared address child objects for the address are dissociated from their parent objects. Also, the address fields in the associated account, contact, dealer, or partner objects are deleted, if the address deleted was flagged as a billing, shipping, or primary contact address.

For more information about the shared address functionality, see Oracle CRM On Demand Online Help.

Methods Called

The following table details the methods called by the Address service.

Table Methods Called by Address Service

Method	Name as Defined in Service
Delete	SharedAddressDelete
Execute	SharedAddressExecute
Insert	SharedAddressInsert
QueryPage	SharedAddressQueryPage
Update	SharedAddressUpdate

Fields

The following table details the required and read-only fields for the shared address object.

Table Required and Read-Only Fields for the Shared Address Object

Field Name	Type
AddressName	Required
GeocodeMatchCode	Read-only
GeocodeMatchVector	Read-only
GeocodeStatus	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the shared address object.

Table Pick Maps Fields for the Shared Address Object

Pick Map Field	Maps To
CustomObjectnName	CustomObjectnId
CustomObjectnExternalSystemId	CustomObjectnId

The following table details the user keys for the shared address object.

Table User Keys for the Shared Address Object

Field Name
Id
ExternalSystemId
AddressName

The following table details the picklists available for the shared address object.

Table Picklists for the Shared Address Object

Field Name
CurrencyCode

Converting Unshared Addresses to Shared Addresses

Release 19 and earlier releases of Oracle CRM On Demand used unshared addresses. To convert unshared addresses from earlier releases to shared addresses, you can follow a procedure that uses the export and import functionality of the Oracle CRM On Demand UI as described in Oracle CRM On Demand Online Help.

You can also follow a procedure that uses UI export functionality and Web services calls to import data. This involves writing an application to read exported data from a file and then creating the SOAP requests to send to Oracle CRM On Demand. Sample SOAP request are shown in the procedure in this topic. However, it may be more efficient, especially if the conversion is a one-time process, to use the import functionality of the UI rather than Web services calls.

Tip: If the data files are large and the Web services or import operations take longer than you expect, then you can use Oracle Data Loader On Demand with the same input files and mapping files that are defined in the conversion procedure.

Before you begin: It is assumed that Oracle CRM On Demand Customer Care has upgraded your company to the current release. To complete this procedure, you must be a company administrator who can perform import and export operations, Web services calls, and customize Oracle CRM On Demand. You require the Manage Addresses privilege to enable shared address functionality.

Note: When moving to shared addresses from unshared addresses, you must use the Web Services v2.0 API for all Web services requests because the Web Services v1.0 API does not support access to shared addresses.

In the following procedure, the steps are performed in the Oracle CRM On Demand UI unless otherwise stated:

To convert unshared addresses to shared addresses

If it is selected, deselect the Enable Shared Addresses setting in the company profile.
Export the data from the address-related objects that you want to convert to shared addresses.
The list includes the following items:
- All account data sections including:
  - Accounts
  - Account Addresses
  - Contacts
  - Account Partners
  - Addresses
- All contact data sections including:
  - Contacts
  - Contact Addresses
  - Accounts
  - Addresses
- All dealer data sections including:
  - Dealer
  - Dealer Addresses
- All partner data sections including:
  - Partner
  - Partner Addresses
- All address data
This export operation must export all the relevant account, contact, partner, dealer, and address data from Oracle CRM On Demand to an external file. You must be able to use the external file with the data correction and standardization method that you choose.
Correct and reformat the data so that importing these addresses into Oracle CRM On Demand does not result in duplicate data and so that the account, contact, dealer, and partner data is set up with the associated addresses.
It is likely that many duplicate and invalid addresses will exist after the export operation. For example, because addresses were not shared in earlier releases, contacts residing at the same location might have identical or similar addresses. However, minor differences might arise because of typing and other errors. For the duplicate addresses that are likely to occur, reimporting the records (for example, accounts) and associating them with newly created shared address records will not delete the preexisting address associations from the earlier release. Consequently, you must do the following:
- Verify your data and then remove duplicate records when preparing the address data that you want to import.
- Take ownership of the preexisting unshared address data associated with your account, contact, dealer, and partner records if you decide to associate those records with the shared address version of the address data. That is, you must remove and disassociate, and choose whether to retain the preexisting unshared address data.
For information on preparing the data for import or use with Web services, see the following topics in Oracle CRM On Demand Online Help:
- Address Fields: Import Preparation
- Account Fields: Import Preparation
- Contact Fields: Import Preparation
- Dealer Fields: Import Preparation
- Partner Fields: Import Preparation

Import the address record data by using Web services calls to insert the Address record data into Oracle CRM On Demand.

Inserting the shared Address top-level record data is a prerequisite for inserting account, contact, dealer, and partner record data. The following is a sample SOAP request for inserting the data:

<?xml version="1.0" encoding="utf-16" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsi="http://www.w3.org/2001/ XMLSchema-instance" xmlns:wsse="http://
docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecuritysecext- 1.0.xsd" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<wsse:Security>
  <wsse:UsernameToken>
    <wsse:Username>%%USERNAME%%</wsse:Username>
    <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-tokenprofile- 1.0#PasswordText">%%PASSWORD%%</wsse:Password>
  </wsse:UsernameToken>
</wsse:Security>
</soap:Header>
<soap:Body>
  <SharedAddressInsert_Input xmlns="urn:crmondemand/ws/ecbs/sharedaddress/">
    <ListOfSharedAddress>
      <SharedAddress>
        <AddressName>LS Address 8</AddressName>
        <PrimaryAddressLine1>30 Prospect Ave</PrimaryAddressLine1>
        <Country>USA</Country>
        <City>Hackensack</City>
        <StateProvince>NJ</StateProvince>
        <ZipCode>07601</ZipCode>
      </SharedAddress>
      <SharedAddress>
        <AddressName>LS Address 9</AddressName>
        <PrimaryAddressLine1>100 S Jackson Ave</PrimaryAddressLine1>
        <Country>USA</Country>
        <City>Pittsburgh</City>
        <StateProvince>PA</StateProvince>
        <ZipCode>15202</ZipCode>
      </SharedAddress>
    </ListOfSharedAddress>
  </SharedAddressInsert_Input
</soap:Body>
</soap:Envelope>

Make sure that you retrieve the Address Ids from the SOAP response for the insert operations.

Import the account record data by using Web services calls to insert the Account-Address record data into Oracle CRM On Demand.

This insertion associates the shared addresses with the accounts. The following is a sample SOAP request for inserting the data. The <AddressId> values used are those retrieved from the response in the previous step:

<?xml version="1.0" encoding="utf-16" standalone="no"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsi="http://www.w3.org/2001/ XMLSchema-instance" xmlns:wsse="http://
docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecuritysecext- 1.0.xsd" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<wsse:Security>
  <wsse:UsernameToken>
    <wsse:Username>%%USERNAME%%</wsse:Username>
    <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-tokenprofile- 1.0#PasswordText">%%PASSWORD%%</wsse:Password>
  </wsse:UsernameToken>
</wsse:Security>
</soap:Header>
<soap:Body>
  <AccountExecute_Input xmlns="urn:crmondemand/ws/ecbs/account/">
    <ListOfAccount>
      <Account operation="skipnode">
        <Id>1QA2-11V4OX</Id>
        <ListOfSharedAddress>
          <SharedAddress operation="insert">
            <AddressId>1QA2-1TAEXP</AddressId>
            <AddressType>Office</AddressType>
            <PrimaryBillingAddressFlag>true</PrimaryBillingAddressFlag>
            <PrimaryShippingAddressFlag>true</PrimaryShippingAddressFlag>
          </SharedAddress>
        </ListOfSharedAddress>
      </Account>
    </ListOfAccount>
  </AccountExecute_Input>
</soap:Body>
</soap:Envelope>

Import the contact record data by using Web services calls to insert the Contact-Address record data into Oracle CRM On Demand.

This insertion associates the shared addresses with the contacts. The following is a sample SOAP request for inserting the data:

<?xml version="1.0" encoding="utf-16" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsi="http://www.w3.org/2001/ XMLSchema-instance" xmlns:wsse="http://
docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecuritysecext- 1.0.xsd" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<wsse:Security>
   <wsse:UsernameToken>
     <wsse:Username>%%USERNAME%%</wsse:Username>
     <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-tokenprofile- 1.0#PasswordText">%%PASSWORD%%</wsse:Password>
   </wsse:UsernameToken>
</wsse:Security>
</soap:Header>
<soap:Body>
<ContactExecute_Input xmlns="urn:crmondemand/ws/ecbs/contact/">
   <ListOfContact>
      <Contact operation="skipnode">
         <Id>1QA2-1S5XPM</Id>
         <ListOfSharedAddress>
         <SharedAddress operation="insert">
           <AddressId>1QA2-1TAEXP</AddressId>
           <AddressType>Office</AddressType>
           <PrimaryContactAddressFlag>true</PrimaryContactAddressFlag>
         </SharedAddress>
        </ListOfSharedAddress>
     </Contact>
  </ListOfContact>
</ContactExecute_Input>
</soap:Body>
</soap:Envelope>

Import the dealer record data by using Web services calls to insert the Dealer-Address record data into Oracle CRM On Demand.

This insertion associates the shared addresses with the dealers. The following is a sample SOAP request for inserting the data:

<?xml version="1.0" encoding="utf-16" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsi="http://www.w3.org/2001/ XMLSchema-instance" xmlns:wsse="http://
docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecuritysecext- 1.0.xsd" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<wsse:Security>
   <wsse:UsernameToken>
     <wsse:Username>%%USERNAME%%</wsse:Username>
     <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-tokenprofile- 1.0#PasswordText">%%PASSWORD%%</wsse:Password>
   </wsse:UsernameToken>
</wsse:Security>
</soap:Header>
<soap:Body>
<DealerExecute_Input xmlns="urn:crmondemand/ws/ecbs/dealer/">
   <ListOfDealer>
      <Dealer operation="skipnode">
         <Id>1QA2-1FH4CA</Id>
         <ListOfSharedAddress>
           <SharedAddress operation="insert">
             <AddressId>1QA2-1TAEXP</AddressId>
             <AddressType>Office</AddressType>
             <PrimaryBillingAddressFlag>true</PrimaryBillingAddressFlag>
             <PrimaryShippingAddressFlag>true</PrimaryShippingAddressFlag>
           </SharedAddress>
         </ListOfSharedAddress>
      </Dealer>
   </ListOfDealer>
</DealerExecute_Input>
</soap:Body>
</soap:Envelope>

Import the partner record data by using Web services calls to insert the Partner-Address record data into Oracle CRM On Demand.

This insertion associates the shared addresses with the partners. The following is a sample SOAP request for inserting the data:

<?xml version="1.0" encoding="utf-16" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsi="http://www.w3.org/2001/ XMLSchema-instance" xmlns:wsse="http://
docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecuritysecext- 1.0.xsd" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<wsse:Security>
  <wsse:UsernameToken>
    <wsse:Username>%%USERNAME%%</wsse:Username>
    <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-tokenprofile- 1.0#PasswordText">%%PASSWORD%%</wsse:Password>
  </wsse:UsernameToken>
</wsse:Security>
</soap:Header>
<soap:Body>
  <PartnerInsert_Input xmlns="urn:crmondemand/ws/ecbs/partner/">
    <ListOfPartner>
      <Partner>
        <Id>1QA2-1U31RC</Id>
        <ListOfSharedAddress>
          <SharedAddress>
            <AddressId>1QA2-1TAEXP</AddressId>
            <AddressType>Office</AddressType>
            <PrimaryBillingAddressFlag>true</PrimaryBillingAddressFlag>
            <PrimaryShippingAddressFlag>true</PrimaryShippingAddressFlag>
          </SharedAddress>
        </ListOfSharedAddress>
      </Partner>
    </ListOfPartner>
  </PartnerInsert_Input>
</soap:Body>
</soap:Envelope>

Confirm that the data has been inserted correctly.
Set up the page layouts for the appropriate roles in your company, and assign the appropriate access to the page layouts for the user’s roles.
Update your users’ roles to include access to the Address record type in step 2 of the Role Management wizard.
If you do not complete this step, then users cannot view address records. For example, if they attempt to associate an address record with an account, then an error message is displayed.
Select the Enable Shared Addresses setting in the company profile to enable shared addresses.
If your company uses applications that are external to Oracle CRM On Demand to mark addresses as valid, and if you want to use only those validated addresses in address picklists, address searches, and address associations, then select the Validate Shared Addresses setting in the company profile.

Note: The Validation Date in an address record must be set to mark the address as validated. For more information, see Oracle CRM On Demand Online Help.

(Optional) After you have verified that the inserted data is correct, you can delete the preexisting unshared address data by using Web services calls. The following is a sample SOAP request for deleting the unshared address data:

<?xml version="1.0" encoding="utf-16" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsi="http://www.w3.org/2001/ XMLSchema-instance" xmlns:wsse="http://
docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecuritysecext- 1.0.xsd" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<wsse:Security>
  <wsse:UsernameToken>
    <wsse:Username>%%USERNAME%%</wsse:Username>
    <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-tokenprofile- 1.0#PasswordText">%%PASSWORD%%</wsse:Password>
  </wsse:UsernameToken>
</wsse:Security>
</soap:Header>
<soap:Body>
  <AccountExecute_Input xmlns="urn:crmondemand/ws/ecbs/account/">
    <ListOfAccount>
      <Account operation="skipnode">
        <Id>1QA2-11V4OX</Id>
        <ListOfAddress>
          <Address operation="delete">
            <Id>1QA2-11V4OZ</Id>
          </Address>
          <Address operation="delete">
            <Id>1QA2-11V4P1</Id>
          </Address>
        </ListOfAddress>
      </Account>
    </ListOfAccount>
  </AccountExecute_Input>
</soap:Body>
</soap:Envelope>

Address Location

The Address Location Web service allows you to return a list of addresses including both shared and unshared addresses.

Usage

All addresses, both shared and unshared are returned regardless of whether the Enable Shared Addresses check box is selected on the company profile.

Methods Called

The following table details the methods called by the Address Location service.

Table Methods Called by Address Location Service

Method	Name as Defined in Service
QueryPage	AddressLocationQueryPage

The following table details the pick map fields for the address location object.

Table Pick Maps Fields for the Address Location Object

Pick Map Field	Maps To
CustomObjectn Name	CustomObjectn Id
CustomObjectn ExternalSystemId	CustomObjectn Id

The following table details the user keys for the address location object.

Table User Keys for the Address Location Object

Field Name
Id
ExternalSystemId
AddressName

Allotment Usage

The allotment usage object stores information about the historical allotment usage for a company.

Usage

The Allotment Usage service is only accessible to users with the Manage Company privilege.

There are various elements of the ListOfAllotmentUsage argument that specify the service allotment usage data:

AggregationType. The aggregation type.
AggregationPeriodTotalUsage. The total usage in the aggregation period.
AggregationPeriodTimestamp. The aggregation period.
AllotmentLimitId. The value set for the allotment by Customer Care.
AllotmentUnit. The allotment unit of measure.
AllotmentType. The allotment type.
AllotmentLimitName. The allotment name.
AllotmentLimitDisplayName. The allotment name in the language currently active for the company.

Various audit fields are also returned. For more information about administration of service allotments, see Oracle CRM On Demand Online Help.

Methods Called

The following table details the methods called by the Allotment Usage service.

Table Methods Called by Allotment Usage Service

Method	Name as Defined in Service
QueryPage	AllotmentUsageQueryPage

Fields

The following table details the user keys for the allotment usage object.

Table User Keys for the Allotment Usage Object

Field Name
AllotmentLimitName

Asset

The asset object stores information on the assets held by your accounts, for example, the products that an account has purchased.

Child Objects

Audit Trail

Usage

Oracle On Demand Web Services uses assets to manage products through their life cycle. It is also used by your accounts to register products, receive product news and literature, track warranty agreements, and receive recommendations on scheduled services.

Methods Called

The following table details the methods called by the Asset service.

Table Methods Called by Asset Service

Method	Name as Defined in Service
Delete	AssetDelete
Execute	AssetExecute
Insert	AssetInsert
QueryPage	AssetQueryPage
Update	AssetUpdate

Fields

The following table details the required and read-only fields for the asset object.

Table Required and Read-Only Fields for the Asset Object

Field Name	Type
ProductId	Required
ProductCategory	Read-only
PartNumber	Read-only
Type	Read-only
Status	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the asset object.

Table Pick Map Fields for the Asset Object

Pick Map Field	Maps To
AccountIntegrationId	AccountId
AccountExternalSystemId	AccountId
Account, AccountLocation	AccountId
ProductIntegrationId	ProductId
ProductExternalSystemId	ProductId
Product	ProductId

The following table provides a list of the user key combinations for the asset object.

Table User Key Fields on the Asset Object

User Key Field Combinations
Id
ExternalSystemId
ProductId
ProductName
ProductExternalId

The following table details the picklists available for the asset object.

Table Picklists Available for the Asset Object

Field Name
Warranty
Contract

Book

The book object provides a way of segmenting data according to the organizational units of your business, such as territories or products. Administrators can create book hierarchies based on how they want to organize your information, and then set up users to have the appropriate level of access to books.

Note: To download the Book WSDL, you must be given access to the Book object. If you do not have access to the Book object, it is not available to download from the Web Services Administration pages. For assistance in gaining access to the Book object, contact your Oracle CRM On Demand service provider.

Methods Called

The following table details the methods called by the Book service.

Table Methods Called by Book Service

Method	Name as Defined in Service
Delete	BookDelete
Execute	BookExecute
Insert	BookInsert
QueryPage	BookQueryPage
Update	BookUpdate

Fields

The following table details the required and read-only fields for the book object.

Table Required and Read-Only Fields for the Book Object

Field Name	Type
BookName	Required
BookId	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the book object.

Table Pick Map Fields for the Book Object

Pick Map Field	Maps To
BookName	BookId

The following table provides a list of the user key combinations for the book object.

Table User Key Fields on the Book Object

User Key Field Combinations
Id
BookName

The following table details the picklists available for the book object.

Table Picklists Available for the Book Object

Field Name
BookType
ParentBookName

Campaign

The campaign object provides a mechanism for marketing products and services to customers and prospects. The campaign object is the primary way in which new products and services are marketed to customers and prospects.

Child Objects

Activity, Application, Attachment, Audit Trail, Book, Contact, Custom Object 1 through 3, Financial Account, Financial Plan, Lead, MDF Request, Event, Note, Policy

Methods Called

The following table details the methods called by the Campaign service.

Table Methods Called by Campaign Service

Method	Name as Defined in Service
Delete	CampaignDelete
Execute	CampaignExecute
Insert	CampaignInsert
QueryPage	CampaignQueryPage
Update	CampaignUpdate

Fields

The following table details the required and read-only fields for the campaign object.

Table Required and Read-Only Fields for the Campaign Object

Field Name	Type
CampaignName	Required
SourceCode	Required
Audit Fields	Read-only
CreatedByFullName	Read-only
LastUpdated	Read-only

The following table details the pick map field for the campaign object.

Table Pick Map Field for the Campaign Object

Pick Map Field	Maps To
Owner	OwnerId

The following table provides a list of the user key combinations for the campaign object.

Table User Key Fields on the Campaign Object

User Key Field Combinations
Id
ExternalSystemId
SourceCode
CampaignName

The following table details the picklists available for the campaign object.

Table Picklists Available for the Campaign Object

Field Name
CampaignType
IndexedPick0 through IndexedPick5
Status

Contact

The contact object stores information on individuals with whom your organization has a relationship. It allows the user to store information on individuals who are external to your company, but who are associated with the business process. Contacts stored in the Oracle CRM On Demand database can also be associated with an account.

Child Objects

Account, Activity, Address, Attachment, Audit Trail, Book, Business Plan, Blocked Product, Call Activity History, Campaign. Claim, Contact Best Times, Contact State License, Coverage, Custom Object 1 through 3, Deal Registration, Financial Account, Financial Account Holder, Financial Plan, HCP Contact Allocation, Household, Image, Interests, Involved Party, Lead, Message Response, Note, Objective, Opportunity, Plan Contact, Policy, Policy Holder, Portfolio, Related Contact, Revenue, Sales Assessment, Sales Assessment Value, Service Request, Signature, Shared Address,Social Profile Special Pricing Product, Team.

Note: When Enabled Shared Addresses is selected on the company profile, the address child object (<ListOfAddress>) cannot be used for insert, update, or delete operations. Only association and dissociation is allowed for the shared address child object. To update a shared address, you must access the top-level shared address object.

Methods Called

The following table details the methods called by the Contact service.

Table Methods Called by Contact Service

Method	Name as Defined in Service
Delete	ContactDelete
Execute	ContactExecute
Insert	ContactInsert
QueryPage	ContactQueryPage
Update	ContactUpdate

Fields

The following table details the required and read-only fields for the contact object.

Table Required and Read-Only Fields for the Contact Object

Field Name	Type
ContactFirstName	Required
ContactLastName	Required
AlternateAddressId	Read-only
ContactConcatField	Read-only
ContactFullName	Read-only
Audit Fields	Read-only
Manager	Read-only
PrimaryAddressId	Read-only

The following table details the pick map fields for the contact object.

Table Pick Map Fields for the Contact Object

Pick Map Field	Maps To
AccountName	AccountId
Owner	AssignedToAlias
SourceCampaignName	SourceCampaignId
ManagerExternalSystemId	ManagerId

The following table provides a list of the user key combinations for the contact object.

Table User Key Fields on the Contact Object

User Key Field Combinations
ContactFirstName and ContactLastName
Id
ExternalSystemId

The following table details the picklists available for the contact object.

Table Picklists Available for the Contact Object

Field Name
AssessmentFilter1 through AssessmentFilter4
BestTimeToCall
BlockedReasonCode
BuyingRole
CallFrequency
ClientStatus
ContactType
CurrentInvestmentMix
Degree
ExperienceLevel
Gender
IndexedPick0 through IndexedPick5
InvestmentHorizon
LeadSource
LifeEvent
MaritalStatus
MarketPotential
MrMrs
Objective
PrimaryGoal
RiskProfile
Route
Segment
Tier

The following table details a number of contact object fields that you must not use for customer integrations.

Table Contact Object Fields That You Must Not Use

Field Name
PartyTypeCode
PartyUId
PersonUId

Adding and Updating Contact Addresses

The information in this topic is applicable when the Enable Shared Addresses check box in the company profit is deselected, that is, when addresses are not shared.

Note: When Enable Shared Addresses is selected, the address child object, (<ListOfAddress>) cannot be used, and instead the shared address child object (<ListOfSharedAddress>) must be used to associate or dissociate addresses and flag addresses as billing, shipping, or primary addresses. For more information about the shared address child object, see Shared Address and for more information about the address child object, see Address.

The contact object has three types of address:

Primary address
Alternate address
Simple address

If the contact is associated with an account, the account’s billing address becomes the contact’s primary address, that is, the account’s billing address fields populate the contact’s primary address fields. The primary address fields are read-only in the contact record. The primary address might also be called the account address.

The alternate address is simply the contact’s address. Alternate address fields at the parent level are editable and this address is added to address children with the Primary checkbox in the UI selected. The alternate address might also be called the contact address.

You can use either ContactInsert, ContactUpdate or ContactExecute calls to insert or update primary or alternate addresses for a contact. With ContactInsert or ContactUpdate calls, the contact parent node with primary and alternate address fields must be present, and there must not be any child node. If an address child is present, only a simple address can be added, and not primary and alternate addresses. If the address child or any other child node is not present, only primary and alternate addresses can be added, and not simple addresses.

With the ContactExecute call, both the contact parent node and address child node can be present along with primary and alternate address fields at the parent level.

Note: A PrimaryAddressLine1 field is used to dynamically map the primary address field from an external application to the primary address field in Oracle CRM On Demand. For more information, see Mapping Primary Address Fields Using Web Services.

CustomObject

The CustomObject services expose the functionality of the CustomObject objects to external applications.

Tip: The reference information for each of Custom Objects follows the same pattern. In this topic, the information for CustomObject1 is given as an example.

The name of some CustomObject fields in the WSDL files for Web Services v2.0 differ from the names used in the WSDL files for Web Services v1.0. For example, the Web Services v1.0 fields ParentExternalSystemId and ParentName correspond to CustomObject1ExternalSystemId and CustomObject1Name for Web Services v2.0.

Note: To download the CustomObject WSDL file, you must be given access to the relevant CustomObject object. If you do not have access to the CustomObject object, it is not available to download from the Web Services Administration page or available to use Web service calls. For assistance in gaining access to the CustomObject objects, contact your Oracle CRM On Demand service provider.

Support for Attachments

For Custom Object1 through 40, attachments are accessible through the following fields:

UI Display Name	Integration Tag Name
Attachment	AttachFileFullName
Attachment: Extension	AttachFileExt
Attachment: File Name	AttachFileName
Attachment: Size (in Bytes)	AttachFileSizeDisp

For Custom Object 4 through 40, the <Attachment> tag is used for the actual attachment and is a string type Base64. For Custom Object 1 through 3 however, the <PrimaryAttachment> tag is used for this purpose.

Requests that specify empty values for the following fields remove the associated attachment and clear all attachment-related field values:

AttachFileName
AttachFileExt
Attachment

For Custom Object 1 through 3 you can also exchange attachments through the Attachment child object as described in Using Attachments with Web Services On Demand For Custom Object 4 through 40, an Attachment child object is not accessible.

Methods Called

The following table details the methods called by the CustomObject1 service. The methods for the other Custom Objects follow the same pattern.

Table Methods Called by Custom ObJect1 Service

Method	Name as Defined in Service
Delete	CustomObject1Delete
Execute	CustomObject1Execute
Insert	CustomObject1Insert
QueryPage	CustomObject1QueryPage
Update	CustomObject1Update

Fields

The following table details the required and read-only fields for the CustomObject1 object.

Note: This section details the fields for the CustomObject1 objects. The other Custom Objects follow the same pattern.

The following table details the pick map fields for the CustomObject1 object.

Table Pick Map Fields for the CustomObject1 Object

Pick Map Field	Maps To
AccountExternalId	AccountId
AccountIntegrationId	AccountId
AccountName	AccountId
ActivityExternalId	ActivityId
ActivityIntegrationId	ActivityId
ActivityName	ActivityId
CampaignExternalId	CampaignId
CampaignIntegrationId	CampaignId
CampaignName	CampaignId
ContactExternalId	ContactId
ContactFirstName	ContactId
ContactFullName	ContactId
ContactIntegrationId	ContactId
ContactLastName	ContactId
CustomObjectnExternalId	CustomObjectnId
CustomObjectnIntegrationId	CustomObjectnId
CustomObjectnName	CustomObjectnId
DealerName	DealerId
HouseholdExternalId	HouseholdId
HouseholdIntegrationId	HouseholdId
HouseholdName	HouseholdId
LeadExternalId	LeadId
LeadFirstName	LeadId
LeadFullName	LeadId
LeadIntegrationId	LeadId
LeadLastName	LeadId
Owner	OwnerId
OpportunityExternalId	OpportunityId
OpportunityIntegrationId	OpportunityId
OpportunityName	OpportunityId
ParentExternalSystemId	ParentId
ParentIntegrationId	ParentId
PortfolioAccountNumber	PortfolioId
ProductExternalId	ProductId
ProductIntegrationId	ProductId
ProductName	ProductId
SolutionExternalId	SolutionId
SolutionIntegrationId	SolutionId
SolutionTitle	SolutionId
ServiceRequestExternalId	ServiceRequestId
ServiceRequestIntegrationId	ServiceRequestId
ServiceRequestName	ServiceRequestId
VIN	VehicleId

The following table provides a list of the user key combinations for the CustomObject1 object.

Table User Key Fields on the CustomObject1 Object

User Key Field Combinations
Id
ExternalSystemId

Division

The division object organizes users into groupings to meet business needs. For example, you can use divisions to organize users on a geographical basis.

Usage

You can associate divisions with picklist value groups, so that for users in certain divisions, the values that appear in the picklists in certain fields on records are limited to subsets of the values that are defined for the fields. Each division can be associated with one picklist value group only. The PickValueGroupFullName and PickValueGroupID are used to identify the picklist value group.

A user can be associated with one or more divisions. You can associate users with divisions in two ways:

From a division record, through the user child object
From a user record, through the division child object

For more information about divisions and picklist value groups, see Oracle CRM On Demand Online Help.

Child Object

Audit Trail,User

Methods Called

The following table details the methods called by the Division service.

Table Methods Called by Division Service

Method	Name as Defined in Service
Delete	DivisionDelete
Execute	DivisionExecute
Insert	DivisionInsert
QueryPage	DivisionQueryPage
Update	DivisionUpdate

Fields

The following table details the required and read-only fields for the division object.

Table Required and Read-Only Fields for the Division Object

Field Name	Type
Name	Required
Id	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the division object.

Table Pick Map Fields for the Division Object

Pick Map Field	Maps To
Name	Id

The following table provides a list of the user key combinations for the division object.

Table User Key Fields on the Division Object

User Key Field Combinations
Id
Name

Exchange Rate

The exchange rate object stores information about exchange rates for the currencies used by a company.

Usage

Administrators can create new exchange rates, update, or delete existing exchange rates, and query the exchange rate history for their company.

All fields are required when inserting new exchange rate records. For insert operations, the ToCurrencyCode value must be the company's default currency value.

Only the FromCurrencyCode, ToCurrencyCode, and ExchangeDate fields are required for update delete operations. However, these fields are not editable for an update operation.

The date value in the ExchangeDate field must be specified in the format: yyyy-mm-dd. For example, a value of 2011-10-12 specifies the date as 12th October 2011.

The ExchangeRateHistory child object can be queried to give the history of exchange rates for the company.

Methods Called

The following table details the methods called by the Exchange Rate service.

Table Methods Called by Exchange Rate Service

Method	Name as Defined in Service
Delete	ExchangeRateDelete
Execute	ExchangeRateExecute
Insert	ExchangeRateInsert
QueryPage	ExchangeRateQueryPage
Update	ExchangeRateUpdate

Fields

The following table details the required and read-only fields for the exchange rate object.

Table Required and Read-Only Fields for the Exchange Rate Object

Field Name	Type
FromCurrencyCode	Required
ToCurrencyCode	Required
ExchangeDate	Required
ExchangeRate	Required

The following table provides a list of the user key combinations for the exchange rate object.

Table User Key Fields on the Exchange Rate Object

User Key Field Combinations
FromCurrencyCode
ToCurrencyCode
ExchangeDate

Group

The group object allows you to create groups to which users can be added. Users can only be a member of one group, and groups can contain many users.

The group object is equivalent to the Web Services V1.0 user group object.

Methods Called

The following table details the methods called by the Group service.

Table Methods Called by Group Service

Method	Name as Defined in Service
Delete	GroupDelete
Execute	GroupExecute
Insert	GroupInsert
QueryPage	GroupQueryPage
Update	GroupUpdate

Fields

The following table details the required and read-only fields for the group object.

Table Required and Read-Only Fields for the Group Object

Field Name	Type
Name	Required
UserGroupId	Read-only
Audit Fields	Read-only

The following table details the pick map field for the group object.

Table Pick Map Field for the Group Object

Pick Map Field	Maps To
UserIntegrationId	UserId
UserExternalSystemId	UserId

The following table provides a list of the user key combinations for the group object.

Table User Key Fields on the Group Object

User Key Field Combinations
Id
ExternalSystemId
Name

Lead

The lead object stores information on a company or individual with whom an opportunity can be created. It allows the user to identify the companies that might be interested in a product or service. Leads are usually generated as part of a marketing campaign.

Note: A PrimaryAddressLine1 field is used to dynamically map the primary address field from an external application to the primary address field in Oracle CRM On Demand. For more information, see Mapping Primary Address Fields Using Web Services.

Child Objects

Activity, Attachment, Audit Trail,Book, Custom Object 1 through 3, Custom Object 4 through 15, Deal Registration, Event, Team.

Methods Called

The following table details the methods called by the Lead service.

Table Methods Called by Lead Service

Method	Name as Defined in Service
Delete	LeadDelete
Execute	LeadExecute
Insert	LeadInsert
QueryPage	LeadQueryPage
Update	LeadUpdate

Fields

The following table details the required and read-only fields for the lead object.

Table Required and Read-Only Fields for the Lead Object

Field Name	Type
FirstName	Required
LastName	Required
LeadOwner	Required
ContactFullName	Read-only
Audit Fields	Read-only
LastUpdated	Read-only
LeadConcatField	Read-only
LeadFullName	Read-only
ReferredById	Read-only

The following table details the pick map fields for the lead object.

Table Pick Map Fields for the Lead Object

Pick Map Field	Maps To
Campaign	CampaignId
OpportunityName	OpportunityId
Owner	OwnerId
AccountExternalSystemId	AccountId
OpportunityExternalSystemId	OpportunityId
ContactExternalSystemId	ContactId
CampaignExternalSystemId	CampaignId
ReferredByExternalSystemId	ReferredById

The following table provides a list of the user key combinations of the lead object.

Table User Key Fields on the Lead Object

User Key Field Combinations
Id
ExternalSystemId
LeadFirstName and LeadLastName

The following table details the picklists available for the lead object.

Table Picklists Available for the Lead Object

Field Name
AssessmentCategory1 through AssessmentCategory4
IndexedPick0 through IndexedPick5
LeadType
MrMrs
OwnershipStatus
Rating
RejectCode
Source

Modification Tracking

Modification tracking is available for applications developed by Oracle CRM On Demand partners and customer integrations. This includes the Oracle CRM On Demand Disconnected Mobile Sales application. Administrators whose role includes the Manage Modification Tracking privilege can do the following in the UI.

Enable automatic modification tracking for a given set of record types. For the record types that are tracked, change events are written to a modification tracking record.
Create event records manually.

Old modification tracking records (records that are 30 days or older) are permanently deleted whenever a regular purge of deleted items occurs in Oracle CRM On Demand.

You can use the Modification Tracking service to query event records or to insert and delete records, if your role includes the Manage Modification Tracking privilege. Requests must include the correct record type name in the ObjectName field. For information about the record types supported for modification tracking, and the correct record type names to use in Web service requests, refer to Oracle CRM On Demand Online Help and supplemental documentation.

Child Objects

None.

Methods Called

The following table details the methods called by the Modification Tracking service.

Table Methods Called by Modification Tracking Service

Method	Name as Defined in Service
Delete	ModificationTrackingDelete
Execute	ModificationTrackingExecute
Insert	ModificationTrackingInsert
QueryPage	ModificationTrackingQueryPage
Update	ModificationTrackingUpdate

Fields

The following table details the required and read-only fields for the modification tracking object.

Table Required and Read-Only Fields for the Modification Tracking Object

Field Name	Type
ObjectId	Required
EventName	Required
ObjectName	Required
ModificationNumber	Required
Audit Fields	Read-only

The following table provides a list of the user key combinations for the modification tracking object.

Table User Key Fields on the Modification Tracking Object

User Key Field Combinations
Id
ObjectName

Note

The note object stores information about the notes available in the Message Center in the Oracle CRM On Demand application. The notes can be sent from users or can store extra information (as a note) on a parent object. This allows employees who are working on a particular record to add extra information as they see fit. For example, when talking to a contact, an employee might notice that the contact is not happy with a service provided. The employee can record this information in a note so that any other employees who talk to the contact are aware of the contact’s dissatisfaction.

Methods Called

The following table details the methods called by the Note service.

Table Methods Called by Note Service

Method	Name as Defined in Service
Delete	NoteDelete
Execute	NoteExecute
Insert	NoteInsert
QueryPage	NoteQueryPage
Update	NoteUpdate

Fields

The following table details the required and read-only fields for the note object.

Table Required and Read-Only Fields for the Note Object

Field Name	Type
Subject	Required
NoteId	Read-only
OwnerId	Read-only
OwnerAlias	Read-only
ParentNoteId	Read-only
SourceId	Read-only
SourceName	Read-only
Audit Fields	Read-only

The following table provides a list of the user key combinations for the note object.

Table User Key Fields on the Note Object

User Key Field Combinations
NoteId

Opportunity

The opportunity object allows employees to identify and record a potential revenue-generating event that has arisen with an account or contact. Opportunities can be generated from marketing campaigns when leads indicate that they are interested in a product or service that has been offered.

Methods Called

The following table details the methods called by the Opportunity service.

Table Methods Called by Opportunity Service

Method	Name as Defined in Service
Delete	OpportunityDelete
Execute	OpportunityExecute
Insert	OpportunityInsert
QueryPage	OpportunityQueryPage
Update	OpportunityUpdate

Fields

The following table details the required and read-only fields for the opportunity object.

Table Required and Read-Only Fields for the Opportunity Object

Field Name	Type
AccountId	Required
CloseDate	Required
OpportunityName	Required
SalesStage	Required
Audit Fields	Read-only
LastUpdated	Read-only
OpportunityConcatField	Read-only

The following table details the pick map fields for the opportunity object.

Table Pick Map Fields for the Opportunity Object

Pick Map Field	Maps To
Owner	OwnerId
AccountExternalSystemId	AccountId
Territory	TerritoryId
KeyContactIntegrationId	KeyContactId
KeyContactExternalSystemId	KeyContactId

The following table provides a list of the user key combinations for the opportunity object.

Table User Key Fields on the Opportunity Object

User Key Field Combinations
Id
ExternalSystemId
Name

The following table details the picklists available for the opportunity object.

Table Picklists Available for the Opportunity Object

Field Name
ApprovalStatus
AssessmentFilter1 through AssessmentFilter4
IndexedPick0 through IndexedPick5
LeadSource
OpportunityType
OwnershipStatus
Priority
Probability
ReasonWonLost
RegistrationStatus
Status
Type
Year

Period

The period object stores information about the fiscal periods for a company.

Child Objects

Usage

There are various elements of the ListOfFiscalPeriod argument that specify the period data:

PeriodName. The name of the fiscal period.
StartDate. The start date for the fiscal period.
EndDate. The end date for the fiscal period.
PeriodType. The period type.
Description. A description for the fiscal period.

For more information about administration of fiscal periods, see Oracle CRM On Demand Online Help.

Methods Called

The following table details the methods called by the Period service.

Table Methods Called by Period Service

Method	Name as Defined in Service
QueryPage	FiscalPeriodQueryPage

Fields

The following table details the user keys for the Period object.

Table User Keys for the Period Object

Field Name
PeriodName

Product

The product object allows you to define and record details about a product or service that your company sells to its customers, including information on product price, category, and so on.

Child Objects

Image, Price List Line Item

Methods Called

The following table details the methods called by the Product service.

Table Methods Called by Product Service

Method	Name as Defined in Service
Execute	ProductExecute
Insert	ProductInsert
QueryPage	ProductQueryPage
Update	ProductUpdate

Fields

The following table details the required and read-only fields for the product object.

Table Required and Read-Only Fields for the Product Object

Field Name	Type
ProductName	Required
Audit Fields	Read-only

The following table details the pick map field for the product object.

Table Pick Map Field for the Product Object

Pick Map Field	Maps To
ParentCategory	ParentCategoryId

The following table details the user keys for the product object.

Table User Keys for the Product Object

Field Name
ProductName
Id
ExternalSystemId

The following table details the picklists available for the product object.;

Table Picklists Available for the Product Object

Field Name
BodyStyle
Category
Class
CurrencyCode
DoorStyle
Engine
Make
Model
PriceType
ProductType
Revision
Status
SubType
TherapeuticClass
Transmission
Trim

Service Allotment

The service allotment object stores information about the service allotments for a company.

Usage

The Service Allotment service is only accessible to users with the Manage Company privilege.

There is only one method, ServiceAllotmentQueryPage, which returns the service allotment data for the company.

There are various elements of the ListOfServiceAllotment argument that specify the service allotment data, as follows:

Name. The allotment name.
Value. The value set for the allotment by Customer Care
CurrentUsage. The amount of the allotment currently used.
AlertThreshold. The threshold value at which a warning email is sent.
AlertEnabled. Whether an alert is enabled for the allotment.
EmailAlertList. The email addresses of the users who will receive a warning email.
AllotmentEmailSentDate. The date when an email notifying full usage of the allotment was sent.
ThresholdEmailSentDate. The date when a warning email for the allotment was sent.
DisplayName. The allotment name in the language currently active for the company.
AllotmentUnit. The allotment unit of measure.
AllotmentType. The type of allotment.
RemainingUsage. The amount of the allotment remaining.
Description. A description of the allotment.
ListOfAllotmentUsage. The allotment usage data, which consists of the following:
- AggregationType. The aggregation type.
- AggregationPeriodTotalUsage. The total usage in the aggregation period.
- AggregationPeriodTimestamp. The aggregation period.
- AllotmentLimitId. The value set for the allotment by Customer Care.
- AllotmentUnit. The allotment unit of measure.
- AllotmentType. The allotment type.
- AllotmentLimitName. The allotment name.
- AllotmentLimitDisplayName. The allotment name in the language currently active for the company.

There are also various audit fields returned. For more information about administration of service allotments, see Oracle CRM On Demand Online Help.

Methods Called

The following table details the methods called by the Service Allotment service.

Table Methods Called by Service Allotment Service

Method	Name as Defined in Service
QueryPage	ServiceAllotmentQueryPage

Fields

The following table details the user keys for the service allotment object.

Table User Keys for the Service Allotment Object

Field Name
Name

Service Request

The service request object allows customers to request information or assistance with a problem related to products or services purchased from your company. Service requests can be ranked for severity and prioritized accordingly.

Child Objects

Activity, Attachment, Audit Trail,Custom Object 1 through 3, Note, Sales Assessment, Sales Assessment Value, Team.

Methods Called

The following table details the methods called by the Service request service.

Table Methods Called by Service Request Service

Method	Name as Defined in Service
Delete	ServiceRequestDelete
Execute	ServiceRequestExecute
Insert	ServiceRequestInsert
QueryPage	ServiceRequestQueryPage
Update	ServiceRequestUpdate

Fields

The following table details the required and read-only fields for the service request object.

Table Required and Read-Only Fields for the Service Request Object

Field Name	Type
ContactEmail	Read-only
ContactFirstName	Read-only
ContactFullName	Read-only
ContactLastName	Read-only
Audit Fields	Read-only
LastUpdated	Read-only
ServiceRequestContactId	Read-only

The following table details the pick map fields for the service request object.

Table Pick Map Fields for the Service Request Object

Pick Map Field	Maps To
Owner	OwnerId
AccountExternalSystemId	AccountId
AssetIntegrationId	AssetId
AssetExternalSystemId	AssetId
ProductExternalSystemId	ProductId

The following table provides a list of the user key combinations for the service request object.

Table User Key Fields on the Service Request Object

User Key Field Combinations
Id
ExternalSystemId
SRNumber

The following table details the picklists available for the service request object.

Table Picklists Available for the Service Request Object

Field Name
Area
Cause
Priority
Source
Status Note: The Status picklist is editable for users whose role includes the Customize Application - Edit Service Request 'Status' Picklist privilege
Type

Social Media

The social media object stores information about the social media postings of contacts.

Note: The social media object is accessible only to users whose role has the Integration:SEM privileges enabled.

Child Objects

Audit Trail,Service Request

Methods Called

The following table details the methods called by the Social Media service.

Table Methods Called by Social Media Service

Method	Name as Defined in Service
Delete	SocialMediaDelete
Execute	SocialMediaExecute
Insert	SocialMediaInsert
QueryPage	SocialMediaQueryPage
Update	SocialMediaUpdate

Fields

The following table details the required and read-only fields for the social media object.

Table Required and Read-Only Fields for the Social Media Object

Field Name	Type
AuthorId	Required
Community	Required
PostLink	Required
UniqueID	Required
Audit Fields	Read-only

The following table details the pick map fields for the social media object.

Table Pick Map Fields for the Social Media Object

Pick Map Field	Maps To
ContactFullName	ContactId
ContactIntegrationId	ContactId
ContactExternalSystemId	ContactId

The following table provides a list of the user key combinations for the social media object.

Table User Key Fields on the Social Media Object

User Key Field Combinations
Id
ExternalSystemId

Social Profile

The social profile object stores information about the profiles that contacts use in their social media interactions.

Note: The social profile object is accessible only to users whose role has the Integration:SEM privileges enabled.

Child Objects

Assigned Books, Audit Trail, Delegated User, Division, User Default Book Per Type

Methods Called

The following table details the methods called by the Social Profile service.

Table Methods Called by Social Profile Service

Method	Name as Defined in Service
Delete	SocialProfileDelete
Execute	SocialProfileExecute
Insert	SocialProfileInsert
QueryPage	SocialProfileQueryPage
Update	SocialProfileUpdate

Fields

The following table details the required and read-only fields for the social profile object.

Table Required and Read-Only Fields for the Social Profile Object

Field Name	Type
ContactId	Required
AuthorId	Required
Community	Required
Active	Required
Audit Fields	Read-only

The following table details the pick map fields for the social profile object.

Table Pick Map Fields for the Social Profile Object

Pick Map Field	Maps To
ContactFullName	ContactId
ContactIntegrationId	ContactId
ContactExternalSystemId	ContactId

The following table provides a list of the user key combinations for the social profile object.

Table User Key Fields on the Social Profile Object

User Key Field Combinations
Id
ExternalSystemId

Solution

The solution object stores information on solutions to customer problems or service requests. Solutions can be reused if the same problem is identified with a product or service. This prevents the duplication of work for customer service representatives.

Child Objects

Attachment, Audit Trail,Book, Message Response, Messaging Plan, Messaging Plan Item, Messaging Plan Item Relation, Service Request.

Methods Called

The following table details the methods called by the Solution service.

Table Methods Called by Solution Service

Method	Name as Defined in Service
Delete	SolutionDelete
Execute	SolutionExecute
Insert	SolutionInsert
QueryPage	SolutionQueryPage
Update	SolutionUpdate

Fields

The following table details the required and read-only fields for the solution object.

Table Required and Read-Only Fields for the Solution Object

Field Name	Type
Title	Required
Audit Fields	Read-only
CreatorId	Read-only
LastUpdated	Read-only

The following table provides a list of the user key combinations for the solution object.

Table User Key Fields on the Solution Object

User Key Field Combinations
Name
Id
ExternalSystemId

The following table details the picklists available for the solution object.

Table Picklists Available for the Solution Object

Field Name
Area
Cause
Priority
Source
Status
Type

Territory

The territory object allows you to store information about the sales territory that is assigned to a user. This information includes the territory name, a description, the currency code, and the sales quota for the territory.

Methods Called

The following table details the methods called by the Territory service.

Table Methods Called by Territory Service

Method	Name as Defined in Service
Delete	TerritoryDelete
Execute	TerritoryExecute
Insert	TerritoryInsert
QueryPage	TerritoryQueryPage
Update	TerritoryUpdate

Fields

The following table details the required and read-only fields for the territory object.

Table Required and Read-Only Fields for the Territory Object

Field Name	Type
TerritoryName	Required
Territory	Read-only
Audit Fields	Read-only

The following table details the pick map field for the territory object.

Table Pick Map Field for the Territory Object

Pick Map Field	Maps To
ParentTerritoryIntegrationId	ParentTerritoryId
ParentTerritoryExternalSystemId	ParentTerritoryId
ParentTerritoryId	ParentTerritoryId

The following table details the user key for the territory object.

Table User Key for the Territory Object

Field Name
Id
ExternalSystemId
TerritoryName

The following table details the picklist fields available for the territory object.

Table Picklists Available for the Territory Object

Field Name
ParentTerritoryExternalSystemId
ParentTerritoryIntegrationId

User

The user object allows you to define and record details of all users in Oracle CRM On Demand, for example, name, position, contact details, manager, and so on. It enables queries to be run on all users, and enables an administrator to insert and update a user’s profile.

Usage

The UserLoginId and UserSignInId fields must be used as follows:

UserLoginId. Used for creating user records through the User Web service.
UserSignInId. Used as the user name for logging in and authenticating using Web services. Also, used for queries, as using UserLoginId is not allowed for queries.

Starting with Oracle CRM On Demand Release 23, you can use the DefaultBookId and DefaultAnalyticsBookId fields respectively to access the default book and default analytics book for a user. In previous releases it was possible to access the default books through the DefaultBookName and DefaultAnalyticsBookName fields only.

A user can be associated with one or more divisions. You can associate users with divisions in two ways:

From a division record, through the user child object
From a user record, through the division child object

The first division that is associated with a user record is automatically specified as the primary division for the user, but you can change the primary division for the user through the PrimaryDivisionName field.

Child Objects

Methods Called

The following table details the methods called by the User service.

Table Methods Called by User Service

Method	Name as Defined in Service
Execute	UserExecute
Insert	UserInsert
QueryPage	UserQueryPage
Update	UserUpdate

Fields

The following table details the required and read-only fields for the user object.

Table Required and Read-Only Fields for the User Object

Field Name	Type
FirstName	Required
LastName	Required
UserLoginId	Required
UserSignInId	Required
Alias	Required
EmailAddr	Required
Role	Required
Status	Required
Audit Fields	Read-only
LastSignInDateTime	Read-only
ManagerFullName	Read-only

The following table details the pick map field for the user object.

Table Pick Map Field for the User Object

Pick Map Field	Maps To
Role	RoleId

The following table provides a list of user key combinations for the user object.

Table User Key Fields on the User Object

User Key Field Combinations
Id
UserId
ExternalSystemId
Alias

Partner Relationship Management Edition Objects (Web Services v2.0)

This topic includes the parent objects available with Oracle CRM On Demand Partner Relationship Management Edition. For these parent objects, all child objects are also accessible.

Note: To download WSDL files for these objects, you must be given access to the object. If you do not have access to the object, it is not available to download from the Web Services Administration page or available to use the Web service calls. For assistance in gaining access to the objects, contact your Oracle CRM On Demand service provider.

The following objects are detailed in this topic:

Accreditation

The accreditation object stores information about a partner company's accreditation for selling products, providing services, or both. Accreditations are an acknowledgement of a partner company's skill, competence, and training in selling a particular line of products or offering services such as design, installation, upgrade, and so on. A partner company is awarded an accreditation upon satisfying several requirements; one of which is usually a minimum number (or percentage) of employees with specific certifications. In Oracle CRM On Demand, an accreditation can be held only by a partner company. Individuals cannot hold accreditations; instead, they hold certifications.

Child Objects

Accreditation, Accreditation Request, Attachment, Audit Trail,Book, Category, Certification, Custom Object 01-03, Custom Object 4 through 15, Product, Solution, Team.

Methods Called

The following table details the methods called by the Accreditation service.

Table Methods Called by Accreditation Service

Method	Name as Defined in Service
Delete	AccreditationDelete
Execute	AccreditationExecute
Insert	AccreditationInsert
QueryPage	AccreditationQueryPage
Update	AccreditationUpdate

Fields

The following table details the required and read-only fields for the accreditation object.

Table Required and Read-Only Fields for the Accreditation Object

Field Name	Type
Name	Required
Status	Required
OwnerId	Required
Audit Fields	Read-only

The following table details the pick map fields for the accreditation object.

Table Pick Map Fields for the Accreditation Object

Pick Map Field	Maps To
PrimaryProductProductCategory, PrimaryProductExternalSystemId, PrimaryProductDescription, PrimaryProductName, PrimaryProductPartNumber, PrimaryProductStatus, PrimaryProductIntegrationId, PrimaryProductType	PrimaryProductId
PrimaryProductCategoryName	PrimaryProductCategoryId
ContactEmail, ContactFirstName, ContactLastName, ContactFullName, ContactIntegrationId, ContactAccountName, ContactExternalSystemId	ContactId
ObjectiveName, ObjectiveExternalSystemId	ObjectiveId

The following table provides a list of the user key combinations for the accreditation object.

Table User Key Fields on the Accreditation Object

User Key Field Combinations
Id
Name

The following table details the picklists available for the accreditation object.

Table Picklists Available for the Accreditation Object

Field Name
PaymentOption
Status
Type

Accreditation Request

The accreditation request object stores information about a partner company's request for accreditation.

Child Objects

None

Methods Called

The following table details the methods called by the Accreditation Request service.

Table Methods Called by Accreditation Request Service

Method	Name as Defined in Service
Delete	AccreditationRequestDelete
Execute	AccreditationRequestExecute
Insert	AccreditationRequestInsert
QueryPage	AccreditationRequestQueryPage
Update	AccreditationRequestUpdate

Fields

The following table details the required and read-only fields for the accreditation request object.

Table Required and Read-Only Fields for the Accreditation Request Object

Field Name	Type
AccreditationId	Required
PartnerId	Required
OwnerId	Required
Audit Fields	Read-only

The following table details the pick map fields for the accreditation request object.

Table Pick Map Fields for the Accreditation Request Object

Pick Map Field	Maps To
AccreditationName, AccreditationNum, AccreditationStatus, AccreditationType, AccreditationExternalSystemId	AccreditationId
PartnerChannelAccountManagerAlias, PartnerIntegrationId, PartnerExternalSystemId, PartnerLocation, PartnerMainPhone, PartnerName	PartnerId
ObjectiveName, ObjectiveExternalSystemId	ObjectiveId
PlanName, PlanType, PlanStatus, PlanDescription, PlanExternalSystemId	PlanId

The following table provides a list of the user key combinations for the accreditation request object.

Table User Key Fields on the Accreditation Request Object

User Key Field Combinations
Id
AccreditationId, PartnerId and RequestDate

The following table details the picklists available for the accreditation request object.

Table Picklists Available for the Accreditation Request Object

Field Name
Status

Application

The application object is the means by which a new or existing partner applies for a partnership with the brand owner. The brand owner then reviews, approves, or rejects the application.

Child Objects

Activity, Audit Trail,Book, Team.

Methods Called

The following table details the methods called by the Application service.

Table Methods Called by Application Service

Method	Name as Defined in Service
Delete	ApplicationDelete
Execute	ApplicationExecute
Insert	ApplicationInsert
QueryPage	ApplicationQueryPage
Update	ApplicationUpdate

Fields

The following table details the required and read-only fields for the application object.

Table Required and Read-Only Fields for the Application Object

Field Name	Type
ContactFirstName	Required
ContactLastName	Required
SubmissionStatus	Required
CompanyName	Required
CurrencyCode	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the application object.

Table Pick Map Fields for the Application Object

Pick Map Field	Maps To
CurrentApproverAlias	CurrentApproverId
AssociatedPartnerName	PartnerId
PartnerProgramProgramName	PartnerProgramId
CampaignName	CampaignId
OwnerAlias	OwnerId
ProcessedByAlias	ProcessedById

The following table provides a list of the user key combinations for the application object.

Table User Key Fields on the Application Object

User Key Field Combinations
Id
ExternalSystemId
CompanyName

The following table details the picklists available for the application object.

Table Picklists Available for the Application Object

Field Name
ApprovalStatus
PartnerType
ProgramLevel
RejectReason
Source
SubmissionStatus

Certification

The certification object stores information about an individual's competency in a specific set of skills. In Oracle CRM On Demand, certifications are always associated with an individual, in contrast to accreditations, which are always associated with a partner company. A certification is proof of an individual's competency in a specific set of skills.

Child Objects

Accreditation, Attachment, Audit Trail,Book, Category, Certification, Certification Request, Course, Custom Object 01-03, Custom Object 4 through 15, Exam, Product, Solution, Team.

Methods Called

The following table details the methods called by the Certification service.

Table Methods Called by Certification Service

Method	Name as Defined in Service
Delete	CertificationDelete
Execute	CertificationExecute
Insert	CertificationInsert
QueryPage	CertificationQueryPage
Update	CertificationUpdate

Fields

The following table details the required and read-only fields for the certification object.

Table Required and Read-Only Fields for the Certification Object

Field Name	Type
Name	Required
Status	Required
OwnerId	Required
Audit Fields	Read-only

The following table details the pick map fields for the certification object.

Table Pick Map Fields for the Certification Object

Pick Map Field	Maps To
PrimaryProductProductCategory, PrimaryProductExternalSystemId, PrimaryProductDescription, PrimaryProductName, PrimaryProductPartNumber, PrimaryProductStatus, PrimaryProductIntegrationId, PrimaryProductType	PrimaryProductId
PrimaryProductCategoryName	PrimaryProductCategoryId
ContactEmail, ContactFirstName, ContactLastName, ContactFullName, ContactIntegrationId, ContactAccountName, ContactExternalSystemId	ContactId
ObjectiveName, ObjectiveExternalSystemId	ObjectiveId

The following table provides a list of the user key combinations for the certification object.

Table User Key Fields on the Certification Object

User Key Field Combinations
Id
Name

The following table details the picklists available for the certification object.

Table Picklists Available for the Certification Object

Field Name
PaymentOption
Status
Type

Certification Request

The certification request object stores information about an individual’s request for certification.

Child Objects

None.

Methods Called

The following table details the methods called by the Certification Request service.

Table Methods Called by Certification Request Service

Method	Name as Defined in Service
Delete	CertificationRequestDelete
Execute	CertificationRequestExecute
Insert	CertificationRequestInsert
QueryPage	CertificationRequestQueryPage
Update	CertificationRequestUpdate

Fields

The following table details the required and read-only fields for the certification request object.

Table Required and Read-Only Fields for the Certification Request Object

Field Name	Type
CertificationId	Required
ContactId	Required
OwnerId	Required
Audit Fields	Read-only

The following table details the pick map fields for the certification request object.

Table Pick Map Fields for the Certification Request Object

Pick Map Field	Maps To
CertificationName, CertificationNum, CertificationStatus, CertificationType, CertificationExternalSystemId	CertificationId
ContactEmail, ContactFirstName, ContactLastName, ContactFullName, ContactIntegrationId, ContactAccountName, ContactExternalSystemId	ContactId
ObjectiveName, ObjectiveExternalSystemId	ObjectiveId
PlanName, PlanType, PlanStatus, PlanDescription, PlanExternalSystemId	PlanId

The following table provides a list of the user key combinations for the certification request object.

Table User Key Fields on the Certification Request Object

User Key Field Combinations
Id
CertificationId, ContactId, and RequestDate

The following table details the picklists available for the certification request object.

Table Picklists Available for the Certification Request Object

Field Name
Status

Course

The course object stores information about a training course. A course is a structured educational programme offered with the primary aim of imparting a specific set of skills to an individual. Many companies, especially those that deal with complex products or services, require their partners and resellers to be adequately trained in and familiar with what they sell. Typically, courses focus on a specific product or product family; however, at times, they might also deal with generic concepts or principles. Courses might either be theoretical or practical, or a blend of both.

Child Objects

Attachment, Audit Trail,Book, Category, Certification, Course, Course Enrollment, Custom Object 01-03, Custom Object 4 through 15, Exam, Partner, Product, Solution, Team.

Methods Called

The following table details the methods called by the Course service.

Table Methods Called by Course Service

Method	Name as Defined in Service
Delete	CourseDelete
Execute	CourseExecute
Insert	CourseInsert
QueryPage	CourseQueryPage
Update	CourseUpdate

Fields

The following table details the required and read-only fields for the course object.

Table Required and Read-Only Fields for the Course Object

Field Name	Type
Name	Required
Status	Required
OwnerId	Required
Audit Fields	Read-only

The following table details the pick map fields for the course object.

Table Pick Map Fields for the Course Object

Pick Map Field	Maps To
PrimaryProductProductCategory, PrimaryProductExternalSystemId, PrimaryProductDescription, PrimaryProductName, PrimaryProductPartNumber, PrimaryProductStatus, PrimaryProductIntegrationId, PrimaryProductType	PrimaryProductId
ProductCategoryName	ProductCategoryId
ContactEmail, ContactFirstName, ContactLastName, ContactFullName, ContactIntegrationId, ContactAccountName, ContactExternalSystemId	ContactId
ObjectiveName, ObjectiveExternalSystemId	ObjectiveId
ExamType, ExamStatus, ExamName, ExamID, ExamExternalSystemId	ExamId
OwnerFirstName, OwnerLastName, OwnerUserSignInId, OwnerAlias, OwnerFullName, OwnerIntegrationId, OwnerExternalSystemId, OwnerEMailAddr	OwnerId

The following table provides a list of the user key combinations for the course object.

Table User Key Fields on the Course Object

User Key Field Combinations
Id
CourseId, CandidateId, and EnrollDate

The following table details the picklists available for the course object.

Table Picklists Available for the Course Object

Field Name
Type
Status
Format
Medium
PaymentOption

Course Enrollment

The course enrollment object stores information about an individual’s enrollment for a course.

Child Objects

None

Methods Called

The following table details the methods called by the Course Enrollment service.

Table Methods Called by Course Enrollment Service

Method	Name as Defined in Service
Delete	CourseEnrollmentDelete
Execute	CourseEnrollmentExecute
Insert	CourseEnrollmentInsert
QueryPage	CourseEnrollmentQueryPage
Update	CourseEnrollmentUpdate

Fields

The following table details the required and read-only fields for the course enrollment object.

Table Required and Read-Only Fields for the Course Enrollment Object

Field Name	Type
CourseId	Required
CandidateId	Required
OwnerId	Required
Audit Fields	Read-only

The following table details the pick map fields for the course enrollment object.

Table Pick Map Fields for the Course Enrollment Object

Pick Map Field	Maps To
CourseName, CourseStatus, CourseType, CourseID, CourseExternalSystemId	CourseId
CandidateContactEmail, CandidateContactFirstName, CandidateContactLastName, CandidateContactFullName, CandidateIntegrationId, CandidateAccountName, CandidateExternalSystemId	CandidateId
ObjectiveName, ObjectiveExternalSystemId	ObjectiveId
OfferingPartnerChannelAccountManagerAlias, OfferingPartnerIntegrationId, OfferingPartnerExternalSystemId, OfferingPartnerLocation, OfferingPartnerMainPhone, OfferingPartnerPartnerName	OfferingPartnerId
OwnerFirstName, OwnerLastName, OwnerUserSignInId, OwnerAlias, OwnerFullName, OwnerIntegrationId, OwnerExternalSystemId, OwnerEMailAddr	OwnerId

The following table provides a list of the user key combinations for the course enrollment object.

Table User Key Fields on the Course Enrollment Object

User Key Field Combinations
CourseId
CandidateId
EnrollDate

The following table details the picklists available for the course enrollment object.

Table Picklists Available for the Course Enrollment Object

Field Name
Status

Deal Registration

The deal registration object stores information about the process by which a partner company requests exclusive rights to an opportunity from the brand owner.

Child Objects

Activity, Audit Trail,Book, Custom Object 01 -03, Custom Object 4 through 15, Special Pricing Product, Team.

Methods Called

The following table details the methods called by the Deal Registration service.

Table Methods Called by Deal Registration Service

Method	Name as Defined in Service
Delete	DealRegistrationDelete
Execute	DealRegistrationExecute
Insert	DealRegistrationInsert
QueryPage	DealRegistrationQueryPage
Update	DealRegistrationUpdate

Fields

The following table details the required and read-only fields for the deal registration object.

Table Required and Read-Only Fields for the Deal Registration Object

Field Name	Type
DealRegistrationName	Required
Type	Required
PartnerId	Required
SubmissionStatus	Required
DealRegistrationId	Read-only
ConvertedtoOpportunity	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the deal registration object.

Table Pick Map Fields for the Deal Registration Object

Pick Map Field	Maps To
PartnerExternalSystemId	PartnerId
PartnerName	PartnerId

The following table provides a list of the user key combinations for the deal registration object.

Table User Key Fields on the Deal Registration Object

User Key Field Combinations
ExternalSystemId
DealRegistrationName and PartnerId
Id

The following table details the picklists available for the deal registration object.

Table Picklists Available for the Deal Registration Object

Field Name
Type
Status
State
Country
Salutation
ApprovalStatus
RejectReason

Exam

The exam object stores information about a training examination. Exams measure the competency of an individual in a specific set of skills. They are usually the next logical step for an individual after completing a course. Typically, a course culminates in an exam (or exams) and an individual is expected to register and appear for the exams upon completing the course. In fact, many companies consider that a course has been successfully completed only if the exams are passed with at least the minimum passing score.

Child Objects

Attachment, Audit Trail,Book, Category, Certification, Course, Custom Object 01-03, Custom Object 4 through 15, Exam, Exam Registration, Partner, Product, Solution, Team.

Methods Called

The following table details the methods called by the Exam service.

Table Methods Called by Exam Service

Method	Name as Defined in Service
Delete	ExamDelete
Execute	ExamExecute
Insert	ExamInsert
QueryPage	ExamQueryPage
Update	ExamUpdate

Fields

The following table details the required and read-only fields for the exam object.

Table Required and Read-Only Fields for the Exam Object

Field Name	Type
Name	Required
Status	Required
OwnerId	Required
Audit Fields	Read-only

The following table details the pick map fields for the exam object.

Table Pick Map Fields for the Exam Object

Pick Map Field	Maps To
PrimaryProductProductCategory, PrimaryProductExternalSystemId, PrimaryProductDescription, PrimaryProductName, PrimaryProductPartNumber, PrimaryProductStatus, PrimaryProductIntegrationId, PrimaryProductType	PrimaryProductId
ProductCategoryName	ProductCategoryId
ContactEmail, ContactFirstName, ContactLastName, ContactFullName, ContactIntegrationId, ContactAccountName, ContactExternalSystemId	ContactId
ObjectiveName, ObjectiveExternalSystemId	ObjectiveId
OwnerFirstName, OwnerLastName, OwnerUserSignInId, OwnerAlias, OwnerFullName, OwnerIntegrationId, OwnerExternalSystemId, OwnerEMailAddr	OwnerId

The following table provides a list of the user key combinations for the exam object.

Table User Key Fields on the Exam Object

User Key Field Combinations
Id
Name

The following table details the picklists available for the exam object.

Table Picklists Available for the Exam Object

Field Name
Type
Status
Format
Medium
PaymentOption
Grade

Exam Registration

The exam registration object stores information about an individual’s registration for an examination.

Child Objects

None.

Methods Called

The following table details the methods called by the Exam Registration service.

Table Methods Called by Exam Registration Service

Method	Name as Defined in Service
Delete	ExamRegistrationDelete
Execute	ExamRegistrationExecute
Insert	ExamRegistrationInsert
QueryPage	ExamRegistrationQueryPage
Update	ExamRegistrationUpdate

Fields

The following table details the required and read-only fields for the exam registration object.

Table Required and Read-Only Fields for the Exam Registration Object

Field Name	Type
ExamId	Required
CandidateId	Required
ExamDate	Required
OwnerId	Required
Audit Fields	Read-only

The following table details the pick map fields for the exam registration object.

Table Pick Map Fields for the Exam Registration Object

Pick Map Field	Maps To
ExamName, ExamStatus, ExamType, ExamID, ExamExternalSystemId	ExamId
ContactEmail, ContactFirstName, ContactLastName, ContactFullName, ContactIntegrationId, ContactAccountName, ContactExternalSystemId	ContactId
ObjectiveName, ObjectiveExternalSystemId	ObjectiveId
PartnerChannelAccountManagerAlias, PartnerIntegrationId, PartnerExternalSystemId, PartnerLocation, PartnerMainPhone, PartnerName,	PartnerId
OwnerFirstName, OwnerLastName, OwnerUserSignInId, OwnerAlias, OwnerFullName, OwnerIntegrationId, OwnerExternalSystemId, OwnerEMailAddr.	OwnerId

The following table provides a list of the user key combinations for the exam registration object.

Table User Key Fields on the Exam Registration Object

User Key Field Combinations
Id
CourseId, CandidateId, OwnerId, and ExamDate

The following table details the picklists available for the exam registration object.

Table Picklists Available for the Exam Registration Object

Field Name
Status

Fund

The fund object stores information about a sum of money or a set of other resources that are set aside for a specific purpose.

Child Objects

Activity, Audit Trail, Custom Object 01-03, Custom Object 4 through 15, Fund Credit, Fund Debit, MDF Request, Event, Objective, Special Pricing Product.

Methods Called

The following table details the methods called by the Fund service.

Table Methods Called by Fund Service

Method	Name as Defined in Service
Delete	FundDelete
Execute	FundExecute
Insert	FundInsert
QueryPage	FundQueryPage
Update	FundUpdate

Fields

The following table details the required and read-only fields for the fund object.

Table Required and Read-Only Fields for the Fund Object

Field Name	Type
FundName	Required
FundId	Required
TargetAmount	Required
Audit Fields	Read-only

The following table details the pick map field for the fund object.

Table Pick Map Field for the Fund Object

Pick Map Field	Maps To
Partner	PartnerId

The following table provides a list of the user key combinations for the fund object.

Table User Key Fields on the Fund Object

User Key Field Combinations
FundId
Id

The following table details the picklists available for the fund object.

Table Picklists Available for the Fund Object

Field Name
FundCode
Status
Type
CurrencyCode
Partner
Period

MDF Request

The MDF request object stores information about market development funds (MDF) requests.

Child Objects

Activity, Audit Trail, Book, Custom Object 01-03, Custom Object 4 through 15, Team.

Methods Called

The following table details the methods called by the MDF Request service.

Table Methods Called by MDF Request Service

Method	Name as Defined in Service
Delete	MDFRequestDelete
Execute	MDFRequestExecute
Insert	MDFRequestInsert
QueryPage	MDFRequestQueryPage
Update	MDFRequestUpdate

Fields

The following table details the required and read-only fields for the MDF request object.

Table Required and Read-Only Fields on the MDF Request Object

Field Name	Type
RequestName	Required
PrincipalPartnerAccountId	Required
FundName	Required
DueDate	Required
SubmissionStatus	Required
MDFRequestId	Read-only
Audit Fields	Read-only

The following table details the pickmap fields for the MDF request object.

Table Pick Map Fields for the MDF Request Object

Pick Map Field	Maps To
PrincipalPartnerAccountExternalSystemId	PrincipalPartnerAccountId
PrincipalPartnerAccountIntegrationId	PrincipalPartnerAccountId
PrincipalPartnerAccountPartnerName, PrincipalPartnerAccountLocation	PrincipalPartnerAccountId
PrincipalPartnerAccountChannelAccountManagerAlias	PrincipalPartnerAccountId

The following table provides a list of the user key combinations for the MDF request object.

Table User Key Fields on the MDF Request Object

User Key Field Combinations
RequestName
Id
ExternalSystemId

The following table details the picklists available for the MDF request object.

Table Picklists Available for the MDF Request Object

Field Name
Status
Type
SubmissionStatus
ApprovalStatus
MarketingPurpose
Region
Category
ReasonCode
ClaimStatus

Partner

The partner object allows you to define and record details about partner accounts.

Child Objects

Application, Audit Trail,Book, Business Plan, Custom Object 4 through 15, Deal Registration, MDF Request, Opportunity, Partner, Policy, Shared Address, Special Pricing Product, Team.

Methods Called

The following table details the methods called by the Partner service.

Table Methods Called by Partner Service

Method	Name as Defined in Service
Insert	PartnerInsert
QueryPage	PartnerQueryPage
Update	PartnerUpdate

Fields

The following table details the read-only fields for the partner object.

Table Read-Only Fields on the Partner Object

Field Name	Type
PartnerName	Required
CurrencyCode	Read-only
Audit Fields	Read-only

The following table details the pickmap fields for the partner object.

Table Pick Map Fields for the Partner Object

Pick Map Field	Maps To
Owner	OwnerId
ParentAccountName, ParentAccountLocation	ParentAccountId
ChannelAccountManager	ChannelAccountManagerId
SourceCampaignName	SourceCampaignId
OwnerPartnerAccountPartnerName	OwnerPartnerId
PrincipalPartnerPartnerName	PrincipalPartnerId
OriginatingPartnerAccountPartnerName	OriginatingPartnerId
Territory	TerritoryId

The following table provides a list of the user key combinations for the partner object.

Table User Key Fields on the Partner Object

User Key Field Combinations
Id
ExternalSystemId
Location
PartnerName

The following table details the picklists available for the partner object.

Table Picklists Available for the Partner Object

Field Name
CallFrequency
ComplianceStatus
Expertise
InfluenceType
MarketPotential
MarketSegment
PartnerOrgStatus
PartnerLevel
Priority
Region
Route
Status

Price List

The price list object store information about a price list for products.

Child Objects

Account, Partner, Price List Line Item, Special Pricing Product.

Methods Called

The following table details the methods called by the Price List service.

Table Methods Called by Price List Service

Method	Name as Defined in Service
Delete	PriceListDelete
Execute	PriceListExecute
Insert	PriceListInsert
QueryPage	PriceListQueryPage
Update	PriceListUpdate

Fields

The following table details the required and read-only fields for the price list object.

Table Required and Read-Only Fields for the Price List Object

Field Name	Type
PriceListName	Required
EffectiveFrom	Required
Type	Required
Status	Required
CurrencyCode	Required
Audit Fields	Read-only

There are no pick map fields for the price list object.

The following table details the user keys for the price list object.

Table User Keys for the Price List Object

Field Name
PriceListName and Type
Id
ExternalSystemId

The following table details the picklists available for the price list object.

Table Picklists Available for the Price List Object

Field Name
Type
Status

Price List Line Item

The price list line item object store information about a product in a price list.

Child Objects

None

Methods Called

The following table details the methods called by the Price List Line Item service.

Table Methods Called by Price List Line Item Service

Method	Name as Defined in Service
Delete	PriceListLineItemDelete
Execute	PriceListLineItemExecute
Insert	PriceListLineItemInsert
QueryPage	PriceListLineItemQueryPage
Update	PriceListLineItemUpdate

Fields

The following table details the required and read-only fields for the price list line item object.

Table Required and Read-Only Fields for the Price List Line Item Object

Field Name	Type
PriceListId	Required
ProductId	Required
Type	Required
Audit Fields	Read-only

The following table details the pick map field for the price list line item object.

Table Pick Map Field for the Price List Line Item Object

Pick Map Field	Maps To
ProductExternalSystemId	ProductId
ProductIntegrationId	ProductId
ProductName, ProductCategory	ProductId
PriceListPriceListName	PriceListId
PriceListIntegrationId	PriceListId
PriceListExternalSystemId	PriceListId

The following table details the user keys for the price list line item object.

Table User Keys for the Price List Line Item Object

Field Name
Id
ExternalSystemId
ProductId and PriceListId and PriceType

The following table details the picklists available for the price list line item object.

Table Picklists Available for the Price List Line Item Object

Field Name
PriceType

Special Pricing Product

The special pricing product object stores information about a product associated with a special pricing request.

Child Objects

None.

Methods Called

The following table details the methods called by the Special Pricing Product service.

Table Methods Called by Special Pricing Product Service

Method	Name as Defined in Service
Delete	SPRequestLineItemDelete
Execute	SPRequestLineItemExecute
Insert	SPRequestLineItemInsert
QueryPage	SPRequestLineItemQueryPage
Update	SPRequestLineItemUpdate

Fields

The following table details the required and read-only fields for the special pricing product object.

Table Required and Read-Only Fields on the Special Pricing Product Object

Field Name	Type
ProductId	Required
SPRequestId	Read-only
Audit Fields	Read-only

The following table details the pickmap fields for the special pricing product object.

Table Pick Map Fields for the Special Pricing Product Object

Pick Map Field	Maps To
ProductExternalSystemId	ProductId
ProductIntegrationId	ProductId
ProductName, ProductCategory	ProductId

The following table provides a list of the user key combinations for the special pricing product object.

Table User Key Fields on the Special Pricing Product Object

User Key Field Combinations
Id
ExternalSystemId
ItemNumber

Special Pricing Request

The Special Pricing (SP) request object stores information about a special pricing request, which is a set of business processes where a partner asks the brand owner for a discount on a product.

Child Objects

Activity, Audit Trail,Book, Custom Object 01 - 03, Custom Object 4 through 15, Special Pricing Product, Team.

Methods Called

The following table details the methods called by the SP Request service.

Table Methods Called by SP Request Service

Method	Name as Defined in Service
Delete	SPRequestDelete
Execute	SPRequestExecute
Insert	SPRequestInsert
QueryPage	SPRequestQueryPage
Update	SPRequestUpdate

Fields

The following table details the required and read-only fields for the SP request object.

Table Read-Only Fields on the SP Request Object

Field Name	Type
SPRequestName	Required
PrincipalPartnerAccountId	Required
SubmissionStatus	Required
SPRequestId	Read-only
Audit Fields	Read-only

The following table details the pickmap fields for the SP request object.

Table Pick Map Fields for the SP Request Object

Pick Map Field	Maps To
PrincipalPartnerAccountExternalSystemId	PrincipalPartnerAccountId
PrincipalPartnerAccountIntegrationId	PrincipalPartnerAccountId
PrincipalPartnerAccountPartnerName, PrincipalPartnerAccountLocation	PrincipalPartnerAccountId
PrincipalPartnerAccountChannelAccountManagerAlias	PrincipalPartnerAccountId

The following table provides a list of the user key combinations for the SP request object.

Table User Key Fields on the SP Request Object

User Key Field Combinations
Id
ExternalSystemId
SPRequestName
FundId and RequestDate

The following table details the picklists available for the SP request object.

Table Picklists Available for the SP Request Object

Field Name
SubmissionStatus
ApprovalStatus
RejectReason
Type
ClaimStatus

Life Sciences Edition Parent Objects (Web Services v2.0)

This topic includes the parent objects available with Oracle CRM On Demand Life Sciences Edition. For these parent objects, all child objects are also accessible.

Note: To download WSDL files for these objects, you must be given access to the object. If you do not have access to the object, it is not available to download from the Web Services Administration page or available to use the Web service calls. For assistance in gaining access to the objects, contact your Oracle CRM On Demand service provider.

The following objects are detailed in this topic:

Note: While the Business Plan, Objective, Plan Account, Plan Contact, and Plan Opportunity functionality was developed in the context of Oracle CRM On Demand Life Sciences Edition, all Oracle CRM On Demand customers can access and leverage this functionality. Your administrator or customer advocate can enable the Business Plan, Objective, Plan Account, Plan Contact, and Plan Opportunity objects and make these pages available for your use.

Allocation

The allocation object determines the period of time in which sample products are provided for a sales representative to distribute to clinics, hospitals, or physician contacts during a sample drop call execution.

Child Objects

Audit Trail, Book

Methods Called

The following table details the methods called by the Allocation service.

Table Methods Called by Allocation Service

Method	Name as Defined in Service
Delete	AllocationDelete
Execute	AllocationExecute
Insert	AllocationInsert
QueryPage	AllocationQueryPage
Update	AllocationUpdate

Fields

The following table details the required and read-only fields for the allocation object.

Table Required and Read-Only Fields for the Allocation Object

Field Name	Type
AllocationType	Required
OwnerAlias	Required
ProductName	Required
StartDate	Required
ActivePeriod	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the allocation object.

Table Pick Map Fields for the Allocation Object

Pick Map Field	Maps To
ProductName	ProductId
ProductExternalSystemId	ProductId
ProductIntegrationId	ProductId
OwnerUserSignId	OwnerId
OwnerExternalSystemId	OwnerId
OwnerIntegrationId	OwnerId

The following table provides a list of the user key combinations for the allocation object.

Table User Key Fields on the Allocation Object

User Key Field Combinations
Id
ExternalSystemId
OwnerId and ProductId and StartDate and EndDate and AllocationType

The following table details the picklists available for the allocation object.

Table Picklists Available for the Allocation Object

Field Name
AllocationType

Blocked Product

The blocked product object specifies a product that is blocked for a particular contact. If a product is blocked for a contact, the contact is prevented from receiving any information, samples, or promotional items for the product.

Child Objects

Methods Called

The following table details the methods called by the Blocked Product service.

Table Methods Called by Blocked Product Service

Method	Name as Defined in Service
Delete	BlockedProductDelete
Execute	BlockedProductExecute
Insert	BlockedProductInsert
QueryPage	BlockedProductQueryPage
Update	BlockedProductUpdate

Fields

The following table details the required and read-only fields for the blocked product object.

Table Required and Read-Only Fields for the Blocked Product Object

Field Name	Type
ProductId	Required
ContactId	Required
Audit Fields	Read-only

The following table details the pick map fields for the blocked product object.

Table Pick Map Fields for the Blocked Product Object

Pick Map Field	Maps To
Contact	ContactId
ContactExternalSystemId	ContactId
ContactIntegrationId	ContactId
Owner	OwnerId
OwnerExternalSystemId	OwnerId
OwnerIntegrationId	OwnerId
ProductName	ProductId
ProductExternalSystemId	ProductId
ProductIntegrationId	ProductId

The following table provides a list of the user key combinations for the blocked product object.

Table User Key Fields on the Blocked Product Object

User Key Field Combinations
Id
ExternalSystemId
ProductId and ContactId

Business Plan

The business plan object allows sales organizations to explicitly establish strategic goals (for example, revenue targets) and action plans to achieve those goals, in the form of objectives, activities, and opportunities.

Child Objects

Activity, Audit Trail,Book, Business Plan, Event, Messaging Plan, Objective, Plan Account, Plan Contact, Plan Opportunity, Sales Assessment, Sales Assessment Value, Team.

Methods Called

The following table details the methods called by the Business Plan service.

Table Methods Called by Business Plan Service

Method	Name as Defined in Service
Delete	BusinessPlanDelete
Execute	BusinessPlanExecute
Insert	BusinessPlanInsert
QueryPage	BusinessPlanQueryPage
Update	BusinessPlanUpdate

Fields

The following table details the required and read-only fields for the business plan object.

Table Required and Read-Only Fields for the Business plan Object

Field Name	Type
PlanName	Required
PeriodName	Required
Type	Required
Status	Required
Audit Fields	Read-only

The following table details the pick map fields for the business plan object.

Table Pick Map Fields for the Business plan Object

Pick Map Field	Maps To
ParentPlanNamePlanName	ParentPlanId
ParentPlanNameExternalSystemId	ParentPlanId
ParentPlanNameIntegrationId	ParentPlanId
ProductName	ProductId
ProductExternalSystemId	ProductId
ProductIntegrationId	ProductId
PeriodName	PeriodId
PeriodExternalSystemId	PeriodId
PeriodIntegrationId	PeriodId
OwnerUserSignId	OwnerId
OwnerExternalSystemId	OwnerId
OwnerIntegrationId	OwnerId

The following table provides a list of the user key combinations for the business plan object.

Table User Key Fields on the Business plan Object

User Key Field Combinations
Id
ExternalSystemId
PeriodId and PlanName

The following table details the picklists available for the business plan object.

Table Picklists Available for the Business plan Object

Field Name
Type
Status

Call Activity History

The call activity history object stores data that enables sales managers and sales representatives to analyze call activity.

Usage

The call activity history is generated only if the Generate Call Activity History setting is selected in the Oracle CRM On Demand UI. This setting is available with the Oracle CRM On Demand Life Sciences Edition only.

The fields returned by the CallActivityHistoryQueryPage method includes a set of fields used to describe and track an activity record itself.

Child Objects

None.

Methods Called

The following table details the methods called by the Call Activity History service.

Table Methods Called by Call Activity History Service

Method	Name as Defined in Service
QueryPage	CallActivityHistoryQueryPage

Fields

No pickmaps are available for the call activity history object

The following table provides a list of the user key combinations for the call activity history object.

Table User Key Fields on the Call Activity History Object

User Key Field Combinations
ActivityId
Type
ProductId
LotName

No picklists are available for the call activity history object.

Call Product Detail

The call product detail object stores product detail information associated with sales calls.

Child Objects

None.

Methods Called

The following table details the methods called by the Call Product Detail service.

Table Methods Called by Call Product Detail Service

Method	Name as Defined in Service
Delete	ProductsDetailedDelete
Execute	ProductsDetailedExecute
Insert	ProductsDetailedInsert
QueryPage	ProductsDetailedQueryPage
Update	ProductsDetailedUpdate

Fields

The following table details the required and read-only fields for the call product detail object.

Table Required and Read-Only Fields for the Call Product Detail Object

Field Name	Type
Product	Required
Audit Fields	Read-only

The following table details the pick map fields for the call product detail object.

Table Pick Map Fields for the Call Product Detail Object

Pick Map Field	Maps To
ExternalSystemId	ProductId
IntegrationId	ProductId

The following table provides a list of the user key combinations for the call product detail object.

Table User Key Fields on the Call Product Detail Object

User Key Field Combinations
ProductId
IntegrationId
ExternalSystemId

The following table details the picklists available for the call product detail object.

Table Picklists Available for the Call Product Detail Object

Field Name
Indication
Issues
Type

Contact Best Times

The contact best times object records and tracks the best time and day of week to call on a contact (by typically, a physician or another health care provider).

Note: It is recommended to access the contact best times object as a child of the contact object. Using the Contact Web service is preferred as best call time is within the context of a contact.

Child Objects

None.

Methods Called

The following table details the methods called by the Contact Best Time service.

Table Methods Called by Contact Best Time Service

Method	Name as Defined in Service
Delete	ContactBestTimesDelete
Execute	ContactBestTimesExecute
Insert	ContactBestTimesInsert
QueryPage	ContactBestTimesQueryPage
Update	ContactBestTimesUpdate

Fields

The following table details the required and read-only fields for the contact best times object.

Table Required and Read-Only Fields for the Contact Best Times Object

Field Name	Type
StartDay	Required
StartTime	Required
EndTime	Required
FullAddress	Required
ContactFullName	Required
Audit Fields	Read-only

The following table details the pick map fields for the contact best times object.

Table Pick Map Fields for the Contact Best Times Object

Pick Map Field	Maps To
AddressExternalSystemId	AddressId
AddressIntegrationId	AddressId
ContactFullName	ContactId
ContactExternalSystemId	ContactId
ContactIntegrationId	ContactId

The following table provides a list of the user key combinations for the contact best times object.

Table User Key Fields on the Contact Best Times Object

User Key Field Combinations
ContactId
AddressId
ExternalSystemId

The following table details the picklists available for the contact best times object.

Table Picklists Available for the Contact Best Times Object

Field Name
StartDay

Contact State License

The contact state license object stores the medical license information for a contact, typically a physician.

Child Objects

Custom Object 1 through 3, Custom Object 4 through 15

Methods Called

The following table details the methods called by the contact state license service.

Table Methods Called by Contact State License Service

Method	Name as Defined in Service
Delete	ContactLicenseDelete
Execute	ContactLicenseExecute
Insert	ContactLicenseInsert
QueryPage	ContactLicenseQueryPage
Update	ContactLicenseUpdate

Fields

The following table details the required and read-only fields for the contact state license object.

Table Required and Read-Only Fields for the Contact State License Object

Field Name	Type
ContactFullName	Required
LicenseNumber	Required
Audit Fields	Read-only

The following table details the pick map fields for the contact state license object.

Table Pick Map Fields for the Contact State License Object

Pick Map Field	Maps To
ContactFullName	ContactId
ContactExternalSystemId	ContactId
ContactIntegrationId	ContactId
OwnerUserSignId	OwnerId
OwnerExternalSystemId	OwnerId
OwnerIntegrationId	OwnerId

The following table provides a list of the user key combinations for the contact state license object.

Table User Key Fields on the Contact State License Object

User Key Field Combinations
Id
ExternalSystemId
ContactId and State
LicenseNumber

The following table details the picklists available for the contact state license object.

Table Picklists Available for the Contact State License Object

Field Name
State
Status

Event

The Event object allows you to plan and track events such as a medical educational seminar, a symposium, or a customer appreciation event. An event can be as simple as a lunch-and-learn session in a physician's office or as complex as a seminar series or national sales meeting.

Note: The Event Web service was labelled as the MedEvent Web service before Oracle CRM On Demand Release 25.

Child Objects

Account, Attachment, Audit Trail, Book, Business Plan, Campaign, Contact, Custom Object 4 through 15, Fund, Invitee, Lead, Objective, Opportunity, Team

Methods Called

The following table details the methods called by the Event service.

Table Methods Called by Event Service

Method	Name as Defined in Service
Delete	MedEdDelete
Execute	MedEdExecute
Insert	MedEdInsert
QueryPage	MedEdQueryPage
Update	MedEdUpdate

Fields

The following table details the required and read-only fields for the Event object.

Table Required and Read-Only Fields on the Event Object

Field Name	Type
EndDate	Required
Name	Required
Objective	Required
StartDate	Required
OwnerFullName	Read-only
Audit Fields	Read-only

The following table details the pickmap fields for the Event object.

Table Pick Map Fields for the Event Object

Pick Map Field	Maps To
ProductExternalSystemId	ProductId
ProductIntegrationId	ProductId

The following table provides a list of the user key combinations for the Event object.

Table User Key Fields on the Event Object

User Key Field Combinations
Id
ExternalSystemId
Name

The following table details the picklists available for the Event object.

Table Picklists Available for the Event Object

Field Name
Status
Type

HCP Contact Allocation

The HCP contact allocation object stores information about the total amount of a product or sample that a health care professional (HCP) contact, (for example, a physician) can receive from sales representatives.

Child Objects

Audit Trail, Book

Methods Called

The following table details the methods called by the HCP contact allocation service.

Table Methods Called by HCP Contact Allocation Service

Method	Name as Defined in Service
Delete	HCPContactAllocationDelete
Execute	HCPContactAllocationExecute
Insert	HCPContactAllocationInsert
QueryPage	HCPContactAllocationQueryPage
Update	HCPContactAllocationUpdate

Fields

The following table details the required and read-only fields for the HCP contact allocation object.

Table Required and Read-Only Fields for the HCP Contact Allocation Object

Field Name	Type
Type	Required
StartDate	Required
ContactId	Required
ProductName	Either one of these fields is required
ProductId	Either one of these fields is required
Audit Fields	Read-only

The following table details the pick map fields for the HCP contact allocation object.

Table Pick Map Fields for the HCP Contact Allocation License Object

Pick Map Field	Maps To
ContactExternalSystemId	ContactId
ContactIntegrationId	ContactId
ProductName	ProductId
ProductExternalSystemId	ProductId
ProductIntegrationId	ProductId
OwnerUserSignInId	OwnerId
OwnerExternalSystemId	OwnerId
OwnerIntegrationId	OwnerId

The following table provides a list of the user key combinations for the HCP contact allocation object.

Table User Key Fields on the HCP Contact Allocation Object

User Key Field Combinations
Id
ExternalSystemId

The following table details the picklists available for the HCP contact allocation object.

Table Picklists Available for the HCP Contact Allocation Object

Field Name
Type

Inventory Audit Report

The inventory audit report object stores information about the reports generated by Oracle CRM On Demand when a sales representative chooses to create a new interim or final audit count for an inventory period.

Support for Attachments

You can exchange attachments through the following fields:

UI Display Name	Integration Tag Name
Attachment	AttachFileFullName
Attachment: Extension	AttachFileExt
Attachment: File Name	AttachFileName
Attachment: Size (in Bytes)	AttachFileSizeDisp

The Attachment tag is used for the actual attachment and is a string type Base64.

Child Objects

Audit Trail, Book, Sample Inventory

Methods Called

The following table details the methods called by the Inventory Audit Report service.

Table Methods Called by Inventory Audit Report Service

Method	Name as Defined in Service
Delete	InventoryAuditReportDelete
Execute	InventoryAuditReportExecute
Insert	InventoryAuditReportInsert
QueryPage	InventoryPeriodQueryPage
Update	InventoryPeriodUpdate

Fields

The following table details the required and read-only fields for the inventory audit report object.

Table Required and Read-Only Fields for the Inventory Audit Report Object

Field Name	Type
Type	Required
Status	Required
Reason	Required
CountCompletedOn	Required
InventoryPeriodStartDate	Required
OwnerUserSignId	Required
Audit Fields	Read-only

The following table details the pick map fields for the inventory audit report object.

Table Pick Map Field for the Inventory Audit Report Object

Pick Map Field	Maps To
InventoryPeriodExternalSystemId	InventoryPeriodId
InventoryPeriodIdIntegrationId	InventoryPeriodId
OwnerUserSignId	OwnerId
OwnerExternalSystemId	OwnerId
OwnerIntegrationId	OwnerId

The following table provides a list of the user key combinations for the inventory audit report object.

Table User Key Fields on the Inventory Audit Report Object

User Key Field Combinations
Id
ExternalSystemId
InventoryPeriodId and OwnerId and CountCompletedOn
Type

The following table details the picklists available for the inventory audit report object.

Table Picklists Available for the Inventory Audit Report Object

Field Name
Type
Status
Reason

Inventory Period

The inventory period object represents a time frame within which all movement of samples or promotional items (sample drops, receipts, disbursements, and inventory adjustments) can be tracked.

Child Objects

Audit Trail,Book, Inventory Audit Report, Sample Inventory, Sample Transaction, Sample Transaction.

Methods Called

The following table details the methods called by the Inventory Period service.

Table Methods Called by Inventory Period Service

Method	Name as Defined in Service
Delete	InventoryPeriodDelete
Execute	InventoryPeriodExecute
Insert	InventoryPeriodInsert
QueryPage	InventoryPeriodQueryPage
Update	InventoryPeriodUpdate

Fields

The following table details the required and read-only fields for the inventory period object.

Table Required and Read-Only Fields for the Inventory Period Object

Field Name	Type
StartDate	Required
OwnerId	Required
ActiveFlg	Required
ReconciledFlg	Required
Audit Fields	Read-only

The following table details the pick map fields for the inventory period object.

Table Pick Map Field for the Inventory Period Object

Pick Map Field	Maps To
OwnerUserSignId	OwnerId
OwnerExternalSystemId	OwnerId
OwnerIntegrationId	OwnerId

The following table provides a list of the user key combinations for the inventory period object.

Table User Key Fields on the Inventory Period Object

User Key Field Combinations
Id
ExternalSystemId
OwnerId and StartDate

Message Response

The message response object stores feedback received from the audience during the presentation of a message plan during a particular period.

Child Objects

Methods Called

The following table details the methods called by the Message Response service.

Table Methods Called by Message Response Service

Method	Name as Defined in Service
Delete	MessageResponseDelete
Execute	MessageResponseExecute
Insert	MessageResponseInsert
QueryPage	MessageResponseQueryPage
Update	MessageResponseUpdate

Fields

The following table details the required and read-only fields for the message response object.

Table Required and Read-Only Fields on the Message Response Object

Field Name	Type
Message	Required
SequenceNumber	Required
Duration	Read-only
Audit Fields	Read-only

The following table details the pickmap fields for the message response object.

Table Pick Map Fields for the Message Response Object

Pick Map Field	Maps To
ContactFullName	ContactId
ContactExternalSystemId	ContactId
ContactIntegrationId	ContactId
AccountName	AccountId
AccountExternalSystemId	AccountId
AccountIntegrationId	AccountId
SolutionTitle	SolutionId
SolutionExternalSystemId	SolutionId
SolutionIntegrationId	SolutionId
PlanName	PlanId
PlanExternalSystemId	PlanId
PlanIntegrationId	Planid
PlanItemName	PlanItemId
PlanItemExternalSystemId	PlanItemId
PlanItemIntegrationId	PlanItemId
OwnerUserSignId	OwnerId
OwnerExternalSystemId	OwnerId
OwnerIntegrationId	OwnerId

The following table provides a list of the user key combinations for the message response object.

Table User Key Fields on the Message Response Object

User Key Field Combinations
Id
ExternalSystemId
PlanName and SolutionName

Message Response details the picklists available for the message response object.

Table Picklists Available for the Message Response Object

Field Name
Response

Messaging Plan

The messaging plan object stores information about a presentation delivered using a personal computer or tablet computer for sales users to detail products and track customer feedback.

Child Objects

Audit Trail, Book, Business Plan, Custom Object 1 through 3, Custom Object 4 through 15, Message Response, Messaging Plan Item.

Methods Called

The following table details the methods called by the Messaging Plan service.

Table Methods Called by Messaging Plan Service

Method	Name as Defined in Service
Delete	MessagePlanDelete
Execute	MessagePlanExecute
Insert	MessagePlanInsert
QueryPage	MessagePlanQueryPage
Update	MessagePlanUpdate

Fields

The following table details the required and read-only fields for the messaging plan object.

Table Required and Read-Only Fields on the Messaging Plan Object

Field Name	Type
Name	Required
OwnerId	Required
Type	Required
ProductName	Required
Status	Required
LockSequence	Required
DisclosureMandatory	Required
EnableFollowUp	Required
VerificationStatus	Read-only
Audit Fields	Read-only

The following table details the pickmap fields for the messaging plan object.

Table Pick Map Fields for the Messaging Plan Object

Pick Map Field	Maps To
SolutionTitle	SolutionId
SolutionExternalSystemId	SolutionId
SolutionIntegrationId	SolutionId
EffectivePeriodName	EffectivePeriodId
EffectivePeriodExternalSystemId	EffectivePeriodId
EffectivePeriodIntegrationId	EffectivePeriodId
ProductName	ProductId
ProductExternalSystemId	ProductId
ProductIntegrationId	ProductId
OwnerUserSignId	OwnerId
OwnerExternalSystemId	OwnerId
OwnerIntegrationId	OwnerId

The following table provides a list of the user key combinations for the messaging plan object.

Table User Key Fields on the Messaging Plan Object

User Key Field Combinations
Id
ExternalSystemId
Name and OwnerId

The following table details the picklists available for the messaging plan object.

Table Picklists Available for the Messaging Plan Object

Field Name
Type
Status
Skin

Messaging Plan Item

The messaging plan item object stores information about the items that make up a message plan.

Child Objects

Audit Trail, Custom Object 1 through 3, Custom Object 4 through 15, Messaging Plan Item Relation, Message Response.

Methods Called

The following table details the methods called by the Messaging Plan Item service.

Table Methods Called by Messaging Plan Item Service

Method	Name as Defined in Service
Delete	MsgPlanItemDelete
Execute	MsgPlanItemExecute
Insert	MsgPlanItemInsert
QueryPage	MsgPlanItemQueryPage
Update	MsgPlanItemUpdate

Fields

The following table details the required and read-only fields for the messaging plan item object.

Table Required and Read-Only Fields on the Messaging Plan Item Object

Field Name	Type
SequenceNumber	Required
DisclosureMessage	Required
Type	Required
ParentMessagePlanName	Required
Audit Fields	Read-only

The following table details the pickmap fields for the messaging plan item object.

Table Pick Map Fields for the Messaging Plan Item Object

Pick Map Field	Maps To
ParentMessagePlanName	ParentMessagePlanId
ParentMessagePlanExternalSystemId	ParentMessagePlanId
ParentMessagePlanIntegrationId	ParentMessagePlanId
SolutionNameTitle	SolutionId
SolutionExternalSystemId	SolutionId
SolutionIntegrationId	SolutionId
OwnerUserSignId	OwnerId
OwnerExternalSystemId	OwnerId
OwnerIntegrationId	OwnerId

The following table provides a list of the user key combinations for the messaging plan item object.

Table User Key Fields on the Messaging Plan Item Object

User Key Field Combinations
Id
ExternalSystemId
ParentMessagePlanId and SolutionNameId and SequenceNumber and Type

The following table details the picklists available for the messaging plan item object.

Table Picklists Available for the Messaging Plan Item Object

Field Name
Type
Status
Rating
SendType

Messaging Plan Item Relation

The messaging plan item relation object stores information about a presentation item that provides optional information to support the primary message plan item.

Child Objects

Audit Trail, Custom Object 1 through 3, Custom Object 4 through 15

Methods Called

The following table details the methods called by the Messaging Plan Item Relation service.

Table Methods Called by Messaging Plan Item Service

Method	Name as Defined in Service
Delete	MsgPlanItemRelationDelete
Execute	MsgPlanItemRelationExecute
Insert	MsgPlanItemRelationInsert
QueryPage	MsgPlanItemRelationQueryPage
Update	MsgPlanItemRelationUpdate

Fields

The following table details the required and read-only fields for the messaging plan item relation object.

Table Required and Read-Only Fields on the Messaging Plan Item Relation Object

Field Name	Type
Type	Required
ParentMPItemName	Required
Audit Fields	Read-only

The following table details the pickmap fields for the messaging plan item relation object.

Table Pick Map Fields for the Messaging Plan Item Relation Object

Pick Map Field	Maps To
ParentMPItemName	ParentMPItemId
ParentMPItemExternalSystemId	ParentMPItemId
ParentMPItemIntegrationId	ParentMPItemid
SolutionNameTitle	SolutionId
SolutionExternalSystemId	SolutionId
SolutionIntegrationId	SolutionId
OwnerUserSignId	OwnerId
OwnerExternalSystemId	OwnerId
OwnerIntegrationId	OwnerId

The following table provides a list of the user key combinations for the messaging plan item relation object.

Table User Key Fields on the Messaging Plan Item Relation Object

User Key Field Combinations
Id
ExternalSystemId
ParentMPId and SolutionNameId and Type

The following table details the picklists available for the messaging plan item relation object.

Table Picklists Available for the Messaging Plan Item Relation Object

Field Name
Type
Status
Rating

Objective

The objective object stores information about a tactical goal you want to achieve to attain a higher level strategic goal in a business plan.

Child Objects

Activity, Audit Trail,Book, Objective, Opportunity, Sales Assessment, Sales Assessment Value, Team.

Methods Called

The following table details the methods called by the objective service.

Table Methods Called by Objective Service

Method	Name as Defined in Service
Delete	ObjectiveDelete
Execute	ObjectiveExecute
Insert	ObjectiveInsert
QueryPage	ObjectiveQueryPage
Update	ObjectiveUpdate

Fields

The following table details the required and read-only fields for the objective object.

Table Required and Read-Only Fields for the Objective Object

Field Name	Type
ObjectiveName	Required
Type	Required
Status	Required
PeriodName	Required
Audit Fields	Read-only

The following table details the pick map fields for the objective object.

Table Pick Map Fields for the Objective Object

Pick Map Field	Maps To
ParentObjectiveObjectiveName	ParentObjectiveId
ParentObjectiveExternalSystemId	ParentObjectiveId
ParentObjectiveIntegrationId	ParentObjectiveId
PlanNamePlanName	PlanNameId
PlanNameExternalSystemId	PlanNameId
PlanNameIntegrationId	PlanNameId
AccountNameAccountName	AccountId
AccountExternalSystemId	AccountId
AccountIntegrationId	AccountId
ContactNameContactFullName	ContactId
ContactExternalSystemId	ContactId
ContactIntegrationId	ContactId
ProductNameName	ProductId
ProductdExternalSystemId	ProductId
ProductIntegrationId	ProductId
PeriodName	PeriodId
PeriodExternalSystemId	PeriodId
PeriodIntegrationId	PeriodId
OwnerUserSignId	OwnerId
OwnerExternalSystemId	OwnerId
OwnerIntegrationId	OwnerId

The following table provides a list of the user key combinations for the objective object.

Table User Key Fields on the Objective Object

User Key Field Combinations
Id
ExternalSystemId
AccountNameId and ContactNameId and ProductNameId and PeriodId
ObjectiveName

The following table details the picklists available for the objective object.

Table Picklists Available for the Objective Object

Field Name
Status
Type
ObjectiveUnits

Order

The order object is used to track orders and associated order items for products. For example, sales representatives can create a direct request for sample fulfillment as well as submit an order to the main office for samples to be sent directly to customers.

Usage

For access to the order object and Order service, the Order Usage value on the company profile page must be set to CRM On Demand Order Management, and your user role must include the Enable Order Access privilege.

For Insert requests, if the Type field is not specified as empty or as a picklist value, then it defaults to the value Order.

Child Objects

Audit Trail, Book, Order Item, Team

Methods Called

The following table details the methods called by the Order service.

Table Methods Called by Order Service

Method	Name as Defined in Service
Delete	OrderDelete
Execute	OrderExecute
Insert	OrderInsert
QueryPage	OrderQueryPage
Update	OrderUpdate

Fields

The following table details the required and read-only fields for the order object.

Table Required and Read-Only Fields for the Order Object

Field Name	Type
OrderNumber	Read-only
BusinessAccountAccountName	Read-only
FinalAccountAccountName	Read-only
OpportunityName	Read-only
OrderIntegrationMessage	Read-only
OrderCreationStatus	Read-only
OrderCreationDate	Read-only
OwnerId	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the order object.

Table Pick Map Fields for the Order Object

Pick Map Field	Maps To
ContactFullName	ContactId

The following table provides a list of the user key combinations for the order object.

Table User Key Fields on the Order Object

User Key Field Combinations
Id
OrderNumber

The following table details the picklists for the order object.

Table Picklist Fields on the Order Object

Field Name
Type

Order Item

The order item object tracks which products have been purchased by the customer as part of an order.

Usage

For access to the order item object and Order Item service, the Order Usage value on the company profile page must be set to CRM On Demand Order Management, and your user role must include the Enable Order Access privilege.

Methods Called

The following table details the methods called by the Order Item service.

Table Methods Called by Order Item Service

Method	Name as Defined in Service
Delete	OrderItemDelete
Execute	OrderItemExecute
Insert	OrderItemInsert
QueryPage	OrderItemQueryPage
Update	OrderItemUpdate

Fields

The following table details the required and read-only fields for the order item object.

Table Required and Read-Only Fields for the Order Item Object

Field Name	Type
OrderItemNum	Required
Quantity	Required
ProductName	Required
OrderNumber	Required
OrderCreationStatus	Required
Audit Fields	Read-only

The following table details the pick map fields for the order item object.

Table Pick Map Fields for the Order Item Object

Pick Map Field	Maps To
ProductName	ProductId
OrderNumber	OrderId

The following table provides a list of the user key combinations for the order item object.

Table User Key Fields on the Order Item Object

User Key Field Combinations
OrderItemNum

There are no picklists available for the order item object.

Plan Account

The plan account object is a mapping of accounts and business plans.

Child Objects

Methods Called

The following table details the methods called by the plan account service.

Table Methods Called by Plan Account Service

Method	Name as Defined in Service
Delete	AccountBusinessPlanDelete
Execute	AccountBusinessPlanExecute
Insert	AccountBusinessPlanInsert
QueryPage	AccountBusinessPlanQueryPage
Update	AccountBusinessPlanUpdate

Fields

The following table details the required and read-only fields for the plan account object.

Table Required and Read-Only Fields for the Plan Account Object

Field Name	Type
AccountIDAccountName	Required
BusinessPlanPlanName	Required
ContactId	Required
RelationshipCode	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the plan account object.

Table Pick Map Fields for the Plan Account Object

Pick Map Field	Maps To
AccountIDAccountName	AccountId
AccountExternalSystemId	AccountId
AccountIntegrationId	AccountId
BusinessPlanPlanName	BusinessPlanId
BusinessPlanExternalSystemId	BusinessPlanId
BusinessPlanIntegrationId	BusinessPlanId
OwnerUserSignId	OwnerId
OwnerExternalSystemId	OwnerId
OwnerIntegrationId	OwnerId

The following table provides a list of the user key combinations for the plan account object.

Table User Key Fields on the Plan Account Object

User Key Field Combinations
Id
ExternalSystemId
BusinessPlanId and AccountIDId
BusinessPlanPlanName

Plan Contact

The plan contact object is a mapping of contacts and business plans.

Child Objects

Methods Called

The following table details the methods called by the plan contact service.

Table Methods Called by Plan Contact Service

Method	Name as Defined in Service
Delete	ContactBusinessPlanDelete
Execute	ContactBusinessPlanExecute
Insert	ContactBusinessPlanInsert
QueryPage	ContactBusinessPlanQueryPage
Update	ContactBusinessPlanUpdate

Fields

The following table details the required and read-only fields for the plan contact object.

Table Required and Read-Only Fields for the Plan Contact Object

Field Name	Type
ContactId	Required
BusinessPlanPlanName	Required
Audit Fields	Read-only

The following table details the pick map fields for the plan contact object.

Table Pick Map Fields for the Plan Contact Object

Pick Map Field	Maps To
ContactFullName	ContactId
ContactExternalSystemId	ContactId
ContactIntegrationId	ContactId
BusinessPlanPlanName	BusinessPlanId
BusinessPlanExternalSystemId	BusinessPlanId
BusinessPlanIntegrationId	BusinessPlanId
OwnerUserSignId	OwnerId
OwnerExternalSystemId	OwnerId
OwnerIntegrationId	OwnerId

The following table provides a list of the user key combinations for the plan contact object.

Table User Key Fields on the Plan Contact Object

User Key Field Combinations
Id
ExternalSystemId
BusinessPlanId and ContactId
ContactFullName

Plan Opportunity

The plan opportunity object is a mapping of opportunities and business plans.

Child Objects

Methods Called

The following table details the methods called by the Plan Opportunity service.

Table Methods Called by Plan Opportunity Service

Method	Name as Defined in Service
Delete	PlanOpportunityDelete
Execute	PlanOpportunityExecute
Insert	PlanOpportunityInsert
QueryPage	PlanOpportunityQueryPage
Update	PlanOpportunityUpdate

Fields

The following table details the required and read-only fields for the plan opportunity object.

Table Required and Read-Only Fields for the Plan Opportunity Object

Field Name	Type
OpportunityName	Required
PlanName	Required
Audit Fields	Read-only

The following table details the pick map fields for the plan opportunity object.

Table Pick Map Fields for the Plan Opportunity Object

Pick Map Field	Maps To
OpportunityName	OpportunityId
OpportunityExternalSystemId	OpportunityId
OpportunityIntegrationId	OpportunityId
PlanName	PlanId
PlanExternalSystemId	PlanId
PlanIntegrationId	PlanId
OwnerUserSignId	OwnerId
OwnerExternalSystemId	OwnerId
OwnerIntegrationId	OwnerId

The following table provides a list of the user key combinations for the plan opportunity object.

Table User Key Fields on the Plan Opportunity Object

User Key Field Combinations
Id
ExternalSystemId
PlanId and OpportunityId
OpportunityName

Product Indication

The product indication object stores the combination of a symptom or malady and the specific product or drug that alleviates the symptom or malady that is typically detailed by a pharmaceutical sales representative during a call with a health practitioner.

Child Objects

Audit Trail, Related Disclaimer

Methods Called

The following table details the methods called by the Product Indication service.

Table Methods Called by Product Indication Service

Method	Name as Defined in Service
Delete	ProductIndicationDelete
Execute	ProductIndicationExecute
Insert	ProductIndicationInsert
QueryPage	ProductIndicationQueryPage
Update	ProductIndicationUpdate

Fields

The following table details the required and read-only fields for the product indication object.

Table Required and Read-Only Fields for the Product Indication Object

Field Name	Type
IndicationName	Required
ProductName	Required
Audit Fields	Read-only

The following table details the pick map fields for the product indication object.

Table Pick Map Fields for the Product Indication Object

Pick Map Field	Maps To
ProductName	ProductId

The following table details the user keys for the product indication object.

Table User Keys for the Product Indication Object

Field Name
ProductName
IndicationName

Related Disclaimer

The related disclaimer object stores the sample disclaimer text for a particular language for a multilingual sample disclaimer.

Child Objects

None

Usage

A number of restrictions apply to the usage of the Related Disclaimer service:

Related disclaimer child records can be inserted and associated only with an inactive sample disclaimer parent, and cannot be inserted and associated with active or expired sample disclaimers.
Related disclaimer child records can be deleted only from an inactive sample disclaimer parent, and cannot be deleted from active or expired sample disclaimers.
A related disclaimer child cannot exist without a parent sample disclaimer.
All record locking rules must be honored by the Related Disclaimer service.

Note: You might find that some of these restrictions do not apply for your company depending on whether your company administrator has set up the appropriate record locking rules using the process administration functionality of Oracle CRM On Demand. For more information about process administration, see Oracle CRM On Demand Online Help.

Methods Called

The following table details the methods called by the Related Disclaimer service.

Table Methods Called by Related Disclaimer Service

Method	Name as Defined in Service
Delete	RelatedDisclaimerDelete
Execute	RelatedDisclaimerExecute
Insert	RelatedDisclaimerInsert
QueryPage	RelatedDisclaimerQueryPage
Update	RelatedDisclaimerUpdate

Fields

The following table details the required and read-only fields for the related disclaimer object.

Table Required and Read-Only Fields for the Related Disclaimer Object

Field Name	Type
Disclaimer	Required
Language	Required
ParentId	Required
Audit Fields	Read-only

The following table details the user keys for the related disclaimer object.

Table User Keys for the Related Disclaimer Object

Field Name
Id
ParentId and Language

The following table details the picklists available for the related disclaimer object.

Table Picklists Available for the Related Disclaimer Object

Field Name
Language

Sample Disclaimer

The sample disclaimer object stores the text that is displayed to deny responsibility for certain adverse effects and reduce liability for a product sample that is dropped off to a physician or other health care professional.

Oracle CRM On Demand supports two types of sample disclaimer:

Global. A global sample disclaimer contains one disclaimer record for each company instance. This disclaimer applies to all products provided as samples, and is displayed at the time of signature capture to confirm receipt of the product samples. Only one global sample disclaimer can be active at any time. This is the default type for Oracle CRM On Demand.
Multilingual. A multilingual sample disclaimer contains an unlimited number of related disclaimers text records in multiple languages, grouped by the countries that apply to the disclaimer. Each sample disclaimer record consists of a header section, and a language-specific Related Disclaimer section that contains the translated disclaimer text required by the company. Only one set of multilingual sample disclaimers can be active within a country at any time, however more than one set of multilingual sample disclaimers can be active at the same time spanning multiple countries. Before you can use multilingual sample disclaimers, your company administrator must set up special page layouts as described in Configuration Guide for Oracle CRM On Demand Life Sciences Edition.

For more information about sample disclaimers, see Oracle CRM On Demand Online Help.

Usage

A number of restrictions apply to the usage of the Sample Disclaimer service:

A sample disclaimer can be inserted only with a Status value of Inactive. A sample disclaimer can be activated only through the UI.
A sample disclaimer cannot have the StartDate, EndDate, or Status fields updated.
A sample disclaimer that is active or expired cannot be updated.
A sample disclaimer that is active or expired cannot be deleted.
All record locking rules must be honored by the Sample Disclaimer service.

Note: You might find that some of these restrictions do not apply for your company depending on whether your company administrator has set up the appropriate record locking rules using the process administration functionality of Oracle CRM On Demand. For more information about process administration, see Oracle CRM On Demand Online Help.

Child Objects

Methods Called

The following table details the methods called by the Sample Disclaimer service.

Table Methods Called by Sample Disclaimer Service

Method	Name as Defined in Service
Delete	SignatureDisclaimerDelete
Execute	SignatureDisclaimerExecute
Insert	SignatureDisclaimerInsert
QueryPage	SignatureDisclaimerQueryPage
Update	SignatureDisclaimerUpdate

Fields

The following table details the required and read-only fields for the sample disclaimer object.

Table Required and Read-Only Fields for the Sample Disclaimer Object

Field Name	Type
DisclaimerText	Required (global disclaimers only)
Status	Required (for inserts)
Country	Required (multilingual disclaimers only)
Language	Required (multilingual disclaimers only)
Audit Fields	Read-only

Note: The DisclaimerText field is required for global disclaimers only. You can create a sample disclaimer without disclaimer text, but if you try to activate such a sample disclaimer through the UI, an error is generated. Similarly, the Country and Language fields are not required when a record is inserted, but they are required when a multilingual sample disclaimer is activated.

The following table details the pick map field for the sample disclaimer object.

Table Pick Map Field for the Sample Disclaimer Object

Pick Map Field	Maps To
OwnerUserSignId	OwnerId
OwnerExternalSystemId	OwnerId
OwnerIntegrationId	OwnerId

The following table details the user keys for the sample disclaimer object.

Table User Keys for the Sample Disclaimer Object

Field Name
Id
ExternalSystemId
DisclaimerNumber

The following table details the picklists available for the sample disclaimer object.

Table Picklists Available for the Sample Disclaimer Object

Field Name
Status
Type
Country

Sample Inventory

The sample inventory object stores information about a product that has been categorized as qualifying for dropping a sample.

Child Objects

None

Methods Called

The following table details the methods called by the Sample Inventory service.

Table Methods Called by Sample Inventory Service

Method	Name as Defined in Service
Delete	SampleInventoryDelete
Execute	SampleInventoryExecute
Insert	SampleInventoryInsert
QueryPage	SampleInventoryQueryPage
Update	SampleInventoryUpdate

Fields

The following table details the required and read-only fields for the sample inventory object.

Table Required and Read-Only Fields for the Sample Inventory Object

Field Name	Type
InventoryPeriodStartDate	Required
ProductName	Required
OpeningBalance	Required
SystemCount	Read-only
Difference	Read-only
InventoryLot	Read-only
Audit Fields	Read-only

The following table details the pick map field for the sample inventory object.

Table Pick Map Fields for the Sample Inventory Object

Pick Map Field	Maps To
LotNumLotId	LotNumId
LotNumExternalSystemId	LotNumId
LotNumIntegrationId	LotNumId
InventoryPeriodExternalSystemId	InventoryPeriodId
InventoryPeriodIntegrationId	InventoryPeriodId
AuditReportExternalSystemId	AuditReportId
AuditReportIntegrationId	AuditReportId
ProductName	ProductId
ProductExternalSystemId	ProductId
ProductIntegrationId	ProductId
OwnerUserSignId	OwnerId
OwnerExternalSystemId	OwnerId
OwnerIntegrationId	OwnerId

The following table details the user keys for the sample inventory object.

Table User Keys for the Sample Inventory Object

Field Name
SampleInventoryId
IntegrationId
ExternalSystemId
OwnerId and ProductId and InventoryPeriodId and LotNumId and AuditReportId
ProductName

Sample Lot

The sample lot object records information about lot numbers for sample products.

Child Objects

Audit Trail,Book, Sample Inventory, Transaction Item.

Methods Called

The following table details the methods called by the Sample Lot service.

Table Methods Called by Sample Lot Service

Method	Name as Defined in Service
Delete	SampleLotDelete
Execute	SampleLotExecute
Insert	SampleLotInsert
QueryPage	SampleLotQueryPage
Update	SampleLotUpdate

Fields

The following table details the required and read-only fields for the sample lot object.

Table Required and Read-Only Fields for the Sample Lot Object

Field Name	Type
LotId	Required
SampleName	Required
ExpirationDate	Required
Orderable	Required
ParentSampleNameName	Required
Status	Read-only
CutoffDate	Read-only
DateCutOff	Read-only
Audit Fields	Read-only

Note: The DateCutOff and CutoffDate fields are both available. DateCutOff is a calculated field of type Date used if you require date processing in your application. CutoffDate is the text version of DateCutOff.

The following table details the pick map field for the sample lot object.

Table Pick Map Field for the Sample Lot Object

Pick Map Field	Maps To
ParentSampleNameName	ParentSampleNameId
ParentSampleNameExternalSystemId	ParentSampleNameId
ParentSampleNameIntegrationId	ParentSampleNameId
OwnerUserSignId	OwnerId
OwnerExternalSystemId	OwnerId
OwnerIntegrationId	OwnerId

The following table details the user keys for the sample lot object.

Table User Keys for the Sample Lot Object

Field Name
Id
ExternalSystemId
LotId

Sample Request

The sample request object is used to track sample requests and associated sample request items for products.

Usage

For Insert requests, if the Type field is not specified as empty or as a picklist value, then it defaults to the value Sample Request.

Child Objects

Audit Trail,Book, Sample Request Item, Team

Methods Called

The following table details the methods called by the Sample Request service.

Table Methods Called by Sample Request Service

Method	Name as Defined in Service
Delete	SampleRequestDelete
Execute	SampleRequestExecute
Insert	SampleRequestInsert
QueryPage	SampleRequestQueryPage
Update	SampleRequestUpdate

Fields

The following table details the required and read-only fields for the sample request object.

Table Required and Read-Only Fields for the Sample Request Object

Field Name	Type
ContactId	Required
ShippingAddress	Required
OrderNumber	Read-only
OrderIntegrationMessage	Read-only
OrderCreationDate	Read-only
OwnerId	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the sample request object.

Table Pick Map Fields for the Sample Request Object

Pick Map Field	Maps To
OrderNumber	OrderId

The following table details the user key combinations for the sample request object.

Table User Key Fields on the Sample Request Object

User Key Field Combinations
Id
OrderNumber

The following table details the picklists for the sample request object.

Table Picklist Fields on the Sample Request Object

Field Name
OrderCreationStatus
Type

Sample Request Item

The sample request item object tracks which products have been purchased by the customer as part of a sample request.

Usage

In releases of Oracle CRM On Demand before Release 22, it was possible to insert a sample request item record without an associated parent sample request record. From Release 22, however, when inserting sample request item records, you must provide the Sample Request ID of the parent to provide the context for the sample request item.

Product blocking rules are respected for this object. A blocked product is a product for which your company does not want users to provide any product information, samples, or promotional items for that product to the associated contact.

Web service requests cannot insert, update, or delete records for this object if the product specified in the request is a blocked product. An error message is generated when such a request is made. For more information about blocked products, see Oracle CRM On Demand Online Help and Blocked Product.

Methods Called

The following table details the methods called by the Sample Request Item service.

Table Methods Called by Sample Request Item Service

Method	Name as Defined in Service
Delete	SampleRequestItemDelete
Execute	SampleRequestItemExecute
Insert	SampleRequestItemInsert
QueryPage	SampleRequestItemQueryPage
Update	SampleRequestItemUpdate

Fields

The following table details the required and read-only fields for the sample request item object.

Table Required and Read-Only Fields for the Sample Request Item Object

Field Name	Type
Quantity	Required
ProductName	Required
SampleRequestOrderNumber	Required
OrderItemNum	Required
Audit Fields	Read-only

The following table details the pick map fields for the sample request item object.

Table Pick Map Fields for the Sample Request Item Object

Pick Map Field	Maps To
ProductName	ProductId

The following table provides a list of the user key combinations for the sample request item object.

Table User Key Fields on the Sample Request Item Object

User Key Field Combinations
OrderItemNum

The following table details the picklists for the sample request item object.

Table Picklist Fields on the Sample Request Item Object

Field Name
OrderCreationStatus

Sample Transaction

The sample transaction object is a record for a sample transfer, receipt, disbursement, or inventory adjustment. A sample transaction is created so that all movement of samples and promotional items can be reported and reconciled at the end of an inventory period, and a running count of inventory products can be maintained during the life of an inventory period.

Support for Attachments

You can exchange attachments through the following fields:

UI Display Name	Integration Tag Name
Attachment	AttachFileFullName
Attachment: Extension	AttachFileExt
Attachment: File Name	AttachFileName
Attachment: Size (in Bytes)	AttachFileSizeDisp

The Attachment tag is used for the actual attachment and is a string type Base64.

Child Objects

Audit Trail, Book, Transaction Item

Methods Called

The following table details the methods called by the Sample Transaction service.

Table Methods Called by Sample Transaction Service

Method	Name as Defined in Service
Delete	TransactionDelete
Execute	TransactionExecute
Insert	TransactionInsert
QueryPage	TransactionQueryPage
Update	TransactionUpdate

Fields

The following table details the required and read-only fields for the sample transaction object.

Table Required and Read-Only Fields for the Sample Transaction Object

Field Name	Type
Name	Required
TransactionDate	Required
TransactionType	Required
InvoiceNumber	Required
Audit Fields	Read-only

The following table details the pick map field for the sample transaction object.

Table Pick Map Field for the Sample Transaction Object

Pick Map Field	Maps To
SalesPersonIDId	SalesPersonIDId
SalesPersonIDExternalSystemId	SalesPersonIDId
SalesPersonIDIntegrationId	SalesPersonIDId
TransferToUserSignId	TransferToId
TransferToExternalSystemId	TransferToId
TransferToIntegrationId	TransferToId
InventoryPeriodExternalSystemId	InventoryPeriodId
InventoryPeriodIntegrationId	InventoryPeriodId
ProductIntegrationId	ProductId
OwnerUserSignId	OwnerId
OwnerExternalSystemId	OwnerId
OwnerIntegrationId	OwnerId

The following table details the user keys for the sample transaction object.

Table User Keys for the Sample Transaction Object

Field Name
Id
ExternalSystemId
Name

The following table details the picklists available for the sample transaction object.

Table Picklists Available for the Sample Transaction Object

Field Name
TransactionType
TransactionStatus
Reason

Signature

The signature object stores information about a signature associated with a call activity for samples that are dropped.

Support for Attachments

You can exchange attachments through the following fields:

UI Display Name	Integration Tag Name
Attachment	AttachFileFullName
Attachment: Extension	AttachFileExt
Attachment: File Name	AttachFileName
Attachment: Size (in Bytes)	AttachFileSizeDisp

The Attachment tag is used for the actual attachment and is a string type Base64.

Child Objects

Methods Called

The following table details the methods called by the Signature service.

Table Methods Called by Signature Service

Method	Name as Defined in Service
Delete	SignatureDelete
Execute	SignatureExecute
Insert	SignatureItemInsert
QueryPage	SignatureQueryPage
Update	SignatureUpdate

Fields

The following table details the required and read-only fields for the signature object.

Table Required and Read-Only Fields for the Signature Object

Field Name	Type
ActivityId	Required
SignatureCtrl	Required
Audit Fields	Read-only

The following table details the pick map field for the signature object.

Table Pick Map Field for the Signature Object

Pick Map Field	Maps To
ContactFullName	ContactId
ContactExternalSystemId	ContactId
ContactIntegrationId	ContactId
OwnerUserSignId	OwnerId
OwnerExternalSystemId	OwnerId
OwnerIntegrationId	OwnerId

The following table details the user keys for the signature object.

Table User Keys for the Signature Object

Field Name
Id
ExternalSystemId
ActivityId

Transaction Item

The transaction item object stores the details of the sample or promotional items associated with a sample transaction.

Child Objects

None

Methods Called

The following table details the methods called by the Transaction Item service.

Table Methods Called by Transaction Item Service

Method	Name as Defined in Service
Delete	TransactionItemDelete
Execute	TransactionItemExecute
Insert	TransactionItemInsert
QueryPage	TransactionItemQueryPage
Update	TransactionItemUpdate

Fields

The following table details the required and read-only fields for the transaction item object.

Table Required and Read-Only Fields for the Transaction Item Object

Field Name	Type
LineNumber	Required
SampleTransactionName	Required
ProductName	Required
Quantity	Required
Audit Fields	Read-only

The following table details the pick map field for the transaction item object.

Table Pick Map Field for the Transaction Item Object

Pick Map Field	Maps To
SampleTransactionName	SampleTransactionId
SampleTransactionExternalSystemId	SampleTransactionId
SampleTransactionIntegrationId	SampleTransactionId
LotNumLotId	LotNumId
LotNumExternalSystemId	LotNumId
LotNumIntegrationId	LotNumId
InventoryPeriodExternalSystemId	InventoryPeriodId
InventoryPeriodIntegrationId	InventoryPeriodId
ProductName	ProductId
ProductExternalSystemId	ProductId
ProductIntegrationId	ProductId
OwnerUserSignId	OwnerId
OwnerExternalSystemId	OwnerId
OwnerIntegrationId	OwnerId

The following table details the user keys for the transaction item object.

Table User Keys for the Transaction Item Object

Field Name
Id
ExternalSystemId
SampleTransactionId and LineNumber
ProductName

Financial Services Edition Parent Objects (Web Services v2.0)

This topic includes the parent objects available with Oracle CRM On Demand Financial Services Edition. For these parent objects, all child objects are also accessible.

Note: To download WSDL files for these objects, you must be given access to the object. If you do not have access to the object, it is not available to download from the Web Services Administration page or available to use the Web service calls. For assistance in gaining access to the objects, contact your Oracle CRM On Demand service provider.

The following objects are detailed in this topic:

Claim

The claim object allows you to define and record details about an insurance policy claim. Claims are typically the claims of a contact or business that an insurance company manages.

Child Objects

Activity, Audit Trail,Damage, Involved Party, Service Request.

Methods Called

The following table details the methods called by the Claim service.

Table Methods Called by Claim Service

Method	Name as Defined in Service
Delete	ClaimDelete
Execute	ClaimExecute
Insert	ClaimInsert
QueryPage	ClaimQueryPage
Update	ClaimUpdate

Fields

The following table details the required and read-only fields for the claim object.

Table Read-Only Fields on the Claim Object

Field Name	Type
ClaimNumber	Required
ReportDate	Required
LossDateandTime	Required
PolicyName	Required
CurrencyCode	Read-only
Audit Fields	Read-only

The following table details the pickmap fields for the claim object.

Table Pick Map Fields for the Claim Object

Pick Map Field	Maps To
PolicyExternalSystemId	PolicyId
PolicyIntegrationId	PolicyId

The following table provides a list of the user key combinations for the claim object.

Table User Key Fields on the Claim Object

User Key Field Combinations
Id
ExternalSystemId
ClaimNumber

The following table details the picklists available for the claim object.

Table Picklists Available for the Claim Object

Field Name
AbilitytoWork
AtFault
CategoryofLoss
ClassofEmployee
InjuredDuringWorkingHours
KindofLoss
LiabilitySource
LineofBusiness
LocationofLoss
LossCode
LossType
MedicalInjuryCode
PartofBodyInjured
PlaceofInjury
RelationshiptoInsured
ReportedBy
State
Status
TypeofInjury

Coverage

The coverage object allows you to define and record details about an insurance policy coverage. Coverage is a term used to describe the monetary limits and risks covered as set out in an insurance policy.

Child Objects

Methods Called

The following table details the methods called by the Coverage service.

Table Methods Called by Coverage Service

Method	Name as Defined in Service
Delete	CoverageDelete
Execute	CoverageExecute
Insert	CoverageInsert
QueryPage	CoverageQueryPage
Update	CoverageUpdate

Fields

The following table details the required and read-only fields for the coverage object.

Table Required and Read-Only Fields on the Coverage Object

Field Name	Type
CoverageName	Required
PolicyName	Required
CurrencyCode	Read-only
Owner	Read-only
OwnerId	Read-only
Audit Fields	Read-only

The following table details the pickmap fields for the coverage object.

Table Pick Map Fields for the Coverage Object

Pick Map Field	Maps To
PolicyExternalSystemId	PolicyId
PolicyIntegrationId	PolicyId

The following table provides a list of the user key combinations for the coverage object.

Table User Key Fields on the Coverage Object

User Key Field Combinations
CoverageName
IntegrationId
ExternalSystemId

The following table details the picklists available for the coverage object.

Table Picklists Available for the Coverage Object

Field Name
Coverage
Status

Damage

The damage object allows you to define and record details about the damages to properties covered in an insurance policy.

Child Objects

Methods Called

The following table details the methods called by the Damage service.

Table Methods Called by Damage Service

Method	Name as Defined in Service
Delete	DamageDelete
Execute	DamageExecute
Insert	DamageInsert
QueryPage	DamageQueryPage
Update	DamageUpdate

Fields

The following table details the required and read-only fields for the damage object.

Table Required and Read-Only Fields on the Damage Object

Field Name	Type
ClaimNumber	Required
DamageName	Required
CurrencyCode	Read-only
Owner	Read-only
OwnerId	Read-only
PrimaryContact	Read-only
Audit Fields	Read-only

The following table details the pickmap fields for the damage object.

Table Pick Map Fields for the Damage Object

Pick Map Field	Maps To
ClaimExternalId	ClaimId
ClaimIntegrationId	ClaimId

The following table provides a list of the user key combinations for the damage object.

Table User Key Fields on the Damage Object

User Key Field Combinations
Id
ExternalSystemId
DamageName

Financial Account

The financial account object stores information about the financial accounts of a contact or business that a financial institution manages, but can also track held away financial accounts.

Child Objects

Activity, Audit Trail, Book, Financial Account, Financial Account Holder, Financial Account Holding, Financial Plan, Financial Transaction, Lead, Policy, Service Request, Team,

Methods Called

The following table details the methods called by the Financial Account service.

Table Methods Called by Financial Account Service

Method	Name as Defined in Service
Delete	FinancialAccountDelete
Execute	FinancialAccountExecute
Insert	FinancialAccountInsert
QueryPage	FinancialAccountQueryPage
Update	FinancialAccountUpdate

Fields

The following table details the required and read-only fields for the financial account object.

Table Required and Read-Only Fields for the Financial Account Object

Field Name	Type
FinancialAccount	Required
FinancialAccountNumber	Required
Type	Required
CurrencyCode	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the financial account object.

Table Pick Map Fields for the Financial Account Object

Pick Map Field	Maps To
ParentFinancialAccountIntegrationId	ParentFinancialAccountId
ParentFinancialAccountExternalSystemId	ParentFinancialAccountId

The following table provides a list of the user key combinations for the financial account object.

Table User Key Fields on the Financial Account Object

User Key Field Combinations
FinancialAccount
Id
ExternalSystemId

The following table details the picklists available for the financial account object.

Table Picklists Available for the Financial Account Object

Field Name
Type
HomeBranch

Financial Account Holder

The financial account holder object stores information about a financial account holder, which is any contact that has a relationship with the financial account, most commonly the legal owner of the financial account.

Child Objects

Methods Called

The following table details the methods called by the Financial Account Holder service.

Table Methods Called by Financial Account Holder Service

Method	Name as Defined in Service
Delete	FinancialAccountHolderDelete
Execute	FinancialAccountHolderExecute
Insert	FinancialAccountHolderInsert
QueryPage	FinancialAccountHolderQueryPage
Update	FinancialAccountHolderUpdate

Fields

The following table details the required and read-only fields for the financial account holder object.

Table Required and Read-Only Fields for the Financial Account Holder Object

Field Name	Type
FinancialAccountHolderName	Required
FinancialAccount	Required
Role	Required
CurrrencyCode	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the financial account holder object.

Table Pick Map Fields for the Financial Account Holder Object

Pick Map Field	Maps To
FinancialAccounIntegrationId	FinancialAccountId
FinancialAccounExternalSystemId	FinancialAccountId

The following table provides a list of the user key combinations for the financial account holder object.

Table User Key Fields on the Financial Account Holder Object

User Key Field Combinations
FinancialAccountHolderName
Id
ExternalSystemId

The following table details the picklists available for the financial account holder object.

Table Picklists Available for the Financial Account Holder Object

Field Name
Role

Financial Account Holding

The financial account holding object stores information about the financial account holdings, which are typically the total of all financial account transactions of a single financial product for a financial account.

Child Objects

Audit Trail, Coverage, Financial Account Holding, Financial Product, Financial Transaction.

Methods Called

The following table details the methods called by the Financial Account Holding service.

Table Methods Called by Financial Account Holding Service

Method	Name as Defined in Service
Delete	FinancialAccountHoldingDelete
Execute	FinancialAccountHoldingExecute
Insert	FinancialAccountHoldingInsert
QueryPage	FinancialAccountHoldingQueryPage
Update	FinancialAccountHoldingUpdate

Fields

The following table details the required and read-only fields for the financial account holding object.

Table Required and Read-Only Fields for the Financial Account Holding Object

Field Name	Type
FinancialAccountHoldingsName	Required
FinancialAccount	Required
FinancialProductFinancialProductName	Required
CurrencyCode	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the financial account holding object.

Table Pick Map Fields for the Financial Account Holding Object

Pick Map Field	Maps To
FinancialAccounIntegrationId	FinancialAccountId
FinancialAccounExternalSystemId	FinancialAccountId

The following table provides a list of the user key combinations for the financial account holding object.

Table User Key Fields on the Financial Account Holding Object

User Key Field Combinations
FinancialAccountHoldingsName
Id
ExternalSystemId

Financial Plan

The financial plan object stores information about the plans of a contact or business for one or more specific financial accounts that a financial institution manages.

Child Objects

Activity, Audit Trail,Book, Lead, Service Request, Team.

Methods Called

The following table details the methods called by the Financial Plan service.

Table Methods Called by Financial Plan Service

Method	Name as Defined in Service
Delete	FinancialPlanDelete
Execute	FinancialPlanExecute
Insert	FinancialPlanInsert
QueryPage	FinancialPlanQueryPage
Update	FinancialPlanUpdate

Fields

The following table details the required and read-only fields for the financial plan object.

Table Required and Read-Only Fields for the Financial Plan Object

Field Name	Type
FinancialPlan	Required
Status	Required
Type	Required
CurrencyCode	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the financial plan object.

Table Pick Map Fields for the Financial Plan Object

Pick Map Field	Maps To
FinancialAccounIntegrationId	FinancialAccountId
FinancialAccounExternalSystemId	FinancialAccountId

The following table provides a list of the user key combinations for the financial plan object.

Table User Key Fields on the Financial Plan Object

User Key Field Combinations
FinancialPlan
Id
ExternalSystemId

The following table details the picklists available for the financial plan object.

Table Picklists Available for the Financial Plan Object

Field Name
Type
Status

Financial Product

The financial product object stores information about the products and services that a financial institution offers to its customers.

Child Objects

Methods Called

The following table details the methods called by the Financial Product service.

Table Methods Called by Financial Product Service

Method	Name as Defined in Service
Delete	FinancialProductDelete
Execute	FinancialProductExecute
Insert	FinancialProductInsert
QueryPage	FinancialProductQueryPage
Update	FinancialProductUpdate

Fields

The following table details the required and read-only fields for the financial product object.

Table Required and Read-Only Fields for the Financial Product Object

Field Name	Type
FinancialProductName	Required
CurrencyCode	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the financial product object.

Table Pick Map Fields for the Financial Product Object

Pick Map Field	Maps To
ParentFinancialProductIntegrationId	ParentFinancialProductId
ParentFinancialProductExternalSystemId	ParentFinancialProductId

The following table provides a list of the user key combinations for the financial product object.

Table User Key Fields on the Financial Product Object

User Key Field Combinations
FinancialProductName
Id
ExternalSystemId

The following table details the picklists available for the financial product object.

Table Picklists Available for the Financial Product Object

Field Name
Category
Type
Class
Sub-Class

Financial Transaction

The financial transaction object stores information about financial account transactions, which are typically the individual transactions of a financial account for all financial products.

Child Objects

Audit Trail, Financial Transaction, Service Request.

Methods Called

The following table details the methods called by the Financial Transaction service.

Table Methods Called by Financial Transaction Service

Method	Name as Defined in Service
Delete	FinancialTransactionDelete
Execute	FinancialTransactionExecute
Insert	FinancialTransactionInsert
QueryPage	FinancialTransactionQueryPage
Update	FinancialTransactionUpdate

Fields

The following table details the required and read-only fields for the financial transaction object.

Table Required and Read-Only Fields for the Financial Transaction Object

Field Name	Type
FinancialAccount	Required
FinancialProductFinancialProductName	Required
TransactionType	Required
TransactionID	Required
Audit Fields	Read-only

The following table details the pick map fields for the financial transaction object.

Table Pick Map Fields for the Financial Transaction Object

Pick Map Field	Maps To
FinancialTransactionParentIntegrationId	FinancialTransactionParentId
FinancialTransactionParentExternalSystemId	FinancialTransactionParentId

The following table provides a list of the user key combinations for the financial transaction object.

Table User Key Fields on the Financial Transaction Object

User Key Field Combinations
TransactionID
Id
ExternalSystemId

The following table details the picklists available for the financial transaction object.

Table Picklists Available for the Financial Transaction Object

Field Name
TransactionType

Household

The household object allows you to define and record financial details about a group of contacts that live in the same household, for example, parents, brothers, sisters, spouses, and so on. These details include the assets of the household, the liabilities of the household, the net income of the household, and so on.

Child Objects

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

Methods Called

The following table details the methods called by the Household service.

Table Methods Called by Household Service

Method	Name as Defined in Service
Delete	HouseholdDelete
Execute	HouseholdExecute
Insert	HouseholdInsert
QueryPage	HouseholdQueryPage
Update	HouseholdUpdate

Fields

The following table details the required and read-only fields for the household object.

Table Required and Read-Only Fields for the Household Object

Field Name	Type
HouseholdName	Required
IntegrationID	Required
ExternalSystemID	Required
HouseholdId	Read-only
PrimaryContactId	Read-only
PrimaryContactExternalId	Read-only
PrimaryContactIntegrationId	Read-only
PrimaryContactFirstName	Read-only
PrimaryContactLastName	Read-only
Timezone	Read-only
HouseholdCurrency	Read-only
LastActivity	Read-only
HeadDOB	Read-only
TotalIncome	Read-only
TotalAssets	Read-only
TotalExpenses	Read-only
TotalLiabilities	Read-only
TotalNetWorth	Read-only
RiskProfile	Read-only
ExperienceLevel	Read-only
InvestmentHorizon	Read-only
CurrentInvestmentMix	Read-only
Objective	Read-only
PrimaryGoal	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the household object.

Table Pick Map Field for the Household Object

Pick Map Field	Maps To
ContactExternalId	ContactId
ContactIntegrationId	ContactId

The following table provides a list of the user key combinations for the household object.

Table User Key Fields on the Household Object

User Key Field Combinations
HouseholdName
Id
ExternalSystemId

The following table details the picklists available for the household object.

Table Picklists Available for the Household Object

Field Name
Segment
Type

Insurance Property

The insurance property object allows you to define and record details about an insurance property. Insurance properties are typically the properties of a contact that are included in an insurance policy or a claim.

Child Objects

Audit Trail,Coverage, Damage.

Methods Called

The following table details the methods called by the Insurance Property service.

Table Methods Called by Insurance Property Service

Method	Name as Defined in Service
Delete	InsurancePropertyDelete
Execute	InsurancePropertyExecute
Insert	InsurancePropertyInsert
QueryPage	InsurancePropertyQueryPage
Update	InsurancePropertyUpdate

Fields

The following table details the required and read-only fields for the insurance property object.

Table Required and Read-Only Fields on the Insurance Property Object

Field Name	Type
PolicyName	Required
Type	Required
CurrencyCode	Read-only
Owner	Read-only
OwnerId	Read-only
Audit Fields	Read-only

The following table details the pickmap fields for the insurance property object.

Table Pick Map Fields for the Insurance Property Object

Pick Map Field	Maps To
PolicyExternalSystemId	PolicyId
PolicyIntegrationId	PolicyId

The following table provides a list of the user key combinations for the insurance property object.

Table User Key Fields on the Insurance Property Object

User Key Field Combinations
Type
Id
ExternalSystemId

The following table details the picklists available for the insurance property object.

Table Picklists Available for the Insurance Property Object

Field Name
Type

Involved Party

The involved party object allows you to define and record details about an involved party, which is typically a contact involved in an insurance claim.

Child Objects

Methods Called

The following table details the methods called by the Involved Party service.

Table Methods Called by Involved Party Service

Method	Name as Defined in Service
Delete	InvolvedPartyDelete
Execute	InvolvedPartyExecute
Insert	InvolvedPartyInsert
QueryPage	InvolvedPartyQueryPage
Update	InvolvedPartyUpdate

Fields

The following table details the required and read-only fields for the involved party object.

Table Required and Read-Only Fields on the Involved Party Object

Field Name	Type
ClaimNumber	Required
Role	Required
InvolvedPartyName	Required
Contact	Required
CurrencyCode	Read-only
Owner	Read-only
OwnerId	Read-only
Audit Fields	Read-only

The following table details the pickmap fields for the involved party object.

Table Pick Map Fields for the Involved Party Object

Pick Map Field	Maps To
ClaimExternalSystemId	ClaimId
ClaimIntegrationId	ClaimId

The following table provides a list of the user key combinations for the involved party object.

Table User Key Fields on the Involved Party Object

User Key Field Combinations
InvolvedPartyName
Id
ExternalSystemId

The following table details the picklists available for the involved party object.

Table Picklists Available for the Involved Party Object

Field Name
Role
RoleinAccident
Location

Policy

The policy object allows you to define and record details about an insurance policy.

Child Objects

Activity, Audit Trail, Book, Claim, Coverage, Insurance Property, Lead, Policy, Policy Holder, Service Request.

Methods Called

The following table details the methods called by the Policy service.

Table Methods Called by Policy Service

Method	Name as Defined in Service
Delete	PolicyDelete
Execute	PolicyExecute
Insert	PolicyInsert
QueryPage	PolicyQueryPage
Update	PolicyUpdate

Fields

The following table details the required and read-only fields for the policy object.

Table Required and Read-Only Fields on the Policy Object

Field Name	Type
PolicyNumber	Required
PolicyType	Required
CurrencyCode	Read-only
Owner	Read-only
OwnerId	Read-only
Audit Fields	Read-only

The following table details the pickmap fields for the policy object.

Table Pick Map Fields for the Policy Object

Pick Map Field	Maps To
ClaimExternalSystemId	ClaimId
ClaimIntegrationId	ClaimId

The following table provides a list of the user key combinations for the policy object.

Table User Key Fields on the Policy Object

User Key Field Combinations
PolicyNumber
Id
ExternalSystemId

The following table details the picklists available for the policy object.

Table Picklists Available for the Policy Object

Field Name
PolicyType
Status
SubStatus
BillingStatus
RateState
RatePlan
ReferralSource
PolicyPayMethod

Policy Holder

The policy holder object allows you to define and record details about an insurance policy holder. A policy holder is typically the contact that owns the policy that the insurance company manages.

Child Objects

Methods Called

The following table details the methods called by the Policy Holder service.

Table Methods Called by Policy Holder Service

Method	Name as Defined in Service
Delete	PolicyHolderDelete
Execute	PolicyHolderExecute
Insert	PolicyHolderInsert
QueryPage	PolicyHolderQueryPage
Update	PolicyHolderUpdate

Fields

The following table details the required and read-only fields for the policy holder object.

Table Required and Read-Only Fields on the Policy Holder Object

Field Name	Type
PolicyName	Required
Role	Required
PolicyHolderName	Required
CurrencyCode	Read-only
Owner	Read-only
OwnerId	Read-only
Audit Fields	Read-only

The following table details the pickmap fields for the policy holder object.

Table Pick Map Fields for the Policy Holder Object

Pick Map Field	Maps To
PolicyExternalSystemId	PolicyId
PolicyIntegrationId	PolicyId

The following table provides a list of the user key combinations for the policy holder object.

Table User Key Fields on the Policy Holder Object

User Key Field Combinations
PolicyHolderName
Id
ExternalSystemId

The following table details the picklists available for the policy holder object.

Table Picklists Available for the Policy Holder Object

Field Name
InsuredType
Role

Portfolio

The portfolio object allows you to define and record details about the collection of financial services that you can provide to an account. Financial services include loans, credit cards, insurance, general banking, and so on.

Parent Objects

Contact, CustomObject, Household

Child Objects

Audit Trail, Contact, Financial Account, Financial Plan, Team.

Methods Called

The following table details the methods called by the Portfolio service.

Table Methods Called by Portfolio Service

Method	Name as Defined in Service
Delete	PortfolioDelete
Execute	PortfolioExecute
Insert	PortfolioInsert
QueryPage	PortfolioQueryPage
Update	PortfolioUpdate

Fields

The following table details the read-only fields for the portfolio object.

Table Required and Read-Only Fields on the Portfolio Object

Field Name	Type
PortfolioId	Read-only
Owner	Read-only
OwnerId	Read-only
PrimaryContact	Read-only
Audit Fields	Read-only

The following table details the pickmap fields for the portfolio object.

Table Pick Map Fields for the Portfolio Object

Pick Map Field	Maps To
InstitutionExternalId	InstitutionId
InstitutionIntegrationId	InstitutionId
InstitutionName	InstitutionId
InstitutionLocation	InstitutionId
Product	ProductId
ProductExternalId	ProductId
ProductIntegrationId	ProductId

The following table provides a list of the user key combinations for the portfolio object.

Table User Key Fields on the Portfolio Object

User Key Field Combinations
AccountNumber and ProductId
Id
ExternalSystemId

The following table details the picklists available for the portfolio object.

Table Picklists Available for the Portfolio Object

Field Name
AccountType
Status
TermUnit

Automotive Edition Parent Objects (Web Services v2.0)

This topic includes the parent objects available with Oracle CRM On Demand Automotive Edition.

Note: To download WSDL files for these objects, you must be given access to the object. If you do not have access to the object, it is not available to download from the Web Services Administration page or available to use the Web service calls. For assistance in gaining access to the objects, contact your Oracle CRM On Demand service provider.

The following objects are detailed in this topic:

Dealer

The dealer object stores information about dealerships in the automotive industry, for example, the name of the dealership, the identity of the parent dealership, the site on which the dealership is based, and so on. The dealer object does not have any parent objects.

Child Objects

Attachment, Audit Trail, Shared Address

For information about using attachments with this object, see Using Attachments with Web Services On Demand

Methods Called

The following table details the methods called by the Dealer service.

Table Methods Called by Dealer Service

Method	Name as Defined in Service
Delete	DealerDelete
Execute	DealerExecute
Insert	DealerInsert
QueryPage	DealerQueryPage
Update	DealerUpdate

Fields

The following table details the required and read-only fields for the dealer object.

Table Required and Read-Only Fields for the Dealer Object

Field Name	Type
DealerId	Required
DealerIntegrationId	Required
DealerExternalSystemID	Required
DealerId	Read-only
DealerType	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the dealer object.

Table Pick Map Fields for the Dealer Object

Pick Map Field	Maps To
Owner	OwnerId
ParentDealerExternalSystemId	ParentDealerId
ParentDealerIntegrationId	ParentDealerId
ParentDealerName	ParentDealerId
ParentDealerSite	ParentDealerId

The following table provides a list of the user key combinations for the dealer object.

Table User Key Fields on the Dealer Object

User Key Field Combinations
DealerId
ExternalSystemID

The following table details the picklists available for the dealer object.

Table Picklists Available for the Dealer Object

Field Name
ParentDealerName
ParentDealerSite

Vehicle

The vehicle object allows you to create and store information about a vehicle, for example, a car, a truck, a van, and so on, that your company would like to sell to a contact or account. This information includes the vehicle’s current mileage, the invoice price, the dealership, the make, and so on.

Child Objects

Audit Trail, Book .

Methods Called

The following table details the methods called by the Vehicle service.

Table Methods Called by Vehicle Service

Method	Name as Defined in Service
Delete	VehicleDelete
Execute	VehicleExecute
Insert	VehicleInsert
QueryPage	VehicleQueryPage
Update	VehicleUpdate

Fields

The following table details the required and read-only fields for the vehicle object.

Table Required and Read-Only Fields for the Vehicle Object

Field Name	Type
VehicleId	Read-only
Contact	Read-only
ProductType	Read-only
SellingDealer	Read-only
ServicingDealer	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the vehicle object.

Table Pick Map Fields for the Vehicle Object

Pick Map Field	Maps To
AccountName	AccountId
AccountSite	AccountId
AccountIntegrationId	AccountId
AccountExternalID	AccountId
SellingDealerExternalId	SellingDealerId
SellingDealerIntegrationId	SellingDealerId
ServicingDealerExternalId	ServicingDealerId
ServicingDealerIntegrationId	ServicingDealerId

The following table provides a list of the user key combinations for the vehicle object.

Table User Key Fields on the Vehicle Object

User Key Field Combinations
Id
ExternalSystemId
ProductId
SerialNumber
ProductExternalId

The following table details the picklists available for the vehicle object.

Table Picklists Available for the Vehicle Object

Field Name
Body
Door
Engine
ExteriorColor
InteriorColor
Location
Make
Model
VehicleOwnedBy
Status
Transmission
Trim
UsedNew
WarrantyType
Year

Child Objects (Web Services v2.0)

This topic includes a list of child objects that are used in Oracle On Demand Web Services v2.0.

The list includes:

Objects that are child objects only and are not themselves parent objects.
Objects that are also parent objects.
The Custom Web Applet child container.

Various parent objects are also child objects of other objects. This includes a number of industry-specific objects added in Release 16 and Release 17 of Oracle CRM On Demand. See the topics about the parent objects for information about the parent-child relationships. For these objects, the field information given for parent objects is the same for the objects when they are child objects, and is therefore not repeated in this topic.

For each child object, the methods that can be called are as shown in the following table. The methods that you can use on a child object are the same as for its parent object.

Table Methods Called On Child Objects

Method	Name as Defined in Service
Delete	<object>Delete
Execute	<object>Execute
Insert	<object>Insert
QueryPage	<object>QueryPage
Update	<object>Update

Note: For the Custom Web Applet child, only the QueryPage method is supported.

The following child objects are listed:

Note: For the Quote and Order child objects, access is included for use by the Oracle CRM On Demand to Oracle E-Business Suite integration and is not available for non-Oracle use. For access to the Order child object, the Order Usage value on the company profile page must be set to Ebiz PIP integration. If the Order Usage value on the company profile page is set to CRM On Demand Order Management, the Order object is a parent object with a child Order Item object.

Account

The account object stores information about the companies that you do business with and is also used to track partners and competitors.

Parent Object

Address, Contact, CustomObject

Fields

The following table details the required and read-only fields for the account child object.

Table Required and Read-Only Fields for the Account Child Object

Field Name	Type
AccountId	Read-only

The following table details the pick map fields for the account child object.

Table Pick Map Fields for the Account Child Object

Pick Map Field	Maps To
ExternalSystemId	AccountId

The following table provides a list of the user key combinations for the account child object.

Table User Key Fields on the Account Child Object

User Key Field Combinations
AccountId
ExternalSystemId
Name and Location

The following table details the picklists available for the account child object.

Table Picklists Available for the Account Child Object

Field Name
Call Frequency
Route
Status
Type

Account Contact

The account contact object stores information about the contacts associated with an account.

Parent Object

Account

Fields

The following table details the required and read-only fields for the account contact child object.

Table Required and Read-Only Fields for the Account Contact Child Object

Field Name	Type
AccountLocation	Read-only
AccountMainPhone	Read-only
AccountType	Read-only

The following table details the pick map fields for the account contact child object.

Table Pick Map Fields for the Account Contact Child Object

Pick Map Field	Maps To
AccountExternalSystemId	AccountId
AccountName	AccountId
ContactExternalSystemId	ContactId
ContactFullName	ContactId
ContactLastName	ContactFirstName
ContactLastName	ContactId

The following table provides a list of the user key combinations for the account contact child object.

Table User Key Fields on the Account Contact Child Object

User Key Field Combinations
AccountId
AccountExternalSystemId
AccountLocation and AccountName
ContactExternalSystemId
ContactFirstName and ContactLastName

The following table details the picklists available for the account contact child object.

Table Picklists Available for the Account Contact Child Object

Field Name
Role

Account Opportunity

The opportunity object allows employees to identify and record a potential revenue-generating event that has arisen with an account or contact. Opportunities can be generated from marketing campaigns when leads indicate that they are interested in a product or service that has been offered.

Parent Object

Account

Fields

The following table details the required and read-only fields for the account opportunity child object.

Table Required and Read-Only Fields for the Account Opportunity Child Object

Field Name	Type
OwnerFullName	Read-only
PrimaryRevenueExpectedValue	Read-only
CreatedbyEmailAddress	Read-only
ModifiedbyEmailAddress	Read-only
FuriganaAccountName	Read-only
NameShadow	Read-only
AssignmentStatus	Read-only
LastAssignmentCompletionDate	Read-only
LastAssignmentSubmissionDate	Read-only

The following table details the pick map fields for the account opportunity child object.

Table Pick Map Fields for the Account Opportunity Child Object

Pick Map Field	Maps To
AccountIntegrationId	AccountId
AccountExternalId	AccountId
AccountLocation	AccountId
Account	AccountId
SourceCampaignExternalId	CampaignId
SourceCampaign	CampaignId
KeyContactExternalId	KeyContactId
KeyContactLastName	KeyContactId
DealerExternalId	DealerId
OwnerAlias	OwnerId
CustomObject1Name	CustomObject1Id
CustomObject2Name	CustomObject2Id
CustomObject3Name	CustomObject3Id

The following table provides a list of the user key combinations for the account opportunity child object.

Table User Key Fields on the Account Opportunity Child Object

User Key Field Combinations
OpportunityId
Id

Activity

The activity object stores information on an activity that a user must carry out, for example, a callback activity for an account.

For activity child objects of Custom Object 01 through Custom Object 03, you can use the Activity field to query for tasks and appointments. The field can have the value Task or Appointment.

Parent Objects

Account, Campaign, Contact, CustomObject, Household, Lead, Opportunity, Service Request.

Fields

The following table details the required and read-only fields for the activity child object.

Table Required and Read-Only Fields for the Activity Child Object

Field Name	Type
AccountLocation	Read-only
CreatedDetail	Read-only
MEEventName	Read-only
CreatedbyEmailAddress	Read-only
ModifiedbyEmailAddress	Read-only
DescriptionShadow	Read-only
DealerName	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the activity child object.

Table Pick Map Fields for the Activity Child Object

Pick Map Field	Maps To
AccountIntegrationId	AccountId
AccountExternalId	AccountId
CampaignExternalId	CampaignId
CampaignIntegrationId	CampaignId
DelegatedBy	DelegatedById
FundRequest	FundRequestId
OpportunityIntegrationId	OpportunityId
OpportunityExternalId	OpportunityId
PrimaryContactIntegrationId	PrimaryContactId
PrimaryContactExternalId	PrimaryContactId
LeadIntegrationId	LeadId
LeadExternalId	LeadId
OwnerExternalId	OwnerId
OwnerIntegrationId	OwnerId
SRIntegrationId	SRId
SRExternalId	SRId
CustomObject1Name	CustomObject1Id
CustomObject2Name	CustomObject2Id
CustomObject3Name	CustomObject3Id

The following table provides a list of the user key combinations for the activity child object.

Table User Key Fields on the Activity Child Object

User Key Field Combinations
Id
ExternalSystemId
Description

Address

The address child object stores information on the different addresses that are associated with accounts and contacts.

This child object is applicable for companies that do not have the Enable Shared Addresses check box selected on the company profile. In this case, address information is not shared between any records, and the address information in each record is specific to each record.

When Enable Shared Addresses is selected, the address child object, (<ListOfAddress>) cannot be used, and instead the shared address child object (<ListOfSharedAddress>) must be used to associate or dissociate addresses and flag addresses as billing, shipping, or primary addresses. For more information about the shared address child object, see Shared Address. To create and update shared addresses, the top-level Address Web service must be used. For more information, see Address.

When Enable Shared Addresses is deselected, the shared address child object cannot be used as addresses are not being shared. Instead, the address child object is used for address operations. See the following table which shows the usage of address child objects and fields depending on whether addresses are shared. For more information about address operations, see Adding and Updating Account Addresses, and Adding and Updating Contact Addresses.

For information about converting unshared addresses to shared addresses using UI export functionality and Web services calls, see Converting Unshared Addresses to Shared Addresses.

Table Usage of Address Child Objects and Fields Depending on Whether Enable Shared Addresses is Selected

Enable Shared Addresses check box on company profile

ListOfAddress (address as child object)

ListOfSharedAddress (shared address as child object)

Denormalised address fields in parent object (PrimaryBillToCity, PrimaryShipToCity and so on)

Address Id fields in parent object (PrimaryBillToAddressId, PrimaryShipToAddressId, AlternateAddressId)

Selected - addresses are shared.

Cannot be used to create, update, or delete the addresses as addresses are being shared, but can be used for query operations.

Can be used only to associate or dissociate an address from parent.

Addresses cannot be created, deleted, or updated using this child object. The top-level Address Web service must be used, see Address.

Cannot be used because addresses are being shared.

To create and update addresses, the top-level Address Web service must be used. see Address.

Can be used to associate a billing/shipping/primary address to the account, contact, dealer, partner objects.Billing/shipping/primary fields in ListOfSharedAddress can also be used for the same purpose.

Deselected - addresses are not being shared.

Can be used to create, update, delete, and read addresses.

Partial update allowed - can be used only to edit the intersection object fields other than AddressId, billing/shipping/primary flag fields. Changing the address association or address flags is not allowed but any other fields (for example, custom fields on the account address object) can be updated.

Create or delete is not allowed and change in address association is not allowed, but query operations are not restricted.

Can be used.

Usage is as described in Adding and Updating Account Addresses.

Parent Objects

Fields

The following table details the required and read-only fields for the address child object.

Table Required and Read-Only Fields for the Address Child Object

Field Name	Type
AddressId	Read-only
GeocodeMatchCode	Read-only
GeocodeMatchVector	Read-only
GeocodeStatus	Read-only

The following table details the pick map fields for the address child object.

Table Pick Map Fields for the Address Child Object

Pick Map Field	Maps To
None

The following table provides a list of the user key combinations for the address child object.

Table User Key Fields on the Address Child Object

User Key Field Combinations
AddressId
ExternalId

Asset

The asset object stores information on the assets held by your accounts, for example, the products that an account has purchased.

Parent Object

Account, CustomObject

Fields

The following table details the required and read-only fields for the asset child object.

Table Required and Read-Only Fields for the Asset Child Object

Field Name	Type
AssetId	Required
ContactAssetId	Read-only
ExternalSystemId	Read-only
Product	Read-only
ProductId	Read-only
ProductPartNumber	Read-only
ProductType	Read-only
ProductStatus	Read-only
CreatedByandDate	Read-only
ModifiedByandDate	Read-only
SerialNumber	Read-only

The following table details the pick map fields for the asset child object.

Table Pick Map Fields for the Asset Child Object

Pick Map Field	Maps To
AccountIntegrationId	AccountId
Manufacturer	ManufacturerId
PreferredServiceDealer	PreferredServiceDealerID

The following table provides a list of the user key combinations for the asset child object.

Table User Key Fields on the Asset Child Object

User Key Field Combinations
AssetId
ExternalSystemId

Assigned Books

The assigned books object stores information about the books assigned to a user.

Parent Object

Fields

The following table details the required and read-only fields for the assigned books child object.

Table Required and Read-Only Fields for the Assigned Books Child Object

Field Name	Type
BookName	Required
BookId	Read-only
ModId	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the assigned books child object.

Table Pick Map Fields for the Assigned Books Child Object

Pick Map Field	Maps To
BookName	BookId

The following table provides a list of the user key combinations for the assigned books child object.

Table User Key Fields on the Assigned Books Child Object

User Key Field Combinations
BookId
BookName

Attachment

The attachment object stores information about a file or URL that is attached to a record in Oracle CRM On Demand.

Parent Objects

Account, Accreditation, Activity, Campaign, Certification, Contact, Course, CustomObject, Dealer, Event, Exam, Lead, Opportunity, Service Request, and Solution.

Fields

The following table details the required and read-only fields for the attachment object.

Table Required and Read-Only Fields for the Attachment Child Object

Field Name	Type
DisplayFileName	Required
FileNameOrURL	Required
FileDate	Read-only
FileSize	Read-only
AttachmentTag	Read-only (accessible for the Attachment child of Account and Contact only)
<parent_object>Id	Read-only
Id	Read-only
ModId	Read-only
Audit Fields	Read-only

The following table provides a list of the user key combinations for the attachment child object.

Table User Key Fields on the Attachment Child Object

User Key Field Combinations
Id
ExternalSystemId
FileNameOrURL and FileExtension

Attendee Call

The attendee call object stores information about an individual call associated with an account call.

Parent Object

Fields

The following table details the required and read-only fields for the attendee call child object.

Table Required and Read-Only Fields for the Attendee Call Child Object

Field Name	Type
Subject	Required
PrimaryContact	Required
Audit Fields	Read-only

The following table details the pick map fields for the attendee call child object.

Table Pick Map Fields for the Attendee Call Child Object

Pick Map Field	Maps To
AddressName	AddressNameId
Address	AddressId
AddressExternalSystemId	AddressId
ApplicationCompanyName	ApplicationUID
ApplicationExternalSystemId	ApplicationCompanyName
BookName	BookId
BusinessPlanExternalSystemId	BusinessPlanPlanName
CampaignName	CampaignId
CampaignExternalId	CampaignId
ClaimExternalSystemId	ClaimNumber
CustomObjectn Name	CustomObjectn Id
CustomObjectn ExternalSystemId	CustomObjectn Id
DealerName	DealerId
DealerExternalId	DealerId
DelegatedBy	DelegatedById
DelegatedByExternalSystemId	DelegatedById
DelegatedByExternalSystemId	DelegatedByFirstName
DelegatedByExternalSystemId	DelegatedByLastName
DealRegistrationName	DealRegistrationId
DealRegistrationName	DealRegistrationExternalSystemId
FinancialAccountExternalSystemId	FinancialAccountFinancialAccount
FinancialPlanExternalSystemId	FinancialPlanFinancialPlan
FundRequest	FundRequestId
Lead	LeadId
LeadIntegrationId	LeadId
LeadExternalSystemId	LeadId
LeadExternalSystemId	LeadFirstName
LeadExternalSystemId	LeadLastName
MDFRequestExternalSystemId	MDFRequestName
MEEventName	MEEventId
ObjectiveExternalSystemId	ObjectiveName
OpportunityName	OpportunityId
OpportunityIntegrationId	OpportunityId
OpportunityExternalId	OpportunityId
OpportunityExternalId	OpportunityName
Alias	OwnerId
PolicyExternalSystemId	PolicyNumber
PortfolioNumber	PortfolioId
PortfolioExternalId	PortfolioId
PrimaryContact	PrimaryContactId
PrimaryContactExternalId	PrimaryContactId
PrimaryContactExternalId	PrimaryContactFirstName
PrimaryContactExternalId	PrimaryContactLastName
Alias	PrimaryOwnerId
ServiceRequestNumber	ServiceRequestId
ServiceRequestExternalSystemId	ServiceRequestId
ServiceRequestExternalSystemId	ServiceRequestNumber
SPRequestExternalSystemId	SPREquestName

The following table provides a list of the user key combinations for the attendee call child object.

Table User Key Fields on the Attendee Call Child Object

User Key Field Combinations
Id
PrimaryContactId
PrimaryContact
PrimaryContactExternalId

The following table provides a list of the picklists for the attendee call child object.

Table Picklists for the Attendee Call Child Object

Field Name
Priority
ApprovalStatus
RejectReason
SubType
Type
CurrencyCode
CallResult
Status
ResolutionCode

Audit Trail

For parent objects that support audit trails, you can use the QueryPage method to access the audit trail information for the object.

The audit trail child object stores information, such as the old and new values in a modified field, as well as the timestamp and the name of the user who made the change to the field.

Other fields, similar to the audit fields returned for record type objects are also returned for each audit trail child. For more information, see Audit Fields.

For more information about audit trails, see Oracle CRM On Demand Online Help.

Parent Objects

Account, Accreditation, Activity, Address, Allocation, Application, Asset, Business Plan, Campaign, Certification, Claim, Contact, Contact State License, Course. Coverage, CustomObject, Damage, Deal Registration, Division, Event, Exam, Financial Account, Financial Account Holder, Financial Account Holding, Financial Plan, Financial Product, Financial Transaction, Fund, HCP Contact Allocation, Household, Insurance Property, Inventory Audit Report, Inventory Period, Involved Party, Lead, MDF Request, Messaging Plan, Messaging Plan Item, Messaging Plan Item Relation, Objective, Opportunity, Order, Partner, Plan Account, Plan Contact, Plan Opportunity, Policy, Policy Holder, Portfolio, Product Indication, Sample Disclaimer, Sample Lot, Sample Request, Service Request, Sample Transaction, Signature, Social Media, Social Profile, Solution, Special Pricing Request, User, Vehicle.

Book

The book object provides a way of segmenting data according to the organizational units of your business, such as territories or products. Administrators can create book hierarchies based on how they want to organize your information, and then set up users to have the appropriate level of access to books.

Fields

The following table details the required and read-only fields for the book child object.

Table Required and Read-Only Fields for the Book Child Object

Field Name	Type
BookName	Required
BookId	Read-only
SystemAssociateFlag	Read-only
ModId	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the book child object.

Table Pick Map Fields for the Book Child Object

Pick Map Field	Maps To
BookName	BookId

The following table provides a list of the user key combinations for the book child object.

Table User Key Fields on the Book Child Object

User Key Field Combinations
BookId
BookName

Book User

The book user object stores information about a book user.

Parent Object

Fields

The following table details the required and read-only fields for the book user child object.

Table Required and Read-Only Fields for the Book User Child Object

Field Name	Type
AccessProfileName	Required
UserAlias	Required
UserFirstName	Read-only
UserLastName	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the book user child object.

Table Pick Map Fields for the Book User Child Object

Pick Map Field	Maps To
BookExternalSystemId	BookId
UserAlias	UserId
UserEMailAddr	UserId
UserExternalSystemId	UserId
UserSignInId	UserId

The following table provides a list of the user key combinations for the book user child object.

Table User Key Fields on the Book User Child Object

User Key Field Combinations
Id
UserId
UserAlias
UserExternalSystemId

The following table provides a list of the picklists for the book user child object.

Table Picklists for the Book User Child Object

Field Name
BookRole

Campaign

The campaign object stores information on the recipients of campaigns.

Parent Object

Contact, Event

Fields

The following table details the required and read-only fields for the campaign child object.

Table Required and Read-Only Fields for the Campaign Child Object

Field Name	Type
CampaignName	Read-only
CampaignContactId	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the campaign child object.

Table Pick Map Fields for the Campaign Child Object

Pick Map Field	Maps To
CampaignExternalSystemId	CampaignId
CampaignName	CampaignId

The following table provides a list of the user key combinations for the campaign child object.

Table User Key Fields on the Campaign Child Object

User Key Field Combinations
CampaignId
CampaignExternalId
CampaignName

The following table details the picklists available for the campaign child object.

Table Picklists Available for the Campaign Child Object

Field Name
DeliveryStatus
ResponseStatus

Competitor

The competitor object stores the information on competitors for your accounts and opportunities.

Note: This topic covers both the account competitor and opportunity competitor child objects. The Parent Object column in the tables in this topic indicates to which objects the information is applicable.

Parent Objects

Fields

The following table details the required and read-only fields for the competitor child object.

Table Required and Read-Only Fields for the Competitor Child Object

Field Name	Type	Parent Object
CompetitorId	Required	Both
StartDate	Required	Both

The following table details the pick map fields for the competitor child object.

Table Pick Map Fields for the Competitor Child Object

Pick Map Field	Maps To	Parent Object
CompetitorExternalId	CompetitorId	Both
CompetitorName	CompetitorId	Both
CompetitorFullName	CompetitorId	Both
CompetitorExternalId	AccountName	Opportunity
CompetitorName	AccountName	Opportunity

The following table provides a list of the user key combinations for the competitor child object.

Table User Key Fields on the Competitor Child Object

User Key Field Combinations	Parent Object
Id	Both
Role & ReverseRole & CompetitorId	Both
Role & ReverseRole & CompetitorExternalId	Both
Role & ReverseRole & CompetitorName	Opportunity
Role & ReverseRole & AccountName	Opportunity

The following table details the picklists available for the competitor child object.

Table Picklists Available for the Competitor Child Object

Field Name	Parent Object
ReverseRole	Both
Role	Both

Contact

The contact object stores information on individuals with whom your organization has a relationship. It allows the user to store information on individuals who are external to your company, but who are associated with the business process. Contacts stored in the Oracle CRM On Demand database can also be associated with an account.

Parent Objects

Activity, Address, Account, Campaign, CustomObject, Event, Household, Opportunity, Portfolio

Fields

The following table details the required and read-only fields for the contact child object.

Table Required and Read-Only Fields for the Contact Child Object

Field Name	Type
ContactId	Read-only
ContactFirstName	Read-only
ContactLastName	Read-only
ContactAccountId	Read-only
ContactAccountName	Read-only
ContactAccountLocation	Read-only
ContactAccountIntegrationId	Read-only
ContactAccountExternalSystemId	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the contact child object.

Table Pick Map Fields for the Contact Child Object

Pick Map Field	Maps To
ContactExternalId	ContactId
ContactIntegrationId	ContactId

The following table provides a list of the user key combinations for the contact child object.

Table User Key Fields on the Contact Child Object

User Key Field Combinations
ActivityContactId
ContactExternalId

Contact Role

The contact role object stores information on the different roles that a contact can hold within an account or opportunity.

Note: This topic covers both the account contact role and opportunity contact role child objects. The Parent Object column in the tables in this topic indicates to which objects the information is applicable.

Parent Objects

Fields

The following table details the required and read-only fields for the contact role child object.

Table Required and Read-Only Fields for the Contact Role Child Object

Field Name	Type	Parent Object
AccountId	Required	Both
ContactId	Required	Opportunity

The following table details the pick map fields for the contact role child object.

Table Pick Map Fields for the Contact Role Child Object

Pick Map Field	Maps To	Parent Object
AccountExternalSystemId	AccountId	Account
AccountName	AccountId	Account
ContactExternalSystemId	ContactId	Both
ContactLastName	ContactId	Opportunity
ContactExternalSystemId	ContactFirstName	Opportunity
ContactLastName	ContactFirstName	Opportunity
ContactExternalSystemId	ContactLastName	Opportunity

The following table provides a list of the user key combinations for the contact role child object.

Table User Key Fields on the Contact Role Child Object

User Key Field Combinations	Parent Object
Id	Account
Role, ContactId	Account
Role, ContactExternalSystemId	Account
Role, ContactFirstName, ContactLastName	Account
ContactExternalSystemId, BuyingRole	Opportunity
ContactFirstName, ContactLastName, BuyingRole	Opportunity

The following table details the picklists available for the contact role child object.

Table Picklists Available for the Contact Role Child Object

Field Name	Parent Object
Role	Account
BuyingRole	Opportunity

Custom Object 1 through 3

The custom objects 1, 2, and 3.

Parent Objects

Account, Activity, Address, Campaign, Contact, Lead, Message Response, Messaging Plan, Messaging Plan Item, Messaging Plan Item Relation, Opportunity, Service Request.

Fields

The following table details the required and read-only fields for the custom object child object.

Table Required and Read-Only Fields for the Custom Object Child Object

Field Name	Type
Name	Required
Id	Read-only

The following table provides a list of the user key combinations for the custom object child object.

Table User Key Fields on the Custom Object Child Object

User Key Field Combinations
Id
ExternalSystemId
Name

No pickmap or picklist fields are available.

Custom Object 4 through 15

The custom objects 4 through 15.

Parent Objects

All top-level objects.

Fields

The following table details the required and read-only fields for the custom object child object.

Table Required and Read-Only Fields for the Custom Object Child Object

Field Name	Type
Name	Required
Currency	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the custom object child object.

Table Pick Map Fields for the Custom Object Child Object

Pick Map Field	Maps To
Owner	OwnerId

The following table provides a list of the user key combinations for the custom object child object.

Table User Key Fields on the Custom Object Child Object

User Key Field Combinations
Id
ExternalSystemId

The following table details the picklists available for the custom object child object.

Table Picklists Available for the Custom Object Child Object

Field Name
Type

Custom Object 1 Child

The Custom Object 1 child object.

Parent Objects

Custom Object 1

Fields

The following table details the required and read-only fields for the Custom Object 1 child object.

Table Required and Read-Only Fields for the Custom Object 1 Child Object

Field Name	Type
Name	Required
Id	Read-only

The following table provides a list of the user key combinations for the Custom Object 1 child object.

Table User Key Fields on the Custom Object 1 Child Object

User Key Field Combinations
Id
ExternalSystemId
Name

No pickmap or picklist fields are available.

Custom Web Applet

For parent objects that support custom Web applets, you can use the QueryPage method to access the Detail page custom Web applets for the object. All custom Web applets enabled for the company can be returned regardless of whether they are enabled in the page layout for the record type.

The URL and HTML code in custom Web applets can contain field and function parameters that are evaluated at run time. The QueryPage method returns URL and HTML data with the evaluated fields and functions. This contrasts with the Administrative Web service methods, DetailPageCustomWebAppletRead and DetailPageCustomWebAppletReadAll, which do not return evaluated URLs or HTML data.

The following table shows the custom Web applet fields that are returned by the QueryPage method and whether they are filterable:

Table Custom Web Applet Fields

Field Name	Description	Filterable
Name	The language-independent name of the custom Web applet.	Yes
DisplayName	The display name of the Web applet in the language of the currently logged-in user.	Yes
Type	The type of Web applet: Feed, HTML, or URL.	Yes
URL	The evaluated URL for the Feed or URL type of Web applet.	No
HTMLHead	The evaluated HTML header code for the HTML type of Web applet.	No
HTMLBody	The evaluated HTML body code for the HTML type of Web applet.	No
Height	The height of the Web applet in pixels.	Yes

Other fields, similar to the audit fields returned for record type objects are also returned for each custom Web applet. For more information, see Audit Fields.

For more information about custom Web applets, see Oracle CRM On Demand Online Help.

Delegated User

The delegated user object stores information about a user who can impersonate another user. The delegated user is added so that he or she can access a user’s data, for example, when a person is on vacation or leaves the company.

Parent Object

Fields

The following table details the required and read-only fields for the delegated user child object.

Table Required and Read-Only Fields for the Delegated User Child Object

Field Name	Type
UserId	Required
UserRole	Required
Audit Fields	Read-only

The following table provides a list of the user key combinations for the delegated user child object.

Table User Key Fields on the Delegated User Child Object

User Key Field Combinations
Id
ExternalSystemId

The following table details the picklists available for the delegated user child object.

Table Picklists Available for the Delegated User Child Object

Field Name
UserRole

Exchange Rate History

The exchange rate history object stores historical information about exchange rates for the currencies used by a company.

Parent Object

Exchange Rate

Usage

The ExchangeRateHistory child object can be queried to give the history of exchange rates for the company.

Fields

The following table details the required and read-only fields for the exchange rate object.

Table Required and Read-Only Fields for the Exchange Rate History Object

Field Name	Type
FromCurrencyCode	Required
ToCurrencyCode	Required
ExchangeDate	Required
ExchangeRate	Required

The following table provides a list of the user key combinations for the exchange rate history object.

Table User Key Fields on the Exchange Rate History Object

User Key Field Combinations
FromCurrencyCode
ToCurrencyCode
ExchangeDate

Image

The image object stores an image that is displayed on detail pages for the Account, Contact, and Product record types. You can insert, update, query, and delete images using Web service calls.

An image can only be inserted when the Display Image check box on the Customize Record Types page is selected for the record type. An image cannot be inserted into an account that already has an associated image.

The maximum file size for an image is 5 MB, and the maximum dimensions are 150 pixels high and 150 pixels wide; larger images will be cropped to 150 x 150 pixels.

Supported image formats are: JPEG, JPG, BMP, PNG, and GIF. If you specify any other format, or a blank value for the <FileExtension> element, an error is returned.

Deleted images are not moved to the Deleted Items area, so they cannot be restored.

Parent Object

Account, Contact, Product

Fields

The following table details the required and read-only fields for the image child object.

Table Required and Read-Only Fields for the Image Child Object

Field Name	Type
Attachment	Required
DisplayFileName	Required
FileNameOrURL	Required
Audit Fields	Read-only

The following table provides a list of the user key combinations for the image child object.

Table User Key Fields on the Image Child Object

User Key Field Combinations
Id
ExternalSystemId
FileNameOrURL and FileExtension

Interests

The interests object stores information about things in which a contact is interested, such as products, services, or hobbies.

Parent Object

Fields

The following table details the required and read-only fields for the interests child object.

Table Required and Read-Only Fields for the Interests Child Object

Field Name	Type
Category	Required
Interests	Required
InterestId	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the interests child object.

Table Pick Map Fields for the Interests Child Object

Pick Map Field	Maps To
InterestExternalSystemId	InterestId

The following table provides a list of the user key combinations for the interests child object.

Table User Key Fields on the Interests Child Object

User Key Field Combinations
InterestId
ExternalSystemId

The following table details the picklists available for the interests child object.

Table Picklists Available for the Interests Child Object

Field Name
Category
Subjects

Invitee

The invitee object stores information about invitees to events, including feedback about the invitation.

Parent Object

Event

Fields

The following table details the required and read-only fields for the invitee child object.

Table Required and Read-Only Fields for the Invitee Child Object

Field Name	Type
ContactFullName	Required
InviteeStatus	Required
InviteeId	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the invitee child object.

Table Pick Map Fields for the Invitee Child Object

Pick Map Field	Maps To
InviteeExternalSystemId	InviteeId

The following table provides a list of the user key combinations for the invitee child object.

Table User Key Fields on the Invitee Child Object

User Key Field Combinations
ContactIdExternalId
InviteeId

The following table details the picklists available for the invitee child object.

Table Picklists Available for the Invitee Child Object

Field Name
InviteeStatus

Lead

The lead object stores information on a company or individual with whom an opportunity can be created. It allows the user to identify the companies that might be interested in a product or service. Leads are usually generated as part of a marketing campaign.

Parent Objects

Account, Campaign, Contact, Household, Opportunity

Fields

The following table details the required and read-only fields for the lead child object.

Table Required and Read-Only Fields for the Lead Child Object

Field Name	Type
OwnerFullName	Read-only
SalesRepFullName	Read-only
CreatedbyEmailAddress	Read-only
ModifiedbyEmailAddress	Read-only
ReferredByFullName	Read-only
FuriganaAccountName	Read-only
FuriganaContactFirstName	Read-only
FuriganaContactLastName	Read-only
FirstNameShadow	Read-only
LastNameShadow	Read-only
CompanyNameShadow	Read-only
AssignmentStatus	Read-only
LastAssignmentCompletionDate	Read-only
LastAssignmentSubmissionDate	Read-only

The following table details the pick map fields for the lead child object.

Table Pick Map Fields for the Lead Child Object

Pick Map Field	Maps To
AccountIntegrationId	AccountId
AccountExternalId	AccountId
AccountLocation	AccountId
AccountName	AccountId
CampaignExternalId	CampaignId
CampaignIntegrationId	CampaignId
CampaignName	CampaignId
ContactExternalId	ContactId
ContactIntegrationId	ContactId
OpportunityIntegrationId	OpportunityId
OpportunityExternalId	OpportunityId
OwnerExternalId	OwnerId
OwnerIntegrationId	OwnerId
SalesRepAlias	SalesRepId
CustomObject1Name	CustomObject1Id
CustomObject2Name	CustomObject2Id
CustomObject3Name	CustomObject3Id

The following table provides a list of the user key combinations for the lead child object.

Table User Key Fields on the Lead Child Object

User Key Field Combinations
LeadId
Id

Note

The note object stores information about the notes available in the Message Center in the Oracle CRM On Demand application.

Usage

Users who have the View Private Notes privilege enabled in their user role can make Web Service calls to read all child-level private notes, regardless of the owner of the note. Private notes are those that have the Private check box selected in the UI. You can read the child-level notes only using a parent object’s QueryPage operation (for example, ContactQueryPage). The notes are retrieved through the <ListOfNote> element.

The View Private Notes privilege does not allow a user to update or delete a note that is owned by another user. Typically, the View Private Notes privilege is given to company administrators only

Note: For insert requests, if you include HTML code in the Description field, you must enclose the HTML code in a CDATA section. Any unsupported elements are removed from the HTML. Refer to Oracle CRM On Demand Online Help for a list of the HTML elements that are allowed in the Description field.

Parent Objects

Account, Campaign, Contact, CustomObject, Household, Opportunity, Service Request

Fields

The following table details the required and read-only fields for the note child object.

Table Required and Read-Only Fields for the Note Child Object

Field Name	Type
Subject	Required
NoteId	Read-only
Audit Fields	Read-only

The following table provides a list of the user key combinations for the note child object.

Table User Key Fields on the Note Child Object

User Key Field Combinations
NoteId

Opportunity

The opportunity object allows employees to identify and record a potential revenue-generating event that has arisen with an account or contact. Opportunities can be generated from marketing campaigns when leads indicate that they are interested in a product or service that has been offered.

Parent Object

Contact, CustomObject, Household, Partner

Fields

The following table details the required and read-only fields for the opportunity child object.

Table Required and Read-Only Fields for the Opportunity Child Object

Field Name	Type
OpportunityName	Required
CloseDate	Required

The following table provides a list of the user key combinations for the opportunity child object.

Table User Key Fields on the Opportunity Child Object

User Key Field Combinations
Id
ExternalSystemId
OpportunityName

Opportunity Child

The opportunity child object is the child of a parent opportunity in an opportunity hierarchy. Such hierarchies are used for sales opportunities that have multiple components.

The same fields are accessible for the opportunity child object as for the opportunity parent object.

For more information about opportunity hierarchies, see Oracle CRM On Demand Online Help.

Parent Object

Opportunity

Products Detailed

The products detailed object stores the information on product details for an activity. This is used, for example, to record information about products discussed on sales calls to customers.

Usage

Product blocking rules are respected for this object. A blocked product is a product for which your company does not want users to provide any product information, samples, or promotional items for that product to the associated contact.

Web service requests cannot insert, update, or delete records for this object if the product specified in the request is a blocked product. An error message is generated when such a request is made. For more information about blocked products, see Oracle CRM On Demand Online Help and Blocked Product.

You can access call objective, outcome, and next call objective records associated to the ProductID of a products detailed record through a Web services call. For more information about these structured product messaging record types, see Oracle CRM On Demand Online Help.

In the Oracle CRM On Demand UI, if the company administrator has selected the Enable Filtering of Product Selection by Sales Rep Allocation check box, then for products detailed only the products that are allocated to the sales representative appear in the Product selector. However, in Web service calls it is possible to specify a product of any type regardless of whether the check box is selected. Be aware that it is your responsibility to validate data before making Web service calls. For more information about filtering of product selection by sales representative allocation, see Oracle CRM On Demand Online Help.

Parent Object

Fields

The following table details the required and read-only fields for the products detailed child object.

Table Required and Read-Only Fields for the Products Detailed Child Object

Field Name	Type
ProductId	Required
Indication	Required
ProductDetailedId	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the products detailed child object.

Table Pick Map Fields for the Products Detailed Child Object

Pick Map Field	Maps To
ProductExternalSystemId	ProductId
ProductIntegrationId	ProductId

The following table provides a list of the user key combinations for the products detailed child object.

Table User Key Fields on the Products Detailed Child Object

User Key Field Combinations
ProductDetailedId
ProductDetailedExternalSytemId
ProductExternalSytemId
ProductId
ProductExternalSytemId
Name
Indication

Promotional Items Dropped

The promotional items dropped object stores the information on promotional items dropped for an activity.

Usage

Product blocking rules are respected for this object. A blocked product is a product for which your company does not want users to provide any product information, samples, or promotional items for that product to the associated contact.

Web service requests cannot insert, update, or delete records for this object if the product specified in the request is a blocked product. An error message is generated when such a request is made. For more information about blocked products, see Oracle CRM On Demand Online Help and Blocked Product.

In the Oracle CRM On Demand UI, if the company administrator has selected the Enable Filtering of Product Selection by Sales Rep Allocation check box, then for promotional items dropped only the products that are allocated to the sales representative appear in the Product selector. However, in Web service calls it is possible to specify a product of any type regardless of whether the check box is selected. Be aware that it is your responsibility to validate data before making Web service calls. For more information about filtering of product selection by sales representative allocation, see Oracle CRM On Demand Online Help.

Parent Object

Fields

The following table details the required and read-only fields for the promotional items dropped child object.

Table Required and Read-Only Fields for the Promotional Items Dropped Child Object

Field Name	Type
ProductName	Required
Quantity	Required
ProductAllocationId	Required
Audit Fields	Read-only

The following table details the pick map fields for the promotional items dropped child object.

Table Pick Map Fields for the Promotional Items Dropped Child Object

Pick Map Field	Maps To
ProductName	ProductId
ProductExternalSystemId	ProductId
ProductIntegrationId	ProductId

The following table provides a list of the user key combinations for the promotional items dropped child object.

Table User Key Fields on the Promotional Items Dropped Child Object

User Key Field Combinations
Id

Recipient

The recipient object stores information about a recipient associated with a campaign.

Parent Object

Campaign

Fields

The following table details the required and read-only fields for the recipient child object.

Table Required and Read-Only Fields for the Recipient Child Object

Field Name	Type
ContactId	Required
ModifiedDate	Read-only

The following table provides a list of the user key combinations for the recipient child object.

Table User Key Fields on the Recipient Child Object

User Key Field Combinations
None

Related Contact

The related contact object stores information about a contact that has a relationship with the parent contact in question. The details of the related contact child object are inherited from a particular contact parent object.

Parent Object

Fields

The following table details the required and read-only fields for the related contact child object.

Table Required and Read-Only Fields for the Related Contact Child Object

Field Name	Type
ContactRelationshipId	Read-only
ContactId	Read-only
RelatedContactFirstName	Read-only
RelatedContactLastName	Read-only

The following table details the pick map fields for the related contact child object.

Table Pick Map Fields for the Related Contact Child Object

Pick Map Field	Maps To
RelatedContactExternalId	RelatedContactId
RelatedContactIntegrationId	RelatedContactId

The following table provides a list of the user key combinations for the related contact child object.

Table User Key Fields on the Related Contact Child Object

User Key Field Combinations
None

The following table details the picklists available for the related contact child object.

Table Picklists Available for the Related Contact Child Object

Field Name
Relationship
Status

Revenue

The revenue object stores monetary information about accounts, contacts, and their associated opportunities. This includes information on the revenue available, expected revenue, and also information about the products associated with the accounts, contacts, opportunities, and so on.

Note: The Revenue child object of Opportunity is actually called Product.

Parent Objects

Account, Contact, Opportunity

Fields

The following table details the required and read-only fields for the revenue child object.

Table Required and Read-Only Fields for the Revenue Child Object

Field Name	Type
RevenueId	Required
PartNumber	Required
Revenue	Required
ContactFullName	Required
Audit Fields	Read-only

The following table details the pick map fields for the revenue child object.

Table Pick Map Fields for the Revenue Child Object

Pick Map Field	Maps To
Product	ProductId
ProductExternalId	ProductId
ProductIntegrationId	ProductId
ProductCategory	ProductCategoryId
ProductCategoryExternalId	ProductCategoryId
ProductCategoryIntegrationId	ProductCategoryId

The following table provides a list of the user key combinations for the revenue child object.

Table User Key Fields on the Revenue Child Object

User Key Field Combinations
RevenueId
ProductId
ProductExternalId

The following table details the picklists available for the revenue child object.

Table Picklists Available for the Revenue Child Object

Field Name
Type
Status
Frequency

Sales Assessment

The sales assessment object stores information about a sales assessment script associated with an account, activity, business plan, contact, or objective.

Parent Objects

Account, Activity, Business Plan, Contact, Objective, Opportunity, Service Request.

Fields

The following table details the required and read-only fields for the sales assessment child object.

Note: Only one of the fields TemplateId or Name is required.

Table Required and Read-Only Fields for the Sales Assessment Child Object

Field Name	Type
TemplateId	Required
Name	Required
Audit Fields	Read-only

The following table provides a list of the user key combinations for the sales assessment child object.

Table User Key Fields on the Sales Assessment Child Object

User Key Field Combinations
Name
TemplateId

Sales Assessment Value

The sales assessment value object stores information about the responses for a sales assessment script associated with the parent object, that is, the values related to the sales assessment child object.

Parent Objects

Account, Activity, Business Plan, Contact, Objective, Opportunity, Service Request.

Fields

The following table details the required and read-only fields for the sales assessment value child object.

Table Required and Read-Only Fields for the Sales Assessment Value Child Object

Field Name	Type
AssessId	Required
AttribId	Required
Audit Fields	Read-only

The following table provides a list of the user key combinations for the sales assessment value child object.

Table User Key Fields on the Sales Assessment Value Child Object

User Key Field Combinations
AssessId
AttribId

Sample Dropped

The sample dropped object stores the information on samples for an activity. This is used, for example, to record information about samples left with the customer on sales calls to customers.

Usage

Product blocking rules are respected for this object. A blocked product is a product for which your company does not want users to provide any product information, samples, or promotional items for that product to the associated contact.

Web service requests cannot insert, update, or delete records for this object if the product specified in the request is a blocked product. An error message is generated when such a request is made. For more information about blocked products, see Oracle CRM On Demand Online Help and Blocked Product.

In the Oracle CRM On Demand UI, if the company administrator has selected the Enable Filtering of Product Selection by Sales Rep Allocation check box, then for samples dropped only the products that are allocated to the sales representative appear in the Product selector. However, in Web service calls it is possible to specify a product of any type regardless of whether the check box is selected. Be aware that it is your responsibility to validate data before making Web service calls. For more information about filtering of product selection by sales representative allocation, see Oracle CRM On Demand Online Help.

Parent Object

Fields

The following table details the required and read-only fields for the sample dropped child object.

Table Required and Read-Only Fields for the Sample Dropped Child Object

Field Name	Type
ProductId	Required
Quantity	Required
Id	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the sample dropped child object.

Table Pick Map Fields for the Sample Dropped Child Object

Pick Map Field	Maps To
ProductName	ProductId
ProductExternalSystemId	ProductId
ProductIntegrationId	ProductId

The following table provides a list of the user key combinations for the sample dropped child object.

Table User Key Fields on the Sample Dropped Child Object

User Key Field Combinations
Id
SampleDroppedExternalSystemId

Service Request

The service request object allows customers to request information or assistance with a problem related to products or services purchased from your company. Service requests can be ranked for severity and prioritized accordingly.

Parent Objects

Account, Contact, Household, Opportunity, Solution

Fields

The following table details the required and read-only fields for the service request child object.

Table Required and Read-Only Fields for the Service Request Child Object

Field Name	Type
Name	Read-only
OwnerFullName	Read-only
CreatedbyEmailAddress	Read-only
ModifiedbyEmailAddress	Read-only
LastAssessmentDate	Read-only
AssignmentStatus	Read-only
FuriganaAccountName	Read-only
FuriganaContactFirstName	Read-only
FuriganaContactLastName	Read-only
SRNumberShadow	Read-only
AbstractShadow	Read-only
LastAssignmentCompletionDate	Read-only
LastAssignmentSubmissionDate	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the service request child object.

Table Pick Map Fields for the Service Request Child Object

Pick Map Field	Maps To
AccountIntegrationId	AccountId
AccountExternalId	AccountId
AccountLocation	AccountId
Account	AccountId
AssetExternalId	AssetId
Dealer	DealerId
ContactExternalId	ContactId
ContactIntegrationId	ContactId
DealerExternalId	DealerId
OwnerExternalId	OwnerId
OwnerIntegrationId	OwnerId
OwnerAlias	OwnerId
Product	ProductId
CustomObject1Name	CustomObject1Id
CustomObject2Name	CustomObject2Id
CustomObject3Name	CustomObject3Id

The following table provides a list of the user key combinations for the service request child object.

Table User Key Fields on the Service Request Child Object

User Key Field Combinations
ServiceRequestId
Id

Shared Address

The shared address child object stores information on the addresses that can be shared between accounts, contacts, partners, and dealers.

This child object is applicable only for companies that have the Enable Shared Addresses check box selected on the company profile. In this case, addresses can be associated with multiple account, contact, dealer, or partner records.

When a child shared address is inserted, it can be flagged as a billing address or shipping address for accounts, dealers, and partners, or as a primary contact address for contacts. When this occurs, the billing, shipping, or primary contact fields in the parent object are populated from the shared address fields.

You cannot delete a shared address child object directly, it can only be dissociated through the parent-level shared address object. For more information, see Address. For more information about the shared address functionality, see Oracle CRM On Demand Online Help.

When Enable Shared Addresses is deselected, the shared address child object cannot be used, because addresses are not being shared. Instead, the address child object is used for address operations. For information about the address child object, see Address. See the following table for information about the usage of address child objects and fields depending on whether addresses are shared. For information about converting unshared addresses to shared addresses using UI export functionality and Web services calls, see Converting Unshared Addresses to Shared Addresses.

Table Usage of Address Child Objects and Fields Depending on Whether Enable Shared Addresses is Selected

Enable Shared Addresses check box on company profile

ListOfAddress (address as child object)

ListOfSharedAddress (shared address as child object)

Denormalised address fields in parent object (PrimaryBillToCity, PrimaryShipToCity and so on)

Address Id fields in parent object (PrimaryBillToAddressId, PrimaryShipToAddressId, AlternateAddressId)

Selected - addresses are shared.

Cannot be used to create, update, or delete the addresses as addresses are being shared, but can be used for query operations.

Can be used only to associate or dissociate an address from parent.

Addresses cannot be created, deleted, or updated using this child object. The top-level Address Web service must be used, see Address.

Cannot be used because addresses are being shared.

To create and update addresses, the top-level Address Web service must be used. see Address.

Can be used to associate a billing/shipping/primary address to the account, contact, dealer, partner objects.Billing/shipping/primary fields in ListOfSharedAddress can also be used for the same purpose.

Deselected - addresses are not being shared.

Can be used to create, update, delete, and read addresses.

Partial update allowed - can be used only to edit the intersection object fields other than AddressId, billing/shipping/primary flag fields. Changing address association or address flags is not allowed but any other fields (for example, custom fields on the account address object) can be updated.

Create or delete and change in address association are not allowed, but query operations are not restricted.

Can be used.

Usage is as described in Adding and Updating Account Addresses.

Parent Objects

Account, Contact, Dealer, Partner

Fields

The following table details the required and read-only fields for the shared address child object.

Table Required and Read-Only Fields for the Shared Address Child Object

Field Name	Type
AddressId	Read-only

The following table details the pick map fields for the shared address child object.

Table Pick Map Fields for the Shared Address Child Object

Pick Map Field	Maps To
AddressName	AddressId
AddressExternalSystemId	AddressId

The following table provides a list of the user key combinations for the shared address child object.

Table User Key Fields on the Shared Address Child Object

User Key Field Combinations
Id
AddressId
AddressName
AddressExternalSystemId

The following table details the picklists available for the shared address child object.

Table Picklists Available for the Shared Address Child Object

Field Name
AddressType
CurrencyCode

Subbook

The subbook object stores information about a subbook.

Usage

After a partner has been associated with a subbook through the PartnerId field, the association cannot be changed.

Parent Object

Fields

The following table details the required and read-only fields for the subbook child object.

Table Required and Read-Only Fields for the Subbook Child Object

Field Name	Type
BookName	Required
Audit Fields	Read-only

The following table details the pick map fields for the subbook child object.

Table Pick Map Fields for the Subbook Child Object

Pick Map Field	Maps To
ParentBookName	ParentBookId

The following table provides a list of the user key combinations for the subbook child object.

Table User Key Fields on the Subbook Child Object

User Key Field Combinations
Id
BookName

Team

The team object stores information on the team that is assigned to a particular record type. In this way, a team of employees can, for example, be dedicated to an account or contact, ensuring that the activities, service requests, leads, and opportunities surrounding that account or contact are always kept up-to-date and are attended to regularly.

Fields

The following table details the required and read-only fields for the team child object.

Table Required and Read-Only Fields for the Team Child Object

Field Name	Type
record_typeAccess	Required
UserId	Required
LoginName	Read-only
UserFirstName	Read-only

The following table details the pick map fields for the team child object.

Table Pick Map Fields for the Team Child Object

Pick Map Field	Maps To
UserLastName	UserFirstName
record_typeAccess	record_typeAccessId
UserAlias	UserId
UserEmail	UserId
UserExternalSystemId	UserId
FullName	UserId

The following table provides a list of the user key combinations for the team child object.

Table User Key Fields on the Team Child Object

User Key Field Combinations
UserId
UserExternalSystemId
UserEmail
UserAlias

The following table details the picklists available for the team child object.

Table Picklists Available for the Team Child Object

Field Name
TeamRole

User

The user object allows you to define and record details of all users in Oracle CRM On Demand, for example, name, position, contact details, manager, and so on.

Parent Object

Fields

The following table details the required and read-only fields for the user child object.

Table Required and Read-Only Fields for the User Child Object

Field Name	Type
UserId	Read-only
UserEmail	Read-only
UserFirstName	Read-only
UserLastName	Read-only
UserRole	Read-only
Audit Fields	Read-only

The following table details the pick map fields for the user child object.

Table Pick Map Fields for the User Child Object

Pick Map Field	Maps To
UserExternalId	UserId
UserIntegrationId	UserId

The following table provides a list of the user key combinations for the user child object.

Table User Key Fields on the User Child Object

User Key Field Combinations
UserId
UserExternalId

User Default Book Per Type

The user default book per type object stores information about the default book for a user for each record type. The record type is identified by the access object name.

Parent Object