> ## 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.CategoryEntity # Class CategoryEntity Namespace: [SuperOffice.WebApi.Data](SuperOffice.WebApi.Data.md)\ Assembly: SuperOffice.WebApi.dll Carrier object for CategoryEntity. ```csharp theme={null} public class CategoryEntity : Carrier ``` #### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [Carrier](SuperOffice.WebApi.Data.Carrier.md) ← [CategoryEntity](SuperOffice.WebApi.Data.CategoryEntity.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 CategoryEntity 123 using the WebApi client:

var configuration = new WebApiConfiguration(url);
var agent = new ListAgent(configuration);
var categoryEntity = agent.GetCategoryEntity( 123 );

## Constructors ### CategoryEntity() Default constructor - defaults any enum props to 0. ```csharp theme={null} public CategoryEntity() ``` ## Properties ### CategoryFamilyId Optional link to family, for grouping things like multiple kinds of customer category under family 'customer' ```csharp theme={null} public virtual int CategoryFamilyId { get; set; } ``` #### Property Value [int](https://learn.microsoft.com/dotnet/api/system.int32) ### CategoryGroup Enum of the group this category belongs to, static list of 5 groups NULL if unknown enum value. ```csharp theme={null} [JsonIgnore] public CategoryGroup? CategoryGroup { get; set; } ``` #### Property Value [CategoryGroup](SuperOffice.WebApi.Data.CategoryGroup.md)? #### See Also [CategoryEntity](SuperOffice.WebApi.Data.CategoryEntity.md).[CategoryGroup\_String](SuperOffice.WebApi.Data.CategoryEntity.md#SuperOffice_WebApi_Data_CategoryEntity_CategoryGroup_String) ### CategoryGroup\_String Enum of the group this category belongs to, static list of 5 groups Raw string enum value. ```csharp theme={null} [JsonProperty("CategoryGroup")] public string CategoryGroup_String { get; set; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.string) #### See Also [CategoryEntity](SuperOffice.WebApi.Data.CategoryEntity.md).[CategoryGroup](SuperOffice.WebApi.Data.CategoryEntity.md#SuperOffice_WebApi_Data_CategoryEntity_CategoryGroup) ### CategoryId Primary key ```csharp theme={null} public virtual int CategoryId { get; set; } ``` #### Property Value [int](https://learn.microsoft.com/dotnet/api/system.int32) ### Deleted true if the category is deleted ```csharp theme={null} public virtual bool Deleted { get; set; } ``` #### Property Value [bool](https://learn.microsoft.com/dotnet/api/system.boolean) ### EnableLeadStatus True if the category should enable lead status ```csharp theme={null} public virtual bool EnableLeadStatus { get; set; } ``` #### Property Value [bool](https://learn.microsoft.com/dotnet/api/system.boolean) ### Name Name of the category ```csharp theme={null} public virtual string Name { get; set; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.string) ### Rank Rank of the category ```csharp theme={null} public virtual short Rank { get; set; } ``` #### Property Value [short](https://learn.microsoft.com/dotnet/api/system.int16) ###