Newer Version Available

This content describes an older version of this product. View Latest

ForecastingCustomCategory

Represents a custom forecasting category used for forecast rollups. This object is available in API version 62.0 and later.

In API version 62.0, this object is available for rollup of Manager Judgments only.

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 Calls

describeSObjects(), query(), retrieve()

Fields

Field Details
CanHaveQuotas
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether forecasts in the custom category can have quotas. The default value is false. Available in API version 63.0 and later.
Description
Type
textarea
Properties
Filter, Group, Nillable, Sort
Description
A user-defined description of the custom category.
DeveloperName
Type
string
Properties
Filter, Group, Sort
Description
The developer name of the custom category.
DisplayPosition
Type
int
Properties
Filter, Group, Nillable, Sort
Description
Indicates the placement of the custom category column among the other columns on the forecasts page.
ForecastingSourceDefinitionId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the forecasting source definition.
This field is a relationship field.
Relationship Name
ForecastingSourceDefinition
Refers To
ForecastingSourceDefinition
ForecastingTypeId
Type
reference
Properties
Filter, Group, Sort
Description
The ID of the related ForecastingType.
This field is a relationship field.
Relationship Name
ForecastingType
Refers To
ForecastingType
IsAdjustable
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether forecast managers can adjust forecasts in the custom category. The default value is false.
IsAmount
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
If true, then the adjustment is made in a revenue amount. If false, then IsQuantity must be true. The default value is false. Available in API version 63.0 and later.
IsHidden
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the custom category is hidden. The default value is false. Available in API version 63.0 and later.
IsOwnerAdjustable
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether all forecast users can adjust their own forecasts in the custom category, including the territory forecasts that they own. The default value is false.
IsQuantity
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description

If true, then the adjustment is made in a quantity amount. If false, then IsAmount must be true. The default value is false. Available in API version 63.0 and later.

Language
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The language of the custom category.
MasterLabel
Type
string
Properties
Filter, Group, Sort
Description
The label for this column. The label is in the default language locale for the organization. If there’s no default language locale, the label is in en_US.
MeasureFieldOverride
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The measure that this custom category supports.
Possible values are:
  • Opportunity.Amount
  • Opportunity.AmountCustom__c
  • Opportunity.AmountRSF__c
  • Opportunity.TotalOpportunityQuantity
  • OpportunityLineItem.Quantity
  • OpportunityLineItem.TotalPrice
  • OpportunityLineItem.oliCustomAmount__c
  • OpportunityLineItemSplit.SplitAmount
  • OpportunitySplit.SplitAmount
  • OpportunitySplit.customAmount__c
UnitOfMeasure
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The unit of measure for the specified custom category measure. Available in API version 63.0 and later.