Class NSQuoteAlternative

Information about a connection to the ERP system.

Constructors

NSQuoteAlternative()

Initializes a new instance of the NSQuoteAlternative class.

Declaration

NSQuoteAlternative

Methods

GetDescription()

Declaration

String GetDescription()

Examples

NSQuoteAlternative thing;
String description = thing.GetDescription();

Returns

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

GetDiscountAmount()

Declaration

Float GetDiscountAmount()

Examples

NSQuoteAlternative thing;
Float discountAmount = thing.GetDiscountAmount();

Returns

Type Description
Float The discount the sales rep specifies, in whatever currency the sale is in.

GetDiscountPercent()

Declaration

Float GetDiscountPercent()

Examples

NSQuoteAlternative thing;
Float discountPercent = thing.GetDiscountPercent();

Returns

Type Description
Float The discount the sales rep specifies, in percent. '12%' is represented as '12'.

GetEarningAmount()

Declaration

Float GetEarningAmount()

Examples

NSQuoteAlternative thing;
Float earningAmount = thing.GetEarningAmount();

Returns

Type Description
Float Earning on this alternative, as an absolute amount.

GetEarningPercent()

Declaration

Float GetEarningPercent()

Examples

NSQuoteAlternative thing;
Float earningPercent = thing.GetEarningPercent();

Returns

Type Description
Float The earning on this alternative, in percent of total. The Percentage is given in integer form, '12%' is represented as '12'.

GetERPDiscountAmount()

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

Float GetERPDiscountAmount()

Examples

NSQuoteAlternative thing;
Float eRPDiscountAmount = thing.GetERPDiscountAmount();

Returns

Type Description
Float The discount the system calculates based on customer /amount / whatever.

GetERPDiscountPercent()

Declaration

Float GetERPDiscountPercent()

Examples

NSQuoteAlternative thing;
Float eRPDiscountPercent = thing.GetERPDiscountPercent();

Returns

Type Description
Float The discount the system calculates based on customer /amount / whatever. The Percentage is given in integer form, '12%' is represented as '12'.

GetERPQuoteAlternativeKey()

Declaration

String GetERPQuoteAlternativeKey()

Examples

NSQuoteAlternative thing;
String eRPQuoteAlternativeKey = thing.GetERPQuoteAlternativeKey();

Returns

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

GetExtraField1()

Declaration

String GetExtraField1()

Examples

NSQuoteAlternative thing;
String extraField1 = thing.GetExtraField1();

Returns

Type Description
String Optional information added by Quote Connector; usable in the quote document merge process.

GetExtraField2()

Declaration

String GetExtraField2()

Examples

NSQuoteAlternative thing;
String extraField2 = thing.GetExtraField2();

Returns

Type Description
String Optional information added by Quote Connector; usable in the quote document merge process.

GetExtraField3()

Declaration

String GetExtraField3()

Examples

NSQuoteAlternative thing;
String extraField3 = thing.GetExtraField3();

Returns

Type Description
String Optional information added by Quote Connector; usable in the quote document merge process.

GetExtraField4()

Declaration

String GetExtraField4()

Examples

NSQuoteAlternative thing;
String extraField4 = thing.GetExtraField4();

Returns

Type Description
String Optional information added by Quote Connector; usable in the quote document merge process.

GetExtraField5()

Declaration

String GetExtraField5()

Examples

NSQuoteAlternative thing;
String extraField5 = thing.GetExtraField5();

Returns

Type Description
String Optional information added by Quote Connector; usable in the quote document merge process.

GetName()

Declaration

String GetName()

Examples

NSQuoteAlternative thing;
String name = thing.GetName();

Returns

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

GetQuoteAlternativeId()

Declaration

Integer GetQuoteAlternativeId()

Examples

NSQuoteAlternative thing;
Integer quoteAlternativeId = thing.GetQuoteAlternativeId();

Returns

Type Description
Integer Primary key.

GetQuoteVersionId()

Declaration

Integer GetQuoteVersionId()

Examples

NSQuoteAlternative thing;
Integer quoteVersionId = thing.GetQuoteVersionId();

Returns

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

GetReason()

Declaration

String GetReason()

Examples

NSQuoteAlternative thing;
String reason = thing.GetReason();

Returns

Type Description
String 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.

GetStatus()

Declaration

Integer GetStatus()

Examples

NSQuoteAlternative thing;
Integer status = thing.GetStatus();

Returns

Type Description
Integer If there was a problem with for instance calculation, this field is set to warning or error. See <xref href="CRMScript.NetServer.QuoteStatus" data-throw-if-not-resolved="false"></xref>.

GetSubTotal()

Declaration

Float GetSubTotal()

Examples

NSQuoteAlternative thing;
Float subTotal = thing.GetSubTotal();

Returns

