Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create purchase order

create_purchase_order
Read-onlyIdempotent

Adds a purchase order, which is an order submitted to a vendor. You can use ItemReceiptAdd to receive items against a purchase order as items arrive from the vendor. A purchase order is a non-posting transaction, so it doesn’t affect a company’s balance sheet or income statement.

The purchase_order_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

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "create_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.
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.
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+.
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.
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.
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.
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`.
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_addNoOne line of the purchase order. Compare with PurchaseOrderLineGroup, which represents a previously defined group of lines in the purchase order. At least one entry is required across `purchase_order_line_add` and `purchase_order_line_group_add`; they combine, any number of each. QuickBooks receives them in that order: every `purchase_order_line_add`, then every `purchase_order_line_group_add`.
purchase_order_line_group_addNoRepresents a previously defined group of lines in the purchase order. Compare with PurchaseOrderLine, which represents just one line in the purchase order. At least one entry is required across `purchase_order_line_add` and `purchase_order_line_group_add`; they combine, any number of each. QuickBooks receives them in that order: every `purchase_order_line_add`, then every `purchase_order_line_group_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

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the bar is lower; the description still adds meaningful context by explaining that this compiles a v2 request plus the webhook payload that carries QuickBooks' answer, that 'purchase_order_add' qbXML is accepted, that a purchase order is a non-posting transaction, and by enumerating likely error codes. The 'Adds a purchase order' phrasing reads at first like a write while annotations say readOnlyHint=true, but the later sentence clarifying that it returns a request to send resolves that tension rather than contradicting it.

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?

Three short paragraphs, front-loaded with what the tool does, then response shape, then errors; nothing is buried. The 24-code error list is long for the space it takes, especially since the description says the call result explains each, but it is scannable and arguably earns its place for pre-call validation.

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 30-parameter tool with an output schema present, the description covers purpose, response mechanics (v2 request plus webhook payload), the qbXML alias, and error taxonomy. The main gap is prerequisites: with zero required top-level parameters but a schema rule that at least one line entry is needed, the description could have warned that a vendor and at least one line are effectively mandatory.

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% across 30 parameters, so the schema already carries essentially all field meaning (fob, memo, terms_ref, ship_address, line add/group arrays). The description adds only the alias note about the qbXML 'purchase_order_add' wrapper and no per-field guidance, 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?

The opening sentence gives a specific verb and resource ('Adds a purchase order') and defines the object ('an order submitted to a vendor'), which distinguishes it semantically from sales-order creation. It also notes the related ItemReceiptAdd operation. It never names the sibling create_sales_order/update_purchase_order boundary explicitly, so it falls short of a 5.

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 implied by the verb plus one concrete workflow pointer ('use ItemReceiptAdd to receive items against a purchase order as items arrive'). There is no explicit when-not-to-use, no statement of prerequisites, and nothing about when to choose update_purchase_order over 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