1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Opportunities
  4. Revenue Items

Get an opportunity revenue

get

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Revenue Items resource and used to uniquely identify an instance of Revenue Items. The client should not generate the hash key value. Instead, the client should query on the Revenue Items collection resource in order to navigate to a specific instance of Revenue Items to get the hash key.
  • The unique alternate identifier for the opportunity.
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : opportunities-ChildRevenue-item-response
Type: object
Show Source
  • Title: Actual Close Date
    The date when the revenue line was closed.
  • Title: Divide Amount by Transactions
    Maximum Length: 1
    The amounts are divided by the number of transactions based on the set schedule.
  • Title: Business Unit
    The unique identifier of the Business Unit that owns the opportunity.
  • Title: Revenue in Corporate Currency
    Read Only: true
    The calculated revenue amount in corporate currency.
  • Child Split Revenues
    Title: Child Split Revenues
    The child split revenue resource is used to view, create, update, and delete a split revenue. The revenue or nonrevenue credit is allocated to the resource which has contributed to the selling effort for an opportunity revenue line.
  • Title: Win/Loss Reason
    Maximum Length: 30
    The code indicating the reason for winning or losing the revenue. A list of valid values is defined in the lookup MOO_SETID_WIN_LOSS_REASON.
  • Title: Line Comments
    Maximum Length: 250
    The user-provided comments for the revenue line.
  • Title: Forecast
    Maximum Length: 1
    Indicates if the revenue line should be used for forecasting. If the value is true, then the revenue line should be used for forecasting. The default value is False.
  • Title: Competitor Party Name
    Read Only: true
    Maximum Length: 360
    The party name of the primary competitor of this child revenue.
  • Title: Conflict ID
    Default Value: 0
    The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
  • Title: Contract End Date
    The end date of the contract for the quote.
  • Title: Contract Start Date
    The start date of the contract for the quote.
  • Title: Conversion Rate
    The currency conversion rate for converting the revenue amount to opportunity summary currency. The rate is used if the revenue line is different from that of the opportunity.
  • Title: Conversion Rate Type
    Maximum Length: 30
    The currency conversion rate type for converting the revenue amount to opportunity summary currency. The rate type is used if the revenue line is different from that of the opportunity. For example, the rate type can be spot, user-defined, or corporate.
  • Title: Cost
    Default Value: 0
    The cost amount for the opportunity.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the child revenue record.
  • Title: Creation Date
    Read Only: true
    The date when the record was created.
  • Title: Credit Recipient Partner
    The unique identifier of the credit recipient partner organization party.
  • Title: CRM Conversion Rate
    The currency conversion rate for converting the revenue amount to CRM common currency for the Revenue Forecast Metrics. The rate is used if the revenue line is different from that of the opportunity.
  • Title: CRM Conversion Rate Type
    Maximum Length: 30
    The currency conversion rate type for converting the revenue amount to CRM common currency for Revenue Forecast Metrics. The rate type is used if the revenue line is different from that of the opportunity. For example, the rate type can be spot, user-defined, or corporate.
  • Title: Currency
    Maximum Length: 15
    The common CRM currency code.
  • Title: Sales Stage
    Read Only: true
    The sales stage identifier of this revenue line.
  • Title: Revenue Customer Account ID
    The unique identifier of the customer account that owns the opportunity.
  • Title: Account Registry ID
    Read Only: true
    Maximum Length: 30
    The name of the opportunity account registry ID.
  • Read Only: true
    Indicates whether the opportunity revenue can be deleted. The default value is true.
  • Title: Product
    Maximum Length: 240
    The user-provided description of the product associated with the revenue.
  • Title: Discount
    The discount percent.
  • Title: Worst Case
    Default Value: 0
    The minimum amount of revenue for the opportunity.
  • Title: Close Date
    The date when the child revenue closes. The default value is the opportunity's close date.
  • Read Only: true
    The end date for the territory owner.
  • Read Only: true
    The start date for the territory owner.
  • Title: Expected Revenue
    Default Value: 0
    The maximum amount of revenue for the opportunity.
  • Title: Expected Delivery Date
    The date when the product in the opportunity is expected to be delivered. This is used only for opportunities that include products.
  • Title: External Asset Key
    Maximum Length: 255
    The asset key from an external system.
  • Title: External Parent Asset Key
    Maximum Length: 255
    The root asset key of the parent from an external system.
  • Title: External Root Asset Key
    Maximum Length: 255
    The root asset key obtained from an external system.
  • 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.
  • 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.
  • Title: Product
    The unique identifier of the product in the inventory.
  • Title: Product
    The unique identifier of the organization in the inventory.
  • Title: Item Number
    Read Only: true
    Maximum Length: 300
    The alternate key identifier of the product that is associated with the revenue.
  • Title: Item Number Internal
    Maximum Length: 300
    The unique internal identifier of the product that is associated with the revenue.
  • Title: Update Date
    Read Only: true
    The date when the record was last updated.
  • Title: Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Links
  • Title: Margin
    Default Value: 0
    The margin amount for the opportunity.
  • Title: Monthly Recurring Revenue
    The monthly recurring revenue on the revenue line.
  • Title: Monthly Usage Revenue
    The monthly usage revenue on the revenue line.
  • Title: Forecast Territory
    Read Only: true
    Maximum Length: 60
    The name of the territory.
  • Title: Nonrecurring Revenue
    The non recurring revenue amount associated with the revenue line.
  • Title: Allocation Style
    Maximum Length: 30
    The code indicating the non-quota allocation split type. The valid values are Adhoc amount and Proportional to Revenue.
  • Title: Opportunity Creation Date
    Read Only: true
    The date and time when the opportunity was created.
  • Title: Opportunity Currency
    Read Only: true
    Maximum Length: 15
    The currency code associated with the opportunity. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Opportunity Owner
    Read Only: true
    Maximum Length: 360
    The name of the opportunity owner.
  • Title: Owner
    Read Only: true
    The unique identifier of a valid employee resource who owns and manages the opportunity.
  • Title: Primary Source
    Read Only: true
    Maximum Length: 100
    The alternate key identifier of the primary marketing source or campaign that generated this opportunity.
  • Title: Opportunity Close Date
    Read Only: true
    The date when the opportunity is expected to close.
  • Title: Revenue Opportunity ID
    The unique identified of the opportunity.
  • Title: Opportunity Last Update Date
    Read Only: true
    The date when the opportunity record was last updated.
  • Title: Opportunity Lead
    The unique Identifier of the lead associated with opportunity.
  • Title: Opportunity Number
    Maximum Length: 30
    The unique alternate identifier for the opportunity associated to child revenue.
  • Title: Organization
    The unique identifier of the organization to which the product belongs.
  • Title: Effective End Date
    The date when the owner deal expires.
  • Title: Effective Start Date
    The date when the owner deal starts.
  • Title: Lock Credit Owner
    Maximum Length: 1
    Default Value: false
    Indicates if the revenue owner assignment should be locked. If the value is Y, then the owner assignment for the child revenue should be locked. The default value is N.
  • Title: Owner Number
    Read Only: true
    Maximum Length: 30
    The party number for the owner of child revenue.
  • Title: Parent Revenue ID
    The unique identifier of the parent revenue line, used for Lineset functionality.
  • Title: Lead Registration Type
    Maximum Length: 100
    The code indicating the type of partner engagement.
  • Title: Partner Organization Party ID
    Read Only: true
    The unique identifier of the primary revenue partner party.
  • Title: Partner
    Read Only: true
    Maximum Length: 360
    The name of the primary partner associated with the child revenue.
  • Title: Sales Credit Recipient
    Read Only: true
    Maximum Length: 360
    The name of this sales credit recipient.
  • Title: Competitor
    The unique identifier of the primary competitor of this child revenue.
  • Title: Price Type
    Maximum Length: 30
    The code indicating the type of pricing associated with the revenue line. The list of valid values are Mixed, Usage, Recurring, and One Time.
  • Title: Primary Competitor Party Number
    Read Only: true
    Maximum Length: 30
    The alternate key identifier of the primary competitor of this child revenue.
  • Title: Primary Contact Party ID
    Read Only: true
    The unique identifier of the primary contact of this child revenue.
  • Title: Primary Contact
    Read Only: true
    Maximum Length: 360
    The name of the primary contact of this child revenue.
  • Title: Primary
    Maximum Length: 1
    Indicates if the revenue is the primary revenue. If the value is true, then the revenue is the primary revenue among all the child revenues. The default value is False.
  • Read Only: true
    The name of the business unit to which this revenue line belongs.
  • Title: Primary Partner Number
    Maximum Length: 30
    The alternate key identifier of the revenue's primary partner company.
  • Title: Product Group
    The unique identifier of the product group.
  • Title: Product Group Model Attributes
    Read Only: true
    Maximum Length: 4000
    The model configuration attributes associated with the product group in revenue line.
  • Title: Product Group Model Family
    Read Only: true
    Maximum Length: 1000
    The model family associated with the product group.
  • Title: Product Group Model Line
    Read Only: true
    Maximum Length: 1000
    The model line associated with the product group.
  • Title: Product Group Model
    Read Only: true
    Maximum Length: 1000
    The model name associated with the product group in revenue line.
  • Title: Product Group
    Maximum Length: 250
    The name of the product group associated with the revenue.
  • Title: Quotable
    Read Only: true
    Maximum Length: 1
    Indicates whether a product group is quotable.
  • Title: Configurable Product
    Read Only: true
    Maximum Length: 1
    Indicates whether a product allows configuration.
  • Title: Product Group Reference Number
    Maximum Length: 50
    The reference number of the product group.
  • Product Groups
    Title: Product Groups
    The product group resource is used to view the product groups associated with an opportunity. A product group is a business object that groups related products, so that you can work with them together. You can use product groups to create a multilevel hierarchy that can be used as a sales catalog, a rollup hierarchy, or a promotion catalog. For example, you might create a product group named Consumer Electronics that includes all of your consumer electronics products so that customers can browse through all the products in this group in your product catalog.
  • Title: Product Model Attributes
    Read Only: true
    Maximum Length: 4000
    The model configuration attributes associated with the product in revenue line.
  • Title: Product Model Family
    Read Only: true
    Maximum Length: 1000
    The model family associated with the product.
  • Title: Product Model Line
    Read Only: true
    Maximum Length: 1000
    The model line associated with the product.
  • Title: Product Model
    Read Only: true
    Maximum Length: 1000
    The model name associated with the product in revenue line.
  • Products
    Title: Products
    The products resource is used to view the products associated with an opportunity.
  • Title: Product Type
    The type of product on the revenue line, such as item or product group.
  • Title: Partner
    The unique identifier of the primary revenue partner organization party.
  • Title: Forecast Territory
    The unique identifier of the primary territory for this revenue item.
  • Title: Manually Assigned Territory Version ID
    The version ID of a territory that is to be manually assigned to the revenue record.
  • Title: Quantity
    The quantity of product for this opportunity.
  • Title: Record Set
    Read Only: true
    The name of the predefined opportunity search filters.
  • Title: Recurring Worst Case
    The minimum revenue amount from the recurrence.
  • Title: End By
    The date when the child revenue recurrence ends.
  • Title: Frequency
    Maximum Length: 30
    The code that indicates the frequency of recurrence for the child revenue. A list of valid values is defined in the lookup MOO_RECURRING_FREQUENCY.
  • Title: End After
    The number of times the child revenue should recur.
  • Title: Recurring Revenue Parent ID
    The unique identifier for the parent revenue of the recurring revenue lines.
  • Title: Recurrence Period or End Date Code
    Default Value: EndAfter
    The code that indicates if a date or the number of recurrences are specified to end the recurrences.
  • Title: Recurring Quantity
    The quantity of the child revenue recurrence.
  • Title: Recurring Revenue
    The recurring revenue amount on the revenue line.
  • Title: Scheduled Revenue Amount
    The amount of revenue from the child revenue recurrence.
  • Recurring Revenues
    Title: Recurring Revenues
    The recurring revenues resource is used to view, create, update, and delete a recurring revenue. The revenues that span over a period of time sourced from the same product on an opportunity.
  • Title: Start Date
    The date when the recurrence starts.
  • Title: Recurrence Type Code
    Maximum Length: 30
    The code indicating if the line is a standard revenue line or a recurring revenue line. A list of valid values is defined in the lookup MOO_REVN_RECUR_TYPE.
  • Title: Recurring Estimated Price
    The price of each child revenue recurrence.
  • Title: Recurring Best Case
    The maximum revenue amount from the recurrence.
  • Title: Owner
    The unique identifier of the revenue owner.
  • Opportunity Revenue Territories
    Title: Opportunity Revenue Territories
    The opportunity revenue territories resource is used to view, create, update, and delete the revenue territories assigned to an opportunity revenue line. The territories provide the rules for automatically assigning salespeople and other resources to customers, partners, leads, and opportunity line items.
  • Title: Revenue Type Category
    Maximum Length: 30
    The revenue category type on the opportunity revenue line.
  • Title: Amount
    Default Value: 0
    The amount of revenue that is earned from this opportunity.
  • Title: Line Currency
    Maximum Length: 15
    The currency code used to calculate the revenue for this opportunity. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.
  • Title: Revenue Category
    Maximum Length: 30
    The code indicating the revenue category used in Revenue Line Set functionality. A list of valid values is defined in the lookup MOO_REVN_CATEGORY.
  • Title: Creation Date
    The date when the revenue item was created.
  • Title: Revenue ID
    The unique identifier of the revenue for the opportunity.
  • Title: Update Date
    The date and time when the revenue record was last updated.
  • Title: Revenue Line Type Code
    Maximum Length: 30
    The code indicating the type of revenue line, such as Opportunity Summary Revenue, Standard Revenue, and so on. A list of valid values is defined in the lookup MOO_REVN_LINE_TYPE.
  • Title: Revenue Number
    Maximum Length: 30
    The user-editable unique identifier for the child revenue. The default value is the revenue identifier.
  • Title: Line Set
    The revenue sequence number.
  • Title: Account
    The unique identifier of the opportunity sales account.
  • Title: Sales Channel
    Maximum Length: 50
    The code indicating the sales channel for the child revenue. A list of valid values is defined in the lookup ZPM_SALES_CHANNEL.
  • Title: Sales Credit Type
    Maximum Length: 30
    Default Value: QUOTA
    The code indicating the type of the sales credit, such as quota or non-quota. A list of valid values is defined in the lookup MOO_SALES_CREDIT_TYPE.
  • Title: Sales Method
    Read Only: true
    The unique identifier of the sales method for this revenue line.
  • Title: Schedule Action
    The transient attribute. Web services need to pass a value to indicate the action to be taken on recurring schedule such as create, delete, extend, and replace.
  • Title: Nonrecurring Amount for Schedule
    The non recurring amount based on the set schedule.
  • Title: Recurring Amount for Schedule
    The recurring amount based on the set schedule.
  • Title: Usage Amount for Schedule
    The usage amount based on the set schedule.
  • Title: Split Parent Revenue ID
    The unique identifier of the split parent revenue.
  • Title: Sales Credit
    The percentage of split revenue.
  • Title: Split Type Code
    Maximum Length: 30
    The code indicating the Split type of the Revenue, such as ParentSplit or ChildSplit. A list of valid values is defined in the lookup MOO_REVN_SPLIT_TYPE.
  • Title: Opportunity Status
    Read Only: true
    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.
  • Title: Status
    Maximum Length: 30
    The unique code indicating the status of the child revenue. A list of valid values is defined in the lookup OPTY_STATUS.
  • Title: Subscription Id
    The unique identifier of the subscription.
  • Title: Subscription Line Id
    The unique identifier of the subscription line within a subscription.
  • Title: Opportunity Revenue
    Read Only: true
    Default Value: 0
    The revenue amount associated with the summary revenue line.
  • Title: Opportunity Summary Revenue in Corporate Currency
    Read Only: true
    The calculated opportunity amount in corporate currency.
  • Title: Opportunity Worst Case
    Read Only: true
    Default Value: 0
    The minimum amount of the summary revenue line for the opportunity.
  • Title: Opportunity Best Case
    Read Only: true
    Default Value: 0
    The maximum amount of the summary revenue line for the opportunity.
  • Title: Account Party ID
    The unique identifier of the sales account that owns the opportunity.
  • Read Only: true
    The unique identifier of the organization the territory owner of this revenue line belongs to.
  • Title: Forecast Territory Owner
    Read Only: true
    Maximum Length: 360
    The party name for the territory owner of this revenue line.
  • Title: Resource ID
    Read Only: true
    The unique identifier for the territory owner of this revenue line.
  • Title: Close Period
    Read Only: true
    The names of the filter on which opportunities can be filtered based on effective date range.
  • Title: Revenue Type
    Maximum Length: 30
    The code indicating the type of revenue earned from this opportunity. A list of valid values is defined in the lookup MOO_SETID_REVENUE_TYPE.
  • Title: Estimated Price
    The estimated unit price for the product.
  • Title: UOM
    Maximum Length: 3
    The unit of measure code for the product.
  • Read Only: true
    Indicates whether the revenue line can be updated. If the value is Y, then the note can be updated. The default value is Y.
  • Title: Best Case
    Default Value: 0
    The maximum amount of revenue for the opportunity.
  • Title: Usage Revenue
    The usage revenue amount on the revenue line.
  • Title: Win Probability
    The estimated probability of winning the opportunity.
