Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create invoice

create_invoice
Read-onlyIdempotent

Adds an invoice: what a customer owes for a sale they didn't pay in full when it was made (a sale paid in full is a sales receipt). customer_ref is required. Each line in invoice_line_add names an item_ref and two of quantity, rate and amount; QuickBooks works out the third. An inventory item on an invoice lowers stock and posts its cost of goods sold. To invoice a sales order, link it with link_to_txn_id. The add_transaction workflow template finds the customer and items first and creates any that are missing.

The invoice_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": {
      "customer_ref": "<customer_ref>"
    },
    "name": "create_invoice"
  }
}

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.
memoNoMessage that appears in reports, but not on the invoice.
otherNoOther, Other1, and Other2 are built-in transaction custom fields. Other is transaction-level; Other1 and Other2 are line-level.
due_dateNoIf `due_date` isn’t included in an InvoiceAdd request, QuickBooks might determine the due date according to the terms set for this customer.
txn_dateNoThe date of the invoice. If you leave `txn_date` out of an InvoiceAdd message, QuickBooks might prefill it with the date of the invoice that was most recently saved.
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+.
po_numberNoPurchase order number.
ship_dateNoThe date when the product was, or will be, shipped.
terms_refNoRefers to the payment terms associated with this entity. (This will be an item on the DateDrivenTerms or StandardTerms list.)
is_pendingNoIf `is_pending` is set to true, the invoice hasn’t been completed. Pending sales might include unpaid orders, estimates, tracked hours that haven’t yet been billed, or sales of back-ordered items.
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`.
set_creditNo
bill_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).
customer_refYes`customer_ref` identifies a customer or customer job. If both `full_name` and `list_id` are provided, `full_name` is ignored. In SalesReceipt and ReceivePayment, it identifies who receives credit.
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.
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.
sales_rep_refNoA sales representative must be on the Employee, Vendor, or Other Names list within QuickBooks. Sales representative’s names and initials appear on the Rep drop-down list on QuickBooks sales forms.
ar_account_refNo`ar_account_ref` points to an Accounts Receivable account. If both `full_name` and `list_id` are provided, `full_name` is ignored.
link_to_txn_idNo
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.
customer_msg_refNoA standard message such as “Thank you for your business,” or “Please sign and return this estimate to indicate your approval.” A customer message can be included at the bottom of a form.
invoice_line_addNoRepresents one line in the invoice. Compare with InvoiceLineGroup, which represents a previously defined group of lines in the invoice. `invoice_line_add` and `invoice_line_group_add` combine: any number of each. QuickBooks receives them in that order: every `invoice_line_add`, then every `invoice_line_group_add`.
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.
discount_line_addNo
is_finance_chargeNoIf `is_finance_charge` is true, a finance-charge item has been added to the invoice.
shipping_line_addNo
item_sales_tax_refNoAn ItemSalesTax entry represents one tax rate paid to one tax agency. Use it when a transaction needs a single tax calculation. For multi-rate scenarios, use a sales-tax group instead.
sales_tax_line_addNo
include_ret_elementNo
invoice_line_group_addNoRepresents a previously defined group of lines in the invoice. Compare with InvoiceLine, which represents just one line in the invoice. `invoice_line_add` and `invoice_line_group_add` combine: any number of each. QuickBooks receives them in that order: every `invoice_line_add`, then every `invoice_line_group_add`.
customer_sales_tax_code_refNoRefers to the sales-tax code for sales related to this customer. (That is, it refers to a member of the SalesTaxCode list.)

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

A4.5/5.0
Behavior5/5

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

The description resolves the tension between "Adds an invoice" and readOnlyHint=true by explaining the tool returns a compiled v2 request plus the webhook payload the answer arrives in — i.e., deferred execution, not direct mutation. Beyond that it discloses side effects the annotations cannot (an inventory item lowers stock and posts COGS, `is_to_be_emailed` fails at runtime on an invalid email), and enumerates the full error taxonomy with codes and types.

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?

It is front-loaded with the definition, then the key parameter rules, then return shape, then errors — a sensible order for a complex create tool. The ~20-entry error-code list is the weakest part: it is dense but each entry is short and directly actionable for error handling, so it earns most of its space.

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 38-parameter nested tool this is well covered: an output schema exists and the description still characterizes the return (request + webhook payload) and failure modes. Minor gaps remain around currency, address aggregates, and which line fields interact, but nothing an agent must know to invoke it correctly is missing.

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 high (84%), so the baseline is 3, but the description adds genuinely useful rules the schema does not surface prominently: `customer_ref` is required, each line in `invoice_line_add` needs an `item_ref` plus two of `quantity`/`rate`/`amount` with QuickBooks deriving the third, and the legacy `invoice_add` qbXML wrapper is also accepted. With 38 parameters, some aggregates still rely entirely on schema text.

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?

"Adds an invoice" is a specific verb+resource, and the description immediately bounds the concept ("what a customer owes for a sale they didn't pay in full") while naming the sibling concept it is not — a sales receipt. An agent can distinguish this from create_estimate, create_credit_memo, or a sales receipt without inspecting any schema.

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?

It gives concrete routing conditions: use this when the sale wasn't paid in full, link a sales order via `link_to_txn_id`, and use the `add_transaction` workflow template when the customer or items don't yet exist. That is real when-to-use guidance rather than implication. It stops short of stating when to prefer `update_invoice` for existing records or what prerequisites must be satisfied 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