<% include( '/elements/header.html', 'Developer Documentation' ) %> <& /elements/menubar.html, 'Freeside Perl Modules' => $fsurl.'docs/library/FS.html', 'Complete Index' => $fsurl.'docs/library/index.html', &>

FS::Report::Tax::ByName

report OPTIONS

Constructor. Generates a tax report using the internal tax rate system (FS::cust_main_county), showing all taxes with a specified tax name, broken down by state/county. Optionally, the taxes can be broken down further by city/district, tax class, or package class.

Required parameters:

- beginning, ending: the date range as Unix timestamps. - taxname: the name of the tax (corresponds to cust_bill_pkg.itemdesc). - country: the country code.

Optional parameters: - agentnum: limit to this agentnum.num. - breakdown: hashref of the fields to group by. Keys can be 'city', 'district', 'pkgclass', or 'taxclass'; values should be true. - total_only: don't run the tax group queries, only the totals queries. Returns one row, except in the unlikely event you're using breakdown by package class. - debug: sets the debug level. 1 will warn the data collected for the report; 2 will also warn all of the SQL statements.

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 12:

'=item' outside of any '=over'

=over without closing =back

<% include ('/elements/footer.html' ) %>