Class NSQuoteLine

Information about a connection to the ERP system.

Constructors

NSQuoteLine()

Initializes a new instance of the NSQuoteLine class.

Declaration

NSQuoteLine

Methods

GetCode()

Declaration

String GetCode()

Examples

NSQuoteLine thing;
String code = thing.GetCode();

Returns

Type Description
String A value the salesmen use to quickly find the correct product. Is stored here if the user changes the value from the product in the price list, or just enters a QuoteLine without a product link.

GetDeliveredQuantity()

Declaration

Float GetDeliveredQuantity()

Examples

NSQuoteLine thing;
Float deliveredQuantity = thing.GetDeliveredQuantity();

Returns

Type Description
Float How many units have been delivered* updated by ERP system.

GetDescription()

Declaration

String GetDescription()

Examples

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

Returns

Type Description
String A longer description for the product. Is stored here if the user changes the value from the product in the price list, or just enters a QuoteLine without a product link.

GetDiscountAmount()

Declaration

Float GetDiscountAmount()

Examples

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

Returns

Type Description
Float The discount for the line, in whatever currency the sale is in. Both 'DiscountPercent' and 'DiscountAmount' shall be filled out, but the UserValueOverride field must be set to the field the user actually changed last. If this field is filled out by the user, it overrides any discount suggested by the connector. If the user has not filled this in, the system will copy the ERP discount amount to this field.

GetDiscountPercent()

Declaration

Float GetDiscountPercent()

Examples

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

Returns

Type Description
Float The discount for the line, in percent. Both 'DiscountPercent' and 'DiscountAmount' shall be filled out, but the UserValueOverride field must be set to the field the user actually changed last. If this field is filled out by the user, it overrides any discount suggested by the connector. If the user has not filled this in, the system will copy the ERP discount amount to this field. The Percentage is given in integer form, i.e. '12%' is represented as '12'.

GetEarningAmount()

Declaration

Float GetEarningAmount()

Examples

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

Returns

Type Description
Float The earning, in whatever currency the sale is in. Both 'EarningAmount and 'EarningPercent shall be filled out, but the UserValueOverride field must be set to the field the user actually changed last.

GetEarningPercent()

Declaration

Float GetEarningPercent()

Examples

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

Returns

Type Description
Float The earning, in percent. Both 'EarningAmount and 'EarningPercent shall be filled out, but the UserValueOverride field must be set to the field the user actually changed last. The Percentage is given in integer form, i.e. '12%' is represented as '12'.

GetERPDiscountAmount()

Declaration

Float GetERPDiscountAmount()

Examples

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

Returns

Type Description
Float The discount the system calculates based on customer / quantity / whatever. Can be overridden by the salesman in the field 'DiscountPercent' or 'DiscountAmount'. If UserValueOverride is set to 'None' then the value is copied to DiscountAmount. Both fields ERPDiscountPercent and ERPDiscountAmount will be filled out.

GetERPDiscountPercent()

Declaration

Float GetERPDiscountPercent()

Examples

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

Returns

Type Description
Float The discount the system calculates based on customer / quantity / whatever. Can be overridden by the salesman in the field 'DiscountPercent' or 'DiscountAmount'. Both fields ERPDiscountPercent and ERPDiscountAmount will be filled out. If UserValueOverride is set to 'None' then the value is copied to DiscountPercent. The Percentage is given in integer form, i.e. '12%' is represented as '12'.

GetERPProductKey()

Declaration

String GetERPProductKey()

Examples

NSQuoteLine thing;
String eRPProductKey = thing.GetERPProductKey();

Returns

Type Description
String Foreign key of product+pricelist this line is based on. Can be blank since the QuoteLine doesn't have to be connected to a product.

GetERPQuoteLineKey()

Declaration

String GetERPQuoteLineKey()

Examples

NSQuoteLine thing;
String eRPQuoteLineKey = thing.GetERPQuoteLineKey();

Returns

Type Description
String The foreign key to the quoteline in ERP system (if it has such a representation).

