Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Find bill to pays

find_bill_to_pays
Read-onlyIdempotent

The BillToPayQuery request returns information about open bills and credits. You can use this information in subsequent BillPaymentCheck and BillPaymentCreditCard requests.

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

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": {
      "payee_entity_ref": "<payee_entity_ref>"
    },
    "name": "find_bill_to_pays"
  }
}

Input Schema

NameRequiredDescriptionDefault
due_dateNoThe date on which payment is due.
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`.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
ap_account_refNoRefers to an accounts payable account in the QuickBooks file. (The AccountType of this account will be AccountsPayable.)
currency_filterNoFilters by the specified currency.
payee_entity_refYes`payee_entity_ref` identifies the payee (customer, vendor, employee, or Other Name). If both `full_name` and `list_id` are provided, `full_name` is ignored.
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.8/5.0
Behavior4/5

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

Annotations already cover safety (readOnly, idempotent, non-destructive), yet the description adds genuinely useful behavior: this is an asynchronous pattern that returns a v2 request plus the webhook payload shape in response_json, not the QuickBooks data directly. It also enumerates the concrete error codes and types an agent must handle, which is real operational context beyond the annotations.

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?

The first sentence front-loads what is queried and the second covers the async return contract efficiently. The trailing error-code list is long but each entry carries a code and human-readable type, so it is dense rather than wasteful; still, it dominates the tail of the description.

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?

An output schema exists, so return-value detail is not required, and the description still flags the webhook/response_json contract. Combined with error handling guidance and the pointer to downstream payment tools, an agent has what it needs for this 8-parameter, nested-schema query.

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 88%, so the parameters are already well documented in the input schema, including the payee reference, meta_data enum, currency_filter, and include_ret_element. The description adds no parameter-level meaning of its own, so the baseline 3 applies.

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 names the underlying operation (BillToPayQuery) and the resource precisely: open bills and credits. It also states the follow-on purpose (feeding BillPaymentCheck / BillPaymentCreditCard requests). It does not distinguish this from close siblings like find_bills or find_bill_payment_checks, so it falls short of a 5.

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?

There is downstream-usage context ('use this information in subsequent BillPaymentCheck and BillPaymentCreditCard requests'), which implies when the data is needed. However, there is no explicit when-to-use-this-vs-another-query guidance and no statement of prerequisites (e.g., the payee requirement), leaving selection between find_bill_to_pays and find_bills/find_bill_payment_checks to inference.

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