View as Markdown
QuickBooks icon

QuickBooks ACTION

Get Cash Flow Report

Retrieves the cash flow report from Quickbooks Online. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's QuickBooks account once, then configure and run Get Cash Flow Report 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-get-cash-flow-report",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    quickbooks: { authProvisionId: "apn_xxxxxxx" },
    customer: ["Customer IDs"],
    vendor: ["Vendor IDs"],
  },
})

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.

Get Cash Flow Report inputs
Property Type Description
customer Customer IDs string[]
Filters report contents to include information for specified customers
Optional Dynamic
vendor Vendor IDs string[]
Filters report contents to include information for specified vendors
Optional Dynamic
dateMacro Date Macro string
Predefined date range. Use if you want the report to cover a standard report date range; otherwise, use the Start Date and End Date to cover an explicit report date range
Optional
startDate Start Date string
The start date of the report, in the format YYYY-MM-DD. Start Date must be less than End Date
Optional
endDate End Date string
The end date of the report, in the format YYYY-MM-DD. Start Date must be less than End Date
Optional
classIds Class IDs string[]
Filters report contents to include information for specified classes if so configured in the company file
Optional Dynamic
item Item IDs string[]
Filters report contents to include information for specified items
Optional Dynamic
sortOrder Sort Order string
The sort order for report results
Optional
summarizeColumnBy Summarize Column By string
The criteria by which to group the report results
Optional
department Department IDs string[]
Filters report contents to include information for specified departments if so configured in the company file
Optional Dynamic

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-get-cash-flow-report
Version
0.0.1
App
QuickBooks
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes