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

# NSPersonEntity

> The Person Service. The service implements all services working with the Person object.

The Person Service. The service implements all services working with the Person object.

## Constructors

### NSPersonEntity()

```crmscript theme={null}
NSPersonEntity
```

Initializes a new instance of the NSPersonEntity class.

## Methods

## GetActiveErpLinks()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - How many active ERP links are there for this person?

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Integer activeErpLinks = thing.GetActiveErpLinks();
```

## GetActiveInterests()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The number of active interests.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Integer activeInterests = thing.GetActiveInterests();
```

## GetAddress()

Retrieves a formatted addressRetrieves the structure holding formatted address data.

```crmscript theme={null}
NSAddress GetAddress()
```

**Returns:** [CRMScript.NetServer.NSAddress](CRMScript.NetServer.NSAddress)

<Note>
  The layout of the array structure indicates the layout of the localized address.
</Note>

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSAddress address = thing.GetAddress();
```

## GetAssociate()

```crmscript theme={null}
NSAssociate GetAssociate()
```

**Returns:** [CRMScript.NetServer.NSAssociate](CRMScript.NetServer.NSAssociate) - The associate owning this person (similar to contact.Associate).

<Note>
  Usually blank. Use the Person.Contact.Associate instead. Intended for use when individual persons are created (i.e. when Person.Contact is blank)
</Note>

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSAssociate associate = thing.GetAssociate();
```

## GetBirthDate()

```crmscript theme={null}
DateTime GetBirthDate()
```

**Returns:** [CRMScript.Global.DateTime](CRMScript.Global.DateTime) - The Person birth date as Date.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
DateTime birthDate = thing.GetBirthDate();
```

## GetBounceEmails()

```crmscript theme={null}
String[] GetBounceEmails()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String)\[] - Email addresses with a positive bounce counter.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String[] bounceEmails = thing.GetBounceEmails();
```

## GetBusiness()

```crmscript theme={null}
NSBusiness GetBusiness()
```

**Returns:** [CRMScript.NetServer.NSBusiness](CRMScript.NetServer.NSBusiness) - Person's business.

<Note>
  Usually blank. Use Contact.NSBusiness instead. Intended for use when individual persons are created. (i.e. when Person.Contact is blank)
</Note>

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSBusiness business = thing.GetBusiness();
```

## GetCategory()

```crmscript theme={null}
NSCategory GetCategory()
```

**Returns:** [CRMScript.NetServer.NSCategory](CRMScript.NetServer.NSCategory) - Person's category.

<Note>
  Usually null. Refer to the Contact.NSCategory instead.  Intended for use when individual persons are created. (i.e. when Person.Contact is blank)
</Note>

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSCategory category = thing.GetCategory();
```

## GetChatEmails()

```crmscript theme={null}
NSEntityElement[] GetChatEmails()
```

**Returns:** [CRMScript.NetServer.NSEntityElement](CRMScript.NetServer.NSEntityElement)\[]

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSEntityElement[] chatEmails = thing.GetChatEmails();
```

## GetConsents()

```crmscript theme={null}
NSConsentInfo[] GetConsents()
```

**Returns:** [CRMScript.NetServer.NSConsentInfo](CRMScript.NetServer.NSConsentInfo)\[] - The person's available consent information.

<Note>
  Missing consents are not deleted. To remove a consent, mark its legalbase as 'WITHDRAWN'
</Note>

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSConsentInfo[] consents = thing.GetConsents();
```

## GetContact()

```crmscript theme={null}
NSContact GetContact()
```

**Returns:** [CRMScript.NetServer.NSContact](CRMScript.NetServer.NSContact) - The contact the contact person is registered on.

<Note>
  This is required unless the 'MandatoryContactOnPerson' preference is set.
</Note>

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSContact contact = thing.GetContact();
```

## GetCorrespondingAssociate()

```crmscript theme={null}
NSAssociate GetCorrespondingAssociate()
```

**Returns:** [CRMScript.NetServer.NSAssociate](CRMScript.NetServer.NSAssociate) - The associate corresponding to this person. Will be empty if the person is not a user (internal associate user, external user).

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSAssociate correspondingAssociate = thing.GetCorrespondingAssociate();
```

## GetCountry()

```crmscript theme={null}
NSCountry GetCountry()
```

**Returns:** [CRMScript.NetServer.NSCountry](CRMScript.NetServer.NSCountry) - The country this contact person is located in.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSCountry country = thing.GetCountry();
```

