> ## 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.

# NSHeadingEntity

> The heading entity contains generic list item information.

The heading entity contains generic list item information.

## Constructors

### NSHeadingEntity()

```crmscript theme={null}
NSHeadingEntity
```

Initializes a new instance of the NSHeadingEntity class.

## Methods

## GetDeleted()

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

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - True if the heading is marked as deleted.

**Example:**

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

## GetHeadingId()

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

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

**Example:**

```crmscript theme={null}
NSHeadingEntity thing;
Integer headingId = thing.GetHeadingId();
```

## GetName()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The visible heading.

**Example:**

```crmscript theme={null}
NSHeadingEntity thing;
String name = thing.GetName();
```

## GetRank()

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

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

**Example:**

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

## GetTooltip()

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

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

**Example:**

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

## GetUdListDefinitionId()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The ID of the list which this heading belongs to.

**Example:**

```crmscript theme={null}
NSHeadingEntity thing;
Integer udListDefinitionId = thing.GetUdListDefinitionId();
```

## SetDeleted(Bool)

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

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

**Example:**

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

## SetHeadingId(Integer)

```crmscript theme={null}
Void SetHeadingId(Integer headingId)
```

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

**Example:**

```crmscript theme={null}
NSHeadingEntity thing;
Integer headingId;
thing.SetHeadingId(headingId);
```

## SetName(String)

```crmscript theme={null}
Void SetName(String name)
```

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

**Example:**

```crmscript theme={null}
NSHeadingEntity thing;
String name;
thing.SetName(name);
```

## SetRank(Integer)

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

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

**Example:**

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

## SetTooltip(String)

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

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

**Example:**

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

## SetUdListDefinitionId(Integer)

```crmscript theme={null}
Void SetUdListDefinitionId(Integer udListDefinitionId)
```

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

**Example:**

```crmscript theme={null}
NSHeadingEntity thing;
Integer udListDefinitionId;
thing.SetUdListDefinitionId(udListDefinitionId);
```


## Related topics

- [NSListAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSListAgent.md)
- [Save Heading Entity](/en/api/reference/restful/agent/list_agent/save-heading-entity.md)
- [Get Heading Entity](/en/api/reference/restful/agent/list_agent/get-heading-entity.md)
- [Put Currency Entity Headings](/en/api/reference/restful/rest/list_currency/put-currency-entity-headings.md)
- [Post Currency Entity Heading](/en/api/reference/restful/rest/list_currency/post-currency-entity-heading.md)
- [Get Currency Entity Headings](/en/api/reference/restful/rest/list_currency/get-currency-entity-headings.md)