5 use FS::UID qw(adminsuidsetup);
7 &untaint_argv; #what it sounds like (eww)
8 #use vars qw($opt_d $opt_v $opt_p $opt_a $opt_s $opt_y);
10 getopts("p:a:d:vsy:", \%opt);
12 my $user = shift or die &usage;
15 use FS::Cron::bill qw(bill);
16 bill(%opt, 'check_freq'=>'1m' );
23 foreach $_ ( $[ .. $#ARGV ) { #untaint @ARGV
24 #$ARGV[$_] =~ /^([\w\-\/]*)$/ || die "Illegal arguement \"$ARGV[$_]\"";
26 $ARGV[$_] =~ /^(.*)$/ || die "Illegal arguement \"$ARGV[$_]\"";
32 die "Usage:\n\n freeside-monthly [ -d 'date' ] user [ custnum custnum ... ]\n";
41 freeside-monthly - Run monthly billing and invoice collection events.
45 freeside-monthly [ -d 'date' ] [ -y days ] [ -p 'payby' ] [ -a agentnum ] [ -s ] [ -v ] user [ custnum custnum ... ]
49 Bills customers and runs invoice collection events, for the alternate monthly
50 event chain. If you have defined monthly event checks, should be run from
53 Bills customers. Searches for customers who are due for billing and calls
54 the bill and collect methods of a cust_main object. See L<FS::cust_main>.
56 -d: Pretend it's 'date'. Date is in any format Date::Parse is happy with,
59 -y: In addition to -d, which specifies an absolute date, the -y switch
60 specifies an offset, in days. For example, "-y 15" would increment the
61 "pretend date" 15 days from whatever was specified by the -d switch
62 (or now, if no -d switch was given).
64 -p: Only process customers with the specified payby (I<CARD>, I<DCRD>, I<CHEK>, I<DCHK>, I<BILL>, I<COMP>, I<LECB>)
66 -a: Only process customers with the specified agentnum
68 -s: re-charge setup fees
72 user: From the mapsecrets file - see config.html from the base documentation
74 custnum: if one or more customer numbers are specified, only bills those
75 customers. Otherwise, bills all customers.
79 In most cases, you would use freeside-daily only and not freeside-monthly.
80 freeside-monthly would only be used in cases where you have events that can
81 only be run once each month, for example, batching invoices to a third-party
88 L<freeside-daily>, L<FS::cust_main>, config.html from the base documentation