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 Time::Local qw( timelocal );
14 use Text::Template 1.20;
16 use Archive::Zip qw( :ERROR_CODES :CONSTANTS );
21 use FS::Misc qw( send_email );
22 use FS::Record qw( qsearch qsearchs );
24 use FS::Misc qw( generate_ps generate_pdf );
31 $me = '[FS::Template_Mixin]';
32 FS::UID->install_callback( sub {
33 my $conf = new FS::Conf; #global
34 $money_char = $conf->config('money_char') || '$';
35 $date_format = $conf->config('date_format') || '%x'; #/YY
40 Returns a configuration handle (L<FS::Conf>) set to the customer's locale.
42 If the "mode" pseudo-field is set on the object, the configuration handle
43 will be an L<FS::invoice_conf> for that invoice mode (and the customer's
50 my $mode = $self->get('mode');
51 if ($self->{_conf} and !defined($mode)) {
52 return $self->{_conf};
55 my $cust_main = $self->cust_main;
56 my $locale = $cust_main ? $cust_main->locale : '';
59 if ( ref $mode and $mode->isa('FS::invoice_mode') ) {
60 $mode = $mode->modenum;
61 } elsif ( $mode =~ /\D/ ) {
62 die "invalid invoice mode $mode";
64 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => $locale });
66 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => '' });
67 # it doesn't have a locale, but system conf still might
68 $conf->set('locale' => $locale) if $conf;
71 # if $mode is unspecified, or if there is no invoice_conf matching this mode
72 # and locale, then use the system config only (but with the locale)
73 $conf ||= FS::Conf->new({ 'locale' => $locale });
75 return $self->{_conf} = $conf;
78 =item print_text OPTIONS
80 Returns an text invoice, as a list of lines.
82 Options can be passed as a hash.
84 I<time>, if specified, is used to control the printing of overdue messages. The
85 default is now. It isn't the date of the invoice; that's the `_date' field.
86 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
87 L<Time::Local> and L<Date::Parse> for conversion functions.
89 I<template>, if specified, is the name of a suffix for alternate invoices.
91 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
99 %params = %{ shift() };
104 $params{'format'} = 'template'; # for some reason
106 $self->print_generic( %params );
109 =item print_latex HASHREF
111 Internal method - returns a filename of a filled-in LaTeX template for this
112 invoice (Note: add ".tex" to get the actual filename), and a filename of
113 an associated logo (with the .eps extension included).
115 See print_ps and print_pdf for methods that return PostScript and PDF output.
117 Options can be passed as a hash.
119 I<time>, if specified, is used to control the printing of overdue messages. The
120 default is now. It isn't the date of the invoice; that's the `_date' field.
121 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
122 L<Time::Local> and L<Date::Parse> for conversion functions.
124 I<template>, if specified, is the name of a suffix for alternate invoices.
125 This is strongly deprecated; see L<FS::invoice_conf> for the right way to
126 customize invoice templates for different purposes.
128 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
137 %params = %{ shift() };
142 $params{'format'} = 'latex';
143 my $conf = $self->conf;
145 # this needs to go away
146 my $template = $params{'template'};
147 # and this especially
148 $template ||= $self->_agent_template
149 if $self->can('_agent_template');
152 $self->set('mode', $params{mode})
155 my $pkey = $self->primary_key;
156 my $tmp_template = $self->table. '.'. $self->$pkey. '.XXXXXXXX';
158 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
159 my $lh = new File::Temp(
160 TEMPLATE => $tmp_template,
164 ) or die "can't open temp file: $!\n";
166 my $agentnum = $self->agentnum;
168 if ( $template && $conf->exists("logo_${template}.eps", $agentnum) ) {
169 print $lh $conf->config_binary("logo_${template}.eps", $agentnum)
170 or die "can't write temp file: $!\n";
172 print $lh $conf->config_binary('logo.eps', $agentnum)
173 or die "can't write temp file: $!\n";
176 $params{'logo_file'} = $lh->filename;
178 if( $conf->exists('invoice-barcode')
179 && $self->can('invoice_barcode')
180 && $self->invnum ) { # don't try to barcode statements
181 my $png_file = $self->invoice_barcode($dir);
182 my $eps_file = $png_file;
183 $eps_file =~ s/\.png$/.eps/g;
184 $png_file =~ /(barcode.*png)/;
186 $eps_file =~ /(barcode.*eps)/;
189 my $curr_dir = cwd();
191 # after painfuly long experimentation, it was determined that sam2p won't
192 # accept : and other chars in the path, no matter how hard I tried to
193 # escape them, hence the chdir (and chdir back, just to be safe)
194 system('sam2p', '-j:quiet', $png_file, 'EPS:', $eps_file ) == 0
195 or die "sam2p failed: $!\n";
199 $params{'barcode_file'} = $eps_file;
202 my @filled_in = $self->print_generic( %params );
204 my $fh = new File::Temp( TEMPLATE => $tmp_template,
208 ) or die "can't open temp file: $!\n";
209 binmode($fh, ':utf8'); # language support
210 print $fh join('', @filled_in );
213 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
214 return ($1, $params{'logo_file'}, $params{'barcode_file'});
220 my $cust_main = $self->cust_main;
221 $cust_main ? $cust_main->agentnum : $self->prospect_main->agentnum;
224 =item print_generic OPTION => VALUE ...
226 Internal method - returns a filled-in template for this invoice as a scalar.
228 See print_ps and print_pdf for methods that return PostScript and PDF output.
236 The B<format> option is required and should be set to html, latex (print and PDF) or template (plaintext).
246 Overrides "Invoice" as the name of the sent document.
250 Used to control the printing of overdue messages. The
251 default is now. It isn't the date of the invoice; that's the `_date' field.
252 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
253 L<Time::Local> and L<Date::Parse> for conversion functions.
257 Logo file (path to temporary EPS file on the local filesystem)
261 CID for inline (emailed) images (logo)
265 Override customer's locale
269 Overrides any per customer cdr squelching when true
273 Supress the (invoice, quotation, statement, etc.) number
281 Supress the payment coupon
285 Barcode file (path to temporary EPS file on the local filesystem)
289 Flag indicating the barcode image should be a link (normal HTML dipaly)
293 Barcode CID for inline (emailed) images
295 =item preref_callback
297 Coderef run for each line item, code should return HTML to be displayed
298 before that line item (quotations only)
302 Dprecated. Used as a suffix for a configuration template. Please
303 don't use this, it deprecated in favor of more flexible alternatives.
309 #what's with all the sprintf('%10.2f')'s in here? will it cause any
310 # (alignment in text invoice?) problems to change them all to '%.2f' ?
311 # yes: fixed width/plain text printing will be borked
313 my( $self, %params ) = @_;
314 my $conf = $self->conf;
316 my $today = $params{today} ? $params{today} : time;
317 warn "$me print_generic called on $self with suffix $params{template}\n"
320 my $format = $params{format};
321 die "Unknown format: $format"
322 unless $format =~ /^(latex|html|template)$/;
324 my $cust_main = $self->cust_main || $self->prospect_main;
326 my $locale = $params{'locale'} || $cust_main->locale;
328 my %delimiters = ( 'latex' => [ '[@--', '--@]' ],
329 'html' => [ '<%=', '%>' ],
330 'template' => [ '{', '}' ],
333 warn "$me print_generic creating template\n"
336 # set the notice name here, and nowhere else.
337 my $notice_name = $params{notice_name}
338 || $conf->config('notice_name')
339 || $self->notice_name;
342 my $template = $params{template} ? $params{template} : $self->_agent_template;
343 my $templatefile = $self->template_conf. $format;
344 $templatefile .= "_$template"
345 if length($template) && $conf->exists($templatefile."_$template");
348 my @invoice_template = map "$_\n", $conf->config($templatefile)
349 or die "cannot load config data $templatefile";
351 if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
352 #change this to a die when the old code is removed
353 # it's been almost ten years, changing it to a die
354 die "old-style invoice template $templatefile; ".
355 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
356 #$old_latex = 'true';
357 #@invoice_template = _translate_old_latex_format(@invoice_template);
360 warn "$me print_generic creating T:T object\n"
363 my $text_template = new Text::Template(
365 SOURCE => \@invoice_template,
366 DELIMITERS => $delimiters{$format},
369 warn "$me print_generic compiling T:T object\n"
372 $text_template->compile()
373 or die "Can't compile $templatefile: $Text::Template::ERROR\n";
376 # additional substitution could possibly cause breakage in existing templates
379 'notes' => sub { map "$_", @_ },
380 'footer' => sub { map "$_", @_ },
381 'smallfooter' => sub { map "$_", @_ },
382 'returnaddress' => sub { map "$_", @_ },
383 'coupon' => sub { map "$_", @_ },
384 'summary' => sub { map "$_", @_ },
390 s/%%(.*)$/<!-- $1 -->/g;
391 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
392 s/\\begin\{enumerate\}/<ol>/g;
394 s/\\end\{enumerate\}/<\/ol>/g;
395 s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
404 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
406 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
412 s/\\hyphenation\{[\w\s\-]+}//;
417 'coupon' => sub { "" },
418 'summary' => sub { "" },
425 s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
426 s/\\begin\{enumerate\}//g;
428 s/\\end\{enumerate\}//g;
429 s/\\textbf\{(.*)\}/$1/g;
436 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
438 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
443 s/\\\\\*?\s*$/\n/; # dubious
444 s/\\hyphenation\{[\w\s\-]+}//;
448 'coupon' => sub { "" },
449 'summary' => sub { "" },
454 # hashes for differing output formats
455 my %nbsps = ( 'latex' => '~',
456 'html' => '', # '&nbps;' would be nice
457 'template' => '', # not used
459 my $nbsp = $nbsps{$format};
461 my %escape_functions = ( 'latex' => \&_latex_escape,
462 'html' => \&_html_escape_nbsp,#\&encode_entities,
463 'template' => sub { shift },
465 my $escape_function = $escape_functions{$format};
466 my $escape_function_nonbsp = ($format eq 'html')
467 ? \&_html_escape : $escape_function;
469 my %newline_tokens = ( 'latex' => '\\\\',
473 my $newline_token = $newline_tokens{$format};
475 warn "$me generating template variables\n"
478 # generate template variables
482 defined( $conf->config_orbase( "invoice_${format}returnaddress",
486 && length( $conf->config_orbase( "invoice_${format}returnaddress",
492 $returnaddress = join("\n",
493 $conf->config_orbase("invoice_${format}returnaddress", $template)
497 $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
499 my $convert_map = $convert_maps{$format}{'returnaddress'};
502 &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
507 } elsif ( grep /\S/, $conf->config('company_address', $cust_main->agentnum) ) {
509 my $convert_map = $convert_maps{$format}{'returnaddress'};
510 $returnaddress = join( "\n", &$convert_map(
511 map { s/( {2,})/'~' x length($1)/eg;
515 ( $conf->config('company_name', $cust_main->agentnum),
516 $conf->config('company_address', $cust_main->agentnum),
523 my $warning = "Couldn't find a return address; ".
524 "do you need to set the company_address configuration value?";
526 $returnaddress = $nbsp;
527 #$returnaddress = $warning;
531 warn "$me generating invoice data\n"
534 my $agentnum = $cust_main->agentnum;
539 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
540 'company_address' => join("\n", $conf->config('company_address', $agentnum) ). "\n",
541 'company_phonenum'=> scalar( $conf->config('company_phonenum', $agentnum) ),
542 'returnaddress' => $returnaddress,
543 'agent' => &$escape_function($cust_main->agent->agent),
545 #invoice/quotation info
546 'no_number' => $params{'no_number'},
547 'invnum' => ( $params{'no_number'} ? '' : $self->invnum ),
548 'quotationnum' => $self->quotationnum,
549 'no_date' => $params{'no_date'},
550 '_date' => ( $params{'no_date'} ? '' : $self->_date ),
551 # workaround for inconsistent behavior in the early plain text
552 # templates; see RT#28271
553 'date' => ( $params{'no_date'}
555 : ($format eq 'template'
557 : $self->time2str_local('long', $self->_date, $format)
560 'today' => $self->time2str_local('long', $today, $format),
561 'terms' => $self->terms,
562 'template' => $template, #params{'template'},
563 'notice_name' => $notice_name, # escape?
564 'current_charges' => sprintf("%.2f", $self->charged),
565 'duedate' => $self->due_date2str('rdate'), #date_format?
566 'duedate_long' => $self->due_date2str('long'),
569 'custnum' => $cust_main->display_custnum,
570 'prospectnum' => $cust_main->prospectnum,
571 'agent_custid' => &$escape_function($cust_main->agent_custid),
572 ( map { $_ => &$escape_function($cust_main->$_()) }
573 qw( company address1 address2 city state zip fax )
575 'payname' => &$escape_function( $cust_main->invoice_attn
576 || $cust_main->contact_firstlast ),
579 'ship_enable' => $cust_main->invoice_ship_address || $conf->exists('invoice-ship_address'),
580 'unitprices' => $conf->exists('invoice-unitprice'),
581 'smallernotes' => $conf->exists('invoice-smallernotes'),
582 'smallerfooter' => $conf->exists('invoice-smallerfooter'),
583 'balance_due_below_line' => $conf->exists('balance_due_below_line'),
585 #layout info -- would be fancy to calc some of this and bury the template
587 'topmargin' => scalar($conf->config('invoice_latextopmargin', $agentnum)),
588 'headsep' => scalar($conf->config('invoice_latexheadsep', $agentnum)),
589 'textheight' => scalar($conf->config('invoice_latextextheight', $agentnum)),
590 'extracouponspace' => scalar($conf->config('invoice_latexextracouponspace', $agentnum)),
591 'couponfootsep' => scalar($conf->config('invoice_latexcouponfootsep', $agentnum)),
592 'verticalreturnaddress' => $conf->exists('invoice_latexverticalreturnaddress', $agentnum),
593 'addresssep' => scalar($conf->config('invoice_latexaddresssep', $agentnum)),
594 'amountenclosedsep' => scalar($conf->config('invoice_latexcouponamountenclosedsep', $agentnum)),
595 'coupontoaddresssep' => scalar($conf->config('invoice_latexcoupontoaddresssep', $agentnum)),
596 'addcompanytoaddress' => $conf->exists('invoice_latexcouponaddcompanytoaddress', $agentnum),
598 # better hang on to conf_dir for a while (for old templates)
599 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
601 #these are only used when doing paged plaintext
607 #quotations have $name
608 $invoice_data{'name'} = $invoice_data{'payname'};
611 $invoice_data{'emt'} = sub { &$escape_function($self->mt(@_)) };
612 # prototype here to silence warnings
613 $invoice_data{'time2str'} = sub ($;$$) { $self->time2str_local(@_, $format) };
615 my $min_sdate = 999999999999;
617 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
618 next unless $cust_bill_pkg->pkgnum > 0;
619 $min_sdate = $cust_bill_pkg->sdate
620 if length($cust_bill_pkg->sdate) && $cust_bill_pkg->sdate < $min_sdate;
621 $max_edate = $cust_bill_pkg->edate
622 if length($cust_bill_pkg->edate) && $cust_bill_pkg->edate > $max_edate;
625 $invoice_data{'bill_period'} = '';
626 $invoice_data{'bill_period'} =
627 $self->time2str_local('%e %h', $min_sdate, $format)
629 $self->time2str_local('%e %h', $max_edate, $format)
630 if ($max_edate != 0 && $min_sdate != 999999999999);
632 $invoice_data{finance_section} = '';
633 if ( $conf->config('finance_pkgclass') ) {
635 qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
636 $invoice_data{finance_section} = $pkg_class->categoryname;
638 $invoice_data{finance_amount} = '0.00';
639 $invoice_data{finance_section} ||= 'Finance Charges'; #avoid config confusion
641 my $countrydefault = $conf->config('countrydefault') || 'US';
642 foreach ( qw( address1 address2 city state zip country fax) ){
643 my $method = 'ship_'.$_;
644 $invoice_data{"ship_$_"} = $escape_function->($cust_main->$method);
646 if ( length($cust_main->ship_company) ) {
647 $invoice_data{'ship_company'} = $escape_function->($cust_main->ship_company);
649 $invoice_data{'ship_company'} = $escape_function->($cust_main->company);
651 $invoice_data{'ship_contact'} = $escape_function->($cust_main->contact);
652 $invoice_data{'ship_country'} = ''
653 if ( $invoice_data{'ship_country'} eq $countrydefault );
655 $invoice_data{'cid'} = $params{'cid'}
658 if ( $cust_main->country eq $countrydefault ) {
659 $invoice_data{'country'} = '';
661 $invoice_data{'country'} = &$escape_function($cust_main->bill_country_full);
665 $invoice_data{'address'} = \@address;
667 $invoice_data{'payname'}.
668 ( $cust_main->po_number
669 ? " (P.O. #". $cust_main->po_number. ")"
673 push @address, $cust_main->company
674 if $cust_main->company;
675 push @address, $cust_main->address1;
676 push @address, $cust_main->address2
677 if $cust_main->address2;
679 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
680 push @address, $invoice_data{'country'}
681 if $invoice_data{'country'};
683 while (scalar(@address) < 5);
685 $invoice_data{'logo_file'} = $params{'logo_file'}
686 if $params{'logo_file'};
687 $invoice_data{'barcode_file'} = $params{'barcode_file'}
688 if $params{'barcode_file'};
689 $invoice_data{'barcode_img'} = $params{'barcode_img'}
690 if $params{'barcode_img'};
691 $invoice_data{'barcode_cid'} = $params{'barcode_cid'}
692 if $params{'barcode_cid'};
694 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
695 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
696 #my $balance_due = $self->owed + $pr_total - $cr_total;
697 my $balance_due = $self->owed;
698 if ( $self->enable_previous ) {
699 $balance_due += $pr_total;
701 # otherwise the previous balance is not shown, so including it in the
702 # balance due is just confusing
704 # the sum of amount owed on all invoices
705 # (this is used in the summary & on the payment coupon)
706 $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
708 # flag telling this invoice to have a first-page summary
709 my $summarypage = '';
711 if ( $self->custnum && $self->invnum ) {
712 # XXX should be an FS::cust_bill method to set the defaults, instead
713 # of checking the type here
715 # info from customer's last invoice before this one, for some
717 $invoice_data{'last_bill'} = {};
719 my $last_bill = $self->previous_bill;
722 # "balance_date_range" unfortunately is unsuitable for this, since it
723 # cares about application dates. We want to know the sum of all
724 # _top-level transactions_ dated before the last invoice.
726 # still do this for the "Previous Balance" line of the summary block
728 map "$_ WHERE _date <= ? AND custnum = ?", (
729 "SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill",
730 "SELECT -1 * COALESCE( SUM(amount), 0 ) FROM cust_credit",
731 "SELECT -1 * COALESCE( SUM(paid), 0 ) FROM cust_pay",
732 "SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund",
735 # the customer's current balance immediately after generating the last
738 my $last_bill_balance = $last_bill->charged;
740 my $delta = FS::Record->scalar_sql(
742 $last_bill->_date - 1,
745 $last_bill_balance += $delta;
748 $last_bill_balance = sprintf("%.2f", $last_bill_balance);
750 warn sprintf("LAST BILL: INVNUM %d, DATE %s, BALANCE %.2f\n\n",
752 $self->time2str_local('%D', $last_bill->_date),
755 # ("true_previous_balance" is a terrible name, but at least it's no
756 # longer stored in the database)
757 $invoice_data{'true_previous_balance'} = $last_bill_balance;
759 # Now, get all applications of credits/payments dated on or after the
760 # previous bill, to invoices before the current bill. (The
761 # credit/payment date restriction prevents these from intersecting
762 # the "Previous Balance" set.)
763 # These are "adjustments". The past due balance will be shown as
764 # Previous Balance - Adjustments.
767 "SELECT COALESCE(SUM(y.amount),0) FROM $_ JOIN cust_bill USING (invnum)
768 WHERE cust_bill._date < ?
770 AND cust_bill.custnum = ?"
771 } "cust_credit AS x JOIN cust_credit_bill y USING (crednum)",
772 "cust_pay AS x JOIN cust_bill_pay y USING (paynum)"
775 my $delta = FS::Record->scalar_sql(
781 $adjustments += $delta;
783 $invoice_data{'balance_adjustments'} = sprintf("%.2f", $adjustments);
785 warn sprintf("BALANCE ADJUSTMENTS: %.2f\n\n",
786 $invoice_data{'balance_adjustments'}
789 # the sum of amount owed on all previous invoices
790 # ($pr_total is used elsewhere but not as $previous_balance)
791 $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
793 $invoice_data{'last_bill'}{'_date'} = $last_bill->_date; #unformatted
794 my (@payments, @credits);
795 # for formats that itemize previous payments
796 foreach my $cust_pay ( qsearch('cust_pay', {
797 'custnum' => $self->custnum,
798 '_date' => { op => '>=',
799 value => $last_bill->_date }
802 next if $cust_pay->_date > $self->_date;
804 '_date' => $cust_pay->_date,
805 'date' => $self->time2str_local('long', $cust_pay->_date, $format),
806 'payinfo' => $cust_pay->payby_payinfo_pretty,
807 'amount' => sprintf('%.2f', $cust_pay->paid),
809 # not concerned about applications
811 foreach my $cust_credit ( qsearch('cust_credit', {
812 'custnum' => $self->custnum,
813 '_date' => { op => '>=',
814 value => $last_bill->_date }
817 next if $cust_credit->_date > $self->_date;
819 '_date' => $cust_credit->_date,
820 'date' => $self->time2str_local('long', $cust_credit->_date, $format),
821 'creditreason'=> $cust_credit->reason,
822 'amount' => sprintf('%.2f', $cust_credit->amount),
825 $invoice_data{'previous_payments'} = \@payments;
826 $invoice_data{'previous_credits'} = \@credits;
828 # there is no $last_bill
829 $invoice_data{'true_previous_balance'} =
830 $invoice_data{'balance_adjustments'} =
831 $invoice_data{'previous_balance'} = '0.00';
832 $invoice_data{'previous_payments'} = [];
833 $invoice_data{'previous_credits'} = [];
836 if ( $conf->exists('invoice_usesummary', $agentnum) ) {
837 $invoice_data{'summarypage'} = $summarypage = 1;
840 } # if this is an invoice
842 warn "$me substituting variables in notes, footer, smallfooter\n"
845 my $tc = $self->template_conf;
846 my @include = ( [ $tc, 'notes' ],
847 [ 'invoice_', 'footer' ],
848 [ 'invoice_', 'smallfooter', ],
849 [ 'invoice_', 'watermark' ],
851 push @include, [ $tc, 'coupon', ]
852 unless $params{'no_coupon'};
854 foreach my $i (@include) {
856 # load the configuration for this sub-template
858 my($base, $include) = @$i;
860 my $inc_file = $conf->key_orbase("$base$format$include", $template);
862 my @inc_src = $conf->config($inc_file, $agentnum);
864 my $converter = $convert_maps{$format}{$include};
866 # then attempt to convert LaTeX to the requested format
867 $inc_file = $conf->key_orbase($base.'latex'.$include, $template);
868 @inc_src = &$converter( $conf->config($inc_file, $agentnum) );
870 # this isn't included in the convert_maps
871 my ($open, $close) = @{ $delimiters{$format} };
876 } # else @inc_src is empty and that's fine
878 # make a Text::Template out of it
880 my $inc_tt = new Text::Template (
882 SOURCE => [ map "$_\n", @inc_src ],
883 DELIMITERS => $delimiters{$format},
884 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
886 unless ( $inc_tt->compile() ) {
887 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
888 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
894 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
896 $invoice_data{$include} =~ s/\n+$//
897 if ($format eq 'latex');
900 # if (well, probably when) we still need PO numbers in the brave new world of
901 # 4.x, then we'll have to add them back as their own customer fields
902 # # let invoices use either of these as needed
903 # $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
904 # ? $cust_main->payinfo : '';
905 # $invoice_data{'po_line'} =
906 # ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
907 # ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
910 my %money_chars = ( 'latex' => '',
911 'html' => $conf->config('money_char') || '$',
914 my $money_char = $money_chars{$format};
917 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
918 'html' => $conf->config('money_char') || '$',
921 my $other_money_char = $other_money_chars{$format};
922 $invoice_data{'dollar'} = $other_money_char;
924 my %minus_signs = ( 'latex' => '$-$',
926 'template' => '- ' );
927 my $minus = $minus_signs{$format};
929 my @detail_items = ();
930 my @total_items = ();
934 $invoice_data{'detail_items'} = \@detail_items;
935 $invoice_data{'total_items'} = \@total_items;
936 $invoice_data{'buf'} = \@buf;
937 $invoice_data{'sections'} = \@sections;
939 warn "$me generating sections\n"
942 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
943 my $multisection = $self->has_sections;
944 $conf->exists($tc.'sections', $cust_main->agentnum) ||
945 $conf->exists($tc.'sections_by_location', $cust_main->agentnum);
946 $invoice_data{'multisection'} = $multisection;
948 my $extra_sections = [];
949 my $extra_lines = ();
951 # default section ('Charges')
952 my $default_section = { 'description' => '',
957 # Previous Charges section
958 # subtotal is the first return value from $self->previous
959 my $previous_section;
960 # if the invoice has major sections, or if we're summarizing previous
961 # charges with a single line, or if we've been specifically told to put them
962 # in a section, create a section for previous charges:
963 if ( $multisection or
964 $conf->exists('previous_balance-summary_only') or
965 $conf->exists('previous_balance-section') ) {
967 $previous_section = { 'description' => $self->mt('Previous Charges'),
968 'subtotal' => $other_money_char.
969 sprintf('%.2f', $pr_total),
970 'summarized' => '', #why? $summarypage ? 'Y' : '',
972 $previous_section->{posttotal} = '0 / 30 / 60 / 90 days overdue '.
973 join(' / ', map { $cust_main->balance_date_range(@$_) }
974 $self->_prior_month30s
976 if $conf->exists('invoice_include_aging');
979 # otherwise put them in the main section
980 $previous_section = $default_section;
983 my $adjust_section = {
984 'description' => $self->mt('Credits, Payments, and Adjustments'),
985 'adjust_section' => 1,
986 'subtotal' => 0, # adjusted below
988 my $adjust_weight = _pkg_category($adjust_section->{description})
989 ? _pkg_category($adjust_section->{description})->weight
991 $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
992 # Note: 'sort_weight' here is actually a flag telling whether there is an
993 # explicit package category for the adjust section. If so, certain behavior
995 $adjust_section->{'sort_weight'} = $adjust_weight;
998 if ( $multisection ) {
999 ($extra_sections, $extra_lines) =
1000 $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
1001 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum)
1002 && $self->can('_items_extra_usage_sections');
1004 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
1006 push @detail_items, @$extra_lines if $extra_lines;
1008 # the code is written so that both methods can be used together, but
1009 # we haven't yet changed the template to take advantage of that, so for
1010 # now, treat them as mutually exclusive.
1011 my %section_method = ( by_category => 1 );
1012 if ( $conf->config($tc.'sections_method') eq 'location' ) {
1013 %section_method = ( by_location => 1 );
1015 my ($early, $late) =
1016 $self->_items_sections( 'summary' => $summarypage,
1017 'escape' => $escape_function_nonbsp,
1018 'extra_sections' => $extra_sections,
1019 'format' => $format,
1022 push @sections, @$early;
1023 $late_sections = $late;
1025 if ( $conf->exists('svc_phone_sections')
1026 && $self->can('_items_svc_phone_sections')
1029 my ($phone_sections, $phone_lines) =
1030 $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
1031 push @{$late_sections}, @$phone_sections;
1032 push @detail_items, @$phone_lines;
1034 if ( $conf->exists('voip-cust_accountcode_cdr')
1035 && $cust_main->accountcode_cdr
1036 && $self->can('_items_accountcode_cdr')
1039 my ($accountcode_section, $accountcode_lines) =
1040 $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
1041 if ( scalar(@$accountcode_lines) ) {
1042 push @{$late_sections}, $accountcode_section;
1043 push @detail_items, @$accountcode_lines;
1046 } else {# not multisection
1047 # make a default section
1048 push @sections, $default_section;
1049 # and calculate the finance charge total, since it won't get done otherwise.
1050 # and the default section total
1051 # XXX possibly finance_pkgclass should not be used in this manner?
1052 my @finance_charges;
1054 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1055 if ( $invoice_data{finance_section} and
1056 grep { $_->section eq $invoice_data{finance_section} }
1057 $cust_bill_pkg->cust_bill_pkg_display ) {
1058 # I think these are always setup fees, but just to be sure...
1059 push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1061 push @charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1064 $invoice_data{finance_amount} =
1065 sprintf('%.2f', sum( @finance_charges ) || 0);
1066 $default_section->{subtotal} = $other_money_char.
1067 sprintf('%.2f', sum( @charges ) || 0);
1070 # start setting up summary subtotals
1071 my @summary_subtotals;
1072 my $method = $conf->config('summary_subtotals_method');
1073 if ( $method and $method ne $conf->config($tc.'sections_method') ) {
1074 # then re-section them by the correct method
1075 my %section_method = ( by_category => 1 );
1076 if ( $conf->config('summary_subtotals_method') eq 'location' ) {
1077 %section_method = ( by_location => 1 );
1079 my ($early, $late) =
1080 $self->_items_sections( 'summary' => $summarypage,
1081 'escape' => $escape_function_nonbsp,
1082 'extra_sections' => $extra_sections,
1083 'format' => $format,
1086 foreach ( @$early ) {
1087 next if $_->{subtotal} == 0;
1088 $_->{subtotal} = $other_money_char.sprintf('%.2f', $_->{subtotal});
1089 push @summary_subtotals, $_;
1092 # subtotal sectioning is the same as for the actual invoice sections
1093 @summary_subtotals = @sections;
1096 # Hereafter, push sections to both @sections and @summary_subtotals
1097 # if they belong in both places (e.g. tax section). Late sections are
1098 # never in @summary_subtotals.
1100 # previous invoice balances in the Previous Charges section if there
1101 # is one, otherwise in the main detail section
1102 # (except if summary_only is enabled, don't show them at all)
1103 if ( $self->can('_items_previous') &&
1104 $self->enable_previous &&
1105 ! $conf->exists('previous_balance-summary_only') ) {
1107 warn "$me adding previous balances\n"
1110 foreach my $line_item ( $self->_items_previous ) {
1113 ref => $line_item->{'pkgnum'},
1114 pkgpart => $line_item->{'pkgpart'},
1115 #quantity => 1, # not really correct
1116 section => $previous_section, # which might be $default_section
1117 description => &$escape_function($line_item->{'description'}),
1118 ext_description => [ map { &$escape_function($_) }
1119 @{ $line_item->{'ext_description'} || [] }
1121 amount => $money_char . $line_item->{'amount'},
1122 product_code => $line_item->{'pkgpart'} || 'N/A',
1125 push @detail_items, $detail;
1126 push @buf, [ $detail->{'description'},
1127 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1133 if ( @pr_cust_bill && $self->enable_previous ) {
1134 push @buf, ['','-----------'];
1135 push @buf, [ $self->mt('Total Previous Balance'),
1136 $money_char. sprintf("%10.2f", $pr_total) ];
1140 if ( $conf->exists('svc_phone-did-summary') && $self->can('_did_summary') ) {
1141 warn "$me adding DID summary\n"
1144 my ($didsummary,$minutes) = $self->_did_summary;
1145 my $didsummary_desc = 'DID Activity Summary (since last invoice)';
1147 { 'description' => $didsummary_desc,
1148 'ext_description' => [ $didsummary, $minutes ],
1152 foreach my $section (@sections, @$late_sections) {
1154 # begin some normalization
1155 $section->{'subtotal'} = $section->{'amount'}
1157 && !exists($section->{subtotal})
1158 && exists($section->{amount});
1160 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
1161 if ( $invoice_data{finance_section} &&
1162 $section->{'description'} eq $invoice_data{finance_section} );
1164 $section->{'subtotal'} = $other_money_char.
1165 sprintf('%.2f', $section->{'subtotal'})
1168 # continue some normalization
1169 $section->{'amount'} = $section->{'subtotal'}
1173 if ( $section->{'description'} ) {
1174 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
1179 warn "$me setting options\n"
1183 $options{'section'} = $section if $multisection;
1184 $options{'format'} = $format;
1185 $options{'escape_function'} = $escape_function;
1186 $options{'no_usage'} = 1 unless $unsquelched;
1187 $options{'unsquelched'} = $unsquelched;
1188 $options{'summary_page'} = $summarypage;
1189 $options{'skip_usage'} =
1190 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
1191 $options{'preref_callback'} = $params{'preref_callback'};
1193 warn "$me searching for line items\n"
1196 foreach my $line_item ( $self->_items_pkg(%options),
1197 $self->_items_fee(%options) ) {
1199 warn "$me adding line item ".
1200 join(', ', map "$_=>".$line_item->{$_}, keys %$line_item). "\n"
1203 push @buf, ( [ $line_item->{'description'},
1204 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1206 map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}},
1209 $line_item->{'ref'} = $line_item->{'pkgnum'};
1210 $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()?
1211 $line_item->{'section'} = $section;
1212 $line_item->{'description'} = &$escape_function($line_item->{'description'});
1213 $line_item->{'amount'} = $money_char.$line_item->{'amount'};
1215 if ( length($line_item->{'unit_amount'}) ) {
1216 $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'};
1218 $line_item->{'ext_description'} ||= [];
1220 push @detail_items, $line_item;
1223 if ( $section->{'description'} ) {
1224 push @buf, ( ['','-----------'],
1225 [ $section->{'description'}. ' sub-total',
1226 $section->{'subtotal'} # already formatted this
1235 $invoice_data{current_less_finance} =
1236 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
1238 # if there's anything in the Previous Charges section, prepend it to the list
1239 if ( $pr_total and $previous_section ne $default_section ) {
1240 unshift @sections, $previous_section;
1241 # but not @summary_subtotals
1244 warn "$me adding taxes\n"
1247 # create a tax section if we don't yet have one
1248 my @items_tax = $self->_items_tax;
1249 my $tax_description = 'Taxes, Surcharges, and Fees';
1251 List::Util::first { $_->{description} eq $tax_description } @sections;
1252 if (!$tax_section) {
1253 $tax_section = { 'description' => $tax_description };
1254 push @sections, $tax_section if $multisection and @items_tax > 0;
1256 $tax_section->{tax_section} = 1; # mark this section as containing taxes
1257 # if this is an existing tax section, we're merging the tax items into it.
1258 # grab the taxtotal that's already there, strip the money symbol if any
1259 my $taxtotal = $tax_section->{'subtotal'} || 0;
1260 $taxtotal =~ s/^\Q$other_money_char\E//;
1263 #my $tax_weight = _pkg_category($tax_section->{description})
1264 # ? _pkg_category($tax_section->{description})->weight
1266 #$tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
1267 #$tax_section->{'sort_weight'} = $tax_weight;
1269 foreach my $tax ( @items_tax ) {
1271 $taxtotal += $tax->{'amount'};
1273 my $description = &$escape_function( $tax->{'description'} );
1274 my $amount = sprintf( '%.2f', $tax->{'amount'} );
1276 if ( $multisection ) {
1278 push @detail_items, {
1279 ext_description => [],
1282 description => $description,
1283 amount => $money_char. $amount,
1285 section => $tax_section,
1290 push @total_items, {
1291 'total_item' => $description,
1292 'total_amount' => $other_money_char. $amount,
1297 push @buf,[ $description,
1298 $money_char. $amount,
1305 $total->{'total_item'} = $self->mt('Sub-total');
1306 $total->{'total_amount'} =
1307 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
1309 if ( $multisection ) {
1310 if ( $taxtotal > 0 ) {
1311 # there are taxes, so prepare the section to be displayed.
1312 # $taxtotal already includes any line items that were already in the
1313 # section (fees, taxes that are charged as packages for some reason).
1314 # also set 'summarized' to false so that this isn't a summary-only
1316 $tax_section->{'subtotal'} = $other_money_char.
1317 sprintf('%.2f', $taxtotal);
1318 $tax_section->{'pretotal'} = 'New charges sub-total '.
1319 $total->{'total_amount'};
1320 $tax_section->{'description'} = $self->mt($tax_description);
1321 $tax_section->{'summarized'} = '';
1323 # append it if it's not already there
1324 if ( !grep $tax_section, @sections ) {
1325 push @sections, $tax_section;
1326 push @summary_subtotals, $tax_section;
1331 unshift @total_items, $total;
1334 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1340 my %embolden_functions = (
1341 'latex' => sub { return '\textbf{'. shift(). '}' },
1342 'html' => sub { return '<b>'. shift(). '</b>' },
1343 'template' => sub { shift },
1345 my $embolden_function = $embolden_functions{$format};
1347 if ( $multisection ) {
1349 if ( $adjust_section->{'sort_weight'} ) {
1350 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1351 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1353 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1354 $other_money_char. sprintf('%.2f', $self->charged );
1359 if ( $self->can('_items_total') ) { # should always be true now
1361 # even for multisection, need plain text version
1363 my @new_total_items = $self->_items_total;
1365 push @buf,['','-----------'];
1367 foreach ( @new_total_items ) {
1368 my ($item, $amount) = ($_->{'total_item'}, $_->{'total_amount'});
1369 $_->{'total_item'} = &$embolden_function( $item );
1370 $_->{'total_amount'} = &$embolden_function( $other_money_char.$amount );
1371 # but if it's multisection, don't append to @total_items. the adjust
1372 # section has all this stuff
1373 push @total_items, $_ if !$multisection;
1374 push @buf, [ $item, $money_char.sprintf('%10.2f',$amount) ];
1377 push @buf, [ '', '' ];
1379 # if we're showing previous invoices, also show previous
1380 # credits and payments
1381 if ( $self->enable_previous
1382 and $self->can('_items_credits')
1383 and $self->can('_items_payments') )
1387 my $credittotal = 0;
1388 foreach my $credit (
1389 $self->_items_credits( 'template' => $template, 'trim_len' => 40 )
1393 $total->{'total_item'} = &$escape_function($credit->{'description'});
1394 $credittotal += $credit->{'amount'};
1395 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1396 if ( $multisection ) {
1397 push @detail_items, {
1398 ext_description => [],
1401 description => &$escape_function($credit->{'description'}),
1402 amount => $money_char . $credit->{'amount'},
1404 section => $adjust_section,
1407 push @total_items, $total;
1411 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1414 foreach my $credit (
1415 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1417 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1421 my $paymenttotal = 0;
1422 foreach my $payment (
1423 $self->_items_payments( 'template' => $template )
1426 $total->{'total_item'} = &$escape_function($payment->{'description'});
1427 $paymenttotal += $payment->{'amount'};
1428 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1429 if ( $multisection ) {
1430 push @detail_items, {
1431 ext_description => [],
1434 description => &$escape_function($payment->{'description'}),
1435 amount => $money_char . $payment->{'amount'},
1437 section => $adjust_section,
1440 push @total_items, $total;
1442 push @buf, [ $payment->{'description'},
1443 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1446 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1448 if ( $multisection ) {
1449 $adjust_section->{'subtotal'} = $other_money_char.
1450 sprintf('%.2f', $credittotal + $paymenttotal);
1452 #why this? because {sort_weight} forces the adjust_section to appear
1453 #in @extra_sections instead of @sections. obviously.
1454 push @sections, $adjust_section
1455 unless $adjust_section->{sort_weight};
1456 # do not summarize; adjustments there are shown according to
1460 # create Balance Due message
1463 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1464 $total->{'total_amount'} =
1465 &$embolden_function(
1466 $other_money_char. sprintf('%.2f', #why? $summarypage
1467 # ? $self->charged +
1468 # $self->billing_balance
1470 $self->owed + $pr_total
1473 if ( $multisection && !$adjust_section->{sort_weight} ) {
1474 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1475 $total->{'total_amount'};
1477 push @total_items, $total;
1479 push @buf,['','-----------'];
1480 push @buf,[$self->balance_due_msg, $money_char.
1481 sprintf("%10.2f", $balance_due ) ];
1484 if ( $conf->exists('previous_balance-show_credit')
1485 and $cust_main->balance < 0 ) {
1486 my $credit_total = {
1487 'total_item' => &$embolden_function($self->credit_balance_msg),
1488 'total_amount' => &$embolden_function(
1489 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1492 if ( $multisection ) {
1493 $adjust_section->{'posttotal'} .= $newline_token .
1494 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1497 push @total_items, $credit_total;
1499 push @buf,['','-----------'];
1500 push @buf,[$self->credit_balance_msg, $money_char.
1501 sprintf("%10.2f", -$cust_main->balance ) ];
1505 } #end of default total adding ! can('_items_total')
1507 if ( $multisection ) {
1508 if ( $conf->exists('svc_phone_sections')
1509 && $self->can('_items_svc_phone_sections')
1513 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1514 $total->{'total_amount'} =
1515 &$embolden_function(
1516 $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
1518 my $last_section = pop @sections;
1519 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1520 $total->{'total_amount'};
1521 push @sections, $last_section;
1523 push @sections, @$late_sections
1527 # make a discounts-available section, even without multisection
1528 if ( $conf->exists('discount-show_available')
1529 and my @discounts_avail = $self->_items_discounts_avail ) {
1530 my $discount_section = {
1531 'description' => $self->mt('Discounts Available'),
1536 push @sections, $discount_section; # do not summarize
1537 push @detail_items, map { +{
1538 'ref' => '', #should this be something else?
1539 'section' => $discount_section,
1540 'description' => &$escape_function( $_->{description} ),
1541 'amount' => $money_char . &$escape_function( $_->{amount} ),
1542 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1543 } } @discounts_avail;
1546 # not adding any more sections after this
1547 $invoice_data{summary_subtotals} = \@summary_subtotals;
1550 if ( $conf->exists('usage_class_summary')
1551 and $self->can('_items_usage_class_summary') ) {
1552 my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function, 'money_char' => $other_money_char);
1553 if ( @usage_subtotals ) {
1554 unshift @sections, $usage_subtotals[0]->{section}; # do not summarize
1555 unshift @detail_items, @usage_subtotals;
1559 # invoice history "section" (not really a section)
1560 # not to be included in any subtotals, completely independent of
1562 if ( $conf->exists('previous_invoice_history') and $cust_main->isa('FS::cust_main') ) {
1565 foreach my $cust_bill ( $cust_main->cust_bill ) {
1566 # XXX hardcoded format, and currently only 'charged'; add other fields
1567 # if they become necessary
1568 my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1569 $history{$date} ||= 0;
1570 $history{$date} += $cust_bill->charged;
1571 # just so we have a numeric sort key
1572 $monthorder{$date} ||= $cust_bill->_date;
1574 my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1576 my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1577 $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1580 # service locations: another option for template customization
1582 foreach my $item (@detail_items) {
1583 if ( $item->{locationnum} ) {
1584 $location_info{ $item->{locationnum} } ||= {
1585 FS::cust_location->by_key( $item->{locationnum} )->location_hash
1589 $invoice_data{location_info} = \%location_info;
1591 # debugging hook: call this with 'diag' => 1 to just get a hash of
1592 # the invoice variables
1593 return \%invoice_data if ( $params{'diag'} );
1595 # All sections and items are built; now fill in templates.
1596 my @includelist = ();
1597 push @includelist, 'summary' if $summarypage;
1598 foreach my $include ( @includelist ) {
1600 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1603 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1605 @inc_src = $conf->config($inc_file, $agentnum);
1609 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1611 my $convert_map = $convert_maps{$format}{$include};
1613 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1614 s/--\@\]/$delimiters{$format}[1]/g;
1617 &$convert_map( $conf->config($inc_file, $agentnum) );
1621 my $inc_tt = new Text::Template (
1623 SOURCE => [ map "$_\n", @inc_src ],
1624 DELIMITERS => $delimiters{$format},
1625 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1627 unless ( $inc_tt->compile() ) {
1628 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1629 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1633 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1635 $invoice_data{$include} =~ s/\n+$//
1636 if ($format eq 'latex');
1641 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1642 /invoice_lines\((\d*)\)/;
1643 $invoice_lines += $1 || scalar(@buf);
1646 die "no invoice_lines() functions in template?"
1647 if ( $format eq 'template' && !$wasfunc );
1649 if ( $invoice_lines ) {
1650 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1651 $invoice_data{'total_pages'}++
1652 if scalar(@buf) % $invoice_lines;
1655 #setup subroutine for the template
1656 $invoice_data{invoice_lines} = sub {
1657 my $lines = shift || scalar(@buf);
1666 if ($format eq 'template') {
1671 push @collect, split("\n",
1672 $text_template->fill_in( HASH => \%invoice_data )
1674 $invoice_data{'page'}++;
1676 map "$_\n", @collect;
1678 } else { # this is where we actually create the invoice
1680 if ( $params{no_addresses} ) {
1681 delete $invoice_data{$_} foreach qw(
1682 payname company address1 address2 city state zip country
1684 $invoice_data{returnaddress} = '~';
1687 warn "filling in template for invoice ". $self->invnum. "\n"
1689 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1692 $text_template->fill_in(HASH => \%invoice_data);
1696 sub notice_name { '('.shift->table.')'; }
1698 # this is not supposed to happen
1699 sub template_conf { warn "bare FS::Template_Mixin::template_conf";
1703 # helper routine for generating date ranges
1704 sub _prior_month30s {
1707 [ 1, 2592000 ], # 0-30 days ago
1708 [ 2592000, 5184000 ], # 30-60 days ago
1709 [ 5184000, 7776000 ], # 60-90 days ago
1710 [ 7776000, 0 ], # 90+ days ago
1713 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
1714 $_->[1] ? $self->_date - $_->[1] - 1 : '',
1719 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1721 Returns an postscript invoice, as a scalar.
1723 Options can be passed as a hashref (recommended) or as a list of time, template
1724 and then any key/value pairs for any other options.
1726 I<time> an optional value used to control the printing of overdue messages. The
1727 default is now. It isn't the date of the invoice; that's the `_date' field.
1728 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1729 L<Time::Local> and L<Date::Parse> for conversion functions.
1731 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1738 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1739 my $ps = generate_ps($file);
1741 unlink($barcodefile) if $barcodefile;
1746 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1748 Returns an PDF invoice, as a scalar.
1750 Options can be passed as a hashref (recommended) or as a list of time, template
1751 and then any key/value pairs for any other options.
1753 I<time> an optional value used to control the printing of overdue messages. The
1754 default is now. It isn't the date of the invoice; that's the `_date' field.
1755 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1756 L<Time::Local> and L<Date::Parse> for conversion functions.
1758 I<template>, if specified, is the name of a suffix for alternate invoices.
1760 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1767 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1768 my $pdf = generate_pdf($file);
1770 unlink($barcodefile) if $barcodefile;
1775 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1777 Returns an HTML invoice, as a scalar.
1779 I<time> an optional value used to control the printing of overdue messages. The
1780 default is now. It isn't the date of the invoice; that's the `_date' field.
1781 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1782 L<Time::Local> and L<Date::Parse> for conversion functions.
1784 I<template>, if specified, is the name of a suffix for alternate invoices.
1786 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1788 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1789 when emailing the invoice as part of a multipart/related MIME email.
1797 %params = %{ shift() };
1801 $params{'format'} = 'html';
1803 $self->print_generic( %params );
1806 # quick subroutine for print_latex
1808 # There are ten characters that LaTeX treats as special characters, which
1809 # means that they do not simply typeset themselves:
1810 # # $ % & ~ _ ^ \ { }
1812 # TeX ignores blanks following an escaped character; if you want a blank (as
1813 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1817 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1818 $value =~ s/([<>])/\$$1\$/g;
1824 encode_entities($value);
1828 sub _html_escape_nbsp {
1829 my $value = _html_escape(shift);
1830 $value =~ s/ +/ /g;
1834 #utility methods for print_*
1836 sub _translate_old_latex_format {
1837 warn "_translate_old_latex_format called\n"
1844 if ( $line =~ /^%%Detail\s*$/ ) {
1846 push @template, q![@--!,
1847 q! foreach my $_tr_line (@detail_items) {!,
1848 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1849 q! $_tr_line->{'description'} .= !,
1850 q! "\\tabularnewline\n~~".!,
1851 q! join( "\\tabularnewline\n~~",!,
1852 q! @{$_tr_line->{'ext_description'}}!,
1856 while ( ( my $line_item_line = shift )
1857 !~ /^%%EndDetail\s*$/ ) {
1858 $line_item_line =~ s/'/\\'/g; # nice LTS
1859 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1860 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1861 push @template, " \$OUT .= '$line_item_line';";
1864 push @template, '}',
1867 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1869 push @template, '[@--',
1870 ' foreach my $_tr_line (@total_items) {';
1872 while ( ( my $total_item_line = shift )
1873 !~ /^%%EndTotalDetails\s*$/ ) {
1874 $total_item_line =~ s/'/\\'/g; # nice LTS
1875 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1876 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1877 push @template, " \$OUT .= '$total_item_line';";
1880 push @template, '}',
1884 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1885 push @template, $line;
1891 warn "$_\n" foreach @template;
1903 my $conf = $self->conf;
1905 #check for an invoice-specific override
1906 return $self->invoice_terms if $self->invoice_terms;
1908 #check for a customer- specific override
1909 my $cust_main = $self->cust_main;
1910 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1914 $agentnum = $cust_main->agentnum;
1915 } elsif ( my $prospect_main = $self->prospect_main ) {
1916 $agentnum = $prospect_main->agentnum;
1919 #use configured default
1920 $conf->config('invoice_default_terms', $agentnum) || '';
1930 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1931 $duedate = $self->_date() + ( $1 * 86400 );
1932 } elsif ( $self->terms =~ /^End of Month$/ ) {
1933 my ($mon,$year) = (localtime($self->_date) )[4,5];
1935 until ( $mon < 12 ) { $mon -= 12; $year++; }
1936 my $nextmonth_first = timelocal(0,0,0,1,$mon,$year);
1937 $duedate = $nextmonth_first - 86400;
1948 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
1951 =item balance_due_msg
1955 sub balance_due_msg {
1957 my $msg = $self->mt('Balance Due');
1958 return $msg unless $self->terms; # huh?
1959 if ( !$self->conf->exists('invoice_show_prior_due_date')
1960 or $self->conf->exists('invoice_sections') ) {
1961 # if enabled, the due date is shown with Total New Charges (see
1962 # _items_total) and not here
1963 # (yes, or if invoice_sections is enabled; this is just for compatibility)
1964 if ( $self->due_date ) {
1966 $self->conf->config('invoice_pay_by_msg', $self->agentnum)
1967 || 'Please pay by [_1]';
1968 $msg .= ' - ' . $self->mt($please_pay_by, $self->due_date2str('short')).
1970 unless $self->conf->config_bool('invoice_omit_due_date',$self->agentnum);
1971 } elsif ( $self->terms ) {
1972 $msg .= ' - '. $self->mt($self->terms);
1978 =item balance_due_date
1982 sub balance_due_date {
1984 my $conf = $self->conf;
1986 my $terms = $self->terms;
1987 if ( $terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1988 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
1993 sub credit_balance_msg {
1995 $self->mt('Credit Balance Remaining')
2000 Returns a string with the date, for example: "3/20/2008", localized for the
2001 customer. Use _date_pretty_unlocalized for non-end-customer display use.
2007 $self->time2str_local('short', $self->_date);
2010 =item _date_pretty_unlocalized
2012 Returns a string with the date, for example: "3/20/2008", in the format
2013 configured for the back-office. Use _date_pretty for end-customer display use.
2017 sub _date_pretty_unlocalized {
2019 time2str($date_format, $self->_date);
2024 Emails this template.
2026 Options are passed as a hashref. Available options:
2032 If specified, overrides the default From: address.
2036 If specified, overrides the name of the sent document ("Invoice" or "Quotation")
2040 (Deprecated) If specified, is the name of a suffix for alternate template files.
2044 Options accepted by generate_email can also be used.
2050 my $opt = shift || {};
2051 if ($opt and !ref($opt)) {
2052 die ref($self). '->email called with positional parameters';
2055 return if $self->hide;
2057 my $error = send_email(
2058 $self->generate_email(
2059 'subject' => $self->email_subject($opt->{template}),
2060 %$opt, # template, etc.
2064 die "can't email: $error\n" if $error;
2067 =item generate_email OPTION => VALUE ...
2075 sender address, required
2079 alternate template name, optional
2083 email subject, optional
2087 notice name instead of "Invoice", optional
2091 Returns an argument list to be passed to L<FS::Misc::send_email>.
2097 sub generate_email {
2101 my $conf = $self->conf;
2103 my $me = '[FS::Template_Mixin::generate_email]';
2106 'from' => $args{'from'},
2107 'subject' => ($args{'subject'} || $self->email_subject),
2108 'custnum' => $self->custnum,
2109 'msgtype' => 'invoice',
2112 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
2114 my $cust_main = $self->cust_main;
2116 if (ref($args{'to'}) eq 'ARRAY') {
2117 $return{'to'} = $args{'to'};
2118 } elsif ( $cust_main ) {
2119 $return{'to'} = [ $cust_main->invoicing_list_emailonly ];
2122 my $tc = $self->template_conf;
2124 my @text; # array of lines
2125 my $html; # a big string
2126 my @related_parts; # will contain the text/HTML alternative, and images
2127 my $related; # will contain the multipart/related object
2129 if ( $conf->exists($tc. 'email_pdf') ) {
2130 if ( my $msgnum = $conf->config($tc.'email_pdf_msgnum') ) {
2132 warn "$me using '${tc}email_pdf_msgnum' in multipart message"
2135 my $msg_template = FS::msg_template->by_key($msgnum)
2136 or die "${tc}email_pdf_msgnum $msgnum not found\n";
2137 my $cust_msg = $msg_template->prepare(
2138 cust_main => $self->cust_main,
2140 msgtype => 'invoice',
2143 # XXX hack to make this work in the new cust_msg era; consider replacing
2144 # with cust_bill_send_with_notice events.
2145 my @parts = $cust_msg->parts;
2146 foreach my $part (@parts) { # will only have two parts, normally
2147 if ( $part->mime_type eq 'text/plain' ) {
2148 @text = @{ $part->body };
2149 } elsif ( $part->mime_type eq 'text/html' ) {
2150 $html = $part->bodyhandle->as_string;
2154 } elsif ( my @note = $conf->config($tc.'email_pdf_note') ) {
2156 warn "$me using '${tc}email_pdf_note' in multipart message"
2158 @text = $conf->config($tc.'email_pdf_note');
2159 $html = join('<BR>', @text);
2161 } # else use the plain text invoice
2166 if ( $conf->config($tc.'template') ) {
2168 warn "$me generating plain text invoice"
2171 # 'print_text' argument is no longer used
2172 @text = $self->print_text(\%args);
2176 warn "$me no plain text version exists; sending empty message body"
2183 my $text_part = build MIME::Entity (
2184 'Type' => 'text/plain',
2185 'Encoding' => 'quoted-printable',
2186 'Charset' => 'UTF-8',
2187 #'Encoding' => '7bit',
2189 'Disposition' => 'inline',
2194 if ( $conf->exists($tc.'html') ) {
2195 warn "$me generating HTML invoice"
2198 $args{'from'} =~ /\@([\w\.\-]+)/;
2199 my $from = $1 || 'example.com';
2200 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2203 my $agentnum = $cust_main ? $cust_main->agentnum
2204 : $self->prospect_main->agentnum;
2205 if ( defined($args{'template'}) && length($args{'template'})
2206 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
2209 $logo = 'logo_'. $args{'template'}. '.png';
2213 my $image_data = $conf->config_binary( $logo, $agentnum);
2215 push @related_parts, build MIME::Entity
2216 'Type' => 'image/png',
2217 'Encoding' => 'base64',
2218 'Data' => $image_data,
2219 'Filename' => 'logo.png',
2220 'Content-ID' => "<$content_id>",
2223 if ( ref($self) eq 'FS::cust_bill' && $conf->exists('invoice-barcode') ) {
2224 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2225 push @related_parts, build MIME::Entity
2226 'Type' => 'image/png',
2227 'Encoding' => 'base64',
2228 'Data' => $self->invoice_barcode(0),
2229 'Filename' => 'barcode.png',
2230 'Content-ID' => "<$barcode_content_id>",
2232 $args{'barcode_cid'} = $barcode_content_id;
2235 $html = $self->print_html({ 'cid'=>$content_id, %args });
2242 warn "$me creating HTML/text multipart message"
2245 $return{'nobody'} = 1;
2247 my $alternative = build MIME::Entity
2248 'Type' => 'multipart/alternative',
2249 #'Encoding' => '7bit',
2250 'Disposition' => 'inline'
2254 $alternative->add_part($text_part);
2257 $alternative->attach(
2258 'Type' => 'text/html',
2259 'Encoding' => 'quoted-printable',
2260 'Data' => [ '<html>',
2263 ' '. encode_entities($return{'subject'}),
2266 ' <body bgcolor="#e8e8e8">',
2271 'Disposition' => 'inline',
2272 #'Filename' => 'invoice.pdf',
2275 unshift @related_parts, $alternative;
2277 $related = build MIME::Entity 'Type' => 'multipart/related',
2278 'Encoding' => '7bit';
2280 #false laziness w/Misc::send_email
2281 $related->head->replace('Content-type',
2282 $related->mime_type.
2283 '; boundary="'. $related->head->multipart_boundary. '"'.
2284 '; type=multipart/alternative'
2287 $related->add_part($_) foreach @related_parts;
2291 my @otherparts = ();
2292 if ( ref($self) eq 'FS::cust_bill' && $cust_main->email_csv_cdr ) {
2294 if ( $conf->config('voip-cdr_email_attach') eq 'zip' ) {
2296 my $data = join('', map "$_\n",
2297 $self->call_details(prepend_billed_number=>1)
2300 my $zip = new Archive::Zip;
2301 my $file = $zip->addString( $data, 'usage-'.$self->invnum.'.csv' );
2302 $file->desiredCompressionMethod( COMPRESSION_DEFLATED );
2305 my $SH = IO::Scalar->new(\$zipdata);
2306 my $status = $zip->writeToFileHandle($SH);
2307 die "Error zipping CDR attachment: $!" unless $status == AZ_OK;
2309 push @otherparts, build MIME::Entity
2310 'Type' => 'application/zip',
2311 'Encoding' => 'base64',
2313 'Disposition' => 'attachment',
2314 'Filename' => 'usage-'. $self->invnum. '.zip',
2317 } else { # } elsif ( $conf->config('voip-cdr_email_attach') eq 'csv' ) {
2319 push @otherparts, build MIME::Entity
2320 'Type' => 'text/csv',
2321 'Encoding' => '7bit',
2322 'Data' => [ map { "$_\n" }
2323 $self->call_details('prepend_billed_number' => 1)
2325 'Disposition' => 'attachment',
2326 'Filename' => 'usage-'. $self->invnum. '.csv',
2333 if ( $conf->exists($tc.'email_pdf') ) {
2338 # multipart/alternative
2344 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
2345 push @otherparts, $pdf;
2349 $return{'content-type'} = 'multipart/mixed'; # of the outer container
2351 $return{'mimeparts'} = [ $related, @otherparts ];
2352 $return{'type'} = 'multipart/related'; # of the first part
2354 $return{'mimeparts'} = [ $text_part, @otherparts ];
2355 $return{'type'} = 'text/plain';
2357 } elsif ( $html ) { # no PDF or CSV, strip the outer container
2358 $return{'mimeparts'} = \@related_parts;
2359 $return{'content-type'} = 'multipart/related';
2360 $return{'type'} = 'multipart/alternative';
2361 } else { # no HTML either
2362 $return{'body'} = \@text;
2363 $return{'content-type'} = 'text/plain';
2372 Returns a list suitable for passing to MIME::Entity->build(), representing
2373 this quotation or invoice as PDF attachment.
2380 'Type' => 'application/pdf',
2381 'Encoding' => 'base64',
2382 'Data' => [ $self->print_pdf(@_) ],
2383 'Disposition' => 'attachment',
2384 'Filename' => $self->pdf_filename,
2388 =item postal_mail_fsinc
2390 Sends this invoice to the Freeside Internet Services, Inc. print and mail
2396 use IO::Socket::SSL;
2398 use HTTP::Request::Common qw( POST );
2399 use Cpanel::JSON::XS;
2401 sub postal_mail_fsinc {
2402 my ( $self, %opt ) = @_;
2404 my $url = 'https://ws.freeside.biz/print';
2406 my $cust_main = $self->cust_main;
2407 my $agentnum = $cust_main->agentnum;
2408 my $bill_location = $cust_main->bill_location;
2410 die "Extra charges for international mailing; contact support\@freeside.biz to enable\n"
2411 if $bill_location->country ne 'US';
2413 my $conf = new FS::Conf;
2415 my @company_address = $conf->config('company_address', $agentnum);
2416 my ( $company_address1, $company_address2, $company_city, $company_state, $company_zip );
2417 if ( $company_address[2] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2418 $company_address1 = $company_address[0];
2419 $company_address2 = $company_address[1];
2421 $company_state = $2;
2423 } elsif ( $company_address[1] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2424 $company_address1 = $company_address[0];
2425 $company_address2 = '';
2427 $company_state = $2;
2430 die "Unparsable company_address; contact support\@freeside.biz\n";
2432 $company_city =~ s/,$//;
2434 my $file = $self->print_pdf(%opt, 'no_addresses' => 1);
2435 my $pages = CAM::PDF->new($file)->numPages;
2437 my $ua = LWP::UserAgent->new(
2439 verify_hostname => 0,
2440 SSL_verify_mode => IO::Socket::SSL::SSL_VERIFY_NONE,
2441 SSL_version => 'SSLv3',
2444 my $response = $ua->request( POST $url, [
2445 'support-key' => scalar($conf->config('support-key')),
2446 'file' => encode_base64($file),
2450 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
2451 'company_address1' => $company_address1,
2452 'company_address2' => $company_address2,
2453 'company_city' => $company_city,
2454 'company_state' => $company_state,
2455 'company_zip' => $company_zip,
2456 'company_country' => 'US',
2457 'company_phonenum' => scalar($conf->config('company_phonenum', $agentnum)),
2458 'company_email' => scalar($conf->config('invoice_from', $agentnum)),
2461 'name' => $cust_main->invoice_attn
2462 || $cust_main->contact_firstlast,
2463 'company' => $cust_main->company,
2464 'address1' => $bill_location->address1,
2465 'address2' => $bill_location->address2,
2466 'city' => $bill_location->city,
2467 'state' => $bill_location->state,
2468 'zip' => $bill_location->zip,
2469 'country' => $bill_location->country,
2472 die "Print connection error: ". $response->message.
2473 ' ('. $response->as_string. ")\n"
2474 unless $response->is_success;
2477 my $content = eval { decode_json($response->content) };
2478 die "Print JSON error : $@\n" if $@;
2480 die $content->{error}."\n"
2481 if $content->{error};
2483 #TODO: store this so we can query for a status later
2484 warn "Invoice printed, ID ". $content->{id}. "\n";
2490 =item _items_sections OPTIONS
2492 Generate section information for all items appearing on this invoice.
2493 This will only be called for multi-section invoices.
2495 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
2496 related display records (L<FS::cust_bill_pkg_display>) and organize
2497 them into two groups ("early" and "late" according to whether they come
2498 before or after the total), then into sections. A subtotal is calculated
2501 Section descriptions are returned in sort weight order. Each consists
2502 of a hash containing:
2504 description: the package category name, escaped
2505 subtotal: the total charges in that section
2506 tax_section: a flag indicating that the section contains only tax charges
2507 summarized: same as tax_section, for some reason
2508 sort_weight: the package category's sort weight
2510 If 'condense' is set on the display record, it also contains everything
2511 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
2512 coderefs to generate parts of the invoice. This is not advised.
2514 The method returns two arrayrefs, one of "early" sections and one of "late"
2517 OPTIONS may include:
2519 by_location: a flag to divide the invoice into sections by location.
2520 Each section hash will have a 'location' element containing a hashref of
2521 the location fields (see L<FS::cust_location>). The section description
2522 will be the location label, but the template can use any of the location
2523 fields to create a suitable label.
2525 by_category: a flag to divide the invoice into sections using display
2526 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
2527 behavior. Each section hash will have a 'category' element containing
2528 the section name from the display record (which probably equals the
2529 category name of the package, but may not in some cases).
2531 summary: a flag indicating that this is a summary-format invoice.
2532 Turning this on has the following effects:
2533 - Ignores display items with the 'summary' flag.
2534 - Places all sections in the "early" group even if they have post_total.
2535 - Creates sections for all non-disabled package categories, even if they
2536 have no charges on this invoice, as well as a section with no name.
2538 escape: an escape function to use for section titles.
2540 extra_sections: an arrayref of additional sections to return after the
2541 sorted list. If there are any of these, section subtotals exclude
2544 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
2545 passed through to C<_condense_section()>.
2549 use vars qw(%pkg_category_cache);
2550 sub _items_sections {
2554 my $escape = $opt{escape};
2555 my @extra_sections = @{ $opt{extra_sections} || [] };
2557 # $subtotal{$locationnum}{$categoryname} = amount.
2558 # if we're not using by_location, $locationnum is undef.
2559 # if we're not using by_category, you guessed it, $categoryname is undef.
2560 # if we're not using either one, we shouldn't be here in the first place...
2562 my %late_subtotal = ();
2565 # About tax items + multisection invoices:
2566 # If either invoice_*summary option is enabled, AND there is a
2567 # package category with the name of the tax, then there will be
2568 # a display record assigning the tax item to that category.
2570 # However, the taxes are always placed in the "Taxes, Surcharges,
2571 # and Fees" section regardless of that. The only effect of the
2572 # display record is to create a subtotal for the summary page.
2575 my $pkg_hash = $self->cust_pkg_hash;
2577 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2580 my $usage = $cust_bill_pkg->usage;
2583 if ( $opt{by_location} ) {
2584 if ( $cust_bill_pkg->pkgnum ) {
2585 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2590 $locationnum = undef;
2593 # as in _items_cust_pkg, if a line item has no display records,
2594 # cust_bill_pkg_display() returns a default record for it
2596 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2597 next if ( $display->summary && $opt{summary} );
2599 my $section = $display->section;
2600 my $type = $display->type;
2601 # Set $section = undef if we're sectioning by location and this
2602 # line item _has_ a location (i.e. isn't a fee).
2603 $section = undef if $locationnum;
2605 # set this flag if the section is not tax-only
2606 $not_tax{$locationnum}{$section} = 1
2607 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
2609 # there's actually a very important piece of logic buried in here:
2610 # incrementing $late_subtotal{$section} CREATES
2611 # $late_subtotal{$section}. keys(%late_subtotal) is later used
2612 # to define the list of late sections, and likewise keys(%subtotal).
2613 # When _items_cust_bill_pkg is called to generate line items for
2614 # real, it will be called with 'section' => $section for each
2616 if ( $display->post_total && !$opt{summary} ) {
2617 if (! $type || $type eq 'S') {
2618 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2619 if $cust_bill_pkg->setup != 0
2620 || $cust_bill_pkg->setup_show_zero;
2624 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
2625 if $cust_bill_pkg->recur != 0
2626 || $cust_bill_pkg->recur_show_zero;
2629 if ($type && $type eq 'R') {
2630 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2631 if $cust_bill_pkg->recur != 0
2632 || $cust_bill_pkg->recur_show_zero;
2635 if ($type && $type eq 'U') {
2636 $late_subtotal{$locationnum}{$section} += $usage
2637 unless scalar(@extra_sections);
2640 } else { # it's a pre-total (normal) section
2642 # skip tax items unless they're explicitly included in a section
2643 next if $cust_bill_pkg->pkgnum == 0 and
2644 ! $cust_bill_pkg->feepart and
2647 if ( $type eq 'S' ) {
2648 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2649 if $cust_bill_pkg->setup != 0
2650 || $cust_bill_pkg->setup_show_zero;
2651 } elsif ( $type eq 'R' ) {
2652 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2653 if $cust_bill_pkg->recur != 0
2654 || $cust_bill_pkg->recur_show_zero;
2655 } elsif ( $type eq 'U' ) {
2656 $subtotal{$locationnum}{$section} += $usage
2657 unless scalar(@extra_sections);
2658 } elsif ( !$type ) {
2659 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2660 + $cust_bill_pkg->recur;
2669 %pkg_category_cache = ();
2671 # summary invoices need subtotals for all non-disabled package categories,
2672 # even if they're zero
2673 # but currently assume that there are no location sections, or at least
2674 # that the summary page doesn't care about them
2675 if ( $opt{summary} ) {
2676 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2677 $subtotal{''}{$category->categoryname} ||= 0;
2679 $subtotal{''}{''} ||= 0;
2683 foreach my $post_total (0,1) {
2685 my $s = $post_total ? \%late_subtotal : \%subtotal;
2686 foreach my $locationnum (keys %$s) {
2687 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2689 'subtotal' => $s->{$locationnum}{$sectionname},
2692 if ( $locationnum ) {
2693 $section->{'locationnum'} = $locationnum;
2694 my $location = FS::cust_location->by_key($locationnum);
2695 $section->{'description'} = &{ $escape }($location->location_label);
2696 # Better ideas? This will roughly group them by proximity,
2697 # which alpha sorting on any of the address fields won't.
2698 # Sorting by locationnum is meaningless.
2699 # We have to sort on _something_ or the order may change
2700 # randomly from one invoice to the next, which will confuse
2702 $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
2704 $section->{'location'} = {
2705 label_prefix => &{ $escape }($location->label_prefix),
2706 map { $_ => &{ $escape }($location->get($_)) }
2710 $section->{'category'} = $sectionname;
2711 $section->{'description'} = &{ $escape }($sectionname);
2712 if ( _pkg_category($sectionname) ) {
2713 $section->{'sort_weight'} = _pkg_category($sectionname)->weight;
2714 if ( _pkg_category($sectionname)->condense ) {
2715 $section = { %$section, $self->_condense_section($opt{format}) };
2719 if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
2720 # then it's a tax-only section
2721 $section->{'summarized'} = 'Y';
2722 $section->{'tax_section'} = 'Y';
2724 push @these, $section;
2725 } # foreach $sectionname
2726 } #foreach $locationnum
2727 push @these, @extra_sections if $post_total == 0;
2728 # need an alpha sort for location sections, because postal codes can
2730 $sections[ $post_total ] = [ sort {
2731 $opt{'by_location'} ?
2732 ($a->{sort_weight} cmp $b->{sort_weight}) :
2733 ($a->{sort_weight} <=> $b->{sort_weight})
2735 } #foreach $post_total
2737 return @sections; # early, late
2740 #helper subs for above
2744 $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2748 my $categoryname = shift;
2749 $pkg_category_cache{$categoryname} ||=
2750 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2753 my %condensed_format = (
2754 'label' => [ qw( Description Qty Amount ) ],
2756 sub { shift->{description} },
2757 sub { shift->{quantity} },
2758 sub { my($href, %opt) = @_;
2759 ($opt{dollar} || ''). $href->{amount};
2762 'align' => [ qw( l r r ) ],
2763 'span' => [ qw( 5 1 1 ) ], # unitprices?
2764 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
2767 sub _condense_section {
2768 my ( $self, $format ) = ( shift, shift );
2770 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2771 qw( description_generator
2774 total_line_generator
2779 sub _condensed_generator_defaults {
2780 my ( $self, $format ) = ( shift, shift );
2781 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2790 sub _condensed_header_generator {
2791 my ( $self, $format ) = ( shift, shift );
2793 my ( $f, $prefix, $suffix, $separator, $column ) =
2794 _condensed_generator_defaults($format);
2796 if ($format eq 'latex') {
2797 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2798 $suffix = "\\\\\n\\hline";
2801 sub { my ($d,$a,$s,$w) = @_;
2802 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2804 } elsif ( $format eq 'html' ) {
2805 $prefix = '<th></th>';
2809 sub { my ($d,$a,$s,$w) = @_;
2810 return qq!<th align="$html_align{$a}">$d</th>!;
2818 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2820 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2823 $prefix. join($separator, @result). $suffix;
2828 sub _condensed_description_generator {
2829 my ( $self, $format ) = ( shift, shift );
2831 my ( $f, $prefix, $suffix, $separator, $column ) =
2832 _condensed_generator_defaults($format);
2834 my $money_char = '$';
2835 if ($format eq 'latex') {
2836 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2838 $separator = " & \n";
2840 sub { my ($d,$a,$s,$w) = @_;
2841 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2843 $money_char = '\\dollar';
2844 }elsif ( $format eq 'html' ) {
2845 $prefix = '"><td align="center"></td>';
2849 sub { my ($d,$a,$s,$w) = @_;
2850 return qq!<td align="$html_align{$a}">$d</td>!;
2852 #$money_char = $conf->config('money_char') || '$';
2853 $money_char = ''; # this is madness
2861 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2863 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2865 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2866 map { $f->{$_}->[$i] } qw(align span width)
2870 $prefix. join( $separator, @result ). $suffix;
2875 sub _condensed_total_generator {
2876 my ( $self, $format ) = ( shift, shift );
2878 my ( $f, $prefix, $suffix, $separator, $column ) =
2879 _condensed_generator_defaults($format);
2882 if ($format eq 'latex') {
2885 $separator = " & \n";
2887 sub { my ($d,$a,$s,$w) = @_;
2888 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2890 }elsif ( $format eq 'html' ) {
2894 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2896 sub { my ($d,$a,$s,$w) = @_;
2897 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2906 # my $r = &{$f->{fields}->[$i]}(@args);
2907 # $r .= ' Total' unless $i;
2909 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2911 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
2912 map { $f->{$_}->[$i] } qw(align span width)
2916 $prefix. join( $separator, @result ). $suffix;
2921 =item total_line_generator FORMAT
2923 Returns a coderef used for generation of invoice total line items for this
2924 usage_class. FORMAT is either html or latex
2928 # should not be used: will have issues with hash element names (description vs
2929 # total_item and amount vs total_amount -- another array of functions?
2931 sub _condensed_total_line_generator {
2932 my ( $self, $format ) = ( shift, shift );
2934 my ( $f, $prefix, $suffix, $separator, $column ) =
2935 _condensed_generator_defaults($format);
2938 if ($format eq 'latex') {
2941 $separator = " & \n";
2943 sub { my ($d,$a,$s,$w) = @_;
2944 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2946 }elsif ( $format eq 'html' ) {
2950 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2952 sub { my ($d,$a,$s,$w) = @_;
2953 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2962 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2964 &{$column}( &{$f->{fields}->[$i]}(@args),
2965 map { $f->{$_}->[$i] } qw(align span width)
2969 $prefix. join( $separator, @result ). $suffix;
2974 =item _items_pkg [ OPTIONS ]
2976 Return line item hashes for each package item on this invoice. Nearly
2979 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
2981 OPTIONS are passed through to _items_cust_bill_pkg, and should include
2982 'format' and 'escape_function' at minimum.
2984 To produce items for a specific invoice section, OPTIONS should include
2985 'section', a hashref containing 'category' and/or 'locationnum' keys.
2987 'section' may also contain a key named 'condensed'. If this is present
2988 and has a true value, _items_pkg will try to merge identical items into items
2989 with 'quantity' equal to the number of items (not the sum of their separate
2990 quantities, for some reason).
2996 # The order of these is important. Bundled line items will be merged into
2997 # the most recent non-hidden item, so it needs to be the one with:
2999 # - the same start date
3000 # - no pkgpart_override
3002 # So: sort by pkgnum,
3004 # then sort the base line item before any overrides
3005 # then sort hidden before non-hidden add-ons
3006 # then sort by override pkgpart (for consistency)
3007 sort { $a->pkgnum <=> $b->pkgnum or
3008 $a->sdate <=> $b->sdate or
3009 ($a->pkgpart_override ? 0 : -1) or
3010 ($b->pkgpart_override ? 0 : 1) or
3011 $b->hidden cmp $a->hidden or
3012 $a->pkgpart_override <=> $b->pkgpart_override
3014 # and of course exclude taxes and fees
3015 grep { $_->pkgnum > 0 } $self->cust_bill_pkg;
3021 my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
3022 my $escape_function = $options{escape_function};
3025 foreach my $cust_bill_pkg (@cust_bill_pkg) {
3026 # cache this, so we don't look it up again in every section
3027 my $part_fee = $cust_bill_pkg->get('part_fee')
3028 || $cust_bill_pkg->part_fee;
3029 $cust_bill_pkg->set('part_fee', $part_fee);
3031 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
3032 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
3035 if ( exists($options{section}) and exists($options{section}{category}) )
3037 my $categoryname = $options{section}{category};
3038 # then filter for items that have that section
3039 if ( $part_fee->categoryname ne $categoryname ) {
3040 warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
3043 } # otherwise include them all in the main section
3044 # XXX what to do when sectioning by location?
3047 my %base_invnums; # invnum => invoice date
3048 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
3049 if ($_->base_invnum) {
3050 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
3051 my $base_date = $self->time2str_local('short', $base_bill->_date)
3053 $base_invnums{$_->base_invnum} = $base_date || '';
3056 foreach (sort keys(%base_invnums)) {
3057 next if $_ == $self->invnum;
3058 # per convention, we must escape ext_description lines
3060 &{$escape_function}(
3061 $self->mt('from invoice #[_1] on [_2]', $_, $base_invnums{$_})
3064 my $desc = $part_fee->itemdesc_locale($self->cust_main->locale);
3065 # but not escape the base description line
3068 { feepart => $cust_bill_pkg->feepart,
3069 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
3070 description => $desc,
3071 ext_description => \@ext_desc
3082 warn "$me _items_pkg searching for all package line items\n"
3085 my @cust_bill_pkg = $self->_items_nontax;
3087 warn "$me _items_pkg filtering line items\n"
3089 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3091 if ($options{section} && $options{section}->{condensed}) {
3093 warn "$me _items_pkg condensing section\n"
3097 local $Storable::canonical = 1;
3098 foreach ( @items ) {
3100 delete $item->{ref};
3101 delete $item->{ext_description};
3102 my $key = freeze($item);
3103 $itemshash{$key} ||= 0;
3104 $itemshash{$key} ++; # += $item->{quantity};
3106 @items = sort { $a->{description} cmp $b->{description} }
3107 map { my $i = thaw($_);
3108 $i->{quantity} = $itemshash{$_};
3110 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
3116 warn "$me _items_pkg returning ". scalar(@items). " items\n"
3123 return 0 unless $a->itemdesc cmp $b->itemdesc;
3124 return -1 if $b->itemdesc eq 'Tax';
3125 return 1 if $a->itemdesc eq 'Tax';
3126 return -1 if $b->itemdesc eq 'Other surcharges';
3127 return 1 if $a->itemdesc eq 'Other surcharges';
3128 $a->itemdesc cmp $b->itemdesc;
3133 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
3134 $self->cust_bill_pkg;
3135 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3137 if ( $self->conf->exists('always_show_tax') ) {
3138 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
3139 if (0 == grep { $_->{description} eq $itemdesc } @items) {
3141 { 'description' => $itemdesc,
3148 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
3150 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
3151 list of hashrefs describing the line items they generate on the invoice.
3153 OPTIONS may include:
3155 format: the invoice format.
3157 escape_function: the function used to escape strings.
3159 DEPRECATED? (expensive, mostly unused?)
3160 format_function: the function used to format CDRs.
3162 section: a hashref containing 'category' and/or 'locationnum'; if this
3163 is present, only returns line items that belong to that category and/or
3164 location (whichever is defined).
3166 multisection: a flag indicating that this is a multisection invoice,
3167 which does something complicated.
3169 Returns a list of hashrefs, each of which may contain:
3171 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
3172 ext_description, which is an arrayref of detail lines to show below
3177 sub _items_cust_bill_pkg {
3179 my $conf = $self->conf;
3180 my $cust_bill_pkgs = shift;
3183 my $format = $opt{format} || '';
3184 my $escape_function = $opt{escape_function} || sub { shift };
3185 my $format_function = $opt{format_function} || '';
3186 my $no_usage = $opt{no_usage} || '';
3187 my $unsquelched = $opt{unsquelched} || ''; #unused
3188 my ($section, $locationnum, $category);
3189 if ( $opt{section} ) {
3190 $category = $opt{section}->{category};
3191 $locationnum = $opt{section}->{locationnum};
3193 my $summary_page = $opt{summary_page} || ''; #unused
3194 my $multisection = defined($category) || defined($locationnum);
3195 # this variable is the value of the config setting, not whether it applies
3196 # to this particular line item.
3197 my $discount_show_always = $conf->exists('discount-show-always');
3199 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 40;
3201 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
3203 # for location labels: use default location on the invoice date
3204 my $default_locationnum;
3205 if ( $conf->exists('invoice-all_pkg_addresses') ) {
3206 $default_locationnum = 0; # treat them all as non-default
3207 } elsif ( $self->custnum ) {
3209 my @h_search = FS::h_cust_main->sql_h_search($self->_date);
3210 $h_cust_main = qsearchs({
3211 'table' => 'h_cust_main',
3212 'hashref' => { custnum => $self->custnum },
3213 'extra_sql' => $h_search[1],
3214 'addl_from' => $h_search[3],
3216 $default_locationnum = $h_cust_main->ship_locationnum;
3217 } elsif ( $self->prospectnum ) {
3218 my $cust_location = qsearchs('cust_location',
3219 { prospectnum => $self->prospectnum,
3221 $default_locationnum = $cust_location->locationnum if $cust_location;
3224 my @b = (); # accumulator for the line item hashes that we'll return
3225 my ($s, $r, $u, $d) = ( undef, undef, undef, undef );
3226 # the 'current' line item hashes for setup, recur, usage, discount
3227 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
3229 # if the current line item is waiting to go out, and the one we're about
3230 # to start is not bundled, then push out the current one and start a new
3233 $d->{amount} = $d->{setup_amount} + $d->{recur_amount};
3235 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3236 if ( $_ && !$cust_bill_pkg->hidden ) {
3237 $_->{amount} = sprintf( "%.2f", $_->{amount} );
3238 $_->{amount} =~ s/^\-0\.00$/0.00/;
3239 if (exists($_->{unit_amount})) {
3240 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3243 # we already decided to create this display line; don't reconsider it
3245 # if $_->{amount} != 0
3246 # || $discount_show_always
3247 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3248 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3254 if ( $locationnum ) {
3255 # this is a location section; skip packages that aren't at this
3257 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
3258 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
3262 # Consider display records for this item to determine if it belongs
3263 # in this section. Note that if there are no display records, there
3264 # will be a default pseudo-record that includes all charge types
3265 # and has no section name.
3266 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
3267 ? $cust_bill_pkg->cust_bill_pkg_display
3268 : ( $cust_bill_pkg );
3270 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
3271 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
3274 if ( defined($category) ) {
3275 # then this is a package category section; process all display records
3276 # that belong to this section.
3277 @cust_bill_pkg_display = grep { $_->section eq $category }
3278 @cust_bill_pkg_display;
3280 # otherwise, process all display records that aren't usage summaries
3281 # (I don't think there should be usage summaries if you aren't using
3282 # category sections, but this is the historical behavior)
3283 @cust_bill_pkg_display = grep { !$_->summary }
3284 @cust_bill_pkg_display;
3287 my $classname = ''; # package class name, will fill in later
3289 foreach my $display (@cust_bill_pkg_display) {
3291 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
3292 $display->billpkgdisplaynum. "\n"
3295 my $type = $display->type;
3297 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
3298 $desc = substr($desc, 0, $maxlength). '...'
3299 if $format eq 'latex' && length($desc) > $maxlength;
3301 my %details_opt = ( 'format' => $format,
3302 'escape_function' => $escape_function,
3303 'format_function' => $format_function,
3304 'no_usage' => $opt{'no_usage'},
3307 if ( $cust_bill_pkg->pkgnum > 0 ) {
3308 # a "normal" package line item (not a quotation, not a fee, not a tax)
3310 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
3313 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3314 my $part_pkg = $cust_pkg->part_pkg;
3316 # which pkgpart to show for display purposes?
3317 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
3319 # start/end dates for invoice formats that do nonstandard
3321 my %item_dates = ();
3322 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
3323 unless $part_pkg->option('disable_line_item_date_ranges',1);
3325 # not normally used, but pass this to the template anyway
3326 $classname = $part_pkg->classname;
3328 if ( (!$type || $type eq 'S')
3329 && ( $cust_bill_pkg->setup != 0
3330 || $cust_bill_pkg->setup_show_zero
3331 || ($discount_show_always and $cust_bill_pkg->unitsetup > 0)
3336 warn "$me _items_cust_bill_pkg adding setup\n"
3339 # append the word 'Setup' to the setup line if there's going to be
3340 # a recur line for the same package (i.e. not a one-time charge)
3342 my $description = $desc;
3343 $description .= ' Setup'
3344 if $cust_bill_pkg->recur != 0
3345 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3346 || $cust_bill_pkg->recur_show_zero;
3348 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3350 if $part_pkg->is_prepaid #for prepaid, "display the validity period
3351 # triggered by the recurring charge freq
3353 && $cust_bill_pkg->recur == 0
3354 && ! $cust_bill_pkg->recur_show_zero;
3359 # always pass the svc_label through to the template, even if
3360 # not displaying it as an ext_description
3361 my @svc_labels = map &{$escape_function}($_),
3362 $cust_pkg->h_labels_short($self->_date,
3365 $self->conf->{locale},
3367 $svc_label = $svc_labels[0];
3369 unless ( $cust_pkg->part_pkg->hide_svc_detail
3370 || $cust_bill_pkg->hidden )
3373 push @d, @svc_labels
3374 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3375 # show the location label if it's not the customer's default
3376 # location, and we're not grouping items by location already
3377 if ( $cust_pkg->locationnum != $default_locationnum
3378 and !defined($locationnum) ) {
3379 my $loc = $cust_pkg->location_label;
3380 $loc = substr($loc, 0, $maxlength). '...'
3381 if $format eq 'latex' && length($loc) > $maxlength;
3382 push @d, &{$escape_function}($loc);
3385 } #unless hiding service details
3387 push @d, $cust_bill_pkg->details(%details_opt)
3388 if $cust_bill_pkg->recur == 0;
3390 if ( $cust_bill_pkg->hidden ) {
3391 $s->{amount} += $cust_bill_pkg->setup;
3392 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3393 push @{ $s->{ext_description} }, @d;
3397 description => $description,
3398 pkgpart => $pkgpart,
3399 pkgnum => $cust_bill_pkg->pkgnum,
3400 amount => $cust_bill_pkg->setup,
3401 setup_show_zero => $cust_bill_pkg->setup_show_zero,
3402 unit_amount => $cust_bill_pkg->unitsetup,
3403 quantity => $cust_bill_pkg->quantity,
3404 ext_description => \@d,
3405 svc_label => ($svc_label || ''),
3406 locationnum => $cust_pkg->locationnum, # sure, why not?
3412 # should we show a recur line?
3413 # if type eq 'S', then NO, because we've been told not to.
3414 # otherwise, show the recur line if:
3415 # - there's a recurring charge
3416 # - or recur_show_zero is on
3417 # - or there's a positive unitrecur (so it's been discounted to zero)
3418 # and discount-show-always is on
3419 if ( ( !$type || $type eq 'R' || $type eq 'U' )
3421 $cust_bill_pkg->recur != 0
3423 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3424 || $cust_bill_pkg->recur_show_zero
3429 warn "$me _items_cust_bill_pkg adding recur/usage\n"
3432 my $is_summary = $display->summary;
3433 my $description = $desc;
3434 if ( $type eq 'U' and defined($r) ) {
3435 # don't just show the same description as the recur line
3436 $description = $self->mt('Usage charges');
3439 my $part_pkg = $cust_pkg->part_pkg;
3441 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3445 my @seconds = (); # for display of usage info
3448 #at least until cust_bill_pkg has "past" ranges in addition to
3449 #the "future" sdate/edate ones... see #3032
3450 my @dates = ( $self->_date );
3451 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
3452 push @dates, $prev->sdate if $prev;
3453 push @dates, undef if !$prev;
3455 my @svc_labels = map &{$escape_function}($_),
3456 $cust_pkg->h_labels_short(@dates,
3458 $self->conf->{locale});
3459 $svc_label = $svc_labels[0];
3461 # show service labels, unless...
3462 # the package is set not to display them
3463 unless ( $part_pkg->hide_svc_detail
3464 # or this is a tax-like line item
3465 || $cust_bill_pkg->itemdesc
3466 # or this is a hidden (bundled) line item
3467 || $cust_bill_pkg->hidden
3468 # or this is a usage summary line
3469 || $is_summary && $type && $type eq 'U'
3470 # or this is a usage line and there's a recurring line
3471 # for the package in the same section (which will
3472 # have service labels already)
3473 || ($type eq 'U' and defined($r))
3477 warn "$me _items_cust_bill_pkg adding service details\n"
3480 push @d, @svc_labels
3481 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3482 warn "$me _items_cust_bill_pkg done adding service details\n"
3485 # show the location label if it's not the customer's default
3486 # location, and we're not grouping items by location already
3487 if ( $cust_pkg->locationnum != $default_locationnum
3488 and !defined($locationnum) ) {
3489 my $loc = $cust_pkg->location_label;
3490 $loc = substr($loc, 0, $maxlength). '...'
3491 if $format eq 'latex' && length($loc) > $maxlength;
3492 push @d, &{$escape_function}($loc);
3495 # Display of seconds_since_sqlradacct:
3496 # On the invoice, when processing @detail_items, look for a field
3497 # named 'seconds'. This will contain total seconds for each
3498 # service, in the same order as @ext_description. For services
3499 # that don't support this it will show undef.
3500 if ( $conf->exists('svc_acct-usage_seconds')
3501 and ! $cust_bill_pkg->pkgpart_override ) {
3502 foreach my $cust_svc (
3503 $cust_pkg->h_cust_svc(@dates, 'I')
3506 # eval because not having any part_export_usage exports
3507 # is a fatal error, last_bill/_date because that's how
3508 # sqlradius_hour billing does it
3510 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
3512 push @seconds, $sec;
3514 } #if svc_acct-usage_seconds
3516 } # if we are showing service labels
3518 unless ( $is_summary ) {
3519 warn "$me _items_cust_bill_pkg adding details\n"
3522 #instead of omitting details entirely in this case (unwanted side
3523 # effects), just omit CDRs
3524 $details_opt{'no_usage'} = 1
3525 if $type && $type eq 'R';
3527 push @d, $cust_bill_pkg->details(%details_opt);
3530 warn "$me _items_cust_bill_pkg calculating amount\n"
3535 $amount = $cust_bill_pkg->recur;
3536 } elsif ($type eq 'R') {
3537 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
3538 } elsif ($type eq 'U') {
3539 $amount = $cust_bill_pkg->usage;
3542 if ( !$type || $type eq 'R' ) {
3544 warn "$me _items_cust_bill_pkg adding recur\n"
3548 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
3551 if ( $cust_bill_pkg->hidden ) {
3552 $r->{amount} += $amount;
3553 $r->{unit_amount} += $unit_amount;
3554 push @{ $r->{ext_description} }, @d;
3557 description => $description,
3558 pkgpart => $pkgpart,
3559 pkgnum => $cust_bill_pkg->pkgnum,
3561 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3562 unit_amount => $unit_amount,
3563 quantity => $cust_bill_pkg->quantity,
3565 ext_description => \@d,
3566 svc_label => ($svc_label || ''),
3567 locationnum => $cust_pkg->locationnum,
3569 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3572 } else { # $type eq 'U'
3574 warn "$me _items_cust_bill_pkg adding usage\n"
3577 if ( $cust_bill_pkg->hidden and defined($u) ) {
3578 # if this is a hidden package and there's already a usage
3579 # line for the bundle, add this package's total amount and
3580 # usage details to it
3581 $u->{amount} += $amount;
3582 push @{ $u->{ext_description} }, @d;
3583 } elsif ( $amount ) {
3584 # create a new usage line
3586 description => $description,
3587 pkgpart => $pkgpart,
3588 pkgnum => $cust_bill_pkg->pkgnum,
3591 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3593 ext_description => \@d,
3594 locationnum => $cust_pkg->locationnum,
3596 } # else this has no usage, so don't create a usage section
3599 } # recurring or usage with recurring charge
3601 } else { # taxes and fees
3603 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3606 # items of this kind should normally not have sdate/edate.
3608 'description' => $desc,
3609 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
3610 + $cust_bill_pkg->recur)
3613 } # if package line item / other line item
3615 # decide whether to show active discounts here
3617 # case 1: we are showing a single line for the package
3619 # case 2: we are showing a setup line for a package that has
3620 # no base recurring fee
3621 or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3622 # case 3: we are showing a recur line for a package that has
3623 # a base recurring fee
3624 or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3627 my $item_discount = $cust_bill_pkg->_item_discount;
3628 if ( $item_discount ) {
3629 # $item_discount->{amount} is negative
3631 if ( $d and $cust_bill_pkg->hidden ) {
3632 $d->{setup_amount} += $item_discount->{setup_amount};
3633 $d->{recur_amount} += $item_discount->{recur_amount};
3635 $d = $item_discount;
3636 $_ = &{$escape_function}($_) foreach @{ $d->{ext_description} };
3639 # update the active line (before the discount) to show the
3640 # original price (whether this is a hidden line or not)
3642 $s->{amount} -= $item_discount->{setup_amount} if $s;
3643 $r->{amount} -= $item_discount->{recur_amount} if $r;
3645 } # if there are any discounts
3646 } # if this is an appropriate place to show discounts
3648 } # foreach $display
3652 # discount amount is internally split up
3654 $d->{amount} = $d->{setup_amount} + $d->{recur_amount};
3657 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3659 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3660 if exists($_->{amount});
3661 $_->{amount} =~ s/^\-0\.00$/0.00/;
3662 if (exists($_->{unit_amount})) {
3663 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3667 #if $_->{amount} != 0
3668 # || $discount_show_always
3669 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3670 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3674 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3681 =item _items_discounts_avail
3683 Returns an array of line item hashrefs representing available term discounts
3684 for this invoice. This makes the same assumptions that apply to term
3685 discounts in general: that the package is billed monthly, at a flat rate,
3686 with no usage charges. A prorated first month will be handled, as will
3687 a setup fee if the discount is allowed to apply to setup fees.
3691 sub _items_discounts_avail {
3694 #maybe move this method from cust_bill when quotations support discount_plans
3695 return () unless $self->can('discount_plans');
3696 my %plans = $self->discount_plans;
3698 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3699 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3703 my $plan = $plans{$months};
3705 my $term_total = sprintf('%.2f', $plan->discounted_total);
3706 my $percent = sprintf('%.0f',
3707 100 * (1 - $term_total / $plan->base_total) );
3708 my $permonth = sprintf('%.2f', $term_total / $months);
3709 my $detail = $self->mt('discount on item'). ' '.
3710 join(', ', map { "#$_" } $plan->pkgnums)
3713 # discounts for non-integer months don't work anyway
3714 $months = sprintf("%d", $months);
3717 description => $self->mt('Save [_1]% by paying for [_2] months',
3719 amount => $self->mt('[_1] ([_2] per month)',
3720 $term_total, $money_char.$permonth),
3721 ext_description => ($detail || ''),
3724 sort { $b <=> $a } keys %plans;