Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Find custom summary reports

find_custom_summary_reports
Read-onlyIdempotent

A custom summary report gives you complete control over the content of the report. It doesn’t have any default values and consists entirely of customized data.

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": {
      "custom_summary_report_type": "<custom_summary_report_type>",
      "summarize_columns_by": "<summarize_columns_by>",
      "summarize_rows_by": "<summarize_rows_by>"
    },
    "name": "find_custom_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`.
summarize_rows_byYes`summarize_rows_by` (along with IncludeColumnList, in most cases) determines what data is calculated for this report and controls how the rows are organized and labeled.
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_byYes`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).
custom_summary_report_typeYesThe type of report being queried.
report_detail_level_filterNoThe level of detail to include in the report.
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, and the description adds real context beyond that: the call compiles a request rather than returning data directly, the answer arrives via a webhook payload in response_json. The enumerated error codes (3220 not_authorized, 3260 insufficient_permission, 3261 personal_data_access_denied) disclose permission and feature-gating failure modes the annotations do not.

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?

Two paragraphs with little waste, but the lead paragraph spends its opening sentence on report semantics instead of the tool's action, and the long comma-separated error catalogue is dense prose that could be scaffolded more clearly.

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?

Return mechanics and the full error taxonomy are covered, and the rich 22-parameter schema with an output schema carries the rest. However, for a tool sitting among many report siblings, the definition gives no guidance on selecting this report family, which is a notable remaining gap.

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% and every enum, nested filter, and date range is documented in the schema itself, so the baseline of 3 applies. The description contributes nothing about any of the 22 parameters.

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 defines what a custom summary report is ('no default values, entirely customized data') rather than stating a tool action; the second paragraph clarifies that it returns a compiled v2 request plus a webhook payload. It never names a sibling, so nothing explicitly separates it from find_custom_detail_reports or find_general_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 and no alternative is named. With siblings like find_general_summary_reports (defaults) and find_custom_detail_reports (detail level) the definition leaves the agent to infer selection from the name alone.

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