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

# NSDocument

> Carrier object for Document.

Carrier object for Document.

## Constructors

### NSDocument()

```crmscript theme={null}
NSDocument
```

Initializes a new instance of the NSDocument class.

## Methods

## GetAssociateFullName()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The associate's culture formatted fullname (firstname, middleName and lastname).

**Example:**

```crmscript theme={null}
NSDocument thing;
String associateFullName = thing.GetAssociateFullName();
```

## GetAssociateId()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - ID of associate whose diary the appointment is in, REQUIREd.

**Example:**

```crmscript theme={null}
NSDocument thing;
Integer associateId = thing.GetAssociateId();
```

## GetAttention()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Attention/salutation.

**Example:**

```crmscript theme={null}
NSDocument thing;
String attention = thing.GetAttention();
```

## GetContactId()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Contact ID of owning contact, may be 0

**Example:**

```crmscript theme={null}
NSDocument thing;
Integer contactId = thing.GetContactId();
```

## GetContactName()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Contact name.

**Example:**

```crmscript theme={null}
NSDocument thing;
String contactName = thing.GetContactName();
```

## GetDescription()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases.

**Example:**

```crmscript theme={null}
NSDocument thing;
String description = thing.GetDescription();
```

## GetDocumentId()

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

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

**Example:**

```crmscript theme={null}
NSDocument thing;
Integer documentId = thing.GetDocumentId();
```

## GetDocumentTemplate()

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

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

**Example:**

```crmscript theme={null}
NSDocument thing;
String documentTemplate = thing.GetDocumentTemplate();
```

## GetHeader()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Visible document name.

**Example:**

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

## GetIsPublished()

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

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - True if document have an entry in published table.

**Example:**

```crmscript theme={null}
NSDocument thing;
Bool isPublished = thing.GetIsPublished();
```

## GetName()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - File name.

**Example:**

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

## GetOurRef()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Our reference, searchable field from free-text search.

**Example:**

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

## GetPersonFullName()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The full name of the person this document belongs to.

**Example:**

```crmscript theme={null}
NSDocument thing;
String personFullName = thing.GetPersonFullName();
```

## GetPersonId()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Person ID of person the appointment is with, may be 0

**Example:**

```crmscript theme={null}
NSDocument thing;
Integer personId = thing.GetPersonId();
```

## GetProjectId()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - ID of project referred to, may be 0

**Example:**

```crmscript theme={null}
NSDocument thing;
Integer projectId = thing.GetProjectId();
```

## GetProjectName()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Project name.

**Example:**

```crmscript theme={null}
NSDocument thing;
String projectName = thing.GetProjectName();
```

## GetSnum()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The sequence number allocated from refcount on used template when creating the document.

**Example:**

```crmscript theme={null}
NSDocument thing;
Integer snum = thing.GetSnum();
```

## GetYourRef()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Your reference.

**Example:**

```crmscript theme={null}
NSDocument thing;
String yourRef = thing.GetYourRef();
```

## SetAssociateFullName(String)

```crmscript theme={null}
Void SetAssociateFullName(String associateFullName)
```

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

**Example:**

```crmscript theme={null}
NSDocument thing;
String associateFullName;
thing.SetAssociateFullName(associateFullName);
```

## SetAssociateId(Integer)

```crmscript theme={null}
Void SetAssociateId(Integer associateId)
```

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

**Example:**

```crmscript theme={null}
NSDocument thing;
Integer associateId;
thing.SetAssociateId(associateId);
```

## SetAttention(String)

```crmscript theme={null}
Void SetAttention(String attention)
```

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

**Example:**

```crmscript theme={null}
NSDocument thing;
String attention;
thing.SetAttention(attention);
```

## SetContactId(Integer)

```crmscript theme={null}
Void SetContactId(Integer contactId)
```

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

**Example:**

```crmscript theme={null}
NSDocument thing;
Integer contactId;
thing.SetContactId(contactId);
```

## SetContactName(String)

```crmscript theme={null}
Void SetContactName(String contactName)
```

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

**Example:**

```crmscript theme={null}
NSDocument thing;
String contactName;
thing.SetContactName(contactName);
```

## SetDescription(String)

```crmscript theme={null}
Void SetDescription(String description)
```

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

**Example:**

```crmscript theme={null}
NSDocument thing;
String description;
thing.SetDescription(description);
```

## SetDocumentId(Integer)

```crmscript theme={null}
Void SetDocumentId(Integer documentId)
```

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

**Example:**

```crmscript theme={null}
NSDocument thing;
Integer documentId;
thing.SetDocumentId(documentId);
```

## SetDocumentTemplate(String)

```crmscript theme={null}
Void SetDocumentTemplate(String documentTemplate)
```

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

**Example:**

```crmscript theme={null}
NSDocument thing;
String documentTemplate;
thing.SetDocumentTemplate(documentTemplate);
```

## SetHeader(String)

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

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

**Example:**

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

## SetIsPublished(Bool)

```crmscript theme={null}
Void SetIsPublished(Bool isPublished)
```

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

**Example:**

```crmscript theme={null}
NSDocument thing;
Bool isPublished;
thing.SetIsPublished(isPublished);
```

## SetName(String)

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

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

**Example:**

```crmscript theme={null}
NSDocument 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}
NSDocument thing;
String ourRef;
thing.SetOurRef(ourRef);
```

## SetPersonFullName(String)

```crmscript theme={null}
Void SetPersonFullName(String personFullName)
```

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

**Example:**

```crmscript theme={null}
NSDocument thing;
String personFullName;
thing.SetPersonFullName(personFullName);
```

## SetPersonId(Integer)

```crmscript theme={null}
Void SetPersonId(Integer personId)
```

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

**Example:**

```crmscript theme={null}
NSDocument thing;
Integer personId;
thing.SetPersonId(personId);
```

## SetProjectId(Integer)

```crmscript theme={null}
Void SetProjectId(Integer projectId)
```

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

**Example:**

```crmscript theme={null}
NSDocument thing;
Integer projectId;
thing.SetProjectId(projectId);
```

## SetProjectName(String)

```crmscript theme={null}
Void SetProjectName(String projectName)
```

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

**Example:**

```crmscript theme={null}
NSDocument thing;
String projectName;
thing.SetProjectName(projectName);
```

## SetSnum(Integer)

```crmscript theme={null}
Void SetSnum(Integer snum)
```

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

**Example:**

```crmscript theme={null}
NSDocument thing;
Integer snum;
thing.SetSnum(snum);
```

## SetYourRef(String)

```crmscript theme={null}
Void SetYourRef(String yourRef)
```

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

**Example:**

```crmscript theme={null}
NSDocument thing;
String yourRef;
thing.SetYourRef(yourRef);
```


## Related topics

- [NSDocumentAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSDocumentAgent.md)
- [Document templates](/en/automation/crmscript/howto/document/templates.md)
- [NSDocumentEntity](/en/automation/crmscript/reference/CRMScript.NetServer.NSDocumentEntity.md)
- [NSDocumentPreview](/en/automation/crmscript/reference/CRMScript.NetServer.NSDocumentPreview.md)
- [NSDocumentTemplate](/en/automation/crmscript/reference/CRMScript.NetServer.NSDocumentTemplate.md)