Class NSSaleSummaryItem
Sale Summary item.
Constructors
NSSaleSummaryItem()
Initializes a new instance of the NSSaleSummaryItem class.
Declaration
NSSaleSummaryItemMethods
GetAmount()
Declaration
Float GetAmount()Examples
NSSaleSummaryItem thing;
Float amount = thing.GetAmount();Returns
| Type | Description |
| Float | Total sale amount. |
GetAmountInBaseCurrency()
Declaration
Float GetAmountInBaseCurrency()Examples
NSSaleSummaryItem thing;
Float amountInBaseCurrency = thing.GetAmountInBaseCurrency();Returns
| Type | Description |
| Float | Sale amount converted to the base currency. |
GetCompleted()
Declaration
Integer GetCompleted()Examples
NSSaleSummaryItem thing;
Integer completed = thing.GetCompleted();Returns
| Type | Description |
| Integer | The Completed state. NotStarted(1) or Completed(3). See <xref href="CRMScript.NetServer.SaleStatus" data-throw-if-not-resolved="false"></xref>. |
GetCurrency()
Declaration
String GetCurrency()Examples
NSSaleSummaryItem thing;
String currency = thing.GetCurrency();Returns
| Type | Description |
| String | NSCurrency the sale amount is in. |
GetHeading()
Declaration
String GetHeading()Examples
NSSaleSummaryItem thing;
String heading = thing.GetHeading();Returns
| Type | Description |
| String | Sale heading (short description?). |
GetProbability()
Declaration
Integer GetProbability()Examples
NSSaleSummaryItem thing;
Integer probability = thing.GetProbability();Returns
| Type | Description |
| Integer | Probability of sale success in percent (0-100). |
GetRegistered()
Declaration
DateTime GetRegistered()Examples
NSSaleSummaryItem thing;
DateTime registered = thing.GetRegistered();Returns
| Type | Description |
| DateTime | Registered date. |
GetSaleDate()
Declaration
DateTime GetSaleDate()Examples
NSSaleSummaryItem thing;
DateTime saleDate = thing.GetSaleDate();Returns
| Type | Description |
| DateTime | Expected sales date. |
GetSaleId()
Declaration
Integer GetSaleId()Examples
NSSaleSummaryItem thing;
Integer saleId = thing.GetSaleId();Returns
| Type | Description |
| Integer | Primary key. |
GetStatus()
Declaration
Integer GetStatus()Examples
NSSaleSummaryItem thing;
Integer status = thing.GetStatus();Returns
| Type | Description |
| Integer | The sale's status, indicating whether the sale is open(1), sold(2) or lost(3). See <xref href="CRMScript.NetServer.SaleStatus" data-throw-if-not-resolved="false"></xref>. |
SetAmount(Float)
Declaration
Void SetAmount(Float amount)Examples
NSSaleSummaryItem thing;
Float amount;
thing.SetAmount(amount);Parameters
| Type | Name | Description |
| Float | amount | Total sale amount. |
Returns
| Type | Description |
| Void |
SetAmountInBaseCurrency(Float)
Declaration
Void SetAmountInBaseCurrency(Float amountInBaseCurrency)Examples
NSSaleSummaryItem thing;
Float amountInBaseCurrency;
thing.SetAmountInBaseCurrency(amountInBaseCurrency);Parameters
| Type | Name | Description |
| Float | amountInBaseCurrency | Sale amount converted to the base currency. |
Returns
| Type | Description |
| Void |
SetCompleted(Integer)
Declaration
Void SetCompleted(Integer completed)Examples
NSSaleSummaryItem thing;
Integer completed;
thing.SetCompleted(completed);Parameters
| Type | Name | Description |
| Integer | completed | The Completed state. NotStarted(1) or Completed(3). |
Returns
| Type | Description |
| Void |
SetCurrency(String)
Declaration
Void SetCurrency(String currency)Examples
NSSaleSummaryItem thing;
String currency;
thing.SetCurrency(currency);Parameters
| Type | Name | Description |
| String | currency | NSCurrency the sale amount is in. |
Returns
| Type | Description |
| Void |
SetHeading(String)
Declaration
Void SetHeading(String heading)Examples
NSSaleSummaryItem thing;
String heading;
thing.SetHeading(heading);Parameters
| Type | Name | Description |
| String | heading | Sale heading (short description?). |
Returns
| Type | Description |
| Void |
SetProbability(Integer)
Declaration
Void SetProbability(Integer probability)Examples
NSSaleSummaryItem thing;
Integer probability;
thing.SetProbability(probability);Parameters
| Type | Name | Description |
| Integer | probability | Probability of sale success in percent (0-100). |
Returns
| Type | Description |
| Void |
SetRegistered(DateTime)
Declaration
Void SetRegistered(DateTime registered)Examples
NSSaleSummaryItem thing;
DateTime registered;
thing.SetRegistered(registered);Parameters
| Type | Name | Description |
| DateTime | registered | Registered date. |
Returns
| Type | Description |
| Void |
SetSaleDate(DateTime)
Declaration
Void SetSaleDate(DateTime )Examples
NSSaleSummaryItem thing;
DateTime saleDate;
thing.SetSaleDate(saleDate);Parameters
| Type | Name | Description |
| DateTime | saleDate | Expected sales date. |
Returns
| Type | Description |
| Void |
SetSaleId(Integer)
Declaration
Void SetSaleId(Integer saleId)Examples
NSSaleSummaryItem thing;
Integer saleId;
thing.SetSaleId(saleId);Parameters
| Type | Name | Description |
| Integer | saleId | Primary key. |
Returns
| Type | Description |
| Void |
SetStatus(Integer)
Declaration
Void SetStatus(Integer status)Examples
NSSaleSummaryItem thing;
Integer status;
thing.SetStatus(status);Parameters
| Type | Name | Description |
| Integer | status | The sale's status, indicating whether the sale is open(1), sold(2) or lost(3). See <xref href="CRMScript.NetServer.SaleStatus" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |