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 0f937ead194bf024379ade52b3af9c0b41c5e52c
Author: holivier <holiv...@apache.org>
AuthorDate: Wed Feb 12 19:34:15 2020 +0100
Documented: Billing Account Docbook files migration to asciidoc format
(OFBIZ-10293)
All the help files associated to it are called via include in the main
document
---
.../HELP_ACCOUNTING_BillingAccountInvoices.xml | 95 ------------
.../HELP_ACCOUNTING_BillingAccountOrders.xml | 29 ----
.../HELP_ACCOUNTING_BillingAccountPayments.xml | 131 -----------------
.../HELP_ACCOUNTING_EditBillingAccount.xml | 159 ---------------------
.../HELP_ACCOUNTING_EditBillingAccountRoles.xml | 98 -------------
.../HELP_ACCOUNTING_EditBillingAccountTerms.xml | 106 --------------
.../HELP_ACCOUNTING_FindBillingAccount.xml | 26 ----
.../helpdata/HELP_ACCOUNTING_billing_accounts.xml | 81 -----------
.../_include/HELP_BillingAccountInvoices.adoc | 63 ++++++++
.../_include/HELP_BillingAccountOrders.adoc | 26 ++++
.../_include/HELP_BillingAccountPayments.adoc | 78 ++++++++++
.../asciidoc/_include/HELP_EditBillingAccount.adoc | 88 ++++++++++++
.../_include/HELP_EditBillingAccountRoles.adoc | 55 +++++++
.../_include/HELP_EditBillingAccountTerms.adoc | 58 ++++++++
.../asciidoc/_include/HELP_FindBillingAccount.adoc | 25 ++++
.../asciidoc/_include/acc-billing-accounts.adoc | 64 +++++++++
.../accounting/src/docs/asciidoc/accounting.adoc | 2 +
17 files changed, 459 insertions(+), 725 deletions(-)
diff --git
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_BillingAccountInvoices.xml
b/applications/accounting/data/helpdata/HELP_ACCOUNTING_BillingAccountInvoices.xml
deleted file mode 100644
index 886a55f..0000000
---
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_BillingAccountInvoices.xml
+++ /dev/null
@@ -1,95 +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 Billing Account Invoices help screen</title>
- <para>The Billing Account Find Invoices screen displays by default a list
of invoices that have
- been charged to the billing account.</para>
- <para>Any invoice displayed here means that its invoice amount has been
deducted from the
- billing account credit limit.For example: If the Billing Account
Credit Limit is $100 and
- the there are 2 invoices displayed with amounts $10 and $25 then the
available credit for
- the billing account will be $75.</para>
- <para>The invoice can be at various statues and there is an option to
locate an invoice by
- status.</para>
- <para>It is also used to apply any payments that have been made into the
Billing Account to an
- invoice. A 'Capture' button is displayed next to each invoice
displayed that has an amount
- outstanding.</para>
- <para>Example:</para>
- <para>
- <itemizedlist>
- <listitem>
- <para>Two invoices are charged to a Billing Account (Invoice A
$10 and Invoice B
- $25)</para>
- </listitem>
- <listitem>
- <para>A payment of $17 has been paid into the Billing
Account</para>
- </listitem>
- <listitem>
- <para>If the Capture button is pressed for the invoice A then
$10 of the $17 payment
- will be applied to this invoice and a new payment
transaction of $7 will be
- created and available to apply to a different invoice
</para>
- </listitem>
- </itemizedlist>
- </para>
- <section>
- <title>How do I locate an invoice by status?</title>
- <para>
- <orderedlist>
- <listitem>
- <para>Select the 'Invoices' sub menu</para>
- </listitem>
- <listitem>
- <para>Use the drop down box to select the 'Status Id' for
the invoice
- required</para>
- </listitem>
- <listitem>
- <para>Press the 'Submit' button</para>
- </listitem>
- </orderedlist>
- </para>
- <para>A list of invoices with the required status will be displayed
</para>
- </section>
- <section>
- <title>How do I capture a payment for an invoice?</title>
- <para>IMPORTANT: In order for this to work a payment needs to have
been made to the billing
- account that has not been completely applied to any other
invoices. Payments to a
- billing account can be done via the 'Payments' sub menu for the
billing account or by
- using Accounting / Payments menu.</para>
- <para>
- <orderedlist>
- <listitem>
- <para>Select the 'Invoices' sub menu</para>
- </listitem>
- <listitem>
- <para>Locate the invoice required (NOTE: The 'Amount to
Apply' is the same as
- the 'Total' column)</para>
- </listitem>
- <listitem>
- <para>Press the 'Capture' button (NOTE: The 'Amount to
Apply' is different to
- the 'Total' column)</para>
- </listitem>
- </orderedlist>
- </para>
- <para>The 'Capture' button is no longer displayed next to the invoice
and an additional
- payments transaction will be created for any difference between
the invoice total and
- the amount paid (Eg Invoice Total $100, Payment Amount $125, the
new payment transaction
- amount will be $25)</para>
- <para>NOTE: The above example assumes that the payment available will
cover the total amount
- outstanding for the invoice</para>
- </section>
-</section>
diff --git
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_BillingAccountOrders.xml
b/applications/accounting/data/helpdata/HELP_ACCOUNTING_BillingAccountOrders.xml
deleted file mode 100644
index 37091fc..0000000
---
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_BillingAccountOrders.xml
+++ /dev/null
@@ -1,29 +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 Billing Account Orders help screen</title>
- <para>This sub menu lists the details of any Sales Orders that have
- been charged to the billing account. A Sales Order is charged to a
- billing account by selecting the billing account as the Payment
- Method.</para>
- <para>NOTE: The details displayed here in conjunction with the
- 'Payments' sub menu could also be used to generate a customer
- statement or account showing details of customer activity during a
- specified time period.</para>
-</section>
diff --git
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_BillingAccountPayments.xml
b/applications/accounting/data/helpdata/HELP_ACCOUNTING_BillingAccountPayments.xml
deleted file mode 100644
index 4e62b36..0000000
---
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_BillingAccountPayments.xml
+++ /dev/null
@@ -1,131 +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 Billing Account Payments help screen</title>
- <para>This sub menu allows the creation of a payment that is automatically
applied to the
- billing account.</para>
- <para>It is used when a payment has been received from a customer that is
used to pay off the
- balance (or part balance) of a billing account. </para>
- <para>An example of how this works is similar to a credit card statement
where a list of
- transactions have been incurred over the previous month and one
payment is used to settle
- the outstanding balance.</para>
- <section>
- <title>How do I add a payment to a billing account?</title>
- <para>
- <orderedlist>
- <listitem>
- <para>Select the 'Payments' sub menu</para>
- </listitem>
- <listitem>
- <para>The 'Create Payment' screen is displayed</para>
- </listitem>
- <listitem>
- <para>Enter or use the lookup to enter the 'From Party Id'
(NOTE: By default
- this will be the Bill To Party of the Billing
Account)</para>
- </listitem>
- <listitem>
- <para>Select the 'Organisation Party Id' from the drop
down box</para>
- </listitem>
- <listitem>
- <para>Select the 'Payment Type Id' from the drop down box
(NOTE: By default this
- will be set to 'Customer Deposit')</para>
- </listitem>
- <listitem>
- <para>Leave the 'Payment Method Type' as 'Billing Account'
(NOTE TO CHECK: What
- happens if you do change this....)</para>
- </listitem>
- <listitem>
- <para>Enter the 'Amount' of the payment</para>
- </listitem>
- <listitem>
- <para>Press the 'Create' button</para>
- </listitem>
- </orderedlist>
- </para>
- <para>The new entry is displayed at the bottom of the screen. </para>
- <para>NOTE: The total amount of the payment will be applied to the
Billing Account. This can
- be verified by going to Accounting / Payments menu and locating
the newly created
- payment. The 'Amount to Apply' column will be zero.</para>
- </section>
- <section>
- <title>How do I update a payment for a billing account?</title>
- <para>A payment can be updated for a billing account by amending the
amount of the payment
- that has been applied to the billing account. For example if a
payment of $100 has been
- applied to a billing account it can be amended so that only $75
will be applied and $25
- will be available to be applied elsewhere.</para>
- <para>
- <orderedlist>
- <listitem>
- <para>Click on the 'Payment Id' of the payment that needs
to be removed</para>
- </listitem>
- <listitem>
- <para>The 'Payment Overview' screen is displayed</para>
- </listitem>
- <listitem>
- <para>Press the 'Update' button in the 'Payments Applied'
box</para>
- </listitem>
- <listitem>
- <para>The 'Payment Applications' screen is displayed</para>
- </listitem>
- <listitem>
- <para>Locate the 'Billing Account Id' and 'Amount
Applied'</para>
- </listitem>
- <listitem>
- <para>Amend the 'Amount Applied' for the billing
account</para>
- </listitem>
- <listitem>
- <para>Press the 'Update' button next to the entry that
refers to the 'Billing
- Account Id'</para>
- </listitem>
- </orderedlist>
- </para>
- <para>A message will be displayed saying that the payment has been
removed from the billing
- account</para>
- </section>
- <section>
- <title>How do I delete a payment from a billing account?</title>
- <para>A payment can be removed from billing account by removing the
link that has applied
- the payment to the billing account.</para>
- <para>
- <orderedlist>
- <listitem>
- <para>Click on the 'Payment Id' of the payment that needs
to be removed</para>
- </listitem>
- <listitem>
- <para>The 'Payment Overview' screen is displayed</para>
- </listitem>
- <listitem>
- <para>Press the 'Update' button in the 'Payments Applied'
box</para>
- </listitem>
- <listitem>
- <para>The 'Payment Applications' screen is displayed</para>
- </listitem>
- <listitem>
- <para>Press the 'Remove' button next to the entry that
refers to the 'Billing
- Account Id'</para>
- </listitem>
- </orderedlist>
- </para>
- <para>A message will be displayed saying that the payment has been
removed from the billing
- account</para>
- <para>NOTE : The above example was done when the payment status was at
'Not Paid' - need to
- test if it still works if the payment status is at 'Received' or
'Confirmed' too.
- </para>
- </section>
-</section>
diff --git
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditBillingAccount.xml
b/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditBillingAccount.xml
deleted file mode 100644
index bfa0299..0000000
---
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditBillingAccount.xml
+++ /dev/null
@@ -1,159 +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 Billing Account help screen</title>
- <para>The 'Account' sub menu is used to enter the basic details required
for setting up a new
- billing account or editing an existing one.</para>
- <para>It can be used to create or update the following details for a
Billing Account:</para>
- <para>
- <itemizedlist>
- <listitem>
- <para>Billing Account Identification</para>
- </listitem>
- <listitem>
- <para>Party to be Billed</para>
- </listitem>
- <listitem>
- <para>Billing Account Limit (NOTE: This is how much credit the
customer will be
- given eg $5000)</para>
- </listitem>
- <listitem>
- <para>Currency to be used for Billing Account</para>
- </listitem>
- <listitem>
- <para>Start and End Dates </para>
- </listitem>
- </itemizedlist>
- </para>
- <para>NOTE: There are currently two ways to add a party to a billing
account.</para>
- <para>
- <orderedlist>
- <listitem>
- <para>Enter a party id in the 'Party Billed To' field</para>
- </listitem>
- <listitem>
- <para>Use the 'Roles' sub menu to add a party id with the role
of 'Bill To
- Customer'</para>
- </listitem>
- <listitem>
- <para>If using the first method then when you press the update
button this removes
- the party id from this field and automatically creates the
party under the Roles
- sub menu with the role of 'Bill To Customer' </para>
- </listitem>
- </orderedlist>
- </para>
- <section>
- <title>How do I create a new Billing Account?</title>
- <para>NOTE TO CHECK: If the party doesnt have the role 'Bill To
Customer' is it
- automatically added when the billing account is created or will
the creation
- fail?..</para>
- <para>Example: To create a new Billing Account</para>
- <para>
- <orderedlist>
- <listitem>
- <para>Press the 'New' button and the 'Edit Billing
Account' screen is
- displayed</para>
- </listitem>
- <listitem>
- <para>Enter a code or number for the 'Billing Account Id'
(NOTE: If this is left
- blank a number will be automatically generated)</para>
- </listitem>
- <listitem>
- <para>Enter a number for the 'Billing Account Limit' (eg
5000)</para>
- </listitem>
- <listitem>
- <para>Leave the 'Account Currency UOM Id' as it is (NOTE:
This should be the
- default currency for Company...)</para>
- </listitem>
- <listitem>
- <para>Enter a description that can be used to identify the
Billing Account (eg
- Joe Bloggs Builders Billing Account)</para>
- </listitem>
- <listitem>
- <para>Leave the 'Contact Mech' field as it is (NOTE: This
field cannot be filled
- in until either the 'Party Billed To' has been filled
in or a party with the
- role of 'Bill To Customer' has been added under the
'Roles' sub menu</para>
- </listitem>
- <listitem>
- <para>Enter the Billing Account start date in the 'From
Date' field. (NOTE: If
- left blank then this will default to the current date
and time. NOTE TO
- CHECK: Can this date be in the future.....?)</para>
- </listitem>
- <listitem>
- <para>Leave the 'Thru date' field blank</para>
- </listitem>
- <listitem>
- <para>Enter or use the lookup to select the 'Party Billed
To'</para>
- </listitem>
- <listitem>
- <para>Press the 'Update' button</para>
- </listitem>
- </orderedlist>
- </para>
- <para>After the 'Update' button has been pressed then the 'Contact
Mech Id' field will
- either be automatically filled in or will allow you to select a
contact mech from a drop
- down list </para>
- </section>
- <section>
- <title>How do I update an existing Billing Account?</title>
- <para>Billing Account details can be updated. A key field that may
need to be updated is the
- actual Billing Account Limit if a customer reduces or improves
their credit
- rating</para>
- <para>Example: To Update a Billing Account</para>
- <para>
- <orderedlist>
- <listitem>
- <para>Click on the 'Billing Account Id' of the Billing
Account to updated</para>
- </listitem>
- <listitem>
- <para>The 'Edit Billing Account' screen is displayed</para>
- </listitem>
- <listitem>
- <para>Enter the changes required</para>
- </listitem>
- <listitem>
- <para>Press the 'Update' button</para>
- </listitem>
- </orderedlist>
- </para>
- </section>
- <section>
- <title>How do I delete a Billing Account?</title>
- <para>Billing Accounts cannot be deleted. They can only be expired.
This means that they
- will no longer be able to be used to associate invoices or
payments against.</para>
- <para>Example: To Expire a Billing Account</para>
- <para>
- <orderedlist>
- <listitem>
- <para> Click on the 'Billing Account Id' of the Billing
Account to be
- expired</para>
- </listitem>
- <listitem>
- <para>The 'Edit Billing Account' screen is displayed</para>
- </listitem>
- <listitem>
- <para>Enter the current date in the 'Thru date'
field</para>
- </listitem>
- <listitem>
- <para>Press the 'Update' button </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
-</section>
diff --git
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditBillingAccountRoles.xml
b/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditBillingAccountRoles.xml
deleted file mode 100644
index 8a515f0..0000000
---
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditBillingAccountRoles.xml
+++ /dev/null
@@ -1,98 +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 Billing Account Roles help screen</title>
- <para>This sub menu allows parties with specific roles to be associated
with to a Billing
- Account. Roles allows you to specify a party role. </para>
- <para> is used to specify which party should be billed for the billing
account. It can be used
- as follows:</para>
- <para>
- <itemizedlist>
- <listitem>
- <para>Simple billing account for a single party</para>
- </listitem>
- <listitem>
- <para>More complex billing account where multiple parties (eg
company subsidiaries)
- charge invoices to the billing account but a different
party (eg head office)
- will pay the account </para>
- </listitem>
- </itemizedlist>
- </para>
- <section>
- <title>How do I add a party role to a billing account?</title>
- <para>Select the 'Roles' sub menu</para>
- <orderedlist>
- <listitem>
- <para>Enter or use the lookup to select the 'Party Id'</para>
- </listitem>
- <listitem>
- <para>Select the 'Role Type Id' from the drop down box (eg
Bill To Customer)</para>
- </listitem>
- <listitem>
- <para>Leave the 'From Date' blank (NOTE: If left blank it will
default to the
- current date and time)</para>
- </listitem>
- <listitem>
- <para>Leave the 'Thru Date' blank</para>
- </listitem>
- <listitem>
- <para>Press the 'Add' button</para>
- </listitem>
- </orderedlist>
- <para>The new party role is displayed at the bottom of the screen
</para>
- </section>
- <section>
- <title>How do I update a party role for a billing account?</title>
- <para>The only field that can be updated for a party role is the 'Thru
Date'. If any other
- details need to be amended then the entry will need to be deleted
and then
- recreated.</para>
- <para>
- <orderedlist>
- <listitem>
- <para>Select the 'Roles' sub menu</para>
- </listitem>
- <listitem>
- <para>Locate the entry that needs to be amended</para>
- </listitem>
- <listitem>
- <para>Enter or use the lookup to enter the 'Thru
Date'</para>
- </listitem>
- <listitem>
- <para>Press the 'Update' button for the entry </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
- <section>
- <title>How do I delete a party role from a billing account?</title>
- <para>
- <orderedlist>
- <listitem>
- <para>Locate the entry that needs to be deleted</para>
- </listitem>
- <listitem>
- <para>Press the 'Delete' button next to the entry</para>
- </listitem>
- <listitem>
- <para>The entry will be removed from the bottom of the
screen </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
-</section>
diff --git
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditBillingAccountTerms.xml
b/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditBillingAccountTerms.xml
deleted file mode 100644
index 8a6dfbe..0000000
---
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditBillingAccountTerms.xml
+++ /dev/null
@@ -1,106 +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 Billing Account Terms help screen</title>
- <para>This sub menu allows terms to be associated with a billing account.
Currently these can be
- the following:</para>
- <para>
- <itemizedlist>
- <listitem>
- <para>payment terms (discounted if paid within specified
days)</para>
- </listitem>
- <listitem>
- <para>payment terms (due on a specified day per month)</para>
- </listitem>
- <listitem>
- <para>payment terms (net days)</para>
- </listitem>
- <listitem>
- <para>penalty terms (late fee)</para>
- </listitem>
- <listitem>
- <para>penalty terms (collection agency fee)</para>
- </listitem>
- <listitem>
- <para>miscellaneous (non returnable sales item)</para>
- </listitem>
- </itemizedlist>
- </para>
- <para>>NOTE: There is an overlap here with the terms that can be specified
in an agreement.
- Would a billing account party also have an agreement for payment
terms...? .</para>
- <section>
- <title>How do I add terms to a billing account?</title>
- <para>
- <orderedlist>
- <listitem>
- <para>Select the 'Terms' sub menu</para>
- </listitem>
- <listitem>
- <para>Select a 'Term Type' from the drop down box (eg.
Payment net days)</para>
- </listitem>
- <listitem>
- <para>Leave the 'UOM' field blank</para>
- </listitem>
- <listitem>
- <para>Enter a number in the 'Term Value' field (eg. 30
which would mean '30
- days' when related to 'Payment net days')</para>
- </listitem>
- <listitem>
- <para>Press the 'Save' button</para>
- </listitem>
- </orderedlist>
- </para>
- <para>The term is displayed in the top part of the screen </para>
- </section>
- <section>
- <title>How do I update terms for a billing account?</title>
- <para>Select the 'Terms' sub menu</para>
- <para>
- <orderedlist>
- <listitem>
- <para>Press the 'Edit' button next to the entry that needs
to be amended</para>
- </listitem>
- <listitem>
- <para>The details are displayed in the 'Edit Billing
Account Terms' box</para>
- </listitem>
- <listitem>
- <para>Update the 'Term Type', 'UOM' or 'Term Value' as
required</para>
- </listitem>
- <listitem>
- <para>Press the 'Save' button</para>
- </listitem>
- </orderedlist>
- </para>
- <para>The updated term is displayed in the top part of the screen
</para>
- </section>
- <section>
- <title>How do I remove terms from a billing account?</title>
- <para>
- <orderedlist>
- <listitem>
- <para>Select the 'Terms' sub menu</para>
- </listitem>
- <listitem>
- <para>Press the 'Delete' button next to the entry that
needs to be removed
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
-</section>
diff --git
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_FindBillingAccount.xml
b/applications/accounting/data/helpdata/HELP_ACCOUNTING_FindBillingAccount.xml
deleted file mode 100644
index 0b87aac..0000000
---
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_FindBillingAccount.xml
+++ /dev/null
@@ -1,26 +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 Billing Account help screen</title>
- <para>The default screen is for the Billing Account tab is 'Find
- Billing Account'. It is used to locate existing billing accounts that
- have been created.</para>
- <para>The user has the option to select an existing billing account or
- create a new one by clicking on the 'New' button.</para>
-</section>
diff --git
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_billing_accounts.xml
b/applications/accounting/data/helpdata/HELP_ACCOUNTING_billing_accounts.xml
deleted file mode 100644
index abef500..0000000
--- a/applications/accounting/data/helpdata/HELP_ACCOUNTING_billing_accounts.xml
+++ /dev/null
@@ -1,81 +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>Billing Accounts.</title>
- <para>A billing account is a way of allowing customers to consolidate
several invoices into an
- account that is paid off at a later date.Customers can be allocated a
credit limit and
- orders can be taken up to the value of the credit limit without any
payment being made.
- Statements to the customer can then be generated (eg monthly) and
payment is made based on
- the outstanding amount.</para>
- <para>NOTE: A billing account does not change the flow of the normal
Invoice and Payment
- processes. It simply allows for a more structured organisation of
Invoices and
- Payments..</para>
- <para>Billing Accounts can be used for the following:</para>
- <para>
- <itemizedlist>
- <listitem>
- <para>Setting credit limits for customers</para>
- </listitem>
- <listitem>
- <para>Keeping track of credit available to customer for
purchase on account</para>
- </listitem>
- <listitem>
- <para>Keeping track of payments made in advance (NOTE TO
CHECK: Could also use
- Financial Account for advance payments but need to
understand the differences in
- functionality and process) </para>
- </listitem>
- <listitem>
- <para>Keeping track of a subset of payments and invoices for a
specific client, i.e.
- allowing them to have multiple billing accounts (NOTE TO
CHECK: This is from
- David - does this mean having multiple accounts for one
customer or does it mean
- one billing account can track a hierarchy of invoices and
payments.....)</para>
- </listitem>
- <listitem>
- <para>Allow multiple authorised parties to bill against the
same account which one
- party is responsible for paying (e.g. different offices of
the same organisation
- may have one single account with a supplier to make use of
order volume
- discounts)</para>
- </listitem>
- <listitem>
- <para>Managing and generating customer statements ??</para>
- </listitem>
- <listitem>
- <para>Customer specific order tracking</para>
- </listitem>
- <listitem>
- <para>Accounts Receivable / Debt Management</para>
- </listitem>
- <listitem>
- <para>Analysis and monitoring customer spending
(creditworthiness / discounts /
- product popularity ???)</para>
- </listitem>
- </itemizedlist>
- </para>
- <para>NOTE: A payment that is applied (or matched) to a Billing Account it
should still be
- applied to an invoice. In the case where the payment arrives before
the invoice has been
- generated then once the invoice is generated it should be applied to
the payment or
- payments. </para>
- <xi:include href="HELP_ACCOUNTING_FindBillingAccount.xml"/>
- <xi:include href="HELP_ACCOUNTING_EditBillingAccount.xml"/>
- <xi:include href="HELP_ACCOUNTING_EditBillingAccountRoles.xml"/>
- <xi:include href="HELP_ACCOUNTING_EditBillingAccountTerms.xml"/>
- <xi:include href="HELP_ACCOUNTING_BillingAccountInvoices.xml"/>
- <xi:include href="HELP_ACCOUNTING_BillingAccountPayments.xml"/>
- <xi:include href="HELP_ACCOUNTING_BillingAccountOrders.xml"/>
-</section>
diff --git
a/applications/accounting/src/docs/asciidoc/_include/HELP_BillingAccountInvoices.adoc
b/applications/accounting/src/docs/asciidoc/_include/HELP_BillingAccountInvoices.adoc
new file mode 100644
index 0000000..7049196
--- /dev/null
+++
b/applications/accounting/src/docs/asciidoc/_include/HELP_BillingAccountInvoices.adoc
@@ -0,0 +1,63 @@
+////
+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 Billing Account Invoices
+The Billing Account Find Invoices screen displays by default a list of
invoices that have been charged to the billing account.
+
+Any invoice displayed here means that its invoice amount has been deducted
from the billing account credit limit.
+For example: If the Billing Account Credit Limit is $100 and the there are 2
invoices displayed with amounts $10 and $25 then
+ the available credit for the billing account will be $75.
+
+The invoice can be at various statues and there is an option to locate an
invoice by status.
+
+It is also used to apply any payments that have been made into the Billing
Account to an invoice.
+A 'Capture' button is displayed next to each invoice displayed that has an
amount outstanding.
+
+Example:
+
+* Two invoices are charged to a Billing Account (Invoice A $10 and Invoice B
$25)
+* A payment of $17 has been paid into the Billing Account
+* If the Capture button is pressed for the invoice A then $10 of the $17
payment will be applied to this invoice and
+ a new payment transaction of $7 will be created and available to apply to a
different invoice
+
+
+== How do I locate an invoice by status?
+. Select the 'Invoices' sub menu
+. Use the drop down box to select the 'Status Id' for the invoice required
+. Press the 'Submit' button
+
+A list of invoices with the required status will be displayed
+
+== How do I capture a payment for an invoice?
+IMPORTANT: In order for this to work a payment needs to have been made to the
billing account that has not been completely applied
+ to any other invoices.
+
+Payments to a billing account can be done via the 'Payments' sub menu for the
billing account or by using Accounting / Payments menu.
+
+. Select the 'Invoices' sub menu
+. Locate the invoice required +
+ (NOTE: The 'Amount to Apply' is the same as the 'Total' column)
+. Press the 'Capture' button +
+ (NOTE: The 'Amount to Apply' is different to the 'Total' column)
+
+The 'Capture' button is no longer displayed next to the invoice and an
additional payments transaction will be created for
+ any difference between the invoice total and the amount paid (Eg Invoice
Total $100, Payment Amount $125,
+ the new payment transaction amount will be $25)
+
+NOTE: The above example assumes that the payment available will cover the
total amount outstanding for the invoice
diff --git
a/applications/accounting/src/docs/asciidoc/_include/HELP_BillingAccountOrders.adoc
b/applications/accounting/src/docs/asciidoc/_include/HELP_BillingAccountOrders.adoc
new file mode 100644
index 0000000..bac9775
--- /dev/null
+++
b/applications/accounting/src/docs/asciidoc/_include/HELP_BillingAccountOrders.adoc
@@ -0,0 +1,26 @@
+////
+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 Billing Account Orders
+This sub menu lists the details of any Sales Orders that have been charged to
the billing account.
+
+A Sales Order is charged to a billing account by selecting the billing account
as the Payment Method.
+
+NOTE: The details displayed here in conjunction with the 'Payments' sub menu
could also be used to generate
+ a customer statement or account showing details of customer activity
during a specified time period.
\ No newline at end of file
diff --git
a/applications/accounting/src/docs/asciidoc/_include/HELP_BillingAccountPayments.adoc
b/applications/accounting/src/docs/asciidoc/_include/HELP_BillingAccountPayments.adoc
new file mode 100644
index 0000000..07d44d6
--- /dev/null
+++
b/applications/accounting/src/docs/asciidoc/_include/HELP_BillingAccountPayments.adoc
@@ -0,0 +1,78 @@
+////
+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 Billing Account Payments
+This sub menu allows the creation of a payment that is automatically applied
to the billing account.
+
+It is used when a payment has been received from a customer that is used to
pay off the balance (or part balance) of
+ a billing account.
+
+An example of how this works is similar to a credit card statement where a
list of transactions have been incurred
+ over the previous month and one payment is used to settle the outstanding
balance.
+
+== How do I add a payment to a billing account?
+. Select the 'Payments' sub menu
+. The 'Create Payment' screen is displayed
+. Enter or use the lookup to enter the 'From Party Id' +
+ (NOTE: By default this will be the Bill To Party of the Billing Account)
+. Select the 'Organisation Party Id' from the drop down box
+. Select the 'Payment Type Id' from the drop down box +
+ (NOTE: By default this will be set to 'Customer Deposit')
+. Leave the 'Payment Method Type' as 'Billing Account' +
+ (NOTE TO CHECK: What happens if you do change this....)
+. Enter the 'Amount' of the payment
+. Press the 'Create' button
+
+The new entry is displayed at the bottom of the screen.
+
+NOTE: The total amount of the payment will be applied to the Billing Account. +
+ This can be verified by going to Accounting / Payments menu and locating
the newly created payment. +
+ The 'Amount to Apply' column will be zero.
+
+== How do I update a payment for a billing account?
+A payment can be updated for a billing account by amending the amount of the
payment that has been applied
+ to the billing account.
+
+For example if a payment of $100 has been applied to a billing account it can
be amended so that only $75
+will be applied and $25 will be available to be applied elsewhere.
+
+. Click on the 'Payment Id' of the payment that needs to be removed
+. The 'Payment Overview' screen is displayed
+. Press the 'Update' button in the 'Payments Applied' box
+. The 'Payment Applications' screen is displayed
+. Locate the 'Billing Account Id' and 'Amount Applied'
+. Amend the 'Amount Applied' for the billing account
+. Press the 'Update' button next to the entry that refers to the 'Billing
Account Id'
+
+A message will be displayed saying that the payment has been removed from the
billing account
+
+== How do I delete a payment from a billing account?
+A payment can be removed from billing account by removing the link that has
applied the payment to the billing account.
+
+. Click on the 'Payment Id' of the payment that needs to be removed
+. The 'Payment Overview' screen is displayed
+. Press the 'Update' button in the 'Payments Applied' box
+. The 'Payment Applications' screen is displayed
+. Press the 'Remove' button next to the entry that refers to the 'Billing
Account Id'
+
+A message will be displayed saying that the payment has been removed from the
billing account
+
+NOTE: The above example was done when the payment status was at 'Not Paid' +
+ TO CHECK: need to test if it still works if the payment status is at
'Received' or 'Confirmed' too.
+
\ No newline at end of file
diff --git
a/applications/accounting/src/docs/asciidoc/_include/HELP_EditBillingAccount.adoc
b/applications/accounting/src/docs/asciidoc/_include/HELP_EditBillingAccount.adoc
new file mode 100644
index 0000000..d8fa1cb
--- /dev/null
+++
b/applications/accounting/src/docs/asciidoc/_include/HELP_EditBillingAccount.adoc
@@ -0,0 +1,88 @@
+////
+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 Billing Account
+The 'Account' sub menu is used to enter the basic details required for setting
up a new billing account or editing an existing one.
+
+It can be used to create or update the following details for a Billing Account:
+
+* Billing Account Identification
+* Party to be Billed
+* Billing Account Limit +
+ (NOTE: This is how much credit the customer will be given eg $5000)
+* Currency to be used for Billing Account
+* Start and End Dates
+
+NOTE: There are currently two ways to add a party to a billing account.
+
+. Enter a party id in the 'Party Billed To' field
+. Use the 'Roles' sub menu to add a party id with the role of 'Bill To
Customer'
+. If using the first method then when you press the update button this removes
the party id from this field and
+ automatically creates the party under the Roles sub menu with the role of
'Bill To Customer'
+
+
+== How do I create a new Billing Account?
+
+NOTE: TO CHECK: If the party doesnt have the role 'Bill To Customer' is it
automatically added when the billing account
+ is created or will the creation fail?..
+
+Example: To create a new Billing Account
+
+. Press the 'New' button and the 'Edit Billing Account' screen is displayed
+. Enter a code or number for the 'Billing Account Id' +
+ (NOTE: If this is left blank a number will be automatically generated)
+. Enter a number for the 'Billing Account Limit' (eg 5000)
+. Leave the 'Account Currency UOM Id' as it is +
+ (NOTE: This should be the default currency for Company...)
+. Enter a description that can be used to identify the Billing Account (eg Joe
Bloggs Builders Billing Account)
+. Leave the 'Contact Mech' field as it is +
+ (NOTE: This field cannot be filled in until either the 'Party Billed To' has
been filled in or a party with
+ the role of 'Bill To Customer' has been added under the 'Roles' sub menu)
+. Enter the Billing Account start date in the 'From Date' field. +
+ (NOTE: If left blank then this will default to the current date and time. +
+ TO CHECK: Can this date be in the future.....?)
+. Leave the 'Thru date' field blank
+. Enter or use the lookup to select the 'Party Billed To'
+. Press the 'Update' button
+
+After the 'Update' button has been pressed then the 'Contact Mech Id' field
will either be automatically filled in
+ or will allow you to select a contact mech from a drop down list
+
+== How do I update an existing Billing Account?
+Billing Account details can be updated. +
+A key field that may need to be updated is the actual Billing Account Limit if
a customer reduces or improves their credit rating
+
+Example: To Update a Billing Account
+
+. Click on the 'Billing Account Id' of the Billing Account to updated
+. The 'Edit Billing Account' screen is displayed
+. Enter the changes required
+. Press the 'Update' button
+
+
+== How do I delete a Billing Account?
+Billing Accounts cannot be deleted. +
+They can only be expired. +
+This means that they will no longer be able to be used to associate invoices
or payments against.
+
+Example: To Expire a Billing Account
+
+. Click on the 'Billing Account Id' of the Billing Account to be expired
+. The 'Edit Billing Account' screen is displayed
+. Enter the current date in the 'Thru date' field
+. Press the 'Update' button
diff --git
a/applications/accounting/src/docs/asciidoc/_include/HELP_EditBillingAccountRoles.adoc
b/applications/accounting/src/docs/asciidoc/_include/HELP_EditBillingAccountRoles.adoc
new file mode 100644
index 0000000..5efcf21
--- /dev/null
+++
b/applications/accounting/src/docs/asciidoc/_include/HELP_EditBillingAccountRoles.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 Billing Account Roles
+This sub menu allows parties with specific roles to be associated with to a
Billing Account. +
+
+It is used to specify which party should be billed for the billing account.
+
+It can be used as follows:
+
+* Simple billing account for a single party
+* More complex billing account where multiple parties (eg company
subsidiaries) charge invoices to the billing account
+ but a different party (eg head office) will pay the account
+
+== How do I add a party role to a billing account?
+Select the 'Roles' sub menu
+
+. Enter or use the lookup to select the 'Party Id'
+. Select the 'Role Type Id' from the drop down box (eg Bill To Customer)
+. Leave the 'From Date' blank +
+ (NOTE: If left blank it will default to the current date and time)
+. Leave the 'Thru Date' blank
+. Press the 'Add' button
+
+The new party role is displayed at the bottom of the screen
+
+== How do I update a party role for a billing account?
+The only field that can be updated for a party role is the 'Thru Date'. If any
other details need to be amended then
+the entry will need to be deleted and then recreated.
+
+. Select the 'Roles' sub menu
+. Locate the entry that needs to be amended
+. Enter or use the lookup to enter the 'Thru Date'
+. Press the 'Update' button for the entry
+
+
+== How do I delete a party role from a billing account?
+. Locate the entry that needs to be deleted
+. Press the 'Delete' button next to the entry
+. The entry will be removed from the bottom of the screen
diff --git
a/applications/accounting/src/docs/asciidoc/_include/HELP_EditBillingAccountTerms.adoc
b/applications/accounting/src/docs/asciidoc/_include/HELP_EditBillingAccountTerms.adoc
new file mode 100644
index 0000000..39c5b49
--- /dev/null
+++
b/applications/accounting/src/docs/asciidoc/_include/HELP_EditBillingAccountTerms.adoc
@@ -0,0 +1,58 @@
+////
+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 Billing Account Terms
+This sub menu allows terms to be associated with a billing account.
+
+Currently these can be the following:
+
+* payment terms (discounted if paid within specified days)
+* payment terms (due on a specified day per month)
+* payment terms (net days)
+* penalty terms (late fee)
+* penalty terms (collection agency fee)
+* miscellaneous (non returnable sales item)
+
+NOTE: TO CHECK: There is an overlap here with the terms that can be specified
in an agreement.
+ Would a billing account party also have an agreement for payment
terms...? .
+
+== How do I add terms to a billing account?
+
+. Select the 'Terms' sub menu
+. Select a 'Term Type' from the drop down box (eg. Payment net days)
+. Leave the 'UOM' field blank
+. Enter a number in the 'Term Value' field +
+ (eg. 30 which would mean '30 days' when related to 'Payment net days')
+. Press the 'Save' button
+
+The term is displayed in the top part of the screen
+
+== How do I update terms for a billing account?
+Select the 'Terms' sub menu
+
+. Press the 'Edit' button next to the entry that needs to be amended
+. The details are displayed in the 'Edit Billing Account Terms' box
+. Update the 'Term Type', 'UOM' or 'Term Value' as required
+. Press the 'Save' button
+
+The updated term is displayed in the top part of the screen
+
+== How do I remove terms from a billing account?
+. Select the 'Terms' sub menu
+. Press the 'Delete' button next to the entry that needs to be removed
diff --git
a/applications/accounting/src/docs/asciidoc/_include/HELP_FindBillingAccount.adoc
b/applications/accounting/src/docs/asciidoc/_include/HELP_FindBillingAccount.adoc
new file mode 100644
index 0000000..a85b811
--- /dev/null
+++
b/applications/accounting/src/docs/asciidoc/_include/HELP_FindBillingAccount.adoc
@@ -0,0 +1,25 @@
+////
+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 Billing Account
+
+The default screen is for the Billing Account tab is 'Find Billing Account'.
+It is used to locate existing billing accounts that have been created.
+
+The user has the option to select an existing billing account or create a new
one by clicking on the 'New' button.
\ No newline at end of file
diff --git
a/applications/accounting/src/docs/asciidoc/_include/acc-billing-accounts.adoc
b/applications/accounting/src/docs/asciidoc/_include/acc-billing-accounts.adoc
new file mode 100644
index 0000000..830e814
--- /dev/null
+++
b/applications/accounting/src/docs/asciidoc/_include/acc-billing-accounts.adoc
@@ -0,0 +1,64 @@
+////
+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.
+////
+
+= Billing Accounts.
+
+A billing account is a way of allowing customers to consolidate several
invoices into an account that is paid off
+at a later date. Customers can be allocated a credit limit and orders can be
taken up to the value of the credit limit without
+any payment being made.
+Statements to the customer can then be generated (eg monthly) and payment is
made based on the outstanding amount.
+
+NOTE: A billing account does not change the flow of the normal Invoice and
Payment processes.
+ It simply allows for a more structured organisation of Invoices and
Payments..
+
+Billing Accounts can be used for the following:
+
+* Setting credit limits for customers
+* Keeping track of credit available to customer for purchase on account
+* Keeping track of payments made in advance +
+ (NOTE TO CHECK: Could also use Financial Account for advance payments but
need to understand the differences
+ in functionality and process)
+* Keeping track of a subset of payments and invoices for a specific client,
i.e. allowing them to have multiple billing accounts +
+ (NOTE TO CHECK: This is from David - does this mean having multiple accounts
for one customer or does it mean one
+ billing account can track a hierarchy of invoices and payments.....)
+* Allow multiple authorised parties to bill against the same account which one
party is responsible for paying +
+ (e.g. different offices of the same organisation may have one single account
with a supplier to make use of order volume discounts)
+* Managing and generating customer statements ??
+* Customer specific order tracking
+* Accounts Receivable / Debt Management
+* Analysis and monitoring customer spending (creditworthiness / discounts /
product popularity ???)
+
+NOTE: A payment that is applied (or matched) to a Billing Account it should
still be applied to an invoice.
+ In the case where the payment arrives before the invoice has been
generated then once the invoice is generated
+ it should be applied to the payment or payments.
+
+== Billing Account management in User Interface
+include::HELP_FindBillingAccount.adoc[leveloffset=+2]
+
+include::HELP_EditBillingAccount.adoc[leveloffset=+2]
+
+include::HELP_EditBillingAccountRoles.adoc[leveloffset=+2]
+
+include::HELP_EditBillingAccountTerms.adoc[leveloffset=+2]
+
+include::HELP_BillingAccountInvoices.adoc[leveloffset=+2]
+
+include::HELP_BillingAccountPayments.adoc[leveloffset=+2]
+
+include::HELP_BillingAccountOrders.adoc[leveloffset=+2]
diff --git a/applications/accounting/src/docs/asciidoc/accounting.adoc
b/applications/accounting/src/docs/asciidoc/accounting.adoc
index b70966a..f3d3d35 100644
--- a/applications/accounting/src/docs/asciidoc/accounting.adoc
+++ b/applications/accounting/src/docs/asciidoc/accounting.adoc
@@ -34,6 +34,8 @@ include::_include/acc-payments.adoc[leveloffset=+1]
include::_include/acc-payments-gateway.adoc[leveloffset=+1]
+include::_include/acc-billing-accounts.adoc[leveloffset=+1]
+
include::_include/acc-agreements.adoc[leveloffset=+1]
include::_include/acc-financial-accounts.adoc[leveloffset=+1]