Nested Schema : Child Split Revenues
Type: array
Title: Child Split Revenues
The child split revenue resource is used to view, create, update, and delete a split revenue. The revenue or nonrevenue credit is allocated to the resource which has contributed to the selling effort for an opportunity revenue line.
Show Source
Nested Schema : Product Groups
Type: array
Title: Product Groups
The product group resource is used to view the product groups associated with an opportunity. A product group is a business object that groups related products, so that you can work with them together. You can use product groups to create a multilevel hierarchy that can be used as a sales catalog, a rollup hierarchy, or a promotion catalog. For example, you might create a product group named Consumer Electronics that includes all of your consumer electronics products so that customers can browse through all the products in this group in your product catalog.
Show Source
Nested Schema : Products
Type: array
Title: Products
The products resource is used to view the products associated with an opportunity.
Show Source
Nested Schema : Recurring Revenues
Type: array
Title: Recurring Revenues
The recurring revenues resource is used to view, create, update, and delete a recurring revenue. The revenues that span over a period of time sourced from the same product on an opportunity.
Show Source
Nested Schema : Opportunity Revenue Territories
Type: array
Title: Opportunity Revenue Territories
The opportunity revenue territories resource is used to view, create, update, and delete the revenue territories assigned to an opportunity revenue line. The territories provide the rules for automatically assigning salespeople and other resources to customers, partners, leads, and opportunity line items.
Show Source
Nested Schema : opportunities-ChildRevenue-ChildSplitRevenue-item-response
Type: object
Show Source
Nested Schema : opportunities-ChildRevenue-productGroups-item-response
Type: object
Show Source
Nested Schema : opportunities-ChildRevenue-products-item-response
Type: object
Show Source
Nested Schema : opportunities-ChildRevenue-RecurringRevenue-item-response
Type: object
Show Source
Nested Schema : opportunities-ChildRevenue-RevenueTerritory-item-response
Type: object
Show Source
Links
BusinessUnitPVO1
The CRM business units resource is used to view the business unit details.
ChildSplitRevenue
Parameters:
  • ChildRevenueUniqID: $request.path.ChildRevenueUniqID
  • OptyNumber: $request.path.OptyNumber
