Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create sales receipt

create_sales_receipt
Read-onlyIdempotent

Adds a sales receipt: a sale paid in full when it was made, by cash, check or card. If the customer pays later, add an invoice instead and record the payment when it arrives. The money goes to deposit_to_account_ref. customer_ref is optional. Card details sent in credit_card_txn_info come back in the answer only if the app may see sensitive data.

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

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_sales_receipt"
  }
}

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 sales receipt.
otherNoOther, Other1, and Other2 are built-in transaction custom fields. Other is transaction-level; Other1 and Other2 are line-level.
due_dateNoA sales receipt doesn’t ordinarily include a due date, because sales receipts are generally used for point-of-sale payments, where full payment is received at the time of purchase.
txn_dateNoThe date of the sales receipt. 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+.
ship_dateNoThe date when the product was, or will be, shipped.
is_pendingNoIf `is_pending` is set to true, the sales receipt hasn’t been completed.
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`.
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).
check_numberNoThe check number of a check that a QuickBooks user writes or receives from someone else.
customer_refNo`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.
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.
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
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.
payment_method_refNo`payment_method_ref` identifies how a payment is made (for example, cash, check, or card type). If both `full_name` and `list_id` are provided, `full_name` is ignored.
sales_tax_line_addNo
include_ret_elementNo
credit_card_txn_infoNoContains data from the credit card transaction used in the payment. This data originates from a previous qbmsXML credit card transaction.
deposit_to_account_refNoRefers to the account where these funds will be (or have been) deposited. In a ReceivePaymentAdd request, the default is Undeposited Funds if this isn’t included in the request.
sales_receipt_line_addNoOne line of the sales receipt. Compare with SalesReceiptLineGroup, which represents a previously defined group of lines in the sales receipt. At least one entry is required across `sales_receipt_line_add` and `sales_receipt_line_group_add`; they combine, any number of each. QuickBooks receives them in that order: every `sales_receipt_line_add`, then every `sales_receipt_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.)
sales_receipt_line_group_addNoRepresents a previously defined group of lines in the sales receipt. Compare with SalesReceiptLine, which represents just one line in the sales receipt. At least one entry is required across `sales_receipt_line_add` and `sales_receipt_line_group_add`; they combine, any number of each. QuickBooks receives them in that order: every `sales_receipt_line_add`, then every `sales_receipt_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

A4/5.0
Behavior4/5

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

Substantially beyond the annotations, it discloses that the call returns a v2 request to send plus the webhook payload shape carrying QuickBooks' answer, that a legacy `sales_receipt_add` qbXML wrapper is accepted, and that card data in `credit_card_txn_info` is echoed only if the app may see sensitive data. It also enumerates 20 concrete error codes with their names, which directly helps an agent plan failure handling. The only friction is that the opening 'Adds a sales receipt' framing sits awkwardly against readOnlyHint=true, though the explicit 'returns the v2 request to send' language reconciles it as a request-builder.

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?

Purpose and the invoice alternative are front-loaded in the first two sentences, followed by parameter notes, the return mechanism, and errors in descending order of importance. The 20-code error enumeration is long and the description itself says the call result explains each, making part of that block token-heavy. Still, every block is scannable and nothing is purely redundant filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given 36 parameters, deep nesting, an output schema, and full annotations, the description covers all the decision-level points an agent needs: what the resource is, when to prefer an invoice, where funds are deposited, what the call returns and how the real answer arrives, and which errors to expect. Detail-level obligations such as requiring at least one line entry are already documented in the schema, so no critical gap remains.

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 already 89%, so the schema carries most of the burden. The description still adds genuine meaning for a few inputs: it explains that money goes to `deposit_to_account_ref`, that `customer_ref` is optional, and that card details resurface only under sensitive-data permissions. It says nothing about the many other inputs (txn_date, is_pending, the line arrays' required shape), so it adds value without fully compensating.

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 plus the defining business scope: 'Adds a sales receipt: a sale paid in full when it was made, by cash, check or card.' It also states the discriminating condition against the invoice concept, so an agent can tell which transaction type to create. It stops short of naming sibling tools (e.g., update_sales_receipt, create_sales_order) as explicit alternatives, which keeps it at 4 rather than 5.

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 a clear when-to-use and when-not-to-use rule: use this when payment is received at the time of sale, and 'add an invoice instead and record the payment when it arrives' if the customer pays later. It also names the destination account parameter that determines where the money lands. What is missing is any guidance on the create-vs-update path or on required line items relative to other creation tools.

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