> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# NSSaleStageEntity

> This entity represents a sale stage with a default percentage rating.

This entity represents a sale stage with a default percentage rating.

## Constructors

### NSSaleStageEntity()

```crmscript theme={null}
NSSaleStageEntity
```

Initializes a new instance of the NSSaleStageEntity class.

## Methods

## GetDeleted()

```crmscript theme={null}
Bool GetDeleted()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - If true, the Sale stage is deleted.

**Example:**

```crmscript theme={null}
NSSaleStageEntity thing;
Bool deleted = thing.GetDeleted();
```

## GetProbability()

```crmscript theme={null}
Integer GetProbability()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The numeric probability of the sale.

**Example:**

```crmscript theme={null}
NSSaleStageEntity thing;
Integer probability = thing.GetProbability();
```

## GetRank()

```crmscript theme={null}
Integer GetRank()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Rank order.

**Example:**

```crmscript theme={null}
NSSaleStageEntity thing;
Integer rank = thing.GetRank();
```

## GetSaleStageId()

```crmscript theme={null}
Integer GetSaleStageId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Primary key.

**Example:**

```crmscript theme={null}
NSSaleStageEntity thing;
Integer saleStageId = thing.GetSaleStageId();
```

## GetTooltip()

```crmscript theme={null}
String GetTooltip()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Tooltip or other description.

**Example:**

```crmscript theme={null}
NSSaleStageEntity thing;
String tooltip = thing.GetTooltip();
```

## GetValue()

```crmscript theme={null}
String GetValue()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The sale stage.

**Example:**

```crmscript theme={null}
NSSaleStageEntity thing;
String value = thing.GetValue();
```

## SetDeleted(Bool)

```crmscript theme={null}
Void SetDeleted(Bool deleted)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleStageEntity thing;
Bool deleted;
thing.SetDeleted(deleted);
```

## SetProbability(Integer)

```crmscript theme={null}
Void SetProbability(Integer probability)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleStageEntity thing;
Integer probability;
thing.SetProbability(probability);
```

## SetRank(Integer)

```crmscript theme={null}
Void SetRank(Integer rank)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleStageEntity thing;
Integer rank;
thing.SetRank(rank);
```

## SetSaleStageId(Integer)

```crmscript theme={null}
Void SetSaleStageId(Integer saleStageId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleStageEntity thing;
Integer saleStageId;
thing.SetSaleStageId(saleStageId);
```

## SetTooltip(String)

```crmscript theme={null}
Void SetTooltip(String tooltip)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleStageEntity thing;
String tooltip;
thing.SetTooltip(tooltip);
```

## SetValue(String)

```crmscript theme={null}
Void SetValue(String value)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleStageEntity thing;
String value;
thing.SetValue(value);
```


## Related topics

- [NSListAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSListAgent.md)
- [Put Sale Stage Entity](/en/api/reference/restful/rest/list_rating/put-sale-stage-entity.md)
- [Get Sale Stage Entity](/en/api/reference/restful/rest/list_rating/get-sale-stage-entity.md)
- [Post Sale Stage Entity](/en/api/reference/restful/rest/list_rating/post-sale-stage-entity.md)
- [Delete Sale Stage Entity](/en/api/reference/restful/rest/list_rating/delete-sale-stage-entity.md)
- [Save Sale Stage Entity](/en/api/reference/restful/agent/list_agent/save-sale-stage-entity.md)