`qb_list_invoices`

Pack: quickbooks · Endpoint: https://gateway.pipeworx.io/quickbooks/mcp

Get recent invoices with number, customer, amount, due date, and payment status. Use qb_get_invoice for full line-item details.

Parameters

Name	Type	Required	Description
`max_results`	number	no	Maximum number of invoices to return (default 25, max 1000)
`start_position`	number	no	Starting position for pagination (default 1)

Example call

Arguments

{
  "max_results": 25
}

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_list_invoices","arguments":{"max_results":25}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('qb_list_invoices', {
  "max_results": 25
});

More examples

{
  "max_results": 50,
  "start_position": 26
}

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 invoices with number, customer, amount, due date, and status",
          "items": {
            "type": "object",
            "properties": {
              "Id": {
                "type": "string",
                "description": "Invoice ID"
              },
              "DocNumber": {
                "type": "string",
                "description": "Invoice number"
              },
              "TotalAmt": {
                "type": "number",
                "description": "Total invoice amount"
              },
              "DueDate": {
                "type": "string",
                "description": "Due date"
              },
              "CustomerRef": {
                "type": "object",
                "description": "Reference to customer"
              }
            }
          }
        }
      }
    }
  ]
}

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.

qb_list_invoices