Skip to main content
Get Quote

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

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

Body

QuoteId

GetQuote: Get a Quote

QuoteId
integer<int32>

Response

OK

Quote carrier with the active quote version and favorite alternative. Carrier object for Quote. Services for the Quote Carrier is available from the Quote Agent.

QuoteId
integer<int32>

Primary key

SaleId
integer<int32>

The foreign key to the corresponding sale

QuoteConnectionId
integer<int32>

The connection in the CRM system to where this quote came from. Identifies the ERP connection used for this quote. Each quote is bound to one and only one connection.

ERPQuoteKey
string

Foreign key of quote (if available). The key in the ERP system that identifies this sale's Quote (as opposed to the later Order information)

ERPOrderKey
string

The key in the ERP system that identifies this sale's Order, as transferred and possibly later edited in the ERP system. Only filled out if there exists a corresponding order representation of the quote in the ERP system.

ActiveQuoteVersionId
integer<int32>

The primary key of the Quote Version that is currently active. (The active version will always be the latest version.)

AcceptedQuoteAlternativeId
integer<int32>

The primary key of the Quote Alternative which was finally accepted by the customer. Set when the user is marking a quote as accepted.

UseValuesFromQuote
integer<int32>

If true, then the Earning, Earning_Percent and Amount fields are populated from the QuoteVersion.QuoteAlternative (current revision, most-likely alternative).

DocumentId
integer<int32>

The ID of the main Quote Document

PoNumber
string

Customer's Purchase order number

OrderComment
string

A comment that is intended for the Invoice, Order, Packing list and similar stages - AFTER the quote has become an order and goes to ERP for processing

PreferredEmailCulture
string

When emails are sent (offer or confirmation), a language can be chosen in the GUI; this field saves the most recent choice and can be used to default the next such choice. Default-default is user's current language

ActiveQuoteVersion
object

Information about a version of the . Carrier object for QuoteVersion. Services for the QuoteVersion Carrier is available from the Quote Agent.

FavoriteQuoteAlternative
object

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

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.