OpportunityStage

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

Supported API Calls

Fields

For a complete list of fields in this object, see the Enterprise WSDL file for your organization and the salesforce.com online help.

OpportunityStage Fields
Field	Data Type	Description
DefaultProbability	double	The default percentage estimate of the confidence in closing a specific opportunity for this opportunity stage value.
Description	string	Description of this opportunity stage value.
ForecastCategory	boolean	The default forecast category for this opportunity stage value. The forecast category automatically determines how opportunities are tracked and totaled in a forecast.
IsActive	boolean	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.
IsClosed	boolean	Indicates whether this opportunity stage value represents a closed opportunity (True) or not (False). Multiple opportunity stage values can represent a closed opportunity.
IsWon	boolean	Indicates whether this opportunity stage value represents a won opportunity (True) or not (False). Multiple opportunity stage values can represent a won opportunity.
MasterLabel	string	Master label for this opportunity stage value. This display value is the internal label that does not get translated.
SortOrder	int	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.

Usage

The OpportunityStage object represents a value in the opportunity stage picklist (see StageName Field). The opportunity stage picklist provides additional information about the stage of a Opportunity, such as its probability (see Probability Field) or forecast category (see ForecastCategory). Your client application can invoke the query call on the OpportunityStage object to retrieve the set of values in the opportunity stage picklist, and then use that information while processing Opportunity objects 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.

The OpportunityStage object is read-only via the sforce API. With sufficient permissions, your client application can invoke the query and describeSObject calls on OpportunityStage objects.