What this page is for
This page runs one report. Its parameters sit above the result: some are required and the report will not run until they are filled in, others are optional and narrow what comes back. Once it runs, a stamp above the rows states As of — the instant the figures were computed — and how many business events had not yet posted to the ledger at that instant, so you know whether the figures below are complete. Where the report deals in money, the stamp also states the currency it is shown in and the exchange-rate basis used to get there.
A small report returns its rows straight away. A large one is prepared in the background instead: the page says so and points you to My exports, where the file appears once it is ready. Export does the same for any volume, and is always prepared as a file rather than shown on screen.
Everyone whose role holds reports.view and this report's own permission can open and run it; a role missing the report's own permission sees why, named on the page, rather than the figures. Exporting needs reports.export as well — holding it lets you export any report you can already open.
Before you start
Changing a parameter and running again replaces the page's address, so a particular set of parameters can be bookmarked or shared with a colleague who holds the same permissions.
How to…
How to run the report
Fill in every required parameter — the page will not run without them — and any optional one you want to narrow the result by, then press Run report.
How to read the stamp
Look at As of for when the figures were computed, and the business-events count beside Posting queue: zero means every event had posted and the figures are complete; any other number names how many had not, and the note underneath says the figures below leave them out.
How to export the report
Press Export and choose a format from the ones offered — a report with no export format shows Screen only in the catalogue and offers no Export button here. The file is prepared in the background; a note confirms this and links to My exports, where it appears once ready.
How to change the sort or the page
Press a column heading to sort by it, or use the paging controls under the rows. Either one re-runs the report with the new setting.
If something goes wrong
If a parameter does not point at something you can see — a branch, a till session or similar — the page says so and asks you to choose it again from the list rather than leaving the figure wrong.
If the report needs a permission your role lacks beyond reports.view, the page names it and offers a button back to the report list; nothing about the report runs.
If the address names a report that does not exist, the page says this report is not available and offers a way back to the list.
Worked examples
Restaurant and bar
The Acacia Grill & Bar's owner opens branch-end-of-day, chooses Business date Yesterday and Branch Westlands, and runs it. The stamp shows Posting queue 0, so the figures are complete, and exports it to an Excel (.xlsx) spreadsheet to send on to their accountant.
Supermarket
Tumaini Supermarket's manager, who holds stock.view but not catalogue.cost, runs usage-variance for last week's stocktake. The report runs and shows every row, but the issue-cost column is missing rather than the whole report being refused, because cost figures are withheld column by column, not report by report.
Butchery
Mama Njeri's Butchery's owner runs sales-by-store over a month holding over forty thousand lines. The page reports it is too many rows to show at once and is being prepared in the background, and points to My exports, where the spreadsheet appears a few minutes later.