| /** |
| * 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.portfolio.loanaccount.domain; |
| |
| import jakarta.persistence.CascadeType; |
| import jakarta.persistence.Column; |
| import jakarta.persistence.Entity; |
| import jakarta.persistence.FetchType; |
| import jakarta.persistence.JoinColumn; |
| import jakarta.persistence.ManyToOne; |
| import jakarta.persistence.OneToMany; |
| import jakarta.persistence.Table; |
| import jakarta.persistence.UniqueConstraint; |
| import java.math.BigDecimal; |
| import java.time.LocalDate; |
| import java.util.ArrayList; |
| import java.util.Collection; |
| import java.util.HashSet; |
| import java.util.LinkedHashMap; |
| import java.util.List; |
| import java.util.Map; |
| import java.util.Set; |
| import org.apache.fineract.infrastructure.core.domain.AbstractAuditableWithUTCDateTimeCustom; |
| import org.apache.fineract.infrastructure.core.domain.ExternalId; |
| import org.apache.fineract.infrastructure.core.service.DateUtils; |
| import org.apache.fineract.organisation.monetary.data.CurrencyData; |
| import org.apache.fineract.organisation.monetary.domain.MonetaryCurrency; |
| import org.apache.fineract.organisation.monetary.domain.Money; |
| import org.apache.fineract.organisation.office.domain.Office; |
| import org.apache.fineract.portfolio.account.data.AccountTransferData; |
| import org.apache.fineract.portfolio.loanaccount.data.LoanTransactionData; |
| import org.apache.fineract.portfolio.loanaccount.data.LoanTransactionEnumData; |
| import org.apache.fineract.portfolio.loanproduct.service.LoanEnumerations; |
| import org.apache.fineract.portfolio.paymentdetail.data.PaymentDetailData; |
| import org.apache.fineract.portfolio.paymentdetail.domain.PaymentDetail; |
| |
| /** |
| * All monetary transactions against a loan are modelled through this entity. Disbursements, Repayments, Waivers, |
| * Write-off etc |
| */ |
| @Entity |
| @Table(name = "m_loan_transaction", uniqueConstraints = { @UniqueConstraint(columnNames = { "external_id" }, name = "external_id_UNIQUE") }) |
| public class LoanTransaction extends AbstractAuditableWithUTCDateTimeCustom { |
| |
| @ManyToOne(optional = false) |
| @JoinColumn(name = "loan_id", nullable = false) |
| private Loan loan; |
| |
| @ManyToOne |
| @JoinColumn(name = "office_id", nullable = false) |
| private Office office; |
| |
| @ManyToOne(optional = true) |
| @JoinColumn(name = "payment_detail_id", nullable = true) |
| private PaymentDetail paymentDetail; |
| |
| @Column(name = "transaction_type_enum", nullable = false) |
| private Integer typeOf; |
| |
| @Column(name = "transaction_date", nullable = false) |
| private LocalDate dateOf; |
| |
| @Column(name = "submitted_on_date", nullable = false) |
| private LocalDate submittedOnDate; |
| |
| @Column(name = "amount", scale = 6, precision = 19, nullable = false) |
| private BigDecimal amount; |
| |
| @Column(name = "principal_portion_derived", scale = 6, precision = 19, nullable = true) |
| private BigDecimal principalPortion; |
| |
| @Column(name = "interest_portion_derived", scale = 6, precision = 19, nullable = true) |
| private BigDecimal interestPortion; |
| |
| @Column(name = "fee_charges_portion_derived", scale = 6, precision = 19, nullable = true) |
| private BigDecimal feeChargesPortion; |
| |
| @Column(name = "penalty_charges_portion_derived", scale = 6, precision = 19, nullable = true) |
| private BigDecimal penaltyChargesPortion; |
| |
| @Column(name = "overpayment_portion_derived", scale = 6, precision = 19, nullable = true) |
| private BigDecimal overPaymentPortion; |
| |
| @Column(name = "unrecognized_income_portion", scale = 6, precision = 19, nullable = true) |
| private BigDecimal unrecognizedIncomePortion; |
| |
| @Column(name = "is_reversed", nullable = false) |
| private boolean reversed; |
| |
| @Column(name = "external_id", length = 100, nullable = true, unique = true) |
| private ExternalId externalId; |
| |
| @Column(name = "reversal_external_id", length = 100, nullable = true, unique = true) |
| private ExternalId reversalExternalId; |
| |
| @Column(name = "reversed_on_date", nullable = true) |
| private LocalDate reversedOnDate; |
| |
| @OneToMany(cascade = CascadeType.ALL, mappedBy = "loanTransaction", orphanRemoval = true, fetch = FetchType.EAGER) |
| private Set<LoanChargePaidBy> loanChargesPaid = new HashSet<>(); |
| |
| @Column(name = "outstanding_loan_balance_derived", scale = 6, precision = 19, nullable = true) |
| private BigDecimal outstandingLoanBalance; |
| |
| @Column(name = "manually_adjusted_or_reversed", nullable = false) |
| private boolean manuallyAdjustedOrReversed; |
| |
| @Column(name = "charge_refund_charge_type", length = 1, nullable = true, unique = true) |
| private String chargeRefundChargeType; |
| |
| @OneToMany(cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.LAZY, mappedBy = "loanTransaction") |
| private Set<LoanCollateralManagement> loanCollateralManagementSet = new HashSet<>(); |
| |
| @OneToMany(cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.EAGER, mappedBy = "loanTransaction") |
| private Set<LoanTransactionToRepaymentScheduleMapping> loanTransactionToRepaymentScheduleMappings = new HashSet<>(); |
| |
| @OneToMany(cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.LAZY, mappedBy = "fromTransaction") |
| private Set<LoanTransactionRelation> loanTransactionRelations = new HashSet<>(); |
| |
| protected LoanTransaction() {} |
| |
| public static LoanTransaction incomePosting(final Loan loan, final Office office, final LocalDate dateOf, final BigDecimal amount, |
| final BigDecimal interestPortion, final BigDecimal feeChargesPortion, final BigDecimal penaltyChargesPortion, |
| final ExternalId externalId) { |
| final Integer typeOf = LoanTransactionType.INCOME_POSTING.getValue(); |
| final BigDecimal principalPortion = BigDecimal.ZERO; |
| final BigDecimal overPaymentPortion = BigDecimal.ZERO; |
| final boolean reversed = false; |
| final PaymentDetail paymentDetail = null; |
| return new LoanTransaction(loan, office, typeOf, dateOf, amount, principalPortion, interestPortion, feeChargesPortion, |
| penaltyChargesPortion, overPaymentPortion, reversed, paymentDetail, externalId); |
| } |
| |
| public static LoanTransaction disbursement(final Office office, final Money amount, final PaymentDetail paymentDetail, |
| final LocalDate disbursementDate, final ExternalId externalId) { |
| return new LoanTransaction(null, office, LoanTransactionType.DISBURSEMENT, paymentDetail, amount.getAmount(), disbursementDate, |
| externalId); |
| } |
| |
| public static LoanTransaction repayment(final Office office, final Money amount, final PaymentDetail paymentDetail, |
| final LocalDate paymentDate, final ExternalId externalId) { |
| return new LoanTransaction(null, office, LoanTransactionType.REPAYMENT, paymentDetail, amount.getAmount(), paymentDate, externalId); |
| } |
| |
| public static LoanTransaction chargeback(final Loan loan, final Money amount, final PaymentDetail paymentDetail, |
| final LocalDate paymentDate, final ExternalId externalId) { |
| LoanTransaction loanTransaction = new LoanTransaction(loan, loan.getOffice(), LoanTransactionType.CHARGEBACK, paymentDetail, |
| amount.getAmount(), paymentDate, externalId); |
| loanTransaction.principalPortion = amount.getAmount(); |
| return loanTransaction; |
| } |
| |
| public static LoanTransaction repaymentType(final LoanTransactionType repaymentType, final Office office, final Money amount, |
| final PaymentDetail paymentDetail, final LocalDate paymentDate, final ExternalId externalId, |
| final String chargeRefundChargeType) { |
| return new LoanTransaction(null, office, repaymentType, paymentDetail, amount.getAmount(), paymentDate, externalId, |
| chargeRefundChargeType); |
| } |
| |
| public static LoanTransaction chargeAdjustment(final Loan loan, final BigDecimal amount, final LocalDate transactionDate, |
| final ExternalId externalId, PaymentDetail paymentDetail) { |
| return new LoanTransaction(loan, loan.getOffice(), LoanTransactionType.CHARGE_ADJUSTMENT, paymentDetail, amount, transactionDate, |
| externalId); |
| } |
| |
| public static LoanTransaction downPayment(final Office office, final Money amount, final PaymentDetail paymentDetail, |
| final LocalDate paymentDate, final ExternalId externalId) { |
| return new LoanTransaction(null, office, LoanTransactionType.DOWN_PAYMENT, paymentDetail, amount.getAmount(), paymentDate, |
| externalId); |
| } |
| |
| public void setLoanTransactionToRepaymentScheduleMappings(final Integer installmentId, final BigDecimal chargePerInstallment) { |
| for (LoanTransactionToRepaymentScheduleMapping loanTransactionToRepaymentScheduleMapping : this.loanTransactionToRepaymentScheduleMappings) { |
| final LoanRepaymentScheduleInstallment loanRepaymentScheduleInstallment = loanTransactionToRepaymentScheduleMapping |
| .getLoanRepaymentScheduleInstallment(); |
| if (loanRepaymentScheduleInstallment.getInstallmentNumber().equals(installmentId)) { |
| loanRepaymentScheduleInstallment.updateLoanRepaymentSchedule(chargePerInstallment); |
| break; |
| } |
| } |
| } |
| |
| public static LoanTransaction recoveryRepayment(final Office office, final Money amount, final PaymentDetail paymentDetail, |
| final LocalDate paymentDate, final ExternalId externalId) { |
| return new LoanTransaction(null, office, LoanTransactionType.RECOVERY_REPAYMENT, paymentDetail, amount.getAmount(), paymentDate, |
| externalId); |
| } |
| |
| public static LoanTransaction loanPayment(final Loan loan, final Office office, final Money amount, final PaymentDetail paymentDetail, |
| final LocalDate paymentDate, final ExternalId externalId, final LoanTransactionType transactionType) { |
| return new LoanTransaction(loan, office, transactionType, paymentDetail, amount.getAmount(), paymentDate, externalId); |
| } |
| |
| public static LoanTransaction repaymentAtDisbursement(final Office office, final Money amount, final PaymentDetail paymentDetail, |
| final LocalDate paymentDate, final ExternalId externalId) { |
| return new LoanTransaction(null, office, LoanTransactionType.REPAYMENT_AT_DISBURSEMENT, paymentDetail, amount.getAmount(), |
| paymentDate, externalId); |
| } |
| |
| public static LoanTransaction waiver(final Office office, final Loan loan, final Money amount, final LocalDate waiveDate, |
| final Money waived, final Money unrecognizedPortion, final ExternalId externalId) { |
| LoanTransaction loanTransaction = new LoanTransaction(loan, office, LoanTransactionType.WAIVE_INTEREST, amount.getAmount(), |
| waiveDate, externalId); |
| loanTransaction.updateInterestComponent(waived, unrecognizedPortion); |
| return loanTransaction; |
| } |
| |
| public static LoanTransaction accrueInterest(final Office office, final Loan loan, final Money amount, |
| final LocalDate interestAppliedDate, final ExternalId externalId) { |
| BigDecimal principalPortion = null; |
| BigDecimal feesPortion = null; |
| BigDecimal penaltiesPortion = null; |
| BigDecimal interestPortion = amount.getAmount(); |
| BigDecimal overPaymentPortion = null; |
| boolean reversed = false; |
| PaymentDetail paymentDetail = null; |
| return new LoanTransaction(loan, office, LoanTransactionType.ACCRUAL.getValue(), interestAppliedDate, interestPortion, |
| principalPortion, interestPortion, feesPortion, penaltiesPortion, overPaymentPortion, reversed, paymentDetail, externalId); |
| } |
| |
| public static LoanTransaction accrueTransaction(final Loan loan, final Office office, final LocalDate dateOf, final BigDecimal amount, |
| final BigDecimal interestPortion, final BigDecimal feeChargesPortion, final BigDecimal penaltyChargesPortion, |
| final ExternalId externalId) { |
| BigDecimal principalPortion = null; |
| BigDecimal overPaymentPortion = null; |
| boolean reversed = false; |
| PaymentDetail paymentDetail = null; |
| return new LoanTransaction(loan, office, LoanTransactionType.ACCRUAL.getValue(), dateOf, amount, principalPortion, interestPortion, |
| feeChargesPortion, penaltyChargesPortion, overPaymentPortion, reversed, paymentDetail, externalId); |
| } |
| |
| public static LoanTransaction initiateTransfer(final Office office, final Loan loan, final LocalDate transferDate, |
| final ExternalId externalId) { |
| return new LoanTransaction(loan, office, LoanTransactionType.INITIATE_TRANSFER.getValue(), transferDate, |
| loan.getLoanSummary().getTotalOutstanding(), loan.getLoanSummary().getTotalPrincipalOutstanding(), |
| loan.getLoanSummary().getTotalInterestOutstanding(), loan.getLoanSummary().getTotalFeeChargesOutstanding(), |
| loan.getLoanSummary().getTotalPenaltyChargesOutstanding(), null, false, null, externalId); |
| } |
| |
| public static LoanTransaction approveTransfer(final Office office, final Loan loan, final LocalDate transferDate, |
| final ExternalId externalId) { |
| return new LoanTransaction(loan, office, LoanTransactionType.APPROVE_TRANSFER.getValue(), transferDate, |
| loan.getLoanSummary().getTotalOutstanding(), loan.getLoanSummary().getTotalPrincipalOutstanding(), |
| loan.getLoanSummary().getTotalInterestOutstanding(), loan.getLoanSummary().getTotalFeeChargesOutstanding(), |
| loan.getLoanSummary().getTotalPenaltyChargesOutstanding(), null, false, null, externalId); |
| } |
| |
| public static LoanTransaction withdrawTransfer(final Office office, final Loan loan, final LocalDate transferDate, |
| final ExternalId externalId) { |
| return new LoanTransaction(loan, office, LoanTransactionType.WITHDRAW_TRANSFER.getValue(), transferDate, |
| loan.getLoanSummary().getTotalOutstanding(), loan.getLoanSummary().getTotalPrincipalOutstanding(), |
| loan.getLoanSummary().getTotalInterestOutstanding(), loan.getLoanSummary().getTotalFeeChargesOutstanding(), |
| loan.getLoanSummary().getTotalPenaltyChargesOutstanding(), null, false, null, externalId); |
| } |
| |
| public static LoanTransaction refund(final Office office, final Money amount, final PaymentDetail paymentDetail, |
| final LocalDate paymentDate, final ExternalId externalId) { |
| return new LoanTransaction(null, office, LoanTransactionType.REFUND, paymentDetail, amount.getAmount(), paymentDate, externalId); |
| } |
| |
| public static LoanTransaction copyTransactionProperties(final LoanTransaction loanTransaction) { |
| LoanTransaction newTransaction = new LoanTransaction(loanTransaction.loan, loanTransaction.office, loanTransaction.typeOf, |
| loanTransaction.dateOf, loanTransaction.amount, loanTransaction.principalPortion, loanTransaction.interestPortion, |
| loanTransaction.feeChargesPortion, loanTransaction.penaltyChargesPortion, loanTransaction.overPaymentPortion, |
| loanTransaction.reversed, loanTransaction.paymentDetail, loanTransaction.externalId); |
| |
| if (LoanTransactionType.CHARGE_PAYMENT.equals(loanTransaction.getTypeOf())) { |
| newTransaction.getLoanChargesPaid().addAll(loanTransaction.getLoanChargesPaid()); |
| } |
| return newTransaction; |
| } |
| |
| public static LoanTransaction accrueLoanCharge(final Loan loan, final Office office, final Money amount, final LocalDate applyDate, |
| final Money feeCharges, final Money penaltyCharges, final ExternalId externalId) { |
| final LoanTransaction applyCharge = new LoanTransaction(loan, office, LoanTransactionType.ACCRUAL, amount.getAmount(), applyDate, |
| externalId); |
| applyCharge.updateChargesComponents(feeCharges, penaltyCharges); |
| return applyCharge; |
| } |
| |
| public static LoanTransaction creditBalanceRefund(final Loan loan, final Office office, final Money amount, final LocalDate paymentDate, |
| final ExternalId externalId, PaymentDetail paymentDetail) { |
| return new LoanTransaction(loan, office, LoanTransactionType.CREDIT_BALANCE_REFUND.getValue(), paymentDate, amount.getAmount(), |
| null, null, null, null, amount.getAmount(), false, paymentDetail, externalId); |
| } |
| |
| public static LoanTransaction refundForActiveLoan(final Office office, final Money amount, final PaymentDetail paymentDetail, |
| final LocalDate paymentDate, final ExternalId externalId) { |
| return new LoanTransaction(null, office, LoanTransactionType.REFUND_FOR_ACTIVE_LOAN, paymentDetail, amount.getAmount(), paymentDate, |
| externalId); |
| } |
| |
| public static boolean transactionAmountsMatch(final MonetaryCurrency currency, final LoanTransaction loanTransaction, |
| final LoanTransaction newLoanTransaction) { |
| return loanTransaction.getAmount(currency).isEqualTo(newLoanTransaction.getAmount(currency)) |
| && loanTransaction.getPrincipalPortion(currency).isEqualTo(newLoanTransaction.getPrincipalPortion(currency)) |
| && loanTransaction.getInterestPortion(currency).isEqualTo(newLoanTransaction.getInterestPortion(currency)) |
| && loanTransaction.getFeeChargesPortion(currency).isEqualTo(newLoanTransaction.getFeeChargesPortion(currency)) |
| && loanTransaction.getPenaltyChargesPortion(currency).isEqualTo(newLoanTransaction.getPenaltyChargesPortion(currency)) |
| && loanTransaction.getOverPaymentPortion(currency).isEqualTo(newLoanTransaction.getOverPaymentPortion(currency)); |
| } |
| |
| public LoanTransaction(final Loan loan, final Office office, final Integer typeOf, final LocalDate dateOf, final BigDecimal amount, |
| final BigDecimal principalPortion, final BigDecimal interestPortion, final BigDecimal feeChargesPortion, |
| final BigDecimal penaltyChargesPortion, final BigDecimal overPaymentPortion, final boolean reversed, |
| final PaymentDetail paymentDetail, final ExternalId externalId) { |
| |
| this.loan = loan; |
| this.typeOf = typeOf; |
| this.dateOf = dateOf; |
| this.amount = amount; |
| this.principalPortion = principalPortion; |
| this.interestPortion = interestPortion; |
| this.feeChargesPortion = feeChargesPortion; |
| this.penaltyChargesPortion = penaltyChargesPortion; |
| this.overPaymentPortion = overPaymentPortion; |
| this.reversed = reversed; |
| this.paymentDetail = paymentDetail; |
| this.office = office; |
| this.externalId = externalId; |
| this.submittedOnDate = DateUtils.getBusinessLocalDate(); |
| } |
| |
| public static LoanTransaction waiveLoanCharge(final Loan loan, final Office office, final Money waived, final LocalDate waiveDate, |
| final Money feeChargesWaived, final Money penaltyChargesWaived, final Money unrecognizedCharge, final ExternalId externalId) { |
| final LoanTransaction waiver = new LoanTransaction(loan, office, LoanTransactionType.WAIVE_CHARGES, waived.getAmount(), waiveDate, |
| externalId); |
| waiver.updateChargesComponents(feeChargesWaived, penaltyChargesWaived, unrecognizedCharge); |
| |
| return waiver; |
| } |
| |
| public static LoanTransaction writeoff(final Loan loan, final Office office, final LocalDate writeOffDate, |
| final ExternalId externalId) { |
| return new LoanTransaction(loan, office, LoanTransactionType.WRITEOFF, null, writeOffDate, externalId); |
| } |
| |
| public static LoanTransaction chargeOff(final Loan loan, final LocalDate chargeOffDate, final ExternalId externalId) { |
| BigDecimal principalPortion = loan.getLoanSummary().getTotalPrincipalOutstanding().compareTo(BigDecimal.ZERO) != 0 |
| ? loan.getLoanSummary().getTotalPrincipalOutstanding() |
| : null; |
| BigDecimal interestPortion = loan.getLoanSummary().getTotalInterestOutstanding().compareTo(BigDecimal.ZERO) != 0 |
| ? loan.getLoanSummary().getTotalInterestOutstanding() |
| : null; |
| BigDecimal feePortion = loan.getLoanSummary().getTotalFeeChargesOutstanding().compareTo(BigDecimal.ZERO) != 0 |
| ? loan.getLoanSummary().getTotalFeeChargesOutstanding() |
| : null; |
| BigDecimal penaltyPortion = loan.getLoanSummary().getTotalPenaltyChargesOutstanding().compareTo(BigDecimal.ZERO) != 0 |
| ? loan.getLoanSummary().getTotalPenaltyChargesOutstanding() |
| : null; |
| BigDecimal totalOutstanding = loan.getLoanSummary().getTotalOutstanding(); |
| |
| return new LoanTransaction(loan, loan.getOffice(), LoanTransactionType.CHARGE_OFF.getValue(), chargeOffDate, totalOutstanding, |
| principalPortion, interestPortion, feePortion, penaltyPortion, null, false, null, externalId); |
| } |
| |
| private LoanTransaction(final Loan loan, final Office office, final LoanTransactionType type, final BigDecimal amount, |
| final LocalDate date, final ExternalId externalId) { |
| this.loan = loan; |
| this.typeOf = type.getValue(); |
| this.amount = amount; |
| this.dateOf = date; |
| this.externalId = externalId; |
| this.office = office; |
| this.submittedOnDate = DateUtils.getBusinessLocalDate(); |
| } |
| |
| private LoanTransaction(final Loan loan, final Office office, final LoanTransactionType type, final PaymentDetail paymentDetail, |
| final BigDecimal amount, final LocalDate date, final ExternalId externalId) { |
| this.loan = loan; |
| this.typeOf = type.getValue(); |
| this.paymentDetail = paymentDetail; |
| this.amount = amount; |
| this.dateOf = date; |
| this.externalId = externalId; |
| this.office = office; |
| this.submittedOnDate = DateUtils.getBusinessLocalDate(); |
| } |
| |
| private LoanTransaction(final Loan loan, final Office office, final LoanTransactionType type, final PaymentDetail paymentDetail, |
| final BigDecimal amount, final LocalDate date, final ExternalId externalId, final String chargeRefundChargeType) { |
| this.loan = loan; |
| this.typeOf = type.getValue(); |
| this.paymentDetail = paymentDetail; |
| this.amount = amount; |
| this.dateOf = date; |
| this.externalId = externalId; |
| this.office = office; |
| this.submittedOnDate = DateUtils.getBusinessLocalDate(); |
| this.chargeRefundChargeType = chargeRefundChargeType; |
| } |
| |
| public void reverse() { |
| this.loan.validateRepaymentTypeTransactionNotBeforeAChargeRefund(this, "reversed"); |
| this.reversed = true; |
| this.reversedOnDate = DateUtils.getBusinessLocalDate(); |
| this.loanTransactionToRepaymentScheduleMappings.clear(); |
| } |
| |
| public void reverse(final ExternalId reversalExternalId) { |
| this.reverse(); |
| this.reversalExternalId = reversalExternalId; |
| } |
| |
| public void resetDerivedComponents() { |
| this.principalPortion = null; |
| this.interestPortion = null; |
| this.feeChargesPortion = null; |
| this.penaltyChargesPortion = null; |
| this.overPaymentPortion = null; |
| this.outstandingLoanBalance = null; |
| } |
| |
| public void updateLoan(final Loan loan) { |
| this.loan = loan; |
| } |
| |
| /** |
| * This updates the derived fields of a loan transaction for the principal, interest and interest waived portions. |
| * |
| * This accumulates the values passed to the already existent values for each of the portions. |
| * |
| * @param principal |
| * principal |
| * @param interest |
| * interest |
| * @param feeCharges |
| * feeCharges |
| * @param penaltyCharges |
| * penaltyCharges |
| */ |
| public void updateComponents(final Money principal, final Money interest, final Money feeCharges, final Money penaltyCharges) { |
| final MonetaryCurrency currency = principal.getCurrency(); |
| this.principalPortion = defaultToNullIfZero(getPrincipalPortion(currency).plus(principal).getAmount()); |
| this.interestPortion = defaultToNullIfZero(getInterestPortion(currency).plus(interest).getAmount()); |
| updateChargesComponents(feeCharges, penaltyCharges); |
| } |
| |
| public void updateChargesComponents(final Money feeCharges, final Money penaltyCharges) { |
| final MonetaryCurrency currency = feeCharges.getCurrency(); |
| this.feeChargesPortion = defaultToNullIfZero(getFeeChargesPortion(currency).plus(feeCharges).getAmount()); |
| this.penaltyChargesPortion = defaultToNullIfZero(getPenaltyChargesPortion(currency).plus(penaltyCharges).getAmount()); |
| } |
| |
| private void updateChargesComponents(final Money feeCharges, final Money penaltyCharges, final Money unrecognizedCharges) { |
| final MonetaryCurrency currency = feeCharges.getCurrency(); |
| this.feeChargesPortion = defaultToNullIfZero(getFeeChargesPortion(currency).plus(feeCharges).getAmount()); |
| this.penaltyChargesPortion = defaultToNullIfZero(getPenaltyChargesPortion(currency).plus(penaltyCharges).getAmount()); |
| this.unrecognizedIncomePortion = defaultToNullIfZero(getUnrecognizedIncomePortion(currency).plus(unrecognizedCharges).getAmount()); |
| } |
| |
| private void updateInterestComponent(final Money interest, final Money unrecognizedInterest) { |
| final MonetaryCurrency currency = interest.getCurrency(); |
| this.interestPortion = defaultToNullIfZero(getInterestPortion(currency).plus(interest).getAmount()); |
| this.unrecognizedIncomePortion = defaultToNullIfZero(getUnrecognizedIncomePortion(currency).plus(unrecognizedInterest).getAmount()); |
| } |
| |
| public void adjustInterestComponent(final MonetaryCurrency currency) { |
| this.interestPortion = defaultToNullIfZero(getInterestPortion(currency).minus(getUnrecognizedIncomePortion(currency)).getAmount()); |
| } |
| |
| public void updateComponentsAndTotal(final Money principal, final Money interest, final Money feeCharges, final Money penaltyCharges) { |
| updateComponents(principal, interest, feeCharges, penaltyCharges); |
| |
| final MonetaryCurrency currency = principal.getCurrency(); |
| this.amount = getPrincipalPortion(currency).plus(getInterestPortion(currency)).plus(getFeeChargesPortion(currency)) |
| .plus(getPenaltyChargesPortion(currency)).getAmount(); |
| } |
| |
| public void setOverPayments(final Money overPayment) { |
| if (overPayment != null) { |
| this.overPaymentPortion = defaultToNullIfZero(overPayment.getAmount()); |
| } |
| } |
| |
| public Money getPrincipalPortion(final MonetaryCurrency currency) { |
| return Money.of(currency, this.principalPortion); |
| } |
| |
| public BigDecimal getPrincipalPortion() { |
| return this.principalPortion; |
| } |
| |
| public BigDecimal getInterestPortion() { |
| return this.interestPortion; |
| } |
| |
| public BigDecimal getPenaltyChargesPortion() { |
| return this.penaltyChargesPortion; |
| } |
| |
| public BigDecimal getFeeChargesPortion() { |
| return this.feeChargesPortion; |
| } |
| |
| public Money getInterestPortion(final MonetaryCurrency currency) { |
| return Money.of(currency, this.interestPortion); |
| } |
| |
| public Money getUnrecognizedIncomePortion(final MonetaryCurrency currency) { |
| return Money.of(currency, this.unrecognizedIncomePortion); |
| } |
| |
| public Money getFeeChargesPortion(final MonetaryCurrency currency) { |
| return Money.of(currency, this.feeChargesPortion); |
| } |
| |
| public Money getPenaltyChargesPortion(final MonetaryCurrency currency) { |
| return Money.of(currency, this.penaltyChargesPortion); |
| } |
| |
| public Money getOverPaymentPortion(final MonetaryCurrency currency) { |
| return Money.of(currency, this.overPaymentPortion); |
| } |
| |
| public Money getAmount(final MonetaryCurrency currency) { |
| return Money.of(currency, this.amount); |
| } |
| |
| public LocalDate getTransactionDate() { |
| return this.dateOf; |
| } |
| |
| public LocalDate getDateOf() { |
| return this.dateOf; |
| } |
| |
| public LoanTransactionType getTypeOf() { |
| return LoanTransactionType.fromInt(this.typeOf); |
| } |
| |
| public boolean isReversed() { |
| return this.reversed; |
| } |
| |
| public boolean isNotReversed() { |
| return !isReversed(); |
| } |
| |
| public void setReversed() { |
| this.reversed = true; |
| } |
| |
| public void setManuallyAdjustedOrReversed() { |
| this.manuallyAdjustedOrReversed = true; |
| } |
| |
| public boolean isRepaymentLikeType() { |
| return isRepayment() || isMerchantIssuedRefund() || isPayoutRefund() || isGoodwillCredit() || isChargeRefund() |
| || isChargeAdjustment() || isDownPayment(); |
| } |
| |
| public boolean isTypeAllowedForChargeback() { |
| return isRepayment() || isMerchantIssuedRefund() || isPayoutRefund() || isGoodwillCredit() || isDownPayment(); |
| } |
| |
| public boolean isRepayment() { |
| return LoanTransactionType.REPAYMENT.equals(getTypeOf()) && isNotReversed(); |
| } |
| |
| public boolean isMerchantIssuedRefund() { |
| return LoanTransactionType.MERCHANT_ISSUED_REFUND.equals(getTypeOf()) && isNotReversed(); |
| } |
| |
| public boolean isDownPayment() { |
| return LoanTransactionType.DOWN_PAYMENT.equals(getTypeOf()) && isNotReversed(); |
| } |
| |
| public boolean isPayoutRefund() { |
| return LoanTransactionType.PAYOUT_REFUND.equals(getTypeOf()) && isNotReversed(); |
| } |
| |
| public boolean isGoodwillCredit() { |
| return LoanTransactionType.GOODWILL_CREDIT.equals(getTypeOf()) && isNotReversed(); |
| } |
| |
| public boolean isChargeRefund() { |
| return LoanTransactionType.CHARGE_REFUND.equals(getTypeOf()) && isNotReversed(); |
| } |
| |
| public boolean isChargeAdjustment() { |
| return LoanTransactionType.CHARGE_ADJUSTMENT.equals(getTypeOf()) && isNotReversed(); |
| } |
| |
| public boolean isNotRepaymentLikeType() { |
| return !isRepaymentLikeType(); |
| } |
| |
| public boolean isIncomePosting() { |
| return LoanTransactionType.INCOME_POSTING.equals(getTypeOf()) && isNotReversed(); |
| } |
| |
| public boolean isNotIncomePosting() { |
| return !isIncomePosting(); |
| } |
| |
| public boolean isDisbursement() { |
| return LoanTransactionType.DISBURSEMENT.equals(getTypeOf()) && isNotReversed(); |
| } |
| |
| public boolean isRepaymentAtDisbursement() { |
| return LoanTransactionType.REPAYMENT_AT_DISBURSEMENT.equals(getTypeOf()) && isNotReversed(); |
| } |
| |
| public boolean isNotRecoveryRepayment() { |
| return !isRecoveryRepayment(); |
| } |
| |
| public boolean isRecoveryRepayment() { |
| return LoanTransactionType.RECOVERY_REPAYMENT.equals(getTypeOf()) && isNotReversed(); |
| } |
| |
| public boolean isInterestWaiver() { |
| return LoanTransactionType.WAIVE_INTEREST.equals(getTypeOf()) && isNotReversed(); |
| } |
| |
| public boolean isChargesWaiver() { |
| return LoanTransactionType.WAIVE_CHARGES.equals(getTypeOf()) && isNotReversed(); |
| } |
| |
| public boolean isNotInterestWaiver() { |
| return !isInterestWaiver(); |
| } |
| |
| public boolean isWaiver() { |
| return isInterestWaiver() || isChargesWaiver(); |
| } |
| |
| public boolean isNotWaiver() { |
| return !isInterestWaiver() && !isChargesWaiver(); |
| } |
| |
| public boolean isNotCreditBalanceRefund() { |
| return !isCreditBalanceRefund(); |
| } |
| |
| public boolean isChargePayment() { |
| return getTypeOf().isChargePayment() && isNotReversed(); |
| } |
| |
| public boolean isChargeback() { |
| return getTypeOf().isChargeback() && isNotReversed(); |
| } |
| |
| public boolean isEditable() { |
| return !(isChargeback() || isGoodwillCredit() || isPayoutRefund() || isMerchantIssuedRefund()); |
| } |
| |
| public boolean isPenaltyPayment() { |
| boolean isPenalty = false; |
| if (isChargePayment()) { |
| for (final LoanChargePaidBy chargePaidBy : this.loanChargesPaid) { |
| isPenalty = chargePaidBy.getLoanCharge().isPenaltyCharge(); |
| break; |
| } |
| } |
| return isPenalty; |
| } |
| |
| public boolean isWriteOff() { |
| return getTypeOf().isWriteOff() && isNotReversed(); |
| } |
| |
| public boolean isChargeOff() { |
| return getTypeOf().isChargeOff() && isNotReversed(); |
| } |
| |
| public boolean isReAge() { |
| return getTypeOf().isReAge() && isNotReversed(); |
| } |
| |
| public boolean isReAmortize() { |
| return getTypeOf().isReAmortize() && isNotReversed(); |
| } |
| |
| public boolean isIdentifiedBy(final Long identifier) { |
| return getId().equals(identifier); |
| } |
| |
| public boolean isBelongingToLoanOf(final Loan check) { |
| return this.loan.getId().equals(check.getId()); |
| } |
| |
| public boolean isNotBelongingToLoanOf(final Loan check) { |
| return !isBelongingToLoanOf(check); |
| } |
| |
| public boolean isNonZero() { |
| return this.amount.subtract(BigDecimal.ZERO).doubleValue() > 0; |
| } |
| |
| public boolean isGreaterThan(final Money monetaryAmount) { |
| return getAmount(monetaryAmount.getCurrency()).isGreaterThan(monetaryAmount); |
| } |
| |
| public boolean isGreaterThanZero(final MonetaryCurrency currency) { |
| return getAmount(currency).isGreaterThanZero(); |
| } |
| |
| public boolean isGreaterThanZeroAndLessThanOrEqualTo(BigDecimal totalOverpaid) { |
| return isNonZero() && this.amount.compareTo(totalOverpaid) <= 0; |
| } |
| |
| public boolean isNotZero(final MonetaryCurrency currency) { |
| return !getAmount(currency).isZero(); |
| } |
| |
| private BigDecimal defaultToNullIfZero(final BigDecimal value) { |
| BigDecimal result = value; |
| if (BigDecimal.ZERO.compareTo(value) == 0) { |
| result = null; |
| } |
| return result; |
| } |
| |
| public LoanTransactionData toData(final CurrencyData currencyData, final AccountTransferData transfer) { |
| final LoanTransactionEnumData transactionType = LoanEnumerations.transactionType(this.typeOf); |
| PaymentDetailData paymentDetailData = null; |
| if (this.paymentDetail != null) { |
| paymentDetailData = this.paymentDetail.toData(); |
| } |
| return new LoanTransactionData(getId(), this.office.getId(), this.office.getName(), transactionType, paymentDetailData, |
| currencyData, getTransactionDate(), this.amount, this.loan.getNetDisbursalAmount(), this.principalPortion, |
| this.interestPortion, this.feeChargesPortion, this.penaltyChargesPortion, this.overPaymentPortion, this.externalId, |
| transfer, null, outstandingLoanBalance, this.unrecognizedIncomePortion, this.manuallyAdjustedOrReversed, this.loan.getId(), |
| this.loan.getExternalId()); |
| } |
| |
| public Map<String, Object> toMapData(final String currencyCode) { |
| final Map<String, Object> thisTransactionData = new LinkedHashMap<>(); |
| |
| final LoanTransactionEnumData transactionType = LoanEnumerations.transactionType(this.typeOf); |
| |
| thisTransactionData.put("id", getId()); |
| thisTransactionData.put("officeId", this.office.getId()); |
| thisTransactionData.put("type", transactionType); |
| thisTransactionData.put("reversed", Boolean.valueOf(isReversed())); |
| thisTransactionData.put("date", getTransactionDate()); |
| thisTransactionData.put("currencyCode", currencyCode); |
| thisTransactionData.put("amount", this.amount); |
| thisTransactionData.put("netDisbursalAmount", this.loan.getNetDisbursalAmount()); |
| thisTransactionData.put("principalPortion", this.principalPortion); |
| thisTransactionData.put("interestPortion", this.interestPortion); |
| thisTransactionData.put("feeChargesPortion", this.feeChargesPortion); |
| thisTransactionData.put("penaltyChargesPortion", this.penaltyChargesPortion); |
| thisTransactionData.put("overPaymentPortion", this.overPaymentPortion); |
| if (transactionType.isChargeRefund()) { |
| thisTransactionData.put("chargeRefundChargeType", this.chargeRefundChargeType); |
| } |
| |
| if (this.paymentDetail != null) { |
| thisTransactionData.put("paymentTypeId", this.paymentDetail.getPaymentType().getId()); |
| } |
| |
| if (!this.loanChargesPaid.isEmpty()) { |
| final List<Map<String, Object>> loanChargesPaidData = new ArrayList<>(); |
| for (final LoanChargePaidBy chargePaidBy : this.loanChargesPaid) { |
| final Map<String, Object> loanChargePaidData = new LinkedHashMap<>(); |
| loanChargePaidData.put("chargeId", chargePaidBy.getLoanCharge().getCharge().getId()); |
| loanChargePaidData.put("isPenalty", chargePaidBy.getLoanCharge().isPenaltyCharge()); |
| loanChargePaidData.put("loanChargeId", chargePaidBy.getLoanCharge().getId()); |
| loanChargePaidData.put("amount", chargePaidBy.getAmount()); |
| |
| loanChargesPaidData.add(loanChargePaidData); |
| } |
| thisTransactionData.put("loanChargesPaid", loanChargesPaidData); |
| } |
| |
| LoanTransactionRelation loanTransactionRelation = loanTransactionRelations.stream() |
| .filter(e -> LoanTransactionRelationTypeEnum.CHARGE_ADJUSTMENT.equals(e.getRelationType())).findAny().orElse(null); |
| if (loanTransactionRelation != null) { |
| LoanCharge loanCharge = loanTransactionRelation.getToCharge(); |
| thisTransactionData.put("loanChargeData", loanCharge.toData()); |
| } |
| |
| return thisTransactionData; |
| } |
| |
| public Loan getLoan() { |
| return this.loan; |
| } |
| |
| public Set<LoanChargePaidBy> getLoanChargesPaid() { |
| return this.loanChargesPaid; |
| } |
| |
| public void setLoanChargesPaid(final Set<LoanChargePaidBy> loanChargesPaid) { |
| this.loanChargesPaid = loanChargesPaid; |
| } |
| |
| public ExternalId getExternalId() { |
| return this.externalId; |
| } |
| |
| public boolean isRefund() { |
| return LoanTransactionType.REFUND.equals(getTypeOf()) && isNotReversed(); |
| } |
| |
| public boolean isCreditBalanceRefund() { |
| return LoanTransactionType.CREDIT_BALANCE_REFUND.equals(getTypeOf()) && isNotReversed(); |
| } |
| |
| public void updateExternalId(final ExternalId externalId) { |
| this.externalId = externalId; |
| } |
| |
| public boolean isAccrual() { |
| return LoanTransactionType.ACCRUAL.equals(getTypeOf()) && isNotReversed(); |
| } |
| |
| public boolean isNonMonetaryTransaction() { |
| return isNotReversed() && (LoanTransactionType.CONTRA.equals(getTypeOf()) |
| || LoanTransactionType.MARKED_FOR_RESCHEDULING.equals(getTypeOf()) |
| || LoanTransactionType.APPROVE_TRANSFER.equals(getTypeOf()) || LoanTransactionType.INITIATE_TRANSFER.equals(getTypeOf()) |
| || LoanTransactionType.REJECT_TRANSFER.equals(getTypeOf()) || LoanTransactionType.WITHDRAW_TRANSFER.equals(getTypeOf()) |
| || LoanTransactionType.CHARGE_OFF.equals(getTypeOf())); |
| } |
| |
| public void updateOutstandingLoanBalance(BigDecimal outstandingLoanBalance) { |
| this.outstandingLoanBalance = outstandingLoanBalance; |
| } |
| |
| public boolean isNotRefundForActiveLoan() { |
| // TODO Auto-generated method stub |
| return !isRefundForActiveLoan(); |
| } |
| |
| public boolean isRefundForActiveLoan() { |
| return LoanTransactionType.REFUND_FOR_ACTIVE_LOAN.equals(getTypeOf()) && isNotReversed(); |
| } |
| |
| public boolean isManuallyAdjustedOrReversed() { |
| return this.manuallyAdjustedOrReversed; |
| } |
| |
| public boolean isNotManuallyAdjustedOrReversed() { |
| return !this.manuallyAdjustedOrReversed; |
| } |
| |
| public void manuallyAdjustedOrReversed() { |
| this.manuallyAdjustedOrReversed = true; |
| } |
| |
| public void updateLoanTransactionToRepaymentScheduleMappings(final Collection<LoanTransactionToRepaymentScheduleMapping> mappings) { |
| Collection<LoanTransactionToRepaymentScheduleMapping> retainMappings = new ArrayList<>(); |
| for (LoanTransactionToRepaymentScheduleMapping updatedrepaymentScheduleMapping : mappings) { |
| updateMapingDetail(retainMappings, updatedrepaymentScheduleMapping); |
| } |
| this.loanTransactionToRepaymentScheduleMappings.retainAll(retainMappings); |
| } |
| |
| private boolean updateMapingDetail(final Collection<LoanTransactionToRepaymentScheduleMapping> retainMappings, |
| final LoanTransactionToRepaymentScheduleMapping updatedrepaymentScheduleMapping) { |
| boolean isMappingUpdated = false; |
| for (LoanTransactionToRepaymentScheduleMapping repaymentScheduleMapping : this.loanTransactionToRepaymentScheduleMappings) { |
| if (updatedrepaymentScheduleMapping.getLoanRepaymentScheduleInstallment().getId() != null |
| && repaymentScheduleMapping.getLoanRepaymentScheduleInstallment().getDueDate() |
| .equals(updatedrepaymentScheduleMapping.getLoanRepaymentScheduleInstallment().getDueDate()) |
| && updatedrepaymentScheduleMapping.getLoanRepaymentScheduleInstallment().getId() |
| .equals(repaymentScheduleMapping.getLoanRepaymentScheduleInstallment().getId())) { |
| repaymentScheduleMapping.setComponents(updatedrepaymentScheduleMapping.getPrincipalPortion(), |
| updatedrepaymentScheduleMapping.getInterestPortion(), updatedrepaymentScheduleMapping.getFeeChargesPortion(), |
| updatedrepaymentScheduleMapping.getPenaltyChargesPortion()); |
| isMappingUpdated = true; |
| retainMappings.add(repaymentScheduleMapping); |
| break; |
| } |
| } |
| if (!isMappingUpdated) { |
| updatedrepaymentScheduleMapping.setLoanTransaction(this); |
| this.loanTransactionToRepaymentScheduleMappings.add(updatedrepaymentScheduleMapping); |
| retainMappings.add(updatedrepaymentScheduleMapping); |
| } |
| return isMappingUpdated; |
| } |
| |
| public Set<LoanTransactionToRepaymentScheduleMapping> getLoanTransactionToRepaymentScheduleMappings() { |
| return this.loanTransactionToRepaymentScheduleMappings; |
| } |
| |
| public Boolean isAllowTypeTransactionAtTheTimeOfLastUndo() { |
| return isDisbursement() || isAccrual() || isRepaymentAtDisbursement() || isRepayment(); |
| } |
| |
| public boolean isAccrualTransaction() { |
| return isAccrual(); |
| } |
| |
| public BigDecimal getOutstandingLoanBalance() { |
| return outstandingLoanBalance; |
| } |
| |
| public PaymentDetail getPaymentDetail() { |
| return this.paymentDetail; |
| } |
| |
| public boolean isPaymentTransaction() { |
| return this.isNotReversed() && !(this.isDisbursement() || this.isAccrual() || this.isRepaymentAtDisbursement() |
| || this.isNonMonetaryTransaction() || this.isIncomePosting()); |
| } |
| |
| public Set<LoanCollateralManagement> getLoanCollateralManagementSet() { |
| return this.loanCollateralManagementSet; |
| } |
| |
| public LocalDate getSubmittedOnDate() { |
| return submittedOnDate; |
| } |
| |
| public boolean hasLoanTransactionRelations() { |
| return (loanTransactionRelations != null && loanTransactionRelations.size() > 0); |
| } |
| |
| public boolean hasChargebackLoanTransactionRelations() { |
| return (loanTransactionRelations != null |
| && loanTransactionRelations.stream().anyMatch(e -> LoanTransactionRelationTypeEnum.CHARGEBACK.equals(e.getRelationType()))); |
| } |
| |
| public Set<LoanTransactionRelation> getLoanTransactionRelations() { |
| return loanTransactionRelations; |
| } |
| |
| public void copyLoanTransactionRelations(Set<LoanTransactionRelation> sourceLoanTransactionRelations) { |
| for (LoanTransactionRelation existingLoanTransactionRelation : sourceLoanTransactionRelations) { |
| loanTransactionRelations.add(new LoanTransactionRelation(this, existingLoanTransactionRelation.getToTransaction(), |
| existingLoanTransactionRelation.getToCharge(), existingLoanTransactionRelation.getRelationType())); |
| } |
| } |
| |
| public BigDecimal getAmount() { |
| return amount; |
| } |
| |
| public boolean isBefore(final LocalDate date) { |
| return DateUtils.isBefore(getTransactionDate(), date); |
| } |
| |
| public boolean isAfter(final LocalDate date) { |
| return DateUtils.isAfter(getTransactionDate(), date); |
| } |
| |
| public boolean isOn(final LocalDate date) { |
| return DateUtils.isEqual(getTransactionDate(), date); |
| } |
| |
| // TODO missing hashCode(), equals(Object obj), but probably OK as long as |
| // this is never stored in a Collection. |
| } |