## GetCreatedBy()

```crmscript theme={null}
NSAssociate GetCreatedBy()
```

**Returns:** [CRMScript.NetServer.NSAssociate](CRMScript.NetServer.NSAssociate) - The user that created the person object.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSAssociate createdBy = thing.GetCreatedBy();
```

## GetCreatedDate()

```crmscript theme={null}
DateTime GetCreatedDate()
```

**Returns:** [CRMScript.Global.DateTime](CRMScript.Global.DateTime) - Registered date.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
DateTime createdDate = thing.GetCreatedDate();
```

## GetCustomerLanguage()

```crmscript theme={null}
NSCustomerLanguage GetCustomerLanguage()
```

**Returns:** [CRMScript.NetServer.NSCustomerLanguage](CRMScript.NetServer.NSCustomerLanguage)

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSCustomerLanguage customerLanguage = thing.GetCustomerLanguage();
```

## GetCustomFields()

Gets the user-defined + extra fields on an NSPersonEntity as a map.

```crmscript theme={null}
Map GetCustomFields()
```

**Returns:** [CRMScript.Native.Map](CRMScript.Native.Map)

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Map fields = thing.GetCustomFields();
String oldValue = fields.get("SuperOffice:1");
fields.insert("SuperOffice:1", "NewValue");
for (fields.first(); !fields.eof(); fields.next())
  printLine(fields.getKey() + ":  " + fields.getVal());
```

## GetDbiAgentId()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Integration agent (eJournal).

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Integer dbiAgentId = thing.GetDbiAgentId();
```

## GetDbiKey()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The primary key for the integrated entry in the external data source.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String dbiKey = thing.GetDbiKey();
```

## GetDbiLastModified()

```crmscript theme={null}
DateTime GetDbiLastModified()
```

**Returns:** [CRMScript.Global.DateTime](CRMScript.Global.DateTime) - When the entry was last modified.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
DateTime dbiLastModified = thing.GetDbiLastModified();
```

## GetDbiLastSyncronized()

```crmscript theme={null}
DateTime GetDbiLastSyncronized()
```

**Returns:** [CRMScript.Global.DateTime](CRMScript.Global.DateTime) - Last external synchronization.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
DateTime dbiLastSyncronized = thing.GetDbiLastSyncronized();
```

## 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}
NSPersonEntity thing;
String description = thing.GetDescription();
```

## GetEmails()

```crmscript theme={null}
NSEntityElement[] GetEmails()
```

**Returns:** [CRMScript.NetServer.NSEntityElement](CRMScript.NetServer.NSEntityElement)\[] - A collection of the person's emails.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSEntityElement[] emails = thing.GetEmails();
```

## GetExtraFields()

Gets the extra fields on NSPersonEntity as a map.

```crmscript theme={null}
Map GetExtraFields()
```

**Returns:** [CRMScript.Native.Map](CRMScript.Native.Map)

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Map fields = thing.GetExtraFields();
String oldValue = fields.get("x_foobar");
fields.insert("x_foobar", "NewValue");
for (fields.first(); !fields.eof(); fields.next())
  printLine(fields.getKey() + ":  " + fields.getVal());
```

## GetFaxes()

Returns a collection of fax numbers that belong to the contact person.

```crmscript theme={null}
NSEntityElement[] GetFaxes()
```

**Returns:** [CRMScript.NetServer.NSEntityElement](CRMScript.NetServer.NSEntityElement)\[]

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSEntityElement[] faxes = thing.GetFaxes();
```

## GetFirstname()

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

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String firstname = thing.GetFirstname();
```

## GetFormalName()

Gets formal name for a person, as used in labels. (Full name + person title + academic title)

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

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String formalName = thing.GetFormalName();
```

## GetFullName()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The person's full name localized to the current culture/country. (internal name used in clients for employees).

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String fullName = thing.GetFullName();
```

## GetInterests()

```crmscript theme={null}
NSSelectableMDOListItem[] GetInterests()
```

**Returns:** [CRMScript.NetServer.NSSelectableMDOListItem](CRMScript.NetServer.NSSelectableMDOListItem)\[] - The person's available and selected interests.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSSelectableMDOListItem[] interests = thing.GetInterests();
```

