ForecastingColumnDefinition | Object Reference for the Salesforce Platform

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, Sort, Nillable, 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). API Column Names - General ForecastingQuotaAmount – Quota (currency) ForecastingQuotaQuantity – Quota quantity (double) `DeveloperName` of any custom calculated column or custom reference data column shown in the forecasts page API Column Names for Single Category Rollups If you have single category rollups selected in Forecasts Settings, use the following column names in your formula. ForecastAmount0 or ForecastQuantity0 – Closed ForecastAmount1 or ForecastQuantity1 – Commit ForecastAmount2 or ForecastQuantity2 – Best Case ForecastAmount3 or ForecastQuantity3 – Pipeline API Column Names for Cumulative Category Rollups If you have cumulative category rollups selected in Forecasts Settings, use the following column names in your formula. ForecastAmount0 or ForecastQuantity0 – Closed Only ForecastAmount1 or ForecastQuantity1 – Commit Forecast ForecastAmount2 or ForecastQuantity2 – Most Likely Forecast ForecastAmount3 or ForecastQuantity3 – Best Case Forecast ForecastAmount4 or ForecastQuantity4 – Open Pipeline API Column Names for Custom Reference Data Use the appropriate field based on whether the custom reference data is of Currency or Number type. ExtensionCurrency0 ExtensionCurrency1 ExtensionCurrency2 ExtensionCurrency3 ExtensionCurrency4 ExtensionNumber0 ExtensionNumber1 ExtensionNumber2 ExtensionNumber3 ExtensionNumber4 Supported Math Operators + (Add) – Calculates the sum of two values. - (Subtract) – Calculates the difference of two values. * (Multiply) – Multiplies its values. / (Divide) – Divides its values. () (Open Parenthesis and Closed Parenthesis) – Specifies that the expressions within the open parenthesis and close parenthesis are evaluated first. All other expressions are evaluated using standard operator precedence. Supported Logical Operators = and == (Equal) – Evaluates if two values are equivalent. The = and == operators are interchangeable. <> and != (Not Equal) – Evaluates if two values aren’t equivalent. < (Less Than) – Evaluates if a value is less than the value that follows this symbol. > (Greater Than) – Evaluates if a value is greater than the value that follows this symbol. <= (Less Than or Equal) – Evaluates if a value is less than or equal to the value that follows this symbol. >= (Greater Than or Equal) – Evaluates if a value is greater than or equal to the value that follows this symbol. Supported Functions IF – Determines if expressions are true or false. Returns a given value if true and another value if false. NULL can be used as a constant. For example, `IF((expression) < 0, NULL, (expression)).` Example The following formula calculates 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)