> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# NSSaleSummary

## Constructors

### NSSaleSummary()

```crmscript theme={null}
NSSaleSummary
```

Initializes a new instance of the NSSaleSummary class.

## Methods

## GetBaseCurrency()

```crmscript theme={null}
String GetBaseCurrency()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Default currency for the installation.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
String baseCurrency = thing.GetBaseCurrency();
```

## GetCurrentOverdue()

```crmscript theme={null}
Integer GetCurrentOverdue()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Number of all overdue sales within the period.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Integer currentOverdue = thing.GetCurrentOverdue();
```

## GetCurrentOverdueTotalBaseCurrency()

```crmscript theme={null}
Float GetCurrentOverdueTotalBaseCurrency()
```

**Returns:** [CRMScript.Global.Float](CRMScript.Global.Float) - Summed amount for all overdue sales within the period in default currency for the installation.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float currentOverdueTotalBaseCurrency = thing.GetCurrentOverdueTotalBaseCurrency();
```

## GetCurrentOverdueTotalOwnCurrency()

```crmscript theme={null}
Float GetCurrentOverdueTotalOwnCurrency()
```

**Returns:** [CRMScript.Global.Float](CRMScript.Global.Float) - Summed amount for all overdue sales within the period in default currency for the current user.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float currentOverdueTotalOwnCurrency = thing.GetCurrentOverdueTotalOwnCurrency();
```

## GetCurrentOverdueWeightedBaseCurrency()

```crmscript theme={null}
Float GetCurrentOverdueWeightedBaseCurrency()
```

**Returns:** [CRMScript.Global.Float](CRMScript.Global.Float) - Weighted sum for all overdue sales within the period in default currency for the installation.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float currentOverdueWeightedBaseCurrency = thing.GetCurrentOverdueWeightedBaseCurrency();
```

## GetCurrentOverdueWeightedOwnCurrency()

```crmscript theme={null}
Float GetCurrentOverdueWeightedOwnCurrency()
```

**Returns:** [CRMScript.Global.Float](CRMScript.Global.Float) - Weighted sum for all overdue sales within the period in default currency for the current user.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float currentOverdueWeightedOwnCurrency = thing.GetCurrentOverdueWeightedOwnCurrency();
```

## GetFutureOpen()

```crmscript theme={null}
Integer GetFutureOpen()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Number of all Future Pipe/All open sales with date after the period.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Integer futureOpen = thing.GetFutureOpen();
```

## GetFutureOpenTotalBaseCurrency()

```crmscript theme={null}
Float GetFutureOpenTotalBaseCurrency()
```

**Returns:** [CRMScript.Global.Float](CRMScript.Global.Float) - Summed amount for all Future Pipe/All open sales with date after the period in default currency for the installation.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float futureOpenTotalBaseCurrency = thing.GetFutureOpenTotalBaseCurrency();
```

## GetFutureOpenTotalOwnCurrency()

```crmscript theme={null}
Float GetFutureOpenTotalOwnCurrency()
```

**Returns:** [CRMScript.Global.Float](CRMScript.Global.Float) - Summed amount for all Future Pipe/All open sales with date after the period in default currency for the current user.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float futureOpenTotalOwnCurrency = thing.GetFutureOpenTotalOwnCurrency();
```

## GetFutureOpenWeightedBaseCurrency()

```crmscript theme={null}
Float GetFutureOpenWeightedBaseCurrency()
```

**Returns:** [CRMScript.Global.Float](CRMScript.Global.Float) - Weighted sum for all Future Pipe/All open sales with date after the period in default currency for the installation.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float futureOpenWeightedBaseCurrency = thing.GetFutureOpenWeightedBaseCurrency();
```

## GetFutureOpenWeightedOwnCurrency()

```crmscript theme={null}
Float GetFutureOpenWeightedOwnCurrency()
```

**Returns:** [CRMScript.Global.Float](CRMScript.Global.Float) - Weighted sum for all Future Pipe/All open sales with date after the period in default currency for the current user.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float futureOpenWeightedOwnCurrency = thing.GetFutureOpenWeightedOwnCurrency();
```

## GetLost()

```crmscript theme={null}
Integer GetLost()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Number of all lost within the period.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Integer lost = thing.GetLost();
```

## GetLostTotalBaseCurrency()

```crmscript theme={null}
Float GetLostTotalBaseCurrency()
```

