# Reports And Charts

This section is a work in process. Some of the material has not been reviewed for V2.0. While it may not be strictly accurate, it is at least a "guide".

## Introduction

Reports and Charts give &app; the ability to present an overview of financial data in various ways. This can range from a simple summary of account totals to an advanced portfolio view. This section will present an explanation of the main &app; reports and how to adjust them.

To run a report or chart, click on the Reports menu, then either select a report (it will open with standard options), or click on Saved Report Configuration to select a report you have previously configured and saved.

Once the report has opened, click on the Options toolbar button to configure the report as needed, for example to set the report date or select accounts.

If you intend to save a report configuration, you should choose a named report date option such as Today rather than enter a specific date so it is not necessary to enter a specific date again in future reports.

If you often run a report with a date as at the start or end of an accounting period, set the accounting period start and end dates in Edit Preferences Accounting Period then select appropriate report date options. See prefs-accounting-period.

If you cannot find a specific report to suit your requirements, you may be able to use the Find Transaction assistant (Edit Find ) to select a set of transactions, and then report them using Reports Account Report . Further formatting or analysis may be done by copying and pasting the report into a spreadsheet.

After you have configured a report, you can save the configuration for future use by clicking either the Save Report Configuration or Save Report Configuration As... button.

### Saving a Report Configuration

To save a report configuration for future use, while the required report tab is selected, go to the report options, select the General tab and change the Report Name to a meaningful unique name. Do not confuse this with the Report Title which prints at the top of a report.

Click the Save Report Configuration or Save Report Configuration As... button. This will store your customized report options in a file in your home directory. E.g. Linux: ~/.gnucash/saved-reports-[versioninfo]

The first time you save a report with a name that has not already been saved, you can use either the Save Report Configuration or the Save Report Configuration As... button. You can modify the report name before saving it.

After a report configuration for a specific name has been saved, the Save Report Configuration button will immediately update the saved report configuration without giving the opportunity to save the configuration with a new name. Use the Save Report Configuration As... button to save the current report configuration with a new name.

After your customized report has been saved, it is available for use by the Reports Saved Report Configurations menu and it will also be listed when starting Reports Sample & Custom Custom Multicolumn Report .

### Working with Saved Report Configurations

Selecting Reports Saved Report Configurations will open a dialog window with a list of the Saved Report Configurations you have previously created. In this context Saved Report Configurations means the set of customized settings for standard reports.

The Saved Report Configurations window lists each of your previously saved report configurations, and 3 small buttons at the end of each. These buttons perform the following actions

- Load (and run) report configuration. Double clicking a report configuration also performs this action.

- Edit report configuration name. This enables a report configuration to be renamed.

- Delete report configuration.

## Configuring Reports and Charts

&app; reports have many configuration options. First, run the original report itself. Then, access the report options with the Options button on the toolbar.

Check changed Graphic Engine Options

### Report Options Buttons

After modifying report options, either

- Click the OK button to apply the changes, regenerate the report and close the options window.

  or

- Click the Apply button to apply the changes, regenerate the report and leave the options window open for possible further changes. In this case, both the Apply and OK buttons will be disabled, indicating changes have been applied, until further changes are made.

  or

- Click the Cancel button to close the options window without applying any unapplied changes.

### Common Report Options

Many reports share similar options. Some common ones include:

- Report Name: Set the title of the report. This is also used to print the report for later viewing.

- Date Options: Reports typically specify either a single date, or a date range, for the report. Dates can be specified in two ways, either directly (using the date selector), or by selecting a relative date from the menu. Relative dates allow you to specify dates like Beginning of this year or Today.

  If you often run a report with a date as at the start or end of an accounting period, set the accounting period start and end dates in Edit Preferences Accounting Period then select appropriate report date options. See prefs-accounting-period.

- Step Size: This option is used on bar charts to determine the interval which each bar represents. Typical values are daily, weekly, monthly, and yearly.

- Accounts: Select the appropriate accounts for the report. Note that in some reports only certain types of accounts can be selected. For example, an expense piechart only allows expense accounts to be selected.

- Show Long Account Names: This option allows displaying either short account names (for example, Power) or long account names (for example, Utilities:Power).

- Include Subaccounts?: Summary reports typically have an include all subaccounts option, which if selected ensures that all subaccounts are included if the parent account is.

- Depth: This option allows the selection of how many levels the report displays subaccounts. If the subaccounts go deeper than selected, an overall value for all the subaccounts is calculated and included in a total. To make sure every account selected is individually displayed, select All.

