ForecastingFilterCondition

Represents the custom filter condition logic for including or excluding data from opportunity forecasts.

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

Version 

Introduced in API version 55.0.

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 

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The developer name of the forecast filter condition.

FieldName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The name of the opportunity field to be filtered.

ForecastingFilterId 

• Type: reference

• Required: No

• Properties: Filter, Group, Sort

• Description: The ID of the forecast filter.

This is a relationship field.

• Relationship name: ForecastingFilter
• Relationship type: relationship
• Refers to: ForecastingFilter

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Introduced: API version 55.0

• Description: The full name of the forecast filter condition.

Language 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Description: The language of the forecast filter condition.

• Possible values:

  • en_US — English

  • de — German

  • es — Spanish

  • fr — French

  • it — Italian

  • ja — Japanese

  • sv — Swedish

  • ko — Korean

  • zh_TW — Chinese (Traditional)

  • zh_CN — Chinese (Simplified)

  • pt_BR — Portuguese (Brazil)

  • nl_NL — Dutch

  • da — Danish

  • th — Thai

  • fi — Finnish

  • ru — Russian

  • es_MX — Spanish (Mexico)

  • no — Norwegian

MasterLabel 

• Type: string

• Required: No

• 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: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Introduced: API version 55.0

• Description: The metadata of the forecast filter condition.

Operation 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Description: The operator in the filter condition.

• Possible values:

  • equals — equals

  • notEqual — not equal to

  • lessThan — less than

  • greaterThan — greater than

  • lessOrEqual — less or equal — less than or equal to

  • greaterOrEqual — greater or equal — greater than or equal to

  • contains — contains

  • notContain — does not contain

  • startsWith — starts with

  • includes — includes

  • excludes — excludes

  • within — within

SortOrder 

• Type: int

• Required: No

• 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

• Required: No

• 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.