view release on metacpan or  search on metacpan

lib/Business/AU/Ledger.pm  view on Meta::CPAN

=item submit_payment

=item submit_receipt

=item tab_set

=item update_context

=item update_payments

=item update_receipts

=back

=head1 Installation and Configuration

=head2 Installation

There are several steps in the installation process:

=over 4

=item Install the database server

You will edit .htledger.conf, as explained below, to tell Business::AU::Ledger
how to connect to the database.

=item Install the Perl module Business::AU::Ledger

This is the same as installing any other Perl module.

Note, however, that you will I<always> need to download the distro from CPAN,
because other installation and configuration steps use files not installed in the
Perl module tree.

Note, also, that installing the module will install a file called .htledger.conf in Perl's module tree,
and in the next few steps you may wish to edit that file. In this case, the file's permissions become relevant.

=item Install the HTML templates

Unpack the distro, and copy (recursively) the directory htdocs/assets/ to your web server's doc root directory.

If you do not wish to use the recommended directory structure, put the contents of
htdocs/assets/css/business/au/ledger/ and htdocs/assets/templates/business/au/ledger/ anywhere you want,
and edit the file lib/Business/AU/Ledger/.htledger.conf (css_url and tmpl_path) to match.

=item Install the YUI (see FAQ below)

Download YUI from http://developer.yahoo.com/yui/ and install it in your web server's doc root directory.

Then, if necessary, edit lib/Business/AU/Ledger/.htledger.conf, where it says yui_url=/yui.

=item Install lib/Business/AU/Ledger/.htledger.conf

Installing the module will have installed the version of .htledger.conf as shipped within the distro.

If you edit your local copy of .htledger.conf, you must use your edited copy to overwrite the version installed
automatically.

Specifically, the database credentials in this file will need to be edited, since several programs use them
to connect to the database.

=item Install the CGI script ledger.cgi

Copy cgi-bin/ledger.cgi into your web server's cgi-bin directory, and mark it as executable.

=back

=head2 Configuation

=over 4

=item Initialize the database tables

In the unpacked distro dir, run:

	perl scripts/create.tables.pl
	perl scripts/populate.tables.pl

Check that this worked by logging on to your database server, via the command line say, and running:

	select * from tx_details

You should get 15 rows output.

=item Point your web client at http://127.0.0.1/cgi-bin/ledger.cgi

To start, you must specify the first month of your financial year.

After that, click on Payments or Receipts, then on the name of a month.

Lastly, click on Initialize to display any transactions already in the database for that month.

=back

=head1 FAQ

=head2 Q: How do you handle the ATO's requirements for BAS and GST?

ATO is Australian Tax Office.

BAS is Business Activity Statement, the basic document by which many businesses report turnover details.

GST is Goods and Services Tax.

The answer is: I don't (for which I'm extremely grateful).

That is, I run my business in such a way as to simply not need to account for those details. I do this
by performing contract programming services via a contract with Freelance Global ( http://www.freelance-global.com/ ),
an organization operated by my accountant (M. Kelson).

Organizations wishing to hire me sign a contract with Freelance, not with me directly.
Hence I avoid the need to manage BAS- and GST-related components of financial transactions.

However, I do understand they are important, and will eventually add those features if those of you needing them
give me the support I need.

=head2 Q: What happened to the Petty Cash/Private Use columns in the Payments input screen?

A: I don't use those fields. If they vanished from one version to the next, it's because