FINERACT-2455: WC - Transaction Type - Repayment

Author: mariiaKraievska

fineract-core/src/main/java/org/apache/fineract/commands/service/CommandWrapperBuilder.java

@@ -872,6 +872,14 @@ public CommandWrapperBuilder updateDiscountWorkingCapitalLoanApplication(final L
         return this;
     }
 
+    public CommandWrapperBuilder repaymentWorkingCapitalLoanTransaction(final Long loanId) {
+        this.actionName = ACTION_REPAYMENT;
+        this.entityName = ENTITY_WORKINGCAPITALLOAN;
+        this.entityId = loanId;
+        this.href = "/working-capital-loans/" + loanId + "/transactions?command=repayment";
+        return this;
+    }
+
     public CommandWrapperBuilder createClientIdentifier(final Long clientId) {
         this.actionName = ACTION_CREATE;
         this.entityName = ENTITY_CLIENTIDENTIFIER;

fineract-provider/src/test/java/org/apache/fineract/infrastructure/event/external/service/ExternalEventConfigurationValidationServiceTest.java

@@ -114,7 +114,8 @@ public void givenAllConfigurationWhenValidatedThenValidationSuccessful() throws
                 "LoanBuyDownFeeAmortizationTransactionCreatedBusinessEvent",
                 "LoanBuyDownFeeAmortizationAdjustmentTransactionCreatedBusinessEvent", "LoanApprovedAmountChangedBusinessEvent",
                 "SavingsAccountsStayedLockedBusinessEvent", "SavingsAccountForceWithdrawalBusinessEvent",
-                "WorkingCapitalLoanDisbursalTransactionBusinessEvent", "WorkingCapitalLoanUndoDisbursalTransactionBusinessEvent");
+                "WorkingCapitalLoanDisbursalTransactionBusinessEvent", "WorkingCapitalLoanUndoDisbursalTransactionBusinessEvent",
+                "WorkingCapitalLoanRepaymentTransactionBusinessEvent");
 
         List<FineractPlatformTenant> tenants = Arrays
                 .asList(new FineractPlatformTenant(1L, "default", "Default Tenant", "Europe/Budapest", null));
@@ -211,7 +212,8 @@ public void givenMissingEventConfigurationWhenValidatedThenThrowException() thro
                 "LoanBuyDownFeeAmortizationTransactionCreatedBusinessEvent",
                 "LoanBuyDownFeeAmortizationAdjustmentTransactionCreatedBusinessEvent", "LoanApprovedAmountChangedBusinessEvent",
                 "SavingsAccountsStayedLockedBusinessEvent", "SavingsAccountForceWithdrawalBusinessEvent",
-                "WorkingCapitalLoanDisbursalTransactionBusinessEvent", "WorkingCapitalLoanUndoDisbursalTransactionBusinessEvent");
+                "WorkingCapitalLoanDisbursalTransactionBusinessEvent", "WorkingCapitalLoanUndoDisbursalTransactionBusinessEvent",
+                "WorkingCapitalLoanRepaymentTransactionBusinessEvent");
 
         List<FineractPlatformTenant> tenants = Arrays
                 .asList(new FineractPlatformTenant(1L, "default", "Default Tenant", "Europe/Budapest", null));

fineract-working-capital-loan/src/main/java/org/apache/fineract/infrastructure/event/business/domain/workingcapitalloan/transaction/WorkingCapitalLoanRepaymentTransactionBusinessEvent.java

@@ -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.infrastructure.event.business.domain.workingcapitalloan.transaction;
+
+import org.apache.fineract.portfolio.workingcapitalloan.domain.WorkingCapitalLoanTransaction;
+
+public class WorkingCapitalLoanRepaymentTransactionBusinessEvent extends WorkingCapitalLoanTransactionBusinessEvent {
+
+    private static final String TYPE = "WorkingCapitalLoanRepaymentTransactionBusinessEvent";
+
+    public WorkingCapitalLoanRepaymentTransactionBusinessEvent(final WorkingCapitalLoanTransaction value) {
+        super(value);
+    }
+
+    public WorkingCapitalLoanRepaymentTransactionBusinessEvent(final WorkingCapitalLoanTransaction value, final Long aggregateRootId) {
+        super(value, aggregateRootId);
+    }
+
+    @Override
+    public String getType() {
+        return TYPE;
+    }
+}

