FINERACT-2279: Contract Termination - Schedule Handing & Reverse-replay

fineract-loan/src/main/java/org/apache/fineract/infrastructure/event/business/domain/loan/transaction/LoanTransactionContractTerminationPostBusinessEvent.java

@@ -0,0 +1,35 @@
+/**
+ * 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.infrastructure.event.business.domain.loan.transaction;
+
+import org.apache.fineract.portfolio.loanaccount.domain.LoanTransaction;
+
+public class LoanTransactionContractTerminationPostBusinessEvent extends LoanTransactionBusinessEvent {
+
+    private static final String TYPE = "LoanTransactionContractTerminationPostBusinessEvent";
+
+    public LoanTransactionContractTerminationPostBusinessEvent(LoanTransaction value) {
+        super(value);
+    }
+
+    @Override
+    public String getType() {
+        return TYPE;
+    }
+}

fineract-loan/src/main/java/org/apache/fineract/portfolio/loanaccount/api/LoanApiConstants.java

@@ -150,6 +150,9 @@ public interface LoanApiConstants {
     String loanIdToClose = "loanIdToClose";
     String topupAmount = "topupAmount";
 
+    String statusAttributeName = "status";
+    String subStatusAttributeName = "subStatus";
+
     String datatables = "datatables";
 
     String isEqualAmortizationParam = "isEqualAmortization";
@@ -176,6 +179,7 @@ public interface LoanApiConstants {
     String MARK_AS_FRAUD_COMMAND = "markAsFraud";
     String CAPITALIZED_INCOME_TRANSACTION_COMMAND = "capitalizedIncome";
     String CAPITALIZED_INCOME_ADJUSTMENT_TRANSACTION_COMMAND = "capitalizedIncomeAdjustment";
+    String CONTRACT_TERMINATION_COMMAND = "contractTermination";
 
     // Data Validator names
     String LOAN_FRAUD_DATAVALIDATOR_PREFIX = "loans.fraud";

fineract-loan/src/main/java/org/apache/fineract/portfolio/loanaccount/api/LoanTransactionApiConstants.java

@@ -55,5 +55,6 @@ public interface LoanTransactionApiConstants {
         capitalizedIncome, //
         capitalizedIncomeAmortization, //
         capitalizedIncomeAdjustment, //
+        contractTermination, //
     }
 }

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

@@ -1647,6 +1647,14 @@ public class Loan extends AbstractAuditableWithUTCDateTimeCustom<Long> {
         return isForeClosure;
     }
 
+    public boolean isContractTermination() {
+        if (this.loanSubStatus != null) {
+            return loanSubStatus.isContractTermination();
+        }
+
+        return false;
+    }
+
     public List<LoanTermVariations> getActiveLoanTermVariations() {
         if (this.loanTermVariations == null) {
             return new ArrayList<>();
@@ -1846,4 +1854,8 @@ public class Loan extends AbstractAuditableWithUTCDateTimeCustom<Long> {
         return LoanChargeOffBehaviour.ACCELERATE_MATURITY.equals(getLoanProductRelatedDetail().getChargeOffBehaviour());
     }
 
+    public boolean hasContractTerminationTransaction() {
+        return getLoanTransactions().stream().anyMatch(t -> t.isContractTermination() && t.isNotReversed());
+    }
+
 }

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

@@ -51,5 +51,7 @@ public enum LoanEvent {
     LOAN_CREDIT_BALANCE_REFUND, //
     LOAN_CHARGEBACK, //
     LOAN_CHARGE_ADDED, //
-    LOAN_CHARGE_ADJUSTMENT;
+    LOAN_CHARGE_ADJUSTMENT, //
+    LOAN_CONTRACT_TERMINATION, //
+    ;
 }

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

@@ -23,7 +23,9 @@ import org.apache.fineract.infrastructure.core.data.EnumOptionData;
 public enum LoanSubStatus {
 
     INVALID(0, "loanSubStatusType.invalid"), //
-    FORECLOSED(100, "loanSubStatusType.foreclosed");
+    FORECLOSED(100, "loanSubStatusType.foreclosed"), //
+    CONTRACT_TERMINATION(900, "loanSubStatusType.contractTermination"), //
+    ;
 
     private final Integer value;
     private final String code;
@@ -35,6 +37,9 @@ public enum LoanSubStatus {
             case 100:
                 enumeration = LoanSubStatus.FORECLOSED;
             break;
+            case 900:
+                enumeration = LoanSubStatus.CONTRACT_TERMINATION;
+            break;
         }
         return enumeration;
     }
@@ -60,6 +65,10 @@ public enum LoanSubStatus {
         return this.value.equals(LoanSubStatus.FORECLOSED.getValue());
     }
 
+    public boolean isContractTermination() {
+        return this.value.equals(LoanSubStatus.CONTRACT_TERMINATION.getValue());
+    }
+
     public static EnumOptionData loanSubStatus(final int id) {
         return loanSubStatusEnum(LoanSubStatus.fromInt(id));
     }
@@ -72,6 +81,10 @@ public enum LoanSubStatus {
                 optionData = new EnumOptionData(LoanSubStatus.FORECLOSED.getValue().longValue(),
                         codePrefix + LoanSubStatus.FORECLOSED.getCode(), "Foreclosed");
             break;
+            case CONTRACT_TERMINATION:
+                optionData = new EnumOptionData(LoanSubStatus.CONTRACT_TERMINATION.getValue().longValue(),
+                        codePrefix + LoanSubStatus.CONTRACT_TERMINATION.getCode(), "Contract Termination");
+            break;
             default:
                 optionData = new EnumOptionData(LoanSubStatus.INVALID.getValue().longValue(), LoanSubStatus.INVALID.getCode(), "Invalid");
             break;

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

@@ -400,6 +400,15 @@ public class LoanTransaction extends AbstractAuditableWithUTCDateTimeCustom<Long
     }
 
     public static LoanTransaction chargeOff(final Loan loan, final LocalDate chargeOffDate, final ExternalId externalId) {
+        return createTerminalTransaction(loan, chargeOffDate, LoanTransactionType.CHARGE_OFF, externalId);
+    }
+
+    public static LoanTransaction contractTermination(final Loan loan, final LocalDate transactionDate, final ExternalId externalId) {
+        return createTerminalTransaction(loan, transactionDate, LoanTransactionType.CONTRACT_TERMINATION, externalId);
+    }
+
+    private static LoanTransaction createTerminalTransaction(final Loan loan, final LocalDate transactionDate,
+            final LoanTransactionType transactionType, final ExternalId externalId) {
         BigDecimal principalPortion = loan.getSummary().getTotalPrincipalOutstanding().compareTo(BigDecimal.ZERO) != 0
                 ? loan.getSummary().getTotalPrincipalOutstanding()
                 : null;
@@ -414,8 +423,8 @@ public class LoanTransaction extends AbstractAuditableWithUTCDateTimeCustom<Long
                 : null;
         BigDecimal totalOutstanding = loan.getSummary().getTotalOutstanding();
 
-        return new LoanTransaction(loan, loan.getOffice(), LoanTransactionType.CHARGE_OFF, chargeOffDate, totalOutstanding,
-                principalPortion, interestPortion, feePortion, penaltyPortion, null, false, null, externalId);
+        return new LoanTransaction(loan, loan.getOffice(), transactionType, transactionDate, totalOutstanding, principalPortion,
+                interestPortion, feePortion, penaltyPortion, null, false, null, externalId);
     }
 
     private LoanTransaction(final Loan loan, final Office office, final LoanTransactionType type, final BigDecimal amount,
@@ -661,6 +670,10 @@ public class LoanTransaction extends AbstractAuditableWithUTCDateTimeCustom<Long
         return LoanTransactionType.CAPITALIZED_INCOME_ADJUSTMENT.equals(getTypeOf()) && isNotReversed();
     }
 
+    public boolean isContractTermination() {
+        return LoanTransactionType.CONTRACT_TERMINATION.equals(getTypeOf()) && isNotReversed();
+    }
+
     public boolean isWaiver() {
         return isInterestWaiver() || isChargesWaiver();
     }
@@ -772,7 +785,7 @@ public class LoanTransaction extends AbstractAuditableWithUTCDateTimeCustom<Long
                 || type == LoanTransactionType.INITIATE_TRANSFER || type == LoanTransactionType.REJECT_TRANSFER
                 || type == LoanTransactionType.WITHDRAW_TRANSFER || type == LoanTransactionType.CHARGE_OFF
                 || type == LoanTransactionType.REAMORTIZE || type == LoanTransactionType.REAGE
-                || type == LoanTransactionType.CAPITALIZED_INCOME_AMORTIZATION);
+                || type == LoanTransactionType.CAPITALIZED_INCOME_AMORTIZATION || type == LoanTransactionType.CONTRACT_TERMINATION);
     }
 
     public void updateOutstandingLoanBalance(BigDecimal outstandingLoanBalance) {

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

@@ -70,6 +70,8 @@ public enum LoanTransactionType {
     CAPITALIZED_INCOME(35, "loanTransactionType.capitalizedIncome"), //
     CAPITALIZED_INCOME_AMORTIZATION(36, "loanTransactionType.capitalizedIncomeAmortization"), //
     CAPITALIZED_INCOME_ADJUSTMENT(37, "loanTransactionType.capitalizedIncomeAdjustment"), //
+    // Kind of Final Transactions
+    CONTRACT_TERMINATION(38, "loanTransactionType.contractTermination"), //
     ;
 
     private final Integer value;
@@ -123,6 +125,7 @@ public enum LoanTransactionType {
             case 35 -> LoanTransactionType.CAPITALIZED_INCOME;
             case 36 -> LoanTransactionType.CAPITALIZED_INCOME_AMORTIZATION;
             case 37 -> LoanTransactionType.CAPITALIZED_INCOME_ADJUSTMENT;
+            case 38 -> LoanTransactionType.CONTRACT_TERMINATION;
             default -> LoanTransactionType.INVALID;
         };
     }
@@ -247,4 +250,8 @@ public enum LoanTransactionType {
     public boolean isCapitalizedIncomeAdjustment() {
         return this == LoanTransactionType.CAPITALIZED_INCOME_ADJUSTMENT;
     }
+
+    public boolean isContractTermination() {
+        return this == LoanTransactionType.CONTRACT_TERMINATION;
+    }
 }

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

@@ -155,7 +155,8 @@ public class LoanDownPaymentHandlerServiceImpl implements LoanDownPaymentHandler
         if (!processLatest || reprocessOnPostConditions) {
             if (loan.isCumulativeSchedule() && loan.isInterestBearingAndInterestRecalculationEnabled()) {
                 loanScheduleService.regenerateRepaymentScheduleWithInterestRecalculation(loan, scheduleGeneratorDTO);
-            } else if (loan.isProgressiveSchedule() && loan.hasChargeOffTransaction() && loan.hasAccelerateChargeOffStrategy()) {
+            } else if (loan.isProgressiveSchedule() && ((loan.hasChargeOffTransaction() && loan.hasAccelerateChargeOffStrategy())
+                    || loan.hasContractTerminationTransaction())) {
                 loanScheduleService.regenerateRepaymentSchedule(loan, scheduleGeneratorDTO);
             }
             reprocessLoanTransactionsService.reprocessTransactions(loan);

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

@@ -51,8 +51,9 @@ public class LoanTransactionService {
     }
 
     private Predicate<LoanTransaction> loanTransactionForReprocessingPredicate() {
-        return transaction -> transaction.isNotReversed() && (transaction.isChargeOff() || transaction.isReAge()
-                || transaction.isAccrualActivity() || transaction.isReAmortize() || !transaction.isNonMonetaryTransaction());
+        return transaction -> transaction.isNotReversed()
+                && (transaction.isChargeOff() || transaction.isReAge() || transaction.isAccrualActivity() || transaction.isReAmortize()
+                        || !transaction.isNonMonetaryTransaction() || transaction.isContractTermination());
     }
 
 }

fineract-loan/src/main/java/org/apache/fineract/portfolio/loanproduct/service/LoanEnumerations.java

@@ -333,6 +333,8 @@ public final class LoanEnumerations {
             case CAPITALIZED_INCOME_ADJUSTMENT ->
                 new LoanTransactionEnumData(LoanTransactionType.CAPITALIZED_INCOME_ADJUSTMENT.getValue().longValue(),
                         LoanTransactionType.CAPITALIZED_INCOME_ADJUSTMENT.getCode(), "Capitalized Income Adjustment");
+            case CONTRACT_TERMINATION -> new LoanTransactionEnumData(LoanTransactionType.CONTRACT_TERMINATION.getValue().longValue(),
+                    LoanTransactionType.CONTRACT_TERMINATION.getCode(), "Contract Termination");
         };
     }