jn-devops/payment

Homeful Payment Package

Fund package maintenance!
Homeful

v1.3.3 2025-03-25 08:08 UTC

This package is auto-updated.

Last update: 2025-03-25 08:10:31 UTC


README

The Homeful\Payment package provides a robust and testable abstraction layer for mortgage-related financial computations. It encapsulates the standard PMT and PV formulas using precise monetary operations via the whitecube/price and brick/money libraries.

๐Ÿ“ฆ Features

  • Compute monthly amortization with interest and term (PMT formula)
  • Add-on fee handling (e.g. insurance, extra charges)
  • Deductible fee support (e.g. rebates, adjustments)
  • Compute present value from future payment streams (PV formula)
  • Income requirement estimation based on configurable disposable income percentage
  • Extensive test coverage and simulation datasets

โœ… Installation

Ensure you have the following packages:

composer require whitecube/price brick/money jarouche/financial

๐Ÿงฎ Usage

๐Ÿ“˜ Basic PMT Calculation

use Homeful\Payment\Payment;
use Homeful\Payment\Class\Term;

$payment = (new Payment)
    ->setPrincipal(850000.0)
    ->setTerm(new Term(20)) // 20 years
    ->setInterestRate(6.25 / 100);

$monthly = $payment->getMonthlyAmortization();
echo $monthly->format(); // e.g. PHP 6,213.00

โž• Add-On Fees (e.g. Fire Insurance, MRI)

use Homeful\Common\Classes\AddOnFeeToPayment;

$payment->addAddOnFeeToPayment(new AddOnFeeToPayment('fire insurance', 100, false));
$payment->addAddOnFeeToPayment(new AddOnFeeToPayment('mortgage redemption insurance', 200, false));

โž– Deductible Fees (e.g. Promo Deduction)

use Homeful\Common\Classes\DeductibleFeeFromPayment;

$payment->addDeductibleFee(new DeductibleFeeFromPayment('promo', 125, true));

๐Ÿงพ Income Requirement

echo $payment->getIncomeRequirement(); // e.g. PHP 20,710.00

๐Ÿ’ก Present Value Calculation

use Homeful\Payment\PresentValue;
use Homeful\Payment\Class\Term;

$pv = (new PresentValue)
    ->setPayment(19978.48)
    ->setTerm(new Term(20))
    ->setInterestRate(7 / 100);

echo $pv->getDiscountedValue()->format(); // e.g. PHP 2,576,874.00

๐Ÿงช Testing

Unit and simulation tests available in /tests/Payment.

php artisan test --filter=Payment

Includes scenarios for:

  • Edge case interest validation
  • Max term validations
  • Add-on and deductible modifier interactions
  • Multiple amortization simulations

โš™๏ธ Configuration

You may configure these via config/payment.php:

return [
    'default_percent_disposable_income' => 0.30,
    'max_years_to_pay' => 30,
    'max_months_to_pay' => 360,
];

๐Ÿ“‚ Data Transformation

Use PaymentData::fromObject($payment) to extract structured values like:

  • principal
  • term, cycle
  • interest_rate
  • monthly_amortization
  • income_requirement

๐Ÿงฉ Traits

  • HasAddOnFees
  • HasDeductibleFees
  • HasIncomeRequirement

These ensure modular responsibility and are shared across payment types.

๐Ÿค Dependencies

โœจ Example Output

$payment = (new Payment)
    ->setPrincipal(2900000)
    ->setTerm(new Term(30))
    ->setInterestRate(6.75 / 100);

echo $payment->getMonthlyAmortization()->format(); // PHP 18,809.00

Behold, a new you awaits โ€” one with precise mortgage computations and a testable financial layer.