gnucash-docs master: Multiple changes pushed
John Ralls
jralls at code.gnucash.org
Sat Mar 11 16:35:28 EST 2023
Updated via https://github.com/Gnucash/gnucash-docs/commit/fc817885 (commit)
via https://github.com/Gnucash/gnucash-docs/commit/0916ae4a (commit)
from https://github.com/Gnucash/gnucash-docs/commit/56abc15b (commit)
commit fc81788544a4b5e694943dab391281c7d1598055
Author: John Ralls <jralls at ceridwen.us>
Date: Sat Mar 11 13:35:17 2023 -0800
Document Import using AQBanking.
diff --git a/C/manual/ch_Transactions.xml b/C/manual/ch_Transactions.xml
index 65307e91..f8e370ab 100644
--- a/C/manual/ch_Transactions.xml
+++ b/C/manual/ch_Transactions.xml
@@ -1290,20 +1290,24 @@ Translators:
</listitem>
<listitem>
- <para><emphasis role="bold"><link linkend="trans-import-MT940-MT942-DTAUS">MT940</link></emphasis> SWIFT
- MT940 Customer End of Day Statement Message;
- </para>
- </listitem>
-
- <listitem>
- <para><emphasis role="bold"><link linkend="trans-import-MT940-MT942-DTAUS">MT942</link></emphasis> SWIFT
- MT942 Customer Intra-day Transaction Report;
- </para>
- </listitem>
-
- <listitem>
- <para><emphasis role="bold"><link linkend="trans-import-MT940-MT942-DTAUS">DTAUS</link></emphasis>
- (.DTAUS) Banking data Exchange File;
+ <para><emphasis role="bold"><link linkend="trans-import-aqbanking">Others</link></emphasis> <guilabel>Import with AQBanking</guilabel> supports importing several European and International file formats including:
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">CAMT 052</emphasis>Daily Bank Statements</para>
+ </listitem>
+ <listitem>
+ <para>OLYMPIC Banking System <emphasis role="bold">ERI</emphasis></para>
+ </listitem>
+ <listitem>
+ <para>Spanish <emphasis role="bold">Q45</emphasis></para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">SWIFT MT535, MT940, MT942.</emphasis>Bank Statements</para>
+ </listitem>
+ <listitem>
+ <para>Swiss <emphasis role="bold">YellowNet XML</emphasis></para>
+ </listitem>
+ </itemizedlist>
</para>
</listitem>
</itemizedlist>
@@ -2119,44 +2123,14 @@ Translators:
</caution>
</sect2>
- <sect2 id="trans-import-MT940-MT942-DTAUS">
- <title>Import MT940 and MT942 SWIFT and DTAUS format files</title>
-
- <para>The SWIFT MT940 format is used for an end of day statement by banks using the SWIFT network for data
- exchange. MT942 is used for an intra-day statement in the same system. DTAUS is a format
- used with 9 track magnetic tapes since 1976 and later with other removable media (floppy
- disks). DTAUS has not been supported by banks since 1 February 2016.
- </para>
-<!--FIXME replace with link to glossary if and when extended to help -->
- <para>When you select
- <emphasis role="bold"><guimenu>File</guimenu>-><guisubmenu>Import</guisubmenu>-></emphasis>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold"><guimenuitem>Import MT940</guimenuitem></emphasis> or;
- </para>
- </listitem>
-
- <listitem>
- <para><emphasis role="bold"><guimenuitem>Import MT942</guimenuitem></emphasis> or;
- </para>
- </listitem>
-
- <listitem>
- <para><emphasis role="bold"><guimenuitem>Import DTAUS</guimenuitem></emphasis>.
- </para>
- </listitem>
- </itemizedlist>
- from the menu, <application>&appname;</application> opens a file selection dialog. Navigate
- to the MT940, MT942 or DTAUS format file you wish to import and then click on the
- <emphasis role="bold"><guibutton>Import</guibutton></emphasis> button. On the first import
- of data to a given account specification in the import file,
- <application>&appname;</application> will bring up an account selection dialog to select an
- appropriate account into which to import the transactions in the file.
- <application>&appname;</application> will map the account description in the import file
- onto the selected account and use it for future imports from the same account. The imported
- transactions will then be displayed in the
- <link linkend="trans-import-matcher"><emphasis role="bold"><guimenuitem>Generic Import
- Transaction Matcher</guimenuitem></emphasis></link> for review.
+ <sect2 id="trans-import-aqbanking">
+ <title>Import several file formats with AQBanking</title>
+ <para>If &app; was built with &app-aqb; support and you have &app-aqb; installed on your computer you may use <guilabel>Import using AQBanking</guilabel> to import files in several formats.</para>
+ <para>You will first be presented with a dialog box having two lists. The left one lists importer plugins and the right one lists file format profiles available for that importer. In some cases, for example <guilabel>swift</guilabel>, the profiles include specialized formats for particular bank: Continuing the example the <guilabel>swift</guilabel> importer can import both generic <guilabel>MT940</guilabel> and <guilabel>MT942</guilabel> statements and those specialized for the Netherlands's AMRO Bank.</para>
+ <para>Select an importer and a profile from the lists. &app; will remember your selection for the next time you do an import.</para>
+ <para>Click <guilabel>OK</guilabel> to proceed to the filechooser. Select a file to import and click the <guilabel>Import</guilabel> button to proceed.</para>
+ <para><application>&appname;</application> will process the selected file and map the account description in the import file onto the selected account and use it for future imports from the same account. The imported transactions will then be displayed in the
+ <link linkend="trans-import-matcher"><emphasis role="bold"><guimenuitem>Generic Import Transaction Matcher</guimenuitem></emphasis></link> for review.
</para>
</sect2>
commit 0916ae4a9a2d6ba440052406cd4603b92df9360c
Author: John Ralls <jralls at ceridwen.us>
Date: Sat Mar 11 12:42:42 2023 -0800
Document the new Stock Transaction Assistant.
diff --git a/C/manual/ch_Tools_Assistants.xml b/C/manual/ch_Tools_Assistants.xml
index 38be44e0..b6b94813 100644
--- a/C/manual/ch_Tools_Assistants.xml
+++ b/C/manual/ch_Tools_Assistants.xml
@@ -4854,163 +4854,84 @@
</para>
</sect1>
- <sect1 id="stock-split">
- <title>Recording a Stock Split</title>
+ <sect1 id="stock-assistant">
+ <title>Recording a Stock Transaction</title>
+ <para>While with practice you can quickly enter any stock transaction directly in the register as explained in the <quote>Investments</quote> chapter in the guide, &app; provides an assistant that can help walk you through most common transactions and several less common ones that you might encounter.</para>
+ <para>The assistant is accessed from the <guilabel>Action</guilabel> menu when the current register is for a Stock or Mutual Fund account.</para>
- <para>Stock splits commonly occur when a company decides its stock price is too expensive for individual
- investors to buy the stock. Splits have the effect of lowering the price of a single share
- while keeping the value of shares owned by investors who have already purchased shares.
- </para>
-
- <sect2 id="stock-split-assistant">
- <title>Stock Split Assistant</title>
-
- <para>&app; uses the Stock Split assistant to record stock splits. This provides a way of entering the
- details of the stock split and also any change in stock price or cash disbursement as a
- result of the stock split.
- </para>
-
- <para>The Stock Split assistant is accessed by going to
- <menuchoice>
- <guimenu>Actions</guimenu> <guimenuitem>Stock Split...</guimenuitem>
- </menuchoice>
- .
- </para>
-
- <para>The Stock Split assistant opens with a screen that briefly describes what this assistant does. The
- three buttons at the very bottom of the screen will not change while using the assistant.
- </para>
-
- <itemizedlist>
- <listitem>
- <para>The <guibutton>Cancel</guibutton> button is used to exit the assistant and cancel entering the stock
- split information. Any selections you have made in this assistant up to this point will
- be lost.
- </para>
- </listitem>
-
- <listitem>
- <para>The <guibutton>Back</guibutton> button will bring up the previous screen so you can change a
- selection made on that screen.
- </para>
- </listitem>
-
- <listitem>
- <para>The <guibutton>Forward</guibutton> button will bring up the next screen so you can continue though
- the assistant.
- </para>
- </listitem>
- </itemizedlist>
-
- <para>The next screen allows you to select a Stock Account. Select an account from the list to record a
- stock split or merger.
- </para>
-
- <itemizedlist>
- <listitem>
- <para><guilabel>Account:</guilabel> Lists the &app; account name for the stock.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Symbol:</guilabel> The stock symbol for the stock associated with this account.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Shares:</guilabel> The amount of shares that have been purchased in the account.
- </para>
- </listitem>
- </itemizedlist>
-
- <para>The next screen lets you set the Stock Split Details. The top part of the screen contains details
- used in creating the stock split transaction.
- </para>
-
- <itemizedlist>
- <listitem>
- <para><guilabel>Date:</guilabel> Choose the date of the stock split.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Share Distribution:</guilabel> Enter the amount of shares gained from the stock split. For
- a stock merger enter a negative number.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Description:</guilabel> Enter a description or leave as the default.
- </para>
- </listitem>
- </itemizedlist>
-
- <para>The bottom part of the screen contains details used to record a price for the split (optional).
- </para>
-
- <itemizedlist>
- <listitem>
- <para><guilabel>New Price:</guilabel> Enter the price of the shares on the day of the stock split.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Currency:</guilabel> Choose the currency of the shares.
- </para>
- </listitem>
- </itemizedlist>
-
- <para>The next screen lets you enter a transaction for a cash disbursement (Cash In Lieu) as a result of
- the stock split (optional).
- </para>
-
- <itemizedlist>
- <listitem>
- <para><guilabel>Cash Amount:</guilabel> Enter the amount of the Cash disbursement.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Memo:</guilabel> Enter a memo or leave as the default.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Income Account:</guilabel> Choose an Income Account for the disbursement.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Asset Account:</guilabel> Choose an Asset Account for the disbursement.
- </para>
- </listitem>
- </itemizedlist>
-
- <para>The last screen gives you a list of three choices to finish the assistant.
- </para>
-
- <itemizedlist>
- <listitem>
- <para>The <guibutton>Cancel</guibutton> button is used to exit the assistant and cancel creating the Stock
- Split transactions. Any selections you have made in this assistant up to this point will
- be lost.
- </para>
- </listitem>
-
- <listitem>
- <para>The <guibutton>Back</guibutton> button will bring up the previous screen so you can change a
- selection made on that screen.
- </para>
- </listitem>
-
- <listitem>
- <para>The <guibutton>Finish</guibutton> button creates the transactions for the Stock Split.
- </para>
- </listitem>
- </itemizedlist>
-
- <para>You should now have successfully entered the Stock Split or Merger.
- </para>
+ <itemizedlist>
+ <title>Types of stock transactions supported by the <guilabel>Stock Transaction Assistant</guilabel></title>
+ <listitem>
+ <para>Buy</para>
+ </listitem>
+ <listitem>
+ <para>Sell</para>
+ </listitem>
+ <listitem>
+ <para>Dividend</para>
+ <note>This is for cash dividends; use <guilabel>Stock Split</guilabel> for share dividends.</note>
+ <note>The assistant does not support recording reinvested dividends in a single transaction. If you reinvest dividends, even if it's done automatically by your broker, mutual fund company, or the issuer of the shares, you must record the share purchase with a second pass through the assistant.</note>
+ </listitem>
+ <listitem>
+ <para>Return of Capital</para>
+ </listitem>
+ <listitem>
+ <para>Notional Distribution</para>
+ </listitem>
+ <listitem>
+ <para>Stock Split</para>
+ </listitem>
+ <listitem>
+ <para>Reverse Split</para>
+ </listitem>
+ </itemizedlist>
+ <para>The assistant recognizes long and short positions in the account and adjusts pages it presents to you depending on the transaction type and whether the position is long or short. It optionally capitalizes commissions and fees.</para>
+ <sect2>
+ <title>Transaction Details Page</title>
+ <para> Enter the transaction post date and description on this page.</para>
+ </sect2>
+ <sect2>
+ <title>Transaction Type Page</title>
+ <para>Select the type of transaction from the list. The assistant will display a description of what it will do when you make a selection.</para>
+ </sect2>
+ <sect2>
+ <title>Stock Amount Page</title>
+ <para>This page is displayed for <guilabel>Buy</guilabel>, <guilabel>Sell</guilabel>, <guilabel>Stock Split</guilabel>, and <guilabel>Reverse Split</guilabel> transactions to collect the new share information. For a <guilabel>Buy</guilabel> or <guilabel>Sell</guilabel> it will display the current share balance, ask for the number of shares traded, and once that's entered it will display the new share balance. For a <guilabel>Stock Split</guilabel> or <guilabel>Reverse Split</guilabel> it will ask for the new balance after the split and display the split ratio.</para>
+ </sect2>
+ <sect2>
+ <title>Stock Value Page</title>
+ <para>Displayed for <guilabel>Buy</guilabel> and <guilabel>Sell</guilabel> to collect the value of the shares bought or sold net of commissions and fees, which are collected on another page. For example if you sell 100 shares of stock for $10.00 per share with a 2% commission and a $10.00 SEC fee the net value for this page is $1000.00.</para>
+ </sect2>
+ <sect2>
+ <title>Cash Page</title>
+ <para>Displayed for all transaction types.</para>
+ <para>Enter the asset account to or from which the money for the transaction will go.</para>
+ <note>Only asset accounts denominated in the stock account's currency—that of the nearest parent account denominated in currency—will be offered. The stock assistant does not support multi-currency stock trading.</note>
+ <note>For a stock split or reverse split this will collect any cash in lieu recieved for fractional shares.</note>
+ <para>Enter the gross amount of the transaction including commissions and fees. In the example from the Stock Value Page that would be $970.00: $1000.00 for the stock less $20 for the 2% commission and the $10.00 fee. Had it been buy you would have added the commission and fees to the amount.</para>
+ <para>There is a field for you to enter a memo on the cash split. It defaults to Cash.</para>
+ </sect2>
+ <sect2>
+ <title>Fees Page</title>
+ <para>Displayed for all transactions. There is a checkbox to select whether the fees will be incorporated into the value of the stock split (capitalized) or separately credited to an expense account.</para>
+ <para>If the amount is to be expensed select the account. Expense acconts will be offered and there's a button to create a new one.</para>
+ <para> Amount: Enter the total of any commissions, fees, or taxes on the transaction.</para><note>There's only one amount and one account. If you want separate accounts for say commissions and taxes, enter the total and one of the accounts here and then edit the transaction afterwards to create the extra splits.</note>
+ <para>As with the Cash Page there's a memo field for this split's memo.</para>
+ </sect2>
+ <sect2>
+ <title>Dividend Page</title>
+ <para>Displayed only for <guilabel>Dividend</guilabel> transactions. Select or create an income account and enter the gross amount of the dividend. There's a memo field as usual.</para>
+ </sect2>
+ <sect2>
+ <title>Capital Gains Page</title>
+ <para>Displayed only for <guilabel>Sell</guilabel> of a long position or <guilabel>Buy</guilabel> of a short position. As with the <guilabel>Dividend Page</guilabel> select an income account for the capital gain or create a new one, enter the amount of the gain—losses should be entered as a negative amount—and optionally edit the memo for the capital gain split.</para>
+ <note>The assistant doesn't do any calculating for you: It's up to you to determine the basis by whatever strategy you choose subject to the tax laws in your jurisdiction and to compute the difference between the basis and the proceeds.</note>
+ <note>If you prefer to use the <guilabel>View Lots</guilabel> dialog to compute capital gains/losses you should leave the <guilabel>Amount</guilabel> field in this page blank.</note>
+ </sect2>
+ <sect2>
+ <title>Finish Page</title>
+ <para> The final page displays a list of the splits the assistant will create along with errors that would prevent the transaction from being complete. If there are errors the <guilabel>Apply</guilabel> button will be disabled. You must use the <guilabel>Back</guilabel> button to navigate to the appropriate page and correct the error. Once all of the errors are resolved click the <guilabel>Apply</guilabel> button to create the transaction.</para>
+ <note>The assistant provides a <guilabel>Finish</guilabel> button to move to the <guilabel>Finish Page</guilabel> from any other.</note>
</sect2>
</sect1>
Summary of changes:
C/manual/ch_Tools_Assistants.xml | 233 +++++++++++++--------------------------
C/manual/ch_Transactions.xml | 78 +++++--------
2 files changed, 103 insertions(+), 208 deletions(-)
More information about the gnucash-changes
mailing list