feat(loans): native amortization schedule for fixed-rate loans (#1804)

app/models/loan.rb

@@ -30,6 +30,33 @@ def original_balance
     Money.new(account.first_valuation_amount, account.currency)
   end
 
+  # Returns a French-style amortization schedule as an array of period hashes:
+  # { period:, payment_date:, beginning_balance:, payment:, interest:, principal:, ending_balance: }
+  # Returns [] when the loan does not have enough parameters to project a fixed-rate schedule.
+  def amortization_schedule
+    return @amortization_schedule if defined?(@amortization_schedule)
+
+    @amortization_schedule = build_amortization_schedule
+  end
+
+  def total_interest
+    schedule = amortization_schedule
+    return nil if schedule.empty?
+
+    Money.new(schedule.sum { |row| row[:interest].amount }, account.currency)
+  end
+
+  def total_payments
+    schedule = amortization_schedule
+    return nil if schedule.empty?
+
+    Money.new(schedule.sum { |row| row[:payment].amount }, account.currency)
+  end
+
+  def payoff_date
+    amortization_schedule.last&.dig(:payment_date)
+  end
+
   class << self
     def color
       "#D444F1"
@@ -43,4 +70,62 @@ def classification
       "liability"
     end
   end
+
+  private
+    def build_amortization_schedule
+      return [] unless rate_type == "fixed"
+      return [] if term_months.nil? || term_months <= 0 || interest_rate.nil?
+
+      principal = original_balance.amount.to_f
+      return [] if principal.zero?
+
+      monthly_rate = (interest_rate.to_f / 100.0) / 12.0
+      payment = exact_monthly_payment_dollars(principal, monthly_rate)
+      start_date = schedule_start_date
+      currency = account.currency
+
+      balance = principal
+      rows = []
+
+      (1..term_months).each do |period|
+        interest_amount = (balance * monthly_rate).round(2)
+        principal_amount = (payment - interest_amount).round(2)
+
+        # Absorb rounding drift in the final period so the balance lands exactly on zero.
+        if period == term_months || principal_amount > balance
+          principal_amount = balance.round(2)
+        end
+
+        payment_amount = (interest_amount + principal_amount).round(2)
+        ending_balance = (balance - principal_amount).round(2)
+        ending_balance = 0.0 if ending_balance.negative?
+
+        rows << {
+          period: period,
+          payment_date: start_date >> period,
+          beginning_balance: Money.new(balance.round(2), currency),
+          payment: Money.new(payment_amount, currency),
+          interest: Money.new(interest_amount, currency),
+          principal: Money.new(principal_amount, currency),
+          ending_balance: Money.new(ending_balance, currency)
+        }
+
+        balance = ending_balance
+      end
+
+      rows
+    end
+
+    def exact_monthly_payment_dollars(principal, monthly_rate)
+      if monthly_rate.zero?
+        (principal / term_months).round(2)
+      else
+        factor = (1 + monthly_rate)**term_months
+        ((principal * monthly_rate * factor) / (factor - 1)).round(2)
+      end
+    end
+
+    def schedule_start_date
+      account.first_valuation&.date || account.created_at&.to_date || Date.current
+    end
 end

app/views/loans/tabs/_overview.html.erb

@@ -42,8 +42,60 @@
   <%= summary_card title: t(".type") do %>
     <%= account.loan.rate_type&.titleize || t(".unknown") %>
   <% end %>
+
+  <%= summary_card title: t(".total_interest") do %>
+    <% if account.loan.total_interest.present? %>
+      <%= format_money(account.loan.total_interest) %>
+    <% else %>
+      <%= t(".unknown") %>
+    <% end %>
+  <% end %>
+
+  <%= summary_card title: t(".payoff_date") do %>
+    <% if account.loan.payoff_date.present? %>
+      <%= I18n.l(account.loan.payoff_date, format: :long) %>
+    <% else %>
+      <%= t(".unknown") %>
+    <% end %>
+  <% end %>
 </div>
 
+<% schedule = account.loan.amortization_schedule %>
+<% if schedule.any? %>
+  <details class="mt-6 rounded-lg border border-primary bg-container">
+    <summary class="cursor-pointer select-none px-4 py-3 text-sm font-medium text-primary">
+      <%= t(".amortization_schedule") %>
+    </summary>
+
+    <div class="overflow-x-auto border-t border-primary">
+      <table class="min-w-full text-sm">
+        <thead class="bg-surface">
+          <tr class="text-left text-secondary">
+            <th scope="col" class="px-4 py-2 font-medium"><%= t(".schedule.period") %></th>
+            <th scope="col" class="px-4 py-2 font-medium"><%= t(".schedule.payment_date") %></th>
+            <th scope="col" class="px-4 py-2 font-medium text-right"><%= t(".schedule.payment") %></th>
+            <th scope="col" class="px-4 py-2 font-medium text-right"><%= t(".schedule.principal") %></th>
+            <th scope="col" class="px-4 py-2 font-medium text-right"><%= t(".schedule.interest") %></th>
+            <th scope="col" class="px-4 py-2 font-medium text-right"><%= t(".schedule.ending_balance") %></th>
+          </tr>
+        </thead>
+        <tbody>
+          <% schedule.each do |row| %>
+            <tr class="border-t border-primary text-primary">
+              <td class="px-4 py-2"><%= row[:period] %></td>
+              <td class="px-4 py-2"><%= I18n.l(row[:payment_date], format: :short) %></td>
+              <td class="px-4 py-2 text-right"><%= format_money(row[:payment]) %></td>
+              <td class="px-4 py-2 text-right"><%= format_money(row[:principal]) %></td>
+              <td class="px-4 py-2 text-right"><%= format_money(row[:interest]) %></td>
+              <td class="px-4 py-2 text-right"><%= format_money(row[:ending_balance]) %></td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+    </div>
+  </details>
+<% end %>
+
 <div class="flex justify-center py-8">
   <%= render DS::Link.new(
     text: t(".edit_loan_details"),

config/locales/views/loans/en.yml

@@ -26,12 +26,22 @@ en:
       unknown: Unknown
     tabs:
       overview:
+        amortization_schedule: Amortization schedule
         interest_rate: Interest Rate
         monthly_payment: Monthly Payment
         not_applicable: N/A
         original_principal: Original Principal
+        payoff_date: Payoff Date
         remaining_principal: Remaining Principal
+        schedule:
+          ending_balance: Balance
+          interest: Interest
+          payment: Payment
+          payment_date: Date
+          period: '#'
+          principal: Principal
         term: Term
+        total_interest: Total Interest
         type: Type
         unknown: Unknown
         edit_loan_details: "Edit loan details"

test/models/loan_test.rb

@@ -9,18 +9,92 @@ class LoanTest < ActiveSupport::TestCase
   end
 
   test "calculates correct monthly payment for fixed rate loan" do
-    loan_account = Account.create! \
-      family: families(:dylan_family),
-      name: "Mortgage Loan",
-      balance: 500000,
-      currency: "USD",
-      accountable: Loan.create!(
-        subtype: "mortgage",
-        interest_rate: 3.5,
-        term_months: 360,
-        rate_type: "fixed"
-      )
+    loan_account = build_loan_account(balance: 500000, interest_rate: 3.5, term_months: 360)
 
     assert_equal 2245, loan_account.loan.monthly_payment.amount
   end
+
+  test "amortization schedule returns one row per term month" do
+    loan_account = build_loan_account(balance: 500000, interest_rate: 3.5, term_months: 360)
+
+    schedule = loan_account.loan.amortization_schedule
+
+    assert_equal 360, schedule.length
+    assert_equal 1, schedule.first[:period]
+    assert_equal 360, schedule.last[:period]
+  end
+
+  test "amortization schedule splits each payment into interest and principal" do
+    loan_account = build_loan_account(balance: 240000, interest_rate: 6.0, term_months: 360)
+
+    first = loan_account.loan.amortization_schedule.first
+
+    assert_equal 1200.00, first[:interest].amount.to_f
+    assert_in_delta 238.92, first[:principal].amount.to_f, 0.05
+    assert_equal first[:beginning_balance].amount.to_f - first[:principal].amount.to_f,
+                 first[:ending_balance].amount.to_f
+  end
+
+  test "amortization schedule pays the loan down to zero in the final period" do
+    loan_account = build_loan_account(balance: 240000, interest_rate: 6.0, term_months: 360)
+
+    last = loan_account.loan.amortization_schedule.last
+
+    assert_equal 0, last[:ending_balance].amount.to_f
+  end
+
+  test "amortization schedule handles zero interest" do
+    loan_account = build_loan_account(balance: 12000, interest_rate: 0, term_months: 12)
+
+    schedule = loan_account.loan.amortization_schedule
+
+    assert_equal 12, schedule.length
+    assert_equal 0, schedule.first[:interest].amount.to_f
+    assert_equal 1000, schedule.first[:principal].amount.to_f
+    assert_equal 0, schedule.last[:ending_balance].amount.to_f
+  end
+
+  test "amortization schedule is empty for non-fixed loans" do
+    loan_account = build_loan_account(balance: 100000, interest_rate: 4.0, term_months: 120, rate_type: "variable")
+
+    assert_empty loan_account.loan.amortization_schedule
+    assert_nil loan_account.loan.total_interest
+    assert_nil loan_account.loan.payoff_date
+  end
+
+  test "amortization schedule is empty when required attributes are missing" do
+    loan_account = build_loan_account(balance: 100000, interest_rate: nil, term_months: 120)
+
+    assert_empty loan_account.loan.amortization_schedule
+  end
+
+  test "total interest sums interest across the schedule" do
+    loan_account = build_loan_account(balance: 240000, interest_rate: 6.0, term_months: 360)
+
+    schedule = loan_account.loan.amortization_schedule
+    expected = schedule.sum { |row| row[:interest].amount }
+
+    assert_equal expected, loan_account.loan.total_interest.amount
+  end
+
+  test "payoff date equals the date of the final schedule row" do
+    loan_account = build_loan_account(balance: 240000, interest_rate: 6.0, term_months: 360)
+
+    assert_equal loan_account.loan.amortization_schedule.last[:payment_date], loan_account.loan.payoff_date
+  end
+
+  private
+    def build_loan_account(balance:, interest_rate:, term_months:, rate_type: "fixed")
+      Account.create! \
+        family: families(:dylan_family),
+        name: "Loan",
+        balance: balance,
+        currency: "USD",
+        accountable: Loan.create!(
+          subtype: "mortgage",
+          interest_rate: interest_rate,
+          term_months: term_months,
+          rate_type: rate_type
+        )
+    end
 end