Update Next Recurring Donation Installment Amount

force-app/main/default/classes/PS_CommitmentRequest.cls

@@ -304,8 +304,10 @@ public inherited sharing class PS_CommitmentRequest {
             : UserInfo.getDefaultCurrency();
 
         if (isElevateScheduleFieldsChanged(rd, oldRd)) {
+            // If the schedule has a Next Payment Amount, we need to send it
+            Decimal nextPaymentAmount = scheduleService.getNextPaymentAmount(rd);
             reqBody.deactivateOldSchedules();
-            setSchedules(reqBody, scheduleService.buildNewSchedules(rd), currencyCode);
+            setSchedules(reqBody, scheduleService.buildNewSchedules(rd, nextPaymentAmount), currencyCode);
         }
 
         if (isElevateCampaignChanged(rd, oldRd)) {
@@ -316,6 +318,26 @@ public inherited sharing class PS_CommitmentRequest {
         return reqBody;
     }
 
+    /***
+    * @description Constructs the edit commitment schedule request body for the specified Recurring Donation.
+    * @param rd Recurring Donation record
+    * @param nextPaymentAmount Next Payment Amount for Active Schedules
+    * @return RequestBody
+    */
+    public RequestBody getUpdateScheduleRequestBody(npe03__Recurring_Donation__c rd, Decimal nextPaymentAmount) {
+        RequestBody reqBody = new RequestBody()
+            .withCommitmentId(rd.CommitmentId__c);
+
+        String currencyCode = UserInfo.isMultiCurrencyOrganization()
+            ? (String) rd.get('CurrencyIsoCode')
+            : UserInfo.getDefaultCurrency();
+
+        reqBody.deactivateOldSchedules();
+        setSchedules(reqBody, scheduleService.buildNewSchedules(rd, nextPaymentAmount), currencyCode);
+
+        return reqBody;
+    }
+
     private Map<String, Object> buildUpdatedProductMetadata(npe03__Recurring_Donation__c rd) {
         Map<String, Object> existingProductMetadata = getExistingProductMetadata(rd.CommitmentId__c);
         PS_ProductMetadata productMetadata = new PS_ProductMetadata()
@@ -743,6 +765,7 @@ public inherited sharing class PS_CommitmentRequest {
      */
     public class Schedule {
         public Integer amount;
+        public Integer nextPaymentAmount;
         public String frequency;
         public Integer frequencyInterval;
         public String firstOccurrenceOnTimestamp;
@@ -767,6 +790,11 @@ public inherited sharing class PS_CommitmentRequest {
             Double amount = rdSchedule.InstallmentAmount__c * currencyMultiplier;
             this.amount = amount == null ? null : Integer.valueOf(amount);
 
+            Double nextPaymentAmount = rdSchedule.NextPaymentAmount__c;
+            this.nextPaymentAmount = nextPaymentAmount == null 
+                ? null 
+                : Integer.valueOf(nextPaymentAmount * currencyMultiplier);
+
             this.frequency = frequencyByInstallmentPeriod.get(rdSchedule.InstallmentPeriod__c);
             this.frequencyInterval = rdSchedule.InstallmentFrequency__c == null
                 ? null

force-app/main/default/classes/PS_CommitmentRequest_TEST.cls

@@ -161,6 +161,50 @@ private with sharing class PS_CommitmentRequest_TEST {
         System.assertEquals(FIRST_PAYMENT_DATE.formatGMT('yyyy-MM-dd\'T\'HH:mm:ss\'Z\''), schedule.firstOccurrenceOnTimestamp, 'First Payment Date should match');
     }
 
+    /**
+    * @description Verifies that the update next payment amount request body is built based on the Recurring Donation and Schedule fields
+    */
+    @isTest
+    private static void shouldBuildUpdateNextPaymentAmountRequestBody() {
+        RD2_ScheduleService.currentDate = CURRENT_DATE;
+        PS_IntegrationService.setConfiguration(PS_IntegrationServiceConfig_TEST.testConfig);
+        RD2_EnablementService_TEST.setRecurringDonations2Enabled();
+
+        Contact contact = getContact();
+        npe03__Recurring_Donation__c rd = getRecurringDonationBuilder()
+            .withContact(contact.Id)
+            .withInstallmentFrequency(INSTALLMENT_FREQUENCY)
+            .withCommitmentId(COMMITMENT_ID)
+            .withPaymentMethod(RD2_Constants.PAYMENT_PICKLIST_VALUE_CARD)
+            .build();
+
+        insert rd;
+
+        npe03__Recurring_Donation__c oldRd = rd.clone();
+
+        PS_CommitmentRequest request = new PS_CommitmentRequest();
+
+        Decimal nextPaymentAmount = 10.11;
+
+        Test.startTest();
+        PS_CommitmentRequest.RequestBody requestBody = request.getUpdateScheduleRequestBody(rd, nextPaymentAmount);
+        Test.stopTest();
+
+        System.assertEquals(UserInfo.getDefaultCurrency(), requestBody.currencyCode, 'Currency Code should match');
+        System.assertEquals(rd.CommitmentId__c, requestBody.id, 'Commitment Id should match');
+        System.assertEquals(true, requestBody.deactivateAllExistingSchedules, 'Deactivate Existing Schedules Boolean should set to true');
+        System.assertEquals(1, requestBody.schedules.size(),
+            'One schedule should be passed to the API: ' + requestBody.schedules);
+
+        PS_CommitmentRequest.Schedule schedule = requestBody.schedules[0];
+        System.assertEquals(AMOUNT * USD_CURRENCY_MULTIPLIER, schedule.amount, 'Recurring Amount should match');
+        System.assertEquals(nextPaymentAmount * USD_CURRENCY_MULTIPLIER, schedule.nextPaymentAmount, 'Next Payment Amount should match');
+        System.assertEquals('MONTH', schedule.frequency, 'Donation should be made monthly');
+        System.assertEquals('CREATE', schedule.operation, 'Schedule should be Created, not Updated');
+        System.assertEquals(INSTALLMENT_FREQUENCY, schedule.frequencyInterval, 'Donation frequency should match');
+        System.assertEquals(FIRST_PAYMENT_DATE.formatGMT('yyyy-MM-dd\'T\'HH:mm:ss\'Z\''), schedule.firstOccurrenceOnTimestamp, 'First Payment Date should match');
+    }
+
     /**
     * @description Verify update request when changing payment method to ACH
     */

force-app/main/default/classes/RD2_CommitmentService.cls

@@ -85,6 +85,31 @@ public without sharing class RD2_CommitmentService {
     }
 
 
+    /**
+    * @description Handles validation and Elevate recurring commitment creation
+    * @param rd Recurring Donation
+    * @param nextPaymentAmount The Next Payment Amount to set on the Schedule
+    * @return UTIL_Http.Response Payments API response
+    */
+    public UTIL_Http.Response handleCommitmentNextPaymentAmount(npe03__Recurring_Donation__c rd, Decimal nextPaymentAmount) {
+        UTIL_Http.Response response;
+
+        // If we want to revert the Next Payment Amount in Elevate, we need to overwrite the value
+        if (nextPaymentAmount == null) {
+            nextPaymentAmount = rd.npe03__Amount__c;
+        }
+
+        PS_CommitmentRequest.RequestBody requestBody = 
+            new PS_CommitmentRequest().getUpdateScheduleRequestBody(rd, nextPaymentAmount);
+
+        response = sendRequest(rd?.CommitmentId__c, JSON.serialize(requestBody),
+            PS_Request.ElevateEndpoint.COMMITMENT);
+
+        processResponse(rd, response);
+
+        return response;
+    }
+
     /**
     * @description Constructs Recurring Donation record from received fields specified in the JSON string,
     * updates defaults that are otherwise updated in the trigger context, and

force-app/main/default/classes/RD2_EntryFormController.cls

@@ -324,6 +324,53 @@ public with sharing class RD2_EntryFormController {
         return null;
     }
 
+    /**
+    * @description Handles validation and Elevate recurring commitment creation
+    * @param rd Recurring Donation
+    * @param nextPaymentAmount The Next Payment Amount to set on the Schedule
+    * @return String Commitment API response
+    */
+    @AuraEnabled
+    public static String handleNextPaymentAmount(Id rdId, Decimal nextPaymentAmount) {
+        try {
+            npe03__Recurring_Donation__c rd = selector.getRecurringDonationForUI(rdId);
+            UTIL_Http.Response response;
+
+            if (rd?.CommitmentId__c != null) {
+                response = commitmentService.handleCommitmentNextPaymentAmount(rd, nextPaymentAmount);
+
+                if (commitmentService.isCommitmentSuccess(response)) {
+                    updateSchedulesWithNextPaymentAmount(rd, nextPaymentAmount);
+                }
+
+                return JSON.serialize(response);
+
+            } else {
+                updateSchedulesWithNextPaymentAmount(rd, nextPaymentAmount);
+                RD2_QueueableService.enqueueOppEvalService(rd.Id, true);
+            }
+        } catch (Exception ex) {
+            UTIL_AuraEnabledCommon.throwAuraHandledException(ex.getMessage());
+        }
+
+        return null;
+    }
+
+    /**
+    * @description Helper method to Update Schedule records with a new Next Payment Amount
+    * @param rd Recurring Donation
+    * @param nextPaymentAmount The Next Payment Amount to set on the Schedule
+    */
+    private static void updateSchedulesWithNextPaymentAmount(npe03__Recurring_Donation__c rd, 
+            Decimal nextPaymentAmount) {
+        List<npe03__Recurring_Donation__c> rdList = new List<npe03__Recurring_Donation__c>{rd};
+        RD2_ScheduleService scheduleService = new RD2_ScheduleService();
+        List<RecurringDonationSchedule__c> revisedSchedules = 
+            scheduleService.setSchedulesWithNextPaymentAmount(rdList, nextPaymentAmount);
+
+        UTIL_DMLService.updateRecords(revisedSchedules);
+    }
+
     /***
     * @description Logs an error when a Recurring Donation cannot be created/updated
     * @param recordId A Recurring Donation, or a donor (Contact/Account) Id
@@ -335,5 +382,4 @@ public with sharing class RD2_EntryFormController {
     }
 
 
-
 }

force-app/main/default/classes/RD2_EntryFormController_TEST.cls

@@ -45,6 +45,7 @@ private with sharing class RD2_EntryFormController_TEST {
     private static final String CARD_EXPIRATION_YEAR = '2019';
     private static final String EVENT_VERSION = '1';
     private static final String NO_CREATE_PERMISSION = 'NoCreate';
+    private static final Decimal NEXT_PAYMENT_AMOUNT = 10.11;
 
     private static final TEST_SObjectGateway.RecurringDonationGateway rdGateway = new TEST_SObjectGateway.RecurringDonationGateway();
     private static final TEST_SObjectGateway.ErrorGateway errorGateway = new TEST_SObjectGateway.ErrorGateway();
@@ -852,6 +853,79 @@ private with sharing class RD2_EntryFormController_TEST {
         System.assertEquals(Label.RD2_AmountMustBeValid, result.errors[0].message, 'Wrong error message');
     }
 
+    /***
+    * @description Verifies Recurring Donation should be validate and handle any error before calling Elevate API
+    */
+    @IsTest
+    private static void shouldReturnSuccessWhenUpdatingRdNextPaymentAmount() {
+        RD2_EnablementService_TEST.setRecurringDonations2Enabled();
+        PS_IntegrationService.setConfiguration(PS_IntegrationServiceConfig_TEST.testConfig);
+
+        npe03__Recurring_Donation__c rd = rdGateway.getRecords()[0];
+
+        rd.CommitmentId__c = COMMITMENT_ID;
+        update rd;
+
+        Test.startTest();
+
+        UTIL_Http_TEST.mockRecordUpdateCalloutResponse(mockSuccessResponseBody());
+        String response = RD2_EntryFormController.handleNextPaymentAmount(rd.Id, NEXT_PAYMENT_AMOUNT);
+        Test.stopTest();
+
+        Integer statusCode;
+        String status;
+        JSONParser parser = JSON.createParser(response);
+
+        while (parser.nextToken() != null) {
+            if(parser.getCurrentToken() == JSONToken.FIELD_NAME) {
+                if (parser.getText() == 'statusCode') {
+                    parser.nextToken();
+                    statusCode = parser.getIntegerValue();
+
+                } else if (parser.getText() == 'status') {
+                    parser.nextToken();
+                    status = parser.getText();
+                }
+            }
+        }
+
+        System.assertNotEquals(null, response, 'Expected to receive a response from handleNextPaymentAmount');
+        System.assertEquals(UTIL_Http.STATUS_CODE_OK, statusCode,
+                'The response status code should match: ' + statusCode);
+        System.assertEquals(UTIL_Http.STATUS_OK, status,
+                'The response status should match: ' + status);
+    }
+
+    /***
+    * @description Verifies Recurring Donation should be validate and handle any error before calling Elevate API
+    */
+    @IsTest
+    private static void shouldUpdateScheduleWhenUpdatingRdNextPaymentAmount() {
+        RD2_QueryService queryService = new RD2_QueryService();
+        RD2_EnablementService_TEST.setRecurringDonations2Enabled();
+        PS_IntegrationService.setConfiguration(PS_IntegrationServiceConfig_TEST.testConfig);
+
+        npe03__Recurring_Donation__c rd = rdGateway.getRecords()[0];
+
+        Test.startTest();
+
+        String response = RD2_EntryFormController.handleNextPaymentAmount(rd.Id, NEXT_PAYMENT_AMOUNT);
+
+        Test.stopTest();
+
+        System.assertEquals(null, response, 'Expected to receive a null response');
+
+        List<npe03__Recurring_Donation__c> rds = 
+            queryService.getRecurringDonationsWithRelatedRecords(new Set<Id>{ rd.Id }, START_DATE);
+
+        rd = rds[0];
+        System.assertEquals(1, rd.RecurringDonationSchedules__r.size(), 'There should be 1 schedule');
+        System.assertEquals(true, rd.RecurringDonationSchedules__r[0].Active__c, 
+            'The schedule should be Active');
+        System.assertEquals(NEXT_PAYMENT_AMOUNT, rd.RecurringDonationSchedules__r[0].NextPaymentAmount__c, 
+            'The Next Payment Amount should be set');
+    }
+
     // Helpers
     ////////////////
 

force-app/main/default/classes/RD2_OpportunityEvaluationService.cls

@@ -453,6 +453,7 @@ public inherited sharing class RD2_OpportunityEvaluationService {
                 }
             }
             // TODO Handle Past Due Installment
+
         }
 
         toggleTriggerState(false);
@@ -487,6 +488,7 @@ public inherited sharing class RD2_OpportunityEvaluationService {
         //in order to calculate the Current/Next Year Values
         rds = null;
 
+        List<npe03__Recurring_Donation__c> checkNextPaymentScheduleRds = new List<npe03__Recurring_Donation__c>();
         List<npe03__Recurring_Donation__c> outdatedRDs = new List<npe03__Recurring_Donation__c>();
         for (RD2_RecurringDonation rdRecord : rdRecords) {
             //revise the Year Values only since other other values such as
@@ -499,10 +501,16 @@ public inherited sharing class RD2_OpportunityEvaluationService {
             ) {
                 outdatedRDs.add(rdRecord.getUpdate());
             }
+
+            if (rdRecord.needsNextPaymentScheduleCheck()) {
+                checkNextPaymentScheduleRds.add(rdRecord.getSObject());
+            }
         }
 
         dbService.updateRecords(outdatedRDs);
 
+        dbService.updateRecords(scheduleService.getSchedulesWithClearedNextPaymentAmount(checkNextPaymentScheduleRds));
+
         return this;
     }
 

force-app/main/default/classes/RD2_OpportunityService.cls

@@ -384,10 +384,15 @@ public with sharing class RD2_OpportunityService {
             return false;
         }
 
+        Decimal installmentAmount = installment.installmentAmount;
+        if (installment.nextPaymentAmount != null) {
+            installmentAmount = installment.nextPaymentAmount;
+        }
+
         Boolean isChanged = false;
 
-        if (opp.Amount != installment.installmentAmount) {
-            opp.Amount = installment.installmentAmount;
+        if (opp.Amount != installmentAmount) {
+            opp.Amount = installmentAmount;
             isChanged = true;
         }