Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Find customers

find_customers
Read-onlyIdempotent

Finds customers and jobs: exact ones by list_id or full_name, or a filtered set by name, active_status and modified date. Without active_status only active customers come back. Set iterator to page through a long list: each page arrives at your webhook_url under one request id.

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_customers"
  }
}

Input Schema

NameRequiredDescriptionDefault
includeNo
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_modified_date`, `max_returned`, `name_contains`, `name_ends_with`, `name_range`, `name_starts_with`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
iteratorNoPage through every match: QuBe Sync asks QuickBooks for each page in turn and sends each to your `webhook_url` as it arrives, all with the same `id`. On by default, with pages of 100 records; send `iterator=true` with `max_returned` for another size. Off when you send `iterator=false` (every match in one answer) or `max_returned` alone (at most that many, in one answer). It pages a filtered query only: with `full_name` or `list_id` every match comes back in one answer, so leave `iterator` out.
owner_idNo`owner_id` identifies who owns the data extension. Use 0 for QuickBooks custom fields that appear in the UI, or use a GUID for private extensions owned by an app.
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`, `from_modified_date`, `max_returned`, `name_contains`, `name_ends_with`, `name_range`, `name_starts_with`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
name_rangeNoFilters according to the object’s Name. Choose at most one of: the set (`name_contains`, `name_ends_with`, `name_starts_with`), or `name_range`. Members of a set combine with each other, not with the other choices.
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`.
max_returnedNoLimits the number of objects that a query returns. (To get a count of how many objects could possibly be returned, use the metaData query attribute.) The page size, with `iterator=true`. Sent without `iterator`, or with `iterator=false`, it's a cap instead: at most this many records come back, in one answer, and QuickBooks doesn't say whether more matched. Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_contains`, `name_ends_with`, `name_range`, `name_starts_with`, `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_modified_date`, `max_returned`, `name_contains`, `name_ends_with`, `name_range`, `name_starts_with`, `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.
name_containsNoFilters according to the object’s Name. Choose at most one of: the set (`name_contains`, `name_ends_with`, `name_starts_with`), or `name_range`. Members of a set combine with each other, not with the other choices.
name_ends_withNoFilters according to the object’s Name. Choose at most one of: the set (`name_contains`, `name_ends_with`, `name_starts_with`), or `name_range`. Members of a set combine with each other, not with the other choices.
name_starts_withNoFilters according to the object’s Name. Choose at most one of: the set (`name_contains`, `name_ends_with`, `name_starts_with`), or `name_range`. 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`, `from_modified_date`, `max_returned`, `name_contains`, `name_ends_with`, `name_range`, `name_starts_with`, `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_modified_date`, `max_returned`, `name_contains`, `name_ends_with`, `name_range`, `name_starts_with`, `to_modified_date`). Members of a set combine with each other, not with the other choices.

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

A4.2/5.0
Behavior4/5

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

Annotations already declare read-only, idempotent, non-destructive, so safety needs no restating; the description instead discloses the non-obvious behavior that results are delivered asynchronously to a `webhook_url` under one request id, and that the tool returns a v2 request plus the webhook payload shape. It also enumerates the error codes an agent must handle, though each code is only labeled, with details deferred 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.

Conciseness4/5

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

Front-loaded with the core lookup modes and paging rule, which is the right priority. The trailing parenthetical about response_json and the dense comma-separated error-code list are useful but heavy, and the error list could be compressed without loss.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given an output schema exists and parameter documentation is near-complete, the description covers the remaining agent-relevant gaps: default active-only filtering, the async webhook delivery model, pagination semantics, and the error surface. Nothing essential to a correct call is missing.

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 coverage is 93%, so nearly every parameter already carries a description, and the prose largely restates the schema's own 'choose at most one of' grouping in digestible form. It adds a little framing (exact versus filtered mode) but no new constraints, formats, or defaults beyond what the schema states.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The first sentence names a specific verb and resource ('Finds customers and jobs') and then enumerates the two lookup modes (exact by `list_id`/`full_name` versus a filtered set). This is enough for an agent to distinguish it from siblings like find_customer_types or find_customer_msgs without opening either schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives clear operative context: without `active_status` only active customers return, and `iterator` should be used to page a long filtered list but left out for `list_id`/`full_name` lookups. It stops short of naming an alternative tool or stating when-not to use this at all, so it is context rather than full routing.

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