The child split revenue resource is used to view, create, update, and delete a split revenue. The revenue or nonrevenue credit is allocated to the resource which has contributed to the selling effort for an opportunity revenue line.
ClosePeriodLookupPVO
Parameters:
  • finder: LookupTypeIsEnabledFinder%3BBindLookupType%3DMOO_OPTY_SRCH_CLS_PERIOD
The lookups resource is used to view standard lookup codes.
CloseReasonLOV
Parameters:
  • finder: CommonSetIdWithBUIdFinder%3BpBusinessUnitId%3D{BUOrgId}%2CpLookupType%3DMOO_SETID_WIN_LOSS_REASON%2CpReferenceGroupName%3DMOO_SETID_WIN_LOSS_REASON%2CpEnabledFlag%3DY
The FND common set Id lookups resource is used to view, create, update, and delete lookups for the foundation common set Id.
ForecastCategoryVA
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MOO_FORECAST_CATEGORY_TYPE
The lookups resource is used to view standard lookup codes.
OptyRevenueCategoryLOV
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOO_REVN_CATEGORY%2CBindLookupCode%3D{RevnCategoryCode}
The lookups resource is used to view standard lookup codes.
OptyStatusZbsLookupValuesVO
Parameters:
  • finder: StatusByBUIdFinder%3BBindEnabledFlag%3DY%2CBindLookupType%3DOPTY_STATUS%2CBindBUId%3D{BUOrgId}
