Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create transfer inventory

create_transfer_inventory
Read-onlyIdempotent

Builds a v2 transfer_inventory.create request.

The transfer_inventory_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": {
      "from_inventory_site_ref": "<from_inventory_site_ref>",
      "to_inventory_site_ref": "<to_inventory_site_ref>"
    },
    "name": "create_transfer_inventory"
  }
}

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 `txn_line_id` so later requests can reference it with `useMacro`. This feature requires SDK 2.0+.
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.
include_ret_elementNo
to_inventory_site_refYesInventory site that transfer will be sent to.
from_inventory_site_refYesInventory site that transfer will be taken from.
transfer_inventory_line_addNo

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?

The description does real work beyond the annotations: it discloses that the output is a request to send plus a webhook payload shape (response_json), which explains why readOnlyHint=true and destructiveHint=false hold for a tool named 'create'. The enumerated error codes also signal permission, locking, and feature-flag failure modes. It stops short of saying what causes 3260/3261 or what to do on retry, but the annotations already carry the safety profile.

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 a short first sentence, but the remainder is dominated by a 20-plus item error-code dump that the text itself says 'the call result explains each', making it largely self-declared redundancy. The sentence about the webhook payload is dense and parenthetical, weakening scannability.

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 an 11-parameter, nested-object request builder whose annotations cover safety and which has an output schema, the definition covers the essentials: what is produced, how the answer arrives, and the failure taxonomy. The one gap an agent still needs is the relationship to the sibling update/find tools and any precondition on inventory site existence.

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 82%, so the schema already documents nearly everything, including nested ref objects and the serial_number/lot_number mutual exclusion. The description adds nothing about parameter meaning, defaults, or which two refs are required, so the 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?

The description names a specific verb and resource ('Builds a v2 transfer_inventory.create request') and even clarifies a non-obvious mechanic: the tool compiles a request rather than executing the transfer. It doesn't name sibling tools, so an agent must infer that update_transfer_inventory is the mutation counterpart, but the create-vs-update distinction is readable from the name plus description.

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?

Usage is only implied. The note that 'The transfer_inventory_add wrapper from qbXML is also accepted' is a useful input-form hint, but there is no statement of when to choose this over update_transfer_inventory, find_transfer_inventories, or create_inventory_adjustment, and no stated prerequisites (e.g., inventory sites and items must already exist).

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