The
reports:read permission is required. Only loans with outstanding principal greater than zero are included — fully repaid loans do not appear.API Endpoint
| Parameter | Type | Required | Description |
|---|---|---|---|
expectedDate | ISO date | No | Arrears calculation cutoff date. Defaults to today if omitted. |
Response Structure
| Field | Type | Description |
|---|---|---|
asOfDate | ISO datetime | The expectedDate value you passed (or today) |
totalOutstanding | number | Sum of all outstanding balances across the entire portfolio |
totalExpected | number | Sum of all amounts expected to have been paid by asOfDate |
totalArrears | number | Total overdue amount across all loans |
| Field | Type | Description |
|---|---|---|
loanId | string | Unique loan identifier |
accountNumber | string | Loan ledger account number |
organizationUserId | string | Borrower’s user ID |
organizationUserName | string | Borrower’s full name |
organizationUserAccountNumber | string | null | Borrower’s savings account number |
loanDate | ISO datetime | Disbursement date |
termMonths | number | Original loan term in months |
outstandingBalance | number | Current balance owed (principal + interest), from the live ledger |
monthlyInstallment | number | Equated monthly installment (EMI) amount |
expectedByDate | number | Total amount that should have been paid by asOfDate per the schedule |
arrears | number | Overdue amount: max(0, expectedByDate − actuallyPaid) |
lastRepaymentDate | ISO datetime | null | Most recent posted payment date |
Key Concepts
Outstanding Balance
The outstanding balance is the current unpaid amount drawn directly from your ledger — not a theoretical projection. It reflects every payment posted to that loan’s account.Expected by Date
expectedByDate is the cumulative amount the borrower should have paid by expectedDate, based on their installment schedule.
Calculation logic:
- Generate the loan’s amortization schedule using its principal, interest rate, and term.
- Filter installments with a due date on or before
expectedDate. - Sum the principal and interest from those installments.
- Adjust for interest payment timing:
- IN_ADVANCE — all interest is expected immediately at disbursement.
- WITH_INSTALLMENTS — interest is expected only for installments that are due.
Arrears Formula
- Arrears = 0: The borrower is current — all scheduled payments have been made.
- Arrears > 0: The borrower is delinquent by this amount.
- Arrears cannot be negative: Overpayments reduce future arrears but are not shown as negative values.
Four Key Use Cases
Monthly Board Reporting
Monthly Board Reporting
Run the report on the last day of the month to capture the end-of-month portfolio snapshot for your board pack.What to present:
- Total outstanding — capital currently deployed in loans
- Total arrears — overdue amount and as a percentage of portfolio
- Number of active loans and delinquency count
- Trend comparison to the prior month
Loans Receivable in assets) and the P&L (which shows the interest income earned from the portfolio).Collections Management
Collections Management
Sort the loan list by
arrears descending to immediately identify who owes the most and how long it has been since their last payment.Suggested workflow:- Run the report weekly (or daily during active collection periods).
- Filter for loans where
arrears > 0. - Sort by
arrearsdescending. - Contact the top delinquent borrowers first.
- Review
lastRepaymentDate— if it is more than 60 days ago with no payment, escalate to guarantors. - Document all contact attempts and any repayment commitments made.
Liquidity Planning
Liquidity Planning
Use the If your cash position is low relative to member savings (below 10%), pause new loan approvals until collections bring cash back into range.
totalOutstanding figure alongside your Cash balance from the Balance Sheet to understand how much capital is deployed vs available.Provisioning for Bad Debts
Provisioning for Bad Debts
Industry practice is to set aside 50–100% of total arrears as a loan loss reserve. Use this report to calculate the required provision.See Reserves to learn how to create and fund a loan loss reserve.
Portfolio Health Indicators
| Metric | Healthy ✅ | Warning ⚠️ | Action Needed ❌ |
|---|---|---|---|
| Arrears as % of total outstanding | Below 5% | 5–10% | Above 10% |
Loans with arrears > 0 | Below 10% of loans | 10–20% of loans | Above 20% of loans |
lastRepaymentDate | Within 30 days for most loans | 30–60 days for multiple loans | 60+ days for multiple loans |
| Month-over-month arrears trend | Declining or stable | Slight increase | Sustained increase |
- Immediate — contact delinquent borrowers by phone or in person.
- Short-term — apply penalties per your organization’s policy.
- Medium-term — tighten lending criteria, require additional guarantors for future loans.
- Long-term — write off uncollectible loans and top up the loan loss reserve from retained earnings.
Relationship to the Balance Sheet
ThetotalOutstanding in this report must reconcile with the loan-related asset lines on the Balance Sheet when both are run as of the same date.
Related Reports
Balance Sheet
Reconcile loan assets and verify the accounting equation
Profit & Loss
Interest income earned from the portfolio
Shares Report
Member savings that fund the loan portfolio
Report Export
Include loans outstanding in your board pack