r23765 - gnucash-docs/trunk - First documention updates for credit notes

Geert Janssens gjanssens at code.gnucash.org
Sat Jan 25 06:50:46 EST 2014


Author: gjanssens
Date: 2014-01-25 06:50:43 -0500 (Sat, 25 Jan 2014)
New Revision: 23765
Trac: http://svn.gnucash.org/trac/changeset/23765

Modified:
   gnucash-docs/trunk/guide/C/ch_bus_ap.xml
   gnucash-docs/trunk/guide/C/ch_bus_ar.xml
   gnucash-docs/trunk/help/C/Help_ch_Business.xml
Log:
First documention updates for credit notes

This commit partly implements feature request 687477

Modified: gnucash-docs/trunk/guide/C/ch_bus_ap.xml
===================================================================
--- gnucash-docs/trunk/guide/C/ch_bus_ap.xml	2014-01-25 11:50:31 UTC (rev 23764)
+++ gnucash-docs/trunk/guide/C/ch_bus_ap.xml	2014-01-25 11:50:43 UTC (rev 23765)
@@ -97,6 +97,10 @@
   </listitem>
   <listitem>
   <para><guilabel>Bills</guilabel> represent the physical bills vendors send to request payment from you.  A bill contains an itemized list of things you purchased.</para>
+        <para>In addition, GnuCash also has support for <guilabel>Credit Notes</guilabel>
+        which represent the inverse of Bills. A credit note is usually received from
+        a vendor to correct items that were erroneously billed or returned.</para>
+        <para>Both document types will be set up using the same menu items.</para>
   </listitem>
   <listitem>
   <para><guilabel>Jobs</guilabel> (optional) is where you register Vendor Jobs.  Jobs are mechanism by which you can group multiple bills from a particular vendor.</para>
@@ -177,10 +181,23 @@
 
   <sect1 id="bus-ap-bills1">
   <title>Bills</title>
- <para>A bill is a request for payment you receive from a vendor.  <application>&app;</application> can track bills.</para>
+  <para>A bill is a request for payment you receive from a vendor.  <application>&app;</application> can track bills.</para>
+
+    <para>A credit note is the document you receive from a vendor to correct
+    products or services rendered that you were incorrectly charged for on a bill. <application>&app;</application> can generate and track
+    credit notes via the same menu entries as bills.</para>
+
+    <note>
+      <para>This section applies to both bills and
+      credit notes. In order to avoid repeating everything twice and to keep
+      the text easier to read it will refer only to bills. You can apply
+      it equally to credit notes. Only where the behaviour of credit notes
+      differs from bills this will be explicitly mentioned.</para>
+    </note>
+
   <sect2 id="bus-ap-billnew2">
   <title>New</title>
- <para>When you receive a bill from a vendor and want to enter it into <application>&app;</application>, you must create a new bill.  To create a new bill use the <menuchoice><guimenu>Business</guimenu><guisubmenu>Vendor</guisubmenu><guimenuitem>New Bill</guimenuitem></menuchoice> menu item, and fill in the resulting window appropriately.</para>
+  <para>When you receive a bill from a vendor and want to enter it into <application>&app;</application>, you must create a new bill.  To create a new bill use the <menuchoice><guimenu>Business</guimenu><guisubmenu>Vendor</guisubmenu><guimenuitem>New Bill</guimenuitem></menuchoice> menu item, and fill in the resulting window appropriately.</para>
 	<screenshot id="bus-ap-billnew">
 	  <mediaobject>
 	    <imageobject>
@@ -202,7 +219,10 @@
 
   <sect2 id="bus-ap-billedit2">
   <title>Edit</title>    
-  <para>From the Edit Bill window you can enter an itemized list of things purchased, in a manner similar to how the account register works.</para>  
+  <para>From the Edit Bill window you can enter an itemized list of
+      goods and services you purchased, in a manner similar to how the account
+      register works. For credit notes you enter an itemized list of goods and
+      services the vendor refunded instead.</para>  
   	<screenshot id="bus-ap-billedit">
 	  <mediaobject>
 	    <imageobject>
@@ -223,7 +243,9 @@
 
   <sect2 id="bus-ap-billpost2">
   <title>Post</title>
-  <para>When you finish editing a bill, you should <guilabel>Post</guilabel> the bill.  You do not have to post the bill, you can close it and return to it later. You have to post the bill eventually.  Posting a bill places its transactions into an accounts payable account.  The Post Bill window appears and asks you to enter information:</para>
+  <para>When you finish editing a bill, you should <guilabel>Post</guilabel> the bill.  You do not have to post the bill,
+      you can close it and return to it later. You have to post the bill eventually.  Posting a bill places its transactions into an accounts payable account.
+      The Post Bill window appears and asks you to enter information:</para>
 
   	<screenshot id="bus-ap-billpost">
 	  <mediaobject>
@@ -257,7 +279,7 @@
 
   <sect1 id="bus-ap-jobs1">
   <title>Vendor Jobs</title>
-  <para>Vendor Jobs are used to group multiple bills from a single vendor.  Use of the vendor jobs feature is optional.  The feature is useful when you have multiple <guilabel>jobs</guilabel> for the same vendor, and would like to view all the bills for a single job.</para>
+  <para>Vendor Jobs are used to group multiple bills and credit notes from a single vendor.  Use of the vendor jobs feature is optional.  The feature is useful when you have multiple <guilabel>jobs</guilabel> for the same vendor, and would like to view all the bills and credit notes for a single job.</para>
   <para>To use vendor jobs, you must create them using the <menuchoice><guimenu>Business</guimenu><guisubmenu>Vendor</guisubmenu><guimenuitem>New Job</guimenuitem></menuchoice> menu item.  You will see the <guilabel>New Job</guilabel> window.</para>
 
   	<screenshot id="bus-ap-jobnew">
@@ -285,8 +307,8 @@
     <guimenu>Business</guimenu><guisubmenu>Vendor</guisubmenu>
     <guimenuitem>Find Job</guimenuitem></menuchoice> menu item. Select the desired job in the
     search results and click the <guilabel>View Invoices</guilabel> button. A
-    window listing bills associated with this job appears. Select a
-    bill and click the <guilabel>View Invoice</guilabel> button to open a
+    window listing bills and credit notes associated with this job appears. Select a
+    bill or credit note and click the <guilabel>View Invoice</guilabel> button to open a
     bill editor in the main application window.</para>
   </sect1>
 

Modified: gnucash-docs/trunk/guide/C/ch_bus_ar.xml
===================================================================
--- gnucash-docs/trunk/guide/C/ch_bus_ar.xml	2014-01-25 11:50:31 UTC (rev 23764)
+++ gnucash-docs/trunk/guide/C/ch_bus_ar.xml	2014-01-25 11:50:43 UTC (rev 23765)
@@ -153,6 +153,10 @@
         <para><guilabel>Invoices</guilabel> represent the physical invoice you
         send to a customer to request payment. This invoice contains an
         itemized list of things you sold.</para>
+        <para>In addition, GnuCash also has support for <guilabel>Credit Notes</guilabel>
+        which represent the inverse of Invoices. A credit note is usually handed to
+        a customer to correct items that were incorrectly invoiced or returned.</para>
+        <para>Both document types will be set up using the same menu items.</para>
       </listitem>
 
       <listitem>
@@ -256,11 +260,23 @@
     payment for products or services rendered. <application>&app;</application> can generate and track
     invoices.</para>
 
+    <para>A credit note is the paperwork you send to a customer to correct
+    products or services rendered that were incorrectly invoiced. <application>&app;</application> can generate and track
+    credit notes via the same menu entries as invoices.</para>
+
+    <note>
+      <para>This section applies to both invoices and
+      credit notes. In order to avoid repeating everything twice and to keep
+      the text easier to read it will refer only to invoices. You can apply
+      it equally to credit notes. Only where the behaviour of credit notes
+      differs from invoices this will be explicitly mentioned.</para>
+    </note>
+
     <sect2 id="bus-ar-invoicenew2">
       <title>New</title>
 
-      <para>To send an invoice to a customer you must first create a new
-      invoice. To create an invoice use <menuchoice><guimenu>Business</guimenu>
+      <para>To send an invoice to a customer you must first create the new
+      document. To create an invoice use <menuchoice><guimenu>Business</guimenu>
       <guisubmenu>Customer</guisubmenu><guimenuitem>New Invoice</guimenuitem></menuchoice>. The
       New Invoice window must be filled in appropriately.</para>
 
@@ -275,7 +291,7 @@
             <phrase>Creating a New Invoice</phrase>
           </textobject>
 
-          <caption><para>Creating a New Invoice </para></caption>
+          <caption><para>Creating a New Invoice</para></caption>
         </mediaobject>
       </screenshot>
 
@@ -287,8 +303,9 @@
       <title>Edit</title>
 
       <para>From the Edit Invoice window you can enter an itemized list of
-      things you sold on this invoice, in a manner similar to how the account
-      register works.</para>
+      goods and services you sold on this invoice in a manner similar to how the account
+      register works. For credit notes you enter an itemized list of goods and
+      services you refunded instead.</para>
 
       <screenshot id="bus-ar-invoiceedit">
         <mediaobject>
