POST Agents/Quote/GetQuoteEntity

• 5 minutes to read
 • 5 minutes to read 
POST /api/v1/Agents/Quote/GetQuoteEntity

Get a Quote

NsApiSlow threshold: 5000 ms.

Query String Parameters

Parameter Name Type Description
$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. 
POST /api/v1/Agents/Quote/GetQuoteEntity?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: request

QuoteId

Property Name Type Description
QuoteId Integer

Response:

OK

Response Description
200 OK

Response body: QuoteEntity

Property Name Type Description
QuoteId int32 Primary key
SaleId int32 The foreign key to the corresponding sale
QuoteConnectionId 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 int32 The primary key of the Quote Version that is currently active. (The active version will always be the latest version.)
AcceptedQuoteAlternativeId 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 int32 If true, then the Earning, Earning_Percent and Amount fields are populated from the QuoteVersion.QuoteAlternative (current revision, most-likely alternative).
DocumentId 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
QuoteVersions array Array og QuoteVersions connected to the quote.
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/Quote/GetQuoteEntity
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: fr,de,ru,zh
Content-Type: application/json; charset=utf-8

{
  "QuoteId": 239
}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "QuoteId": 527,
  "SaleId": 506,
  "QuoteConnectionId": 859,
  "ERPQuoteKey": "ERP-QUOTE-2024-004",
  "ERPOrderKey": "ERP-ORDER-2024-004",
  "ActiveQuoteVersionId": 479,
  "AcceptedQuoteAlternativeId": 875,
  "UseValuesFromQuote": 842,
  "DocumentId": 516,
  "PoNumber": "PO-2024-99887",
  "OrderComment": "Annual license renewal with upgraded support package",
  "PreferredEmailCulture": "en-US",
  "QuoteVersions": [
    {
      "QuoteVersionId": 682,
      "ERPQuoteVersionKey": "ERP-QUOTE-V1-2024-004",
      "QuoteId": 637,
      "Description": "Annual License Renewal - 50 Users with Premium Support",
      "Number": "Q-2024-004",
      "State": "Archived",
      "ArchivedState": "Archived",
      "Status": "Error",
      "Reason": "",
      "LikelyQuoteAlternativeId": 178,
      "SentDate": "2024-11-18T11:30:00+01:00",
      "FollowupId": 836,
      "ExpirationDate": "2024-12-18T23:59:00+01:00",
      "DeliveryCountryId": 233,
      "HasOwnDeliveryAddress": false,
      "InvoiceCountryId": 223,
      "HasOwnInvoiceAddress": false,
      "ERPPaymentTermsKey": "NET30",
      "ERPPaymentTypeKey": "INVOICE",
      "ERPDeliveryTermsKey": "FOB",
      "ERPDeliveryTypeKey": "STANDARD",
      "Rank": 260,
      "ApprovedBy": 150,
      "ApprovedText": "sit",
      "ApprovedRegisteredBy": 4,
      "ApprovedRegisteredDate": "2024-11-20T13:15:00+01:00",
      "ExtraField1": "Renewal with premium support",
      "ExtraField2": "",
      "ExtraField3": "",
      "ExtraField4": "",
      "ExtraField5": "",
      "LastRecalculated": "2024-11-27T09:20:00+01:00",
      "Updated": "2024-11-27T09:20:00+01:00",
      "UpdatedAssociateId": 324,
      "Registered": "2024-11-18T10:00:00+01:00",
      "RegisteredAssociateId": 232,
      "RequestAssociateId": 752,
      "RequestComment": "Customer wants to renew existing licenses and upgrade support",
      "QuoteAlternatives": [
        {},
        {}
      ],
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.String",
          "FieldLength": 603
        }
      }
    }
  ],
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 865
    }
  }
}