FINERACT-1981: pay off schedule handling

kjozsa · Sep 6, 2024 · 885e7b0 · 885e7b0
1 parent 456db2f
commit 885e7b0
Show file tree

Hide file tree

Showing 7 changed files with 257 additions and 177 deletions.
diff --git a/...n/src/main/java/org/apache/fineract/portfolio/loanaccount/data/OutstandingAmountsDTO.java b/...n/src/main/java/org/apache/fineract/portfolio/loanaccount/data/OutstandingAmountsDTO.java
@@ -46,20 +46,24 @@ public Money getTotalOutstanding() {
                 .plus(penaltyCharges());
     }
 
-    public void plusPrincipal(Money principal) {
+    public OutstandingAmountsDTO plusPrincipal(Money principal) {
         this.principal = this.principal.plus(principal);
+        return this;
     }
 
-    public void plusInterest(Money interest) {
+    public OutstandingAmountsDTO plusInterest(Money interest) {
         this.interest = this.interest.plus(interest);
+        return this;
     }
 
-    public void plusFeeCharges(Money feeCharges) {
+    public OutstandingAmountsDTO plusFeeCharges(Money feeCharges) {
         this.feeCharges = this.feeCharges.plus(feeCharges);
+        return this;
     }
 
-    public void plusPenaltyCharges(Money penaltyCharges) {
+    public OutstandingAmountsDTO plusPenaltyCharges(Money penaltyCharges) {
         this.penaltyCharges = this.penaltyCharges.plus(penaltyCharges);
+        return this;
     }
 
 }
diff --git a/...va/org/apache/fineract/portfolio/loanaccount/domain/LoanRepaymentScheduleInstallment.java b/...va/org/apache/fineract/portfolio/loanaccount/domain/LoanRepaymentScheduleInstallment.java
@@ -18,6 +18,8 @@
  */
 package org.apache.fineract.portfolio.loanaccount.domain;
 
+import static org.apache.fineract.portfolio.loanproduct.domain.AllocationType.PENALTY;
+
 import jakarta.persistence.CascadeType;
 import jakarta.persistence.Column;
 import jakarta.persistence.Entity;
@@ -488,6 +490,10 @@ public void resetChargesCharged() {
         this.penaltyCharges = null;
     }
 
+    public boolean isCurrentInstallment(LocalDate transactionDate) {
+        return getFromDate().isBefore(transactionDate) && !getDueDate().isBefore(transactionDate);
+    }
+
     public interface PaymentFunction {
 
         Money accept(LocalDate transactionDate, Money transactionAmountRemaining);

diff --git a/...account/domain/transactionprocessor/impl/AdvancedPaymentScheduleTransactionProcessor.java b/...account/domain/transactionprocessor/impl/AdvancedPaymentScheduleTransactionProcessor.java
diff --git a/.../fineract/portfolio/loanaccount/loanschedule/domain/ProgressiveLoanScheduleGenerator.java b/.../fineract/portfolio/loanaccount/loanschedule/domain/ProgressiveLoanScheduleGenerator.java
@@ -19,6 +19,7 @@
 package org.apache.fineract.portfolio.loanaccount.loanschedule.domain;
 
 import static java.time.temporal.ChronoUnit.DAYS;
+import static org.apache.fineract.portfolio.loanproduct.domain.LoanPreClosureInterestCalculationStrategy.TILL_PRE_CLOSURE_DATE;
 
 import java.math.BigDecimal;
 import java.math.MathContext;
@@ -29,8 +30,8 @@
 import java.util.Comparator;
 import java.util.HashSet;
 import java.util.List;
+import java.util.Optional;
 import java.util.Set;
-import java.util.concurrent.atomic.AtomicBoolean;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.fineract.infrastructure.core.service.MathUtil;
@@ -46,6 +47,7 @@
 import org.apache.fineract.portfolio.loanaccount.domain.LoanCharge;
 import org.apache.fineract.portfolio.loanaccount.domain.LoanRepaymentScheduleInstallment;
 import org.apache.fineract.portfolio.loanaccount.domain.transactionprocessor.LoanRepaymentScheduleTransactionProcessor;
+import org.apache.fineract.portfolio.loanaccount.domain.transactionprocessor.impl.AdvancedPaymentScheduleTransactionProcessor;
 import org.apache.fineract.portfolio.loanaccount.loanschedule.data.LoanScheduleDTO;
 import org.apache.fineract.portfolio.loanaccount.loanschedule.data.LoanScheduleModelDownPaymentPeriod;
 import org.apache.fineract.portfolio.loanaccount.loanschedule.data.LoanScheduleParams;
@@ -247,58 +249,44 @@ public LoanScheduleDTO rescheduleNextInstallments(MathContext mc, LoanApplicatio
     public OutstandingAmountsDTO calculatePrepaymentAmount(MonetaryCurrency currency, LocalDate onDate,
             LoanApplicationTerms loanApplicationTerms, MathContext mc, Loan loan, HolidayDetailDTO holidayDetailDTO,
             LoanRepaymentScheduleTransactionProcessor loanRepaymentScheduleTransactionProcessor) {
-        return switch (loanApplicationTerms.getPreClosureInterestCalculationStrategy()) {
-            case TILL_PRE_CLOSURE_DATE -> {
-                log.debug("calculating prepayment amount till pre closure date (Strategy A)");
-                OutstandingAmountsDTO outstandingAmounts = new OutstandingAmountsDTO(currency);
-                AtomicBoolean firstAfterPayoff = new AtomicBoolean(true);
-                loan.getRepaymentScheduleInstallments().forEach(installment -> {
-                    boolean isInstallmentAfterPayoff = installment.getDueDate().isAfter(onDate);
-
-                    outstandingAmounts.plusPrincipal(installment.getPrincipalOutstanding(currency));
-                    if (isInstallmentAfterPayoff) {
-                        if (firstAfterPayoff.getAndSet(false)) {
-                            outstandingAmounts.plusInterest(calculatePayableInterest(loan, installment, onDate));
-                        } else {
-                            log.debug("Installment {} - {} is after payoff, not counting interest", installment.getFromDate(),
-                                    installment.getDueDate());
-                        }
-                    } else {
-                        log.debug("adding interest for {} - {}: {}", installment.getFromDate(), installment.getDueDate(),
-                                installment.getInterestOutstanding(currency));
-                        outstandingAmounts.plusInterest(installment.getInterestOutstanding(currency));
-                    }
-                    outstandingAmounts.plusFeeCharges(installment.getFeeChargesOutstanding(currency));
-                    outstandingAmounts.plusPenaltyCharges(installment.getPenaltyChargesOutstanding(currency));
-                });
-                yield outstandingAmounts;
-            }
-
-            case TILL_REST_FREQUENCY_DATE -> {
-                log.debug("calculating prepayment amount till rest frequency date (Strategy B)");
-                OutstandingAmountsDTO outstandingAmounts = new OutstandingAmountsDTO(currency);
-                loan.getRepaymentScheduleInstallments().forEach(installment -> {
-                    boolean isPayoffBeforeInstallment = installment.getFromDate().isBefore(onDate);
-
-                    outstandingAmounts.plusPrincipal(installment.getPrincipalOutstanding(currency));
-                    if (isPayoffBeforeInstallment) {
-                        outstandingAmounts.plusInterest(installment.getInterestOutstanding(currency));
-                    } else {
-                        log.debug("Payoff after installment {}, not counting interest", installment.getDueDate());
-                    }
-                    outstandingAmounts.plusFeeCharges(installment.getFeeChargesOutstanding(currency));
-                    outstandingAmounts.plusPenaltyCharges(installment.getPenaltyChargesOutstanding(currency));
-                });
-
-                yield outstandingAmounts;
-            }
-            case NONE -> throw new UnsupportedOperationException("Pre-closure interest calculation strategy not supported");
+        List<LoanRepaymentScheduleInstallment> installments = loan.getRepaymentScheduleInstallments();
+
+        LocalDate transactionDate = switch (loanApplicationTerms.getPreClosureInterestCalculationStrategy()) {
+            case TILL_PRE_CLOSURE_DATE -> onDate;
+            case TILL_REST_FREQUENCY_DATE -> // find due date of current installment
+                installments.stream().filter(it -> it.getFromDate().isBefore(onDate) && it.getDueDate().isAfter(onDate)).findFirst()
+                        .orElseThrow(() -> new IllegalStateException("No installment found for transaction date: " + onDate)).getDueDate();
+            case NONE -> throw new IllegalStateException("Unexpected PreClosureInterestCalculationStrategy: NONE");
         };
+
+        if (!(loanRepaymentScheduleTransactionProcessor instanceof AdvancedPaymentScheduleTransactionProcessor processor)) {
+            throw new IllegalStateException("Expected an AdvancedPaymentScheduleTransactionProcessor");
+        }
+        ProgressiveLoanInterestScheduleModel model = processor.reprocessProgressiveLoanTransactions(loan.getDisbursementDate(),
+                loan.retrieveListOfTransactionsForReprocessing(), currency, installments, loan.getActiveCharges()).getRight();
+
+        LoanRepaymentScheduleInstallment actualInstallment = installments.stream()
+                .filter(it -> transactionDate.isAfter(it.getFromDate()) && !transactionDate.isAfter(it.getDueDate()))
+                .findFirst()
+                .orElse(installments.get(0));
+
+        ProgressiveLoanInterestRepaymentModel result = emiCalculator.getPayableDetails(model, actualInstallment.getDueDate(), transactionDate).orElseThrow();
+
+        OutstandingAmountsDTO amounts = new OutstandingAmountsDTO(currency) //
+                .principal(result.getOutstandingBalance()) //
+                .interest(result.getInterestDue());
+
+        installments.forEach(installment -> amounts //
+                .plusFeeCharges(installment.getFeeChargesOutstanding(currency))
+                .plusPenaltyCharges(installment.getPenaltyChargesOutstanding(currency)));
+
+        return amounts;
     }
 
-    private Money calculatePayableInterest(Loan loan, LoanRepaymentScheduleInstallment installment, LocalDate onDate) {
+    @Deprecated
+    public static Money calculatePayableInterest(LoanRepaymentScheduleInstallment installment, LocalDate onDate) {
         RoundingMode roundingMode = MoneyHelper.getRoundingMode();
-        MonetaryCurrency currency = loan.getCurrency();
+        MonetaryCurrency currency = installment.getLoan().getCurrency();
         Money originalInterest = installment.getInterestCharged(currency);
         log.debug("calculating interest for {} from {} to {}", originalInterest, installment.getFromDate(), installment.getDueDate());
 

diff --git a/...sive-loan/src/main/java/org/apache/fineract/portfolio/loanproduct/calc/EMICalculator.java b/...sive-loan/src/main/java/org/apache/fineract/portfolio/loanproduct/calc/EMICalculator.java
@@ -28,6 +28,7 @@
 import org.apache.fineract.portfolio.loanaccount.loanschedule.data.ProgressiveLoanInterestRepaymentModel;
 import org.apache.fineract.portfolio.loanaccount.loanschedule.data.ProgressiveLoanInterestScheduleModel;
 import org.apache.fineract.portfolio.loanaccount.loanschedule.domain.LoanScheduleModelRepaymentPeriod;
+import org.apache.fineract.portfolio.loanaccount.loanschedule.domain.PrincipalInterest;
 import org.apache.fineract.portfolio.loanproduct.domain.LoanProductRelatedDetail;
 
 public interface EMICalculator {

diff --git a/...rc/main/java/org/apache/fineract/portfolio/loanproduct/calc/ProgressiveEMICalculator.java b/...rc/main/java/org/apache/fineract/portfolio/loanproduct/calc/ProgressiveEMICalculator.java
@@ -33,6 +33,7 @@
 import org.apache.fineract.infrastructure.core.service.DateUtils;
 import org.apache.fineract.infrastructure.core.service.MathUtil;
 import org.apache.fineract.organisation.monetary.domain.Money;
+import org.apache.fineract.organisation.monetary.domain.MoneyHelper;
 import org.apache.fineract.portfolio.common.domain.DaysInMonthType;
 import org.apache.fineract.portfolio.common.domain.DaysInYearType;
 import org.apache.fineract.portfolio.common.domain.PeriodFrequencyType;
@@ -41,6 +42,7 @@
 import org.apache.fineract.portfolio.loanaccount.loanschedule.data.ProgressiveLoanInterestRepaymentModel;
 import org.apache.fineract.portfolio.loanaccount.loanschedule.data.ProgressiveLoanInterestScheduleModel;
 import org.apache.fineract.portfolio.loanaccount.loanschedule.domain.LoanScheduleModelRepaymentPeriod;
+import org.apache.fineract.portfolio.loanaccount.loanschedule.domain.PrincipalInterest;
 import org.apache.fineract.portfolio.loanproduct.domain.LoanProductRelatedDetail;
 import org.apache.fineract.portfolio.loanproduct.mapper.ProgressiveLoanInterestRepaymentModelMapper;
 import org.jetbrains.annotations.NotNull;

diff --git a/...eract/portfolio/loanaccount/loanschedule/domain/ProgressiveLoanScheduleGeneratorTest.java b/...eract/portfolio/loanaccount/loanschedule/domain/ProgressiveLoanScheduleGeneratorTest.java
@@ -121,7 +121,7 @@ public void calculatePrepaymentAmount_TILL_PRE_CLOSURE_DATE() {
 
         OutstandingAmountsDTO amounts = generator.calculatePrepaymentAmount(usd, LocalDate.of(2024, 2, 15), terms, MathContext.DECIMAL32,
                 loan, holidays, processor);
-        assertEquals(BigDecimal.valueOf(83.84), amounts.getTotalOutstanding().getAmount());
+        assertEquals(BigDecimal.valueOf(83.81), amounts.getTotalOutstanding().getAmount());
     }
 
     @Test