Find hosts
find_hostsA HostQueryRq request message returns information about the exact QuickBooks product and version with which you are communicating. Note: If you include an explicit end tag in a HostQueryRq request, you will receive an error if there is any space between the opening tag and the end tag. The following table shows valid and invalid ways of constructing this request:
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
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "find_hosts"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| 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. | |
| include_ret_element | No | ||
| include_list_meta_data | No | Use this aggregate if you want the query to return list capacity metadata for each object type in QuickBooks. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Replace {connection_id} with the customer's connection. | |
| qbxml | No | The qbXML it compiles to. Only with include_qbxml. | |
| query | Yes | The query parameters: the arguments you passed. | |
| 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). |