Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create unit of measure set

create_unit_of_measure_set
Read-onlyIdempotent

Requires the company to be enabled for unit of measure (UOM), either a single unit of measure per item, or multiple units of measure. However, in order to support both single or multiple units per item of measure enablement, you must prefix all UOM set names with “By the”, for example, “By the Barrel”. Otherwise, the UOM set won’t show up in the QuickBooks UI in single UOM per item mode.

The unit_of_measure_set_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": {
      "base_unit": "<base_unit>",
      "name": "<name>",
      "unit_of_measure_type": "<unit_of_measure_type>"
    },
    "name": "create_unit_of_measure_set"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesName is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope.
base_unitYes
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`.
default_unitNo
related_unitNo
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
include_ret_elementNo
unit_of_measure_typeYesThe type of the unit of measure.

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

B3.2/5.0
Behavior4/5

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

The annotations already declare the read-only, idempotent, non-destructive, closed-world profile, and the description clarifies the seemingly surprising mismatch with the 'create' name by explaining it returns the v2 request to send plus the webhook payload the answer arrives in. It also enumerates the concrete error codes/types an agent must handle and states the call result explains each. This is meaningful behavior beyond what annotations convey, though the request-then-webhook flow could be described more explicitly.

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 first paragraph is convoluted and hard to parse ('in order to support both single or multiple units per item of measure enablement'), and the seventeen-item error enumeration occupies a large share of the text without prioritization. The prefix requirement, the single most important instruction, is buried mid-sentence rather than front-loaded. It is not padded with fluff, but the structure does not help rapid scanning.

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?

An output schema exists, so return-shape explanation is rightly minimal, and the error list and UOM-enablement prerequisite are appropriate for this complexity. What is missing is an explicit statement of the operation itself and any hint about idempotency/duplicate behavior relative to `find_unit_of_measure_sets`. Adequate but not complete for a nested, nine-parameter mutating-in-spirit tool.

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?

With 56% schema coverage and nine parameters including nested base_unit/default_unit/related_unit, the description adds only the naming-prefix rule that constrains `name`, plus the note that `unit_of_measure_set_add` fields are accepted. It does not explain the base-unit vs related-unit conversion semantics, how `default_unit` interacts with `unit_used_for`, or `include_ret_element`. The useful prefix rule is real added value, but most parameter meaning still comes from the schema.

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

Purpose3/5

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

The description never states plainly that it creates a UOM set with a name, base unit, related units and default units; purpose is only inferable from the title, from the phrase 'the UOM set won't show up in the QuickBooks UI', and from the remark that the qbXML `unit_of_measure_set_add` wrapper is accepted. The opening sentence is spent entirely on preconditions rather than the action. An agent can guess the intent, but it is not spelled out as a verb+resource statement.

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?

It gives a real prerequisite (the company must be UOM-enabled, single or multi-unit mode) and a hard naming rule (prefix names with 'By the' for single-UOM mode), which is genuinely actionable. However, it offers no routing guidance relative to the sibling `find_unit_of_measure_sets`, and no guidance on duplicate handling beyond the `3100 name_in_use` code appearing in a list. Usage is implied rather than explicitly framed.

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