Class NSSaleSummary

Syntax

Constructors

NSSaleSummary()

Initializes a new instance of the NSSaleSummary class.

Introduced or updated in version: 7

Declaration

NSSaleSummary

Methods

GetBaseCurrency()

Introduced or updated in version: 7

Declaration

String GetBaseCurrency()

Returns

Type	Description
String	Default currency for the installation.

Examples

NSSaleSummary thing;
String baseCurrency = thing.GetBaseCurrency();

GetCurrentOverdue()

Introduced or updated in version: 7

Declaration

Integer GetCurrentOverdue()

Returns

Type	Description
Integer	Number of all overdue sales within the period.

Examples

NSSaleSummary thing;
Integer currentOverdue = thing.GetCurrentOverdue();

GetCurrentOverdueTotalBaseCurrency()

Introduced or updated in version: 7

Declaration

Float GetCurrentOverdueTotalBaseCurrency()

Returns

Type	Description
Float	Summed amount for all overdue sales within the period in default currency for the installation.

Examples

NSSaleSummary thing;
Float currentOverdueTotalBaseCurrency = thing.GetCurrentOverdueTotalBaseCurrency();

GetCurrentOverdueTotalOwnCurrency()

Introduced or updated in version: 7

Declaration

Float GetCurrentOverdueTotalOwnCurrency()

Returns

Type	Description
Float	Summed amount for all overdue sales within the period in default currency for the current user.

Examples

NSSaleSummary thing;
Float currentOverdueTotalOwnCurrency = thing.GetCurrentOverdueTotalOwnCurrency();

GetCurrentOverdueWeightedBaseCurrency()

Introduced or updated in version: 7

Declaration

Float GetCurrentOverdueWeightedBaseCurrency()

Returns

Type	Description
Float	Weighted sum for all overdue sales within the period in default currency for the installation.

Examples

NSSaleSummary thing;
Float currentOverdueWeightedBaseCurrency = thing.GetCurrentOverdueWeightedBaseCurrency();

GetCurrentOverdueWeightedOwnCurrency()

Introduced or updated in version: 7

Declaration

Float GetCurrentOverdueWeightedOwnCurrency()

Returns

Type	Description
Float	Weighted sum for all overdue sales within the period in default currency for the current user.

Examples

NSSaleSummary thing;
Float currentOverdueWeightedOwnCurrency = thing.GetCurrentOverdueWeightedOwnCurrency();

GetFutureOpen()

Introduced or updated in version: 7

Declaration

Integer GetFutureOpen()

Returns

Type	Description
Integer	Number of all Future Pipe/All open sales with date after the period.

Examples

NSSaleSummary thing;
Integer futureOpen = thing.GetFutureOpen();

GetFutureOpenTotalBaseCurrency()

Introduced or updated in version: 7

Declaration

Float GetFutureOpenTotalBaseCurrency()

Returns

Type	Description
Float	Summed amount for all Future Pipe/All open sales with date after the period in default currency for the installation.

Examples

NSSaleSummary thing;
Float futureOpenTotalBaseCurrency = thing.GetFutureOpenTotalBaseCurrency();

GetFutureOpenTotalOwnCurrency()

Introduced or updated in version: 7

Declaration

Float GetFutureOpenTotalOwnCurrency()

Returns

Type	Description
Float	Summed amount for all Future Pipe/All open sales with date after the period in default currency for the current user.

Examples

NSSaleSummary thing;
Float futureOpenTotalOwnCurrency = thing.GetFutureOpenTotalOwnCurrency();

GetFutureOpenWeightedBaseCurrency()

Introduced or updated in version: 7

Declaration

Float GetFutureOpenWeightedBaseCurrency()

Returns

Type	Description
Float	Weighted sum for all Future Pipe/All open sales with date after the period in default currency for the installation.

Examples

NSSaleSummary thing;
Float futureOpenWeightedBaseCurrency = thing.GetFutureOpenWeightedBaseCurrency();

GetFutureOpenWeightedOwnCurrency()

Introduced or updated in version: 7

Declaration

Float GetFutureOpenWeightedOwnCurrency()

Returns

Type	Description
Float	Weighted sum for all Future Pipe/All open sales with date after the period in default currency for the current user.

Examples

NSSaleSummary thing;
Float futureOpenWeightedOwnCurrency = thing.GetFutureOpenWeightedOwnCurrency();

GetLost()

Introduced or updated in version: 7

Declaration

Integer GetLost()