- Style Sheet: Select a Style Sheet. Style sheets control how reports are displayed. At the moment, there are four style sheets: Default, Easy, Footer and Technicolor. You can customize each of these from the Edit Style Sheets... menu item. This is described in the change-style section.

- Plot Dimensions: There are width and height options for most charts, which specify the displayed dimensions (in pixels).

- Report Currency: Select the report currency. Generally, values will be converted to this currency for display.

  The default Report Currency is defined in Edit Preferences Reports tab. See prefs-reports.

- Price Source: Select how stock and currency prices are calculated in this report. Choose between:

  - Nearest in time (default for most reports): A price retrieved from the prices database on the date nearest to the date of the report or of the datum for time-series reports.

  - Most recent: The latest price in the price database.

  - Average Cost: The amount-weighted net average of all splits exchanging the commodity for another regardless of account. Gain/loss splits are included in the calculation.

  - Weighted Average: The gross amount-weighted average price of all splits exchanging the commodity for another regardless of account. Gain/Loss splits are not in the calculation.

  More information on Average Cost and Weighted Average may be found in the Investments chapter of The Tutorial and Concepts Guide.

- Totals: Charts display totals in the chart legend if this option is selected.

- Maximum Slices: Controls the maximum number of slices displayed in a piechart - other accounts will be placed in a slice marked Other.

- Maximum Bars: Controls the maximum number of bars displayed in a barchart.

- Display Columns: Choose columns to show from the register.

## Reports Listed By Class

&app; has classified the main types of reports into major classes. These are all available under the Reports menu.

### General Reports

The General Reports include the Account Summary Report, the Future Scheduled Transactions Summary, the Tax Schedule Report and TXF Export, and the Transaction Report and also the reports in the Sample & Custom menu.

#### Account Summary

#### Future Scheduled Transactions Summary

#### Tax Schedule Report and TXF Export

The tax schedule report lists all taxable income and deductible expense amounts used in the preparation of US Income Tax returns. The purpose of the report is to provide a complete audit trail for these amounts. The report is intended to be used by a tax payer to manually prepare his or her own tax return, or alternatively, to be provided to a tax preparer for that purpose. The report can also be used to generate an export of all tax related income and expenses to a TXF (Tax eXchange Format) file (this is in addition to exporting to the HTML format that all reports allow). The TXF file can be imported into tax filing programs such as TaxCut or TurboTax. The report should be run, inspected carefully for errors or omissions, and then corrections made to transactions, report settings, currency conversion rates or the account structure as needed. This process should be repeated as often as needed until all the amounts on the report are correct before a final version is used and saved along with the tax returns.

For accounts specified in the report options (none = all) that are also flagged as Tax-related, all transactions for the time period selected (also in the report options) are included. The report sorts transactions by date within account providing subtotals by account within tax code within Form or Schedule line number. Support is also provided for multiple copies of and for sub-line items for selected Forms/Schedules. Optionally uses special date processing to include federal estimated tax payments after year end.

All totals are in USD since this is the currency required for filing US Income Tax returns. Non-USD transaction amounts are converted to USD using the transaction conversion rate to USD, if available. If not, a conversion rate from the price database is used (either the date nearest the transaction date or nearest the report date as specified in the report options; if none is available, transaction amounts are converted to zero and the report provides a comment accordingly). A complete audit trail of conversions is provided.

For this to work, the user has to segregate taxable and non taxable income to different accounts, as well as deductible and non deductible expenses. The Income Tax Information dialog is used for this. To access the Income Tax Information dialog go to Edit Tax Report Options. The user also must set the TXF category of each tax related account. The Income Tax Information dialog is described in the set-tax-options section.

#### Transaction Report

This report lists transactions in selected accounts during a specified financial period. Two fields may be optionally used for sorting and totalling.

##### Report Options

###### Transaction Report, Report Options

Transaction Report, Report Options screen

This is an image of the Transaction Report, Report Options, Display tab.

- Accounts tab

  - Accounts: Select one or more accounts to be reported.

    There are 4 buttons to aid account selection

    Select All | Select all accounts
    Clear All | Clear the selection and unselect all accounts
    Select Children | Select all descendants of selected account
    Select Default | Select the default account selection

  - Show Hidden Accounts: Show accounts that have been marked hidden.

  - Filter By: Optionally select accounts to be either included or excluded depending on Filter type

  - Show Hidden Accounts: Show accounts that have been marked hidden in the Filter By list of accounts

  - Filter Type: One of

    None | Do not do any filtering
    Include Transactions to/from Filter Accounts | Include Transactions to/from Filter Accounts only
    Exclude Transactions to/from Filter Accounts | Exclude Transactions to/from all Filter Accounts

  - Reset defaults button: Reset all values to their defaults