## GetInternetPhones()

```crmscript theme={null}
NSEntityElement[] GetInternetPhones()
```

**Returns:** [CRMScript.NetServer.NSEntityElement](CRMScript.NetServer.NSEntityElement)\[]

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSEntityElement[] internetPhones = thing.GetInternetPhones();
```

## GetIsAssociate()

Checks if the person object is an associate. The property is read-only.

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

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Bool isAssociate = thing.GetIsAssociate();
```

## GetKanafname()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Kana first name, used in Japanese versions only.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String kanafname = thing.GetKanafname();
```

## GetKanalname()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Kana last name, used in Japanese versions only.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String kanalname = thing.GetKanalname();
```

## GetLastname()

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

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String lastname = thing.GetLastname();
```

## GetMiddleName()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Middle name or 'van' etc.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String middleName = thing.GetMiddleName();
```

## GetMobilePhones()

Returns a collection of mobile phone numbers that belong to the contact person.

```crmscript theme={null}
NSEntityElement[] GetMobilePhones()
```

**Returns:** [CRMScript.NetServer.NSEntityElement](CRMScript.NetServer.NSEntityElement)\[]

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSEntityElement[] mobilePhones = thing.GetMobilePhones();
```

## GetMrmrs()

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

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String mrmrs = thing.GetMrmrs();
```

## GetNoMailing()

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

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Spam filter. Indicates if this person should retrieve advertising.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Bool noMailing = thing.GetNoMailing();
```

## GetOfficePhones()

Returns a collection of office phone numbers that belong to the contact person.

```crmscript theme={null}
NSEntityElement[] GetOfficePhones()
```

**Returns:** [CRMScript.NetServer.NSEntityElement](CRMScript.NetServer.NSEntityElement)\[]

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSEntityElement[] officePhones = thing.GetOfficePhones();
```

## GetOtherPhones()

Returns a collection of pagers that belong to the contact person.

```crmscript theme={null}
NSEntityElement[] GetOtherPhones()
```

**Returns:** [CRMScript.NetServer.NSEntityElement](CRMScript.NetServer.NSEntityElement)\[]

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSEntityElement[] otherPhones = thing.GetOtherPhones();
```

## GetPagers()

```crmscript theme={null}
NSEntityElement[] GetPagers()
```

**Returns:** [CRMScript.NetServer.NSEntityElement](CRMScript.NetServer.NSEntityElement)\[]

## GetPersonId()

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

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

**Example:**

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

## GetPersonNumber()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Alphanumeric user field.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String personNumber = thing.GetPersonNumber();
```

## GetPosition()

```crmscript theme={null}
NSPosition GetPosition()
```

**Returns:** [CRMScript.NetServer.NSPosition](CRMScript.NetServer.NSPosition) - The position. This is a predefined SuperOffice value, different from Title.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSPosition position = thing.GetPosition();
```

## GetPost1()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Postal address, used in Japanese versions only.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String post1 = thing.GetPost1();
```

## GetPost2()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Postal address, used in Japanese versions only.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String post2 = thing.GetPost2();
```

## GetPost3()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Postal address, used in Japanese versions only.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String post3 = thing.GetPost3();
```

## GetPrivatePhones()

Returns a collection of phone numbers that belong to the contact person.

```crmscript theme={null}
NSEntityElement[] GetPrivatePhones()
```

**Returns:** [CRMScript.NetServer.NSEntityElement](CRMScript.NetServer.NSEntityElement)\[]

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSEntityElement[] privatePhones = thing.GetPrivatePhones();
```

## GetRetired()

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

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - True if the user is retired and should have no rights, not appear in lists, etc.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Bool retired = thing.GetRetired();
```

## GetSalutation()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Academic title, populated from Salutation list but can be overwritten with anything at all.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String salutation = thing.GetSalutation();
```

## GetSentInfo()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Has information on username/password been sent (Service).

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Integer sentInfo = thing.GetSentInfo();
```

## GetShipmentTypes()

The person's available and selected shipment types.

```crmscript theme={null}
NSSelectableMDOListItem[] GetShipmentTypes()
```

