Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Find workers comp codes

find_workers_comp_codes
Read-onlyIdempotent

Requires the company to be subscribed to Intuit Payroll service. Queries for the workers’ compensation codes specified in the query filter; you can filter by name, modified date, and effective date.

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

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "find_workers_comp_codes"
  }
}

Input Schema

NameRequiredDescriptionDefault
list_idNoQuickBooks' ID for the record. Used over `full_name` when both are sent. Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_effective_date`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_effective_date`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
full_nameNoChoose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_effective_date`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_effective_date`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
meta_dataNoUse the `meta_data` attribute to control whether query responses include counts. Options are NoMetaData (default), MetaDataOnly (count only), and MetaDataAndResponseData (count plus objects).
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`.
name_filterNoFilters according to the object’s Name. Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_effective_date`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_effective_date`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
max_returnedNoLimits the number of objects that a query returns. (To get a count of how many objects could possibly be returned, use the `meta_data` query attribute.) QuickBooks doesn't page this query: at most this many records come back, in one answer, with no sign of whether more matched. Leave it out for every match, in one answer; one over 4 MB as the Web Connector sends it, about 3 MB of qbXML isn't kept (`error_type` `response_too_large`), so narrow a large one with its filters. Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_effective_date`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_effective_date`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
active_statusNoUsed in filters to select list objects based on whether or not they are currently enabled for use by QuickBooks. The default value is asActiveOnly, which selects only list objects that are active. Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_effective_date`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_effective_date`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
to_modified_dateNoFilters results to objects modified on or before this timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a date is provided, time defaults to end-of-day (23:59:59). Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_effective_date`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_effective_date`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
name_range_filterNoFilters according to the object’s Name. Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_effective_date`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_effective_date`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
to_effective_dateNoThe end of the range of effective dates to be searched. Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_effective_date`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_effective_date`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
from_modified_dateNoFilters results to objects modified on or after this timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a date is provided, time defaults to 00:00:00. Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_effective_date`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_effective_date`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
from_effective_dateNoThe beginning of the range of effective dates to be searched. Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_effective_date`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_effective_date`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
include_ret_elementNo

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 cover the safety profile (readOnly, idempotent, non-destructive, closed-world), so the bar is lower, and the description still adds substantial context: the subscription prerequisite, the fact that the call returns a v2 request plus a webhook payload shape rather than data directly, and the full error taxonomy including 3262 payroll_subscription_required. That two-phase/asynchronous behavior is not derivable from the annotations. It does not explain what happens on partial failures or how to correlate the webhook back, keeping it below 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.

Conciseness4/5

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

Front-loaded with the prerequisite, then purpose, then return shape, then errors — a sensible order that lets an agent stop reading early. The error enumeration is long but each entry is compact and directly actionable (it names the failure mode the call result explains), so it earns its space, though the block is denser than needed for a single query tool.

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 14-parameter, nested, enum-bearing query tool with full annotations, an output schema, and 93% schema coverage, the description covers the gaps that structured fields cannot: the payroll subscription prerequisite and the webhook-based response contract. Missing is guidance on choosing among sibling lookup/create/update tools and any note on result-size limits, both of which the agent would otherwise have to infer.

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 documents parameters thoroughly, including the mutual-exclusion sets and enum meanings; baseline 3 applies. The description's mention of filtering by name, modified date, and effective date merely restates the schema's own surface and adds no syntax, defaults, or trade-off guidance beyond it.

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?

States a specific verb and resource: "Queries for the workers' compensation codes specified in the query filter," then names the filterable dimensions (name, modified date, effective date). It is clearly distinguishable from sibling mutators (create_workers_comp_code, update_workers_comp_code) by its query verb, though it never names an alternative tool explicitly.

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?

Adds a real prerequisite — the company must be subscribed to Intuit Payroll service — which is a genuine gating condition for use. Beyond that there is no when-to-use versus when-not guidance and no routing to siblings such as find_bar_codes or the create/update counterparts; the agent must infer the choice from the verb alone.

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