Skip to main content
Get Quote Version

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

QuoteVersionId

GetQuoteVersion: Get a QuoteVersion

QuoteVersionId
integer<int32>

Response

OK

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

QuoteVersionId
integer<int32>

Primary key

ERPQuoteVersionKey
string

Key in the ERP system that uniquely identifies this Version within the ERP system (if available, the field may be empty).

QuoteId
integer<int32>

Foreign key to CRM quote (the conceptual parent). Owning Quote of this Quote Version.

Description
string

Description of Version. Potentially longer text description, typically used in a tooltip. Max 2K.

Number
string

A quote number that the user (or ERP connector) can fill out.

State
enum<string>

Current state of this quote version.

Available options:
Unknown,
Draft,
DraftNotCalculated,
DraftNeedsApproval,
DraftApproved,
DraftNotApproved,
Sent,
Archived,
Lost,
Sold
ArchivedState
enum<string>

State that this quote version had, right before it was changed to Archived; in this way we can show what happened before the archiving.

Available options:
Unknown,
Draft,
DraftNotCalculated,
DraftNeedsApproval,
DraftApproved,
DraftNotApproved,
Sent,
Archived,
Lost,
Sold
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.

LikelyQuoteAlternativeId
integer<int32>

The alternative that is considered most likely to be accepted. Used to calculate probable income.

SentDate
string<date-time>

The date the version was sent to the customer.

FollowupId
integer<int32>

Link to a follow-up activity, created when this quote version was sent to the customer.

ExpirationDate
string<date-time>

Last date the quote Version is valid, expiration is at midnight end of this day.

DeliveryCountryId
integer<int32>

Country of delivery address, typically copied from the contact record

HasOwnDeliveryAddress
boolean

The delivery address is not the same as the contact's Street address

InvoiceCountryId
integer<int32>

Country of invoice address, typically copied from contact record

HasOwnInvoiceAddress
boolean

The quote has an address for Invoicing. This will typically be copied from the company's addresses.

ERPPaymentTermsKey
string

Either a List id to an id from a connector provided list, or, if the connection doesn’t support lists, a text. For instance: ‘Standard 30 days’.

ERPPaymentTypeKey
string

Either a List id to an id from a connector provided list, or, if the connection doesn’t support lists, a text. For instance: 'Invoice'.

ERPDeliveryTermsKey
string

Either a List id to an id from a connector provided list, or, if the connection doesn’t support lists, a text. For instance: ‘FOB’ (‘Free on board’).

ERPDeliveryTypeKey
string

Either a List id to an id from a connector provided list, or, if the connection doesn’t support lists, a text. For instance: ‘Air’.

Rank
integer<int32>

Rank/Version number, starts at 1

ApprovedBy
integer<int32>

Id of associate who approved (or rejected approval) for this version

ApprovedText
string

Text with comments on why approval was granted (or rejected)

ApprovedRegisteredBy
integer<int32>

Id of associate who actually entered the approval; might be different from ApprovedBy (f.x. due to telephone consultation/approval)

ApprovedRegisteredDate
string<date-time>

When was approval granted or rejected

ExtraField1
string

Optional information added by Quote Connector; usable in the quote document merge process

ExtraField2
string

Optional information added by Quote Connector; usable in the quote document merge process

ExtraField3
string

Optional information added by Quote Connector; usable in the quote document merge process

ExtraField4
string

Optional information added by Quote Connector; usable in the quote document merge process

ExtraField5
string

Optional information added by Quote Connector; usable in the quote document merge process

LastRecalculated
string<date-time>

When this version was last subjected to a total recalculation. This field must be set by the connector, since the connector may choose to ignore a RecalculateVersion call based on policies and possibly the current value of this field. SuperOffice will set this field to 1.1.1760 whenever any change occurs to the quote, to indicate that a recalculation is needed.

Updated
string<date-time>

Last updated when in UTC.

UpdatedAssociateId
integer<int32>

Last updated by whom

Registered
string<date-time>

Registered when in UTC.

RegisteredAssociateId
integer<int32>

Registered by whom

RequestAssociateId
integer<int32>

User to whom the request proposal should be delivered

RequestComment
string

Comment for why quote should be approved

QuoteAlternatives
object[]

The QuoteAlternatives for the QuoteVersion

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.