1 package FS::Template_Mixin;
4 use vars qw( $DEBUG $me
9 use vars qw( $invoice_lines @buf ); #yuck
10 use List::Util qw(sum);
13 use Text::Template 1.20;
19 use FS::Misc qw( send_email );
20 use FS::Record qw( qsearch qsearchs );
22 use FS::Misc qw( generate_ps generate_pdf );
29 $me = '[FS::Template_Mixin]';
30 FS::UID->install_callback( sub {
31 my $conf = new FS::Conf; #global
32 $money_char = $conf->config('money_char') || '$';
33 $date_format = $conf->config('date_format') || '%x'; #/YY
38 Returns a configuration handle (L<FS::Conf>) set to the customer's locale.
40 If the "mode" pseudo-field is set on the object, the configuration handle
41 will be an L<FS::invoice_conf> for that invoice mode (and the customer's
48 my $mode = $self->get('mode');
49 if ($self->{_conf} and !defined($mode)) {
50 return $self->{_conf};
53 my $cust_main = $self->cust_main;
54 my $locale = $cust_main ? $cust_main->locale : '';
57 if ( ref $mode and $mode->isa('FS::invoice_mode') ) {
58 $mode = $mode->modenum;
59 } elsif ( $mode =~ /\D/ ) {
60 die "invalid invoice mode $mode";
62 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => $locale });
64 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => '' });
65 # it doesn't have a locale, but system conf still might
66 $conf->set('locale' => $locale) if $conf;
69 # if $mode is unspecified, or if there is no invoice_conf matching this mode
70 # and locale, then use the system config only (but with the locale)
71 $conf ||= FS::Conf->new({ 'locale' => $locale });
73 return $self->{_conf} = $conf;
76 =item print_text OPTIONS
78 Returns an text invoice, as a list of lines.
80 Options can be passed as a hash.
82 I<time>, if specified, is used to control the printing of overdue messages. The
83 default is now. It isn't the date of the invoice; that's the `_date' field.
84 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
85 L<Time::Local> and L<Date::Parse> for conversion functions.
87 I<template>, if specified, is the name of a suffix for alternate invoices.
89 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
97 %params = %{ shift() };
102 $params{'format'} = 'template'; # for some reason
104 $self->print_generic( %params );
107 =item print_latex HASHREF
109 Internal method - returns a filename of a filled-in LaTeX template for this
110 invoice (Note: add ".tex" to get the actual filename), and a filename of
111 an associated logo (with the .eps extension included).
113 See print_ps and print_pdf for methods that return PostScript and PDF output.
115 Options can be passed as a hash.
117 I<time>, if specified, is used to control the printing of overdue messages. The
118 default is now. It isn't the date of the invoice; that's the `_date' field.
119 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
120 L<Time::Local> and L<Date::Parse> for conversion functions.
122 I<template>, if specified, is the name of a suffix for alternate invoices.
123 This is strongly deprecated; see L<FS::invoice_conf> for the right way to
124 customize invoice templates for different purposes.
126 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
135 %params = %{ shift() };
140 $params{'format'} = 'latex';
141 my $conf = $self->conf;
143 # this needs to go away
144 my $template = $params{'template'};
145 # and this especially
146 $template ||= $self->_agent_template
147 if $self->can('_agent_template');
149 my $pkey = $self->primary_key;
150 my $tmp_template = $self->table. '.'. $self->$pkey. '.XXXXXXXX';
152 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
153 my $lh = new File::Temp(
154 TEMPLATE => $tmp_template,
158 ) or die "can't open temp file: $!\n";
160 my $agentnum = $self->agentnum;
162 if ( $template && $conf->exists("logo_${template}.eps", $agentnum) ) {
163 print $lh $conf->config_binary("logo_${template}.eps", $agentnum)
164 or die "can't write temp file: $!\n";
166 print $lh $conf->config_binary('logo.eps', $agentnum)
167 or die "can't write temp file: $!\n";
170 $params{'logo_file'} = $lh->filename;
172 if( $conf->exists('invoice-barcode')
173 && $self->can('invoice_barcode')
174 && $self->invnum ) { # don't try to barcode statements
175 my $png_file = $self->invoice_barcode($dir);
176 my $eps_file = $png_file;
177 $eps_file =~ s/\.png$/.eps/g;
178 $png_file =~ /(barcode.*png)/;
180 $eps_file =~ /(barcode.*eps)/;
183 my $curr_dir = cwd();
185 # after painfuly long experimentation, it was determined that sam2p won't
186 # accept : and other chars in the path, no matter how hard I tried to
187 # escape them, hence the chdir (and chdir back, just to be safe)
188 system('sam2p', '-j:quiet', $png_file, 'EPS:', $eps_file ) == 0
189 or die "sam2p failed: $!\n";
193 $params{'barcode_file'} = $eps_file;
196 my @filled_in = $self->print_generic( %params );
198 my $fh = new File::Temp( TEMPLATE => $tmp_template,
202 ) or die "can't open temp file: $!\n";
203 binmode($fh, ':utf8'); # language support
204 print $fh join('', @filled_in );
207 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
208 return ($1, $params{'logo_file'}, $params{'barcode_file'});
214 my $cust_main = $self->cust_main;
215 $cust_main ? $cust_main->agentnum : $self->prospect_main->agentnum;
218 =item print_generic OPTION => VALUE ...
220 Internal method - returns a filled-in template for this invoice as a scalar.
222 See print_ps and print_pdf for methods that return PostScript and PDF output.
230 The B<format> option is required and should be set to html, latex (print and PDF) or template (plaintext).
240 Overrides "Invoice" as the name of the sent document.
244 Used to control the printing of overdue messages. The
245 default is now. It isn't the date of the invoice; that's the `_date' field.
246 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
247 L<Time::Local> and L<Date::Parse> for conversion functions.
251 Logo file (path to temporary EPS file on the local filesystem)
255 CID for inline (emailed) images (logo)
259 Override customer's locale
263 Overrides any per customer cdr squelching when true
267 Supress the (invoice, quotation, statement, etc.) number
275 Supress the payment coupon
279 Barcode file (path to temporary EPS file on the local filesystem)
283 Flag indicating the barcode image should be a link (normal HTML dipaly)
287 Barcode CID for inline (emailed) images
289 =item preref_callback
291 Coderef run for each line item, code should return HTML to be displayed
292 before that line item (quotations only)
296 Dprecated. Used as a suffix for a configuration template. Please
297 don't use this, it deprecated in favor of more flexible alternatives.
303 #what's with all the sprintf('%10.2f')'s in here? will it cause any
304 # (alignment in text invoice?) problems to change them all to '%.2f' ?
305 # yes: fixed width/plain text printing will be borked
307 my( $self, %params ) = @_;
308 my $conf = $self->conf;
310 my $today = $params{today} ? $params{today} : time;
311 warn "$me print_generic called on $self with suffix $params{template}\n"
314 my $format = $params{format};
315 die "Unknown format: $format"
316 unless $format =~ /^(latex|html|template)$/;
318 my $cust_main = $self->cust_main || $self->prospect_main;
319 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
320 unless $cust_main->payname
321 && $cust_main->payby !~ /^(CARD|DCRD|CHEK|DCHK)$/;
323 my $locale = $params{'locale'} || $cust_main->locale;
325 my %delimiters = ( 'latex' => [ '[@--', '--@]' ],
326 'html' => [ '<%=', '%>' ],
327 'template' => [ '{', '}' ],
330 warn "$me print_generic creating template\n"
333 # set the notice name here, and nowhere else.
334 my $notice_name = $params{notice_name}
335 || $conf->config('notice_name')
336 || $self->notice_name;
339 my $template = $params{template} ? $params{template} : $self->_agent_template;
340 my $templatefile = $self->template_conf. $format;
341 $templatefile .= "_$template"
342 if length($template) && $conf->exists($templatefile."_$template");
345 my @invoice_template = map "$_\n", $conf->config($templatefile)
346 or die "cannot load config data $templatefile";
348 if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
349 #change this to a die when the old code is removed
350 # it's been almost ten years, changing it to a die on the next release.
351 warn "old-style invoice template $templatefile; ".
352 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
353 #$old_latex = 'true';
354 #@invoice_template = _translate_old_latex_format(@invoice_template);
357 warn "$me print_generic creating T:T object\n"
360 my $text_template = new Text::Template(
362 SOURCE => \@invoice_template,
363 DELIMITERS => $delimiters{$format},
366 warn "$me print_generic compiling T:T object\n"
369 $text_template->compile()
370 or die "Can't compile $templatefile: $Text::Template::ERROR\n";
373 # additional substitution could possibly cause breakage in existing templates
376 'notes' => sub { map "$_", @_ },
377 'footer' => sub { map "$_", @_ },
378 'smallfooter' => sub { map "$_", @_ },
379 'returnaddress' => sub { map "$_", @_ },
380 'coupon' => sub { map "$_", @_ },
381 'summary' => sub { map "$_", @_ },
387 s/%%(.*)$/<!-- $1 -->/g;
388 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
389 s/\\begin\{enumerate\}/<ol>/g;
391 s/\\end\{enumerate\}/<\/ol>/g;
392 s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
401 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
403 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
409 s/\\hyphenation\{[\w\s\-]+}//;
414 'coupon' => sub { "" },
415 'summary' => sub { "" },
422 s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
423 s/\\begin\{enumerate\}//g;
425 s/\\end\{enumerate\}//g;
426 s/\\textbf\{(.*)\}/$1/g;
433 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
435 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
440 s/\\\\\*?\s*$/\n/; # dubious
441 s/\\hyphenation\{[\w\s\-]+}//;
445 'coupon' => sub { "" },
446 'summary' => sub { "" },
451 # hashes for differing output formats
452 my %nbsps = ( 'latex' => '~',
453 'html' => '', # '&nbps;' would be nice
454 'template' => '', # not used
456 my $nbsp = $nbsps{$format};
458 my %escape_functions = ( 'latex' => \&_latex_escape,
459 'html' => \&_html_escape_nbsp,#\&encode_entities,
460 'template' => sub { shift },
462 my $escape_function = $escape_functions{$format};
463 my $escape_function_nonbsp = ($format eq 'html')
464 ? \&_html_escape : $escape_function;
466 my %newline_tokens = ( 'latex' => '\\\\',
470 my $newline_token = $newline_tokens{$format};
472 warn "$me generating template variables\n"
475 # generate template variables
479 defined( $conf->config_orbase( "invoice_${format}returnaddress",
483 && length( $conf->config_orbase( "invoice_${format}returnaddress",
489 $returnaddress = join("\n",
490 $conf->config_orbase("invoice_${format}returnaddress", $template)
494 $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
496 my $convert_map = $convert_maps{$format}{'returnaddress'};
499 &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
504 } elsif ( grep /\S/, $conf->config('company_address', $cust_main->agentnum) ) {
506 my $convert_map = $convert_maps{$format}{'returnaddress'};
507 $returnaddress = join( "\n", &$convert_map(
508 map { s/( {2,})/'~' x length($1)/eg;
512 ( $conf->config('company_name', $cust_main->agentnum),
513 $conf->config('company_address', $cust_main->agentnum),
520 my $warning = "Couldn't find a return address; ".
521 "do you need to set the company_address configuration value?";
523 $returnaddress = $nbsp;
524 #$returnaddress = $warning;
528 warn "$me generating invoice data\n"
531 my $agentnum = $cust_main->agentnum;
536 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
537 'company_address' => join("\n", $conf->config('company_address', $agentnum) ). "\n",
538 'company_phonenum'=> scalar( $conf->config('company_phonenum', $agentnum) ),
539 'returnaddress' => $returnaddress,
540 'agent' => &$escape_function($cust_main->agent->agent),
542 #invoice/quotation info
543 'no_number' => $params{'no_number'},
544 'invnum' => ( $params{'no_number'} ? '' : $self->invnum ),
545 'quotationnum' => $self->quotationnum,
546 'no_date' => $params{'no_date'},
547 '_date' => ( $params{'no_date'} ? '' : $self->_date ),
548 # workaround for inconsistent behavior in the early plain text
549 # templates; see RT#28271
550 'date' => ( $params{'no_date'}
552 : ($format eq 'template'
554 : $self->time2str_local('long', $self->_date, $format)
557 'today' => $self->time2str_local('long', $today, $format),
558 'terms' => $self->terms,
559 'template' => $template, #params{'template'},
560 'notice_name' => $notice_name, # escape?
561 'current_charges' => sprintf("%.2f", $self->charged),
562 'duedate' => $self->due_date2str('rdate'), #date_format?
565 'custnum' => $cust_main->display_custnum,
566 'prospectnum' => $cust_main->prospectnum,
567 'agent_custid' => &$escape_function($cust_main->agent_custid),
568 ( map { $_ => &$escape_function($cust_main->$_()) } qw(
569 payname company address1 address2 city state zip fax
573 'ship_enable' => $conf->exists('invoice-ship_address'),
574 'unitprices' => $conf->exists('invoice-unitprice'),
575 'smallernotes' => $conf->exists('invoice-smallernotes'),
576 'smallerfooter' => $conf->exists('invoice-smallerfooter'),
577 'balance_due_below_line' => $conf->exists('balance_due_below_line'),
579 #layout info -- would be fancy to calc some of this and bury the template
581 'topmargin' => scalar($conf->config('invoice_latextopmargin', $agentnum)),
582 'headsep' => scalar($conf->config('invoice_latexheadsep', $agentnum)),
583 'textheight' => scalar($conf->config('invoice_latextextheight', $agentnum)),
584 'extracouponspace' => scalar($conf->config('invoice_latexextracouponspace', $agentnum)),
585 'couponfootsep' => scalar($conf->config('invoice_latexcouponfootsep', $agentnum)),
586 'verticalreturnaddress' => $conf->exists('invoice_latexverticalreturnaddress', $agentnum),
587 'addresssep' => scalar($conf->config('invoice_latexaddresssep', $agentnum)),
588 'amountenclosedsep' => scalar($conf->config('invoice_latexcouponamountenclosedsep', $agentnum)),
589 'coupontoaddresssep' => scalar($conf->config('invoice_latexcoupontoaddresssep', $agentnum)),
590 'addcompanytoaddress' => $conf->exists('invoice_latexcouponaddcompanytoaddress', $agentnum),
592 # better hang on to conf_dir for a while (for old templates)
593 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
595 #these are only used when doing paged plaintext
602 $invoice_data{'emt'} = sub { &$escape_function($self->mt(@_)) };
603 # prototype here to silence warnings
604 $invoice_data{'time2str'} = sub ($;$$) { $self->time2str_local(@_, $format) };
606 my $min_sdate = 999999999999;
608 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
609 next unless $cust_bill_pkg->pkgnum > 0;
610 $min_sdate = $cust_bill_pkg->sdate
611 if length($cust_bill_pkg->sdate) && $cust_bill_pkg->sdate < $min_sdate;
612 $max_edate = $cust_bill_pkg->edate
613 if length($cust_bill_pkg->edate) && $cust_bill_pkg->edate > $max_edate;
616 $invoice_data{'bill_period'} = '';
617 $invoice_data{'bill_period'} =
618 $self->time2str_local('%e %h', $min_sdate, $format)
620 $self->time2str_local('%e %h', $max_edate, $format)
621 if ($max_edate != 0 && $min_sdate != 999999999999);
623 $invoice_data{finance_section} = '';
624 if ( $conf->config('finance_pkgclass') ) {
626 qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
627 $invoice_data{finance_section} = $pkg_class->categoryname;
629 $invoice_data{finance_amount} = '0.00';
630 $invoice_data{finance_section} ||= 'Finance Charges'; #avoid config confusion
632 my $countrydefault = $conf->config('countrydefault') || 'US';
633 foreach ( qw( address1 address2 city state zip country fax) ){
634 my $method = 'ship_'.$_;
635 $invoice_data{"ship_$_"} = $escape_function->($cust_main->$method);
637 if ( length($cust_main->ship_company) ) {
638 $invoice_data{'ship_company'} = $escape_function->($cust_main->ship_company);
640 $invoice_data{'ship_company'} = $escape_function->($cust_main->company);
642 $invoice_data{'ship_contact'} = $escape_function->($cust_main->contact);
643 $invoice_data{'ship_country'} = ''
644 if ( $invoice_data{'ship_country'} eq $countrydefault );
646 $invoice_data{'cid'} = $params{'cid'}
649 if ( $cust_main->country eq $countrydefault ) {
650 $invoice_data{'country'} = '';
652 $invoice_data{'country'} = &$escape_function(code2country($cust_main->country));
656 $invoice_data{'address'} = \@address;
659 ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
660 ? " (P.O. #". $cust_main->payinfo. ")"
664 push @address, $cust_main->company
665 if $cust_main->company;
666 push @address, $cust_main->address1;
667 push @address, $cust_main->address2
668 if $cust_main->address2;
670 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
671 push @address, $invoice_data{'country'}
672 if $invoice_data{'country'};
674 while (scalar(@address) < 5);
676 $invoice_data{'logo_file'} = $params{'logo_file'}
677 if $params{'logo_file'};
678 $invoice_data{'barcode_file'} = $params{'barcode_file'}
679 if $params{'barcode_file'};
680 $invoice_data{'barcode_img'} = $params{'barcode_img'}
681 if $params{'barcode_img'};
682 $invoice_data{'barcode_cid'} = $params{'barcode_cid'}
683 if $params{'barcode_cid'};
685 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
686 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
687 #my $balance_due = $self->owed + $pr_total - $cr_total;
688 my $balance_due = $self->owed + $pr_total;
690 # the sum of amount owed on all invoices
691 # (this is used in the summary & on the payment coupon)
692 $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
694 # flag telling this invoice to have a first-page summary
695 my $summarypage = '';
697 if ( $self->custnum && $self->invnum ) {
698 # XXX should be an FS::cust_bill method to set the defaults, instead
699 # of checking the type here
701 my $last_bill = $self->previous_bill;
704 # "balance_date_range" unfortunately is unsuitable for this, since it
705 # cares about application dates. We want to know the sum of all
706 # _top-level transactions_ dated before the last invoice.
708 map "$_ WHERE _date <= ? AND custnum = ?", (
709 "SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill",
710 "SELECT -1 * COALESCE( SUM(amount), 0 ) FROM cust_credit",
711 "SELECT -1 * COALESCE( SUM(paid), 0 ) FROM cust_pay",
712 "SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund",
715 # the customer's current balance immediately after generating the last
718 my $last_bill_balance = $last_bill->charged;
720 my $delta = FS::Record->scalar_sql(
722 $last_bill->_date - 1,
725 $last_bill_balance += $delta;
728 $last_bill_balance = sprintf("%.2f", $last_bill_balance);
730 warn sprintf("LAST BILL: INVNUM %d, DATE %s, BALANCE %.2f\n\n",
732 $self->time2str_local('%D', $last_bill->_date),
735 # ("true_previous_balance" is a terrible name, but at least it's no
736 # longer stored in the database)
737 $invoice_data{'true_previous_balance'} = $last_bill_balance;
739 # the change in balance from immediately after that invoice
740 # to immediately before this one
741 my $before_this_bill_balance = 0;
743 my $delta = FS::Record->scalar_sql(
748 $before_this_bill_balance += $delta;
750 $invoice_data{'balance_adjustments'} =
751 sprintf("%.2f", $last_bill_balance - $before_this_bill_balance);
753 warn sprintf("BALANCE ADJUSTMENTS: %.2f\n\n",
754 $invoice_data{'balance_adjustments'}
757 # the sum of amount owed on all previous invoices
758 # ($pr_total is used elsewhere but not as $previous_balance)
759 $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
761 $invoice_data{'last_bill'} = {
762 '_date' => $last_bill->_date, #unformatted
764 my (@payments, @credits);
765 # for formats that itemize previous payments
766 foreach my $cust_pay ( qsearch('cust_pay', {
767 'custnum' => $self->custnum,
768 '_date' => { op => '>=',
769 value => $last_bill->_date }
772 next if $cust_pay->_date > $self->_date;
774 '_date' => $cust_pay->_date,
775 'date' => $self->time2str_local('long', $cust_pay->_date, $format),
776 'payinfo' => $cust_pay->payby_payinfo_pretty,
777 'amount' => sprintf('%.2f', $cust_pay->paid),
779 # not concerned about applications
781 foreach my $cust_credit ( qsearch('cust_credit', {
782 'custnum' => $self->custnum,
783 '_date' => { op => '>=',
784 value => $last_bill->_date }
787 next if $cust_credit->_date > $self->_date;
789 '_date' => $cust_credit->_date,
790 'date' => $self->time2str_local('long', $cust_credit->_date, $format),
791 'creditreason'=> $cust_credit->reason,
792 'amount' => sprintf('%.2f', $cust_credit->amount),
795 $invoice_data{'previous_payments'} = \@payments;
796 $invoice_data{'previous_credits'} = \@credits;
798 # there is no $last_bill
799 $invoice_data{'true_previous_balance'} =
800 $invoice_data{'balance_adjustments'} =
801 $invoice_data{'previous_balance'} = '0.00';
802 $invoice_data{'previous_payments'} = [];
803 $invoice_data{'previous_credits'} = [];
806 # info from customer's last invoice before this one, for some
808 $invoice_data{'last_bill'} = {};
810 if ( $conf->exists('invoice_usesummary', $agentnum) ) {
811 $invoice_data{'summarypage'} = $summarypage = 1;
814 } # if this is an invoice
816 warn "$me substituting variables in notes, footer, smallfooter\n"
819 my $tc = $self->template_conf;
820 my @include = ( [ $tc, 'notes' ],
821 [ 'invoice_', 'footer' ],
822 [ 'invoice_', 'smallfooter', ],
824 push @include, [ $tc, 'coupon', ]
825 unless $params{'no_coupon'};
827 foreach my $i (@include) {
829 my($base, $include) = @$i;
831 my $inc_file = $conf->key_orbase("$base$format$include", $template);
834 if ( $conf->exists($inc_file, $agentnum)
835 && length( $conf->config($inc_file, $agentnum) ) ) {
837 @inc_src = $conf->config($inc_file, $agentnum);
841 $inc_file = $conf->key_orbase("${base}latex$include", $template);
843 my $convert_map = $convert_maps{$format}{$include};
845 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
846 s/--\@\]/$delimiters{$format}[1]/g;
849 &$convert_map( $conf->config($inc_file, $agentnum) );
853 my $inc_tt = new Text::Template (
855 SOURCE => [ map "$_\n", @inc_src ],
856 DELIMITERS => $delimiters{$format},
857 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
859 unless ( $inc_tt->compile() ) {
860 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
861 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
865 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
867 $invoice_data{$include} =~ s/\n+$//
868 if ($format eq 'latex');
871 # let invoices use either of these as needed
872 $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
873 ? $cust_main->payinfo : '';
874 $invoice_data{'po_line'} =
875 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
876 ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
879 my %money_chars = ( 'latex' => '',
880 'html' => $conf->config('money_char') || '$',
883 my $money_char = $money_chars{$format};
886 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
887 'html' => $conf->config('money_char') || '$',
890 my $other_money_char = $other_money_chars{$format};
891 $invoice_data{'dollar'} = $other_money_char;
893 my %minus_signs = ( 'latex' => '$-$',
895 'template' => '- ' );
896 my $minus = $minus_signs{$format};
898 my @detail_items = ();
899 my @total_items = ();
903 $invoice_data{'detail_items'} = \@detail_items;
904 $invoice_data{'total_items'} = \@total_items;
905 $invoice_data{'buf'} = \@buf;
906 $invoice_data{'sections'} = \@sections;
908 warn "$me generating sections\n"
912 my $tax_section = { 'description' => $self->mt('Taxes, Surcharges, and Fees'),
913 'subtotal' => $taxtotal, # adjusted below
916 my $tax_weight = _pkg_category($tax_section->{description})
917 ? _pkg_category($tax_section->{description})->weight
919 $tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
920 $tax_section->{'sort_weight'} = $tax_weight;
923 my $adjust_section = {
924 'description' => $self->mt('Credits, Payments, and Adjustments'),
925 'adjust_section' => 1,
926 'subtotal' => 0, # adjusted below
928 my $adjust_weight = _pkg_category($adjust_section->{description})
929 ? _pkg_category($adjust_section->{description})->weight
931 $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
932 $adjust_section->{'sort_weight'} = $adjust_weight;
934 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
935 my $multisection = $conf->exists($tc.'sections', $cust_main->agentnum) ||
936 $conf->exists($tc.'sections_by_location', $cust_main->agentnum);
937 $invoice_data{'multisection'} = $multisection;
939 my $extra_sections = [];
940 my $extra_lines = ();
942 # default section ('Charges')
943 my $default_section = { 'description' => '',
948 # Previous Charges section
949 # subtotal is the first return value from $self->previous
950 my $previous_section;
951 # if the invoice has major sections, or if we're summarizing previous
952 # charges with a single line, or if we've been specifically told to put them
953 # in a section, create a section for previous charges:
954 if ( $multisection or
955 $conf->exists('previous_balance-summary_only') or
956 $conf->exists('previous_balance-section') ) {
958 $previous_section = { 'description' => $self->mt('Previous Charges'),
959 'subtotal' => $other_money_char.
960 sprintf('%.2f', $pr_total),
961 'summarized' => '', #why? $summarypage ? 'Y' : '',
963 $previous_section->{posttotal} = '0 / 30 / 60 / 90 days overdue '.
964 join(' / ', map { $cust_main->balance_date_range(@$_) }
965 $self->_prior_month30s
967 if $conf->exists('invoice_include_aging');
970 # otherwise put them in the main section
971 $previous_section = $default_section;
974 if ( $multisection ) {
975 ($extra_sections, $extra_lines) =
976 $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
977 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum)
978 && $self->can('_items_extra_usage_sections');
980 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
982 push @detail_items, @$extra_lines if $extra_lines;
984 # the code is written so that both methods can be used together, but
985 # we haven't yet changed the template to take advantage of that, so for
986 # now, treat them as mutually exclusive.
987 my %section_method = ( by_category => 1 );
988 if ( $conf->config($tc.'sections_method') eq 'location' ) {
989 %section_method = ( by_location => 1 );
992 $self->_items_sections( 'summary' => $summarypage,
993 'escape' => $escape_function_nonbsp,
994 'extra_sections' => $extra_sections,
998 push @sections, @$early;
999 $late_sections = $late;
1001 if ( $conf->exists('svc_phone_sections')
1002 && $self->can('_items_svc_phone_sections')
1005 my ($phone_sections, $phone_lines) =
1006 $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
1007 push @{$late_sections}, @$phone_sections;
1008 push @detail_items, @$phone_lines;
1010 if ( $conf->exists('voip-cust_accountcode_cdr')
1011 && $cust_main->accountcode_cdr
1012 && $self->can('_items_accountcode_cdr')
1015 my ($accountcode_section, $accountcode_lines) =
1016 $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
1017 if ( scalar(@$accountcode_lines) ) {
1018 push @{$late_sections}, $accountcode_section;
1019 push @detail_items, @$accountcode_lines;
1022 } else {# not multisection
1023 # make a default section
1024 push @sections, $default_section;
1025 # and calculate the finance charge total, since it won't get done otherwise.
1026 # and the default section total
1027 # XXX possibly finance_pkgclass should not be used in this manner?
1028 my @finance_charges;
1030 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1031 if ( $invoice_data{finance_section} and
1032 grep { $_->section eq $invoice_data{finance_section} }
1033 $cust_bill_pkg->cust_bill_pkg_display ) {
1034 # I think these are always setup fees, but just to be sure...
1035 push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1037 push @charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1040 $invoice_data{finance_amount} =
1041 sprintf('%.2f', sum( @finance_charges ) || 0);
1042 $default_section->{subtotal} = $other_money_char.
1043 sprintf('%.2f', sum( @charges ) || 0);
1046 # start setting up summary subtotals
1047 my @summary_subtotals;
1048 my $method = $conf->config('summary_subtotals_method');
1049 if ( $method and $method ne $conf->config($tc.'sections_method') ) {
1050 # then re-section them by the correct method
1051 my %section_method = ( by_category => 1 );
1052 if ( $conf->config('summary_subtotals_method') eq 'location' ) {
1053 %section_method = ( by_location => 1 );
1055 my ($early, $late) =
1056 $self->_items_sections( 'summary' => $summarypage,
1057 'escape' => $escape_function_nonbsp,
1058 'extra_sections' => $extra_sections,
1059 'format' => $format,
1062 foreach ( @$early ) {
1063 next if $_->{subtotal} == 0;
1064 $_->{subtotal} = $other_money_char.sprintf('%.2f', $_->{subtotal});
1065 push @summary_subtotals, $_;
1068 # subtotal sectioning is the same as for the actual invoice sections
1069 @summary_subtotals = @sections;
1072 # Hereafter, push sections to both @sections and @summary_subtotals
1073 # if they belong in both places (e.g. tax section). Late sections are
1074 # never in @summary_subtotals.
1076 # previous invoice balances in the Previous Charges section if there
1077 # is one, otherwise in the main detail section
1078 # (except if summary_only is enabled, don't show them at all)
1079 if ( $self->can('_items_previous') &&
1080 $self->enable_previous &&
1081 ! $conf->exists('previous_balance-summary_only') ) {
1083 warn "$me adding previous balances\n"
1086 foreach my $line_item ( $self->_items_previous ) {
1089 ref => $line_item->{'pkgnum'},
1090 pkgpart => $line_item->{'pkgpart'},
1091 #quantity => 1, # not really correct
1092 section => $previous_section, # which might be $default_section
1093 description => &$escape_function($line_item->{'description'}),
1094 ext_description => [ map { &$escape_function($_) }
1095 @{ $line_item->{'ext_description'} || [] }
1097 amount => $money_char . $line_item->{'amount'},
1098 product_code => $line_item->{'pkgpart'} || 'N/A',
1101 push @detail_items, $detail;
1102 push @buf, [ $detail->{'description'},
1103 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1109 if ( @pr_cust_bill && $self->enable_previous ) {
1110 push @buf, ['','-----------'];
1111 push @buf, [ $self->mt('Total Previous Balance'),
1112 $money_char. sprintf("%10.2f", $pr_total) ];
1116 if ( $conf->exists('svc_phone-did-summary') && $self->can('_did_summary') ) {
1117 warn "$me adding DID summary\n"
1120 my ($didsummary,$minutes) = $self->_did_summary;
1121 my $didsummary_desc = 'DID Activity Summary (since last invoice)';
1123 { 'description' => $didsummary_desc,
1124 'ext_description' => [ $didsummary, $minutes ],
1128 foreach my $section (@sections, @$late_sections) {
1130 # begin some normalization
1131 $section->{'subtotal'} = $section->{'amount'}
1133 && !exists($section->{subtotal})
1134 && exists($section->{amount});
1136 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
1137 if ( $invoice_data{finance_section} &&
1138 $section->{'description'} eq $invoice_data{finance_section} );
1140 $section->{'subtotal'} = $other_money_char.
1141 sprintf('%.2f', $section->{'subtotal'})
1144 # continue some normalization
1145 $section->{'amount'} = $section->{'subtotal'}
1149 if ( $section->{'description'} ) {
1150 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
1155 warn "$me setting options\n"
1159 $options{'section'} = $section if $multisection;
1160 $options{'format'} = $format;
1161 $options{'escape_function'} = $escape_function;
1162 $options{'no_usage'} = 1 unless $unsquelched;
1163 $options{'unsquelched'} = $unsquelched;
1164 $options{'summary_page'} = $summarypage;
1165 $options{'skip_usage'} =
1166 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
1167 $options{'preref_callback'} = $params{'preref_callback'};
1169 warn "$me searching for line items\n"
1172 foreach my $line_item ( $self->_items_pkg(%options),
1173 $self->_items_fee(%options) ) {
1175 warn "$me adding line item ".
1176 join(', ', map "$_=>".$line_item->{$_}, keys %$line_item). "\n"
1179 push @buf, ( [ $line_item->{'description'},
1180 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1182 map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}},
1185 $line_item->{'ref'} = $line_item->{'pkgnum'};
1186 $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()?
1187 $line_item->{'section'} = $section;
1188 $line_item->{'description'} = &$escape_function($line_item->{'description'});
1189 $line_item->{'amount'} = $money_char.$line_item->{'amount'};
1191 if ( length($line_item->{'unit_amount'}) ) {
1192 $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'};
1194 $line_item->{'ext_description'} ||= [];
1196 push @detail_items, $line_item;
1199 if ( $section->{'description'} ) {
1200 push @buf, ( ['','-----------'],
1201 [ $section->{'description'}. ' sub-total',
1202 $section->{'subtotal'} # already formatted this
1211 $invoice_data{current_less_finance} =
1212 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
1214 # if there's anything in the Previous Charges section, prepend it to the list
1215 if ( $pr_total and $previous_section ne $default_section ) {
1216 unshift @sections, $previous_section;
1217 # but not @summary_subtotals
1220 warn "$me adding taxes\n"
1223 my @items_tax = $self->_items_tax;
1224 foreach my $tax ( @items_tax ) {
1226 $taxtotal += $tax->{'amount'};
1228 my $description = &$escape_function( $tax->{'description'} );
1229 my $amount = sprintf( '%.2f', $tax->{'amount'} );
1231 if ( $multisection ) {
1233 push @detail_items, {
1234 ext_description => [],
1237 description => $description,
1238 amount => $money_char. $amount,
1240 section => $tax_section,
1245 push @total_items, {
1246 'total_item' => $description,
1247 'total_amount' => $other_money_char. $amount,
1252 push @buf,[ $description,
1253 $money_char. $amount,
1260 $total->{'total_item'} = $self->mt('Sub-total');
1261 $total->{'total_amount'} =
1262 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
1264 if ( $multisection ) {
1265 $tax_section->{'subtotal'} = $other_money_char.
1266 sprintf('%.2f', $taxtotal);
1267 $tax_section->{'pretotal'} = 'New charges sub-total '.
1268 $total->{'total_amount'};
1270 push @sections, $tax_section;
1271 push @summary_subtotals, $tax_section;
1274 unshift @total_items, $total;
1277 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1279 push @buf,['','-----------'];
1280 push @buf,[$self->mt(
1281 (!$self->enable_previous)
1283 : 'Total New Charges'
1285 $money_char. sprintf("%10.2f",$self->charged) ];
1293 my %embolden_functions = (
1294 'latex' => sub { return '\textbf{'. shift(). '}' },
1295 'html' => sub { return '<b>'. shift(). '</b>' },
1296 'template' => sub { shift },
1298 my $embolden_function = $embolden_functions{$format};
1300 if ( $self->can('_items_total') ) { # quotations
1302 $self->_items_total(\@total_items);
1304 foreach ( @total_items ) {
1305 $_->{'total_item'} = &$embolden_function( $_->{'total_item'} );
1306 $_->{'total_amount'} = &$embolden_function( $other_money_char.
1307 $_->{'total_amount'}
1311 } else { #normal invoice case
1313 # calculate total, possibly including total owed on previous
1317 $item = $conf->config('previous_balance-exclude_from_total')
1318 || 'Total New Charges'
1319 if $conf->exists('previous_balance-exclude_from_total');
1320 my $amount = $self->charged;
1321 if ( $self->enable_previous and !$conf->exists('previous_balance-exclude_from_total') ) {
1322 $amount += $pr_total;
1325 $total->{'total_item'} = &$embolden_function($self->mt($item));
1326 $total->{'total_amount'} =
1327 &$embolden_function( $other_money_char. sprintf( '%.2f', $amount ) );
1328 if ( $multisection ) {
1329 if ( $adjust_section->{'sort_weight'} ) {
1330 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1331 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1333 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1334 $other_money_char. sprintf('%.2f', $self->charged );
1337 push @total_items, $total;
1339 push @buf,['','-----------'];
1342 sprintf( '%10.2f', $amount )
1346 # if we're showing previous invoices, also show previous
1347 # credits and payments
1348 if ( $self->enable_previous
1349 and $self->can('_items_credits')
1350 and $self->can('_items_payments') )
1352 #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
1355 my $credittotal = 0;
1356 foreach my $credit (
1357 $self->_items_credits( 'template' => $template, 'trim_len' => 60 )
1361 $total->{'total_item'} = &$escape_function($credit->{'description'});
1362 $credittotal += $credit->{'amount'};
1363 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1364 $adjusttotal += $credit->{'amount'};
1365 if ( $multisection ) {
1366 push @detail_items, {
1367 ext_description => [],
1370 description => &$escape_function($credit->{'description'}),
1371 amount => $money_char . $credit->{'amount'},
1373 section => $adjust_section,
1376 push @total_items, $total;
1380 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1383 foreach my $credit (
1384 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1386 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1390 my $paymenttotal = 0;
1391 foreach my $payment (
1392 $self->_items_payments( 'template' => $template )
1395 $total->{'total_item'} = &$escape_function($payment->{'description'});
1396 $paymenttotal += $payment->{'amount'};
1397 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1398 $adjusttotal += $payment->{'amount'};
1399 if ( $multisection ) {
1400 push @detail_items, {
1401 ext_description => [],
1404 description => &$escape_function($payment->{'description'}),
1405 amount => $money_char . $payment->{'amount'},
1407 section => $adjust_section,
1410 push @total_items, $total;
1412 push @buf, [ $payment->{'description'},
1413 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1416 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1418 if ( $multisection ) {
1419 $adjust_section->{'subtotal'} = $other_money_char.
1420 sprintf('%.2f', $adjusttotal);
1421 push @sections, $adjust_section
1422 unless $adjust_section->{sort_weight};
1423 # do not summarize; adjustments there are shown according to
1427 # create Balance Due message
1430 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1431 $total->{'total_amount'} =
1432 &$embolden_function(
1433 $other_money_char. sprintf('%.2f', #why? $summarypage
1434 # ? $self->charged +
1435 # $self->billing_balance
1437 $self->owed + $pr_total
1440 if ( $multisection && !$adjust_section->{sort_weight} ) {
1441 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1442 $total->{'total_amount'};
1444 push @total_items, $total;
1446 push @buf,['','-----------'];
1447 push @buf,[$self->balance_due_msg, $money_char.
1448 sprintf("%10.2f", $balance_due ) ];
1451 if ( $conf->exists('previous_balance-show_credit')
1452 and $cust_main->balance < 0 ) {
1453 my $credit_total = {
1454 'total_item' => &$embolden_function($self->credit_balance_msg),
1455 'total_amount' => &$embolden_function(
1456 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1459 if ( $multisection ) {
1460 $adjust_section->{'posttotal'} .= $newline_token .
1461 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1464 push @total_items, $credit_total;
1466 push @buf,['','-----------'];
1467 push @buf,[$self->credit_balance_msg, $money_char.
1468 sprintf("%10.2f", -$cust_main->balance ) ];
1472 } #end of default total adding ! can('_items_total')
1474 if ( $multisection ) {
1475 if ( $conf->exists('svc_phone_sections')
1476 && $self->can('_items_svc_phone_sections')
1480 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1481 $total->{'total_amount'} =
1482 &$embolden_function(
1483 $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
1485 my $last_section = pop @sections;
1486 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1487 $total->{'total_amount'};
1488 push @sections, $last_section;
1490 push @sections, @$late_sections
1494 # make a discounts-available section, even without multisection
1495 if ( $conf->exists('discount-show_available')
1496 and my @discounts_avail = $self->_items_discounts_avail ) {
1497 my $discount_section = {
1498 'description' => $self->mt('Discounts Available'),
1503 push @sections, $discount_section; # do not summarize
1504 push @detail_items, map { +{
1505 'ref' => '', #should this be something else?
1506 'section' => $discount_section,
1507 'description' => &$escape_function( $_->{description} ),
1508 'amount' => $money_char . &$escape_function( $_->{amount} ),
1509 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1510 } } @discounts_avail;
1513 # not adding any more sections after this
1514 $invoice_data{summary_subtotals} = \@summary_subtotals;
1517 if ( $conf->exists('usage_class_summary')
1518 and $self->can('_items_usage_class_summary') ) {
1519 my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function);
1520 if ( @usage_subtotals ) {
1521 unshift @sections, $usage_subtotals[0]->{section}; # do not summarize
1522 unshift @detail_items, @usage_subtotals;
1526 # invoice history "section" (not really a section)
1527 # not to be included in any subtotals, completely independent of
1529 if ( $conf->exists('previous_invoice_history') ) {
1532 foreach my $cust_bill ( $cust_main->cust_bill ) {
1533 # XXX hardcoded format, and currently only 'charged'; add other fields
1534 # if they become necessary
1535 my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1536 $history{$date} ||= 0;
1537 $history{$date} += $cust_bill->charged;
1538 # just so we have a numeric sort key
1539 $monthorder{$date} ||= $cust_bill->_date;
1541 my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1543 my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1544 $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1547 # service locations: another option for template customization
1549 foreach my $item (@detail_items) {
1550 if ( $item->{locationnum} ) {
1551 $location_info{ $item->{locationnum} } ||= {
1552 FS::cust_location->by_key( $item->{locationnum} )->location_hash
1556 $invoice_data{location_info} = \%location_info;
1558 # debugging hook: call this with 'diag' => 1 to just get a hash of
1559 # the invoice variables
1560 return \%invoice_data if ( $params{'diag'} );
1562 # All sections and items are built; now fill in templates.
1563 my @includelist = ();
1564 push @includelist, 'summary' if $summarypage;
1565 foreach my $include ( @includelist ) {
1567 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1570 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1572 @inc_src = $conf->config($inc_file, $agentnum);
1576 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1578 my $convert_map = $convert_maps{$format}{$include};
1580 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1581 s/--\@\]/$delimiters{$format}[1]/g;
1584 &$convert_map( $conf->config($inc_file, $agentnum) );
1588 my $inc_tt = new Text::Template (
1590 SOURCE => [ map "$_\n", @inc_src ],
1591 DELIMITERS => $delimiters{$format},
1592 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1594 unless ( $inc_tt->compile() ) {
1595 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1596 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1600 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1602 $invoice_data{$include} =~ s/\n+$//
1603 if ($format eq 'latex');
1608 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1609 /invoice_lines\((\d*)\)/;
1610 $invoice_lines += $1 || scalar(@buf);
1613 die "no invoice_lines() functions in template?"
1614 if ( $format eq 'template' && !$wasfunc );
1616 if ($format eq 'template') {
1618 if ( $invoice_lines ) {
1619 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1620 $invoice_data{'total_pages'}++
1621 if scalar(@buf) % $invoice_lines;
1624 #setup subroutine for the template
1625 $invoice_data{invoice_lines} = sub {
1626 my $lines = shift || scalar(@buf);
1638 push @collect, split("\n",
1639 $text_template->fill_in( HASH => \%invoice_data )
1641 $invoice_data{'page'}++;
1643 map "$_\n", @collect;
1645 } else { # this is where we actually create the invoice
1647 warn "filling in template for invoice ". $self->invnum. "\n"
1649 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1652 $text_template->fill_in(HASH => \%invoice_data);
1656 sub notice_name { '('.shift->table.')'; }
1658 sub template_conf { 'invoice_'; }
1660 # helper routine for generating date ranges
1661 sub _prior_month30s {
1664 [ 1, 2592000 ], # 0-30 days ago
1665 [ 2592000, 5184000 ], # 30-60 days ago
1666 [ 5184000, 7776000 ], # 60-90 days ago
1667 [ 7776000, 0 ], # 90+ days ago
1670 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
1671 $_->[1] ? $self->_date - $_->[1] - 1 : '',
1676 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1678 Returns an postscript invoice, as a scalar.
1680 Options can be passed as a hashref (recommended) or as a list of time, template
1681 and then any key/value pairs for any other options.
1683 I<time> an optional value used to control the printing of overdue messages. The
1684 default is now. It isn't the date of the invoice; that's the `_date' field.
1685 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1686 L<Time::Local> and L<Date::Parse> for conversion functions.
1688 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1695 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1696 my $ps = generate_ps($file);
1698 unlink($barcodefile) if $barcodefile;
1703 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1705 Returns an PDF invoice, as a scalar.
1707 Options can be passed as a hashref (recommended) or as a list of time, template
1708 and then any key/value pairs for any other options.
1710 I<time> an optional value used to control the printing of overdue messages. The
1711 default is now. It isn't the date of the invoice; that's the `_date' field.
1712 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1713 L<Time::Local> and L<Date::Parse> for conversion functions.
1715 I<template>, if specified, is the name of a suffix for alternate invoices.
1717 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1724 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1725 my $pdf = generate_pdf($file);
1727 unlink($barcodefile) if $barcodefile;
1732 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1734 Returns an HTML invoice, as a scalar.
1736 I<time> an optional value used to control the printing of overdue messages. The
1737 default is now. It isn't the date of the invoice; that's the `_date' field.
1738 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1739 L<Time::Local> and L<Date::Parse> for conversion functions.
1741 I<template>, if specified, is the name of a suffix for alternate invoices.
1743 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1745 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1746 when emailing the invoice as part of a multipart/related MIME email.
1754 %params = %{ shift() };
1758 $params{'format'} = 'html';
1760 $self->print_generic( %params );
1763 # quick subroutine for print_latex
1765 # There are ten characters that LaTeX treats as special characters, which
1766 # means that they do not simply typeset themselves:
1767 # # $ % & ~ _ ^ \ { }
1769 # TeX ignores blanks following an escaped character; if you want a blank (as
1770 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1774 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1775 $value =~ s/([<>])/\$$1\$/g;
1781 encode_entities($value);
1785 sub _html_escape_nbsp {
1786 my $value = _html_escape(shift);
1787 $value =~ s/ +/ /g;
1791 #utility methods for print_*
1793 sub _translate_old_latex_format {
1794 warn "_translate_old_latex_format called\n"
1801 if ( $line =~ /^%%Detail\s*$/ ) {
1803 push @template, q![@--!,
1804 q! foreach my $_tr_line (@detail_items) {!,
1805 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1806 q! $_tr_line->{'description'} .= !,
1807 q! "\\tabularnewline\n~~".!,
1808 q! join( "\\tabularnewline\n~~",!,
1809 q! @{$_tr_line->{'ext_description'}}!,
1813 while ( ( my $line_item_line = shift )
1814 !~ /^%%EndDetail\s*$/ ) {
1815 $line_item_line =~ s/'/\\'/g; # nice LTS
1816 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1817 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1818 push @template, " \$OUT .= '$line_item_line';";
1821 push @template, '}',
1824 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1826 push @template, '[@--',
1827 ' foreach my $_tr_line (@total_items) {';
1829 while ( ( my $total_item_line = shift )
1830 !~ /^%%EndTotalDetails\s*$/ ) {
1831 $total_item_line =~ s/'/\\'/g; # nice LTS
1832 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1833 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1834 push @template, " \$OUT .= '$total_item_line';";
1837 push @template, '}',
1841 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1842 push @template, $line;
1848 warn "$_\n" foreach @template;
1860 my $conf = $self->conf;
1862 #check for an invoice-specific override
1863 return $self->invoice_terms if $self->invoice_terms;
1865 #check for a customer- specific override
1866 my $cust_main = $self->cust_main;
1867 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1871 $agentnum = $cust_main->agentnum;
1872 } elsif ( my $prospect_main = $self->prospect_main ) {
1873 $agentnum = $prospect_main->agentnum;
1876 #use configured default
1877 $conf->config('invoice_default_terms', $agentnum) || '';
1887 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1888 $duedate = $self->_date() + ( $1 * 86400 );
1899 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
1902 =item balance_due_msg
1906 sub balance_due_msg {
1908 my $msg = $self->mt('Balance Due');
1909 return $msg unless $self->terms;
1910 if ( $self->due_date ) {
1911 $msg .= ' - ' . $self->mt('Please pay by'). ' '.
1912 $self->due_date2str('short');
1913 } elsif ( $self->terms ) {
1914 $msg .= ' - '. $self->terms;
1919 =item balance_due_date
1923 sub balance_due_date {
1925 my $conf = $self->conf;
1927 my $terms = $self->terms;
1928 if ( $terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1929 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
1934 sub credit_balance_msg {
1936 $self->mt('Credit Balance Remaining')
1941 Returns a string with the date, for example: "3/20/2008", localized for the
1942 customer. Use _date_pretty_unlocalized for non-end-customer display use.
1948 $self->time2str_local('short', $self->_date);
1951 =item _date_pretty_unlocalized
1953 Returns a string with the date, for example: "3/20/2008", in the format
1954 configured for the back-office. Use _date_pretty for end-customer display use.
1958 sub _date_pretty_unlocalized {
1960 time2str($date_format, $self->_date);
1965 Emails this template.
1967 Options are passed as a hashref. Available options:
1973 If specified, overrides the default From: address.
1977 If specified, overrides the name of the sent document ("Invoice" or "Quotation")
1981 (Deprecated) If specified, is the name of a suffix for alternate template files.
1985 Options accepted by generate_email can also be used.
1991 my $opt = shift || {};
1992 if ($opt and !ref($opt)) {
1993 die ref($self). '->email called with positional parameters';
1996 return if $self->hide;
1998 my $error = send_email(
1999 $self->generate_email(
2000 'subject' => $self->email_subject($opt->{template}),
2001 %$opt, # template, etc.
2005 die "can't email: $error\n" if $error;
2008 =item generate_email OPTION => VALUE ...
2016 sender address, required
2020 alternate template name, optional
2024 text attachment arrayref, optional
2028 email subject, optional
2032 notice name instead of "Invoice", optional
2036 Returns an argument list to be passed to L<FS::Misc::send_email>.
2042 sub generate_email {
2046 my $conf = $self->conf;
2048 my $me = '[FS::Template_Mixin::generate_email]';
2051 'from' => $args{'from'},
2052 'subject' => ($args{'subject'} || $self->email_subject),
2053 'custnum' => $self->custnum,
2054 'msgtype' => 'invoice',
2057 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
2059 my $cust_main = $self->cust_main;
2061 if (ref($args{'to'}) eq 'ARRAY') {
2062 $return{'to'} = $args{'to'};
2063 } elsif ( $cust_main ) {
2064 $return{'to'} = [ $cust_main->invoicing_list_emailonly ];
2067 my $tc = $self->template_conf;
2069 if ( $conf->exists($tc.'html') ) {
2071 warn "$me creating HTML/text multipart message"
2074 $return{'nobody'} = 1;
2076 my $alternative = build MIME::Entity
2077 'Type' => 'multipart/alternative',
2078 #'Encoding' => '7bit',
2079 'Disposition' => 'inline'
2083 if ( $conf->exists($tc. 'email_pdf')
2084 and scalar($conf->config($tc. 'email_pdf_note')) ) {
2086 warn "$me using '${tc}email_pdf_note' in multipart message"
2088 $data = [ map { $_ . "\n" }
2089 $conf->config($tc.'email_pdf_note')
2094 warn "$me not using '${tc}email_pdf_note' in multipart message"
2096 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
2097 $data = $args{'print_text'};
2098 } elsif ( $conf->exists($tc.'template') ) { #plaintext invoice_template
2099 $data = [ $self->print_text(\%args) ];
2105 $alternative->attach(
2106 'Type' => 'text/plain',
2107 'Encoding' => 'quoted-printable',
2108 'Charset' => 'UTF-8',
2109 #'Encoding' => '7bit',
2111 'Disposition' => 'inline',
2118 if ( $conf->exists($tc.'email_pdf')
2119 and scalar($conf->config($tc.'email_pdf_note')) ) {
2121 $htmldata = join('<BR>', $conf->config($tc.'email_pdf_note') );
2125 $args{'from'} =~ /\@([\w\.\-]+)/;
2126 my $from = $1 || 'example.com';
2127 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2130 my $agentnum = $cust_main ? $cust_main->agentnum
2131 : $self->prospect_main->agentnum;
2132 if ( defined($args{'template'}) && length($args{'template'})
2133 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
2136 $logo = 'logo_'. $args{'template'}. '.png';
2140 my $image_data = $conf->config_binary( $logo, $agentnum);
2142 $image = build MIME::Entity
2143 'Type' => 'image/png',
2144 'Encoding' => 'base64',
2145 'Data' => $image_data,
2146 'Filename' => 'logo.png',
2147 'Content-ID' => "<$content_id>",
2150 if ( ref($self) eq 'FS::cust_bill' && $conf->exists('invoice-barcode') ) {
2151 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2152 $barcode = build MIME::Entity
2153 'Type' => 'image/png',
2154 'Encoding' => 'base64',
2155 'Data' => $self->invoice_barcode(0),
2156 'Filename' => 'barcode.png',
2157 'Content-ID' => "<$barcode_content_id>",
2159 $args{'barcode_cid'} = $barcode_content_id;
2162 $htmldata = $self->print_html({ 'cid'=>$content_id, %args });
2165 $alternative->attach(
2166 'Type' => 'text/html',
2167 'Encoding' => 'quoted-printable',
2168 'Data' => [ '<html>',
2171 ' '. encode_entities($return{'subject'}),
2174 ' <body bgcolor="#e8e8e8">',
2179 'Disposition' => 'inline',
2180 #'Filename' => 'invoice.pdf',
2184 my @otherparts = ();
2185 if ( ref($self) eq 'FS::cust_bill' && $cust_main->email_csv_cdr ) {
2187 push @otherparts, build MIME::Entity
2188 'Type' => 'text/csv',
2189 'Encoding' => '7bit',
2190 'Data' => [ map { "$_\n" }
2191 $self->call_details('prepend_billed_number' => 1)
2193 'Disposition' => 'attachment',
2194 'Filename' => 'usage-'. $self->invnum. '.csv',
2199 if ( $conf->exists($tc.'email_pdf') ) {
2204 # multipart/alternative
2210 my $related = build MIME::Entity 'Type' => 'multipart/related',
2211 'Encoding' => '7bit';
2213 #false laziness w/Misc::send_email
2214 $related->head->replace('Content-type',
2215 $related->mime_type.
2216 '; boundary="'. $related->head->multipart_boundary. '"'.
2217 '; type=multipart/alternative'
2220 $related->add_part($alternative);
2222 $related->add_part($image) if $image;
2224 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
2226 $return{'mimeparts'} = [ $related, $pdf, @otherparts ];
2230 #no other attachment:
2232 # multipart/alternative
2237 $return{'content-type'} = 'multipart/related';
2238 if ($conf->exists('invoice-barcode') && $barcode) {
2239 $return{'mimeparts'} = [ $alternative, $image, $barcode, @otherparts ];
2241 $return{'mimeparts'} = [ $alternative, $image, @otherparts ];
2243 $return{'type'} = 'multipart/alternative'; #Content-Type of first part...
2244 #$return{'disposition'} = 'inline';
2250 if ( $conf->exists($tc.'email_pdf') ) {
2251 warn "$me creating PDF attachment"
2254 #mime parts arguments a la MIME::Entity->build().
2255 $return{'mimeparts'} = [
2256 { $self->mimebuild_pdf(\%args) }
2260 if ( $conf->exists($tc.'email_pdf')
2261 and scalar($conf->config($tc.'email_pdf_note')) ) {
2263 warn "$me using '${tc}email_pdf_note'"
2265 $return{'body'} = [ map { $_ . "\n" }
2266 $conf->config($tc.'email_pdf_note')
2271 warn "$me not using '${tc}email_pdf_note'"
2273 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
2274 $return{'body'} = $args{'print_text'};
2276 $return{'body'} = [ $self->print_text(\%args) ];
2289 Returns a list suitable for passing to MIME::Entity->build(), representing
2290 this invoice as PDF attachment.
2297 'Type' => 'application/pdf',
2298 'Encoding' => 'base64',
2299 'Data' => [ $self->print_pdf(@_) ],
2300 'Disposition' => 'attachment',
2301 'Filename' => 'invoice-'. $self->invnum. '.pdf',
2305 =item _items_sections OPTIONS
2307 Generate section information for all items appearing on this invoice.
2308 This will only be called for multi-section invoices.
2310 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
2311 related display records (L<FS::cust_bill_pkg_display>) and organize
2312 them into two groups ("early" and "late" according to whether they come
2313 before or after the total), then into sections. A subtotal is calculated
2316 Section descriptions are returned in sort weight order. Each consists
2317 of a hash containing:
2319 description: the package category name, escaped
2320 subtotal: the total charges in that section
2321 tax_section: a flag indicating that the section contains only tax charges
2322 summarized: same as tax_section, for some reason
2323 sort_weight: the package category's sort weight
2325 If 'condense' is set on the display record, it also contains everything
2326 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
2327 coderefs to generate parts of the invoice. This is not advised.
2329 The method returns two arrayrefs, one of "early" sections and one of "late"
2332 OPTIONS may include:
2334 by_location: a flag to divide the invoice into sections by location.
2335 Each section hash will have a 'location' element containing a hashref of
2336 the location fields (see L<FS::cust_location>). The section description
2337 will be the location label, but the template can use any of the location
2338 fields to create a suitable label.
2340 by_category: a flag to divide the invoice into sections using display
2341 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
2342 behavior. Each section hash will have a 'category' element containing
2343 the section name from the display record (which probably equals the
2344 category name of the package, but may not in some cases).
2346 summary: a flag indicating that this is a summary-format invoice.
2347 Turning this on has the following effects:
2348 - Ignores display items with the 'summary' flag.
2349 - Places all sections in the "early" group even if they have post_total.
2350 - Creates sections for all non-disabled package categories, even if they
2351 have no charges on this invoice, as well as a section with no name.
2353 escape: an escape function to use for section titles.
2355 extra_sections: an arrayref of additional sections to return after the
2356 sorted list. If there are any of these, section subtotals exclude
2359 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
2360 passed through to C<_condense_section()>.
2364 use vars qw(%pkg_category_cache);
2365 sub _items_sections {
2369 my $escape = $opt{escape};
2370 my @extra_sections = @{ $opt{extra_sections} || [] };
2372 # $subtotal{$locationnum}{$categoryname} = amount.
2373 # if we're not using by_location, $locationnum is undef.
2374 # if we're not using by_category, you guessed it, $categoryname is undef.
2375 # if we're not using either one, we shouldn't be here in the first place...
2377 my %late_subtotal = ();
2380 # About tax items + multisection invoices:
2381 # If either invoice_*summary option is enabled, AND there is a
2382 # package category with the name of the tax, then there will be
2383 # a display record assigning the tax item to that category.
2385 # However, the taxes are always placed in the "Taxes, Surcharges,
2386 # and Fees" section regardless of that. The only effect of the
2387 # display record is to create a subtotal for the summary page.
2390 my $pkg_hash = $self->cust_pkg_hash;
2392 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2395 my $usage = $cust_bill_pkg->usage;
2398 if ( $opt{by_location} ) {
2399 if ( $cust_bill_pkg->pkgnum ) {
2400 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2405 $locationnum = undef;
2408 # as in _items_cust_pkg, if a line item has no display records,
2409 # cust_bill_pkg_display() returns a default record for it
2411 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2412 next if ( $display->summary && $opt{summary} );
2414 my $section = $display->section;
2415 my $type = $display->type;
2416 # Set $section = undef if we're sectioning by location and this
2417 # line item _has_ a location (i.e. isn't a fee).
2418 $section = undef if $locationnum;
2420 # set this flag if the section is not tax-only
2421 $not_tax{$locationnum}{$section} = 1
2422 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
2424 # there's actually a very important piece of logic buried in here:
2425 # incrementing $late_subtotal{$section} CREATES
2426 # $late_subtotal{$section}. keys(%late_subtotal) is later used
2427 # to define the list of late sections, and likewise keys(%subtotal).
2428 # When _items_cust_bill_pkg is called to generate line items for
2429 # real, it will be called with 'section' => $section for each
2431 if ( $display->post_total && !$opt{summary} ) {
2432 if (! $type || $type eq 'S') {
2433 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2434 if $cust_bill_pkg->setup != 0
2435 || $cust_bill_pkg->setup_show_zero;
2439 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
2440 if $cust_bill_pkg->recur != 0
2441 || $cust_bill_pkg->recur_show_zero;
2444 if ($type && $type eq 'R') {
2445 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2446 if $cust_bill_pkg->recur != 0
2447 || $cust_bill_pkg->recur_show_zero;
2450 if ($type && $type eq 'U') {
2451 $late_subtotal{$locationnum}{$section} += $usage
2452 unless scalar(@extra_sections);
2455 } else { # it's a pre-total (normal) section
2457 # skip tax items unless they're explicitly included in a section
2458 next if $cust_bill_pkg->pkgnum == 0 and
2459 ! $cust_bill_pkg->feepart and
2462 if ( $type eq 'S' ) {
2463 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2464 if $cust_bill_pkg->setup != 0
2465 || $cust_bill_pkg->setup_show_zero;
2466 } elsif ( $type eq 'R' ) {
2467 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2468 if $cust_bill_pkg->recur != 0
2469 || $cust_bill_pkg->recur_show_zero;
2470 } elsif ( $type eq 'U' ) {
2471 $subtotal{$locationnum}{$section} += $usage
2472 unless scalar(@extra_sections);
2473 } elsif ( !$type ) {
2474 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2475 + $cust_bill_pkg->recur;
2484 %pkg_category_cache = ();
2486 # summary invoices need subtotals for all non-disabled package categories,
2487 # even if they're zero
2488 # but currently assume that there are no location sections, or at least
2489 # that the summary page doesn't care about them
2490 if ( $opt{summary} ) {
2491 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2492 $subtotal{''}{$category->categoryname} ||= 0;
2494 $subtotal{''}{''} ||= 0;
2498 foreach my $post_total (0,1) {
2500 my $s = $post_total ? \%late_subtotal : \%subtotal;
2501 foreach my $locationnum (keys %$s) {
2502 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2504 'subtotal' => $s->{$locationnum}{$sectionname},
2505 'post_total' => $post_total,
2508 if ( $locationnum ) {
2509 $section->{'locationnum'} = $locationnum;
2510 my $location = FS::cust_location->by_key($locationnum);
2511 $section->{'description'} = &{ $escape }($location->location_label);
2512 # Better ideas? This will roughly group them by proximity,
2513 # which alpha sorting on any of the address fields won't.
2514 # Sorting by locationnum is meaningless.
2515 # We have to sort on _something_ or the order may change
2516 # randomly from one invoice to the next, which will confuse
2518 $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
2520 $section->{'location'} = {
2521 label_prefix => &{ $escape }($location->label_prefix),
2522 map { $_ => &{ $escape }($location->get($_)) }
2526 $section->{'category'} = $sectionname;
2527 $section->{'description'} = &{ $escape }($sectionname);
2528 if ( _pkg_category($sectionname) ) {
2529 $section->{'sort_weight'} = _pkg_category($sectionname)->weight;
2530 if ( _pkg_category($sectionname)->condense ) {
2531 $section = { %$section, $self->_condense_section($opt{format}) };
2535 if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
2536 # then it's a tax-only section
2537 $section->{'summarized'} = 'Y';
2538 $section->{'tax_section'} = 'Y';
2540 push @these, $section;
2541 } # foreach $sectionname
2542 } #foreach $locationnum
2543 push @these, @extra_sections if $post_total == 0;
2544 # need an alpha sort for location sections, because postal codes can
2546 $sections[ $post_total ] = [ sort {
2547 $opt{'by_location'} ?
2548 ($a->{sort_weight} cmp $b->{sort_weight}) :
2549 ($a->{sort_weight} <=> $b->{sort_weight})
2551 } #foreach $post_total
2553 return @sections; # early, late
2556 #helper subs for above
2560 $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2564 my $categoryname = shift;
2565 $pkg_category_cache{$categoryname} ||=
2566 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2569 my %condensed_format = (
2570 'label' => [ qw( Description Qty Amount ) ],
2572 sub { shift->{description} },
2573 sub { shift->{quantity} },
2574 sub { my($href, %opt) = @_;
2575 ($opt{dollar} || ''). $href->{amount};
2578 'align' => [ qw( l r r ) ],
2579 'span' => [ qw( 5 1 1 ) ], # unitprices?
2580 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
2583 sub _condense_section {
2584 my ( $self, $format ) = ( shift, shift );
2586 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2587 qw( description_generator
2590 total_line_generator
2595 sub _condensed_generator_defaults {
2596 my ( $self, $format ) = ( shift, shift );
2597 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2606 sub _condensed_header_generator {
2607 my ( $self, $format ) = ( shift, shift );
2609 my ( $f, $prefix, $suffix, $separator, $column ) =
2610 _condensed_generator_defaults($format);
2612 if ($format eq 'latex') {
2613 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2614 $suffix = "\\\\\n\\hline";
2617 sub { my ($d,$a,$s,$w) = @_;
2618 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2620 } elsif ( $format eq 'html' ) {
2621 $prefix = '<th></th>';
2625 sub { my ($d,$a,$s,$w) = @_;
2626 return qq!<th align="$html_align{$a}">$d</th>!;
2634 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2636 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2639 $prefix. join($separator, @result). $suffix;
2644 sub _condensed_description_generator {
2645 my ( $self, $format ) = ( shift, shift );
2647 my ( $f, $prefix, $suffix, $separator, $column ) =
2648 _condensed_generator_defaults($format);
2650 my $money_char = '$';
2651 if ($format eq 'latex') {
2652 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2654 $separator = " & \n";
2656 sub { my ($d,$a,$s,$w) = @_;
2657 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2659 $money_char = '\\dollar';
2660 }elsif ( $format eq 'html' ) {
2661 $prefix = '"><td align="center"></td>';
2665 sub { my ($d,$a,$s,$w) = @_;
2666 return qq!<td align="$html_align{$a}">$d</td>!;
2668 #$money_char = $conf->config('money_char') || '$';
2669 $money_char = ''; # this is madness
2677 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2679 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2681 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2682 map { $f->{$_}->[$i] } qw(align span width)
2686 $prefix. join( $separator, @result ). $suffix;
2691 sub _condensed_total_generator {
2692 my ( $self, $format ) = ( shift, shift );
2694 my ( $f, $prefix, $suffix, $separator, $column ) =
2695 _condensed_generator_defaults($format);
2698 if ($format eq 'latex') {
2701 $separator = " & \n";
2703 sub { my ($d,$a,$s,$w) = @_;
2704 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2706 }elsif ( $format eq 'html' ) {
2710 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2712 sub { my ($d,$a,$s,$w) = @_;
2713 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2722 # my $r = &{$f->{fields}->[$i]}(@args);
2723 # $r .= ' Total' unless $i;
2725 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2727 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
2728 map { $f->{$_}->[$i] } qw(align span width)
2732 $prefix. join( $separator, @result ). $suffix;
2737 =item total_line_generator FORMAT
2739 Returns a coderef used for generation of invoice total line items for this
2740 usage_class. FORMAT is either html or latex
2744 # should not be used: will have issues with hash element names (description vs
2745 # total_item and amount vs total_amount -- another array of functions?
2747 sub _condensed_total_line_generator {
2748 my ( $self, $format ) = ( shift, shift );
2750 my ( $f, $prefix, $suffix, $separator, $column ) =
2751 _condensed_generator_defaults($format);
2754 if ($format eq 'latex') {
2757 $separator = " & \n";
2759 sub { my ($d,$a,$s,$w) = @_;
2760 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2762 }elsif ( $format eq 'html' ) {
2766 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2768 sub { my ($d,$a,$s,$w) = @_;
2769 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2778 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2780 &{$column}( &{$f->{fields}->[$i]}(@args),
2781 map { $f->{$_}->[$i] } qw(align span width)
2785 $prefix. join( $separator, @result ). $suffix;
2790 =item _items_pkg [ OPTIONS ]
2792 Return line item hashes for each package item on this invoice. Nearly
2795 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
2797 The only OPTIONS accepted is 'section', which may point to a hashref
2798 with a key named 'condensed', which may have a true value. If it
2799 does, this method tries to merge identical items into items with
2800 'quantity' equal to the number of items (not the sum of their
2801 separate quantities, for some reason).
2807 # The order of these is important. Bundled line items will be merged into
2808 # the most recent non-hidden item, so it needs to be the one with:
2810 # - the same start date
2811 # - no pkgpart_override
2813 # So: sort by pkgnum,
2815 # then sort the base line item before any overrides
2816 # then sort hidden before non-hidden add-ons
2817 # then sort by override pkgpart (for consistency)
2818 sort { $a->pkgnum <=> $b->pkgnum or
2819 $a->sdate <=> $b->sdate or
2820 ($a->pkgpart_override ? 0 : -1) or
2821 ($b->pkgpart_override ? 0 : 1) or
2822 $b->hidden cmp $a->hidden or
2823 $a->pkgpart_override <=> $b->pkgpart_override
2825 # and of course exclude taxes and fees
2826 grep { $_->pkgnum > 0 } $self->cust_bill_pkg;
2832 my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
2833 my $escape_function = $options{escape_function};
2836 foreach my $cust_bill_pkg (@cust_bill_pkg) {
2837 # cache this, so we don't look it up again in every section
2838 my $part_fee = $cust_bill_pkg->get('part_fee')
2839 || $cust_bill_pkg->part_fee;
2840 $cust_bill_pkg->set('part_fee', $part_fee);
2842 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
2843 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
2846 if ( exists($options{section}) and exists($options{section}{category}) )
2848 my $categoryname = $options{section}{category};
2849 # then filter for items that have that section
2850 if ( $part_fee->categoryname ne $categoryname ) {
2851 warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
2854 } # otherwise include them all in the main section
2855 # XXX what to do when sectioning by location?
2858 my %base_invnums; # invnum => invoice date
2859 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
2860 if ($_->base_invnum) {
2861 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
2862 my $base_date = $self->time2str_local('short', $base_bill->_date)
2864 $base_invnums{$_->base_invnum} = $base_date || '';
2867 foreach (sort keys(%base_invnums)) {
2868 next if $_ == $self->invnum;
2870 &{$escape_function}(
2871 $self->mt('from invoice #[_1] on [_2]', $_, $base_invnums{$_})
2874 my $desc = $part_fee->itemdesc_locale($self->cust_main->locale);
2875 $desc = &{$escape_function}($desc);
2878 { feepart => $cust_bill_pkg->feepart,
2879 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
2880 description => $desc,
2881 ext_description => \@ext_desc
2892 warn "$me _items_pkg searching for all package line items\n"
2895 my @cust_bill_pkg = $self->_items_nontax;
2897 warn "$me _items_pkg filtering line items\n"
2899 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2901 if ($options{section} && $options{section}->{condensed}) {
2903 warn "$me _items_pkg condensing section\n"
2907 local $Storable::canonical = 1;
2908 foreach ( @items ) {
2910 delete $item->{ref};
2911 delete $item->{ext_description};
2912 my $key = freeze($item);
2913 $itemshash{$key} ||= 0;
2914 $itemshash{$key} ++; # += $item->{quantity};
2916 @items = sort { $a->{description} cmp $b->{description} }
2917 map { my $i = thaw($_);
2918 $i->{quantity} = $itemshash{$_};
2920 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
2926 warn "$me _items_pkg returning ". scalar(@items). " items\n"
2933 return 0 unless $a->itemdesc cmp $b->itemdesc;
2934 return -1 if $b->itemdesc eq 'Tax';
2935 return 1 if $a->itemdesc eq 'Tax';
2936 return -1 if $b->itemdesc eq 'Other surcharges';
2937 return 1 if $a->itemdesc eq 'Other surcharges';
2938 $a->itemdesc cmp $b->itemdesc;
2943 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
2944 $self->cust_bill_pkg;
2945 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2947 if ( $self->conf->exists('always_show_tax') ) {
2948 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
2949 if (0 == grep { $_->{description} eq $itemdesc } @items) {
2951 { 'description' => $itemdesc,
2958 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
2960 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
2961 list of hashrefs describing the line items they generate on the invoice.
2963 OPTIONS may include:
2965 format: the invoice format.
2967 escape_function: the function used to escape strings.
2969 DEPRECATED? (expensive, mostly unused?)
2970 format_function: the function used to format CDRs.
2972 section: a hashref containing 'category' and/or 'locationnum'; if this
2973 is present, only returns line items that belong to that category and/or
2974 location (whichever is defined).
2976 multisection: a flag indicating that this is a multisection invoice,
2977 which does something complicated.
2979 preref_callback: coderef run for each line item, code should return HTML to be
2980 displayed before that line item (quotations only)
2982 Returns a list of hashrefs, each of which may contain:
2984 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
2985 ext_description, which is an arrayref of detail lines to show below
2990 sub _items_cust_bill_pkg {
2992 my $conf = $self->conf;
2993 my $cust_bill_pkgs = shift;
2996 my $format = $opt{format} || '';
2997 my $escape_function = $opt{escape_function} || sub { shift };
2998 my $format_function = $opt{format_function} || '';
2999 my $no_usage = $opt{no_usage} || '';
3000 my $unsquelched = $opt{unsquelched} || ''; #unused
3001 my ($section, $locationnum, $category);
3002 if ( $opt{section} ) {
3003 $category = $opt{section}->{category};
3004 $locationnum = $opt{section}->{locationnum};
3006 my $summary_page = $opt{summary_page} || ''; #unused
3007 my $multisection = defined($category) || defined($locationnum);
3008 my $discount_show_always = 0;
3010 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
3012 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
3013 # and location labels
3015 my @b = (); # accumulator for the line item hashes that we'll return
3016 my ($s, $r, $u, $d) = ( undef, undef, undef, undef );
3017 # the 'current' line item hashes for setup, recur, usage, discount
3018 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
3020 # if the current line item is waiting to go out, and the one we're about
3021 # to start is not bundled, then push out the current one and start a new
3023 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3024 if ( $_ && !$cust_bill_pkg->hidden ) {
3025 $_->{amount} = sprintf( "%.2f", $_->{amount} );
3026 $_->{amount} =~ s/^\-0\.00$/0.00/;
3027 if (exists($_->{unit_amount})) {
3028 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3031 if $_->{amount} != 0
3032 || $discount_show_always
3033 || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3034 || ( $_->{_is_setup} && $_->{setup_show_zero} )
3040 if ( $locationnum ) {
3041 # this is a location section; skip packages that aren't at this
3043 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
3044 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
3048 # Consider display records for this item to determine if it belongs
3049 # in this section. Note that if there are no display records, there
3050 # will be a default pseudo-record that includes all charge types
3051 # and has no section name.
3052 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
3053 ? $cust_bill_pkg->cust_bill_pkg_display
3054 : ( $cust_bill_pkg );
3056 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
3057 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
3060 if ( defined($category) ) {
3061 # then this is a package category section; process all display records
3062 # that belong to this section.
3063 @cust_bill_pkg_display = grep { $_->section eq $category }
3064 @cust_bill_pkg_display;
3066 # otherwise, process all display records that aren't usage summaries
3067 # (I don't think there should be usage summaries if you aren't using
3068 # category sections, but this is the historical behavior)
3069 @cust_bill_pkg_display = grep { !$_->summary }
3070 @cust_bill_pkg_display;
3073 my $classname = ''; # package class name, will fill in later
3075 foreach my $display (@cust_bill_pkg_display) {
3077 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
3078 $display->billpkgdisplaynum. "\n"
3081 my $type = $display->type;
3083 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
3084 $desc = substr($desc, 0, $maxlength). '...'
3085 if $format eq 'latex' && length($desc) > $maxlength;
3087 my %details_opt = ( 'format' => $format,
3088 'escape_function' => $escape_function,
3089 'format_function' => $format_function,
3090 'no_usage' => $opt{'no_usage'},
3093 if ( ref($cust_bill_pkg) eq 'FS::quotation_pkg' ) {
3095 warn "$me _items_cust_bill_pkg cust_bill_pkg is quotation_pkg\n"
3097 # quotation_pkgs are never fees, so don't worry about the case where
3098 # part_pkg is undefined
3100 # and I guess they're never bundled either?
3101 if ( $cust_bill_pkg->setup != 0 ) {
3102 my $description = $desc;
3103 $description .= ' Setup'
3104 if $cust_bill_pkg->recur != 0
3105 || $discount_show_always
3106 || $cust_bill_pkg->recur_show_zero;
3108 # keep it consistent, please
3110 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3111 'description' => $description,
3112 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
3113 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitsetup),
3114 'quantity' => $cust_bill_pkg->quantity,
3115 'preref_html' => ( $opt{preref_callback}
3116 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3121 if ( $cust_bill_pkg->recur != 0 ) {
3124 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3125 'description' => "$desc (". $cust_bill_pkg->part_pkg->freq_pretty.")",
3126 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
3127 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitrecur),
3128 'quantity' => $cust_bill_pkg->quantity,
3129 'preref_html' => ( $opt{preref_callback}
3130 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3136 } elsif ( $cust_bill_pkg->pkgnum > 0 ) {
3137 # a "normal" package line item (not a quotation, not a fee, not a tax)
3139 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
3142 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3143 my $part_pkg = $cust_pkg->part_pkg;
3145 # which pkgpart to show for display purposes?
3146 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
3148 # start/end dates for invoice formats that do nonstandard
3150 my %item_dates = ();
3151 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
3152 unless $part_pkg->option('disable_line_item_date_ranges',1);
3154 # not normally used, but pass this to the template anyway
3155 $classname = $part_pkg->classname;
3157 if ( (!$type || $type eq 'S')
3158 && ( $cust_bill_pkg->setup != 0
3159 || $cust_bill_pkg->setup_show_zero
3164 warn "$me _items_cust_bill_pkg adding setup\n"
3167 my $description = $desc;
3168 $description .= ' Setup'
3169 if $cust_bill_pkg->recur != 0
3170 || $discount_show_always
3171 || $cust_bill_pkg->recur_show_zero;
3173 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3175 if $part_pkg->is_prepaid #for prepaid, "display the validity period
3176 # triggered by the recurring charge freq
3178 && $cust_bill_pkg->recur == 0
3179 && ! $cust_bill_pkg->recur_show_zero;
3184 # always pass the svc_label through to the template, even if
3185 # not displaying it as an ext_description
3186 my @svc_labels = map &{$escape_function}($_),
3187 $cust_pkg->h_labels_short($self->_date, undef, 'I');
3189 $svc_label = $svc_labels[0];
3191 unless ( $cust_pkg->part_pkg->hide_svc_detail
3192 || $cust_bill_pkg->hidden )
3195 push @d, @svc_labels
3196 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3197 my $lnum = $cust_main ? $cust_main->ship_locationnum
3198 : $self->prospect_main->locationnum;
3199 # show the location label if it's not the customer's default
3200 # location, and we're not grouping items by location already
3201 if ( $cust_pkg->locationnum != $lnum and !defined($locationnum) ) {
3202 my $loc = $cust_pkg->location_label;
3203 $loc = substr($loc, 0, $maxlength). '...'
3204 if $format eq 'latex' && length($loc) > $maxlength;
3205 push @d, &{$escape_function}($loc);
3208 } #unless hiding service details
3210 push @d, $cust_bill_pkg->details(%details_opt)
3211 if $cust_bill_pkg->recur == 0;
3213 if ( $cust_bill_pkg->hidden ) {
3214 $s->{amount} += $cust_bill_pkg->setup;
3215 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3216 push @{ $s->{ext_description} }, @d;
3220 description => $description,
3221 pkgpart => $pkgpart,
3222 pkgnum => $cust_bill_pkg->pkgnum,
3223 amount => $cust_bill_pkg->setup,
3224 setup_show_zero => $cust_bill_pkg->setup_show_zero,
3225 unit_amount => $cust_bill_pkg->unitsetup,
3226 quantity => $cust_bill_pkg->quantity,
3227 ext_description => \@d,
3228 svc_label => ($svc_label || ''),
3229 locationnum => $cust_pkg->locationnum, # sure, why not?
3235 if ( ( !$type || $type eq 'R' || $type eq 'U' )
3237 $cust_bill_pkg->recur != 0
3238 || $cust_bill_pkg->setup == 0
3239 || $discount_show_always
3240 || $cust_bill_pkg->recur_show_zero
3245 warn "$me _items_cust_bill_pkg adding recur/usage\n"
3248 my $is_summary = $display->summary;
3249 my $description = $desc;
3250 if ( $type eq 'U' and defined($r) ) {
3251 # don't just show the same description as the recur line
3252 $description = $self->mt('Usage charges');
3255 my $part_pkg = $cust_pkg->part_pkg;
3257 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3261 my @seconds = (); # for display of usage info
3264 #at least until cust_bill_pkg has "past" ranges in addition to
3265 #the "future" sdate/edate ones... see #3032
3266 my @dates = ( $self->_date );
3267 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
3268 push @dates, $prev->sdate if $prev;
3269 push @dates, undef if !$prev;
3271 my @svc_labels = map &{$escape_function}($_),
3272 $cust_pkg->h_labels_short(@dates, 'I');
3273 $svc_label = $svc_labels[0];
3275 # show service labels, unless...
3276 # the package is set not to display them
3277 unless ( $part_pkg->hide_svc_detail
3278 # or this is a tax-like line item
3279 || $cust_bill_pkg->itemdesc
3280 # or this is a hidden (bundled) line item
3281 || $cust_bill_pkg->hidden
3282 # or this is a usage summary line
3283 || $is_summary && $type && $type eq 'U'
3284 # or this is a usage line and there's a recurring line
3285 # for the package in the same section (which will
3286 # have service labels already)
3287 || ($type eq 'U' and defined($r))
3291 warn "$me _items_cust_bill_pkg adding service details\n"
3294 push @d, @svc_labels
3295 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3296 warn "$me _items_cust_bill_pkg done adding service details\n"
3299 my $lnum = $cust_main ? $cust_main->ship_locationnum
3300 : $self->prospect_main->locationnum;
3301 # show the location label if it's not the customer's default
3302 # location, and we're not grouping items by location already
3303 if ( $cust_pkg->locationnum != $lnum and !defined($locationnum) ) {
3304 my $loc = $cust_pkg->location_label;
3305 $loc = substr($loc, 0, $maxlength). '...'
3306 if $format eq 'latex' && length($loc) > $maxlength;
3307 push @d, &{$escape_function}($loc);
3310 # Display of seconds_since_sqlradacct:
3311 # On the invoice, when processing @detail_items, look for a field
3312 # named 'seconds'. This will contain total seconds for each
3313 # service, in the same order as @ext_description. For services
3314 # that don't support this it will show undef.
3315 if ( $conf->exists('svc_acct-usage_seconds')
3316 and ! $cust_bill_pkg->pkgpart_override ) {
3317 foreach my $cust_svc (
3318 $cust_pkg->h_cust_svc(@dates, 'I')
3321 # eval because not having any part_export_usage exports
3322 # is a fatal error, last_bill/_date because that's how
3323 # sqlradius_hour billing does it
3325 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
3327 push @seconds, $sec;
3329 } #if svc_acct-usage_seconds
3331 } # if we are showing service labels
3333 unless ( $is_summary ) {
3334 warn "$me _items_cust_bill_pkg adding details\n"
3337 #instead of omitting details entirely in this case (unwanted side
3338 # effects), just omit CDRs
3339 $details_opt{'no_usage'} = 1
3340 if $type && $type eq 'R';
3342 push @d, $cust_bill_pkg->details(%details_opt);
3345 warn "$me _items_cust_bill_pkg calculating amount\n"
3350 $amount = $cust_bill_pkg->recur;
3351 } elsif ($type eq 'R') {
3352 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
3353 } elsif ($type eq 'U') {
3354 $amount = $cust_bill_pkg->usage;
3357 if ( !$type || $type eq 'R' ) {
3359 warn "$me _items_cust_bill_pkg adding recur\n"
3363 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
3366 if ( $cust_bill_pkg->hidden ) {
3367 $r->{amount} += $amount;
3368 $r->{unit_amount} += $unit_amount;
3369 push @{ $r->{ext_description} }, @d;
3372 description => $description,
3373 pkgpart => $pkgpart,
3374 pkgnum => $cust_bill_pkg->pkgnum,
3376 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3377 unit_amount => $unit_amount,
3378 quantity => $cust_bill_pkg->quantity,
3380 ext_description => \@d,
3381 svc_label => ($svc_label || ''),
3382 locationnum => $cust_pkg->locationnum,
3384 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3387 } else { # $type eq 'U'
3389 warn "$me _items_cust_bill_pkg adding usage\n"
3392 if ( $cust_bill_pkg->hidden and defined($u) ) {
3393 # if this is a hidden package and there's already a usage
3394 # line for the bundle, add this package's total amount and
3395 # usage details to it
3396 $u->{amount} += $amount;
3397 push @{ $u->{ext_description} }, @d;
3398 } elsif ( $amount ) {
3399 # create a new usage line
3401 description => $description,
3402 pkgpart => $pkgpart,
3403 pkgnum => $cust_bill_pkg->pkgnum,
3406 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3408 ext_description => \@d,
3409 locationnum => $cust_pkg->locationnum,
3411 } # else this has no usage, so don't create a usage section
3414 } # recurring or usage with recurring charge
3416 } else { # taxes and fees
3418 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3421 # items of this kind should normally not have sdate/edate.
3423 'description' => $desc,
3424 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
3425 + $cust_bill_pkg->recur)
3428 } # if quotation / package line item / other line item
3430 # decide whether to show active discounts here
3432 # case 1: we are showing a single line for the package
3434 # case 2: we are showing a setup line for a package that has
3435 # no base recurring fee
3436 or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3437 # case 3: we are showing a recur line for a package that has
3438 # a base recurring fee
3439 or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3442 my $item_discount = $cust_bill_pkg->_item_discount;
3443 if ( $item_discount ) {
3444 # $item_discount->{amount} is negative
3446 if ( $d and $cust_bill_pkg->hidden ) {
3447 $d->{amount} += $item_discount->{amount};
3449 $d = $item_discount;
3450 $_ = &{$escape_function}($_) foreach @{ $d->{ext_description} };
3453 # update the active line (before the discount) to show the
3454 # original price (whether this is a hidden line or not)
3456 # quotation discounts keep track of setup and recur; invoice
3457 # discounts currently don't
3458 if ( exists $item_discount->{setup_amount} ) {
3460 $s->{amount} -= $item_discount->{setup_amount} if $s;
3461 $r->{amount} -= $item_discount->{recur_amount} if $r;
3465 # $active_line is the line item hashref for the line that will
3466 # show the original price
3467 # (use the recur or single line for the package, unless we're
3468 # showing a setup line for a package with no recurring fee)
3469 my $active_line = $r;
3470 if ( $type eq 'S' ) {
3473 $active_line->{amount} -= $item_discount->{amount};
3477 } # if there are any discounts
3478 } # if this is an appropriate place to show discounts
3480 } # foreach $display
3482 $discount_show_always = ($cust_bill_pkg->cust_bill_pkg_discount
3483 && $conf->exists('discount-show-always'));
3487 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3489 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3490 if exists($_->{amount});
3491 $_->{amount} =~ s/^\-0\.00$/0.00/;
3492 if (exists($_->{unit_amount})) {
3493 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3497 if $_->{amount} != 0
3498 || $discount_show_always
3499 || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3500 || ( $_->{_is_setup} && $_->{setup_show_zero} )
3504 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3511 =item _items_discounts_avail
3513 Returns an array of line item hashrefs representing available term discounts
3514 for this invoice. This makes the same assumptions that apply to term
3515 discounts in general: that the package is billed monthly, at a flat rate,
3516 with no usage charges. A prorated first month will be handled, as will
3517 a setup fee if the discount is allowed to apply to setup fees.
3521 sub _items_discounts_avail {
3524 #maybe move this method from cust_bill when quotations support discount_plans
3525 return () unless $self->can('discount_plans');
3526 my %plans = $self->discount_plans;
3528 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3529 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3533 my $plan = $plans{$months};
3535 my $term_total = sprintf('%.2f', $plan->discounted_total);
3536 my $percent = sprintf('%.0f',
3537 100 * (1 - $term_total / $plan->base_total) );
3538 my $permonth = sprintf('%.2f', $term_total / $months);
3539 my $detail = $self->mt('discount on item'). ' '.
3540 join(', ', map { "#$_" } $plan->pkgnums)
3543 # discounts for non-integer months don't work anyway
3544 $months = sprintf("%d", $months);
3547 description => $self->mt('Save [_1]% by paying for [_2] months',
3549 amount => $self->mt('[_1] ([_2] per month)',
3550 $term_total, $money_char.$permonth),
3551 ext_description => ($detail || ''),
3554 sort { $b <=> $a } keys %plans;