Returns

Type	Description
Integer	Number of all lost within the period.

Examples

NSSaleSummary thing;
Integer lost = thing.GetLost();

GetLostTotalBaseCurrency()

Introduced or updated in version: 7

Declaration

Float GetLostTotalBaseCurrency()

Returns

Type	Description
Float	Summed amount for all lost within the period in default currency for the installation.

Examples

NSSaleSummary thing;
Float lostTotalBaseCurrency = thing.GetLostTotalBaseCurrency();

GetLostTotalOwnCurrency()

Introduced or updated in version: 7

Declaration

Float GetLostTotalOwnCurrency()

Returns

Type	Description
Float	Summed amount for all lost within the period in default currency for the current user.

Examples

NSSaleSummary thing;
Float lostTotalOwnCurrency = thing.GetLostTotalOwnCurrency();

GetOpen()

Introduced or updated in version: 7

Declaration

Integer GetOpen()

Returns

Type	Description
Integer	Number of all open within the period.

Examples

NSSaleSummary thing;
Integer open = thing.GetOpen();

GetOpenTotalBaseCurrency()

Introduced or updated in version: 7

Declaration

Float GetOpenTotalBaseCurrency()

Returns

Type	Description
Float	Summed amount for all open within the period in default currency for the installation.

Examples

NSSaleSummary thing;
Float openTotalBaseCurrency = thing.GetOpenTotalBaseCurrency();

GetOpenTotalOwnCurrency()

Introduced or updated in version: 7

Declaration

Float GetOpenTotalOwnCurrency()

Returns

Type	Description
Float	Summed amount for all open within the period in default currency for the current user.

Examples

NSSaleSummary thing;
Float openTotalOwnCurrency = thing.GetOpenTotalOwnCurrency();

GetOpenWeightedBaseCurrency()

Introduced or updated in version: 7

Declaration

Float GetOpenWeightedBaseCurrency()

Returns

Type	Description
Float	Weighted sum for all open within the period in default currency for the installation.

Examples

NSSaleSummary thing;
Float openWeightedBaseCurrency = thing.GetOpenWeightedBaseCurrency();

GetOpenWeightedOwnCurrency()

Introduced or updated in version: 7

Declaration

Float GetOpenWeightedOwnCurrency()

Returns

Type	Description
Float	Weighted sum for all open within the period in default currency for the current user.

Examples

NSSaleSummary thing;
Float openWeightedOwnCurrency = thing.GetOpenWeightedOwnCurrency();

GetOwnCurrency()

Introduced or updated in version: 7

Declaration

String GetOwnCurrency()

Returns

Type	Description
String	Default currency for the current user.

Examples

NSSaleSummary thing;
String ownCurrency = thing.GetOwnCurrency();

GetPreviousOverdue()

Introduced or updated in version: 7

Declaration

Integer GetPreviousOverdue()

Returns

Type	Description
Integer	Number of all open sales with date before this period.

Examples

NSSaleSummary thing;
Integer previousOverdue = thing.GetPreviousOverdue();

GetPreviousOverdueTotalBaseCurrency()

Introduced or updated in version: 7

Declaration

Float GetPreviousOverdueTotalBaseCurrency()

Returns

Type	Description
Float	Summed amount for all open sales with date before this period in default currency for the installation.

Examples

NSSaleSummary thing;
Float previousOverdueTotalBaseCurrency = thing.GetPreviousOverdueTotalBaseCurrency();

GetPreviousOverdueTotalOwnCurrency()

Introduced or updated in version: 7

Declaration

Float GetPreviousOverdueTotalOwnCurrency()

Returns

Type	Description
Float	Summed amount for all open sales with date before this period in default currency for the current user.

Examples

NSSaleSummary thing;
Float previousOverdueTotalOwnCurrency = thing.GetPreviousOverdueTotalOwnCurrency();

GetPreviousOverdueWeightedBaseCurrency()

Introduced or updated in version: 7

Declaration

Float GetPreviousOverdueWeightedBaseCurrency()

Returns

Type	Description
Float	Weighted sum for all open sales with date before this period in default currency for the installation.

Examples

NSSaleSummary thing;
Float previousOverdueWeightedBaseCurrency = thing.GetPreviousOverdueWeightedBaseCurrency();

GetPreviousOverdueWeightedOwnCurrency()

Introduced or updated in version: 7

Declaration

Float GetPreviousOverdueWeightedOwnCurrency()

Returns

