Loading
Insurance
Table of Contents
Filter by (0)Add
Select Filters

          No results
          No results
          Here are some search tips

          Check the spelling of your keywords.
          Use more general search terms.
          Select fewer filters to broaden your search.

            Search all of Salesforce Help
            Search all of Salesforce Help
            InsPolicyRevenueScheduleService:createRevenueSchedule

            You are here:

            1. Salesforce Help
            2. Docs
            3. Digital Insurance

            InsPolicyRevenueScheduleService:createRevenueSchedule

            This service creates a monthly revenue schedule for a policy, starting on the effective date of the policy and ending on the expiration date of the policy term.

            This service supports Salesforce Financial Services Cloud.

            Class: InsPolicyRevenueScheduleService

            Method: createRevenueSchedule

            How It Works

            1. The service looks for the policy Id (assetId) and the transactionId that recorded the sale of the policy.

              Note
              Note

              If you're using this service on an org that uses Salesforce Financial Services Cloud, you must use getDataDRBundleNames or getDataCustomClassName as input in addition to these options.

            2. Creates a list of revenue schedule entries for the policy. Each entry contains the following information:

              • Date: The end of each month, starting with the effective date of the policy and ending the last month of the policy term.

              • Total Earned Revenue: Total revenue you have earned for this policy by this date.

              • Total Unearned Revenue: Revenue you have not yet earned for this policy by this date.

              • Period Earned Revenue: The revenue you earn for this policy during this month.

              Note
              Note

              If you're using this service on an org that uses Salesforce Financial Services Cloud, you must use postDataDRBundleName or postDataCustomClassName to post the revenue schedule to the FSC.

            3. Returns the total policy revenue to be earned, if the policy is not canceled or modified, in the output JSON.

            Remote Options

            Option

            Description

            assetId

            Required.

            The ID of this policy.

            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.

            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.
            postDataCustomClassName

            The name of the custom class this service uses to save the new policy version.

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

            The name of the Data Mapper this service uses to save the new policy version.

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

            transactionId

            The ID of the transaction associated with the creation of the policy.

            Input JSON

            This service doesn't use an input JSON.

            Output JSON

            The service returns the total revenue you will earn for this policy (if it isn't canceled or modified).

            {
    "totalEarned": 533.8
}
             
            Loading
            Salesforce Help | Article