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.
801 AMOUNT, if specified, only sends the invoice if the total amount owed on this
802 invoice and all older invoices is greater than the specified amount.
809 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
810 or die "invalid invoice number: " . $opt{invnum};
812 my @args = ( $opt{template}, $opt{agentnum} );
813 push @args, $opt{invoice_from}
814 if exists($opt{invoice_from}) && $opt{invoice_from};
816 my $error = $self->send( @args );
817 die $error if $error;
823 my $template = scalar(@_) ? shift : '';
824 if ( scalar(@_) && $_[0] ) {
825 my $agentnums = ref($_[0]) ? shift : [ shift ];
826 return 'N/A' unless grep { $_ == $self->cust_main->agentnum } @$agentnums;
832 : ( $self->_agent_invoice_from || $conf->config('invoice_from') );
834 my $balance_over = ( scalar(@_) && $_[0] !~ /^\s*$/ ) ? shift : 0;
837 unless $self->cust_main->total_owed_date($self->_date) > $balance_over;
839 my @invoicing_list = $self->cust_main->invoicing_list;
841 $self->email($template, $invoice_from)
842 if grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list;
844 $self->print($template)
845 if grep { $_ eq 'POST' } @invoicing_list; #postal
847 $self->fax($template)
848 if grep { $_ eq 'FAX' } @invoicing_list; #fax
854 =item email [ TEMPLATENAME [ , INVOICE_FROM ] ]
858 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
860 INVOICE_FROM, if specified, overrides the default email invoice From: address.
864 sub queueable_email {
867 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
868 or die "invalid invoice number: " . $opt{invnum};
870 my @args = ( $opt{template} );
871 push @args, $opt{invoice_from}
872 if exists($opt{invoice_from}) && $opt{invoice_from};
874 my $error = $self->email( @args );
875 die $error if $error;
881 my $template = scalar(@_) ? shift : '';
885 : ( $self->_agent_invoice_from || $conf->config('invoice_from') );
887 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
888 $self->cust_main->invoicing_list;
890 #better to notify this person than silence
891 @invoicing_list = ($invoice_from) unless @invoicing_list;
893 my $error = send_email(
894 $self->generate_email(
895 'from' => $invoice_from,
896 'to' => [ grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list ],
897 'template' => $template,
900 die "can't email invoice: $error\n" if $error;
901 #die "$error\n" if $error;
905 =item lpr_data [ TEMPLATENAME ]
907 Returns the postscript or plaintext for this invoice as an arrayref.
909 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
914 my( $self, $template) = @_;
915 $conf->exists('invoice_latex')
916 ? [ $self->print_ps('', $template) ]
917 : [ $self->print_text('', $template) ];
920 =item print [ TEMPLATENAME ]
924 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
930 my $template = scalar(@_) ? shift : '';
932 do_print $self->lpr_data($template);
935 =item fax [ TEMPLATENAME ]
939 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
945 my $template = scalar(@_) ? shift : '';
947 die 'FAX invoice destination not (yet?) supported with plain text invoices.'
948 unless $conf->exists('invoice_latex');
950 my $dialstring = $self->cust_main->getfield('fax');
953 my $error = send_fax( 'docdata' => $self->lpr_data($template),
954 'dialstring' => $dialstring,
956 die $error if $error;
960 =item send_if_newest [ TEMPLATENAME [ , AGENTNUM [ , INVOICE_FROM ] ] ]
962 Like B<send>, but only sends the invoice if it is the newest open invoice for
972 grep { $_->owed > 0 }
973 qsearch('cust_bill', {
974 'custnum' => $self->custnum,
975 #'_date' => { op=>'>', value=>$self->_date },
976 'invnum' => { op=>'>', value=>$self->invnum },
983 =item send_csv OPTION => VALUE, ...
985 Sends invoice as a CSV data-file to a remote host with the specified protocol.
989 protocol - currently only "ftp"
995 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
996 and YYMMDDHHMMSS is a timestamp.
998 See L</print_csv> for a description of the output format.
1003 my($self, %opt) = @_;
1007 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1008 mkdir $spooldir, 0700 unless -d $spooldir;
1010 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1011 my $file = "$spooldir/$tracctnum.csv";
1013 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1015 open(CSV, ">$file") or die "can't open $file: $!";
1023 if ( $opt{protocol} eq 'ftp' ) {
1024 eval "use Net::FTP;";
1026 $net = Net::FTP->new($opt{server}) or die @$;
1028 die "unknown protocol: $opt{protocol}";
1031 $net->login( $opt{username}, $opt{password} )
1032 or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
1034 $net->binary or die "can't set binary mode";
1036 $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
1038 $net->put($file) or die "can't put $file: $!";
1048 Spools CSV invoice data.
1054 =item format - 'default' or 'billco'
1056 =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>).
1058 =item agent_spools - if set to a true value, will spool to per-agent files rather than a single global file
1060 =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.
1067 my($self, %opt) = @_;
1069 my $cust_main = $self->cust_main;
1071 if ( $opt{'dest'} ) {
1072 my %invoicing_list = map { /^(POST|FAX)$/ or 'EMAIL' =~ /^(.*)$/; $1 => 1 }
1073 $cust_main->invoicing_list;
1074 return 'N/A' unless $invoicing_list{$opt{'dest'}}
1075 || ! keys %invoicing_list;
1078 if ( $opt{'balanceover'} ) {
1080 if $cust_main->total_owed_date($self->_date) < $opt{'balanceover'};
1083 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1084 mkdir $spooldir, 0700 unless -d $spooldir;
1086 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1090 ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1091 ( lc($opt{'format'}) eq 'billco' ? '-header' : '' ) .
1094 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1096 open(CSV, ">>$file") or die "can't open $file: $!";
1097 flock(CSV, LOCK_EX);
1102 if ( lc($opt{'format'}) eq 'billco' ) {
1104 flock(CSV, LOCK_UN);
1109 ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1112 open(CSV,">>$file") or die "can't open $file: $!";
1113 flock(CSV, LOCK_EX);
1119 flock(CSV, LOCK_UN);
1126 =item print_csv OPTION => VALUE, ...
1128 Returns CSV data for this invoice.
1132 format - 'default' or 'billco'
1134 Returns a list consisting of two scalars. The first is a single line of CSV
1135 header information for this invoice. The second is one or more lines of CSV
1136 detail information for this invoice.
1138 If I<format> is not specified or "default", the fields of the CSV file are as
1141 record_type, invnum, custnum, _date, charged, first, last, company, address1, address2, city, state, zip, country, pkg, setup, recur, sdate, edate
1145 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
1147 B<record_type> is C<cust_bill> for the initial header line only. The
1148 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
1149 fields are filled in.
1151 B<record_type> is C<cust_bill_pkg> for detail lines. Only the first two fields
1152 (B<record_type> and B<invnum>) and the last five fields (B<pkg> through B<edate>)
1155 =item invnum - invoice number
1157 =item custnum - customer number
1159 =item _date - invoice date
1161 =item charged - total invoice amount
1163 =item first - customer first name
1165 =item last - customer first name
1167 =item company - company name
1169 =item address1 - address line 1
1171 =item address2 - address line 1
1181 =item pkg - line item description
1183 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
1185 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
1187 =item sdate - start date for recurring fee
1189 =item edate - end date for recurring fee
1193 If I<format> is "billco", the fields of the header CSV file are as follows:
1195 +-------------------------------------------------------------------+
1196 | FORMAT HEADER FILE |
1197 |-------------------------------------------------------------------|
1198 | Field | Description | Name | Type | Width |
1199 | 1 | N/A-Leave Empty | RC | CHAR | 2 |
1200 | 2 | N/A-Leave Empty | CUSTID | CHAR | 15 |
1201 | 3 | Transaction Account No | TRACCTNUM | CHAR | 15 |
1202 | 4 | Transaction Invoice No | TRINVOICE | CHAR | 15 |
1203 | 5 | Transaction Zip Code | TRZIP | CHAR | 5 |
1204 | 6 | Transaction Company Bill To | TRCOMPANY | CHAR | 30 |
1205 | 7 | Transaction Contact Bill To | TRNAME | CHAR | 30 |
1206 | 8 | Additional Address Unit Info | TRADDR1 | CHAR | 30 |
1207 | 9 | Bill To Street Address | TRADDR2 | CHAR | 30 |
1208 | 10 | Ancillary Billing Information | TRADDR3 | CHAR | 30 |
1209 | 11 | Transaction City Bill To | TRCITY | CHAR | 20 |
1210 | 12 | Transaction State Bill To | TRSTATE | CHAR | 2 |
1211 | 13 | Bill Cycle Close Date | CLOSEDATE | CHAR | 10 |
1212 | 14 | Bill Due Date | DUEDATE | CHAR | 10 |
1213 | 15 | Previous Balance | BALFWD | NUM* | 9 |
1214 | 16 | Pmt/CR Applied | CREDAPPLY | NUM* | 9 |
1215 | 17 | Total Current Charges | CURRENTCHG | NUM* | 9 |
1216 | 18 | Total Amt Due | TOTALDUE | NUM* | 9 |
1217 | 19 | Total Amt Due | AMTDUE | NUM* | 9 |
1218 | 20 | 30 Day Aging | AMT30 | NUM* | 9 |
1219 | 21 | 60 Day Aging | AMT60 | NUM* | 9 |
1220 | 22 | 90 Day Aging | AMT90 | NUM* | 9 |
1221 | 23 | Y/N | AGESWITCH | CHAR | 1 |
1222 | 24 | Remittance automation | SCANLINE | CHAR | 100 |
1223 | 25 | Total Taxes & Fees | TAXTOT | NUM* | 9 |
1224 | 26 | Customer Reference Number | CUSTREF | CHAR | 15 |
1225 | 27 | Federal Tax*** | FEDTAX | NUM* | 9 |
1226 | 28 | State Tax*** | STATETAX | NUM* | 9 |
1227 | 29 | Other Taxes & Fees*** | OTHERTAX | NUM* | 9 |
1228 +-------+-------------------------------+------------+------+-------+
1230 If I<format> is "billco", the fields of the detail CSV file are as follows:
1232 FORMAT FOR DETAIL FILE
1234 Field | Description | Name | Type | Width
1235 1 | N/A-Leave Empty | RC | CHAR | 2
1236 2 | N/A-Leave Empty | CUSTID | CHAR | 15
1237 3 | Account Number | TRACCTNUM | CHAR | 15
1238 4 | Invoice Number | TRINVOICE | CHAR | 15
1239 5 | Line Sequence (sort order) | LINESEQ | NUM | 6
1240 6 | Transaction Detail | DETAILS | CHAR | 100
1241 7 | Amount | AMT | NUM* | 9
1242 8 | Line Format Control** | LNCTRL | CHAR | 2
1243 9 | Grouping Code | GROUP | CHAR | 2
1244 10 | User Defined | ACCT CODE | CHAR | 15
1249 my($self, %opt) = @_;
1251 eval "use Text::CSV_XS";
1254 my $cust_main = $self->cust_main;
1256 my $csv = Text::CSV_XS->new({'always_quote'=>1});
1258 if ( lc($opt{'format'}) eq 'billco' ) {
1261 $taxtotal += $_->{'amount'} foreach $self->_items_tax;
1263 my $duedate = $self->due_date2str('%m/%d/%Y'); #date_format?
1265 my( $previous_balance, @unused ) = $self->previous; #previous balance
1267 my $pmt_cr_applied = 0;
1268 $pmt_cr_applied += $_->{'amount'}
1269 foreach ( $self->_items_payments, $self->_items_credits ) ;
1271 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
1274 '', # 1 | N/A-Leave Empty CHAR 2
1275 '', # 2 | N/A-Leave Empty CHAR 15
1276 $opt{'tracctnum'}, # 3 | Transaction Account No CHAR 15
1277 $self->invnum, # 4 | Transaction Invoice No CHAR 15
1278 $cust_main->zip, # 5 | Transaction Zip Code CHAR 5
1279 $cust_main->company, # 6 | Transaction Company Bill To CHAR 30
1280 #$cust_main->payname, # 7 | Transaction Contact Bill To CHAR 30
1281 $cust_main->contact, # 7 | Transaction Contact Bill To CHAR 30
1282 $cust_main->address2, # 8 | Additional Address Unit Info CHAR 30
1283 $cust_main->address1, # 9 | Bill To Street Address CHAR 30
1284 '', # 10 | Ancillary Billing Information CHAR 30
1285 $cust_main->city, # 11 | Transaction City Bill To CHAR 20
1286 $cust_main->state, # 12 | Transaction State Bill To CHAR 2
1289 time2str("%m/%d/%Y", $self->_date), # 13 | Bill Cycle Close Date CHAR 10
1292 $duedate, # 14 | Bill Due Date CHAR 10
1294 $previous_balance, # 15 | Previous Balance NUM* 9
1295 $pmt_cr_applied, # 16 | Pmt/CR Applied NUM* 9
1296 sprintf("%.2f", $self->charged), # 17 | Total Current Charges NUM* 9
1297 $totaldue, # 18 | Total Amt Due NUM* 9
1298 $totaldue, # 19 | Total Amt Due NUM* 9
1299 '', # 20 | 30 Day Aging NUM* 9
1300 '', # 21 | 60 Day Aging NUM* 9
1301 '', # 22 | 90 Day Aging NUM* 9
1302 'N', # 23 | Y/N CHAR 1
1303 '', # 24 | Remittance automation CHAR 100
1304 $taxtotal, # 25 | Total Taxes & Fees NUM* 9
1305 $self->custnum, # 26 | Customer Reference Number CHAR 15
1306 '0', # 27 | Federal Tax*** NUM* 9
1307 sprintf("%.2f", $taxtotal), # 28 | State Tax*** NUM* 9
1308 '0', # 29 | Other Taxes & Fees*** NUM* 9
1317 time2str("%x", $self->_date),
1318 sprintf("%.2f", $self->charged),
1319 ( map { $cust_main->getfield($_) }
1320 qw( first last company address1 address2 city state zip country ) ),
1322 ) or die "can't create csv";
1325 my $header = $csv->string. "\n";
1328 if ( lc($opt{'format'}) eq 'billco' ) {
1331 foreach my $item ( $self->_items_pkg ) {
1334 '', # 1 | N/A-Leave Empty CHAR 2
1335 '', # 2 | N/A-Leave Empty CHAR 15
1336 $opt{'tracctnum'}, # 3 | Account Number CHAR 15
1337 $self->invnum, # 4 | Invoice Number CHAR 15
1338 $lineseq++, # 5 | Line Sequence (sort order) NUM 6
1339 $item->{'description'}, # 6 | Transaction Detail CHAR 100
1340 $item->{'amount'}, # 7 | Amount NUM* 9
1341 '', # 8 | Line Format Control** CHAR 2
1342 '', # 9 | Grouping Code CHAR 2
1343 '', # 10 | User Defined CHAR 15
1346 $detail .= $csv->string. "\n";
1352 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1354 my($pkg, $setup, $recur, $sdate, $edate);
1355 if ( $cust_bill_pkg->pkgnum ) {
1357 ($pkg, $setup, $recur, $sdate, $edate) = (
1358 $cust_bill_pkg->part_pkg->pkg,
1359 ( $cust_bill_pkg->setup != 0
1360 ? sprintf("%.2f", $cust_bill_pkg->setup )
1362 ( $cust_bill_pkg->recur != 0
1363 ? sprintf("%.2f", $cust_bill_pkg->recur )
1365 ( $cust_bill_pkg->sdate
1366 ? time2str("%x", $cust_bill_pkg->sdate)
1368 ($cust_bill_pkg->edate
1369 ?time2str("%x", $cust_bill_pkg->edate)
1373 } else { #pkgnum tax
1374 next unless $cust_bill_pkg->setup != 0;
1375 my $itemdesc = defined $cust_bill_pkg->dbdef_table->column('itemdesc')
1376 ? ( $cust_bill_pkg->itemdesc || 'Tax' )
1378 ($pkg, $setup, $recur, $sdate, $edate) =
1379 ( $itemdesc, sprintf("%10.2f",$cust_bill_pkg->setup), '', '', '' );
1385 ( map { '' } (1..11) ),
1386 ($pkg, $setup, $recur, $sdate, $edate)
1387 ) or die "can't create csv";
1389 $detail .= $csv->string. "\n";
1395 ( $header, $detail );
1401 Pays this invoice with a compliemntary payment. If there is an error,
1402 returns the error, otherwise returns false.
1408 my $cust_pay = new FS::cust_pay ( {
1409 'invnum' => $self->invnum,
1410 'paid' => $self->owed,
1413 'payinfo' => $self->cust_main->payinfo,
1421 Attempts to pay this invoice with a credit card payment via a
1422 Business::OnlinePayment realtime gateway. See
1423 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1424 for supported processors.
1430 $self->realtime_bop( 'CC', @_ );
1435 Attempts to pay this invoice with an electronic check (ACH) payment via a
1436 Business::OnlinePayment realtime gateway. See
1437 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1438 for supported processors.
1444 $self->realtime_bop( 'ECHECK', @_ );
1449 Attempts to pay this invoice with phone bill (LEC) payment via a
1450 Business::OnlinePayment realtime gateway. See
1451 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1452 for supported processors.
1458 $self->realtime_bop( 'LEC', @_ );
1462 my( $self, $method ) = @_;
1464 my $cust_main = $self->cust_main;
1465 my $balance = $cust_main->balance;
1466 my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
1467 $amount = sprintf("%.2f", $amount);
1468 return "not run (balance $balance)" unless $amount > 0;
1470 my $description = 'Internet Services';
1471 if ( $conf->exists('business-onlinepayment-description') ) {
1472 my $dtempl = $conf->config('business-onlinepayment-description');
1474 my $agent_obj = $cust_main->agent
1475 or die "can't retreive agent for $cust_main (agentnum ".
1476 $cust_main->agentnum. ")";
1477 my $agent = $agent_obj->agent;
1478 my $pkgs = join(', ',
1479 map { $_->part_pkg->pkg }
1480 grep { $_->pkgnum } $self->cust_bill_pkg
1482 $description = eval qq("$dtempl");
1485 $cust_main->realtime_bop($method, $amount,
1486 'description' => $description,
1487 'invnum' => $self->invnum,
1492 =item batch_card OPTION => VALUE...
1494 Adds a payment for this invoice to the pending credit card batch (see
1495 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
1496 runs the payment using a realtime gateway.
1501 my ($self, %options) = @_;
1502 my $cust_main = $self->cust_main;
1504 $options{invnum} = $self->invnum;
1506 $cust_main->batch_card(%options);
1509 sub _agent_template {
1511 $self->cust_main->agent_template;
1514 sub _agent_invoice_from {
1516 $self->cust_main->agent_invoice_from;
1519 =item print_text [ TIME [ , TEMPLATE ] ]
1521 Returns an text invoice, as a list of lines.
1523 TIME an optional value used to control the printing of overdue messages. The
1524 default is now. It isn't the date of the invoice; that's the `_date' field.
1525 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1526 L<Time::Local> and L<Date::Parse> for conversion functions.
1531 my( $self, $today, $template ) = @_;
1533 my %params = ( 'format' => 'template' );
1534 $params{'time'} = $today if $today;
1535 $params{'template'} = $template if $template;
1537 $self->print_generic( %params );
1540 =item print_latex [ TIME [ , TEMPLATE ] ]
1542 Internal method - returns a filename of a filled-in LaTeX template for this
1543 invoice (Note: add ".tex" to get the actual filename), and a filename of
1544 an associated logo (with the .eps extension included).
1546 See print_ps and print_pdf for methods that return PostScript and PDF output.
1548 TIME an optional value used to control the printing of overdue messages. The
1549 default is now. It isn't the date of the invoice; that's the `_date' field.
1550 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1551 L<Time::Local> and L<Date::Parse> for conversion functions.
1557 my( $self, $today, $template ) = @_;
1559 my %params = ( 'format' => 'latex' );
1560 $params{'time'} = $today if $today;
1561 $params{'template'} = $template if $template;
1563 $template ||= $self->_agent_template;
1565 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1566 my $lh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
1570 ) or die "can't open temp file: $!\n";
1572 if ($template && $conf->exists("logo_${template}.eps")) {
1573 print $lh $conf->config_binary("logo_${template}.eps")
1574 or die "can't write temp file: $!\n";
1576 print $lh $conf->config_binary('logo.eps')
1577 or die "can't write temp file: $!\n";
1580 $params{'logo_file'} = $lh->filename;
1582 my @filled_in = $self->print_generic( %params );
1584 my $fh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
1588 ) or die "can't open temp file: $!\n";
1589 print $fh join('', @filled_in );
1592 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
1593 return ($1, $params{'logo_file'});
1597 =item print_generic OPTIONS_HASH
1599 Internal method - returns a filled-in template for this invoice as a scalar.
1601 See print_ps and print_pdf for methods that return PostScript and PDF output.
1603 Non optional options include
1604 format - latex, html, template
1606 Optional options include
1608 template - a value used as a suffix for a configuration template
1610 time - a value used to control the printing of overdue messages. The
1611 default is now. It isn't the date of the invoice; that's the `_date' field.
1612 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1613 L<Time::Local> and L<Date::Parse> for conversion functions.
1621 my( $self, %params ) = @_;
1622 my $today = $params{today} ? $params{today} : time;
1623 warn "FS::cust_bill::print_generic called on $self with suffix $params{template}\n"
1626 my $format = $params{format};
1627 die "Unknown format: $format"
1628 unless $format =~ /^(latex|html|template)$/;
1630 my $cust_main = $self->cust_main;
1631 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
1632 unless $cust_main->payname && $cust_main->payby !~ /^(CHEK|DCHK)$/;
1635 my %delimiters = ( 'latex' => [ '[@--', '--@]' ],
1636 'html' => [ '<%=', '%>' ],
1637 'template' => [ '{', '}' ],
1640 #create the template
1641 my $template = $params{template} ? $params{template} : $self->_agent_template;
1642 my $templatefile = "invoice_$format";
1643 $templatefile .= "_$template"
1644 if length($template);
1645 my @invoice_template = map "$_\n", $conf->config($templatefile)
1646 or die "cannot load config data $templatefile";
1649 if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
1650 #change this to a die when the old code is removed
1651 warn "old-style invoice template $templatefile; ".
1652 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
1653 $old_latex = 'true';
1654 @invoice_template = _translate_old_latex_format(@invoice_template);
1657 my $text_template = new Text::Template(
1659 SOURCE => \@invoice_template,
1660 DELIMITERS => $delimiters{$format},
1663 $text_template->compile()
1664 or die "Can't compile $templatefile: $Text::Template::ERROR\n";
1667 # additional substitution could possibly cause breakage in existing templates
1668 my %convert_maps = (
1670 'notes' => sub { map "$_", @_ },
1671 'footer' => sub { map "$_", @_ },
1672 'smallfooter' => sub { map "$_", @_ },
1673 'returnaddress' => sub { map "$_", @_ },
1679 s/%%(.*)$/<!-- $1 -->/g;
1680 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
1681 s/\\begin\{enumerate\}/<ol>/g;
1683 s/\\end\{enumerate\}/<\/ol>/g;
1684 s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
1693 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
1695 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
1700 s/\\\\\*?\s*$/<BR>/;
1701 s/\\hyphenation\{[\w\s\-]+}//;
1711 s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
1712 s/\\begin\{enumerate\}//g;
1714 s/\\end\{enumerate\}//g;
1715 s/\\textbf\{(.*)\}/$1/g;
1722 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
1724 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
1729 s/\\\\\*?\s*$/\n/; # dubious
1730 s/\\hyphenation\{[\w\s\-]+}//;
1738 # hashes for differing output formats
1739 my %nbsps = ( 'latex' => '~',
1740 'html' => '', # '&nbps;' would be nice
1741 'template' => '', # not used
1743 my $nbsp = $nbsps{$format};
1745 my %escape_functions = ( 'latex' => \&_latex_escape,
1746 'html' => \&encode_entities,
1747 'template' => sub { shift },
1749 my $escape_function = $escape_functions{$format};
1751 my %date_formats = ( 'latex' => '%b %o, %Y',
1752 'html' => '%b %o, %Y',
1755 my $date_format = $date_formats{$format};
1757 my %embolden_functions = ( 'latex' => sub { return '\textbf{'. shift(). '}'
1759 'html' => sub { return '<b>'. shift(). '</b>'
1761 'template' => sub { shift },
1763 my $embolden_function = $embolden_functions{$format};
1766 # generate template variables
1769 defined( $conf->config_orbase( "invoice_${format}returnaddress",
1773 && length( $conf->config_orbase( "invoice_${format}returnaddress",
1779 $returnaddress = join("\n",
1780 $conf->config_orbase("invoice_${format}returnaddress", $template)
1783 } elsif ( grep /\S/,
1784 $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
1786 my $convert_map = $convert_maps{$format}{'returnaddress'};
1789 &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
1794 } elsif ( grep /\S/, $conf->config('company_address') ) {
1796 my $convert_map = $convert_maps{$format}{'returnaddress'};
1797 $returnaddress = join( "\n", &$convert_map(
1798 map { s/( {2,})/'~' x length($1)/eg;
1802 ( $conf->config('company_name'),
1803 $conf->config('company_address'),
1810 my $warning = "Couldn't find a return address; ".
1811 "do you need to set the company_address configuration value?";
1813 $returnaddress = $nbsp;
1814 #$returnaddress = $warning;
1818 my %invoice_data = (
1819 'company_name' => scalar( $conf->config('company_name') ),
1820 'company_address' => join("\n", $conf->config('company_address') ). "\n",
1821 'custnum' => $self->custnum,
1822 'invnum' => $self->invnum,
1823 'date' => time2str($date_format, $self->_date),
1824 'today' => time2str('%b %o, %Y', $today),
1825 'agent' => &$escape_function($cust_main->agent->agent),
1826 'payname' => &$escape_function($cust_main->payname),
1827 'company' => &$escape_function($cust_main->company),
1828 'address1' => &$escape_function($cust_main->address1),
1829 'address2' => &$escape_function($cust_main->address2),
1830 'city' => &$escape_function($cust_main->city),
1831 'state' => &$escape_function($cust_main->state),
1832 'zip' => &$escape_function($cust_main->zip),
1833 'returnaddress' => $returnaddress,
1835 'terms' => $self->terms,
1836 'template' => $params{'template'},
1837 #'notes' => join("\n", $conf->config('invoice_latexnotes') ),
1838 # better hang on to conf_dir for a while
1839 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
1844 $invoice_data{'cid'} = $params{'cid'}
1847 my $countrydefault = $conf->config('countrydefault') || 'US';
1848 if ( $cust_main->country eq $countrydefault ) {
1849 $invoice_data{'country'} = '';
1851 $invoice_data{'country'} = &$escape_function(code2country($cust_main->country));
1855 $invoice_data{'address'} = \@address;
1857 $cust_main->payname.
1858 ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
1859 ? " (P.O. #". $cust_main->payinfo. ")"
1863 push @address, $cust_main->company
1864 if $cust_main->company;
1865 push @address, $cust_main->address1;
1866 push @address, $cust_main->address2
1867 if $cust_main->address2;
1869 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
1870 push @address, $invoice_data{'country'}
1871 if $invoice_data{'country'};
1873 while (scalar(@address) < 5);
1875 #do variable substitution in notes, footer, smallfooter
1876 foreach my $include (qw( notes footer smallfooter )) {
1878 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1881 if ( $conf->exists($inc_file) && length( $conf->config($inc_file) ) ) {
1883 @inc_src = $conf->config($inc_file);
1887 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1889 my $convert_map = $convert_maps{$format}{$include};
1891 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1892 s/--\@\]/$delimiters{$format}[1]/g;
1895 &$convert_map( $conf->config($inc_file) );
1899 my $inc_tt = new Text::Template (
1901 SOURCE => [ map "$_\n", @inc_src ],
1902 DELIMITERS => $delimiters{$format},
1903 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1905 unless ( $inc_tt->compile() ) {
1906 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1907 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1911 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1913 $invoice_data{$include} =~ s/\n+$//
1914 if ($format eq 'latex');
1917 $invoice_data{'po_line'} =
1918 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
1919 ? &$escape_function("Purchase Order #". $cust_main->payinfo)
1922 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
1923 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
1924 #my $balance_due = $self->owed + $pr_total - $cr_total;
1925 my $balance_due = $self->owed + $pr_total;
1927 my %money_chars = ( 'latex' => '',
1928 'html' => $conf->config('money_char') || '$',
1931 my $money_char = $money_chars{$format};
1933 my %other_money_chars = ( 'latex' => '\dollar ',
1934 'html' => $conf->config('money_char') || '$',
1937 my $other_money_char = $other_money_chars{$format};
1939 my @detail_items = ();
1940 my @total_items = ();
1944 $invoice_data{'detail_items'} = \@detail_items;
1945 $invoice_data{'total_items'} = \@total_items;
1946 $invoice_data{'buf'} = \@buf;
1947 $invoice_data{'sections'} = \@sections;
1949 my $previous_section = { 'description' => 'Previous Charges',
1950 'subtotal' => $other_money_char.
1951 sprintf('%.2f', $pr_total),
1954 my $multisection = $conf->exists('invoice_sections', $cust_main->agentnum);
1955 if ( $multisection ) {
1956 push @sections, $self->_items_sections;
1958 push @sections, { 'description' => '', 'subtotal' => '' };
1961 foreach my $line_item ( $conf->exists('disable_previous_balance')
1963 : $self->_items_previous
1967 ext_description => [],
1969 $detail->{'ref'} = $line_item->{'pkgnum'};
1970 $detail->{'quantity'} = 1;
1971 $detail->{'section'} = $previous_section;
1972 $detail->{'description'} = &$escape_function($line_item->{'description'});
1973 if ( exists $line_item->{'ext_description'} ) {
1974 @{$detail->{'ext_description'}} = map {
1975 &$escape_function($_);
1976 } @{$line_item->{'ext_description'}};
1979 my $money = $old_latex ? '' : $money_char;
1980 $detail->{'amount'} = $money. $line_item->{'amount'};
1982 $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
1984 push @detail_items, $detail;
1985 push @buf, [ $detail->{'description'},
1986 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1990 if ( @pr_cust_bill && !$conf->exists('disable_previous_balance') ) {
1991 push @buf, ['','-----------'];
1992 push @buf, [ 'Total Previous Balance',
1993 $money_char. sprintf("%10.2f", $pr_total) ];
1997 foreach my $section (@sections) {
1999 $section->{'subtotal'} = $other_money_char.
2000 sprintf('%.2f', $section->{'subtotal'})
2003 if ( $section->{'description'} ) {
2004 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
2010 $options{'section'} = $section if $multisection;
2011 $options{'format'} = $format;
2013 foreach my $line_item ( $self->_items_pkg(%options) ) {
2015 ext_description => [],
2017 $detail->{'ref'} = $line_item->{'pkgnum'};
2018 $detail->{'quantity'} = 1;
2019 $detail->{'section'} = $section;
2020 $detail->{'description'} = &$escape_function($line_item->{'description'});
2021 if ( exists $line_item->{'ext_description'} ) {
2022 @{$detail->{'ext_description'}} = @{$line_item->{'ext_description'}};
2025 my $money = $old_latex ? '' : $money_char;
2026 $detail->{'amount'} = $money. $line_item->{'amount'};
2028 $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
2030 push @detail_items, $detail;
2031 push @buf, ( [ $detail->{'description'},
2032 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
2034 map { [ " ". $_, '' ] } @{$detail->{'ext_description'}},
2038 if ( $section->{'description'} ) {
2039 push @buf, ( ['','-----------'],
2040 [ $section->{'description'}. ' sub-total',
2041 $money_char. sprintf("%10.2f", $section->{'subtotal'})
2050 if ( $multisection && !$conf->exists('disable_previous_balance') ) {
2051 unshift @sections, $previous_section;
2055 foreach my $tax ( $self->_items_tax ) {
2057 $total->{'total_item'} = &$escape_function($tax->{'description'});
2058 $taxtotal += $tax->{'amount'};
2059 $total->{'total_amount'} = $other_money_char. $tax->{'amount'};
2060 push @total_items, $total;
2061 push @buf,[ $total->{'total_item'},
2062 $money_char. sprintf("%10.2f", $total->{'total_amount'}),
2069 if ( $multisection ) {
2070 $total->{'total_item'} = 'New charges sub-total';
2072 $total->{'total_item'} = 'Sub-total';
2074 $total->{'total_amount'} =
2075 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
2076 unshift @total_items, $total;
2079 push @buf,['','-----------'];
2080 push @buf,[( $conf->exists('disable_previous_balance')
2082 : 'Total New Charges'
2084 $money_char. sprintf("%10.2f",$self->charged) ];
2089 $total->{'total_item'} = &$embolden_function('Total');
2090 $total->{'total_amount'} =
2091 &$embolden_function(
2094 $self->charged + ( $conf->exists('disable_previous_balance')
2100 push @total_items, $total;
2101 push @buf,['','-----------'];
2102 push @buf,['Total Charges',
2104 sprintf( '%10.2f', $self->charged +
2105 ( $conf->exists('disable_previous_balance')
2114 unless ( $conf->exists('disable_previous_balance') ) {
2115 #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
2118 foreach my $credit ( $self->_items_credits ) {
2120 $total->{'total_item'} = &$escape_function($credit->{'description'});
2122 $total->{'total_amount'} = '-'. $other_money_char. $credit->{'amount'};
2123 push @total_items, $total;
2127 foreach ( $self->cust_credited ) {
2129 #something more elaborate if $_->amount ne $_->cust_credit->credited ?
2131 my $reason = substr($_->cust_credit->reason,0,32);
2132 $reason .= '...' if length($reason) < length($_->cust_credit->reason);
2133 $reason = " ($reason) " if $reason;
2135 "Credit #". $_->crednum. " (". time2str("%x",$_->cust_credit->_date) .")". $reason,
2136 $money_char. sprintf("%10.2f",$_->amount)
2141 foreach my $payment ( $self->_items_payments ) {
2143 $total->{'total_item'} = &$escape_function($payment->{'description'});
2145 $total->{'total_amount'} = '-'. $other_money_char. $payment->{'amount'};
2146 push @total_items, $total;
2147 push @buf, [ $payment->{'description'},
2148 $money_char. sprintf("%10.2f", $payment->{'amount'}),
2154 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
2155 $total->{'total_amount'} =
2156 &$embolden_function(
2157 $other_money_char. sprintf('%.2f', $self->owed + $pr_total )
2159 push @total_items, $total;
2160 push @buf,['','-----------'];
2161 push @buf,[$self->balance_due_msg, $money_char.
2162 sprintf("%10.2f", $balance_due ) ];
2166 $invoice_data{'logo_file'} = $params{'logo_file'}
2167 if $params{'logo_file'};
2171 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
2172 /invoice_lines\((\d*)\)/;
2173 $invoice_lines += $1 || scalar(@buf);
2176 die "no invoice_lines() functions in template?"
2177 if ( $format eq 'template' && !$wasfunc );
2179 if ($format eq 'template') {
2181 if ( $invoice_lines ) {
2182 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
2183 $invoice_data{'total_pages'}++
2184 if scalar(@buf) % $invoice_lines;
2187 #setup subroutine for the template
2188 sub FS::cust_bill::_template::invoice_lines {
2189 my $lines = shift || scalar(@FS::cust_bill::_template::buf);
2191 scalar(@FS::cust_bill::_template::buf)
2192 ? shift @FS::cust_bill::_template::buf
2201 push @collect, split("\n",
2202 $text_template->fill_in( HASH => \%invoice_data,
2203 PACKAGE => 'FS::cust_bill::_template'
2206 $FS::cust_bill::_template::page++;
2208 map "$_\n", @collect;
2210 warn "filling in template for invoice ". $self->invnum. "\n"
2212 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
2215 $text_template->fill_in(HASH => \%invoice_data);
2219 =item print_ps [ TIME [ , TEMPLATE ] ]
2221 Returns an postscript invoice, as a scalar.
2223 TIME an optional value used to control the printing of overdue messages. The
2224 default is now. It isn't the date of the invoice; that's the `_date' field.
2225 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2226 L<Time::Local> and L<Date::Parse> for conversion functions.
2233 my ($file, $lfile) = $self->print_latex(@_);
2234 my $ps = generate_ps($file);
2240 =item print_pdf [ TIME [ , TEMPLATE ] ]
2242 Returns an PDF invoice, as a scalar.
2244 TIME an optional value used to control the printing of overdue messages. The
2245 default is now. It isn't the date of the invoice; that's the `_date' field.
2246 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2247 L<Time::Local> and L<Date::Parse> for conversion functions.
2254 my ($file, $lfile) = $self->print_latex(@_);
2256 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2259 #system('pdflatex', "$file.tex");
2260 #system('pdflatex', "$file.tex");
2261 #! LaTeX Error: Unknown graphics extension: .eps.
2263 my $sfile = shell_quote $file;
2265 system("pslatex $sfile.tex >/dev/null 2>&1") == 0
2266 or die "pslatex $file.tex failed; see $file.log for details?\n";
2267 system("pslatex $sfile.tex >/dev/null 2>&1") == 0
2268 or die "pslatex $file.tex failed; see $file.log for details?\n";
2270 #system('dvipdf', "$file.dvi", "$file.pdf" );
2272 "dvips -q -t letter -f $sfile.dvi ".
2273 "| gs -q -dNOPAUSE -dBATCH -sDEVICE=pdfwrite -sOutputFile=$sfile.pdf ".
2276 or die "dvips | gs failed: $!";
2278 open(PDF, "<$file.pdf")
2279 or die "can't open $file.pdf: $! (error in LaTeX template?)\n";
2281 unlink("$file.dvi", "$file.log", "$file.aux", "$file.pdf", "$file.tex");
2295 =item print_html [ TIME [ , TEMPLATE [ , CID ] ] ]
2297 Returns an HTML invoice, as a scalar.
2299 TIME an optional value used to control the printing of overdue messages. The
2300 default is now. It isn't the date of the invoice; that's the `_date' field.
2301 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2302 L<Time::Local> and L<Date::Parse> for conversion functions.
2304 CID is a MIME Content-ID used to create a "cid:" URL for the logo image, used
2305 when emailing the invoice as part of a multipart/related MIME email.
2310 my( $self, $today, $template, $cid ) = @_;
2312 my %params = ( 'format' => 'html' );
2313 $params{'time'} = $today if $today;
2314 $params{'template'} = $template if $template;
2315 $params{'cid'} = $cid if $cid;
2317 $self->print_generic( %params );
2320 # quick subroutine for print_latex
2322 # There are ten characters that LaTeX treats as special characters, which
2323 # means that they do not simply typeset themselves:
2324 # # $ % & ~ _ ^ \ { }
2326 # TeX ignores blanks following an escaped character; if you want a blank (as
2327 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
2331 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
2332 $value =~ s/([<>])/\$$1\$/g;
2336 #utility methods for print_*
2338 sub _translate_old_latex_format {
2339 warn "_translate_old_latex_format called\n"
2346 if ( $line =~ /^%%Detail\s*$/ ) {
2348 push @template, q![@--!,
2349 q! foreach my $_tr_line (@detail_items) {!,
2350 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
2351 q! $_tr_line->{'description'} .= !,
2352 q! "\\tabularnewline\n~~".!,
2353 q! join( "\\tabularnewline\n~~",!,
2354 q! @{$_tr_line->{'ext_description'}}!,
2358 while ( ( my $line_item_line = shift )
2359 !~ /^%%EndDetail\s*$/ ) {
2360 $line_item_line =~ s/'/\\'/g; # nice LTS
2361 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
2362 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
2363 push @template, " \$OUT .= '$line_item_line';";
2366 push @template, '}',
2369 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
2371 push @template, '[@--',
2372 ' foreach my $_tr_line (@total_items) {';
2374 while ( ( my $total_item_line = shift )
2375 !~ /^%%EndTotalDetails\s*$/ ) {
2376 $total_item_line =~ s/'/\\'/g; # nice LTS
2377 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
2378 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
2379 push @template, " \$OUT .= '$total_item_line';";
2382 push @template, '}',
2386 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
2387 push @template, $line;
2393 warn "$_\n" foreach @template;
2402 #check for an invoice- specific override (eventually)
2404 #check for a customer- specific override
2405 return $self->cust_main->invoice_terms
2406 if $self->cust_main->invoice_terms;
2408 #use configured default or default default
2409 $conf->config('invoice_default_terms') || 'Payable upon receipt';
2415 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
2416 $duedate = $self->_date() + ( $1 * 86400 );
2423 $self->due_date ? time2str(shift, $self->due_date) : '';
2426 sub balance_due_msg {
2428 my $msg = 'Balance Due';
2429 return $msg unless $self->terms;
2430 if ( $self->due_date ) {
2431 $msg .= ' - Please pay by '. $self->due_date2str('%x');
2432 } elsif ( $self->terms ) {
2433 $msg .= ' - '. $self->terms;
2438 sub _items_sections {
2442 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2444 if ( $cust_bill_pkg->pkgnum > 0 ) {
2446 my $desc = $cust_bill_pkg->part_pkg->classname;
2448 $s{$desc} += $cust_bill_pkg->setup
2449 if ( $cust_bill_pkg->setup != 0 );
2451 $s{$desc} += $cust_bill_pkg->recur
2452 if ( $cust_bill_pkg->recur != 0 );
2458 map { {'description' => $_, 'subtotal' => $s{$_}} } sort keys %s;
2464 my @display = scalar(@_)
2466 : qw( _items_previous _items_pkg );
2467 #: qw( _items_pkg );
2468 #: qw( _items_previous _items_pkg _items_tax _items_credits _items_payments );
2470 foreach my $display ( @display ) {
2471 push @b, $self->$display(@_);
2476 sub _items_previous {
2478 my $cust_main = $self->cust_main;
2479 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2481 foreach ( @pr_cust_bill ) {
2483 'description' => 'Previous Balance, Invoice #'. $_->invnum.
2484 ' ('. time2str('%x',$_->_date). ')',
2485 #'pkgpart' => 'N/A',
2487 'amount' => sprintf("%.2f", $_->owed),
2493 # 'description' => 'Previous Balance',
2494 # #'pkgpart' => 'N/A',
2495 # 'pkgnum' => 'N/A',
2496 # 'amount' => sprintf("%10.2f", $pr_total ),
2497 # 'ext_description' => [ map {
2498 # "Invoice ". $_->invnum.
2499 # " (". time2str("%x",$_->_date). ") ".
2500 # sprintf("%10.2f", $_->owed)
2501 # } @pr_cust_bill ],
2509 my $section = delete $options{'section'};
2511 grep { $_->pkgnum &&
2513 ? $_->part_pkg->classname eq $section->{'description'}
2516 } $self->cust_bill_pkg;
2517 $self->_items_cust_bill_pkg(\@cust_bill_pkg, %options);
2521 return 0 unless $a cmp $b;
2522 return -1 if $b eq 'Tax';
2523 return 1 if $a eq 'Tax';
2524 return -1 if $b eq 'Other surcharges';
2525 return 1 if $a eq 'Other surcharges';
2531 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum } $self->cust_bill_pkg;
2532 $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2535 sub _items_cust_bill_pkg {
2537 my $cust_bill_pkg = shift;
2539 my $format = $opt{format} || '';
2540 my $escape_function = $opt{escape_function} || sub { shift };
2543 foreach my $cust_bill_pkg ( @$cust_bill_pkg ) {
2545 my $cust_pkg = $cust_bill_pkg->cust_pkg;
2547 my $desc = $cust_bill_pkg->desc;
2549 if ( $cust_bill_pkg->pkgnum > 0 ) {
2551 if ( $cust_bill_pkg->setup != 0 ) {
2552 my $description = $desc;
2553 $description .= ' Setup' if $cust_bill_pkg->recur != 0;
2554 my @d = $cust_pkg->h_labels_short($self->_date);
2555 push @d, $cust_bill_pkg->details( 'format' => $format,
2556 'escape_function' => $escape_function,
2558 if $cust_bill_pkg->recur == 0;
2560 description => $description,
2561 #pkgpart => $part_pkg->pkgpart,
2562 pkgnum => $cust_bill_pkg->pkgnum,
2563 amount => sprintf("%.2f", $cust_bill_pkg->setup),
2564 ext_description => \@d,
2568 if ( $cust_bill_pkg->recur != 0 ) {
2570 description => $desc .
2571 ( $conf->exists('disable_line_item_date_ranges')
2573 : " (" .time2str("%x", $cust_bill_pkg->sdate).
2574 " - ".time2str("%x", $cust_bill_pkg->edate).")"
2576 #pkgpart => $part_pkg->pkgpart,
2577 pkgnum => $cust_bill_pkg->pkgnum,
2578 amount => sprintf("%.2f", $cust_bill_pkg->recur),
2580 #at least until cust_bill_pkg has "past" ranges in addition to
2581 #the "future" sdate/edate ones... see #3032
2582 [ $cust_pkg->h_labels_short( $self->_date ),
2583 #$cust_bill_pkg->edate,
2584 #$cust_bill_pkg->sdate),
2585 $cust_bill_pkg->details( 'format' => $format,
2586 'escape_function' => $escape_function),
2591 } else { #pkgnum tax or one-shot line item (??)
2593 if ( $cust_bill_pkg->setup != 0 ) {
2595 'description' => $desc,
2596 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
2599 if ( $cust_bill_pkg->recur != 0 ) {
2601 'description' => "$desc (".
2602 time2str("%x", $cust_bill_pkg->sdate). ' - '.
2603 time2str("%x", $cust_bill_pkg->edate). ')',
2604 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
2616 sub _items_credits {
2621 foreach ( $self->cust_credited ) {
2623 #something more elaborate if $_->amount ne $_->cust_credit->credited ?
2625 my $reason = $_->cust_credit->reason;
2626 #my $reason = substr($_->cust_credit->reason,0,32);
2627 #$reason .= '...' if length($reason) < length($_->cust_credit->reason);
2628 $reason = " ($reason) " if $reason;
2630 #'description' => 'Credit ref\#'. $_->crednum.
2631 # " (". time2str("%x",$_->cust_credit->_date) .")".
2633 'description' => 'Credit applied '.
2634 time2str("%x",$_->cust_credit->_date). $reason,
2635 'amount' => sprintf("%.2f",$_->amount),
2638 #foreach ( @cr_cust_credit ) {
2640 # "Credit #". $_->crednum. " (" . time2str("%x",$_->_date) .")",
2641 # $money_char. sprintf("%10.2f",$_->credited)
2649 sub _items_payments {
2653 #get & print payments
2654 foreach ( $self->cust_bill_pay ) {
2656 #something more elaborate if $_->amount ne ->cust_pay->paid ?
2659 'description' => "Payment received ".
2660 time2str("%x",$_->cust_pay->_date ),
2661 'amount' => sprintf("%.2f", $_->amount )
2680 sub process_reprint {
2681 process_re_X('print', @_);
2688 sub process_reemail {
2689 process_re_X('email', @_);
2697 process_re_X('fax', @_);
2700 use Storable qw(thaw);
2704 my( $method, $job ) = ( shift, shift );
2705 warn "$me process_re_X $method for job $job\n" if $DEBUG;
2707 my $param = thaw(decode_base64(shift));
2708 warn Dumper($param) if $DEBUG;
2719 my($method, $job, %param ) = @_;
2721 warn "re_X $method for job $job with param:\n".
2722 join( '', map { " $_ => ". $param{$_}. "\n" } keys %param );
2725 #some false laziness w/search/cust_bill.html
2727 my $orderby = 'ORDER BY cust_bill._date';
2729 my $extra_sql = ' WHERE '. FS::cust_bill->search_sql(\%param);
2731 my $addl_from = 'LEFT JOIN cust_main USING ( custnum )';
2733 my @cust_bill = qsearch( {
2734 #'select' => "cust_bill.*",
2735 'table' => 'cust_bill',
2736 'addl_from' => $addl_from,
2738 'extra_sql' => $extra_sql,
2739 'order_by' => $orderby,
2743 warn " $me re_X $method: ". scalar(@cust_bill). " invoices found\n"
2746 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
2747 foreach my $cust_bill ( @cust_bill ) {
2748 $cust_bill->$method();
2750 if ( $job ) { #progressbar foo
2752 if ( time - $min_sec > $last ) {
2753 my $error = $job->update_statustext(
2754 int( 100 * $num / scalar(@cust_bill) )
2756 die $error if $error;
2767 =head1 CLASS METHODS
2773 Returns an SQL fragment to retreive the amount owed (charged minus credited and paid).
2779 'charged - '. $class->paid_sql. ' - '. $class->credited_sql;
2784 Returns an SQL fragment to retreive the net amount (charged minus credited).
2790 'charged - '. $class->credited_sql;
2795 Returns an SQL fragment to retreive the amount paid against this invoice.
2801 "( SELECT COALESCE(SUM(amount),0) FROM cust_bill_pay
2802 WHERE cust_bill.invnum = cust_bill_pay.invnum )";
2807 Returns an SQL fragment to retreive the amount credited against this invoice.
2813 "( SELECT COALESCE(SUM(amount),0) FROM cust_credit_bill
2814 WHERE cust_bill.invnum = cust_credit_bill.invnum )";
2817 =item search_sql HASHREF
2819 Class method which returns an SQL WHERE fragment to search for parameters
2820 specified in HASHREF. Valid parameters are
2826 Epoch date (UNIX timestamp) setting a lower bound for _date values
2830 Epoch date (UNIX timestamp) setting an upper bound for _date values
2844 =item newest_percust
2848 Note: validates all passed-in data; i.e. safe to use with unchecked CGI params.
2853 my($class, $param) = @_;
2855 warn "$me search_sql called with params: \n".
2856 join("\n", map { " $_: ". $param->{$_} } keys %$param ). "\n";
2861 if ( $param->{'begin'} =~ /^(\d+)$/ ) {
2862 push @search, "cust_bill._date >= $1";
2864 if ( $param->{'end'} =~ /^(\d+)$/ ) {
2865 push @search, "cust_bill._date < $1";
2867 if ( $param->{'invnum_min'} =~ /^(\d+)$/ ) {
2868 push @search, "cust_bill.invnum >= $1";
2870 if ( $param->{'invnum_max'} =~ /^(\d+)$/ ) {
2871 push @search, "cust_bill.invnum <= $1";
2873 if ( $param->{'agentnum'} =~ /^(\d+)$/ ) {
2874 push @search, "cust_main.agentnum = $1";
2877 push @search, '0 != '. FS::cust_bill->owed_sql
2878 if $param->{'open'};
2880 push @search, '0 != '. FS::cust_bill->net_sql
2883 push @search, "cust_bill._date < ". (time-86400*$param->{'days'})
2884 if $param->{'days'};
2886 if ( $param->{'newest_percust'} ) {
2888 #$distinct = 'DISTINCT ON ( cust_bill.custnum )';
2889 #$orderby = 'ORDER BY cust_bill.custnum ASC, cust_bill._date DESC';
2891 my @newest_where = map { my $x = $_;
2892 $x =~ s/\bcust_bill\./newest_cust_bill./g;
2895 grep ! /^cust_main./, @search;
2896 my $newest_where = scalar(@newest_where)
2897 ? ' AND '. join(' AND ', @newest_where)
2901 push @search, "cust_bill._date = (
2902 SELECT(MAX(newest_cust_bill._date)) FROM cust_bill AS newest_cust_bill
2903 WHERE newest_cust_bill.custnum = cust_bill.custnum
2909 my $curuser = $FS::CurrentUser::CurrentUser;
2910 if ( $curuser->username eq 'fs_queue'
2911 && $param->{'CurrentUser'} =~ /^(\w+)$/ ) {
2913 my $newuser = qsearchs('access_user', {
2914 'username' => $username,
2918 $curuser = $newuser;
2920 warn "$me WARNING: (fs_queue) can't find CurrentUser $username\n";
2924 push @search, $curuser->agentnums_sql;
2926 join(' AND ', @search );
2938 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
2939 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base