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

# NSSuggestedDocumentEntity

## Constructors

### NSSuggestedDocumentEntity()

```crmscript theme={null}
NSSuggestedDocumentEntity
```

Initializes a new instance of the NSSuggestedDocumentEntity class.

## Methods

## 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}
NSSuggestedDocumentEntity thing;
Bool deleted = thing.GetDeleted();
```

## GetDocTmpl()

```crmscript theme={null}
NSDocumentTemplate GetDocTmpl()
```

**Returns:** [CRMScript.NetServer.NSDocumentTemplate](CRMScript.NetServer.NSDocumentTemplate) - Document template.

**Example:**

```crmscript theme={null}
NSSuggestedDocumentEntity thing;
NSDocumentTemplate docTmpl = thing.GetDocTmpl();
```

## GetDoctmplId()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Type of the suggested document.

**Example:**

```crmscript theme={null}
NSSuggestedDocumentEntity thing;
Integer doctmplId = thing.GetDoctmplId();
```

## GetHeader()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Suggested 'header'

**Example:**

```crmscript theme={null}
NSSuggestedDocumentEntity thing;
String header = thing.GetHeader();
```

## GetName()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Item name, visible in Guide.

**Example:**

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

## GetOurRef()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Suggested 'our reference'

**Example:**

```crmscript theme={null}
NSSuggestedDocumentEntity thing;
String ourRef = thing.GetOurRef();
```

## GetProjectTypeStatusLink()

```crmscript theme={null}
NSProjectTypeStatusLink GetProjectTypeStatusLink()
```

**Returns:** [CRMScript.NetServer.NSProjectTypeStatusLink](CRMScript.NetServer.NSProjectTypeStatusLink) - Project type and project status link info.

**Example:**

```crmscript theme={null}
NSSuggestedDocumentEntity thing;
NSProjectTypeStatusLink projectTypeStatusLink = thing.GetProjectTypeStatusLink();
```

## GetRank()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Rank, controls rank of non-instantiated items in Guide.

**Example:**

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

## GetSaleTypeStageLink()

```crmscript theme={null}
NSSaleTypeStageLink GetSaleTypeStageLink()
```

**Returns:** [CRMScript.NetServer.NSSaleTypeStageLink](CRMScript.NetServer.NSSaleTypeStageLink) - Sale type and stage link info.

**Example:**

```crmscript theme={null}
NSSuggestedDocumentEntity thing;
NSSaleTypeStageLink saleTypeStageLink = thing.GetSaleTypeStageLink();
```

## GetSuggestedDocumentId()

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

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

**Example:**

```crmscript theme={null}
NSSuggestedDocumentEntity thing;
Integer suggestedDocumentId = thing.GetSuggestedDocumentId();
```

## GetTooltip()

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

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

**Example:**

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

## SetDeleted(Bool)

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

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

**Example:**

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

## SetDocTmpl(NSDocumentTemplate)

```crmscript theme={null}
Void SetDocTmpl(NSDocumentTemplate docTmpl)
```

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

**Example:**

```crmscript theme={null}
NSSuggestedDocumentEntity thing;
NSDocumentTemplate docTmpl;
thing.SetDocTmpl(docTmpl);
```

## SetDoctmplId(Integer)

```crmscript theme={null}
Void SetDoctmplId(Integer doctmplId)
```

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

**Example:**

```crmscript theme={null}
NSSuggestedDocumentEntity thing;
Integer doctmplId;
thing.SetDoctmplId(doctmplId);
```

## SetHeader(String)

```crmscript theme={null}
Void SetHeader(String header)
```

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

**Example:**

```crmscript theme={null}
NSSuggestedDocumentEntity thing;
String header;
thing.SetHeader(header);
```

## SetName(String)

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

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

**Example:**

```crmscript theme={null}
NSSuggestedDocumentEntity thing;
String name;
thing.SetName(name);
```

## SetOurRef(String)

```crmscript theme={null}
Void SetOurRef(String ourRef)
```

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

**Example:**

```crmscript theme={null}
NSSuggestedDocumentEntity thing;
String ourRef;
thing.SetOurRef(ourRef);
```

## SetProjectTypeStatusLink(NSProjectTypeStatusLink)

```crmscript theme={null}
Void SetProjectTypeStatusLink(NSProjectTypeStatusLink projectTypeStatusLink)
```

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

**Example:**

```crmscript theme={null}
NSSuggestedDocumentEntity thing;
NSProjectTypeStatusLink projectTypeStatusLink;
thing.SetProjectTypeStatusLink(projectTypeStatusLink);
```

## SetRank(Integer)

```crmscript theme={null}
Void SetRank(Integer rank)
```

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

**Example:**

```crmscript theme={null}
NSSuggestedDocumentEntity thing;
Integer rank;
thing.SetRank(rank);
```

## SetSaleTypeStageLink(NSSaleTypeStageLink)

```crmscript theme={null}
Void SetSaleTypeStageLink(NSSaleTypeStageLink saleTypeStageLink)
```

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

**Example:**

```crmscript theme={null}
NSSuggestedDocumentEntity thing;
NSSaleTypeStageLink saleTypeStageLink;
thing.SetSaleTypeStageLink(saleTypeStageLink);
```

## SetSuggestedDocumentId(Integer)

```crmscript theme={null}
Void SetSuggestedDocumentId(Integer suggestedDocumentId)
```

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

**Example:**

```crmscript theme={null}
NSSuggestedDocumentEntity thing;
Integer suggestedDocumentId;
thing.SetSuggestedDocumentId(suggestedDocumentId);
```

## SetTooltip(String)

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

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

**Example:**

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


## Related topics

- [NSDocumentAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSDocumentAgent.md)
- [Save Suggested Document Entity](/en/api/reference/restful/agent/document_agent/save-suggested-document-entity.md)
- [Get Suggested Document Entity](/en/api/reference/restful/agent/document_agent/get-suggested-document-entity.md)
- [Create Default Suggested Document Entity](/en/api/reference/restful/agent/document_agent/create-default-suggested-document-entity.md)
- [SuperOffice.WebApi.Data.SuggestedDocumentEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.SuggestedDocumentEntity.md)
- [SuperOffice.WebApi.Agents.DocumentAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.DocumentAgent.md)