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, QuantityWithoutManagerAdjustments, ForecastQuantity, OwnerOnlyQuantity. 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. Available in API versions 26 and greater.

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 all of a person’s owned revenue opportunities and also his or her subordinates’ opportunities, without adjustments. Subordinates include everyone reporting up to a person in the forecast hierarchy.

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 his or her 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.

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, Restricted picklist, Sort
Description

A forecast category is the category within the sales cycle that an opportunity is assigned to based on its opportunity stage. The standard forecast categories are Pipeline, Best Case, Commit, Omitted, and Closed. You can customize forecast category names for your organization. The forecast categories display information for that specific category; for example, Best Case only reflects amounts in the Best Case category.

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.

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 an adjustment has been made based on the point of view of the viewer.

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 all of a person’s revenue opportunities, without adjustments.

OwnerOnlyQuantity
Type
double
Properties
Filter, Sort, Nillable
Description

The sum of all 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.

QuantityWithoutManagerAdjustments
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 his or her 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.

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, 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