Quotes

Queryable, Introduced in version 2.18

GET https://localhost:8001/sv/001.1/api/v1/Sales/Quotes

Represents a quote.

GUID

FC8419EB-AF90-4416-A025-8C41B29AE06B

Required permission

Show quote

Properties

Name Type Summary Introduced in
Id Int64 The business key identifier of the quote.
PaymentTermId Int64? The business key identifier of the quote's payment term.

References PaymentTerms
PaymentTerm PaymentTerms The payment term of the quote.

  • Expandable
PaymentTermDescription String The payment term description of the quote.

  • Max length is 35
GracePeriodInDays Int32? The quote's grace period in days.
DeliveryMethodId Int64? The business key identifier of the quote's delivery method.

References DeliveryMethods
DeliveryTermId Int64? The business key identifier of the quote's delivery term.

References DeliveryTerms
DeliveryTermDescription String The delivery term description of the quote.

  • Max length is 35
DeliveryMethodDescription String The delivery method description of the quote.

  • Max length is 35
ShipmentPayer Int32 Specifies the shipment payer of the quote.

  • BuyerPays: 1
  • SellerPays: 2
  • OtherPayer: 3
  • Incoterms: 4
BusinessContactOrderNumber String The customer's quote number.

  • Max length is 30
OurReferenceId Int64? The business key identifier of our reference on the quote.

Reference Persons
OurReferenceName String The name of our reference on the quote.

  • Max length is 80
BusinessContactReferenceId Int64? The business key identifier of the customer's reference on the quote.

Reference Persons
BusinessContactReferenceName String The name of the customer's reference on the quote.

  • Max length is 80
GoodsLabel String The goods label of the quote.

  • Max length is 80
CurrencyId Int64 The business key identifier of the quote's currency.

References Currencies
VatGroupId Int64 The business key identifier of the quote's VAT group.

References VatGroups
WarehouseId Int64 The business key identifier of the quote's warehouse.

References Warehouses
Priority Int32 The priority of the quote.
ProjectId Int64? The business key identifier of the quote's project.

References Project
SendMethod Int32 Specifies the method of the quote printout.

  • Printer: 0
  • Email: 1
  • Edi: 2
  • None: 9
InvoicePrintoutMethod Int32 Specifies the method of future invoice printouts resulted from
the quote.

  • Printer: 0
  • Email: 1
  • Edi: 2
  • None: 9
InternalCommentId Int64? The business key identifier of the quote's internal comment.

References Comments
InternalComment Comments The internal comment of the quote.

  • Expandable
ExternalCommentId Int64? The business key identifier of the quote's external comment.

References Comments
ExternalComment Comments The external comment of the quote.

  • Expandable
TransportTime Int32? The transport time of the quote.
LifeCycleState Int32 The life cycle state of the quote.

  • Transient: 1
  • Persistent: 10
  • History: 20
  • RemovableCandidate: 99
Version Int32 The version of the quote.
UseForwardRate Boolean Specifies if forward rate should be used.
ExchangeRate Decimal The exchange rate to use for the quote.
OrderAmount Decimal This property is obsolete and no longer carries a value.

  • Obsolete since version 2.36 (Unavailable)
OrderAmountInCompanyCurrency Decimal This property is obsolete and no longer carries a value.

  • Obsolete since version 2.36 (Unavailable)
CustomerId Int64 The business key identifier of the customer that the quote
belongs to.

References Customers
OrderNumber String The order number of the customer order created as a result of the
quote.

  • Not nullable
  • Max length is 15
OrderDate DateTimeOffset? The date/time when the quote was made into an order.
Rows QuoteRows[] The rows of the quote.

  • Expandable
SellerId Int64? The business key identifier of the quote's seller.

References Persons
DeliveryAddressId Int64? The business key identifier of the quote's delivery address.

References Addresses
DeliveryAddress Addresses The delivery address of the quote.

  • Expandable
MailingAddressId Int64? The business key identifier of the quote's mailing address.

References Addresses
MailingAddress Addresses The mailing address of the quote.

  • Expandable
VatNumber String The VAT number on the quote.

  • Max length is 80
Status Int32 The status of the quote.

  • Registered: 1
  • Printed: 2
  • Closed: 6
  • PartialOrder: 7
  • OrderViaRelatedQuote: 8
  • Order: 9
CommunicationAddresses CommunicationAddresses[] The communication addresses registered on the quote.

  • Expandable
QuoteDate DateTimeOffset The date when the quote was made to the customer.
QuoteDescription String The description of the quote.

  • Max length is 200
LatestContactDate DateTimeOffset? The last contact date on the quote.
RequestForQuoteDate DateTimeOffset The date when the RFQ was made.
ValidityTimeId Int64? The business key identifier of the validity time of the quote.

References ValidityTimes
ValidityTime ValidityTimes The validity time of the quote.

  • Expandable
ValidityTimeDescription String The validity time description of the quote.

  • Max length is 30
ValidityTimeInDays Int32 The validity time of the quote in days.
ValidThroughDate DateTimeOffset The valid through date of the quote.
ProbabilityId Int64 The business key of the quote's probability.

