ForecastingFilter

Represents the custom filter 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 permission 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.

FilterLogic 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The logic that controls the evaluation of conditions. Only AND is supported. For example, 1 AND 2 AND 3.

ForecastingTypeId 

• Type: reference

• Required: No

• Properties: Filter, Group, Sort

• Description: The ID of the forecast type. Can be linked only to forecast types created in Summer ’21 and later.

This is a relationship field.

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

ForecastingTypeSourceId 

• Type: reference

• Required: No

• Properties: Filter, Group, Sort

• Description: The ID of the forecast type source. Can be linked only to forecast type sources created in Summer ’21 or later and with a forecast source definition with source object of ‘Opportunity’.

This is a relationship field.

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

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Introduced: API version 55.0

• Description: The full name of the forecast filter.

Language 

• Type: picklist

• Required: No

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

• Description: The language of the forecast filter.

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