GetExtraField1()

Declaration

String GetExtraField1()

Examples

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

Returns

Type Description
String A simple field for adding information that the Connector can provide, and that the quote document need to display.

GetExtraField2()

Declaration

String GetExtraField2()

Examples

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

Returns

Type Description
String A simple field for adding information that the Connector can provide, and that the quote document need to display.

GetExtraField3()

Declaration

String GetExtraField3()

Examples

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

Returns

Type Description
String A simple field for adding information that the Connector can provide, and that the quote document need to display.

GetExtraField4()

Declaration

String GetExtraField4()

Examples

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

Returns

Type Description
String A simple field for adding information that the Connector can provide, and that the quote document need to display.

GetExtraField5()

Declaration

String GetExtraField5()

Examples

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

Returns

Type Description
String A simple field for adding information that the Connector can provide, and that the quote document need to display.

GetExtraInfo()

Declaration

NSProductExtraDataField[] GetExtraInfo()

Examples

NSQuoteLine thing;
NSProductExtraDataField[] extraInfo = thing.GetExtraInfo();

Returns

Type Description
NSProductExtraDataField[] Extra information, supplied by QuoteConnector, used by a future dynamic GUI extension.

GetIsSubscription()

Declaration

Bool GetIsSubscription()

Examples

NSQuoteLine thing;
Bool isSubscription = thing.GetIsSubscription();

Returns

Type Description
Bool Is this a subscription product, sold in repeating intervals/amounts?

GetItemNumber()

Declaration

String GetItemNumber()

Examples

NSQuoteLine thing;
String itemNumber = thing.GetItemNumber();

Returns

Type Description
String Norwegian «Postnummer». Specific numbers from some hierarchy, for instance '1.4.3.2'. Is stored here if the user changes the value from the product in the price list, or just enters a QuoteLine without a product link.

GetName()

Declaration

String GetName()

Examples

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

Returns

Type Description
String The name of the product. Is stored here if the user changes the value from the product in the price list, or just enters a QuoteLine without a product link.

GetPriceUnit()

Declaration

String GetPriceUnit()

Examples

NSQuoteLine thing;
String priceUnit = thing.GetPriceUnit();

Returns

Type Description
String What is the unit (meter, ton, bushel, microsecond, gradus, τρυβλίον, 五合枡, دونم or whatever); read-only for lines that originate in defined products.

GetProductCategoryKey()

Declaration

String GetProductCategoryKey()

Examples

NSQuoteLine thing;
String productCategoryKey = thing.GetProductCategoryKey();

Returns

Type Description
String Either a ListId to an ID from a connector provided list, or, if the connection doesn't support lists, a text. Is stored here if the user changes the value from the product in the pricelist, or just enters a QuoteLine without a product link.

GetProductFamilyKey()

Declaration

String GetProductFamilyKey()

Examples

NSQuoteLine thing;
String productFamilyKey = thing.GetProductFamilyKey();

Returns

Type Description
String Either a ListId to an ID from a connector provided list, or, if the connection doesn't support lists, a text. Is stored here if the user changes the value from the product in the price list, or just enters a QuoteLine without a product link.

GetProductTypeKey()

Declaration

String GetProductTypeKey()

Examples

NSQuoteLine thing;
String productTypeKey = thing.GetProductTypeKey();

Returns

Type Description
String Either a ListId to an ID from a connector provided list, or, if the connection doesn't support lists, a text. Is stored here if the user changes the value from the product in the price list, or just enters a QuoteLine without a product link.

GetQuantity()

Declaration

Float GetQuantity()

Examples

NSQuoteLine thing;
Float quantity = thing.GetQuantity();

Returns

Type Description
Float How many units; this is a decimal field since you might want to offer fractional units (2.5kg, or 0.5PC).

GetQuantityUnit()

Declaration

String GetQuantityUnit()

Examples

NSQuoteLine thing;
String quantityUnit = thing.GetQuantityUnit();

Returns

