Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create charge

create_charge
Read-onlyIdempotent

Adds a customer charge. A Charge contains information about a statement charge. (A CreditCardCharge object, on the other hand, refers to a credit card charge incurred by the QuickBooks user.)

The charge_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_charge"
  }
}

Input Schema

NameRequiredDescriptionDefault
descNoA descriptive text field.
rateNoIndicates the price of something.
amountNoA monetary amount.
due_dateNoThe date on which payment is due.
item_refNo`item_ref` may accept all item types or a restricted subset, depending on the request.
quantityNoOn transaction lines, QuickBooks can derive one value from the other two among Quantity, Rate, and Amount. If you supply Quantity and Amount, QuickBooks calculates Rate.
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+.
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`.
billed_dateNoThe date when the customer was billed for what is now being charged to their credit card.
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.
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.
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.
unit_of_measureNoIn a transaction line item, the name of the unit of measure selected from within the item’s available units.
inventory_site_refNoSite where inventory is located.
include_ret_elementNo
override_item_account_refNoRefers to a QuickBooks account. If an `override_item_account_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
inventory_site_location_refNoLocation within the Inventory Site
option_for_price_rule_conflictNoFlag to override price rule conflict.

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.1/5.0
Behavior2/5

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

Beyond the annotations, the description genuinely adds context: it describes the returned v2 request, the webhook payload and its response_json shape, and enumerates 20 specific error codes with types, which is real behavioral value. But it opens with "Adds a customer charge" — a write claim — while annotations declare readOnlyHint=true, and it never reconciles whether the mutation happens here or when the returned request is sent, leaving the read/write profile ambiguous for a high-stakes create operation.

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 opening two sentences are front-loaded and earn their place, but the second paragraph is a dense run-on that mixes wrapper aliasing, response shape, and a 20-item error-code dump. Since an output schema exists, much of the error/status enumeration is redundant bulk that dilutes the actionable content.

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 complex tool with 22 parameters, nested objects, and an output schema, the description covers the error surface and response mechanism reasonably well. It is incomplete on the points an agent most needs: whether the call itself posts to QuickBooks, what the required customer_ref must identify, and any guidance on the two-phase send/webhook flow.

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 95% across 22 parameters and the schema already documents nested refs, quantity/rate/amount derivation, and include_ret_element enums, so the description correctly cedes that ground. The description adds no parameter-level meaning of its own (not even clarifying the sole required `customer_ref`), so the 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?

"Adds a customer charge" gives a specific verb and resource, and the parenthetical explicitly separates a Charge (statement charge) from a CreditCardCharge, which usefully distinguishes it from sibling create_credit_card_charge. It falls short of 5 only because "statement charge" is left partially defined and the two-phase nature (returns a v2 request rather than plainly performing the add) muddies what the tool itself does.

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?

The CreditCardCharge contrast implies when to choose this tool over the credit-card sibling, and the note that `charge_add` from qbXML is accepted helps callers migrating legacy payloads. However, there is no explicit when-to-use/when-not guidance against update_charge or create_item_other_charge, no stated prerequisites, and no statement about whether the caller must still send the returned v2 request.

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