POST Agents/Quote/SaveQuoteVersion

• 8 minutes to read
 • 8 minutes to read 
POST /api/v1/Agents/Quote/SaveQuoteVersion

Saves a quote version

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/SaveQuoteVersion?$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

QuoteVersion

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

Response:

OK

Response Description
200 OK

Response body: QuoteVersion

Property Name Type Description
QuoteVersionId 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 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 string Current state of this quote version.
ArchivedState 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.
Status string If there was a problem with for instance calculation, this field is set to warning or 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 int32 The alternative that is considered most likely to be accepted. Used to calculate probable income.
SentDate date-time The date the version was sent to the customer.
FollowupId int32 Link to a follow-up activity, created when this quote version was sent to the customer.
ExpirationDate date-time Last date the quote Version is valid, expiration is at midnight end of this day.
DeliveryCountryId int32 Country of delivery address, typically copied from the contact record
HasOwnDeliveryAddress bool The delivery address is not the same as the contact's Street address
InvoiceCountryId int32 Country of invoice address, typically copied from contact record
HasOwnInvoiceAddress bool 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 int32 Rank/Version number, starts at 1
ApprovedBy 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 int32 Id of associate who actually entered the approval; might be different from ApprovedBy (f.x. due to telephone consultation/approval)
ApprovedRegisteredDate 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 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 date-time Last updated when in UTC.
UpdatedAssociateId int32 Last updated by whom
Registered date-time Registered when in UTC.
RegisteredAssociateId int32 Registered by whom
RequestAssociateId int32 User to whom the request proposal should be delivered
RequestComment string Comment for why quote should be approved
QuoteAlternatives array The QuoteAlternatives for the QuoteVersion
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/SaveQuoteVersion
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv
Content-Type: application/json; charset=utf-8

{
  "QuoteVersion": null
}

Sample response

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

{
  "QuoteVersionId": 757,
  "ERPQuoteVersionKey": "labore",
  "QuoteId": 300,
  "Description": "Function-based leading edge access",
  "Number": "1702578",
  "State": "Archived",
  "ArchivedState": "Archived",
  "Status": "Error",
  "Reason": "",
  "LikelyQuoteAlternativeId": 993,
  "SentDate": "2022-06-09T02:30:47.7100701+02:00",
  "FollowupId": 189,
  "ExpirationDate": "2024-05-26T02:30:47.7100701+02:00",
  "DeliveryCountryId": 962,
  "HasOwnDeliveryAddress": false,
  "InvoiceCountryId": 82,
  "HasOwnInvoiceAddress": false,
  "ERPPaymentTermsKey": "commodi",
  "ERPPaymentTypeKey": "occaecati",
  "ERPDeliveryTermsKey": "sed",
  "ERPDeliveryTypeKey": "nulla",
  "Rank": 170,
  "ApprovedBy": 385,
  "ApprovedText": "aliquam",
  "ApprovedRegisteredBy": 682,
  "ApprovedRegisteredDate": "2022-04-06T02:30:47.7100701+02:00",
  "ExtraField1": "autem",
  "ExtraField2": "et",
  "ExtraField3": "quis",
  "ExtraField4": "impedit",
  "ExtraField5": "assumenda",
  "LastRecalculated": "2015-08-14T02:30:47.7100701+02:00",
  "Updated": "2023-07-09T02:30:47.7100701+02:00",
  "UpdatedAssociateId": 678,
  "Registered": "2024-10-04T02:30:47.7100701+02:00",
  "RegisteredAssociateId": 297,
  "RequestAssociateId": 275,
  "RequestComment": "eius",
  "QuoteAlternatives": [
    {
      "QuoteAlternativeId": 700,
      "ERPQuoteAlternativeKey": "sit",
      "QuoteVersionId": 835,
      "Name": "Lowe, Block and Bailey",
      "Description": "Open-architected web-enabled benchmark",
      "Status": "Error",
      "Reason": "",
      "ERPDiscountPercent": 17453.246,
      "ERPDiscountAmount": 16497.376,
      "DiscountPercent": 29700.917999999998,
      "DiscountAmount": 15948.926,
      "UserValueOverride": "DiscountAmount",
      "VATInfo": "est",
      "VAT": 31296.124,
      "EarningPercent": 4453.414,
      "EarningAmount": 2544.808,
      "SubTotal": 5415.552,
      "TotalPrice": 10768.423999999999,
      "ExtraField1": "vel",
      "ExtraField2": "quo",
      "ExtraField3": "enim",
      "ExtraField4": "temporibus",
      "ExtraField5": "dolorum",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 694
        }
      }
    }
  ],
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 296
    }
  }
}