RevenueForecast

Represents a revenue-based forecast.

The API also provides quantity-based forecasts with QuantityForecast.

Supported Calls

create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()

Special Access Rules

Customer Portal users can't access this object.

Fields

Field Details
Closed
Type
currency
Properties
Create, Filter
Description
Read only. A rollup of opportunities or opportunity line items that have closed in this period.
Commit
Type
currency
Properties
Filter, Nillable
Description
The owner's Commit total.
CommitComment
Type
string
Properties
Filter, Nillable, Update
Description
Read only. The comment entered when the owner edited his or her Commit total from the Adjusted Total link on the forecast edit page.
CommitOverride
Type
currency
Properties
Filter, Nillable, Update
Description
Read only. The owner's override of their own My Commit total.
CurrencyIsoCode
Type
picklist
Properties
Filter, Restricted picklist, Update
Description
Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. You can update or upsert this field and Quota only.
DefaultRollupCommit
Type
currency
Properties
Filter, Nillable
Description
Read only. The owner's standard Commit rollup, including their own opportunities and forecast-level overrides from subordinate users in the role hierarchy.
DefaultRollupUpside
Type
currency
Properties
Filter, Nillable
Description
Read only. The owner's standard Best Case rollup, including their own opportunities and forecast-level overrides from subordinate users in the role hierarchy.
InvalidationDate
Type
dateTime
Properties
Filter, Nillable
Description
Read only. If not blank, indicates that the rollup numbers for Forecast Override fields that represent calculated (summarized) amounts may not be up to date.
ManagerChoiceCommit
Type
picklist
Properties
Filter, Nillable, Restricted picklist, Update
Description
Read only. The manager's choice regarding the commit amount:
  • DefaultRollup: Use the manager's default commit rollup for owner's forecast, which reflects the manager's opportunity forecast overrides.
  • AcceptForecast (default selection): Accept the forecast owner's Adjusted Total commit amount, which may or may not be an override.
  • ManagerManualOverride: Use the manager's manual override.
  • OpportunityOnlyRollup: Use the opportunity rollup, including opportunity forecast overrides, but excluding any forecast-level (Adjusted Total) overrides.
ManagerChoiceUpside
Type
picklist
Properties
Filter, Nillable, Restricted picklist, Update
Description
Read only. The manager's choice regarding the best case amount:
  • DefaultRollup: Use the manager's default best case rollup for owner's forecast, which reflects the manager's opportunity forecast overrides.
  • AcceptForecast (default selection): Accept the forecast owner's Adjusted Total best case amount, which may or may not be an override.
  • ManagerManualOverride: Use the manager's manual override.
  • OpportunityOnlyRollup: Use the opportunity rollup, including opportunity forecast overrides, but excluding any forecast-level (Adjusted Total) overrides.
