Class NSProduct
Information about a Product from the ERP system. This may be fetched from SuperOffice Product table through the SO Connector.
Constructors
NSProduct()
Initializes a new instance of the NSProduct class.
Declaration
NSProductMethods
GetCode()
Declaration
String GetCode()Examples
NSProduct thing;
String code = thing.GetCode();Returns
| Type | Description |
| String | The product code / article number in the product supplier system. |
GetDefaultSubscriptionQuantity()
Declaration
Float GetDefaultSubscriptionQuantity()Examples
NSProduct thing;
Float defaultSubscriptionQuantity = thing.GetDefaultSubscriptionQuantity();Returns
| Type | Description |
| Float | The default number of SubscriptionUnits to suggest when creating quote lines from this product. |
GetDescription()
Declaration
String GetDescription()Examples
NSProduct thing;
String description = thing.GetDescription();Returns
| Type | Description |
| String | The description to use, with potentially several lines. Will be used as tool-tip to use in the list user interface too. |
GetERPPriceListKey()
Declaration
String GetERPPriceListKey()Examples
NSProduct thing;
String eRPPriceListKey = thing.GetERPPriceListKey();Returns
| Type | Description |
| String | Foreign key to the price list that this product is a part of, or the primary key of the price list if this is a built-in list. |
GetERPProductKey()
Declaration
String GetERPProductKey()Examples
NSProduct thing;
String eRPProductKey = thing.GetERPProductKey();Returns
| Type | Description |
| String | Reference/foreign key to the product in the given price list in the product supplier system, if it exists there. |
GetExtraField1()
Declaration
String GetExtraField1()Examples
NSProduct 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
NSProduct 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
NSProduct 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
NSProduct 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
NSProduct 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
NSProduct thing;
NSProductExtraDataField[] extraInfo = thing.GetExtraInfo();Returns
| Type | Description |
| NSProductExtraDataField[] | Extra information, supplied by QuoteConnector, used by a future dynamic GUI extension. |
GetInAssortment()
Declaration
Bool GetInAssortment()Examples
NSProduct thing;
Bool inAssortment = thing.GetInAssortment();Returns
| Type | Description |
| Bool | True for products that should currently be offered, false when the product is discontinued and should not ordinarily be offered. When false the product no longer appears in search results. |
GetInStock()
Declaration
Float GetInStock()Examples
NSProduct thing;
Float inStock = thing.GetInStock();Returns
| Type | Description |
| Float | Negative numbers will be interpreted as how many is ordered. Might not be available. |
GetIsSubscription()
Declaration
Bool GetIsSubscription()Examples
NSProduct thing;
Bool isSubscription = thing.GetIsSubscription();Returns
| Type | Description |
| Bool | Is this a subscription product, sold in repeating intervals/amounts? |
GetItemNumber()
Declaration
String GetItemNumber()Examples
NSProduct thing;
String itemNumber = thing.GetItemNumber();Returns
| Type | Description |
| String | Line item number, NOR «Postnummer». Specific numbers from some hierarchy, for instance "1.4.3.2P". |
GetName()
Declaration
String GetName()Examples
NSProduct thing;
String name = thing.GetName();Returns
| Type | Description |
| String | The name to use in the user interface. |
GetPriceUnit()
Declaration
String GetPriceUnit()Examples
NSProduct 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
NSProduct 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 with the actual product category. |
GetProductFamilyKey()
Declaration
String GetProductFamilyKey()Examples
NSProduct 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 with the actual product family. |
GetProductId()
Declaration
Integer GetProductId()Examples
NSProduct thing;
Integer productId = thing.GetProductId();Returns
| Type | Description |
| Integer | Primary key. |
GetProductTypeKey()
Either a ListId to an ID from a connector provided list, or, if the connection doesn't support lists, a text with the actual product type.
Declaration
String GetProductTypeKey()Examples
NSProduct thing;
String productTypeKey = thing.GetProductTypeKey();Returns
| Type | Description |
| String |
GetQuantityUnit()
Declaration
String GetQuantityUnit()Examples
NSProduct 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. |
GetRawExtraInfo()
Declaration
String GetRawExtraInfo()Examples
NSProduct 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. |
GetRights()
Declaration
String GetRights()Examples
NSProduct 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 quoteline, like Image will also be possibly to set rights on. |
GetRule()
Declaration
String GetRule()Examples
NSProduct 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. |
GetSubscriptionUnit()
Declaration
String GetSubscriptionUnit()Examples
NSProduct 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. |
GetSupplier()
Declaration
String GetSupplier()Examples
NSProduct thing;
String supplier = thing.GetSupplier();Returns
| Type | Description |
| String | In SuperOffice, an ID from the contact table, when saved as an ERP cache, the name of the supplier. |
GetSupplierCode()
Declaration
String GetSupplierCode()Examples
NSProduct thing;
String supplierCode = thing.GetSupplierCode();Returns
| Type | Description |
| String | Suppliers part code/number or other key-like field. |
GetUnitCost()
Declaration
Float GetUnitCost()Examples
NSProduct thing;
Float unitCost = thing.GetUnitCost();Returns
| Type | Description |
| Float | The cost price. Might not be given, use Decimal.MinValue to signal this. |
GetUnitListPrice()
Declaration
Float GetUnitListPrice()Examples
NSProduct thing;
Float unitListPrice = thing.GetUnitListPrice();Returns
| Type | Description |
| Float | The basic/normal/standard price from which the discount is computed from. |
GetUnitMinimumPrice()
Declaration
Float GetUnitMinimumPrice()Examples
NSProduct thing;
Float unitMinimumPrice = thing.GetUnitMinimumPrice();Returns
| Type | Description |
| Float | The minimum price this salesman can offer to his customer. This might be cost price if there is no policy. Might not be given, use Decimal.MinValue to signal this. |
GetUrl()
Declaration
String GetUrl()Examples
NSProduct thing;
String url = thing.GetUrl();Returns
| Type | Description |
| String | URL to product information web page. |
GetVAT()
Declaration
Float GetVAT()Examples
NSProduct thing;
Float vAT = thing.GetVAT();Returns
| Type | Description |
| Float | Tax/VAT if available from ERP system. THIS IS A PERCENTAGE. |
GetVATInfo()
Declaration
String GetVATInfo()Examples
NSProduct thing;
String vATInfo = thing.GetVATInfo();Returns
| Type | Description |
| String | VATInfo you need to show in the final quoteDocument, like the VAT type that is used. |
SetCode(String)
Declaration
Void SetCode(String code)Examples
NSProduct thing;
String code;
thing.SetCode(code);Parameters
| Type | Name | Description |
| String | code | The product code / article number in the product supplier system. |
Returns
| Type | Description |
| Void |
SetDefaultSubscriptionQuantity(Float)
Declaration
Void SetDefaultSubscriptionQuantity(Float defaultSubscriptionQuantity)Examples
NSProduct thing;
Float defaultSubscriptionQuantity;
thing.SetDefaultSubscriptionQuantity(defaultSubscriptionQuantity);Parameters
| Type | Name | Description |
| Float | defaultSubscriptionQuantity | The default number of SubscriptionUnits to suggest when creating quote lines from this product. |
Returns
| Type | Description |
| Void |
SetDescription(String)
Declaration
Void SetDescription(String description)Examples
NSProduct thing;
String description;
thing.SetDescription(description);Parameters
| Type | Name | Description |
| String | description | The description to use, with potentially several lines. Will be used as tool-tip to use in the list user interface too. |
Returns
| Type | Description |
| Void |
SetERPPriceListKey(String)
Declaration
Void SetERPPriceListKey(String eRPPriceListKey)Examples
NSProduct thing;
String eRPPriceListKey;
thing.SetERPPriceListKey(eRPPriceListKey);Parameters
| Type | Name | Description |
| String | eRPPriceListKey | Foreign key to the price list that this product is a part of, or the primary key of the price list if this is a built-in list. |
Returns
| Type | Description |
| Void |
SetERPProductKey(String)
Declaration
Void SetERPProductKey(String eRPProductKey)Examples
NSProduct thing;
String eRPProductKey;
thing.SetERPProductKey(eRPProductKey);Parameters
| Type | Name | Description |
| String | eRPProductKey | Reference/foreign key to the product in the given price list in the product supplier system, if it exists there. |
Returns
| Type | Description |
| Void |
SetExtraField1(String)
Declaration
Void SetExtraField1(String extraField1)Examples
NSProduct 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
NSProduct 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
NSProduct 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
NSProduct 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
NSProduct 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
NSProduct 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 |
SetInAssortment(Bool)
Declaration
Void SetInAssortment(Bool inAssortment)Examples
NSProduct thing;
Bool inAssortment;
thing.SetInAssortment(inAssortment);Parameters
| Type | Name | Description |
| Bool | inAssortment | True for products that should currently be offered, false when the product is discontinued and should not ordinarily be offered. When false the product no longer appears in search results. |
Returns
| Type | Description |
| Void |
SetInStock(Float)
Declaration
Void SetInStock(Float inStock)Examples
NSProduct thing;
Float inStock;
thing.SetInStock(inStock);Parameters
| Type | Name | Description |
| Float | inStock | Negative numbers will be interpreted as how many is ordered. Might not be available. |
Returns
| Type | Description |
| Void |
SetIsSubscription(Bool)
Declaration
Void SetIsSubscription(Bool isSubscription)Examples
NSProduct 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
NSProduct thing;
String itemNumber;
thing.SetItemNumber(itemNumber);Parameters
| Type | Name | Description |
| String | itemNumber | Line item number, NOR «Postnummer». Specific numbers from some hierarchy, for instance "1.4.3.2P". |
Returns
| Type | Description |
| Void |
SetName(String)
Declaration
Void SetName(String name)Examples
NSProduct thing;
String name;
thing.SetName(name);Parameters
| Type | Name | Description |
| String | name | The name to use in the user interface. |
Returns
| Type | Description |
| Void |
SetPriceUnit(String)
Declaration
Void SetPriceUnit(String priceUnit)Examples
NSProduct 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
NSProduct 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 with the actual product category. |
Returns
| Type | Description |
| Void |
SetProductFamilyKey(String)
Declaration
Void SetProductFamilyKey(String productFamilyKey)Examples
NSProduct 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 with the actual product family. |
Returns
| Type | Description |
| Void |
SetProductId(Integer)
Declaration
Void SetProductId(Integer productId)Examples
NSProduct thing;
Integer productId;
thing.SetProductId(productId);Parameters
| Type | Name | Description |
| Integer | productId | Primary key. |
Returns
| Type | Description |
| Void |
SetProductTypeKey(String)
Declaration
Void SetProductTypeKey(String productTypeKey)Examples
NSProduct 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 with the actual product type. |
Returns
| Type | Description |
| Void |
SetQuantityUnit(String)
Declaration
Void SetQuantityUnit(String quantityUnit)Examples
NSProduct 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 |
SetRawExtraInfo(String)
Declaration
Void SetRawExtraInfo(String rawExtraInfo)Examples
NSProduct 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 |
SetRights(String)
Declaration
Void SetRights(String rights)Examples
NSProduct thing;
String rights;
thing.SetRights(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 quoteline, like Image will also be possibly to set rights on. |
Returns
| Type | Description |
| Void |
SetRule(String)
Declaration
Void SetRule(String rule)Examples
NSProduct 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 |
SetSubscriptionUnit(String)
Declaration
Void SetSubscriptionUnit(String subscriptionUnit)Examples
NSProduct 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 |
SetSupplier(String)
Declaration
Void SetSupplier(String supplier)Examples
NSProduct thing;
String supplier;
thing.SetSupplier(supplier);Parameters
| Type | Name | Description |
| String | supplier | In SuperOffice, an ID from the contact table, when saved as an ERP cache, the name of the supplier. |
Returns
| Type | Description |
| Void |
SetSupplierCode(String)
Declaration
Void SetSupplierCode(String supplierCode)Examples
NSProduct thing;
String supplierCode;
thing.SetSupplierCode(supplierCode);Parameters
| Type | Name | Description |
| String | supplierCode | Suppliers part code/number or other key-like field. |
Returns
| Type | Description |
| Void |
SetUnitCost(Float)
Declaration
Void SetUnitCost(Float unitCost)Examples
NSProduct thing;
Float unitCost;
thing.SetUnitCost(unitCost);Parameters
| Type | Name | Description |
| Float | unitCost | The cost price. Might not be given, use Decimal.MinValue to signal this. |
Returns
| Type | Description |
| Void |
SetUnitListPrice(Float)
Declaration
Void SetUnitListPrice(Float unitListPrice)Examples
NSProduct thing;
Float unitListPrice;
thing.SetUnitListPrice(unitListPrice);Parameters
| Type | Name | Description |
| Float | unitListPrice | The basic/normal/standard price from which the discount is computed from. |
Returns
| Type | Description |
| Void |
SetUnitMinimumPrice(Float)
Declaration
Void SetUnitMinimumPrice(Float unitMinimumPrice)Examples
NSProduct thing;
Float unitMinimumPrice;
thing.SetUnitMinimumPrice(unitMinimumPrice);Parameters
| Type | Name | Description |
| Float | unitMinimumPrice | The minimum price this salesman can offer to his customer. This might be cost price if there is no policy. Might not be given, use Decimal.MinValue to signal this. |
Returns
| Type | Description |
| Void |
SetUrl(String)
Declaration
Void SetUrl(String url)Examples
NSProduct thing;
String url;
thing.SetUrl(url);Parameters
| Type | Name | Description |
| String | url | URL to product information web page. |
Returns
| Type | Description |
| Void |