Type Description
String What is the unit (meter, ton, bushel, microsecond, gradus, τρυβλίον, 五合枡, دونم or whatever); Connector handles conversion relative to PriceUnit if they are different.

GetQuoteAlternativeId()

Declaration

Integer GetQuoteAlternativeId()

Examples

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

Returns

Type Description
Integer The alternative this line is part of, the conceptual Parent in CRM database.

GetQuoteLineId()

Declaration

Integer GetQuoteLineId()

Examples

NSQuoteLine thing;
Integer quoteLineId = thing.GetQuoteLineId();

Returns

Type Description
Integer Primary key.

GetRank()

Declaration

Integer GetRank()

Examples

NSQuoteLine thing;
Integer rank = thing.GetRank();

Returns

Type Description
Integer QuoteLines can be re-ordered, so we must track the ordering.

GetRawExtraInfo()

Declaration

String GetRawExtraInfo()

Examples

NSQuoteLine thing;
String rawExtraInfo = thing.GetRawExtraInfo();

Returns

Type Description
String Read-only extra information in plain text, supplied by QuoteConnector, used by a future dynamic GUI extension.

GetReason()

Declaration

String GetReason()

Examples

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

Returns

Type Description
String If QuoteStatus is not OK, then this field contains a localized explanation that the user can be shown.

GetRights()

Declaration

String GetRights()

Examples

NSQuoteLine thing;
String rights = thing.GetRights();

Returns

Type Description
String Field1=right&Field2=right, etc. of any fields that have non-standard field access rights. Rights can be one of N (=None or Hidden), R (=Read-only), W (=Writeable), M (=Mandatory). The fields will mostly be from the Quoteline table, but some added fields that are conceptually part of the quote line, like Image will also be possibly to set rights on.

GetRule()

Declaration

String GetRule()

Examples

NSQuoteLine thing;
String rule = thing.GetRule();

Returns

Type Description
String The names of one or more calculation rules that are in effect for this line, comma-separated case-insensitive.

GetStatus()

Declaration

Integer GetStatus()

Examples

NSQuoteLine 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>.

GetSubscriptionQuantity()

Declaration

Float GetSubscriptionQuantity()

Examples

NSQuoteLine thing;
Float subscriptionQuantity = thing.GetSubscriptionQuantity();

Returns

Type Description
Float The default number of SubscriptionUnits to suggest when creating quote lines from this product.

GetSubscriptionStart()

Declaration

DateTime GetSubscriptionStart()

Examples

NSQuoteLine thing;
DateTime subscriptionStart = thing.GetSubscriptionStart();

Returns

Type Description
DateTime Start date for subscription, as offered.

GetSubscriptionUnit()

Declaration

String GetSubscriptionUnit()

Examples

NSQuoteLine thing;
String subscriptionUnit = thing.GetSubscriptionUnit();

Returns

Type Description
String Either a ListId to an ID from a connector provided list, or, if the connection doesn't support lists, a text with the actual subscription unit.

GetSubTotal()

Declaration

Float GetSubTotal()

Examples

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

Returns

Type Description
Float Value to help the user interface, is equal to 'Quantity * ListPrice'

GetSupplier()

Declaration

String GetSupplier()

Examples

NSQuoteLine thing;
String supplier = thing.GetSupplier();

Returns

Type Description
String The name of the supplier. Is stored here if the user changes the value from the product in the price list, or just enters a QuoteLine without a product link.

GetSupplierCode()

Declaration

String GetSupplierCode()

Examples

NSQuoteLine thing;
String supplierCode = thing.GetSupplierCode();

Returns

Type Description
String The suppliers' code or part number for this product.

GetThumbnail()

Declaration

String GetThumbnail()

Examples

NSQuoteLine thing;
String thumbnail = thing.GetThumbnail();

Returns

Type Description
String A small image of the product, typically used to show in a list. Base64 encoded png.

GetTotalPrice()

Declaration

Float GetTotalPrice()

Examples

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

Returns

