Using Simplified SOAP Web Services

May 2015
Oracle Sales Cloud Using

Simplified SOAP Web Services
for Account, Household, and
Contact
Release 9
Copyright 2005, 2014 Oracle and/or its affiliates. All rights reserved.
This software and related documentation are provided under a license agreement containing restrictions on use
and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license
agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit,
distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering,
disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If you
find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf
of the U.S. Government, the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs
installed on the hardware, and/or documentation, delivered to U.S. Government end users are commercial
computer software pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental
regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any
operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be
subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S.
Government.
This software or hardware is developed for general use in a variety of information management applications. It is not
developed or intended for use in any inherently dangerous applications, including applications that may create a
risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to
take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation
and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous
applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their
respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used
under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD
logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a
registered trademark of The Open Group.
This software or hardware and documentation may provide access to or information on content, products, and
services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all
warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its
affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party
content, products, or services.
Documentation Accessibility
For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at
http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.
Access to Oracle Support
Oracle customers have access to electronic support through My Oracle Support. For information, visit
http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit
http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.
Contents
1 Introduction to Simplified Sales Cloud Web Services for Account,

Household, and Contact ................................................................................................ 9
Overview of Oracle Sales Cloud Web Services ............................................................ 9
Overview of Simplified SOAP Web Services .................................................................. 9
Understanding the Process Flow for Consuming a SOAP Web Service................... 10
Searching for Relevant Web Services Using the OER ................................................ 11
Accessing WSDL URL ...................................................................................................... 12
Determining Which Web service to Use to Implement Your Use Case ................... 12
Prototyping Payloads and Evaluating if a Web Service Meets Your Business
Requirements Using the Fusion Service Tester....................................................... 13
Prototyping Payloads and Evaluating Web Services Using the JDeveloper
HTTP Analyzer ............................................................................................................ 23
Prototyping Payloads and Evaluating Web Services Using Third Party Tools.... 24
How do I ? .............................................................................................................. 25
Managing Accounts Using the Simplified Sales Cloud Account Web Service
(AccountService)............................................................................................................ 25
Create an Account Programmatically Using createAccount........................... 25
Search for an Account Programmatically Using findAccount........................... 27
Update an Account and its Primary Address Programmatically Using
updateAccount ....................................................................................................... 28
Delete an Account Programmatically Using deleteAccount ............................ 29
Retrieve an Account Programmatically Using getAccount............................... 29
Merge an account Programmatically Using mergeAccount ............................ 30
Perform a Specific Operation (Create, Update, Delete, or Merge) on a List
of Accounts Using processAccount....................................................................... 31
Managing Contacts Using the Simplified Sales Cloud Contact Web Service
(ContactService) ............................................................................................................ 32
Create a Contact Programmatically Using createContact .............................. 32
Search for a Contact Programmatically Using findContact .............................. 35
Update a Contact and its Primary Address Programmatically Using
updateContact ........................................................................................................ 35
Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact
Contents
Delete a Contact Programmatically Using deleteContact ............................... 36

Retrieve a Contact Programmatically Using getContact .................................. 37
Merge a Contact Programmatically Using mergeContact ............................... 38
of Contacts Using processContact ........................................................................ 39
Managing Households Using the Simplified Sales Cloud Household Web
Service .............................................................................................................................. 39
Create a Household Programmatically Using createHousehold....................... 40
Search for a Household Programmatically Using findHousehold ...................... 41
Update a Household and its Primary Address Programmatically Using
updateHousehold..................................................................................................... 42
Delete a Household Programmatically Using deleteHousehold ........................ 43
Retrieve a Household Programmatically Using getHousehold........................... 44
Merge a Household Programmatically Using mergeHousehold ........................ 44
of Households Using processHousehold ................................................................ 45
Managing Addresses Using the Simplified Sales Cloud Address Web Service
(AddressService) ............................................................................................................. 46
Create an Address Programmatically Using createAddress .............................. 46
Search for an Address Programmatically Using findAddress .............................. 47
Update an Address and Address Purpose Programmatically Using
updateAddress ......................................................................................................... 48
Delete an Address Programmatically Using deleteAddress ............................... 50
Retrieve an Address Programmatically Using getAddress .................................. 51
Merge an Address Programmatically Using mergeAddress ............................... 51
Managing Relationships Using the Simplified Sales Cloud Relationship Web
Service .............................................................................................................................. 53
Create a Relationship Programmatically Using createRelationship.................. 53
Search for a Relationship Programmatically Using findRelationship ................. 55
Update a Relationship and its Primary Address Programmatically Using
updateRelationship .................................................................................................. 56
Merge a Relationship Programmatically Using mergeRelationship ................... 56
of Relationships Using processRelationship ........................................................... 58
Invoking A Simplified Web Service Using Web Service Proxy Clients ................ 59
Points to Consider While Designing Web Service Proxy Clients ................................ 59
Invoking A Simplified Web Service Using A Static Proxy ............................................ 60
Authentication ................................................................................................................ 64
4
4
Sales Cloud Account Simplified Web Services Interface.................................... 67
Introduction to Simplified Sales Cloud Web Services for Account, Household, and Contact
Overview of Oracle Sales Cloud Web Services
Operations ....................................................................................................................... 68
createAccount ......................................................................................................... 68
deleteAccount ......................................................................................................... 69
findAccount .............................................................................................................. 69
getAccount ............................................................................................................... 70
mergeAccount ......................................................................................................... 71
processAccount ....................................................................................................... 71
processCSAccount .................................................................................................. 72
updateAccount ....................................................................................................... 73
Sales Cloud Account SDO ............................................................................................. 74
Sales Cloud Contact Simplified Web Services Interface .................................... 95

Operations ....................................................................................................................... 96
getContact ............................................................................................................... 96
createContact ......................................................................................................... 97
updateContact ........................................................................................................ 97
deleteContact .......................................................................................................... 98
mergeContact.......................................................................................................... 99
findContact ............................................................................................................. 100
processContact ...................................................................................................... 100
processCSContact ................................................................................................. 101
Sales Cloud Contact SDO ........................................................................................... 102
Sales Cloud Household Simplified Web Services Interface .............................. 123

Operations ..................................................................................................................... 123
getHousehold ......................................................................................................... 124
createHousehold.................................................................................................... 124
updateHousehold .................................................................................................. 125
deleteHousehold .................................................................................................... 126
mergeHousehold .................................................................................................... 127
findHousehold ......................................................................................................... 127
processHousehold .................................................................................................. 128
processCSHousehold ............................................................................................. 129
Sales Cloud Household SDO ....................................................................................... 130
Sales Cloud Relationship Simplified Web Services Interface ............................ 143

Operations ..................................................................................................................... 143
createRelationship ................................................................................................. 144
updateRelationship ................................................................................................ 144
deleteRelationship ................................................................................................. 145
Contents
mergeRelationship.................................................................................................. 146
findRelationship ....................................................................................................... 146
processRelationship ................................................................................................ 147
processCSRelationship ........................................................................................... 148
Sales Cloud Relationship SDO ..................................................................................... 149
Sales Cloud Address Simplified Web Services Interface ................................... 155

Operations ..................................................................................................................... 155
getAddress .............................................................................................................. 156
createAddress ......................................................................................................... 156
updateAddress ....................................................................................................... 157
mergeAddress ......................................................................................................... 158
deleteAddress ......................................................................................................... 159
findAddress .............................................................................................................. 159
processAddress ....................................................................................................... 160
processCSAddress .................................................................................................. 161
Sales Cloud Address SDO ............................................................................................ 162
Sales Cloud Address Purpose SDO ............................................................................. 171
Sales Cloud Primary Address SDO .............................................................................. 172
Appendix A: Downloading and Setting Up the Fusion Service Tester ............ 179
Installing JAVA on Windows machine ........................................................................ 179
Downloading the Fusion Service Tester ..................................................................... 179
Running the Fusion Service Tester Client .................................................................... 179
Importing a New certificate in the keystore (for IE).................................................. 180
10
Appendix B: Sample Code: Static Web Service Proxy JAX-WS Style ........ 181
11
Appendix C: Extracting Oracle Public Certificate from Fusion WSDL ...... 189
Introduction to Simplified Sales

Cloud Web Services for Account,
Household, and Contact

Oracle Sales Cloud comes with SOAP Web services that you can use to:
Develop cloud applications that call on and integrate with Oracle Sales Cloud to
deliver some of their functionality. You could sell these applications in the Oracle
Cloud Marketplace. These applications might deliver other functionality
independently or by integrating with third-party applications.
Integrate suites of applications from third party vendors to Oracle Sales Cloud.
Integrate different types of Oracle applications suites, such as Oracle E-Business
Suite, with Oracle Sales Cloud.
Customize and extend Oracle Sales Cloud applications to your business needs.
Overview of Simplified SOAP Web Services

The new and simplified SOAP Web services are a subset of Oracle Sales Cloud Web
Services. These Web services make it easy to integrate accounts, contacts and
households with other spoke systems. Simplified object structures represent logical views
of accounts, contacts and households. You dont need to know the full data model to
use the services correctly. Instead of calling multiple granular web services to
orchestrate a set of customer record updates, you can now perform the most common
customer data management actions with new APIs. For example, you can use one API
call to create account with locations and associate the account with existing contacts.
The following top level SOAP services are available:
Sales Cloud Account
Sales Cloud Contact
Sales Cloud Household
Use these services to create, edit, find, merge, and delete account, contact, and
household objects. The services support commonly used profile attributes: one set of
industry classification and parent node information attributes required to create an
account hierarchy, address attributes, and one instance of different contact point type
attributes such as phone, mobile, fax, and email.
The following child services are also available and allow you to manage multiple
addresses and relationships for the three top level objects:
Understanding the Process Flow for Consuming a SOAP Web Service
Sales Cloud Address

Sales Cloud Relationship
Steps to Enable
There are no steps necessary to enable these enhancements.

Tips and Considerations
Attributes that are available on the simplified pages by default are available within
each of the top-level services.
The Sales Cloud Account service supports the management of an account

hierarchy for a given account.
The Sales Cloud Address service can be used only if there is more than one address
related to the top level object.
The top-level services do not support any relationships. Use the Sales Cloud
Relationship service to manage relationships between any two top-level objects.
Key Resources
For more information about using Web Services in Oracle Sales Cloud, see:
Getting Started with Web Services

Sales Cloud Web Services: (MOS article 1354841.1)
Import Web-Service Guide: (1605219.1)
Understanding the Process Flow for Consuming a SOAP Web

Service
The following figure illustrates the typical stages of the process for consuming a SOAP
Web Service:
These stages are described below:
10
Identifying the web services relevant to your business use case: Review the available
services, for the object you want to work with, in Oracle Enterprise Repository and
Searching for Relevant Web Services Using the OER
decide which service you want to use. For more information, see Searching for Web
Services in OER.
Prototyping payloads and evaluating if a web service meets your business

requirements: You can do it by prototyping payloads and testing if the web service
can actually perform the operations per your business requirements. You can
prototype payloads and evaluate results using the Fusion Service Tester or the Oracle
JDeveloper HTTP Analyzer. Alternatively, you can use third party tools, such as
WebInject, SoapUI, and Strom, to test the Sales Cloud web services. For more
information, see Determining Which Web service to Use to Implement Your Use Case.
Building Web service clients using an IDE: You can use an appropriate IDE to develop
a proxy client on a platform of your choice such as Java, .Net, or ASP to call Web
services and integrate applications with Oracle Sales Cloud. You can build a static
proxy, dynamic proxy, or a dynamic-static proxy depending on your business
requirements. For more information, see Building Web Service Clients Using an IDE.
Generating Keystore certificates: You have to generate keystore certificates only for
running standalone JDK applications. You do not need to generate keystore
certificates if you are running within the Weblogic Server. For more information, see
Generating Keystore certificates: Points to Consider.
Searching for Relevant Web Services Using the OER

The simplified Web services let you perform simple operations. For example, the Sales
Cloud Account service lets you manage (create, update, and delete) only simple
organization accounts. You cannot use the Sales Cloud Account Web service to
manage organization accounts with additional names and identifiers, multiple sets of
addresses, contacts, industry classification information, e-mail and phone, and resources
associated with the sales profile.
To perform complex operations, you can use related services. For example, to manage
complex accounts you could use Sales Party, Sales Account Service, and so on.
You can identify the Web services relevant to your business use case by reviewing the
available services, for the object you want to work with, in the Oracle Enterprise
Repository (OER).
The Oracle Enterprise Repository contains reference guides with detailed information on
individual Web services. The OER includes all information about web services such as the
LBA information, operations available, related service data objects (SDOs), and the Web
service invocation methods.
The following types of assets can be accessed in the repository:
ADF Business Components services
ADF Business Components service data objects
Service Oriented Architecture (SOA) composites

SOA composite services
To access the information for a web service, follow these steps.
11
Accessing WSDL URL
1. Using your browser, enter http://fusionappsoer.oracle.com. Sign in as a user or a

guest to Oracle Enterprise Repository.
2. Search for assets, using the Web service name for your Search String.
3. Navigate to the results, and click the Documentation tab.
The Detail tab includes the service WSDL URL and an abstract WSDL URL. You can modify
the service WSDL URL to obtain the endpoint URL for the service.
Accessing WSDL URL

