Newer Version Available

This content describes an older version of this product. View Latest

ForecastingItem

This is a read-only object used for individual forecast amounts. Users see amounts based on their perspectives and forecast roles. The amounts users see include one of the following when forecasting in revenue: AmountWithoutAdjustments, AmountWithoutManagerAdjustment, ForecastAmount, OwnerOnlyAmount. The amounts users see include one of the following when forecasting in quantity: QuantityWithoutAdjustments, QuantityWithoutManagerAdjustment, ForecastQuantity, OwnerOnlyQuantity. Available in API versions 26 and greater.
Additionally, note that users:
  • with the “View All Forecasts” permission have access to all ForecastingItem fields.
  • without the “View All Forecasts” permission have access to all fields for their own subordinates.
Other users can see the ForecastingItem object, but not its records.

This information only applies to Collaborative Forecasts.

Note

Supported Calls

describeSObjects()query()retrieve()

Fields

Field Name Details
AmountWithoutAdjustments
Type
double
Properties
Filter, Sort, Nillable
Description

The sum of a person’s owned revenue opportunities and the person's subordinates’ opportunities, without adjustments. Subordinates include everyone reporting up to a person in the forecast hierarchy. This amount is visible only on reports.

AmountWithoutManagerAdjustment
Type
double
Properties
Filter, Sort, Nillable
Description

The forecast number as seen by the forecast owner. This is the sum of the owner’s revenue opportunities and the owner’s subordinates’ opportunities, including adjustments made by the forecast owner on the owner's or subordinates’ forecasts. It doesn’t include adjustments made by forecast managers above the owner in the forecast hierarchy.

AmountWithoutOwnerAdjustment
Type
double
Properties
Filter, Sort, Nillable
Description

The forecast amount as seen by the forecast owner without the owner's adjustment. This is the sum of the subordinate's opportunities, including adjustments made by their manager or by the subordinate themselves, plus the rollup of the owner's own opportunities. It doesn’t include adjustments made by the forecast owner.

ForecastAmount
Type
double
Properties
Filter, Sort, Nillable
Description

The revenue forecast from the forecast manager’s perspective and the sum of the owner’s and subordinates’ opportunities, including all forecast adjustments.

ForecastCategoryName
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description

A forecast category is the category within the sales cycle to which an opportunity is assigned based on its opportunity stage. The standard forecast categories are Pipeline, Best Case, Commit, Omitted, and Closed. You can customize the forecast category names.

ForecastQuantity
Type
double
Properties
Filter, Sort, Nillable
Description

The quantity forecast from the forecast manager’s perspective and the sum of the owner’s and subordinates’ opportunities, including all forecast adjustments. This field is available in API version 28 and later.

ForecastingItemCategory
Type
picklist
Properties
Filter, Group, Sort
Description
This field indicates which type of forecast rollup the forecasting item belongs to. Depending on whether your organization uses individual forecast category rollups or cumulative forecast rollups, you have these possible values for the ForecastingItemCategory field.
Individual forecast category rollups:
  • PipelineOnly - Rollup from Pipeline opportunities only.
  • BestCaseOnly - Rollup from Best Case opportunities only. Adjustable.
  • CommitOnly - Rollup from Commit opportunities only. Adjustable.
Cumulative forecast rollups:
  • OpenPipeline - Rollup from Pipeline + Best Case + Commit opportunities.
  • BestCaseForecast - Rollup from Best Case + Commit + Closed opportunities. Adjustable.
  • CommitForecast - Rollup from Commit + Closed opportunities. Adjustable.
Either cumulative or individual forecast category rollups:
  • ClosedOnly - Rollup from Closed opportunities only.

The ForecastingItemCategory field differs from the ForecastCategoryName field.

  • The ForecastCategoryName field represents the forecast category of the underlying opportunities rolling up to forecast amounts. In organizations using cumulative forecast rollups, the ForecastCategoryName field can be null because the cumulative forecast amounts include opportunities from multiple forecast categories.
  • The new ForecastingItemCategory field represents the type of rollup a forecast amount or adjustment is from. In organizations using individual forecast category columns, it contains the individual forecast rollup categories. In organizations using cumulative forecast rollups, it contains the cumulative rollup categories.
ForecastingTypeId
Type
reference
Properties
Filter, Group, Sort
Description

The ID of the related ForecastingType.

HasAdjustment
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description

A flag that indicates if the forecasting item includes a manager adjustment. This flag is true only when the item includes an adjustment and the user performing the query has read access to the adjustment.

HasOwnerAdjustment
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description

A flag that indicates if the forecasting item includes an owner adjustment. This flag is true only when the item includes an adjustment and the user performing the query has read access to the adjustment. Available in API versions 33 and greater.

IsAmount
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description

True indicates that the adjustment is made in a revenue amount. If false, then IsQuantity must be true. This field is available in API version 28 and later.

IsQuantity
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description

True indicates that the adjustment is made in a quantity amount. If false, then IsAmount must be true. This field is available in API version 28 and later.

IsUpToDate
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description

A flag indicating whether or not a specific forecasting item reflects current information. For example, if users are making adjustments which are in process, the item won’t be up-to-date.

OwnerId
Type
reference
Properties
Filter, Group, Sort
Description

The ID of the forecast owner.

OwnerOnlyAmount
Type
double
Properties
Filter, Sort, Nillable
Description

The sum of a person’s revenue opportunities, without adjustments.

OwnerOnlyQuantity
Type
double
Properties
Filter, Sort, Nillable
Description

The sum of a person’s quantity opportunities, without adjustments. This field is available in API version 28 and later.

ParentForecastingItemId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description

The ID of the ForecastingItem that the current item rolls up to.

PeriodId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description

Period ID for the forecast.

ProductFamily
Type
picklist
Properties
Filter, Group, Nillable, Sort
Description
The product family of the forecast item. This field is available in API version 29 and later. Read only.
QuantityWithoutAdjustments
Type
double
Properties
Filter, Sort, Nillable
Description

The sum of a person’s owned quantity opportunities and also his or her subordinates’ opportunities, without adjustments. Subordinates include everyone reporting up to a person in the forecast hierarchy. This field is available in API version 28 and later.

QuantityWithoutManagerAdjustment
Type
double
Properties
Filter, Sort, Nillable
Description

The forecast number as seen by the forecast owner. This is the sum of the owner’s quantity opportunities and subordinates’ opportunities, including adjustments made on the subordinates’ forecasts.  It doesn’t include adjustments made by forecast managers above the owner in the forecast hierarchy. This field is available in API version 28 and later.

QuantityWithoutOwnerAdjustment
Type
double
Properties
Filter, Sort, Nillable
Description

The forecast quantity as seen by the forecast owner without the owner's adjustment. This is the sum of the subordinate's opportunities, including adjustments made by their manager or by the subordinate themselves, plus the rollup of the owner's own opportunities. It doesn’t include adjustments made by the forecast owner. This field is available in API version 38.0 and later.

Usage

Use this object to obtain individual forecast amounts, either with or without adjustments, based on a user’s perspective and forecast role. The ForecastingItem object is visible to all users, but only forecast managers and users above them in the forecast hierarchy can read or write ForecastingAdjustment records.

Beginning with API version 30.0, organizations can have more than one forecasting type enabled. The ForecastingQuota, ForecastingAdjustment, ForecastingOwnerAdjustment, ForecastingItem, and ForecastingFact objects can all have records with different ForecastingTypeId values. Use the ForecastingType object to determine the ID for each forecast type and then filter ForecastingQuota, ForecastingAdjustment, ForecastingItem, or ForecastingFact records as necessary.

Note