Type Description
Float TotalPrice = SubTotal* DiscountAmount or TotalPrice = (UnitCost * Quantity) + EarningAmount, according to what the user changed last.

GetUnitCost()

Declaration

Float GetUnitCost()

Examples

NSQuoteLine thing;
Float unitCost = thing.GetUnitCost();

Returns

Type Description
Float The cost price per unit for this product. May be filled in by connector if it has the Provide-Cost capability.

GetUnitListPrice()

Declaration

Float GetUnitListPrice()

Examples

NSQuoteLine thing;
Float unitListPrice = thing.GetUnitListPrice();

Returns

Type Description
Float The standard list price; as given by ERP Connector, OR overridden by user.

GetUnitMinimumPrice()

Declaration

Float GetUnitMinimumPrice()

Examples

NSQuoteLine thing;
Float unitMinimumPrice = thing.GetUnitMinimumPrice();

Returns

Type Description
Float The minimum price this line can be sold for (to limit discounting). Will come from the connector. List price per unit must exceed the minimum price per unit.

GetUrl()

Declaration

String GetUrl()

Examples

NSQuoteLine thing;
String url = thing.GetUrl();

Returns

Type Description
String A URL to the product info. Can be empty. Is stored here if the user changes the value from the product in the price list, or just enters a QuoteLine without a product link.

GetUserValueOverride()

Declaration

Integer GetUserValueOverride()

Examples

NSQuoteLine 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

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

Returns

Type Description
Float Tax/VAT* THIS IS A PERCENTAGE. The connector is responsible for populating this field; the percentage will be used to calculate VAT amounts available as merge fields in the document templates (but amounts are never stored in the database).

GetVATInfo()

Declaration

String GetVATInfo()

Examples

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

Returns

Type Description
String Tax/VAT information, Extra info about VAT that the connector might insert, and the users might want to specify on the quote. The core CRM product has no business logic for this field, it is wholly up to connectors to use it.

SetCode(String)

Declaration

Void SetCode(String code)

Examples

NSQuoteLine thing;
String code;
thing.SetCode(code);

Parameters

Type Name Description
String code A value the salesmen use to quickly find the correct product. Is stored here if the user changes the value from the product in the price list, or just enters a QuoteLine without a product link.

Returns

Type Description
Void

SetDeliveredQuantity(Float)

Declaration

Void SetDeliveredQuantity(Float deliveredQuantity)

Examples

NSQuoteLine thing;
Float deliveredQuantity;
thing.SetDeliveredQuantity(deliveredQuantity);

Parameters

Type Name Description
Float deliveredQuantity How many units have been delivered* updated by ERP system.

Returns

Type Description
Void

SetDescription(String)

Declaration

Void SetDescription(String description)

Examples

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

Parameters

Type Name Description
String description A longer description for the product. Is stored here if the user changes the value from the product in the price list, or just enters a QuoteLine without a product link.

Returns

Type Description
Void

SetDiscountAmount(Float)

Declaration

Void SetDiscountAmount(Float discountAmount)

Examples

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

Parameters

Type Name Description
Float discountAmount The discount for the line, in whatever currency the sale is in. Both 'DiscountPercent' and 'DiscountAmount' shall be filled out, but the UserValueOverride field must be set to the field the user actually changed last. If this field is filled out by the user, it overrides any discount suggested by the connector. If the user has not filled this in, the system will copy the ERP discount amount to this field.

Returns

Type Description
Void

SetDiscountPercent(Float)

Declaration

Void SetDiscountPercent(Float discountPercent)

Examples

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

Parameters

Type Name Description
Float discountPercent The discount for the line, in percent. Both 'DiscountPercent' and 'DiscountAmount' shall be filled out, but the UserValueOverride field must be set to the field the user actually changed last. If this field is filled out by the user, it overrides any discount suggested by the connector. If the user has not filled this in, the system will copy the ERP discount amount to this field. The Percentage is given in integer form, i.e. '12%' is represented as '12'.

Returns

Type Description
Void

