You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ofbiz.apache.org by mb...@apache.org on 2020/02/25 21:09:55 UTC
[ofbiz-framework] 04/12: Documented: Invoice Docbook files
migration to asciidoc format (OFBIZ-10292)
This is an automated email from the ASF dual-hosted git repository.
mbrohl pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git
commit 47353fcdcb33fcbf9e2686a6802e39ff73ee6225
Author: holivier <ho...@apache.org>
AuthorDate: Fri Feb 7 12:11:25 2020 +0100
Documented: Invoice Docbook files migration to asciidoc format
(OFBIZ-10292)
All the help files associated to it are called via include in the main
document
---
.../data/helpdata/HELP_ACCOUNTING_editInvoice.xml | 34 -----
.../HELP_ACCOUNTING_editInvoiceApplications.xml | 142 ---------------------
.../HELP_ACCOUNTING_editInvoiceTimeEntries.xml | 43 -------
.../data/helpdata/HELP_ACCOUNTING_findInvoices.xml | 74 -----------
.../helpdata/HELP_ACCOUNTING_invoiceOverview.xml | 40 ------
.../data/helpdata/HELP_ACCOUNTING_invoiceRoles.xml | 53 --------
.../data/helpdata/HELP_ACCOUNTING_invoices.xml | 63 ---------
.../helpdata/HELP_ACCOUNTING_listInvoiceItems.xml | 65 ----------
.../data/helpdata/HELP_ACCOUNTING_newInvoice.xml | 64 ----------
.../data/helpdata/HELP_ACCOUNTING_sendPerEmail.xml | 44 -------
.../HELP_editInvoice.adoc} | 22 +---
.../_include/HELP_editInvoiceApplications.adoc | 85 ++++++++++++
.../HELP_editInvoiceTimeEntries.adoc} | 24 ++--
.../docs/asciidoc/_include/HELP_findInvoices.adoc | 50 ++++++++
.../asciidoc/_include/HELP_invoiceOverview.adoc | 36 ++++++
.../docs/asciidoc/_include/HELP_invoiceRoles.adoc | 55 ++++++++
.../asciidoc/_include/HELP_listInvoiceItems.adoc | 69 ++++++++++
.../docs/asciidoc/_include/HELP_newInvoice.adoc | 42 ++++++
.../docs/asciidoc/_include/HELP_sendPerEmail.adoc | 34 +++++
.../src/docs/asciidoc/_include/acc-invoices.adoc | 67 ++++++++++
.../accounting/src/docs/asciidoc/accounting.adoc | 2 +
21 files changed, 459 insertions(+), 649 deletions(-)
diff --git a/applications/accounting/data/helpdata/HELP_ACCOUNTING_editInvoice.xml b/applications/accounting/data/helpdata/HELP_ACCOUNTING_editInvoice.xml
deleted file mode 100644
index e019cd5..0000000
--- a/applications/accounting/data/helpdata/HELP_ACCOUNTING_editInvoice.xml
+++ /dev/null
@@ -1,34 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>The Edit Invoice Header screen.</title>
- <para>The Invoice Header screen is used to view or update details from
- the invoice header. Examples of the type of information that can be
- changed are Due Date, Description, Currency.</para>
- <section>
- <title>How do I update the header details for an Invoice?</title>
- <orderedlist>
- <listitem><para>Select the 'Header' sub menu and the header details of the
- invoice will be displayed</para></listitem>
- <listitem><para>Update the fields required</para></listitem>
- <listitem><para> Press the 'Update' button</para></listitem>
- </orderedlist>
- </section>
-</section>
-
diff --git a/applications/accounting/data/helpdata/HELP_ACCOUNTING_editInvoiceApplications.xml b/applications/accounting/data/helpdata/HELP_ACCOUNTING_editInvoiceApplications.xml
deleted file mode 100644
index 52520ab..0000000
--- a/applications/accounting/data/helpdata/HELP_ACCOUNTING_editInvoiceApplications.xml
+++ /dev/null
@@ -1,142 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>The Edit Invoice Applications screen.</title>
- <para>The Invoice Applications sub menu is where payments that have been made (or received) can
- be linked or allocated to an invoice. The phrase 'applying' an amount to an invoice is often
- used to describe this. The screen is divided into 3 main areas as follows.</para>
- <itemizedlist>
- <listitem>
- <para>Payments Applied (which shows details of the total amount 'Applied' and the total
- amount 'Open'. Note that 'Open' here means outstanding)</para>
- </listitem>
- <listitem>
- <para>Possible Payments to Apply (which shows all the payments that have been sent from
- the same party id as the invoice - for a sales invoice this would be the customer
- party id)</para>
- </listitem>
- <listitem>
- <para>Assign Payment to Invoice (which allows you to manually assign a specific payment
- id to this invoice)</para>
- </listitem>
- </itemizedlist>
- <para>GENERAL NOTE: General Ledger accounting transactions are generated during the payment
- application process but unless your GL is setup with Unapplied Cash and Applied Cash
- accounts - I'm not sure that there will be any true accounting impact. In the Sales Order
- process the accounting transaction generated the following GL Accounting transaction is
- generated for 'Payment Applied' o add some text here.</para>
- <para>DR 120000 Accounts Receivable / CR 120000 Accounts Receivable - This transaction doesnt
- really do anything! </para>
- <para>It is used to link payments to invoices. It is also used to allocate which part of a
- payment is allocated or applied to a specific invoice. This is extremely useful if your
- customers pay multiple invoices with a single payment.</para>
- <para>Example:</para>
- <para>
- <itemizedlist>
- <listitem>
- <para>A customer could send a single payment of $1000 that can be used to pay for
- two invoices (eg $400 and $600)</para>
- </listitem>
- <listitem>
- <para>Using this applications sub menu allows you to allocate part of the $400 to
- one invoice and the balance ($600) to the other invoice </para>
- </listitem>
- </itemizedlist>
- </para>
- <para>By default all 'unapplied' payments that have been entered into OFBiz from the customer
- will be available for selection even if they have not yet been flagged as formally
- 'Received'. This means that these are payments that have not already been linked to another
- invoice. If only part of a payment amount has been linked to an invoice then the remaining
- amount is left available to be allocated to another invoice. Also note that a single invoice
- could be paid by multiple payments being applied to it.</para>
- <section>
- <title>How do I apply a payment (or payments) to an invoice?</title>
- <orderedlist>
- <listitem>
- <para>Select the 'Applications' sub menu for the invoice</para>
- </listitem>
- <listitem>
- <para>A list of unapplied payments for the party id will be displayed </para>
- </listitem>
- <listitem>
- <para>Press the 'Apply' button next to the entry that needs to be applied to the
- invoice (NOTE: More than one entry may be used. Also only part of a larger
- amount may be used)The Payments Applied total at the top of the screen will be
- updated with the amount selected. Also the Amount Open will be reduced by the
- amount selected.</para>
- </listitem>
- <listitem>
- <para> Once the total invoice amount has been selected a message will be displayed
- and only the first part of the screen will be displayed </para>
- </listitem>
- <listitem>
- <para>The top part of the screen will now be updated to show the 'Payments Applied'
- total is equal to the invoice total and the 'Amount Open' is zero. </para>
- </listitem>
- </orderedlist>
- </section>
- <section>
- <title>How do I update an applied payment for an invoice?</title>
- <orderedlist>
- <listitem>
- <para>Payments that have been applied to an invoice can be updated. This means that
- you can change the details of the payment transaction or adjust the amount that
- was applied to the invoice.</para>
- </listitem>
- <listitem>
- <para>Select the 'Applications' sub menu for the invoice</para>
- </listitem>
- <listitem>
- <para>A list of payments already applied to the invoice will be displayed in the top
- part of the screen</para>
- </listitem>
- <listitem>
- <para>Enter or use the lookup to change the 'Payment Id' if required </para>
- </listitem>
- <listitem>
- <para>Enter the updated amount in the 'Amount to Apply' field if required</para>
- </listitem>
- <listitem>
- <para>Press the 'Update' button</para>
- </listitem>
- </orderedlist>
- </section>
- <section>
- <title>How do I remove an applied payment (or payments) from an invoice?</title>
- <para>NOTE TO CHECK: It can be done before transaction has been posted to GL but also need
- to check if its can be done if the transaction has been posted. </para>
- <orderedlist>
- <listitem>
- <para>Select the 'Applications' sub menu for the invoice</para>
- </listitem>
- <listitem>
- <para>A list of payments already applied to the invoice will be displayed in the top
- part of the screen</para>
- </listitem>
- <listitem>
- <para>Press the 'Remove' button next to the payment entry that needs to be
- removed</para>
- </listitem>
- <listitem>
- <para>The entry will be removed and the top part of the screen will be update the
- 'Payments Applied' total and 'Amount Open'</para>
- </listitem>
- </orderedlist>
- </section>
-</section>
diff --git a/applications/accounting/data/helpdata/HELP_ACCOUNTING_editInvoiceTimeEntries.xml b/applications/accounting/data/helpdata/HELP_ACCOUNTING_editInvoiceTimeEntries.xml
deleted file mode 100644
index fec7258..0000000
--- a/applications/accounting/data/helpdata/HELP_ACCOUNTING_editInvoiceTimeEntries.xml
+++ /dev/null
@@ -1,43 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>The Edit Invoice Time Entries screen.</title>
- <para>he Time Entries screen displays any time logged against the
- invoice. For example these time entries can be from employee or
- external supplier timesheets that are tracked within OFBiz. is used to
- track any individual work or billable hours against an invoice.</para>
- <section>
- <title>How do I add a new time entry for an invoice?</title>
- <para>Threre are two options</para>
- <orderedlist>
- <listitem><para>Add time entry to a new invoice and add time entry
- to an existing invoice.</para></listitem>
- <listitem><para>Timesheet entries can be added to an existing invoice from
- Workeffort Manager.</para></listitem>
- </orderedlist>
- </section>
- <section>
- <title>How do I update a time entry for an invoice?</title>
- <para>NOTE: To check if this can only be done via timesheets.</para>
- </section>
- <section>
- <title>How do I remove a time entry from an invoice?</title>
- <para>NOTE: To check if this is done via timesheets </para>
- </section>
-</section>
diff --git a/applications/accounting/data/helpdata/HELP_ACCOUNTING_findInvoices.xml b/applications/accounting/data/helpdata/HELP_ACCOUNTING_findInvoices.xml
deleted file mode 100644
index ced94c9..0000000
--- a/applications/accounting/data/helpdata/HELP_ACCOUNTING_findInvoices.xml
+++ /dev/null
@@ -1,74 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>The Find Invoices screen.</title>
- <para>The default screen is for the Invoices tab is 'Find Invoices'. It
- is used to locate existing invoices that have been created
- automatically by the system or manually by the user. It can also be
- used to create a new Sales or Purchase Invoice. </para>
- <section>
- <title>How do I view all invoices?</title>
- <orderedlist>
- <listitem><para>Press the 'Search' button to view all invoices</para></listitem>
- </orderedlist>
- </section>
- <section>
- <title>How do I locate an existing invoice?</title>
- <orderedlist>
- <listitem><para>Enter the 'Invoice ID' if known</para></listitem>
- <listitem><para>Enter a word from the invoice description in the 'Description'
- field if known</para></listitem>
- <listitem><para>Enter the 'Invoice Type' if known</para></listitem>
- <listitem><para>Enter the 'From Party Id' if known (NOTE: In most cases for a
- Sales Invoices this will be Company. For Purchase Invoice it will be
- the supplier party id)</para></listitem>
- <listitem><para>Enter the 'Billing Account Id' if known</para></listitem>
- <listitem><para>Enter the invoice status in the 'Status Id' field if known
- </para></listitem>
- <listitem><para>Enter the 'To Party Id' if known (NOTE: In most cases for a
- Purchase Invoice this will be company. For Sales Invoices it will be
- the customer party id)</para></listitem>
- <listitem><para>Press the 'Search' button to view all invoices</para></listitem>
- <listitem><para>All invoices that meet the search criteria will be displayed.
- </para></listitem>
- </orderedlist>
- </section>
- <section>
- <title>How do I update an invoice?</title>
- <orderedlist>
- <listitem><para>Locate the invoice using the 'Find Invoices' screen</para></listitem>
- <listitem><para>Using the relevant sub menu make the required changes.</para></listitem>
- </orderedlist>
- </section>
- <section>
- <title>How do I delete an invoice?</title>
- <para>Invoices cannot be deleted through the user interface. They can
- only be cancelled (eg if they have been entered or created by
- mistake).</para>
-
- <para>NOTE: They can probably be deleted using Entity Data Maintenance
- in the Webtools menu but this is not recommended for 2 reasons:
- </para>
- <orderedlist>
- <listitem><para>It may cause data integrity problems.</para></listitem>
- <listitem><para>In case of audit it would be a problem.
- </para></listitem>
- </orderedlist>
- </section>
-</section>
diff --git a/applications/accounting/data/helpdata/HELP_ACCOUNTING_invoiceOverview.xml b/applications/accounting/data/helpdata/HELP_ACCOUNTING_invoiceOverview.xml
deleted file mode 100644
index 74fed52..0000000
--- a/applications/accounting/data/helpdata/HELP_ACCOUNTING_invoiceOverview.xml
+++ /dev/null
@@ -1,40 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>The Invoice Overview screen.</title>
- <para>The Invoice Overview screen is used to display the summary of an invoice in a single view. The screen is divided into sections that show various information related to the invoice (eg Roles, Status, Terms, Items, Payments Applied, etc).</para>
- <para>The following options are currently available from this screen:</para>
- <itemizedlist>
- <listitem><para>Create New (Create a new invoice)</para></listitem>
- <listitem><para>Copy (Create a copy of the current invoice)</para></listitem>
- <listitem><para>PDF (View a PDF of the current invoice)</para></listitem>
- <listitem><para>PDF default currency (NOTE TO CHECK: Need to see how this is different from just the PDF view......)</para></listitem>
- <listitem><para>Status to 'Approved' (Change the status of the current invoice to 'Approved)</para></listitem>
- <listitem><para>Status to 'Sent' (Change the status of the current invoice to 'Sent')</para></listitem>
- <listitem><para>Status to 'Ready' (Change the status of the current invoice to 'Ready'. NOTE: This will create the relevant accounting transactions and post them to the general ledger)</para></listitem>
- <listitem><para>Status to 'Cancelled' (Change the status of the current invoice to 'Cancelled')</para></listitem>
- <listitem><para>Save as Template (NOTE TO CHECK: Save the current invoice format as a template)</para></listitem>
- </itemizedlist>
-</section>
-
diff --git a/applications/accounting/data/helpdata/HELP_ACCOUNTING_invoiceRoles.xml b/applications/accounting/data/helpdata/HELP_ACCOUNTING_invoiceRoles.xml
deleted file mode 100644
index 5bce782..0000000
--- a/applications/accounting/data/helpdata/HELP_ACCOUNTING_invoiceRoles.xml
+++ /dev/null
@@ -1,53 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>The Invoice Roles screen.</title>
- <para>The Invoice Roles screen allows parties with specific roles to be associated with and invoice. If the e-commerce or Sales Order entry route has already been used then the invoice generated will already contain the relevant roles from the various parties.</para>
- <para>For a Sales Order examples of roles will include Bill From Customer, Bill To Customer, End User Customer,Ship To Customer etc.</para>
- <section>
- <title>How do I add a party role to an invoice?</title>
- <para>Party roles will automatically be added to an invoices that have been generated as a result of E-Commerce order entry or Sales Order entry. They can also be added be added manually.</para>
- <orderedlist>
- <listitem><para>Select the 'Roles' sub menu</para></listitem>
- <listitem><para>Enter or use the lookup to enter the party to be added to the invoice in the 'Party Id' field</para></listitem>
- <listitem><para>Use the drop down box to select the 'Role Type Id' </para></listitem>
- <listitem><para>Leave the 'Date Time Performed' field blank (NOTE: This field is optional and can be entered if required. This field can be used to indicate the date and time this role was performed by the party for this invoice)</para></listitem>
- <listitem><para>Leave the 'Percentage' field blank (NOTE: This field is optional and can be entered if required. If roles are shared then this field can be used to indicate the assigned percentage for this role) </para></listitem>
- <listitem><para>Press the 'Submit' button</para></listitem>
- <listitem><para>The new role entry will be displayed on the bottom part of the screen</para></listitem>
- <listitem><para>NOTE: If you select a role that is not associated with the party that has been entered an error message will be displayed. To fix it you will need to add the role to the party or choose another party that already has that role associated with it.</para></listitem>
- </orderedlist>
- </section>
- <section>
- <title>How do I update a party role on an invoice?</title>
- <para>A party role cannot be updated via the current user interface. It can only be removed. If a party role needs to be updated then the entry must be deleted and then re-created. </para>
- </section>
- <section>
- <title>How do I remove a party role from an invoice?</title>
- <orderedlist>
- <listitem><para>Locate the entry that needs to be removed</para></listitem>
- <listitem><para>Press the 'Remove' button next to the entry that needs to be deleted</para></listitem>
- <listitem><para>The entry is now removed from the list of invoice roles </para></listitem>
- </orderedlist>
- </section>
-</section>
diff --git a/applications/accounting/data/helpdata/HELP_ACCOUNTING_invoices.xml b/applications/accounting/data/helpdata/HELP_ACCOUNTING_invoices.xml
deleted file mode 100644
index 0083bb7..0000000
--- a/applications/accounting/data/helpdata/HELP_ACCOUNTING_invoices.xml
+++ /dev/null
@@ -1,63 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>Invoices.</title>
- <para>
- Sales invoices are generated when customers buy something from your
- business.
- You will need to provide a detailed list of the items bought and relevant
- taxes paid. They are often referred to a 'tax invoices' as they
- contain
- information relating to the amount of sales tax (eg VAT / GST)
- charged on the product or service.
- </para>
- <para> Purchase invoices are generated by your suppliers when you
- order something from them. You may send them an order in the form of
- a Purchase Order. They will then send you the products and an invoice
- for payment. This invoice is the Purchase Invoice and it will contain
- details of the items bought plus any taxes.</para>
- <para> Both of these documents are used as proof to various tax
- authorities (eg Inland Revenue, Customs etc) that the required tax
- has been charged or collected.</para>
- <para>
- GENERAL NOTE: The following is an extract from Ian McNulty's
- documentation work on accounting:</para>
- <para>Invoices are created automatically by the system when
- certain criteria are met for each item on an order. The criteria
- will vary depending on the type of product associated with the
- order item, and the type of order (ie purchase/sales).</para>
- <para>For Sales Orders that include digital goods, an invoice
- will be created when the order is placed, and that invoice will be
- for all digital goods in the order. If there are non-digital or
- physical goods they will go in a separate invoice.</para>
- <para>For Sales Orders that need physical fulfillment, an
- invoice will be created for all items in a shipment when the
- shipment goes into the 'Packed' status.</para>
- <para>For Purchase Orders an invoice will be created from a
- shipment when the shipment goes into the Received status.</para>
- <xi:include href="HELP_ACCOUNTING_findInvoices.xml" />
- <xi:include href="HELP_ACCOUNTING_invoiceOverview.xml" />
- <xi:include href="HELP_ACCOUNTING_editInvoice.xml" />
- <xi:include href="HELP_ACCOUNTING_newInvoice.xml" />
- <xi:include href="HELP_ACCOUNTING_editInvoiceApplications.xml" />
- <xi:include href="HELP_ACCOUNTING_listInvoiceItems.xml" />
- <xi:include href="HELP_ACCOUNTING_editInvoiceTimeEntries.xml" />
- <xi:include href="HELP_ACCOUNTING_sendPerEmail.xml" />
- <xi:include href="HELP_ACCOUNTING_invoiceRoles.xml" />
- </section>
diff --git a/applications/accounting/data/helpdata/HELP_ACCOUNTING_listInvoiceItems.xml b/applications/accounting/data/helpdata/HELP_ACCOUNTING_listInvoiceItems.xml
deleted file mode 100644
index eab91d1..0000000
--- a/applications/accounting/data/helpdata/HELP_ACCOUNTING_listInvoiceItems.xml
+++ /dev/null
@@ -1,65 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>The Edit Invoice Items screen.</title>
- <para>The Invoice Items screen displays the individual invoice line details and allows the user to update or remove an entry. As each invoice line is created it is allocated a specific sequence (or Item Number) which acts as a unique identifier.</para>
- <section>
- <title>How do I create a new invoice line item?</title>
- <para>Note that only invoices that have specific statuses can have new line items created. This means that if an invoice has already been paid and processed OFBiz will not allow any amendments to it.</para>
- <orderedlist>
- <listitem><para>Select the 'Items' sub menu for the invoice</para></listitem>
- <listitem><para>The 'Add a new invoice item' screen will be displayed</para></listitem>
- <listitem><para>Leave the 'Item No' field blank (as it will be automatically generated)</para></listitem>
- <listitem><para>Select the 'Invoice Item Type' from the drop down box (NOTE: A typical line using the demo could be 'Invoice Finished Good Item' but ensure that it corresponds with the type of products setup in your catalog)</para></listitem>
- <listitem><para>Enter a description describing what the line item is (NOTE: If you are going to enter a product in the Product Id field from the catalog then leave the 'Description' field blank as it will be used to show the product description)</para></listitem>
- <listitem><para>Leave the 'Override GL Account Id' field blank as it will use the default account based on the Chart of Accounts setup</para></listitem>
- <listitem><para>Use the lookup or enter a product code in the 'Product Id' field (NOTE: This can be left blank if your invoice line is not related to a product in the catalog)</para></listitem>
- <listitem><para>Enter a number in the 'Quantity' field</para></listitem>
- <listitem><para>Enter a 'Unit Price' only if the Product Id field is blank (NOTE: If a Product Id has been entered then leave the 'Unit Price' field blank as it will pick up the product price from the catalog)</para></listitem>
- <listitem><para>Leave the 'Inventory Item' field blank</para></listitem>
- <listitem><para>Leave the 'Product Feature Id' field blank</para></listitem>
- <listitem><para>Leave the 'UOM' field blank</para></listitem>
- <listitem><para>Select 'Yes' for the 'Taxable Flag' field</para></listitem>
- </orderedlist>
- <para>NOTE TO CHECK: Need to do some tests to see what line item type needs to be used for 'Sales Tax'. I think that it could be 'Invoice Item Sales Tax' since tax is currently calculated at invoice item line level. Also the automatically generated invoices from Order Entry and E-Commerce show taxes at the invoice item line level (think there may be some work going on - see JIRA on to consolidate entries). Need to do some tests using 'Invoice Sales Tax' to see how it works....... [...]
- </section>
- <section>
- <title>How do I update an invoice line item?</title>
- <para>Not all the fields on the invoice item line can be updated. For example Taxable Flag and Inventory Item cannot be updated. If these fields need to be amended then the invoice item will need to be removed and then re-created.</para>
- <orderedlist>
- <listitem><para>Select the 'Items' sub menu for the invoice</para></listitem>
- <listitem><para>Any existing line items will be displayed in the 'Items' box</para></listitem>
- <listitem><para>Amend the details in the line item that needs to be updated (eg Quantity, Invoice Item Type, Product Id, Description, Override GL Account, Unit Price)</para></listitem>
- <listitem><para>Press the 'Update' button displayed at the end of the line item that has been updated </para></listitem>
- </orderedlist>
- </section>
- <section>
- <title>How do I delete an invoice item?</title>
- <orderedlist>
- <listitem><para>Select the 'Items' sub menu for the invoice</para></listitem>
- <listitem><para>Any existing line items will be displayed in the 'Items' box</para></listitem>
- <listitem><para>Press the 'Remove' button displayed at the end of the line item that needs to be deleted</para></listitem>
- </orderedlist>
- </section>
-
-</section>
diff --git a/applications/accounting/data/helpdata/HELP_ACCOUNTING_newInvoice.xml b/applications/accounting/data/helpdata/HELP_ACCOUNTING_newInvoice.xml
deleted file mode 100644
index a56bb98..0000000
--- a/applications/accounting/data/helpdata/HELP_ACCOUNTING_newInvoice.xml
+++ /dev/null
@@ -1,64 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>The New Invoice screen.</title>
- <para>This screen allows the user to create a new Sales or Purchase
- Invoice. Sales Invoices are created when a customer buys something
- from you. Purchase Invoices are created when you buy something from a
- supplier.</para>
- <section>
- <title>How do I create a new Sales invoice?</title>
- <orderedlist>
- <listitem><para>Press the 'Create New' button</para></listitem>
- <listitem><para>The New Sales Invoice / New Purchase Invoice screen is
- displayed></para></listitem>
- <listitem><para>Using the top part of the screen, leave Invoice type with its
- default of 'Sales Invoice'</para></listitem>
- <listitem><para>Leave 'Organization Party Id' with its default of 'Company'
- </para></listitem>
- <listitem><para>Enter or use the lookup to find the 'To Party Id' (eg
- DemoCustomer)</para></listitem>
- <listitem><para>Press the 'Create' button in the top part of the screen</para></listitem>
- <listitem><para>The invoice header has been created and the default header
- screen will be displayed</para></listitem>
- <listitem><para>Details on the invoice will need to be entered via the other sub
- menus (eg Items, Time Entries etc) </para></listitem>
- </orderedlist>
- </section>
- <section>
- <title>How do I create a new Purchase invoice?</title>
- <orderedlist>
- <listitem><para>Press the 'Create New' button</para></listitem>
- <listitem><para>The New Sales Invoice / New Purchase Invoice screen is
- displayed></para></listitem>
- <listitem><para>Using the bottom part of the screen, leave Invoice type with its
- default of 'Purchase Invoice'</para></listitem>
- <listitem><para>Leave 'Organization Party Id' with its default of 'Company'
- </para></listitem>
- <listitem><para>Enter or use the lookup to find the 'From Party Id' (eg
- DemoSupplier)</para></listitem>
- <listitem><para>Press the 'Create' button in the bottom part of the screen
- </para></listitem>
- <listitem><para>The invoice header has been created and the default header
- screen will be displayed</para></listitem>
- <listitem><para>Details on the invoice will need to be entered via the other sub
- menus (eg Items, Time Entries etc) </para></listitem>
- </orderedlist>
- </section>
-</section>
diff --git a/applications/accounting/data/helpdata/HELP_ACCOUNTING_sendPerEmail.xml b/applications/accounting/data/helpdata/HELP_ACCOUNTING_sendPerEmail.xml
deleted file mode 100644
index 448127a..0000000
--- a/applications/accounting/data/helpdata/HELP_ACCOUNTING_sendPerEmail.xml
+++ /dev/null
@@ -1,44 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>The Send Per Email screen.</title>
- <para>This is used to send a copy of the invoice details to one or more
- email addresses. The invoice is included as an attachment and the user
- can add a simple accompanying email message.</para>
- <section>
- <title>How do I send a copy of an invoice via email?</title>
- <orderedlist>
- <listitem><para>Select the 'Send per Email' sub menu</para></listitem>
- <listitem><para>The 'Send per Email' default screen will be displayed</para></listitem>
- <listitem><para>Enter the 'From Email Address' (NOTE TO CHECK: Shouldnt this be
- defaulted from the user login.....????)</para></listitem>
- <listitem><para>Leave the 'To Email Address' as it is as this will be defaulted
- using the customer details from the invoice</para></listitem>
- <listitem><para>If required enter the 'Copy Email address' for anyone that needs
- to be copied on the email</para></listitem>
- <listitem><para>Leave the 'Subject' as the default of 'Please find attached
- invoice'</para></listitem>
- <listitem><para>Leave the 'Other Currency' box blank (NOTE TO CHECK: Investigate
- what effect this has on the email.....)</para></listitem>
- <listitem><para>Enter a short email message in the 'Email Body' </para></listitem>
- <listitem><para>Press the 'Submit' button </para></listitem>
- </orderedlist>
- </section>
-</section>
-
diff --git a/applications/accounting/src/docs/asciidoc/accounting.adoc b/applications/accounting/src/docs/asciidoc/_include/HELP_editInvoice.adoc
similarity index 52%
copy from applications/accounting/src/docs/asciidoc/accounting.adoc
copy to applications/accounting/src/docs/asciidoc/_include/HELP_editInvoice.adoc
index 526f29c..3167f97 100644
--- a/applications/accounting/src/docs/asciidoc/accounting.adoc
+++ b/applications/accounting/src/docs/asciidoc/_include/HELP_editInvoice.adoc
@@ -16,20 +16,12 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
////
-= Accounting
+= Help for Edit Invoice Header
+The Invoice Header screen is used to view or update details from the invoice header.
-The OFBiz accounting system is a core application component and has most of the
-modern features you would expect in a general purpose double-entry accounting
-system. However, OFBiz goes beyond that by and seamlessly integrates with other
-OFBiz applications such as Inventory, Purchasing and Manufacturing to give your
-business a complete ERP solution. This makes the system as a whole robust and
-integrated to provide more value than a plain accounting system.
+Examples of the type of information that can be changed are Due Date, Description, Currency.
-
-include::_include/acc-intro.adoc[leveloffset=+1]
-
-include::_include/acc-agreements.adoc[leveloffset=+1]
-
-include::_include/acc-financial-accounts.adoc[leveloffset=+1]
-
-include::_include/acc-global-settings.adoc[leveloffset=+1]
+== How do I update the header details for an Invoice?
+. Select the 'Header' sub menu and the header details of the invoice will be displayed
+. Update the fields required
+. Press the 'Update' button
diff --git a/applications/accounting/src/docs/asciidoc/_include/HELP_editInvoiceApplications.adoc b/applications/accounting/src/docs/asciidoc/_include/HELP_editInvoiceApplications.adoc
new file mode 100644
index 0000000..e3713d3
--- /dev/null
+++ b/applications/accounting/src/docs/asciidoc/_include/HELP_editInvoiceApplications.adoc
@@ -0,0 +1,85 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+= Help for Edit Invoice Applications
+The Invoice Applications sub menu is where payments that have been made (or received) can be linked or allocated to an invoice. +
+The phrase 'applying' an amount to an invoice is often used to describe this.
+
+The screen is divided into 3 main areas as follows.
+
+* Payments Applied (which shows details of the total amount 'Applied' and the total amount 'Open'. +
+ Note that 'Open' here means outstanding)
+* Possible Payments to Apply (which shows all the payments that have been sent from the same party id as the invoice,
+ for a sales invoice this would be the customer party id)
+* Assign Payment to Invoice (which allows you to manually assign a specific payment id to this invoice)
+
+NOTE: General Ledger accounting transactions are generated during the payment application process but unless your GL is setup
+ with Unapplied Cash and Applied Cash accounts +
+ - I'm not sure that there will be any true accounting impact. +
+ In the Sales Order process the accounting transaction generated the following GL Accounting transaction is generated
+ for 'Payment Applied' o add some text here.
+
+DR 120000 Accounts Receivable / CR 120000 Accounts Receivable - This transaction doesnt really do anything!
+
+It is used to link payments to invoices.
+It is also used to allocate which part of a payment is allocated or applied to a specific invoice.
+This is extremely useful if your customers pay multiple invoices with a single payment.
+
+Example:
+
+* A customer could send a single payment of $1000 that can be used to pay for two invoices (eg $400 and $600)
+* Using this applications sub menu allows you to allocate part of the $400 to one invoice and the balance ($600) to the other
+ invoice
+
+By default all 'unapplied' payments that have been entered into OFBiz from the customer will be available for selection even
+if they have not yet been flagged as formally 'Received'. This means that these are payments that have not already been linked
+to another invoice.
+
+If only part of a payment amount has been linked to an invoice then the remaining amount is left available to be allocated
+to another invoice. +
+Also note that a single invoice could be paid by multiple payments being applied to it.
+
+== How do I apply a payment (or payments) to an invoice?
+. Select the 'Applications' sub menu for the invoice
+. A list of unapplied payments for the party id will be displayed
+. Press the 'Apply' button next to the entry that needs to be applied to the invoice +
+ (NOTE: More than one entry may be used. Also only part of a larger amount may be used) +
+ The Payments Applied total at the top of the screen will be updated with
+ the amount selected. Also the Amount Open will be reduced by the amount selected.
+. Once the total invoice amount has been selected a message will be displayed and only the first part of the screen will be
+ displayed
+. The top part of the screen will now be updated to show the 'Payments Applied' total is equal to the invoice total and
+ the 'Amount Open' is zero.
+
+== How do I update an applied payment for an invoice?
+. Payments that have been applied to an invoice can be updated. This means that you can change the details of the payment
+ transaction or adjust the amount that was applied to the invoice.
+. Select the 'Applications' sub menu for the invoice
+. A list of payments already applied to the invoice will be displayed in the top part of the screen
+. Enter or use the lookup to change the 'Payment Id' if required
+. Enter the updated amount in the 'Amount to Apply' field if required
+. Press the 'Update' button
+
+== How do I remove an applied payment (or payments) from an invoice?
+WARNING: TO CHECK: It can be done before transaction has been posted to GL but also need to check if its can be done if
+ the transaction has been posted.
+
+. Select the 'Applications' sub menu for the invoice
+. A list of payments already applied to the invoice will be displayed in the top part of the screen
+. Press the 'Remove' button next to the payment entry that needs to be removed
+. The entry will be removed and the top part of the screen will be update the 'Payments Applied' total and 'Amount Open'
diff --git a/applications/accounting/src/docs/asciidoc/accounting.adoc b/applications/accounting/src/docs/asciidoc/_include/HELP_editInvoiceTimeEntries.adoc
similarity index 51%
copy from applications/accounting/src/docs/asciidoc/accounting.adoc
copy to applications/accounting/src/docs/asciidoc/_include/HELP_editInvoiceTimeEntries.adoc
index 526f29c..7ee96a6 100644
--- a/applications/accounting/src/docs/asciidoc/accounting.adoc
+++ b/applications/accounting/src/docs/asciidoc/_include/HELP_editInvoiceTimeEntries.adoc
@@ -16,20 +16,20 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
////
-= Accounting
+= Help for Edit Invoice Time Entries
+he Time Entries screen displays any time logged against the invoice.
+For example these time entries can be from employee or external supplier timesheets that are tracked within OFBiz.
+It is used to track any individual work or billable hours against an invoice.
-The OFBiz accounting system is a core application component and has most of the
-modern features you would expect in a general purpose double-entry accounting
-system. However, OFBiz goes beyond that by and seamlessly integrates with other
-OFBiz applications such as Inventory, Purchasing and Manufacturing to give your
-business a complete ERP solution. This makes the system as a whole robust and
-integrated to provide more value than a plain accounting system.
+== How do I add a new time entry for an invoice?
+Threre are two options
+. Add time entry to a new invoice and add time entry to an existing invoice.
+. Timesheet entries can be added to an existing invoice from Workeffort Manager.
-include::_include/acc-intro.adoc[leveloffset=+1]
+== How do I update a time entry for an invoice?
+WARNING: To CHECK if this can only be done via timesheets.
-include::_include/acc-agreements.adoc[leveloffset=+1]
+== How do I remove a time entry from an invoice?
-include::_include/acc-financial-accounts.adoc[leveloffset=+1]
-
-include::_include/acc-global-settings.adoc[leveloffset=+1]
+WARNING: TO CHECK if this is done via timesheets
\ No newline at end of file
diff --git a/applications/accounting/src/docs/asciidoc/_include/HELP_findInvoices.adoc b/applications/accounting/src/docs/asciidoc/_include/HELP_findInvoices.adoc
new file mode 100644
index 0000000..e9b76ca
--- /dev/null
+++ b/applications/accounting/src/docs/asciidoc/_include/HELP_findInvoices.adoc
@@ -0,0 +1,50 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+= Help for Find Invoices
+The default screen is for the Invoices tab is 'Find Invoices'. It is used to locate existing invoices that have been created
+automatically by the system or manually by the user.
+It can also be used to create a new Sales or Purchase Invoice.
+
+== How do I view all invoices?
+. Press the 'Search' button to view all invoices
+
+== How do I locate an existing invoice?
+. Enter the 'Invoice ID' if known
+. Enter a word from the invoice description in the 'Description' field if known
+. Enter the 'Invoice Type' if known
+. Enter the 'From Party Id' if known +
+ (NOTE: In most cases for a Sales Invoices this will be Company. For Purchase Invoice it will be the supplier party id)
+. Enter the 'Billing Account Id' if known
+. Enter the invoice status in the 'Status Id' field if known
+. Enter the 'To Party Id' if known +
+ (NOTE: In most cases for a Purchase Invoice this will be company. For Sales Invoices it will be the customer party id)
+. Press the 'Search' button to view all invoices
+. All invoices that meet the search criteria will be displayed.
+
+== How do I update an invoice?
+. Locate the invoice using the 'Find Invoices' screen
+. Using the relevant sub menu make the required changes.
+
+== How do I delete an invoice?
+Invoices cannot be deleted through the user interface.
+They can only be cancelled (eg if they have been entered or created by mistake).
+
+NOTE: They can probably be deleted using Entity Data Maintenance in the Webtools menu but this is not recommended for 2 reasons: +
+ 1) It may cause data integrity problems. +
+ 2) In case of audit it would be a problem.
diff --git a/applications/accounting/src/docs/asciidoc/_include/HELP_invoiceOverview.adoc b/applications/accounting/src/docs/asciidoc/_include/HELP_invoiceOverview.adoc
new file mode 100644
index 0000000..2c9b28c
--- /dev/null
+++ b/applications/accounting/src/docs/asciidoc/_include/HELP_invoiceOverview.adoc
@@ -0,0 +1,36 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+= Help for Invoice Overview
+The Invoice Overview screen is used to display the summary of an invoice in a single view.
+The screen is divided into sections that show various information related to the invoice (eg Roles, Status, Terms, Items, Payments Applied, etc).
+
+The following options are currently available from this screen:
+
+* Create New (Create a new invoice)
+* Copy (Create a copy of the current invoice)
+* PDF (View a PDF of the current invoice)
+* PDF default currency +
+ (NOTE TO CHECK: Need to see how this is different from just the PDF view......)
+* Status to 'Approved' (Change the status of the current invoice to 'Approved)
+* Status to 'Sent' (Change the status of the current invoice to 'Sent')
+* Status to 'Ready' (Change the status of the current invoice to 'Ready'. +
+ NOTE: This will create the relevant accounting transactions and post them to the general ledger)
+* Status to 'Cancelled' (Change the status of the current invoice to 'Cancelled')
+* Save as Template +
+ (NOTE TO CHECK: Save the current invoice format as a template)
diff --git a/applications/accounting/src/docs/asciidoc/_include/HELP_invoiceRoles.adoc b/applications/accounting/src/docs/asciidoc/_include/HELP_invoiceRoles.adoc
new file mode 100644
index 0000000..c5ad14f
--- /dev/null
+++ b/applications/accounting/src/docs/asciidoc/_include/HELP_invoiceRoles.adoc
@@ -0,0 +1,55 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+= Help for Invoice Roles
+The Invoice Roles screen allows parties with specific roles to be associated with and invoice.
+If the e-commerce or Sales Order entry route has already been used then the invoice generated will already contain the relevant
+roles from the various parties.
+
+For a Sales Order examples of roles will include Bill From Customer, Bill To Customer, End User Customer,Ship To Customer etc.
+
+== How do I add a party role to an invoice?
+Party roles will automatically be added to an invoices that have been generated as a result of E-Commerce order entry or
+Sales Order entry. +
+They can also be added be added manually.
+
+. Select the 'Roles' sub menu
+. Enter or use the lookup to enter the party to be added to the invoice in the 'Party Id' field
+. Use the drop down box to select the 'Role Type Id'
+. Leave the 'Date Time Performed' field blank +
+ (NOTE: This field is optional and can be entered if required. This field can be used to indicate the date and time this role
+ was performed by the party for this invoice)
+. Leave the 'Percentage' field blank +
+ (NOTE: This field is optional and can be entered if required. If roles are shared then this field can be used to indicate
+ the assigned percentage for this role)
+. Press the 'Submit' button
+
+The new role entry will be displayed on the bottom part of the screen
+
+NOTE: If you select a role that is not associated with the party that has been entered an error message will be displayed.
+ To fix it you will need to add the role to the party or choose another party that already has that role associated with it.
+
+== How do I update a party role on an invoice?
+A party role cannot be updated via the current user interface.
+It can only be removed.
+If a party role needs to be updated then the entry must be deleted and then re-created.
+
+== How do I remove a party role from an invoice?
+. Locate the entry that needs to be removed
+. Press the 'Remove' button next to the entry that needs to be deleted
+. The entry is now removed from the list of invoice roles
diff --git a/applications/accounting/src/docs/asciidoc/_include/HELP_listInvoiceItems.adoc b/applications/accounting/src/docs/asciidoc/_include/HELP_listInvoiceItems.adoc
new file mode 100644
index 0000000..992f6f6
--- /dev/null
+++ b/applications/accounting/src/docs/asciidoc/_include/HELP_listInvoiceItems.adoc
@@ -0,0 +1,69 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+= Help for Edit Invoice Items
+The Invoice Items screen displays the individual invoice line details and allows the user to update or remove an entry.
+As each invoice line is created it is allocated a specific sequence (or Item Number) which acts as a unique identifier.
+
+== How do I create a new invoice line item?
+Note that only invoices that have specific statuses can have new line items created.
+This means that if an invoice has already been paid and processed OFBiz will not allow any amendments to it.
+
+. Select the 'Items' sub menu for the invoice
+. The 'Add a new invoice item' screen will be displayed
+. Leave the 'Item No' field blank (as it will be automatically generated)
+. Select the 'Invoice Item Type' from the drop down box +
+ (NOTE: A typical line using the demo could be 'Invoice Finished Good Item' but ensure that it corresponds with
+ the type of products setup in your catalog)
+. Enter a description describing what the line item is +
+ (NOTE: If you are going to enter a product in the Product Id field from the catalog then leave the 'Description' field
+ blank as it will be used to show the product description)
+. Leave the 'Override GL Account Id' field blank as it will use the default account based on the Chart of Accounts setup
+. Use the lookup or enter a product code in the 'Product Id' field +
+ (NOTE: This can be left blank if your invoice line is not related to a product in the catalog)
+. Enter a number in the 'Quantity' field
+. Enter a 'Unit Price' only if the Product Id field is blank +
+ (NOTE: If a Product Id has been entered then leave the 'Unit Price' field blank as it will pick up the product price
+ from the catalog)
+. Leave the 'Inventory Item' field blank
+. Leave the 'Product Feature Id' field blank
+. Leave the 'UOM' field blank
+. Select 'Yes' for the 'Taxable Flag' field
+
+WARNING: TO CHECK: Need to do some tests to see what line item type needs to be used for 'Sales Tax'. +
+ I think that it could be 'Invoice Item Sales Tax' since tax is currently calculated at invoice item line level. +
+ Also the automatically generated invoices from Order Entry and E-Commerce show taxes at the invoice item line level
+ (think there may be some work going on - see JIRA on to consolidate entries). +
+ Need to do some tests using 'Invoice Sales Tax' to see how it works.........
+
+== How do I update an invoice line item?
+Not all the fields on the invoice item line can be updated.
+For example Taxable Flag and Inventory Item cannot be updated.
+
+If these fields need to be amended then the invoice item will need to be removed and then re-created.
+
+. Select the 'Items' sub menu for the invoice
+. Any existing line items will be displayed in the 'Items' box
+. Amend the details in the line item that needs to be updated (eg Quantity, Invoice Item Type, Product Id, Description,
+ Override GL Account, Unit Price)
+. Press the 'Update' button displayed at the end of the line item that has been updated
+
+== How do I delete an invoice item?
+. Select the 'Items' sub menu for the invoice
+. Any existing line items will be displayed in the 'Items' box
+. Press the 'Remove' button displayed at the end of the line item that needs to be deleted
diff --git a/applications/accounting/src/docs/asciidoc/_include/HELP_newInvoice.adoc b/applications/accounting/src/docs/asciidoc/_include/HELP_newInvoice.adoc
new file mode 100644
index 0000000..f69d4cb
--- /dev/null
+++ b/applications/accounting/src/docs/asciidoc/_include/HELP_newInvoice.adoc
@@ -0,0 +1,42 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+= Help for New Invoice
+This screen allows the user to create a new Sales or Purchase Invoice. +
+Sales Invoices are created when a customer buys something from you. +
+Purchase Invoices are created when you buy something from a supplier.
+
+== How do I create a new Sales invoice?
+. Press the 'Create New' button
+. The New Sales Invoice / New Purchase Invoice screen is displayed>
+. Using the top part of the screen, leave Invoice type with its default of 'Sales Invoice'
+. Leave 'Organization Party Id' with its default of 'Company'
+. Enter or use the lookup to find the 'To Party Id' (eg DemoCustomer)
+. Press the 'Create' button in the top part of the screen
+. The invoice header has been created and the default header screen will be displayed
+. Details on the invoice will need to be entered via the other sub menus (eg Items, Time Entries etc)
+
+== How do I create a new Purchase invoice?
+. Press the 'Create New' button
+. The New Sales Invoice / New Purchase Invoice screen is displayed>
+. Using the bottom part of the screen, leave Invoice type with its default of 'Purchase Invoice'
+. Leave 'Organization Party Id' with its default of 'Company'
+. Enter or use the lookup to find the 'From Party Id' (eg DemoSupplier)
+. Press the 'Create' button in the bottom part of the screen
+. The invoice header has been created and the default header screen will be displayed
+. Details on the invoice will need to be entered via the other sub menus (eg Items, Time Entries etc)
diff --git a/applications/accounting/src/docs/asciidoc/_include/HELP_sendPerEmail.adoc b/applications/accounting/src/docs/asciidoc/_include/HELP_sendPerEmail.adoc
new file mode 100644
index 0000000..6a1ee1e
--- /dev/null
+++ b/applications/accounting/src/docs/asciidoc/_include/HELP_sendPerEmail.adoc
@@ -0,0 +1,34 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+= Help for Send Per Email
+This is used to send a copy of the invoice details to one or more email addresses.
+The invoice is included as an attachment and the user can add a simple accompanying email message.
+
+== How do I send a copy of an invoice via email?
+. Select the 'Send per Email' sub menu
+. The 'Send per Email' default screen will be displayed
+. Enter the 'From Email Address' +
+ (NOTE TO CHECK: Shouldnt this be defaulted from the user login.....????)
+. Leave the 'To Email Address' as it is as this will be defaulted using the customer details from the invoice
+. If required enter the 'Copy Email address' for anyone that needs to be copied on the email
+. Leave the 'Subject' as the default of 'Please find attached invoice'
+. Leave the 'Other Currency' box blank +
+ (NOTE TO CHECK: Investigate what effect this has on the email.....)
+. Enter a short email message in the 'Email Body'
+. Press the 'Submit' button
diff --git a/applications/accounting/src/docs/asciidoc/_include/acc-invoices.adoc b/applications/accounting/src/docs/asciidoc/_include/acc-invoices.adoc
new file mode 100644
index 0000000..8a2c0bc
--- /dev/null
+++ b/applications/accounting/src/docs/asciidoc/_include/acc-invoices.adoc
@@ -0,0 +1,67 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+
+= Invoices.
+
+Sales invoices are generated when customers buy something from your business.
+You will need to provide a detailed list of the items bought and relevant taxes paid.
+They are often referred to a 'tax invoices' as they contain information relating to the amount of sales tax (eg VAT / GST)
+charged on the product or service.
+
+Purchase invoices are generated by your suppliers when you order something from them. +
+You may send them an order in the form of a Purchase Order. +
+They will then send you the products and an invoice for payment. +
+This invoice is the Purchase Invoice and it will contain details of the items bought plus any taxes. +
+
+Both of these documents are used as proof to various tax authorities (eg Inland Revenue, Customs etc) that the required tax
+has been charged or collected.
+
+NOTE: The following is an extract from Ian McNulty's documentation work on accounting:
+
+Invoices are created automatically by the system when certain criteria are met for each item on an order.
+The criteria will vary depending on the type of product associated with the order item, and the type of order
+(ie purchase/sales).
+
+For Sales Orders that include digital goods, an invoice will be created when the order is placed, and that invoice will be
+for all digital goods in the order. +
+If there are non-digital or physical goods they will go in a separate invoice.
+
+For Sales Orders that need physical fulfillment, an invoice will be created for all items in a shipment when the shipment
+goes into the 'Packed' status.
+
+For Purchase Orders an invoice will be created from a shipment when the shipment goes into the Received status.
+
+== Invoices management in User Interface
+include::HELP_findInvoices.adoc[leveloffset=+2]
+
+include::HELP_invoiceOverview.adoc[leveloffset=+2]
+
+include::HELP_editInvoice.adoc[leveloffset=+2]
+
+include::HELP_newInvoice.adoc[leveloffset=+2]
+
+include::HELP_editInvoiceApplications.adoc[leveloffset=+2]
+
+include::HELP_listInvoiceItems.adoc[leveloffset=+2]
+
+include::HELP_editInvoiceTimeEntries.adoc[leveloffset=+2]
+
+include::HELP_sendPerEmail.adoc[leveloffset=+2]
+
+include::HELP_invoiceRoles.adoc[leveloffset=+2]
diff --git a/applications/accounting/src/docs/asciidoc/accounting.adoc b/applications/accounting/src/docs/asciidoc/accounting.adoc
index 526f29c..71b493b 100644
--- a/applications/accounting/src/docs/asciidoc/accounting.adoc
+++ b/applications/accounting/src/docs/asciidoc/accounting.adoc
@@ -28,6 +28,8 @@ integrated to provide more value than a plain accounting system.
include::_include/acc-intro.adoc[leveloffset=+1]
+include::_include/acc-invoices.adoc[leveloffset=+1]
+
include::_include/acc-agreements.adoc[leveloffset=+1]
include::_include/acc-financial-accounts.adoc[leveloffset=+1]