Skip to content

Commit

Permalink
FINERACT-2114: Fix EMI Calculator get payment details
Browse files Browse the repository at this point in the history
  • Loading branch information
@janez89 @adamsaghy
janez89 authored and adamsaghy committed Sep 11, 2024
1 parent 0229630 commit 5215e56
Show file tree
Hide file tree
Showing 4 changed files with 192 additions and 33 deletions.
13 changes: 9 additions & 4 deletions ...neract/portfolio/loanaccount/loanschedule/data/ProgressiveLoanInterestRepaymentModel.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ public class ProgressiveLoanInterestRepaymentModel {
private Money equalMonthlyInstallment;
private Money principalDue;
private Money remainingBalance;
private Money outstandingBalance;

private Money initialBalance;

public ProgressiveLoanInterestRepaymentModel(final LocalDate fromDate, final LocalDate dueDate, final Money equalMonthlyInstallment) {
this.fromDate = fromDate;
Expand All @@ -46,7 +47,7 @@ public ProgressiveLoanInterestRepaymentModel(final LocalDate fromDate, final Loc
this.isLastPeriod = false;

final Money zeroAmount = Money.zero(equalMonthlyInstallment.getCurrency());
this.outstandingBalance = zeroAmount;
this.initialBalance = zeroAmount;
this.remainingBalance = zeroAmount;
this.principalDue = zeroAmount;
this.interestPeriods = new LinkedList<>();
Expand All @@ -59,7 +60,7 @@ public ProgressiveLoanInterestRepaymentModel(ProgressiveLoanInterestRepaymentMod
this.dueDate = repaymentModel.dueDate;
this.isLastPeriod = repaymentModel.isLastPeriod;
this.equalMonthlyInstallment = repaymentModel.equalMonthlyInstallment;
this.outstandingBalance = repaymentModel.outstandingBalance;
this.initialBalance = repaymentModel.initialBalance;
this.remainingBalance = repaymentModel.remainingBalance;
this.principalDue = repaymentModel.principalDue;
this.interestPeriods = new LinkedList<>();
Expand Down Expand Up @@ -88,7 +89,11 @@ public Money getCorrectionAmount() {
.reduce(Money.zero(equalMonthlyInstallment.getCurrency()), Money::plus);
}

public Money getOutstandingBalance() {
return initialBalance.plus(getDisbursedAmountInPeriod());
}

public Money getCorrectedOutstandingBalance() {
return outstandingBalance.plus(getCorrectionAmount());
return getOutstandingBalance().plus(getCorrectionAmount());
}
}
3 changes: 2 additions & 1 deletion ...sive-loan/src/main/java/org/apache/fineract/portfolio/loanproduct/calc/EMICalculator.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ void changeInterestRate(ProgressiveLoanInterestScheduleModel scheduleModel, Loca
void addBalanceCorrection(ProgressiveLoanInterestScheduleModel scheduleModel, LocalDate balanceCorrectionDate,
Money balanceCorrectionAmount);

Optional<ProgressiveLoanInterestRepaymentModel> getPayableDetails(ProgressiveLoanInterestScheduleModel scheduleModel, LocalDate date);
Optional<ProgressiveLoanInterestRepaymentModel> getPayableDetails(ProgressiveLoanInterestScheduleModel scheduleModel,
LocalDate periodDueDate, LocalDate payDate);

ProgressiveLoanInterestScheduleModel makeScheduleModelDeepCopy(ProgressiveLoanInterestScheduleModel scheduleModel);

Expand Down
85 changes: 62 additions & 23 deletions ...rc/main/java/org/apache/fineract/portfolio/loanproduct/calc/ProgressiveEMICalculator.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
*/
package org.apache.fineract.portfolio.loanproduct.calc;

import jakarta.validation.constraints.NotNull;
import java.math.BigDecimal;
import java.math.MathContext;
import java.time.LocalDate;
Expand All @@ -27,6 +28,7 @@
import java.util.Iterator;
import java.util.List;
import java.util.Optional;
import java.util.function.Consumer;
import java.util.function.Predicate;
import lombok.RequiredArgsConstructor;
import org.apache.fineract.infrastructure.core.service.DateUtils;
Expand All @@ -42,7 +44,6 @@
import org.apache.fineract.portfolio.loanaccount.loanschedule.domain.LoanScheduleModelRepaymentPeriod;
import org.apache.fineract.portfolio.loanproduct.domain.LoanProductRelatedDetail;
import org.apache.fineract.portfolio.loanproduct.mapper.ProgressiveLoanInterestRepaymentModelMapper;
import org.jetbrains.annotations.NotNull;
import org.springframework.stereotype.Component;

@Component
Expand Down Expand Up @@ -137,44 +138,81 @@ public void addDisbursement(final ProgressiveLoanInterestScheduleModel scheduleM
Optional<ProgressiveLoanInterestRepaymentModel> changeOutstandingBalanceAndUpdateInterestPeriods(
final ProgressiveLoanInterestScheduleModel scheduleModel, final LocalDate balanceChangeDate, final Money disbursedAmount,
final Money correctionAmount) {
return findInterestRepaymentPeriodForBalanceChange(scheduleModel, balanceChangeDate).stream().peek(repaymentPeriod -> {
var interestPeriodOptional = findInterestPeriodForBalanceChange(repaymentPeriod, balanceChangeDate);
return findInterestRepaymentPeriodForBalanceChange(scheduleModel, balanceChangeDate).stream()//
.peek(updateInterestPeriodOnRepaymentPeriod(balanceChangeDate, disbursedAmount, correctionAmount, false))//
.findFirst();//
}

@NotNull
private Consumer<ProgressiveLoanInterestRepaymentModel> updateInterestPeriodOnRepaymentPeriod(final LocalDate balanceChangeDate,
final Money disbursedAmount, final Money correctionAmount, final boolean tillBalanceChangeDate) {
return repaymentPeriod -> {
if (tillBalanceChangeDate && balanceChangeDate.isEqual(repaymentPeriod.getFromDate())) {
insertInterestPeriodIntoStart(repaymentPeriod, disbursedAmount, correctionAmount);
return;
}

final var interestPeriodOptional = findInterestPeriodForBalanceChange(repaymentPeriod, balanceChangeDate);
if (interestPeriodOptional.isPresent()) {
interestPeriodOptional.get().addDisbursedAmount(disbursedAmount);
interestPeriodOptional.get().addCorrectionAmount(correctionAmount);
} else {
insertInterestPeriod(repaymentPeriod, balanceChangeDate, disbursedAmount, correctionAmount);
}
}).findFirst();
};
}

void insertInterestPeriodIntoStart(final ProgressiveLoanInterestRepaymentModel repaymentPeriod, final Money disbursedAmount,
final Money correctionAmount) {
final Money zeroAmount = Money.zero(disbursedAmount.getCurrency());
// interestPeriodFromDate is after disb.date because this case when disbursement date is different then interest
// we always have at least one period
final ProgressiveLoanInterestRepaymentInterestPeriod selectedInterestPeriod = repaymentPeriod.getInterestPeriods().get(0);

final LocalDate interestPeriodDueDate = selectedInterestPeriod.getFromDate();
final var newInterestPeriod = new ProgressiveLoanInterestRepaymentInterestPeriod(selectedInterestPeriod.getFromDate(),
interestPeriodDueDate, BigDecimal.ZERO, zeroAmount, zeroAmount, Money.zero(disbursedAmount.getCurrency()));

newInterestPeriod.setDisbursedAmount(disbursedAmount.add(selectedInterestPeriod.getDisbursedAmount()));
newInterestPeriod.setCorrectionAmount(correctionAmount.add(selectedInterestPeriod.getCorrectionAmount()));

// reset amounts on next periods
selectedInterestPeriod.setDisbursedAmount(zeroAmount);
selectedInterestPeriod.setCorrectionAmount(zeroAmount);
selectedInterestPeriod.setFromDate(interestPeriodDueDate);

repaymentPeriod.getInterestPeriods().add(newInterestPeriod);
Collections.sort(repaymentPeriod.getInterestPeriods());
}

void insertInterestPeriod(final ProgressiveLoanInterestRepaymentModel repaymentPeriod, final LocalDate balanceChangeDate,
void insertInterestPeriod(final ProgressiveLoanInterestRepaymentModel repaymentPeriod, final LocalDate interestPeriodFromDate,
final Money disbursedAmount, final Money correctionAmount) {
// balanceChangeDate is after disb.date because this case when disbursement date is different then interest
// interestPeriodFromDate is after disb.date because this case when disbursement date is different then interest
// period start date
final ProgressiveLoanInterestRepaymentInterestPeriod previousInterestPeriod = repaymentPeriod.getInterestPeriods().stream()
.filter(balanceChangeRelatedPreviousInterestPeriod(repaymentPeriod, balanceChangeDate))//
.filter(operationRelatedPreviousInterestPeriod(repaymentPeriod, interestPeriodFromDate))//
.findFirst()//
.get();//

final boolean changeAfterLastRepaymentPeriod = repaymentPeriod.isLastPeriod()
&& previousInterestPeriod.getDueDate().isEqual(repaymentPeriod.getDueDate());
final LocalDate interestPeriodDueDate = changeAfterLastRepaymentPeriod ? balanceChangeDate.plusDays(1)
&& previousInterestPeriod.getDueDate().isEqual(repaymentPeriod.getDueDate())
&& !interestPeriodFromDate.isBefore(repaymentPeriod.getDueDate());
final LocalDate interestPeriodDueDate = changeAfterLastRepaymentPeriod ? interestPeriodFromDate.plusDays(1)
: previousInterestPeriod.getDueDate();
final var interestPeriod = new ProgressiveLoanInterestRepaymentInterestPeriod(balanceChangeDate, interestPeriodDueDate,
final var interestPeriod = new ProgressiveLoanInterestRepaymentInterestPeriod(interestPeriodFromDate, interestPeriodDueDate,
BigDecimal.ZERO, disbursedAmount, correctionAmount, Money.zero(disbursedAmount.getCurrency()));

previousInterestPeriod.setDueDate(balanceChangeDate);
previousInterestPeriod.setDueDate(interestPeriodFromDate);

repaymentPeriod.getInterestPeriods().add(interestPeriod);
Collections.sort(repaymentPeriod.getInterestPeriods());
}

private static @NotNull Predicate<ProgressiveLoanInterestRepaymentInterestPeriod> balanceChangeRelatedPreviousInterestPeriod(
ProgressiveLoanInterestRepaymentModel repaymentPeriod, LocalDate balanceChangeDate) {
return interestPeriod -> balanceChangeDate.isAfter(interestPeriod.getFromDate())
&& (balanceChangeDate.isBefore(interestPeriod.getDueDate())
|| (repaymentPeriod.isLastPeriod() && !balanceChangeDate.isBefore(repaymentPeriod.getDueDate())));
private static Predicate<ProgressiveLoanInterestRepaymentInterestPeriod> operationRelatedPreviousInterestPeriod(
ProgressiveLoanInterestRepaymentModel repaymentPeriod, LocalDate operationDate) {
return interestPeriod -> operationDate.isAfter(interestPeriod.getFromDate())
&& (operationDate.isBefore(interestPeriod.getDueDate()) || (repaymentPeriod.getDueDate().equals(interestPeriod.getDueDate())
&& !operationDate.isBefore(repaymentPeriod.getDueDate())));
}

@Override
Expand Down Expand Up @@ -241,15 +279,16 @@ public void addBalanceCorrection(ProgressiveLoanInterestScheduleModel scheduleMo
}

@Override
public Optional<ProgressiveLoanInterestRepaymentModel> getPayableDetails(ProgressiveLoanInterestScheduleModel scheduleModel,
LocalDate date) {
public Optional<ProgressiveLoanInterestRepaymentModel> getPayableDetails(final ProgressiveLoanInterestScheduleModel scheduleModel,
final LocalDate periodDueDate, final LocalDate payDate) {
final var newScheduleModel = makeScheduleModelDeepCopy(scheduleModel);
final var zeroAmount = Money.zero(scheduleModel.loanProductRelatedDetail().getCurrency());

return changeOutstandingBalanceAndUpdateInterestPeriods(newScheduleModel, date, zeroAmount, zeroAmount).stream()
return findInterestRepaymentPeriod(newScheduleModel, periodDueDate).stream()
.peek(updateInterestPeriodOnRepaymentPeriod(payDate, zeroAmount, zeroAmount, true))//
.peek(repaymentPeriod -> {
calculateRateFactorMinus1ForRepaymentPeriod(repaymentPeriod, scheduleModel);
calculatePrincipalInterestComponentsForPeriod(repaymentPeriod, date);
calculatePrincipalInterestComponentsForPeriod(repaymentPeriod, payDate);
}).findFirst();
}

Expand Down Expand Up @@ -681,16 +720,16 @@ BigDecimal fnValue(final BigDecimal previousFnValue, final BigDecimal currentRat
void calculatePrincipalInterestComponentsForPeriods(final ProgressiveLoanInterestScheduleModel scheduleModel) {
Money outstandingBalance = Money.zero(scheduleModel.loanProductRelatedDetail().getCurrency());
for (var repaymentPeriod : scheduleModel.repayments()) {
repaymentPeriod.setOutstandingBalance(outstandingBalance);
repaymentPeriod.setInitialBalance(outstandingBalance);
calculatePrincipalInterestComponentsForPeriod(repaymentPeriod, null);
outstandingBalance = repaymentPeriod.getRemainingBalance();
}
}

void calculatePrincipalInterestComponentsForPeriod(final ProgressiveLoanInterestRepaymentModel repaymentPeriod,
final LocalDate calculateTill) {
final Money zeroAmount = Money.zero(repaymentPeriod.getOutstandingBalance().getCurrency());
Money outstandingBalance = repaymentPeriod.getOutstandingBalance();
final Money zeroAmount = Money.zero(repaymentPeriod.getInitialBalance().getCurrency());
Money outstandingBalance = repaymentPeriod.getInitialBalance();
Money balanceCorrection = zeroAmount;
Money cumulatedInterest = zeroAmount;

Expand Down
Loading

0 comments on commit 5215e56

Please sign in to comment.