Insurance Developer Guide

Get Started with Insurance Developer Resources
Insurance Brokerage
Insurance Claims Management
Insurance Group Benefits
Insurance Policy Administration
Insurance Policy Business APIs
Insurance Policy Standard Invocable Actions
Insurance Policy Administration Metadata API Types
Insurance Policy Standard Objects
Insurance Policy Administration Apex Reference
Insurance Policy Developer Journey
Create and Manage Insurance Policies by Using Salesforce Quoting
Endorse Policy
Issue Policy
Renew Policy
Create Out of Sequence Policy Endorsement
Issue Multi-Root Policy
Endorse Multi-Root Policy
Renew Multi-Root Policy
Create and Manage Insurance Policies Without Using Salesforce Quoting
Cancel Policy
Insurance Product Administration
Insurance Quoting
Insurance Apex Reference
Error Codes and Responses
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Renew Multi-Root Policy

Renew a multi-root policy to create a new policy term for the parent policy and all associated child policies. The parent–child policy structure is preserved in the renewed term.
Make sure you have these details before renewing a multi-root policy:
  • The Policy ID of the active parent insurance policy to be renewed.
  • The Pricebook ID required to generate the renewal quote.
  1. Get Policy Context—Retrieve the policy context by using the policy ID through one of the following methods:
    Returns the context required to generate the renewal quote.
  2. Create Renewal Quote—Use the policy context to create the renewal quote by using one of the following methods:
    Creates a renewal quote associated with the active policy.
  3. Modify Renewal Quote (Optional)—Configure changes to the renewal terms by making a PATCH request to the CreateUpdateQuote Connect API with the desired updates.

    For multi-root policies, ensure pricing is recalculated across all root products to accurately compute aggregate totals and prorated term premiums.

    Note

  4. Renew Multi-Root Policy—Use the updated context to renew the policy by using one of the following methods:
  • Returns an Async Request ID in the response to track the job status.
  • Creates a new parent policy record and corresponding child policy records for the new term.
  • Creates a corresponding transaction record for each child policy. In addition, creates a parent policy transaction that represents the rolled-up premium from all associated child policy transactions.
  • Consolidates financial details at the parent policy level.