@wealthx/borrow-capacity-lib/dist/types/finance.types.d.ts

Borrow capacity calculation library for WealthX

export interface ScenarioIncomeAndExpenseData {
    mainApplicantMonthlyIncome: number;
    coApplicantMonthlyIncome: number;
    mainApplicantMonthlyRentalIncome: number;
    coApplicantMonthlyRentalIncome: number;
    monthlyExpense: number;
    monthlyDebtRepayment: number;
}
export interface HistoryScenarioIncomeAndExpenseData extends ScenarioIncomeAndExpenseData {
    month: string;
}
export interface IncomeAndExpensesSummary {
    avgExpenseByLastXMonths: Record<string, number>;
    avgRepaymentExpenseByLastXMonths: Record<string, number>;
    incomesByLastXMonths: Record<string, {
        regular: Array<{
            avgAmount: number;
            isRentalIncome?: boolean;
        }>;
    }>;
}
export interface ScenarioFinanceHistoryItem {
    memberId: string;
    incomeAndExpensesSummary: IncomeAndExpensesSummary;
}
export declare enum AccountType {
    Transaction = "transaction",
    Savings = "savings",
    CreditCard = "credit-card",
    Mortgage = "mortgage",
    Loan = "loan",
    Investment = "investment",
    Share = "share",
    TermDeposit = "term-deposit",
    Insurance = "insurance",
    Other = "other",
    Unknown = "unknown",
    Superannuation = "superannuation"
}
export interface AccountMeta {
    lendingRates?: AccountLendingRate[];
}
export interface AccountLendingRate {
    rate?: string;
}
export interface Account {
    id: string;
    balance?: number;
    class?: {
        type?: AccountType;
    };
    institutionName?: string;
    institutionShortName?: string | null;
    institutionLogo?: string;
    lendingRate?: string;
    meta?: AccountMeta;
}
export interface Property {
    id?: string;
    estimate: number;
    accountIds?: string;
}
export declare enum PeriodType {
    Monthly = "monthly",
    Weekly = "weekly"
}