fineract-working-capital-loan/src/main/java/org/apache/fineract/portfolio/workingcapitalloan/WorkingCapitalLoanConstants.java

@@ -46,6 +46,7 @@ private WorkingCapitalLoanConstants() {
     // Loan commands
     public static final String APPROVE_LOAN_COMMAND = "approve";
     public static final String DISBURSE_LOAN_COMMAND = "disburse";
+    public static final String REPAYMENT_LOAN_COMMAND = "repayment";
 
     // Approval / Rejection / Undo-approval parameters
     public static final String RESOURCE_NAME = WCL_RESOURCE_NAME;
@@ -62,11 +63,13 @@ private WorkingCapitalLoanConstants() {
     public static final String classificationIdParamName = "classificationId";
 
     public static final String DISBURSEMENT_CLASSIFICATION_CODE_NAME = "working_capital_loan_disbursement_classification";
+    public static final String REPAYMENT_CLASSIFICATION_CODE_NAME = "working_capital_loan_repayment_classification";
     public static final String paymentDetailsParamName = "paymentDetails";
     public static final String paymentTypeIdParamName = "paymentTypeId";
     public static final String accountNumberParamName = "accountNumber";
     public static final String checkNumberParamName = "checkNumber";
     public static final String routingCodeParamName = "routingCode";
     public static final String receiptNumberParamName = "receiptNumber";
     public static final String bankNumberParamName = "bankNumber";
+    public static final String transactionDateParamName = "transactionDate";
 }

fineract-working-capital-loan/src/main/java/org/apache/fineract/portfolio/workingcapitalloan/api/WorkingCapitalLoanTransactionsApiResource.java

@@ -22,10 +22,13 @@
 import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.media.Content;
 import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.parameters.RequestBody;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.responses.ApiResponses;
 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.Path;
 import jakarta.ws.rs.PathParam;
 import jakarta.ws.rs.Produces;
@@ -34,8 +37,13 @@
 import jakarta.ws.rs.core.MediaType;
 import jakarta.ws.rs.core.UriInfo;
 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.api.jersey.Pagination;
+import org.apache.fineract.infrastructure.core.data.CommandProcessingResult;
 import org.apache.fineract.infrastructure.core.exception.UnrecognizedQueryParamException;
+import org.apache.fineract.infrastructure.core.service.CommandParameterUtil;
 import org.apache.fineract.infrastructure.core.service.ExternalIdFactory;
 import org.apache.fineract.infrastructure.security.service.PlatformSecurityContext;
 import org.apache.fineract.portfolio.workingcapitalloan.WorkingCapitalLoanConstants;
@@ -59,6 +67,7 @@ public class WorkingCapitalLoanTransactionsApiResource {
     private final PlatformSecurityContext context;
     private final WorkingCapitalLoanApplicationReadPlatformService loanReadPlatformService;
     private final WorkingCapitalLoanTransactionReadPlatformService transactionReadPlatformService;
+    private final PortfolioCommandSourceWritePlatformService commandsSourceWritePlatformService;
 
     @GET
     @Path("{loanId}/transactions")
@@ -168,4 +177,51 @@ private WorkingCapitalLoanCommandTemplateData handleLoanTransactionTemplate(fina
 
         return loanTransactionTemplateData;
     }
+
+    @POST
+    @Path("{loanId}/transactions")
+    @Consumes({ MediaType.APPLICATION_JSON })
+    @Produces({ MediaType.APPLICATION_JSON })
+    @Operation(operationId = "executeWorkingCapitalLoanTransactionById", summary = "Execute Working Capital Loan transaction", description = "Supported command query parameter: repayment")
+    @RequestBody(required = true, content = @Content(schema = @Schema(implementation = WorkingCapitalLoanTransactionsApiResourceSwagger.PostWorkingCapitalLoanTransactionsRequest.class)))
+    @ApiResponses({
+            @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = WorkingCapitalLoanTransactionsApiResourceSwagger.PostWorkingCapitalLoanTransactionsResponse.class))) })
+    public CommandProcessingResult executeLoanTransactionById(
+            @PathParam("loanId") @Parameter(description = "loanId", required = true) final Long loanId,
+            @QueryParam("command") @Parameter(description = "command", required = true) final String commandParam,
+            @Parameter(hidden = true) final String apiRequestBodyAsJson) {
+        return executeTransaction(loanId, null, commandParam, apiRequestBodyAsJson);
+    }
+
+    @POST
+    @Path("external-id/{loanExternalId}/transactions")
+    @Consumes({ MediaType.APPLICATION_JSON })
+    @Produces({ MediaType.APPLICATION_JSON })
+    @Operation(operationId = "executeWorkingCapitalLoanTransactionByExternalId", summary = "Execute Working Capital Loan transaction by external id", description = "Supported command query parameter: repayment")
+    @RequestBody(required = true, content = @Content(schema = @Schema(implementation = WorkingCapitalLoanTransactionsApiResourceSwagger.PostWorkingCapitalLoanTransactionsRequest.class)))
+    @ApiResponses({
+            @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = WorkingCapitalLoanTransactionsApiResourceSwagger.PostWorkingCapitalLoanTransactionsResponse.class))) })
+    public CommandProcessingResult executeLoanTransactionByExternalId(
+            @PathParam("loanExternalId") @Parameter(description = "loanExternalId", required = true) final String loanExternalId,
+            @QueryParam("command") @Parameter(description = "command", required = true) final String commandParam,
+            @Parameter(hidden = true) final String apiRequestBodyAsJson) {
+        return executeTransaction(null, loanExternalId, commandParam, apiRequestBodyAsJson);
+    }
+
+    private CommandProcessingResult executeTransaction(final Long loanId, final String loanExternalIdStr, final String commandParam,
+            final String apiRequestBodyAsJson) {
+        final Long resolvedLoanId = loanId != null ? loanId
+                : loanReadPlatformService.getResolvedLoanId(ExternalIdFactory.produce(loanExternalIdStr));
+        if (resolvedLoanId == null) {
+            throw new WorkingCapitalLoanNotFoundException(ExternalIdFactory.produce(loanExternalIdStr));
+        }
+        final CommandWrapperBuilder builder = new CommandWrapperBuilder().withJson(apiRequestBodyAsJson);
+        final CommandWrapper commandRequest;
+        if (CommandParameterUtil.is(commandParam, "repayment")) {
+            commandRequest = builder.repaymentWorkingCapitalLoanTransaction(resolvedLoanId).build();
+        } else {
+            throw new UnrecognizedQueryParamException("command", commandParam);
+        }
+        return this.commandsSourceWritePlatformService.logCommandSource(commandRequest);
+    }
 }

