ForecastingColumnDefinition | Object Reference for the Salesforce Platform

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 definition. Use this value to refer to this column in a formula of another custom calculated 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, Update Description 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 ForecastingPredictionAmount – Prediction (currency) ForecastingQuotaAmount – Quota (currency) ForecastingQuotaQuantity – Quota quantity (double) `DeveloperName` of any custom calculated 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 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.
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.
ResultField	Type string Properties Create, Filter, Group, Sort, Update Description The value of the result of the formula. 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.

Usage

Each forecast type can have up to five custom calculated 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 column’s formula refers to a quota value)