SetEarningAmount(Float)

Declaration

Void SetEarningAmount(Float earningAmount)

Examples

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

Parameters

Type Name Description
Float earningAmount The earning, in whatever currency the sale is in. Both 'EarningAmount and 'EarningPercent shall be filled out, but the UserValueOverride field must be set to the field the user actually changed last.

Returns

Type Description
Void

SetEarningPercent(Float)

Declaration

Void SetEarningPercent(Float earningPercent)

Examples

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

Parameters

Type Name Description
Float earningPercent The earning, in percent. Both 'EarningAmount and 'EarningPercent shall be filled out, but the UserValueOverride field must be set to the field the user actually changed last. 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

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

Parameters

Type Name Description
Float The discount the system calculates based on customer / quantity / whatever. Can be overridden by the salesman in the field 'DiscountPercent' or 'DiscountAmount'. If UserValueOverride is set to 'None' then the value is copied to DiscountAmount. Both fields ERPDiscountPercent and ERPDiscountAmount will be filled out.

Returns

Type Description
Void

SetERPDiscountPercent(Float)

Declaration

Void SetERPDiscountPercent(Float eRPDiscountPercent)

Examples

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

Parameters

Type Name Description
Float eRPDiscountPercent The discount the system calculates based on customer / quantity / whatever. Can be overridden by the salesman in the field 'DiscountPercent' or 'DiscountAmount'. Both fields ERPDiscountPercent and ERPDiscountAmount will be filled out. If UserValueOverride is set to 'None' then the value is copied to DiscountPercent. The Percentage is given in integer form, i.e. '12%' is represented as '12'.

Returns

Type Description
Void

SetERPProductKey(String)

Declaration

Void SetERPProductKey(String eRPProductKey)

Examples

NSQuoteLine thing;
String eRPProductKey;
thing.SetERPProductKey(eRPProductKey);

Parameters

Type Name Description
String eRPProductKey Foreign key of product+pricelist this line is based on. Can be blank since the QuoteLine doesn't have to be connected to a product.

Returns

Type Description
Void

SetERPQuoteLineKey(String)

Declaration

Void SetERPQuoteLineKey(String eRPQuoteLineKey)

Examples

NSQuoteLine thing;
String eRPQuoteLineKey;
thing.SetERPQuoteLineKey(eRPQuoteLineKey);

Parameters

Type Name Description
String eRPQuoteLineKey The foreign key to the quote line in ERP system (if it has such a representation).

Returns

Type Description
Void

SetExtraField1(String)

Declaration

Void SetExtraField1(String extraField1)

Examples

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

Parameters

Type Name Description
String extraField1 A simple field for adding information that the Connector can provide, and that the quote document need to display.

Returns

Type Description
Void

SetExtraField2(String)

Declaration

Void SetExtraField2(String extraField2)

Examples

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

Parameters

Type Name Description
String extraField2 A simple field for adding information that the Connector can provide, and that the quote document need to display.

Returns

Type Description
Void

SetExtraField3(String)

Declaration

Void SetExtraField3(String extraField3)

Examples

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

Parameters

Type Name Description
String extraField3 A simple field for adding information that the Connector can provide, and that the quote document need to display.

Returns

Type Description
Void

SetExtraField4(String)

Declaration

Void SetExtraField4(String extraField4)

Examples

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

Parameters

Type Name Description
String extraField4 A simple field for adding information that the Connector can provide, and that the quote document need to display.

Returns

Type Description
Void

SetExtraField5(String)

Declaration

Void SetExtraField5(String extraField5)

Examples

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

Parameters

Type Name Description
String extraField5 A simple field for adding information that the Connector can provide, and that the quote document need to display.

Returns

Type Description
Void

SetExtraInfo(NSProductExtraDataField[])

Declaration

Void SetExtraInfo(NSProductExtraDataField[] extraInfo)

Examples

NSQuoteLine thing;
NSProductExtraDataField[] extraInfo;
thing.SetExtraInfo(extraInfo);

