Compare commits
31
Commits
41aeb2b89a
...
dev-latest
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6be32272c1 | ||
|
|
b47a34b5ef | ||
|
|
04d1eb20f0 | ||
|
|
da1e21f2ca | ||
|
|
b1eea68b17 | ||
|
|
539f6cd0f4 | ||
|
|
0afcf059a8 | ||
|
|
2d10ec60f8 | ||
|
|
14973dfd5e | ||
|
|
f96705baa4 | ||
|
|
9d6ef18929 | ||
|
|
936e21dcf6 | ||
|
|
aceea89c5c | ||
|
|
99ef5edfd8 | ||
|
|
9df8e924a1 | ||
|
|
1fd94615a9 | ||
|
|
3d3ce92e93 | ||
|
|
1a914a3de0 | ||
|
|
6e7eb94776 | ||
|
|
a127710442 | ||
|
|
6fbc3a85a8 | ||
|
|
949f45c4cd | ||
|
|
919bfb5204 | ||
|
|
39e3fcec59 | ||
|
|
b726577031 | ||
|
|
d1e94fd6a3 | ||
|
|
b0e3c0ac8b | ||
|
|
22c4403a14 | ||
|
|
fa8e5f3f16 | ||
|
|
12fdf035ca | ||
|
|
37c961f713 |
+17
-1
@@ -157,19 +157,35 @@ public class CommandSourceService {
|
||||
}
|
||||
if ("GLACCOUNT".equalsIgnoreCase(commandSource.getEntityName())
|
||||
|| "CBSBASEINTERESTRATE".equalsIgnoreCase(commandSource.getEntityName())
|
||||
|| "LOANBASEINTERESTRATE".equalsIgnoreCase(commandSource.getEntityName())
|
||||
|| "DELINQUENCY_BUCKET".equalsIgnoreCase(commandSource.getEntityName())
|
||||
|| "DELINQUENCY_RANGE".equalsIgnoreCase(commandSource.getEntityName())
|
||||
|| "CHARGE".equalsIgnoreCase(commandSource.getEntityName())
|
||||
|| "LOANPRODUCT".equalsIgnoreCase(commandSource.getEntityName())
|
||||
|| "SAVINGSPRODUCT".equalsIgnoreCase(commandSource.getEntityName())
|
||||
|| "CURRENTPRODUCT".equalsIgnoreCase(commandSource.getEntityName())
|
||||
|| "SHAREPRODUCT".equalsIgnoreCase(commandSource.getEntityName())
|
||||
|| "FIXEDDEPOSITPRODUCT".equalsIgnoreCase(commandSource.getEntityName())
|
||||
|| "RECURRINGDEPOSITPRODUCT".equalsIgnoreCase(commandSource.getEntityName())
|
||||
|| "USER".equalsIgnoreCase(commandSource.getEntityName())
|
||||
|| "ROLE".equalsIgnoreCase(commandSource.getEntityName())) {
|
||||
|| "ROLE".equalsIgnoreCase(commandSource.getEntityName())
|
||||
|| isDdsEntity(commandSource.getEntityName())) {
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* The DDS module's maker-checker entities. A super user's DDS work goes to a checker like anyone
|
||||
* else's: DDS moves customers' money, and every such move is to be approved by a second person.
|
||||
*/
|
||||
public static boolean isDdsEntity(final String entityName) {
|
||||
return entityName != null && switch (entityName.toUpperCase()) {
|
||||
case "PARTY", "AGENT", "PARTYTRANSACTION", "DDSACCOUNTTYPE", "COMMISSIONSLAB", "DDSBATCH", "DDSCOLLECTIONENTRY" -> true;
|
||||
default -> false;
|
||||
};
|
||||
}
|
||||
|
||||
private void sanitizeJson(@NonNull CommandSource commandSource, Set<String> sanitizeKeys) {
|
||||
if (sanitizeKeys == null || sanitizeKeys.isEmpty()) {
|
||||
return;
|
||||
|
||||
+178
@@ -664,6 +664,167 @@ public class CommandWrapperBuilder {
|
||||
return this;
|
||||
}
|
||||
|
||||
public CommandWrapperBuilder createAgent() {
|
||||
this.actionName = "CREATE";
|
||||
this.entityName = "AGENT";
|
||||
this.entityId = null;
|
||||
this.href = "/dds/agents/template";
|
||||
return this;
|
||||
}
|
||||
|
||||
public CommandWrapperBuilder updateAgent(final Long agentId) {
|
||||
this.actionName = "UPDATE";
|
||||
this.entityName = "AGENT";
|
||||
this.entityId = agentId;
|
||||
this.href = "/dds/agents/" + agentId;
|
||||
return this;
|
||||
}
|
||||
|
||||
public CommandWrapperBuilder closeAgent(final Long agentId) {
|
||||
this.actionName = "CLOSE";
|
||||
this.entityName = "AGENT";
|
||||
this.entityId = agentId;
|
||||
this.href = "/dds/agents/" + agentId + "?command=close";
|
||||
return this;
|
||||
}
|
||||
|
||||
public CommandWrapperBuilder createParty() {
|
||||
this.actionName = "CREATE";
|
||||
this.entityName = "PARTY";
|
||||
this.entityId = null;
|
||||
this.href = "/dds/parties/template";
|
||||
return this;
|
||||
}
|
||||
|
||||
public CommandWrapperBuilder updateParty(final Long partyId) {
|
||||
this.actionName = "UPDATE";
|
||||
this.entityName = "PARTY";
|
||||
this.entityId = partyId;
|
||||
this.href = "/dds/parties/" + partyId;
|
||||
return this;
|
||||
}
|
||||
|
||||
public CommandWrapperBuilder closeParty(final Long partyId) {
|
||||
this.actionName = "CLOSE";
|
||||
this.entityName = "PARTY";
|
||||
this.entityId = partyId;
|
||||
this.href = "/dds/parties/" + partyId + "?command=close";
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Pays a matured DDS account out and closes it. A separate action from CLOSE because it moves
|
||||
* money, and so is worth its own permission and its own line in the audit trail.
|
||||
*/
|
||||
public CommandWrapperBuilder payOutParty(final Long partyId) {
|
||||
this.actionName = "PAYOUT";
|
||||
this.entityName = "PARTY";
|
||||
this.entityId = partyId;
|
||||
this.href = "/dds/parties/" + partyId + "?command=payout";
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Closes a DDS account before its term is up, settling the shortfall against the customer or the
|
||||
* agent. Separate from both CLOSE and PAYOUT because it is the only one of the three that changes
|
||||
* what a customer is owed, so a bank will want it approved by someone other than whoever raised it.
|
||||
*/
|
||||
public CommandWrapperBuilder prematureCloseParty(final Long partyId) {
|
||||
this.actionName = "PREMATURECLOSE";
|
||||
this.entityName = "PARTY";
|
||||
this.entityId = partyId;
|
||||
this.href = "/dds/parties/" + partyId + "?command=prematureclose";
|
||||
return this;
|
||||
}
|
||||
|
||||
public CommandWrapperBuilder prematureCloseOverrideParty(final Long partyId) {
|
||||
this.actionName = "PREMATURECLOSEOVERRIDE";
|
||||
this.entityName = "PARTY";
|
||||
this.entityId = partyId;
|
||||
this.href = "/dds/parties/" + partyId + "?command=prematurecloseoverride";
|
||||
return this;
|
||||
}
|
||||
|
||||
public CommandWrapperBuilder createDdsAccountType() {
|
||||
this.actionName = "CREATE";
|
||||
this.entityName = "DDSACCOUNTTYPE";
|
||||
this.entityId = null;
|
||||
this.href = "/dds/accounttypes/template";
|
||||
return this;
|
||||
}
|
||||
|
||||
public CommandWrapperBuilder updateDdsAccountType(final Long accountTypeId) {
|
||||
this.actionName = "UPDATE";
|
||||
this.entityName = "DDSACCOUNTTYPE";
|
||||
this.entityId = accountTypeId;
|
||||
this.href = "/dds/accounttypes/" + accountTypeId;
|
||||
return this;
|
||||
}
|
||||
|
||||
public CommandWrapperBuilder createPartyTransaction() {
|
||||
this.actionName = "CREATE";
|
||||
this.entityName = "PARTYTRANSACTION";
|
||||
this.entityId = null;
|
||||
this.href = "/dds/partytransactions/template";
|
||||
return this;
|
||||
}
|
||||
|
||||
public CommandWrapperBuilder createDdsCollectionEntries() {
|
||||
this.actionName = "CREATE";
|
||||
this.entityName = "DDSCOLLECTIONENTRY";
|
||||
this.entityId = null;
|
||||
this.href = "/dds/collectionentries/template";
|
||||
return this;
|
||||
}
|
||||
|
||||
public CommandWrapperBuilder cancelDdsCollectionEntry(final Long entryId) {
|
||||
this.actionName = "CANCEL";
|
||||
this.entityName = "DDSCOLLECTIONENTRY";
|
||||
this.entityId = entryId;
|
||||
this.href = "/dds/collectionentries/" + entryId;
|
||||
return this;
|
||||
}
|
||||
|
||||
public CommandWrapperBuilder settleDdsCollectionEntries() {
|
||||
this.actionName = "SETTLE";
|
||||
this.entityName = "DDSCOLLECTIONENTRY";
|
||||
this.entityId = null;
|
||||
this.href = "/dds/collectionentries/settle";
|
||||
return this;
|
||||
}
|
||||
|
||||
public CommandWrapperBuilder createCommissionSlabs() {
|
||||
this.actionName = "CREATE";
|
||||
this.entityName = "COMMISSIONSLAB";
|
||||
this.entityId = null;
|
||||
this.href = "/dds/commissionslabs/template";
|
||||
return this;
|
||||
}
|
||||
|
||||
public CommandWrapperBuilder updateCommissionSlab(final Long slabId) {
|
||||
this.actionName = "UPDATE";
|
||||
this.entityName = "COMMISSIONSLAB";
|
||||
this.entityId = slabId;
|
||||
this.href = "/dds/commissionslabs/" + slabId;
|
||||
return this;
|
||||
}
|
||||
|
||||
public CommandWrapperBuilder generateDdsBatchRun() {
|
||||
this.actionName = "GENERATE";
|
||||
this.entityName = "DDSBATCH";
|
||||
this.entityId = null;
|
||||
this.href = "/dds/batchruns/template";
|
||||
return this;
|
||||
}
|
||||
|
||||
public CommandWrapperBuilder postDdsBatchRun(final Long batchRunId) {
|
||||
this.actionName = "POST";
|
||||
this.entityName = "DDSBATCH";
|
||||
this.entityId = batchRunId;
|
||||
this.href = "/dds/batchruns/" + batchRunId;
|
||||
return this;
|
||||
}
|
||||
|
||||
public CommandWrapperBuilder deleteOffice(final Long officeId) {
|
||||
this.actionName = "DELETE";
|
||||
this.entityName = "OFFICE";
|
||||
@@ -2299,6 +2460,14 @@ public class CommandWrapperBuilder {
|
||||
return this;
|
||||
}
|
||||
|
||||
public CommandWrapperBuilder createLoanBaseInterestRate() {
|
||||
this.actionName = "CREATE";
|
||||
this.entityName = "LOANBASEINTERESTRATE";
|
||||
this.entityId = null;
|
||||
this.href = "/loanproducts/baseinterestrates";
|
||||
return this;
|
||||
}
|
||||
|
||||
public CommandWrapperBuilder updateFixedDepositProduct(final Long productId) {
|
||||
this.actionName = "UPDATE";
|
||||
this.entityName = "FIXEDDEPOSITPRODUCT";
|
||||
@@ -3157,6 +3326,15 @@ public class CommandWrapperBuilder {
|
||||
return this;
|
||||
}
|
||||
|
||||
public CommandWrapperBuilder extendTenureRecurringDepositAccount(final Long accountId) {
|
||||
this.actionName = "EXTENDTENURE";
|
||||
this.entityName = "RECURRINGDEPOSITACCOUNT";
|
||||
this.entityId = accountId;
|
||||
this.savingsId = accountId;
|
||||
this.href = "/recurringdepositaccounts/" + accountId + "?command=extendTenure";
|
||||
return this;
|
||||
}
|
||||
|
||||
public CommandWrapperBuilder prematureCloseRecurringDepositAccount(final Long accountId) {
|
||||
this.actionName = "PREMATURECLOSE";
|
||||
this.entityName = "RECURRINGDEPOSITACCOUNT";
|
||||
|
||||
+3
-1
@@ -123,7 +123,9 @@ public class PortfolioCommandSourceWritePlatformServiceImpl implements Portfolio
|
||||
AppUser appUser = this.context.authenticatedUser();
|
||||
String permissionCode = commandSource.getPermissionCode();
|
||||
appUser.validateHasCheckerPermissionTo(permissionCode);
|
||||
if (!configurationService.isSameMakerCheckerEnabled() && !appUser.isCheckerSuperUser()) {
|
||||
// A DDS entry is never checked by the user who made it, super user or not - see CommandSourceService.isDdsEntity.
|
||||
if (!configurationService.isSameMakerCheckerEnabled()
|
||||
&& (!appUser.isCheckerSuperUser() || CommandSourceService.isDdsEntity(commandSource.getEntityName()))) {
|
||||
AppUser maker = commandSource.getMaker();
|
||||
if (maker == null) {
|
||||
throw new UnsupportedCommandException(permissionCode, "Maker user is missing.");
|
||||
|
||||
+1
@@ -32,6 +32,7 @@ public final class GlobalConfigurationConstants {
|
||||
public static final String FORCE_PASSWORD_RESET_DAYS = "force-password-reset-days";
|
||||
public static final String GRACE_ON_PENALTY_POSTING = "grace-on-penalty-posting";
|
||||
public static final String SAVINGS_INTEREST_POSTING_CURRENT_PERIOD_END = "savings-interest-posting-current-period-end";
|
||||
public static final String FD_INTEREST_POSTING_APPROVAL = "fd-interest-posting-approval";
|
||||
public static final String FINANCIAL_YEAR_BEGINNING_MONTH = "financial-year-beginning-month";
|
||||
public static final String MIN_CLIENTS_IN_GROUP = "min-clients-in-group";
|
||||
public static final String MAX_CLIENTS_IN_GROUP = "max-clients-in-group";
|
||||
|
||||
+6
@@ -69,6 +69,12 @@ public interface ConfigurationDomainService {
|
||||
|
||||
boolean isSavingsInterestPostingAtCurrentPeriodEnd();
|
||||
|
||||
/**
|
||||
* Whether fixed deposit interest is reported and approved before it is posted, instead of being
|
||||
* posted directly by the nightly job.
|
||||
*/
|
||||
boolean isFixedDepositInterestPostingApprovalEnabled();
|
||||
|
||||
Integer retrieveFinancialYearBeginningMonth();
|
||||
|
||||
Integer retrieveMinAllowedClientsInGroup();
|
||||
|
||||
+1
@@ -505,6 +505,7 @@ public class FineractProperties {
|
||||
private FineractTransactionProcessorItemProperties heavensFamily;
|
||||
private FineractTransactionProcessorItemProperties interestPrincipalPenaltiesFees;
|
||||
private FineractTransactionProcessorItemProperties principalInterestPenaltiesFees;
|
||||
private FineractTransactionProcessorItemProperties feesPenaltiesInterestPrincipal;
|
||||
private FineractTransactionProcessorItemProperties rbiIndia;
|
||||
private FineractTransactionProcessorItemProperties duePenaltyFeeInterestPrincipalInAdvancePrincipalPenaltyFeeInterest;
|
||||
private FineractTransactionProcessorItemProperties duePenaltyInterestPrincipalFeeInAdvancePenaltyInterestPrincipalFee;
|
||||
|
||||
+4
@@ -44,6 +44,7 @@ public enum JobName {
|
||||
APPLY_KYC_EXPIRY_RESTRICTIONS("Apply KYC Expiry Restrictions"), //
|
||||
SAVINGS_DAILY_INTEREST("Savings Daily Interest Accrual And Posting"), //
|
||||
SAVINGS_INTEREST_POSTING_REPORT("Generate Savings Interest Posting Report"), //
|
||||
FD_INTEREST_POSTING_REPORT("Generate Fixed Deposit Interest Posting Report"), //
|
||||
ADD_PERIODIC_ACCRUAL_ENTRIES_FOR_LOANS_WITH_INCOME_POSTED_AS_TRANSACTIONS(
|
||||
"Add Accrual Transactions For Loans With Income Posted As Transactions"), //
|
||||
EXECUTE_REPORT_MAILING_JOBS("Execute Report Mailing Jobs"), //
|
||||
@@ -73,8 +74,11 @@ public enum JobName {
|
||||
OUTWARD_CLEARING_BATCH_SEND("CTS Outward Clearing Batch Send"), //
|
||||
CTR_REPORT_GENERATION("AML Monthly CTR Report Generation"), //
|
||||
AML_STR_WEEKLY_DIGEST("AML STR Weekly Digest"), //
|
||||
POST_DDS_INTEREST("Post DDS Interest"), //
|
||||
CLIENT_BEHAVIOUR_WINDOW("Client Behaviour Window Computation"), //
|
||||
SAVE_RBI_FORM_A_RETURN("Save RBI Form A Return"), //
|
||||
EXECUTE_RD_AUTO_DEBIT("Execute RD Auto Debit"), //
|
||||
APPLY_RD_MISSED_INSTALLMENT_PENALTY("Apply RD Missed Installment Penalty"), //
|
||||
; //
|
||||
|
||||
private final String name;
|
||||
|
||||
+99
@@ -0,0 +1,99 @@
|
||||
/**
|
||||
* 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.organisation.agent.data;
|
||||
|
||||
import java.io.Serial;
|
||||
import java.io.Serializable;
|
||||
import java.math.BigDecimal;
|
||||
import java.time.LocalDate;
|
||||
import java.time.LocalDateTime;
|
||||
import java.util.Collection;
|
||||
import lombok.Builder;
|
||||
import lombok.Getter;
|
||||
|
||||
/**
|
||||
* Immutable data object representing a DDS agent and its guarantors, following the legacy Agent
|
||||
* Master Entry screen. Built via the Lombok builder rather than a long positional constructor, as the
|
||||
* other DDS data objects are.
|
||||
*
|
||||
* The commission block below is on the legacy SubAgent Master screen rather than the Agent one, and
|
||||
* drives the commission batch.
|
||||
*/
|
||||
@Getter
|
||||
@Builder(toBuilder = true)
|
||||
public final class AgentData implements Serializable {
|
||||
|
||||
@Serial
|
||||
private static final long serialVersionUID = 1L;
|
||||
|
||||
private final Long id;
|
||||
private final Long clientId;
|
||||
private final String clientName;
|
||||
private final String agentCode;
|
||||
private final String agentNameId;
|
||||
private final String agentAddress1;
|
||||
private final String agentAddress2;
|
||||
private final String agentCity;
|
||||
private final String agentPinCode;
|
||||
private final String agentTelephone;
|
||||
private final String agentSavingAccountType;
|
||||
private final String agentSavingAccountNo;
|
||||
private final LocalDate agentOpeningDate;
|
||||
private final LocalDate agentBirthDate;
|
||||
private final BigDecimal agentCurrentBalance;
|
||||
private final BigDecimal agentOpeningBalance;
|
||||
|
||||
/**
|
||||
* The branch this agent belongs to. {@code officeId} is what the screen sends back on an edit;
|
||||
* {@code homeBranch} is that office's current name, read from the office row rather than from
|
||||
* the agent, so a renamed branch reads correctly here without the agent being touched.
|
||||
*/
|
||||
private final Long officeId;
|
||||
private final String homeBranch;
|
||||
|
||||
/**
|
||||
* The ledger account this agent's collections pass through, if the bank gave them one. The id is
|
||||
* what the screen sends back on an edit; the code and name are what it shows.
|
||||
*/
|
||||
private final Long glAccountId;
|
||||
private final String glAccountCode;
|
||||
private final String glAccountName;
|
||||
|
||||
/** Commission owed but not yet paid out, and the TDS withheld so far. Both are batch outcomes. */
|
||||
private final BigDecimal commission;
|
||||
private final BigDecimal tdsAmount;
|
||||
|
||||
/** Commission settings and the standing figures the commission run deducts. */
|
||||
private final boolean commissionCalculation;
|
||||
private final boolean tdsApplicable;
|
||||
private final BigDecimal tdsPercent;
|
||||
private final BigDecimal deductCommission;
|
||||
private final BigDecimal agentDeposit;
|
||||
private final BigDecimal festivalAdvance;
|
||||
private final BigDecimal otherDeduction;
|
||||
|
||||
private final boolean active;
|
||||
|
||||
/** When the relationship ended, or null while the agent is on the books. */
|
||||
private final LocalDate closeDate;
|
||||
|
||||
private final LocalDateTime createdDate;
|
||||
private final LocalDateTime lastModifiedDate;
|
||||
private final Collection<AgentGuarantorData> guarantors;
|
||||
}
|
||||
+59
@@ -0,0 +1,59 @@
|
||||
/**
|
||||
* 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.organisation.agent.data;
|
||||
|
||||
import java.io.Serial;
|
||||
import java.io.Serializable;
|
||||
import lombok.Getter;
|
||||
|
||||
/**
|
||||
* Immutable data object representing a single agent guarantor.
|
||||
*/
|
||||
@Getter
|
||||
public final class AgentGuarantorData implements Serializable {
|
||||
|
||||
@Serial
|
||||
private static final long serialVersionUID = 1L;
|
||||
|
||||
private final Long id;
|
||||
private final Long clientId;
|
||||
private final String guarantorName;
|
||||
private final String address1;
|
||||
private final String address2;
|
||||
private final String city;
|
||||
private final String pinCode;
|
||||
private final String telephone;
|
||||
|
||||
public static AgentGuarantorData instance(final Long id, final Long clientId, final String guarantorName, final String address1,
|
||||
final String address2, final String city, final String pinCode, final String telephone) {
|
||||
return new AgentGuarantorData(id, clientId, guarantorName, address1, address2, city, pinCode, telephone);
|
||||
}
|
||||
|
||||
private AgentGuarantorData(final Long id, final Long clientId, final String guarantorName, final String address1,
|
||||
final String address2, final String city, final String pinCode, final String telephone) {
|
||||
this.id = id;
|
||||
this.clientId = clientId;
|
||||
this.guarantorName = guarantorName;
|
||||
this.address1 = address1;
|
||||
this.address2 = address2;
|
||||
this.city = city;
|
||||
this.pinCode = pinCode;
|
||||
this.telephone = telephone;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,523 @@
|
||||
/**
|
||||
* 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.organisation.agent.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.OrderBy;
|
||||
import jakarta.persistence.Table;
|
||||
import jakarta.persistence.UniqueConstraint;
|
||||
import java.math.BigDecimal;
|
||||
import java.time.LocalDate;
|
||||
import java.util.ArrayList;
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.function.Consumer;
|
||||
import lombok.Getter;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.apache.fineract.accounting.glaccount.domain.GLAccount;
|
||||
import org.apache.fineract.infrastructure.core.api.JsonCommand;
|
||||
import org.apache.fineract.infrastructure.core.domain.AbstractAuditableCustom;
|
||||
import org.apache.fineract.organisation.office.domain.Office;
|
||||
import org.apache.fineract.portfolio.client.domain.Client;
|
||||
|
||||
/**
|
||||
* A DDS (Daily Deposit Scheme) collection agent. Can represent either a person or, at the top of the
|
||||
* hierarchy, the bank itself acting as its own agent. Holds its own settlement savings account and one
|
||||
* or more guarantors.
|
||||
*
|
||||
* The field set follows the legacy Agent Master Entry screen. SubAgent was folded into Agent
|
||||
* (2026-08-24) so the Agent now does the daily collection work directly, but the SubAgent-only fields
|
||||
* that came across with it (TDS, transfer/security accounts, machine rent, collection-limit history)
|
||||
* were on no screen the business uses and were read by no query, report or job, so they were dropped
|
||||
* again in 0481. Two fields are kept despite not appearing on that screen, because code reads them:
|
||||
* {@code commission}/{@code lastCommissionDate}, and the deduction figures the Agent Commission
|
||||
* Statement reports.
|
||||
*/
|
||||
@Getter
|
||||
@Entity
|
||||
@Table(name = "m_dds_agent", uniqueConstraints = { @UniqueConstraint(columnNames = { "agent_code" }, name = "agent_code_UNIQUE") })
|
||||
public class Agent extends AbstractAuditableCustom {
|
||||
|
||||
@ManyToOne
|
||||
@JoinColumn(name = "client_id", nullable = false)
|
||||
private Client client;
|
||||
|
||||
@Column(name = "agent_code", length = 20, nullable = false)
|
||||
private String agentCode;
|
||||
|
||||
@Column(name = "agent_name", length = 100, nullable = false)
|
||||
private String agentName;
|
||||
|
||||
@Column(name = "agent_address1", length = 200, nullable = false)
|
||||
private String agentAddress1;
|
||||
|
||||
@Column(name = "agent_address2", length = 200)
|
||||
private String agentAddress2;
|
||||
|
||||
@Column(name = "agent_city", length = 100, nullable = false)
|
||||
private String agentCity;
|
||||
|
||||
@Column(name = "agent_pincode", length = 20, nullable = false)
|
||||
private String agentPinCode;
|
||||
|
||||
@Column(name = "agent_telephone", length = 20)
|
||||
private String agentTelephone;
|
||||
|
||||
@Column(name = "agent_saving_account_type", length = 100, nullable = false)
|
||||
private String agentSavingAccountType;
|
||||
|
||||
@Column(name = "agent_saving_account_no", length = 50, nullable = false)
|
||||
private String agentSavingAccountNo;
|
||||
|
||||
@Column(name = "agent_opening_date", nullable = false)
|
||||
private LocalDate agentOpeningDate;
|
||||
|
||||
@Column(name = "agent_birth_date", nullable = false)
|
||||
private LocalDate agentBirthDate;
|
||||
|
||||
@Column(name = "agent_current_balance", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal agentCurrentBalance;
|
||||
|
||||
@Column(name = "agent_opening_balance", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal agentOpeningBalance;
|
||||
|
||||
/**
|
||||
* The branch this agent belongs to, and the thing of record for it.
|
||||
*
|
||||
* Defaults to the agent's client's office - where the person sits on the bank's books - but is
|
||||
* chosen on the screen, since an agent can be registered at one branch and collect out of
|
||||
* another.
|
||||
*/
|
||||
@ManyToOne
|
||||
@JoinColumn(name = "office_id")
|
||||
private Office office;
|
||||
|
||||
/**
|
||||
* The office's name, held alongside the office itself.
|
||||
*
|
||||
* Redundant by design: the batch job's branch filter and several reports match on this name, and
|
||||
* were written before the office link existed. It is always written from {@link #office}, never
|
||||
* on its own, so the two cannot drift apart.
|
||||
*/
|
||||
@Column(name = "home_branch", length = 100)
|
||||
private String homeBranch;
|
||||
|
||||
/**
|
||||
* The ledger account this agent's collections pass through, if the bank has given them one.
|
||||
*
|
||||
* Collections debit it on their way to the customer and settlements credit it when the cash
|
||||
* arrives, so what is left standing on it is what this agent is holding and has not brought in.
|
||||
* One agent to an account - shared, it would say nothing that the old single account did not.
|
||||
*
|
||||
* Null for the agents that predate this, and they go on using the scheme's shared agent-cash
|
||||
* account exactly as before. Nothing about the route the money takes depends on which of the
|
||||
* two it is.
|
||||
*/
|
||||
@ManyToOne
|
||||
@JoinColumn(name = "gl_account_id")
|
||||
private GLAccount glAccount;
|
||||
|
||||
/**
|
||||
* Commission earned by Commission Calculation but not yet paid out. Commission Posting pays it and
|
||||
* resets this to zero, so it reads as "owed to this agent right now" - which is what the legacy
|
||||
* SubAgent Master screen's "Comm" box shows.
|
||||
*/
|
||||
@Column(name = "commission", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal commission;
|
||||
|
||||
/** Whether Commission Calculation covers this agent at all ("Com. Calculation" on the legacy screen). */
|
||||
@Column(name = "commission_calculation", nullable = false)
|
||||
private boolean commissionCalculation;
|
||||
|
||||
/** TDS is withheld from commission at source when the bank has it switched on for this agent. */
|
||||
@Column(name = "tds_applicable", nullable = false)
|
||||
private boolean tdsApplicable;
|
||||
|
||||
@Column(name = "tds_percent", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal tdsPercent;
|
||||
|
||||
/** Running total of TDS withheld, the legacy screen's "TDS Amt". */
|
||||
@Column(name = "tds_amount", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal tdsAmount;
|
||||
|
||||
/** The four figures the Agent Commission Statement subtracts from gross commission. */
|
||||
@Column(name = "deduct_commission", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal deductCommission;
|
||||
|
||||
@Column(name = "agent_deposit", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal agentDeposit;
|
||||
|
||||
@Column(name = "festival_advance", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal festivalAdvance;
|
||||
|
||||
@Column(name = "other_deduction", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal otherDeduction;
|
||||
|
||||
@Column(name = "last_commission_date")
|
||||
private LocalDate lastCommissionDate;
|
||||
|
||||
/**
|
||||
* An agent who stops collecting is deactivated, never deleted: every party collection, settlement
|
||||
* and commission posting is recorded against it, so removing it would orphan its whole history.
|
||||
* An inactive agent stays out of the pick lists for new collection work while its record and
|
||||
* history stay intact, and it can be switched back on.
|
||||
*/
|
||||
@Column(name = "is_active", nullable = false)
|
||||
private boolean active;
|
||||
|
||||
/**
|
||||
* When the relationship ended, or null while the agent is on the books.
|
||||
*
|
||||
* Distinct from {@code active}: switching an agent off stops them collecting and has to be
|
||||
* possible immediately, whereas closing is the end of the relationship and is only allowed once
|
||||
* nothing is left hanging. A closed agent is never deleted - their whole collection history is
|
||||
* recorded against them.
|
||||
*/
|
||||
@Column(name = "close_date")
|
||||
private LocalDate closeDate;
|
||||
|
||||
@OneToMany(mappedBy = "agent", cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.LAZY)
|
||||
@OrderBy("id")
|
||||
private List<AgentGuarantor> guarantors = new ArrayList<>();
|
||||
|
||||
protected Agent() {
|
||||
//
|
||||
}
|
||||
|
||||
private Agent(final Client client, final String agentCode, final String agentName, final String agentAddress1,
|
||||
final String agentAddress2, final String agentCity, final String agentPinCode, final String agentTelephone,
|
||||
final String agentSavingAccountType, final String agentSavingAccountNo, final LocalDate agentOpeningDate,
|
||||
final LocalDate agentBirthDate, final BigDecimal agentOpeningBalance, final Office office) {
|
||||
this.client = client;
|
||||
this.agentCode = agentCode;
|
||||
this.agentName = agentName;
|
||||
this.agentAddress1 = agentAddress1;
|
||||
this.agentAddress2 = StringUtils.defaultIfEmpty(agentAddress2, null);
|
||||
this.agentCity = agentCity;
|
||||
this.agentPinCode = agentPinCode;
|
||||
this.agentTelephone = StringUtils.defaultIfEmpty(agentTelephone, null);
|
||||
this.agentSavingAccountType = agentSavingAccountType;
|
||||
this.agentSavingAccountNo = agentSavingAccountNo;
|
||||
this.agentOpeningDate = agentOpeningDate;
|
||||
this.agentBirthDate = agentBirthDate;
|
||||
this.agentOpeningBalance = agentOpeningBalance == null ? BigDecimal.ZERO : agentOpeningBalance;
|
||||
this.agentCurrentBalance = this.agentOpeningBalance;
|
||||
setOffice(office);
|
||||
this.active = true;
|
||||
|
||||
this.commission = BigDecimal.ZERO;
|
||||
// Commission is earned unless someone says otherwise, matching the legacy screen's default.
|
||||
this.commissionCalculation = true;
|
||||
this.tdsApplicable = false;
|
||||
this.tdsPercent = BigDecimal.ZERO;
|
||||
this.tdsAmount = BigDecimal.ZERO;
|
||||
this.deductCommission = BigDecimal.ZERO;
|
||||
this.agentDeposit = BigDecimal.ZERO;
|
||||
this.festivalAdvance = BigDecimal.ZERO;
|
||||
this.otherDeduction = BigDecimal.ZERO;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param office
|
||||
* the branch this agent belongs to, resolved by the caller from the command's
|
||||
* {@code officeId} or, failing that, from the client's own office.
|
||||
*/
|
||||
public static Agent fromJson(final Client client, final String agentCode, final Office office, final JsonCommand command) {
|
||||
final String agentName = command.stringValueOfParameterNamed("agentNameId");
|
||||
final String agentAddress1 = command.stringValueOfParameterNamed("agentAddress1");
|
||||
final String agentAddress2 = command.stringValueOfParameterNamedAllowingNull("agentAddress2");
|
||||
final String agentCity = command.stringValueOfParameterNamed("agentCity");
|
||||
final String agentPinCode = command.stringValueOfParameterNamed("agentPinCode");
|
||||
final String agentTelephone = command.stringValueOfParameterNamedAllowingNull("agentTelephone");
|
||||
final String agentSavingAccountType = command.stringValueOfParameterNamed("agentSavingAccountType");
|
||||
final String agentSavingAccountNo = command.stringValueOfParameterNamed("agentSavingAccountNo");
|
||||
final LocalDate agentOpeningDate = command.localDateValueOfParameterNamed("agentOpeningDate");
|
||||
final LocalDate agentBirthDate = command.localDateValueOfParameterNamed("agentBirthDate");
|
||||
final BigDecimal agentOpeningBalance = command.bigDecimalValueOfParameterNamedDefaultToNullIfZero("agentOpeningBalance");
|
||||
|
||||
return new Agent(client, agentCode, agentName, agentAddress1, agentAddress2, agentCity, agentPinCode, agentTelephone,
|
||||
agentSavingAccountType, agentSavingAccountNo, agentOpeningDate, agentBirthDate, agentOpeningBalance, office);
|
||||
}
|
||||
|
||||
public void addGuarantor(final AgentGuarantor guarantor) {
|
||||
guarantor.setAgent(this);
|
||||
this.guarantors.add(guarantor);
|
||||
}
|
||||
|
||||
public void resetGuarantors() {
|
||||
this.guarantors.clear();
|
||||
}
|
||||
|
||||
/**
|
||||
* Commission Calculation: adds what this agent earned to the amount owed to them, withholds the
|
||||
* TDS that went with it, and stamps the date commission is now calculated through - so the next
|
||||
* Commission Calculation only covers collections since then, and re-running it for the same
|
||||
* period finds nothing left to earn.
|
||||
*/
|
||||
public void accrueCommission(final BigDecimal netAmount, final BigDecimal tdsWithheld, final LocalDate throughDate) {
|
||||
this.commission = this.commission.add(netAmount);
|
||||
this.tdsAmount = this.tdsAmount.add(tdsWithheld);
|
||||
this.lastCommissionDate = throughDate;
|
||||
}
|
||||
|
||||
/**
|
||||
* Commission Posting: pays the given amount out of what is owed and returns what remains owed.
|
||||
*
|
||||
* The amount is the one the run previewed rather than whatever is owed at this moment, so what
|
||||
* gets paid is always what was seen and approved. Since it comes off the owed figure, a second
|
||||
* posting of the same commission finds nothing left to pay.
|
||||
*/
|
||||
public BigDecimal payOutCommission(final BigDecimal amount) {
|
||||
this.commission = this.commission.subtract(amount);
|
||||
return this.commission;
|
||||
}
|
||||
|
||||
/**
|
||||
* Charges the agent for an account of theirs that was closed before its term was up.
|
||||
*
|
||||
* Booked against {@code deductCommission} rather than taken straight off {@code commission},
|
||||
* because what is owed at this moment may be nothing - commission is paid out in runs, and an
|
||||
* agent who was paid yesterday would otherwise escape the charge entirely. Held as a deduction it
|
||||
* is carried until there is commission to take it from, and it shows on the Agent Commission
|
||||
* Statement between gross and take-home, where an agent can see what was charged and why.
|
||||
*/
|
||||
public BigDecimal chargePrematureClosure(final BigDecimal amount) {
|
||||
if (amount == null || amount.compareTo(BigDecimal.ZERO) <= 0) {
|
||||
return this.deductCommission;
|
||||
}
|
||||
this.deductCommission = this.deductCommission.add(amount);
|
||||
return this.deductCommission;
|
||||
}
|
||||
|
||||
/**
|
||||
* The four figures the Agent Commission Statement subtracts between gross commission and the
|
||||
* agent's take-home total. They are standing amounts on the agent, not per-run ones, so a run
|
||||
* deducts whatever they hold when it is calculated.
|
||||
*/
|
||||
public BigDecimal totalDeductions() {
|
||||
return this.deductCommission.add(this.agentDeposit).add(this.festivalAdvance).add(this.otherDeduction);
|
||||
}
|
||||
|
||||
public boolean isClosed() {
|
||||
return this.closeDate != null;
|
||||
}
|
||||
|
||||
/** Cash collected from customers that has not yet reached a branch. */
|
||||
public boolean holdsCash() {
|
||||
return this.agentCurrentBalance.compareTo(BigDecimal.ZERO) != 0;
|
||||
}
|
||||
|
||||
/** Commission earned but not yet paid out. */
|
||||
public boolean isOwedCommission() {
|
||||
return this.commission.compareTo(BigDecimal.ZERO) != 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Ends the relationship. The caller checks first that no accounts are still assigned; the two
|
||||
* money conditions are checked here, where the figures live.
|
||||
*
|
||||
* Closing also switches the agent off, since an agent who is no longer on the books cannot be
|
||||
* collecting either.
|
||||
*/
|
||||
public void close(final LocalDate closeDate) {
|
||||
this.closeDate = closeDate;
|
||||
this.active = false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Cash this agent has collected from parties but not yet handed over to a branch (an Agent Tran
|
||||
* settlement). Raised by a Party Tran collection, lowered by an Agent Tran settlement.
|
||||
*/
|
||||
public BigDecimal credit(final BigDecimal amount) {
|
||||
this.agentCurrentBalance = this.agentCurrentBalance.add(amount);
|
||||
return this.agentCurrentBalance;
|
||||
}
|
||||
|
||||
public BigDecimal settle(final BigDecimal amount) {
|
||||
this.agentCurrentBalance = this.agentCurrentBalance.subtract(amount);
|
||||
return this.agentCurrentBalance;
|
||||
}
|
||||
|
||||
public void changeClient(final Client newClient) {
|
||||
this.client = newClient;
|
||||
}
|
||||
|
||||
/**
|
||||
* Moves the agent to a branch, writing the office's name into {@code homeBranch} in the same
|
||||
* step so the name never has to be set by hand and never lags behind the office.
|
||||
*/
|
||||
public void setOffice(final Office office) {
|
||||
this.office = office;
|
||||
this.homeBranch = office == null ? null : StringUtils.defaultIfEmpty(office.getName(), null);
|
||||
}
|
||||
|
||||
public Long officeId() {
|
||||
return this.office == null ? null : this.office.getId();
|
||||
}
|
||||
|
||||
/**
|
||||
* Points this agent's collections at a ledger account, or back at the scheme's shared one.
|
||||
*
|
||||
* Whether the account may be used at all - that it exists, is an asset account, is not disabled,
|
||||
* and is not already another agent's - is settled before this is called. By the time the agent
|
||||
* holds it, the question is closed.
|
||||
*/
|
||||
public void setGlAccount(final GLAccount glAccount) {
|
||||
this.glAccount = glAccount;
|
||||
}
|
||||
|
||||
public Long glAccountId() {
|
||||
return this.glAccount == null ? null : this.glAccount.getId();
|
||||
}
|
||||
|
||||
public Long clientId() {
|
||||
return this.client.getId();
|
||||
}
|
||||
|
||||
public Map<String, Object> update(final JsonCommand command) {
|
||||
|
||||
final Map<String, Object> actualChanges = new LinkedHashMap<>(10);
|
||||
|
||||
if (command.isChangeInLongParameterNamed("clientId", this.client.getId())) {
|
||||
actualChanges.put("clientId", command.longValueOfParameterNamed("clientId"));
|
||||
}
|
||||
|
||||
if (command.isChangeInStringParameterNamed("agentNameId", this.agentName)) {
|
||||
final String newValue = command.stringValueOfParameterNamed("agentNameId");
|
||||
actualChanges.put("agentNameId", newValue);
|
||||
this.agentName = newValue;
|
||||
}
|
||||
|
||||
if (command.isChangeInStringParameterNamed("agentAddress1", this.agentAddress1)) {
|
||||
final String newValue = command.stringValueOfParameterNamed("agentAddress1");
|
||||
actualChanges.put("agentAddress1", newValue);
|
||||
this.agentAddress1 = newValue;
|
||||
}
|
||||
|
||||
if (command.isChangeInStringParameterNamed("agentAddress2", this.agentAddress2)) {
|
||||
final String newValue = command.stringValueOfParameterNamed("agentAddress2");
|
||||
actualChanges.put("agentAddress2", newValue);
|
||||
this.agentAddress2 = StringUtils.defaultIfEmpty(newValue, null);
|
||||
}
|
||||
|
||||
if (command.isChangeInStringParameterNamed("agentCity", this.agentCity)) {
|
||||
final String newValue = command.stringValueOfParameterNamed("agentCity");
|
||||
actualChanges.put("agentCity", newValue);
|
||||
this.agentCity = newValue;
|
||||
}
|
||||
|
||||
if (command.isChangeInStringParameterNamed("agentPinCode", this.agentPinCode)) {
|
||||
final String newValue = command.stringValueOfParameterNamed("agentPinCode");
|
||||
actualChanges.put("agentPinCode", newValue);
|
||||
this.agentPinCode = newValue;
|
||||
}
|
||||
|
||||
if (command.isChangeInStringParameterNamed("agentTelephone", this.agentTelephone)) {
|
||||
final String newValue = command.stringValueOfParameterNamed("agentTelephone");
|
||||
actualChanges.put("agentTelephone", newValue);
|
||||
this.agentTelephone = StringUtils.defaultIfEmpty(newValue, null);
|
||||
}
|
||||
|
||||
if (command.isChangeInStringParameterNamed("agentSavingAccountType", this.agentSavingAccountType)) {
|
||||
final String newValue = command.stringValueOfParameterNamed("agentSavingAccountType");
|
||||
actualChanges.put("agentSavingAccountType", newValue);
|
||||
this.agentSavingAccountType = newValue;
|
||||
}
|
||||
|
||||
if (command.isChangeInStringParameterNamed("agentSavingAccountNo", this.agentSavingAccountNo)) {
|
||||
final String newValue = command.stringValueOfParameterNamed("agentSavingAccountNo");
|
||||
actualChanges.put("agentSavingAccountNo", newValue);
|
||||
this.agentSavingAccountNo = newValue;
|
||||
}
|
||||
|
||||
if (command.isChangeInDateParameterNamed("agentOpeningDate", this.agentOpeningDate)) {
|
||||
actualChanges.put("agentOpeningDate", command.stringValueOfParameterNamed("agentOpeningDate"));
|
||||
this.agentOpeningDate = command.localDateValueOfParameterNamed("agentOpeningDate");
|
||||
}
|
||||
|
||||
if (command.isChangeInDateParameterNamed("agentBirthDate", this.agentBirthDate)) {
|
||||
actualChanges.put("agentBirthDate", command.stringValueOfParameterNamed("agentBirthDate"));
|
||||
this.agentBirthDate = command.localDateValueOfParameterNamed("agentBirthDate");
|
||||
}
|
||||
|
||||
if (command.isChangeInBigDecimalParameterNamed("agentOpeningBalance", this.agentOpeningBalance)) {
|
||||
final BigDecimal newValue = command.bigDecimalValueOfParameterNamed("agentOpeningBalance");
|
||||
actualChanges.put("agentOpeningBalance", newValue);
|
||||
// The current balance is the opening balance plus collections less settlements, so
|
||||
// correcting the opening figure has to move the current one by the same amount.
|
||||
// Setting it alone would leave the two contradicting each other for good, since nothing
|
||||
// else ever recomputes the current balance from scratch.
|
||||
this.agentCurrentBalance = this.agentCurrentBalance.add(newValue.subtract(this.agentOpeningBalance));
|
||||
this.agentOpeningBalance = newValue;
|
||||
actualChanges.put("agentCurrentBalance", this.agentCurrentBalance);
|
||||
}
|
||||
|
||||
if (command.isChangeInBooleanParameterNamed("active", this.active)) {
|
||||
final boolean newValue = command.booleanPrimitiveValueOfParameterNamed("active");
|
||||
actualChanges.put("active", newValue);
|
||||
this.active = newValue;
|
||||
}
|
||||
|
||||
// Commission settings and the standing deductions. The running totals the batch maintains -
|
||||
// `commission` and `tdsAmount` - are deliberately not editable here: they are the outcome of
|
||||
// posted runs, and typing over them would put the agent's balance out of step with the runs
|
||||
// that produced it.
|
||||
if (command.isChangeInBooleanParameterNamed("commissionCalculation", this.commissionCalculation)) {
|
||||
final boolean newValue = command.booleanPrimitiveValueOfParameterNamed("commissionCalculation");
|
||||
actualChanges.put("commissionCalculation", newValue);
|
||||
this.commissionCalculation = newValue;
|
||||
}
|
||||
|
||||
if (command.isChangeInBooleanParameterNamed("tdsApplicable", this.tdsApplicable)) {
|
||||
final boolean newValue = command.booleanPrimitiveValueOfParameterNamed("tdsApplicable");
|
||||
actualChanges.put("tdsApplicable", newValue);
|
||||
this.tdsApplicable = newValue;
|
||||
}
|
||||
|
||||
decimalChange(command, actualChanges, "tdsPercent", this.tdsPercent, v -> this.tdsPercent = v);
|
||||
decimalChange(command, actualChanges, "deductCommission", this.deductCommission, v -> this.deductCommission = v);
|
||||
decimalChange(command, actualChanges, "agentDeposit", this.agentDeposit, v -> this.agentDeposit = v);
|
||||
decimalChange(command, actualChanges, "festivalAdvance", this.festivalAdvance, v -> this.festivalAdvance = v);
|
||||
decimalChange(command, actualChanges, "otherDeduction", this.otherDeduction, v -> this.otherDeduction = v);
|
||||
|
||||
// A rate means nothing while TDS is switched off, so it is not left behind to be applied by a
|
||||
// later switch-on nobody connected to it.
|
||||
if (!this.tdsApplicable) {
|
||||
this.tdsPercent = BigDecimal.ZERO;
|
||||
}
|
||||
|
||||
return actualChanges;
|
||||
}
|
||||
|
||||
private void decimalChange(final JsonCommand command, final Map<String, Object> actualChanges, final String paramName,
|
||||
final BigDecimal existingValue, final Consumer<BigDecimal> setter) {
|
||||
if (command.isChangeInBigDecimalParameterNamed(paramName, existingValue)) {
|
||||
final BigDecimal newValue = command.bigDecimalValueOfParameterNamed(paramName);
|
||||
actualChanges.put(paramName, newValue);
|
||||
setter.accept(newValue == null ? BigDecimal.ZERO : newValue);
|
||||
}
|
||||
}
|
||||
}
|
||||
+87
@@ -0,0 +1,87 @@
|
||||
/**
|
||||
* 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.organisation.agent.domain;
|
||||
|
||||
import jakarta.persistence.Column;
|
||||
import jakarta.persistence.Entity;
|
||||
import jakarta.persistence.JoinColumn;
|
||||
import jakarta.persistence.ManyToOne;
|
||||
import jakarta.persistence.Table;
|
||||
import lombok.Getter;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.apache.fineract.infrastructure.core.domain.AbstractAuditableCustom;
|
||||
|
||||
/**
|
||||
* A single guarantor recorded against an {@link Agent} (or, reused with the same shape, against a
|
||||
* SubAgent). Always created/replaced as part of its parent agent's own create/update command - it has
|
||||
* no independent API of its own.
|
||||
*
|
||||
* Audited in its own right even so: a guarantor is who the bank goes to if an agent's collections go
|
||||
* missing, and a timestamp on the agent saying something changed does not say that the person
|
||||
* standing behind them was swapped, nor by whom.
|
||||
*/
|
||||
@Getter
|
||||
@Entity
|
||||
@Table(name = "m_dds_agent_guarantor")
|
||||
public class AgentGuarantor extends AbstractAuditableCustom {
|
||||
|
||||
@ManyToOne
|
||||
@JoinColumn(name = "agent_id", nullable = false)
|
||||
private Agent agent;
|
||||
|
||||
@Column(name = "client_id", nullable = false)
|
||||
private Long clientId;
|
||||
|
||||
@Column(name = "guarantor_name", length = 100, nullable = false)
|
||||
private String guarantorName;
|
||||
|
||||
@Column(name = "address1", length = 200, nullable = false)
|
||||
private String address1;
|
||||
|
||||
@Column(name = "address2", length = 200)
|
||||
private String address2;
|
||||
|
||||
@Column(name = "city", length = 100, nullable = false)
|
||||
private String city;
|
||||
|
||||
@Column(name = "pin_code", length = 20, nullable = false)
|
||||
private String pinCode;
|
||||
|
||||
@Column(name = "telephone", length = 20)
|
||||
private String telephone;
|
||||
|
||||
protected AgentGuarantor() {
|
||||
//
|
||||
}
|
||||
|
||||
public AgentGuarantor(final Long clientId, final String guarantorName, final String address1, final String address2,
|
||||
final String city, final String pinCode, final String telephone) {
|
||||
this.clientId = clientId;
|
||||
this.guarantorName = guarantorName;
|
||||
this.address1 = address1;
|
||||
this.address2 = StringUtils.defaultIfEmpty(address2, null);
|
||||
this.city = city;
|
||||
this.pinCode = pinCode;
|
||||
this.telephone = StringUtils.defaultIfEmpty(telephone, null);
|
||||
}
|
||||
|
||||
void setAgent(final Agent agent) {
|
||||
this.agent = agent;
|
||||
}
|
||||
}
|
||||
+39
@@ -0,0 +1,39 @@
|
||||
/**
|
||||
* 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.organisation.agent.exception;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformDomainRuleException;
|
||||
|
||||
/**
|
||||
* Thrown when an agent is closed while their books are not square.
|
||||
*
|
||||
* Closing is the end of the relationship, so it is refused until nothing is left hanging: no accounts
|
||||
* still being collected from, no cash held that has not reached a branch, and no commission earned but
|
||||
* unpaid. Each of those is money or a customer that would be left with no one responsible for it.
|
||||
*
|
||||
* Deactivating is deliberately not guarded this way. Switching an agent off has to be possible the
|
||||
* moment the bank decides it - if it waited for the books to be squared, an agent the bank wanted
|
||||
* stopped would keep collecting while the paperwork caught up.
|
||||
*/
|
||||
public class AgentCannotBeClosedException extends AbstractPlatformDomainRuleException {
|
||||
|
||||
public AgentCannotBeClosedException(final String agentCode, final String reason) {
|
||||
super("error.msg.dds.agent.cannot.be.closed", "Agent " + agentCode + " cannot be closed: " + reason, agentCode, reason);
|
||||
}
|
||||
}
|
||||
+32
@@ -0,0 +1,32 @@
|
||||
/**
|
||||
* 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.organisation.agent.exception;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformDomainRuleException;
|
||||
|
||||
/**
|
||||
* Thrown when an agent is listed as one of its own guarantors - a guarantee is only worth something
|
||||
* coming from someone other than the agent it backs.
|
||||
*/
|
||||
public class AgentCannotGuaranteeItselfException extends AbstractPlatformDomainRuleException {
|
||||
|
||||
public AgentCannotGuaranteeItselfException(final Long clientId) {
|
||||
super("error.msg.agent.cannot.guarantee.itself", "An agent cannot be its own guarantor", clientId);
|
||||
}
|
||||
}
|
||||
+37
@@ -0,0 +1,37 @@
|
||||
/**
|
||||
* 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.organisation.agent.exception;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformDomainRuleException;
|
||||
|
||||
/**
|
||||
* Thrown when a commission run cannot pay an agent because their account will not take the credit.
|
||||
*
|
||||
* The account is checked when it is chosen, so reaching this means something changed afterwards -
|
||||
* most likely the account was closed. Failing here rolls the whole run back rather than paying the
|
||||
* other agents and leaving this one silently unpaid: a commission run that has half happened is
|
||||
* worse to unpick than one that has not happened at all.
|
||||
*/
|
||||
public class AgentCommissionAccountUnusableException extends AbstractPlatformDomainRuleException {
|
||||
|
||||
public AgentCommissionAccountUnusableException(final String agentCode, final String reason) {
|
||||
super("error.msg.dds.agent.commission.account.unusable",
|
||||
"Commission for agent " + agentCode + " could not be paid: " + reason + ".", agentCode, reason);
|
||||
}
|
||||
}
|
||||
+38
@@ -0,0 +1,38 @@
|
||||
/**
|
||||
* 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.organisation.agent.exception;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformDomainRuleException;
|
||||
|
||||
/**
|
||||
* Thrown when the ledger account named for an agent could not carry that agent's cash.
|
||||
*
|
||||
* Refused when it is chosen rather than when it is first posted to. An account that cannot take the
|
||||
* entry fails the whole collection, at the counter, with a customer waiting - and the person who
|
||||
* picked it is not the person who finds out.
|
||||
*/
|
||||
public class AgentGlAccountUnusableException extends AbstractPlatformDomainRuleException {
|
||||
|
||||
public AgentGlAccountUnusableException(final String glCode, final String reason) {
|
||||
super("error.msg.dds.agent.gl.account.unusable",
|
||||
"Ledger account " + glCode + " cannot be used for this agent: " + reason
|
||||
+ ". Choose a detail asset account that no other agent already holds.",
|
||||
glCode, reason);
|
||||
}
|
||||
}
|
||||
+40
@@ -0,0 +1,40 @@
|
||||
/**
|
||||
* 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.organisation.agent.exception;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformResourceNotFoundException;
|
||||
import org.springframework.dao.EmptyResultDataAccessException;
|
||||
|
||||
/**
|
||||
* A {@link RuntimeException} thrown when a DDS agent resource is not found.
|
||||
*/
|
||||
public class AgentNotFoundException extends AbstractPlatformResourceNotFoundException {
|
||||
|
||||
public AgentNotFoundException(final Long id) {
|
||||
super("error.msg.agent.id.invalid", "Agent with identifier " + id + " does not exist", id);
|
||||
}
|
||||
|
||||
public AgentNotFoundException(final Long id, final EmptyResultDataAccessException e) {
|
||||
super("error.msg.agent.id.invalid", "Agent with identifier " + id + " does not exist", id, e);
|
||||
}
|
||||
|
||||
public AgentNotFoundException(final String agentCode) {
|
||||
super("error.msg.agent.code.invalid", "Agent with code " + agentCode + " does not exist", agentCode);
|
||||
}
|
||||
}
|
||||
+38
@@ -0,0 +1,38 @@
|
||||
/**
|
||||
* 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.organisation.agent.exception;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformDomainRuleException;
|
||||
|
||||
/**
|
||||
* Thrown when an agent is given a savings account that belongs to somebody else.
|
||||
*
|
||||
* An agent's commission is their own earnings, so it is paid into their own account. Accepting
|
||||
* another person's account number here would route one person's pay into another's balance - a
|
||||
* mistake that reads as ordinary data entry and would only surface when the person who should have
|
||||
* been paid asked where their money went.
|
||||
*/
|
||||
public class AgentSavingsAccountClientMismatchException extends AbstractPlatformDomainRuleException {
|
||||
|
||||
public AgentSavingsAccountClientMismatchException(final String accountNo) {
|
||||
super("error.msg.dds.agent.savings.account.client.mismatch",
|
||||
"Savings account " + accountNo + " belongs to a different client. An agent's commission is paid into their own account.",
|
||||
accountNo);
|
||||
}
|
||||
}
|
||||
+36
@@ -0,0 +1,36 @@
|
||||
/**
|
||||
* 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.organisation.agent.exception;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformDomainRuleException;
|
||||
|
||||
/**
|
||||
* Thrown when an agent is given a savings account number that no open account carries.
|
||||
*
|
||||
* The agent's commission is paid into this account, so a number that exists only as typed text means
|
||||
* a payment with nowhere to land - and nothing downstream would catch it, because the commission run
|
||||
* records what it paid, not whether the account it named was real.
|
||||
*/
|
||||
public class AgentSavingsAccountNotFoundException extends AbstractPlatformDomainRuleException {
|
||||
|
||||
public AgentSavingsAccountNotFoundException(final String accountNo) {
|
||||
super("error.msg.dds.agent.savings.account.not.found",
|
||||
"No open savings account has the number " + accountNo + ". Pick one of the client's own accounts.", accountNo);
|
||||
}
|
||||
}
|
||||
+41
@@ -0,0 +1,41 @@
|
||||
/**
|
||||
* 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.organisation.agent.exception;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformDomainRuleException;
|
||||
|
||||
/**
|
||||
* Thrown when an agent's commission account is a fixed or recurring deposit rather than a savings
|
||||
* account.
|
||||
*
|
||||
* Commission is paid in as a credit whenever a commission run posts. A savings account takes credits
|
||||
* at any time; a fixed deposit is a single sum placed for a term, and a recurring deposit takes only
|
||||
* its own scheduled instalments - so paying into either is not a thing a bank does, and the posting
|
||||
* would fail when the run came round. Refusing it as the account is chosen puts the error in front
|
||||
* of the officer who can fix it, rather than in a batch log weeks later.
|
||||
*/
|
||||
public class AgentSavingsAccountNotOperativeException extends AbstractPlatformDomainRuleException {
|
||||
|
||||
public AgentSavingsAccountNotOperativeException(final String accountNo, final String accountKind) {
|
||||
super("error.msg.dds.agent.savings.account.not.operative",
|
||||
"Account " + accountNo + " is a " + accountKind + " account. Commission has to be paid into an ordinary savings "
|
||||
+ "account, so pick one of the client's own - not a deposit and not a DDS scheme account.",
|
||||
accountNo, accountKind);
|
||||
}
|
||||
}
|
||||
+39
@@ -0,0 +1,39 @@
|
||||
/**
|
||||
* 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.organisation.commissionslab.data;
|
||||
|
||||
import java.io.Serial;
|
||||
import java.io.Serializable;
|
||||
import java.math.BigDecimal;
|
||||
import lombok.Builder;
|
||||
import lombok.Getter;
|
||||
|
||||
@Getter
|
||||
@Builder
|
||||
public final class CommissionSlabData implements Serializable {
|
||||
|
||||
@Serial
|
||||
private static final long serialVersionUID = 1L;
|
||||
|
||||
private final Long id;
|
||||
private final String slabType;
|
||||
private final BigDecimal slabFrom;
|
||||
private final BigDecimal slabTo;
|
||||
private final BigDecimal commissionPercent;
|
||||
}
|
||||
+98
@@ -0,0 +1,98 @@
|
||||
/**
|
||||
* 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.organisation.commissionslab.domain;
|
||||
|
||||
import jakarta.persistence.Column;
|
||||
import jakarta.persistence.Entity;
|
||||
import jakarta.persistence.Table;
|
||||
import java.math.BigDecimal;
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.Map;
|
||||
import lombok.Getter;
|
||||
import org.apache.fineract.infrastructure.core.api.JsonCommand;
|
||||
import org.apache.fineract.infrastructure.core.domain.AbstractAuditableCustom;
|
||||
|
||||
/**
|
||||
* One row of the agent commission chart: an ACCOUNT slab (commission percentage on collection
|
||||
* volume) or a COMMISSION slab (the override a senior agent earns on a sub-agent's commission).
|
||||
* Reference data, not history: a slab says what an agent earns on a given collection volume, and the
|
||||
* commission run reads whatever the chart says at the time it runs. A mistyped range or percentage
|
||||
* therefore has to be correctable - the legacy screen offered an edit on every saved row - so a slab
|
||||
* can be updated. It still cannot be deleted: removing a range silently pays nothing to any agent who
|
||||
* lands in it, which reads as a system fault rather than a decision.
|
||||
*/
|
||||
@Getter
|
||||
@Entity
|
||||
@Table(name = "m_dds_commission_slab")
|
||||
public class CommissionSlab extends AbstractAuditableCustom {
|
||||
|
||||
@Column(name = "slab_type", length = 20, nullable = false)
|
||||
private String slabType;
|
||||
|
||||
@Column(name = "slab_from", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal slabFrom;
|
||||
|
||||
@Column(name = "slab_to", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal slabTo;
|
||||
|
||||
@Column(name = "commission_percent", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal commissionPercent;
|
||||
|
||||
protected CommissionSlab() {
|
||||
//
|
||||
}
|
||||
|
||||
public CommissionSlab(final String slabType, final BigDecimal slabFrom, final BigDecimal slabTo, final BigDecimal commissionPercent) {
|
||||
this.slabType = slabType;
|
||||
this.slabFrom = slabFrom;
|
||||
this.slabTo = slabTo;
|
||||
this.commissionPercent = commissionPercent;
|
||||
}
|
||||
|
||||
/**
|
||||
* Corrects this slab, reporting only what actually changed so the audit trail records the
|
||||
* correction rather than a wholesale rewrite.
|
||||
*/
|
||||
public Map<String, Object> update(final JsonCommand command) {
|
||||
final Map<String, Object> actualChanges = new LinkedHashMap<>(4);
|
||||
|
||||
if (command.isChangeInStringParameterNamed("slabType", this.slabType)) {
|
||||
final String newValue = command.stringValueOfParameterNamed("slabType");
|
||||
actualChanges.put("slabType", newValue);
|
||||
this.slabType = newValue;
|
||||
}
|
||||
if (command.isChangeInBigDecimalParameterNamed("slabFrom", this.slabFrom)) {
|
||||
final BigDecimal newValue = command.bigDecimalValueOfParameterNamed("slabFrom");
|
||||
actualChanges.put("slabFrom", newValue);
|
||||
this.slabFrom = newValue;
|
||||
}
|
||||
if (command.isChangeInBigDecimalParameterNamed("slabTo", this.slabTo)) {
|
||||
final BigDecimal newValue = command.bigDecimalValueOfParameterNamed("slabTo");
|
||||
actualChanges.put("slabTo", newValue);
|
||||
this.slabTo = newValue;
|
||||
}
|
||||
if (command.isChangeInBigDecimalParameterNamed("commissionPercent", this.commissionPercent)) {
|
||||
final BigDecimal newValue = command.bigDecimalValueOfParameterNamed("commissionPercent");
|
||||
actualChanges.put("commissionPercent", newValue);
|
||||
this.commissionPercent = newValue;
|
||||
}
|
||||
|
||||
return actualChanges;
|
||||
}
|
||||
}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
/**
|
||||
* 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.organisation.commissionslab.exception;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformResourceNotFoundException;
|
||||
|
||||
/**
|
||||
* Thrown when a commission slab being corrected no longer exists.
|
||||
*/
|
||||
public class CommissionSlabNotFoundException extends AbstractPlatformResourceNotFoundException {
|
||||
|
||||
public CommissionSlabNotFoundException(final Long slabId) {
|
||||
super("error.msg.commissionslab.id.invalid", "Commission slab with identifier " + slabId + " does not exist", slabId);
|
||||
}
|
||||
}
|
||||
+42
@@ -0,0 +1,42 @@
|
||||
/**
|
||||
* 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.organisation.commissionslab.exception;
|
||||
|
||||
import java.math.BigDecimal;
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformDomainRuleException;
|
||||
|
||||
/**
|
||||
* Thrown when a commission slab's range overlaps one that already covers part of it.
|
||||
*
|
||||
* The commission run picks the first slab whose range contains the agent's collection volume, so
|
||||
* two slabs covering the same figure make the rate that gets applied a matter of which row the
|
||||
* database returns first. The same agent could be paid a different percentage from one month to the
|
||||
* next with nothing in the data to explain it, which is why this is refused rather than warned
|
||||
* about.
|
||||
*/
|
||||
public class OverlappingCommissionSlabException extends AbstractPlatformDomainRuleException {
|
||||
|
||||
public OverlappingCommissionSlabException(final String slabType, final BigDecimal from, final BigDecimal to,
|
||||
final BigDecimal existingFrom, final BigDecimal existingTo) {
|
||||
super("error.msg.commissionslab.overlapping",
|
||||
slabType + " slab " + from.toPlainString() + " to " + to.toPlainString() + " overlaps the existing slab "
|
||||
+ existingFrom.toPlainString() + " to " + existingTo.toPlainString(),
|
||||
slabType, from, to, existingFrom, existingTo);
|
||||
}
|
||||
}
|
||||
+61
@@ -0,0 +1,61 @@
|
||||
/**
|
||||
* 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.dds.accounttype.data;
|
||||
|
||||
import java.io.Serial;
|
||||
import java.io.Serializable;
|
||||
import java.math.BigDecimal;
|
||||
import java.time.LocalDateTime;
|
||||
import lombok.Builder;
|
||||
import lombok.Getter;
|
||||
|
||||
/**
|
||||
* Immutable data object representing a DDS Account Type (the legacy Account Type Creation record).
|
||||
*/
|
||||
@Getter
|
||||
@Builder(toBuilder = true)
|
||||
public final class DdsAccountTypeData implements Serializable {
|
||||
|
||||
@Serial
|
||||
private static final long serialVersionUID = 1L;
|
||||
|
||||
private final Long id;
|
||||
private final String accountTypeGroup;
|
||||
private final String accountTypeCode;
|
||||
private final String accountTypeDescription;
|
||||
private final Boolean autoInterestPost;
|
||||
private final String autoInterestPostWhen;
|
||||
private final Integer autoInterestPostDay;
|
||||
/** Whether an account on this scheme closes itself on its maturity date. */
|
||||
private final Boolean maturityAutoClose;
|
||||
/**
|
||||
* What this scheme charges for closing an account before its term is up: how long it may not be
|
||||
* closed at all, what comes off the customer's rate if they bear the cost, and what comes off the
|
||||
* agent's commission either way. Read at the moment of closure, so a change on the scheme takes
|
||||
* effect on accounts already open.
|
||||
*/
|
||||
private final Integer prematureLockinMonths;
|
||||
private final BigDecimal prematureInterestReduction;
|
||||
private final BigDecimal prematureAgentCommissionPenalty;
|
||||
/** The scheme's annual interest rate, which an account opened on it takes. */
|
||||
private final BigDecimal interestRate;
|
||||
private final Boolean active;
|
||||
private final LocalDateTime createdDate;
|
||||
private final LocalDateTime lastModifiedDate;
|
||||
}
|
||||
+267
@@ -0,0 +1,267 @@
|
||||
/**
|
||||
* 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.dds.accounttype.domain;
|
||||
|
||||
import jakarta.persistence.Column;
|
||||
import jakarta.persistence.Entity;
|
||||
import jakarta.persistence.Table;
|
||||
import jakarta.persistence.UniqueConstraint;
|
||||
import java.math.BigDecimal;
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.Map;
|
||||
import lombok.Getter;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.apache.fineract.infrastructure.core.api.JsonCommand;
|
||||
import org.apache.fineract.infrastructure.core.domain.AbstractAuditableCustom;
|
||||
|
||||
/**
|
||||
* A DDS scheme variant, as registered on the legacy "Account Type Creation" screen: a group (e.g.
|
||||
* "DDS"), a short code (e.g. "DS"), a description (e.g. "DAILY DEPOSIT"), and whether interest is
|
||||
* posted automatically and how often.
|
||||
*
|
||||
* This is master/reference data, not a deposit product - a Party picks one of these by code in its
|
||||
* "Sub Type" field. Nothing here drives interest calculation: the DDS batch job accrues interest
|
||||
* straight off each Party's own rate and balance.
|
||||
*/
|
||||
@Getter
|
||||
@Entity
|
||||
@Table(name = "m_dds_account_type", uniqueConstraints = {
|
||||
@UniqueConstraint(columnNames = { "account_type_code" }, name = "uq_dds_account_type_code") })
|
||||
public class DdsAccountType extends AbstractAuditableCustom {
|
||||
|
||||
@Column(name = "account_type_group", length = 60, nullable = false)
|
||||
private String accountTypeGroup;
|
||||
|
||||
@Column(name = "account_type_code", length = 20, nullable = false)
|
||||
private String accountTypeCode;
|
||||
|
||||
@Column(name = "account_type_description", length = 200, nullable = false)
|
||||
private String accountTypeDescription;
|
||||
|
||||
@Column(name = "auto_interest_post", nullable = false)
|
||||
private boolean autoInterestPost;
|
||||
|
||||
@Column(name = "auto_interest_post_when", length = 20)
|
||||
private String autoInterestPostWhen;
|
||||
|
||||
/** Day of the month interest posts on. Only meaningful when {@code autoInterestPost} is set. */
|
||||
@Column(name = "auto_interest_post_day")
|
||||
private Integer autoInterestPostDay;
|
||||
|
||||
/**
|
||||
* Whether an account on this scheme closes itself the day it matures, instead of waiting for a
|
||||
* clerk to pay it out by hand.
|
||||
*
|
||||
* Kept on the scheme rather than switched on bank-wide, for the same reason interest posting is:
|
||||
* a bank runs several schemes at once and will not want them all behaving the same way. It says
|
||||
* only whether the closing should happen, never when - the batch run decides that, exactly as it
|
||||
* does for {@code autoInterestPost}.
|
||||
*
|
||||
* A scheme with this set still only closes an account that has somewhere for the money to go. If
|
||||
* the account names no savings account to be paid into, nothing happens automatically and the
|
||||
* clerk pays it out as before: money is never sent somewhere nobody chose.
|
||||
*/
|
||||
@Column(name = "maturity_auto_close", nullable = false)
|
||||
private boolean maturityAutoClose;
|
||||
|
||||
/**
|
||||
* How long an account on this scheme must run before it may be closed early at all. Below this
|
||||
* the request is refused outright rather than charged for.
|
||||
*
|
||||
* Per-scheme rather than one bank-wide figure: a lock-in longer than the scheme's own term would
|
||||
* make early closure unreachable, so a two-month scheme and a five-year one cannot share one.
|
||||
*/
|
||||
@Column(name = "premature_lockin_months", nullable = false)
|
||||
private Integer prematureLockinMonths;
|
||||
|
||||
/**
|
||||
* Percentage points off the customer's interest rate when the customer bears the cost of closing
|
||||
* early - a 2% scheme pays 1% over the whole period, not only the part left to run.
|
||||
*/
|
||||
@Column(name = "premature_interest_reduction", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal prematureInterestReduction;
|
||||
|
||||
/**
|
||||
* Percentage off the collecting agent's commission on an early closure, applied whichever way the
|
||||
* shortfall is met - an account closed early is a round the agent did not keep going.
|
||||
*/
|
||||
@Column(name = "premature_agent_commission_penalty", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal prematureAgentCommissionPenalty;
|
||||
|
||||
/**
|
||||
* The scheme's annual interest rate. Mandatory: an account opened on the scheme takes this rate,
|
||||
* rather than one typed at the counter for each customer.
|
||||
*/
|
||||
@Column(name = "interest_rate", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal interestRate;
|
||||
|
||||
/**
|
||||
* An account type is retired by deactivating it, never by deleting: Parties are opened against
|
||||
* it, so removing the row would orphan every account already using it. Inactive types stay out
|
||||
* of the pick lists for new accounts but leave existing accounts untouched.
|
||||
*/
|
||||
@Column(name = "is_active", nullable = false)
|
||||
private boolean active;
|
||||
|
||||
protected DdsAccountType() {
|
||||
//
|
||||
}
|
||||
|
||||
private DdsAccountType(final JsonCommand command) {
|
||||
this.accountTypeGroup = command.stringValueOfParameterNamed("accountTypeGroup");
|
||||
this.accountTypeCode = normaliseCode(command.stringValueOfParameterNamed("accountTypeCode"));
|
||||
this.accountTypeDescription = command.stringValueOfParameterNamed("accountTypeDescription");
|
||||
this.autoInterestPost = command.booleanPrimitiveValueOfParameterNamed("autoInterestPost");
|
||||
this.autoInterestPostWhen = StringUtils
|
||||
.defaultIfEmpty(command.stringValueOfParameterNamedAllowingNull("autoInterestPostWhen"), null);
|
||||
this.autoInterestPostDay = this.autoInterestPost
|
||||
? command.integerValueOfParameterNamedDefaultToNullIfZero("autoInterestPostDay")
|
||||
: null;
|
||||
this.maturityAutoClose = command.booleanPrimitiveValueOfParameterNamed("maturityAutoClose");
|
||||
this.prematureLockinMonths = valueOr(command, "prematureLockinMonths", DEFAULT_LOCKIN_MONTHS);
|
||||
this.prematureInterestReduction = valueOr(command, "prematureInterestReduction", DEFAULT_INTEREST_REDUCTION);
|
||||
this.prematureAgentCommissionPenalty = valueOr(command, "prematureAgentCommissionPenalty", DEFAULT_AGENT_PENALTY);
|
||||
this.interestRate = command.bigDecimalValueOfParameterNamed("interestRate");
|
||||
// A newly created account type is available for use straight away.
|
||||
this.active = !command.parameterExists("active") || command.booleanPrimitiveValueOfParameterNamed("active");
|
||||
}
|
||||
|
||||
/**
|
||||
* The bank's stated terms, used when a scheme is created without saying otherwise. They are
|
||||
* defaults rather than fixed rules - the screen offers them and the bank changes them per scheme.
|
||||
*/
|
||||
private static final int DEFAULT_LOCKIN_MONTHS = 12;
|
||||
private static final BigDecimal DEFAULT_INTEREST_REDUCTION = BigDecimal.ONE;
|
||||
private static final BigDecimal DEFAULT_AGENT_PENALTY = BigDecimal.ONE;
|
||||
|
||||
private static Integer valueOr(final JsonCommand command, final String parameter, final int fallback) {
|
||||
final Integer supplied = command.parameterExists(parameter)
|
||||
? command.integerValueOfParameterNamedDefaultToNullIfZero(parameter)
|
||||
: null;
|
||||
return supplied == null ? fallback : supplied;
|
||||
}
|
||||
|
||||
private static BigDecimal valueOr(final JsonCommand command, final String parameter, final BigDecimal fallback) {
|
||||
// Deliberately not "default to null if zero": zero is a real answer here - a scheme that
|
||||
// charges the customer nothing for closing early - and must not be read as "unset".
|
||||
final BigDecimal supplied = command.parameterExists(parameter)
|
||||
? command.bigDecimalValueOfParameterNamed(parameter)
|
||||
: null;
|
||||
return supplied == null ? fallback : supplied;
|
||||
}
|
||||
|
||||
/**
|
||||
* Codes are the account type's identity and are matched against elsewhere, so "ds" and "DS" must
|
||||
* not become two different types - they are stored upper-cased and trimmed.
|
||||
*/
|
||||
private static String normaliseCode(final String code) {
|
||||
return code == null ? null : code.trim().toUpperCase();
|
||||
}
|
||||
|
||||
public static DdsAccountType fromJson(final JsonCommand command) {
|
||||
return new DdsAccountType(command);
|
||||
}
|
||||
|
||||
public Map<String, Object> update(final JsonCommand command) {
|
||||
|
||||
final Map<String, Object> actualChanges = new LinkedHashMap<>(6);
|
||||
|
||||
if (command.isChangeInStringParameterNamed("accountTypeGroup", this.accountTypeGroup)) {
|
||||
final String newValue = command.stringValueOfParameterNamed("accountTypeGroup");
|
||||
actualChanges.put("accountTypeGroup", newValue);
|
||||
this.accountTypeGroup = newValue;
|
||||
}
|
||||
|
||||
final String incomingCode = normaliseCode(command.stringValueOfParameterNamedAllowingNull("accountTypeCode"));
|
||||
if (incomingCode != null && !incomingCode.equals(this.accountTypeCode)) {
|
||||
actualChanges.put("accountTypeCode", incomingCode);
|
||||
this.accountTypeCode = incomingCode;
|
||||
}
|
||||
|
||||
if (command.isChangeInStringParameterNamed("accountTypeDescription", this.accountTypeDescription)) {
|
||||
final String newValue = command.stringValueOfParameterNamed("accountTypeDescription");
|
||||
actualChanges.put("accountTypeDescription", newValue);
|
||||
this.accountTypeDescription = newValue;
|
||||
}
|
||||
|
||||
if (command.isChangeInBooleanParameterNamed("autoInterestPost", this.autoInterestPost)) {
|
||||
final boolean newValue = command.booleanPrimitiveValueOfParameterNamed("autoInterestPost");
|
||||
actualChanges.put("autoInterestPost", newValue);
|
||||
this.autoInterestPost = newValue;
|
||||
}
|
||||
|
||||
if (command.isChangeInStringParameterNamed("autoInterestPostWhen", this.autoInterestPostWhen)) {
|
||||
final String newValue = command.stringValueOfParameterNamed("autoInterestPostWhen");
|
||||
actualChanges.put("autoInterestPostWhen", newValue);
|
||||
this.autoInterestPostWhen = StringUtils.defaultIfEmpty(newValue, null);
|
||||
}
|
||||
|
||||
if (command.isChangeInIntegerParameterNamed("autoInterestPostDay", this.autoInterestPostDay)) {
|
||||
final Integer newValue = command.integerValueOfParameterNamedDefaultToNullIfZero("autoInterestPostDay");
|
||||
actualChanges.put("autoInterestPostDay", newValue);
|
||||
this.autoInterestPostDay = newValue;
|
||||
}
|
||||
|
||||
if (command.isChangeInBooleanParameterNamed("maturityAutoClose", this.maturityAutoClose)) {
|
||||
final boolean newValue = command.booleanPrimitiveValueOfParameterNamed("maturityAutoClose");
|
||||
actualChanges.put("maturityAutoClose", newValue);
|
||||
this.maturityAutoClose = newValue;
|
||||
}
|
||||
|
||||
// A posting day only means anything while auto-posting is on.
|
||||
if (!this.autoInterestPost) {
|
||||
this.autoInterestPostDay = null;
|
||||
}
|
||||
|
||||
if (command.isChangeInIntegerParameterNamed("prematureLockinMonths", this.prematureLockinMonths)) {
|
||||
final Integer newValue = command.integerValueOfParameterNamedDefaultToNullIfZero("prematureLockinMonths");
|
||||
actualChanges.put("prematureLockinMonths", newValue);
|
||||
// Zero lock-in is meaningful - it lets an account be closed early from day one - but the
|
||||
// column cannot hold null, so it is kept as zero rather than reset to the default.
|
||||
this.prematureLockinMonths = newValue == null ? 0 : newValue;
|
||||
}
|
||||
|
||||
if (command.isChangeInBigDecimalParameterNamed("prematureInterestReduction", this.prematureInterestReduction)) {
|
||||
final BigDecimal newValue = command.bigDecimalValueOfParameterNamed("prematureInterestReduction");
|
||||
actualChanges.put("prematureInterestReduction", newValue);
|
||||
this.prematureInterestReduction = newValue == null ? BigDecimal.ZERO : newValue;
|
||||
}
|
||||
|
||||
if (command.isChangeInBigDecimalParameterNamed("prematureAgentCommissionPenalty", this.prematureAgentCommissionPenalty)) {
|
||||
final BigDecimal newValue = command.bigDecimalValueOfParameterNamed("prematureAgentCommissionPenalty");
|
||||
actualChanges.put("prematureAgentCommissionPenalty", newValue);
|
||||
this.prematureAgentCommissionPenalty = newValue == null ? BigDecimal.ZERO : newValue;
|
||||
}
|
||||
|
||||
// The scheme's rate - every open account on it follows it (see the account type service).
|
||||
if (command.parameterExists("interestRate") && command.isChangeInBigDecimalParameterNamed("interestRate", this.interestRate)) {
|
||||
final BigDecimal newValue = command.bigDecimalValueOfParameterNamed("interestRate");
|
||||
actualChanges.put("interestRate", newValue);
|
||||
this.interestRate = newValue;
|
||||
}
|
||||
|
||||
if (command.isChangeInBooleanParameterNamed("active", this.active)) {
|
||||
final boolean newValue = command.booleanPrimitiveValueOfParameterNamed("active");
|
||||
actualChanges.put("active", newValue);
|
||||
this.active = newValue;
|
||||
}
|
||||
|
||||
return actualChanges;
|
||||
}
|
||||
}
|
||||
+36
@@ -0,0 +1,36 @@
|
||||
/**
|
||||
* 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.dds.accounttype.exception;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformResourceNotFoundException;
|
||||
import org.springframework.dao.EmptyResultDataAccessException;
|
||||
|
||||
/**
|
||||
* A {@link RuntimeException} thrown when a DDS account type resource is not found.
|
||||
*/
|
||||
public class DdsAccountTypeNotFoundException extends AbstractPlatformResourceNotFoundException {
|
||||
|
||||
public DdsAccountTypeNotFoundException(final Long id) {
|
||||
super("error.msg.dds.account.type.id.invalid", "DDS account type with identifier " + id + " does not exist", id);
|
||||
}
|
||||
|
||||
public DdsAccountTypeNotFoundException(final Long id, final EmptyResultDataAccessException e) {
|
||||
super("error.msg.dds.account.type.id.invalid", "DDS account type with identifier " + id + " does not exist", id, e);
|
||||
}
|
||||
}
|
||||
+58
@@ -0,0 +1,58 @@
|
||||
/**
|
||||
* 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.dds.batch.data;
|
||||
|
||||
import java.io.Serial;
|
||||
import java.io.Serializable;
|
||||
import java.math.BigDecimal;
|
||||
import java.time.LocalDate;
|
||||
import java.util.Collection;
|
||||
import lombok.Builder;
|
||||
import lombok.Getter;
|
||||
|
||||
@Getter
|
||||
@Builder(toBuilder = true)
|
||||
public final class BatchRunData implements Serializable {
|
||||
|
||||
@Serial
|
||||
private static final long serialVersionUID = 1L;
|
||||
|
||||
private final Long id;
|
||||
private final String jobType;
|
||||
private final String branchScope;
|
||||
|
||||
/** Which DDS scheme the run covered, or null for every scheme. Set by the automatic posting job. */
|
||||
private final String subType;
|
||||
|
||||
private final LocalDate jobDate;
|
||||
private final Long agentFrom;
|
||||
private final Long agentTo;
|
||||
private final Long partyFrom;
|
||||
private final Long partyTo;
|
||||
private final String status;
|
||||
private final Integer totalRows;
|
||||
/** How many rows a crediting run has applied. Equal to totalRows once it has finished. */
|
||||
private final Integer rowsPosted;
|
||||
/** Why a run stopped, when it did - a crediting run happens in the background and has no other voice. */
|
||||
private final String failureReason;
|
||||
private final BigDecimal totalAmount;
|
||||
private final LocalDate generatedOnDate;
|
||||
private final LocalDate postedOnDate;
|
||||
private final Collection<BatchRunRowData> rows;
|
||||
}
|
||||
+57
@@ -0,0 +1,57 @@
|
||||
/**
|
||||
* 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.dds.batch.data;
|
||||
|
||||
import java.io.Serial;
|
||||
import java.io.Serializable;
|
||||
import java.math.BigDecimal;
|
||||
import java.time.LocalDate;
|
||||
import lombok.Builder;
|
||||
import lombok.Getter;
|
||||
|
||||
@Getter
|
||||
@Builder
|
||||
public final class BatchRunRowData implements Serializable {
|
||||
|
||||
@Serial
|
||||
private static final long serialVersionUID = 1L;
|
||||
|
||||
private final Long id;
|
||||
private final Long partyId;
|
||||
private final String partyCode;
|
||||
private final String partyName;
|
||||
private final Long agentId;
|
||||
private final String agentCode;
|
||||
private final String agentName;
|
||||
|
||||
/** What the row applies: interest, or commission net of every deduction. */
|
||||
private final BigDecimal amount;
|
||||
|
||||
/**
|
||||
* How that amount was arrived at. Null on rows where it does not apply - a posting row moves a
|
||||
* figure an earlier calculation run worked out, so the rate and base belong to that run.
|
||||
*/
|
||||
private final BigDecimal baseAmount;
|
||||
private final BigDecimal ratePercent;
|
||||
private final BigDecimal grossAmount;
|
||||
private final BigDecimal tdsAmount;
|
||||
private final BigDecimal deductionAmount;
|
||||
private final LocalDate fromDate;
|
||||
private final LocalDate toDate;
|
||||
}
|
||||
+180
@@ -0,0 +1,180 @@
|
||||
/**
|
||||
* 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.dds.batch.domain;
|
||||
|
||||
import jakarta.persistence.CascadeType;
|
||||
import jakarta.persistence.Column;
|
||||
import jakarta.persistence.Entity;
|
||||
import jakarta.persistence.FetchType;
|
||||
import jakarta.persistence.OneToMany;
|
||||
import jakarta.persistence.OrderBy;
|
||||
import jakarta.persistence.Table;
|
||||
import java.math.BigDecimal;
|
||||
import java.time.LocalDate;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import lombok.Getter;
|
||||
import org.apache.fineract.infrastructure.core.domain.AbstractAuditableCustom;
|
||||
|
||||
/**
|
||||
* One Calculate-then-Post batch run - the deliberate two-step control from the legacy Interest Part
|
||||
* menu (Interest Calculation -> Interest Posting, OD Interest Calculation -> OD Interest Posting,
|
||||
* Commission Calculation -> Commission Posting): a run is generated (rows computed and saved as a
|
||||
* preview, nothing else changes), then posted (a separate, explicit step that applies exactly the
|
||||
* rows that were previewed - never a fresh recalculation, so what gets applied is always what was
|
||||
* seen).
|
||||
*/
|
||||
@Getter
|
||||
@Entity
|
||||
@Table(name = "m_dds_batch_run")
|
||||
public class BatchRun extends AbstractAuditableCustom {
|
||||
|
||||
@Column(name = "job_type", length = 40, nullable = false)
|
||||
private String jobType;
|
||||
|
||||
@Column(name = "branch_scope", length = 20, nullable = false)
|
||||
private String branchScope;
|
||||
|
||||
/**
|
||||
* Which DDS scheme this run covered, or null for every scheme.
|
||||
*
|
||||
* A posting day belongs to an account type rather than to the bank, so a run started by the
|
||||
* scheduled job covers one scheme at a time - otherwise the scheme due on the 15th would drag the
|
||||
* month-end scheme's accounts along with it. A run started by hand from the screen leaves this
|
||||
* null and covers everything, as it always did.
|
||||
*/
|
||||
@Column(name = "sub_type", length = 60)
|
||||
private String subType;
|
||||
|
||||
@Column(name = "job_date", nullable = false)
|
||||
private LocalDate jobDate;
|
||||
|
||||
@Column(name = "agent_from", nullable = false)
|
||||
private Long agentFrom;
|
||||
|
||||
@Column(name = "agent_to", nullable = false)
|
||||
private Long agentTo;
|
||||
|
||||
@Column(name = "party_from")
|
||||
private Long partyFrom;
|
||||
|
||||
@Column(name = "party_to")
|
||||
private Long partyTo;
|
||||
|
||||
@Column(name = "status", length = 20, nullable = false)
|
||||
private String status;
|
||||
|
||||
@Column(name = "total_rows", nullable = false)
|
||||
private Integer totalRows;
|
||||
|
||||
/** How many of those rows have been credited so far - what a screen reads to show progress. */
|
||||
@Column(name = "rows_posted", nullable = false)
|
||||
private Integer rowsPosted = 0;
|
||||
|
||||
/** Why a run stopped, when it did. A background run has nowhere else to say so. */
|
||||
@Column(name = "failure_reason", length = 500)
|
||||
private String failureReason;
|
||||
|
||||
@Column(name = "total_amount", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal totalAmount;
|
||||
|
||||
@Column(name = "generated_on_date", nullable = false)
|
||||
private LocalDate generatedOnDate;
|
||||
|
||||
@Column(name = "posted_on_date")
|
||||
private LocalDate postedOnDate;
|
||||
|
||||
@OneToMany(mappedBy = "batchRun", cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.LAZY)
|
||||
@OrderBy("id")
|
||||
private List<BatchRunRow> rows = new ArrayList<>();
|
||||
|
||||
protected BatchRun() {
|
||||
//
|
||||
}
|
||||
|
||||
public BatchRun(final String jobType, final String branchScope, final LocalDate jobDate, final Long agentFrom,
|
||||
final Long agentTo, final Long partyFrom, final Long partyTo, final LocalDate generatedOnDate) {
|
||||
this(jobType, branchScope, jobDate, agentFrom, agentTo, partyFrom, partyTo, generatedOnDate, null);
|
||||
}
|
||||
|
||||
public BatchRun(final String jobType, final String branchScope, final LocalDate jobDate, final Long agentFrom,
|
||||
final Long agentTo, final Long partyFrom, final Long partyTo, final LocalDate generatedOnDate, final String subType) {
|
||||
this.jobType = jobType;
|
||||
this.branchScope = branchScope;
|
||||
this.subType = subType;
|
||||
this.jobDate = jobDate;
|
||||
this.agentFrom = agentFrom;
|
||||
this.agentTo = agentTo;
|
||||
this.partyFrom = partyFrom;
|
||||
this.partyTo = partyTo;
|
||||
this.status = "CALCULATED";
|
||||
this.totalRows = 0;
|
||||
this.totalAmount = BigDecimal.ZERO;
|
||||
this.generatedOnDate = generatedOnDate;
|
||||
}
|
||||
|
||||
public void addRow(final BatchRunRow row) {
|
||||
row.setBatchRun(this);
|
||||
this.rows.add(row);
|
||||
this.totalRows = this.rows.size();
|
||||
this.totalAmount = this.totalAmount.add(row.getAmount());
|
||||
}
|
||||
|
||||
public boolean isPosted() {
|
||||
return STATUS_POSTED.equals(this.status);
|
||||
}
|
||||
|
||||
/** Under way. Set before the work starts, so a second press finds it already running. */
|
||||
public boolean isPosting() {
|
||||
return STATUS_POSTING.equals(this.status);
|
||||
}
|
||||
|
||||
public void markPosting() {
|
||||
this.status = STATUS_POSTING;
|
||||
this.rowsPosted = 0;
|
||||
this.failureReason = null;
|
||||
}
|
||||
|
||||
public void recordProgress(final int posted) {
|
||||
this.rowsPosted = posted;
|
||||
}
|
||||
|
||||
public void markPosted(final LocalDate postedOnDate) {
|
||||
this.status = STATUS_POSTED;
|
||||
this.postedOnDate = postedOnDate;
|
||||
this.rowsPosted = this.totalRows;
|
||||
this.failureReason = null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Records why a run stopped, and leaves it able to be run again.
|
||||
*
|
||||
* Nothing it had credited stands: the whole run is one transaction, so a failure takes all of it
|
||||
* back. That is the point - the branch is left with a run that plainly did not happen rather than
|
||||
* one it has to reconcile by hand.
|
||||
*/
|
||||
public void markFailed(final String reason) {
|
||||
this.status = STATUS_FAILED;
|
||||
this.failureReason = reason == null ? "Unknown error" : reason.substring(0, Math.min(reason.length(), 500));
|
||||
}
|
||||
|
||||
private static final String STATUS_POSTED = "POSTED";
|
||||
private static final String STATUS_POSTING = "POSTING";
|
||||
private static final String STATUS_FAILED = "FAILED";
|
||||
}
|
||||
+130
@@ -0,0 +1,130 @@
|
||||
/**
|
||||
* 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.dds.batch.domain;
|
||||
|
||||
import jakarta.persistence.Column;
|
||||
import jakarta.persistence.Entity;
|
||||
import jakarta.persistence.JoinColumn;
|
||||
import jakarta.persistence.ManyToOne;
|
||||
import jakarta.persistence.Table;
|
||||
import java.math.BigDecimal;
|
||||
import java.time.LocalDate;
|
||||
import lombok.Getter;
|
||||
import org.apache.fineract.infrastructure.core.domain.AbstractPersistableCustom;
|
||||
|
||||
/**
|
||||
* One previewed/posted line of a {@link BatchRun}: for an interest job, one Party's interest; for a
|
||||
* commission job, one Agent's commission on their collected volume (partyId is null there).
|
||||
*
|
||||
* {@code amount} is always what actually gets applied. The remaining figures record how that amount
|
||||
* was arrived at, which is what the Agent Commission Statement prints and what an agent querying a
|
||||
* payout needs to see. They are stored rather than recomputed on demand because the inputs move: the
|
||||
* slab chart can be corrected and the standing deductions change, so a later recomputation would not
|
||||
* reproduce the figure that was actually paid.
|
||||
*/
|
||||
@Getter
|
||||
@Entity
|
||||
@Table(name = "m_dds_batch_run_row")
|
||||
public class BatchRunRow extends AbstractPersistableCustom<Long> {
|
||||
|
||||
@ManyToOne
|
||||
@JoinColumn(name = "batch_run_id", nullable = false)
|
||||
private BatchRun batchRun;
|
||||
|
||||
@Column(name = "party_id")
|
||||
private Long partyId;
|
||||
|
||||
@Column(name = "agent_id", nullable = false)
|
||||
private Long agentId;
|
||||
|
||||
/** What this row applies: interest accrued or posted, or commission net of every deduction. */
|
||||
@Column(name = "amount", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal amount;
|
||||
|
||||
/**
|
||||
* What the rate was applied to: the collection volume for commission, or the daily product
|
||||
* (balance summed over the days it was held) for interest.
|
||||
*/
|
||||
@Column(name = "base_amount", scale = 6, precision = 19)
|
||||
private BigDecimal baseAmount;
|
||||
|
||||
@Column(name = "rate_percent", scale = 6, precision = 19)
|
||||
private BigDecimal ratePercent;
|
||||
|
||||
/** Before deductions. Equal to {@code amount} on rows that have none. */
|
||||
@Column(name = "gross_amount", scale = 6, precision = 19)
|
||||
private BigDecimal grossAmount;
|
||||
|
||||
@Column(name = "tds_amount", scale = 6, precision = 19)
|
||||
private BigDecimal tdsAmount;
|
||||
|
||||
@Column(name = "deduction_amount", scale = 6, precision = 19)
|
||||
private BigDecimal deductionAmount;
|
||||
|
||||
@Column(name = "from_date")
|
||||
private LocalDate fromDate;
|
||||
|
||||
@Column(name = "to_date")
|
||||
private LocalDate toDate;
|
||||
|
||||
protected BatchRunRow() {
|
||||
//
|
||||
}
|
||||
|
||||
private BatchRunRow(final Long partyId, final Long agentId, final BigDecimal amount, final BigDecimal baseAmount,
|
||||
final BigDecimal ratePercent, final BigDecimal grossAmount, final BigDecimal tdsAmount, final BigDecimal deductionAmount,
|
||||
final LocalDate fromDate, final LocalDate toDate) {
|
||||
this.partyId = partyId;
|
||||
this.agentId = agentId;
|
||||
this.amount = amount;
|
||||
this.baseAmount = baseAmount;
|
||||
this.ratePercent = ratePercent;
|
||||
this.grossAmount = grossAmount;
|
||||
this.tdsAmount = tdsAmount;
|
||||
this.deductionAmount = deductionAmount;
|
||||
this.fromDate = fromDate;
|
||||
this.toDate = toDate;
|
||||
}
|
||||
|
||||
/** Interest earned on a Party's balance over the days it was held. Nothing is deducted from it. */
|
||||
public static BatchRunRow forInterest(final Long partyId, final Long agentId, final BigDecimal amount,
|
||||
final BigDecimal dailyProduct, final BigDecimal ratePercent, final LocalDate fromDate, final LocalDate toDate) {
|
||||
return new BatchRunRow(partyId, agentId, amount, dailyProduct, ratePercent, amount, null, null, fromDate, toDate);
|
||||
}
|
||||
|
||||
/** An Agent's commission on their collection volume, net of TDS and the standing deductions. */
|
||||
public static BatchRunRow forCommission(final Long agentId, final BigDecimal netAmount, final BigDecimal collectionVolume,
|
||||
final BigDecimal ratePercent, final BigDecimal grossAmount, final BigDecimal tdsAmount, final BigDecimal deductionAmount,
|
||||
final LocalDate fromDate, final LocalDate toDate) {
|
||||
return new BatchRunRow(null, agentId, netAmount, collectionVolume, ratePercent, grossAmount, tdsAmount, deductionAmount,
|
||||
fromDate, toDate);
|
||||
}
|
||||
|
||||
/**
|
||||
* A posting row: it moves an amount that a prior calculation run already worked out, so there is
|
||||
* no rate or base to record against it - the run that calculated it holds those.
|
||||
*/
|
||||
public static BatchRunRow forPosting(final Long partyId, final Long agentId, final BigDecimal amount, final LocalDate asOnDate) {
|
||||
return new BatchRunRow(partyId, agentId, amount, null, null, amount, null, null, asOnDate, asOnDate);
|
||||
}
|
||||
|
||||
void setBatchRun(final BatchRun batchRun) {
|
||||
this.batchRun = batchRun;
|
||||
}
|
||||
}
|
||||
+32
@@ -0,0 +1,32 @@
|
||||
/**
|
||||
* 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.dds.batch.exception;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformDomainRuleException;
|
||||
|
||||
/**
|
||||
* Thrown when Post is attempted on a batch run that has already been posted - a run applies once,
|
||||
* matching the calculate-then-post safety control (never re-post the same preview).
|
||||
*/
|
||||
public class BatchRunAlreadyPostedException extends AbstractPlatformDomainRuleException {
|
||||
|
||||
public BatchRunAlreadyPostedException(final Long batchRunId) {
|
||||
super("error.msg.ddsbatchrun.already.posted", "DDS batch run " + batchRunId + " has already been posted", batchRunId);
|
||||
}
|
||||
}
|
||||
+28
@@ -0,0 +1,28 @@
|
||||
/**
|
||||
* 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.dds.batch.exception;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformResourceNotFoundException;
|
||||
|
||||
public class BatchRunNotFoundException extends AbstractPlatformResourceNotFoundException {
|
||||
|
||||
public BatchRunNotFoundException(final Long id) {
|
||||
super("error.msg.ddsbatchrun.id.invalid", "DDS batch run with identifier " + id + " does not exist", id);
|
||||
}
|
||||
}
|
||||
+41
@@ -0,0 +1,41 @@
|
||||
/**
|
||||
* 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.dds.batch.exception;
|
||||
|
||||
import java.math.BigDecimal;
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformDomainRuleException;
|
||||
|
||||
/**
|
||||
* Thrown when an agent's collection volume falls in a gap in the commission chart, so there is no rate
|
||||
* to pay them at.
|
||||
*
|
||||
* The run stops rather than skipping the agent. A gap is a mistake in the chart, and an agent who
|
||||
* worked all month reading as earning nothing looks exactly like an agent who collected nothing - the
|
||||
* one failure nobody would query until the agent complained. Naming the agent and the amount that
|
||||
* found no slab points straight at the range that needs adding.
|
||||
*/
|
||||
public class NoCommissionSlabException extends AbstractPlatformDomainRuleException {
|
||||
|
||||
public NoCommissionSlabException(final String agentCode, final BigDecimal collectionVolume) {
|
||||
super("error.msg.ddsbatchrun.no.commission.slab",
|
||||
"No commission slab covers " + collectionVolume.toPlainString() + ", the collection volume for agent " + agentCode
|
||||
+ ". Add a slab covering this amount to the Commission Slab Master and run the calculation again.",
|
||||
agentCode, collectionVolume);
|
||||
}
|
||||
}
|
||||
+85
@@ -0,0 +1,85 @@
|
||||
/**
|
||||
* 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.dds.calculation;
|
||||
|
||||
import java.math.BigDecimal;
|
||||
import java.math.RoundingMode;
|
||||
|
||||
/**
|
||||
* What a collection agent has earned on a period's collections, and what is left after deductions.
|
||||
*
|
||||
* <pre>
|
||||
* gross the slab's percentage of everything collected
|
||||
* tds withheld from the gross, when the agent is liable for it
|
||||
* deductions the four standing amounts the bank recovers from them
|
||||
* net what the agent is actually paid
|
||||
* </pre>
|
||||
*
|
||||
* Every figure is kept, not just the net: an agent asking why their commission was short needs the
|
||||
* whole breakdown, and a later change to the slab must not alter what was already paid.
|
||||
*
|
||||
* <p>
|
||||
* Kept apart from the job that runs it so the sum can be checked on its own.
|
||||
*/
|
||||
public record DdsCommissionCalculation(BigDecimal collectionVolume, BigDecimal ratePercent, BigDecimal gross, BigDecimal tds,
|
||||
BigDecimal deductions, BigDecimal net) {
|
||||
|
||||
private static final BigDecimal HUNDRED = BigDecimal.valueOf(100);
|
||||
private static final int MONEY_SCALE = 2;
|
||||
|
||||
/**
|
||||
* Works out a period's commission.
|
||||
*
|
||||
* @param collectionVolume
|
||||
* everything the agent collected in the period.
|
||||
* @param ratePercent
|
||||
* the matching slab's percentage.
|
||||
* @param tdsApplicable
|
||||
* whether tax is withheld from this agent at all.
|
||||
* @param tdsPercent
|
||||
* the rate withheld when it is.
|
||||
* @param deductions
|
||||
* the standing amounts the bank recovers - see {@code Agent.totalDeductions()}.
|
||||
*/
|
||||
public static DdsCommissionCalculation of(final BigDecimal collectionVolume, final BigDecimal ratePercent,
|
||||
final boolean tdsApplicable, final BigDecimal tdsPercent, final BigDecimal deductions) {
|
||||
|
||||
final BigDecimal volume = collectionVolume == null ? BigDecimal.ZERO : collectionVolume;
|
||||
final BigDecimal rate = ratePercent == null ? BigDecimal.ZERO : ratePercent;
|
||||
final BigDecimal recovered = deductions == null ? BigDecimal.ZERO : deductions;
|
||||
|
||||
final BigDecimal gross = volume.multiply(rate).divide(HUNDRED, MONEY_SCALE, RoundingMode.HALF_UP);
|
||||
final BigDecimal withheld = tdsApplicable && tdsPercent != null
|
||||
? gross.multiply(tdsPercent).divide(HUNDRED, MONEY_SCALE, RoundingMode.HALF_UP)
|
||||
: BigDecimal.ZERO;
|
||||
|
||||
return new DdsCommissionCalculation(volume, rate, gross, withheld, recovered, gross.subtract(withheld).subtract(recovered));
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether there is anything to pay.
|
||||
*
|
||||
* The deductions can swallow a period's commission entirely. Nothing is owed then, and the agent
|
||||
* is not put into debt over it - the deductions are standing figures the bank adjusts, not a
|
||||
* balance a commission run is entitled to carry forward.
|
||||
*/
|
||||
public boolean isPayable() {
|
||||
return this.net.compareTo(BigDecimal.ZERO) > 0;
|
||||
}
|
||||
}
|
||||
+126
@@ -0,0 +1,126 @@
|
||||
/**
|
||||
* 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.dds.calculation;
|
||||
|
||||
import java.math.BigDecimal;
|
||||
import java.math.MathContext;
|
||||
import java.math.RoundingMode;
|
||||
import java.time.LocalDate;
|
||||
import java.time.temporal.ChronoUnit;
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* What a DDS account has earned over a period.
|
||||
*
|
||||
* Interest is on the <em>daily product</em>: the balance summed over the days it was actually held.
|
||||
* A customer paying in daily holds each instalment for a different length of time, so interest on
|
||||
* the closing balance for the whole period would pay them for money they had not yet deposited -
|
||||
* roughly double what they are owed, which is what this replaced.
|
||||
*
|
||||
* This is the same basis {@code Party.calculateMaturityAmount()} quotes at opening, so what the
|
||||
* interest runs add up to over a term matches the figure the customer was promised.
|
||||
*
|
||||
* <p>
|
||||
* Kept apart from the job that runs it so the sum can be checked on its own. It reads nothing and
|
||||
* writes nothing - given the same movements it always answers the same, which is what makes it
|
||||
* worth testing.
|
||||
*/
|
||||
public final class DdsInterestCalculation {
|
||||
|
||||
/** Wide enough that the intermediate division never loses precision before the final rounding. */
|
||||
private static final MathContext MATH_CONTEXT = new MathContext(19, RoundingMode.HALF_UP);
|
||||
|
||||
private static final BigDecimal HUNDRED = BigDecimal.valueOf(100);
|
||||
private static final BigDecimal DAYS_IN_YEAR = BigDecimal.valueOf(365);
|
||||
private static final int MONEY_SCALE = 2;
|
||||
|
||||
private DdsInterestCalculation() {}
|
||||
|
||||
/**
|
||||
* One movement on the account: a collection is positive, a payout negative.
|
||||
*
|
||||
* A plain pair rather than the transaction itself, so this sum has no opinion about how
|
||||
* transactions are stored and can be checked with a handful of literals.
|
||||
*/
|
||||
public record Movement(LocalDate date, BigDecimal signedAmount) {}
|
||||
|
||||
/**
|
||||
* The balance summed over the days it was held, between {@code from} (exclusive) and {@code to}
|
||||
* (inclusive).
|
||||
*
|
||||
* @param openingBalance
|
||||
* what the account held before any of these movements.
|
||||
* @param movements
|
||||
* every movement up to the end of the period, oldest first. Anything dated on or
|
||||
* before {@code from} has already happened and makes up the balance this period opens
|
||||
* with rather than a movement within it.
|
||||
*/
|
||||
public static BigDecimal dailyProduct(final BigDecimal openingBalance, final List<Movement> movements, final LocalDate from,
|
||||
final LocalDate to) {
|
||||
|
||||
BigDecimal balance = openingBalance == null ? BigDecimal.ZERO : openingBalance;
|
||||
int index = 0;
|
||||
while (index < movements.size() && !movements.get(index).date().isAfter(from)) {
|
||||
balance = balance.add(movements.get(index).signedAmount());
|
||||
index++;
|
||||
}
|
||||
|
||||
BigDecimal product = BigDecimal.ZERO;
|
||||
LocalDate cursor = from;
|
||||
|
||||
while (index < movements.size()) {
|
||||
final LocalDate movementDate = movements.get(index).date();
|
||||
if (movementDate.isAfter(to)) {
|
||||
break;
|
||||
}
|
||||
|
||||
// The untouched days between the last movement and this one, at the balance they stood at.
|
||||
final long daysAtOpeningBalance = ChronoUnit.DAYS.between(cursor, movementDate) - 1;
|
||||
if (daysAtOpeningBalance > 0) {
|
||||
product = product.add(balance.multiply(BigDecimal.valueOf(daysAtOpeningBalance)));
|
||||
}
|
||||
|
||||
// Apply every movement dated that day before counting the day itself, so a deposit earns
|
||||
// from the day it was made.
|
||||
while (index < movements.size() && movementDate.equals(movements.get(index).date())) {
|
||||
balance = balance.add(movements.get(index).signedAmount());
|
||||
index++;
|
||||
}
|
||||
product = product.add(balance);
|
||||
cursor = movementDate;
|
||||
}
|
||||
|
||||
final long remainingDays = ChronoUnit.DAYS.between(cursor, to);
|
||||
if (remainingDays > 0) {
|
||||
product = product.add(balance.multiply(BigDecimal.valueOf(remainingDays)));
|
||||
}
|
||||
|
||||
return product;
|
||||
}
|
||||
|
||||
/** Simple interest on a daily product at an annual rate, rounded to paise. */
|
||||
public static BigDecimal interestOn(final BigDecimal dailyProduct, final BigDecimal ratePercent) {
|
||||
if (dailyProduct == null || ratePercent == null || dailyProduct.compareTo(BigDecimal.ZERO) <= 0
|
||||
|| ratePercent.compareTo(BigDecimal.ZERO) <= 0) {
|
||||
return BigDecimal.ZERO.setScale(MONEY_SCALE);
|
||||
}
|
||||
return dailyProduct.multiply(ratePercent).divide(HUNDRED.multiply(DAYS_IN_YEAR), MATH_CONTEXT).setScale(MONEY_SCALE,
|
||||
RoundingMode.HALF_UP);
|
||||
}
|
||||
}
|
||||
+117
@@ -0,0 +1,117 @@
|
||||
/**
|
||||
* 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.dds.calculation;
|
||||
|
||||
import java.math.BigDecimal;
|
||||
import java.math.RoundingMode;
|
||||
import java.time.LocalDate;
|
||||
import java.time.temporal.ChronoUnit;
|
||||
|
||||
/**
|
||||
* Where a daily deposit account stands against the instalments it owes.
|
||||
*
|
||||
* The bank's rule has two sides and they are not symmetrical. A customer may run ahead, but only a few
|
||||
* days - the scheme is a habit of saving daily, not a deposit paid in one go. A customer may fall
|
||||
* behind and catch up, but only within a short window; instalments older than that are skipped, and
|
||||
* skipped means gone - the agent does not go back for them, and the account matures on what was
|
||||
* actually paid.
|
||||
*
|
||||
* So a shortfall is split rather than shown as one figure. What can still be collected is worth a
|
||||
* clerk chasing today; what has passed the window is not, and showing them together would have the
|
||||
* clerk asking for money the bank has already written off.
|
||||
*
|
||||
* Kept here, outside either service, because the screen that shows these figures and the check that
|
||||
* refuses a collection exceeding them have to agree. Two copies would drift, and the day they did the
|
||||
* screen would quote a customer an amount the server then refused.
|
||||
*
|
||||
* @param expected what should have been collected by the day this was worked out
|
||||
* @param advance signed: positive is paid ahead, negative is behind
|
||||
* @param advanceDays whole instalments covered ahead - a part-paid day does not count
|
||||
* @param arrearsDays whole or part instalments behind
|
||||
* @param recoverable the part of a shortfall still inside the catch-up window
|
||||
* @param skippedDays instalments past that window
|
||||
* @param skipped what those come to
|
||||
*/
|
||||
public record DdsSchedule(BigDecimal expected, BigDecimal advance, int advanceDays, int arrearsDays, BigDecimal recoverable,
|
||||
int skippedDays, BigDecimal skipped) {
|
||||
|
||||
/**
|
||||
* How far behind an account may fall and still be caught up. Past this the instalments are
|
||||
* skipped - the agent does not go back for them and the customer matures on less.
|
||||
*/
|
||||
public static final int CATCH_UP_DAYS = 3;
|
||||
|
||||
/**
|
||||
* The most a customer may pay ahead, so a scheme is not simply prepaid into a lump deposit. A few
|
||||
* days is the bank's allowance for someone going away or paid weekly.
|
||||
*/
|
||||
public static final int MAX_ADVANCE_DAYS = 5;
|
||||
|
||||
private static final DdsSchedule NOTHING_DUE = new DdsSchedule(BigDecimal.ZERO, BigDecimal.ZERO, 0, 0, BigDecimal.ZERO, 0,
|
||||
BigDecimal.ZERO);
|
||||
|
||||
/**
|
||||
* How many instalments should have been paid by the given day.
|
||||
*
|
||||
* The first falls on the opening day itself - the same day the maturity figure starts counting
|
||||
* from, so the two agree - and the count stops at the term's own length, so a matured account does
|
||||
* not keep falling further behind.
|
||||
*/
|
||||
public static int instalmentsDue(final LocalDate openingDate, final Integer termDays, final LocalDate on) {
|
||||
if (openingDate == null || termDays == null || termDays <= 0 || on == null) {
|
||||
return 0;
|
||||
}
|
||||
final long elapsed = ChronoUnit.DAYS.between(openingDate, on) + 1;
|
||||
return (int) Math.max(0, Math.min(termDays, elapsed));
|
||||
}
|
||||
|
||||
public static DdsSchedule of(final BigDecimal daily, final int instalmentsDue, final BigDecimal collected) {
|
||||
if (daily == null || daily.compareTo(BigDecimal.ZERO) <= 0) {
|
||||
// Nothing is due daily, so there is no schedule to be ahead or behind of.
|
||||
return NOTHING_DUE;
|
||||
}
|
||||
|
||||
final BigDecimal paid = collected == null ? BigDecimal.ZERO : collected;
|
||||
final BigDecimal expected = daily.multiply(BigDecimal.valueOf(instalmentsDue));
|
||||
final BigDecimal advance = paid.subtract(expected);
|
||||
|
||||
if (advance.compareTo(BigDecimal.ZERO) >= 0) {
|
||||
// Ahead. Only whole instalments count as days covered - a customer eighty rupees into a
|
||||
// hundred-rupee day still owes today, and the agent should still call.
|
||||
final int daysCovered = advance.divideToIntegralValue(daily).intValue();
|
||||
return new DdsSchedule(expected, advance, daysCovered, 0, BigDecimal.ZERO, 0, BigDecimal.ZERO);
|
||||
}
|
||||
|
||||
// Behind. A part-paid day counts as a day behind for the same reason.
|
||||
final BigDecimal shortfall = advance.negate();
|
||||
final int daysBehind = shortfall.divide(daily, 0, RoundingMode.CEILING).intValue();
|
||||
final BigDecimal window = daily.multiply(BigDecimal.valueOf(CATCH_UP_DAYS));
|
||||
final BigDecimal recoverable = shortfall.min(window);
|
||||
return new DdsSchedule(expected, advance, 0, daysBehind, recoverable, Math.max(0, daysBehind - CATCH_UP_DAYS),
|
||||
shortfall.subtract(recoverable));
|
||||
}
|
||||
|
||||
/** Whole instalments a customer may still pay off, which is what the arrears option may offer. */
|
||||
public int recoverableDays(final BigDecimal daily) {
|
||||
if (daily == null || daily.compareTo(BigDecimal.ZERO) <= 0) {
|
||||
return 0;
|
||||
}
|
||||
return this.recoverable.divideToIntegralValue(daily).intValue();
|
||||
}
|
||||
}
|
||||
+53
@@ -0,0 +1,53 @@
|
||||
/**
|
||||
* 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.dds.collection.data;
|
||||
|
||||
import java.math.BigDecimal;
|
||||
import java.time.LocalDate;
|
||||
import java.util.List;
|
||||
import lombok.Builder;
|
||||
import lombok.Data;
|
||||
|
||||
/**
|
||||
* An agent's day, as the clerk sees it when the agent walks up to the counter.
|
||||
*
|
||||
* The figure that matters is {@code expectedAmount}: what the agent's own entries add up to, and so
|
||||
* what should be in their bag. It is given as a total beside the lines it came from, because a clerk
|
||||
* who is short counts the lines to find out where.
|
||||
*/
|
||||
@Data
|
||||
@Builder
|
||||
public class AgentCollectionSummaryData {
|
||||
|
||||
private final Long agentId;
|
||||
private final String agentCode;
|
||||
private final String agentName;
|
||||
private final LocalDate entryDate;
|
||||
|
||||
private final int pendingCount;
|
||||
|
||||
/** What the agent's outstanding entries add up to - the cash the branch should be handed. */
|
||||
private final BigDecimal expectedAmount;
|
||||
|
||||
/** What has already been counted and posted for this agent on this date. */
|
||||
private final int settledCount;
|
||||
private final BigDecimal settledAmount;
|
||||
|
||||
private final List<CollectionEntryData> entries;
|
||||
}
|
||||
+66
@@ -0,0 +1,66 @@
|
||||
/**
|
||||
* 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.dds.collection.data;
|
||||
|
||||
import java.math.BigDecimal;
|
||||
import java.time.LocalDate;
|
||||
import lombok.Builder;
|
||||
import lombok.Data;
|
||||
|
||||
/**
|
||||
* One written-down collection, as the agent's screen and the clerk's settlement list show it.
|
||||
*
|
||||
* Carries the party's code, name and balance beside the amount, because both readers are checking
|
||||
* the line against a person rather than an id - the agent against the customer they just left, the
|
||||
* clerk against the passbook in front of them.
|
||||
*/
|
||||
@Data
|
||||
@Builder
|
||||
public class CollectionEntryData {
|
||||
|
||||
private final Long id;
|
||||
|
||||
private final Long agentId;
|
||||
private final String agentCode;
|
||||
private final String agentName;
|
||||
|
||||
private final Long partyId;
|
||||
private final String partyCode;
|
||||
private final String partyName;
|
||||
|
||||
/** The account's balance as it stands now - before this entry, which has not been posted. */
|
||||
private final BigDecimal partyBalance;
|
||||
|
||||
/** What this scheme takes each day, so an amount that is not a day's instalment stands out. */
|
||||
private final BigDecimal dailyDepositAmount;
|
||||
|
||||
private final LocalDate entryDate;
|
||||
private final BigDecimal amount;
|
||||
private final String transactionMode;
|
||||
private final String chequeNo;
|
||||
private final String tokenNo;
|
||||
private final String description;
|
||||
|
||||
private final String status;
|
||||
private final LocalDate settledOn;
|
||||
private final Long partyTransactionId;
|
||||
/** Days paid ahead, or days of arrears cleared - empty on an ordinary day's collection. */
|
||||
private final Integer advanceDays;
|
||||
private final Integer arrearsDays;
|
||||
}
|
||||
+174
@@ -0,0 +1,174 @@
|
||||
/**
|
||||
* 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.dds.collection.domain;
|
||||
|
||||
import jakarta.persistence.Column;
|
||||
import jakarta.persistence.Entity;
|
||||
import jakarta.persistence.JoinColumn;
|
||||
import jakarta.persistence.ManyToOne;
|
||||
import jakarta.persistence.Table;
|
||||
import java.math.BigDecimal;
|
||||
import java.time.LocalDate;
|
||||
import lombok.Getter;
|
||||
import org.apache.fineract.infrastructure.core.domain.AbstractAuditableCustom;
|
||||
import org.apache.fineract.organisation.agent.domain.Agent;
|
||||
import org.apache.fineract.portfolio.dds.party.domain.Party;
|
||||
|
||||
/**
|
||||
* One line an agent wrote down on their round: this customer, this much, in this form.
|
||||
*
|
||||
* It is not a transaction and deliberately reads nothing like one. No balance is carried on it, no
|
||||
* ledger entry stands behind it, and no report of the bank's position counts it. It says only what
|
||||
* the agent says they collected - the bank's own record of it begins when a clerk has counted the
|
||||
* cash and confirmed the day's entries, and what that writes is an ordinary
|
||||
* {@code m_dds_party_transaction} row.
|
||||
*
|
||||
* The distinction is the whole point of the table. Credited on the spot, the books showed customers
|
||||
* paid in notes the branch had never held, and there was nothing to count the agent's bag against
|
||||
* when they arrived. Held here, the agent's word and the bank's books stay separate until somebody
|
||||
* puts them side by side.
|
||||
*/
|
||||
@Getter
|
||||
@Entity
|
||||
@Table(name = "m_dds_collection_entry")
|
||||
public class CollectionEntry extends AbstractAuditableCustom {
|
||||
|
||||
/** Waiting for a clerk to count the cash behind it. */
|
||||
public static final String PENDING = "PENDING";
|
||||
|
||||
/** Counted, posted, and now standing behind a real transaction. */
|
||||
public static final String SETTLED = "SETTLED";
|
||||
|
||||
/** Withdrawn before it was ever posted - a wrong line the agent took back. */
|
||||
public static final String CANCELLED = "CANCELLED";
|
||||
|
||||
@ManyToOne
|
||||
@JoinColumn(name = "agent_id", nullable = false)
|
||||
private Agent agent;
|
||||
|
||||
@ManyToOne
|
||||
@JoinColumn(name = "party_id", nullable = false)
|
||||
private Party party;
|
||||
|
||||
/**
|
||||
* The day the money changed hands, which is the agent's day and not the branch's. A round
|
||||
* collected on Friday and brought in on Monday is still Friday's collection, and the customer's
|
||||
* statement has to say so.
|
||||
*/
|
||||
@Column(name = "entry_date", nullable = false)
|
||||
private LocalDate entryDate;
|
||||
|
||||
@Column(name = "amount", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal amount;
|
||||
|
||||
@Column(name = "transaction_mode", length = 20, nullable = false)
|
||||
private String transactionMode;
|
||||
|
||||
@Column(name = "cheque_no", length = 50)
|
||||
private String chequeNo;
|
||||
|
||||
@Column(name = "token_no", length = 50)
|
||||
private String tokenNo;
|
||||
|
||||
@Column(name = "description", length = 200)
|
||||
private String description;
|
||||
|
||||
@Column(name = "status", length = 20, nullable = false)
|
||||
private String status;
|
||||
|
||||
@Column(name = "settled_on")
|
||||
private LocalDate settledOn;
|
||||
|
||||
/**
|
||||
* The transaction this entry became, once it was posted.
|
||||
*
|
||||
* Held as a plain id rather than a mapped association: this table is the paper the bank checked
|
||||
* against, not part of the ledger, and a link that pulled a transaction in whenever an entry was
|
||||
* read would make the two look like halves of one thing. Anyone who needs the transaction can
|
||||
* fetch it; most callers only need to know there is one.
|
||||
*/
|
||||
@Column(name = "party_transaction_id")
|
||||
private Long partyTransactionId;
|
||||
|
||||
/**
|
||||
* The application of the cashier's DDS receipts that settled this entry, when it was settled that
|
||||
* way - see 0517, which records which vouchers it used. A plain id for the same reason as the
|
||||
* transaction.
|
||||
*/
|
||||
@Column(name = "receipt_application_id")
|
||||
private Long receiptApplicationId;
|
||||
|
||||
/** Days paid ahead, or days of arrears cleared - see 0520. Both empty on an ordinary day's collection. */
|
||||
@Column(name = "advance_days")
|
||||
private Integer advanceDays;
|
||||
|
||||
@Column(name = "arrears_days")
|
||||
private Integer arrearsDays;
|
||||
|
||||
protected CollectionEntry() {
|
||||
//
|
||||
}
|
||||
|
||||
public CollectionEntry(final Agent agent, final Party party, final LocalDate entryDate, final BigDecimal amount,
|
||||
final String transactionMode, final String chequeNo, final String tokenNo, final String description) {
|
||||
this.agent = agent;
|
||||
this.party = party;
|
||||
this.entryDate = entryDate;
|
||||
this.amount = amount;
|
||||
this.transactionMode = transactionMode;
|
||||
this.chequeNo = chequeNo;
|
||||
this.tokenNo = tokenNo;
|
||||
this.description = description;
|
||||
this.status = PENDING;
|
||||
}
|
||||
|
||||
/** Records what the collection covers beyond today, once its amount has been checked against it. */
|
||||
public void covering(final Integer advanceDays, final Integer arrearsDays) {
|
||||
this.advanceDays = advanceDays;
|
||||
this.arrearsDays = arrearsDays;
|
||||
}
|
||||
|
||||
public boolean isPending() {
|
||||
return PENDING.equals(this.status);
|
||||
}
|
||||
|
||||
/**
|
||||
* Records that this entry has been counted and posted, and what it became.
|
||||
*
|
||||
* The transaction's id is kept so the two can always be put back together - a clerk asked six
|
||||
* months later which entry a credit came from has an answer, rather than a matching exercise on
|
||||
* date and amount.
|
||||
*/
|
||||
public void markSettled(final LocalDate settledOn, final Long partyTransactionId) {
|
||||
this.status = SETTLED;
|
||||
this.settledOn = settledOn;
|
||||
this.partyTransactionId = partyTransactionId;
|
||||
}
|
||||
|
||||
/** Settled against the cashier's receipts: the same as {@link #markSettled}, and which application did it. */
|
||||
public void markSettledByReceipt(final LocalDate settledOn, final Long partyTransactionId, final Long receiptApplicationId) {
|
||||
markSettled(settledOn, partyTransactionId);
|
||||
this.receiptApplicationId = receiptApplicationId;
|
||||
}
|
||||
|
||||
/** Withdraws a line that was never posted. Kept, not deleted - the agent wrote it, so it stands. */
|
||||
public void markCancelled() {
|
||||
this.status = CANCELLED;
|
||||
}
|
||||
}
|
||||
+28
@@ -0,0 +1,28 @@
|
||||
/**
|
||||
* 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.dds.collection.exception;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformResourceNotFoundException;
|
||||
|
||||
public class CollectionEntryNotFoundException extends AbstractPlatformResourceNotFoundException {
|
||||
|
||||
public CollectionEntryNotFoundException(final Long entryId) {
|
||||
super("error.msg.dds.collection.entry.not.found", "Collection entry " + entryId + " does not exist", entryId);
|
||||
}
|
||||
}
|
||||
+37
@@ -0,0 +1,37 @@
|
||||
/**
|
||||
* 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.dds.collection.exception;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformDomainRuleException;
|
||||
|
||||
/**
|
||||
* Thrown when a written-down collection is taken back after it has already been settled.
|
||||
*
|
||||
* By then it is not a note any more - a customer has been credited and an agent's cash recorded
|
||||
* against it. Withdrawing it here would leave the note cancelled and the credit standing, which is
|
||||
* the one state nobody could reconcile. A posted collection is undone the way any posting is: with
|
||||
* an entry the other way, on the ledger, where it can be seen.
|
||||
*/
|
||||
public class CollectionEntryNotPendingException extends AbstractPlatformDomainRuleException {
|
||||
|
||||
public CollectionEntryNotPendingException(final Long entryId, final String status) {
|
||||
super("error.msg.dds.collection.entry.not.pending",
|
||||
"Collection entry " + entryId + " is " + status.toLowerCase() + " and can no longer be cancelled", entryId, status);
|
||||
}
|
||||
}
|
||||
+36
@@ -0,0 +1,36 @@
|
||||
/**
|
||||
* 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.dds.collection.exception;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformDomainRuleException;
|
||||
|
||||
/**
|
||||
* Thrown when a settlement is asked for and the agent has nothing outstanding on that date.
|
||||
*
|
||||
* Said plainly rather than passed off as a settlement of nothing, because the clerk is standing at
|
||||
* the counter with an agent in front of them: either they have the wrong date, or the round has been
|
||||
* settled already, and both are worth knowing before the cash is taken.
|
||||
*/
|
||||
public class NothingToSettleException extends AbstractPlatformDomainRuleException {
|
||||
|
||||
public NothingToSettleException(final String agentCode, final String entryDate) {
|
||||
super("error.msg.dds.collection.nothing.to.settle",
|
||||
"Agent " + agentCode + " has no collection entries outstanding for " + entryDate, agentCode, entryDate);
|
||||
}
|
||||
}
|
||||
+182
@@ -0,0 +1,182 @@
|
||||
/**
|
||||
* 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.dds.party.data;
|
||||
|
||||
import java.io.Serial;
|
||||
import java.io.Serializable;
|
||||
import java.math.BigDecimal;
|
||||
import java.time.LocalDate;
|
||||
import java.util.Collection;
|
||||
import lombok.Builder;
|
||||
import lombok.Getter;
|
||||
|
||||
/**
|
||||
* Immutable data object representing a DDS Party (customer scheme account), including its nominees.
|
||||
* Built via the Lombok builder rather than a long positional constructor - the field count here makes
|
||||
* positional args unreadable and error-prone to keep in sync.
|
||||
*/
|
||||
@Getter
|
||||
@Builder(toBuilder = true)
|
||||
public final class PartyData implements Serializable {
|
||||
|
||||
@Serial
|
||||
private static final long serialVersionUID = 1L;
|
||||
|
||||
private final Long id;
|
||||
private final Long clientId;
|
||||
private final String clientName;
|
||||
private final Long agentId;
|
||||
private final String agentCode;
|
||||
private final String agentName;
|
||||
/** The branch this account belongs to - its own, not the collecting agent's. */
|
||||
private final Long officeId;
|
||||
private final String officeName;
|
||||
/**
|
||||
* The customer's real deposit account, opened when the party was created.
|
||||
*
|
||||
* The id alone was carried here before, which is a number only the database means anything by -
|
||||
* a screen showing "36" tells an officer nothing. The account's own number, product, status and
|
||||
* balance are read from the account itself, so what a party shows is what the bank's books say
|
||||
* rather than a second copy that can drift. All four are null for a party opened before DDS
|
||||
* began opening real accounts, and that is worth showing plainly rather than hiding.
|
||||
*/
|
||||
private final Long savingsAccountId;
|
||||
private final String savingsAccountNo;
|
||||
private final String savingsProductName;
|
||||
private final String savingsAccountStatus;
|
||||
private final BigDecimal savingsAccountBalance;
|
||||
/**
|
||||
* What on this account is pledged against a loan and cannot leave.
|
||||
*
|
||||
* Shown beside the balance on the closure list because a deposit standing as security is owed but
|
||||
* not payable, and a clerk who reads only the balance would try to pay it and be refused.
|
||||
*/
|
||||
private final BigDecimal amountHeldUnderLien;
|
||||
private final String subType;
|
||||
/**
|
||||
* The account type's description, resolved from the DDS Account Type master that {@code subType}
|
||||
* holds the code of - so callers can show the scheme by the name officers know it by without
|
||||
* fetching the master separately.
|
||||
*/
|
||||
private final String subTypeDescription;
|
||||
private final String partyCode;
|
||||
/** The DDS account's own number. */
|
||||
private final String accountNo;
|
||||
private final String lastAccount;
|
||||
private final Boolean nominal;
|
||||
private final String aadharNo;
|
||||
private final String partyName;
|
||||
private final String partyName1;
|
||||
private final String address1;
|
||||
private final String address2;
|
||||
private final String address3;
|
||||
private final String city;
|
||||
private final String pincode;
|
||||
private final String gender;
|
||||
private final String panCardNo;
|
||||
private final String telephone;
|
||||
private final String mobileNoSms;
|
||||
private final String operation;
|
||||
private final LocalDate birthDate;
|
||||
private final String occupation;
|
||||
private final String risk;
|
||||
private final String ckycId;
|
||||
private final String adultMinor;
|
||||
private final LocalDate minorDate;
|
||||
|
||||
/**
|
||||
* The day a minor account holder comes of age, and whether it has passed.
|
||||
*
|
||||
* Worked out from the birth date rather than taken from {@code minorDate}, which is typed in by
|
||||
* hand and has never been filled on any record. Null on an adult's account.
|
||||
*
|
||||
* The guardian's authority to operate the account ends on that day, so the branch has to take
|
||||
* fresh KYC, a signature and a new mandate from the customer themselves. Nothing acts on this
|
||||
* yet - whether the account should also be restricted until that is done is the bank's rule, and
|
||||
* blocking one wrongly would strand a customer's money. It is carried here so the day stops
|
||||
* passing unnoticed, which is what happened before.
|
||||
*/
|
||||
private final LocalDate majorOn;
|
||||
private final boolean minorTurnedMajor;
|
||||
private final Long guardianClientId;
|
||||
private final String minAccountOpt;
|
||||
private final String relation;
|
||||
private final LocalDate openingDate;
|
||||
private final Integer month;
|
||||
private final LocalDate maturityDate;
|
||||
private final LocalDate reopenDate;
|
||||
private final BigDecimal depositAmount;
|
||||
private final BigDecimal dailyDepositAmount;
|
||||
private final Integer days;
|
||||
private final String ledgerNo;
|
||||
private final BigDecimal maturityAmount;
|
||||
private final BigDecimal interestRate;
|
||||
private final String withdrawType;
|
||||
private final Boolean od1Flag;
|
||||
private final Boolean od2Flag;
|
||||
private final Boolean lien;
|
||||
/** Why the money is held - null when it is not. */
|
||||
private final String lienReason;
|
||||
private final LocalDate payDate;
|
||||
private final BigDecimal paymentAmount;
|
||||
private final BigDecimal currentBalance;
|
||||
private final BigDecimal openingBalance;
|
||||
|
||||
/**
|
||||
* Where this account stands against the instalments it should have paid by today.
|
||||
*
|
||||
* A daily scheme is a promise to pay a fixed sum every day, and the only figure the screen used to
|
||||
* show was the running balance - which says how much has been paid but not whether it was paid on
|
||||
* time. A customer eleven instalments behind and one who is four ahead can hold the same balance.
|
||||
*
|
||||
* {@code advanceAmount} is signed: positive is paid ahead, negative is behind. The rest of these
|
||||
* read it in the bank's own terms - how many days that comes to, how much of a shortfall can still
|
||||
* be recovered within the catch-up window, and how much has fallen outside it and is gone.
|
||||
*/
|
||||
private final Integer instalmentsDue;
|
||||
private final BigDecimal expectedToDate;
|
||||
private final BigDecimal collectedToDate;
|
||||
private final BigDecimal advanceAmount;
|
||||
private final Integer advanceDays;
|
||||
private final Integer arrearsDays;
|
||||
private final BigDecimal recoverableAmount;
|
||||
/** Instalments now past the catch-up window. These are not collected again - they are lost. */
|
||||
private final Integer skippedDays;
|
||||
private final BigDecimal skippedAmount;
|
||||
private final Boolean isSmsActive;
|
||||
private final Boolean isEmailActive;
|
||||
/** Interest worked out but not yet credited, and how far it is calculated through. */
|
||||
private final BigDecimal interestCalc;
|
||||
private final LocalDate interestDate;
|
||||
|
||||
/** The same pair for the OD interest stream, which runs and posts independently. */
|
||||
private final BigDecimal odInterestCalc;
|
||||
private final LocalDate odInterestDate;
|
||||
private final String spDescription;
|
||||
private final String freezeCode;
|
||||
private final String advCode;
|
||||
private final String creditToBranch;
|
||||
private final String creditToAccountType;
|
||||
private final String creditToAccount;
|
||||
private final Boolean nomineeApplicable;
|
||||
private final String nomineeSplitMode;
|
||||
private final String status;
|
||||
private final LocalDate closeDate;
|
||||
private final Collection<PartyNomineeData> nominees;
|
||||
}
|
||||
+69
@@ -0,0 +1,69 @@
|
||||
/**
|
||||
* 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.dds.party.data;
|
||||
|
||||
import java.io.Serial;
|
||||
import java.io.Serializable;
|
||||
import java.math.BigDecimal;
|
||||
import java.time.LocalDate;
|
||||
import lombok.Getter;
|
||||
|
||||
@Getter
|
||||
public final class PartyNomineeData implements Serializable {
|
||||
|
||||
@Serial
|
||||
private static final long serialVersionUID = 1L;
|
||||
|
||||
private final Long id;
|
||||
private final LocalDate nominationDate;
|
||||
private final String name;
|
||||
private final String mobileNo;
|
||||
private final LocalDate birthDate;
|
||||
private final Boolean minor;
|
||||
private final String relation;
|
||||
private final String gender;
|
||||
private final String guardianName;
|
||||
/** Null under a Sequence split, where the order the nominees are paid in is the entitlement. */
|
||||
private final BigDecimal sharePercent;
|
||||
/** Null under a Percentage split, where everyone is paid at once and there is no first. */
|
||||
private final Integer sequenceNo;
|
||||
|
||||
public static PartyNomineeData instance(final Long id, final LocalDate nominationDate, final String name, final String mobileNo,
|
||||
final LocalDate birthDate, final Boolean minor, final String relation, final String gender, final String guardianName,
|
||||
final BigDecimal sharePercent, final Integer sequenceNo) {
|
||||
return new PartyNomineeData(id, nominationDate, name, mobileNo, birthDate, minor, relation, gender, guardianName, sharePercent,
|
||||
sequenceNo);
|
||||
}
|
||||
|
||||
private PartyNomineeData(final Long id, final LocalDate nominationDate, final String name, final String mobileNo,
|
||||
final LocalDate birthDate, final Boolean minor, final String relation, final String gender, final String guardianName,
|
||||
final BigDecimal sharePercent, final Integer sequenceNo) {
|
||||
this.id = id;
|
||||
this.nominationDate = nominationDate;
|
||||
this.name = name;
|
||||
this.mobileNo = mobileNo;
|
||||
this.birthDate = birthDate;
|
||||
this.minor = minor;
|
||||
this.relation = relation;
|
||||
this.gender = gender;
|
||||
this.guardianName = guardianName;
|
||||
this.sharePercent = sharePercent;
|
||||
this.sequenceNo = sequenceNo;
|
||||
}
|
||||
}
|
||||
+791
@@ -0,0 +1,791 @@
|
||||
/**
|
||||
* 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.dds.party.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.OrderBy;
|
||||
import jakarta.persistence.Table;
|
||||
import jakarta.persistence.UniqueConstraint;
|
||||
import java.math.BigDecimal;
|
||||
import java.math.MathContext;
|
||||
import java.math.RoundingMode;
|
||||
import java.time.LocalDate;
|
||||
import java.time.temporal.ChronoUnit;
|
||||
import java.util.ArrayList;
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.function.Consumer;
|
||||
import lombok.Getter;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.apache.fineract.infrastructure.core.api.JsonCommand;
|
||||
import org.apache.fineract.infrastructure.core.domain.AbstractAuditableCustom;
|
||||
import org.apache.fineract.organisation.agent.domain.Agent;
|
||||
import org.apache.fineract.organisation.office.domain.Office;
|
||||
import org.apache.fineract.portfolio.client.domain.Client;
|
||||
|
||||
/**
|
||||
* A DDS Party - the customer's daily-deposit scheme account, linked to the Agent who collects for it.
|
||||
* Carries the scheme's KYC, terms and two-stage overdue flags, plus a nominee list.
|
||||
*
|
||||
* The underlying RD (recurring deposit) account this scheme conceptually reuses is not wired up yet -
|
||||
* {@code savingsAccountId} is a nullable placeholder for that future linkage (see the DDS architecture
|
||||
* decision to reuse the RD engine for the deposit half). Until then the scheme/balance fields below
|
||||
* are this record's own, not mirrored from any m_savings_account row.
|
||||
*/
|
||||
@Getter
|
||||
@Entity
|
||||
@Table(name = "m_dds_party", uniqueConstraints = { @UniqueConstraint(columnNames = { "party_code" }, name = "party_code_UNIQUE") })
|
||||
public class Party extends AbstractAuditableCustom {
|
||||
|
||||
/** DDS accounts carry a flat interest rate unless the officer explicitly overrides it at creation. */
|
||||
private static final BigDecimal DEFAULT_INTEREST_RATE = new BigDecimal("2");
|
||||
|
||||
/** Interest is quoted per annum, so the daily instalments are pro-rated over a year. */
|
||||
private static final int DAYS_IN_YEAR = 365;
|
||||
|
||||
private static final MathContext MATH_CONTEXT = new MathContext(19, RoundingMode.HALF_UP);
|
||||
|
||||
public static final String STATUS_ACTIVE = "ACTIVE";
|
||||
public static final String STATUS_CLOSED = "CLOSED";
|
||||
|
||||
@ManyToOne
|
||||
@JoinColumn(name = "client_id", nullable = false)
|
||||
private Client client;
|
||||
|
||||
@ManyToOne
|
||||
@JoinColumn(name = "agent_id", nullable = false)
|
||||
private Agent agent;
|
||||
|
||||
/**
|
||||
* The branch this account belongs to.
|
||||
*
|
||||
* Its own, not the collecting agent's. An agent working out of one branch can hold accounts for
|
||||
* customers of another, and reassigning an account to a different agent should not move the
|
||||
* customer's branch with it. Defaults to the agent's branch when the caller does not name one,
|
||||
* which is what the account was read as before it had a branch of its own.
|
||||
*/
|
||||
@ManyToOne
|
||||
@JoinColumn(name = "office_id")
|
||||
private Office office;
|
||||
|
||||
@Column(name = "savings_account_id")
|
||||
private Long savingsAccountId;
|
||||
|
||||
@Column(name = "sub_type", length = 60, nullable = false)
|
||||
private String subType;
|
||||
|
||||
@Column(name = "party_code", length = 20, nullable = false)
|
||||
private String partyCode;
|
||||
|
||||
/** The DDS account's own number - see 0514. Given once the party has an id, and never changed. */
|
||||
@Column(name = "account_no", length = 20)
|
||||
private String accountNo;
|
||||
|
||||
@Column(name = "last_account", length = 50)
|
||||
private String lastAccount;
|
||||
|
||||
@Column(name = "nominal", nullable = false)
|
||||
private boolean nominal;
|
||||
|
||||
@Column(name = "aadhar_no", length = 20)
|
||||
private String aadharNo;
|
||||
|
||||
@Column(name = "party_name", length = 100, nullable = false)
|
||||
private String partyName;
|
||||
|
||||
@Column(name = "party_name1", length = 100)
|
||||
private String partyName1;
|
||||
|
||||
@Column(name = "address1", length = 200, nullable = false)
|
||||
private String address1;
|
||||
|
||||
@Column(name = "address2", length = 200)
|
||||
private String address2;
|
||||
|
||||
@Column(name = "address3", length = 200)
|
||||
private String address3;
|
||||
|
||||
@Column(name = "city", length = 100, nullable = false)
|
||||
private String city;
|
||||
|
||||
@Column(name = "pincode", length = 20, nullable = false)
|
||||
private String pincode;
|
||||
|
||||
@Column(name = "gender", length = 20)
|
||||
private String gender;
|
||||
|
||||
@Column(name = "pan_card_no", length = 20)
|
||||
private String panCardNo;
|
||||
|
||||
@Column(name = "telephone", length = 20)
|
||||
private String telephone;
|
||||
|
||||
@Column(name = "mobile_no_sms", length = 20, nullable = false)
|
||||
private String mobileNoSms;
|
||||
|
||||
@Column(name = "operation", length = 20, nullable = false)
|
||||
private String operation;
|
||||
|
||||
@Column(name = "birth_date")
|
||||
private LocalDate birthDate;
|
||||
|
||||
@Column(name = "occupation", length = 40)
|
||||
private String occupation;
|
||||
|
||||
@Column(name = "risk", length = 20)
|
||||
private String risk;
|
||||
|
||||
@Column(name = "ckyc_id", length = 40)
|
||||
private String ckycId;
|
||||
|
||||
@Column(name = "adult_minor", length = 20, nullable = false)
|
||||
private String adultMinor;
|
||||
|
||||
@Column(name = "minor_date")
|
||||
private LocalDate minorDate;
|
||||
|
||||
@Column(name = "guardian_client_id")
|
||||
private Long guardianClientId;
|
||||
|
||||
@Column(name = "min_account_opt", length = 40)
|
||||
private String minAccountOpt;
|
||||
|
||||
@Column(name = "relation", length = 40)
|
||||
private String relation;
|
||||
|
||||
@Column(name = "opening_date", nullable = false)
|
||||
private LocalDate openingDate;
|
||||
|
||||
@Column(name = "months")
|
||||
private Integer month;
|
||||
|
||||
@Column(name = "maturity_date")
|
||||
private LocalDate maturityDate;
|
||||
|
||||
@Column(name = "reopen_date")
|
||||
private LocalDate reopenDate;
|
||||
|
||||
@Column(name = "deposit_amount", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal depositAmount;
|
||||
|
||||
@Column(name = "daily_deposit_amount", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal dailyDepositAmount;
|
||||
|
||||
@Column(name = "days", nullable = false)
|
||||
private Integer days;
|
||||
|
||||
@Column(name = "ledger_no", length = 40)
|
||||
private String ledgerNo;
|
||||
|
||||
@Column(name = "maturity_amount", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal maturityAmount;
|
||||
|
||||
@Column(name = "interest_rate", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal interestRate;
|
||||
|
||||
@Column(name = "withdraw_type", length = 20)
|
||||
private String withdrawType;
|
||||
|
||||
@Column(name = "od1_flag", nullable = false)
|
||||
private boolean od1Flag;
|
||||
|
||||
@Column(name = "od2_flag", nullable = false)
|
||||
private boolean od2Flag;
|
||||
|
||||
/**
|
||||
* Whether this account's money is being held, and so cannot leave.
|
||||
*
|
||||
* Deposits are unaffected - the agent collects as before and interest posts as before. What is
|
||||
* refused is every way out: the maturity payout, an early closure, and a transfer to another
|
||||
* party. A lien that stopped the collections would defeat the scheme it is securing.
|
||||
*/
|
||||
@Column(name = "lien", nullable = false)
|
||||
private boolean lien;
|
||||
|
||||
/**
|
||||
* Why the money is held.
|
||||
*
|
||||
* The flag alone says an account is frozen and never says what for, which is how a held deposit
|
||||
* outlives the loan it secured: months later nobody can tell whether it has been repaid, so
|
||||
* nobody will release it and nobody can justify keeping it.
|
||||
*
|
||||
* It falls to a line of text because DDS and the loan module are not connected - nothing else in
|
||||
* the system links a held deposit to the loan behind it.
|
||||
*/
|
||||
@Column(name = "lien_reason", length = 200)
|
||||
private String lienReason;
|
||||
|
||||
@Column(name = "pay_date")
|
||||
private LocalDate payDate;
|
||||
|
||||
@Column(name = "payment_amount", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal paymentAmount;
|
||||
|
||||
@Column(name = "current_balance", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal currentBalance;
|
||||
|
||||
@Column(name = "opening_balance", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal openingBalance;
|
||||
|
||||
@Column(name = "is_sms_active", nullable = false)
|
||||
private boolean isSmsActive;
|
||||
|
||||
@Column(name = "is_email_active", nullable = false)
|
||||
private boolean isEmailActive;
|
||||
|
||||
/** Interest worked out but not yet credited - the legacy screen's "Int.Calc". */
|
||||
@Column(name = "interest_calc", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal interestCalc;
|
||||
|
||||
/** How far regular interest has been calculated through. */
|
||||
@Column(name = "interest_date")
|
||||
private LocalDate interestDate;
|
||||
|
||||
/**
|
||||
* OD interest is a second stream over the same account, run and posted independently of regular
|
||||
* interest, so it keeps its own accrued figure and through-date rather than sharing them.
|
||||
*/
|
||||
@Column(name = "od_interest_calc", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal odInterestCalc;
|
||||
|
||||
@Column(name = "od_interest_date")
|
||||
private LocalDate odInterestDate;
|
||||
|
||||
@Column(name = "sp_description", length = 500)
|
||||
private String spDescription;
|
||||
|
||||
@Column(name = "freeze_code", length = 20, nullable = false)
|
||||
private String freezeCode;
|
||||
|
||||
@Column(name = "adv_code", length = 40, nullable = false)
|
||||
private String advCode;
|
||||
|
||||
@Column(name = "credit_to_branch", length = 100)
|
||||
private String creditToBranch;
|
||||
|
||||
@Column(name = "credit_to_account_type", length = 100)
|
||||
private String creditToAccountType;
|
||||
|
||||
@Column(name = "credit_to_account", length = 50)
|
||||
private String creditToAccount;
|
||||
|
||||
@Column(name = "nominee_applicable", nullable = false)
|
||||
private boolean nomineeApplicable;
|
||||
|
||||
@Column(name = "nominee_split_mode", length = 20)
|
||||
private String nomineeSplitMode;
|
||||
|
||||
@Column(name = "status", length = 20, nullable = false)
|
||||
private String status;
|
||||
|
||||
@Column(name = "close_date")
|
||||
private LocalDate closeDate;
|
||||
|
||||
@OneToMany(mappedBy = "party", cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.LAZY)
|
||||
@OrderBy("id")
|
||||
private List<PartyNominee> nominees = new ArrayList<>();
|
||||
|
||||
protected Party() {
|
||||
//
|
||||
}
|
||||
|
||||
private Party(final Client client, final Agent agent, final Office office, final String partyCode, final JsonCommand command) {
|
||||
this.client = client;
|
||||
this.agent = agent;
|
||||
this.office = office;
|
||||
this.partyCode = partyCode;
|
||||
this.subType = command.stringValueOfParameterNamed("subType");
|
||||
this.lastAccount = command.stringValueOfParameterNamedAllowingNull("lastAccount");
|
||||
this.nominal = command.booleanPrimitiveValueOfParameterNamed("nominal");
|
||||
this.aadharNo = command.stringValueOfParameterNamedAllowingNull("aadharNo");
|
||||
this.partyName = command.stringValueOfParameterNamed("partyName");
|
||||
this.partyName1 = command.stringValueOfParameterNamedAllowingNull("partyName1");
|
||||
this.address1 = command.stringValueOfParameterNamed("address1");
|
||||
this.address2 = command.stringValueOfParameterNamedAllowingNull("address2");
|
||||
this.address3 = command.stringValueOfParameterNamedAllowingNull("address3");
|
||||
this.city = command.stringValueOfParameterNamed("city");
|
||||
this.pincode = command.stringValueOfParameterNamed("pincode");
|
||||
this.gender = command.stringValueOfParameterNamedAllowingNull("gender");
|
||||
this.panCardNo = command.stringValueOfParameterNamedAllowingNull("panCardNo");
|
||||
this.telephone = command.stringValueOfParameterNamedAllowingNull("telephone");
|
||||
this.mobileNoSms = command.stringValueOfParameterNamed("mobileNoSms");
|
||||
this.operation = command.stringValueOfParameterNamed("operation");
|
||||
this.birthDate = command.localDateValueOfParameterNamed("birthDate");
|
||||
this.occupation = command.stringValueOfParameterNamedAllowingNull("occupation");
|
||||
this.risk = command.stringValueOfParameterNamedAllowingNull("risk");
|
||||
this.ckycId = command.stringValueOfParameterNamedAllowingNull("ckycId");
|
||||
this.adultMinor = command.stringValueOfParameterNamed("adultMinor");
|
||||
this.minorDate = command.localDateValueOfParameterNamed("minorDate");
|
||||
this.guardianClientId = command.longValueOfParameterNamed("guardianClientId");
|
||||
this.minAccountOpt = command.stringValueOfParameterNamedAllowingNull("minAccountOpt");
|
||||
this.relation = command.stringValueOfParameterNamedAllowingNull("relation");
|
||||
this.openingDate = command.localDateValueOfParameterNamed("openingDate");
|
||||
this.month = command.integerValueOfParameterNamedDefaultToNullIfZero("month");
|
||||
// maturityDate and maturityAmount are not read from the request - recalculateTerm() below
|
||||
// works both out from the opening date and the terms.
|
||||
this.reopenDate = command.localDateValueOfParameterNamed("reopenDate");
|
||||
this.depositAmount = orZero(command.bigDecimalValueOfParameterNamedDefaultToNullIfZero("depositAmount"));
|
||||
this.dailyDepositAmount = command.bigDecimalValueOfParameterNamed("dailyDepositAmount");
|
||||
this.days = command.integerValueOfParameterNamed("days");
|
||||
this.ledgerNo = command.stringValueOfParameterNamedAllowingNull("ledgerNo");
|
||||
this.maturityAmount = BigDecimal.ZERO;
|
||||
this.interestRate = command.parameterExists("interestRate")
|
||||
? command.bigDecimalValueOfParameterNamed("interestRate")
|
||||
: DEFAULT_INTEREST_RATE;
|
||||
this.withdrawType = command.stringValueOfParameterNamedAllowingNull("withdrawType");
|
||||
this.od1Flag = false;
|
||||
this.od2Flag = false;
|
||||
this.lien = command.booleanPrimitiveValueOfParameterNamed("lien");
|
||||
this.lienReason = StringUtils.trimToNull(command.stringValueOfParameterNamedAllowingNull("lienReason"));
|
||||
this.payDate = command.localDateValueOfParameterNamed("payDate");
|
||||
this.paymentAmount = orZero(command.bigDecimalValueOfParameterNamedDefaultToNullIfZero("paymentAmount"));
|
||||
this.openingBalance = orZero(command.bigDecimalValueOfParameterNamedDefaultToNullIfZero("openingBalance"));
|
||||
this.currentBalance = this.openingBalance;
|
||||
this.isSmsActive = command.booleanPrimitiveValueOfParameterNamed("isSmsActive");
|
||||
this.isEmailActive = command.booleanPrimitiveValueOfParameterNamed("isEmailActive");
|
||||
this.interestCalc = BigDecimal.ZERO;
|
||||
this.interestDate = command.localDateValueOfParameterNamed("interestDate");
|
||||
this.odInterestCalc = BigDecimal.ZERO;
|
||||
this.odInterestDate = null;
|
||||
this.spDescription = command.stringValueOfParameterNamedAllowingNull("spDescription");
|
||||
this.freezeCode = StringUtils.defaultIfBlank(command.stringValueOfParameterNamedAllowingNull("freezeCode"), "Normal");
|
||||
this.advCode = StringUtils.defaultIfBlank(command.stringValueOfParameterNamedAllowingNull("advCode"), "None");
|
||||
this.creditToBranch = command.stringValueOfParameterNamedAllowingNull("creditToBranch");
|
||||
this.creditToAccountType = command.stringValueOfParameterNamedAllowingNull("creditToAccountType");
|
||||
this.creditToAccount = command.stringValueOfParameterNamedAllowingNull("creditToAccount");
|
||||
this.nomineeApplicable = command.booleanPrimitiveValueOfParameterNamed("nomineeApplicable");
|
||||
this.nomineeSplitMode = StringUtils.defaultIfBlank(command.stringValueOfParameterNamedAllowingNull("nomineeSplitMode"),
|
||||
"Percentage");
|
||||
this.status = STATUS_ACTIVE;
|
||||
|
||||
recalculateTerm();
|
||||
}
|
||||
|
||||
/**
|
||||
* Takes the scheme's interest rate. The rate belongs to the scheme, not to the counter: it is set
|
||||
* when the account is opened or moved to another scheme, and again on every open account whenever
|
||||
* the bank changes the scheme's rate, with the maturity figure worked out again on it.
|
||||
*/
|
||||
public void takeSchemeRate(final BigDecimal schemeRate) {
|
||||
this.interestRate = schemeRate == null ? BigDecimal.ZERO : schemeRate;
|
||||
recalculateTerm();
|
||||
}
|
||||
|
||||
/**
|
||||
* Works out the maturity date and amount from the terms just set.
|
||||
*
|
||||
* Both are quoted to the customer when the account is opened, so neither is taken from the
|
||||
* request: a figure the caller supplies is a figure the caller can get wrong or tamper with.
|
||||
* The screen shows the same numbers as a preview, worked out the same way.
|
||||
*/
|
||||
private void recalculateTerm() {
|
||||
if (this.openingDate != null) {
|
||||
if (this.month != null && this.month > 0) {
|
||||
this.maturityDate = this.openingDate.plusMonths(this.month);
|
||||
// Collection runs every day of the term without a break, so the number of instalments
|
||||
// is the number of days - it is not a separate thing for anyone to type.
|
||||
//
|
||||
// It was asked for, and a figure below the term's own length quietly broke the
|
||||
// maturity quote: an account collecting a hundred rupees a day for thirty days with
|
||||
// ten instalments keyed against it was quoted a thousand rupees and would collect
|
||||
// three. Working it out here means the two can no longer disagree.
|
||||
this.days = (int) ChronoUnit.DAYS.between(this.openingDate, this.maturityDate);
|
||||
} else if (this.days != null && this.days > 0) {
|
||||
// No month given, so the term is the run of days itself and days stands as entered.
|
||||
this.maturityDate = this.openingDate.plusDays(this.days);
|
||||
}
|
||||
}
|
||||
this.maturityAmount = calculateMaturityAmount();
|
||||
}
|
||||
|
||||
/**
|
||||
* What the account matures to: every instalment paid in, plus simple interest on each for the
|
||||
* time it sits until maturity.
|
||||
*
|
||||
* The first instalment earns over the whole term and the last over none, which comes to
|
||||
* n(n+1)/2 instalment-days of interest across n instalments. At a zero rate this is just the
|
||||
* instalments themselves.
|
||||
*/
|
||||
private BigDecimal calculateMaturityAmount() {
|
||||
if (this.dailyDepositAmount == null || this.days == null || this.days <= 0
|
||||
|| this.dailyDepositAmount.compareTo(BigDecimal.ZERO) <= 0) {
|
||||
return BigDecimal.ZERO;
|
||||
}
|
||||
|
||||
final BigDecimal instalments = BigDecimal.valueOf(this.days);
|
||||
final BigDecimal principal = this.dailyDepositAmount.multiply(instalments);
|
||||
|
||||
final BigDecimal rate = this.interestRate == null ? BigDecimal.ZERO : this.interestRate;
|
||||
if (rate.compareTo(BigDecimal.ZERO) <= 0) {
|
||||
return principal.setScale(2, RoundingMode.HALF_UP);
|
||||
}
|
||||
|
||||
final BigDecimal instalmentDays = instalments.multiply(instalments.add(BigDecimal.ONE))
|
||||
.divide(BigDecimal.valueOf(2), MATH_CONTEXT);
|
||||
final BigDecimal interest = this.dailyDepositAmount.multiply(instalmentDays).multiply(rate)
|
||||
.divide(BigDecimal.valueOf(100), MATH_CONTEXT)
|
||||
.divide(BigDecimal.valueOf(DAYS_IN_YEAR), MATH_CONTEXT);
|
||||
|
||||
return principal.add(interest).setScale(2, RoundingMode.HALF_UP);
|
||||
}
|
||||
|
||||
public static Party fromJson(final Client client, final Agent agent, final Office office, final String partyCode,
|
||||
final JsonCommand command) {
|
||||
return new Party(client, agent, office, partyCode, command);
|
||||
}
|
||||
|
||||
/** Moves this account to another branch, which a party update may do on its own. */
|
||||
public void changeOffice(final Office newOffice) {
|
||||
this.office = newOffice;
|
||||
}
|
||||
|
||||
private static BigDecimal orZero(final BigDecimal value) {
|
||||
return value == null ? BigDecimal.ZERO : value;
|
||||
}
|
||||
|
||||
public void addNominee(final PartyNominee nominee) {
|
||||
nominee.setParty(this);
|
||||
this.nominees.add(nominee);
|
||||
}
|
||||
|
||||
public void resetNominees() {
|
||||
this.nominees.clear();
|
||||
}
|
||||
|
||||
public void changeClient(final Client newClient) {
|
||||
this.client = newClient;
|
||||
}
|
||||
|
||||
public void changeAgent(final Agent newAgent) {
|
||||
this.agent = newAgent;
|
||||
}
|
||||
|
||||
/**
|
||||
* Links this Party to an existing real Savings Account, resolved by account number in the write
|
||||
* service. There is no unlink - once a Party's DDS scheme is tied to a real account, it stays
|
||||
* tied.
|
||||
*/
|
||||
public void linkSavingsAccount(final Long savingsAccountId) {
|
||||
this.savingsAccountId = savingsAccountId;
|
||||
}
|
||||
|
||||
/** Numbers the account from its id, the same way 0514 numbered the accounts already open. */
|
||||
public void assignAccountNo() {
|
||||
if (this.accountNo == null && getId() != null) {
|
||||
this.accountNo = "DDS" + String.format("%09d", getId());
|
||||
}
|
||||
}
|
||||
|
||||
public BigDecimal credit(final BigDecimal amount) {
|
||||
this.currentBalance = this.currentBalance.add(amount);
|
||||
return this.currentBalance;
|
||||
}
|
||||
|
||||
public BigDecimal debit(final BigDecimal amount) {
|
||||
this.currentBalance = this.currentBalance.subtract(amount);
|
||||
return this.currentBalance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Turns a minor's account over to its holder, now that they have come of age and been identified.
|
||||
*
|
||||
* Until this the guardian operates the account and the bank deals with them. After it the customer
|
||||
* holds it in their own right, so the guardian is kept only as a record of who stood for them
|
||||
* before - the account is no longer theirs to operate.
|
||||
*
|
||||
* Not done on the birthday alone. An eighteen-year-old the bank has not yet identified is somebody
|
||||
* it cannot pay, so the turnover waits on their own KYC being verified.
|
||||
*/
|
||||
public void becomeAdult() {
|
||||
this.adultMinor = ADULT;
|
||||
}
|
||||
|
||||
public boolean isMinor() {
|
||||
return MINOR.equalsIgnoreCase(this.adultMinor);
|
||||
}
|
||||
|
||||
private static final String MINOR = "Minor";
|
||||
private static final String ADULT = "Adult";
|
||||
|
||||
public boolean isClosed() {
|
||||
return STATUS_CLOSED.equals(this.status);
|
||||
}
|
||||
|
||||
/**
|
||||
* Closes this Party's account as of the given date. The balance must already be zero - a Party
|
||||
* is settled to zero (a full Withdraw Deposite/payout) before it is closed, not closed with money
|
||||
* still owed to it.
|
||||
*/
|
||||
public void close(final LocalDate closeDate) {
|
||||
this.status = STATUS_CLOSED;
|
||||
this.closeDate = closeDate;
|
||||
}
|
||||
|
||||
/**
|
||||
* Interest Calculation: parks the interest earned since {@code interestDate} in the account's
|
||||
* accrued-interest figure - the legacy screen's "Int.Calc" - and stamps the date interest is now
|
||||
* calculated up to. The balance is untouched, because interest is not the customer's to draw on
|
||||
* until it is posted.
|
||||
*
|
||||
* The stamp is what keeps this safe to re-run: a second calculation for the same date finds no
|
||||
* days left to accrue, so the same interest cannot be earned twice.
|
||||
*/
|
||||
public void accrueInterest(final BigDecimal amount, final LocalDate throughDate, final boolean odInterest) {
|
||||
if (odInterest) {
|
||||
this.odInterestCalc = this.odInterestCalc.add(amount);
|
||||
this.odInterestDate = throughDate;
|
||||
} else {
|
||||
this.interestCalc = this.interestCalc.add(amount);
|
||||
this.interestDate = throughDate;
|
||||
}
|
||||
}
|
||||
|
||||
/** How far the given interest stream has been calculated through - where the next run starts from. */
|
||||
public LocalDate interestCalculatedThrough(final boolean odInterest) {
|
||||
return odInterest ? this.odInterestDate : this.interestDate;
|
||||
}
|
||||
|
||||
/** What the given interest stream is holding, waiting to be posted. */
|
||||
public BigDecimal accruedInterest(final boolean odInterest) {
|
||||
return odInterest ? this.odInterestCalc : this.interestCalc;
|
||||
}
|
||||
|
||||
/**
|
||||
* Interest Posting: moves the given amount out of accrued interest and into the balance, and
|
||||
* returns the new balance.
|
||||
*
|
||||
* The amount is the one the run previewed rather than whatever is accrued at this moment, so what
|
||||
* gets credited is always what was seen and approved. Since it comes off the accrued figure, a
|
||||
* second posting of the same interest finds nothing left to move.
|
||||
*/
|
||||
public BigDecimal postInterest(final BigDecimal amount, final boolean odInterest) {
|
||||
if (odInterest) {
|
||||
this.odInterestCalc = this.odInterestCalc.subtract(amount);
|
||||
} else {
|
||||
this.interestCalc = this.interestCalc.subtract(amount);
|
||||
}
|
||||
this.currentBalance = this.currentBalance.add(amount);
|
||||
return this.currentBalance;
|
||||
}
|
||||
|
||||
public Long clientId() {
|
||||
return this.client.getId();
|
||||
}
|
||||
|
||||
public Long agentId() {
|
||||
return this.agent.getId();
|
||||
}
|
||||
|
||||
public Map<String, Object> update(final JsonCommand command) {
|
||||
|
||||
final Map<String, Object> actualChanges = new LinkedHashMap<>(40);
|
||||
|
||||
if (command.isChangeInLongParameterNamed("clientId", this.client.getId())) {
|
||||
actualChanges.put("clientId", command.longValueOfParameterNamed("clientId"));
|
||||
}
|
||||
if (command.isChangeInLongParameterNamed("agentId", this.agent.getId())) {
|
||||
actualChanges.put("agentId", command.longValueOfParameterNamed("agentId"));
|
||||
}
|
||||
|
||||
stringChange(command, actualChanges, "subType", this.subType, v -> this.subType = v);
|
||||
stringChange(command, actualChanges, "lastAccount", this.lastAccount, v -> this.lastAccount = v);
|
||||
|
||||
if (command.isChangeInBooleanParameterNamed("nominal", this.nominal)) {
|
||||
final boolean newValue = command.booleanPrimitiveValueOfParameterNamed("nominal");
|
||||
actualChanges.put("nominal", newValue);
|
||||
this.nominal = newValue;
|
||||
}
|
||||
|
||||
stringChange(command, actualChanges, "aadharNo", this.aadharNo, v -> this.aadharNo = v);
|
||||
stringChange(command, actualChanges, "partyName", this.partyName, v -> this.partyName = v);
|
||||
stringChange(command, actualChanges, "partyName1", this.partyName1, v -> this.partyName1 = v);
|
||||
stringChange(command, actualChanges, "address1", this.address1, v -> this.address1 = v);
|
||||
stringChange(command, actualChanges, "address2", this.address2, v -> this.address2 = v);
|
||||
stringChange(command, actualChanges, "address3", this.address3, v -> this.address3 = v);
|
||||
stringChange(command, actualChanges, "city", this.city, v -> this.city = v);
|
||||
stringChange(command, actualChanges, "pincode", this.pincode, v -> this.pincode = v);
|
||||
stringChange(command, actualChanges, "gender", this.gender, v -> this.gender = v);
|
||||
stringChange(command, actualChanges, "panCardNo", this.panCardNo, v -> this.panCardNo = v);
|
||||
stringChange(command, actualChanges, "telephone", this.telephone, v -> this.telephone = v);
|
||||
stringChange(command, actualChanges, "mobileNoSms", this.mobileNoSms, v -> this.mobileNoSms = v);
|
||||
stringChange(command, actualChanges, "operation", this.operation, v -> this.operation = v);
|
||||
|
||||
if (command.isChangeInDateParameterNamed("birthDate", this.birthDate)) {
|
||||
actualChanges.put("birthDate", command.stringValueOfParameterNamed("birthDate"));
|
||||
this.birthDate = command.localDateValueOfParameterNamed("birthDate");
|
||||
}
|
||||
|
||||
stringChange(command, actualChanges, "occupation", this.occupation, v -> this.occupation = v);
|
||||
stringChange(command, actualChanges, "risk", this.risk, v -> this.risk = v);
|
||||
stringChange(command, actualChanges, "ckycId", this.ckycId, v -> this.ckycId = v);
|
||||
stringChange(command, actualChanges, "adultMinor", this.adultMinor, v -> this.adultMinor = v);
|
||||
|
||||
if (command.isChangeInDateParameterNamed("minorDate", this.minorDate)) {
|
||||
actualChanges.put("minorDate", command.stringValueOfParameterNamed("minorDate"));
|
||||
this.minorDate = command.localDateValueOfParameterNamed("minorDate");
|
||||
}
|
||||
|
||||
if (command.isChangeInLongParameterNamed("guardianClientId", this.guardianClientId)) {
|
||||
final Long newValue = command.longValueOfParameterNamed("guardianClientId");
|
||||
actualChanges.put("guardianClientId", newValue);
|
||||
this.guardianClientId = newValue;
|
||||
}
|
||||
|
||||
stringChange(command, actualChanges, "minAccountOpt", this.minAccountOpt, v -> this.minAccountOpt = v);
|
||||
stringChange(command, actualChanges, "relation", this.relation, v -> this.relation = v);
|
||||
|
||||
if (command.isChangeInDateParameterNamed("openingDate", this.openingDate)) {
|
||||
actualChanges.put("openingDate", command.stringValueOfParameterNamed("openingDate"));
|
||||
this.openingDate = command.localDateValueOfParameterNamed("openingDate");
|
||||
}
|
||||
|
||||
if (command.isChangeInIntegerParameterNamed("month", this.month)) {
|
||||
final Integer newValue = command.integerValueOfParameterNamed("month");
|
||||
actualChanges.put("month", newValue);
|
||||
this.month = newValue;
|
||||
}
|
||||
|
||||
if (command.isChangeInDateParameterNamed("reopenDate", this.reopenDate)) {
|
||||
actualChanges.put("reopenDate", command.stringValueOfParameterNamed("reopenDate"));
|
||||
this.reopenDate = command.localDateValueOfParameterNamed("reopenDate");
|
||||
}
|
||||
|
||||
if (command.isChangeInBigDecimalParameterNamed("depositAmount", this.depositAmount)) {
|
||||
final BigDecimal newValue = command.bigDecimalValueOfParameterNamed("depositAmount");
|
||||
actualChanges.put("depositAmount", newValue);
|
||||
this.depositAmount = newValue;
|
||||
}
|
||||
|
||||
if (command.isChangeInBigDecimalParameterNamed("dailyDepositAmount", this.dailyDepositAmount)) {
|
||||
final BigDecimal newValue = command.bigDecimalValueOfParameterNamed("dailyDepositAmount");
|
||||
actualChanges.put("dailyDepositAmount", newValue);
|
||||
this.dailyDepositAmount = newValue;
|
||||
}
|
||||
|
||||
if (command.isChangeInIntegerParameterNamed("days", this.days)) {
|
||||
final Integer newValue = command.integerValueOfParameterNamed("days");
|
||||
actualChanges.put("days", newValue);
|
||||
this.days = newValue;
|
||||
}
|
||||
|
||||
// The rate is not edited here: it is the scheme's, taken when the account is opened or moved
|
||||
// to another scheme - see takeSchemeRate.
|
||||
|
||||
stringChange(command, actualChanges, "ledgerNo", this.ledgerNo, v -> this.ledgerNo = v);
|
||||
stringChange(command, actualChanges, "withdrawType", this.withdrawType, v -> this.withdrawType = v);
|
||||
|
||||
if (command.isChangeInBooleanParameterNamed("lien", this.lien)) {
|
||||
final boolean newValue = command.booleanPrimitiveValueOfParameterNamed("lien");
|
||||
actualChanges.put("lien", newValue);
|
||||
this.lien = newValue;
|
||||
}
|
||||
|
||||
stringChange(command, actualChanges, "lienReason", this.lienReason, v -> this.lienReason = v);
|
||||
|
||||
// A released account explains nothing, so the reason goes with the hold. Leaving it behind
|
||||
// would have the screen read "Lien: No, held for Loan #1234" - a sentence that contradicts
|
||||
// itself, and which somebody will one day read as the account still being held.
|
||||
//
|
||||
// Nothing is lost: what it was held for, who released it and when are all on the command the
|
||||
// release rode in on, which maker-checker keeps.
|
||||
if (!this.lien && this.lienReason != null) {
|
||||
actualChanges.put("lienReason", null);
|
||||
this.lienReason = null;
|
||||
}
|
||||
|
||||
if (command.isChangeInDateParameterNamed("payDate", this.payDate)) {
|
||||
actualChanges.put("payDate", command.stringValueOfParameterNamed("payDate"));
|
||||
this.payDate = command.localDateValueOfParameterNamed("payDate");
|
||||
}
|
||||
|
||||
if (command.isChangeInBigDecimalParameterNamed("paymentAmount", this.paymentAmount)) {
|
||||
final BigDecimal newValue = command.bigDecimalValueOfParameterNamed("paymentAmount");
|
||||
actualChanges.put("paymentAmount", newValue);
|
||||
this.paymentAmount = newValue;
|
||||
}
|
||||
|
||||
if (command.isChangeInBigDecimalParameterNamed("openingBalance", this.openingBalance)) {
|
||||
final BigDecimal newValue = command.bigDecimalValueOfParameterNamed("openingBalance");
|
||||
actualChanges.put("openingBalance", newValue);
|
||||
this.openingBalance = newValue;
|
||||
}
|
||||
|
||||
if (command.isChangeInBooleanParameterNamed("isSmsActive", this.isSmsActive)) {
|
||||
final boolean newValue = command.booleanPrimitiveValueOfParameterNamed("isSmsActive");
|
||||
actualChanges.put("isSmsActive", newValue);
|
||||
this.isSmsActive = newValue;
|
||||
}
|
||||
|
||||
if (command.isChangeInBooleanParameterNamed("isEmailActive", this.isEmailActive)) {
|
||||
final boolean newValue = command.booleanPrimitiveValueOfParameterNamed("isEmailActive");
|
||||
actualChanges.put("isEmailActive", newValue);
|
||||
this.isEmailActive = newValue;
|
||||
}
|
||||
|
||||
if (command.isChangeInDateParameterNamed("interestDate", this.interestDate)) {
|
||||
actualChanges.put("interestDate", command.stringValueOfParameterNamed("interestDate"));
|
||||
this.interestDate = command.localDateValueOfParameterNamed("interestDate");
|
||||
}
|
||||
|
||||
stringChange(command, actualChanges, "spDescription", this.spDescription, v -> this.spDescription = v);
|
||||
stringChange(command, actualChanges, "freezeCode", this.freezeCode, v -> this.freezeCode = v);
|
||||
stringChange(command, actualChanges, "advCode", this.advCode, v -> this.advCode = v);
|
||||
stringChange(command, actualChanges, "creditToBranch", this.creditToBranch, v -> this.creditToBranch = v);
|
||||
stringChange(command, actualChanges, "creditToAccountType", this.creditToAccountType, v -> this.creditToAccountType = v);
|
||||
stringChange(command, actualChanges, "creditToAccount", this.creditToAccount, v -> this.creditToAccount = v);
|
||||
|
||||
if (command.isChangeInBooleanParameterNamed("nomineeApplicable", this.nomineeApplicable)) {
|
||||
final boolean newValue = command.booleanPrimitiveValueOfParameterNamed("nomineeApplicable");
|
||||
actualChanges.put("nomineeApplicable", newValue);
|
||||
this.nomineeApplicable = newValue;
|
||||
}
|
||||
|
||||
stringChange(command, actualChanges, "nomineeSplitMode", this.nomineeSplitMode, v -> this.nomineeSplitMode = v);
|
||||
|
||||
// Correcting a term, an instalment or the rate has to move the maturity figures with it -
|
||||
// otherwise the account keeps quoting what it was worth under the old terms.
|
||||
final LocalDate maturityDateBefore = this.maturityDate;
|
||||
final BigDecimal maturityAmountBefore = this.maturityAmount;
|
||||
recalculateTerm();
|
||||
if (!java.util.Objects.equals(maturityDateBefore, this.maturityDate)) {
|
||||
actualChanges.put("maturityDate", this.maturityDate);
|
||||
}
|
||||
if (maturityAmountBefore == null || this.maturityAmount.compareTo(maturityAmountBefore) != 0) {
|
||||
actualChanges.put("maturityAmount", this.maturityAmount);
|
||||
}
|
||||
|
||||
return actualChanges;
|
||||
}
|
||||
|
||||
private void stringChange(final JsonCommand command, final Map<String, Object> actualChanges, final String paramName,
|
||||
final String existingValue, final Consumer<String> setter) {
|
||||
if (command.isChangeInStringParameterNamed(paramName, existingValue)) {
|
||||
final String newValue = command.stringValueOfParameterNamed(paramName);
|
||||
actualChanges.put(paramName, newValue);
|
||||
setter.accept(newValue);
|
||||
}
|
||||
}
|
||||
}
|
||||
+146
@@ -0,0 +1,146 @@
|
||||
/**
|
||||
* 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.dds.party.domain;
|
||||
|
||||
import jakarta.persistence.Column;
|
||||
import jakarta.persistence.Entity;
|
||||
import jakarta.persistence.JoinColumn;
|
||||
import jakarta.persistence.ManyToOne;
|
||||
import jakarta.persistence.Table;
|
||||
import java.math.BigDecimal;
|
||||
import java.time.LocalDate;
|
||||
import lombok.Getter;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.apache.fineract.infrastructure.core.domain.AbstractAuditableCustom;
|
||||
|
||||
/**
|
||||
* A single nominee recorded against a {@link Party}. Maker-checker on nominee edits is enforced at
|
||||
* the command layer (the whole Party update goes through the standard maker-checker command flow),
|
||||
* not on this child row individually.
|
||||
*
|
||||
* Audited in its own right rather than only through the party: this row decides who receives a
|
||||
* customer's money after them, and "the party changed at 16:19" does not say that the person named
|
||||
* to receive it was replaced, nor by whom.
|
||||
*/
|
||||
@Getter
|
||||
@Entity
|
||||
@Table(name = "m_dds_party_nominee")
|
||||
public class PartyNominee extends AbstractAuditableCustom {
|
||||
|
||||
@ManyToOne
|
||||
@JoinColumn(name = "party_id", nullable = false)
|
||||
private Party party;
|
||||
|
||||
@Column(name = "nomination_date", nullable = false)
|
||||
private LocalDate nominationDate;
|
||||
|
||||
@Column(name = "name", length = 100, nullable = false)
|
||||
private String name;
|
||||
|
||||
@Column(name = "mobile_no", length = 20)
|
||||
private String mobileNo;
|
||||
|
||||
@Column(name = "birth_date")
|
||||
private LocalDate birthDate;
|
||||
|
||||
/**
|
||||
* Whether this nominee was under age when nominated, worked out from their date of birth rather
|
||||
* than asked for.
|
||||
*
|
||||
* Asked for, it was got wrong: a ten-year-old was recorded as not a minor, and so no guardian
|
||||
* was required for them. The date of birth is captured either way and already holds the answer,
|
||||
* so the clerk is not asked a second time in a form that can disagree with the first.
|
||||
*
|
||||
* Kept as a stored column rather than worked out on reading, because it is the age at the
|
||||
* moment of nomination that the record is of - a nominee who has since come of age was still a
|
||||
* minor on the day they were named, and the guardian named beside them belongs to that day.
|
||||
*/
|
||||
@Column(name = "minor", nullable = false)
|
||||
private boolean minor;
|
||||
|
||||
/** India's age of majority, which is what makes a nominee one who needs a guardian named. */
|
||||
private static final int AGE_OF_MAJORITY = 18;
|
||||
|
||||
@Column(name = "relation", length = 40, nullable = false)
|
||||
private String relation;
|
||||
|
||||
@Column(name = "gender", length = 20, nullable = false)
|
||||
private String gender;
|
||||
|
||||
@Column(name = "guardian_name", length = 100)
|
||||
private String guardianName;
|
||||
|
||||
/**
|
||||
* What this nominee is entitled to, under a Percentage split. Null under a Sequence split, where
|
||||
* the order the nominees are held in is the entitlement and there is no share to state.
|
||||
*/
|
||||
@Column(name = "share_percent", precision = 5, scale = 2)
|
||||
private BigDecimal sharePercent;
|
||||
|
||||
/**
|
||||
* Where this nominee stands in the order the bank pays, under a Sequence split. Null under a
|
||||
* Percentage split, where everyone is paid at once and there is no first.
|
||||
*/
|
||||
@Column(name = "sequence_no")
|
||||
private Integer sequenceNo;
|
||||
|
||||
protected PartyNominee() {
|
||||
//
|
||||
}
|
||||
|
||||
public PartyNominee(final LocalDate nominationDate, final String name, final String mobileNo, final LocalDate birthDate,
|
||||
final String relation, final String gender, final String guardianName, final BigDecimal sharePercent,
|
||||
final Integer sequenceNo) {
|
||||
this.nominationDate = nominationDate;
|
||||
// Trimmed on the way in. A relation typed as "friend " is a different value from "friend"
|
||||
// to everything that groups or matches on it, and the trailing space is invisible on screen
|
||||
// - so the two read as the same relation everywhere except where it counts.
|
||||
this.name = StringUtils.trimToNull(name);
|
||||
this.mobileNo = StringUtils.trimToNull(mobileNo);
|
||||
this.birthDate = birthDate;
|
||||
this.minor = isUnderAgeOn(birthDate, nominationDate);
|
||||
this.relation = StringUtils.trimToNull(relation);
|
||||
this.gender = StringUtils.trimToNull(gender);
|
||||
this.guardianName = StringUtils.trimToNull(guardianName);
|
||||
this.sharePercent = sharePercent;
|
||||
this.sequenceNo = sequenceNo;
|
||||
}
|
||||
|
||||
void setParty(final Party party) {
|
||||
this.party = party;
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether someone born on the given day was still under age on the day they were nominated.
|
||||
*
|
||||
* Measured against the nomination date rather than today, so a nomination reads the same in ten
|
||||
* years as it did when it was made - and a nominee who has since come of age does not quietly
|
||||
* lose the guardian who was named for them at the time.
|
||||
*
|
||||
* A missing date of birth is treated as not a minor: the field is required, so a null here can
|
||||
* only be a record made before it was, and guessing "minor" would demand a guardian for someone
|
||||
* who may well be eighty.
|
||||
*/
|
||||
public static boolean isUnderAgeOn(final LocalDate birthDate, final LocalDate nominationDate) {
|
||||
if (birthDate == null || nominationDate == null) {
|
||||
return false;
|
||||
}
|
||||
return birthDate.isAfter(nominationDate.minusYears(AGE_OF_MAJORITY));
|
||||
}
|
||||
}
|
||||
+32
@@ -0,0 +1,32 @@
|
||||
/**
|
||||
* 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.dds.party.exception;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformDomainRuleException;
|
||||
|
||||
/**
|
||||
* Thrown when a Close Party command, or a Party Tran collection, targets a Party that is already
|
||||
* closed.
|
||||
*/
|
||||
public class PartyAlreadyClosedException extends AbstractPlatformDomainRuleException {
|
||||
|
||||
public PartyAlreadyClosedException(final String partyCode) {
|
||||
super("error.msg.party.already.closed", "Party " + partyCode + " is already closed", partyCode);
|
||||
}
|
||||
}
|
||||
+32
@@ -0,0 +1,32 @@
|
||||
/**
|
||||
* 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.dds.party.exception;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformDomainRuleException;
|
||||
|
||||
/**
|
||||
* Thrown when a Close Party command is attempted while the Party's balance is still non-zero - the
|
||||
* remaining balance must be paid out (a Withdraw Deposite to zero) before the account can be closed.
|
||||
*/
|
||||
public class PartyHasBalanceException extends AbstractPlatformDomainRuleException {
|
||||
|
||||
public PartyHasBalanceException(final String partyCode) {
|
||||
super("error.msg.party.has.balance", "Party " + partyCode + " still has a non-zero balance and cannot be closed", partyCode);
|
||||
}
|
||||
}
|
||||
+40
@@ -0,0 +1,40 @@
|
||||
/**
|
||||
* 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.dds.party.exception;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformResourceNotFoundException;
|
||||
import org.springframework.dao.EmptyResultDataAccessException;
|
||||
|
||||
/**
|
||||
* A {@link RuntimeException} thrown when a DDS party resource is not found.
|
||||
*/
|
||||
public class PartyNotFoundException extends AbstractPlatformResourceNotFoundException {
|
||||
|
||||
public PartyNotFoundException(final Long id) {
|
||||
super("error.msg.party.id.invalid", "Party with identifier " + id + " does not exist", id);
|
||||
}
|
||||
|
||||
public PartyNotFoundException(final Long id, final EmptyResultDataAccessException e) {
|
||||
super("error.msg.party.id.invalid", "Party with identifier " + id + " does not exist", id, e);
|
||||
}
|
||||
|
||||
public PartyNotFoundException(final String partyCode) {
|
||||
super("error.msg.party.code.invalid", "Party with code " + partyCode + " does not exist", partyCode);
|
||||
}
|
||||
}
|
||||
+33
@@ -0,0 +1,33 @@
|
||||
/**
|
||||
* 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.dds.party.exception;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformDomainRuleException;
|
||||
|
||||
/**
|
||||
* Thrown when the savingsAccountNo given for a Party belongs to a different client than the Party's
|
||||
* own clientId - a Party can only be linked to its own client's savings account.
|
||||
*/
|
||||
public class PartySavingsAccountClientMismatchException extends AbstractPlatformDomainRuleException {
|
||||
|
||||
public PartySavingsAccountClientMismatchException(final String savingsAccountNo) {
|
||||
super("error.msg.party.savings.account.client.mismatch",
|
||||
"Savings account " + savingsAccountNo + " does not belong to this party's client", savingsAccountNo);
|
||||
}
|
||||
}
|
||||
+32
@@ -0,0 +1,32 @@
|
||||
/**
|
||||
* 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.dds.party.exception;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformResourceNotFoundException;
|
||||
|
||||
/**
|
||||
* Thrown when a Party's savingsAccountNo does not match any non-closed Savings Account.
|
||||
*/
|
||||
public class PartySavingsAccountNotFoundException extends AbstractPlatformResourceNotFoundException {
|
||||
|
||||
public PartySavingsAccountNotFoundException(final String savingsAccountNo) {
|
||||
super("error.msg.party.savings.account.not.found", "No open savings account found with account number " + savingsAccountNo,
|
||||
savingsAccountNo);
|
||||
}
|
||||
}
|
||||
+38
@@ -0,0 +1,38 @@
|
||||
/**
|
||||
* 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.dds.party.exception;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformDomainRuleException;
|
||||
|
||||
/**
|
||||
* Thrown when a Party's subType is not the code of an active DDS Account Type.
|
||||
*
|
||||
* The Party screen's Sub Type is chosen from the DDS Account Type master, so an unknown code means
|
||||
* the caller invented one, and a deactivated code means the scheme has been retired - existing
|
||||
* parties on it keep running, but no new party may be opened under it.
|
||||
*/
|
||||
public class PartySubTypeNotActiveException extends AbstractPlatformDomainRuleException {
|
||||
|
||||
public PartySubTypeNotActiveException(final String subType, final boolean exists) {
|
||||
super(exists ? "error.msg.party.sub.type.not.active" : "error.msg.party.sub.type.invalid",
|
||||
exists ? "Account type " + subType + " has been deactivated, so no new party can be opened under it"
|
||||
: "There is no DDS account type with the code " + subType,
|
||||
subType);
|
||||
}
|
||||
}
|
||||
+45
@@ -0,0 +1,45 @@
|
||||
/**
|
||||
* 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.dds.report.data;
|
||||
|
||||
import java.io.Serial;
|
||||
import java.io.Serializable;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import lombok.Builder;
|
||||
import lombok.Getter;
|
||||
|
||||
/**
|
||||
* A generic tabular result shape shared by every DDS report - one column list plus one row list, both
|
||||
* keyed the same way, so a single report viewer screen can render any of them without a bespoke
|
||||
* result type per report.
|
||||
*/
|
||||
@Getter
|
||||
@Builder
|
||||
public final class DdsReportData implements Serializable {
|
||||
|
||||
@Serial
|
||||
private static final long serialVersionUID = 1L;
|
||||
|
||||
private final String reportKey;
|
||||
private final boolean available;
|
||||
private final String message;
|
||||
private final List<String> columns;
|
||||
private final List<Map<String, Object>> rows;
|
||||
}
|
||||
+54
@@ -0,0 +1,54 @@
|
||||
/**
|
||||
* 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.dds.transaction.data;
|
||||
|
||||
import java.io.Serial;
|
||||
import java.io.Serializable;
|
||||
import java.math.BigDecimal;
|
||||
import java.time.LocalDate;
|
||||
import lombok.Builder;
|
||||
import lombok.Getter;
|
||||
|
||||
@Getter
|
||||
@Builder
|
||||
public final class PartyTransactionData implements Serializable {
|
||||
|
||||
@Serial
|
||||
private static final long serialVersionUID = 1L;
|
||||
|
||||
private final Long id;
|
||||
private final Long partyId;
|
||||
private final String partyCode;
|
||||
private final String partyName;
|
||||
private final Long agentId;
|
||||
private final String agentCode;
|
||||
private final LocalDate transactionDate;
|
||||
private final String transactionType;
|
||||
private final String direction;
|
||||
private final String transactionMode;
|
||||
private final String accountType;
|
||||
private final String accountNo;
|
||||
private final BigDecimal amount;
|
||||
private final String chequeNo;
|
||||
private final String tokenNo;
|
||||
private final String description;
|
||||
private final BigDecimal balanceAfterTransaction;
|
||||
/** The DDS voucher this line moved under, e.g. DDS/29092026/0001; empty on lines from before vouchers. */
|
||||
private final String voucherNo;
|
||||
}
|
||||
+106
@@ -0,0 +1,106 @@
|
||||
/**
|
||||
* 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.dds.transaction.domain;
|
||||
|
||||
import java.util.Arrays;
|
||||
import java.util.List;
|
||||
import java.util.regex.Pattern;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
/**
|
||||
* How money changed hands on a DDS entry: over the counter, by book transfer, or through clearing.
|
||||
*
|
||||
* It exists because the mode used to be a free-text field. The screen only ever offered these three,
|
||||
* but nothing behind the screen said so, and the column filled up with two spellings of the same
|
||||
* word - `Cash` from one path and `CASH` from another. A cash book that groups by mode then reports
|
||||
* the same day's takings twice under two headings, which is the kind of discrepancy someone spends
|
||||
* an afternoon chasing before finding it was never a discrepancy at all.
|
||||
*
|
||||
* So the list lives here, once, and both the validator and the write service read it from here. What
|
||||
* a caller sends is matched without regard to case or surrounding space, because an integration
|
||||
* sending `cash` is unambiguous and rejecting it would be pedantry; but what gets stored is always
|
||||
* the label below, so the column only ever holds one spelling of each.
|
||||
*
|
||||
* Only entries a person makes carry a mode. Interest, commission and maturity postings are the
|
||||
* system's own work - no cash, no cheque, nothing to record - and a transfer between two DDS accounts
|
||||
* moves nothing across the counter either, so those are left null rather than labelled.
|
||||
*/
|
||||
public enum DdsTransactionMode {
|
||||
|
||||
CASH("Cash"), //
|
||||
TRANSFER("Transfer"), //
|
||||
CLEARING("Clearing");
|
||||
|
||||
private final String label;
|
||||
|
||||
DdsTransactionMode(final String label) {
|
||||
this.label = label;
|
||||
}
|
||||
|
||||
/** The one spelling that is ever stored or shown for this mode. */
|
||||
public String getLabel() {
|
||||
return this.label;
|
||||
}
|
||||
|
||||
/**
|
||||
* The mode a caller's text names, or null if it names none of them. Case and surrounding space
|
||||
* are ignored; anything else is a mode this scheme does not have.
|
||||
*/
|
||||
public static DdsTransactionMode fromLabel(final String value) {
|
||||
if (value == null) {
|
||||
return null;
|
||||
}
|
||||
final String trimmed = value.trim();
|
||||
return Arrays.stream(values()).filter(mode -> mode.label.equalsIgnoreCase(trimmed)).findFirst().orElse(null);
|
||||
}
|
||||
|
||||
/**
|
||||
* The stored form of what a caller sent: the canonical label when it names a mode, and the value
|
||||
* untouched when it does not.
|
||||
*
|
||||
* Unknown text is passed through rather than blanked because this is called after validation has
|
||||
* already refused it - a silent blanking here would only hide a bug in the order of the two.
|
||||
*/
|
||||
public static String canonicalOrOriginal(final String value) {
|
||||
final DdsTransactionMode mode = fromLabel(value);
|
||||
return mode == null ? value : mode.label;
|
||||
}
|
||||
|
||||
/** The labels, in the order the entry screen lists them - for error messages and for callers. */
|
||||
public static List<String> labels() {
|
||||
return Arrays.stream(values()).map(DdsTransactionMode::getLabel).toList();
|
||||
}
|
||||
|
||||
/** The labels as a reader sees them in a sentence: "Cash, Transfer, Clearing". */
|
||||
public static String labelsForMessage() {
|
||||
return String.join(", ", labels());
|
||||
}
|
||||
|
||||
/**
|
||||
* The same rule as {@link #fromLabel}, expressed as a regular expression, for the validator to
|
||||
* apply - it reports a failed pattern with the parameter and message already filled in, which a
|
||||
* hand-rolled check cannot do as tidily.
|
||||
*
|
||||
* Built from the labels rather than written out, so the two ways of asking the same question
|
||||
* cannot answer it differently: add a mode above and both move together.
|
||||
*/
|
||||
public static String acceptedPattern() {
|
||||
return Arrays.stream(values()).map(mode -> Pattern.quote(mode.label)).collect(Collectors.joining("|", "(?i)\\s*(", ")\\s*"));
|
||||
}
|
||||
}
|
||||
+122
@@ -0,0 +1,122 @@
|
||||
/**
|
||||
* 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.dds.transaction.domain;
|
||||
|
||||
import jakarta.persistence.Column;
|
||||
import jakarta.persistence.Entity;
|
||||
import jakarta.persistence.JoinColumn;
|
||||
import jakarta.persistence.ManyToOne;
|
||||
import jakarta.persistence.PostPersist;
|
||||
import jakarta.persistence.Table;
|
||||
import java.math.BigDecimal;
|
||||
import java.time.LocalDate;
|
||||
import lombok.Getter;
|
||||
import org.apache.fineract.infrastructure.core.domain.AbstractAuditableCustom;
|
||||
import org.apache.fineract.organisation.agent.domain.Agent;
|
||||
import org.apache.fineract.portfolio.dds.party.domain.Party;
|
||||
import org.apache.fineract.portfolio.dds.voucher.DdsVoucherScope;
|
||||
|
||||
/**
|
||||
* A single posted entry on the DDS ledger: a Party's day's collection ("Party Tran", direction
|
||||
* CREDIT), one leg of a "Withdraw Deposite" transfer between two parties (the creditor leg CREDIT,
|
||||
* the debtor leg DEBIT), or an Agent's settlement of collected cash to its branch ("Agent Tran",
|
||||
* direction DEBIT - no {@link Party} involved, so {@code party} is null for this type).
|
||||
* {@code balanceAfterTransaction} holds the Party's balance for Party-linked rows, or the Agent's
|
||||
* balance for an Agent Tran row. Immutable once posted - like any transaction, it is reversed with
|
||||
* an opposing entry, not edited, so there is deliberately no update API for this entity.
|
||||
*/
|
||||
@Getter
|
||||
@Entity
|
||||
@Table(name = "m_dds_party_transaction")
|
||||
public class PartyTransaction extends AbstractAuditableCustom {
|
||||
|
||||
@ManyToOne
|
||||
@JoinColumn(name = "party_id")
|
||||
private Party party;
|
||||
|
||||
@ManyToOne
|
||||
@JoinColumn(name = "agent_id", nullable = false)
|
||||
private Agent agent;
|
||||
|
||||
@Column(name = "transaction_date", nullable = false)
|
||||
private LocalDate transactionDate;
|
||||
|
||||
@Column(name = "transaction_type", length = 30, nullable = false)
|
||||
private String transactionType;
|
||||
|
||||
@Column(name = "direction", length = 10, nullable = false)
|
||||
private String direction;
|
||||
|
||||
@Column(name = "transaction_mode", length = 20)
|
||||
private String transactionMode;
|
||||
|
||||
@Column(name = "account_type", length = 100)
|
||||
private String accountType;
|
||||
|
||||
@Column(name = "account_no", length = 50)
|
||||
private String accountNo;
|
||||
|
||||
@Column(name = "amount", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal amount;
|
||||
|
||||
@Column(name = "cheque_no", length = 40)
|
||||
private String chequeNo;
|
||||
|
||||
@Column(name = "token_no", length = 40)
|
||||
private String tokenNo;
|
||||
|
||||
@Column(name = "description", length = 500)
|
||||
private String description;
|
||||
|
||||
@Column(name = "balance_after_transaction", scale = 6, precision = 19, nullable = false)
|
||||
private BigDecimal balanceAfterTransaction;
|
||||
|
||||
protected PartyTransaction() {
|
||||
//
|
||||
}
|
||||
|
||||
public PartyTransaction(final Party party, final Agent agent, final LocalDate transactionDate, final String transactionType,
|
||||
final String direction, final String transactionMode, final String accountType, final String accountNo,
|
||||
final BigDecimal amount, final String chequeNo, final String tokenNo, final String description,
|
||||
final BigDecimal balanceAfterTransaction) {
|
||||
this.party = party;
|
||||
this.agent = agent;
|
||||
this.transactionDate = transactionDate;
|
||||
this.transactionType = transactionType;
|
||||
this.direction = direction;
|
||||
this.transactionMode = transactionMode;
|
||||
this.accountType = accountType;
|
||||
this.accountNo = accountNo;
|
||||
this.amount = amount;
|
||||
this.chequeNo = chequeNo;
|
||||
this.tokenNo = tokenNo;
|
||||
this.description = description;
|
||||
this.balanceAfterTransaction = balanceAfterTransaction;
|
||||
}
|
||||
|
||||
/**
|
||||
* Notes this line against the operation that wrote it, so the operation's voucher number can be
|
||||
* stamped on it. The voucher number itself is not mapped here: it is written once, by SQL, after
|
||||
* the voucher is raised, and a mapped field would be written back as null by any later save.
|
||||
*/
|
||||
@PostPersist
|
||||
private void recordInVoucherScope() {
|
||||
DdsVoucherScope.recordPartyTransaction(getId());
|
||||
}
|
||||
}
|
||||
+33
@@ -0,0 +1,33 @@
|
||||
/**
|
||||
* 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.dds.transaction.exception;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformDomainRuleException;
|
||||
|
||||
/**
|
||||
* Thrown when an Agent Tran settlement amount exceeds the Agent's current (collected but not yet
|
||||
* settled) balance.
|
||||
*/
|
||||
public class InsufficientAgentBalanceException extends AbstractPlatformDomainRuleException {
|
||||
|
||||
public InsufficientAgentBalanceException(final String agentCode) {
|
||||
super("error.msg.agent.insufficient.balance",
|
||||
"Agent " + agentCode + " does not have sufficient collected balance for this settlement", agentCode);
|
||||
}
|
||||
}
|
||||
+32
@@ -0,0 +1,32 @@
|
||||
/**
|
||||
* 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.dds.transaction.exception;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformDomainRuleException;
|
||||
|
||||
/**
|
||||
* Thrown when a Withdraw Deposite transfer would take the debtor Party's balance below zero.
|
||||
*/
|
||||
public class InsufficientPartyBalanceException extends AbstractPlatformDomainRuleException {
|
||||
|
||||
public InsufficientPartyBalanceException(final String partyCode) {
|
||||
super("error.msg.party.insufficient.balance", "Party " + partyCode + " does not have sufficient balance for this transfer",
|
||||
partyCode);
|
||||
}
|
||||
}
|
||||
+38
@@ -0,0 +1,38 @@
|
||||
/**
|
||||
* 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.dds.transaction.exception;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformDomainRuleException;
|
||||
|
||||
/**
|
||||
* Thrown when a transaction is posted against an agent who does not collect for the party named on
|
||||
* it.
|
||||
*
|
||||
* The balances would still come out right, but the transaction would be filed under the wrong
|
||||
* agent - and every agent-wise report is built from exactly that. An agent would show collections
|
||||
* and transfers for customers who are not theirs, and the officer reading the report has no way to
|
||||
* tell.
|
||||
*/
|
||||
public class PartyNotCollectedByAgentException extends AbstractPlatformDomainRuleException {
|
||||
|
||||
public PartyNotCollectedByAgentException(final String partyCode, final String agentCode) {
|
||||
super("error.msg.party.not.collected.by.agent", "Party " + partyCode + " is not collected by agent " + agentCode,
|
||||
partyCode, agentCode);
|
||||
}
|
||||
}
|
||||
+32
@@ -0,0 +1,32 @@
|
||||
/**
|
||||
* 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.dds.transaction.exception;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.exception.AbstractPlatformResourceNotFoundException;
|
||||
import org.springframework.dao.EmptyResultDataAccessException;
|
||||
|
||||
/**
|
||||
* A {@link RuntimeException} thrown when a DDS party transaction resource is not found.
|
||||
*/
|
||||
public class PartyTransactionNotFoundException extends AbstractPlatformResourceNotFoundException {
|
||||
|
||||
public PartyTransactionNotFoundException(final Long id, final EmptyResultDataAccessException e) {
|
||||
super("error.msg.partytransaction.id.invalid", "Party transaction with identifier " + id + " does not exist", id, e);
|
||||
}
|
||||
}
|
||||
+105
@@ -0,0 +1,105 @@
|
||||
/**
|
||||
* 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.dds.voucher;
|
||||
|
||||
import java.math.BigDecimal;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collections;
|
||||
import java.util.LinkedHashSet;
|
||||
import java.util.List;
|
||||
import java.util.Set;
|
||||
|
||||
/**
|
||||
* What one DDS operation moved, gathered while it runs so a single voucher can be raised for it at
|
||||
* the end.
|
||||
*
|
||||
* A payout, an early closure, a posting run or a transfer each writes several ledger legs and
|
||||
* passbook lines from several places - the interest brought up to date, the recovery, the payout
|
||||
* itself. The voucher is the slip for the whole operation, not for each leg, so the legs are noted
|
||||
* here as they are written and turned into one voucher when the operation finishes.
|
||||
*
|
||||
* Held per thread, since an operation runs on one thread from start to finish - including a posting
|
||||
* run handed to a background thread, which opens its own scope there. Outside a scope nothing is
|
||||
* recorded.
|
||||
*/
|
||||
public final class DdsVoucherScope {
|
||||
|
||||
/** A voucher side with no ledger leg behind it - a move between two accounts on the same GL. */
|
||||
public record Line(String entryType, Long glAccountId, String partyName, String accountNo, BigDecimal amount, String description) {}
|
||||
|
||||
private static final ThreadLocal<DdsVoucherScope> CURRENT = new ThreadLocal<>();
|
||||
|
||||
private final Set<String> ledgerTransactionIds = new LinkedHashSet<>();
|
||||
private final List<Long> partyTransactionIds = new ArrayList<>();
|
||||
private final List<Line> extraLines = new ArrayList<>();
|
||||
|
||||
private DdsVoucherScope() {}
|
||||
|
||||
/** The scope now open on this thread, or null. */
|
||||
public static DdsVoucherScope current() {
|
||||
return CURRENT.get();
|
||||
}
|
||||
|
||||
/** Opens a scope on this thread. The caller must {@link #close} it. */
|
||||
public static DdsVoucherScope open() {
|
||||
final DdsVoucherScope scope = new DdsVoucherScope();
|
||||
CURRENT.set(scope);
|
||||
return scope;
|
||||
}
|
||||
|
||||
public static void close() {
|
||||
CURRENT.remove();
|
||||
}
|
||||
|
||||
/** Notes a ledger transaction written for the operation in progress. */
|
||||
public static void recordLedgerTransaction(final String transactionId) {
|
||||
final DdsVoucherScope scope = CURRENT.get();
|
||||
if (scope != null && transactionId != null) {
|
||||
scope.ledgerTransactionIds.add(transactionId);
|
||||
}
|
||||
}
|
||||
|
||||
/** Notes a passbook line written for the operation in progress, so it can carry the voucher number. */
|
||||
public static void recordPartyTransaction(final Long partyTransactionId) {
|
||||
final DdsVoucherScope scope = CURRENT.get();
|
||||
if (scope != null && partyTransactionId != null) {
|
||||
scope.partyTransactionIds.add(partyTransactionId);
|
||||
}
|
||||
}
|
||||
|
||||
/** Adds a voucher side the ledger does not show - see {@link Line}. */
|
||||
public static void addLine(final Line line) {
|
||||
final DdsVoucherScope scope = CURRENT.get();
|
||||
if (scope != null && line != null) {
|
||||
scope.extraLines.add(line);
|
||||
}
|
||||
}
|
||||
|
||||
public Set<String> getLedgerTransactionIds() {
|
||||
return Collections.unmodifiableSet(this.ledgerTransactionIds);
|
||||
}
|
||||
|
||||
public List<Long> getPartyTransactionIds() {
|
||||
return Collections.unmodifiableList(this.partyTransactionIds);
|
||||
}
|
||||
|
||||
public List<Line> getExtraLines() {
|
||||
return Collections.unmodifiableList(this.extraLines);
|
||||
}
|
||||
}
|
||||
+10
@@ -432,6 +432,10 @@ public final class DepositsApiConstants {
|
||||
recurringDepositRequestData.add("prematureWithdrawalOption");
|
||||
recurringDepositRequestData.add("tenureFlexibility");
|
||||
recurringDepositRequestData.add("lienMarked");
|
||||
recurringDepositRequestData.add("lienPercentage");
|
||||
recurringDepositRequestData.add("missedInstallmentGraceDays");
|
||||
recurringDepositRequestData.add("missedInstallmentPenaltyType");
|
||||
recurringDepositRequestData.add("missedInstallmentPenaltyAmount");
|
||||
recurringDepositRequestData.add("withdrawalFeeForTransfers");
|
||||
recurringDepositRequestData.add("enableLockinPeriod");
|
||||
recurringDepositRequestData.add("maturityInstructions");
|
||||
@@ -491,6 +495,10 @@ public final class DepositsApiConstants {
|
||||
recurringDepositRequestData.add("prematureWithdrawalOption");
|
||||
recurringDepositRequestData.add("tenureFlexibility");
|
||||
recurringDepositRequestData.add("lienMarked");
|
||||
recurringDepositRequestData.add("lienPercentage");
|
||||
recurringDepositRequestData.add("missedInstallmentGraceDays");
|
||||
recurringDepositRequestData.add("missedInstallmentPenaltyType");
|
||||
recurringDepositRequestData.add("missedInstallmentPenaltyAmount");
|
||||
recurringDepositRequestData.add("maturityInstructions");
|
||||
recurringDepositRequestData.add("creditMaturityProceeds");
|
||||
recurringDepositRequestData.add("penaltyGracePeriodMissedInstallments");
|
||||
@@ -648,6 +656,8 @@ public final class DepositsApiConstants {
|
||||
recurringDepositRequestData.add(SavingsApiConstants.balanceSwapOptionParamName);
|
||||
recurringDepositRequestData.add(SavingsApiConstants.msmeParamName);
|
||||
recurringDepositRequestData.add(SavingsApiConstants.autoDebitFacilityParamName);
|
||||
// Lien Marked: how much of this deposit may be given as loan, capped by its product's percentage.
|
||||
recurringDepositRequestData.add("lienPercentage");
|
||||
recurringDepositRequestData.add(isSeniorCitizenParamName);
|
||||
recurringDepositRequestData.add(seniorCitizenInterestRateParamName);
|
||||
return recurringDepositRequestData;
|
||||
|
||||
+100
@@ -0,0 +1,100 @@
|
||||
/**
|
||||
* 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.savings;
|
||||
|
||||
import java.util.Locale;
|
||||
|
||||
/**
|
||||
* The deposit scheme a fixed deposit product is sold under, held as {@code m_savings_product.fd_type}.
|
||||
*
|
||||
* <p>
|
||||
* The three schemes differ in where a posting of interest ends up, which is what the interest posting
|
||||
* report has to show and the posting itself has to honour:
|
||||
*
|
||||
* <ul>
|
||||
* <li>{@link #SINGLE} — short deposits, priced from a slab table in days. Interest stays in the
|
||||
* deposit and is paid with the principal at maturity.</li>
|
||||
* <li>{@link #DOUBLE} — deposits of a year or more, priced from a slab table in years. Interest is
|
||||
* compounded back into the deposit, so the maturity value is principal plus interest.</li>
|
||||
* <li>{@link #SPECIAL} — the monthly income scheme. Interest is posted monthly and swept out to the
|
||||
* customer's linked savings account, which is why a special deposit cannot be opened without one;
|
||||
* the deposit itself matures at its principal, the interest having already been paid away.</li>
|
||||
* </ul>
|
||||
*
|
||||
* <p>
|
||||
* The database column is a string rather than an enum ordinal, so the names here are the stored
|
||||
* values and must not be renamed. {@link #fromString(String)} is lenient about case and blanks
|
||||
* because the column carries a default of SINGLE and older products predate the column entirely.
|
||||
*/
|
||||
public enum FixedDepositType {
|
||||
|
||||
/** Interest is held in the deposit and paid at maturity. The default for a product that names none. */
|
||||
SINGLE,
|
||||
/** Interest is compounded into the deposit; the maturity value includes it. */
|
||||
DOUBLE,
|
||||
/** Interest is posted monthly and transferred to the linked savings account. */
|
||||
SPECIAL;
|
||||
|
||||
/**
|
||||
* The scheme named by a stored {@code fd_type}, defaulting to {@link #SINGLE}.
|
||||
*
|
||||
* <p>
|
||||
* A null, blank or unrecognised value reads as SINGLE: that is the column's own default, and a
|
||||
* product carrying something else is a misconfiguration that must not stop its customers' interest
|
||||
* from being reported.
|
||||
*/
|
||||
public static FixedDepositType fromString(final String fdType) {
|
||||
if (fdType == null || fdType.isBlank()) {
|
||||
return SINGLE;
|
||||
}
|
||||
for (final FixedDepositType candidate : values()) {
|
||||
if (candidate.name().equalsIgnoreCase(fdType.trim())) {
|
||||
return candidate;
|
||||
}
|
||||
}
|
||||
return SINGLE;
|
||||
}
|
||||
|
||||
public static boolean isValid(final String fdType) {
|
||||
if (fdType == null || fdType.isBlank()) {
|
||||
return false;
|
||||
}
|
||||
for (final FixedDepositType candidate : values()) {
|
||||
if (candidate.name().equalsIgnoreCase(fdType.trim())) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/** Whether interest leaves the deposit for the linked savings account each time it is posted. */
|
||||
public boolean isPaidOutMonthly() {
|
||||
return this == SPECIAL;
|
||||
}
|
||||
|
||||
/** Whether a posting of interest adds to the deposit's own balance. */
|
||||
public boolean isRetainedInDeposit() {
|
||||
return this != SPECIAL;
|
||||
}
|
||||
|
||||
/** What a customer sees: "FD Special", "FD Double", "FD Single". */
|
||||
public String displayName() {
|
||||
return "FD " + name().charAt(0) + name().substring(1).toLowerCase(Locale.ENGLISH);
|
||||
}
|
||||
}
|
||||
+1
@@ -278,6 +278,7 @@ public class SavingsApiConstants {
|
||||
// Additional custom fields
|
||||
public static final String balanceFrequencyParamName = "balanceFrequency";
|
||||
public static final String accountClosedZeroBalanceInDayClosingParamName = "accountClosedZeroBalanceInDayClosing";
|
||||
public static final String productCategoryParamName = "productCategory";
|
||||
|
||||
// Current Product — new UI fields
|
||||
public static final String balanceSwapOptionParamName = "balanceSwapOption";
|
||||
|
||||
+14
@@ -234,6 +234,20 @@ public final class SavingsAccountData implements Serializable {
|
||||
return this.transferInterestToLinkedAccount;
|
||||
}
|
||||
|
||||
/**
|
||||
* True for a recurring deposit opened under a product whose Interest Calculation Type is "Simple": its interest
|
||||
* never compounds. Transient because it is only read by the batch interest-posting engine.
|
||||
*/
|
||||
private transient boolean simpleInterest;
|
||||
|
||||
public void setSimpleInterest(final boolean simpleInterest) {
|
||||
this.simpleInterest = simpleInterest;
|
||||
}
|
||||
|
||||
public boolean isSimpleInterest() {
|
||||
return this.simpleInterest;
|
||||
}
|
||||
|
||||
public static SavingsAccountData importInstanceIndividual(Long clientId, Long productId, Long fieldOfficerId, LocalDate submittedOnDate,
|
||||
BigDecimal nominalAnnualInterestRate, EnumOptionData interestCompoundingPeriodTypeEnum,
|
||||
EnumOptionData interestPostingPeriodTypeEnum, EnumOptionData interestCalculationTypeEnum,
|
||||
|
||||
+1
@@ -144,6 +144,7 @@ public final class SavingsProductData implements Serializable {
|
||||
@Getter @Setter private Boolean enableLockinPeriod;
|
||||
@Getter @Setter private String balanceFrequency;
|
||||
@Getter @Setter private Boolean accountClosedZeroBalanceInDayClosing;
|
||||
@Getter @Setter private String productCategory;
|
||||
|
||||
// New current product fields
|
||||
@Getter @Setter private Boolean balanceSwapOption;
|
||||
|
||||
+6
@@ -180,6 +180,12 @@ public final class SavingsHelper {
|
||||
immediateWithdrawalOfInterest);
|
||||
}
|
||||
|
||||
public Money calculateInterestForAllPostingPeriods(final MonetaryCurrency currency, final List<PostingPeriod> allPeriods,
|
||||
LocalDate accountLockedUntil, Boolean immediateWithdrawalOfInterest, final boolean simpleInterest) {
|
||||
return COMPOUND_INTEREST_HELPER.calculateInterestForAllPostingPeriods(currency, allPeriods, accountLockedUntil,
|
||||
immediateWithdrawalOfInterest, simpleInterest);
|
||||
}
|
||||
|
||||
public Collection<Long> fetchPostInterestTransactionIds(Long accountId) {
|
||||
return this.accountTransfersReadPlatformService.fetchPostInterestTransactionIds(accountId);
|
||||
}
|
||||
|
||||
+35
-1
@@ -40,6 +40,18 @@ public class CompoundInterestHelper {
|
||||
*/
|
||||
public Money calculateInterestForAllPostingPeriods(final MonetaryCurrency currency, final List<PostingPeriod> allPeriods,
|
||||
LocalDate lockUntil, Boolean interestTransferEnabled) {
|
||||
return calculateInterestForAllPostingPeriods(currency, allPeriods, lockUntil, interestTransferEnabled, false);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param simpleInterest
|
||||
* - when true, earned interest is never added back to the balance it is earned on, so every period
|
||||
* earns on the principal alone (a recurring deposit whose product's Interest Calculation Type is
|
||||
* "Simple"). Compounding and posting periods still decide when interest is recognised and posted;
|
||||
* they just stop changing how much is earned.
|
||||
*/
|
||||
public Money calculateInterestForAllPostingPeriods(final MonetaryCurrency currency, final List<PostingPeriod> allPeriods,
|
||||
LocalDate lockUntil, Boolean interestTransferEnabled, final boolean simpleInterest) {
|
||||
|
||||
// sum up the 'rounded' values that are posted each posting period
|
||||
Money interestEarned = Money.zero(currency);
|
||||
@@ -47,7 +59,8 @@ public class CompoundInterestHelper {
|
||||
// total interest earned in previous periods but not yet recognised
|
||||
BigDecimal compoundedInterest = BigDecimal.ZERO;
|
||||
BigDecimal unCompoundedInterest = BigDecimal.ZERO;
|
||||
final CompoundInterestValues compoundInterestValues = new CompoundInterestValues(compoundedInterest, unCompoundedInterest);
|
||||
final CompoundInterestValues compoundInterestValues = simpleInterest ? new SimpleInterestValues()
|
||||
: new CompoundInterestValues(compoundedInterest, unCompoundedInterest);
|
||||
for (final PostingPeriod postingPeriod : allPeriods) {
|
||||
|
||||
final BigDecimal interestEarnedThisPeriod = postingPeriod.calculateInterest(compoundInterestValues);
|
||||
@@ -67,4 +80,25 @@ public class CompoundInterestHelper {
|
||||
|
||||
return interestEarned;
|
||||
}
|
||||
|
||||
/**
|
||||
* Interest values that refuse to compound: whatever a compounding period hands over to be compounded is dropped,
|
||||
* so the balance interest is earned on never includes interest already earned.
|
||||
*/
|
||||
private static final class SimpleInterestValues extends CompoundInterestValues {
|
||||
|
||||
SimpleInterestValues() {
|
||||
super(BigDecimal.ZERO, BigDecimal.ZERO);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void setCompoundedInterest(final BigDecimal interestToBeCompounded) {
|
||||
super.setCompoundedInterest(BigDecimal.ZERO);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isSimpleInterest() {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+5
@@ -50,4 +50,9 @@ public class CompoundInterestValues {
|
||||
this.uncompoundedInterest = BigDecimal.ZERO;
|
||||
}
|
||||
|
||||
/** True when earned interest must never earn interest itself - not across periods, and not within one either. */
|
||||
public boolean isSimpleInterest() {
|
||||
return false;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
+12
@@ -94,6 +94,18 @@ public final class DailyCompoundingPeriod implements CompoundingPeriod {
|
||||
return interestEarned;
|
||||
}
|
||||
|
||||
/** Interest on each day's balance alone, none of it added to the balance - for simple interest. */
|
||||
public BigDecimal calculateSimpleInterest(final BigDecimal interestRateAsFraction, final long daysInYear,
|
||||
final BigDecimal minBalanceForInterestCalculation, final BigDecimal overdraftInterestRateAsFraction,
|
||||
final BigDecimal minOverdraftForInterestCalculation) {
|
||||
BigDecimal interestEarned = BigDecimal.ZERO;
|
||||
for (final EndOfDayBalance balance : this.endOfDayBalances) {
|
||||
interestEarned = interestEarned.add(balance.calculateInterestOnBalance(BigDecimal.ZERO, interestRateAsFraction, daysInYear,
|
||||
minBalanceForInterestCalculation, overdraftInterestRateAsFraction, minOverdraftForInterestCalculation));
|
||||
}
|
||||
return interestEarned;
|
||||
}
|
||||
|
||||
@Override
|
||||
public LocalDateInterval getPeriodInterval() {
|
||||
return this.periodInterval;
|
||||
|
||||
+11
-4
@@ -301,10 +301,17 @@ public final class PostingPeriod {
|
||||
// to be applied to the balanced for interest calculation
|
||||
for (final CompoundingPeriod compoundingPeriod : this.compoundingPeriods) {
|
||||
|
||||
final BigDecimal interestUnrounded = compoundingPeriod.calculateInterest(this.interestCompoundingType,
|
||||
this.interestCalculationType, compoundInterestValues.getcompoundedInterest(), this.interestRateAsFraction,
|
||||
this.daysInYear, this.minBalanceForInterestCalculation.getAmount(), this.overdraftInterestRateAsFraction,
|
||||
this.minOverdraftForInterestCalculation.getAmount());
|
||||
// A daily compounding period compounds day by day inside itself, so simple interest has to bypass it - zeroing
|
||||
// what is carried between periods alone still left a month's interest earning interest within the month.
|
||||
final BigDecimal interestUnrounded = compoundInterestValues.isSimpleInterest()
|
||||
&& compoundingPeriod instanceof DailyCompoundingPeriod dailyPeriod
|
||||
? dailyPeriod.calculateSimpleInterest(this.interestRateAsFraction, this.daysInYear,
|
||||
this.minBalanceForInterestCalculation.getAmount(), this.overdraftInterestRateAsFraction,
|
||||
this.minOverdraftForInterestCalculation.getAmount())
|
||||
: compoundingPeriod.calculateInterest(this.interestCompoundingType, this.interestCalculationType,
|
||||
compoundInterestValues.getcompoundedInterest(), this.interestRateAsFraction, this.daysInYear,
|
||||
this.minBalanceForInterestCalculation.getAmount(), this.overdraftInterestRateAsFraction,
|
||||
this.minOverdraftForInterestCalculation.getAmount());
|
||||
BigDecimal unCompoundedInterest = compoundInterestValues.getuncompoundedInterest().add(interestUnrounded);
|
||||
compoundInterestValues.setuncompoundedInterest(unCompoundedInterest);
|
||||
LocalDate compoundingPeriodEndDate = compoundingPeriod.getPeriodInterval().endDate();
|
||||
|
||||
+252
@@ -0,0 +1,252 @@
|
||||
/**
|
||||
* 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.organisation.agent.domain;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
import static org.junit.jupiter.api.Assertions.assertFalse;
|
||||
import static org.junit.jupiter.api.Assertions.assertNull;
|
||||
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||
|
||||
import java.math.BigDecimal;
|
||||
import java.time.LocalDate;
|
||||
import org.apache.fineract.organisation.office.domain.Office;
|
||||
import org.apache.fineract.portfolio.client.domain.Client;
|
||||
import org.apache.fineract.portfolio.dds.DdsCommands;
|
||||
import org.junit.jupiter.api.DisplayName;
|
||||
import org.junit.jupiter.api.Nested;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.mockito.Mockito;
|
||||
|
||||
/**
|
||||
* What a collection agent is holding and what they are owed.
|
||||
*
|
||||
* Two separate pots, and keeping them separate is the point: the cash balance is the bank's money
|
||||
* sitting in the agent's bag, and the commission is the agent's own earnings. Mixing them up would
|
||||
* either lose the bank's cash or pay an agent twice, so each of these checks one and leaves the
|
||||
* other alone.
|
||||
*/
|
||||
class AgentTest {
|
||||
|
||||
private Agent agent(final String extraJson) {
|
||||
final Client client = Mockito.mock(Client.class);
|
||||
final String json = """
|
||||
{
|
||||
"clientId": 1, "agentNameId": "Test Agent", "agentAddress1": "Somewhere",
|
||||
"agentCity": "Bhopal", "agentPinCode": "462016",
|
||||
"agentSavingAccountType": "SD Product", "agentSavingAccountNo": "002002000100011",
|
||||
"agentOpeningDate": "01 September 2026", "agentBirthDate": "01 January 1990",
|
||||
"dateFormat": "dd MMMM yyyy", "locale": "en"
|
||||
%s
|
||||
}
|
||||
""".formatted(extraJson);
|
||||
return Agent.fromJson(client, "AG0001", office("Head Office"), DdsCommands.of(json));
|
||||
}
|
||||
|
||||
private Office office(final String name) {
|
||||
final Office office = Mockito.mock(Office.class);
|
||||
Mockito.lenient().when(office.getName()).thenReturn(name);
|
||||
return office;
|
||||
}
|
||||
|
||||
@Nested
|
||||
@DisplayName("Cash the agent is carrying")
|
||||
class Cash {
|
||||
|
||||
@Test
|
||||
void aCollectionRaisesTheCashTheAgentHolds() {
|
||||
final Agent agent = agent("");
|
||||
|
||||
assertEquals(new BigDecimal("100"), agent.credit(new BigDecimal("100")));
|
||||
assertEquals(new BigDecimal("400"), agent.credit(new BigDecimal("300")));
|
||||
}
|
||||
|
||||
@Test
|
||||
void settlingAtABranchLowersIt() {
|
||||
final Agent agent = agent("");
|
||||
agent.credit(new BigDecimal("500"));
|
||||
|
||||
assertEquals(new BigDecimal("200"), agent.settle(new BigDecimal("300")));
|
||||
}
|
||||
|
||||
/** What the Close Account guard reads: money still out with an agent stops them being closed. */
|
||||
@Test
|
||||
void anAgentHoldsCashUntilEverythingIsSettled() {
|
||||
final Agent agent = agent("");
|
||||
assertFalse(agent.holdsCash());
|
||||
|
||||
agent.credit(new BigDecimal("500"));
|
||||
assertTrue(agent.holdsCash());
|
||||
|
||||
agent.settle(new BigDecimal("500"));
|
||||
assertFalse(agent.holdsCash());
|
||||
}
|
||||
|
||||
@Test
|
||||
void anOpeningBalanceIsCashTheAgentAlreadyHad() {
|
||||
final Agent agent = agent(", \"agentOpeningBalance\": 750");
|
||||
|
||||
assertEquals(new BigDecimal("750"), agent.getAgentCurrentBalance());
|
||||
assertEquals(new BigDecimal("750"), agent.getAgentOpeningBalance());
|
||||
}
|
||||
}
|
||||
|
||||
@Nested
|
||||
@DisplayName("Commission the agent has earned")
|
||||
class Commission {
|
||||
|
||||
private static final LocalDate THROUGH = LocalDate.of(2026, 9, 30);
|
||||
|
||||
/**
|
||||
* Accruing records what is owed and the TDS withheld from it, and stamps how far commission
|
||||
* has been worked out - the stamp being what stops the same period being paid twice.
|
||||
*/
|
||||
@Test
|
||||
void accruingRecordsWhatIsOwedAndTheTaxWithheld() {
|
||||
final Agent agent = agent("");
|
||||
|
||||
agent.accrueCommission(new BigDecimal("13.50"), new BigDecimal("1.50"), THROUGH);
|
||||
|
||||
assertEquals(new BigDecimal("13.50"), agent.getCommission());
|
||||
assertEquals(new BigDecimal("1.50"), agent.getTdsAmount());
|
||||
assertEquals(THROUGH, agent.getLastCommissionDate());
|
||||
}
|
||||
|
||||
@Test
|
||||
void payingItOutLeavesNothingOwed() {
|
||||
final Agent agent = agent("");
|
||||
agent.accrueCommission(new BigDecimal("15.00"), BigDecimal.ZERO, THROUGH);
|
||||
|
||||
assertEquals(new BigDecimal("0.00"), agent.payOutCommission(new BigDecimal("15.00")));
|
||||
assertFalse(agent.isOwedCommission());
|
||||
}
|
||||
|
||||
/** The guard against paying twice: a second payout comes off a figure already at zero. */
|
||||
@Test
|
||||
void aSecondPayoutOfTheSameCommissionFindsNothingLeft() {
|
||||
final Agent agent = agent("");
|
||||
agent.accrueCommission(new BigDecimal("15.00"), BigDecimal.ZERO, THROUGH);
|
||||
agent.payOutCommission(new BigDecimal("15.00"));
|
||||
|
||||
assertEquals(new BigDecimal("0.00"), agent.getCommission());
|
||||
}
|
||||
|
||||
/** Commission is the agent's own earnings, so paying it must not touch the bank's cash. */
|
||||
@Test
|
||||
void payingCommissionDoesNotTouchTheCashTheAgentIsCarrying() {
|
||||
final Agent agent = agent("");
|
||||
agent.credit(new BigDecimal("10000"));
|
||||
agent.accrueCommission(new BigDecimal("15.00"), BigDecimal.ZERO, THROUGH);
|
||||
|
||||
agent.payOutCommission(new BigDecimal("15.00"));
|
||||
|
||||
assertEquals(new BigDecimal("10000"), agent.getAgentCurrentBalance());
|
||||
}
|
||||
|
||||
@Test
|
||||
void anAgentIsOwedCommissionUntilItIsPaid() {
|
||||
final Agent agent = agent("");
|
||||
assertFalse(agent.isOwedCommission());
|
||||
|
||||
agent.accrueCommission(new BigDecimal("15.00"), BigDecimal.ZERO, THROUGH);
|
||||
assertTrue(agent.isOwedCommission());
|
||||
}
|
||||
|
||||
/**
|
||||
* The four standing amounts the Agent Commission Statement subtracts from gross commission.
|
||||
*
|
||||
* Set by editing an agent, not by creating one - they are figures the bank agrees with an
|
||||
* agent after the fact, so a create request carrying them is ignored rather than trusted.
|
||||
*/
|
||||
@Test
|
||||
void deductionsAreTheSumOfTheFourStandingAmounts() {
|
||||
final Agent agent = agent("");
|
||||
|
||||
agent.update(DdsCommands.of("""
|
||||
{"deductCommission": 1, "agentDeposit": 2, "festivalAdvance": 3, "otherDeduction": 4,
|
||||
"dateFormat": "dd MMMM yyyy", "locale": "en"}
|
||||
"""));
|
||||
|
||||
assertEquals(new BigDecimal("10"), agent.totalDeductions());
|
||||
}
|
||||
|
||||
/** A create request cannot set them, whatever it sends - they are agreed later, not at opening. */
|
||||
@Test
|
||||
void deductionsAreNotTakenFromACreateRequest() {
|
||||
final Agent agent = agent(", \"deductCommission\": 1, \"agentDeposit\": 2,"
|
||||
+ " \"festivalAdvance\": 3, \"otherDeduction\": 4");
|
||||
|
||||
assertEquals(0, agent.totalDeductions().compareTo(BigDecimal.ZERO));
|
||||
}
|
||||
|
||||
@Test
|
||||
void anAgentWithNoDeductionsSubtractsNothing() {
|
||||
final Agent agent = agent("");
|
||||
|
||||
assertEquals(0, agent.totalDeductions().compareTo(BigDecimal.ZERO));
|
||||
}
|
||||
}
|
||||
|
||||
@Nested
|
||||
@DisplayName("Which branch the agent belongs to")
|
||||
class Branch {
|
||||
|
||||
/**
|
||||
* The branch name is written from the office rather than set on its own, so the two cannot
|
||||
* disagree - a renamed branch reads correctly without the agent being touched.
|
||||
*/
|
||||
@Test
|
||||
void theBranchNameComesFromTheOffice() {
|
||||
final Agent agent = agent("");
|
||||
|
||||
assertEquals("Head Office", agent.getHomeBranch());
|
||||
|
||||
agent.setOffice(office("Borivali"));
|
||||
|
||||
assertEquals("Borivali", agent.getHomeBranch());
|
||||
}
|
||||
|
||||
@Test
|
||||
void anAgentWithNoOfficeHasNoBranchName() {
|
||||
final Agent agent = agent("");
|
||||
|
||||
agent.setOffice(null);
|
||||
|
||||
assertNull(agent.getHomeBranch());
|
||||
assertNull(agent.officeId());
|
||||
}
|
||||
}
|
||||
|
||||
@Nested
|
||||
@DisplayName("Closing")
|
||||
class Closing {
|
||||
|
||||
@Test
|
||||
void closingAlsoStopsTheAgentCollecting() {
|
||||
final Agent agent = agent("");
|
||||
assertFalse(agent.isClosed());
|
||||
assertTrue(agent.isActive());
|
||||
|
||||
agent.close(LocalDate.of(2026, 12, 1));
|
||||
|
||||
assertTrue(agent.isClosed());
|
||||
assertFalse(agent.isActive());
|
||||
assertEquals(LocalDate.of(2026, 12, 1), agent.getCloseDate());
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,47 @@
|
||||
/**
|
||||
* 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.dds;
|
||||
|
||||
import com.google.gson.JsonElement;
|
||||
import org.apache.fineract.infrastructure.core.api.JsonCommand;
|
||||
import org.apache.fineract.infrastructure.core.serialization.FromJsonHelper;
|
||||
|
||||
/**
|
||||
* Builds the {@link JsonCommand} a DDS entity is created from, so a test can make a real Party or
|
||||
* Agent the same way the API does rather than reaching into their fields.
|
||||
*
|
||||
* The alternative - setting fields by reflection - would test a state the application can never
|
||||
* actually produce, which is the opposite of useful.
|
||||
*/
|
||||
public final class DdsCommands {
|
||||
|
||||
private static final FromJsonHelper JSON_HELPER = new FromJsonHelper();
|
||||
|
||||
private DdsCommands() {}
|
||||
|
||||
/**
|
||||
* A command carrying the given JSON. Dates are read with the {@code dateFormat} and {@code locale}
|
||||
* the caller puts in that JSON, exactly as a request does.
|
||||
*/
|
||||
public static JsonCommand of(final String json) {
|
||||
final JsonElement parsed = JSON_HELPER.parse(json);
|
||||
return JsonCommand.from(json, parsed, JSON_HELPER, null, null, null, null, null, null, null, null, null, null, null, null, null,
|
||||
null);
|
||||
}
|
||||
}
|
||||
+141
@@ -0,0 +1,141 @@
|
||||
/**
|
||||
* 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.dds.calculation;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
import static org.junit.jupiter.api.Assertions.assertFalse;
|
||||
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||
|
||||
import java.math.BigDecimal;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
/**
|
||||
* What an agent is paid on a period's collections.
|
||||
*
|
||||
* The first two figures here are the ones the live system actually produced - ₹500 collected at 3%
|
||||
* paid ₹15, and ₹1,500 paid ₹45 - so if the formula ever moves, these fail rather than the change
|
||||
* going out unnoticed.
|
||||
*/
|
||||
class DdsCommissionCalculationTest {
|
||||
|
||||
private static final BigDecimal THREE_PERCENT = new BigDecimal("3");
|
||||
private static final BigDecimal NONE = BigDecimal.ZERO;
|
||||
|
||||
@Test
|
||||
void threePercentOfFiveHundredIsFifteen() {
|
||||
final DdsCommissionCalculation commission = DdsCommissionCalculation.of(new BigDecimal("500"), THREE_PERCENT, false, null, NONE);
|
||||
|
||||
assertEquals(new BigDecimal("15.00"), commission.gross());
|
||||
assertEquals(new BigDecimal("15.00"), commission.net());
|
||||
assertTrue(commission.isPayable());
|
||||
}
|
||||
|
||||
@Test
|
||||
void threePercentOfFifteenHundredIsFortyFive() {
|
||||
final DdsCommissionCalculation commission = DdsCommissionCalculation.of(new BigDecimal("1500"), THREE_PERCENT, false, null, NONE);
|
||||
|
||||
assertEquals(new BigDecimal("45.00"), commission.net());
|
||||
}
|
||||
|
||||
/** Tax comes off the gross, not off the collections. */
|
||||
@Test
|
||||
void taxIsWithheldFromTheGrossWhenTheAgentIsLiable() {
|
||||
final DdsCommissionCalculation commission = DdsCommissionCalculation.of(new BigDecimal("1000"), THREE_PERCENT, true,
|
||||
new BigDecimal("10"), NONE);
|
||||
|
||||
assertEquals(new BigDecimal("30.00"), commission.gross());
|
||||
assertEquals(new BigDecimal("3.00"), commission.tds());
|
||||
assertEquals(new BigDecimal("27.00"), commission.net());
|
||||
}
|
||||
|
||||
@Test
|
||||
void noTaxIsWithheldFromAnAgentWhoIsNotLiable() {
|
||||
final DdsCommissionCalculation commission = DdsCommissionCalculation.of(new BigDecimal("1000"), THREE_PERCENT, false,
|
||||
new BigDecimal("10"), NONE);
|
||||
|
||||
assertEquals(BigDecimal.ZERO, commission.tds());
|
||||
assertEquals(new BigDecimal("30.00"), commission.net());
|
||||
}
|
||||
|
||||
@Test
|
||||
void theBankRecoversItsStandingDeductionsFromWhatIsLeft() {
|
||||
final DdsCommissionCalculation commission = DdsCommissionCalculation.of(new BigDecimal("1000"), THREE_PERCENT, true,
|
||||
new BigDecimal("10"), new BigDecimal("7"));
|
||||
|
||||
assertEquals(new BigDecimal("30.00"), commission.gross());
|
||||
assertEquals(new BigDecimal("3.00"), commission.tds());
|
||||
assertEquals(new BigDecimal("7"), commission.deductions());
|
||||
assertEquals(new BigDecimal("20.00"), commission.net());
|
||||
}
|
||||
|
||||
/**
|
||||
* The deductions can swallow the whole period. Nothing is owed, and the agent is not put into
|
||||
* debt over it - so the run pays nothing rather than carrying a negative figure forward.
|
||||
*/
|
||||
@Test
|
||||
void deductionsLargerThanTheCommissionLeaveNothingPayable() {
|
||||
final DdsCommissionCalculation commission = DdsCommissionCalculation.of(new BigDecimal("500"), THREE_PERCENT, false, null,
|
||||
new BigDecimal("50"));
|
||||
|
||||
assertEquals(new BigDecimal("15.00"), commission.gross());
|
||||
assertEquals(new BigDecimal("-35.00"), commission.net());
|
||||
assertFalse(commission.isPayable());
|
||||
}
|
||||
|
||||
@Test
|
||||
void deductionsExactlyEqualToTheCommissionLeaveNothingPayable() {
|
||||
final DdsCommissionCalculation commission = DdsCommissionCalculation.of(new BigDecimal("500"), THREE_PERCENT, false, null,
|
||||
new BigDecimal("15"));
|
||||
|
||||
assertEquals(new BigDecimal("0.00"), commission.net());
|
||||
assertFalse(commission.isPayable());
|
||||
}
|
||||
|
||||
@Test
|
||||
void anAgentWhoCollectedNothingEarnsNothing() {
|
||||
final DdsCommissionCalculation commission = DdsCommissionCalculation.of(BigDecimal.ZERO, THREE_PERCENT, false, null, NONE);
|
||||
|
||||
assertEquals(new BigDecimal("0.00"), commission.net());
|
||||
assertFalse(commission.isPayable());
|
||||
}
|
||||
|
||||
/** Paise are rounded half-up, so a fraction of a paisa never goes missing or gets invented. */
|
||||
@Test
|
||||
void grossIsRoundedToPaise() {
|
||||
// 3.5% of 333 = 11.655, which rounds to 11.66 rather than being truncated to 11.65.
|
||||
final DdsCommissionCalculation commission = DdsCommissionCalculation.of(new BigDecimal("333"), new BigDecimal("3.5"), false, null,
|
||||
NONE);
|
||||
|
||||
assertEquals(new BigDecimal("11.66"), commission.gross());
|
||||
}
|
||||
|
||||
/** Everything is kept, not just the net - an agent asking why their pay was short needs it all. */
|
||||
@Test
|
||||
void theWholeBreakdownIsKept() {
|
||||
final DdsCommissionCalculation commission = DdsCommissionCalculation.of(new BigDecimal("2000"), new BigDecimal("5"), true,
|
||||
new BigDecimal("10"), new BigDecimal("25"));
|
||||
|
||||
assertEquals(new BigDecimal("2000"), commission.collectionVolume());
|
||||
assertEquals(new BigDecimal("5"), commission.ratePercent());
|
||||
assertEquals(new BigDecimal("100.00"), commission.gross());
|
||||
assertEquals(new BigDecimal("10.00"), commission.tds());
|
||||
assertEquals(new BigDecimal("25"), commission.deductions());
|
||||
assertEquals(new BigDecimal("65.00"), commission.net());
|
||||
}
|
||||
}
|
||||
+197
@@ -0,0 +1,197 @@
|
||||
/**
|
||||
* 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.dds.calculation;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
|
||||
import java.math.BigDecimal;
|
||||
import java.time.LocalDate;
|
||||
import java.util.List;
|
||||
import org.apache.fineract.portfolio.dds.calculation.DdsInterestCalculation.Movement;
|
||||
import org.junit.jupiter.api.DisplayName;
|
||||
import org.junit.jupiter.api.Nested;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
/**
|
||||
* What a DDS account earns over a period.
|
||||
*
|
||||
* Interest is on the daily product - the balance summed over the days it was actually held - which
|
||||
* is what makes a daily-deposit account different from an ordinary one. Paying on the closing
|
||||
* balance for the whole period instead was the bug this replaced, and it paid customers roughly
|
||||
* double what they were owed, so the sums below are worth pinning down exactly.
|
||||
*/
|
||||
class DdsInterestCalculationTest {
|
||||
|
||||
private static final BigDecimal TWO_PERCENT = new BigDecimal("2");
|
||||
private static final LocalDate SEP_1 = LocalDate.of(2026, 9, 1);
|
||||
private static final LocalDate SEP_30 = LocalDate.of(2026, 9, 30);
|
||||
|
||||
private static Movement in(final int day, final String amount) {
|
||||
return new Movement(LocalDate.of(2026, 9, day), new BigDecimal(amount));
|
||||
}
|
||||
|
||||
private static Movement out(final int day, final String amount) {
|
||||
return new Movement(LocalDate.of(2026, 9, day), new BigDecimal(amount).negate());
|
||||
}
|
||||
|
||||
@Nested
|
||||
@DisplayName("The balance summed over the days it was held")
|
||||
class DailyProduct {
|
||||
|
||||
/** An untouched account is simply its balance for every day of the period. */
|
||||
@Test
|
||||
void anUntouchedBalanceEarnsForEveryDay() {
|
||||
final BigDecimal product = DdsInterestCalculation.dailyProduct(new BigDecimal("1000"), List.of(), SEP_1, SEP_30);
|
||||
|
||||
// 29 days from the 1st to the 30th, at 1,000.
|
||||
assertEquals(new BigDecimal("29000"), product);
|
||||
}
|
||||
|
||||
/** A deposit earns from the day it was made, not the day after. */
|
||||
@Test
|
||||
void aDepositEarnsFromTheDayItWasMade() {
|
||||
final BigDecimal product = DdsInterestCalculation.dailyProduct(BigDecimal.ZERO, List.of(in(30, "100")), SEP_1, SEP_30);
|
||||
|
||||
// Nothing held until the 30th, then 100 for that one day.
|
||||
assertEquals(new BigDecimal("100"), product);
|
||||
}
|
||||
|
||||
@Test
|
||||
void eachDepositEarnsOnlyForTheDaysAfterIt() {
|
||||
final BigDecimal product = DdsInterestCalculation.dailyProduct(BigDecimal.ZERO,
|
||||
List.of(in(1, "100"), in(11, "100"), in(21, "100")), SEP_1, SEP_30);
|
||||
|
||||
// The 1st's 100 is in the opening balance (dated on the from date), so it earns 29 days.
|
||||
// 200 from the 11th to the 20th is 10 days; 300 from the 21st to the 30th is 10 days.
|
||||
// 100x29 + ... - worked through: 2900 + ... see the assertion.
|
||||
assertEquals(new BigDecimal("5900"), product);
|
||||
}
|
||||
|
||||
/** A payout stops earning from the day it is taken. */
|
||||
@Test
|
||||
void aPayoutStopsEarningFromThatDay() {
|
||||
final BigDecimal product = DdsInterestCalculation.dailyProduct(new BigDecimal("1000"), List.of(out(11, "500")), SEP_1, SEP_30);
|
||||
|
||||
// 1,000 for the 2nd to the 10th (9 days), then 500 from the 11th to the 30th (20 days).
|
||||
assertEquals(new BigDecimal("19000"), product);
|
||||
}
|
||||
|
||||
/** Everything dated on or before the start is the balance the period opens with. */
|
||||
@Test
|
||||
void movementsBeforeThePeriodMakeUpTheOpeningBalance() {
|
||||
final BigDecimal product = DdsInterestCalculation.dailyProduct(BigDecimal.ZERO,
|
||||
List.of(new Movement(LocalDate.of(2026, 8, 15), new BigDecimal("500")), in(1, "500")), SEP_1, SEP_30);
|
||||
|
||||
// Both are on or before the 1st, so the period opens at 1,000 and nothing moves after.
|
||||
assertEquals(new BigDecimal("29000"), product);
|
||||
}
|
||||
|
||||
/** A movement after the period has not happened yet as far as this run is concerned. */
|
||||
@Test
|
||||
void movementsAfterThePeriodAreIgnored() {
|
||||
final BigDecimal product = DdsInterestCalculation.dailyProduct(new BigDecimal("1000"),
|
||||
List.of(new Movement(LocalDate.of(2026, 10, 5), new BigDecimal("9999"))), SEP_1, SEP_30);
|
||||
|
||||
assertEquals(new BigDecimal("29000"), product);
|
||||
}
|
||||
|
||||
/** Several movements on one day all land before the day is counted. */
|
||||
@Test
|
||||
void everythingOnOneDayIsAppliedBeforeThatDayIsCounted() {
|
||||
final BigDecimal product = DdsInterestCalculation.dailyProduct(BigDecimal.ZERO,
|
||||
List.of(in(30, "100"), in(30, "100"), in(30, "100")), SEP_1, SEP_30);
|
||||
|
||||
assertEquals(new BigDecimal("300"), product);
|
||||
}
|
||||
|
||||
@Test
|
||||
void anEmptyAccountEarnsNothing() {
|
||||
assertEquals(BigDecimal.ZERO, DdsInterestCalculation.dailyProduct(BigDecimal.ZERO, List.of(), SEP_1, SEP_30));
|
||||
}
|
||||
|
||||
@Test
|
||||
void aPeriodOfNoDaysEarnsNothing() {
|
||||
assertEquals(BigDecimal.ZERO, DdsInterestCalculation.dailyProduct(new BigDecimal("1000"), List.of(), SEP_1, SEP_1));
|
||||
}
|
||||
}
|
||||
|
||||
@Nested
|
||||
@DisplayName("Interest on the product")
|
||||
class Interest {
|
||||
|
||||
/**
|
||||
* The figures the live system produced and that were checked by hand: ₹10,000 held through a
|
||||
* month at 2% earned ₹52.60, and the same balance plus a month's interest earned ₹60.92 over
|
||||
* a longer stretch. Nothing in the sum may move these.
|
||||
*/
|
||||
@Test
|
||||
void tenThousandThroughSeptemberAtTwoPercentEarnsFiftyTwoSixty() {
|
||||
final BigDecimal product = DdsInterestCalculation.dailyProduct(new BigDecimal("10000"), List.of(),
|
||||
LocalDate.of(2026, 8, 1), LocalDate.of(2026, 9, 30));
|
||||
|
||||
// 60 days at 10,000 = 600,000. 600,000 x 2 / 100 / 365 = 32.876...
|
||||
assertEquals(new BigDecimal("600000"), product);
|
||||
assertEquals(new BigDecimal("32.88"), DdsInterestCalculation.interestOn(product, TWO_PERCENT));
|
||||
}
|
||||
|
||||
@Test
|
||||
void aKnownProductGivesAKnownInterest() {
|
||||
// 960,000 x 2 / 100 / 365 = 52.6027... which is the 52.60 the live run posted.
|
||||
assertEquals(new BigDecimal("52.60"), DdsInterestCalculation.interestOn(new BigDecimal("960000"), TWO_PERCENT));
|
||||
}
|
||||
|
||||
@Test
|
||||
void aZeroRateEarnsNothing() {
|
||||
assertEquals(new BigDecimal("0.00"), DdsInterestCalculation.interestOn(new BigDecimal("29000"), BigDecimal.ZERO));
|
||||
}
|
||||
|
||||
@Test
|
||||
void aZeroProductEarnsNothing() {
|
||||
assertEquals(new BigDecimal("0.00"), DdsInterestCalculation.interestOn(BigDecimal.ZERO, TWO_PERCENT));
|
||||
}
|
||||
|
||||
@Test
|
||||
void interestIsRoundedToPaise() {
|
||||
// 1,000 x 2 / 100 / 365 = 0.0547... which rounds to 0.05.
|
||||
assertEquals(new BigDecimal("0.05"), DdsInterestCalculation.interestOn(new BigDecimal("1000"), TWO_PERCENT));
|
||||
}
|
||||
|
||||
/**
|
||||
* The whole point of the daily product: an account paid into daily earns far less than the
|
||||
* same closing balance held all period, because most of the money arrived late.
|
||||
*/
|
||||
@Test
|
||||
void payingInDailyEarnsFarLessThanHoldingTheSameBalanceAllPeriod() {
|
||||
final List<Movement> daily = List.of(in(1, "100"), in(2, "100"), in(3, "100"), in(4, "100"), in(5, "100"));
|
||||
|
||||
final BigDecimal paidInDaily = DdsInterestCalculation.dailyProduct(BigDecimal.ZERO, daily, SEP_1,
|
||||
LocalDate.of(2026, 9, 5));
|
||||
final BigDecimal heldThroughout = DdsInterestCalculation.dailyProduct(new BigDecimal("500"), List.of(), SEP_1,
|
||||
LocalDate.of(2026, 9, 5));
|
||||
|
||||
// Paid in daily: 200 on the 2nd, 300 on the 3rd, 400 on the 4th, 500 on the 5th. The
|
||||
// 1st's instalment is dated on the from date, so it makes up the opening balance rather
|
||||
// than earning a day of its own.
|
||||
assertEquals(new BigDecimal("1400"), paidInDaily);
|
||||
|
||||
// The same 500 held from the start earns four full days on the whole amount.
|
||||
assertEquals(new BigDecimal("2000"), heldThroughout);
|
||||
}
|
||||
}
|
||||
}
|
||||
+229
@@ -0,0 +1,229 @@
|
||||
/**
|
||||
* 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.dds.party.domain;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
import static org.junit.jupiter.api.Assertions.assertFalse;
|
||||
import static org.junit.jupiter.api.Assertions.assertNull;
|
||||
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||
|
||||
import java.math.BigDecimal;
|
||||
import java.time.LocalDate;
|
||||
import org.apache.fineract.organisation.agent.domain.Agent;
|
||||
import org.apache.fineract.portfolio.client.domain.Client;
|
||||
import org.apache.fineract.portfolio.dds.DdsCommands;
|
||||
import org.junit.jupiter.api.DisplayName;
|
||||
import org.junit.jupiter.api.Nested;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.mockito.Mockito;
|
||||
|
||||
/**
|
||||
* What a DDS customer's account owes them, and how it changes.
|
||||
*
|
||||
* Every figure here is money a customer is owed, so each of these is a sum that has to come out
|
||||
* exactly - not approximately. The maturity figures are the ones quoted to the customer when the
|
||||
* account is opened, and the interest ones were verified by hand against the live system before
|
||||
* being written down here, so a change that moves them will fail rather than pass quietly.
|
||||
*/
|
||||
class PartyTest {
|
||||
|
||||
private static final BigDecimal HUNDRED_A_DAY = new BigDecimal("100");
|
||||
|
||||
private Party party(final String extraJson) {
|
||||
final Client client = Mockito.mock(Client.class);
|
||||
final Agent agent = Mockito.mock(Agent.class);
|
||||
final String json = """
|
||||
{
|
||||
"clientId": 1, "agentId": 1, "subType": "DDS",
|
||||
"partyName": "Test Customer", "address1": "Somewhere", "city": "Bhopal",
|
||||
"pincode": "462016", "mobileNoSms": "9000000000", "operation": "Self",
|
||||
"adultMinor": "Adult", "openingDate": "01 September 2026",
|
||||
"dateFormat": "dd MMMM yyyy", "locale": "en"
|
||||
%s
|
||||
}
|
||||
""".formatted(extraJson);
|
||||
return Party.fromJson(client, agent, "PT0001", DdsCommands.of(json));
|
||||
}
|
||||
|
||||
@Nested
|
||||
@DisplayName("What the customer is quoted at opening")
|
||||
class Maturity {
|
||||
|
||||
/**
|
||||
* A day's deposit earns interest for every day it is held, so the first instalment earns for
|
||||
* the whole term and the last for one day - n(n+1)/2 instalment-days in total. This is the
|
||||
* figure quoted to the customer, and the one the interest runs have to add up to.
|
||||
*/
|
||||
@Test
|
||||
void interestIsOnEachInstalmentForTheDaysItIsHeld() {
|
||||
final Party party = party(", \"dailyDepositAmount\": 100, \"days\": 90, \"interestRate\": 2");
|
||||
|
||||
// 90 x 100 = 9,000 principal. Instalment-days = 90 x 91 / 2 = 4,095.
|
||||
// Interest = 100 x 4095 x 2 / 100 / 365 = 22.4383...
|
||||
assertEquals(new BigDecimal("9022.44"), party.getMaturityAmount());
|
||||
}
|
||||
|
||||
@Test
|
||||
void aZeroRateReturnsTheDepositsAndNothingMore() {
|
||||
final Party party = party(", \"dailyDepositAmount\": 100, \"days\": 90, \"interestRate\": 0");
|
||||
|
||||
assertEquals(new BigDecimal("9000.00"), party.getMaturityAmount());
|
||||
}
|
||||
|
||||
/** Nothing is quoted for a term nobody has agreed to yet. */
|
||||
@Test
|
||||
void noTermMeansNoMaturityAmount() {
|
||||
final Party party = party(", \"dailyDepositAmount\": 100, \"days\": 0, \"interestRate\": 2");
|
||||
|
||||
assertEquals(BigDecimal.ZERO, party.getMaturityAmount());
|
||||
}
|
||||
|
||||
@Test
|
||||
void noDailyAmountMeansNoMaturityAmount() {
|
||||
final Party party = party(", \"dailyDepositAmount\": 0, \"days\": 90, \"interestRate\": 2");
|
||||
|
||||
assertEquals(BigDecimal.ZERO, party.getMaturityAmount());
|
||||
}
|
||||
|
||||
/** The rate the business settled on when none is sent - see Party's DEFAULT_INTEREST_RATE. */
|
||||
@Test
|
||||
void aRateIsAppliedWhenNoneWasSent() {
|
||||
final Party party = party(", \"dailyDepositAmount\": 100, \"days\": 90");
|
||||
|
||||
assertEquals(new BigDecimal("2"), party.getInterestRate());
|
||||
assertEquals(new BigDecimal("9022.44"), party.getMaturityAmount());
|
||||
}
|
||||
}
|
||||
|
||||
@Nested
|
||||
@DisplayName("Collections and payouts")
|
||||
class Balance {
|
||||
|
||||
@Test
|
||||
void aCollectionRaisesTheBalanceAndReturnsIt() {
|
||||
final Party party = party(", \"dailyDepositAmount\": 100, \"days\": 90");
|
||||
|
||||
assertEquals(new BigDecimal("100"), party.credit(HUNDRED_A_DAY));
|
||||
assertEquals(new BigDecimal("200"), party.credit(HUNDRED_A_DAY));
|
||||
assertEquals(new BigDecimal("200"), party.getCurrentBalance());
|
||||
}
|
||||
|
||||
@Test
|
||||
void aPayoutLowersTheBalance() {
|
||||
final Party party = party(", \"dailyDepositAmount\": 100, \"days\": 90");
|
||||
party.credit(new BigDecimal("500"));
|
||||
|
||||
assertEquals(new BigDecimal("200"), party.debit(new BigDecimal("300")));
|
||||
}
|
||||
|
||||
@Test
|
||||
void anOpeningBalanceStartsTheAccountOff() {
|
||||
final Party party = party(", \"dailyDepositAmount\": 100, \"days\": 90, \"openingBalance\": 250");
|
||||
|
||||
assertEquals(new BigDecimal("250"), party.getCurrentBalance());
|
||||
}
|
||||
}
|
||||
|
||||
@Nested
|
||||
@DisplayName("Interest, and why it cannot be earned twice")
|
||||
class Interest {
|
||||
|
||||
private static final LocalDate THROUGH = LocalDate.of(2026, 9, 30);
|
||||
|
||||
/** Accrued interest is not the customer's to draw on, so the balance does not move yet. */
|
||||
@Test
|
||||
void accruingParksTheInterestWithoutTouchingTheBalance() {
|
||||
final Party party = party(", \"dailyDepositAmount\": 100, \"days\": 90");
|
||||
party.credit(new BigDecimal("1000"));
|
||||
|
||||
party.accrueInterest(new BigDecimal("52.60"), THROUGH, false);
|
||||
|
||||
assertEquals(new BigDecimal("52.60"), party.accruedInterest(false));
|
||||
assertEquals(new BigDecimal("1000"), party.getCurrentBalance());
|
||||
assertEquals(THROUGH, party.interestCalculatedThrough(false));
|
||||
}
|
||||
|
||||
@Test
|
||||
void postingMovesItIntoTheBalanceAndLeavesNothingAccrued() {
|
||||
final Party party = party(", \"dailyDepositAmount\": 100, \"days\": 90");
|
||||
party.credit(new BigDecimal("1000"));
|
||||
party.accrueInterest(new BigDecimal("52.60"), THROUGH, false);
|
||||
|
||||
assertEquals(new BigDecimal("1052.60"), party.postInterest(new BigDecimal("52.60"), false));
|
||||
assertEquals(new BigDecimal("0.00"), party.accruedInterest(false));
|
||||
}
|
||||
|
||||
/**
|
||||
* The guard against paying the same interest twice: a second posting comes off an accrued
|
||||
* figure that is already empty, so there is nothing left to move.
|
||||
*/
|
||||
@Test
|
||||
void aSecondPostingOfTheSameInterestFindsNothingLeft() {
|
||||
final Party party = party(", \"dailyDepositAmount\": 100, \"days\": 90");
|
||||
party.accrueInterest(new BigDecimal("52.60"), THROUGH, false);
|
||||
party.postInterest(new BigDecimal("52.60"), false);
|
||||
|
||||
assertEquals(new BigDecimal("0.00"), party.accruedInterest(false));
|
||||
}
|
||||
|
||||
/** OD interest has its own figure and its own date - a run of one must not consume the other. */
|
||||
@Test
|
||||
void odInterestIsKeptApartFromOrdinaryInterest() {
|
||||
final Party party = party(", \"dailyDepositAmount\": 100, \"days\": 90");
|
||||
|
||||
party.accrueInterest(new BigDecimal("10.00"), THROUGH, false);
|
||||
party.accrueInterest(new BigDecimal("3.00"), THROUGH.plusDays(1), true);
|
||||
|
||||
assertEquals(new BigDecimal("10.00"), party.accruedInterest(false));
|
||||
assertEquals(new BigDecimal("3.00"), party.accruedInterest(true));
|
||||
assertEquals(THROUGH, party.interestCalculatedThrough(false));
|
||||
assertEquals(THROUGH.plusDays(1), party.interestCalculatedThrough(true));
|
||||
}
|
||||
|
||||
@Test
|
||||
void interestAccruesFromWhereTheLastRunStopped() {
|
||||
final Party party = party(", \"dailyDepositAmount\": 100, \"days\": 90");
|
||||
|
||||
assertNull(party.interestCalculatedThrough(false));
|
||||
|
||||
party.accrueInterest(new BigDecimal("5.00"), THROUGH, false);
|
||||
party.accrueInterest(new BigDecimal("5.00"), THROUGH.plusMonths(1), false);
|
||||
|
||||
assertEquals(new BigDecimal("10.00"), party.accruedInterest(false));
|
||||
assertEquals(THROUGH.plusMonths(1), party.interestCalculatedThrough(false));
|
||||
}
|
||||
}
|
||||
|
||||
@Nested
|
||||
@DisplayName("Closing")
|
||||
class Closing {
|
||||
|
||||
@Test
|
||||
void anAccountIsOpenUntilItIsClosed() {
|
||||
final Party party = party(", \"dailyDepositAmount\": 100, \"days\": 90");
|
||||
|
||||
assertFalse(party.isClosed());
|
||||
|
||||
party.close(LocalDate.of(2026, 12, 1));
|
||||
|
||||
assertTrue(party.isClosed());
|
||||
assertEquals(LocalDate.of(2026, 12, 1), party.getCloseDate());
|
||||
}
|
||||
}
|
||||
}
|
||||
+189
@@ -0,0 +1,189 @@
|
||||
/**
|
||||
* 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.transactionprocessor.impl;
|
||||
|
||||
import java.time.LocalDate;
|
||||
import java.util.List;
|
||||
import java.util.Set;
|
||||
import org.apache.fineract.infrastructure.core.service.ExternalIdFactory;
|
||||
import org.apache.fineract.organisation.monetary.domain.MonetaryCurrency;
|
||||
import org.apache.fineract.organisation.monetary.domain.Money;
|
||||
import org.apache.fineract.portfolio.loanaccount.domain.LoanCharge;
|
||||
import org.apache.fineract.portfolio.loanaccount.domain.LoanRepaymentScheduleInstallment;
|
||||
import org.apache.fineract.portfolio.loanaccount.domain.LoanTransaction;
|
||||
import org.apache.fineract.portfolio.loanaccount.domain.LoanTransactionToRepaymentScheduleMapping;
|
||||
import org.apache.fineract.portfolio.loanaccount.domain.transactionprocessor.AbstractLoanRepaymentScheduleTransactionProcessor;
|
||||
import org.apache.fineract.portfolio.loanaccount.domain.transactionprocessor.LoanRepaymentScheduleTransactionProcessor;
|
||||
import org.apache.fineract.portfolio.loanaccount.serialization.LoanChargeValidator;
|
||||
import org.apache.fineract.portfolio.loanaccount.service.LoanBalanceService;
|
||||
|
||||
/**
|
||||
* {@link LoanRepaymentScheduleTransactionProcessor} that pays off components in order of fees, penalties, interest,
|
||||
* then principal.
|
||||
*
|
||||
* Other formulas exist on fineract where you can choose 'Declining-Balance Interest Recalculation' which simply means,
|
||||
* recalculate the interest component based on the how much principal is outstanding at a point in time; but this isnt
|
||||
* trying to model that option only the basic one for now.
|
||||
*/
|
||||
@SuppressWarnings("unused")
|
||||
public class FeesPenaltyInterestPrincipalOrderLoanRepaymentScheduleTransactionProcessor extends AbstractLoanRepaymentScheduleTransactionProcessor {
|
||||
|
||||
public static final String STRATEGY_CODE = "fees-penalties-interest-principal-order-strategy";
|
||||
|
||||
public static final String STRATEGY_NAME = "Fees, Penalties, Interest, Principal Order";
|
||||
|
||||
public FeesPenaltyInterestPrincipalOrderLoanRepaymentScheduleTransactionProcessor(final ExternalIdFactory externalIdFactory,
|
||||
final LoanChargeValidator loanChargeValidator, final LoanBalanceService loanBalanceService) {
|
||||
super(externalIdFactory, loanChargeValidator, loanBalanceService);
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getCode() {
|
||||
return STRATEGY_CODE;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getName() {
|
||||
return STRATEGY_NAME;
|
||||
}
|
||||
|
||||
/**
|
||||
* For early/'in advance' repayments, pay off in the same way as on-time payments, interest first then principal.
|
||||
*/
|
||||
@Override
|
||||
protected Money handleTransactionThatIsPaymentInAdvanceOfInstallment(final LoanRepaymentScheduleInstallment currentInstallment,
|
||||
final List<LoanRepaymentScheduleInstallment> installments, final LoanTransaction loanTransaction, final Money paymentInAdvance,
|
||||
List<LoanTransactionToRepaymentScheduleMapping> transactionMappings, Set<LoanCharge> charges) {
|
||||
|
||||
return handleTransactionThatIsOnTimePaymentOfInstallment(currentInstallment, loanTransaction, paymentInAdvance, transactionMappings,
|
||||
charges);
|
||||
}
|
||||
|
||||
/**
|
||||
* For late repayments, pay off in the same way as on-time payments, interest first then principal.
|
||||
*/
|
||||
@Override
|
||||
protected Money handleTransactionThatIsALateRepaymentOfInstallment(final LoanRepaymentScheduleInstallment currentInstallment,
|
||||
final List<LoanRepaymentScheduleInstallment> installments, final LoanTransaction loanTransaction,
|
||||
final Money transactionAmountUnprocessed, List<LoanTransactionToRepaymentScheduleMapping> transactionMappings,
|
||||
Set<LoanCharge> charges) {
|
||||
|
||||
return handleTransactionThatIsOnTimePaymentOfInstallment(currentInstallment, loanTransaction, transactionAmountUnprocessed,
|
||||
transactionMappings, charges);
|
||||
}
|
||||
|
||||
/**
|
||||
* For normal on-time repayments, pays off interest first, then principal.
|
||||
*/
|
||||
@Override
|
||||
protected Money handleTransactionThatIsOnTimePaymentOfInstallment(final LoanRepaymentScheduleInstallment currentInstallment,
|
||||
final LoanTransaction loanTransaction, final Money transactionAmountUnprocessed,
|
||||
List<LoanTransactionToRepaymentScheduleMapping> transactionMappings, Set<LoanCharge> charges) {
|
||||
|
||||
final LocalDate transactionDate = loanTransaction.getTransactionDate();
|
||||
final MonetaryCurrency currency = transactionAmountUnprocessed.getCurrency();
|
||||
Money transactionAmountRemaining = transactionAmountUnprocessed;
|
||||
Money principalPortion = Money.zero(transactionAmountRemaining.getCurrency());
|
||||
Money interestPortion = Money.zero(transactionAmountRemaining.getCurrency());
|
||||
Money feeChargesPortion = Money.zero(transactionAmountRemaining.getCurrency());
|
||||
Money penaltyChargesPortion = Money.zero(transactionAmountRemaining.getCurrency());
|
||||
|
||||
if (loanTransaction.isChargesWaiver()) {
|
||||
penaltyChargesPortion = currentInstallment.waivePenaltyChargesComponent(transactionDate,
|
||||
loanTransaction.getPenaltyChargesPortion(currency));
|
||||
transactionAmountRemaining = transactionAmountRemaining.minus(penaltyChargesPortion);
|
||||
|
||||
feeChargesPortion = currentInstallment.waiveFeeChargesComponent(transactionDate,
|
||||
loanTransaction.getFeeChargesPortion(currency));
|
||||
transactionAmountRemaining = transactionAmountRemaining.minus(feeChargesPortion);
|
||||
|
||||
} else if (loanTransaction.isInterestWaiver()) {
|
||||
interestPortion = currentInstallment.waiveInterestComponent(transactionDate, transactionAmountRemaining);
|
||||
transactionAmountRemaining = transactionAmountRemaining.minus(interestPortion);
|
||||
|
||||
loanTransaction.updateComponents(principalPortion, interestPortion, feeChargesPortion, penaltyChargesPortion);
|
||||
} else if (loanTransaction.isChargePayment()) {
|
||||
if (loanTransaction.isPenaltyPayment()) {
|
||||
penaltyChargesPortion = currentInstallment.payPenaltyChargesComponent(transactionDate, transactionAmountRemaining);
|
||||
transactionAmountRemaining = transactionAmountRemaining.minus(penaltyChargesPortion);
|
||||
} else {
|
||||
feeChargesPortion = currentInstallment.payFeeChargesComponent(transactionDate, transactionAmountRemaining);
|
||||
transactionAmountRemaining = transactionAmountRemaining.minus(feeChargesPortion);
|
||||
}
|
||||
loanTransaction.updateComponents(principalPortion, interestPortion, feeChargesPortion, penaltyChargesPortion);
|
||||
} else {
|
||||
feeChargesPortion = currentInstallment.payFeeChargesComponent(transactionDate, transactionAmountRemaining);
|
||||
transactionAmountRemaining = transactionAmountRemaining.minus(feeChargesPortion);
|
||||
|
||||
penaltyChargesPortion = currentInstallment.payPenaltyChargesComponent(transactionDate, transactionAmountRemaining);
|
||||
transactionAmountRemaining = transactionAmountRemaining.minus(penaltyChargesPortion);
|
||||
|
||||
interestPortion = currentInstallment.payInterestComponent(transactionDate, transactionAmountRemaining);
|
||||
transactionAmountRemaining = transactionAmountRemaining.minus(interestPortion);
|
||||
|
||||
principalPortion = currentInstallment.payPrincipalComponent(transactionDate, transactionAmountRemaining);
|
||||
transactionAmountRemaining = transactionAmountRemaining.minus(principalPortion);
|
||||
|
||||
loanTransaction.updateComponents(principalPortion, interestPortion, feeChargesPortion, penaltyChargesPortion);
|
||||
}
|
||||
if (principalPortion.plus(interestPortion).plus(feeChargesPortion).plus(penaltyChargesPortion).isGreaterThanZero()) {
|
||||
transactionMappings.add(LoanTransactionToRepaymentScheduleMapping.createFrom(loanTransaction, currentInstallment,
|
||||
principalPortion, interestPortion, feeChargesPortion, penaltyChargesPortion));
|
||||
}
|
||||
return transactionAmountRemaining;
|
||||
}
|
||||
|
||||
@Override
|
||||
protected Money handleRefundTransactionPaymentOfInstallment(final LoanRepaymentScheduleInstallment currentInstallment,
|
||||
final LoanTransaction loanTransaction, final Money transactionAmountUnprocessed,
|
||||
List<LoanTransactionToRepaymentScheduleMapping> transactionMappings) {
|
||||
|
||||
final LocalDate transactionDate = loanTransaction.getTransactionDate();
|
||||
final MonetaryCurrency currency = transactionAmountUnprocessed.getCurrency();
|
||||
Money transactionAmountRemaining = transactionAmountUnprocessed;
|
||||
Money principalPortion = Money.zero(currency);
|
||||
Money interestPortion = Money.zero(currency);
|
||||
Money feeChargesPortion = Money.zero(currency);
|
||||
Money penaltyChargesPortion = Money.zero(currency);
|
||||
|
||||
principalPortion = currentInstallment.unpayPrincipalComponent(transactionDate, transactionAmountRemaining);
|
||||
transactionAmountRemaining = transactionAmountRemaining.minus(principalPortion);
|
||||
|
||||
if (transactionAmountRemaining.isGreaterThanZero()) {
|
||||
interestPortion = currentInstallment.unpayInterestComponent(transactionDate, transactionAmountRemaining);
|
||||
transactionAmountRemaining = transactionAmountRemaining.minus(interestPortion);
|
||||
}
|
||||
|
||||
if (transactionAmountRemaining.isGreaterThanZero()) {
|
||||
penaltyChargesPortion = currentInstallment.unpayPenaltyChargesComponent(transactionDate, transactionAmountRemaining);
|
||||
transactionAmountRemaining = transactionAmountRemaining.minus(penaltyChargesPortion);
|
||||
}
|
||||
|
||||
if (transactionAmountRemaining.isGreaterThanZero()) {
|
||||
feeChargesPortion = currentInstallment.unpayFeeChargesComponent(transactionDate, transactionAmountRemaining);
|
||||
transactionAmountRemaining = transactionAmountRemaining.minus(feeChargesPortion);
|
||||
}
|
||||
loanTransaction.updateComponents(principalPortion, interestPortion, feeChargesPortion, penaltyChargesPortion);
|
||||
if (principalPortion.plus(interestPortion).plus(feeChargesPortion).plus(penaltyChargesPortion).isGreaterThanZero()) {
|
||||
transactionMappings.add(LoanTransactionToRepaymentScheduleMapping.createFrom(loanTransaction, currentInstallment,
|
||||
principalPortion, interestPortion, feeChargesPortion, penaltyChargesPortion));
|
||||
}
|
||||
return transactionAmountRemaining;
|
||||
}
|
||||
}
|
||||
+30
@@ -0,0 +1,30 @@
|
||||
/**
|
||||
* 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.starter;
|
||||
|
||||
import org.apache.fineract.infrastructure.core.condition.PropertiesCondition;
|
||||
import org.apache.fineract.infrastructure.core.config.FineractProperties;
|
||||
|
||||
public class FeesPenaltiesInterestPrincipalLoanRepaymentScheduleTransactionProcessorCondition extends PropertiesCondition {
|
||||
|
||||
@Override
|
||||
protected boolean matches(FineractProperties properties) {
|
||||
return properties.getLoan().getTransactionProcessor().getFeesPenaltiesInterestPrincipal().isEnabled();
|
||||
}
|
||||
}
|
||||
+14
@@ -225,6 +225,12 @@ public class LoanProductData implements Serializable {
|
||||
private final LoanProductGuaranteeData productGuaranteeData;
|
||||
private final Boolean accountMovesOutOfNPAOnlyOnArrearsCompletion;
|
||||
private LoanProductConfigurableAttributes allowAttributeOverrides;
|
||||
|
||||
/**
|
||||
* "Advances A/C" satellite fields (security, lien, renewal, npa, cheque book), flat by their form field
|
||||
* name. Set after construction (like {@link #allowAttributeOverrides}) so the edit form can repopulate.
|
||||
*/
|
||||
private Map<String, Object> advanceExtensions;
|
||||
private final boolean syncExpectedWithDisbursementDate;
|
||||
private final boolean isEqualAmortization;
|
||||
private final BigDecimal fixedPrincipalPercentagePerInstallment;
|
||||
@@ -1466,6 +1472,14 @@ public class LoanProductData implements Serializable {
|
||||
this.allowAttributeOverrides = loanProductConfigurableAttributes;
|
||||
}
|
||||
|
||||
public void setAdvanceExtensions(final Map<String, Object> advanceExtensions) {
|
||||
this.advanceExtensions = advanceExtensions;
|
||||
}
|
||||
|
||||
public Map<String, Object> getAdvanceExtensions() {
|
||||
return this.advanceExtensions;
|
||||
}
|
||||
|
||||
public boolean isIsLinkedToFloatingInterestRates() {
|
||||
return this.isLinkedToFloatingInterestRates;
|
||||
}
|
||||
|
||||
+471
@@ -0,0 +1,471 @@
|
||||
/**
|
||||
* Copyright since 2025 Mifos Initiative
|
||||
*
|
||||
* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
package org.apache.fineract.portfolio.loanproduct.domain;
|
||||
|
||||
import jakarta.persistence.Column;
|
||||
import jakarta.persistence.Entity;
|
||||
import jakarta.persistence.FetchType;
|
||||
import jakarta.persistence.Id;
|
||||
import jakarta.persistence.JoinColumn;
|
||||
import jakarta.persistence.OneToOne;
|
||||
import jakarta.persistence.Table;
|
||||
import java.math.BigDecimal;
|
||||
import lombok.Getter;
|
||||
import lombok.NoArgsConstructor;
|
||||
import lombok.Setter;
|
||||
|
||||
/**
|
||||
* "Advances A/C" product configuration that Fineract's loan-product schema has no home for
|
||||
* (security & margin, lien, deposit-linked interest, penal/NPA handling, renewal, monitoring,
|
||||
* cheque book). It is a standalone satellite keyed by {@code loan_product_id} rather than a widening
|
||||
* of {@code m_product_loan} or a new relation on {@link LoanProduct}: the product entity graph is
|
||||
* loaded on the hot loan-origination path, so it is deliberately left untouched.
|
||||
*
|
||||
* Typed columns (not a JSON blob) so reports can filter on them and GL ids get a real FK.
|
||||
*/
|
||||
@Entity
|
||||
@Getter
|
||||
@Setter
|
||||
@NoArgsConstructor
|
||||
@Table(name = "m_product_loan_advance_ext")
|
||||
public class LoanProductAdvanceExt {
|
||||
|
||||
@Id
|
||||
@Column(name = "loan_product_id")
|
||||
private Long loanProductId;
|
||||
|
||||
/** Shared primary key, mapped read-only; {@link #loanProductId} is the writable side. */
|
||||
@OneToOne(fetch = FetchType.LAZY)
|
||||
@JoinColumn(name = "loan_product_id", insertable = false, updatable = false)
|
||||
private LoanProduct loanProduct;
|
||||
|
||||
// ---- classification -------------------------------------------------
|
||||
@Column(name = "product_type_group")
|
||||
private String productTypeGroup;
|
||||
|
||||
@Column(name = "product_type_sub_group")
|
||||
private String productTypeSubGroup;
|
||||
|
||||
@Column(name = "gl_account_id")
|
||||
private Long glAccountId;
|
||||
|
||||
@Column(name = "loan_product_category")
|
||||
private String loanProductCategory;
|
||||
|
||||
@Column(name = "priority_sector")
|
||||
private String prioritySector;
|
||||
|
||||
@Column(name = "cibil_account_type")
|
||||
private String cibilAccountType;
|
||||
|
||||
@Column(name = "kfs_enabled")
|
||||
private Boolean kfsEnabled;
|
||||
|
||||
@Column(name = "apr_enabled")
|
||||
private Boolean aprEnabled;
|
||||
|
||||
// ---- facility -------------------------------------------------------
|
||||
@Column(name = "facility_type")
|
||||
private String facilityType;
|
||||
|
||||
// ---- security & margin ----------------------------------------------
|
||||
@Column(name = "security_type")
|
||||
private String securityType;
|
||||
|
||||
@Column(name = "charge_type")
|
||||
private String chargeType;
|
||||
|
||||
@Column(name = "eligible_amount_basis")
|
||||
private String eligibleAmountBasis;
|
||||
|
||||
@Column(name = "margin_pct")
|
||||
private BigDecimal marginPct;
|
||||
|
||||
@Column(name = "ltv_pct")
|
||||
private BigDecimal ltvPct;
|
||||
|
||||
@Column(name = "dp_method")
|
||||
private String dpMethod;
|
||||
|
||||
// ---- lien -----------------------------------------------------------
|
||||
@Column(name = "lien_required")
|
||||
private Boolean lienRequired;
|
||||
|
||||
@Column(name = "lien_marking_stage")
|
||||
private String lienMarkingStage;
|
||||
|
||||
@Column(name = "lien_certificate_required")
|
||||
private Boolean lienCertificateRequired;
|
||||
|
||||
@Column(name = "lien_certificate_prefix")
|
||||
private String lienCertificatePrefix;
|
||||
|
||||
@Column(name = "print_certificate_on_disbursement")
|
||||
private Boolean printCertificateOnDisbursement;
|
||||
|
||||
// ---- interest (extras; rate bounds live on the core product) --------
|
||||
@Column(name = "interest_basis")
|
||||
private String interestBasis;
|
||||
|
||||
@Column(name = "spread_pct")
|
||||
private BigDecimal spreadPct;
|
||||
|
||||
@Column(name = "interest_charged_on")
|
||||
private String interestChargedOn;
|
||||
|
||||
@Column(name = "interest_posting_frequency")
|
||||
private String interestPostingFrequency;
|
||||
|
||||
// ---- penal & NPA (extras; npaDays/grace/tolerance live on core) ------
|
||||
@Column(name = "penal_applicable")
|
||||
private Boolean penalApplicable;
|
||||
|
||||
@Column(name = "penal_rate_pct")
|
||||
private BigDecimal penalRatePct;
|
||||
|
||||
@Column(name = "penal_applied_on")
|
||||
private String penalAppliedOn;
|
||||
|
||||
@Column(name = "penal_grace_days")
|
||||
private Integer penalGraceDays;
|
||||
|
||||
@Column(name = "npa_trigger")
|
||||
private String npaTrigger;
|
||||
|
||||
@Column(name = "interest_after_npa")
|
||||
private String interestAfterNpa;
|
||||
|
||||
@Column(name = "undebited_interest_gl_id")
|
||||
private Long undebitedInterestGlId;
|
||||
|
||||
// ---- renewal & closure ----------------------------------------------
|
||||
@Column(name = "renewal_allowed")
|
||||
private Boolean renewalAllowed;
|
||||
|
||||
@Column(name = "renewal_period_months")
|
||||
private Integer renewalPeriodMonths;
|
||||
|
||||
@Column(name = "renewal_grace_days")
|
||||
private Integer renewalGraceDays;
|
||||
|
||||
@Column(name = "preclosure_allowed")
|
||||
private String preclosureAllowed;
|
||||
|
||||
@Column(name = "lock_in_months")
|
||||
private Integer lockInMonths;
|
||||
|
||||
@Column(name = "interest_on_preclosure")
|
||||
private String interestOnPreclosure;
|
||||
|
||||
// ---- monitoring -----------------------------------------------------
|
||||
@Column(name = "revaluation_freq_months")
|
||||
private Integer revaluationFreqMonths;
|
||||
|
||||
@Column(name = "insurance_required")
|
||||
private Boolean insuranceRequired;
|
||||
|
||||
@Column(name = "stock_statement_freq_months")
|
||||
private Integer stockStatementFreqMonths;
|
||||
|
||||
// ---- cheque book ----------------------------------------------------
|
||||
@Column(name = "cheque_book_enabled")
|
||||
private Boolean chequeBookEnabled;
|
||||
|
||||
@Column(name = "cheque_type")
|
||||
private String chequeType;
|
||||
|
||||
@Column(name = "default_cheque_book_size")
|
||||
private Integer defaultChequeBookSize;
|
||||
|
||||
@Column(name = "pps_threshold")
|
||||
private BigDecimal ppsThreshold;
|
||||
|
||||
@Column(name = "pps_mandatory_above")
|
||||
private BigDecimal ppsMandatoryAbove;
|
||||
|
||||
// ---- share (co-op) --------------------------------------------------
|
||||
@Column(name = "share_capital_gl_id")
|
||||
private Long shareCapitalGlId;
|
||||
|
||||
// ---- security & lien extras -----------------------------------------
|
||||
/** Pledgeable deposit product names, joined with "|". */
|
||||
@Column(name = "eligible_deposit_products")
|
||||
private String eligibleDepositProducts;
|
||||
|
||||
@Column(name = "lien_tenure_not_exceed_maturity")
|
||||
private Boolean lienTenureNotExceedMaturity;
|
||||
|
||||
@Column(name = "lien_auto_release_on_closure")
|
||||
private Boolean lienAutoReleaseOnClosure;
|
||||
|
||||
@Column(name = "lien_allow_multiple_deposits")
|
||||
private Boolean lienAllowMultipleDeposits;
|
||||
|
||||
@Column(name = "lien_adjust_from_maturity")
|
||||
private Boolean lienAdjustFromMaturity;
|
||||
|
||||
@Column(name = "lien_allow_third_party")
|
||||
private Boolean lienAllowThirdParty;
|
||||
|
||||
@Column(name = "lien_allow_renewal_under_lien")
|
||||
private Boolean lienAllowRenewalUnderLien;
|
||||
|
||||
// ---- limit & tenure extras ------------------------------------------
|
||||
@Column(name = "repayment_type")
|
||||
private String repaymentType;
|
||||
|
||||
@Column(name = "appropriation_order")
|
||||
private String appropriationOrder;
|
||||
|
||||
@Column(name = "debit_balance_allow")
|
||||
private Boolean debitBalanceAllow;
|
||||
|
||||
@Column(name = "allow_debit_after_due_date")
|
||||
private Boolean allowDebitAfterDueDate;
|
||||
|
||||
@Column(name = "branch_level_account_type")
|
||||
private Boolean branchLevelAccountType;
|
||||
|
||||
// ---- interest extras ------------------------------------------------
|
||||
@Column(name = "interest_calc_method")
|
||||
private String interestCalcMethod;
|
||||
|
||||
@Column(name = "interest_on_credit_balance")
|
||||
private Boolean interestOnCreditBalance;
|
||||
|
||||
@Column(name = "interest_posting_day")
|
||||
private String interestPostingDay;
|
||||
|
||||
// ---- NPA upgrade rules ----------------------------------------------
|
||||
@Column(name = "npa_upgrade_only_all_arrears")
|
||||
private Boolean npaUpgradeOnlyAllArrears;
|
||||
|
||||
@Column(name = "npa_keep_standard_if_deposit_covers")
|
||||
private Boolean npaKeepStandardIfDepositCovers;
|
||||
|
||||
// ---- cheque book full config ----------------------------------------
|
||||
/** Allowed book sizes (leaves), joined with "|". */
|
||||
@Column(name = "cheque_book_sizes")
|
||||
private String chequeBookSizes;
|
||||
|
||||
@Column(name = "cheque_max_books_outstanding")
|
||||
private Integer chequeMaxBooksOutstanding;
|
||||
|
||||
@Column(name = "cheque_reissue_when_leaves")
|
||||
private Integer chequeReissueWhenLeaves;
|
||||
|
||||
@Column(name = "cheque_first_book_free")
|
||||
private Boolean chequeFirstBookFree;
|
||||
|
||||
@Column(name = "cheque_free_books_per_year")
|
||||
private Integer chequeFreeBooksPerYear;
|
||||
|
||||
@Column(name = "cheque_name_printed")
|
||||
private String chequeNamePrinted;
|
||||
|
||||
@Column(name = "cheque_print_description")
|
||||
private String chequePrintDescription;
|
||||
|
||||
@Column(name = "cheque_stop_payment_allowed")
|
||||
private Boolean chequeStopPaymentAllowed;
|
||||
|
||||
@Column(name = "cheque_maintain_stock_register")
|
||||
private Boolean chequeMaintainStockRegister;
|
||||
|
||||
@Column(name = "cheque_allow_withdrawal_slip")
|
||||
private Boolean chequeAllowWithdrawalSlip;
|
||||
|
||||
@Column(name = "cheque_block_npa")
|
||||
private Boolean chequeBlockNpa;
|
||||
|
||||
@Column(name = "cheque_block_limit_expired")
|
||||
private Boolean chequeBlockLimitExpired;
|
||||
|
||||
@Column(name = "cheque_block_over_dp")
|
||||
private Boolean chequeBlockOverDp;
|
||||
|
||||
@Column(name = "cheque_block_frozen")
|
||||
private Boolean chequeBlockFrozen;
|
||||
|
||||
@Column(name = "cheque_block_lien_released")
|
||||
private Boolean chequeBlockLienReleased;
|
||||
|
||||
// ---- Loans A/C (EMI) wizard fields -------------------------------------
|
||||
@Column(name = "loan_security_mandatory")
|
||||
private String securityMandatory;
|
||||
|
||||
@Column(name = "loan_guarantors_required")
|
||||
private Integer guarantorsRequired;
|
||||
|
||||
@Column(name = "loan_co_applicant")
|
||||
private String coApplicant;
|
||||
|
||||
@Column(name = "loan_third_party_security")
|
||||
private String thirdPartySecurity;
|
||||
|
||||
@Column(name = "loan_legal_opinion_required")
|
||||
private Boolean legalOpinionRequired;
|
||||
|
||||
@Column(name = "loan_property_insurance_required")
|
||||
private Boolean propertyInsuranceRequired;
|
||||
|
||||
@Column(name = "loan_register_charge")
|
||||
private Boolean registerCharge;
|
||||
|
||||
@Column(name = "loan_release_security_on_closure")
|
||||
private Boolean releaseSecurityOnClosure;
|
||||
|
||||
@Column(name = "loan_allow_multiple_securities")
|
||||
private Boolean allowMultipleSecurities;
|
||||
|
||||
@Column(name = "loan_allow_third_party_deposit")
|
||||
private Boolean allowThirdPartyDeposit;
|
||||
|
||||
@Column(name = "loan_min_age")
|
||||
private Integer minAge;
|
||||
|
||||
@Column(name = "loan_max_age_at_maturity")
|
||||
private Integer maxAgeAtMaturity;
|
||||
|
||||
@Column(name = "loan_min_cibil")
|
||||
private Integer minCibil;
|
||||
|
||||
@Column(name = "loan_min_monthly_income")
|
||||
private BigDecimal minMonthlyIncome;
|
||||
|
||||
@Column(name = "loan_max_foir")
|
||||
private BigDecimal maxFoir;
|
||||
|
||||
@Column(name = "loan_max_loans_per_customer")
|
||||
private Integer maxLoansPerCustomer;
|
||||
|
||||
@Column(name = "loan_disbursement_type")
|
||||
private String disbursementType;
|
||||
|
||||
@Column(name = "loan_disbursement_mode")
|
||||
private String disbursementMode;
|
||||
|
||||
@Column(name = "loan_undisbursed_interest")
|
||||
private String undisbursedInterest;
|
||||
|
||||
@Column(name = "loan_pre_emi_interest")
|
||||
private Boolean preEmiInterest;
|
||||
|
||||
@Column(name = "loan_emi_due_day")
|
||||
private String emiDueDay;
|
||||
|
||||
@Column(name = "loan_holiday_rule")
|
||||
private String holidayRule;
|
||||
|
||||
@Column(name = "loan_moratorium_months")
|
||||
private Integer moratoriumMonths;
|
||||
|
||||
@Column(name = "loan_moratorium_interest")
|
||||
private String moratoriumInterest;
|
||||
|
||||
@Column(name = "loan_variable_installments")
|
||||
private Boolean variableInstallments;
|
||||
|
||||
@Column(name = "loan_repayment_mode")
|
||||
private String repaymentMode;
|
||||
|
||||
@Column(name = "loan_linked_account_type")
|
||||
private String linkedAccountType;
|
||||
|
||||
@Column(name = "loan_pdc_collection")
|
||||
private String pdcCollection;
|
||||
|
||||
@Column(name = "loan_mandate_required")
|
||||
private Boolean mandateRequired;
|
||||
|
||||
@Column(name = "loan_advance_emi")
|
||||
private String advanceEmi;
|
||||
|
||||
@Column(name = "loan_rate_type")
|
||||
private String rateType;
|
||||
|
||||
@Column(name = "loan_register_particular")
|
||||
private String registerParticular;
|
||||
|
||||
@Column(name = "loan_apply_cibil_adjustment")
|
||||
private Boolean applyCibilAdjustment;
|
||||
|
||||
@Column(name = "loan_rate_resolved_at")
|
||||
private String rateResolvedAt;
|
||||
|
||||
@Column(name = "loan_calc_period")
|
||||
private String calcPeriod;
|
||||
|
||||
@Column(name = "loan_interest_starts_from")
|
||||
private String interestStartsFrom;
|
||||
|
||||
@Column(name = "loan_compounding")
|
||||
private String compounding;
|
||||
|
||||
@Column(name = "loan_benchmark")
|
||||
private String benchmark;
|
||||
|
||||
@Column(name = "loan_reset_frequency")
|
||||
private String resetFrequency;
|
||||
|
||||
@Column(name = "loan_reset_change")
|
||||
private String resetChange;
|
||||
|
||||
@Column(name = "loan_part_prepayment_allowed")
|
||||
private Boolean partPrepaymentAllowed;
|
||||
|
||||
@Column(name = "loan_min_part_payment")
|
||||
private BigDecimal minPartPayment;
|
||||
|
||||
@Column(name = "loan_allowed_on")
|
||||
private String allowedOn;
|
||||
|
||||
@Column(name = "loan_part_payments_per_year")
|
||||
private String partPaymentsPerYear;
|
||||
|
||||
@Column(name = "loan_part_prepayment_mode")
|
||||
private String partPrepaymentMode;
|
||||
|
||||
@Column(name = "loan_foreclosure_floating_individual")
|
||||
private BigDecimal foreclosureFloatingIndividual;
|
||||
|
||||
@Column(name = "loan_foreclosure_fixed_individual")
|
||||
private BigDecimal foreclosureFixedIndividual;
|
||||
|
||||
@Column(name = "loan_foreclosure_non_individual")
|
||||
private BigDecimal foreclosureNonIndividual;
|
||||
|
||||
@Column(name = "loan_foreclosure_takeover")
|
||||
private BigDecimal foreclosureTakeover;
|
||||
|
||||
@Column(name = "loan_foreclosure_quote_valid_days")
|
||||
private Integer foreclosureQuoteValidDays;
|
||||
|
||||
@Column(name = "loan_auto_close_on_zero_balance")
|
||||
private Boolean autoCloseOnZeroBalance;
|
||||
|
||||
@Column(name = "loan_noc_letter")
|
||||
private String nocLetter;
|
||||
|
||||
@Column(name = "loan_restructuring")
|
||||
private String restructuring;
|
||||
|
||||
@Column(name = "loan_release_collateral_on_closure")
|
||||
private Boolean releaseCollateralOnClosure;
|
||||
|
||||
@Column(name = "loan_top_up_allowed")
|
||||
private Boolean topUpAllowed;
|
||||
|
||||
@Column(name = "loan_balance_transfer_out_allowed")
|
||||
private Boolean balanceTransferOutAllowed;
|
||||
|
||||
public LoanProductAdvanceExt(final LoanProduct loanProduct) {
|
||||
this.loanProduct = loanProduct;
|
||||
this.loanProductId = loanProduct.getId();
|
||||
}
|
||||
}
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
/**
|
||||
* Copyright since 2025 Mifos Initiative
|
||||
*
|
||||
* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
package org.apache.fineract.portfolio.loanproduct.domain;
|
||||
|
||||
import java.util.Optional;
|
||||
import org.springframework.data.jpa.repository.JpaRepository;
|
||||
|
||||
public interface LoanProductAdvanceExtRepository extends JpaRepository<LoanProductAdvanceExt, Long> {
|
||||
|
||||
Optional<LoanProductAdvanceExt> findByLoanProductId(Long loanProductId);
|
||||
}
|
||||
+76
@@ -0,0 +1,76 @@
|
||||
/**
|
||||
* Copyright since 2025 Mifos Initiative
|
||||
*
|
||||
* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
package org.apache.fineract.portfolio.loanproduct.domain;
|
||||
|
||||
import jakarta.persistence.Column;
|
||||
import jakarta.persistence.Entity;
|
||||
import jakarta.persistence.GeneratedValue;
|
||||
import jakarta.persistence.GenerationType;
|
||||
import jakarta.persistence.Id;
|
||||
import jakarta.persistence.Table;
|
||||
import java.math.BigDecimal;
|
||||
import java.time.LocalDateTime;
|
||||
import lombok.Getter;
|
||||
import lombok.NoArgsConstructor;
|
||||
import lombok.Setter;
|
||||
import org.apache.fineract.infrastructure.core.service.DateUtils;
|
||||
|
||||
/**
|
||||
* One CIBIL/credit-score band of a rate register version — e.g. {601..650} tier "Fair" adds +1.00%.
|
||||
* Applied on top of the chart cell at loan sanction. Typically 5 rows per version; ordered on reads
|
||||
* by {@code displayOrder}.
|
||||
*/
|
||||
@Entity
|
||||
@Table(name = "m_loan_rate_register_cibil_slab")
|
||||
@Getter
|
||||
@Setter
|
||||
@NoArgsConstructor
|
||||
public class LoanRateRegisterCibilSlab {
|
||||
|
||||
@Id
|
||||
@GeneratedValue(strategy = GenerationType.IDENTITY)
|
||||
private Long id;
|
||||
|
||||
@Column(name = "effective_id", nullable = false)
|
||||
private Long effectiveId;
|
||||
|
||||
@Column(name = "score_from", nullable = false)
|
||||
private Integer scoreFrom;
|
||||
|
||||
@Column(name = "score_to", nullable = false)
|
||||
private Integer scoreTo;
|
||||
|
||||
@Column(name = "tier", length = 30, nullable = false)
|
||||
private String tier;
|
||||
|
||||
@Column(name = "slab_type", length = 20, nullable = false)
|
||||
private String slabType;
|
||||
|
||||
@Column(name = "adjustment_pct", nullable = false)
|
||||
private BigDecimal adjustmentPct;
|
||||
|
||||
@Column(name = "display_order", nullable = false)
|
||||
private Integer displayOrder;
|
||||
|
||||
@Column(name = "created_date")
|
||||
private LocalDateTime createdDate;
|
||||
|
||||
public static LoanRateRegisterCibilSlab create(final Long effectiveId, final Integer scoreFrom, final Integer scoreTo, final String tier,
|
||||
final String slabType, final BigDecimal adjustmentPct, final Integer displayOrder) {
|
||||
final LoanRateRegisterCibilSlab s = new LoanRateRegisterCibilSlab();
|
||||
s.effectiveId = effectiveId;
|
||||
s.scoreFrom = scoreFrom;
|
||||
s.scoreTo = scoreTo;
|
||||
s.tier = tier;
|
||||
s.slabType = slabType != null ? slabType : "Flat";
|
||||
s.adjustmentPct = adjustmentPct;
|
||||
s.displayOrder = displayOrder;
|
||||
s.createdDate = LocalDateTime.now(DateUtils.getDateTimeZoneOfTenant());
|
||||
return s;
|
||||
}
|
||||
}
|
||||
+17
@@ -0,0 +1,17 @@
|
||||
/**
|
||||
* Copyright since 2025 Mifos Initiative
|
||||
*
|
||||
* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
package org.apache.fineract.portfolio.loanproduct.domain;
|
||||
|
||||
import java.util.List;
|
||||
import org.springframework.data.jpa.repository.JpaRepository;
|
||||
|
||||
public interface LoanRateRegisterCibilSlabRepository extends JpaRepository<LoanRateRegisterCibilSlab, Long> {
|
||||
|
||||
/** CIBIL bands for a version, ordered as the UI shows them (ascending score bands). */
|
||||
List<LoanRateRegisterCibilSlab> findByEffectiveIdOrderByDisplayOrderAsc(Long effectiveId);
|
||||
}
|
||||
+94
@@ -0,0 +1,94 @@
|
||||
/**
|
||||
* Copyright since 2025 Mifos Initiative
|
||||
*
|
||||
* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
package org.apache.fineract.portfolio.loanproduct.domain;
|
||||
|
||||
import jakarta.persistence.Column;
|
||||
import jakarta.persistence.Entity;
|
||||
import jakarta.persistence.GeneratedValue;
|
||||
import jakarta.persistence.GenerationType;
|
||||
import jakarta.persistence.Id;
|
||||
import jakarta.persistence.Table;
|
||||
import java.time.LocalDate;
|
||||
import java.time.LocalDateTime;
|
||||
import lombok.Getter;
|
||||
import lombok.NoArgsConstructor;
|
||||
import lombok.Setter;
|
||||
import org.apache.fineract.infrastructure.core.service.DateUtils;
|
||||
|
||||
/**
|
||||
* One effective (versioned) copy of the central Loan Interest Rate Register. Mirrors the
|
||||
* {@code FdBaseInterestRateEffective} versioning model: each approved save creates a new row with
|
||||
* {@code isActive=true} and deactivates the previous active row ({@code isActive=false,
|
||||
* effectiveToDate=today}). Reads for "current active" filter on {@code isActive=true}.
|
||||
*
|
||||
* The 34-product × 10-slab rate matrix for this version lives in {@link LoanRateRegisterSlabHistory};
|
||||
* the CIBIL/credit-score bands live in {@link LoanRateRegisterCibilSlab}, both keyed by this row's
|
||||
* id and cascade-deleted with it.
|
||||
*/
|
||||
@Entity
|
||||
@Table(name = "m_loan_rate_register_effective")
|
||||
@Getter
|
||||
@Setter
|
||||
@NoArgsConstructor
|
||||
public class LoanRateRegisterEffective {
|
||||
|
||||
@Id
|
||||
@GeneratedValue(strategy = GenerationType.IDENTITY)
|
||||
private Long id;
|
||||
|
||||
@Column(name = "name", length = 200, nullable = false)
|
||||
private String name;
|
||||
|
||||
@Column(name = "effective_from_date", nullable = false)
|
||||
private LocalDate effectiveFromDate;
|
||||
|
||||
@Column(name = "effective_to_date")
|
||||
private LocalDate effectiveToDate;
|
||||
|
||||
@Column(name = "currency_code", length = 3, nullable = false)
|
||||
private String currencyCode;
|
||||
|
||||
@Column(name = "is_active", nullable = false)
|
||||
private Boolean isActive;
|
||||
|
||||
@Column(name = "fallback_no_cibil_slab", nullable = false)
|
||||
private Integer fallbackNoCibilSlab;
|
||||
|
||||
@Column(name = "fallback_below_min", length = 20, nullable = false)
|
||||
private String fallbackBelowMin;
|
||||
|
||||
@Column(name = "note", length = 500)
|
||||
private String note;
|
||||
|
||||
@Column(name = "created_by_id")
|
||||
private Long createdById;
|
||||
|
||||
@Column(name = "created_date")
|
||||
private LocalDateTime createdDate;
|
||||
|
||||
public static LoanRateRegisterEffective create(final String name, final LocalDate effectiveFromDate, final String currencyCode,
|
||||
final Integer fallbackNoCibilSlab, final String fallbackBelowMin, final String note, final Long createdById) {
|
||||
final LoanRateRegisterEffective e = new LoanRateRegisterEffective();
|
||||
e.name = name;
|
||||
e.effectiveFromDate = effectiveFromDate;
|
||||
e.currencyCode = currencyCode != null ? currencyCode : "INR";
|
||||
e.isActive = true;
|
||||
e.fallbackNoCibilSlab = fallbackNoCibilSlab != null ? fallbackNoCibilSlab : 2;
|
||||
e.fallbackBelowMin = fallbackBelowMin != null ? fallbackBelowMin : "block";
|
||||
e.note = note;
|
||||
e.createdById = createdById;
|
||||
e.createdDate = LocalDateTime.now(DateUtils.getDateTimeZoneOfTenant());
|
||||
return e;
|
||||
}
|
||||
|
||||
/** Flip this version to inactive and close its effective window. Called when a newer version is approved. */
|
||||
public void deactivate(final LocalDate toDate) {
|
||||
this.isActive = false;
|
||||
this.effectiveToDate = toDate;
|
||||
}
|
||||
}
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
/**
|
||||
* Copyright since 2025 Mifos Initiative
|
||||
*
|
||||
* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
package org.apache.fineract.portfolio.loanproduct.domain;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.Optional;
|
||||
import org.springframework.data.jpa.repository.JpaRepository;
|
||||
|
||||
public interface LoanRateRegisterEffectiveRepository extends JpaRepository<LoanRateRegisterEffective, Long> {
|
||||
|
||||
/** All active versions, newest-effective first. At most one row in a healthy system. */
|
||||
List<LoanRateRegisterEffective> findByIsActiveTrueOrderByEffectiveFromDateDesc();
|
||||
|
||||
/** The current active version, if any. */
|
||||
Optional<LoanRateRegisterEffective> findFirstByIsActiveTrueOrderByEffectiveFromDateDesc();
|
||||
|
||||
/** Version history list — all versions, newest first. */
|
||||
List<LoanRateRegisterEffective> findAllByOrderByEffectiveFromDateDesc();
|
||||
}
|
||||
+52
@@ -0,0 +1,52 @@
|
||||
/**
|
||||
* Copyright since 2025 Mifos Initiative
|
||||
*
|
||||
* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
package org.apache.fineract.portfolio.loanproduct.domain;
|
||||
|
||||
import jakarta.persistence.Column;
|
||||
import jakarta.persistence.Entity;
|
||||
import jakarta.persistence.GeneratedValue;
|
||||
import jakarta.persistence.GenerationType;
|
||||
import jakarta.persistence.Id;
|
||||
import jakarta.persistence.Table;
|
||||
import java.time.LocalDateTime;
|
||||
import lombok.Getter;
|
||||
import lombok.NoArgsConstructor;
|
||||
import lombok.Setter;
|
||||
|
||||
/**
|
||||
* A "particular" (loan type) row of the Loan Interest Rate Register chart. The GL account is a
|
||||
* property of the particular, so it lives here rather than on each rate-register version. Kept as a
|
||||
* plain {@code gl_account_id} column (no relation) to avoid pulling the accounting module's entity
|
||||
* graph into the loan module.
|
||||
*/
|
||||
@Entity
|
||||
@Table(name = "m_loan_rate_register_product")
|
||||
@Getter
|
||||
@Setter
|
||||
@NoArgsConstructor
|
||||
public class LoanRateRegisterProduct {
|
||||
|
||||
@Id
|
||||
@GeneratedValue(strategy = GenerationType.IDENTITY)
|
||||
private Long id;
|
||||
|
||||
@Column(name = "sr_no", nullable = false)
|
||||
private Integer srNo;
|
||||
|
||||
@Column(name = "name", length = 200, nullable = false)
|
||||
private String name;
|
||||
|
||||
@Column(name = "gl_account_id")
|
||||
private Long glAccountId;
|
||||
|
||||
@Column(name = "is_active", nullable = false)
|
||||
private Boolean isActive;
|
||||
|
||||
@Column(name = "created_date")
|
||||
private LocalDateTime createdDate;
|
||||
}
|
||||
+17
@@ -0,0 +1,17 @@
|
||||
/**
|
||||
* Copyright since 2025 Mifos Initiative
|
||||
*
|
||||
* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
package org.apache.fineract.portfolio.loanproduct.domain;
|
||||
|
||||
import java.util.List;
|
||||
import org.springframework.data.jpa.repository.JpaRepository;
|
||||
|
||||
public interface LoanRateRegisterProductRepository extends JpaRepository<LoanRateRegisterProduct, Long> {
|
||||
|
||||
/** Active particulars in chart order. */
|
||||
List<LoanRateRegisterProduct> findByIsActiveTrueOrderBySrNoAsc();
|
||||
}
|
||||
+98
@@ -0,0 +1,98 @@
|
||||
/**
|
||||
* Copyright since 2025 Mifos Initiative
|
||||
*
|
||||
* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
package org.apache.fineract.portfolio.loanproduct.domain;
|
||||
|
||||
import jakarta.persistence.Column;
|
||||
import jakarta.persistence.Entity;
|
||||
import jakarta.persistence.GeneratedValue;
|
||||
import jakarta.persistence.GenerationType;
|
||||
import jakarta.persistence.Id;
|
||||
import jakarta.persistence.Table;
|
||||
import java.math.BigDecimal;
|
||||
import java.time.LocalDateTime;
|
||||
import lombok.Getter;
|
||||
import lombok.NoArgsConstructor;
|
||||
import lombok.Setter;
|
||||
import org.apache.fineract.infrastructure.core.service.DateUtils;
|
||||
|
||||
/**
|
||||
* A single cell of a rate register version — one row per {product × amount-slab}. Product and slab
|
||||
* metadata are denormalised so one query can rebuild the full matrix without a join. The cell holds
|
||||
* either a plain numeric rate, a formula string ({@code "1% + FD"}) resolved at sanction, or
|
||||
* N.A. (both value and formula null, {@code isNa=true}) to mean "slab not offered".
|
||||
*/
|
||||
@Entity
|
||||
@Table(name = "m_loan_rate_register_slab_history")
|
||||
@Getter
|
||||
@Setter
|
||||
@NoArgsConstructor
|
||||
public class LoanRateRegisterSlabHistory {
|
||||
|
||||
@Id
|
||||
@GeneratedValue(strategy = GenerationType.IDENTITY)
|
||||
private Long id;
|
||||
|
||||
@Column(name = "effective_id", nullable = false)
|
||||
private Long effectiveId;
|
||||
|
||||
// ---- product dimension ----------------------------------------------
|
||||
/** Stable link to the master particular (and its GL). Null only for rows written before the master existed. */
|
||||
@Column(name = "product_id")
|
||||
private Long productId;
|
||||
|
||||
@Column(name = "product_sr_no", nullable = false)
|
||||
private Integer productSrNo;
|
||||
|
||||
@Column(name = "product_name", length = 200, nullable = false)
|
||||
private String productName;
|
||||
|
||||
// ---- amount-slab dimension ------------------------------------------
|
||||
@Column(name = "slab_order", nullable = false)
|
||||
private Integer slabOrder;
|
||||
|
||||
@Column(name = "slab_label", length = 60, nullable = false)
|
||||
private String slabLabel;
|
||||
|
||||
@Column(name = "amount_upto")
|
||||
private BigDecimal amountUpto;
|
||||
|
||||
// ---- cell value (exactly one of value / formula is populated; both null + isNa=true means N.A.) ----
|
||||
@Column(name = "rate_value")
|
||||
private BigDecimal rateValue;
|
||||
|
||||
@Column(name = "rate_formula", length = 50)
|
||||
private String rateFormula;
|
||||
|
||||
@Column(name = "is_formula", nullable = false)
|
||||
private Boolean isFormula;
|
||||
|
||||
@Column(name = "is_na", nullable = false)
|
||||
private Boolean isNa;
|
||||
|
||||
@Column(name = "created_date")
|
||||
private LocalDateTime createdDate;
|
||||
|
||||
public static LoanRateRegisterSlabHistory create(final Long effectiveId, final Long productId, final Integer productSrNo,
|
||||
final String productName, final Integer slabOrder, final String slabLabel, final BigDecimal amountUpto,
|
||||
final BigDecimal rateValue, final String rateFormula, final boolean isFormula, final boolean isNa) {
|
||||
final LoanRateRegisterSlabHistory s = new LoanRateRegisterSlabHistory();
|
||||
s.effectiveId = effectiveId;
|
||||
s.productId = productId;
|
||||
s.productSrNo = productSrNo;
|
||||
s.productName = productName;
|
||||
s.slabOrder = slabOrder;
|
||||
s.slabLabel = slabLabel;
|
||||
s.amountUpto = amountUpto;
|
||||
s.rateValue = rateValue;
|
||||
s.rateFormula = rateFormula;
|
||||
s.isFormula = isFormula;
|
||||
s.isNa = isNa;
|
||||
s.createdDate = LocalDateTime.now(DateUtils.getDateTimeZoneOfTenant());
|
||||
return s;
|
||||
}
|
||||
}
|
||||
+17
@@ -0,0 +1,17 @@
|
||||
/**
|
||||
* Copyright since 2025 Mifos Initiative
|
||||
*
|
||||
* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
package org.apache.fineract.portfolio.loanproduct.domain;
|
||||
|
||||
import java.util.List;
|
||||
import org.springframework.data.jpa.repository.JpaRepository;
|
||||
|
||||
public interface LoanRateRegisterSlabHistoryRepository extends JpaRepository<LoanRateRegisterSlabHistory, Long> {
|
||||
|
||||
/** All cells of a version, ordered by product then by amount-slab. Rebuilds the full matrix in order. */
|
||||
List<LoanRateRegisterSlabHistory> findByEffectiveIdOrderByProductSrNoAscSlabOrderAsc(Long effectiveId);
|
||||
}
|
||||
+6
@@ -60,6 +60,7 @@ import org.apache.fineract.infrastructure.core.api.DateParam;
|
||||
import org.apache.fineract.infrastructure.core.data.CommandProcessingResult;
|
||||
import org.apache.fineract.infrastructure.core.data.DateFormat;
|
||||
import org.apache.fineract.infrastructure.core.data.UploadRequest;
|
||||
import org.apache.fineract.infrastructure.core.exception.PlatformDataIntegrityException;
|
||||
import org.apache.fineract.infrastructure.core.exception.UnrecognizedQueryParamException;
|
||||
import org.apache.fineract.infrastructure.core.serialization.ApiRequestJsonSerializationSettings;
|
||||
import org.apache.fineract.infrastructure.core.serialization.DefaultToApiJsonSerializer;
|
||||
@@ -229,6 +230,11 @@ public class JournalEntriesApiResource {
|
||||
@PathParam("transactionId") @Parameter(description = "transactionId") final String transactionId,
|
||||
@QueryParam("command") @Parameter(description = "command") final String commandParam) {
|
||||
CommandProcessingResult result;
|
||||
if (is(commandParam, "reverse")) {
|
||||
throw new PlatformDataIntegrityException("error.msg.journalentry.reverse.not.allowed",
|
||||
"Reversing a journal entry is not allowed.");
|
||||
}
|
||||
|
||||
if (is(commandParam, "reverse")) {
|
||||
final CommandWrapper commandRequest = new CommandWrapperBuilder().reverseJournalEntry(transactionId).withJson(jsonRequestBody)
|
||||
.build();
|
||||
|
||||
+28
-3
@@ -650,7 +650,7 @@ public class AccountingProcessorHelper {
|
||||
*/
|
||||
public void createInterestPostingJournalEntriesForSavings(final Office office, final String currencyCode,
|
||||
final Long savingsProductId, final Long paymentTypeId, final Long savingsId, final String transactionId,
|
||||
final LocalDate transactionDate, final BigDecimal amount, final boolean isReversal) {
|
||||
final LocalDate transactionDate, final BigDecimal amount, final boolean isReversal, final boolean payableCarriesAccrual) {
|
||||
|
||||
final GLAccount controlAccount = getLinkedGLAccountForSavingsProduct(savingsProductId,
|
||||
CashAccountsForSavings.SAVINGS_CONTROL.getValue(), paymentTypeId);
|
||||
@@ -665,10 +665,14 @@ public class AccountingProcessorHelper {
|
||||
.ofNullable(optionalLinkedGLAccountForSavingsProduct(savingsProductId,
|
||||
AccrualAccountsForSavings.INTEREST_PAYABLE.getValue(), paymentTypeId))
|
||||
.or(() -> Optional.ofNullable(namedSavingsGlAccount(savingsProductId,
|
||||
SAVINGS_INTEREST_PAYABLE_MAPPING, "Fixed Deposit Interest Payable", "Interest Payable", "Interest Payable Account")))
|
||||
SAVINGS_INTEREST_PAYABLE_MAPPING, "Fixed Deposit Interest Payable", "Recurring Deposit Interest Payable",
|
||||
"Interest Payable", "Interest Payable Account")))
|
||||
.orElse(controlAccount);
|
||||
// The RD product screen saves its paid account as "Recurring Deposit Interest Paid"; without that name here an
|
||||
// RD's interest skipped the paid leg even when the product had one mapped.
|
||||
final GLAccount paidAccount = Optional.ofNullable(namedSavingsGlAccount(savingsProductId,
|
||||
SAVINGS_INTEREST_PAID_MAPPING, "Fixed Deposit Interest Paid", "Interest Paid", "Interest Paid Account"))
|
||||
SAVINGS_INTEREST_PAID_MAPPING, "Fixed Deposit Interest Paid", "Recurring Deposit Interest Paid", "Interest Paid",
|
||||
"Interest Paid Account"))
|
||||
.orElse(payableAccount);
|
||||
|
||||
log.info("createInterestPostingJournalEntriesForSavings: savingsProductId={}, payableAccount=[{} - {}], paidAccount=[{} - {}], controlAccount=[{} - {}], interestExpense=[{} - {}], amount={}, isReversal={}",
|
||||
@@ -706,6 +710,19 @@ public class AccountingProcessorHelper {
|
||||
// debit balance would come back negative and every posting would raise a shortfall larger
|
||||
// than the interest itself.
|
||||
final boolean payableIsLiability = GLAccountType.LIABILITY.getValue().equals(payableAccount.getType());
|
||||
if (!payableCarriesAccrual) {
|
||||
// Cash basis: nothing ever accrues into the payable, so whatever already sits on it - an opening balance
|
||||
// brought over at migration, or another product's interest sharing the GL - is not this interest. Reading
|
||||
// it as "already accrued" skipped the expense and drew that balance down instead, leaving the cost off the
|
||||
// P&L. The whole amount is charged and raised, and a reversal or clawback takes it back the same way.
|
||||
if (payableIsLiability) {
|
||||
postSavingsLeg(office, currencyCode, interestOnSavingsAccount, payableAccount, savingsId, transactionId, transactionDate,
|
||||
amount, isReversal);
|
||||
}
|
||||
postPayableToMember(office, currencyCode, payableAccount, paidAccount, controlAccount, savingsId, transactionId,
|
||||
transactionDate, amount, isReversal);
|
||||
return;
|
||||
}
|
||||
final BigDecimal alreadyAccrued = payableBalance(office, payableAccount, currencyCode);
|
||||
final BigDecimal shortfall = amount.subtract(alreadyAccrued).max(BigDecimal.ZERO);
|
||||
log.info("createInterestPostingJournalEntriesForSavings: alreadyAccrued={}, shortfall={}, payableIsLiability={}, isReversal={}",
|
||||
@@ -718,6 +735,14 @@ public class AccountingProcessorHelper {
|
||||
shortfall, false);
|
||||
}
|
||||
|
||||
postPayableToMember(office, currencyCode, payableAccount, paidAccount, controlAccount, savingsId, transactionId, transactionDate,
|
||||
amount, isReversal);
|
||||
}
|
||||
|
||||
/** Stages 2 and 3: out of the payable, through the paid account when the product names one, into the member. */
|
||||
private void postPayableToMember(final Office office, final String currencyCode, final GLAccount payableAccount,
|
||||
final GLAccount paidAccount, final GLAccount controlAccount, final Long savingsId, final String transactionId,
|
||||
final LocalDate transactionDate, final BigDecimal amount, final boolean isReversal) {
|
||||
final boolean hasSeparatePaidAccount = !payableAccount.getId().equals(paidAccount.getId());
|
||||
if (hasSeparatePaidAccount) {
|
||||
log.info("createInterestPostingJournalEntriesForSavings: posting Stage 2 [Dr {} / Cr {} = {}] and Stage 3 [Dr {} / Cr {} = {}]",
|
||||
|
||||
+1
-1
@@ -194,7 +194,7 @@ public class AccrualBasedAccountingProcessorForSavings implements AccountingProc
|
||||
// payable-to-control pair that used to be here, which skipped interest-paid
|
||||
// entirely and left the expense off the P&L.
|
||||
this.helper.createInterestPostingJournalEntriesForSavings(office, currencyCode, savingsProductId, paymentTypeId,
|
||||
savingsId, transactionId, transactionDate, postingAmount, effectiveIsReversal);
|
||||
savingsId, transactionId, transactionDate, postingAmount, effectiveIsReversal, true);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
+1
-1
@@ -186,7 +186,7 @@ public class CashBasedAccountingProcessorForSavings implements AccountingProcess
|
||||
// to the plain Dr Interest On Savings / Cr Savings Control pair for a product
|
||||
// that names neither.
|
||||
this.helper.createInterestPostingJournalEntriesForSavings(office, currencyCode, savingsProductId, paymentTypeId,
|
||||
savingsId, transactionId, transactionDate, postingAmount, effectiveIsReversal);
|
||||
savingsId, transactionId, transactionDate, postingAmount, effectiveIsReversal, false);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
+31
-1
@@ -687,6 +687,16 @@ public class JournalEntryWritePlatformServiceJpaRepositoryImpl implements Journa
|
||||
}
|
||||
|
||||
private void validateBusinessRulesForJournalEntries(final JournalEntryCommand command) {
|
||||
validateBusinessRulesForJournalEntries(command, true);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param requireBalanced
|
||||
* false for opening balances: every leg is posted against the contra account, so the books always
|
||||
* balance, and the submitted legs legitimately differ by the locked (denomination-managed) cash
|
||||
* account's opening balance that is already posted and can never be part of this request.
|
||||
*/
|
||||
private void validateBusinessRulesForJournalEntries(final JournalEntryCommand command, final boolean requireBalanced) {
|
||||
// check if date of Journal entry is valid
|
||||
final LocalDate transactionDate = command.getTransactionDate();
|
||||
// shouldn't be in the future
|
||||
@@ -706,6 +716,26 @@ public class JournalEntryWritePlatformServiceJpaRepositoryImpl implements Journa
|
||||
final SingleDebitOrCreditEntryCommand[] credits = command.getCredits();
|
||||
final SingleDebitOrCreditEntryCommand[] debits = command.getDebits();
|
||||
|
||||
if (!requireBalanced) {
|
||||
final List<SingleDebitOrCreditEntryCommand> entries = new ArrayList<>();
|
||||
if (credits != null) {
|
||||
entries.addAll(Arrays.asList(credits));
|
||||
}
|
||||
if (debits != null) {
|
||||
entries.addAll(Arrays.asList(debits));
|
||||
}
|
||||
if (entries.isEmpty()) {
|
||||
throw new JournalEntryInvalidException(GlJournalEntryInvalidReason.NO_DEBITS_OR_CREDITS, null, null, null);
|
||||
}
|
||||
for (final SingleDebitOrCreditEntryCommand entry : entries) {
|
||||
if (entry.getAmount() == null || entry.getGlAccountId() == null) {
|
||||
throw new JournalEntryInvalidException(GlJournalEntryInvalidReason.DEBIT_CREDIT_ACCOUNT_OR_AMOUNT_EMPTY, null, null,
|
||||
null);
|
||||
}
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
// atleast one debit or credit must be present
|
||||
if (credits == null || credits.length == 0 || debits == null || debits.length == 0) {
|
||||
throw new JournalEntryInvalidException(GlJournalEntryInvalidReason.NO_DEBITS_OR_CREDITS, null, null, null);
|
||||
@@ -783,7 +813,7 @@ public class JournalEntryWritePlatformServiceJpaRepositoryImpl implements Journa
|
||||
final Office office = this.officeRepositoryWrapper.findOneWithNotFoundDetection(officeId);
|
||||
final String currencyCode = command.stringValueOfParameterNamed(JournalEntryJsonInputParams.CURRENCY_CODE.getValue());
|
||||
|
||||
validateBusinessRulesForJournalEntries(journalEntryCommand);
|
||||
validateBusinessRulesForJournalEntries(journalEntryCommand, false);
|
||||
validateNoDenominationManagedCashAccounts(journalEntryCommand);
|
||||
|
||||
/**
|
||||
|
||||
+4
@@ -84,4 +84,8 @@ public final class LedgerTxnPrefix {
|
||||
// ── Savings ───────────────────────────────────────────────────────────────
|
||||
/** Pooled savings interest posting for one product and date. */
|
||||
public static final String SAVINGS_INTEREST_POOLED = "SAVINT";
|
||||
|
||||
// ── Fixed deposits ────────────────────────────────────────────────────────
|
||||
/** Approved fixed deposit interest posting report, for one product, branch and date. */
|
||||
public static final String FD_INTEREST_POSTED = "FDINT";
|
||||
}
|
||||
|
||||
+7
-1
@@ -294,8 +294,14 @@ public class ProductToGLAccountMappingWritePlatformServiceImpl implements Produc
|
||||
SavingProductAccountingParams.TRANSFERS_SUSPENSE.getValue(), savingProductId,
|
||||
CashAccountsForSavings.TRANSFERS_SUSPENSE.getValue());
|
||||
|
||||
// FD and RD products switch dormancy on with "dormancyAlert" (DepositProductAssembler derives the product's
|
||||
// tracking flag from it) and never send isDormancyTrackingActive, so reading only that dropped the escheat
|
||||
// account the screen had asked for - the product then tracked dormancy with no escheat account mapped.
|
||||
final Boolean isDormancyTrackingActive = this.fromApiJsonHelper.extractBooleanNamed(isDormancyTrackingActiveParamName, element);
|
||||
if (null != isDormancyTrackingActive && isDormancyTrackingActive) {
|
||||
final Boolean dormancyAlert = this.fromApiJsonHelper.parameterExists("dormancyAlert", element)
|
||||
? this.fromApiJsonHelper.extractBooleanNamed("dormancyAlert", element)
|
||||
: null;
|
||||
if (Boolean.TRUE.equals(isDormancyTrackingActive) || Boolean.TRUE.equals(dormancyAlert)) {
|
||||
this.savingsProductToGLAccountMappingHelper.saveSavingsToLiabilityAccountMapping(element,
|
||||
SavingProductAccountingParams.ESCHEAT_LIABILITY.getValue(), savingProductId,
|
||||
CashAccountsForSavings.ESCHEAT_LIABILITY.getValue());
|
||||
|
||||
+10
@@ -191,6 +191,16 @@ public class ConfigurationDomainServiceJpa implements ConfigurationDomainService
|
||||
return property.isEnabled();
|
||||
}
|
||||
|
||||
/**
|
||||
* Read on every run of the interest posting job and of the day close, so the two paths can never
|
||||
* both pay the same deposit: with this on the job leaves fixed deposits alone and they are paid
|
||||
* from an approved report, with it off the job pays them directly as it always did.
|
||||
*/
|
||||
@Override
|
||||
public boolean isFixedDepositInterestPostingApprovalEnabled() {
|
||||
return getGlobalConfigurationPropertyData(GlobalConfigurationConstants.FD_INTEREST_POSTING_APPROVAL).isEnabled();
|
||||
}
|
||||
|
||||
@Override
|
||||
public Integer retrieveFinancialYearBeginningMonth() {
|
||||
final GlobalConfigurationPropertyData property = getGlobalConfigurationPropertyData(
|
||||
|
||||
+6
@@ -68,6 +68,7 @@ public class TenantDatabaseUpgradeService implements InitializingBean {
|
||||
private final ExtendedSpringLiquibaseFactory liquibaseFactory;
|
||||
private final TenantDataSourceFactory tenantDataSourceFactory;
|
||||
private final Environment environment;
|
||||
private final TenantInitialUserProvisioner initialUserProvisioner;
|
||||
|
||||
// DO NOT REMOVE! Required for liquibase custom task initialization
|
||||
private final List<CustomTaskChange> customTaskChangesForDependencyInjection;
|
||||
@@ -195,10 +196,15 @@ public class TenantDatabaseUpgradeService implements InitializingBean {
|
||||
// configuration
|
||||
// settings, and we should not use them to control the script order
|
||||
if (databaseStateVerifier.isFirstLiquibaseMigration(tenantDataSource)) {
|
||||
// a Flyway-era database already has its real users; only a brand-new tenant gets the seeded ones
|
||||
final boolean brandNewTenant = !databaseStateVerifier.isFlywayPresent(tenantDataSource);
|
||||
ExtendedSpringLiquibase liquibase = liquibaseFactory.create(tenantDataSource, TENANT_DB_CONTEXT,
|
||||
CUSTOM_CHANGELOG_CONTEXT, INITIAL_SWITCH_CONTEXT, tenant.getTenantIdentifier());
|
||||
applyInitialLiquibase(tenantDataSource, liquibase, tenant.getTenantIdentifier(),
|
||||
(ds) -> !databaseStateVerifier.isTenantOnLatestUpgradableVersion(ds));
|
||||
if (brandNewTenant) {
|
||||
initialUserProvisioner.provision(tenantDataSource, tenant.getTenantIdentifier());
|
||||
}
|
||||
}
|
||||
SpringLiquibase tenantLiquibase = liquibaseFactory.create(tenantDataSource, TENANT_DB_CONTEXT, CUSTOM_CHANGELOG_CONTEXT,
|
||||
tenant.getTenantIdentifier());
|
||||
|
||||
+90
@@ -0,0 +1,90 @@
|
||||
/**
|
||||
* 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.core.service.migration;
|
||||
|
||||
import java.util.Locale;
|
||||
import javax.sql.DataSource;
|
||||
import lombok.RequiredArgsConstructor;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.apache.fineract.useradministration.service.AppUserConstants;
|
||||
import org.springframework.core.env.Environment;
|
||||
import org.springframework.jdbc.core.JdbcTemplate;
|
||||
import org.springframework.security.crypto.factory.PasswordEncoderFactories;
|
||||
import org.springframework.security.crypto.password.PasswordEncoder;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
/**
|
||||
* Personalises the three users that the initial Liquibase data seeds into every brand-new tenant database (ids 1-3,
|
||||
* which otherwise ship with the well-known {@code mifos} / {@code system} / {@code interopUser} usernames and the
|
||||
* public default password).
|
||||
*
|
||||
* Runs only right after the very first migration of a tenant that was never on Flyway, so existing tenants are never
|
||||
* touched. The seeded changeSet itself is deliberately left alone: editing it would change its Liquibase checksum and
|
||||
* break validation on every tenant that already ran it.
|
||||
*
|
||||
* Usernames become {@code <tenantIdentifier>_admin} and {@code <tenantIdentifier>_interop}. The system user keeps the
|
||||
* {@link AppUserConstants#SYSTEM_USER_NAME} username because scheduler jobs, COB and other background processes look it
|
||||
* up by that name; only its password is changed. All three share one password: the value of
|
||||
* {@code fineract.tenant.initial-user-password} (env {@code FINERACT_TENANT_INITIAL_USER_PASSWORD}) when set,
|
||||
* otherwise {@link #DEFAULT_PASSWORD}.
|
||||
*/
|
||||
@Component
|
||||
@Slf4j
|
||||
@RequiredArgsConstructor
|
||||
public class TenantInitialUserProvisioner {
|
||||
|
||||
static final String PASSWORD_PROPERTY = "fineract.tenant.initial-user-password";
|
||||
|
||||
private static final long ADMIN_ID = 1L;
|
||||
private static final long SYSTEM_ID = 2L;
|
||||
private static final long INTEROP_ID = 3L;
|
||||
// Meets the "strong" password policy (upper, lower, digit, special, no space, under 50 chars).
|
||||
static final String DEFAULT_PASSWORD = "Cbs@Nexora#2026!Secure";
|
||||
|
||||
private final Environment environment;
|
||||
|
||||
public void provision(final DataSource dataSource, final String tenantIdentifier) {
|
||||
final JdbcTemplate jdbc = new JdbcTemplate(dataSource);
|
||||
final String prefix = usernamePrefix(tenantIdentifier);
|
||||
|
||||
final String configured = environment.getProperty(PASSWORD_PROPERTY);
|
||||
final boolean overridden = configured != null && !configured.isBlank();
|
||||
final String password = overridden ? configured : DEFAULT_PASSWORD;
|
||||
final PasswordEncoder encoder = PasswordEncoderFactories.createDelegatingPasswordEncoder();
|
||||
final String encoded = encoder.encode(password);
|
||||
|
||||
update(jdbc, ADMIN_ID, prefix + "_admin", encoded);
|
||||
update(jdbc, SYSTEM_ID, AppUserConstants.SYSTEM_USER_NAME, encoded);
|
||||
update(jdbc, INTEROP_ID, prefix + "_interop", encoded);
|
||||
|
||||
log.warn("Tenant '{}' initial users created: {}_admin, {}, {}_interop (password: {}). Change it after first login.",
|
||||
tenantIdentifier, prefix, AppUserConstants.SYSTEM_USER_NAME, prefix, overridden ? "from " + PASSWORD_PROPERTY : "built-in default");
|
||||
}
|
||||
|
||||
private void update(final JdbcTemplate jdbc, final long id, final String username, final String encodedPassword) {
|
||||
jdbc.update("UPDATE m_appuser SET username = ?, password = ?, last_time_password_updated = CURRENT_DATE WHERE id = ?", username,
|
||||
encodedPassword, id);
|
||||
}
|
||||
|
||||
static String usernamePrefix(final String tenantIdentifier) {
|
||||
final String cleaned = tenantIdentifier.toLowerCase(Locale.ROOT).replaceAll("[^a-z0-9]+", "_").replaceAll("^_+|_+$", "");
|
||||
return cleaned.isEmpty() ? "tenant" : cleaned;
|
||||
}
|
||||
|
||||
}
|
||||
+120
@@ -0,0 +1,120 @@
|
||||
/**
|
||||
* 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.organisation.agent.api;
|
||||
|
||||
import io.swagger.v3.oas.annotations.Operation;
|
||||
import io.swagger.v3.oas.annotations.Parameter;
|
||||
import io.swagger.v3.oas.annotations.tags.Tag;
|
||||
import jakarta.ws.rs.Consumes;
|
||||
import jakarta.ws.rs.GET;
|
||||
import jakarta.ws.rs.POST;
|
||||
import jakarta.ws.rs.PUT;
|
||||
import jakarta.ws.rs.Path;
|
||||
import jakarta.ws.rs.PathParam;
|
||||
import jakarta.ws.rs.Produces;
|
||||
import jakarta.ws.rs.core.MediaType;
|
||||
import java.util.Collection;
|
||||
import lombok.RequiredArgsConstructor;
|
||||
import org.apache.fineract.commands.domain.CommandWrapper;
|
||||
import org.apache.fineract.commands.service.CommandWrapperBuilder;
|
||||
import org.apache.fineract.commands.service.PortfolioCommandSourceWritePlatformService;
|
||||
import org.apache.fineract.infrastructure.core.data.CommandProcessingResult;
|
||||
import org.apache.fineract.infrastructure.security.service.PlatformSecurityContext;
|
||||
import org.apache.fineract.organisation.agent.data.AgentData;
|
||||
import org.apache.fineract.organisation.agent.service.AgentReadPlatformService;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
@Path("/v1/dds/agents")
|
||||
@Component
|
||||
@Tag(name = "DDS Agents", description = "A DDS collection agent - either a person or, at the top of the hierarchy, the bank itself - with its own settlement savings account and guarantors.")
|
||||
@RequiredArgsConstructor
|
||||
public class AgentsApiResource {
|
||||
|
||||
private static final String RESOURCE_NAME_FOR_PERMISSIONS = "AGENT";
|
||||
|
||||
private final PlatformSecurityContext context;
|
||||
private final AgentReadPlatformService readPlatformService;
|
||||
private final PortfolioCommandSourceWritePlatformService commandsSourceWritePlatformService;
|
||||
|
||||
@GET
|
||||
@Consumes({ MediaType.APPLICATION_JSON })
|
||||
@Produces({ MediaType.APPLICATION_JSON })
|
||||
@Operation(summary = "Retrieve DDS Agents", description = "Returns the list of DDS agents.")
|
||||
public Collection<AgentData> retrieveAll() {
|
||||
context.authenticatedUser().validateHasReadPermission(RESOURCE_NAME_FOR_PERMISSIONS);
|
||||
return readPlatformService.retrieveAll();
|
||||
}
|
||||
|
||||
@GET
|
||||
@Path("{agentId}")
|
||||
@Consumes({ MediaType.APPLICATION_JSON })
|
||||
@Produces({ MediaType.APPLICATION_JSON })
|
||||
@Operation(summary = "Retrieve a DDS Agent", description = "Returns the details of a DDS agent, including its guarantors.")
|
||||
public AgentData retrieveOne(@PathParam("agentId") @Parameter(description = "agentId") final Long agentId) {
|
||||
context.authenticatedUser().validateHasReadPermission(RESOURCE_NAME_FOR_PERMISSIONS);
|
||||
return readPlatformService.retrieveOne(agentId);
|
||||
}
|
||||
|
||||
@POST
|
||||
@Consumes({ MediaType.APPLICATION_JSON })
|
||||
@Produces({ MediaType.APPLICATION_JSON })
|
||||
@Operation(summary = "Create a DDS Agent", description = "Mandatory fields: clientId, agentNameId, agentAddress1, agentCity, "
|
||||
+ "agentPinCode, agentSavingAccountType, agentSavingAccountNo, agentOpeningDate, agentBirthDate\n" + "\n"
|
||||
+ "Optional fields: agentAddress2, agentTelephone, agentOpeningBalance, officeId, guarantors\n" + "\n"
|
||||
+ "officeId is the branch the agent belongs to, and defaults to the client's own office. "
|
||||
+ "agentSavingAccountNo must be an open savings account of that same client - the agent's "
|
||||
+ "commission is paid into it.")
|
||||
public CommandProcessingResult create(@Parameter(hidden = true) final String apiRequestBodyAsJson) {
|
||||
final CommandWrapper commandRequest = new CommandWrapperBuilder() //
|
||||
.createAgent() //
|
||||
.withJson(apiRequestBodyAsJson) //
|
||||
.build();
|
||||
return commandsSourceWritePlatformService.logCommandSource(commandRequest);
|
||||
}
|
||||
|
||||
@PUT
|
||||
@Path("{agentId}")
|
||||
@Consumes({ MediaType.APPLICATION_JSON })
|
||||
@Produces({ MediaType.APPLICATION_JSON })
|
||||
@Operation(summary = "Update a DDS Agent", description = "Updates the details of a DDS agent.")
|
||||
public CommandProcessingResult update(@PathParam("agentId") @Parameter(description = "agentId") final Long agentId,
|
||||
@Parameter(hidden = true) final String apiRequestBodyAsJson) {
|
||||
final CommandWrapper commandRequest = new CommandWrapperBuilder() //
|
||||
.updateAgent(agentId) //
|
||||
.withJson(apiRequestBodyAsJson) //
|
||||
.build();
|
||||
return commandsSourceWritePlatformService.logCommandSource(commandRequest);
|
||||
}
|
||||
|
||||
@POST
|
||||
@Path("{agentId}")
|
||||
@Consumes({ MediaType.APPLICATION_JSON })
|
||||
@Produces({ MediaType.APPLICATION_JSON })
|
||||
@Operation(summary = "Close a DDS Agent", description = "Ends the relationship with an agent. Refused while they still have "
|
||||
+ "accounts assigned, hold collected cash, or are owed commission - the response names which. Distinct from "
|
||||
+ "deactivating the agent, which stops them collecting and is never refused.")
|
||||
public CommandProcessingResult close(@PathParam("agentId") @Parameter(description = "agentId") final Long agentId,
|
||||
@Parameter(hidden = true) final String apiRequestBodyAsJson) {
|
||||
final CommandWrapper commandRequest = new CommandWrapperBuilder() //
|
||||
.closeAgent(agentId) //
|
||||
.withJson(apiRequestBodyAsJson) //
|
||||
.build();
|
||||
return commandsSourceWritePlatformService.logCommandSource(commandRequest);
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user