Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create item receipt

create_item_receipt
Read-onlyIdempotent

Adds an item receipt transaction, which is a transaction entered in QuickBooks when a shipment is received from a vendor. If you use PurchaseOrders to order from the vendor, you can link the item receipt to purchase order to receive the items against the purchase orders to automatically update (and eventually close) the purchase orders. This linking also saves you having to re-create line items as they are pulled in automatically from the purchase order. You can do this linking only in the item receipt add, not in the mod.

The item_receipt_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": {
      "vendor_ref": "<vendor_ref>"
    },
    "name": "create_item_receipt"
  }
}

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`.
vendor_refYesA vendor is any person or company from whom a small business owner buys goods and services. (Banks and tax agencies usually are included on the vendor list.)
exchange_rateNo`exchange_rate` is the rate from this currency to the company’s home currency at AsOfDate. You can supply a rate when adding transactions, but QuickBooks does not provide rates through the SDK.
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.
item_line_addNoAn ItemLine is used to track any portion of a transaction that represents the purchase of an “item.” `item_line_add` and `item_group_line_add` combine: any number of each. QuickBooks receives them in that order: every `item_line_add`, then every `item_group_line_add`.
ap_account_refNoRefers to an accounts payable account in the QuickBooks file. (The AccountType of this account will be AccountsPayable.)
link_to_txn_idNo
is_tax_includedNoFor future use with international versions of QuickBooks.
expense_line_addNo
sales_tax_code_refNo`sales_tax_code_ref` points to the sales-tax code used for an item or customer context. QuickBooks includes default TAX and NON codes, and a code can be deleted only when nothing references it.
include_ret_elementNo
item_group_line_addNoRefers to items that are grouped together in QuickBooks for fast entry. `item_line_add` and `item_group_line_add` combine: any number of each. QuickBooks receives them in that order: every `item_line_add`, then every `item_group_line_add`.

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

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

The description describes a write operation that creates a new transaction ('Adds an item receipt transaction'), while annotations declare readOnlyHint=true and destructiveHint=false. This directly contradicts the safety profile an agent relies on to decide whether to call the tool, so the transparency score is capped at 1 regardless of the otherwise useful context about the returned v2 request and webhook payload.

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 and the PO-linking behavior follows logically. However, the second half is a wall of roughly twenty enumerated error codes that the description itself says 'the call result explains each', plus verbose asides like saving the user from re-creating line items, which dilute the structure.

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?

The tool is complex (17 parameters, nested objects) but an output schema exists and schema coverage is high, so much of the burden is already handled. The description covers what the operation does, its return shape, and error handling, but leaves the misleading read-only annotation unresolved and does not explain required reference resolution for vendor_ref.

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%, above the 80% threshold, so the schema already carries most parameter meaning and the baseline is 3. The description adds some semantic linkage, explaining that line items are pulled automatically from the linked purchase order, which is relevant to link_to_txn_id and item_line_add, but it does not clarify required versus optional fields or the interaction between the two line arrays.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Adds an item receipt transaction') and then defines the QuickBooks concept for an agent that may not know it: a transaction entered when a shipment is received from a vendor. It also distinguishes itself from the update path by noting the purchase-order linking is available 'only in the item receipt add, not in the mod', which separates it from update_item_receipt.

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?

Gives clear situational context: use this when receiving a shipment from a vendor, and optionally when receiving against existing PurchaseOrders to auto-update and close them. It explicitly flags a when-not ('not in the mod'), but never names a sibling tool or states prerequisites such as needing the PO to exist first.

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