The configurable setup data defined specifically for sales usage.
OwnerLockAsgnFlagLookupPVO
Parameters:
  • finder: LookupTypeFinder%3BBindLookupType%3DYES_NO
The lookups resource is used to view standard lookup codes.
PriceTypeLookupPVO
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{PriceTypeCode}%2CBindLookupType%3DORA_ZCA_SO_LINE_PRICE_TYPE
The lookups resource is used to view standard lookup codes.
ProductGroupExtnVA
Parameters:
  • finder: ProductGroupList%3BBind_UsageCode%3DBASE%2CBind_UsageModeCode%3DMOO
Name for Product Group detail base public view object.
ProductTypeLookupVOVA
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MOO_PROD_TYPE
The lookups resource is used to view standard lookup codes.
RatedCurrenciesVO
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.
RecurFrequencyLOV
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOO_RECURRING_FREQUENCY
The lookups resource is used to view standard lookup codes.
RecurTypeLOV
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOO_REVN_RECUR_TYPE
The lookups resource is used to view standard lookup codes.
RecurringRevenue
Parameters:
  • ChildRevenueUniqID: $request.path.ChildRevenueUniqID
  • OptyNumber: $request.path.OptyNumber
The recurring revenues resource is used to view, create, update, and delete a recurring revenue. The revenues that span over a period of time sourced from the same product on an opportunity.
RevenueSalesChannelLookupVO
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.
RevenueTerritory
Parameters:
  • ChildRevenueUniqID: $request.path.ChildRevenueUniqID
  • OptyNumber: $request.path.OptyNumber