- Display tab

  - Date refers to the 'posted date' i.e. effective date of a transaction.

  - Reconciled Date refers to the 'date of reconciliation' of a transaction.

  - Num is commonly used for check numbers.

  - Description is a description of the transaction

  - Memo is the memo field of a transaction. This can be used as a secondary description of a transaction.

  - Notes: Display the notes if the memo is unavailable

  - Account Name will print the account name containing the transaction.

  - Use Full Account Name if the account name is enabled, this option will display the full account name hierarchy.

  - Account Code this refers to the 'account code' related to the account.

  - Detail Level— One of

    Single | Display 1 line
    Multi-Line | Display N lines

    Before stable version 3.0 Detail Level was called Style on the General tab.

    If Detail Level is Multi-Line, check boxes Other Account Name and Use Full Other Account Name are automatically deselected and disabled, and the Transfer column is not reported.

  - Other Account Name: For multi-split transactions, this parameter should be unticked. See below for more details.

  - Use Full Other Account Name will enable display of full corresponding account name.

  - Other Account Code will enable display of corresponding account code.

  - Shares: Display number of shares

  - Price: Display share prices

  - Amount: One of

    None | Do not display Amount
    Single | Single column display
    Double | Two column display

  - Subtotal Table will add a summary table for the various subtotals generated in the report. It lists the same subtotals generated in tabular form.

  - Running Balance refers to the running balance of the account holding the transaction.

  - Totals will add a 'Grand Total' line adding all transactions in the report.

  - Sign Reverses: One of

    Global Preference | Use reversing option specified in global preference.
    None | Do not display signs reversed
    Credit Accounts | Reverse amount display for Liability, Payable, Equity, Credit Card and Income accounts
    Income and Expense | Reverse amount display for Income and Expense accounts

  - Reset defaults button Reset all values to their defaults

- Filter tab

  - Account Name Filter will include only selected accounts containing the substring. Alternatively, if the next option is checked, the account name filter will be matched according to full POSIX regular expressions.

  - Use regular expressions for account name filter toggles regular expressions for account name filter.

  - Transaction Filter will include only transactions which contain this substring in the description, notes, or memo. Alternatively if the next option is checked, the filter will be matched using full POSIX regular expressions.

  - Use regular expressions for transaction filter toggles regular expressions for the transaction filter.

  - Reconcile Status

    All | Show all transactions
    Unreconciled | Unreconciled only
    Cleared | Cleared only
    Reconciled | Reconciled only

  - Void Transactions: One of

    Non-void only | Show only non-voided transactions
    Void only | Show only voided transactions
    Both | Show both and include voided transactions in totals

  - Closing transactions: One of

    Excluding closing transactions | Show only regular transactions
    Show both closing and regular transactions | Show both regular and closing transactions
    Show closing transactions only | Show closing transactions only

  - Reset defaults button: Reset all values to their defaults

- General tab

  - Report name: Enter a descriptive name for this report

  - Stylesheet: Select Default, Easy, Footer or Technicolor

  - Start Date: Enter or select a specific Start Date

    or select one of the following named start date options which will be used to determine the start date each time the report is run

    Today | The current date
    Start of this month | First day of the current month
    Start of previous month | First day of the previous month
    Start of current quarter | First day of the current quarterly accounting period
    Start of previous quarter | First day of the previous quarterly accounting period
    Start of this year | First day of the current calendar year
    Start of previous year | First day of the previous calendar year
    Start of accounting period | First day of the accounting period as defined in the global preferences

  - End Date: Enter or select a specific End Date,

    or select one of the following named end date options which will be used to determine the end date each time the report is run

    Today | The current date
    End of this month | Last day of the current month
    End of previous month | Last day of the previous month
    End of current quarter | Last day of the current quarterly accounting period
    End of previous quarter | Last day of the previous quarterly accounting period
    End of this year | Last day of the current calendar year
    End of previous year | Last day of the previous calendar year
    End of accounting period | Last day of the accounting period as defined in the global preferences

  - Style: One of

    Single | Display 1 line
    Multi-Line | Display N lines

    In stable version 3.0, the Style option will be renamed to Detail Level and moved to the Display tab.

  - Common Currency: Convert all transactions into a common currency

  - Report's currency: Select the currency to display values

  - Show original currency amount Also show original currency amounts

  - Table for Exporting: Formats the table for cut & paste exporting with extra cells

  - Add options summary: Adds an informative text describing options that were changed by user. This is mainly useful for troubleshooting reports.

  - Reset defaults button: Reset all values to their defaults

