diff --git a/doc/details-impexp-csv.docbook b/doc/details-impexp-csv.docbook
index 854c6e8ba..60f03fd5a 100644
--- a/doc/details-impexp-csv.docbook
+++ b/doc/details-impexp-csv.docbook
@@ -1,660 +1,660 @@
&Allan.Anderson; &Allan.Anderson.mail; CSV Importer PluginReasons for importing CSV Files
In general, it is preferable to import OFX. However, not all institutions
provide data in that format. CSV (comma separated value) files are almost
always available, sometimes described as Excel or spreadsheet files. Also,
they can often be created fairly easily by capturing the data you want to
import, such as in a text file, and manually editing it.
The primary focus of the plugin is on importing data from bank statements, but
there is also a capability to import some investment statements. This plugin
was initially created, before becoming a CSV importer, to produce QIF files
from CSV, which could then be imported. This functionality is still present,
but is likely to be removed, as the plugin now focuses on directly importing
CSV files. Also, &kmymoney; has the native ability to export QIF files, so there is no real
reason to produce a QIF file from a CSV file.
Getting the plugin
&kmymoney; will import CSV files. This functionality is provided as a plugin,
and it is now built into the core program, both in distro packages and in the
source files. Once the distro package is installed, or the source files are
compiled and installed, the menu choice to import CSV files will automatically
show up under the
FileImport
menu.
The CSV importer plugin is much newer than the OFX plugin, but most
distributions are now built with the CSV importer already included or
available as a separate package. Ensure that it is enabled within &kmymoney;.
Check the SettingsConfigure
KMyMoneyPlugins menu.
If the CSV importer does not seem to be installed in your version, the first
place to check is in the same place you got your base &kmymoney; package. See
if a later version is available, or if the importer is available as a separate
package.
If you have installed from RPM or Deb, the CSV Importer Plugin should be
contained within the &kmymoney; package. If you have built from source, there
should be no additional requirements. The &kmymoney; build process should
detect the plugin source and compile the plugin.
Importing a CSV file
To import a CSV file, choose the importer from the menu bar:
FileImportCSV....
If CSV does not show up under Import, you do not have the CSV Importer Plugin
installed correctly. Please see the previous section.
The CSV Importer is in the form of a wizard, with a separate page for each
individual step of the process. There may be some minor differences between
the text in this handbook, the labels in the screenshots, and the labels you
actually see in the wizard. In such cases, the handbook describes what the
wizard will look like in the next release.
CSV Import Wizard: Start
When started, the CSV Importer displays the Start
page. The upper area, where data will be displayed, is initially empty.
Below that, on the left, is a list of the steps of the import process, with
the current one highlighted. To the right of that are some brief instructions
and two radio buttons, allowing the choice of either
Banking or Investment. Next there is
a profile selector box, which is enabled once one of the radio buttons has
been selected. At the bottom of the display are buttons to move on to the
next step of the wizard, go Back to the previous step,
or Cancel the import. At the initial step, there is
also a button Select File to initially select the file to
import.
Also, note the Skip setup checkbox next to the profile
selector. Initially, you should not select this check-box. Once you have set
up a profile and finished the wizard, those parameters are saved in the
resource file. Next time you use that same profile, the parameters will be
loaded into the UI (User Interface). The wizard would then plod through the
following pages of parameters that you won't need to change. So, instead,
once you are happy with a profile, it may be helpful to check this box. The
wizard will then move directly to the final page, and, assuming no problems
are found, you just have to click Import.
First select either Banking or
Investment, then click in the selector box, which displays
"Add New Profile." If you have previously created any profiles, you can
select one of them, otherwise enter a new profile name, possibly the name of
the account into which you wish to import. If you enter a new profile name,
hit &Enter; to create it. Then, click on Select File,
and a standard file selector box will open, from which you should select the
CSV file you wish to import.
CSV Import Wizard: Separators
The wizard will now have advanced to the Separators page,
and you should now see your data.
It may appear that the displayed entries in the upper section of the
plugin window may be edited, and in fact they may, but any edits are not
kept. The table is purely for display, not for editing. The input file
is never altered by the plugin, and the data actually imported comes from
the input file, not from the display. The one exception to this is
covered in Securities and
Symbols below.
The plugin should have detected the appropriate Field
Separator to use, and it is not usually possible to select a
different one. In fact, attempting to do so will reset any field choices you
may already have made. There is also a selector for the Text
Delimiter, but generally the quote (") is correct. Now click on
the Next button. Depending upon the earlier selection
you made, you will now be on either the Banking page or the Investment page.
CSV Import Wizard: Banking
On this page, you select the column numbers from which to import the relevant fields.
For most fields, you just need to use the appropriate dropdown to select the
appropriate column. However, there are a few special considerations.
In the center are two radio buttons. If your file has a single column for all
values, select Amount col. However, if there are separate
columns for debits and credits, select Debit/credit col.
This will enable either the Amount column selector or the
Debit column and Credit column
selectors.
It is possible to select more than one column for the Memo field, by
consecutive selections. Memo columns already selected are marked in the
drop-down with an asterisk (*). If you select multiple columns in this way,
their contents will be concatenated in the Memo field.
If you attempt to choose the same column number for two fields, the plugin
will alert you and clear both selections. However, it is possible, if
desired, to use the same column in both the
Payee/Description and Memo fields.
If you select a column for the Payee/Description field,
and then select the same field for the Memo field, you
will receive a warning that duplicate columns have been selected, but asking
if you wish to proceed. If you do, click Yes.
One particular reason to also capture the Payee/Descriptor field in the Memo
field is that the incoming Payee/Description field might get completely
changed on import when &kmymoney; does transaction matching. Selecting that
field also as Memo will preserve that data, which would otherwise get lost.
If you notice you have made an incorrect choice, just change that selection.
If several changes need to be made, click the
Clear button.
Once columns have been chosen for all the necessary fields, the
Next button will be enabled, and clicking it will advance
the wizard.
CSV Import Wizard: Investment
This page is similar to the Banking page, although it
is somewhat more complex. Most selections are fairly obvious, but there are
some items which can seem confusing until you have completed the process
once or twice.
As on the Banking page, you may select more than one
column for the Memo field
The Type/Action selector is to identify the column which
- contains the action type, such as Buy, Sell, Dividend, etc.
+ contains the action type, such as Buy, Sell, Dividend, &etc;
The Price Fraction selector is to indicate the
fraction/multiplier for compatibility between imported and stored prices. For
instance, if the import file price is in cents, but your &kmymoney; account is
priced in dollars, select 0.01. Or, if your &kmymoney; data file pricing is
in dollars, and so is the CSV file being imported, then set Price
Fraction to 1.0.
Use the Fee Column selector if your file has a distinct
column for fees. Beware, though, that the fee might have been taken into
account in the price. If there is a fee, and it is a percentage figure,
rather than a value, click the Fee is percentage check
box. Note that on this page, this is the only field to explicitly include
"column" in the label, to emphasize that it is for the fee column, not for any
actual fee.
Below the column selectors are two areas for the security identity. Depending
upon your broker or financial institution, your file may contain entries for
only one or for several securities.
If the file contains transactions for just a single security, with the name
possibly in a header row, the name should be entered into the
Security Name box. The name you enter will be added to
the drop-down list for future use. You may subsequently wish to remove that
name from the list. If so, select it, then click the Hide
security button. This removes it only from this list, and has no
effect on your main &kmymoney; file.
If the file includes transactions for several securities, each will be
identified by its ticker symbol in a column with further detail in another
column. Select those columns in the Symbol and
Detail selectors. It may be that a security has no
official symbol, and in this case a pseudo-symbol may be invented; this is not
a problem, as long as it uniquely identifies that security in the import file.
Sometimes the actual activity type is embedded in the detail column, possibly
prefixed by a standard text. For instance, if the field contains type:
dividend, enter into the Filter text box
type: including the trailing space.
When all required fields are selected,
the Next button will be enabled, and clicking it will
advance the wizard.
CSV Import Wizard: Lines
On this page, you indicate if any lines should be ignored at the beginning or
end of the file. You also indicate the format of any date column.
Start line
Set this so the importer skips any header lines in the file. Your choice will
be saved in this profile for future use. The start and end lines interact, and
the start line may not be higher than the end line. If the Start
line selector does not respond, check the end line setting.
End line
The importer will automatically set this to the last line in the file, or to
the setting last saved. You will only need to adjust it if there are footer
lines in the file the importer should ignore. Otherwise, you are likely to
get a data error warning when the plugin attempts to parse incorrect
data. Again, if the End line selector does not respond,
check the Start line setting.
Date format
This needs to be set according to the order of year, month, and day in the
dates in the file. If the plugin finds data incompatible with this setting,
it will complain when you try to import. However, if the setting is wrong,
but does not produce invalid results (such as data with no days higher than 12,
so month and day could be switched) you will simply get incorrect data,
because the plugin cannot know you made a mistake. In this case, the error will be
obvious in the ledger after import.
Once ready, the Next button will be enabled, and clicking
it will advance the wizard.
CSV Import Wizard: Securities and Symbols
For an Investment file, after the Lines page has been
accepted, you need to assure that each security in the file is matched to the
correct security in your &kmymoney; file, before import can proceed. At this
point, another window will open, showing the securities and symbols contained
in the import file. Note that unlike the data display in the main wizard
windows, the changes you make on this page are imported.
Completing this page is straightforward, if you consider these items:
Each row represents one transaction, and so it may appear there are
duplicate rows. This is OK.
Each security name must match exactly the existing security as specified
in &kmymoney;. If it does not match, it will be created as a new
security, which you probably do not want, unless it represents the
purchase of a new security.
A symbol must be shown for each security.
The only information on this page should be the
security symbol and name. Any other information initially shown (such as
date or activity type) is still in the actual import file, but should not
be shown here.
You can edit a symbol or security name by double clicking the cell. For
each security, if necessary, edit the name in one of its rows, If the correct
security name appears in the imported file, double click on it to select it,
then copy and paste/edit, taking care if you have used a variation or
abbreviation within &kmymoney;. If you edit a security name, that edit will
be applied to all rows with the same symbol.
Any line without a symbol will be treated as a brokerage-type checking
item. If any transaction involves another account, ⪚, a checking or
brokerage account for a received dividend or for making a payment, a message
box will pop up for the account name to be entered for the transfer. This
will generally be the Brokerage account you chose or created when you created
the Investment account. Similarly enter the column number containing the
payee, if requested. If a mistake is made when entering the account name, the
import will go ahead, but &kmymoney; will not recognize it, and will flag
those transactions as missing a category assignment. If the required account
name is rather long, just enter a few characters. The import will proceed but
the transactions will be flagged by &kmymoney; as missing a category
assignment, and you will need to select the correct transfer account after the
import. Click OK when done. The import process then gets
handed over to
&kmymoney;
If you have more that one transaction referring to the same security, you can
edit all of them at once, using multi-select. For instance, to add a symbol for
- several lines, press and hold the CTL key, and in the symbol column,
- select each transaction. While still holding the CTL key,
+ several lines, press and hold the &Ctrl; key, and in the symbol column,
+ select each transaction. While still holding the &Ctrl; key,
all those symbol cells should still be selected, so click on one and enter the
symbol. Click inside the window but outside that column, or hit
- Enter (not OK). Now that those
+ &Enter; (not OK). Now that those
transactions all have the same symbol, double click one detail entry and edit
the security name as you wish. Click elsewhere on the window (or
- Enter) to accept the edit, which will then change all
+ &Enter;) to accept the edit, which will then change all
those entries. The remaining entries will show the symbols picked up from the
transactions in the import file.
Now click OK, then Import. In the
Enter Account box, enter the name of a Brokerage/checking
account for funds. If you enter a valid name that account will be used. If
you can't be bothered entering a correct but long name, enter a few
characters. The import will accept that but the transactions in the ledger
after import will need a proper account to be selected. For the
Brokerage Item box, enter the number of the column
containing that detail. Now, on the Invalid transaction
box you may get a few entries because the activity type does not match the
qty/price/amount combination. On each message, click Select
Transaction Type, and a drop down will appear indicating valid
activity types for that combination of values.
Now the import has occurred and you're into KMM to select the investment
account to use. Then the checking account, if there were any brokerage type
transactions.
CSV Import Wizard: Finish
On reaching the Final page, the plugin automatically validates the values. If
the numeric value column/s is/are highlighted in green, then the validation
was successful and all that is necessary is to click Import
CSV and control then passes to the main &kmymoney; program.
However, if the start and/or end lines are incorrectly set, or if the wrong
columns were selected, the highlighting will be in red, and an error message
will appear indicating where the error lies. The user will then need to click
Back to get to the relevant page to correct the error.
It might also be that if debit and credit columns are in use, one of those
columns may legitimately contain no entries. This would mean that that column
has no decimal symbol present, and this would result in a warning. If you see
that this is the case, you may click either of the Accept
buttons (Accept this or Accept all.)
Decimal Symbol
Another possible problem might be that the selected decimal symbol is
incorrect. Selecting the symbol to match the data should clear that error.
Normally, you should not need to change this selection. Note that the
Decimal Symbol must be set to match your file, not your
locale. If your locale setting has a different value, conversion will be seen
to take place. The display of the file in the upper part of the window will
show numeric fields highlighted in green if the current setting produces valid
results, otherwise in red. The highlighting also reflects the Start
line and End line settings. There could be
warnings if any of the selected cells appear not to contain the selected
symbol.
Thousands Symbol
This does not need to be selected, as it is set automatically based on the
Decimal Symbol. It is provided purely as a guide. In
addition, the selector will be inactive if none of the values to be imported
is greater or equal to 1000.
Import CSV
Clicking this button tells the plugin to actually import the data from the
file, based on the choices you have made above. &kmymoney; will prompt you
for the correct account into which to import the data.
Make QIF File
This button gives you the ability, after the import has been completed, to
save the data from the csv file as a qif file, should you require one for any
reason. This was actually the original functionality that drove the creation
of this plugin. However, as &kmymoney; itself is now able to export a qif
file, the capability is now probably of little use and is likely to be removed
eventually.
Finishing up
For a Banking import, the plugin has finished, and
&kmymoney; will prompt you, as stated above, for the correct account into
which to import the data. For an Investment import,
however, a little more may be required. If, during import of a transaction,
the plugin finds no valid transaction type, it will display the offending
transaction, and the user may select a valid type to substitute, depending on
the combination of quantity, price, and amount values. For every transaction,
the plugin will validate the column contents to ensure they match the action
type. For instance, if a quantity appears but no price or amount, it is
assumed that the transaction can be only an Add or Remove Shares. Or, if
- there is an amount but no quantity or price, then a Dividend is assumed, etc..
+ there is an amount but no quantity or price, then a Dividend is assumed, &etc;.
If you wish to save your settings, remember to click the
Finish button, and the plugin will then close.
Adding Investment Activity Types
If you find that your investment statements keep including activity types that
are not recognized, just add them to the section in the resource file. (See
below for more details on
this file.) For instance, in the [InvestmentSettings] section of the file,
the BuyParam field includes entries for Purchase, Buy, New Inv, and Switch In.
If you find a different one, add it to the correct list and restart the
plugin. You may notice that there are similarities in the entries in
different fields, and you may find that the wrong activity type is being
selected. The plugin checks these lists in the following order: Shrsin, DivX,
Reinvdiv, Brokerage, Buy, Sell, Remove. Re-ordering the lists to suit this
does not work as might be expected, since the entries in the resource file get
sorted into alphabetical order. If the offending parameter is one you don't
need, just delete it from the file. If that is not possible, you may need to
edit your file before input.
Configuration of CSV importer plugin
A well-known drawback of QIF format is that it is a fairly loose format.
With CSV files, there is this same problem, only more so, in that there is
no agreed standard at all. With investment files, in particular, there is
much more scope for variation in specifying the different types of activities
represented in the data. The plugin handles this by listing these activity
types in a resource file, called csvimporterrc. The location of this file
depends on your distribution. It will usually be located in ~/.kde4/share/config/,
or in ~/.kde/... instead. Using this resource file allows the user to add an
activity type that the developer had not encountered. If the file does not
exist when the importer first runs, the plugin will create a default version,
containing a few of the more obvious descriptions.
A number of sample csv files are provided (in the kmymoney/contrib/csvimporter/
folder in the source tree) in the hope that they may help. For example, in the
investment sample, an activity type is "ReInvestorContract Buy : ReInvested Units".
In the validation process, the first successful match is on the ReInv in
ReInvestorContract Buy, so the transaction therefore gets classed as Reinvdiv,
even though Buy also is mentioned. Another example which has been observed is an
activity type of Reinvest even though the transaction included neither price nor
amount, but only a quantity, so that needed to be treated as Add Shares, or Shrsin.
When this plugin was created, only a few investment formats had been seen as
examples, and it may well be that you will encounter one which cannot be
handled correctly. If you find such a file, please send a suitable example
(edited to remove or replace personal information) to the &kmymoney; user list
&userlist; or developer list &devlist;, the developer will do his best to
modify the plugin to handle it.
diff --git a/doc/details-impexp.docbook b/doc/details-impexp.docbook
index 6ec8fc2f6..07f750035 100644
--- a/doc/details-impexp.docbook
+++ b/doc/details-impexp.docbook
@@ -1,1146 +1,1146 @@
&Ace.Jones; &Ace.Jones.mail; 2011-07-34.6Importing and Exporting&Tony.Bloomfield; &Tony.Bloomfield.mail;GnuCash ImporterGnuCash Files
The &kmymoney; GnuCash importer handles direct reading of standard (&XML;)
files as produced by GnuCash versions 1.8 and 2.0. The following are not
supported:
import of database (Postgres) dataimport of 'multi-book' filesimport into an existing &kmymoney; fileimport of small-business specific features (Employees,
- Invoices, etc.)
+ Invoices, &etc;)
export to GnuCash files.
The import will probably only work correctly if presented with a valid
file. It is recommended that the GnuCash Check & Repair All function (in
the Actions menu) be run before attempting to import.
Files can be opened by specifying the filename on the command line
(kmymoney <path to file>), or by means of the &kmymoney;
&Ctrl;OFileOpen or
FileImport menu items.
The similarity between the two products means that much day-to-day data can be
imported in a straightforward fashion. However, there are some areas where
differences arise, and various options are provided to deal with these. The
following sections will describe some of these differences; understanding them
should lead to a smoother importation.
Similarities, Differences, and TerminologySmall Business Usage
It should be noted that &kmymoney; is a personal finance
manager, and as such, does not directly support any of the business features
of GnuCash, such as tax tables, payroll, and tracking of lots. Any Accounts
Payable or Receivable accounts found in a file will be imported as Liability
or Asset accounts respectively.
AccountsAccount types
For both products, the highest level of structure in the file is the
account. &kmymoney; supports 5 main types of account: Asset, Liability,
Income, Expense and Equity, each of which may have various subtypes, ⪚,
Checking, Credit Card, &etc; &kmymoney; includes a 'standard' account for
each of these five types, and all other accounts are held subordinate to one
of these. &kmymoney; enforces more consistency (or less flexibility, depending
on your point of view) between account types than does GnuCash, and the
importer will correct any inconsistencies it detects. This may result in a
slightly different account structure, though this can, within reason, be
amended after the import is complete.
Categories
&kmymoney; uses the term Category to denote an account of an Income or Expense
type. Unlike GnuCash, these are not considered as 'ledger' accounts, and entry
of transactions folder into categories is not supported; allocations are made
during transaction entry into other account types.
Structure and Placeholders
GnuCash supports the use of Placeholder accounts. In effect, these are just
read-only accounts into which no transactions can be entered, but which
function in an analogous fashion to folders in a folder structure, as a
holder for other accounts. Though &kmymoney; does not support this feature as
such, it does provide a parent/child account relationship, so the importer
simulates placeholders by creating empty accounts.
Account Type mapGnuCash type&kmymoney; typeBANKCheckingCHECKINGCheckingSAVINGSSavingsASSETAssetCASHCashCURRENCYCashMONEYMRKTMoneyMarketSTOCKStockMUTUALStockEQUITYEquityLIABILITYLiabilityCREDITCreditCardINCOMEIncomeEXPENSEExpenseRECEIVABLEAssetPAYABLELiabilityTransactions and SplitsBalanced transactions
As with GnuCash, data is entered in the form of transactions, each generally
consisting of 2 or more split entries. In fact, valid GnuCash transactions
will always contain at least 2 splits, and to conform to GnuCash's
- double-entry bookkeeping standard, these must be in monetary balance (i.e.,
+ double-entry bookkeeping standard, these must be in monetary balance (&ie;,
they must balance out to zero). &kmymoney; encourages, but does not enforce,
this standard, but any imported transaction which is not balanced will be
marked in the ledger view as having a problem.
Payees
&kmymoney; prefers that all transactions have a Payee (a generic term that
encompasses both payees and payers), and unlike GnuCash, a list of these
payees is maintained. Payee names are generated by the importer from the
GnuCash transaction's Description field.
Transfers
&kmymoney; uses the term Transfer to describe a transaction which does not
involve a Category, but only transfers money between Asset and/or Liability
accounts.
Reconcile
&kmymoney; provides an account reconciliation function similar to that of
GnuCash, and the corresponding transaction status will be imported.
Commodities
GnuCash uses the term Commodity to cover both currencies and non-currency
assets. These are treated separately in &kmymoney;.
Currencies
&kmymoney; has built-in support for all foreign
currency types. &kmymoney; also
requires that the user specify a base currency, this being the default
currency for new accounts. The importer will attempt to determine the most
likely base currency, though this choice may be rejected in favor of an
alternative.
(NOTE: &kmymoney; does not currently support accounts denominated in 'defunct'
currencies (except those replaced by the Euro). At present, it will be
necessary to remove any such accounts from your GnuCash file before
importing. We hope to improve on this situation in a future release.)
Securities and Investments
Non-currency assets (normally stocks and bonds) are called Securities by
&kmymoney;, and represent the main difference between the two products, in
that &kmymoney; requires any account denominated in a security to be
subordinate to an Investment Account. This is described in more detail in the
chapter on Investments. Though
users may have implemented such a relationship, GnuCash imposes no defined
structure on it, so the importer is unable to detect it and perform an
automatic conversion. Three options are therefore made available:
Create a separate Investment account for each security, with the same
name as the securityCreate a single Investment account which will act as 'parent' for all
security accountsCreate several Investment accounts, and assign securities to them as
directed by the user.
It depends entirely on user requirements which of these options is relevant in
each situation, and in some cases, manual restructuring of accounts after
importation may be necessary.
Prices and currency rates
Security prices and currency exchange rates as displayed in the GnuCash Price
Editor will be imported. In addition, price and rate entries will be generated
from all transactions involving securities and multiple currencies.
Online Quotes
For obtaining online price and currency rate quotations, GnuCash uses a
package called Finance::Quote. Recent versions of &kmymoney; contain support
for this package for obtaining stock quotes, and this will be used by default
when importing data. You may however select to convert to the native method
used by &kmymoney; which is covered in more detail in
online quotes.
If you choose to do so, the following dialog will allow selection of a
'native' &kmymoney; price source, or a user-defined source, for each account
for which online quotes are required. However, the stock (ticker) symbol will
be imported unchanged. Since this symbol will almost certainly be different in
the two packages, it will need to be manually edited after completion of the
import process. Future currency rate updates will not use Finance::Quote, and
will always use the native retrieval method.
Scheduled Transactions
&kmymoney; does not retain the separation made in GnuCash between template
transactions and their frequency of occurrence. Transaction data will be
duplicated if the same template is used in different schedules, but this is
not likely to be of great significance.
Schedule types
&kmymoney; classifies all schedules as one of three types, Bills, Deposits, or
Transfers. Since GnuCash does not make such a distinction, the importer
attempts to determine the classification from the accounts and direction of
money movements. It may be that in some cases incorrect assumptions are made,
and these will need manual correction.
Suspect Schedules
Some features of GnuCash scheduled transactions are not available in
&kmymoney;, so the importer tries in each case to reach a reasonable
compromise in converting the data. These transactions will be flagged as
suspect, and the user will be given the option of editing them directly during
the import process. Examples of situations which may cause this are:
some frequency intervals supported in GnuCash are not currently
available in &kmymoney;&kmymoney; does not support the use of formulae and variables in
amount fieldscomplex cases which have not yet been identified for import.
Despite best efforts, it is possible that, due to the many options involved, a
scheduled transaction may cause a fatal error within &kmymoney;. If this sort
of problem seems to be occurring, the importer offers the option to drop all
suspect schedules.
Reports
&kmymoney; provides a comprehensive selection of configurable reports,
described in more detail in Reports.
These will not necessarily, however, match precisely those reports available
in GnuCash.
Selecting Importer OptionsInvestment Handling
See "Securities and Investments" above.
Online Quotes
Turn this off if you wish to use the native method for future online price
quotes.
See "Online Quotes" above.
Scheduled Transactions
See "Scheduled Transactions" above.
Decoding Options
If your native language is written in letters or symbols which are different
- from those used in the 'Latin' languages (i.e., generally Western European),
+ from those used in the 'Latin' languages (&ie;, generally Western European),
these are represented in a special fashion ('encoded') in your GnuCash file.
If these letters are not displayed correctly on your screen, then they must be
decoded. Currently, it is often not possible to detect accurately which form
of decoding must be used, so you may need to set this option and select an
entry from the list. In general, the first item in the list will be that
- which is considered appropriate for your locale (i.e., the country and
+ which is considered appropriate for your locale (&ie;, the country and
language which was selected as native when your operating system was
installed), so this should be tried first. Since the import process does not
overwrite your GnuCash file, you are free to experiment with any of these
selections.
Transaction Notes option
Under some usage conditions, non-split GnuCash transactions may contain
residual, often incorrect, memo data which is not normally visible to the
user. When imported into &kmymoney; however, due to display differences, this
data can become visible. Often, these transactions will have a Notes field
describing the real purpose of the transaction. If this option is selected,
these notes, if present, will be used to override the extraneous memo data.
Debug Options
These need only be used in the event of import problems. If you have such
problems, you should also report them to the &kmymoney; developer list
&devlist;. Note that the traces produced by these options may contain data of
a confidential nature, and the Anonymize option should be used if they are to
be made publicly available.
Import Report
At the end of processing, the importer produces a report showing the number of
different entities processed, and any errors or anomalies encountered. This
report will be displayed on screen, and may be saved to a file for later
review. A full report may contain the following sections:
Record countsInconsistencies in account types and actions takenDetails of suspect schedules&Thomas.Baumgart; &Thomas.Baumgart.mail;QIF ImporterQIF format considered harmful
Generally speaking, the QIF format should be avoided wherever possible. It is
a poor choice for transporting financial data. Among other things, QIF suffers
from these problems:
Lack of standardized format: Different versions of the same program
will impart different meanings to the same element.Lack of transaction identifier: Because there is no ID number
associated with each transaction, matching duplicate transactions is
haphazard at best.Lack of expressiveness: The grammar is really simple, and cannot
portray the depth of financial information found in today's financial
environment.
This is generally why Intuit stopped supporting QIF input at all with Quicken
2005. If you have the option of getting data some other way, like OFX, always
choose that option.
How to import a QIF file
To import a QIF file, first ensure you have a valid &kmymoney; file open.
Then select ImportQIF... from
the File menu.
The resulting dialog prompts for the QIF filename allowing you to locate the
file by clicking on the Browse button.
Also, &kmymoney; differentiates between the import of a bank statement file
and historic data exported from another application. The default is to import
a bank statement file. In case you are importing data from your previous personal
finance manager application select the appropriate option.
In general the default QIF profile should work with your QIF data. In some
cases it might become necessary to use a modified QIF profile. See
the next section for more
details on that subject.
Click on Import to import the QIF file.
&kmymoney; will start scanning the file to determine the formats used to
represent dates and numbers. In case it cannot determine a date format
unambiguously, &kmymoney; will ask the user to select one from the list of
possible date formats.
Next, &kmymoney; imports the data and creates all necessary objects, such as
payee information, accounts and category records, and stock price information.
Wherever possible, existing transactions will be matched against the imported
information. A progress bar is shown and updated during the import process.
In case &kmymoney; could not detect the name of the account to be imported,
the user will be asked to select the account into which the data should be
imported. If the account does not already exist in your file, a new account
can be created by clicking on Create.
At the end of the import, &kmymoney; shows a statement import statistics
window.
Statement statisticsStatement statistics
After importing, all of the imported transactions will be shown with a yellow
background in the ledger view. In case &kmymoney; was able to match an
imported transaction with an already existing transaction, the background is
shown in light green.
The next step is to verify the imported data and accept it. This is a general
process and also applies to imports from other sources. It is outlined in a
separate section of this document.
The colors used to mark imported and matched transactions are customizable and
may be different in your environment.
Setting up a QIF profile
Because there is no universally standard format for a QIF file, different
vendors have taken liberties with the format, and introduced their own
nuances. The QIF Profile allows &kmymoney; to know about the peculiarities of
your file. To edit an existing QIF Profile, or to create a new one, press the
New button on the QIF Import dialog, near the profile selector.
QIF Profile Editor
Previous versions of &kmymoney; used to have a tab for date and amount
specifications. &kmymoney; now determines those settings by scanning the
file. If it cannot figure out all settings, it will interrogate the user
during import.
Transaction matching
As noted previously, one of the major drawbacks of the QIF format is the lack
of a unique identifier for each transaction. Thus, if you import a QIF file
and some of the transactions are already in your ledger, you may get
duplicates. &kmymoney; attempts to get around this by looking for
transactions that look similar to those you already have. If it finds
something that looks like the same transaction, it will match the apparent
duplicate.
This can be a problem if you have transactions that look too similar but are
actually different. In this case, you can unmatch those transactions later in
the ledger view.
Writing an import filter
Sometimes you may have data in a custom format, like comma-separated-values
(CSV) or something else unique to your situation. As of version 4.6,
&kmymoney; includes a CSV Importer Plugin, but you can still import other
types of files into &kmymoney; using a QIF Import Filter. A filter is a
custom program you write which takes your special file as input, and produces
a QIF file as output. This can be a shell script, a perl script, a compiled
program written in C/C++, or anything else you can dream of, as long as the
system can run it.
To use it, edit your favorite QIF Profile, and select the Filter tab. Enter
the location of your filter program where prompted. Then, whenever you do a
QIF import using this profile, the file you select for importing will be run
through your filter first.
A common problem is to convert a list of comma-separated-values into a QIF
file. This is a textbook case for the awk tool. Create a script called
csv2qif.awk, with the following two lines as contents:
BEGIN { FS=","; print "!Type:Bank" }
{ print "D"$1; print "T"$2; print "N"$3; print "P"$4; print "M"$5; print "^" }
Then, change the QIF keys (D,T,N,P,M) to match the order of your csv data.
Set the input filter to awk -f csv2qif.awk.
Another problem sometimes arises in the encoding of QIF files. &kmymoney;
expects files to be UTF8 encoded. If your file is encoded in something else,
it can be useful to convert it to UTF8. For example to convert it from
iso-8859-1, you would set the input filter to recode
iso-8859-1..utf-8.
Special &kmymoney; QIF extensions
As already mentioned, one of the major drawbacks of the QIF format is the lack
of a unique identifier for each transaction. If you are writing your own QIF
file creator (or filter, as described above), you can overcome this problem.
&kmymoney; supports the '#' field. The importer will interpret this as a
unique transaction ID, and disregard the record if the transaction is already
in the system.
QIF Exporter
To export one of your accounts to a QIF file, choose
the ExportQIF from
the File menu. You will be prompted for which single
account to export, what file to export it to, and what QIF Profile to use.
At the moment, QIF Exporter does not handle export of investments.
QIF Export&Ace.Jones; &Ace.Jones.mail;&Thomas.Baumgart; &Thomas.Baumgart.mail;OFX Importer PluginGetting the plugin
&kmymoney; will import OFX files painlessly. However, this functionality is
not built into the core program. You must obtain and install the OFX Importer
Plugin. Once that is installed, the command to import OFX files will
automatically show up under the FileImport menu.
Note that many prepackaged versions of &kmymoney; were built with the OFX
importer already included or available as a separate package. If the OFX
importer does not seem to be installed in your version, the first place to
check is in the same place you got your base &kmymoney; package.
If you have installed from RPM, the OFX Importer Plugin is contained within
the kmymoney-ofx RPM. It should be available from whatever source you got the
base &kmymoney; RPM. If you have built from sources, all you need to do is
have preferably the libOFX 0.9 development headers and libraries installed on
your system. The &kmymoney; build process will detect these and compile the
plugin. At the time of release of &kmymoney; 4.6, the latest libofx version
was 0.9.4, which is also the minimum required version.
Should you run into trouble trying to compile &kmymoney;, and you are certain
you have the correct version of libOFX installed, please contact the
developers list &devlist; for assistance. Include a copy of your config.log
file, compressed first via gzip.
What is OFX
OFX stands for Open Financial Exchange. According to the
OFX web siteOpen Financial
Exchange (OFX) is a unified specification for the electronic exchange of
financial data between financial institutions, businesses and consumers via
the Internet. OFX is not a financial institution. The specification
defines formats for transfer of financial data both by file and by direct
interchange.
Although the standard is much more complete and robust than QIF, there are
still variations, depending on the specific implementation used by any
institution. OFX files may have an extension of OFX or
QFX (upper or lower case); this does not imply any particular
- difference in the content. The specification is based on XML, so the files
+ difference in the content. The specification is based on &XML;, so the files
can be read in any text editor, but as whitespace is not relevant to the
content itself, some implementations do not use any, making it very hard for a
human to read.
Another site with good information is OFX
Home. They maintain a directory of financial institutions that
support OFX. This can be useful if you have problems setting up OFX direct connect. They also
have a forum for discussions about OFX issues.
Importing an OFX file
The most basic way to import an OFX file is to choose the importer from the
menu bar. From the File menu,
choose Import, and
then OFX.... If OFX does not show up under Import,
you do not have the OFX Importer Plugin installed correctly. Please see the
previous section.
The first thing the importer will do is ask you into which account to import
the transactions. If there are transactions from multiple accounts in your
file, you will be asked this question multiple times.
After importing, some of your transactions may be shown with an exclamation
mark on a yellow triangle in the ledger. This is because they need to be
assigned a category. The importer was not able to automatically assign a
category based on your past transaction history. You can edit each
transaction in the ledger to assign a category, and the mark will be removed.
Please note that this section describes the native OFX
importer. OFX files may also be imported using the AqBanking Importer Plugin
if you have installed that. Note that the two importers do behave slightly
differently, and they are written and supported by two different developers.
Importing Investments
Please note that if you are importing a file with investment transactions,
those investments must first exist in your &kmymoney; file. The trading
symbol is used to match, so please ensure that the symbol in &kmymoney; is
exactly the same as the one in the file you're importing.
Web Connect
The easiest way to import an OFX file is to set up Web Connect. Visit your
bank's web site, and click on a link to download an OFX file. Your browser
should ask you what program you would like to use to open the file. Point
your browser to &kmymoney;. It will then import the downloaded OFX file into
the &kmymoney; file you most recently had open. You can also change the file
associations of your desktop environment, and have &kmymoney; open the OFX
file automatically for you.
If you need to import the OFX file into some other &kmymoney; file, load up
that file in &kmymoney; first, and then visit your bank's web site.
Direct Connect
OFX Direct Connect is now supported in &kmymoney;. This gives you the ability
to contact your bank directly to obtain statements. In the future, there will
be more help written, and this will be moved to its own section.
To enable this feature, you must compile &kmymoney; with the
--enable-ofxbanking switch (now the default).
Please be warned: Many banks require a separate signup, will give you a
separate password or PIN, and may even charge you a separate fee for this
service. No bank directly supports &kmymoney;. You will have to tell them
you want to bank directly from MS Money or Quicken.
The first step is to configure each account for which you wish to download
statements. Go to the Accounts view, right click on the account you wish to
configure, and choose Map to online account....
In case more than one online banking plugin is installed on your system
you will be asked which one to use. For the internal OFX method select
KMyMoney OFX. A list of banks will be downloaded
from the Internet and a wizard will guide you through choosing a bank,
entering your username and password, and selecting an account. Should you
find that your bank is not listed, then it may still be possible to use the
manual option. Your bank may be able to provide the required parameters, or
you may have to do some research to find them.
Setting up OFX Direct Connect can sometimes be a challenge, especially as
the implementation at most institutions do not provide sufficient details in
error messages. One particular issue to note is that many institutions
require you to change your password the first time you access it online
using this method. Unfortunately, at this time, the library that &kmymoney;
uses (libofx) does not have a way to interactively change a password. In
some cases, it is possible to get a techincal support person at the
institution to change the password for you. Until we are able to expand
this section with more detailed troubleshooting information, if you have
trouble getting this to work for you, you can ask for help on the &kmymoney;
developer list &devlist;.
Once you have an account set up with online banking, go to the ledger for that
account. Then from the Account menu, choose Update
account.... This will connect to your bank, and download a statement
for the last 60 days.
In version of &kmymoney; prior to 4.6, the payee name was always taken
from the PAYEEID field. As of version 4.6, the payee name can be based on
either the PAYEEID, NAME, or MEMO field in the OFX transaction. You can
configure this feature and some other OFX direct connect settings by
selecting the appropriate tab in
the Edit account dialog.
Exporting an OFX file
It is not possible to export your data as an OFX file currently. If you are
interested to contribute in this area, please contact the libofx development
team for details.
&details-impexp-csv;
Writing Importer Plugins
&kmymoney; contains explicit support for importer plugins. If you have a
custom format, and you would like to write an importer plugin, we would value
your contribution. To do so, you'll need to compile the program from source.
Then use the OFX Importer Plugin as an example.
diff --git a/doc/details-investments.docbook b/doc/details-investments.docbook
index 0756fd904..e10a55993 100644
--- a/doc/details-investments.docbook
+++ b/doc/details-investments.docbook
@@ -1,646 +1,646 @@
&Ace.Jones; &Ace.Jones.mail; 2014-08-304.7.01InvestmentsInvestments in &kmymoney;Investments
Investments are instruments for investing money that are traded on a market.
Stocks, bonds, and mutual funds are the most common investments; so they are
the ones supported most directly. Futures, commodities, options, and more
complex derivatives are also sometimes used, but &kmymoney; has no special
functionality for them. As long as they behave like a stock or a bond, they
can be tracked easily.
Base Currency
Each investment has a Base Currency. This is the currency in which it is
traded. When a price quote is entered for an investment, the currency of the
value given is always its base currency. A stock on the NYSE (New York Stock
Exchange) would be in US dollars, and one on an Australian market would be in
Australian dollars.
Investment Accounts
Investment Accounts hold a collection of investments. An Investment account
contains transactions, such as buys and sells, of those investments. All
transactions in an Investment account must relate to a specific investment.
There is no separate cash balance in an investment account. For
that, you need a Brokerage Account.
Brokerage Accounts
An investment account often has an associated Brokerage Account. This is also
sometimes referred to as a Cash Account. Investment accounts
cannot contain cash transactions, like a transfer from your bank. When a
stock is sold, the proceeds are typically placed in the Brokerage Account.
When you create an Investment Account, you have the option of creating an
associated Brokerage Account with it.
Creating an Investment Account
The first step on the path to working with investments is to create an account
to hold your investments. Choose AccountNew account... to begin the process of
adding a new account. Create an account as usual, making sure to choose
Investment as the type of account.
To work with the new investment account, navigate to the
Investments view, and choose the account you have just
created from the Select Account dropdown box.
Adding Investments to Your Account
To add individual Investments to your Investment Account, navigate to the
Investments view, select the
Equities tab, and choose the account where the
investment is held from the Select Account drop-down box.
Investment View, Equities TabInvestment View, Equities Tab
Right-click the mouse in the empty space in the view. This brings up
the Investment Options context menu. Choose
New investment... from this menu. This launches the
New Investment Wizard which you use to create your new
Investment.
New Investment Wizard
The first thing you'll be asked to enter is the type of investment, whether
- it's a stock, bond, etc.
+ it's a stock, bond, &etc;
Next, the investment details page is presented. The following information is
entered on this page:
Trading Symbol. The ticker symbol used to identify the
investment on whatever market it trades. &kmymoney; requires a trading
symbol for all investments; however some investments do not have symbols.
In this case, you will need to make up a symbol for it.
Full name. The friendly, readable name of the investment
you're creating, ⪚, Advanced Micro Devices, Inc. This name is
also referred to as the security.
Fraction. The degree of precision to which your holdings are
measured. For example, in the US most mutual funds measure holdings to
three decimal places, so you would enter 1000 in this field. Stocks are
often measured to only whole units, so you could enter 1 for a stock like
this.
Trading market. Where the stock trades. This is an optional
field which is provided for your convenience. This information is not used
anywhere else in &kmymoney;.
Identification. An optional field to enter additional
identification information you might like to keep track of. Again, this
information is not used anywhere else.
Trading currency. The underlying currency in which this
investment trades on its market.
Price entry. Choose whether the price will be entered as an
individual price, or as the total for all shares.
If you are using Online Quotes, ensure that the symbol exactly matches the
symbol used by your quote source. Yahoo covers most of the world's markets,
and requires a suffix on the end of symbols outside the US. For example,
Rubicon Limited on the New Zealand market should be entered as
RBC.NZ.
Finally, you're presented with the Online Update screen. This is where you
tell &kmymoney; how you would like to update the prices of your investment.
The following items are set here:
Use Finance::Quote. This is an option for GnuCash users who are used to
this style of quotes. Most users can leave this unchecked.
Online Source. The online source you'd like to use for this particular
investment. The most common choice is Yahoo. Try that
first, and if the investment cannot be found using this source, then
experiment with the others.
Factor. A multiplier that should be applied to quotes retrieved for this
investment. This is most commonly needed for UK stocks where the price
quoted is in pence (1/100), and the stock is denominated in pounds. In
this case, enter 0,01 for the Factor.
Editing an Investment
The Equities tab of the Investments view window lists your
current holdings in this account, along with their symbol, value, quantity, and price.
Right-click the mouse on any of the investments to bring up the
Investment Options context menu, where you have the option
to add, edit, or delete individual investments from this account. Also, you
can update the price of your investments here either manually or via their
online source. In addition, it is possible to close an empty account, or to
reopen a closed account.
Investment TransactionsInvestment Transaction FormInvestment Transaction Form
Investment transactions are entered and edited in the
ledger view, as with other kinds of
accounts. However, the fields are different, and vary depending on the
investment transaction type or activity. Investment transactions have some
additional elements:
ActivitySecurityAccountShares, Price, & Total AmountFeesInterest categoryActivity
The Activity for an investment transaction describes what action is happening
to the stock. The following activities are supported:
Buy/Sell
Use to record purchases or sales of individual investments.
This action requires an account to transfer the funds from/to.
Dividend/Yield
Also known as a Cash Dividend, this action
is used for when you receive an interest or dividend disbursement from
your investment. This action requires an account to transfer the funds
from/to.
Reinvest Dividend
Reinvest Dividend. This is a dividend where the proceeds are re-invested
back into the investment.
Add/Remove Shares
A simple increase or decrease in your balance. This
should be used very rarely, because it's uncommon for shares to just show
up in your account (or disappear) unless it's a purchase or a sale.
Split Shares
Used when the stock is split. Enter the ratio of the split
in the Split Ratio field. For example, in a 3:2 split,
enter 1.5
Security
Each investment transaction must be associated with an individual security,
which is here just another name for an investment. Choose the investment name
when adding or editing a transaction. The symbol will be displayed when
viewing it.
Account
For any transactions which generate or require money, you must enter the
account where the money is transferred to/from. If your investment account
has an associated brokerage account, it's usually best to transfer the funds
there. This applies to funds for purchase or sale of the investment, as well
as for fees paid or interest or dividends earned.
Shares, Price & Total Amount
For buy, sell, and cash dividend transactions, the number of shares, the price
per share, and the total amount of the transaction must be established. You
can enter any two of these, and &kmymoney; will calculate the third. It's
usually best to enter just the total amount and the number of shares, because
these are the known facts of the transaction. The price per share can be
calculated from these.
Fees
With many investment transactions you can include the fees (or commission) you
paid the broker. If you enter a category for the fee, then a field will be
shown to the right where you can enter the amount of the fee. If you need to
enter more than one fee for the transaction, you can use
the Split Transactions feature.
In this case, when you complete entering all the splits, the total amount of
the fees will be shown to the right.
Interest
This is how you enter an interest or dividend payment from an investment. As
with fees, if you enter a category, then a field will be shown to the right
where you can enter the amount. You can also use the split transaction
feature, if required.
Working With Foreign Investments
&kmymoney; supports multiple currencies and investments, and you may want to
combine the two. However, doing so requires extra care. As noted above, when
you added an investment, you had to specify its trading currency. This might
not be the same as your base currency, and it also might not be the same as
the account in which you hold the stock or the account where you transfer your
funds to/from for buys/sells.
Consider a hypothetical case. Your base currency is USD. You have an
investment account in EUR, and a brokerage account also in EUR. In that
account, you hold shares of TietoEnator, which is traded in SEK.
When you enter a buy transaction on this investment, use SEK as the currency.
So if you buy 100 shares at a price of SEK 248.00, for a total of SEK
24,800.00, enter these values in the transaction.
Currency WarningCurrency Warning
When you choose the brokerage account to fund the transfer, you'll be warned
that it's in a different currency.
Exchange Rate EditorExchange Rate Editor
When you finish the transaction, you will be prompted for a price update to
the investment account's currency, in this case, SEK -> EUR. Review the
documentation on Entering Prices
Manually for more information on the price dialog.
If you then switch over to the brokerage account, you will see the transaction
as EUR 2,254.54, assuming an exchange rate is 11.0000 SEK / EUR.
Updating Prices
There are two ways of updating the prices for your investments. You can
either enter the new price manually or have &kmymoney; fetch it from the web.
Manual Price Updates
You can enter prices for your investments using the same
Price Editor as used for
currencies.
Online Price Quotes
&kmymoney; has the ability to download the latest prices for your investments
and currencies via the web.
How Online Quotes Work
At your request, &kmymoney; will fetch a page from the web that contains the
latest price for each item. By default, prices are fetched from
finance.yahoo.com, and are subject to the terms and conditions of that
site.
The online quote lookup uses the investment's trading symbol to find the
price. Therefore, it's important to set the symbol correctly. Yahoo supports
stocks from most major world markets, so it's usually just a matter of finding
the correct symbol. For example, TietoEnator trades on the Stockholm Stock
Exchange market, and its Yahoo symbol is TIEN.ST.
To find the trading symbol for a security supported by Yahoo, use the
Symbol Lookup feature at finance.yahoo.com.
Assigning a Quote Source
In order to get online price quotes, you first have to enable it for each
investment or currency you want updated, by setting a Online Quote
Source. This is the name of the service from which the quote should
be fetched. &kmymoney; ships with several sources to choose from. Yahoo is the
recommended default source, and should work for most investments and all
currencies.
To assign a quote source to an investment, navigate to the investment summary
view for the account in which the security is held. Edit the security by
right-clicking it and selecting Edit Investment
.... In the Investment Detail Wizard,
click Next twice, for the Online Update section. In
the Online source dropdown box, select the online source.
Versions of &kmymoney; starting with 0.9 contain support for the
Finance::Quote package for obtaining online quotes. This is intended primarily
as a convenience for those users converting from the GnuCash finance package,
which uses it as its native method. If you do select this option, you should
see a different list of sources, those supported by Finance::Quote. If the
list is empty, it suggests that the package is not properly installed. See
their web site at
http://finance-quote.sourceforge.net for more information.
Adjusting a quote
Some online sources do not report the price in a base quantity (⪚, EUR) but
in a fraction (⪚, Cent). Using this information as price will produce wrong
values for your investments.
If this is the case for your online source, you can use the
Factor field to enter an adjusting factor. For the above
mentioned example the factor would be 0.01.
The Factor field is only available if a
Quote Source has been selected.
Fetching Quotes
Typically, you will update the prices for all your investments and currencies
at once. Choose the ToolsUpdate
Stock and Currency Prices... menu option to bring
up the online price quotes dialog. Press Update All to
fetch quotes for all investments and currencies in your &kmymoney; file.
Update Stock and Currency PricesOnline Stock and Currency Price UpdateAdding or Editing Quote Sources
Adding or editing quote sources is not recommended for anyone but the most
technical user. You should feel comfortable reading HTML and writing complex
regular expressions. If this doesn't sound like you, we recommend writing to
the developer's list if none of the quote sources work for you. Ideally,
please point us to a web page where these quotes can be obtained.
If you do feel up to the challenge, here's how it works. The quote sources
are contained in the settings dialog.
Choose SettingsConfigure
&kmymoney;. From there, choose
the Online Quotes section. You can choose an existing
source to edit, or create a new one. When you are done with your changes, be
sure to press the Update button before exiting the
dialog. Your changes are not saved by default.
The first thing to worry about in an online quote source is the URL. This is
the page that is fetched from the web. You will see a %1 in all sources, and
a %2 in currency sources. For investments, %1 is replaced by the trading
symbol. For currencies, %1 is replaced by the From currency, and %2 is
replaced by the To currency. This URL is then fetched, all HTML tags are
removed, and that stripped file is then sent to the page parser.
Note that the URL can also be a file: URL, which the quote fetcher takes to
mean an executable script. It will pass any command-line arguments to it that
you have specified, and feed the stdout to the page parser. For example, you
might have a script called getquote.sh that contains custom quote logic,
taking the symbol as a single parameter. Your URL would be
file:/path/to/getquote.sh %1.
The page parser looks for a symbol, a date, and a price. Regular expressions
tell it how to extract those items from the page. Please review the
documentation for the QRegExp class
for the exact makeup of the
regular expressions. There should be exactly one capture expression,
surrounded by parentheses, in each regexp. The date format further tells the
date parser the order of year, month, and day. This date format should always
be in the form "%x %x %x". where x is y, m, or d. The date parser is very
smart. %m %d %y will parse December 31st, 2005
as easily as 12/31/05. Two digit years are interpreted as
being in the range of 1950-2049.
Unimplemented Features
Certain common features that are normally found with investments are not yet
implemented in &kmymoney;. These include: Derivatives (options, futures,
- etc), capital gains, and tax reporting for investments.
+ &etc;), capital gains, and tax reporting for investments.
diff --git a/doc/details-ledgers.docbook b/doc/details-ledgers.docbook
index bdde5ec84..936506cb7 100644
--- a/doc/details-ledgers.docbook
+++ b/doc/details-ledgers.docbook
@@ -1,733 +1,733 @@
&Michael.T.Edwardes; &Michael.T.Edwardes.mail; &Roger.Lum; &Roger.Lum.mail; MichaelCarpinomfcarpino@gmail.com2019-04-025.0.3LedgersThe Ledger View
The Ledger view is functionally the data integration center of &kmymoney;. This
view is for entering, examining, deleting, and editing transactions in your defined
accounts. The view is split into three main areas: the filter area, the
transaction list, and the input area.
This view allows for several key actions: searching and viewing transactions;
entering new transaction; and editing, duplicating, deleting, and scheduling
existing transactions. Along with this it also provides the ability to move,
mark, and go to additional account transaction details. Other functionality
within the Ledgers View includes modifying and reconciling the account.
Ledger View
The view has three elements:
The filter areaThe transaction list
The transaction form, which may or may not appear, depending upon
your configuration as selected in the Configure &kmymoney; Ledger section.
The filter areaFilter area
You can easily select any account via the account dropdown list at the top of
the view area. Note that depending upon the type of the account the transaction form at the
bottom of the view may change.
To the right of the account dropdown list, are two additional fields. The
filter box provides the ability to search for matching transactions
that will be displayed in the list view. The text specified can be in any
of the fields of the transaction for the specific account. The status field
is a dropdown list. The status field list allows for the selection of:
Any status, Imported, Matched, Erroneous, Not marked, Not reconciled,
Cleared, and scheduled transactions.
The transaction listTransaction list
After a transaction has been entered, it is displayed in the transaction list.
You can also change transaction properties or even create new transactions
directly in the list. In the transactions list, the default order of
transactions is sorted by date with the most recent transaction on the bottom.
- Clicking the Right Mouse Button on the header of the transaction list brings
+ Clicking the &RMB; on the header of the transaction list brings
up a dialog box that will allow the ability to change the sort order of the
transactions. For instructions on how to change the default sort order, see the Sorting tab section of the
&kmymoney; Settings Chapter.
Note that the balance column is based on the currently displayed sort order,
and will not be calculated if the display is filtered by the searching within
the filter box or transaction type dropdown, as described above.
At the bottom of the transaction list, &kmymoney; displays three values:
Last reconciled
This is the most recent date when you reconciled this account.
Reconciliation is an important process for many accounts, and is described
here.
Cleared
This is the total of all cleared and reconciled transactions in this
account. See this section
for more information about the cleared and reconciled states of
transactions.
Balance
This is where &kmymoney; displays the total balance of the account, which is
the sum of all transactions in the account. However, if you select more
than one transaction in the transaction list, this changes to display the
sum of the selected transactions. This returns to the balance when only one
transaction is selected.
The transaction form
The exact layout of the bottom area of the ledger view depends on your
configuration and the type of account being displayed. However, it generally
includes fields for all the details of a single transaction, as well as
buttons for various actions that can apply to a transaction. It is described
in more detail in the following sections.
Entering Transactions
There are two methods of entering transactions into the ledger: using the
transaction form or entering the data directly into the transaction
list. The transaction form is displayed by default and this is the
method we will discuss first. Turning off the transaction form can be
accomplished by going to the Ledger section in the Configure &kmymoney; that's
within the Settings.
The fields in the input area match the information fields in the transaction
list. Additional fields include the Memo field, for a more detailed
description of the transaction, and a Category selection. The Split button
allows you to split the transaction into multiple categories.
Using the transaction formTransaction Form
The transaction form at the bottom of the ledger view is the interface
for manually creating transactions.
Depending upon the type of transaction you wish to enter there are
several tabs available on the transaction form. Click on the tab that best
defines your transaction (deposit, transfer, or withdrawal) and the form
will load several fields available for your input.
Please note that the actual transaction method is not used directly by
&kmymoney; but is purely for grouping/reporting purposes.
If you are unsure which method to choose simply use Deposit for any money
coming into the account, Withdrawal for money going out of the account, and
Transfer for money moving from one account to another. The transaction
methods and the differences between them are discussed in more detail
elsewhere.
Select the transaction method by clicking on the appropriate tab.
The fields of a transaction
Enter the information using the following notes on the available fields. Note
that many fields have 'Auto Completion' turned on. That is, if you start
typing, &kmymoney; will offer alternatives matching the characters you begin
to enter. To select the matching content simply click on the entry by using
your mouse or selecting the appropriate keyboard keys. If the entry is not
listed finish typing the content to add the new value. The next time you type
the content, &kmymoney; will find it for you as you begin to enter the initial
characters.
The Payee
The Payee is who the money came from/to. If the payee is a new entry
&kmymoney; will ask if you wish to add this to the list of Payees. Any other
information related to a payee or payer, such as address, phone number and account
number as well as notes can be updated in the Payees view.
The Category
The Category associates a transaction with an income or expense category for
accounting and reporting purposes, and enables you to group certain
transactions. Type the name of the category into the defined field. If you
have entered the category and it does not exist then &kmymoney; will ask if
you want to create a new one. If the selection is Yes &kmymoney; will then
open a dialog box that allows for the further definition of the category based
on General, Hierarchy and Tax characteristics.
If you wish to associate parts of the transaction with different categories,
&kmymoney; can handle this need. An example transaction might be a cash
withdrawal of 50 of which you use 10 on food, 20 on beer and 20 as
cash. The transaction will therefore be assigned three categories:
Food, Beer, and Cash. To do this, you need to use Split Transactions, which is described
in more detail below.
See the special &kmymoney; fields
section for more information on how to use this field.
The Tag
Tags are similar to Categories, and can be used to maintain an orthogonal view
to Categories. They provide the ability to group transactions within a Category based
on your defined needs. This need could be defined by a specifics to Person, Place, or
Thing. For example, you might have a Category for each different type of automotive
expenses, and then have a Tag for each vehicle. As with Categories, you can select
from the dropdown list, or type a new Tag name, and be prompted if you want to create
a new Tag with that name. Within the Tag field &kmymoney; will allow for multiple tags
entered within a single transaction. Also, you can enter a tag on an individual split.
The Memo
A multi-line memo can be entered if you wish to help you remember further
details of a specific transaction.
The Check Number
The check number can be entered if needed. Note that the check number field can
be made visible or invisible in the ledger if desired. This is configured in
the Ledger Settings dialog.
The Date
The transaction's date must be entered to specify when the transaction took
place. See the special &kmymoney;
fields section for more information on how the date input field can be
used to make entering dates quicker and easier. For transactions in checking
and credit card accounts, it is your choice whether to use the actual date
(when you wrote the check or made the purchase) or the posting date as
reported by the bank or credit card company. Using the actual date can help
you track when you made the purchase, for example, but the statement or
downloaded data from the bank is more likely to use the posting date.
The Amount
Finally, enter the transaction amount into the required field. Note that a
simple calculator can be displayed, either by clicking the icon to the right
of the amount field, or by entering the % character into the field, or by
entering any of these mathematical symbols: + - * / in a formula, as in
12 + 3. When entering the plus sign, the calculator will
be opened. Note that only the final result of any calculation will be saved
as the amount of the transaction.
When you are satisfied that all the fields have been adequately filled in,
click on Enter. If you accidentally press or click on
Enter before you have finished entering all the data,
click on Edit to resume entering the data.
Directly inputting transactions into the listDirect Transaction Entry
The second method of entering transactions into the ledger involves editing
the transaction list directly.
To do this you must first let &kmymoney; know that you don't want to use the
transaction form by opening the settings dialog and unchecking the
Show transaction form option.
This is performed by selecting SettingsConfigure &kmymoney; from the menu bar
and selecting the
Register icon from the list on the left. The option to uncheck is
labeled Show transaction form. When finished click on
OK to be ready to directly enter or edit transactions.
Starting the edit
To enter a new transaction into the register you can now either click on an
empty entry, press &Ctrl;Ins, or click
- New at the foot of the window. The Up
- and Down arrow keys let you navigate through the list. After
+ action="simul">&Ctrl;&Ins;, or click
+ New at the foot of the window. The &Up;
+ and &Down; arrow keys let you navigate through the list. After
pressing &Enter; or double clicking on an entry, the transaction list displays
the fields required to enter the transaction and waits for input.
To move through the fields press the 	 key and when done
press &Enter; to save the changes or &Esc; to
cancel.
In case the option Use Enter to move between fields is
selected, the &Enter; key moves to the next field just as the
- TAB key except for the last entry field where it saves the
+ 	 key except for the last entry field where it saves the
data.
Which method you use to enter transactions is up to you and is a matter of
personal preference.
Split Transactions
The Split transaction feature allows you to divide up a transaction into
multiple categories, representing, for example, the different items bought
with a single purchase at a store.
To enter a split transaction, using either the transaction form or the
transaction list, start a new transaction, including entering the total
amount. Then, instead of selecting a category, click the
Split button to the right of the
Category field. If you have already selected a category,
that becomes the first entry in the split editor screen.
In the split editor screen, double-click an empty line to enter a new
sub-transaction or press &Ctrl;Ins. Specify the category,
+ action="simul">&Ctrl;&Ins;. Specify the category,
add an (optional) memo, and enter the amount. To save this part of the split,
press the green check mark under the category. To cancel, press the red cross.
After entering a split, the bottom of the split editor shows how much of the
total transaction is still unassigned. After entering all the splits, press
the OK button to save the entire transaction. If there
is still an unassigned amount, you will be prompted to either return to
editing the splits, change the total transaction amount, or leave part of the
transaction unassigned.
Note that the category field in the transaction form or the transaction
list now displays Split transaction.
Split transactionsSplit transactionEditing transactions
To edit a transaction, select it in the list view and either click on
Edit in the transaction form or right click on the
entry and select Edit from the popup menu. If you
are editing transactions directly in the list you can edit the transaction
simply by double clicking on an entry or by pressing &Enter; when a
transaction is highlighted.
Deleting transactions
To delete a transaction, select it in the list view, right click on the entry,
and select Delete from the popup menu when it
appears, or click Delete on the transaction form.
Matching Transactions
Generally, when you import transactions, either via QIF, OFX, or HBCI, &kmymoney;
will automatically attempt to match them against existing transactions. To
allow for differences in the dates, there is a default setting of 4 days,
which may be changed in the settings - Register/Import. Any transactions so
matched will be highlighted in green. On completion of the import, you should
review these and either accept or unmatch them.
If you should find that an imported transaction was not automatically matched
with an existing transaction when it should have matched, then it is possible
to match them manually. Note there is a difference between manually
matching two transactions and simply deleting one of them, even though they
may appear to have the same effect. Specifically with OFX or HBCI, it is
important not to delete the imported transaction, because you will find that
the next time you import your transactions, the deleted transaction may show up
again. This is because modern import formats like OFX and HBCI use a
Transaction ID to identify transactions. When you delete the
imported transaction, the transaction ID goes with it, so the importer has no
way to know this transaction was already imported.
The solution is to tell &kmymoney; that the transactions are the same, using
the manual matching interface. This allows you to match an imported
transaction with a hand-entered (non-imported) transaction. To do so, select
one of the transactions to be matched by clicking on it, then select the other
by left clicking on it while pressing the &Ctrl; key, and then select
Match from the context menu. This will match and
combine the two transactions together. The values of both transactions must be
the same for the match to work, except that the dates may differ by the window
specified in the settings, as described above. If you are happy with the
result, right click the matched transaction, then select
Accept.
During import of online statements, either directly or by importing a
downloaded file, &kmymoney; performs matching as best as it can based on the
name of the payee and the amount of the transaction. In case of an invalid
match, a matched transaction can be unmatched.
The matching interface will not allow you to match two transactions which
have both been imported. Likewise, it won't allow matching between two
transactions which have both been entered by hand.
Understanding the State of a transaction
A transaction can have one of three states: non-reconciled (blank), cleared
(C), or reconciled (R). When a transaction is entered, it has state of
non-reconciled. Once the bank posts the transaction, the user can clear it
and thus transform it to state (C). When you receive a statement from the
bank, all cleared transactions should be on the statement.
Understanding the cleared statecleared state
When you reconcile your account, you
actually mark the statements as cleared and check that the difference between
the beginning balance and the cleared transactions equals the ending balance
of the statement. When this is the case, you can 'finish reconciling' which
actually changes the state of all cleared transactions (C) to reconciled (R).
If you try to edit a transaction with at least one split marked as reconciled
(R), you will be warned.
Changing Transaction Settings
There are several options that change the appearance and behavior of the
Ledger view in terms of transactions. These settings are found by selecting
SettingsConfigure &kmymoney;
from the menu bar, and selecting the
Ledger icon from the list on
the left.
Most of the settings are self explanatory. For clarity, several of the
settings are explained below.
Show transaction form (under the Display tab) - toggle to hide the
transaction form at the bottom of this screen. Transactions can still be
entered directly into an empty line at the end of the transaction list,
through an automatic compact entry area.
These images show what direct transaction entry looks like compared to the
transaction form.
The transaction formThe transaction formTransaction formTransactions entered directlyTransactions entered directlyDirect input
Keep changes when selecting a different transaction/split - by selecting
the next line in the transaction list or split editor, the changes are
kept, instead of the default behavior where you have to push the green
check mark to save changes.
Other Functionality
Additional options are available from the Transaction
Options menu, accessed by right-clicking any transaction in the
list.
The transaction options sub-menuTransaction options
Options include jumping to the Payees view for the Payee in the transaction,
creating a schedule, and changing the reconciled or cleared status.
To edit the account information from the ledger view, select
Account from the menu bar. From the Edit
Account... menu item, you can change the account details. There
is also a menu item to bring up the Reconcile menu, which allows you to match
transactions against an official bank statement or credit card notice.
diff --git a/doc/details-reports.docbook b/doc/details-reports.docbook
index 482e143eb..1191f293c 100644
--- a/doc/details-reports.docbook
+++ b/doc/details-reports.docbook
@@ -1,441 +1,441 @@
&Ace.Jones; &Ace.Jones.mail; 2010-07-254.5ReportsAvailable ReportsReports ViewReports View
The Reports View lists all available reports, grouped under the following
headings.
Income and Expenses
The reports in this section show your income and expenses either for the
current month or for each month in the current year. Of course, the duration
of the overall report and the duration captured by each column can be
configured to your liking. Graphs and Pie Charts also may be produced.
Net Worth
Here there are reports that describe your net worth, either at the current
moment, every month for the current year, or every year of your history. In
addition, there is a 7-day Cash Flow Forecast and a Net Worth Graph. There
are also reports to get the balances for all of your accounts at any given
point in time.
Transactions
This section includes reports that list individual transactions. This is the
best way to print your account register for a specific period of time. The
transactions printed can be grouped together according to your liking by
choosing the appropriate report, such as:
By AccountBy CategoryBy Month or WeekBy PayeeCash Flow
The Cash Flow report is similar to a Transaction report, but it displays all
cash-flow related transactions.
Investments
These reports help you keep track of your investments. They only include
investment accounts. There are a variety of presentation filters and styles,
as shown in this partial list.
Investment Transactions: Similar to a Transactions report,
and includes the share price and quantities.Investment Holdings by Account: Shows the current shares,
price, and value for each account.Investment Holdings by Type: Same as the previous report, but
- organizes the accounts by type (Stock, Mutual Fund, etc)
+ organizes the accounts by type (Stock, Mutual Fund, &etc;)
Investment Performance by Account: Shows the annualized
performance over any period of time. This performs a cash flow analysis of
all money coming into and going out of the account. As a result, this is a
very accurate picture of how well your investments are
doing.Investment Performance by Type: Same as the previous report,
but organizes the accounts by type (Stock, Mutual Fund,
- etc)
+ &etc;)
There are also graphs for Investment Prices and Investment Worth.
Taxes
The tax reports are just like the transactions reports, with the addition that
only Tax related categories are included. This allows you to flag certain
categories as being tax-related, and then get one big report at the end of the
year to see them all in one place. They may be listed either by Category or by
Payee, and for the last fiscal year.
Budgeting
The budgeting reports are similar to net worth reports, but the reports can
display the budget for a given year, or even compare it to the actual income
and expenses for the same period.
Forecast
The forecast reports are just like the net worth reports, but they use the
information to display forecast information. You can display the information
at various levels and for the time frame of your choosing.
Information
These reports display non-transaction information about schedules, accounts,
and loans.
Charts
If Charts are enabled, this
section lists all the reports which are marked to display a graphical chart as
the default. They are also listed in one of the other sections, but they are
also aggregated here for your easy reference.
Favorite Reports
This section lists all the reports you have marked as a favorite in the report
configuration dialog. They are still listed in one of the other sections, but
they are also aggregated here for your easy reference. Favorite reports are
also included on the financial summary page for even easier reference.
Configuring Reports
To access the report configuration dialog, bring up the report you wish to
configure, and press the Configure button at the top of
the report.
Working With Reports
There are a number of actions you can take on each report. You can access
these by right-clicking the report name in the list of reports. Alternately,
once you have run a report, there are buttons across the top of the view to
invoke each of these:
Chart: Only present if the report is capable of displaying a
chart. Clicking this option toggles between the report and the
chart.Configure: Change the properties of this report. You can
customize the report to your liking and save it for future
use.New: Create a new customized report based on the selected
report.Copy: The report output can be copied to the clipboard to
paste them in another application, like a spreadsheet, for further
analysis.Export: Reports can be saved in &HTML; or CSV
format.Delete: Customized reports can be deleted. The default
reports that ship with &kmymoney; cannot be deleted.Close: Close the current report.Configuring ReportsWorking with custom reports
You can configure the default reports or create your own from them by
selecting 'New' and then configuring the new report. When you select
'Configure' you will be presented with the Report Tab. Initially, it is named
the same as the old report with (Customized) added to the end. You
can change the name to whatever you want. You can even name your custom
reports the same as a default report, or the same as another custom
report. Also, you can always use the Comment field to further distinguish
reports.
The Report Configuration dialog has a number of tabs across the top. Each tab
displays options for configuring different aspects of the report.
Report TabReport Configuration -Report
On this tab, you set the basic properties of this report.
Report Name: Choose a name for this report.Comment: Enter a comment to help you remember the details of
this report.Convert values to base currency: Select this option to convert
all values in the report to your base currency. Leave it unchecked if you'd
like to see values in their original currency. If currencies are not
converted, then subtotals will not be shown.Mark as favorite report: Check this to cause this report to
show up on the home page and in the group of Favorite
Reports.Rows/Columns Tab
On this tab, you configure how you would like the rows and columns to be selected
and organized. This tab presents different configuration options depending on
the style of report you have selected.
Report Configuration -Rows and Columns
For income/expense and net worth reports:
Columns: Choose how large of a time period each column should
encompassRows: Choose what kind of accounts to display as the rows of
this reportDetail: Choose the level of detail required for this
report.The following levels of detail are available:
All: Show every category or account.Top-Level: Show only the highest-level categories or accounts,
and roll up the sums of the subordinates categories or accounts into those
values.Groups: Show only the totals of the income, expenses, assets,
or liabilities.Total: Show only the grand totals line.
For transaction reports:
Organize by: Choose how to group the transactions in this
reportShow Columns: Choose which columns should be shown in the
report. The date and transaction amount are always shown.Include only Tax Categories: Only show categories which have
been marked as tax-related.Include only Investment Accounts: Only show transactions from
investment accounts.Include only Loan Accounts: Only show transactions from loan
accounts.Chart Tab
This tab allows you to configure what the report should look like when it is
displayed as a chart. See the Graphs
& Charts section for more explanation of the charting functions.
Chart Type: The visual format of chart
desired.Show grid lines: Whether to print horizontal and vertical grid
lines on the chart.Draw values on chart: Whether to print the data values on the
chart itself for chosen data points.Show chart by default: Whether this report should first be
displayed as a chart when it's opened.Line width: The width of data lines on the
chart.Other Tabs
The other tabs in this dialog are the same as in the Search Transactions
interface. Please refer to
the documentation on that interface for
details on the other tabs.Graphs & ChartsViewing as a Chart
Each report can be viewed in either textual form or graphical (chart) form.
The same report configuration parameters are used in either case. You can
easily jump back and forth between the textual and graphical forms by pressing
the Chart or Report buttons
along the top of the report view.
Care should be taken to limit the amount of data you choose to display on a
chart. If you are not careful, using the same configuration for both textual
and graphical forms means it's possible to configure a chart to be visually
cluttered, unappealing, and uninformative. &kmymoney; will not force you to
keep your charts readable and useful!
Available Chart TypesLine Graph
A line graph is one of the most simple forms of a chart. There is one line
for each series. (Usually a series is a single account or category; see below
for more details on that.) The time periods stretch out along the bottom axis,
and the currency values are along the left.
The detail level for each line is controlled in the Rows/Columns Tab of chart
configuration. If you choose the Top-Level detail level, there
will be one line for each of the top-most accounts or categories which show
the sum total of all underlying accounts or categories. If you choose
Groups it will instead show one line each for Income, Expenses,
Assets, or Liabilities, depending on the other settings.
Bar Graph
The bar graph works exactly the same as the line graph, except there is one
bar for each series in each time slice.
Pie Chart
The pie chart is the most simple chart available. It shows only one time
slice, as opposed to showing the values across time. This chart shows only
the totals column of whatever report is selected. If your report is
configured to NOT convert values to the base currency, there will be no totals
column, and therefore this report is not useful.
Ring Chart
The ring chart is very similar to a pie chart, except there is one
ring for each time slice in the report.
diff --git a/doc/details-widgets.docbook b/doc/details-widgets.docbook
index b889ee2c6..27d08404d 100644
--- a/doc/details-widgets.docbook
+++ b/doc/details-widgets.docbook
@@ -1,209 +1,209 @@
&Thomas.Baumgart; &Thomas.Baumgart.mail; 2010-07-254.5Widgets
&kmymoney; has some specific widgets not found in other applications. The
usage of these widgets is explained in this chapter.
Date entry widget
Whenever &kmymoney; needs information about a specific date, ⪚, the posting
date of a transaction or the opening date of an account, it offers the user
the date entry widget. This widget consists of three
fields and a button. The fields present the day, the
month, and the year, separated by
the date separator characters specified by your locale settings. The button -
if pressed - opens the datepicker widget.
Tip of the DayDate widget
Within the date entry widget, the left/right cursor keys can be used to switch
between the day, the month, and the
year fields. Using the up/down cursor keys, the value of
the selected field can be incremented/decremented. The + and
- keys can be used to increment/decrement a single day.
Month and year boundaries are considered and incremented/decremented if
necessary. Pressing T will set the date to today's date.
The date can also be changed using the mouse. Clicking on the
day, month, or
year field selects the field. The value can then be
incremented/decremented using the arrow buttons on the right of the
widget. They act exactly the same as the up/down key.
The datepicker opens when the button to the right of the arrow buttons is
pressed. It shows four arrow buttons at the top, two on each side of the
currently selected month name and year. The leftmost buttons are used to
decrement the year and the month; the buttons to the right of the year are
used to increment the month and the year. The button to the very right closes
the datepicker.
Beneath the buttons, the widget presents a calendar page for the selected
month. Clicking a day on the calendar selects that date, closes the
datepicker, and transfers the selected date into the day,
month, and year fields.
At the bottom of the datepicker widget, there are a button, a text edit field,
and a combo box. Pressing the button selects today's date in the
datepicker. The text field can be used to enter a specific date. Pressing the
- RETURN key shows that date in the datepicker widget. The
+ &Enter; key shows that date in the datepicker widget. The
combo box allows the user to select a specific week, and continue to pick a
date from there.
Value entry
The value entry widget consists of a text field (that accepts digits,
thousands separators, and decimal symbols) as well as a button to the
right. Use the digits to enter the value. Separate the fractional part by
entering the decimal separator for your locale. If you click on the button to
the right or press a key representing a numeric operation (⪚, +,-,/,* or %)
a little calculator will pop up and allow you to calculate the final value.
Negative values can be entered by preceding the value with a minus sign. In
case your locale is set to display negative numbers with parentheses around
the value, the value can also be enclosed in parenthesis in the value entry
widget.
Tip of the DayValue widget
Use the calculator widget just like a normal calculator and once done leave
it by clicking on the '=' button or press the '=' key on your keyboard.
Payee/Payer entry
When you are requested to enter a payee/payer for a transaction, you can start
entering the name by pressing keys on your keyboard. As long as matching
entries exist in the list of payees/payers maintained by &kmymoney; they will
be presented in a box beneath or above the text entry area. Using the mouse or
the up/down keys one can select a name from that list. Using the keyboard
additionally requires you to select the entry by pressing the RETURN key.
Tip of the DayPayee widget
If a name is entered that is not yet known to &kmymoney; you will be asked if
you want to create a new payee/payer record. If you do not wish to do so,
then the field will be blanked. Otherwise, the record will be created and
added to the list.
Once the edit field contains characters, the list only shows those payees that
match the character sequence entered. Double-click on the arrow of the combo
box to show all payees in the list.
Category/account entry
When you are requested to enter the name of a category or account, you can
start entering the name by pressing keys on your keyboard. As long as
matching entries exist in the list of categories/accounts known to &kmymoney;
they will be presented in a box beneath or above the text entry area. Using
the mouse or the up/down keys one can select a name from that list. Using the
keyboard additionally requires you to select the entry by pressing the RETURN
key.
Tip of the DayCategory widget
If a name is entered that is not yet known to &kmymoney; you will be asked if
you want to create a new category record. If you do not wish to do so, then
the field will be blanked. Otherwise, the record will be created and added to
the list.
Once the edit field is filled with characters, the list only shows those
categories/accounts that match the character sequence entered. Double-click on
the arrow of the combo box to show the complete list.
diff --git a/doc/firsttime.docbook b/doc/firsttime.docbook
index 4556795b8..0e80a8d86 100644
--- a/doc/firsttime.docbook
+++ b/doc/firsttime.docbook
@@ -1,1035 +1,1035 @@
&Michael.T.Edwardes; &Michael.T.Edwardes.mail; &Jack.H.Ostroff; &Jack.H.Ostroff.mail; 2018-02-015.0.0Using &kmymoney; for the first timeRunning &kmymoney; for the first time
Once &kmymoney; has fully loaded two windows will be opened. The top window,
'Tip of the Day' offers one of a series of important or useful pieces of
information about the application.
Tip of the DayTip of the Day
You are recommended to quickly read through these tips by pressing on the
Previous and Next buttons at the
bottom of the window.
Once you have read the tips the window can be closed; it will re-open each
time &kmymoney; is started. To stop this default behavior, uncheck the
appropriate option on the Tip of the Day window.
Tips can be read at anytime by selecting Show tip of the
day from the Help menu within &kmymoney;.
- All tips have been extracted from the Frequently Asked Questions list (FAQ)
+ All tips have been extracted from the Frequently Asked Questions list (&FAQ;)
that provides more detailed help and can be found on the project website and in this manual.
Please click on Close to close the Tip of the Day
dialog.
When you run &kmymoney;, it might not look exactly like the screenshots in
this manual. Many details, such as fonts, colors, and icons, can be
customized, either using the
SettingsConfigure
- &kmymoney;... dialog or the KDE System Settings
+ &kmymoney;... dialog or the &kde; &systemsettings;
application, depending on your operating system.
The main windowThe Main WindowThe Main Window
The &kmymoney; main window consists of four major parts
A. The menu barB. The toolbarC. The View selectorD. The view
The menu and toolbars provide access to the features of &kmymoney; and allow
you to Create files or configure how
&kmymoney; operates.
On the left side of the main window, the view selector consists of at least
eleven icons with optional labels, depending upon the software provided by
your system. More icons could be added by various plugins. By clicking on an
icon, the view window on the right hand side is loaded with the appropriate
view of your financial data. Each view provides a unique representation of
your financial situation and allows you to view or edit the information shown.
The view selector may contain the following icons
Home View
Home: A configurable overview of your current financial situation (or an
introduction page when no data file is open).
Institutions View
Institutions: All of your institutions and accounts displayed in a
hierarchy.
Accounts View
Accounts: All of your accounts displayed in a hierarchy.
Schedules View
Scheduled Transactions: Your recurring bills and deposits.
Categories View
Categories: Special accounts that provide a means for you to group
associated transactions.
Tags View
Tags: Special accounts that provide an additional means to Categories for
you to group associated transactions.
Payees View
Payees: All Payees used by &kmymoney;. These are all the people or
organizations you pay money to or receive money from.
Ledgers View
Ledgers: Your account transactions.
Investments View
Investments: Your portfolio summary.
Reports View
Reports: A collection of useful reports, providing alternate, customizable
views of your financial data.
Budgets View
Budgets: Your budgets
Forecast View
Forecast: This view provides a forecast of your accounts and categories
Outbox View
Outbox: Used by the online banking module to provide feedback on running
processes. This view is provided by the KBanking plugin and may not be
present on your system.
Creating a new file
&kmymoney; keeps all the data about your finances in a file. As was stated in
Defining the
accounts (personal records), you can keep more than one set of
accounts, but the data for each will be kept in a separate file, and
&kmymoney; can only have one file open at a time. See the chapter on File Formats for more details about
&kmymoney;'s data files.
To create a new file you can either select
FileNew
from the menu or choose the New
icon from the toolbar. In addition, if the main welcome page is displayed,
you can also select the first link: "Get started and setup accounts."
&kmymoney; will then open the New File Setup Wizard which will
guide you through the process of creating the file.
Personal Data PagePersonal Data Page
Since all fields are optional, you can use &kmymoney; without entering any
information now. Any information entered here is used only to personalize
your file. In the future, it may be used in some reports and for online
banking. If &kmymoney; requires any personal information in future releases
and finds none, you will be prompted to enter the relevant data then.
Please enter your name and address or nothing and press
Next.
In case you have an address for yourself stored in the &kaddressbook;, the
button Load from Addressbook is enabled and pressing it
imports all information into &kmymoney;.
&kmymoney; supports multiple currencies. To set your base currency (the
currency you use day to day and which will be used for your reports), select
the appropriate entry from the list provided and press
Next. A default will be selected from &kmymoney; based
upon your locale settings.
In the following example, US Dollar has been selected as the base currency.
Base currency selection PageBase currency selection page
The following page allows you to create an initial account. For the typical
&kmymoney; user this is a checking account.
Checking account creation PageChecking account creation page
Enter the name of the account and a possible account or reference number
assigned by the institution managing the account. Enter the opening date of
the account and the opening balance of the account. For example, you want to
use &kmymoney; to manage all your finances as of 2008-01-01, then enter the
balance of the account at the beginning of this date. The number can possibly
be obtained from a paper statement. Also enter the name and routing number of
the institution, though this information is optional and only required for
online banking purposes.
In case you don't want to setup an initial account, please uncheck the check box.
Once finished, press Next to proceed.
Account template selection PageAccount template selection page
Choose the appropriate country and account template(s). Each template provides
a different set of categories for organizing your finances. Multiple
templates, even from different countries, can be selected using a combination
- of &Ctrl; and &Shift; together with the left mouse button. The account
+ of &Ctrl; and &Shift; together with the &LMB;. The account
hierarchy to be setup will be shown in a preview part of the wizard. In case
you cannot find a template that suits your needs, don't select a template at
this time, and you can manually set up categories later.
Once finished with the template selection press Next to
proceed.
The next page of the wizard allows you to setup user preferences. If you
select the checkbox, the application settings dialog will be displayed after
you have completed the account setup wizard. Press
Next if you are done and want to proceed.
Preference PagePreference page
The last page of the wizard allows you to select the location and filename
that will be used to store your financial data. Initial values will be
constructed out of your HOME folder and user name. In case the file exists, a
warning will be displayed which reminds you to select a name of a non-existing
file.
Filename selection PageFilename selection page
Now you have entered all relevant information to create the file. Press
Finish and &kmymoney; will create the file for you and
open it.
Creating accounts
There are multiple ways you can create an account, which are described here:
Using the menu
To create an account using the menu select
AccountsNew
account.
Using the Accounts view
To create an account using the accounts view click on the Accounts icon
in the view selector to display the Accounts View. Right click on the
either the Asset tree icon or the Liability tree icon in the right hand
view and select New account from the popup
menu. The Asset tree holds all of your accounts that are an asset, such
as savings and investments. Liabilities are accounts that represent
money you owe, such as loans and credit cards. These and all the other
account types are discussed in more detail later in this manual.
Using the toolbar
If the New Account... button is displayed on the
toolbar, you can click it to create an account.
Note that &kmymoney; uses context menus a lot throughout the whole
application. If you find yourself stuck trying to figure out how to do
something, try right-clicking where you would expect to see a feature.
Creating a new account by either method opens the New Account
Wizard. This wizard will take you step by step through the process
of creating an account, gathering the required information at each step. To
navigate through the pages click on the Next and
Back buttons.
Create an account using any of the previously mentioned methods to continue.
A full description of creating accounts can be found in the Accounts section.
Now that one or more accounts exist in &kmymoney;, your account summary is
shown in the Home view. You can create transactions manually in the Ledgers view, or set up automatic
transactions through the Schedules
view.
Schedules
Sometimes called a recurring transaction, a Schedule is a transaction that occurs one
or more times over a certain period of time. A typical example is your pay
check that you receive every month or week. Rather than have to enter the
transaction details each time you get paid, you can instruct &kmymoney; to
create a schedule that will enter a transaction for you when you get paid.
To maintain schedules click on the
Schedules icon in
the view selector.
Categories
To maintain categories click on the
Categories icon in the view selector.
A full description of this topic can be found in the Categories section.
Tags
To maintain tags click on the Tags icon
in the
view selector.
A full description of this topic can be found in the Tags section.
Payees
To maintain your list of payees click on the Payees icon
in the
view selector.
A full description of this topic can be found in the Payees section.
Quicken Interchange Format (QIF) Import
If you currently use another financial manager application, &kmymoney; can
import an account's transactions as long as they can be exported or saved in a
format &kmymoney; understands. The most common of these is the Quicken
Interchange Format (QIF). Most financial programs can export this format,
although the different applications' methods of exporting QIF is not discussed
here for brevity.
A full description of this topic can be found in the QIF Import section.
Searching for transactions
&kmymoney; provides a useful and powerful transaction search facility in the
form of the search dialog.
The search dialog can be opened from the toolbar using the Find icon
or by selecting Find Transaction from the
Edit menu.
A full description of this topic can be found in the Search section.
Reconciliation
At some point you will want to reconcile the transactions you have entered
with the transactions listed in a statement, be it a bank statement, credit
card statement, loan statement, or any other statement. Reconciliation
involves matching what you have entered with what the statement lists. If any
discrepancies are found then either you or the person who created the
statement have made a mistake.
To reconcile an account, first select the account, either from
Accounts view or from Ledgers
view. Then, either click on the Reconcile icon on the
Toolbar, or select Reconcile from the
Account menu.
A full description of this topic can be found in the Reconciliation section.
Backing up
Now that you have created some accounts and entered transactions it's a good
idea to perform a backup. Because the file used by &kmymoney; is a standard
Unix file you can just copy the file to another location to back it up or use
the dialog provided by &kmymoney;. Using the dialog is the preferred method
because if &kmymoney; ever starts using other file formats, such as SQL, then
it would be much harder to copy the file manually.
To backup your file through &kmymoney; Select
Backup from the File menu and
enter the folder where you wish the file to be saved. If the folder
needs mounting first and you have the sufficient privileges then check the
tick box labeled Mount this directory before backing up
and click on OK.
The file will be saved to the folder specified with the current date appended
to the filename so it is easy to see the date the file was backed up.
Launching &kmymoney;
Most commonly, you will launch &kmymoney; from an icon or a start menu of your
window manager. In this case, the default behavior is that &kmymoney; will
open the last file you had open. However, in some circumstances, you will
want or need to launch &kmymoney; from the command line.
For a complete description of all the available command line options, see the
man page for &kmymoney;. However, there are two special cases which we
describe here.
kmymoney -n
The -n option tells &kmymoney; not to open the last file it had open. This
can be useful if the program crashes on startup.
kmymoney <path to file>
Giving &kmymoney; a filename on the command line tells it to open that file
instead of the last file it had open. You can use the name of any valid
&kmymoney; file, as described in the chapter on file formats. In addition, this can be
used to import a GnuCash file.
How to move &kmymoney; to a new computerMoving your data
If you get a new computer, it's very easy to move your data. In fact, all you
have to do is to copy your &kmymoney; data file. The name of the file is
shown in the title bar when &kmymoney; is running, it usually ends in .kmy.
The first time you run the application on the new computer you will have to
tell it where you have put the data file, either by running from the command
line, or from the
FileOpen...
menu. You should even be able to move between &Windows;, &MacOS;, and &Linux; systems.
If you have encrypted your data file, be sure the appropriate software and
keys have also been set up on the new computer.
If your data is in an SQL database, refer to documentation for your database
software for guidance on migrating your data.
Note that this assumes you have installed the same version of &kmymoney; on the new
computer as you were running on the old computer. Installing a newer version should
also be safe, but you need to be aware of any issues related to that upgrade. Any such
issues should be noted in the release notes for the new version.
Moving your settings
If you only move your data file to the new machine, as described in the
previous section, &kmymoney; will work correctly, but you will have lost any
settings you changed from the default on your old machine. To maintain these
settings, you also need to copy your configuration file. This file is called
kmymoneyrc. This file will be in a directory with other &kde;
application configuration files. On a &Linux; system, this will be in
$KDEHOME/share/config where $KDEHOME is usually
.config within your home directory. If you are migrating from
a version of &kmymoney; prior to 5.0 to 5.0 or later, the old location
of $KDEHOME was .kde4.
Moving plugin settings
If you have run any &kmymoney; plugin, such as the csv importer or exporter,
it may also have created a configuration file in that same directory, such as
csvimporterrc or csvexporterrc. These should also be copied to the new
computer.
As with the main data file, this assumes the same version of the plugin on
both computers. Upgrades are generally safe, but if the functionality of the
plugin has changed greatly, it is advisable to carefully test using the old
configuration file, to be sure the plugin behaves as you expect.
Note that when upgrading from a previous version to version 5.0 or higher, the
location of the template files used by the plugin for printing checks has
changed. Please consult the release notes or the project website for more details.
These instructions are solely for moving your &kmymoney; data and settings.
However, there may be important items which are stored by &kde; and not by
&kmymoney;, such as passwords stored in kwallet. Moving other parts of
your &kde; setup is beyond the scope of this manual, although many of the
relevant files are also stored under $KDEHOME.
Contacting the Developers / Reporting BugsContacting the developers
For general questions or comments about &kmymoney;, there is a users' mailing
list &userlist;. (more details
here.) In addition, you can contact the developers through their
mailing list &devlist;. (more details
here.) Since replies are often sent only to the list, you may not get
any response unless you subscribe to one of the lists before sending to it.
We're happy to hear about your experiences using &kmymoney;.
Reporting bugs
To report a bug please use the interface provided by &kmymoney; by selecting
HelpReport
Bug and filling in the required information.
However, in case you have any difficulties with that method, you can report a
bug (or file a wish-list or enhancement request) directly at the &kde; bug reporting web site. Reports
should be filed against the product kmymoney.
In any case, before reporting a bug, please read through the guidelines below.
Following them will make it more likely that the developers will be able to
quickly identify the problem without having to ask you for more information.
Writing High Quality Bug Reports
We encourage users to take extra time to write high-quality bug reports when
submitting them. This reduces wasted effort on all sides, as the reporter and
the developer who will fix it trade emails until this information is really
in place.
Eli Goldberg wrote the canonical Bug-Writing Guideline, available at http://issues.apache.org/bugwritinghelp.html.
Generally, you'll be well-served by following these guidelines:
Include your system information
The HelpReport
Bug menu choice will fill this in automatically,
but if you would prefer not to use this interface, there are several items
you need to include in the report. We will need to know what operating
system you are using (&Linux;, &MacOS;, or &Windows;), the version of &kde;,
and the version of &kmymoney; you're running, and either the version of
&MacOS; or &Windows; or the name and version of your &Linux; distribution
and the version of your kernel.
Include a backtrace for crashes
The backtrace is often the single most useful piece of information in
solving crashes.
Try to reproduce it
Let us know if you were able to do so. It's useful to know whether the bug
only happened once and you couldn't get it to happen again or happens every
time or happens sometimes but not others.
Include specific steps
This is a bad bug report: I entered a transaction, and &kmymoney;
crashed. A much better bug report is: Using the transaction
form, I entered a new transaction in my Credit Card account. I selected the
Transfer tab, entered in an amount, then changed to the Deposit tab, and
back to the Transfer tab. When I returned to the Transfer tab, &kmymoney;
crashed. This bug is fully reproducible for me.Tell us what you expected to happen
In some cases, this is obvious, but in more subtle bugs, sometimes you'll
see a bug report where it is not obvious what the reporter expected to
happen. Always tell us what you think should have happened.
Consider running with debugging enabled
By compiling a version configured with --enable-debug=full you can ensure
that the best possible backtraces are generated. If you encounter a crash,
run &kmymoney; again from within gdb, and reproduce the crash. When it
crashes, type bt to generate a backtrace.
Running this way is a bit more difficult, so we don't expect all users to do
this. However, if you're interested in helping &kmymoney; become as stable as
possible, this is the best way to do it short of finding the bug in the code
and sending in a patch.
diff --git a/doc/installation.docbook b/doc/installation.docbook
index b7f43d6f8..7f903ef94 100644
--- a/doc/installation.docbook
+++ b/doc/installation.docbook
@@ -1,217 +1,217 @@
&Jack.H.Ostroff; &Jack.H.Ostroff.mail;2014-08-304.7.01Installation
This appendix primarily addresses the installation of &kmymoney; under the
&Linux; operating system. The final
section addresses other operating systems.
How to obtain &kmymoney;
&kmymoney; has existed for a number of years, and we have worked very hard on
full integration into &kde;. The earliest stable versions (1.0.x) required
libraries from &kde; 3, and so were not available in many Linux distributions,
which had already migrated to &kde; 4. However, with the release of version
4.5 in August 2010, &kmymoney; could be easily compiled and installed on any
version of &kde; 4.3 or higher. The current version, 4.7, requires &kde; 4.6,
specifically kdelibs and kdepimlibs.
- Although work has begun porting &kmymoney; to the new KDE Frameworks 5, this is
+ Although work has begun porting &kmymoney; to the new &kf5-full;, this is
still very early, and not yet usable. Hopefully it will be available in the
5.0 version, which we expect to release in early 2015. Until then, if you are
specifically interested in following this work, you should subscribe to the
developers mailing list &devlist;.
The rest of this section will describe installing &kmymoney; using the
standard software installation process for your Linux distribution. The
following section will discuss compiling from source.
Official Distribution Packages
The best way to install &kmymoney; is to use the package manager of your
distribution, such as apt-get, yum, portage, or pacman. This will take care
of all the dependencies and required libraries. Although it takes some time
after the release a new version of &kmymoney; for all the distributions to add
it to their official repositories, please check there first.
Unsupported Repositories
Many Linux distributions have users who provide unsupported repositories that
offer more up-to-date packages than the distributions' official repositories.
A list of these may be found at the &kmymoney; home page.
Compiling &kmymoney; from Source
More up-to-date information on the latest available version and any known
installation issues will be available on the &kmymoney; home page. That page will
also have links to tarballs of recent versions as well as instructions for
- obtaining the source from &kde; Git, in case you want to compile the latest,
+ obtaining the source from &kde; &git;, in case you want to compile the latest,
development version.
As the previous paragraph implied, there are two distinct reasons to compile
&kmymoney; from source. If you cannot find a version specifically packaged
for your distribution, please download the tarball of the most recent stable
release. This is version 4.6.0 as of the time this is being written. This is
the compile option recommended for normal users.
On the other hand, if you want to see the current state of development, to
check out a recent bug fix or new feature, you can download a tarball which is
a snapshot of the development repository. You can also check the source
- directly out of the repository. The version 4.x source is in &kde; Git. (The
+ directly out of the repository. The version 4.x source is in &kde; &git;. (The
version 1.0.x source was in SourceForge cvs, but it is no longer being
developed or supported at all.) Instructions for access are on the project
home page.
- The code in the Git repository and in development snapshots is under active
+ The code in the &git; repository and in development snapshots is under active
development: it may have bugs, it may crash, and it may mess up or lose data.
If you use it, be absolutely sure to make adequate backups. Unless you have
a good reason to use this, stick to a stable released version.
Required libraries
&kmymoney; depends on certain libraries in order to compile and run
properly. First is KDE version 4.3.5 or later, specifically kdelibs and
kdepimlibs. Depending on your distribution, you may need to explicitly load
the -devel versions in order to compile &kmymoney;, rather
than just running a pre-compiled version. As of version 4.6.0, &kmymoney;
also depends on libalkimia, version 4.3.1 or higher. Additional
requirements may be detected during the cmake step below.
Additional functionality can be obtained if extra libraries are available at
compile time. The two most common are
libofx, version 0.9.4 or higher, to be able to import financial data
in the OFX format, andAqBanking, version 5.0.0 or higher, to be able to use certain on-line
banking features. Note that version 5.0.14 or higher is strongly
recommended, due to bugs in earlier versions.Build instructions
&kmymoney; uses the cmake build system. Further information can be found in
the README.cmake file in the root folder of the source. The basic steps are
the following:
$ mkdir build$ cd build$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr/$ make$ sudo make install/fast
Note that the last step is required. &kmymoney; expects to find certain
components in standard locations, and if you run it from within the build
directory without the install step, you will have missing icons or other
surprises.
- If you have compiled the source from git, and want to update to the latest
+ If you have compiled the source from &git;, and want to update to the latest
revision, most of the time you can do the following:
$ cd <path to root of source>$ git pull --rebase$ cd build$ make$ sudo make install/fast
However, changes made by the developers sometimes cause compile problems if
you do not start with a clean code base. In these cases, you need to do the
following:
$ cd <path to root of source>$ git pull --rebase$ rm -r build$ mkdir build$ cd build$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr/$ make$ sudo make install/fastInstalling &kmymoney; without Linux
&kmymoney; has been successfully compiled for &MacOS; X, and is available at
the MacPorts web site.
&kmymoney; is also available for &Windows;. This initiative is still a work
in progress, but great improvements have been made in the past year. For more
information about running &kde;, including &kmymoney; on &Windows; see the
KDE on Windows Initiative page.
For a standalone installer that only installs &kmymoney; see the download link
on the right of the &kmymoney; home
page. Note that the most recent version of this installer no longer
works on &Windows; XP. At the time of this release, it was not known if this
could be changed, as the issue was related to the tools used to build the
application, not the application itself.
If you know of &kmymoney; being successfully compiled and made available for
any other operating system, please let us know, so we can spread the word.
diff --git a/doc/makemostof.docbook b/doc/makemostof.docbook
index 53329d188..c572ab710 100644
--- a/doc/makemostof.docbook
+++ b/doc/makemostof.docbook
@@ -1,383 +1,383 @@
Joe(joe1011010)joe1011010_km@users.sourceforge.net2010-07-194.5Making the most of &kmymoney;
While you could go ahead, clicking some buttons and filling in some data,
after a time, you could decide you have done it wrong and start again, even if
you did read the documentation on each part of &kmymoney;.
You will get a more effective system if you spend a little time planning how
you are going to use &kmymoney;, so follow the steps given here.
Basic Accounting
Imagine your money as balls, or beans, and to stop them rolling around you
keep them in a box, or pot. Accounting, or Bookkeeping, is the process of
counting and keeping track of the beans in the pot, or several pots.
You have some money in the pot marked Cash. You buy some goods,
so you take some beans out of the cash pot and place them into another pot
marked Supplier. The supplier gives you some goods in exchange
for the cash, so you take the beans out of the pot marked
Supplier and put them in the pot marked Goods.
The goods have a value (the price you paid) so you still have the same amount
of beans, some representing cash and some representing goods.
In this case you have two movements of beans, or transactions. Each
transaction needs two entries, one to take beans out and one to put beans
in. This is called double entry bookkeeping or double
entry accounting. The recording of the transactions is done in a
Ledger; each pot is known as an Account or
Ledger code.
Now you take some goods and give them to a customer, who gives you some cash
in exchange. The goods were worth some beans and, hopefully, the customer has
given us more beans than that, so making a profit. To over simplify, the beans
from the Goods pot come back as Cash, but we can split that as the Cost
of Goods sold and Profit. This transaction has three
entries; one side of the double entry has been split.
This will be covered in more detail later on in this handbook.
Defining the accounts (personal records)
Most accounts, or pots, above represent a measure of our Worth.
The cash and goods represent our Assets; so does what we are
owed if our customers have not yet given us the money. The money we owe, say
if we had not paid our suppliers, are our Liabilities. These
accounts are transferable to Cash and have a value.
Any pots that cannot be valued are Income or
Expense. Our phone bill (or the phone company to which we pay
the bill) cannot be valued; we know how much we have paid, but not how much
anyone else has paid. We know how much our employer has paid us, but we do
not know how much they have paid anybody else, or how much money they have
left to pay us next month. Although we cannot determine an actual value for
these pots, it is useful to monitor how much we have put into or taken out of
each of them.
In some cases a supplier is a Liability, in others it is an
Expense. This is something we need to consider and decide for
each case. Similarly, you may set up a loan as a Liability, particularly if
you transfer the money into your bank account, but it could be an Expense if
it was to buy some furniture.
Consider how you want to track and analyze your income and expenses. This will
help you decide how to set them up in &kmymoney;.
Finally, consider if you want everything in one set of accounts, or two or
more. This may depend on the legal framework or just how you want to analyze
things. Each set of accounts would be handled separately.
Defining the accounts (business records)
There are similarities to setting up accounts for personal use, but there are
additional considerations, including legal guidelines and requirements.
&kmymoney; does not explicitly address any of these issues, as it has been
designed as a personal finance manager. In addition, these
additional issues are not addressed in this handbook, but you must be aware of
them if you are going to attempt to use &kmymoney; for a business.
Mapping your finances to &kmymoney;
So, collect up your papers and see the following sections for each item in
&kmymoney;.
Accounts
These hold a value. Transactions are created against one or more accounts.
Accounts - Asset
These are the accounts which hold your money and possessions that you wish to
monitor. The following types are available:
Checking
Standard bank checking account.
Savings
Standard bank savings account.
Cash
Money in your hand or wallet.
Loan
Loans you make to someone else.
Investment
Money you invest.
Asset
- Property, collections, etc.
+ Property, collections, &etc;.
Accounts - Liability
These are the accounts which represent your debts and money owed that you wish
to monitor. The following types are available:
Credit card
Standard credit card account.
Loan
- Loans made to you, mortgages, etc.
+ Loans made to you, mortgages, &etc;.
Liability
Anything else you owe that is not a loan.
Institutions
These are completely optional and can be used to group accounts, and show a
total value for all accounts in each group.
Categories
These represent non-managed income and expense accounts that do not have a
value. The total value of transactions is shown against each category. A
category or transfer account is required for each transaction.
Sub-Categories
Categories can be split into sub-categories, but this relationship is only for
display purposes, as the sub-category totals are not included in the higher
level category total.
Tags
Tags are very similar to Categories, as they are also non-managed accounts
that do not have a value. However, unlike Categories, the use of Tags is
completely optional.
Payees
These are optional for transactions. They are required for Scheduled
transactions. A transaction history, with category, is shown against each
payee.
Scheduled transactions
Where transactions occur on a regular basis, these can be set up against a
Schedule. Transactions are created from a schedule; any that are overdue can
be seen on the home page.
Useful Tips
Unless you keep your money under your mattress or under the floorboards, you
probably make use of one or more institutions where you have accounts, which
may be in credit or debit. In order to familiarize yourself with the way
&kmymoney; works, choose an account you want to track with &kmymoney; and
select FileNew in order
to set up an account file.
If you have used another personal finance manager, you may be able to import
the data from it into &kmymoney;.
If you have some regular receipts into or outgoings from this account, go to
Payee and enter the names of both the payers and the payees involved; then go
to Schedule and fill in a New Schedule for each recurring transaction. If you
haven't entered the payee or payer, &kmymoney; will offer you the opportunity
to do this in the middle of entering the schedule.
To add other new transactions go to Ledgers; you can add new payees and
categories in the middle of a transaction or by going to Payees or Categories
before entering the transaction.
You will probably find that the default Categories do not exactly match your
needs; you can easily delete ones you know you are never going to need and add
others that you need. But when you are entering a transaction, you only have
to type a few letters of a category and &kmymoney; will offer you a drop down
list of the matching categories from which to choose.
You can add different accounts managed by different institutions; the
preferred one will show when you open &kmymoney; but you can quickly switch to
any of the others.
When you make a payment, &kmymoney; will work out what the next check number
should be; delete this if you are not making a check payment or edit it if
the first check you enter is not check number 1. Alternatively, it is
possible to switch off auto-increment of check numbers.
Every so often you may get statements of your account from the institutions
you use; you can reconcile your &kmymoney; accounts against these statements
so that you have an accurate statement of the current state of your finances.
If you go to Reports, you will find several default reports; to customize
these, open one similar to the sort you prefer and then select 'New' (not
'Copy'); you can then customize this to your needs and mark it as a preferred
report if you wish.
Though &kmymoney; is not intended for use in a business context, if you are
running a business on your own and so do not need payroll functions, you will
probably find that &kmymoney; is sufficiently customizable to meet your needs
particularly as it comes with budgeting and forecasting features and you can
export your customized reports via CSV into other applications.
diff --git a/doc/reference.docbook b/doc/reference.docbook
index cec7089a3..49aadb6fe 100644
--- a/doc/reference.docbook
+++ b/doc/reference.docbook
@@ -1,794 +1,794 @@
2016-12-055.0Reference &Roger.Lum; &Roger.Lum.mail; Menus
Below is a complete list of the menu selections in &kmymoney;, with a very
brief description of what each one does. Note that many of these menu choices
will be unavailable, or grayed out, depending on the current display or state
of the application. For example, you are not able to edit an account unless
you have an account selected or displayed in the current view.
File Menu&Ctrl;NFileNew Creates a new empty &kmymoney; data file. Only one
&kmymoney; file can be open at once, so this will close your current file
first, if one is open. &Ctrl;OFileOpenOpens an existing &kmymoney; data file.FileOpen Recent...Allows quick access to recently opened
files.FileOpen Database...Opens an existing database.&Ctrl;SFileSaveSaves the currently open file.&Ctrl;&Shift;SFileSave As...Saves the currently open file with a different
filename.FileSave As Database...Saves the currently open file in a Database.FileImport...Imports financial data from other file types, such as QIF
and Gnucash, or a template file of accounts and categories that can be
used in setting up new accounts.FileExport...Exports the current file as a different file type, such as
QIF, or exports a list of your accounts and categories as an template.
&Ctrl;PFilePrintPrints the current file.FileBackupSaves a backup the current file.FilePersonal DataAllows to edit personal data.FileFile informationDisplays information about the currently open &kmymoney;
file.&Ctrl;WFileCloseCloses the current file.&Ctrl;QFileQuitQuit &kmymoney;Edit Menu&Ctrl;FEditFind transaction...Search transactions.View Menu&Ctrl;TViewShow Transaction Detail
Shows transaction details in the Ledger view. With this option turned
on, all lines of the transaction will be shown in the ledger. When it
is turned off, only one line will be shown.
If you only want to see details for the currently selected transaction,
but only one line for the others, you can turn on the Ledger Lens.
&Ctrl;RViewHide reconciled transactionsHides reconciled transactions on the
register.&Ctrl;UViewHide unused categoriesHides unused categories in the views.
&Ctrl;&Shift;AViewShow all accountsShows all accounts in the views.Institution MenuInstitutionNew institution...Add a new institution.InstitutionEdit institution...Edit an institution.InstitutionDelete institution...Delete an institution.Account MenuAccountNew account...Adds a new account.AccountEdit account...Edits an account.AccountDelete account...Deletes an account.AccountOpen ledgerDisplays the ledger view of an account.
&Ctrl;&Shift;RAccountReconcile...Reconciles an account through the reconciliation
wizard.AccountPostpone reconciliationPostpones reconciliation of an account.AccountFinishFinishes reconciliation of an account.AccountTransaction reportOpens a transaction report of an account.AccountClose accountCloses an account.AccountReopen accountReopens an account, if closed.AccountUnmap accountUnmaps an online account.AccountMap to online accountMaps an account to an online account.AccountUpdate account...Imports transactions from online banking for an
accountAccountUpdate all accounts...Import transactions from online banking for all
accounts.Category MenuCategoryNew category...Adds a new category.CategoryEdit category...Edits a category.CategoryDelete category...Deletes a category.CategoryOpen ledgerDisplays the ledger view of a category.Transaction Menu&Ctrl;&Ins;TransactionNewAdds a new transaction.TransactionEditEdits a transaction.TransactionEdit splitsEdits the splits of a transaction.TransactionDeleteDeletes a transaction.TransactionDuplicateDuplicates a transaction.TransactionMark transaction as ...Not ReconciledChanges a transaction to Not Reconciled
status.
- &Ctrl;&Alt;Space
+ &Ctrl;&Alt;&Space;
TransactionMark transaction as ...ClearedChanges a transaction to Cleared status.
- &Ctrl;&Shift;Space
+ &Ctrl;&Shift;&Space;
TransactionMark transaction as ...ReconciledChanges a transaction to Reconciled status.TransactionGo to accountDisplays the other account of a transaction.TransactionGo to payeeDisplays the Payee view and focuses on the payee of the
selected transaction.TransactionCreate scheduled transaction...Creates a new scheduled transaction.TransactionMatchMatches imported transactions.TransactionUnmatchUnmatches a transactions that &kmymoney; has proposed
as a match of imported transactions. Note that this
menu choice is only present if a matched transaction exists.
TransactionAcceptAccepts a proposed merge of imported
transactions.&Ctrl;ATransactionSelect allSelects all transactions on the register.TransactionPrint checkPrints the contents of the selected transaction in the displayed
register, formatted according to the selected template. Note
that this menu choice is only present if a transaction is selected in
the register. See the section on configuring the Print check plugin for more
information.
Tools MenuToolsQIF Profile Editor...Modifies the QIF profile used to import or export QIF
files.ToolsCurrencies...Lists the currencies known to &kmymoney;.ToolsPrices...Lists stock and currency prices.ToolsUpdate Stock and Currency Prices...Updates stock and currency prices from online sources using
the Online Price
Quotes feature.ToolsConsistency CheckRuns a check on your file and tries to fix any problem it
finds, if possible.Make a backup of your file before running this option.ToolsPerformance-TestRuns a performance test on your file and displays the
results.Settings and Help Menu&kmymoney; has the default &kde; Settings and Help menu as described in the
&kde; Fundamentals
with one additional entry:SettingsEnable all messagesRe-enables any messages you may have turned off by checking
Don't tell me about this again in a dialog
box.
&details-widgets;
diff --git a/doc/whatsnew.docbook b/doc/whatsnew.docbook
index fb8fa311e..2e4c5fd82 100644
--- a/doc/whatsnew.docbook
+++ b/doc/whatsnew.docbook
@@ -1,117 +1,117 @@
2018-02-015.0.0What's new in this release
As with every release, the &kmymoney; development team has been working hard
to make this release better and easier to use in every way. We have also made
quite a few improvements. We are confident you will like what you see.
- The largest amount of work has gone towards basing this version on KDE
- Frameworks. Many of the underlying libraries used by the application have
+ The largest amount of work has gone towards basing this version on
+ &kde-frameworks;. Many of the underlying libraries used by the application have
been reorganized and improved, but most of that is behind the scenes, and not
directly visible to the end user. Some of the general look and feel may have
changed, but the basic functionality of the program remains the same, aside
from intentional improvements and additions.
In addition to adapting to new and updated libraries, there have also been
numerous bug fixes, as well as several new features and improved
functionality. Although this means there have been some major changes to the
underlying code, this version has actually been used in production by many of
the developers, so it has actually had a significant amount of testing.
Here are some of the new features found in this release:
Multiple improvements to reports, including better performance.
Allow logarithmic axes in report graphs.
When deleting a security, automatically delete its prices.
Allow separate beginning balance accounts for different currencies.
Added support for several new currencies
Here are some of the major bugs which have been fixed:
Elimination of several crashes.
Fix problems with report graphs using older data.
Fix rounding errors in some investment transactions.
Removed Yahoo from stock and currency price sources, as they no longer
provide this service
There are a some changes which will need some adjustments on the user's side
if you are upgrading from 4.8.x or an older version
The program searches for the templates for the printcheck plugin in
different locations. The user needs to account for this in the plugins
setting dialog, see this section
for more details.