@@ -450,10 +467,10 @@
   <sect1 id="bus-ar-jobs1">
     <title>Customer Jobs</title>
 
-    <para>Customer Jobs are used to group multiple invoices to the same
+    <para>Customer Jobs are used to group multiple invoices and credit notes to the same
     customer. Use of the Customer Jobs feature is optional. The feature is
     useful when you have multiple <guilabel>jobs</guilabel> for the same customer, and would like
-    to view all the invoices related to a single job.</para>
+    to view all the invoices and credit notes related to a single job.</para>
 
     <screenshot id="bus-ar-jobnew">
       <mediaobject>
@@ -481,12 +498,12 @@
     search results, and click the <guilabel>View/Edit Job</guilabel>
     button.</para>
 
-    <para>To select from the invoices associated with a given job, use <menuchoice>
+    <para>To select from the invoices and credit notes associated with a given job, use <menuchoice>
     <guimenu>Business</guimenu><guisubmenu>Customer</guisubmenu><guimenuitem>Find
     Job</guimenuitem></menuchoice> menu item. Select the desired job in the
     search results and click the <guilabel>View Invoices</guilabel> button. A
-    window listing invoices associated with this job appears. Select an
-    invoice and click the <guilabel>View Invoice</guilabel> button to open an
+    window listing invoices and credit notes associated with this job appears. Select an
+    invoice or credit note and click the <guilabel>View Invoice</guilabel> button to open an
     invoice editor in the main application window.</para>
   </sect1>
 

Modified: gnucash-docs/trunk/help/C/Help_ch_Business.xml
===================================================================
--- gnucash-docs/trunk/help/C/Help_ch_Business.xml	2014-01-25 11:50:31 UTC (rev 23764)
+++ gnucash-docs/trunk/help/C/Help_ch_Business.xml	2014-01-25 11:50:43 UTC (rev 23765)
@@ -316,6 +316,18 @@
     payment for products or services rendered. <application>&app;</application> can generate and track
     invoices.</para>
 
+    <para>A credit note is the paperwork you send to a customer to correct
+    products or services rendered that were incorrectly invoiced. <application>&app;</application> can generate and track
+    credit notes via the same menu entries as invoices.</para>
+
+    <note>
+      <para>This section applies to both invoices and
+      credit notes. In order to avoid repeating everything twice and to keep
+      the text easier to read it will refer only to invoices. You can apply
+      it equally to credit notes. Only where the behaviour of credit notes
+      differs from invoices this will be explicitly mentioned.</para>
+    </note>
+
     <sect2 id="busnss-ar-invoicenew2">
       <title>New</title>
 
@@ -326,6 +338,11 @@
 
       <itemizedlist>
         <listitem>
+          <para><guilabel>Invoice Information - Type</guilabel> - the
+          type of customer document to create - either an invoice or a credit note.</para>
+        </listitem>
+
+        <listitem>
           <para><guilabel>Invoice Information - Invoice ID</guilabel> - the
           identification number of this invoice. This is your internal number
           for this invoice. If you leave it blank, an invoice number will be
@@ -386,8 +403,9 @@
       <title>Edit</title>
 
       <para>From the Edit Invoice window you can enter an itemized list of
-      things you sold on this invoice, in a manner similar to how the account
-      register works.</para>
+      goods and services you sold on this invoice in a manner similar to how the account
+      register works. For credit notes you enter an itemized list of goods and
+      services you refunded instead.</para>
 
       <para>There are 15 columns in the <guilabel>Invoice Entries</guilabel>
       area:</para>
@@ -712,10 +730,10 @@
   <sect1 id="busnss-ar-jobs1">
     <title>Customer Jobs</title>
 
-    <para>Customer Jobs are used to group multiple invoices to the same
+    <para>Customer Jobs are used to group multiple invoices and credit notes to the same
     customer. Use of the Customer Jobs feature is optional. The feature is
     useful when you have multiple <guilabel>jobs</guilabel> for the same customer, and would like
-    to view all the invoices related to a single job.</para>
+    to view all the invoices and credit notes related to a single job.</para>
 
     <para>To use customer jobs, you must create them using the <menuchoice>
     <guimenu>Business</guimenu><guisubmenu>Customer</guisubmenu>
@@ -766,12 +784,12 @@
     search results, and click the <guilabel>View/Edit Job</guilabel>
     button.</para>
 
-    <para>To select from the invoices associated with a given job, use <menuchoice>
+    <para>To select from the invoices and credit notes associated with a given job, use <menuchoice>
     <guimenu>Business</guimenu><guisubmenu>Customer</guisubmenu><guimenuitem>Find
     Job</guimenuitem></menuchoice> menu item. Select the desired job in the
     search results and click the <guilabel>View Invoices</guilabel> button. A
