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;
319 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
320 unless $cust_main->payname
321 && $cust_main->payby !~ /^(CARD|DCRD|CHEK|DCHK)$/;
323 my $locale = $params{'locale'} || $cust_main->locale;
325 my %delimiters = ( 'latex' => [ '[@--', '--@]' ],
326 'html' => [ '<%=', '%>' ],
327 'template' => [ '{', '}' ],
330 warn "$me print_generic creating template\n"
333 # set the notice name here, and nowhere else.
334 my $notice_name = $params{notice_name}
335 || $conf->config('notice_name')
336 || $self->notice_name;
339 my $template = $params{template} ? $params{template} : $self->_agent_template;
340 my $templatefile = $self->template_conf. $format;
341 $templatefile .= "_$template"
342 if length($template) && $conf->exists($templatefile."_$template");
345 my @invoice_template = map "$_\n", $conf->config($templatefile)
346 or die "cannot load config data $templatefile";
348 if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
349 #change this to a die when the old code is removed
350 # it's been almost ten years, changing it to a die on the next release.
351 warn "old-style invoice template $templatefile; ".
352 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
353 #$old_latex = 'true';
354 #@invoice_template = _translate_old_latex_format(@invoice_template);
357 warn "$me print_generic creating T:T object\n"
360 my $text_template = new Text::Template(
362 SOURCE => \@invoice_template,
363 DELIMITERS => $delimiters{$format},
366 warn "$me print_generic compiling T:T object\n"
369 $text_template->compile()
370 or die "Can't compile $templatefile: $Text::Template::ERROR\n";
373 # additional substitution could possibly cause breakage in existing templates
376 'notes' => sub { map "$_", @_ },
377 'footer' => sub { map "$_", @_ },
378 'smallfooter' => sub { map "$_", @_ },
379 'returnaddress' => sub { map "$_", @_ },
380 'coupon' => sub { map "$_", @_ },
381 'summary' => sub { map "$_", @_ },
387 s/%%(.*)$/<!-- $1 -->/g;
388 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
389 s/\\begin\{enumerate\}/<ol>/g;
391 s/\\end\{enumerate\}/<\/ol>/g;
392 s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
401 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
403 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
409 s/\\hyphenation\{[\w\s\-]+}//;
414 'coupon' => sub { "" },
415 'summary' => sub { "" },
422 s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
423 s/\\begin\{enumerate\}//g;
425 s/\\end\{enumerate\}//g;
426 s/\\textbf\{(.*)\}/$1/g;
433 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
435 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
440 s/\\\\\*?\s*$/\n/; # dubious
441 s/\\hyphenation\{[\w\s\-]+}//;
445 'coupon' => sub { "" },
446 'summary' => sub { "" },
451 # hashes for differing output formats
452 my %nbsps = ( 'latex' => '~',
453 'html' => '', # '&nbps;' would be nice
454 'template' => '', # not used
456 my $nbsp = $nbsps{$format};
458 my %escape_functions = ( 'latex' => \&_latex_escape,
459 'html' => \&_html_escape_nbsp,#\&encode_entities,
460 'template' => sub { shift },
462 my $escape_function = $escape_functions{$format};
463 my $escape_function_nonbsp = ($format eq 'html')
464 ? \&_html_escape : $escape_function;
466 my %newline_tokens = ( 'latex' => '\\\\',
470 my $newline_token = $newline_tokens{$format};
472 warn "$me generating template variables\n"
475 # generate template variables
479 defined( $conf->config_orbase( "invoice_${format}returnaddress",
483 && length( $conf->config_orbase( "invoice_${format}returnaddress",
489 $returnaddress = join("\n",
490 $conf->config_orbase("invoice_${format}returnaddress", $template)
494 $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
496 my $convert_map = $convert_maps{$format}{'returnaddress'};
499 &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
504 } elsif ( grep /\S/, $conf->config('company_address', $cust_main->agentnum) ) {
506 my $convert_map = $convert_maps{$format}{'returnaddress'};
507 $returnaddress = join( "\n", &$convert_map(
508 map { s/( {2,})/'~' x length($1)/eg;
512 ( $conf->config('company_name', $cust_main->agentnum),
513 $conf->config('company_address', $cust_main->agentnum),
520 my $warning = "Couldn't find a return address; ".
521 "do you need to set the company_address configuration value?";
523 $returnaddress = $nbsp;
524 #$returnaddress = $warning;
528 warn "$me generating invoice data\n"
531 my $agentnum = $cust_main->agentnum;
536 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
537 'company_address' => join("\n", $conf->config('company_address', $agentnum) ). "\n",
538 'company_phonenum'=> scalar( $conf->config('company_phonenum', $agentnum) ),
539 'returnaddress' => $returnaddress,
540 'agent' => &$escape_function($cust_main->agent->agent),
542 #invoice/quotation info
543 'no_number' => $params{'no_number'},
544 'invnum' => ( $params{'no_number'} ? '' : $self->invnum ),
545 'quotationnum' => $self->quotationnum,
546 'no_date' => $params{'no_date'},
547 '_date' => ( $params{'no_date'} ? '' : $self->_date ),
548 # workaround for inconsistent behavior in the early plain text
549 # templates; see RT#28271
550 'date' => ( $params{'no_date'}
552 : ($format eq 'template'
554 : $self->time2str_local('long', $self->_date, $format)
557 'today' => $self->time2str_local('long', $today, $format),
558 'terms' => $self->terms,
559 'template' => $template, #params{'template'},
560 'notice_name' => $notice_name, # escape?
561 'current_charges' => sprintf("%.2f", $self->charged),
562 'duedate' => $self->due_date2str('rdate'), #date_format?
565 'custnum' => $cust_main->display_custnum,
566 'prospectnum' => $cust_main->prospectnum,
567 'agent_custid' => &$escape_function($cust_main->agent_custid),
568 ( map { $_ => &$escape_function($cust_main->$_()) } qw(
569 payname company address1 address2 city state zip fax
573 'ship_enable' => $cust_main->invoice_ship_address || $conf->exists('invoice-ship_address'),
574 'unitprices' => $conf->exists('invoice-unitprice'),
575 'smallernotes' => $conf->exists('invoice-smallernotes'),
576 'smallerfooter' => $conf->exists('invoice-smallerfooter'),
577 'balance_due_below_line' => $conf->exists('balance_due_below_line'),
579 #layout info -- would be fancy to calc some of this and bury the template
581 'topmargin' => scalar($conf->config('invoice_latextopmargin', $agentnum)),
582 'headsep' => scalar($conf->config('invoice_latexheadsep', $agentnum)),
583 'textheight' => scalar($conf->config('invoice_latextextheight', $agentnum)),
584 'extracouponspace' => scalar($conf->config('invoice_latexextracouponspace', $agentnum)),
585 'couponfootsep' => scalar($conf->config('invoice_latexcouponfootsep', $agentnum)),
586 'verticalreturnaddress' => $conf->exists('invoice_latexverticalreturnaddress', $agentnum),
587 'addresssep' => scalar($conf->config('invoice_latexaddresssep', $agentnum)),
588 'amountenclosedsep' => scalar($conf->config('invoice_latexcouponamountenclosedsep', $agentnum)),
589 'coupontoaddresssep' => scalar($conf->config('invoice_latexcoupontoaddresssep', $agentnum)),
590 'addcompanytoaddress' => $conf->exists('invoice_latexcouponaddcompanytoaddress', $agentnum),
592 # better hang on to conf_dir for a while (for old templates)
593 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
595 #these are only used when doing paged plaintext
602 $invoice_data{'emt'} = sub { &$escape_function($self->mt(@_)) };
603 # prototype here to silence warnings
604 $invoice_data{'time2str'} = sub ($;$$) { $self->time2str_local(@_, $format) };
606 my $min_sdate = 999999999999;
608 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
609 next unless $cust_bill_pkg->pkgnum > 0;
610 $min_sdate = $cust_bill_pkg->sdate
611 if length($cust_bill_pkg->sdate) && $cust_bill_pkg->sdate < $min_sdate;
612 $max_edate = $cust_bill_pkg->edate
613 if length($cust_bill_pkg->edate) && $cust_bill_pkg->edate > $max_edate;
616 $invoice_data{'bill_period'} = '';
617 $invoice_data{'bill_period'} =
618 $self->time2str_local('%e %h', $min_sdate, $format)
620 $self->time2str_local('%e %h', $max_edate, $format)
621 if ($max_edate != 0 && $min_sdate != 999999999999);
623 $invoice_data{finance_section} = '';
624 if ( $conf->config('finance_pkgclass') ) {
626 qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
627 $invoice_data{finance_section} = $pkg_class->categoryname;
629 $invoice_data{finance_amount} = '0.00';
630 $invoice_data{finance_section} ||= 'Finance Charges'; #avoid config confusion
632 my $countrydefault = $conf->config('countrydefault') || 'US';
633 foreach ( qw( address1 address2 city state zip country fax) ){
634 my $method = 'ship_'.$_;
635 $invoice_data{"ship_$_"} = $escape_function->($cust_main->$method);
637 if ( length($cust_main->ship_company) ) {
638 $invoice_data{'ship_company'} = $escape_function->($cust_main->ship_company);
640 $invoice_data{'ship_company'} = $escape_function->($cust_main->company);
642 $invoice_data{'ship_contact'} = $escape_function->($cust_main->contact);
643 $invoice_data{'ship_country'} = ''
644 if ( $invoice_data{'ship_country'} eq $countrydefault );
646 $invoice_data{'cid'} = $params{'cid'}
649 if ( $cust_main->country eq $countrydefault ) {
650 $invoice_data{'country'} = '';
652 $invoice_data{'country'} = &$escape_function(code2country($cust_main->country));
656 $invoice_data{'address'} = \@address;
659 ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
660 ? " (P.O. #". $cust_main->payinfo. ")"
664 push @address, $cust_main->company
665 if $cust_main->company;
666 push @address, $cust_main->address1;
667 push @address, $cust_main->address2
668 if $cust_main->address2;
670 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
671 push @address, $invoice_data{'country'}
672 if $invoice_data{'country'};
674 while (scalar(@address) < 5);
676 $invoice_data{'logo_file'} = $params{'logo_file'}
677 if $params{'logo_file'};
678 $invoice_data{'barcode_file'} = $params{'barcode_file'}
679 if $params{'barcode_file'};
680 $invoice_data{'barcode_img'} = $params{'barcode_img'}
681 if $params{'barcode_img'};
682 $invoice_data{'barcode_cid'} = $params{'barcode_cid'}
683 if $params{'barcode_cid'};
685 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
686 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
687 #my $balance_due = $self->owed + $pr_total - $cr_total;
688 my $balance_due = $self->owed + $pr_total;
690 # the sum of amount owed on all invoices
691 # (this is used in the summary & on the payment coupon)
692 $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
694 # flag telling this invoice to have a first-page summary
695 my $summarypage = '';
697 if ( $self->custnum && $self->invnum ) {
698 # XXX should be an FS::cust_bill method to set the defaults, instead
699 # of checking the type here
701 # info from customer's last invoice before this one, for some
703 $invoice_data{'last_bill'} = {};
705 my $last_bill = $self->previous_bill;
708 # "balance_date_range" unfortunately is unsuitable for this, since it
709 # cares about application dates. We want to know the sum of all
710 # _top-level transactions_ dated before the last invoice.
712 map "$_ WHERE _date <= ? AND custnum = ?", (
713 "SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill",
714 "SELECT -1 * COALESCE( SUM(amount), 0 ) FROM cust_credit",
715 "SELECT -1 * COALESCE( SUM(paid), 0 ) FROM cust_pay",
716 "SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund",
719 # the customer's current balance immediately after generating the last
722 my $last_bill_balance = $last_bill->charged;
724 my $delta = FS::Record->scalar_sql(
726 $last_bill->_date - 1,
729 $last_bill_balance += $delta;
732 $last_bill_balance = sprintf("%.2f", $last_bill_balance);
734 warn sprintf("LAST BILL: INVNUM %d, DATE %s, BALANCE %.2f\n\n",
736 $self->time2str_local('%D', $last_bill->_date),
739 # ("true_previous_balance" is a terrible name, but at least it's no
740 # longer stored in the database)
741 $invoice_data{'true_previous_balance'} = $last_bill_balance;
743 # the change in balance from immediately after that invoice
744 # to immediately before this one
745 my $before_this_bill_balance = 0;
747 my $delta = FS::Record->scalar_sql(
752 $before_this_bill_balance += $delta;
754 $invoice_data{'balance_adjustments'} =
755 sprintf("%.2f", $last_bill_balance - $before_this_bill_balance);
757 warn sprintf("BALANCE ADJUSTMENTS: %.2f\n\n",
758 $invoice_data{'balance_adjustments'}
761 # the sum of amount owed on all previous invoices
762 # ($pr_total is used elsewhere but not as $previous_balance)
763 $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
765 $invoice_data{'last_bill'}{'_date'} = $last_bill->_date; #unformatted
766 my (@payments, @credits);
767 # for formats that itemize previous payments
768 foreach my $cust_pay ( qsearch('cust_pay', {
769 'custnum' => $self->custnum,
770 '_date' => { op => '>=',
771 value => $last_bill->_date }
774 next if $cust_pay->_date > $self->_date;
776 '_date' => $cust_pay->_date,
777 'date' => $self->time2str_local('long', $cust_pay->_date, $format),
778 'payinfo' => $cust_pay->payby_payinfo_pretty,
779 'amount' => sprintf('%.2f', $cust_pay->paid),
781 # not concerned about applications
783 foreach my $cust_credit ( qsearch('cust_credit', {
784 'custnum' => $self->custnum,
785 '_date' => { op => '>=',
786 value => $last_bill->_date }
789 next if $cust_credit->_date > $self->_date;
791 '_date' => $cust_credit->_date,
792 'date' => $self->time2str_local('long', $cust_credit->_date, $format),
793 'creditreason'=> $cust_credit->reason,
794 'amount' => sprintf('%.2f', $cust_credit->amount),
797 $invoice_data{'previous_payments'} = \@payments;
798 $invoice_data{'previous_credits'} = \@credits;
800 # there is no $last_bill
801 $invoice_data{'true_previous_balance'} =
802 $invoice_data{'balance_adjustments'} =
803 $invoice_data{'previous_balance'} = '0.00';
804 $invoice_data{'previous_payments'} = [];
805 $invoice_data{'previous_credits'} = [];
808 if ( $conf->exists('invoice_usesummary', $agentnum) ) {
809 $invoice_data{'summarypage'} = $summarypage = 1;
812 } # if this is an invoice
814 warn "$me substituting variables in notes, footer, smallfooter\n"
817 my $tc = $self->template_conf;
818 my @include = ( [ $tc, 'notes' ],
819 [ 'invoice_', 'footer' ],
820 [ 'invoice_', 'smallfooter', ],
822 push @include, [ $tc, 'coupon', ]
823 unless $params{'no_coupon'};
825 foreach my $i (@include) {
827 my($base, $include) = @$i;
829 my $inc_file = $conf->key_orbase("$base$format$include", $template);
832 if ( $conf->exists($inc_file, $agentnum)
833 && length( $conf->config($inc_file, $agentnum) ) ) {
835 @inc_src = $conf->config($inc_file, $agentnum);
839 $inc_file = $conf->key_orbase("${base}latex$include", $template);
841 my $convert_map = $convert_maps{$format}{$include};
843 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
844 s/--\@\]/$delimiters{$format}[1]/g;
847 &$convert_map( $conf->config($inc_file, $agentnum) );
851 my $inc_tt = new Text::Template (
853 SOURCE => [ map "$_\n", @inc_src ],
854 DELIMITERS => $delimiters{$format},
855 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
857 unless ( $inc_tt->compile() ) {
858 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
859 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
863 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
865 $invoice_data{$include} =~ s/\n+$//
866 if ($format eq 'latex');
869 # let invoices use either of these as needed
870 $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
871 ? $cust_main->payinfo : '';
872 $invoice_data{'po_line'} =
873 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
874 ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
877 my %money_chars = ( 'latex' => '',
878 'html' => $conf->config('money_char') || '$',
881 my $money_char = $money_chars{$format};
884 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
885 'html' => $conf->config('money_char') || '$',
888 my $other_money_char = $other_money_chars{$format};
889 $invoice_data{'dollar'} = $other_money_char;
891 my %minus_signs = ( 'latex' => '$-$',
893 'template' => '- ' );
894 my $minus = $minus_signs{$format};
896 my @detail_items = ();
897 my @total_items = ();
901 $invoice_data{'detail_items'} = \@detail_items;
902 $invoice_data{'total_items'} = \@total_items;
903 $invoice_data{'buf'} = \@buf;
904 $invoice_data{'sections'} = \@sections;
906 warn "$me generating sections\n"
909 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
910 my $multisection = $conf->exists($tc.'sections', $cust_main->agentnum) ||
911 $conf->exists($tc.'sections_by_location', $cust_main->agentnum);
912 $invoice_data{'multisection'} = $multisection;
914 my $extra_sections = [];
915 my $extra_lines = ();
917 # default section ('Charges')
918 my $default_section = { 'description' => '',
923 # Previous Charges section
924 # subtotal is the first return value from $self->previous
925 my $previous_section;
926 # if the invoice has major sections, or if we're summarizing previous
927 # charges with a single line, or if we've been specifically told to put them
928 # in a section, create a section for previous charges:
929 if ( $multisection or
930 $conf->exists('previous_balance-summary_only') or
931 $conf->exists('previous_balance-section') ) {
933 $previous_section = { 'description' => $self->mt('Previous Charges'),
934 'subtotal' => $other_money_char.
935 sprintf('%.2f', $pr_total),
936 'summarized' => '', #why? $summarypage ? 'Y' : '',
938 $previous_section->{posttotal} = '0 / 30 / 60 / 90 days overdue '.
939 join(' / ', map { $cust_main->balance_date_range(@$_) }
940 $self->_prior_month30s
942 if $conf->exists('invoice_include_aging');
945 # otherwise put them in the main section
946 $previous_section = $default_section;
949 my $adjust_section = {
950 'description' => $self->mt('Credits, Payments, and Adjustments'),
951 'adjust_section' => 1,
952 'subtotal' => 0, # adjusted below
954 my $adjust_weight = _pkg_category($adjust_section->{description})
955 ? _pkg_category($adjust_section->{description})->weight
957 $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
958 # Note: 'sort_weight' here is actually a flag telling whether there is an
959 # explicit package category for the adjust section. If so, certain behavior
961 $adjust_section->{'sort_weight'} = $adjust_weight;
964 if ( $multisection ) {
965 ($extra_sections, $extra_lines) =
966 $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
967 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum)
968 && $self->can('_items_extra_usage_sections');
970 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
972 push @detail_items, @$extra_lines if $extra_lines;
974 # the code is written so that both methods can be used together, but
975 # we haven't yet changed the template to take advantage of that, so for
976 # now, treat them as mutually exclusive.
977 my %section_method = ( by_category => 1 );
978 if ( $conf->config($tc.'sections_method') eq 'location' ) {
979 %section_method = ( by_location => 1 );
982 $self->_items_sections( 'summary' => $summarypage,
983 'escape' => $escape_function_nonbsp,
984 'extra_sections' => $extra_sections,
988 push @sections, @$early;
989 $late_sections = $late;
991 if ( $conf->exists('svc_phone_sections')
992 && $self->can('_items_svc_phone_sections')
995 my ($phone_sections, $phone_lines) =
996 $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
997 push @{$late_sections}, @$phone_sections;
998 push @detail_items, @$phone_lines;
1000 if ( $conf->exists('voip-cust_accountcode_cdr')
1001 && $cust_main->accountcode_cdr
1002 && $self->can('_items_accountcode_cdr')
1005 my ($accountcode_section, $accountcode_lines) =
1006 $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
1007 if ( scalar(@$accountcode_lines) ) {
1008 push @{$late_sections}, $accountcode_section;
1009 push @detail_items, @$accountcode_lines;
1012 } else {# not multisection
1013 # make a default section
1014 push @sections, $default_section;
1015 # and calculate the finance charge total, since it won't get done otherwise.
1016 # and the default section total
1017 # XXX possibly finance_pkgclass should not be used in this manner?
1018 my @finance_charges;
1020 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1021 if ( $invoice_data{finance_section} and
1022 grep { $_->section eq $invoice_data{finance_section} }
1023 $cust_bill_pkg->cust_bill_pkg_display ) {
1024 # I think these are always setup fees, but just to be sure...
1025 push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1027 push @charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1030 $invoice_data{finance_amount} =
1031 sprintf('%.2f', sum( @finance_charges ) || 0);
1032 $default_section->{subtotal} = $other_money_char.
1033 sprintf('%.2f', sum( @charges ) || 0);
1036 # start setting up summary subtotals
1037 my @summary_subtotals;
1038 my $method = $conf->config('summary_subtotals_method');
1039 if ( $method and $method ne $conf->config($tc.'sections_method') ) {
1040 # then re-section them by the correct method
1041 my %section_method = ( by_category => 1 );
1042 if ( $conf->config('summary_subtotals_method') eq 'location' ) {
1043 %section_method = ( by_location => 1 );
1045 my ($early, $late) =
1046 $self->_items_sections( 'summary' => $summarypage,
1047 'escape' => $escape_function_nonbsp,
1048 'extra_sections' => $extra_sections,
1049 'format' => $format,
1052 foreach ( @$early ) {
1053 next if $_->{subtotal} == 0;
1054 $_->{subtotal} = $other_money_char.sprintf('%.2f', $_->{subtotal});
1055 push @summary_subtotals, $_;
1058 # subtotal sectioning is the same as for the actual invoice sections
1059 @summary_subtotals = @sections;
1062 # Hereafter, push sections to both @sections and @summary_subtotals
1063 # if they belong in both places (e.g. tax section). Late sections are
1064 # never in @summary_subtotals.
1066 # previous invoice balances in the Previous Charges section if there
1067 # is one, otherwise in the main detail section
1068 # (except if summary_only is enabled, don't show them at all)
1069 if ( $self->can('_items_previous') &&
1070 $self->enable_previous &&
1071 ! $conf->exists('previous_balance-summary_only') ) {
1073 warn "$me adding previous balances\n"
1076 foreach my $line_item ( $self->_items_previous ) {
1079 ref => $line_item->{'pkgnum'},
1080 pkgpart => $line_item->{'pkgpart'},
1081 #quantity => 1, # not really correct
1082 section => $previous_section, # which might be $default_section
1083 description => &$escape_function($line_item->{'description'}),
1084 ext_description => [ map { &$escape_function($_) }
1085 @{ $line_item->{'ext_description'} || [] }
1087 amount => $money_char . $line_item->{'amount'},
1088 product_code => $line_item->{'pkgpart'} || 'N/A',
1091 push @detail_items, $detail;
1092 push @buf, [ $detail->{'description'},
1093 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1099 if ( @pr_cust_bill && $self->enable_previous ) {
1100 push @buf, ['','-----------'];
1101 push @buf, [ $self->mt('Total Previous Balance'),
1102 $money_char. sprintf("%10.2f", $pr_total) ];
1106 if ( $conf->exists('svc_phone-did-summary') && $self->can('_did_summary') ) {
1107 warn "$me adding DID summary\n"
1110 my ($didsummary,$minutes) = $self->_did_summary;
1111 my $didsummary_desc = 'DID Activity Summary (since last invoice)';
1113 { 'description' => $didsummary_desc,
1114 'ext_description' => [ $didsummary, $minutes ],
1118 foreach my $section (@sections, @$late_sections) {
1120 # begin some normalization
1121 $section->{'subtotal'} = $section->{'amount'}
1123 && !exists($section->{subtotal})
1124 && exists($section->{amount});
1126 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
1127 if ( $invoice_data{finance_section} &&
1128 $section->{'description'} eq $invoice_data{finance_section} );
1130 $section->{'subtotal'} = $other_money_char.
1131 sprintf('%.2f', $section->{'subtotal'})
1134 # continue some normalization
1135 $section->{'amount'} = $section->{'subtotal'}
1139 if ( $section->{'description'} ) {
1140 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
1145 warn "$me setting options\n"
1149 $options{'section'} = $section if $multisection;
1150 $options{'format'} = $format;
1151 $options{'escape_function'} = $escape_function;
1152 $options{'no_usage'} = 1 unless $unsquelched;
1153 $options{'unsquelched'} = $unsquelched;
1154 $options{'summary_page'} = $summarypage;
1155 $options{'skip_usage'} =
1156 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
1157 $options{'preref_callback'} = $params{'preref_callback'};
1159 warn "$me searching for line items\n"
1162 foreach my $line_item ( $self->_items_pkg(%options),
1163 $self->_items_fee(%options) ) {
1165 warn "$me adding line item ".
1166 join(', ', map "$_=>".$line_item->{$_}, keys %$line_item). "\n"
1169 push @buf, ( [ $line_item->{'description'},
1170 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1172 map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}},
1175 $line_item->{'ref'} = $line_item->{'pkgnum'};
1176 $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()?
1177 $line_item->{'section'} = $section;
1178 $line_item->{'description'} = &$escape_function($line_item->{'description'});
1179 $line_item->{'amount'} = $money_char.$line_item->{'amount'};
1181 if ( length($line_item->{'unit_amount'}) ) {
1182 $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'};
1184 $line_item->{'ext_description'} ||= [];
1186 push @detail_items, $line_item;
1189 if ( $section->{'description'} ) {
1190 push @buf, ( ['','-----------'],
1191 [ $section->{'description'}. ' sub-total',
1192 $section->{'subtotal'} # already formatted this
1201 $invoice_data{current_less_finance} =
1202 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
1204 # if there's anything in the Previous Charges section, prepend it to the list
1205 if ( $pr_total and $previous_section ne $default_section ) {
1206 unshift @sections, $previous_section;
1207 # but not @summary_subtotals
1210 warn "$me adding taxes\n"
1213 # create a tax section if we don't yet have one
1214 my $tax_description = 'Taxes, Surcharges, and Fees';
1216 List::Util::first { $_->{description} eq $tax_description } @sections;
1217 if (!$tax_section) {
1218 $tax_section = { 'description' => $tax_description };
1219 push @sections, $tax_section if $multisection;
1221 $tax_section->{tax_section} = 1; # mark this section as containing taxes
1222 # if this is an existing tax section, we're merging the tax items into it.
1223 # grab the taxtotal that's already there, strip the money symbol if any
1224 my $taxtotal = $tax_section->{'subtotal'} || 0;
1225 $taxtotal =~ s/^\Q$other_money_char\E//;
1228 #my $tax_weight = _pkg_category($tax_section->{description})
1229 # ? _pkg_category($tax_section->{description})->weight
1231 #$tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
1232 #$tax_section->{'sort_weight'} = $tax_weight;
1234 my @items_tax = $self->_items_tax;
1235 foreach my $tax ( @items_tax ) {
1237 $taxtotal += $tax->{'amount'};
1239 my $description = &$escape_function( $tax->{'description'} );
1240 my $amount = sprintf( '%.2f', $tax->{'amount'} );
1242 if ( $multisection ) {
1244 push @detail_items, {
1245 ext_description => [],
1248 description => $description,
1249 amount => $money_char. $amount,
1251 section => $tax_section,
1256 push @total_items, {
1257 'total_item' => $description,
1258 'total_amount' => $other_money_char. $amount,
1263 push @buf,[ $description,
1264 $money_char. $amount,
1271 $total->{'total_item'} = $self->mt('Sub-total');
1272 $total->{'total_amount'} =
1273 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
1275 if ( $multisection ) {
1276 if ( $taxtotal > 0 ) {
1277 $tax_section->{'subtotal'} = $other_money_char.
1278 sprintf('%.2f', $taxtotal);
1279 $tax_section->{'pretotal'} = 'New charges sub-total '.
1280 $total->{'total_amount'};
1281 $tax_section->{'description'} = $self->mt($tax_description);
1283 # append it if it's not already there
1284 if ( !grep $tax_section, @sections ) {
1285 push @sections, $tax_section;
1286 push @summary_subtotals, $tax_section;
1291 unshift @total_items, $total;
1294 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1300 my %embolden_functions = (
1301 'latex' => sub { return '\textbf{'. shift(). '}' },
1302 'html' => sub { return '<b>'. shift(). '</b>' },
1303 'template' => sub { shift },
1305 my $embolden_function = $embolden_functions{$format};
1307 if ( $multisection ) {
1309 if ( $adjust_section->{'sort_weight'} ) {
1310 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1311 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1313 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1314 $other_money_char. sprintf('%.2f', $self->charged );
1319 if ( $self->can('_items_total') ) { # should always be true now
1321 # even for multisection, need plain text version
1323 my @new_total_items = $self->_items_total;
1325 push @buf,['','-----------'];
1327 foreach ( @new_total_items ) {
1328 my ($item, $amount) = ($_->{'total_item'}, $_->{'total_amount'});
1329 $_->{'total_item'} = &$embolden_function( $item );
1330 $_->{'total_amount'} = &$embolden_function( $other_money_char.$amount );
1331 # but if it's multisection, don't append to @total_items. the adjust
1332 # section has all this stuff
1333 push @total_items, $_ if !$multisection;
1334 push @buf, [ $item, $money_char.sprintf('%10.2f',$amount) ];
1337 push @buf, [ '', '' ];
1339 # if we're showing previous invoices, also show previous
1340 # credits and payments
1341 if ( $self->enable_previous
1342 and $self->can('_items_credits')
1343 and $self->can('_items_payments') )
1347 my $credittotal = 0;
1348 foreach my $credit (
1349 $self->_items_credits( 'template' => $template, 'trim_len' => 40 )
1353 $total->{'total_item'} = &$escape_function($credit->{'description'});
1354 $credittotal += $credit->{'amount'};
1355 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1356 if ( $multisection ) {
1357 push @detail_items, {
1358 ext_description => [],
1361 description => &$escape_function($credit->{'description'}),
1362 amount => $money_char . $credit->{'amount'},
1364 section => $adjust_section,
1367 push @total_items, $total;
1371 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1374 foreach my $credit (
1375 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1377 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1381 my $paymenttotal = 0;
1382 foreach my $payment (
1383 $self->_items_payments( 'template' => $template )
1386 $total->{'total_item'} = &$escape_function($payment->{'description'});
1387 $paymenttotal += $payment->{'amount'};
1388 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1389 if ( $multisection ) {
1390 push @detail_items, {
1391 ext_description => [],
1394 description => &$escape_function($payment->{'description'}),
1395 amount => $money_char . $payment->{'amount'},
1397 section => $adjust_section,
1400 push @total_items, $total;
1402 push @buf, [ $payment->{'description'},
1403 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1406 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1408 if ( $multisection ) {
1409 $adjust_section->{'subtotal'} = $other_money_char.
1410 sprintf('%.2f', $credittotal + $paymenttotal);
1412 #why this? because {sort_weight} forces the adjust_section to appear
1413 #in @extra_sections instead of @sections. obviously.
1414 push @sections, $adjust_section
1415 unless $adjust_section->{sort_weight};
1416 # do not summarize; adjustments there are shown according to
1420 # create Balance Due message
1423 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1424 $total->{'total_amount'} =
1425 &$embolden_function(
1426 $other_money_char. sprintf('%.2f', #why? $summarypage
1427 # ? $self->charged +
1428 # $self->billing_balance
1430 $self->owed + $pr_total
1433 if ( $multisection && !$adjust_section->{sort_weight} ) {
1434 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1435 $total->{'total_amount'};
1437 push @total_items, $total;
1439 push @buf,['','-----------'];
1440 push @buf,[$self->balance_due_msg, $money_char.
1441 sprintf("%10.2f", $balance_due ) ];
1444 if ( $conf->exists('previous_balance-show_credit')
1445 and $cust_main->balance < 0 ) {
1446 my $credit_total = {
1447 'total_item' => &$embolden_function($self->credit_balance_msg),
1448 'total_amount' => &$embolden_function(
1449 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1452 if ( $multisection ) {
1453 $adjust_section->{'posttotal'} .= $newline_token .
1454 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1457 push @total_items, $credit_total;
1459 push @buf,['','-----------'];
1460 push @buf,[$self->credit_balance_msg, $money_char.
1461 sprintf("%10.2f", -$cust_main->balance ) ];
1465 } #end of default total adding ! can('_items_total')
1467 if ( $multisection ) {
1468 if ( $conf->exists('svc_phone_sections')
1469 && $self->can('_items_svc_phone_sections')
1473 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1474 $total->{'total_amount'} =
1475 &$embolden_function(
1476 $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
1478 my $last_section = pop @sections;
1479 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1480 $total->{'total_amount'};
1481 push @sections, $last_section;
1483 push @sections, @$late_sections
1487 # make a discounts-available section, even without multisection
1488 if ( $conf->exists('discount-show_available')
1489 and my @discounts_avail = $self->_items_discounts_avail ) {
1490 my $discount_section = {
1491 'description' => $self->mt('Discounts Available'),
1496 push @sections, $discount_section; # do not summarize
1497 push @detail_items, map { +{
1498 'ref' => '', #should this be something else?
1499 'section' => $discount_section,
1500 'description' => &$escape_function( $_->{description} ),
1501 'amount' => $money_char . &$escape_function( $_->{amount} ),
1502 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1503 } } @discounts_avail;
1506 # not adding any more sections after this
1507 $invoice_data{summary_subtotals} = \@summary_subtotals;
1510 if ( $conf->exists('usage_class_summary')
1511 and $self->can('_items_usage_class_summary') ) {
1512 my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function);
1513 if ( @usage_subtotals ) {
1514 unshift @sections, $usage_subtotals[0]->{section}; # do not summarize
1515 unshift @detail_items, @usage_subtotals;
1519 # invoice history "section" (not really a section)
1520 # not to be included in any subtotals, completely independent of
1522 if ( $conf->exists('previous_invoice_history') and $cust_main->isa('FS::cust_main') ) {
1525 foreach my $cust_bill ( $cust_main->cust_bill ) {
1526 # XXX hardcoded format, and currently only 'charged'; add other fields
1527 # if they become necessary
1528 my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1529 $history{$date} ||= 0;
1530 $history{$date} += $cust_bill->charged;
1531 # just so we have a numeric sort key
1532 $monthorder{$date} ||= $cust_bill->_date;
1534 my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1536 my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1537 $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1540 # service locations: another option for template customization
1542 foreach my $item (@detail_items) {
1543 if ( $item->{locationnum} ) {
1544 $location_info{ $item->{locationnum} } ||= {
1545 FS::cust_location->by_key( $item->{locationnum} )->location_hash
1549 $invoice_data{location_info} = \%location_info;
1551 # debugging hook: call this with 'diag' => 1 to just get a hash of
1552 # the invoice variables
1553 return \%invoice_data if ( $params{'diag'} );
1555 # All sections and items are built; now fill in templates.
1556 my @includelist = ();
1557 push @includelist, 'summary' if $summarypage;
1558 foreach my $include ( @includelist ) {
1560 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1563 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1565 @inc_src = $conf->config($inc_file, $agentnum);
1569 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1571 my $convert_map = $convert_maps{$format}{$include};
1573 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1574 s/--\@\]/$delimiters{$format}[1]/g;
1577 &$convert_map( $conf->config($inc_file, $agentnum) );
1581 my $inc_tt = new Text::Template (
1583 SOURCE => [ map "$_\n", @inc_src ],
1584 DELIMITERS => $delimiters{$format},
1585 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1587 unless ( $inc_tt->compile() ) {
1588 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1589 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1593 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1595 $invoice_data{$include} =~ s/\n+$//
1596 if ($format eq 'latex');
1601 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1602 /invoice_lines\((\d*)\)/;
1603 $invoice_lines += $1 || scalar(@buf);
1606 die "no invoice_lines() functions in template?"
1607 if ( $format eq 'template' && !$wasfunc );
1609 if ($format eq 'template') {
1611 if ( $invoice_lines ) {
1612 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1613 $invoice_data{'total_pages'}++
1614 if scalar(@buf) % $invoice_lines;
1617 #setup subroutine for the template
1618 $invoice_data{invoice_lines} = sub {
1619 my $lines = shift || scalar(@buf);
1631 push @collect, split("\n",
1632 $text_template->fill_in( HASH => \%invoice_data )
1634 $invoice_data{'page'}++;
1636 map "$_\n", @collect;
1638 } else { # this is where we actually create the invoice
1640 warn "filling in template for invoice ". $self->invnum. "\n"
1642 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1645 $text_template->fill_in(HASH => \%invoice_data);
1649 sub notice_name { '('.shift->table.')'; }
1651 sub template_conf { 'invoice_'; }
1653 # helper routine for generating date ranges
1654 sub _prior_month30s {
1657 [ 1, 2592000 ], # 0-30 days ago
1658 [ 2592000, 5184000 ], # 30-60 days ago
1659 [ 5184000, 7776000 ], # 60-90 days ago
1660 [ 7776000, 0 ], # 90+ days ago
1663 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
1664 $_->[1] ? $self->_date - $_->[1] - 1 : '',
1669 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1671 Returns an postscript invoice, as a scalar.
1673 Options can be passed as a hashref (recommended) or as a list of time, template
1674 and then any key/value pairs for any other options.
1676 I<time> an optional value used to control the printing of overdue messages. The
1677 default is now. It isn't the date of the invoice; that's the `_date' field.
1678 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1679 L<Time::Local> and L<Date::Parse> for conversion functions.
1681 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1688 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1689 my $ps = generate_ps($file);
1691 unlink($barcodefile) if $barcodefile;
1696 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1698 Returns an PDF invoice, as a scalar.
1700 Options can be passed as a hashref (recommended) or as a list of time, template
1701 and then any key/value pairs for any other options.
1703 I<time> an optional value used to control the printing of overdue messages. The
1704 default is now. It isn't the date of the invoice; that's the `_date' field.
1705 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1706 L<Time::Local> and L<Date::Parse> for conversion functions.
1708 I<template>, if specified, is the name of a suffix for alternate invoices.
1710 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1717 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1718 my $pdf = generate_pdf($file);
1720 unlink($barcodefile) if $barcodefile;
1725 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1727 Returns an HTML invoice, as a scalar.
1729 I<time> an optional value used to control the printing of overdue messages. The
1730 default is now. It isn't the date of the invoice; that's the `_date' field.
1731 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1732 L<Time::Local> and L<Date::Parse> for conversion functions.
1734 I<template>, if specified, is the name of a suffix for alternate invoices.
1736 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1738 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1739 when emailing the invoice as part of a multipart/related MIME email.
1747 %params = %{ shift() };
1751 $params{'format'} = 'html';
1753 $self->print_generic( %params );
1756 # quick subroutine for print_latex
1758 # There are ten characters that LaTeX treats as special characters, which
1759 # means that they do not simply typeset themselves:
1760 # # $ % & ~ _ ^ \ { }
1762 # TeX ignores blanks following an escaped character; if you want a blank (as
1763 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1767 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1768 $value =~ s/([<>])/\$$1\$/g;
1774 encode_entities($value);
1778 sub _html_escape_nbsp {
1779 my $value = _html_escape(shift);
1780 $value =~ s/ +/ /g;
1784 #utility methods for print_*
1786 sub _translate_old_latex_format {
1787 warn "_translate_old_latex_format called\n"
1794 if ( $line =~ /^%%Detail\s*$/ ) {
1796 push @template, q![@--!,
1797 q! foreach my $_tr_line (@detail_items) {!,
1798 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1799 q! $_tr_line->{'description'} .= !,
1800 q! "\\tabularnewline\n~~".!,
1801 q! join( "\\tabularnewline\n~~",!,
1802 q! @{$_tr_line->{'ext_description'}}!,
1806 while ( ( my $line_item_line = shift )
1807 !~ /^%%EndDetail\s*$/ ) {
1808 $line_item_line =~ s/'/\\'/g; # nice LTS
1809 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1810 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1811 push @template, " \$OUT .= '$line_item_line';";
1814 push @template, '}',
1817 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1819 push @template, '[@--',
1820 ' foreach my $_tr_line (@total_items) {';
1822 while ( ( my $total_item_line = shift )
1823 !~ /^%%EndTotalDetails\s*$/ ) {
1824 $total_item_line =~ s/'/\\'/g; # nice LTS
1825 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1826 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1827 push @template, " \$OUT .= '$total_item_line';";
1830 push @template, '}',
1834 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1835 push @template, $line;
1841 warn "$_\n" foreach @template;
1853 my $conf = $self->conf;
1855 #check for an invoice-specific override
1856 return $self->invoice_terms if $self->invoice_terms;
1858 #check for a customer- specific override
1859 my $cust_main = $self->cust_main;
1860 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1864 $agentnum = $cust_main->agentnum;
1865 } elsif ( my $prospect_main = $self->prospect_main ) {
1866 $agentnum = $prospect_main->agentnum;
1869 #use configured default
1870 $conf->config('invoice_default_terms', $agentnum) || '';
1880 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1881 $duedate = $self->_date() + ( $1 * 86400 );
1892 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
1895 =item balance_due_msg
1899 sub balance_due_msg {
1901 my $msg = $self->mt('Balance Due');
1902 return $msg unless $self->terms; # huh?
1903 if ( !$self->conf->exists('invoice_show_prior_due_date')
1904 or $self->conf->exists('invoice_sections') ) {
1905 # if enabled, the due date is shown with Total New Charges (see
1906 # _items_total) and not here
1907 # (yes, or if invoice_sections is enabled; this is just for compatibility)
1908 if ( $self->due_date ) {
1909 $msg .= ' - ' . $self->mt('Please pay by'). ' '.
1910 $self->due_date2str('short');
1911 } elsif ( $self->terms ) {
1912 $msg .= ' - '. $self->mt($self->terms);
1918 =item balance_due_date
1922 sub balance_due_date {
1924 my $conf = $self->conf;
1926 my $terms = $self->terms;
1927 if ( $terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1928 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
1933 sub credit_balance_msg {
1935 $self->mt('Credit Balance Remaining')
1940 Returns a string with the date, for example: "3/20/2008", localized for the
1941 customer. Use _date_pretty_unlocalized for non-end-customer display use.
1947 $self->time2str_local('short', $self->_date);
1950 =item _date_pretty_unlocalized
1952 Returns a string with the date, for example: "3/20/2008", in the format
1953 configured for the back-office. Use _date_pretty for end-customer display use.
1957 sub _date_pretty_unlocalized {
1959 time2str($date_format, $self->_date);
1964 Emails this template.
1966 Options are passed as a hashref. Available options:
1972 If specified, overrides the default From: address.
1976 If specified, overrides the name of the sent document ("Invoice" or "Quotation")
1980 (Deprecated) If specified, is the name of a suffix for alternate template files.
1984 Options accepted by generate_email can also be used.
1990 my $opt = shift || {};
1991 if ($opt and !ref($opt)) {
1992 die ref($self). '->email called with positional parameters';
1995 return if $self->hide;
1997 my $error = send_email(
1998 $self->generate_email(
1999 'subject' => $self->email_subject($opt->{template}),
2000 %$opt, # template, etc.
2004 die "can't email: $error\n" if $error;
2007 =item generate_email OPTION => VALUE ...
2015 sender address, required
2019 alternate template name, optional
2023 email subject, optional
2027 notice name instead of "Invoice", optional
2031 Returns an argument list to be passed to L<FS::Misc::send_email>.
2037 sub generate_email {
2041 my $conf = $self->conf;
2043 my $me = '[FS::Template_Mixin::generate_email]';
2046 'from' => $args{'from'},
2047 'subject' => ($args{'subject'} || $self->email_subject),
2048 'custnum' => $self->custnum,
2049 'msgtype' => 'invoice',
2052 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
2054 my $cust_main = $self->cust_main;
2056 if (ref($args{'to'}) eq 'ARRAY') {
2057 $return{'to'} = $args{'to'};
2058 } elsif ( $cust_main ) {
2059 $return{'to'} = [ $cust_main->invoicing_list_emailonly ];
2062 my $tc = $self->template_conf;
2064 my @text; # array of lines
2065 my $html; # a big string
2066 my @related_parts; # will contain the text/HTML alternative, and images
2067 my $related; # will contain the multipart/related object
2069 if ( $conf->exists($tc. 'email_pdf') ) {
2070 if ( my $msgnum = $conf->config($tc.'email_pdf_msgnum') ) {
2072 warn "$me using '${tc}email_pdf_msgnum' in multipart message"
2075 my $msg_template = FS::msg_template->by_key($msgnum)
2076 or die "${tc}email_pdf_msgnum $msgnum not found\n";
2077 my %prepared = $msg_template->prepare(
2078 cust_main => $self->cust_main,
2082 @text = split(/(?=\n)/, $prepared{'text_body'});
2083 $html = $prepared{'html_body'};
2085 } elsif ( my @note = $conf->config($tc.'email_pdf_note') ) {
2087 warn "$me using '${tc}email_pdf_note' in multipart message"
2089 @text = $conf->config($tc.'email_pdf_note');
2090 $html = join('<BR>', @text);
2092 } # else use the plain text invoice
2097 warn "$me generating plain text invoice"
2100 # 'print_text' argument is no longer used
2101 @text = $self->print_text(\%args);
2105 my $text_part = build MIME::Entity (
2106 'Type' => 'text/plain',
2107 'Encoding' => 'quoted-printable',
2108 'Charset' => 'UTF-8',
2109 #'Encoding' => '7bit',
2111 'Disposition' => 'inline',
2116 if ( $conf->exists($tc.'html') ) {
2117 warn "$me generating HTML invoice"
2120 $args{'from'} =~ /\@([\w\.\-]+)/;
2121 my $from = $1 || 'example.com';
2122 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2125 my $agentnum = $cust_main ? $cust_main->agentnum
2126 : $self->prospect_main->agentnum;
2127 if ( defined($args{'template'}) && length($args{'template'})
2128 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
2131 $logo = 'logo_'. $args{'template'}. '.png';
2135 my $image_data = $conf->config_binary( $logo, $agentnum);
2137 push @related_parts, build MIME::Entity
2138 'Type' => 'image/png',
2139 'Encoding' => 'base64',
2140 'Data' => $image_data,
2141 'Filename' => 'logo.png',
2142 'Content-ID' => "<$content_id>",
2145 if ( ref($self) eq 'FS::cust_bill' && $conf->exists('invoice-barcode') ) {
2146 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2147 push @related_parts, build MIME::Entity
2148 'Type' => 'image/png',
2149 'Encoding' => 'base64',
2150 'Data' => $self->invoice_barcode(0),
2151 'Filename' => 'barcode.png',
2152 'Content-ID' => "<$barcode_content_id>",
2154 $args{'barcode_cid'} = $barcode_content_id;
2157 $html = $self->print_html({ 'cid'=>$content_id, %args });
2164 warn "$me creating HTML/text multipart message"
2167 $return{'nobody'} = 1;
2169 my $alternative = build MIME::Entity
2170 'Type' => 'multipart/alternative',
2171 #'Encoding' => '7bit',
2172 'Disposition' => 'inline'
2176 $alternative->add_part($text_part);
2179 $alternative->attach(
2180 'Type' => 'text/html',
2181 'Encoding' => 'quoted-printable',
2182 'Data' => [ '<html>',
2185 ' '. encode_entities($return{'subject'}),
2188 ' <body bgcolor="#e8e8e8">',
2193 'Disposition' => 'inline',
2194 #'Filename' => 'invoice.pdf',
2197 unshift @related_parts, $alternative;
2199 $related = build MIME::Entity 'Type' => 'multipart/related',
2200 'Encoding' => '7bit';
2202 #false laziness w/Misc::send_email
2203 $related->head->replace('Content-type',
2204 $related->mime_type.
2205 '; boundary="'. $related->head->multipart_boundary. '"'.
2206 '; type=multipart/alternative'
2209 $related->add_part($_) foreach @related_parts;
2213 my @otherparts = ();
2214 if ( ref($self) eq 'FS::cust_bill' && $cust_main->email_csv_cdr ) {
2216 push @otherparts, build MIME::Entity
2217 'Type' => 'text/csv',
2218 'Encoding' => '7bit',
2219 'Data' => [ map { "$_\n" }
2220 $self->call_details('prepend_billed_number' => 1)
2222 'Disposition' => 'attachment',
2223 'Filename' => 'usage-'. $self->invnum. '.csv',
2228 if ( $conf->exists($tc.'email_pdf') ) {
2233 # multipart/alternative
2239 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
2240 push @otherparts, $pdf;
2244 $return{'content-type'} = 'multipart/mixed'; # of the outer container
2246 $return{'mimeparts'} = [ $related, @otherparts ];
2247 $return{'type'} = 'multipart/related'; # of the first part
2249 $return{'mimeparts'} = [ $text_part, @otherparts ];
2250 $return{'type'} = 'text/plain';
2252 } elsif ( $html ) { # no PDF or CSV, strip the outer container
2253 $return{'mimeparts'} = \@related_parts;
2254 $return{'content-type'} = 'multipart/related';
2255 $return{'type'} = 'multipart/alternative';
2256 } else { # no HTML either
2257 $return{'body'} = \@text;
2258 $return{'content-type'} = 'text/plain';
2267 Returns a list suitable for passing to MIME::Entity->build(), representing
2268 this invoice as PDF attachment.
2275 'Type' => 'application/pdf',
2276 'Encoding' => 'base64',
2277 'Data' => [ $self->print_pdf(@_) ],
2278 'Disposition' => 'attachment',
2279 'Filename' => 'invoice-'. $self->invnum. '.pdf',
2283 =item _items_sections OPTIONS
2285 Generate section information for all items appearing on this invoice.
2286 This will only be called for multi-section invoices.
2288 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
2289 related display records (L<FS::cust_bill_pkg_display>) and organize
2290 them into two groups ("early" and "late" according to whether they come
2291 before or after the total), then into sections. A subtotal is calculated
2294 Section descriptions are returned in sort weight order. Each consists
2295 of a hash containing:
2297 description: the package category name, escaped
2298 subtotal: the total charges in that section
2299 tax_section: a flag indicating that the section contains only tax charges
2300 summarized: same as tax_section, for some reason
2301 sort_weight: the package category's sort weight
2303 If 'condense' is set on the display record, it also contains everything
2304 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
2305 coderefs to generate parts of the invoice. This is not advised.
2307 The method returns two arrayrefs, one of "early" sections and one of "late"
2310 OPTIONS may include:
2312 by_location: a flag to divide the invoice into sections by location.
2313 Each section hash will have a 'location' element containing a hashref of
2314 the location fields (see L<FS::cust_location>). The section description
2315 will be the location label, but the template can use any of the location
2316 fields to create a suitable label.
2318 by_category: a flag to divide the invoice into sections using display
2319 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
2320 behavior. Each section hash will have a 'category' element containing
2321 the section name from the display record (which probably equals the
2322 category name of the package, but may not in some cases).
2324 summary: a flag indicating that this is a summary-format invoice.
2325 Turning this on has the following effects:
2326 - Ignores display items with the 'summary' flag.
2327 - Places all sections in the "early" group even if they have post_total.
2328 - Creates sections for all non-disabled package categories, even if they
2329 have no charges on this invoice, as well as a section with no name.
2331 escape: an escape function to use for section titles.
2333 extra_sections: an arrayref of additional sections to return after the
2334 sorted list. If there are any of these, section subtotals exclude
2337 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
2338 passed through to C<_condense_section()>.
2342 use vars qw(%pkg_category_cache);
2343 sub _items_sections {
2347 my $escape = $opt{escape};
2348 my @extra_sections = @{ $opt{extra_sections} || [] };
2350 # $subtotal{$locationnum}{$categoryname} = amount.
2351 # if we're not using by_location, $locationnum is undef.
2352 # if we're not using by_category, you guessed it, $categoryname is undef.
2353 # if we're not using either one, we shouldn't be here in the first place...
2355 my %late_subtotal = ();
2358 # About tax items + multisection invoices:
2359 # If either invoice_*summary option is enabled, AND there is a
2360 # package category with the name of the tax, then there will be
2361 # a display record assigning the tax item to that category.
2363 # However, the taxes are always placed in the "Taxes, Surcharges,
2364 # and Fees" section regardless of that. The only effect of the
2365 # display record is to create a subtotal for the summary page.
2368 my $pkg_hash = $self->cust_pkg_hash;
2370 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2373 my $usage = $cust_bill_pkg->usage;
2376 if ( $opt{by_location} ) {
2377 if ( $cust_bill_pkg->pkgnum ) {
2378 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2383 $locationnum = undef;
2386 # as in _items_cust_pkg, if a line item has no display records,
2387 # cust_bill_pkg_display() returns a default record for it
2389 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2390 next if ( $display->summary && $opt{summary} );
2392 my $section = $display->section;
2393 my $type = $display->type;
2394 # Set $section = undef if we're sectioning by location and this
2395 # line item _has_ a location (i.e. isn't a fee).
2396 $section = undef if $locationnum;
2398 # set this flag if the section is not tax-only
2399 $not_tax{$locationnum}{$section} = 1
2400 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
2402 # there's actually a very important piece of logic buried in here:
2403 # incrementing $late_subtotal{$section} CREATES
2404 # $late_subtotal{$section}. keys(%late_subtotal) is later used
2405 # to define the list of late sections, and likewise keys(%subtotal).
2406 # When _items_cust_bill_pkg is called to generate line items for
2407 # real, it will be called with 'section' => $section for each
2409 if ( $display->post_total && !$opt{summary} ) {
2410 if (! $type || $type eq 'S') {
2411 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2412 if $cust_bill_pkg->setup != 0
2413 || $cust_bill_pkg->setup_show_zero;
2417 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
2418 if $cust_bill_pkg->recur != 0
2419 || $cust_bill_pkg->recur_show_zero;
2422 if ($type && $type eq 'R') {
2423 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2424 if $cust_bill_pkg->recur != 0
2425 || $cust_bill_pkg->recur_show_zero;
2428 if ($type && $type eq 'U') {
2429 $late_subtotal{$locationnum}{$section} += $usage
2430 unless scalar(@extra_sections);
2433 } else { # it's a pre-total (normal) section
2435 # skip tax items unless they're explicitly included in a section
2436 next if $cust_bill_pkg->pkgnum == 0 and
2437 ! $cust_bill_pkg->feepart and
2440 if ( $type eq 'S' ) {
2441 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2442 if $cust_bill_pkg->setup != 0
2443 || $cust_bill_pkg->setup_show_zero;
2444 } elsif ( $type eq 'R' ) {
2445 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2446 if $cust_bill_pkg->recur != 0
2447 || $cust_bill_pkg->recur_show_zero;
2448 } elsif ( $type eq 'U' ) {
2449 $subtotal{$locationnum}{$section} += $usage
2450 unless scalar(@extra_sections);
2451 } elsif ( !$type ) {
2452 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2453 + $cust_bill_pkg->recur;
2462 %pkg_category_cache = ();
2464 # summary invoices need subtotals for all non-disabled package categories,
2465 # even if they're zero
2466 # but currently assume that there are no location sections, or at least
2467 # that the summary page doesn't care about them
2468 if ( $opt{summary} ) {
2469 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2470 $subtotal{''}{$category->categoryname} ||= 0;
2472 $subtotal{''}{''} ||= 0;
2476 foreach my $post_total (0,1) {
2478 my $s = $post_total ? \%late_subtotal : \%subtotal;
2479 foreach my $locationnum (keys %$s) {
2480 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2482 'subtotal' => $s->{$locationnum}{$sectionname},
2483 'post_total' => $post_total,
2486 if ( $locationnum ) {
2487 $section->{'locationnum'} = $locationnum;
2488 my $location = FS::cust_location->by_key($locationnum);
2489 $section->{'description'} = &{ $escape }($location->location_label);
2490 # Better ideas? This will roughly group them by proximity,
2491 # which alpha sorting on any of the address fields won't.
2492 # Sorting by locationnum is meaningless.
2493 # We have to sort on _something_ or the order may change
2494 # randomly from one invoice to the next, which will confuse
2496 $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
2498 $section->{'location'} = {
2499 label_prefix => &{ $escape }($location->label_prefix),
2500 map { $_ => &{ $escape }($location->get($_)) }
2504 $section->{'category'} = $sectionname;
2505 $section->{'description'} = &{ $escape }($sectionname);
2506 if ( _pkg_category($sectionname) ) {
2507 $section->{'sort_weight'} = _pkg_category($sectionname)->weight;
2508 if ( _pkg_category($sectionname)->condense ) {
2509 $section = { %$section, $self->_condense_section($opt{format}) };
2513 if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
2514 # then it's a tax-only section
2515 $section->{'summarized'} = 'Y';
2516 $section->{'tax_section'} = 'Y';
2518 push @these, $section;
2519 } # foreach $sectionname
2520 } #foreach $locationnum
2521 push @these, @extra_sections if $post_total == 0;
2522 # need an alpha sort for location sections, because postal codes can
2524 $sections[ $post_total ] = [ sort {
2525 $opt{'by_location'} ?
2526 ($a->{sort_weight} cmp $b->{sort_weight}) :
2527 ($a->{sort_weight} <=> $b->{sort_weight})
2529 } #foreach $post_total
2531 return @sections; # early, late
2534 #helper subs for above
2538 $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2542 my $categoryname = shift;
2543 $pkg_category_cache{$categoryname} ||=
2544 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2547 my %condensed_format = (
2548 'label' => [ qw( Description Qty Amount ) ],
2550 sub { shift->{description} },
2551 sub { shift->{quantity} },
2552 sub { my($href, %opt) = @_;
2553 ($opt{dollar} || ''). $href->{amount};
2556 'align' => [ qw( l r r ) ],
2557 'span' => [ qw( 5 1 1 ) ], # unitprices?
2558 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
2561 sub _condense_section {
2562 my ( $self, $format ) = ( shift, shift );
2564 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2565 qw( description_generator
2568 total_line_generator
2573 sub _condensed_generator_defaults {
2574 my ( $self, $format ) = ( shift, shift );
2575 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2584 sub _condensed_header_generator {
2585 my ( $self, $format ) = ( shift, shift );
2587 my ( $f, $prefix, $suffix, $separator, $column ) =
2588 _condensed_generator_defaults($format);
2590 if ($format eq 'latex') {
2591 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2592 $suffix = "\\\\\n\\hline";
2595 sub { my ($d,$a,$s,$w) = @_;
2596 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2598 } elsif ( $format eq 'html' ) {
2599 $prefix = '<th></th>';
2603 sub { my ($d,$a,$s,$w) = @_;
2604 return qq!<th align="$html_align{$a}">$d</th>!;
2612 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2614 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2617 $prefix. join($separator, @result). $suffix;
2622 sub _condensed_description_generator {
2623 my ( $self, $format ) = ( shift, shift );
2625 my ( $f, $prefix, $suffix, $separator, $column ) =
2626 _condensed_generator_defaults($format);
2628 my $money_char = '$';
2629 if ($format eq 'latex') {
2630 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2632 $separator = " & \n";
2634 sub { my ($d,$a,$s,$w) = @_;
2635 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2637 $money_char = '\\dollar';
2638 }elsif ( $format eq 'html' ) {
2639 $prefix = '"><td align="center"></td>';
2643 sub { my ($d,$a,$s,$w) = @_;
2644 return qq!<td align="$html_align{$a}">$d</td>!;
2646 #$money_char = $conf->config('money_char') || '$';
2647 $money_char = ''; # this is madness
2655 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2657 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2659 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2660 map { $f->{$_}->[$i] } qw(align span width)
2664 $prefix. join( $separator, @result ). $suffix;
2669 sub _condensed_total_generator {
2670 my ( $self, $format ) = ( shift, shift );
2672 my ( $f, $prefix, $suffix, $separator, $column ) =
2673 _condensed_generator_defaults($format);
2676 if ($format eq 'latex') {
2679 $separator = " & \n";
2681 sub { my ($d,$a,$s,$w) = @_;
2682 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2684 }elsif ( $format eq 'html' ) {
2688 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2690 sub { my ($d,$a,$s,$w) = @_;
2691 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2700 # my $r = &{$f->{fields}->[$i]}(@args);
2701 # $r .= ' Total' unless $i;
2703 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2705 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
2706 map { $f->{$_}->[$i] } qw(align span width)
2710 $prefix. join( $separator, @result ). $suffix;
2715 =item total_line_generator FORMAT
2717 Returns a coderef used for generation of invoice total line items for this
2718 usage_class. FORMAT is either html or latex
2722 # should not be used: will have issues with hash element names (description vs
2723 # total_item and amount vs total_amount -- another array of functions?
2725 sub _condensed_total_line_generator {
2726 my ( $self, $format ) = ( shift, shift );
2728 my ( $f, $prefix, $suffix, $separator, $column ) =
2729 _condensed_generator_defaults($format);
2732 if ($format eq 'latex') {
2735 $separator = " & \n";
2737 sub { my ($d,$a,$s,$w) = @_;
2738 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2740 }elsif ( $format eq 'html' ) {
2744 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2746 sub { my ($d,$a,$s,$w) = @_;
2747 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2756 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2758 &{$column}( &{$f->{fields}->[$i]}(@args),
2759 map { $f->{$_}->[$i] } qw(align span width)
2763 $prefix. join( $separator, @result ). $suffix;
2768 =item _items_pkg [ OPTIONS ]
2770 Return line item hashes for each package item on this invoice. Nearly
2773 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
2775 OPTIONS are passed through to _items_cust_bill_pkg, and should include
2776 'format' and 'escape_function' at minimum.
2778 To produce items for a specific invoice section, OPTIONS should include
2779 'section', a hashref containing 'category' and/or 'locationnum' keys.
2781 'section' may also contain a key named 'condensed'. If this is present
2782 and has a true value, _items_pkg will try to merge identical items into items
2783 with 'quantity' equal to the number of items (not the sum of their separate
2784 quantities, for some reason).
2790 # The order of these is important. Bundled line items will be merged into
2791 # the most recent non-hidden item, so it needs to be the one with:
2793 # - the same start date
2794 # - no pkgpart_override
2796 # So: sort by pkgnum,
2798 # then sort the base line item before any overrides
2799 # then sort hidden before non-hidden add-ons
2800 # then sort by override pkgpart (for consistency)
2801 sort { $a->pkgnum <=> $b->pkgnum or
2802 $a->sdate <=> $b->sdate or
2803 ($a->pkgpart_override ? 0 : -1) or
2804 ($b->pkgpart_override ? 0 : 1) or
2805 $b->hidden cmp $a->hidden or
2806 $a->pkgpart_override <=> $b->pkgpart_override
2808 # and of course exclude taxes and fees
2809 grep { $_->pkgnum > 0 } $self->cust_bill_pkg;
2815 my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
2816 my $escape_function = $options{escape_function};
2819 foreach my $cust_bill_pkg (@cust_bill_pkg) {
2820 # cache this, so we don't look it up again in every section
2821 my $part_fee = $cust_bill_pkg->get('part_fee')
2822 || $cust_bill_pkg->part_fee;
2823 $cust_bill_pkg->set('part_fee', $part_fee);
2825 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
2826 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
2829 if ( exists($options{section}) and exists($options{section}{category}) )
2831 my $categoryname = $options{section}{category};
2832 # then filter for items that have that section
2833 if ( $part_fee->categoryname ne $categoryname ) {
2834 warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
2837 } # otherwise include them all in the main section
2838 # XXX what to do when sectioning by location?
2841 my %base_invnums; # invnum => invoice date
2842 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
2843 if ($_->base_invnum) {
2844 # XXX what if base_bill has been voided?
2845 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
2846 my $base_date = $self->time2str_local('short', $base_bill->_date)
2848 $base_invnums{$_->base_invnum} = $base_date || '';
2851 foreach (sort keys(%base_invnums)) {
2852 next if $_ == $self->invnum;
2853 # per convention, we must escape ext_description lines
2855 &{$escape_function}(
2856 $self->mt('from invoice #[_1] on [_2]', $_, $base_invnums{$_})
2859 my $desc = $part_fee->itemdesc_locale($self->cust_main->locale);
2860 # but not escape the base description line
2863 { feepart => $cust_bill_pkg->feepart,
2864 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
2865 description => $desc,
2866 ext_description => \@ext_desc
2877 warn "$me _items_pkg searching for all package line items\n"
2880 my @cust_bill_pkg = $self->_items_nontax;
2882 warn "$me _items_pkg filtering line items\n"
2884 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2886 if ($options{section} && $options{section}->{condensed}) {
2888 warn "$me _items_pkg condensing section\n"
2892 local $Storable::canonical = 1;
2893 foreach ( @items ) {
2895 delete $item->{ref};
2896 delete $item->{ext_description};
2897 my $key = freeze($item);
2898 $itemshash{$key} ||= 0;
2899 $itemshash{$key} ++; # += $item->{quantity};
2901 @items = sort { $a->{description} cmp $b->{description} }
2902 map { my $i = thaw($_);
2903 $i->{quantity} = $itemshash{$_};
2905 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
2911 warn "$me _items_pkg returning ". scalar(@items). " items\n"
2918 return 0 unless $a->itemdesc cmp $b->itemdesc;
2919 return -1 if $b->itemdesc eq 'Tax';
2920 return 1 if $a->itemdesc eq 'Tax';
2921 return -1 if $b->itemdesc eq 'Other surcharges';
2922 return 1 if $a->itemdesc eq 'Other surcharges';
2923 $a->itemdesc cmp $b->itemdesc;
2928 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
2929 $self->cust_bill_pkg;
2930 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2932 if ( $self->conf->exists('always_show_tax') ) {
2933 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
2934 if (0 == grep { $_->{description} eq $itemdesc } @items) {
2936 { 'description' => $itemdesc,
2943 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
2945 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
2946 list of hashrefs describing the line items they generate on the invoice.
2948 OPTIONS may include:
2950 format: the invoice format.
2952 escape_function: the function used to escape strings.
2954 DEPRECATED? (expensive, mostly unused?)
2955 format_function: the function used to format CDRs.
2957 section: a hashref containing 'category' and/or 'locationnum'; if this
2958 is present, only returns line items that belong to that category and/or
2959 location (whichever is defined).
2961 multisection: a flag indicating that this is a multisection invoice,
2962 which does something complicated.
2964 preref_callback: coderef run for each line item, code should return HTML to be
2965 displayed before that line item (quotations only)
2967 Returns a list of hashrefs, each of which may contain:
2969 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
2970 ext_description, which is an arrayref of detail lines to show below
2975 sub _items_cust_bill_pkg {
2977 my $conf = $self->conf;
2978 my $cust_bill_pkgs = shift;
2981 my $format = $opt{format} || '';
2982 my $escape_function = $opt{escape_function} || sub { shift };
2983 my $format_function = $opt{format_function} || '';
2984 my $no_usage = $opt{no_usage} || '';
2985 my $unsquelched = $opt{unsquelched} || ''; #unused
2986 my ($section, $locationnum, $category);
2987 if ( $opt{section} ) {
2988 $category = $opt{section}->{category};
2989 $locationnum = $opt{section}->{locationnum};
2991 my $summary_page = $opt{summary_page} || ''; #unused
2992 my $multisection = defined($category) || defined($locationnum);
2993 my $discount_show_always = 0;
2995 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 40;
2997 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
2999 # for location labels: use default location on the invoice date
3000 my $default_locationnum;
3001 if ( $self->custnum ) {
3003 my @h_search = FS::h_cust_main->sql_h_search($self->_date);
3004 $h_cust_main = qsearchs({
3005 'table' => 'h_cust_main',
3006 'hashref' => { custnum => $self->custnum },
3007 'extra_sql' => $h_search[1],
3008 'addl_from' => $h_search[3],
3010 $default_locationnum = $h_cust_main->ship_locationnum;
3011 } elsif ( $self->prospectnum ) {
3012 my $cust_location = qsearchs('cust_location',
3013 { prospectnum => $self->prospectnum,
3015 $default_locationnum = $cust_location->locationnum if $cust_location;
3018 my @b = (); # accumulator for the line item hashes that we'll return
3019 my ($s, $r, $u, $d) = ( undef, undef, undef, undef );
3020 # the 'current' line item hashes for setup, recur, usage, discount
3021 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
3023 # if the current line item is waiting to go out, and the one we're about
3024 # to start is not bundled, then push out the current one and start a new
3026 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3027 if ( $_ && !$cust_bill_pkg->hidden ) {
3028 $_->{amount} = sprintf( "%.2f", $_->{amount} );
3029 $_->{amount} =~ s/^\-0\.00$/0.00/;
3030 if (exists($_->{unit_amount})) {
3031 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3034 if $_->{amount} != 0
3035 || $discount_show_always
3036 || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3037 || ( $_->{_is_setup} && $_->{setup_show_zero} )
3043 if ( $locationnum ) {
3044 # this is a location section; skip packages that aren't at this
3046 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
3047 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
3051 # Consider display records for this item to determine if it belongs
3052 # in this section. Note that if there are no display records, there
3053 # will be a default pseudo-record that includes all charge types
3054 # and has no section name.
3055 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
3056 ? $cust_bill_pkg->cust_bill_pkg_display
3057 : ( $cust_bill_pkg );
3059 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
3060 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
3063 if ( defined($category) ) {
3064 # then this is a package category section; process all display records
3065 # that belong to this section.
3066 @cust_bill_pkg_display = grep { $_->section eq $category }
3067 @cust_bill_pkg_display;
3069 # otherwise, process all display records that aren't usage summaries
3070 # (I don't think there should be usage summaries if you aren't using
3071 # category sections, but this is the historical behavior)
3072 @cust_bill_pkg_display = grep { !$_->summary }
3073 @cust_bill_pkg_display;
3076 my $classname = ''; # package class name, will fill in later
3078 foreach my $display (@cust_bill_pkg_display) {
3080 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
3081 $display->billpkgdisplaynum. "\n"
3084 my $type = $display->type;
3086 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
3087 $desc = substr($desc, 0, $maxlength). '...'
3088 if $format eq 'latex' && length($desc) > $maxlength;
3090 my %details_opt = ( 'format' => $format,
3091 'escape_function' => $escape_function,
3092 'format_function' => $format_function,
3093 'no_usage' => $opt{'no_usage'},
3096 if ( ref($cust_bill_pkg) eq 'FS::quotation_pkg' ) {
3097 # XXX this should be pulled out into quotation_pkg
3099 warn "$me _items_cust_bill_pkg cust_bill_pkg is quotation_pkg\n"
3101 # quotation_pkgs are never fees, so don't worry about the case where
3102 # part_pkg is undefined
3104 # and I guess they're never bundled either?
3105 if ( $cust_bill_pkg->setup != 0 ) {
3106 my $description = $desc;
3107 $description .= ' Setup'
3108 if $cust_bill_pkg->recur != 0
3109 || $discount_show_always
3110 || $cust_bill_pkg->recur_show_zero;
3112 # keep it consistent, please
3114 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3115 'description' => $description,
3116 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
3117 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitsetup),
3118 'quantity' => $cust_bill_pkg->quantity,
3119 'preref_html' => ( $opt{preref_callback}
3120 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3125 if ( $cust_bill_pkg->recur != 0 ) {
3128 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3129 'description' => "$desc (". $cust_bill_pkg->part_pkg->freq_pretty.")",
3130 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
3131 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitrecur),
3132 'quantity' => $cust_bill_pkg->quantity,
3133 'preref_html' => ( $opt{preref_callback}
3134 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3140 } elsif ( $cust_bill_pkg->pkgnum > 0 ) {
3141 # a "normal" package line item (not a quotation, not a fee, not a tax)
3143 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
3146 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3147 my $part_pkg = $cust_pkg->part_pkg;
3149 # which pkgpart to show for display purposes?
3150 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
3152 # start/end dates for invoice formats that do nonstandard
3154 my %item_dates = ();
3155 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
3156 unless $part_pkg->option('disable_line_item_date_ranges',1);
3158 # not normally used, but pass this to the template anyway
3159 $classname = $part_pkg->classname;
3161 if ( (!$type || $type eq 'S')
3162 && ( $cust_bill_pkg->setup != 0
3163 || $cust_bill_pkg->setup_show_zero
3168 warn "$me _items_cust_bill_pkg adding setup\n"
3171 my $description = $desc;
3172 $description .= ' Setup'
3173 if $cust_bill_pkg->recur != 0
3174 || $discount_show_always
3175 || $cust_bill_pkg->recur_show_zero;
3177 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3179 if $part_pkg->is_prepaid #for prepaid, "display the validity period
3180 # triggered by the recurring charge freq
3182 && $cust_bill_pkg->recur == 0
3183 && ! $cust_bill_pkg->recur_show_zero;
3188 # always pass the svc_label through to the template, even if
3189 # not displaying it as an ext_description
3190 my @svc_labels = map &{$escape_function}($_),
3191 $cust_pkg->h_labels_short($self->_date, undef, 'I');
3193 $svc_label = $svc_labels[0];
3195 unless ( $cust_pkg->part_pkg->hide_svc_detail
3196 || $cust_bill_pkg->hidden )
3199 push @d, @svc_labels
3200 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3201 # show the location label if it's not the customer's default
3202 # location, and we're not grouping items by location already
3203 if ( $cust_pkg->locationnum != $default_locationnum
3204 and !defined($locationnum) ) {
3205 my $loc = $cust_pkg->location_label;
3206 $loc = substr($loc, 0, $maxlength). '...'
3207 if $format eq 'latex' && length($loc) > $maxlength;
3208 push @d, &{$escape_function}($loc);
3211 } #unless hiding service details
3213 push @d, $cust_bill_pkg->details(%details_opt)
3214 if $cust_bill_pkg->recur == 0;
3216 if ( $cust_bill_pkg->hidden ) {
3217 $s->{amount} += $cust_bill_pkg->setup;
3218 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3219 push @{ $s->{ext_description} }, @d;
3223 description => $description,
3224 pkgpart => $pkgpart,
3225 pkgnum => $cust_bill_pkg->pkgnum,
3226 amount => $cust_bill_pkg->setup,
3227 setup_show_zero => $cust_bill_pkg->setup_show_zero,
3228 unit_amount => $cust_bill_pkg->unitsetup,
3229 quantity => $cust_bill_pkg->quantity,
3230 ext_description => \@d,
3231 svc_label => ($svc_label || ''),
3232 locationnum => $cust_pkg->locationnum, # sure, why not?
3238 if ( ( !$type || $type eq 'R' || $type eq 'U' )
3240 $cust_bill_pkg->recur != 0
3241 || $cust_bill_pkg->setup == 0
3242 || $discount_show_always
3243 || $cust_bill_pkg->recur_show_zero
3248 warn "$me _items_cust_bill_pkg adding recur/usage\n"
3251 my $is_summary = $display->summary;
3252 my $description = $desc;
3253 if ( $type eq 'U' and defined($r) ) {
3254 # don't just show the same description as the recur line
3255 $description = $self->mt('Usage charges');
3258 my $part_pkg = $cust_pkg->part_pkg;
3260 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3264 my @seconds = (); # for display of usage info
3267 #at least until cust_bill_pkg has "past" ranges in addition to
3268 #the "future" sdate/edate ones... see #3032
3269 my @dates = ( $self->_date );
3270 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
3271 push @dates, $prev->sdate if $prev;
3272 push @dates, undef if !$prev;
3274 my @svc_labels = map &{$escape_function}($_),
3275 $cust_pkg->h_labels_short(@dates, 'I');
3276 $svc_label = $svc_labels[0];
3278 # show service labels, unless...
3279 # the package is set not to display them
3280 unless ( $part_pkg->hide_svc_detail
3281 # or this is a tax-like line item
3282 || $cust_bill_pkg->itemdesc
3283 # or this is a hidden (bundled) line item
3284 || $cust_bill_pkg->hidden
3285 # or this is a usage summary line
3286 || $is_summary && $type && $type eq 'U'
3287 # or this is a usage line and there's a recurring line
3288 # for the package in the same section (which will
3289 # have service labels already)
3290 || ($type eq 'U' and defined($r))
3294 warn "$me _items_cust_bill_pkg adding service details\n"
3297 push @d, @svc_labels
3298 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3299 warn "$me _items_cust_bill_pkg done adding service details\n"
3302 # show the location label if it's not the customer's default
3303 # location, and we're not grouping items by location already
3304 if ( $cust_pkg->locationnum != $default_locationnum
3305 and !defined($locationnum) ) {
3306 my $loc = $cust_pkg->location_label;
3307 $loc = substr($loc, 0, $maxlength). '...'
3308 if $format eq 'latex' && length($loc) > $maxlength;
3309 push @d, &{$escape_function}($loc);
3312 # Display of seconds_since_sqlradacct:
3313 # On the invoice, when processing @detail_items, look for a field
3314 # named 'seconds'. This will contain total seconds for each
3315 # service, in the same order as @ext_description. For services
3316 # that don't support this it will show undef.
3317 if ( $conf->exists('svc_acct-usage_seconds')
3318 and ! $cust_bill_pkg->pkgpart_override ) {
3319 foreach my $cust_svc (
3320 $cust_pkg->h_cust_svc(@dates, 'I')
3323 # eval because not having any part_export_usage exports
3324 # is a fatal error, last_bill/_date because that's how
3325 # sqlradius_hour billing does it
3327 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
3329 push @seconds, $sec;
3331 } #if svc_acct-usage_seconds
3333 } # if we are showing service labels
3335 unless ( $is_summary ) {
3336 warn "$me _items_cust_bill_pkg adding details\n"
3339 #instead of omitting details entirely in this case (unwanted side
3340 # effects), just omit CDRs
3341 $details_opt{'no_usage'} = 1
3342 if $type && $type eq 'R';
3344 push @d, $cust_bill_pkg->details(%details_opt);
3347 warn "$me _items_cust_bill_pkg calculating amount\n"
3352 $amount = $cust_bill_pkg->recur;
3353 } elsif ($type eq 'R') {
3354 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
3355 } elsif ($type eq 'U') {
3356 $amount = $cust_bill_pkg->usage;
3359 if ( !$type || $type eq 'R' ) {
3361 warn "$me _items_cust_bill_pkg adding recur\n"
3365 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
3368 if ( $cust_bill_pkg->hidden ) {
3369 $r->{amount} += $amount;
3370 $r->{unit_amount} += $unit_amount;
3371 push @{ $r->{ext_description} }, @d;
3374 description => $description,
3375 pkgpart => $pkgpart,
3376 pkgnum => $cust_bill_pkg->pkgnum,
3378 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3379 unit_amount => $unit_amount,
3380 quantity => $cust_bill_pkg->quantity,
3382 ext_description => \@d,
3383 svc_label => ($svc_label || ''),
3384 locationnum => $cust_pkg->locationnum,
3386 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3389 } else { # $type eq 'U'
3391 warn "$me _items_cust_bill_pkg adding usage\n"
3394 if ( $cust_bill_pkg->hidden and defined($u) ) {
3395 # if this is a hidden package and there's already a usage
3396 # line for the bundle, add this package's total amount and
3397 # usage details to it
3398 $u->{amount} += $amount;
3399 push @{ $u->{ext_description} }, @d;
3400 } elsif ( $amount ) {
3401 # create a new usage line
3403 description => $description,
3404 pkgpart => $pkgpart,
3405 pkgnum => $cust_bill_pkg->pkgnum,
3408 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3410 ext_description => \@d,
3411 locationnum => $cust_pkg->locationnum,
3413 } # else this has no usage, so don't create a usage section
3416 } # recurring or usage with recurring charge
3418 } else { # taxes and fees
3420 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3423 # items of this kind should normally not have sdate/edate.
3425 'description' => $desc,
3426 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
3427 + $cust_bill_pkg->recur)
3430 } # if quotation / package line item / other line item
3432 # decide whether to show active discounts here
3434 # case 1: we are showing a single line for the package
3436 # case 2: we are showing a setup line for a package that has
3437 # no base recurring fee
3438 or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3439 # case 3: we are showing a recur line for a package that has
3440 # a base recurring fee
3441 or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3444 my $item_discount = $cust_bill_pkg->_item_discount;
3445 if ( $item_discount ) {
3446 # $item_discount->{amount} is negative
3448 if ( $d and $cust_bill_pkg->hidden ) {
3449 $d->{amount} += $item_discount->{amount};
3451 $d = $item_discount;
3452 $_ = &{$escape_function}($_) foreach @{ $d->{ext_description} };
3455 # update the active line (before the discount) to show the
3456 # original price (whether this is a hidden line or not)
3458 # quotation discounts keep track of setup and recur; invoice
3459 # discounts currently don't
3460 if ( exists $item_discount->{setup_amount} ) {
3462 $s->{amount} -= $item_discount->{setup_amount} if $s;
3463 $r->{amount} -= $item_discount->{recur_amount} if $r;
3467 # $active_line is the line item hashref for the line that will
3468 # show the original price
3469 # (use the recur or single line for the package, unless we're
3470 # showing a setup line for a package with no recurring fee)
3471 my $active_line = $r;
3472 if ( $type eq 'S' ) {
3475 $active_line->{amount} -= $item_discount->{amount};
3479 } # if there are any discounts
3480 } # if this is an appropriate place to show discounts
3482 } # foreach $display
3484 $discount_show_always = ($cust_bill_pkg->cust_bill_pkg_discount
3485 && $conf->exists('discount-show-always'));
3489 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3491 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3492 if exists($_->{amount});
3493 $_->{amount} =~ s/^\-0\.00$/0.00/;
3494 if (exists($_->{unit_amount})) {
3495 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3499 if $_->{amount} != 0
3500 || $discount_show_always
3501 || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3502 || ( $_->{_is_setup} && $_->{setup_show_zero} )
3506 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3513 =item _items_discounts_avail
3515 Returns an array of line item hashrefs representing available term discounts
3516 for this invoice. This makes the same assumptions that apply to term
3517 discounts in general: that the package is billed monthly, at a flat rate,
3518 with no usage charges. A prorated first month will be handled, as will
3519 a setup fee if the discount is allowed to apply to setup fees.
3523 sub _items_discounts_avail {
3526 #maybe move this method from cust_bill when quotations support discount_plans
3527 return () unless $self->can('discount_plans');
3528 my %plans = $self->discount_plans;
3530 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3531 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3535 my $plan = $plans{$months};
3537 my $term_total = sprintf('%.2f', $plan->discounted_total);
3538 my $percent = sprintf('%.0f',
3539 100 * (1 - $term_total / $plan->base_total) );
3540 my $permonth = sprintf('%.2f', $term_total / $months);
3541 my $detail = $self->mt('discount on item'). ' '.
3542 join(', ', map { "#$_" } $plan->pkgnums)
3545 # discounts for non-integer months don't work anyway
3546 $months = sprintf("%d", $months);
3549 description => $self->mt('Save [_1]% by paying for [_2] months',
3551 amount => $self->mt('[_1] ([_2] per month)',
3552 $term_total, $money_char.$permonth),
3553 ext_description => ($detail || ''),
3556 sort { $b <=> $a } keys %plans;