Type	Description
Float	Weighted sum for all open sales with date before this period in default currency for the current user.

Examples

NSSaleSummary thing;
Float previousOverdueWeightedOwnCurrency = thing.GetPreviousOverdueWeightedOwnCurrency();

GetSold()

Introduced or updated in version: 7

Declaration

Integer GetSold()

Returns

Type	Description
Integer	Number of all sold within the period.

Examples

NSSaleSummary thing;
Integer sold = thing.GetSold();

GetSoldTotalBaseCurrency()

Introduced or updated in version: 7

Declaration

Float GetSoldTotalBaseCurrency()

Returns

Type	Description
Float	Summed amount for all sold within the period in default currency for the installation.

Examples

NSSaleSummary thing;
Float soldTotalBaseCurrency = thing.GetSoldTotalBaseCurrency();

GetSoldTotalOwnCurrency()

Introduced or updated in version: 7

Declaration

Float GetSoldTotalOwnCurrency()

Returns

Type	Description
Float	Summed amount for all sold within the period in default currency for the current user.

Examples

NSSaleSummary thing;
Float soldTotalOwnCurrency = thing.GetSoldTotalOwnCurrency();

SetBaseCurrency(String)

Introduced or updated in version: 7

Declaration

Void SetBaseCurrency(String baseCurrency)

Parameters

Type	Name	Description
String	baseCurrency	Default currency for the installation.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
String baseCurrency;
thing.SetBaseCurrency(baseCurrency);

SetCurrentOverdue(Integer)

Introduced or updated in version: 7

Declaration

Void SetCurrentOverdue(Integer currentOverdue)

Parameters

Type	Name	Description
Integer	currentOverdue	Number of all overdue sales within the period.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Integer currentOverdue;
thing.SetCurrentOverdue(currentOverdue);

SetCurrentOverdueTotalBaseCurrency(Float)

Introduced or updated in version: 7

Declaration

Void SetCurrentOverdueTotalBaseCurrency(Float currentOverdueTotalBaseCurrency)

Parameters

Type	Name	Description
Float	currentOverdueTotalBaseCurrency	Summed amount for all overdue sales within the period in default currency for the installation.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Float currentOverdueTotalBaseCurrency;
thing.SetCurrentOverdueTotalBaseCurrency(currentOverdueTotalBaseCurrency);

SetCurrentOverdueTotalOwnCurrency(Float)

Introduced or updated in version: 7

Declaration

Void SetCurrentOverdueTotalOwnCurrency(Float currentOverdueTotalOwnCurrency)

Parameters

Type	Name	Description
Float	currentOverdueTotalOwnCurrency	Summed amount for all overdue sales within the period in default currency for the current user.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Float currentOverdueTotalOwnCurrency;
thing.SetCurrentOverdueTotalOwnCurrency(currentOverdueTotalOwnCurrency);

SetCurrentOverdueWeightedBaseCurrency(Float)

Introduced or updated in version: 7

Declaration

Void SetCurrentOverdueWeightedBaseCurrency(Float currentOverdueWeightedBaseCurrency)

Parameters

Type	Name	Description
Float	currentOverdueWeightedBaseCurrency	Weighted sum for all overdue sales within the period in default currency for the installation.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Float currentOverdueWeightedBaseCurrency;
thing.SetCurrentOverdueWeightedBaseCurrency(currentOverdueWeightedBaseCurrency);

SetCurrentOverdueWeightedOwnCurrency(Float)

Introduced or updated in version: 7

Declaration

Void SetCurrentOverdueWeightedOwnCurrency(Float currentOverdueWeightedOwnCurrency)

Parameters

Type	Name	Description
Float	currentOverdueWeightedOwnCurrency	Weighted sum for all overdue sales within the period in default currency for the current user.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Float currentOverdueWeightedOwnCurrency;
thing.SetCurrentOverdueWeightedOwnCurrency(currentOverdueWeightedOwnCurrency);

SetFutureOpen(Integer)

Introduced or updated in version: 7

Declaration

Void SetFutureOpen(Integer futureOpen)

Parameters

Type	Name	Description
Integer	futureOpen	Number of all Future Pipe/All open sales with date after the period.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Integer futureOpen;
thing.SetFutureOpen(futureOpen);

SetFutureOpenTotalBaseCurrency(Float)

Introduced or updated in version: 7

Declaration

Void SetFutureOpenTotalBaseCurrency(Float futureOpenTotalBaseCurrency)