ManagerClosed
Type
currency
Properties
Filter, Nillable
Description
Read only. The manager's closed total for the owner's forecast, including any opportunity or opportunity product overrides made by the manager.
ManagerCommit
Type
currency
Properties
Filter, Nillable
Description
The manager's Commit total.
ManagerCommitOverride
Type
currency
Properties
Filter, Nillable, Update
Description
Read only. The manager's manual override of the forecast owner's Commit total. Represents an option in the override popup window, which allows managers to choose how to roll up the forecast numbers of a direct report.
ManagerDefaultRollupCommit
Type
currency
Properties
Filter, Nillable
Description
Read only. The manager's standard Commit rollup for the forecast owner. Represents an option in the override pop-up window, which allows managers to choose how to roll up the forecast numbers of a direct report.
ManagerDefaultRollupUpside
Type
currency
Properties
Filter, Nillable
Description
Read only. The manager's standard Best Case rollup for the forecast owner. Represents an option in the override pop-up window, which allows managers to choose how to roll up the forecast numbers of a direct report.
ManagerId
Type
reference
Properties
Filter, Nillable
Description
Read only. ID of the direct manager of the user who owns this forecast.
ManagerOpportunityRollupCommit
Type
currency
Properties
Filter, Nillable
Description
The manager's view of the forecast owner's opportunity-level Commit rollup, ignoring all forecast overrides. Represents an option in the override pop-up window, which allows managers to choose how to roll up the forecast numbers of a direct report.
ManagerOpportunityRollupUpside
Type
currency
Properties
Filter, Nillable
Description
The manager's view of the forecast owner's opportunity-level Best Case rollup, ignoring all forecast overrides. Represents an option in the override pop-up window, which allows managers to choose how to roll up the forecast numbers of a direct report.
ManagerPipeline
Type
currency
Properties
Filter, Nillable
Description
The manager's pipeline total for the owner's forecast, including any opportunity or opportunity product overrides made by the manager.
ManagerTerritoryId
Type
reference
Properties
Filter, Nillable
Description
ID of the manager's UserRole or Territory.
ManagerUpside
Type
currency
Properties
Filter, Nillable
Description
The manager's Best Case total.
ManagerUpsideOverride
Type
currency
Properties
Filter, Nillable, Update
Description
The manager's manual override of the forecast owner's Best Case total. Represents an option in the override pop-up window, which allows managers to choose how to roll up the forecast numbers of a direct report.
OpportunityRollupClosed
Type
currency
Properties
Filter, Nillable
Description
The owner's Closed total for his or her opportunities only.
OpportunityRollupCommit
Type
currency
Properties
Filter, Nillable
Description
The owner's Commit total for his or her opportunities only.
OpportunityRollupPipeline
Type
currency
Properties
Filter, Nillable
Description
The owner's Pipeline total for his or her opportunities only.
OpportunityRollupUpside
Type
currency
Properties
Filter, Nillable
Description
Read only. The owner's Best Case total for his or her opportunities only.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter
Description
ID of the User who owns this forecast. Required on create.
PeriodId
Type
reference
Properties
Filter, Nillable
Description
The ID of the Period that contains the StartDate.
Pipeline
Type
currency
Properties
Filter, Nillable
Description
The total pipeline rollup from subordinates in the role hierarchy, including the owner's opportunities.
ProductFamily
Type
picklist
Properties
Create, Filter, Nillable
Description
The value chosen in the Product Family picklist, which can be configured from Setup at Customize | Products | Fields. This field is relevant if you have chosen “Use Product Families” as the Forecast Type from Setup at Customize | Forecast | Settings. If you are not forecasting by product family or if the forecast represents opportunities that are not associated with a product family, then this field is blank. Otherwise, this field is required on create.
Quota
Type
currency
Properties
Create, Filter, Nillable, Update
Description
The quota amount for the period. You can update or upsert this field and CurrencyIsoCode, and for Quota only, create. Requires the “Modify All Data” and “Manage Users” permission. Required on create.
StartDate
Type
date
Properties
Create, Filter, Nillable
Description
The start date of this forecast. The period ID of the period that contains this date is written to the PeriodId field if it changes. A new Period is created if none exists. Required on create.
TerritoryId
Type
reference
Properties
Create, Filter, Nillable
Description
ID of the forecast owner's UserRole or Territory. Required on create if Territory Management is enabled (if this field is available).
Upside
Type
currency
Properties
Filter, Nillable
Description
The owner's Best Case total.
UpsideComment
Type
string
Properties
Filter, Nillable, Update
Description
Read only. The comment entered when the owner edited his or her Best Case total. Label is Best Case Comment.
UpsideOverride
Type
currency
Properties
Filter, Nillable, Update
Description
Read only. The owner's override of their My Best Case total. Label is Best Case Override.

Usage

Query this object to support customizable forecasts based on revenue. Requires the “View All Data” permission.

You can also update CurrencyIsoCode and Quota, which means that you can mass update sales users' quotas instead of updating them one by one in the user interface. Editing Quota requires “Modify All Data” and “Manage Users” permissions.

The rollup fields always reflect opportunity and opportunity product overrides by the forecast owner or one of the forecast owner’s subordinates in the role hierarchy. In addition, the manager rollup fields include overrides by the forecast owner's direct manager in the role hierarchy.

Some of the rollup fields ignore forecast-level (Adjusted Total) overrides, but they never ignore opportunity forecast overrides that are visible to the owner or manager.

© Copyright 2000–2014 salesforce.com, inc. All rights reserved.
Various trademarks held by their respective owners.