Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update charge

update_charge
Read-onlyIdempotent

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

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

Input Schema

NameRequiredDescriptionDefault
descNoA descriptive text field.
rateNoIndicates the price of something.
amountNoA monetary amount.
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.
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.
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_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.
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`.
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_uom_set_refNoWhen you modify a transaction line to change the unit of measure used in that line, you use this aggregate to specify the UOM set within which you are choosing an available unit of measure.
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

C2.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, and the description usefully explains why: it returns 'the v2 request to send' plus the webhook payload rather than performing the write itself. It also enumerates the concrete error codes/types an agent must handle, which is real added context. That credit is offset by the broken 'fields can't be cleared' rule, which is exactly the behavioral constraint an agent most needs before building a ChargeMod payload.

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 is not front-loaded: it begins with an incomplete constraint instead of stating what the tool does, then jumps to a long error-code catalogue. The error list is legitimately useful, but the dangling 'following fields' colon followed by nothing is a structural defect that wastes the reader's attention.

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?

The heavy lifting is done elsewhere - 96% schema coverage for 23 params and an output schema covering the v2 request and webhook payload shape - so the description does not need to restate parameters. It does cover error handling and the request-vs-execute mechanic, but omits any statement of purpose or sibling routing, and the truncated field-clearing rule leaves a known gap unfilled.

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 96% across 23 parameters, so the schema already carries most semantics and a 3 is the expected baseline. The description adds only two small pieces of meaning: that the raw qbXML `charge_mod` wrapper is accepted, and the all-or-nothing value requirement for unspecified fields, which cannot be applied because the field list is absent.

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

Purpose2/5

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

The description never states plainly that this modifies an existing QuickBooks charge; the reader has to infer it from the tool name and the phrase 'a charge modify request'. It opens mid-thought with 'Some fields in a ChargeMod request can't be cleared', and the promised list 'the following fields' never appears, so the primary sentence is a dangling fragment.

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 guidance on when to use this versus create_charge or update_credit_card_charge, and no statement of prerequisites beyond the implicit edit_sequence token. The one usage-shaped rule ('must contain a value') is unusable because the field list it refers to is missing.

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