@wealthx/borrow-capacity-lib/dist/calculations/history-data.d.ts

Borrow capacity calculation library for WealthX

import { HistoryScenarioIncomeAndExpenseData, ScenarioFinanceHistoryItem } from "../types/finance.types";
/**
 * Process scenario finance history to calculate aggregated monthly data
 * This function processes expense and income data for all participants across multiple months
 *
 * @param scenarioFinanceHistory - Array of scenario finance history items
 * @param scenarioFinanceHistory.incomeAndExpensesSummary.avgExpenseByLastXMonths - Negative value represent a deduction, Example: { "2025-09": -1000 }
 * @param scenarioFinanceHistory.incomeAndExpensesSummary.avgRepaymentExpenseByLastXMonths - Positive value represent a repayment, Example: { "2025-09": 1000 }
 * @param scenarioFinanceHistory.incomeAndExpensesSummary.incomesByLastXMonths - Positive value represent a credit action, Example: { "2025-09": { "regular": [{ "avgAmount": 1000, "isRentalIncome": true }] } }
 * @param userId - Main applicant user ID
 * @returns Array of processed history data sorted by month
 */
export declare function processScenarioHistoryData(scenarioFinanceHistory: ScenarioFinanceHistoryItem[], userId: string): HistoryScenarioIncomeAndExpenseData[];