**Returns:** [CRMScript.NetServer.NSSelectableMDOListItem](CRMScript.NetServer.NSSelectableMDOListItem)\[]

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSSelectableMDOListItem[] shipmentTypes = thing.GetShipmentTypes();
```

## GetShowContactTickets()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Should tickets related to the company be shown to this person.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Integer showContactTickets = thing.GetShowContactTickets();
```

## GetSource()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - How did we get this person? For future integration needs.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Integer source = thing.GetSource();
```

## GetSupportAssociate()

```crmscript theme={null}
NSAssociate GetSupportAssociate()
```

**Returns:** [CRMScript.NetServer.NSAssociate](CRMScript.NetServer.NSAssociate)

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSAssociate supportAssociate = thing.GetSupportAssociate();
```

## GetTicketPriority()

```crmscript theme={null}
NSTicketPriority GetTicketPriority()
```

**Returns:** [CRMScript.NetServer.NSTicketPriority](CRMScript.NetServer.NSTicketPriority)

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSTicketPriority ticketPriority = thing.GetTicketPriority();
```

## GetTitle()

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

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String title = thing.GetTitle();
```

## GetUpdatedBy()

```crmscript theme={null}
NSAssociate GetUpdatedBy()
```

**Returns:** [CRMScript.NetServer.NSAssociate](CRMScript.NetServer.NSAssociate) - The person that last updated the person object.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSAssociate updatedBy = thing.GetUpdatedBy();
```

## GetUpdatedDate()

```crmscript theme={null}
DateTime GetUpdatedDate()
```

**Returns:** [CRMScript.Global.DateTime](CRMScript.Global.DateTime) - Last updated date.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
DateTime updatedDate = thing.GetUpdatedDate();
```

## GetUrls()

```crmscript theme={null}
NSEntityElement[] GetUrls()
```

**Returns:** [CRMScript.NetServer.NSEntityElement](CRMScript.NetServer.NSEntityElement)\[] - The URLs related to this person.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSEntityElement[] urls = thing.GetUrls();
```

## GetUsePersonAddress()

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

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - True if the person's address should be used as mailing address, instead of the contact's address.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Bool usePersonAddress = thing.GetUsePersonAddress();
```

## GetUserDefinedFields()

Gets the user-defined fields on the NSPersonEntity as a map.

```crmscript theme={null}
Map GetUserDefinedFields()
```

**Returns:** [CRMScript.Native.Map](CRMScript.Native.Map)

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Map fields = thing.GetUserDefinedFields();
String oldValue = fields.get("SuperOffice:1");
fields.insert("SuperOffice:1", "NewValue");
for (fields.first(); !fields.eof(); fields.next())
  printLine(fields.getKey() + ":  " + fields.getVal());
```

## GetUserInfo()

```crmscript theme={null}
NSUserInfo GetUserInfo()
```

**Returns:** [CRMScript.NetServer.NSUserInfo](CRMScript.NetServer.NSUserInfo) - Information about the user if this person is a user.  If IsAssociate (e.g. is user is true) the NSUserInfo will be provided.

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSUserInfo userInfo = thing.GetUserInfo();
```

## SetActiveErpLinks(Integer)

```crmscript theme={null}
Void SetActiveErpLinks(Integer activeErpLinks)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Integer activeErpLinks;
thing.SetActiveErpLinks(activeErpLinks);
```

## SetActiveInterests(Integer)

```crmscript theme={null}
Void SetActiveInterests(Integer activeInterests)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Integer activeInterests;
thing.SetActiveInterests(activeInterests);
```

## SetAddress(NSAddress)

Sets a formatted addressSets the structure holding formatted address data.

```crmscript theme={null}
Void SetAddress(NSAddress address)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSAddress address;
thing.SetAddress(address);
```

## SetAssociate(NSAssociate)

```crmscript theme={null}
Void SetAssociate(NSAssociate associate)
```

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

<Note>
  Usually blank. Use the Person.Contact.Associate instead. Intended for use when individual persons are created (i.e. when Person.Contact is blank)
