FINERACT-2455: Update loan details and balances

Author: adamsaghy

fineract-doc/src/docs/en/chapters/features/working-capital-amortization-schedule.adoc

@@ -233,7 +233,7 @@ The amortization schedule model is calculated from these loan-level parameters:
 
 | `originationFeeAmount` | Money | Upfront discount/fee. Amortized over lifecycle.
 | `netDisbursementAmount` | Money | Principal disbursed. Must be positive.
-| `totalPaymentValue` | Money | Merchant's TPV.
+| `totalPaymentVolume` | Money | Merchant's TPV.
 | `periodPaymentRate` | BigDecimal | Rate applied to TPV (e.g., 0.18 = 18%).
 | `npvDayCount` | Integer | Day-count convention (e.g., 360). Must be positive.
 | `expectedDisbursementDate` | Date | Loan start date.
@@ -539,7 +539,7 @@ Creates a new Working Capital loan product with EIR amortization configuration.
 
 === POST /v1/working-capital-loans
 
-Creates a new Working Capital loan application. Required fields include: `productId`, `clientId`, `principal`, `totalPayment`, `periodPaymentRate`, `submittedOnDate`, `expectedDisbursementDate`.
+Creates a new Working Capital loan application. Required fields include: `productId`, `clientId`, `principal`, `totalPaymentVolume`, `periodPaymentRate`, `submittedOnDate`, `expectedDisbursementDate`.
 
 === POST /v1/working-capital-loans/{loanId}?command=approve
 
