Newer Version Available

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

ForecastingAdjustment

This object represents an individual user’s adjustment for a subordinate’s forecast via a ForecastingItem. Available in API versions 26 and greater.

This information only applies to Collaborative Forecasts.

Note

Supported Calls

create()delete()describeSObjects()getDeleted()getUpdated()query(), retrieve()update()upsert()

Fields

Field Name Details
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, 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.

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.

Usage

Use this object to obtain a user’s adjustment detail for a specified ForecastingItem. The ForecastingAdjustment object itself is visible to all users, but only forecast managers and users above them in the forecast hierarchy can read or write ForecastingAdjustment records.

Beginning with API version 30.0, organizations can have more than one forecasting type enabled. The ForecastingQuota, ForecastingAdjustment, ForecastingItem, and ForecastingFact objects can all have records with different ForecastingTypeId values. Use the ForecastingType object to determine the ID for each forecast type and then filter ForecastingQuota, ForecastingAdjustment, ForecastingItem, or ForecastingFact records as necessary.

Note