Skip to main content
The Person Service. The service implements all services working with the Person object.

Constructors

NSPersonEntity()

Initializes a new instance of the NSPersonEntity class.

Methods

Returns: CRMScript.Global.Integer - How many active ERP links are there for this person? Example:

GetActiveInterests()

Returns: CRMScript.Global.Integer - The number of active interests. Example:

GetAddress()

Retrieves a formatted addressRetrieves the structure holding formatted address data.
Returns: CRMScript.NetServer.NSAddress
The layout of the array structure indicates the layout of the localized address.
Example:

GetAssociate()

Returns: CRMScript.NetServer.NSAssociate - The associate owning this person (similar to contact.Associate).
Usually blank. Use the Person.Contact.Associate instead. Intended for use when individual persons are created (i.e. when Person.Contact is blank)
Example:

GetBirthDate()

Returns: CRMScript.Global.DateTime - The Person birth date as Date. Example:

GetBounceEmails()

Returns: CRMScript.Global.String[] - Email addresses with a positive bounce counter. Example:

GetBusiness()

Returns: CRMScript.NetServer.NSBusiness - Person’s business.
Usually blank. Use Contact.NSBusiness instead. Intended for use when individual persons are created. (i.e. when Person.Contact is blank)
Example:

GetCategory()

Returns: CRMScript.NetServer.NSCategory - Person’s category.
Usually null. Refer to the Contact.NSCategory instead. Intended for use when individual persons are created. (i.e. when Person.Contact is blank)
Example:

GetChatEmails()

Returns: CRMScript.NetServer.NSEntityElement[] Example:

GetConsents()

Returns: CRMScript.NetServer.NSConsentInfo[] - The person’s available consent information.
Missing consents are not deleted. To remove a consent, mark its legalbase as ‘WITHDRAWN’
Example:

GetContact()

Returns: CRMScript.NetServer.NSContact - The contact the contact person is registered on.
This is required unless the ‘MandatoryContactOnPerson’ preference is set.
Example:

GetCorrespondingAssociate()

Returns: 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:

GetCountry()

Returns: CRMScript.NetServer.NSCountry - The country this contact person is located in. Example:

GetCreatedBy()

Returns: CRMScript.NetServer.NSAssociate - The user that created the person object. Example:

GetCreatedDate()

Returns: CRMScript.Global.DateTime - Registered date. Example:

GetCustomerLanguage()

Returns: CRMScript.NetServer.NSCustomerLanguage Example:

GetCustomFields()

Gets the user-defined + extra fields on an NSPersonEntity as a map.
Returns: CRMScript.Native.Map Example:

GetDbiAgentId()

Returns: CRMScript.Global.Integer - Integration agent (eJournal). Example:

GetDbiKey()

Returns: CRMScript.Global.String - The primary key for the integrated entry in the external data source. Example:

GetDbiLastModified()

Returns: CRMScript.Global.DateTime - When the entry was last modified. Example:

GetDbiLastSyncronized()

Returns: CRMScript.Global.DateTime - Last external synchronization. Example:

GetDescription()

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

GetEmails()

Returns: CRMScript.NetServer.NSEntityElement[] - A collection of the person’s emails. Example:

GetExtraFields()

Gets the extra fields on NSPersonEntity as a map.
Returns: CRMScript.Native.Map Example:

GetFaxes()

Returns a collection of fax numbers that belong to the contact person.
Returns: CRMScript.NetServer.NSEntityElement[] Example:

GetFirstname()

Returns: CRMScript.Global.String - First name. Example:

GetFormalName()

Gets formal name for a person, as used in labels. (Full name + person title + academic title)
Returns: CRMScript.Global.String Example:

GetFullName()

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

GetInterests()

Returns: CRMScript.NetServer.NSSelectableMDOListItem[] - The person’s available and selected interests. Example:

GetInternetPhones()

Returns: CRMScript.NetServer.NSEntityElement[] Example:

GetIsAssociate()

Checks if the person object is an associate. The property is read-only.
Returns: CRMScript.Global.Bool Example:

GetKanafname()

Returns: CRMScript.Global.String - Kana first name, used in Japanese versions only. Example:

GetKanalname()

Returns: CRMScript.Global.String - Kana last name, used in Japanese versions only. Example:

GetLastname()

Returns: CRMScript.Global.String - Last name. Example:

GetMiddleName()

Returns: CRMScript.Global.String - Middle name or ‘van’ etc. Example:

GetMobilePhones()

Returns a collection of mobile phone numbers that belong to the contact person.
Returns: CRMScript.NetServer.NSEntityElement[] Example:

GetMrmrs()

Returns: CRMScript.Global.String Example:

