Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

ForecastingColumnDefinition

Represents a custom calculated column or a custom reference data column in a forecast type. This object is available in API version 56.0 and later.

For a custom calculated column, a Formula field value is required. For a custom reference data column, a ReferenceField field value is required.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Supported Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Fields

Field	Details
DeveloperName	Type string Properties Create, Filter, Group, Sort, Update Description The developer (API) name of the custom calculated column or custom reference data column.
ForecastingTypeId	Type reference Properties Create, Filter, Group, Sort Description The ID of the forecast type. This field is a relationship field. Relationship Name ForecastingType Relationship Type Lookup Refers To ForecastingType
Formula	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Required for custom calculated columns. The formula for the custom calculated column. Use API column names in your formula (such as ForecastAmount0), not column header names (such as Closed or Closed Only). For details on API column names, operators, and functions to use in formulas, see ForecastingColumnDefinition Formula Field Details. Example The following formula calculates the gap to quota: `ForecastingQuotaAmount - ForecastAmount0`
Language	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the custom calculated column or custom reference data column.
MasterLabel	Type string Properties Create, Filter, Group, Sort, Update Description The label for this object, which displays in Setup and in the column header on the forecasts page. The label is in the default language locale for the organization. If there’s no default language locale, the label is in en_US.
ReferenceField	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Required for custom reference data columns. The number or currency custom field from the ForecastingCustomData object. For example, `ForecastingCustomData.Realized_Revenue__c`. Data from this field appears in a column in the forecasts summary. This field is available in API version 58.0 and later.
ResultField	Type string Properties Create, Filter, Group, Sort, Update Description The field name to represent the custom calculated column or custom reference data column result. Possible values are: Custom Calculated Column Result CalculatedAmount0 or CalculatedQuantity0 CalculatedAmount1 or CalculatedQuantity1 CalculatedAmount2 or CalculatedQuantity2 CalculatedAmount3 or CalculatedQuantity3 CalculatedAmount4 or CalculatedQuantity4 If the formula’s result is null or invalid, “-” is the value. For example, if the formula divided by 0. If you want to show “-” for 0 or negative values in your forecast, use the IF function in your formula to detect 0 or negative numbers. Custom Reference Data Column Result Use the appropriate field based on whether your column output is of Currency or Number type. ExtensionCurrency0 or ExtensionNumber0 ExtensionCurrency1 or ExtensionNumber1 ExtensionCurrency2 or ExtensionNumber2 ExtensionCurrency3 or ExtensionNumber3 ExtensionCurrency4 or ExtensionNumber4

Usage

Each forecast type can include any combination of custom calculated columns and reference data columns, as long as they don’t exceed five in number. For example, a forecast type can have two custom calculated columns and three custom reference data columns.

Custom calculated columns can’t be adjusted and aren’t included in rollups. In the UI, custom calculated columns can’t indicate changes in the last 7 days.

If you have at least one custom calculated column in an active or inactive forecast type, you can’t do the following until you’ve removed the column.

Switch from single category to cumulative rollups in Forecast Settings
Enable the Most Likely category
Disable Show Quotas (only if your custom calculated column’s formula refers to a quota value)

Object Reference for the Salesforce Platform

ForecastingColumnDefinition

Supported Calls

Fields

Usage