4 use vars qw( @ISA $DEBUG $me $conf $money_char );
5 use vars qw( $invoice_lines @buf ); #yuck
6 use Fcntl qw(:flock); #for spool_csv
7 use List::Util qw(min max);
9 use Text::Template 1.20;
11 use String::ShellQuote;
14 use FS::UID qw( datasrc );
15 use FS::Misc qw( send_email send_fax generate_ps do_print );
16 use FS::Record qw( qsearch qsearchs dbh );
17 use FS::cust_main_Mixin;
19 use FS::cust_bill_pkg;
23 use FS::cust_credit_bill;
25 use FS::cust_pay_batch;
26 use FS::cust_bill_event;
28 use FS::cust_bill_pay;
29 use FS::cust_bill_pay_batch;
30 use FS::part_bill_event;
33 @ISA = qw( FS::cust_main_Mixin FS::Record );
36 $me = '[FS::cust_bill]';
38 #ask FS::UID to run this stuff for us later
39 FS::UID->install_callback( sub {
41 $money_char = $conf->config('money_char') || '$';
46 FS::cust_bill - Object methods for cust_bill records
52 $record = new FS::cust_bill \%hash;
53 $record = new FS::cust_bill { 'column' => 'value' };
55 $error = $record->insert;
57 $error = $new_record->replace($old_record);
59 $error = $record->delete;
61 $error = $record->check;
63 ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
65 @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
67 ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
69 @cust_pay_objects = $cust_bill->cust_pay;
71 $tax_amount = $record->tax;
73 @lines = $cust_bill->print_text;
74 @lines = $cust_bill->print_text $time;
78 An FS::cust_bill object represents an invoice; a declaration that a customer
79 owes you money. The specific charges are itemized as B<cust_bill_pkg> records
80 (see L<FS::cust_bill_pkg>). FS::cust_bill inherits from FS::Record. The
81 following fields are currently supported:
85 =item invnum - primary key (assigned automatically for new invoices)
87 =item custnum - customer (see L<FS::cust_main>)
89 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
90 L<Time::Local> and L<Date::Parse> for conversion functions.
92 =item charged - amount of this invoice
94 =item printed - deprecated
96 =item closed - books closed flag, empty or `Y'
106 Creates a new invoice. To add the invoice to the database, see L<"insert">.
107 Invoices are normally created by calling the bill method of a customer object
108 (see L<FS::cust_main>).
112 sub table { 'cust_bill'; }
114 sub cust_linked { $_[0]->cust_main_custnum; }
115 sub cust_unlinked_msg {
117 "WARNING: can't find cust_main.custnum ". $self->custnum.
118 ' (cust_bill.invnum '. $self->invnum. ')';
123 Adds this invoice to the database ("Posts" the invoice). If there is an error,
124 returns the error, otherwise returns false.
128 This method now works but you probably shouldn't use it. Instead, apply a
129 credit against the invoice.
131 Using this method to delete invoices outright is really, really bad. There
132 would be no record you ever posted this invoice, and there are no check to
133 make sure charged = 0 or that there are no associated cust_bill_pkg records.
135 Really, don't use it.
141 return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
142 $self->SUPER::delete(@_);
145 =item replace OLD_RECORD
147 Replaces the OLD_RECORD with this one in the database. If there is an error,
148 returns the error, otherwise returns false.
150 Only printed may be changed. printed is normally updated by calling the
151 collect method of a customer object (see L<FS::cust_main>).
155 #replace can be inherited from Record.pm
157 # replace_check is now the preferred way to #implement replace data checks
158 # (so $object->replace() works without an argument)
161 my( $new, $old ) = ( shift, shift );
162 return "Can't change custnum!" unless $old->custnum == $new->custnum;
163 #return "Can't change _date!" unless $old->_date eq $new->_date;
164 return "Can't change _date!" unless $old->_date == $new->_date;
165 return "Can't change charged!" unless $old->charged == $new->charged
166 || $old->charged == 0;
173 Checks all fields to make sure this is a valid invoice. If there is an error,
174 returns the error, otherwise returns false. Called by the insert and replace
183 $self->ut_numbern('invnum')
184 || $self->ut_number('custnum')
185 || $self->ut_numbern('_date')
186 || $self->ut_money('charged')
187 || $self->ut_numbern('printed')
188 || $self->ut_enum('closed', [ '', 'Y' ])
190 return $error if $error;
192 return "Unknown customer"
193 unless qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
195 $self->_date(time) unless $self->_date;
197 $self->printed(0) if $self->printed eq '';
204 Returns a list consisting of the total previous balance for this customer,
205 followed by the previous outstanding invoices (as FS::cust_bill objects also).
212 my @cust_bill = sort { $a->_date <=> $b->_date }
213 grep { $_->owed != 0 && $_->_date < $self->_date }
214 qsearch( 'cust_bill', { 'custnum' => $self->custnum } )
216 foreach ( @cust_bill ) { $total += $_->owed; }
222 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
228 qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum } );
233 Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
240 my @cust_pkg = map { $_->cust_pkg } $self->cust_bill_pkg;
242 grep { ! $saw{$_->pkgnum}++ } @cust_pkg;
245 =item open_cust_bill_pkg
247 Returns the open line items for this invoice.
249 Note that cust_bill_pkg with both setup and recur fees are returned as two
250 separate line items, each with only one fee.
254 # modeled after cust_main::open_cust_bill
255 sub open_cust_bill_pkg {
258 # grep { $_->owed > 0 } $self->cust_bill_pkg
260 my %other = ( 'recur' => 'setup',
261 'setup' => 'recur', );
263 foreach my $field ( qw( recur setup )) {
264 push @open, map { $_->set( $other{$field}, 0 ); $_; }
265 grep { $_->owed($field) > 0 }
266 $self->cust_bill_pkg;
272 =item cust_bill_event
274 Returns the completed invoice events (see L<FS::cust_bill_event>) for this
279 sub cust_bill_event {
281 qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
287 Returns the customer (see L<FS::cust_main>) for this invoice.
293 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
296 =item cust_suspend_if_balance_over AMOUNT
298 Suspends the customer associated with this invoice if the total amount owed on
299 this invoice and all older invoices is greater than the specified amount.
301 Returns a list: an empty list on success or a list of errors.
305 sub cust_suspend_if_balance_over {
306 my( $self, $amount ) = ( shift, shift );
307 my $cust_main = $self->cust_main;
308 if ( $cust_main->total_owed_date($self->_date) < $amount ) {
311 $cust_main->suspend(@_);
317 Depreciated. See the cust_credited method.
319 #Returns a list consisting of the total previous credited (see
320 #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
321 #outstanding credits (FS::cust_credit objects).
327 croak "FS::cust_bill->cust_credit depreciated; see ".
328 "FS::cust_bill->cust_credit_bill";
331 #my @cust_credit = sort { $a->_date <=> $b->_date }
332 # grep { $_->credited != 0 && $_->_date < $self->_date }
333 # qsearch('cust_credit', { 'custnum' => $self->custnum } )
335 #foreach (@cust_credit) { $total += $_->credited; }
336 #$total, @cust_credit;
341 Depreciated. See the cust_bill_pay method.
343 #Returns all payments (see L<FS::cust_pay>) for this invoice.
349 croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
351 #sort { $a->_date <=> $b->_date }
352 # qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
358 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
364 sort { $a->_date <=> $b->_date }
365 qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
370 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
376 sort { $a->_date <=> $b->_date }
377 qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
383 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
390 my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
392 foreach (@taxlines) { $total += $_->setup; }
398 Returns the amount owed (still outstanding) on this invoice, which is charged
399 minus all payment applications (see L<FS::cust_bill_pay>) and credit
400 applications (see L<FS::cust_credit_bill>).
406 my $balance = $self->charged;
407 $balance -= $_->amount foreach ( $self->cust_bill_pay );
408 $balance -= $_->amount foreach ( $self->cust_credited );
409 $balance = sprintf( "%.2f", $balance);
410 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
414 =item apply_payments_and_credits
418 sub apply_payments_and_credits {
421 local $SIG{HUP} = 'IGNORE';
422 local $SIG{INT} = 'IGNORE';
423 local $SIG{QUIT} = 'IGNORE';
424 local $SIG{TERM} = 'IGNORE';
425 local $SIG{TSTP} = 'IGNORE';
426 local $SIG{PIPE} = 'IGNORE';
428 my $oldAutoCommit = $FS::UID::AutoCommit;
429 local $FS::UID::AutoCommit = 0;
432 $self->select_for_update; #mutex
434 my @payments = grep { $_->unapplied > 0 } $self->cust_main->cust_pay;
435 my @credits = grep { $_->credited > 0 } $self->cust_main->cust_credit;
437 while ( $self->owed > 0 and ( @payments || @credits ) ) {
440 if ( @payments && @credits ) {
442 #decide which goes first by weight of top (unapplied) line item
444 my @open_lineitems = $self->open_cust_bill_pkg;
447 max( map { $_->part_pkg->pay_weight || 0 }
452 my $max_credit_weight =
453 max( map { $_->part_pkg->credit_weight || 0 }
459 #if both are the same... payments first? it has to be something
460 if ( $max_pay_weight >= $max_credit_weight ) {
466 } elsif ( @payments ) {
468 } elsif ( @credits ) {
471 die "guru meditation #12 and 35";
474 if ( $app eq 'pay' ) {
476 my $payment = shift @payments;
478 $app = new FS::cust_bill_pay {
479 'paynum' => $payment->paynum,
480 'amount' => sprintf('%.2f', min( $payment->unapplied, $self->owed ) ),
483 } elsif ( $app eq 'credit' ) {
485 my $credit = shift @credits;
487 $app = new FS::cust_credit_bill {
488 'crednum' => $credit->crednum,
489 'amount' => sprintf('%.2f', min( $credit->credited, $self->owed ) ),
493 die "guru meditation #12 and 35";
496 $app->invnum( $self->invnum );
498 my $error = $app->insert;
500 $dbh->rollback if $oldAutoCommit;
501 return "Error inserting ". $app->table. " record: $error";
503 die $error if $error;
507 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
512 =item generate_email PARAMHASH
514 PARAMHASH can contain the following:
518 =item from => sender address, required
520 =item tempate => alternate template name, optional
522 =item print_text => text attachment arrayref, optional
524 =item subject => email subject, optional
528 Returns an argument list to be passed to L<FS::Misc::send_email>.
539 my $me = '[FS::cust_bill::generate_email]';
542 'from' => $args{'from'},
543 'subject' => (($args{'subject'}) ? $args{'subject'} : 'Invoice'),
546 if (ref($args{'to'}) eq 'ARRAY') {
547 $return{'to'} = $args{'to'};
549 $return{'to'} = [ grep { $_ !~ /^(POST|FAX)$/ }
550 $self->cust_main->invoicing_list
554 if ( $conf->exists('invoice_html') ) {
556 warn "$me creating HTML/text multipart message"
559 $return{'nobody'} = 1;
561 my $alternative = build MIME::Entity
562 'Type' => 'multipart/alternative',
563 'Encoding' => '7bit',
564 'Disposition' => 'inline'
568 if ( $conf->exists('invoice_email_pdf')
569 and scalar($conf->config('invoice_email_pdf_note')) ) {
571 warn "$me using 'invoice_email_pdf_note' in multipart message"
573 $data = [ map { $_ . "\n" }
574 $conf->config('invoice_email_pdf_note')
579 warn "$me not using 'invoice_email_pdf_note' in multipart message"
581 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
582 $data = $args{'print_text'};
584 $data = [ $self->print_text('', $args{'template'}) ];
589 $alternative->attach(
590 'Type' => 'text/plain',
591 #'Encoding' => 'quoted-printable',
592 'Encoding' => '7bit',
594 'Disposition' => 'inline',
597 $args{'from'} =~ /\@([\w\.\-]+)/;
598 my $from = $1 || 'example.com';
599 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
601 my $path = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
603 if ( defined($args{'template'}) && length($args{'template'})
604 && -e "$path/logo_". $args{'template'}. ".png"
607 $file = "$path/logo_". $args{'template'}. ".png";
609 $file = "$path/logo.png";
612 my $image = build MIME::Entity
613 'Type' => 'image/png',
614 'Encoding' => 'base64',
616 'Filename' => 'logo.png',
617 'Content-ID' => "<$content_id>",
620 $alternative->attach(
621 'Type' => 'text/html',
622 'Encoding' => 'quoted-printable',
623 'Data' => [ '<html>',
626 ' '. encode_entities($return{'subject'}),
629 ' <body bgcolor="#e8e8e8">',
630 $self->print_html('', $args{'template'}, $content_id),
634 'Disposition' => 'inline',
635 #'Filename' => 'invoice.pdf',
638 if ( $conf->exists('invoice_email_pdf') ) {
643 # multipart/alternative
649 my $related = build MIME::Entity 'Type' => 'multipart/related',
650 'Encoding' => '7bit';
652 #false laziness w/Misc::send_email
653 $related->head->replace('Content-type',
655 '; boundary="'. $related->head->multipart_boundary. '"'.
656 '; type=multipart/alternative'
659 $related->add_part($alternative);
661 $related->add_part($image);
663 my $pdf = build MIME::Entity $self->mimebuild_pdf('', $args{'template'});
665 $return{'mimeparts'} = [ $related, $pdf ];
669 #no other attachment:
671 # multipart/alternative
676 $return{'content-type'} = 'multipart/related';
677 $return{'mimeparts'} = [ $alternative, $image ];
678 $return{'type'} = 'multipart/alternative'; #Content-Type of first part...
679 #$return{'disposition'} = 'inline';
685 if ( $conf->exists('invoice_email_pdf') ) {
686 warn "$me creating PDF attachment"
689 #mime parts arguments a la MIME::Entity->build().
690 $return{'mimeparts'} = [
691 { $self->mimebuild_pdf('', $args{'template'}) }
695 if ( $conf->exists('invoice_email_pdf')
696 and scalar($conf->config('invoice_email_pdf_note')) ) {
698 warn "$me using 'invoice_email_pdf_note'"
700 $return{'body'} = [ map { $_ . "\n" }
701 $conf->config('invoice_email_pdf_note')
706 warn "$me not using 'invoice_email_pdf_note'"
708 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
709 $return{'body'} = $args{'print_text'};
711 $return{'body'} = [ $self->print_text('', $args{'template'}) ];
724 Returns a list suitable for passing to MIME::Entity->build(), representing
725 this invoice as PDF attachment.
732 'Type' => 'application/pdf',
733 'Encoding' => 'base64',
734 'Data' => [ $self->print_pdf(@_) ],
735 'Disposition' => 'attachment',
736 'Filename' => 'invoice.pdf',
740 =item send [ TEMPLATENAME [ , AGENTNUM [ , INVOICE_FROM ] ] ]
742 Sends this invoice to the destinations configured for this customer: sends
743 email, prints and/or faxes. See L<FS::cust_main_invoice>.
745 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
747 AGENTNUM, if specified, means that this invoice will only be sent for customers
748 of the specified agent or agent(s). AGENTNUM can be a scalar agentnum (for a
749 single agent) or an arrayref of agentnums.
751 INVOICE_FROM, if specified, overrides the default email invoice From: address.
758 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
759 or die "invalid invoice number: " . $opt{invnum};
761 my @args = ( $opt{template}, $opt{agentnum} );
762 push @args, $opt{invoice_from}
763 if exists($opt{invoice_from}) && $opt{invoice_from};
765 my $error = $self->send( @args );
766 die $error if $error;
772 my $template = scalar(@_) ? shift : '';
773 if ( scalar(@_) && $_[0] ) {
774 my $agentnums = ref($_[0]) ? shift : [ shift ];
775 return 'N/A' unless grep { $_ == $self->cust_main->agentnum } @$agentnums;
781 : ( $self->_agent_invoice_from || $conf->config('invoice_from') );
783 my @invoicing_list = $self->cust_main->invoicing_list;
785 $self->email($template, $invoice_from)
786 if grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list;
788 $self->print($template)
789 if grep { $_ eq 'POST' } @invoicing_list; #postal
791 $self->fax($template)
792 if grep { $_ eq 'FAX' } @invoicing_list; #fax
798 =item email [ TEMPLATENAME [ , INVOICE_FROM ] ]
802 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
804 INVOICE_FROM, if specified, overrides the default email invoice From: address.
808 sub queueable_email {
811 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
812 or die "invalid invoice number: " . $opt{invnum};
814 my @args = ( $opt{template} );
815 push @args, $opt{invoice_from}
816 if exists($opt{invoice_from}) && $opt{invoice_from};
818 my $error = $self->email( @args );
819 die $error if $error;
825 my $template = scalar(@_) ? shift : '';
829 : ( $self->_agent_invoice_from || $conf->config('invoice_from') );
831 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
832 $self->cust_main->invoicing_list;
834 #better to notify this person than silence
835 @invoicing_list = ($invoice_from) unless @invoicing_list;
837 my $error = send_email(
838 $self->generate_email(
839 'from' => $invoice_from,
840 'to' => [ grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list ],
841 'template' => $template,
844 die "can't email invoice: $error\n" if $error;
845 #die "$error\n" if $error;
849 =item lpr_data [ TEMPLATENAME ]
851 Returns the postscript or plaintext for this invoice as an arrayref.
853 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
858 my( $self, $template) = @_;
859 $conf->exists('invoice_latex')
860 ? [ $self->print_ps('', $template) ]
861 : [ $self->print_text('', $template) ];
864 =item print [ TEMPLATENAME ]
868 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
874 my $template = scalar(@_) ? shift : '';
876 do_print $self->lpr_data($template);
879 =item fax [ TEMPLATENAME ]
883 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
889 my $template = scalar(@_) ? shift : '';
891 die 'FAX invoice destination not (yet?) supported with plain text invoices.'
892 unless $conf->exists('invoice_latex');
894 my $dialstring = $self->cust_main->getfield('fax');
897 my $error = send_fax( 'docdata' => $self->lpr_data($template),
898 'dialstring' => $dialstring,
900 die $error if $error;
904 =item send_if_newest [ TEMPLATENAME [ , AGENTNUM [ , INVOICE_FROM ] ] ]
906 Like B<send>, but only sends the invoice if it is the newest open invoice for
916 grep { $_->owed > 0 }
917 qsearch('cust_bill', {
918 'custnum' => $self->custnum,
919 #'_date' => { op=>'>', value=>$self->_date },
920 'invnum' => { op=>'>', value=>$self->invnum },
927 =item send_csv OPTION => VALUE, ...
929 Sends invoice as a CSV data-file to a remote host with the specified protocol.
933 protocol - currently only "ftp"
939 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
940 and YYMMDDHHMMSS is a timestamp.
942 See L</print_csv> for a description of the output format.
947 my($self, %opt) = @_;
951 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
952 mkdir $spooldir, 0700 unless -d $spooldir;
954 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
955 my $file = "$spooldir/$tracctnum.csv";
957 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
959 open(CSV, ">$file") or die "can't open $file: $!";
967 if ( $opt{protocol} eq 'ftp' ) {
968 eval "use Net::FTP;";
970 $net = Net::FTP->new($opt{server}) or die @$;
972 die "unknown protocol: $opt{protocol}";
975 $net->login( $opt{username}, $opt{password} )
976 or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
978 $net->binary or die "can't set binary mode";
980 $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
982 $net->put($file) or die "can't put $file: $!";
992 Spools CSV invoice data.
998 =item format - 'default' or 'billco'
1000 =item dest - if set (to POST, EMAIL or FAX), only sends spools invoices if the customer has the corresponding invoice destinations set (see L<FS::cust_main_invoice>).
1002 =item agent_spools - if set to a true value, will spool to per-agent files rather than a single global file
1004 =item balanceover - if set, only spools the invoice if the total amount owed on this invoice and all older invoices is greater than the specified amount.
1011 my($self, %opt) = @_;
1013 my $cust_main = $self->cust_main;
1015 if ( $opt{'dest'} ) {
1016 my %invoicing_list = map { /^(POST|FAX)$/ or 'EMAIL' =~ /^(.*)$/; $1 => 1 }
1017 $cust_main->invoicing_list;
1018 return 'N/A' unless $invoicing_list{$opt{'dest'}}
1019 || ! keys %invoicing_list;
1022 if ( $opt{'balanceover'} ) {
1024 if $cust_main->total_owed_date($self->_date) < $opt{'balanceover'};
1027 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1028 mkdir $spooldir, 0700 unless -d $spooldir;
1030 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1034 ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1035 ( lc($opt{'format'}) eq 'billco' ? '-header' : '' ) .
1038 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1040 open(CSV, ">>$file") or die "can't open $file: $!";
1041 flock(CSV, LOCK_EX);
1046 if ( lc($opt{'format'}) eq 'billco' ) {
1048 flock(CSV, LOCK_UN);
1053 ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1056 open(CSV,">>$file") or die "can't open $file: $!";
1057 flock(CSV, LOCK_EX);
1063 flock(CSV, LOCK_UN);
1070 =item print_csv OPTION => VALUE, ...
1072 Returns CSV data for this invoice.
1076 format - 'default' or 'billco'
1078 Returns a list consisting of two scalars. The first is a single line of CSV
1079 header information for this invoice. The second is one or more lines of CSV
1080 detail information for this invoice.
1082 If I<format> is not specified or "default", the fields of the CSV file are as
1085 record_type, invnum, custnum, _date, charged, first, last, company, address1, address2, city, state, zip, country, pkg, setup, recur, sdate, edate
1089 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
1091 B<record_type> is C<cust_bill> for the initial header line only. The
1092 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
1093 fields are filled in.
1095 B<record_type> is C<cust_bill_pkg> for detail lines. Only the first two fields
1096 (B<record_type> and B<invnum>) and the last five fields (B<pkg> through B<edate>)
1099 =item invnum - invoice number
1101 =item custnum - customer number
1103 =item _date - invoice date
1105 =item charged - total invoice amount
1107 =item first - customer first name
1109 =item last - customer first name
1111 =item company - company name
1113 =item address1 - address line 1
1115 =item address2 - address line 1
1125 =item pkg - line item description
1127 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
1129 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
1131 =item sdate - start date for recurring fee
1133 =item edate - end date for recurring fee
1137 If I<format> is "billco", the fields of the header CSV file are as follows:
1139 +-------------------------------------------------------------------+
1140 | FORMAT HEADER FILE |
1141 |-------------------------------------------------------------------|
1142 | Field | Description | Name | Type | Width |
1143 | 1 | N/A-Leave Empty | RC | CHAR | 2 |
1144 | 2 | N/A-Leave Empty | CUSTID | CHAR | 15 |
1145 | 3 | Transaction Account No | TRACCTNUM | CHAR | 15 |
1146 | 4 | Transaction Invoice No | TRINVOICE | CHAR | 15 |
1147 | 5 | Transaction Zip Code | TRZIP | CHAR | 5 |
1148 | 6 | Transaction Company Bill To | TRCOMPANY | CHAR | 30 |
1149 | 7 | Transaction Contact Bill To | TRNAME | CHAR | 30 |
1150 | 8 | Additional Address Unit Info | TRADDR1 | CHAR | 30 |
1151 | 9 | Bill To Street Address | TRADDR2 | CHAR | 30 |
1152 | 10 | Ancillary Billing Information | TRADDR3 | CHAR | 30 |
1153 | 11 | Transaction City Bill To | TRCITY | CHAR | 20 |
1154 | 12 | Transaction State Bill To | TRSTATE | CHAR | 2 |
1155 | 13 | Bill Cycle Close Date | CLOSEDATE | CHAR | 10 |
1156 | 14 | Bill Due Date | DUEDATE | CHAR | 10 |
1157 | 15 | Previous Balance | BALFWD | NUM* | 9 |
1158 | 16 | Pmt/CR Applied | CREDAPPLY | NUM* | 9 |
1159 | 17 | Total Current Charges | CURRENTCHG | NUM* | 9 |
1160 | 18 | Total Amt Due | TOTALDUE | NUM* | 9 |
1161 | 19 | Total Amt Due | AMTDUE | NUM* | 9 |
1162 | 20 | 30 Day Aging | AMT30 | NUM* | 9 |
1163 | 21 | 60 Day Aging | AMT60 | NUM* | 9 |
1164 | 22 | 90 Day Aging | AMT90 | NUM* | 9 |
1165 | 23 | Y/N | AGESWITCH | CHAR | 1 |
1166 | 24 | Remittance automation | SCANLINE | CHAR | 100 |
1167 | 25 | Total Taxes & Fees | TAXTOT | NUM* | 9 |
1168 | 26 | Customer Reference Number | CUSTREF | CHAR | 15 |
1169 | 27 | Federal Tax*** | FEDTAX | NUM* | 9 |
1170 | 28 | State Tax*** | STATETAX | NUM* | 9 |
1171 | 29 | Other Taxes & Fees*** | OTHERTAX | NUM* | 9 |
1172 +-------+-------------------------------+------------+------+-------+
1174 If I<format> is "billco", the fields of the detail CSV file are as follows:
1176 FORMAT FOR DETAIL FILE
1178 Field | Description | Name | Type | Width
1179 1 | N/A-Leave Empty | RC | CHAR | 2
1180 2 | N/A-Leave Empty | CUSTID | CHAR | 15
1181 3 | Account Number | TRACCTNUM | CHAR | 15
1182 4 | Invoice Number | TRINVOICE | CHAR | 15
1183 5 | Line Sequence (sort order) | LINESEQ | NUM | 6
1184 6 | Transaction Detail | DETAILS | CHAR | 100
1185 7 | Amount | AMT | NUM* | 9
1186 8 | Line Format Control** | LNCTRL | CHAR | 2
1187 9 | Grouping Code | GROUP | CHAR | 2
1188 10 | User Defined | ACCT CODE | CHAR | 15
1193 my($self, %opt) = @_;
1195 eval "use Text::CSV_XS";
1198 my $cust_main = $self->cust_main;
1200 my $csv = Text::CSV_XS->new({'always_quote'=>1});
1202 if ( lc($opt{'format'}) eq 'billco' ) {
1205 $taxtotal += $_->{'amount'} foreach $self->_items_tax;
1208 if ( $conf->exists('invoice_default_terms')
1209 && $conf->config('invoice_default_terms')=~ /^\s*Net\s*(\d+)\s*$/ ) {
1210 $duedate = time2str("%m/%d/%Y", $self->_date + ($1*86400) );
1213 my( $previous_balance, @unused ) = $self->previous; #previous balance
1215 my $pmt_cr_applied = 0;
1216 $pmt_cr_applied += $_->{'amount'}
1217 foreach ( $self->_items_payments, $self->_items_credits ) ;
1219 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
1222 '', # 1 | N/A-Leave Empty CHAR 2
1223 '', # 2 | N/A-Leave Empty CHAR 15
1224 $opt{'tracctnum'}, # 3 | Transaction Account No CHAR 15
1225 $self->invnum, # 4 | Transaction Invoice No CHAR 15
1226 $cust_main->zip, # 5 | Transaction Zip Code CHAR 5
1227 $cust_main->company, # 6 | Transaction Company Bill To CHAR 30
1228 #$cust_main->payname, # 7 | Transaction Contact Bill To CHAR 30
1229 $cust_main->contact, # 7 | Transaction Contact Bill To CHAR 30
1230 $cust_main->address2, # 8 | Additional Address Unit Info CHAR 30
1231 $cust_main->address1, # 9 | Bill To Street Address CHAR 30
1232 '', # 10 | Ancillary Billing Information CHAR 30
1233 $cust_main->city, # 11 | Transaction City Bill To CHAR 20
1234 $cust_main->state, # 12 | Transaction State Bill To CHAR 2
1237 time2str("%m/%d/%Y", $self->_date), # 13 | Bill Cycle Close Date CHAR 10
1240 $duedate, # 14 | Bill Due Date CHAR 10
1242 $previous_balance, # 15 | Previous Balance NUM* 9
1243 $pmt_cr_applied, # 16 | Pmt/CR Applied NUM* 9
1244 sprintf("%.2f", $self->charged), # 17 | Total Current Charges NUM* 9
1245 $totaldue, # 18 | Total Amt Due NUM* 9
1246 $totaldue, # 19 | Total Amt Due NUM* 9
1247 '', # 20 | 30 Day Aging NUM* 9
1248 '', # 21 | 60 Day Aging NUM* 9
1249 '', # 22 | 90 Day Aging NUM* 9
1250 'N', # 23 | Y/N CHAR 1
1251 '', # 24 | Remittance automation CHAR 100
1252 $taxtotal, # 25 | Total Taxes & Fees NUM* 9
1253 $self->custnum, # 26 | Customer Reference Number CHAR 15
1254 '0', # 27 | Federal Tax*** NUM* 9
1255 sprintf("%.2f", $taxtotal), # 28 | State Tax*** NUM* 9
1256 '0', # 29 | Other Taxes & Fees*** NUM* 9
1265 time2str("%x", $self->_date),
1266 sprintf("%.2f", $self->charged),
1267 ( map { $cust_main->getfield($_) }
1268 qw( first last company address1 address2 city state zip country ) ),
1270 ) or die "can't create csv";
1273 my $header = $csv->string. "\n";
1276 if ( lc($opt{'format'}) eq 'billco' ) {
1279 foreach my $item ( $self->_items_pkg ) {
1282 '', # 1 | N/A-Leave Empty CHAR 2
1283 '', # 2 | N/A-Leave Empty CHAR 15
1284 $opt{'tracctnum'}, # 3 | Account Number CHAR 15
1285 $self->invnum, # 4 | Invoice Number CHAR 15
1286 $lineseq++, # 5 | Line Sequence (sort order) NUM 6
1287 $item->{'description'}, # 6 | Transaction Detail CHAR 100
1288 $item->{'amount'}, # 7 | Amount NUM* 9
1289 '', # 8 | Line Format Control** CHAR 2
1290 '', # 9 | Grouping Code CHAR 2
1291 '', # 10 | User Defined CHAR 15
1294 $detail .= $csv->string. "\n";
1300 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1302 my($pkg, $setup, $recur, $sdate, $edate);
1303 if ( $cust_bill_pkg->pkgnum ) {
1305 ($pkg, $setup, $recur, $sdate, $edate) = (
1306 $cust_bill_pkg->cust_pkg->part_pkg->pkg,
1307 ( $cust_bill_pkg->setup != 0
1308 ? sprintf("%.2f", $cust_bill_pkg->setup )
1310 ( $cust_bill_pkg->recur != 0
1311 ? sprintf("%.2f", $cust_bill_pkg->recur )
1313 ( $cust_bill_pkg->sdate
1314 ? time2str("%x", $cust_bill_pkg->sdate)
1316 ($cust_bill_pkg->edate
1317 ?time2str("%x", $cust_bill_pkg->edate)
1321 } else { #pkgnum tax
1322 next unless $cust_bill_pkg->setup != 0;
1323 my $itemdesc = defined $cust_bill_pkg->dbdef_table->column('itemdesc')
1324 ? ( $cust_bill_pkg->itemdesc || 'Tax' )
1326 ($pkg, $setup, $recur, $sdate, $edate) =
1327 ( $itemdesc, sprintf("%10.2f",$cust_bill_pkg->setup), '', '', '' );
1333 ( map { '' } (1..11) ),
1334 ($pkg, $setup, $recur, $sdate, $edate)
1335 ) or die "can't create csv";
1337 $detail .= $csv->string. "\n";
1343 ( $header, $detail );
1349 Pays this invoice with a compliemntary payment. If there is an error,
1350 returns the error, otherwise returns false.
1356 my $cust_pay = new FS::cust_pay ( {
1357 'invnum' => $self->invnum,
1358 'paid' => $self->owed,
1361 'payinfo' => $self->cust_main->payinfo,
1369 Attempts to pay this invoice with a credit card payment via a
1370 Business::OnlinePayment realtime gateway. See
1371 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1372 for supported processors.
1378 $self->realtime_bop( 'CC', @_ );
1383 Attempts to pay this invoice with an electronic check (ACH) payment via a
1384 Business::OnlinePayment realtime gateway. See
1385 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1386 for supported processors.
1392 $self->realtime_bop( 'ECHECK', @_ );
1397 Attempts to pay this invoice with phone bill (LEC) payment via a
1398 Business::OnlinePayment realtime gateway. See
1399 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1400 for supported processors.
1406 $self->realtime_bop( 'LEC', @_ );
1410 my( $self, $method ) = @_;
1412 my $cust_main = $self->cust_main;
1413 my $balance = $cust_main->balance;
1414 my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
1415 $amount = sprintf("%.2f", $amount);
1416 return "not run (balance $balance)" unless $amount > 0;
1418 my $description = 'Internet Services';
1419 if ( $conf->exists('business-onlinepayment-description') ) {
1420 my $dtempl = $conf->config('business-onlinepayment-description');
1422 my $agent_obj = $cust_main->agent
1423 or die "can't retreive agent for $cust_main (agentnum ".
1424 $cust_main->agentnum. ")";
1425 my $agent = $agent_obj->agent;
1426 my $pkgs = join(', ',
1427 map { $_->cust_pkg->part_pkg->pkg }
1428 grep { $_->pkgnum } $self->cust_bill_pkg
1430 $description = eval qq("$dtempl");
1433 $cust_main->realtime_bop($method, $amount,
1434 'description' => $description,
1435 'invnum' => $self->invnum,
1440 =item batch_card OPTION => VALUE...
1442 Adds a payment for this invoice to the pending credit card batch (see
1443 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
1444 runs the payment using a realtime gateway.
1449 my ($self, %options) = @_;
1450 my $cust_main = $self->cust_main;
1452 $options{invnum} = $self->invnum;
1454 $cust_main->batch_card(%options);
1457 sub _agent_template {
1459 $self->cust_main->agent_template;
1462 sub _agent_invoice_from {
1464 $self->cust_main->agent_invoice_from;
1467 =item print_text [ TIME [ , TEMPLATE ] ]
1469 Returns an text invoice, as a list of lines.
1471 TIME an optional value used to control the printing of overdue messages. The
1472 default is now. It isn't the date of the invoice; that's the `_date' field.
1473 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1474 L<Time::Local> and L<Date::Parse> for conversion functions.
1478 #still some false laziness w/_items stuff (and send_csv)
1481 my( $self, $today, $template ) = @_;
1484 # my $invnum = $self->invnum;
1485 my $cust_main = $self->cust_main;
1486 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
1487 unless $cust_main->payname && $cust_main->payby !~ /^(CHEK|DCHK)$/;
1489 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
1490 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
1491 #my $balance_due = $self->owed + $pr_total - $cr_total;
1492 my $balance_due = $self->owed + $pr_total;
1495 #my($description,$amount);
1499 foreach ( @pr_cust_bill ) {
1501 "Previous Balance, Invoice #". $_->invnum.
1502 " (". time2str("%x",$_->_date). ")",
1503 $money_char. sprintf("%10.2f",$_->owed)
1506 if (@pr_cust_bill) {
1507 push @buf,['','-----------'];
1508 push @buf,[ 'Total Previous Balance',
1509 $money_char. sprintf("%10.2f",$pr_total ) ];
1514 foreach my $cust_bill_pkg (
1515 ( grep { $_->pkgnum } $self->cust_bill_pkg ), #packages first
1516 ( grep { ! $_->pkgnum } $self->cust_bill_pkg ), #then taxes
1519 my $desc = $cust_bill_pkg->desc;
1521 if ( $cust_bill_pkg->pkgnum > 0 ) {
1523 if ( $cust_bill_pkg->setup != 0 ) {
1524 my $description = $desc;
1525 $description .= ' Setup' if $cust_bill_pkg->recur != 0;
1526 push @buf, [ $description,
1527 $money_char. sprintf("%10.2f", $cust_bill_pkg->setup) ];
1529 map { [ " ". $_->[0]. ": ". $_->[1], '' ] }
1530 $cust_bill_pkg->cust_pkg->h_labels($self->_date);
1533 if ( $cust_bill_pkg->recur != 0 ) {
1536 ( $conf->exists('disable_line_item_date_ranges')
1538 : " (" . time2str("%x", $cust_bill_pkg->sdate) . " - " .
1539 time2str("%x", $cust_bill_pkg->edate) . ")"
1541 $money_char. sprintf("%10.2f", $cust_bill_pkg->recur)
1544 map { [ " ". $_->[0]. ": ". $_->[1], '' ] }
1545 $cust_bill_pkg->cust_pkg->h_labels( $cust_bill_pkg->edate,
1546 $cust_bill_pkg->sdate );
1549 push @buf, map { [ " $_", '' ] } $cust_bill_pkg->details;
1551 } else { #pkgnum tax or one-shot line item
1553 if ( $cust_bill_pkg->setup != 0 ) {
1555 $money_char. sprintf("%10.2f", $cust_bill_pkg->setup) ];
1557 if ( $cust_bill_pkg->recur != 0 ) {
1558 push @buf, [ "$desc (". time2str("%x", $cust_bill_pkg->sdate). " - "
1559 . time2str("%x", $cust_bill_pkg->edate). ")",
1560 $money_char. sprintf("%10.2f", $cust_bill_pkg->recur)
1568 push @buf,['','-----------'];
1569 push @buf,['Total New Charges',
1570 $money_char. sprintf("%10.2f",$self->charged) ];
1573 push @buf,['','-----------'];
1574 push @buf,['Total Charges',
1575 $money_char. sprintf("%10.2f",$self->charged + $pr_total) ];
1579 foreach ( $self->cust_credited ) {
1581 #something more elaborate if $_->amount ne $_->cust_credit->credited ?
1583 my $reason = substr($_->cust_credit->reason,0,32);
1584 $reason .= '...' if length($reason) < length($_->cust_credit->reason);
1585 $reason = " ($reason) " if $reason;
1587 "Credit #". $_->crednum. " (". time2str("%x",$_->cust_credit->_date) .")".
1589 $money_char. sprintf("%10.2f",$_->amount)
1592 #foreach ( @cr_cust_credit ) {
1594 # "Credit #". $_->crednum. " (" . time2str("%x",$_->_date) .")",
1595 # $money_char. sprintf("%10.2f",$_->credited)
1599 #get & print payments
1600 foreach ( $self->cust_bill_pay ) {
1602 #something more elaborate if $_->amount ne ->cust_pay->paid ?
1605 "Payment received ". time2str("%x",$_->cust_pay->_date ),
1606 $money_char. sprintf("%10.2f",$_->amount )
1611 my $balance_due_msg = $self->balance_due_msg;
1613 push @buf,['','-----------'];
1614 push @buf,[$balance_due_msg, $money_char.
1615 sprintf("%10.2f", $balance_due ) ];
1617 #create the template
1618 $template ||= $self->_agent_template;
1619 my $templatefile = 'invoice_template';
1620 $templatefile .= "_$template" if length($template);
1621 my @invoice_template = $conf->config($templatefile)
1622 or die "cannot load config file $templatefile";
1625 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1626 /invoice_lines\((\d*)\)/;
1627 $invoice_lines += $1 || scalar(@buf);
1630 die "no invoice_lines() functions in template?" unless $wasfunc;
1631 my $invoice_template = new Text::Template (
1633 SOURCE => [ map "$_\n", @invoice_template ],
1634 ) or die "can't create new Text::Template object: $Text::Template::ERROR";
1635 $invoice_template->compile()
1636 or die "can't compile template: $Text::Template::ERROR";
1638 #setup template variables
1639 package FS::cust_bill::_template; #!
1640 use vars qw( $custnum $invnum $date $agent @address $overdue
1641 $page $total_pages @buf );
1643 $custnum = $self->custnum;
1644 $invnum = $self->invnum;
1645 $date = $self->_date;
1646 $agent = $self->cust_main->agent->agent;
1649 if ( $FS::cust_bill::invoice_lines ) {
1651 int( scalar(@FS::cust_bill::buf) / $FS::cust_bill::invoice_lines );
1653 if scalar(@FS::cust_bill::buf) % $FS::cust_bill::invoice_lines;
1658 #format address (variable for the template)
1660 @address = ( '', '', '', '', '', '' );
1661 package FS::cust_bill; #!
1662 $FS::cust_bill::_template::address[$l++] =
1663 $cust_main->payname.
1664 ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
1665 ? " (P.O. #". $cust_main->payinfo. ")"
1669 $FS::cust_bill::_template::address[$l++] = $cust_main->company
1670 if $cust_main->company;
1671 $FS::cust_bill::_template::address[$l++] = $cust_main->address1;
1672 $FS::cust_bill::_template::address[$l++] = $cust_main->address2
1673 if $cust_main->address2;
1674 $FS::cust_bill::_template::address[$l++] =
1675 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
1677 my $countrydefault = $conf->config('countrydefault') || 'US';
1678 $FS::cust_bill::_template::address[$l++] = code2country($cust_main->country)
1679 unless $cust_main->country eq $countrydefault;
1681 # #overdue? (variable for the template)
1682 # $FS::cust_bill::_template::overdue = (
1684 # && $today > $self->_date
1685 ## && $self->printed > 1
1686 # && $self->printed > 0
1689 #and subroutine for the template
1690 sub FS::cust_bill::_template::invoice_lines {
1691 my $lines = shift || scalar(@buf);
1693 scalar(@buf) ? shift @buf : [ '', '' ];
1699 $FS::cust_bill::_template::page = 1;
1703 push @collect, split("\n",
1704 $invoice_template->fill_in( PACKAGE => 'FS::cust_bill::_template' )
1706 $FS::cust_bill::_template::page++;
1709 map "$_\n", @collect;
1713 =item print_latex [ TIME [ , TEMPLATE ] ]
1715 Internal method - returns a filename of a filled-in LaTeX template for this
1716 invoice (Note: add ".tex" to get the actual filename).
1718 See print_ps and print_pdf for methods that return PostScript and PDF output.
1720 TIME an optional value used to control the printing of overdue messages. The
1721 default is now. It isn't the date of the invoice; that's the `_date' field.
1722 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1723 L<Time::Local> and L<Date::Parse> for conversion functions.
1727 #still some false laziness w/print_text and print_html (and send_csv) (mostly print_text should use _items stuff though)
1730 my( $self, $today, $template ) = @_;
1732 warn "FS::cust_bill::print_latex called on $self with suffix $template\n"
1735 my $cust_main = $self->cust_main;
1736 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
1737 unless $cust_main->payname && $cust_main->payby !~ /^(CHEK|DCHK)$/;
1739 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
1740 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
1741 #my $balance_due = $self->owed + $pr_total - $cr_total;
1742 my $balance_due = $self->owed + $pr_total;
1744 #create the template
1745 $template ||= $self->_agent_template;
1746 my $templatefile = 'invoice_latex';
1747 my $suffix = length($template) ? "_$template" : '';
1748 $templatefile .= $suffix;
1749 my @invoice_template = map "$_\n", $conf->config($templatefile)
1750 or die "cannot load config file $templatefile";
1752 my($format, $text_template);
1753 if ( grep { /^%%Detail/ } @invoice_template ) {
1754 #change this to a die when the old code is removed
1755 warn "old-style invoice template $templatefile; ".
1756 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
1759 $format = 'Text::Template';
1760 $text_template = new Text::Template(
1762 SOURCE => \@invoice_template,
1763 DELIMITERS => [ '[@--', '--@]' ],
1766 $text_template->compile()
1767 or die 'While compiling ' . $templatefile . ': ' . $Text::Template::ERROR;
1771 if ( length($conf->config_orbase('invoice_latexreturnaddress', $template)) ) {
1772 $returnaddress = join("\n",
1773 $conf->config_orbase('invoice_latexreturnaddress', $template)
1776 $returnaddress = '~';
1779 my %invoice_data = (
1780 'custnum' => $self->custnum,
1781 'invnum' => $self->invnum,
1782 'date' => time2str('%b %o, %Y', $self->_date),
1783 'today' => time2str('%b %o, %Y', $today),
1784 'agent' => _latex_escape($cust_main->agent->agent),
1785 'payname' => _latex_escape($cust_main->payname),
1786 'company' => _latex_escape($cust_main->company),
1787 'address1' => _latex_escape($cust_main->address1),
1788 'address2' => _latex_escape($cust_main->address2),
1789 'city' => _latex_escape($cust_main->city),
1790 'state' => _latex_escape($cust_main->state),
1791 'zip' => _latex_escape($cust_main->zip),
1792 'footer' => join("\n", $conf->config_orbase('invoice_latexfooter', $template) ),
1793 'smallfooter' => join("\n", $conf->config_orbase('invoice_latexsmallfooter', $template) ),
1794 'returnaddress' => $returnaddress,
1796 'terms' => $conf->config('invoice_default_terms') || 'Payable upon receipt',
1797 #'notes' => join("\n", $conf->config('invoice_latexnotes') ),
1798 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
1801 my $countrydefault = $conf->config('countrydefault') || 'US';
1802 if ( $cust_main->country eq $countrydefault ) {
1803 $invoice_data{'country'} = '';
1805 $invoice_data{'country'} = _latex_escape(code2country($cust_main->country));
1808 $invoice_data{'notes'} =
1810 # #do variable substitutions in notes
1811 # map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1812 $conf->config_orbase('invoice_latexnotes', $template)
1814 warn "invoice notes: ". $invoice_data{'notes'}. "\n"
1817 $invoice_data{'footer'} =~ s/\n+$//;
1818 $invoice_data{'smallfooter'} =~ s/\n+$//;
1819 $invoice_data{'notes'} =~ s/\n+$//;
1821 $invoice_data{'po_line'} =
1822 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
1823 ? _latex_escape("Purchase Order #". $cust_main->payinfo)
1827 if ( $format eq 'old' ) {
1830 my @total_item = ();
1831 while ( @invoice_template ) {
1832 my $line = shift @invoice_template;
1834 if ( $line =~ /^%%Detail\s*$/ ) {
1836 while ( ( my $line_item_line = shift @invoice_template )
1837 !~ /^%%EndDetail\s*$/ ) {
1838 push @line_item, $line_item_line;
1840 foreach my $line_item ( $self->_items ) {
1841 #foreach my $line_item ( $self->_items_pkg ) {
1842 $invoice_data{'ref'} = $line_item->{'pkgnum'};
1843 $invoice_data{'description'} =
1844 _latex_escape($line_item->{'description'});
1845 if ( exists $line_item->{'ext_description'} ) {
1846 $invoice_data{'description'} .=
1847 "\\tabularnewline\n~~".
1848 join( "\\tabularnewline\n~~",
1849 map _latex_escape($_), @{$line_item->{'ext_description'}}
1852 $invoice_data{'amount'} = $line_item->{'amount'};
1853 $invoice_data{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
1855 map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b } @line_item;
1858 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1860 while ( ( my $total_item_line = shift @invoice_template )
1861 !~ /^%%EndTotalDetails\s*$/ ) {
1862 push @total_item, $total_item_line;
1865 my @total_fill = ();
1868 foreach my $tax ( $self->_items_tax ) {
1869 $invoice_data{'total_item'} = _latex_escape($tax->{'description'});
1870 $taxtotal += $tax->{'amount'};
1871 $invoice_data{'total_amount'} = '\dollar '. $tax->{'amount'};
1873 map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1878 $invoice_data{'total_item'} = 'Sub-total';
1879 $invoice_data{'total_amount'} =
1880 '\dollar '. sprintf('%.2f', $self->charged - $taxtotal );
1881 unshift @total_fill,
1882 map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1886 $invoice_data{'total_item'} = '\textbf{Total}';
1887 $invoice_data{'total_amount'} =
1888 '\textbf{\dollar '. sprintf('%.2f', $self->charged + $pr_total ). '}';
1890 map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1893 #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
1896 foreach my $credit ( $self->_items_credits ) {
1897 $invoice_data{'total_item'} = _latex_escape($credit->{'description'});
1899 $invoice_data{'total_amount'} = '-\dollar '. $credit->{'amount'};
1901 map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1906 foreach my $payment ( $self->_items_payments ) {
1907 $invoice_data{'total_item'} = _latex_escape($payment->{'description'});
1909 $invoice_data{'total_amount'} = '-\dollar '. $payment->{'amount'};
1911 map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1915 $invoice_data{'total_item'} = '\textbf{'. $self->balance_due_msg. '}';
1916 $invoice_data{'total_amount'} =
1917 '\textbf{\dollar '. sprintf('%.2f', $self->owed + $pr_total ). '}';
1919 map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1922 push @filled_in, @total_fill;
1925 #$line =~ s/\$(\w+)/$invoice_data{$1}/eg;
1926 $line =~ s/\$(\w+)/exists($invoice_data{$1}) ? $invoice_data{$1} : nounder($1)/eg;
1927 push @filled_in, $line;
1938 } elsif ( $format eq 'Text::Template' ) {
1940 my @detail_items = ();
1941 my @total_items = ();
1943 $invoice_data{'detail_items'} = \@detail_items;
1944 $invoice_data{'total_items'} = \@total_items;
1946 foreach my $line_item ( $self->_items ) {
1948 ext_description => [],
1950 $detail->{'ref'} = $line_item->{'pkgnum'};
1951 $detail->{'quantity'} = 1;
1952 $detail->{'description'} = _latex_escape($line_item->{'description'});
1953 if ( exists $line_item->{'ext_description'} ) {
1954 @{$detail->{'ext_description'}} = map {
1956 } @{$line_item->{'ext_description'}};
1958 $detail->{'amount'} = $line_item->{'amount'};
1959 $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
1961 push @detail_items, $detail;
1966 foreach my $tax ( $self->_items_tax ) {
1968 $total->{'total_item'} = _latex_escape($tax->{'description'});
1969 $taxtotal += $tax->{'amount'};
1970 $total->{'total_amount'} = '\dollar '. $tax->{'amount'};
1971 push @total_items, $total;
1976 $total->{'total_item'} = 'Sub-total';
1977 $total->{'total_amount'} =
1978 '\dollar '. sprintf('%.2f', $self->charged - $taxtotal );
1979 unshift @total_items, $total;
1984 $total->{'total_item'} = '\textbf{Total}';
1985 $total->{'total_amount'} =
1986 '\textbf{\dollar '. sprintf('%.2f', $self->charged + $pr_total ). '}';
1987 push @total_items, $total;
1990 #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
1993 foreach my $credit ( $self->_items_credits ) {
1995 $total->{'total_item'} = _latex_escape($credit->{'description'});
1997 $total->{'total_amount'} = '-\dollar '. $credit->{'amount'};
1998 push @total_items, $total;
2002 foreach my $payment ( $self->_items_payments ) {
2004 $total->{'total_item'} = _latex_escape($payment->{'description'});
2006 $total->{'total_amount'} = '-\dollar '. $payment->{'amount'};
2007 push @total_items, $total;
2012 $total->{'total_item'} = '\textbf{'. $self->balance_due_msg. '}';
2013 $total->{'total_amount'} =
2014 '\textbf{\dollar '. sprintf('%.2f', $self->owed + $pr_total ). '}';
2015 push @total_items, $total;
2019 die "guru meditation #54";
2022 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
2023 my $fh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
2027 ) or die "can't open temp file: $!\n";
2028 if ( $format eq 'old' ) {
2029 print $fh join('', @filled_in );
2030 } elsif ( $format eq 'Text::Template' ) {
2031 $text_template->fill_in(OUTPUT => $fh, HASH => \%invoice_data);
2033 die "guru meditation #32";
2037 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
2042 =item print_ps [ TIME [ , TEMPLATE ] ]
2044 Returns an postscript invoice, as a scalar.
2046 TIME an optional value used to control the printing of overdue messages. The
2047 default is now. It isn't the date of the invoice; that's the `_date' field.
2048 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2049 L<Time::Local> and L<Date::Parse> for conversion functions.
2056 my $file = $self->print_latex(@_);
2057 FS::Misc::generate_ps($file);
2061 =item print_pdf [ TIME [ , TEMPLATE ] ]
2063 Returns an PDF invoice, as a scalar.
2065 TIME an optional value used to control the printing of overdue messages. The
2066 default is now. It isn't the date of the invoice; that's the `_date' field.
2067 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2068 L<Time::Local> and L<Date::Parse> for conversion functions.
2075 my $file = $self->print_latex(@_);
2077 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
2080 #system('pdflatex', "$file.tex");
2081 #system('pdflatex', "$file.tex");
2082 #! LaTeX Error: Unknown graphics extension: .eps.
2084 my $sfile = shell_quote $file;
2086 system("pslatex $sfile.tex >/dev/null 2>&1") == 0
2087 or die "pslatex $file.tex failed; see $file.log for details?\n";
2088 system("pslatex $sfile.tex >/dev/null 2>&1") == 0
2089 or die "pslatex $file.tex failed; see $file.log for details?\n";
2091 #system('dvipdf', "$file.dvi", "$file.pdf" );
2093 "dvips -q -t letter -f $sfile.dvi ".
2094 "| gs -q -dNOPAUSE -dBATCH -sDEVICE=pdfwrite -sOutputFile=$sfile.pdf ".
2097 or die "dvips | gs failed: $!";
2099 open(PDF, "<$file.pdf")
2100 or die "can't open $file.pdf: $! (error in LaTeX template?)\n";
2102 unlink("$file.dvi", "$file.log", "$file.aux", "$file.pdf", "$file.tex");
2115 =item print_html [ TIME [ , TEMPLATE [ , CID ] ] ]
2117 Returns an HTML invoice, as a scalar.
2119 TIME an optional value used to control the printing of overdue messages. The
2120 default is now. It isn't the date of the invoice; that's the `_date' field.
2121 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2122 L<Time::Local> and L<Date::Parse> for conversion functions.
2124 CID is a MIME Content-ID used to create a "cid:" URL for the logo image, used
2125 when emailing the invoice as part of a multipart/related MIME email.
2129 #some falze laziness w/print_text and print_latex (and send_csv)
2131 my( $self, $today, $template, $cid ) = @_;
2134 my $cust_main = $self->cust_main;
2135 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
2136 unless $cust_main->payname && $cust_main->payby !~ /^(CHEK|DCHK)$/;
2138 $template ||= $self->_agent_template;
2139 my $templatefile = 'invoice_html';
2140 my $suffix = length($template) ? "_$template" : '';
2141 $templatefile .= $suffix;
2142 my @html_template = map "$_\n", $conf->config($templatefile)
2143 or die "cannot load config file $templatefile";
2145 my $html_template = new Text::Template(
2147 SOURCE => \@html_template,
2148 DELIMITERS => [ '<%=', '%>' ],
2151 $html_template->compile()
2152 or die 'While compiling ' . $templatefile . ': ' . $Text::Template::ERROR;
2154 my %invoice_data = (
2155 'custnum' => $self->custnum,
2156 'invnum' => $self->invnum,
2157 'date' => time2str('%b %o, %Y', $self->_date),
2158 'today' => time2str('%b %o, %Y', $today),
2159 'agent' => encode_entities($cust_main->agent->agent),
2160 'payname' => encode_entities($cust_main->payname),
2161 'company' => encode_entities($cust_main->company),
2162 'address1' => encode_entities($cust_main->address1),
2163 'address2' => encode_entities($cust_main->address2),
2164 'city' => encode_entities($cust_main->city),
2165 'state' => encode_entities($cust_main->state),
2166 'zip' => encode_entities($cust_main->zip),
2167 'terms' => $conf->config('invoice_default_terms')
2168 || 'Payable upon receipt',
2170 'template' => $template,
2171 # 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
2175 defined( $conf->config_orbase('invoice_htmlreturnaddress', $template) )
2176 && length( $conf->config_orbase('invoice_htmlreturnaddress', $template) )
2178 $invoice_data{'returnaddress'} =
2179 join("\n", $conf->config('invoice_htmlreturnaddress', $template) );
2181 $invoice_data{'returnaddress'} =
2184 s/\\\\\*?\s*$/<BR>/;
2185 s/\\hyphenation\{[\w\s\-]+\}//;
2188 $conf->config_orbase( 'invoice_latexreturnaddress',
2194 my $countrydefault = $conf->config('countrydefault') || 'US';
2195 if ( $cust_main->country eq $countrydefault ) {
2196 $invoice_data{'country'} = '';
2198 $invoice_data{'country'} =
2199 encode_entities(code2country($cust_main->country));
2203 defined( $conf->config_orbase('invoice_htmlnotes', $template) )
2204 && length( $conf->config_orbase('invoice_htmlnotes', $template) )
2206 $invoice_data{'notes'} =
2207 join("\n", $conf->config_orbase('invoice_htmlnotes', $template) );
2209 $invoice_data{'notes'} =
2211 s/%%(.*)$/<!-- $1 -->/g;
2212 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
2213 s/\\begin\{enumerate\}/<ol>/g;
2215 s/\\end\{enumerate\}/<\/ol>/g;
2216 s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
2221 $conf->config_orbase('invoice_latexnotes', $template)
2225 # #do variable substitutions in notes
2226 # $invoice_data{'notes'} =
2228 # map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
2229 # $conf->config_orbase('invoice_latexnotes', $suffix)
2233 defined( $conf->config_orbase('invoice_htmlfooter', $template) )
2234 && length( $conf->config_orbase('invoice_htmlfooter', $template) )
2236 $invoice_data{'footer'} =
2237 join("\n", $conf->config_orbase('invoice_htmlfooter', $template) );
2239 $invoice_data{'footer'} =
2240 join("\n", map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; }
2241 $conf->config_orbase('invoice_latexfooter', $template)
2245 $invoice_data{'po_line'} =
2246 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
2247 ? encode_entities("Purchase Order #". $cust_main->payinfo)
2250 my $money_char = $conf->config('money_char') || '$';
2252 foreach my $line_item ( $self->_items ) {
2254 ext_description => [],
2256 $detail->{'ref'} = $line_item->{'pkgnum'};
2257 $detail->{'description'} = encode_entities($line_item->{'description'});
2258 if ( exists $line_item->{'ext_description'} ) {
2259 @{$detail->{'ext_description'}} = map {
2260 encode_entities($_);
2261 } @{$line_item->{'ext_description'}};
2263 $detail->{'amount'} = $money_char. $line_item->{'amount'};
2264 $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
2266 push @{$invoice_data{'detail_items'}}, $detail;
2271 foreach my $tax ( $self->_items_tax ) {
2273 $total->{'total_item'} = encode_entities($tax->{'description'});
2274 $taxtotal += $tax->{'amount'};
2275 $total->{'total_amount'} = $money_char. $tax->{'amount'};
2276 push @{$invoice_data{'total_items'}}, $total;
2281 $total->{'total_item'} = 'Sub-total';
2282 $total->{'total_amount'} =
2283 $money_char. sprintf('%.2f', $self->charged - $taxtotal );
2284 unshift @{$invoice_data{'total_items'}}, $total;
2287 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2290 $total->{'total_item'} = '<b>Total</b>';
2291 $total->{'total_amount'} =
2292 "<b>$money_char". sprintf('%.2f', $self->charged + $pr_total ). '</b>';
2293 push @{$invoice_data{'total_items'}}, $total;
2296 #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
2299 foreach my $credit ( $self->_items_credits ) {
2301 $total->{'total_item'} = encode_entities($credit->{'description'});
2303 $total->{'total_amount'} = "-$money_char". $credit->{'amount'};
2304 push @{$invoice_data{'total_items'}}, $total;
2308 foreach my $payment ( $self->_items_payments ) {
2310 $total->{'total_item'} = encode_entities($payment->{'description'});
2312 $total->{'total_amount'} = "-$money_char". $payment->{'amount'};
2313 push @{$invoice_data{'total_items'}}, $total;
2318 $total->{'total_item'} = '<b>'. $self->balance_due_msg. '</b>';
2319 $total->{'total_amount'} =
2320 "<b>$money_char". sprintf('%.2f', $self->owed + $pr_total ). '</b>';
2321 push @{$invoice_data{'total_items'}}, $total;
2324 $html_template->fill_in( HASH => \%invoice_data);
2327 # quick subroutine for print_latex
2329 # There are ten characters that LaTeX treats as special characters, which
2330 # means that they do not simply typeset themselves:
2331 # # $ % & ~ _ ^ \ { }
2333 # TeX ignores blanks following an escaped character; if you want a blank (as
2334 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
2338 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
2339 $value =~ s/([<>])/\$$1\$/g;
2343 #utility methods for print_*
2345 sub balance_due_msg {
2347 my $msg = 'Balance Due';
2348 return $msg unless $conf->exists('invoice_default_terms');
2349 if ( $conf->config('invoice_default_terms') =~ /^\s*Net\s*(\d+)\s*$/ ) {
2350 $msg .= ' - Please pay by '. time2str("%x", $self->_date + ($1*86400) );
2351 } elsif ( $conf->config('invoice_default_terms') ) {
2352 $msg .= ' - '. $conf->config('invoice_default_terms');
2359 my @display = scalar(@_)
2361 : qw( _items_previous _items_pkg );
2362 #: qw( _items_pkg );
2363 #: qw( _items_previous _items_pkg _items_tax _items_credits _items_payments );
2365 foreach my $display ( @display ) {
2366 push @b, $self->$display(@_);
2371 sub _items_previous {
2373 my $cust_main = $self->cust_main;
2374 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2376 foreach ( @pr_cust_bill ) {
2378 'description' => 'Previous Balance, Invoice #'. $_->invnum.
2379 ' ('. time2str('%x',$_->_date). ')',
2380 #'pkgpart' => 'N/A',
2382 'amount' => sprintf("%.2f", $_->owed),
2388 # 'description' => 'Previous Balance',
2389 # #'pkgpart' => 'N/A',
2390 # 'pkgnum' => 'N/A',
2391 # 'amount' => sprintf("%10.2f", $pr_total ),
2392 # 'ext_description' => [ map {
2393 # "Invoice ". $_->invnum.
2394 # " (". time2str("%x",$_->_date). ") ".
2395 # sprintf("%10.2f", $_->owed)
2396 # } @pr_cust_bill ],
2403 my @cust_bill_pkg = grep { $_->pkgnum } $self->cust_bill_pkg;
2404 $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2409 my @cust_bill_pkg = grep { ! $_->pkgnum } $self->cust_bill_pkg;
2410 $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2413 sub _items_cust_bill_pkg {
2415 my $cust_bill_pkg = shift;
2418 foreach my $cust_bill_pkg ( @$cust_bill_pkg ) {
2420 my $desc = $cust_bill_pkg->desc;
2422 if ( $cust_bill_pkg->pkgnum > 0 ) {
2424 if ( $cust_bill_pkg->setup != 0 ) {
2425 my $description = $desc;
2426 $description .= ' Setup' if $cust_bill_pkg->recur != 0;
2427 my @d = $cust_bill_pkg->cust_pkg->h_labels_short($self->_date);
2428 push @d, $cust_bill_pkg->details if $cust_bill_pkg->recur == 0;
2430 description => $description,
2431 #pkgpart => $part_pkg->pkgpart,
2432 pkgnum => $cust_bill_pkg->pkgnum,
2433 amount => sprintf("%.2f", $cust_bill_pkg->setup),
2434 ext_description => \@d,
2438 if ( $cust_bill_pkg->recur != 0 ) {
2440 description => $desc .
2441 ( $conf->exists('disable_line_item_date_ranges')
2443 : " (" .time2str("%x", $cust_bill_pkg->sdate).
2444 " - ".time2str("%x", $cust_bill_pkg->edate).")"
2446 #pkgpart => $part_pkg->pkgpart,
2447 pkgnum => $cust_bill_pkg->pkgnum,
2448 amount => sprintf("%.2f", $cust_bill_pkg->recur),
2450 [ $cust_bill_pkg->cust_pkg->h_labels_short( $cust_bill_pkg->edate,
2451 $cust_bill_pkg->sdate),
2452 $cust_bill_pkg->details,
2457 } else { #pkgnum tax or one-shot line item (??)
2459 if ( $cust_bill_pkg->setup != 0 ) {
2461 'description' => $desc,
2462 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
2465 if ( $cust_bill_pkg->recur != 0 ) {
2467 'description' => "$desc (".
2468 time2str("%x", $cust_bill_pkg->sdate). ' - '.
2469 time2str("%x", $cust_bill_pkg->edate). ')',
2470 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
2482 sub _items_credits {
2487 foreach ( $self->cust_credited ) {
2489 #something more elaborate if $_->amount ne $_->cust_credit->credited ?
2491 my $reason = $_->cust_credit->reason;
2492 #my $reason = substr($_->cust_credit->reason,0,32);
2493 #$reason .= '...' if length($reason) < length($_->cust_credit->reason);
2494 $reason = " ($reason) " if $reason;
2496 #'description' => 'Credit ref\#'. $_->crednum.
2497 # " (". time2str("%x",$_->cust_credit->_date) .")".
2499 'description' => 'Credit applied '.
2500 time2str("%x",$_->cust_credit->_date). $reason,
2501 'amount' => sprintf("%.2f",$_->amount),
2504 #foreach ( @cr_cust_credit ) {
2506 # "Credit #". $_->crednum. " (" . time2str("%x",$_->_date) .")",
2507 # $money_char. sprintf("%10.2f",$_->credited)
2515 sub _items_payments {
2519 #get & print payments
2520 foreach ( $self->cust_bill_pay ) {
2522 #something more elaborate if $_->amount ne ->cust_pay->paid ?
2525 'description' => "Payment received ".
2526 time2str("%x",$_->cust_pay->_date ),
2527 'amount' => sprintf("%.2f", $_->amount )
2546 sub process_reprint {
2547 process_re_X('print', @_);
2554 sub process_reemail {
2555 process_re_X('email', @_);
2563 process_re_X('fax', @_);
2566 use Storable qw(thaw);
2570 my( $method, $job ) = ( shift, shift );
2571 warn "process_re_X $method for job $job\n" if $DEBUG;
2573 my $param = thaw(decode_base64(shift));
2574 warn Dumper($param) if $DEBUG;
2585 my($method, $job, %param ) = @_;
2586 # [ 'begin', 'end', 'agentnum', 'open', 'days', 'newest_percust' ],
2588 warn "re_X $method for job $job with param:\n".
2589 join( '', map { " $_ => ". $param{$_}. "\n" } keys %param );
2592 #some false laziness w/search/cust_bill.html
2594 my $orderby = 'ORDER BY cust_bill._date';
2598 if ( $param{'begin'} =~ /^(\d+)$/ ) {
2599 push @where, "cust_bill._date >= $1";
2601 if ( $param{'end'} =~ /^(\d+)$/ ) {
2602 push @where, "cust_bill._date < $1";
2604 if ( $param{'invnum_min'} =~ /^(\d+)$/ ) {
2605 push @where, "cust_bill.invnum >= $1";
2607 if ( $param{'invnum_max'} =~ /^(\d+)$/ ) {
2608 push @where, "cust_bill.invnum <= $1";
2610 if ( $param{'agentnum'} =~ /^(\d+)$/ ) {
2611 push @where, "cust_main.agentnum = $1";
2615 "charged - ( SELECT COALESCE(SUM(amount),0) FROM cust_bill_pay
2616 WHERE cust_bill_pay.invnum = cust_bill.invnum )
2617 - ( SELECT COALESCE(SUM(amount),0) FROM cust_credit_bill
2618 WHERE cust_credit_bill.invnum = cust_bill.invnum )";
2620 push @where, "0 != $owed"
2623 push @where, "cust_bill._date < ". (time-86400*$param{'days'})
2626 if ( $param{'newest_percust'} ) {
2628 #$distinct = 'DISTINCT ON ( cust_bill.custnum )';
2629 #$orderby = 'ORDER BY cust_bill.custnum ASC, cust_bill._date DESC';
2631 my @newest_where = map { s/\bcust_bill\./newest_cust_bill./g; }
2632 grep ! /^cust_main./, @where;
2633 my $newest_where = scalar(@newest_where)
2634 ? ' AND '. join(' AND ', @newest_where)
2637 push @where, "cust_bill._date = (
2638 SELECT(MAX(newest_cust_bill._date)) FROM cust_bill AS newest_cust_bill
2639 WHERE newest_cust_bill.custnum = cust_bill.custnum
2645 my $extra_sql = scalar(@where) ? 'WHERE '. join(' AND ', @where) : '';
2647 my $addl_from = 'left join cust_main using ( custnum )';
2649 my @cust_bill = qsearch( 'cust_bill',
2651 #"$distinct cust_bill.*",
2658 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
2659 foreach my $cust_bill ( @cust_bill ) {
2660 $cust_bill->$method();
2662 if ( $job ) { #progressbar foo
2664 if ( time - $min_sec > $last ) {
2665 my $error = $job->update_statustext(
2666 int( 100 * $num / scalar(@cust_bill) )
2668 die $error if $error;
2683 print_text formatting (and some logic :/) is in source, but needs to be
2684 slurped in from a file. Also number of lines ($=).
2688 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
2689 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base