Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Find job reports

find_job_reports
Read-onlyIdempotent

The Job Reports category includes both summary and transaction detail reports. They can be customized only by date range, by column summarization, and by common filters. Some job reports require a customer:job reference in order to work

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": {
      "job_report_type": "<job_report_type>"
    },
    "name": "find_job_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`.
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.)
job_report_typeYesThe type of job 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_txn_type_filterNoAllows you to report on specific transaction types (for example, charge, check, deposit, or estimate).
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.6/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world behavior, so the safety profile is covered. The description adds genuinely new context: the tool returns a v2 request plus the webhook payload shape the QuickBooks answer arrives in, and it enumerates the error codes the caller must handle. That is meaningful operational detail beyond the structured fields, though it does not mention latency, polling, or webhook timing.

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 opening paragraph is front-loaded and earns its place, but the second and third paragraphs are a run-on sentence about the v2 request/webhook and a nine-item error-code list that is dense and hard to scan. The information is useful but the structure could be tightened with clearer separation between behavior and error handling.

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 17-parameter tool with nested filter objects and six enums, the description covers the key gaps the schema cannot: the customer:job prerequisite, the return mechanics (v2 request plus webhook payload), and the failure modes. With an output schema present, it need not describe return values in detail, and the remaining omission (how the webhook is delivered or awaited) is minor.

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%, so the schema already documents all 17 parameters including the mutually-exclusive filter groups and date macro options. The description's claim that reports are customizable 'only by date range, by column summarization, and by common filters' adds a useful usage constraint that maps to those parameter families, but it does not explain individual parameters. Baseline 3 is appropriate given the schema carries the load.

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 identifies the resource clearly ('Job Reports category includes both summary and transaction detail reports') and the required job_report_type enum in the schema pins down which reports are produced. It distinguishes itself from generic report tools by naming the job report family, though it never explicitly contrasts itself with siblings like find_general_summary_reports or find_job_types.

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?

It gives a real prerequisite ('Some job reports require a customer:job reference in order to work') and constrains customization to date range, column summarization, and common filters, which implicitly tells the agent what it cannot do. However, there is no explicit statement of when to choose this over another report tool or what conditions make a job report the wrong choice.

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