Reports Overview Tool
reports-overviewReads aggregate revenue, receivables, job, lead, and estimate performance for the authenticated workspace without exposing customer names, addresses, invoice rows, or mutation access. Use to inspect business performance totals in the connected business. Returns period_days, revenue, outstanding, jobs, leads, quotes, scope.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "reports-overview"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| period | No | Number of days for the bounded trend metrics; defaults to 30. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| jobs | Yes | Jobs data returned by the authorized safe projection. | |
| leads | Yes | Leads data returned by the authorized safe projection. | |
| scope | Yes | Authorization scope of this result; data remains restricted to the connected business. | |
| quotes | Yes | Quotes data returned by the authorized safe projection. | |
| revenue | Yes | Revenue metadata; empty collections retain their existing JSON array representation. | |
| outstanding | Yes | Outstanding metadata; empty collections retain their existing JSON array representation. | |
| period_days | Yes | Period days for the returned result. |