ForecastingTypeSource

Represents the mapping of a forecasting source definition to 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()

Supported REST API Methods 

DELETE, GET, HEAD, POST, Query

Fields 

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The developer name of the forecasting source definition.

ForecastingSourceDefinitionId 

• Type: reference

• Required: No

• Properties: Filter, Group, Sort

• Description: The ID of the forecasting source definition.

This is a relationship field.

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

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

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Introduced: API version 52.0

• Description: The full name of the forecasting type source.

Language 

• Type: picklist

• Required: No

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

• Description: The language of the forecasting type source.

• 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. The controlling label for this forecasting type source.

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Introduced: API version 52.0

• Description: The metadata of the forecasting source definition.

ParentSourceDefinitionId 

• Type: reference

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 51.0

• Description: For forecast types not based on the Opportunity object and not based on a custom measure, this value represents the ID of the parent ForecastingSourceDefinition of the linked ForecastingSourceDefinition.

This is a relationship field.

• Relationship name: ParentSourceDefinition
• Relationship type: relationship
• Refers to: ForecastingSourceDefinition

RelationField 

• Type: picklist

• Required: No

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

• Introduced: API version 51.0

• Description: Represents the field that links the source objects of the parent ForecastingSourceDefinition to the child ForecastingSourceDefinition.

SourceGroup 

• Type: int

• Required: No

• Properties: Filter, Group, Sort

• Description: Required. Represents a grouping of forecast type source definitions.