You are here:
InsPolicyService:createRenewalQuote
Use this service to create a renewal quote for an existing policy.
How it Works
-
The service accepts the
policyIdof the policy to be renewed.
NoteThe service passes
userInputsto determine additional rating factors for recalculating the price. Also, the service uses theadditionalFieldsnode to populate additional fields on the quote object, which otherwise aren’t part of this service. -
The service checks for the effective date and expiration date of the renewed policy. If not provided, the service computes these dates using the following logic:
-
Effective date = Expiration date of original policy + 1 day
-
Expiration date = Effective date of new policy + Term of the new policy
-
-
Reprices the policy product using
aggByKeyandincludeInputKeyoptions. -
The service creates an Opportunity record using the
OpportunityDetails JSONnode from the input. See sample input JSON. This node accepts only these three mandatory fields:-
Name
-
StageName
-
CloseDate
Note Additional opportunity fields cannot be included in this node. However, you can update the opportunity record with additional details after the renewal quote is generated. -
-
The service creates a quote of type 'Renewal' and links it to the opportunity record created in the previous step.
Inputs
Input |
Description |
|---|---|
|
Required The ID of the policy that is to be renewed. |
|
Optional The details of the products associated with the policy. For any product, the target format for the |
|
Optional The key-value pairs of the additional fields that aren’t a part of this service. These fields populate on the quote object. |
|
The details of renewal opportunity, which is linked to the renewal quote. If this node isn’t present, then the service takes up the opportunity details from the opportunity linked to the source quote of the original policy. |
Remote Options
Remote Option |
Description |
|---|---|
|
Optional Effective date of the renewed policy. If not provided, the value is computed using the following logic: Expiration date of existing policy + 1 day |
|
Optional Expiration date of the renewed policy. If not provided, the value is set using the following logic: Effective date of new policy + Term of new policy |
|
Optional The term of the policy. It help calculates |
|
Optional The name of the |
|
Required
The service sends this option as an input to the calculation procedure, which uses it to complete the calculation with aggregation. For example, an auto insurance policy has multiple drivers attached to each insured vehicle. The insured vehicle has a separate instanceKey for each instance in the policy. The The service uses this option to reprice the policy. |
|
Required A string of comma-separated key-value pairs that the service passes into and out of the calculation procedure. These key-value pairs are included in the output product object within the Only keys used by the calculation procedure have a value in the results. |
Input JSON
Here's an example of the input JSON:
{
"policyId": "0YT5w000000Y8MNGA0",
"userInputs": [
{
"DRIVER.instanceKey": "Bob Jones",
"DRIVER.LN": "Jones",
"DRIVER.GENDER": "Male",
"DRIVER.FN": "Bobby",
"DRIVER.AGE": 30,
"AUTO.instanceKey": "2018 Audi A3",
"AUTO.autoYear": 2018,
"AUTO.autoModel": "A4",
"perAccident": 500
}
],
"additionalFields": {
"BillingName": "John Smith",
"Description": "This is a renewal quote",
"Phone": "123456789"
},
"OpportunityDetails": {
"Name": "Renewal Opportunity",
"StageName": "Qualification",
"CloseDate": "2023-04-04"
}
}