Run a financial report
wave_run_reportGenerate Wave financial reports—profit and loss, balance sheet, cash flow, trial balance, and more—from an imported ledger or live API, with paginated rows and full totals.
Instructions
Financial reports computed by this server (Wave's API has no report endpoint). Rows are paginated with limit/offset; totals always cover every row. From the imported ledger (wave_import_ledger; any period, default year to date; balance-sheet style reports as of endDate): profit_and_loss, balance_sheet, cash_flow, trial_balance, account_balances, account_transactions/general_ledger (filter with account or accountId), sales_tax (sales and purchases), aged_payables, purchases_by_vendor. Without a ledger, profit_and_loss, balance_sheet, trial_balance and account_balances fall back to current account balances from the API (as of now only), and sales_tax to invoices. Live from invoices (invoice date range): income_by_customer, sales_by_product, invoice_summary; as of today: aged_receivables; customer_statement needs customerId. Not possible: tax_line, payroll_wage_tax, payroll_benefits_deductions.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Rows to return | |
| offset | No | Rows to skip; use nextOffset | |
| report | Yes | ||
| source | No | auto: imported ledger when available for this report, else the live API | auto |
| account | No | account_transactions: account name (exact, else contains) | |
| endDate | No | Period end; also the as-of date for balance_sheet, trial_balance, account_balances, aged_payables | |
| accountId | No | account_transactions: Wave account ID | |
| startDate | No | Date, YYYY-MM-DD | |
| businessId | No | Business ID; defaults to the one wave_get_context reports | |
| customerId | No | Required for customer_statement; filters invoice-based reports | |
| fiscalYearStart | No | balance_sheet: fiscal year start MM-DD, splits retained earnings from current-year profit | 01-01 |
| outstandingOnly | No | customer_statement: only invoices with an amount due | |
| includeZeroBalances | No | account_balances: include accounts with a zero balance | |
| includeArchivedAccounts | No |