The opportunity revenue territories resource is used to view, create, update, and delete the revenue territories assigned to an opportunity revenue line. The territories provide the rules for automatically assigning salespeople and other resources to customers, partners, leads, and opportunity line items.
RevenueTypeCategoryPVO
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{RevenueTypeCategory}%2CBindLookupType%3DORA_MOO_REVN_CATEGORY_TYPE
The lookups resource is used to view standard lookup codes.
RevenueTypeLOV
Parameters:
  • finder: CommonSetIdWithBUIdFinder%3BpBusinessUnitId%3D{BUOrgId}%2CpEnabledFlag%3DY%2CpLookupType%3DMOO_SETID_REVENUE_TYPE%2CpReferenceGroupName%3DMOO_SETID_REVENUE_TYPE
The FND common set Id lookups resource is used to view, create, update, and delete lookups for the foundation common set Id.
RevnAmountCurcyCodeVA
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.
RevnFrcstOverrideCodeLOV
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZSF_FCST_INCLUDE_IN_FCST%2CBindLookupCode%3D{ForecastOverrideCode}
The lookups resource is used to view standard lookup codes.
RevnStatusZbsValuesLOV
Parameters:
  • finder: StatusByBUIdFinder%3BBindEnabledFlag%3DY%2CBindLookupType%3DOPTY_STATUS%2CBindBUId%3D{BUOrgId}