</Note>

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSAssociate associate;
thing.SetAssociate(associate);
```

## SetBirthDate(DateTime)

```crmscript theme={null}
Void SetBirthDate(DateTime birthDate)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
DateTime birthDate;
thing.SetBirthDate(birthDate);
```

## SetBounceEmails(String\[])

```crmscript theme={null}
Void SetBounceEmails(String[] bounceEmails)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String[] bounceEmails;
thing.SetBounceEmails(bounceEmails);
```

## SetBusiness(NSBusiness)

```crmscript theme={null}
Void SetBusiness(NSBusiness business)
```

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

<Note>
  Usually blank. Use Contact.NSBusiness instead. Intended for use when individual persons are created. (i.e. when Person.Contact is blank)
</Note>

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSBusiness business;
thing.SetBusiness(business);
```

## SetCategory(NSCategory)

```crmscript theme={null}
Void SetCategory(NSCategory category)
```

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

<Note>
  Usually null. Refer to the Contact.NSCategory instead.  Intended for use when individual persons are created. (i.e. when Person.Contact is blank)
</Note>

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSCategory category;
thing.SetCategory(category);
```

## SetChatEmails(NSEntityElement\[])

```crmscript theme={null}
Void SetChatEmails(NSEntityElement[] chatEmails)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSEntityElement[] chatEmails;
thing.SetChatEmails(chatEmails);
```

## SetConsents(NSConsentInfo\[])

```crmscript theme={null}
Void SetConsents(NSConsentInfo[] consents)
```

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

<Note>
  Missing consents are not deleted. To remove a consent, mark its legalbase as 'WITHDRAWN'
</Note>

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSConsentInfo[] consents;
thing.SetConsents(consents);
```

## SetContact(NSContact)

```crmscript theme={null}
Void SetContact(NSContact contact)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSContact contact;
thing.SetContact(contact);
```

## SetCorrespondingAssociate(NSAssociate)

```crmscript theme={null}
Void SetCorrespondingAssociate(NSAssociate correspondingAssociate)
```

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

<Note>
  Will be empty if the person is not a user (internal associate user, external user).
