Run a report
books_reportA report in the base currency. profit_and_loss and tax cover from-to (default: this fiscal year so far); balance_sheet and trial_balance are as of to (default today); general_ledger lists each account's lines from-to with running balances (one account, or all, paged); oss is a quarter's sales to consumers in other EU countries for the One Stop Shop return, per country and VAT rate in euros (quarter, default the last one ended; no books needed); reconciliation holds each bank account's books against the closing balance its latest statement on or before to stated: reconciled, to_match (statement lines and entries still to pair explain the difference) or off (unexplained). Like Xero's: profit_and_loss with compare adds columns for earlier months, quarters or years; cash_summary shows the money accounts at the start and end of from-to and what came in and went out, by account; executive_summary (default this month so far) gives cash, profit, margins, what is owed both ways, debtor and creditor days and invoices issued, against the same days a month before; budget_variance holds a budget (books_save_budget) against the actual figures for the months from-to touches; vat_return gives from-to by the boxes of the VAT return the business files itself, Germany's advance return by Kennzahl or the UK's nine boxes (country, default the business's), with what the books can't tell yet. Like Xero's short-term cash flow, cash_forecast projects the money accounts days ahead (default 30, up to 180) from open invoices and bills on their due, expected or planned dates and what repeating templates will make, by day and week, with the lowest point and the overdue invoices and bills it leaves out until they have a date to come (each with the id that invoices_set_expected_date or purchasing_set_planned_date takes). snapshot is the year so far (default) against the same days a year before: profit, margins, income and expenses by month, the largest costs, the balance sheet, cash, and the average days from an invoice's or a bill's date to the payment that settled it, for those paid in the period. To show a person, put it in a view (view_show). Free.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | YYYY-MM-DD | |
| days | No | For cash_forecast: how many days ahead. | |
| from | No | YYYY-MM-DD | |
| limit | No | ||
| budget | No | For budget_variance: the budget's name (books_list_budgets). | |
| offset | No | ||
| report | Yes | ||
| account | No | An account code from the chart, e.g. "6600". | |
| compare | No | For profit_and_loss: add columns for the same days `periods` months, quarters or years before. | |
| country | No | For vat_return: whose form. Default the business's country. | |
| periods | No | With compare; default 1. | |
| quarter | No | For oss: like 2026-Q3. | |
| tracking | No | For profit_and_loss: only lines with these options, e.g. {"Department": "Service"}. | |
| by_tracking | No | For profit_and_loss: a tracking category to split by, one column per option and one for what is not tracked. |