References a Probabilities
Probability Probabilities The probability of the quote.
ReasonCodeLostQuoteId Int64? The business key identifier of the reason why the quote was lost.

References ReasonCodeLostQuotes
ReasonCodeLostQuote ReasonCodeLostQuotes The reason why the quote was lost.

  • Expandable
ReasonLostCommentId Int64? The business key identifier of the quote's reason of loss comment.

Reference Comments
ReasonLostComment Comments The reason of loss comment for the quote.

  • Expandable
OrderTypeId Int64? The business key identifier of the quote's quote type.

References QuoteTypes
 Introduced in version 2.27
OrderType QuoteTypes The quote type used on the quote.

  • Expandable
 Introduced in version 2.27
Preliminary Boolean Specifies if the quote is to be considered preliminary.
 Introduced in version 2.53
CurrencyExchangeTypeId Int64 The business key identifier of the quote's currency exchange type.

 Introduced in version 22.9
DeliveryTimeId Int64? The business key identifier of the quote's delivery time.

 Introduced in version 23.6
DeliveryTime DeliveryTimes The delivery time of the quote.

  • Expandable
 Introduced in version 23.6
DeliveryTimeInDays Int32? The delivery time in days of the quote.
 Introduced in version 23.6
AccountGroupId Int64 The business key identifier of the account group of the quote.

 Introduced in version 24.2
AccountGroup CustomerAccountGroups The account group on the quote.

  • Expandable
 Introduced in version 24.2
CategoryString String The category string on the quote.

  • Max length is 20
 Introduced in version 24.3
DestinationForDeliveryTerm String The destination for the delivery term.

  • Max length is 80
 Introduced in version 24.7
EditedOrderAmountExcludingVat Decimal? The edited order amount excluding VAT for the quote.
 Introduced in version 24.8
EditedOrderAmountExcludingVatCurrencyId Int64? The currency of the edited order amount excluding VAT for the quote.

 Introduced in version 24.8
EditedOrderAmountDiscount Decimal? The edited order amount discount in percent for the quote.
 Introduced in version 24.8
TypeOfOrderAmountEntered Int32? The type of edited order value entered on the quote.

  • Percent: 1
  • Amount: 2
 Introduced in version 24.8

Example

{
  "Id": 0,
  "PaymentTermId": null,
  "PaymentTerm": null,
  "PaymentTermDescription": null,
  "GracePeriodInDays": null,
  "DeliveryMethodId": null,
  "DeliveryTermId": null,
  "DeliveryTermDescription": null,
  "DeliveryMethodDescription": null,
  "ShipmentPayer": 0,
  "BusinessContactOrderNumber": null,
  "OurReferenceId": null,
  "OurReferenceName": null,
  "BusinessContactReferenceId": null,
  "BusinessContactReferenceName": null,
  "GoodsLabel": null,
  "CurrencyId": 0,
  "VatGroupId": 0,
  "WarehouseId": 0,
  "Priority": 0,
  "ProjectId": null,
  "SendMethod": 0,
  "InvoicePrintoutMethod": 0,
  "InternalCommentId": null,
  "InternalComment": null,
  "ExternalCommentId": null,
  "ExternalComment": null,
  "TransportTime": null,
  "LifeCycleState": 0,
  "Version": 0,
  "UseForwardRate": false,
  "ExchangeRate": 0.0,
  "OrderAmount": 0.0,
  "OrderAmountInCompanyCurrency": 0.0,
  "CustomerId": 0,
  "OrderNumber": null,
  "OrderDate": null,
  "Rows": null,
  "SellerId": null,
  "DeliveryAddressId": null,
  "DeliveryAddress": null,
  "MailingAddressId": null,
  "MailingAddress": null,
  "VatNumber": null,
  "Status": 0,
  "CommunicationAddresses": null,
  "QuoteDate": "0001-01-01T00:00:00+00:00",
  "QuoteDescription": null,
  "LatestContactDate": null,
  "RequestForQuoteDate": "0001-01-01T00:00:00+00:00",
  "ValidityTimeId": null,
  "ValidityTime": null,
  "ValidityTimeDescription": null,
  "ValidityTimeInDays": 0,
  "ValidThroughDate": "0001-01-01T00:00:00+00:00",
  "ProbabilityId": 0,
  "Probability": null,
  "ReasonCodeLostQuoteId": null,
  "ReasonCodeLostQuote": null,
  "ReasonLostCommentId": null,
  "ReasonLostComment": null,
  "OrderTypeId": null,
  "OrderType": null,
  "Preliminary": false,
  "CurrencyExchangeTypeId": 0,
  "DeliveryTimeId": null,
  "DeliveryTime": null,
  "DeliveryTimeInDays": null,
  "AccountGroupId": 0,
  "AccountGroup": null,
  "CategoryString": null,
  "DestinationForDeliveryTerm": null,
  "EditedOrderAmountExcludingVat": null,
  "EditedOrderAmountExcludingVatCurrencyId": null,
  "EditedOrderAmountDiscount": null,
  "TypeOfOrderAmountEntered": null
}