Reports

A variety of financial reports can be selected on the "Reports" menu":

The Report Window

Once you select a report, a report window will appear:

The report is displayed in a resizable, scrollable window. To control the report, you can use the toolbar buttons at the top of the window:

Constructing custom reports

It is possible to write your own reports to meet your own needs, if you can program a little. You will need to know Scheme (a LISP-like programming language), and it is an excellent idea to have a copy of the Gnucash source code available.

The reporting interface is presently undocumented, but you can get a good idea of how it works by examining the file src/scm/report/hello-world.scm in the GnuCash source distribution.

You will also need to access data from the "engine" to get information for your report. This is performed by a set of Scheme wrapper functions that are documented in the file src/g-wrap/gnc.html. You may wish to examine some of the other reports in src/scm/report for an indication of how they are used.

At present, reports are produced by internally creating HTML and rendering this with a HTML widget. (Future versions of GnuCash will hopefully support a more flexible system).

If you need more information, or have developed a new report that may be of use to others, please contact the GnuCash development mailing list at gnucash-devel@gnucash.org.


Return to Main Documentation Page.