OpportunityStage

Represents the stage of an Opportunity in the sales pipeline, such as New Lead, Negotiating, Pending, Closed, and so on.

Introduced in API version 3.0.

describeSObjects(), query(), retrieve()

  • Type: string
  • Properties: Filter, Group, idLookup, Sort
  • Introduced: API version 36.0
  • Description: Uniquely identifies a picklist value so it can be retrieved without using an id or master label.
  • Type: percent
  • Properties: Filter, Nillable, Sort
  • Description: The default percentage estimate of the confidence in closing a specific opportunity for this opportunity stage value. Label is Probability (%).
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Description: Description of this opportunity stage value. Limit: 255 characters.
  • Type: picklist
  • Properties: Filter, Group, Restricted picklist, Sort
  • Description: The default forecast category for this opportunity stage value. The forecast category automatically determines how opportunities are tracked and totaled in a forecast.
  • Possible values:
    • BestCase — BestCase
    • Closed — Closed
    • Forecast — Forecast
    • MostLikely — MostLikely
    • Omitted — Omitted
    • Pipeline — Pipeline
  • Type: picklist
  • Properties: Filter, Group, Restricted picklist, Sort
  • Introduced: API version 12.0
  • Description: The default forecast category value for this opportunity stage value.
  • Possible values:
    • Best Case — Best Case
    • Closed — Closed
    • Commit — Commit
    • Most Likely — Most Likely
    • Omitted — Omitted
    • Pipeline — Pipeline
  • Type: boolean
  • Properties: Defaulted on create, Filter, Group, Sort
  • Description: Indicates whether this opportunity stage value is active (true) or not (false). Inactive opportunity stage values are not available in the picklist and are retained for historical purposes only.
  • Default value: false
  • Type: boolean
  • Properties: Defaulted on create, Filter, Group, Sort
  • Description: Indicates whether this opportunity stage value represents a closed opportunity (true) or not (false). Multiple opportunity stage values can represent a closed opportunity. Label is Closed.
  • Default value: false
  • Type: boolean
  • Properties: Defaulted on create, Filter, Group, Sort
  • Description: Indicates whether this opportunity stage value represents a won opportunity (true) or not (false). Multiple opportunity stage values can represent a won opportunity. Label is Won.
  • Default value: false
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Description: Master label for this opportunity stage value. This display value is the internal label that does not get translated. Limit: 255 characters.
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Description: Number used to sort this value in the opportunity stage picklist. These numbers are not guaranteed to be sequential, as some previous opportunity stage values might have been deleted.

This object represents a value in the opportunity stage picklist, which provides additional information about the stage of an Opportunity, such as its probability or forecast category. Query this object to retrieve the set of values in the opportunity stage picklist, and then use that information while processing Opportunity records to determine more information about a given opportunity. For example, the application could test whether a given opportunity is won or not based on its StageName value and the value of the IsWon property in the associated OpportunityStage object.

This object is read-only via the API.