Class ProductDataInfo

Data shared between a product and a quote line.

Inheritance
Object
ProductDataInfo
ProductInfo
QuoteLineInfo
Inherited Members
Namespace: SuperOffice.CRM
Assembly: SuperOffice.Plugins.dll
Syntax
public class ProductDataInfo

Constructors

ProductDataInfo()

Declaration
public ProductDataInfo()

Properties

Code

The product code / article number in the product supplier system.

Declaration
public string Code { get; set; }
Property Value
Type 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.

Declaration
public string Description { get; set; }
Property Value
Type Description
String

ERPProductKey

Reference/foreign key to the product in the product supplier system, if it exists there.

Declaration
public string ERPProductKey { get; set; }
Property Value
Type Description
String

ExtraField1

This a simple field for adding information that the Connector can provide , and that the quote document need to display.

Declaration
public string ExtraField1 { get; set; }
Property Value
Type Description
String

ExtraField2

This a simple field for adding information that the Connector can provide , and that the quote document need to display.

Declaration
public string ExtraField2 { get; set; }
Property Value
Type Description
String

ExtraField3

This a simple field for adding information that the Connector can provide , and that the quote document need to display.

Declaration
public string ExtraField3 { get; set; }
Property Value
Type Description
String

ExtraField4

This a simple field for adding information that the Connector can provide , and that the quote document need to display.

Declaration
public string ExtraField4 { get; set; }
Property Value
Type Description
String

ExtraField5

This a simple field for adding information that the Connector can provide , and that the quote document need to display.

Declaration
public string ExtraField5 { get; set; }
Property Value
Type Description
String

ExtraInfo

Extra data (fields with labels). Shall be shown in the quoteline dialog. Bucket of additional info that the ERP system would like to store and show in the user interface.

Information placed here is shown in the GUI if the “provide-extra-data” capability is true. Different products can have different fields. It will not be possible to directly put info here into the quote document.

Declaration
public ProductExtraDataFieldInfo[] ExtraInfo { get; set; }
Property Value
Type Description
ProductExtraDataFieldInfo[]
Examples

<Fields> <Field Name="Weight" Type="Double" Value="16.6" /> <Field Name="Height" Type="Double" Value="4.0" /> <Field Name="Arms" Type="Integer" Value="2" /> <Field Name="Certification" Type="String" Value="AB-ICE" /> <Field Name="Weight" Type="String" Value="40°C" /> </Fields>

IsSubscription

Is this a running subscription, rather than a one-time buy

Declaration
public bool IsSubscription { get; set; }
Property Value
Type Description
Boolean

ItemNumber

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.

Declaration
public string ItemNumber { get; set; }
Property Value
Type Description
String

Name

The name to use in the user interface

Declaration
public string Name { get; set; }
Property Value
Type Description
String

PriceUnit

Unit for determining the price: 5-Pack, 10-cm, meter, ton, bushel, microsecond, gradus, τρυβλίον, 五合枡, دونم or whatever

Declaration
public string PriceUnit { get; set; }
Property Value
Type Description
String

ProductCategoryKey

Either a List id to an id from a connector provided list, or, if the connection doesn’t support lists, a text with the actual product category.

Declaration
public string ProductCategoryKey { get; set; }
Property Value
Type Description
String

ProductFamilyKey

Either a List id to an id from a connector provided list, or, if the connection doesn't support lists, a text with the actual product family.

Declaration
public string ProductFamilyKey { get; set; }
Property Value
Type Description
String

ProductTypeKey

Either a List id to an id from a connector provided list, or, if the connection doesn’t support lists, a text with the actual product type.

Declaration
public string ProductTypeKey { get; set; }
Property Value
Type Description
String

QuantityUnit

Unit for setting the sales quantity: 5-Pack, 10-cm, meter, ton, bushel, microsecond, gradus, τρυβλίον, 五合枡, دونم or whatever

Declaration
public string QuantityUnit { get; set; }
Property Value
Type Description
String

RawExtraInfo

Extra data (fields with labels) as string. Shall be shown in the quoteline dialog. Bucket of additional info that the ERP system would like to store and show in the user interface.

