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 generate_pdf do_print );
16 use FS::Record qw( qsearch qsearchs dbh );
17 use FS::cust_main_Mixin;
19 use FS::cust_bill_pkg;
20 use FS::cust_bill_pkg_display;
24 use FS::cust_credit_bill;
26 use FS::cust_pay_batch;
27 use FS::cust_bill_event;
30 use FS::cust_bill_pay;
31 use FS::cust_bill_pay_batch;
32 use FS::part_bill_event;
35 @ISA = qw( FS::cust_main_Mixin FS::Record );
38 $me = '[FS::cust_bill]';
40 #ask FS::UID to run this stuff for us later
41 FS::UID->install_callback( sub {
43 $money_char = $conf->config('money_char') || '$';
48 FS::cust_bill - Object methods for cust_bill records
54 $record = new FS::cust_bill \%hash;
55 $record = new FS::cust_bill { 'column' => 'value' };
57 $error = $record->insert;
59 $error = $new_record->replace($old_record);
61 $error = $record->delete;
63 $error = $record->check;
65 ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
67 @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
69 ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
71 @cust_pay_objects = $cust_bill->cust_pay;
73 $tax_amount = $record->tax;
75 @lines = $cust_bill->print_text;
76 @lines = $cust_bill->print_text $time;
80 An FS::cust_bill object represents an invoice; a declaration that a customer
81 owes you money. The specific charges are itemized as B<cust_bill_pkg> records
82 (see L<FS::cust_bill_pkg>). FS::cust_bill inherits from FS::Record. The
83 following fields are currently supported:
87 =item invnum - primary key (assigned automatically for new invoices)
89 =item custnum - customer (see L<FS::cust_main>)
91 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
92 L<Time::Local> and L<Date::Parse> for conversion functions.
94 =item charged - amount of this invoice
96 =item printed - deprecated
98 =item closed - books closed flag, empty or `Y'
108 Creates a new invoice. To add the invoice to the database, see L<"insert">.
109 Invoices are normally created by calling the bill method of a customer object
110 (see L<FS::cust_main>).
114 sub table { 'cust_bill'; }
116 sub cust_linked { $_[0]->cust_main_custnum; }
117 sub cust_unlinked_msg {
119 "WARNING: can't find cust_main.custnum ". $self->custnum.
120 ' (cust_bill.invnum '. $self->invnum. ')';
125 Adds this invoice to the database ("Posts" the invoice). If there is an error,
126 returns the error, otherwise returns false.
130 This method now works but you probably shouldn't use it. Instead, apply a
131 credit against the invoice.
133 Using this method to delete invoices outright is really, really bad. There
134 would be no record you ever posted this invoice, and there are no check to
135 make sure charged = 0 or that there are no associated cust_bill_pkg records.
137 Really, don't use it.
143 return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
144 $self->SUPER::delete(@_);
147 =item replace OLD_RECORD
149 Replaces the OLD_RECORD with this one in the database. If there is an error,
150 returns the error, otherwise returns false.
152 Only printed may be changed. printed is normally updated by calling the
153 collect method of a customer object (see L<FS::cust_main>).
157 #replace can be inherited from Record.pm
159 # replace_check is now the preferred way to #implement replace data checks
160 # (so $object->replace() works without an argument)
163 my( $new, $old ) = ( shift, shift );
164 return "Can't change custnum!" unless $old->custnum == $new->custnum;
165 #return "Can't change _date!" unless $old->_date eq $new->_date;
166 return "Can't change _date!" unless $old->_date == $new->_date;
167 return "Can't change charged!" unless $old->charged == $new->charged
168 || $old->charged == 0;
175 Checks all fields to make sure this is a valid invoice. If there is an error,
176 returns the error, otherwise returns false. Called by the insert and replace
185 $self->ut_numbern('invnum')
186 || $self->ut_number('custnum')
187 || $self->ut_numbern('_date')
188 || $self->ut_money('charged')
189 || $self->ut_numbern('printed')
190 || $self->ut_enum('closed', [ '', 'Y' ])
192 return $error if $error;
194 return "Unknown customer"
195 unless qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
197 $self->_date(time) unless $self->_date;
199 $self->printed(0) if $self->printed eq '';
206 Returns a list consisting of the total previous balance for this customer,
207 followed by the previous outstanding invoices (as FS::cust_bill objects also).
214 my @cust_bill = sort { $a->_date <=> $b->_date }
215 grep { $_->owed != 0 && $_->_date < $self->_date }
216 qsearch( 'cust_bill', { 'custnum' => $self->custnum } )
218 foreach ( @cust_bill ) { $total += $_->owed; }
224 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
231 { 'table' => 'cust_bill_pkg',
232 'hashref' => { 'invnum' => $self->invnum },
233 'order_by' => 'ORDER BY billpkgnum',
240 Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
247 my @cust_pkg = map { $_->cust_pkg } $self->cust_bill_pkg;
249 grep { ! $saw{$_->pkgnum}++ } @cust_pkg;
252 =item open_cust_bill_pkg
254 Returns the open line items for this invoice.
256 Note that cust_bill_pkg with both setup and recur fees are returned as two
257 separate line items, each with only one fee.
261 # modeled after cust_main::open_cust_bill
262 sub open_cust_bill_pkg {
265 # grep { $_->owed > 0 } $self->cust_bill_pkg
267 my %other = ( 'recur' => 'setup',
268 'setup' => 'recur', );
270 foreach my $field ( qw( recur setup )) {
271 push @open, map { $_->set( $other{$field}, 0 ); $_; }
272 grep { $_->owed($field) > 0 }
273 $self->cust_bill_pkg;
279 =item cust_bill_event
281 Returns the completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
285 sub cust_bill_event {
287 qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
290 =item num_cust_bill_event
292 Returns the number of completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
296 sub num_cust_bill_event {
299 "SELECT COUNT(*) FROM cust_bill_event WHERE invnum = ?";
300 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
301 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
302 $sth->fetchrow_arrayref->[0];
307 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
311 #false laziness w/cust_pkg.pm
315 'table' => 'cust_event',
316 'addl_from' => 'JOIN part_event USING ( eventpart )',
317 'hashref' => { 'tablenum' => $self->invnum },
318 'extra_sql' => " AND eventtable = 'cust_bill' ",
324 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
328 #false laziness w/cust_pkg.pm
332 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
333 " WHERE tablenum = ? AND eventtable = 'cust_bill'";
334 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
335 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
336 $sth->fetchrow_arrayref->[0];
341 Returns the customer (see L<FS::cust_main>) for this invoice.
347 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
350 =item cust_suspend_if_balance_over AMOUNT
352 Suspends the customer associated with this invoice if the total amount owed on
353 this invoice and all older invoices is greater than the specified amount.
355 Returns a list: an empty list on success or a list of errors.
359 sub cust_suspend_if_balance_over {
360 my( $self, $amount ) = ( shift, shift );
361 my $cust_main = $self->cust_main;
362 if ( $cust_main->total_owed_date($self->_date) < $amount ) {
365 $cust_main->suspend(@_);
371 Depreciated. See the cust_credited method.
373 #Returns a list consisting of the total previous credited (see
374 #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
375 #outstanding credits (FS::cust_credit objects).
381 croak "FS::cust_bill->cust_credit depreciated; see ".
382 "FS::cust_bill->cust_credit_bill";
385 #my @cust_credit = sort { $a->_date <=> $b->_date }
386 # grep { $_->credited != 0 && $_->_date < $self->_date }
387 # qsearch('cust_credit', { 'custnum' => $self->custnum } )
389 #foreach (@cust_credit) { $total += $_->credited; }
390 #$total, @cust_credit;
395 Depreciated. See the cust_bill_pay method.
397 #Returns all payments (see L<FS::cust_pay>) for this invoice.
403 croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
405 #sort { $a->_date <=> $b->_date }
406 # qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
412 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
418 sort { $a->_date <=> $b->_date }
419 qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
424 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
430 sort { $a->_date <=> $b->_date }
431 qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
437 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
444 my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
446 foreach (@taxlines) { $total += $_->setup; }
452 Returns the amount owed (still outstanding) on this invoice, which is charged
453 minus all payment applications (see L<FS::cust_bill_pay>) and credit
454 applications (see L<FS::cust_credit_bill>).
460 my $balance = $self->charged;
461 $balance -= $_->amount foreach ( $self->cust_bill_pay );
462 $balance -= $_->amount foreach ( $self->cust_credited );
463 $balance = sprintf( "%.2f", $balance);
464 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
468 =item apply_payments_and_credits
472 sub apply_payments_and_credits {
475 local $SIG{HUP} = 'IGNORE';
476 local $SIG{INT} = 'IGNORE';
477 local $SIG{QUIT} = 'IGNORE';
478 local $SIG{TERM} = 'IGNORE';
479 local $SIG{TSTP} = 'IGNORE';
480 local $SIG{PIPE} = 'IGNORE';
482 my $oldAutoCommit = $FS::UID::AutoCommit;
483 local $FS::UID::AutoCommit = 0;
486 $self->select_for_update; #mutex
488 my @payments = grep { $_->unapplied > 0 } $self->cust_main->cust_pay;
489 my @credits = grep { $_->credited > 0 } $self->cust_main->cust_credit;
491 while ( $self->owed > 0 and ( @payments || @credits ) ) {
494 if ( @payments && @credits ) {
496 #decide which goes first by weight of top (unapplied) line item
498 my @open_lineitems = $self->open_cust_bill_pkg;
501 max( map { $_->part_pkg->pay_weight || 0 }
506 my $max_credit_weight =
507 max( map { $_->part_pkg->credit_weight || 0 }
513 #if both are the same... payments first? it has to be something
514 if ( $max_pay_weight >= $max_credit_weight ) {
520 } elsif ( @payments ) {
522 } elsif ( @credits ) {
525 die "guru meditation #12 and 35";
528 if ( $app eq 'pay' ) {
530 my $payment = shift @payments;
532 $app = new FS::cust_bill_pay {
533 'paynum' => $payment->paynum,
534 'amount' => sprintf('%.2f', min( $payment->unapplied, $self->owed ) ),
537 } elsif ( $app eq 'credit' ) {
539 my $credit = shift @credits;
541 $app = new FS::cust_credit_bill {
542 'crednum' => $credit->crednum,
543 'amount' => sprintf('%.2f', min( $credit->credited, $self->owed ) ),
547 die "guru meditation #12 and 35";
550 $app->invnum( $self->invnum );
552 my $error = $app->insert;
554 $dbh->rollback if $oldAutoCommit;
555 return "Error inserting ". $app->table. " record: $error";
557 die $error if $error;
561 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
566 =item generate_email OPTION => VALUE ...
574 sender address, required
578 alternate template name, optional
582 text attachment arrayref, optional
586 email subject, optional
590 Returns an argument list to be passed to L<FS::Misc::send_email>.
601 my $me = '[FS::cust_bill::generate_email]';
604 'from' => $args{'from'},
605 'subject' => (($args{'subject'}) ? $args{'subject'} : 'Invoice'),
608 if (ref($args{'to'}) eq 'ARRAY') {
609 $return{'to'} = $args{'to'};
611 $return{'to'} = [ grep { $_ !~ /^(POST|FAX)$/ }
612 $self->cust_main->invoicing_list
616 if ( $conf->exists('invoice_html') ) {
618 warn "$me creating HTML/text multipart message"
621 $return{'nobody'} = 1;
623 my $alternative = build MIME::Entity
624 'Type' => 'multipart/alternative',
625 'Encoding' => '7bit',
626 'Disposition' => 'inline'
630 if ( $conf->exists('invoice_email_pdf')
631 and scalar($conf->config('invoice_email_pdf_note')) ) {
633 warn "$me using 'invoice_email_pdf_note' in multipart message"
635 $data = [ map { $_ . "\n" }
636 $conf->config('invoice_email_pdf_note')
641 warn "$me not using 'invoice_email_pdf_note' in multipart message"
643 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
644 $data = $args{'print_text'};
646 $data = [ $self->print_text('', $args{'template'}) ];
651 $alternative->attach(
652 'Type' => 'text/plain',
653 #'Encoding' => 'quoted-printable',
654 'Encoding' => '7bit',
656 'Disposition' => 'inline',
659 $args{'from'} =~ /\@([\w\.\-]+)/;
660 my $from = $1 || 'example.com';
661 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
663 my $path = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
665 if ( defined($args{'template'}) && length($args{'template'})
666 && -e "$path/logo_". $args{'template'}. ".png"
669 $file = "$path/logo_". $args{'template'}. ".png";
671 $file = "$path/logo.png";
674 my $image = build MIME::Entity
675 'Type' => 'image/png',
676 'Encoding' => 'base64',
678 'Filename' => 'logo.png',
679 'Content-ID' => "<$content_id>",
682 $alternative->attach(
683 'Type' => 'text/html',
684 'Encoding' => 'quoted-printable',
685 'Data' => [ '<html>',
688 ' '. encode_entities($return{'subject'}),
691 ' <body bgcolor="#e8e8e8">',
692 $self->print_html('', $args{'template'}, $content_id),
696 'Disposition' => 'inline',
697 #'Filename' => 'invoice.pdf',
700 if ( $conf->exists('invoice_email_pdf') ) {
705 # multipart/alternative
711 my $related = build MIME::Entity 'Type' => 'multipart/related',
712 'Encoding' => '7bit';
714 #false laziness w/Misc::send_email
715 $related->head->replace('Content-type',
717 '; boundary="'. $related->head->multipart_boundary. '"'.
718 '; type=multipart/alternative'
721 $related->add_part($alternative);
723 $related->add_part($image);
725 my $pdf = build MIME::Entity $self->mimebuild_pdf('', $args{'template'});
727 $return{'mimeparts'} = [ $related, $pdf ];
731 #no other attachment:
733 # multipart/alternative
738 $return{'content-type'} = 'multipart/related';
739 $return{'mimeparts'} = [ $alternative, $image ];
740 $return{'type'} = 'multipart/alternative'; #Content-Type of first part...
741 #$return{'disposition'} = 'inline';
747 if ( $conf->exists('invoice_email_pdf') ) {
748 warn "$me creating PDF attachment"
751 #mime parts arguments a la MIME::Entity->build().
752 $return{'mimeparts'} = [
753 { $self->mimebuild_pdf('', $args{'template'}) }
757 if ( $conf->exists('invoice_email_pdf')
758 and scalar($conf->config('invoice_email_pdf_note')) ) {
760 warn "$me using 'invoice_email_pdf_note'"
762 $return{'body'} = [ map { $_ . "\n" }
763 $conf->config('invoice_email_pdf_note')
768 warn "$me not using 'invoice_email_pdf_note'"
770 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
771 $return{'body'} = $args{'print_text'};
773 $return{'body'} = [ $self->print_text('', $args{'template'}) ];
786 Returns a list suitable for passing to MIME::Entity->build(), representing
787 this invoice as PDF attachment.
794 'Type' => 'application/pdf',
795 'Encoding' => 'base64',
796 'Data' => [ $self->print_pdf(@_) ],
797 'Disposition' => 'attachment',
798 'Filename' => 'invoice.pdf',
802 =item send [ TEMPLATENAME [ , AGENTNUM [ , INVOICE_FROM ] ] ]
804 Sends this invoice to the destinations configured for this customer: sends
805 email, prints and/or faxes. See L<FS::cust_main_invoice>.
807 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
809 AGENTNUM, if specified, means that this invoice will only be sent for customers
810 of the specified agent or agent(s). AGENTNUM can be a scalar agentnum (for a
811 single agent) or an arrayref of agentnums.
813 INVOICE_FROM, if specified, overrides the default email invoice From: address.
815 AMOUNT, if specified, only sends the invoice if the total amount owed on this
816 invoice and all older invoices is greater than the specified amount.
823 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
824 or die "invalid invoice number: " . $opt{invnum};
826 my @args = ( $opt{template}, $opt{agentnum} );
827 push @args, $opt{invoice_from}
828 if exists($opt{invoice_from}) && $opt{invoice_from};
830 my $error = $self->send( @args );
831 die $error if $error;
837 my $template = scalar(@_) ? shift : '';
838 if ( scalar(@_) && $_[0] ) {
839 my $agentnums = ref($_[0]) ? shift : [ shift ];
840 return 'N/A' unless grep { $_ == $self->cust_main->agentnum } @$agentnums;
846 : ( $self->_agent_invoice_from || #XXX should go away
847 $conf->config('invoice_from', $self->cust_main->agentnum )
850 my $balance_over = ( scalar(@_) && $_[0] !~ /^\s*$/ ) ? shift : 0;
853 unless $self->cust_main->total_owed_date($self->_date) > $balance_over;
855 my @invoicing_list = $self->cust_main->invoicing_list;
857 #$self->email_invoice($template, $invoice_from)
858 $self->email($template, $invoice_from)
859 if grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list;
861 #$self->print_invoice($template)
862 $self->print($template)
863 if grep { $_ eq 'POST' } @invoicing_list; #postal
865 $self->fax_invoice($template)
866 if grep { $_ eq 'FAX' } @invoicing_list; #fax
872 =item email [ TEMPLATENAME [ , INVOICE_FROM ] ]
876 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
878 INVOICE_FROM, if specified, overrides the default email invoice From: address.
882 sub queueable_email {
885 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
886 or die "invalid invoice number: " . $opt{invnum};
888 my @args = ( $opt{template} );
889 push @args, $opt{invoice_from}
890 if exists($opt{invoice_from}) && $opt{invoice_from};
892 my $error = $self->email( @args );
893 die $error if $error;
900 my $template = scalar(@_) ? shift : '';
904 : ( $self->_agent_invoice_from || #XXX should go away
905 $conf->config('invoice_from', $self->cust_main->agentnum )
909 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
910 $self->cust_main->invoicing_list;
912 #better to notify this person than silence
913 @invoicing_list = ($invoice_from) unless @invoicing_list;
915 my $subject = $self->email_subject($template);
917 my $error = send_email(
918 $self->generate_email(
919 'from' => $invoice_from,
920 'to' => [ grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list ],
921 'subject' => $subject,
922 'template' => $template,
925 die "can't email invoice: $error\n" if $error;
926 #die "$error\n" if $error;
933 #my $template = scalar(@_) ? shift : '';
936 my $subject = $conf->config('invoice_subject', $self->cust_main->agentnum)
939 my $cust_main = $self->cust_main;
940 my $name = $cust_main->name;
941 my $name_short = $cust_main->name_short;
942 my $invoice_number = $self->invnum;
943 my $invoice_date = $self->_date_pretty;
948 =item lpr_data [ TEMPLATENAME ]
950 Returns the postscript or plaintext for this invoice as an arrayref.
952 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
957 my( $self, $template) = @_;
958 $conf->exists('invoice_latex')
959 ? [ $self->print_ps('', $template) ]
960 : [ $self->print_text('', $template) ];
963 =item print [ TEMPLATENAME ]
967 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
974 my $template = scalar(@_) ? shift : '';
976 do_print $self->lpr_data($template);
979 =item fax_invoice [ TEMPLATENAME ]
983 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
989 my $template = scalar(@_) ? shift : '';
991 die 'FAX invoice destination not (yet?) supported with plain text invoices.'
992 unless $conf->exists('invoice_latex');
994 my $dialstring = $self->cust_main->getfield('fax');
997 my $error = send_fax( 'docdata' => $self->lpr_data($template),
998 'dialstring' => $dialstring,
1000 die $error if $error;
1004 =item ftp_invoice [ TEMPLATENAME ]
1006 Sends this invoice data via FTP.
1008 TEMPLATENAME is unused?
1014 my $template = scalar(@_) ? shift : '';
1017 'protocol' => 'ftp',
1018 'server' => $conf->config('cust_bill-ftpserver'),
1019 'username' => $conf->config('cust_bill-ftpusername'),
1020 'password' => $conf->config('cust_bill-ftppassword'),
1021 'dir' => $conf->config('cust_bill-ftpdir'),
1022 'format' => $conf->config('cust_bill-ftpformat'),
1026 =item spool_invoice [ TEMPLATENAME ]
1028 Spools this invoice data (see L<FS::spool_csv>)
1030 TEMPLATENAME is unused?
1036 my $template = scalar(@_) ? shift : '';
1039 'format' => $conf->config('cust_bill-spoolformat'),
1040 'agent_spools' => $conf->exists('cust_bill-spoolagent'),
1044 =item send_if_newest [ TEMPLATENAME [ , AGENTNUM [ , INVOICE_FROM ] ] ]
1046 Like B<send>, but only sends the invoice if it is the newest open invoice for
1051 sub send_if_newest {
1056 grep { $_->owed > 0 }
1057 qsearch('cust_bill', {
1058 'custnum' => $self->custnum,
1059 #'_date' => { op=>'>', value=>$self->_date },
1060 'invnum' => { op=>'>', value=>$self->invnum },
1067 =item send_csv OPTION => VALUE, ...
1069 Sends invoice as a CSV data-file to a remote host with the specified protocol.
1073 protocol - currently only "ftp"
1079 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
1080 and YYMMDDHHMMSS is a timestamp.
1082 See L</print_csv> for a description of the output format.
1087 my($self, %opt) = @_;
1091 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1092 mkdir $spooldir, 0700 unless -d $spooldir;
1094 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1095 my $file = "$spooldir/$tracctnum.csv";
1097 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1099 open(CSV, ">$file") or die "can't open $file: $!";
1107 if ( $opt{protocol} eq 'ftp' ) {
1108 eval "use Net::FTP;";
1110 $net = Net::FTP->new($opt{server}) or die @$;
1112 die "unknown protocol: $opt{protocol}";
1115 $net->login( $opt{username}, $opt{password} )
1116 or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
1118 $net->binary or die "can't set binary mode";
1120 $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
1122 $net->put($file) or die "can't put $file: $!";
1132 Spools CSV invoice data.
1138 =item format - 'default' or 'billco'
1140 =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>).
1142 =item agent_spools - if set to a true value, will spool to per-agent files rather than a single global file
1144 =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.
1151 my($self, %opt) = @_;
1153 my $cust_main = $self->cust_main;
1155 if ( $opt{'dest'} ) {
1156 my %invoicing_list = map { /^(POST|FAX)$/ or 'EMAIL' =~ /^(.*)$/; $1 => 1 }
1157 $cust_main->invoicing_list;
1158 return 'N/A' unless $invoicing_list{$opt{'dest'}}
1159 || ! keys %invoicing_list;
1162 if ( $opt{'balanceover'} ) {
1164 if $cust_main->total_owed_date($self->_date) < $opt{'balanceover'};
1167 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1168 mkdir $spooldir, 0700 unless -d $spooldir;
1170 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1174 ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1175 ( lc($opt{'format'}) eq 'billco' ? '-header' : '' ) .
1178 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1180 open(CSV, ">>$file") or die "can't open $file: $!";
1181 flock(CSV, LOCK_EX);
1186 if ( lc($opt{'format'}) eq 'billco' ) {
1188 flock(CSV, LOCK_UN);
1193 ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1196 open(CSV,">>$file") or die "can't open $file: $!";
1197 flock(CSV, LOCK_EX);
1203 flock(CSV, LOCK_UN);
1210 =item print_csv OPTION => VALUE, ...
1212 Returns CSV data for this invoice.
1216 format - 'default' or 'billco'
1218 Returns a list consisting of two scalars. The first is a single line of CSV
1219 header information for this invoice. The second is one or more lines of CSV
1220 detail information for this invoice.
1222 If I<format> is not specified or "default", the fields of the CSV file are as
1225 record_type, invnum, custnum, _date, charged, first, last, company, address1, address2, city, state, zip, country, pkg, setup, recur, sdate, edate
1229 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
1231 B<record_type> is C<cust_bill> for the initial header line only. The
1232 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
1233 fields are filled in.
1235 B<record_type> is C<cust_bill_pkg> for detail lines. Only the first two fields
1236 (B<record_type> and B<invnum>) and the last five fields (B<pkg> through B<edate>)
1239 =item invnum - invoice number
1241 =item custnum - customer number
1243 =item _date - invoice date
1245 =item charged - total invoice amount
1247 =item first - customer first name
1249 =item last - customer first name
1251 =item company - company name
1253 =item address1 - address line 1
1255 =item address2 - address line 1
1265 =item pkg - line item description
1267 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
1269 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
1271 =item sdate - start date for recurring fee
1273 =item edate - end date for recurring fee
1277 If I<format> is "billco", the fields of the header CSV file are as follows:
1279 +-------------------------------------------------------------------+
1280 | FORMAT HEADER FILE |
1281 |-------------------------------------------------------------------|
1282 | Field | Description | Name | Type | Width |
1283 | 1 | N/A-Leave Empty | RC | CHAR | 2 |
1284 | 2 | N/A-Leave Empty | CUSTID | CHAR | 15 |
1285 | 3 | Transaction Account No | TRACCTNUM | CHAR | 15 |
1286 | 4 | Transaction Invoice No | TRINVOICE | CHAR | 15 |
1287 | 5 | Transaction Zip Code | TRZIP | CHAR | 5 |
1288 | 6 | Transaction Company Bill To | TRCOMPANY | CHAR | 30 |
1289 | 7 | Transaction Contact Bill To | TRNAME | CHAR | 30 |
1290 | 8 | Additional Address Unit Info | TRADDR1 | CHAR | 30 |
1291 | 9 | Bill To Street Address | TRADDR2 | CHAR | 30 |
1292 | 10 | Ancillary Billing Information | TRADDR3 | CHAR | 30 |
1293 | 11 | Transaction City Bill To | TRCITY | CHAR | 20 |
1294 | 12 | Transaction State Bill To | TRSTATE | CHAR | 2 |
1295 | 13 | Bill Cycle Close Date | CLOSEDATE | CHAR | 10 |
1296 | 14 | Bill Due Date | DUEDATE | CHAR | 10 |
1297 | 15 | Previous Balance | BALFWD | NUM* | 9 |
1298 | 16 | Pmt/CR Applied | CREDAPPLY | NUM* | 9 |
1299 | 17 | Total Current Charges | CURRENTCHG | NUM* | 9 |
1300 | 18 | Total Amt Due | TOTALDUE | NUM* | 9 |
1301 | 19 | Total Amt Due | AMTDUE | NUM* | 9 |
1302 | 20 | 30 Day Aging | AMT30 | NUM* | 9 |
1303 | 21 | 60 Day Aging | AMT60 | NUM* | 9 |
1304 | 22 | 90 Day Aging | AMT90 | NUM* | 9 |
1305 | 23 | Y/N | AGESWITCH | CHAR | 1 |
1306 | 24 | Remittance automation | SCANLINE | CHAR | 100 |
1307 | 25 | Total Taxes & Fees | TAXTOT | NUM* | 9 |
1308 | 26 | Customer Reference Number | CUSTREF | CHAR | 15 |
1309 | 27 | Federal Tax*** | FEDTAX | NUM* | 9 |
1310 | 28 | State Tax*** | STATETAX | NUM* | 9 |
1311 | 29 | Other Taxes & Fees*** | OTHERTAX | NUM* | 9 |
1312 +-------+-------------------------------+------------+------+-------+
1314 If I<format> is "billco", the fields of the detail CSV file are as follows:
1316 FORMAT FOR DETAIL FILE
1318 Field | Description | Name | Type | Width
1319 1 | N/A-Leave Empty | RC | CHAR | 2
1320 2 | N/A-Leave Empty | CUSTID | CHAR | 15
1321 3 | Account Number | TRACCTNUM | CHAR | 15
1322 4 | Invoice Number | TRINVOICE | CHAR | 15
1323 5 | Line Sequence (sort order) | LINESEQ | NUM | 6
1324 6 | Transaction Detail | DETAILS | CHAR | 100
1325 7 | Amount | AMT | NUM* | 9
1326 8 | Line Format Control** | LNCTRL | CHAR | 2
1327 9 | Grouping Code | GROUP | CHAR | 2
1328 10 | User Defined | ACCT CODE | CHAR | 15
1333 my($self, %opt) = @_;
1335 eval "use Text::CSV_XS";
1338 my $cust_main = $self->cust_main;
1340 my $csv = Text::CSV_XS->new({'always_quote'=>1});
1342 if ( lc($opt{'format'}) eq 'billco' ) {
1345 $taxtotal += $_->{'amount'} foreach $self->_items_tax;
1347 my $duedate = $self->due_date2str('%m/%d/%Y'); #date_format?
1349 my( $previous_balance, @unused ) = $self->previous; #previous balance
1351 my $pmt_cr_applied = 0;
1352 $pmt_cr_applied += $_->{'amount'}
1353 foreach ( $self->_items_payments, $self->_items_credits ) ;
1355 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
1358 '', # 1 | N/A-Leave Empty CHAR 2
1359 '', # 2 | N/A-Leave Empty CHAR 15
1360 $opt{'tracctnum'}, # 3 | Transaction Account No CHAR 15
1361 $self->invnum, # 4 | Transaction Invoice No CHAR 15
1362 $cust_main->zip, # 5 | Transaction Zip Code CHAR 5
1363 $cust_main->company, # 6 | Transaction Company Bill To CHAR 30
1364 #$cust_main->payname, # 7 | Transaction Contact Bill To CHAR 30
1365 $cust_main->contact, # 7 | Transaction Contact Bill To CHAR 30
1366 $cust_main->address2, # 8 | Additional Address Unit Info CHAR 30
1367 $cust_main->address1, # 9 | Bill To Street Address CHAR 30
1368 '', # 10 | Ancillary Billing Information CHAR 30
1369 $cust_main->city, # 11 | Transaction City Bill To CHAR 20
1370 $cust_main->state, # 12 | Transaction State Bill To CHAR 2
1373 time2str("%m/%d/%Y", $self->_date), # 13 | Bill Cycle Close Date CHAR 10
1376 $duedate, # 14 | Bill Due Date CHAR 10
1378 $previous_balance, # 15 | Previous Balance NUM* 9
1379 $pmt_cr_applied, # 16 | Pmt/CR Applied NUM* 9
1380 sprintf("%.2f", $self->charged), # 17 | Total Current Charges NUM* 9
1381 $totaldue, # 18 | Total Amt Due NUM* 9
1382 $totaldue, # 19 | Total Amt Due NUM* 9
1383 '', # 20 | 30 Day Aging NUM* 9
1384 '', # 21 | 60 Day Aging NUM* 9
1385 '', # 22 | 90 Day Aging NUM* 9
1386 'N', # 23 | Y/N CHAR 1
1387 '', # 24 | Remittance automation CHAR 100
1388 $taxtotal, # 25 | Total Taxes & Fees NUM* 9
1389 $self->custnum, # 26 | Customer Reference Number CHAR 15
1390 '0', # 27 | Federal Tax*** NUM* 9
1391 sprintf("%.2f", $taxtotal), # 28 | State Tax*** NUM* 9
1392 '0', # 29 | Other Taxes & Fees*** NUM* 9
1401 time2str("%x", $self->_date),
1402 sprintf("%.2f", $self->charged),
1403 ( map { $cust_main->getfield($_) }
1404 qw( first last company address1 address2 city state zip country ) ),
1406 ) or die "can't create csv";
1409 my $header = $csv->string. "\n";
1412 if ( lc($opt{'format'}) eq 'billco' ) {
1415 foreach my $item ( $self->_items_pkg ) {
1418 '', # 1 | N/A-Leave Empty CHAR 2
1419 '', # 2 | N/A-Leave Empty CHAR 15
1420 $opt{'tracctnum'}, # 3 | Account Number CHAR 15
1421 $self->invnum, # 4 | Invoice Number CHAR 15
1422 $lineseq++, # 5 | Line Sequence (sort order) NUM 6
1423 $item->{'description'}, # 6 | Transaction Detail CHAR 100
1424 $item->{'amount'}, # 7 | Amount NUM* 9
1425 '', # 8 | Line Format Control** CHAR 2
1426 '', # 9 | Grouping Code CHAR 2
1427 '', # 10 | User Defined CHAR 15
1430 $detail .= $csv->string. "\n";
1436 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1438 my($pkg, $setup, $recur, $sdate, $edate);
1439 if ( $cust_bill_pkg->pkgnum ) {
1441 ($pkg, $setup, $recur, $sdate, $edate) = (
1442 $cust_bill_pkg->part_pkg->pkg,
1443 ( $cust_bill_pkg->setup != 0
1444 ? sprintf("%.2f", $cust_bill_pkg->setup )
1446 ( $cust_bill_pkg->recur != 0
1447 ? sprintf("%.2f", $cust_bill_pkg->recur )
1449 ( $cust_bill_pkg->sdate
1450 ? time2str("%x", $cust_bill_pkg->sdate)
1452 ($cust_bill_pkg->edate
1453 ?time2str("%x", $cust_bill_pkg->edate)
1457 } else { #pkgnum tax
1458 next unless $cust_bill_pkg->setup != 0;
1459 my $itemdesc = defined $cust_bill_pkg->dbdef_table->column('itemdesc')
1460 ? ( $cust_bill_pkg->itemdesc || 'Tax' )
1462 ($pkg, $setup, $recur, $sdate, $edate) =
1463 ( $itemdesc, sprintf("%10.2f",$cust_bill_pkg->setup), '', '', '' );
1469 ( map { '' } (1..11) ),
1470 ($pkg, $setup, $recur, $sdate, $edate)
1471 ) or die "can't create csv";
1473 $detail .= $csv->string. "\n";
1479 ( $header, $detail );
1485 Pays this invoice with a compliemntary payment. If there is an error,
1486 returns the error, otherwise returns false.
1492 my $cust_pay = new FS::cust_pay ( {
1493 'invnum' => $self->invnum,
1494 'paid' => $self->owed,
1497 'payinfo' => $self->cust_main->payinfo,
1505 Attempts to pay this invoice with a credit card payment via a
1506 Business::OnlinePayment realtime gateway. See
1507 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1508 for supported processors.
1514 $self->realtime_bop( 'CC', @_ );
1519 Attempts to pay this invoice with an electronic check (ACH) payment via a
1520 Business::OnlinePayment realtime gateway. See
1521 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1522 for supported processors.
1528 $self->realtime_bop( 'ECHECK', @_ );
1533 Attempts to pay this invoice with phone bill (LEC) payment via a
1534 Business::OnlinePayment realtime gateway. See
1535 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1536 for supported processors.
1542 $self->realtime_bop( 'LEC', @_ );
1546 my( $self, $method ) = @_;
1548 my $cust_main = $self->cust_main;
1549 my $balance = $cust_main->balance;
1550 my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
1551 $amount = sprintf("%.2f", $amount);
1552 return "not run (balance $balance)" unless $amount > 0;
1554 my $description = 'Internet Services';
1555 if ( $conf->exists('business-onlinepayment-description') ) {
1556 my $dtempl = $conf->config('business-onlinepayment-description');
1558 my $agent_obj = $cust_main->agent
1559 or die "can't retreive agent for $cust_main (agentnum ".
1560 $cust_main->agentnum. ")";
1561 my $agent = $agent_obj->agent;
1562 my $pkgs = join(', ',
1563 map { $_->part_pkg->pkg }
1564 grep { $_->pkgnum } $self->cust_bill_pkg
1566 $description = eval qq("$dtempl");
1569 $cust_main->realtime_bop($method, $amount,
1570 'description' => $description,
1571 'invnum' => $self->invnum,
1576 =item batch_card OPTION => VALUE...
1578 Adds a payment for this invoice to the pending credit card batch (see
1579 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
1580 runs the payment using a realtime gateway.
1585 my ($self, %options) = @_;
1586 my $cust_main = $self->cust_main;
1588 $options{invnum} = $self->invnum;
1590 $cust_main->batch_card(%options);
1593 sub _agent_template {
1595 $self->cust_main->agent_template;
1598 sub _agent_invoice_from {
1600 $self->cust_main->agent_invoice_from;
1603 =item print_text [ TIME [ , TEMPLATE ] ]
1605 Returns an text invoice, as a list of lines.
1607 TIME an optional value used to control the printing of overdue messages. The
1608 default is now. It isn't the date of the invoice; that's the `_date' field.
1609 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1610 L<Time::Local> and L<Date::Parse> for conversion functions.
1615 my( $self, $today, $template ) = @_;
1617 my %params = ( 'format' => 'template' );
1618 $params{'time'} = $today if $today;
1619 $params{'template'} = $template if $template;
1621 $self->print_generic( %params );
1624 =item print_latex [ TIME [ , TEMPLATE ] ]
1626 Internal method - returns a filename of a filled-in LaTeX template for this
1627 invoice (Note: add ".tex" to get the actual filename), and a filename of
1628 an associated logo (with the .eps extension included).
1630 See print_ps and print_pdf for methods that return PostScript and PDF output.
1632 TIME an optional value used to control the printing of overdue messages. The
1633 default is now. It isn't the date of the invoice; that's the `_date' field.
1634 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1635 L<Time::Local> and L<Date::Parse> for conversion functions.
1641 my( $self, $today, $template ) = @_;
1643 my %params = ( 'format' => 'latex' );
1644 $params{'time'} = $today if $today;
1645 $params{'template'} = $template if $template;
1647 $template ||= $self->_agent_template;
1649 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1650 my $lh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
1654 ) or die "can't open temp file: $!\n";
1656 if ($template && $conf->exists("logo_${template}.eps")) {
1657 print $lh $conf->config_binary("logo_${template}.eps")
1658 or die "can't write temp file: $!\n";
1660 print $lh $conf->config_binary('logo.eps')
1661 or die "can't write temp file: $!\n";
1664 $params{'logo_file'} = $lh->filename;
1666 my @filled_in = $self->print_generic( %params );
1668 my $fh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
1672 ) or die "can't open temp file: $!\n";
1673 print $fh join('', @filled_in );
1676 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
1677 return ($1, $params{'logo_file'});
1681 =item print_generic OPTIONS_HASH
1683 Internal method - returns a filled-in template for this invoice as a scalar.
1685 See print_ps and print_pdf for methods that return PostScript and PDF output.
1687 Non optional options include
1688 format - latex, html, template
1690 Optional options include
1692 template - a value used as a suffix for a configuration template
1694 time - a value used to control the printing of overdue messages. The
1695 default is now. It isn't the date of the invoice; that's the `_date' field.
1696 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1697 L<Time::Local> and L<Date::Parse> for conversion functions.
1701 unsquelch_cdr - overrides any per customer cdr squelching when true
1705 #what's with all the sprintf('%10.2f')'s in here? will it cause any
1706 # (alignment?) problems to change them all to '%.2f' ?
1709 my( $self, %params ) = @_;
1710 my $today = $params{today} ? $params{today} : time;
1711 warn "FS::cust_bill::print_generic called on $self with suffix $params{template}\n"
1714 my $format = $params{format};
1715 die "Unknown format: $format"
1716 unless $format =~ /^(latex|html|template)$/;
1718 my $cust_main = $self->cust_main;
1719 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
1720 unless $cust_main->payname
1721 && $cust_main->payby !~ /^(CARD|DCRD|CHEK|DCHK)$/;
1723 my %delimiters = ( 'latex' => [ '[@--', '--@]' ],
1724 'html' => [ '<%=', '%>' ],
1725 'template' => [ '{', '}' ],
1728 #create the template
1729 my $template = $params{template} ? $params{template} : $self->_agent_template;
1730 my $templatefile = "invoice_$format";
1731 $templatefile .= "_$template"
1732 if length($template);
1733 my @invoice_template = map "$_\n", $conf->config($templatefile)
1734 or die "cannot load config data $templatefile";
1737 if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
1738 #change this to a die when the old code is removed
1739 warn "old-style invoice template $templatefile; ".
1740 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
1741 $old_latex = 'true';
1742 @invoice_template = _translate_old_latex_format(@invoice_template);
1745 my $text_template = new Text::Template(
1747 SOURCE => \@invoice_template,
1748 DELIMITERS => $delimiters{$format},
1751 $text_template->compile()
1752 or die "Can't compile $templatefile: $Text::Template::ERROR\n";
1755 # additional substitution could possibly cause breakage in existing templates
1756 my %convert_maps = (
1758 'notes' => sub { map "$_", @_ },
1759 'footer' => sub { map "$_", @_ },
1760 'smallfooter' => sub { map "$_", @_ },
1761 'returnaddress' => sub { map "$_", @_ },
1762 'coupon' => sub { map "$_", @_ },
1768 s/%%(.*)$/<!-- $1 -->/g;
1769 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
1770 s/\\begin\{enumerate\}/<ol>/g;
1772 s/\\end\{enumerate\}/<\/ol>/g;
1773 s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
1782 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
1784 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
1789 s/\\\\\*?\s*$/<BR>/;
1790 s/\\hyphenation\{[\w\s\-]+}//;
1795 'coupon' => sub { "" },
1802 s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
1803 s/\\begin\{enumerate\}//g;
1805 s/\\end\{enumerate\}//g;
1806 s/\\textbf\{(.*)\}/$1/g;
1813 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
1815 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
1820 s/\\\\\*?\s*$/\n/; # dubious
1821 s/\\hyphenation\{[\w\s\-]+}//;
1825 'coupon' => sub { "" },
1830 # hashes for differing output formats
1831 my %nbsps = ( 'latex' => '~',
1832 'html' => '', # '&nbps;' would be nice
1833 'template' => '', # not used
1835 my $nbsp = $nbsps{$format};
1837 my %escape_functions = ( 'latex' => \&_latex_escape,
1838 'html' => \&encode_entities,
1839 'template' => sub { shift },
1841 my $escape_function = $escape_functions{$format};
1843 my %date_formats = ( 'latex' => '%b %o, %Y',
1844 'html' => '%b %o, %Y',
1847 my $date_format = $date_formats{$format};
1849 my %embolden_functions = ( 'latex' => sub { return '\textbf{'. shift(). '}'
1851 'html' => sub { return '<b>'. shift(). '</b>'
1853 'template' => sub { shift },
1855 my $embolden_function = $embolden_functions{$format};
1858 # generate template variables
1861 defined( $conf->config_orbase( "invoice_${format}returnaddress",
1865 && length( $conf->config_orbase( "invoice_${format}returnaddress",
1871 $returnaddress = join("\n",
1872 $conf->config_orbase("invoice_${format}returnaddress", $template)
1875 } elsif ( grep /\S/,
1876 $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
1878 my $convert_map = $convert_maps{$format}{'returnaddress'};
1881 &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
1886 } elsif ( grep /\S/, $conf->config('company_address', $self->cust_main->agentnum) ) {
1888 my $convert_map = $convert_maps{$format}{'returnaddress'};
1889 $returnaddress = join( "\n", &$convert_map(
1890 map { s/( {2,})/'~' x length($1)/eg;
1894 ( $conf->config('company_name', $self->cust_main->agentnum),
1895 $conf->config('company_address', $self->cust_main->agentnum),
1902 my $warning = "Couldn't find a return address; ".
1903 "do you need to set the company_address configuration value?";
1905 $returnaddress = $nbsp;
1906 #$returnaddress = $warning;
1910 my %invoice_data = (
1911 'company_name' => scalar( $conf->config('company_name', $self->cust_main->agentnum) ),
1912 'company_address' => join("\n", $conf->config('company_address', $self->cust_main->agentnum) ). "\n",
1913 'custnum' => $cust_main->display_custnum,
1914 'invnum' => $self->invnum,
1915 'date' => time2str($date_format, $self->_date),
1916 'today' => time2str('%b %o, %Y', $today),
1917 'agent' => &$escape_function($cust_main->agent->agent),
1918 'agent_custid' => &$escape_function($cust_main->agent_custid),
1919 'payname' => &$escape_function($cust_main->payname),
1920 'company' => &$escape_function($cust_main->company),
1921 'address1' => &$escape_function($cust_main->address1),
1922 'address2' => &$escape_function($cust_main->address2),
1923 'city' => &$escape_function($cust_main->city),
1924 'state' => &$escape_function($cust_main->state),
1925 'zip' => &$escape_function($cust_main->zip),
1926 'fax' => &$escape_function($cust_main->fax),
1927 'returnaddress' => $returnaddress,
1929 'terms' => $self->terms,
1930 'template' => $template, #params{'template'},
1931 #'notes' => join("\n", $conf->config('invoice_latexnotes') ),
1932 # better hang on to conf_dir for a while
1933 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
1936 'current_charges' => sprintf("%.2f", $self->charged),
1937 'duedate' => $self->due_date2str('%m/%d/%Y'), #date_format?
1938 'ship_enable' => $conf->exists('invoice-ship_address'),
1939 'unitprices' => $conf->exists('invoice-unitprice'),
1942 my $countrydefault = $conf->config('countrydefault') || 'US';
1943 my $prefix = $cust_main->has_ship_address ? 'ship_' : '';
1944 foreach ( qw( contact company address1 address2 city state zip country fax) ){
1945 my $method = $prefix.$_;
1946 $invoice_data{"ship_$_"} = _latex_escape($cust_main->$method);
1948 $invoice_data{'ship_country'} = ''
1949 if ( $invoice_data{'ship_country'} eq $countrydefault );
1951 $invoice_data{'cid'} = $params{'cid'}
1954 if ( $cust_main->country eq $countrydefault ) {
1955 $invoice_data{'country'} = '';
1957 $invoice_data{'country'} = &$escape_function(code2country($cust_main->country));
1961 $invoice_data{'address'} = \@address;
1963 $cust_main->payname.
1964 ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
1965 ? " (P.O. #". $cust_main->payinfo. ")"
1969 push @address, $cust_main->company
1970 if $cust_main->company;
1971 push @address, $cust_main->address1;
1972 push @address, $cust_main->address2
1973 if $cust_main->address2;
1975 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
1976 push @address, $invoice_data{'country'}
1977 if $invoice_data{'country'};
1979 while (scalar(@address) < 5);
1981 $invoice_data{'logo_file'} = $params{'logo_file'}
1982 if $params{'logo_file'};
1984 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
1985 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
1986 #my $balance_due = $self->owed + $pr_total - $cr_total;
1987 my $balance_due = $self->owed + $pr_total;
1988 $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
1989 $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
1991 #do variable substitution in notes, footer, smallfooter
1992 foreach my $include (qw( notes footer smallfooter coupon )) {
1994 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1997 if ( $conf->exists($inc_file) && length( $conf->config($inc_file) ) ) {
1999 @inc_src = $conf->config($inc_file);
2003 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
2005 my $convert_map = $convert_maps{$format}{$include};
2007 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
2008 s/--\@\]/$delimiters{$format}[1]/g;
2011 &$convert_map( $conf->config($inc_file) );
2015 my $inc_tt = new Text::Template (
2017 SOURCE => [ map "$_\n", @inc_src ],
2018 DELIMITERS => $delimiters{$format},
2019 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
2021 unless ( $inc_tt->compile() ) {
2022 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
2023 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
2027 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
2029 $invoice_data{$include} =~ s/\n+$//
2030 if ($format eq 'latex');
2033 $invoice_data{'po_line'} =
2034 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
2035 ? &$escape_function("Purchase Order #". $cust_main->payinfo)
2038 my %money_chars = ( 'latex' => '',
2039 'html' => $conf->config('money_char') || '$',
2042 my $money_char = $money_chars{$format};
2044 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
2045 'html' => $conf->config('money_char') || '$',
2048 my $other_money_char = $other_money_chars{$format};
2050 my @detail_items = ();
2051 my @total_items = ();
2055 $invoice_data{'detail_items'} = \@detail_items;
2056 $invoice_data{'total_items'} = \@total_items;
2057 $invoice_data{'buf'} = \@buf;
2058 $invoice_data{'sections'} = \@sections;
2060 my $previous_section = { 'description' => 'Previous Charges',
2061 'subtotal' => $other_money_char.
2062 sprintf('%.2f', $pr_total),
2066 my $tax_section = { 'description' => 'Taxes, Surcharges, and Fees',
2067 'subtotal' => $taxtotal }; # adjusted below
2069 my $adjusttotal = 0;
2070 my $adjust_section = { 'description' => 'Credits, Payments, and Adjustments',
2071 'subtotal' => 0 }; # adjusted below
2073 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
2074 my $multisection = $conf->exists('invoice_sections', $cust_main->agentnum);
2075 my $late_sections = [];
2076 if ( $multisection ) {
2077 push @sections, $self->_items_sections( $late_sections );
2079 push @sections, { 'description' => '', 'subtotal' => '' };
2082 foreach my $line_item ( $conf->exists('disable_previous_balance')
2084 : $self->_items_previous
2088 ext_description => [],
2090 $detail->{'ref'} = $line_item->{'pkgnum'};
2091 $detail->{'quantity'} = 1;
2092 $detail->{'section'} = $previous_section;
2093 $detail->{'description'} = &$escape_function($line_item->{'description'});
2094 if ( exists $line_item->{'ext_description'} ) {
2095 @{$detail->{'ext_description'}} = map {
2096 &$escape_function($_);
2097 } @{$line_item->{'ext_description'}};
2099 $detail->{'amount'} = ( $old_latex ? '' : $money_char).
2100 $line_item->{'amount'};
2101 $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
2103 push @detail_items, $detail;
2104 push @buf, [ $detail->{'description'},
2105 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
2109 if ( @pr_cust_bill && !$conf->exists('disable_previous_balance') ) {
2110 push @buf, ['','-----------'];
2111 push @buf, [ 'Total Previous Balance',
2112 $money_char. sprintf("%10.2f", $pr_total) ];
2116 foreach my $section (@sections, @$late_sections) {
2118 $section->{'subtotal'} = $other_money_char.
2119 sprintf('%.2f', $section->{'subtotal'})
2122 if ( $section->{'description'} ) {
2123 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
2129 $options{'section'} = $section if $multisection;
2130 $options{'format'} = $format;
2131 $options{'escape_function'} = $escape_function;
2132 $options{'format_function'} = sub { () } unless $unsquelched;
2133 $options{'unsquelched'} = $unsquelched;
2135 foreach my $line_item ( $self->_items_pkg(%options) ) {
2137 ext_description => [],
2139 $detail->{'ref'} = $line_item->{'pkgnum'};
2140 $detail->{'quantity'} = $line_item->{'quantity'};
2141 $detail->{'section'} = $section;
2142 $detail->{'description'} = &$escape_function($line_item->{'description'});
2143 if ( exists $line_item->{'ext_description'} ) {
2144 @{$detail->{'ext_description'}} = @{$line_item->{'ext_description'}};
2146 $detail->{'amount'} = ( $old_latex ? '' : $money_char ).
2147 $line_item->{'amount'};
2148 $detail->{'unit_amount'} = ( $old_latex ? '' : $money_char ).
2149 $line_item->{'unit_amount'};
2150 $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
2152 push @detail_items, $detail;
2153 push @buf, ( [ $detail->{'description'},
2154 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
2156 map { [ " ". $_, '' ] } @{$detail->{'ext_description'}},
2160 if ( $section->{'description'} ) {
2161 push @buf, ( ['','-----------'],
2162 [ $section->{'description'}. ' sub-total',
2163 $money_char. sprintf("%10.2f", $section->{'subtotal'})
2172 if ( $multisection && !$conf->exists('disable_previous_balance') ) {
2173 unshift @sections, $previous_section if $pr_total;
2176 foreach my $tax ( $self->_items_tax ) {
2178 $taxtotal += $tax->{'amount'};
2180 my $description = &$escape_function( $tax->{'description'} );
2181 my $amount = sprintf( '%.2f', $tax->{'amount'} );
2183 if ( $multisection ) {
2185 my $money = $old_latex ? '' : $money_char;
2186 push @detail_items, {
2187 ext_description => [],
2190 description => $description,
2191 amount => $money. $amount,
2193 section => $tax_section,
2198 push @total_items, {
2199 'total_item' => $description,
2200 'total_amount' => $other_money_char. $amount,
2205 push @buf,[ $description,
2206 $money_char. $amount,
2213 $total->{'total_item'} = 'Sub-total';
2214 $total->{'total_amount'} =
2215 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
2217 if ( $multisection ) {
2218 $tax_section->{'subtotal'} = $other_money_char.
2219 sprintf('%.2f', $taxtotal);
2220 $tax_section->{'pretotal'} = 'New charges sub-total '.
2221 $total->{'total_amount'};
2222 push @sections, $tax_section if $taxtotal;
2224 unshift @total_items, $total;
2227 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
2229 push @buf,['','-----------'];
2230 push @buf,[( $conf->exists('disable_previous_balance')
2232 : 'Total New Charges'
2234 $money_char. sprintf("%10.2f",$self->charged) ];
2239 $total->{'total_item'} = &$embolden_function('Total');
2240 $total->{'total_amount'} =
2241 &$embolden_function(
2244 $self->charged + ( $conf->exists('disable_previous_balance')
2250 if ( $multisection ) {
2251 $adjust_section->{'pretotal'} = 'New charges total '. $other_money_char.
2252 sprintf('%.2f', $self->charged );
2254 push @total_items, $total;
2256 push @buf,['','-----------'];
2257 push @buf,['Total Charges',
2259 sprintf( '%10.2f', $self->charged +
2260 ( $conf->exists('disable_previous_balance')
2269 unless ( $conf->exists('disable_previous_balance') ) {
2270 #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
2273 my $credittotal = 0;
2274 foreach my $credit ( $self->_items_credits ) {
2276 $total->{'total_item'} = &$escape_function($credit->{'description'});
2277 $credittotal += $credit->{'amount'};
2278 $total->{'total_amount'} = '-'. $other_money_char. $credit->{'amount'};
2279 $adjusttotal += $credit->{'amount'};
2280 if ( $multisection ) {
2281 my $money = $old_latex ? '' : $money_char;
2282 push @detail_items, {
2283 ext_description => [],
2286 description => &$escape_function($credit->{'description'}),
2287 amount => $money. $credit->{'amount'},
2289 section => $adjust_section,
2292 push @total_items, $total;
2295 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
2298 foreach ( $self->cust_credited ) {
2300 #something more elaborate if $_->amount ne $_->cust_credit->credited ?
2302 my $reason = substr($_->cust_credit->reason,0,32);
2303 $reason .= '...' if length($reason) < length($_->cust_credit->reason);
2304 $reason = " ($reason) " if $reason;
2306 "Credit #". $_->crednum. " (". time2str("%x",$_->cust_credit->_date) .")". $reason,
2307 $money_char. sprintf("%10.2f",$_->amount)
2312 my $paymenttotal = 0;
2313 foreach my $payment ( $self->_items_payments ) {
2315 $total->{'total_item'} = &$escape_function($payment->{'description'});
2316 $paymenttotal += $payment->{'amount'};
2317 $total->{'total_amount'} = '-'. $other_money_char. $payment->{'amount'};
2318 $adjusttotal += $payment->{'amount'};
2319 if ( $multisection ) {
2320 my $money = $old_latex ? '' : $money_char;
2321 push @detail_items, {
2322 ext_description => [],
2325 description => &$escape_function($payment->{'description'}),
2326 amount => $money. $payment->{'amount'},
2328 section => $adjust_section,
2331 push @total_items, $total;
2333 push @buf, [ $payment->{'description'},
2334 $money_char. sprintf("%10.2f", $payment->{'amount'}),
2337 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
2339 if ( $multisection ) {
2340 $adjust_section->{'subtotal'} = $other_money_char.
2341 sprintf('%.2f', $adjusttotal);
2342 push @sections, $adjust_section;
2347 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
2348 $total->{'total_amount'} =
2349 &$embolden_function(
2350 $other_money_char. sprintf('%.2f', $self->owed + $pr_total )
2352 if ( $multisection ) {
2353 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
2354 $total->{'total_amount'};
2356 push @total_items, $total;
2358 push @buf,['','-----------'];
2359 push @buf,[$self->balance_due_msg, $money_char.
2360 sprintf("%10.2f", $balance_due ) ];
2364 if ( $multisection ) {
2365 push @sections, @$late_sections
2371 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
2372 /invoice_lines\((\d*)\)/;
2373 $invoice_lines += $1 || scalar(@buf);
2376 die "no invoice_lines() functions in template?"
2377 if ( $format eq 'template' && !$wasfunc );
2379 if ($format eq 'template') {
2381 if ( $invoice_lines ) {
2382 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
2383 $invoice_data{'total_pages'}++
2384 if scalar(@buf) % $invoice_lines;
2387 #setup subroutine for the template
2388 sub FS::cust_bill::_template::invoice_lines {
2389 my $lines = shift || scalar(@FS::cust_bill::_template::buf);
2391 scalar(@FS::cust_bill::_template::buf)
2392 ? shift @FS::cust_bill::_template::buf
2401 push @collect, split("\n",
2402 $text_template->fill_in( HASH => \%invoice_data,
2403 PACKAGE => 'FS::cust_bill::_template'
2406 $FS::cust_bill::_template::page++;
2408 map "$_\n", @collect;
2410 warn "filling in template for invoice ". $self->invnum. "\n"
2412 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
2415 $text_template->fill_in(HASH => \%invoice_data);
2419 =item print_ps [ TIME [ , TEMPLATE ] ]
2421 Returns an postscript invoice, as a scalar.
2423 TIME an optional value used to control the printing of overdue messages. The
2424 default is now. It isn't the date of the invoice; that's the `_date' field.
2425 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2426 L<Time::Local> and L<Date::Parse> for conversion functions.
2433 my ($file, $lfile) = $self->print_latex(@_);
2434 my $ps = generate_ps($file);
2440 =item print_pdf [ TIME [ , TEMPLATE ] ]
2442 Returns an PDF invoice, as a scalar.
2444 TIME an optional value used to control the printing of overdue messages. The
2445 default is now. It isn't the date of the invoice; that's the `_date' field.
2446 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2447 L<Time::Local> and L<Date::Parse> for conversion functions.
2454 my ($file, $lfile) = $self->print_latex(@_);
2455 my $pdf = generate_pdf($file);
2461 =item print_html [ TIME [ , TEMPLATE [ , CID ] ] ]
2463 Returns an HTML invoice, as a scalar.
2465 TIME an optional value used to control the printing of overdue messages. The
2466 default is now. It isn't the date of the invoice; that's the `_date' field.
2467 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2468 L<Time::Local> and L<Date::Parse> for conversion functions.
2470 CID is a MIME Content-ID used to create a "cid:" URL for the logo image, used
2471 when emailing the invoice as part of a multipart/related MIME email.
2479 %params = %{ shift() };
2481 $params{'time'} = shift;
2482 $params{'template'} = shift;
2483 $params{'cid'} = shift;
2486 $params{'format'} = 'html';
2488 $self->print_generic( %params );
2491 # quick subroutine for print_latex
2493 # There are ten characters that LaTeX treats as special characters, which
2494 # means that they do not simply typeset themselves:
2495 # # $ % & ~ _ ^ \ { }
2497 # TeX ignores blanks following an escaped character; if you want a blank (as
2498 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
2502 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
2503 $value =~ s/([<>])/\$$1\$/g;
2507 #utility methods for print_*
2509 sub _translate_old_latex_format {
2510 warn "_translate_old_latex_format called\n"
2517 if ( $line =~ /^%%Detail\s*$/ ) {
2519 push @template, q![@--!,
2520 q! foreach my $_tr_line (@detail_items) {!,
2521 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
2522 q! $_tr_line->{'description'} .= !,
2523 q! "\\tabularnewline\n~~".!,
2524 q! join( "\\tabularnewline\n~~",!,
2525 q! @{$_tr_line->{'ext_description'}}!,
2529 while ( ( my $line_item_line = shift )
2530 !~ /^%%EndDetail\s*$/ ) {
2531 $line_item_line =~ s/'/\\'/g; # nice LTS
2532 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
2533 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
2534 push @template, " \$OUT .= '$line_item_line';";
2537 push @template, '}',
2540 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
2542 push @template, '[@--',
2543 ' foreach my $_tr_line (@total_items) {';
2545 while ( ( my $total_item_line = shift )
2546 !~ /^%%EndTotalDetails\s*$/ ) {
2547 $total_item_line =~ s/'/\\'/g; # nice LTS
2548 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
2549 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
2550 push @template, " \$OUT .= '$total_item_line';";
2553 push @template, '}',
2557 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
2558 push @template, $line;
2564 warn "$_\n" foreach @template;
2573 #check for an invoice- specific override (eventually)
2575 #check for a customer- specific override
2576 return $self->cust_main->invoice_terms
2577 if $self->cust_main->invoice_terms;
2579 #use configured default or default default
2580 $conf->config('invoice_default_terms') || 'Payable upon receipt';
2586 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
2587 $duedate = $self->_date() + ( $1 * 86400 );
2594 $self->due_date ? time2str(shift, $self->due_date) : '';
2597 sub balance_due_msg {
2599 my $msg = 'Balance Due';
2600 return $msg unless $self->terms;
2601 if ( $self->due_date ) {
2602 $msg .= ' - Please pay by '. $self->due_date2str('%x');
2603 } elsif ( $self->terms ) {
2604 $msg .= ' - '. $self->terms;
2609 sub balance_due_date {
2612 if ( $conf->exists('invoice_default_terms')
2613 && $conf->config('invoice_default_terms')=~ /^\s*Net\s*(\d+)\s*$/ ) {
2614 $duedate = time2str("%m/%d/%Y", $self->_date + ($1*86400) );
2619 =item invnum_date_pretty
2621 Returns a string with the invoice number and date, for example:
2622 "Invoice #54 (3/20/2008)"
2626 sub invnum_date_pretty {
2628 'Invoice #'. $self->invnum. ' ('. $self->_date_pretty. ')';
2633 Returns a string with the date, for example: "3/20/2008"
2639 time2str('%x', $self->_date);
2642 sub _items_sections {
2649 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2652 if ( $cust_bill_pkg->pkgnum > 0 ) {
2653 my $usage = $cust_bill_pkg->usage;
2655 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2656 my $desc = $display->section;
2657 my $type = $display->type;
2659 if ( $display->post_total ) {
2660 if (! $type || $type eq 'S') {
2661 $l{$desc} += $cust_bill_pkg->setup
2662 if ( $cust_bill_pkg->setup != 0 );
2666 $l{$desc} += $cust_bill_pkg->recur
2667 if ( $cust_bill_pkg->recur != 0 );
2670 if ($type && $type eq 'R') {
2671 $l{$desc} += $cust_bill_pkg->recur - $usage
2672 if ( $cust_bill_pkg->recur != 0 );
2675 if ($type && $type eq 'U') {
2676 $l{$desc} += $usage;
2680 if (! $type || $type eq 'S') {
2681 $s{$desc} += $cust_bill_pkg->setup
2682 if ( $cust_bill_pkg->setup != 0 );
2686 $s{$desc} += $cust_bill_pkg->recur
2687 if ( $cust_bill_pkg->recur != 0 );
2690 if ($type && $type eq 'R') {
2691 $s{$desc} += $cust_bill_pkg->recur - $usage
2692 if ( $cust_bill_pkg->recur != 0 );
2695 if ($type && $type eq 'U') {
2696 $s{$desc} += $usage;
2707 push @$late, map { { 'description' => $_,
2708 'subtotal' => $l{$_},
2712 map { {'description' => $_, 'subtotal' => $s{$_}} } sort keys %s;
2719 #my @display = scalar(@_)
2721 # : qw( _items_previous _items_pkg );
2722 # #: qw( _items_pkg );
2723 # #: qw( _items_previous _items_pkg _items_tax _items_credits _items_payments );
2724 my @display = qw( _items_previous _items_pkg );
2727 foreach my $display ( @display ) {
2728 push @b, $self->$display(@_);
2733 sub _items_previous {
2735 my $cust_main = $self->cust_main;
2736 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2738 foreach ( @pr_cust_bill ) {
2740 'description' => 'Previous Balance, Invoice #'. $_->invnum.
2741 ' ('. time2str('%x',$_->_date). ')',
2742 #'pkgpart' => 'N/A',
2744 'amount' => sprintf("%.2f", $_->owed),
2750 # 'description' => 'Previous Balance',
2751 # #'pkgpart' => 'N/A',
2752 # 'pkgnum' => 'N/A',
2753 # 'amount' => sprintf("%10.2f", $pr_total ),
2754 # 'ext_description' => [ map {
2755 # "Invoice ". $_->invnum.
2756 # " (". time2str("%x",$_->_date). ") ".
2757 # sprintf("%10.2f", $_->owed)
2758 # } @pr_cust_bill ],
2765 my @cust_bill_pkg = grep { $_->pkgnum } $self->cust_bill_pkg;
2766 $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2770 return 0 unless $a cmp $b;
2771 return -1 if $b eq 'Tax';
2772 return 1 if $a eq 'Tax';
2773 return -1 if $b eq 'Other surcharges';
2774 return 1 if $a eq 'Other surcharges';
2780 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum } $self->cust_bill_pkg;
2781 $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2784 sub _items_cust_bill_pkg {
2786 my $cust_bill_pkg = shift;
2789 my $format = $opt{format} || '';
2790 my $escape_function = $opt{escape_function} || sub { shift };
2791 my $format_function = $opt{format_function} || '';
2792 my $unsquelched = $opt{unsquelched} || '';
2793 my $section = $opt{section}->{description} if $opt{section};
2796 foreach my $cust_bill_pkg ( @$cust_bill_pkg )
2798 foreach my $display ( grep { defined($section)
2799 ? $_->section eq $section
2802 $cust_bill_pkg->cust_bill_pkg_display
2806 my $type = $display->type;
2808 my $cust_pkg = $cust_bill_pkg->cust_pkg;
2810 my $desc = $cust_bill_pkg->desc;
2811 $desc = substr($desc, 0, 50). '...'
2812 if $format eq 'latex' && length($desc) > 50;
2814 my %details_opt = ( 'format' => $format,
2815 'escape_function' => $escape_function,
2816 'format_function' => $format_function,
2819 if ( $cust_bill_pkg->pkgnum > 0 ) {
2821 if ( $cust_bill_pkg->setup != 0 && (!$type || $type eq 'S') ) {
2823 my $description = $desc;
2824 $description .= ' Setup' if $cust_bill_pkg->recur != 0;
2826 my @d = map &{$escape_function}($_),
2827 $cust_pkg->h_labels_short($self->_date);
2828 push @d, $cust_bill_pkg->details(%details_opt)
2829 if $cust_bill_pkg->recur == 0;
2832 description => $description,
2833 #pkgpart => $part_pkg->pkgpart,
2834 pkgnum => $cust_bill_pkg->pkgnum,
2835 amount => sprintf("%.2f", $cust_bill_pkg->setup),
2836 unit_amount => sprintf("%.2f", $cust_bill_pkg->unitsetup),
2837 quantity => $cust_bill_pkg->quantity,
2838 ext_description => \@d,
2843 if ( $cust_bill_pkg->recur != 0 &&
2844 ( !$type || $type eq 'R' || $type eq 'U' )
2848 my $is_summary = $display->summary;
2849 my $description = $is_summary ? "Usage charges" : $desc;
2851 unless ( $conf->exists('disable_line_item_date_ranges') ) {
2852 $description .= " (" . time2str("%x", $cust_bill_pkg->sdate).
2853 " - ". time2str("%x", $cust_bill_pkg->edate). ")";
2856 #at least until cust_bill_pkg has "past" ranges in addition to
2857 #the "future" sdate/edate ones... see #3032
2859 push @d, map &{$escape_function}($_),
2860 $cust_pkg->h_labels_short($self->_date)
2861 #$cust_bill_pkg->edate,
2862 #$cust_bill_pkg->sdate),
2865 @d = () if ($cust_bill_pkg->itemdesc || $is_summary);
2866 push @d, $cust_bill_pkg->details(%details_opt)
2867 unless ($is_summary || $type && $type eq 'R');
2871 $amount = $cust_bill_pkg->recur;
2872 }elsif($type eq 'R') {
2873 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
2874 }elsif($type eq 'U') {
2875 $amount = $cust_bill_pkg->usage;
2879 description => $description,
2880 #pkgpart => $part_pkg->pkgpart,
2881 pkgnum => $cust_bill_pkg->pkgnum,
2882 amount => sprintf("%.2f", $amount),
2883 unit_amount => sprintf("%.2f", $cust_bill_pkg->unitrecur),
2884 quantity => $cust_bill_pkg->quantity,
2885 ext_description => \@d,
2886 } unless ( $type eq 'U' && ! $amount );
2890 } else { #pkgnum tax or one-shot line item (??)
2892 if ( $cust_bill_pkg->setup != 0 ) {
2894 'description' => $desc,
2895 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
2898 if ( $cust_bill_pkg->recur != 0 ) {
2900 'description' => "$desc (".
2901 time2str("%x", $cust_bill_pkg->sdate). ' - '.
2902 time2str("%x", $cust_bill_pkg->edate). ')',
2903 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
2917 sub _items_credits {
2922 foreach ( $self->cust_credited ) {
2924 #something more elaborate if $_->amount ne $_->cust_credit->credited ?
2926 my $reason = $_->cust_credit->reason;
2927 #my $reason = substr($_->cust_credit->reason,0,32);
2928 #$reason .= '...' if length($reason) < length($_->cust_credit->reason);
2929 $reason = " ($reason) " if $reason;
2931 #'description' => 'Credit ref\#'. $_->crednum.
2932 # " (". time2str("%x",$_->cust_credit->_date) .")".
2934 'description' => 'Credit applied '.
2935 time2str("%x",$_->cust_credit->_date). $reason,
2936 'amount' => sprintf("%.2f",$_->amount),
2939 #foreach ( @cr_cust_credit ) {
2941 # "Credit #". $_->crednum. " (" . time2str("%x",$_->_date) .")",
2942 # $money_char. sprintf("%10.2f",$_->credited)
2950 sub _items_payments {
2954 #get & print payments
2955 foreach ( $self->cust_bill_pay ) {
2957 #something more elaborate if $_->amount ne ->cust_pay->paid ?
2960 'description' => "Payment received ".
2961 time2str("%x",$_->cust_pay->_date ),
2962 'amount' => sprintf("%.2f", $_->amount )
2977 =item process_reprint
2981 sub process_reprint {
2982 process_re_X('print', @_);
2985 =item process_reemail
2989 sub process_reemail {
2990 process_re_X('email', @_);
2998 process_re_X('fax', @_);
3006 process_re_X('ftp', @_);
3013 sub process_respool {
3014 process_re_X('spool', @_);
3017 use Storable qw(thaw);
3021 my( $method, $job ) = ( shift, shift );
3022 warn "$me process_re_X $method for job $job\n" if $DEBUG;
3024 my $param = thaw(decode_base64(shift));
3025 warn Dumper($param) if $DEBUG;
3036 my($method, $job, %param ) = @_;
3038 warn "re_X $method for job $job with param:\n".
3039 join( '', map { " $_ => ". $param{$_}. "\n" } keys %param );
3042 #some false laziness w/search/cust_bill.html
3044 my $orderby = 'ORDER BY cust_bill._date';
3046 my $extra_sql = ' WHERE '. FS::cust_bill->search_sql(\%param);
3048 my $addl_from = 'LEFT JOIN cust_main USING ( custnum )';
3050 my @cust_bill = qsearch( {
3051 #'select' => "cust_bill.*",
3052 'table' => 'cust_bill',
3053 'addl_from' => $addl_from,
3055 'extra_sql' => $extra_sql,
3056 'order_by' => $orderby,
3060 $method .= '_invoice' unless $method eq 'email' || $method eq 'print';
3062 warn " $me re_X $method: ". scalar(@cust_bill). " invoices found\n"
3065 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
3066 foreach my $cust_bill ( @cust_bill ) {
3067 $cust_bill->$method();
3069 if ( $job ) { #progressbar foo
3071 if ( time - $min_sec > $last ) {
3072 my $error = $job->update_statustext(
3073 int( 100 * $num / scalar(@cust_bill) )
3075 die $error if $error;
3086 =head1 CLASS METHODS
3092 Returns an SQL fragment to retreive the amount owed (charged minus credited and paid).
3098 'charged - '. $class->paid_sql. ' - '. $class->credited_sql;
3103 Returns an SQL fragment to retreive the net amount (charged minus credited).
3109 'charged - '. $class->credited_sql;
3114 Returns an SQL fragment to retreive the amount paid against this invoice.
3120 "( SELECT COALESCE(SUM(amount),0) FROM cust_bill_pay
3121 WHERE cust_bill.invnum = cust_bill_pay.invnum )";
3126 Returns an SQL fragment to retreive the amount credited against this invoice.
3132 "( SELECT COALESCE(SUM(amount),0) FROM cust_credit_bill
3133 WHERE cust_bill.invnum = cust_credit_bill.invnum )";
3136 =item search_sql HASHREF
3138 Class method which returns an SQL WHERE fragment to search for parameters
3139 specified in HASHREF. Valid parameters are
3145 Epoch date (UNIX timestamp) setting a lower bound for _date values
3149 Epoch date (UNIX timestamp) setting an upper bound for _date values
3163 =item newest_percust
3167 Note: validates all passed-in data; i.e. safe to use with unchecked CGI params.
3172 my($class, $param) = @_;
3174 warn "$me search_sql called with params: \n".
3175 join("\n", map { " $_: ". $param->{$_} } keys %$param ). "\n";
3180 if ( $param->{'begin'} =~ /^(\d+)$/ ) {
3181 push @search, "cust_bill._date >= $1";
3183 if ( $param->{'end'} =~ /^(\d+)$/ ) {
3184 push @search, "cust_bill._date < $1";
3186 if ( $param->{'invnum_min'} =~ /^(\d+)$/ ) {
3187 push @search, "cust_bill.invnum >= $1";
3189 if ( $param->{'invnum_max'} =~ /^(\d+)$/ ) {
3190 push @search, "cust_bill.invnum <= $1";
3192 if ( $param->{'agentnum'} =~ /^(\d+)$/ ) {
3193 push @search, "cust_main.agentnum = $1";
3196 push @search, '0 != '. FS::cust_bill->owed_sql
3197 if $param->{'open'};
3199 push @search, '0 != '. FS::cust_bill->net_sql
3202 push @search, "cust_bill._date < ". (time-86400*$param->{'days'})
3203 if $param->{'days'};
3205 if ( $param->{'newest_percust'} ) {
3207 #$distinct = 'DISTINCT ON ( cust_bill.custnum )';
3208 #$orderby = 'ORDER BY cust_bill.custnum ASC, cust_bill._date DESC';
3210 my @newest_where = map { my $x = $_;
3211 $x =~ s/\bcust_bill\./newest_cust_bill./g;
3214 grep ! /^cust_main./, @search;
3215 my $newest_where = scalar(@newest_where)
3216 ? ' AND '. join(' AND ', @newest_where)
3220 push @search, "cust_bill._date = (
3221 SELECT(MAX(newest_cust_bill._date)) FROM cust_bill AS newest_cust_bill
3222 WHERE newest_cust_bill.custnum = cust_bill.custnum
3228 my $curuser = $FS::CurrentUser::CurrentUser;
3229 if ( $curuser->username eq 'fs_queue'
3230 && $param->{'CurrentUser'} =~ /^(\w+)$/ ) {
3232 my $newuser = qsearchs('access_user', {
3233 'username' => $username,
3237 $curuser = $newuser;
3239 warn "$me WARNING: (fs_queue) can't find CurrentUser $username\n";
3243 push @search, $curuser->agentnums_sql;
3245 join(' AND ', @search );
3257 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
3258 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base