ForecastingFilterCondition

Represents the custom filter condition logic for including or excluding data from opportunity forecasts. This object is available in API version 55.0 and later.

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 SOAP API Calls

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

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules

As of Spring ’20 and later, only standard users with the View All Forecasts OR Allow Forecasting permission OR delegated forecast manager status can access this object.

Fields

Field Details
DeveloperName
Type
string
Properties
Filter, Group, Sort
Description
The developer name of the forecast filter condition.
FieldName
Type
string
Properties
Filter, Group, Sort
Description
The name of the opportunity field to be filtered.
ForecastingFilterId
Type
reference
Properties
Filter, Group, Sort
Description
The ID of the forecast filter.
This is a relationship field.
Relationship Name
ForecastingFilter
Relationship Type
Lookup
Refers To
ForecastingFilter
ForecastingSourceDefinitionId
Type
reference
Properties
Filter, Group, Sort
Description
The ID of the forecasting source definition.
This is a relationship field.
Relationship Name
ForecastingSourceDefinition
Relationship Type
Lookup
Refers To
ForecastingSourceDefinition
FullName
Type
string
Properties
Create, Group, Nillable
Description
The full name of the forecast filter condition.
Language
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
The language of the forecast filter condition.
MasterLabel
Type
string
Properties
Filter, Group, Sort
Description
The label for this object, which displays in Setup. The label is in the default language locale for the organization. If there’s no default language locale, the label is in en_US.
Metadata
Type
ForecastingFilterCondition
Properties
Create, Nillable, Update
Description
The metadata of the forecast filter condition.
Operation
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The operator in the filter condition.
Possible values are:
  • equals
  • greaterOrEqual—greater than or equal to
  • greaterThan
  • lessOrEqual—less than or equal to
  • lessThan
  • notEqual—not equal to
SortOrder
Type
int
Properties
Filter, Group, Sort
Description
The index value for the condition. This value represents the condition in the FilterLogic field on the ForecastingFilter object. For example, 1.
Value
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The value of the filter condition. If multiple values are specified, they must be separated by a comma delimiter.

If you have multiple currencies enabled, and add a custom filter on a currency field as part of your forecast type definition, the corporate currency at the time the filter was created is used. If you have a single currency enabled, the absolute value is used in your filter condition.

Note

Usage

A forecast type can contain up to three filter conditions.