Docs/API Reference
Reports
Profit and loss, balance sheet, receivables and payables aging, sales tax and more.
Endpoints
POSTDashboard SummaryHigh-level financial snapshot: revenue, expenses, net income, receipt counts for a date range.POSTIncome StatementFull profit & loss report broken down by account.POSTProfit & Loss By PeriodProfit & loss with one column per month or quarter. Accounts are grouped into Revenue, Cost of Goods Sold, Operating Expenses and Other Expenses; each line carries its amount per period, its total, and its share of its section. Amounts are natural-signed (revenue and expenses both positive) in the organization's functional currency. A single-period result always equals the Income Statement.POSTSpending By VendorExpenses grouped by vendor, one column per month or quarter. Uses the same posted expense lines as the Profit & Loss (Cost of Goods Sold, Operating and Other Expenses, before tax), so the grand total always equals the P&L's total expenses. A line belongs to its transaction's vendor, else the line's own contact (QuickBooks history), else its known business, else its cleaned bank text; anything left is "No Vendor" (key "none"). Vendors are sorted biggest first. To list one vendor's entries, call accountLines with the returned accountIds and vendor set to the row's key.POSTReceivables & Payables (Aged)Who owes what as of a date: customers who owe you (side "receivable", A/R accounts) or vendors you owe (side "payable", A/P accounts), grouped by the customer/vendor on each posted line. Aging is first-in, first-out: payments clear the oldest charges first and what remains is aged by its own date into 0–30, 31–60, 61–90 and over 90 days. A contact who has overpaid shows a negative balance in current. Lines with no contact are grouped under key "none". The grand total equals the accounts' balance-sheet balance. To list one row's entries, call accountLines with the returned accountIds, endDate = asOf and contact set to the row's key.POSTDownload Reports (Excel / CSV)Every report for a date range in one .xlsx workbook: Profit & Loss by period, Balance Sheet, Spending By Vendor, Receivables and Payables (balances as of endDate). Amounts are numeric cells in the organization's currency format, built from the same services as the queries above, so they always agree. With format "csv", returns just the one report named by report (pnl, balance-sheet, vendors, receivable, payable) as plain rows: amounts to the cent with no symbols, ISO dates. Returns the file name, content type and the file as base64.POSTBalance SheetAssets, liabilities and equity as of a date, optionally compared to a second date. Accounts are grouped by type (Current Assets, Fixed Assets, Current Liabilities, Long-Term Liabilities, Equity). Equity includes two computed lines derived from the P&L, the way QuickBooks derives retained earnings: "Prior Years' Earnings" (before Jan 1 of the as-of year, accountId prior_earnings) and "Net Income (Year To Date)" (accountId net_income). outOfBalance is assets minus liabilities and equity, and is zero for balanced books.POSTAccount BalancesCurrent balance for every account in the chart of accounts.POSTGST/HST Filing PeriodCanadian organizations. The organization's GST/HST filing period by its filing frequency (monthly, quarterly or annual — calendar months/quarters/years). offset 0 is the latest period that has already ended (the return you'd file now); -1 is the one before it, 1 is the period in progress. Returns the dates to pass to gstHstReturn plus the due date (null for annual filers, whose deadline depends on the filer).POSTGST/HST ReturnCanadian organizations. GST/HST return summary for a filing period: tax collected on sales, input tax credits (ITCs) claimable on expenses, ITC adjustments (e.g. the 50% meals & entertainment restriction), and the net amount owing or refundable. The province, rate, and filing frequency/deadline are derived from the organization's tax configuration. Each collected/ITC line carries its accountId and revenueAccountIds lists the revenue accounts, so accountLines can list the entries behind any line. Before filing, check unbookedCount / unbookedTotal (transactions in the period still in review — not counted yet) and receiptsMissingTaxCount (receipts in the period with no tax read). Use filingPeriod to get the period dates.POSTProvincial Sales Tax ReturnProvincial sales tax return for PST (BC/SK/MB) and QST (QC), returned as one section per tax component so an organization registered for more than one province files each separately. Each section reports tax collected, input tax credits (QST registrants only — PST is a cost, not recoverable), and the net owing or refundable for that agency.POSTTax Collected vs PaidFor organizations on their own rates (outside Canada and the US): per rate, tax collected on sales, tax paid on purchases, how much of that is claimed back, and the net owed (collected minus claimed back). Tax that isn't claimed back is part of the expense.POSTSales Tax Collected By StateUS organizations: sales tax collected in the period for each state, a liability summary of what is owed to each state. Each state has its own return and due dates. Sales tax paid on purchases is part of their cost, so it isn't listed.