FINERACT-1992 Installment level delinquency is exposed to the loan api.

integration-tests/src/test/java/org/apache/fineract/integrationtests/BaseLoanIntegrationTest.java

@@ -53,6 +53,7 @@ import org.apache.fineract.client.models.PostLoansRequest;
 import org.apache.fineract.client.models.PostLoansResponse;
 import org.apache.fineract.client.util.CallFailedRuntimeException;
 import org.apache.fineract.integrationtests.common.BusinessDateHelper;
+import org.apache.fineract.integrationtests.common.ClientHelper;
 import org.apache.fineract.integrationtests.common.GlobalConfigurationHelper;
 import org.apache.fineract.integrationtests.common.Utils;
 import org.apache.fineract.integrationtests.common.accounting.Account;
@@ -78,6 +79,8 @@ public abstract class BaseLoanIntegrationTest {
     protected final LoanTransactionHelper loanTransactionHelper = new LoanTransactionHelper(requestSpec, responseSpec);
     protected final LoanProductHelper loanProductHelper = new LoanProductHelper();
     protected JournalEntryHelper journalEntryHelper = new JournalEntryHelper(requestSpec, responseSpec);
+    protected ClientHelper clientHelper = new ClientHelper(requestSpec, responseSpec);
+
     protected BusinessDateHelper businessDateHelper = new BusinessDateHelper();
     protected DateTimeFormatter dateTimeFormatter = DateTimeFormatter.ofPattern(DATETIME_PATTERN);
 

integration-tests/src/test/java/org/apache/fineract/integrationtests/DelinquencyActionIntegrationTests.java

@@ -51,7 +51,6 @@ import org.junit.jupiter.api.extension.ExtendWith;
 public class DelinquencyActionIntegrationTests extends BaseLoanIntegrationTest {
 
     public static final BigDecimal DOWN_PAYMENT_PERCENTAGE = new BigDecimal(25);
-    private final ClientHelper clientHelper = new ClientHelper(this.requestSpec, this.responseSpec);
 
     @Test
     public void testCreateAndReadPauseDelinquencyAction() {

integration-tests/src/test/java/org/apache/fineract/integrationtests/InstallmentLevelDelinquencyAPIIntegrationTests.java

@@ -0,0 +1,289 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.fineract.integrationtests;
+
+import static org.apache.fineract.infrastructure.businessdate.domain.BusinessDateType.BUSINESS_DATE;
+import static org.assertj.core.api.Assertions.assertThat;
+
+import java.math.BigDecimal;
+import java.util.List;
+import lombok.AllArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.tuple.Pair;
+import org.apache.fineract.client.models.BusinessDateRequest;
+import org.apache.fineract.client.models.GetLoansLoanIdLoanInstallmentLevelDelinquency;
+import org.apache.fineract.client.models.GetLoansLoanIdResponse;
+import org.apache.fineract.client.models.PostLoanProductsRequest;
+import org.apache.fineract.client.models.PostLoanProductsResponse;
+import org.apache.fineract.integrationtests.common.ClientHelper;
+import org.apache.fineract.integrationtests.common.SchedulerJobHelper;
+import org.apache.fineract.integrationtests.common.loans.LoanTestLifecycleExtension;
+import org.apache.fineract.integrationtests.common.products.DelinquencyBucketsHelper;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+
+@Slf4j
+@ExtendWith(LoanTestLifecycleExtension.class)
+public class InstallmentLevelDelinquencyAPIIntegrationTests extends BaseLoanIntegrationTest {
+
+    private SchedulerJobHelper schedulerJobHelper = new SchedulerJobHelper(this.requestSpec);
+
+    @Test
+    public void testInstallmentLevelDelinquencyFourRangesInTheBucket() {
+        runAt("31 May 2023", () -> {
+            // Create Client
+            Long clientId = clientHelper.createClient(ClientHelper.defaultClientCreationRequest()).getClientId();
+
+            // Create DelinquencyBuckets
+            Integer delinquencyBucketId = DelinquencyBucketsHelper.createDelinquencyBucket(requestSpec, responseSpec, List.of(//
+                    Pair.of(1, 10), //
+                    Pair.of(11, 30), //
+                    Pair.of(31, 60), //
+                    Pair.of(61, null)//
+            ));
+
+            // Create Loan Product
+            PostLoanProductsRequest loanProductsRequest = create1InstallmentAmountInMultiplesOf4Period1MonthLongWithInterestAndAmortizationProduct(
+                    InterestType.FLAT, AmortizationType.EQUAL_INSTALLMENTS);
+            loanProductsRequest.setEnableInstallmentLevelDelinquency(true);
+            loanProductsRequest.setDelinquencyBucketId(delinquencyBucketId.longValue());
+            PostLoanProductsResponse loanProductResponse = loanProductHelper.createLoanProduct(loanProductsRequest);
+
+            // Apply and Approve Loan
+            Long loanId = applyAndApproveLoan(clientId, loanProductResponse.getResourceId(), "01 January 2023", 1250.0, 4);
+
+            // Disburse Loan
+            disburseLoan(loanId, BigDecimal.valueOf(1250), "01 January 2023");
+
+            // Verify Repayment Schedule and Due Dates
+            verifyRepaymentSchedule(loanId, //
+                    installment(0, null, "01 January 2023"), //
+                    installment(313.0, false, "31 January 2023"), // 120 days delinquent -> range4
+                    installment(313.0, false, "02 March 2023"), // 90 days delinquent -> range4
+                    installment(313.0, false, "01 April 2023"), // 60 days delinquent -> range3
+                    installment(311.0, false, "01 May 2023") // 30 days delinquent -> range2
+            );
+
+            // since the current day is 31 May 2023, therefore all the installments are delinquent
+            verifyDelinquency(loanId, 120, "1250.0", //
+                    delinquency(11, 30, "311.0"), // 4th installment
+                    delinquency(31, 60, "313.0"), // 3rd installment
+                    delinquency(61, null, "626.0") // 1st installment + 2nd installment
+            );
+
+            // Repayment of the first two installments
+            addRepaymentForLoan(loanId, 626.0, "31 May 2023");
+            verifyDelinquency(loanId, 60, "624.0", //
+                    delinquency(11, 30, "311.0"), // 4th installment
+                    delinquency(31, 60, "313.0") // 3rd installment
+            );
+
+            // Partial repayment
+            addRepaymentForLoan(loanId, 100.0, "31 May 2023");
+            verifyDelinquency(loanId, 60, "524.0", //
+                    delinquency(11, 30, "311.0"), // 4th installment
+                    delinquency(31, 60, "213.0") // 3rd installment
+            );
+
+            // Repay the loan fully
+            addRepaymentForLoan(loanId, 524.0, "31 May 2023");
+            verifyDelinquency(loanId, 0, "0.0");
+        });
+    }
+
+    @Test
+    public void testInstallmentLevelDelinquencyTwoRangesInTheBucket() {
+        runAt("31 May 2023", () -> {
+            // Create Client
+            Long clientId = clientHelper.createClient(ClientHelper.defaultClientCreationRequest()).getClientId();
+
+            // Create DelinquencyBuckets
+            Integer delinquencyBucketId = DelinquencyBucketsHelper.createDelinquencyBucket(requestSpec, responseSpec, List.of(//
+                    Pair.of(1, 60), //
+                    Pair.of(61, null)//
+            ));
+
+            // Create Loan Product
+            PostLoanProductsRequest loanProductsRequest = create1InstallmentAmountInMultiplesOf4Period1MonthLongWithInterestAndAmortizationProduct(
+                    InterestType.FLAT, AmortizationType.EQUAL_INSTALLMENTS);
+            loanProductsRequest.setEnableInstallmentLevelDelinquency(true);
+            loanProductsRequest.setDelinquencyBucketId(delinquencyBucketId.longValue());
+            PostLoanProductsResponse loanProductResponse = loanProductHelper.createLoanProduct(loanProductsRequest);
+
+            // Apply and Approve Loan
+            Long loanId = applyAndApproveLoan(clientId, loanProductResponse.getResourceId(), "01 January 2023", 1250.0, 4);
+
+            // Disburse Loan
+            disburseLoan(loanId, BigDecimal.valueOf(1250), "01 January 2023");
+
+            // Verify Repayment Schedule and Due Dates
+            verifyRepaymentSchedule(loanId, //
+                    installment(0, null, "01 January 2023"), //
+                    installment(313.0, false, "31 January 2023"), // 120 days delinquent -> range2
+                    installment(313.0, false, "02 March 2023"), // 90 days delinquent -> range2
+                    installment(313.0, false, "01 April 2023"), // 60 days delinquent -> range1
+                    installment(311.0, false, "01 May 2023") // 30 days delinquent -> range1
+            );
+
+            verifyDelinquency(loanId, 120, "1250.0", //
+                    delinquency(1, 60, "624.0"), // 4th installment
+                    delinquency(61, null, "626.0") // 1st installment + 2nd installment
+            );
+
+            // repay the first installment
+            addRepaymentForLoan(loanId, 313.0, "31 May 2023");
+
+            verifyDelinquency(loanId, 90, "937.0", //
+                    delinquency(1, 60, "624.0"), // 4th installment
+                    delinquency(61, null, "313.0") // 1st installment + 2nd installment
+            );
+
+        });
+    }
+
+    @Test
+    public void testInstallmentLevelDelinquencyIsTurnedOff() {
+        runAt("31 May 2023", () -> {
+            // Create Client
+            Long clientId = clientHelper.createClient(ClientHelper.defaultClientCreationRequest()).getClientId();
+
+            // Create DelinquencyBuckets
+            Integer delinquencyBucketId = DelinquencyBucketsHelper.createDelinquencyBucket(requestSpec, responseSpec, List.of(//
+                    Pair.of(1, 60), //
+                    Pair.of(61, null)//
+            ));
+
+            // Create Loan Product
+            PostLoanProductsRequest loanProductsRequest = create1InstallmentAmountInMultiplesOf4Period1MonthLongWithInterestAndAmortizationProduct(
+                    InterestType.FLAT, AmortizationType.EQUAL_INSTALLMENTS);
+            loanProductsRequest.setEnableInstallmentLevelDelinquency(false);
+            loanProductsRequest.setDelinquencyBucketId(delinquencyBucketId.longValue());
+            PostLoanProductsResponse loanProductResponse = loanProductHelper.createLoanProduct(loanProductsRequest);
+
+            // Apply and Approve Loan
+            Long loanId = applyAndApproveLoan(clientId, loanProductResponse.getResourceId(), "01 January 2023", 1250.0, 4);
+
+            // Disburse Loan
+            disburseLoan(loanId, BigDecimal.valueOf(1250), "01 January 2023");
+
+            // Verify Repayment Schedule and Due Dates
+            verifyRepaymentSchedule(loanId, //
+                    installment(0, null, "01 January 2023"), //
+                    installment(313.0, false, "31 January 2023"), // 120 days delinquent -> range2
+                    installment(313.0, false, "02 March 2023"), // 90 days delinquent -> range2
+                    installment(313.0, false, "01 April 2023"), // 60 days delinquent -> range1
+                    installment(311.0, false, "01 May 2023") // 30 days delinquent -> range1
+            );
+
+            // this should be empty as the installment level delinquency is not enabled for this loan
+            verifyDelinquency(loanId, 120, "1250.0");
+        });
+    }
+
+    @Test
+    public void testInstallmentLevelDelinquencyUpdatedWhenCOBIsExecuted() {
+        runAt("01 February 2023", () -> {
+            // Create Client
+            Long clientId = clientHelper.createClient(ClientHelper.defaultClientCreationRequest()).getClientId();
+
+            // Create DelinquencyBuckets
+            Integer delinquencyBucketId = DelinquencyBucketsHelper.createDelinquencyBucket(requestSpec, responseSpec, List.of(//
+                    Pair.of(1, 1), //
+                    Pair.of(2, null)//
+            ));
+
+            // Create Loan Product
+            PostLoanProductsRequest loanProductsRequest = create1InstallmentAmountInMultiplesOf4Period1MonthLongWithInterestAndAmortizationProduct(
+                    InterestType.FLAT, AmortizationType.EQUAL_INSTALLMENTS);
+            loanProductsRequest.setEnableInstallmentLevelDelinquency(true);
+            loanProductsRequest.setDelinquencyBucketId(delinquencyBucketId.longValue());
+            PostLoanProductsResponse loanProductResponse = loanProductHelper.createLoanProduct(loanProductsRequest);
+
+            // Apply and Approve Loan
+            Long loanId = applyAndApproveLoan(clientId, loanProductResponse.getResourceId(), "01 January 2023", 1250.0, 4);
+
+            // Disburse Loan
+            disburseLoan(loanId, BigDecimal.valueOf(1250), "01 January 2023");
+
+            // Verify Repayment Schedule and Due Dates
+            verifyRepaymentSchedule(loanId, //
+                    installment(0, null, "01 January 2023"), installment(313.0, false, "31 January 2023"),
+                    installment(313.0, false, "02 March 2023"), installment(313.0, false, "01 April 2023"),
+                    installment(311.0, false, "01 May 2023"));
+
+            // The first installment falls into the first range
+            verifyDelinquency(loanId, 1, "313.0", //
+                    delinquency(1, 1, "313.0") // 4th installment
+            );
+
+            // Let's go one day ahead in the time
+            updateBusinessDateAndExecuteCOBJob("2 February 2023");
+
+            // The first installment is not two days delinquent and therefore falls into the second range
+            verifyDelinquency(loanId, 2, "313.0", //
+                    delinquency(2, null, "313.0") // 4th installment
+            );
+        });
+    }
+
+    private void updateBusinessDateAndExecuteCOBJob(String date) {
+        businessDateHelper.updateBusinessDate(
+                new BusinessDateRequest().type(BUSINESS_DATE.getName()).date(date).dateFormat(DATETIME_PATTERN).locale("en"));
+        schedulerJobHelper.executeAndAwaitJob("Loan COB");
+    }
+
+    @AllArgsConstructor
+    public static class DelinquencyData {
+
+        Integer minAgeDays;
+        Integer maxAgeDays;
+        BigDecimal delinquentAmount;
+    }
+
+    private static DelinquencyData delinquency(Integer minAgeDays, Integer maxAgeDays, String delinquentAmount) {
+        return new DelinquencyData(minAgeDays, maxAgeDays, new BigDecimal(delinquentAmount));
+    }
+
+    private void verifyDelinquency(Long loanId, Integer loanLevelDelinquentDays, String loanLevelDelinquentAmount,
+            DelinquencyData... expectedInstallmentLevelDelinquencyData) {
+        GetLoansLoanIdResponse loan = loanTransactionHelper.getLoan(requestSpec, responseSpec, loanId.intValue());
+        assertThat(loan.getDelinquent()).isNotNull();
+        List<GetLoansLoanIdLoanInstallmentLevelDelinquency> installmentLevelDelinquency = loan.getDelinquent()
+                .getInstallmentLevelDelinquency();
+
+        assertThat(loan.getDelinquent().getDelinquentDays()).isEqualTo(loanLevelDelinquentDays);
+        assertThat(loan.getDelinquent().getDelinquentAmount()).isEqualByComparingTo(Double.valueOf(loanLevelDelinquentAmount));
+
+        if (expectedInstallmentLevelDelinquencyData != null && expectedInstallmentLevelDelinquencyData.length > 0) {
+            assertThat(installmentLevelDelinquency).isNotNull();
+            assertThat(installmentLevelDelinquency).hasSize(expectedInstallmentLevelDelinquencyData.length);
+            for (int i = 0; i < expectedInstallmentLevelDelinquencyData.length; i++) {
+                assertThat(installmentLevelDelinquency.get(i).getMaximumAgeDays())
+                        .isEqualTo(expectedInstallmentLevelDelinquencyData[i].maxAgeDays);
+                assertThat(installmentLevelDelinquency.get(i).getMinimumAgeDays())
+                        .isEqualTo(expectedInstallmentLevelDelinquencyData[i].minAgeDays);
+                assertThat(installmentLevelDelinquency.get(i).getDelinquentAmount())
+                        .isEqualByComparingTo(expectedInstallmentLevelDelinquencyData[i].delinquentAmount);
+            }
+        } else {
+            assertThat(installmentLevelDelinquency).isNull();
+        }
+    }
+
+}

integration-tests/src/test/java/org/apache/fineract/integrationtests/LoanInstallmentMultiplesOfTest.java

@@ -36,8 +36,6 @@ import org.junit.jupiter.params.provider.MethodSource;
 
 public class LoanInstallmentMultiplesOfTest extends BaseLoanIntegrationTest {
 
-    private final ClientHelper clientHelper = new ClientHelper(this.requestSpec, this.responseSpec);
-
     private static Stream<Arguments> interestTypes() {
         return Stream.of(Arguments.of(Named.of("DECLINING_BALANCE", InterestType.DECLINING_BALANCE)), //
                 Arguments.of(Named.of("FLAT", InterestType.FLAT)));

integration-tests/src/test/java/org/apache/fineract/integrationtests/LoanRescheduleTestWithDownpayment.java

@@ -37,7 +37,6 @@ import org.junit.jupiter.api.extension.ExtendWith;
 public class LoanRescheduleTestWithDownpayment extends BaseLoanIntegrationTest {
 
     public static final BigDecimal DOWN_PAYMENT_PERCENTAGE = new BigDecimal(25);
-    private final ClientHelper clientHelper = new ClientHelper(this.requestSpec, this.responseSpec);
 
     private final LoanRescheduleRequestHelper loanRescheduleRequestHelper = new LoanRescheduleRequestHelper(this.requestSpec,
             this.responseSpec);

integration-tests/src/test/java/org/apache/fineract/integrationtests/UndoLoanDisbursalWithDownPaymentIntegrationTest.java

@@ -37,7 +37,6 @@ import org.junit.jupiter.api.extension.ExtendWith;
 public class UndoLoanDisbursalWithDownPaymentIntegrationTest extends BaseLoanIntegrationTest {
 
     public static final BigDecimal DOWN_PAYMENT_PERCENTAGE = new BigDecimal(25);
-    private final ClientHelper clientHelper = new ClientHelper(this.requestSpec, this.responseSpec);
 
     @Test
     public void testUndoDisbursalForLoanWithSingleDisbursalAutoDownPaymentEnabledAndNoManualTransactions() {

integration-tests/src/test/java/org/apache/fineract/integrationtests/common/products/DelinquencyBucketsHelper.java

@@ -29,7 +29,9 @@ import io.restassured.specification.ResponseSpecification;
 import java.lang.reflect.Type;
 import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.List;
 import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.tuple.Pair;
 import org.apache.fineract.client.models.DeleteDelinquencyBucketResponse;
 import org.apache.fineract.client.models.GetDelinquencyBucketsResponse;
 import org.apache.fineract.client.models.GetDelinquencyRangesResponse;
@@ -87,13 +89,31 @@ public class DelinquencyBucketsHelper {
         return GSON.fromJson(response, DeleteDelinquencyBucketResponse.class);
     }
 
-    public static String getAsJSON(final ArrayList<Integer> rangeIds) {
+    public static String getAsJSON(final List<Integer> rangeIds) {
         final HashMap<String, Object> map = new HashMap<>();
         map.put("name", Utils.uniqueRandomStringGenerator("Delinquency_Bucket_", 4));
         map.put("ranges", rangeIds.toArray());
         return new Gson().toJson(map);
     }
 
+    public static Integer createDelinquencyBucket(final RequestSpecification requestSpec, final ResponseSpecification responseSpec,
+            List<Pair<Integer, Integer>> ranges) {
+        List<Integer> rangeIds = ranges.stream().map(r -> createDelinquencyRange(requestSpec, responseSpec, r)).toList();
+        String jsonBucket = DelinquencyBucketsHelper.getAsJSON(rangeIds);
+        PostDelinquencyBucketResponse delinquencyBucketResponse = DelinquencyBucketsHelper.createDelinquencyBucket(requestSpec,
+                responseSpec, jsonBucket);
+        assertNotNull(delinquencyBucketResponse);
+        return delinquencyBucketResponse.getResourceId();
+    }
+
+    public static Integer createDelinquencyRange(final RequestSpecification requestSpec, final ResponseSpecification responseSpec,
+            Pair<Integer, Integer> range) {
+        String jsonRange = DelinquencyRangesHelper.getAsJSON(range.getLeft(), range.getRight());
+        PostDelinquencyRangeResponse delinquencyRangeResponse = DelinquencyRangesHelper.createDelinquencyRange(requestSpec, responseSpec,
+                jsonRange);
+        return delinquencyRangeResponse.getResourceId();
+    }
+
     public static Integer createDelinquencyBucket(final RequestSpecification requestSpec, final ResponseSpecification responseSpec) {
         ArrayList<Integer> rangeIds = new ArrayList<>();
 

integration-tests/src/test/java/org/apache/fineract/integrationtests/common/products/DelinquencyRangesHelper.java

@@ -83,7 +83,7 @@ public class DelinquencyRangesHelper {
         return GSON.fromJson(response, DeleteDelinquencyRangeResponse.class);
     }
 
-    public static String getAsJSON(int minimumAgeDays, int maximumAgeDays) {
+    public static String getAsJSON(Integer minimumAgeDays, Integer maximumAgeDays) {
         final HashMap<String, Object> map = new HashMap<>();
         map.put("classification", Utils.uniqueRandomStringGenerator("Delinquency__" + minimumAgeDays + "_" + maximumAgeDays + "__", 4));
         map.put("minimumAgeDays", minimumAgeDays);