Parameters

Type Name Description
NSProductExtraDataField[] extraInfo Extra information, supplied by QuoteConnector, used by a future dynamic GUI extension.

Returns

Type Description
Void

SetIsSubscription(Bool)

Declaration

Void SetIsSubscription(Bool isSubscription)

Examples

NSQuoteLine thing;
Bool isSubscription;
thing.SetIsSubscription(isSubscription);

Parameters

Type Name Description
Bool isSubscription Is this a subscription product, sold in repeating intervals/amounts?

Returns

Type Description
Void

SetItemNumber(String)

Declaration

Void SetItemNumber(String itemNumber)

Examples

NSQuoteLine thing;
String itemNumber;
thing.SetItemNumber(itemNumber);

Parameters

Type Name Description
String itemNumber Norwegian «Postnummer». Specific numbers from some hierarchy, for instance '1.4.3.2'. Is stored here if the user changes the value from the product in the price list, or just enters a QuoteLine without a product link.

Returns

Type Description
Void

SetName(String)

Declaration

Void SetName(String name)

Examples

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

Parameters

Type Name Description
String name The name of the product. Is stored here if the user changes the value from the product in the price list, or just enters a QuoteLine without a product link.

Returns

Type Description
Void

SetPriceUnit(String)

Declaration

Void SetPriceUnit(String priceUnit)

Examples

NSQuoteLine thing;
String priceUnit;
thing.SetPriceUnit(priceUnit);

Parameters

Type Name Description
String priceUnit What is the unit (meter, ton, bushel, microsecond, gradus, τρυβλίον, 五合枡, دونم or whatever); read-only for lines that originate in defined products.

Returns

Type Description
Void

SetProductCategoryKey(String)

Declaration

Void SetProductCategoryKey(String productCategoryKey)

Examples

NSQuoteLine thing;
String productCategoryKey;
thing.SetProductCategoryKey(productCategoryKey);

Parameters

Type Name Description
String productCategoryKey Either a ListId to an ID from a connector provided list, or, if the connection doesn't support lists, a text. Is stored here if the user changes the value from the product in the price list, or just enters a QuoteLine without a product link.

Returns

Type Description
Void

SetProductFamilyKey(String)

Declaration

Void SetProductFamilyKey(String productFamilyKey)

Examples

NSQuoteLine thing;
String productFamilyKey;
thing.SetProductFamilyKey(productFamilyKey);

Parameters

Type Name Description
String productFamilyKey Either a ListId to an ID from a connector provided list, or, if the connection doesn't support lists, a text. Is stored here if the user changes the value from the product in the price list, or just enters a QuoteLine without a product link.

Returns

Type Description
Void

SetProductTypeKey(String)

Declaration

Void SetProductTypeKey(String productTypeKey)

Examples

NSQuoteLine thing;
String productTypeKey;
thing.SetProductTypeKey(productTypeKey);

Parameters

Type Name Description
String productTypeKey Either a ListId to an ID from a connector provided list, or, if the connection doesn't support lists, a text. Is stored here if the user changes the value from the product in the price list, or just enters a QuoteLine without a product link.

Returns

Type Description
Void

SetQuantity(Float)

Declaration

Void SetQuantity(Float quantity)

Examples

NSQuoteLine thing;
Float quantity;
thing.SetQuantity(quantity);

Parameters

Type Name Description
Float quantity How many units; this is a decimal field since you might want to offer fractional units (2.5kg, or 0.5PC).

Returns

Type Description
Void

SetQuantityUnit(String)

Declaration

Void SetQuantityUnit(String quantityUnit)

Examples

NSQuoteLine thing;
String quantityUnit;
thing.SetQuantityUnit(quantityUnit);

Parameters

Type Name Description
String quantityUnit What is the unit (meter, ton, bushel, microsecond, gradus, τρυβλίον, 五合枡, دونم or whatever); Connector handles conversion relative to PriceUnit if they are different.

Returns

Type Description
Void

