Class NSQuoteLine
Information about a connection to the ERP system.
Syntax
Constructors
NSQuoteLine()
Initializes a new instance of the NSQuoteLine class.
Introduced or updated in version: 7.5
Declaration
NSQuoteLine
Methods
GetCode()
Introduced or updated in version: 7.5
Declaration
String 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. |
Examples
NSQuoteLine thing;
String code = thing.GetCode();
GetDeliveredQuantity()
Introduced or updated in version: 7.5
Declaration
Float GetDeliveredQuantity()
Returns
Type | Description |
---|---|
Float | How many units have been delivered* updated by ERP system. |
Examples
NSQuoteLine thing;
Float deliveredQuantity = thing.GetDeliveredQuantity();
GetDescription()
Introduced or updated in version: 7.5
Declaration
String 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. |
Examples
NSQuoteLine thing;
String description = thing.GetDescription();
GetDiscountAmount()
Introduced or updated in version: 7.5
Declaration
Float 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. |
Examples
NSQuoteLine thing;
Float discountAmount = thing.GetDiscountAmount();
GetDiscountPercent()
Introduced or updated in version: 7.5
Declaration
Float 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'. |
Examples
NSQuoteLine thing;
Float discountPercent = thing.GetDiscountPercent();
GetEarningAmount()
Introduced or updated in version: 7.5
Declaration
Float 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. |
Examples
NSQuoteLine thing;
Float earningAmount = thing.GetEarningAmount();
GetEarningPercent()
Introduced or updated in version: 7.5
Declaration
Float 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'. |
Examples
NSQuoteLine thing;
Float earningPercent = thing.GetEarningPercent();
GetERPDiscountAmount()
Introduced or updated in version: 7.5
Declaration
Float 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. |
Examples
NSQuoteLine thing;
Float eRPDiscountAmount = thing.GetERPDiscountAmount();
GetERPDiscountPercent()
Introduced or updated in version: 7.5
Declaration
Float 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'. |
Examples
NSQuoteLine thing;
Float eRPDiscountPercent = thing.GetERPDiscountPercent();
GetERPProductKey()
Introduced or updated in version: 7.5
Declaration
String 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. |
Examples
NSQuoteLine thing;
String eRPProductKey = thing.GetERPProductKey();
GetERPQuoteLineKey()
Introduced or updated in version: 7.5
Declaration
String GetERPQuoteLineKey()
Returns
Type | Description |
---|---|
String | The foreign key to the quoteline in ERP system (if it has such a representation). |
Examples
NSQuoteLine thing;
String eRPQuoteLineKey = thing.GetERPQuoteLineKey();
GetExtraField1()
Introduced or updated in version: 7.5
Declaration
String GetExtraField1()
Returns
Type | Description |
---|---|
String | A simple field for adding information that the Connector can provide, and that the quote document need to display. |
Examples
NSQuoteLine thing;
String extraField1 = thing.GetExtraField1();
GetExtraField2()
Introduced or updated in version: 7.5
Declaration
String GetExtraField2()
Returns
Type | Description |
---|---|
String | A simple field for adding information that the Connector can provide, and that the quote document need to display. |
Examples
NSQuoteLine thing;
String extraField2 = thing.GetExtraField2();
GetExtraField3()
Introduced or updated in version: 7.5
Declaration
String GetExtraField3()
Returns
Type | Description |
---|---|
String | A simple field for adding information that the Connector can provide, and that the quote document need to display. |
Examples
NSQuoteLine thing;
String extraField3 = thing.GetExtraField3();
GetExtraField4()
Introduced or updated in version: 7.5
Declaration
String GetExtraField4()
Returns
Type | Description |
---|---|
String | A simple field for adding information that the Connector can provide, and that the quote document need to display. |
Examples
NSQuoteLine thing;
String extraField4 = thing.GetExtraField4();
GetExtraField5()
Introduced or updated in version: 7.5
Declaration
String GetExtraField5()
Returns
Type | Description |
---|---|
String | A simple field for adding information that the Connector can provide, and that the quote document need to display. |
Examples
NSQuoteLine thing;
String extraField5 = thing.GetExtraField5();
GetExtraInfo()
Introduced or updated in version: 7.5
Declaration
NSProductExtraDataField[] GetExtraInfo()
Returns
Type | Description |
---|---|
NSProductExtraDataField[] | Extra information, supplied by QuoteConnector, used by a future dynamic GUI extension. |
Examples
NSQuoteLine thing;
NSProductExtraDataField[] extraInfo = thing.GetExtraInfo();
GetIsSubscription()
Introduced or updated in version: 7.5
Declaration
Bool GetIsSubscription()
Returns
Type | Description |
---|---|
Bool | Is this a subscription product, sold in repeating intervals/amounts? |
Examples
NSQuoteLine thing;
Bool isSubscription = thing.GetIsSubscription();
GetItemNumber()
Introduced or updated in version: 7.5
Declaration
String 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. |
Examples
NSQuoteLine thing;
String itemNumber = thing.GetItemNumber();
GetName()
Introduced or updated in version: 7.5
Declaration
String 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. |
Examples
NSQuoteLine thing;
String name = thing.GetName();
GetPriceUnit()
Introduced or updated in version: 7.5
Declaration
String 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. |
Examples
NSQuoteLine thing;
String priceUnit = thing.GetPriceUnit();
GetProductCategoryKey()
Introduced or updated in version: 7.5
Declaration
String 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. |
Examples
NSQuoteLine thing;
String productCategoryKey = thing.GetProductCategoryKey();
GetProductFamilyKey()
Introduced or updated in version: 7.5
Declaration
String 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. |
Examples
NSQuoteLine thing;
String productFamilyKey = thing.GetProductFamilyKey();
GetProductTypeKey()
Introduced or updated in version: 7.5
Declaration
String 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. |
Examples
NSQuoteLine thing;
String productTypeKey = thing.GetProductTypeKey();
GetQuantity()
Introduced or updated in version: 7.5
Declaration
Float 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). |
Examples
NSQuoteLine thing;
Float quantity = thing.GetQuantity();
GetQuantityUnit()
Introduced or updated in version: 7.5
Declaration
String 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. |
Examples
NSQuoteLine thing;
String quantityUnit = thing.GetQuantityUnit();
GetQuoteAlternativeId()
Introduced or updated in version: 7.5
Declaration
Integer GetQuoteAlternativeId()
Returns
Type | Description |
---|---|
Integer | The alternative this line is part of, the conceptual Parent in CRM database. |
Examples
NSQuoteLine thing;
Integer quoteAlternativeId = thing.GetQuoteAlternativeId();
GetQuoteLineId()
Introduced or updated in version: 7.5
Declaration
Integer GetQuoteLineId()
Returns
Type | Description |
---|---|
Integer | Primary key. |
Examples
NSQuoteLine thing;
Integer quoteLineId = thing.GetQuoteLineId();
GetRank()
Introduced or updated in version: 7.5
Declaration
Integer GetRank()
Returns
Type | Description |
---|---|
Integer | QuoteLines can be re-ordered, so we must track the ordering. |
Examples
NSQuoteLine thing;
Integer rank = thing.GetRank();
GetRawExtraInfo()
Introduced or updated in version: 7.5
Declaration
String GetRawExtraInfo()
Returns
Type | Description |
---|---|
String | Read-only extra information in plain text, supplied by QuoteConnector, used by a future dynamic GUI extension. |
Examples
NSQuoteLine thing;
String rawExtraInfo = thing.GetRawExtraInfo();
GetReason()
Introduced or updated in version: 7.5
Declaration
String GetReason()
Returns
Type | Description |
---|---|
String | If QuoteStatus is not OK, then this field contains a localized explanation that the user can be shown. |
Examples
NSQuoteLine thing;
String reason = thing.GetReason();
GetRights()
Introduced or updated in version: 7.5
Declaration
String 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. |
Remarks
Will be used by SuperOffice to control the user interface when showing the record.
Examples
NSQuoteLine thing;
String rights = thing.GetRights();
GetRule()
Introduced or updated in version: 7.5
Declaration
String GetRule()
Returns
Type | Description |
---|---|
String | The names of one or more calculation rules that are in effect for this line, comma-separated case-insensitive. |
Examples
NSQuoteLine thing;
String rule = thing.GetRule();
GetStatus()
Introduced or updated in version: 7.5
Declaration
Integer GetStatus()
Returns
Type | Description |
---|---|
Integer | If there was a problem with for instance calculation, this field is set to warning or error. See QuoteStatus. |
Remarks
Typically shown as an icon.
Examples
NSQuoteLine thing;
Integer status = thing.GetStatus();
GetSubscriptionQuantity()
Introduced or updated in version: 7.5
Declaration
Float GetSubscriptionQuantity()
Returns
Type | Description |
---|---|
Float | The default number of SubscriptionUnits to suggest when creating quote lines from this product. |
Examples
NSQuoteLine thing;
Float subscriptionQuantity = thing.GetSubscriptionQuantity();
GetSubscriptionStart()
Introduced or updated in version: 7.5
Declaration
DateTime GetSubscriptionStart()
Returns
Type | Description |
---|---|
DateTime | Start date for subscription, as offered. |
Examples
NSQuoteLine thing;
DateTime subscriptionStart = thing.GetSubscriptionStart();
GetSubscriptionUnit()
Introduced or updated in version: 7.5
Declaration
String 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. |
Examples
NSQuoteLine thing;
String subscriptionUnit = thing.GetSubscriptionUnit();
GetSubTotal()
Introduced or updated in version: 7.5
Declaration
Float GetSubTotal()
Returns
Type | Description |
---|---|
Float | Value to help the user interface, is equal to 'Quantity * ListPrice' |
Examples
NSQuoteLine thing;
Float subTotal = thing.GetSubTotal();
GetSupplier()
Introduced or updated in version: 7.5
Declaration
String 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. |
Examples
NSQuoteLine thing;
String supplier = thing.GetSupplier();
GetSupplierCode()
Introduced or updated in version: 7.5
Declaration
String GetSupplierCode()
Returns
Type | Description |
---|---|
String | The suppliers' code or part number for this product. |
Remarks
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.
Examples
NSQuoteLine thing;
String supplierCode = thing.GetSupplierCode();
GetThumbnail()
Introduced or updated in version: 7.5
Declaration
String GetThumbnail()
Returns
Type | Description |
---|---|
String | A small image of the product, typically used to show in a list. Base64 encoded png. |
Examples
NSQuoteLine thing;
String thumbnail = thing.GetThumbnail();
GetTotalPrice()
Introduced or updated in version: 7.5
Declaration
Float GetTotalPrice()
Returns
Type | Description |
---|---|
Float | TotalPrice = SubTotal* DiscountAmount or TotalPrice = (UnitCost * Quantity) + EarningAmount, according to what the user changed last. |
Examples
NSQuoteLine thing;
Float totalPrice = thing.GetTotalPrice();
GetUnitCost()
Introduced or updated in version: 7.5
Declaration
Float 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. |
Examples
NSQuoteLine thing;
Float unitCost = thing.GetUnitCost();
GetUnitListPrice()
Introduced or updated in version: 7.5
Declaration
Float GetUnitListPrice()
Returns
Type | Description |
---|---|
Float | The standard list price; as given by ERP Connector, OR overridden by user. |
Examples
NSQuoteLine thing;
Float unitListPrice = thing.GetUnitListPrice();
GetUnitMinimumPrice()
Introduced or updated in version: 7.5
Declaration
Float 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. |
Examples
NSQuoteLine thing;
Float unitMinimumPrice = thing.GetUnitMinimumPrice();
GetUrl()
Introduced or updated in version: 7.5
Declaration
String 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. |
Examples
NSQuoteLine thing;
String url = thing.GetUrl();
GetUserValueOverride()
Introduced or updated in version: 7.5
Declaration
Integer GetUserValueOverride()
Returns
Type | Description |
---|---|
Integer | Has the pre-calculated (from ERP) price information been overridden, and how. See ValueOverride. |
Remarks
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.)
Examples
NSQuoteLine thing;
Integer userValueOverride = thing.GetUserValueOverride();
GetVAT()
Introduced or updated in version: 7.5
Declaration
Float 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). |
Examples
NSQuoteLine thing;
Float vAT = thing.GetVAT();
GetVATInfo()
Introduced or updated in version: 7.5
Declaration
String 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. |
Examples
NSQuoteLine thing;
String vATInfo = thing.GetVATInfo();
SetCode(String)
Introduced or updated in version: 7.5
Declaration
Void SetCode(String 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 |
Examples
NSQuoteLine thing;
String code;
thing.SetCode(code);
SetDeliveredQuantity(Float)
Introduced or updated in version: 7.5
Declaration
Void SetDeliveredQuantity(Float deliveredQuantity)
Parameters
Type | Name | Description |
---|---|---|
Float | deliveredQuantity | How many units have been delivered* updated by ERP system. |
Returns
Type | Description |
---|---|
Void |
Examples
NSQuoteLine thing;
Float deliveredQuantity;
thing.SetDeliveredQuantity(deliveredQuantity);
SetDescription(String)
Introduced or updated in version: 7.5
Declaration
Void SetDescription(String 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 |
Examples
NSQuoteLine thing;
String description;
thing.SetDescription(description);
SetDiscountAmount(Float)
Introduced or updated in version: 7.5
Declaration
Void SetDiscountAmount(Float 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 |
Examples
NSQuoteLine thing;
Float discountAmount;
thing.SetDiscountAmount(discountAmount);
SetDiscountPercent(Float)
Introduced or updated in version: 7.5
Declaration
Void SetDiscountPercent(Float 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 |
Examples
NSQuoteLine thing;
Float discountPercent;
thing.SetDiscountPercent(discountPercent);
SetEarningAmount(Float)
Introduced or updated in version: 7.5
Declaration
Void SetEarningAmount(Float 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 |
Examples
NSQuoteLine thing;
Float earningAmount;
thing.SetEarningAmount(earningAmount);
SetEarningPercent(Float)
Introduced or updated in version: 7.5
Declaration
Void SetEarningPercent(Float 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 |
Examples
NSQuoteLine thing;
Float earningPercent;
thing.SetEarningPercent(earningPercent);
SetERPDiscountAmount(Float)
Introduced or updated in version: 7.5
Declaration
Void SetERPDiscountAmount(Float eRPDiscountAmount)
Parameters
Type | Name | Description |
---|---|---|
Float | CRMScript_NetServer_NSQuoteLine_SetERPDiscountAmount_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 |
Examples
NSQuoteLine thing;
Float eRPDiscountAmount;
thing.SetERPDiscountAmount(eRPDiscountAmount);
SetERPDiscountPercent(Float)
Introduced or updated in version: 7.5
Declaration
Void SetERPDiscountPercent(Float 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 |
Examples
NSQuoteLine thing;
Float eRPDiscountPercent;
thing.SetERPDiscountPercent(eRPDiscountPercent);
SetERPProductKey(String)
Introduced or updated in version: 7.5
Declaration
Void SetERPProductKey(String 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 |
Examples
NSQuoteLine thing;
String eRPProductKey;
thing.SetERPProductKey(eRPProductKey);
SetERPQuoteLineKey(String)
Introduced or updated in version: 7.5
Declaration
Void SetERPQuoteLineKey(String 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 |
Examples
NSQuoteLine thing;
String eRPQuoteLineKey;
thing.SetERPQuoteLineKey(eRPQuoteLineKey);
SetExtraField1(String)
Introduced or updated in version: 7.5
Declaration
Void SetExtraField1(String 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 |
Examples
NSQuoteLine thing;
String extraField1;
thing.SetExtraField1(extraField1);
SetExtraField2(String)
Introduced or updated in version: 7.5
Declaration
Void SetExtraField2(String 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 |
Examples
NSQuoteLine thing;
String extraField2;
thing.SetExtraField2(extraField2);
SetExtraField3(String)
Introduced or updated in version: 7.5
Declaration
Void SetExtraField3(String 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 |
Examples
NSQuoteLine thing;
String extraField3;
thing.SetExtraField3(extraField3);
SetExtraField4(String)
Introduced or updated in version: 7.5
Declaration
Void SetExtraField4(String 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 |
Examples
NSQuoteLine thing;
String extraField4;
thing.SetExtraField4(extraField4);
SetExtraField5(String)
Introduced or updated in version: 7.5
Declaration
Void SetExtraField5(String 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 |
Examples
NSQuoteLine thing;
String extraField5;
thing.SetExtraField5(extraField5);
SetExtraInfo(NSProductExtraDataField[])
Introduced or updated in version: 7.5
Declaration
Void SetExtraInfo(NSProductExtraDataField[] extraInfo)
Parameters
Type | Name | Description |
---|---|---|
NSProductExtraDataField[] | extraInfo | Extra information, supplied by QuoteConnector, used by a future dynamic GUI extension. |
Returns
Type | Description |
---|---|
Void |
Examples
NSQuoteLine thing;
NSProductExtraDataField[] extraInfo;
thing.SetExtraInfo(extraInfo);
SetIsSubscription(Bool)
Introduced or updated in version: 7.5
Declaration
Void SetIsSubscription(Bool isSubscription)
Parameters
Type | Name | Description |
---|---|---|
Bool | isSubscription | Is this a subscription product, sold in repeating intervals/amounts? |
Returns
Type | Description |
---|---|
Void |
Examples
NSQuoteLine thing;
Bool isSubscription;
thing.SetIsSubscription(isSubscription);
SetItemNumber(String)
Introduced or updated in version: 7.5
Declaration
Void SetItemNumber(String 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 |
Examples
NSQuoteLine thing;
String itemNumber;
thing.SetItemNumber(itemNumber);
SetName(String)
Introduced or updated in version: 7.5
Declaration
Void SetName(String 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 |
Examples
NSQuoteLine thing;
String name;
thing.SetName(name);
SetPriceUnit(String)
Introduced or updated in version: 7.5
Declaration
Void SetPriceUnit(String 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 |
Examples
NSQuoteLine thing;
String priceUnit;
thing.SetPriceUnit(priceUnit);
SetProductCategoryKey(String)
Introduced or updated in version: 7.5
Declaration
Void SetProductCategoryKey(String 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 |
Examples
NSQuoteLine thing;
String productCategoryKey;
thing.SetProductCategoryKey(productCategoryKey);
SetProductFamilyKey(String)
Introduced or updated in version: 7.5
Declaration
Void SetProductFamilyKey(String 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 |
Examples
NSQuoteLine thing;
String productFamilyKey;
thing.SetProductFamilyKey(productFamilyKey);
SetProductTypeKey(String)
Introduced or updated in version: 7.5
Declaration
Void SetProductTypeKey(String 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 |
Examples
NSQuoteLine thing;
String productTypeKey;
thing.SetProductTypeKey(productTypeKey);
SetQuantity(Float)
Introduced or updated in version: 7.5
Declaration
Void SetQuantity(Float 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 |
Examples
NSQuoteLine thing;
Float quantity;
thing.SetQuantity(quantity);
SetQuantityUnit(String)
Introduced or updated in version: 7.5
Declaration
Void SetQuantityUnit(String 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 |
Examples
NSQuoteLine thing;
String quantityUnit;
thing.SetQuantityUnit(quantityUnit);
SetQuoteAlternativeId(Integer)
Introduced or updated in version: 7.5
Declaration
Void SetQuoteAlternativeId(Integer quoteAlternativeId)
Parameters
Type | Name | Description |
---|---|---|
Integer | quoteAlternativeId | The alternative this line is part of, the conceptual Parent in CRM database. |
Returns
Type | Description |
---|---|
Void |
Examples
NSQuoteLine thing;
Integer quoteAlternativeId;
thing.SetQuoteAlternativeId(quoteAlternativeId);
SetQuoteLineId(Integer)
Introduced or updated in version: 7.5
Declaration
Void SetQuoteLineId(Integer quoteLineId)
Parameters
Type | Name | Description |
---|---|---|
Integer | quoteLineId | Primary key. |
Returns
Type | Description |
---|---|
Void |
Examples
NSQuoteLine thing;
Integer quoteLineId;
thing.SetQuoteLineId(quoteLineId);
SetRank(Integer)
Introduced or updated in version: 7.5
Declaration
Void SetRank(Integer rank)
Parameters
Type | Name | Description |
---|---|---|
Integer | rank | QuoteLines can be re-ordered, so we must track the ordering. |
Returns
Type | Description |
---|---|
Void |
Examples
NSQuoteLine thing;
Integer rank;
thing.SetRank(rank);
SetRawExtraInfo(String)
Introduced or updated in version: 7.5
Declaration
Void SetRawExtraInfo(String 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 |
Examples
NSQuoteLine thing;
String rawExtraInfo;
thing.SetRawExtraInfo(rawExtraInfo);
SetReason(String)
Introduced or updated in version: 7.5
Declaration
Void SetReason(String 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 |
Examples
NSQuoteLine thing;
String reason;
thing.SetReason(reason);
SetRights(String)
Introduced or updated in version: 7.5
Declaration
Void SetRights(String rights)
Parameters
Type | Name | Description |
---|---|---|
String | rights | 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. Will be used by SuperOffice to control the user interface when showing the record. |
Returns
Type | Description |
---|---|
Void |
Examples
NSQuoteLine thing;
String rights;
thing.SetRights(rights);
SetRule(String)
Introduced or updated in version: 7.5
Declaration
Void SetRule(String 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 |
Examples
NSQuoteLine thing;
String rule;
thing.SetRule(rule);
SetStatus(Integer)
Introduced or updated in version: 7.5
Declaration
Void SetStatus(Integer 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 QuoteStatus. |
Returns
Type | Description |
---|---|
Void |
Examples
NSQuoteLine thing;
Integer status;
thing.SetStatus(status);
SetSubscriptionQuantity(Float)
Introduced or updated in version: 7.5
Declaration
Void SetSubscriptionQuantity(Float 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 |
Examples
NSQuoteLine thing;
Float subscriptionQuantity;
thing.SetSubscriptionQuantity(subscriptionQuantity);
SetSubscriptionStart(DateTime)
Introduced or updated in version: 7.5
Declaration
Void SetSubscriptionStart(DateTime subscriptionStart)
Parameters
Type | Name | Description |
---|---|---|
DateTime | subscriptionStart | Start date for subscription, as offered. |
Returns
Type | Description |
---|---|
Void |
Examples
NSQuoteLine thing;
DateTime subscriptionStart;
thing.SetSubscriptionStart(subscriptionStart);
SetSubscriptionUnit(String)
Introduced or updated in version: 7.5
Declaration
Void SetSubscriptionUnit(String 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 |
Examples
NSQuoteLine thing;
String subscriptionUnit;
thing.SetSubscriptionUnit(subscriptionUnit);
SetSubTotal(Float)
Introduced or updated in version: 7.5
Declaration
Void SetSubTotal(Float subTotal)
Parameters
Type | Name | Description |
---|---|---|
Float | subTotal | Value to help the user interface, is equal to 'Quantity * ListPrice' |
Returns
Type | Description |
---|---|
Void |
Examples
NSQuoteLine thing;
Float subTotal;
thing.SetSubTotal(subTotal);
SetSupplier(String)
Introduced or updated in version: 7.5
Declaration
Void SetSupplier(String 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 |
Examples
NSQuoteLine thing;
String supplier;
thing.SetSupplier(supplier);
SetSupplierCode(String)
Introduced or updated in version: 7.5
Declaration
Void SetSupplierCode(String 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 |
Examples
NSQuoteLine thing;
String supplierCode;
thing.SetSupplierCode(supplierCode);
SetThumbnail(String)
Introduced or updated in version: 7.5
Declaration
Void SetThumbnail(String 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 |
Examples
NSQuoteLine thing;
String thumbnail;
thing.SetThumbnail(thumbnail);
SetTotalPrice(Float)
Introduced or updated in version: 7.5
Declaration
Void SetTotalPrice(Float 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 |
Examples
NSQuoteLine thing;
Float totalPrice;
thing.SetTotalPrice(totalPrice);
SetUnitCost(Float)
Introduced or updated in version: 7.5
Declaration
Void SetUnitCost(Float 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 |
Examples
NSQuoteLine thing;
Float unitCost;
thing.SetUnitCost(unitCost);
SetUnitListPrice(Float)
Introduced or updated in version: 7.5
Declaration
Void SetUnitListPrice(Float unitListPrice)
Parameters
Type | Name | Description |
---|---|---|
Float | unitListPrice | The standard list price; as given by ERP Connector, OR overridden by user. |
Returns
Type | Description |
---|---|
Void |
Examples
NSQuoteLine thing;
Float unitListPrice;
thing.SetUnitListPrice(unitListPrice);
SetUnitMinimumPrice(Float)
Introduced or updated in version: 7.5
Declaration
Void SetUnitMinimumPrice(Float 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 |
Examples
NSQuoteLine thing;
Float unitMinimumPrice;
thing.SetUnitMinimumPrice(unitMinimumPrice);
SetUrl(String)
Introduced or updated in version: 7.5
Declaration
Void SetUrl(String 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 |
Examples
NSQuoteLine thing;
String url;
thing.SetUrl(url);
SetUserValueOverride(Integer)
Introduced or updated in version: 7.5
Declaration
Void SetUserValueOverride(Integer userValueOverride)
Parameters
Type | Name | Description |
---|---|---|
Integer | userValueOverride | Has the pre-calculated (from ERP) price information been overridden, and how. See ValueOverride. |
Returns
Type | Description |
---|---|
Void |
Remarks
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.)
Examples
NSQuoteLine thing;
Integer userValueOverride;
thing.SetUserValueOverride(userValueOverride);
SetVAT(Float)
Introduced or updated in version: 7.5
Declaration
Void SetVAT(Float 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 |
Examples
NSQuoteLine thing;
Float vAT;
thing.SetVAT(vAT);
SetVATInfo(String)
Introduced or updated in version: 7.5
Declaration
Void SetVATInfo(String 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 |
Examples
NSQuoteLine thing;
String vATInfo;
thing.SetVATInfo(vATInfo);