Loan aggregation summary
Get loan aggregation summary
Retrieve aggregated loan counts and amounts grouped by loan type and sale status for a specific MPL. Useful for dashboards and high-level reporting.
Query parameters
Parameter | Type | Required | Description |
|---|---|---|---|
mpl | String | Yes | MPL ID |
type | String | No | Filter by loan type: HFS, LTHFS, or RET |
fundedDate | Date | No | Filter by exact funded date (YYYY-MM-DD) |
fromFundedDate | Date | No | Filter loans funded after this date (YYYY-MM-DD) |
toFundedDate | Date | No | Filter loans funded before this date (YYYY-MM-DD) |
purchaseDate | Date | No | Filter by exact purchase date (YYYY-MM-DD) |
fromPurchaseDate | Date | No | Filter loans with purchase date after this date (YYYY-MM-DD) |
toPurchaseDate | Date | No | Filter loans with purchase date before this date (YYYY-MM-DD) |
fromOriginalPurchaseDate | Date | No | Filter by original purchase date range start (YYYY-MM-DD) |
toOriginalPurchaseDate | Date | No | Filter by original purchase date range end (YYYY-MM-DD) |
fromSeasoningStartDate | Date | No | Filter by seasoning start date range start (YYYY-MM-DD) |
toSeasoningStartDate | Date | No | Filter by seasoning start date range end (YYYY-MM-DD) |
fromPurchasedAt | Date | No | Filter by purchased timestamp range start (YYYY-MM-DD) |
toPurchasedAt | Date | No | Filter by purchased timestamp range end (YYYY-MM-DD) |
Response
200 OK - Returns aggregated data grouped by loan type and status:
- Total loan count per category
- Total loan amounts per category
- Breakdown by sale status (Pending, InSeasoning, ReadyForPurchase, Purchased, etc.)
Example request
Use cases
- Dashboard widgets: Display loan portfolio summaries
- Weekly reporting: Generate reports on loans funded or purchased in a date range
- Pipeline monitoring: Track how many loans are in each stage
- MPL portfolio overview: View all loan activity for a specific MPL