SetQuoteAlternativeId(Integer)

Declaration

Void SetQuoteAlternativeId(Integer quoteAlternativeId)

Examples

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

Parameters

Type Name Description
Integer quoteAlternativeId The alternative this line is part of, the conceptual Parent in CRM database.

Returns

Type Description
Void

SetQuoteLineId(Integer)

Declaration

Void SetQuoteLineId(Integer quoteLineId)

Examples

NSQuoteLine thing;
Integer quoteLineId;
thing.SetQuoteLineId(quoteLineId);

Parameters

Type Name Description
Integer quoteLineId Primary key.

Returns

Type Description
Void

SetRank(Integer)

Declaration

Void SetRank(Integer rank)

Examples

NSQuoteLine thing;
Integer rank;
thing.SetRank(rank);

Parameters

Type Name Description
Integer rank QuoteLines can be re-ordered, so we must track the ordering.

Returns

Type Description
Void

SetRawExtraInfo(String)

Declaration

Void SetRawExtraInfo(String rawExtraInfo)

Examples

NSQuoteLine thing;
String rawExtraInfo;
thing.SetRawExtraInfo(rawExtraInfo);

Parameters

Type Name Description
String rawExtraInfo Read-only extra information in plain text, supplied by QuoteConnector, used by a future dynamic GUI extension.

Returns

Type Description
Void

SetReason(String)

Declaration

Void SetReason(String reason)

Examples

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

Parameters

Type Name Description
String reason If QuoteStatus is not OK, then this field contains a localized explanation that the user can be shown.

Returns

Type Description
Void

SetRights(String)

Declaration

Void SetRights(String rights)

Examples

NSQuoteLine thing;
String rights;
thing.SetRights(rights);

Parameters

Type Name Description
String rights Field1=right&amp;Field2=right, etc. of any fields that have non-standard field access rights. Rights can be one of N (=None or Hidden), R (=Read-only), W (=Writeable), M (=Mandatory). The fields will mostly be from the Quoteline table, but some added fields that are conceptually part of the quote line, like Image will also be possibly to set rights on. Will be used by SuperOffice to control the user interface when showing the record.

Returns

Type Description
Void

SetRule(String)

Declaration

Void SetRule(String rule)

Examples

NSQuoteLine thing;
String rule;
thing.SetRule(rule);

Parameters

Type Name Description
String rule The names of one or more calculation rules that are in effect for this line, comma-separated case-insensitive.

Returns

Type Description
Void

SetStatus(Integer)

Declaration

Void SetStatus(Integer status)

Examples

NSQuoteLine 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. Typically shown as an icon. See <xref href="CRMScript.NetServer.QuoteStatus" data-throw-if-not-resolved="false"></xref>.

Returns

Type Description
Void

SetSubscriptionQuantity(Float)

Declaration

Void SetSubscriptionQuantity(Float subscriptionQuantity)

Examples

NSQuoteLine thing;
Float subscriptionQuantity;
thing.SetSubscriptionQuantity(subscriptionQuantity);

Parameters

Type Name Description
Float subscriptionQuantity The default number of SubscriptionUnits to suggest when creating quote lines from this product.

Returns

Type Description
Void

SetSubscriptionStart(DateTime)

Declaration

Void SetSubscriptionStart(DateTime subscriptionStart)

Examples

NSQuoteLine thing;
DateTime subscriptionStart;
thing.SetSubscriptionStart(subscriptionStart);

Parameters

Type Name Description
DateTime subscriptionStart Start date for subscription, as offered.

Returns

Type Description
Void

SetSubscriptionUnit(String)

Declaration

Void SetSubscriptionUnit(String subscriptionUnit)

Examples

NSQuoteLine thing;
String subscriptionUnit;
thing.SetSubscriptionUnit(subscriptionUnit);

Parameters

Type Name Description
String subscriptionUnit Either a ListId to an ID from a connector provided list, or, if the connection doesn't support lists, a text with the actual subscription unit.

Returns

Type Description
Void

