Jump to

• Request
• Response
• Examples

Get an opportunity

get

/crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/MatchedOpportunity/{OptyId}

Request

Path Parameters

• OptyId(required): integer(int64)
  The unique identifier of the opportunity.
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 Top

Response

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.

Body ()

Root Schema : deals-MatchedOpportunity-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the opportunity record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyLastUpdateDate":{
            "title":"Opportunity Last Updated Date",
            "type":"string",
            "description":"The date when the opportunity was last updated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"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).",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QuotaFactor":{
            "title":"Quota Factor",
            "type":"number",
            "description":"The quota factor of the opportunity sales stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"22",
                "scale":"7"
            }
        },
        "PredWinProb":{
            "title":"Predicted Win Probability",
            "type":"number",
            "description":"AI predicted win probability percent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "PrimaryCompetitorId":{
            "title":"Primary Competitor",
            "type":"integer",
            "description":"The unique identifier of the primary competitor associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Competitor",
                "RecentItemEntityName":"competitors",
                "dependencies":[
                    "PriCompPartyUniqueName1",
                    "PrimaryCompetitorName"
                ]
            },
            "x-queryable":true
        },
        "PrimaryPartnerId":{
            "title":"Primary Partner",
            "type":"integer",
            "description":"The unique identifier of the primary partner associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Partner",
                "RecentItemEntityName":"partners"
            },
            "x-queryable":true
        },
        "IBAssetId":{
            "title":"Installed Base Asset",
            "type":"integer",
            "description":"Identifier of the installed base asset of the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "IBAssetNumber"
                ]
            }
        },
        "PrimaryContactEmailAddress":{
            "title":"Primary Contact Email",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address of the primary contact associated with the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            }
        },
        "RecommendedAction":{
            "title":"Recommended Action",
            "maxLength":"180",
            "type":"string",
            "description":"AI recommended action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupCategory":{
            "title":"Status Category",
            "maxLength":"30",
            "type":"string",
            "description":"The status category of the opportunity status.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identifier for the opportunity.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "PrimaryPartnerCompanyNumber":{
            "title":"Primary Partner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The party number of the primary partner associated with the opportunity.",
            "nullable":false,
            "x-queryable":true
        },
        "TargetPartyId":{
            "title":"Account",
            "type":"integer",
            "description":"The unique identifier of the sales account associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Account",
                "RecentItemEntityName":"accounts"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the opportunity record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OptyCreatedBy":{
            "title":"Opportunity Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the opportunity record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PrSrcNumber":{
            "title":"Primary Source Number",
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier of the primary marketing source or campaign that generated the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "EmailAddress":{
            "title":"Owner Email",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address of the employee resource that owns the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            }
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the opportunity can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OptyCreationDate":{
            "title":"Opportunity Creation Date",
            "type":"string",
            "description":"The date and time when the opportunity was created.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "OptyLastUpdatedBy":{
            "title":"Opportunity Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the opportunity.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "PrimaryContactPartyNumber":{
            "title":"Primary Contact Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The party number of the primary contact associated with the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "KeyContactId":{
            "title":"Primary Contact",
            "type":"integer",
            "description":"The unique identifier of the primary contact associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Contact",
                "RecentItemEntityName":"contacts",
                "dependencies":[
                    "PriContactPartyNameTransientForLOV",
                    "PriContactPartyName1"
                ]
            },
            "x-queryable":true
        },
        "ManageTeamDataFlag":{
            "title":"Manage Team Data",
            "type":"boolean",
            "description":"Allows management of opportunity sales team data.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Revenue":{
            "title":"Amount",
            "type":"number",
            "description":"The revenue amount of the opportunity.",
            "nullable":true,
            "default":"0",
            "x-queryable":false
        },
        "AssetId":{
            "type":"integer",
            "description":"The unique identifier of the asset associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Asset",
                "RecentItemEntityName":"assets",
                "dependencies":[
                    "AssetProduct",
                    "AssetNumber",
                    "AssetProductForExtnLOV"
                ]
            }
        },
        "OpportunityOrigin":{
            "title":"Opportunity Origin",
            "maxLength":"30",
            "type":"string",
            "description":"The value for the origin of the opportunity.",
            "nullable":true,
            "default":"SALES_OPTY",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the opportunity record.",
            "nullable":true,
            "x-queryable":false
        },
        "IBAssetSerialNumber":{
            "title":"Installed Base Asset Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"The associated installed base Asset's Serial number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BudgetAvailableDate":{
            "title":"Date Budget Available",
            "type":"string",
            "description":"The date and time when the opportunity budget was made available.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Sales Objective",
            "maxLength":"2000",
            "type":"string",
            "description":"The description of the opportunity, including the sales objective.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "OwnerPartyNumber":{
            "title":"Owner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The owner party number of the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetPartyPrimaryAddressCountry":{
            "title":"Account Country",
            "maxLength":"2",
            "type":"string",
            "description":"Country of the primary account's primary address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AverageDaysAtStage":{
            "title":"Duration",
            "type":"integer",
            "description":"The average duration, in number of days, that the opportunity remains in the current sales stage.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"10"
            }
        },
        "OpportunityTypeCode":{
            "title":"Opportunity Type",
            "maxLength":"30",
            "type":"string",
            "description":"Display the different types of opportunity such as new, renewal and expansion.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StgOrder":{
            "title":"Order",
            "type":"number",
            "description":"The order of the opportunity's sales stage in the sales method.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"22",
                "scale":"7"
            }
        },
        "AccountPartyNumber":{
            "title":"Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"The party number of the account associated with the matched opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StageStatusCd":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the default status of the sales stage associated with the opportunity.",
            "nullable":true,
            "readOnly":true,
            "default":"\"Open\"",
            "x-queryable":false
        },
        "DealHorizonCode":{
            "title":"Estimated Deal Duration",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "DecisionLevelCode":{
            "title":"Decision Level",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "OwnerResourcePartyId":{
            "title":"Owner",
            "type":"integer",
            "description":"The unique identifier of a valid employee resource who owns and manages the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "RecentItemEntityName":"resources"
            },
            "x-queryable":true
        },
        "BdgtAmtCurcyCd":{
            "title":"Budget Amount Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code for budget amount from the sales account.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryCompetitorPartyNumber":{
            "title":"Primary Competitor Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The party number of the primary competitor associated with the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryCampaignName":{
            "title":"Primary Campaign",
            "type":"string",
            "description":"The name of the primary campaign associated with the matched opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PrimaryCampaignName1"
                ]
            },
            "x-queryable":true
        },
        "DownsideAmount":{
            "title":"Worst Case",
            "type":"number",
            "description":"The minimum amount of revenue for the opportunity.",
            "nullable":true,
            "default":"0",
            "x-queryable":false
        },
        "Selected":{
            "type":"boolean",
            "description":"Indicates if the matched opportunity is selected.",
            "nullable":true,
            "x-queryable":false
        },
        "AssetProduct":{
            "title":"Asset",
            "type":"string",
            "description":"The asset product associated with the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "IBAssetNumber":{
            "title":"Installed Base Asset Number",
            "maxLength":"80",
            "type":"string",
            "description":"Asset number of the installed base asset of the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryCampaignId":{
            "title":"Primary Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the primary campaign associated with the matched opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "RecentItemEntityName":"campaigns"
            },
            "x-queryable":true
        },
        "QuotedFlag":{
            "title":"Quoted",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that a quote has been created for this Opportunity.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "RcmndWinProb":{
            "title":"Win Probability",
            "type":"number",
            "description":"The recommended probability of winning the opportunity in the sales stage.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":false,
            "x-hints":{
                "precision":"22",
                "scale":"7"
            }
        },
        "RegistrationStatus":{
            "title":"Registration Status",
            "maxLength":"30",
            "type":"string",
            "description":"The registration status of the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "ManageRevenueDataFlag":{
            "title":"Manage Revenue Data",
            "type":"boolean",
            "description":"Allows management of revenue data, such as products and recurring revenue information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CrmConversionRate":{
            "title":"Conversion Rate",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ManageGeneralProfileDataFlag":{
            "title":"Manage General Profile Data",
            "type":"boolean",
            "description":"Allows management of general opportunity information such as competitors, lead, source, contacts, references, interactions, and assessments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SalesChannelCd":{
            "title":"Sales Channel",
            "maxLength":"50",
            "type":"string",
            "description":"The code indicating the sales channel for the opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "DescriptionText":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the sales objective of the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "ChampionFlag":{
            "title":"Key Internal Sponsor",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "ClosePeriod":{
            "title":"Close Period",
            "type":"string",
            "description":"The close period of the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DefaultQueryValue":"CURR_QTR",
                "controlType":"choice",
                "operators":[
                    "="
                ],
                "AttributeType":"Picklist"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the opportunity record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesMethodId":{
            "title":"Sales Method",
            "type":"integer",
            "description":"The unique identifier of the sales method associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "Dependencies":"PrimaryOrganizationId"
            },
            "x-queryable":true
        },
        "SourceType":{
            "title":"Source Type",
            "type":"string",
            "description":"The source type of the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "UpsideAmount":{
            "title":"Best Case",
            "type":"number",
            "description":"The maximum amount of revenue for the opportunity.",
            "nullable":true,
            "default":"0",
            "x-queryable":false
        },
        "PrimaryCampaignNumber":{
            "title":"Primary Campaign Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the primary campaign associated with the matched opportunity.",
            "nullable":false,
            "x-queryable":true
        },
        "ForecastCategory":{
            "title":"Forecast Category",
            "maxLength":"30",
            "type":"string",
            "description":"Specifies the categories used to represent the commitment level for sales forecasting such as pipeline, best case, most likely and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectAmount":{
            "title":"Expected Revenue",
            "type":"number",
            "description":"The expected revenue from the opportunity.",
            "nullable":true,
            "default":"0",
            "x-queryable":false
        },
        "PartyName1":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the opportunity owner.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ],
                "AttributeType":"Picklist",
                "Dependencies":"PrimaryOrganizationId"
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Asset Number",
            "maxLength":"100",
            "type":"string",
            "description":"The alternate key identifier of the asset associated with the opportunity.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"275",
            "type":"string",
            "description":"The name of the opportunity.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "PrimaryContactFormattedPhoneNumber":{
            "title":"Primary Contact Phone",
            "type":"string",
            "description":"The phone number of the primary contact associated with the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactPartyId"
                ]
            }
        },
        "RiskLevelCode":{
            "title":"Level of Risk",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RecordSet":{
            "type":"string",
            "description":"The record set of the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "AssignmentMode":{
            "title":"Assignment Mode",
            "maxLength":"30",
            "type":"string",
            "description":"Specifies the types of assignment mode options available for controlling auto assignment default behavior for opportunity record updates.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            }
        },
        "SalesAccountUniqueName":{
            "title":"Customer Account",
            "maxLength":"900",
            "type":"string",
            "description":"The unique name of the sales account that owns the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            }
        },
        "MaximumDaysInStage":{
            "title":"Stalled Deal Limit",
            "type":"integer",
            "description":"The maximum duration, in number of days, that the opportunity can remain in the sales stage before it is considered stalled.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"10"
            }
        },
        "ReasonWonLostCode":{
            "title":"Win/Loss Reason",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"PrimaryOrganizationId"
            },
            "x-queryable":true
        },
        "SalesMethod":{
            "title":"Sales Method",
            "maxLength":"50",
            "type":"string",
            "description":"The sales method associated with the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "SalesStageId":{
            "title":"Sales Stage",
            "type":"integer",
            "description":"The unique identifier of the sales stage associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "precision":"18",
                "Dependencies":"SalesMethodId,PrimaryOrganizationId"
            },
            "x-queryable":true
        },
        "WinProb":{
            "title":"Win Probability",
            "type":"integer",
            "description":"The estimated probability of winning the opportunity.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "precision":"5"
            },
            "x-queryable":true
        },
        "AssetSerialNumber":{
            "title":"Asset Serial Number",
            "maxLength":"100",
            "type":"string",
            "description":"The asset serial number associated with the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BdgtAmount":{
            "title":"Budget Amount",
            "type":"number",
            "description":"Budget amount from the sales account.",
            "nullable":true,
            "x-queryable":false
        },
        "TargetPartyName":{
            "title":"Account",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the sales account associated with the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryPartnerOrgPartyName":{
            "title":"Primary Partner",
            "maxLength":"360",
            "type":"string",
            "description":"The organization party name of the primary partner associated with the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SetupRefCode":{
            "maxLength":"80",
            "type":"string",
            "description":"The public unique identifier for the CPQ configuration setup.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimarySubscriptionId":{
            "title":"Primary Subscription Id",
            "type":"integer",
            "description":"The unique identifier of the primary subscription of the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "HintCode":{
            "title":"Hint Code",
            "maxLength":"10",
            "type":"string",
            "description":"AI hint code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the opportunity can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryContactPartyName":{
            "title":"Primary Contact",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the primary contact associated with the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "PrimaryContactPhonePref":{
            "title":"Primary Contact Phone Preference",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates if the primary contact has a phone preference of do not call, ok to call, or no value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactPartyId"
                ]
            }
        },
        "CrmCurrencyCode":{
            "title":"CRM Common Currency",
            "maxLength":"15",
            "type":"string",
            "description":"CRM common currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RenewalProcess":{
            "title":"Renewal Process",
            "maxLength":"30",
            "type":"string",
            "description":"The renewal process can be manual, do not renew or automatic renewal.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CustomerAccountId":{
            "title":"Billing Account",
            "type":"integer",
            "description":"The unique identifier of the customer billing account associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            }
        },
        "RegistrationType":{
            "title":"Registration Type",
            "maxLength":"30",
            "type":"string",
            "description":"The registration type used by the partner to create the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "PrimaryOrganizationId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the business unit associated with the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ],
                "precision":"18"
            }
        },
        "StrategicLevelCode":{
            "title":"Strategic Value",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "PartyUniqueName1":{
            "title":"Primary Competitor",
            "maxLength":"900",
            "type":"string",
            "description":"The unique name of the primary competitor for the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "BudgetedFlag":{
            "title":"Budgeted",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "SalesStage":{
            "title":"Sales Stage",
            "maxLength":"50",
            "type":"string",
            "description":"The current sales stage of the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The user-provided comments for the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "PhaseCd":{
            "title":"Phase",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the current phase of the opportunity sales stage.",
            "nullable":false,
            "readOnly":true,
            "default":"\"B - Working the Deal\"",
            "x-queryable":false
        },
        "ManageRestrictedProfileDataFlag":{
            "title":"Manage Restricted Profile Data",
            "type":"boolean",
            "description":"Allows management of restricted opportunity information such as sales method, sales stage, sales account, primary contact, and partners.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PrimarySubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":"120",
            "type":"string",
            "description":"The alternate identifier of primary subscription of the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LineOfBusinessCode":{
            "title":"Line of Business",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating which line of business owns the opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "ForecastOverrideCode":{
            "title":"Include in Forecast",
            "maxLength":"30",
            "type":"string",
            "description":"The code that indicates if the revenue forecast should be overridden. The valid values are ALWAYS, NEVER, and CRITERIA.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "PrimaryContactEmailPref":{
            "title":"Primary Contact Email Preference",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates if the primary contact has an email preference of do not email, ok to email, or no value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactPartyId"
                ]
            }
        },
        "PrimaryRevenueId":{
            "title":"Summary Revenue Line ID",
            "type":"integer",
            "description":"The unique identifier of the summary revenue line associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Registered":{
            "title":"Registered",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the opportunity was registered. The valid values are Expired, Yes, and No.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EffectiveDate":{
            "title":"Close Date",
            "type":"string",
            "description":"The date and time when the opportunity was closed.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "BETWEEN"
                ]
            },
            "x-queryable":true
        },
        "BatchTag":{
            "title":"Batch Tag",
            "maxLength":"30",
            "type":"string",
            "description":"The batch tag of the opportunity.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

AssetVA

Operation: /crmRestApi/resources/11.13.18.05/assets

Assets represents the products owned by Customers. Anything tangible or intangible that is capable of being owned or controlled to produce value. For example: Tangible Items - Computers, engines, machine parts, and so on. Intangible items - Software, Services, Licenses and agreements

AssignmentModeLookupPVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{AssignmentMode}%2CBindLookupType%3DORA_MOO_OPTY_ASGN_MODE_OPTIONS

The lookups resource is used to view standard lookup codes.

BusinessUnitPVO

Operation: /crmRestApi/resources/11.13.18.05/crmBusinessUnits

The CRM business units resource is used to view the business unit details.

CampaignVOVA

Operation: /crmRestApi/resources/11.13.18.05/campaigns

The campaigns resource is used to view, create, update, and delete campaigns. A campaign is an effort reach out to contacts and leads to convert them to a customer.

ClosePeriodLookupPVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsEnabledFinder%3BBindLookupType%3DMOO_OPTY_SRCH_CLS_PERIOD

The lookups resource is used to view standard lookup codes.

CustomerAccountPickerVO

Operation: /crmRestApi/resources/11.13.18.05/accounts

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.

ForecastCategoryVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{ForecastCategory}%2CBindLookupType%3DORA_MOO_FORECAST_CATEGORY_TYPE

The lookups resource is used to view standard lookup codes.

FrcstOverrideCodeLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZSF_FCST_INCLUDE_IN_FCST%2CBindLookupCode%3D{ForecastOverrideCode}

The lookups resource is used to view standard lookup codes.

LobForSearchLookupPVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOT_LINE_OF_BUSINESS%2CBindLookupCode%3D{LineOfBusinessCode}

The lookups resource is used to view standard lookup codes.

OpportunityOriginVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{OpportunityOrigin}%2CBindLookupType%3DORA_MOO_OPPORTUNITY_ORIGIN

The lookups resource is used to view standard lookup codes.

OpportunityTypePVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{OpportunityTypeCode}%2CBindLookupType%3DORA_MOO_OPPORTUNITY_TYPE

The lookups resource is used to view standard lookup codes.

OptyDealHorizonLOV

Operation: /crmRestApi/resources/11.13.18.05/fndCommonSetIdLookups

Parameters:

• finder: CommonSetIdWithBUIdFinder%3BpBusinessUnitId%3D{PrimaryOrganizationId}%2CpLookupType%3DMOO_SETID_DEAL_HORIZION%2CpReferenceGroupName%3DMOO_SETID_DEAL_HORIZION%2CpEnabledFlag%3DY

The FND common set Id lookups resource is used to view, create, update, and delete lookups for the foundation common set Id.

OptyDecisionLevelLOV

Operation: /crmRestApi/resources/11.13.18.05/fndCommonSetIdLookups

Parameters:

• finder: CommonSetIdWithBUIdFinder%3BpBusinessUnitId%3D{PrimaryOrganizationId}%2CpLookupType%3DMOO_SETID_DECISION_LEVEL%2CpReferenceGroupName%3DMOO_SETID_DECISION_LEVEL%2CpEnabledFlag%3DY

The FND common set Id lookups resource is used to view, create, update, and delete lookups for the foundation common set Id.

OptyRenewalProcessPVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{RenewalProcess}%2CBindLookupType%3DORA_MOO_OPTY_RENEWAL_PROCESS

The lookups resource is used to view standard lookup codes.

OptyRiskLevelLOV

Operation: /crmRestApi/resources/11.13.18.05/fndCommonSetIdLookups

Parameters:

• finder: CommonSetIdWithBUIdFinder%3BpBusinessUnitId%3D{PrimaryOrganizationId}%2CpLookupType%3DMOO_SETID_RISK_LEVEL%2CpReferenceGroupName%3DMOO_SETID_RISK_LEVEL%2CpEnabledFlag%3DY

The FND common set Id lookups resource is used to view, create, update, and delete lookups for the foundation common set Id.

OptyStatusCategoryLookupVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsEnabledFinder%3BBindLookupType%3DZBS_SALESLOOKUPS_CATEGORY

The lookups resource is used to view standard lookup codes.

OptyStatusZbsValuesLOV

Operation: /crmRestApi/resources/11.13.18.05/optyStatusesLOV

Parameters:

• finder: StatusByBUIdFinder%3BBindEnabledFlag%3DY%2CBindLookupType%3DOPTY_STATUS%2CBindBUId%3D{PrimaryOrganizationId}

The configurable setup data defined specifically for sales usage.

OptyStrategicValueLOV

Operation: /crmRestApi/resources/11.13.18.05/fndCommonSetIdLookups

Parameters:

• finder: CommonSetIdWithBUIdFinder%3BpBusinessUnitId%3D{PrimaryOrganizationId}%2CpLookupType%3DMOO_SETID_STRATEGIC_VALUE%2CpReferenceGroupName%3DMOO_SETID_STRATEGIC_VALUE%2CpEnabledFlag%3DY

The FND common set Id lookups resource is used to view, create, update, and delete lookups for the foundation common set Id.

PartnerPickerVA

Operation: /crmRestApi/resources/11.13.18.05/partnersLOV

Parameters:

• finder: ActivePartnersFinder%3BBindDefaultStatus%3DACTIVE%2CBindExtraStatus%3DACTIVE

The partner list of values resource is used to view a list of partners.

RatedCurrenciesVO

Operation: /crmRestApi/resources/11.13.18.05/ratedCurrencies

The rated currencies resource is used to view details of currency codes for CRM. It gives a list of accepted values that are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.

ReasonWonLostLOV

Operation: /crmRestApi/resources/11.13.18.05/fndCommonSetIdLookups

Parameters:

• finder: CommonSetIdWithBUIdFinder%3BpBusinessUnitId%3D{PrimaryOrganizationId}%2CpEnabledFlag%3DY%2CpLookupType%3DMOO_SETID_WIN_LOSS_REASON%2CpReferenceGroupName%3DMOO_SETID_WIN_LOSS_REASON

The FND common set Id lookups resource is used to view, create, update, and delete lookups for the foundation common set Id.

RegisteredLookupPVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MOO_DEAL_REGISTERED_FLAG

The lookups resource is used to view standard lookup codes.

RegistrationStatusLookupPVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DOPTY_PARTNER_REGISTRATION_TYPE%2CBindLookupCode%3D{RegistrationStatus}

The lookups resource is used to view standard lookup codes.

RegistrationTypeLookupPVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DPARTNER_REGISTRATION_INITIATOR%2CBindLookupCode%3D{RegistrationType}

The lookups resource is used to view standard lookup codes.

RevenueSalesChannelLookupVO

Operation: /crmRestApi/resources/11.13.18.05/revenueSalesChannels

Parameters:

• finder: SalesChannelFinder%3BBindLookupCode%3DZPM_PARTNER_CHANNEL_TYPES%2CBindLookupType%3DZPM_SALES_CHANNEL

The resource is used to view the values for sales channels of opportunity revenue.

SalesMethodLOV

Operation: /crmRestApi/resources/11.13.18.05/salesMethodsLOV

Parameters:

• finder: SalesMethodByBUFinder%3BBindBUId%3D{PrimaryOrganizationId}%2CBindOpportunityType%3D{OpportunityTypeCode}

A sales method is an approach used in the sales process. A method can encompass every stage associated with the sales process, from prospecting to forecasting to closing opportunities.

SalesStageLOV

Operation: /crmRestApi/resources/11.13.18.05/salesStagesLOV

Parameters:

• finder: SalesStageBySalesMethodFinder%3BBindSalesMethodId%3D{SalesMethodId}

The sales stage for a given sales method describes the progress of an opportunity in the sales cycle.

SearchFilteringLookupPVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsEnabledFinder%3BBindLookupType%3DMOO_OPTY_SRCH_RECORD_SET

The lookups resource is used to view standard lookup codes.

YesNoLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeFinder%3BBindLookupType%3DYES_NO

The lookups resource is used to view standard lookup codes.

Back to Top

Examples

The following example shows how to get an opportunity 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/300100089504947

Example of Response Body

The following shows an example of the response body in JSON format.

{    
  PrimaryOrganizationId: 100000015105046
  ChampionFlag: false
  CurrencyCode: "USD"
  SalesMethodId: 100000012430001
  SalesStageId: 100000012430007
  Name: "Major Application Upgrade"
  OptyId: 300100089504947
  OptyNumber: "CDRM_98919"
  OwnerResourcePartyId: 100000016934102
  ...
}

Back to Top