fineract-working-capital-loan/src/main/java/org/apache/fineract/portfolio/workingcapitalloan/api/WorkingCapitalLoanTransactionsApiResourceSwagger.java

@@ -125,4 +125,44 @@ private CodeValueData() {}
         @Schema(example = "Some classification")
         public String name;
     }
+
+    @Schema(description = "Request for transaction command: repayment")
+    public static final class PostWorkingCapitalLoanTransactionsRequest {
+
+        private PostWorkingCapitalLoanTransactionsRequest() {}
+
+        @Schema(example = "en_GB")
+        public String locale;
+        @Schema(example = "dd MMMM yyyy")
+        public String dateFormat;
+        @Schema(example = "28 June 2024", description = "Repayment transaction date")
+        public String transactionDate;
+        @Schema(example = "100.0", description = "Repayment amount")
+        public BigDecimal transactionAmount;
+        @Schema(example = "12", description = "Optional code value id for repayment classification")
+        public Long classificationId;
+        @Schema(example = "Repayment note")
+        public String note;
+        @Schema(example = "repayment-ext-001")
+        public String externalId;
+        @Schema(description = "Payment details")
+        public WorkingCapitalLoanTransactionPaymentDetailData paymentDetails;
+    }
+
+    @Schema(description = "Response for repayment transaction command")
+    public static final class PostWorkingCapitalLoanTransactionsResponse {
+
+        private PostWorkingCapitalLoanTransactionsResponse() {}
+
+        @Schema(example = "1")
+        public Long officeId;
+        @Schema(example = "2")
+        public Long clientId;
+        @Schema(example = "3")
+        public Long loanId;
+        @Schema(example = "4")
+        public Long resourceId;
+        @Schema(example = "repayment-ext-001")
+        public String resourceExternalId;
+    }
 }

