Skip to content

FINERACT-1183: archive FD and RD products #5967

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
San-43 wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

FINERACT-1183: archive FD and RD products #5967

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions fineract-core/src/main/java/org/apache/fineract/portfolio/savings/DepositsApiConstants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ private DepositsApiConstants() {
public static final String localeParamName = "locale";
public static final String dateFormatParamName = "dateFormat";
public static final String monthDayFormatParamName = "monthDayFormat";
public static final String startDateParamName = "startDate";
public static final String closeDateParamName = "closeDate";

// deposit product and account parameters
public static final String idParamName = "id";
Expand Down Expand Up @@ -217,10 +219,11 @@ private DepositsApiConstants() {
* Deposit Product Parameters
*/
private static final Set<String> DEPOSIT_PRODUCT_REQUEST_DATA_PARAMETERS = new HashSet<>(Arrays.asList(localeParamName,
monthDayFormatParamName, nameParamName, shortNameParamName, descriptionParamName, currencyCodeParamName,
digitsAfterDecimalParamName, inMultiplesOfParamName, nominalAnnualInterestRateParamName, interestCompoundingPeriodTypeParamName,
interestPostingPeriodTypeParamName, interestCalculationTypeParamName, interestCalculationDaysInYearTypeParamName,
lockinPeriodFrequencyParamName, lockinPeriodFrequencyTypeParamName, accountingRuleParamName, chargesParamName,
monthDayFormatParamName, dateFormatParamName, startDateParamName, closeDateParamName, nameParamName, shortNameParamName,
descriptionParamName, currencyCodeParamName, digitsAfterDecimalParamName, inMultiplesOfParamName,
nominalAnnualInterestRateParamName, interestCompoundingPeriodTypeParamName, interestPostingPeriodTypeParamName,
interestCalculationTypeParamName, interestCalculationDaysInYearTypeParamName, lockinPeriodFrequencyParamName,
lockinPeriodFrequencyTypeParamName, accountingRuleParamName, chargesParamName,
SavingProductAccountingParams.INCOME_FROM_FEES.getValue(), SavingProductAccountingParams.INCOME_FROM_PENALTIES.getValue(),
SavingProductAccountingParams.INTEREST_ON_SAVINGS.getValue(),
SavingProductAccountingParams.PAYMENT_CHANNEL_FUND_SOURCE_MAPPING.getValue(),
Expand Down Expand Up @@ -277,6 +280,7 @@ private static Set<String> fixedDepositProductResponseData() {
fixedDepositRequestData.addAll(DEPOSIT_PRODUCT_REQUEST_DATA_PARAMETERS);
fixedDepositRequestData.addAll(PRECLOSURE_RESPONSE_DATA_PARAMETERS);
fixedDepositRequestData.addAll(DEPOSIT_TERM_RESPONSE_DATA_PARAMETERS);
fixedDepositRequestData.add(statusParamName);
return fixedDepositRequestData;
}

Expand All @@ -296,6 +300,7 @@ private static Set<String> recurringDepositProductResponseData() {
recurringDepositRequestData.addAll(PRECLOSURE_RESPONSE_DATA_PARAMETERS);
recurringDepositRequestData.addAll(DEPOSIT_TERM_RESPONSE_DATA_PARAMETERS);
recurringDepositRequestData.addAll(RECURRING_DETAILS_RESPONSE_DATA_PARAMETERS);
recurringDepositRequestData.add(statusParamName);
recurringDepositRequestData.add(SavingsApiConstants.minBalanceForInterestCalculationParamName);
return recurringDepositRequestData;
}
Expand Down
2 changes: 1 addition & 1 deletion .../main/java/org/apache/fineract/portfolio/savings/api/FixedDepositAccountsApiResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ public String retrieveAll(@Context final UriInfo uriInfo, @QueryParam("paged") @
@POST
@Consumes({ MediaType.APPLICATION_JSON })
@Produces({ MediaType.APPLICATION_JSON })
@Operation(summary = "Submit new fixed deposit application", description = """
@Operation(summary = "Submit new fixed deposit application", operationId = "submitApplicationFixedDepositAccount", description = """
Submits a new fixed deposit application
Mandatory Fields: clientId or groupId, productId, submittedOnDate, depositAmount, depositPeriod, depositPeriodFrequencyId

Expand Down
2 changes: 1 addition & 1 deletion .../main/java/org/apache/fineract/portfolio/savings/api/FixedDepositProductsApiResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ public class FixedDepositProductsApiResource {

Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minDepositTerm, minDepositTermTypeId, accountingRule

Optional Fields: lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, charts, , withHoldTax, taxGroupId
Optional Fields: startDate, closeDate, lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, charts, , withHoldTax, taxGroupId


Mandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId""")
Expand Down
30 changes: 30 additions & 0 deletions ...ava/org/apache/fineract/portfolio/savings/api/FixedDepositProductsApiResourceSwagger.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ private PostFixedDepositProductsChartSlabs() {}
public String shortName;
@Schema(example = "Daily compounding using Daily Balance, 5% per year, 365 days in year")
public String description;
@Schema(example = "10 July 2022")
public String startDate;
@Schema(example = "10 July 2022")
public String closeDate;
@Schema(example = "USD")
public String currencyCode;
@Schema(example = "2")
Expand All @@ -77,6 +81,8 @@ private PostFixedDepositProductsChartSlabs() {}
public Integer inMultiplesOf;
@Schema(example = "en")
public String locale;
@Schema(example = "dd MMMM yyyy")
public String dateFormat;
@Schema(example = "1")
public Integer interestCompoundingPeriodType;
@Schema(example = "4")
Expand All @@ -101,6 +107,8 @@ private PostFixedDepositProductsChartSlabs() {}
public Integer maxDepositTerm;
@Schema(example = "3")
public Integer maxDepositTermTypeId;
@Schema(example = "10000")
public Long depositAmount;

@adamsaghy adamsaghy Jun 22, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be BigDecimal

public Set<PostFixedDepositProductsCharts> charts;
}

Expand All @@ -120,8 +128,14 @@ private PutFixedDepositProductsProductIdRequest() {}

@Schema(example = "Fixed deposit product new offerings")
public String description;
@Schema(example = "10 July 2022")
public String startDate;
@Schema(example = "10 July 2022")
public String closeDate;
@Schema(example = "en")
public String locale;
@Schema(example = "dd MMMM yyyy")
public String dateFormat;
@Schema(example = "5")
public Integer minDepositTerm;
@Schema(example = "1")
Expand All @@ -139,6 +153,10 @@ private PutFixedDepositProductsChanges() {}

@Schema(example = "Fixed deposit product new offerings")
public String description;
@Schema(example = "10 July 2022")
public String startDate;
@Schema(example = "10 July 2022")
public String closeDate;
@Schema(example = "5")
public Integer minDepositTerm;
}
Expand Down Expand Up @@ -265,6 +283,12 @@ private GetFixedDepositProductsAccountingRule() {}
public String shortName;
@Schema(example = "FD01")
public String description;
@Schema(example = "[2013, 9, 2]")
public LocalDate startDate;
@Schema(example = "[2014, 2, 7]")
public LocalDate closeDate;
@Schema(example = "loanProduct.active")
public String status;
public GetFixedDepositProductsCurrency currency;
@Schema(example = "false")
public Boolean preClosurePenalApplicable;
Expand Down Expand Up @@ -491,6 +515,12 @@ private GetFixedDepositProductsProductIdPeriodType() {}
public String shortName;
@Schema(example = "Daily compounding using Daily Balance, 5% per year, 365 days in year")
public String description;
@Schema(example = "[2013, 9, 2]")
public LocalDate startDate;
@Schema(example = "[2014, 2, 7]")
public LocalDate closeDate;
@Schema(example = "loanProduct.active")
public String status;
public GetFixedDepositProductsProductIdCurrency currency;
public GetFixedDepositProductsProductIdInterestCompoundingPeriodType interestCompoundingPeriodType;
public GetFixedDepositProductsResponse.GetFixedDepositProductsInterestPostingPeriodType interestPostingPeriodType;
Expand Down
2 changes: 1 addition & 1 deletion ...n/java/org/apache/fineract/portfolio/savings/api/RecurringDepositProductsApiResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ public class RecurringDepositProductsApiResource {
@Operation(summary = "Create a Recurring Deposit Product", operationId = "createRecurringDepositProduct", description = "Creates a Recurring Deposit Product\n\n"
+ "Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, interestCompoundingPeriodType, interestPostingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minDepositTerm, minDepositTermTypeId, accountingRule, depositAmount, charts\n\n"
+ "Mandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId\n\n"
+ "Optional Fields: lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, minDepositAmount, maxDepositAmount, withHoldTax, taxGroupId")
+ "Optional Fields: startDate, closeDate, lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, minDepositAmount, maxDepositAmount, withHoldTax, taxGroupId")
@RequestBody(required = true, content = @Content(schema = @Schema(implementation = RecurringDepositProductsApiResourceSwagger.PostRecurringDepositProductsRequest.class)))
@ApiResponses({
@ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = RecurringDepositProductsApiResourceSwagger.PostRecurringDepositProductsResponse.class))) })
Expand Down
28 changes: 28 additions & 0 deletions ...org/apache/fineract/portfolio/savings/api/RecurringDepositProductsApiResourceSwagger.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ private PostRecurringDepositProductsChartSlabs() {}
public String shortName;
@Schema(example = "Daily compounding using Daily Balance, 5% per year, 365 days in year")
public String description;
@Schema(example = "10 July 2022")
public String startDate;
@Schema(example = "10 July 2022")
public String closeDate;
@Schema(example = "USD")
public String currencyCode;
@Schema(example = "2")
Expand All @@ -77,6 +81,8 @@ private PostRecurringDepositProductsChartSlabs() {}
public Integer inMultiplesOf;
@Schema(example = "en")
public String locale;
@Schema(example = "dd MMMM yyyy")
public String dateFormat;
@Schema(example = "1")
public Integer interestCompoundingPeriodType;
@Schema(example = "4")
Expand Down Expand Up @@ -126,8 +132,14 @@ private PutRecurringDepositProductsRequest() {}

@Schema(example = "Recurring deposit product new offerings")
public String description;
@Schema(example = "10 July 2022")
public String startDate;
@Schema(example = "10 July 2022")
public String closeDate;
@Schema(example = "en")
public String locale;
@Schema(example = "dd MMMM yyyy")
public String dateFormat;
@Schema(example = "5")
public Integer minDepositTerm;
@Schema(example = "1")
Expand All @@ -145,6 +157,10 @@ private PutRecurringDepositProductsChanges() {}

@Schema(example = "Recurring deposit product new offerings")
public String description;
@Schema(example = "10 July 2022")
public String startDate;
@Schema(example = "10 July 2022")
public String closeDate;
@Schema(example = "5")
public Integer minDepositTerm;
}
Expand Down Expand Up @@ -283,6 +299,12 @@ private GetRecurringDepositProductsRecurringDepositFrequencyType() {}
public String shortName;
@Schema(example = "RD01")
public String description;
@Schema(example = "[2013, 9, 2]")
public LocalDate startDate;
@Schema(example = "[2014, 2, 7]")
public LocalDate closeDate;
@Schema(example = "loanProduct.active")
public String status;
public GetRecurringDepositProductsCurrency currency;
@Schema(example = "1")
public Integer recurringDepositFrequency;
Expand Down Expand Up @@ -511,6 +533,12 @@ private GetRecurringDepositProductsProductIdPeriodType() {}
public String shortName;
@Schema(example = "Daily compounding using Daily Balance, 5% per year, 365 days in year")
public String description;
@Schema(example = "[2013, 9, 2]")
public LocalDate startDate;
@Schema(example = "[2014, 2, 7]")
public LocalDate closeDate;
@Schema(example = "loanProduct.active")
public String status;
public GetRecurringDepositProductsProductIdCurrency currency;
public GetRecurringDepositProductsProductIdInterestCompoundingPeriodType interestCompoundingPeriodType;
public GetRecurringDepositProductsResponse.GetRecurringDepositProductsInterestPostingPeriodType interestPostingPeriodType;
Expand Down
8 changes: 6 additions & 2 deletions ...src/main/java/org/apache/fineract/portfolio/savings/data/DepositProductDataValidator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,9 @@ public void validateForFixedDepositUpdate(final String json) {

validateDepositTermDetailForUpdate(element, baseDataValidator);

validateChartsData(element, baseDataValidator);
if (fromApiJsonHelper.parameterExists(chartsParamName, element)) {

@adamsaghy adamsaghy Jun 22, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This condition can be moved into validateChartsData, so the validator will be unified (none of the other validate methods are wrapped in an if condition).

validateChartsData(element, baseDataValidator);
}

validateDepositAmountForUpdate(element, baseDataValidator);

Expand Down Expand Up @@ -202,7 +204,9 @@ public void validateForRecurringDepositUpdate(final String json) {

validateRecurringDepositUpdate(element, baseDataValidator);

validateChartsData(element, baseDataValidator);
if (fromApiJsonHelper.parameterExists(chartsParamName, element)) {
validateChartsData(element, baseDataValidator);
}

validateDepositAmountForUpdate(element, baseDataValidator);

Expand Down
19 changes: 19 additions & 0 deletions ...r/src/main/java/org/apache/fineract/portfolio/savings/domain/DepositAccountAssembler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@
import org.apache.fineract.infrastructure.core.exception.InvalidJsonException;
import org.apache.fineract.infrastructure.core.exception.UnsupportedParameterException;
import org.apache.fineract.infrastructure.core.serialization.FromJsonHelper;
import org.apache.fineract.infrastructure.core.service.DateUtils;
import org.apache.fineract.infrastructure.core.service.ExternalIdFactory;
import org.apache.fineract.infrastructure.security.service.PlatformSecurityContext;
import org.apache.fineract.organisation.staff.domain.Staff;
Expand All @@ -96,6 +97,7 @@
import org.apache.fineract.portfolio.savings.SavingsPeriodFrequencyType;
import org.apache.fineract.portfolio.savings.SavingsPostingInterestPeriodType;
import org.apache.fineract.portfolio.savings.data.SavingsAccountTransactionDTO;
import org.apache.fineract.portfolio.savings.exception.DepositAccountApplicationDateException;
import org.apache.fineract.portfolio.savings.exception.FixedDepositProductNotFoundException;
import org.apache.fineract.portfolio.savings.exception.RecurringDepositProductNotFoundException;
import org.apache.fineract.portfolio.savings.exception.SavingsProductNotFoundException;
Expand Down Expand Up @@ -223,6 +225,7 @@ public SavingsAccount assembleFrom(final JsonCommand command, final AppUser subm
}

final LocalDate submittedOnDate = this.fromApiJsonHelper.extractLocalDateNamed(submittedOnDateParamName, element);
validateProductApplicationDate(submittedOnDate, product);

BigDecimal interestRate = null;
if (command.parameterExists(nominalAnnualInterestRateParamName)) {
Expand Down Expand Up @@ -367,6 +370,22 @@ public SavingsAccount assembleFrom(final JsonCommand command, final AppUser subm
return account;
}

public void validateProductApplicationDate(final LocalDate submittedOnDate, final SavingsProduct savingsProduct) {
final FixedDepositProduct product = (FixedDepositProduct) savingsProduct;
final LocalDate startDate = product.getStartDate();
final LocalDate closeDate = product.getCloseDate();

if (startDate != null && DateUtils.isBefore(submittedOnDate, startDate)) {
throw new DepositAccountApplicationDateException("submitted.on.date.cannot.be.before.the.deposit.product.start.date",
"submittedOnDate cannot be before the deposit product startDate.", submittedOnDate.toString(), startDate.toString());
}

if (closeDate != null && DateUtils.isAfter(submittedOnDate, closeDate)) {
throw new DepositAccountApplicationDateException("submitted.on.date.cannot.be.after.the.deposit.product.close.date",
"submittedOnDate cannot be after the deposit product closeDate.", submittedOnDate.toString(), closeDate.toString());
}
}

public SavingsAccount assembleFrom(final Long savingsId, DepositAccountType depositAccountType) {
final SavingsAccount account = this.savingsAccountRepository.findOneWithNotFoundDetection(savingsId, depositAccountType);
account.setHelpers(this.savingsAccountTransactionSummaryWrapper, this.savingsHelper, this.configurationDomainService);
Expand Down
3 changes: 3 additions & 0 deletions ...ain/java/org/apache/fineract/portfolio/savings/domain/DepositAccountDomainServiceJpa.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,7 @@ public Long handleFDAccountClosure(final FixedDepositAccount account, final Paym
if (onClosureType == DepositAccountOnClosureType.REINVEST_PRINCIPAL_AND_INTEREST
|| onClosureType == DepositAccountOnClosureType.REINVEST_PRINCIPAL_ONLY) {
ExternalId externalId = this.externalIdFactory.create();
this.depositAccountAssembler.validateProductApplicationDate(closedDate, account.savingsProduct());
FixedDepositAccount reinvestedDeposit = account.reInvest(account.getAccountBalance(), externalId);
this.depositAccountAssembler.assignSavingAccountHelpers(reinvestedDeposit);
reinvestedDeposit.updateMaturityDateAndAmountBeforeAccountActivation(mc, isPreMatureClosure,
Expand Down Expand Up @@ -271,6 +272,7 @@ public Long handleFDAccountMaturityClosure(final FixedDepositAccount account, fi
}
ExternalId externalId = this.externalIdFactory.create();

this.depositAccountAssembler.validateProductApplicationDate(closedDate, account.savingsProduct());

@adamsaghy adamsaghy Jun 22, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe validations should occur as early as possible. Could we move this validator to be executed as one of the initial steps and only begin processing after it has successfully passed?

FixedDepositAccount reinvestedDeposit = account.reInvest(reInvestAmount, externalId);
this.depositAccountAssembler.assignSavingAccountHelpers(reinvestedDeposit);
reinvestedDeposit.updateMaturityDateAndAmountBeforeAccountActivation(mc, isPreMatureClosure,
Expand Down Expand Up @@ -352,6 +354,7 @@ public Long handleRDAccountClosure(final RecurringDepositAccount account, final
} else {
reInvestAmount = account.getAccountBalance();
}
this.depositAccountAssembler.validateProductApplicationDate(closedDate, account.savingsProduct());
RecurringDepositAccount reinvestedDeposit = account.reInvest(reInvestAmount);
depositAccountAssembler.assignSavingAccountHelpers(reinvestedDeposit);
this.savingsAccountRepository.save(reinvestedDeposit);
Expand Down
Loading
Loading