Parameters

Type	Name	Description
Float	futureOpenTotalBaseCurrency	Summed amount for all Future Pipe/All open sales with date after the period in default currency for the installation.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Float futureOpenTotalBaseCurrency;
thing.SetFutureOpenTotalBaseCurrency(futureOpenTotalBaseCurrency);

SetFutureOpenTotalOwnCurrency(Float)

Introduced or updated in version: 7

Declaration

Void SetFutureOpenTotalOwnCurrency(Float futureOpenTotalOwnCurrency)

Parameters

Type	Name	Description
Float	futureOpenTotalOwnCurrency	Summed amount for all Future Pipe/All open sales with date after the period in default currency for the current user.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Float futureOpenTotalOwnCurrency;
thing.SetFutureOpenTotalOwnCurrency(futureOpenTotalOwnCurrency);

SetFutureOpenWeightedBaseCurrency(Float)

Introduced or updated in version: 7

Declaration

Void SetFutureOpenWeightedBaseCurrency(Float futureOpenWeightedBaseCurrency)

Parameters

Type	Name	Description
Float	futureOpenWeightedBaseCurrency	Weighted sum for all Future Pipe/All open sales with date after the period in default currency for the installation.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Float futureOpenWeightedBaseCurrency;
thing.SetFutureOpenWeightedBaseCurrency(futureOpenWeightedBaseCurrency);

SetFutureOpenWeightedOwnCurrency(Float)

Introduced or updated in version: 7

Declaration

Void SetFutureOpenWeightedOwnCurrency(Float futureOpenWeightedOwnCurrency)

Parameters

Type	Name	Description
Float	futureOpenWeightedOwnCurrency	Weighted sum for all Future Pipe/All open sales with date after the period in default currency for the current user.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Float futureOpenWeightedOwnCurrency;
thing.SetFutureOpenWeightedOwnCurrency(futureOpenWeightedOwnCurrency);

SetLost(Integer)

Introduced or updated in version: 7

Declaration

Void SetLost(Integer lost)

Parameters

Type	Name	Description
Integer	lost	Number of all lost within the period.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Integer lost;
thing.SetLost(lost);

SetLostTotalBaseCurrency(Float)

Introduced or updated in version: 7

Declaration

Void SetLostTotalBaseCurrency(Float lostTotalBaseCurrency)

Parameters

Type	Name	Description
Float	lostTotalBaseCurrency	Summed amount for all lost within the period in default currency for the installation.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Float lostTotalBaseCurrency;
thing.SetLostTotalBaseCurrency(lostTotalBaseCurrency);

SetLostTotalOwnCurrency(Float)

Introduced or updated in version: 7

Declaration

Void SetLostTotalOwnCurrency(Float lostTotalOwnCurrency)

Parameters

Type	Name	Description
Float	lostTotalOwnCurrency	Summed amount for all lost within the period in default currency for the current user.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Float lostTotalOwnCurrency;
thing.SetLostTotalOwnCurrency(lostTotalOwnCurrency);

SetOpen(Integer)

Introduced or updated in version: 7

Declaration

Void SetOpen(Integer open)

Parameters

Type	Name	Description
Integer	open	Number of all open within the period.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Integer open;
thing.SetOpen(open);

SetOpenTotalBaseCurrency(Float)

Introduced or updated in version: 7

Declaration

Void SetOpenTotalBaseCurrency(Float openTotalBaseCurrency)

Parameters

Type	Name	Description
Float	openTotalBaseCurrency	Summed amount for all open within the period in default currency for the installation.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Float openTotalBaseCurrency;
thing.SetOpenTotalBaseCurrency(openTotalBaseCurrency);

SetOpenTotalOwnCurrency(Float)

Introduced or updated in version: 7

Declaration

Void SetOpenTotalOwnCurrency(Float openTotalOwnCurrency)

Parameters

Type	Name	Description
Float	openTotalOwnCurrency	Summed amount for all open within the period in default currency for the current user.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Float openTotalOwnCurrency;
thing.SetOpenTotalOwnCurrency(openTotalOwnCurrency);

SetOpenWeightedBaseCurrency(Float)

Introduced or updated in version: 7

Declaration

Void SetOpenWeightedBaseCurrency(Float openWeightedBaseCurrency)

Parameters

Type	Name	Description
Float	openWeightedBaseCurrency	Weighted sum for all open within the period in default currency for the installation.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Float openWeightedBaseCurrency;
thing.SetOpenWeightedBaseCurrency(openWeightedBaseCurrency);