- Sorting tab

  - Primary Key: Primary Sort Key. One of

    None | Do not sort
    Account Name | Sort and subtotal by account name
    Account Code | Sort and subtotal by account code
    Date | Sort by date
    Reconciled Date | Sort by the reconciled date
    Reconciled Status | Sort by the reconciled status
    Register Order | Sort as within the register
    Other Account Name | Sort by account transferred from/to's name
    Other Account Code | Sort by account transferred from/to's code
    Amount | Sort by amount
    Description | Sort by description
    Number | Sort by check/transaction number
    Memo | Sort by memo

  - Primary Subtotal: Subtotal according to the primary key

  - Primary Subtotal for Date Key: Do a date subtotal. Only configurable if primary key is date or reconciled date. One of None, weekly, monthly, quarterly or yearly

  - Primary Sort Order: One of

    Ascending | Smallest to largest, earliest to latest
    Descending | Largest to smallest, latest to earliest

  - Secondary Key: Secondary Sort Key. Same options as Primary Key

  - Secondary Subtotal: Subtotal according to the secondary key

  - Secondary Subtotal for Date Key: Do a date subtotal. Only configurable if primary key is date or reconciled date. One of None, weekly, monthly, quarterly or yearly

  - Secondary Sort Order: One of

    Ascending | Smallest to largest, earliest to latest
    Descending | Largest to smallest, latest to earliest

  - Show Full Account Name: Show the full account name for subtotals and subtitles

  - Show Account Code: Show the account code for subtotals and subtitles

  - Show Account Description: Show the account description for subtitles

  - Show Informal Debit/Credit Headers: Show informal names for debit/credit in the subtitles. This requires that subtotal is enabled, and the primary or sortkey is account or account code.

  - Add indenting columns: Add columns to align transactions within the same grouping together, and can be useful to highlight groups.

  - Show subtotals only (hide transactional data): Will hide transactions. This may be useful for reports whereby only subtotals are required.

  - Reset defaults button: Reset all values to their defaults

##### Displaying Split Account Details

This is controled by the Detail Level option on the Display tab.

In stable versions before 3.0 this option was called Style on the General tab.

In Single line mode, there's only one line per transaction. So you can have the account name on one side of the equation and

a. the other account name if there's only one other split in the transaction

or

b. "Split" if there are multiple other splits in the transaction. You can't display multiple "other" account names in one line. There's just no room for it.

In the case of Multi-Line mode, this report uses a completely different concept. For each transaction, every split (both the split in this account and the split(s) in the other account(s) !) is printed on a separate line. And every split really means every split: both the split which belongs in the account being reported and the split(s) in the other account(s) that balance the transaction. So even the most basic transaction, with only two splits (this account and other account) will print two lines in multiline mode.

For a simple transaction like this

Description | Account | Debit | Credit
Cheques Received
"multiple payers" | IncomeAccount |  | £30.00
| BankAccount | £30.00 |

then on a Transaction Report for the bank account the details appear pretty much as above.

For clarity of the accounts, you might enter transactions with multiple splits referring to the same account. For example, the above transaction might well be entered like this

Description | Account | Debit | Credit
Cheques Received
"FirstPayer" | IncomeAccount |  | £10.00
"SecondPayer" | IncomeAccount |  | £20.00
| BankAccount | £30.00 |

When this transaction is printed on the bank account's Transaction Report in Single line mode, then under other account it simply prints the word split instead of the account name.

To display the additional split detail, you need to set Single/Multi-Line to Multi-Line and then tick Display -> Account Name. Do NOT tick Display -> Other Account Name.

You can choose whether or not to turn off the full account name using Display -> Use Full Account Name.

Use Full Other Account Name has no effect in Multi-Line mode.

### Assets & Liabilities

The Assets & Liabilities reports includes the Balance Sheet report, Investment reports and the Net Worth report.

