Class Sale
Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for Sale.
Inheritance
object ←
Carrier ←
Sale
Inherited Members
Carrier.TableRight,
Carrier.FieldProperties,
object.ToString(),
object.Equals(object),
object.Equals(object, object),
object.ReferenceEquals(object, object),
object.GetHashCode(),
object.GetType(),
object.MemberwiseClone()
Examples
Get Sale 123 using the WebApi client:
var configuration = new WebApiConfiguration(url);
var agent = new SaleAgent(configuration);
var sale = agent.GetSale( 123 );
Constructors
Sale()
Default constructor - defaults any enum props to 0.
Properties
ActiveErpLinks
The number of active erp links
Property Value
int
Amount
Total sale amount
Property Value
double
AssociateFullName
The sale’s owner
Property Value
string
AssociateId
The sale’s owner id
Property Value
int
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.
Property Value
ActivityStatus?
See Also
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.
Property Value
string
See Also
Sale.Completed
Optional contact reference
Property Value
int
Contact name
Property Value
string
Currency
Currency the sale was made in.
Property Value
string
Description
The sales description
Property Value
string
Earning
Earning on sale
Property Value
double
EarningPercent
Earning as percent of total
Property Value
double
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.
Property Value
DateTime
Number
Alphanumeric user field
Property Value
string
PersonFullName
The name of the person this sale belongs to.
Property Value
string
PersonId
The sale’s contact persons id
Property Value
int
Probability
Actual probability, may differ from the one in the list
Property Value
short
ProjectId
Optional project reference
Property Value
int
ProjectName
Project name
Property Value
string
SaleDate
(expected / lost / won) sales date
Property Value
DateTime
SaleId
Primary key
Property Value
int
SaleTypeId
The sale’s type id
Property Value
int
SaleTypeName
The sale’s type name
Property Value
string
Status
The sale’s status, indicating wether the sale is open, sold or lost.
NULL if unknown enum value.
Property Value
SaleStatus?
See Also
Sale.Status_String
Status_String
The sale’s status, indicating wether the sale is open, sold or lost.
Raw string enum value.
Property Value
string
See Also
Sale.Status
Title
Sale heading (short description?)
Property Value
string
WeightedAmount
The weighted amount ( amount * probability / 100)
Property Value
double
See Also
SaleAgent
