Get all opportunities
get
/crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/MatchedOpportunity
Request
Path Parameters
-
dealsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Deal Registrations resource and used to uniquely identify an instance of Deal Registrations. The client should not generate the hash key value. Instead, the client should query on the Deal Registrations collection resource in order to navigate to a specific instance of Deal Registrations to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- MyOpportunitiesFinder: Finds the opportunity with the specified opportunity finder.
Finder Variables:- ClosePeriod; string; The close period associated with the opportunity.
- ContactPartyId; integer; The contact party identifier associated with the opportunity.
- EffectiveBeginDate; string; The effective start date of the opportunity.
- EffectiveEndDate; string; The effective end date of the opportunity.
- LeadNumber; string; The lead number associated with the opportunity.
- LookupCategory; string; The status category of the opportunity status.
- Name; string; The name of the opportunity.
- OpportunityContactName; string; The contact name associated with the opportunity.
- OptyStatusCode; string; The status code of the opportunity.
- Partner; string; The partner associated with the opportunity.
- PartnerPartyId; integer; The partner party identifier associated with the opportunity.
- Product; string; The product associated with the opportunity.
- ProductGroup; string; The product group associated with the opportunity.
- RecordSet; string; The record set of the opportunity.
- ReferenceName; string; The reference name of the opportunity.
- ResourcePartyId; string; The resource party identifier of the opportunity.
- TeamMember; string; The team member associated with the opportunity.
- OptyNumberRowFinder: Finds the opportunity with the specified row number.
Finder Variables:- OptyNumber; string; The row number of the opportunity.
- PrimaryKey: Finds the opportunity with the specified primary key identifier.
Finder Variables:- OptyId; integer; The primary key identifier of the opportunity.
- MyOpportunitiesFinder: Finds the opportunity with the specified opportunity finder.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AccountPartyNumber; string; The party number of the account associated with the matched opportunity.
- AssetNumber; string; The alternate key identifier of the asset associated with the opportunity.
- AssetSerialNumber; string; The asset serial number associated with the opportunity.
- BudgetedFlag; boolean; Indicates if the opportunity sales account has the budget approved for the potential purchase. If the value is true, then the sales account has the budget approved for the purchase. The default value is False.
- ClosePeriod; string; The close period of the opportunity.
- ConflictId; integer; Disconnected Mobile: this value is used to guarantee the uniqueness of the row when duplicates are created in different databases (i.e. mobile databases or the server).
- CreationDate; string; The date and time when the opportunity record was created.
- CrmConversionRate; number; This rate is used for the conversion of the revenue amount to the CRM common currency to facilitate the computation of the revenue forecast metrics. This is the amount that one currency can be exchanged for, at a specific point of time.
- CurrencyCode; string; The currency code of the matched opportunity. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
- EffectiveDate; string; The date and time when the opportunity was closed.
- ForecastCategory; string; Specifies the categories used to represent the commitment level for sales forecasting such as pipeline, best case, most likely and so on.
- IBAssetNumber; string; Asset number of the installed base asset of the opportunity.
- IBAssetSerialNumber; string; The associated installed base Asset's Serial number
- KeyContactId; integer; The unique identifier of the primary contact associated with the opportunity.
- LastUpdateDate; string; The date and time when the opportunity record was last updated.
- LineOfBusinessCode; string; The code indicating which line of business owns the opportunity.
- LookupCategory; string; The status category of the opportunity status.
- Name; string; The name of the opportunity.
- OpportunityOrigin; string; The value for the origin of the opportunity.
- OptyCreationDate; string; The date and time when the opportunity was created.
- OptyId; integer; The unique identifier of the opportunity.
- OptyLastUpdateDate; string; The date when the opportunity was last updated.
- OptyLastUpdatedBy; string; The user who last updated the opportunity.
- OptyNumber; string; The unique alternate identifier for the opportunity.
- OwnerPartyNumber; string; The owner party number of the opportunity.
- OwnerResourcePartyId; integer; The unique identifier of a valid employee resource who owns and manages the opportunity.
- PartyName1; string; The name of the opportunity owner.
- PartyUniqueName1; string; The unique name of the primary competitor for the opportunity.
- PredWinProb; number; AI predicted win probability percent.
- PrimaryCampaignId; integer; The unique identifier of the primary campaign associated with the matched opportunity.
- PrimaryCampaignName; string; The name of the primary campaign associated with the matched opportunity.
- PrimaryCampaignNumber; string; The alternate unique identifier of the primary campaign associated with the matched opportunity.
- PrimaryCompetitorId; integer; The unique identifier of the primary competitor associated with the opportunity.
- PrimaryCompetitorPartyNumber; string; The party number of the primary competitor associated with the opportunity.
- PrimaryContactPartyName; string; The name of the primary contact associated with the opportunity.
- PrimaryContactPartyNumber; string; The party number of the primary contact associated with the opportunity.
- PrimaryPartnerCompanyNumber; string; The party number of the primary partner associated with the opportunity.
- PrimaryPartnerId; integer; The unique identifier of the primary partner associated with the opportunity.
- QuotedFlag; boolean; Indicates that a quote has been created for this Opportunity.
- ReasonWonLostCode; string; The reason for winning or losing the opportunity. A list of valid values is defined in the lookup MOO_SETID_WIN_LOSS_REASON. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
- RecommendedAction; string; AI recommended action.
- RecordSet; string; The record set of the opportunity.
- SalesChannelCd; string; The code indicating the sales channel for the opportunity.
- SalesMethod; string; The sales method associated with the opportunity.
- SalesMethodId; integer; The unique identifier of the sales method associated with the opportunity.
- SalesStageId; integer; The unique identifier of the sales stage associated with the opportunity.
- SetupRefCode; string; The public unique identifier for the CPQ configuration setup.
- StatusCode; string; The status of the opportunity. A list of valid values is defined in the lookup MOO_OPTY_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
- TargetPartyId; integer; The unique identifier of the sales account associated with the opportunity.
- WinProb; integer; The estimated probability of winning the opportunity.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : deals-MatchedOpportunity
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : deals-MatchedOpportunity-item-response
Type:
Show Source
object
-
AccountPartyNumber: string
Title:
Account Number
Read Only:true
Maximum Length:30
The party number of the account associated with the matched opportunity. -
AssetId: integer
(int64)
The unique identifier of the asset associated with the opportunity.
-
AssetNumber: string
Title:
Asset Number
Maximum Length:100
The alternate key identifier of the asset associated with the opportunity. -
AssetProduct: string
Title:
Asset
The asset product associated with the opportunity. -
AssetSerialNumber: string
Title:
Asset Serial Number
Read Only:true
Maximum Length:100
The asset serial number associated with the opportunity. -
AssignmentMode: string
Title:
Assignment Mode
Maximum Length:30
Specifies the types of assignment mode options available for controlling auto assignment default behavior for opportunity record updates. -
AverageDaysAtStage: integer
(int64)
Title:
Duration
Read Only:true
The average duration, in number of days, that the opportunity remains in the current sales stage. -
BatchTag: string
Title:
Batch Tag
Maximum Length:30
The batch tag of the opportunity. -
BdgtAmount: number
Title:
Budget Amount
Budget amount from the sales account. -
BdgtAmtCurcyCd: string
Title:
Budget Amount Currency
Maximum Length:15
The currency code for budget amount from the sales account. -
BudgetAvailableDate: string
(date)
Title:
Date Budget Available
The date and time when the opportunity budget was made available. -
BudgetedFlag: boolean
Title:
Budgeted
Maximum Length:1
Default Value:false
Indicates if the opportunity sales account has the budget approved for the potential purchase. If the value is true, then the sales account has the budget approved for the purchase. The default value is False. -
ChampionFlag: boolean
Title:
Key Internal Sponsor
Maximum Length:1
Default Value:false
Indicates if the opportunity has an internal sponsor. If the value is true, then the opportunity has an internal sponsor. The default value is False. -
ClosePeriod: string
Title:
Close Period
Read Only:true
The close period of the opportunity. -
Comments: string
Title:
Comments
Maximum Length:2000
The user-provided comments for the opportunity. -
ConflictId: integer
(int64)
Title:
Conflict ID
Default Value:0
Disconnected Mobile: this value is used to guarantee the uniqueness of the row when duplicates are created in different databases (i.e. mobile databases or the server). -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the opportunity record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the opportunity record was created. -
CrmConversionRate: number
Title:
Conversion Rate
This rate is used for the conversion of the revenue amount to the CRM common currency to facilitate the computation of the revenue forecast metrics. This is the amount that one currency can be exchanged for, at a specific point of time. -
CrmCurrencyCode: string
Title:
CRM Common Currency
Read Only:true
Maximum Length:15
CRM common currency code. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code of the matched opportunity. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CustomerAccountId: integer
(int64)
Title:
Billing Account
The unique identifier of the customer billing account associated with the opportunity. -
DealHorizonCode: string
Title:
Estimated Deal Duration
Maximum Length:30
The estimated time, in days, required to close the deal. A list of valid values is defined in the lookup MOO_SETID_DEAL_HORIZION. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
DecisionLevelCode: string
Title:
Decision Level
Maximum Length:30
The job level of the person who takes the final decision for the opportunity. A list of valid values is defined in the lookup MOO_SETID_DECISION_LEVEL. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the opportunity can be deleted. -
Description: string
Title:
Sales Objective
Maximum Length:2000
The description of the opportunity, including the sales objective. -
DescriptionText: string
Title:
Description
Read Only:true
Maximum Length:255
The description of the sales objective of the opportunity. -
DownsideAmount: number
Title:
Worst Case
Default Value:0
The minimum amount of revenue for the opportunity. -
EffectiveDate: string
(date)
Title:
Close Date
The date and time when the opportunity was closed. -
EmailAddress: string
Title:
Owner Email
Read Only:true
Maximum Length:320
The e-mail address of the employee resource that owns the opportunity. -
ExpectAmount: number
Title:
Expected Revenue
Default Value:0
The expected revenue from the opportunity. -
ForecastCategory: string
Title:
Forecast Category
Maximum Length:30
Specifies the categories used to represent the commitment level for sales forecasting such as pipeline, best case, most likely and so on. -
ForecastOverrideCode: string
Title:
Include in Forecast
Maximum Length:30
The code that indicates if the revenue forecast should be overridden. The valid values are ALWAYS, NEVER, and CRITERIA. -
HintCode: string
Title:
Hint Code
Read Only:true
Maximum Length:10
AI hint code. -
IBAssetId: integer
(int64)
Title:
Installed Base Asset
Identifier of the installed base asset of the opportunity. -
IBAssetNumber: string
Title:
Installed Base Asset Number
Read Only:true
Maximum Length:80
Asset number of the installed base asset of the opportunity. -
IBAssetSerialNumber: string
Title:
Installed Base Asset Serial Number
Read Only:true
Maximum Length:80
The associated installed base Asset's Serial number -
KeyContactId: integer
(int64)
Title:
Primary Contact
The unique identifier of the primary contact associated with the opportunity. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the opportunity record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the opportunity record. -
LastUpdateLogin: string
Title:
Last Update Login
Maximum Length:32
The login of the user who last updated the opportunity record. -
LineOfBusinessCode: string
Title:
Line of Business
Maximum Length:30
The code indicating which line of business owns the opportunity. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupCategory: string
Title:
Status Category
Read Only:true
Maximum Length:30
The status category of the opportunity status. -
ManageGeneralProfileDataFlag: boolean
Title:
Manage General Profile Data
Read Only:true
Allows management of general opportunity information such as competitors, lead, source, contacts, references, interactions, and assessments. -
ManageRestrictedProfileDataFlag: boolean
Title:
Manage Restricted Profile Data
Read Only:true
Allows management of restricted opportunity information such as sales method, sales stage, sales account, primary contact, and partners. -
ManageRevenueDataFlag: boolean
Title:
Manage Revenue Data
Read Only:true
Allows management of revenue data, such as products and recurring revenue information. -
ManageTeamDataFlag: boolean
Title:
Manage Team Data
Read Only:true
Allows management of opportunity sales team data. -
MaximumDaysInStage: integer
(int64)
Title:
Stalled Deal Limit
Read Only:true
The maximum duration, in number of days, that the opportunity can remain in the sales stage before it is considered stalled. -
Name: string
Title:
Name
Maximum Length:275
The name of the opportunity. -
OpportunityOrigin: string
Title:
Opportunity Origin
Maximum Length:30
Default Value:SALES_OPTY
The value for the origin of the opportunity. -
OpportunityTypeCode: string
Title:
Opportunity Type
Maximum Length:30
Display the different types of opportunity such as new, renewal and expansion. -
OptyCreatedBy: string
Title:
Opportunity Created By
Maximum Length:64
The user who created the opportunity. -
OptyCreationDate: string
(date-time)
Title:
Opportunity Creation Date
The date and time when the opportunity was created. -
OptyId: integer
(int64)
Title:
Opportunity ID
The unique identifier of the opportunity. -
OptyLastUpdateDate: string
(date-time)
Title:
Opportunity Last Updated Date
The date when the opportunity was last updated. -
OptyLastUpdatedBy: string
Title:
Opportunity Last Updated By
Maximum Length:64
The user who last updated the opportunity. -
OptyNumber: string
Title:
Opportunity Number
Maximum Length:30
The unique alternate identifier for the opportunity. -
OwnerPartyNumber: string
Title:
Owner Number
Read Only:true
Maximum Length:30
The owner party number of the opportunity. -
OwnerResourcePartyId: integer
(int64)
Title:
Owner
The unique identifier of a valid employee resource who owns and manages the opportunity. -
PartyName1: string
Title:
Owner
Read Only:true
Maximum Length:360
The name of the opportunity owner. -
PartyUniqueName1: string
Title:
Primary Competitor
Read Only:true
Maximum Length:900
The unique name of the primary competitor for the opportunity. -
PhaseCd: string
Title:
Phase
Read Only:true
Maximum Length:30
Default Value:"B - Working the Deal"
The code indicating the current phase of the opportunity sales stage. -
PredWinProb: number
Title:
Predicted Win Probability
Read Only:true
AI predicted win probability percent. -
PrimaryCampaignId: integer
(int64)
Title:
Primary Campaign ID
The unique identifier of the primary campaign associated with the matched opportunity. -
PrimaryCampaignName: string
Title:
Primary Campaign
The name of the primary campaign associated with the matched opportunity. -
PrimaryCampaignNumber: string
Title:
Primary Campaign Number
Maximum Length:30
The alternate unique identifier of the primary campaign associated with the matched opportunity. -
PrimaryCompetitorId: integer
(int64)
Title:
Primary Competitor
The unique identifier of the primary competitor associated with the opportunity. -
PrimaryCompetitorPartyNumber: string
Title:
Primary Competitor Party Number
Read Only:true
Maximum Length:30
The party number of the primary competitor associated with the opportunity. -
PrimaryContactEmailAddress: string
Title:
Primary Contact Email
Read Only:true
Maximum Length:320
The e-mail address of the primary contact associated with the opportunity. -
PrimaryContactEmailPref: string
Title:
Primary Contact Email Preference
Read Only:true
Maximum Length:255
Indicates if the primary contact has an email preference of do not email, ok to email, or no value. -
PrimaryContactFormattedPhoneNumber: string
Title:
Primary Contact Phone
Read Only:true
The phone number of the primary contact associated with the opportunity. -
PrimaryContactPartyName: string
Title:
Primary Contact
Read Only:true
Maximum Length:360
The name of the primary contact associated with the opportunity. -
PrimaryContactPartyNumber: string
Title:
Primary Contact Party Number
Read Only:true
Maximum Length:30
The party number of the primary contact associated with the opportunity. -
PrimaryContactPhonePref: string
Title:
Primary Contact Phone Preference
Read Only:true
Maximum Length:255
Indicates if the primary contact has a phone preference of do not call, ok to call, or no value. -
PrimaryOrganizationId: integer
(int64)
Title:
Business Unit ID
The unique identifier of the business unit associated with the opportunity. -
PrimaryPartnerCompanyNumber: string
Title:
Primary Partner Number
Maximum Length:30
The party number of the primary partner associated with the opportunity. -
PrimaryPartnerId: integer
(int64)
Title:
Primary Partner
The unique identifier of the primary partner associated with the opportunity. -
PrimaryPartnerOrgPartyName: string
Title:
Primary Partner
Maximum Length:360
The organization party name of the primary partner associated with the opportunity. -
PrimaryRevenueId: integer
(int64)
Title:
Summary Revenue Line ID
The unique identifier of the summary revenue line associated with the opportunity. -
PrimarySubscriptionId: integer
(int64)
Title:
Primary Subscription Id
The unique identifier of the primary subscription of the opportunity. -
PrimarySubscriptionNumber: string
Title:
Subscription Number
Read Only:true
Maximum Length:120
The alternate identifier of primary subscription of the opportunity. -
PrSrcNumber: string
Title:
Primary Source Number
Maximum Length:100
The unique identifier of the primary marketing source or campaign that generated the opportunity. -
QuotaFactor: number
Title:
Quota Factor
Read Only:true
The quota factor of the opportunity sales stage. -
QuotedFlag: boolean
Title:
Quoted
Maximum Length:1
Default Value:false
Indicates that a quote has been created for this Opportunity. -
RcmndWinProb: number
Title:
Win Probability
Read Only:true
Default Value:0
The recommended probability of winning the opportunity in the sales stage. -
ReasonWonLostCode: string
Title:
Win/Loss Reason
Maximum Length:30
The reason for winning or losing the opportunity. A list of valid values is defined in the lookup MOO_SETID_WIN_LOSS_REASON. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
RecommendedAction: string
Title:
Recommended Action
Read Only:true
Maximum Length:180
AI recommended action. -
RecordSet: string
Read Only:
true
The record set of the opportunity. -
Registered: string
Title:
Registered
Maximum Length:30
Indicates whether the opportunity was registered. The valid values are Expired, Yes, and No. -
RegistrationStatus: string
Title:
Registration Status
Maximum Length:30
The registration status of the opportunity. -
RegistrationType: string
Title:
Registration Type
Maximum Length:30
The registration type used by the partner to create the opportunity. -
RenewalProcess: string
Title:
Renewal Process
Maximum Length:30
The renewal process can be manual, do not renew or automatic renewal. -
Revenue: number
Title:
Amount
Default Value:0
The revenue amount of the opportunity. -
RiskLevelCode: string
Title:
Level of Risk
Maximum Length:30
The risk level code of the opportunity. A list of valid values is defined in the lookup MOO_SETID_RISK_LEVE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
SalesAccountUniqueName: string
Title:
Customer Account
Read Only:true
Maximum Length:900
The unique name of the sales account that owns the opportunity. -
SalesChannelCd: string
Title:
Sales Channel
Maximum Length:50
The code indicating the sales channel for the opportunity. -
SalesMethod: string
Title:
Sales Method
Read Only:true
Maximum Length:50
The sales method associated with the opportunity. -
SalesMethodId: integer
(int64)
Title:
Sales Method
The unique identifier of the sales method associated with the opportunity. -
SalesStage: string
Title:
Sales Stage
Read Only:true
Maximum Length:50
The current sales stage of the opportunity. -
SalesStageId: integer
(int64)
Title:
Sales Stage
The unique identifier of the sales stage associated with the opportunity. -
Selected: boolean
Indicates if the matched opportunity is selected.
-
SetupRefCode: string
Maximum Length:
80
The public unique identifier for the CPQ configuration setup. -
SourceType: string
Title:
Source Type
Read Only:true
The source type of the opportunity. -
StageStatusCd: string
Title:
Status
Read Only:true
Maximum Length:30
Default Value:"Open"
The code indicating the default status of the sales stage associated with the opportunity. -
StatusCode: string
Title:
Status
Maximum Length:30
The status of the opportunity. A list of valid values is defined in the lookup MOO_OPTY_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
StgOrder: number
Title:
Order
Read Only:true
The order of the opportunity's sales stage in the sales method. -
StrategicLevelCode: string
Title:
Strategic Value
Maximum Length:30
The strategic value that the opportunity has for the sales account. A list of valid values is defined in the lookup MOO_SETID_STRATEGIC_VALUE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
TargetPartyId: integer
(int64)
Title:
Account
The unique identifier of the sales account associated with the opportunity. -
TargetPartyName: string
Title:
Account
Read Only:true
Maximum Length:360
The name of the sales account associated with the opportunity. -
TargetPartyPrimaryAddressCountry: string
Title:
Account Country
Read Only:true
Maximum Length:2
Country of the primary account's primary address. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the opportunity can be updated. -
UpsideAmount: number
Title:
Best Case
Default Value:0
The maximum amount of revenue for the opportunity. -
WinProb: integer
(int32)
Title:
Win Probability
The estimated probability of winning the opportunity.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- assignOpportunity
-
Parameters:
- dealsUniqID:
$request.path.dealsUniqID
This method lets you assign a matched opportunity. - dealsUniqID:
- copyOpportunity
-
Parameters:
- dealsUniqID:
$request.path.dealsUniqID
This method lets you copy a matched opportunity. - dealsUniqID:
- createQuote
-
Operation: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/MatchedOpportunity/action/createQuoteParameters:
- dealsUniqID:
$request.path.dealsUniqID
This method lets you invoke a create quote process in an active Oracle CPQ Cloud integration. - dealsUniqID:
Examples
The following example shows how to get all opportunities by submitting a get request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/deals/300100071991763/child/MatchedOpportunity
Example of Response Body
The following shows an example of the response body in JSON format.
{ -items: [1] -0: { PrimaryOrganizationId: 100000015105046 ChampionFlag: false CurrencyCode: "USD" SalesMethodId: 100000012430001 SalesStageId: 100000012430007 Name: "Major Application Upgrade" OptyId: 300100089504947 OptyNumber: "CDRM_98919" OwnerResourcePartyId: 100000016934102 ... }