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

# SuperOffice.WebApi.Data.RefCountEntity

# <a id="SuperOffice_WebApi_Data_RefCountEntity" /> Class RefCountEntity

Namespace: [SuperOffice.WebApi.Data](SuperOffice.WebApi.Data.md)\
Assembly: SuperOffice.WebApi.dll

Carrier object for RefCountEntity.
A refcount entity for a number allocation

```csharp theme={null}
public class RefCountEntity : Carrier
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[RefCountEntity](SuperOffice.WebApi.Data.RefCountEntity.md)

#### Inherited Members

[Carrier.TableRight](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_TableRight),
[Carrier.FieldProperties](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_FieldProperties),
[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Examples

Get RefCountEntity 123 using the WebApi client:
<pre><code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new NumberAllocationAgent(configuration);
var refCountEntity = agent.GetRefCountEntity( 123 );</code></pre>

## Constructors

### <a id="SuperOffice_WebApi_Data_RefCountEntity__ctor" /> RefCountEntity()

Default constructor - defaults any enum props to 0.

```csharp theme={null}
public RefCountEntity()
```

## Properties

### <a id="SuperOffice_WebApi_Data_RefCountEntity_Allocate" /> Allocate

Allocate numbers automatically

```csharp theme={null}
public virtual bool Allocate { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_RefCountEntity_AllowBlank" /> AllowBlank

Allow blank  as a valid value

```csharp theme={null}
public virtual bool AllowBlank { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_RefCountEntity_CurrentValue" /> CurrentValue

Current value of counter

```csharp theme={null}
public virtual int CurrentValue { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_RefCountEntity_Field" /> Field

Field identifier in string format table.field

```csharp theme={null}
public virtual string Field { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_RefCountEntity_ReadOnly" /> ReadOnly

Target field is read only in GUI

```csharp theme={null}
public virtual bool ReadOnly { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_RefCountEntity_RecordId" /> RecordId

Record id in target table, used when there are separate counters for each target record

```csharp theme={null}
public virtual int RecordId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_RefCountEntity_RefCountsId" /> RefCountsId

Primary key

```csharp theme={null}
public virtual int RefCountsId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_RefCountEntity_SatPrefix" /> SatPrefix

size of prefix for Satellite use of this counter

```csharp theme={null}
public virtual uint SatPrefix { get; set; }
```

#### Property Value

[uint](https://learn.microsoft.com/dotnet/api/system.uint32)

### <a id="SuperOffice_WebApi_Data_RefCountEntity_SuggestedRecords" /> SuggestedRecords

List of valid entities, the associated record is selected in the list, used records are filtered out

```csharp theme={null}
public virtual MDOListItem[] SuggestedRecords { get; set; }
```

#### Property Value

[MDOListItem](SuperOffice.WebApi.Data.MDOListItem.md)\[]

### <a id="SuperOffice_WebApi_Data_RefCountEntity_TravelPrefix" /> TravelPrefix

size of prefix for Travel use of ths counter

```csharp theme={null}
public virtual uint TravelPrefix { get; set; }
```

#### Property Value

[uint](https://learn.microsoft.com/dotnet/api/system.uint32)

### <a id="SuperOffice_WebApi_Data_RefCountEntity_Unique" /> Unique

Check that entered value is unique

```csharp theme={null}
public virtual bool Unique { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

## See Also

[NumberAllocationAgent](SuperOffice.WebApi.Agents.NumberAllocationAgent.md)


## Related topics

- [SuperOffice.WebApi.Agents.INumberAllocationAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.INumberAllocationAgent.md)
- [SuperOffice.WebApi.Agents.NumberAllocationAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.NumberAllocationAgent.md)
- [SuperOffice.WebApi.Data.NumberAllocation SaveDefaultNumberingRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.NumberAllocation_SaveDefaultNumberingRequest.md)
- [SuperOffice.WebApi.Data.EntityCounts](/en/api/reference/webapi/SuperOffice.WebApi.Data.EntityCounts.md)
- [SuperOffice.WebApi.Data.Diagnostics GetEntityCountsForAllUsersRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Diagnostics_GetEntityCountsForAllUsersRequest.md)
- [SuperOffice.WebApi.Data.Diagnostics GetEntityCountsForCurrentUserRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Diagnostics_GetEntityCountsForCurrentUserRequest.md)