Type Description
Float Value to help the user interface, is computed by summing the total price of the quote lines, and NOT by summing their subtotals.

GetTotalPrice()

Declaration

Float GetTotalPrice()

Examples

NSQuoteAlternative thing;
Float totalPrice = thing.GetTotalPrice();

Returns

Type Description
Float 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.

GetUserValueOverride()

Declaration

Integer GetUserValueOverride()

Examples

NSQuoteAlternative thing;
Integer userValueOverride = thing.GetUserValueOverride();

Returns

Type Description
Integer Has the pre-calculated (from ERP) price information been overridden, and how. See <xref href="CRMScript.NetServer.ValueOverride" data-throw-if-not-resolved="false"></xref>.

GetVAT()

Declaration

Float GetVAT()

Examples

NSQuoteAlternative thing;
Float vAT = thing.GetVAT();

Returns

Type Description
Float Tax/VAT, THIS IS AN AMOUNT, available as a merge field in the quote document.

GetVATInfo()

Declaration

String GetVATInfo()

Examples

NSQuoteAlternative thing;
String vATInfo = thing.GetVATInfo();

Returns

Type Description
String Extra info about VAT that the connector might insert.

SetDescription(String)

Declaration

Void SetDescription(String description)

Examples

NSQuoteAlternative thing;
String description;
thing.SetDescription(description);

Parameters

Type Name Description
String description The tool-tip to use in the user interface (on the tab, for instance).

Returns

Type Description
Void

SetDiscountAmount(Float)

Declaration

Void SetDiscountAmount(Float discountAmount)

Examples

NSQuoteAlternative thing;
Float discountAmount;
thing.SetDiscountAmount(discountAmount);

Parameters

Type Name Description
Float 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.

Returns

Type Description
Void

SetDiscountPercent(Float)

Declaration

Void SetDiscountPercent(Float discountPercent)

Examples

NSQuoteAlternative thing;
Float discountPercent;
thing.SetDiscountPercent(discountPercent);

Parameters

Type Name Description
Float discountPercent The discount the sales rep specifies, in percent. The Percentage is given in integer form, i.e. '12%' is represented as '12'. Both the two 'DiscountPercent' and 'DiscountAmount' shall be filled out, but the UserValueOverride field must be set to the field the user actually changed.

Returns

Type Description
Void

SetEarningAmount(Float)

Declaration

Void SetEarningAmount(Float earningAmount)

Examples

NSQuoteAlternative thing;
Float earningAmount;
thing.SetEarningAmount(earningAmount);

Parameters

Type Name Description
Float earningAmount Earning on this alternative, as an absolute amount.

Returns

Type Description
Void

SetEarningPercent(Float)

Declaration

Void SetEarningPercent(Float earningPercent)

Examples

NSQuoteAlternative thing;
Float earningPercent;
thing.SetEarningPercent(earningPercent);

Parameters

Type Name Description
Float earningPercent The earning on this alternative, in percent of total. The Percentage is given in integer form, i.e. '12%' is represented as '12'.

Returns

Type Description
Void

SetERPDiscountAmount(Float)

Declaration

Void SetERPDiscountAmount(Float eRPDiscountAmount)

Examples

NSQuoteAlternative thing;
Float eRPDiscountAmount;
thing.SetERPDiscountAmount(eRPDiscountAmount);

Parameters

Type Name Description
Float eRPDiscountAmount The discount the system calculates based on customer /amount / whatever.

Returns

Type Description
Void

SetERPDiscountPercent(Float)

Declaration

Void SetERPDiscountPercent(Float eRPDiscountPercent)

Examples

NSQuoteAlternative thing;
Float eRPDiscountPercent;
thing.SetERPDiscountPercent(eRPDiscountPercent);

Parameters

Type Name Description
Float eRPDiscountPercent The discount the system calculates based on customer /amount / whatever. The Percentage is given in integer form, i.e. '12%' is represented as '12'.

Returns

Type Description
Void

SetERPQuoteAlternativeKey(String)

Declaration

Void SetERPQuoteAlternativeKey(String eRPQuoteAlternativeKey)

Examples

NSQuoteAlternative thing;
String eRPQuoteAlternativeKey;
thing.SetERPQuoteAlternativeKey(eRPQuoteAlternativeKey);

Parameters

Type Name Description
String eRPQuoteAlternativeKey Key that identifies this alternative in the ERP system, if it exists there.

Returns

Type Description
Void

SetExtraField1(String)

Declaration

Void SetExtraField1(String extraField1)

Examples

NSQuoteAlternative thing;
String extraField1;
thing.SetExtraField1(extraField1);

Parameters

Type Name Description
String extraField1 Optional information added by Quote Connector; usable in the quote document merge process.

Returns

Type Description
Void

SetExtraField2(String)

Declaration

Void SetExtraField2(String extraField2)

Examples