- Advanced Portfolio:

  Columns

  - Account: Stock Account

  - Symbol: Ticker Symbol/Abbreviation as defined in the Security Editor. A report option can suppress this column.

  - Listing: Type as defined in the Security Editor. A report option can suppress this column.

  - Shares: Number of shares (quantity). A report option sets how many decimal places to show. A report option can suppress this column.

  - Price: Unit market price as at report date. A report option can suppress this column.

  - Basis: Cost of all shares acquired by any means, including brokerage fees if the option to include them is checked. Report option Basis calculation method can be set to Average, LIFO or FIFO.

  - Value: Number of shares * Unit market price as at report date

  - Money In: Sum of the cost of stock purchased, excluding stock acquired as part of a Dividend Reinvestment Plan. I.e. External money used to purchase shares.

  - Money Out: Money from selling shares or a spin off transaction.

  - Realized Gain: Money received for selling shares minus basis for shares sold, minus brokerage fees for the sale if the option to include them in basis is checked.

  - Unrealized Gain: Value less Basis for unsold shares

  - Total Gain: Realized Gain + Unrealized Gain

  - Rate of Gain: Total Gain / Money In * 100 (from &app; 2.6.1 onwards)

  - Income: Total of all income transactions associated with a stock account.

    To include income from dividends which are not reinvested (if there is no split to the stock account in the income transaction, the report has no way of associating the income with a particular stock) :

    Ensure there is a dummy transaction split to the stock account with quantity 0, price 1 and value 0 in the dividend transaction. Enter the dummy stock split with no values in the dividend account and it will create the transaction with price 1 even though you cannot see the Price column in that register.

    In GnuCash 2.6.6, this report was modified to simplify the recording of dividend and interest payments. With this change it may not be necessary to include the dummy stock split in the transaction. The report will find income (and expense) transactions that are in the parent account of the stock account being reported on. This is done by looking in the parent account for transactions that have exactly two splits (not counting trading account splits) where the other split is to an income or expense account with the same name as the stock's account.

    For example given an account structure like

                        Assets (type ASSET)
                          Broker (type ASSET)
                            Widget Stock (type STOCK)
                        Income (type INCOME)
                          Dividends (type INCOME)
                            Widget Stock (type INCOME)

    A transaction that debits the "Assets:Broker" account and credits the "Income:Dividends:Widget Stock" account will count as income even though it doesn't have a split with account "Assets:Broker:Widget Stock".

    This only works if the parent account ("Assets:Broker" in this case) is a Bank or Asset account and the Income/Expense account has the same name as the stock account. It won't double count transactions that have a dummy split since they won't have exactly two split transactions.

    It will not work if the income or expense account split is to a subaccount of the account with the same name as the stock account i.e. "Income:Dividends:Widget Stock:Franked"

  - Brokerage Fees: Brokerage Fees

  - Total Return: Total Gain + Income

  - Rate of Return: Total Return / Money In * 100

  Common report options are described in report-config

  Report Specific Options

  - Accounts Tab

    - Include accounts with no shares: Unchecked (default) or checked.

  - Display Tab

    - Show ticker symbols: Checked (default) or unchecked. If unchecked, Symbol column will be omitted.

    - Show listings: Checked (default) or unchecked. If unchecked, Listing column (source of shares price quotes) will be omitted.

    - Show number of shares: Checked (default) or unchecked. If unchecked, Shares column will be omitted.

    - Share decimal places: The number of decimal places to show in the number of shares. Default is 2.

    - Show prices: Checked (default) or unchecked. If unchecked, Price column will be omitted.

  - General Tab

    - Price Source: Nearest in time (default) or Most Recent.

    - Basis calculation method: Average (default), FIFO or LIFO.

    - Set preference for price list data: Checked (default): Use price list data. If there is no relevant price list data, transaction prices will be used and there will be a warning. Unchecked: Get prices from stock transactions.

    - How to report brokerage fees: Include in basis (default), Include in gain or Ignore.

