View as Markdown
QuickBooks icon

QuickBooks ACTION

List Open Invoices

Lists invoices with an outstanding balance (open invoices). Optionally supply a full query to override the default filter. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's QuickBooks account once, then configure and run List Open Invoices from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "quickbooks-list-open-invoices",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    quickbooks: { authProvisionId: "apn_xxxxxxx" },
    query: "Query",
    maxResults: "Max Results",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Open Invoices inputs
Property Type Description
query Query string
Full QuickBooks query string targeting Invoice. When omitted, the action runs select * from Invoice where Balance > '0' (plus optional sort/pagination below).
Optional
maxResults Max Results string
The number of entity elements in the response.
Optional
orderClause Order Clause string
The orderClause is for sorting the result. Include the property to sort by. The default sort order is ascending; to indicate descending sort order, include DESC, for example: Name DESC
Optional
startPosition Start Position string
The starting count of the response for pagination.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
quickbooks-list-open-invoices
Version
0.0.2
App
QuickBooks
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes