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); #can't import first, it conflicts with cust_main.first
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;
320 my $locale = $params{'locale'} || $cust_main->locale;
322 my %delimiters = ( 'latex' => [ '[@--', '--@]' ],
323 'html' => [ '<%=', '%>' ],
324 'template' => [ '{', '}' ],
327 warn "$me print_generic creating template\n"
330 # set the notice name here, and nowhere else.
331 my $notice_name = $params{notice_name}
332 || $conf->config('notice_name')
333 || $self->notice_name;
336 my $template = $params{template} ? $params{template} : $self->_agent_template;
337 my $templatefile = $self->template_conf. $format;
338 $templatefile .= "_$template"
339 if length($template) && $conf->exists($templatefile."_$template");
342 my @invoice_template = map "$_\n", $conf->config($templatefile)
343 or die "cannot load config data $templatefile";
345 if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
346 #change this to a die when the old code is removed
347 # it's been almost ten years, changing it to a die
348 die "old-style invoice template $templatefile; ".
349 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
350 #$old_latex = 'true';
351 #@invoice_template = _translate_old_latex_format(@invoice_template);
354 warn "$me print_generic creating T:T object\n"
357 my $text_template = new Text::Template(
359 SOURCE => \@invoice_template,
360 DELIMITERS => $delimiters{$format},
363 warn "$me print_generic compiling T:T object\n"
366 $text_template->compile()
367 or die "Can't compile $templatefile: $Text::Template::ERROR\n";
370 # additional substitution could possibly cause breakage in existing templates
373 'notes' => sub { map "$_", @_ },
374 'footer' => sub { map "$_", @_ },
375 'smallfooter' => sub { map "$_", @_ },
376 'returnaddress' => sub { map "$_", @_ },
377 'coupon' => sub { map "$_", @_ },
378 'summary' => sub { map "$_", @_ },
384 s/%%(.*)$/<!-- $1 -->/g;
385 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
386 s/\\begin\{enumerate\}/<ol>/g;
388 s/\\end\{enumerate\}/<\/ol>/g;
389 s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
398 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
400 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
406 s/\\hyphenation\{[\w\s\-]+}//;
411 'coupon' => sub { "" },
412 'summary' => sub { "" },
419 s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
420 s/\\begin\{enumerate\}//g;
422 s/\\end\{enumerate\}//g;
423 s/\\textbf\{(.*)\}/$1/g;
430 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
432 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
437 s/\\\\\*?\s*$/\n/; # dubious
438 s/\\hyphenation\{[\w\s\-]+}//;
442 'coupon' => sub { "" },
443 'summary' => sub { "" },
448 # hashes for differing output formats
449 my %nbsps = ( 'latex' => '~',
450 'html' => '', # '&nbps;' would be nice
451 'template' => '', # not used
453 my $nbsp = $nbsps{$format};
455 my %escape_functions = ( 'latex' => \&_latex_escape,
456 'html' => \&_html_escape_nbsp,#\&encode_entities,
457 'template' => sub { shift },
459 my $escape_function = $escape_functions{$format};
460 my $escape_function_nonbsp = ($format eq 'html')
461 ? \&_html_escape : $escape_function;
463 my %newline_tokens = ( 'latex' => '\\\\',
467 my $newline_token = $newline_tokens{$format};
469 warn "$me generating template variables\n"
472 # generate template variables
476 defined( $conf->config_orbase( "invoice_${format}returnaddress",
480 && length( $conf->config_orbase( "invoice_${format}returnaddress",
486 $returnaddress = join("\n",
487 $conf->config_orbase("invoice_${format}returnaddress", $template)
491 $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
493 my $convert_map = $convert_maps{$format}{'returnaddress'};
496 &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
501 } elsif ( grep /\S/, $conf->config('company_address', $cust_main->agentnum) ) {
503 my $convert_map = $convert_maps{$format}{'returnaddress'};
504 $returnaddress = join( "\n", &$convert_map(
505 map { s/( {2,})/'~' x length($1)/eg;
509 ( $conf->config('company_name', $cust_main->agentnum),
510 $conf->config('company_address', $cust_main->agentnum),
517 my $warning = "Couldn't find a return address; ".
518 "do you need to set the company_address configuration value?";
520 $returnaddress = $nbsp;
521 #$returnaddress = $warning;
525 warn "$me generating invoice data\n"
528 my $agentnum = $cust_main->agentnum;
533 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
534 'company_address' => join("\n", $conf->config('company_address', $agentnum) ). "\n",
535 'company_phonenum'=> scalar( $conf->config('company_phonenum', $agentnum) ),
536 'returnaddress' => $returnaddress,
537 'agent' => &$escape_function($cust_main->agent->agent),
539 #invoice/quotation info
540 'no_number' => $params{'no_number'},
541 'invnum' => ( $params{'no_number'} ? '' : $self->invnum ),
542 'quotationnum' => $self->quotationnum,
543 'no_date' => $params{'no_date'},
544 '_date' => ( $params{'no_date'} ? '' : $self->_date ),
545 # workaround for inconsistent behavior in the early plain text
546 # templates; see RT#28271
547 'date' => ( $params{'no_date'}
549 : ($format eq 'template'
551 : $self->time2str_local('long', $self->_date, $format)
554 'today' => $self->time2str_local('long', $today, $format),
555 'terms' => $self->terms,
556 'template' => $template, #params{'template'},
557 'notice_name' => $notice_name, # escape?
558 'current_charges' => sprintf("%.2f", $self->charged),
559 'duedate' => $self->due_date2str('rdate'), #date_format?
562 'custnum' => $cust_main->display_custnum,
563 'prospectnum' => $cust_main->prospectnum,
564 'agent_custid' => &$escape_function($cust_main->agent_custid),
565 ( map { $_ => &$escape_function($cust_main->$_()) }
566 qw( company address1 address2 city state zip fax )
568 'payname' => &$escape_function( $cust_main->invoice_attn
569 || $cust_main->contact_firstlast ),
572 'ship_enable' => $conf->exists('invoice-ship_address'),
573 'unitprices' => $conf->exists('invoice-unitprice'),
574 'smallernotes' => $conf->exists('invoice-smallernotes'),
575 'smallerfooter' => $conf->exists('invoice-smallerfooter'),
576 'balance_due_below_line' => $conf->exists('balance_due_below_line'),
578 #layout info -- would be fancy to calc some of this and bury the template
580 'topmargin' => scalar($conf->config('invoice_latextopmargin', $agentnum)),
581 'headsep' => scalar($conf->config('invoice_latexheadsep', $agentnum)),
582 'textheight' => scalar($conf->config('invoice_latextextheight', $agentnum)),
583 'extracouponspace' => scalar($conf->config('invoice_latexextracouponspace', $agentnum)),
584 'couponfootsep' => scalar($conf->config('invoice_latexcouponfootsep', $agentnum)),
585 'verticalreturnaddress' => $conf->exists('invoice_latexverticalreturnaddress', $agentnum),
586 'addresssep' => scalar($conf->config('invoice_latexaddresssep', $agentnum)),
587 'amountenclosedsep' => scalar($conf->config('invoice_latexcouponamountenclosedsep', $agentnum)),
588 'coupontoaddresssep' => scalar($conf->config('invoice_latexcoupontoaddresssep', $agentnum)),
589 'addcompanytoaddress' => $conf->exists('invoice_latexcouponaddcompanytoaddress', $agentnum),
591 # better hang on to conf_dir for a while (for old templates)
592 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
594 #these are only used when doing paged plaintext
601 $invoice_data{'emt'} = sub { &$escape_function($self->mt(@_)) };
602 # prototype here to silence warnings
603 $invoice_data{'time2str'} = sub ($;$$) { $self->time2str_local(@_, $format) };
605 my $min_sdate = 999999999999;
607 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
608 next unless $cust_bill_pkg->pkgnum > 0;
609 $min_sdate = $cust_bill_pkg->sdate
610 if length($cust_bill_pkg->sdate) && $cust_bill_pkg->sdate < $min_sdate;
611 $max_edate = $cust_bill_pkg->edate
612 if length($cust_bill_pkg->edate) && $cust_bill_pkg->edate > $max_edate;
615 $invoice_data{'bill_period'} = '';
616 $invoice_data{'bill_period'} =
617 $self->time2str_local('%e %h', $min_sdate, $format)
619 $self->time2str_local('%e %h', $max_edate, $format)
620 if ($max_edate != 0 && $min_sdate != 999999999999);
622 $invoice_data{finance_section} = '';
623 if ( $conf->config('finance_pkgclass') ) {
625 qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
626 $invoice_data{finance_section} = $pkg_class->categoryname;
628 $invoice_data{finance_amount} = '0.00';
629 $invoice_data{finance_section} ||= 'Finance Charges'; #avoid config confusion
631 my $countrydefault = $conf->config('countrydefault') || 'US';
632 foreach ( qw( address1 address2 city state zip country fax) ){
633 my $method = 'ship_'.$_;
634 $invoice_data{"ship_$_"} = $escape_function->($cust_main->$method);
636 if ( length($cust_main->ship_company) ) {
637 $invoice_data{'ship_company'} = $escape_function->($cust_main->ship_company);
639 $invoice_data{'ship_company'} = $escape_function->($cust_main->company);
641 $invoice_data{'ship_contact'} = $escape_function->($cust_main->contact);
642 $invoice_data{'ship_country'} = ''
643 if ( $invoice_data{'ship_country'} eq $countrydefault );
645 $invoice_data{'cid'} = $params{'cid'}
648 if ( $cust_main->country eq $countrydefault ) {
649 $invoice_data{'country'} = '';
651 $invoice_data{'country'} = &$escape_function(code2country($cust_main->country));
655 $invoice_data{'address'} = \@address;
657 $invoice_data{'payname'}.
658 ( $cust_main->po_number
659 ? " (P.O. #". $cust_main->po_number. ")"
663 push @address, $cust_main->company
664 if $cust_main->company;
665 push @address, $cust_main->address1;
666 push @address, $cust_main->address2
667 if $cust_main->address2;
669 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
670 push @address, $invoice_data{'country'}
671 if $invoice_data{'country'};
673 while (scalar(@address) < 5);
675 $invoice_data{'logo_file'} = $params{'logo_file'}
676 if $params{'logo_file'};
677 $invoice_data{'barcode_file'} = $params{'barcode_file'}
678 if $params{'barcode_file'};
679 $invoice_data{'barcode_img'} = $params{'barcode_img'}
680 if $params{'barcode_img'};
681 $invoice_data{'barcode_cid'} = $params{'barcode_cid'}
682 if $params{'barcode_cid'};
684 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
685 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
686 #my $balance_due = $self->owed + $pr_total - $cr_total;
687 my $balance_due = $self->owed + $pr_total;
689 # the sum of amount owed on all invoices
690 # (this is used in the summary & on the payment coupon)
691 $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
693 # flag telling this invoice to have a first-page summary
694 my $summarypage = '';
696 if ( $self->custnum && $self->invnum ) {
697 # XXX should be an FS::cust_bill method to set the defaults, instead
698 # of checking the type here
700 my $last_bill = $self->previous_bill;
703 # "balance_date_range" unfortunately is unsuitable for this, since it
704 # cares about application dates. We want to know the sum of all
705 # _top-level transactions_ dated before the last invoice.
707 map "$_ WHERE _date <= ? AND custnum = ?", (
708 "SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill",
709 "SELECT -1 * COALESCE( SUM(amount), 0 ) FROM cust_credit",
710 "SELECT -1 * COALESCE( SUM(paid), 0 ) FROM cust_pay",
711 "SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund",
714 # the customer's current balance immediately after generating the last
717 my $last_bill_balance = $last_bill->charged;
719 my $delta = FS::Record->scalar_sql(
721 $last_bill->_date - 1,
724 $last_bill_balance += $delta;
727 $last_bill_balance = sprintf("%.2f", $last_bill_balance);
729 warn sprintf("LAST BILL: INVNUM %d, DATE %s, BALANCE %.2f\n\n",
731 $self->time2str_local('%D', $last_bill->_date),
734 # ("true_previous_balance" is a terrible name, but at least it's no
735 # longer stored in the database)
736 $invoice_data{'true_previous_balance'} = $last_bill_balance;
738 # the change in balance from immediately after that invoice
739 # to immediately before this one
740 my $before_this_bill_balance = 0;
742 my $delta = FS::Record->scalar_sql(
747 $before_this_bill_balance += $delta;
749 $invoice_data{'balance_adjustments'} =
750 sprintf("%.2f", $last_bill_balance - $before_this_bill_balance);
752 warn sprintf("BALANCE ADJUSTMENTS: %.2f\n\n",
753 $invoice_data{'balance_adjustments'}
756 # the sum of amount owed on all previous invoices
757 # ($pr_total is used elsewhere but not as $previous_balance)
758 $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
760 $invoice_data{'last_bill'} = {
761 '_date' => $last_bill->_date, #unformatted
763 my (@payments, @credits);
764 # for formats that itemize previous payments
765 foreach my $cust_pay ( qsearch('cust_pay', {
766 'custnum' => $self->custnum,
767 '_date' => { op => '>=',
768 value => $last_bill->_date }
771 next if $cust_pay->_date > $self->_date;
773 '_date' => $cust_pay->_date,
774 'date' => $self->time2str_local('long', $cust_pay->_date, $format),
775 'payinfo' => $cust_pay->payby_payinfo_pretty,
776 'amount' => sprintf('%.2f', $cust_pay->paid),
778 # not concerned about applications
780 foreach my $cust_credit ( qsearch('cust_credit', {
781 'custnum' => $self->custnum,
782 '_date' => { op => '>=',
783 value => $last_bill->_date }
786 next if $cust_credit->_date > $self->_date;
788 '_date' => $cust_credit->_date,
789 'date' => $self->time2str_local('long', $cust_credit->_date, $format),
790 'creditreason'=> $cust_credit->reason,
791 'amount' => sprintf('%.2f', $cust_credit->amount),
794 $invoice_data{'previous_payments'} = \@payments;
795 $invoice_data{'previous_credits'} = \@credits;
797 # there is no $last_bill
798 $invoice_data{'true_previous_balance'} =
799 $invoice_data{'balance_adjustments'} =
800 $invoice_data{'previous_balance'} = '0.00';
801 $invoice_data{'previous_payments'} = [];
802 $invoice_data{'previous_credits'} = [];
805 # info from customer's last invoice before this one, for some
807 $invoice_data{'last_bill'} = {};
809 if ( $conf->exists('invoice_usesummary', $agentnum) ) {
810 $invoice_data{'summarypage'} = $summarypage = 1;
813 } # if this is an invoice
815 warn "$me substituting variables in notes, footer, smallfooter\n"
818 my $tc = $self->template_conf;
819 my @include = ( [ $tc, 'notes' ],
820 [ 'invoice_', 'footer' ],
821 [ 'invoice_', 'smallfooter', ],
823 push @include, [ $tc, 'coupon', ]
824 unless $params{'no_coupon'};
826 foreach my $i (@include) {
828 my($base, $include) = @$i;
830 my $inc_file = $conf->key_orbase("$base$format$include", $template);
833 if ( $conf->exists($inc_file, $agentnum)
834 && length( $conf->config($inc_file, $agentnum) ) ) {
836 @inc_src = $conf->config($inc_file, $agentnum);
840 $inc_file = $conf->key_orbase("${base}latex$include", $template);
842 my $convert_map = $convert_maps{$format}{$include};
844 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
845 s/--\@\]/$delimiters{$format}[1]/g;
848 &$convert_map( $conf->config($inc_file, $agentnum) );
852 my $inc_tt = new Text::Template (
854 SOURCE => [ map "$_\n", @inc_src ],
855 DELIMITERS => $delimiters{$format},
856 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
858 unless ( $inc_tt->compile() ) {
859 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
860 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
864 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
866 $invoice_data{$include} =~ s/\n+$//
867 if ($format eq 'latex');
870 # let invoices use either of these as needed
871 $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
872 ? $cust_main->payinfo : '';
873 $invoice_data{'po_line'} =
874 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
875 ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
878 my %money_chars = ( 'latex' => '',
879 'html' => $conf->config('money_char') || '$',
882 my $money_char = $money_chars{$format};
885 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
886 'html' => $conf->config('money_char') || '$',
889 my $other_money_char = $other_money_chars{$format};
890 $invoice_data{'dollar'} = $other_money_char;
892 my %minus_signs = ( 'latex' => '$-$',
894 'template' => '- ' );
895 my $minus = $minus_signs{$format};
897 my @detail_items = ();
898 my @total_items = ();
902 $invoice_data{'detail_items'} = \@detail_items;
903 $invoice_data{'total_items'} = \@total_items;
904 $invoice_data{'buf'} = \@buf;
905 $invoice_data{'sections'} = \@sections;
907 warn "$me generating sections\n"
910 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
911 my $multisection = $conf->exists($tc.'sections', $cust_main->agentnum) ||
912 $conf->exists($tc.'sections_by_location', $cust_main->agentnum);
913 $invoice_data{'multisection'} = $multisection;
915 my $extra_sections = [];
916 my $extra_lines = ();
918 # default section ('Charges')
919 my $default_section = { 'description' => '',
924 # Previous Charges section
925 # subtotal is the first return value from $self->previous
926 my $previous_section;
927 # if the invoice has major sections, or if we're summarizing previous
928 # charges with a single line, or if we've been specifically told to put them
929 # in a section, create a section for previous charges:
930 if ( $multisection or
931 $conf->exists('previous_balance-summary_only') or
932 $conf->exists('previous_balance-section') ) {
934 $previous_section = { 'description' => $self->mt('Previous Charges'),
935 'subtotal' => $other_money_char.
936 sprintf('%.2f', $pr_total),
937 'summarized' => '', #why? $summarypage ? 'Y' : '',
939 $previous_section->{posttotal} = '0 / 30 / 60 / 90 days overdue '.
940 join(' / ', map { $cust_main->balance_date_range(@$_) }
941 $self->_prior_month30s
943 if $conf->exists('invoice_include_aging');
946 # otherwise put them in the main section
947 $previous_section = $default_section;
950 my $adjust_section = {
951 'description' => $self->mt('Credits, Payments, and Adjustments'),
952 'adjust_section' => 1,
953 'subtotal' => 0, # adjusted below
955 my $adjust_weight = _pkg_category($adjust_section->{description})
956 ? _pkg_category($adjust_section->{description})->weight
958 $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
959 # Note: 'sort_weight' here is actually a flag telling whether there is an
960 # explicit package category for the adjust section. If so, certain behavior
962 $adjust_section->{'sort_weight'} = $adjust_weight;
965 if ( $multisection ) {
966 ($extra_sections, $extra_lines) =
967 $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
968 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum)
969 && $self->can('_items_extra_usage_sections');
971 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
973 push @detail_items, @$extra_lines if $extra_lines;
975 # the code is written so that both methods can be used together, but
976 # we haven't yet changed the template to take advantage of that, so for
977 # now, treat them as mutually exclusive.
978 my %section_method = ( by_category => 1 );
979 if ( $conf->config($tc.'sections_method') eq 'location' ) {
980 %section_method = ( by_location => 1 );
983 $self->_items_sections( 'summary' => $summarypage,
984 'escape' => $escape_function_nonbsp,
985 'extra_sections' => $extra_sections,
989 push @sections, @$early;
990 $late_sections = $late;
992 if ( $conf->exists('svc_phone_sections')
993 && $self->can('_items_svc_phone_sections')
996 my ($phone_sections, $phone_lines) =
997 $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
998 push @{$late_sections}, @$phone_sections;
999 push @detail_items, @$phone_lines;
1001 if ( $conf->exists('voip-cust_accountcode_cdr')
1002 && $cust_main->accountcode_cdr
1003 && $self->can('_items_accountcode_cdr')
1006 my ($accountcode_section, $accountcode_lines) =
1007 $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
1008 if ( scalar(@$accountcode_lines) ) {
1009 push @{$late_sections}, $accountcode_section;
1010 push @detail_items, @$accountcode_lines;
1013 } else {# not multisection
1014 # make a default section
1015 push @sections, $default_section;
1016 # and calculate the finance charge total, since it won't get done otherwise.
1017 # and the default section total
1018 # XXX possibly finance_pkgclass should not be used in this manner?
1019 my @finance_charges;
1021 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1022 if ( $invoice_data{finance_section} and
1023 grep { $_->section eq $invoice_data{finance_section} }
1024 $cust_bill_pkg->cust_bill_pkg_display ) {
1025 # I think these are always setup fees, but just to be sure...
1026 push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1028 push @charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1031 $invoice_data{finance_amount} =
1032 sprintf('%.2f', sum( @finance_charges ) || 0);
1033 $default_section->{subtotal} = $other_money_char.
1034 sprintf('%.2f', sum( @charges ) || 0);
1037 # start setting up summary subtotals
1038 my @summary_subtotals;
1039 my $method = $conf->config('summary_subtotals_method');
1040 if ( $method and $method ne $conf->config($tc.'sections_method') ) {
1041 # then re-section them by the correct method
1042 my %section_method = ( by_category => 1 );
1043 if ( $conf->config('summary_subtotals_method') eq 'location' ) {
1044 %section_method = ( by_location => 1 );
1046 my ($early, $late) =
1047 $self->_items_sections( 'summary' => $summarypage,
1048 'escape' => $escape_function_nonbsp,
1049 'extra_sections' => $extra_sections,
1050 'format' => $format,
1053 foreach ( @$early ) {
1054 next if $_->{subtotal} == 0;
1055 $_->{subtotal} = $other_money_char.sprintf('%.2f', $_->{subtotal});
1056 push @summary_subtotals, $_;
1059 # subtotal sectioning is the same as for the actual invoice sections
1060 @summary_subtotals = @sections;
1063 # Hereafter, push sections to both @sections and @summary_subtotals
1064 # if they belong in both places (e.g. tax section). Late sections are
1065 # never in @summary_subtotals.
1067 # previous invoice balances in the Previous Charges section if there
1068 # is one, otherwise in the main detail section
1069 # (except if summary_only is enabled, don't show them at all)
1070 if ( $self->can('_items_previous') &&
1071 $self->enable_previous &&
1072 ! $conf->exists('previous_balance-summary_only') ) {
1074 warn "$me adding previous balances\n"
1077 foreach my $line_item ( $self->_items_previous ) {
1080 ref => $line_item->{'pkgnum'},
1081 pkgpart => $line_item->{'pkgpart'},
1082 #quantity => 1, # not really correct
1083 section => $previous_section, # which might be $default_section
1084 description => &$escape_function($line_item->{'description'}),
1085 ext_description => [ map { &$escape_function($_) }
1086 @{ $line_item->{'ext_description'} || [] }
1088 amount => $money_char . $line_item->{'amount'},
1089 product_code => $line_item->{'pkgpart'} || 'N/A',
1092 push @detail_items, $detail;
1093 push @buf, [ $detail->{'description'},
1094 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1100 if ( @pr_cust_bill && $self->enable_previous ) {
1101 push @buf, ['','-----------'];
1102 push @buf, [ $self->mt('Total Previous Balance'),
1103 $money_char. sprintf("%10.2f", $pr_total) ];
1107 if ( $conf->exists('svc_phone-did-summary') && $self->can('_did_summary') ) {
1108 warn "$me adding DID summary\n"
1111 my ($didsummary,$minutes) = $self->_did_summary;
1112 my $didsummary_desc = 'DID Activity Summary (since last invoice)';
1114 { 'description' => $didsummary_desc,
1115 'ext_description' => [ $didsummary, $minutes ],
1119 foreach my $section (@sections, @$late_sections) {
1121 # begin some normalization
1122 $section->{'subtotal'} = $section->{'amount'}
1124 && !exists($section->{subtotal})
1125 && exists($section->{amount});
1127 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
1128 if ( $invoice_data{finance_section} &&
1129 $section->{'description'} eq $invoice_data{finance_section} );
1131 $section->{'subtotal'} = $other_money_char.
1132 sprintf('%.2f', $section->{'subtotal'})
1135 # continue some normalization
1136 $section->{'amount'} = $section->{'subtotal'}
1140 if ( $section->{'description'} ) {
1141 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
1146 warn "$me setting options\n"
1150 $options{'section'} = $section if $multisection;
1151 $options{'format'} = $format;
1152 $options{'escape_function'} = $escape_function;
1153 $options{'no_usage'} = 1 unless $unsquelched;
1154 $options{'unsquelched'} = $unsquelched;
1155 $options{'summary_page'} = $summarypage;
1156 $options{'skip_usage'} =
1157 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
1158 $options{'preref_callback'} = $params{'preref_callback'};
1160 warn "$me searching for line items\n"
1163 foreach my $line_item ( $self->_items_pkg(%options),
1164 $self->_items_fee(%options) ) {
1166 warn "$me adding line item ".
1167 join(', ', map "$_=>".$line_item->{$_}, keys %$line_item). "\n"
1170 push @buf, ( [ $line_item->{'description'},
1171 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1173 map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}},
1176 $line_item->{'ref'} = $line_item->{'pkgnum'};
1177 $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()?
1178 $line_item->{'section'} = $section;
1179 $line_item->{'description'} = &$escape_function($line_item->{'description'});
1180 $line_item->{'amount'} = $money_char.$line_item->{'amount'};
1182 if ( length($line_item->{'unit_amount'}) ) {
1183 $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'};
1185 $line_item->{'ext_description'} ||= [];
1187 push @detail_items, $line_item;
1190 if ( $section->{'description'} ) {
1191 push @buf, ( ['','-----------'],
1192 [ $section->{'description'}. ' sub-total',
1193 $section->{'subtotal'} # already formatted this
1202 $invoice_data{current_less_finance} =
1203 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
1205 # if there's anything in the Previous Charges section, prepend it to the list
1206 if ( $pr_total and $previous_section ne $default_section ) {
1207 unshift @sections, $previous_section;
1208 # but not @summary_subtotals
1211 warn "$me adding taxes\n"
1214 # create a tax section if we don't yet have one
1215 my $tax_description = 'Taxes, Surcharges, and Fees';
1217 List::Util::first { $_->{description} eq $tax_description } @sections;
1218 if (!$tax_section) {
1219 $tax_section = { 'description' => $tax_description };
1220 push @sections, $tax_section if $multisection;
1222 $tax_section->{tax_section} = 1; # mark this section as containing taxes
1223 # if this is an existing tax section, we're merging the tax items into it.
1224 # grab the taxtotal that's already there, strip the money symbol if any
1225 my $taxtotal = $tax_section->{'subtotal'} || 0;
1226 $taxtotal =~ s/^\Q$other_money_char\E//;
1229 #my $tax_weight = _pkg_category($tax_section->{description})
1230 # ? _pkg_category($tax_section->{description})->weight
1232 #$tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
1233 #$tax_section->{'sort_weight'} = $tax_weight;
1235 my @items_tax = $self->_items_tax;
1236 foreach my $tax ( @items_tax ) {
1238 $taxtotal += $tax->{'amount'};
1240 my $description = &$escape_function( $tax->{'description'} );
1241 my $amount = sprintf( '%.2f', $tax->{'amount'} );
1243 if ( $multisection ) {
1245 push @detail_items, {
1246 ext_description => [],
1249 description => $description,
1250 amount => $money_char. $amount,
1252 section => $tax_section,
1257 push @total_items, {
1258 'total_item' => $description,
1259 'total_amount' => $other_money_char. $amount,
1264 push @buf,[ $description,
1265 $money_char. $amount,
1272 $total->{'total_item'} = $self->mt('Sub-total');
1273 $total->{'total_amount'} =
1274 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
1276 if ( $multisection ) {
1277 if ( $taxtotal > 0 ) {
1278 $tax_section->{'subtotal'} = $other_money_char.
1279 sprintf('%.2f', $taxtotal);
1280 $tax_section->{'pretotal'} = 'New charges sub-total '.
1281 $total->{'total_amount'};
1282 $tax_section->{'description'} = $self->mt($tax_description);
1284 # append it if it's not already there
1285 if ( !grep $tax_section, @sections ) {
1286 push @sections, $tax_section;
1287 push @summary_subtotals, $tax_section;
1292 unshift @total_items, $total;
1295 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1297 push @buf,['','-----------'];
1298 push @buf,[$self->mt(
1299 (!$self->enable_previous)
1301 : 'Total New Charges'
1303 $money_char. sprintf("%10.2f",$self->charged) ];
1310 my %embolden_functions = (
1311 'latex' => sub { return '\textbf{'. shift(). '}' },
1312 'html' => sub { return '<b>'. shift(). '</b>' },
1313 'template' => sub { shift },
1315 my $embolden_function = $embolden_functions{$format};
1317 if ( $self->can('_items_total') ) { # quotations
1319 $self->_items_total(\@total_items);
1321 foreach ( @total_items ) {
1322 $_->{'total_item'} = &$embolden_function( $_->{'total_item'} );
1323 $_->{'total_amount'} = &$embolden_function( $other_money_char.
1324 $_->{'total_amount'}
1328 } else { #normal invoice case
1330 # calculate total, possibly including total owed on previous
1334 $item = $conf->config('previous_balance-exclude_from_total')
1335 || 'Total New Charges'
1336 if $conf->exists('previous_balance-exclude_from_total');
1337 my $amount = $self->charged;
1338 if ( $self->enable_previous and !$conf->exists('previous_balance-exclude_from_total') ) {
1339 $amount += $pr_total;
1342 $total->{'total_item'} = &$embolden_function($self->mt($item));
1343 $total->{'total_amount'} =
1344 &$embolden_function( $other_money_char. sprintf( '%.2f', $amount ) );
1345 if ( $multisection ) {
1346 if ( $adjust_section->{'sort_weight'} ) {
1347 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1348 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1350 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1351 $other_money_char. sprintf('%.2f', $self->charged );
1354 push @total_items, $total;
1356 push @buf,['','-----------'];
1359 sprintf( '%10.2f', $amount )
1363 # if we're showing previous invoices, also show previous
1364 # credits and payments
1365 if ( $self->enable_previous
1366 and $self->can('_items_credits')
1367 and $self->can('_items_payments') )
1369 #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
1372 my $credittotal = 0;
1373 foreach my $credit (
1374 $self->_items_credits( 'template' => $template, 'trim_len' => 60 )
1378 $total->{'total_item'} = &$escape_function($credit->{'description'});
1379 $credittotal += $credit->{'amount'};
1380 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1381 if ( $multisection ) {
1382 push @detail_items, {
1383 ext_description => [],
1386 description => &$escape_function($credit->{'description'}),
1387 amount => $money_char . $credit->{'amount'},
1389 section => $adjust_section,
1392 push @total_items, $total;
1396 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1399 foreach my $credit (
1400 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1402 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1406 my $paymenttotal = 0;
1407 foreach my $payment (
1408 $self->_items_payments( 'template' => $template )
1411 $total->{'total_item'} = &$escape_function($payment->{'description'});
1412 $paymenttotal += $payment->{'amount'};
1413 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1414 if ( $multisection ) {
1415 push @detail_items, {
1416 ext_description => [],
1419 description => &$escape_function($payment->{'description'}),
1420 amount => $money_char . $payment->{'amount'},
1422 section => $adjust_section,
1425 push @total_items, $total;
1427 push @buf, [ $payment->{'description'},
1428 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1431 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1433 if ( $multisection ) {
1434 $adjust_section->{'subtotal'} = $other_money_char.
1435 sprintf('%.2f', $credittotal + $paymenttotal);
1437 #why this? because {sort_weight} forces the adjust_section to appear
1438 #in @extra_sections instead of @sections. obviously.
1439 push @sections, $adjust_section
1440 unless $adjust_section->{sort_weight};
1441 # do not summarize; adjustments there are shown according to
1445 # create Balance Due message
1448 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1449 $total->{'total_amount'} =
1450 &$embolden_function(
1451 $other_money_char. sprintf('%.2f', #why? $summarypage
1452 # ? $self->charged +
1453 # $self->billing_balance
1455 $self->owed + $pr_total
1458 if ( $multisection && !$adjust_section->{sort_weight} ) {
1459 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1460 $total->{'total_amount'};
1462 push @total_items, $total;
1464 push @buf,['','-----------'];
1465 push @buf,[$self->balance_due_msg, $money_char.
1466 sprintf("%10.2f", $balance_due ) ];
1469 if ( $conf->exists('previous_balance-show_credit')
1470 and $cust_main->balance < 0 ) {
1471 my $credit_total = {
1472 'total_item' => &$embolden_function($self->credit_balance_msg),
1473 'total_amount' => &$embolden_function(
1474 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1477 if ( $multisection ) {
1478 $adjust_section->{'posttotal'} .= $newline_token .
1479 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1482 push @total_items, $credit_total;
1484 push @buf,['','-----------'];
1485 push @buf,[$self->credit_balance_msg, $money_char.
1486 sprintf("%10.2f", -$cust_main->balance ) ];
1490 } #end of default total adding ! can('_items_total')
1492 if ( $multisection ) {
1493 if ( $conf->exists('svc_phone_sections')
1494 && $self->can('_items_svc_phone_sections')
1498 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1499 $total->{'total_amount'} =
1500 &$embolden_function(
1501 $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
1503 my $last_section = pop @sections;
1504 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1505 $total->{'total_amount'};
1506 push @sections, $last_section;
1508 push @sections, @$late_sections
1512 # make a discounts-available section, even without multisection
1513 if ( $conf->exists('discount-show_available')
1514 and my @discounts_avail = $self->_items_discounts_avail ) {
1515 my $discount_section = {
1516 'description' => $self->mt('Discounts Available'),
1521 push @sections, $discount_section; # do not summarize
1522 push @detail_items, map { +{
1523 'ref' => '', #should this be something else?
1524 'section' => $discount_section,
1525 'description' => &$escape_function( $_->{description} ),
1526 'amount' => $money_char . &$escape_function( $_->{amount} ),
1527 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1528 } } @discounts_avail;
1531 # not adding any more sections after this
1532 $invoice_data{summary_subtotals} = \@summary_subtotals;
1535 if ( $conf->exists('usage_class_summary')
1536 and $self->can('_items_usage_class_summary') ) {
1537 my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function);
1538 if ( @usage_subtotals ) {
1539 unshift @sections, $usage_subtotals[0]->{section}; # do not summarize
1540 unshift @detail_items, @usage_subtotals;
1544 # invoice history "section" (not really a section)
1545 # not to be included in any subtotals, completely independent of
1547 if ( $conf->exists('previous_invoice_history') ) {
1550 foreach my $cust_bill ( $cust_main->cust_bill ) {
1551 # XXX hardcoded format, and currently only 'charged'; add other fields
1552 # if they become necessary
1553 my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1554 $history{$date} ||= 0;
1555 $history{$date} += $cust_bill->charged;
1556 # just so we have a numeric sort key
1557 $monthorder{$date} ||= $cust_bill->_date;
1559 my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1561 my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1562 $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1565 # service locations: another option for template customization
1567 foreach my $item (@detail_items) {
1568 if ( $item->{locationnum} ) {
1569 $location_info{ $item->{locationnum} } ||= {
1570 FS::cust_location->by_key( $item->{locationnum} )->location_hash
1574 $invoice_data{location_info} = \%location_info;
1576 # debugging hook: call this with 'diag' => 1 to just get a hash of
1577 # the invoice variables
1578 return \%invoice_data if ( $params{'diag'} );
1580 # All sections and items are built; now fill in templates.
1581 my @includelist = ();
1582 push @includelist, 'summary' if $summarypage;
1583 foreach my $include ( @includelist ) {
1585 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1588 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1590 @inc_src = $conf->config($inc_file, $agentnum);
1594 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1596 my $convert_map = $convert_maps{$format}{$include};
1598 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1599 s/--\@\]/$delimiters{$format}[1]/g;
1602 &$convert_map( $conf->config($inc_file, $agentnum) );
1606 my $inc_tt = new Text::Template (
1608 SOURCE => [ map "$_\n", @inc_src ],
1609 DELIMITERS => $delimiters{$format},
1610 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1612 unless ( $inc_tt->compile() ) {
1613 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1614 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1618 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1620 $invoice_data{$include} =~ s/\n+$//
1621 if ($format eq 'latex');
1626 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1627 /invoice_lines\((\d*)\)/;
1628 $invoice_lines += $1 || scalar(@buf);
1631 die "no invoice_lines() functions in template?"
1632 if ( $format eq 'template' && !$wasfunc );
1634 if ($format eq 'template') {
1636 if ( $invoice_lines ) {
1637 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1638 $invoice_data{'total_pages'}++
1639 if scalar(@buf) % $invoice_lines;
1642 #setup subroutine for the template
1643 $invoice_data{invoice_lines} = sub {
1644 my $lines = shift || scalar(@buf);
1656 push @collect, split("\n",
1657 $text_template->fill_in( HASH => \%invoice_data )
1659 $invoice_data{'page'}++;
1661 map "$_\n", @collect;
1663 } else { # this is where we actually create the invoice
1665 warn "filling in template for invoice ". $self->invnum. "\n"
1667 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1670 $text_template->fill_in(HASH => \%invoice_data);
1674 sub notice_name { '('.shift->table.')'; }
1676 sub template_conf { 'invoice_'; }
1678 # helper routine for generating date ranges
1679 sub _prior_month30s {
1682 [ 1, 2592000 ], # 0-30 days ago
1683 [ 2592000, 5184000 ], # 30-60 days ago
1684 [ 5184000, 7776000 ], # 60-90 days ago
1685 [ 7776000, 0 ], # 90+ days ago
1688 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
1689 $_->[1] ? $self->_date - $_->[1] - 1 : '',
1694 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1696 Returns an postscript invoice, as a scalar.
1698 Options can be passed as a hashref (recommended) or as a list of time, template
1699 and then any key/value pairs for any other options.
1701 I<time> an optional value used to control the printing of overdue messages. The
1702 default is now. It isn't the date of the invoice; that's the `_date' field.
1703 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1704 L<Time::Local> and L<Date::Parse> for conversion functions.
1706 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1713 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1714 my $ps = generate_ps($file);
1716 unlink($barcodefile) if $barcodefile;
1721 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1723 Returns an PDF invoice, as a scalar.
1725 Options can be passed as a hashref (recommended) or as a list of time, template
1726 and then any key/value pairs for any other options.
1728 I<time> an optional value used to control the printing of overdue messages. The
1729 default is now. It isn't the date of the invoice; that's the `_date' field.
1730 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1731 L<Time::Local> and L<Date::Parse> for conversion functions.
1733 I<template>, if specified, is the name of a suffix for alternate invoices.
1735 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1742 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1743 my $pdf = generate_pdf($file);
1745 unlink($barcodefile) if $barcodefile;
1750 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1752 Returns an HTML invoice, as a scalar.
1754 I<time> an optional value used to control the printing of overdue messages. The
1755 default is now. It isn't the date of the invoice; that's the `_date' field.
1756 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1757 L<Time::Local> and L<Date::Parse> for conversion functions.
1759 I<template>, if specified, is the name of a suffix for alternate invoices.
1761 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1763 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1764 when emailing the invoice as part of a multipart/related MIME email.
1772 %params = %{ shift() };
1776 $params{'format'} = 'html';
1778 $self->print_generic( %params );
1781 # quick subroutine for print_latex
1783 # There are ten characters that LaTeX treats as special characters, which
1784 # means that they do not simply typeset themselves:
1785 # # $ % & ~ _ ^ \ { }
1787 # TeX ignores blanks following an escaped character; if you want a blank (as
1788 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1792 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1793 $value =~ s/([<>])/\$$1\$/g;
1799 encode_entities($value);
1803 sub _html_escape_nbsp {
1804 my $value = _html_escape(shift);
1805 $value =~ s/ +/ /g;
1809 #utility methods for print_*
1811 sub _translate_old_latex_format {
1812 warn "_translate_old_latex_format called\n"
1819 if ( $line =~ /^%%Detail\s*$/ ) {
1821 push @template, q![@--!,
1822 q! foreach my $_tr_line (@detail_items) {!,
1823 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1824 q! $_tr_line->{'description'} .= !,
1825 q! "\\tabularnewline\n~~".!,
1826 q! join( "\\tabularnewline\n~~",!,
1827 q! @{$_tr_line->{'ext_description'}}!,
1831 while ( ( my $line_item_line = shift )
1832 !~ /^%%EndDetail\s*$/ ) {
1833 $line_item_line =~ s/'/\\'/g; # nice LTS
1834 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1835 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1836 push @template, " \$OUT .= '$line_item_line';";
1839 push @template, '}',
1842 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1844 push @template, '[@--',
1845 ' foreach my $_tr_line (@total_items) {';
1847 while ( ( my $total_item_line = shift )
1848 !~ /^%%EndTotalDetails\s*$/ ) {
1849 $total_item_line =~ s/'/\\'/g; # nice LTS
1850 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1851 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1852 push @template, " \$OUT .= '$total_item_line';";
1855 push @template, '}',
1859 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1860 push @template, $line;
1866 warn "$_\n" foreach @template;
1878 my $conf = $self->conf;
1880 #check for an invoice-specific override
1881 return $self->invoice_terms if $self->invoice_terms;
1883 #check for a customer- specific override
1884 my $cust_main = $self->cust_main;
1885 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1889 $agentnum = $cust_main->agentnum;
1890 } elsif ( my $prospect_main = $self->prospect_main ) {
1891 $agentnum = $prospect_main->agentnum;
1894 #use configured default
1895 $conf->config('invoice_default_terms', $agentnum) || '';
1905 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1906 $duedate = $self->_date() + ( $1 * 86400 );
1917 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
1920 =item balance_due_msg
1924 sub balance_due_msg {
1926 my $msg = $self->mt('Balance Due');
1927 return $msg unless $self->terms;
1928 if ( $self->due_date ) {
1929 $msg .= ' - ' . $self->mt('Please pay by'). ' '.
1930 $self->due_date2str('short');
1931 } elsif ( $self->terms ) {
1932 $msg .= ' - '. $self->terms;
1937 =item balance_due_date
1941 sub balance_due_date {
1943 my $conf = $self->conf;
1945 my $terms = $self->terms;
1946 if ( $terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1947 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
1952 sub credit_balance_msg {
1954 $self->mt('Credit Balance Remaining')
1959 Returns a string with the date, for example: "3/20/2008", localized for the
1960 customer. Use _date_pretty_unlocalized for non-end-customer display use.
1966 $self->time2str_local('short', $self->_date);
1969 =item _date_pretty_unlocalized
1971 Returns a string with the date, for example: "3/20/2008", in the format
1972 configured for the back-office. Use _date_pretty for end-customer display use.
1976 sub _date_pretty_unlocalized {
1978 time2str($date_format, $self->_date);
1983 Emails this template.
1985 Options are passed as a hashref. Available options:
1991 If specified, overrides the default From: address.
1995 If specified, overrides the name of the sent document ("Invoice" or "Quotation")
1999 (Deprecated) If specified, is the name of a suffix for alternate template files.
2003 Options accepted by generate_email can also be used.
2009 my $opt = shift || {};
2010 if ($opt and !ref($opt)) {
2011 die ref($self). '->email called with positional parameters';
2014 return if $self->hide;
2016 my $error = send_email(
2017 $self->generate_email(
2018 'subject' => $self->email_subject($opt->{template}),
2019 %$opt, # template, etc.
2023 die "can't email: $error\n" if $error;
2026 =item generate_email OPTION => VALUE ...
2034 sender address, required
2038 alternate template name, optional
2042 email subject, optional
2046 notice name instead of "Invoice", optional
2050 Returns an argument list to be passed to L<FS::Misc::send_email>.
2056 sub generate_email {
2060 my $conf = $self->conf;
2062 my $me = '[FS::Template_Mixin::generate_email]';
2065 'from' => $args{'from'},
2066 'subject' => ($args{'subject'} || $self->email_subject),
2067 'custnum' => $self->custnum,
2068 'msgtype' => 'invoice',
2071 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
2073 my $cust_main = $self->cust_main;
2075 if (ref($args{'to'}) eq 'ARRAY') {
2076 $return{'to'} = $args{'to'};
2077 } elsif ( $cust_main ) {
2078 $return{'to'} = [ $cust_main->invoicing_list_emailonly ];
2081 my $tc = $self->template_conf;
2083 my @text; # array of lines
2084 my $html; # a big string
2085 my @related_parts; # will contain the text/HTML alternative, and images
2086 my $related; # will contain the multipart/related object
2088 if ( $conf->exists($tc. 'email_pdf') ) {
2089 if ( my $msgnum = $conf->config($tc.'email_pdf_msgnum') ) {
2091 warn "$me using '${tc}email_pdf_msgnum' in multipart message"
2094 my $msg_template = FS::msg_template->by_key($msgnum)
2095 or die "${tc}email_pdf_msgnum $msgnum not found\n";
2096 my %prepared = $msg_template->prepare(
2097 cust_main => $self->cust_main,
2101 @text = split(/(?=\n)/, $prepared{'text_body'});
2102 $html = $prepared{'html_body'};
2104 } elsif ( my @note = $conf->config($tc.'email_pdf_note') ) {
2106 warn "$me using '${tc}email_pdf_note' in multipart message"
2108 @text = $conf->config($tc.'email_pdf_note');
2109 $html = join('<BR>', @text);
2111 } # else use the plain text invoice
2116 warn "$me generating plain text invoice"
2119 # 'print_text' argument is no longer used
2120 @text = $self->print_text(\%args);
2124 my $text_part = build MIME::Entity (
2125 'Type' => 'text/plain',
2126 'Encoding' => 'quoted-printable',
2127 'Charset' => 'UTF-8',
2128 #'Encoding' => '7bit',
2130 'Disposition' => 'inline',
2135 if ( $conf->exists($tc.'html') ) {
2136 warn "$me generating HTML invoice"
2139 $args{'from'} =~ /\@([\w\.\-]+)/;
2140 my $from = $1 || 'example.com';
2141 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2144 my $agentnum = $cust_main ? $cust_main->agentnum
2145 : $self->prospect_main->agentnum;
2146 if ( defined($args{'template'}) && length($args{'template'})
2147 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
2150 $logo = 'logo_'. $args{'template'}. '.png';
2154 my $image_data = $conf->config_binary( $logo, $agentnum);
2156 push @related_parts, build MIME::Entity
2157 'Type' => 'image/png',
2158 'Encoding' => 'base64',
2159 'Data' => $image_data,
2160 'Filename' => 'logo.png',
2161 'Content-ID' => "<$content_id>",
2164 if ( ref($self) eq 'FS::cust_bill' && $conf->exists('invoice-barcode') ) {
2165 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2166 push @related_parts, build MIME::Entity
2167 'Type' => 'image/png',
2168 'Encoding' => 'base64',
2169 'Data' => $self->invoice_barcode(0),
2170 'Filename' => 'barcode.png',
2171 'Content-ID' => "<$barcode_content_id>",
2173 $args{'barcode_cid'} = $barcode_content_id;
2176 $html = $self->print_html({ 'cid'=>$content_id, %args });
2183 warn "$me creating HTML/text multipart message"
2186 $return{'nobody'} = 1;
2188 my $alternative = build MIME::Entity
2189 'Type' => 'multipart/alternative',
2190 #'Encoding' => '7bit',
2191 'Disposition' => 'inline'
2195 $alternative->add_part($text_part);
2198 $alternative->attach(
2199 'Type' => 'text/html',
2200 'Encoding' => 'quoted-printable',
2201 'Data' => [ '<html>',
2204 ' '. encode_entities($return{'subject'}),
2207 ' <body bgcolor="#e8e8e8">',
2212 'Disposition' => 'inline',
2213 #'Filename' => 'invoice.pdf',
2216 unshift @related_parts, $alternative;
2218 $related = build MIME::Entity 'Type' => 'multipart/related',
2219 'Encoding' => '7bit';
2221 #false laziness w/Misc::send_email
2222 $related->head->replace('Content-type',
2223 $related->mime_type.
2224 '; boundary="'. $related->head->multipart_boundary. '"'.
2225 '; type=multipart/alternative'
2228 $related->add_part($_) foreach @related_parts;
2232 my @otherparts = ();
2233 if ( ref($self) eq 'FS::cust_bill' && $cust_main->email_csv_cdr ) {
2235 push @otherparts, build MIME::Entity
2236 'Type' => 'text/csv',
2237 'Encoding' => '7bit',
2238 'Data' => [ map { "$_\n" }
2239 $self->call_details('prepend_billed_number' => 1)
2241 'Disposition' => 'attachment',
2242 'Filename' => 'usage-'. $self->invnum. '.csv',
2247 if ( $conf->exists($tc.'email_pdf') ) {
2252 # multipart/alternative
2258 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
2259 push @otherparts, $pdf;
2263 $return{'content-type'} = 'multipart/mixed'; # of the outer container
2265 $return{'mimeparts'} = [ $related, @otherparts ];
2266 $return{'type'} = 'multipart/related'; # of the first part
2268 $return{'mimeparts'} = [ $text_part, @otherparts ];
2269 $return{'type'} = 'text/plain';
2271 } elsif ( $html ) { # no PDF or CSV, strip the outer container
2272 $return{'mimeparts'} = \@related_parts;
2273 $return{'content-type'} = 'multipart/related';
2274 $return{'type'} = 'multipart/alternative';
2275 } else { # no HTML either
2276 $return{'body'} = \@text;
2277 $return{'content-type'} = 'text/plain';
2286 Returns a list suitable for passing to MIME::Entity->build(), representing
2287 this invoice as PDF attachment.
2294 'Type' => 'application/pdf',
2295 'Encoding' => 'base64',
2296 'Data' => [ $self->print_pdf(@_) ],
2297 'Disposition' => 'attachment',
2298 'Filename' => 'invoice-'. $self->invnum. '.pdf',
2302 =item _items_sections OPTIONS
2304 Generate section information for all items appearing on this invoice.
2305 This will only be called for multi-section invoices.
2307 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
2308 related display records (L<FS::cust_bill_pkg_display>) and organize
2309 them into two groups ("early" and "late" according to whether they come
2310 before or after the total), then into sections. A subtotal is calculated
2313 Section descriptions are returned in sort weight order. Each consists
2314 of a hash containing:
2316 description: the package category name, escaped
2317 subtotal: the total charges in that section
2318 tax_section: a flag indicating that the section contains only tax charges
2319 summarized: same as tax_section, for some reason
2320 sort_weight: the package category's sort weight
2322 If 'condense' is set on the display record, it also contains everything
2323 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
2324 coderefs to generate parts of the invoice. This is not advised.
2326 The method returns two arrayrefs, one of "early" sections and one of "late"
2329 OPTIONS may include:
2331 by_location: a flag to divide the invoice into sections by location.
2332 Each section hash will have a 'location' element containing a hashref of
2333 the location fields (see L<FS::cust_location>). The section description
2334 will be the location label, but the template can use any of the location
2335 fields to create a suitable label.
2337 by_category: a flag to divide the invoice into sections using display
2338 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
2339 behavior. Each section hash will have a 'category' element containing
2340 the section name from the display record (which probably equals the
2341 category name of the package, but may not in some cases).
2343 summary: a flag indicating that this is a summary-format invoice.
2344 Turning this on has the following effects:
2345 - Ignores display items with the 'summary' flag.
2346 - Places all sections in the "early" group even if they have post_total.
2347 - Creates sections for all non-disabled package categories, even if they
2348 have no charges on this invoice, as well as a section with no name.
2350 escape: an escape function to use for section titles.
2352 extra_sections: an arrayref of additional sections to return after the
2353 sorted list. If there are any of these, section subtotals exclude
2356 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
2357 passed through to C<_condense_section()>.
2361 use vars qw(%pkg_category_cache);
2362 sub _items_sections {
2366 my $escape = $opt{escape};
2367 my @extra_sections = @{ $opt{extra_sections} || [] };
2369 # $subtotal{$locationnum}{$categoryname} = amount.
2370 # if we're not using by_location, $locationnum is undef.
2371 # if we're not using by_category, you guessed it, $categoryname is undef.
2372 # if we're not using either one, we shouldn't be here in the first place...
2374 my %late_subtotal = ();
2377 # About tax items + multisection invoices:
2378 # If either invoice_*summary option is enabled, AND there is a
2379 # package category with the name of the tax, then there will be
2380 # a display record assigning the tax item to that category.
2382 # However, the taxes are always placed in the "Taxes, Surcharges,
2383 # and Fees" section regardless of that. The only effect of the
2384 # display record is to create a subtotal for the summary page.
2387 my $pkg_hash = $self->cust_pkg_hash;
2389 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2392 my $usage = $cust_bill_pkg->usage;
2395 if ( $opt{by_location} ) {
2396 if ( $cust_bill_pkg->pkgnum ) {
2397 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2402 $locationnum = undef;
2405 # as in _items_cust_pkg, if a line item has no display records,
2406 # cust_bill_pkg_display() returns a default record for it
2408 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2409 next if ( $display->summary && $opt{summary} );
2411 my $section = $display->section;
2412 my $type = $display->type;
2413 # Set $section = undef if we're sectioning by location and this
2414 # line item _has_ a location (i.e. isn't a fee).
2415 $section = undef if $locationnum;
2417 # set this flag if the section is not tax-only
2418 $not_tax{$locationnum}{$section} = 1
2419 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
2421 # there's actually a very important piece of logic buried in here:
2422 # incrementing $late_subtotal{$section} CREATES
2423 # $late_subtotal{$section}. keys(%late_subtotal) is later used
2424 # to define the list of late sections, and likewise keys(%subtotal).
2425 # When _items_cust_bill_pkg is called to generate line items for
2426 # real, it will be called with 'section' => $section for each
2428 if ( $display->post_total && !$opt{summary} ) {
2429 if (! $type || $type eq 'S') {
2430 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2431 if $cust_bill_pkg->setup != 0
2432 || $cust_bill_pkg->setup_show_zero;
2436 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
2437 if $cust_bill_pkg->recur != 0
2438 || $cust_bill_pkg->recur_show_zero;
2441 if ($type && $type eq 'R') {
2442 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2443 if $cust_bill_pkg->recur != 0
2444 || $cust_bill_pkg->recur_show_zero;
2447 if ($type && $type eq 'U') {
2448 $late_subtotal{$locationnum}{$section} += $usage
2449 unless scalar(@extra_sections);
2452 } else { # it's a pre-total (normal) section
2454 # skip tax items unless they're explicitly included in a section
2455 next if $cust_bill_pkg->pkgnum == 0 and
2456 ! $cust_bill_pkg->feepart and
2459 if ( $type eq 'S' ) {
2460 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2461 if $cust_bill_pkg->setup != 0
2462 || $cust_bill_pkg->setup_show_zero;
2463 } elsif ( $type eq 'R' ) {
2464 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2465 if $cust_bill_pkg->recur != 0
2466 || $cust_bill_pkg->recur_show_zero;
2467 } elsif ( $type eq 'U' ) {
2468 $subtotal{$locationnum}{$section} += $usage
2469 unless scalar(@extra_sections);
2470 } elsif ( !$type ) {
2471 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2472 + $cust_bill_pkg->recur;
2481 %pkg_category_cache = ();
2483 # summary invoices need subtotals for all non-disabled package categories,
2484 # even if they're zero
2485 # but currently assume that there are no location sections, or at least
2486 # that the summary page doesn't care about them
2487 if ( $opt{summary} ) {
2488 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2489 $subtotal{''}{$category->categoryname} ||= 0;
2491 $subtotal{''}{''} ||= 0;
2495 foreach my $post_total (0,1) {
2497 my $s = $post_total ? \%late_subtotal : \%subtotal;
2498 foreach my $locationnum (keys %$s) {
2499 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2501 'subtotal' => $s->{$locationnum}{$sectionname},
2502 'post_total' => $post_total,
2505 if ( $locationnum ) {
2506 $section->{'locationnum'} = $locationnum;
2507 my $location = FS::cust_location->by_key($locationnum);
2508 $section->{'description'} = &{ $escape }($location->location_label);
2509 # Better ideas? This will roughly group them by proximity,
2510 # which alpha sorting on any of the address fields won't.
2511 # Sorting by locationnum is meaningless.
2512 # We have to sort on _something_ or the order may change
2513 # randomly from one invoice to the next, which will confuse
2515 $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
2517 $section->{'location'} = {
2518 label_prefix => &{ $escape }($location->label_prefix),
2519 map { $_ => &{ $escape }($location->get($_)) }
2523 $section->{'category'} = $sectionname;
2524 $section->{'description'} = &{ $escape }($sectionname);
2525 if ( _pkg_category($sectionname) ) {
2526 $section->{'sort_weight'} = _pkg_category($sectionname)->weight;
2527 if ( _pkg_category($sectionname)->condense ) {
2528 $section = { %$section, $self->_condense_section($opt{format}) };
2532 if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
2533 # then it's a tax-only section
2534 $section->{'summarized'} = 'Y';
2535 $section->{'tax_section'} = 'Y';
2537 push @these, $section;
2538 } # foreach $sectionname
2539 } #foreach $locationnum
2540 push @these, @extra_sections if $post_total == 0;
2541 # need an alpha sort for location sections, because postal codes can
2543 $sections[ $post_total ] = [ sort {
2544 $opt{'by_location'} ?
2545 ($a->{sort_weight} cmp $b->{sort_weight}) :
2546 ($a->{sort_weight} <=> $b->{sort_weight})
2548 } #foreach $post_total
2550 return @sections; # early, late
2553 #helper subs for above
2557 $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2561 my $categoryname = shift;
2562 $pkg_category_cache{$categoryname} ||=
2563 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2566 my %condensed_format = (
2567 'label' => [ qw( Description Qty Amount ) ],
2569 sub { shift->{description} },
2570 sub { shift->{quantity} },
2571 sub { my($href, %opt) = @_;
2572 ($opt{dollar} || ''). $href->{amount};
2575 'align' => [ qw( l r r ) ],
2576 'span' => [ qw( 5 1 1 ) ], # unitprices?
2577 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
2580 sub _condense_section {
2581 my ( $self, $format ) = ( shift, shift );
2583 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2584 qw( description_generator
2587 total_line_generator
2592 sub _condensed_generator_defaults {
2593 my ( $self, $format ) = ( shift, shift );
2594 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2603 sub _condensed_header_generator {
2604 my ( $self, $format ) = ( shift, shift );
2606 my ( $f, $prefix, $suffix, $separator, $column ) =
2607 _condensed_generator_defaults($format);
2609 if ($format eq 'latex') {
2610 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2611 $suffix = "\\\\\n\\hline";
2614 sub { my ($d,$a,$s,$w) = @_;
2615 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2617 } elsif ( $format eq 'html' ) {
2618 $prefix = '<th></th>';
2622 sub { my ($d,$a,$s,$w) = @_;
2623 return qq!<th align="$html_align{$a}">$d</th>!;
2631 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2633 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2636 $prefix. join($separator, @result). $suffix;
2641 sub _condensed_description_generator {
2642 my ( $self, $format ) = ( shift, shift );
2644 my ( $f, $prefix, $suffix, $separator, $column ) =
2645 _condensed_generator_defaults($format);
2647 my $money_char = '$';
2648 if ($format eq 'latex') {
2649 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2651 $separator = " & \n";
2653 sub { my ($d,$a,$s,$w) = @_;
2654 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2656 $money_char = '\\dollar';
2657 }elsif ( $format eq 'html' ) {
2658 $prefix = '"><td align="center"></td>';
2662 sub { my ($d,$a,$s,$w) = @_;
2663 return qq!<td align="$html_align{$a}">$d</td>!;
2665 #$money_char = $conf->config('money_char') || '$';
2666 $money_char = ''; # this is madness
2674 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2676 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2678 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2679 map { $f->{$_}->[$i] } qw(align span width)
2683 $prefix. join( $separator, @result ). $suffix;
2688 sub _condensed_total_generator {
2689 my ( $self, $format ) = ( shift, shift );
2691 my ( $f, $prefix, $suffix, $separator, $column ) =
2692 _condensed_generator_defaults($format);
2695 if ($format eq 'latex') {
2698 $separator = " & \n";
2700 sub { my ($d,$a,$s,$w) = @_;
2701 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2703 }elsif ( $format eq 'html' ) {
2707 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2709 sub { my ($d,$a,$s,$w) = @_;
2710 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2719 # my $r = &{$f->{fields}->[$i]}(@args);
2720 # $r .= ' Total' unless $i;
2722 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2724 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
2725 map { $f->{$_}->[$i] } qw(align span width)
2729 $prefix. join( $separator, @result ). $suffix;
2734 =item total_line_generator FORMAT
2736 Returns a coderef used for generation of invoice total line items for this
2737 usage_class. FORMAT is either html or latex
2741 # should not be used: will have issues with hash element names (description vs
2742 # total_item and amount vs total_amount -- another array of functions?
2744 sub _condensed_total_line_generator {
2745 my ( $self, $format ) = ( shift, shift );
2747 my ( $f, $prefix, $suffix, $separator, $column ) =
2748 _condensed_generator_defaults($format);
2751 if ($format eq 'latex') {
2754 $separator = " & \n";
2756 sub { my ($d,$a,$s,$w) = @_;
2757 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2759 }elsif ( $format eq 'html' ) {
2763 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2765 sub { my ($d,$a,$s,$w) = @_;
2766 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2775 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2777 &{$column}( &{$f->{fields}->[$i]}(@args),
2778 map { $f->{$_}->[$i] } qw(align span width)
2782 $prefix. join( $separator, @result ). $suffix;
2787 =item _items_pkg [ OPTIONS ]
2789 Return line item hashes for each package item on this invoice. Nearly
2792 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
2794 OPTIONS are passed through to _items_cust_bill_pkg, and should include
2795 'format' and 'escape_function' at minimum.
2797 To produce items for a specific invoice section, OPTIONS should include
2798 'section', a hashref containing 'category' and/or 'locationnum' keys.
2800 'section' may also contain a key named 'condensed'. If this is present
2801 and has a true value, _items_pkg will try to merge identical items into items
2802 with 'quantity' equal to the number of items (not the sum of their separate
2803 quantities, for some reason).
2809 # The order of these is important. Bundled line items will be merged into
2810 # the most recent non-hidden item, so it needs to be the one with:
2812 # - the same start date
2813 # - no pkgpart_override
2815 # So: sort by pkgnum,
2817 # then sort the base line item before any overrides
2818 # then sort hidden before non-hidden add-ons
2819 # then sort by override pkgpart (for consistency)
2820 sort { $a->pkgnum <=> $b->pkgnum or
2821 $a->sdate <=> $b->sdate or
2822 ($a->pkgpart_override ? 0 : -1) or
2823 ($b->pkgpart_override ? 0 : 1) or
2824 $b->hidden cmp $a->hidden or
2825 $a->pkgpart_override <=> $b->pkgpart_override
2827 # and of course exclude taxes and fees
2828 grep { $_->pkgnum > 0 } $self->cust_bill_pkg;
2834 my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
2835 my $escape_function = $options{escape_function};
2838 foreach my $cust_bill_pkg (@cust_bill_pkg) {
2839 # cache this, so we don't look it up again in every section
2840 my $part_fee = $cust_bill_pkg->get('part_fee')
2841 || $cust_bill_pkg->part_fee;
2842 $cust_bill_pkg->set('part_fee', $part_fee);
2844 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
2845 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
2848 if ( exists($options{section}) and exists($options{section}{category}) )
2850 my $categoryname = $options{section}{category};
2851 # then filter for items that have that section
2852 if ( $part_fee->categoryname ne $categoryname ) {
2853 warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
2856 } # otherwise include them all in the main section
2857 # XXX what to do when sectioning by location?
2860 my %base_invnums; # invnum => invoice date
2861 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
2862 if ($_->base_invnum) {
2863 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
2864 my $base_date = $self->time2str_local('short', $base_bill->_date)
2866 $base_invnums{$_->base_invnum} = $base_date || '';
2869 foreach (sort keys(%base_invnums)) {
2870 next if $_ == $self->invnum;
2871 # per convention, we must escape ext_description lines
2873 &{$escape_function}(
2874 $self->mt('from invoice #[_1] on [_2]', $_, $base_invnums{$_})
2877 my $desc = $part_fee->itemdesc_locale($self->cust_main->locale);
2878 # but not escape the base description line
2881 { feepart => $cust_bill_pkg->feepart,
2882 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
2883 description => $desc,
2884 ext_description => \@ext_desc
2895 warn "$me _items_pkg searching for all package line items\n"
2898 my @cust_bill_pkg = $self->_items_nontax;
2900 warn "$me _items_pkg filtering line items\n"
2902 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2904 if ($options{section} && $options{section}->{condensed}) {
2906 warn "$me _items_pkg condensing section\n"
2910 local $Storable::canonical = 1;
2911 foreach ( @items ) {
2913 delete $item->{ref};
2914 delete $item->{ext_description};
2915 my $key = freeze($item);
2916 $itemshash{$key} ||= 0;
2917 $itemshash{$key} ++; # += $item->{quantity};
2919 @items = sort { $a->{description} cmp $b->{description} }
2920 map { my $i = thaw($_);
2921 $i->{quantity} = $itemshash{$_};
2923 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
2929 warn "$me _items_pkg returning ". scalar(@items). " items\n"
2936 return 0 unless $a->itemdesc cmp $b->itemdesc;
2937 return -1 if $b->itemdesc eq 'Tax';
2938 return 1 if $a->itemdesc eq 'Tax';
2939 return -1 if $b->itemdesc eq 'Other surcharges';
2940 return 1 if $a->itemdesc eq 'Other surcharges';
2941 $a->itemdesc cmp $b->itemdesc;
2946 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
2947 $self->cust_bill_pkg;
2948 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2950 if ( $self->conf->exists('always_show_tax') ) {
2951 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
2952 if (0 == grep { $_->{description} eq $itemdesc } @items) {
2954 { 'description' => $itemdesc,
2961 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
2963 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
2964 list of hashrefs describing the line items they generate on the invoice.
2966 OPTIONS may include:
2968 format: the invoice format.
2970 escape_function: the function used to escape strings.
2972 DEPRECATED? (expensive, mostly unused?)
2973 format_function: the function used to format CDRs.
2975 section: a hashref containing 'category' and/or 'locationnum'; if this
2976 is present, only returns line items that belong to that category and/or
2977 location (whichever is defined).
2979 multisection: a flag indicating that this is a multisection invoice,
2980 which does something complicated.
2982 preref_callback: coderef run for each line item, code should return HTML to be
2983 displayed before that line item (quotations only)
2985 Returns a list of hashrefs, each of which may contain:
2987 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
2988 ext_description, which is an arrayref of detail lines to show below
2993 sub _items_cust_bill_pkg {
2995 my $conf = $self->conf;
2996 my $cust_bill_pkgs = shift;
2999 my $format = $opt{format} || '';
3000 my $escape_function = $opt{escape_function} || sub { shift };
3001 my $format_function = $opt{format_function} || '';
3002 my $no_usage = $opt{no_usage} || '';
3003 my $unsquelched = $opt{unsquelched} || ''; #unused
3004 my ($section, $locationnum, $category);
3005 if ( $opt{section} ) {
3006 $category = $opt{section}->{category};
3007 $locationnum = $opt{section}->{locationnum};
3009 my $summary_page = $opt{summary_page} || ''; #unused
3010 my $multisection = defined($category) || defined($locationnum);
3011 my $discount_show_always = 0;
3013 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
3015 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
3016 # and location labels
3018 my @b = (); # accumulator for the line item hashes that we'll return
3019 my ($s, $r, $u, $d) = ( undef, undef, undef, undef );
3020 # the 'current' line item hashes for setup, recur, usage, discount
3021 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
3023 # if the current line item is waiting to go out, and the one we're about
3024 # to start is not bundled, then push out the current one and start a new
3026 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3027 if ( $_ && !$cust_bill_pkg->hidden ) {
3028 $_->{amount} = sprintf( "%.2f", $_->{amount} );
3029 $_->{amount} =~ s/^\-0\.00$/0.00/;
3030 if (exists($_->{unit_amount})) {
3031 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3034 if $_->{amount} != 0
3035 || $discount_show_always
3036 || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3037 || ( $_->{_is_setup} && $_->{setup_show_zero} )
3043 if ( $locationnum ) {
3044 # this is a location section; skip packages that aren't at this
3046 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
3047 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
3051 # Consider display records for this item to determine if it belongs
3052 # in this section. Note that if there are no display records, there
3053 # will be a default pseudo-record that includes all charge types
3054 # and has no section name.
3055 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
3056 ? $cust_bill_pkg->cust_bill_pkg_display
3057 : ( $cust_bill_pkg );
3059 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
3060 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
3063 if ( defined($category) ) {
3064 # then this is a package category section; process all display records
3065 # that belong to this section.
3066 @cust_bill_pkg_display = grep { $_->section eq $category }
3067 @cust_bill_pkg_display;
3069 # otherwise, process all display records that aren't usage summaries
3070 # (I don't think there should be usage summaries if you aren't using
3071 # category sections, but this is the historical behavior)
3072 @cust_bill_pkg_display = grep { !$_->summary }
3073 @cust_bill_pkg_display;
3076 my $classname = ''; # package class name, will fill in later
3078 foreach my $display (@cust_bill_pkg_display) {
3080 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
3081 $display->billpkgdisplaynum. "\n"
3084 my $type = $display->type;
3086 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
3087 $desc = substr($desc, 0, $maxlength). '...'
3088 if $format eq 'latex' && length($desc) > $maxlength;
3090 my %details_opt = ( 'format' => $format,
3091 'escape_function' => $escape_function,
3092 'format_function' => $format_function,
3093 'no_usage' => $opt{'no_usage'},
3096 if ( ref($cust_bill_pkg) eq 'FS::quotation_pkg' ) {
3098 warn "$me _items_cust_bill_pkg cust_bill_pkg is quotation_pkg\n"
3100 # quotation_pkgs are never fees, so don't worry about the case where
3101 # part_pkg is undefined
3103 # and I guess they're never bundled either?
3104 if ( $cust_bill_pkg->setup != 0 ) {
3105 my $description = $desc;
3106 $description .= ' Setup'
3107 if $cust_bill_pkg->recur != 0
3108 || $discount_show_always
3109 || $cust_bill_pkg->recur_show_zero;
3111 # keep it consistent, please
3113 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3114 'description' => $description,
3115 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
3116 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitsetup),
3117 'quantity' => $cust_bill_pkg->quantity,
3118 'preref_html' => ( $opt{preref_callback}
3119 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3124 if ( $cust_bill_pkg->recur != 0 ) {
3127 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3128 'description' => "$desc (". $cust_bill_pkg->part_pkg->freq_pretty.")",
3129 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
3130 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitrecur),
3131 'quantity' => $cust_bill_pkg->quantity,
3132 'preref_html' => ( $opt{preref_callback}
3133 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3139 } elsif ( $cust_bill_pkg->pkgnum > 0 ) {
3140 # a "normal" package line item (not a quotation, not a fee, not a tax)
3142 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
3145 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3146 my $part_pkg = $cust_pkg->part_pkg;
3148 # which pkgpart to show for display purposes?
3149 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
3151 # start/end dates for invoice formats that do nonstandard
3153 my %item_dates = ();
3154 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
3155 unless $part_pkg->option('disable_line_item_date_ranges',1);
3157 # not normally used, but pass this to the template anyway
3158 $classname = $part_pkg->classname;
3160 if ( (!$type || $type eq 'S')
3161 && ( $cust_bill_pkg->setup != 0
3162 || $cust_bill_pkg->setup_show_zero
3167 warn "$me _items_cust_bill_pkg adding setup\n"
3170 my $description = $desc;
3171 $description .= ' Setup'
3172 if $cust_bill_pkg->recur != 0
3173 || $discount_show_always
3174 || $cust_bill_pkg->recur_show_zero;
3176 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3178 if $part_pkg->is_prepaid #for prepaid, "display the validity period
3179 # triggered by the recurring charge freq
3181 && $cust_bill_pkg->recur == 0
3182 && ! $cust_bill_pkg->recur_show_zero;
3187 # always pass the svc_label through to the template, even if
3188 # not displaying it as an ext_description
3189 my @svc_labels = map &{$escape_function}($_),
3190 $cust_pkg->h_labels_short($self->_date, undef, 'I');
3192 $svc_label = $svc_labels[0];
3194 unless ( $cust_pkg->part_pkg->hide_svc_detail
3195 || $cust_bill_pkg->hidden )
3198 push @d, @svc_labels
3199 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3200 my $lnum = $cust_main ? $cust_main->ship_locationnum
3201 : $self->prospect_main->locationnum;
3202 # show the location label if it's not the customer's default
3203 # location, and we're not grouping items by location already
3204 if ( $cust_pkg->locationnum != $lnum and !defined($locationnum) ) {
3205 my $loc = $cust_pkg->location_label;
3206 $loc = substr($loc, 0, $maxlength). '...'
3207 if $format eq 'latex' && length($loc) > $maxlength;
3208 push @d, &{$escape_function}($loc);
3211 } #unless hiding service details
3213 push @d, $cust_bill_pkg->details(%details_opt)
3214 if $cust_bill_pkg->recur == 0;
3216 if ( $cust_bill_pkg->hidden ) {
3217 $s->{amount} += $cust_bill_pkg->setup;
3218 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3219 push @{ $s->{ext_description} }, @d;
3223 description => $description,
3224 pkgpart => $pkgpart,
3225 pkgnum => $cust_bill_pkg->pkgnum,
3226 amount => $cust_bill_pkg->setup,
3227 setup_show_zero => $cust_bill_pkg->setup_show_zero,
3228 unit_amount => $cust_bill_pkg->unitsetup,
3229 quantity => $cust_bill_pkg->quantity,
3230 ext_description => \@d,
3231 svc_label => ($svc_label || ''),
3232 locationnum => $cust_pkg->locationnum, # sure, why not?
3238 if ( ( !$type || $type eq 'R' || $type eq 'U' )
3240 $cust_bill_pkg->recur != 0
3241 || $cust_bill_pkg->setup == 0
3242 || $discount_show_always
3243 || $cust_bill_pkg->recur_show_zero
3248 warn "$me _items_cust_bill_pkg adding recur/usage\n"
3251 my $is_summary = $display->summary;
3252 my $description = $desc;
3253 if ( $type eq 'U' and defined($r) ) {
3254 # don't just show the same description as the recur line
3255 $description = $self->mt('Usage charges');
3258 my $part_pkg = $cust_pkg->part_pkg;
3260 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3264 my @seconds = (); # for display of usage info
3267 #at least until cust_bill_pkg has "past" ranges in addition to
3268 #the "future" sdate/edate ones... see #3032
3269 my @dates = ( $self->_date );
3270 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
3271 push @dates, $prev->sdate if $prev;
3272 push @dates, undef if !$prev;
3274 my @svc_labels = map &{$escape_function}($_),
3275 $cust_pkg->h_labels_short(@dates, 'I');
3276 $svc_label = $svc_labels[0];
3278 # show service labels, unless...
3279 # the package is set not to display them
3280 unless ( $part_pkg->hide_svc_detail
3281 # or this is a tax-like line item
3282 || $cust_bill_pkg->itemdesc
3283 # or this is a hidden (bundled) line item
3284 || $cust_bill_pkg->hidden
3285 # or this is a usage summary line
3286 || $is_summary && $type && $type eq 'U'
3287 # or this is a usage line and there's a recurring line
3288 # for the package in the same section (which will
3289 # have service labels already)
3290 || ($type eq 'U' and defined($r))
3294 warn "$me _items_cust_bill_pkg adding service details\n"
3297 push @d, @svc_labels
3298 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3299 warn "$me _items_cust_bill_pkg done adding service details\n"
3302 my $lnum = $cust_main ? $cust_main->ship_locationnum
3303 : $self->prospect_main->locationnum;
3304 # show the location label if it's not the customer's default
3305 # location, and we're not grouping items by location already
3306 if ( $cust_pkg->locationnum != $lnum and !defined($locationnum) ) {
3307 my $loc = $cust_pkg->location_label;
3308 $loc = substr($loc, 0, $maxlength). '...'
3309 if $format eq 'latex' && length($loc) > $maxlength;
3310 push @d, &{$escape_function}($loc);
3313 # Display of seconds_since_sqlradacct:
3314 # On the invoice, when processing @detail_items, look for a field
3315 # named 'seconds'. This will contain total seconds for each
3316 # service, in the same order as @ext_description. For services
3317 # that don't support this it will show undef.
3318 if ( $conf->exists('svc_acct-usage_seconds')
3319 and ! $cust_bill_pkg->pkgpart_override ) {
3320 foreach my $cust_svc (
3321 $cust_pkg->h_cust_svc(@dates, 'I')
3324 # eval because not having any part_export_usage exports
3325 # is a fatal error, last_bill/_date because that's how
3326 # sqlradius_hour billing does it
3328 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
3330 push @seconds, $sec;
3332 } #if svc_acct-usage_seconds
3334 } # if we are showing service labels
3336 unless ( $is_summary ) {
3337 warn "$me _items_cust_bill_pkg adding details\n"
3340 #instead of omitting details entirely in this case (unwanted side
3341 # effects), just omit CDRs
3342 $details_opt{'no_usage'} = 1
3343 if $type && $type eq 'R';
3345 push @d, $cust_bill_pkg->details(%details_opt);
3348 warn "$me _items_cust_bill_pkg calculating amount\n"
3353 $amount = $cust_bill_pkg->recur;
3354 } elsif ($type eq 'R') {
3355 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
3356 } elsif ($type eq 'U') {
3357 $amount = $cust_bill_pkg->usage;
3360 if ( !$type || $type eq 'R' ) {
3362 warn "$me _items_cust_bill_pkg adding recur\n"
3366 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
3369 if ( $cust_bill_pkg->hidden ) {
3370 $r->{amount} += $amount;
3371 $r->{unit_amount} += $unit_amount;
3372 push @{ $r->{ext_description} }, @d;
3375 description => $description,
3376 pkgpart => $pkgpart,
3377 pkgnum => $cust_bill_pkg->pkgnum,
3379 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3380 unit_amount => $unit_amount,
3381 quantity => $cust_bill_pkg->quantity,
3383 ext_description => \@d,
3384 svc_label => ($svc_label || ''),
3385 locationnum => $cust_pkg->locationnum,
3387 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3390 } else { # $type eq 'U'
3392 warn "$me _items_cust_bill_pkg adding usage\n"
3395 if ( $cust_bill_pkg->hidden and defined($u) ) {
3396 # if this is a hidden package and there's already a usage
3397 # line for the bundle, add this package's total amount and
3398 # usage details to it
3399 $u->{amount} += $amount;
3400 push @{ $u->{ext_description} }, @d;
3401 } elsif ( $amount ) {
3402 # create a new usage line
3404 description => $description,
3405 pkgpart => $pkgpart,
3406 pkgnum => $cust_bill_pkg->pkgnum,
3409 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3411 ext_description => \@d,
3412 locationnum => $cust_pkg->locationnum,
3414 } # else this has no usage, so don't create a usage section
3417 } # recurring or usage with recurring charge
3419 } else { # taxes and fees
3421 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3424 # items of this kind should normally not have sdate/edate.
3426 'description' => $desc,
3427 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
3428 + $cust_bill_pkg->recur)
3431 } # if quotation / package line item / other line item
3433 # decide whether to show active discounts here
3435 # case 1: we are showing a single line for the package
3437 # case 2: we are showing a setup line for a package that has
3438 # no base recurring fee
3439 or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3440 # case 3: we are showing a recur line for a package that has
3441 # a base recurring fee
3442 or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3445 my $item_discount = $cust_bill_pkg->_item_discount;
3446 if ( $item_discount ) {
3447 # $item_discount->{amount} is negative
3449 if ( $d and $cust_bill_pkg->hidden ) {
3450 $d->{amount} += $item_discount->{amount};
3452 $d = $item_discount;
3453 $_ = &{$escape_function}($_) foreach @{ $d->{ext_description} };
3456 # update the active line (before the discount) to show the
3457 # original price (whether this is a hidden line or not)
3459 # quotation discounts keep track of setup and recur; invoice
3460 # discounts currently don't
3461 if ( exists $item_discount->{setup_amount} ) {
3463 $s->{amount} -= $item_discount->{setup_amount} if $s;
3464 $r->{amount} -= $item_discount->{recur_amount} if $r;
3468 # $active_line is the line item hashref for the line that will
3469 # show the original price
3470 # (use the recur or single line for the package, unless we're
3471 # showing a setup line for a package with no recurring fee)
3472 my $active_line = $r;
3473 if ( $type eq 'S' ) {
3476 $active_line->{amount} -= $item_discount->{amount};
3480 } # if there are any discounts
3481 } # if this is an appropriate place to show discounts
3483 } # foreach $display
3485 $discount_show_always = ($cust_bill_pkg->cust_bill_pkg_discount
3486 && $conf->exists('discount-show-always'));
3490 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3492 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3493 if exists($_->{amount});
3494 $_->{amount} =~ s/^\-0\.00$/0.00/;
3495 if (exists($_->{unit_amount})) {
3496 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3500 if $_->{amount} != 0
3501 || $discount_show_always
3502 || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3503 || ( $_->{_is_setup} && $_->{setup_show_zero} )
3507 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3514 =item _items_discounts_avail
3516 Returns an array of line item hashrefs representing available term discounts
3517 for this invoice. This makes the same assumptions that apply to term
3518 discounts in general: that the package is billed monthly, at a flat rate,
3519 with no usage charges. A prorated first month will be handled, as will
3520 a setup fee if the discount is allowed to apply to setup fees.
3524 sub _items_discounts_avail {
3527 #maybe move this method from cust_bill when quotations support discount_plans
3528 return () unless $self->can('discount_plans');
3529 my %plans = $self->discount_plans;
3531 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3532 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3536 my $plan = $plans{$months};
3538 my $term_total = sprintf('%.2f', $plan->discounted_total);
3539 my $percent = sprintf('%.0f',
3540 100 * (1 - $term_total / $plan->base_total) );
3541 my $permonth = sprintf('%.2f', $term_total / $months);
3542 my $detail = $self->mt('discount on item'). ' '.
3543 join(', ', map { "#$_" } $plan->pkgnums)
3546 # discounts for non-integer months don't work anyway
3547 $months = sprintf("%d", $months);
3550 description => $self->mt('Save [_1]% by paying for [_2] months',
3552 amount => $self->mt('[_1] ([_2] per month)',
3553 $term_total, $money_char.$permonth),
3554 ext_description => ($detail || ''),
3557 sort { $b <=> $a } keys %plans;