**Returns:** [CRMScript.Global.Float](CRMScript.Global.Float) - Summed amount for all lost within the period in default currency for the installation.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float lostTotalBaseCurrency = thing.GetLostTotalBaseCurrency();
```

## GetLostTotalOwnCurrency()

```crmscript theme={null}
Float GetLostTotalOwnCurrency()
```

**Returns:** [CRMScript.Global.Float](CRMScript.Global.Float) - Summed amount for all lost within the period in default currency for the current user.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float lostTotalOwnCurrency = thing.GetLostTotalOwnCurrency();
```

## GetOpen()

```crmscript theme={null}
Integer GetOpen()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Number of all open within the period.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Integer open = thing.GetOpen();
```

## GetOpenTotalBaseCurrency()

```crmscript theme={null}
Float GetOpenTotalBaseCurrency()
```

**Returns:** [CRMScript.Global.Float](CRMScript.Global.Float) - Summed amount for all open within the period in default currency for the installation.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float openTotalBaseCurrency = thing.GetOpenTotalBaseCurrency();
```

## GetOpenTotalOwnCurrency()

```crmscript theme={null}
Float GetOpenTotalOwnCurrency()
```

**Returns:** [CRMScript.Global.Float](CRMScript.Global.Float) - Summed amount for all open within the period in default currency for the current user.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float openTotalOwnCurrency = thing.GetOpenTotalOwnCurrency();
```

## GetOpenWeightedBaseCurrency()

```crmscript theme={null}
Float GetOpenWeightedBaseCurrency()
```

**Returns:** [CRMScript.Global.Float](CRMScript.Global.Float) - Weighted sum for all open within the period in default currency for the installation.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float openWeightedBaseCurrency = thing.GetOpenWeightedBaseCurrency();
```

## GetOpenWeightedOwnCurrency()

```crmscript theme={null}
Float GetOpenWeightedOwnCurrency()
```

**Returns:** [CRMScript.Global.Float](CRMScript.Global.Float) - Weighted sum for all open within the period in default currency for the current user.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float openWeightedOwnCurrency = thing.GetOpenWeightedOwnCurrency();
```

## GetOwnCurrency()

```crmscript theme={null}
String GetOwnCurrency()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Default currency for the current user.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
String ownCurrency = thing.GetOwnCurrency();
```

## GetPreviousOverdue()

```crmscript theme={null}
Integer GetPreviousOverdue()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Number of all open sales with date before this period.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Integer previousOverdue = thing.GetPreviousOverdue();
```

## GetPreviousOverdueTotalBaseCurrency()

```crmscript theme={null}
Float GetPreviousOverdueTotalBaseCurrency()
```

**Returns:** [CRMScript.Global.Float](CRMScript.Global.Float) - Summed amount for all open sales with date before this period in default currency for the installation.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float previousOverdueTotalBaseCurrency = thing.GetPreviousOverdueTotalBaseCurrency();
```

## GetPreviousOverdueTotalOwnCurrency()

```crmscript theme={null}
Float GetPreviousOverdueTotalOwnCurrency()
```

**Returns:** [CRMScript.Global.Float](CRMScript.Global.Float) - Summed amount for all open sales with date before this period in default currency for the current user.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float previousOverdueTotalOwnCurrency = thing.GetPreviousOverdueTotalOwnCurrency();
```

## GetPreviousOverdueWeightedBaseCurrency()

```crmscript theme={null}
Float GetPreviousOverdueWeightedBaseCurrency()
```

**Returns:** [CRMScript.Global.Float](CRMScript.Global.Float) - Weighted sum for all open sales with date before this period in default currency for the installation.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float previousOverdueWeightedBaseCurrency = thing.GetPreviousOverdueWeightedBaseCurrency();
```

## GetPreviousOverdueWeightedOwnCurrency()

```crmscript theme={null}
Float GetPreviousOverdueWeightedOwnCurrency()
```

**Returns:** [CRMScript.Global.Float](CRMScript.Global.Float) - Weighted sum for all open sales with date before this period in default currency for the current user.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float previousOverdueWeightedOwnCurrency = thing.GetPreviousOverdueWeightedOwnCurrency();
```

## GetSold()

```crmscript theme={null}
Integer GetSold()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Number of all sold within the period.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Integer sold = thing.GetSold();
```

## GetSoldTotalBaseCurrency()

```crmscript theme={null}
Float GetSoldTotalBaseCurrency()
```

