FINERACT-1183: archive FD and RD products

fineract-core/src/main/java/org/apache/fineract/portfolio/savings/DepositsApiConstants.java

@@ -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";
@@ -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(),
@@ -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;
     }
 
@@ -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;
     }

fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/api/FixedDepositAccountsApiResource.java

@@ -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
 

fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/api/FixedDepositProductsApiResource.java

@@ -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""")

fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/api/FixedDepositProductsApiResourceSwagger.java

@@ -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")
@@ -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")
@@ -120,8 +126,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")
@@ -139,6 +151,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;
         }
@@ -265,6 +281,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;
@@ -491,6 +513,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;

fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/api/RecurringDepositProductsApiResource.java

@@ -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))) })

fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/api/RecurringDepositProductsApiResourceSwagger.java

@@ -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")
@@ -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")
@@ -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")
@@ -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;
         }
@@ -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;
@@ -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;

fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/domain/DepositAccountAssembler.java

@@ -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;
@@ -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;
@@ -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)) {
@@ -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);

fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/domain/DepositAccountDomainServiceJpa.java

@@ -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,
@@ -271,6 +272,7 @@ public Long handleFDAccountMaturityClosure(final FixedDepositAccount account, fi
             }
             ExternalId externalId = this.externalIdFactory.create();
 
+            this.depositAccountAssembler.validateProductApplicationDate(closedDate, account.savingsProduct());
             FixedDepositAccount reinvestedDeposit = account.reInvest(reInvestAmount, externalId);
             this.depositAccountAssembler.assignSavingAccountHelpers(reinvestedDeposit);
             reinvestedDeposit.updateMaturityDateAndAmountBeforeAccountActivation(mc, isPreMatureClosure,
@@ -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);