NSProduct - SuperOffice

Information about a Product from the ERP system. This may be fetched from SuperOffice Product table through the SO Connector.

Constructors

NSProduct()

NSProduct

Initializes a new instance of the NSProduct class.

Methods

GetCode()

String GetCode()

Returns: CRMScript.Global.String - The product code / article number in the product supplier system. Example:

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

GetDefaultSubscriptionQuantity()

Float GetDefaultSubscriptionQuantity()

Returns: CRMScript.Global.Float - The default number of SubscriptionUnits to suggest when creating quote lines from this product. Example:

NSProduct thing;
Float defaultSubscriptionQuantity = thing.GetDefaultSubscriptionQuantity();

GetDescription()

String GetDescription()

Returns: CRMScript.Global.String - The description to use, with potentially several lines. Will be used as tool-tip to use in the list user interface too. Example:

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

GetERPPriceListKey()

String GetERPPriceListKey()

Returns: CRMScript.Global.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. Example:

NSProduct thing;
String eRPPriceListKey = thing.GetERPPriceListKey();

GetERPProductKey()

String GetERPProductKey()

Returns: CRMScript.Global.String - Reference/foreign key to the product in the given price list in the product supplier system, if it exists there. Example:

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

GetExtraField1()

String GetExtraField1()

Returns: CRMScript.Global.String - A simple field for adding information that the Connector can provide, and that the quote document need to display. Example:

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

GetExtraField2()

String GetExtraField2()

Returns: CRMScript.Global.String - A simple field for adding information that the Connector can provide, and that the quote document need to display. Example:

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

GetExtraField3()

String GetExtraField3()

Returns: CRMScript.Global.String - A simple field for adding information that the Connector can provide, and that the quote document need to display. Example:

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

GetExtraField4()

String GetExtraField4()

Returns: CRMScript.Global.String - A simple field for adding information that the Connector can provide, and that the quote document need to display. Example:

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

GetExtraField5()

String GetExtraField5()

Returns: CRMScript.Global.String - A simple field for adding information that the Connector can provide, and that the quote document need to display. Example:

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

GetExtraInfo()

NSProductExtraDataField[] GetExtraInfo()

Returns: CRMScript.NetServer.NSProductExtraDataField[] - Extra information, supplied by QuoteConnector, used by a future dynamic GUI extension. Example:

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

GetInAssortment()

Bool GetInAssortment()

Returns: CRMScript.Global.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. Example:

NSProduct thing;
Bool inAssortment = thing.GetInAssortment();

GetInStock()

Float GetInStock()

Returns: CRMScript.Global.Float - Negative numbers will be interpreted as how many is ordered. Might not be available. Example:

NSProduct thing;
Float inStock = thing.GetInStock();

GetIsSubscription()

Bool GetIsSubscription()

Returns: CRMScript.Global.Bool - Is this a subscription product, sold in repeating intervals/amounts? Example:

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

GetItemNumber()

String GetItemNumber()

Returns: CRMScript.Global.String - Line item number, NOR «Postnummer». Specific numbers from some hierarchy, for instance “1.4.3.2P”.

Typically used to sort the items in the quote by some standard way.

Example:

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

GetName()

String GetName()

Returns: CRMScript.Global.String - The name to use in the user interface. Example:

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

GetPriceUnit()

String GetPriceUnit()

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

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

GetProductCategoryKey()

String GetProductCategoryKey()

Returns: CRMScript.Global.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. Example:

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

GetProductFamilyKey()

String GetProductFamilyKey()

Returns: CRMScript.Global.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. Example:

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

GetProductId()

Integer GetProductId()

Returns: CRMScript.Global.Integer - Primary key. Example:

NSProduct thing;
Integer productId = thing.GetProductId();

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.

String GetProductTypeKey()

Returns: CRMScript.Global.String Example:

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

GetQuantityUnit()

String GetQuantityUnit()

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

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

GetRawExtraInfo()

String GetRawExtraInfo()

Returns: CRMScript.Global.String - Read-only extra information in plain text, supplied by QuoteConnector, used by a future dynamic GUI extension. Example:

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

GetRights()

String GetRights()

Returns: CRMScript.Global.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.

Will be used by SuperOffice to control the user interface when showing the record.

Example:

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

GetRule()

String GetRule()

Returns: CRMScript.Global.String - The names of one or more calculation rules that are in effect for this line, comma-separated case-insensitive.

Will NOT be used by SuperOffice.

Example:

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

GetSubscriptionUnit()

String GetSubscriptionUnit()

Returns: CRMScript.Global.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. Example:

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

GetSupplier()

String GetSupplier()

Returns: CRMScript.Global.String - In SuperOffice, an ID from the contact table, when saved as an ERP cache, the name of the supplier. Example:

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

GetSupplierCode()

String GetSupplierCode()

Returns: CRMScript.Global.String - Suppliers part code/number or other key-like field. Example:

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

GetUnitCost()

Float GetUnitCost()

Returns: CRMScript.Global.Float - The cost price. Might not be given, use Decimal.MinValue to signal this. Example:

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

GetUnitListPrice()

Float GetUnitListPrice()

Returns: CRMScript.Global.Float - The basic/normal/standard price from which the discount is computed from.

The ListPrice will stay the same even when a larger amount is ordered.

Example:

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

GetUnitMinimumPrice()

Float GetUnitMinimumPrice()

Returns: CRMScript.Global.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. Example:

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

GetUrl()

String GetUrl()

Returns: CRMScript.Global.String - URL to product information web page. Example:

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

GetVAT()

Float GetVAT()

Returns: CRMScript.Global.Float - Tax/VAT if available from ERP system. THIS IS A PERCENTAGE.

