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' => $cust_main->invoice_ship_address || $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 my @new_total_items = $self->_items_total;
1321 foreach ( @new_total_items ) {
1322 $_->{'total_item'} = &$embolden_function( $_->{'total_item'} );
1323 $_->{'total_amount'} = &$embolden_function( $other_money_char.$_->{'total_amount'});
1324 push @total_items, $_;
1327 } else { #normal invoice case
1329 # calculate total, possibly including total owed on previous
1333 $item = $conf->config('previous_balance-exclude_from_total')
1334 || 'Total New Charges'
1335 if $conf->exists('previous_balance-exclude_from_total');
1336 my $amount = $self->charged;
1337 if ( $self->enable_previous and !$conf->exists('previous_balance-exclude_from_total') ) {
1338 $amount += $pr_total;
1341 $total->{'total_item'} = &$embolden_function($self->mt($item));
1342 $total->{'total_amount'} =
1343 &$embolden_function( $other_money_char. sprintf( '%.2f', $amount ) );
1344 if ( $multisection ) {
1345 if ( $adjust_section->{'sort_weight'} ) {
1346 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1347 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1349 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1350 $other_money_char. sprintf('%.2f', $self->charged );
1353 push @total_items, $total;
1355 push @buf,['','-----------'];
1358 sprintf( '%10.2f', $amount )
1362 # if we're showing previous invoices, also show previous
1363 # credits and payments
1364 if ( $self->enable_previous
1365 and $self->can('_items_credits')
1366 and $self->can('_items_payments') )
1368 #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
1371 my $credittotal = 0;
1372 foreach my $credit (
1373 $self->_items_credits( 'template' => $template, 'trim_len' => 50 )
1377 $total->{'total_item'} = &$escape_function($credit->{'description'});
1378 $credittotal += $credit->{'amount'};
1379 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1380 if ( $multisection ) {
1381 push @detail_items, {
1382 ext_description => [],
1385 description => &$escape_function($credit->{'description'}),
1386 amount => $money_char . $credit->{'amount'},
1388 section => $adjust_section,
1391 push @total_items, $total;
1395 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1398 foreach my $credit (
1399 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1401 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1405 my $paymenttotal = 0;
1406 foreach my $payment (
1407 $self->_items_payments( 'template' => $template )
1410 $total->{'total_item'} = &$escape_function($payment->{'description'});
1411 $paymenttotal += $payment->{'amount'};
1412 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1413 if ( $multisection ) {
1414 push @detail_items, {
1415 ext_description => [],
1418 description => &$escape_function($payment->{'description'}),
1419 amount => $money_char . $payment->{'amount'},
1421 section => $adjust_section,
1424 push @total_items, $total;
1426 push @buf, [ $payment->{'description'},
1427 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1430 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1432 if ( $multisection ) {
1433 $adjust_section->{'subtotal'} = $other_money_char.
1434 sprintf('%.2f', $credittotal + $paymenttotal);
1436 #why this? because {sort_weight} forces the adjust_section to appear
1437 #in @extra_sections instead of @sections. obviously.
1438 push @sections, $adjust_section
1439 unless $adjust_section->{sort_weight};
1440 # do not summarize; adjustments there are shown according to
1444 # create Balance Due message
1447 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1448 $total->{'total_amount'} =
1449 &$embolden_function(
1450 $other_money_char. sprintf('%.2f', #why? $summarypage
1451 # ? $self->charged +
1452 # $self->billing_balance
1454 $self->owed + $pr_total
1457 if ( $multisection && !$adjust_section->{sort_weight} ) {
1458 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1459 $total->{'total_amount'};
1461 push @total_items, $total;
1463 push @buf,['','-----------'];
1464 push @buf,[$self->balance_due_msg, $money_char.
1465 sprintf("%10.2f", $balance_due ) ];
1468 if ( $conf->exists('previous_balance-show_credit')
1469 and $cust_main->balance < 0 ) {
1470 my $credit_total = {
1471 'total_item' => &$embolden_function($self->credit_balance_msg),
1472 'total_amount' => &$embolden_function(
1473 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1476 if ( $multisection ) {
1477 $adjust_section->{'posttotal'} .= $newline_token .
1478 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1481 push @total_items, $credit_total;
1483 push @buf,['','-----------'];
1484 push @buf,[$self->credit_balance_msg, $money_char.
1485 sprintf("%10.2f", -$cust_main->balance ) ];
1489 } #end of default total adding ! can('_items_total')
1491 if ( $multisection ) {
1492 if ( $conf->exists('svc_phone_sections')
1493 && $self->can('_items_svc_phone_sections')
1497 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1498 $total->{'total_amount'} =
1499 &$embolden_function(
1500 $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
1502 my $last_section = pop @sections;
1503 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1504 $total->{'total_amount'};
1505 push @sections, $last_section;
1507 push @sections, @$late_sections
1511 # make a discounts-available section, even without multisection
1512 if ( $conf->exists('discount-show_available')
1513 and my @discounts_avail = $self->_items_discounts_avail ) {
1514 my $discount_section = {
1515 'description' => $self->mt('Discounts Available'),
1520 push @sections, $discount_section; # do not summarize
1521 push @detail_items, map { +{
1522 'ref' => '', #should this be something else?
1523 'section' => $discount_section,
1524 'description' => &$escape_function( $_->{description} ),
1525 'amount' => $money_char . &$escape_function( $_->{amount} ),
1526 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1527 } } @discounts_avail;
1530 # not adding any more sections after this
1531 $invoice_data{summary_subtotals} = \@summary_subtotals;
1534 if ( $conf->exists('usage_class_summary')
1535 and $self->can('_items_usage_class_summary') ) {
1536 my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function);
1537 if ( @usage_subtotals ) {
1538 unshift @sections, $usage_subtotals[0]->{section}; # do not summarize
1539 unshift @detail_items, @usage_subtotals;
1543 # invoice history "section" (not really a section)
1544 # not to be included in any subtotals, completely independent of
1546 if ( $conf->exists('previous_invoice_history') and $cust_main->isa('FS::cust_main') ) {
1549 foreach my $cust_bill ( $cust_main->cust_bill ) {
1550 # XXX hardcoded format, and currently only 'charged'; add other fields
1551 # if they become necessary
1552 my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1553 $history{$date} ||= 0;
1554 $history{$date} += $cust_bill->charged;
1555 # just so we have a numeric sort key
1556 $monthorder{$date} ||= $cust_bill->_date;
1558 my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1560 my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1561 $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1564 # service locations: another option for template customization
1566 foreach my $item (@detail_items) {
1567 if ( $item->{locationnum} ) {
1568 $location_info{ $item->{locationnum} } ||= {
1569 FS::cust_location->by_key( $item->{locationnum} )->location_hash
1573 $invoice_data{location_info} = \%location_info;
1575 # debugging hook: call this with 'diag' => 1 to just get a hash of
1576 # the invoice variables
1577 return \%invoice_data if ( $params{'diag'} );
1579 # All sections and items are built; now fill in templates.
1580 my @includelist = ();
1581 push @includelist, 'summary' if $summarypage;
1582 foreach my $include ( @includelist ) {
1584 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1587 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1589 @inc_src = $conf->config($inc_file, $agentnum);
1593 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1595 my $convert_map = $convert_maps{$format}{$include};
1597 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1598 s/--\@\]/$delimiters{$format}[1]/g;
1601 &$convert_map( $conf->config($inc_file, $agentnum) );
1605 my $inc_tt = new Text::Template (
1607 SOURCE => [ map "$_\n", @inc_src ],
1608 DELIMITERS => $delimiters{$format},
1609 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1611 unless ( $inc_tt->compile() ) {
1612 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1613 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1617 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1619 $invoice_data{$include} =~ s/\n+$//
1620 if ($format eq 'latex');
1625 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1626 /invoice_lines\((\d*)\)/;
1627 $invoice_lines += $1 || scalar(@buf);
1630 die "no invoice_lines() functions in template?"
1631 if ( $format eq 'template' && !$wasfunc );
1633 if ($format eq 'template') {
1635 if ( $invoice_lines ) {
1636 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1637 $invoice_data{'total_pages'}++
1638 if scalar(@buf) % $invoice_lines;
1641 #setup subroutine for the template
1642 $invoice_data{invoice_lines} = sub {
1643 my $lines = shift || scalar(@buf);
1655 push @collect, split("\n",
1656 $text_template->fill_in( HASH => \%invoice_data )
1658 $invoice_data{'page'}++;
1660 map "$_\n", @collect;
1662 } else { # this is where we actually create the invoice
1664 warn "filling in template for invoice ". $self->invnum. "\n"
1666 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1669 $text_template->fill_in(HASH => \%invoice_data);
1673 sub notice_name { '('.shift->table.')'; }
1675 sub template_conf { 'invoice_'; }
1677 # helper routine for generating date ranges
1678 sub _prior_month30s {
1681 [ 1, 2592000 ], # 0-30 days ago
1682 [ 2592000, 5184000 ], # 30-60 days ago
1683 [ 5184000, 7776000 ], # 60-90 days ago
1684 [ 7776000, 0 ], # 90+ days ago
1687 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
1688 $_->[1] ? $self->_date - $_->[1] - 1 : '',
1693 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1695 Returns an postscript invoice, as a scalar.
1697 Options can be passed as a hashref (recommended) or as a list of time, template
1698 and then any key/value pairs for any other options.
1700 I<time> an optional value used to control the printing of overdue messages. The
1701 default is now. It isn't the date of the invoice; that's the `_date' field.
1702 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1703 L<Time::Local> and L<Date::Parse> for conversion functions.
1705 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1712 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1713 my $ps = generate_ps($file);
1715 unlink($barcodefile) if $barcodefile;
1720 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1722 Returns an PDF invoice, as a scalar.
1724 Options can be passed as a hashref (recommended) or as a list of time, template
1725 and then any key/value pairs for any other options.
1727 I<time> an optional value used to control the printing of overdue messages. The
1728 default is now. It isn't the date of the invoice; that's the `_date' field.
1729 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1730 L<Time::Local> and L<Date::Parse> for conversion functions.
1732 I<template>, if specified, is the name of a suffix for alternate invoices.
1734 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1741 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1742 my $pdf = generate_pdf($file);
1744 unlink($barcodefile) if $barcodefile;
1749 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1751 Returns an HTML invoice, as a scalar.
1753 I<time> an optional value used to control the printing of overdue messages. The
1754 default is now. It isn't the date of the invoice; that's the `_date' field.
1755 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1756 L<Time::Local> and L<Date::Parse> for conversion functions.
1758 I<template>, if specified, is the name of a suffix for alternate invoices.
1760 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1762 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1763 when emailing the invoice as part of a multipart/related MIME email.
1771 %params = %{ shift() };
1775 $params{'format'} = 'html';
1777 $self->print_generic( %params );
1780 # quick subroutine for print_latex
1782 # There are ten characters that LaTeX treats as special characters, which
1783 # means that they do not simply typeset themselves:
1784 # # $ % & ~ _ ^ \ { }
1786 # TeX ignores blanks following an escaped character; if you want a blank (as
1787 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1791 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1792 $value =~ s/([<>])/\$$1\$/g;
1798 encode_entities($value);
1802 sub _html_escape_nbsp {
1803 my $value = _html_escape(shift);
1804 $value =~ s/ +/ /g;
1808 #utility methods for print_*
1810 sub _translate_old_latex_format {
1811 warn "_translate_old_latex_format called\n"
1818 if ( $line =~ /^%%Detail\s*$/ ) {
1820 push @template, q![@--!,
1821 q! foreach my $_tr_line (@detail_items) {!,
1822 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1823 q! $_tr_line->{'description'} .= !,
1824 q! "\\tabularnewline\n~~".!,
1825 q! join( "\\tabularnewline\n~~",!,
1826 q! @{$_tr_line->{'ext_description'}}!,
1830 while ( ( my $line_item_line = shift )
1831 !~ /^%%EndDetail\s*$/ ) {
1832 $line_item_line =~ s/'/\\'/g; # nice LTS
1833 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1834 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1835 push @template, " \$OUT .= '$line_item_line';";
1838 push @template, '}',
1841 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1843 push @template, '[@--',
1844 ' foreach my $_tr_line (@total_items) {';
1846 while ( ( my $total_item_line = shift )
1847 !~ /^%%EndTotalDetails\s*$/ ) {
1848 $total_item_line =~ s/'/\\'/g; # nice LTS
1849 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1850 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1851 push @template, " \$OUT .= '$total_item_line';";
1854 push @template, '}',
1858 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1859 push @template, $line;
1865 warn "$_\n" foreach @template;
1877 my $conf = $self->conf;
1879 #check for an invoice-specific override
1880 return $self->invoice_terms if $self->invoice_terms;
1882 #check for a customer- specific override
1883 my $cust_main = $self->cust_main;
1884 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1888 $agentnum = $cust_main->agentnum;
1889 } elsif ( my $prospect_main = $self->prospect_main ) {
1890 $agentnum = $prospect_main->agentnum;
1893 #use configured default
1894 $conf->config('invoice_default_terms', $agentnum) || '';
1904 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1905 $duedate = $self->_date() + ( $1 * 86400 );
1916 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
1919 =item balance_due_msg
1923 sub balance_due_msg {
1925 my $msg = $self->mt('Balance Due');
1926 return $msg unless $self->terms;
1927 if ( $self->due_date ) {
1928 $msg .= ' - ' . $self->mt('Please pay by'). ' '.
1929 $self->due_date2str('short');
1930 } elsif ( $self->terms ) {
1931 $msg .= ' - '. $self->terms;
1936 =item balance_due_date
1940 sub balance_due_date {
1942 my $conf = $self->conf;
1944 my $terms = $self->terms;
1945 if ( $terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1946 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
1951 sub credit_balance_msg {
1953 $self->mt('Credit Balance Remaining')
1958 Returns a string with the date, for example: "3/20/2008", localized for the
1959 customer. Use _date_pretty_unlocalized for non-end-customer display use.
1965 $self->time2str_local('short', $self->_date);
1968 =item _date_pretty_unlocalized
1970 Returns a string with the date, for example: "3/20/2008", in the format
1971 configured for the back-office. Use _date_pretty for end-customer display use.
1975 sub _date_pretty_unlocalized {
1977 time2str($date_format, $self->_date);
1982 Emails this template.
1984 Options are passed as a hashref. Available options:
1990 If specified, overrides the default From: address.
1994 If specified, overrides the name of the sent document ("Invoice" or "Quotation")
1998 (Deprecated) If specified, is the name of a suffix for alternate template files.
2002 Options accepted by generate_email can also be used.
2008 my $opt = shift || {};
2009 if ($opt and !ref($opt)) {
2010 die ref($self). '->email called with positional parameters';
2013 return if $self->hide;
2015 my $error = send_email(
2016 $self->generate_email(
2017 'subject' => $self->email_subject($opt->{template}),
2018 %$opt, # template, etc.
2022 die "can't email: $error\n" if $error;
2025 =item generate_email OPTION => VALUE ...
2033 sender address, required
2037 alternate template name, optional
2041 email subject, optional
2045 notice name instead of "Invoice", optional
2049 Returns an argument list to be passed to L<FS::Misc::send_email>.
2055 sub generate_email {
2059 my $conf = $self->conf;
2061 my $me = '[FS::Template_Mixin::generate_email]';
2064 'from' => $args{'from'},
2065 'subject' => ($args{'subject'} || $self->email_subject),
2066 'custnum' => $self->custnum,
2067 'msgtype' => 'invoice',
2070 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
2072 my $cust_main = $self->cust_main;
2074 if (ref($args{'to'}) eq 'ARRAY') {
2075 $return{'to'} = $args{'to'};
2076 } elsif ( $cust_main ) {
2077 $return{'to'} = [ $cust_main->invoicing_list_emailonly ];
2080 my $tc = $self->template_conf;
2082 my @text; # array of lines
2083 my $html; # a big string
2084 my @related_parts; # will contain the text/HTML alternative, and images
2085 my $related; # will contain the multipart/related object
2087 if ( $conf->exists($tc. 'email_pdf') ) {
2088 if ( my $msgnum = $conf->config($tc.'email_pdf_msgnum') ) {
2090 warn "$me using '${tc}email_pdf_msgnum' in multipart message"
2093 my $msg_template = FS::msg_template->by_key($msgnum)
2094 or die "${tc}email_pdf_msgnum $msgnum not found\n";
2095 my %prepared = $msg_template->prepare(
2096 cust_main => $self->cust_main,
2100 @text = split(/(?=\n)/, $prepared{'text_body'});
2101 $html = $prepared{'html_body'};
2103 } elsif ( my @note = $conf->config($tc.'email_pdf_note') ) {
2105 warn "$me using '${tc}email_pdf_note' in multipart message"
2107 @text = $conf->config($tc.'email_pdf_note');
2108 $html = join('<BR>', @text);
2110 } # else use the plain text invoice
2115 warn "$me generating plain text invoice"
2118 # 'print_text' argument is no longer used
2119 @text = $self->print_text(\%args);
2123 my $text_part = build MIME::Entity (
2124 'Type' => 'text/plain',
2125 'Encoding' => 'quoted-printable',
2126 'Charset' => 'UTF-8',
2127 #'Encoding' => '7bit',
2129 'Disposition' => 'inline',
2134 if ( $conf->exists($tc.'html') ) {
2135 warn "$me generating HTML invoice"
2138 $args{'from'} =~ /\@([\w\.\-]+)/;
2139 my $from = $1 || 'example.com';
2140 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2143 my $agentnum = $cust_main ? $cust_main->agentnum
2144 : $self->prospect_main->agentnum;
2145 if ( defined($args{'template'}) && length($args{'template'})
2146 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
2149 $logo = 'logo_'. $args{'template'}. '.png';
2153 my $image_data = $conf->config_binary( $logo, $agentnum);
2155 push @related_parts, build MIME::Entity
2156 'Type' => 'image/png',
2157 'Encoding' => 'base64',
2158 'Data' => $image_data,
2159 'Filename' => 'logo.png',
2160 'Content-ID' => "<$content_id>",
2163 if ( ref($self) eq 'FS::cust_bill' && $conf->exists('invoice-barcode') ) {
2164 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2165 push @related_parts, build MIME::Entity
2166 'Type' => 'image/png',
2167 'Encoding' => 'base64',
2168 'Data' => $self->invoice_barcode(0),
2169 'Filename' => 'barcode.png',
2170 'Content-ID' => "<$barcode_content_id>",
2172 $args{'barcode_cid'} = $barcode_content_id;
2175 $html = $self->print_html({ 'cid'=>$content_id, %args });
2182 warn "$me creating HTML/text multipart message"
2185 $return{'nobody'} = 1;
2187 my $alternative = build MIME::Entity
2188 'Type' => 'multipart/alternative',
2189 #'Encoding' => '7bit',
2190 'Disposition' => 'inline'
2194 $alternative->add_part($text_part);
2197 $alternative->attach(
2198 'Type' => 'text/html',
2199 'Encoding' => 'quoted-printable',
2200 'Data' => [ '<html>',
2203 ' '. encode_entities($return{'subject'}),
2206 ' <body bgcolor="#e8e8e8">',
2211 'Disposition' => 'inline',
2212 #'Filename' => 'invoice.pdf',
2215 unshift @related_parts, $alternative;
2217 $related = build MIME::Entity 'Type' => 'multipart/related',
2218 'Encoding' => '7bit';
2220 #false laziness w/Misc::send_email
2221 $related->head->replace('Content-type',
2222 $related->mime_type.
2223 '; boundary="'. $related->head->multipart_boundary. '"'.
2224 '; type=multipart/alternative'
2227 $related->add_part($_) foreach @related_parts;
2231 my @otherparts = ();
2232 if ( ref($self) eq 'FS::cust_bill' && $cust_main->email_csv_cdr ) {
2234 push @otherparts, build MIME::Entity
2235 'Type' => 'text/csv',
2236 'Encoding' => '7bit',
2237 'Data' => [ map { "$_\n" }
2238 $self->call_details('prepend_billed_number' => 1)
2240 'Disposition' => 'attachment',
2241 'Filename' => 'usage-'. $self->invnum. '.csv',
2246 if ( $conf->exists($tc.'email_pdf') ) {
2251 # multipart/alternative
2257 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
2258 push @otherparts, $pdf;
2262 $return{'content-type'} = 'multipart/mixed'; # of the outer container
2264 $return{'mimeparts'} = [ $related, @otherparts ];
2265 $return{'type'} = 'multipart/related'; # of the first part
2267 $return{'mimeparts'} = [ $text_part, @otherparts ];
2268 $return{'type'} = 'text/plain';
2270 } elsif ( $html ) { # no PDF or CSV, strip the outer container
2271 $return{'mimeparts'} = \@related_parts;
2272 $return{'content-type'} = 'multipart/related';
2273 $return{'type'} = 'multipart/alternative';
2274 } else { # no HTML either
2275 $return{'body'} = \@text;
2276 $return{'content-type'} = 'text/plain';
2285 Returns a list suitable for passing to MIME::Entity->build(), representing
2286 this invoice as PDF attachment.
2293 'Type' => 'application/pdf',
2294 'Encoding' => 'base64',
2295 'Data' => [ $self->print_pdf(@_) ],
2296 'Disposition' => 'attachment',
2297 'Filename' => 'invoice-'. $self->invnum. '.pdf',
2301 =item _items_sections OPTIONS
2303 Generate section information for all items appearing on this invoice.
2304 This will only be called for multi-section invoices.
2306 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
2307 related display records (L<FS::cust_bill_pkg_display>) and organize
2308 them into two groups ("early" and "late" according to whether they come
2309 before or after the total), then into sections. A subtotal is calculated
2312 Section descriptions are returned in sort weight order. Each consists
2313 of a hash containing:
2315 description: the package category name, escaped
2316 subtotal: the total charges in that section
2317 tax_section: a flag indicating that the section contains only tax charges
2318 summarized: same as tax_section, for some reason
2319 sort_weight: the package category's sort weight
2321 If 'condense' is set on the display record, it also contains everything
2322 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
2323 coderefs to generate parts of the invoice. This is not advised.
2325 The method returns two arrayrefs, one of "early" sections and one of "late"
2328 OPTIONS may include:
2330 by_location: a flag to divide the invoice into sections by location.
2331 Each section hash will have a 'location' element containing a hashref of
2332 the location fields (see L<FS::cust_location>). The section description
2333 will be the location label, but the template can use any of the location
2334 fields to create a suitable label.
2336 by_category: a flag to divide the invoice into sections using display
2337 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
2338 behavior. Each section hash will have a 'category' element containing
2339 the section name from the display record (which probably equals the
2340 category name of the package, but may not in some cases).
2342 summary: a flag indicating that this is a summary-format invoice.
2343 Turning this on has the following effects:
2344 - Ignores display items with the 'summary' flag.
2345 - Places all sections in the "early" group even if they have post_total.
2346 - Creates sections for all non-disabled package categories, even if they
2347 have no charges on this invoice, as well as a section with no name.
2349 escape: an escape function to use for section titles.
2351 extra_sections: an arrayref of additional sections to return after the
2352 sorted list. If there are any of these, section subtotals exclude
2355 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
2356 passed through to C<_condense_section()>.
2360 use vars qw(%pkg_category_cache);
2361 sub _items_sections {
2365 my $escape = $opt{escape};
2366 my @extra_sections = @{ $opt{extra_sections} || [] };
2368 # $subtotal{$locationnum}{$categoryname} = amount.
2369 # if we're not using by_location, $locationnum is undef.
2370 # if we're not using by_category, you guessed it, $categoryname is undef.
2371 # if we're not using either one, we shouldn't be here in the first place...
2373 my %late_subtotal = ();
2376 # About tax items + multisection invoices:
2377 # If either invoice_*summary option is enabled, AND there is a
2378 # package category with the name of the tax, then there will be
2379 # a display record assigning the tax item to that category.
2381 # However, the taxes are always placed in the "Taxes, Surcharges,
2382 # and Fees" section regardless of that. The only effect of the
2383 # display record is to create a subtotal for the summary page.
2386 my $pkg_hash = $self->cust_pkg_hash;
2388 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2391 my $usage = $cust_bill_pkg->usage;
2394 if ( $opt{by_location} ) {
2395 if ( $cust_bill_pkg->pkgnum ) {
2396 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2401 $locationnum = undef;
2404 # as in _items_cust_pkg, if a line item has no display records,
2405 # cust_bill_pkg_display() returns a default record for it
2407 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2408 next if ( $display->summary && $opt{summary} );
2410 my $section = $display->section;
2411 my $type = $display->type;
2412 # Set $section = undef if we're sectioning by location and this
2413 # line item _has_ a location (i.e. isn't a fee).
2414 $section = undef if $locationnum;
2416 # set this flag if the section is not tax-only
2417 $not_tax{$locationnum}{$section} = 1
2418 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
2420 # there's actually a very important piece of logic buried in here:
2421 # incrementing $late_subtotal{$section} CREATES
2422 # $late_subtotal{$section}. keys(%late_subtotal) is later used
2423 # to define the list of late sections, and likewise keys(%subtotal).
2424 # When _items_cust_bill_pkg is called to generate line items for
2425 # real, it will be called with 'section' => $section for each
2427 if ( $display->post_total && !$opt{summary} ) {
2428 if (! $type || $type eq 'S') {
2429 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2430 if $cust_bill_pkg->setup != 0
2431 || $cust_bill_pkg->setup_show_zero;
2435 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
2436 if $cust_bill_pkg->recur != 0
2437 || $cust_bill_pkg->recur_show_zero;
2440 if ($type && $type eq 'R') {
2441 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2442 if $cust_bill_pkg->recur != 0
2443 || $cust_bill_pkg->recur_show_zero;
2446 if ($type && $type eq 'U') {
2447 $late_subtotal{$locationnum}{$section} += $usage
2448 unless scalar(@extra_sections);
2451 } else { # it's a pre-total (normal) section
2453 # skip tax items unless they're explicitly included in a section
2454 next if $cust_bill_pkg->pkgnum == 0 and
2455 ! $cust_bill_pkg->feepart and
2458 if ( $type eq 'S' ) {
2459 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2460 if $cust_bill_pkg->setup != 0
2461 || $cust_bill_pkg->setup_show_zero;
2462 } elsif ( $type eq 'R' ) {
2463 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2464 if $cust_bill_pkg->recur != 0
2465 || $cust_bill_pkg->recur_show_zero;
2466 } elsif ( $type eq 'U' ) {
2467 $subtotal{$locationnum}{$section} += $usage
2468 unless scalar(@extra_sections);
2469 } elsif ( !$type ) {
2470 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2471 + $cust_bill_pkg->recur;
2480 %pkg_category_cache = ();
2482 # summary invoices need subtotals for all non-disabled package categories,
2483 # even if they're zero
2484 # but currently assume that there are no location sections, or at least
2485 # that the summary page doesn't care about them
2486 if ( $opt{summary} ) {
2487 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2488 $subtotal{''}{$category->categoryname} ||= 0;
2490 $subtotal{''}{''} ||= 0;
2494 foreach my $post_total (0,1) {
2496 my $s = $post_total ? \%late_subtotal : \%subtotal;
2497 foreach my $locationnum (keys %$s) {
2498 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2500 'subtotal' => $s->{$locationnum}{$sectionname},
2501 'post_total' => $post_total,
2504 if ( $locationnum ) {
2505 $section->{'locationnum'} = $locationnum;
2506 my $location = FS::cust_location->by_key($locationnum);
2507 $section->{'description'} = &{ $escape }($location->location_label);
2508 # Better ideas? This will roughly group them by proximity,
2509 # which alpha sorting on any of the address fields won't.
2510 # Sorting by locationnum is meaningless.
2511 # We have to sort on _something_ or the order may change
2512 # randomly from one invoice to the next, which will confuse
2514 $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
2516 $section->{'location'} = {
2517 label_prefix => &{ $escape }($location->label_prefix),
2518 map { $_ => &{ $escape }($location->get($_)) }
2522 $section->{'category'} = $sectionname;
2523 $section->{'description'} = &{ $escape }($sectionname);
2524 if ( _pkg_category($sectionname) ) {
2525 $section->{'sort_weight'} = _pkg_category($sectionname)->weight;
2526 if ( _pkg_category($sectionname)->condense ) {
2527 $section = { %$section, $self->_condense_section($opt{format}) };
2531 if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
2532 # then it's a tax-only section
2533 $section->{'summarized'} = 'Y';
2534 $section->{'tax_section'} = 'Y';
2536 push @these, $section;
2537 } # foreach $sectionname
2538 } #foreach $locationnum
2539 push @these, @extra_sections if $post_total == 0;
2540 # need an alpha sort for location sections, because postal codes can
2542 $sections[ $post_total ] = [ sort {
2543 $opt{'by_location'} ?
2544 ($a->{sort_weight} cmp $b->{sort_weight}) :
2545 ($a->{sort_weight} <=> $b->{sort_weight})
2547 } #foreach $post_total
2549 return @sections; # early, late
2552 #helper subs for above
2556 $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2560 my $categoryname = shift;
2561 $pkg_category_cache{$categoryname} ||=
2562 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2565 my %condensed_format = (
2566 'label' => [ qw( Description Qty Amount ) ],
2568 sub { shift->{description} },
2569 sub { shift->{quantity} },
2570 sub { my($href, %opt) = @_;
2571 ($opt{dollar} || ''). $href->{amount};
2574 'align' => [ qw( l r r ) ],
2575 'span' => [ qw( 5 1 1 ) ], # unitprices?
2576 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
2579 sub _condense_section {
2580 my ( $self, $format ) = ( shift, shift );
2582 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2583 qw( description_generator
2586 total_line_generator
2591 sub _condensed_generator_defaults {
2592 my ( $self, $format ) = ( shift, shift );
2593 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2602 sub _condensed_header_generator {
2603 my ( $self, $format ) = ( shift, shift );
2605 my ( $f, $prefix, $suffix, $separator, $column ) =
2606 _condensed_generator_defaults($format);
2608 if ($format eq 'latex') {
2609 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2610 $suffix = "\\\\\n\\hline";
2613 sub { my ($d,$a,$s,$w) = @_;
2614 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2616 } elsif ( $format eq 'html' ) {
2617 $prefix = '<th></th>';
2621 sub { my ($d,$a,$s,$w) = @_;
2622 return qq!<th align="$html_align{$a}">$d</th>!;
2630 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2632 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2635 $prefix. join($separator, @result). $suffix;
2640 sub _condensed_description_generator {
2641 my ( $self, $format ) = ( shift, shift );
2643 my ( $f, $prefix, $suffix, $separator, $column ) =
2644 _condensed_generator_defaults($format);
2646 my $money_char = '$';
2647 if ($format eq 'latex') {
2648 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2650 $separator = " & \n";
2652 sub { my ($d,$a,$s,$w) = @_;
2653 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2655 $money_char = '\\dollar';
2656 }elsif ( $format eq 'html' ) {
2657 $prefix = '"><td align="center"></td>';
2661 sub { my ($d,$a,$s,$w) = @_;
2662 return qq!<td align="$html_align{$a}">$d</td>!;
2664 #$money_char = $conf->config('money_char') || '$';
2665 $money_char = ''; # this is madness
2673 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2675 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2677 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2678 map { $f->{$_}->[$i] } qw(align span width)
2682 $prefix. join( $separator, @result ). $suffix;
2687 sub _condensed_total_generator {
2688 my ( $self, $format ) = ( shift, shift );
2690 my ( $f, $prefix, $suffix, $separator, $column ) =
2691 _condensed_generator_defaults($format);
2694 if ($format eq 'latex') {
2697 $separator = " & \n";
2699 sub { my ($d,$a,$s,$w) = @_;
2700 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2702 }elsif ( $format eq 'html' ) {
2706 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2708 sub { my ($d,$a,$s,$w) = @_;
2709 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2718 # my $r = &{$f->{fields}->[$i]}(@args);
2719 # $r .= ' Total' unless $i;
2721 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2723 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
2724 map { $f->{$_}->[$i] } qw(align span width)
2728 $prefix. join( $separator, @result ). $suffix;
2733 =item total_line_generator FORMAT
2735 Returns a coderef used for generation of invoice total line items for this
2736 usage_class. FORMAT is either html or latex
2740 # should not be used: will have issues with hash element names (description vs
2741 # total_item and amount vs total_amount -- another array of functions?
2743 sub _condensed_total_line_generator {
2744 my ( $self, $format ) = ( shift, shift );
2746 my ( $f, $prefix, $suffix, $separator, $column ) =
2747 _condensed_generator_defaults($format);
2750 if ($format eq 'latex') {
2753 $separator = " & \n";
2755 sub { my ($d,$a,$s,$w) = @_;
2756 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2758 }elsif ( $format eq 'html' ) {
2762 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2764 sub { my ($d,$a,$s,$w) = @_;
2765 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2774 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2776 &{$column}( &{$f->{fields}->[$i]}(@args),
2777 map { $f->{$_}->[$i] } qw(align span width)
2781 $prefix. join( $separator, @result ). $suffix;
2786 =item _items_pkg [ OPTIONS ]
2788 Return line item hashes for each package item on this invoice. Nearly
2791 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
2793 OPTIONS are passed through to _items_cust_bill_pkg, and should include
2794 'format' and 'escape_function' at minimum.
2796 To produce items for a specific invoice section, OPTIONS should include
2797 'section', a hashref containing 'category' and/or 'locationnum' keys.
2799 'section' may also contain a key named 'condensed'. If this is present
2800 and has a true value, _items_pkg will try to merge identical items into items
2801 with 'quantity' equal to the number of items (not the sum of their separate
2802 quantities, for some reason).
2808 # The order of these is important. Bundled line items will be merged into
2809 # the most recent non-hidden item, so it needs to be the one with:
2811 # - the same start date
2812 # - no pkgpart_override
2814 # So: sort by pkgnum,
2816 # then sort the base line item before any overrides
2817 # then sort hidden before non-hidden add-ons
2818 # then sort by override pkgpart (for consistency)
2819 sort { $a->pkgnum <=> $b->pkgnum or
2820 $a->sdate <=> $b->sdate or
2821 ($a->pkgpart_override ? 0 : -1) or
2822 ($b->pkgpart_override ? 0 : 1) or
2823 $b->hidden cmp $a->hidden or
2824 $a->pkgpart_override <=> $b->pkgpart_override
2826 # and of course exclude taxes and fees
2827 grep { $_->pkgnum > 0 } $self->cust_bill_pkg;
2833 my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
2834 my $escape_function = $options{escape_function};
2837 foreach my $cust_bill_pkg (@cust_bill_pkg) {
2838 # cache this, so we don't look it up again in every section
2839 my $part_fee = $cust_bill_pkg->get('part_fee')
2840 || $cust_bill_pkg->part_fee;
2841 $cust_bill_pkg->set('part_fee', $part_fee);
2843 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
2844 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
2847 if ( exists($options{section}) and exists($options{section}{category}) )
2849 my $categoryname = $options{section}{category};
2850 # then filter for items that have that section
2851 if ( $part_fee->categoryname ne $categoryname ) {
2852 warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
2855 } # otherwise include them all in the main section
2856 # XXX what to do when sectioning by location?
2859 my %base_invnums; # invnum => invoice date
2860 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
2861 if ($_->base_invnum) {
2862 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
2863 my $base_date = $self->time2str_local('short', $base_bill->_date)
2865 $base_invnums{$_->base_invnum} = $base_date || '';
2868 foreach (sort keys(%base_invnums)) {
2869 next if $_ == $self->invnum;
2870 # per convention, we must escape ext_description lines
2872 &{$escape_function}(
2873 $self->mt('from invoice #[_1] on [_2]', $_, $base_invnums{$_})
2876 my $desc = $part_fee->itemdesc_locale($self->cust_main->locale);
2877 # but not escape the base description line
2880 { feepart => $cust_bill_pkg->feepart,
2881 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
2882 description => $desc,
2883 ext_description => \@ext_desc
2894 warn "$me _items_pkg searching for all package line items\n"
2897 my @cust_bill_pkg = $self->_items_nontax;
2899 warn "$me _items_pkg filtering line items\n"
2901 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2903 if ($options{section} && $options{section}->{condensed}) {
2905 warn "$me _items_pkg condensing section\n"
2909 local $Storable::canonical = 1;
2910 foreach ( @items ) {
2912 delete $item->{ref};
2913 delete $item->{ext_description};
2914 my $key = freeze($item);
2915 $itemshash{$key} ||= 0;
2916 $itemshash{$key} ++; # += $item->{quantity};
2918 @items = sort { $a->{description} cmp $b->{description} }
2919 map { my $i = thaw($_);
2920 $i->{quantity} = $itemshash{$_};
2922 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
2928 warn "$me _items_pkg returning ". scalar(@items). " items\n"
2935 return 0 unless $a->itemdesc cmp $b->itemdesc;
2936 return -1 if $b->itemdesc eq 'Tax';
2937 return 1 if $a->itemdesc eq 'Tax';
2938 return -1 if $b->itemdesc eq 'Other surcharges';
2939 return 1 if $a->itemdesc eq 'Other surcharges';
2940 $a->itemdesc cmp $b->itemdesc;
2945 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
2946 $self->cust_bill_pkg;
2947 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2949 if ( $self->conf->exists('always_show_tax') ) {
2950 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
2951 if (0 == grep { $_->{description} eq $itemdesc } @items) {
2953 { 'description' => $itemdesc,
2960 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
2962 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
2963 list of hashrefs describing the line items they generate on the invoice.
2965 OPTIONS may include:
2967 format: the invoice format.
2969 escape_function: the function used to escape strings.
2971 DEPRECATED? (expensive, mostly unused?)
2972 format_function: the function used to format CDRs.
2974 section: a hashref containing 'category' and/or 'locationnum'; if this
2975 is present, only returns line items that belong to that category and/or
2976 location (whichever is defined).
2978 multisection: a flag indicating that this is a multisection invoice,
2979 which does something complicated.
2981 preref_callback: coderef run for each line item, code should return HTML to be
2982 displayed before that line item (quotations only)
2984 Returns a list of hashrefs, each of which may contain:
2986 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
2987 ext_description, which is an arrayref of detail lines to show below
2992 sub _items_cust_bill_pkg {
2994 my $conf = $self->conf;
2995 my $cust_bill_pkgs = shift;
2998 my $format = $opt{format} || '';
2999 my $escape_function = $opt{escape_function} || sub { shift };
3000 my $format_function = $opt{format_function} || '';
3001 my $no_usage = $opt{no_usage} || '';
3002 my $unsquelched = $opt{unsquelched} || ''; #unused
3003 my ($section, $locationnum, $category);
3004 if ( $opt{section} ) {
3005 $category = $opt{section}->{category};
3006 $locationnum = $opt{section}->{locationnum};
3008 my $summary_page = $opt{summary_page} || ''; #unused
3009 my $multisection = defined($category) || defined($locationnum);
3010 my $discount_show_always = 0;
3012 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
3014 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
3016 # for location labels: use default location on the invoice date
3017 my $default_locationnum;
3018 if ( $self->custnum ) {
3020 my @h_search = FS::h_cust_main->sql_h_search($self->_date);
3021 $h_cust_main = qsearchs({
3022 'table' => 'h_cust_main',
3023 'hashref' => { custnum => $self->custnum },
3024 'extra_sql' => $h_search[1],
3025 'addl_from' => $h_search[3],
3027 $default_locationnum = $h_cust_main->ship_locationnum;
3028 } elsif ( $self->prospectnum ) {
3029 my $cust_location = qsearchs('cust_location',
3030 { prospectnum => $self->prospectnum,
3032 $default_locationnum = $cust_location->locationnum if $cust_location;
3035 my @b = (); # accumulator for the line item hashes that we'll return
3036 my ($s, $r, $u, $d) = ( undef, undef, undef, undef );
3037 # the 'current' line item hashes for setup, recur, usage, discount
3038 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
3040 # if the current line item is waiting to go out, and the one we're about
3041 # to start is not bundled, then push out the current one and start a new
3043 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3044 if ( $_ && !$cust_bill_pkg->hidden ) {
3045 $_->{amount} = sprintf( "%.2f", $_->{amount} );
3046 $_->{amount} =~ s/^\-0\.00$/0.00/;
3047 if (exists($_->{unit_amount})) {
3048 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3051 if $_->{amount} != 0
3052 || $discount_show_always
3053 || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3054 || ( $_->{_is_setup} && $_->{setup_show_zero} )
3060 if ( $locationnum ) {
3061 # this is a location section; skip packages that aren't at this
3063 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
3064 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
3068 # Consider display records for this item to determine if it belongs
3069 # in this section. Note that if there are no display records, there
3070 # will be a default pseudo-record that includes all charge types
3071 # and has no section name.
3072 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
3073 ? $cust_bill_pkg->cust_bill_pkg_display
3074 : ( $cust_bill_pkg );
3076 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
3077 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
3080 if ( defined($category) ) {
3081 # then this is a package category section; process all display records
3082 # that belong to this section.
3083 @cust_bill_pkg_display = grep { $_->section eq $category }
3084 @cust_bill_pkg_display;
3086 # otherwise, process all display records that aren't usage summaries
3087 # (I don't think there should be usage summaries if you aren't using
3088 # category sections, but this is the historical behavior)
3089 @cust_bill_pkg_display = grep { !$_->summary }
3090 @cust_bill_pkg_display;
3093 my $classname = ''; # package class name, will fill in later
3095 foreach my $display (@cust_bill_pkg_display) {
3097 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
3098 $display->billpkgdisplaynum. "\n"
3101 my $type = $display->type;
3103 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
3104 $desc = substr($desc, 0, $maxlength). '...'
3105 if $format eq 'latex' && length($desc) > $maxlength;
3107 my %details_opt = ( 'format' => $format,
3108 'escape_function' => $escape_function,
3109 'format_function' => $format_function,
3110 'no_usage' => $opt{'no_usage'},
3113 if ( ref($cust_bill_pkg) eq 'FS::quotation_pkg' ) {
3114 # XXX this should be pulled out into quotation_pkg
3116 warn "$me _items_cust_bill_pkg cust_bill_pkg is quotation_pkg\n"
3118 # quotation_pkgs are never fees, so don't worry about the case where
3119 # part_pkg is undefined
3121 # and I guess they're never bundled either?
3122 if ( $cust_bill_pkg->setup != 0 ) {
3123 my $description = $desc;
3124 $description .= ' Setup'
3125 if $cust_bill_pkg->recur != 0
3126 || $discount_show_always
3127 || $cust_bill_pkg->recur_show_zero;
3129 # keep it consistent, please
3131 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3132 'description' => $description,
3133 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
3134 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitsetup),
3135 'quantity' => $cust_bill_pkg->quantity,
3136 'preref_html' => ( $opt{preref_callback}
3137 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3142 if ( $cust_bill_pkg->recur != 0 ) {
3145 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3146 'description' => "$desc (". $cust_bill_pkg->part_pkg->freq_pretty.")",
3147 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
3148 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitrecur),
3149 'quantity' => $cust_bill_pkg->quantity,
3150 'preref_html' => ( $opt{preref_callback}
3151 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3157 } elsif ( $cust_bill_pkg->pkgnum > 0 ) {
3158 # a "normal" package line item (not a quotation, not a fee, not a tax)
3160 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
3163 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3164 my $part_pkg = $cust_pkg->part_pkg;
3166 # which pkgpart to show for display purposes?
3167 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
3169 # start/end dates for invoice formats that do nonstandard
3171 my %item_dates = ();
3172 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
3173 unless $part_pkg->option('disable_line_item_date_ranges',1);
3175 # not normally used, but pass this to the template anyway
3176 $classname = $part_pkg->classname;
3178 if ( (!$type || $type eq 'S')
3179 && ( $cust_bill_pkg->setup != 0
3180 || $cust_bill_pkg->setup_show_zero
3185 warn "$me _items_cust_bill_pkg adding setup\n"
3188 my $description = $desc;
3189 $description .= ' Setup'
3190 if $cust_bill_pkg->recur != 0
3191 || $discount_show_always
3192 || $cust_bill_pkg->recur_show_zero;
3194 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3196 if $part_pkg->is_prepaid #for prepaid, "display the validity period
3197 # triggered by the recurring charge freq
3199 && $cust_bill_pkg->recur == 0
3200 && ! $cust_bill_pkg->recur_show_zero;
3205 # always pass the svc_label through to the template, even if
3206 # not displaying it as an ext_description
3207 my @svc_labels = map &{$escape_function}($_),
3208 $cust_pkg->h_labels_short($self->_date, undef, 'I');
3210 $svc_label = $svc_labels[0];
3212 unless ( $cust_pkg->part_pkg->hide_svc_detail
3213 || $cust_bill_pkg->hidden )
3216 push @d, @svc_labels
3217 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3218 # show the location label if it's not the customer's default
3219 # location, and we're not grouping items by location already
3220 if ( $cust_pkg->locationnum != $default_locationnum
3221 and !defined($locationnum) ) {
3222 my $loc = $cust_pkg->location_label;
3223 $loc = substr($loc, 0, $maxlength). '...'
3224 if $format eq 'latex' && length($loc) > $maxlength;
3225 push @d, &{$escape_function}($loc);
3228 } #unless hiding service details
3230 push @d, $cust_bill_pkg->details(%details_opt)
3231 if $cust_bill_pkg->recur == 0;
3233 if ( $cust_bill_pkg->hidden ) {
3234 $s->{amount} += $cust_bill_pkg->setup;
3235 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3236 push @{ $s->{ext_description} }, @d;
3240 description => $description,
3241 pkgpart => $pkgpart,
3242 pkgnum => $cust_bill_pkg->pkgnum,
3243 amount => $cust_bill_pkg->setup,
3244 setup_show_zero => $cust_bill_pkg->setup_show_zero,
3245 unit_amount => $cust_bill_pkg->unitsetup,
3246 quantity => $cust_bill_pkg->quantity,
3247 ext_description => \@d,
3248 svc_label => ($svc_label || ''),
3249 locationnum => $cust_pkg->locationnum, # sure, why not?
3255 if ( ( !$type || $type eq 'R' || $type eq 'U' )
3257 $cust_bill_pkg->recur != 0
3258 || $cust_bill_pkg->setup == 0
3259 || $discount_show_always
3260 || $cust_bill_pkg->recur_show_zero
3265 warn "$me _items_cust_bill_pkg adding recur/usage\n"
3268 my $is_summary = $display->summary;
3269 my $description = $desc;
3270 if ( $type eq 'U' and defined($r) ) {
3271 # don't just show the same description as the recur line
3272 $description = $self->mt('Usage charges');
3275 my $part_pkg = $cust_pkg->part_pkg;
3277 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3281 my @seconds = (); # for display of usage info
3284 #at least until cust_bill_pkg has "past" ranges in addition to
3285 #the "future" sdate/edate ones... see #3032
3286 my @dates = ( $self->_date );
3287 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
3288 push @dates, $prev->sdate if $prev;
3289 push @dates, undef if !$prev;
3291 my @svc_labels = map &{$escape_function}($_),
3292 $cust_pkg->h_labels_short(@dates, 'I');
3293 $svc_label = $svc_labels[0];
3295 # show service labels, unless...
3296 # the package is set not to display them
3297 unless ( $part_pkg->hide_svc_detail
3298 # or this is a tax-like line item
3299 || $cust_bill_pkg->itemdesc
3300 # or this is a hidden (bundled) line item
3301 || $cust_bill_pkg->hidden
3302 # or this is a usage summary line
3303 || $is_summary && $type && $type eq 'U'
3304 # or this is a usage line and there's a recurring line
3305 # for the package in the same section (which will
3306 # have service labels already)
3307 || ($type eq 'U' and defined($r))
3311 warn "$me _items_cust_bill_pkg adding service details\n"
3314 push @d, @svc_labels
3315 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3316 warn "$me _items_cust_bill_pkg done adding service details\n"
3319 # show the location label if it's not the customer's default
3320 # location, and we're not grouping items by location already
3321 if ( $cust_pkg->locationnum != $default_locationnum
3322 and !defined($locationnum) ) {
3323 my $loc = $cust_pkg->location_label;
3324 $loc = substr($loc, 0, $maxlength). '...'
3325 if $format eq 'latex' && length($loc) > $maxlength;
3326 push @d, &{$escape_function}($loc);
3329 # Display of seconds_since_sqlradacct:
3330 # On the invoice, when processing @detail_items, look for a field
3331 # named 'seconds'. This will contain total seconds for each
3332 # service, in the same order as @ext_description. For services
3333 # that don't support this it will show undef.
3334 if ( $conf->exists('svc_acct-usage_seconds')
3335 and ! $cust_bill_pkg->pkgpart_override ) {
3336 foreach my $cust_svc (
3337 $cust_pkg->h_cust_svc(@dates, 'I')
3340 # eval because not having any part_export_usage exports
3341 # is a fatal error, last_bill/_date because that's how
3342 # sqlradius_hour billing does it
3344 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
3346 push @seconds, $sec;
3348 } #if svc_acct-usage_seconds
3350 } # if we are showing service labels
3352 unless ( $is_summary ) {
3353 warn "$me _items_cust_bill_pkg adding details\n"
3356 #instead of omitting details entirely in this case (unwanted side
3357 # effects), just omit CDRs
3358 $details_opt{'no_usage'} = 1
3359 if $type && $type eq 'R';
3361 push @d, $cust_bill_pkg->details(%details_opt);
3364 warn "$me _items_cust_bill_pkg calculating amount\n"
3369 $amount = $cust_bill_pkg->recur;
3370 } elsif ($type eq 'R') {
3371 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
3372 } elsif ($type eq 'U') {
3373 $amount = $cust_bill_pkg->usage;
3376 if ( !$type || $type eq 'R' ) {
3378 warn "$me _items_cust_bill_pkg adding recur\n"
3382 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
3385 if ( $cust_bill_pkg->hidden ) {
3386 $r->{amount} += $amount;
3387 $r->{unit_amount} += $unit_amount;
3388 push @{ $r->{ext_description} }, @d;
3391 description => $description,
3392 pkgpart => $pkgpart,
3393 pkgnum => $cust_bill_pkg->pkgnum,
3395 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3396 unit_amount => $unit_amount,
3397 quantity => $cust_bill_pkg->quantity,
3399 ext_description => \@d,
3400 svc_label => ($svc_label || ''),
3401 locationnum => $cust_pkg->locationnum,
3403 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3406 } else { # $type eq 'U'
3408 warn "$me _items_cust_bill_pkg adding usage\n"
3411 if ( $cust_bill_pkg->hidden and defined($u) ) {
3412 # if this is a hidden package and there's already a usage
3413 # line for the bundle, add this package's total amount and
3414 # usage details to it
3415 $u->{amount} += $amount;
3416 push @{ $u->{ext_description} }, @d;
3417 } elsif ( $amount ) {
3418 # create a new usage line
3420 description => $description,
3421 pkgpart => $pkgpart,
3422 pkgnum => $cust_bill_pkg->pkgnum,
3425 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3427 ext_description => \@d,
3428 locationnum => $cust_pkg->locationnum,
3430 } # else this has no usage, so don't create a usage section
3433 } # recurring or usage with recurring charge
3435 } else { # taxes and fees
3437 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3440 # items of this kind should normally not have sdate/edate.
3442 'description' => $desc,
3443 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
3444 + $cust_bill_pkg->recur)
3447 } # if quotation / package line item / other line item
3449 # decide whether to show active discounts here
3451 # case 1: we are showing a single line for the package
3453 # case 2: we are showing a setup line for a package that has
3454 # no base recurring fee
3455 or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3456 # case 3: we are showing a recur line for a package that has
3457 # a base recurring fee
3458 or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3461 my $item_discount = $cust_bill_pkg->_item_discount;
3462 if ( $item_discount ) {
3463 # $item_discount->{amount} is negative
3465 if ( $d and $cust_bill_pkg->hidden ) {
3466 $d->{amount} += $item_discount->{amount};
3468 $d = $item_discount;
3469 $_ = &{$escape_function}($_) foreach @{ $d->{ext_description} };
3472 # update the active line (before the discount) to show the
3473 # original price (whether this is a hidden line or not)
3475 # quotation discounts keep track of setup and recur; invoice
3476 # discounts currently don't
3477 if ( exists $item_discount->{setup_amount} ) {
3479 $s->{amount} -= $item_discount->{setup_amount} if $s;
3480 $r->{amount} -= $item_discount->{recur_amount} if $r;
3484 # $active_line is the line item hashref for the line that will
3485 # show the original price
3486 # (use the recur or single line for the package, unless we're
3487 # showing a setup line for a package with no recurring fee)
3488 my $active_line = $r;
3489 if ( $type eq 'S' ) {
3492 $active_line->{amount} -= $item_discount->{amount};
3496 } # if there are any discounts
3497 } # if this is an appropriate place to show discounts
3499 } # foreach $display
3501 $discount_show_always = ($cust_bill_pkg->cust_bill_pkg_discount
3502 && $conf->exists('discount-show-always'));
3506 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3508 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3509 if exists($_->{amount});
3510 $_->{amount} =~ s/^\-0\.00$/0.00/;
3511 if (exists($_->{unit_amount})) {
3512 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3516 if $_->{amount} != 0
3517 || $discount_show_always
3518 || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3519 || ( $_->{_is_setup} && $_->{setup_show_zero} )
3523 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3530 =item _items_discounts_avail
3532 Returns an array of line item hashrefs representing available term discounts
3533 for this invoice. This makes the same assumptions that apply to term
3534 discounts in general: that the package is billed monthly, at a flat rate,
3535 with no usage charges. A prorated first month will be handled, as will
3536 a setup fee if the discount is allowed to apply to setup fees.
3540 sub _items_discounts_avail {
3543 #maybe move this method from cust_bill when quotations support discount_plans
3544 return () unless $self->can('discount_plans');
3545 my %plans = $self->discount_plans;
3547 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3548 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3552 my $plan = $plans{$months};
3554 my $term_total = sprintf('%.2f', $plan->discounted_total);
3555 my $percent = sprintf('%.0f',
3556 100 * (1 - $term_total / $plan->base_total) );
3557 my $permonth = sprintf('%.2f', $term_total / $months);
3558 my $detail = $self->mt('discount on item'). ' '.
3559 join(', ', map { "#$_" } $plan->pkgnums)
3562 # discounts for non-integer months don't work anyway
3563 $months = sprintf("%d", $months);
3566 description => $self->mt('Save [_1]% by paying for [_2] months',
3568 amount => $self->mt('[_1] ([_2] per month)',
3569 $term_total, $money_char.$permonth),
3570 ext_description => ($detail || ''),
3573 sort { $b <=> $a } keys %plans;