Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Find general detail reports

find_general_detail_reports
Read-onlyIdempotent

You use this report query to get any of the supported QuickBooks detail reports, which you specify in the general_detail_report_type. You can optionally display the report within QB by setting display_report to True.

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_detail_report_type": "<general_detail_report_type>"
    },
    "name": "find_general_detail_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`.
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.)
include_columnNo
include_accountsNoIndicates whether this report should include all accounts or just those that are currently in use.
report_date_macroNoThe time period covered by this report. Choose at most one of: `report_period`, or `report_date_macro`.
summarize_rows_byNo`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.
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.
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_open_balance_as_ofNoThe report will return open balance information up to the `report_open_balance_as_of` date.
general_detail_report_typeYesThe type of general detail report to return. (If you specify gdrtMissingChecks, you must also specify an account type in the account filter.)
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

A3.7/5.0
Behavior4/5

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

Annotations already carry the safety profile (readOnly, idempotent, non-destructive, non-open-world), yet the description adds genuinely new behavior: the call returns the v2 request to send plus the webhook payload shape and status codes for QuickBooks' answer, making the async round-trip explicit. It also enumerates nine concrete error codes and states the call result explains each, which meaningfully helps recovery handling.

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

Conciseness4/5

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

Three short paragraphs, front-loaded with the core purpose and the key parameter before the return-shape and error notes. The error-code run-on is dense but each entry is informative; nothing is redundant filler.

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 a 20-parameter, deeply nested tool with an output schema, the definition covers purpose, the async request/webhook return model, and error taxonomy, so an agent knows what comes back without needing return-value documentation. The main gap is the absence of guidance on selecting among report types or picking this over sibling report tools.

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 90%, so the schema already explains nearly every parameter, including the mutually-exclusive filter rules and date-range macros. The description only highlights `general_detail_report_type` and `display_report`, adding no syntax or constraint detail beyond what the schema states, so the baseline 3 applies.

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 first sentence names a specific verb and resource ('get any of the supported QuickBooks detail reports') and identifies the discriminator parameter `general_detail_report_type`. It implicitly separates this from summary-report siblings by saying 'detail reports', but never names an alternative tool, so differentiation is by inference rather than explicit contrast.

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 is only implied: an agent can infer this is the tool for detail reports, and the description hints that gdrtMissingChecks requires an account filter. There is no explicit when-to-use/when-not guidance versus find_general_summary_reports or find_custom_detail_reports, and no advice on choosing among the ~34 report types.

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