In the Superoffice product register, this field is available in the product admin GUI.

Example:

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

GetVATInfo()

String GetVATInfo()

Returns: CRMScript.Global.String - VATInfo you need to show in the final quoteDocument, like the VAT type that is used.

Not used in any business logic in SuperOffice; available to document templates.

Example:

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

SetCode(String)

Void SetCode(String code)

Returns: CRMScript.Global.Void Example:

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

SetDefaultSubscriptionQuantity(Float)

Void SetDefaultSubscriptionQuantity(Float defaultSubscriptionQuantity)

Returns: CRMScript.Global.Void Example:

NSProduct thing;
Float defaultSubscriptionQuantity;
thing.SetDefaultSubscriptionQuantity(defaultSubscriptionQuantity);

SetDescription(String)

Void SetDescription(String description)

Returns: CRMScript.Global.Void Example:

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

SetERPPriceListKey(String)

Void SetERPPriceListKey(String eRPPriceListKey)

Returns: CRMScript.Global.Void Example:

NSProduct thing;
String eRPPriceListKey;
thing.SetERPPriceListKey(eRPPriceListKey);

SetERPProductKey(String)

Void SetERPProductKey(String eRPProductKey)

Returns: CRMScript.Global.Void Example:

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

SetExtraField1(String)

Void SetExtraField1(String extraField1)

Returns: CRMScript.Global.Void Example:

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

SetExtraField2(String)

Void SetExtraField2(String extraField2)

Returns: CRMScript.Global.Void Example:

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

SetExtraField3(String)

Void SetExtraField3(String extraField3)

Returns: CRMScript.Global.Void Example:

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

SetExtraField4(String)

Void SetExtraField4(String extraField4)

Returns: CRMScript.Global.Void Example:

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

SetExtraField5(String)

Void SetExtraField5(String extraField5)

Returns: CRMScript.Global.Void Example:

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

SetExtraInfo(NSProductExtraDataField[])

Void SetExtraInfo(NSProductExtraDataField[] extraInfo)

Returns: CRMScript.Global.Void Example:

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

SetInAssortment(Bool)

Void SetInAssortment(Bool inAssortment)

Returns: CRMScript.Global.Void Example:

NSProduct thing;
Bool inAssortment;
thing.SetInAssortment(inAssortment);

SetInStock(Float)

Void SetInStock(Float inStock)

Returns: CRMScript.Global.Void Example:

NSProduct thing;
Float inStock;
thing.SetInStock(inStock);

SetIsSubscription(Bool)

Void SetIsSubscription(Bool isSubscription)

Returns: CRMScript.Global.Void Example:

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

SetItemNumber(String)

Void SetItemNumber(String itemNumber)

Returns: CRMScript.Global.Void

Typically used to sort the items in the quote by some standard way.

Example:

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

SetName(String)

Void SetName(String name)

Returns: CRMScript.Global.Void Example:

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

SetPriceUnit(String)

Void SetPriceUnit(String priceUnit)

Returns: CRMScript.Global.Void Example:

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

SetProductCategoryKey(String)

Void SetProductCategoryKey(String productCategoryKey)

Returns: CRMScript.Global.Void Example:

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

SetProductFamilyKey(String)

Void SetProductFamilyKey(String productFamilyKey)

Returns: CRMScript.Global.Void Example:

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

SetProductId(Integer)

Void SetProductId(Integer productId)

Returns: CRMScript.Global.Void Example:

NSProduct thing;
Integer productId;
thing.SetProductId(productId);

SetProductTypeKey(String)

Void SetProductTypeKey(String productTypeKey)

Returns: CRMScript.Global.Void Example:

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

SetQuantityUnit(String)

Void SetQuantityUnit(String quantityUnit)

Returns: CRMScript.Global.Void Example:

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

SetRawExtraInfo(String)

Void SetRawExtraInfo(String rawExtraInfo)

Returns: CRMScript.Global.Void Example:

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

SetRights(String)

Void SetRights(String rights)

Returns: CRMScript.Global.Void

Will be used by SuperOffice to control the user interface when showing the record.

Example:

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

SetRule(String)

Void SetRule(String rule)

Returns: CRMScript.Global.Void

Will NOT be used by SuperOffice.

Example:

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

SetSubscriptionUnit(String)

Void SetSubscriptionUnit(String subscriptionUnit)

Returns: CRMScript.Global.Void Example:

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

SetSupplier(String)

Void SetSupplier(String supplier)

Returns: CRMScript.Global.Void Example:

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

SetSupplierCode(String)

Void SetSupplierCode(String supplierCode)

Returns: CRMScript.Global.Void Example:

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

SetUnitCost(Float)

Void SetUnitCost(Float unitCost)

Returns: CRMScript.Global.Void Example:

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

SetUnitListPrice(Float)

Void SetUnitListPrice(Float unitListPrice)

Returns: CRMScript.Global.Void

The ListPrice will stay the same even when a larger amount is ordered.

Example:

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

SetUnitMinimumPrice(Float)

Void SetUnitMinimumPrice(Float unitMinimumPrice)

Returns: CRMScript.Global.Void Example:

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

SetUrl(String)

Void SetUrl(String url)

Returns: CRMScript.Global.Void Example:

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

SetVAT(Float)

Void SetVAT(Float vAT)

Returns: CRMScript.Global.Void

In the Superoffice product register, this field is available in the product admin GUI.

Example:

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

SetVATInfo(String)

Void SetVATInfo(String vATInfo)

Returns: CRMScript.Global.Void

Not used in any business logic in SuperOffice; available to document templates.

Example:

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

Related topics

Products NSQuoteAgent Add quote line NSProductCategory NSProductFamily NSProductType

⌘I