Class Product

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll Carrier object for Product. Information about a Product from the ERP system. This may be fetched from SuperOffice Product table through the SO Connector

public class Product : Carrier

Inheritance

object ← Carrier ← Product

Inherited Members

Carrier.TableRight, Carrier.FieldProperties, object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

Examples

Get Product 123 using the WebApi client:

var configuration = new WebApiConfiguration(url);
var agent = new QuoteAgent(configuration);
var product = agent.GetProduct( 123 );

Remarks

Use : All Product:

“Product”

Constructors

Product()

Default constructor - defaults any enum props to 0.

public Product()

Properties

Code

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

public virtual string Code { get; set; }

Property Value

DefaultSubscriptionQuantity

The default number of SubscriptionUnits to suggest when creating quote lines from this product

public virtual double DefaultSubscriptionQuantity { get; set; }

Property Value

Description

The description to use, with potentially several lines. Will be used as tool-tip to use in the list user interface too.

public virtual string Description { get; set; }

Property Value

ERPPriceListKey

Foreign key to the price list that this product is a part of, or the primary key of the pricelist if this is a built-in pricelist.

public virtual string ERPPriceListKey { get; set; }

Property Value

ERPProductKey

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

public virtual string ERPProductKey { get; set; }

Property Value

ExtraField1

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

public virtual string ExtraField1 { get; set; }

Property Value

ExtraField2

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

public virtual string ExtraField2 { get; set; }

Property Value

ExtraField3

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

public virtual string ExtraField3 { get; set; }

Property Value

ExtraField4

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

public virtual string ExtraField4 { get; set; }

Property Value

ExtraField5

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

public virtual string ExtraField5 { get; set; }

Property Value

ExtraInfo

Extra information, supplied by QuoteConnector, used by a future dynamic GUI extension

public virtual ProductExtraDataField[] ExtraInfo { get; set; }

Property Value

ProductExtraDataField[]

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.

public virtual bool InAssortment { get; set; }

Property Value

InStock

Negative numbers will be interpreted as how many is ordered. Might not be available.

public virtual double InStock { get; set; }

Property Value

IsSubscription

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

public virtual bool IsSubscription { get; set; }

Property Value

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.

public virtual string ItemNumber { get; set; }

Property Value

Name

The name to use in the user interface.

public virtual string Name { get; set; }

Property Value

PriceUnit

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

public virtual string PriceUnit { get; set; }

Property Value

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.

public virtual string ProductCategoryKey { get; set; }

Property Value

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.

public virtual string ProductFamilyKey { get; set; }

Property Value

ProductId

Primary key

public virtual int ProductId { get; set; }

Property Value

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.

public virtual string ProductTypeKey { get; set; }

Property Value

QuantityUnit

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

public virtual string QuantityUnit { get; set; }

Property Value

RawExtraInfo

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

public virtual string RawExtraInfo { get; set; }

Property Value

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. Will be used by SuperOffice to control the user interface when showing the record.

public virtual string Rights { get; set; }

Property Value

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.

public virtual string Rule { get; set; }

Property Value

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.

public virtual string SubscriptionUnit { get; set; }

Property Value

Supplier

In SuperOffice, an id from the contact table, when saved as an ERP cache, the name of the supplier

public virtual string Supplier { get; set; }

Property Value

SupplierCode

Suppliers part code/number or other key-like field

public virtual string SupplierCode { get; set; }

Property Value

UnitCost

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

public virtual double UnitCost { get; set; }

Property Value

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.

public virtual double UnitListPrice { get; set; }

Property Value

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.

public virtual double UnitMinimumPrice { get; set; }

Property Value

Url

URL to product information web page.

public virtual string Url { get; set; }

Property Value

VAT

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.

public virtual double VAT { get; set; }

Property Value

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.

public virtual string VATInfo { get; set; }

Property Value

See Also

QuoteAgent, ArchiveAgent,

Related topics

WebAPI changes in SuperOffice 12.0 WebAPI changes in SuperOffice 12.1 WebAPI changes in SuperOffice 12.2 SuperOffice WebApi How to use SuperOffice.WebApi How to create a user-defined field using the web services API How to get a system user ticket credential

⌘I