The configurable setup data defined specifically for sales usage.
SalesCatalogExtnProductsLovVA
Parameters:
  • finder: ProductList%3BBind_UsageCode%3DBASE%2CBind_UsageModeCode%3DMOO
The product resource is used to view, create, or modify a product. A product is an item that an organization or company intends to sell.
SalesCreditTypeLOV
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOO_SALES_CREDIT_TYPE
The lookups resource is used to view standard lookup codes.
SalesMethodVA
Parameters:
  • finder: SalesMethodByBUFinder%3BBindBUId%3D{BUOrgId}
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.
SalesStageVA
Parameters:
  • finder: SalesStageBySalesMethodFinder%3BBindSalesMethodId%3D{SalesMethodId}
The sales stage for a given sales method describes the progress of an opportunity in the sales cycle.
ScheduleActionLOV
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MOO_REV_SCHEDULE_ACTION
The lookups resource is used to view standard lookup codes.
SearchFilteringLookupPVO
Parameters:
  • finder: LookupTypeIsEnabledFinder%3BBindLookupType%3DMOO_REVN_SRCH_RECORD_SET
The lookups resource is used to view standard lookup codes.
SplitAllocTypeLOV
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOO_REVN_SPLIT_ALLOC_TYPE
The lookups resource is used to view standard lookup codes.
SplitTypeLOV
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOO_REVN_SPLIT_TYPE
The lookups resource is used to view standard lookup codes.
TerritoryListVA
An entity that holds the various versions of a sales territory. Each version record contains most of the key attributes of a territory. Most of the sales territory object components are child entities to a sales territory version, for example, territory rules, territory rule boundaries, territory rule boundary values, and territory resources.
YesNoLookupPVO
Parameters:
  • finder: LookupTypeFinder%3BBindLookupType%3DYES_NO
