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

# <a id="SuperOffice_WebApi_Data_SuggestedDocumentEntity" /> Class SuggestedDocumentEntity

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

Carrier object for SuggestedDocumentEntity.

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

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[SuggestedDocumentEntity](SuperOffice.WebApi.Data.SuggestedDocumentEntity.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 SuggestedDocumentEntity 123 using the WebApi client:
<pre><code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new DocumentAgent(configuration);
var suggestedDocumentEntity = agent.GetSuggestedDocumentEntity( 123 );</code></pre>

## Constructors

### <a id="SuperOffice_WebApi_Data_SuggestedDocumentEntity__ctor" /> SuggestedDocumentEntity()

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_SuggestedDocumentEntity_Deleted" /> Deleted

0 -> record is active 1 -> record is 'deleted' and should not be shown in lists

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_SuggestedDocumentEntity_DocTmpl" /> DocTmpl

Document template

```csharp theme={null}
public virtual DocumentTemplate DocTmpl { get; set; }
```

#### Property Value

[DocumentTemplate](SuperOffice.WebApi.Data.DocumentTemplate.md)

### <a id="SuperOffice_WebApi_Data_SuggestedDocumentEntity_DoctmplId" /> DoctmplId

Type of the suggested document

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_SuggestedDocumentEntity_Header" /> Header

Suggested 'header'

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_SuggestedDocumentEntity_Name" /> Name

Item name, visible in Guide

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_SuggestedDocumentEntity_OurRef" /> OurRef

Suggested 'our reference'

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_SuggestedDocumentEntity_ProjectTypeStatusLink" /> ProjectTypeStatusLink

Project type and project status link info

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

#### Property Value

[ProjectTypeStatusLink](SuperOffice.WebApi.Data.ProjectTypeStatusLink.md)

### <a id="SuperOffice_WebApi_Data_SuggestedDocumentEntity_Rank" /> Rank

Rank, controls rank of non-instantiated items in Guide

```csharp theme={null}
public virtual short Rank { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_SuggestedDocumentEntity_SaleTypeStageLink" /> SaleTypeStageLink

Sale type and stage link info.

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

#### Property Value

[SaleTypeStageLink](SuperOffice.WebApi.Data.SaleTypeStageLink.md)

### <a id="SuperOffice_WebApi_Data_SuggestedDocumentEntity_SuggestedDocumentId" /> SuggestedDocumentId

Primary key

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_SuggestedDocumentEntity_Tooltip" /> Tooltip

Tooltip / description

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

#### Property Value

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

## See Also

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


## Related topics

- [SuperOffice.WebApi.Agents.DocumentAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.DocumentAgent.md)
- [SuperOffice.WebApi.Agents.IDocumentAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IDocumentAgent.md)
- [SuperOffice.WebApi.Data.DocumentEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.DocumentEntity.md)
- [SuperOffice.WebApi.Data.AppointmentEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.AppointmentEntity.md)
- [SuperOffice.WebApi.Data.SuggestedAppointmentEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.SuggestedAppointmentEntity.md)
- [SuperOffice.WebApi.Data.Carrier](/en/api/reference/webapi/SuperOffice.WebApi.Data.Carrier.md)