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;
18 use FS::Misc qw( send_email );
19 use FS::Record qw( qsearch qsearchs );
21 use FS::Misc qw( generate_ps generate_pdf );
28 $me = '[FS::Template_Mixin]';
29 FS::UID->install_callback( sub {
30 my $conf = new FS::Conf; #global
31 $money_char = $conf->config('money_char') || '$';
32 $date_format = $conf->config('date_format') || '%x'; #/YY
37 Returns a configuration handle (L<FS::Conf>) set to the customer's locale.
39 If the "mode" pseudo-field is set on the object, the configuration handle
40 will be an L<FS::invoice_conf> for that invoice mode (and the customer's
47 my $mode = $self->get('mode');
48 if ($self->{_conf} and !defined($mode)) {
49 return $self->{_conf};
52 my $cust_main = $self->cust_main;
53 my $locale = $cust_main ? $cust_main->locale : '';
56 if ( ref $mode and $mode->isa('FS::invoice_mode') ) {
57 $mode = $mode->modenum;
58 } elsif ( $mode =~ /\D/ ) {
59 die "invalid invoice mode $mode";
61 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => $locale });
63 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => '' });
64 # it doesn't have a locale, but system conf still might
65 $conf->set('locale' => $locale) if $conf;
68 # if $mode is unspecified, or if there is no invoice_conf matching this mode
69 # and locale, then use the system config only (but with the locale)
70 $conf ||= FS::Conf->new({ 'locale' => $locale });
72 return $self->{_conf} = $conf;
75 =item print_text OPTIONS
77 Returns an text invoice, as a list of lines.
79 Options can be passed as a hash.
81 I<time>, if specified, is used to control the printing of overdue messages. The
82 default is now. It isn't the date of the invoice; that's the `_date' field.
83 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
84 L<Time::Local> and L<Date::Parse> for conversion functions.
86 I<template>, if specified, is the name of a suffix for alternate invoices.
88 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
96 %params = %{ shift() };
101 $params{'format'} = 'template'; # for some reason
103 $self->print_generic( %params );
106 =item print_latex HASHREF
108 Internal method - returns a filename of a filled-in LaTeX template for this
109 invoice (Note: add ".tex" to get the actual filename), and a filename of
110 an associated logo (with the .eps extension included).
112 See print_ps and print_pdf for methods that return PostScript and PDF output.
114 Options can be passed as a hash.
116 I<time>, if specified, is used to control the printing of overdue messages. The
117 default is now. It isn't the date of the invoice; that's the `_date' field.
118 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
119 L<Time::Local> and L<Date::Parse> for conversion functions.
121 I<template>, if specified, is the name of a suffix for alternate invoices.
122 This is strongly deprecated; see L<FS::invoice_conf> for the right way to
123 customize invoice templates for different purposes.
125 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
134 %params = %{ shift() };
139 $params{'format'} = 'latex';
140 my $conf = $self->conf;
142 # this needs to go away
143 my $template = $params{'template'};
144 # and this especially
145 $template ||= $self->_agent_template
146 if $self->can('_agent_template');
148 my $pkey = $self->primary_key;
149 my $tmp_template = $self->table. '.'. $self->$pkey. '.XXXXXXXX';
151 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
152 my $lh = new File::Temp(
153 TEMPLATE => $tmp_template,
157 ) or die "can't open temp file: $!\n";
159 my $agentnum = $self->agentnum;
161 if ( $template && $conf->exists("logo_${template}.eps", $agentnum) ) {
162 print $lh $conf->config_binary("logo_${template}.eps", $agentnum)
163 or die "can't write temp file: $!\n";
165 print $lh $conf->config_binary('logo.eps', $agentnum)
166 or die "can't write temp file: $!\n";
169 $params{'logo_file'} = $lh->filename;
171 if( $conf->exists('invoice-barcode')
172 && $self->can('invoice_barcode')
173 && $self->invnum ) { # don't try to barcode statements
174 my $png_file = $self->invoice_barcode($dir);
175 my $eps_file = $png_file;
176 $eps_file =~ s/\.png$/.eps/g;
177 $png_file =~ /(barcode.*png)/;
179 $eps_file =~ /(barcode.*eps)/;
182 my $curr_dir = cwd();
184 # after painfuly long experimentation, it was determined that sam2p won't
185 # accept : and other chars in the path, no matter how hard I tried to
186 # escape them, hence the chdir (and chdir back, just to be safe)
187 system('sam2p', '-j:quiet', $png_file, 'EPS:', $eps_file ) == 0
188 or die "sam2p failed: $!\n";
192 $params{'barcode_file'} = $eps_file;
195 my @filled_in = $self->print_generic( %params );
197 my $fh = new File::Temp( TEMPLATE => $tmp_template,
201 ) or die "can't open temp file: $!\n";
202 binmode($fh, ':utf8'); # language support
203 print $fh join('', @filled_in );
206 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
207 return ($1, $params{'logo_file'}, $params{'barcode_file'});
213 my $cust_main = $self->cust_main;
214 $cust_main ? $cust_main->agentnum : $self->prospect_main->agentnum;
217 =item print_generic OPTION => VALUE ...
219 Internal method - returns a filled-in template for this invoice as a scalar.
221 See print_ps and print_pdf for methods that return PostScript and PDF output.
229 The B<format> option is required and should be set to html, latex (print and PDF) or template (plaintext).
239 Overrides "Invoice" as the name of the sent document.
243 Used to control the printing of overdue messages. The
244 default is now. It isn't the date of the invoice; that's the `_date' field.
245 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
246 L<Time::Local> and L<Date::Parse> for conversion functions.
250 Logo file (path to temporary EPS file on the local filesystem)
254 CID for inline (emailed) images (logo)
258 Override customer's locale
262 Overrides any per customer cdr squelching when true
266 Supress the (invoice, quotation, statement, etc.) number
274 Supress the payment coupon
278 Barcode file (path to temporary EPS file on the local filesystem)
282 Flag indicating the barcode image should be a link (normal HTML dipaly)
286 Barcode CID for inline (emailed) images
288 =item preref_callback
290 Coderef run for each line item, code should return HTML to be displayed
291 before that line item (quotations only)
295 Dprecated. Used as a suffix for a configuration template. Please
296 don't use this, it deprecated in favor of more flexible alternatives.
302 #what's with all the sprintf('%10.2f')'s in here? will it cause any
303 # (alignment in text invoice?) problems to change them all to '%.2f' ?
304 # yes: fixed width/plain text printing will be borked
306 my( $self, %params ) = @_;
307 my $conf = $self->conf;
309 my $today = $params{today} ? $params{today} : time;
310 warn "$me print_generic called on $self with suffix $params{template}\n"
313 my $format = $params{format};
314 die "Unknown format: $format"
315 unless $format =~ /^(latex|html|template)$/;
317 my $cust_main = $self->cust_main || $self->prospect_main;
319 my $locale = $params{'locale'} || $cust_main->locale;
321 my %delimiters = ( 'latex' => [ '[@--', '--@]' ],
322 'html' => [ '<%=', '%>' ],
323 'template' => [ '{', '}' ],
326 warn "$me print_generic creating template\n"
329 # set the notice name here, and nowhere else.
330 my $notice_name = $params{notice_name}
331 || $conf->config('notice_name')
332 || $self->notice_name;
335 my $template = $params{template} ? $params{template} : $self->_agent_template;
336 my $templatefile = $self->template_conf. $format;
337 $templatefile .= "_$template"
338 if length($template) && $conf->exists($templatefile."_$template");
341 my @invoice_template = map "$_\n", $conf->config($templatefile)
342 or die "cannot load config data $templatefile";
344 if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
345 #change this to a die when the old code is removed
346 # it's been almost ten years, changing it to a die
347 die "old-style invoice template $templatefile; ".
348 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
349 #$old_latex = 'true';
350 #@invoice_template = _translate_old_latex_format(@invoice_template);
353 warn "$me print_generic creating T:T object\n"
356 my $text_template = new Text::Template(
358 SOURCE => \@invoice_template,
359 DELIMITERS => $delimiters{$format},
362 warn "$me print_generic compiling T:T object\n"
365 $text_template->compile()
366 or die "Can't compile $templatefile: $Text::Template::ERROR\n";
369 # additional substitution could possibly cause breakage in existing templates
372 'notes' => sub { map "$_", @_ },
373 'footer' => sub { map "$_", @_ },
374 'smallfooter' => sub { map "$_", @_ },
375 'returnaddress' => sub { map "$_", @_ },
376 'coupon' => sub { map "$_", @_ },
377 'summary' => sub { map "$_", @_ },
383 s/%%(.*)$/<!-- $1 -->/g;
384 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
385 s/\\begin\{enumerate\}/<ol>/g;
387 s/\\end\{enumerate\}/<\/ol>/g;
388 s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
397 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
399 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
405 s/\\hyphenation\{[\w\s\-]+}//;
410 'coupon' => sub { "" },
411 'summary' => sub { "" },
418 s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
419 s/\\begin\{enumerate\}//g;
421 s/\\end\{enumerate\}//g;
422 s/\\textbf\{(.*)\}/$1/g;
429 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
431 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
436 s/\\\\\*?\s*$/\n/; # dubious
437 s/\\hyphenation\{[\w\s\-]+}//;
441 'coupon' => sub { "" },
442 'summary' => sub { "" },
447 # hashes for differing output formats
448 my %nbsps = ( 'latex' => '~',
449 'html' => '', # '&nbps;' would be nice
450 'template' => '', # not used
452 my $nbsp = $nbsps{$format};
454 my %escape_functions = ( 'latex' => \&_latex_escape,
455 'html' => \&_html_escape_nbsp,#\&encode_entities,
456 'template' => sub { shift },
458 my $escape_function = $escape_functions{$format};
459 my $escape_function_nonbsp = ($format eq 'html')
460 ? \&_html_escape : $escape_function;
462 my %newline_tokens = ( 'latex' => '\\\\',
466 my $newline_token = $newline_tokens{$format};
468 warn "$me generating template variables\n"
471 # generate template variables
475 defined( $conf->config_orbase( "invoice_${format}returnaddress",
479 && length( $conf->config_orbase( "invoice_${format}returnaddress",
485 $returnaddress = join("\n",
486 $conf->config_orbase("invoice_${format}returnaddress", $template)
490 $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
492 my $convert_map = $convert_maps{$format}{'returnaddress'};
495 &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
500 } elsif ( grep /\S/, $conf->config('company_address', $cust_main->agentnum) ) {
502 my $convert_map = $convert_maps{$format}{'returnaddress'};
503 $returnaddress = join( "\n", &$convert_map(
504 map { s/( {2,})/'~' x length($1)/eg;
508 ( $conf->config('company_name', $cust_main->agentnum),
509 $conf->config('company_address', $cust_main->agentnum),
516 my $warning = "Couldn't find a return address; ".
517 "do you need to set the company_address configuration value?";
519 $returnaddress = $nbsp;
520 #$returnaddress = $warning;
524 warn "$me generating invoice data\n"
527 my $agentnum = $cust_main->agentnum;
532 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
533 'company_address' => join("\n", $conf->config('company_address', $agentnum) ). "\n",
534 'company_phonenum'=> scalar( $conf->config('company_phonenum', $agentnum) ),
535 'returnaddress' => $returnaddress,
536 'agent' => &$escape_function($cust_main->agent->agent),
538 #invoice/quotation info
539 'no_number' => $params{'no_number'},
540 'invnum' => ( $params{'no_number'} ? '' : $self->invnum ),
541 'quotationnum' => $self->quotationnum,
542 'no_date' => $params{'no_date'},
543 '_date' => ( $params{'no_date'} ? '' : $self->_date ),
544 # workaround for inconsistent behavior in the early plain text
545 # templates; see RT#28271
546 'date' => ( $params{'no_date'}
548 : ($format eq 'template'
550 : $self->time2str_local('long', $self->_date, $format)
553 'today' => $self->time2str_local('long', $today, $format),
554 'terms' => $self->terms,
555 'template' => $template, #params{'template'},
556 'notice_name' => $notice_name, # escape?
557 'current_charges' => sprintf("%.2f", $self->charged),
558 'duedate' => $self->due_date2str('rdate'), #date_format?
561 'custnum' => $cust_main->display_custnum,
562 'prospectnum' => $cust_main->prospectnum,
563 'agent_custid' => &$escape_function($cust_main->agent_custid),
564 ( map { $_ => &$escape_function($cust_main->$_()) }
565 qw( company address1 address2 city state zip fax )
567 'payname' => &$escape_function( $cust_main->invoice_attn
568 || $cust_main->contact_firstlast ),
571 'ship_enable' => $cust_main->invoice_ship_address || $conf->exists('invoice-ship_address'),
572 'unitprices' => $conf->exists('invoice-unitprice'),
573 'smallernotes' => $conf->exists('invoice-smallernotes'),
574 'smallerfooter' => $conf->exists('invoice-smallerfooter'),
575 'balance_due_below_line' => $conf->exists('balance_due_below_line'),
577 #layout info -- would be fancy to calc some of this and bury the template
579 'topmargin' => scalar($conf->config('invoice_latextopmargin', $agentnum)),
580 'headsep' => scalar($conf->config('invoice_latexheadsep', $agentnum)),
581 'textheight' => scalar($conf->config('invoice_latextextheight', $agentnum)),
582 'extracouponspace' => scalar($conf->config('invoice_latexextracouponspace', $agentnum)),
583 'couponfootsep' => scalar($conf->config('invoice_latexcouponfootsep', $agentnum)),
584 'verticalreturnaddress' => $conf->exists('invoice_latexverticalreturnaddress', $agentnum),
585 'addresssep' => scalar($conf->config('invoice_latexaddresssep', $agentnum)),
586 'amountenclosedsep' => scalar($conf->config('invoice_latexcouponamountenclosedsep', $agentnum)),
587 'coupontoaddresssep' => scalar($conf->config('invoice_latexcoupontoaddresssep', $agentnum)),
588 'addcompanytoaddress' => $conf->exists('invoice_latexcouponaddcompanytoaddress', $agentnum),
590 # better hang on to conf_dir for a while (for old templates)
591 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
593 #these are only used when doing paged plaintext
600 $invoice_data{'emt'} = sub { &$escape_function($self->mt(@_)) };
601 # prototype here to silence warnings
602 $invoice_data{'time2str'} = sub ($;$$) { $self->time2str_local(@_, $format) };
604 my $min_sdate = 999999999999;
606 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
607 next unless $cust_bill_pkg->pkgnum > 0;
608 $min_sdate = $cust_bill_pkg->sdate
609 if length($cust_bill_pkg->sdate) && $cust_bill_pkg->sdate < $min_sdate;
610 $max_edate = $cust_bill_pkg->edate
611 if length($cust_bill_pkg->edate) && $cust_bill_pkg->edate > $max_edate;
614 $invoice_data{'bill_period'} = '';
615 $invoice_data{'bill_period'} =
616 $self->time2str_local('%e %h', $min_sdate, $format)
618 $self->time2str_local('%e %h', $max_edate, $format)
619 if ($max_edate != 0 && $min_sdate != 999999999999);
621 $invoice_data{finance_section} = '';
622 if ( $conf->config('finance_pkgclass') ) {
624 qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
625 $invoice_data{finance_section} = $pkg_class->categoryname;
627 $invoice_data{finance_amount} = '0.00';
628 $invoice_data{finance_section} ||= 'Finance Charges'; #avoid config confusion
630 my $countrydefault = $conf->config('countrydefault') || 'US';
631 foreach ( qw( address1 address2 city state zip country fax) ){
632 my $method = 'ship_'.$_;
633 $invoice_data{"ship_$_"} = $escape_function->($cust_main->$method);
635 if ( length($cust_main->ship_company) ) {
636 $invoice_data{'ship_company'} = $escape_function->($cust_main->ship_company);
638 $invoice_data{'ship_company'} = $escape_function->($cust_main->company);
640 $invoice_data{'ship_contact'} = $escape_function->($cust_main->contact);
641 $invoice_data{'ship_country'} = ''
642 if ( $invoice_data{'ship_country'} eq $countrydefault );
644 $invoice_data{'cid'} = $params{'cid'}
647 if ( $cust_main->country eq $countrydefault ) {
648 $invoice_data{'country'} = '';
650 $invoice_data{'country'} = &$escape_function($cust_main->bill_country_full);
654 $invoice_data{'address'} = \@address;
656 $invoice_data{'payname'}.
657 ( $cust_main->po_number
658 ? " (P.O. #". $cust_main->po_number. ")"
662 push @address, $cust_main->company
663 if $cust_main->company;
664 push @address, $cust_main->address1;
665 push @address, $cust_main->address2
666 if $cust_main->address2;
668 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
669 push @address, $invoice_data{'country'}
670 if $invoice_data{'country'};
672 while (scalar(@address) < 5);
674 $invoice_data{'logo_file'} = $params{'logo_file'}
675 if $params{'logo_file'};
676 $invoice_data{'barcode_file'} = $params{'barcode_file'}
677 if $params{'barcode_file'};
678 $invoice_data{'barcode_img'} = $params{'barcode_img'}
679 if $params{'barcode_img'};
680 $invoice_data{'barcode_cid'} = $params{'barcode_cid'}
681 if $params{'barcode_cid'};
683 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
684 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
685 #my $balance_due = $self->owed + $pr_total - $cr_total;
686 my $balance_due = $self->owed;
687 if ( $self->enable_previous ) {
688 $balance_due += $pr_total;
690 # otherwise the previous balance is not shown, so including it in the
691 # balance due is just confusing
693 # the sum of amount owed on all invoices
694 # (this is used in the summary & on the payment coupon)
695 $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
697 # flag telling this invoice to have a first-page summary
698 my $summarypage = '';
700 if ( $self->custnum && $self->invnum ) {
701 # XXX should be an FS::cust_bill method to set the defaults, instead
702 # of checking the type here
704 # info from customer's last invoice before this one, for some
706 $invoice_data{'last_bill'} = {};
708 my $last_bill = $self->previous_bill;
711 # "balance_date_range" unfortunately is unsuitable for this, since it
712 # cares about application dates. We want to know the sum of all
713 # _top-level transactions_ dated before the last invoice.
715 # still do this for the "Previous Balance" line of the summary block
717 map "$_ WHERE _date <= ? AND custnum = ?", (
718 "SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill",
719 "SELECT -1 * COALESCE( SUM(amount), 0 ) FROM cust_credit",
720 "SELECT -1 * COALESCE( SUM(paid), 0 ) FROM cust_pay",
721 "SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund",
724 # the customer's current balance immediately after generating the last
727 my $last_bill_balance = $last_bill->charged;
729 my $delta = FS::Record->scalar_sql(
731 $last_bill->_date - 1,
734 $last_bill_balance += $delta;
737 $last_bill_balance = sprintf("%.2f", $last_bill_balance);
739 warn sprintf("LAST BILL: INVNUM %d, DATE %s, BALANCE %.2f\n\n",
741 $self->time2str_local('%D', $last_bill->_date),
744 # ("true_previous_balance" is a terrible name, but at least it's no
745 # longer stored in the database)
746 $invoice_data{'true_previous_balance'} = $last_bill_balance;
748 # Now, get all applications of credits/payments dated on or after the
749 # previous bill, to invoices before the current bill. (The
750 # credit/payment date restriction prevents these from intersecting
751 # the "Previous Balance" set.)
752 # These are "adjustments". The past due balance will be shown as
753 # Previous Balance - Adjustments.
756 "SELECT COALESCE(SUM(y.amount),0) FROM $_ JOIN cust_bill USING (invnum)
757 WHERE cust_bill._date < ?
759 AND cust_bill.custnum = ?"
760 } "cust_credit AS x JOIN cust_credit_bill y USING (crednum)",
761 "cust_pay AS x JOIN cust_bill_pay y USING (paynum)"
764 my $delta = FS::Record->scalar_sql(
770 $adjustments += $delta;
772 $invoice_data{'balance_adjustments'} = sprintf("%.2f", $adjustments);
774 warn sprintf("BALANCE ADJUSTMENTS: %.2f\n\n",
775 $invoice_data{'balance_adjustments'}
778 # the sum of amount owed on all previous invoices
779 # ($pr_total is used elsewhere but not as $previous_balance)
780 $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
782 $invoice_data{'last_bill'}{'_date'} = $last_bill->_date; #unformatted
783 my (@payments, @credits);
784 # for formats that itemize previous payments
785 foreach my $cust_pay ( qsearch('cust_pay', {
786 'custnum' => $self->custnum,
787 '_date' => { op => '>=',
788 value => $last_bill->_date }
791 next if $cust_pay->_date > $self->_date;
793 '_date' => $cust_pay->_date,
794 'date' => $self->time2str_local('long', $cust_pay->_date, $format),
795 'payinfo' => $cust_pay->payby_payinfo_pretty,
796 'amount' => sprintf('%.2f', $cust_pay->paid),
798 # not concerned about applications
800 foreach my $cust_credit ( qsearch('cust_credit', {
801 'custnum' => $self->custnum,
802 '_date' => { op => '>=',
803 value => $last_bill->_date }
806 next if $cust_credit->_date > $self->_date;
808 '_date' => $cust_credit->_date,
809 'date' => $self->time2str_local('long', $cust_credit->_date, $format),
810 'creditreason'=> $cust_credit->reason,
811 'amount' => sprintf('%.2f', $cust_credit->amount),
814 $invoice_data{'previous_payments'} = \@payments;
815 $invoice_data{'previous_credits'} = \@credits;
817 # there is no $last_bill
818 $invoice_data{'true_previous_balance'} =
819 $invoice_data{'balance_adjustments'} =
820 $invoice_data{'previous_balance'} = '0.00';
821 $invoice_data{'previous_payments'} = [];
822 $invoice_data{'previous_credits'} = [];
825 if ( $conf->exists('invoice_usesummary', $agentnum) ) {
826 $invoice_data{'summarypage'} = $summarypage = 1;
829 } # if this is an invoice
831 warn "$me substituting variables in notes, footer, smallfooter\n"
834 my $tc = $self->template_conf;
835 my @include = ( [ $tc, 'notes' ],
836 [ 'invoice_', 'footer' ],
837 [ 'invoice_', 'smallfooter', ],
838 [ 'invoice_', 'watermark' ],
840 push @include, [ $tc, 'coupon', ]
841 unless $params{'no_coupon'};
843 foreach my $i (@include) {
845 # load the configuration for this sub-template
847 my($base, $include) = @$i;
849 my $inc_file = $conf->key_orbase("$base$format$include", $template);
851 my @inc_src = $conf->config($inc_file, $agentnum);
853 my $converter = $convert_maps{$format}{$include};
855 # then attempt to convert LaTeX to the requested format
856 $inc_file = $conf->key_orbase($base.'latex'.$include, $template);
857 @inc_src = &$converter( $conf->config($inc_file, $agentnum) );
859 # this isn't included in the convert_maps
860 my ($open, $close) = @{ $delimiters{$format} };
865 } # else @inc_src is empty and that's fine
867 # make a Text::Template out of it
869 my $inc_tt = new Text::Template (
871 SOURCE => [ map "$_\n", @inc_src ],
872 DELIMITERS => $delimiters{$format},
873 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
875 unless ( $inc_tt->compile() ) {
876 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
877 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
883 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
885 $invoice_data{$include} =~ s/\n+$//
886 if ($format eq 'latex');
889 # let invoices use either of these as needed
890 $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
891 ? $cust_main->payinfo : '';
892 $invoice_data{'po_line'} =
893 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
894 ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
897 my %money_chars = ( 'latex' => '',
898 'html' => $conf->config('money_char') || '$',
901 my $money_char = $money_chars{$format};
904 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
905 'html' => $conf->config('money_char') || '$',
908 my $other_money_char = $other_money_chars{$format};
909 $invoice_data{'dollar'} = $other_money_char;
911 my %minus_signs = ( 'latex' => '$-$',
913 'template' => '- ' );
914 my $minus = $minus_signs{$format};
916 my @detail_items = ();
917 my @total_items = ();
921 $invoice_data{'detail_items'} = \@detail_items;
922 $invoice_data{'total_items'} = \@total_items;
923 $invoice_data{'buf'} = \@buf;
924 $invoice_data{'sections'} = \@sections;
926 warn "$me generating sections\n"
929 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
930 my $multisection = $self->has_sections;
931 $conf->exists($tc.'sections', $cust_main->agentnum) ||
932 $conf->exists($tc.'sections_by_location', $cust_main->agentnum);
933 $invoice_data{'multisection'} = $multisection;
935 my $extra_sections = [];
936 my $extra_lines = ();
938 # default section ('Charges')
939 my $default_section = { 'description' => '',
944 # Previous Charges section
945 # subtotal is the first return value from $self->previous
946 my $previous_section;
947 # if the invoice has major sections, or if we're summarizing previous
948 # charges with a single line, or if we've been specifically told to put them
949 # in a section, create a section for previous charges:
950 if ( $multisection or
951 $conf->exists('previous_balance-summary_only') or
952 $conf->exists('previous_balance-section') ) {
954 $previous_section = { 'description' => $self->mt('Previous Charges'),
955 'subtotal' => $other_money_char.
956 sprintf('%.2f', $pr_total),
957 'summarized' => '', #why? $summarypage ? 'Y' : '',
959 $previous_section->{posttotal} = '0 / 30 / 60 / 90 days overdue '.
960 join(' / ', map { $cust_main->balance_date_range(@$_) }
961 $self->_prior_month30s
963 if $conf->exists('invoice_include_aging');
966 # otherwise put them in the main section
967 $previous_section = $default_section;
970 my $adjust_section = {
971 'description' => $self->mt('Credits, Payments, and Adjustments'),
972 'adjust_section' => 1,
973 'subtotal' => 0, # adjusted below
975 my $adjust_weight = _pkg_category($adjust_section->{description})
976 ? _pkg_category($adjust_section->{description})->weight
978 $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
979 # Note: 'sort_weight' here is actually a flag telling whether there is an
980 # explicit package category for the adjust section. If so, certain behavior
982 $adjust_section->{'sort_weight'} = $adjust_weight;
985 if ( $multisection ) {
986 ($extra_sections, $extra_lines) =
987 $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
988 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum)
989 && $self->can('_items_extra_usage_sections');
991 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
993 push @detail_items, @$extra_lines if $extra_lines;
995 # the code is written so that both methods can be used together, but
996 # we haven't yet changed the template to take advantage of that, so for
997 # now, treat them as mutually exclusive.
998 my %section_method = ( by_category => 1 );
999 if ( $conf->config($tc.'sections_method') eq 'location' ) {
1000 %section_method = ( by_location => 1 );
1002 my ($early, $late) =
1003 $self->_items_sections( 'summary' => $summarypage,
1004 'escape' => $escape_function_nonbsp,
1005 'extra_sections' => $extra_sections,
1006 'format' => $format,
1009 push @sections, @$early;
1010 $late_sections = $late;
1012 if ( $conf->exists('svc_phone_sections')
1013 && $self->can('_items_svc_phone_sections')
1016 my ($phone_sections, $phone_lines) =
1017 $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
1018 push @{$late_sections}, @$phone_sections;
1019 push @detail_items, @$phone_lines;
1021 if ( $conf->exists('voip-cust_accountcode_cdr')
1022 && $cust_main->accountcode_cdr
1023 && $self->can('_items_accountcode_cdr')
1026 my ($accountcode_section, $accountcode_lines) =
1027 $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
1028 if ( scalar(@$accountcode_lines) ) {
1029 push @{$late_sections}, $accountcode_section;
1030 push @detail_items, @$accountcode_lines;
1033 } else {# not multisection
1034 # make a default section
1035 push @sections, $default_section;
1036 # and calculate the finance charge total, since it won't get done otherwise.
1037 # and the default section total
1038 # XXX possibly finance_pkgclass should not be used in this manner?
1039 my @finance_charges;
1041 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1042 if ( $invoice_data{finance_section} and
1043 grep { $_->section eq $invoice_data{finance_section} }
1044 $cust_bill_pkg->cust_bill_pkg_display ) {
1045 # I think these are always setup fees, but just to be sure...
1046 push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1048 push @charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1051 $invoice_data{finance_amount} =
1052 sprintf('%.2f', sum( @finance_charges ) || 0);
1053 $default_section->{subtotal} = $other_money_char.
1054 sprintf('%.2f', sum( @charges ) || 0);
1057 # start setting up summary subtotals
1058 my @summary_subtotals;
1059 my $method = $conf->config('summary_subtotals_method');
1060 if ( $method and $method ne $conf->config($tc.'sections_method') ) {
1061 # then re-section them by the correct method
1062 my %section_method = ( by_category => 1 );
1063 if ( $conf->config('summary_subtotals_method') eq 'location' ) {
1064 %section_method = ( by_location => 1 );
1066 my ($early, $late) =
1067 $self->_items_sections( 'summary' => $summarypage,
1068 'escape' => $escape_function_nonbsp,
1069 'extra_sections' => $extra_sections,
1070 'format' => $format,
1073 foreach ( @$early ) {
1074 next if $_->{subtotal} == 0;
1075 $_->{subtotal} = $other_money_char.sprintf('%.2f', $_->{subtotal});
1076 push @summary_subtotals, $_;
1079 # subtotal sectioning is the same as for the actual invoice sections
1080 @summary_subtotals = @sections;
1083 # Hereafter, push sections to both @sections and @summary_subtotals
1084 # if they belong in both places (e.g. tax section). Late sections are
1085 # never in @summary_subtotals.
1087 # previous invoice balances in the Previous Charges section if there
1088 # is one, otherwise in the main detail section
1089 # (except if summary_only is enabled, don't show them at all)
1090 if ( $self->can('_items_previous') &&
1091 $self->enable_previous &&
1092 ! $conf->exists('previous_balance-summary_only') ) {
1094 warn "$me adding previous balances\n"
1097 foreach my $line_item ( $self->_items_previous ) {
1100 ref => $line_item->{'pkgnum'},
1101 pkgpart => $line_item->{'pkgpart'},
1102 #quantity => 1, # not really correct
1103 section => $previous_section, # which might be $default_section
1104 description => &$escape_function($line_item->{'description'}),
1105 ext_description => [ map { &$escape_function($_) }
1106 @{ $line_item->{'ext_description'} || [] }
1108 amount => $money_char . $line_item->{'amount'},
1109 product_code => $line_item->{'pkgpart'} || 'N/A',
1112 push @detail_items, $detail;
1113 push @buf, [ $detail->{'description'},
1114 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1120 if ( @pr_cust_bill && $self->enable_previous ) {
1121 push @buf, ['','-----------'];
1122 push @buf, [ $self->mt('Total Previous Balance'),
1123 $money_char. sprintf("%10.2f", $pr_total) ];
1127 if ( $conf->exists('svc_phone-did-summary') && $self->can('_did_summary') ) {
1128 warn "$me adding DID summary\n"
1131 my ($didsummary,$minutes) = $self->_did_summary;
1132 my $didsummary_desc = 'DID Activity Summary (since last invoice)';
1134 { 'description' => $didsummary_desc,
1135 'ext_description' => [ $didsummary, $minutes ],
1139 foreach my $section (@sections, @$late_sections) {
1141 # begin some normalization
1142 $section->{'subtotal'} = $section->{'amount'}
1144 && !exists($section->{subtotal})
1145 && exists($section->{amount});
1147 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
1148 if ( $invoice_data{finance_section} &&
1149 $section->{'description'} eq $invoice_data{finance_section} );
1151 $section->{'subtotal'} = $other_money_char.
1152 sprintf('%.2f', $section->{'subtotal'})
1155 # continue some normalization
1156 $section->{'amount'} = $section->{'subtotal'}
1160 if ( $section->{'description'} ) {
1161 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
1166 warn "$me setting options\n"
1170 $options{'section'} = $section if $multisection;
1171 $options{'format'} = $format;
1172 $options{'escape_function'} = $escape_function;
1173 $options{'no_usage'} = 1 unless $unsquelched;
1174 $options{'unsquelched'} = $unsquelched;
1175 $options{'summary_page'} = $summarypage;
1176 $options{'skip_usage'} =
1177 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
1178 $options{'preref_callback'} = $params{'preref_callback'};
1180 warn "$me searching for line items\n"
1183 foreach my $line_item ( $self->_items_pkg(%options),
1184 $self->_items_fee(%options) ) {
1186 warn "$me adding line item ".
1187 join(', ', map "$_=>".$line_item->{$_}, keys %$line_item). "\n"
1190 push @buf, ( [ $line_item->{'description'},
1191 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1193 map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}},
1196 $line_item->{'ref'} = $line_item->{'pkgnum'};
1197 $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()?
1198 $line_item->{'section'} = $section;
1199 $line_item->{'description'} = &$escape_function($line_item->{'description'});
1200 $line_item->{'amount'} = $money_char.$line_item->{'amount'};
1202 if ( length($line_item->{'unit_amount'}) ) {
1203 $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'};
1205 $line_item->{'ext_description'} ||= [];
1207 push @detail_items, $line_item;
1210 if ( $section->{'description'} ) {
1211 push @buf, ( ['','-----------'],
1212 [ $section->{'description'}. ' sub-total',
1213 $section->{'subtotal'} # already formatted this
1222 $invoice_data{current_less_finance} =
1223 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
1225 # if there's anything in the Previous Charges section, prepend it to the list
1226 if ( $pr_total and $previous_section ne $default_section ) {
1227 unshift @sections, $previous_section;
1228 # but not @summary_subtotals
1231 warn "$me adding taxes\n"
1234 # create a tax section if we don't yet have one
1235 my $tax_description = 'Taxes, Surcharges, and Fees';
1237 List::Util::first { $_->{description} eq $tax_description } @sections;
1238 if (!$tax_section) {
1239 $tax_section = { 'description' => $tax_description };
1241 $tax_section->{tax_section} = 1; # mark this section as containing taxes
1242 # if this is an existing tax section, we're merging the tax items into it.
1243 # grab the taxtotal that's already there, strip the money symbol if any
1244 my $taxtotal = $tax_section->{'subtotal'} || 0;
1245 $taxtotal =~ s/^\Q$other_money_char\E//;
1248 #my $tax_weight = _pkg_category($tax_section->{description})
1249 # ? _pkg_category($tax_section->{description})->weight
1251 #$tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
1252 #$tax_section->{'sort_weight'} = $tax_weight;
1254 my @items_tax = $self->_items_tax;
1255 push @sections, $tax_section if $multisection and @items_tax > 0;
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 # this is not supposed to happen
1680 sub template_conf { warn "bare FS::Template_Mixin::template_conf";
1684 # helper routine for generating date ranges
1685 sub _prior_month30s {
1688 [ 1, 2592000 ], # 0-30 days ago
1689 [ 2592000, 5184000 ], # 30-60 days ago
1690 [ 5184000, 7776000 ], # 60-90 days ago
1691 [ 7776000, 0 ], # 90+ days ago
1694 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
1695 $_->[1] ? $self->_date - $_->[1] - 1 : '',
1700 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1702 Returns an postscript invoice, as a scalar.
1704 Options can be passed as a hashref (recommended) or as a list of time, template
1705 and then any key/value pairs for any other options.
1707 I<time> an optional value used to control the printing of overdue messages. The
1708 default is now. It isn't the date of the invoice; that's the `_date' field.
1709 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1710 L<Time::Local> and L<Date::Parse> for conversion functions.
1712 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1719 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1720 my $ps = generate_ps($file);
1722 unlink($barcodefile) if $barcodefile;
1727 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1729 Returns an PDF invoice, as a scalar.
1731 Options can be passed as a hashref (recommended) or as a list of time, template
1732 and then any key/value pairs for any other options.
1734 I<time> an optional value used to control the printing of overdue messages. The
1735 default is now. It isn't the date of the invoice; that's the `_date' field.
1736 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1737 L<Time::Local> and L<Date::Parse> for conversion functions.
1739 I<template>, if specified, is the name of a suffix for alternate invoices.
1741 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1748 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1749 my $pdf = generate_pdf($file);
1751 unlink($barcodefile) if $barcodefile;
1756 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1758 Returns an HTML invoice, as a scalar.
1760 I<time> an optional value used to control the printing of overdue messages. The
1761 default is now. It isn't the date of the invoice; that's the `_date' field.
1762 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1763 L<Time::Local> and L<Date::Parse> for conversion functions.
1765 I<template>, if specified, is the name of a suffix for alternate invoices.
1767 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1769 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1770 when emailing the invoice as part of a multipart/related MIME email.
1778 %params = %{ shift() };
1782 $params{'format'} = 'html';
1784 $self->print_generic( %params );
1787 # quick subroutine for print_latex
1789 # There are ten characters that LaTeX treats as special characters, which
1790 # means that they do not simply typeset themselves:
1791 # # $ % & ~ _ ^ \ { }
1793 # TeX ignores blanks following an escaped character; if you want a blank (as
1794 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1798 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1799 $value =~ s/([<>])/\$$1\$/g;
1805 encode_entities($value);
1809 sub _html_escape_nbsp {
1810 my $value = _html_escape(shift);
1811 $value =~ s/ +/ /g;
1815 #utility methods for print_*
1817 sub _translate_old_latex_format {
1818 warn "_translate_old_latex_format called\n"
1825 if ( $line =~ /^%%Detail\s*$/ ) {
1827 push @template, q![@--!,
1828 q! foreach my $_tr_line (@detail_items) {!,
1829 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1830 q! $_tr_line->{'description'} .= !,
1831 q! "\\tabularnewline\n~~".!,
1832 q! join( "\\tabularnewline\n~~",!,
1833 q! @{$_tr_line->{'ext_description'}}!,
1837 while ( ( my $line_item_line = shift )
1838 !~ /^%%EndDetail\s*$/ ) {
1839 $line_item_line =~ s/'/\\'/g; # nice LTS
1840 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1841 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1842 push @template, " \$OUT .= '$line_item_line';";
1845 push @template, '}',
1848 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1850 push @template, '[@--',
1851 ' foreach my $_tr_line (@total_items) {';
1853 while ( ( my $total_item_line = shift )
1854 !~ /^%%EndTotalDetails\s*$/ ) {
1855 $total_item_line =~ s/'/\\'/g; # nice LTS
1856 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1857 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1858 push @template, " \$OUT .= '$total_item_line';";
1861 push @template, '}',
1865 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1866 push @template, $line;
1872 warn "$_\n" foreach @template;
1884 my $conf = $self->conf;
1886 #check for an invoice-specific override
1887 return $self->invoice_terms if $self->invoice_terms;
1889 #check for a customer- specific override
1890 my $cust_main = $self->cust_main;
1891 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1895 $agentnum = $cust_main->agentnum;
1896 } elsif ( my $prospect_main = $self->prospect_main ) {
1897 $agentnum = $prospect_main->agentnum;
1900 #use configured default
1901 $conf->config('invoice_default_terms', $agentnum) || '';
1911 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1912 $duedate = $self->_date() + ( $1 * 86400 );
1923 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
1926 =item balance_due_msg
1930 sub balance_due_msg {
1932 my $msg = $self->mt('Balance Due');
1933 return $msg unless $self->terms; # huh?
1934 if ( !$self->conf->exists('invoice_show_prior_due_date')
1935 or $self->conf->exists('invoice_sections') ) {
1936 # if enabled, the due date is shown with Total New Charges (see
1937 # _items_total) and not here
1938 # (yes, or if invoice_sections is enabled; this is just for compatibility)
1939 if ( $self->due_date ) {
1940 $msg .= ' - ' . $self->mt('Please pay by'). ' '.
1941 $self->due_date2str('short');
1942 } elsif ( $self->terms ) {
1943 $msg .= ' - '. $self->mt($self->terms);
1949 =item balance_due_date
1953 sub balance_due_date {
1955 my $conf = $self->conf;
1957 my $terms = $self->terms;
1958 if ( $terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1959 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
1964 sub credit_balance_msg {
1966 $self->mt('Credit Balance Remaining')
1971 Returns a string with the date, for example: "3/20/2008", localized for the
1972 customer. Use _date_pretty_unlocalized for non-end-customer display use.
1978 $self->time2str_local('short', $self->_date);
1981 =item _date_pretty_unlocalized
1983 Returns a string with the date, for example: "3/20/2008", in the format
1984 configured for the back-office. Use _date_pretty for end-customer display use.
1988 sub _date_pretty_unlocalized {
1990 time2str($date_format, $self->_date);
1995 Emails this template.
1997 Options are passed as a hashref. Available options:
2003 If specified, overrides the default From: address.
2007 If specified, overrides the name of the sent document ("Invoice" or "Quotation")
2011 (Deprecated) If specified, is the name of a suffix for alternate template files.
2015 Options accepted by generate_email can also be used.
2021 my $opt = shift || {};
2022 if ($opt and !ref($opt)) {
2023 die ref($self). '->email called with positional parameters';
2026 return if $self->hide;
2028 my $error = send_email(
2029 $self->generate_email(
2030 'subject' => $self->email_subject($opt->{template}),
2031 %$opt, # template, etc.
2035 die "can't email: $error\n" if $error;
2038 =item generate_email OPTION => VALUE ...
2046 sender address, required
2050 alternate template name, optional
2054 email subject, optional
2058 notice name instead of "Invoice", optional
2062 Returns an argument list to be passed to L<FS::Misc::send_email>.
2068 sub generate_email {
2072 my $conf = $self->conf;
2074 my $me = '[FS::Template_Mixin::generate_email]';
2077 'from' => $args{'from'},
2078 'subject' => ($args{'subject'} || $self->email_subject),
2079 'custnum' => $self->custnum,
2080 'msgtype' => 'invoice',
2083 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
2085 my $cust_main = $self->cust_main;
2087 if (ref($args{'to'}) eq 'ARRAY') {
2088 $return{'to'} = $args{'to'};
2089 } elsif ( $cust_main ) {
2090 $return{'to'} = [ $cust_main->invoicing_list_emailonly ];
2093 my $tc = $self->template_conf;
2095 my @text; # array of lines
2096 my $html; # a big string
2097 my @related_parts; # will contain the text/HTML alternative, and images
2098 my $related; # will contain the multipart/related object
2100 if ( $conf->exists($tc. 'email_pdf') ) {
2101 if ( my $msgnum = $conf->config($tc.'email_pdf_msgnum') ) {
2103 warn "$me using '${tc}email_pdf_msgnum' in multipart message"
2106 my $msg_template = FS::msg_template->by_key($msgnum)
2107 or die "${tc}email_pdf_msgnum $msgnum not found\n";
2108 my %prepared = $msg_template->prepare(
2109 cust_main => $self->cust_main,
2113 @text = split(/(?=\n)/, $prepared{'text_body'});
2114 $html = $prepared{'html_body'};
2116 } elsif ( my @note = $conf->config($tc.'email_pdf_note') ) {
2118 warn "$me using '${tc}email_pdf_note' in multipart message"
2120 @text = $conf->config($tc.'email_pdf_note');
2121 $html = join('<BR>', @text);
2123 } # else use the plain text invoice
2128 if ( $conf->config($tc.'template') ) {
2130 warn "$me generating plain text invoice"
2133 # 'print_text' argument is no longer used
2134 @text = $self->print_text(\%args);
2138 warn "$me no plain text version exists; sending empty message body"
2145 my $text_part = build MIME::Entity (
2146 'Type' => 'text/plain',
2147 'Encoding' => 'quoted-printable',
2148 'Charset' => 'UTF-8',
2149 #'Encoding' => '7bit',
2151 'Disposition' => 'inline',
2156 if ( $conf->exists($tc.'html') ) {
2157 warn "$me generating HTML invoice"
2160 $args{'from'} =~ /\@([\w\.\-]+)/;
2161 my $from = $1 || 'example.com';
2162 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2165 my $agentnum = $cust_main ? $cust_main->agentnum
2166 : $self->prospect_main->agentnum;
2167 if ( defined($args{'template'}) && length($args{'template'})
2168 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
2171 $logo = 'logo_'. $args{'template'}. '.png';
2175 my $image_data = $conf->config_binary( $logo, $agentnum);
2177 push @related_parts, build MIME::Entity
2178 'Type' => 'image/png',
2179 'Encoding' => 'base64',
2180 'Data' => $image_data,
2181 'Filename' => 'logo.png',
2182 'Content-ID' => "<$content_id>",
2185 if ( ref($self) eq 'FS::cust_bill' && $conf->exists('invoice-barcode') ) {
2186 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2187 push @related_parts, build MIME::Entity
2188 'Type' => 'image/png',
2189 'Encoding' => 'base64',
2190 'Data' => $self->invoice_barcode(0),
2191 'Filename' => 'barcode.png',
2192 'Content-ID' => "<$barcode_content_id>",
2194 $args{'barcode_cid'} = $barcode_content_id;
2197 $html = $self->print_html({ 'cid'=>$content_id, %args });
2204 warn "$me creating HTML/text multipart message"
2207 $return{'nobody'} = 1;
2209 my $alternative = build MIME::Entity
2210 'Type' => 'multipart/alternative',
2211 #'Encoding' => '7bit',
2212 'Disposition' => 'inline'
2216 $alternative->add_part($text_part);
2219 $alternative->attach(
2220 'Type' => 'text/html',
2221 'Encoding' => 'quoted-printable',
2222 'Data' => [ '<html>',
2225 ' '. encode_entities($return{'subject'}),
2228 ' <body bgcolor="#e8e8e8">',
2233 'Disposition' => 'inline',
2234 #'Filename' => 'invoice.pdf',
2237 unshift @related_parts, $alternative;
2239 $related = build MIME::Entity 'Type' => 'multipart/related',
2240 'Encoding' => '7bit';
2242 #false laziness w/Misc::send_email
2243 $related->head->replace('Content-type',
2244 $related->mime_type.
2245 '; boundary="'. $related->head->multipart_boundary. '"'.
2246 '; type=multipart/alternative'
2249 $related->add_part($_) foreach @related_parts;
2253 my @otherparts = ();
2254 if ( ref($self) eq 'FS::cust_bill' && $cust_main->email_csv_cdr ) {
2256 push @otherparts, build MIME::Entity
2257 'Type' => 'text/csv',
2258 'Encoding' => '7bit',
2259 'Data' => [ map { "$_\n" }
2260 $self->call_details('prepend_billed_number' => 1)
2262 'Disposition' => 'attachment',
2263 'Filename' => 'usage-'. $self->invnum. '.csv',
2268 if ( $conf->exists($tc.'email_pdf') ) {
2273 # multipart/alternative
2279 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
2280 push @otherparts, $pdf;
2284 $return{'content-type'} = 'multipart/mixed'; # of the outer container
2286 $return{'mimeparts'} = [ $related, @otherparts ];
2287 $return{'type'} = 'multipart/related'; # of the first part
2289 $return{'mimeparts'} = [ $text_part, @otherparts ];
2290 $return{'type'} = 'text/plain';
2292 } elsif ( $html ) { # no PDF or CSV, strip the outer container
2293 $return{'mimeparts'} = \@related_parts;
2294 $return{'content-type'} = 'multipart/related';
2295 $return{'type'} = 'multipart/alternative';
2296 } else { # no HTML either
2297 $return{'body'} = \@text;
2298 $return{'content-type'} = 'text/plain';
2307 Returns a list suitable for passing to MIME::Entity->build(), representing
2308 this invoice as PDF attachment.
2315 'Type' => 'application/pdf',
2316 'Encoding' => 'base64',
2317 'Data' => [ $self->print_pdf(@_) ],
2318 'Disposition' => 'attachment',
2319 'Filename' => 'invoice-'. $self->invnum. '.pdf',
2323 =item _items_sections OPTIONS
2325 Generate section information for all items appearing on this invoice.
2326 This will only be called for multi-section invoices.
2328 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
2329 related display records (L<FS::cust_bill_pkg_display>) and organize
2330 them into two groups ("early" and "late" according to whether they come
2331 before or after the total), then into sections. A subtotal is calculated
2334 Section descriptions are returned in sort weight order. Each consists
2335 of a hash containing:
2337 description: the package category name, escaped
2338 subtotal: the total charges in that section
2339 tax_section: a flag indicating that the section contains only tax charges
2340 summarized: same as tax_section, for some reason
2341 sort_weight: the package category's sort weight
2343 If 'condense' is set on the display record, it also contains everything
2344 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
2345 coderefs to generate parts of the invoice. This is not advised.
2347 The method returns two arrayrefs, one of "early" sections and one of "late"
2350 OPTIONS may include:
2352 by_location: a flag to divide the invoice into sections by location.
2353 Each section hash will have a 'location' element containing a hashref of
2354 the location fields (see L<FS::cust_location>). The section description
2355 will be the location label, but the template can use any of the location
2356 fields to create a suitable label.
2358 by_category: a flag to divide the invoice into sections using display
2359 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
2360 behavior. Each section hash will have a 'category' element containing
2361 the section name from the display record (which probably equals the
2362 category name of the package, but may not in some cases).
2364 summary: a flag indicating that this is a summary-format invoice.
2365 Turning this on has the following effects:
2366 - Ignores display items with the 'summary' flag.
2367 - Places all sections in the "early" group even if they have post_total.
2368 - Creates sections for all non-disabled package categories, even if they
2369 have no charges on this invoice, as well as a section with no name.
2371 escape: an escape function to use for section titles.
2373 extra_sections: an arrayref of additional sections to return after the
2374 sorted list. If there are any of these, section subtotals exclude
2377 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
2378 passed through to C<_condense_section()>.
2382 use vars qw(%pkg_category_cache);
2383 sub _items_sections {
2387 my $escape = $opt{escape};
2388 my @extra_sections = @{ $opt{extra_sections} || [] };
2390 # $subtotal{$locationnum}{$categoryname} = amount.
2391 # if we're not using by_location, $locationnum is undef.
2392 # if we're not using by_category, you guessed it, $categoryname is undef.
2393 # if we're not using either one, we shouldn't be here in the first place...
2395 my %late_subtotal = ();
2398 # About tax items + multisection invoices:
2399 # If either invoice_*summary option is enabled, AND there is a
2400 # package category with the name of the tax, then there will be
2401 # a display record assigning the tax item to that category.
2403 # However, the taxes are always placed in the "Taxes, Surcharges,
2404 # and Fees" section regardless of that. The only effect of the
2405 # display record is to create a subtotal for the summary page.
2408 my $pkg_hash = $self->cust_pkg_hash;
2410 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2413 my $usage = $cust_bill_pkg->usage;
2416 if ( $opt{by_location} ) {
2417 if ( $cust_bill_pkg->pkgnum ) {
2418 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2423 $locationnum = undef;
2426 # as in _items_cust_pkg, if a line item has no display records,
2427 # cust_bill_pkg_display() returns a default record for it
2429 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2430 next if ( $display->summary && $opt{summary} );
2432 my $section = $display->section;
2433 my $type = $display->type;
2434 # Set $section = undef if we're sectioning by location and this
2435 # line item _has_ a location (i.e. isn't a fee).
2436 $section = undef if $locationnum;
2438 # set this flag if the section is not tax-only
2439 $not_tax{$locationnum}{$section} = 1
2440 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
2442 # there's actually a very important piece of logic buried in here:
2443 # incrementing $late_subtotal{$section} CREATES
2444 # $late_subtotal{$section}. keys(%late_subtotal) is later used
2445 # to define the list of late sections, and likewise keys(%subtotal).
2446 # When _items_cust_bill_pkg is called to generate line items for
2447 # real, it will be called with 'section' => $section for each
2449 if ( $display->post_total && !$opt{summary} ) {
2450 if (! $type || $type eq 'S') {
2451 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2452 if $cust_bill_pkg->setup != 0
2453 || $cust_bill_pkg->setup_show_zero;
2457 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
2458 if $cust_bill_pkg->recur != 0
2459 || $cust_bill_pkg->recur_show_zero;
2462 if ($type && $type eq 'R') {
2463 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2464 if $cust_bill_pkg->recur != 0
2465 || $cust_bill_pkg->recur_show_zero;
2468 if ($type && $type eq 'U') {
2469 $late_subtotal{$locationnum}{$section} += $usage
2470 unless scalar(@extra_sections);
2473 } else { # it's a pre-total (normal) section
2475 # skip tax items unless they're explicitly included in a section
2476 next if $cust_bill_pkg->pkgnum == 0 and
2477 ! $cust_bill_pkg->feepart and
2480 if ( $type eq 'S' ) {
2481 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2482 if $cust_bill_pkg->setup != 0
2483 || $cust_bill_pkg->setup_show_zero;
2484 } elsif ( $type eq 'R' ) {
2485 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2486 if $cust_bill_pkg->recur != 0
2487 || $cust_bill_pkg->recur_show_zero;
2488 } elsif ( $type eq 'U' ) {
2489 $subtotal{$locationnum}{$section} += $usage
2490 unless scalar(@extra_sections);
2491 } elsif ( !$type ) {
2492 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2493 + $cust_bill_pkg->recur;
2502 %pkg_category_cache = ();
2504 # summary invoices need subtotals for all non-disabled package categories,
2505 # even if they're zero
2506 # but currently assume that there are no location sections, or at least
2507 # that the summary page doesn't care about them
2508 if ( $opt{summary} ) {
2509 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2510 $subtotal{''}{$category->categoryname} ||= 0;
2512 $subtotal{''}{''} ||= 0;
2516 foreach my $post_total (0,1) {
2518 my $s = $post_total ? \%late_subtotal : \%subtotal;
2519 foreach my $locationnum (keys %$s) {
2520 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2522 'subtotal' => $s->{$locationnum}{$sectionname},
2525 if ( $locationnum ) {
2526 $section->{'locationnum'} = $locationnum;
2527 my $location = FS::cust_location->by_key($locationnum);
2528 $section->{'description'} = &{ $escape }($location->location_label);
2529 # Better ideas? This will roughly group them by proximity,
2530 # which alpha sorting on any of the address fields won't.
2531 # Sorting by locationnum is meaningless.
2532 # We have to sort on _something_ or the order may change
2533 # randomly from one invoice to the next, which will confuse
2535 $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
2537 $section->{'location'} = {
2538 label_prefix => &{ $escape }($location->label_prefix),
2539 map { $_ => &{ $escape }($location->get($_)) }
2543 $section->{'category'} = $sectionname;
2544 $section->{'description'} = &{ $escape }($sectionname);
2545 if ( _pkg_category($sectionname) ) {
2546 $section->{'sort_weight'} = _pkg_category($sectionname)->weight;
2547 if ( _pkg_category($sectionname)->condense ) {
2548 $section = { %$section, $self->_condense_section($opt{format}) };
2552 if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
2553 # then it's a tax-only section
2554 $section->{'summarized'} = 'Y';
2555 $section->{'tax_section'} = 'Y';
2557 push @these, $section;
2558 } # foreach $sectionname
2559 } #foreach $locationnum
2560 push @these, @extra_sections if $post_total == 0;
2561 # need an alpha sort for location sections, because postal codes can
2563 $sections[ $post_total ] = [ sort {
2564 $opt{'by_location'} ?
2565 ($a->{sort_weight} cmp $b->{sort_weight}) :
2566 ($a->{sort_weight} <=> $b->{sort_weight})
2568 } #foreach $post_total
2570 return @sections; # early, late
2573 #helper subs for above
2577 $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2581 my $categoryname = shift;
2582 $pkg_category_cache{$categoryname} ||=
2583 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2586 my %condensed_format = (
2587 'label' => [ qw( Description Qty Amount ) ],
2589 sub { shift->{description} },
2590 sub { shift->{quantity} },
2591 sub { my($href, %opt) = @_;
2592 ($opt{dollar} || ''). $href->{amount};
2595 'align' => [ qw( l r r ) ],
2596 'span' => [ qw( 5 1 1 ) ], # unitprices?
2597 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
2600 sub _condense_section {
2601 my ( $self, $format ) = ( shift, shift );
2603 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2604 qw( description_generator
2607 total_line_generator
2612 sub _condensed_generator_defaults {
2613 my ( $self, $format ) = ( shift, shift );
2614 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2623 sub _condensed_header_generator {
2624 my ( $self, $format ) = ( shift, shift );
2626 my ( $f, $prefix, $suffix, $separator, $column ) =
2627 _condensed_generator_defaults($format);
2629 if ($format eq 'latex') {
2630 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2631 $suffix = "\\\\\n\\hline";
2634 sub { my ($d,$a,$s,$w) = @_;
2635 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2637 } elsif ( $format eq 'html' ) {
2638 $prefix = '<th></th>';
2642 sub { my ($d,$a,$s,$w) = @_;
2643 return qq!<th align="$html_align{$a}">$d</th>!;
2651 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2653 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2656 $prefix. join($separator, @result). $suffix;
2661 sub _condensed_description_generator {
2662 my ( $self, $format ) = ( shift, shift );
2664 my ( $f, $prefix, $suffix, $separator, $column ) =
2665 _condensed_generator_defaults($format);
2667 my $money_char = '$';
2668 if ($format eq 'latex') {
2669 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2671 $separator = " & \n";
2673 sub { my ($d,$a,$s,$w) = @_;
2674 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2676 $money_char = '\\dollar';
2677 }elsif ( $format eq 'html' ) {
2678 $prefix = '"><td align="center"></td>';
2682 sub { my ($d,$a,$s,$w) = @_;
2683 return qq!<td align="$html_align{$a}">$d</td>!;
2685 #$money_char = $conf->config('money_char') || '$';
2686 $money_char = ''; # this is madness
2694 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2696 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2698 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2699 map { $f->{$_}->[$i] } qw(align span width)
2703 $prefix. join( $separator, @result ). $suffix;
2708 sub _condensed_total_generator {
2709 my ( $self, $format ) = ( shift, shift );
2711 my ( $f, $prefix, $suffix, $separator, $column ) =
2712 _condensed_generator_defaults($format);
2715 if ($format eq 'latex') {
2718 $separator = " & \n";
2720 sub { my ($d,$a,$s,$w) = @_;
2721 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2723 }elsif ( $format eq 'html' ) {
2727 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2729 sub { my ($d,$a,$s,$w) = @_;
2730 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2739 # my $r = &{$f->{fields}->[$i]}(@args);
2740 # $r .= ' Total' unless $i;
2742 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2744 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
2745 map { $f->{$_}->[$i] } qw(align span width)
2749 $prefix. join( $separator, @result ). $suffix;
2754 =item total_line_generator FORMAT
2756 Returns a coderef used for generation of invoice total line items for this
2757 usage_class. FORMAT is either html or latex
2761 # should not be used: will have issues with hash element names (description vs
2762 # total_item and amount vs total_amount -- another array of functions?
2764 sub _condensed_total_line_generator {
2765 my ( $self, $format ) = ( shift, shift );
2767 my ( $f, $prefix, $suffix, $separator, $column ) =
2768 _condensed_generator_defaults($format);
2771 if ($format eq 'latex') {
2774 $separator = " & \n";
2776 sub { my ($d,$a,$s,$w) = @_;
2777 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2779 }elsif ( $format eq 'html' ) {
2783 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2785 sub { my ($d,$a,$s,$w) = @_;
2786 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2795 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2797 &{$column}( &{$f->{fields}->[$i]}(@args),
2798 map { $f->{$_}->[$i] } qw(align span width)
2802 $prefix. join( $separator, @result ). $suffix;
2807 =item _items_pkg [ OPTIONS ]
2809 Return line item hashes for each package item on this invoice. Nearly
2812 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
2814 OPTIONS are passed through to _items_cust_bill_pkg, and should include
2815 'format' and 'escape_function' at minimum.
2817 To produce items for a specific invoice section, OPTIONS should include
2818 'section', a hashref containing 'category' and/or 'locationnum' keys.
2820 'section' may also contain a key named 'condensed'. If this is present
2821 and has a true value, _items_pkg will try to merge identical items into items
2822 with 'quantity' equal to the number of items (not the sum of their separate
2823 quantities, for some reason).
2829 # The order of these is important. Bundled line items will be merged into
2830 # the most recent non-hidden item, so it needs to be the one with:
2832 # - the same start date
2833 # - no pkgpart_override
2835 # So: sort by pkgnum,
2837 # then sort the base line item before any overrides
2838 # then sort hidden before non-hidden add-ons
2839 # then sort by override pkgpart (for consistency)
2840 sort { $a->pkgnum <=> $b->pkgnum or
2841 $a->sdate <=> $b->sdate or
2842 ($a->pkgpart_override ? 0 : -1) or
2843 ($b->pkgpart_override ? 0 : 1) or
2844 $b->hidden cmp $a->hidden or
2845 $a->pkgpart_override <=> $b->pkgpart_override
2847 # and of course exclude taxes and fees
2848 grep { $_->pkgnum > 0 } $self->cust_bill_pkg;
2854 my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
2855 my $escape_function = $options{escape_function};
2858 foreach my $cust_bill_pkg (@cust_bill_pkg) {
2859 # cache this, so we don't look it up again in every section
2860 my $part_fee = $cust_bill_pkg->get('part_fee')
2861 || $cust_bill_pkg->part_fee;
2862 $cust_bill_pkg->set('part_fee', $part_fee);
2864 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
2865 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
2868 if ( exists($options{section}) and exists($options{section}{category}) )
2870 my $categoryname = $options{section}{category};
2871 # then filter for items that have that section
2872 if ( $part_fee->categoryname ne $categoryname ) {
2873 warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
2876 } # otherwise include them all in the main section
2877 # XXX what to do when sectioning by location?
2880 my %base_invnums; # invnum => invoice date
2881 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
2882 if ($_->base_invnum) {
2883 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
2884 my $base_date = $self->time2str_local('short', $base_bill->_date)
2886 $base_invnums{$_->base_invnum} = $base_date || '';
2889 foreach (sort keys(%base_invnums)) {
2890 next if $_ == $self->invnum;
2891 # per convention, we must escape ext_description lines
2893 &{$escape_function}(
2894 $self->mt('from invoice #[_1] on [_2]', $_, $base_invnums{$_})
2897 my $desc = $part_fee->itemdesc_locale($self->cust_main->locale);
2898 # but not escape the base description line
2901 { feepart => $cust_bill_pkg->feepart,
2902 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
2903 description => $desc,
2904 ext_description => \@ext_desc
2915 warn "$me _items_pkg searching for all package line items\n"
2918 my @cust_bill_pkg = $self->_items_nontax;
2920 warn "$me _items_pkg filtering line items\n"
2922 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2924 if ($options{section} && $options{section}->{condensed}) {
2926 warn "$me _items_pkg condensing section\n"
2930 local $Storable::canonical = 1;
2931 foreach ( @items ) {
2933 delete $item->{ref};
2934 delete $item->{ext_description};
2935 my $key = freeze($item);
2936 $itemshash{$key} ||= 0;
2937 $itemshash{$key} ++; # += $item->{quantity};
2939 @items = sort { $a->{description} cmp $b->{description} }
2940 map { my $i = thaw($_);
2941 $i->{quantity} = $itemshash{$_};
2943 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
2949 warn "$me _items_pkg returning ". scalar(@items). " items\n"
2956 return 0 unless $a->itemdesc cmp $b->itemdesc;
2957 return -1 if $b->itemdesc eq 'Tax';
2958 return 1 if $a->itemdesc eq 'Tax';
2959 return -1 if $b->itemdesc eq 'Other surcharges';
2960 return 1 if $a->itemdesc eq 'Other surcharges';
2961 $a->itemdesc cmp $b->itemdesc;
2966 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
2967 $self->cust_bill_pkg;
2968 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2970 if ( $self->conf->exists('always_show_tax') ) {
2971 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
2972 if (0 == grep { $_->{description} eq $itemdesc } @items) {
2974 { 'description' => $itemdesc,
2981 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
2983 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
2984 list of hashrefs describing the line items they generate on the invoice.
2986 OPTIONS may include:
2988 format: the invoice format.
2990 escape_function: the function used to escape strings.
2992 DEPRECATED? (expensive, mostly unused?)
2993 format_function: the function used to format CDRs.
2995 section: a hashref containing 'category' and/or 'locationnum'; if this
2996 is present, only returns line items that belong to that category and/or
2997 location (whichever is defined).
2999 multisection: a flag indicating that this is a multisection invoice,
3000 which does something complicated.
3002 Returns a list of hashrefs, each of which may contain:
3004 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
3005 ext_description, which is an arrayref of detail lines to show below
3010 sub _items_cust_bill_pkg {
3012 my $conf = $self->conf;
3013 my $cust_bill_pkgs = shift;
3016 my $format = $opt{format} || '';
3017 my $escape_function = $opt{escape_function} || sub { shift };
3018 my $format_function = $opt{format_function} || '';
3019 my $no_usage = $opt{no_usage} || '';
3020 my $unsquelched = $opt{unsquelched} || ''; #unused
3021 my ($section, $locationnum, $category);
3022 if ( $opt{section} ) {
3023 $category = $opt{section}->{category};
3024 $locationnum = $opt{section}->{locationnum};
3026 my $summary_page = $opt{summary_page} || ''; #unused
3027 my $multisection = defined($category) || defined($locationnum);
3028 # this variable is the value of the config setting, not whether it applies
3029 # to this particular line item.
3030 my $discount_show_always = $conf->exists('discount-show-always');
3032 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 40;
3034 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
3036 # for location labels: use default location on the invoice date
3037 my $default_locationnum;
3038 if ( $self->custnum ) {
3040 my @h_search = FS::h_cust_main->sql_h_search($self->_date);
3041 $h_cust_main = qsearchs({
3042 'table' => 'h_cust_main',
3043 'hashref' => { custnum => $self->custnum },
3044 'extra_sql' => $h_search[1],
3045 'addl_from' => $h_search[3],
3047 $default_locationnum = $h_cust_main->ship_locationnum;
3048 } elsif ( $self->prospectnum ) {
3049 my $cust_location = qsearchs('cust_location',
3050 { prospectnum => $self->prospectnum,
3052 $default_locationnum = $cust_location->locationnum if $cust_location;
3055 my @b = (); # accumulator for the line item hashes that we'll return
3056 my ($s, $r, $u, $d) = ( undef, undef, undef, undef );
3057 # the 'current' line item hashes for setup, recur, usage, discount
3058 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
3060 # if the current line item is waiting to go out, and the one we're about
3061 # to start is not bundled, then push out the current one and start a new
3064 $d->{amount} = $d->{setup_amount} + $d->{recur_amount};
3066 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3067 if ( $_ && !$cust_bill_pkg->hidden ) {
3068 $_->{amount} = sprintf( "%.2f", $_->{amount} );
3069 $_->{amount} =~ s/^\-0\.00$/0.00/;
3070 if (exists($_->{unit_amount})) {
3071 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3074 # we already decided to create this display line; don't reconsider it
3076 # if $_->{amount} != 0
3077 # || $discount_show_always
3078 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3079 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3085 if ( $locationnum ) {
3086 # this is a location section; skip packages that aren't at this
3088 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
3089 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
3093 # Consider display records for this item to determine if it belongs
3094 # in this section. Note that if there are no display records, there
3095 # will be a default pseudo-record that includes all charge types
3096 # and has no section name.
3097 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
3098 ? $cust_bill_pkg->cust_bill_pkg_display
3099 : ( $cust_bill_pkg );
3101 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
3102 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
3105 if ( defined($category) ) {
3106 # then this is a package category section; process all display records
3107 # that belong to this section.
3108 @cust_bill_pkg_display = grep { $_->section eq $category }
3109 @cust_bill_pkg_display;
3111 # otherwise, process all display records that aren't usage summaries
3112 # (I don't think there should be usage summaries if you aren't using
3113 # category sections, but this is the historical behavior)
3114 @cust_bill_pkg_display = grep { !$_->summary }
3115 @cust_bill_pkg_display;
3118 my $classname = ''; # package class name, will fill in later
3120 foreach my $display (@cust_bill_pkg_display) {
3122 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
3123 $display->billpkgdisplaynum. "\n"
3126 my $type = $display->type;
3128 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
3129 $desc = substr($desc, 0, $maxlength). '...'
3130 if $format eq 'latex' && length($desc) > $maxlength;
3132 my %details_opt = ( 'format' => $format,
3133 'escape_function' => $escape_function,
3134 'format_function' => $format_function,
3135 'no_usage' => $opt{'no_usage'},
3138 if ( $cust_bill_pkg->pkgnum > 0 ) {
3139 # a "normal" package line item (not a quotation, not a fee, not a tax)
3141 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
3144 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3145 my $part_pkg = $cust_pkg->part_pkg;
3147 # which pkgpart to show for display purposes?
3148 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
3150 # start/end dates for invoice formats that do nonstandard
3152 my %item_dates = ();
3153 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
3154 unless $part_pkg->option('disable_line_item_date_ranges',1);
3156 # not normally used, but pass this to the template anyway
3157 $classname = $part_pkg->classname;
3159 if ( (!$type || $type eq 'S')
3160 && ( $cust_bill_pkg->setup != 0
3161 || $cust_bill_pkg->setup_show_zero
3162 || ($discount_show_always and $cust_bill_pkg->unitsetup > 0)
3167 warn "$me _items_cust_bill_pkg adding setup\n"
3170 # append the word 'Setup' to the setup line if there's going to be
3171 # a recur line for the same package (i.e. not a one-time charge)
3172 my $description = $desc;
3173 $description .= ' Setup'
3174 if $cust_bill_pkg->recur != 0
3175 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3176 || $cust_bill_pkg->recur_show_zero;
3178 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3180 if $part_pkg->is_prepaid #for prepaid, "display the validity period
3181 # triggered by the recurring charge freq
3183 && $cust_bill_pkg->recur == 0
3184 && ! $cust_bill_pkg->recur_show_zero;
3189 # always pass the svc_label through to the template, even if
3190 # not displaying it as an ext_description
3191 my @svc_labels = map &{$escape_function}($_),
3192 $cust_pkg->h_labels_short($self->_date, undef, 'I');
3194 $svc_label = $svc_labels[0];
3196 unless ( $cust_pkg->part_pkg->hide_svc_detail
3197 || $cust_bill_pkg->hidden )
3200 push @d, @svc_labels
3201 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3202 # show the location label if it's not the customer's default
3203 # location, and we're not grouping items by location already
3204 if ( $cust_pkg->locationnum != $default_locationnum
3205 and !defined($locationnum) ) {
3206 my $loc = $cust_pkg->location_label;
3207 $loc = substr($loc, 0, $maxlength). '...'
3208 if $format eq 'latex' && length($loc) > $maxlength;
3209 push @d, &{$escape_function}($loc);
3212 } #unless hiding service details
3214 push @d, $cust_bill_pkg->details(%details_opt)
3215 if $cust_bill_pkg->recur == 0;
3217 if ( $cust_bill_pkg->hidden ) {
3218 $s->{amount} += $cust_bill_pkg->setup;
3219 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3220 push @{ $s->{ext_description} }, @d;
3224 description => $description,
3225 pkgpart => $pkgpart,
3226 pkgnum => $cust_bill_pkg->pkgnum,
3227 amount => $cust_bill_pkg->setup,
3228 setup_show_zero => $cust_bill_pkg->setup_show_zero,
3229 unit_amount => $cust_bill_pkg->unitsetup,
3230 quantity => $cust_bill_pkg->quantity,
3231 ext_description => \@d,
3232 svc_label => ($svc_label || ''),
3233 locationnum => $cust_pkg->locationnum, # sure, why not?
3239 # should we show a recur line?
3240 # if type eq 'S', then NO, because we've been told not to.
3241 # otherwise, show the recur line if:
3242 # - there's a recurring charge
3243 # - or recur_show_zero is on
3244 # - or there's a positive unitrecur (so it's been discounted to zero)
3245 # and discount-show-always is on
3246 if ( ( !$type || $type eq 'R' || $type eq 'U' )
3248 $cust_bill_pkg->recur != 0
3250 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3251 || $cust_bill_pkg->recur_show_zero
3256 warn "$me _items_cust_bill_pkg adding recur/usage\n"
3259 my $is_summary = $display->summary;
3260 my $description = $desc;
3261 if ( $type eq 'U' and defined($r) ) {
3262 # don't just show the same description as the recur line
3263 $description = $self->mt('Usage charges');
3266 my $part_pkg = $cust_pkg->part_pkg;
3268 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3272 my @seconds = (); # for display of usage info
3275 #at least until cust_bill_pkg has "past" ranges in addition to
3276 #the "future" sdate/edate ones... see #3032
3277 my @dates = ( $self->_date );
3278 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
3279 push @dates, $prev->sdate if $prev;
3280 push @dates, undef if !$prev;
3282 my @svc_labels = map &{$escape_function}($_),
3283 $cust_pkg->h_labels_short(@dates, 'I');
3284 $svc_label = $svc_labels[0];
3286 # show service labels, unless...
3287 # the package is set not to display them
3288 unless ( $part_pkg->hide_svc_detail
3289 # or this is a tax-like line item
3290 || $cust_bill_pkg->itemdesc
3291 # or this is a hidden (bundled) line item
3292 || $cust_bill_pkg->hidden
3293 # or this is a usage summary line
3294 || $is_summary && $type && $type eq 'U'
3295 # or this is a usage line and there's a recurring line
3296 # for the package in the same section (which will
3297 # have service labels already)
3298 || ($type eq 'U' and defined($r))
3302 warn "$me _items_cust_bill_pkg adding service details\n"
3305 push @d, @svc_labels
3306 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3307 warn "$me _items_cust_bill_pkg done adding service details\n"
3310 # show the location label if it's not the customer's default
3311 # location, and we're not grouping items by location already
3312 if ( $cust_pkg->locationnum != $default_locationnum
3313 and !defined($locationnum) ) {
3314 my $loc = $cust_pkg->location_label;
3315 $loc = substr($loc, 0, $maxlength). '...'
3316 if $format eq 'latex' && length($loc) > $maxlength;
3317 push @d, &{$escape_function}($loc);
3320 # Display of seconds_since_sqlradacct:
3321 # On the invoice, when processing @detail_items, look for a field
3322 # named 'seconds'. This will contain total seconds for each
3323 # service, in the same order as @ext_description. For services
3324 # that don't support this it will show undef.
3325 if ( $conf->exists('svc_acct-usage_seconds')
3326 and ! $cust_bill_pkg->pkgpart_override ) {
3327 foreach my $cust_svc (
3328 $cust_pkg->h_cust_svc(@dates, 'I')
3331 # eval because not having any part_export_usage exports
3332 # is a fatal error, last_bill/_date because that's how
3333 # sqlradius_hour billing does it
3335 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
3337 push @seconds, $sec;
3339 } #if svc_acct-usage_seconds
3341 } # if we are showing service labels
3343 unless ( $is_summary ) {
3344 warn "$me _items_cust_bill_pkg adding details\n"
3347 #instead of omitting details entirely in this case (unwanted side
3348 # effects), just omit CDRs
3349 $details_opt{'no_usage'} = 1
3350 if $type && $type eq 'R';
3352 push @d, $cust_bill_pkg->details(%details_opt);
3355 warn "$me _items_cust_bill_pkg calculating amount\n"
3360 $amount = $cust_bill_pkg->recur;
3361 } elsif ($type eq 'R') {
3362 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
3363 } elsif ($type eq 'U') {
3364 $amount = $cust_bill_pkg->usage;
3367 if ( !$type || $type eq 'R' ) {
3369 warn "$me _items_cust_bill_pkg adding recur\n"
3373 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
3376 if ( $cust_bill_pkg->hidden ) {
3377 $r->{amount} += $amount;
3378 $r->{unit_amount} += $unit_amount;
3379 push @{ $r->{ext_description} }, @d;
3382 description => $description,
3383 pkgpart => $pkgpart,
3384 pkgnum => $cust_bill_pkg->pkgnum,
3386 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3387 unit_amount => $unit_amount,
3388 quantity => $cust_bill_pkg->quantity,
3390 ext_description => \@d,
3391 svc_label => ($svc_label || ''),
3392 locationnum => $cust_pkg->locationnum,
3394 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3397 } else { # $type eq 'U'
3399 warn "$me _items_cust_bill_pkg adding usage\n"
3402 if ( $cust_bill_pkg->hidden and defined($u) ) {
3403 # if this is a hidden package and there's already a usage
3404 # line for the bundle, add this package's total amount and
3405 # usage details to it
3406 $u->{amount} += $amount;
3407 push @{ $u->{ext_description} }, @d;
3408 } elsif ( $amount ) {
3409 # create a new usage line
3411 description => $description,
3412 pkgpart => $pkgpart,
3413 pkgnum => $cust_bill_pkg->pkgnum,
3416 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3418 ext_description => \@d,
3419 locationnum => $cust_pkg->locationnum,
3421 } # else this has no usage, so don't create a usage section
3424 } # recurring or usage with recurring charge
3426 } else { # taxes and fees
3428 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3431 # items of this kind should normally not have sdate/edate.
3433 'description' => $desc,
3434 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
3435 + $cust_bill_pkg->recur)
3438 } # if package line item / other line item
3440 # decide whether to show active discounts here
3442 # case 1: we are showing a single line for the package
3444 # case 2: we are showing a setup line for a package that has
3445 # no base recurring fee
3446 or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3447 # case 3: we are showing a recur line for a package that has
3448 # a base recurring fee
3449 or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3452 my $item_discount = $cust_bill_pkg->_item_discount;
3453 if ( $item_discount ) {
3454 # $item_discount->{amount} is negative
3456 if ( $d and $cust_bill_pkg->hidden ) {
3457 $d->{setup_amount} += $item_discount->{setup_amount};
3458 $d->{recur_amount} += $item_discount->{recur_amount};
3460 $d = $item_discount;
3461 $_ = &{$escape_function}($_) foreach @{ $d->{ext_description} };
3464 # update the active line (before the discount) to show the
3465 # original price (whether this is a hidden line or not)
3467 $s->{amount} -= $item_discount->{setup_amount} if $s;
3468 $r->{amount} -= $item_discount->{recur_amount} if $r;
3470 } # if there are any discounts
3471 } # if this is an appropriate place to show discounts
3473 } # foreach $display
3477 # discount amount is internally split up
3479 $d->{amount} = $d->{setup_amount} + $d->{recur_amount};
3482 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3484 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3485 if exists($_->{amount});
3486 $_->{amount} =~ s/^\-0\.00$/0.00/;
3487 if (exists($_->{unit_amount})) {
3488 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3492 #if $_->{amount} != 0
3493 # || $discount_show_always
3494 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3495 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3499 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3506 =item _items_discounts_avail
3508 Returns an array of line item hashrefs representing available term discounts
3509 for this invoice. This makes the same assumptions that apply to term
3510 discounts in general: that the package is billed monthly, at a flat rate,
3511 with no usage charges. A prorated first month will be handled, as will
3512 a setup fee if the discount is allowed to apply to setup fees.
3516 sub _items_discounts_avail {
3519 #maybe move this method from cust_bill when quotations support discount_plans
3520 return () unless $self->can('discount_plans');
3521 my %plans = $self->discount_plans;
3523 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3524 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3528 my $plan = $plans{$months};
3530 my $term_total = sprintf('%.2f', $plan->discounted_total);
3531 my $percent = sprintf('%.0f',
3532 100 * (1 - $term_total / $plan->base_total) );
3533 my $permonth = sprintf('%.2f', $term_total / $months);
3534 my $detail = $self->mt('discount on item'). ' '.
3535 join(', ', map { "#$_" } $plan->pkgnums)
3538 # discounts for non-integer months don't work anyway
3539 $months = sprintf("%d", $months);
3542 description => $self->mt('Save [_1]% by paying for [_2] months',
3544 amount => $self->mt('[_1] ([_2] per month)',
3545 $term_total, $money_char.$permonth),
3546 ext_description => ($detail || ''),
3549 sort { $b <=> $a } keys %plans;