FINERACT-1960: Accrual Transactions For Savings batch job

apache · Jul 16, 2024 · 0a11c8f · 0a11c8f
1 parent 6c4932b
commit 0a11c8f
Show file tree

Hide file tree

Showing 38 changed files with 1,416 additions and 102 deletions.
diff --git a/fineract-avro-schemas/src/main/avro/savings/v1/SavingsAccountSummaryDataV1.avsc b/fineract-avro-schemas/src/main/avro/savings/v1/SavingsAccountSummaryDataV1.avsc
@@ -138,6 +138,22 @@
                 "null",
                 "string"
             ]
+        },
+        {
+            "default": null,
+            "name": "accruedTillDate",
+            "type": [
+                "null",
+                "string"
+            ]
+        },
+        {
+            "default": null,
+            "name": "totalInterestAccrued",
+            "type": [
+                "null",
+                "bigdecimal"
+            ]
         }
     ]
 }
diff --git a/fineract-core/src/main/java/org/apache/fineract/infrastructure/jobs/service/JobName.java b/fineract-core/src/main/java/org/apache/fineract/infrastructure/jobs/service/JobName.java
@@ -57,6 +57,7 @@ public enum JobName {
     SEND_ASYNCHRONOUS_EVENTS("Send Asynchronous Events"), //
     PURGE_EXTERNAL_EVENTS("Purge External Events"), //
     PURGE_PROCESSED_COMMANDS("Purge Processed Commands"), //
+    ADD_PERIODIC_ACCRUAL_ENTRIES_FOR_SAVINGS_WITH_INCOME_POSTED_AS_TRANSACTIONS("Add Accrual Transactions For Savings"); //
     ;
 
     private final String name;

diff --git a/...isation/staff/domain/StaffRepository.java → ...isation/staff/domain/StaffRepository.java b/...isation/staff/domain/StaffRepository.java → ...isation/staff/domain/StaffRepository.java
diff --git a/.../staff/domain/StaffRepositoryWrapper.java → .../staff/domain/StaffRepositoryWrapper.java b/.../staff/domain/StaffRepositoryWrapper.java → .../staff/domain/StaffRepositoryWrapper.java
diff --git a/...lient/domain/ClientRepositoryWrapper.java → ...lient/domain/ClientRepositoryWrapper.java b/...lient/domain/ClientRepositoryWrapper.java → ...lient/domain/ClientRepositoryWrapper.java
diff --git a/...rtfolio/group/domain/GroupRepository.java → ...rtfolio/group/domain/GroupRepository.java b/...rtfolio/group/domain/GroupRepository.java → ...rtfolio/group/domain/GroupRepository.java
diff --git a/.../group/domain/GroupRepositoryWrapper.java → .../group/domain/GroupRepositoryWrapper.java b/.../group/domain/GroupRepositoryWrapper.java → .../group/domain/GroupRepositoryWrapper.java
diff --git a/...p/exception/CenterNotActiveException.java → ...p/exception/CenterNotActiveException.java b/...p/exception/CenterNotActiveException.java → ...p/exception/CenterNotActiveException.java
diff --git a/...oup/exception/GroupNotFoundException.java → ...oup/exception/GroupNotFoundException.java b/...oup/exception/GroupNotFoundException.java → ...oup/exception/GroupNotFoundException.java
diff --git a/...e/src/main/java/org/apache/fineract/portfolio/savings/data/SavingsAccountSummaryData.java b/...e/src/main/java/org/apache/fineract/portfolio/savings/data/SavingsAccountSummaryData.java
@@ -56,13 +56,15 @@ public class SavingsAccountSummaryData implements Serializable {
     private LocalDate interestPostedTillDate;
     private LocalDate prevInterestPostedTillDate;
     private transient BigDecimal runningBalanceOnInterestPostingTillDate = BigDecimal.ZERO;
+    private LocalDate accruedTillDate;
+    private BigDecimal totalInterestAccrued;
 
     public SavingsAccountSummaryData(final CurrencyData currency, final BigDecimal totalDeposits, final BigDecimal totalWithdrawals,
             final BigDecimal totalWithdrawalFees, final BigDecimal totalAnnualFees, final BigDecimal totalInterestEarned,
             final BigDecimal totalInterestPosted, final BigDecimal accountBalance, final BigDecimal totalFeeCharge,
             final BigDecimal totalPenaltyCharge, final BigDecimal totalOverdraftInterestDerived, final BigDecimal totalWithholdTax,
             final BigDecimal interestNotPosted, final LocalDate lastInterestCalculationDate, final BigDecimal availableBalance,
-            final LocalDate interestPostedTillDate) {
+            final LocalDate interestPostedTillDate, final LocalDate accruedTillDate) {
         this.currency = currency;
         this.totalDeposits = totalDeposits;
         this.totalWithdrawals = totalWithdrawals;
@@ -79,6 +81,7 @@ public SavingsAccountSummaryData(final CurrencyData currency, final BigDecimal t
         this.lastInterestCalculationDate = lastInterestCalculationDate;
         this.availableBalance = availableBalance;
         this.interestPostedTillDate = interestPostedTillDate;
+        this.accruedTillDate = accruedTillDate;
     }
 
     public void setPrevInterestPostedTillDate(LocalDate interestPostedTillDate) {
@@ -255,6 +258,7 @@ public void updateSummary(final CurrencyData currency, final SavingsAccountTrans
         this.totalPenaltyCharge = wrapper.calculateTotalPenaltyChargeWaived(currency, transactions);
         this.totalOverdraftInterestDerived = wrapper.calculateTotalOverdraftInterest(currency, transactions);
         this.totalWithholdTax = wrapper.calculateTotalWithholdTaxWithdrawal(currency, transactions);
+        this.totalInterestAccrued = wrapper.calculateTotalInterestAccrued(currency, transactions);
 
         // boolean isUpdated = false;
         updateRunningBalanceAndPivotDate(false, transactions, null, null, null);

diff --git a/...c/main/java/org/apache/fineract/portfolio/savings/data/SavingsAccountTransactionData.java b/...c/main/java/org/apache/fineract/portfolio/savings/data/SavingsAccountTransactionData.java
@@ -626,6 +626,10 @@ public boolean isWithHoldTaxAndNotReversed() {
         return SavingsAccountTransactionType.fromInt(this.transactionType.getId().intValue()).isWithHoldTax() && isNotReversed();
     }
 
+    public boolean isAccrual() {
+        return this.transactionType.isAccrual();
+    }
+
     public boolean isNotReversed() {
         return !isReversed();
     }

diff --git a/...apache/fineract/portfolio/savings/domain/SavingsAccountTransactionDataSummaryWrapper.java b/...apache/fineract/portfolio/savings/domain/SavingsAccountTransactionDataSummaryWrapper.java
@@ -142,4 +142,15 @@ public BigDecimal calculateTotalWithholdTaxWithdrawal(CurrencyData currency, Lis
         }
         return total.getAmountDefaultedToNullIfZero();
     }
+
+    public BigDecimal calculateTotalInterestAccrued(CurrencyData currency, List<SavingsAccountTransactionData> transactions) {
+        Money total = Money.zero(currency);
+        for (final SavingsAccountTransactionData transaction : transactions) {
+            if (transaction.isAccrual() && !transaction.isReversalTransaction()) {
+                total = total.plus(transaction.getAmount());
+            }
+        }
+        return total.getAmountDefaultedToNullIfZero();
+    }
+
 }
diff --git a/...n/java/org/apache/fineract/accounting/journalentry/service/AccountingProcessorHelper.java b/...n/java/org/apache/fineract/accounting/journalentry/service/AccountingProcessorHelper.java
@@ -203,12 +203,13 @@ public SavingsDTO populateSavingsDtoFromMap(final Map<String, Object> accounting
             if (map.containsKey("savingsChargesPaid")) {
                 @SuppressWarnings("unchecked")
                 final List<Map<String, Object>> savingsChargesPaidData = (List<Map<String, Object>>) map.get("savingsChargesPaid");
-                for (final Map<String, Object> loanChargePaid : savingsChargesPaidData) {
-                    final Long chargeId = (Long) loanChargePaid.get("chargeId");
-                    final Long loanChargeId = (Long) loanChargePaid.get("savingsChargeId");
-                    final boolean isPenalty = (Boolean) loanChargePaid.get("isPenalty");
-                    final BigDecimal chargeAmountPaid = (BigDecimal) loanChargePaid.get("amount");
+                for (final Map<String, Object> savingsChargesPaid : savingsChargesPaidData) {
+                    final Long chargeId = (Long) savingsChargesPaid.get("chargeId");
+                    final Long loanChargeId = (Long) savingsChargesPaid.get("savingsChargeId");
+                    final boolean isPenalty = (Boolean) savingsChargesPaid.get("isPenalty");
+                    final BigDecimal chargeAmountPaid = (BigDecimal) savingsChargesPaid.get("amount");
                     final ChargePaymentDTO chargePaymentDTO = new ChargePaymentDTO(chargeId, chargeAmountPaid, loanChargeId);
+
                     if (isPenalty) {
                         penaltyPayments.add(chargePaymentDTO);
                     } else {

diff --git a/...e/fineract/accounting/journalentry/service/AccrualBasedAccountingProcessorForSavings.java b/...e/fineract/accounting/journalentry/service/AccrualBasedAccountingProcessorForSavings.java
@@ -182,9 +182,16 @@ else if (savingsTransactionDTO.getTransactionType().isInterestPosting()) {
             else if (savingsTransactionDTO.getTransactionType().isAccrual()) {
                 // Post journal entry for Accrual Recognition
                 if (savingsTransactionDTO.getAmount().compareTo(BigDecimal.ZERO) > 0) {
-                    this.helper.createCashBasedJournalEntriesAndReversalsForSavings(office, currencyCode,
-                            AccrualAccountsForSavings.INTEREST_ON_SAVINGS.getValue(), AccrualAccountsForSavings.INTEREST_PAYABLE.getValue(),
-                            savingsProductId, paymentTypeId, savingsId, transactionId, transactionDate, amount, isReversal);
+                    if (feePayments.size() > 0 || penaltyPayments.size() > 0) {
+                        this.helper.createCashBasedJournalEntriesAndReversalsForSavings(office, currencyCode,
+                                AccrualAccountsForSavings.FEES_RECEIVABLE.getValue(), AccrualAccountsForSavings.INCOME_FROM_FEES.getValue(),
+                                savingsProductId, paymentTypeId, savingsId, transactionId, transactionDate, amount, isReversal);
+                    } else {
+                        this.helper.createCashBasedJournalEntriesAndReversalsForSavings(office, currencyCode,
+                                AccrualAccountsForSavings.INTEREST_ON_SAVINGS.getValue(),
+                                AccrualAccountsForSavings.INTEREST_PAYABLE.getValue(), savingsProductId, paymentTypeId, savingsId,
+                                transactionId, transactionDate, amount, isReversal);
+                    }
                 }
             }
 
@@ -205,35 +212,45 @@ else if (savingsTransactionDTO.getTransactionType().isFeeDeduction() && savingsT
                             savingsProductId, paymentTypeId, savingsId, transactionId, transactionDate, overdraftAmount, isReversal,
                             penaltyPayments);
                     if (isPositive) {
+                        final ChargePaymentDTO chargePaymentDTO = penaltyPayments.get(0);
+                        AccrualAccountsForSavings accountTypeToBeDebited = AccrualAccountsForSavings.SAVINGS_CONTROL;
+
                         this.helper.createAccrualBasedJournalEntriesAndReversalsForSavingsCharges(office, currencyCode,
-                                AccrualAccountsForSavings.SAVINGS_CONTROL, AccrualAccountsForSavings.INCOME_FROM_PENALTIES,
-                                savingsProductId, paymentTypeId, savingsId, transactionId, transactionDate,
-                                amount.subtract(overdraftAmount), isReversal, penaltyPayments);
+                                accountTypeToBeDebited, AccrualAccountsForSavings.INCOME_FROM_PENALTIES, savingsProductId, paymentTypeId,
+                                savingsId, transactionId, transactionDate, amount.subtract(overdraftAmount), isReversal, penaltyPayments);
                     }
                 } else {
                     this.helper.createAccrualBasedJournalEntriesAndReversalsForSavingsCharges(office, currencyCode,
                             AccrualAccountsForSavings.OVERDRAFT_PORTFOLIO_CONTROL, AccrualAccountsForSavings.INCOME_FROM_FEES,
                             savingsProductId, paymentTypeId, savingsId, transactionId, transactionDate, overdraftAmount, isReversal,
                             feePayments);
                     if (isPositive) {
+                        final ChargePaymentDTO chargePaymentDTO = feePayments.get(0);
+                        AccrualAccountsForSavings accountTypeToBeDebited = AccrualAccountsForSavings.SAVINGS_CONTROL;
+
                         this.helper.createAccrualBasedJournalEntriesAndReversalsForSavingsCharges(office, currencyCode,
-                                AccrualAccountsForSavings.SAVINGS_CONTROL, AccrualAccountsForSavings.INCOME_FROM_FEES, savingsProductId,
-                                paymentTypeId, savingsId, transactionId, transactionDate, amount.subtract(overdraftAmount), isReversal,
-                                feePayments);
+                                accountTypeToBeDebited, AccrualAccountsForSavings.INCOME_FROM_FEES, savingsProductId, paymentTypeId,
+                                savingsId, transactionId, transactionDate, amount.subtract(overdraftAmount), isReversal, feePayments);
                     }
                 }
             }
 
             else if (savingsTransactionDTO.getTransactionType().isFeeDeduction()) {
                 // Is the Charge a penalty?
                 if (penaltyPayments.size() > 0) {
+                    final ChargePaymentDTO chargePaymentDTO = penaltyPayments.get(0);
+                    AccrualAccountsForSavings accountTypeToBeCredited = AccrualAccountsForSavings.INCOME_FROM_PENALTIES;
+
                     this.helper.createAccrualBasedJournalEntriesAndReversalsForSavingsCharges(office, currencyCode,
-                            AccrualAccountsForSavings.SAVINGS_CONTROL, AccrualAccountsForSavings.INCOME_FROM_PENALTIES, savingsProductId,
-                            paymentTypeId, savingsId, transactionId, transactionDate, amount, isReversal, penaltyPayments);
+                            AccrualAccountsForSavings.SAVINGS_CONTROL, accountTypeToBeCredited, savingsProductId, paymentTypeId, savingsId,
+                            transactionId, transactionDate, amount, isReversal, penaltyPayments);
                 } else {
+                    final ChargePaymentDTO chargePaymentDTO = feePayments.get(0);
+                    AccrualAccountsForSavings accountTypeToBeCredited = AccrualAccountsForSavings.INCOME_FROM_PENALTIES;
+
                     this.helper.createAccrualBasedJournalEntriesAndReversalsForSavingsCharges(office, currencyCode,
-                            AccrualAccountsForSavings.SAVINGS_CONTROL, AccrualAccountsForSavings.INCOME_FROM_FEES, savingsProductId,
-                            paymentTypeId, savingsId, transactionId, transactionDate, amount, isReversal, feePayments);
+                            AccrualAccountsForSavings.SAVINGS_CONTROL, accountTypeToBeCredited, savingsProductId, paymentTypeId, savingsId,
+                            transactionId, transactionDate, amount, isReversal, feePayments);
                 }
             }