@apiverve/loanpaymentcalculator/index.d.ts

Loan Payment Calculator is a simple tool for calculating loan payments. It returns the monthly payment, total interest, and more.

declare module '@apiverve/loanpaymentcalculator' {
  export interface loanpaymentcalculatorOptions {
    api_key: string;
    secure?: boolean;
  }

  export interface loanpaymentcalculatorResponse {
    status: string;
    error: string | null;
    data: LoanCalculatorData;
    code?: number;
  }


  interface LoanCalculatorData {
      loanAmount:           number;
      downpayment:          number;
      interestRate:         number;
      loanTerm:             number;
      monthlyPayment:       number;
      totalInterestPaid:    number;
      amortizationSchedule: AmortizationSchedule[];
  }
  
  interface AmortizationSchedule {
      month:            number;
      interestPayment:  number;
      principalPayment: number;
      remainingBalance: number;
  }

  export default class loanpaymentcalculatorWrapper {
    constructor(options: loanpaymentcalculatorOptions);

    execute(callback: (error: any, data: loanpaymentcalculatorResponse | null) => void): Promise<loanpaymentcalculatorResponse>;
    execute(query: Record<string, any>, callback: (error: any, data: loanpaymentcalculatorResponse | null) => void): Promise<loanpaymentcalculatorResponse>;
    execute(query?: Record<string, any>): Promise<loanpaymentcalculatorResponse>;
  }
}