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
            Configure the Request Ex Gratia Payment Action

            You are here:

            1. Salesforce Help
            2. Docs
            3. Digital Insurance

            Configure the Request Ex Gratia Payment Action

            Configure a Request Ex Gratia payment action to streamline requests for ex gratia payments. When users click Request Ex Gratia, the action invokes an integration procedure that changes a payment detail status to Ex Gratia Requested. The action also invokes an approval process. For approved requests, a custom setting lets the limit class allow payments to post if they're over the limit.

            Before You Begin

            Get a head start with the Vlocity Actions DataPack for Payment Actions. It includes a PaymentDetailRequestExGratiaAction Vlocity Action that you can customize or use as a template. See Download and Import Vlocity Actions DataPack for Payment Actions.

            Your configuration includes:

            • A business process, typically an approval process, to run when users click Request Ex Gratia.

            • An integration procedure that updates the status of a payment detail record, and that launches your approval process.

            • A custom setting called PayOverLimitStatuses that specifies which payment detail statuses let the limit class allow payments to post if they're over the limit.

            • The PaymentDetailRequestExGratiaAction Vlocity Action, which calls your integration procedure. This action also specifies which payment detail statuses show the Request Ex Gratia payment action.

            1. Configure a business process, typically an approval process, to run when users click Request Ex Gratia.
            2. Create an integration procedure that:

              • Accept as inputs either PaymentId from the Claim Payment Summary object or  ItemId  from the Claim Coverage Payment Detail object.

                Format the JSON structure like this:

                {
  "itemIds": [
    {
      "Id": "0l25c000000CalvAAC"
    },
    {
      "Id": "0l25c000000CalvAAC"
    }
  ]
}

              • Updates the status of a payment detail record to a value such as Ex Gratia Requested.

              • Launches your approval process.

            3. From Setup, in the Quick Find box, enter Custom Settings, and then select Custom Settings.
            4. Next to Insurance Configuration Setup, click Manage.
            5. Click New.
            6. Configure a custom setting called PayOverLimitStatuses.

              For Setup Value, enter Ex Gratia Approved.

              The Insurance Configuration Setup Edit UI.
            7. From the App Launcher, find and select Vlocity Actions.
            8. Click PaymentDetailRequestExGratiaAction.
            9. Enter details about the payment action.

              Vlocity Actions Name

              PaymentDetailRequestExGratiaAction.

              Applicable Type

              ClaimCoveragePaymentDetail.

              If ClaimCoveragePaymentDetail is missing from the list, go to Object Manager and open Vlocity Action. Then add ClaimCoveragePaymentDetail as a picklist value to the Applicable Type field.

              Display Label

              The label to show users for this action.

              Filter

              The payment status values that go along with this payment action. Users can click the payment action only if the claim payment status meets the filter criteria.

              Let users click Request Ex Gratia only for unpaid payment detail records, not paid ones.

              Format: Status IN (<value>, <value>, ..., <value>)

              Example: Status IN (New, Open, Authority Denied)

              Invocation Class Name, Invocation Method Name

              Enter values that call the integration procedure you configured for the Request Ex Gratia payment action.

              Example of a configured PaymentDetailRequestExGratiaAction​ payment action
            10. Confirm that the user interface lets users click the Request Ex Gratia payment action for the correct payment detail statuses.

              If a claim's Financials tab doesn't show the action as expected, clear the session cache and reload the page.

              Make sure that individual payment details show the action, and that the action dropdown at the top of the page shows the action only if it applies to all the selected payment details. Also confirm that the approval process launches as expected for the new action.

             
            Loading
            Salesforce Help | Article