Class SaleTypeEntity

Carrier object for SaleTypeEntity. Services for the SaleTypeEntity Carrier is available from the IListAgent.

Inheritance
Object
SaleTypeEntity
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class SaleTypeEntity : Carrier
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }

Constructors

SaleTypeEntity()

Default constructor

Declaration
public SaleTypeEntity()
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }
See Also

Properties

AllowQuoteAlternatives

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

Declaration
public virtual bool AllowQuoteAlternatives { get; set; }
Property Value
Type Description
Boolean
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }
See Also

ConfirmationLinesTemplate

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

Declaration
public virtual int ConfirmationLinesTemplate { get; set; }
Property Value
Type Description
Int32
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }
See Also

DefaultQuoteValidity

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

Declaration
public virtual int DefaultQuoteValidity { get; set; }
Property Value
Type Description
Int32
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }
See Also

Deleted

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

Declaration
public virtual bool Deleted { get; set; }
Property Value
Type Description
Boolean
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }
See Also

DurationUnit

Units for the duration (day, week, whatever)

Declaration
public virtual DurationUnit DurationUnit { get; set; }
Property Value
Type Description
DurationUnit
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }
See Also

GroupQuoteLinesBy

Group quote lines by this field

Declaration
public virtual int GroupQuoteLinesBy { get; set; }
Property Value
Type Description
Int32
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }
See Also

HasGuide

Does this sale type have a guide attached

Declaration
public virtual bool HasGuide { get; set; }
Property Value
Type Description
Boolean
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }
See Also

HasStakeholders

Does this sale type have stakeholders

Declaration
public virtual bool HasStakeholders { get; set; }
Property Value
Type Description
Boolean
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }
See Also

IsAutoAdvance

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

Declaration
public virtual bool IsAutoAdvance { get; set; }
Property Value
Type Description
Boolean
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }
See Also

MaxDiscountPercent

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

Declaration
public virtual int MaxDiscountPercent { get; set; }
Property Value
Type Description
Int32
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }
See Also

MaxDiscountPercentSet

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

Declaration
public virtual bool MaxDiscountPercentSet { get; set; }
Property Value
Type Description
Boolean
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }
See Also

MinEarningPercent

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

Declaration
public virtual int MinEarningPercent { get; set; }
Property Value
Type Description
Int32
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }
See Also

MinEarningPercentSet

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

Declaration
public virtual bool MinEarningPercentSet { get; set; }
Property Value
Type Description
Boolean
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }
See Also

Name

The list item

Declaration
public virtual string Name { get; set; }
Property Value
Type Description
String
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }
See Also

QuoteLinesTemplate

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

Declaration
public virtual int QuoteLinesTemplate { get; set; }
Property Value
Type Description
Int32
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }
See Also

Rank

Rank order

Declaration
public virtual short Rank { get; set; }
Property Value
Type Description
Int16
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }
See Also

SaleDuration

Expected number of dales from initiation to close of sale

Declaration
public virtual int SaleDuration { get; set; }
Property Value
Type Description
Int32
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }
See Also

SaleTypeCatId

Category of sale type, copied to sale

Declaration
public virtual int SaleTypeCatId { get; set; }
Property Value
Type Description
Int32
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }
See Also

SaleTypeId

Primary key

Declaration
public virtual int SaleTypeId { get; set; }
Property Value
Type Description
Int32
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }
See Also

SortGroupLinesBy

Sort group lines by this field

Declaration
public virtual int SortGroupLinesBy { get; set; }
Property Value
Type Description
Int32
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }
See Also

Stages

Stages, those associated with this SaleType are selected.

Use MDO List name "salestage" to get list items.

Declaration
public virtual SelectableMDOListItem[] Stages { get; set; }
Property Value
Type Description
SelectableMDOListItem[]
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }
See Also

Tooltip

Tooltip or other description

Declaration
public virtual string Tooltip { get; set; }
Property Value
Type Description
String
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
String

The carrier contents.
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }
See Also

ToString(String)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
String prefix

The line prefix (typically used for indenting)
Returns
Type Description
String

The carrier contents.
Examples

Get SaleTypeEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var saleTypeEntity = agent.GetSaleTypeEntity( 123 );
 }
See Also

See Also