- Asset Barchart:

  The Asset Barchart report displays bars that present the value of all assets in a &app; file over time. By default, the report shows all accounts in Accounts Receivable, Current Assets, Fixed Assets, Investments and Special Accounts (if they exist) and it displays monthly bars for the current financial period. This report provides a graphic view of the assets in the file over time.

  Like all the generic reports, the user can assign a title and save the report with it's selected options for re-use later.

  The display is in the form of either a stacked barchart or simple barchart with an option to display a table of the values.

  This report calculates and displays a default of 8 bars or up to 24 separate asset accounts value at the end of the day on several dates through a specified time period. The report automatically selects the most significant accounts to display with all other selected accounts summed as Other.

  The report exploits the outline structure of the chart of accounts to allow the user to select top level accounts and sub-accounts down to a user-selectable depth. Selected sub-accounts below the selected depth are automatically summed up into the next level when it is also selected. The default number of sub-account levels is 2, giving a summary view. Increasing the number of sub-levels increases the detail available to display. It is possible to un-select a higher level account and leave sub-accounts selected to force greater detail to appear in the report.

  By default the report includes all asset accounts and sub-accounts, as well as Imbalance and Orphan Special accounts in whatever currencies or commodities may be present. The report's base currency is the default currency of the &app; file but if the file has data for multiple currencies, then it can be changed to another currency.

  Since each account may be individually selected, the report can be designed to focus on a small subset of data such as current assets or investments.

  The overall interval of the report defaults to start at the start of the current accounting period and to end at the end of the current accounting period. Numerous other starting choices and ending choices are available.

  The first bar shows the selected values at the end of the day on the first date chosen. There are a number of choices for step size from day to year with the default being month. Note that if any step date would fall on the 29th, 30th or 31st in a month that does not have such a date the next interval will be 31 days later. For that step only the date will slip up to 3 days into the following month. This is true for releases at least through 2.4.13. Bug 639049 is open in Bugzilla to modify this behavior.

  Currently, there is no option to start the report on the last day of any period. There is also no option to show beginning balances or end of previous step balances. This makes it difficult to correlate this report to business quarterly reports, for example.

  The Net Worth linechart report, Liability barchart report and Net Worth barchart report are similar except for the graphic type and default account groups selected.

  Other features are customizable in a manner similar to other standard reports.

- Asset Piechart:

- Average Balance:

- Balance Sheet: This report summarizes assets, liabilities, and equity. When properly maintained, assets should equal the sum of liabilities and equity. If that is not the case, there is some kind of internal imbalance in the accounts.

- Balance Sheet using eguile-gnc:

- General Journal:

- General Ledger:

- Investment Portfolio: This report summarizes the value of the stocks in the current portfolio.

- Liability Barchart:

- Liability Piechart:

- Net Worth Barchart: Net worth is the difference between the value of assets or liabilities.

- Net Worth Linechart: Net worth plotted over time. Net worth is the difference between the value of assets or liabilities.

- Price Scatterplot:

### Business Reports

The Business Reports includes Customer and Vendor Reports and Printable Invoices as well as Aging reports.

#### Customer Report

#### Customer Summary

#### Easy Invoice

#### Employee Report

#### Fancy Invoice

#### Job Report

#### Payable Aging

This report provides a listing of vendors and their aged outstanding balances. Vendors may be included if they have posted business transactions (e.g. invoices) for the selected accounts payable account. It shows their current balance, and how much they have due from invoices over time periods 0-30 days, 31-60 days, 61-90 days, and over 90 days. The report also contains links to each vendor and to their current vendor report.

Optionally, vendor address details may be also shown.

To export vendor address details, say in order to do a mail merge, select the optional vendor address details in the report options display tab, apply the options to regenerate the report, then copy and paste the report into a spreadsheet. Alternatively, the report can be exported to a .html file, then read into a spreadsheet.

##### Report Options

See report-common.title in the Configuring Reports and Charts section of this help manual for more details of the common options.

- General tab

  - Report name: Enter a descriptive name for this report - see report-common.title.

  - Stylesheet: Select a style sheet for this report - see report-common.title.

  - To: Select a date to report on or a named date. Transactions up to and including the selected date will be used to calculate the outstanding aged balances. See report-common.title.

  - Report's currency: Select the currency to display the values in - see report-common.title

  - Price Source: Select the source of price information used for currency conversion if needed. One of

    Average Cost | The volume-weighted net average price of all exchanges.
    Weighted Average (default) | The volume-weighted gross average price of all exchanges up to the date of the report
    Most recent | The most recent recorded price
    Nearest in time | The price recorded nearest in time to the report date

  - Show Multi-currency Totals: If not selected, all totals are shown in the report currency.

  - Sort By: Sort companies by one of

    Name (default) | Company name
    Total Owed | Total amount owed to company
    Bracket Total Owed | Amount owed in oldest bracket. If same, use next oldest

  - Sort Order: One of

    Increasing (default)
    Decreasing

  - Show zero balance items: Show companies even if they have a zero outstanding balance.

  - Due or Post Date: Leading date. Which date to use to determine aging. One of

    Due Date (default)
    Post Date

  - Payable Account: The accounts payable account used to select vendors to be reported. Vendors are included if they have a posted business transaction (usually an invoice) on or before the report date and also meet the Show zero balance items criteria.

