Class NSSale
Constructors
NSSale()
Initializes a new instance of the NSSale class.
Declaration
NSSaleMethods
GetActiveErpLinks()
Declaration
Integer GetActiveErpLinks()Examples
NSSale thing;
Integer activeErpLinks = thing.GetActiveErpLinks();Returns
| Type | Description |
| Integer | The number of active ERP links. |
GetAmount()
Declaration
Float GetAmount()Examples
NSSale thing;
Float amount = thing.GetAmount();Returns
| Type | Description |
| Float | Total sale amount. |
GetAssociateFullName()
Declaration
String GetAssociateFullName()Examples
NSSale thing;
String associateFullName = thing.GetAssociateFullName();Returns
| Type | Description |
| String | The sale's owner. |
GetAssociateId()
Declaration
Integer GetAssociateId()Examples
NSSale thing;
Integer associateId = thing.GetAssociateId();Returns
| Type | Description |
| Integer | The sale's owner Id. |
GetCompleted()
Declaration
Integer GetCompleted()Examples
NSSale thing;
Integer completed = thing.GetCompleted();Returns
| Type | Description |
| Integer | The Sale completed state. |
GetContactId()
Declaration
Integer GetContactId()Examples
NSSale thing;
Integer contactId = thing.GetContactId();Returns
| Type | Description |
| Integer | Optional contact reference. |
GetContactName()
Declaration
String GetContactName()Examples
NSSale thing;
String contactName = thing.GetContactName();Returns
| Type | Description |
| String | Contact name. |
GetCurrency()
Declaration
String GetCurrency()Examples
NSSale thing;
String currency = thing.GetCurrency();Returns
| Type | Description |
| String | NSCurrency the sale was made in. |
GetDescription()
Declaration
String GetDescription()Examples
NSSale thing;
String description = thing.GetDescription();Returns
| Type | Description |
| String | The sales description. |
GetEarning()
Declaration
Float GetEarning()Examples
NSSale thing;
Float earning = thing.GetEarning();Returns
| Type | Description |
| Float | Earning on sale. |
GetEarningPercent()
Declaration
Float GetEarningPercent()Examples
NSSale thing;
Float earningPercent = thing.GetEarningPercent();Returns
| Type | Description |
| Float | Earning as percent of total. |
GetNextDueDate()
Declaration
DateTime GetNextDueDate()Examples
NSSale thing;
DateTime nextDueDate = thing.GetNextDueDate();Returns
| Type | Description |
| DateTime | Next due date, this is a de-normalization of 'closest future activity date, or most recent if no future activities'. |
GetNumber()
Declaration
String GetNumber()Examples
NSSale thing;
String number = thing.GetNumber();Returns
| Type | Description |
| String | Alphanumeric user field. |
GetPersonFullName()
Declaration
String GetPersonFullName()Examples
NSSale thing;
String personFullName = thing.GetPersonFullName();Returns
| Type | Description |
| String | The name of the person this sale belongs to. |
GetPersonId()
Declaration
Integer GetPersonId()Examples
NSSale thing;
Integer personId = thing.GetPersonId();Returns
| Type | Description |
| Integer | The sale's contact persons Id. |
GetProbability()
Declaration
Integer GetProbability()Examples
NSSale thing;
Integer probability = thing.GetProbability();Returns
| Type | Description |
| Integer | Actual probability, may differ from the one in the list. |
GetProjectId()
Declaration
Integer GetProjectId()Examples
NSSale thing;
Integer projectId = thing.GetProjectId();Returns
| Type | Description |
| Integer | Optional project reference. |
GetProjectName()
Declaration
String GetProjectName()Examples
NSSale thing;
String projectName = thing.GetProjectName();Returns
| Type | Description |
| String | Project name. |
GetSaleDate()
Declaration
DateTime GetSaleDate()Examples
NSSale thing;
DateTime saleDate = thing.GetSaleDate();Returns
| Type | Description |
| DateTime | (expected / lost / won) sales date. |
GetSaleId()
Declaration
Integer GetSaleId()Examples
NSSale thing;
Integer saleId = thing.GetSaleId();Returns
| Type | Description |
| Integer | Primary key. |
GetSaleTypeId()
Declaration
Integer GetSaleTypeId()Examples
NSSale thing;
Integer saleTypeId = thing.GetSaleTypeId();Returns
| Type | Description |
| Integer | The sale's type Id. |
GetSaleTypeName()
Declaration
String GetSaleTypeName()Examples
NSSale thing;
String saleTypeName = thing.GetSaleTypeName();Returns
| Type | Description |
| String | The sale's type name. |
GetStatus()
Declaration
Integer GetStatus()Examples
NSSale thing;
Integer status = thing.GetStatus();Returns
| Type | Description |
| Integer | The sale's status, indicating wether the sale is open, sold or lost. See <xref href="CRMScript.NetServer.SaleStatus" data-throw-if-not-resolved="false"></xref>. |
GetTitle()
Declaration
String GetTitle()Examples
NSSale thing;
String title = thing.GetTitle();Returns
| Type | Description |
| String | Sale heading (short description?). |
GetWeightedAmount()
Declaration
Float GetWeightedAmount()Examples
NSSale thing;
Float weightedAmount = thing.GetWeightedAmount();Returns
| Type | Description |
| Float | The weighted amount ( amount * probability / 100). |
SetActiveErpLinks(Integer)
Declaration
Void SetActiveErpLinks(Integer activeErpLinks)Examples
NSSale thing;
Integer activeErpLinks;
thing.SetActiveErpLinks(activeErpLinks);Parameters
| Type | Name | Description |
| Integer | activeErpLinks | The number of active ERP links. |
Returns
| Type | Description |
| Void |
SetAmount(Float)
Declaration
Void SetAmount(Float amount)Examples
NSSale thing;
Float amount;
thing.SetAmount(amount);Parameters
| Type | Name | Description |
| Float | amount | Total sale amount. |
Returns
| Type | Description |
| Void |
SetAssociateFullName(String)
Declaration
Void SetAssociateFullName(String associateFullName)Examples
NSSale thing;
String associateFullName;
thing.SetAssociateFullName(associateFullName);Parameters
| Type | Name | Description |
| String | associateFullName | The sale's owner. |
Returns
| Type | Description |
| Void |
SetAssociateId(Integer)
Declaration
Void SetAssociateId(Integer associateId)Examples
NSSale thing;
Integer associateId;
thing.SetAssociateId(associateId);Parameters
| Type | Name | Description |
| Integer | associateId | The sale's owner Id. |
Returns
| Type | Description |
| Void |
SetCompleted(Integer)
Declaration
Void SetCompleted(Integer completed)Examples
NSSale thing;
Integer completed;
thing.SetCompleted(completed);Parameters
| Type | Name | Description |
| Integer | completed | The Sale completed state. |
Returns
| Type | Description |
| Void |
SetContactId(Integer)
Declaration
Void SetContactId(Integer contactId)Examples
NSSale thing;
Integer contactId;
thing.SetContactId(contactId);Parameters
| Type | Name | Description |
| Integer | contactId | Optional contact reference. |
Returns
| Type | Description |
| Void |
SetContactName(String)
Declaration
Void SetContactName(String contactName)Examples
NSSale thing;
String contactName;
thing.SetContactName(contactName);Parameters
| Type | Name | Description |
| String | contactName | Contact name. |
Returns
| Type | Description |
| Void |
SetCurrency(String)
Declaration
Void SetCurrency(String currency)Examples
NSSale thing;
String currency;
thing.SetCurrency(currency);Parameters
| Type | Name | Description |
| String | currency | NSCurrency the sale was made in. |
Returns
| Type | Description |
| Void |
SetDescription(String)
Declaration
Void SetDescription(String description)Examples
NSSale thing;
String description;
thing.SetDescription(description);Parameters
| Type | Name | Description |
| String | description | The sales description. |
Returns
| Type | Description |
| Void |
SetEarning(Float)
Declaration
Void SetEarning(Float earning)Examples
NSSale thing;
Float earning;
thing.SetEarning(earning);Parameters
| Type | Name | Description |
| Float | earning | Earning on Sale. |
Returns
| Type | Description |
| Void |
SetEarningPercent(Float)
Declaration
Void SetEarningPercent(Float earningPercent)Examples
NSSale thing;
Float earningPercent;
thing.SetEarningPercent(earningPercent);Parameters
| Type | Name | Description |
| Float | earningPercent | Earning as percent of total. |
Returns
| Type | Description |
| Void |
SetNextDueDate(DateTime)
Maintained by the system, but very convenient for searching.
Declaration
Void SetNextDueDate(DateTime nextDueDate)Examples
NSSale thing;
DateTime nextDueDate;
thing.SetNextDueDate(nextDueDate);Parameters
| Type | Name | Description |
| DateTime | nextDueDate | Next due date, this is a de-normalization of 'closest future activity date, or most recent if no future activities'. |
Returns
| Type | Description |
| Void |
SetNumber(String)
Alphanumeric user field
Declaration
Void SetNumber(String number)Examples
NSSale thing;
String number;
thing.SetNumber(number);Parameters
| Type | Name | Description |
| String | number | Alphanumeric user field. |
Returns
| Type | Description |
| Void |
SetPersonFullName(String)
Declaration
Void SetPersonFullName(String personFullName)Examples
NSSale thing;
String personFullName;
thing.SetPersonFullName(personFullName);Parameters
| Type | Name | Description |
| String | personFullName | The name of the person this sale belongs to. |
Returns
| Type | Description |
| Void |
SetPersonId(Integer)
Declaration
Void SetPersonId(Integer personId)Examples
NSSale thing;
Integer personId;
thing.SetPersonId(personId);Parameters
| Type | Name | Description |
| Integer | personId | The sale's contact persons Id. |
Returns
| Type | Description |
| Void |
SetProbability(Integer)
Declaration
Void SetProbability(Integer probability)Examples
NSSale thing;
Integer probability;
thing.SetProbability(probability);Parameters
| Type | Name | Description |
| Integer | probability | Actual probability, may differ from the one in the list. |
Returns
| Type | Description |
| Void |
SetProjectId(Integer)
Declaration
Void SetProjectId(Integer projectId)Examples
NSSale thing;
Integer projectId;
thing.SetProjectId(projectId);Parameters
| Type | Name | Description |
| Integer | projectId | Optional project reference. |
Returns
| Type | Description |
| Void |
SetProjectName(String)
Declaration
Void SetProjectName(String projectName)Examples
NSSale thing;
String projectName;
thing.SetProjectName(projectName);Parameters
| Type | Name | Description |
| String | projectName | Project name. |
Returns
| Type | Description |
| Void |
SetSaleDate(DateTime)
Declaration
Void SetSaleDate(DateTime saleDate)Examples
NSSale thing;
DateTime saleDate;
thing.SetSaleDate(saleDate);Parameters
| Type | Name | Description |
| DateTime | saleDate | (expected / lost / won) sales date. |
Returns
| Type | Description |
| Void |
SetSaleId(Integer)
Declaration
Void SetSaleId(Integer saleId)Examples
NSSale thing;
Integer saleId;
thing.SetSaleId(saleId);Parameters
| Type | Name | Description |
| Integer | saleId | Primary key. |
Returns
| Type | Description |
| Void |
SetSaleTypeId(Integer)
Declaration
Void SetSaleTypeId(Integer saleTypeId)Examples
NSSale thing;
Integer saleTypeId;
thing.SetSaleTypeId(saleTypeId);Parameters
| Type | Name | Description |
| Integer | saleTypeId | The sale's type Id. |
Returns
| Type | Description |
| Void |
SetSaleTypeName(String)
Declaration
Void SetSaleTypeName(String saleTypeName)Examples
NSSale thing;
String saleTypeName;
thing.SetSaleTypeName(saleTypeName);Parameters
| Type | Name | Description |
| String | saleTypeName | The sale's type name. |
Returns
| Type | Description |
| Void |
SetStatus(Integer)
Declaration
Void SetStatus(Integer status)Examples
NSSale thing;
Integer status;
thing.SetStatus(status);Parameters
| Type | Name | Description |
| Integer | status | The sale's status, indicating wether the sale is open, sold or lost. See <xref href="CRMScript.NetServer.SaleStatus" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetTitle(String)
Declaration
Void SetTitle(String title)Examples
NSSale thing;
String title;
thing.SetTitle(title);Parameters
| Type | Name | Description |
| String | title | Sale heading (short description?). |
Returns
| Type | Description |
| Void |
SetWeightedAmount(Float)
Declaration
Void SetWeightedAmount(Float weightedAmount)Examples
NSSale thing;
Float weightedAmount;
thing.SetWeightedAmount(weightedAmount);Parameters
| Type | Name | Description |
| Float | weightedAmount | The weighted amount ( amount * probability / 100). |
Returns
| Type | Description |
| Void |