NSQuoteAlternative thing;
String extraField2;
thing.SetExtraField2(extraField2);

Parameters

Type Name Description
String extraField2 Optional information added by Quote Connector; usable in the quote document merge process.

Returns

Type Description
Void

SetExtraField3(String)

Declaration

Void SetExtraField3(String extraField3)

Examples

NSQuoteAlternative thing;
String extraField3;
thing.SetExtraField3(extraField3);

Parameters

Type Name Description
String extraField3 Optional information added by Quote Connector; usable in the quote document merge process.

Returns

Type Description
Void

SetExtraField4(String)

Declaration

Void SetExtraField4(String extraField4)

Examples

NSQuoteAlternative thing;
String extraField4;
thing.SetExtraField4(extraField4);

Parameters

Type Name Description
String extraField4 Optional information added by Quote Connector; usable in the quote document merge process.

Returns

Type Description
Void

SetExtraField5(String)

Declaration

Void SetExtraField5(String extraField5)

Examples

NSQuoteAlternative thing;
String extraField5;
thing.SetExtraField5(extraField5);

Parameters

Type Name Description
String extraField5 Optional information added by Quote Connector; usable in the quote document merge process.

Returns

Type Description
Void

SetName(String)

Declaration

Void SetName(String name)

Examples

NSQuoteAlternative thing;
String name;
thing.SetName(name);

Parameters

Type Name Description
String name Name of Alternative. Shown in tab in user interface, intentionally kept short.

Returns

Type Description
Void

SetQuoteAlternativeId(Integer)

Declaration

Void SetQuoteAlternativeId(Integer quoteAlternativeId)

Examples

NSQuoteAlternative thing;
Integer quoteAlternativeId;
thing.SetQuoteAlternativeId(quoteAlternativeId);

Parameters

Type Name Description
Integer quoteAlternativeId Primary key.

Returns

Type Description
Void

SetQuoteVersionId(Integer)

Declaration

Void SetQuoteVersionId(Integer quoteVersionId)

Examples

NSQuoteAlternative thing;
Integer quoteVersionId;
thing.SetQuoteVersionId(quoteVersionId);

Parameters

Type Name Description
Integer quoteVersionId The version that owns this alternative (the chain is Sale 1-&gt;1 Quote 1-&gt;+ QuoteVersion 1-&gt;+ QuoteAlternative.

Returns

Type Description
Void

SetReason(String)

Declaration

Void SetReason(String reason)

Examples

NSQuoteAlternative thing;
String reason;
thing.SetReason(reason);

Parameters

Type Name Description
String 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.

Returns

Type Description
Void

SetStatus(Integer)

Declaration

Void SetStatus(Integer status)

Examples

NSQuoteAlternative thing;
Integer status;
thing.SetStatus(status);

Parameters

Type Name Description
Integer status If there was a problem with for instance calculation, this field is set to warning or error. See <xref href="CRMScript.NetServer.QuoteStatus" data-throw-if-not-resolved="false"></xref>.

Returns

Type Description
Void

SetSubTotal(Float)

Declaration

Void SetSubTotal(Float subTotal)

Examples

NSQuoteAlternative thing;
Float subTotal;
thing.SetSubTotal(subTotal);

Parameters

Type Name Description
Float subTotal Value to help the user interface, is computed by summing the total price of the quote lines, and NOT by summing their subtotals.

Returns

Type Description
Void

SetTotalPrice(Float)

Declaration

Void SetTotalPrice(Float totalPrice)

Examples

NSQuoteAlternative thing;
Float totalPrice;
thing.SetTotalPrice(totalPrice);

Parameters

Type Name Description
Float 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.

Returns

Type Description
Void

SetUserValueOverride(Integer)

Declaration

Void SetUserValueOverride(Integer userValueOverride)

Examples

NSQuoteAlternative thing;
Integer userValueOverride;
thing.SetUserValueOverride(userValueOverride);

Parameters

Type Name Description
Integer userValueOverride Has the pre-calculated (from ERP) price information been overridden, and how. See <xref href="CRMScript.NetServer.ValueOverride" data-throw-if-not-resolved="false"></xref>.

Returns

Type Description
Void

SetVAT(Float)

Declaration

Void SetVAT(Float vAT)

Examples

NSQuoteAlternative thing;
Float vAT;
thing.SetVAT(vAT);

Parameters

Type Name Description
Float vAT Tax/VAT* THIS IS AN AMOUNT, available as a merge field in the quote document.

Returns

Type Description
Void

SetVATInfo(String)

Declaration

Void SetVATInfo(String vATInfo)

Examples

NSQuoteAlternative thing;
String vATInfo;
thing.SetVATInfo(vATInfo);

Parameters

Type Name Description
String vATInfo Extra info about VAT that the connector might insert.

Returns

Type Description
Void