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;
689 if ( $self->enable_previous ) {
690 $balance_due += $pr_total;
692 # otherwise the previous balance is not shown, so including it in the
693 # balance due is just confusing
695 # the sum of amount owed on all invoices
696 # (this is used in the summary & on the payment coupon)
697 $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
699 # flag telling this invoice to have a first-page summary
700 my $summarypage = '';
702 if ( $self->custnum && $self->invnum ) {
703 # XXX should be an FS::cust_bill method to set the defaults, instead
704 # of checking the type here
706 # info from customer's last invoice before this one, for some
708 $invoice_data{'last_bill'} = {};
710 my $last_bill = $self->previous_bill;
713 # "balance_date_range" unfortunately is unsuitable for this, since it
714 # cares about application dates. We want to know the sum of all
715 # _top-level transactions_ dated before the last invoice.
717 # still do this for the "Previous Balance" line of the summary block
719 map "$_ WHERE _date <= ? AND custnum = ?", (
720 "SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill",
721 "SELECT -1 * COALESCE( SUM(amount), 0 ) FROM cust_credit",
722 "SELECT -1 * COALESCE( SUM(paid), 0 ) FROM cust_pay",
723 "SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund",
726 # the customer's current balance immediately after generating the last
729 my $last_bill_balance = $last_bill->charged;
731 my $delta = FS::Record->scalar_sql(
733 $last_bill->_date - 1,
736 $last_bill_balance += $delta;
739 $last_bill_balance = sprintf("%.2f", $last_bill_balance);
741 warn sprintf("LAST BILL: INVNUM %d, DATE %s, BALANCE %.2f\n\n",
743 $self->time2str_local('%D', $last_bill->_date),
746 # ("true_previous_balance" is a terrible name, but at least it's no
747 # longer stored in the database)
748 $invoice_data{'true_previous_balance'} = $last_bill_balance;
750 # Now, get all applications of credits/payments dated on or after the
751 # previous bill, to invoices before the current bill. (The
752 # credit/payment date restriction prevents these from intersecting
753 # the "Previous Balance" set.)
754 # These are "adjustments". The past due balance will be shown as
755 # Previous Balance - Adjustments.
758 "SELECT COALESCE(SUM(y.amount),0) FROM $_ JOIN cust_bill USING (invnum)
759 WHERE cust_bill._date < ?
761 AND cust_bill.custnum = ?"
762 } "cust_credit AS x JOIN cust_credit_bill y USING (crednum)",
763 "cust_pay AS x JOIN cust_bill_pay y USING (paynum)"
766 my $delta = FS::Record->scalar_sql(
772 $adjustments += $delta;
774 $invoice_data{'balance_adjustments'} = sprintf("%.2f", $adjustments);
776 warn sprintf("BALANCE ADJUSTMENTS: %.2f\n\n",
777 $invoice_data{'balance_adjustments'}
780 # the sum of amount owed on all previous invoices
781 # ($pr_total is used elsewhere but not as $previous_balance)
782 $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
784 $invoice_data{'last_bill'}{'_date'} = $last_bill->_date; #unformatted
785 my (@payments, @credits);
786 # for formats that itemize previous payments
787 foreach my $cust_pay ( qsearch('cust_pay', {
788 'custnum' => $self->custnum,
789 '_date' => { op => '>=',
790 value => $last_bill->_date }
793 next if $cust_pay->_date > $self->_date;
795 '_date' => $cust_pay->_date,
796 'date' => $self->time2str_local('long', $cust_pay->_date, $format),
797 'payinfo' => $cust_pay->payby_payinfo_pretty,
798 'amount' => sprintf('%.2f', $cust_pay->paid),
800 # not concerned about applications
802 foreach my $cust_credit ( qsearch('cust_credit', {
803 'custnum' => $self->custnum,
804 '_date' => { op => '>=',
805 value => $last_bill->_date }
808 next if $cust_credit->_date > $self->_date;
810 '_date' => $cust_credit->_date,
811 'date' => $self->time2str_local('long', $cust_credit->_date, $format),
812 'creditreason'=> $cust_credit->reason,
813 'amount' => sprintf('%.2f', $cust_credit->amount),
816 $invoice_data{'previous_payments'} = \@payments;
817 $invoice_data{'previous_credits'} = \@credits;
819 # there is no $last_bill
820 $invoice_data{'true_previous_balance'} =
821 $invoice_data{'balance_adjustments'} =
822 $invoice_data{'previous_balance'} = '0.00';
823 $invoice_data{'previous_payments'} = [];
824 $invoice_data{'previous_credits'} = [];
827 if ( $conf->exists('invoice_usesummary', $agentnum) ) {
828 $invoice_data{'summarypage'} = $summarypage = 1;
831 } # if this is an invoice
833 warn "$me substituting variables in notes, footer, smallfooter\n"
836 my $tc = $self->template_conf;
837 my @include = ( [ $tc, 'notes' ],
838 [ 'invoice_', 'footer' ],
839 [ 'invoice_', 'smallfooter', ],
840 [ 'invoice_', 'watermark' ],
842 push @include, [ $tc, 'coupon', ]
843 unless $params{'no_coupon'};
845 foreach my $i (@include) {
847 # load the configuration for this sub-template
849 my($base, $include) = @$i;
851 my $inc_file = $conf->key_orbase("$base$format$include", $template);
853 my @inc_src = $conf->config($inc_file, $agentnum);
855 my $converter = $convert_maps{$format}{$include};
857 # then attempt to convert LaTeX to the requested format
858 $inc_file = $conf->key_orbase($base.'latex'.$include, $template);
859 @inc_src = &$converter( $conf->config($inc_file, $agentnum) );
861 # this isn't included in the convert_maps
862 my ($open, $close) = @{ $delimiters{$format} };
867 } # else @inc_src is empty and that's fine
869 # make a Text::Template out of it
871 my $inc_tt = new Text::Template (
873 SOURCE => [ map "$_\n", @inc_src ],
874 DELIMITERS => $delimiters{$format},
875 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
877 unless ( $inc_tt->compile() ) {
878 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
879 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
885 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
887 $invoice_data{$include} =~ s/\n+$//
888 if ($format eq 'latex');
891 # let invoices use either of these as needed
892 $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
893 ? $cust_main->payinfo : '';
894 $invoice_data{'po_line'} =
895 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
896 ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
899 my %money_chars = ( 'latex' => '',
900 'html' => $conf->config('money_char') || '$',
903 my $money_char = $money_chars{$format};
906 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
907 'html' => $conf->config('money_char') || '$',
910 my $other_money_char = $other_money_chars{$format};
911 $invoice_data{'dollar'} = $other_money_char;
913 my %minus_signs = ( 'latex' => '$-$',
915 'template' => '- ' );
916 my $minus = $minus_signs{$format};
918 my @detail_items = ();
919 my @total_items = ();
923 $invoice_data{'detail_items'} = \@detail_items;
924 $invoice_data{'total_items'} = \@total_items;
925 $invoice_data{'buf'} = \@buf;
926 $invoice_data{'sections'} = \@sections;
928 warn "$me generating sections\n"
931 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
932 my $multisection = $conf->exists($tc.'sections', $cust_main->agentnum) ||
933 $conf->exists($tc.'sections_by_location', $cust_main->agentnum);
934 $invoice_data{'multisection'} = $multisection;
936 my $extra_sections = [];
937 my $extra_lines = ();
939 # default section ('Charges')
940 my $default_section = { 'description' => '',
945 # Previous Charges section
946 # subtotal is the first return value from $self->previous
947 my $previous_section;
948 # if the invoice has major sections, or if we're summarizing previous
949 # charges with a single line, or if we've been specifically told to put them
950 # in a section, create a section for previous charges:
951 if ( $multisection or
952 $conf->exists('previous_balance-summary_only') or
953 $conf->exists('previous_balance-section') ) {
955 $previous_section = { 'description' => $self->mt('Previous Charges'),
956 'subtotal' => $other_money_char.
957 sprintf('%.2f', $pr_total),
958 'summarized' => '', #why? $summarypage ? 'Y' : '',
960 $previous_section->{posttotal} = '0 / 30 / 60 / 90 days overdue '.
961 join(' / ', map { $cust_main->balance_date_range(@$_) }
962 $self->_prior_month30s
964 if $conf->exists('invoice_include_aging');
967 # otherwise put them in the main section
968 $previous_section = $default_section;
971 my $adjust_section = {
972 'description' => $self->mt('Credits, Payments, and Adjustments'),
973 'adjust_section' => 1,
974 'subtotal' => 0, # adjusted below
976 my $adjust_weight = _pkg_category($adjust_section->{description})
977 ? _pkg_category($adjust_section->{description})->weight
979 $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
980 # Note: 'sort_weight' here is actually a flag telling whether there is an
981 # explicit package category for the adjust section. If so, certain behavior
983 $adjust_section->{'sort_weight'} = $adjust_weight;
986 if ( $multisection ) {
987 ($extra_sections, $extra_lines) =
988 $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
989 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum)
990 && $self->can('_items_extra_usage_sections');
992 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
994 push @detail_items, @$extra_lines if $extra_lines;
996 # the code is written so that both methods can be used together, but
997 # we haven't yet changed the template to take advantage of that, so for
998 # now, treat them as mutually exclusive.
999 my %section_method = ( by_category => 1 );
1000 if ( $conf->config($tc.'sections_method') eq 'location' ) {
1001 %section_method = ( by_location => 1 );
1003 my ($early, $late) =
1004 $self->_items_sections( 'summary' => $summarypage,
1005 'escape' => $escape_function_nonbsp,
1006 'extra_sections' => $extra_sections,
1007 'format' => $format,
1010 push @sections, @$early;
1011 $late_sections = $late;
1013 if ( $conf->exists('svc_phone_sections')
1014 && $self->can('_items_svc_phone_sections')
1017 my ($phone_sections, $phone_lines) =
1018 $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
1019 push @{$late_sections}, @$phone_sections;
1020 push @detail_items, @$phone_lines;
1022 if ( $conf->exists('voip-cust_accountcode_cdr')
1023 && $cust_main->accountcode_cdr
1024 && $self->can('_items_accountcode_cdr')
1027 my ($accountcode_section, $accountcode_lines) =
1028 $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
1029 if ( scalar(@$accountcode_lines) ) {
1030 push @{$late_sections}, $accountcode_section;
1031 push @detail_items, @$accountcode_lines;
1034 } else {# not multisection
1035 # make a default section
1036 push @sections, $default_section;
1037 # and calculate the finance charge total, since it won't get done otherwise.
1038 # and the default section total
1039 # XXX possibly finance_pkgclass should not be used in this manner?
1040 my @finance_charges;
1042 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1043 if ( $invoice_data{finance_section} and
1044 grep { $_->section eq $invoice_data{finance_section} }
1045 $cust_bill_pkg->cust_bill_pkg_display ) {
1046 # I think these are always setup fees, but just to be sure...
1047 push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1049 push @charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1052 $invoice_data{finance_amount} =
1053 sprintf('%.2f', sum( @finance_charges ) || 0);
1054 $default_section->{subtotal} = $other_money_char.
1055 sprintf('%.2f', sum( @charges ) || 0);
1058 # start setting up summary subtotals
1059 my @summary_subtotals;
1060 my $method = $conf->config('summary_subtotals_method');
1061 if ( $method and $method ne $conf->config($tc.'sections_method') ) {
1062 # then re-section them by the correct method
1063 my %section_method = ( by_category => 1 );
1064 if ( $conf->config('summary_subtotals_method') eq 'location' ) {
1065 %section_method = ( by_location => 1 );
1067 my ($early, $late) =
1068 $self->_items_sections( 'summary' => $summarypage,
1069 'escape' => $escape_function_nonbsp,
1070 'extra_sections' => $extra_sections,
1071 'format' => $format,
1074 foreach ( @$early ) {
1075 next if $_->{subtotal} == 0;
1076 $_->{subtotal} = $other_money_char.sprintf('%.2f', $_->{subtotal});
1077 push @summary_subtotals, $_;
1080 # subtotal sectioning is the same as for the actual invoice sections
1081 @summary_subtotals = @sections;
1084 # Hereafter, push sections to both @sections and @summary_subtotals
1085 # if they belong in both places (e.g. tax section). Late sections are
1086 # never in @summary_subtotals.
1088 # previous invoice balances in the Previous Charges section if there
1089 # is one, otherwise in the main detail section
1090 # (except if summary_only is enabled, don't show them at all)
1091 if ( $self->can('_items_previous') &&
1092 $self->enable_previous &&
1093 ! $conf->exists('previous_balance-summary_only') ) {
1095 warn "$me adding previous balances\n"
1098 foreach my $line_item ( $self->_items_previous ) {
1101 ref => $line_item->{'pkgnum'},
1102 pkgpart => $line_item->{'pkgpart'},
1103 #quantity => 1, # not really correct
1104 section => $previous_section, # which might be $default_section
1105 description => &$escape_function($line_item->{'description'}),
1106 ext_description => [ map { &$escape_function($_) }
1107 @{ $line_item->{'ext_description'} || [] }
1109 amount => $money_char . $line_item->{'amount'},
1110 product_code => $line_item->{'pkgpart'} || 'N/A',
1113 push @detail_items, $detail;
1114 push @buf, [ $detail->{'description'},
1115 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1121 if ( @pr_cust_bill && $self->enable_previous ) {
1122 push @buf, ['','-----------'];
1123 push @buf, [ $self->mt('Total Previous Balance'),
1124 $money_char. sprintf("%10.2f", $pr_total) ];
1128 if ( $conf->exists('svc_phone-did-summary') && $self->can('_did_summary') ) {
1129 warn "$me adding DID summary\n"
1132 my ($didsummary,$minutes) = $self->_did_summary;
1133 my $didsummary_desc = 'DID Activity Summary (since last invoice)';
1135 { 'description' => $didsummary_desc,
1136 'ext_description' => [ $didsummary, $minutes ],
1140 foreach my $section (@sections, @$late_sections) {
1142 # begin some normalization
1143 $section->{'subtotal'} = $section->{'amount'}
1145 && !exists($section->{subtotal})
1146 && exists($section->{amount});
1148 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
1149 if ( $invoice_data{finance_section} &&
1150 $section->{'description'} eq $invoice_data{finance_section} );
1152 $section->{'subtotal'} = $other_money_char.
1153 sprintf('%.2f', $section->{'subtotal'})
1156 # continue some normalization
1157 $section->{'amount'} = $section->{'subtotal'}
1161 if ( $section->{'description'} ) {
1162 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
1167 warn "$me setting options\n"
1171 $options{'section'} = $section if $multisection;
1172 $options{'format'} = $format;
1173 $options{'escape_function'} = $escape_function;
1174 $options{'no_usage'} = 1 unless $unsquelched;
1175 $options{'unsquelched'} = $unsquelched;
1176 $options{'summary_page'} = $summarypage;
1177 $options{'skip_usage'} =
1178 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
1179 $options{'preref_callback'} = $params{'preref_callback'};
1181 warn "$me searching for line items\n"
1184 foreach my $line_item ( $self->_items_pkg(%options),
1185 $self->_items_fee(%options) ) {
1187 warn "$me adding line item ".
1188 join(', ', map "$_=>".$line_item->{$_}, keys %$line_item). "\n"
1191 push @buf, ( [ $line_item->{'description'},
1192 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1194 map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}},
1197 $line_item->{'ref'} = $line_item->{'pkgnum'};
1198 $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()?
1199 $line_item->{'section'} = $section;
1200 $line_item->{'description'} = &$escape_function($line_item->{'description'});
1201 $line_item->{'amount'} = $money_char.$line_item->{'amount'};
1203 if ( length($line_item->{'unit_amount'}) ) {
1204 $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'};
1206 $line_item->{'ext_description'} ||= [];
1208 push @detail_items, $line_item;
1211 if ( $section->{'description'} ) {
1212 push @buf, ( ['','-----------'],
1213 [ $section->{'description'}. ' sub-total',
1214 $section->{'subtotal'} # already formatted this
1223 $invoice_data{current_less_finance} =
1224 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
1226 # if there's anything in the Previous Charges section, prepend it to the list
1227 if ( $pr_total and $previous_section ne $default_section ) {
1228 unshift @sections, $previous_section;
1229 # but not @summary_subtotals
1232 warn "$me adding taxes\n"
1235 # create a tax section if we don't yet have one
1236 my $tax_description = 'Taxes, Surcharges, and Fees';
1238 List::Util::first { $_->{description} eq $tax_description } @sections;
1239 if (!$tax_section) {
1240 $tax_section = { 'description' => $tax_description };
1241 push @sections, $tax_section if $multisection;
1243 $tax_section->{tax_section} = 1; # mark this section as containing taxes
1244 # if this is an existing tax section, we're merging the tax items into it.
1245 # grab the taxtotal that's already there, strip the money symbol if any
1246 my $taxtotal = $tax_section->{'subtotal'} || 0;
1247 $taxtotal =~ s/^\Q$other_money_char\E//;
1250 #my $tax_weight = _pkg_category($tax_section->{description})
1251 # ? _pkg_category($tax_section->{description})->weight
1253 #$tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
1254 #$tax_section->{'sort_weight'} = $tax_weight;
1256 my @items_tax = $self->_items_tax;
1257 foreach my $tax ( @items_tax ) {
1259 $taxtotal += $tax->{'amount'};
1261 my $description = &$escape_function( $tax->{'description'} );
1262 my $amount = sprintf( '%.2f', $tax->{'amount'} );
1264 if ( $multisection ) {
1266 push @detail_items, {
1267 ext_description => [],
1270 description => $description,
1271 amount => $money_char. $amount,
1273 section => $tax_section,
1278 push @total_items, {
1279 'total_item' => $description,
1280 'total_amount' => $other_money_char. $amount,
1285 push @buf,[ $description,
1286 $money_char. $amount,
1293 $total->{'total_item'} = $self->mt('Sub-total');
1294 $total->{'total_amount'} =
1295 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
1297 if ( $multisection ) {
1298 if ( $taxtotal > 0 ) {
1299 # there are taxes, so prepare the section to be displayed.
1300 # $taxtotal already includes any line items that were already in the
1301 # section (fees, taxes that are charged as packages for some reason).
1302 # also set 'summarized' to false so that this isn't a summary-only
1304 $tax_section->{'subtotal'} = $other_money_char.
1305 sprintf('%.2f', $taxtotal);
1306 $tax_section->{'pretotal'} = 'New charges sub-total '.
1307 $total->{'total_amount'};
1308 $tax_section->{'description'} = $self->mt($tax_description);
1309 $tax_section->{'summarized'} = '';
1311 # append it if it's not already there
1312 if ( !grep $tax_section, @sections ) {
1313 push @sections, $tax_section;
1314 push @summary_subtotals, $tax_section;
1319 unshift @total_items, $total;
1322 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1328 my %embolden_functions = (
1329 'latex' => sub { return '\textbf{'. shift(). '}' },
1330 'html' => sub { return '<b>'. shift(). '</b>' },
1331 'template' => sub { shift },
1333 my $embolden_function = $embolden_functions{$format};
1335 if ( $multisection ) {
1337 if ( $adjust_section->{'sort_weight'} ) {
1338 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1339 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1341 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1342 $other_money_char. sprintf('%.2f', $self->charged );
1347 if ( $self->can('_items_total') ) { # should always be true now
1349 # even for multisection, need plain text version
1351 my @new_total_items = $self->_items_total;
1353 push @buf,['','-----------'];
1355 foreach ( @new_total_items ) {
1356 my ($item, $amount) = ($_->{'total_item'}, $_->{'total_amount'});
1357 $_->{'total_item'} = &$embolden_function( $item );
1358 $_->{'total_amount'} = &$embolden_function( $other_money_char.$amount );
1359 # but if it's multisection, don't append to @total_items. the adjust
1360 # section has all this stuff
1361 push @total_items, $_ if !$multisection;
1362 push @buf, [ $item, $money_char.sprintf('%10.2f',$amount) ];
1365 push @buf, [ '', '' ];
1367 # if we're showing previous invoices, also show previous
1368 # credits and payments
1369 if ( $self->enable_previous
1370 and $self->can('_items_credits')
1371 and $self->can('_items_payments') )
1375 my $credittotal = 0;
1376 foreach my $credit (
1377 $self->_items_credits( 'template' => $template, 'trim_len' => 40 )
1381 $total->{'total_item'} = &$escape_function($credit->{'description'});
1382 $credittotal += $credit->{'amount'};
1383 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1384 if ( $multisection ) {
1385 push @detail_items, {
1386 ext_description => [],
1389 description => &$escape_function($credit->{'description'}),
1390 amount => $money_char . $credit->{'amount'},
1392 section => $adjust_section,
1395 push @total_items, $total;
1399 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1402 foreach my $credit (
1403 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1405 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1409 my $paymenttotal = 0;
1410 foreach my $payment (
1411 $self->_items_payments( 'template' => $template )
1414 $total->{'total_item'} = &$escape_function($payment->{'description'});
1415 $paymenttotal += $payment->{'amount'};
1416 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1417 if ( $multisection ) {
1418 push @detail_items, {
1419 ext_description => [],
1422 description => &$escape_function($payment->{'description'}),
1423 amount => $money_char . $payment->{'amount'},
1425 section => $adjust_section,
1428 push @total_items, $total;
1430 push @buf, [ $payment->{'description'},
1431 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1434 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1436 if ( $multisection ) {
1437 $adjust_section->{'subtotal'} = $other_money_char.
1438 sprintf('%.2f', $credittotal + $paymenttotal);
1440 #why this? because {sort_weight} forces the adjust_section to appear
1441 #in @extra_sections instead of @sections. obviously.
1442 push @sections, $adjust_section
1443 unless $adjust_section->{sort_weight};
1444 # do not summarize; adjustments there are shown according to
1448 # create Balance Due message
1451 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1452 $total->{'total_amount'} =
1453 &$embolden_function(
1454 $other_money_char. sprintf('%.2f', #why? $summarypage
1455 # ? $self->charged +
1456 # $self->billing_balance
1458 $self->owed + $pr_total
1461 if ( $multisection && !$adjust_section->{sort_weight} ) {
1462 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1463 $total->{'total_amount'};
1465 push @total_items, $total;
1467 push @buf,['','-----------'];
1468 push @buf,[$self->balance_due_msg, $money_char.
1469 sprintf("%10.2f", $balance_due ) ];
1472 if ( $conf->exists('previous_balance-show_credit')
1473 and $cust_main->balance < 0 ) {
1474 my $credit_total = {
1475 'total_item' => &$embolden_function($self->credit_balance_msg),
1476 'total_amount' => &$embolden_function(
1477 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1480 if ( $multisection ) {
1481 $adjust_section->{'posttotal'} .= $newline_token .
1482 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1485 push @total_items, $credit_total;
1487 push @buf,['','-----------'];
1488 push @buf,[$self->credit_balance_msg, $money_char.
1489 sprintf("%10.2f", -$cust_main->balance ) ];
1493 } #end of default total adding ! can('_items_total')
1495 if ( $multisection ) {
1496 if ( $conf->exists('svc_phone_sections')
1497 && $self->can('_items_svc_phone_sections')
1501 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1502 $total->{'total_amount'} =
1503 &$embolden_function(
1504 $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
1506 my $last_section = pop @sections;
1507 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1508 $total->{'total_amount'};
1509 push @sections, $last_section;
1511 push @sections, @$late_sections
1515 # make a discounts-available section, even without multisection
1516 if ( $conf->exists('discount-show_available')
1517 and my @discounts_avail = $self->_items_discounts_avail ) {
1518 my $discount_section = {
1519 'description' => $self->mt('Discounts Available'),
1524 push @sections, $discount_section; # do not summarize
1525 push @detail_items, map { +{
1526 'ref' => '', #should this be something else?
1527 'section' => $discount_section,
1528 'description' => &$escape_function( $_->{description} ),
1529 'amount' => $money_char . &$escape_function( $_->{amount} ),
1530 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1531 } } @discounts_avail;
1534 # not adding any more sections after this
1535 $invoice_data{summary_subtotals} = \@summary_subtotals;
1538 if ( $conf->exists('usage_class_summary')
1539 and $self->can('_items_usage_class_summary') ) {
1540 my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function, 'money_char' => $other_money_char);
1541 if ( @usage_subtotals ) {
1542 unshift @sections, $usage_subtotals[0]->{section}; # do not summarize
1543 unshift @detail_items, @usage_subtotals;
1547 # invoice history "section" (not really a section)
1548 # not to be included in any subtotals, completely independent of
1550 if ( $conf->exists('previous_invoice_history') and $cust_main->isa('FS::cust_main') ) {
1553 foreach my $cust_bill ( $cust_main->cust_bill ) {
1554 # XXX hardcoded format, and currently only 'charged'; add other fields
1555 # if they become necessary
1556 my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1557 $history{$date} ||= 0;
1558 $history{$date} += $cust_bill->charged;
1559 # just so we have a numeric sort key
1560 $monthorder{$date} ||= $cust_bill->_date;
1562 my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1564 my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1565 $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1568 # service locations: another option for template customization
1570 foreach my $item (@detail_items) {
1571 if ( $item->{locationnum} ) {
1572 $location_info{ $item->{locationnum} } ||= {
1573 FS::cust_location->by_key( $item->{locationnum} )->location_hash
1577 $invoice_data{location_info} = \%location_info;
1579 # debugging hook: call this with 'diag' => 1 to just get a hash of
1580 # the invoice variables
1581 return \%invoice_data if ( $params{'diag'} );
1583 # All sections and items are built; now fill in templates.
1584 my @includelist = ();
1585 push @includelist, 'summary' if $summarypage;
1586 foreach my $include ( @includelist ) {
1588 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1591 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1593 @inc_src = $conf->config($inc_file, $agentnum);
1597 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1599 my $convert_map = $convert_maps{$format}{$include};
1601 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1602 s/--\@\]/$delimiters{$format}[1]/g;
1605 &$convert_map( $conf->config($inc_file, $agentnum) );
1609 my $inc_tt = new Text::Template (
1611 SOURCE => [ map "$_\n", @inc_src ],
1612 DELIMITERS => $delimiters{$format},
1613 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1615 unless ( $inc_tt->compile() ) {
1616 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1617 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1621 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1623 $invoice_data{$include} =~ s/\n+$//
1624 if ($format eq 'latex');
1629 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1630 /invoice_lines\((\d*)\)/;
1631 $invoice_lines += $1 || scalar(@buf);
1634 die "no invoice_lines() functions in template?"
1635 if ( $format eq 'template' && !$wasfunc );
1637 if ($format eq 'template') {
1639 if ( $invoice_lines ) {
1640 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1641 $invoice_data{'total_pages'}++
1642 if scalar(@buf) % $invoice_lines;
1645 #setup subroutine for the template
1646 $invoice_data{invoice_lines} = sub {
1647 my $lines = shift || scalar(@buf);
1659 push @collect, split("\n",
1660 $text_template->fill_in( HASH => \%invoice_data )
1662 $invoice_data{'page'}++;
1664 map "$_\n", @collect;
1666 } else { # this is where we actually create the invoice
1668 warn "filling in template for invoice ". $self->invnum. "\n"
1670 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1673 $text_template->fill_in(HASH => \%invoice_data);
1677 sub notice_name { '('.shift->table.')'; }
1679 sub template_conf { 'invoice_'; }
1681 # helper routine for generating date ranges
1682 sub _prior_month30s {
1685 [ 1, 2592000 ], # 0-30 days ago
1686 [ 2592000, 5184000 ], # 30-60 days ago
1687 [ 5184000, 7776000 ], # 60-90 days ago
1688 [ 7776000, 0 ], # 90+ days ago
1691 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
1692 $_->[1] ? $self->_date - $_->[1] - 1 : '',
1697 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1699 Returns an postscript invoice, as a scalar.
1701 Options can be passed as a hashref (recommended) or as a list of time, template
1702 and then any key/value pairs for any other options.
1704 I<time> an optional value used to control the printing of overdue messages. The
1705 default is now. It isn't the date of the invoice; that's the `_date' field.
1706 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1707 L<Time::Local> and L<Date::Parse> for conversion functions.
1709 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1716 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1717 my $ps = generate_ps($file);
1719 unlink($barcodefile) if $barcodefile;
1724 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1726 Returns an PDF invoice, as a scalar.
1728 Options can be passed as a hashref (recommended) or as a list of time, template
1729 and then any key/value pairs for any other options.
1731 I<time> an optional value used to control the printing of overdue messages. The
1732 default is now. It isn't the date of the invoice; that's the `_date' field.
1733 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1734 L<Time::Local> and L<Date::Parse> for conversion functions.
1736 I<template>, if specified, is the name of a suffix for alternate invoices.
1738 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1745 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1746 my $pdf = generate_pdf($file);
1748 unlink($barcodefile) if $barcodefile;
1753 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1755 Returns an HTML invoice, as a scalar.
1757 I<time> an optional value used to control the printing of overdue messages. The
1758 default is now. It isn't the date of the invoice; that's the `_date' field.
1759 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1760 L<Time::Local> and L<Date::Parse> for conversion functions.
1762 I<template>, if specified, is the name of a suffix for alternate invoices.
1764 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1766 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1767 when emailing the invoice as part of a multipart/related MIME email.
1775 %params = %{ shift() };
1779 $params{'format'} = 'html';
1781 $self->print_generic( %params );
1784 # quick subroutine for print_latex
1786 # There are ten characters that LaTeX treats as special characters, which
1787 # means that they do not simply typeset themselves:
1788 # # $ % & ~ _ ^ \ { }
1790 # TeX ignores blanks following an escaped character; if you want a blank (as
1791 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1795 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1796 $value =~ s/([<>])/\$$1\$/g;
1802 encode_entities($value);
1806 sub _html_escape_nbsp {
1807 my $value = _html_escape(shift);
1808 $value =~ s/ +/ /g;
1812 #utility methods for print_*
1814 sub _translate_old_latex_format {
1815 warn "_translate_old_latex_format called\n"
1822 if ( $line =~ /^%%Detail\s*$/ ) {
1824 push @template, q![@--!,
1825 q! foreach my $_tr_line (@detail_items) {!,
1826 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1827 q! $_tr_line->{'description'} .= !,
1828 q! "\\tabularnewline\n~~".!,
1829 q! join( "\\tabularnewline\n~~",!,
1830 q! @{$_tr_line->{'ext_description'}}!,
1834 while ( ( my $line_item_line = shift )
1835 !~ /^%%EndDetail\s*$/ ) {
1836 $line_item_line =~ s/'/\\'/g; # nice LTS
1837 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1838 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1839 push @template, " \$OUT .= '$line_item_line';";
1842 push @template, '}',
1845 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1847 push @template, '[@--',
1848 ' foreach my $_tr_line (@total_items) {';
1850 while ( ( my $total_item_line = shift )
1851 !~ /^%%EndTotalDetails\s*$/ ) {
1852 $total_item_line =~ s/'/\\'/g; # nice LTS
1853 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1854 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1855 push @template, " \$OUT .= '$total_item_line';";
1858 push @template, '}',
1862 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1863 push @template, $line;
1869 warn "$_\n" foreach @template;
1881 my $conf = $self->conf;
1883 #check for an invoice-specific override
1884 return $self->invoice_terms if $self->invoice_terms;
1886 #check for a customer- specific override
1887 my $cust_main = $self->cust_main;
1888 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1892 $agentnum = $cust_main->agentnum;
1893 } elsif ( my $prospect_main = $self->prospect_main ) {
1894 $agentnum = $prospect_main->agentnum;
1897 #use configured default
1898 $conf->config('invoice_default_terms', $agentnum) || '';
1908 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1909 $duedate = $self->_date() + ( $1 * 86400 );
1920 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
1923 =item balance_due_msg
1927 sub balance_due_msg {
1929 my $msg = $self->mt('Balance Due');
1930 return $msg unless $self->terms; # huh?
1931 if ( !$self->conf->exists('invoice_show_prior_due_date')
1932 or $self->conf->exists('invoice_sections') ) {
1933 # if enabled, the due date is shown with Total New Charges (see
1934 # _items_total) and not here
1935 # (yes, or if invoice_sections is enabled; this is just for compatibility)
1936 if ( $self->due_date ) {
1937 $msg .= ' - ' . $self->mt('Please pay by'). ' '.
1938 $self->due_date2str('short');
1939 } elsif ( $self->terms ) {
1940 $msg .= ' - '. $self->mt($self->terms);
1946 =item balance_due_date
1950 sub balance_due_date {
1952 my $conf = $self->conf;
1954 my $terms = $self->terms;
1955 if ( $terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1956 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
1961 sub credit_balance_msg {
1963 $self->mt('Credit Balance Remaining')
1968 Returns a string with the date, for example: "3/20/2008", localized for the
1969 customer. Use _date_pretty_unlocalized for non-end-customer display use.
1975 $self->time2str_local('short', $self->_date);
1978 =item _date_pretty_unlocalized
1980 Returns a string with the date, for example: "3/20/2008", in the format
1981 configured for the back-office. Use _date_pretty for end-customer display use.
1985 sub _date_pretty_unlocalized {
1987 time2str($date_format, $self->_date);
1992 Emails this template.
1994 Options are passed as a hashref. Available options:
2000 If specified, overrides the default From: address.
2004 If specified, overrides the name of the sent document ("Invoice" or "Quotation")
2008 (Deprecated) If specified, is the name of a suffix for alternate template files.
2012 Options accepted by generate_email can also be used.
2018 my $opt = shift || {};
2019 if ($opt and !ref($opt)) {
2020 die ref($self). '->email called with positional parameters';
2023 return if $self->hide;
2025 my $error = send_email(
2026 $self->generate_email(
2027 'subject' => $self->email_subject($opt->{template}),
2028 %$opt, # template, etc.
2032 die "can't email: $error\n" if $error;
2035 =item generate_email OPTION => VALUE ...
2043 sender address, required
2047 alternate template name, optional
2051 email subject, optional
2055 notice name instead of "Invoice", optional
2059 Returns an argument list to be passed to L<FS::Misc::send_email>.
2065 sub generate_email {
2069 my $conf = $self->conf;
2071 my $me = '[FS::Template_Mixin::generate_email]';
2074 'from' => $args{'from'},
2075 'subject' => ($args{'subject'} || $self->email_subject),
2076 'custnum' => $self->custnum,
2077 'msgtype' => 'invoice',
2080 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
2082 my $cust_main = $self->cust_main;
2084 if (ref($args{'to'}) eq 'ARRAY') {
2085 $return{'to'} = $args{'to'};
2086 } elsif ( $cust_main ) {
2087 $return{'to'} = [ $cust_main->invoicing_list_emailonly ];
2090 my $tc = $self->template_conf;
2092 my @text; # array of lines
2093 my $html; # a big string
2094 my @related_parts; # will contain the text/HTML alternative, and images
2095 my $related; # will contain the multipart/related object
2097 if ( $conf->exists($tc. 'email_pdf') ) {
2098 if ( my $msgnum = $conf->config($tc.'email_pdf_msgnum') ) {
2100 warn "$me using '${tc}email_pdf_msgnum' in multipart message"
2103 my $msg_template = FS::msg_template->by_key($msgnum)
2104 or die "${tc}email_pdf_msgnum $msgnum not found\n";
2105 my %prepared = $msg_template->prepare(
2106 cust_main => $self->cust_main,
2110 @text = split(/(?=\n)/, $prepared{'text_body'});
2111 $html = $prepared{'html_body'};
2113 } elsif ( my @note = $conf->config($tc.'email_pdf_note') ) {
2115 warn "$me using '${tc}email_pdf_note' in multipart message"
2117 @text = $conf->config($tc.'email_pdf_note');
2118 $html = join('<BR>', @text);
2120 } # else use the plain text invoice
2125 if ( $conf->config($tc.'template') ) {
2127 warn "$me generating plain text invoice"
2130 # 'print_text' argument is no longer used
2131 @text = $self->print_text(\%args);
2135 warn "$me no plain text version exists; sending empty message body"
2142 my $text_part = build MIME::Entity (
2143 'Type' => 'text/plain',
2144 'Encoding' => 'quoted-printable',
2145 'Charset' => 'UTF-8',
2146 #'Encoding' => '7bit',
2148 'Disposition' => 'inline',
2153 if ( $conf->exists($tc.'html') ) {
2154 warn "$me generating HTML invoice"
2157 $args{'from'} =~ /\@([\w\.\-]+)/;
2158 my $from = $1 || 'example.com';
2159 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2162 my $agentnum = $cust_main ? $cust_main->agentnum
2163 : $self->prospect_main->agentnum;
2164 if ( defined($args{'template'}) && length($args{'template'})
2165 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
2168 $logo = 'logo_'. $args{'template'}. '.png';
2172 my $image_data = $conf->config_binary( $logo, $agentnum);
2174 push @related_parts, build MIME::Entity
2175 'Type' => 'image/png',
2176 'Encoding' => 'base64',
2177 'Data' => $image_data,
2178 'Filename' => 'logo.png',
2179 'Content-ID' => "<$content_id>",
2182 if ( ref($self) eq 'FS::cust_bill' && $conf->exists('invoice-barcode') ) {
2183 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2184 push @related_parts, build MIME::Entity
2185 'Type' => 'image/png',
2186 'Encoding' => 'base64',
2187 'Data' => $self->invoice_barcode(0),
2188 'Filename' => 'barcode.png',
2189 'Content-ID' => "<$barcode_content_id>",
2191 $args{'barcode_cid'} = $barcode_content_id;
2194 $html = $self->print_html({ 'cid'=>$content_id, %args });
2201 warn "$me creating HTML/text multipart message"
2204 $return{'nobody'} = 1;
2206 my $alternative = build MIME::Entity
2207 'Type' => 'multipart/alternative',
2208 #'Encoding' => '7bit',
2209 'Disposition' => 'inline'
2213 $alternative->add_part($text_part);
2216 $alternative->attach(
2217 'Type' => 'text/html',
2218 'Encoding' => 'quoted-printable',
2219 'Data' => [ '<html>',
2222 ' '. encode_entities($return{'subject'}),
2225 ' <body bgcolor="#e8e8e8">',
2230 'Disposition' => 'inline',
2231 #'Filename' => 'invoice.pdf',
2234 unshift @related_parts, $alternative;
2236 $related = build MIME::Entity 'Type' => 'multipart/related',
2237 'Encoding' => '7bit';
2239 #false laziness w/Misc::send_email
2240 $related->head->replace('Content-type',
2241 $related->mime_type.
2242 '; boundary="'. $related->head->multipart_boundary. '"'.
2243 '; type=multipart/alternative'
2246 $related->add_part($_) foreach @related_parts;
2250 my @otherparts = ();
2251 if ( ref($self) eq 'FS::cust_bill' && $cust_main->email_csv_cdr ) {
2253 push @otherparts, build MIME::Entity
2254 'Type' => 'text/csv',
2255 'Encoding' => '7bit',
2256 'Data' => [ map { "$_\n" }
2257 $self->call_details('prepend_billed_number' => 1)
2259 'Disposition' => 'attachment',
2260 'Filename' => 'usage-'. $self->invnum. '.csv',
2265 if ( $conf->exists($tc.'email_pdf') ) {
2270 # multipart/alternative
2276 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
2277 push @otherparts, $pdf;
2281 $return{'content-type'} = 'multipart/mixed'; # of the outer container
2283 $return{'mimeparts'} = [ $related, @otherparts ];
2284 $return{'type'} = 'multipart/related'; # of the first part
2286 $return{'mimeparts'} = [ $text_part, @otherparts ];
2287 $return{'type'} = 'text/plain';
2289 } elsif ( $html ) { # no PDF or CSV, strip the outer container
2290 $return{'mimeparts'} = \@related_parts;
2291 $return{'content-type'} = 'multipart/related';
2292 $return{'type'} = 'multipart/alternative';
2293 } else { # no HTML either
2294 $return{'body'} = \@text;
2295 $return{'content-type'} = 'text/plain';
2304 Returns a list suitable for passing to MIME::Entity->build(), representing
2305 this invoice as PDF attachment.
2312 'Type' => 'application/pdf',
2313 'Encoding' => 'base64',
2314 'Data' => [ $self->print_pdf(@_) ],
2315 'Disposition' => 'attachment',
2316 'Filename' => 'invoice-'. $self->invnum. '.pdf',
2320 =item _items_sections OPTIONS
2322 Generate section information for all items appearing on this invoice.
2323 This will only be called for multi-section invoices.
2325 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
2326 related display records (L<FS::cust_bill_pkg_display>) and organize
2327 them into two groups ("early" and "late" according to whether they come
2328 before or after the total), then into sections. A subtotal is calculated
2331 Section descriptions are returned in sort weight order. Each consists
2332 of a hash containing:
2334 description: the package category name, escaped
2335 subtotal: the total charges in that section
2336 tax_section: a flag indicating that the section contains only tax charges
2337 summarized: same as tax_section, for some reason
2338 sort_weight: the package category's sort weight
2340 If 'condense' is set on the display record, it also contains everything
2341 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
2342 coderefs to generate parts of the invoice. This is not advised.
2344 The method returns two arrayrefs, one of "early" sections and one of "late"
2347 OPTIONS may include:
2349 by_location: a flag to divide the invoice into sections by location.
2350 Each section hash will have a 'location' element containing a hashref of
2351 the location fields (see L<FS::cust_location>). The section description
2352 will be the location label, but the template can use any of the location
2353 fields to create a suitable label.
2355 by_category: a flag to divide the invoice into sections using display
2356 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
2357 behavior. Each section hash will have a 'category' element containing
2358 the section name from the display record (which probably equals the
2359 category name of the package, but may not in some cases).
2361 summary: a flag indicating that this is a summary-format invoice.
2362 Turning this on has the following effects:
2363 - Ignores display items with the 'summary' flag.
2364 - Places all sections in the "early" group even if they have post_total.
2365 - Creates sections for all non-disabled package categories, even if they
2366 have no charges on this invoice, as well as a section with no name.
2368 escape: an escape function to use for section titles.
2370 extra_sections: an arrayref of additional sections to return after the
2371 sorted list. If there are any of these, section subtotals exclude
2374 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
2375 passed through to C<_condense_section()>.
2379 use vars qw(%pkg_category_cache);
2380 sub _items_sections {
2384 my $escape = $opt{escape};
2385 my @extra_sections = @{ $opt{extra_sections} || [] };
2387 # $subtotal{$locationnum}{$categoryname} = amount.
2388 # if we're not using by_location, $locationnum is undef.
2389 # if we're not using by_category, you guessed it, $categoryname is undef.
2390 # if we're not using either one, we shouldn't be here in the first place...
2392 my %late_subtotal = ();
2395 # About tax items + multisection invoices:
2396 # If either invoice_*summary option is enabled, AND there is a
2397 # package category with the name of the tax, then there will be
2398 # a display record assigning the tax item to that category.
2400 # However, the taxes are always placed in the "Taxes, Surcharges,
2401 # and Fees" section regardless of that. The only effect of the
2402 # display record is to create a subtotal for the summary page.
2405 my $pkg_hash = $self->cust_pkg_hash;
2407 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2410 my $usage = $cust_bill_pkg->usage;
2413 if ( $opt{by_location} ) {
2414 if ( $cust_bill_pkg->pkgnum ) {
2415 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2420 $locationnum = undef;
2423 # as in _items_cust_pkg, if a line item has no display records,
2424 # cust_bill_pkg_display() returns a default record for it
2426 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2427 next if ( $display->summary && $opt{summary} );
2429 my $section = $display->section;
2430 my $type = $display->type;
2431 # Set $section = undef if we're sectioning by location and this
2432 # line item _has_ a location (i.e. isn't a fee).
2433 $section = undef if $locationnum;
2435 # set this flag if the section is not tax-only
2436 $not_tax{$locationnum}{$section} = 1
2437 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
2439 # there's actually a very important piece of logic buried in here:
2440 # incrementing $late_subtotal{$section} CREATES
2441 # $late_subtotal{$section}. keys(%late_subtotal) is later used
2442 # to define the list of late sections, and likewise keys(%subtotal).
2443 # When _items_cust_bill_pkg is called to generate line items for
2444 # real, it will be called with 'section' => $section for each
2446 if ( $display->post_total && !$opt{summary} ) {
2447 if (! $type || $type eq 'S') {
2448 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2449 if $cust_bill_pkg->setup != 0
2450 || $cust_bill_pkg->setup_show_zero;
2454 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
2455 if $cust_bill_pkg->recur != 0
2456 || $cust_bill_pkg->recur_show_zero;
2459 if ($type && $type eq 'R') {
2460 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2461 if $cust_bill_pkg->recur != 0
2462 || $cust_bill_pkg->recur_show_zero;
2465 if ($type && $type eq 'U') {
2466 $late_subtotal{$locationnum}{$section} += $usage
2467 unless scalar(@extra_sections);
2470 } else { # it's a pre-total (normal) section
2472 # skip tax items unless they're explicitly included in a section
2473 next if $cust_bill_pkg->pkgnum == 0 and
2474 ! $cust_bill_pkg->feepart and
2477 if ( $type eq 'S' ) {
2478 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2479 if $cust_bill_pkg->setup != 0
2480 || $cust_bill_pkg->setup_show_zero;
2481 } elsif ( $type eq 'R' ) {
2482 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2483 if $cust_bill_pkg->recur != 0
2484 || $cust_bill_pkg->recur_show_zero;
2485 } elsif ( $type eq 'U' ) {
2486 $subtotal{$locationnum}{$section} += $usage
2487 unless scalar(@extra_sections);
2488 } elsif ( !$type ) {
2489 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2490 + $cust_bill_pkg->recur;
2499 %pkg_category_cache = ();
2501 # summary invoices need subtotals for all non-disabled package categories,
2502 # even if they're zero
2503 # but currently assume that there are no location sections, or at least
2504 # that the summary page doesn't care about them
2505 if ( $opt{summary} ) {
2506 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2507 $subtotal{''}{$category->categoryname} ||= 0;
2509 $subtotal{''}{''} ||= 0;
2513 foreach my $post_total (0,1) {
2515 my $s = $post_total ? \%late_subtotal : \%subtotal;
2516 foreach my $locationnum (keys %$s) {
2517 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2519 'subtotal' => $s->{$locationnum}{$sectionname},
2522 if ( $locationnum ) {
2523 $section->{'locationnum'} = $locationnum;
2524 my $location = FS::cust_location->by_key($locationnum);
2525 $section->{'description'} = &{ $escape }($location->location_label);
2526 # Better ideas? This will roughly group them by proximity,
2527 # which alpha sorting on any of the address fields won't.
2528 # Sorting by locationnum is meaningless.
2529 # We have to sort on _something_ or the order may change
2530 # randomly from one invoice to the next, which will confuse
2532 $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
2534 $section->{'location'} = {
2535 label_prefix => &{ $escape }($location->label_prefix),
2536 map { $_ => &{ $escape }($location->get($_)) }
2540 $section->{'category'} = $sectionname;
2541 $section->{'description'} = &{ $escape }($sectionname);
2542 if ( _pkg_category($sectionname) ) {
2543 $section->{'sort_weight'} = _pkg_category($sectionname)->weight;
2544 if ( _pkg_category($sectionname)->condense ) {
2545 $section = { %$section, $self->_condense_section($opt{format}) };
2549 if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
2550 # then it's a tax-only section
2551 $section->{'summarized'} = 'Y';
2552 $section->{'tax_section'} = 'Y';
2554 push @these, $section;
2555 } # foreach $sectionname
2556 } #foreach $locationnum
2557 push @these, @extra_sections if $post_total == 0;
2558 # need an alpha sort for location sections, because postal codes can
2560 $sections[ $post_total ] = [ sort {
2561 $opt{'by_location'} ?
2562 ($a->{sort_weight} cmp $b->{sort_weight}) :
2563 ($a->{sort_weight} <=> $b->{sort_weight})
2565 } #foreach $post_total
2567 return @sections; # early, late
2570 #helper subs for above
2574 $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2578 my $categoryname = shift;
2579 $pkg_category_cache{$categoryname} ||=
2580 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2583 my %condensed_format = (
2584 'label' => [ qw( Description Qty Amount ) ],
2586 sub { shift->{description} },
2587 sub { shift->{quantity} },
2588 sub { my($href, %opt) = @_;
2589 ($opt{dollar} || ''). $href->{amount};
2592 'align' => [ qw( l r r ) ],
2593 'span' => [ qw( 5 1 1 ) ], # unitprices?
2594 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
2597 sub _condense_section {
2598 my ( $self, $format ) = ( shift, shift );
2600 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2601 qw( description_generator
2604 total_line_generator
2609 sub _condensed_generator_defaults {
2610 my ( $self, $format ) = ( shift, shift );
2611 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2620 sub _condensed_header_generator {
2621 my ( $self, $format ) = ( shift, shift );
2623 my ( $f, $prefix, $suffix, $separator, $column ) =
2624 _condensed_generator_defaults($format);
2626 if ($format eq 'latex') {
2627 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2628 $suffix = "\\\\\n\\hline";
2631 sub { my ($d,$a,$s,$w) = @_;
2632 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2634 } elsif ( $format eq 'html' ) {
2635 $prefix = '<th></th>';
2639 sub { my ($d,$a,$s,$w) = @_;
2640 return qq!<th align="$html_align{$a}">$d</th>!;
2648 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2650 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2653 $prefix. join($separator, @result). $suffix;
2658 sub _condensed_description_generator {
2659 my ( $self, $format ) = ( shift, shift );
2661 my ( $f, $prefix, $suffix, $separator, $column ) =
2662 _condensed_generator_defaults($format);
2664 my $money_char = '$';
2665 if ($format eq 'latex') {
2666 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2668 $separator = " & \n";
2670 sub { my ($d,$a,$s,$w) = @_;
2671 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2673 $money_char = '\\dollar';
2674 }elsif ( $format eq 'html' ) {
2675 $prefix = '"><td align="center"></td>';
2679 sub { my ($d,$a,$s,$w) = @_;
2680 return qq!<td align="$html_align{$a}">$d</td>!;
2682 #$money_char = $conf->config('money_char') || '$';
2683 $money_char = ''; # this is madness
2691 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2693 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2695 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2696 map { $f->{$_}->[$i] } qw(align span width)
2700 $prefix. join( $separator, @result ). $suffix;
2705 sub _condensed_total_generator {
2706 my ( $self, $format ) = ( shift, shift );
2708 my ( $f, $prefix, $suffix, $separator, $column ) =
2709 _condensed_generator_defaults($format);
2712 if ($format eq 'latex') {
2715 $separator = " & \n";
2717 sub { my ($d,$a,$s,$w) = @_;
2718 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2720 }elsif ( $format eq 'html' ) {
2724 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2726 sub { my ($d,$a,$s,$w) = @_;
2727 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2736 # my $r = &{$f->{fields}->[$i]}(@args);
2737 # $r .= ' Total' unless $i;
2739 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2741 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
2742 map { $f->{$_}->[$i] } qw(align span width)
2746 $prefix. join( $separator, @result ). $suffix;
2751 =item total_line_generator FORMAT
2753 Returns a coderef used for generation of invoice total line items for this
2754 usage_class. FORMAT is either html or latex
2758 # should not be used: will have issues with hash element names (description vs
2759 # total_item and amount vs total_amount -- another array of functions?
2761 sub _condensed_total_line_generator {
2762 my ( $self, $format ) = ( shift, shift );
2764 my ( $f, $prefix, $suffix, $separator, $column ) =
2765 _condensed_generator_defaults($format);
2768 if ($format eq 'latex') {
2771 $separator = " & \n";
2773 sub { my ($d,$a,$s,$w) = @_;
2774 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2776 }elsif ( $format eq 'html' ) {
2780 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2782 sub { my ($d,$a,$s,$w) = @_;
2783 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2792 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2794 &{$column}( &{$f->{fields}->[$i]}(@args),
2795 map { $f->{$_}->[$i] } qw(align span width)
2799 $prefix. join( $separator, @result ). $suffix;
2804 =item _items_pkg [ OPTIONS ]
2806 Return line item hashes for each package item on this invoice. Nearly
2809 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
2811 OPTIONS are passed through to _items_cust_bill_pkg, and should include
2812 'format' and 'escape_function' at minimum.
2814 To produce items for a specific invoice section, OPTIONS should include
2815 'section', a hashref containing 'category' and/or 'locationnum' keys.
2817 'section' may also contain a key named 'condensed'. If this is present
2818 and has a true value, _items_pkg will try to merge identical items into items
2819 with 'quantity' equal to the number of items (not the sum of their separate
2820 quantities, for some reason).
2826 # The order of these is important. Bundled line items will be merged into
2827 # the most recent non-hidden item, so it needs to be the one with:
2829 # - the same start date
2830 # - no pkgpart_override
2832 # So: sort by pkgnum,
2834 # then sort the base line item before any overrides
2835 # then sort hidden before non-hidden add-ons
2836 # then sort by override pkgpart (for consistency)
2837 sort { $a->pkgnum <=> $b->pkgnum or
2838 $a->sdate <=> $b->sdate or
2839 ($a->pkgpart_override ? 0 : -1) or
2840 ($b->pkgpart_override ? 0 : 1) or
2841 $b->hidden cmp $a->hidden or
2842 $a->pkgpart_override <=> $b->pkgpart_override
2844 # and of course exclude taxes and fees
2845 grep { $_->pkgnum > 0 } $self->cust_bill_pkg;
2851 my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
2852 my $escape_function = $options{escape_function};
2855 foreach my $cust_bill_pkg (@cust_bill_pkg) {
2856 # cache this, so we don't look it up again in every section
2857 my $part_fee = $cust_bill_pkg->get('part_fee')
2858 || $cust_bill_pkg->part_fee;
2859 $cust_bill_pkg->set('part_fee', $part_fee);
2861 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
2862 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
2865 if ( exists($options{section}) and exists($options{section}{category}) )
2867 my $categoryname = $options{section}{category};
2868 # then filter for items that have that section
2869 if ( $part_fee->categoryname ne $categoryname ) {
2870 warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
2873 } # otherwise include them all in the main section
2874 # XXX what to do when sectioning by location?
2877 my %base_invnums; # invnum => invoice date
2878 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
2879 if ($_->base_invnum) {
2880 # XXX what if base_bill has been voided?
2881 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
2882 my $base_date = $self->time2str_local('short', $base_bill->_date)
2884 $base_invnums{$_->base_invnum} = $base_date || '';
2887 foreach (sort keys(%base_invnums)) {
2888 next if $_ == $self->invnum;
2889 # per convention, we must escape ext_description lines
2891 &{$escape_function}(
2892 $self->mt('from invoice #[_1] on [_2]', $_, $base_invnums{$_})
2895 my $desc = $part_fee->itemdesc_locale($self->cust_main->locale);
2896 # but not escape the base description line
2899 { feepart => $cust_bill_pkg->feepart,
2900 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
2901 description => $desc,
2902 ext_description => \@ext_desc
2913 warn "$me _items_pkg searching for all package line items\n"
2916 my @cust_bill_pkg = $self->_items_nontax;
2918 warn "$me _items_pkg filtering line items\n"
2920 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2922 if ($options{section} && $options{section}->{condensed}) {
2924 warn "$me _items_pkg condensing section\n"
2928 local $Storable::canonical = 1;
2929 foreach ( @items ) {
2931 delete $item->{ref};
2932 delete $item->{ext_description};
2933 my $key = freeze($item);
2934 $itemshash{$key} ||= 0;
2935 $itemshash{$key} ++; # += $item->{quantity};
2937 @items = sort { $a->{description} cmp $b->{description} }
2938 map { my $i = thaw($_);
2939 $i->{quantity} = $itemshash{$_};
2941 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
2947 warn "$me _items_pkg returning ". scalar(@items). " items\n"
2954 return 0 unless $a->itemdesc cmp $b->itemdesc;
2955 return -1 if $b->itemdesc eq 'Tax';
2956 return 1 if $a->itemdesc eq 'Tax';
2957 return -1 if $b->itemdesc eq 'Other surcharges';
2958 return 1 if $a->itemdesc eq 'Other surcharges';
2959 $a->itemdesc cmp $b->itemdesc;
2964 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
2965 $self->cust_bill_pkg;
2966 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2968 if ( $self->conf->exists('always_show_tax') ) {
2969 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
2970 if (0 == grep { $_->{description} eq $itemdesc } @items) {
2972 { 'description' => $itemdesc,
2979 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
2981 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
2982 list of hashrefs describing the line items they generate on the invoice.
2984 OPTIONS may include:
2986 format: the invoice format.
2988 escape_function: the function used to escape strings.
2990 DEPRECATED? (expensive, mostly unused?)
2991 format_function: the function used to format CDRs.
2993 section: a hashref containing 'category' and/or 'locationnum'; if this
2994 is present, only returns line items that belong to that category and/or
2995 location (whichever is defined).
2997 multisection: a flag indicating that this is a multisection invoice,
2998 which does something complicated.
3000 preref_callback: coderef run for each line item, code should return HTML to be
3001 displayed before that line item (quotations only)
3003 Returns a list of hashrefs, each of which may contain:
3005 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
3006 ext_description, which is an arrayref of detail lines to show below
3011 sub _items_cust_bill_pkg {
3013 my $conf = $self->conf;
3014 my $cust_bill_pkgs = shift;
3017 my $format = $opt{format} || '';
3018 my $escape_function = $opt{escape_function} || sub { shift };
3019 my $format_function = $opt{format_function} || '';
3020 my $no_usage = $opt{no_usage} || '';
3021 my $unsquelched = $opt{unsquelched} || ''; #unused
3022 my ($section, $locationnum, $category);
3023 if ( $opt{section} ) {
3024 $category = $opt{section}->{category};
3025 $locationnum = $opt{section}->{locationnum};
3027 my $summary_page = $opt{summary_page} || ''; #unused
3028 my $multisection = defined($category) || defined($locationnum);
3029 # this variable is the value of the config setting, not whether it applies
3030 # to this particular line item.
3031 my $discount_show_always = $conf->exists('discount-show-always');
3033 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 40;
3035 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
3037 # for location labels: use default location on the invoice date
3038 my $default_locationnum;
3039 if ( $self->custnum ) {
3041 my @h_search = FS::h_cust_main->sql_h_search($self->_date);
3042 $h_cust_main = qsearchs({
3043 'table' => 'h_cust_main',
3044 'hashref' => { custnum => $self->custnum },
3045 'extra_sql' => $h_search[1],
3046 'addl_from' => $h_search[3],
3048 $default_locationnum = $h_cust_main->ship_locationnum;
3049 } elsif ( $self->prospectnum ) {
3050 my $cust_location = qsearchs('cust_location',
3051 { prospectnum => $self->prospectnum,
3053 $default_locationnum = $cust_location->locationnum if $cust_location;
3056 my @b = (); # accumulator for the line item hashes that we'll return
3057 my ($s, $r, $u, $d) = ( undef, undef, undef, undef );
3058 # the 'current' line item hashes for setup, recur, usage, discount
3059 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
3061 # if the current line item is waiting to go out, and the one we're about
3062 # to start is not bundled, then push out the current one and start a new
3064 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3065 if ( $_ && !$cust_bill_pkg->hidden ) {
3066 $_->{amount} = sprintf( "%.2f", $_->{amount} );
3067 $_->{amount} =~ s/^\-0\.00$/0.00/;
3068 if (exists($_->{unit_amount})) {
3069 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3072 # we already decided to create this display line; don't reconsider it
3074 # if $_->{amount} != 0
3075 # || $discount_show_always
3076 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3077 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3083 if ( $locationnum ) {
3084 # this is a location section; skip packages that aren't at this
3086 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
3087 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
3091 # Consider display records for this item to determine if it belongs
3092 # in this section. Note that if there are no display records, there
3093 # will be a default pseudo-record that includes all charge types
3094 # and has no section name.
3095 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
3096 ? $cust_bill_pkg->cust_bill_pkg_display
3097 : ( $cust_bill_pkg );
3099 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
3100 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
3103 if ( defined($category) ) {
3104 # then this is a package category section; process all display records
3105 # that belong to this section.
3106 @cust_bill_pkg_display = grep { $_->section eq $category }
3107 @cust_bill_pkg_display;
3109 # otherwise, process all display records that aren't usage summaries
3110 # (I don't think there should be usage summaries if you aren't using
3111 # category sections, but this is the historical behavior)
3112 @cust_bill_pkg_display = grep { !$_->summary }
3113 @cust_bill_pkg_display;
3116 my $classname = ''; # package class name, will fill in later
3118 foreach my $display (@cust_bill_pkg_display) {
3120 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
3121 $display->billpkgdisplaynum. "\n"
3124 my $type = $display->type;
3126 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
3127 $desc = substr($desc, 0, $maxlength). '...'
3128 if $format eq 'latex' && length($desc) > $maxlength;
3130 my %details_opt = ( 'format' => $format,
3131 'escape_function' => $escape_function,
3132 'format_function' => $format_function,
3133 'no_usage' => $opt{'no_usage'},
3136 if ( ref($cust_bill_pkg) eq 'FS::quotation_pkg' ) {
3137 # XXX this should be pulled out into quotation_pkg
3139 warn "$me _items_cust_bill_pkg cust_bill_pkg is quotation_pkg\n"
3141 # quotation_pkgs are never fees, so don't worry about the case where
3142 # part_pkg is undefined
3144 my @details = $cust_bill_pkg->details;
3146 # and I guess they're never bundled either?
3147 if ( $cust_bill_pkg->setup != 0 ) {
3148 my $description = $desc;
3149 $description .= ' Setup'
3150 if $cust_bill_pkg->recur != 0
3151 || $discount_show_always
3152 || $cust_bill_pkg->recur_show_zero;
3154 # keep it consistent, please
3156 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3157 'description' => $description,
3158 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
3159 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitsetup),
3160 'quantity' => $cust_bill_pkg->quantity,
3161 'ext_description' => \@details,
3162 'preref_html' => ( $opt{preref_callback}
3163 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3168 if ( $cust_bill_pkg->recur != 0 ) {
3171 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3172 'description' => "$desc (". $cust_bill_pkg->part_pkg->freq_pretty.")",
3173 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
3174 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitrecur),
3175 'quantity' => $cust_bill_pkg->quantity,
3176 'ext_description' => \@details,
3177 'preref_html' => ( $opt{preref_callback}
3178 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3184 } elsif ( $cust_bill_pkg->pkgnum > 0 ) {
3185 # a "normal" package line item (not a quotation, not a fee, not a tax)
3187 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
3190 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3191 my $part_pkg = $cust_pkg->part_pkg;
3193 # which pkgpart to show for display purposes?
3194 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
3196 # start/end dates for invoice formats that do nonstandard
3198 my %item_dates = ();
3199 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
3200 unless $part_pkg->option('disable_line_item_date_ranges',1);
3202 # not normally used, but pass this to the template anyway
3203 $classname = $part_pkg->classname;
3205 if ( (!$type || $type eq 'S')
3206 && ( $cust_bill_pkg->setup != 0
3207 || $cust_bill_pkg->setup_show_zero
3208 || ($discount_show_always and $cust_bill_pkg->unitsetup > 0)
3213 warn "$me _items_cust_bill_pkg adding setup\n"
3216 # append the word 'Setup' to the setup line if there's going to be
3217 # a recur line for the same package (i.e. not a one-time charge)
3218 my $description = $desc;
3219 $description .= ' Setup'
3220 if $cust_bill_pkg->recur != 0
3221 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3222 || $cust_bill_pkg->recur_show_zero;
3224 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3226 if $part_pkg->is_prepaid #for prepaid, "display the validity period
3227 # triggered by the recurring charge freq
3229 && $cust_bill_pkg->recur == 0
3230 && ! $cust_bill_pkg->recur_show_zero;
3235 # always pass the svc_label through to the template, even if
3236 # not displaying it as an ext_description
3237 my @svc_labels = map &{$escape_function}($_),
3238 $cust_pkg->h_labels_short($self->_date, undef, 'I');
3240 $svc_label = $svc_labels[0];
3242 unless ( $cust_pkg->part_pkg->hide_svc_detail
3243 || $cust_bill_pkg->hidden )
3246 push @d, @svc_labels
3247 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3248 # show the location label if it's not the customer's default
3249 # location, and we're not grouping items by location already
3250 if ( $cust_pkg->locationnum != $default_locationnum
3251 and !defined($locationnum) ) {
3252 my $loc = $cust_pkg->location_label;
3253 $loc = substr($loc, 0, $maxlength). '...'
3254 if $format eq 'latex' && length($loc) > $maxlength;
3255 push @d, &{$escape_function}($loc);
3258 } #unless hiding service details
3260 push @d, $cust_bill_pkg->details(%details_opt)
3261 if $cust_bill_pkg->recur == 0;
3263 if ( $cust_bill_pkg->hidden ) {
3264 $s->{amount} += $cust_bill_pkg->setup;
3265 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3266 push @{ $s->{ext_description} }, @d;
3270 description => $description,
3271 pkgpart => $pkgpart,
3272 pkgnum => $cust_bill_pkg->pkgnum,
3273 amount => $cust_bill_pkg->setup,
3274 setup_show_zero => $cust_bill_pkg->setup_show_zero,
3275 unit_amount => $cust_bill_pkg->unitsetup,
3276 quantity => $cust_bill_pkg->quantity,
3277 ext_description => \@d,
3278 svc_label => ($svc_label || ''),
3279 locationnum => $cust_pkg->locationnum, # sure, why not?
3285 # should we show a recur line?
3286 # if type eq 'S', then NO, because we've been told not to.
3287 # otherwise, show the recur line if:
3288 # - there's a recurring charge
3289 # - or recur_show_zero is on
3290 # - or there's a positive unitrecur (so it's been discounted to zero)
3291 # and discount-show-always is on
3292 if ( ( !$type || $type eq 'R' || $type eq 'U' )
3294 $cust_bill_pkg->recur != 0
3296 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3297 || $cust_bill_pkg->recur_show_zero
3302 warn "$me _items_cust_bill_pkg adding recur/usage\n"
3305 my $is_summary = $display->summary;
3306 my $description = $desc;
3307 if ( $type eq 'U' and defined($r) ) {
3308 # don't just show the same description as the recur line
3309 $description = $self->mt('Usage charges');
3312 my $part_pkg = $cust_pkg->part_pkg;
3314 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3318 my @seconds = (); # for display of usage info
3321 #at least until cust_bill_pkg has "past" ranges in addition to
3322 #the "future" sdate/edate ones... see #3032
3323 my @dates = ( $self->_date );
3324 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
3325 push @dates, $prev->sdate if $prev;
3326 push @dates, undef if !$prev;
3328 my @svc_labels = map &{$escape_function}($_),
3329 $cust_pkg->h_labels_short(@dates, 'I');
3330 $svc_label = $svc_labels[0];
3332 # show service labels, unless...
3333 # the package is set not to display them
3334 unless ( $part_pkg->hide_svc_detail
3335 # or this is a tax-like line item
3336 || $cust_bill_pkg->itemdesc
3337 # or this is a hidden (bundled) line item
3338 || $cust_bill_pkg->hidden
3339 # or this is a usage summary line
3340 || $is_summary && $type && $type eq 'U'
3341 # or this is a usage line and there's a recurring line
3342 # for the package in the same section (which will
3343 # have service labels already)
3344 || ($type eq 'U' and defined($r))
3348 warn "$me _items_cust_bill_pkg adding service details\n"
3351 push @d, @svc_labels
3352 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3353 warn "$me _items_cust_bill_pkg done adding service details\n"
3356 # show the location label if it's not the customer's default
3357 # location, and we're not grouping items by location already
3358 if ( $cust_pkg->locationnum != $default_locationnum
3359 and !defined($locationnum) ) {
3360 my $loc = $cust_pkg->location_label;
3361 $loc = substr($loc, 0, $maxlength). '...'
3362 if $format eq 'latex' && length($loc) > $maxlength;
3363 push @d, &{$escape_function}($loc);
3366 # Display of seconds_since_sqlradacct:
3367 # On the invoice, when processing @detail_items, look for a field
3368 # named 'seconds'. This will contain total seconds for each
3369 # service, in the same order as @ext_description. For services
3370 # that don't support this it will show undef.
3371 if ( $conf->exists('svc_acct-usage_seconds')
3372 and ! $cust_bill_pkg->pkgpart_override ) {
3373 foreach my $cust_svc (
3374 $cust_pkg->h_cust_svc(@dates, 'I')
3377 # eval because not having any part_export_usage exports
3378 # is a fatal error, last_bill/_date because that's how
3379 # sqlradius_hour billing does it
3381 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
3383 push @seconds, $sec;
3385 } #if svc_acct-usage_seconds
3387 } # if we are showing service labels
3389 unless ( $is_summary ) {
3390 warn "$me _items_cust_bill_pkg adding details\n"
3393 #instead of omitting details entirely in this case (unwanted side
3394 # effects), just omit CDRs
3395 $details_opt{'no_usage'} = 1
3396 if $type && $type eq 'R';
3398 push @d, $cust_bill_pkg->details(%details_opt);
3401 warn "$me _items_cust_bill_pkg calculating amount\n"
3406 $amount = $cust_bill_pkg->recur;
3407 } elsif ($type eq 'R') {
3408 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
3409 } elsif ($type eq 'U') {
3410 $amount = $cust_bill_pkg->usage;
3413 if ( !$type || $type eq 'R' ) {
3415 warn "$me _items_cust_bill_pkg adding recur\n"
3419 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
3422 if ( $cust_bill_pkg->hidden ) {
3423 $r->{amount} += $amount;
3424 $r->{unit_amount} += $unit_amount;
3425 push @{ $r->{ext_description} }, @d;
3428 description => $description,
3429 pkgpart => $pkgpart,
3430 pkgnum => $cust_bill_pkg->pkgnum,
3432 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3433 unit_amount => $unit_amount,
3434 quantity => $cust_bill_pkg->quantity,
3436 ext_description => \@d,
3437 svc_label => ($svc_label || ''),
3438 locationnum => $cust_pkg->locationnum,
3440 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3443 } else { # $type eq 'U'
3445 warn "$me _items_cust_bill_pkg adding usage\n"
3448 if ( $cust_bill_pkg->hidden and defined($u) ) {
3449 # if this is a hidden package and there's already a usage
3450 # line for the bundle, add this package's total amount and
3451 # usage details to it
3452 $u->{amount} += $amount;
3453 push @{ $u->{ext_description} }, @d;
3454 } elsif ( $amount ) {
3455 # create a new usage line
3457 description => $description,
3458 pkgpart => $pkgpart,
3459 pkgnum => $cust_bill_pkg->pkgnum,
3462 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3464 ext_description => \@d,
3465 locationnum => $cust_pkg->locationnum,
3467 } # else this has no usage, so don't create a usage section
3470 } # recurring or usage with recurring charge
3472 } else { # taxes and fees
3474 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3477 # items of this kind should normally not have sdate/edate.
3479 'description' => $desc,
3480 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
3481 + $cust_bill_pkg->recur)
3484 } # if quotation / package line item / other line item
3486 # decide whether to show active discounts here
3488 # case 1: we are showing a single line for the package
3490 # case 2: we are showing a setup line for a package that has
3491 # no base recurring fee
3492 or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3493 # case 3: we are showing a recur line for a package that has
3494 # a base recurring fee
3495 or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3498 my $item_discount = $cust_bill_pkg->_item_discount;
3499 if ( $item_discount ) {
3500 # $item_discount->{amount} is negative
3502 if ( $d and $cust_bill_pkg->hidden ) {
3503 $d->{amount} += $item_discount->{amount};
3505 $d = $item_discount;
3506 $_ = &{$escape_function}($_) foreach @{ $d->{ext_description} };
3509 # update the active line (before the discount) to show the
3510 # original price (whether this is a hidden line or not)
3512 # quotation discounts keep track of setup and recur; invoice
3513 # discounts currently don't
3514 if ( exists $item_discount->{setup_amount} ) {
3516 $s->{amount} -= $item_discount->{setup_amount} if $s;
3517 $r->{amount} -= $item_discount->{recur_amount} if $r;
3521 # $active_line is the line item hashref for the line that will
3522 # show the original price
3523 # (use the recur or single line for the package, unless we're
3524 # showing a setup line for a package with no recurring fee)
3525 my $active_line = $r;
3526 if ( $type eq 'S' ) {
3529 $active_line->{amount} -= $item_discount->{amount};
3533 } # if there are any discounts
3534 } # if this is an appropriate place to show discounts
3536 } # foreach $display
3540 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3542 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3543 if exists($_->{amount});
3544 $_->{amount} =~ s/^\-0\.00$/0.00/;
3545 if (exists($_->{unit_amount})) {
3546 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3550 #if $_->{amount} != 0
3551 # || $discount_show_always
3552 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3553 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3557 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3564 =item _items_discounts_avail
3566 Returns an array of line item hashrefs representing available term discounts
3567 for this invoice. This makes the same assumptions that apply to term
3568 discounts in general: that the package is billed monthly, at a flat rate,
3569 with no usage charges. A prorated first month will be handled, as will
3570 a setup fee if the discount is allowed to apply to setup fees.
3574 sub _items_discounts_avail {
3577 #maybe move this method from cust_bill when quotations support discount_plans
3578 return () unless $self->can('discount_plans');
3579 my %plans = $self->discount_plans;
3581 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3582 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3586 my $plan = $plans{$months};
3588 my $term_total = sprintf('%.2f', $plan->discounted_total);
3589 my $percent = sprintf('%.0f',
3590 100 * (1 - $term_total / $plan->base_total) );
3591 my $permonth = sprintf('%.2f', $term_total / $months);
3592 my $detail = $self->mt('discount on item'). ' '.
3593 join(', ', map { "#$_" } $plan->pkgnums)
3596 # discounts for non-integer months don't work anyway
3597 $months = sprintf("%d", $months);
3600 description => $self->mt('Save [_1]% by paying for [_2] months',
3602 amount => $self->mt('[_1] ([_2] per month)',
3603 $term_total, $money_char.$permonth),
3604 ext_description => ($detail || ''),
3607 sort { $b <=> $a } keys %plans;