Cash Flow Analysis#

Cash Flow Analysis provides detailed financial attributes derived from a tenant's connected bank account data. These attributes power the cash flow score and provide granular insights for manual review.

Attribute Categories#

Attributes are organized into three nodes:

INCOME Attributes#

Attribute	Description
`monthly_income`	Average monthly income
`income_stability_score`	Income consistency over time (0–1)
`income_source_count`	Number of distinct income sources
`pay_frequency`	Detected pay frequency
`rent_to_income_ratio`	Proposed rent as ratio of income
`income_trend`	Income trend direction (positive/negative/stable)

EXPENSES Attributes#

Attribute	Description
`monthly_expenses`	Average monthly expenses
`expense_volatility`	Expense variation coefficient
`recurring_obligations`	Total recurring monthly obligations
`debt_to_income_ratio`	Total debt payments as ratio of income
`discretionary_spending`	Non-essential spending ratio
`gambling_activity`	Detected gambling transactions flag

ASSETS Attributes#

Attribute	Description
`net_monthly_cash_flow`	Income minus expenses
`savings_balance`	Current savings balance
`average_daily_balance`	Average daily balance over period
`minimum_balance_30d`	Lowest balance in last 30 days
`overdraft_frequency`	Number of overdraft occurrences
`nsf_count`	Non-sufficient funds count

Retrieving Cash Flow Attributes#

Cash flow attributes are included in the Score Report:

curl https://api.casapay.com/v1/score_reports/scrpt_xyz789 \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc"

Filter attributes by node:

const report = await casapay.scoreReports.retrieve('scrpt_xyz789');

const incomeAttrs = report.attributes.filter(a => a.node === 'INCOME');
const expenseAttrs = report.attributes.filter(a => a.node === 'EXPENSES');
const assetAttrs = report.attributes.filter(a => a.node === 'ASSETS');