fineract-working-capital-loan/src/main/java/org/apache/fineract/portfolio/workingcapitalloan/calc/ProjectedAmortizationScheduleModel.java

@@ -162,15 +162,24 @@ public static ProjectedAmortizationScheduleModel generate(final BigDecimal origi
                 expectedDisbursementDate, Money.of(currency, expectedPayment, mc), term, eir, mc, currency);
     }
 
+    public LocalDate normalizePaymentDateForSchedule(final LocalDate paymentDate) {
+        Objects.requireNonNull(paymentDate, "paymentDate");
+        if (paymentDate.equals(expectedDisbursementDate)) {
+            return expectedDisbursementDate.plusDays(1);
+        }
+        return paymentDate;
+    }
+
     public void applyPayment(final LocalDate paymentDate, final BigDecimal amount) {
         Objects.requireNonNull(paymentDate, "paymentDate");
         Objects.requireNonNull(amount, "amount");
-        final int index = resolvePaymentIndex(paymentDate);
+        final LocalDate scheduleDate = normalizePaymentDateForSchedule(paymentDate);
+        final int index = resolvePaymentIndex(scheduleDate);
         if (index < 0 || index >= loanTerm) {
             throw new IllegalArgumentException("paymentDate " + paymentDate + " is outside the valid range ["
                     + expectedDisbursementDate.plusDays(1) + " .. " + expectedDisbursementDate.plusDays(loanTerm) + "]");
         }
-        appliedPayments.add(new AppliedPayment(paymentDate, amount));
+        appliedPayments.add(new AppliedPayment(scheduleDate, amount));
         rebuildPayments();
     }
 
@@ -184,6 +193,37 @@ public ProjectedAmortizationScheduleModel regenerate(final BigDecimal newDiscoun
         return newModel;
     }
 