**Returns:** [CRMScript.Global.Float](CRMScript.Global.Float) - Summed amount for all sold within the period in default currency for the installation.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float soldTotalBaseCurrency = thing.GetSoldTotalBaseCurrency();
```

## GetSoldTotalOwnCurrency()

```crmscript theme={null}
Float GetSoldTotalOwnCurrency()
```

**Returns:** [CRMScript.Global.Float](CRMScript.Global.Float) - Summed amount for all sold within the period in default currency for the current user.

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float soldTotalOwnCurrency = thing.GetSoldTotalOwnCurrency();
```

## SetBaseCurrency(String)

```crmscript theme={null}
Void SetBaseCurrency(String baseCurrency)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
String baseCurrency;
thing.SetBaseCurrency(baseCurrency);
```

## SetCurrentOverdue(Integer)

```crmscript theme={null}
Void SetCurrentOverdue(Integer currentOverdue)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Integer currentOverdue;
thing.SetCurrentOverdue(currentOverdue);
```

## SetCurrentOverdueTotalBaseCurrency(Float)

```crmscript theme={null}
Void SetCurrentOverdueTotalBaseCurrency(Float currentOverdueTotalBaseCurrency)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float currentOverdueTotalBaseCurrency;
thing.SetCurrentOverdueTotalBaseCurrency(currentOverdueTotalBaseCurrency);
```

## SetCurrentOverdueTotalOwnCurrency(Float)

```crmscript theme={null}
Void SetCurrentOverdueTotalOwnCurrency(Float currentOverdueTotalOwnCurrency)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float currentOverdueTotalOwnCurrency;
thing.SetCurrentOverdueTotalOwnCurrency(currentOverdueTotalOwnCurrency);
```

## SetCurrentOverdueWeightedBaseCurrency(Float)

```crmscript theme={null}
Void SetCurrentOverdueWeightedBaseCurrency(Float currentOverdueWeightedBaseCurrency)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float currentOverdueWeightedBaseCurrency;
thing.SetCurrentOverdueWeightedBaseCurrency(currentOverdueWeightedBaseCurrency);
```

## SetCurrentOverdueWeightedOwnCurrency(Float)

```crmscript theme={null}
Void SetCurrentOverdueWeightedOwnCurrency(Float currentOverdueWeightedOwnCurrency)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float currentOverdueWeightedOwnCurrency;
thing.SetCurrentOverdueWeightedOwnCurrency(currentOverdueWeightedOwnCurrency);
```

## SetFutureOpen(Integer)

```crmscript theme={null}
Void SetFutureOpen(Integer futureOpen)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Integer futureOpen;
thing.SetFutureOpen(futureOpen);
```

## SetFutureOpenTotalBaseCurrency(Float)

```crmscript theme={null}
Void SetFutureOpenTotalBaseCurrency(Float futureOpenTotalBaseCurrency)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float futureOpenTotalBaseCurrency;
thing.SetFutureOpenTotalBaseCurrency(futureOpenTotalBaseCurrency);
```

## SetFutureOpenTotalOwnCurrency(Float)

```crmscript theme={null}
Void SetFutureOpenTotalOwnCurrency(Float futureOpenTotalOwnCurrency)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float futureOpenTotalOwnCurrency;
thing.SetFutureOpenTotalOwnCurrency(futureOpenTotalOwnCurrency);
```

## SetFutureOpenWeightedBaseCurrency(Float)

```crmscript theme={null}
Void SetFutureOpenWeightedBaseCurrency(Float futureOpenWeightedBaseCurrency)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float futureOpenWeightedBaseCurrency;
thing.SetFutureOpenWeightedBaseCurrency(futureOpenWeightedBaseCurrency);
```

## SetFutureOpenWeightedOwnCurrency(Float)

```crmscript theme={null}
Void SetFutureOpenWeightedOwnCurrency(Float futureOpenWeightedOwnCurrency)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float futureOpenWeightedOwnCurrency;
thing.SetFutureOpenWeightedOwnCurrency(futureOpenWeightedOwnCurrency);
```

## SetLost(Integer)

```crmscript theme={null}
Void SetLost(Integer lost)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Integer lost;
thing.SetLost(lost);
```

## SetLostTotalBaseCurrency(Float)

```crmscript theme={null}
Void SetLostTotalBaseCurrency(Float lostTotalBaseCurrency)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float lostTotalBaseCurrency;
thing.SetLostTotalBaseCurrency(lostTotalBaseCurrency);
```

## SetLostTotalOwnCurrency(Float)

```crmscript theme={null}
Void SetLostTotalOwnCurrency(Float lostTotalOwnCurrency)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float lostTotalOwnCurrency;
thing.SetLostTotalOwnCurrency(lostTotalOwnCurrency);
```

## SetOpen(Integer)

