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

# NSListItemEntity

> The list item entity contains generic list item information.

The list item entity contains generic list item information.

## Constructors

### NSListItemEntity()

```crmscript theme={null}
NSListItemEntity
```

Initializes a new instance of the NSListItemEntity class.

## Methods

## GetDeleted()

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

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

**Example:**

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

## GetId()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The identity of the list item.

**Example:**

```crmscript theme={null}
NSListItemEntity thing;
Integer id = thing.GetId();
```

## GetName()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The name of the list item.

**Example:**

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

## GetRank()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The rank of the list item.

**Example:**

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

## GetTooltip()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The tooltip of the list item.

**Example:**

```crmscript theme={null}
NSListItemEntity 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 list item belongs to.

**Example:**

```crmscript theme={null}
NSListItemEntity 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}
NSListItemEntity thing;
Bool deleted;
thing.SetDeleted(deleted);
```

## SetId(Integer)

```crmscript theme={null}
Void SetId(Integer id)
```

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

**Example:**

```crmscript theme={null}
NSListItemEntity thing;
Integer id;
thing.SetId(id);
```

## SetName(String)

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

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

**Example:**

```crmscript theme={null}
NSListItemEntity 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}
NSListItemEntity 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}
NSListItemEntity 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}
NSListItemEntity thing;
Integer udListDefinitionId;
thing.SetUdListDefinitionId(udListDefinitionId);
```


## Related topics

- [NSListAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSListAgent.md)
- [Save List Item Entity](/en/api/reference/restful/agent/list_agent/save-list-item-entity.md)
- [Create Default List Item Entity](/en/api/reference/restful/agent/list_agent/create-default-list-item-entity.md)
- [Put Currency Entity Headings For List Item](/en/api/reference/restful/rest/list_currency/put-currency-entity-headings-for-list-item.md)
- [Get Currency Entity Headings For List Item](/en/api/reference/restful/rest/list_currency/get-currency-entity-headings-for-list-item.md)
- [Put Sale Stage Entity Headings For List Item](/en/api/reference/restful/rest/list_rating/put-sale-stage-entity-headings-for-list-item.md)