Skip to main content

Class QuoteLine

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for QuoteLine. Information about a connection to the ERP system.

Inheritance

objectCarrierQuoteLine

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()

Constructors

QuoteLine()

Default constructor - defaults any enum props to 0.

Properties

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 pricelist, or just enters a QuoteLine without a product link.

Property Value

string

DeliveredQuantity

How many units have been delivered - updated by ERP system.

Property Value

double

Description

A longer description for the product. Is stored here if the user changes the value from the product in the pricelist, or just enters a QuoteLine without a product link.

Property Value

string

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.

Property Value

double

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’.

Property Value

double

ERPDiscountAmount

The discount the system calculates based on customer / quantity / whatever. Can be overrided 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.

Property Value

double

ERPDiscountPercent

The discount the system calculates based on customer / quantity / whatever. Can be overrided 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’.

Property Value

double

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.

Property Value

string

ERPQuoteLineKey

The foreign key to the quoteline in ERP system (if it has such a representation).

Property Value

string

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.

Property Value

double

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’.

Property Value

double

ExtraField1

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

Property Value

string

ExtraField2

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

Property Value

string

ExtraField3

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

Property Value

string

ExtraField4

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

Property Value

string

ExtraField5

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

Property Value

string

ExtraInfo

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

Property Value

ProductExtraDataField[]

IsSubscription

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

Property Value

bool

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 pricelist, or just enters a QuoteLine without a product link.

Property Value

string

Name

The name of the product. Is stored here if the user changes the value from the product in the pricelist, or just enters a QuoteLine without a product link.

Property Value

string

PriceUnit

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

Property Value

string

ProductCategoryKey

Either a List id 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.

Property Value

string

ProductFamilyKey

Either a List id 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.

Property Value

string

ProductTypeKey

Either a List id 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.

Property Value

string

Quantity

How many units; this is a decimal field since you might want to offer fractional units (2.5kg, or 0.5PC).

Property Value

double

QuantityUnit

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

Property Value

string

QuoteAlternativeId

The alternative this line is part of, the conceptual Parent in CRM database.

Property Value

int

QuoteLineId

Primary key

Property Value

int

Rank

QuoteLines can be re-ordered, so we must track the ordering.

Property Value

int

RawExtraInfo

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

Property Value

string

Reason

If QuoteStatus is not OK, then this field contains a localized explanation that the user can be shown.

Property Value

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

Property Value

string

Rule

The names of one or more calculation rules that are in effect for this line, comma-separated case-insensitive

Property Value

string

Status

If there was a problem with for instance calculation, this field is set to warning or error. Typically shown as an icon. QuoteStatus is an enum with statuses: OK, OKWithInfo, Warning, Error. NULL if unknown enum value.

Property Value

QuoteStatus?

See Also

QuoteLine.Status_String

Status_String

If there was a problem with for instance calculation, this field is set to warning or error. Typically shown as an icon. QuoteStatus is an enum with statuses: OK, OKWithInfo, Warning, Error. Raw string enum value.

Property Value

string

See Also

QuoteLine.Status

SubTotal

Value to help the user interface, is equal to ‘Quantity * ListPrice’

Property Value

double

SubscriptionQuantity

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

Property Value

double

SubscriptionStart

Start date for subscription, as offered

Property Value

DateTime

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.

Property Value

string

Supplier

The name of the supplier. Is stored here if the user changes the value from the product in the pricelist, or just enters a QuoteLine without a product link.

Property Value

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 pricelist, or just enters a QuoteLine without a product link.

Property Value

string

Thumbnail

A small image of the product, typically used to show in a list. Base64 encoded png.

Property Value

string

TotalPrice

TotalPrice = SubTotal - DiscountAmount or TotalPrice = (UnitCost * Quantity) + EarningAmount, according to what the user changed last.

Property Value

double

UnitCost

The cost price per unit for this product. May be filled in by connector if it has the Provide-Cost capability.

Property Value

double

UnitListPrice

The standard list price; as given by ERP Connector, OR overridden by user

Property Value

double

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.

Property Value

double

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.

Property Value

string

UserValueOverride

Has the pre-calculated (from ERP) price information been overridden, and how. 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.) NULL if unknown enum value.

Property Value

ValueOverride?

See Also

QuoteLine.UserValueOverride_String

UserValueOverride_String

Has the pre-calculated (from ERP) price information been overridden, and how. 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.) Raw string enum value.

Property Value

string

See Also

QuoteLine.UserValueOverride

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).

Property Value

double

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.

Property Value

string

See Also

QuoteAgent