Class NSSaleSummary

Constructors

NSSaleSummary()

Initializes a new instance of the NSSaleSummary class.

Declaration

NSSaleSummary

Methods

GetBaseCurrency()

Declaration

String GetBaseCurrency()

Examples

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

Returns

Type Description
String Default currency for the installation.

GetCurrentOverdue()

Declaration

Integer GetCurrentOverdue()

Examples

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

Returns

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

GetCurrentOverdueTotalBaseCurrency()

Declaration

Float GetCurrentOverdueTotalBaseCurrency()

Examples

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

Returns

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

GetCurrentOverdueTotalOwnCurrency()

Declaration

Float GetCurrentOverdueTotalOwnCurrency()

Examples

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

Returns

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

GetCurrentOverdueWeightedBaseCurrency()

Declaration

Float GetCurrentOverdueWeightedBaseCurrency()

Examples

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

Returns

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

GetCurrentOverdueWeightedOwnCurrency()

Declaration

Float GetCurrentOverdueWeightedOwnCurrency()

Examples

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

Returns

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

GetFutureOpen()

Declaration

Integer GetFutureOpen()

Examples

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

Returns

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

GetFutureOpenTotalBaseCurrency()

Declaration

Float GetFutureOpenTotalBaseCurrency()

Examples

NSSaleSummary thing;
Float futureOpenTotalBaseCurrency = thing.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.

GetFutureOpenTotalOwnCurrency()

Declaration

Float GetFutureOpenTotalOwnCurrency()

Examples

NSSaleSummary thing;
Float futureOpenTotalOwnCurrency = thing.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.

GetFutureOpenWeightedBaseCurrency()

Declaration

Float GetFutureOpenWeightedBaseCurrency()

Examples

NSSaleSummary thing;
Float futureOpenWeightedBaseCurrency = thing.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.

GetFutureOpenWeightedOwnCurrency()

Declaration

Float GetFutureOpenWeightedOwnCurrency()

Examples

NSSaleSummary thing;
Float futureOpenWeightedOwnCurrency = thing.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.

GetLost()

Declaration

Integer GetLost()

Examples

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

Returns

Type Description
Integer Number of all lost within the period.

GetLostTotalBaseCurrency()

Declaration

Float GetLostTotalBaseCurrency()

Examples

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

Returns

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

GetLostTotalOwnCurrency()

Declaration

Float GetLostTotalOwnCurrency()

Examples

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

Returns

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

GetOpen()

Declaration

Integer GetOpen()

Examples

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

Returns

Type Description
Integer Number of all open within the period.

GetOpenTotalBaseCurrency()

Declaration

Float GetOpenTotalBaseCurrency()

Examples

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

Returns

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

GetOpenTotalOwnCurrency()

Declaration

Float GetOpenTotalOwnCurrency()

Examples

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

Returns

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

GetOpenWeightedBaseCurrency()

Declaration

Float GetOpenWeightedBaseCurrency()

Examples

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

Returns

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

GetOpenWeightedOwnCurrency()

Declaration

Float GetOpenWeightedOwnCurrency()

Examples

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

Returns

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

GetOwnCurrency()

Declaration

String GetOwnCurrency()

Examples

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

Returns

Type Description
String Default currency for the current user.

GetPreviousOverdue()

Declaration

Integer GetPreviousOverdue()

Examples

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

Returns

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

GetPreviousOverdueTotalBaseCurrency()

Declaration

Float GetPreviousOverdueTotalBaseCurrency()

Examples

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

Returns

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

GetPreviousOverdueTotalOwnCurrency()

Declaration

Float GetPreviousOverdueTotalOwnCurrency()

Examples

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

Returns

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

GetPreviousOverdueWeightedBaseCurrency()

Declaration

Float GetPreviousOverdueWeightedBaseCurrency()

Examples

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

Returns

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

GetPreviousOverdueWeightedOwnCurrency()

Declaration

Float GetPreviousOverdueWeightedOwnCurrency()

Examples

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

Returns

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

GetSold()

