Salesforce Docs Portal

AccountProductPeriodForecast

Represents the quantity and revenue information of opportunities, sales agreements, orders, and resultant forecasted quantities for a product in a particular time period of the forecast rolling period. Other than the fields AdjustedForecastQuantity and AdjustedForecastRevenue, no other fields of this object can be updated. This object is available in API version 47.0 and later.

Supported Calls

describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update()

Fields

AccForecastPeriodMetricId

  • Type: reference
  • Properties: Filter, Group, Nillable, Sort
  • Description: ID of each account forecast period metric used in forecast formula calculations.

AccountProductForecastId

  • Type: reference
  • Properties: Filter, Group, Sort
  • Description: ID of a specific product for which forecast is calculated for this period.

AdjustedForecastedQuantity

  • Type: double
  • Properties: Filter, Nillable, Sort
  • Description: Forecasted quantity which is either auto-calculated or overwritten by a user with edit access. The user-defined value is retained along with the auto-calculated value.
    Note

    Note

    AdjustedForecastQuantity cannot be updated for past schedules.

AdjustedForecastedRevenue

  • Type: double
  • Properties: Filter, Nillable, Sort
  • Description: Forecasted revenue which is either auto-calculated or overwritten by a user with edit access. The user-defined value is retained along with the auto-calculated value.
Note

Note

AdjustedForecastRevenue cannot be updated for past schedules.

AdjustmentComments

  • Type: textarea
  • Properties: Nillable
  • Description: User-defined notes stating the reason for a manual adjustment.
    Note

    Note

    Adjusted comments can be updated along with either AdjustedForecastedQuantity or AdjustedForecastedRevenue.

CurrentOrdersQuantity

  • Type: double
  • Properties: Filter, Nillable, Sort
  • Description: Calculated quantity of all active orders for this account in the current period.

CurrentOrdersRevenue

  • Type: double
  • Properties: Filter, Nillable, Sort
  • Description: Calculated revenue of all active orders for this account in the current period.

ForecastedQuantity

  • Type: double
  • Properties: Filter, Nillable, Sort
  • Description: Auto-calculated quantity based on forecast formula and configurations.

ForecastedRevenue

  • Type: double
  • Properties: Filter, Nillable, Sort
  • Description: Auto-calculated revenue based on forecast formula and configurations.

IsActive

  • Type: boolean
  • Properties: Defaulted on create, Filter, Group, Sort
  • Description: Indicator of whether the record is part of the forecast display period or not.

LastCalculatedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: Date when the value was last calculated, either due to rolling over or through recalculation of forecast.

LastReferencedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The most recent date on which this record was referenced.

LastViewedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The most recent date on which this record was viewed.

Name

  • Type: string
  • Properties: Filter, Group, idLookup, Sort
  • Description: Name of the record.

OpportunityQuantity

  • Type: double
  • Properties: Filter, Nillable, Sort
  • Description: Calculated quantity of all active opportunities for this account in the current period.

OpportunityRevenue

  • Type: double
  • Properties: Filter, Nillable, Sort
  • Description: Calculated revenue of all active opportunities for this account in the current period.

PastOrdersQuantity

  • Type: double
  • Properties: Filter, Nillable, Sort
  • Description: Calculated quantity of all active orders for this account in the last forecast period.

PastOrdersRevenue

  • Type: double
  • Properties: Filter, Nillable, Sort
  • Description: Calculated revenue of all active orders for this account in the last forecast period.

PeriodId

  • Type: reference
  • Properties: Filter, Group, Sort
  • Description: ID of the period as derived from the Period entity based on the fiscal year.

SalesAgreementPlannedQuantity

  • Type: double
  • Properties: Filter, Nillable, Sort
  • Description: Calculated quantity for all active sales agreements for this account in the current period. This is calculated on a pro-rata basis if the sales agreement period does not coincide with the forecast display period.

SalesAgreementPlannedRevenue

  • Type: double
  • Properties: Filter, Nillable, Sort
  • Description: Calculated revenue for all active sales agreements for this account in the current period. This is calculated on a pro-rata basis if the sales agreement period does not coincide with the forecast display period.

StartDate

  • Type: date
  • Properties: Filter, Group, Nillable, Sort
  • Description: Date on which the period starts.