Reports
Tool types that run QuickBooks' built-in reports: profit and loss, balance sheet, cash flow, receivables and payables aging, customer and vendor balances, and the raw transaction list.
Every type on this page requires a QuickBooks connector; connectorId is the ID of that connector. All dates are YYYY-MM-DD strings, and where accountingMethod appears it's Cash or Accrual. Reports come back in QuickBooks' row/column report format rather than as entity lists — for pre-digested aggregates, see the summary composites on the Workflows page.
Get profit and loss TOOLQUICKBOOKS_GET_PROFIT_AND_LOSS
Runs the P&L (income statement) for a date range: income, cost of goods sold, expenses, and net income. summarizeColumnsBy splits the columns by Month, Week, and so on, or keeps a single Total column.
Example
{
"toolType": "QUICKBOOKS_GET_PROFIT_AND_LOSS",
"connectorId": "V1StGXR8Z5",
"startDate": "@@{startDate}",
"endDate": "@@{endDate}",
"accountingMethod": "Accrual",
"summarizeColumnsBy": "Month"
}
connectorId in the tool configuration.Configuration fields
- Name
connectorId- Type
- string (ID)
- Description
- Required string (ID) value. References a connector by ID.
- Name
startDate- Type
- string
- Description
- Start date (YYYY-MM-DD)
- Name
endDate- Type
- string
- Description
- End date (YYYY-MM-DD)
- Name
accountingMethod- Type
- string
- Description
- Cash or Accrual
- Name
summarizeColumnsBy- Type
- string
- Description
- Total, Month, Week, etc.
Get balance sheet TOOLQUICKBOOKS_GET_BALANCE_SHEET
Runs the balance sheet as of endDate: assets, liabilities, and equity at that point in time. Like the P&L, columns can be summarized by period for trend views.
Example
{
"toolType": "QUICKBOOKS_GET_BALANCE_SHEET",
"connectorId": "V1StGXR8Z5",
"endDate": "@@{asOfDate}",
"accountingMethod": "Accrual",
"summarizeColumnsBy": "Total"
}
connectorId in the tool configuration.Configuration fields
- Name
connectorId- Type
- string (ID)
- Description
- Required string (ID) value. References a connector by ID.
- Name
endDate- Type
- string
- Description
- As of date (YYYY-MM-DD)
- Name
accountingMethod- Type
- string
- Description
- Cash or Accrual
- Name
summarizeColumnsBy- Type
- string
- Description
- Total, Month, Week, etc.
Get cash flow TOOLQUICKBOOKS_GET_CASH_FLOW
Runs the statement of cash flows for a date range, broken into operating, investing, and financing activities. Useful for agents answering "where did the money actually go?" as opposed to accrual-based P&L questions.
Example
{
"toolType": "QUICKBOOKS_GET_CASH_FLOW",
"connectorId": "V1StGXR8Z5",
"startDate": "@@{startDate}",
"endDate": "@@{endDate}",
"summarizeColumnsBy": "Month"
}
connectorId in the tool configuration.Configuration fields
- Name
connectorId- Type
- string (ID)
- Description
- Required string (ID) value. References a connector by ID.
- Name
startDate- Type
- string
- Description
- Start date (YYYY-MM-DD)
- Name
endDate- Type
- string
- Description
- End date (YYYY-MM-DD)
- Name
summarizeColumnsBy- Type
- string
- Description
- Total, Month, Week, etc.
Get aged receivables TOOLQUICKBOOKS_GET_AGED_RECEIVABLES
Runs the A/R aging report — who owes money and how overdue it is, bucketed into aging periods (daysPerAgingPeriod wide, numPeriods of them, defaulting to 4 x 30 days). Pass customerId to age a single customer's balance; this is the natural input for collections and dunning agents.
Example
{
"toolType": "QUICKBOOKS_GET_AGED_RECEIVABLES",
"connectorId": "V1StGXR8Z5",
"reportDate": "@@{asOfDate}",
"agingMethod": "Report_Date",
"daysPerAgingPeriod": 30,
"numPeriods": 4
}
connectorId in the tool configuration.Configuration fields
- Name
connectorId- Type
- string (ID)
- Description
- Required string (ID) value. References a connector by ID.
- Name
reportDate- Type
- string
- Description
- As of date (YYYY-MM-DD)
- Name
agingMethod- Type
- string
- Description
- Report_Date or Current
- Name
daysPerAgingPeriod- Type
- integer
- Description
- Days per period (default 30)
- Name
numPeriods- Type
- integer
- Description
- Number of periods (default 4)
- Name
customerId- Type
- string
- Description
- Filter by specific customer
Get aged payables TOOLQUICKBOOKS_GET_AGED_PAYABLES
The A/P mirror of aged receivables — which vendors the company owes and how overdue each balance is, in the same configurable aging buckets. Pass vendorId to focus on one vendor before deciding what to pay first.
Example
{
"toolType": "QUICKBOOKS_GET_AGED_PAYABLES",
"connectorId": "V1StGXR8Z5",
"reportDate": "@@{asOfDate}",
"agingMethod": "Report_Date",
"daysPerAgingPeriod": 30,
"numPeriods": 4
}
connectorId in the tool configuration.Configuration fields
- Name
connectorId- Type
- string (ID)
- Description
- Required string (ID) value. References a connector by ID.
- Name
reportDate- Type
- string
- Description
- As of date (YYYY-MM-DD)
- Name
agingMethod- Type
- string
- Description
- Report_Date or Current
- Name
daysPerAgingPeriod- Type
- integer
- Description
- Days per period (default 30)
- Name
numPeriods- Type
- integer
- Description
- Number of periods (default 4)
- Name
vendorId- Type
- string
- Description
- Filter by specific vendor
Get customer balance TOOLQUICKBOOKS_GET_CUSTOMER_BALANCE
Runs the customer balance report — each customer's open balance as of reportDate, without the aging breakdown. Filter with customerId for a quick "how much does this customer owe right now?" answer.
Example
{
"toolType": "QUICKBOOKS_GET_CUSTOMER_BALANCE",
"connectorId": "V1StGXR8Z5",
"reportDate": "@@{asOfDate}",
"accountingMethod": "Accrual",
"customerId": "@@{customerId}"
}
connectorId in the tool configuration.Configuration fields
- Name
connectorId- Type
- string (ID)
- Description
- Required string (ID) value. References a connector by ID.
- Name
reportDate- Type
- string
- Description
- As of date (YYYY-MM-DD)
- Name
accountingMethod- Type
- string
- Description
- Cash or Accrual
- Name
customerId- Type
- string
- Description
- Filter by specific customer
Get vendor balance TOOLQUICKBOOKS_GET_VENDOR_BALANCE
Runs the vendor balance report — how much is owed to each vendor as of reportDate. Filter with vendorId to check a single vendor before approving new spend or a payment run.
Example
{
"toolType": "QUICKBOOKS_GET_VENDOR_BALANCE",
"connectorId": "V1StGXR8Z5",
"reportDate": "@@{asOfDate}",
"accountingMethod": "Accrual",
"vendorId": "@@{vendorId}"
}
connectorId in the tool configuration.Configuration fields
- Name
connectorId- Type
- string (ID)
- Description
- Required string (ID) value. References a connector by ID.
- Name
reportDate- Type
- string
- Description
- As of date (YYYY-MM-DD)
- Name
accountingMethod- Type
- string
- Description
- Cash or Accrual
- Name
vendorId- Type
- string
- Description
- Filter by specific vendor
Get transaction list TOOLQUICKBOOKS_GET_TRANSACTION_LIST
Runs the transaction list report — every transaction in a date range, filterable by comma-separated transactionType values (Invoice, Payment, Bill, ...), groupable by customer, vendor, or account, with selectable columns. It's the most flexible read on this page and the engine behind QUICKBOOKS_GET_RECENT_ACTIVITY on the Workflows page.
Example
{
"toolType": "QUICKBOOKS_GET_TRANSACTION_LIST",
"connectorId": "V1StGXR8Z5",
"startDate": "@@{startDate}",
"endDate": "@@{endDate}",
"transactionType": "Invoice,Payment",
"groupBy": "Customer"
}
connectorId in the tool configuration.Configuration fields
- Name
connectorId- Type
- string (ID)
- Description
- Required string (ID) value. References a connector by ID.
- Name
startDate- Type
- string
- Description
- Start date (YYYY-MM-DD)
- Name
endDate- Type
- string
- Description
- End date (YYYY-MM-DD)
- Name
transactionType- Type
- string
- Description
- Invoice, Payment, Bill, etc. (comma-separated)
- Name
sourceAccountType- Type
- string
- Description
- Filter by account type
- Name
groupBy- Type
- string
- Description
- None, Customer, Vendor, Account, etc.
- Name
columns- Type
- string
- Description
- Comma-separated column names to include