Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Find general summary reports

find_general_summary_reports
Read-onlyIdempotent

The General Summary Reports category is the largest category for summary reports. In addition to common customizations, the reports within this category can be customized by the number of columns that are returned and by period comparisons for the data in the report.

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": {
      "general_summary_report_type": "<general_summary_report_type>"
    },
    "name": "find_general_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`.
return_rowsNoSpecifies whether you want the report to include only rows with active information, only rows with nonzero values, or all rows regardless of their content or active status.
report_basisNo
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.)
return_columnsNoSpecifies whether you want the report to include only columns with active information, only columns with nonzero values, or all columns regardless of their content or active status.
report_calendarNoSpecifies the type of year that will be used for this report.
report_date_macroNoThe time period covered by this report. Choose at most one of: `report_period`, or `report_date_macro`.
include_subcolumnsNoThe default value is false, which means that the report won’t include any subcolumn information. To include all available types of subcolumns for this report, set `include_subcolumns` to true.
report_item_filterNoAllows you to query for a specified item type (for example, discount, inventory, or non-inventory) or query for specific list elements.
report_class_filterNoAllows you to query for a specified class. Classes can be used to separate transactions into meaningful categories.
report_entity_filterNoAllows you to query for a specified name type (customer, employee, vendor, or other) or query for specific list elements.
summarize_columns_byNo`summarize_columns_by` determines which data the report calculates and how the columns will be labeled across the top of the report.
report_account_filterNoAllows you to query for a specified account type or for specific list elements.
report_txn_type_filterNoAllows you to report on specific transaction types (for example, charge, check, deposit, or estimate).
report_detail_level_filterNoThe level of detail to include in the report.
general_summary_report_typeYesThe type of general summary report being queried. The report types listed below map almost directly to named reports in QuickBooks.
report_posting_status_filterNoAllows you to query for posting reports, non-posting reports, or reports that are either one.
report_modified_date_range_macroNoThe time period covered by this report. Choose at most one of: `report_modified_date_range_filter`, or `report_modified_date_range_macro`.
report_modified_date_range_filterNoReturns reports that were modified between these two dates (inclusive). Choose at most one of: `report_modified_date_range_filter`, or `report_modified_date_range_macro`.

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

B3/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive/closed-world, and the description adds real context beyond them: the call does not return report data directly but returns a v2 request to send plus the webhook payload shape in response_json. It also enumerates the error codes and types (e.g. 3260 insufficient_permission, 3250 feature_not_enabled) the caller must handle, which is substantive operational detail not present in 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 opening sentence about category size and 'common customizations' earns little and is placed first, ahead of the far more important fact that the call returns a request to send rather than the report. The error-code list is long but useful; overall the content is dense yet poorly front-loaded.

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

Completeness3/5

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

With 21 parameters, nested filters, and an output schema, the description covers return shape and error handling reasonably, but it omits how the returned v2 request is actually dispatched and how the webhook answer is correlated, and gives no guidance on choosing among the 29 report types. Adequate but with clear gaps for a tool of this complexity.

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

Parameters3/5

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

Schema description coverage is 95%, so the schema already documents nearly every parameter including enums and nested filter exclusivity rules. The description only gestures at two of them ('number of columns' and 'period comparisons') without adding syntax, defaults, or interactions beyond what the schema states, so it sits at the baseline.

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

Purpose3/5

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

The description never states the action plainly; the first sentence is category trivia ('the largest category for summary reports') rather than a verb+resource statement. The second paragraph reveals what the tool returns (a v2 request plus webhook payload) but never says it builds/compiles a General Summary Report request, and it draws no boundary against siblings such as find_custom_summary_reports or find_budget_summary_reports.

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

Usage Guidelines2/5

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

There is no when-to-use guidance, no exclusions, and no named alternative. An agent cannot tell from this text why it would pick this tool over find_custom_summary_reports or find_general_detail_reports; only the enum of report types in the schema hints at scope.

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