+    public void recalculateNetAmortizationAndDeferredBalanceFrom(final LocalDate repaymentDate) {
+        if (repaymentDate == null || payments == null || payments.isEmpty()) {
+            return;
+        }
+        final ProjectedPayment lastRepayment = payments.stream().filter(p -> p.paymentNo() > 0).filter(p -> repaymentDate.equals(p.date()))
+                .reduce((a, b) -> b).orElse(null);
+
+        if (lastRepayment == null) {
+            return;
+        }
+
+        int fromIndex = payments.indexOf(lastRepayment);
+
+        BigDecimal runningNetAmortization = amountOrZero(payments.get(fromIndex).netAmortizationAmount());
+        BigDecimal runningDeferredBalance = amountOrZero(payments.get(fromIndex).deferredBalance());
+
+        final List<ProjectedPayment> adjusted = new ArrayList<>(payments.subList(0, fromIndex + 1));
+        for (int i = fromIndex + 1; i < payments.size(); i++) {
+            final ProjectedPayment current = payments.get(i);
+            final BigDecimal actualTotalAmortization = amountOrZero(current.actualAmortizationAmount());
+            runningNetAmortization = runningNetAmortization.subtract(actualTotalAmortization, mc);
+            runningDeferredBalance = runningDeferredBalance.subtract(actualTotalAmortization, mc);
+
+            adjusted.add(new ProjectedPayment(current.paymentNo(), current.date(), current.count(), current.paymentsLeft(),
+                    current.expectedPaymentAmount(), current.forecastPaymentAmount(), current.discountFactor(), current.npvValue(),
+                    current.balance(), current.expectedAmortizationAmount(), money(runningNetAmortization), current.actualPaymentAmount(),
+                    current.actualAmortizationAmount(), current.incomeModification(), money(runningDeferredBalance)));
+        }
+        this.payments = List.copyOf(adjusted);
+    }
+
     private void rebuildPayments() {
         final Map<LocalDate, BigDecimal> paymentsByDate = aggregatePaymentsByDate();
         final List<BigDecimal> paymentList = buildPaymentList(paymentsByDate);
@@ -275,6 +315,10 @@ private List<ProjectedPayment> buildPayments(final List<BigDecimal> payments, fi
         return result;
     }
 
+    private static BigDecimal amountOrZero(final Money value) {
+        return value != null && value.getAmount() != null ? value.getAmount() : BigDecimal.ZERO;
+    }
+
     private ProjectedPayment createDisbursementPayment(final int appliedCount) {
         final Money negDisbursement = netDisbursementAmount.negated(mc);
         final long count = (long) loanTerm + appliedCount;

fineract-working-capital-loan/src/main/java/org/apache/fineract/portfolio/workingcapitalloan/data/RepaymentAmortizationData.java

@@ -0,0 +1,24 @@
+/**
+ * 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.workingcapitalloan.data;
+
+import java.math.BigDecimal;
+
+public record RepaymentAmortizationData(BigDecimal currentDayAmortizedAmount, BigDecimal totalAmortizedAmount) {
+}

fineract-working-capital-loan/src/main/java/org/apache/fineract/portfolio/workingcapitalloan/domain/WorkingCapitalLoanTransaction.java

@@ -118,4 +118,22 @@ public static WorkingCapitalLoanTransaction disbursement(final WorkingCapitalLoa
         txn.reversedOnDate = null;
         return txn;
     }
+
+    public static WorkingCapitalLoanTransaction repayment(final WorkingCapitalLoan loan, final BigDecimal amount,
+            final PaymentDetail paymentDetail, final LocalDate transactionDate, final CodeValue classification,
+            final ExternalId externalId) {
+        final WorkingCapitalLoanTransaction txn = new WorkingCapitalLoanTransaction();
+        txn.wcLoan = loan;
+        txn.transactionType = LoanTransactionType.REPAYMENT;
+        txn.transactionDate = transactionDate;
+        txn.submittedOnDate = transactionDate;
+        txn.transactionAmount = amount;
+        txn.paymentDetail = paymentDetail;
+        txn.classification = classification;
+        txn.externalId = externalId != null ? externalId : ExternalId.empty();
+        txn.reversed = false;
+        txn.reversalExternalId = null;
+        txn.reversedOnDate = null;
+        return txn;
+    }
 }

fineract-working-capital-loan/src/main/java/org/apache/fineract/portfolio/workingcapitalloan/domain/WorkingCapitalLoanTransactionAllocation.java

@@ -59,7 +59,7 @@ public class WorkingCapitalLoanTransactionAllocation extends AbstractAuditableWi
 
     protected WorkingCapitalLoanTransactionAllocation() {}
 
-    public static WorkingCapitalLoanTransactionAllocation forDisbursement(final WorkingCapitalLoanTransaction transaction,
+    public static WorkingCapitalLoanTransactionAllocation forPrincipalAllocation(final WorkingCapitalLoanTransaction transaction,
             final BigDecimal principalAmount) {
         final WorkingCapitalLoanTransactionAllocation allocation = new WorkingCapitalLoanTransactionAllocation();
         allocation.wcLoanTransaction = transaction;