adding accounts.md

portfolio-performance · Aug 29, 2023 · 4e03da9 · 4e03da9
1 parent 2f36c3e
commit 4e03da9
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 2 deletions.
diff --git a/config/en/mkdocs.yml b/config/en/mkdocs.yml
@@ -70,5 +70,5 @@ markdown_extensions:
 
 nav:
   - Welcome: index.md
-  - Lizenz: license.md
+  - License: license.md
 
diff --git a/docs/en/accounts.md b/docs/en/accounts.md
@@ -0,0 +1,42 @@
+---
+title: Types of accounts
+---
+An account is a collection of [transactions](/pp/transaction). These could be buy and sell transactions of securities (shares, …) in case of a Securities account or the withdrawal and deposit of money for a Deposit account. Each account has a default currency attached. As part of the installation procedure, you should already have created at least one Securities account and one Deposit account.
+
+PP has two main type accounts: Securities and Deposit accounts. They are rather well described in the [Guide on getting started]([https://forum.portfolio-performance.info/t/guide-on-getting-started/5390#accounts-6]) of Thomas (Contributor); you have to scroll quite a bit down.
+
+Other related terms are “Investment Plans”, “All Transactions”, “Reference account” and “Offset account”. Sometimes a Deposit Account is called a Cash Account.
+
+# Deposit account
+
+<img src="../images/account-types-deposit.png" alt="Account type Deposit" style="zoom:100%;" />
+<figcaption>Figure 1: Example of a Deposit Account</figcaption>
+
+
+In figure 1, there are two deposit accounts; named EUR and USD (in column Cash Account). They will be used for deposits and withdrawals in EUR or USD. It's a bit redundant to call them “EUR” and “USD” because you also have to specify the currency that the account will use (see third column in figure). Then, for example, when you want to book a dividend in EUR, you will get the following dialog. The cash account can be selected from a drop-down and the correct currency is automatically added.
+
+
+<img src="../images/account-dividend-booking.png" alt="Deposit Account with redundant Currency" style="zoom:50%;" />
+<figcaption>Figure 2: Deposit Account with redundant Currency</figcaption>
+
+According to your needs, you can use other names. For example, if you want to collect all of your dividends or taxes in a separate account, you could name them “Dividends” and “Taxes” in stead of EUR and USD. Of course, you also have to decide which currency that will be used for them. And, if you receive dividends in both EUR and USD then you need two deposit accounts with the name “Dividends” but with different currencies.
+
+Another possibility is to name the deposit accounts with the name of the bank or broker they belong to; e.g. BNPPF, Deutsche Bank, …
+
+A deposit account is used to transfer or receive money as the result of a transaction. In figure 1 (bottom part), 4 buy/sell transactions result in a negative balance (-2210 EUR). Good practice however requires that you first add a deposit of a large enough sum to cover the subsequent buy transactions; just as you should do with a real broker.
+
+# Securities account
+
+A security account will hold your securities and will be used for buying or selling securities. A security account is most of the time named after the broker or bank that you use to buy or sell.
+
+<img src="../images/account_securities.png" alt="Example of Securities accounts" style="zoom:50%;" />
+<figcaption>Figure 3: Example of Securities accounts</figcaption>
+
+# Related terms
+
+## Reference account
+
+A security account is always associated with a deposit account. This is the deposit account that will used (if no other is explicitly assigned) for any buy or sell transaction on that securities account. This deposit account is called Reference Account. In figure 3, the Broker-A security has a reference account Broker-A (EUR) while the Broker-B security account has a USD-deposit account (Broker-B (USD). Probably, you use Broker A mostly for your EUR transactions and Broker B for the USD transactions.
+
+## Offset account
+Offset account is translated from the German "Gegenkonto. It is the account used as the twin-account for a transaction. If you buy a share, then the Securities account is debeted and the "Gegenkonto" deposit account is credited.
diff --git a/docs/en/images/account-dividend-booking.png b/docs/en/images/account-dividend-booking.png
diff --git a/docs/en/images/account-types-deposit.png b/docs/en/images/account-types-deposit.png
diff --git a/docs/en/images/account_securities.png b/docs/en/images/account_securities.png
diff --git a/docs/en/index.md b/docs/en/index.md
@@ -31,7 +31,7 @@ In order to be able to track, evaluate and manage your securities portfolio with
 
 ### Create portfolio file
 
-- You create a new portfolio file and set up your securities accounts and related clearing accounts in it. The portfolio file contains all securities, accounts, cash accounts, transactions, classifications, etc.
+- You create a new portfolio file and set up your [accounts](accounts.md). The portfolio file contains all of these accounts but also all of your transactions, classifications, etc.
 
 ### Create securities