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

# NSRefCountEntity

> A refcount entity for a number allocation.

A refcount entity for a number allocation.

## Constructors

### NSRefCountEntity()

```crmscript theme={null}
NSRefCountEntity
```

Initializes a new instance of the NSRefCountEntity class.

## Methods

## GetAllocate()

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

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Allocate numbers automatically.

**Example:**

```crmscript theme={null}
NSRefCountEntity thing;
Bool allocate = thing.GetAllocate();
```

## GetAllowBlank()

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

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Allow blank  as a valid value.

**Example:**

```crmscript theme={null}
NSRefCountEntity thing;
Bool allowBlank = thing.GetAllowBlank();
```

## GetCurrentValue()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Current value of counter.

**Example:**

```crmscript theme={null}
NSRefCountEntity thing;
Integer currentValue = thing.GetCurrentValue();
```

## GetField()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Field identifier in string format table.field.

**Example:**

```crmscript theme={null}
NSRefCountEntity thing;
String field = thing.GetField();
```

## GetReadOnly()

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

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Target field is read only in GUi.

**Example:**

```crmscript theme={null}
NSRefCountEntity thing;
Bool readOnly = thing.GetReadOnly();
```

## GetRecordId()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Record ID in target table, used when there are separate counters for each target record.

**Example:**

```crmscript theme={null}
NSRefCountEntity thing;
Integer recordId = thing.GetRecordId();
```

## GetRefCountsId()

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

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

**Example:**

```crmscript theme={null}
NSRefCountEntity thing;
Integer refCountsId = thing.GetRefCountsId();
```

## GetSatPrefix()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - size of prefix for Satellite use of this counter.

**Example:**

```crmscript theme={null}
NSRefCountEntity thing;
Integer satPrefix = thing.GetSatPrefix();
```

## GetSuggestedRecords()

```crmscript theme={null}
NSMDOListItem[] GetSuggestedRecords()
```

**Returns:** [CRMScript.NetServer.NSMDOListItem](CRMScript.NetServer.NSMDOListItem)\[] - List of valid entities, the associated record is selected in the list, used records are filtered out.

**Example:**

```crmscript theme={null}
NSRefCountEntity thing;
NSMDOListItem[] suggestedRecords = thing.GetSuggestedRecords();
```

## GetTravelPrefix()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - size of prefix for Travel use of ths counter.

**Example:**

```crmscript theme={null}
NSRefCountEntity thing;
Integer travelPrefix = thing.GetTravelPrefix();
```

## GetUnique()

Checks that entered value is unique

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

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

**Example:**

```crmscript theme={null}
NSRefCountEntity thing;
Bool unique = thing.GetUnique();
```

## SetAllocate(Bool)

```crmscript theme={null}
Void SetAllocate(Bool allocate)
```

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

**Example:**

```crmscript theme={null}
NSRefCountEntity thing;
Bool allocate;
thing.SetAllocate(allocate);
```

## SetAllowBlank(Bool)

```crmscript theme={null}
Void SetAllowBlank(Bool allowBlank)
```

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

**Example:**

```crmscript theme={null}
NSRefCountEntity thing;
Bool allowBlank;
thing.SetAllowBlank(allowBlank);
```

## SetCurrentValue(Integer)

```crmscript theme={null}
Void SetCurrentValue(Integer currentValue)
```

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

**Example:**

```crmscript theme={null}
NSRefCountEntity thing;
Integer currentValue;
thing.SetCurrentValue(currentValue);
```

## SetField(String)

```crmscript theme={null}
Void SetField(String field)
```

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

**Example:**

```crmscript theme={null}
NSRefCountEntity thing;
String field;
thing.SetField(field);
```

## SetReadOnly(Bool)

```crmscript theme={null}
Void SetReadOnly(Bool readOnly)
```

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

**Example:**

```crmscript theme={null}
NSRefCountEntity thing;
Bool readOnly;
thing.SetReadOnly(readOnly);
```

## SetRecordId(Integer)

```crmscript theme={null}
Void SetRecordId(Integer recordId)
```

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

**Example:**

```crmscript theme={null}
NSRefCountEntity thing;
Integer recordId;
thing.SetRecordId(recordId);
```

## SetRefCountsId(Integer)

```crmscript theme={null}
Void SetRefCountsId(Integer refCountsId)
```

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

**Example:**

```crmscript theme={null}
NSRefCountEntity thing;
Integer refCountsId;
thing.SetRefCountsId(refCountsId);
```

## SetSatPrefix(Integer)

```crmscript theme={null}
Void SetSatPrefix(Integer satPrefix)
```

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

**Example:**

```crmscript theme={null}
NSRefCountEntity thing;
Integer satPrefix;
thing.SetSatPrefix(satPrefix);
```

## SetSuggestedRecords(NSMDOListItem\[])

```crmscript theme={null}
Void SetSuggestedRecords(NSMDOListItem[] suggestedRecords)
```

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

**Example:**

```crmscript theme={null}
NSRefCountEntity thing;
NSMDOListItem[] suggestedRecords;
thing.SetSuggestedRecords(suggestedRecords);
```

## SetTravelPrefix(Integer)

```crmscript theme={null}
Void SetTravelPrefix(Integer travelPrefix)
```

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

**Example:**

```crmscript theme={null}
NSRefCountEntity thing;
Integer travelPrefix;
thing.SetTravelPrefix(travelPrefix);
```

## SetUnique(Bool)

Checks that entered value is unique

```crmscript theme={null}
Void SetUnique(Bool unique)
```

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

**Example:**

```crmscript theme={null}
NSRefCountEntity thing;
Bool unique;
thing.SetUnique(unique);
```


## Related topics

- [NSNumberAllocationAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSNumberAllocationAgent.md)
- [Delete Ref Count Entity](/en/api/reference/restful/agent/numberallocation_agent/delete-ref-count-entity.md)
- [Save Ref Count Entity](/en/api/reference/restful/agent/numberallocation_agent/save-ref-count-entity.md)
- [Get Ref Count Entity](/en/api/reference/restful/agent/numberallocation_agent/get-ref-count-entity.md)
- [Create Default Ref Count Entity](/en/api/reference/restful/agent/numberallocation_agent/create-default-ref-count-entity.md)
- [SuperOffice.WebApi.Data.RefCountEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.RefCountEntity.md)