Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update build assembly

update_build_assembly
Read-onlyIdempotent

Modifies an existing build assembly transaction in the QuickBooks company.

The build_assembly_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, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_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>",
      "txn_id": "<txn_id>"
    },
    "name": "update_build_assembly"
  }
}

Input Schema

NameRequiredDescriptionDefault
memoNoAdditional information.
txn_idYes`txn_id` is the unique QuickBooks identifier for a transaction. Use it to reference that transaction in later requests.
txn_dateNoThe date of the transaction. In some cases, if you leave `txn_date` out of an -Add message, QuickBooks will prefill `txn_date` with the date of the last-saved transaction of the same type.
lot_numberNoThe lot number of the asset. Choose at most one of: `serial_number`, or `lot_number`.
ref_numberNo`ref_number` is a user-managed transaction reference (for example, a check number). It can be edited and is not guaranteed to be globally unique.
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`.
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.
serial_numberNoThe serial number of the asset. Choose at most one of: `serial_number`, or `lot_number`.
remove_pendingNoChanges the transaction’s pending status from Pending to non pending. In BuildAssembly transactions, this effectively does the build transaction.
quantity_to_buildNoSpecifies the number of assemblies to be built. The transaction will fail if the number specified here exceeds the number of on-hand components.
inventory_site_refNoSite where inventory is located.
include_ret_elementNo
mark_pending_if_requiredNoAllows the build assembly to be marked pending if there are insufficient quantities to complete the build assembly.
inventory_site_location_refNoLocation within the Inventory Site

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

C2.9/5.0
Behavior1/5

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

The description explicitly says the tool 'Modifies an existing build assembly transaction', while the annotations declare readOnlyHint=true, destructiveHint=false and idempotentHint=true. A mutation described as a read-only, idempotent operation is a direct contradiction that could cause an agent to call it without expecting state change. The otherwise useful disclosure of the two-step request/webhook flow and the error catalog cannot offset that conflict.

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?

It is front-loaded with the purpose, then the wrapper/return behavior, then errors, which is a sensible order. The 30-entry error code list is bulky but each entry is a compact code/name pair, so it earns its space as machine-usable error handling data.

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 15-parameter mutation with an output schema and 93% schema coverage, the description covers purpose, the qbXML alias, what is returned (v2 request plus webhook payload), and error handling. It omits any note about concurrency semantics of edit_sequence and about which fields are actually mutable, but those gaps are partly covered by the schema.

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 93%, so nearly every parameter already carries its own explanation (edit_sequence, txn_id, serial_number vs lot_number, remove_pending, mark_pending_if_required). The description adds only the qbXML wrapper alias `build_assembly_mod`, which is naming rather than parameter meaning, so baseline 3 applies.

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?

States a specific verb and resource: 'Modifies an existing build assembly transaction in the QuickBooks company.' That distinguishes it from create_build_assembly by the word 'existing', but no sibling is named explicitly and the scope of what can be modified is left to the schema.

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

Usage Guidelines2/5

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

There is no when-to-use guidance, no mention of when to prefer update over create or over the item-level siblings, and no stated prerequisites. The requirement for a current edit_sequence exists only in the schema, not in the description, so an agent gets no routing or sequencing advice from the text.

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