Warning, /office/kmymoney/doc/details-reports.docbook is written in an unsupported language. File is not indexed.
0001 <?xml version="1.0" encoding="UTF-8"?> 0002 <chapter id="details.reports"> 0003 <chapterinfo> 0004 <authorgroup> 0005 <author> &Ace.Jones; &Ace.Jones.mail; </author> 0006 <author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author> 0007 </authorgroup> 0008 <date>2022-12-31</date> 0009 <releaseinfo>5.1</releaseinfo> 0010 </chapterinfo> 0011 0012 <title>Reports</title> 0013 0014 <sect1 id="details.reports.issues"> 0015 <title>Known Issues</title> 0016 <para> 0017 Recent updates to this chapter bring it up to date as far as actually 0018 selecting, configuring, viewing, exporting, and saving reports. However, 0019 there are known issues with the content of some reports which will be 0020 addressed in more detail in a future update, both of &kmymoney; itself as 0021 well as this Handbook. These are listed below for your information, and to 0022 avoid surprises and unnecessary bug reports. 0023 </para> 0024 0025 <itemizedlist> 0026 <listitem> 0027 <para> 0028 In some Investment Reports, questions have been raised regarding the 0029 methods used in the calculations related to capital gains, especially 0030 unrealized gains or losses (the difference in value of currently held 0031 securities compared to their original purchase cost.) This is 0032 particularly true when the period of the report does not extend prior to 0033 the purchase and after the sale of any security. 0034 </para> 0035 </listitem> 0036 0037 <listitem> 0038 <para> 0039 In reports involving a data pivot (where columns represent time periods) 0040 if currency conversions are involved, the conversions may not be applied 0041 on the same dates when transactions are not grouped by dates. This can 0042 lead to different values in different reports, where the values might be 0043 expected to be the same. 0044 </para> 0045 </listitem> 0046 0047 <listitem> 0048 <para> 0049 Specifying closed accounts for inclusion in reports does not always work 0050 as expected. Due to interactions between different parts of the report 0051 configuration and generation, it is not always possible to include data 0052 from accounts which are now closed, but which were open during the 0053 specified time frame of the report. 0054 </para> 0055 </listitem> 0056 </itemizedlist> 0057 </sect1> 0058 0059 <sect1 id="details.reports.avail"> 0060 <title>Available Reports</title> 0061 0062 <para> 0063 <screenshot> 0064 <screeninfo>Reports View</screeninfo> 0065 <mediaobject> 0066 <imageobject> 0067 <imagedata fileref="reports_view-all.png" format="PNG" /> 0068 </imageobject> 0069 <textobject> 0070 <phrase>Reports View</phrase> 0071 </textobject> 0072 </mediaobject> 0073 </screenshot> 0074 </para> 0075 0076 <para> 0077 The Reports View lists all available reports, grouped under the following 0078 headings. 0079 </para> 0080 0081 <sect2> 0082 <title>Income and Expenses</title> 0083 <para> 0084 These reports show your income and expenses for the current month or for each 0085 month in the current year. Of course, the duration of the overall report and 0086 the duration captured by each column can be configured to your liking. Graphs 0087 and Pie Charts also may be produced. 0088 </para> 0089 </sect2> 0090 0091 <sect2> 0092 <title>Net Worth</title> 0093 <para> 0094 These reports describe your net worth, either at the current moment, every 0095 month for the current year, or every year of your history. In addition, there 0096 is a 7-day Cash Flow Forecast and a Net Worth Graph. There are also reports 0097 to get the balances for all of your accounts at any given point in time. As 0098 with the Income and Expenses Reports, time periods and groupings can be 0099 configured as desired. 0100 </para> 0101 </sect2> 0102 0103 <sect2> 0104 <title>Transactions</title> 0105 <para> 0106 These reports list individual transactions. This is the best way to print 0107 your account register for a specific period of time. The transactions 0108 included in a report can be grouped together according to your liking by 0109 choosing the appropriate report, such as: 0110 </para> 0111 <itemizedlist> 0112 <listitem><para>By Account</para></listitem> 0113 <listitem><para>By Category</para></listitem> 0114 <listitem><para>By Month or Week</para></listitem> 0115 <listitem><para>By Payee</para></listitem> 0116 </itemizedlist> 0117 <para> 0118 You can also choose the time period for the report. 0119 </para> 0120 </sect2> 0121 0122 <sect2> 0123 <title>Cash Flow</title> 0124 <para> 0125 The Cash Flow Report is similar to a Transaction Report, but it displays all 0126 cash-flow related transactions. 0127 </para> 0128 </sect2> 0129 0130 <sect2> 0131 <title>Investments</title> 0132 <para> 0133 These reports help you keep track of your investments. They only include 0134 investment accounts. There are a variety of presentation filters and styles, 0135 as shown in this partial list. 0136 </para> 0137 <itemizedlist> 0138 <listitem><para> Investment Transactions: Similar to a Transactions Report, 0139 and includes the share price and quantities. </para></listitem> 0140 <listitem><para>Investment Holdings by Account: Shows the current shares, 0141 price, and value for each account.</para></listitem> 0142 <listitem><para>Investment Holdings by Type: Same as the previous report, but 0143 organizes the accounts by type (Stock, Mutual Fund, &etc;)</para></listitem> 0144 <listitem><para>Investment Performance by Account: Shows the annualized 0145 performance over any period of time. This performs a cash flow analysis of 0146 all money coming into and going out of the account. As a result, this is a 0147 very accurate picture of how well your investments are 0148 doing.</para></listitem> 0149 <listitem><para>Investment Performance by Type: Same as the previous report, 0150 but organizes the accounts by type (Stock, Mutual Fund, 0151 &etc;)</para></listitem> 0152 </itemizedlist> 0153 0154 <para> 0155 There are also graphs for Investment Prices and Investment Worth. 0156 </para> 0157 </sect2> 0158 0159 <sect2> 0160 <title>Taxes</title> 0161 <para> 0162 The Tax Reports are just like the Transactions Reports, but only Tax related 0163 categories are included. This allows you to flag certain categories as being 0164 tax-related, and then get one big report at the end of the year to see them 0165 all in one place. They may be listed either by Category or by Payee, and for 0166 the last fiscal year. 0167 </para> 0168 </sect2> 0169 0170 <sect2> 0171 <title>Budgeting</title> 0172 <para> 0173 These reports are similar to the Net Worth Reports, but they can display the 0174 budget for a given year, and can compare it to the actual income and expenses 0175 for the same period. 0176 </para> 0177 </sect2> 0178 0179 <sect2> 0180 <title>Forecast</title> 0181 <para> 0182 These reports are just like the Net Worth Reports, but they use the 0183 information to display forecast information. You can display the information 0184 at various levels and for the time frame of your choosing. 0185 </para> 0186 </sect2> 0187 0188 <sect2> 0189 <title>Information</title> 0190 <para> 0191 These reports display non-transaction information about schedules, accounts, 0192 and loans. 0193 </para> 0194 </sect2> 0195 0196 <sect2> 0197 <title>Charts</title> 0198 <para> 0199 If <link linkend="details.reports.charts">Charts</link> are enabled, this 0200 section lists all the reports which are marked to display a graphical chart as 0201 the default. They are also listed in one of the other sections, but they are 0202 also aggregated here for your easy reference. 0203 </para> 0204 </sect2> 0205 0206 <sect2> 0207 <title>Favorite Reports</title> 0208 <para> 0209 This section lists all the reports you have marked as a favorite in the report 0210 configuration dialog. They are still listed in one of the other sections, but 0211 they are also aggregated here for your easy reference. Favorite reports are 0212 also included on the financial summary page for even easier reference. 0213 </para> 0214 </sect2> 0215 </sect1> 0216 0217 <sect1 id="details.reports.working"> 0218 <title>Working With Reports</title> 0219 0220 <para> 0221 There are a number of actions you can take on each report. You can access 0222 some of these by right-clicking the report name in the list of reports, and 0223 selecting the action from the context menu. These include: 0224 </para> 0225 0226 <itemizedlist> 0227 <listitem> 0228 <para> 0229 Open: this runs the report and displays the results. This is the same 0230 action as if you double clicked on the report name. 0231 </para> 0232 </listitem> 0233 0234 <listitem> 0235 <para> 0236 Print: this is the same as running the report and then selecting the 0237 <menuchoice><guimenu>File</guimenu><guimenuitem>Print</guimenuitem></menuchoice> 0238 menu item. 0239 </para> 0240 </listitem> 0241 0242 <listitem> 0243 <para> 0244 Configure: change the properties of this report. You can customize the 0245 report to your liking and save it for future use. For more details, see 0246 the next section. 0247 </para> 0248 </listitem> 0249 0250 <listitem> 0251 <para> 0252 New report: this creates a copy of the report and opens the configuration 0253 dialog. 0254 </para> 0255 </listitem> 0256 0257 </itemizedlist> 0258 0259 <para> 0260 Alternately, once you have run a report, there are buttons across the top of 0261 the view to invoke each of these actions: 0262 </para> 0263 0264 <itemizedlist> 0265 <listitem> 0266 <para> 0267 Chart: This is only enabled if the report is capable of displaying a 0268 chart. Clicking on it toggles between the report and the chart. 0269 </para> 0270 </listitem> 0271 0272 <listitem> 0273 <para> 0274 Configure: as described above. 0275 </para> 0276 </listitem> 0277 0278 <listitem> 0279 <para> 0280 New: as described above. 0281 </para> 0282 </listitem> 0283 0284 <listitem> 0285 <para> 0286 Copy: this copies the report output to the clipboard to paste it in 0287 another application, like a spreadsheet, for further analysis or 0288 manipulation. 0289 </para> 0290 </listitem> 0291 0292 <listitem> 0293 <para> 0294 Export: the content of a report can be saved in &HTML; or CSV format. 0295 </para> 0296 </listitem> 0297 0298 <listitem> 0299 <para> 0300 Delete: customized reports can be deleted. The default reports that ship 0301 with &kmymoney; cannot be deleted. 0302 </para> 0303 </listitem> 0304 0305 <listitem> 0306 <para> 0307 Close: close the current report. 0308 </para> 0309 </listitem> 0310 </itemizedlist> 0311 </sect1> 0312 0313 <sect1 id="details.reports.config"> 0314 <title>Configuring Reports</title> 0315 0316 <sect2> 0317 <title>Working with custom reports</title> 0318 <para> 0319 You can configure the default reports or create your own from them by 0320 selecting 'New' and then configuring the new report. When you select 0321 'Configure' you will be presented with the Report Configuration Dialog, with 0322 the Report Tab selected. Initially, the new report is named the same as the 0323 old report with <quote>(Customized)</quote> added to the end. You can change 0324 the name to whatever you want. You can even name your custom reports the same 0325 as a default report, or the same as another custom report. Also, you can 0326 always use the Comment field to further distinguish reports. 0327 </para> 0328 0329 <para> 0330 The Report Configuration dialog has a number of tabs across the top, with 0331 subtabs below them. Each tab displays options for configuring different 0332 aspects of the report. 0333 </para> 0334 </sect2> 0335 0336 <sect2><title>Budgets</title> 0337 <para> 0338 The configuration dialog for reports which display amounts over time may 0339 include budget related settings. These are only enabled if you do have one or 0340 more budgets defined, and include a drop-down to select one of those 0341 budgets. If one is selected, the report will show the budgeted amount per 0342 time period rather that the actual amounts from transaction in that period. 0343 In addition, some reports may also give you the option of displaying both the 0344 bugdeted and actual amounts, so you can compare them. 0345 </para> 0346 </sect2> 0347 0348 <sect2><title>Report Tab</title> 0349 <para> 0350 <screenshot> 0351 <mediaobject> 0352 <imageobject> 0353 <imagedata fileref="report_configuration-reporttab.png" format="PNG" /> 0354 </imageobject> 0355 <textobject> 0356 <phrase>Report Configuration -Report</phrase> 0357 </textobject> 0358 </mediaobject> 0359 </screenshot> 0360 Note that this screenshot shows the old names of the Criteria and Result Tabs, 0361 which have been changed to Report and Filters. Different reports will show 0362 different subsets of the subtabs, appropriate for configuring that particular 0363 report. In addition, many of the subtabs have been moved from from the Report 0364 Tab to the Filters Tab. 0365 </para> 0366 0367 <sect3> 0368 <title>General Subtab</title> 0369 <para> 0370 Here you set the basic properties of this report. 0371 <itemizedlist> 0372 <listitem> 0373 <para> 0374 Report Name: Choose a name for this report. 0375 </para> 0376 </listitem> 0377 0378 <listitem> 0379 <para> 0380 Comment: Enter a comment to help you remember the details of 0381 this report, or to distinguish reports with the same name. 0382 </para> 0383 </listitem> 0384 0385 <listitem> 0386 <para> 0387 Convert values to base currency: Select this option to convert all values 0388 in the report to your base currency. Leave it unchecked to see values in 0389 their original currency. If currencies are not converted, then subtotals 0390 will not be shown. 0391 </para> 0392 </listitem> 0393 0394 <listitem> 0395 <para> 0396 Mark as favorite report: Check this to cause this report to show up on the 0397 home page and in the group of <guilabel>Favorite Reports</guilabel>. 0398 </para> 0399 </listitem> 0400 0401 <listitem> 0402 <para> 0403 Skip value if price is zero: This is only enabled for investments reports 0404 which show prices instead of balances. Select this option to include 0405 prices only if there is an actual price for the date. If not, 0 will be 0406 shown. In the graph, the value will be skipped. 0407 </para> 0408 </listitem> 0409 </itemizedlist> 0410 </para> 0411 </sect3> 0412 0413 <sect3 id="details.reports.config.rowscolumns"> 0414 <title>Rows/Columns Subtab</title> 0415 <para> 0416 This is where you configure the selection and organization of the rows and 0417 columns shown in the report. This tab presents different configuration 0418 options depending on the type of report you have selected. 0419 </para> 0420 0421 <para> 0422 <screenshot> 0423 <mediaobject> 0424 <imageobject> 0425 <imagedata fileref="report_configuration-rowscolumns.png" format="PNG" /> 0426 </imageobject> 0427 <textobject> 0428 <phrase>Report Configuration -Rows and Columns</phrase> 0429 </textobject> 0430 </mediaobject> 0431 </screenshot> 0432 </para> 0433 0434 <para> 0435 For Income and Expenses and for Net Worth reports: 0436 <itemizedlist> 0437 <listitem> 0438 <para> 0439 Budget: see discussion above 0440 </para> 0441 </listitem> 0442 0443 <listitem> 0444 <para> 0445 Show totals column: Check this to display a column showing the total 0446 for each row. 0447 </para> 0448 </listitem> 0449 0450 <listitem> 0451 <para> 0452 Show totals row: Check this to display a row showing the total for 0453 each column. 0454 </para> 0455 </listitem> 0456 0457 <listitem> 0458 <para> 0459 Rows: Choose what kind of accounts to display as the rows of this 0460 report 0461 </para> 0462 </listitem> 0463 0464 <listitem> 0465 <para> 0466 Detail: Choose the level of detail required for this report. The 0467 following levels of detail are available: 0468 <itemizedlist> 0469 <listitem> 0470 <para> 0471 All: Show every category or account. 0472 </para> 0473 </listitem> 0474 0475 <listitem> 0476 <para> 0477 Top-Level: Show only the highest-level categories or accounts, 0478 and roll up the sums of the subordinate categories or accounts 0479 into those values. 0480 </para> 0481 </listitem> 0482 0483 <listitem> 0484 <para> 0485 Groups: Show only the totals of the categories or accounts. 0486 </para> 0487 </listitem> 0488 0489 <listitem> 0490 <para> 0491 Totals: Show only the grand totals row. 0492 </para> 0493 </listitem> 0494 </itemizedlist> 0495 </para> 0496 </listitem> 0497 0498 <listitem> 0499 <para> 0500 Average days: Only enabled for relevant reports. Set how long of a 0501 time period each column should encompass. 0502 </para> 0503 </listitem> 0504 0505 <listitem> 0506 <para> 0507 Columns: Choose how large of a time period each column should encompass 0508 </para> 0509 </listitem> 0510 0511 <listitem> 0512 <para> 0513 Include scheduled transactions: Check this to include scheduled 0514 transactions that have not yet been entered. 0515 </para> 0516 </listitem> 0517 0518 <listitem> 0519 <para> 0520 Include transfers: Unless you check this, transfers are excluded from 0521 transaction reports. 0522 </para> 0523 </listitem> 0524 0525 <listitem> 0526 <para> 0527 Include unused accounts/categories: Unless you check this, rows which 0528 would have zero values are not displayed. 0529 </para> 0530 </listitem> 0531 </itemizedlist> 0532 </para> 0533 0534 0535 <para> 0536 For Transactions reports: 0537 <itemizedlist> 0538 <listitem> 0539 <para> 0540 Organize by: Choose how to group the transactions in this report. 0541 </para> 0542 </listitem> 0543 0544 <listitem> 0545 <para> 0546 Show Columns: Choose which transaction details should be shown in the 0547 report. The date and transaction amount are always shown. 0548 </para> 0549 </listitem> 0550 0551 <listitem> 0552 <para> 0553 Include only Tax categories: Only show categories which have been 0554 marked as tax-related. 0555 </para> 0556 </listitem> 0557 0558 <listitem> 0559 <para> 0560 Include only Investment accounts: Only show transactions from 0561 investment accounts. 0562 </para> 0563 </listitem> 0564 0565 <listitem> 0566 <para> 0567 Include only Loan accounts: Only show transactions from Loan accounts. 0568 </para> 0569 </listitem> 0570 0571 <listitem> 0572 <para> 0573 Include transfers: Unless you check this, transfers are excluded from 0574 transaction reports. 0575 </para> 0576 </listitem> 0577 0578 <listitem> 0579 <para> 0580 Hide Split Transaction Details: Do not display the detailed splits, 0581 just the overall account details. 0582 </para> 0583 </listitem> 0584 0585 <listitem> 0586 <para> 0587 Hide Transactions: Do not display the transactions, leaving only the totals 0588 displayed. 0589 </para> 0590 </listitem> 0591 0592 <listitem> 0593 <para> 0594 Hide Totals: Only display the transactions, not the totals. 0595 </para> 0596 </listitem> 0597 </itemizedlist> 0598 </para> 0599 </sect3> 0600 0601 <sect3> 0602 <title>Chart Subtab</title> 0603 0604 <para> 0605 This tab allows you to configure what the report looks like when it is 0606 displayed as a chart. See the <link linkend="details.reports.charts">Graphs 0607 & Charts</link> section for more explanation of the charting functions. 0608 0609 <itemizedlist> 0610 <listitem> 0611 <para> 0612 Chart Type: The visual format of chart desired. 0613 </para> 0614 </listitem> 0615 0616 <listitem> 0617 <para> 0618 Chart Palette: Select from several possible color palettes for the 0619 chart. 0620 </para> 0621 </listitem> 0622 0623 <listitem> 0624 <para> 0625 Show grid lines: Whether to display horizontal and vertical grid lines 0626 on the chart for line, bar, and stacked bar charts; circular and 0627 saggital grid lines for pie and ring charts. 0628 </para> 0629 </listitem> 0630 0631 <listitem> 0632 <para> 0633 Draw values on chart: Whether to print the data values on the chart for 0634 chosen data points. 0635 </para> 0636 </listitem> 0637 0638 <listitem> 0639 <para> 0640 Show chart by default: Whether this report should first be displayed as 0641 a chart when it's opened instead of as a tabular report. 0642 </para> 0643 </listitem> 0644 0645 <listitem> 0646 <para> 0647 Logarithmic vertical axis: Only enabled when relevant - use a logarithmic 0648 instead of linear scale for the vertical axis. 0649 </para> 0650 </listitem> 0651 0652 <listitem> 0653 <para> 0654 Plot expenses downward: If not checked, then both income and expenses 0655 are plotted upwards. 0656 </para> 0657 </listitem> 0658 0659 <listitem> 0660 <para> 0661 Line width: The width of data lines on the chart. 0662 </para> 0663 </listitem> 0664 </itemizedlist> 0665 </para> 0666 </sect3> 0667 0668 <sect3><title>Range Subtab</title> 0669 <sect4><title>Date range</title> 0670 <para> 0671 Use this section to specify the date range of transactions to be included in 0672 the report. The <guilabel>Range</guilabel> drop-down includes a large number 0673 of predefined ranges, but you can select <quote>User defined</quote> and 0674 manually set <guilabel>From</guilabel> and <guilabel>To</guilabel>. The 0675 <guilabel>Ticks</guilabel> drop-down specifies the placement of tick marks on 0676 the horizontal (time) axis of the chart. 0677 </para> 0678 </sect4> 0679 0680 <sect4><title>Data range</title> 0681 <para> 0682 This specifies the tick marks and divisions on the vertical axis of the chart. 0683 It is generally best to leave the <guilabel>Range</guilabel> drop-down set to 0684 <quote>Automatic</quote>. 0685 </para> 0686 </sect4> 0687 </sect3> 0688 </sect2> 0689 0690 <sect2> 0691 <title>Filters Tab</title> 0692 <para> 0693 The subtabs here are the same as the tabs in the Search Transactions 0694 interface. Please refer to the <link 0695 linkend="details.search">documentation</link> on that interface for details on 0696 their use. 0697 </para> 0698 </sect2> 0699 </sect1> 0700 0701 <sect1 id="details.reports.charts"> 0702 <title>Graphs & Charts</title> 0703 0704 <sect2> 0705 <title>Viewing as a Chart</title> 0706 0707 <para> 0708 Each report can be viewed in either textual form or graphical (chart) form. 0709 The same report configuration parameters are used in either case. You can 0710 easily jump back and forth between the textual and graphical forms by pressing 0711 the <guibutton>Chart</guibutton> or <guibutton>Report</guibutton> button along 0712 the top of the report. 0713 </para> 0714 0715 <para> 0716 You should take care to limit the amount of data you choose to display on a 0717 chart. If you are not careful, using the same configuration for both textual 0718 and graphical forms means it's possible to configure a chart to be visually 0719 cluttered, unappealing, and uninformative. &kmymoney; will not force you to 0720 keep your charts readable and useful! 0721 </para> 0722 </sect2> 0723 0724 <sect2> 0725 <title>Available Chart Types</title> 0726 0727 <sect3> 0728 <title>Line Graph</title> 0729 0730 <para> 0731 A line graph is one of the most simple forms of a chart. There is one line 0732 for each series. (Usually a series is a single account or category; see below 0733 for more details on that.) The time periods stretch out along the bottom 0734 axis, and the currency values are along the left. 0735 </para> 0736 0737 <para> 0738 The detail level for each line is controlled in the <link 0739 linkend="details.reports.config.rowscolumns">Rows/Columns</link> Tab of chart 0740 configuration. If you choose the <quote>Top-Level</quote> detail level, there 0741 will be one line for each of the top-most accounts or categories, which shows 0742 the sum total of all underlying accounts or categories. If you choose 0743 <quote>Groups</quote>, it will instead show one line for each Income, Expense, 0744 Asset, or Liability depending on the other settings. 0745 </para> 0746 </sect3> 0747 0748 <sect3> 0749 <title>Bar Graph</title> 0750 0751 <para> 0752 The bar graph works exactly the same as the line graph, except there is one 0753 bar for each series in each time slice. 0754 </para> 0755 </sect3> 0756 0757 <sect3> 0758 <title>Pie Chart</title> 0759 0760 <para> 0761 The pie chart is the most simple chart available. It shows data at only one 0762 time slice, as opposed to showing the values across time. This chart shows 0763 the values from only the totals column of whatever report is selected. If 0764 your report is configured to NOT convert values to the base currency, there 0765 will be no totals column, and therefore this report is not useful. 0766 </para> 0767 </sect3> 0768 0769 <sect3> 0770 <title>Ring Chart</title> 0771 0772 <para> 0773 The ring chart is very similar to a pie chart, except there is one 0774 <quote>ring</quote> for each time slice in the report. 0775 </para> 0776 </sect3> 0777 </sect2> 0778 </sect1> 0779 </chapter>