To get logical end point:
Launch the OER (https://fusionappsoer.oracle.com/oer) and login as Guest.

Search for the Web service that you need using an appropriate search string and
type. For example, for the Sales Cloud Account Web service, use the following
combination:
Search String: Sales Cloud Account

Type: ADF Service
Select the service from the results section and see the Details tab in the bottom. That
will have service logical end point as below. Service Path:
http://<crm_server:PortNumber>/crmCommonSalesParties/AccountService
The part "http://<crm_server:PortNumber>" is dynamic for every environment where
as "/crmCommonSalesParties/AccountService" is static for a given service version.
To get physical end point of any given instance:
Launch Oracle Sales Cloud home page and login as a functional user.
Navigate to an application's dashboard/workarea page that belongs to Sales Cloud
Account. For example: In case of Financial Util Service navigate to Payables or in
case of Purchase Order Service navigate to Procurement.
Lets take the Payables Invoice workbench as an example, you will see a URL in the
browser similar to https://<domainname>/payables/faces/InvoiceWorkbench. The
<domainname> might be like https://<pod-name>.<lba>.xxx.oraclecloud.com.
In this URL, take the "https://<domainname>". For example, in case of Payables

Invoice workbench URL just take till "payables". Then append the static context root
that we extracted from OER - "/crmCommonSalesParties/AccountService" to it.
https://<domainname>/crmCommonSalesParties/AccountService is the WSDL URL

for Sales Cloud Account.
Determining Which Web service to Use to Implement Your Use

Case
Before you invest time and resources in building a custom proxy client application to call
an Oracle Sales Cloud Web service, you much ascertain whether that Web services can
meet your business requirements. This section outlines how you can identify the Web
12
Determining Which Web service to Use to Implement Your Use Case
service that you need to use to implement your specific use case. The section describes
the different options available to you for evaluating Oracle Sales Cloud Web services,
by prototyping their input payloads and evaluating output payloads and results.
You can test Oracle Sales Cloud Web services using the following tools:
Fusion Service Tester

Oracle JDeveloper HTTP Analyzer
Third party tools
Prototyping Payloads and Evaluating if a Web Service Meets Your Business

Requirements Using the Fusion Service Tester
You can use Oracles Fusion Service Tester application to test Oracle Sales Cloud
services. Review Appendix A to find out how to download it from the OER
(https://fusionappsoer.oracle.com/oer/FusionServiceTester.zip) and set it up.
After completing the setup steps, you can run the startFusionServiceTester.bat to launch
the Fusion Service Tester application.
Evaluating the Simplified Account Service
Use this procedure to evaluate the simplified Account service (AccountService).
Prerequisites
Ensure that the user credentials used to invoke the service has the required privilege
to create an account in Oracle Sales Cloud Applications.
Optionally, if you want to designate an account owner to any account you must
ensure that the account owner exists.
Identifying the Appropriate Web Service
1. Log in to Oracle Enterprise Repository.

2. Enter Account Service as the search string and select ADF Service in the Type field,
and click Search.
3. Click Sales Cloud Account.
4. Note down the service interface name of the Web service
oracle.apps.crmCommon.salesParties.accountService.AccountService.
Extracting the Web Services URL
After you have identified the appropriate Web service in the Identify the Appropriate
Web Service section, perform the following steps.

Account. For example: Navigator > Customers > Create Account.
13
Review the URL of the dashboard/workarea. You will see a URL in the browser similar
to https://<domainname>/customer/faces/CustomerCtrWorkarea. The
In this URL, take the "https://<domainname>". Then append the static context root
that we extracted from OER - "/crmCommonSalesParties/AccountService" to it.
https://<domainname>/crmCommonSalesParties/AccountService is the WSDL URL
for Sales Cloud Account.
If you have access to Oracle Enterprise Manager Fusion Applications Control, you can
use the following steps:
1. Log in to the Oracle Enterprise Manager Fusion Applications Control using the Web
Logic Server credentials.
2. Select Oracle Fusion Customer Relationship Management from the navigation tree,
and then select Fusion Applications.
3. From the tree, select CrmCommonApp, and then select CrmCommonApp
(CRMCommonServer_1).
4. In the Web Services pane on the right side of the page, scroll to the service name
that you had noted down in the Identifying the Appropriate Web Service section,
and click Test.
5. In the Test Web Service pane, copy the URL of a WSDL that appears in the WSDL field
until "?wsdl", and then paste to a notepad.
Deriving the Input Payload
Perform the following steps, after you have launched the WSDL URL in a web browser.
1. In the AccountsService endpoint page, select createAccount from the Operation
list.
2. In the Parameters pane, under Account, enter the name of the account in the
OrganizationName field.
3. In the Parameters pane, under Account, enter an appropriate account type
(ZCA_PROSPECT or ZCA_CUSTOMER) in the Type field.
4. Uncheck all the other fields.
5. Click the XML Source option that is next to the Operation list.
6. Copy the XML source and paste to a notepad.
Invoking the Web Service
Follow the below steps to invoke the Web service using Fusion Service Tester:
Note: You can also use your custom proxy client application, JDeveloper HTTP Analyzer, and third party
tools, such as SoapUI, to call a simplified Oracle Sales Cloud Web service.
1. Launch the Fusion Service Tester. Review Appendix A to find out how to download it
from OER (https://fusionappsoer.oracle.com/oer/FusionServiceTester.zip) and set it
up.
14
2. In the WebService URL field, paste the WSDL URL that you derived following the steps
in the "Extracting the Web Services URL" section.
3. Enter the username and password credentials.
4. In the Input Payload pane, paste the XML source that you derived following the
steps in the "Deriving the Input Payload" section.
5. Click Invoke. The Output Payload pane displays the output payload.
Testing the Results
1. Copy and paste the output payload to a notepad.

2. Verify if the account has been created.
3. Log in to Oracle Sales Cloud Applications.
4. In the Customers work area, search for the new account you have created using the
Manage Customers Classic UI page. You can also search using the Accounts
simplified UI page.
5. Verify the account details.
Evaluating the Simplified Contact Service
Use this procedure to evaluate the simplified Contact service (ContactService).
Prerequisites
Ensure that the user credentials used to invoke the service has the required privilege to
create a contact in Oracle Sales Cloud Applications.

2. Enter ContactService as the search string and select ADF Service in the Type field,
and click Search.
3. Click Sales Cloud Contact.
4. Note down the service interface name of the Web service:
oracle.apps.crmCommon.salesParties.contactService.ContactService.

Contact. For example: Navigator > Customers > Create Contact.
15
that we extracted from OER - "/crmCommonSalesParties/ContactService" to it.
https://<domainname>/crmCommonSalesParties/ContactService is the WSDL URL for

Sales Cloud Contact.
If you have access to Oracle Enterprise Manager Fusion Applications Control, use the
following steps:
and click Test.
Perform the following steps, after you have launched the WSDL URL in a web browser.
1. In the ContactService endpoint page, select createContact from the Operation list.
2. In the Parameters pane, under Contact, enter the first name and last name in the
FirstName and LastName fields, respectively.
3. In the Parameters pane, under Contact, enter HZ_WS in the CreatedByModule field.
Note: HZ_WS is the inbuilt code for Web Services.
4. Uncheck all the other fields.

Note: In this example, the Type field is also unchecked. If you dont enter a value in the Type field,
then the type is Business Contact, by default.
5. Click the XML Source option.

Note: This option appears next to the Operation list.
up.
16
2. In the WebService URL field, paste the WSDL URL that you derived following the steps
in the "Extracting the Web Services URL" section.
Evaluating the Results
1. Copy and paste the output payload to a notepad.

2. Verify if ZCA_Contact is assigned in the Type field, which is the default value for
Contact.
4.
In the Customers work area, search for the new contact that you have created
using the Manage Contacts Classic UI page. You can also search using the Contacts
simplified UI page.
5. Enter the first or last name in the Keywords field to search for the contact.
6. Verify the contact details.
Evaluating the Simplified Household Service
Use this procedure to evaluate the simplified Household service (HouseholdService).
Prerequisites
create a household in Oracle Sales Cloud Applications.

2. Enter HouseholdService as the search string and select ADF Service in the Type field,
and click Search.
3. Click Sales Cloud Household.
oracle.apps.crmCommon.salesParties.householdService.HouseholdService.

Account. For example: Navigator > Customers > Create Household.
17
that we extracted from OER - "/crmCommonSalesParties/HouseholdService" to it.
https://<domainname>/crmCommonSalesParties/HouseholdService is the WSDL URL
for Sales Cloud Household.
and click Test.
After you have identified the appropriate web service in the Identifying the
Appropriate Web Service section, perform the following steps.
1. Navigate to the HouseholdService endpoint page, as explained in the Extracting the
Web Services URL section.
2. Select the createHousehold operation from the operation drop-down list.
3. Provide valid values to the mandatory fields.
4. In the parameters section, select the Include in Message checkbox if a parameter is
not mandatory and you're providing a value for it.
5. Click the XML Source radio button. This generates the input payload.
18
up.
2. In the Web Service URL field, paste the WSDL URL that you derived following the steps
in "Identifying the Appropriate Web Service" section.
4. In the Input Payload pane, paste the XML source that you derived from "Generating
the Payload" section.
You can evaluate the results of the Web service call by verifying the creation of the
household in your Oracle Sales Cloud instance as follows:
1. Copy and paste the output payload to a notepad window.
3. In the Customers work area, search for the new household you have created using
the Manage Customer Classic UI page. You can also search for it using the
Households simplified UI page.
4. Verify the household details. This confirms that the household has been created.
Evaluating the Simplified Relationship Service
Use this procedure to evaluate the simplified Relationship service (RelationshipService).
Prerequisites
create a relationship in Oracle Sales Cloud Applications.

2. Enter RelationshipService as the search string and select ADF Service in the Type
field, and click Search.
3. Click Sales Cloud Relationship.
oracle.apps.crmCommon.salesParties.relationshipService.RelationshipService.
Navigate to an application's dashboard/workarea page that is related to Sales
Cloud Relationship. For example: Navigator > Customers.
19
that we extracted from OER - "/crmCommonSalesParties/RelationshipService" to it.
https://<domainname>/crmCommonSalesParties/RelationshipService is the WSDL
URL for Sales Cloud Relationship.
and click Test.
1. Navigate to the RelationshipService endpoint page, as explained in the Identifying
the Appropriate Web Service section.
2. Select the createRelationshp operation from the operation drop-down list.
20
up.
in the "Identifying the Service" section.
steps in the "Deriving the Input the Payload" section.
relationship in your Oracle Sales Cloud instance as follows:
1. Copy and paste the output payload to a notepad window
3. In the Customers work area, search for the customer (account or contact) for which
you created the relationship using the Manage Customer or the Manage Contact
Classic UI page. You can also search for it using the Account or Contact simplified UI
page.
4. Verify the relationship details. This confirms that the relationship has been created.
Evaluating the Simplified Address Service
Use this procedure to evaluate the simplified Address service (AddressService).
Prerequisites
create an address in Oracle Sales Cloud Applications.

2. Enter AddressService as the search string and select ADF Service in the Type field,
and click Search.
3. Click Sales Cloud Address.

oracle.apps.crmCommon.salesParties.addressService.AddressService.
21
Navigate to an application's dashboard/workarea page that is related to Sales

Cloud Address. For example: Navigator > Customers.
From this URL, take the "https://<domainname>". Then append the static context
root that we extracted from OER - "/crmCommonSalesParties/AddressService" to it.
https://<domainname>/crmCommonSalesParties/AddressService is the WSDL URL for

Sales Cloud Address.
and click Test.
1. Navigate to the AddressService endpoint page as explained in the Extracting the
Web Services URL section.
2. Select the createAddress operation from the operation drop-down list.
Follow the below steps to invoke the Web service using the Fusion Service Tester:
22
tools, such as SoapUI, to call a simplified Oracle Sales Cloud Web service Web service.
up.
in the "Identifying the Service" section.
address in your Oracle Sales Cloud instance as follows:
1. Copy and paste the output payload to a notepad window.
2. Verify the relationship details. This confirms that the household has been created.
4. In the Customers work area, search for the customer (account or contact) for which
you created the address using the Manage Customer or the Manage Contact
Classic UI page. You can also search for it using the Account or Contact simplified UI
page.
5. Verify the address details. This confirms that the address has been created.
Prototyping Payloads and Evaluating Web Services Using the JDeveloper HTTP
Analyzer
Use this procedure to prototype payloads and evaluate Web service call results using
the JDeveloper HTTP Analyzer:
1. Launch JDeveloper IDE in Default role.
2. Click Tools and select the HTTP Analyzer
3. Click the Create A New Request icon.
4. In the HTTP Analyzer: Unsent Message page, Click Open WSDL button on the top
right
5. Enter WSDL URL.
6. Click OK and wait for the JDeveloper to fetch the WSDL document.
7. Select an appropriate Web service operation.
8. Click on HTTP Content tab and paste an appropriate request payload.
9. Click SOAP Structure tab and click Request HTTP Headers
23
10. Click on the + (Add headers menu) icon (Sometimes, the + icon may not be visible.
You may have to expand the Request HTTP Headers panel by dragging the splitter
bar to the right.
11. Select Authorization basic.
12. Enter Basic username:password such as Basic Sales_Admin: Welcome
13. Click Send Request.
14. Review the response and verify the operation result in your instance of Oracle Sales
Cloud.
Prototyping Payloads and Evaluating Web Services Using Third Party Tools
You can use third party tools, such as SoapUI, WebInject and Strom, to test the Sales
Cloud Web services. You can perform various types of Web service testing, based on
the third party tool you are using. For more information, see:
24
http://www.soapui.org
https://storm.codeplex.com
http://www.webinject.org
How do I ?
Managing Accounts Using the Simplified Sales Cloud Account

Web Service (AccountService)
An account is an organization or company that you want in your records for sales
purposes. Accounts include organizations to which you sell, but do not include
individuals.
Call the Sales Cloud Account service (AccountService) to create, update, find, and
delete organization accounts. When performing these operations, you can include only
one address in the payload. You must use the Address web service to create an address
for an account.
Create an Account Programmatically Using createAccount

You can create accounts of the following types in Oracle Sales Cloud by calling the
createAccount method:
Customer: An account to whom you are actively selling or to whom you have sold
previously. This was a Sales Account in Oracle Sales Cloud Release 7.
Prospect: A new account to whom you plan to sell.
The sample code and payload for calling the createAccount method are as follows.
Sample XML Payload
Sample WSDL call for createAccount
https://<domainname>/crmCommonSalesParties/AccountService
Payload to create an account of the type prospect (ZCA_PROSPECT)
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soap:Body>
<ns1:createAccount
xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/accountServ
ice/types/">
<ns1:account
ice/">
<ns2:OrganizationName>Responsys
California</ns2:OrganizationName>
<ns2:Type>ZCA_PROSPECT</ns2:Type>
<ns2:CreatedByModule>HZ_WS</ns2:CreatedByModule>
<ns2:PhoneCountryCode>1</ns2:PhoneCountryCode>
25
Contents
<ns2:PhoneAreaCode>650</ns2:PhoneAreaCode>
<ns2:PhoneNumber>8881111</ns2:PhoneNumber>
<ns2:PhoneExtension>123</ns2:PhoneExtension>
</ns1:account>
</ns1:createAccount>
</soap:Body>
</soap:Envelope>
This payload contains the minimum information to create a prospect. It creates a new
prospect account with an organization name and contact phone number.
Payload to create an account of the type customer (ZCA_CUSTOMER)
This payload contains the information to create a customer. It creates a new customer
account with profile and contact information, a new address, and a relationship
between the newly created account and address to indicate the address is the primary
address for the customer.
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soap:Body>
<ns1:createAccount
ice/types/">
<ns1:account
ice/">
<ns2:SourceSystem>CSV</ns2:SourceSystem>
<ns2:SourceSystemReferenceValue>SBS_ACCT_SSR_23417</ns2:SourceSystemRefere
nceValue>
<ns2:OrganizationName>Materials Process Engineering
LLC</ns2:OrganizationName>
<ns2:CEOName>Bob Doyle</ns2:CEOName>
<ns2:Type>ZCA_CUSTOMER</ns2:Type>
<ns2:IndustryCodeType>ONE VOICE</ns2:IndustryCodeType>
<ns2:IndustryCode>2700</ns2:IndustryCode>
<ns2:FaxCountryCode>1</ns2:FaxCountryCode>
<ns2:FaxAreaCode>650</ns2:FaxAreaCode>
<ns2:FaxNumber>8882222</ns2:FaxNumber>
<ns2:EmailAddress>contactus@oracle.com</ns2:EmailAddress>
26
How do I ? Managing Accounts Using the Simplified Sales Cloud Account Web Service
(AccountService)
<ns2:URL>https://www.wpi.edu/about/tour/washburn.html</ns2:URL>
<ns2:PrimaryAddress
xmlns:ns3="http://xmlns.oracle.com/apps/crmCommon/salesParties/commonServi
ce/">
<ns3:SourceSystemReferenceValue>SBS_ACCT_ADD_SSR_419</ns3:SourceSystemRefe
renceValue>
<ns3:AddressLine1>4578 El Camino
Real</ns3:AddressLine1>
<ns3:City>San Mateo</ns3:City>
<ns3:Country>US</ns3:Country>
<ns3:County>San Mateo</ns3:County>
<ns3:PostalCode>94401</ns3:PostalCode>
<ns3:State>CA</ns3:State>
</ns2:PrimaryAddress>
</ns1:account>
</ns1:createAccount>
</soap:Body>
</soap:Envelope>
Search for an Account Programmatically Using findAccount

You can search for accounts using the findAccount method. The sample payload for
calling the findAccount method is as follows. This sample payload finds all accounts that
contain Alcoa in the organization name.
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:findAccount
ice/types/">
<ns1:findCriteria
xmlns:ns2="http://xmlns.oracle.com/adf/svc/types/">
<ns2:filter>
<ns2:conjunction>And</ns2:conjunction>
<ns2:group>
<ns2:item>
<ns2:attribute>OrganizationName</ns2:attribute>
<ns2:operator>CONTAINS</ns2:operator>
<ns2:value>Alcoa</ns2:value>
</ns2:item>
27
Contents
</ns2:group>
</ns2:filter>
</ns1:findAccount>
</soap:Body>
</soap:Envelope>
Update an Account and its Primary Address Programmatically Using

updateAccount
You can update an account and its primary address by using the updateAccount
method. When updating an account, you must provide the partyId of the account.
The sample payload for calling the updateAccount method is as follows. This sample
payload updates the profile information, contact information, and the primary address
for the account with the PartyId 300100032610977.
<soap:Body>
<ns1:updateAccount
ice/types/">
<ns1:account
ice/">
<ns2:PartyId>300100059083744</ns2:PartyId>
<ns2:CEOName>Mike Burns</ns2:CEOName>
<ns2:CEOTitle>MR</ns2:CEOTitle>
<ns2:Comments>Updating the organization information based
on recent changes as of 04/28/2104</ns2:Comments>
<ns2:PrimaryAddress
ce/">
<ns3:AddressLine1>21 El Camino Real</ns3:AddressLine1>
<ns3:AddressLine2>Suite 3001</ns3:AddressLine2>
<ns3:AddressLine3>West Wing</ns3:AddressLine3>
</ns1:account>
</ns1:updateAccount>
</soap:Body>
</soap:Envelope>
28
(AccountService)
Delete an Account Programmatically Using deleteAccount

You can delete an account by using the deleteContact method. When deleting an
account, you must provide any identifier of the account.
The sample payload for calling the deleteAccount method is as follows. In this sample
payload, we are providing the origin system and the origin system reference to identify
the account.
<soap:Body>
<ns1:deleteAccount
ice/types/">
<ns1:account
ice/">
<ns2:SourceSystemReferenceValue>SBS_ACCT_SSR_245401</ns2:SourceSystemRefer
enceValue>
</ns1:account>
</ns1:deleteAccount>
</soap:Body>
</soap:Envelope>
Retrieve an Account Programmatically Using getAccount

You can retrieve an account by using the getContact method. When retrieving an
account, you must provide the PartyId of the account.
The sample payload for calling the getAccount method is as follows. In this sample
payload, we are retrieving the account with the partyId 300100059257833.
<soap:Body>
<ns1:getAccount
ice/types/">
</ns1:getAccount>
</soap:Body>
</soap:Envelope>
29
Contents
Merge an account Programmatically Using mergeAccount

You can merge attribute information in an account using the mergeAccount method.
The service updates the object if it exists, else creates a new account.
The sample payload for calling the mergeAccount method is as follows. In this sample
payload, we are updating the account with the partyId 300100059257833. The method
will update the account if it exists, else it will create a new account.
<soap:Body>
<ns1:mergeAccount
ice/types/">
<ns1:account
ice/">
<ns2:SourceSystemReferenceValue>300100059257833</ns2:SourceSystemReference
Value>
<ns2:OrganizationName>Alcoa Systems</ns2:OrganizationName>
<ns2:OwnerPartyId>300447669257833</ns2:OwnerPartyId>
<ns2:OwnerPartyNumber>55748</ns2:OwnerPartyNumber>
<ns2:OwnerEmailAddress>bob.boyle@alcoa.com</ns2:OwnerEmailAddress>
<ns2:YearEstablished>1980</ns2:YearEstablished>
<ns2:YearIncorporated>1981</ns2:YearIncorporated>
<ns2:PrimaryAddress
ce/">
<ns3:AddressLine1>#24823</ns3:AddressLine1>
<ns3:AddressLine2>Alcoa Drive</ns3:AddressLine2>
<ns3:AddressLine3>Redmond</ns3:AddressLine3>
<ns3:AddressLine4>CA</ns3:AddressLine4>
</ns1:account>
</ns1:mergeAccount>
</soap:Body>
</soap:Envelope>
30
(AccountService)
Perform a Specific Operation (Create, Update, Delete, or Merge) on a List of

Accounts Using processAccount
You can perform create, update, delete, or merge operation on a list of accounts in
Oracle Sales Cloud by calling the processAccount method.
The sample payload for calling the processAccount method is as follows. This sample
payload creates two accounts using one API call.
<soap:Body>
<ns1:processAccount
ice/types/">
<ns1:changeOperation>Create</ns1:changeOperation>
<ns1:account
ice/">
<ns2:OrganizationName>Pinnacle Energy Inc
</ns2:OrganizationName>
</ns1:account>
<ns1:account
ice/">
<ns2:OrganizationName>Pinnacle
Financials</ns2:OrganizationName>
<ns2:CEOName>John Smith</ns2:CEOName>
</ns1:account>
<ns1:processControl
<ns2:returnMode>Full</ns2:returnMode>
<ns2:exceptionReturnMode>Full</ns2:exceptionReturnMode>
<ns2:partialFailureAllowed>true</ns2:partialFailureAllowed>
</ns1:processControl>
</ns1:processAccount>
</soap:Body>
</soap:Envelope>
31
Contents
Managing Contacts Using the Simplified Sales Cloud Contact Web

Service (ContactService)
A contact is a person who either has a relationship to other objects like account and
household or is a customer or prospect you directly sell to. Contacts can be of the
following types:
Business contacts: People related to accounts or households

Customer: People to whom you sell directly
Prospect: A new contact to whom you plan to sell
A contact could be either contact of an account or household in a B2B scenario or a

buying customer in a B2C scenario.
Call the Sales Cloud Contact service (ContactService) to create, find, update, retrieve,
delete, get, and merge contacts. When performing these operations, you can include
only one (primary) address in the payload. When creating a contact with multiple
addresses you must use the PrimaryAddress child entity for one (primary) address and
the Address service for the rest of the addresses.
Create a Contact Programmatically Using createContact

You can create contacts of the type, business, customer, or prospect, in Oracle Sales
Cloud by calling the createContact method. The sample payload for calling the
createContact method is as follows.
Sample XML Payload
Payload to create an contact of the type business contact (ZCA_CONTACT)
<soap:Body>
<ns1:createContact
xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/contactServ
ice/types/">
<ns1:contact
ice/">
<ns2:SourceSystemReferenceValue>SBS_CNT_24616</ns2:SourceSystemReferenceVa
lue>
<ns2:FirstName>SBS_FN</ns2:FirstName>
<ns2:LastName>SBS_LN</ns2:LastName>
<ns2:WorkPhoneCountryCode>1</ns2:WorkPhoneCountryCode>
<ns2:WorkPhoneAreaCode>650</ns2:WorkPhoneAreaCode>
<ns2:WorkPhoneNumber>2276000</ns2:WorkPhoneNumber>
<ns2:WorkPhoneExtension>001</ns2:WorkPhoneExtension>
<ns2:MobileCountryCode>1</ns2:MobileCountryCode>
32
How do I ? Managing Contacts Using the Simplified Sales Cloud Contact Web Service
(ContactService)
<ns2:MobileAreaCode>650</ns2:MobileAreaCode>
<ns2:MobileNumber>2276001</ns2:MobileNumber>
<ns2:MobileExtension>002</ns2:MobileExtension>
<ns2:FaxCountryCode>1</ns2:FaxCountryCode>
<ns2:FaxAreaCode>650</ns2:FaxAreaCode>
<ns2:FaxNumber>2276003</ns2:FaxNumber>
<ns2:FaxExtension>003</ns2:FaxExtension>
<ns2:EmailAddress>sbs@oracle.com</ns2:EmailAddress>
<ns2:ClassificationCategory>CUSTOMER_CATEGORY</ns2:ClassificationCategory>
<ns2:ClassificationCode>BROKER</ns2:ClassificationCode>
<ns2:PrimaryAddress
ce/">
<ns3:AddressLine1>Commerce at
Mantri</ns3:AddressLine1>
<ns3:Country>IN</ns3:Country>
</ns1:contact>
</ns1:createContact>
</soap:Body>
</soap:Envelope>
Payload to create an contact of the type prospect (ZCA_PROSPECT)
<soap:Body>
<ns1:createContact
ice/types/">
<ns1:contact
ice/">
<ns2:SourceSystemReferenceValue>SBS_CNT_CUST_24620_1</ns2:SourceSystemRefe
renceValue>
<ns2:ContactName>SBS FN LN</ns2:ContactName>
<ns2:FavoriteContactFlag>TRUE</ns2:FavoriteContactFlag>
<ns2:CreatedByModule>AMS</ns2:CreatedByModule>
33
Contents
<ns2:PrimaryAddress
ce/">
<ns3:AddressLine1>PTP</ns3:AddressLine1>
<ns3:City>BENGALURU</ns3:City>
<ns3:State>KA</ns3:State>
</ns1:contact>
</soap:Body>
</soap:Envelope>
Payload to create an contact of the type customer (ZCA_CUSTOMER)
<soap:Body>
<ns1:createContact
ice/types/">
<ns1:contact
ice/">
<ns2:SourceSystemReferenceValue>SBS_CNT_CUST_24620</ns2:SourceSystemRefere
nceValue>
<ns2:ContactName>SBS FN LN</ns2:ContactName>
<ns2:FavoriteContactFlag>TRUE</ns2:FavoriteContactFlag>
<ns2:PrimaryAddress
ce/">
<ns3:AddressLine1>PTP</ns3:AddressLine1>
<ns3:City>BENGALURU</ns3:City>
<ns3:State>KA</ns3:State>
34
(ContactService)
</ns1:contact>
</soap:Body>
</soap:Envelope>
Search for a Contact Programmatically Using findContact

You can find contacts in Oracle Sales Cloud by calling the findContact method. The
sample payload for calling the findContact method is as follows.
Sample XML Payload
<soap:Body>
<ns1:findContact
ice/types/">
<ns1:findCriteria
<ns2:fetchStart>0</ns2:fetchStart>
<ns2:fetchSize>-1</ns2:fetchSize>
<ns2:filter>
<ns2:group>
<ns2:upperCaseCompare></ns2:upperCaseCompare>
<ns2:item>
<ns2:attribute>PartyId</ns2:attribute>
<ns2:operator>=</ns2:operator>
<ns2:value>300100044016994</ns2:value>
</ns2:item>
</ns2:group>
</ns2:filter>
<ns2:excludeAttribute></ns2:excludeAttribute>
</ns1:findCriteria>
</ns1:findContact>
</soap:Body>
</soap:Envelope>
Update a Contact and its Primary Address Programmatically Using

updateContact
You can update a contact and its primary address in Oracle Sales Cloud by calling the
updateContact method. The sample payload for calling the updateContact method is
as follows.
35
Contents
Sample XML Payload

<soap:Body>
<ns1:updateContact
ice/types/">
<ns1:contact
ice/">
<ns2:SourceSystemReferenceValue>SBS_CNT_225607</ns2:SourceSystemReferenceV
alue>
<ns2:FirstName>SBS_FN_SSR</ns2:FirstName>
<ns2:LastName>SBS_LN_SSR</ns2:LastName>
<ns2:Department>RESEARCH</ns2:Department>
<ns2:EmailAddress>ssr.value@oracle.com</ns2:EmailAddress>
<ns2:PrimaryAddress
ce/">
<ns3:AddressLine1>UPDATE SSR LINE1</ns3:AddressLine1>
</ns1:contact>
</ns1:updateContact>
</soap:Body>
</soap:Envelope>
Delete a Contact Programmatically Using deleteContact

You can delete a contact and its relationship with the contacts primary address in
Oracle Sales Cloud by calling the deleteContact method. The sample payload for
calling the deleteContact method is as follows.
Sample XML Payload
Party ID
<soap:Body>
<ns1:deleteContact
ice/types/">
<ns1:contact
ice/">
</ns1:contact>
</ns1:deleteContact>
36
(ContactService)
</soap:Body>
</soap:Envelope>
Party Number
<soap:Body>
<ns1:deleteContact
ice/types/">
<ns1:contact
ice/">
<ns2:PartyNumber>CDRM_737311</ns2:PartyNumber>
</ns1:contact>
</soap:Body>
</soap:Envelope>
SSR Value
<soap:Body>
<ns1:deleteContact
ice/types/">
<ns1:contact
ice/">
alue>
</ns1:contact>
</soap:Body>
</soap:Envelope>
Retrieve a Contact Programmatically Using getContact

You can retrieve a contact in Oracle Sales Cloud by calling the getContact method.
The sample payload for calling the getContact method is as follows.
Sample XML Payload
37
Contents
<soap:Body>
<ns1:getContact
ice/types/">
</ns1:getContact>
</soap:Body>
</soap:Envelope>
Merge a Contact Programmatically Using mergeContact

You can replace the existing contact details or create a new contact if it doesnt already exist in Oracle Sales
Cloud by calling the mergeContact method. The sample payload for calling the mergeContact method is as
follows:
Sample XML Payload
<soap:Body>
<ns1:mergeContact
ice/types/">
<ns1:contact
ice/">
alue>
<ns2:FirstName>SBS_FN_SSR_MERGE</ns2:FirstName>
<ns2:LastName>SBS_LN_SSR_MERGE</ns2:LastName>
<ns2:Department>RESEARCH</ns2:Department>
<ns2:EmailAddress>ssr.value@oracle.com</ns2:EmailAddress>
<ns2:PrimaryAddress
ce/">
<ns3:AddressLine2>UPDATE SSR LINE1
MERGE</ns3:AddressLine2>
</ns1:contact>
</ns1:mergeContact>
</soap:Body>
</soap:Envelope>
38
How do I ? Managing Households Using the Simplified Sales Cloud Household Web
Service

Contacts Using processContact
You can perform a create, update, delete, or merge operation on a list of contact rows
in Oracle Sales Cloud by calling the processContact method. The sample payload for
calling the processContact method is as follows.
Sample XML Payload
<soap:Body>
<ns1:processContact
ice/types/">
<ns1:contact
ice/">
<ns2:FirstName>John</ns2:FirstName>
<ns2:LastName>Smith</ns2:LastName>
<ns2:EmailAddress>john.smith@oracle.com</ns2:EmailAddress>
</ns1:contact>
<ns1:contact
ice/">
<ns2:FirstName>George</ns2:FirstName>
<ns2:LastName>Clooney</ns2:LastName>
<ns2:EmailAddress>george.clooney@oracle.com</ns2:EmailAddress>
</ns1:contact>
<ns1:processControl
</ns1:processContact>
</soap:Body>
</soap:Envelope>
Managing Households Using the Simplified Sales Cloud Household

Web Service
You can use household to track information about a groups of contacts, including:
39
Contents
Household members
Sales Teams
Relationships
Leads and opportunities
Assets
Notes, tasks, and appointments
Conversations
Call the Sales Cloud Household service (HouseholdService) to create, update, find, and
delete the parties of type household. When performing these operations, you can
include only one address in the payload. You must use the Address web service to
create an address for a household.
Create a Household Programmatically Using createHousehold

You can create households in Oracle Sales Cloud by calling the createHousehold
method. The sample payload for calling the createHousehold method is as follows.
Sample XML Payload
Payload to create a household of the type prospect (ZCA_PROSPECT)
<soap:Body>
<ns1:createHousehold
xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/householdSe
rvice/types/">
<ns1:household
rvice/">
<ns2:HouseholdName>SBS_HLD</ns2:HouseholdName>
<ns2:HouseholdSize>3</ns2:HouseholdSize>
<ns2:UniqueNameSuffix>Abc</ns2:UniqueNameSuffix>
<ns2:AverageAge>30</ns2:AverageAge>
<ns2:AnnualIncome>1000000</ns2:AnnualIncome>
<ns2:Child0to6Num>1</ns2:Child0to6Num>
<ns2:DependentsNum>2</ns2:DependentsNum>
<ns2:MedianAge>30</ns2:MedianAge>
<ns2:WealthAmt>10000000</ns2:WealthAmt>
<ns2:SourceSystemReferenceValue>SBS_HLD_131250</ns2:SourceSystemReferenceV
alue>
40
Service
<ns2:PrimaryAddress
ce/">
<ns3:AddressLine1>300 Oracle
Parkway</ns3:AddressLine1>
<ns3:City>Bengaluru</ns3:City>
</ns1:household>
</ns1:createHousehold>
</soap:Body>
</soap:Envelope>
Search for a Household Programmatically Using findHousehold

You can find household in Oracle Sales Cloud by calling the findHousehold method. The
payload for calling the findHousehold method is as follows:
Sample XML Payload
<soap:Body>
<ns1:findHousehold
rvice/types/">
<ns1:findCriteria
<ns2:fetchStart></ns2:fetchStart>
<ns2:fetchSize></ns2:fetchSize>
<ns2:filter>
<ns2:group>
<ns2:item>
<ns2:attribute>PartyNumber</ns2:attribute>
41
Contents
<ns2:value>CDRM_747827</ns2:value>
</ns2:item>
</ns2:group>
</ns2:filter>
</ns1:findCriteria>
<ns1:findControl
<ns2:retrieveAllTranslations></ns2:retrieveAllTranslations>
</ns1:findControl>
</ns1:findHousehold >
</soap:Body>
</soap:Envelope>
Update a Household and its Primary Address Programmatically Using

updateHousehold
You can update a household and its primary address in Oracle Sales Cloud by calling
the updateHousehold method. The sample payload for calling the updateHousehold
method is as follows:
Sample XML Payload
<soap:Body>
<ns1:updateHousehold
rvice/types/">
<ns1:household
rvice/">
<ns2:HouseholdName>UPDATED_SBS_HLD_227259</ns2:HouseholdName>
alue>
<ns2:PrimaryAddress
ce/">
42
Service
<ns3:City>Shimoga</ns3:City>
</ns1:household>
</ns1:updateHousehold>
</soap:Body>
</soap:Envelope>
Delete a Household Programmatically Using deleteHousehold

You can delete a household and its relationship with the households primary address in
Oracle Sales Cloud by calling the deleteHousehold method. The sample payload for
calling the deleteHousehold method is as follows:
Sample XML Payload
Party ID
<soap:Body>
<ns1:deleteHousehold
rvice/types/">
<ns1:household
rvice/">
</ns1:household>
</ns1:deleteHousehold>
</soap:Body>
</soap:Envelope>
Party Number
<soap:Body>
rvice/types/">
<ns1:household
rvice/">
</ns1:household>
</soap:Body>
</soap:Envelope>
43
Contents
SSR
<soap:Body>
rvice/types/">
<ns1:household
rvice/">
alue>
</ns1:household>
</soap:Body>
</soap:Envelope>
Retrieve a Household Programmatically Using getHousehold

You can retrieve a household based on the primary key identifier in Oracle Sales Cloud
by calling the getHousehold method. The sample payload for calling the getHousehold
Sample XML Payload
<soap:Body>
<ns1:getHousehold
rvice/types/">
</ns1:getHousehold>
</soap:Body>
</soap:Envelope>
Merge a Household Programmatically Using mergeHousehold

You can create a household or update a household if it already exists in Oracle Sales
Cloud by calling the mergeHousehold method. The sample payload for calling the
mergeHousehold method is as follows:
Sample XML Payload
<soap:Body>
44
Service
<ns1:mergeHousehold
rvice/types/">
<ns1:household
rvice/">
<ns2:HouseholdName>UPDATED_SBS_HLD_227421</ns2:HouseholdName>
<ns2:PrimaryAddress
ce/">
<ns3:SourceSystemReferenceValue>ADD_SBS_227421</ns3:SourceSystemReferenceV
alue>
<ns3:City>Shimoga</ns3:City>
</ns1:household>
</ns1:mergeHousehold>
</soap:Body>
</soap:Envelope>

Households Using processHousehold
You can perform create, update, delete, or merge operation on a list of household rows
in Oracle Sales Cloud by calling the processHousehold method. The sample payload for
calling the processHousehold method is as follows:
Sample XML Payload
<soap:Body>
<ns1:processHousehold
rvice/types/">
<ns1:household
rvice/">
<ns2:HouseholdName>Household1</ns2:HouseholdName>
45
Contents
<ns2:EmailAddress>household1@oracle.com</ns2:EmailAddress>
</ns1:household>
<ns1:household
rvice/">
<ns2:HouseholdName>Household2</ns2:HouseholdName>
<ns2:EmailAddress>household2@oracle.com</ns2:EmailAddress>
</ns1:household>
<ns1:processControl
</ns1:processHousehold>
</soap:Body>
</soap:Envelope>
Managing Addresses Using the Simplified Sales Cloud Address

Web Service (AddressService)
Call the Sales Cloud Address service (AddressService) to provide a representation of the
Address entity in Oracle Sales Cloud.
Create an Address Programmatically Using createAddress

You can create addresses in Oracle Sales Cloud by calling the createAddress method.
The sample payload for calling the createAddress method is as follows.
Sample XML Payload
Payload to create an address

<soap:Body>
<ns1:createAddress
xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/addressServ
ice/types/">
46
How do I ? Managing Addresses Using the Simplified Sales Cloud Address Web Service
(AddressService)
<ns1:address
ice/">
<ns2:PrimaryFlag>true</ns2:PrimaryFlag>
<ns2:Address1>300 Oracle Parkway</ns2:Address1>
<ns2:City>Redwood City</ns2:City>
<ns2:State>CA</ns2:State>
<ns2:Country>US</ns2:Country>
<ns2:AddressNumber>SBS1291252</ns2:AddressNumber>
<ns2:SourceSystem>DNB</ns2:SourceSystem>
<ns2:SourceSystemReferenceValue>ADD1291253</ns2:SourceSystemReferenc
eValue>
<ns2:AddressPurpose>
<ns2:Purpose>BILL_TO</ns2:Purpose>
</ns2:AddressPurpose>
<ns2:Purpose>PAY_TO</ns2:Purpose>
</ns1:address>
</ns1:createAddress>
</soap:Body>
</soap:Envelope>
Search for an Address Programmatically Using findAddress

You can find address in Oracle Sales Cloud by calling the findAddress method. The
sample payload for calling the findAddress method is as follows.
Sample XML Payload
<soap:Body>
<ns1:findAddress
ice/types/">
<ns1:findCriteria
<ns2:filter>
<ns2:group>
<ns2:item>
47
Contents
<ns2:attribute>PartyId</ns2:attribute>
<ns2:value>300100046210740</ns2:value>
</ns2:item>
</ns2:group>
</ns2:filter>
</ns1:findCriteria>
<ns1:findControl
<ns2:retrieveAllTranslations>TRUE</ns2:retrieveAllTranslations>
</ns1:findControl>
</ns1:findAddress>
</soap:Body>
</soap:Envelope>
Update an Address and Address Purpose Programmatically Using

updateAddress
You can update an address and Address Purpose in Oracle Sales Cloud by calling the
updateAddress method. The sample payload for calling the updateAddress method is
as follows:
Sample XML Payload
Address ID
<soap:Body>
<ns1:updateAddress
ice/types/">
<ns1:address
ice/">
<ns2:AddressId>300100089301612</ns2:AddressId>
<ns2:DoNotMailFlag>TRUE</ns2:DoNotMailFlag>
<ns2:Address1>400 Commerce at Mantri</ns2:Address1>
48
(AddressService)
<ns2:Description>Updating the
Addressline1</ns2:Description>
</ns1:address>
</ns1:updateAddress>
</soap:Body>
</soap:Envelope>
Address Number
<soap:Body>
<ns1:updateAddress
ice/types/">
<ns1:address
ice/">
<ns2:DoNotMailFlag>FALSE</ns2:DoNotMailFlag>
<ns2:Address1>400 PTP</ns2:Address1>
<ns2:City>BDVT</ns2:City>
</ns1:address>
</soap:Body>
</soap:Envelope>
Update with SSR

<soap:Body>
<ns1:updateAddress
ice/types/">
<ns1:address
ice/">
<ns2:PrimaryFlag>FALSE</ns2:PrimaryFlag>
<ns2:Address2>UPDATED</ns2:Address2>
49
Contents
<ns2:SourceSystemReferenceValue>ADD129103</ns2:SourceSystemReferenceValue>
</ns1:address>
</soap:Body>
</soap:Envelope>
Delete an Address Programmatically Using deleteAddress

You can delete an address in Oracle Sales Cloud by calling the deleteAddress method.
The sample payload for calling the deleteAddress method is as follows:
Sample XML Payload
Address ID
<soap:Body>
<ns1:deleteAddress
ice/types/">
<ns1:address
ice/">
</ns1:address>
</ns1:deleteAddress>
</soap:Body>
</soap:Envelope>
Address Number
<soap:Body>
<ns1:deleteAddress
ice/types/">
<ns1:address
ice/">
</ns1:address>
</soap:Body>
</soap:Envelope>
50
(AddressService)
Address SSR
<soap:Body>
<ns1:deleteAddress
ice/types/">
<ns1:address
ice/">
<ns2:SourceSystemReferenceValue>ADDSSR01122</ns2:SourceSystemReferenceValu
e>
</ns1:address>
</soap:Body>
</soap:Envelope>
Retrieve an Address Programmatically Using getAddress

You can retrieve an address in Oracle Sales Cloud by calling the getAddress method.
The sample payload for calling the getAddress method is as follows:
Sample XML Payload
<soap:Body>
<ns1:getAddress
ice/types/">
</ns1:getAddress>
</soap:Body>
</soap:Envelope>
Merge an Address Programmatically Using mergeAddress

You can merge an address in Oracle Sales Cloud by calling the mergeAddress method.
The sample payload for calling the mergeAddress method is as follows:
Sample XML Payload
Address ID
51
Contents
<soap:Body>
<ns1:mergeAddress
ice/types/">
<ns1:address
ice/">
<ns2:Address1>400 Commerce at Mantri_using
merge</ns2:Address1>
</ns1:address>
</ns1:mergeAddress>
</soap:Body>
</soap:Envelope>
Address Number
<soap:Body>
<ns1:mergeAddress
ice/types/">
<ns1:address
ice/">
<ns2:Address1>400 PTP UPDATE USING MERGE</ns2:Address1>
<ns2:City>BDVT</ns2:City>
</ns1:address>
</ns1:mergeAddress>
52
How do I ? Managing Relationships Using the Simplified Sales Cloud Relationship Web
Service
</soap:Body>
</soap:Envelope>
Update with SSR

<soap:Body>
<ns1:updateAddress
ice/types/">
<ns1:address
ice/">
<ns2:PrimaryFlag>TRUE</ns2:PrimaryFlag>
<ns2:Address2>UPDATED USING MERGE</ns2:Address2>
<ns2:SourceSystemReferenceValue>ADD129103</ns2:SourceSystemReferenceValue>
</ns1:address>
</soap:Body>
</soap:Envelope>
Managing Relationships Using the Simplified Sales Cloud

Relationship Web Service
Call the Sales Cloud Relationship service (RelationshipService) to create, update,
retrieve, and delete relationships.
Create a Relationship Programmatically Using createRelationship

You can create relationship in Oracle Sales Cloud by calling the createRelationship
method. The sample payload for calling the createRelationship method is as follows.
Sample XML Payload
Payload to create a relationship between a contact to account with Primary key and Alt Key
Primary Key
<soap:Body>
53
Contents
<ns1:createRelationship
xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/salesParties/relationshi
pService/types/">
<ns1:relationship
pService/">
<ns2:ObjectPartyId>300100039444422</ns2:ObjectPartyId>
<ns2:SubjectPartyId>300100039444433</ns2:SubjectPartyId>
<ns2:RelationshipType>CONTACT</ns2:RelationshipType>
<ns2:RelationshipCode>CONTACT_OF</ns2:RelationshipCode>
<ns2:StartDate>2020-11-17</ns2:StartDate>
<ns2:EndDate>2025-12-31</ns2:EndDate>
<ns2:Comments>FUTURE DATE
RELATIONSHIP</ns2:Comments>
</ns1:relationship>
</ns1:createRelationship>
</soap:Body>
</soap:Envelope>
Alternate Key
<soap:Body>
<ns1:createRelationship
pService/types/">
<ns1:relationship
pService/">
<ns2:Comments>CURRENT DATE</ns2:Comments>
<ns2:SubjectPartyNumber>CDRM_414573</ns2:SubjectPartyNumber>
<ns2:ObjectPartyNumber>SBS_AACT_2171247</ns2:ObjectPartyNumber>
</ns1:relationship>
</ns1:createRelationship>
</soap:Body>
</soap:Envelope>
54
Service
Search for a Relationship Programmatically Using findRelationship

You can find relationship in Oracle Sales Cloud by calling the findRelationship method.
The sample payload for calling the findRelationship method is as follows.
Sample XML Payload
<soap:Body>
<ns1:findRelationship
pService/types/">
<ns1:findCriteria
<ns2:filter>
<ns2:group>
<ns2:item>
<ns2:attribute>SubjectPartyId</ns2:attribute>
<ns2:value>300100044841487</ns2:value>
</ns2:item>
<ns2:item>
<ns2:attribute>ObjectPartyId</ns2:attribute>
<ns2:value>300100044841494</ns2:value>
</ns2:item>
</ns2:group>
</ns2:filter>
</ns1:findCriteria>
<ns1:findControl
<ns2:retrieveAllTranslations></ns2:retrieveAllTranslations>
</ns1:findControl>
55
Contents
</ns1:findRelationship>
</soap:Body>
</soap:Envelope>
Update a Relationship and its Primary Address Programmatically Using

updateRelationship
You can update a relationship and its primary address in Oracle Sales Cloud by calling
the updateRelationship method. The sample payload for calling the updateRelationship
Sample XML Payload
<soap:Body>
<ns1:updateRelationship
pService/types/">
<ns1:relationship
pService/">
<ns2:Comments>Updating End Date</ns2:Comments>
</ns1:relationship>
</ns1:updateRelationship>
</soap:Body>
</soap:Envelope>
Merge a Relationship Programmatically Using mergeRelationship

You can merge a relationship by calling the mergeRelationship method. The sample
payload for calling the mergeRelationship method is as follows.
Sample XML Payload
Primary Key
<soap:Body>
<ns1:mergeRelationship
pService/types/">
56
Service
<ns1:relationship
pService/">
<ns2:RelationshipType>MEMBERSHIP</ns2:RelationshipType>
<ns2:RelationshipCode>MEMBER_OF</ns2:RelationshipCode>
<ns2:StartDate>2030-11-17</ns2:StartDate>
<ns2:Comments>FUTURE DATE RELATIONSHIP WITH
CONTACT</ns2:Comments>
</ns1:relationship>
</ns1:mergeRelationship>
</soap:Body>
</soap:Envelope>
Alternate Key
<soap:Body>
<ns1:mergeRelationship
pService/types/">
<ns1:relationship
pService/">
<ns2:RelationshipType>MEMBERSHIP</ns2:RelationshipType>
<ns2:RelationshipCode>MEMBER_OF</ns2:RelationshipCode>
<ns2:Comments>CURRENT DATE</ns2:Comments>
<ns2:SubjectPartyNumber>CDRM_414607</ns2:SubjectPartyNumber>
<ns2:ObjectPartyNumber>CDRM_415617</ns2:ObjectPartyNumber>
</ns1:relationship>
</ns1:mergeRelationship>
</soap:Body>
</soap:Envelope>
57
Contents

Relationships Using processRelationship
You can perform a create, update, delete, or merge operation on a list of relationship
rows in Oracle Sales Cloud by calling the processRelationship method. The sample
payload for calling the processRelationship method is as follows.
Sample XML Payload
<soap:Body>
<ns1:processRelationship
pService/types/">
<ns1:relationship
pService/">
</ns1:relationship>
<ns1:processControl
</ns1:processRelationship>
</soap:Body>
</soap:Envelope>
58
Invoking A Simplified Web

Service Using Web Service Proxy
Clients
You can use an appropriate IDE to develop a proxy client on a platform of your choice
such as Java, .Net, or ASP to call Web services and integrate applications with Oracle
Sales Cloud using Web services. You can use any IDE that supports the SOAP standards
and conforms to WS Security 1.1 policies to develop the client application. You can
build a static proxy, dynamic proxy, or a dynamic-static proxy depending on your
business requirements.
Points to Consider While Designing Web Service Proxy Clients

You must consider the pros and cons of static proxies:
Pros:
Proxy compiled at design time
Collection of classes usually generated (e.g. JAX-B), helps with the development
Quick and easy for POCs and implementations where the server contract
doesnt change dramatically, or uses standard fields
Cons
If a developer adds a field to the Oracle Sales Cloud then these fields are added
to the WSDL. Unless the proxy is re-generated then these fields wont be seen by
the code
You should also keep in mind the benefits of dynamic proxies:
Compile nothing at development time, all resolved at runtime
Application retrieves WSDL, dynamically constructs calls

Able to manage customizations and dynamicity in WSDL
More robust for production use
However, dynamic proxies are more complex to develop.

Some other factors that could impact your choice of Web service proxy type are
follows:
The need to add new custom fields or custom child objects changes the payload
The need to integrate with multiple sales Cloud tenants, each having different
customizations
Publishing applications to Oracle Marketplace, you want to make sure your web
service works on everyone's tenant instance
Static Web Service proxies may not be able to manipulate new custom fields easily
59
Contents
Invoking A Simplified Web Service Using A Static Proxy

Some of the IDEs that you can use to build Web service static proxy clients are
JDeveloper, Eclipse, and NetBeans.
The following procedure describes how to build a Web service proxy client using Oracle
JDeveloper.
1. Launch Oracle JDeveloper IDE in Default role.
2. Click on the File menu and select New
3. In the New Gallery dialog, select Generic Project and Click OK
4. In the Create Generic Project Dialog, specify the Project Name and Directory, and
then click Finish.
60
Invoking A Simplified Web Service Using Web Service Proxy Clients Invoking A Simplified
Web Service Using A Static Proxy
5. Right click on the project and click on new (CTRL+N).

6. In the New Gallery dialog, under Business Tier select Web Services and then Web
Service Proxy
7. Click OK.
8. In the Create Web Service Proxy wizard, click Next.
61
Contents
9. Select JAX-WS Style and click Next.
10. Enter URL of the WSDL in the format :
http://<crm_server:PortNumber>/crmCommonSalesParties/AccountService?
WSDL.
62
Invoking A Simplified Web Service Using Web Service Proxy Clients Invoking A Simplified
Web Service Using A Static Proxy
11. Deselect Copy WSDL into Project.

12. Click Next.
13. Click Next.
14. Click Next.
15. Select oracle/wss11_saml_token_with_message_protection_client_policy
63
Contents
16. Click Next.

17. Click Finish and wait for proxy generation.
18. Double Click on AccountServiceSoapHttpPortClient.java which is basically the file to
be edited to invoke the service.
19. Add your custom code to call the desired methods, such as createAccount,
updateAccount, or deleteAccount, or with the required input parameters.
Note: See Appendix B for sample code to call the different methods. The appendix contains code for a
sample a static Web Service Proxy -JAX-WS Style built with Oracle JDeveloper Studio for the Sales Cloud
Account Web service.
Authentication
In order to authenticate to the Sales Cloud application, one of the 2 security policies
listed below have to be adhered to. The policies are managed by Oracle Web Services
Manager.
oracle/wss_username_token_over_ssl_client_policy
This policy includes credentials in the WS-Security UsernameToken header in the SOAP
request messages. The plain text mechanism is supported. The policy uses SSL for
achieving transport layer security.
The following is an example of an authentication mechanism to Sales Cloud. This is a
code snippet written in the Java programming language, demonstrating the
authentication code to login to a Fusion environment using the username token over SSL
policy. In order for this code snippet to run, the OWSM agent should be present and
64
Invoking A Simplified Web Service Using Web Service Proxy Clients Authentication
running. In this approach the OWSM agent is embedded in webLogic 11g or

JDeveloper 11g.
Authentication - Username token over SSL
oracle/wss11_username_token_with_message_protection_client_policy
The username_token_message_protection policy requires that the public Oracle

certificate (Service Public key) is referenced by the client as rcpt-key alias.
rcpt-key-alias : Service Public key

Encrypting symmetric key which is used for SAML+Body signature/encryption
One approach is to leverage the OWSM agent. In such an approach, a keystore needs
to be generated by the client and stored on the client machine. A keystore holds the
user alias, the appropriate keys and its corresponding values which are required in order
to authenticate to the Fusion environment.
The public Oracle certificate file can be obtained from the Fusion WSDL and can be
imported to the keystore under the rcpt-key-alias. The Oracle certificate file can be
imported to the keystore using the keytool commands listed below.
Import Oracle certificate to a keystore file

keytool -importcert -alias nameoforaclekey -file oraclecertificatefile.cer -keystore
oracle-keystore.jks -storepass keystorepassword
List the contents of a keystore
keytool -list -keystore ".oracle-keystore.jks"
The client should store the keystore file to their local machine and reference the keystore
file in their client application in order to authenticate to the Fusion environment.
The following is an example of an authentication mechanism to Sales Cloud. This is a
code snippet written in the Java programming language, demonstrating the
authentication code to login to a Fusion environment using the username token with
message protection policy. In order for this code snippet to run, the OWSM agent should
65
Contents
be present and running. In this approach the OWSM agent is embedded in webLogic
11g or JDeveloper 11g.
Authentication -- Username token and message protection

Note: The above examples represent a single approach to authenticate to Sales Cloud web services
using Java as the programming language and JDeveloper 11g as the IDE. Any development platform
which complies with WS Security policies 1.1 can be used to authenticate to Sales Cloud web services.
For further information regarding extracting Oracle public certificate from a Fusion
WSDL, please refer to Appendix C: Extracting Oracle Public Certificate from Fusion WSDL
66
Sales Cloud Account Simplified

Web Services Interface
Call the Sales Cloud Account service to create, update, find, and delete organization
accounts. Organization accounts contain the following information: organization
profile, sales profile, contact information (primary address, phone, fax, email and URL),
industry classification and account hierarchy. This service manages simple
organization accounts, and does not support organization accounts with additional
names and identifiers, multiple sets of addresses, contacts, industry classification
information, email and phone and resources associated with the sales profile.
Related Services:
Sales Cloud Address: This service can be used to add additional address to the
organization account, once it is created using the Sales Cloud Account service.
Sales Cloud Relationship: This service can be used, in combination with the Contact
service, to define additional contacts on the organization account, once it is
created using the Sales Cloud Account service.
Sales Cloud Household: If you have requirements to create a household account

rather than an organization account, use this service instead.
Sales Cloud Contact: If you have requirements to create a contact account rather
than an organization account, use this service instead.
Sales Party: This service is similar to the Sales Cloud Account service in that it creates
organization accounts. However, it is used for more complex organization accounts,
has prerequisite invocation steps, and has a more complex hierarchical service
interface rather than flattened structure. If organization account requirements are
met by the Sales Cloud Account service, then use the Sales Cloud Account service
because it is easier to use.
Sales Account Service: This service is used to add sales accounts to existing accounts
in a multiple sales account scenarios. Although this service name is similar, this
service is used for a different use case scenario.
Life Cycle
Active
QName
{http://xmlns.oracle.com/apps/crmCommon/salesParties/accountService/}AccountSer
vice
Relationships
Type
Relationship To
67
Sales Cloud Account Simplified Web Services Interface
Type
Relationship To
Handles
Sales Cloud Account SDO
Handles
Sales Cloud Primary Address

SDO
Body Text
Body Text
Operations
Available Operations:
createAccount
deleteAccount
findAccount
getAccount
mergeAccount
processAccount
processCSAccount
updateAccount
createAccount
Creates an organization account and its primary address.
Life Cycle
Active
Request Payload
68
Element
Name
Type
Description
account
Sales
Cloud
Account
SDO
The account to create.
Sales Cloud Account Simplified Web Services Interface Operations
Response Payload
Name
Type
Description
result
Sales
Cloud
Account
SDO
The account which is created.
deleteAccount
Deletes an account and the relationship between the account and address objects
indicating the address is a primary address. The address object cannot be deleted
using this operation. To delete the address, use the Sales Cloud Address service.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
account
Sales
Cloud
Account
SDO
The account to delete.
Response Payload
Name
Type
Description
result
MethodR
esult
Not applicable.
findAccount
Finds a list of accounts based matching the supplied criteria pertaining to the object.
Life Cycle
Active
69
Operations
Request Payload
Element
Name
Type
Description
findCriteria
FindCriteria
The criteria used to find the account, such as

the filter,
the fetch size, and so on.
findControl
FindControl
Response Payload
Name
Type
Description
result
Sales
Cloud
Account
SDO
The list of accounts that match the filter criteria.
getAccount
Retrieves the account based on the primary key identifier.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
PartyId
Long
The identifier of the account you want to retrieve.
Response Payload
70
Name
Type
Description
result
Sales
Cloud
Account
SDO
The account matching the party Id specified.
mergeAccount
Merges an account with another account. The service updates the object if it exists, else
inserts the object.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
account
Sales
Cloud
Account
SDO
The account to merge.
Response Payload
Name
Type
Description
result
AccountR
esult
Not applicable.
processAccount
Creates, updates, deletes, or merges a list of account rows. It performs the specified
operation on the accounts.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
changeOpera
tion
string
The action to perform on the account such as

Create, Update, Merge, or Delete.
account
Sales
Cloud
A list of accounts to be processed.
71
Operations
Account
SDO
processContro
l
ProcessC
ontrol
Attribute to manage the account processing such

as whether the valid data will be committed if
there are other invalid data in the same batch, or
whether the outbound will contain the key
attributes only or the full object.
Response Payload
Name
Type
Description
result
Sales
Cloud
Account
SDO
A list of Accounts that are successfully processed.
processCSAccount
Creates, updates, or deletes a list of accounts. The operation and objects depend on
the ChangeSummary object specified.
Life Cycle
Active
Request Payload
72
Element
Name
Type
Description
processData
ProcessD
ata
The object that is used to represent the changes

that have been made.
processContro
l
ProcessC
ontrol
Attribute to manage the account processing such

as whether the valid data will be committed if
there are other invalid data in the same batch, or
Response Payload
Name
Type
Description
result
ProcessD
ata
Result of the operation including the list of objects

created or updated. This also lists all warning and
informational messages.
updateAccount
An operation to update an account and primary address. When updating the primary
address information it is not necessary to include the primary or alternate keys for the
primary address. There is a one-to-one correspondence between the account and
primary address. If the alternate keys SourceSystem and SourceSystemReferenceValue
in the primary address are specified and they do not match the values in the existing
primary address, then a new source system reference is created with the existing primary
address values and values specified in the request payload, and the primary address is
updated to point to the newly created address object.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
account
Sales
Cloud
Account
SDO
The account to update.
Response Payload
Name
Type
Description
result
AccountR
esult
The account which is updated.
73

An account for a customer or prospect. This object is an aggregation of primary
account profile, and contact information, and references a single primary address.
QName
{http://xmlns.oracle.com/apps/crmCommon/salesParties/accountService/}Account
Relationships
Type
Relationship To
Contains
Sales Cloud Primary Address SDO
Handled by
Sales Cloud Account
Attributes (Alternate 1 Keys/Label/Properties sections with description)

Name
Type
AnalysisFiscalY
ear
Description
Properties
Creatable, Updateable
The fiscal year used as the source for financial
information.
BusinessReport
Properties
The Dun & Bradstreet business information report.
BusinessScope
string
Properties
The class of business to which the account
belongs, such as local, national, or international.
CEOName
string
Properties
74
Sales Cloud Account Simplified Web Services Interface Sales Cloud Account SDO
The name of the organizations chief executive

officer.
CEOTitle
string
Properties
The formal title of the chief executive officer.
CertificationLe
vel
string
Properties
The certification level the organization. A list of
valid certification level codes is defined using the
lookup HZ_PARTY_CERT_LEVEL. Review the Review
and update the codes using the Setup and
Maintenance work area, Manage Trading
Community Common Lookups task.
CertificationR
easonCode
string
Properties
The reason for the contact's current certification
level assignment. A list of valid certification reason
codes are defined using the lookup
HZ_PARTY_CERT_REASON. Review and update the
codes using the Setup and Maintenance work
area, Manage Trading Community Common
Lookups task.
Comments
string
Properties
The corporate charter of the organization.
Congressional
DistrictCode
String
Properties
The U.S. Congressional district code for the
account.
ControlYear
Number
Properties
75
The year when current ownership gained control
of the organization.
CorpCurrency
Code
String
The corporate currency code used by the CRM

Extensibility framework. It is defaulted to the value
set in the profile option
ZCA_COMMON_CORPORATE_CURRENCY.
CorporationCl
ass
string
Properties
The taxation classification for corporation entities
such as Chapter S in the US.
CreatedBy
String
The user who created the account record.
CreatedByMo
dule
String
Properties
Creatable
The module that created the account record.
76
CreationDate
Date
The date when the record was created.
CurcyConvRa
teType
String
The currency conversion rate type. This attribute is

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

Extensibility framework. A list of valid values is
defined in the lookup
ZCA_COMMON_CORPORATE_CURRENCY. Review
and update the profile option using the Setup and
Options task.
CurrentFiscalY
earPotentialR
evenueAmou
Number
Properties
nt
The estimated revenues that can be earned by
the organization during its current fiscal year.
DataCloudSta
tus
String
Properties
The enrichment status of the contact record from
Data-as-a-Service. A list of valid values are defined
in the lookup DATA_CLOUD_STATUS. Review and
update the codes using the Setup and
Maintenance work area, Manage Standard
Lookups task.
Disadvantage
Indicator
boolean
Properties
Indicates whether the organization is considered
disadvantaged by the US government under Title
8A. If the value is Yes, the organization is
considered disadvantaged under Title 8A. The
default value is No.
DomesticUltim
ateDUNSNum
ber
number
Properties
The DUNS Number for the Domestic Ultimate. A
Domestic Ultimate is the highest member of the
same country in the organization's hierarchy. An
organization can be its own Domestic Ultimate.
DoNotConfus
eWith
string
Properties
Indicates that there is an organization that is
similarly named.
DUNSCreditRa
ting
string
Properties
77
The Dun & Bradstreet credit rating.

DUNSNumber
number
Properties
The DUNS Number in freeform text format. The
value not restricted to nine digit number.
EmailAddress
string
Properties
The e-mail address of the contact point for the
organization.
EmailFormat
string
Properties
The preferred format for e-mail addressed to this
organization, such as HTML or ASCII.
EmployeesAtP
rimaryAddress
Number
Properties
The qualifier to calculate the estimated number of
employees at the primary address. A list of valid
qualifier codes are defined using the lookup
EMP_AT_PRIMARY_ADR_EST_IND. Review and
EmployeesAtP
rimaryAddress
Estimation
String
Properties
The estimated minimum number of employees at
the primary address. A list of accepted values are
defined in the lookup type
EMP_AT_PRIMARY_ADR_MIN_IND. Review and
update the values using the Setup and
78

EmployeesAtP
rimaryAddress
Minimum
Number
Properties
The qualifier to qualify calculation of employees at
the primary address as minimum.
EmployeesAtP
rimaryAddress
Text
String
Properties
The number of employees at the referenced
address in text format.
EmployeesTot
al
Number
Properties
The total number of employees in the organization.
ExportIndicato
r
Boolean
Properties
Indicates whether the organization is an exporter.
If the value is Y, then the organization is an
exporter. The default value is N.
FaxAreaCode
Number
Properties
The area code for the fax number.
FaxCountryCo
de
Number
Properties
The international country code for a fax number,
such as 33 for France.
FaxExtension
Number
Properties
79
The extension to the fax number of the
organization.
FaxNumber
Number
Properties
The fax number of the organization in the local
format. The number should not include area code,
country code, or extension.
FiscalYearend
Month
String
Properties
The last month of a fiscal year for the organization.
The list of accepted values is defined in the lookup
type MONTH.
FormattedFax
Number
Number
The formatted fax number of the organization.
FormattedPho
neNumber
Number
The formatted phone number of the organization.
GeneralServic
esAdministrati
onFlag
Boolean
Properties
Indicates whether organization is a US federal
agency supported by the General Services
Administration (GSA). If the value is Y, then the
organization is supported by GSA. The default
value is N.
GlobalUltimat
eDUNSNumbe
r
Number
Properties
The DUNS Number for the Global Ultimate. A
Global Ultimate is the highest member in the
organization's hierarchy. An organization can be its
own Global Ultimate.
80
GrowthStrateg
yDescription
String
Properties
The user-defined description of growth strategy.
HomeCountry
String
Properties
The home country of the organization.
HQBranchIndi
cator
String
Properties
The status of this site, such as HQ, a branch, or a
single location. A list of accepted values are
defined in the lookup type HQ_BRANCH_IND.
ImportIndicat
or
Boolean
Properties
Indicates whether the organization is an importer.
If the value is Y, then the organization is an
importer. The default value is N.
IndustryCode
String
Properties
The Industry classification code. The classification
codes are defined for every classification
category as specified in IndustryCodeType
attribute. Review and update the codes using the
Setup and Maintenance work area, Manage
Classification Categories task.
IndustryCodeT
ype
String
The industry classification category code type. It is

defaulted to the value of profile option
MOT_INDUSTRY_CLASS_CATEGORY. Review and
Maintenance work area, Manage Classification
Categories task.
81
LaborSurplusIn
dicator
Boolean
Properties
Indicates whether the organization operates in an
area with a labor surplus. If the value is Y, then the
organization operates in an area with a labor
surplus. The default value is N.
LastEnrichmen
tDate
Date
Properties
The date when the record was last enriched.
LastUpdateDa
te
Date
The date when the record was last updated.
LastUpdatedB
y
String
The user who last updated the record.
LastUpdateLo
gin
String
The login of the user who last updated the record.
LegalStatus
String
Properties
The legal structure of the organization such as
partnership, corporation, and so on.
LineOfBusiness
String
Properties
The type of business activities performed at this
site.
LocalActivityC
ode
String
Properties
The local activity classification code.
LocalActivityC
82
String
Properties
odeType
The local activity classification code type identifier.
LocalBusinessI
dentifier
String
Properties
The primary identifier assigned to a businesses by a
government agency such as Chamber of
Commerce, or other authority. It is often used by
countries other than USA.
LocalBusinessI
dentifierType
String
Properties
The lookup that represents most common business
identifier in a country such as Chamber of
Commerce Number in Italy, Government
Registration Number in Taiwan. A list of accepted
values is defined in the lookup type
LOCAL_BUS_IDEN_TYPE.
MinorityOwne
dIndicator
Boolean
Properties
Indicates whether the organization is primarily
owned by ethnic or racial minorities. If the value is
Y, then the organization is owned by ethnic or
racial minorities. The default value is N.
MinorityOwne
dType
String
Properties
The type of minority-owned firm.
MissionStatem
ent
String
Properties
The corporate charter of organization in user-
83
defined text format.

NamedFlag
Boolean
Properties
Indicates if the sales account is a named sales
account. If the value is True, then the account is a
named account. The default value is False.
NextFiscalYear
PotentialReve
nueAmount
Number
Properties
The estimated revenue of the organization to be
earned during its next fiscal year.
OrganizationN
ame
String
Properties
Creatable, Required, Updateable
The name of the account.
OrganizationSi
ze
String
Properties
The size of an organization based on revenue,
number of employees, and so on. The accepted
values are defined in the lookup type
HZ_ORGANIZATION_SIZE.
OrganizationT
ype
String
Properties
The organization type value such as region,
division, and department.
OutOfBusinessI
ndicator
Boolean
Properties
Indicates whether the organization is out of
business. If the value is Y, then the organization is
84
out of business. The default value is N.

OwnerEmailA
ddress
String
Properties
The e-mail address of the employee resource that
owns and manages the sales account. The owner
is a valid employee resource defined within Sales
Cloud.
To assign an owner to the sales account, user can
provide one of the following attributes of the
resource: PartyID, PartyNumber or Email Address.
This is provided if user wants to change the owner
of the account or create account with a different
owner than the login user. If provided then
OwnerPartyID, OwnerPartyNumber, and
OwnerEmailAddress are used in this order to
determine the owner of the account.
OwnerPartyId
String
Properties
The unique identifier of a valid employee resource
who owns and manages the sales account.
To assign an owner to the sales account, user can
owner than the login user. The OwnerPartyID,
OwnerPartyNumber, and OwnerEmailAddress are
used in this order to determine the owner for the
account.
During create, if OwnerPartyID,
OwnerPartyNumber or OwnerEmailAddress are not
provided, then the account is assigned by default
to the login user's partyID.
OwnerPartyNu
mber
Number
Properties
85
The party number of a valid employee resource

who owns and manages the sales account. To
assign an owner to the sales account, user can
owner than the login user. The OwnerPartyID,
used in this order to determine the owner for the
account.
ParentAccoun
tPartyId
String
Properties
The party Id of the parent account within the
hierarchy. To assign a parent account to a sales
account, you must provide the parent account's
party ID, party number, or source system
reference.
ParentAccoun
tPartyNumber
Number
Properties
The party number of the parent account within the
hierarchy.
To assign a parent account to the given account,
provide parent account's Party Id, PartyNumber, or
Source System Reference and SourceSystem. The
account hierarchy is updated based on the
identified parent account.
ParentAccoun
tSourceSystem
String
Properties
The source system of the parent account within
the hierarchy.
86
To assign a parent account to the given account,

provide Party ID, PartyNumber, or Source System
Reference and SourceSystem. The account
hierarchy is updated based on the identified
parent account. Review and update the value for
this attribute using the Setup and Maintenance
work area, Manage Trading Community Common
Lookups task and editing the lookup type
HZ_ORIG_SYSTEMS_VL.
ParentAccoun
tSourceSystem
ReferenceVal
ue
String
Properties
The source system reference of the parent
account within the hierarchy.
To assign a parent account to an account,
provide the parent account's Party ID,
PartyNumber, or Source System Reference and
SourceSystem.
The account hierarchy is updated based on the
identified parent account.
ParentDUNSN
umber
Number
Properties
The DUNS Number of the organization or the
parent entity that owns a majority stake of the
organization's capital stock. The parent entity can
be a subsidiary of another corporation. If the
parent also has branches, then it is regarded as
headquarters as well as a parent company.
A headquarters is a business establishment that
has branches or divisions reporting to it, and is
financially responsible for those branches or
divisions. If the headquarters has more than 50% of
capital stock owned by another corporation, it
also will be a subsidiary. If it owns more than 50% of
capital stock of another corporation, then it is also
a parent.
87
ParentOrSubsi
diaryIndicator
String
Properties
Indicates whether the organization is a parent or
subsidiary.
PartyId
String
The unique identifier of the account.
PartyNumber
String
Properties
The unique alternate identifier for the account
party. You can update the value if the profile
option HZ_GENERATE_PARTY_NUMBER is set to True.
The default value is a concatenation of the value
specified in the profile option ZCA_PUID_PREFIX
and a unique system generated sequence
number.
PartyStatus
String
Indicates the status of the account. This is an

internally-used column and the values are defined
in the lookup HZ_STATUS. Review and update the
codes using the Setup and Maintenance work
area, Manage Trading Community Common
Lookups task.
PartyUniqueN
ame
String
The unique account name displayed on account

related screens. The default value is the
concatenation of attributes AccountName and
UniqueNameSuffix. If the attribute
UniqueNameSuffix is nil, then the AccountName is
concatenated with a system generated number.
PhoneAreaCo
de
Number
Properties
The area code for the telephone number.
PhoneCountry
Code
Number
Properties
The international country code for a telephone
88
number, such as 33 for France.

PhoneExtensio
n
Number
Properties
The extension to the phone number of the
organization.
PhoneNumber
Number
Properties
The phone number of the organization in the local
PreferredCont
actMethod
String
Properties
The preferred contact method of the organization.
The accepted values are defined in the lookup
type HZ_PREFERRED_CONTACT_METHOD. Review
PreferredFunc
tionalCurrenc
y
String
Properties
The organization's default currency code. A list of
valid currency codes are defined during the
application setup.
PrimaryAddres
s
String
Properties
The primary address of the account.
PrincipalNam
e
String
Properties
89
The name of the highest ranking person in the

organization.
PrincipalTitle
String
Properties
The title of the highest ranking person in the
organization.
PublicPrivate
OwnershipFla
g
Boolean
Properties
Indicates whether the organization is publically or
privately owned. If the value is Y, then the
organization is a privately owned organization. The
default value is N.
RegistrationTy
pe
String
Properties
Indicates the type of registration, such as
nonprofit. The accepted values are defined in the
lookup type REGISTRATION_TYPE.
RentOrOwnIn
dicator
String
Properties
Indicates if this contact owns or rents his or her
residence. A list of valid values for rent, own, and
lease are defined in the lookup OWN_RENT_IND.
Review and update the codes using the Setup
and Maintenance work area, Manage Standard
Lookups task.
SiebelLocatio
n
String
Properties
The location of account. This is an optional part of
User Primary Key.
90
SmallBusinessI
ndicator
Boolean
Properties
Indicates whether the organization is considered
as a small business. If the value is Y, then the
organization is considered as a small business. The
default value is N.
SourceSystem
String
Properties
Creatable
The name of external source system where the
account party is imported from. The values
configured in setup task Trading Community
Source System.
SourceSystem
ReferenceVal
ue
String
Properties
Creatable
The unique identifier for the account party from
the external source system specified in the
attribute SourceSystem.
StockSymbol
String
Properties
The corporate stock symbol of the organization as
listed in stock exchanges.
TaxpayerIdent
ificationNumb
er
String
Properties
The taxpayer identification number that is often a
unique identifier of the organization, such as
income taxpayer Id in USA and fiscal code or NIF
in Europe.
TotalEmploye
esEstimatedIn
dicator
String
Properties
91
Indicates if the employee total is estimated. The

accepted values are defined in the lookup type
TOTAL_EMP_EST_IND.
TotalEmploye
esIndicator
String
Properties
Indicates if subsidiaries are included in the
calculation of total employees. The accepted
values are defined in the lookup type
TOTAL_EMPLOYEES_INDICATOR.
TotalEmploye
esMinimumInd
icator
String
Properties
Indicates if the number is a minimum, maximum, or
average number of total employees. The
accepted values are defined in the lookup type
TOTAL_EMP_MIN_IND.
TotalEmploye
esText
String
Properties
The total number of employees in text format.
TotalPayment
Amount
Number
Properties
The total amount of payment collected from the
organization.
Type
String
Properties
The account type that defines if the account is a
sales account or a prospect or any other party
type. The accepted values are defined in the
lookup type ZCA_ACCOUNT_TYPE. It is defaulted to
ZCA_CUSTOMER if no value is provided.
92
UniqueNameS
uffix
String
Properties
The suffix used to generate the attribute
PartyUniqueName. The suffix is concatenated to
the OrganizationName attribute to generate the
PartyUniqueName. The primary address is
defaulted as the suffix.
URL
String
Properties
The uniform resource locator or a website
containing information about the organization.
WomanOwne
dIndicator
String
Properties
Indicates whether the organization is primarily
owned by women. If the value is Y, then the
organization is primarily owned by women. The
default value is N.
YearEstablishe
d
Number
Properties
The year that the organization started it business
operations.
YearIncorpora
ted
String
Properties
The year that the business was formally
incorporated.
93
Sales Cloud Contact Simplified

Call the Sales Cloud Contact service (ContactService) to create, update, retrieve, and
delete contacts. The service includes attributes related to contact profile, sales profile,
contact information, such as primary address, phone, fax, e-mail and URL, and
classification. This service covers all frequently used operations for contact. However, this
service does not support relationships, additional address, contact preferences, and
multiple instances of other child objects such as additional names, identifiers,
classification, phone, fax, e-mail, etc.
Related Services:
Sales Cloud Address: Service to add additional address to an existing contact.
Sales Cloud Relationship: Service to define additional account relationships for

an existing contact that can be used in combination with the Account and
Household service. Similarly, it can be used in combination with the Household
service to create members or contact relationships for a given household.
Sales Location and Person Service: Service to manage contacts and their
addresses.
Sales Party: Service similar to the Sales Cloud Account service that creates
organization accounts. However, it is used for more complex organization
accounts, has prerequisite invocation steps, and has a more complex
hierarchical service interface rather than flattened structure. If organization
account requirements are met by the Sales Cloud Account service, then use the
Sales Cloud Account service because it is easier to use.
Sales Account Service: Service to add sales accounts to existing accounts in a

multiple sales account scenarios. Although this service name is similar, this service
is used for a different use case scenario.
Life Cycle
Active
QName
{http://xmlns.oracle.com/apps/crmCommon/salesParties/contactService/}ContactServi
ce
Relationships
Type
Relationship To
Handles
Sales Cloud Contact SDO
Handles
95
Sales Cloud Contact Simplified Web Services Interface
Operations
Operations
getContact
createContact
updateContact
deleteContact
mergeContact
findContact
processContact
processCSContact
getContact
Retrieves the contact based on the primary key identifier.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
PartyId
long
The party identifier used to retrieve the contact.
Response Payload
96
Name
Type
Description
result
Sales
Cloud
Contact
SDO
Contact that matches the inbound key attributes.
Sales Cloud Contact Simplified Web Services Interface Operations
createContact
Creates a contact and its primary address.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
contact
Sales Cloud
Contact SDO
The contact to be created along with its primary

address.
Response Payload
Name
Type
Description
result
{http://xmlns.orac
le.com/apps/crm
C
The created contact.
ommon/salesParti
es/contactServic
e/
}ContactResult
updateContact
Updates a contact and its primary address. When updating the primary address
information it is not necessary to include the primary or alternate keys for the primary
address. There is a one-to-one correspondence between the contact and primary
address. If the alternate keys SourceSystem and SourceSystemReferenceValue in the
primary address are specified and they do not match the values in the existing primary
address, then no new address object is created. However, new SourceSystem or
SourceSystemReferenceValue are created for the existing primary address.
Life Cycle
Active
Request Payload
Element
Type
Description
97
Operations
Name
contact
Sales
Cloud
Contact
SDO
The contact to be updated along with its primary

address.
Response Payload
Name
Type
Description
result
{http://xm
lns.oracle.
com/app
s/crmC
The updated contact.
ommon/s
alesPartie
s/contact
Service/
}Contact
Result
deleteContact
Deletes a contact and the relationship between the contact and address objects
indicating the address is a primary address. The address object cannot be deleted
using this operation. To delete the address, use the Sales Cloud Address service.
Life Cycle
Active
Request Payload
98
Element
Name
Type
Description
contact
Sales
Cloud
Contact
SDO
The contact to be deleted along with its

relationship with address objects.
Response Payload
Name
Type
result
{http://xm
lns.oracle.
com/adf/
svc/type
Description
s/}Metho
dResult
mergeContact
Performs a merge on the contact. It will perform an update if the object exists or an
insert if the object doesn't exist.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
contact
Sales
Cloud
Contact
SDO
The contact to be merged.
Response Payload
Name
Type
Description
result
{http://xm
lns.oracle.
com/app
s/crmC
The merged contact.
ommon/s
alesPartie
s/contact
Service/
}Contact
99
Operations
Result
findContact
Finds a list of contacts based on matching the supplied criteria pertaining to the object.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
findCriteria
{http://xm
lns.oracle.
com/adf/
svc/type
The criteria used to limit your query

result, such as the filter (where
clause), the fetch size, and so on.
s/}FindCrit
eria
findControl
{http://xm
lns.oracle.
com/adf/
svc/type
The find control. Not currently used.
s/}FindCo
ntrol
Response Payload
Name
Type
Description
result
Sales
Cloud
Contact
SDO
A list of contact that satisfy the inbound criteria.
processContact
Performs a create, update, delete, or merge operation on a list of contact rows. It
performs the specified operation on the contacts.
100
Life Cycle
Active
Request Payload
Element
Name
Type
Description
changeOpera
tion
string
Indicates the action to be performed, such as

contact
Sales
Cloud
Contact
SDO
Properties
Unbounded
A list of contact to be processed.
processContro
l
{http://xm
lns.oracle.
com/adf/
svc/type
s/}Process
Control
Control your bulk upload behavior, such as

whether the valid data will be committed if there
are other invalid data in the same batch, and
Response Payload
Name
Type
Description
result
Sales
Cloud
Contact
SDO
A list of contact that are successfully processed.
processCSContact
Performs a create, update, or delete operation on a list of contact rows. The operation
and objects depend on the ChangeSummary object specified.
Life Cycle
Active
101
Request Payload
Element
Name
Type
Description
processData
{http://xm
lns.oracle.
com/adf/
svc/type

s/}Process
Data
processContro
l
{http://xm
lns.oracle.
com/adf/
svc/type
s/}Process
Control

Response Payload
Name
Type
Description
result
{http://xm
lns.oracle.
com/adf/
svc/type
Result of the operation including a list of

created/updated data objects, and all warning
and informational messages.
s/}Process
Data

A contact is a person who either has a relationship to other objects like account and
household or is a customer or prospect you directly sell to. A contact could be either a
buying customer in a B2C scenario or contact of an account in a B2B scenario. This
object is an aggregation of person profile, and contact information, and references a
single primary address.
QName
{http://xmlns.oracle.com/apps/crmCommon/salesParties/contactService/}Contact
102
Sales Cloud Contact Simplified Web Services Interface Sales Cloud Contact SDO
Relationships
Type
Relationship To
Contains
Sales Cloud Primary Contact SDO
Handled by
Sales Cloud Contact

Name
Type
Description
AcademicTitle
string
Properties
The part of the persons title that denotes the
academic qualification, such as Dr. Jane Smith.
AccountName
string
The name of the sales account that this contact

belongs to.
AccountPartyId
long
Properties
The unique identifier of sales account that this
contact belongs to. To specify the account for a
contact, you can provide an Account's party ID,
PartyNumber, SourceSystem, or
SourceSystemReference.
AccountPartyNu
mber
string
Properties
The party number of the sales account that this
contact belongs to. To specify the account for a
contact, you can provide an Account's party ID,
AccountSourceSy
stem
string
Properties
103
The source system code of the sales account that

this contact belongs to. To specify the account for
a contact, you can provide an Account's party ID,
AccountSourceSy
stemReferenceVa
lue
string
Properties
The source system reference value of the sales
account that this contact belongs to. To specify
the account for a contact, you can provide an
Account's party ID, PartyNumber, SourceSystem, or
AssignmentExcep
tionFlag
boolean
Properties
Indicates whether the sales account has the
required dimensions to allow assignment manager
to assign territories to the sales account. If the
value is True, then the sales account has the
required dimensions. The default is false.
CertificationLevel
string
Properties
The certification level of a contact. A list of
accepted values are defined in the lookup
HZ_PARTY_CERT_LEVEL. Review and update the
value for this attribute using the Setup and
CertificationReas
onCode
string
Properties
The reason for the contact's current certification
level assignment. A list of accepted values are
defined using the lookup HZ_PARTY_CERT_REASON.
Review and update the value for this attribute
104
using the Setup and Maintenance work area,

Manage Trading Community Common Lookups
task.
ClassificationCate
gory
string
Properties
A valid classification category code for the
contact. This is defined by an admin and is marked
as primary.
ClassificationCod
e
string
Properties
A valid classification code corresponding to the
classification category, which is marked as
primary.
Comments
string
Properties
The textual comments about a contact.
ContactIsPrimaryF
orAccount
string
Properties
The preferred contact for the account.
ContactName
string
Properties
The derived name of the contact.
ContactUniqueN
ame
string
The unique contact name displayed on contact

related screens. The default value for
ContactUniqueName is the concatenation of
attributes ContactName and UniqueNameSuffix. If
the attribute UniqueNameSuffix is nil, then the
ContactName is concatenated with a system
generated number.
105
CorpCurrencyCo
de
string
The corporate currency code associated with the

contact. This attribute is used by CRM Extensibility
framework. A list of accepted values is defined in
the lookup
CreatedBy
string
The user who created the contact record.
CreatedByModul
e
string
Properties
Creatable
The application module that created this contact
record. The default value for CreatedByModule is
HZ_WS for all Web service based creation.
A list of accepted values is defined in the lookup
type HZ_CREATED_BY_MODULES. Review and
update the value for this attribute using the Setup
and Maintenance task work area, Manage
Trading Community Common Lookups task.
106
CreationDate
timestamp
The date and time when the contact record was

created.
CurcyConvRateTy
pe
string
The currency conversion rate type associated with

the contact. This attribute is used by CRM
Extensibility framework. A list of accepted values is
defined in the lookup ZCA_COMMON_RATE_TYPE.
Manage Trading Community Common Lookups
task.
CurrencyCode
string
The currency code associated with the contact.

This attribute is used by CRM Extensibility
framework. A list of accepted values is defined in
the lookup
and update the value for this attribute using the
Trading Community Common Lookups task.
DataCloudStatus
string
Properties
The enrichment status of the contact record from
Data cloud. A list of accepted values are defined
in the lookup DATA_CLOUD_STATUS. Review and
Lookups task.
DateOfBirth
date
Properties
The date when the person was born.
DateOfDeath
date
Properties
The date when the person died.
DeceasedFlag
boolean
Properties
Indicates whether the person is deceased or not. If
the value is True, then the person is deceased. The
default is False.
DeclaredEthnicity
string
Properties
The declared ethnicity of the person.
Department
string
Properties
The free form text used to name the department
for the contact.
DepartmentCode
string
Properties
107
The department code for the contact. A list of

accepted values is defined in the lookup
DEPARTMENT_TYPE. Review and update the value
for this attribute using the Setup and Maintenance
work area, Manage Contact Lookups task.
DoNotCallFlag
boolean
Properties
Indicates if the user can call the person or not. If
the value is True, then the user must not call the
person. The default is False.
A list of accepted values is defined using the
lookup YES_NO. Review and update the value for
work area, Manage Common Lookups task.
DoNotContactFla
g
boolean
Properties
Indicates if the user can contact the person or not
by phone, e-mail, or mail. If the value is True, then
the user must not contact the person. The default
is False.
DoNotEmailFlag
boolean
Properties
Indicates if the user can e-mail the person or not. If
the value is True, then the user must not contact
the person by e-mail. The default is False.
108
DoNotMailFlag
boolean
Properties
Indicates if the user can send mail to the person or
not. If the value is True, then the user must not
contact the person by mail. The default is False.
EmailAddress
string
Properties
The e-mail address of the contact point.
EmailFormat
string
Properties
The preferred format for e-mail addressed to this
address such as HTML or ASCII. A list of accepted
values is defined using the lookup EMAIL_FORMAT.
Manage Standard Lookups task.
ExistingCustomerFl
ag
boolean
Properties
Indicates whether there is an existing selling or
billing relationship with the sales account. If the
value is true, then there is an existing relationship
with the sales account. The default value is False.
Such relationships are defined by the existence of
a Sell_To or Bill_To address.
ExistingCustomerFl
agLastUpdateDat
e
boolean
Properties
The date when the ExistingCustomerFlag was last
109
modified. It is internally populated by the

application.
FavoriteContactFl
ag
boolean
Properties
Indicates whether the person is a key contact. If
the value is true, then person is a key contact. The
default value is False.
FaxAreaCode
string
Properties
The area code within a country code.
FaxCountryCode
string
Properties
FaxExtension
string
Properties
The additional number addressed after initial
connection to an internal telephone system.
FaxNumber
string
Properties
A telephone number formatted in the local format
without the area code, country code, or
extension.
FirstName
string
Properties
First name of the person.
110
FormattedFaxNu
mber
string
The formatted fax number information.
FormattedMobile
Number
string
The formatted mobile phone number information.
FormattedWorkPh
oneNumber
string
The formatted work phone number information.
Gender
string
Properties
The gender of the person, such as male, female,
and unknown. A list of accepted values are
defined in the lookup HZ_GENDER. Review and
Lookups task.
HeadOfHousehol
dFlag
boolean
Properties
Indicates if the person is the head of the
household. If the value is True, then the person is
the head of the household. The default value is
False.
HomePhoneArea
Code
string
Properties
HomePhoneCoun
tryCode
string
Properties
HomePhoneNum
ber
string
Properties
111
The home phone number formatted in the local

format without the area code, country code, or
extension.
HouseholdIncom
eAmount
string
Properties
The income of the household that this person is a
part of.
HouseholdSize
bigdecimal
Properties
The size of the household this person is a part of.
Initials
string
Properties
The initials in the contacts name.
JobTitle
string
Properties
The free form text for job title.
JobTitleCode
string
Properties
The code given to the job title.
LastAssignmentD
ate
timestamp
Properties
The date when the Sales Account Territory
Assignment was last run by Assignment Manager.
LastAssignmentD
112
timestamp
The date and time when the Sales Account

Territory Assignment was last run by Assignment
ateTime
LastContactDate
Manager.
timestamp
Properties
The date when the contact was last contacted.
LastEnrichmentDa
te
date
Properties
The date when the contact record was last
enriched with data from external sources by using
Data-as-a-Service.
LastName
string
Properties
The last name of the person.
LastNamePrefix
string
Properties
The prefix for the last name of a person, such as
fon, van. For example, if a persons name is Hans
Van, the last name of the person is captured using
this attribute.
LastUpdateDate
timestamp
The date and time when the contact was last

updated.
LastUpdatedBy
string
The user who last updated the contact record.
LastUpdateLogin
string
The session login associated to the user who last

updated the contact record.
MaritalStatus
string
Properties
The marital status of the person. A list of accepted
values is defined in the lookup MARITAL_STATUS.
113

MaritalStatusEffec
tiveDate
date
Properties
The date when the person's marital status was
changed.
MiddleName
string
Properties
The middle name of the person.
MobileAreaCode
string
Properties
The area code for the contact's mobile phone.
MobileCountryCo
de
string
Properties
The international country code for a contacts
mobile phone number, such as 33 for France.
MobileExtension
string
Properties
MobileNumber
string
Properties
The mobile phone number formatted in the local
MyBusinessConta
114
boolean
Indicates if searching on business contact belongs
ct
to login user. If the value is True, then the business

contact belongs to login user. The default is false.
NamedFlag
string
Properties
Indicates whether a sales account is a named
sales account. If the value is true, then the sales
account is a named sales account. The default
value is False.
NameSuffix
string
Properties
The place in a family structure. For example, in
"Tom Jones III", the "III".
Note
string
Properties
The note about the contact.
OwnerEmailAddr
ess
string
Properties
The e-mail address of a valid employee resource
provide one of the following attributes pertaining
to the owner: PartyID, PartyNumber or E-mail
Address. This is provided if user wants to change
the owner of the contact or create contact with a
different owner than the login user. If provided,
then OwnerPartyID, OwnerPartyNumber, and
OwnerEmailAddress are honored in this order to
determine the owner for the contact.
OwnerName
string
The name of the sales account owner.
OwnerPartyId
long
Properties
115

who owns and manages the sales account. The
owner is a valid employee resource defined within
Sales Cloud. To assign an owner to the sales
account, user can provide one of the following
attributes pertaining to the owner: PartyID,
PartyNumber, or E-mail Address. This is provided if
user wants to change the owner of the contact or
create contact with a different owner than the
login user. If provided, then OwnerPartyID,
honored in this order to determine the owner for
the contact. During create, if none of the
OwnerPartyID, OwnerPartyNumber, or
OwnerEmailAddress is provided, then the contact
is assigned by default to the login user. The login
user's partyID is used to populate OwnerPartyID.
OwnerPartyNumb
er
string
Properties
The party number of a valid employee resource
provide one of the following attributes pertaining
to the owner: PartyID, PartyNumber, or E-mail
Address. This is provided if user wants to change
the owner of the contact or create contact with a
different owner than the login user. If provided,
then OwnerPartyID, OwnerPartyNumber, and
OwnerEmailAddress are honored in this order to
determine the owner for the contact.
PartyId
long
Keys
Primary Key
The unique internal identifier of a contact party.
One of PartyId, PartyNumber or PartySourceSystem
and PartySourceSystemReferenceValue keys is
required to uniquely identify the contact party.
PartyNumber
116
string
Keys
Alternate Key
Label
Registry ID (this would show when UI hint is
specified)
Properties
Updateable, Creatable
The unique alternate identifier for the contact
party. The default value for PartyNumber is the
value specified in the profile option
HZ_GENERATE_PARTY_NUMBER. You can update
the PartyNumber depending on the profile option
HZ_GENERATE_PARTY_NUMBER. A list of accepted
values is defined in the profile option
HZ_GENERATE_PARTY_NUMBER. Review and
and Maintenance work area, Manage Trading
Community Common Profile Options task.
PartyStatus
string
The status of the contact. A list of valid values are

defined in the lookup HZ_STATUS. Review and
Lookups task.
PersonalIncomeA
mount
string
Properties
The estimated gross annual income of the person.
PlaceOfBirth
string
Properties
The place where the person was born, such as city
or country.
PreferredContact
Method
string
Properties
117
The preferred method to contact the person. A list

of accepted values is defined in the lookup
HZ_PREFERRED_CONTACT_METHOD. Review and
and Maintenance work area, Manage Contact
Point Lookups task.
PreferredFunction
alCurrency
string
Properties
The default currency code for this contact. A list of
accepted values is defined using the Setup and
Maintenance work area, Manage Currencies task.
PreviousLastNam
e
string
Properties
The previous last name or surname of the person.
PrimaryAddress
string
Properties
The primary address of the contact.
RecordSet
string
Properties
The search results displayed under the selected
record set.
RentOrOwnIndica
tor
string
Properties
Indicates if this contact owns or rents his or her
residence. A list of valid values for rent, own, and
lease is defined in the lookup OWN_RENT_IND.
118
SalesAffinityCode
string
Properties
The affinity of a contact to the deploying
organization. A list of accepted values are defined
in the lookup HZ_SLS_CNTCT_AFFINITY_CODE.
Manage Contact Lookups task.
SalesBuyingRoleC
ode
string
Properties
The roles played by a contact in the buying
process, for example, decision maker or supporting
role. A list of accepted values is defined in the
lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review
and update the values for this attribute using the
Contact Lookups task.
SalesProfileStatus
string
Properties
A valid user defined status of the sales account.
SalesTeamMemb
er
string
Properties
The unique alternate identifier of the sales team
member.
Salutation
string
Properties
The size of the household this person is a part of.
SalutoryIntroducti
on
string
Properties
119
The title or a salutary introduction for a contact,

such as Mr., Herr, and so on. A list of accepted
values is defined in the lookup CONTACT_TITLE.
SecondLastName
string
Properties
The second last name for a person. A list of
accepted values is defined in the lookup
HZ_PERSON_PROFILES. Review and update the
value for this attribute using the Setup and
Lookups task.
SourceSystem
string
Keys
Composite Alternate Key [SourceSystem and
SourceSystemReference]
Properties
Creatable
The name of external source system where the
contact party is imported from. The values are
configured in Setup and Maintenance work area,
Manage Trading Community Source Systems task.
SourceSystemRef
erenceValue
string
Keys
Composite Alternate Key [SourceSystem,
SourceSystemReference]
Properties
Creatable
The alternate unique identifier for the contact
party from the external source system specified in
the attribute SourceSystem.
120
TaxpayerIdentific
ationNumber
string
Properties
The taxpayer identification number, which is often
a unique identifier of the contact. The typical
values are taxpayer Id in USA or fiscal code or NIF
in Europe.
Title
string
Properties
A professional or family title, such as Don or The
Right Honorable.
Type
string
Properties
The contact party type that defines whether the
contact is a sales account, a prospect, a contact
or any other user-defined party type. The default
value is ZCA_CUSTOMER. A list of accepted values
is defined in the lookup ZCA_CONTACT_TYPE.
UniqueNameSuffi
x
string
Properties
The system generated or manually overridden
suffix. The suffix is used to generate the
PartyUniqueName attribute and is concatenated
to the ContactName attribute to generate the
WorkPhoneAreaC
ode
string
Properties
The area code for the contact's work phone.
121
WorkPhoneCount
ryCode
string
Properties
The international country code for a contacts
work phone number, such as 33 for France.
WorkPhoneExtensi
on
string
Properties
WorkPhoneNumb
er
string
Properties
The work phone number formatted in the local
format without the area code, country code, or
extension.
122
Sales Cloud Household Simplified

Call the Sales Cloud Household service (HouseholdService) to create, update, find, and
delete the parties of type household. A household is a group that has accounts or
contacts as its members. This service covers attributes related to household profile, sales
profile, contact information (primary address, phone, and e-mail) and industry
classification. It does not support attributes for additional names and identifiers or
multiple sets of addresses, industry classifications, e-mail and phone numbers or
additional resources associated with the sales profile.
Related Services:
Sales Cloud Address: This service can be used to add additional address to an
existing household.
Sales Cloud Relationship: This service is used with the contact service to define
members or contacts for a household. It can be used with the account service to
define members for a household.
Trading Community Location Service and Trading Community Group Service: These
services are used to manage households and their addresses.
Life Cycle
Active
QName
{http://xmlns.oracle.com/apps/crmCommon/salesParties/householdService/}Household
Service
Relationships
Type
Relationship To
Handles
Sales Cloud Household SDO
Handles
Operations
getHousehold
createHousehold
updateHousehold
123
Sales Cloud Household Simplified Web Services Interface
deleteHousehold
mergeHousehold
findHousehold
processHousehold
processCSHousehold
Operations
getHousehold
Retrieves the household based on the primary key identifier.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
PartyId
long
The party identifier used to retrieve the household.
Response Payload
Name
Type
Description
Return
Sales
Cloud
Househol
d SDO
The household that matches the inbound key

attributes.
createHousehold
Creates a household and, optionally, its primary address.
Life Cycle
Active
Request Payload
124
Element
Name
Type
Description
household
Sales
The household to be created.
Sales Cloud Household Simplified Web Services Interface Operations
Cloud
Househol
d SDO
Response Payload
Name
Type
Description
result
{http://xmlns.o
racle.com/ap
ps/crmComm
on/salesPartie
s/householdSe
rvice/}Househ
oldResult
The household that is created.
updateHousehold
Updates a household and its primary address. When updating the primary address
information it is not necessary to include the primary or alternate keys for the primary
address. There is a one-to-one correspondence between the account and primary
address. SourceSystem and SourceSystemReferenceValue are the alternate keys. If
SourceSystem and SourceSystemReferenceValue in the primary address are specified
and they dont match the values in the existing primary address, then a new
SourceSystem/SourceSystemReferenceValue gets created for the existing primary
address.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
household
Sales
Cloud
Househol
d SDO
The household to be updated.
125
Operations
Response Payload
Name
Type
Description
Result
{http://xmlns.or
acle.com/apps
/crmC
The household that is updated.
ommon/salesPa
rties/householdS
erv
ice/}Household
Result
deleteHousehold
Deletes a household and its relationship with the primary address. The address object
can't be deleted using this operation. You can use the Sales Cloud Address service to
delete an address.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
household
Sales
Cloud
Househol
d SDO
The household to be deleted.
Response Payload
Name
Type
Description
Result
{http://xmlns.orac
le.com/adf/svc/ty
pe
Not applicable.
s/}MethodResult
126
mergeHousehold
Merges the household and updates the record. If the household doesnt exist, then the
operation inserts the household.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
household
Sales
Cloud
Househol
d SDO
The household to be merged.
Response Payload
Name
Type
Description
result
{http://xmlns.ora
cle.com/apps/cr
mC
The household that is merged.
ommon/salesPar
ties/householdSe
rv
ice/}HouseholdR
esult
findHousehold
Finds a list of households matching the supplied criteria pertaining to the object.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
127
findCriteria
{http://xmlns.
oracle.com/
adf/svc/type
Operations
The criteria used to limit the query result. For

example, the filter, such as the where clause, the
fetch size, and so on.
s/}FindCriteria
findControl
{http://xmlns.
oracle.com/
adf/svc/type
Find Control. Not currently used.
s/}FindContro
l
Response Payload
Name
Type
Description
result
Sales
Cloud
Househol
d SDO
A list of households meeting the criteria.
processHousehold
Performs bulk load operation for household.
Life Cycle
Active
Request Payload
128
Element Name
Type
Description
changeOperat
ion
String
Indicates what action shall be performed, such as

household
Sales
Cloud
Househol
d SDO
A list of households that should be processed.
processControl
{http://x
mlns.ora
cle.com/
adf/svc/t

ype
s/}Proces
sControl
Response Payload
Name
Type
Description
Result
Sales
Cloud
Househol
d SDO
A list of households that are successfully

processed.
processCSHousehold
Creates, updates, deletes, or merges a list of households. It performs the specified
operation on the households.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
processDat
a
{http://xmlns
.oracle.com
/adf/svc/typ
e

s/}ProcessDa
ta
processCon
trol
{http://xmlns
.oracle.com
/adf/svc/typ
e
s/}ProcessC
ontrol

129
Response Payload
Name
Type
Description
result
{http://xm
lns.oracle.
com/adf/
svc/type

created/updated data objects, and all warning
s/}Process
Data

An object that includes attributes used to store values while creating or updating a
household. A household is a group that has a relationship with either an account or a
contact.
QName
{http://xmlns.oracle.com/apps/cdm/foundation/parties/groupService/}Group
Relationships
Type
Relationship To
Contains
Handled By

Name
Type
Description
PartyId
long
Keys
Primary Key
The unique internal identifier of a household party.
This attribute is generated internally by the
application.
PartyNumber
130
strin
g
Keys
Alternate Key
Sales Cloud Household Simplified Web Services Interface Sales Cloud Household SDO
Label
Registry ID (this would show when UI hint is
specified)
Properties
Updateable, Creatable
The unique alternate identifier for the household
party. The default value is the value specified in
the profile option ZCA_PUID_PREFIX concatenated
with a unique generated sequence number. The
value is updateable depending on the profile
option HZ_GENERATE_PARTY_NUMBER. A list of valid
values is defined in the profile option
AnnualIncome
long
Properties
The annual income of the household. If not
provided, then the value is NULL.
AssignmentExcepti
onFlag
bool
ean
Properties
Read-only
Indicates whether the sales account had the
required dimensions to allow assignment manager
to assign territories to the sales account. Possible
values are True or False.
AverageAge
long
Properties
The average age of the members of the
131
household.
CertificationLevel
strin
g
Properties
The certification level of a household. A list of valid
certification level codes is defined in the lookup
HZ_PARTY_CERT_LEVEL. Review and update the
codes using the Setup and Maintenance task,
Manage Trading Community Common Lookups.
CertificationReason
Code
strin
g
Properties
The reason for the household current certification
level assignment. A list of valid certification reason
codes are defined using the lookup
HZ_PARTY_CERT_REASON. Review and update the
Manage Trading Community Common Lookups.
Child0to6Number
long
Properties
The number of children in the household less than
6 years of age.
Child13to18Number
long
Properties
The number of children in the household between
13 and 18 years of age.
Child7to12Number
long
Properties
The number of children in the household between
7 and 12 year of age
ClassificationCateg
132
strin
Properties
ory
A valid classification category code for the
household which will be marked as primary and is
defined by an admin.
ClassificationCode
Strin
g
Properties
A valid classification code corresponding to the
classification category and which will be marked
as primary.
Comments
Strin
g
Properties
The textual comments about the household.
CorpCurrencyCod
e
strin
g
The corporate currency code. A list of valid values

is defined in the lookup
Options task. This attribute is used by CRM
Extensibility framework.
CreatedBy
strin
g
The user who created the record.
CreationDate
strin
g
Date and time when the record was created.
CurcyConvRateTyp
e
strin
g

the household. This attribute is used by CRM
Review and update the profile option using the
Currency Profile Options task.
CurrencyCode
strin
g
The currency code attribute is used by CRM

defined in the lookup
133

Options task.
DependentsNumbe
r
long
Properties
The number of dependents in the household.
EmailAddress
Strin
g
Properties
The e-mail address of the contact point.
EmailFormat
Strin
g
Properties
Indicates the preferred format for e-mail, such as
HTML or ASCII.
ExistingCustomerFla
g
Bool
ean
Properties
Read-only
Indicates whether there is an existing selling or
billing relationship with the sales account. If the
value is true, then there is an existing relationship
with the sales account. The default value is False.
ExistingCustomerFla
gLastUpdateDate
Dat
e
Properties
Read-only
The date when the ExistingCustomerFlag was last
modified. It is internally populated by the
application.
FormattedPhoneNu
mber
strin
g
The formatted phone number information.
134
HouseholdName
Strin
g
Properties
The unique identification number for this party.
Data stored in this attribute comes from
PARTY_NUMBER in HZ_PARTIES.
HouseholdSize
Long
Properties
The size of the household or group.
LastAssignmentDat
e
Dat
e
Properties
Read-only
The date when the Sales Account Territory
Assignment was last run by Assignment Manager.
LastUpdateDate
Time
stam
p
Properties
Required, Searchable
The date and time when the record was last
updated.
LastUpdatedBy
strin
g
Properties
LastUpdateLogin
strin
g
Properties
Searchable
MedianAge
Long
Properties
Creatable, Searchable, Updateable
The median age of the members of the
135
household.
NamedFlag
Bool
ean
Properties
Indicates whether a sales account is a named
sales account. Possible values are True or False. If
the value is True, then the sales account is a
named sales account.
OwnerEmailAddress
strin
g
Properties
The email address of valid employee resource that
owns and manages the sales account. To assign
an owner to the sales account, you can either
provide owner's party ID, PartyNumber, or Email
Address.
OwnerPartyId
Long
Properties
assign an owner to the sales account, you must
provide either owner's party identifier, party
number, or email address.
OwnerPartyNumber
Strin
g
Properties
Party Number of a valid employee resource who
owns and manages the sales account. To assign
an owner to the sales account, you can either
provide owner's party ID, PartyNumber, or Email
Address.
PartyStatus
136
Strin
g
The status of the household. This is an internal

column and you are not expected to pass in a
value. A list of valid statuses are defined in the
lookup HZ_STATUS. Review and update the codes
using the Setup and Maintenance task, Manage
Trading Community Common Lookups.
PartyUniqueName
strin
g
The unique household name displayed on

household related screens. This is the derived
column. For Organization, it is concatenation of
unique_name_alias and suffix. For Person, this is
concatenation of person_name and suffix.
PhoneAreaCode
strin
g
Properties
PhoneCountryCod
e
Strin
g
Properties
The International country code for a telephone
PhoneExtension
Strin
g
Properties
PhoneNumber
strin
g
Properties
A telephone number formatted in the local
PreferredContactM
ethod
Strin
g
Properties
Indicates how a household prefers to be
contacted. Validated against lookup type
PREFERRED_CONTACT_METHOD. A list of valid
codes is defined in the lookup HZ_PREFERENCE.
and Maintenance task, Manage Trading
Community Common Lookups.
137
PreferredFunctional
Currency
Strin
g
Properties
The households default currency code. A list of
valid currency codes are defined using the Setup
and Maintenance work area, Manage Currency
Profile Options task.
PrimaryAddress
SourceSystem
orac
le.a
pps.
crm
Co
mm
on.s
ales
Parti
es.c
om
mon
Servi
ce.P
rima
ryAd
dres
s
Properties
Strin
g
Properties
The primary address of the household. Address
attributes of the household are grouped under a
PrimaryAddress entity for clarity.
Creatable
The name of external source system, which is
defined by an admin as part of system setup. It is
part of Alternate Key (along with
SourceSystemReference), and is mandatory if
Primary Key or PartyNumberBusinessKey is not
passed in update.
SourceSystemRefer
enceValue
strin
g
Properties
Creatable
The unique identifier for the household party from
the external source system specified in the
attribute SourceSystem. It is part of Alternate Key
138
(along with SourceSystemReference), and is

mandatory if Primary Key or
PartyNumberBusinessKey is not passed in update.
Type
strin
g
Properties
The household party type that defines whether the
household is a sales account or a prospect or any
other user-defined party type as specified using
the lookup type ZCA_ HOUSEHOLD _TYPE. It is
defaulted to ZCA_CUSTOMER if no value is
provided. Possible values are CUSTOMER or
PROSPECT. A list of valid values is defined in the
lookup ZCA_HOUSEHOLD_TYPE. Review and
Lookups task.
UniqueNameSuffix
Strin
g
Properties
The suffix used to generate the attribute
PartyUniqueName. The suffix is concatenated to
the householdName attribute to generate the
WealthAmount
{http
://x
mlns
.ora
cle.
com
/adf
/svc
/typ
e
Properties
The household's wealth amount or net worth. The
value is NULL if not given.
s/}A
mou
ntTy
pe
LastAssignmentDat
time
The date and time when the Sales Account
139
eTime
stam
p
Territory Assignment was last run by Assignment

Manager.
Note
Strin
g
Properties
The note about the household.
OwnerName
Strin
g
The name of a valid employee resource who owns

and manages the sales account.
PrimaryContactEm
ail
Strin
g
The e-mail address of the primary contact.
PrimaryContactNa
me
Strin
g
The name of the primary contact.
PrimaryContactPart
yId
Strin
g
Properties
The unique identifier of the primary contact. To
specify the contact for a household, you can
provide Contacts party ID, PartyNumber, or a
combination of SourceSystem and
PrimaryContactPart
yNumber
Strin
g
Properties
The party number of the primary contact. To
either provide Contact's party ID, PartyNumber, or
a combination of SourceSystem and
140
PrimaryContactPho
ne
Strin
g
The phone number of the primary contact.
PrimaryContactSou
rceSystem
Strin
g
Properties
The SourceSystem of the primary contact. To

either provide Contact's party ID, PartyNumber, or
a combination of SourceSystem and
PrimaryContactSou
rceSystemReferenc
eValue
Strin
g
Properties
The SourceSystemReference of the primary
contact. To specify the contact for a household,
you can either provide Contact's party ID,
PartyNumber, or a combination of SourceSystem
and SourceSystemReference.
RecordSet
Strin
g
The selected record set under which the search

results are displayed.
SalesProfileStatus
Strin
g
Properties
A valid user-defined status of the sales account
that this household belongs to.
SalesTeamMember
Strin
g
Properties
The sales team member who is associated to a
sales account.
141

Simplified Web Services Interface
Call the Sales Cloud Relationship service (RelationshipService) to create, update,

retrieve, and delete relationships. Accounts, contacts and household could have
various types of predefined relationships within Oracle Sales Cloud. A contact can have
a contact relationship with an account or household while it could also be a member of
a household. Other such relationships could exist between two contacts or between
two accounts or households. This service is used to manage all such relationships
between two parties. It is often used in conjunction with the Account, Contact or
Household service to create the subject and object participating in the relationship
before using this service to actually create the relationship.
Related Services
Trading Community Organization Service and trading Community Person Service are
two other services that could be used to manage relationships.
Life Cycle
Active
QName
http://xmlns.oracle.com/apps/crmCommon/salesParties/relationshipService/}Relation
shipService
Relationships
Type
Relationship To
Handles
Sales Cloud Relationship SDO
Operations
createRelationship
updateRelationship
deleteRelationship
mergeRelationship
findRelationship
processRelationship
processCSRelationship
getDfltObjAttrHints
143
Sales Cloud Relationship Simplified Web Services Interface
Operations
getServiceLastUpdateTime
getEntityList
createRelationship
Creates a relationship.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
relationship
Sales
Cloud
Relationsh
ip SDO
The relationship to be created.
Response Payload
Name
Type
Description
result
Sales
Cloud
Relationsh
ip SDO
The relationship which is created.
updateRelationship
Updates a relationship.
Life Cycle
Active
144
Sales Cloud Relationship Simplified Web Services Interface Operations
Request Payload
Element
Name
Type
Description
relationship
Sales
Cloud
Relationsh
ip SDO
The relationship to be updated.
Response Payload
Name
Type
Description
Result
Sales
Cloud
Relationsh
ip SDO
The relationship which is updated.
deleteRelationship
Deletes a relationship.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
relationship
Sales
Cloud
Relationsh
ip SDO
The relationship to be deleted.
Response Payload
Name
Type
Description
145
Result
void
Operations
Not applicable
mergeRelationship
Merges a relationship. It will perform an update if the object exists or an insert if the
object doesn't already exist.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
Relationship
Sales
Cloud
Relationsh
ip SDO
The relationship to be merged.
Response Payload
Name
Type
Description
Result
Sales
Cloud
Relationsh
ip SDO
Merged Relationship
findRelationship
Finds a relationship.
Life Cycle
Active
Request Payload
Element
Name
146
Type
Description
Sales Cloud Relationship Simplified Web Services Interface Operations
findCriteria
{http://xm
lns.oracle.
com/adf/
svc/type

clause), the fetch size, etc.
s/}FindCrit
eria
findControl
{http://xm
lns.oracle.
com/adf/
svc/type
s/}FindCo
ntrol
Response Payload
Name
Type
Description
result
Sales
Cloud
Relationsh
ip SDO
Properties
Unbounded
A list of Relationship that satisfy the
inbound criteria.
processRelationship
Performs a bulk load of relationship.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
changeOpera
tion
string
Indicates what action shall be

performed, such as Create, Update,
Merge, or Delete.
Relationship
Sales
Properties
147
processContro
l
Operations
Cloud
Relationsh
ip SDO
Unbounded
{http://xm
lns.oracle.
com/adf/
svc/type
Control your bulk upload behavior,
s/}Process
Control
invalid data in the same batch, and
A list of Relationship to be processed.
such as whether the valid data will

be committed if there are other
whether the outbound will contain
the key attributes only or the full
object.
Response Payload
Name
Type
Description
Result
Sales
Cloud
Relationsh
ip SDO
Properties
Unbounded
A list of Relationship that are successfully
processed.
processCSRelationship
Applies the changes back to the data source for a relationship.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
processData
{http://xm
lns.oracle.
com/adf/
svc/type

s/}Process
Data
148
Sales Cloud Relationship Simplified Web Services Interface Sales Cloud Relationship SDO
processContro
l
{http://xm
lns.oracle.
com/adf/
svc/type
s/}Process
Control

are other
invalid data in the same batch, and whether the
outbound will contain the key attributes only or the
full
object.
Response Payload
Name
Type
Description
result
{http://xm
lns.oracle.
com/adf/
svc/type

related/updated data objects, and all warning
s/}Process
Data

relationship. Relationship is an object that stores attributes that define and categorize a
relationship between 2 entities such as account, contact and household.
QName
{http://xmlns.oracle.com/apps/crmCommon/salesParties/relationshipService/}Relation
ship
Relationships
Type
Relationship To
Handled by

Name
Type
Description
149
ObjectPartyId
Long
Properties
Creatable, Required, Searchable
The primary key identifier of the object in this
relationship. Either one of ObjectPartyId,
ObjectPartyNumber and ObjectSourceSystem
along with ObjectSourceSystemReferenceValue
combination is used to identify the object party of
the relationship.
SubjectPartyId
Long
Properties
The primary key identifier of the subject in this
relationship. Either one of SubjectPartyId,
SubjectPartyNumber and SubjectSourceSystem
along with SubjectSourceSystemReferenceValue
combination is used to identify the subject party of
the relationship.
RelationshipType
Strin
g
Properties
The relationship type name. For example,
CUSTOMER_SUPPLIER. A list of valid relationship
types is defined in the lookup
HZ_RELATIONSHIP_TYPE. Review and update the
Manage Relationship Lookups.
RelationshipCode
strin
g
Properties
Indicates if this is a forward or a backward
relationship code. A list of valid relationship codes
is defined in the lookup PARTY_RELATIONS_TYPE.
and Maintenance task, Manage Relationship
Lookups.
StartDate
Dat
e
Properties
The date when the relationship was established.
150
Defaulted to the system date.

EndDate
Dat
e
Properties
Creatable, Required, Searchable,
Updateable
The date when the relationship ends.
CreatedByModule
strin
g
Properties
Creatable, Searchable
Application module that created this relationship
record. It is defaulted to value HZ_WS for all web
service based creation.
A list of valid certification level codes is defined in
the lookup HZ_CREATED_BY_MODULES. Review
Maintenance task, Manage Trading Community
Common Lookups.
Comments
strin
g
Properties
The user comments for this relationship.
Status
strin
g
Properties
Read-only
Indicates whether this is an active or inactive
relationship. A for active, I for inactive. This is an
internal column and you are not expected to pass
in a value. A list of valid values is defined in the
lookup HZ_STATUS. Review and update the codes
CreatedBy
Strin
g
Properties
CreationDate
LastUpdateDate
Dat
eTim
e
Properties
Dat
Properties
The date and time when the record was created.
151
LastUpdateLogin
eTim
e
Strin
g
Properties

updated.
Searchable
updated.
LastUpdatedBy
Strin
g
Properties
SubjectPartyNumb
er
Strin
g
Properties
Updateable
The alternate key identifier for the subject party of
the relationship. One of SubjectPartyId,
SubjectPartyNumber, and a combination of
SubjectSourceSystem and
SubjectSourceSystemReferenceValue, is used to
identify the subject party of the relationship.
SubjectSourceSyste
m
Strin
g
Properties
The name of external source system for the subject
party in the relationship, which are defined by an
admin as part of system setup. One of
SubjectPartyId, SubjectPartyNumber, and a
combination of SubjectSourceSystem and
identify the subject party of the relationship. The
value for this attribute should be predefined in the
lookup type HZ_ORIG_SYSTEMS_VL using the setup
task Manage Trading Community Source Systems.
SubjectSourceSyste
mReferenceValue
strin
g
Properties
The identifier for the subject party in the
relationship from external source system. One of
SubjectPartyId, SubjectPartyNumber, and a
combination of SubjectSourceSystem and
152
identify the subject party of the relationship.
ObjectSourceSyste
m
Strin
g
Properties
The name of external source system for the object
party in the relationship, which are defined by an
admin as part of system setup. One of
ObjectPartyId, ObjectPartyNumber, and a
combination of ObjectSourceSystem and
ObjectSourceSystemReferenceValue, is used to
identify the object party of the relationship. The
ObjectSourceSyste
mReferenceValue
Strin
g
Properties
The identifier for the object party in the relationship
from external source system. One of ObjectPartyId,
ObjectPartyNumber, and a combination of
ObjectSourceSystem and
identify the object party of the relationship.
ObjectPartyNumbe
r
Strin
g
Properties
Updateable
The unique identification number for the object
party of the relationship. One of ObjectPartyId,
ObjectPartyNumber, and a combination of
ObjectSourceSystem and
identify the object party of the relationship.
RelationshipSourceS
ystem
Strin
g
Properties
The name of external source system for the
relationship, which is defined by an admin as part
of the system setup.
RelationshipSourceS
ystemReferenceVal
Strin
g
Properties
153
ue
154
The identifier for the relationship with the external

source system.
Sales Cloud Address Simplified

Call the Sales Cloud Address service (AddressService) to provide a representation of the Address entity in
Oracle Sales Cloud. This service exposes the key attributes of an Address and provides
operations to define and manage addresses. This service should be used to mange
addresses in relation to a customer or prospect entity of type Account, Contact or
Household. It is also used to manage multiple address purposes for a given address.
While this service is independent and could be used to create an address for an existing
customer or prospect, it is often used in conjunction with the Account, Contact or
Household service to create the customer or prospect first before using this service
Related Services:
Trading Community Location Service is an alternate service used to manage addresses
and needs to be used in conjunction with either the Trading Community Organization
Service or Trading Community Person Service or Trading Community Group Service
depending upon the context used to manage relationships.
Life Cycle
Active
QName
{http://xmlns.oracle.com/apps/crmCommon/salesParties/addressService/}AddressServi
ce
Relationships
Type
Relationship To
Handles
Sales Cloud Address Purpose SDO
Handles
Sales Cloud Address SDO
Operations
getAddress
createAddress
updateAddress
deleteAddress
155
Sales Cloud Address Simplified Web Services Interface
mergeAddress
findAddress
processAddress
processCSAddress
Operations
getAddress
Retrieves the address based on the primary key identifier.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
addressId
Long
Party site identifier
Response Payload
Name
Type
Description
result
Sales
Cloud
Address
SDO
Address that matches the inbound

key attributes.
createAddress
Creates an Address.
Life Cycle
Active
Request Payload
156
Element
Name
Type
Description
address
Sales
Cloud
Address to be created.
Sales Cloud Address Simplified Web Services Interface Operations
Address
SDO
Response Payload
Name
Type
Description
result
{http://xm
lns.oracle.
com/app
s/crmCo
mmon/sal
esParties/
addressSe
rvice/}Ad
dressResul
t
The address which is created.
updateAddress
Updates an address. The address is identified by either providing the primary or alternate
keys of the Address, such AddressId, AddressNumber, SourceSystem or
SourceSystemReferenceValue.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
address
Sales
Cloud
Address
SDO
Address to be updated.
Response Payload
Name
Type
Description
157
result
{http://xm
lns.oracle.
com/app
s/crmCo
mmon/sal
esParties/
addressSe
rvice/}Ad
dressResul
t
Operations
The address which is updated.
mergeAddress
Merges an address. It will perform an update if the object exists or an insert if the object
doesn't already exist.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
address
Sales
Cloud
Address
SDO
Address to be merged.
Response Payload
158
Name
Type
Description
result
{http://xm
lns.oracle.
com/app
s/crmCo
mmon/sal
esParties/
addressSe
rvice/}Ad
dressResul
Merged Address
deleteAddress
Deletes an address.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
address
Sales
Cloud
Address
SDO
Address to be deleted.
Response Payload
Name
Type
result
{http://xm
lns.oracle.
com/adf/
svc/types
/}Method
Result
Description
findAddress
Finds a list of addresses matching the supplied criteria pertaining to the object.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
159
findCriteria
findControl
Operations
{http://xm
lns.oracle.
com/adf/
svc/types
/}FindCrit
eria
{http://xm
lns.oracle.
com/adf/
svc/types
/}FindCon
trol

clause), the fetch size, etc.
Response Payload
Name
Type
Description
result
Sales
Cloud
Address
SDO
A list of Address that satisfy the

inbound criteria.
processAddress
Bulk loads the Address. Performs a Create, Update, or Delete operation on a list of
Address rows. Different operations may be applied to different objects, depending on
what is specified in the ChangeSummary object.
Life Cycle
Active
Request Payload
Element Name
Type
Description
changeOperati
on
string
Indicates what action shall be

performed, such as Create, Update,
Merge, or Delete.
address
160
Sales
Cloud
Address
Properties
Unbounded
processControl
SDO
A list of Address to be processed.
{http://x
mlns.ora
cle.com
/adf/sv
c/types
/}Proces
sControl
Control your bulk upload behavior,

such as whether the valid data will
be committed if there are other
invalid data in the same batch, and
whether the outbound will contain
the key attributes only or the full
object.
Response Payload
Name
Type
Description
result
Sales
Cloud
Address
SDO
Properties
Unbounded
A list of Address that are successfully processed.
processCSAddress
Applies the changes back to the data source for Address.
Life Cycle
Active
Request Payload
Element
Name
Type
Description
processData
{http://xml
ns.oracle.c
om/adf/sv
c/types/}Pr
ocessData

processContr
ol
{http://xml
ns.oracle.c
om/adf/sv
c/types/}Pr

are other
invalid data in the same batch, and whether the
161
ocessCont
rol
outbound will contain the key attributes only or the

full
object.
Response Payload
Name
Type
Description
result
{http://xm
lns.oracle.
com/adf/
svc/types
/}Process
Data

related/updated data objects, and all warning

An object that includes attributes used to store values while creating or updating an
address. An address represents the location information of an account, contact or
household.
QName
{http://xmlns.oracle.com/apps/crmCommon/salesParties/addressService/}Address
Relationships
Type
Relationship To
Contains
Handled by
Sales Cloud Address

Name
Type
Description
PartyId
long
Properties
Creatable
Unique Identifier of the account, contact or
162
Sales Cloud Address Simplified Web Services Interface Sales Cloud Address SDO
household to which the address is associated. One

of PartyId, PartyNumber or PartySourceSystem and
PartySourceSystemReferenceValue keys is required
to uniquely identify the account, contact or
household record with which the address is
associated.
PartyNumber
string
Properties
Creatable
Alternate unique identifier of the account, contact

or household to which the address is associated.
One of PartyId, PartyNumber or PartySourceSystem
and PartySourceSystemReferenceValue keys is
required to identify the account, contact or
associated. The default value is the value
specified in the profile option ZCA_PUID_PREFIX
concatenated with a unique generated
sequence number. The value is updateable
depending on the profile option
HZ_GENERATE_PARTY_NUMBER. A list of valid values
is defined in the profile option
PartySourceSyste
m
string
Properties
Creatable
Name of external source system of the account,
contact or household with which the address is
associated. Part of Alternate Key for the account,
contact or household record (along with
PartyourceSystemReferenceValue). One of
PartyId, PartyNumber or PartySourceSystem and
to identify the account, contact or household
record with which the address is associated. The
163
PartySourceSyste
mReferenceValu
e
string
AddressId
long
Properties
Creatable
Identifier from external source system for the
account, contact or household with which the
address is associated. Part of Alternate Key (along
with PartySourceSystem). One of PartyId,
PartyNumber or PartySourceSystem and
to identify the account, contact or household
record with which the address is associated.
Keys
Primary Key
The unique address identifier that is internally
generated during create. One of AddressId,
AddressNumber or SourceSystem and
SourceSystemReferenceValue keys is used to
identify the address record during update.
AddressNumber
string
Properties
Creatable
The alternate unique identifier for the address. One
of AddressId, AddressNumber or SourceSystem
and SourceSystemReferenceValue keys is used to
identify the address record during update. If not
specified, then it is automatically generated.
Prefix defined as in profile option ZCA_PUID_PREFIX
concatenated with an internally generated
unique sequence number.
Comments
string
Properties
The user comments for the address
DoNotMailFlag
boole
an
Properties
Indicates that this address should not be used for
mailing
CorpCurrencyCo
de
string
Properties
The corporate currency code associated with the
164
addresses. A list of valid values is defined in the

lookup ZCA_COMMON_CORPORATE_CURRENCY.
CreatedBy
string
CreationDate
dateTi
me
Date and time when the record was created.
CreatedByModul
e
string
Application module that created this organization

record. Defaulted to value HZ_WS for all web
service based creation.
A list of valid certification level codes is defined in
the lookup HZ_CREATED_BY_MODULES. Review
Maintenance task, Manage Trading Community
Common Lookups.
CurcyConvRateTy
pe
string

the address. This attribute is used by CRM
CurrencyCode
string
The currency code related to the address. This

attribute is used by CRM Extensibility framework. A
list of valid values is defined in the lookup
Options task.
EndDateActive
date
Properties
Date after which this address is rendered inactive.
FormattedAddres
s
string
The formatted address information.
FormattedMultilin
eAddress
string
The formatted multiple line address information.
165
LastUpdateDate
dateTi
me

updated.
LastUpdateLogin
string
LastUpdatedBy
string
LocationId
long
Properties
Read-only
The unique identifier for the location record for this
address.
Mailstop
string
Properties
A user-defined code to indicate a mail drop point
within their organization
PrimaryFlag
boole
an
Properties
Indicates if this is the primary address of the
associated object. Accepts values Y for primary
contact, N for all others.
StartDateActive
date
Properties
Creatable
Date from which this address is active. Defaulted
to the current system date if not provided during
create.
Status
string
An internal application determined flag indicating

status of the address. Status codes are defined by
the lookup HZ_STATUS.
AddrElementAttri
bute1
string
Properties
The additional address element to support flexible
address format.
AddrElementAttri
166
string
Properties
bute2
address format.
AddrElementAttri
bute3
string
Properties
address format.
AddrElementAttri
bute4
string
Properties
address format.
AddrElementAttri
bute5
string
Properties
address format.
Address1
string
Properties
The first line for address.
Address2
string
Properties
The second line for address.
Address3
string
Properties
The third line for address.
Address4
string
Properties
The fourth line for address.
AddressLinesPhon
etic
string
Properties
The phonetic or Kana representation of the Kanji
address lines (used in Japan).
167
Building
string
Properties
The specific building name or number at a given
address.
City
string
Properties
The city element of Address.
ClliCode
string
Properties
The Common Language Location Identifier (CLLI)
code.
Country
string
Properties
The country code of the address.
County
string
Properties
The county element of the address.
DateValidated
date
Properties
Read-only
Date on which the address was last validated.
Description
string
Properties
An extensive description of the location.
FloorNumber
string
Properties
The specific floor number at a given address or in
a particular building when building number is
provided.
HouseType
string
Properties
Indicates the building type. A list of `valid values
168
are defined in the lookup HZ_HOUSE_TYPE. Review

Lookups task.
Latitude
decim
al
Properties
Used to store latitude information for the location
for spatial proximity and containment purposes.
LocationDirection
s
string
Properties
The directions to the location.
Longitude
decim
al
Properties
Used to store longitude information for the location
PostalCode
string
Properties
The postal code as defined by the formal
countrywide postal system.
PostalPlus4Code
string
Properties
The four digit extension to the United States Postal
ZIP code.
Province
string
Properties
The province element of Address.
State
string
Properties
The state element of Address.
ValidatedFlag
boole
an
Indicates whether the location was validated. Y for

validated, N for invalidated. If the value is True,
then the location is validated. The value is
internally set by system during address cleansing.
169
ValidationStartDa
te
date
Date on which the validation starts. Internally set

by system during address cleansing.
ValidationStatusC
ode
string
Properties
The standardized status code that describes the
results of the validation. Internally set by system
during address cleansing.
SourceSystem
string
Properties
Creatable
Composite alternate key: SourceSystem and
SourceSystemReference
Name of external source system for the address
denoted by a code, which is defined by an
administrator as part of system setup. The value for
this attribute should be predefined in the lookup
type HZ_ORIG_SYSTEMS_VL using the setup task
Manage Trading Community Source Systems.
SourceSystem and SourceSystemReference
combination is unique and is used as the foreign
key to identify an address.
SourceSystemRef
erenceValue
string
Properties
Creatable
Composite alternate key: SourceSystem and
SourceSystemReference
The unique identifier for the address from the
external source. SourceSystem and
SourceSystemReference combination is unique
and is used as the foreign key to identify an
address.
AddressPurpose
170
Sales
Cloud
Addre
ss
Purpos
e SDO
Properties
Reference to the address purpose child entity of
this address
Sales Cloud Address Simplified Web Services Interface Sales Cloud Address Purpose SDO

An object that includes attributes used to store values while creating or updating the
address purpose. The address purpose describes the use of an address. For example,
shipping address or billing address.
QName
{http://xmlns.oracle.com/apps/crmCommon/salesParties/addressService/}AddressPurp
ose
Relationships
Type
Relationship To
Contained by
Handled by
Sales Cloud Address

Name
Type
Description
AddressPurposeId
long
Keys
Primary Key
Address purpose unique internal identifier used for
identifying the address purpose record in case of
update. The identifier is internally generated during
create.
Purpose
string
Properties
Creatable
Indicates the use or purpose of the address e.g.
billing, shipping etc. A list of valid values is defined
in the lookup PARTY_SITE_USE_CODE. Review and
Lookups task.
DeleteFlag
boole
an
Properties
Indicates if the address purpose is to be deleted.
Valid values are Y or N. Mention Y for delete,
171
considered N by default

primary address. A primary address is the default communication address of an entity
irrespective of the address purpose
QName
{http://xmlns.oracle.com/apps/crmCommon/salesParties/commonService/}PrimaryAddr
ess
Relationships
Type
Relationship To
Contained by
Contained by
Contained by
Handled by
Sales Cloud Account
Handled by
Sales Cloud Contact
Handled by

Name
Type
Description
AddressId
long
Keys
Primary Key
Address internal unique identifier that is internally
generated during create. One of AddressId,
AddressNumber or SourceSystem and
identify the address record during update.
AddressNumber
172
string
Properties
Sales Cloud Address Simplified Web Services Interface Sales Cloud Primary Address SDO
Creatable
Alternate unique identifier for the address. One of
AddressId, AddressNumber or SourceSystem and
identify the address record during update. If not
specified, then it is automatically generated.
Prefix defined as in profile option ZCA_PUID_PREFIX
concatenated with an internally generated
unique sequence number.
SourceSystem
string
Composite alternate key

Properties
Creatable
Name of external source system for the address
denoted by a code, which is defined by an
administrator as part of system setup. The value for
this attribute should be predefined in the lookup
type HZ_ORIG_SYSTEMS_VL using the setup task
Manage Trading Community Source Systems.
combination is unique and is used as the foreign
key to identify an address.
SourceSystemRef
erenceValue
string
Composite alternate key

Properties
Creatable
The unique identifier for the address from the
external source. SourceSystem and
SourceSystemReference combination is unique
and is used as the foreign key to identify an
address.
LocationId
long
Properties
Read-only
Unique identifier for the location record for this
address
PartyId
Long
Properties
Creatable
173
Unique Identifier of the account, contact or

household to which the address is associated. One
of PartyId, PartyNumber or PartySourceSystem and
to uniquely identify the account, contact or
associated.
AddrElementAttri
bute1
string
Properties
Additional address element to support flexible
address format
AddrElementAttri
bute2
string
Properties
address format
AddrElementAttri
bute3
string
Properties
address format
AddrElementAttri
bute4
string
Properties
address format
AddrElementAttri
bute5
string
Properties
address format
Address1
string
Properties
First line for address
Address2
string
Properties
Second line for address
174
Address3
string
Properties
Third line for address
Address4
string
Properties
Fourth line for address
Building
string
Properties
Specific building name or number at a given
address
City
string
Properties
City element of Address.
Country
string
Properties
Country code of the address.
County
string
Properties
County element of Address.
FloorNumber
string
Properties
Specific floor number at a given address or in a
particular building when building number is
provided
PostalCode
string
Properties
Postal code as defined by the formal countrywide
postal system
PostalPlus4Code
string
Properties
Four digit extension to the United States Postal ZIP
175
code.
Province
string
Properties
Province element of Address.
State
string
Properties
State element of Address.
Latitude
decim
al
Properties
Used to store Latitude Information for the Location
Longitude
Decim
al
Properties
Used to store Longitude Information for the
Location for spatial proximity and containment
purposes
Mailstop
string
Properties
A user-defined code to indicate a mail drop point
within their organization
AddressLinesPhon
etic
string
Properties
Phonetic or Kana representation of the Kanji
address lines (used in Japan)
Comments
string
Properties
User comments for the address
Description
string
Properties
An extensive description of the location
DateValidated
176
date
Properties
Read-only
Date the address was last validated.
HouseType
string
Properties
Indicates the building type. A list of valid values is
defined in the lookup HZ_HOUSE_TYPE. Review and
Lookups task.
LocationDirection
s
string
Properties
Directions to the location
ValidatedFlag
boole
an
Indicates if the location was validated. Y for

validated, N for invalidated. The value is internally
set by system during address cleansing.
ValidationStartDa
te
date
Start date of the validation. Internally set by system

during address cleansing.
FormattedAddres
s
string
Formatted address information
FormattedMultilin
eAddress
string
Formatted multiple line address information
CreatedBy
string
Who column that indicates the user who created

the record.
CreationDate
dateTi
me
Who column that indicates the date and time of

the creation of the record.
LastUpdateDate
dateTi
me
Who column that indicates the date and time of

the last update of the record.
LastUpdateLogin
string
Who column that indicates the session login

associated to the user who last updated the
record.
LastUpdatedBy
string
Who column that indicates the user who last

updated the record.
DeleteFlag
boole
Properties
177
an
Indicates if the primary address is to be deleted.
Valid values are Y or N. Mention Y for delete,
considered N by default
178
CorpCurrencyCo
de
string
Corporate currency code associated with the

addresses. This attribute is used by CRM Extensibility
framework The value of the profile option
ZCA_COMMON_CORPORATE_CURRENCY is the
default corporate currency value. Review and
update the profile option using the Setup and
Maintenance work area, Manage Profile Options
task.
CurcyConvRateTy
pe
string
Currency conversion rate type associated with the

address. This attribute is used by CRM Extensibility
framework. A list of valid values are defined in the
lookup ZCA_COMMON_RATE_TYPE. Review and
update the profile option using the Setup and
Options task.
CurrencyCode
string
Currency Code related to the address. This

attribute is used by CRM Extensibility framework. A
list of valid values are defined in the lookup
Options task.
Appendix A: Downloading and

Setting Up the Fusion Service
Tester
You can use the Fusion Service Tester to easily test Oracle Sales Cloud Web services. It
can be invoked by clicking a bat file or by running a jar file. You must download Java on
your computer to run Fusion Service Tester:
Installing JAVA on Windows machine

1. Get the latest JDK version from the link:
http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads1880260.html .
2. Install JAVA from the executable.
3. Note down the path of bin directory in the Java installation directory. The default
path is: C:\Program Files\Java\jdkx.x.x\bin.
4. Set the System Environment variables.
A. Right-click on 'My Computer' and select 'Properties'.
B. Go to Advanced System Settings.
C. Click Environment Variables.
D. Set the PATH variable
E. If PATH is already present, double click it and append the bin path like
";C:\Program Files\Java\jdkx.x.x\bin;".
F. Else create a New Variable by clicking NEW. Provide variable name as "Path"
G. and variable value as path of bin directory "C:\Program Files\Java\jdkx.x.x\bin;"
H. Click Ok.
5. Type " java -version " in the command prompt to test if installation is successful. A successful
installation will return version details.
Downloading the Fusion Service Tester

1. Login to OER (https://fusionappsoer.oracle.com)
2. Enter the following path in the browser window and press Enter:
https://fusionappsoer.oracle.com/oer/FusionServiceTester.zip
Running the Fusion Service Tester Client

1. Navigate to the Client code directory and Use the startFusionServiceTester.sh or
startFusionServiceTester.bat to start the Client.
2. Alternatively you can run the client using the following command:-
179
Appendix A: Downloading and Setting Up the Fusion Service Tester

certificate in the keystore (for IE)
Importing a New
java -Djavax.net.ssl.trustStore=default-keystore.jks -jar

FusionServiceTester.jar
Note: If you get a SSL handshake error related to invalid certificate path, then additional setup might
be needed to manually add the certificate in the truststore. To do that follow the below instruction
Importing a New certificate in the keystore (for IE)

1. Export the certificate from the browser to file using following steps
A. Open the SSL URL for any of the web service.
B. Click on the lock icon besides the URL.
C. Go to the connections tab and certificate information link.
D. Go to Details -> Copy to File -> Next
E. Change the encoding to the Base-64 and click Next.
F. Provide the filename and click finish.
2. Then in the command prompt type the below command:
keytool -import -trustcacerts -file <filename> -alias <aliasname> keystore default-keystore.jks -storepass welcome1
180
10
Appendix B: Sample Code:

Static Web Service Proxy JAX-WS
Style
Note: The following code was developed using Oracle JDeveloper Studio 11.1.1.7. 1. This client is
created as a Servlet to avoid certificate checking.
package saaspaas_tester;
import accountservice.proxy.AccountService;
import accountservice.proxy.AccountService_Service;
import com.oracle.xmlns.adf.svc.types.DataObjectResult;
import com.oracle.xmlns.adf.svc.types.FindCriteria;
import com.oracle.xmlns.adf.svc.types.ProcessControl;
import com.oracle.xmlns.adf.svc.types.ReturnMode;
import com.oracle.xmlns.adf.svc.types.ViewCriteria;
import com.oracle.xmlns.adf.svc.types.ViewCriteriaItem;
import com.oracle.xmlns.adf.svc.types.ViewCriteriaRow;
import
com.oracle.xmlns.apps.crmcommon.salesparties.accountservice.Account;
import
com.oracle.xmlns.apps.crmcommon.salesparties.accountservice.ObjectFactory;
import
com.oracle.xmlns.apps.crmcommon.salesparties.accountservice.types.FindAcco
unt;
import com.sun.xml.ws.developer.WSBindingProvider;
import java.io.PrintWriter;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import javax.xml.ws.WebServiceRef;
import weblogic.wsee.jws.jaxws.owsm.SecurityPolicyFeature;
public class PaaSSaaSCRUDSample {
@WebServiceRef
private AccountService_Service accountService_Service;
private String osc_hostname = "server.domain_name.com:port_number";
private String endpoint = "https://" + this.osc_hostname +
"/crmCommonSalesParties/AccountService";
private String osc_username = "User_name";
private String osc_password = "Password";
181
Appendix B: Sample Code: Static Web Service Proxy JAX-WS Style

Importing a New
public void testCRUDOperations(PrintWriter out) {

out.println("Testing JCS/OSC CRUD operations with");
out.println("Endpoint: : " + endpoint);
out.println("Username : " + osc_username);
out.println("Password: " + osc_password);
Date time = new Date();
// Global Try Catch
try {
// Setup SOAP Connection
// Workaround bug#18241690, to ensure Java Cloud uses the
correct XLS transformer
System.setProperty("javax.xml.transform.TransformerFactory",
"com.sun.org.apache.xalan.internal.xsltc.trax.TransformerFactoryImpl");
// Set SSL SecurityPolicy, this examples assumes Https
connection not SAML
String SSLSecurityPolicy =
"oracle/wss_username_token_over_ssl_client_policy";
SecurityPolicyFeature[] m_securityFeature =
new SecurityPolicyFeature[] { new
SecurityPolicyFeature(SSLSecurityPolicy) };
// Initiate account Service
accountService_Service = new AccountService_Service();
//m_securityFeature =
//
new SecurityPolicyFeature[] { new
SecurityPolicyFeature(SSLSecurityPolicy) };
// Connect to the JAXWS WebServiceEndpoint
AccountService accountService =
accountService_Service.getAccountServiceSoapHttpPort(m_securityFeature);
// Get the request context to set the outgoing addressing
properties
// Set the username,password and endpoint of the SOAP Service.
These lines overrite what
WSBindingProvider wsbp = (WSBindingProvider)accountService;
wsbp.getRequestContext().put(WSBindingProvider.USERNAME_PROPERTY,
osc_username);
wsbp.getRequestContext().put(WSBindingProvider.PASSWORD_PROPERTY,
osc_password);
182
Appendix B: Sample Code: Static Web Service Proxy JAX-WS Style Importing a New
wsbp.getRequestContext().put(WSBindingProvider.ENDPOINT_ADDRESS_PROPERTY,
endpoint);
StringBuffer result = new StringBuffer();
// Always create an objectfactory and instantiate objects from
this.
// Only exception is when parameters are native java types
e.g. String or Long
// Make sure you use the right objectFactory for the
WebService, in this example the correct objectFactory is
//
com.oracle.xmlns.apps.crmcommon.salesparties.accountservice.ObjectFactory
ObjectFactory objectFactory = new ObjectFactory();
//
// Create ACCOUNT Object
//
// Other Account payload attributes can be created in a
similar manner
Account acc = objectFactory.createAccount();
acc.setOrganizationName("World Vision Inc - " +
time.getTime());
acc.setType(objectFactory.createAccountType("ZCA_CUSTOMER"));
acc.setCEOName(objectFactory.createAccountCEOName("John
Smith"));
// Call Service to create Object
DataObjectResult createResponse =
accountService.createAccount(acc);
// Response contains full result of created object
// Verify the result from create account service call
Long partyId = 0L;
if (createResponse != null && createResponse.getValue() !=
null &&
createResponse.getValue().size() > 0) {
Account createResult =
(Account)createResponse.getValue().get(0);
partyId = createResult.getPartyId();
out.println("Created a party with PartyId: " + partyId);
// we can get other attributes of the account from the
createResult object
// e.g. createResult.getPartyNumber(), etc.
}
183

Importing a New
//
// Get Account
//
// Need the partyId of the account for this operation
// partyId is either 0 or the partyId of the newly created
party in the previous create method
DataObjectResult getResult =
accountService.getAccount(partyId);
if (getResult != null && getResult.getValue() != null &&
getResult.getValue().size() > 0) {
Account getAccResult =
(Account)getResult.getValue().get(0);
String getorgName = getAccResult.getOrganizationName();
String getceoName = getAccResult.getCEOName().getValue();
out.println("Org name from get operation is +" +
getorgName +
" and ceo name is " + getceoName);
}
//
// Update Account
// We can update an account by creating an object with the
right partyId (ala QueryByExample) and then the added/modified fields
//
out.println("Updating Organization Name");
Account updateAcc = objectFactory.createAccount();
updateAcc.setPartyId(partyId);
updateAcc.setOrganizationName("Updated World Vision Inc " +
time.getTime());
accountService.updateAccount(updateAcc);
// we can verify the update result by doing a get operation
//
// Merge account
// merge either creates a new account or updates an exisitng
account
out.println("Merge : new Organization ");
Account mergeAcc = objectFactory.createAccount();
mergeAcc.setPartyNumber("DHQA_06052150_A1");
mergeAcc.setOrganizationName("Merge Organization Test 123");
DataObjectResult mergeResult =
accountService.mergeAccount(mergeAcc);
184
if (mergeResult != null && mergeResult.getValue() != null &&

mergeResult.getValue().size() > 0) {
Account mergeAccResult =
(Account)mergeResult.getValue().get(0);
out.println(" PartyId is: " +
mergeAccResult.getPartyId());
out.println(" PartyNumber is " +
mergeAccResult.getPartyNumber());
out.println(" Organization Name is " +
mergeAccResult.getOrganizationName());
}
//
// DELETE account
//
// using the partyId to delete the party
// does it return anything?
out.println("Deleting Organization with party id " + partyId);
Account account = objectFactory.createAccount();
account.setPartyId(partyId);
accountService.deleteAccount(account);
//
// PROCESS account
//
// Used for batch operations. The same operation is perfomed
on each object
out.println("Performing Batch creation of Organizations");
// Create the Account objects
Account account1 = objectFactory.createAccount();
account1.setPartyNumber("DHQA_06052150_A1");
account1.setOrganizationName("Process Merge Account 1");
//
Account account2 = objectFactory.createAccount();
account2.setPartyNumber("DHQA_06052150_A1_123");
account2.setOrganizationName("Process Merge Account 2");
// add them to a list
List<Account> accountList = new ArrayList<Account>();
accountList.add(account1);
accountList.add(account2);
185

Importing a New
//set the process control params

ProcessControl pc = new ProcessControl();
pc.setPartialFailureAllowed(true);
pc.setExceptionReturnMode(ReturnMode.FULL);
pc.setReturnMode(ReturnMode.FULL);
// invoke the process operation. Here "merge" operation is
being invoked
DataObjectResult processResults =
accountService.processAccount("Merge", accountList, pc);
List accountProcessResults = processResults.getValue();
for (Object o : accountProcessResults) {
Account processResult = (Account)o;
out.println(processResult.getPartyId());
out.println(processResult.getPartyNumber());
out.println(processResult.getOrganizationName());
}
//
// FIND account
// finding accounts whose party numbers are given
//
// The following code implements this SOAP message
//
//
<typ:findCriteria>
//
<typ1:fetchStart>0</typ1:fetchStart>
//
<typ1:fetchSize>10</typ1:fetchSize>
//
<typ1:filter>
//
<typ1:group>
//
<typ1:upperCaseCompare>true</typ1:upperCaseCompare>
//
<typ1:item>
//
<typ1:upperCaseCompare/>
//
<typ1:attribute>PartyNumber</typ1:attribute>
//
<typ1:operator>IN</typ1:operator>
//
<typ1:value>DHQA_06052150_A1</typ1:value>
//
<typ1:value>DHQA_06052150_A1_123</typ1:value>
//
</typ1:item>
//
</typ1:group>
//
</typ1:filter>
186
//
</typ:findCriteria>
FindCriteria fc = new FindCriteria();

fc.setFetchSize(10); // Get max of 10 records
fc.setFetchStart(0); // Start at index 0
ViewCriteriaItem vcItem = new ViewCriteriaItem();
vcItem.setAttribute("PartyNumber");
vcItem.setOperator("IN");
vcItem.setUpperCaseCompare(true);
vcItem.getValue().add("DHQA_06052150_A1");
vcItem.getValue().add("DHQA_06052150_A1_123");
ViewCriteriaRow vcr = new ViewCriteriaRow();
vcr.getItem().add(vcItem);
ViewCriteria vc = new ViewCriteria();
vc.getGroup().add(vcr);
fc.setFilter(vc);
//
// Now findCriteria is created add it to the calling object
and call the service
//
FindAccount facc = new FindAccount();
facc.setFindCriteria(fc);
DataObjectResult findResponse =
accountService.findAccount(fc, null);
if (findResponse != null && findResponse.getValue() != null) {
List findResults = findResponse.getValue();
for (Object o : findResults) {
Account findResult = (Account)o;
out.println(findResult.getPartyId());
out.println(findResult.getPartyNumber());
out.println(findResult.getOrganizationName());
}
}
} catch (Exception e) {
e.printStackTrace();
out.println(e.getLocalizedMessage());
}
return;
}
}
187
11
Appendix C: Extracting
Oracle Public Certificate from
Fusion WSDL
This is a sample certificate and the sections below illustrate how to extract the certificate
from a WSDL and add to a keystore. The actual Oracle public certificate should be
extracted from a Fusion WSDL.
In the Fusion WSDL, the encrypted certificate is stored in the following format:
<dsig:X509Certificate>MIICCzCCAXSgAwIBAgIETf8ZWjANBgkqhkiG9w0BAQUFADBKMRMw
EQYKCZImiZPyLGQBGRYDY29tMSEwHwYKCZImiZPyLGQBGRYRb3JhY2xlb3V0c291cmNpbmcxED
AOBgNVBAMTB3NlcnZpY2UwHhcNMTEwNjIwMDk1NjQyWhcNMTExMjE3MDk1NjQyWjBKMRMwEQYK
CZImiZPyLGQBGRYDY29tMSEwHwYKCZImiZPyLGQBGRYRb3JhY2xlb3V0c291cmNpbmcxEDAOBg
NVBAMTB3NlcnZpY2UwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAJJsUQQHiE9qlTlv3n1j
P3JhepkAwsxXsy5+DMifv2ZbB2haoCcJ319Nx06tg67QyS5E79iAs3rLE5W/2rEKXmWjJ74whX
0gJho+a+33EMLDuejehtx1d726CoYIvTpGl+6C+QH1R3N1MIEFWk0JuLod5YFgEXgXhNQuEFXz
3UIbAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAGYQX4MKfFlwO1TuKpjtABEwveZKpyIvkfdCcqv
ZVpdIb7rNyCeVWOuSlpldgEQ4lUYo29IrFf50z/Rbuz4tu3JT8uB2cpRpX9GDUKq5MTx6efVUV
H9EGK0sZZ8NbX2aeAlOq02Wau2T0og5IxID7KPcCU1qiRV0WA3ebd15vODk=</dsig:X509Cer
tificate>
Copy the encrypted text to a text editor and remove the
<dsig:X509Certificate> and </dsig:X509Certificate> tags. Add the
following lines before and after the encrypted text.
-----BEGIN CERTIFICATE---------END CERTIFICATE-----------BEGIN CERTIFICATE----MIICCzCCAXSgAwIBAgIETf8ZWjANBgkqhkiG9w0BAQUFADBKMRMwEQYKCZImiZPyLGQBGRYDY2
9tMSEwHwYKCZImiZPyLGQBGRYRb3JhY2xlb3V0c291cmNpbmcxEDAOBgNVBAMTB3NlcnZpY2Uw
HhcNMTEwNjIwMDk1NjQyWhcNMTExMjE3MDk1NjQyWjBKMRMwEQYKCZImiZPyLGQBGRYDY29tMS
EwHwYKCZImiZPyLGQBGRYRb3JhY2xlb3V0c291cmNpbmcxEDAOBgNVBAMTB3NlcnZpY2UwgZ8w
DQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAJJsUQQHiE9qlTlv3n1jP3JhepkAwsxXsy5+DMifv2
ZbB2haoCcJ319Nx06tg67QyS5E79iAs3rLE5W/2rEKXmWjJ74whX0gJho+a+33EMLDuejehtx1
d726CoYIvTpGl+6C+QH1R3N1MIEFWk0JuLod5YFgEXgXhNQuEFXz3UIbAgMBAAEwDQYJKoZIhv
cNAQEFBQADgYEAGYQX4MKfFlwO1TuKpjtABEwveZKpyIvkfdCcqvZVpdIb7rNyCeVWOuSlpldg
EQ4lUYo29IrFf50z/Rbuz4tu3JT8uB2cpRpX9GDUKq5MTx6efVUVH9EGK0sZZ8NbX2aeAlOq02
Wau2T0og5IxID7KPcCU1qiRV0WA3ebd15vODk=
-----END CERTIFICATE----
Save the file as yourcert.crt. The certificate can now be imported to the keystore under
the rcpt-key-alias. The Oracle certificate file can be imported to the keystore using the
keytool commands listed below.
Import Oracle certificate to a keystore file
keytool -importcert -alias nameoforaclekey -file oraclecertificatefile.cer
-keystore oracle-keystore.jks -storepass keystorepassword
189
Appendix C: Extracting Oracle Public Certificate from Fusion WSDL

Importing a New
List the contents of a keystore

keytool -list -keystore "oracle-keystore.jks"
The client can save the keystore file to their local machine and reference the keystore
file in their client application to authenticate to the Fusion environment.
190

Using Simplified SOAP Web Services

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Using Simplified SOAP Web Services

Uploaded by

Copyright:

Available Formats

May 2015

Oracle Sales Cloud Using

1 Introduction to Simplified Sales Cloud Web Services for Account,

Delete a Contact Programmatically Using deleteContact ............................... 36

Sales Cloud Account Simplified Web Services Interface.................................... 67

Overview of Oracle Sales Cloud Web Services

Sales Cloud Contact Simplified Web Services Interface .................................... 95

Sales Cloud Household Simplified Web Services Interface .............................. 123

Sales Cloud Relationship Simplified Web Services Interface ............................ 143

Sales Cloud Address Simplified Web Services Interface ................................... 155

Overview of Oracle Sales Cloud Web Services

Introduction to Simplified Sales

Overview of Oracle Sales Cloud Web Services

Overview of Simplified SOAP Web Services

Sales Cloud Account

Sales Cloud Contact

Sales Cloud Household

Sales Cloud Address

There are no steps necessary to enable these enhancements.

The Sales Cloud Account service supports the management of an account

Getting Started with Web Services

Understanding the Process Flow for Consuming a SOAP Web

These stages are described below:

Searching for Relevant Web Services Using the OER

Prototyping payloads and evaluating if a web service meets your business

Searching for Relevant Web Services Using the OER

ADF Business Components service data objects

Service Oriented Architecture (SOA) composites

To access the information for a web service, follow these steps.

1. Using your browser, enter http://fusionappsoer.oracle.com. Sign in as a user or a

Accessing WSDL URL

Launch the OER (https://fusionappsoer.oracle.com/oer) and login as Guest.

Search String: Sales Cloud Account

To get physical end point of any given instance:

In this URL, take the "https://<domainname>". For example, in case of Payables

https://<domainname>/crmCommonSalesParties/AccountService is the WSDL URL

Determining Which Web service to Use to Implement Your Use

Determining Which Web service to Use to Implement Your Use Case

Fusion Service Tester

Third party tools

Prototyping Payloads and Evaluating if a Web Service Meets Your Business

Evaluating the Simplified Account Service

Use this procedure to evaluate the simplified Account service (AccountService).

Identifying the Appropriate Web Service

1. Log in to Oracle Enterprise Repository.

Extracting the Web Services URL

Navigate to an application's dashboard/workarea page that belongs to Sales Cloud

Deriving the Input Payload

Invoking the Web Service

Determining Which Web service to Use to Implement Your Use Case

Testing the Results

1. Copy and paste the output payload to a notepad.

Evaluating the Simplified Contact Service

Use this procedure to evaluate the simplified Contact service (ContactService).

Identifying the Appropriate Web Service

1. Log in to Oracle Enterprise Repository.

Extracting the Web Services URL

Navigate to an application's dashboard/workarea page that belongs to Sales Cloud

https://<domainname>/crmCommonSalesParties/ContactService is the WSDL URL for

Deriving the Input Payload

4. Uncheck all the other fields.

5. Click the XML Source option.

6. Copy the XML source and paste to a notepad.

Invoking the Web Service