qb_query
Pack: quickbooks · Endpoint: https://gateway.pipeworx.io/quickbooks/mcp
Search QuickBooks data by customer, invoice, or account using filters like name, amount, date, or status. Returns matching records with full details.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
query | string | yes | QuickBooks SQL-like query string (e.g., “SELECT * FROM Customer MAXRESULTS 10”) |
Example call
Arguments
{
"query": "SELECT * FROM Customer MAXRESULTS 10"
}
curl
curl -X POST https://gateway.pipeworx.io/quickbooks/mcp \
-H 'Content-Type: application/json' \
-d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"qb_query","arguments":{"query":"SELECT * FROM Customer MAXRESULTS 10"}}}'
TypeScript (@pipeworx/sdk)
import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();
const result = await pipeworx.call('qb_query', {
"query": "SELECT * FROM Customer MAXRESULTS 10"
});
More examples
{
"query": "SELECT * FROM Invoice WHERE DocNumber = '1001' AND TxnDate >= '2024-01-01'"
}
Response shape
Full JSON Schema
{
"oneOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Error code if connection not configured"
},
"message": {
"type": "string",
"description": "Error message with setup instructions"
}
},
"required": [
"error",
"message"
]
},
{
"type": "object",
"properties": {
"QueryResponse": {
"type": "array",
"description": "Array of query results matching the QuickBooks query",
"items": {
"type": "object"
}
}
}
}
]
}
Connect
Add this to your MCP client config, or use one-click install buttons:
{
"mcpServers": {
"quickbooks": {
"url": "https://gateway.pipeworx.io/quickbooks/mcp"
}
}
}
See Getting Started for client-specific install steps.