The report builder runs the custom reports saved for this business. Each report has its own columns, filters, groups and totals. Owners and managers make a new report and choose who it is shared with in the server console. Everyone the report is shared with can run it here.
Before you start #
Sign in. A report shared with your role appears in the list.
Steps #
- Choose Report builder in the sidebar.
- Pick a report on the left. Its last run time shows under its name.
- Set From and To.
- Choose Run. The table shows the rows, the columns and the totals the report defines.
- Choose CSV or PDF to save the same report for the same dates.
If something goes wrong #
- The list is empty: no report has been saved yet, or none is shared with your role.
- A run is refused: read the sentence the server gives. A report that uses money fields can be shared only with roles that may see money.
- The table is empty: no record matches the report for those dates.
Technical details
The list calls GET /report-builder/saved. A run is GET /report-builder/saved/:id/run with from, to and tz; format=csv or format=pdf returns the file. Money columns are whole cents and use the business currency.