- Display tab

  - Address Name: Display vendor address name. This, and other fields, may be useful if copying this report to a spreadsheet for use in a mail merge.

  - Address 1: Display address line 1.

  - Address 2: Display address line 2.

  - Address 3: Display address line 3.

  - Address 4: Display address line 4.

  - Phone: Display address phone number.

  - Fax: Display address fax number.

  - Email: Display email address.

  - Active: Display vendor active status.

#### Printable Invoice

#### Receivable Aging

This report provides a listing of customers and their aged outstanding balances. Customers may be included if they have posted business transactions (e.g. invoices) for the selected accounts receivable account. It shows their current balance, and how much they have outstanding from invoices over time periods 0-30 days, 31-60 days, 61-90 days, and over 90 days. The report also contains links to each customer and to their current customer report.

Optionally, customer address details may be also shown.

To export customer address details, say in order to do a mail merge, select the optional customer address details in the report options display tab, apply the options to regenerate the report, then copy and paste the report into a spreadsheet. Alternatively, the report can be exported to a .html file, then read into a spreadsheet.

##### Report Options

See report-common.title in the Configuring Reports and Charts section of this help manual for more details of the common options.

- General tab

  - Report name: Enter a descriptive name for this report - see report-common.title.

  - Stylesheet: Select a style sheet for this report - see report-common.title.

  - To: Select a date to report on or a named date. Transactions up to and including the selected date will be used to calculate the outstanding aged balances. See report-common.title.

  - Report's currency: Select the currency to display the values in - see report-common.title.

  - Price Source: Select the source of price information used for commodity conversion if needed. One of

    Average Cost | The volume-weighted net average price of all exchanges
    Weighted Average (default) | The volume-weighted gross average price of all exchanges
    Most recent | The most recent recorded price
    Nearest in time | The price recorded nearest in time to the report date

  - Show Multi-currency Totals: If not selected, all totals are shown in the report currency.

  - Sort By: Sort companies by one of

    Name (default) | Company name
    Total Owed | Total amount owed by company
    Bracket Total Owed | Amount owed in oldest bracket. If same, use next oldest

  - Sort Order: One of

    Increasing (default)
    Decreasing

  - Show zero balance items: Show companies even if they have a zero outstanding balance.

  - Due or Post Date: Leading date. Which date to use to determine aging. One of

    Due Date (default)
    Post Date

  - Receivables Account: The accounts receivable account used to select customers to be reported. Customers are included if they have a posted business transaction (usually an invoice) on or before the report date and also meet the Show zero balance items criteria.

- Display tab

  - Address Source: Which customer address fields to display. One of

    Billing (default) | Address fields from billing address.
    Shipping | Address fields from shipping address.

  - Address Name: Display customer address name. This, and other fields, may be useful if copying this report to a spreadsheet for use in a mail merge.

  - Address 1: Display address line 1.

  - Address 2: Display address line 2.

  - Address 3: Display address line 3.

  - Address 4: Display address line 4.

  - Phone: Display address phone number.

  - Fax: Display address fax number.

  - Email: Display email address.

  - Active: Display vendor active status.

#### Tax Invoice

#### Vendor Report

### Income & Expense

The Income & Expense reports includes the Cash Flow and Income Statement reports.

- Cash Flow:

- Equity Statement:

- Expense Barchart:

- Expense Piechart:

- Expense vs Day of Week:

- Income & Expense Chart:

- Income Barchart:

- Income Piechart:

- Income Statement: This report summarizes sources of income and expenditure. (This report was called Profit & Loss in gnucash-1.8.)

- Income vs Day of Week:

- Profit & Loss: This is the same report as the Income Statement but with a different title.

- Trial Balance: This report summarizes sources of income and expenditure.

### Sample & Custom

#### Welcome Sample Report

#### Custom Multicolumn Report

This report is used to place multiple reports into a single report window to examine a set of financial information at a glance.

#### Sample Report with Examples

### Budget

#### Budget Balance Sheet

#### Budget Barchart

#### Budget Flow

#### Budget Income Statement

#### Budget Profit & Loss

#### Budget Report

This report is used to compare budgeted and real amounts for selected accounts. It allows you to review how well you follow the budget.

