> ## 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.

# NSSaleSummaryItem

> Sale Summary item.

Sale Summary item.

## Constructors

### NSSaleSummaryItem()

```crmscript theme={null}
NSSaleSummaryItem
```

Initializes a new instance of the NSSaleSummaryItem class.

## Methods

## GetAmount()

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

**Returns:** [CRMScript.Global.Float](CRMScript.Global.Float) - Total sale amount.

**Example:**

```crmscript theme={null}
NSSaleSummaryItem thing;
Float amount = thing.GetAmount();
```

## GetAmountInBaseCurrency()

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

**Returns:** [CRMScript.Global.Float](CRMScript.Global.Float) - Sale amount converted to the base currency.

**Example:**

```crmscript theme={null}
NSSaleSummaryItem thing;
Float amountInBaseCurrency = thing.GetAmountInBaseCurrency();
```

## GetCompleted()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The Completed state. NotStarted(1) or Completed(3). See \<xref href="CRMScript.NetServer.SaleStatus" data-throw-if-not-resolved="false">\</xref>.

**Example:**

```crmscript theme={null}
NSSaleSummaryItem thing;
Integer completed = thing.GetCompleted();
```

## GetCurrency()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - NSCurrency the sale amount is in.

**Example:**

```crmscript theme={null}
NSSaleSummaryItem thing;
String currency = thing.GetCurrency();
```

## GetHeading()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Sale heading (short description?).

**Example:**

```crmscript theme={null}
NSSaleSummaryItem thing;
String heading = thing.GetHeading();
```

## GetProbability()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Probability of sale success in percent (0-100).

**Example:**

```crmscript theme={null}
NSSaleSummaryItem thing;
Integer probability = thing.GetProbability();
```

## GetRegistered()

```crmscript theme={null}
DateTime GetRegistered()
```

**Returns:** [CRMScript.Global.DateTime](CRMScript.Global.DateTime) - Registered date.

**Example:**

```crmscript theme={null}
NSSaleSummaryItem thing;
DateTime registered = thing.GetRegistered();
```

## GetSaleDate()

```crmscript theme={null}
DateTime GetSaleDate()
```

**Returns:** [CRMScript.Global.DateTime](CRMScript.Global.DateTime) - Expected sales date.

**Example:**

```crmscript theme={null}
NSSaleSummaryItem thing;
DateTime saleDate = thing.GetSaleDate();
```

## GetSaleId()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Primary key.

**Example:**

```crmscript theme={null}
NSSaleSummaryItem thing;
Integer saleId = thing.GetSaleId();
```

## GetStatus()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.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>.

**Example:**

```crmscript theme={null}
NSSaleSummaryItem thing;
Integer status = thing.GetStatus();
```

## SetAmount(Float)

```crmscript theme={null}
Void SetAmount(Float amount)
```

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

**Example:**

```crmscript theme={null}
NSSaleSummaryItem thing;
Float amount;
thing.SetAmount(amount);
```

## SetAmountInBaseCurrency(Float)

```crmscript theme={null}
Void SetAmountInBaseCurrency(Float amountInBaseCurrency)
```

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

**Example:**

```crmscript theme={null}
NSSaleSummaryItem thing;
Float amountInBaseCurrency;
thing.SetAmountInBaseCurrency(amountInBaseCurrency);
```

## SetCompleted(Integer)

```crmscript theme={null}
Void SetCompleted(Integer completed)
```

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

**Example:**

```crmscript theme={null}
NSSaleSummaryItem thing;
Integer completed;
thing.SetCompleted(completed);
```

## SetCurrency(String)

```crmscript theme={null}
Void SetCurrency(String currency)
```

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

**Example:**

```crmscript theme={null}
NSSaleSummaryItem thing;
String currency;
thing.SetCurrency(currency);
```

## SetHeading(String)

```crmscript theme={null}
Void SetHeading(String heading)
```

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

**Example:**

```crmscript theme={null}
NSSaleSummaryItem thing;
String heading;
thing.SetHeading(heading);
```

## SetProbability(Integer)

```crmscript theme={null}
Void SetProbability(Integer probability)
```

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

**Example:**

```crmscript theme={null}
NSSaleSummaryItem thing;
Integer probability;
thing.SetProbability(probability);
```

## SetRegistered(DateTime)

```crmscript theme={null}
Void SetRegistered(DateTime registered)
```

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

**Example:**

```crmscript theme={null}
NSSaleSummaryItem thing;
DateTime registered;
thing.SetRegistered(registered);
```

## SetSaleDate(DateTime)

```crmscript theme={null}
Void SetSaleDate(DateTime )
```

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

**Example:**

```crmscript theme={null}
NSSaleSummaryItem thing;
DateTime saleDate;
thing.SetSaleDate(saleDate);
```

## SetSaleId(Integer)

```crmscript theme={null}
Void SetSaleId(Integer saleId)
```

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

**Example:**

```crmscript theme={null}
NSSaleSummaryItem thing;
Integer saleId;
thing.SetSaleId(saleId);
```

## SetStatus(Integer)

```crmscript theme={null}
Void SetStatus(Integer status)
```

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

**Example:**

```crmscript theme={null}
NSSaleSummaryItem thing;
Integer status;
thing.SetStatus(status);
```


## Related topics

- [NSContactSummary](/en/automation/crmscript/reference/CRMScript.NetServer.NSContactSummary.md)
- [NSPersonSummary](/en/automation/crmscript/reference/CRMScript.NetServer.NSPersonSummary.md)
- [SuperOffice.WebApi.Data.SaleSummaryItem](/en/api/reference/webapi/SuperOffice.WebApi.Data.SaleSummaryItem.md)
- [Summaries](/integrations/supernotes/summaries.md)
- [Get Person Summary](/en/api/reference/restful/rest/person/get-person-summary.md)