DD Overview Dashboard
DD Overview Dashboard
Available from v1.0.73
The DD Overview Dashboard is the primary landing screen for the Direct Debit collection service. It replaces the generic overview page with a purpose-built view of your DD operation — giving you key metrics, reserve health, a live activity feed, and fast access to the most common actions, all in one place.
Dashboard Metrics
The dashboard displays six stats cards. Each card is clickable and links through to the relevant list or detail page for deeper investigation.
| Card | Description |
|---|---|
| Active Mandates | Total number of mandates currently in an active state for your account. |
| Scheduled Collections This Week | Count and total GBP value of collections scheduled to run within the current week. |
| Collections Succeeded This Month | Count of collections that completed successfully in the current calendar month. |
| Collections Failed This Month | Count of collections that failed or were returned in the current calendar month. |
| Clawbacks This Month | Number of clawback events raised against your account in the current calendar month. |
| Reserve Health | Indicates whether the clawback reserve held in the Griffin DD holding account currently meets the configured minimum threshold. |
Reserve Health
The reserve health indicator reflects the live balance of the clawback reserve relative to the risk-adjusted minimum threshold configured for your account. A healthy reserve means funds can be forwarded to the agent's client account as normal. If the reserve drops below the minimum, forwarding is paused until the reserve is replenished.
See Clawback Reserve for configuration details.
Recent Activity Feed
Below the stats cards, a chronological activity feed shows recent DD events across your account, including:
- Mandate creations
- Collection successes and failures
- Clawback events
- Alerts raised
The feed provides quick situational awareness without needing to navigate to individual list pages.
Quick Actions
Two quick-action buttons are available at the top of the dashboard:
Send Mandate Invite
Generates a unique, token-based mandate form link and sends it to a tenant. Clicking this button opens the invite flow directly from the dashboard — no need to navigate to the mandates list first.
View Alerts
Navigates directly to the alerts list, where you can review and acknowledge any active threshold or fraud alerts.
API Access via tRPC
All dashboard metrics are available to API consumers via tRPC. This allows external applications (such as agentOS) to query the same data programmatically and render their own dashboard views.
All metrics are scoped per customer — only data belonging to the authenticated letting agent is returned.
Available Queries
| Query | Returns |
|---|---|
dashboard.activeMandateCount | Integer count of active mandates. |
dashboard.scheduledCollectionsThisWeek | Count and total GBP value of this week's scheduled collections. |
dashboard.collectionsSucceededThisMonth | Count of successful collections this month. |
dashboard.collectionsFailedThisMonth | Count of failed collections this month. |
dashboard.clawbacksThisMonth | Count of clawback events this month. |
dashboard.reserveHealth | Reserve balance, minimum threshold, and health status. |
dashboard.recentActivity | Paginated list of recent DD events. |
Refer to the API Reference for full request/response schemas and authentication requirements.
Multi-Tenancy
All data displayed on the dashboard is strictly scoped to the authenticated letting agent's account. Agents cannot see metrics or activity belonging to other agents.