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

freeside-issue-credit-for-taxnums

NAME

freeside-issue-credit-for-taxnums

SYNOPSIS

freeside freeside-issue-credit-for-taxnums [options] [freeside_user]

OPTIONS

--help

Display help and exit

--csv_dir [directory]

Directory to save CSV reports into

cust_bill_pkg_location.csv

Contains a list of all rows from cust_bill_pkg to be credited

cust_adjustments.csv

Contains a list of all intended customer adjustments amounts

cust_credit.csv

Contains all rows created in cust_credit to issue customer adjustments

--start-date [yyyy-mm-dd]

The start of the date range to search for invoices containing taxes to credit

--end-date [yyyy-mm-dd]

The end of the date range to search for invoices containing taxes to credit

--taxnums [123,124,125,126]

A comma separated list, with no spaces, of taxnums to issue credits for

--credit-reasonnum [22]

The credit reasonnum to be attached to issued credits

--credit-addlinfo "[Credits happen for this reason]"

Comment field attached to issued credits. Enclose text within quotes.

--insert-credits

Unless this flag is set, no changes will be written to customer accounts

--apply-credits

If this flag is set, created credits will be applied to the original bill that created the charge to be refunded. If you want the credit to be created as an unapplied credit, do not set this flag

DESCRIPTION

Tool to issue credit to customers when taxes were charged in error

Given a list of taxnums, and a date range, utility will compile a CSV report of customer charges for those taxnums.

When directed, utility will issue a credit to the account of each of those customers, and generate a CSV report describing those credits for reporting

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