Newer Version Available

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

AccountForecastSettings

Represents settings that define the generation of account forecasts and their display on the account’s record page. These settings also define the periods during which the account forecast values can be edited and the formula definitions for account forecast calculations. Available in API version 47.0 and later.

Supported SOAP Calls

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

Supported REST HTTP Methods

GET, POST, PATCH, PUT

Fields

Field Details
AcctPrdctPrdFrcstVolCnt
Type
int
Properties
Filter, Group, Nillable, Sort
Description
Number of existing records in the AccountProductPeriodForecast object. Available in API version 49.0 and later.
CalculationFrequency
Type
picklist
Properties
Defaulted on Create, Filter, Group, Restricted picklist, Sort
Description
Source from which frequency of account forecast recalculation is derived. Valid values are:
  • Monthly (default)
  • Quarterly
DeveloperName
Type
string
Properties
Filter, Group, Sort
Description
The developer name for AccountForecastSettings.
DisplayDuration
Type
int
Properties
Filter, Group, Sort
Description
The number of periods for which the forecast is generated and displayed.
DisplayedForecastMetrics
Type
textarea
Properties
Filter, Sort
Description
The quantity metrics that are selected for display in the account forecast in a specified sequence. There can be a maximum of 10 comma-separated metric names in this list.
DisplayedRevenueMetrics
Type
textarea
Properties
Filter, Sort
Description
The revenue metrics that are selected for display in the account forecast in a specified sequence. There can be a maximum of 10 comma-separated metric names in this list.
EditsAllowedFor
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of days either during the start or the end of a period when an account forecast’s values can be edited.
ForecastFrequency
Type
picklist
Properties
Defaulted on Create, Filter, Group, Restricted picklist, Sort
Description
Source from which frequency of account forecast generation is derived. You can select a start period from when to consider data for account forecast generation and the number of periods for which forecast is generated. Valid values are:
  • Monthly (default)
  • Quarterly
FullName
Type
string
Properties
Create, Group, Nillable
Description
The unique name used for these account forecast settings. The FullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.
Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
HasOpportunityItemSchedule
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether to use the probability of opportunity schedules associated with accounts to calculate forecast values (true) or not to use the probability of opportunities associated with accounts to calculate forecast (false). The default value is false. Available in API version 50.0 and later.
HasOpportunityProbability
Type
boolean
Properties
Create, Filter, Group, Sort
Description
Indicates whether to use the probability of opportunities associated with accounts to calculate forecast values (true) or not use the probability of opportunities associated with accounts to calculate forecast (false). The default is false. Available in API version 50.0 and later.
IsEditableAtStartOfPeriod
Type
boolean
Properties
Defaulted on Create, Filter, Group, Sort
Description
Indicates whether the account forecast can be adjusted at the start of the adjustment period (true) or cannot be adjusted at the start of the adjustment period (false). The default is false.
Language
Type
picklist
Properties
Defaulted on Create, Filter, Group, Nillable, Restricted picklist, Sort
Description
The language of the account forecast settings.
MasterLabel
Type
string
Properties
Filter, Group, Sort
Description
Master label for AccountForecastSettings. This internal label doesn’t get translated.
Metadata
Type
complexvalue
Properties
Create, Nillable, Update
Description
The corresponding metadata value.
PrimaryNotifEmailAddress
Type
email
Properties
Filter, Group, Nillable, Sort
Description
The email address to which notifications are sent.
RecalculateAllFrcstCnt
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of times account forecasts are recalculated for all the eligible accounts in an org. Available in API version 49.0 and later.
RegenerateForecastCnt
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of times account forecasts are regenerated for all the eligible accounts in an org. Available in API version 49.0 and later.
SalesAgreementFilterId
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Specifies the list view having a filtered list of sales agreements. Only the sales agreements in the entered list view are eligible for account forecasting. Available in API version 50.0 and later.
SecondaryNotifEmailAddress
Type
email
Properties
Filter, Group, Nillable, Sort
Description
The second email address to which notifications are sent.
StartingPeriod
Type
int
Properties
Filter, Group, Sort
Description
The number of periods to go back from the current date for account forecast generation.