Skip to Content
API ReferenceEarnings & Cap

Earnings & Cap API

Cap Status Values

type CapStatus = 'pre_cap' | 'capped' | 'elite'

Endpoints

Get Earnings Summary

GET /api/dashboard/earnings Authorization: Bearer <jwt>

Returns:

{ "ytd_gci": 18500.00, "ytd_net": 12950.00, "deals_closed": 4, "cap_status": "pre_cap", "monthly": [ { "month": "2026-01", "gci": 4200.00, "net": 2940.00 } ] }

Get Cap Progress

GET /api/dashboard/cap-progress Authorization: Bearer <jwt>

Returns:

{ "cap_amount": 30000, "ytd_gci": 18500, "percentage": 61.7, "cap_status": "pre_cap", "current_split_rate": 0.70, "elite_cap_amount": 50000, "anniversary_date": "2027-03-01" }

Simulate Commission Split

POST /api/dashboard/earnings/simulate Authorization: Bearer <jwt> Content-Type: application/json { "gross_commission": 15000 }

Returns projected split based on current cap status and brokerage settings.


Export Earnings (Broker)

GET /api/brokerage/finance/export?format=csv&from=2026-01-01&to=2026-06-30 Authorization: Bearer <jwt> (broker only)

Available formats: csv, pdf

Last updated on