Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create data ext

create_data_ext
Read-onlyIdempotent

Writes data to one data extension. This request can only be invoked if a data extension definition has already been defined for the target object type. That is, before you can perform the DataExtAdd on a particular customer, say John Henry, the data extension must already be defined for the Customer object. Notice that a data extension definition can be defined in either of two ways: via DataExtDefAdd as already described, or via the QuickBooks UI by the user specifying a custom field. Only custom fields can be defined through the UI, not private data extensions.

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

B3.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint/idempotentHint/destructiveHint, so the safety profile is covered; the description adds the prerequisite definition state, qbXML wrapper acceptance (`data_ext_add`), and that the call returns a v2 request plus a webhook payload rather than a direct result. The lead word 'Writes' sits in tension with readOnlyHint=true, though the later sentence about returning 'the v2 request to send' partially reconciles it by showing the mutation is deferred to an external send; error.code/error.type coverage also adds real context.

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 first paragraph is legacy documentation copy with a cross-document reference ('via DataExtDefAdd as already described') that means nothing to an agent, and it spends sentences on background about UI custom fields rather than on invocation guidance. The 20-code error enumeration further bloats the text without front-loading the decision-relevant facts.

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 an 11-parameter tool with nested objects, enums, and an output schema, the description covers the prerequisite, the accepted request shapes, the deferred request/webhook return flow, and error handling. The main gap is routing guidance among the create/update/delete data-extension siblings.

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%, including the choose-exactly-one set logic and enum meanings, so the schema carries parameter semantics. The description adds essentially nothing parameter-specific beyond the object-type prerequisite, so the baseline 3 for high coverage is appropriate.

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 states a specific verb and resource: 'Writes data to one data extension', and the remainder scopes it to values (not definitions) attached to a list/transaction/other object. An agent can tell this is the value-writing counterpart to create_data_ext_def, though no sibling is named explicitly.

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?

It gives a genuine precondition: a data extension definition must already exist for the target object type, and it notes definitions come from DataExtDefAdd or the UI (custom fields only). It never says when to prefer this over update_data_ext or create_data_ext_def, so the when-vs-alternative guidance is only implied.

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