Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create customer msg

create_customer_msg
Read-onlyIdempotent

Builds a v2 customer_msg.create request.

The customer_msg_add wrapper from qbXML is also accepted. 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, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 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, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account

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

Input Schema

NameRequiredDescriptionDefault
nameYesName is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope.
is_activeNoIf `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
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.
include_ret_elementNo

Output Schema

NameRequiredDescriptionDefault
urlYesReplace {connection_id} with the customer's connection.
bodyYesThe JSON body: the arguments you passed.
qbxmlNoThe qbXML it compiles to. Only with include_qbxml.
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.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, and the description explains why by framing the tool as a builder that returns a request plus the webhook payload rather than mutating data. It additionally enumerates the error codes/types the call can surface, which is context the annotations cannot convey; it stops short of saying where the compiled request must be sent.

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 core behavior is front-loaded in the first two sentences, with the error catalog placed last where it can be skimmed. The long comma-separated error list is bulky but is structured data an agent can parse, not filler prose.

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?

Given an output schema and annotations covering the safety profile, the description supplies the remaining operational context: the two-part request/webhook flow and the error taxonomy. Only the missing instruction on disposal of the returned request (where to send it) keeps this from being complete.

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 80%, so `name`, `is_active`, `request_id`, `include_qbxml`, and `include_ret_element` are already documented in the schema. The description adds no parameter-level meaning beyond that, which is acceptable at this coverage level but is not additive.

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 description states a specific verb and resource ('Builds a v2 customer_msg.create request') and makes the crucial distinction that this compiles a request rather than performing the write, which separates it from a plain create_customer-style sibling. It also names the qbXML `customer_msg_add` alias, so an agent mapping from legacy terminology can identify it.

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?

Usage is only implied: the agent can infer this is the request-builder step preceding a webhook answer, and that the qbXML wrapper is an accepted alternate input form. There is no explicit statement of when to choose this over create_customer or find_customer_msgs, and no stated prerequisites for the downstream send.

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