InsPolicyService:createOutOfSequencePolicyVersion

How It Works

1. The service takes the policyId of the current policy, the effective date for the out-of-sequence endorsement, and the JSON specified by the inputKey.

2. If createTransaction is true, the service creates an out-of-sequence transaction of the type Out-of-Sequence Changed/Endorsed and the transaction details.

3. If includePaymentSchedule is true, the service generates or updates payment schedules and payment schedule entry details. The calculation is performed based on values selected for corresponding paymentCalculationMethod and paymentFrequency options. The payment schedule follows the existing payment schedule rules:

   • Only future-dated unpaid payment schedules are updated.

   • Past payment schedules, paid or unpaid, are never updated.

   • Any adjustments for the past-dated payment and paid payment schedule are included in the Out-of-Sequence Endorsement transaction.

4. The service updates the value of the IsPolicyEditLocked field to true on the related insurance policy versions. All the policy versions are locked until the out-of-sequence endorsement transaction is complete.

Note

The service additionally supports out-of-sequence endorsements where the original policy version has a duration of less than 365 days, or less than 366 days in a leap year. See Considerations and Limitations for Insurance Policies.

Support for Custom Fields

• Store the custom fields of the Insurance Policy object in the OutOfSequenceEndorsementCustomFields field set.

• Populate the custom fields as key/value pairs in the additionalFields section. See Input JSON.

• Use this OutOfSequenceEndorsementCustomFields field set to copy custom data from the canceled to new policy versions during an out-of-sequence endorsement.

Remote Options

Input JSON

The service looks for the inputKey specified within the product JSON. Here's the sample input JSON:

"newPolicyJSON": {
  "accountId": "001f400000RrQSrAAN",
  "term": "Annual",
  "productConfigurationDetail": {
    ...
  },
  "insuredItems": {
    ...
  },
  "additionalFields": {
    "vlocity_ins__Type__c": "AUTO",
  },
}

{
   
    "effectiveDate": "2023-03-01",
    "inputKey": "quotepolicyJson",
    "policyId": "0YT3t000000uUz6GAE",
    "includePaymentSchedule": true,
    "createTransaction": true,
    "paymentFrequency": "Monthly",
    "paymentCalculationMethod": "Modal"
  }

Output JSON

Here's the sample output JSON when the service initiates an out-of-sequence endorsement and successfully generates the job ID:

 {
"jobId": "7073t0000BNGivxAQD",
"errorCode": "INVOKE-200",
 "error": "OK"
}

{
"errorCode": "ERROR-CODE",
"error": "error message"
}