Create data ext def
create_data_ext_defThis request adds a data extension definition to the specified object type (e.g. Customer) so that extension data can be written to a particular object of that type (e.g., this customer, John Smith. A data extension definition must be created before data can be written to the data extension.
The data_ext_def_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, 3040 invalid_amount, 3070 string_too_long, 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_type": "<data_ext_type>",
"owner_id": "<owner_id>"
},
"name": "create_data_ext_def"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| owner_id | Yes | `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_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`. | |
| data_ext_name | Yes | The 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. | |
| data_ext_type | Yes | The field’s data type, which corresponds to a qbXML data type. In an IDataExtDefAdd request object, if this is a custom field, `data_ext_type` must be detSTR255TYPE. | |
| include_qbxml | No | Also return the qbXML this compiles to, for debugging. Not part of the v2 request. | |
| assign_to_object | No | ||
| include_ret_element | No | ||
| data_ext_txn_require | No | If `data_ext_txn_require` is true, this data extension field is required to be entered in transaction. The default value is false. | |
| data_ext_list_require | No | If `data_ext_list_require` is true, this data extension field is required to be entered in lists. The default value is false. | |
| data_ext_format_string | No | The string format required for the data extension. |
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). |