Represents the stage of an Opportunity in the sales pipeline, such as New Lead, Negotiating, Pending, Closed, and so on.
| Field | Field Type | Field Properties | Description |
|---|---|---|---|
| DefaultProbability | percent | Filter | The default percentage estimate of the confidence in closing a specific opportunity for this opportunity stage value. Label is Probability (%). |
| Description | string | Filter | Description of this opportunity stage value. Limit: 255 characters. |
| ForecastCategory | picklist | Filter | The default forecast category for this opportunity stage value. The forecast category automatically determines how opportunities are tracked and totaled in a forecast. |
| ForecastCategoryName | picklist | Filter | Available in API version 12.0 and later. The default forecast category value for this opportunity stage value. |
| IsActive | boolean | Defaulted on create | 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 | Defaulted on create | 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. |
| IsWon | boolean | Defaulted on create | 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. |
| MasterLabel | string | Filter | Master label for this opportunity stage value. This display value is the internal label that does not get translated. Limit: 255 characters. |
| SortOrder | int | Filter | 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 a Opportunity, such as its probability or forecast category. 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.
This object is read-only via the API. With sufficient permissions, your client application can invoke the query() and describeSObjects() calls on these objects.