SetSubTotal(Float)

Declaration

Void SetSubTotal(Float subTotal)

Examples

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

Parameters

Type Name Description
Float subTotal Value to help the user interface, is equal to 'Quantity * ListPrice'

Returns

Type Description
Void

SetSupplier(String)

Declaration

Void SetSupplier(String supplier)

Examples

NSQuoteLine thing;
String supplier;
thing.SetSupplier(supplier);

Parameters

Type Name Description
String supplier The name of the supplier. Is stored here if the user changes the value from the product in the price list, or just enters a QuoteLine without a product link.

Returns

Type Description
Void

SetSupplierCode(String)

Declaration

Void SetSupplierCode(String supplierCode)

Examples

NSQuoteLine thing;
String supplierCode;
thing.SetSupplierCode(supplierCode);

Parameters

Type Name Description
String supplierCode The suppliers' code or part number for this product. Is stored here if the user changes the value from the product in the price list, or just enters a QuoteLine without a product link.

Returns

Type Description
Void

SetThumbnail(String)

Declaration

Void SetThumbnail(String thumbnail)

Examples

NSQuoteLine thing;
String thumbnail;
thing.SetThumbnail(thumbnail);

Parameters

Type Name Description
String thumbnail A small image of the product, typically used to show in a list. Base64 encoded png.

Returns

Type Description
Void

SetTotalPrice(Float)

Declaration

Void SetTotalPrice(Float totalPrice)

Examples

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

Parameters

Type Name Description
Float totalPrice TotalPrice = SubTotal* DiscountAmount or TotalPrice = (UnitCost * Quantity) + EarningAmount, according to what the user changed last.

Returns

Type Description
Void

SetUnitCost(Float)

Declaration

Void SetUnitCost(Float unitCost)

Examples

NSQuoteLine thing;
Float unitCost;
thing.SetUnitCost(unitCost);

Parameters

Type Name Description
Float unitCost The cost price per unit for this product. May be filled in by connector if it has the Provide-Cost capability.

Returns

Type Description
Void

SetUnitListPrice(Float)

Declaration

Void SetUnitListPrice(Float unitListPrice)

Examples

NSQuoteLine thing;
Float unitListPrice;
thing.SetUnitListPrice(unitListPrice);

Parameters

Type Name Description
Float unitListPrice The standard list price; as given by ERP Connector, OR overridden by user.

Returns

Type Description
Void

SetUnitMinimumPrice(Float)

Declaration

Void SetUnitMinimumPrice(Float unitMinimumPrice)

Examples

NSQuoteLine thing;
Float unitMinimumPrice;
thing.SetUnitMinimumPrice(unitMinimumPrice);

Parameters

Type Name Description
Float unitMinimumPrice The minimum price this line can be sold for (to limit discounting). Will come from the connector. List price per unit must exceed the minimum price per unit.

Returns

Type Description
Void

SetUrl(String)

Declaration

Void SetUrl(String url)

Examples

NSQuoteLine thing;
String url;
thing.SetUrl(url);

Parameters

Type Name Description
String url A URL to the product info. Can be empty. Is stored here if the user changes the value from the product in the pricelist, or just enters a QuoteLine without a product link.

Returns

Type Description
Void

SetUserValueOverride(Integer)

Declaration

Void SetUserValueOverride(Integer userValueOverride)

Examples

NSQuoteLine 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

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

Parameters

Type Name Description
Float vAT Tax/VAT* THIS IS A PERCENTAGE. The connector is responsible for populating this field; the percentage will be used to calculate VAT amounts available as merge fields in the document templates (but amounts are never stored in the database).

Returns

Type Description
Void

SetVATInfo(String)

Declaration

Void SetVATInfo(String vATInfo)

Examples

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

Parameters

Type Name Description
String vATInfo Tax/VAT information, Extra info about VAT that the connector might insert, and the users might want to specify on the quote. The core CRM product has no business logic for this field, it is wholly up to connectors to use it.

Returns

Type Description
Void