Class Sale

Carrier object for Sale. Services for the Sale Carrier is available from the Sale Agent.

Inheritance
object
Sale
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.1.0.0")]
public class Sale : Carrier
Examples

Get Sale 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   var agent = new SaleAgent();
   var sale = agent.GetSale( 123 );
}

Constructors

Sale()

Default constructor

Declaration
public Sale()
See Also

Properties

The number of active erp links

Declaration
[DataMember]
public virtual int ActiveErpLinks { get; set; }
Property Value
Type Description
int

Amount

Total sale amount

Declaration
[DataMember]
public virtual double Amount { get; set; }
Property Value
Type Description
double
See Also

AssociateFullName

The sale's owner

Declaration
[DataMember]
public virtual string AssociateFullName { get; set; }
Property Value
Type Description
string
See Also

AssociateId

The sale's owner id

Declaration
[DataMember]
public virtual int AssociateId { get; set; }
Property Value
Type Description
int
See Also

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.

Declaration
[DataMember]
public virtual ActivityStatus Completed { get; set; }
Property Value
Type Description
ActivityStatus
See Also

ContactId

Optional contact reference

Declaration
[DataMember]
public virtual int ContactId { get; set; }
Property Value
Type Description
int
See Also

ContactName

Contact name

Declaration
[DataMember]
public virtual string ContactName { get; set; }
Property Value
Type Description
string
See Also

Currency

Currency the sale was made in.

Declaration
[DataMember]
public virtual string Currency { get; set; }
Property Value
Type Description
string
See Also

Description

The sales description

Declaration
[DataMember]
public virtual string Description { get; set; }
Property Value
Type Description
string
See Also

Earning

Earning on sale

Declaration
[DataMember]
public virtual double Earning { get; set; }
Property Value
Type Description
double
See Also

EarningPercent

Earning as percent of total

Declaration
[DataMember]
public virtual double EarningPercent { get; set; }
Property Value
Type Description
double
See Also

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.

Declaration
[DataMember]
public virtual DateTime NextDueDate { get; set; }
Property Value
Type Description
DateTime
See Also

Number

Alphanumeric user field

Declaration
[DataMember]
public virtual string Number { get; set; }
Property Value
Type Description
string
See Also

PersonFullName

The name of the person this sale belongs to.

Declaration
[DataMember]
public virtual string PersonFullName { get; set; }
Property Value
Type Description
string
See Also

PersonId

The sale's contact persons id

Declaration
[DataMember]
public virtual int PersonId { get; set; }
Property Value
Type Description
int
See Also

Probability

Actual probability, may differ from the one in the list

Declaration
[DataMember]
public virtual short Probability { get; set; }
Property Value
Type Description
short
See Also

ProjectId

Optional project reference

Declaration
[DataMember]
public virtual int ProjectId { get; set; }
Property Value
Type Description
int
See Also

ProjectName

Project name

Declaration
[DataMember]
public virtual string ProjectName { get; set; }
Property Value
Type Description
string
See Also

SaleDate

(expected / lost / won) sales date

Declaration
[DataMember]
public virtual DateTime SaleDate { get; set; }
Property Value
Type Description
DateTime
See Also

SaleId

Primary key

Declaration
[DataMember]
public virtual int SaleId { get; set; }
Property Value
Type Description
int
See Also

SaleTypeId

The sale's type id

Declaration
[DataMember]
public virtual int SaleTypeId { get; set; }
Property Value
Type Description
int
See Also

SaleTypeName

The sale's type name

Declaration
[DataMember]
public virtual string SaleTypeName { get; set; }
Property Value
Type Description
string
See Also

Status

The sale's status, indicating wether the sale is open, sold or lost.

Declaration
[DataMember]
public virtual SaleStatus Status { get; set; }
Property Value
Type Description
SaleStatus
See Also

Title

Sale heading (short description?)

Declaration
[DataMember]
public virtual string Title { get; set; }
Property Value
Type Description
string
See Also

WeightedAmount

The weighted amount ( amount * probability / 100)

Declaration
[DataMember]
public virtual double WeightedAmount { get; set; }
Property Value
Type Description
double
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.
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.
See Also

See Also