GetNoMailing()

Returns: CRMScript.Global.Bool - Spam filter. Indicates if this person should retrieve advertising. Example:

GetOfficePhones()

Returns a collection of office phone numbers that belong to the contact person.
Returns: CRMScript.NetServer.NSEntityElement[] Example:

GetOtherPhones()

Returns a collection of pagers that belong to the contact person.
Returns: CRMScript.NetServer.NSEntityElement[] Example:

GetPagers()

Returns: CRMScript.NetServer.NSEntityElement[]

GetPersonId()

Returns: CRMScript.Global.Integer - Primary key. Example:

GetPersonNumber()

Returns: CRMScript.Global.String - Alphanumeric user field. Example:

GetPosition()

Returns: CRMScript.NetServer.NSPosition - The position. This is a predefined SuperOffice value, different from Title. Example:

GetPost1()

Returns: CRMScript.Global.String - Postal address, used in Japanese versions only. Example:

GetPost2()

Returns: CRMScript.Global.String - Postal address, used in Japanese versions only. Example:

GetPost3()

Returns: CRMScript.Global.String - Postal address, used in Japanese versions only. Example:

GetPrivatePhones()

Returns a collection of phone numbers that belong to the contact person.
Returns: CRMScript.NetServer.NSEntityElement[] Example:

GetRetired()

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

GetSalutation()

Returns: CRMScript.Global.String - Academic title, populated from Salutation list but can be overwritten with anything at all. Example:

GetSentInfo()

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

GetShipmentTypes()

The person’s available and selected shipment types.
Returns: CRMScript.NetServer.NSSelectableMDOListItem[] Example:

GetShowContactTickets()

Returns: CRMScript.Global.Integer - Should tickets related to the company be shown to this person. Example:

GetSource()

Returns: CRMScript.Global.Integer - How did we get this person? For future integration needs. Example:

GetSupportAssociate()

Returns: CRMScript.NetServer.NSAssociate Example:

GetTicketPriority()

Returns: CRMScript.NetServer.NSTicketPriority Example:

GetTitle()

Returns: CRMScript.Global.String - Title. Example:

GetUpdatedBy()

Returns: CRMScript.NetServer.NSAssociate - The person that last updated the person object. Example:

GetUpdatedDate()

Returns: CRMScript.Global.DateTime - Last updated date. Example:

GetUrls()

Returns: CRMScript.NetServer.NSEntityElement[] - The URLs related to this person. Example:

GetUsePersonAddress()

Returns: CRMScript.Global.Bool - True if the person’s address should be used as mailing address, instead of the contact’s address. Example:

GetUserDefinedFields()

Gets the user-defined fields on the NSPersonEntity as a map.
Returns: CRMScript.Native.Map Example:

GetUserInfo()

Returns: 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:
Returns: CRMScript.Global.Void Example:

SetActiveInterests(Integer)

Returns: CRMScript.Global.Void Example:

SetAddress(NSAddress)

Sets a formatted addressSets the structure holding formatted address data.
Returns: CRMScript.Global.Void Example:

SetAssociate(NSAssociate)

Returns: CRMScript.Global.Void
Usually blank. Use the Person.Contact.Associate instead. Intended for use when individual persons are created (i.e. when Person.Contact is blank)
Example:

SetBirthDate(DateTime)

Returns: CRMScript.Global.Void Example:

SetBounceEmails(String[])

Returns: CRMScript.Global.Void Example:

SetBusiness(NSBusiness)

Returns: CRMScript.Global.Void
Usually blank. Use Contact.NSBusiness instead. Intended for use when individual persons are created. (i.e. when Person.Contact is blank)
Example:

SetCategory(NSCategory)

Returns: CRMScript.Global.Void
Usually null. Refer to the Contact.NSCategory instead. Intended for use when individual persons are created. (i.e. when Person.Contact is blank)
Example:

SetChatEmails(NSEntityElement[])

Returns: CRMScript.Global.Void Example:

SetConsents(NSConsentInfo[])

Returns: CRMScript.Global.Void
Missing consents are not deleted. To remove a consent, mark its legalbase as ‘WITHDRAWN’
Example:

SetContact(NSContact)

Returns: CRMScript.Global.Void Example:

SetCorrespondingAssociate(NSAssociate)

Returns: CRMScript.Global.Void
Will be empty if the person is not a user (internal associate user, external user).
Example:

SetCountry(NSCountry)

Returns: CRMScript.Global.Void Example:

SetCreatedBy(NSAssociate)

Returns: CRMScript.Global.Void Example:

SetCreatedDate(DateTime)

Returns: CRMScript.Global.Void Example:

