Get revenue dashboard summary
GET https://api.suger.cloud/org/{orgId}/revenue/dashboard/summary
Aggregate unified revenue records across every connected channel into dashboard totals: billed, collected, and disbursed amounts, a per-channel mix, a trend series, and open alerts, all converted to one base currency. Use this for the top-level revenue overview. GetRevenueDashboardMetrics returns the recurring-revenue KPIs (ARR, MRR, waterfall) instead.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | yes | Organization ID |
startDate | query | string | no | Earliest invoice date to include (RFC3339 or YYYY-MM-DD) |
endDate | query | string | no | Latest invoice date to include (RFC3339 or YYYY-MM-DD); must be on or after startDate |
groupBy | query | string | no | Trend grouping (defaults to month) |
baseCurrency | query | string | no | ISO 4217 code the amounts are converted to (defaults to the organization's base currency) |
Responses
200 — OK
Content-Type: application/json · Schema: RevenueDashboardSummaryResponse
400 — Invalid baseCurrency, date, or date range
Content-Type: application/json
401 — Missing or invalid access token, or the caller lacks the revenue read permission
Content-Type: application/json
500 — Failed to query the dashboard data
Content-Type: application/json