@@ -573,7 +573,7 @@ Example Response (first 3 payments shown):
 {
   "originationFeeAmount": 1000.00,
   "netDisbursementAmount": 9000.00,
-  "totalPaymentValue": 100000.00,
+  "totalPaymentVolume": 100000.00,
   "periodPaymentRate": 0.18,
   "npvDayCount": 360,
   "expectedDisbursementDate": "2019-01-01",

fineract-doc/src/docs/en/chapters/features/working-capital-eir-calculation.adoc

@@ -182,7 +182,7 @@ GET /v1/working-capital-loans/{loanId}/amortization-schedule
 {
   "discountFeeAmount": 5000.00,
   "netDisbursementAmount": 95000.00,
-  "totalPaymentValue": 105000.00,
+  "totalPaymentVolume": 105000.00,
   "periodPaymentRate": 0.0027778,
   "npvDayCount": 360,
   "expectedDisbursementDate": "2024-01-15",
@@ -276,7 +276,7 @@ GET /v1/working-capital-loans/external-id/{loanExternalId}/rate-changes
 
 === EIR Computation
 
-* `expectedPayment = (totalPaymentValue × periodPaymentRate) / npvDayCount`
+* `expectedPayment = (totalPaymentVolume × periodPaymentRate) / npvDayCount`
 * `originalPaymentNumber = ceil((netDisbursementAmount + discountFeeAmount) / expectedPayment)`
 * `EIR = TvmFunctions.rate(originalPaymentNumber, −expectedPayment, netDisbursementAmount)`
 * The Newton-Raphson solver converges to a tolerance of `1E-12` with a maximum of 500 iterations.
@@ -324,7 +324,7 @@ The `ProjectedAmortizationScheduleModel` progresses through four operations:
 
 **Setup:**
 * Loan amount: 100,000; discount fee: 5,000 (deducted upfront)
-* `periodPaymentRate = 0.0027778`, `npvDayCount = 360`, `totalPaymentValue = 105,000`
+* `periodPaymentRate = 0.0027778`, `npvDayCount = 360`, `totalPaymentVolume = 105,000`
 
 **Action:**
 The system computes `expectedPayment = (105,000 × 0.0027778) / 360 ≈ 291.67` and `originalPaymentNumber = ceil(100,000 / 291.67) = 344`. EIR is solved via Newton-Raphson: `EIR = RATE(344, −291.67, 95,000)`. The schedule is stored in `m_wc_loan_amortization_model` with one row per day (344 payment rows plus the disbursement row).
@@ -356,7 +356,7 @@ The system computes `expectedPayment = (105,000 × 0.0027778) / 360 ≈ 291.67`
 
 Working Capital Loan EIR calculation provides time-value-of-money-based income recognition for revolving credit. Key aspects include:
 
-* EIR is derived analytically using Newton-Raphson from `totalPaymentValue`, `periodPaymentRate`, `npvDayCount`, and `discountFeeAmount`.
+* EIR is derived analytically using Newton-Raphson from `totalPaymentVolume`, `periodPaymentRate`, `npvDayCount`, and `discountFeeAmount`.
 * The full amortization schedule is serialized to JSON in `m_wc_loan_amortization_model` for efficient retrieval without recomputation.
 * Each scheduled payment carries a `discountFactor` and `npvValue`, enabling present-value-based income recognition through the `deferredBalance` amortization mechanism.
 * Mid-lifecycle rate changes are handled via `RateSegment` splits, preserving historical actuals while recalculating only future payments with the new EIR.

fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/factory/WorkingCapitalLoanRequestFactory.java

@@ -58,7 +58,7 @@ public PostWorkingCapitalLoansRequest defaultWorkingCapitalLoansRequest(Long cli
                 .submittedOnDate(DATE_SUBMIT_STRING)//
                 .expectedDisbursementDate(DATE_SUBMIT_STRING)//
                 .principalAmount(DEFAULT_PRINCIPAL)//
-                .totalPayment(DEFAULT_TOTAL_PAYMENT)//
+                .totalPaymentVolume(DEFAULT_TOTAL_PAYMENT)//
                 .periodPaymentRate(DEFAULT_PERIOD_PAYMENT_RATE)//
                 .discount(DEFAULT_DISCOUNT_ZERO)//
                 .locale(DEFAULT_LOCALE)//

fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/helper/WorkingCapitalLoanTestHelper.java

@@ -81,7 +81,7 @@ public Long insertLoan(final LoanStatus status, final LocalDate lastClosedBusine
                 .addValue("principal", DEFAULT_PRINCIPAL)//
                 .addValue("principal_amount_proposed", DEFAULT_PRINCIPAL)//
                 .addValue("approved_principal", DEFAULT_PRINCIPAL)//
-                .addValue("total_payment", DEFAULT_PRINCIPAL);
+                .addValue("total_payment_volume", DEFAULT_PRINCIPAL);
         final Number key = wcLoanInsert.executeAndReturnKey(params);
         return Objects.requireNonNull(key, "Generated key must not be null").longValue();
     }

fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/messaging/event/EventCheckHelper.java

@@ -45,7 +45,7 @@
 import org.apache.fineract.client.models.GetLoansLoanIdResponse;
 import org.apache.fineract.client.models.GetLoansLoanIdTransactions;
 import org.apache.fineract.client.models.GetWorkingCapitalLoanTransactionIdResponse;
-import org.apache.fineract.client.models.GetWorkingCapitalLoansLoanIdResponse;
+import org.apache.fineract.client.models.GetWorkingCapitalLoanTransactionsResponse;
 import org.apache.fineract.client.models.GlobalConfigurationPropertyData;
 import org.apache.fineract.client.models.PageExternalTransferData;
 import org.apache.fineract.client.models.PostClientsResponse;
@@ -307,13 +307,13 @@ public void workingCapitalLoanDisbursalTransactionEventCheck(final Long loanId)
 
     public void workingCapitalLoanDisbursalTransactionEventCheck(final Long loanId, final BigDecimal expectedAmount) {
         waitForTransactionCommit();
-        final GetWorkingCapitalLoansLoanIdResponse body = ok(
-                () -> fineractClient.workingCapitalLoans().retrieveWorkingCapitalLoanById(loanId));
-        if (body.getTransactions() == null || body.getTransactions().isEmpty()) {
+        final GetWorkingCapitalLoanTransactionsResponse body = ok(
+                () -> fineractClient.workingCapitalLoanTransactions().retrieveWorkingCapitalLoanTransactionsById(loanId));
+        if (body.getContent() == null || body.getContent().isEmpty()) {
             throw new IllegalStateException("No Working Capital Loan transactions found");
         }
 
-        final GetWorkingCapitalLoanTransactionIdResponse disbursementTransaction = body.getTransactions().stream()
+        final GetWorkingCapitalLoanTransactionIdResponse disbursementTransaction = body.getContent().stream()
                 .filter(t -> t.getType() != null && "loanTransactionType.disbursement".equals(t.getType().getCode())
                         && !Boolean.TRUE.equals(t.getReversed()))
                 .reduce((first, second) -> second).orElseThrow(() -> new IllegalStateException("Disbursement transaction not found"));
@@ -327,13 +327,13 @@ public void workingCapitalLoanDisbursalTransactionEventCheck(final Long loanId,
 
     public void workingCapitalLoanCreditBalanceRefundTransactionEventCheck(final Long loanId, final BigDecimal expectedAmount) {
         waitForTransactionCommit();
-        final GetWorkingCapitalLoansLoanIdResponse body = ok(
-                () -> fineractClient.workingCapitalLoans().retrieveWorkingCapitalLoanById(loanId));
-        if (body.getTransactions() == null || body.getTransactions().isEmpty()) {
+        final GetWorkingCapitalLoanTransactionsResponse body = ok(
+                () -> fineractClient.workingCapitalLoanTransactions().retrieveWorkingCapitalLoanTransactionsById(loanId));
+        if (body.getContent() == null || body.getContent().isEmpty()) {
             throw new IllegalStateException("No Working Capital Loan transactions found");
         }
 
-        final GetWorkingCapitalLoanTransactionIdResponse cbrTransaction = body.getTransactions().stream()
+        final GetWorkingCapitalLoanTransactionIdResponse cbrTransaction = body.getContent().stream()
                 .filter(t -> t.getType() != null && "loanTransactionType.creditBalanceRefund".equals(t.getType().getCode())
                         && !Boolean.TRUE.equals(t.getReversed()))
                 .reduce((first, second) -> second)
@@ -352,13 +352,13 @@ public void workingCapitalLoanUndoDisbursalTransactionEventCheck(final Long loan
 
     public void workingCapitalLoanUndoDisbursalTransactionEventCheck(final Long loanId, final BigDecimal expectedAmount) {
         waitForTransactionCommit();
-        final GetWorkingCapitalLoansLoanIdResponse body = ok(
-                () -> fineractClient.workingCapitalLoans().retrieveWorkingCapitalLoanById(loanId));
-        if (body.getTransactions() == null || body.getTransactions().isEmpty()) {
+        final GetWorkingCapitalLoanTransactionsResponse body = ok(
+                () -> fineractClient.workingCapitalLoanTransactions().retrieveWorkingCapitalLoanTransactionsById(loanId));
+        if (body.getContent() == null || body.getContent().isEmpty()) {
             throw new IllegalStateException("No Working Capital Loan transactions found");
         }
 
-        final GetWorkingCapitalLoanTransactionIdResponse reversedDisbursementTransaction = body.getTransactions().stream()
+        final GetWorkingCapitalLoanTransactionIdResponse reversedDisbursementTransaction = body.getContent().stream()
                 .filter(t -> t.getType() != null && "loanTransactionType.disbursement".equals(t.getType().getCode())
                         && Boolean.TRUE.equals(t.getReversed()))
                 .reduce((first, second) -> second)

fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/stepdef/loan/WorkingCapitalAmortizationScheduleStepDef.java

@@ -49,16 +49,16 @@ public class WorkingCapitalAmortizationScheduleStepDef extends AbstractStepDef {
 
     private final FineractFeignClient fineractFeignClient;
 
-    @When("Admin generates a projected amortization schedule with discountFeeAmount {double}, netDisbursementAmount {double}, totalPaymentValue {double}, periodPaymentRate {double}, npvDayCount {int}, expectedDisbursementDate {string}")
+    @When("Admin generates a projected amortization schedule with discountFeeAmount {double}, netDisbursementAmount {double}, totalPaymentVolume {double}, periodPaymentRate {double}, npvDayCount {int}, expectedDisbursementDate {string}")
     public void generateAmortizationSchedule(final double discountFeeAmount, final double netDisbursementAmount,
-            final double totalPaymentValue, final double periodPaymentRate, final int npvDayCount, final String expectedDisbursementDate) {
+            final double totalPaymentVolume, final double periodPaymentRate, final int npvDayCount, final String expectedDisbursementDate) {
         final Long loanId = extractLoanId();
         final WorkingCapitalLoansApi api = fineractFeignClient.create(WorkingCapitalLoansApi.class);
 
         final ProjectedAmortizationScheduleGenerateRequest request = new ProjectedAmortizationScheduleGenerateRequest();
         request.setDiscountFeeAmount(BigDecimal.valueOf(discountFeeAmount));
         request.setNetDisbursementAmount(BigDecimal.valueOf(netDisbursementAmount));
-        request.setTotalPaymentValue(BigDecimal.valueOf(totalPaymentValue));
+        request.setTotalPaymentVolume(BigDecimal.valueOf(totalPaymentVolume));
         request.setPeriodPaymentRate(BigDecimal.valueOf(periodPaymentRate));
         request.setNpvDayCount(npvDayCount);
         request.setExpectedDisbursementDate(LocalDate.parse(expectedDisbursementDate));
@@ -96,7 +96,7 @@ private void verifySummaryFields(final DataTable dataTable) {
 
         assertDecimal(assertions, "discountFeeAmount", response.getDiscountFeeAmount(), expected.get("discountFeeAmount"));
         assertDecimal(assertions, "netDisbursementAmount", response.getNetDisbursementAmount(), expected.get("netDisbursementAmount"));
-        assertDecimal(assertions, "totalPaymentValue", response.getTotalPaymentValue(), expected.get("totalPaymentValue"));
+        assertDecimal(assertions, "totalPaymentVolume", response.getTotalPaymentVolume(), expected.get("totalPaymentVolume"));
         assertDecimal(assertions, "periodPaymentRate", response.getPeriodPaymentRate(), expected.get("periodPaymentRate"));
         assertInt(assertions, "npvDayCount", response.getNpvDayCount(), expected.get("npvDayCount"));
         assertDecimal(assertions, "expectedPaymentAmount", response.getExpectedPaymentAmount(), expected.get("expectedPaymentAmount"));