Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Find time reports

find_time_reports
Read-onlyIdempotent

The Time Reports category includes summary and detail reports related by time. Summarized columns can be customized in these reports.

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": {
      "time_report_type": "<time_report_type>"
    },
    "name": "find_time_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.
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
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.
time_report_typeYesAllows you to report on time that has been recorded in a particular category.
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.

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.1/5.0
Behavior4/5

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

Annotations already cover safety (readOnly, idempotent, non-destructive), but the description adds material context they cannot convey: the call is asynchronous, returning a v2 request plus the webhook payload shape the QuickBooks answer arrives in. It also enumerates the error codes/types the caller must handle, which is exactly the kind of beyond-schema behavior an agent needs.

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 error enumeration is genuinely useful but is delivered as a single dense parenthetical with heavy nesting, and the first sentence spends its budget on category marketing rather than the operation. Front-loading the async request/webhook nature of the call would have made the opening sentence earn its place.

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 15-parameter nested tool with an output schema, the description covers the two things the schema cannot: the async request/webhook round trip and the failure modes. What is missing is guidance on the four time_report_type values and how they differ, which matters for the one required parameter.

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 93%, so the schema already carries parameter meaning and the baseline of 3 applies. The only parameter-adjacent content in the description is the note that summarized columns can be customized, which loosely gestures at include_column/summarize_columns_by without adding format or selection advice.

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 opening sentence describes the Time Reports category ("summary and detail reports related by time") rather than stating a verb+resource for the tool itself, and nothing distinguishes it from siblings such as find_time_trackings or find_payroll_summary_reports. The second sentence does reveal the actual output ("the v2 request to send, and the webhook payload"), which rescues it from being a pure tautology, but an agent still has to infer that this tool compiles a request rather than fetching finished report data.

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 statement of when to use this tool, when not to, or which sibling to pick for adjacent needs (time trackings vs. payroll detail reports vs. job reports). The only selection guidance lives inside the schema (e.g. "Choose at most one of: report_period, or report_date_macro"), not in the description.

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