</Note>

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSAssociate correspondingAssociate;
thing.SetCorrespondingAssociate(correspondingAssociate);
```

## SetCountry(NSCountry)

```crmscript theme={null}
Void SetCountry(NSCountry country)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSCountry country;
thing.SetCountry(country);
```

## SetCreatedBy(NSAssociate)

```crmscript theme={null}
Void SetCreatedBy(NSAssociate createdBy)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSAssociate createdBy;
thing.SetCreatedBy(createdBy);
```

## SetCreatedDate(DateTime)

```crmscript theme={null}
Void SetCreatedDate(DateTime createdDate)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
DateTime createdDate;
thing.SetCreatedDate(createdDate);
```

## SetCustomerLanguage(NSCustomerLanguage)

```crmscript theme={null}
Void SetCustomerLanguage(NSCustomerLanguage customerLanguage)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSCustomerLanguage customerLanguage;
thing.SetCustomerLanguage(customerLanguage);
```

## SetCustomFields(Map)

Sets the user-defined and extra fields on an NSPersonEntity with a map.

```crmscript theme={null}
Void SetCustomFields(Map udefs)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Map udefs;
udefs["SuperOffice:1"] = "[I:123]";
udefs["SuperOffice:1"] = "123"; // this will also work, but beware of decimal point variations in different languages
udefs["custom.progid"] = "foobar";
udefs["x_foo"] = "foobar";
udefs["x_bar"] = "456"; // List item id
thing.SetCustomFields(udefs);
```

## SetDbiAgentId(Integer)

```crmscript theme={null}
Void SetDbiAgentId(Integer dbiAgentId)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Integer dbiAgentId;
thing.SetDbiAgentId(dbiAgentId);
```

## SetDbiKey(String)

```crmscript theme={null}
Void SetDbiKey(String dbiKey)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String dbiKey;
thing.SetDbiKey(dbiKey);
```

## SetDbiLastModified(DateTime)

```crmscript theme={null}
Void SetDbiLastModified(DateTime dbiLastModified)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
DateTime dbiLastModified;
thing.SetDbiLastModified(dbiLastModified);
```

## SetDbiLastSyncronized(DateTime)

```crmscript theme={null}
Void SetDbiLastSyncronized(DateTime dbiLastSyncronized)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
DateTime dbiLastSyncronized;
thing.SetDbiLastSyncronized(dbiLastSyncronized);
```

## SetDescription(String)

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

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

**Example:**

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

## SetEmails(NSEntityElement\[])

```crmscript theme={null}
Void SetEmails(NSEntityElement[] emails)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSEntityElement[] emails;
thing.SetEmails(emails);
```

## SetExtraFields(Map)

Sets the extra field values on NSPersonEntity with a map.

```crmscript theme={null}
Void SetExtraFields(Map extras)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Map extras;
extras["SuperOffice:1"] = "[I:123]";
extras["SuperOffice:1"] = "123"; // this will also work, but beware of decimal point variations in different languages
extras["custom.progid"] = "foobar";
thing.SetExtraFields(extras);
```

## SetFaxes(NSEntityElement\[])

Returns a collection of fax numbers that belong to the contact person.

```crmscript theme={null}
Void SetFaxes(NSEntityElement[] faxes)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSEntityElement[] faxes;
thing.SetFaxes(faxes);
```

## SetFirstname(String)

```crmscript theme={null}
Void SetFirstname(String firstname)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String firstname;
thing.SetFirstname(firstname);
```

## SetFormalName(String)

Gets formal name for a person, as used in labels. (Full name + person title + academic title)

```crmscript theme={null}
Void SetFormalName(String formalName)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String formalName;
thing.SetFormalName(formalName);
```

## SetFullName(String)

```crmscript theme={null}
Void SetFullName(String fullName)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String fullName;
thing.SetFullName(fullName);
```

## SetInterests(NSSelectableMDOListItem\[])

```crmscript theme={null}
Void SetInterests(NSSelectableMDOListItem[] interests)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSSelectableMDOListItem[] interests;
thing.SetInterests(interests);
```

## SetInternetPhones(NSEntityElement\[])

```crmscript theme={null}
Void SetInternetPhones(NSEntityElement[] internetPhones)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSEntityElement[] internetPhones;
thing.SetInternetPhones(internetPhones);
```

## SetIsAssociate(Bool)

Checks if the person object is an associate. The property is read-only.

```crmscript theme={null}
Void SetIsAssociate(Bool isAssociate)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Bool isAssociate;
thing.SetIsAssociate(isAssociate);
```

## SetKanafname(String)

```crmscript theme={null}
Void SetKanafname(String kanafname)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String kanafname;
thing.SetKanafname(kanafname);
```

## SetKanalname(String)

```crmscript theme={null}
Void SetKanalname(String kanalname)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String kanalname;
thing.SetKanalname(kanalname);
```

## SetLastname(String)

```crmscript theme={null}
Void SetLastname(String lastname)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String lastname;
thing.SetLastname(lastname);
```

## SetMiddleName(String)

```crmscript theme={null}
Void SetMiddleName(String middleName)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String middleName;
thing.SetMiddleName(middleName);
```

## SetMobilePhones(NSEntityElement\[])

Returns a collection of mobile phone numbers that belong to the contact person.

```crmscript theme={null}
Void SetMobilePhones(NSEntityElement[] mobilePhones)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSEntityElement[] mobilePhones;
thing.SetMobilePhones(mobilePhones);
```

## SetMrmrs(String)

```crmscript theme={null}
Void SetMrmrs(String mrmrs)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String mrmrs;
thing.SetMrmrs(mrmrs);
```

## SetNoMailing(Bool)

```crmscript theme={null}
Void SetNoMailing(Bool noMailing)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Bool noMailing;
thing.SetNoMailing(noMailing);
```

## SetOfficePhones(NSEntityElement\[])

Returns a collection of office phone numbers that belong to the contact person.

```crmscript theme={null}
Void SetOfficePhones(NSEntityElement[] officePhones)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSEntityElement[] officePhones;
thing.SetOfficePhones(officePhones);
```

## SetOtherPhones(NSEntityElement\[])

Returns a collection of pagers that belong to the contact person.

```crmscript theme={null}
Void SetOtherPhones(NSEntityElement[] otherPhones)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSEntityElement[] otherPhones;
thing.SetOtherPhones(otherPhones);
```

## SetPagers(NSEntityElement\[])

```crmscript theme={null}
Void SetPagers(NSEntityElement[] pagers)
```

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

## SetPersonId(Integer)

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

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

**Example:**

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

## SetPersonNumber(String)

```crmscript theme={null}
Void SetPersonNumber(String personNumber)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String personNumber;
thing.SetPersonNumber(personNumber);
```

## SetPosition(NSPosition)

```crmscript theme={null}
Void SetPosition(NSPosition position)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSPosition position;
thing.SetPosition(position);
```

## SetPost1(String)

```crmscript theme={null}
Void SetPost1(String post1)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String post1;
thing.SetPost1(post1);
```

## SetPost2(String)

```crmscript theme={null}
Void SetPost2(String post2)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String post2;
thing.SetPost2(post2);
```

## SetPost3(String)

```crmscript theme={null}
Void SetPost3(String post3)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String post3;
thing.SetPost3(post3);
```

## SetPrivatePhones(NSEntityElement\[])

Returns a collection of phone numbers that belong to the contact person.

```crmscript theme={null}
Void SetPrivatePhones(NSEntityElement[] privatePhones)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSEntityElement[] privatePhones;
thing.SetPrivatePhones(privatePhones);
```

## SetRetired(Bool)

```crmscript theme={null}
Void SetRetired(Bool retired)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Bool retired;
thing.SetRetired(retired);
```

## SetSalutation(String)

```crmscript theme={null}
Void SetSalutation(String salutation)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String salutation;
thing.SetSalutation(salutation);
```

## SetSentInfo(Integer)

```crmscript theme={null}
Void SetSentInfo(Integer sentInfo)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Integer sentInfo;
thing.SetSentInfo(sentInfo);
```

## SetShipmentTypes(NSSelectableMDOListItem\[])

```crmscript theme={null}
Void SetShipmentTypes(NSSelectableMDOListItem[] shipmentTypes)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSSelectableMDOListItem[] shipmentTypes;
thing.SetShipmentTypes(shipmentTypes);
```

## SetShowContactTickets(Integer)

```crmscript theme={null}
Void SetShowContactTickets(Integer showContactTickets)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Integer showContactTickets;
thing.SetShowContactTickets(showContactTickets);
```

## SetSource(Integer)

```crmscript theme={null}
Void SetSource(Integer source)
```

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

<Note>
  For future integration needs
</Note>

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Integer source;
thing.SetSource(source);
```

