ForecastingSourceDefinition

Represents the object, measure, date type, and hierarchy that a forecast uses to project sales. This object is available in API version 52.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()

Supported REST API Methods

DELETE, GET, HEAD, POST, Query

Fields

Field	Details
CategoryField	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Name of the forecast category that is associated with the forecast type. Possible values are: `Opportunity.ForecastCategoryName`
DateField	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Field that is used for the forecast type’s date type. For example, the CloseDate field on Opportunity is used for opportunity close date–based forecast types. Possible values are: `Opportunity.CloseDate` `OpportunityLineItem.ServiceDate`
DeveloperName	Type string Properties Filter, Group, Sort Description Required. The name of the forecasting source definition.
FamilyField	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Use this field to group forecasts by product family. Possible values are: `Product2.Family`
FullName	Type string Properties Create, Group, Nillable Description The full name of the forecasting source definition.
Language	Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The language of the forecasting source definition.
MasterLabel	Type string Properties Filter, Group, Sort Description Required. Controlling label for this forecasting source definition.
MeasureField	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Field that is used for the forecast type’s measure. For example, the Amount field on Opportunity is associated with revenue-based forecast types. Possible values are: `Opportunity.Amount` `Opportunity.Custom` `Opportunity.TotalOpportunityQuantity` `OpportunityLineItem.Custom` `OpportunityLineItem.Quantity` `OpportunityLineItem.TotalPrice` Where `Custom` represents the name of the custom field that a forecast type’s measure is based on. Example: Use the `Megawatts__c` custom field to forecast energy consumption.
Metadata	Type ForecastingSourceDefinition Properties Create, Nillable, Update Description The metadata of the forecasting source definition.
SourceObject	Type picklist Properties Filter, Group, Restricted picklist, Sort Description Required. Object associated with this forecasting source definition. Possible values are: `Opportunity` `OpportunityLineItem` `Product2`
Territory2Field	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description For a territory-based forecast type, indicates the field that is used for territory information. For user role–based forecast types, this value is `null`.
UserField	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies who owns the forecast. Possible values are: `Opportunity.OwnerId`

Tooling API

ForecastingSourceDefinition

Supported SOAP API Calls

Supported REST API Methods

Fields