OpportunityHistory

Represents the stage history of an opportunity.

describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Estimated total sale amount.
  • Type: date
  • Properties: Filter, Group, Nillable, Sort
  • Description: Date when the opportunity is expected to close.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Calculated revenue based on the Amount and Probability fields.
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Description: Category that determines the column in which an opportunity is totaled in a forecast. Label is To ForecastCategory.
  • Possible values:
    • BestCase — BestCase
    • Closed — Closed
    • Forecast — Forecast
    • MostLikely — MostLikely
    • Omitted — Omitted
    • Pipeline — Pipeline

  • Type: reference

  • Properties: Filter, Group, Sort

  • Description:

    ID of the associated Opportunity.

    This is a relationship field.

  • Relationship name: Opportunity

  • Relationship type: relationship

  • Refers to: Opportunity

  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 50.0
  • Description: The value in the opportunity’s Amount field before the update of the opportunity. In OpportunityHistory records created before Winter ’21, the value is null.Available in API version 50.0 and later.
  • Type: date
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 50.0
  • Description: The value in the opportunity’s Close Date field before the update of the opportunity. In OpportunityHistory records created before Winter ’21, the value is null.Available in API version 50.0 and later.
  • Type: percent
  • Properties: Filter, Nillable, Sort
  • Description: Percentage of estimated confidence in closing the opportunity.
  • Type: picklist
  • Properties: Filter, Group, Sort
  • Description: Name of the current stage of the opportunity (for example, Prospect or Proposal).

This object represents the history of a change to the Amount, Probability, Stage, or Close Date fields of an Opportunity. The OpportunityFieldHistory object represents the history of a change to any of the fields of an Opportunity. To obtain information about how a particular opportunity is progressing, query the OpportunityHistory records associated with a given Opportunity. Please note that if an opportunity’s Amount, Probability, Stage, or Close Date fields have not changed, nothing will be returned in the OpportunityHistory objects. In this case, query the OpportunityFieldHistory records associated with a given Opportunity to get more information about changes to the opportunity.

This object is read-only. The system generates a new record whenever a user or client application changes the value of any of the above fields; the then-current values of all of these major fields are saved in the newly-generated object.

This object respects field-level security on the parent object.

The record is automatically deleted if its parent Opportunity is deleted.