Declaration

Integer GetSold()

Examples

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

Returns

Type Description
Integer Number of all sold within the period.

GetSoldTotalBaseCurrency()

Declaration

Float GetSoldTotalBaseCurrency()

Examples

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

Returns

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

GetSoldTotalOwnCurrency()

Declaration

Float GetSoldTotalOwnCurrency()

Examples

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

Returns

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

SetBaseCurrency(String)

Declaration

Void SetBaseCurrency(String baseCurrency)

Examples

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

Parameters

Type Name Description
String baseCurrency Default currency for the installation.

Returns

Type Description
Void

SetCurrentOverdue(Integer)

Declaration

Void SetCurrentOverdue(Integer currentOverdue)

Examples

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

Parameters

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

Returns

Type Description
Void

SetCurrentOverdueTotalBaseCurrency(Float)

Declaration

Void SetCurrentOverdueTotalBaseCurrency(Float currentOverdueTotalBaseCurrency)

Examples

NSSaleSummary thing;
Float currentOverdueTotalBaseCurrency;
thing.SetCurrentOverdueTotalBaseCurrency(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

SetCurrentOverdueTotalOwnCurrency(Float)

Declaration

Void SetCurrentOverdueTotalOwnCurrency(Float currentOverdueTotalOwnCurrency)

Examples

NSSaleSummary thing;
Float currentOverdueTotalOwnCurrency;
thing.SetCurrentOverdueTotalOwnCurrency(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

SetCurrentOverdueWeightedBaseCurrency(Float)

Declaration

Void SetCurrentOverdueWeightedBaseCurrency(Float currentOverdueWeightedBaseCurrency)

Examples

NSSaleSummary thing;
Float currentOverdueWeightedBaseCurrency;
thing.SetCurrentOverdueWeightedBaseCurrency(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

SetCurrentOverdueWeightedOwnCurrency(Float)

Declaration

Void SetCurrentOverdueWeightedOwnCurrency(Float currentOverdueWeightedOwnCurrency)

Examples

NSSaleSummary thing;
Float currentOverdueWeightedOwnCurrency;
thing.SetCurrentOverdueWeightedOwnCurrency(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

SetFutureOpen(Integer)

Declaration

Void SetFutureOpen(Integer futureOpen)

Examples

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

Parameters

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

Returns

Type Description
Void

SetFutureOpenTotalBaseCurrency(Float)

Declaration

Void SetFutureOpenTotalBaseCurrency(Float futureOpenTotalBaseCurrency)

Examples

NSSaleSummary thing;
Float futureOpenTotalBaseCurrency;
thing.SetFutureOpenTotalBaseCurrency(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

SetFutureOpenTotalOwnCurrency(Float)

Declaration

Void SetFutureOpenTotalOwnCurrency(Float futureOpenTotalOwnCurrency)

Examples

NSSaleSummary thing;
Float futureOpenTotalOwnCurrency;
thing.SetFutureOpenTotalOwnCurrency(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

SetFutureOpenWeightedBaseCurrency(Float)

Declaration

Void SetFutureOpenWeightedBaseCurrency(Float futureOpenWeightedBaseCurrency)

Examples

NSSaleSummary thing;
Float futureOpenWeightedBaseCurrency;
thing.SetFutureOpenWeightedBaseCurrency(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

SetFutureOpenWeightedOwnCurrency(Float)

Declaration

Void SetFutureOpenWeightedOwnCurrency(Float futureOpenWeightedOwnCurrency)

Examples

NSSaleSummary thing;
Float futureOpenWeightedOwnCurrency;
thing.SetFutureOpenWeightedOwnCurrency(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

SetLost(Integer)

Declaration

Void SetLost(Integer lost)

Examples

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

Parameters

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

Returns

Type Description
Void

SetLostTotalBaseCurrency(Float)

Declaration

Void SetLostTotalBaseCurrency(Float lostTotalBaseCurrency)

Examples

NSSaleSummary thing;
Float lostTotalBaseCurrency;
thing.SetLostTotalBaseCurrency(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

SetLostTotalOwnCurrency(Float)

Declaration

Void SetLostTotalOwnCurrency(Float lostTotalOwnCurrency)

Examples

NSSaleSummary thing;
Float lostTotalOwnCurrency;
thing.SetLostTotalOwnCurrency(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

SetOpen(Integer)

Declaration

Void SetOpen(Integer open)

Examples

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

Parameters

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

Returns

Type Description
Void

SetOpenTotalBaseCurrency(Float)

Declaration

Void SetOpenTotalBaseCurrency(Float openTotalBaseCurrency)

Examples

NSSaleSummary thing;
Float openTotalBaseCurrency;
thing.SetOpenTotalBaseCurrency(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

SetOpenTotalOwnCurrency(Float)

Declaration

Void SetOpenTotalOwnCurrency(Float openTotalOwnCurrency)

Examples

NSSaleSummary thing;
Float openTotalOwnCurrency;
thing.SetOpenTotalOwnCurrency(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

SetOpenWeightedBaseCurrency(Float)

Declaration

Void SetOpenWeightedBaseCurrency(Float openWeightedBaseCurrency)

Examples

NSSaleSummary thing;
Float openWeightedBaseCurrency;
thing.SetOpenWeightedBaseCurrency(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

SetOpenWeightedOwnCurrency(Float)

Declaration

Void SetOpenWeightedOwnCurrency(Float openWeightedOwnCurrency)

Examples

NSSaleSummary thing;
Float openWeightedOwnCurrency;
thing.SetOpenWeightedOwnCurrency(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

SetOwnCurrency(String)

Declaration

Void SetOwnCurrency(String ownCurrency)

Examples

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

Parameters

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

Returns

Type Description
Void

SetPreviousOverdue(Integer)

Declaration

Void SetPreviousOverdue(Integer previousOverdue)

Examples

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

Parameters

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

Returns

Type Description
Void

SetPreviousOverdueTotalBaseCurrency(Float)

Declaration

Void SetPreviousOverdueTotalBaseCurrency(Float previousOverdueTotalBaseCurrency)

Examples

NSSaleSummary thing;
Float previousOverdueTotalBaseCurrency;
thing.SetPreviousOverdueTotalBaseCurrency(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

SetPreviousOverdueTotalOwnCurrency(Float)

Declaration

Void SetPreviousOverdueTotalOwnCurrency(Float previousOverdueTotalOwnCurrency)

Examples

NSSaleSummary thing;
Float previousOverdueTotalOwnCurrency;
thing.SetPreviousOverdueTotalOwnCurrency(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

SetPreviousOverdueWeightedBaseCurrency(Float)

Declaration

Void SetPreviousOverdueWeightedBaseCurrency(Float previousOverdueWeightedBaseCurrency)

Examples

NSSaleSummary thing;
Float previousOverdueWeightedBaseCurrency;
thing.SetPreviousOverdueWeightedBaseCurrency(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

SetPreviousOverdueWeightedOwnCurrency(Float)

Declaration

Void SetPreviousOverdueWeightedOwnCurrency(Float previousOverdueWeightedOwnCurrency)

Examples

NSSaleSummary thing;
Float previousOverdueWeightedOwnCurrency;
thing.SetPreviousOverdueWeightedOwnCurrency(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

SetSold(Integer)

Declaration

Void SetSold(Integer sold)

Examples

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

Parameters

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

Returns

Type Description
Void

SetSoldTotalBaseCurrency(Float)

Declaration

Void SetSoldTotalBaseCurrency(Float soldTotalBaseCurrency)

Examples

NSSaleSummary thing;
Float soldTotalBaseCurrency;
thing.SetSoldTotalBaseCurrency(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

SetSoldTotalOwnCurrency(Float)

Declaration

Void SetSoldTotalOwnCurrency(Float soldTotalOwnCurrency)

Examples

NSSaleSummary thing;
Float soldTotalOwnCurrency;
thing.SetSoldTotalOwnCurrency(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