The report is generated as a table in which each row represents an account and each set of columns shows the budgeted amount, the real amount, and the difference between them for each report period.

Each entry in the real amount column is the sum of all the splits in the row's account over the column's period. For example, if the report is set up for monthly periods, the column is for May, and the row is for Expenses:Groceries, then the value will be the sum of all Expenses:Groceries splits for that May.

The report supports selecting a range of periods instead all of them. Periods that are out of range can be included in the report as the consolidated columns around the selected range. This allows you to focus on particular periods, for example the current one, and is especially useful for budgets with many periods. For example, if you have a 12 period budget you can make a 3 column report with the format "(all periods before columns set) (current period columns set) (all periods after columns set)" that is easily fits on the screen and allows you to match values with account names.

Budget report options

Here we describe only options that are specific for the Budget Report. You can find information about standard parameters in report-config.

- Show budget - include the budgeted values for the period

- Show actual - include the real values for the period

- Show difference - include the difference between budgeted and real values for the period. Enabling this option does not force including budgeted and actual values in the report

- Show Column with totals - Adds a final column set containing budgeted, real value, and difference columns summing those values across all periods of the report.

- Rollup budget amounts to parent - not used in the report, can be deleted or should be fixed

- Include accounts with zero total balances and budget values - enables display of accounts with no budget or splits in any period.

- Budget - Select the budget to use for report generation

- Report for range of budget periods - Enables reporting on a subset of the budget by selecting a beginning and an ending period.

- Range start - a combobox with a list of options to select the start period:

  1. First - select first budget period

  2. Previous - select previous period.

  3. Current - select current period.

  4. Next - select next period.

  5. Last - select last budget period

  6. Manual - enables spinbox where you can select exact period

  The current, previous, and next options select the period based on the date on which the report is run, with current being the period in which the date falls, previous being the one before that, and next the period after. If the current date falls outside the date range covered by the budget, the first or last period will be used as appropriate.

- Exact start period - options for select exact start period, enabled only if the range start option is set to Manual

- Range end - a combobox with a list of options to select the end period. Values are the same as in Range start options

- Exact end period - the same as Exact start period but for the end of range

- Include collapsed periods before selected - if on, then includes in the report all budget periods, that are before selected period range, as a single consolidated column set

- Include collapsed periods after selected - if on, then includes in the report all budget periods, that are after selected period range, as a single consolidated column set.

## Printing or Exporting Reports and Charts

Verify !!! How customize printing with Gnome?

&app; is able to print reports and to export the reports to HTML (web) pages. The Print &app; Document dialog is accessed from the Print button on the Toolbar or go to File Print in the menu. To Export a report to a web page (HTML) select the Export button on the Toolbar and type in a file name.

Most reports, being presented in HTML, can also be copied and pasted into a spreadsheet.

The Print &app; Document dialog is used to select which Printer to send the print job to or to print to a File. It also contains a Preview button to view the document before printing. Press Print to send the job to the selected printer or Cancel to dismiss the Print dialog.

Printing from an open register prints the Account Report, which is also called the Register Report. This lists transactions in the account with a total. Other reports print as viewed in the Report screen.

## Creating Reports and Charts

This section may need updating !!!

It is possible to write reports if the current ones are not suitable. To do this you will need to know Scheme (a LISP-like programming language), and it is an excellent idea to have a copy of the &app; source code available.

The reporting interface is documented in the source code file `src/report/report-system/doc/report-html.txt`. The file `src/report/utility-reports/hello-world.scm` in the &app; source distribution provides a good example of how reports are developed.

### Accessing the &app; API

It is also necessary to access data from the engine to get information for your report. This is since version 2.1.x performed by a set of Scheme wrapper functions that are documented in the file `src/engine/swig-engine.c`. Up to version 2.0.5 it was `src/g-wrap/gnc.html`. Examine some of the other reports in src/scm/report for an indication of how they are used.

Some users started a table in the &app; wiki Custom Reports#The GnuCash API.

Because the above file only contains the syntax of the function you can use the Doxygen source documentation either local after running

    ./configure --enable-doxygen --enable-html-docs
    make doc

on your sources or online http://code.gnucash.org/docs/MAINT/ or http://code.gnucash.org/docs/MASTER/ to get more information about the functions.

### Report Rendering

At present, reports are produced by calling a HTML-generation API, which outputs a dialect of HTML and rendering this with a HTML widget. This has limitations, particularly when trying to align objects precisely, as might be necessary for printing onto pre-printed invoices for example.