ForecastingType

Represents a forecast type.

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

Supported SOAP API Calls 

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

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Fields 

DateType 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Introduced: API version 42.0

• Description: Required. The date type that forecast amounts are based on.

• Possible values:

  • OpportunityCloseDate — 0

  • ProductDate — 1

  • ScheduleDate — 2

  • OLIMeasureCloseDateOnly — 3

  • ProductDateOnly — 4

  • ScheduleDateOnly — 5

  • OpportunityCustomDate — 6

  • OLIMeasureOppCustomDateOnly — 7

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: Required. The name of the forecast type.

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Introduced: API version 52.0

• Description: The full name of the forecast type.

HasProductFamily 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Group

• Introduced: API version 40.0

• Description: Required. Indicates whether the forecast type includes product families (true) or not (false). The default value is false.

• Default value: false

Language 

• Type: picklist

• Required: No

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

• Description: The language of the forecast type.

• 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: Required. Controlling label for this forecast type. This display value is the internal label that doesn’t get translated.

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Introduced: API version 52.0

• Description: The metadata of the forecast type.

OpportunitySplitTypeId 

• Type: reference

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 41.0

• Description: For a forecast type based on a split, the ID of the opportunity split type.

This field is a relationship field.

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

OpptyLineItemSplitTypeId 

• Type: reference

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 58.0

• Description: For a forecast type based on an opportunity product split, the ID of the opportunity line item split type.

This field is a relationship field.

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

RoleType 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Introduced: API version 41.0

• Description: Required. Indicates whether the role type has a ForecastingType, and if so, which ForecastingType.

• Possible values:

  • R — R — User role-based forecast type

  • T — T

  • Y — Y — Territory2-based forecast type

Territory2ModelId 

• Type: ID

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 41.0

• Description: For a territory-based forecast type, the ID of the Territory2 model.