Update charge
update_chargeSome 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
| Name | Required | Description | Default |
|---|---|---|---|
| desc | No | A descriptive text field. | |
| rate | No | Indicates the price of something. | |
| amount | No | A monetary amount. | |
| txn_id | Yes | `txn_id` is the unique QuickBooks identifier for a transaction. Use it to reference that transaction in later requests. | |
| due_date | No | The date on which payment is due. | |
| item_ref | No | `item_ref` may accept all item types or a restricted subset, depending on the request. | |
| quantity | No | On 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_date | No | The 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_ref | No | Use classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks. | |
| ref_number | No | `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_id | No | Your 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_date | No | The date when the customer was billed for what is now being charged to their credit card. | |
| customer_ref | No | `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_sequence | Yes | `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_qbxml | No | Also return the qbXML this compiles to, for debugging. Not part of the v2 request. | |
| ar_account_ref | No | `ar_account_ref` points to an Accounts Receivable account. If both `full_name` and `list_id` are provided, `full_name` is ignored. | |
| unit_of_measure | No | In a transaction line item, the name of the unit of measure selected from within the item’s available units. | |
| inventory_site_ref | No | Site where inventory is located. | |
| include_ret_element | No | ||
| override_uom_set_ref | No | When 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_ref | No | Refers 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_ref | No | Location within the Inventory Site. | |
| option_for_price_rule_conflict | No | Flag to override price rule conflict |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Replace {connection_id} with the customer's connection. | |
| body | Yes | The JSON body: the arguments you passed. | |
| qbxml | No | The qbXML it compiles to. Only with include_qbxml. | |
| method | Yes | ||
| headers | Yes | Send with the request. Resent unchanged when no 201 came back, it answers with the request already queued. | |
| webhook | Yes | JSON Schema of the payload POSTed to webhook_url once QuickBooks answers, with this operation's response_json (data shape and status codes). |