Get all territory forecasts
get
/crmRestApi/resources/11.13.18.05/territoryForecasts
Request
Query Parameters
-
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:- CurrentForecast: Finds all active forecast records.
Finder Variables: - FilterByParticipantId: Finds a territory forecast record with the specified participant identifier.
Finder Variables:- ForecastParticipantId; integer; The unique identifier of the forecast participant.
- MyForecast: Finds all forecast records for a specified user.
Finder Variables:- TrStatus; string; The accepted values for TrStatus are ACTIVE, PAST, and FUTURE. The forecast records for the given user are filtered based on the specified territory forecast status value.
- PrimaryKey: Finds the territory forecast record by primary key.
Finder Variables:- ForecastParticipantId; integer; The unique identifier of the territory forecast.
- CurrentForecast: Finds all active forecast records.
-
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:- ClosedAmt; number; The closed revenue amount for the territory forecast.
- CreatedBy; string; The user who created the record.
- CreationDate; string; The date when the record was created.
- DueDate; string; The due date for the forecast.
- EndDate; string; The end date for the forecast.
- FcstStatusQualifierCode; string; The status code indicating if a forecast territory is unsubmitted, submitted, or rejected.
- ForecastHeaderId; integer; The unique identifier of the forecast.
- ForecastName; string; The name of the forecast.
- ForecastParticipantId; integer; The unique identifier of the participant associated with the territory forecast.
- ForecastSeqNum; integer; The number that sorts the various forecasts into the correct sequence.
- ForecastType; string; The type of the forecast. The accepted values are: Revenue and Overlay.
- LastUpdateDate; string; The date when the record was last updated.
- LastUpdateLogin; string; The login of the user who last updated the record.
- LastUpdatedBy; string; The user who last updated the record.
- Meaning; string; The status of the forecast. The accepted values are: Submitted, Unsubmitted, and Rejected.
- Notes; string; The forecast summary adjustment comments.
- OwnerResourceId; integer; The unique identifier of the party that owns the territory.
- ParentTerritoryId; integer; The unique identifier of the parent territory.
- ParentTerritoryOwnerResourceId; integer; The unique identifier of the parent territory owner.
- PeriodName; string; The display name of the forecast adjustment period.
- PipelineAmt; number; The total amount of open opportunity revenue which is set to close within the same time frame as the current forecast period.
- StartDate; string; The start date for the forecast.
- StatusCode; string; The status code of the forecast. The accepted values are: SUBMITTED, UNSUBMITTED, and REJECTED.
- SubmittedBy; string; The name of the user who submitted the forecast.
- SubmittedOn; string; The date when the forecast was submitted.
- TerritoryHierarchyFreezeDate; string; The date on which the territory hierarchy is frozen. The forecast for a period is editable only after the territory hierarchy has been frozen for that forecasting period.
- TerritoryId; integer; The unique identifier of the territory.
- TerritoryLevel; number; The level of the territory in the territory hierarchy.
- TerritoryName; string; The name of the forecast territory.
- TerritoryVersionId; integer; The unique identifier of the territory version.
- UserLastUpdateDate; string; The date when the user last updated 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 : territoryForecasts
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 : territoryForecasts-item-response
Type:
Show Source
object
-
AdjustedBestCase: number
Title:
Adjusted Best Case
The best case value of the forecast after adjustments. -
AdjustedForecast: number
Title:
Adjusted Forecast
The value of the territory forecast after adjustments. -
AdjustedQuantity: number
Title:
Adjusted Quantity
The value of the adjusted quantity. -
AdjustedWorstCase: number
Title:
Adjusted Worst Case
The worst case value of the forecast after adjustments. -
ClosedAmt: number
Default Value:
0
The closed revenue amount for the territory forecast. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DueDate: string
(date)
Title:
Due Date
Read Only:true
The due date for the forecast. -
EndDate: string
(date)
Title:
End Date
Read Only:true
The end date for the forecast. -
FcstStatusQualifierCode: string
Title:
State
Read Only:true
Maximum Length:30
The status code indicating if a forecast territory is unsubmitted, submitted, or rejected. -
forecastAdjustmentPeriods: array
Adjustment Periods
Title:
Adjustment Periods
The forecast adjustment periods resource is used to view and update the time period adjustment applied to a territory forecast. -
ForecastByParentFlag: string
Title:
Forecast Invisible to Owner
Maximum Length:1
Indicates whether the territory is forecasted by the parent territory. -
ForecastHeaderId: integer
(int64)
Title:
Forecast Header ID
Read Only:true
The unique identifier of the forecast. -
ForecastItemDetail: array
Forecast Items
Title:
Forecast Items
The forecast items resource is used view and update the items associated with a forecast. -
ForecastName: string
Title:
Forecast Name
Read Only:true
Maximum Length:30
The name of the forecast. -
ForecastParticipantId: integer
(int64)
Title:
Participant ID
The unique identifier of the participant associated with the territory forecast. -
ForecastParticipationCode: string
Title:
Enable Forecasting
Maximum Length:30
The code indicating the type of participation of the forecast. The accepted values are Revenue (for revenue forecasts) and Non-Revenue (for overlay forecasts). -
forecastProducts: array
Forecast Products
Title:
Forecast Products
The forecast products resource is used to view and update the products associated with a forecast. The forecast products resource displays forecasts categorized by product. -
ForecastSeqNum: integer
(int32)
Title:
Forecast Sequence Number
Read Only:true
The number that sorts the various forecasts into the correct sequence. -
ForecastType: string
Title:
Forecast Type
Read Only:true
Maximum Length:30
The type of the forecast. The accepted values are: Revenue and Overlay. -
LastUpdateDate: string
(date-time)
Title:
Last Updated
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last 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. -
Meaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
The status of the forecast. The accepted values are: Submitted, Unsubmitted, and Rejected. -
NewAdjustedBestCase: number
Title:
New Best Case
The net new best case value of the forecast after adjustments. -
NewAdjustedForecast: number
Title:
New Forecast
The net new value of the territory forecast after adjustments. -
NewAdjustedQuantity: number
Title:
New Quantity
The value of the adjusted quantity for net new. -
NewAdjustedWorstCase: number
Title:
New Worst Case
The net new worst case value of the forecast after adjustments. -
Notes: string
Title:
Note
Maximum Length:1000
The forecast summary adjustment comments. -
OwnerResourceId: integer
(int64)
Title:
Owner ID
The unique identifier of the party that owns the territory. -
ParentTerritoryId: integer
(int64)
Title:
Parent Territory ID
The unique identifier of the parent territory. -
ParentTerritoryOwnerResourceId: integer
The unique identifier of the parent territory owner.
-
PeriodName: string
Title:
Forecast Period Name
Read Only:true
Maximum Length:30
The display name of the forecast adjustment period. -
PipelineAmt: number
Default Value:
0
The total amount of open opportunity revenue which is set to close within the same time frame as the current forecast period. -
PseudoTerritoryFlag: boolean
Title:
Manager Territory
Indicates if the territory is a manager territory. -
RenewalAdjustedBestCase: number
Title:
Renewal Best Case
The renewal best case value of the forecast after adjustments. -
RenewalAdjustedForecast: number
Title:
Renewal Forecast
The renewal value of the territory forecast after adjustments. -
RenewalAdjustedQuantity: number
Title:
Renewal Quantity
The value of the adjusted quantity for renewals. -
RenewalAdjustedWorstCase: number
Title:
Renewal Worst Case
The renewal worst case value of the forecast after adjustments. -
StartDate: string
(date)
Title:
Start Date
Read Only:true
The start date for the forecast. -
StatusCode: string
Title:
Status
Maximum Length:30
The status code of the forecast. The accepted values are: SUBMITTED, UNSUBMITTED, and REJECTED. -
SubmittedBy: string
Title:
Submitted By
Maximum Length:100
The name of the user who submitted the forecast. -
SubmittedOn: string
(date-time)
Title:
Submission Date
The date when the forecast was submitted. -
TerritoryHierarchyFreezeDate: string
(date)
Title:
Territory Freeze Date
Read Only:true
The date on which the territory hierarchy is frozen. The forecast for a period is editable only after the territory hierarchy has been frozen for that forecasting period. -
TerritoryId: integer
(int64)
Title:
Territory ID
The unique identifier of the territory. -
TerritoryLevel: number
Title:
Territory Level
The level of the territory in the territory hierarchy. -
TerritoryName: string
Title:
Territory Name
Maximum Length:60
The name of the forecast territory. -
TerritoryVersionId: integer
(int64)
Title:
Territory Version ID
The unique identifier of the territory version. -
unforecastedPipeline: array
Revenue Items
Title:
Revenue Items
The revenue items resource is used to view the revenue items that are not included in the forecast associated with a territory. -
UpdateFlag: boolean
Read Only:
true
Indicates if the user has access to update the record. -
UserLastUpdateDate: string
(date-time)
The date when the user last updated the opportunity.
Nested Schema : Adjustment Periods
Type:
array
Title:
Adjustment Periods
The forecast adjustment periods resource is used to view and update the time period adjustment applied to a territory forecast.
Show Source
Nested Schema : Forecast Items
Type:
array
Title:
Forecast Items
The forecast items resource is used view and update the items associated with a forecast.
Show Source
Nested Schema : Forecast Products
Type:
array
Title:
Forecast Products
The forecast products resource is used to view and update the products associated with a forecast. The forecast products resource displays forecasts categorized by product.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Revenue Items
Type:
array
Title:
Revenue Items
The revenue items resource is used to view the revenue items that are not included in the forecast associated with a territory.
Show Source
Nested Schema : territoryForecasts-forecastAdjustmentPeriods-item-response
Type:
Show Source
object
-
AdjustedForecast: number
The value of the revenue for the territory after adjustments.
-
AdjustmentComment: string
Read Only:
true
Maximum Length:360
The additional comments entered while making the adjustment. -
AdjustmentReason: string
Read Only:
true
Maximum Length:360
The code indicating the reason for adjusting the forecast. -
FcstAdjustmentId: integer
(int64)
Read Only:
true
The unique identifier of the adjustment made to the territory forecast. -
FcstAdjustPeriodId: integer
(int64)
Read Only:
true
The unique identifier of the forecast adjustment period. -
FcstHeaderId: integer
(int64)
Title:
Forecast Header ID
Read Only:true
The unique identifier of the forecast. -
FcstParticipantId: integer
(int64)
Title:
Participant ID
Read Only:true
The unique identifier of the territory forecast participant. -
LastAdjustedDate: string
(date)
Read Only:
true
The date when the territory forecast was last adjusted. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NewAdjustedForecast: number
The net new forecast value of the territory after adjustments.
-
NewUnadjustedForecast: number
The value of the unadjusted territory forecast for net new.
-
PeriodName: string
Title:
Adjustment Period
Maximum Length:15
The name of the forecast adjustment period. -
RenewalAdjustedForecast: number
The renewal forecast value of the territory after adjustments.
-
RenewalUnadjustedForecast: number
The value of the unadjusted territory forecast for renewals.
-
TerritoryId: integer
(int64)
Title:
Territory ID
Read Only:true
The unique identifier of the territory. -
UnadjustedForecast: number
The value of the unadjusted territory forecast.
-
UpdateFlag: boolean
Read Only:
true
Indicates if the user has access to update the record.
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 : territoryForecasts-ForecastItemDetail-item-response
Type:
Show Source
object
-
AdjustedForecast: number
Title:
Adjusted Forecast
The value of the revenue item after adjustments. -
AdjustedQuantity: number
Title:
Adjusted Quantity
The value of the adjusted quantity. -
AdjustmentType: string
Title:
Adjustment Type
Read Only:true
Maximum Length:30
The type of forecast adjustment that was created. A forecast can be adjusted either at the forecast item level or at the forecast summary level. -
AdjustPeriodId: integer
(int64)
Title:
Adjustment Period ID
The unique identifier of the forecast period. -
BestCaseAdjustedForecast: number
Title:
Adjusted Best Case
The best case value of the revenue item after adjustments. -
BUOrgId: integer
(int64)
The unique identifier of the business unit organization.
-
Category: string
Title:
Category
Read Only:true
Forecast item category denotes whether the forecast item is of type renewal or new. -
CorporateCurrencyCode: string
Title:
Currency
Maximum Length:30
The corporate currency code associated with the forecast. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CorporateUnadjustedDownsideAmount: number
Title:
Unadjusted Worst Case
The worst case revenue item amount in corporate currency. -
CorporateUnadjustedRevenueAmount: number
Title:
Unadjusted Forecast
The revenue item amount in corporate currency. -
CorporateUnadjustedUpsideAmount: number
Title:
Unadjusted Best Case
The best case revenue item amount in corporate currency. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CurrentStageId: integer
(int64)
Title:
Sales Stage
The unique identifier of the current sales stage associated with the opportunity. -
CustomerPartyId: integer
(int64)
Title:
Customer
The unique identifier of the customer associated with the revenue item. -
EffectiveDate: string
(date)
Title:
Close Date
The date when the revenue item becomes effective. -
ForecastHeaderId: integer
(int64)
Title:
Forecast Header ID
The unique identifier of the forecast. -
ForecastItemId: integer
(int64)
Title:
ForecastItem
The unique identifier of the forecast item. -
ForecastOverrideCode: string
Title:
Include in Forecast
Maximum Length:30
Forecast Override code for criteria. -
InventoryItemId: integer
(int64)
Title:
Product ID
Read Only:true
The unique identifier of the inventory item that is generated during product creation. -
InventoryOrgId: integer
(int64)
Title:
Inventory Organization ID
The unique identifier of the inventory organization that is generated during product creation. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last 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. -
OpportunityId: integer
(int64)
Title:
Opportunity ID
The unique identifier of the opportunity associated with the revenue item. -
OpportunityName: string
Title:
Opportunity
Maximum Length:275
The name of the opportunity. -
OpportunityStatusCode: string
Title:
Opportunity Status
Maximum Length:30
The status of the opportunity. -
OwnerName: string
Read Only:
true
Maximum Length:360
The name of the revenue item owner. -
OwnerResourceId: integer
(int64)
Title:
Credit Receiver ID
The unique identifier of the revenue owner. -
OwnerResourceOrgId: integer
(int64)
Title:
Resource Organization ID
The unique identifier of the revenue owner's organization. -
PartnerPartOrgPartyId: integer
(int64)
Title:
Partner Organization ID
The unique identifier of the partner party organization. -
PartnerSourceNumber: string
Title:
Primary Source Number
Maximum Length:30
The source number of the partner. -
PartyUniqueName: string
Title:
Account
Read Only:true
Maximum Length:900
The name of the sales account associated with the opportunity. -
PrimaryTerritoryId: integer
(int64)
Title:
Primary Territory ID
The unique identifier of the primary territory associated with the revenue item. -
PrimaryTerritoryVersionId: integer
(int64)
Title:
Primary Territory Version ID
The unique identifier of the primary territory version associated with the revenue item. -
ProductGroupId: integer
(int64)
Title:
Product Group ID
The unique identifier of the product group. -
ProductName: string
Title:
Product Name
The product name. -
Quantity: number
Title:
Quantity
The quantity of the revenue item. -
RecurTypeCode: string
Title:
Recurrence Type Code
Maximum Length:30
The code indicating if the opportunity is recurring. -
RevenueAmount: number
Title:
Revenue
The revenue amount associated with the revenue item. -
RevenueId: integer
(int64)
Title:
Revenue ID
The unique identifier of the revenue item associated with the forecast item. -
RevenueStatusCode: string
Title:
Status
Maximum Length:30
The status of the revenue item. -
RevenueTerritoryId: integer
(int64)
The unique identifier of the revenue territory. This attribute is populated only when a revenue item is pulled into a subordinate forecast by the manager.
-
UnadjustedQuantity: number
Title:
Unadjusted Quantity
Default Value:0
The value of the unadjusted quantity. -
UnitPrice: number
Title:
Estimated Price
The unit price of the revenue item. -
UpdateFlag: boolean
Read Only:
true
Indicates if the user has access to update the record. -
UserLastUpdateDate: string
(date-time)
Read Only:
true
The date when the user last updated the record. -
WinProbability: integer
(int32)
Title:
Win Probability
The win probability value of the revenue item. -
WorstCaseAdjustedForecast: number
Title:
Adjusted Worst Case
The worst case value of the revenue item after adjustments.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : territoryForecasts-forecastProducts-item-response
Type:
Show Source
object
-
AdjustedForecast: number
The value of the product forecast after adjustments.
-
AdjustedQuantity: number
The value of the adjusted quantity.
-
BestCaseAdjustedForecast: number
The best case value of the forecast after adjustments.
-
EntityType: string
Maximum Length:
360
The type of the entity, such as product or a product group. -
FcstHeaderId: integer
(int64)
Title:
Forecast Type
Read Only:true
The unique identifier of the forecast. -
FcstParticipantId: integer
(int64)
Title:
Participant ID
Read Only:true
The unique identifier of the participant associated with the territory forecast. -
FcstProductId: integer
(int64)
The unique identifier of the product.
-
forecastProductAdjustmentPeriods: array
Product Adjustment Periods
Title:
Product Adjustment Periods
The forecast product adjustment periods resource is used to view and update the time period adjustment applied to a forecast product. -
InventoryItemId: integer
(int64)
The unique identifier of the inventory item that is generated during product creation. This attribute in combination with the InvOrgID attribute forms the composite unique identifier of the inventory item.
-
InvOrgId: integer
(int64)
The unique identifier of the inventory organization that is generated during product creation. This attribute in combination with the InventoryItemID attribute forms the composite unique identifier of the inventory item.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
The product name.
-
NewAdjustedForecast: number
The net new value of the product forecast after adjustments.
-
NewAdjustedQuantity: number
The value of the adjusted quantity for net new.
-
NewBestCaseAdjustedForecast: number
The net new best case value of the forecast after adjustments.
-
NewUnadjustedBcAmount: number
The net new best case value of the unadjusted product forecast.
-
NewUnadjustedForecast: number
The value of the unadjusted product forecast for net new.
-
NewUnadjustedQuantity: number
The value of the unadjusted quantity for net new.
-
NewUnadjustedWcAmount: number
The net new worst case value of the unadjusted product forecast.
-
NewWorstCaseAdjustedForecast: number
The net new worst case value of the forecast after adjustments.
-
ParentFcstProductId: integer
(int64)
The unique identifier of the parent product.
-
ProdHierarchyLevel: number
The level of the node in the product hierarchy.
-
ProductGroupId: integer
(int64)
The unique identifier of the product group.
-
RenewalAdjustedForecast: number
The renewal value of the product forecast after adjustments.
-
RenewalAdjustedQuantity: number
The value of the adjusted quantity for renewals.
-
RenewalBestCaseAdjustedForecast: number
The renewal best case value of the forecast after adjustments.
-
RenewalUnadjustedBcAmount: number
The renewal best case value of the unadjusted product forecast.
-
RenewalUnadjustedForecast: number
The value of the unadjusted product forecast for renewals.
-
RenewalUnadjustedQuantity: number
The value of the unadjusted quantity for renewals.
-
RenewalUnadjustedWcAmount: number
The renewal worst case value of the unadjusted product forecast.
-
RenewalWorstCaseAdjustedForecast: number
The renewal worst case value of the forecast after adjustments.
-
SnapshotVersionId: integer
(int64)
The unique identifier of the product hierarchy snapshot version. A snap shot of the product hierarchy is taken for each forecasting period.
-
TerritoryId: integer
(int64)
Title:
Territory ID
Read Only:true
The unique identifier of the territory. -
UnadjustedBcAmount: number
The best case value of the unadjusted product forecast.
-
UnadjustedForecast: number
The value of the unadjusted product forecast.
-
UnadjustedQuantity: number
The value of the unadjusted quantity.
-
UnadjustedWcAmount: number
The worst case value of the unadjusted product forecast.
-
UnspecifiedFlag: boolean
Maximum Length:
1
The revenue associated with the product group for which the product is not specified. -
UpdateFlag: boolean
Read Only:
true
Indicates if the user has access to update the record. -
WorstCaseAdjustedForecast: number
The worst case value of the forecast after adjustments.
Nested Schema : Product Adjustment Periods
Type:
array
Title:
Product Adjustment Periods
The forecast product adjustment periods resource is used to view and update the time period adjustment applied to a forecast product.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : territoryForecasts-forecastProducts-forecastProductAdjustmentPeriods-item-response
Type:
Show Source
object
-
AdjustedForecast: number
The value of the forecast product after adjustments.
-
AdjustedQuantity: number
The value of the adjusted quantity.
-
AdjustmentPeriodEndDate: string
(date)
Read Only:
true
The date when the forecast ends. -
AdjustmentPeriodStartDate: string
(date)
Read Only:
true
The date when the forecast starts. -
BestCaseAdjustedForecast: number
The best case value of the forecast after adjustments.
-
BestCaseUnadjustedForecast: number
Read Only:
true
The best case value of the unadjusted product forecast. -
FcstAdjustPeriodId: integer
(int64)
Read Only:
true
The unique identifier of the summary level forecast adjustment. -
FcstHeaderId: integer
(int64)
Title:
Forecast Type
Read Only:true
The unique identifier of the forecast. -
FcstParticipantId: integer
(int64)
Title:
Participant ID
Read Only:true
The unique identifier of the territory forecast participant. -
FcstProductId: integer
(int64)
Read Only:
true
The unique identifier of the product that the forecast item is associated with. -
InventoryItemId: integer
(int64)
Read Only:
true
The unique identifier of the inventory item that is generated during product creation. This attribute in combination with the InvOrgID attribute forms the composite unique identifier of the inventory item. -
InvOrgId: integer
(int64)
Read Only:
true
The unique identifier of the inventory organization that is generated during product creation. This attribute in combination with the InventoryItemID attribute forms the composite unique identifier of the inventory item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NewAdjustedForecast: number
The net new value of the product forecast after adjustments.
-
NewAdjustedQuantity: number
The value of the adjusted quantity for net new.
-
NewBestCaseAdjustedForecast: number
The net new best case value of the forecast after adjustments.
-
NewBestCaseUnadjustedForecast: number
Read Only:
true
The net new best case value of the unadjusted product forecast. -
NewUnadjustedForecast: number
Read Only:
true
The value of the unadjusted territory forecast for net new. -
NewUnadjustedQuantity: number
Read Only:
true
The value of the unadjusted quantity for net new. -
NewWorstCaseAdjustedForecast: number
The net new worst case value of the forecast after adjustments.
-
NewWorstCaseUnadjustedForecast: number
Read Only:
true
The net new worst case value of the unadjusted product forecast. -
ParentFcstProductId: integer
(int64)
Read Only:
true
The unique identifier of the parent product. -
PeriodName: string
Title:
Adjustment Period
Read Only:true
Maximum Length:15
The name of the forecast period. -
PeriodSetName: string
Read Only:
true
Maximum Length:15
The name of the adjustment period. -
ProductGroupId: integer
(int64)
Read Only:
true
The unique identifier of the product group. -
RenewalAdjustedForecast: number
The renewal value of the product forecast after adjustments.
-
RenewalAdjustedQuantity: number
The value of the adjusted quantity for renewals.
-
RenewalBestCaseAdjustedForecast: number
The renewal best case value of the forecast after adjustments.
-
RenewalBestCaseUnadjustedForecast: number
Read Only:
true
The renewal best case value of the unadjusted product forecast. -
RenewalUnadjustedForecast: number
Read Only:
true
The value of the unadjusted territory forecast for renewals. -
RenewalUnadjustedQuantity: number
Read Only:
true
The value of the unadjusted quantity for renewals. -
RenewalWorstCaseAdjustedForecast: number
The renewal worst case value of the forecast after adjustments.
-
RenewalWorstCaseUnadjustedForecast: number
Read Only:
true
The renewal worst case value of the unadjusted product forecast. -
TerritoryId: integer
(int64)
Title:
Territory ID
Read Only:true
The unique identifier of the territory. -
UnadjustedForecast: number
Read Only:
true
The value of the unadjusted product forecast. -
UnadjustedQuantity: number
Read Only:
true
The value of the unadjusted quantity. -
UpdateFlag: boolean
Read Only:
true
Indicates if the user has access to update the record. -
WorstCaseAdjustedForecast: number
The worst case value of the unadjusted product forecast after adjustments.
-
WorstCaseUnadjustedForecast: number
Read Only:
true
The worst case value of the unadjusted product forecast.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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
Examples
The following example shows how to get all territory forecasts by submitting a get request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territoryForecasts
Example of Response Body
The following shows an example of the response body in JSON format.
{ "items": [20] 0: { "ForecastParticipantId": 463773 "ForecastHeaderId": 300100018228533 "StatusCode": "UNSUBMITTED" "DueDate": "2013-01-12" "StartDate": "2013-04-01" "ForecastName": "Q2-2013 - 2013/01/12" "TerritoryHierarchyFreezeDate": "2013-01-11" "Meaning": "Unsubmitted" "TerritoryLevel": 4 "TerritoryId": 300100012312306 "TerritoryVersionId": 300100015404040 "TerritoryName": "ZSF_Territory_US West" "OwnerResourceId": 100010037456217 "ForecastType": "REVENUE" "ForecastParticipationCode": "REVENUE_AND_NONREVENUE" "ParentTerritoryOwnerResourceId": 100010037456757 ... }