Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Find price levels

find_price_levels
Read-onlyIdempotent

Queries for the specified price level or set of price levels.

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, 3000 invalid_object_id, 3120 object_not_found, 3140 invalid_reference, 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_price_levels"
  }
}

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`, `currency_filter`, `from_modified_date`, `item_ref`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
item_refNo`item_ref` may accept all item types or a restricted subset, depending on the request. Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `currency_filter`, `from_modified_date`, `item_ref`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
full_nameNoThe record's name, parents first: `Jones:Kitchen:Cabinets`. Not case-sensitive. Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `currency_filter`, `from_modified_date`, `item_ref`, `max_returned`, `name_filter`, `name_range_filter`, `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`, `currency_filter`, `from_modified_date`, `item_ref`, `max_returned`, `name_filter`, `name_range_filter`, `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`, `currency_filter`, `from_modified_date`, `item_ref`, `max_returned`, `name_filter`, `name_range_filter`, `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`, `currency_filter`, `from_modified_date`, `item_ref`, `max_returned`, `name_filter`, `name_range_filter`, `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.
currency_filterNoFilters by the specified currency. Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `currency_filter`, `from_modified_date`, `item_ref`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
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`, `currency_filter`, `from_modified_date`, `item_ref`, `max_returned`, `name_filter`, `name_range_filter`, `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`, `currency_filter`, `from_modified_date`, `item_ref`, `max_returned`, `name_filter`, `name_range_filter`, `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`, `currency_filter`, `from_modified_date`, `item_ref`, `max_returned`, `name_filter`, `name_range_filter`, `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

B3.3/5.0
Behavior4/5

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

Beyond the annotations (readOnly, idempotent, non-destructive, closed-world), the description discloses a genuinely non-obvious trait: this call returns a v2 request to send and the answer arrives as a QuickBooks webhook whose payload shape and status codes the caller must handle. It also enumerates the concrete error codes and types the caller may encounter. It stops short of explaining what each error means or how to remediate, deferring to the call result.

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 sentence is front-loaded and efficient, but the second half is a long run-on enumeration of fourteen error codes that reads like raw field data rather than guidance. That enumeration consumes most of the description's length while conveying little actionable information beyond 'these errors exist'.

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?

With 14 parameters, nested objects, and an output schema, the description does cover the two things an agent most needs beyond the schema: how the answer is delivered (webhook/response_json) and the error surface. However, it never explains the interplay between the single-record selectors and the filter set, nor the no-pagination behavior of max_returned, leaving the most error-prone aspect of invocation to the schema alone.

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 nearly all parameter meaning, including the mutual-exclusion rules among list_id, full_name, and the filter set. The description adds only the vague high-level 'specified price level or set of price levels' framing and no format, syntax, or precedence detail beyond what the schema states. Baseline 3 is appropriate.

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 opens with a specific verb and resource — 'Queries for the specified price level or set of price levels' — which is unambiguous and consistent with the find_* naming convention shared by its siblings. It does not explicitly distinguish itself from create_price_level or update_price_level, but the read semantics are clear from the verb and the readOnlyHint annotation.

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?

The phrase 'or set of price levels' hints that the tool serves both single-record lookup and filtered listing, but there is no explicit when-to-use, when-not-to-use, or alternative-routing guidance. Nothing tells an agent to prefer this over a targeted lookup or how to decide between the ID path and the filter path.

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