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

Get all opportunity revenues

get

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

Request

Path Parameters
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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds revenue line by the primary key revenue ID.
      Finder Variables:
      • RevnId; integer; The unique identifier of the child revenue item.
    • RevnNumberRowFinder: Finds a revenue line based on its unique public identifier.
      Finder Variables:
      • RevnNumber; string; The unique public identifier of a revenue line.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ActualCloseDate; string; The date when the revenue line was closed.
    • AssetId; integer; Identifier of the asset associated to the Revenue Line.
    • BUOrgId; integer; The unique identifier of the Business Unit that owns the opportunity.
    • CalculatedLineRevnAmtInCorpCur; number; The calculated revenue amount in corporate currency.
    • CloseReasonCode; string; 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.
    • CommitFlag; boolean; 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.
    • CompetitorPartyName; string; The party name of the primary competitor of this child revenue.
    • ConflictId; integer; 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.
    • CurrStgId; integer; The sales stage identifier of this revenue line.
    • CustomerRegistryId; string; The name of the opportunity account registry ID.
    • Description; string; The user-provided description of the product associated with the revenue.
    • DownsideAmount; number; The minimum amount of revenue for the opportunity.
    • EffectiveDate; string; The date when the child revenue closes. The default value is the opportunity's close date.
    • ForecastOverrideCode; string; The code that indicates if the revenue forecast should be overridden. The valid values are ALWAYS, NEVER, and CRITERIA.
    • LastUpdateDate; string; The date when the record was last updated.
    • Name1; string; The name of the territory.
    • OpportunityCreationDate; string; The date and time when the opportunity was created.
    • OpportunityCurrencyCode; string; 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.
    • OpportunityOwnerPartyName; string; The name of the opportunity owner.
    • OpportunityOwnerResourcePartyId; integer; The unique identifier of a valid employee resource who owns and manages the opportunity.
    • OptyEffectiveDate; string; The date when the opportunity is expected to close.
    • OptyId; integer; The unique identified of the opportunity.
    • OptyLastUpdateDate; string; The date when the opportunity record was last updated.
    • OptyNumber; string; The unique alternate identifier for the opportunity associated to child revenue.
    • OrganizationId; integer; The unique identifier of the organization to which the product belongs.
    • OwnerPartyNumber; string; The party number for the owner of child revenue.
    • PartOrgPartyName; string; The name of the primary partner associated with the child revenue.
    • PartyName2; string; The name of this sales credit recipient.
    • PrimaryCompetitorPartyNumber; string; The alternate key identifier of the primary competitor of this child revenue.
    • PrimaryContactPartyId; integer; The unique identifier of the primary contact of this child revenue.
    • PrimaryContactPartyName; string; The name of the primary contact of this child revenue.
    • PrimaryFlag; boolean; 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.
    • PrimaryOrganizationName; string; The name of the business unit to which this revenue line belongs.
    • PrimaryPartnerCompanyNumber; string; The alternate key identifier of the revenue's primary partner company.
    • ProdGroupName; string; The name of the product group associated with the revenue.
    • ProductGroupReferenceNumber; string; The reference number of the product group.
    • ProductType; string; The type of product on the revenue line, such as item or product group.
    • Quantity; number; The quantity of product for this opportunity.
    • RecordSet; string; The name of the predefined opportunity search filters.
    • RecurTypeCode; string; 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.
    • ResourcePartyId; integer; The unique identifier of the revenue owner.
    • RevnAmount; number; The amount of revenue that is earned from this opportunity.
    • RevnAmountCurcyCode; string; 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.
    • RevnId; integer; The unique identifier of the revenue for the opportunity.
    • RevnLastUpdateDate; string; The date and time when the revenue record was last updated.
    • RevnNumber; string; The user-editable unique identifier for the child revenue. The default value is the revenue identifier.
    • SalesChannelCd; string; The code indicating the sales channel for the child revenue. A list of valid values is defined in the lookup ZPM_SALES_CHANNEL.
    • SalesCreditTypeCode; string; 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.
    • SplitPercent; number; The percentage of split revenue.
    • SplitTypeCode; string; 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.
    • StatusCd; string; The status of the opportunity. A list of valid values is defined in the lookup MOO_OPTY_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
    • StatusCode; string; The unique code indicating the status of the child revenue. A list of valid values is defined in the lookup OPTY_STATUS.
    • SumRevnDownsideAmt; number; The minimum amount of the summary revenue line for the opportunity.
    • SumRevnUpsideAmt; number; The maximum amount of the summary revenue line for the opportunity.
    • SummaryRevnAmt; number; The revenue amount associated with the summary revenue line.
    • SummaryRevnAmtInCorpCur; number; The calculated opportunity amount in corporate currency.
    • TerrOwnerPartyName; string; The party name for the territory owner of this revenue line.
    • TerrOwnerResourceId; integer; The unique identifier for the territory owner of this revenue line.
    • TimeFilter; string; The names of the filter on which opportunities can be filtered based on effective date range.
    • UnitPrice; number; The estimated unit price for the product.
    • UpsideAmount; number; The maximum amount of revenue for the opportunity.
    • WinProb; integer; The estimated probability of winning the opportunity.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested 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: Asset
    Identifier of the asset associated to the Revenue Line.
  • 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.
  • Smart Actions
    Title: Smart Actions
    The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • 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 : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
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
Nested Schema : opportunities-ChildRevenue-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Indicates if action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function for smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether the smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    Indicates whether the action is seeded or custom.
  • Title: Attributes to Update
    Maximum Length: 512
    The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
  • Title: User Action ID
    The unique system assigned identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique system assigned smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type: array
Title: Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : opportunities-ChildRevenue-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique system assigned identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : opportunities-ChildRevenue-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Links
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : opportunities-ChildRevenue-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Back to Top

Examples

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

cURL Command

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

Example of Response Body

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

{
   "items" : [12]
   -0: {
          "RevnId" : 300100111705696,
    "TargetPartyId" : null,
    "CustomerAccountId" : null,
    "BUOrgId" : 204,
    "Comments" : null,
    "CommitFlag" : false,
    "CostAmount" : 0,
    "ResourcePartyId" : 100010025532672,
    "DownsideAmount" : 0,
    "ExpectAmount" : 0,
    "MarginAmount" : 1000,
    "OptyId" : 300100111705686,
    "UnitPrice" : null,
    "InventoryItemId" : null,
    "InventoryOrgId" : null,
    "Quantity" : null,
    "RevnAmount" : 0,
    "RevnAmountCurcyCode" : "USD",
    "TypeCode" : null,
    "UpsideAmount" : 0,
    "WinProb" : 0,
    "UOMCode" : null,
...

}


    -1:
{
...
}
 ...
}
Back to Top