Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update data ext

update_data_ext
Read-onlyIdempotent

Sets the value of a custom field (owner_id 0) or private extension (your GUID) on a list object or transaction. The object needn't have a value yet: on QuickBooks Enterprise 24.0 (2026-10-10) this set a custom field's first value on a new sales order, so you don't need data_ext.create first. The definition must reach the object's type: a custom field defined on Customer also reaches credit memos, estimates, invoices, sales orders and sales receipts. It can't clear a value; delete the value instead.

The data_ext_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, 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": {
      "data_ext_name": "<data_ext_name>",
      "data_ext_value": "<data_ext_value>",
      "owner_id": "<owner_id>"
    },
    "name": "update_data_ext"
  }
}

Input Schema

NameRequiredDescriptionDefault
txn_idNo`txn_id` is the unique QuickBooks identifier for a transaction. Use it to reference that transaction in later requests. Choose exactly one of: the set (`list_data_ext_type`, `list_obj_ref`), or the set (`txn_data_ext_type`, `txn_id`, `txn_line_id`), or `other_data_ext_type`. Members of a set combine with each other, not with the other choices.
owner_idYes`owner_id` identifies who owns the data extension. Use 0 for QuickBooks custom fields that appear in the UI, or use a GUID for private extensions owned by an app.
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`.
txn_line_idNoIdentification number of the transaction line. (`txn_line_id` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `txn_line_id` is always returned as zero.) Choose exactly one of: the set (`list_data_ext_type`, `list_obj_ref`), or the set (`txn_data_ext_type`, `txn_id`, `txn_line_id`), or `other_data_ext_type`. Members of a set combine with each other, not with the other choices.
list_obj_refNoRefers to a list object. In a DataExtAdd request, the list object ref must be the same type as the type specified in `list_data_ext_type`. Choose exactly one of: the set (`list_data_ext_type`, `list_obj_ref`), or the set (`txn_data_ext_type`, `txn_id`, `txn_line_id`), or `other_data_ext_type`. Members of a set combine with each other, not with the other choices.
data_ext_nameYesThe name of the data extension. If this is a custom field, `data_ext_name` will be visible as a label in the QuickBooks user interface.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
data_ext_valueYesThe data in this field. The maximum length of `data_ext_value` will depend on the `data_ext_type` of this data extension.
txn_data_ext_typeNoThe type of transaction that the data extension belongs to. Choose exactly one of: the set (`list_data_ext_type`, `list_obj_ref`), or the set (`txn_data_ext_type`, `txn_id`, `txn_line_id`), or `other_data_ext_type`. Members of a set combine with each other, not with the other choices.
list_data_ext_typeNoThe type of list object (e.g. Customer) that this data extension is attached to. Choose exactly one of: the set (`list_data_ext_type`, `list_obj_ref`), or the set (`txn_data_ext_type`, `txn_id`, `txn_line_id`), or `other_data_ext_type`. Members of a set combine with each other, not with the other choices.
other_data_ext_typeNoNot supported. Choose exactly one of: the set (`list_data_ext_type`, `list_obj_ref`), or the set (`txn_data_ext_type`, `txn_id`, `txn_line_id`), or `other_data_ext_type`. Members of a set combine with each other, not with the other choices.

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

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive and closed-world, and the description resolves the apparent tension by explaining the async contract: it returns the v2 request to send plus the webhook payload the answer arrives in (response_json shape and status codes to handle). It also discloses the qbXML data_ext_mod wrapper, the include_qbxml debug option, and enumerates the error codes with their types, which is substantial behavior beyond the annotations.

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?

The first sentence front-loads the action, scope and the owner_id distinction, and the second paragraph carries the important operational caveats. The long inline enumeration of 19 error codes is dense reference material that could be deferred to the error result itself, mildly diluting the otherwise tight structure.

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 complex tool (11 parameters, nested refs, three enums, an output schema, and an async webhook round-trip), the description covers the mutation semantics, the no-create-needed rule, the clear-value limitation, and the response path. The main residual gap is the precise boundary with update_data_ext_def for definition-level changes.

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 100%, so all 11 parameters, their enums and the exclusive-set rule are already documented. The description reinforces the most consequential semantic point (owner_id=0 is a UI-visible custom field, a GUID is a private app extension) and adds the cross-type reach constraint, but otherwise restates what the schema provides, which is the expected baseline 3.

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 description gives a specific verb and resource: it 'sets the value of a custom field (owner_id 0) or private extension (your GUID) on a list object or transaction.' That is concrete enough to distinguish it from definition-level siblings such as update_data_ext_def, although the only sibling it names is 'data_ext.create' (i.e., create semantics), not the closest alternative.

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 real when-to-use guidance: you do not need to create the data extension first, the definition must reach the object's type (a Customer custom field also reaches invoices, sales orders, etc.), and it explicitly states what the tool cannot do ('It can't clear a value; delete the value instead'), which routes the agent to the delete sibling. It does not explicitly contrast with update_data_ext_def, so that boundary is left to inference.

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