You are here:
InsQuoteService:getQuoteDetail
Use this service to get all of the quote details as JSON.
This service works well for flows that take a saved quote and create either an insurance policy or a health plan from it.
How It Works
-
The service takes a
quoteIdand finds the quote. -
The service returns JSON that includes these key: values:
-
quoteDetails: Quote field valuesIncludes quote field values with attributes.
-
insuredItems: Insured items and insured partiesIncludes InsuredItemSpec and InsuredPartySpec quote line details. (Not applicable for Vlocity Health.)
-
productConfigurationDetail: Product configurationsProduct JSON Structure Model
-
Taxes and Fees
Here's how this service works:
-
The
taxAmount,TaxAmount__c,feeAmount,FeeAmount__c, andTotalAmount__cfields are returned for eachQuoteLineItem, if the fields aren’t null. -
The
TotalTaxAmount__c,TotalFeeAmount__c, andTotalAmount__cfields are returned for the quote, if the fields aren’t null. -
The
totalTaxFeeAmount=TaxAmount__c+FeeAmount__c
Inputs
The service requires these inputs if the isForExternal remote option is
set to true. Omit these inputs if isForExternal is blank or set to
false.
Option |
Description |
|---|---|
action
|
Required when isForExternal=true. The service uses this value to create the Action node required for the external pricing API. Possible values:
|
quoteId
|
Required when isForExternal=true. The ID of the quote to retrieve details for. |
Remote Options
Input JSON
Here's the format of the input JSON:
{
"quoteId": "...",
"action": "..."
}
Here's an example of the input JSON:
{
"quoteId":"0Q06g0000009YA3CAM"
"action": "submit"
}
Output JSON (Insurance)
The service returns a JSON that contains these nodes:
-
Insured parties and insured items
-
Quote details field set
-
Product configuration details
The quoteDetail field set exists on several objects, but
the InsQuoteService:getQuoteDetail service reads only the field set on the Quote Line Item
object when it builds the productConfigurationDetail node in the JSON
response. Field sets on Product2 object are ignored by this service.
To reduce the
payload size and improve the Omniscript performance, add or remove fields in the
quoteDetail field set. A few Quote Line Item fields such as Product
Name, Product Code, Product Id are included by default. We recommend you keep these sets
unchanged because they’re essential to a quote.
{
"productConfigurationDetail": {
"records": [...]
"totalSize": 1
},
"insuredItems": {
"Driver": [{
"instanceKey": "Joan Smith",
"isPrimary": false,
"isParent": false,
"LN": "Smith",
"AGE": 20,
"FN": "Joan",
"GENDER": "Female",
"FirstName": "Joan",
"LastName": "Smith"
},
{
...
}
],
"Auto": [{
"instanceKey": "2015 Lexus LX250",
"autoAntiTheft": true,
"est_annual_mileage": "1-10000",
"autoLicNum": "Lexus",
"autoModel": "LX250",
"autoYear": 2015,
"BodyClass": "Sedan/Saloon",
"VehicleType": "PASSENGER CAR",
"isPrimary": true
"isParent": false,
},
{
...
}
]
},
"quoteDetail": {
"attributes": {
"type": "Quote",
"url": "/services/data/v43.0/sobjects/Quote/0Q01I000000qeWLSAY"
},
"ins_daily4__EffectiveDate__c": "2018-07-27",
"ins_daily4__TotalSumInsured__c": 0,
"AccountId": "0011I00000QknfjQAB",
"ins_daily4__RootItemTotal__c": 0,
"Id": "0Q01I000000qeWLSAY"
},
"error": "OK"
}Output JSON (Health)
The service returns a JSON that contains these nodes:
-
Quote details field set
-
Product configuration details
{
"productConfigurationDetail": {
"records": [...]
"totalSize": 1
},
"quoteDetail": {
"attributes": {
"type": "Quote",
"url": "/services/data/v43.0/sobjects/Quote/0Q01I000000qeWLSAY"
},
"ins_daily4__EffectiveDate__c": "2018-07-27",
"ins_daily4__TotalSumInsured__c": 0,
"AccountId": "0011I00000QknfjQAB",
"ins_daily4__RootItemTotal__c": 0,
"Id": "0Q01I000000qeWLSAY"
},
"error": "OK"
}