The lookups resource is used to view standard lookup codes.
productGroups
Parameters:
  • ChildRevenueUniqID: $request.path.ChildRevenueUniqID
  • OptyNumber: $request.path.OptyNumber
The product group resource is used to view the product groups associated with an opportunity. A product group is a business object that groups related products, so that you can work with them together. You can use product groups to create a multilevel hierarchy that can be used as a sales catalog, a rollup hierarchy, or a promotion catalog. For example, you might create a product group named Consumer Electronics that includes all of your consumer electronics products so that customers can browse through all the products in this group in your product catalog.
products
Parameters:
  • ChildRevenueUniqID: $request.path.ChildRevenueUniqID
  • OptyNumber: $request.path.OptyNumber
The products resource is used to view the products associated with an opportunity.
Back to Top

Examples

The following example shows how to get an opportunity revenue by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_332708/child/childrevenuve/300100111705696

Example of Request Body

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

{
           "ProdGroupId": 999997826071065
           "UnitPrice": 400,
           "Quantity": 3
 
}

Example of Response Body

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

{
RevnId: 300100111705696
BUOrgId: 204
CommitFlag: false
CostAmount: 0
ResourcePartyId: 100010025532672
UnitPrice: 400
Quantity: 3
DownsideAmount: 0
ExpectAmount: 0
MarginAmount: 1000
OptyId: 300100111705686
...
}
Back to Top