Get Quote Alternative

Headers

Accept-Language

string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language

string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture

string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone

string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken

string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

quoteAlternativeId

integer<int32>

required

The identifier of the QuoteAlternative object

$select

string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Response

Information about a connection to the ERP system. Carrier object for QuoteAlternative. Services for the QuoteAlternative Carrier is available from the Quote Agent.

QuoteAlternativeId

integer<int32>

Primary key

ERPQuoteAlternativeKey

string

Key that identifies this alternative in the ERP system, if it exists there.

QuoteVersionId

integer<int32>

The version that owns this alternative (the chain is Sale 1->1 Quote 1->+ QuoteVersion 1->+ QuoteAlternative.

Name

string

Name of Alternative. Shown in tab in user interface, intentionally kept short

Description

string

The tool-tip to use in the user interface (on the tab, for instance).

Status

enum<string>

If there was a problem with for instance calculation, this field is set to warning or error.

Available options:

Ok,

OkWithInfo,

Warning,

Error

Reason

string

If there was a problem, this field contains a localized explanation of the problem and possible steps to fix it that the user can be shown.

ERPDiscountPercent

number<double>

The discount the system calculates based on customer /amount / whatever. Can be overridden by the sales rep in the field ‘DiscountPercent’ or ‘DiscountAmount’. Both the two ‘ERPDiscountPercent’ and ‘ERPDiscountAmount’ shall be filled out. If UserValueOverride is 'None', then the ERPDiscountAmount shall be copied into DiscountAmount and ERPDiscountPercent into DiscountPercent. The Percentage is given in integer form, i.e. ‘12%’ is represented as ‘12’.

ERPDiscountAmount

number<double>

The discount the system calculates based on customer /amount / whatever. Can be overridden by the user in the field ‘DiscountPercent’ or ‘DiscountAmount’. Both the two ‘ERPDiscountPercent’ and ‘ERPDiscountAmount’ shall be filled out. If UserValueOverride is 'None', then the ERPDiscountAmount shall be copied into DiscountAmount and ERPDiscountPercent into DiscountPercent.

DiscountPercent

number<double>

The discount the sales rep specifies, in percent. Both the two ‘DiscountPercent’ and ‘DiscountAmount’ shall be filled out, but the UserValueOverride field must be set to the field the user actually changed. If this field is filled out by the user, it overrides the discount suggested by the connector. If the user has not filled any values, the system will copy the ERP discount percent value into this field. The Percentage is given in integer form, i.e. ‘12%’ is represented as ‘12’.

DiscountAmount

number<double>

The discount the sales rep specifies, in whatever currency the sale is in. Both the two ‘DiscountPercent’ and ‘DiscountAmount’ shall be filled out, but the UserValueOverride field must be set to the field the user actually changed. If this field is filled out by the user, it overrides the discount suggested by the connector. If the user has not filled any values, the system will copy the ERP discount amount value into this field.

UserValueOverride

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

Available options:

None,

Total,

DiscountPercent,

DiscountAmount,

EarningPercent,

EarningAmount

VATInfo

string

Extra info about VAT that the connector might insert. This field has no business logic in the CRM code, but is available as a merge field in the quote documents.

VAT

number<double>

Tax/VAT - THIS IS AN AMOUNT, available as a merge field in the quote document. The SuperOffice quote connector will calculate this field based on the vat PERCENTAGES on the individual lines; other connectors may implement other algorithms at will.

EarningPercent

number<double>

The earning on this alternative, in percent of total. The Percentage is given in integer form, i.e. ‘12%’ is represented as ‘12’.

EarningAmount

number<double>

Earning on this alternative, as an absolute amount

SubTotal

number<double>

Value to help the user interface, is computed by summing the totalprice of the quotelines, and NOT by summing their subtotals

TotalPrice

number<double>

Sum of the QuoteLines.TotalPrice - AlternativeDiscount or QuoteLines.TotalCost + Earning based on what, if anything, the user has entered last. Shall be calculated by the connector.

ExtraField1

string