Get an unforecasted revenue item
get
/crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}/child/unforecastedPipeline/{unforecastedPipelineUniqID}
Request
Path Parameters
-
ForecastParticipantId(required): integer(int64)
The unique identifier of the participant associated with the territory forecast.
-
unforecastedPipelineUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Revenue Items resource and used to uniquely identify an instance of Revenue Items. The client should not generate the hash key value. Instead, the client should query on the Revenue Items collection resource in order to navigate to a specific instance of Revenue Items to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to 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 : territoryForecasts-unforecastedPipeline-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 aggregated amount 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 opportunity revenue amount converted to the corporate currency. -
CloseReasonCode: string
Title:
Win/Loss Reason
Maximum Length:30
The reason for winning or losing the revenue. -
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 name of the primary competitor. For the opportunity. -
ConflictId: integer
(int64)
Title:
Conflict ID
Default Value:0
Disconnected Mobile: this value is used to guarantee the uniqueness of the row when duplicates are created in different databases (i.e. mobile databases or the server). -
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 associated with the pipeline. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrStgId: integer
(int64)
Title:
Sales Stage
Read Only:true
The unique identifier of the sales stage of the opportunity. -
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 customer registry identifier of the sales account associated with the opportunity. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the forecast item has been deleted from the forecast. -
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 opportunity revenue line recurrence start date. -
EffectiveStartDate: string
(date)
Read Only:
true
The opportunity revenue line recurrence end date. -
ExpectAmount: number
Title:
Expected Revenue
Default Value:0
The expected 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 number 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
Non-Recurring Revenue Amount (Net) -
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 underlying opportunity was created. -
OpportunityCurrencyCode: string
Title:
Opportunity Currency
Read Only:true
Maximum Length:15
The currency on which the opportunity amount is based on. -
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 the opportunity owner. -
OpportunityPrSrcNumber: string
Title:
Primary Source
Read Only:true
Maximum Length:100
The primary marketing source or campaign that generated this opportunity. -
OptyEffectiveDate: string
(date)
Title:
Opportunity Close Date
Read Only:true
The estimated close date for the opportunity. -
OptyId: integer
(int64)
Title:
Revenue Opportunity ID
The unique identifier of the opportunity. -
OptyLastUpdateDate: string
(date-time)
Title:
Opportunity Last Update Date
Read Only:true
The date when the underlying opportunity 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 alternate key identifier of the opportunity associated with the partner. -
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. -
OwnerPartyNumber: string
Title:
Owner Number
Read Only:true
Maximum Length:30
The alternate identifier of the opportunity owner. -
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 partner engagement type. -
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
Name of this party -
PrCmptPartyId: integer
(int64)
Title:
Competitor
The unique identifier of the primary competitor of the child revenue. -
PriceTypeCode: string
Title:
Price Type
Maximum Length:30
The type of pricing associated with the revenue line -
PrimaryCompetitorPartyNumber: string
Title:
Primary Competitor Party Number
Read Only:true
Maximum Length:30
Primary competitor party id. -
PrimaryContactPartyId: integer
(int64)
Title:
Primary Contact Party ID
Read Only:true
The unique identifier of the primary contact. -
PrimaryContactPartyName: string
Title:
Primary Contact
Read Only:true
Maximum Length:360
The name of the primary contact. -
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 opportunity belongs. -
PrimaryPartnerCompanyNumber: string
Title:
Primary Partner Number
Maximum Length:30
The alternate identifier of the primary partner. -
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
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
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 if a product group is quotable. -
ProductConfigurableFlag: boolean
Title:
Configurable Product
Read Only:true
Maximum Length:1
Indicates that a product allows configuration. -
ProductGroupReferenceNumber: string
Title:
Product Group Reference Number
Maximum Length:50
The product group identifier. -
ProductModelConfigAttributes: string
Title:
Product Model Attributes
Read Only:true
Maximum Length:4000
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
Model Name associated with the Product in Revenue Line. -
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 the revenue item. -
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. -
Quantity: number
Title:
Quantity
The quantity of product for this opportunity. -
RecordSet: string
Title:
Record Set
Read Only:true
The revenue category used in Revenue Line Set functionality. -
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. -
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 indicating 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. -
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 recurring revenue line. -
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. -
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 code indicating the currency used to calculate the revenue for this opportunity. -
RevnCategoryCode: string
Title:
Revenue Category
Maximum Length:30
The revenue category used in Revenue Line Set functionality. -
RevnCreationDate: string
(date-time)
Title:
Creation Date
functional creation date for the revenue item -
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 line 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 or Standard Revenue. -
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 number indicating the sequence of the revenue in the pipeline. -
SalesAccountId: integer
(int64)
Title:
Account
The unique identifier of the opportunity sales account. -
SalesChannelCd: string
Title:
Sales Channel
Maximum Length:50
The sales channel for the opportunity. -
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. -
SalesMethodId: integer
(int64)
Title:
Sales Method
Read Only:true
The unique identifier of the sales method. -
ScheduleAction: string
Title:
Schedule Action
Transient attribute. Web services need to pass a value to indicate the action to be taken on Recurring Schedule - create, delete, extend, replace. -
ScheduleNonRecurringAmount: number
Title:
Nonrecurring Amount for Schedule
The nonrecurring 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 that indicates if the split is revenue or non-revenue. -
StatusCd: string
Title:
Opportunity Status
Read Only:true
Maximum Length:30
The revenue status code. -
StatusCode: string
Title:
Status
Maximum Length:30
The unique code of the status for the child revenue. -
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. -
SummaryRevnAmtInCorpCur: number
Title:
Opportunity Summary Revenue in Corporate Currency
Read Only:true
The revenue amount converted to corporate currency. -
SumRevnDownsideAmt: number
Title:
Opportunity Worst Case
Read Only:true
Default Value:0
The worst case amount. -
SumRevnUpsideAmt: number
Title:
Opportunity Best Case
Read Only:true
Default Value:0
The best case amount. -
TargetPartyId: integer
(int64)
Title:
Account Party ID
The unique identifier of the sales account that owns the opportunity. -
TerrOwnerOrganizationId: integer
Read Only:
true
The primary territory orgnization for this revenue item. -
TerrOwnerPartyName: string
Title:
Forecast Territory Owner
Read Only:true
Maximum Length:360
The primary territory owner for this revenue item. -
TerrOwnerResourceId: integer
(int64)
Title:
Resource ID
Read Only:true
The primary territory owner identitier for this revenue item. -
TimeFilter: string
Title:
Close Period
Read Only:true
The time filter associated with the line. -
TypeCode: string
Title:
Revenue Type
Maximum Length:30
The revenue type for the revenue earned from the opportunity. -
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 forecast item has been updated in the forecast. -
UpsideAmount: number
Title:
Best Case
Default Value:0
The maximum revenue amount 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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- BusinessUnitPVO1
-
The list of values for the business unit that owns the opportunity.
The following properties are defined on the LOV link relation:- Source Attribute: BUOrgId; Target Attribute: BusinessUnitId
- Display Attribute: Name
- ClosePeriodLookupPVO
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DMOO_OPTY_SRCH_CLS_PERIOD
The list of names of the filters by which opportunities can be filtered based on effective date range.
The following properties are defined on the LOV link relation:- Source Attribute: TimeFilter; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CloseReasonLOV
-
Parameters:
- finder:
CommonSetIdWithBUIdFinder%3BpBusinessUnitId%3D{BUOrgId}%2CpLookupType%3DMOO_SETID_WIN_LOSS_REASON%2CpReferenceGroupName%3DMOO_SETID_WIN_LOSS_REASON%2CpEnabledFlag%3DY
The list of values for the reason for winning or losing the revenue, such as Good Lead, or Install Base.
The following properties are defined on the LOV link relation:- Source Attribute: CloseReasonCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ForecastCategoryVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MOO_FORECAST_CATEGORY_TYPE
The list of values of forecast category type.
The following properties are defined on the LOV link relation:- Source Attribute: ForecastCategory; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- OptyRevenueCategoryLOV
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOO_REVN_CATEGORY%2CBindLookupCode%3D{RevnCategoryCode}
The list of values for the revenue category used in Revenue Line Set functionality such as Software, Training, or Hardware.
The following properties are defined on the LOV link relation:- Source Attribute: RevnCategoryCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- OptyStatusZbsLookupValuesVO
-
Parameters:
- finder:
StatusByBUIdFinder%3BBindEnabledFlag%3DY%2CBindLookupType%3DOPTY_STATUS%2CBindBUId%3D{BUOrgId}
The list of values for the status codes of the revenue line.
The following properties are defined on the LOV link relation:- Source Attribute: StatusCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- OwnerLockAsgnFlagLookupPVO
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DYES_NO
The list of values that indicate if the revenue owner assignment should be locked, such as Y or N.
The following properties are defined on the LOV link relation:- Source Attribute: OwnerLockAsgnFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- PriceTypeLookupPVO
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{PriceTypeCode}%2CBindLookupType%3DORA_ZCA_SO_LINE_PRICE_TYPE
The list of values indicating the price types associated with a product.
The following properties are defined on the LOV link relation:- Source Attribute: PriceTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ProductGroupExtnVA
-
Parameters:
- finder:
ProductGroupList%3BBind_UsageCode%3DBASE%2CBind_UsageModeCode%3DMOO
The following properties are defined on the LOV link relation:- Source Attribute: ProdGroupName; Target Attribute: HierProdGroupName
- Display Attribute: HierProdGroupName
- finder:
- ProductTypeLookupVOVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MOO_PROD_TYPE
The list of values for the type of product on the revenue line, such as item or product group.
The following properties are defined on the LOV link relation:- Source Attribute: ProductType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RatedCurrenciesVO
-
The list of values for the common CRM currency code such as USD,CAD, or INR.
The following properties are defined on the LOV link relation:- Source Attribute: CrmCurcyCode; Target Attribute: CurrencyCode
- Display Attribute: CurrencyCode
- RecurFrequencyLOV
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOO_RECURRING_FREQUENCY
The list of values for the code that indicates the frequency of recurrence for the child revenue, such as Weekly, Monthly, or Bi-Weekly.
The following properties are defined on the LOV link relation:- Source Attribute: RecurFrequencyCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RecurTypeLOV
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOO_REVN_RECUR_TYPE
The list of values for the code that indicates the frequency of recurrence for the child revenue, such as Child Recurrence (CHILDRECUR), or Parent Recurrence (PARENTRECUR).
The following properties are defined on the LOV link relation:- Source Attribute: RecurTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RevenueSalesChannelLookupVO
-
Parameters:
- finder:
SalesChannelFinder%3BBindLookupCode%3DZPM_PARTNER_CHANNEL_TYPES%2CBindLookupType%3DZPM_SALES_CHANNEL
The list of values for the sales channel of the opportunity, such as Direct (ZPM_DIRECT_CHANNEL_TYPES), or Indirect (ZPM_INDIRECT_CHANNEL_TYPES).
The following properties are defined on the LOV link relation:- Source Attribute: SalesChannelCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RevenueTypeCategoryPVO
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{RevenueTypeCategory}%2CBindLookupType%3DORA_MOO_REVN_CATEGORY_TYPE
The list of values for revenue category type, such as New, Renew, Expansion, and Do not renew.
The following properties are defined on the LOV link relation:- Source Attribute: RevenueTypeCategory; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RevenueTypeLOV
-
Parameters:
- finder:
CommonSetIdWithBUIdFinder%3BpBusinessUnitId%3D{BUOrgId}%2CpEnabledFlag%3DY%2CpLookupType%3DMOO_SETID_REVENUE_TYPE%2CpReferenceGroupName%3DMOO_SETID_REVENUE_TYPE
The list of values for the revenue type for the revenue earned from the opportunity, such as Closed, Committed, or Pipeline.
The following properties are defined on the LOV link relation:- Source Attribute: TypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RevnAmountCurcyCodeVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: RevnAmountCurcyCode; Target Attribute: CurrencyCode
- Display Attribute: CurrencyCode
- RevnFrcstOverrideCodeLOV
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZSF_FCST_INCLUDE_IN_FCST%2CBindLookupCode%3D{ForecastOverrideCode}
The list of values for the code that indicates if the revenue forecast should be overridden, such as always, never, or criteria.
The following properties are defined on the LOV link relation:- Source Attribute: ForecastOverrideCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RevnStatusZbsValuesLOV
-
Parameters:
- finder:
StatusByBUIdFinder%3BBindEnabledFlag%3DY%2CBindLookupType%3DOPTY_STATUS%2CBindBUId%3D{BUOrgId}
The list of values for the unique code of the child revenue status, such as Open, Won, or Lost.
The following properties are defined on the LOV link relation:- Source Attribute: StatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SalesCatalogExtnProductsLovVA
-
Operation: /crmRestApi/resources/11.13.18.05/productsParameters:
- finder:
ProductList%3BBind_UsageCode%3DBASE%2CBind_UsageModeCode%3DMOO
The following properties are defined on the LOV link relation:- Source Attribute: Description; Target Attribute: Name
- Display Attribute: Name
- finder:
- SalesCreditTypeLOV
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOO_SALES_CREDIT_TYPE
The list of values for the type of the sales credit, such as quota or non-quota.
The following properties are defined on the LOV link relation:- Source Attribute: SalesCreditTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SalesMethodVA
-
Parameters:
- finder:
SalesMethodByBUFinder%3BBindBUId%3D{BUOrgId}
The list of values for the sales method identifier for this opportunity.
The following properties are defined on the LOV link relation:- Source Attribute: SalesMethodId; Target Attribute: SalesMethodId
- Display Attribute: Name
- finder:
- SalesStageVA
-
Parameters:
- finder:
SalesStageBySalesMethodFinder%3BBindSalesMethodId%3D{SalesMethodId}
The list of values for the current sales stage identifier of the opportunity.
The following properties are defined on the LOV link relation:- Source Attribute: CurrStgId; Target Attribute: StgId
- Display Attribute: Name
- finder:
- ScheduleActionLOV
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MOO_REV_SCHEDULE_ACTION
The list of values that the web services can pass to indicate the action to be taken on Recurring Schedule such as create, delete, extend, or replace.
The following properties are defined on the LOV link relation:- Source Attribute: ScheduleAction; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SearchFilteringLookupPVO
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DMOO_REVN_SRCH_RECORD_SET
The list of names of the predefined opportunity search filters.
The following properties are defined on the LOV link relation:- Source Attribute: RecordSet; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SplitAllocTypeLOV
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOO_REVN_SPLIT_ALLOC_TYPE
The list of values for the code indicating the non-quota allocation split type, such as ad hoc amount or Proportional to Revenue.
The following properties are defined on the LOV link relation:- Source Attribute: NqSplitAllocTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SplitTypeLOV
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOO_REVN_SPLIT_TYPE
The list of values for the code that indicates if the split is revenue or non-revenue.
The following properties are defined on the LOV link relation:- Source Attribute: SplitTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- TerritoryListVA
-
The list of values that for the version identifier of a territory that is to be manually assigned to the revenue record.
The following properties are defined on the LOV link relation:- Source Attribute: PrTerritoryVersionIdForManual; Target Attribute: TerritoryVersionId
- Display Attribute: Name
- YesNoLookupPVO
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DYES_NO
The list of values that indicate if the revenue line should be used for forecasting, such as true or false.
The following properties are defined on the LOV link relation:- Source Attribute: CommitFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
Examples
The following example shows how to get an unforecasted revenue item by submitting a get request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territoryForecasts/1897628/child/unforecastedPipeline/300100090407978?onlyData=true
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "RevnId" : 300100090407978, "TargetPartyId" : 999997550776400, "CustomerAccountId" : null, "BUOrgId" : 5186, "Comments" : null, "CommitFlag" : false, "CostAmount" : 0, "ResourcePartyId" : 300100027483620, "DownsideAmount" : 0, "ExpectAmount" : 12500, "MarginAmount" : 0, "OptyId" : 300100090387685, "UnitPrice" : null, "InventoryItemId" : null, "InventoryOrgId" : null, "Quantity" : 10, "RevnAmount" : 125000, "RevnAmountCurcyCode" : "USD", "TypeCode" : null, "UpsideAmount" : 125000, "WinProb" : 10, "UOMCode" : null, "ExpectDlvryDate" : null, "CreatedBy" : "ZSF_Sales_Rep3", "CreationDate" : "2016-07-29T14:59:21-07:00", "LastUpdatedBy" : "SALES_ADMIN", "LastUpdateDate" : "2016-09-19T01:53:42-07:00", "LastUpdateLogin" : "38CC162B2E17133AE05394D0F00AB723", "Description" : null, "OrganizationId" : null, "PrimaryFlag" : false, "RevnNumber" : "CDRM_99567", "ProdGroupId" : 999997826070652, "ProdGroupName" : "Agile Applications", "RecurFrequencyCode" : "NONE", "RecurEndDate" : null, "RecurParentRevnId" : null, "RecurNumberPeriods" : null, "RecurQuantity" : null, "RecurUnitPrice" : null, "RecurRevnAmount" : null, "RecurTypeCode" : "NONRECUR", "RecurStartDate" : null, "SalesCreditTypeCode" : "QUOTA", "SplitParentRevnId" : 300100090387706, "SplitPercent" : 100, "SplitTypeCode" : "DETAILCHILDSPLIT", "StatusCode" : "OPEN", "EffectiveDate" : "2016-10-16", "CloseReasonCode" : null, "PrCmptPartyId" : null, "RecurPeriodOrEndDateCode" : "EndAfter", "ActualCloseDate" : null, "PrTerritoryVersionId" : 300100026843435, "ConversionRate" : 1, "ConversionRateType" : "Corporate", "OwnerDealExpirationDate" : null, "OwnerDealProtectedDate" : null, "OwnerLockAsgnFlag" : false, "Name1" : "ZSF_Territory_USWest1", "ForecastOverrideCode" : "CRITERIA", "ItemNumber" : null, "ItemNumberInternal" : null, "ProductType" : "Group", "NqSplitAllocTypeCode" : null, "RecurDownsideAmount" : null, "RecurUpsideAmount" : null, "CrmCurcyCode" : "USD", "CrmConversionRateType" : "Corporate", "CrmConversionRate" : 1, "RevnCategoryCode" : null, "OptyLeadId" : null, "SalesChannelCd" : "ZPM_DIRECT_CHANNEL_TYPES", "PrPartOrgPartyId" : null, "PartEngagementTypeCd" : null, "CreditRcptPartOrgPartyId" : null, "PartOrgPartyId" : null, "PartOrgPartyName" : null, "ParentRevnId" : null, "RevnLineTypeCode" : "STANDARD_REVN", "RevnSequenceNumber" : null, "TerrOwnerOrganizationId" : 300100027657573, "EffectiveStartDate" : "2013-08-23", "EffectiveEndDate" : "4712-12-31", "SalesAccountId" : 999997550776400, "Discount" : null }