Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update currency

update_currency
Read-onlyIdempotent

This request is used primarily for changing the is_active status of the built-in QuickBooks currencies. However, it can also be used to modify anything in user-defined currencies. When used on a built-in currency, this request can’t modify name or currency code, neither of which can be modified in the UI either.

The currency_mod 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, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 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

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": {
      "edit_sequence": "<edit_sequence>",
      "list_id": "<list_id>"
    },
    "name": "update_currency"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoName is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope.
list_idYesQuickBooks' ID for the record. Used over `full_name` when both are sent.
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_codeNoFor built-in currencies, the currency code and name is the generally accepted code and name. These are based on the standard ISO 4217 code/name for a country’s currency.
edit_sequenceYes`edit_sequence` is a server-generated revision token. It changes each time the object is updated. To modify an existing object, you must send the current `edit_sequence`.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
currency_formatNoThe aggregate controlling the appearance of the currency with regard to comma and decimal.
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

B3.4/5.0
Behavior2/5

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

The annotations declare readOnlyHint=true and destructiveHint=false, yet the description's leading sentence frames this as a tool 'used primarily for changing the is_active status' of currencies. Only deep in the second paragraph does it hint at the read-only reality ('Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in'), and it never plainly says the tool performs no mutation itself. An agent could easily believe the update already happened, which is the opposite of what the annotations promise.

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 is front-loaded in the first sentence, which is the right structure, but the second paragraph mixes the request/response mechanism with a long enumerated error-code dump that consumes most of the text. The bundled error list ('the call result explains each') is reference material rather than selection guidance and crowds out the mutation semantics.

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 and the description correctly explains the response_json/webhook shape, and the error taxonomy is thorough, so return-value coverage is adequate. What is missing is the critical framing: whether this tool mutates anything, whether the returned request must be sent elsewhere, and any permission prerequisites behind 3260/3263 — gaps that matter for a 9-parameter mutation-shaped tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is high (89%), so the baseline is 3, but the description adds genuine semantics on top: name and currency code are immutable for built-in currencies while user-defined currencies can be modified more freely, which tells the agent which parameters are actually usable in which case. It does not clarify `edit_sequence` concurrency behavior (the schema covers that), so it is not a 5.

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 a specific verb and resource pair (changing the `is_active` status of built-in currencies, modifying user-defined currencies) and carves out what cannot change on built-ins (name, currency code). That is concrete enough to distinguish it from `create_currency`, though the second paragraph drifts into qbXML/wrapper mechanics that dilute the core statement.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives real usage conditions: the primary use is toggling `is_active`, it is the appropriate tool for user-defined currencies generally, and it is explicitly limited when the target is a built-in currency. No sibling tool is named as an alternative (e.g. `create_currency`), so the routing guidance stops short of a 5.

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