Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create price level

create_price_level
Read-onlyIdempotent

Adds a price level. You can use price levels to specify custom pricing for specific customers. Once you create a price level for a customer, QuickBooks will automatically use the custom price in new invoices, sales receipts, sales orders or credit memos for that customer. You can override this automatic feature, however, when you create the invoices, sales receipts, etc.)

The price_level_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, 3100 name_in_use, 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": {
      "name": "<name>"
    },
    "name": "create_price_level"
  }
}

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`.
currency_refNoA currency record defines how QuickBooks stores and displays a currency. Built-in currency name/code values are fixed; formatting and active status can vary by settings and workflow. Choose exactly one of: `price_level_fixed_percentage`, or the set (`currency_ref`, `price_level_per_item`). 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.
include_ret_elementNo
price_level_per_itemNoChoose exactly one of: `price_level_fixed_percentage`, or the set (`currency_ref`, `price_level_per_item`). Members of a set combine with each other, not with the other choices.
price_level_fixed_percentageNoWhen you create a price level, you must specify whether it is a fixed percentage or a per item price level. Once you create the price level, you can’t change this. Choose exactly one of: `price_level_fixed_percentage`, or the set (`currency_ref`, `price_level_per_item`). Members of a set combine with each other, not with the other choices.

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 the safety profile (readOnlyHint=true, destructiveHint=false, idempotentHint=true), and the description reconciles this by explaining the tool returns "the v2 request to send, and the webhook payload" rather than persisting the record itself — valuable clarification an agent would otherwise miss. It also accepts the qbXML alias price_level_add and catalogues possible error codes, though it omits permission/auth requirements and rate behavior.

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 purpose and mechanics are front-loaded in the first two sentences, but roughly half the text is a ~30-entry error-code catalogue that the description itself says "the call result explains," making it largely redundant bulk. There is also a stray unmatched parenthesis after "sales receipts, etc." that suggests unedited source text.

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 complex 8-parameter nested-schema create tool, the description covers the essential surprises: the request-builder pattern, the webhook response channel, the qbXML alias, and the immutability rule. An output schema exists so return values need no explanation, and the only real gap is the absence of prerequisites or validation rules for the exclusive pricing options.

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 schema already documents nearly every parameter, including the mutually exclusive pricing shapes. The description adds little parameter-level detail beyond noting the fixed-percentage-vs-per-item choice is immutable after creation; it says nothing about name uniqueness or the optional debugging fields.

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 sentence names a specific verb and resource ("Adds a price level") and immediately explains the business concept — custom pricing for specific customers applied automatically to invoices, sales receipts, sales orders and credit memos. It is clearly a create operation distinct from update_price_level/find_price_levels by the verb alone, though no sibling is named explicitly.

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 clear use case (per-customer custom pricing) and notes the automatic application can be overridden downstream, which is genuinely useful context. However, it never states prerequisites (feature enablement, permissions) or when to prefer this tool over update_price_level, and the guidance is implied rather than explicit.

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