Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Find custom detail reports

find_custom_detail_reports
Read-onlyIdempotent

A Custom Transaction Detail report gives you complete control over the content of the report. It doesn’t have any default values and consists entirely of customized data. You must specify all the include columns for the transactions you want returned 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": {
      "custom_detail_report_type": "<custom_detail_report_type>",
      "include_column": "<include_column>",
      "summarize_rows_by": "<summarize_rows_by>"
    },
    "name": "find_custom_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_columnYes
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_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.
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).
custom_detail_report_typeYesThe type of report being queried.
report_open_balance_as_ofNoThe report will return open balance information up to the `report_open_balance_as_of` date.
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.5/5.0
Behavior4/5

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

Annotations already declare this as a safe, idempotent, non-destructive read, so the bar is lower, yet the description still adds meaningful context: it produces the v2 request to send plus the webhook payload shape in response_json, and it enumerates the error codes the caller must handle. The phrasing 'Returns the v2 request to send' is slightly ambiguous about the async flow, but the added behavioral detail clearly exceeds what the annotations convey. No contradiction with readOnlyHint, since the tool itself only compiles a report request.

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 purpose paragraph is front-loaded and efficient, but the second paragraph is muddled ('the v2 request to send') and followed by a ten-item error code dump that consumes roughly half the text for speculative failure modes. The content is relevant but not tightly structured or prioritized.

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?

For a 20-parameter, deeply nested tool with an output schema present, return values need not be explained, and the description's notable gap is not the parameters but the lack of routing guidance among the many sibling report tools. What it does supply — mandatory include columns and the webhook/error handling surface — is the right kind of information, just not sufficient to fully resolve which report tool to call.

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 documents nearly every parameter, including the report_period versus report_date_macro exclusivity and the filter one-of constraints. The description adds only the meaningful requirement that include_column be exhaustive; that is a genuine clarification, but the baseline of 3 is appropriate when the schema carries this much weight.

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 — a Custom Transaction Detail report — and its defining trait: no default values, entirely customized data, with all include columns required. That is a clear verb-and-resource statement, but it never distinguishes this tool from close siblings such as find_custom_summary_reports or find_general_detail_reports, so an agent must infer the boundary itself.

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?

The requirement that the caller 'must specify all the include columns' is a real invocation constraint, and 'complete control over the content' implies the use case (fully bespoke transaction detail output). However, there is no explicit when-to-use versus when-not guidance and no pointer to the general or summary report alternatives, leaving selection between the report tools to inference.

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