Class NSSaleSummaryItem

Sale Summary item.

Syntax

Constructors

NSSaleSummaryItem()

Initializes a new instance of the NSSaleSummaryItem class.

Introduced or updated in version: 8.5R08

Declaration

NSSaleSummaryItem

Methods

GetAmount()

Introduced or updated in version: 8.5R08

Declaration

Float GetAmount()

Returns

Type	Description
Float	Total sale amount.

Examples

NSSaleSummaryItem thing;
Float amount = thing.GetAmount();

GetAmountInBaseCurrency()

Introduced or updated in version: 8.5R08

Declaration

Float GetAmountInBaseCurrency()

Returns

Type	Description
Float	Sale amount converted to the base currency.

Examples

NSSaleSummaryItem thing;
Float amountInBaseCurrency = thing.GetAmountInBaseCurrency();

GetCompleted()

Introduced or updated in version: 8.5R08

Declaration

Integer GetCompleted()

Returns

Type	Description
Integer	The Completed state. NotStarted(1) or Completed(3). See SaleStatus.

Examples

NSSaleSummaryItem thing;
Integer completed = thing.GetCompleted();

GetCurrency()

Introduced or updated in version: 8.5R08

Declaration

String GetCurrency()

Returns

Type	Description
String	NSCurrency the sale amount is in.

Examples

NSSaleSummaryItem thing;
String currency = thing.GetCurrency();

GetHeading()

Introduced or updated in version: 8.5R08

Declaration

String GetHeading()

Returns

Type	Description
String	Sale heading (short description?).

Examples

NSSaleSummaryItem thing;
String heading = thing.GetHeading();

GetProbability()

Introduced or updated in version: 8.5R08

Declaration

Integer GetProbability()

Returns

Type	Description
Integer	Probability of sale success in percent (0-100).

Examples

NSSaleSummaryItem thing;
Integer probability = thing.GetProbability();

GetRegistered()

Introduced or updated in version: 8.5R08

Declaration

DateTime GetRegistered()

Returns

Type	Description
DateTime	Registered date.

Examples

NSSaleSummaryItem thing;
DateTime registered = thing.GetRegistered();

GetSaleDate()

Introduced or updated in version: 8.5R08

Declaration

DateTime GetSaleDate()

Returns

Type	Description
DateTime	Expected sales date.

Examples

NSSaleSummaryItem thing;
DateTime saleDate = thing.GetSaleDate();

GetSaleId()

Introduced or updated in version: 8.5R08

Declaration

Integer GetSaleId()

Returns

Type	Description
Integer	Primary key.

Examples

NSSaleSummaryItem thing;
Integer saleId = thing.GetSaleId();

GetStatus()

Introduced or updated in version: 8.5R08

Declaration

Integer GetStatus()

Returns

Type	Description
Integer	The sale's status, indicating whether the sale is open(1), sold(2) or lost(3). See SaleStatus.

Examples

NSSaleSummaryItem thing;
Integer status = thing.GetStatus();

SetAmount(Float)

Introduced or updated in version: 8.5R08

Declaration

Void SetAmount(Float amount)

Parameters

Type	Name	Description
Float	amount	Total sale amount.

Returns

Type	Description
Void

Examples

NSSaleSummaryItem thing;
Float amount;
thing.SetAmount(amount);

SetAmountInBaseCurrency(Float)

Introduced or updated in version: 8.5R08

Declaration

Void SetAmountInBaseCurrency(Float amountInBaseCurrency)

Parameters

Type	Name	Description
Float	amountInBaseCurrency	Sale amount converted to the base currency.

Returns

Type	Description
Void

Examples

NSSaleSummaryItem thing;
Float amountInBaseCurrency;
thing.SetAmountInBaseCurrency(amountInBaseCurrency);

SetCompleted(Integer)

Introduced or updated in version: 8.5R08

Declaration

Void SetCompleted(Integer completed)

Parameters

Type	Name	Description
Integer	completed	The Completed state. NotStarted(1) or Completed(3).

Returns

Type	Description
Void

Examples

NSSaleSummaryItem thing;
Integer completed;
thing.SetCompleted(completed);

SetCurrency(String)

Introduced or updated in version: 8.5R08

Declaration

Void SetCurrency(String currency)

Parameters

Type	Name	Description
String	currency	NSCurrency the sale amount is in.

Returns

Type	Description
Void

Examples

NSSaleSummaryItem thing;
String currency;
thing.SetCurrency(currency);

SetHeading(String)

Introduced or updated in version: 8.5R08

Declaration

Void SetHeading(String heading)

Parameters

Type	Name	Description
String	heading	Sale heading (short description?).

Returns

Type	Description
Void

Examples

NSSaleSummaryItem thing;
String heading;
thing.SetHeading(heading);

SetProbability(Integer)

Introduced or updated in version: 8.5R08

Declaration

Void SetProbability(Integer probability)

Parameters

Type	Name	Description
Integer	probability	Probability of sale success in percent (0-100).

Returns

Type	Description
Void

Examples

NSSaleSummaryItem thing;
Integer probability;
thing.SetProbability(probability);

SetRegistered(DateTime)

Introduced or updated in version: 8.5R08

Declaration

Void SetRegistered(DateTime registered)

Parameters

Type	Name	Description
DateTime	registered	Registered date.

Returns

Type	Description
Void

Examples

NSSaleSummaryItem thing;
DateTime registered;
thing.SetRegistered(registered);

SetSaleDate(DateTime)

Introduced or updated in version: 8.5R08

Declaration

Void SetSaleDate(DateTime )

Parameters

Type	Name	Description
DateTime	saleDate	Expected sales date.

Returns

Type	Description
Void

Examples

NSSaleSummaryItem thing;
DateTime saleDate;
thing.SetSaleDate(saleDate);

SetSaleId(Integer)

Introduced or updated in version: 8.5R08

Declaration

Void SetSaleId(Integer saleId)

Parameters

Type	Name	Description
Integer	saleId	Primary key.

Returns

Type	Description
Void

Examples

NSSaleSummaryItem thing;
Integer saleId;
thing.SetSaleId(saleId);

SetStatus(Integer)

Introduced or updated in version: 8.5R08

Declaration

Void SetStatus(Integer status)

Parameters

Type	Name	Description
Integer	status	The sale's status, indicating whether the sale is open(1), sold(2) or lost(3). See SaleStatus.

Returns

Type	Description
Void

Examples

NSSaleSummaryItem thing;
Integer status;
thing.SetStatus(status);