Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Find payroll summary reports

find_payroll_summary_reports
Read-onlyIdempotent

This report returns information from any of three QuickBooks payroll 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": {
      "payroll_summary_report_type": "<payroll_summary_report_type>"
    },
    "name": "find_payroll_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.
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_detail_level_filterNoThe level of detail to include in the report.
payroll_summary_report_typeYesThe type of payroll report: psrtEmployeeEarningsSummary This report shows information similar to the payroll summary report, but in a different layout.
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 cover the safety profile (readOnly, idempotent, non-destructive, non-open-world), and the description adds genuinely useful behavior beyond that: it explains that the call returns a v2 request plus the webhook payload the answer arrives in, and it enumerates the specific error codes (1030, 3220, 3262, etc.) with a pointer that the call result explains each. That async/webhook execution model is not derivable from the annotations or schema. It stops short of saying whether the request is actually dispatched or merely compiled, which keeps it from a 5.

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 body is short and the error-code enumeration is compact and earns its space, but the first sentence is broken, terminating in a colon with an enumerated list that never follows. That malformed lead-in pushes the agent into the schema to learn the most basic fact about the tool.

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?

Output schema, annotations, and full schema coverage carry most of the burden for this 19-parameter tool, and the description's response/error information fills a real gap. However, for a tool wiring 19 parameters (9 with enums) into a webhook-based flow, the description says nothing about how the three report types differ or what payload shape to expect beyond the pointer to response_json.

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 100% and the 19 parameters, including nested filter objects with mutual-exclusion constraints, are fully documented in the schema itself. The description adds no parameter-level meaning — it never explains how to choose among the three report types or how report_period and report_date_macro interact — so the baseline 3 applies.

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 says it 'returns information from any of three QuickBooks payroll reports,' which gives a verb and a resource, but the sentence ends in a dangling colon with the three report types never listed (they only appear in the `payroll_summary_report_type` enum). Nothing distinguishes it from siblings such as find_payroll_detail_reports or find_general_summary_reports, so the agent must infer the boundary from the tool name.

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, when-not-to-use, or alternative-tool guidance anywhere in the text. With siblings like find_payroll_detail_reports and find_payroll_last_periods in the catalog, an agent gets no signal about which to pick; the only routing information lives implicitly in the parameter enum.

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