Get all opportunity revenues
get
/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue
Request
Path Parameters
-
OptyNumber(required): string
The unique alternate identifier for the opportunity.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- 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.
- PrimaryKey: Finds revenue line by the primary key revenue ID.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ActualCloseDate; string; The date when the revenue line was closed.
- 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.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : opportunities-ChildRevenue
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-ChildRevenue-item-response
Type:
Show Source
object
-
ActualCloseDate: string
(date)
Title:
Actual Close Date
The date when the revenue line was closed. -
AmountAggregatedForScheduleFlag: boolean
Title:
Divide Amount by Transactions
Maximum Length:1
The amounts are divided by the number of transactions based on the set schedule. -
BUOrgId: integer
(int64)
Title:
Business Unit
The unique identifier of the Business Unit that owns the opportunity. -
CalculatedLineRevnAmtInCorpCur: number
Title:
Revenue in Corporate Currency
Read Only:true
The calculated revenue amount in corporate currency. -
ChildSplitRevenue: array
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. -
CloseReasonCode: string
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. -
Comments: string
Title:
Line Comments
Maximum Length:250
The user-provided comments for the revenue line. -
CommitFlag: boolean
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. -
CompetitorPartyName: string
Title:
Competitor Party Name
Read Only:true
Maximum Length:360
The party name of the primary competitor of this child revenue. -
ConflictId: integer
(int64)
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. -
ContractEndDate: string
(date-time)
Title:
Contract End Date
The end date of the contract for the quote. -
ContractStartDate: string
(date-time)
Title:
Contract Start Date
The start date of the contract for the quote. -
ConversionRate: number
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. -
ConversionRateType: string
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. -
CostAmount: number
Title:
Cost
Default Value:0
The cost amount for the opportunity. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the child revenue record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CreditRcptPartOrgPartyId: integer
(int64)
Title:
Credit Recipient Partner
The unique identifier of the credit recipient partner organization party. -
CrmConversionRate: number
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. -
CrmConversionRateType: string
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. -
CrmCurcyCode: string
Title:
Currency
Maximum Length:15
The common CRM currency code. -
CurrStgId: integer
(int64)
Title:
Sales Stage
Read Only:true
The sales stage identifier of this revenue line. -
CustomerAccountId: integer
(int64)
Title:
Revenue Customer Account ID
The unique identifier of the customer account that owns the opportunity. -
CustomerRegistryId: string
Title:
Account Registry ID
Read Only:true
Maximum Length:30
The name of the opportunity account registry ID. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the opportunity revenue can be deleted. The default value is true. -
Description: string
Title:
Product
Maximum Length:240
The user-provided description of the product associated with the revenue. -
Discount: number
Title:
Discount
The discount percent. -
DownsideAmount: number
Title:
Worst Case
Default Value:0
The minimum amount of revenue for the opportunity. -
EffectiveDate: string
(date)
Title:
Close Date
The date when the child revenue closes. The default value is the opportunity's close date. -
EffectiveEndDate: string
(date)
Read Only:
true
The end date for the territory owner. -
EffectiveStartDate: string
(date)
Read Only:
true
The start date for the territory owner. -
ExpectAmount: number
Title:
Expected Revenue
Default Value:0
The maximum amount of revenue for the opportunity. -
ExpectDlvryDate: string
(date)
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. -
ExternalAssetKey: string
Title:
External Asset Key
Maximum Length:255
The asset key from an external system. -
ExternalParentAssetKey: string
Title:
External Parent Asset Key
Maximum Length:255
The root asset key of the parent from an external system. -
ExternalRootAssetKey: string
Title:
External Root Asset Key
Maximum Length:255
The root asset key obtained from an external system. -
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. -
InventoryItemId: integer
(int64)
Title:
Product
The unique identifier of the product in the inventory. -
InventoryOrgId: integer
(int64)
Title:
Product
The unique identifier of the organization in the inventory. -
ItemNumber: string
Title:
Item Number
Read Only:true
Maximum Length:300
The alternate key identifier of the product that is associated with the revenue. -
ItemNumberInternal: string
Title:
Item Number Internal
Maximum Length:300
The unique internal identifier of the product that is associated with the revenue. -
LastUpdateDate: string
(date-time)
Title:
Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MarginAmount: number
Title:
Margin
Default Value:0
The margin amount for the opportunity. -
MonthlyRecurringRevenue: number
Title:
Monthly Recurring Revenue
The monthly recurring revenue on the revenue line. -
MonthlyUsageRevenue: number
Title:
Monthly Usage Revenue
The monthly usage revenue on the revenue line. -
Name1: string
Title:
Forecast Territory
Read Only:true
Maximum Length:60
The name of the territory. -
NonRecurringRevenue: number
Title:
Nonrecurring Revenue
The non recurring revenue amount associated with the revenue line. -
NqSplitAllocTypeCode: string
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. -
OpportunityCreationDate: string
(date-time)
Title:
Opportunity Creation Date
Read Only:true
The date and time when the opportunity was created. -
OpportunityCurrencyCode: string
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. -
OpportunityOwnerPartyName: string
Title:
Opportunity Owner
Read Only:true
Maximum Length:360
The name of the opportunity owner. -
OpportunityOwnerResourcePartyId: integer
(int64)
Title:
Owner
Read Only:true
The unique identifier of a valid employee resource who owns and manages the opportunity. -
OpportunityPrSrcNumber: string
Title:
Primary Source
Read Only:true
Maximum Length:100
The alternate key identifier of the primary marketing source or campaign that generated this opportunity. -
OptyEffectiveDate: string
(date)
Title:
Opportunity Close Date
Read Only:true
The date when the opportunity is expected to close. -
OptyId: integer
(int64)
Title:
Revenue Opportunity ID
The unique identified of the opportunity. -
OptyLastUpdateDate: string
(date-time)
Title:
Opportunity Last Update Date
Read Only:true
The date when the opportunity record was last updated. -
OptyLeadId: integer
(int64)
Title:
Opportunity Lead
The unique Identifier of the lead associated with opportunity. -
OptyNumber: string
Title:
Opportunity Number
Maximum Length:30
The unique alternate identifier for the opportunity associated to child revenue. -
OrganizationId: integer
(int64)
Title:
Organization
The unique identifier of the organization to which the product belongs. -
OwnerDealExpirationDate: string
(date)
Title:
Effective End Date
The date when the owner deal expires. -
OwnerDealProtectedDate: string
(date)
Title:
Effective Start Date
The date when the owner deal starts. -
OwnerLockAsgnFlag: boolean
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. -
OwnerPartyNumber: string
Title:
Owner Number
Read Only:true
Maximum Length:30
The party number for the owner of child revenue. -
ParentRevnId: integer
(int64)
Title:
Parent Revenue ID
The unique identifier of the parent revenue line, used for Lineset functionality. -
PartEngagementTypeCd: string
Title:
Lead Registration Type
Maximum Length:100
The code indicating the type of partner engagement. -
PartOrgPartyId: integer
(int64)
Title:
Partner Organization Party ID
Read Only:true
The unique identifier of the primary revenue partner party. -
PartOrgPartyName: string
Title:
Partner
Read Only:true
Maximum Length:360
The name of the primary partner associated with the child revenue. -
PartyName2: string
Title:
Sales Credit Recipient
Read Only:true
Maximum Length:360
The name of this sales credit recipient. -
PrCmptPartyId: integer
(int64)
Title:
Competitor
The unique identifier of the primary competitor of this child revenue. -
PriceTypeCode: string
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. -
PrimaryCompetitorPartyNumber: string
Title:
Primary Competitor Party Number
Read Only:true
Maximum Length:30
The alternate key identifier of the primary competitor of this child revenue. -
PrimaryContactPartyId: integer
(int64)
Title:
Primary Contact Party ID
Read Only:true
The unique identifier of the primary contact of this child revenue. -
PrimaryContactPartyName: string
Title:
Primary Contact
Read Only:true
Maximum Length:360
The name of the primary contact of this child revenue. -
PrimaryFlag: boolean
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. -
PrimaryOrganizationName: string
Read Only:
true
The name of the business unit to which this revenue line belongs. -
PrimaryPartnerCompanyNumber: string
Title:
Primary Partner Number
Maximum Length:30
The alternate key identifier of the revenue's primary partner company. -
ProdGroupId: integer
(int64)
Title:
Product Group
The unique identifier of the product group. -
ProdGroupModelConfigAttributes: string
Title:
Product Group Model Attributes
Read Only:true
Maximum Length:4000
The model configuration attributes associated with the product group in revenue line. -
ProdGroupModelFamily: string
Title:
Product Group Model Family
Read Only:true
Maximum Length:1000
The model family associated with the product group. -
ProdGroupModelLine: string
Title:
Product Group Model Line
Read Only:true
Maximum Length:1000
The model line associated with the product group. -
ProdGroupModelName: string
Title:
Product Group Model
Read Only:true
Maximum Length:1000
The model name associated with the product group in revenue line. -
ProdGroupName: string
Title:
Product Group
Maximum Length:250
The name of the product group associated with the revenue. -
ProdGroupQuotableFlag: boolean
Title:
Quotable
Read Only:true
Maximum Length:1
Indicates whether a product group is quotable. -
ProductConfigurableFlag: boolean
Title:
Configurable Product
Read Only:true
Maximum Length:1
Indicates whether a product allows configuration. -
ProductGroupReferenceNumber: string
Title:
Product Group Reference Number
Maximum Length:50
The reference number of the product group. -
productGroups: array
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. -
ProductModelConfigAttributes: string
Title:
Product Model Attributes
Read Only:true
Maximum Length:4000
The model configuration attributes associated with the product in revenue line. -
ProductModelFamily: string
Title:
Product Model Family
Read Only:true
Maximum Length:1000
The model family associated with the product. -
ProductModelLine: string
Title:
Product Model Line
Read Only:true
Maximum Length:1000
The model line associated with the product. -
ProductModelName: string
Title:
Product Model
Read Only:true
Maximum Length:1000
The model name associated with the product in revenue line. -
products: array
Products
Title:
Products
The products resource is used to view the products associated with an opportunity. -
ProductType: string
Title:
Product Type
The type of product on the revenue line, such as item or product group. -
PrPartOrgPartyId: integer
(int64)
Title:
Partner
The unique identifier of the primary revenue partner organization party. -
PrTerritoryVersionId: integer
(int64)
Title:
Forecast Territory
The unique identifier of the primary territory for this revenue item. -
PrTerritoryVersionIdForManual: string
Title:
Manually Assigned Territory Version ID
The version ID of a territory that is to be manually assigned to the revenue record. -
Quantity: number
Title:
Quantity
The quantity of product for this opportunity. -
RecordSet: string
Title:
Record Set
Read Only:true
The name of the predefined opportunity search filters. -
RecurDownsideAmount: number
Title:
Recurring Worst Case
The minimum revenue amount from the recurrence. -
RecurEndDate: string
(date)
Title:
End By
The date when the child revenue recurrence ends. -
RecurFrequencyCode: string
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. -
RecurNumberPeriods: integer
(int64)
Title:
End After
The number of times the child revenue should recur. -
RecurParentRevnId: integer
(int64)
Title:
Recurring Revenue Parent ID
The unique identifier for the parent revenue of the recurring revenue lines. -
RecurPeriodOrEndDateCode: string
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. -
RecurQuantity: number
Title:
Recurring Quantity
The quantity of the child revenue recurrence. -
RecurRevenue: number
Title:
Recurring Revenue
The recurring revenue amount on the revenue line. -
RecurRevnAmount: number
Title:
Scheduled Revenue Amount
The amount of revenue from the child revenue recurrence. -
RecurringRevenue: array
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. -
RecurStartDate: string
(date)
Title:
Start Date
The date when the recurrence starts. -
RecurTypeCode: string
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. -
RecurUnitPrice: number
Title:
Recurring Estimated Price
The price of each child revenue recurrence. -
RecurUpsideAmount: number
Title:
Recurring Best Case
The maximum revenue amount from the recurrence. -
ResourcePartyId: integer
(int64)
Title:
Owner
The unique identifier of the revenue owner. -
RevenueTerritory: array
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. -
RevenueTypeCategory: string
Title:
Revenue Type Category
Maximum Length:30
The revenue category type on the opportunity revenue line. -
RevnAmount: number
Title:
Amount
Default Value:0
The amount of revenue that is earned from this opportunity. -
RevnAmountCurcyCode: string
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. -
RevnCategoryCode: string
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. -
RevnCreationDate: string
(date-time)
Title:
Creation Date
The date when the revenue item was created. -
RevnId: integer
(int64)
Title:
Revenue ID
The unique identifier of the revenue for the opportunity. -
RevnLastUpdateDate: string
(date-time)
Title:
Update Date
The date and time when the revenue record was last updated. -
RevnLineTypeCode: string
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. -
RevnNumber: string
Title:
Revenue Number
Maximum Length:30
The user-editable unique identifier for the child revenue. The default value is the revenue identifier. -
RevnSequenceNumber: integer
(int32)
Title:
Line Set
The revenue sequence number. -
SalesAccountId: integer
(int64)
Title:
Account
The unique identifier of the opportunity sales account. -
SalesChannelCd: string
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. -
SalesCreditTypeCode: string
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. -
SalesMethodId: integer
(int64)
Title:
Sales Method
Read Only:true
The unique identifier of the sales method for this revenue line. -
ScheduleAction: string
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. -
ScheduleNonRecurringAmount: number
Title:
Nonrecurring Amount for Schedule
The non recurring amount based on the set schedule. -
ScheduleRecurringAmount: number
Title:
Recurring Amount for Schedule
The recurring amount based on the set schedule. -
ScheduleUsageAmount: number
Title:
Usage Amount for Schedule
The usage amount based on the set schedule. -
SplitParentRevnId: integer
(int64)
Title:
Split Parent Revenue ID
The unique identifier of the split parent revenue. -
SplitPercent: number
Title:
Sales Credit
The percentage of split revenue. -
SplitTypeCode: string
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. -
StatusCd: string
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. -
StatusCode: string
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. -
SubscriptionId: integer
(int64)
Title:
Subscription Id
The unique identifier of the subscription. -
SubscriptionLineId: integer
(int64)
Title:
Subscription Line Id
The unique identifier of the subscription line within a subscription. -
SummaryRevnAmt: number
Title:
Opportunity Revenue
Read Only:true
Default Value:0
The revenue amount associated with the summary revenue line. -
SummaryRevnAmtInCorpCur: number
Title:
Opportunity Summary Revenue in Corporate Currency
Read Only:true
The calculated opportunity amount in corporate currency. -
SumRevnDownsideAmt: number
Title:
Opportunity Worst Case
Read Only:true
Default Value:0
The minimum amount of the summary revenue line for the opportunity. -
SumRevnUpsideAmt: number
Title:
Opportunity Best Case
Read Only:true
Default Value:0
The maximum amount of the summary revenue line for the opportunity. -
TargetPartyId: integer
(int64)
Title:
Account Party ID
The unique identifier of the sales account that owns the opportunity. -
TerrOwnerOrganizationId: integer
Read Only:
true
The unique identifier of the organization the territory owner of this revenue line belongs to. -
TerrOwnerPartyName: string
Title:
Forecast Territory Owner
Read Only:true
Maximum Length:360
The party name for the territory owner of this revenue line. -
TerrOwnerResourceId: integer
(int64)
Title:
Resource ID
Read Only:true
The unique identifier for the territory owner of this revenue line. -
TimeFilter: string
Title:
Close Period
Read Only:true
The names of the filter on which opportunities can be filtered based on effective date range. -
TypeCode: string
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. -
UnitPrice: number
Title:
Estimated Price
The estimated unit price for the product. -
UOMCode: string
Title:
UOM
Maximum Length:3
The unit of measure code for the product. -
UpdateFlag: boolean
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. -
UpsideAmount: number
Title:
Best Case
Default Value:0
The maximum amount of revenue for the opportunity. -
UsageRevenue: number
Title:
Usage Revenue
The usage revenue amount on the revenue line. -
WinProb: integer
(int32)
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
ExtnPartyName: string
Title:
Owner
The name of the revenue owner. -
ExtnPartyNameLOVSwitcher: string
The switcher for ist of values for the revenue owner, used in UI scenarios.
-
ForecastTerritoryName: string
Title:
Territory Name
Maximum Length:60
The name of the forecast territory. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Organization
Read Only:true
The name of the resource organization associated the with revenue. -
OwnerLockAsgnFlag: boolean
Title:
Lock Credit Owner
Maximum Length:1
Default Value:false
Indicates if the credit recipients of the revenue line should be locked from re-assignment by the system. -
OwnerPartyNumber: string
Title:
Owner Number
Read Only:true
Maximum Length:30
The party number for the owner of child split revenue. -
PrTerritoryUpdatedByPartyName: string
Title:
Updated By
Read Only:true
Maximum Length:360
The name of the user who last updated the forecast territory. -
PrTerritoryVersionId: integer
(int64)
Title:
Forecast Territory
Forecast territory version identifier. -
PrTerritoryVersionIdForManual: string
Title:
Manually Assigned Territory Version ID
Indicates the version ID of a territory that is to be manually assigned to the revenue record. -
ResourcePartyId: integer
(int64)
Title:
Owner
The identifier of the resource associated with the child split revenue. -
RevnAmount: number
Title:
Line Revenue
Default Value:0
The revenue amount. -
RevnAmountCurcyCode: string
Title:
Currency
Maximum Length:15
The currency the amount on this revenue line is based on. -
RevnId: integer
(int64)
The unique identifier of the child split revenue.
-
RevnNumber: string
Title:
Revenue Number
Maximum Length:30
The unique number for the revenue line. -
SalesCreditTypeCode: string
Title:
Sales Credit Type
Maximum Length:30
Default Value:QUOTA
Indicates the type of credit. -
SplitPercent: number
Title:
Sales Credit
The percentage of split revenue. -
TerrOwnerPartyName: string
Title:
Owner
Read Only:true
Maximum Length:360
The name of the forecast territory owner.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : opportunities-ChildRevenue-productGroups-item-response
Type:
Show Source
object
-
Description: string
Title:
Description
Read Only:true
Maximum Length:1000
The user-provided description of the product group. -
DisplayName: string
Title:
Name
Read Only:true
Maximum Length:255
The name of the product group. -
LastUpdateDate: string
Title:
Last Updated Date
Read Only:true
The date the product group was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModelConfigAttributes: string
Read Only:
true
The model configuration attributes associated with the product group. -
ModelName: string
Read Only:
true
The model name associated with the product group. -
ProdGroupId: integer
Title:
Product Group ID
Read Only:true
The unique identifier of the product group. -
QuotableFlag: boolean
Title:
Quotable
Read Only:true
Indicates whether a product group is quotable. -
ReferenceNumber: string
Title:
Reference Number
Read Only:true
The reference number of the product group.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-ChildRevenue-products-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Read Only:true
Indicates if the product is Active. -
CSSEnabled: string
Read Only:
true
Indicates if the product is enabled for customer self-service. The default value is No. -
Description: string
Title:
Name
Read Only:true
Maximum Length:255
The description of the product associated with the opportunity. -
EndDate: string
(date-time)
Title:
Effective to Date
Read Only:true
The date after which the product is no longer available. -
InventoryItemId: integer
Title:
Inventory Item ID
Read Only:true
The unique identifier of the product inventory item associated with the opportunity. -
InvOrgId: integer
Title:
Inventory Organization ID
Read Only:true
The unique identifier of the inventory organization. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the product was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LongDescription: string
Title:
Description
Read Only:true
Maximum Length:4000
A detailed description of the product. -
ProdGroupId: integer
Title:
Product Group ID
Read Only:true
The unique identifier of the Product Group. -
ProductNum: string
Title:
Product Number
Read Only:true
The alternate key identifier of the product. -
ProductType: string
Title:
Product Type
Read Only:true
The type of the product, such as item or product group. -
ServiceRequestEnabledCode: string
Read Only:
true
The code indicating whether the product is serviceable. If the value is True, then the product is serviceable. -
StartDate: string
(date-time)
Title:
Effective from Date
Read Only:true
The date from which the product is available. -
Text: string
Title:
Keyword
The text or keywords associated with the product.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-ChildRevenue-RecurringRevenue-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
EffectiveDate: string
(date)
Title:
Line Close Date
Estimated close date for this revenue - defaulted from opportunity's close date. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NonRecurringRevenue: number
Title:
Nonrecurring Revenue
The non recurring revenue amount on the revenue line. -
Quantity: number
Title:
Quantity
Product quantity. -
RecurParentRevnId: integer
(int64)
Indicates the parent revenue id for the recurrence.
-
RecurRevenue: number
Title:
Recurring Revenue
The recurring revenue amount on the revenue line. -
RevnAmount: number
Title:
Line Revenue
Default Value:0
Revenue amount. -
RevnAmtCurcyCode: string
Read Only:
true
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
(int64)
Revenue identifier.
-
RevnNumber: string
Title:
Revenue Number
Maximum Length:30
User editable revenue number. Defaulted from REVN_ID. Needs to be unique, cannot be NULL. -
UsageRevenue: number
Title:
Usage Revenue
The usage revenue amount on the revenue line.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-ChildRevenue-RevenueTerritory-item-response
Type:
Show Source
object
-
AssignmentType: string
Title:
Assignment Type
Read Only:true
Maximum Length:15
The type of assignment used to assign the territory to the opportunity. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the revenue territory record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
EffectiveEndDate: string
(date)
The date when the resource organization assignment to the territory ends.
-
EffectiveStartDate: string
(date)
The date when the resource organization for the territory was assigned to the revenue line.
-
ForecastParticipationCode: string
Title:
Forecast Participation
Read Only:true
Maximum Length:30
The code to identify the forecast type that the territory participates in. For example, Revenue, Nonrevenue, Revenue and Nonrevenue, or Nonforecasting. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Revenue Line Territory
Read Only:true
Maximum Length:60
The name of the territory that the opportunity belongs to. -
Name1: string
Title:
Organization
The name of the organization that the territory resource belongs to. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique identifier of the resource who owns the territory. -
PartyName: string
Title:
Owner
Read Only:true
Maximum Length:360
The name of the territory owner for the opportunity. -
RevnId: integer
(int64)
The unique identifier of the revenue.
-
RevnTerrId: integer
(int64)
The unique identifier of the revenue territory.
-
RoleId: integer
The unique identifier of the resource's role.
-
RoleName: string
The name of the resource's role.
-
TerritoryId: integer
(int64)
The unique identifier of the territory.
-
TerritoryVersionId: integer
(int64)
The unique identifier of the territory version.
-
TypeCode: string
Title:
Type
Read Only:true
Maximum Length:30
The code indicating the type of territory assigned to the opportunity. A list of valid values is defined in the lookup MOT_TERRITORY_TYPE.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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: { ... } ... }