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);
10 use Text::Template 1.20;
12 use String::ShellQuote;
15 use FS::UID qw( datasrc );
16 use FS::Misc qw( send_email send_fax );
17 use FS::Record qw( qsearch qsearchs dbh );
18 use FS::cust_main_Mixin;
20 use FS::cust_bill_pkg;
24 use FS::cust_credit_bill;
26 use FS::cust_pay_batch;
27 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 (see L<FS::cust_bill_event>) for this
280 sub cust_bill_event {
282 qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
288 Returns the customer (see L<FS::cust_main>) for this invoice.
294 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
297 =item cust_suspend_if_balance_over AMOUNT
299 Suspends the customer associated with this invoice if the total amount owed on
300 this invoice and all older invoices is greater than the specified amount.
302 Returns a list: an empty list on success or a list of errors.
306 sub cust_suspend_if_balance_over {
307 my( $self, $amount ) = ( shift, shift );
308 my $cust_main = $self->cust_main;
309 if ( $cust_main->total_owed_date($self->_date) < $amount ) {
312 $cust_main->suspend(@_);
318 Depreciated. See the cust_credited method.
320 #Returns a list consisting of the total previous credited (see
321 #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
322 #outstanding credits (FS::cust_credit objects).
328 croak "FS::cust_bill->cust_credit depreciated; see ".
329 "FS::cust_bill->cust_credit_bill";
332 #my @cust_credit = sort { $a->_date <=> $b->_date }
333 # grep { $_->credited != 0 && $_->_date < $self->_date }
334 # qsearch('cust_credit', { 'custnum' => $self->custnum } )
336 #foreach (@cust_credit) { $total += $_->credited; }
337 #$total, @cust_credit;
342 Depreciated. See the cust_bill_pay method.
344 #Returns all payments (see L<FS::cust_pay>) for this invoice.
350 croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
352 #sort { $a->_date <=> $b->_date }
353 # qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
359 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
365 sort { $a->_date <=> $b->_date }
366 qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
371 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
377 sort { $a->_date <=> $b->_date }
378 qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
384 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
391 my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
393 foreach (@taxlines) { $total += $_->setup; }
399 Returns the amount owed (still outstanding) on this invoice, which is charged
400 minus all payment applications (see L<FS::cust_bill_pay>) and credit
401 applications (see L<FS::cust_credit_bill>).
407 my $balance = $self->charged;
408 $balance -= $_->amount foreach ( $self->cust_bill_pay );
409 $balance -= $_->amount foreach ( $self->cust_credited );
410 $balance = sprintf( "%.2f", $balance);
411 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
415 =item apply_payments_and_credits
419 sub apply_payments_and_credits {
422 my @payments = grep { $_->unapplied > 0 } $self->cust_main->cust_pay;
423 my @credits = grep { $_->credited > 0 } $self->cust_main->cust_credit;
425 while ( $self->owed > 0 and ( @payments || @credits ) ) {
428 if ( @payments && @credits ) {
430 #decide which goes first by weight of top (unapplied) line item
432 my @open_lineitems = $self->open_cust_bill_pkg;
435 max( map { $_->part_pkg->pay_weight || 0 }
440 my $max_credit_weight =
441 max( map { $_->part_pkg->credit_weight || 0 }
447 #if both are the same... payments first? it has to be something
448 if ( $max_pay_weight >= $max_credit_weight ) {
454 } elsif ( @payments ) {
456 } elsif ( @credits ) {
459 die "guru meditation #12 and 35";
462 if ( $app eq 'pay' ) {
464 my $payment = shift @payments;
466 $app = new FS::cust_bill_pay {
467 'paynum' => $payment->paynum,
468 'amount' => sprintf('%.2f', min( $payment->unapplied, $self->owed ) ),
471 } elsif ( $app eq 'credit' ) {
473 my $credit = shift @credits;
475 $app = new FS::cust_credit_bill {
476 'crednum' => $credit->crednum,
477 'amount' => sprintf('%.2f', min( $credit->credited, $self->owed ) ),
481 die "guru meditation #12 and 35";
484 $app->invnum( $self->invnum );
486 my $error = $app->insert;
487 die $error if $error;
493 =item generate_email PARAMHASH
495 PARAMHASH can contain the following:
499 =item from => sender address, required
501 =item tempate => alternate template name, optional
503 =item print_text => text attachment arrayref, optional
505 =item subject => email subject, optional
509 Returns an argument list to be passed to L<FS::Misc::send_email>.
520 my $me = '[FS::cust_bill::generate_email]';
523 'from' => $args{'from'},
524 'subject' => (($args{'subject'}) ? $args{'subject'} : 'Invoice'),
527 if (ref($args{'to'}) eq 'ARRAY') {
528 $return{'to'} = $args{'to'};
530 $return{'to'} = [ grep { $_ !~ /^(POST|FAX)$/ }
531 $self->cust_main->invoicing_list
535 if ( $conf->exists('invoice_html') ) {
537 warn "$me creating HTML/text multipart message"
540 $return{'nobody'} = 1;
542 my $alternative = build MIME::Entity
543 'Type' => 'multipart/alternative',
544 'Encoding' => '7bit',
545 'Disposition' => 'inline'
549 if ( $conf->exists('invoice_email_pdf')
550 and scalar($conf->config('invoice_email_pdf_note')) ) {
552 warn "$me using 'invoice_email_pdf_note' in multipart message"
554 $data = [ map { $_ . "\n" }
555 $conf->config('invoice_email_pdf_note')
560 warn "$me not using 'invoice_email_pdf_note' in multipart message"
562 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
563 $data = $args{'print_text'};
565 $data = [ $self->print_text('', $args{'template'}) ];
570 $alternative->attach(
571 'Type' => 'text/plain',
572 #'Encoding' => 'quoted-printable',
573 'Encoding' => '7bit',
575 'Disposition' => 'inline',
578 $args{'from'} =~ /\@([\w\.\-]+)/;
579 my $from = $1 || 'example.com';
580 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
582 my $path = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
584 if ( defined($args{'template'}) && length($args{'template'})
585 && -e "$path/logo_". $args{'template'}. ".png"
588 $file = "$path/logo_". $args{'template'}. ".png";
590 $file = "$path/logo.png";
593 my $image = build MIME::Entity
594 'Type' => 'image/png',
595 'Encoding' => 'base64',
597 'Filename' => 'logo.png',
598 'Content-ID' => "<$content_id>",
601 $alternative->attach(
602 'Type' => 'text/html',
603 'Encoding' => 'quoted-printable',
604 'Data' => [ '<html>',
607 ' '. encode_entities($return{'subject'}),
610 ' <body bgcolor="#e8e8e8">',
611 $self->print_html('', $args{'template'}, $content_id),
615 'Disposition' => 'inline',
616 #'Filename' => 'invoice.pdf',
619 if ( $conf->exists('invoice_email_pdf') ) {
624 # multipart/alternative
630 my $related = build MIME::Entity 'Type' => 'multipart/related',
631 'Encoding' => '7bit';
633 #false laziness w/Misc::send_email
634 $related->head->replace('Content-type',
636 '; boundary="'. $related->head->multipart_boundary. '"'.
637 '; type=multipart/alternative'
640 $related->add_part($alternative);
642 $related->add_part($image);
644 my $pdf = build MIME::Entity $self->mimebuild_pdf('', $args{'template'});
646 $return{'mimeparts'} = [ $related, $pdf ];
650 #no other attachment:
652 # multipart/alternative
657 $return{'content-type'} = 'multipart/related';
658 $return{'mimeparts'} = [ $alternative, $image ];
659 $return{'type'} = 'multipart/alternative'; #Content-Type of first part...
660 #$return{'disposition'} = 'inline';
666 if ( $conf->exists('invoice_email_pdf') ) {
667 warn "$me creating PDF attachment"
670 #mime parts arguments a la MIME::Entity->build().
671 $return{'mimeparts'} = [
672 { $self->mimebuild_pdf('', $args{'template'}) }
676 if ( $conf->exists('invoice_email_pdf')
677 and scalar($conf->config('invoice_email_pdf_note')) ) {
679 warn "$me using 'invoice_email_pdf_note'"
681 $return{'body'} = [ map { $_ . "\n" }
682 $conf->config('invoice_email_pdf_note')
687 warn "$me not using 'invoice_email_pdf_note'"
689 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
690 $return{'body'} = $args{'print_text'};
692 $return{'body'} = [ $self->print_text('', $args{'template'}) ];
705 Returns a list suitable for passing to MIME::Entity->build(), representing
706 this invoice as PDF attachment.
713 'Type' => 'application/pdf',
714 'Encoding' => 'base64',
715 'Data' => [ $self->print_pdf(@_) ],
716 'Disposition' => 'attachment',
717 'Filename' => 'invoice.pdf',
721 =item send [ TEMPLATENAME [ , AGENTNUM [ , INVOICE_FROM ] ] ]
723 Sends this invoice to the destinations configured for this customer: sends
724 email, prints and/or faxes. See L<FS::cust_main_invoice>.
726 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
728 AGENTNUM, if specified, means that this invoice will only be sent for customers
729 of the specified agent or agent(s). AGENTNUM can be a scalar agentnum (for a
730 single agent) or an arrayref of agentnums.
732 INVOICE_FROM, if specified, overrides the default email invoice From: address.
739 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
740 or die "invalid invoice number: " . $opt{invnum};
742 my @args = ( $opt{template}, $opt{agentnum} );
743 push @args, $opt{invoice_from}
744 if exists($opt{invoice_from}) && $opt{invoice_from};
746 my $error = $self->send( @args );
747 die $error if $error;
753 my $template = scalar(@_) ? shift : '';
754 if ( scalar(@_) && $_[0] ) {
755 my $agentnums = ref($_[0]) ? shift : [ shift ];
756 return 'N/A' unless grep { $_ == $self->cust_main->agentnum } @$agentnums;
762 : ( $self->_agent_invoice_from || $conf->config('invoice_from') );
764 my @invoicing_list = $self->cust_main->invoicing_list;
766 $self->email($template, $invoice_from)
767 if grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list;
769 $self->print($template)
770 if grep { $_ eq 'POST' } @invoicing_list; #postal
772 $self->fax($template)
773 if grep { $_ eq 'FAX' } @invoicing_list; #fax
779 =item email [ TEMPLATENAME [ , INVOICE_FROM ] ]
783 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
785 INVOICE_FROM, if specified, overrides the default email invoice From: address.
789 sub queueable_email {
792 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
793 or die "invalid invoice number: " . $opt{invnum};
795 my @args = ( $opt{template} );
796 push @args, $opt{invoice_from}
797 if exists($opt{invoice_from}) && $opt{invoice_from};
799 my $error = $self->email( @args );
800 die $error if $error;
806 my $template = scalar(@_) ? shift : '';
810 : ( $self->_agent_invoice_from || $conf->config('invoice_from') );
812 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
813 $self->cust_main->invoicing_list;
815 #better to notify this person than silence
816 @invoicing_list = ($invoice_from) unless @invoicing_list;
818 my $error = send_email(
819 $self->generate_email(
820 'from' => $invoice_from,
821 'to' => [ grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list ],
822 'template' => $template,
825 die "can't email invoice: $error\n" if $error;
826 #die "$error\n" if $error;
830 =item lpr_data [ TEMPLATENAME ]
832 Returns the postscript or plaintext for this invoice as an arrayref.
834 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
839 my( $self, $template) = @_;
840 $conf->exists('invoice_latex')
841 ? [ $self->print_ps('', $template) ]
842 : [ $self->print_text('', $template) ];
845 =item print [ TEMPLATENAME ]
849 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
855 my $template = scalar(@_) ? shift : '';
857 my $lpr = $conf->config('lpr');
860 run3 $lpr, $self->lpr_data($template), \$outerr, \$outerr;
862 $outerr = ": $outerr" if length($outerr);
863 die "Error from $lpr (exit status ". ($?>>8). ")$outerr\n";
868 =item fax [ TEMPLATENAME ]
872 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
878 my $template = scalar(@_) ? shift : '';
880 die 'FAX invoice destination not (yet?) supported with plain text invoices.'
881 unless $conf->exists('invoice_latex');
883 my $dialstring = $self->cust_main->getfield('fax');
886 my $error = send_fax( 'docdata' => $self->lpr_data($template),
887 'dialstring' => $dialstring,
889 die $error if $error;
893 =item send_if_newest [ TEMPLATENAME [ , AGENTNUM [ , INVOICE_FROM ] ] ]
895 Like B<send>, but only sends the invoice if it is the newest open invoice for
905 grep { $_->owed > 0 }
906 qsearch('cust_bill', {
907 'custnum' => $self->custnum,
908 #'_date' => { op=>'>', value=>$self->_date },
909 'invnum' => { op=>'>', value=>$self->invnum },
916 =item send_csv OPTION => VALUE, ...
918 Sends invoice as a CSV data-file to a remote host with the specified protocol.
922 protocol - currently only "ftp"
928 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
929 and YYMMDDHHMMSS is a timestamp.
931 See L</print_csv> for a description of the output format.
936 my($self, %opt) = @_;
940 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
941 mkdir $spooldir, 0700 unless -d $spooldir;
943 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
944 my $file = "$spooldir/$tracctnum.csv";
946 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
948 open(CSV, ">$file") or die "can't open $file: $!";
956 if ( $opt{protocol} eq 'ftp' ) {
957 eval "use Net::FTP;";
959 $net = Net::FTP->new($opt{server}) or die @$;
961 die "unknown protocol: $opt{protocol}";
964 $net->login( $opt{username}, $opt{password} )
965 or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
967 $net->binary or die "can't set binary mode";
969 $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
971 $net->put($file) or die "can't put $file: $!";
981 Spools CSV invoice data.
987 =item format - 'default' or 'billco'
989 =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>).
991 =item agent_spools - if set to a true value, will spool to per-agent files rather than a single global file
993 =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.
1000 my($self, %opt) = @_;
1002 my $cust_main = $self->cust_main;
1004 if ( $opt{'dest'} ) {
1005 my %invoicing_list = map { /^(POST|FAX)$/ or 'EMAIL' =~ /^(.*)$/; $1 => 1 }
1006 $cust_main->invoicing_list;
1007 return 'N/A' unless $invoicing_list{$opt{'dest'}}
1008 || ! keys %invoicing_list;
1011 if ( $opt{'balanceover'} ) {
1013 if $cust_main->total_owed_date($self->_date) < $opt{'balanceover'};
1016 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1017 mkdir $spooldir, 0700 unless -d $spooldir;
1019 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1023 ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1024 ( lc($opt{'format'}) eq 'billco' ? '-header' : '' ) .
1027 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1029 open(CSV, ">>$file") or die "can't open $file: $!";
1030 flock(CSV, LOCK_EX);
1035 if ( lc($opt{'format'}) eq 'billco' ) {
1037 flock(CSV, LOCK_UN);
1042 ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1045 open(CSV,">>$file") or die "can't open $file: $!";
1046 flock(CSV, LOCK_EX);
1052 flock(CSV, LOCK_UN);
1059 =item print_csv OPTION => VALUE, ...
1061 Returns CSV data for this invoice.
1065 format - 'default' or 'billco'
1067 Returns a list consisting of two scalars. The first is a single line of CSV
1068 header information for this invoice. The second is one or more lines of CSV
1069 detail information for this invoice.
1071 If I<format> is not specified or "default", the fields of the CSV file are as
1074 record_type, invnum, custnum, _date, charged, first, last, company, address1, address2, city, state, zip, country, pkg, setup, recur, sdate, edate
1078 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
1080 B<record_type> is C<cust_bill> for the initial header line only. The
1081 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
1082 fields are filled in.
1084 B<record_type> is C<cust_bill_pkg> for detail lines. Only the first two fields
1085 (B<record_type> and B<invnum>) and the last five fields (B<pkg> through B<edate>)
1088 =item invnum - invoice number
1090 =item custnum - customer number
1092 =item _date - invoice date
1094 =item charged - total invoice amount
1096 =item first - customer first name
1098 =item last - customer first name
1100 =item company - company name
1102 =item address1 - address line 1
1104 =item address2 - address line 1
1114 =item pkg - line item description
1116 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
1118 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
1120 =item sdate - start date for recurring fee
1122 =item edate - end date for recurring fee
1126 If I<format> is "billco", the fields of the header CSV file are as follows:
1128 +-------------------------------------------------------------------+
1129 | FORMAT HEADER FILE |
1130 |-------------------------------------------------------------------|
1131 | Field | Description | Name | Type | Width |
1132 | 1 | N/A-Leave Empty | RC | CHAR | 2 |
1133 | 2 | N/A-Leave Empty | CUSTID | CHAR | 15 |
1134 | 3 | Transaction Account No | TRACCTNUM | CHAR | 15 |
1135 | 4 | Transaction Invoice No | TRINVOICE | CHAR | 15 |
1136 | 5 | Transaction Zip Code | TRZIP | CHAR | 5 |
1137 | 6 | Transaction Company Bill To | TRCOMPANY | CHAR | 30 |
1138 | 7 | Transaction Contact Bill To | TRNAME | CHAR | 30 |
1139 | 8 | Additional Address Unit Info | TRADDR1 | CHAR | 30 |
1140 | 9 | Bill To Street Address | TRADDR2 | CHAR | 30 |
1141 | 10 | Ancillary Billing Information | TRADDR3 | CHAR | 30 |
1142 | 11 | Transaction City Bill To | TRCITY | CHAR | 20 |
1143 | 12 | Transaction State Bill To | TRSTATE | CHAR | 2 |
1144 | 13 | Bill Cycle Close Date | CLOSEDATE | CHAR | 10 |
1145 | 14 | Bill Due Date | DUEDATE | CHAR | 10 |
1146 | 15 | Previous Balance | BALFWD | NUM* | 9 |
1147 | 16 | Pmt/CR Applied | CREDAPPLY | NUM* | 9 |
1148 | 17 | Total Current Charges | CURRENTCHG | NUM* | 9 |
1149 | 18 | Total Amt Due | TOTALDUE | NUM* | 9 |
1150 | 19 | Total Amt Due | AMTDUE | NUM* | 9 |
1151 | 20 | 30 Day Aging | AMT30 | NUM* | 9 |
1152 | 21 | 60 Day Aging | AMT60 | NUM* | 9 |
1153 | 22 | 90 Day Aging | AMT90 | NUM* | 9 |
1154 | 23 | Y/N | AGESWITCH | CHAR | 1 |
1155 | 24 | Remittance automation | SCANLINE | CHAR | 100 |
1156 | 25 | Total Taxes & Fees | TAXTOT | NUM* | 9 |
1157 | 26 | Customer Reference Number | CUSTREF | CHAR | 15 |
1158 | 27 | Federal Tax*** | FEDTAX | NUM* | 9 |
1159 | 28 | State Tax*** | STATETAX | NUM* | 9 |
1160 | 29 | Other Taxes & Fees*** | OTHERTAX | NUM* | 9 |
1161 +-------+-------------------------------+------------+------+-------+
1163 If I<format> is "billco", the fields of the detail CSV file are as follows:
1165 FORMAT FOR DETAIL FILE
1167 Field | Description | Name | Type | Width
1168 1 | N/A-Leave Empty | RC | CHAR | 2
1169 2 | N/A-Leave Empty | CUSTID | CHAR | 15
1170 3 | Account Number | TRACCTNUM | CHAR | 15
1171 4 | Invoice Number | TRINVOICE | CHAR | 15
1172 5 | Line Sequence (sort order) | LINESEQ | NUM | 6
1173 6 | Transaction Detail | DETAILS | CHAR | 100
1174 7 | Amount | AMT | NUM* | 9
1175 8 | Line Format Control** | LNCTRL | CHAR | 2
1176 9 | Grouping Code | GROUP | CHAR | 2
1177 10 | User Defined | ACCT CODE | CHAR | 15
1182 my($self, %opt) = @_;
1184 eval "use Text::CSV_XS";
1187 my $cust_main = $self->cust_main;
1189 my $csv = Text::CSV_XS->new({'always_quote'=>1});
1191 if ( lc($opt{'format'}) eq 'billco' ) {
1194 $taxtotal += $_->{'amount'} foreach $self->_items_tax;
1196 my $duedate = $self->due_date2str('%m/%d/%Y'); #date_format?
1198 my( $previous_balance, @unused ) = $self->previous; #previous balance
1200 my $pmt_cr_applied = 0;
1201 $pmt_cr_applied += $_->{'amount'}
1202 foreach ( $self->_items_payments, $self->_items_credits ) ;
1204 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
1207 '', # 1 | N/A-Leave Empty CHAR 2
1208 '', # 2 | N/A-Leave Empty CHAR 15
1209 $opt{'tracctnum'}, # 3 | Transaction Account No CHAR 15
1210 $self->invnum, # 4 | Transaction Invoice No CHAR 15
1211 $cust_main->zip, # 5 | Transaction Zip Code CHAR 5
1212 $cust_main->company, # 6 | Transaction Company Bill To CHAR 30
1213 #$cust_main->payname, # 7 | Transaction Contact Bill To CHAR 30
1214 $cust_main->contact, # 7 | Transaction Contact Bill To CHAR 30
1215 $cust_main->address2, # 8 | Additional Address Unit Info CHAR 30
1216 $cust_main->address1, # 9 | Bill To Street Address CHAR 30
1217 '', # 10 | Ancillary Billing Information CHAR 30
1218 $cust_main->city, # 11 | Transaction City Bill To CHAR 20
1219 $cust_main->state, # 12 | Transaction State Bill To CHAR 2
1222 time2str("%m/%d/%Y", $self->_date), # 13 | Bill Cycle Close Date CHAR 10
1225 $duedate, # 14 | Bill Due Date CHAR 10
1227 $previous_balance, # 15 | Previous Balance NUM* 9
1228 $pmt_cr_applied, # 16 | Pmt/CR Applied NUM* 9
1229 sprintf("%.2f", $self->charged), # 17 | Total Current Charges NUM* 9
1230 $totaldue, # 18 | Total Amt Due NUM* 9
1231 $totaldue, # 19 | Total Amt Due NUM* 9
1232 '', # 20 | 30 Day Aging NUM* 9
1233 '', # 21 | 60 Day Aging NUM* 9
1234 '', # 22 | 90 Day Aging NUM* 9
1235 'N', # 23 | Y/N CHAR 1
1236 '', # 24 | Remittance automation CHAR 100
1237 $taxtotal, # 25 | Total Taxes & Fees NUM* 9
1238 $self->custnum, # 26 | Customer Reference Number CHAR 15
1239 '0', # 27 | Federal Tax*** NUM* 9
1240 sprintf("%.2f", $taxtotal), # 28 | State Tax*** NUM* 9
1241 '0', # 29 | Other Taxes & Fees*** NUM* 9
1250 time2str("%x", $self->_date),
1251 sprintf("%.2f", $self->charged),
1252 ( map { $cust_main->getfield($_) }
1253 qw( first last company address1 address2 city state zip country ) ),
1255 ) or die "can't create csv";
1258 my $header = $csv->string. "\n";
1261 if ( lc($opt{'format'}) eq 'billco' ) {
1264 foreach my $item ( $self->_items_pkg ) {
1267 '', # 1 | N/A-Leave Empty CHAR 2
1268 '', # 2 | N/A-Leave Empty CHAR 15
1269 $opt{'tracctnum'}, # 3 | Account Number CHAR 15
1270 $self->invnum, # 4 | Invoice Number CHAR 15
1271 $lineseq++, # 5 | Line Sequence (sort order) NUM 6
1272 $item->{'description'}, # 6 | Transaction Detail CHAR 100
1273 $item->{'amount'}, # 7 | Amount NUM* 9
1274 '', # 8 | Line Format Control** CHAR 2
1275 '', # 9 | Grouping Code CHAR 2
1276 '', # 10 | User Defined CHAR 15
1279 $detail .= $csv->string. "\n";
1285 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1287 my($pkg, $setup, $recur, $sdate, $edate);
1288 if ( $cust_bill_pkg->pkgnum ) {
1290 ($pkg, $setup, $recur, $sdate, $edate) = (
1291 $cust_bill_pkg->cust_pkg->part_pkg->pkg,
1292 ( $cust_bill_pkg->setup != 0
1293 ? sprintf("%.2f", $cust_bill_pkg->setup )
1295 ( $cust_bill_pkg->recur != 0
1296 ? sprintf("%.2f", $cust_bill_pkg->recur )
1298 ( $cust_bill_pkg->sdate
1299 ? time2str("%x", $cust_bill_pkg->sdate)
1301 ($cust_bill_pkg->edate
1302 ?time2str("%x", $cust_bill_pkg->edate)
1306 } else { #pkgnum tax
1307 next unless $cust_bill_pkg->setup != 0;
1308 my $itemdesc = defined $cust_bill_pkg->dbdef_table->column('itemdesc')
1309 ? ( $cust_bill_pkg->itemdesc || 'Tax' )
1311 ($pkg, $setup, $recur, $sdate, $edate) =
1312 ( $itemdesc, sprintf("%10.2f",$cust_bill_pkg->setup), '', '', '' );
1318 ( map { '' } (1..11) ),
1319 ($pkg, $setup, $recur, $sdate, $edate)
1320 ) or die "can't create csv";
1322 $detail .= $csv->string. "\n";
1328 ( $header, $detail );
1334 Pays this invoice with a compliemntary payment. If there is an error,
1335 returns the error, otherwise returns false.
1341 my $cust_pay = new FS::cust_pay ( {
1342 'invnum' => $self->invnum,
1343 'paid' => $self->owed,
1346 'payinfo' => $self->cust_main->payinfo,
1354 Attempts to pay this invoice with a credit card payment via a
1355 Business::OnlinePayment realtime gateway. See
1356 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1357 for supported processors.
1363 $self->realtime_bop( 'CC', @_ );
1368 Attempts to pay this invoice with an electronic check (ACH) payment via a
1369 Business::OnlinePayment realtime gateway. See
1370 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1371 for supported processors.
1377 $self->realtime_bop( 'ECHECK', @_ );
1382 Attempts to pay this invoice with phone bill (LEC) payment via a
1383 Business::OnlinePayment realtime gateway. See
1384 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1385 for supported processors.
1391 $self->realtime_bop( 'LEC', @_ );
1395 my( $self, $method ) = @_;
1397 my $cust_main = $self->cust_main;
1398 my $balance = $cust_main->balance;
1399 my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
1400 $amount = sprintf("%.2f", $amount);
1401 return "not run (balance $balance)" unless $amount > 0;
1403 my $description = 'Internet Services';
1404 if ( $conf->exists('business-onlinepayment-description') ) {
1405 my $dtempl = $conf->config('business-onlinepayment-description');
1407 my $agent_obj = $cust_main->agent
1408 or die "can't retreive agent for $cust_main (agentnum ".
1409 $cust_main->agentnum. ")";
1410 my $agent = $agent_obj->agent;
1411 my $pkgs = join(', ',
1412 map { $_->cust_pkg->part_pkg->pkg }
1413 grep { $_->pkgnum } $self->cust_bill_pkg
1415 $description = eval qq("$dtempl");
1418 $cust_main->realtime_bop($method, $amount,
1419 'description' => $description,
1420 'invnum' => $self->invnum,
1425 =item batch_card OPTION => VALUE...
1427 Adds a payment for this invoice to the pending credit card batch (see
1428 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
1429 runs the payment using a realtime gateway.
1434 my ($self, %options) = @_;
1435 my $cust_main = $self->cust_main;
1437 $options{invnum} = $self->invnum;
1439 $cust_main->batch_card(%options);
1442 sub _agent_template {
1444 $self->_agent_plandata('agent_templatename');
1447 sub _agent_invoice_from {
1449 $self->_agent_plandata('agent_invoice_from');
1452 sub _agent_plandata {
1453 my( $self, $option ) = @_;
1455 my $part_bill_event = qsearchs( 'part_bill_event',
1457 'payby' => $self->cust_main->payby,
1458 'plan' => 'send_agent',
1459 'plandata' => { 'op' => '~',
1460 'value' => "(^|\n)agentnum ".
1462 $self->cust_main->agentnum.
1468 'ORDER BY seconds LIMIT 1'
1471 return '' unless $part_bill_event;
1473 if ( $part_bill_event->plandata =~ /^$option (.*)$/m ) {
1476 warn "can't parse part_bill_event eventpart#". $part_bill_event->eventpart.
1477 " plandata for $option";
1483 =item print_text [ TIME [ , TEMPLATE ] ]
1485 Returns an text invoice, as a list of lines.
1487 TIME an optional value used to control the printing of overdue messages. The
1488 default is now. It isn't the date of the invoice; that's the `_date' field.
1489 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1490 L<Time::Local> and L<Date::Parse> for conversion functions.
1494 #still some false laziness w/_items stuff (and send_csv)
1497 my( $self, $today, $template ) = @_;
1500 # my $invnum = $self->invnum;
1501 my $cust_main = $self->cust_main;
1502 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
1503 unless $cust_main->payname && $cust_main->payby !~ /^(CHEK|DCHK)$/;
1505 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
1506 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
1507 #my $balance_due = $self->owed + $pr_total - $cr_total;
1508 my $balance_due = $self->owed + $pr_total;
1511 #my($description,$amount);
1515 foreach ( @pr_cust_bill ) {
1517 "Previous Balance, Invoice #". $_->invnum.
1518 " (". time2str("%x",$_->_date). ")",
1519 $money_char. sprintf("%10.2f",$_->owed)
1522 if (@pr_cust_bill) {
1523 push @buf,['','-----------'];
1524 push @buf,[ 'Total Previous Balance',
1525 $money_char. sprintf("%10.2f",$pr_total ) ];
1530 foreach my $cust_bill_pkg (
1531 ( grep { $_->pkgnum } $self->cust_bill_pkg ), #packages first
1532 ( grep { ! $_->pkgnum } $self->cust_bill_pkg ), #then taxes
1535 my $desc = $cust_bill_pkg->desc;
1537 if ( $cust_bill_pkg->pkgnum > 0 ) {
1539 if ( $cust_bill_pkg->setup != 0 ) {
1540 my $description = $desc;
1541 $description .= ' Setup' if $cust_bill_pkg->recur != 0;
1542 push @buf, [ $description,
1543 $money_char. sprintf("%10.2f", $cust_bill_pkg->setup) ];
1545 map { [ " ". $_->[0]. ": ". $_->[1], '' ] }
1546 $cust_bill_pkg->cust_pkg->h_labels($self->_date);
1549 if ( $cust_bill_pkg->recur != 0 ) {
1551 "$desc (" . time2str("%x", $cust_bill_pkg->sdate) . " - " .
1552 time2str("%x", $cust_bill_pkg->edate) . ")",
1553 $money_char. sprintf("%10.2f", $cust_bill_pkg->recur)
1556 map { [ " ". $_->[0]. ": ". $_->[1], '' ] }
1557 $cust_bill_pkg->cust_pkg->h_labels( $cust_bill_pkg->edate,
1558 $cust_bill_pkg->sdate );
1561 push @buf, map { [ " $_", '' ] } $cust_bill_pkg->details;
1563 } else { #pkgnum tax or one-shot line item
1565 if ( $cust_bill_pkg->setup != 0 ) {
1567 $money_char. sprintf("%10.2f", $cust_bill_pkg->setup) ];
1569 if ( $cust_bill_pkg->recur != 0 ) {
1570 push @buf, [ "$desc (". time2str("%x", $cust_bill_pkg->sdate). " - "
1571 . time2str("%x", $cust_bill_pkg->edate). ")",
1572 $money_char. sprintf("%10.2f", $cust_bill_pkg->recur)
1580 push @buf,['','-----------'];
1581 push @buf,['Total New Charges',
1582 $money_char. sprintf("%10.2f",$self->charged) ];
1585 push @buf,['','-----------'];
1586 push @buf,['Total Charges',
1587 $money_char. sprintf("%10.2f",$self->charged + $pr_total) ];
1591 foreach ( $self->cust_credited ) {
1593 #something more elaborate if $_->amount ne $_->cust_credit->credited ?
1595 my $reason = substr($_->cust_credit->reason,0,32);
1596 $reason .= '...' if length($reason) < length($_->cust_credit->reason);
1597 $reason = " ($reason) " if $reason;
1599 "Credit #". $_->crednum. " (". time2str("%x",$_->cust_credit->_date) .")".
1601 $money_char. sprintf("%10.2f",$_->amount)
1604 #foreach ( @cr_cust_credit ) {
1606 # "Credit #". $_->crednum. " (" . time2str("%x",$_->_date) .")",
1607 # $money_char. sprintf("%10.2f",$_->credited)
1611 #get & print payments
1612 foreach ( $self->cust_bill_pay ) {
1614 #something more elaborate if $_->amount ne ->cust_pay->paid ?
1617 "Payment received ". time2str("%x",$_->cust_pay->_date ),
1618 $money_char. sprintf("%10.2f",$_->amount )
1623 my $balance_due_msg = $self->balance_due_msg;
1625 push @buf,['','-----------'];
1626 push @buf,[$balance_due_msg, $money_char.
1627 sprintf("%10.2f", $balance_due ) ];
1629 #create the template
1630 $template ||= $self->_agent_template;
1631 my $templatefile = 'invoice_template';
1632 $templatefile .= "_$template" if length($template);
1633 my @invoice_template = $conf->config($templatefile)
1634 or die "cannot load config file $templatefile";
1637 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1638 /invoice_lines\((\d*)\)/;
1639 $invoice_lines += $1 || scalar(@buf);
1642 die "no invoice_lines() functions in template?" unless $wasfunc;
1643 my $invoice_template = new Text::Template (
1645 SOURCE => [ map "$_\n", @invoice_template ],
1646 ) or die "can't create new Text::Template object: $Text::Template::ERROR";
1647 $invoice_template->compile()
1648 or die "can't compile template: $Text::Template::ERROR";
1650 #setup template variables
1651 package FS::cust_bill::_template; #!
1652 use vars qw( $custnum $invnum $date $agent @address $overdue
1653 $page $total_pages @buf );
1655 $custnum = $self->custnum;
1656 $invnum = $self->invnum;
1657 $date = $self->_date;
1658 $agent = $self->cust_main->agent->agent;
1661 if ( $FS::cust_bill::invoice_lines ) {
1663 int( scalar(@FS::cust_bill::buf) / $FS::cust_bill::invoice_lines );
1665 if scalar(@FS::cust_bill::buf) % $FS::cust_bill::invoice_lines;
1670 #format address (variable for the template)
1672 @address = ( '', '', '', '', '', '' );
1673 package FS::cust_bill; #!
1674 $FS::cust_bill::_template::address[$l++] =
1675 $cust_main->payname.
1676 ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
1677 ? " (P.O. #". $cust_main->payinfo. ")"
1681 $FS::cust_bill::_template::address[$l++] = $cust_main->company
1682 if $cust_main->company;
1683 $FS::cust_bill::_template::address[$l++] = $cust_main->address1;
1684 $FS::cust_bill::_template::address[$l++] = $cust_main->address2
1685 if $cust_main->address2;
1686 $FS::cust_bill::_template::address[$l++] =
1687 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
1689 my $countrydefault = $conf->config('countrydefault') || 'US';
1690 $FS::cust_bill::_template::address[$l++] = code2country($cust_main->country)
1691 unless $cust_main->country eq $countrydefault;
1693 # #overdue? (variable for the template)
1694 # $FS::cust_bill::_template::overdue = (
1696 # && $today > $self->_date
1697 ## && $self->printed > 1
1698 # && $self->printed > 0
1701 #and subroutine for the template
1702 sub FS::cust_bill::_template::invoice_lines {
1703 my $lines = shift || scalar(@buf);
1705 scalar(@buf) ? shift @buf : [ '', '' ];
1711 $FS::cust_bill::_template::page = 1;
1715 push @collect, split("\n",
1716 $invoice_template->fill_in( PACKAGE => 'FS::cust_bill::_template' )
1718 $FS::cust_bill::_template::page++;
1721 map "$_\n", @collect;
1725 =item print_latex [ TIME [ , TEMPLATE ] ]
1727 Internal method - returns a filename of a filled-in LaTeX template for this
1728 invoice (Note: add ".tex" to get the actual filename), and a filename of
1729 an associated logo (with the .eps extension included).
1731 See print_ps and print_pdf for methods that return PostScript and PDF output.
1733 TIME an optional value used to control the printing of overdue messages. The
1734 default is now. It isn't the date of the invoice; that's the `_date' field.
1735 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1736 L<Time::Local> and L<Date::Parse> for conversion functions.
1740 #still some false laziness w/print_text and print_html (and send_csv) (mostly print_text should use _items stuff though)
1743 my( $self, $today, $template ) = @_;
1745 warn "FS::cust_bill::print_latex called on $self with suffix $template\n"
1748 my $cust_main = $self->cust_main;
1749 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
1750 unless $cust_main->payname && $cust_main->payby !~ /^(CHEK|DCHK)$/;
1752 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
1753 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
1754 #my $balance_due = $self->owed + $pr_total - $cr_total;
1755 my $balance_due = $self->owed + $pr_total;
1757 #create the template
1758 $template ||= $self->_agent_template;
1759 my $templatefile = 'invoice_latex';
1760 my $suffix = length($template) ? "_$template" : '';
1761 $templatefile .= $suffix;
1762 my @invoice_template = map "$_\n", $conf->config($templatefile)
1763 or die "cannot load config file $templatefile";
1765 my($format, $text_template);
1766 if ( grep { /^%%Detail/ } @invoice_template ) {
1767 #change this to a die when the old code is removed
1768 warn "old-style invoice template $templatefile; ".
1769 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
1772 $format = 'Text::Template';
1773 $text_template = new Text::Template(
1775 SOURCE => \@invoice_template,
1776 DELIMITERS => [ '[@--', '--@]' ],
1779 $text_template->compile()
1780 or die 'While compiling ' . $templatefile . ': ' . $Text::Template::ERROR;
1784 if ( length($conf->config_orbase('invoice_latexreturnaddress', $template)) ) {
1785 $returnaddress = join("\n",
1786 $conf->config_orbase('invoice_latexreturnaddress', $template)
1789 $returnaddress = '~';
1792 my %invoice_data = (
1793 'custnum' => $self->custnum,
1794 'invnum' => $self->invnum,
1795 'date' => time2str('%b %o, %Y', $self->_date),
1796 'today' => time2str('%b %o, %Y', $today),
1797 'agent' => _latex_escape($cust_main->agent->agent),
1798 'payname' => _latex_escape($cust_main->payname),
1799 'company' => _latex_escape($cust_main->company),
1800 'address1' => _latex_escape($cust_main->address1),
1801 'address2' => _latex_escape($cust_main->address2),
1802 'city' => _latex_escape($cust_main->city),
1803 'state' => _latex_escape($cust_main->state),
1804 'zip' => _latex_escape($cust_main->zip),
1805 'footer' => join("\n", $conf->config_orbase('invoice_latexfooter', $template) ),
1806 'smallfooter' => join("\n", $conf->config_orbase('invoice_latexsmallfooter', $template) ),
1807 'returnaddress' => $returnaddress,
1809 'terms' => $self->terms,
1810 #'notes' => join("\n", $conf->config('invoice_latexnotes') ),
1811 # better hang on to conf_dir for a while
1812 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
1815 my $countrydefault = $conf->config('countrydefault') || 'US';
1816 if ( $cust_main->country eq $countrydefault ) {
1817 $invoice_data{'country'} = '';
1819 $invoice_data{'country'} = _latex_escape(code2country($cust_main->country));
1822 $invoice_data{'notes'} =
1824 # #do variable substitutions in notes
1825 # map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1826 $conf->config_orbase('invoice_latexnotes', $template)
1828 warn "invoice notes: ". $invoice_data{'notes'}. "\n"
1831 $invoice_data{'footer'} =~ s/\n+$//;
1832 $invoice_data{'smallfooter'} =~ s/\n+$//;
1833 $invoice_data{'notes'} =~ s/\n+$//;
1835 $invoice_data{'po_line'} =
1836 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
1837 ? _latex_escape("Purchase Order #". $cust_main->payinfo)
1841 if ( $format eq 'old' ) {
1844 my @total_item = ();
1845 while ( @invoice_template ) {
1846 my $line = shift @invoice_template;
1848 if ( $line =~ /^%%Detail\s*$/ ) {
1850 while ( ( my $line_item_line = shift @invoice_template )
1851 !~ /^%%EndDetail\s*$/ ) {
1852 push @line_item, $line_item_line;
1854 foreach my $line_item ( $self->_items ) {
1855 #foreach my $line_item ( $self->_items_pkg ) {
1856 $invoice_data{'ref'} = $line_item->{'pkgnum'};
1857 $invoice_data{'description'} =
1858 _latex_escape($line_item->{'description'});
1859 if ( exists $line_item->{'ext_description'} ) {
1860 $invoice_data{'description'} .=
1861 "\\tabularnewline\n~~".
1862 join( "\\tabularnewline\n~~",
1863 map _latex_escape($_), @{$line_item->{'ext_description'}}
1866 $invoice_data{'amount'} = $line_item->{'amount'};
1867 $invoice_data{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
1869 map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b } @line_item;
1872 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1874 while ( ( my $total_item_line = shift @invoice_template )
1875 !~ /^%%EndTotalDetails\s*$/ ) {
1876 push @total_item, $total_item_line;
1879 my @total_fill = ();
1882 foreach my $tax ( $self->_items_tax ) {
1883 $invoice_data{'total_item'} = _latex_escape($tax->{'description'});
1884 $taxtotal += $tax->{'amount'};
1885 $invoice_data{'total_amount'} = '\dollar '. $tax->{'amount'};
1887 map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1892 $invoice_data{'total_item'} = 'Sub-total';
1893 $invoice_data{'total_amount'} =
1894 '\dollar '. sprintf('%.2f', $self->charged - $taxtotal );
1895 unshift @total_fill,
1896 map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1900 $invoice_data{'total_item'} = '\textbf{Total}';
1901 $invoice_data{'total_amount'} =
1902 '\textbf{\dollar '. sprintf('%.2f', $self->charged + $pr_total ). '}';
1904 map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1907 #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
1910 foreach my $credit ( $self->_items_credits ) {
1911 $invoice_data{'total_item'} = _latex_escape($credit->{'description'});
1913 $invoice_data{'total_amount'} = '-\dollar '. $credit->{'amount'};
1915 map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1920 foreach my $payment ( $self->_items_payments ) {
1921 $invoice_data{'total_item'} = _latex_escape($payment->{'description'});
1923 $invoice_data{'total_amount'} = '-\dollar '. $payment->{'amount'};
1925 map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1929 $invoice_data{'total_item'} = '\textbf{'. $self->balance_due_msg. '}';
1930 $invoice_data{'total_amount'} =
1931 '\textbf{\dollar '. sprintf('%.2f', $self->owed + $pr_total ). '}';
1933 map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1936 push @filled_in, @total_fill;
1939 #$line =~ s/\$(\w+)/$invoice_data{$1}/eg;
1940 $line =~ s/\$(\w+)/exists($invoice_data{$1}) ? $invoice_data{$1} : nounder($1)/eg;
1941 push @filled_in, $line;
1952 } elsif ( $format eq 'Text::Template' ) {
1954 my @detail_items = ();
1955 my @total_items = ();
1957 $invoice_data{'detail_items'} = \@detail_items;
1958 $invoice_data{'total_items'} = \@total_items;
1960 foreach my $line_item ( $self->_items ) {
1962 ext_description => [],
1964 $detail->{'ref'} = $line_item->{'pkgnum'};
1965 $detail->{'quantity'} = 1;
1966 $detail->{'description'} = _latex_escape($line_item->{'description'});
1967 if ( exists $line_item->{'ext_description'} ) {
1968 @{$detail->{'ext_description'}} = map {
1970 } @{$line_item->{'ext_description'}};
1972 $detail->{'amount'} = $line_item->{'amount'};
1973 $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
1975 push @detail_items, $detail;
1980 foreach my $tax ( $self->_items_tax ) {
1982 $total->{'total_item'} = _latex_escape($tax->{'description'});
1983 $taxtotal += $tax->{'amount'};
1984 $total->{'total_amount'} = '\dollar '. $tax->{'amount'};
1985 push @total_items, $total;
1990 $total->{'total_item'} = 'Sub-total';
1991 $total->{'total_amount'} =
1992 '\dollar '. sprintf('%.2f', $self->charged - $taxtotal );
1993 unshift @total_items, $total;
1998 $total->{'total_item'} = '\textbf{Total}';
1999 $total->{'total_amount'} =
2000 '\textbf{\dollar '. sprintf('%.2f', $self->charged + $pr_total ). '}';
2001 push @total_items, $total;
2004 #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
2007 foreach my $credit ( $self->_items_credits ) {
2009 $total->{'total_item'} = _latex_escape($credit->{'description'});
2011 $total->{'total_amount'} = '-\dollar '. $credit->{'amount'};
2012 push @total_items, $total;
2016 foreach my $payment ( $self->_items_payments ) {
2018 $total->{'total_item'} = _latex_escape($payment->{'description'});
2020 $total->{'total_amount'} = '-\dollar '. $payment->{'amount'};
2021 push @total_items, $total;
2026 $total->{'total_item'} = '\textbf{'. $self->balance_due_msg. '}';
2027 $total->{'total_amount'} =
2028 '\textbf{\dollar '. sprintf('%.2f', $self->owed + $pr_total ). '}';
2029 push @total_items, $total;
2033 die "guru meditation #54";
2036 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
2037 my $lh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
2041 ) or die "can't open temp file: $!\n";
2043 if ($template && $conf->exists("logo_${template}.eps")) {
2044 print $lh $conf->config_binary("logo_${template}.eps")
2045 or die "can't write temp file: $!\n";
2047 print $lh $conf->config_binary('logo.eps')
2048 or die "can't write temp file: $!\n";
2051 $invoice_data{'logo_file'} = $lh->filename;
2053 my $fh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
2057 ) or die "can't open temp file: $!\n";
2058 if ( $format eq 'old' ) {
2059 print $fh join('', @filled_in );
2060 } elsif ( $format eq 'Text::Template' ) {
2061 $text_template->fill_in(OUTPUT => $fh, HASH => \%invoice_data);
2063 die "guru meditation #32";
2067 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
2068 return ($1, $invoice_data{'logo_file'});
2072 =item print_ps [ TIME [ , TEMPLATE ] ]
2074 Returns an postscript invoice, as a scalar.
2076 TIME an optional value used to control the printing of overdue messages. The
2077 default is now. It isn't the date of the invoice; that's the `_date' field.
2078 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2079 L<Time::Local> and L<Date::Parse> for conversion functions.
2086 my ($file, $lfile) = $self->print_latex(@_);
2088 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
2091 my $sfile = shell_quote $file;
2093 system("pslatex $sfile.tex >/dev/null 2>&1") == 0
2094 or die "pslatex $file.tex failed; see $file.log for details?\n";
2095 system("pslatex $sfile.tex >/dev/null 2>&1") == 0
2096 or die "pslatex $file.tex failed; see $file.log for details?\n";
2098 system('dvips', '-q', '-t', 'letter', "$file.dvi", '-o', "$file.ps" ) == 0
2099 or die "dvips failed";
2101 open(POSTSCRIPT, "<$file.ps")
2102 or die "can't open $file.ps: $! (error in LaTeX template?)\n";
2104 unlink("$file.dvi", "$file.log", "$file.aux", "$file.ps", "$file.tex");
2109 if ( $conf->exists('lpr-postscript_prefix') ) {
2110 my $prefix = $conf->config('lpr-postscript_prefix');
2111 $ps .= eval qq("$prefix");
2114 while (<POSTSCRIPT>) {
2118 if ( $conf->exists('lpr-postscript_suffix') ) {
2119 my $suffix = $conf->config('lpr-postscript_suffix');
2120 $ps .= eval qq("$suffix");
2129 =item print_pdf [ TIME [ , TEMPLATE ] ]
2131 Returns an PDF invoice, as a scalar.
2133 TIME an optional value used to control the printing of overdue messages. The
2134 default is now. It isn't the date of the invoice; that's the `_date' field.
2135 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2136 L<Time::Local> and L<Date::Parse> for conversion functions.
2143 my ($file, $lfile) = $self->print_latex(@_);
2145 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
2148 #system('pdflatex', "$file.tex");
2149 #system('pdflatex', "$file.tex");
2150 #! LaTeX Error: Unknown graphics extension: .eps.
2152 my $sfile = shell_quote $file;
2154 system("pslatex $sfile.tex >/dev/null 2>&1") == 0
2155 or die "pslatex $file.tex failed; see $file.log for details?\n";
2156 system("pslatex $sfile.tex >/dev/null 2>&1") == 0
2157 or die "pslatex $file.tex failed; see $file.log for details?\n";
2159 #system('dvipdf', "$file.dvi", "$file.pdf" );
2161 "dvips -q -t letter -f $sfile.dvi ".
2162 "| gs -q -dNOPAUSE -dBATCH -sDEVICE=pdfwrite -sOutputFile=$sfile.pdf ".
2165 or die "dvips | gs failed: $!";
2167 open(PDF, "<$file.pdf")
2168 or die "can't open $file.pdf: $! (error in LaTeX template?)\n";
2170 unlink("$file.dvi", "$file.log", "$file.aux", "$file.pdf", "$file.tex");
2184 =item print_html [ TIME [ , TEMPLATE [ , CID ] ] ]
2186 Returns an HTML invoice, as a scalar.
2188 TIME an optional value used to control the printing of overdue messages. The
2189 default is now. It isn't the date of the invoice; that's the `_date' field.
2190 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2191 L<Time::Local> and L<Date::Parse> for conversion functions.
2193 CID is a MIME Content-ID used to create a "cid:" URL for the logo image, used
2194 when emailing the invoice as part of a multipart/related MIME email.
2198 #some falze laziness w/print_text and print_latex (and send_csv)
2200 my( $self, $today, $template, $cid ) = @_;
2203 my $cust_main = $self->cust_main;
2204 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
2205 unless $cust_main->payname && $cust_main->payby !~ /^(CHEK|DCHK)$/;
2207 $template ||= $self->_agent_template;
2208 my $templatefile = 'invoice_html';
2209 my $suffix = length($template) ? "_$template" : '';
2210 $templatefile .= $suffix;
2211 my @html_template = map "$_\n", $conf->config($templatefile)
2212 or die "cannot load config file $templatefile";
2214 my $html_template = new Text::Template(
2216 SOURCE => \@html_template,
2217 DELIMITERS => [ '<%=', '%>' ],
2220 $html_template->compile()
2221 or die 'While compiling ' . $templatefile . ': ' . $Text::Template::ERROR;
2223 my %invoice_data = (
2224 'custnum' => $self->custnum,
2225 'invnum' => $self->invnum,
2226 'date' => time2str('%b %o, %Y', $self->_date),
2227 'today' => time2str('%b %o, %Y', $today),
2228 'agent' => encode_entities($cust_main->agent->agent),
2229 'payname' => encode_entities($cust_main->payname),
2230 'company' => encode_entities($cust_main->company),
2231 'address1' => encode_entities($cust_main->address1),
2232 'address2' => encode_entities($cust_main->address2),
2233 'city' => encode_entities($cust_main->city),
2234 'state' => encode_entities($cust_main->state),
2235 'zip' => encode_entities($cust_main->zip),
2236 'terms' => $self->terms,
2238 'template' => $template,
2239 # 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
2243 defined( $conf->config_orbase('invoice_htmlreturnaddress', $template) )
2244 && length( $conf->config_orbase('invoice_htmlreturnaddress', $template) )
2246 $invoice_data{'returnaddress'} =
2247 join("\n", $conf->config('invoice_htmlreturnaddress', $template) );
2249 $invoice_data{'returnaddress'} =
2252 s/\\\\\*?\s*$/<BR>/;
2253 s/\\hyphenation\{[\w\s\-]+\}//;
2256 $conf->config_orbase( 'invoice_latexreturnaddress',
2262 my $countrydefault = $conf->config('countrydefault') || 'US';
2263 if ( $cust_main->country eq $countrydefault ) {
2264 $invoice_data{'country'} = '';
2266 $invoice_data{'country'} =
2267 encode_entities(code2country($cust_main->country));
2271 defined( $conf->config_orbase('invoice_htmlnotes', $template) )
2272 && length( $conf->config_orbase('invoice_htmlnotes', $template) )
2274 $invoice_data{'notes'} =
2275 join("\n", $conf->config_orbase('invoice_htmlnotes', $template) );
2277 $invoice_data{'notes'} =
2279 s/%%(.*)$/<!-- $1 -->/;
2280 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/;
2281 s/\\begin\{enumerate\}/<ol>/;
2283 s/\\end\{enumerate\}/<\/ol>/;
2284 s/\\textbf\{(.*)\}/<b>$1<\/b>/;
2288 $conf->config_orbase('invoice_latexnotes', $template)
2292 # #do variable substitutions in notes
2293 # $invoice_data{'notes'} =
2295 # map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
2296 # $conf->config_orbase('invoice_latexnotes', $suffix)
2300 defined( $conf->config_orbase('invoice_htmlfooter', $template) )
2301 && length( $conf->config_orbase('invoice_htmlfooter', $template) )
2303 $invoice_data{'footer'} =
2304 join("\n", $conf->config_orbase('invoice_htmlfooter', $template) );
2306 $invoice_data{'footer'} =
2307 join("\n", map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; }
2308 $conf->config_orbase('invoice_latexfooter', $template)
2312 $invoice_data{'po_line'} =
2313 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
2314 ? encode_entities("Purchase Order #". $cust_main->payinfo)
2317 my $money_char = $conf->config('money_char') || '$';
2319 foreach my $line_item ( $self->_items ) {
2321 ext_description => [],
2323 $detail->{'ref'} = $line_item->{'pkgnum'};
2324 $detail->{'description'} = encode_entities($line_item->{'description'});
2325 if ( exists $line_item->{'ext_description'} ) {
2326 @{$detail->{'ext_description'}} = map {
2327 encode_entities($_);
2328 } @{$line_item->{'ext_description'}};
2330 $detail->{'amount'} = $money_char. $line_item->{'amount'};
2331 $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
2333 push @{$invoice_data{'detail_items'}}, $detail;
2338 foreach my $tax ( $self->_items_tax ) {
2340 $total->{'total_item'} = encode_entities($tax->{'description'});
2341 $taxtotal += $tax->{'amount'};
2342 $total->{'total_amount'} = $money_char. $tax->{'amount'};
2343 push @{$invoice_data{'total_items'}}, $total;
2348 $total->{'total_item'} = 'Sub-total';
2349 $total->{'total_amount'} =
2350 $money_char. sprintf('%.2f', $self->charged - $taxtotal );
2351 unshift @{$invoice_data{'total_items'}}, $total;
2354 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2357 $total->{'total_item'} = '<b>Total</b>';
2358 $total->{'total_amount'} =
2359 "<b>$money_char". sprintf('%.2f', $self->charged + $pr_total ). '</b>';
2360 push @{$invoice_data{'total_items'}}, $total;
2363 #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
2366 foreach my $credit ( $self->_items_credits ) {
2368 $total->{'total_item'} = encode_entities($credit->{'description'});
2370 $total->{'total_amount'} = "-$money_char". $credit->{'amount'};
2371 push @{$invoice_data{'total_items'}}, $total;
2375 foreach my $payment ( $self->_items_payments ) {
2377 $total->{'total_item'} = encode_entities($payment->{'description'});
2379 $total->{'total_amount'} = "-$money_char". $payment->{'amount'};
2380 push @{$invoice_data{'total_items'}}, $total;
2385 $total->{'total_item'} = '<b>'. $self->balance_due_msg. '</b>';
2386 $total->{'total_amount'} =
2387 "<b>$money_char". sprintf('%.2f', $self->owed + $pr_total ). '</b>';
2388 push @{$invoice_data{'total_items'}}, $total;
2391 $html_template->fill_in( HASH => \%invoice_data);
2394 # quick subroutine for print_latex
2396 # There are ten characters that LaTeX treats as special characters, which
2397 # means that they do not simply typeset themselves:
2398 # # $ % & ~ _ ^ \ { }
2400 # TeX ignores blanks following an escaped character; if you want a blank (as
2401 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
2405 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
2406 $value =~ s/([<>])/\$$1\$/g;
2410 #utility methods for print_*
2415 #check for an invoice- specific override (eventually)
2417 #check for a customer- specific override
2418 return $self->cust_main->invoice_terms
2419 if $self->cust_main->invoice_terms;
2421 #use configured default or default default
2422 $conf->config('invoice_default_terms') || 'Payable upon receipt';
2428 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
2429 $duedate = $self->_date() + ( $1 * 86400 );
2436 $self->due_date ? time2str(shift, $self->due_date) : '';
2439 sub balance_due_msg {
2441 my $msg = 'Balance Due';
2442 return $msg unless $self->terms;
2443 if ( $self->due_date ) {
2444 $msg .= ' - Please pay by '. $self->due_date2str('%x');
2445 } elsif ( $self->terms ) {
2446 $msg .= ' - '. $self->terms;
2453 my @display = scalar(@_)
2455 : qw( _items_previous _items_pkg );
2456 #: qw( _items_pkg );
2457 #: qw( _items_previous _items_pkg _items_tax _items_credits _items_payments );
2459 foreach my $display ( @display ) {
2460 push @b, $self->$display(@_);
2465 sub _items_previous {
2467 my $cust_main = $self->cust_main;
2468 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2470 foreach ( @pr_cust_bill ) {
2472 'description' => 'Previous Balance, Invoice #'. $_->invnum.
2473 ' ('. time2str('%x',$_->_date). ')',
2474 #'pkgpart' => 'N/A',
2476 'amount' => sprintf("%.2f", $_->owed),
2482 # 'description' => 'Previous Balance',
2483 # #'pkgpart' => 'N/A',
2484 # 'pkgnum' => 'N/A',
2485 # 'amount' => sprintf("%10.2f", $pr_total ),
2486 # 'ext_description' => [ map {
2487 # "Invoice ". $_->invnum.
2488 # " (". time2str("%x",$_->_date). ") ".
2489 # sprintf("%10.2f", $_->owed)
2490 # } @pr_cust_bill ],
2497 my @cust_bill_pkg = grep { $_->pkgnum } $self->cust_bill_pkg;
2498 $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2503 my @cust_bill_pkg = grep { ! $_->pkgnum } $self->cust_bill_pkg;
2504 $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2507 sub _items_cust_bill_pkg {
2509 my $cust_bill_pkg = shift;
2512 foreach my $cust_bill_pkg ( @$cust_bill_pkg ) {
2514 my $desc = $cust_bill_pkg->desc;
2516 if ( $cust_bill_pkg->pkgnum > 0 ) {
2518 if ( $cust_bill_pkg->setup != 0 ) {
2519 my $description = $desc;
2520 $description .= ' Setup' if $cust_bill_pkg->recur != 0;
2521 my @d = $cust_bill_pkg->cust_pkg->h_labels_short($self->_date);
2522 push @d, $cust_bill_pkg->details if $cust_bill_pkg->recur == 0;
2524 description => $description,
2525 #pkgpart => $part_pkg->pkgpart,
2526 pkgnum => $cust_bill_pkg->pkgnum,
2527 amount => sprintf("%.2f", $cust_bill_pkg->setup),
2528 ext_description => \@d,
2532 if ( $cust_bill_pkg->recur != 0 ) {
2534 description => "$desc (" .
2535 time2str('%x', $cust_bill_pkg->sdate). ' - '.
2536 time2str('%x', $cust_bill_pkg->edate). ')',
2537 #pkgpart => $part_pkg->pkgpart,
2538 pkgnum => $cust_bill_pkg->pkgnum,
2539 amount => sprintf("%.2f", $cust_bill_pkg->recur),
2541 [ $cust_bill_pkg->cust_pkg->h_labels_short( $cust_bill_pkg->edate,
2542 $cust_bill_pkg->sdate),
2543 $cust_bill_pkg->details,
2548 } else { #pkgnum tax or one-shot line item (??)
2550 if ( $cust_bill_pkg->setup != 0 ) {
2552 'description' => $desc,
2553 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
2556 if ( $cust_bill_pkg->recur != 0 ) {
2558 'description' => "$desc (".
2559 time2str("%x", $cust_bill_pkg->sdate). ' - '.
2560 time2str("%x", $cust_bill_pkg->edate). ')',
2561 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
2573 sub _items_credits {
2578 foreach ( $self->cust_credited ) {
2580 #something more elaborate if $_->amount ne $_->cust_credit->credited ?
2582 my $reason = $_->cust_credit->reason;
2583 #my $reason = substr($_->cust_credit->reason,0,32);
2584 #$reason .= '...' if length($reason) < length($_->cust_credit->reason);
2585 $reason = " ($reason) " if $reason;
2587 #'description' => 'Credit ref\#'. $_->crednum.
2588 # " (". time2str("%x",$_->cust_credit->_date) .")".
2590 'description' => 'Credit applied '.
2591 time2str("%x",$_->cust_credit->_date). $reason,
2592 'amount' => sprintf("%.2f",$_->amount),
2595 #foreach ( @cr_cust_credit ) {
2597 # "Credit #". $_->crednum. " (" . time2str("%x",$_->_date) .")",
2598 # $money_char. sprintf("%10.2f",$_->credited)
2606 sub _items_payments {
2610 #get & print payments
2611 foreach ( $self->cust_bill_pay ) {
2613 #something more elaborate if $_->amount ne ->cust_pay->paid ?
2616 'description' => "Payment received ".
2617 time2str("%x",$_->cust_pay->_date ),
2618 'amount' => sprintf("%.2f", $_->amount )
2637 sub process_reprint {
2638 process_re_X('print', @_);
2645 sub process_reemail {
2646 process_re_X('email', @_);
2654 process_re_X('fax', @_);
2657 use Storable qw(thaw);
2661 my( $method, $job ) = ( shift, shift );
2662 warn "process_re_X $method for job $job\n" if $DEBUG;
2664 my $param = thaw(decode_base64(shift));
2665 warn Dumper($param) if $DEBUG;
2676 my($method, $job, %param ) = @_;
2677 # [ 'begin', 'end', 'agentnum', 'open', 'days', 'newest_percust' ],
2679 warn "re_X $method for job $job with param:\n".
2680 join( '', map { " $_ => ". $param{$_}. "\n" } keys %param );
2683 #some false laziness w/search/cust_bill.html
2685 my $orderby = 'ORDER BY cust_bill._date';
2689 if ( $param{'begin'} =~ /^(\d+)$/ ) {
2690 push @where, "cust_bill._date >= $1";
2692 if ( $param{'end'} =~ /^(\d+)$/ ) {
2693 push @where, "cust_bill._date < $1";
2695 if ( $param{'agentnum'} =~ /^(\d+)$/ ) {
2696 push @where, "cust_main.agentnum = $1";
2700 "charged - ( SELECT COALESCE(SUM(amount),0) FROM cust_bill_pay
2701 WHERE cust_bill_pay.invnum = cust_bill.invnum )
2702 - ( SELECT COALESCE(SUM(amount),0) FROM cust_credit_bill
2703 WHERE cust_credit_bill.invnum = cust_bill.invnum )";
2705 push @where, "0 != $owed"
2708 push @where, "cust_bill._date < ". (time-86400*$param{'days'})
2711 my $extra_sql = scalar(@where) ? 'WHERE '. join(' AND ', @where) : '';
2713 my $addl_from = 'left join cust_main using ( custnum )';
2715 if ( $param{'newest_percust'} ) {
2716 $distinct = 'DISTINCT ON ( cust_bill.custnum )';
2717 $orderby = 'ORDER BY cust_bill.custnum ASC, cust_bill._date DESC';
2718 #$count_query = "SELECT COUNT(DISTINCT cust_bill.custnum), 'N/A', 'N/A'";
2721 my @cust_bill = qsearch( 'cust_bill',
2723 "$distinct cust_bill.*",
2729 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
2730 foreach my $cust_bill ( @cust_bill ) {
2731 $cust_bill->$method();
2733 if ( $job ) { #progressbar foo
2735 if ( time - $min_sec > $last ) {
2736 my $error = $job->update_statustext(
2737 int( 100 * $num / scalar(@cust_bill) )
2739 die $error if $error;
2754 print_text formatting (and some logic :/) is in source, but needs to be
2755 slurped in from a file. Also number of lines ($=).
2759 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
2760 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base