SetCustomerLanguage(NSCustomerLanguage)

Returns: CRMScript.Global.Void Example:

SetCustomFields(Map)

Sets the user-defined and extra fields on an NSPersonEntity with a map.
Returns: CRMScript.Global.Void Example:

SetDbiAgentId(Integer)

Returns: CRMScript.Global.Void Example:

SetDbiKey(String)

Returns: CRMScript.Global.Void Example:

SetDbiLastModified(DateTime)

Returns: CRMScript.Global.Void Example:

SetDbiLastSyncronized(DateTime)

Returns: CRMScript.Global.Void Example:

SetDescription(String)

Returns: CRMScript.Global.Void Example:

SetEmails(NSEntityElement[])

Returns: CRMScript.Global.Void Example:

SetExtraFields(Map)

Sets the extra field values on NSPersonEntity with a map.
Returns: CRMScript.Global.Void Example:

SetFaxes(NSEntityElement[])

Returns a collection of fax numbers that belong to the contact person.
Returns: CRMScript.Global.Void Example:

SetFirstname(String)

Returns: CRMScript.Global.Void Example:

SetFormalName(String)

Gets formal name for a person, as used in labels. (Full name + person title + academic title)
Returns: CRMScript.Global.Void Example:

SetFullName(String)

Returns: CRMScript.Global.Void Example:

SetInterests(NSSelectableMDOListItem[])

Returns: CRMScript.Global.Void Example:

SetInternetPhones(NSEntityElement[])

Returns: CRMScript.Global.Void Example:

SetIsAssociate(Bool)

Checks if the person object is an associate. The property is read-only.
Returns: CRMScript.Global.Void Example:

SetKanafname(String)

Returns: CRMScript.Global.Void Example:

SetKanalname(String)

Returns: CRMScript.Global.Void Example:

SetLastname(String)

Returns: CRMScript.Global.Void Example:

SetMiddleName(String)

Returns: CRMScript.Global.Void Example:

SetMobilePhones(NSEntityElement[])

Returns a collection of mobile phone numbers that belong to the contact person.
Returns: CRMScript.Global.Void Example:

SetMrmrs(String)

Returns: CRMScript.Global.Void Example:

SetNoMailing(Bool)

Returns: CRMScript.Global.Void Example:

SetOfficePhones(NSEntityElement[])

Returns a collection of office phone numbers that belong to the contact person.
Returns: CRMScript.Global.Void Example:

SetOtherPhones(NSEntityElement[])

Returns a collection of pagers that belong to the contact person.
Returns: CRMScript.Global.Void Example:

SetPagers(NSEntityElement[])

Returns: CRMScript.Global.Void

SetPersonId(Integer)

Returns: CRMScript.Global.Void Example:

SetPersonNumber(String)

Returns: CRMScript.Global.Void Example:

SetPosition(NSPosition)

Returns: CRMScript.Global.Void Example:

SetPost1(String)

Returns: CRMScript.Global.Void Example:

SetPost2(String)

Returns: CRMScript.Global.Void Example:

SetPost3(String)

Returns: CRMScript.Global.Void Example:

SetPrivatePhones(NSEntityElement[])

Returns a collection of phone numbers that belong to the contact person.
Returns: CRMScript.Global.Void Example:

SetRetired(Bool)

Returns: CRMScript.Global.Void Example:

SetSalutation(String)

Returns: CRMScript.Global.Void Example:

SetSentInfo(Integer)

Returns: CRMScript.Global.Void Example:

SetShipmentTypes(NSSelectableMDOListItem[])

Returns: CRMScript.Global.Void Example:

SetShowContactTickets(Integer)

Returns: CRMScript.Global.Void Example:

SetSource(Integer)

Returns: CRMScript.Global.Void
For future integration needs
Example:

SetSupportAssociate(NSAssociate)

Returns: CRMScript.Global.Void Example:

SetTicketPriority(NSTicketPriority)

Returns: CRMScript.Global.Void Example:

SetTitle(String)

Returns: CRMScript.Global.Void Example:

SetUpdatedBy(NSAssociate)

The person that last updated the person object
Returns: CRMScript.Global.Void Example:

SetUpdatedDate(DateTime)

Returns: CRMScript.Global.Void Example:

SetUrls(NSEntityElement[])

Returns: CRMScript.Global.Void Example:

SetUsePersonAddress(Bool)

Returns: CRMScript.Global.Void Example:

SetUserDefinedFields(Map)

Sets the user-defined fields on the NSPersonEntity as a map.
Returns: CRMScript.Global.Void Example:

SetUserInfo(NSUserInfo)

Returns: CRMScript.Global.Void Example: