Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create build assembly

create_build_assembly
Read-onlyIdempotent

Adds a build assembly transaction to QuickBooks, where the specified quantity of the specified inventory assembly item is built. If there are insufficient quantities of items required for the build, you can have the build marked as a pending build by using setting mark_pending_if_required to True. (If you don’t and theren’t enough quantities on hand for the build, this request will fail.) If successful, this request results in the decrementing of the quantities on hand amounts of each item used in the build, and the incrementing of the on hand quantities of the built assembly item.

The build_assembly_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": {
      "item_inventory_assembly_ref": "<item_inventory_assembly_ref>",
      "quantity_to_build": "<quantity_to_build>"
    },
    "name": "create_build_assembly"
  }
}

Input Schema

NameRequiredDescriptionDefault
memoNoAdditional information.
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.
def_macroNo`def_macro` lets you assign a reusable name to a returned `txn_id` or TxnLineID so later requests can reference it with `useMacro`. This feature requires SDK 2.0+.
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`.
external_guidNoAllows for the attachment of a user defined GUID value.
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`.
quantity_to_buildYesSpecifies 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
item_inventory_assembly_refYesAn inventory assembly item is one that is assembled or manufactured from inventory items. The items and/or assemblies that make up the assembly are called components.

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.1/5.0
Behavior1/5

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

The description states this creates a transaction and decrements on-hand quantities of every component while incrementing the built assembly's quantity, which is a state-mutating write. The annotations declare `readOnlyHint: true` and `idempotentHint: true`, which the described inventory-mutating behavior directly contradicts.

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 front-loaded, specific, and earns its place, but the twenty-code error enumeration and the boilerplate wrapper sentence add bulk without helping the agent call the tool. There is also a typo ('theren’t'), which weakens polish.

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 nested refs and an output schema, the description covers the build mechanics, the failure condition, the pending flag, and the asynchronous webhook response path. Missing only an explicit note on which sibling to use for edits and the status codes to handle, which it merely references.

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 already 93%, yet the description adds real meaning: it explains the consequence of `quantity_to_build` exceeding on-hand components and the effect of `mark_pending_if_required`, and it notes the `build_assembly_add` qbXML wrapper alias. It does not clarify the serial/lot mutual exclusion or txn_date prefill behavior beyond the schema.

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 opens with a precise verb and resource: it adds a build assembly transaction to QuickBooks and builds a specified quantity of a specified inventory assembly item. The effect is unambiguous, though it never names create vs. update vs. find siblings to route the agent 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 conditional rule for `mark_pending_if_required` and warns that the request fails when on-hand components are insufficient, which is genuine usage guidance. However, there is no statement of when to choose this over `update_build_assembly` or `find_build_assemblies`, so tool selection is only implied by the create/update naming.

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