Execute list merge
execute_list_mergeThis request merges one list object into another list object of the same type. Currently you can merge customers/jobs, or vendors, or accounts. The consequence of the merge is that only the merge-to object remains. The merge-from object goes away and all transactions that reference that merge-from object now reference only the merge-to object.
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, 3150 missing_element, 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, 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": {
"list_merge_type": "<list_merge_type>",
"merge_from": "<merge_from>",
"merge_to": "<merge_to>"
},
"name": "execute_list_merge"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| merge_to | Yes | The object into which you are merging another object. | |
| merge_from | Yes | The object to be merged into another object. | |
| 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`. | |
| include_qbxml | No | Also return the qbXML this compiles to, for debugging. Not part of the v2 request. | |
| list_merge_type | Yes | The type of the objects to be merged. Both of the objects must be the same type, for example both must be customers, because you can’t merge a vendor with a customer. | |
| same_ship_addr_ok | No | A new tag (SameshipAddressOk) is added to ListMerge request. If true is supplied in this tag then the merge will go through even if elements have same default shipto address. |
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). |