-    window listing invoices associated with this job appears. Select an
-    invoice and click the <guilabel>View Invoice</guilabel> button to open an
+    window listing invoices and credit notes associated with this job appears. Select an
+    invoice or credit note and click the <guilabel>View Invoice</guilabel> button to open an
     invoice editor in the main application window.</para>
   </sect1>
 
@@ -1046,10 +1064,27 @@
   <sect1 id="busnss-ap-bills1">
   <title>Bills</title>
  <para>A bill is a request for payment you receive from a vendor.  <application>&app;</application> can track bills.</para>
-  <sect2 id="busnss-ap-billnew2">
+ 
+    <para>A credit note is the document you receive from a vendor to correct
+    products or services rendered that you were incorrectly charged for on a bill. <application>&app;</application> can generate and track
+    credit notes via the same menu entries as bills.</para>
+
+    <note>
+      <para>This section applies to both bills and
+      credit notes. In order to avoid repeating everything twice and to keep
+      the text easier to read it will refer only to bills. You can apply
+      it equally to credit notes. Only where the behaviour of credit notes
+      differs from bills this will be explicitly mentioned.</para>
+    </note>
+
+    <sect2 id="busnss-ap-billnew2">
   <title>New</title>
  <para>When you receive a bill from a vendor and want to enter it into <application>&app;</application>, you must create a new bill.  To create a new bill use the <menuchoice><guimenu>Business</guimenu><guisubmenu>Vendor</guisubmenu><guimenuitem>New Bill</guimenuitem></menuchoice> menu item, and fill in the resulting window appropriately.</para>
   <itemizedlist>
+        <listitem>
+          <para><guilabel>Invoice Information - Type</guilabel> - the
+          type of vendor document to create - either a bill or a credit note.</para>
+        </listitem>
   <listitem>
   <para><guilabel>Invoice Info - Invoice ID</guilabel> (optional) - the identification number of the invoice as emitted by the vendor (IE: the vendor’s internal number for this invoice).</para>
   </listitem>
@@ -1092,7 +1127,10 @@
   </sect2>
   <sect2 id="busnss-ap-billedit2">
   <title>Edit</title>    
-  <para>From the Edit Bill window you can enter an itemized list of things purchased, in a manner similar to how the account register works.</para>  
+  <para>From the Edit Bill window you can enter an itemized list of
+      goods and services you purchased, in a manner similar to how the account
+      register works. For credit notes you enter an itemized list of goods and
+      services the vendor refunded instead.</para>  
   <para>There are 12 columns in the Invoice Entries area:</para>
   <itemizedlist>
   <listitem>
@@ -1217,7 +1255,7 @@
 
   <sect1 id="busnss-ap-jobs1">
   <title>Vendor Jobs</title>
-  <para>Vendor Jobs are used to group multiple bills from a single vendor.  Use of the vendor jobs feature is optional.  The feature is useful when you have multiple <guilabel>jobs</guilabel> for the same vendor, and would like to view all the bills for a single job.</para>
+  <para>Vendor Jobs are used to group multiple bills and credit notes from a single vendor.  Use of the vendor jobs feature is optional.  The feature is useful when you have multiple <guilabel>jobs</guilabel> for the same vendor, and would like to view all the bills and credit notes for a single job.</para>
   <para>To use vendor jobs, you must create them using the <menuchoice><guimenu>Business</guimenu><guisubmenu>Vendor</guisubmenu><guimenuitem>New Job</guimenuitem></menuchoice> menu item.  You will see the <guilabel>New Job</guilabel> window.  The editable fields are:</para>
 
 
@@ -1256,12 +1294,12 @@
     search results, and click the <guilabel>View/Edit Job</guilabel>
     button.</para>
 
-    <para>To select from the bills associated with a given job, use <menuchoice>
+    <para>To select from the bills and credit notes associated with a given job, use <menuchoice>
     <guimenu>Business</guimenu><guisubmenu>Vendor</guisubmenu>
     <guimenuitem>Find Job</guimenuitem></menuchoice> menu item. Select the desired job in the
     search results and click the <guilabel>View Invoices</guilabel> button. A
-    window listing bills associated with this job appears. Select a
-    bill and click the <guilabel>View Invoice</guilabel> button to open a
+    window listing bills and credit notes associated with this job appears. Select a
+    bill or credit note and click the <guilabel>View Invoice</guilabel> button to open a
     bill editor in the main application window.</para>
   </sect1>
 



More information about the gnucash-changes mailing list