Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Find budget summary reports

find_budget_summary_reports
Read-onlyIdempotent

Generates budget reports similar to the budget report functionality that is available within the QuickBooks UI. (From the main QB menubar select Reports->Budgets & Forecasts.) Note: the graphing functionality, forecasts, and memorized reports that available through the UI aren’t supported by the SDK. Notice that if you simply use the default instead of specifying the Fiscal Year, the report_period defaults to “year to date.” You can’t change the default to “This Fiscal Year.”

Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).

Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "budget_summary_report_type": "<budget_summary_report_type>",
      "fiscal_year": "<fiscal_year>"
    },
    "name": "find_budget_summary_reports"
  }
}

Input Schema

NameRequiredDescriptionDefault
request_idNoYour own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
fiscal_yearYesSpecify the fiscal year of the budget to be queried.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
report_periodNoIf you omit both `to_report_date` and `from_report_date`, the report will cover the current fiscal year to date. Choose at most one of: `report_period`, or `report_date_macro`.
display_reportNoSet `display_report` to true to display this report within the QuickBooks UI. (Default is false.)
budget_criterionNoWhat this budget covers.
report_date_macroNoThe time period covered by this report. Choose at most one of: `report_period`, or `report_date_macro`.
report_class_filterNoAllows you to query for a specified class. Classes can be used to separate transactions into meaningful categories.
summarize_budget_rows_byNoHow you want rows to be labeled in the report. For example, if you set the value to sbrbAccount, the report’s row labels might be “Checking,” “Savings,” and so on.
budget_summary_report_typeYesThe type of budget report being queried.
summarize_budget_columns_byNo`summarize_budget_columns_by` determines which data the report calculates and how the columns will be labeled across the top of the report.

Output Schema

NameRequiredDescriptionDefault
urlYesReplace {connection_id} with the customer's connection.
qbxmlNoThe qbXML it compiles to. Only with include_qbxml.
queryYesThe query parameters: the arguments you passed.
methodYes
headersYesSend with the request. Resent unchanged when no 201 came back, it answers with the request already queued.
webhookYesJSON Schema of the payload POSTed to webhook_url once QuickBooks answers, with this operation's response_json (data shape and status codes).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world), so the description's added value is in disclosing the async nature of the call: it returns a v2 request plus the webhook payload shape that QuickBooks' answer arrives in. It also flags the fiscal-year default behavior and enumerates the error codes/types the agent must handle, which is meaningful operational context beyond the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The core purpose and the webhook return contract are front-loaded, which is good. But the menubar navigation instructions ('select Reports->Budgets & Forecasts') and the long inline error-code dump add bulk that could be compressed, and the parenthetical UI aside interrupts the flow of the first sentence.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For an 11-parameter tool with nested objects, enums, and an output schema, the definition covers the essentials: what it produces, the two-stage request/webhook contract, the date-range defaulting caveat, and the error surface. The presence of an output schema relieves it of describing return data, and the remaining gap is minor — no guidance on sibling selection.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already carries parameter documentation and a 3 would be the baseline. The description earns above baseline by clarifying the defaulting trap: omitting fiscal year makes `report_period` default to 'year to date' and that default cannot be changed to 'This Fiscal Year', which is exactly the kind of behavioral nuance the schema does not state.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific resource — budget summary reports — and anchors it to the equivalent QuickBooks UI feature (Reports->Budgets & Forecasts), with the supported report types enumerated in the schema. It does not explicitly differentiate itself from sibling report finders such as find_general_summary_reports or find_custom_summary_reports, so the agent must infer the boundary from the name alone.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage context is implied through the UI analog and the warning that graphing, forecasts, and memorized reports are unsupported, which tells the agent when this tool falls short. However, there is no explicit 'use this instead of X when Y' routing against any sibling report tool, and no statement of prerequisites or account requirements.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources