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

# SuperOffice.WebApi.Data.Sale

# <a id="SuperOffice_WebApi_Data_Sale" /> Class Sale

Namespace: [SuperOffice.WebApi.Data](SuperOffice.WebApi.Data.md)\
Assembly: SuperOffice.WebApi.dll

Carrier object for Sale.

```csharp theme={null}
public class Sale : Carrier
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[Sale](SuperOffice.WebApi.Data.Sale.md)

#### Inherited Members

[Carrier.TableRight](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_TableRight),
[Carrier.FieldProperties](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_FieldProperties),
[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Examples

Get Sale 123 using the WebApi client:
<pre><code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new SaleAgent(configuration);
var sale = agent.GetSale( 123 );</code></pre>

## Constructors

### <a id="SuperOffice_WebApi_Data_Sale__ctor" /> Sale()

Default constructor - defaults any enum props to 0.

```csharp theme={null}
public Sale()
```

## Properties

### <a id="SuperOffice_WebApi_Data_Sale_ActiveErpLinks" /> ActiveErpLinks

The number of active erp links

```csharp theme={null}
public virtual int ActiveErpLinks { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_Sale_Amount" /> Amount

Total sale amount

```csharp theme={null}
public virtual double Amount { get; set; }
```

#### Property Value

[double](https://learn.microsoft.com/dotnet/api/system.double)

### <a id="SuperOffice_WebApi_Data_Sale_AssociateFullName" /> AssociateFullName

The sale's owner

```csharp theme={null}
public virtual string AssociateFullName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Sale_AssociateId" /> AssociateId

The sale's owner id

```csharp theme={null}
public virtual int AssociateId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_Sale_Completed" /> Completed

The Sale completed state. The completed state is either Started or Completed. NotStarted is treated as Started. The value maps to the Done database field.
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public ActivityStatus? Completed { get; set; }
```

#### Property Value

[ActivityStatus](SuperOffice.WebApi.Data.ActivityStatus.md)?

#### See Also

[Sale](SuperOffice.WebApi.Data.Sale.md).[Completed\_String](SuperOffice.WebApi.Data.Sale.md#SuperOffice_WebApi_Data_Sale_Completed_String)

### <a id="SuperOffice_WebApi_Data_Sale_Completed_String" /> Completed\_String

The Sale completed state. The completed state is either Started or Completed. NotStarted is treated as Started. The value maps to the Done database field.
Raw string enum value.

```csharp theme={null}
[JsonProperty("Completed")]
public string Completed_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[Sale](SuperOffice.WebApi.Data.Sale.md).[Completed](SuperOffice.WebApi.Data.Sale.md#SuperOffice_WebApi_Data_Sale_Completed)

### <a id="SuperOffice_WebApi_Data_Sale_ContactId" /> ContactId

Optional contact reference

```csharp theme={null}
public virtual int ContactId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_Sale_ContactName" /> ContactName

Contact name

```csharp theme={null}
public virtual string ContactName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Sale_Currency" /> Currency

Currency the sale was made in.

```csharp theme={null}
public virtual string Currency { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Sale_Description" /> Description

The sales description

```csharp theme={null}
public virtual string Description { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Sale_Earning" /> Earning

Earning on sale

```csharp theme={null}
public virtual double Earning { get; set; }
```

#### Property Value

[double](https://learn.microsoft.com/dotnet/api/system.double)

### <a id="SuperOffice_WebApi_Data_Sale_EarningPercent" /> EarningPercent

Earning as percent of total

```csharp theme={null}
public virtual double EarningPercent { get; set; }
```

#### Property Value

[double](https://learn.microsoft.com/dotnet/api/system.double)

### <a id="SuperOffice_WebApi_Data_Sale_NextDueDate" /> NextDueDate

Next due date, this is a denormalization of 'closest future activity date, or most recent if no future activities'. Maintained by the system, but very convenient for searching.

```csharp theme={null}
public virtual DateTime NextDueDate { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

### <a id="SuperOffice_WebApi_Data_Sale_Number" /> Number

Alphanumeric user field

```csharp theme={null}
public virtual string Number { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Sale_PersonFullName" /> PersonFullName

The name of the person this sale belongs to.

```csharp theme={null}
public virtual string PersonFullName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Sale_PersonId" /> PersonId

The sale's contact persons id

```csharp theme={null}
public virtual int PersonId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_Sale_Probability" /> Probability

Actual probability, may differ from the one in the list

```csharp theme={null}
public virtual short Probability { get; set; }
```

#### Property Value

[short](https://learn.microsoft.com/dotnet/api/system.int16)

### <a id="SuperOffice_WebApi_Data_Sale_ProjectId" /> ProjectId

Optional project reference

```csharp theme={null}
public virtual int ProjectId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_Sale_ProjectName" /> ProjectName

Project name

```csharp theme={null}
public virtual string ProjectName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Sale_SaleDate" /> SaleDate

(expected / lost / won) sales date

```csharp theme={null}
public virtual DateTime SaleDate { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

### <a id="SuperOffice_WebApi_Data_Sale_SaleId" /> SaleId

Primary key

```csharp theme={null}
public virtual int SaleId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_Sale_SaleTypeId" /> SaleTypeId

The sale's type id

```csharp theme={null}
public virtual int SaleTypeId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_Sale_SaleTypeName" /> SaleTypeName

The sale's type name

```csharp theme={null}
public virtual string SaleTypeName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Sale_Status" /> Status

The sale's status, indicating wether the sale is open, sold or lost.
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public SaleStatus? Status { get; set; }
```

#### Property Value

[SaleStatus](SuperOffice.WebApi.Data.SaleStatus.md)?

#### See Also

[Sale](SuperOffice.WebApi.Data.Sale.md).[Status\_String](SuperOffice.WebApi.Data.Sale.md#SuperOffice_WebApi_Data_Sale_Status_String)

### <a id="SuperOffice_WebApi_Data_Sale_Status_String" /> Status\_String

The sale's status, indicating wether the sale is open, sold or lost.
Raw string enum value.

```csharp theme={null}
[JsonProperty("Status")]
public string Status_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[Sale](SuperOffice.WebApi.Data.Sale.md).[Status](SuperOffice.WebApi.Data.Sale.md#SuperOffice_WebApi_Data_Sale_Status)

### <a id="SuperOffice_WebApi_Data_Sale_Title" /> Title

Sale heading (short description?)

```csharp theme={null}
public virtual string Title { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Sale_WeightedAmount" /> WeightedAmount

The weighted amount ( amount \*  probability / 100)

```csharp theme={null}
public virtual double WeightedAmount { get; set; }
```

#### Property Value

[double](https://learn.microsoft.com/dotnet/api/system.double)

## See Also

[SaleAgent](SuperOffice.WebApi.Agents.SaleAgent.md)


## Related topics

- [SuperOffice.WebApi.Data.SaleEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.SaleEntity.md)
- [SuperOffice.WebApi.Data.Sale SaleHasQuoteRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Sale_SaleHasQuoteRequest.md)
- [SuperOffice.WebApi.Data.SaleStatus](/en/api/reference/webapi/SuperOffice.WebApi.Data.SaleStatus.md)
- [SuperOffice.WebApi.Data.Sale GetUpcomingSalesRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Sale_GetUpcomingSalesRequest.md)
- [SuperOffice.WebApi.Data.Sale GetRecentSalesRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Sale_GetRecentSalesRequest.md)
- [SuperOffice.WebApi.Data.Sale GetSaleStakeholdersRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Sale_GetSaleStakeholdersRequest.md)