## SetSupportAssociate(NSAssociate)

```crmscript theme={null}
Void SetSupportAssociate(NSAssociate supportAssociate)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSAssociate supportAssociate;
thing.SetSupportAssociate(supportAssociate);
```

## SetTicketPriority(NSTicketPriority)

```crmscript theme={null}
Void SetTicketPriority(NSTicketPriority ticketPriority)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSTicketPriority ticketPriority;
thing.SetTicketPriority(ticketPriority);
```

## SetTitle(String)

```crmscript theme={null}
Void SetTitle(String title)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
String title;
thing.SetTitle(title);
```

## SetUpdatedBy(NSAssociate)

The person that last updated the person object

```crmscript theme={null}
Void SetUpdatedBy(NSAssociate updatedBy)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSAssociate updatedBy;
thing.SetUpdatedBy(updatedBy);
```

## SetUpdatedDate(DateTime)

```crmscript theme={null}
Void SetUpdatedDate(DateTime updatedDate)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
DateTime updatedDate;
thing.SetUpdatedDate(updatedDate);
```

## SetUrls(NSEntityElement\[])

```crmscript theme={null}
Void SetUrls(NSEntityElement[] urls)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSEntityElement[] urls;
thing.SetUrls(urls);
```

## SetUsePersonAddress(Bool)

```crmscript theme={null}
Void SetUsePersonAddress(Bool usePersonAddress)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Bool usePersonAddress;
thing.SetUsePersonAddress(usePersonAddress);
```

## SetUserDefinedFields(Map)

Sets the user-defined fields on the NSPersonEntity as a map.

```crmscript theme={null}
Void SetUserDefinedFields(Map udefs)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
Map udefs;
udefs["SuperOffice:1"] = "[I:123]";
udefs["SuperOffice:1"] = "123"; // this will also work, but beware of decimal point variations in different languages
udefs["custom.progid"] = "foobar";
thing.SetUserDefinedFields(udefs);
```

## SetUserInfo(NSUserInfo)

```crmscript theme={null}
Void SetUserInfo(NSUserInfo userInfo)
```

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

**Example:**

```crmscript theme={null}
NSPersonEntity thing;
NSUserInfo userInfo;
thing.SetUserInfo(userInfo);
```
