lease-calculator v4.1.0

Car Lease Calculator :red_car:

A simple auto lease calculator for calculating your monthly lease payment, APR, total lease cost, percentage off MSRP, etc.

See it used in the Auto Lease app: https://github.com/ErezNagar/lease-calculator-app

Features

• Calculates car lease payments including total monthly payment, monthly payment pre-tax, total lease cost, APR, percentage off MSRP and drive-off fees.
• Since v4.0.0: Calculates car financing, including finance monthly payment, total finance cost and total finance interest
• Supports methods of taxation by state
• Includes acquisition fee for supported manufacturers
• Includes disposition fee for supported manufacturers
• Supports zero down payment
• Supports zero drive-off payments

How To Use

npm install lease-calculator

const leaseCalculator = new LeaseCalculator();
const lease = leaseCalculator.calculate({
  make: "Toyota",
  msrp: 23000,
  sellingPrice: 21000,
  rv: 13110,
  isRVPercent: false,
  mf: 0.00125,
  salesTax: 6.25,
  totalFees: 1200,
});

// Get the lease monthly payment
const monthlyPayment = lease.getMonthlyPayment();

API

calculate(options: Object): LeaseResults

Calculate lease payments. Returns LeaseResults object

Arguments: options object, with the following attributes:

• make: string = "" Make of the vehicle, for calculating manufacturer-based fees.

• msrp: number Required, MSRP of the vehicle.

• sellingPrice: number Required, negotiated price of the vehicle.

• rv: number Required, residual value of the vehicle. If isRVPercent is true, value must be a percentage, e.g., if RV is 65%, rv should be 65.

• isRVPercent: boolean = true Whether the RV is an absolute value or a percentage of MSRP.

• mf: number Required, the money factor of the lease (e.g. 0.00125).

• leaseTerm: number = 36 The length of the lease in months.

• salesTax: number = 0 The state's sales tax in percentage.

• totalFees: number = 0 Total fees of the lease.

• rebates: number = 0 Total discount from dealer and manufacturer.

• downPayment: number = 0 Down payment, if applicable.

• taxMethod: TaxationMethod = TaxationMethod.TAX_ON_MONTHLY_PAYMENT Method of taxation to apply, based on state.

• isZeroDriveoff: boolean = false Added in v1.3.0. Whether the lease should be calculated with zero drive-off amount. If true, all fees and taxes are rolled into the monthly payment.

LeaseResults.getMonthlyPayment(): number

Gets the monthly payment of the lease, including taxes.

LeaseResults.getMonthlyPaymentPreTax(): number

Gets the monthly payment of the lease, not including taxes.

LeaseResults.getTotalLeaseCost(): number

Gets the total cost of the lease. This includes all monthly payments, down payment, disposition fee, acquisition fee, dealer fees and lease taxes.

LeaseResults.getDriveOffPayment(): number

Gets total drive-off payment.

LeaseResults.getDriveOffTax(): number

Gets the tax amount on drive off payment.

LeaseResults.getDiscountOffMsrpPercentage(): number | null

Gets the discount off of MSRP, in percentage. Returns null if Selling Price >= MSRP (v3.0.0).

LeaseResults.getMonthlyPaymentToMsrpPercentage(): number

Gets the percentage of the monthly payment out of the MSRP.

LeaseResults.getAPR()

Gets the APR value of the lease.

LeaseResults.getAcquisitionFee(): number

Gets the acquisition fee value by brand. If no brand sepcified, returns 0.

LeaseResults.getDispositionFee(): number

Gets the disposition fee value by brand. If no brand sepcified, returns 0.

LeaseResults.getRVValue(): number

Gets the residual value of the lease.

LeaseResults.getRVPercentage(): number

Gets the residual value of the lease in percentage.

LeaseResults.getDepreciation(): number

Gets the total depreciation value of the lease. Added in v2.1.0.

LeaseResults.getBaseMonthlyPayment(): number

Gets the base monthly payment. Added in v2.1.0.

LeaseResults.getRentCharge(): number

Gets the rent charge value. Added in v2.1.0.

LeaseResults.getTotalInterest(): number

Gets total interest for the lease. Added in v2.1.0.

LeaseResults.getMonthlyTax(): number

Gets the monthly tax value. Applicable on for taxatino method is TAX_ON_MONTHLY_PAYMENT. Otherwise, returns 0. Added in v2.1.0.

LeaseResults.getTotalTax(): number

Gets the total tax for the lease. Added in v2.1.0.

LeaseResults.getDriveOffPaymentBreakdown(): object[] | null

Returns a list of all drive-off payments. Returns null if isZeroDriveoff is true.

LeaseResults.getFinanceMonthlyPayment(): number

Returns the finance monthly payment, inc. tax.

LeaseResults.getFinanceTotalCost(): number

Returns the total cost of finance. Comprised of the monthly payment over the life of the load plus down payment and any trade-in value.

LeaseResults.getTotalAmountFinanced(): number

Returns the total financed amount. Comprised of the selling price plus any fees and taxes minus down payment, trade-in value and any rebates.

LeaseResults.getFinanceTotalInterest(): number

Returns the total interest paid for finance.

calculateFinance (options: Object): FinanceResults

Since v4.0.0. Calculates finance payments. Returns FinanceResults object.

Arguments: options object, with the following attributes:

• financeTerm: number Required, the length of the loan, in months.

• sellingPrice: number Required, negotiated price of the vehicle.

• APR: number Required, the Annual Percentage Rate of the loan, in percentage (e.g. 4.5%).

• salesTax :number = 0, The state's sales tax, in percentage.

• taxableFees :number = 0, Total taxable fees (non-governmental fees such as dealer doc fees and any dealer add-ons)

• untaxableFees :number = 0, Total fees that are not taxable (government-related fees such as license and registration.

• downPayment :number = 0, Down payment, if applicable.

• tradeIn :number = 0, Trade-in value, if applicable.

• rebates :number = 0, Total discount from manufacturer.

FinanceResults.getFinanceMonthlyPayment(): number

Gets the financing monthly payment, including tax.

FinanceResults.getFinanceTotalCost(): number

Gets the total cost of the loan. Comprised of the monthly payment over the life of the loan plus down payment and any trade-in value.

FinanceResults.getTotalAmountFinanced(): number

Gets the total financed amount. Comprised of the selling price plus any fees and taxes.

FinanceResults.getFinanceTotalInterest(): number

Gets the total interest paid for duration of the loan.

Supported manufacturers

Lease Calculator supports acquisition and disposition fee calculation for the following brands:

Acura, Alfa Romeo, Audi, Bmw, Buick, Cadillac, Chevrolet, Chrysler, Dodge, Fiat, Ford, Genesis, GMC, Honda, Hyundai, Infiniti, Jaguar, Jeep, Kia, land rover, Lexus, Lincoln, Mini, Mazda, Mercedes benz, Mitsubishi, Nissan, Ram, Scion, Smart, Subaru, Tesla, Toyota, Volkswagen, Volvo