DRAFT: FINERACT-2162: Chargeback interest bearing loans

fineract-loan/src/main/java/org/apache/fineract/portfolio/loanaccount/domain/LoanRepaymentScheduleInstallment.java

@@ -853,14 +853,6 @@ public void addToInterest(final LocalDate transactionDate, final Money transacti
         checkIfRepaymentPeriodObligationsAreMet(transactionDate, transactionAmount.getCurrency());
     }
 
-    public void addToCreditedPrincipal(final BigDecimal amount) {
-        if (this.creditedPrincipal == null) {
-            this.creditedPrincipal = amount;
-        } else {
-            this.creditedPrincipal = this.creditedPrincipal.add(amount);
-        }
-    }
-
     public void addToCreditedInterest(final BigDecimal amount) {
         if (this.creditedInterest == null) {
             this.creditedInterest = amount;
@@ -869,6 +861,14 @@ public void addToCreditedInterest(final BigDecimal amount) {
         }
     }
 
+    public void addToCreditedPrincipal(final BigDecimal amount) {
+        if (this.creditedPrincipal == null) {
+            this.creditedPrincipal = amount;
+        } else {
+            this.creditedPrincipal = this.creditedPrincipal.add(amount);
+        }
+    }
+
     public void addToCreditedFee(final BigDecimal amount) {
         if (this.creditedFee == null) {
             this.creditedFee = amount;

fineract-loan/src/main/java/org/apache/fineract/portfolio/loanaccount/service/LoanScheduleService.java

@@ -66,17 +66,12 @@ public ChangedTransactionDetail recalculateScheduleFromLastTransaction(final Loa
             final List<Long> existingTransactionIds, final List<Long> existingReversedTransactionIds) {
         existingTransactionIds.addAll(loan.findExistingTransactionIds());
         existingReversedTransactionIds.addAll(loan.findExistingReversedTransactionIds());
-        /*
-         * LocalDate recalculateFrom = null; List<LoanTransaction> loanTransactions =
-         * this.retrieveListOfTransactionsPostDisbursementExcludeAccruals(); for (LoanTransaction loanTransaction :
-         * loanTransactions) { if (recalculateFrom == null ||
-         * loanTransaction.getTransactionDate().isAfter(recalculateFrom)) { recalculateFrom =
-         * loanTransaction.getTransactionDate(); } } generatorDTO.setRecalculateFrom(recalculateFrom);
-         */
-        if (loan.repaymentScheduleDetail().isInterestRecalculationEnabled() && !loan.isChargedOff()) {
-            regenerateRepaymentScheduleWithInterestRecalculation(loan, generatorDTO);
-        } else {
-            regenerateRepaymentSchedule(loan, generatorDTO);
+        if (!loan.isProgressiveSchedule()) {
+            if (loan.repaymentScheduleDetail().isInterestRecalculationEnabled() && !loan.isChargedOff()) {
+                regenerateRepaymentScheduleWithInterestRecalculation(loan, generatorDTO);
+            } else {
+                regenerateRepaymentSchedule(loan, generatorDTO);
+            }
         }
         return loan.reprocessTransactions();
     }

fineract-progressive-loan/src/main/java/org/apache/fineract/portfolio/loanaccount/domain/transactionprocessor/impl/ProgressiveTransactionCtx.java

@@ -32,7 +32,7 @@
 import org.apache.fineract.portfolio.loanaccount.domain.LoanTransaction;
 import org.apache.fineract.portfolio.loanaccount.domain.transactionprocessor.MoneyHolder;
 import org.apache.fineract.portfolio.loanaccount.domain.transactionprocessor.TransactionCtx;
-import org.apache.fineract.portfolio.loanaccount.loanschedule.data.ProgressiveLoanInterestScheduleModel;
+import org.apache.fineract.portfolio.loanproduct.calc.data.ProgressiveLoanInterestScheduleModel;
 
 @Getter
 public class ProgressiveTransactionCtx extends TransactionCtx {

fineract-progressive-loan/src/main/java/org/apache/fineract/portfolio/loanaccount/loanschedule/domain/ProgressiveLoanScheduleGenerator.java

@@ -48,10 +48,10 @@
 import org.apache.fineract.portfolio.loanaccount.loanschedule.data.LoanScheduleModelDownPaymentPeriod;
 import org.apache.fineract.portfolio.loanaccount.loanschedule.data.LoanScheduleParams;
 import org.apache.fineract.portfolio.loanaccount.loanschedule.data.LoanSchedulePlan;
-import org.apache.fineract.portfolio.loanaccount.loanschedule.data.OutstandingDetails;
-import org.apache.fineract.portfolio.loanaccount.loanschedule.data.ProgressiveLoanInterestScheduleModel;
 import org.apache.fineract.portfolio.loanaccount.loanschedule.exception.MultiDisbursementOutstandingAmoutException;
 import org.apache.fineract.portfolio.loanproduct.calc.EMICalculator;
+import org.apache.fineract.portfolio.loanproduct.calc.data.OutstandingDetails;
+import org.apache.fineract.portfolio.loanproduct.calc.data.ProgressiveLoanInterestScheduleModel;
 import org.apache.fineract.portfolio.loanproduct.domain.RepaymentStartDateType;
 import org.springframework.stereotype.Component;
 
@@ -182,9 +182,15 @@ public OutstandingAmountsDTO calculatePrepaymentAmount(MonetaryCurrency currency
                 .principal(outstandingAmounts.getOutstandingPrincipal()) //
                 .interest(outstandingAmounts.getOutstandingInterest());//
 
-        installments.forEach(installment -> result //
-                .plusFeeCharges(installment.getFeeChargesOutstanding(currency))
-                .plusPenaltyCharges(installment.getPenaltyChargesOutstanding(currency)));
+        installments.forEach(installment -> {
+            if (installment.isAdditional()) {
+                result.plusPrincipal(installment.getPrincipalOutstanding(currency))
+                        .plusInterest(installment.getInterestOutstanding(currency));
+            }
+            result //
+                    .plusFeeCharges(installment.getFeeChargesOutstanding(currency))
+                    .plusPenaltyCharges(installment.getPenaltyChargesOutstanding(currency));
+        });
 
         return result;
     }
@@ -200,7 +206,7 @@ public Money getPeriodInterestTillDate(@NotNull LoanRepaymentScheduleInstallment
             return Money.zero(loan.getCurrency());
         }
         ProgressiveLoanInterestScheduleModel model = processor.calculateInterestScheduleModel(loan.getId(), targetDate);
-        return emiCalculator.getPeriodInterestTillDate(model, installment.getDueDate(), targetDate);
+        return emiCalculator.getPeriodInterestTillDate(model, installment.getDueDate(), targetDate, false);
     }
 
     // Private, internal methods

fineract-progressive-loan/src/main/java/org/apache/fineract/portfolio/loanproduct/calc/EMICalculator.java

@@ -27,49 +27,98 @@
 import org.apache.fineract.organisation.monetary.domain.Money;
 import org.apache.fineract.portfolio.loanaccount.data.LoanTermVariationsData;
 import org.apache.fineract.portfolio.loanaccount.domain.LoanRepaymentScheduleInstallment;
-import org.apache.fineract.portfolio.loanaccount.loanschedule.data.OutstandingDetails;
-import org.apache.fineract.portfolio.loanaccount.loanschedule.data.PeriodDueDetails;
-import org.apache.fineract.portfolio.loanaccount.loanschedule.data.ProgressiveLoanInterestScheduleModel;
-import org.apache.fineract.portfolio.loanaccount.loanschedule.data.RepaymentPeriod;
 import org.apache.fineract.portfolio.loanaccount.loanschedule.domain.LoanScheduleModelRepaymentPeriod;
+import org.apache.fineract.portfolio.loanproduct.calc.data.OutstandingDetails;
+import org.apache.fineract.portfolio.loanproduct.calc.data.PeriodDueDetails;
+import org.apache.fineract.portfolio.loanproduct.calc.data.ProgressiveLoanInterestScheduleModel;
+import org.apache.fineract.portfolio.loanproduct.calc.data.RepaymentPeriod;
 import org.apache.fineract.portfolio.loanproduct.domain.LoanProductMinimumRepaymentScheduleRelatedDetail;
 
 public interface EMICalculator {
 
+    /**
+     * This method creates an Interest model with repayment periods from the schedule periods which generated by
+     * schedule generator.
+     */
     @NotNull
     ProgressiveLoanInterestScheduleModel generatePeriodInterestScheduleModel(@NotNull List<LoanScheduleModelRepaymentPeriod> periods,
             @NotNull LoanProductMinimumRepaymentScheduleRelatedDetail loanProductRelatedDetail,
             List<LoanTermVariationsData> loanTermVariations, Integer installmentAmountInMultiplesOf, MathContext mc);
 
+    /**
+     * This method creates an Interest model with repayment periods from the installments which retrieved from the
+     * database.
+     */
     @NotNull
     ProgressiveLoanInterestScheduleModel generateInstallmentInterestScheduleModel(
             @NotNull List<LoanRepaymentScheduleInstallment> installments,
             @NotNull LoanProductMinimumRepaymentScheduleRelatedDetail loanProductRelatedDetail,
             List<LoanTermVariationsData> loanTermVariations, Integer installmentAmountInMultiplesOf, MathContext mc);
 
+    /**
+     * Find repayment period based on Due Date.
+     */
     Optional<RepaymentPeriod> findRepaymentPeriod(ProgressiveLoanInterestScheduleModel scheduleModel, LocalDate dueDate);
 
+    /**
+     * Applies the Bank disbursement on the interest model. This method recalculates the EMI amounts from the action
+     * date.
+     */
     void addDisbursement(ProgressiveLoanInterestScheduleModel scheduleModel, LocalDate disbursementDueDate, Money disbursedAmount);
 
+    /**
+     * Applies the interest rate change on the interest model. This method recalculates the EMI amounts from the action
+     * date.
+     */
     void changeInterestRate(ProgressiveLoanInterestScheduleModel scheduleModel, LocalDate newInterestSubmittedOnDate,
             BigDecimal newInterestRate);
 
+    /**
+     * This method applies outstanding balance correction on the interest model. Negative amount decreases the
+     * outstanding balance while positive amounts are increasing that. Typically used for late repayment or to count
+     * repayments.
+     */
     void addBalanceCorrection(ProgressiveLoanInterestScheduleModel scheduleModel, LocalDate balanceCorrectionDate,
             Money balanceCorrectionAmount);
 
+    /**
+     * This method used for pay interest portion during the repayment transaction.
+     */
     void payInterest(ProgressiveLoanInterestScheduleModel scheduleModel, LocalDate repaymentPeriodDueDate, LocalDate transactionDate,
             Money interestAmount);
 
+    /**
+     * This method used for pay principal portion during the repayment transaction.
+     */
     void payPrincipal(ProgressiveLoanInterestScheduleModel scheduleModel, LocalDate repaymentPeriodDueDate, LocalDate transactionDate,
             Money principalAmount);
 
+    /**
+     * This method used for charge back principal portion. This method increases the outstanding balance. This method
+     * creates a calculated "virtual" EMI for the applied period.
+     */
+    void chargebackPrincipal(ProgressiveLoanInterestScheduleModel scheduleModel, LocalDate transactionDate,
+            Money chargebackPrincipalAmount);
+
+    /**
+     * This method used for charge back interest portion. This method adds extra interest due. This method creates a
+     * calculated "virtual" EMI for the applied period.
+     */
+    void chargebackInterest(ProgressiveLoanInterestScheduleModel scheduleModel, LocalDate transactionDate, Money chargebackInterestAmount);
+
+    /**
+     * This method gives back the maximum of the due principal and maximum of the due interest for a requested day.
+     */
     @NotNull
     PeriodDueDetails getDueAmounts(@NotNull ProgressiveLoanInterestScheduleModel scheduleModel, @NotNull LocalDate periodDueDate,
             @NotNull LocalDate targetDate);
 
+    /**
+     * Gives back the sum of the interest from the whole model on the given date.
+     */
     @NotNull
     Money getPeriodInterestTillDate(@NotNull ProgressiveLoanInterestScheduleModel scheduleModel, @NotNull LocalDate periodDueDate,
-            @NotNull LocalDate targetDate);
+            @NotNull LocalDate targetDate, boolean includeChargebackInterest);
 
     Money getOutstandingLoanBalanceOfPeriod(ProgressiveLoanInterestScheduleModel interestScheduleModel, LocalDate repaymentPeriodDueDate,
             LocalDate targetDate);
@@ -78,5 +127,9 @@ Money getOutstandingLoanBalanceOfPeriod(ProgressiveLoanInterestScheduleModel int
 
     Money getSumOfDueInterestsOnDate(ProgressiveLoanInterestScheduleModel scheduleModel, LocalDate subjectDate);
 
+    /**
+     * This method stops the interest counting for the given range. Chargeback interest counts even if the normal
+     * interest paused.
+     */
     void applyInterestPause(ProgressiveLoanInterestScheduleModel scheduleModel, LocalDate fromDate, LocalDate endDate);
 }