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 # if (well, probably when) we still need PO numbers in the brave new world of
890 # 4.x, then we'll have to add them back as their own customer fields
891 # # let invoices use either of these as needed
892 # $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
893 # ? $cust_main->payinfo : '';
894 # $invoice_data{'po_line'} =
895 # ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
896 # ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
899 my %money_chars = ( 'latex' => '',
900 'html' => $conf->config('money_char') || '$',
903 my $money_char = $money_chars{$format};
906 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
907 'html' => $conf->config('money_char') || '$',
910 my $other_money_char = $other_money_chars{$format};
911 $invoice_data{'dollar'} = $other_money_char;
913 my %minus_signs = ( 'latex' => '$-$',
915 'template' => '- ' );
916 my $minus = $minus_signs{$format};
918 my @detail_items = ();
919 my @total_items = ();
923 $invoice_data{'detail_items'} = \@detail_items;
924 $invoice_data{'total_items'} = \@total_items;
925 $invoice_data{'buf'} = \@buf;
926 $invoice_data{'sections'} = \@sections;
928 warn "$me generating sections\n"
931 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
932 my $multisection = $self->has_sections;
933 $conf->exists($tc.'sections', $cust_main->agentnum) ||
934 $conf->exists($tc.'sections_by_location', $cust_main->agentnum);
935 $invoice_data{'multisection'} = $multisection;
937 my $extra_sections = [];
938 my $extra_lines = ();
940 # default section ('Charges')
941 my $default_section = { 'description' => '',
946 # Previous Charges section
947 # subtotal is the first return value from $self->previous
948 my $previous_section;
949 # if the invoice has major sections, or if we're summarizing previous
950 # charges with a single line, or if we've been specifically told to put them
951 # in a section, create a section for previous charges:
952 if ( $multisection or
953 $conf->exists('previous_balance-summary_only') or
954 $conf->exists('previous_balance-section') ) {
956 $previous_section = { 'description' => $self->mt('Previous Charges'),
957 'subtotal' => $other_money_char.
958 sprintf('%.2f', $pr_total),
959 'summarized' => '', #why? $summarypage ? 'Y' : '',
961 $previous_section->{posttotal} = '0 / 30 / 60 / 90 days overdue '.
962 join(' / ', map { $cust_main->balance_date_range(@$_) }
963 $self->_prior_month30s
965 if $conf->exists('invoice_include_aging');
968 # otherwise put them in the main section
969 $previous_section = $default_section;
972 my $adjust_section = {
973 'description' => $self->mt('Credits, Payments, and Adjustments'),
974 'adjust_section' => 1,
975 'subtotal' => 0, # adjusted below
977 my $adjust_weight = _pkg_category($adjust_section->{description})
978 ? _pkg_category($adjust_section->{description})->weight
980 $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
981 # Note: 'sort_weight' here is actually a flag telling whether there is an
982 # explicit package category for the adjust section. If so, certain behavior
984 $adjust_section->{'sort_weight'} = $adjust_weight;
987 if ( $multisection ) {
988 ($extra_sections, $extra_lines) =
989 $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
990 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum)
991 && $self->can('_items_extra_usage_sections');
993 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
995 push @detail_items, @$extra_lines if $extra_lines;
997 # the code is written so that both methods can be used together, but
998 # we haven't yet changed the template to take advantage of that, so for
999 # now, treat them as mutually exclusive.
1000 my %section_method = ( by_category => 1 );
1001 if ( $conf->config($tc.'sections_method') eq 'location' ) {
1002 %section_method = ( by_location => 1 );
1004 my ($early, $late) =
1005 $self->_items_sections( 'summary' => $summarypage,
1006 'escape' => $escape_function_nonbsp,
1007 'extra_sections' => $extra_sections,
1008 'format' => $format,
1011 push @sections, @$early;
1012 $late_sections = $late;
1014 if ( $conf->exists('svc_phone_sections')
1015 && $self->can('_items_svc_phone_sections')
1018 my ($phone_sections, $phone_lines) =
1019 $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
1020 push @{$late_sections}, @$phone_sections;
1021 push @detail_items, @$phone_lines;
1023 if ( $conf->exists('voip-cust_accountcode_cdr')
1024 && $cust_main->accountcode_cdr
1025 && $self->can('_items_accountcode_cdr')
1028 my ($accountcode_section, $accountcode_lines) =
1029 $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
1030 if ( scalar(@$accountcode_lines) ) {
1031 push @{$late_sections}, $accountcode_section;
1032 push @detail_items, @$accountcode_lines;
1035 } else {# not multisection
1036 # make a default section
1037 push @sections, $default_section;
1038 # and calculate the finance charge total, since it won't get done otherwise.
1039 # and the default section total
1040 # XXX possibly finance_pkgclass should not be used in this manner?
1041 my @finance_charges;
1043 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1044 if ( $invoice_data{finance_section} and
1045 grep { $_->section eq $invoice_data{finance_section} }
1046 $cust_bill_pkg->cust_bill_pkg_display ) {
1047 # I think these are always setup fees, but just to be sure...
1048 push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1050 push @charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1053 $invoice_data{finance_amount} =
1054 sprintf('%.2f', sum( @finance_charges ) || 0);
1055 $default_section->{subtotal} = $other_money_char.
1056 sprintf('%.2f', sum( @charges ) || 0);
1059 # start setting up summary subtotals
1060 my @summary_subtotals;
1061 my $method = $conf->config('summary_subtotals_method');
1062 if ( $method and $method ne $conf->config($tc.'sections_method') ) {
1063 # then re-section them by the correct method
1064 my %section_method = ( by_category => 1 );
1065 if ( $conf->config('summary_subtotals_method') eq 'location' ) {
1066 %section_method = ( by_location => 1 );
1068 my ($early, $late) =
1069 $self->_items_sections( 'summary' => $summarypage,
1070 'escape' => $escape_function_nonbsp,
1071 'extra_sections' => $extra_sections,
1072 'format' => $format,
1075 foreach ( @$early ) {
1076 next if $_->{subtotal} == 0;
1077 $_->{subtotal} = $other_money_char.sprintf('%.2f', $_->{subtotal});
1078 push @summary_subtotals, $_;
1081 # subtotal sectioning is the same as for the actual invoice sections
1082 @summary_subtotals = @sections;
1085 # Hereafter, push sections to both @sections and @summary_subtotals
1086 # if they belong in both places (e.g. tax section). Late sections are
1087 # never in @summary_subtotals.
1089 # previous invoice balances in the Previous Charges section if there
1090 # is one, otherwise in the main detail section
1091 # (except if summary_only is enabled, don't show them at all)
1092 if ( $self->can('_items_previous') &&
1093 $self->enable_previous &&
1094 ! $conf->exists('previous_balance-summary_only') ) {
1096 warn "$me adding previous balances\n"
1099 foreach my $line_item ( $self->_items_previous ) {
1102 ref => $line_item->{'pkgnum'},
1103 pkgpart => $line_item->{'pkgpart'},
1104 #quantity => 1, # not really correct
1105 section => $previous_section, # which might be $default_section
1106 description => &$escape_function($line_item->{'description'}),
1107 ext_description => [ map { &$escape_function($_) }
1108 @{ $line_item->{'ext_description'} || [] }
1110 amount => $money_char . $line_item->{'amount'},
1111 product_code => $line_item->{'pkgpart'} || 'N/A',
1114 push @detail_items, $detail;
1115 push @buf, [ $detail->{'description'},
1116 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1122 if ( @pr_cust_bill && $self->enable_previous ) {
1123 push @buf, ['','-----------'];
1124 push @buf, [ $self->mt('Total Previous Balance'),
1125 $money_char. sprintf("%10.2f", $pr_total) ];
1129 if ( $conf->exists('svc_phone-did-summary') && $self->can('_did_summary') ) {
1130 warn "$me adding DID summary\n"
1133 my ($didsummary,$minutes) = $self->_did_summary;
1134 my $didsummary_desc = 'DID Activity Summary (since last invoice)';
1136 { 'description' => $didsummary_desc,
1137 'ext_description' => [ $didsummary, $minutes ],
1141 foreach my $section (@sections, @$late_sections) {
1143 # begin some normalization
1144 $section->{'subtotal'} = $section->{'amount'}
1146 && !exists($section->{subtotal})
1147 && exists($section->{amount});
1149 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
1150 if ( $invoice_data{finance_section} &&
1151 $section->{'description'} eq $invoice_data{finance_section} );
1153 $section->{'subtotal'} = $other_money_char.
1154 sprintf('%.2f', $section->{'subtotal'})
1157 # continue some normalization
1158 $section->{'amount'} = $section->{'subtotal'}
1162 if ( $section->{'description'} ) {
1163 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
1168 warn "$me setting options\n"
1172 $options{'section'} = $section if $multisection;
1173 $options{'format'} = $format;
1174 $options{'escape_function'} = $escape_function;
1175 $options{'no_usage'} = 1 unless $unsquelched;
1176 $options{'unsquelched'} = $unsquelched;
1177 $options{'summary_page'} = $summarypage;
1178 $options{'skip_usage'} =
1179 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
1180 $options{'preref_callback'} = $params{'preref_callback'};
1182 warn "$me searching for line items\n"
1185 foreach my $line_item ( $self->_items_pkg(%options),
1186 $self->_items_fee(%options) ) {
1188 warn "$me adding line item ".
1189 join(', ', map "$_=>".$line_item->{$_}, keys %$line_item). "\n"
1192 push @buf, ( [ $line_item->{'description'},
1193 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1195 map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}},
1198 $line_item->{'ref'} = $line_item->{'pkgnum'};
1199 $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()?
1200 $line_item->{'section'} = $section;
1201 $line_item->{'description'} = &$escape_function($line_item->{'description'});
1202 $line_item->{'amount'} = $money_char.$line_item->{'amount'};
1204 if ( length($line_item->{'unit_amount'}) ) {
1205 $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'};
1207 $line_item->{'ext_description'} ||= [];
1209 push @detail_items, $line_item;
1212 if ( $section->{'description'} ) {
1213 push @buf, ( ['','-----------'],
1214 [ $section->{'description'}. ' sub-total',
1215 $section->{'subtotal'} # already formatted this
1224 $invoice_data{current_less_finance} =
1225 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
1227 # if there's anything in the Previous Charges section, prepend it to the list
1228 if ( $pr_total and $previous_section ne $default_section ) {
1229 unshift @sections, $previous_section;
1230 # but not @summary_subtotals
1233 warn "$me adding taxes\n"
1236 # create a tax section if we don't yet have one
1237 my $tax_description = 'Taxes, Surcharges, and Fees';
1239 List::Util::first { $_->{description} eq $tax_description } @sections;
1240 if (!$tax_section) {
1241 $tax_section = { 'description' => $tax_description };
1243 $tax_section->{tax_section} = 1; # mark this section as containing taxes
1244 # if this is an existing tax section, we're merging the tax items into it.
1245 # grab the taxtotal that's already there, strip the money symbol if any
1246 my $taxtotal = $tax_section->{'subtotal'} || 0;
1247 $taxtotal =~ s/^\Q$other_money_char\E//;
1250 #my $tax_weight = _pkg_category($tax_section->{description})
1251 # ? _pkg_category($tax_section->{description})->weight
1253 #$tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
1254 #$tax_section->{'sort_weight'} = $tax_weight;
1256 my @items_tax = $self->_items_tax;
1257 push @sections, $tax_section if $multisection and @items_tax > 0;
1259 foreach my $tax ( @items_tax ) {
1261 $taxtotal += $tax->{'amount'};
1263 my $description = &$escape_function( $tax->{'description'} );
1264 my $amount = sprintf( '%.2f', $tax->{'amount'} );
1266 if ( $multisection ) {
1268 push @detail_items, {
1269 ext_description => [],
1272 description => $description,
1273 amount => $money_char. $amount,
1275 section => $tax_section,
1280 push @total_items, {
1281 'total_item' => $description,
1282 'total_amount' => $other_money_char. $amount,
1287 push @buf,[ $description,
1288 $money_char. $amount,
1295 $total->{'total_item'} = $self->mt('Sub-total');
1296 $total->{'total_amount'} =
1297 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
1299 if ( $multisection ) {
1300 if ( $taxtotal > 0 ) {
1301 # there are taxes, so prepare the section to be displayed.
1302 # $taxtotal already includes any line items that were already in the
1303 # section (fees, taxes that are charged as packages for some reason).
1304 # also set 'summarized' to false so that this isn't a summary-only
1306 $tax_section->{'subtotal'} = $other_money_char.
1307 sprintf('%.2f', $taxtotal);
1308 $tax_section->{'pretotal'} = 'New charges sub-total '.
1309 $total->{'total_amount'};
1310 $tax_section->{'description'} = $self->mt($tax_description);
1311 $tax_section->{'summarized'} = '';
1313 # append it if it's not already there
1314 if ( !grep $tax_section, @sections ) {
1315 push @sections, $tax_section;
1316 push @summary_subtotals, $tax_section;
1321 unshift @total_items, $total;
1324 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1330 my %embolden_functions = (
1331 'latex' => sub { return '\textbf{'. shift(). '}' },
1332 'html' => sub { return '<b>'. shift(). '</b>' },
1333 'template' => sub { shift },
1335 my $embolden_function = $embolden_functions{$format};
1337 if ( $multisection ) {
1339 if ( $adjust_section->{'sort_weight'} ) {
1340 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1341 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1343 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1344 $other_money_char. sprintf('%.2f', $self->charged );
1349 if ( $self->can('_items_total') ) { # should always be true now
1351 # even for multisection, need plain text version
1353 my @new_total_items = $self->_items_total;
1355 push @buf,['','-----------'];
1357 foreach ( @new_total_items ) {
1358 my ($item, $amount) = ($_->{'total_item'}, $_->{'total_amount'});
1359 $_->{'total_item'} = &$embolden_function( $item );
1360 $_->{'total_amount'} = &$embolden_function( $other_money_char.$amount );
1361 # but if it's multisection, don't append to @total_items. the adjust
1362 # section has all this stuff
1363 push @total_items, $_ if !$multisection;
1364 push @buf, [ $item, $money_char.sprintf('%10.2f',$amount) ];
1367 push @buf, [ '', '' ];
1369 # if we're showing previous invoices, also show previous
1370 # credits and payments
1371 if ( $self->enable_previous
1372 and $self->can('_items_credits')
1373 and $self->can('_items_payments') )
1377 my $credittotal = 0;
1378 foreach my $credit (
1379 $self->_items_credits( 'template' => $template, 'trim_len' => 40 )
1383 $total->{'total_item'} = &$escape_function($credit->{'description'});
1384 $credittotal += $credit->{'amount'};
1385 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1386 if ( $multisection ) {
1387 push @detail_items, {
1388 ext_description => [],
1391 description => &$escape_function($credit->{'description'}),
1392 amount => $money_char . $credit->{'amount'},
1394 section => $adjust_section,
1397 push @total_items, $total;
1401 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1404 foreach my $credit (
1405 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1407 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1411 my $paymenttotal = 0;
1412 foreach my $payment (
1413 $self->_items_payments( 'template' => $template )
1416 $total->{'total_item'} = &$escape_function($payment->{'description'});
1417 $paymenttotal += $payment->{'amount'};
1418 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1419 if ( $multisection ) {
1420 push @detail_items, {
1421 ext_description => [],
1424 description => &$escape_function($payment->{'description'}),
1425 amount => $money_char . $payment->{'amount'},
1427 section => $adjust_section,
1430 push @total_items, $total;
1432 push @buf, [ $payment->{'description'},
1433 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1436 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1438 if ( $multisection ) {
1439 $adjust_section->{'subtotal'} = $other_money_char.
1440 sprintf('%.2f', $credittotal + $paymenttotal);
1442 #why this? because {sort_weight} forces the adjust_section to appear
1443 #in @extra_sections instead of @sections. obviously.
1444 push @sections, $adjust_section
1445 unless $adjust_section->{sort_weight};
1446 # do not summarize; adjustments there are shown according to
1450 # create Balance Due message
1453 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1454 $total->{'total_amount'} =
1455 &$embolden_function(
1456 $other_money_char. sprintf('%.2f', #why? $summarypage
1457 # ? $self->charged +
1458 # $self->billing_balance
1460 $self->owed + $pr_total
1463 if ( $multisection && !$adjust_section->{sort_weight} ) {
1464 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1465 $total->{'total_amount'};
1467 push @total_items, $total;
1469 push @buf,['','-----------'];
1470 push @buf,[$self->balance_due_msg, $money_char.
1471 sprintf("%10.2f", $balance_due ) ];
1474 if ( $conf->exists('previous_balance-show_credit')
1475 and $cust_main->balance < 0 ) {
1476 my $credit_total = {
1477 'total_item' => &$embolden_function($self->credit_balance_msg),
1478 'total_amount' => &$embolden_function(
1479 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1482 if ( $multisection ) {
1483 $adjust_section->{'posttotal'} .= $newline_token .
1484 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1487 push @total_items, $credit_total;
1489 push @buf,['','-----------'];
1490 push @buf,[$self->credit_balance_msg, $money_char.
1491 sprintf("%10.2f", -$cust_main->balance ) ];
1495 } #end of default total adding ! can('_items_total')
1497 if ( $multisection ) {
1498 if ( $conf->exists('svc_phone_sections')
1499 && $self->can('_items_svc_phone_sections')
1503 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1504 $total->{'total_amount'} =
1505 &$embolden_function(
1506 $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
1508 my $last_section = pop @sections;
1509 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1510 $total->{'total_amount'};
1511 push @sections, $last_section;
1513 push @sections, @$late_sections
1517 # make a discounts-available section, even without multisection
1518 if ( $conf->exists('discount-show_available')
1519 and my @discounts_avail = $self->_items_discounts_avail ) {
1520 my $discount_section = {
1521 'description' => $self->mt('Discounts Available'),
1526 push @sections, $discount_section; # do not summarize
1527 push @detail_items, map { +{
1528 'ref' => '', #should this be something else?
1529 'section' => $discount_section,
1530 'description' => &$escape_function( $_->{description} ),
1531 'amount' => $money_char . &$escape_function( $_->{amount} ),
1532 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1533 } } @discounts_avail;
1536 # not adding any more sections after this
1537 $invoice_data{summary_subtotals} = \@summary_subtotals;
1540 if ( $conf->exists('usage_class_summary')
1541 and $self->can('_items_usage_class_summary') ) {
1542 my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function, 'money_char' => $other_money_char);
1543 if ( @usage_subtotals ) {
1544 unshift @sections, $usage_subtotals[0]->{section}; # do not summarize
1545 unshift @detail_items, @usage_subtotals;
1549 # invoice history "section" (not really a section)
1550 # not to be included in any subtotals, completely independent of
1552 if ( $conf->exists('previous_invoice_history') and $cust_main->isa('FS::cust_main') ) {
1555 foreach my $cust_bill ( $cust_main->cust_bill ) {
1556 # XXX hardcoded format, and currently only 'charged'; add other fields
1557 # if they become necessary
1558 my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1559 $history{$date} ||= 0;
1560 $history{$date} += $cust_bill->charged;
1561 # just so we have a numeric sort key
1562 $monthorder{$date} ||= $cust_bill->_date;
1564 my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1566 my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1567 $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1570 # service locations: another option for template customization
1572 foreach my $item (@detail_items) {
1573 if ( $item->{locationnum} ) {
1574 $location_info{ $item->{locationnum} } ||= {
1575 FS::cust_location->by_key( $item->{locationnum} )->location_hash
1579 $invoice_data{location_info} = \%location_info;
1581 # debugging hook: call this with 'diag' => 1 to just get a hash of
1582 # the invoice variables
1583 return \%invoice_data if ( $params{'diag'} );
1585 # All sections and items are built; now fill in templates.
1586 my @includelist = ();
1587 push @includelist, 'summary' if $summarypage;
1588 foreach my $include ( @includelist ) {
1590 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1593 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1595 @inc_src = $conf->config($inc_file, $agentnum);
1599 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1601 my $convert_map = $convert_maps{$format}{$include};
1603 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1604 s/--\@\]/$delimiters{$format}[1]/g;
1607 &$convert_map( $conf->config($inc_file, $agentnum) );
1611 my $inc_tt = new Text::Template (
1613 SOURCE => [ map "$_\n", @inc_src ],
1614 DELIMITERS => $delimiters{$format},
1615 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1617 unless ( $inc_tt->compile() ) {
1618 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1619 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1623 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1625 $invoice_data{$include} =~ s/\n+$//
1626 if ($format eq 'latex');
1631 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1632 /invoice_lines\((\d*)\)/;
1633 $invoice_lines += $1 || scalar(@buf);
1636 die "no invoice_lines() functions in template?"
1637 if ( $format eq 'template' && !$wasfunc );
1639 if ($format eq 'template') {
1641 if ( $invoice_lines ) {
1642 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1643 $invoice_data{'total_pages'}++
1644 if scalar(@buf) % $invoice_lines;
1647 #setup subroutine for the template
1648 $invoice_data{invoice_lines} = sub {
1649 my $lines = shift || scalar(@buf);
1661 push @collect, split("\n",
1662 $text_template->fill_in( HASH => \%invoice_data )
1664 $invoice_data{'page'}++;
1666 map "$_\n", @collect;
1668 } else { # this is where we actually create the invoice
1670 warn "filling in template for invoice ". $self->invnum. "\n"
1672 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1675 $text_template->fill_in(HASH => \%invoice_data);
1679 sub notice_name { '('.shift->table.')'; }
1681 # this is not supposed to happen
1682 sub template_conf { warn "bare FS::Template_Mixin::template_conf";
1686 # helper routine for generating date ranges
1687 sub _prior_month30s {
1690 [ 1, 2592000 ], # 0-30 days ago
1691 [ 2592000, 5184000 ], # 30-60 days ago
1692 [ 5184000, 7776000 ], # 60-90 days ago
1693 [ 7776000, 0 ], # 90+ days ago
1696 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
1697 $_->[1] ? $self->_date - $_->[1] - 1 : '',
1702 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1704 Returns an postscript invoice, as a scalar.
1706 Options can be passed as a hashref (recommended) or as a list of time, template
1707 and then any key/value pairs for any other options.
1709 I<time> an optional value used to control the printing of overdue messages. The
1710 default is now. It isn't the date of the invoice; that's the `_date' field.
1711 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1712 L<Time::Local> and L<Date::Parse> for conversion functions.
1714 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1721 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1722 my $ps = generate_ps($file);
1724 unlink($barcodefile) if $barcodefile;
1729 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1731 Returns an PDF invoice, as a scalar.
1733 Options can be passed as a hashref (recommended) or as a list of time, template
1734 and then any key/value pairs for any other options.
1736 I<time> an optional value used to control the printing of overdue messages. The
1737 default is now. It isn't the date of the invoice; that's the `_date' field.
1738 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1739 L<Time::Local> and L<Date::Parse> for conversion functions.
1741 I<template>, if specified, is the name of a suffix for alternate invoices.
1743 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1750 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1751 my $pdf = generate_pdf($file);
1753 unlink($barcodefile) if $barcodefile;
1758 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1760 Returns an HTML invoice, as a scalar.
1762 I<time> an optional value used to control the printing of overdue messages. The
1763 default is now. It isn't the date of the invoice; that's the `_date' field.
1764 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1765 L<Time::Local> and L<Date::Parse> for conversion functions.
1767 I<template>, if specified, is the name of a suffix for alternate invoices.
1769 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1771 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1772 when emailing the invoice as part of a multipart/related MIME email.
1780 %params = %{ shift() };
1784 $params{'format'} = 'html';
1786 $self->print_generic( %params );
1789 # quick subroutine for print_latex
1791 # There are ten characters that LaTeX treats as special characters, which
1792 # means that they do not simply typeset themselves:
1793 # # $ % & ~ _ ^ \ { }
1795 # TeX ignores blanks following an escaped character; if you want a blank (as
1796 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1800 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1801 $value =~ s/([<>])/\$$1\$/g;
1807 encode_entities($value);
1811 sub _html_escape_nbsp {
1812 my $value = _html_escape(shift);
1813 $value =~ s/ +/ /g;
1817 #utility methods for print_*
1819 sub _translate_old_latex_format {
1820 warn "_translate_old_latex_format called\n"
1827 if ( $line =~ /^%%Detail\s*$/ ) {
1829 push @template, q![@--!,
1830 q! foreach my $_tr_line (@detail_items) {!,
1831 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1832 q! $_tr_line->{'description'} .= !,
1833 q! "\\tabularnewline\n~~".!,
1834 q! join( "\\tabularnewline\n~~",!,
1835 q! @{$_tr_line->{'ext_description'}}!,
1839 while ( ( my $line_item_line = shift )
1840 !~ /^%%EndDetail\s*$/ ) {
1841 $line_item_line =~ s/'/\\'/g; # nice LTS
1842 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1843 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1844 push @template, " \$OUT .= '$line_item_line';";
1847 push @template, '}',
1850 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1852 push @template, '[@--',
1853 ' foreach my $_tr_line (@total_items) {';
1855 while ( ( my $total_item_line = shift )
1856 !~ /^%%EndTotalDetails\s*$/ ) {
1857 $total_item_line =~ s/'/\\'/g; # nice LTS
1858 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1859 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1860 push @template, " \$OUT .= '$total_item_line';";
1863 push @template, '}',
1867 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1868 push @template, $line;
1874 warn "$_\n" foreach @template;
1886 my $conf = $self->conf;
1888 #check for an invoice-specific override
1889 return $self->invoice_terms if $self->invoice_terms;
1891 #check for a customer- specific override
1892 my $cust_main = $self->cust_main;
1893 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1897 $agentnum = $cust_main->agentnum;
1898 } elsif ( my $prospect_main = $self->prospect_main ) {
1899 $agentnum = $prospect_main->agentnum;
1902 #use configured default
1903 $conf->config('invoice_default_terms', $agentnum) || '';
1913 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1914 $duedate = $self->_date() + ( $1 * 86400 );
1925 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
1928 =item balance_due_msg
1932 sub balance_due_msg {
1934 my $msg = $self->mt('Balance Due');
1935 return $msg unless $self->terms; # huh?
1936 if ( !$self->conf->exists('invoice_show_prior_due_date')
1937 or $self->conf->exists('invoice_sections') ) {
1938 # if enabled, the due date is shown with Total New Charges (see
1939 # _items_total) and not here
1940 # (yes, or if invoice_sections is enabled; this is just for compatibility)
1941 if ( $self->due_date ) {
1942 $msg .= ' - ' . $self->mt('Please pay by'). ' '.
1943 $self->due_date2str('short');
1944 } elsif ( $self->terms ) {
1945 $msg .= ' - '. $self->mt($self->terms);
1951 =item balance_due_date
1955 sub balance_due_date {
1957 my $conf = $self->conf;
1959 my $terms = $self->terms;
1960 if ( $terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1961 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
1966 sub credit_balance_msg {
1968 $self->mt('Credit Balance Remaining')
1973 Returns a string with the date, for example: "3/20/2008", localized for the
1974 customer. Use _date_pretty_unlocalized for non-end-customer display use.
1980 $self->time2str_local('short', $self->_date);
1983 =item _date_pretty_unlocalized
1985 Returns a string with the date, for example: "3/20/2008", in the format
1986 configured for the back-office. Use _date_pretty for end-customer display use.
1990 sub _date_pretty_unlocalized {
1992 time2str($date_format, $self->_date);
1997 Emails this template.
1999 Options are passed as a hashref. Available options:
2005 If specified, overrides the default From: address.
2009 If specified, overrides the name of the sent document ("Invoice" or "Quotation")
2013 (Deprecated) If specified, is the name of a suffix for alternate template files.
2017 Options accepted by generate_email can also be used.
2023 my $opt = shift || {};
2024 if ($opt and !ref($opt)) {
2025 die ref($self). '->email called with positional parameters';
2028 return if $self->hide;
2030 my $error = send_email(
2031 $self->generate_email(
2032 'subject' => $self->email_subject($opt->{template}),
2033 %$opt, # template, etc.
2037 die "can't email: $error\n" if $error;
2040 =item generate_email OPTION => VALUE ...
2048 sender address, required
2052 alternate template name, optional
2056 email subject, optional
2060 notice name instead of "Invoice", optional
2064 Returns an argument list to be passed to L<FS::Misc::send_email>.
2070 sub generate_email {
2074 my $conf = $self->conf;
2076 my $me = '[FS::Template_Mixin::generate_email]';
2079 'from' => $args{'from'},
2080 'subject' => ($args{'subject'} || $self->email_subject),
2081 'custnum' => $self->custnum,
2082 'msgtype' => 'invoice',
2085 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
2087 my $cust_main = $self->cust_main;
2089 if (ref($args{'to'}) eq 'ARRAY') {
2090 $return{'to'} = $args{'to'};
2091 } elsif ( $cust_main ) {
2092 $return{'to'} = [ $cust_main->invoicing_list_emailonly ];
2095 my $tc = $self->template_conf;
2097 my @text; # array of lines
2098 my $html; # a big string
2099 my @related_parts; # will contain the text/HTML alternative, and images
2100 my $related; # will contain the multipart/related object
2102 if ( $conf->exists($tc. 'email_pdf') ) {
2103 if ( my $msgnum = $conf->config($tc.'email_pdf_msgnum') ) {
2105 warn "$me using '${tc}email_pdf_msgnum' in multipart message"
2108 my $msg_template = FS::msg_template->by_key($msgnum)
2109 or die "${tc}email_pdf_msgnum $msgnum not found\n";
2110 my %prepared = $msg_template->prepare(
2111 cust_main => $self->cust_main,
2115 @text = split(/(?=\n)/, $prepared{'text_body'});
2116 $html = $prepared{'html_body'};
2118 } elsif ( my @note = $conf->config($tc.'email_pdf_note') ) {
2120 warn "$me using '${tc}email_pdf_note' in multipart message"
2122 @text = $conf->config($tc.'email_pdf_note');
2123 $html = join('<BR>', @text);
2125 } # else use the plain text invoice
2130 if ( $conf->config($tc.'template') ) {
2132 warn "$me generating plain text invoice"
2135 # 'print_text' argument is no longer used
2136 @text = $self->print_text(\%args);
2140 warn "$me no plain text version exists; sending empty message body"
2147 my $text_part = build MIME::Entity (
2148 'Type' => 'text/plain',
2149 'Encoding' => 'quoted-printable',
2150 'Charset' => 'UTF-8',
2151 #'Encoding' => '7bit',
2153 'Disposition' => 'inline',
2158 if ( $conf->exists($tc.'html') ) {
2159 warn "$me generating HTML invoice"
2162 $args{'from'} =~ /\@([\w\.\-]+)/;
2163 my $from = $1 || 'example.com';
2164 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2167 my $agentnum = $cust_main ? $cust_main->agentnum
2168 : $self->prospect_main->agentnum;
2169 if ( defined($args{'template'}) && length($args{'template'})
2170 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
2173 $logo = 'logo_'. $args{'template'}. '.png';
2177 my $image_data = $conf->config_binary( $logo, $agentnum);
2179 push @related_parts, build MIME::Entity
2180 'Type' => 'image/png',
2181 'Encoding' => 'base64',
2182 'Data' => $image_data,
2183 'Filename' => 'logo.png',
2184 'Content-ID' => "<$content_id>",
2187 if ( ref($self) eq 'FS::cust_bill' && $conf->exists('invoice-barcode') ) {
2188 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2189 push @related_parts, build MIME::Entity
2190 'Type' => 'image/png',
2191 'Encoding' => 'base64',
2192 'Data' => $self->invoice_barcode(0),
2193 'Filename' => 'barcode.png',
2194 'Content-ID' => "<$barcode_content_id>",
2196 $args{'barcode_cid'} = $barcode_content_id;
2199 $html = $self->print_html({ 'cid'=>$content_id, %args });
2206 warn "$me creating HTML/text multipart message"
2209 $return{'nobody'} = 1;
2211 my $alternative = build MIME::Entity
2212 'Type' => 'multipart/alternative',
2213 #'Encoding' => '7bit',
2214 'Disposition' => 'inline'
2218 $alternative->add_part($text_part);
2221 $alternative->attach(
2222 'Type' => 'text/html',
2223 'Encoding' => 'quoted-printable',
2224 'Data' => [ '<html>',
2227 ' '. encode_entities($return{'subject'}),
2230 ' <body bgcolor="#e8e8e8">',
2235 'Disposition' => 'inline',
2236 #'Filename' => 'invoice.pdf',
2239 unshift @related_parts, $alternative;
2241 $related = build MIME::Entity 'Type' => 'multipart/related',
2242 'Encoding' => '7bit';
2244 #false laziness w/Misc::send_email
2245 $related->head->replace('Content-type',
2246 $related->mime_type.
2247 '; boundary="'. $related->head->multipart_boundary. '"'.
2248 '; type=multipart/alternative'
2251 $related->add_part($_) foreach @related_parts;
2255 my @otherparts = ();
2256 if ( ref($self) eq 'FS::cust_bill' && $cust_main->email_csv_cdr ) {
2258 push @otherparts, build MIME::Entity
2259 'Type' => 'text/csv',
2260 'Encoding' => '7bit',
2261 'Data' => [ map { "$_\n" }
2262 $self->call_details('prepend_billed_number' => 1)
2264 'Disposition' => 'attachment',
2265 'Filename' => 'usage-'. $self->invnum. '.csv',
2270 if ( $conf->exists($tc.'email_pdf') ) {
2275 # multipart/alternative
2281 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
2282 push @otherparts, $pdf;
2286 $return{'content-type'} = 'multipart/mixed'; # of the outer container
2288 $return{'mimeparts'} = [ $related, @otherparts ];
2289 $return{'type'} = 'multipart/related'; # of the first part
2291 $return{'mimeparts'} = [ $text_part, @otherparts ];
2292 $return{'type'} = 'text/plain';
2294 } elsif ( $html ) { # no PDF or CSV, strip the outer container
2295 $return{'mimeparts'} = \@related_parts;
2296 $return{'content-type'} = 'multipart/related';
2297 $return{'type'} = 'multipart/alternative';
2298 } else { # no HTML either
2299 $return{'body'} = \@text;
2300 $return{'content-type'} = 'text/plain';
2309 Returns a list suitable for passing to MIME::Entity->build(), representing
2310 this invoice as PDF attachment.
2317 'Type' => 'application/pdf',
2318 'Encoding' => 'base64',
2319 'Data' => [ $self->print_pdf(@_) ],
2320 'Disposition' => 'attachment',
2321 'Filename' => 'invoice-'. $self->invnum. '.pdf',
2325 =item _items_sections OPTIONS
2327 Generate section information for all items appearing on this invoice.
2328 This will only be called for multi-section invoices.
2330 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
2331 related display records (L<FS::cust_bill_pkg_display>) and organize
2332 them into two groups ("early" and "late" according to whether they come
2333 before or after the total), then into sections. A subtotal is calculated
2336 Section descriptions are returned in sort weight order. Each consists
2337 of a hash containing:
2339 description: the package category name, escaped
2340 subtotal: the total charges in that section
2341 tax_section: a flag indicating that the section contains only tax charges
2342 summarized: same as tax_section, for some reason
2343 sort_weight: the package category's sort weight
2345 If 'condense' is set on the display record, it also contains everything
2346 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
2347 coderefs to generate parts of the invoice. This is not advised.
2349 The method returns two arrayrefs, one of "early" sections and one of "late"
2352 OPTIONS may include:
2354 by_location: a flag to divide the invoice into sections by location.
2355 Each section hash will have a 'location' element containing a hashref of
2356 the location fields (see L<FS::cust_location>). The section description
2357 will be the location label, but the template can use any of the location
2358 fields to create a suitable label.
2360 by_category: a flag to divide the invoice into sections using display
2361 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
2362 behavior. Each section hash will have a 'category' element containing
2363 the section name from the display record (which probably equals the
2364 category name of the package, but may not in some cases).
2366 summary: a flag indicating that this is a summary-format invoice.
2367 Turning this on has the following effects:
2368 - Ignores display items with the 'summary' flag.
2369 - Places all sections in the "early" group even if they have post_total.
2370 - Creates sections for all non-disabled package categories, even if they
2371 have no charges on this invoice, as well as a section with no name.
2373 escape: an escape function to use for section titles.
2375 extra_sections: an arrayref of additional sections to return after the
2376 sorted list. If there are any of these, section subtotals exclude
2379 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
2380 passed through to C<_condense_section()>.
2384 use vars qw(%pkg_category_cache);
2385 sub _items_sections {
2389 my $escape = $opt{escape};
2390 my @extra_sections = @{ $opt{extra_sections} || [] };
2392 # $subtotal{$locationnum}{$categoryname} = amount.
2393 # if we're not using by_location, $locationnum is undef.
2394 # if we're not using by_category, you guessed it, $categoryname is undef.
2395 # if we're not using either one, we shouldn't be here in the first place...
2397 my %late_subtotal = ();
2400 # About tax items + multisection invoices:
2401 # If either invoice_*summary option is enabled, AND there is a
2402 # package category with the name of the tax, then there will be
2403 # a display record assigning the tax item to that category.
2405 # However, the taxes are always placed in the "Taxes, Surcharges,
2406 # and Fees" section regardless of that. The only effect of the
2407 # display record is to create a subtotal for the summary page.
2410 my $pkg_hash = $self->cust_pkg_hash;
2412 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2415 my $usage = $cust_bill_pkg->usage;
2418 if ( $opt{by_location} ) {
2419 if ( $cust_bill_pkg->pkgnum ) {
2420 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2425 $locationnum = undef;
2428 # as in _items_cust_pkg, if a line item has no display records,
2429 # cust_bill_pkg_display() returns a default record for it
2431 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2432 next if ( $display->summary && $opt{summary} );
2434 my $section = $display->section;
2435 my $type = $display->type;
2436 # Set $section = undef if we're sectioning by location and this
2437 # line item _has_ a location (i.e. isn't a fee).
2438 $section = undef if $locationnum;
2440 # set this flag if the section is not tax-only
2441 $not_tax{$locationnum}{$section} = 1
2442 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
2444 # there's actually a very important piece of logic buried in here:
2445 # incrementing $late_subtotal{$section} CREATES
2446 # $late_subtotal{$section}. keys(%late_subtotal) is later used
2447 # to define the list of late sections, and likewise keys(%subtotal).
2448 # When _items_cust_bill_pkg is called to generate line items for
2449 # real, it will be called with 'section' => $section for each
2451 if ( $display->post_total && !$opt{summary} ) {
2452 if (! $type || $type eq 'S') {
2453 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2454 if $cust_bill_pkg->setup != 0
2455 || $cust_bill_pkg->setup_show_zero;
2459 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
2460 if $cust_bill_pkg->recur != 0
2461 || $cust_bill_pkg->recur_show_zero;
2464 if ($type && $type eq 'R') {
2465 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2466 if $cust_bill_pkg->recur != 0
2467 || $cust_bill_pkg->recur_show_zero;
2470 if ($type && $type eq 'U') {
2471 $late_subtotal{$locationnum}{$section} += $usage
2472 unless scalar(@extra_sections);
2475 } else { # it's a pre-total (normal) section
2477 # skip tax items unless they're explicitly included in a section
2478 next if $cust_bill_pkg->pkgnum == 0 and
2479 ! $cust_bill_pkg->feepart and
2482 if ( $type eq 'S' ) {
2483 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2484 if $cust_bill_pkg->setup != 0
2485 || $cust_bill_pkg->setup_show_zero;
2486 } elsif ( $type eq 'R' ) {
2487 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2488 if $cust_bill_pkg->recur != 0
2489 || $cust_bill_pkg->recur_show_zero;
2490 } elsif ( $type eq 'U' ) {
2491 $subtotal{$locationnum}{$section} += $usage
2492 unless scalar(@extra_sections);
2493 } elsif ( !$type ) {
2494 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2495 + $cust_bill_pkg->recur;
2504 %pkg_category_cache = ();
2506 # summary invoices need subtotals for all non-disabled package categories,
2507 # even if they're zero
2508 # but currently assume that there are no location sections, or at least
2509 # that the summary page doesn't care about them
2510 if ( $opt{summary} ) {
2511 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2512 $subtotal{''}{$category->categoryname} ||= 0;
2514 $subtotal{''}{''} ||= 0;
2518 foreach my $post_total (0,1) {
2520 my $s = $post_total ? \%late_subtotal : \%subtotal;
2521 foreach my $locationnum (keys %$s) {
2522 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2524 'subtotal' => $s->{$locationnum}{$sectionname},
2527 if ( $locationnum ) {
2528 $section->{'locationnum'} = $locationnum;
2529 my $location = FS::cust_location->by_key($locationnum);
2530 $section->{'description'} = &{ $escape }($location->location_label);
2531 # Better ideas? This will roughly group them by proximity,
2532 # which alpha sorting on any of the address fields won't.
2533 # Sorting by locationnum is meaningless.
2534 # We have to sort on _something_ or the order may change
2535 # randomly from one invoice to the next, which will confuse
2537 $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
2539 $section->{'location'} = {
2540 label_prefix => &{ $escape }($location->label_prefix),
2541 map { $_ => &{ $escape }($location->get($_)) }
2545 $section->{'category'} = $sectionname;
2546 $section->{'description'} = &{ $escape }($sectionname);
2547 if ( _pkg_category($sectionname) ) {
2548 $section->{'sort_weight'} = _pkg_category($sectionname)->weight;
2549 if ( _pkg_category($sectionname)->condense ) {
2550 $section = { %$section, $self->_condense_section($opt{format}) };
2554 if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
2555 # then it's a tax-only section
2556 $section->{'summarized'} = 'Y';
2557 $section->{'tax_section'} = 'Y';
2559 push @these, $section;
2560 } # foreach $sectionname
2561 } #foreach $locationnum
2562 push @these, @extra_sections if $post_total == 0;
2563 # need an alpha sort for location sections, because postal codes can
2565 $sections[ $post_total ] = [ sort {
2566 $opt{'by_location'} ?
2567 ($a->{sort_weight} cmp $b->{sort_weight}) :
2568 ($a->{sort_weight} <=> $b->{sort_weight})
2570 } #foreach $post_total
2572 return @sections; # early, late
2575 #helper subs for above
2579 $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2583 my $categoryname = shift;
2584 $pkg_category_cache{$categoryname} ||=
2585 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2588 my %condensed_format = (
2589 'label' => [ qw( Description Qty Amount ) ],
2591 sub { shift->{description} },
2592 sub { shift->{quantity} },
2593 sub { my($href, %opt) = @_;
2594 ($opt{dollar} || ''). $href->{amount};
2597 'align' => [ qw( l r r ) ],
2598 'span' => [ qw( 5 1 1 ) ], # unitprices?
2599 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
2602 sub _condense_section {
2603 my ( $self, $format ) = ( shift, shift );
2605 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2606 qw( description_generator
2609 total_line_generator
2614 sub _condensed_generator_defaults {
2615 my ( $self, $format ) = ( shift, shift );
2616 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2625 sub _condensed_header_generator {
2626 my ( $self, $format ) = ( shift, shift );
2628 my ( $f, $prefix, $suffix, $separator, $column ) =
2629 _condensed_generator_defaults($format);
2631 if ($format eq 'latex') {
2632 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2633 $suffix = "\\\\\n\\hline";
2636 sub { my ($d,$a,$s,$w) = @_;
2637 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2639 } elsif ( $format eq 'html' ) {
2640 $prefix = '<th></th>';
2644 sub { my ($d,$a,$s,$w) = @_;
2645 return qq!<th align="$html_align{$a}">$d</th>!;
2653 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2655 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2658 $prefix. join($separator, @result). $suffix;
2663 sub _condensed_description_generator {
2664 my ( $self, $format ) = ( shift, shift );
2666 my ( $f, $prefix, $suffix, $separator, $column ) =
2667 _condensed_generator_defaults($format);
2669 my $money_char = '$';
2670 if ($format eq 'latex') {
2671 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2673 $separator = " & \n";
2675 sub { my ($d,$a,$s,$w) = @_;
2676 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2678 $money_char = '\\dollar';
2679 }elsif ( $format eq 'html' ) {
2680 $prefix = '"><td align="center"></td>';
2684 sub { my ($d,$a,$s,$w) = @_;
2685 return qq!<td align="$html_align{$a}">$d</td>!;
2687 #$money_char = $conf->config('money_char') || '$';
2688 $money_char = ''; # this is madness
2696 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2698 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2700 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2701 map { $f->{$_}->[$i] } qw(align span width)
2705 $prefix. join( $separator, @result ). $suffix;
2710 sub _condensed_total_generator {
2711 my ( $self, $format ) = ( shift, shift );
2713 my ( $f, $prefix, $suffix, $separator, $column ) =
2714 _condensed_generator_defaults($format);
2717 if ($format eq 'latex') {
2720 $separator = " & \n";
2722 sub { my ($d,$a,$s,$w) = @_;
2723 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2725 }elsif ( $format eq 'html' ) {
2729 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2731 sub { my ($d,$a,$s,$w) = @_;
2732 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2741 # my $r = &{$f->{fields}->[$i]}(@args);
2742 # $r .= ' Total' unless $i;
2744 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2746 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
2747 map { $f->{$_}->[$i] } qw(align span width)
2751 $prefix. join( $separator, @result ). $suffix;
2756 =item total_line_generator FORMAT
2758 Returns a coderef used for generation of invoice total line items for this
2759 usage_class. FORMAT is either html or latex
2763 # should not be used: will have issues with hash element names (description vs
2764 # total_item and amount vs total_amount -- another array of functions?
2766 sub _condensed_total_line_generator {
2767 my ( $self, $format ) = ( shift, shift );
2769 my ( $f, $prefix, $suffix, $separator, $column ) =
2770 _condensed_generator_defaults($format);
2773 if ($format eq 'latex') {
2776 $separator = " & \n";
2778 sub { my ($d,$a,$s,$w) = @_;
2779 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2781 }elsif ( $format eq 'html' ) {
2785 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2787 sub { my ($d,$a,$s,$w) = @_;
2788 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2797 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2799 &{$column}( &{$f->{fields}->[$i]}(@args),
2800 map { $f->{$_}->[$i] } qw(align span width)
2804 $prefix. join( $separator, @result ). $suffix;
2809 =item _items_pkg [ OPTIONS ]
2811 Return line item hashes for each package item on this invoice. Nearly
2814 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
2816 OPTIONS are passed through to _items_cust_bill_pkg, and should include
2817 'format' and 'escape_function' at minimum.
2819 To produce items for a specific invoice section, OPTIONS should include
2820 'section', a hashref containing 'category' and/or 'locationnum' keys.
2822 'section' may also contain a key named 'condensed'. If this is present
2823 and has a true value, _items_pkg will try to merge identical items into items
2824 with 'quantity' equal to the number of items (not the sum of their separate
2825 quantities, for some reason).
2831 # The order of these is important. Bundled line items will be merged into
2832 # the most recent non-hidden item, so it needs to be the one with:
2834 # - the same start date
2835 # - no pkgpart_override
2837 # So: sort by pkgnum,
2839 # then sort the base line item before any overrides
2840 # then sort hidden before non-hidden add-ons
2841 # then sort by override pkgpart (for consistency)
2842 sort { $a->pkgnum <=> $b->pkgnum or
2843 $a->sdate <=> $b->sdate or
2844 ($a->pkgpart_override ? 0 : -1) or
2845 ($b->pkgpart_override ? 0 : 1) or
2846 $b->hidden cmp $a->hidden or
2847 $a->pkgpart_override <=> $b->pkgpart_override
2849 # and of course exclude taxes and fees
2850 grep { $_->pkgnum > 0 } $self->cust_bill_pkg;
2856 my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
2857 my $escape_function = $options{escape_function};
2860 foreach my $cust_bill_pkg (@cust_bill_pkg) {
2861 # cache this, so we don't look it up again in every section
2862 my $part_fee = $cust_bill_pkg->get('part_fee')
2863 || $cust_bill_pkg->part_fee;
2864 $cust_bill_pkg->set('part_fee', $part_fee);
2866 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
2867 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
2870 if ( exists($options{section}) and exists($options{section}{category}) )
2872 my $categoryname = $options{section}{category};
2873 # then filter for items that have that section
2874 if ( $part_fee->categoryname ne $categoryname ) {
2875 warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
2878 } # otherwise include them all in the main section
2879 # XXX what to do when sectioning by location?
2882 my %base_invnums; # invnum => invoice date
2883 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
2884 if ($_->base_invnum) {
2885 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
2886 my $base_date = $self->time2str_local('short', $base_bill->_date)
2888 $base_invnums{$_->base_invnum} = $base_date || '';
2891 foreach (sort keys(%base_invnums)) {
2892 next if $_ == $self->invnum;
2893 # per convention, we must escape ext_description lines
2895 &{$escape_function}(
2896 $self->mt('from invoice #[_1] on [_2]', $_, $base_invnums{$_})
2899 my $desc = $part_fee->itemdesc_locale($self->cust_main->locale);
2900 # but not escape the base description line
2903 { feepart => $cust_bill_pkg->feepart,
2904 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
2905 description => $desc,
2906 ext_description => \@ext_desc
2917 warn "$me _items_pkg searching for all package line items\n"
2920 my @cust_bill_pkg = $self->_items_nontax;
2922 warn "$me _items_pkg filtering line items\n"
2924 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2926 if ($options{section} && $options{section}->{condensed}) {
2928 warn "$me _items_pkg condensing section\n"
2932 local $Storable::canonical = 1;
2933 foreach ( @items ) {
2935 delete $item->{ref};
2936 delete $item->{ext_description};
2937 my $key = freeze($item);
2938 $itemshash{$key} ||= 0;
2939 $itemshash{$key} ++; # += $item->{quantity};
2941 @items = sort { $a->{description} cmp $b->{description} }
2942 map { my $i = thaw($_);
2943 $i->{quantity} = $itemshash{$_};
2945 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
2951 warn "$me _items_pkg returning ". scalar(@items). " items\n"
2958 return 0 unless $a->itemdesc cmp $b->itemdesc;
2959 return -1 if $b->itemdesc eq 'Tax';
2960 return 1 if $a->itemdesc eq 'Tax';
2961 return -1 if $b->itemdesc eq 'Other surcharges';
2962 return 1 if $a->itemdesc eq 'Other surcharges';
2963 $a->itemdesc cmp $b->itemdesc;
2968 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
2969 $self->cust_bill_pkg;
2970 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2972 if ( $self->conf->exists('always_show_tax') ) {
2973 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
2974 if (0 == grep { $_->{description} eq $itemdesc } @items) {
2976 { 'description' => $itemdesc,
2983 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
2985 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
2986 list of hashrefs describing the line items they generate on the invoice.
2988 OPTIONS may include:
2990 format: the invoice format.
2992 escape_function: the function used to escape strings.
2994 DEPRECATED? (expensive, mostly unused?)
2995 format_function: the function used to format CDRs.
2997 section: a hashref containing 'category' and/or 'locationnum'; if this
2998 is present, only returns line items that belong to that category and/or
2999 location (whichever is defined).
3001 multisection: a flag indicating that this is a multisection invoice,
3002 which does something complicated.
3004 Returns a list of hashrefs, each of which may contain:
3006 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
3007 ext_description, which is an arrayref of detail lines to show below
3012 sub _items_cust_bill_pkg {
3014 my $conf = $self->conf;
3015 my $cust_bill_pkgs = shift;
3018 my $format = $opt{format} || '';
3019 my $escape_function = $opt{escape_function} || sub { shift };
3020 my $format_function = $opt{format_function} || '';
3021 my $no_usage = $opt{no_usage} || '';
3022 my $unsquelched = $opt{unsquelched} || ''; #unused
3023 my ($section, $locationnum, $category);
3024 if ( $opt{section} ) {
3025 $category = $opt{section}->{category};
3026 $locationnum = $opt{section}->{locationnum};
3028 my $summary_page = $opt{summary_page} || ''; #unused
3029 my $multisection = defined($category) || defined($locationnum);
3030 # this variable is the value of the config setting, not whether it applies
3031 # to this particular line item.
3032 my $discount_show_always = $conf->exists('discount-show-always');
3034 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 40;
3036 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
3038 # for location labels: use default location on the invoice date
3039 my $default_locationnum;
3040 if ( $self->custnum ) {
3042 my @h_search = FS::h_cust_main->sql_h_search($self->_date);
3043 $h_cust_main = qsearchs({
3044 'table' => 'h_cust_main',
3045 'hashref' => { custnum => $self->custnum },
3046 'extra_sql' => $h_search[1],
3047 'addl_from' => $h_search[3],
3049 $default_locationnum = $h_cust_main->ship_locationnum;
3050 } elsif ( $self->prospectnum ) {
3051 my $cust_location = qsearchs('cust_location',
3052 { prospectnum => $self->prospectnum,
3054 $default_locationnum = $cust_location->locationnum if $cust_location;
3057 my @b = (); # accumulator for the line item hashes that we'll return
3058 my ($s, $r, $u, $d) = ( undef, undef, undef, undef );
3059 # the 'current' line item hashes for setup, recur, usage, discount
3060 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
3062 # if the current line item is waiting to go out, and the one we're about
3063 # to start is not bundled, then push out the current one and start a new
3066 $d->{amount} = $d->{setup_amount} + $d->{recur_amount};
3068 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3069 if ( $_ && !$cust_bill_pkg->hidden ) {
3070 $_->{amount} = sprintf( "%.2f", $_->{amount} );
3071 $_->{amount} =~ s/^\-0\.00$/0.00/;
3072 if (exists($_->{unit_amount})) {
3073 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3076 # we already decided to create this display line; don't reconsider it
3078 # if $_->{amount} != 0
3079 # || $discount_show_always
3080 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3081 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3087 if ( $locationnum ) {
3088 # this is a location section; skip packages that aren't at this
3090 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
3091 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
3095 # Consider display records for this item to determine if it belongs
3096 # in this section. Note that if there are no display records, there
3097 # will be a default pseudo-record that includes all charge types
3098 # and has no section name.
3099 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
3100 ? $cust_bill_pkg->cust_bill_pkg_display
3101 : ( $cust_bill_pkg );
3103 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
3104 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
3107 if ( defined($category) ) {
3108 # then this is a package category section; process all display records
3109 # that belong to this section.
3110 @cust_bill_pkg_display = grep { $_->section eq $category }
3111 @cust_bill_pkg_display;
3113 # otherwise, process all display records that aren't usage summaries
3114 # (I don't think there should be usage summaries if you aren't using
3115 # category sections, but this is the historical behavior)
3116 @cust_bill_pkg_display = grep { !$_->summary }
3117 @cust_bill_pkg_display;
3120 my $classname = ''; # package class name, will fill in later
3122 foreach my $display (@cust_bill_pkg_display) {
3124 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
3125 $display->billpkgdisplaynum. "\n"
3128 my $type = $display->type;
3130 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
3131 $desc = substr($desc, 0, $maxlength). '...'
3132 if $format eq 'latex' && length($desc) > $maxlength;
3134 my %details_opt = ( 'format' => $format,
3135 'escape_function' => $escape_function,
3136 'format_function' => $format_function,
3137 'no_usage' => $opt{'no_usage'},
3140 if ( $cust_bill_pkg->pkgnum > 0 ) {
3141 # a "normal" package line item (not a quotation, not a fee, not a tax)
3143 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
3146 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3147 my $part_pkg = $cust_pkg->part_pkg;
3149 # which pkgpart to show for display purposes?
3150 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
3152 # start/end dates for invoice formats that do nonstandard
3154 my %item_dates = ();
3155 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
3156 unless $part_pkg->option('disable_line_item_date_ranges',1);
3158 # not normally used, but pass this to the template anyway
3159 $classname = $part_pkg->classname;
3161 if ( (!$type || $type eq 'S')
3162 && ( $cust_bill_pkg->setup != 0
3163 || $cust_bill_pkg->setup_show_zero
3164 || ($discount_show_always and $cust_bill_pkg->unitsetup > 0)
3169 warn "$me _items_cust_bill_pkg adding setup\n"
3172 # append the word 'Setup' to the setup line if there's going to be
3173 # a recur line for the same package (i.e. not a one-time charge)
3174 my $description = $desc;
3175 $description .= ' Setup'
3176 if $cust_bill_pkg->recur != 0
3177 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3178 || $cust_bill_pkg->recur_show_zero;
3180 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3182 if $part_pkg->is_prepaid #for prepaid, "display the validity period
3183 # triggered by the recurring charge freq
3185 && $cust_bill_pkg->recur == 0
3186 && ! $cust_bill_pkg->recur_show_zero;
3191 # always pass the svc_label through to the template, even if
3192 # not displaying it as an ext_description
3193 my @svc_labels = map &{$escape_function}($_),
3194 $cust_pkg->h_labels_short($self->_date, undef, 'I');
3196 $svc_label = $svc_labels[0];
3198 unless ( $cust_pkg->part_pkg->hide_svc_detail
3199 || $cust_bill_pkg->hidden )
3202 push @d, @svc_labels
3203 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3204 # show the location label if it's not the customer's default
3205 # location, and we're not grouping items by location already
3206 if ( $cust_pkg->locationnum != $default_locationnum
3207 and !defined($locationnum) ) {
3208 my $loc = $cust_pkg->location_label;
3209 $loc = substr($loc, 0, $maxlength). '...'
3210 if $format eq 'latex' && length($loc) > $maxlength;
3211 push @d, &{$escape_function}($loc);
3214 } #unless hiding service details
3216 push @d, $cust_bill_pkg->details(%details_opt)
3217 if $cust_bill_pkg->recur == 0;
3219 if ( $cust_bill_pkg->hidden ) {
3220 $s->{amount} += $cust_bill_pkg->setup;
3221 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3222 push @{ $s->{ext_description} }, @d;
3226 description => $description,
3227 pkgpart => $pkgpart,
3228 pkgnum => $cust_bill_pkg->pkgnum,
3229 amount => $cust_bill_pkg->setup,
3230 setup_show_zero => $cust_bill_pkg->setup_show_zero,
3231 unit_amount => $cust_bill_pkg->unitsetup,
3232 quantity => $cust_bill_pkg->quantity,
3233 ext_description => \@d,
3234 svc_label => ($svc_label || ''),
3235 locationnum => $cust_pkg->locationnum, # sure, why not?
3241 # should we show a recur line?
3242 # if type eq 'S', then NO, because we've been told not to.
3243 # otherwise, show the recur line if:
3244 # - there's a recurring charge
3245 # - or recur_show_zero is on
3246 # - or there's a positive unitrecur (so it's been discounted to zero)
3247 # and discount-show-always is on
3248 if ( ( !$type || $type eq 'R' || $type eq 'U' )
3250 $cust_bill_pkg->recur != 0
3252 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3253 || $cust_bill_pkg->recur_show_zero
3258 warn "$me _items_cust_bill_pkg adding recur/usage\n"
3261 my $is_summary = $display->summary;
3262 my $description = $desc;
3263 if ( $type eq 'U' and defined($r) ) {
3264 # don't just show the same description as the recur line
3265 $description = $self->mt('Usage charges');
3268 my $part_pkg = $cust_pkg->part_pkg;
3270 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3274 my @seconds = (); # for display of usage info
3277 #at least until cust_bill_pkg has "past" ranges in addition to
3278 #the "future" sdate/edate ones... see #3032
3279 my @dates = ( $self->_date );
3280 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
3281 push @dates, $prev->sdate if $prev;
3282 push @dates, undef if !$prev;
3284 my @svc_labels = map &{$escape_function}($_),
3285 $cust_pkg->h_labels_short(@dates, 'I');
3286 $svc_label = $svc_labels[0];
3288 # show service labels, unless...
3289 # the package is set not to display them
3290 unless ( $part_pkg->hide_svc_detail
3291 # or this is a tax-like line item
3292 || $cust_bill_pkg->itemdesc
3293 # or this is a hidden (bundled) line item
3294 || $cust_bill_pkg->hidden
3295 # or this is a usage summary line
3296 || $is_summary && $type && $type eq 'U'
3297 # or this is a usage line and there's a recurring line
3298 # for the package in the same section (which will
3299 # have service labels already)
3300 || ($type eq 'U' and defined($r))
3304 warn "$me _items_cust_bill_pkg adding service details\n"
3307 push @d, @svc_labels
3308 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3309 warn "$me _items_cust_bill_pkg done adding service details\n"
3312 # show the location label if it's not the customer's default
3313 # location, and we're not grouping items by location already
3314 if ( $cust_pkg->locationnum != $default_locationnum
3315 and !defined($locationnum) ) {
3316 my $loc = $cust_pkg->location_label;
3317 $loc = substr($loc, 0, $maxlength). '...'
3318 if $format eq 'latex' && length($loc) > $maxlength;
3319 push @d, &{$escape_function}($loc);
3322 # Display of seconds_since_sqlradacct:
3323 # On the invoice, when processing @detail_items, look for a field
3324 # named 'seconds'. This will contain total seconds for each
3325 # service, in the same order as @ext_description. For services
3326 # that don't support this it will show undef.
3327 if ( $conf->exists('svc_acct-usage_seconds')
3328 and ! $cust_bill_pkg->pkgpart_override ) {
3329 foreach my $cust_svc (
3330 $cust_pkg->h_cust_svc(@dates, 'I')
3333 # eval because not having any part_export_usage exports
3334 # is a fatal error, last_bill/_date because that's how
3335 # sqlradius_hour billing does it
3337 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
3339 push @seconds, $sec;
3341 } #if svc_acct-usage_seconds
3343 } # if we are showing service labels
3345 unless ( $is_summary ) {
3346 warn "$me _items_cust_bill_pkg adding details\n"
3349 #instead of omitting details entirely in this case (unwanted side
3350 # effects), just omit CDRs
3351 $details_opt{'no_usage'} = 1
3352 if $type && $type eq 'R';
3354 push @d, $cust_bill_pkg->details(%details_opt);
3357 warn "$me _items_cust_bill_pkg calculating amount\n"
3362 $amount = $cust_bill_pkg->recur;
3363 } elsif ($type eq 'R') {
3364 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
3365 } elsif ($type eq 'U') {
3366 $amount = $cust_bill_pkg->usage;
3369 if ( !$type || $type eq 'R' ) {
3371 warn "$me _items_cust_bill_pkg adding recur\n"
3375 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
3378 if ( $cust_bill_pkg->hidden ) {
3379 $r->{amount} += $amount;
3380 $r->{unit_amount} += $unit_amount;
3381 push @{ $r->{ext_description} }, @d;
3384 description => $description,
3385 pkgpart => $pkgpart,
3386 pkgnum => $cust_bill_pkg->pkgnum,
3388 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3389 unit_amount => $unit_amount,
3390 quantity => $cust_bill_pkg->quantity,
3392 ext_description => \@d,
3393 svc_label => ($svc_label || ''),
3394 locationnum => $cust_pkg->locationnum,
3396 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3399 } else { # $type eq 'U'
3401 warn "$me _items_cust_bill_pkg adding usage\n"
3404 if ( $cust_bill_pkg->hidden and defined($u) ) {
3405 # if this is a hidden package and there's already a usage
3406 # line for the bundle, add this package's total amount and
3407 # usage details to it
3408 $u->{amount} += $amount;
3409 push @{ $u->{ext_description} }, @d;
3410 } elsif ( $amount ) {
3411 # create a new usage line
3413 description => $description,
3414 pkgpart => $pkgpart,
3415 pkgnum => $cust_bill_pkg->pkgnum,
3418 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3420 ext_description => \@d,
3421 locationnum => $cust_pkg->locationnum,
3423 } # else this has no usage, so don't create a usage section
3426 } # recurring or usage with recurring charge
3428 } else { # taxes and fees
3430 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3433 # items of this kind should normally not have sdate/edate.
3435 'description' => $desc,
3436 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
3437 + $cust_bill_pkg->recur)
3440 } # if package line item / other line item
3442 # decide whether to show active discounts here
3444 # case 1: we are showing a single line for the package
3446 # case 2: we are showing a setup line for a package that has
3447 # no base recurring fee
3448 or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3449 # case 3: we are showing a recur line for a package that has
3450 # a base recurring fee
3451 or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3454 my $item_discount = $cust_bill_pkg->_item_discount;
3455 if ( $item_discount ) {
3456 # $item_discount->{amount} is negative
3458 if ( $d and $cust_bill_pkg->hidden ) {
3459 $d->{setup_amount} += $item_discount->{setup_amount};
3460 $d->{recur_amount} += $item_discount->{recur_amount};
3462 $d = $item_discount;
3463 $_ = &{$escape_function}($_) foreach @{ $d->{ext_description} };
3466 # update the active line (before the discount) to show the
3467 # original price (whether this is a hidden line or not)
3469 $s->{amount} -= $item_discount->{setup_amount} if $s;
3470 $r->{amount} -= $item_discount->{recur_amount} if $r;
3472 } # if there are any discounts
3473 } # if this is an appropriate place to show discounts
3475 } # foreach $display
3479 # discount amount is internally split up
3481 $d->{amount} = $d->{setup_amount} + $d->{recur_amount};
3484 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3486 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3487 if exists($_->{amount});
3488 $_->{amount} =~ s/^\-0\.00$/0.00/;
3489 if (exists($_->{unit_amount})) {
3490 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3494 #if $_->{amount} != 0
3495 # || $discount_show_always
3496 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3497 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3501 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3508 =item _items_discounts_avail
3510 Returns an array of line item hashrefs representing available term discounts
3511 for this invoice. This makes the same assumptions that apply to term
3512 discounts in general: that the package is billed monthly, at a flat rate,
3513 with no usage charges. A prorated first month will be handled, as will
3514 a setup fee if the discount is allowed to apply to setup fees.
3518 sub _items_discounts_avail {
3521 #maybe move this method from cust_bill when quotations support discount_plans
3522 return () unless $self->can('discount_plans');
3523 my %plans = $self->discount_plans;
3525 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3526 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3530 my $plan = $plans{$months};
3532 my $term_total = sprintf('%.2f', $plan->discounted_total);
3533 my $percent = sprintf('%.0f',
3534 100 * (1 - $term_total / $plan->base_total) );
3535 my $permonth = sprintf('%.2f', $term_total / $months);
3536 my $detail = $self->mt('discount on item'). ' '.
3537 join(', ', map { "#$_" } $plan->pkgnums)
3540 # discounts for non-integer months don't work anyway
3541 $months = sprintf("%d", $months);
3544 description => $self->mt('Save [_1]% by paying for [_2] months',
3546 amount => $self->mt('[_1] ([_2] per month)',
3547 $term_total, $money_char.$permonth),
3548 ext_description => ($detail || ''),
3551 sort { $b <=> $a } keys %plans;