Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update purchase order

update_purchase_order
Read-onlyIdempotent

Some fields in a PurchaseOrderMod request can’t be cleared. If any of the following fields is included in a purchase order modify request, it must contain a value:

The purchase_order_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_purchase_order"
  }
}

Input Schema

NameRequiredDescriptionDefault
fobNoQuickBooks uses the term FOB, “freight on board,” to indicate the place from which the product is shipped. The FOB has no accounting implications.
memoNoThis can be included in reports, but it doesn’t appear on the printed purchase order.
other1NoOther, Other1, and Other2 are built-in transaction custom fields. Other is transaction-level; Other1 and Other2 are line-level.
other2NoOther, Other1, and Other2 are built-in transaction custom fields. Other is transaction-level; Other1 and Other2 are line-level.
txn_idYes`txn_id` is the unique QuickBooks identifier for a transaction. Use it to reference that transaction in later requests.
due_dateNoThe date on which payment is due.
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.
class_refNoUse classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks.
terms_refNoRefers to the payment terms associated with this entity. (This will be an item on the DateDrivenTerms or StandardTerms list.)
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_msgNoMessage to be printed on a purchase order for the vendor to read.
vendor_refNoA 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.)
ship_addressNoThis aggregate supports at most five address lines. You can provide a structured address (Addr1-Addr3 plus City/State/`postal_code`/etc.) or use block mode (Addr1-Addr5 only).
template_refNoQuickBooks templates specify how to print certain transactions. A template query returns the names of all templates that have been defined in QuickBooks.
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`.
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.
expected_dateNoThe date on which shipment is expected.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
vendor_addressNoIf an address request fails, some combination of address fields might be too long.
is_tax_includedNoFor future use with international versions of QuickBooks.
ship_method_refNoA shipping method, for example, standard mail or overnight delivery. A `ship_method_ref` aggregate refers to an item on the ShipMethod list.
is_to_be_emailedNoWhen enabled, QuickBooks validates the customer email at runtime before sending. If no valid email is available, the request fails.
is_to_be_printedNoIf `is_to_be_printed` is true, QuickBooks queues the form for later printing. It does not print immediately; printing is still a user action in QuickBooks.
inventory_site_refNoSite where inventory is located. Choose at most one of: `inventory_site_ref`, or `ship_to_entity_ref`.
is_manually_closedNoIf `is_manually_closed` is true, this purchase order has been closed, even if all the items haven’t been received or the sale hasn’t been cancelled.
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.
ship_to_entity_refNoRefers to a customer, vendor, employee, or person on the “other names” list to whom this order is to be shipped. Choose at most one of: `inventory_site_ref`, or `ship_to_entity_ref`.
include_ret_elementNo
purchase_order_line_modNoOne line of the purchase order. Compare with PurchaseOrderLineGroup, which represents a previously defined group of lines in the purchase order. `purchase_order_line_mod` and `purchase_order_line_group_mod` combine: any number of each. QuickBooks receives them in that order: every `purchase_order_line_mod`, then every `purchase_order_line_group_mod`.
purchase_order_line_group_modNoRepresents a previously defined group of lines in the purchase order. Compare with PurchaseOrderLine, which represents just one line in the purchase order. `purchase_order_line_mod` and `purchase_order_line_group_mod` combine: any number of each. QuickBooks receives them in that order: every `purchase_order_line_mod`, then every `purchase_order_line_group_mod`.

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
Behavior4/5

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

Annotations already declare read-only, non-destructive, idempotent, closed-world, and the description complements them by explaining that the call returns the v2 request plus the webhook payload that carries QuickBooks' answer, and that include_qbxml adds the compiled qbXML for debugging. The enumerated error codes/types (stale_edit_sequence, closing_date_modify, cannot_modify, not_authorized, etc.) are above-and-beyond behavioral disclosure. The only weakness is that the crucial 'this does not apply the change itself' point is stated obliquely and the promised list of must-have-value fields is missing.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The text opens with an edge-case fragment ('Some fields... can't be cleared') followed by a colon that introduces nothing, so the most prominent sentence is broken and not front-loaded with purpose. The error-code catalogue is dense and earns its space, but the missing list and the ordering make the whole read disorganized.

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?

For a 31-parameter mutation-adjacent tool, the definition covers failure modes and the response path well, and an output schema plus annotations reduce the burden. However, it omits the promised immutable-field list, says nothing about permission or locking prerequisites, and never states when a caller should prefer this over the create/sales-order siblings.

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 97%, so the schema does nearly all the parameter work and a baseline 3 is warranted. The description adds little beyond noting that the qbXML purchase_order_mod wrapper is also accepted, and it gestures at fields that cannot be cleared without naming them. The dangling 'following fields' sentence actively fails to deliver the one piece of parameter meaning it promised.

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

Purpose3/5

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

The description never plainly states 'modify an existing purchase order'; the verb is only implied via 'purchase order modify request' and 'PurchaseOrderMod'. It obliquely reveals that the tool compiles a request ('Returns the v2 request to send, and the webhook payload'), which is genuinely distinguishing, but the leading sentence about uncleareable fields is a fragment and gives no resource-level purpose. Nothing tells the agent how this differs from create_purchase_order or update_sales_order.

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 prerequisites like holding a current edit_sequence (only the schema says so), and no exclusions against sibling update tools. The only guidance-like content is the error taxonomy, which tells the agent what can go wrong rather than when to pick this tool.

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