Difference between revisions of "Freeside:1.7:Documentation:Developer/bin/freeside-daily"
From Freeside
(import from POD) |
(→DESCRIPTION) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 4: | Line 4: | ||
==SYNOPSIS== | ==SYNOPSIS== | ||
<code> | <code> | ||
| − | freeside-daily [ -d 'date' ] [ -y days ] [ -p 'payby' ] [ -a agentnum ] [ -s ] [ -v ] user [ custnum custnum ... ] | + | freeside-daily [ -d 'date' ] [ -y days ] [ -p 'payby' ] [ -a agentnum ] [ -s ] [ -v ] [ -l level ] [ -m ] [ -r ] [ -k ] user [ custnum custnum ... ] |
</code> | </code> | ||
==DESCRIPTION== | ==DESCRIPTION== | ||
| Line 21: | Line 21: | ||
-n: When used with "-d" and/or "-y", specifies that invoices should be dated | -n: When used with "-d" and/or "-y", specifies that invoices should be dated | ||
| − | with today's date, | + | with today's date, regardless of the pretend date used to pre-generate |
the invoices. | the invoices. | ||
| Line 31: | Line 31: | ||
-v: enable debugging | -v: enable debugging | ||
| + | |||
| + | -l: debugging level | ||
| + | |||
| + | -m: Experimental multi-process mode uses the job queue for multi-process and/or multi-machine billing. | ||
| + | |||
| + | -r: Multi-process mode dry run option | ||
| + | |||
| + | -k: skip notify_flat_delay and vacuum | ||
</code> | </code> | ||
user: From the mapsecrets file - see config.html from the base documentation | user: From the mapsecrets file - see config.html from the base documentation | ||
Latest revision as of 23:48, 31 July 2012
Contents
NAME
freeside-daily - Run daily billing and invoice collection events.
SYNOPSIS
freeside-daily [ -d 'date' ] [ -y days ] [ -p 'payby' ] [ -a agentnum ] [ -s ] [ -v ] [ -l level ] [ -m ] [ -r ] [ -k ] user [ custnum custnum ... ]
DESCRIPTION
Bills customers and runs invoice collection events. Should be run from crontab daily.
Bills customers. Searches for customers who are due for billing and calls the bill and collect methods of a cust_main object. See FS::cust_main.
-d: Pretend it's 'date'. Date is in any format Date::Parse is happy with,
but be careful.
-y: In addition to -d, which specifies an absolute date, the -y switch
specifies an offset, in days. For example, "-y 15" would increment the
"pretend date" 15 days from whatever was specified by the -d switch
(or now, if no -d switch was given).
-n: When used with "-d" and/or "-y", specifies that invoices should be dated
with today's date, regardless of the pretend date used to pre-generate
the invoices.
-p: Only process customers with the specified payby (I<CARD>, I<DCRD>, I<CHEK>, I<DCHK>, I<BILL>, I<COMP>, I<LECB>)
-a: Only process customers with the specified agentnum
-s: re-charge setup fees
-v: enable debugging
-l: debugging level
-m: Experimental multi-process mode uses the job queue for multi-process and/or multi-machine billing.
-r: Multi-process mode dry run option
-k: skip notify_flat_delay and vacuum
user: From the mapsecrets file - see config.html from the base documentation
custnum: if one or more customer numbers are specified, only bills those customers. Otherwise, bills all customers.
BUGS
SEE ALSO
FS::cust_main, config.html from the base documentation