```crmscript theme={null}
Void SetOpen(Integer open)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Integer open;
thing.SetOpen(open);
```

## SetOpenTotalBaseCurrency(Float)

```crmscript theme={null}
Void SetOpenTotalBaseCurrency(Float openTotalBaseCurrency)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float openTotalBaseCurrency;
thing.SetOpenTotalBaseCurrency(openTotalBaseCurrency);
```

## SetOpenTotalOwnCurrency(Float)

```crmscript theme={null}
Void SetOpenTotalOwnCurrency(Float openTotalOwnCurrency)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float openTotalOwnCurrency;
thing.SetOpenTotalOwnCurrency(openTotalOwnCurrency);
```

## SetOpenWeightedBaseCurrency(Float)

```crmscript theme={null}
Void SetOpenWeightedBaseCurrency(Float openWeightedBaseCurrency)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float openWeightedBaseCurrency;
thing.SetOpenWeightedBaseCurrency(openWeightedBaseCurrency);
```

## SetOpenWeightedOwnCurrency(Float)

```crmscript theme={null}
Void SetOpenWeightedOwnCurrency(Float openWeightedOwnCurrency)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float openWeightedOwnCurrency;
thing.SetOpenWeightedOwnCurrency(openWeightedOwnCurrency);
```

## SetOwnCurrency(String)

```crmscript theme={null}
Void SetOwnCurrency(String ownCurrency)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
String ownCurrency;
thing.SetOwnCurrency(ownCurrency);
```

## SetPreviousOverdue(Integer)

```crmscript theme={null}
Void SetPreviousOverdue(Integer previousOverdue)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Integer previousOverdue;
thing.SetPreviousOverdue(previousOverdue);
```

## SetPreviousOverdueTotalBaseCurrency(Float)

```crmscript theme={null}
Void SetPreviousOverdueTotalBaseCurrency(Float previousOverdueTotalBaseCurrency)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float previousOverdueTotalBaseCurrency;
thing.SetPreviousOverdueTotalBaseCurrency(previousOverdueTotalBaseCurrency);
```

## SetPreviousOverdueTotalOwnCurrency(Float)

```crmscript theme={null}
Void SetPreviousOverdueTotalOwnCurrency(Float previousOverdueTotalOwnCurrency)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float previousOverdueTotalOwnCurrency;
thing.SetPreviousOverdueTotalOwnCurrency(previousOverdueTotalOwnCurrency);
```

## SetPreviousOverdueWeightedBaseCurrency(Float)

```crmscript theme={null}
Void SetPreviousOverdueWeightedBaseCurrency(Float previousOverdueWeightedBaseCurrency)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float previousOverdueWeightedBaseCurrency;
thing.SetPreviousOverdueWeightedBaseCurrency(previousOverdueWeightedBaseCurrency);
```

## SetPreviousOverdueWeightedOwnCurrency(Float)

```crmscript theme={null}
Void SetPreviousOverdueWeightedOwnCurrency(Float previousOverdueWeightedOwnCurrency)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float previousOverdueWeightedOwnCurrency;
thing.SetPreviousOverdueWeightedOwnCurrency(previousOverdueWeightedOwnCurrency);
```

## SetSold(Integer)

```crmscript theme={null}
Void SetSold(Integer sold)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Integer sold;
thing.SetSold(sold);
```

## SetSoldTotalBaseCurrency(Float)

```crmscript theme={null}
Void SetSoldTotalBaseCurrency(Float soldTotalBaseCurrency)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float soldTotalBaseCurrency;
thing.SetSoldTotalBaseCurrency(soldTotalBaseCurrency);
```

## SetSoldTotalOwnCurrency(Float)

```crmscript theme={null}
Void SetSoldTotalOwnCurrency(Float soldTotalOwnCurrency)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSSaleSummary thing;
Float soldTotalOwnCurrency;
thing.SetSoldTotalOwnCurrency(soldTotalOwnCurrency);
```


## Related topics

- [NSSaleAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSSaleAgent.md)
- [Retrieve a sale](/en/automation/crmscript/howto/sale/get.md)
- [NSSaleSummaryItem](/en/automation/crmscript/reference/CRMScript.NetServer.NSSaleSummaryItem.md)
- [NSContactSummary](/en/automation/crmscript/reference/CRMScript.NetServer.NSContactSummary.md)
- [NSPersonSummary](/en/automation/crmscript/reference/CRMScript.NetServer.NSPersonSummary.md)
- [Create Default Sale Summary](/en/api/reference/restful/agent/sale_agent/create-default-sale-summary.md)