Skip to main content
Purpose: Per-account and cross-account cashflow analytics for linked bank (deposit) accounts. Covers monthly and overall cashflow metrics, category-wise spending analysis, and recurring transaction patterns.

Top-Level Structure


accounts[]

Each entry in accounts represents a single linked bank account.

accountDetail

analysis


Cashflow Fields (monthly and overall)

cashflow.monthly contains one object per calendar month. cashflow.overall uses the same fields as an aggregate across all months. Fields are grouped below by functional area.

Period Identifiers

Balance Metrics

EOD Balance on Specific Days

Credit Metrics

Debit Metrics

Summary / Ratio Metrics

UPI Metrics

ATM / Cash Metrics

Salary Metrics

Loan / EMI Metrics

Bounce / Reversal Metrics

Bank Charges & Penalties

Investment Metrics

Insurance, Utilities, ECS/NACH

Credit Card

Cheque / DD

Interest & Tax

Overdraft / Limit Utilisation

Wallet / Holiday / Sweep


overall

Cross-account aggregate. Contains the same analysis structure as a per-account entry, with two additional sections.

Usage Notes

  • All monetary values are in Indian Rupees (INR).
  • cashflow.overall contains the same fields as individual cashflow.monthly entries; it represents the aggregate across the entire statement period (no year, month, or monthName fields).
  • accounts[].analysis.cashflow is scoped to that single account. overall.analysis.cashflow aggregates across all linked accounts.
  • completeCategoryWiseAnalysis is only present at the per-account level. Cross-account category analysis is not included in overall.
  • recurringCredits and recurringDebits are only present in overall — they reflect patterns detected across all accounts.
  • salaryFiltered = true in a recurring group means the group was identified as a salary pattern and excluded from the generic recurring credit list.
  • Fields with two names (e.g., totalCreditTxn / totalCreditTransactions) are aliases carrying the same value — both may appear in the response.