Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create sales rep

create_sales_rep
Read-onlyIdempotent

Adds a sales rep. The sales representative must be on the Employee, Vendor, or Other Names list within QuickBooks. Sales representative’s names and initials appear on the Rep drop-down list on QuickBooks sales forms. A SalesRepRef refers to a person on the SalesRep list. In a request, if a SalesRepRef aggregate includes both full_name and list_id, full_name will be ignored.

The sales_rep_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, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 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": {
      "initial": "<initial>",
      "sales_rep_entity_ref": "<sales_rep_entity_ref>"
    },
    "name": "create_sales_rep"
  }
}

Input Schema

NameRequiredDescriptionDefault
initialYesThe initials of a sales representative’s name.
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
sales_rep_entity_refYesRefers to the sales representative’s full information on the Employee, Vendor, or OtherName list.

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.6/5.0
Behavior4/5

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

Annotations already declare readOnly/non-destructive/idempotent, and the description adds real context beyond them: it explains that the call compiles a v2 request plus the webhook payload that will carry QuickBooks' answer, that a qbXML `sales_rep_add` wrapper is also accepted, and it enumerates the error codes and types to handle. The phrase "Adds a sales rep" sits in mild tension with readOnlyHint, but the explicit "Returns the v2 request to send" makes clear the tool does not itself mutate, so it is not a contradiction.

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 core requirement and the request/webhook model are front-loaded, but the middle paragraph is QuickBooks UI filler ("names and initials appear on the Rep drop-down list on QuickBooks sales forms") and the paragraph-long list of 24 error codes is dense without explaining which ones an agent should branch on. Several sentences do not earn their place.

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 nested-object create-and-compile tool with an output schema present, the definition covers the prerequisite, the request/webhook round-trip, ref resolution precedence, and the failure surface, so an agent knows what to expect back. The missing piece is sequencing guidance — what to do with the returned v2 request and how to correlate the webhook answer.

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 83%, so the schema already documents `initial`, `is_active`, `request_id`, `include_qbxml`, and the `sales_rep_entity_ref` sub-fields, including the list_id-over-full_name precedence. The description only reinforces the SalesRepRef meaning and the full_name/list_id rule, adding little beyond the structured fields; 3 is the baseline.

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 opening verb+resource ("Adds a sales rep") is specific and, combined with the SalesRepRef explanation and the prerequisite that the rep must already exist on the Employee, Vendor, or Other Names list, an agent can tell this apart from update_sales_rep and find_sales_reps. It falls short of 5 because the description never names a sibling or explicitly contrasts create-vs-update-vs-find.

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?

The strongest guidance is a prerequisite ("must be on the Employee, Vendor, or Other Names list within QuickBooks"), which is genuinely useful gating information. However, there is no statement of when to choose this over update_sales_rep or find_sales_reps, and no note on the two-stage request/webhook flow an agent must follow, leaving usage only implied.

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