SetOpenWeightedOwnCurrency(Float)

Introduced or updated in version: 7

Declaration

Void SetOpenWeightedOwnCurrency(Float openWeightedOwnCurrency)

Parameters

Type	Name	Description
Float	openWeightedOwnCurrency	Weighted sum for all open within the period in default currency for the current user.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Float openWeightedOwnCurrency;
thing.SetOpenWeightedOwnCurrency(openWeightedOwnCurrency);

SetOwnCurrency(String)

Introduced or updated in version: 7

Declaration

Void SetOwnCurrency(String ownCurrency)

Parameters

Type	Name	Description
String	ownCurrency	Default currency for the current user.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
String ownCurrency;
thing.SetOwnCurrency(ownCurrency);

SetPreviousOverdue(Integer)

Introduced or updated in version: 7

Declaration

Void SetPreviousOverdue(Integer previousOverdue)

Parameters

Type	Name	Description
Integer	previousOverdue	Number of all open sales with date before this period.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Integer previousOverdue;
thing.SetPreviousOverdue(previousOverdue);

SetPreviousOverdueTotalBaseCurrency(Float)

Introduced or updated in version: 7

Declaration

Void SetPreviousOverdueTotalBaseCurrency(Float previousOverdueTotalBaseCurrency)

Parameters

Type	Name	Description
Float	previousOverdueTotalBaseCurrency	Summed amount for all open sales with date before this period in default currency for the installation.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Float previousOverdueTotalBaseCurrency;
thing.SetPreviousOverdueTotalBaseCurrency(previousOverdueTotalBaseCurrency);

SetPreviousOverdueTotalOwnCurrency(Float)

Introduced or updated in version: 7

Declaration

Void SetPreviousOverdueTotalOwnCurrency(Float previousOverdueTotalOwnCurrency)

Parameters

Type	Name	Description
Float	previousOverdueTotalOwnCurrency	Summed amount for all open sales with date before this period in default currency for the current user.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Float previousOverdueTotalOwnCurrency;
thing.SetPreviousOverdueTotalOwnCurrency(previousOverdueTotalOwnCurrency);

SetPreviousOverdueWeightedBaseCurrency(Float)

Introduced or updated in version: 7

Declaration

Void SetPreviousOverdueWeightedBaseCurrency(Float previousOverdueWeightedBaseCurrency)

Parameters

Type	Name	Description
Float	previousOverdueWeightedBaseCurrency	Weighted sum for all open sales with date before this period in default currency for the installation.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Float previousOverdueWeightedBaseCurrency;
thing.SetPreviousOverdueWeightedBaseCurrency(previousOverdueWeightedBaseCurrency);

SetPreviousOverdueWeightedOwnCurrency(Float)

Introduced or updated in version: 7

Declaration

Void SetPreviousOverdueWeightedOwnCurrency(Float previousOverdueWeightedOwnCurrency)

Parameters

Type	Name	Description
Float	previousOverdueWeightedOwnCurrency	Weighted sum for all open sales with date before this period in default currency for the current user.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Float previousOverdueWeightedOwnCurrency;
thing.SetPreviousOverdueWeightedOwnCurrency(previousOverdueWeightedOwnCurrency);

SetSold(Integer)

Introduced or updated in version: 7

Declaration

Void SetSold(Integer sold)

Parameters

Type	Name	Description
Integer	sold	Number of all sold within the period.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Integer sold;
thing.SetSold(sold);

SetSoldTotalBaseCurrency(Float)

Introduced or updated in version: 7

Declaration

Void SetSoldTotalBaseCurrency(Float soldTotalBaseCurrency)

Parameters

Type	Name	Description
Float	soldTotalBaseCurrency	Summed amount for all sold within the period in default currency for the installation.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Float soldTotalBaseCurrency;
thing.SetSoldTotalBaseCurrency(soldTotalBaseCurrency);

SetSoldTotalOwnCurrency(Float)

Introduced or updated in version: 7

Declaration

Void SetSoldTotalOwnCurrency(Float soldTotalOwnCurrency)

Parameters

Type	Name	Description
Float	soldTotalOwnCurrency	Summed amount for all sold within the period in default currency for the current user.

Returns

Type	Description
Void

Examples

NSSaleSummary thing;
Float soldTotalOwnCurrency;
thing.SetSoldTotalOwnCurrency(soldTotalOwnCurrency);