Information placed here is shown in the GUI if the “provide-extra-data” capability is true. Different products can have different fields. It will not be possible to directly put info here into the quote document.

Declaration
public string RawExtraInfo { get; set; }
Property Value
Type Description
String
Examples

<Fields> <Field Name="Weight" Type="Double" Value="16.6" /> <Field Name="Height" Type="Double" Value="4.0" /> <Field Name="Arms" Type="Integer" Value="2" /> <Field Name="Certification" Type="String" Value="AB-ICE" /> <Field Name="Weight" Type="String" Value="40°C" /> </Fields>

Rights

Rights attribute

Declaration
public string Rights { get; set; }
Property Value
Type Description
String

Rule

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.

Declaration
public string Rule { get; set; }
Property Value
Type Description
String

SubscriptionUnit

Either a List id to an id from a connector provided list, or, if the connection doesn’t support lists, a text with the actual subscription unit (year, month, ... or some kind of volume unit).

Declaration
public string SubscriptionUnit { get; set; }
Property Value
Type Description
String

Supplier

Name of the supplier of the product

Declaration
public string Supplier { get; set; }
Property Value
Type Description
String

SupplierCode

Suppliers part code/number or other key-like field

Declaration
public string SupplierCode { get; set; }
Property Value
Type Description
String

Thumbnail

The thumbnail of the product, if it exists. Base64 encoded string, or a valid URI that resolves to an image. Requires the “Provide-Thumbnail” capability.

Declaration
public string Thumbnail { get; set; }
Property Value
Type Description
String

UnitCost

The cost price. Might not be given, use Decimal.MinValue to signal this.

Declaration
public double UnitCost { get; set; }
Property Value
Type Description
Double

UnitListPrice

(Basic Price, normal price, standard price.) This is the basic price from which the discount is computed from. The ListPrice will stay the same even when a larger amount is ordered.

Declaration
public double UnitListPrice { get; set; }
Property Value
Type Description
Double

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.

Declaration
public double UnitMinimumPrice { get; set; }
Property Value
Type Description
Double

Url

URL to product information web page

Declaration
public string Url { get; set; }
Property Value
Type Description
String

VAT

Tax/VAT if available from ERP system. Could be either the percentage or the actual value. This is just to help out the layout of the quote in a document , but SuperOffice will not try to calculate this value.

Declaration
public double VAT { get; set; }
Property Value
Type Description
Double

VATInfo

A field for putting 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.

Declaration
public string VATInfo { get; set; }
Property Value
Type Description
String

Methods

GetFieldRight(String)

Returns the special product or quoteline right this product have

Declaration
public string GetFieldRight(string fieldname)
Parameters
Type Name Description
String fieldname
Returns
Type Description
String

HasFieldRight(String)

Does the name field have any right override?

Declaration
public bool HasFieldRight(string fieldname)
Parameters
Type Name Description
String fieldname
Returns
Type Description
Boolean

HasFieldRight(String, Char)

Does the named field has any special right overrides in this product or Quoteline?

Declaration
public bool HasFieldRight(string fieldname, char right)
Parameters
Type Name Description
String fieldname
Char right
Returns
Type Description
Boolean

IsFieldWritable(String)

Both 'M' and 'W' is editable / writable

Declaration
public bool IsFieldWritable(string fieldname)
Parameters
Type Name Description
String fieldname
Returns
Type Description
Boolean

SetRight(String, String)

Sets the right on the named field

Declaration
public void SetRight(string fieldname, string fieldRight)
Parameters
Type Name Description
String fieldname

case-sensitive name of QuoteLine field without tablename
String fieldRight

N=None/hidden, R=Read-only, W=Write/Editable, M=Editable+Mandatory
Examples

Rights field = "" fieldname="Quantity" fieldRight="W"

Result: Rights field = "Quanity=W"

Rights field = "Quanity=M;SomeOtherField=W" fieldname="Quantity" fieldRight="W"

Result: Rights field = "Quanity=W;SomeOtherField=W"

Extension Methods

EnumUtil.MapEnums<From, To>(From)