Class QuoteAlternative

Information about a connection to the ERP system.

Carrier object for QuoteAlternative. Services for the QuoteAlternative Carrier is available from the Quote Agent.
Inheritance
object
QuoteAlternative
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.1.0.0")]
public class QuoteAlternative : Carrier
Examples

Get QuoteAlternative 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   var agent = new QuoteAgent();
   var quoteAlternative = agent.GetQuoteAlternative( 123 );
}

Constructors

QuoteAlternative()

Default constructor

Declaration
public QuoteAlternative()
See Also

Properties

Description

The tool-tip to use in the user interface (on the tab, for instance).

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

DiscountAmount

The discount the sales rep specifies, in whatever currency the sale is in. Both the two ‘DiscountPercent’ and ‘DiscountAmount’ shall be filled out, but the UserValueOverride field must be set to the field the user actually changed. If this field is filled out by the user, it overrides the discount suggested by the connector. If the user has not filled any values, the system will copy the ERP discount amount value into this field.

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

DiscountPercent

The discount the sales rep specifies, in percent. Both the two ‘DiscountPercent’ and ‘DiscountAmount’ shall be filled out, but the UserValueOverride field must be set to the field the user actually changed. If this field is filled out by the user, it overrides the discount suggested by the connector. If the user has not filled any values, the system will copy the ERP discount percent value into this field. The Percentage is given in integer form, i.e. ‘12%’ is represented as ‘12’.

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

ERPDiscountAmount

The discount the system calculates based on customer /amount / whatever. Can be overridden by the user in the field ‘DiscountPercent’ or ‘DiscountAmount’. Both the two ‘ERPDiscountPercent’ and ‘ERPDiscountAmount’ shall be filled out. If UserValueOverride is 'None', then the ERPDiscountAmount shall be copied into DiscountAmount and ERPDiscountPercent into DiscountPercent.

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

ERPDiscountPercent

The discount the system calculates based on customer /amount / whatever. Can be overridden by the sales rep in the field ‘DiscountPercent’ or ‘DiscountAmount’. Both the two ‘ERPDiscountPercent’ and ‘ERPDiscountAmount’ shall be filled out. If UserValueOverride is 'None', then the ERPDiscountAmount shall be copied into DiscountAmount and ERPDiscountPercent into DiscountPercent. The Percentage is given in integer form, i.e. ‘12%’ is represented as ‘12’.

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

ERPQuoteAlternativeKey

Key that identifies this alternative in the ERP system, if it exists there.

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

EarningAmount

Earning on this alternative, as an absolute amount

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

EarningPercent

The earning on this alternative, in percent of total. The Percentage is given in integer form, i.e. ‘12%’ is represented as ‘12’.

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

ExtraField1

Optional information added by Quote Connector; usable in the quote document merge process

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

ExtraField2

Optional information added by Quote Connector; usable in the quote document merge process

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

ExtraField3

Optional information added by Quote Connector; usable in the quote document merge process

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

ExtraField4

Optional information added by Quote Connector; usable in the quote document merge process

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

ExtraField5

Optional information added by Quote Connector; usable in the quote document merge process

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

Name

Name of Alternative. Shown in tab in user interface, intentionally kept short

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

QuoteAlternativeId

Primary key

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

QuoteVersionId

The version that owns this alternative (the chain is Sale 1->1 Quote 1->+ QuoteVersion 1->+ QuoteAlternative.

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

Reason

If there was a problem, this field contains a localized explanation of the problem and possible steps to fix it that the user can be shown.

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

Status

If there was a problem with for instance calculation, this field is set to warning or error.

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

SubTotal

Value to help the user interface, is computed by summing the totalprice of the quotelines, and NOT by summing their subtotals

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

TotalPrice

Sum of the QuoteLines.TotalPrice - AlternativeDiscount or QuoteLines.TotalCost + Earning based on what, if anything, the user has entered last. Shall be calculated by the connector.

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

UserValueOverride

Has the pre-calculated (from ERP) price information been overridden, and how. If the user has filled out the discountpercentage field, then the UserValueOverride field is set to OverridePercent. (The DiscountAmount, EarningPercent, EarningAmount and TotalPrice fields are calculated based on the discountPercent.)

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

VAT

Tax/VAT - THIS IS AN AMOUNT, available as a merge field in the quote document. The SuperOffice quote connector will calculate this field based on the vat PERCENTAGES on the individual lines; other connectors may implement other algorithms at will.

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

VATInfo

Extra info about VAT that the connector might insert. This field has no business logic in the CRM code, but is available as a merge field in the quote documents.

Declaration
[DataMember]
public virtual string VATInfo { get; set; }
Property Value
Type Description
string
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