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

# NSCurrencyEntity

> Carrier object for CurrencyEntity.

Carrier object for CurrencyEntity.

## Constructors

### NSCurrencyEntity()

```crmscript theme={null}
NSCurrencyEntity
```

Initializes a new instance of the NSCurrencyEntity class.

## Methods

## GetCurrencyId()

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

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

**Example:**

```crmscript theme={null}
NSCurrencyEntity thing;
Integer currencyId = thing.GetCurrencyId();
```

## GetDeleted()

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

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - 0 -> record is active 1 -> record is 'deleted' and should not be shown in lists.

**Example:**

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

## GetName()

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

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

**Example:**

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

## GetRank()

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

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

**Example:**

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

## GetRate()

```crmscript theme={null}
Float GetRate()
```

**Returns:** [CRMScript.Global.Float](CRMScript.Global.Float) - Exchange rate.

**Example:**

```crmscript theme={null}
NSCurrencyEntity thing;
Float rate = thing.GetRate();
```

## GetTooltip()

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

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

**Example:**

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

## GetUnits()

```crmscript theme={null}
Float GetUnits()
```

**Returns:** [CRMScript.Global.Float](CRMScript.Global.Float) - Exchange unit scale (0.01, 0.1, 1, 10, 100 etc).

**Example:**

```crmscript theme={null}
NSCurrencyEntity thing;
Float units = thing.GetUnits();
```

## SetCurrencyId(Integer)

```crmscript theme={null}
Void SetCurrencyId(Integer currencyId)
```

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

**Example:**

```crmscript theme={null}
NSCurrencyEntity thing;
Integer currencyId;
thing.SetCurrencyId(currencyId);
```

## SetDeleted(Bool)

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

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

**Example:**

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

## SetName(String)

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

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

**Example:**

```crmscript theme={null}
NSCurrencyEntity 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}
NSCurrencyEntity thing;
Integer rank;
thing.SetRank(rank);
```

## SetRate(Float)

```crmscript theme={null}
Void SetRate(Float rate)
```

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

**Example:**

```crmscript theme={null}
NSCurrencyEntity thing;
Float rate;
thing.SetRate(rate);
```

## SetTooltip(String)

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

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

**Example:**

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

## SetUnits(Float)

```crmscript theme={null}
Void SetUnits(Float units)
```

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

**Example:**

```crmscript theme={null}
NSCurrencyEntity thing;
Float units;
thing.SetUnits(units);
```


## Related topics

- [Currency](/en/automation/crmscript/howto/sale/currency.md)
- [NSListAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSListAgent.md)
- [Namespace CRMScript.NetServer](/en/automation/crmscript/reference/CRMScript.NetServer.md)
- [Put Currency Entity](/en/api/reference/restful/rest/list_currency/put-currency-entity.md)
- [Get Currency Entity](/en/api/reference/restful/rest/list_currency/get-currency-entity.md)
- [Delete Currency Entity](/en/api/reference/restful/rest/list_currency/delete-currency-entity.md)