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;
29 use FS::cust_bill_pay;
30 use FS::cust_bill_pay_batch;
31 use FS::part_bill_event;
34 @ISA = qw( FS::cust_main_Mixin FS::Record );
37 $me = '[FS::cust_bill]';
39 #ask FS::UID to run this stuff for us later
40 FS::UID->install_callback( sub {
42 $money_char = $conf->config('money_char') || '$';
47 FS::cust_bill - Object methods for cust_bill records
53 $record = new FS::cust_bill \%hash;
54 $record = new FS::cust_bill { 'column' => 'value' };
56 $error = $record->insert;
58 $error = $new_record->replace($old_record);
60 $error = $record->delete;
62 $error = $record->check;
64 ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
66 @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
68 ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
70 @cust_pay_objects = $cust_bill->cust_pay;
72 $tax_amount = $record->tax;
74 @lines = $cust_bill->print_text;
75 @lines = $cust_bill->print_text $time;
79 An FS::cust_bill object represents an invoice; a declaration that a customer
80 owes you money. The specific charges are itemized as B<cust_bill_pkg> records
81 (see L<FS::cust_bill_pkg>). FS::cust_bill inherits from FS::Record. The
82 following fields are currently supported:
86 =item invnum - primary key (assigned automatically for new invoices)
88 =item custnum - customer (see L<FS::cust_main>)
90 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
91 L<Time::Local> and L<Date::Parse> for conversion functions.
93 =item charged - amount of this invoice
95 =item printed - deprecated
97 =item closed - books closed flag, empty or `Y'
107 Creates a new invoice. To add the invoice to the database, see L<"insert">.
108 Invoices are normally created by calling the bill method of a customer object
109 (see L<FS::cust_main>).
113 sub table { 'cust_bill'; }
115 sub cust_linked { $_[0]->cust_main_custnum; }
116 sub cust_unlinked_msg {
118 "WARNING: can't find cust_main.custnum ". $self->custnum.
119 ' (cust_bill.invnum '. $self->invnum. ')';
124 Adds this invoice to the database ("Posts" the invoice). If there is an error,
125 returns the error, otherwise returns false.
129 This method now works but you probably shouldn't use it. Instead, apply a
130 credit against the invoice.
132 Using this method to delete invoices outright is really, really bad. There
133 would be no record you ever posted this invoice, and there are no check to
134 make sure charged = 0 or that there are no associated cust_bill_pkg records.
136 Really, don't use it.
142 return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
143 $self->SUPER::delete(@_);
146 =item replace OLD_RECORD
148 Replaces the OLD_RECORD with this one in the database. If there is an error,
149 returns the error, otherwise returns false.
151 Only printed may be changed. printed is normally updated by calling the
152 collect method of a customer object (see L<FS::cust_main>).
156 #replace can be inherited from Record.pm
158 # replace_check is now the preferred way to #implement replace data checks
159 # (so $object->replace() works without an argument)
162 my( $new, $old ) = ( shift, shift );
163 return "Can't change custnum!" unless $old->custnum == $new->custnum;
164 #return "Can't change _date!" unless $old->_date eq $new->_date;
165 return "Can't change _date!" unless $old->_date == $new->_date;
166 return "Can't change charged!" unless $old->charged == $new->charged
167 || $old->charged == 0;
174 Checks all fields to make sure this is a valid invoice. If there is an error,
175 returns the error, otherwise returns false. Called by the insert and replace
184 $self->ut_numbern('invnum')
185 || $self->ut_number('custnum')
186 || $self->ut_numbern('_date')
187 || $self->ut_money('charged')
188 || $self->ut_numbern('printed')
189 || $self->ut_enum('closed', [ '', 'Y' ])
191 return $error if $error;
193 return "Unknown customer"
194 unless qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
196 $self->_date(time) unless $self->_date;
198 $self->printed(0) if $self->printed eq '';
205 Returns a list consisting of the total previous balance for this customer,
206 followed by the previous outstanding invoices (as FS::cust_bill objects also).
213 my @cust_bill = sort { $a->_date <=> $b->_date }
214 grep { $_->owed != 0 && $_->_date < $self->_date }
215 qsearch( 'cust_bill', { 'custnum' => $self->custnum } )
217 foreach ( @cust_bill ) { $total += $_->owed; }
223 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
229 qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum } );
234 Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
241 my @cust_pkg = map { $_->cust_pkg } $self->cust_bill_pkg;
243 grep { ! $saw{$_->pkgnum}++ } @cust_pkg;
246 =item open_cust_bill_pkg
248 Returns the open line items for this invoice.
250 Note that cust_bill_pkg with both setup and recur fees are returned as two
251 separate line items, each with only one fee.
255 # modeled after cust_main::open_cust_bill
256 sub open_cust_bill_pkg {
259 # grep { $_->owed > 0 } $self->cust_bill_pkg
261 my %other = ( 'recur' => 'setup',
262 'setup' => 'recur', );
264 foreach my $field ( qw( recur setup )) {
265 push @open, map { $_->set( $other{$field}, 0 ); $_; }
266 grep { $_->owed($field) > 0 }
267 $self->cust_bill_pkg;
273 =item cust_bill_event
275 Returns the completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
279 sub cust_bill_event {
281 qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
284 =item num_cust_bill_event
286 Returns the number of completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
290 sub num_cust_bill_event {
293 "SELECT COUNT(*) FROM cust_bill_event WHERE invnum = ?";
294 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
295 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
296 $sth->fetchrow_arrayref->[0];
301 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
305 #false laziness w/cust_pkg.pm
309 'table' => 'cust_event',
310 'addl_from' => 'JOIN part_event USING ( eventpart )',
311 'hashref' => { 'tablenum' => $self->invnum },
312 'extra_sql' => " AND eventtable = 'cust_bill' ",
318 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
322 #false laziness w/cust_pkg.pm
326 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
327 " WHERE tablenum = ? AND eventtable = 'cust_bill'";
328 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
329 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
330 $sth->fetchrow_arrayref->[0];
335 Returns the customer (see L<FS::cust_main>) for this invoice.
341 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
344 =item cust_suspend_if_balance_over AMOUNT
346 Suspends the customer associated with this invoice if the total amount owed on
347 this invoice and all older invoices is greater than the specified amount.
349 Returns a list: an empty list on success or a list of errors.
353 sub cust_suspend_if_balance_over {
354 my( $self, $amount ) = ( shift, shift );
355 my $cust_main = $self->cust_main;
356 if ( $cust_main->total_owed_date($self->_date) < $amount ) {
359 $cust_main->suspend(@_);
365 Depreciated. See the cust_credited method.
367 #Returns a list consisting of the total previous credited (see
368 #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
369 #outstanding credits (FS::cust_credit objects).
375 croak "FS::cust_bill->cust_credit depreciated; see ".
376 "FS::cust_bill->cust_credit_bill";
379 #my @cust_credit = sort { $a->_date <=> $b->_date }
380 # grep { $_->credited != 0 && $_->_date < $self->_date }
381 # qsearch('cust_credit', { 'custnum' => $self->custnum } )
383 #foreach (@cust_credit) { $total += $_->credited; }
384 #$total, @cust_credit;
389 Depreciated. See the cust_bill_pay method.
391 #Returns all payments (see L<FS::cust_pay>) for this invoice.
397 croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
399 #sort { $a->_date <=> $b->_date }
400 # qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
406 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
412 sort { $a->_date <=> $b->_date }
413 qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
418 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
424 sort { $a->_date <=> $b->_date }
425 qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
431 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
438 my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
440 foreach (@taxlines) { $total += $_->setup; }
446 Returns the amount owed (still outstanding) on this invoice, which is charged
447 minus all payment applications (see L<FS::cust_bill_pay>) and credit
448 applications (see L<FS::cust_credit_bill>).
454 my $balance = $self->charged;
455 $balance -= $_->amount foreach ( $self->cust_bill_pay );
456 $balance -= $_->amount foreach ( $self->cust_credited );
457 $balance = sprintf( "%.2f", $balance);
458 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
462 =item apply_payments_and_credits
466 sub apply_payments_and_credits {
469 local $SIG{HUP} = 'IGNORE';
470 local $SIG{INT} = 'IGNORE';
471 local $SIG{QUIT} = 'IGNORE';
472 local $SIG{TERM} = 'IGNORE';
473 local $SIG{TSTP} = 'IGNORE';
474 local $SIG{PIPE} = 'IGNORE';
476 my $oldAutoCommit = $FS::UID::AutoCommit;
477 local $FS::UID::AutoCommit = 0;
480 $self->select_for_update; #mutex
482 my @payments = grep { $_->unapplied > 0 } $self->cust_main->cust_pay;
483 my @credits = grep { $_->credited > 0 } $self->cust_main->cust_credit;
485 while ( $self->owed > 0 and ( @payments || @credits ) ) {
488 if ( @payments && @credits ) {
490 #decide which goes first by weight of top (unapplied) line item
492 my @open_lineitems = $self->open_cust_bill_pkg;
495 max( map { $_->part_pkg->pay_weight || 0 }
500 my $max_credit_weight =
501 max( map { $_->part_pkg->credit_weight || 0 }
507 #if both are the same... payments first? it has to be something
508 if ( $max_pay_weight >= $max_credit_weight ) {
514 } elsif ( @payments ) {
516 } elsif ( @credits ) {
519 die "guru meditation #12 and 35";
522 if ( $app eq 'pay' ) {
524 my $payment = shift @payments;
526 $app = new FS::cust_bill_pay {
527 'paynum' => $payment->paynum,
528 'amount' => sprintf('%.2f', min( $payment->unapplied, $self->owed ) ),
531 } elsif ( $app eq 'credit' ) {
533 my $credit = shift @credits;
535 $app = new FS::cust_credit_bill {
536 'crednum' => $credit->crednum,
537 'amount' => sprintf('%.2f', min( $credit->credited, $self->owed ) ),
541 die "guru meditation #12 and 35";
544 $app->invnum( $self->invnum );
546 my $error = $app->insert;
548 $dbh->rollback if $oldAutoCommit;
549 return "Error inserting ". $app->table. " record: $error";
551 die $error if $error;
555 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
560 =item generate_email PARAMHASH
562 PARAMHASH can contain the following:
566 =item from => sender address, required
568 =item tempate => alternate template name, optional
570 =item print_text => text attachment arrayref, optional
572 =item subject => email subject, optional
576 Returns an argument list to be passed to L<FS::Misc::send_email>.
587 my $me = '[FS::cust_bill::generate_email]';
590 'from' => $args{'from'},
591 'subject' => (($args{'subject'}) ? $args{'subject'} : 'Invoice'),
594 if (ref($args{'to'}) eq 'ARRAY') {
595 $return{'to'} = $args{'to'};
597 $return{'to'} = [ grep { $_ !~ /^(POST|FAX)$/ }
598 $self->cust_main->invoicing_list
602 if ( $conf->exists('invoice_html') ) {
604 warn "$me creating HTML/text multipart message"
607 $return{'nobody'} = 1;
609 my $alternative = build MIME::Entity
610 'Type' => 'multipart/alternative',
611 'Encoding' => '7bit',
612 'Disposition' => 'inline'
616 if ( $conf->exists('invoice_email_pdf')
617 and scalar($conf->config('invoice_email_pdf_note')) ) {
619 warn "$me using 'invoice_email_pdf_note' in multipart message"
621 $data = [ map { $_ . "\n" }
622 $conf->config('invoice_email_pdf_note')
627 warn "$me not using 'invoice_email_pdf_note' in multipart message"
629 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
630 $data = $args{'print_text'};
632 $data = [ $self->print_text('', $args{'template'}) ];
637 $alternative->attach(
638 'Type' => 'text/plain',
639 #'Encoding' => 'quoted-printable',
640 'Encoding' => '7bit',
642 'Disposition' => 'inline',
645 $args{'from'} =~ /\@([\w\.\-]+)/;
646 my $from = $1 || 'example.com';
647 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
649 my $path = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
651 if ( defined($args{'template'}) && length($args{'template'})
652 && -e "$path/logo_". $args{'template'}. ".png"
655 $file = "$path/logo_". $args{'template'}. ".png";
657 $file = "$path/logo.png";
660 my $image = build MIME::Entity
661 'Type' => 'image/png',
662 'Encoding' => 'base64',
664 'Filename' => 'logo.png',
665 'Content-ID' => "<$content_id>",
668 $alternative->attach(
669 'Type' => 'text/html',
670 'Encoding' => 'quoted-printable',
671 'Data' => [ '<html>',
674 ' '. encode_entities($return{'subject'}),
677 ' <body bgcolor="#e8e8e8">',
678 $self->print_html('', $args{'template'}, $content_id),
682 'Disposition' => 'inline',
683 #'Filename' => 'invoice.pdf',
686 if ( $conf->exists('invoice_email_pdf') ) {
691 # multipart/alternative
697 my $related = build MIME::Entity 'Type' => 'multipart/related',
698 'Encoding' => '7bit';
700 #false laziness w/Misc::send_email
701 $related->head->replace('Content-type',
703 '; boundary="'. $related->head->multipart_boundary. '"'.
704 '; type=multipart/alternative'
707 $related->add_part($alternative);
709 $related->add_part($image);
711 my $pdf = build MIME::Entity $self->mimebuild_pdf('', $args{'template'});
713 $return{'mimeparts'} = [ $related, $pdf ];
717 #no other attachment:
719 # multipart/alternative
724 $return{'content-type'} = 'multipart/related';
725 $return{'mimeparts'} = [ $alternative, $image ];
726 $return{'type'} = 'multipart/alternative'; #Content-Type of first part...
727 #$return{'disposition'} = 'inline';
733 if ( $conf->exists('invoice_email_pdf') ) {
734 warn "$me creating PDF attachment"
737 #mime parts arguments a la MIME::Entity->build().
738 $return{'mimeparts'} = [
739 { $self->mimebuild_pdf('', $args{'template'}) }
743 if ( $conf->exists('invoice_email_pdf')
744 and scalar($conf->config('invoice_email_pdf_note')) ) {
746 warn "$me using 'invoice_email_pdf_note'"
748 $return{'body'} = [ map { $_ . "\n" }
749 $conf->config('invoice_email_pdf_note')
754 warn "$me not using 'invoice_email_pdf_note'"
756 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
757 $return{'body'} = $args{'print_text'};
759 $return{'body'} = [ $self->print_text('', $args{'template'}) ];
772 Returns a list suitable for passing to MIME::Entity->build(), representing
773 this invoice as PDF attachment.
780 'Type' => 'application/pdf',
781 'Encoding' => 'base64',
782 'Data' => [ $self->print_pdf(@_) ],
783 'Disposition' => 'attachment',
784 'Filename' => 'invoice.pdf',
788 =item send [ TEMPLATENAME [ , AGENTNUM [ , INVOICE_FROM ] ] ]
790 Sends this invoice to the destinations configured for this customer: sends
791 email, prints and/or faxes. See L<FS::cust_main_invoice>.
793 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
795 AGENTNUM, if specified, means that this invoice will only be sent for customers
796 of the specified agent or agent(s). AGENTNUM can be a scalar agentnum (for a
797 single agent) or an arrayref of agentnums.
799 INVOICE_FROM, if specified, overrides the default email invoice From: address.
806 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
807 or die "invalid invoice number: " . $opt{invnum};
809 my @args = ( $opt{template}, $opt{agentnum} );
810 push @args, $opt{invoice_from}
811 if exists($opt{invoice_from}) && $opt{invoice_from};
813 my $error = $self->send( @args );
814 die $error if $error;
820 my $template = scalar(@_) ? shift : '';
821 if ( scalar(@_) && $_[0] ) {
822 my $agentnums = ref($_[0]) ? shift : [ shift ];
823 return 'N/A' unless grep { $_ == $self->cust_main->agentnum } @$agentnums;
829 : ( $self->_agent_invoice_from || $conf->config('invoice_from') );
831 my @invoicing_list = $self->cust_main->invoicing_list;
833 $self->email($template, $invoice_from)
834 if grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list;
836 $self->print($template)
837 if grep { $_ eq 'POST' } @invoicing_list; #postal
839 $self->fax($template)
840 if grep { $_ eq 'FAX' } @invoicing_list; #fax
846 =item email [ TEMPLATENAME [ , INVOICE_FROM ] ]
850 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
852 INVOICE_FROM, if specified, overrides the default email invoice From: address.
856 sub queueable_email {
859 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
860 or die "invalid invoice number: " . $opt{invnum};
862 my @args = ( $opt{template} );
863 push @args, $opt{invoice_from}
864 if exists($opt{invoice_from}) && $opt{invoice_from};
866 my $error = $self->email( @args );
867 die $error if $error;
873 my $template = scalar(@_) ? shift : '';
877 : ( $self->_agent_invoice_from || $conf->config('invoice_from') );
879 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
880 $self->cust_main->invoicing_list;
882 #better to notify this person than silence
883 @invoicing_list = ($invoice_from) unless @invoicing_list;
885 my $error = send_email(
886 $self->generate_email(
887 'from' => $invoice_from,
888 'to' => [ grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list ],
889 'template' => $template,
892 die "can't email invoice: $error\n" if $error;
893 #die "$error\n" if $error;
897 =item lpr_data [ TEMPLATENAME ]
899 Returns the postscript or plaintext for this invoice as an arrayref.
901 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
906 my( $self, $template) = @_;
907 $conf->exists('invoice_latex')
908 ? [ $self->print_ps('', $template) ]
909 : [ $self->print_text('', $template) ];
912 =item print [ TEMPLATENAME ]
916 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
922 my $template = scalar(@_) ? shift : '';
924 do_print $self->lpr_data($template);
927 =item fax [ TEMPLATENAME ]
931 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
937 my $template = scalar(@_) ? shift : '';
939 die 'FAX invoice destination not (yet?) supported with plain text invoices.'
940 unless $conf->exists('invoice_latex');
942 my $dialstring = $self->cust_main->getfield('fax');
945 my $error = send_fax( 'docdata' => $self->lpr_data($template),
946 'dialstring' => $dialstring,
948 die $error if $error;
952 =item send_if_newest [ TEMPLATENAME [ , AGENTNUM [ , INVOICE_FROM ] ] ]
954 Like B<send>, but only sends the invoice if it is the newest open invoice for
964 grep { $_->owed > 0 }
965 qsearch('cust_bill', {
966 'custnum' => $self->custnum,
967 #'_date' => { op=>'>', value=>$self->_date },
968 'invnum' => { op=>'>', value=>$self->invnum },
975 =item send_csv OPTION => VALUE, ...
977 Sends invoice as a CSV data-file to a remote host with the specified protocol.
981 protocol - currently only "ftp"
987 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
988 and YYMMDDHHMMSS is a timestamp.
990 See L</print_csv> for a description of the output format.
995 my($self, %opt) = @_;
999 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1000 mkdir $spooldir, 0700 unless -d $spooldir;
1002 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1003 my $file = "$spooldir/$tracctnum.csv";
1005 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1007 open(CSV, ">$file") or die "can't open $file: $!";
1015 if ( $opt{protocol} eq 'ftp' ) {
1016 eval "use Net::FTP;";
1018 $net = Net::FTP->new($opt{server}) or die @$;
1020 die "unknown protocol: $opt{protocol}";
1023 $net->login( $opt{username}, $opt{password} )
1024 or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
1026 $net->binary or die "can't set binary mode";
1028 $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
1030 $net->put($file) or die "can't put $file: $!";
1040 Spools CSV invoice data.
1046 =item format - 'default' or 'billco'
1048 =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>).
1050 =item agent_spools - if set to a true value, will spool to per-agent files rather than a single global file
1052 =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.
1059 my($self, %opt) = @_;
1061 my $cust_main = $self->cust_main;
1063 if ( $opt{'dest'} ) {
1064 my %invoicing_list = map { /^(POST|FAX)$/ or 'EMAIL' =~ /^(.*)$/; $1 => 1 }
1065 $cust_main->invoicing_list;
1066 return 'N/A' unless $invoicing_list{$opt{'dest'}}
1067 || ! keys %invoicing_list;
1070 if ( $opt{'balanceover'} ) {
1072 if $cust_main->total_owed_date($self->_date) < $opt{'balanceover'};
1075 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1076 mkdir $spooldir, 0700 unless -d $spooldir;
1078 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1082 ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1083 ( lc($opt{'format'}) eq 'billco' ? '-header' : '' ) .
1086 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1088 open(CSV, ">>$file") or die "can't open $file: $!";
1089 flock(CSV, LOCK_EX);
1094 if ( lc($opt{'format'}) eq 'billco' ) {
1096 flock(CSV, LOCK_UN);
1101 ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1104 open(CSV,">>$file") or die "can't open $file: $!";
1105 flock(CSV, LOCK_EX);
1111 flock(CSV, LOCK_UN);
1118 =item print_csv OPTION => VALUE, ...
1120 Returns CSV data for this invoice.
1124 format - 'default' or 'billco'
1126 Returns a list consisting of two scalars. The first is a single line of CSV
1127 header information for this invoice. The second is one or more lines of CSV
1128 detail information for this invoice.
1130 If I<format> is not specified or "default", the fields of the CSV file are as
1133 record_type, invnum, custnum, _date, charged, first, last, company, address1, address2, city, state, zip, country, pkg, setup, recur, sdate, edate
1137 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
1139 B<record_type> is C<cust_bill> for the initial header line only. The
1140 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
1141 fields are filled in.
1143 B<record_type> is C<cust_bill_pkg> for detail lines. Only the first two fields
1144 (B<record_type> and B<invnum>) and the last five fields (B<pkg> through B<edate>)
1147 =item invnum - invoice number
1149 =item custnum - customer number
1151 =item _date - invoice date
1153 =item charged - total invoice amount
1155 =item first - customer first name
1157 =item last - customer first name
1159 =item company - company name
1161 =item address1 - address line 1
1163 =item address2 - address line 1
1173 =item pkg - line item description
1175 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
1177 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
1179 =item sdate - start date for recurring fee
1181 =item edate - end date for recurring fee
1185 If I<format> is "billco", the fields of the header CSV file are as follows:
1187 +-------------------------------------------------------------------+
1188 | FORMAT HEADER FILE |
1189 |-------------------------------------------------------------------|
1190 | Field | Description | Name | Type | Width |
1191 | 1 | N/A-Leave Empty | RC | CHAR | 2 |
1192 | 2 | N/A-Leave Empty | CUSTID | CHAR | 15 |
1193 | 3 | Transaction Account No | TRACCTNUM | CHAR | 15 |
1194 | 4 | Transaction Invoice No | TRINVOICE | CHAR | 15 |
1195 | 5 | Transaction Zip Code | TRZIP | CHAR | 5 |
1196 | 6 | Transaction Company Bill To | TRCOMPANY | CHAR | 30 |
1197 | 7 | Transaction Contact Bill To | TRNAME | CHAR | 30 |
1198 | 8 | Additional Address Unit Info | TRADDR1 | CHAR | 30 |
1199 | 9 | Bill To Street Address | TRADDR2 | CHAR | 30 |
1200 | 10 | Ancillary Billing Information | TRADDR3 | CHAR | 30 |
1201 | 11 | Transaction City Bill To | TRCITY | CHAR | 20 |
1202 | 12 | Transaction State Bill To | TRSTATE | CHAR | 2 |
1203 | 13 | Bill Cycle Close Date | CLOSEDATE | CHAR | 10 |
1204 | 14 | Bill Due Date | DUEDATE | CHAR | 10 |
1205 | 15 | Previous Balance | BALFWD | NUM* | 9 |
1206 | 16 | Pmt/CR Applied | CREDAPPLY | NUM* | 9 |
1207 | 17 | Total Current Charges | CURRENTCHG | NUM* | 9 |
1208 | 18 | Total Amt Due | TOTALDUE | NUM* | 9 |
1209 | 19 | Total Amt Due | AMTDUE | NUM* | 9 |
1210 | 20 | 30 Day Aging | AMT30 | NUM* | 9 |
1211 | 21 | 60 Day Aging | AMT60 | NUM* | 9 |
1212 | 22 | 90 Day Aging | AMT90 | NUM* | 9 |
1213 | 23 | Y/N | AGESWITCH | CHAR | 1 |
1214 | 24 | Remittance automation | SCANLINE | CHAR | 100 |
1215 | 25 | Total Taxes & Fees | TAXTOT | NUM* | 9 |
1216 | 26 | Customer Reference Number | CUSTREF | CHAR | 15 |
1217 | 27 | Federal Tax*** | FEDTAX | NUM* | 9 |
1218 | 28 | State Tax*** | STATETAX | NUM* | 9 |
1219 | 29 | Other Taxes & Fees*** | OTHERTAX | NUM* | 9 |
1220 +-------+-------------------------------+------------+------+-------+
1222 If I<format> is "billco", the fields of the detail CSV file are as follows:
1224 FORMAT FOR DETAIL FILE
1226 Field | Description | Name | Type | Width
1227 1 | N/A-Leave Empty | RC | CHAR | 2
1228 2 | N/A-Leave Empty | CUSTID | CHAR | 15
1229 3 | Account Number | TRACCTNUM | CHAR | 15
1230 4 | Invoice Number | TRINVOICE | CHAR | 15
1231 5 | Line Sequence (sort order) | LINESEQ | NUM | 6
1232 6 | Transaction Detail | DETAILS | CHAR | 100
1233 7 | Amount | AMT | NUM* | 9
1234 8 | Line Format Control** | LNCTRL | CHAR | 2
1235 9 | Grouping Code | GROUP | CHAR | 2
1236 10 | User Defined | ACCT CODE | CHAR | 15
1241 my($self, %opt) = @_;
1243 eval "use Text::CSV_XS";
1246 my $cust_main = $self->cust_main;
1248 my $csv = Text::CSV_XS->new({'always_quote'=>1});
1250 if ( lc($opt{'format'}) eq 'billco' ) {
1253 $taxtotal += $_->{'amount'} foreach $self->_items_tax;
1255 my $duedate = $self->due_date2str('%m/%d/%Y'); #date_format?
1257 my( $previous_balance, @unused ) = $self->previous; #previous balance
1259 my $pmt_cr_applied = 0;
1260 $pmt_cr_applied += $_->{'amount'}
1261 foreach ( $self->_items_payments, $self->_items_credits ) ;
1263 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
1266 '', # 1 | N/A-Leave Empty CHAR 2
1267 '', # 2 | N/A-Leave Empty CHAR 15
1268 $opt{'tracctnum'}, # 3 | Transaction Account No CHAR 15
1269 $self->invnum, # 4 | Transaction Invoice No CHAR 15
1270 $cust_main->zip, # 5 | Transaction Zip Code CHAR 5
1271 $cust_main->company, # 6 | Transaction Company Bill To CHAR 30
1272 #$cust_main->payname, # 7 | Transaction Contact Bill To CHAR 30
1273 $cust_main->contact, # 7 | Transaction Contact Bill To CHAR 30
1274 $cust_main->address2, # 8 | Additional Address Unit Info CHAR 30
1275 $cust_main->address1, # 9 | Bill To Street Address CHAR 30
1276 '', # 10 | Ancillary Billing Information CHAR 30
1277 $cust_main->city, # 11 | Transaction City Bill To CHAR 20
1278 $cust_main->state, # 12 | Transaction State Bill To CHAR 2
1281 time2str("%m/%d/%Y", $self->_date), # 13 | Bill Cycle Close Date CHAR 10
1284 $duedate, # 14 | Bill Due Date CHAR 10
1286 $previous_balance, # 15 | Previous Balance NUM* 9
1287 $pmt_cr_applied, # 16 | Pmt/CR Applied NUM* 9
1288 sprintf("%.2f", $self->charged), # 17 | Total Current Charges NUM* 9
1289 $totaldue, # 18 | Total Amt Due NUM* 9
1290 $totaldue, # 19 | Total Amt Due NUM* 9
1291 '', # 20 | 30 Day Aging NUM* 9
1292 '', # 21 | 60 Day Aging NUM* 9
1293 '', # 22 | 90 Day Aging NUM* 9
1294 'N', # 23 | Y/N CHAR 1
1295 '', # 24 | Remittance automation CHAR 100
1296 $taxtotal, # 25 | Total Taxes & Fees NUM* 9
1297 $self->custnum, # 26 | Customer Reference Number CHAR 15
1298 '0', # 27 | Federal Tax*** NUM* 9
1299 sprintf("%.2f", $taxtotal), # 28 | State Tax*** NUM* 9
1300 '0', # 29 | Other Taxes & Fees*** NUM* 9
1309 time2str("%x", $self->_date),
1310 sprintf("%.2f", $self->charged),
1311 ( map { $cust_main->getfield($_) }
1312 qw( first last company address1 address2 city state zip country ) ),
1314 ) or die "can't create csv";
1317 my $header = $csv->string. "\n";
1320 if ( lc($opt{'format'}) eq 'billco' ) {
1323 foreach my $item ( $self->_items_pkg ) {
1326 '', # 1 | N/A-Leave Empty CHAR 2
1327 '', # 2 | N/A-Leave Empty CHAR 15
1328 $opt{'tracctnum'}, # 3 | Account Number CHAR 15
1329 $self->invnum, # 4 | Invoice Number CHAR 15
1330 $lineseq++, # 5 | Line Sequence (sort order) NUM 6
1331 $item->{'description'}, # 6 | Transaction Detail CHAR 100
1332 $item->{'amount'}, # 7 | Amount NUM* 9
1333 '', # 8 | Line Format Control** CHAR 2
1334 '', # 9 | Grouping Code CHAR 2
1335 '', # 10 | User Defined CHAR 15
1338 $detail .= $csv->string. "\n";
1344 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1346 my($pkg, $setup, $recur, $sdate, $edate);
1347 if ( $cust_bill_pkg->pkgnum ) {
1349 ($pkg, $setup, $recur, $sdate, $edate) = (
1350 $cust_bill_pkg->cust_pkg->part_pkg->pkg,
1351 ( $cust_bill_pkg->setup != 0
1352 ? sprintf("%.2f", $cust_bill_pkg->setup )
1354 ( $cust_bill_pkg->recur != 0
1355 ? sprintf("%.2f", $cust_bill_pkg->recur )
1357 ( $cust_bill_pkg->sdate
1358 ? time2str("%x", $cust_bill_pkg->sdate)
1360 ($cust_bill_pkg->edate
1361 ?time2str("%x", $cust_bill_pkg->edate)
1365 } else { #pkgnum tax
1366 next unless $cust_bill_pkg->setup != 0;
1367 my $itemdesc = defined $cust_bill_pkg->dbdef_table->column('itemdesc')
1368 ? ( $cust_bill_pkg->itemdesc || 'Tax' )
1370 ($pkg, $setup, $recur, $sdate, $edate) =
1371 ( $itemdesc, sprintf("%10.2f",$cust_bill_pkg->setup), '', '', '' );
1377 ( map { '' } (1..11) ),
1378 ($pkg, $setup, $recur, $sdate, $edate)
1379 ) or die "can't create csv";
1381 $detail .= $csv->string. "\n";
1387 ( $header, $detail );
1393 Pays this invoice with a compliemntary payment. If there is an error,
1394 returns the error, otherwise returns false.
1400 my $cust_pay = new FS::cust_pay ( {
1401 'invnum' => $self->invnum,
1402 'paid' => $self->owed,
1405 'payinfo' => $self->cust_main->payinfo,
1413 Attempts to pay this invoice with a credit card payment via a
1414 Business::OnlinePayment realtime gateway. See
1415 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1416 for supported processors.
1422 $self->realtime_bop( 'CC', @_ );
1427 Attempts to pay this invoice with an electronic check (ACH) payment via a
1428 Business::OnlinePayment realtime gateway. See
1429 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1430 for supported processors.
1436 $self->realtime_bop( 'ECHECK', @_ );
1441 Attempts to pay this invoice with phone bill (LEC) payment via a
1442 Business::OnlinePayment realtime gateway. See
1443 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1444 for supported processors.
1450 $self->realtime_bop( 'LEC', @_ );
1454 my( $self, $method ) = @_;
1456 my $cust_main = $self->cust_main;
1457 my $balance = $cust_main->balance;
1458 my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
1459 $amount = sprintf("%.2f", $amount);
1460 return "not run (balance $balance)" unless $amount > 0;
1462 my $description = 'Internet Services';
1463 if ( $conf->exists('business-onlinepayment-description') ) {
1464 my $dtempl = $conf->config('business-onlinepayment-description');
1466 my $agent_obj = $cust_main->agent
1467 or die "can't retreive agent for $cust_main (agentnum ".
1468 $cust_main->agentnum. ")";
1469 my $agent = $agent_obj->agent;
1470 my $pkgs = join(', ',
1471 map { $_->cust_pkg->part_pkg->pkg }
1472 grep { $_->pkgnum } $self->cust_bill_pkg
1474 $description = eval qq("$dtempl");
1477 $cust_main->realtime_bop($method, $amount,
1478 'description' => $description,
1479 'invnum' => $self->invnum,
1484 =item batch_card OPTION => VALUE...
1486 Adds a payment for this invoice to the pending credit card batch (see
1487 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
1488 runs the payment using a realtime gateway.
1493 my ($self, %options) = @_;
1494 my $cust_main = $self->cust_main;
1496 $options{invnum} = $self->invnum;
1498 $cust_main->batch_card(%options);
1501 sub _agent_template {
1503 $self->cust_main->agent_template;
1506 sub _agent_invoice_from {
1508 $self->cust_main->agent_invoice_from;
1511 =item print_text [ TIME [ , TEMPLATE ] ]
1513 Returns an text invoice, as a list of lines.
1515 TIME an optional value used to control the printing of overdue messages. The
1516 default is now. It isn't the date of the invoice; that's the `_date' field.
1517 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1518 L<Time::Local> and L<Date::Parse> for conversion functions.
1523 my( $self, $today, $template ) = @_;
1525 my %params = ( 'format' => 'template' );
1526 $params{'time'} = $today if $today;
1527 $params{'template'} = $template if $template;
1529 $self->print_generic( %params );
1532 =item print_latex [ TIME [ , TEMPLATE ] ]
1534 Internal method - returns a filename of a filled-in LaTeX template for this
1535 invoice (Note: add ".tex" to get the actual filename), and a filename of
1536 an associated logo (with the .eps extension included).
1538 See print_ps and print_pdf for methods that return PostScript and PDF output.
1540 TIME an optional value used to control the printing of overdue messages. The
1541 default is now. It isn't the date of the invoice; that's the `_date' field.
1542 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1543 L<Time::Local> and L<Date::Parse> for conversion functions.
1549 my( $self, $today, $template ) = @_;
1551 my %params = ( 'format' => 'latex' );
1552 $params{'time'} = $today if $today;
1553 $params{'template'} = $template if $template;
1555 $template ||= $self->_agent_template;
1557 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1558 my $lh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
1562 ) or die "can't open temp file: $!\n";
1564 if ($template && $conf->exists("logo_${template}.eps")) {
1565 print $lh $conf->config_binary("logo_${template}.eps")
1566 or die "can't write temp file: $!\n";
1568 print $lh $conf->config_binary('logo.eps')
1569 or die "can't write temp file: $!\n";
1572 $params{'logo_file'} = $lh->filename;
1574 my @filled_in = $self->print_generic( %params );
1576 my $fh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
1580 ) or die "can't open temp file: $!\n";
1581 print $fh join('', @filled_in );
1584 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
1585 return ($1, $params{'logo_file'});
1589 =item print_generic OPTIONS_HASH
1591 Internal method - returns a filled-in template for this invoice as a scalar.
1593 See print_ps and print_pdf for methods that return PostScript and PDF output.
1595 Non optional options include
1596 format - latex, html, template
1598 Optional options include
1600 template - a value used as a suffix for a configuration template
1602 time - a value used to control the printing of overdue messages. The
1603 default is now. It isn't the date of the invoice; that's the `_date' field.
1604 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1605 L<Time::Local> and L<Date::Parse> for conversion functions.
1613 my( $self, %params ) = @_;
1614 my $today = $params{today} ? $params{today} : time;
1615 warn "FS::cust_bill::print_generic called on $self with suffix $params{template}\n"
1618 my $format = $params{format};
1619 die "Unknown format: $format"
1620 unless $format =~ /^(latex|html|template)$/;
1622 my $cust_main = $self->cust_main;
1623 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
1624 unless $cust_main->payname && $cust_main->payby !~ /^(CHEK|DCHK)$/;
1627 my %delimiters = ( 'latex' => [ '[@--', '--@]' ],
1628 'html' => [ '<%=', '%>' ],
1629 'template' => [ '{', '}' ],
1632 #create the template
1633 my $template = $params{template} ? $params{template} : $self->_agent_template;
1634 my $templatefile = "invoice_$format";
1635 $templatefile .= "_$template"
1636 if length($template);
1637 my @invoice_template = map "$_\n", $conf->config($templatefile)
1638 or die "cannot load config file $templatefile";
1641 if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
1642 #change this to a die when the old code is removed
1643 warn "old-style invoice template $templatefile; ".
1644 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
1645 $old_latex = 'true';
1646 @invoice_template = _translate_old_latex_format(@invoice_template);
1649 my $text_template = new Text::Template(
1651 SOURCE => \@invoice_template,
1652 DELIMITERS => $delimiters{$format},
1655 $text_template->compile()
1656 or die 'While compiling ' . $templatefile . ': ' . $Text::Template::ERROR;
1659 # additional substitution could possibly cause breakage in existing templates
1660 my %convert_maps = (
1662 'notes' => sub { map "$_", @_ },
1663 'footer' => sub { map "$_", @_ },
1664 'smallfooter' => sub { map "$_", @_ },
1665 'returnaddress' => sub { map "$_", @_ },
1671 s/%%(.*)$/<!-- $1 -->/g;
1672 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
1673 s/\\begin\{enumerate\}/<ol>/g;
1675 s/\\end\{enumerate\}/<\/ol>/g;
1676 s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
1683 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
1685 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
1690 s/\\\\\*?\s*$/<BR>/;
1691 s/\\hyphenation\{[\w\s\-]+}//;
1701 s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
1702 s/\\begin\{enumerate\}//g;
1704 s/\\end\{enumerate\}//g;
1705 s/\\textbf\{(.*)\}/$1/g;
1712 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
1714 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
1719 s/\\\\\*?\s*$/\n/; # dubious
1720 s/\\hyphenation\{[\w\s\-]+}//;
1728 # hashes for differing output formats
1729 my %nbsps = ( 'latex' => '~',
1730 'html' => '', # '&nbps;' would be nice
1731 'template' => '', # not used
1733 my $nbsp = $nbsps{$format};
1735 my %escape_functions = ( 'latex' => \&_latex_escape,
1736 'html' => \&encode_entities,
1737 'template' => sub { shift },
1739 my $escape_function = $escape_functions{$format};
1741 my %date_formats = ( 'latex' => '%b, %o, %Y',
1742 'html' => '%b %o, %Y',
1745 my $date_format = $date_formats{$format};
1747 my %embolden_functions = ( 'latex' => sub { return '\textbf{'. shift(). '}'
1749 'html' => sub { return '<b>'. shift(). '</b>'
1751 'template' => sub { shift },
1753 my $embolden_function = $embolden_functions{$format};
1756 # generate template variables
1759 defined( $conf->config_orbase( "invoice_${format}returnaddress",
1763 && length( $conf->config_orbase( "invoice_${format}returnaddress",
1769 $returnaddress = join("\n",
1770 $conf->config_orbase("invoice_${format}returnaddress", $template)
1773 } elsif ( grep /\S/,
1774 $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
1776 my $convert_map = $convert_maps{$format}{'returnaddress'};
1779 &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
1784 } elsif ( grep /\S/, $conf->config('company_address') ) {
1786 $returnaddress = join( "\n", $conf->config('company_address') );
1789 join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
1790 $conf->config('company_address')
1792 if $format eq 'latex';
1796 my $warning = "Couldn't find a return address; ".
1797 "do you need to set the company_address configuration value?";
1799 $returnaddress = $nbsp;
1800 #$returnaddress = $warning;
1804 my %invoice_data = (
1805 'company_name' => scalar( $conf->config('company_name') ),
1806 'company_address' => join("\n", $conf->config('company_address') ). "\n",
1807 'custnum' => $self->custnum,
1808 'invnum' => $self->invnum,
1809 'date' => time2str($date_format, $self->_date),
1810 'today' => time2str('%b %o, %Y', $today),
1811 'agent' => &$escape_function($cust_main->agent->agent),
1812 'payname' => &$escape_function($cust_main->payname),
1813 'company' => &$escape_function($cust_main->company),
1814 'address1' => &$escape_function($cust_main->address1),
1815 'address2' => &$escape_function($cust_main->address2),
1816 'city' => &$escape_function($cust_main->city),
1817 'state' => &$escape_function($cust_main->state),
1818 'zip' => &$escape_function($cust_main->zip),
1819 'returnaddress' => $returnaddress,
1821 'terms' => $self->terms,
1822 'template' => $params{'template'},
1823 #'notes' => join("\n", $conf->config('invoice_latexnotes') ),
1824 # better hang on to conf_dir for a while
1825 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
1830 $invoice_data{'cid'} = $params{'cid'}
1833 my $countrydefault = $conf->config('countrydefault') || 'US';
1834 if ( $cust_main->country eq $countrydefault ) {
1835 $invoice_data{'country'} = '';
1837 $invoice_data{'country'} = &$escape_function(code2country($cust_main->country));
1841 $invoice_data{'address'} = \@address;
1843 $cust_main->payname.
1844 ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
1845 ? " (P.O. #". $cust_main->payinfo. ")"
1849 push @address, $cust_main->company
1850 if $cust_main->company;
1851 push @address, $cust_main->address1;
1852 push @address, $cust_main->address2
1853 if $cust_main->address2;
1855 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
1856 push @address, $invoice_data{'country'}
1857 if $invoice_data{'country'};
1859 while (scalar(@address) < 5);
1861 #do variable substitution in notes, footer, smallfooter
1862 foreach my $include (qw( notes footer smallfooter )) {
1864 my @inc_src = $conf->config_orbase("invoice_latex$include", $template );
1865 my $convert_map = $convert_maps{$format}{$include};
1868 defined( $conf->config_orbase("invoice_${format}$include", $template) )
1869 && length( $conf->config_orbase('invoice_${format}$include', $template) )
1871 @inc_src = $conf->config_orbase("invoice_${format}$include", $template );
1874 map { s/\[@--/$delimiters{$format}[0]/g;
1875 s/--@]/$delimiters{$format}[1]/g;
1879 $conf->config_orbase("invoice_latex$include", $template )
1883 my $inc_tt = new Text::Template (
1885 SOURCE => [ map "$_\n", @inc_src ],
1886 DELIMITERS => $delimiters{$format},
1887 ) or die "can't create new Text::Template object: $Text::Template::ERROR";
1890 or die "can't compile template: $Text::Template::ERROR";
1892 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1894 $invoice_data{$include} =~ s/\n+$//
1895 if ($format eq 'latex');
1898 $invoice_data{'po_line'} =
1899 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
1900 ? &$escape_function("Purchase Order #". $cust_main->payinfo)
1903 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
1904 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
1905 #my $balance_due = $self->owed + $pr_total - $cr_total;
1906 my $balance_due = $self->owed + $pr_total;
1908 my %money_chars = ( 'latex' => '',
1909 'html' => $conf->config('money_char') || '$',
1912 my $money_char = $money_chars{$format};
1914 my %other_money_chars = ( 'latex' => '\dollar ',
1915 'html' => $conf->config('money_char') || '$',
1918 my $other_money_char = $other_money_chars{$format};
1920 my @detail_items = ();
1921 my @total_items = ();
1925 $invoice_data{'detail_items'} = \@detail_items;
1926 $invoice_data{'total_items'} = \@total_items;
1927 $invoice_data{'buf'} = \@buf;
1928 $invoice_data{'sections'} = \@sections;
1930 my $previous_section = { 'description' => 'Previous Charges',
1931 'subtotal' => $other_money_char.
1932 sprintf('%.2f', $pr_total),
1935 my $multisection = $conf->exists('invoice_sections', $cust_main->agentnum);
1936 if ( $multisection ) {
1937 push @sections, $self->_items_sections;
1939 push @sections, { 'description' => '', 'subtotal' => '' };
1942 foreach my $line_item ( $self->_items_previous ) {
1944 ext_description => [],
1946 $detail->{'ref'} = $line_item->{'pkgnum'};
1947 $detail->{'quantity'} = 1;
1948 $detail->{'section'} = $previous_section;
1949 $detail->{'description'} = &$escape_function($line_item->{'description'});
1950 if ( exists $line_item->{'ext_description'} ) {
1951 @{$detail->{'ext_description'}} = map {
1952 &$escape_function($_);
1953 } @{$line_item->{'ext_description'}};
1956 my $money = $old_latex ? '' : $money_char;
1957 $detail->{'amount'} = $money. $line_item->{'amount'};
1959 $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
1961 push @detail_items, $detail;
1962 push @buf, [ $detail->{'description'},
1963 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1967 if (@pr_cust_bill) {
1968 push @buf, ['','-----------'];
1969 push @buf, [ 'Total Previous Balance',
1970 $money_char. sprintf("%10.2f", $pr_total) ];
1974 foreach my $section (@sections) {
1976 $section->{'subtotal'} = $other_money_char.
1977 sprintf('%.2f', $section->{'subtotal'})
1980 if ( $section->{'description'} ) {
1981 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
1987 $options{'section'} = $section if $multisection;
1989 foreach my $line_item ( $self->_items_pkg(%options) ) {
1991 ext_description => [],
1993 $detail->{'ref'} = $line_item->{'pkgnum'};
1994 $detail->{'quantity'} = 1;
1995 $detail->{'section'} = $section;
1996 $detail->{'description'} = &$escape_function($line_item->{'description'});
1997 if ( exists $line_item->{'ext_description'} ) {
1998 @{$detail->{'ext_description'}} = map {
1999 &$escape_function($_);
2000 } @{$line_item->{'ext_description'}};
2003 my $money = $old_latex ? '' : $money_char;
2004 $detail->{'amount'} = $money. $line_item->{'amount'};
2006 $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
2008 push @detail_items, $detail;
2009 push @buf, ( [ $detail->{'description'},
2010 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
2012 map { [ " ". $_, '' ] } @{$detail->{'ext_description'}},
2016 if ( $section->{'description'} ) {
2017 push @buf, ( ['','-----------'],
2018 [ $section->{'description'}. ' sub-total',
2019 $money_char. sprintf("%10.2f", $section->{'subtotal'})
2028 if ( $multisection ) {
2029 unshift @sections, $previous_section;
2033 foreach my $tax ( $self->_items_tax ) {
2035 $total->{'total_item'} = &$escape_function($tax->{'description'});
2036 $taxtotal += $tax->{'amount'};
2037 $total->{'total_amount'} = $other_money_char. $tax->{'amount'};
2038 push @total_items, $total;
2039 push @buf,[ $total->{'total_item'},
2040 $money_char. sprintf("%10.2f", $total->{'total_amount'}),
2047 if ( $multisection ) {
2048 $total->{'total_item'} = 'New charges sub-total';
2050 $total->{'total_item'} = 'Sub-total';
2052 $total->{'total_amount'} =
2053 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
2054 unshift @total_items, $total;
2057 push @buf,['','-----------'];
2058 push @buf,['Total New Charges',
2059 $money_char. sprintf("%10.2f",$self->charged) ];
2064 $total->{'total_item'} = &$embolden_function('Total');
2065 $total->{'total_amount'} =
2066 $total->{'total_amount'} =
2067 &$embolden_function(
2068 $other_money_char. sprintf('%.2f', $self->charged + $pr_total )
2070 push @total_items, $total;
2071 push @buf,['','-----------'];
2072 push @buf,['Total Charges',
2073 $money_char. sprintf("%10.2f",$self->charged + $pr_total) ];
2078 #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
2081 foreach my $credit ( $self->_items_credits ) {
2083 $total->{'total_item'} = &$escape_function($credit->{'description'});
2085 $total->{'total_amount'} = '-'. $other_money_char. $credit->{'amount'};
2086 push @total_items, $total;
2090 foreach ( $self->cust_credited ) {
2092 #something more elaborate if $_->amount ne $_->cust_credit->credited ?
2094 my $reason = substr($_->cust_credit->reason,0,32);
2095 $reason .= '...' if length($reason) < length($_->cust_credit->reason);
2096 $reason = " ($reason) " if $reason;
2098 "Credit #". $_->crednum. " (". time2str("%x",$_->cust_credit->_date) .")". $reason,
2099 $money_char. sprintf("%10.2f",$_->amount)
2104 foreach my $payment ( $self->_items_payments ) {
2106 $total->{'total_item'} = &$escape_function($payment->{'description'});
2108 $total->{'total_amount'} = '-'. $other_money_char. $payment->{'amount'};
2109 push @total_items, $total;
2110 push @buf, [ $payment->{'description'},
2111 $money_char. sprintf("%10.2f", $payment->{'amount'}),
2117 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
2118 $total->{'total_amount'} =
2119 &$embolden_function(
2120 $other_money_char. sprintf('%.2f', $self->owed + $pr_total )
2122 push @total_items, $total;
2123 push @buf,['','-----------'];
2124 push @buf,[$self->balance_due_msg, $money_char.
2125 sprintf("%10.2f", $balance_due ) ];
2128 $invoice_data{'logo_file'} = $params{'logo_file'}
2129 if $params{'logo_file'};
2133 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
2134 /invoice_lines\((\d*)\)/;
2135 $invoice_lines += $1 || scalar(@buf);
2138 die "no invoice_lines() functions in template?"
2139 if ( $format eq 'template' && !$wasfunc );
2141 if ($format eq 'template') {
2143 if ( $invoice_lines ) {
2144 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
2145 $invoice_data{'total_pages'}++
2146 if scalar(@buf) % $invoice_lines;
2149 #setup subroutine for the template
2150 sub FS::cust_bill::_template::invoice_lines {
2151 my $lines = shift || scalar(@FS::cust_bill::_template::buf);
2153 scalar(@FS::cust_bill::_template::buf)
2154 ? shift @FS::cust_bill::_template::buf
2163 push @collect, split("\n",
2164 $text_template->fill_in( HASH => \%invoice_data,
2165 PACKAGE => 'FS::cust_bill::_template'
2168 $FS::cust_bill::_template::page++;
2170 map "$_\n", @collect;
2172 warn "filling in template for invoice ". $self->invnum. "\n"
2174 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
2177 $text_template->fill_in(HASH => \%invoice_data);
2181 =item print_ps [ TIME [ , TEMPLATE ] ]
2183 Returns an postscript invoice, as a scalar.
2185 TIME an optional value used to control the printing of overdue messages. The
2186 default is now. It isn't the date of the invoice; that's the `_date' field.
2187 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2188 L<Time::Local> and L<Date::Parse> for conversion functions.
2195 my ($file, $lfile) = $self->print_latex(@_);
2196 my $ps = generate_ps($file);
2202 =item print_pdf [ TIME [ , TEMPLATE ] ]
2204 Returns an PDF invoice, as a scalar.
2206 TIME an optional value used to control the printing of overdue messages. The
2207 default is now. It isn't the date of the invoice; that's the `_date' field.
2208 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2209 L<Time::Local> and L<Date::Parse> for conversion functions.
2216 my ($file, $lfile) = $self->print_latex(@_);
2218 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2221 #system('pdflatex', "$file.tex");
2222 #system('pdflatex', "$file.tex");
2223 #! LaTeX Error: Unknown graphics extension: .eps.
2225 my $sfile = shell_quote $file;
2227 system("pslatex $sfile.tex >/dev/null 2>&1") == 0
2228 or die "pslatex $file.tex failed; see $file.log for details?\n";
2229 system("pslatex $sfile.tex >/dev/null 2>&1") == 0
2230 or die "pslatex $file.tex failed; see $file.log for details?\n";
2232 #system('dvipdf', "$file.dvi", "$file.pdf" );
2234 "dvips -q -t letter -f $sfile.dvi ".
2235 "| gs -q -dNOPAUSE -dBATCH -sDEVICE=pdfwrite -sOutputFile=$sfile.pdf ".
2238 or die "dvips | gs failed: $!";
2240 open(PDF, "<$file.pdf")
2241 or die "can't open $file.pdf: $! (error in LaTeX template?)\n";
2243 unlink("$file.dvi", "$file.log", "$file.aux", "$file.pdf", "$file.tex");
2257 =item print_html [ TIME [ , TEMPLATE [ , CID ] ] ]
2259 Returns an HTML invoice, as a scalar.
2261 TIME an optional value used to control the printing of overdue messages. The
2262 default is now. It isn't the date of the invoice; that's the `_date' field.
2263 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2264 L<Time::Local> and L<Date::Parse> for conversion functions.
2266 CID is a MIME Content-ID used to create a "cid:" URL for the logo image, used
2267 when emailing the invoice as part of a multipart/related MIME email.
2272 my( $self, $today, $template, $cid ) = @_;
2274 my %params = ( 'format' => 'html' );
2275 $params{'time'} = $today if $today;
2276 $params{'template'} = $template if $template;
2277 $params{'cid'} = $cid if $cid;
2279 $self->print_generic( %params );
2282 # quick subroutine for print_latex
2284 # There are ten characters that LaTeX treats as special characters, which
2285 # means that they do not simply typeset themselves:
2286 # # $ % & ~ _ ^ \ { }
2288 # TeX ignores blanks following an escaped character; if you want a blank (as
2289 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
2293 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
2294 $value =~ s/([<>])/\$$1\$/g;
2298 #utility methods for print_*
2300 sub _translate_old_latex_format {
2301 warn "_translate_old_latex_format called\n"
2308 if ( $line =~ /^%%Detail\s*$/ ) {
2310 push @template, q![@--!,
2311 q! foreach my $_tr_line (@detail_items) {!,
2312 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
2313 q! $_tr_line->{'description'} .= !,
2314 q! "\\tabularnewline\n~~".!,
2315 q! join( "\\tabularnewline\n~~",!,
2316 q! @{$_tr_line->{'ext_description'}}!,
2320 while ( ( my $line_item_line = shift )
2321 !~ /^%%EndDetail\s*$/ ) {
2322 $line_item_line =~ s/'/\\'/g; # nice LTS
2323 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
2324 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
2325 push @template, " \$OUT .= '$line_item_line';";
2328 push @template, '}',
2331 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
2333 push @template, '[@--',
2334 ' foreach my $_tr_line (@total_items) {';
2336 while ( ( my $total_item_line = shift )
2337 !~ /^%%EndTotalDetails\s*$/ ) {
2338 $total_item_line =~ s/'/\\'/g; # nice LTS
2339 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
2340 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
2341 push @template, " \$OUT .= '$total_item_line';";
2344 push @template, '}',
2348 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
2349 push @template, $line;
2355 warn "$_\n" foreach @template;
2364 #check for an invoice- specific override (eventually)
2366 #check for a customer- specific override
2367 return $self->cust_main->invoice_terms
2368 if $self->cust_main->invoice_terms;
2370 #use configured default or default default
2371 $conf->config('invoice_default_terms') || 'Payable upon receipt';
2377 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
2378 $duedate = $self->_date() + ( $1 * 86400 );
2385 $self->due_date ? time2str(shift, $self->due_date) : '';
2388 sub balance_due_msg {
2390 my $msg = 'Balance Due';
2391 return $msg unless $self->terms;
2392 if ( $self->due_date ) {
2393 $msg .= ' - Please pay by '. $self->due_date2str('%x');
2394 } elsif ( $self->terms ) {
2395 $msg .= ' - '. $self->terms;
2400 sub _items_sections {
2404 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2406 if ( $cust_bill_pkg->pkgnum > 0 ) {
2408 my $desc = $cust_bill_pkg->cust_pkg->part_pkg->classname;
2410 $s{$desc} += $cust_bill_pkg->setup
2411 if ( $cust_bill_pkg->setup != 0 );
2413 $s{$desc} += $cust_bill_pkg->recur
2414 if ( $cust_bill_pkg->recur != 0 );
2420 map { {'description' => $_, 'subtotal' => $s{$_}} } sort keys %s;
2426 my @display = scalar(@_)
2428 : qw( _items_previous _items_pkg );
2429 #: qw( _items_pkg );
2430 #: qw( _items_previous _items_pkg _items_tax _items_credits _items_payments );
2432 foreach my $display ( @display ) {
2433 push @b, $self->$display(@_);
2438 sub _items_previous {
2440 my $cust_main = $self->cust_main;
2441 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2443 foreach ( @pr_cust_bill ) {
2445 'description' => 'Previous Balance, Invoice #'. $_->invnum.
2446 ' ('. time2str('%x',$_->_date). ')',
2447 #'pkgpart' => 'N/A',
2449 'amount' => sprintf("%.2f", $_->owed),
2455 # 'description' => 'Previous Balance',
2456 # #'pkgpart' => 'N/A',
2457 # 'pkgnum' => 'N/A',
2458 # 'amount' => sprintf("%10.2f", $pr_total ),
2459 # 'ext_description' => [ map {
2460 # "Invoice ". $_->invnum.
2461 # " (". time2str("%x",$_->_date). ") ".
2462 # sprintf("%10.2f", $_->owed)
2463 # } @pr_cust_bill ],
2471 my $section = delete $options{'section'};
2473 grep { $_->pkgnum &&
2475 ? $_->cust_pkg->part_pkg->classname eq $section->{'description'}
2478 } $self->cust_bill_pkg;
2479 $self->_items_cust_bill_pkg(\@cust_bill_pkg, %options);
2484 my @cust_bill_pkg = grep { ! $_->pkgnum } $self->cust_bill_pkg;
2485 $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2488 sub _items_cust_bill_pkg {
2490 my $cust_bill_pkg = shift;
2493 foreach my $cust_bill_pkg ( @$cust_bill_pkg ) {
2495 my $desc = $cust_bill_pkg->desc;
2497 if ( $cust_bill_pkg->pkgnum > 0 ) {
2499 if ( $cust_bill_pkg->setup != 0 ) {
2500 my $description = $desc;
2501 $description .= ' Setup' if $cust_bill_pkg->recur != 0;
2502 my @d = $cust_bill_pkg->cust_pkg->h_labels_short($self->_date);
2503 push @d, $cust_bill_pkg->details if $cust_bill_pkg->recur == 0;
2505 description => $description,
2506 #pkgpart => $part_pkg->pkgpart,
2507 pkgnum => $cust_bill_pkg->pkgnum,
2508 amount => sprintf("%.2f", $cust_bill_pkg->setup),
2509 ext_description => \@d,
2513 if ( $cust_bill_pkg->recur != 0 ) {
2515 description => $desc .
2516 ( $conf->exists('disable_line_item_date_ranges')
2518 : " (" .time2str("%x", $cust_bill_pkg->sdate).
2519 " - ".time2str("%x", $cust_bill_pkg->edate).")"
2521 #pkgpart => $part_pkg->pkgpart,
2522 pkgnum => $cust_bill_pkg->pkgnum,
2523 amount => sprintf("%.2f", $cust_bill_pkg->recur),
2525 [ $cust_bill_pkg->cust_pkg->h_labels_short( $cust_bill_pkg->edate,
2526 $cust_bill_pkg->sdate),
2527 $cust_bill_pkg->details,
2532 } else { #pkgnum tax or one-shot line item (??)
2534 if ( $cust_bill_pkg->setup != 0 ) {
2536 'description' => $desc,
2537 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
2540 if ( $cust_bill_pkg->recur != 0 ) {
2542 'description' => "$desc (".
2543 time2str("%x", $cust_bill_pkg->sdate). ' - '.
2544 time2str("%x", $cust_bill_pkg->edate). ')',
2545 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
2557 sub _items_credits {
2562 foreach ( $self->cust_credited ) {
2564 #something more elaborate if $_->amount ne $_->cust_credit->credited ?
2566 my $reason = $_->cust_credit->reason;
2567 #my $reason = substr($_->cust_credit->reason,0,32);
2568 #$reason .= '...' if length($reason) < length($_->cust_credit->reason);
2569 $reason = " ($reason) " if $reason;
2571 #'description' => 'Credit ref\#'. $_->crednum.
2572 # " (". time2str("%x",$_->cust_credit->_date) .")".
2574 'description' => 'Credit applied '.
2575 time2str("%x",$_->cust_credit->_date). $reason,
2576 'amount' => sprintf("%.2f",$_->amount),
2579 #foreach ( @cr_cust_credit ) {
2581 # "Credit #". $_->crednum. " (" . time2str("%x",$_->_date) .")",
2582 # $money_char. sprintf("%10.2f",$_->credited)
2590 sub _items_payments {
2594 #get & print payments
2595 foreach ( $self->cust_bill_pay ) {
2597 #something more elaborate if $_->amount ne ->cust_pay->paid ?
2600 'description' => "Payment received ".
2601 time2str("%x",$_->cust_pay->_date ),
2602 'amount' => sprintf("%.2f", $_->amount )
2621 sub process_reprint {
2622 process_re_X('print', @_);
2629 sub process_reemail {
2630 process_re_X('email', @_);
2638 process_re_X('fax', @_);
2641 use Storable qw(thaw);
2645 my( $method, $job ) = ( shift, shift );
2646 warn "process_re_X $method for job $job\n" if $DEBUG;
2648 my $param = thaw(decode_base64(shift));
2649 warn Dumper($param) if $DEBUG;
2660 my($method, $job, %param ) = @_;
2662 warn "re_X $method for job $job with param:\n".
2663 join( '', map { " $_ => ". $param{$_}. "\n" } keys %param );
2666 #some false laziness w/search/cust_bill.html
2668 my $orderby = 'ORDER BY cust_bill._date';
2670 my $extra_sql = ' WHERE '. FS::cust_bill->search_sql(\%param);
2672 my $addl_from = 'left join cust_main using ( custnum )';
2674 my @cust_bill = qsearch( 'cust_bill',
2676 #"$distinct cust_bill.*",
2683 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
2684 foreach my $cust_bill ( @cust_bill ) {
2685 $cust_bill->$method();
2687 if ( $job ) { #progressbar foo
2689 if ( time - $min_sec > $last ) {
2690 my $error = $job->update_statustext(
2691 int( 100 * $num / scalar(@cust_bill) )
2693 die $error if $error;
2704 =head1 CLASS METHODS
2710 Returns an SQL fragment to retreive the amount owed (charged minus credited and paid).
2716 'charged - '. $class->paid_sql. ' - '. $class->credited_sql;
2721 Returns an SQL fragment to retreive the net amount (charged minus credited).
2727 'charged - '. $class->credited_sql;
2732 Returns an SQL fragment to retreive the amount paid against this invoice.
2738 "( SELECT COALESCE(SUM(amount),0) FROM cust_bill_pay
2739 WHERE cust_bill.invnum = cust_bill_pay.invnum )";
2744 Returns an SQL fragment to retreive the amount credited against this invoice.
2750 "( SELECT COALESCE(SUM(amount),0) FROM cust_credit_bill
2751 WHERE cust_bill.invnum = cust_credit_bill.invnum )";
2754 =item search_sql HASHREF
2756 Class method which returns an SQL WHERE fragment to search for parameters
2757 specified in HASHREF. Valid parameters are
2763 Epoch date (UNIX timestamp) setting a lower bound for _date values
2767 Epoch date (UNIX timestamp) setting an upper bound for _date values
2781 =item newest_percust
2785 Note: validates all passed-in data; i.e. safe to use with unchecked CGI params.
2790 my($class, $param) = @_;
2793 if ( $param->{'begin'} =~ /^(\d+)$/ ) {
2794 push @search, "cust_bill._date >= $1";
2796 if ( $param->{'end'} =~ /^(\d+)$/ ) {
2797 push @search, "cust_bill._date < $1";
2799 if ( $param->{'invnum_min'} =~ /^(\d+)$/ ) {
2800 push @search, "cust_bill.invnum >= $1";
2802 if ( $param->{'invnum_max'} =~ /^(\d+)$/ ) {
2803 push @search, "cust_bill.invnum <= $1";
2805 if ( $param->{'agentnum'} =~ /^(\d+)$/ ) {
2806 push @search, "cust_main.agentnum = $1";
2809 push @search, '0 != '. FS::cust_bill->owed_sql
2810 if $param->{'open'};
2812 push @search, '0 != '. FS::cust_bill->net_sql
2815 push @search, "cust_bill._date < ". (time-86400*$param->{'days'})
2816 if $param->{'days'};
2818 if ( $param->{'newest_percust'} ) {
2820 #$distinct = 'DISTINCT ON ( cust_bill.custnum )';
2821 #$orderby = 'ORDER BY cust_bill.custnum ASC, cust_bill._date DESC';
2823 my @newest_where = map { my $x = $_;
2824 $x =~ s/\bcust_bill\./newest_cust_bill./g;
2827 grep ! /^cust_main./, @search;
2828 my $newest_where = scalar(@newest_where)
2829 ? ' AND '. join(' AND ', @newest_where)
2833 push @search, "cust_bill._date = (
2834 SELECT(MAX(newest_cust_bill._date)) FROM cust_bill AS newest_cust_bill
2835 WHERE newest_cust_bill.custnum = cust_bill.custnum
2841 push @search, $FS::CurrentUser::CurrentUser->agentnums_sql;
2843 join(' AND ', @search );
2855 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
2856 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base