| AdjustedAmount |
- Type
- double
- Properties
- Create, Filter, Sort, Update
- Description
-
The revenue amount of an individual forecast item, after an adjustment.
|
| AdjustedQuantity |
- Type
- double
- Properties
- Create, Filter, Sort, Update
- Description
-
The quantity amount of an individual forecast item, after an adjustment. This field is available in API version 28 and
later.
|
| AdjustmentNote |
- Type
- textarea
- Properties
- Create, Filter, Group,
Nillable, Sort, Update
- Description
-
A text note providing information about the adjustment. The maximum length is 140
characters. This field does not appear in reports.
|
| CurrencyIsoCode |
- Type
- picklist
- Properties
- Create, Defaulted on create, Filter, Group,
Restricted picklist, Sort, Update
- Description
-
The currency code of the adjustment. If omitted, the default is the importing
user’s personal currency.
|
| ForecastCategoryName |
- Type
- picklist
- Properties
- Create, Filter, Group,
Nillable, Restricted picklist, Sort
- Description
-
The category within the sales cycle that an opportunity is assigned to based on its
opportunity stage. The standard forecast categories are Pipeline, Best Case, Commit,
Omitted, and Closed. You can customize forecast category names. The forecast categories
display information for that specific category; for example, Best Case only reflects
amounts in the Best Case category.
|
| ForecastingItemCategory |
- Type
- picklist
- Properties
- Create, Filter, Group,
Sort
- Description
- This field indicates which type of forecast rollup the manager adjustment belongs to.
Depending on whether your organization uses individual forecast category rollups or
cumulative forecast rollups, you have these possible values for the
ForecastingItemCategory field.
- Individual forecast category rollups:
-
- PipelineOnly - Rollup from Pipeline opportunities only.
- BestCaseOnly - Rollup from Best Case opportunities only. Adjustable.
- CommitOnly - Rollup from Commit opportunities only. Adjustable.
- Cumulative forecast rollups:
-
- OpenPipeline - Rollup from Pipeline + Best Case + Commit opportunities.
- BestCaseForecast - Rollup from Best Case + Commit + Closed opportunities.
Adjustable.
- CommitForecast - Rollup from Commit + Closed opportunities. Adjustable.
- Either cumulative or individual forecast category rollups:
-
- ClosedOnly - Rollup from Closed opportunities only.
The ForecastingItemCategory field differs from the
ForecastCategoryName field.
- The ForecastCategoryName field represents the forecast category
of the underlying opportunities rolling up to forecast amounts. In organizations
using cumulative forecast rollups, the ForecastCategoryName field
can be null because the cumulative forecast amounts include opportunities from multiple
forecast categories.
- The new ForecastingItemCategory field represents the type of
rollup a forecast amount or adjustment is from. In organizations using individual
forecast category columns, it contains the individual forecast rollup categories. In
organizations using cumulative forecast rollups, it contains the cumulative rollup
categories.
When inserting manager adjustments, the values you insert for
ForecastCategoryName and
ForecastingItemCategory must be compatible with each other. In
organizations using cumulative forecast rollups, the
ForecastCategoryName is nillable. The following pairs are
valid.
- Individual forecast category rollups:
-
-
ForecastCategoryName: BestCase,
ForecastingItemCategory: BestCaseOnly
-
ForecastCategoryName: Commit,
ForecastingItemCategory: CommitOnly
- Cumulative forecast category rollups:
-
-
ForecastCategoryName: null,
ForecastingItemCategory: BestCaseForecast
-
ForecastCategoryName: null,
ForecastingItemCategory: CommitForecast
|
| ForecastingTypeId |
- Type
- reference
- Properties
- Create, Filter, Group,
Sort
- Description
-
The ID of the related ForecastingType.
|
| ForecastingItemId |
- Type
- reference
- Properties
- Filter, Group,
Sort
- Description
-
The ID of the related ForecastingItem.
|
| IsAmount |
- Type
- boolean
- Properties
- Defaulted on create, Filter, Group, Sort
- Description
-
True indicates that the adjustment is made in a revenue amount. If false, then
IsQuantity must be true. This field is available in API version 28 and
later.
|
| IsQuantity |
- Type
- boolean
- Properties
- Defaulted on create, Filter, Group, Sort
- Description
-
True indicates that the adjustment is made in a quantity amount. If false, then
IsAmount must be true. This field is available in API version 28 and
later.
|
| OwnerId |
- Type
- reference
- Properties
- Create,Defaulted on create, Filter, Group,
Sort
- Description
-
The ID of the forecast owner.
|
| PeriodId |
- Type
- reference
- Properties
- Filter, Group,
Nillable, Sort
- Description
-
Period ID for the adjustment. Read only.
|
| ProductFamily |
- Type
- picklist
- Properties
- Create, Filter, Group,
Nillable, Sort
- Description
-
The Product Family for the adjustment. Read only. This field is available in API
version 29 and later.
|
| StartDate |
- Type
- date
- Properties
- Create, Filter, Group,
Sort
- Description
-
The start of the adjustment, expressed as month and year. The date can include any day
in a given month. Stored using the first date of the month.
|
| Territory2Id |
- Type
- reference
- Properties
- Create, Filter, Group,
Nillable, Sort
- Description
-
The ID of the territory to forecast on. Available in API version 43 and later.
|
j