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

# <a id="SuperOffice_WebApi_Data_SaleTypeEntity" /> Class SaleTypeEntity

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

Carrier object for SaleTypeEntity.

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

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[SaleTypeEntity](SuperOffice.WebApi.Data.SaleTypeEntity.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 SaleTypeEntity 123 using the WebApi client:
<pre><code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new ListAgent(configuration);
var saleTypeEntity = agent.GetSaleTypeEntity( 123 );</code></pre>

## Constructors

### <a id="SuperOffice_WebApi_Data_SaleTypeEntity__ctor" /> SaleTypeEntity()

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_SaleTypeEntity_AllowQuoteAlternatives" /> AllowQuoteAlternatives

Can quotes linked to sales of this type, have multiple Alternatives

```csharp theme={null}
public virtual bool AllowQuoteAlternatives { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_SaleTypeEntity_ConfirmationLinesTemplate" /> ConfirmationLinesTemplate

The template that this sale type should use when producing the order confirmation lines document; the template must have DocTmplQuoteType=ConfirmationLines

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_SaleTypeEntity_DefaultQuoteValidity" /> DefaultQuoteValidity

Default valid days for quotes linked to sales of this type (valid from quote transmission)

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_SaleTypeEntity_Deleted" /> Deleted

0 -> record is active 1 -> record is 'deleted' and should not be shown in lists

```csharp theme={null}
public virtual bool Deleted { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_SaleTypeEntity_DurationUnit" /> DurationUnit

Units for the duration (day, week, whatever)
NULL if unknown enum value.

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

#### Property Value

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

#### See Also

[SaleTypeEntity](SuperOffice.WebApi.Data.SaleTypeEntity.md).[DurationUnit\_String](SuperOffice.WebApi.Data.SaleTypeEntity.md#SuperOffice_WebApi_Data_SaleTypeEntity_DurationUnit_String)

### <a id="SuperOffice_WebApi_Data_SaleTypeEntity_DurationUnit_String" /> DurationUnit\_String

Units for the duration (day, week, whatever)
Raw string enum value.

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

#### Property Value

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

#### See Also

[SaleTypeEntity](SuperOffice.WebApi.Data.SaleTypeEntity.md).[DurationUnit](SuperOffice.WebApi.Data.SaleTypeEntity.md#SuperOffice_WebApi_Data_SaleTypeEntity_DurationUnit)

### <a id="SuperOffice_WebApi_Data_SaleTypeEntity_GroupQuoteLinesBy" /> GroupQuoteLinesBy

Group quote lines by this field

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_SaleTypeEntity_HasGuide" /> HasGuide

Does this sale type have a guide attached

```csharp theme={null}
public virtual bool HasGuide { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_SaleTypeEntity_HasStakeholders" /> HasStakeholders

Does this sale type have stakeholders

```csharp theme={null}
public virtual bool HasStakeholders { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_SaleTypeEntity_IsAutoAdvance" /> IsAutoAdvance

Does the sale stage advance automatically, when the last guided activity in a stage is completed?

```csharp theme={null}
public virtual bool IsAutoAdvance { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_SaleTypeEntity_MaxDiscountPercent" /> MaxDiscountPercent

The maximum discount in percent of total, if set, on quotes linked to sales of this type

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_SaleTypeEntity_MaxDiscountPercentSet" /> MaxDiscountPercentSet

Is there a limit, in percent, to the total discount on quotes linked to sales of this type

```csharp theme={null}
public virtual bool MaxDiscountPercentSet { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_SaleTypeEntity_MinEarningPercent" /> MinEarningPercent

The minimum earning in percent of total, if set, on quotes linked to sales of this type

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_SaleTypeEntity_MinEarningPercentSet" /> MinEarningPercentSet

Is there a limit, in earning as percent of total, on quotes linked to sales of this type

```csharp theme={null}
public virtual bool MinEarningPercentSet { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_SaleTypeEntity_Name" /> Name

The list item

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_SaleTypeEntity_QuoteLinesTemplate" /> QuoteLinesTemplate

The template that this sale type should use when producing the product lines offer document; the template must have DocTmplQuoteType=QuoteLines

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_SaleTypeEntity_Rank" /> Rank

Rank order

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_SaleTypeEntity_SaleDuration" /> SaleDuration

Expected number of dales from initiation to close of sale

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_SaleTypeEntity_SaleTypeCatId" /> SaleTypeCatId

Category of sale type, copied to sale

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

#### Property Value

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

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

Primary key

```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_SaleTypeEntity_SortGroupLinesBy" /> SortGroupLinesBy

Sort group lines by this field

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_SaleTypeEntity_Stages" /> Stages

Stages, those associated with this SaleType are selected.
<p>Use MDO List name "salestage" to get list items.</p>

```csharp theme={null}
public virtual SelectableMDOListItem[] Stages { get; set; }
```

#### Property Value

[SelectableMDOListItem](SuperOffice.WebApi.Data.SelectableMDOListItem.md)\[]

### <a id="SuperOffice_WebApi_Data_SaleTypeEntity_Tooltip" /> Tooltip

Tooltip or other description

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

#### Property Value

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

## See Also

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


## Related topics

- [SuperOffice.WebApi.Agents.IListAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IListAgent.md)
- [SuperOffice.WebApi.Agents.ListAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ListAgent.md)
- [SuperOffice.WebApi.Data.List GetAllSaleTypeEntitiesRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.List_GetAllSaleTypeEntitiesRequest.md)
- [SuperOffice.WebApi.Data.SaleEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.SaleEntity.md)
- [SuperOffice.WebApi.Data.Carrier](/en/api/reference/webapi/SuperOffice.WebApi.Data.Carrier.md)
- [SuperOffice.WebApi.Data.TargetEntityType](/en/api/reference/webapi/SuperOffice.WebApi.Data.TargetEntityType.md)
