Loading
Prepare for Email to Become the Default Login ExperienceRead More
The online Trailblazer Community becomes read-only Oct 30, 2026Read More
Important Advisory: iOS Update Impacting CG Mobile ApplicationRead More
Ongoing maintenance for Salesforce HelpRead More
Insurance
InsPolicyRevenueScheduleService:cancelRevenueSchedule

InsPolicyRevenueScheduleService:cancelRevenueSchedule

When a policy is canceled, this service adjusts the revenue schedule to calculate revenue until the cancellation date.

Class: InsPolicyRevenueScheduleService

Method: cancelRevenueSchedule

How it works

  1. This service looks for the policy (asset) ID, the transaction ID, and the effective date for the cancellation of the policy.

  2. Uses modificationType to query the transaction table Type field to get a list of modifications to the policy. If no modificationType is specified, the service usesChanged/Endorsed by default.

  3. Modifies the revenue schedule, removing future unearned revenue from the policy (asset) object.

  4. Returns the policy ID in the output JSON.

Remote Options

Option

Description

assetId

Required.

The policy ID of the canceled policy.

transactionId

Required.

The transaction ID that's created when the policy is canceled.

effectiveDate

Required.

The policy cancellation date.

getDataDRBundleName

The name of the Omnistudio Data Mapper this service uses to retrieve policy (asset) information.

If you're using Salesforce FSC, you must specify either this option or getDataCustomClassName.

getDataCustomClassName

The name of the custom class this service uses to retrieve policy (asset) information.

If you're using Salesforce FSC, you must specify either this option or getDataDRBundleName.

modificationType

Required.

The type of modifications made to a policy over its term.

If no value is specified, the services uses Changed/Endorsed as the default.

Input JSON

This service takes an input JSON.

"CancelPolicy": {
	"startDate": "2017-10-31T07:00:00.000Z",
	"endDate": "2018-10-30T07:00:00.000Z",
	"originalPremium": 0,
	"modifyDate": "2018-06-22T07:00:00.000Z",
	"CancelDateValidation": true
},
"PolicyId": "02if200000YfCDEAA3",
}

Output JSON

The service returns the policy ID in the output JSON.

{
    "PolicyId": "02if200000YfCDEAA3"
}
 
Loading
Salesforce Help | Article