1 package FS::Template_Mixin;
4 use vars qw( $DEBUG $me
9 use vars qw( $invoice_lines @buf ); #yuck
10 use List::Util qw(sum); #can't import first, it conflicts with cust_main.first
13 use Text::Template 1.20;
15 use Archive::Zip qw( :ERROR_CODES :CONSTANTS );
20 use FS::Misc qw( send_email );
21 use FS::Record qw( qsearch qsearchs );
23 use FS::Misc qw( generate_ps generate_pdf );
30 $me = '[FS::Template_Mixin]';
31 FS::UID->install_callback( sub {
32 my $conf = new FS::Conf; #global
33 $money_char = $conf->config('money_char') || '$';
34 $date_format = $conf->config('date_format') || '%x'; #/YY
39 Returns a configuration handle (L<FS::Conf>) set to the customer's locale.
41 If the "mode" pseudo-field is set on the object, the configuration handle
42 will be an L<FS::invoice_conf> for that invoice mode (and the customer's
49 my $mode = $self->get('mode');
50 if ($self->{_conf} and !defined($mode)) {
51 return $self->{_conf};
54 my $cust_main = $self->cust_main;
55 my $locale = $cust_main ? $cust_main->locale : '';
58 if ( ref $mode and $mode->isa('FS::invoice_mode') ) {
59 $mode = $mode->modenum;
60 } elsif ( $mode =~ /\D/ ) {
61 die "invalid invoice mode $mode";
63 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => $locale });
65 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => '' });
66 # it doesn't have a locale, but system conf still might
67 $conf->set('locale' => $locale) if $conf;
70 # if $mode is unspecified, or if there is no invoice_conf matching this mode
71 # and locale, then use the system config only (but with the locale)
72 $conf ||= FS::Conf->new({ 'locale' => $locale });
74 return $self->{_conf} = $conf;
77 =item print_text OPTIONS
79 Returns an text invoice, as a list of lines.
81 Options can be passed as a hash.
83 I<time>, if specified, is used to control the printing of overdue messages. The
84 default is now. It isn't the date of the invoice; that's the `_date' field.
85 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
86 L<Time::Local> and L<Date::Parse> for conversion functions.
88 I<template>, if specified, is the name of a suffix for alternate invoices.
90 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
98 %params = %{ shift() };
103 $params{'format'} = 'template'; # for some reason
105 $self->print_generic( %params );
108 =item print_latex HASHREF
110 Internal method - returns a filename of a filled-in LaTeX template for this
111 invoice (Note: add ".tex" to get the actual filename), and a filename of
112 an associated logo (with the .eps extension included).
114 See print_ps and print_pdf for methods that return PostScript and PDF output.
116 Options can be passed as a hash.
118 I<time>, if specified, is used to control the printing of overdue messages. The
119 default is now. It isn't the date of the invoice; that's the `_date' field.
120 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
121 L<Time::Local> and L<Date::Parse> for conversion functions.
123 I<template>, if specified, is the name of a suffix for alternate invoices.
124 This is strongly deprecated; see L<FS::invoice_conf> for the right way to
125 customize invoice templates for different purposes.
127 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
136 %params = %{ shift() };
141 $params{'format'} = 'latex';
142 my $conf = $self->conf;
144 # this needs to go away
145 my $template = $params{'template'};
146 # and this especially
147 $template ||= $self->_agent_template
148 if $self->can('_agent_template');
150 my $pkey = $self->primary_key;
151 my $tmp_template = $self->table. '.'. $self->$pkey. '.XXXXXXXX';
153 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
154 my $lh = new File::Temp(
155 TEMPLATE => $tmp_template,
159 ) or die "can't open temp file: $!\n";
161 my $agentnum = $self->agentnum;
163 if ( $template && $conf->exists("logo_${template}.eps", $agentnum) ) {
164 print $lh $conf->config_binary("logo_${template}.eps", $agentnum)
165 or die "can't write temp file: $!\n";
167 print $lh $conf->config_binary('logo.eps', $agentnum)
168 or die "can't write temp file: $!\n";
171 $params{'logo_file'} = $lh->filename;
173 if( $conf->exists('invoice-barcode')
174 && $self->can('invoice_barcode')
175 && $self->invnum ) { # don't try to barcode statements
176 my $png_file = $self->invoice_barcode($dir);
177 my $eps_file = $png_file;
178 $eps_file =~ s/\.png$/.eps/g;
179 $png_file =~ /(barcode.*png)/;
181 $eps_file =~ /(barcode.*eps)/;
184 my $curr_dir = cwd();
186 # after painfuly long experimentation, it was determined that sam2p won't
187 # accept : and other chars in the path, no matter how hard I tried to
188 # escape them, hence the chdir (and chdir back, just to be safe)
189 system('sam2p', '-j:quiet', $png_file, 'EPS:', $eps_file ) == 0
190 or die "sam2p failed: $!\n";
194 $params{'barcode_file'} = $eps_file;
197 my @filled_in = $self->print_generic( %params );
199 my $fh = new File::Temp( TEMPLATE => $tmp_template,
203 ) or die "can't open temp file: $!\n";
204 binmode($fh, ':utf8'); # language support
205 print $fh join('', @filled_in );
208 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
209 return ($1, $params{'logo_file'}, $params{'barcode_file'});
215 my $cust_main = $self->cust_main;
216 $cust_main ? $cust_main->agentnum : $self->prospect_main->agentnum;
219 =item print_generic OPTION => VALUE ...
221 Internal method - returns a filled-in template for this invoice as a scalar.
223 See print_ps and print_pdf for methods that return PostScript and PDF output.
231 The B<format> option is required and should be set to html, latex (print and PDF) or template (plaintext).
241 Overrides "Invoice" as the name of the sent document.
245 Used to control the printing of overdue messages. The
246 default is now. It isn't the date of the invoice; that's the `_date' field.
247 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
248 L<Time::Local> and L<Date::Parse> for conversion functions.
252 Logo file (path to temporary EPS file on the local filesystem)
256 CID for inline (emailed) images (logo)
260 Override customer's locale
264 Overrides any per customer cdr squelching when true
268 Supress the (invoice, quotation, statement, etc.) number
276 Supress the payment coupon
280 Barcode file (path to temporary EPS file on the local filesystem)
284 Flag indicating the barcode image should be a link (normal HTML dipaly)
288 Barcode CID for inline (emailed) images
290 =item preref_callback
292 Coderef run for each line item, code should return HTML to be displayed
293 before that line item (quotations only)
297 Dprecated. Used as a suffix for a configuration template. Please
298 don't use this, it deprecated in favor of more flexible alternatives.
304 #what's with all the sprintf('%10.2f')'s in here? will it cause any
305 # (alignment in text invoice?) problems to change them all to '%.2f' ?
306 # yes: fixed width/plain text printing will be borked
308 my( $self, %params ) = @_;
309 my $conf = $self->conf;
311 my $today = $params{today} ? $params{today} : time;
312 warn "$me print_generic called on $self with suffix $params{template}\n"
315 my $format = $params{format};
316 die "Unknown format: $format"
317 unless $format =~ /^(latex|html|template)$/;
319 my $cust_main = $self->cust_main || $self->prospect_main;
320 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
321 unless $cust_main->payname
322 && $cust_main->payby !~ /^(CARD|DCRD|CHEK|DCHK)$/;
324 my $locale = $params{'locale'} || $cust_main->locale;
326 my %delimiters = ( 'latex' => [ '[@--', '--@]' ],
327 'html' => [ '<%=', '%>' ],
328 'template' => [ '{', '}' ],
331 warn "$me print_generic creating template\n"
334 # set the notice name here, and nowhere else.
335 my $notice_name = $params{notice_name}
336 || $conf->config('notice_name')
337 || $self->notice_name;
340 my $template = $params{template} ? $params{template} : $self->_agent_template;
341 my $templatefile = $self->template_conf. $format;
342 $templatefile .= "_$template"
343 if length($template) && $conf->exists($templatefile."_$template");
346 my @invoice_template = map "$_\n", $conf->config($templatefile)
347 or die "cannot load config data $templatefile";
349 if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
350 #change this to a die when the old code is removed
351 # it's been almost ten years, changing it to a die on the next release.
352 warn "old-style invoice template $templatefile; ".
353 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
354 #$old_latex = 'true';
355 #@invoice_template = _translate_old_latex_format(@invoice_template);
358 warn "$me print_generic creating T:T object\n"
361 my $text_template = new Text::Template(
363 SOURCE => \@invoice_template,
364 DELIMITERS => $delimiters{$format},
367 warn "$me print_generic compiling T:T object\n"
370 $text_template->compile()
371 or die "Can't compile $templatefile: $Text::Template::ERROR\n";
374 # additional substitution could possibly cause breakage in existing templates
377 'notes' => sub { map "$_", @_ },
378 'footer' => sub { map "$_", @_ },
379 'smallfooter' => sub { map "$_", @_ },
380 'returnaddress' => sub { map "$_", @_ },
381 'coupon' => sub { map "$_", @_ },
382 'summary' => sub { map "$_", @_ },
388 s/%%(.*)$/<!-- $1 -->/g;
389 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
390 s/\\begin\{enumerate\}/<ol>/g;
392 s/\\end\{enumerate\}/<\/ol>/g;
393 s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
402 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
404 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
410 s/\\hyphenation\{[\w\s\-]+}//;
415 'coupon' => sub { "" },
416 'summary' => sub { "" },
423 s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
424 s/\\begin\{enumerate\}//g;
426 s/\\end\{enumerate\}//g;
427 s/\\textbf\{(.*)\}/$1/g;
434 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
436 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
441 s/\\\\\*?\s*$/\n/; # dubious
442 s/\\hyphenation\{[\w\s\-]+}//;
446 'coupon' => sub { "" },
447 'summary' => sub { "" },
452 # hashes for differing output formats
453 my %nbsps = ( 'latex' => '~',
454 'html' => '', # '&nbps;' would be nice
455 'template' => '', # not used
457 my $nbsp = $nbsps{$format};
459 my %escape_functions = ( 'latex' => \&_latex_escape,
460 'html' => \&_html_escape_nbsp,#\&encode_entities,
461 'template' => sub { shift },
463 my $escape_function = $escape_functions{$format};
464 my $escape_function_nonbsp = ($format eq 'html')
465 ? \&_html_escape : $escape_function;
467 my %newline_tokens = ( 'latex' => '\\\\',
471 my $newline_token = $newline_tokens{$format};
473 warn "$me generating template variables\n"
476 # generate template variables
480 defined( $conf->config_orbase( "invoice_${format}returnaddress",
484 && length( $conf->config_orbase( "invoice_${format}returnaddress",
490 $returnaddress = join("\n",
491 $conf->config_orbase("invoice_${format}returnaddress", $template)
495 $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
497 my $convert_map = $convert_maps{$format}{'returnaddress'};
500 &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
505 } elsif ( grep /\S/, $conf->config('company_address', $cust_main->agentnum) ) {
507 my $convert_map = $convert_maps{$format}{'returnaddress'};
508 $returnaddress = join( "\n", &$convert_map(
509 map { s/( {2,})/'~' x length($1)/eg;
513 ( $conf->config('company_name', $cust_main->agentnum),
514 $conf->config('company_address', $cust_main->agentnum),
521 my $warning = "Couldn't find a return address; ".
522 "do you need to set the company_address configuration value?";
524 $returnaddress = $nbsp;
525 #$returnaddress = $warning;
529 warn "$me generating invoice data\n"
532 my $agentnum = $cust_main->agentnum;
537 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
538 'company_address' => join("\n", $conf->config('company_address', $agentnum) ). "\n",
539 'company_phonenum'=> scalar( $conf->config('company_phonenum', $agentnum) ),
540 'returnaddress' => $returnaddress,
541 'agent' => &$escape_function($cust_main->agent->agent),
543 #invoice/quotation info
544 'no_number' => $params{'no_number'},
545 'invnum' => ( $params{'no_number'} ? '' : $self->invnum ),
546 'quotationnum' => $self->quotationnum,
547 'no_date' => $params{'no_date'},
548 '_date' => ( $params{'no_date'} ? '' : $self->_date ),
549 # workaround for inconsistent behavior in the early plain text
550 # templates; see RT#28271
551 'date' => ( $params{'no_date'}
553 : ($format eq 'template'
555 : $self->time2str_local('long', $self->_date, $format)
558 'today' => $self->time2str_local('long', $today, $format),
559 'terms' => $self->terms,
560 'template' => $template, #params{'template'},
561 'notice_name' => $notice_name, # escape?
562 'current_charges' => sprintf("%.2f", $self->charged),
563 'duedate' => $self->due_date2str('rdate'), #date_format?
566 'custnum' => $cust_main->display_custnum,
567 'prospectnum' => $cust_main->prospectnum,
568 'agent_custid' => &$escape_function($cust_main->agent_custid),
569 ( map { $_ => &$escape_function($cust_main->$_()) } qw(
570 payname company address1 address2 city state zip fax
574 'ship_enable' => $cust_main->invoice_ship_address || $conf->exists('invoice-ship_address'),
575 'unitprices' => $conf->exists('invoice-unitprice'),
576 'smallernotes' => $conf->exists('invoice-smallernotes'),
577 'smallerfooter' => $conf->exists('invoice-smallerfooter'),
578 'balance_due_below_line' => $conf->exists('balance_due_below_line'),
580 #layout info -- would be fancy to calc some of this and bury the template
582 'topmargin' => scalar($conf->config('invoice_latextopmargin', $agentnum)),
583 'headsep' => scalar($conf->config('invoice_latexheadsep', $agentnum)),
584 'textheight' => scalar($conf->config('invoice_latextextheight', $agentnum)),
585 'extracouponspace' => scalar($conf->config('invoice_latexextracouponspace', $agentnum)),
586 'couponfootsep' => scalar($conf->config('invoice_latexcouponfootsep', $agentnum)),
587 'verticalreturnaddress' => $conf->exists('invoice_latexverticalreturnaddress', $agentnum),
588 'addresssep' => scalar($conf->config('invoice_latexaddresssep', $agentnum)),
589 'amountenclosedsep' => scalar($conf->config('invoice_latexcouponamountenclosedsep', $agentnum)),
590 'coupontoaddresssep' => scalar($conf->config('invoice_latexcoupontoaddresssep', $agentnum)),
591 'addcompanytoaddress' => $conf->exists('invoice_latexcouponaddcompanytoaddress', $agentnum),
593 # better hang on to conf_dir for a while (for old templates)
594 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
596 #these are only used when doing paged plaintext
603 $invoice_data{'emt'} = sub { &$escape_function($self->mt(@_)) };
604 # prototype here to silence warnings
605 $invoice_data{'time2str'} = sub ($;$$) { $self->time2str_local(@_, $format) };
607 my $min_sdate = 999999999999;
609 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
610 next unless $cust_bill_pkg->pkgnum > 0;
611 $min_sdate = $cust_bill_pkg->sdate
612 if length($cust_bill_pkg->sdate) && $cust_bill_pkg->sdate < $min_sdate;
613 $max_edate = $cust_bill_pkg->edate
614 if length($cust_bill_pkg->edate) && $cust_bill_pkg->edate > $max_edate;
617 $invoice_data{'bill_period'} = '';
618 $invoice_data{'bill_period'} =
619 $self->time2str_local('%e %h', $min_sdate, $format)
621 $self->time2str_local('%e %h', $max_edate, $format)
622 if ($max_edate != 0 && $min_sdate != 999999999999);
624 $invoice_data{finance_section} = '';
625 if ( $conf->config('finance_pkgclass') ) {
627 qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
628 $invoice_data{finance_section} = $pkg_class->categoryname;
630 $invoice_data{finance_amount} = '0.00';
631 $invoice_data{finance_section} ||= 'Finance Charges'; #avoid config confusion
633 my $countrydefault = $conf->config('countrydefault') || 'US';
634 foreach ( qw( address1 address2 city state zip country fax) ){
635 my $method = 'ship_'.$_;
636 $invoice_data{"ship_$_"} = $escape_function->($cust_main->$method);
638 if ( length($cust_main->ship_company) ) {
639 $invoice_data{'ship_company'} = $escape_function->($cust_main->ship_company);
641 $invoice_data{'ship_company'} = $escape_function->($cust_main->company);
643 $invoice_data{'ship_contact'} = $escape_function->($cust_main->contact);
644 $invoice_data{'ship_country'} = ''
645 if ( $invoice_data{'ship_country'} eq $countrydefault );
647 $invoice_data{'cid'} = $params{'cid'}
650 if ( $cust_main->country eq $countrydefault ) {
651 $invoice_data{'country'} = '';
653 $invoice_data{'country'} = &$escape_function($cust_main->bill_country_full);
657 $invoice_data{'address'} = \@address;
660 ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
661 ? " (P.O. #". $cust_main->payinfo. ")"
665 push @address, $cust_main->company
666 if $cust_main->company;
667 push @address, $cust_main->address1;
668 push @address, $cust_main->address2
669 if $cust_main->address2;
671 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
672 push @address, $invoice_data{'country'}
673 if $invoice_data{'country'};
675 while (scalar(@address) < 5);
677 $invoice_data{'logo_file'} = $params{'logo_file'}
678 if $params{'logo_file'};
679 $invoice_data{'barcode_file'} = $params{'barcode_file'}
680 if $params{'barcode_file'};
681 $invoice_data{'barcode_img'} = $params{'barcode_img'}
682 if $params{'barcode_img'};
683 $invoice_data{'barcode_cid'} = $params{'barcode_cid'}
684 if $params{'barcode_cid'};
686 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
687 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
688 #my $balance_due = $self->owed + $pr_total - $cr_total;
689 my $balance_due = $self->owed;
690 if ( $self->enable_previous ) {
691 $balance_due += $pr_total;
693 # otherwise the previous balance is not shown, so including it in the
694 # balance due is just confusing
696 # the sum of amount owed on all invoices
697 # (this is used in the summary & on the payment coupon)
698 $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
700 # flag telling this invoice to have a first-page summary
701 my $summarypage = '';
703 if ( $self->custnum && $self->invnum ) {
704 # XXX should be an FS::cust_bill method to set the defaults, instead
705 # of checking the type here
707 # info from customer's last invoice before this one, for some
709 $invoice_data{'last_bill'} = {};
711 my $last_bill = $self->previous_bill;
714 # "balance_date_range" unfortunately is unsuitable for this, since it
715 # cares about application dates. We want to know the sum of all
716 # _top-level transactions_ dated before the last invoice.
718 # still do this for the "Previous Balance" line of the summary block
720 map "$_ WHERE _date <= ? AND custnum = ?", (
721 "SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill",
722 "SELECT -1 * COALESCE( SUM(amount), 0 ) FROM cust_credit",
723 "SELECT -1 * COALESCE( SUM(paid), 0 ) FROM cust_pay",
724 "SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund",
727 # the customer's current balance immediately after generating the last
730 my $last_bill_balance = $last_bill->charged;
732 my $delta = FS::Record->scalar_sql(
734 $last_bill->_date - 1,
737 $last_bill_balance += $delta;
740 $last_bill_balance = sprintf("%.2f", $last_bill_balance);
742 warn sprintf("LAST BILL: INVNUM %d, DATE %s, BALANCE %.2f\n\n",
744 $self->time2str_local('%D', $last_bill->_date),
747 # ("true_previous_balance" is a terrible name, but at least it's no
748 # longer stored in the database)
749 $invoice_data{'true_previous_balance'} = $last_bill_balance;
751 # Now, get all applications of credits/payments dated on or after the
752 # previous bill, to invoices before the current bill. (The
753 # credit/payment date restriction prevents these from intersecting
754 # the "Previous Balance" set.)
755 # These are "adjustments". The past due balance will be shown as
756 # Previous Balance - Adjustments.
759 "SELECT COALESCE(SUM(y.amount),0) FROM $_ JOIN cust_bill USING (invnum)
760 WHERE cust_bill._date < ?
762 AND cust_bill.custnum = ?"
763 } "cust_credit AS x JOIN cust_credit_bill y USING (crednum)",
764 "cust_pay AS x JOIN cust_bill_pay y USING (paynum)"
767 my $delta = FS::Record->scalar_sql(
773 $adjustments += $delta;
775 $invoice_data{'balance_adjustments'} = sprintf("%.2f", $adjustments);
777 warn sprintf("BALANCE ADJUSTMENTS: %.2f\n\n",
778 $invoice_data{'balance_adjustments'}
781 # the sum of amount owed on all previous invoices
782 # ($pr_total is used elsewhere but not as $previous_balance)
783 $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
785 $invoice_data{'last_bill'}{'_date'} = $last_bill->_date; #unformatted
786 my (@payments, @credits);
787 # for formats that itemize previous payments
788 foreach my $cust_pay ( qsearch('cust_pay', {
789 'custnum' => $self->custnum,
790 '_date' => { op => '>=',
791 value => $last_bill->_date }
794 next if $cust_pay->_date > $self->_date;
796 '_date' => $cust_pay->_date,
797 'date' => $self->time2str_local('long', $cust_pay->_date, $format),
798 'payinfo' => $cust_pay->payby_payinfo_pretty,
799 'amount' => sprintf('%.2f', $cust_pay->paid),
801 # not concerned about applications
803 foreach my $cust_credit ( qsearch('cust_credit', {
804 'custnum' => $self->custnum,
805 '_date' => { op => '>=',
806 value => $last_bill->_date }
809 next if $cust_credit->_date > $self->_date;
811 '_date' => $cust_credit->_date,
812 'date' => $self->time2str_local('long', $cust_credit->_date, $format),
813 'creditreason'=> $cust_credit->reason,
814 'amount' => sprintf('%.2f', $cust_credit->amount),
817 $invoice_data{'previous_payments'} = \@payments;
818 $invoice_data{'previous_credits'} = \@credits;
820 # there is no $last_bill
821 $invoice_data{'true_previous_balance'} =
822 $invoice_data{'balance_adjustments'} =
823 $invoice_data{'previous_balance'} = '0.00';
824 $invoice_data{'previous_payments'} = [];
825 $invoice_data{'previous_credits'} = [];
828 if ( $conf->exists('invoice_usesummary', $agentnum) ) {
829 $invoice_data{'summarypage'} = $summarypage = 1;
832 } # if this is an invoice
834 warn "$me substituting variables in notes, footer, smallfooter\n"
837 my $tc = $self->template_conf;
838 my @include = ( [ $tc, 'notes' ],
839 [ 'invoice_', 'footer' ],
840 [ 'invoice_', 'smallfooter', ],
841 [ 'invoice_', 'watermark' ],
843 push @include, [ $tc, 'coupon', ]
844 unless $params{'no_coupon'};
846 foreach my $i (@include) {
848 # load the configuration for this sub-template
850 my($base, $include) = @$i;
852 my $inc_file = $conf->key_orbase("$base$format$include", $template);
854 my @inc_src = $conf->config($inc_file, $agentnum);
856 my $converter = $convert_maps{$format}{$include};
858 # then attempt to convert LaTeX to the requested format
859 $inc_file = $conf->key_orbase($base.'latex'.$include, $template);
860 @inc_src = &$converter( $conf->config($inc_file, $agentnum) );
862 # this isn't included in the convert_maps
863 my ($open, $close) = @{ $delimiters{$format} };
868 } # else @inc_src is empty and that's fine
870 # make a Text::Template out of it
872 my $inc_tt = new Text::Template (
874 SOURCE => [ map "$_\n", @inc_src ],
875 DELIMITERS => $delimiters{$format},
876 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
878 unless ( $inc_tt->compile() ) {
879 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
880 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
886 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
888 $invoice_data{$include} =~ s/\n+$//
889 if ($format eq 'latex');
892 # let invoices use either of these as needed
893 $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
894 ? $cust_main->payinfo : '';
895 $invoice_data{'po_line'} =
896 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
897 ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
900 my %money_chars = ( 'latex' => '',
901 'html' => $conf->config('money_char') || '$',
904 my $money_char = $money_chars{$format};
907 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
908 'html' => $conf->config('money_char') || '$',
911 my $other_money_char = $other_money_chars{$format};
912 $invoice_data{'dollar'} = $other_money_char;
914 my %minus_signs = ( 'latex' => '$-$',
916 'template' => '- ' );
917 my $minus = $minus_signs{$format};
919 my @detail_items = ();
920 my @total_items = ();
924 $invoice_data{'detail_items'} = \@detail_items;
925 $invoice_data{'total_items'} = \@total_items;
926 $invoice_data{'buf'} = \@buf;
927 $invoice_data{'sections'} = \@sections;
929 warn "$me generating sections\n"
932 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
933 my $multisection = $conf->exists($tc.'sections', $cust_main->agentnum) ||
934 $conf->exists($tc.'sections_by_location', $cust_main->agentnum);
935 $invoice_data{'multisection'} = $multisection;
937 my $extra_sections = [];
938 my $extra_lines = ();
940 # default section ('Charges')
941 my $default_section = { 'description' => '',
946 # Previous Charges section
947 # subtotal is the first return value from $self->previous
948 my $previous_section;
949 # if the invoice has major sections, or if we're summarizing previous
950 # charges with a single line, or if we've been specifically told to put them
951 # in a section, create a section for previous charges:
952 if ( $multisection or
953 $conf->exists('previous_balance-summary_only') or
954 $conf->exists('previous_balance-section') ) {
956 $previous_section = { 'description' => $self->mt('Previous Charges'),
957 'subtotal' => $other_money_char.
958 sprintf('%.2f', $pr_total),
959 'summarized' => '', #why? $summarypage ? 'Y' : '',
961 $previous_section->{posttotal} = '0 / 30 / 60 / 90 days overdue '.
962 join(' / ', map { $cust_main->balance_date_range(@$_) }
963 $self->_prior_month30s
965 if $conf->exists('invoice_include_aging');
968 # otherwise put them in the main section
969 $previous_section = $default_section;
972 my $adjust_section = {
973 'description' => $self->mt('Credits, Payments, and Adjustments'),
974 'adjust_section' => 1,
975 'subtotal' => 0, # adjusted below
977 my $adjust_weight = _pkg_category($adjust_section->{description})
978 ? _pkg_category($adjust_section->{description})->weight
980 $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
981 # Note: 'sort_weight' here is actually a flag telling whether there is an
982 # explicit package category for the adjust section. If so, certain behavior
984 $adjust_section->{'sort_weight'} = $adjust_weight;
987 if ( $multisection ) {
988 ($extra_sections, $extra_lines) =
989 $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
990 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum)
991 && $self->can('_items_extra_usage_sections');
993 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
995 push @detail_items, @$extra_lines if $extra_lines;
997 # the code is written so that both methods can be used together, but
998 # we haven't yet changed the template to take advantage of that, so for
999 # now, treat them as mutually exclusive.
1000 my %section_method = ( by_category => 1 );
1001 if ( $conf->config($tc.'sections_method') eq 'location' ) {
1002 %section_method = ( by_location => 1 );
1004 my ($early, $late) =
1005 $self->_items_sections( 'summary' => $summarypage,
1006 'escape' => $escape_function_nonbsp,
1007 'extra_sections' => $extra_sections,
1008 'format' => $format,
1011 push @sections, @$early;
1012 $late_sections = $late;
1014 if ( $conf->exists('svc_phone_sections')
1015 && $self->can('_items_svc_phone_sections')
1018 my ($phone_sections, $phone_lines) =
1019 $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
1020 push @{$late_sections}, @$phone_sections;
1021 push @detail_items, @$phone_lines;
1023 if ( $conf->exists('voip-cust_accountcode_cdr')
1024 && $cust_main->accountcode_cdr
1025 && $self->can('_items_accountcode_cdr')
1028 my ($accountcode_section, $accountcode_lines) =
1029 $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
1030 if ( scalar(@$accountcode_lines) ) {
1031 push @{$late_sections}, $accountcode_section;
1032 push @detail_items, @$accountcode_lines;
1035 } else {# not multisection
1036 # make a default section
1037 push @sections, $default_section;
1038 # and calculate the finance charge total, since it won't get done otherwise.
1039 # and the default section total
1040 # XXX possibly finance_pkgclass should not be used in this manner?
1041 my @finance_charges;
1043 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1044 if ( $invoice_data{finance_section} and
1045 grep { $_->section eq $invoice_data{finance_section} }
1046 $cust_bill_pkg->cust_bill_pkg_display ) {
1047 # I think these are always setup fees, but just to be sure...
1048 push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1050 push @charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1053 $invoice_data{finance_amount} =
1054 sprintf('%.2f', sum( @finance_charges ) || 0);
1055 $default_section->{subtotal} = $other_money_char.
1056 sprintf('%.2f', sum( @charges ) || 0);
1059 # start setting up summary subtotals
1060 my @summary_subtotals;
1061 my $method = $conf->config('summary_subtotals_method');
1062 if ( $method and $method ne $conf->config($tc.'sections_method') ) {
1063 # then re-section them by the correct method
1064 my %section_method = ( by_category => 1 );
1065 if ( $conf->config('summary_subtotals_method') eq 'location' ) {
1066 %section_method = ( by_location => 1 );
1068 my ($early, $late) =
1069 $self->_items_sections( 'summary' => $summarypage,
1070 'escape' => $escape_function_nonbsp,
1071 'extra_sections' => $extra_sections,
1072 'format' => $format,
1075 foreach ( @$early ) {
1076 next if $_->{subtotal} == 0;
1077 $_->{subtotal} = $other_money_char.sprintf('%.2f', $_->{subtotal});
1078 push @summary_subtotals, $_;
1081 # subtotal sectioning is the same as for the actual invoice sections
1082 @summary_subtotals = @sections;
1085 # Hereafter, push sections to both @sections and @summary_subtotals
1086 # if they belong in both places (e.g. tax section). Late sections are
1087 # never in @summary_subtotals.
1089 # previous invoice balances in the Previous Charges section if there
1090 # is one, otherwise in the main detail section
1091 # (except if summary_only is enabled, don't show them at all)
1092 if ( $self->can('_items_previous') &&
1093 $self->enable_previous &&
1094 ! $conf->exists('previous_balance-summary_only') ) {
1096 warn "$me adding previous balances\n"
1099 foreach my $line_item ( $self->_items_previous ) {
1102 ref => $line_item->{'pkgnum'},
1103 pkgpart => $line_item->{'pkgpart'},
1104 #quantity => 1, # not really correct
1105 section => $previous_section, # which might be $default_section
1106 description => &$escape_function($line_item->{'description'}),
1107 ext_description => [ map { &$escape_function($_) }
1108 @{ $line_item->{'ext_description'} || [] }
1110 amount => $money_char . $line_item->{'amount'},
1111 product_code => $line_item->{'pkgpart'} || 'N/A',
1114 push @detail_items, $detail;
1115 push @buf, [ $detail->{'description'},
1116 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1122 if ( @pr_cust_bill && $self->enable_previous ) {
1123 push @buf, ['','-----------'];
1124 push @buf, [ $self->mt('Total Previous Balance'),
1125 $money_char. sprintf("%10.2f", $pr_total) ];
1129 if ( $conf->exists('svc_phone-did-summary') && $self->can('_did_summary') ) {
1130 warn "$me adding DID summary\n"
1133 my ($didsummary,$minutes) = $self->_did_summary;
1134 my $didsummary_desc = 'DID Activity Summary (since last invoice)';
1136 { 'description' => $didsummary_desc,
1137 'ext_description' => [ $didsummary, $minutes ],
1141 foreach my $section (@sections, @$late_sections) {
1143 # begin some normalization
1144 $section->{'subtotal'} = $section->{'amount'}
1146 && !exists($section->{subtotal})
1147 && exists($section->{amount});
1149 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
1150 if ( $invoice_data{finance_section} &&
1151 $section->{'description'} eq $invoice_data{finance_section} );
1153 $section->{'subtotal'} = $other_money_char.
1154 sprintf('%.2f', $section->{'subtotal'})
1157 # continue some normalization
1158 $section->{'amount'} = $section->{'subtotal'}
1162 if ( $section->{'description'} ) {
1163 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
1168 warn "$me setting options\n"
1172 $options{'section'} = $section if $multisection;
1173 $options{'format'} = $format;
1174 $options{'escape_function'} = $escape_function;
1175 $options{'no_usage'} = 1 unless $unsquelched;
1176 $options{'unsquelched'} = $unsquelched;
1177 $options{'summary_page'} = $summarypage;
1178 $options{'skip_usage'} =
1179 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
1180 $options{'preref_callback'} = $params{'preref_callback'};
1182 warn "$me searching for line items\n"
1185 foreach my $line_item ( $self->_items_pkg(%options),
1186 $self->_items_fee(%options) ) {
1188 warn "$me adding line item ".
1189 join(', ', map "$_=>".$line_item->{$_}, keys %$line_item). "\n"
1192 push @buf, ( [ $line_item->{'description'},
1193 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1195 map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}},
1198 $line_item->{'ref'} = $line_item->{'pkgnum'};
1199 $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()?
1200 $line_item->{'section'} = $section;
1201 $line_item->{'description'} = &$escape_function($line_item->{'description'});
1202 $line_item->{'amount'} = $money_char.$line_item->{'amount'};
1204 if ( length($line_item->{'unit_amount'}) ) {
1205 $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'};
1207 $line_item->{'ext_description'} ||= [];
1209 push @detail_items, $line_item;
1212 if ( $section->{'description'} ) {
1213 push @buf, ( ['','-----------'],
1214 [ $section->{'description'}. ' sub-total',
1215 $section->{'subtotal'} # already formatted this
1224 $invoice_data{current_less_finance} =
1225 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
1227 # if there's anything in the Previous Charges section, prepend it to the list
1228 if ( $pr_total and $previous_section ne $default_section ) {
1229 unshift @sections, $previous_section;
1230 # but not @summary_subtotals
1233 warn "$me adding taxes\n"
1236 # create a tax section if we don't yet have one
1237 my $tax_description = 'Taxes, Surcharges, and Fees';
1239 List::Util::first { $_->{description} eq $tax_description } @sections;
1240 if (!$tax_section) {
1241 $tax_section = { 'description' => $tax_description };
1242 push @sections, $tax_section if $multisection;
1244 $tax_section->{tax_section} = 1; # mark this section as containing taxes
1245 # if this is an existing tax section, we're merging the tax items into it.
1246 # grab the taxtotal that's already there, strip the money symbol if any
1247 my $taxtotal = $tax_section->{'subtotal'} || 0;
1248 $taxtotal =~ s/^\Q$other_money_char\E//;
1251 #my $tax_weight = _pkg_category($tax_section->{description})
1252 # ? _pkg_category($tax_section->{description})->weight
1254 #$tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
1255 #$tax_section->{'sort_weight'} = $tax_weight;
1257 my @items_tax = $self->_items_tax;
1258 foreach my $tax ( @items_tax ) {
1260 $taxtotal += $tax->{'amount'};
1262 my $description = &$escape_function( $tax->{'description'} );
1263 my $amount = sprintf( '%.2f', $tax->{'amount'} );
1265 if ( $multisection ) {
1267 push @detail_items, {
1268 ext_description => [],
1271 description => $description,
1272 amount => $money_char. $amount,
1274 section => $tax_section,
1279 push @total_items, {
1280 'total_item' => $description,
1281 'total_amount' => $other_money_char. $amount,
1286 push @buf,[ $description,
1287 $money_char. $amount,
1294 $total->{'total_item'} = $self->mt('Sub-total');
1295 $total->{'total_amount'} =
1296 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
1298 if ( $multisection ) {
1299 if ( $taxtotal > 0 ) {
1300 # there are taxes, so prepare the section to be displayed.
1301 # $taxtotal already includes any line items that were already in the
1302 # section (fees, taxes that are charged as packages for some reason).
1303 # also set 'summarized' to false so that this isn't a summary-only
1305 $tax_section->{'subtotal'} = $other_money_char.
1306 sprintf('%.2f', $taxtotal);
1307 $tax_section->{'pretotal'} = 'New charges sub-total '.
1308 $total->{'total_amount'};
1309 $tax_section->{'description'} = $self->mt($tax_description);
1310 $tax_section->{'summarized'} = '';
1312 # append it if it's not already there
1313 if ( !grep $tax_section, @sections ) {
1314 push @sections, $tax_section;
1315 push @summary_subtotals, $tax_section;
1320 unshift @total_items, $total;
1323 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1329 my %embolden_functions = (
1330 'latex' => sub { return '\textbf{'. shift(). '}' },
1331 'html' => sub { return '<b>'. shift(). '</b>' },
1332 'template' => sub { shift },
1334 my $embolden_function = $embolden_functions{$format};
1336 if ( $multisection ) {
1338 if ( $adjust_section->{'sort_weight'} ) {
1339 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1340 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1342 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1343 $other_money_char. sprintf('%.2f', $self->charged );
1348 if ( $self->can('_items_total') ) { # should always be true now
1350 # even for multisection, need plain text version
1352 my @new_total_items = $self->_items_total;
1354 push @buf,['','-----------'];
1356 foreach ( @new_total_items ) {
1357 my ($item, $amount) = ($_->{'total_item'}, $_->{'total_amount'});
1358 $_->{'total_item'} = &$embolden_function( $item );
1359 $_->{'total_amount'} = &$embolden_function( $other_money_char.$amount );
1360 # but if it's multisection, don't append to @total_items. the adjust
1361 # section has all this stuff
1362 push @total_items, $_ if !$multisection;
1363 push @buf, [ $item, $money_char.sprintf('%10.2f',$amount) ];
1366 push @buf, [ '', '' ];
1368 # if we're showing previous invoices, also show previous
1369 # credits and payments
1370 if ( $self->enable_previous
1371 and $self->can('_items_credits')
1372 and $self->can('_items_payments') )
1376 my $credittotal = 0;
1377 foreach my $credit (
1378 $self->_items_credits( 'template' => $template, 'trim_len' => 40 )
1382 $total->{'total_item'} = &$escape_function($credit->{'description'});
1383 $credittotal += $credit->{'amount'};
1384 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1385 if ( $multisection ) {
1386 push @detail_items, {
1387 ext_description => [],
1390 description => &$escape_function($credit->{'description'}),
1391 amount => $money_char . $credit->{'amount'},
1393 section => $adjust_section,
1396 push @total_items, $total;
1400 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1403 foreach my $credit (
1404 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1406 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1410 my $paymenttotal = 0;
1411 foreach my $payment (
1412 $self->_items_payments( 'template' => $template )
1415 $total->{'total_item'} = &$escape_function($payment->{'description'});
1416 $paymenttotal += $payment->{'amount'};
1417 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1418 if ( $multisection ) {
1419 push @detail_items, {
1420 ext_description => [],
1423 description => &$escape_function($payment->{'description'}),
1424 amount => $money_char . $payment->{'amount'},
1426 section => $adjust_section,
1429 push @total_items, $total;
1431 push @buf, [ $payment->{'description'},
1432 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1435 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1437 if ( $multisection ) {
1438 $adjust_section->{'subtotal'} = $other_money_char.
1439 sprintf('%.2f', $credittotal + $paymenttotal);
1441 #why this? because {sort_weight} forces the adjust_section to appear
1442 #in @extra_sections instead of @sections. obviously.
1443 push @sections, $adjust_section
1444 unless $adjust_section->{sort_weight};
1445 # do not summarize; adjustments there are shown according to
1449 # create Balance Due message
1452 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1453 $total->{'total_amount'} =
1454 &$embolden_function(
1455 $other_money_char. sprintf('%.2f', #why? $summarypage
1456 # ? $self->charged +
1457 # $self->billing_balance
1459 $self->owed + $pr_total
1462 if ( $multisection && !$adjust_section->{sort_weight} ) {
1463 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1464 $total->{'total_amount'};
1466 push @total_items, $total;
1468 push @buf,['','-----------'];
1469 push @buf,[$self->balance_due_msg, $money_char.
1470 sprintf("%10.2f", $balance_due ) ];
1473 if ( $conf->exists('previous_balance-show_credit')
1474 and $cust_main->balance < 0 ) {
1475 my $credit_total = {
1476 'total_item' => &$embolden_function($self->credit_balance_msg),
1477 'total_amount' => &$embolden_function(
1478 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1481 if ( $multisection ) {
1482 $adjust_section->{'posttotal'} .= $newline_token .
1483 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1486 push @total_items, $credit_total;
1488 push @buf,['','-----------'];
1489 push @buf,[$self->credit_balance_msg, $money_char.
1490 sprintf("%10.2f", -$cust_main->balance ) ];
1494 } #end of default total adding ! can('_items_total')
1496 if ( $multisection ) {
1497 if ( $conf->exists('svc_phone_sections')
1498 && $self->can('_items_svc_phone_sections')
1502 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1503 $total->{'total_amount'} =
1504 &$embolden_function(
1505 $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
1507 my $last_section = pop @sections;
1508 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1509 $total->{'total_amount'};
1510 push @sections, $last_section;
1512 push @sections, @$late_sections
1516 # make a discounts-available section, even without multisection
1517 if ( $conf->exists('discount-show_available')
1518 and my @discounts_avail = $self->_items_discounts_avail ) {
1519 my $discount_section = {
1520 'description' => $self->mt('Discounts Available'),
1525 push @sections, $discount_section; # do not summarize
1526 push @detail_items, map { +{
1527 'ref' => '', #should this be something else?
1528 'section' => $discount_section,
1529 'description' => &$escape_function( $_->{description} ),
1530 'amount' => $money_char . &$escape_function( $_->{amount} ),
1531 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1532 } } @discounts_avail;
1535 # not adding any more sections after this
1536 $invoice_data{summary_subtotals} = \@summary_subtotals;
1539 if ( $conf->exists('usage_class_summary')
1540 and $self->can('_items_usage_class_summary') ) {
1541 my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function, 'money_char' => $other_money_char);
1542 if ( @usage_subtotals ) {
1543 unshift @sections, $usage_subtotals[0]->{section}; # do not summarize
1544 unshift @detail_items, @usage_subtotals;
1548 # invoice history "section" (not really a section)
1549 # not to be included in any subtotals, completely independent of
1551 if ( $conf->exists('previous_invoice_history') and $cust_main->isa('FS::cust_main') ) {
1554 foreach my $cust_bill ( $cust_main->cust_bill ) {
1555 # XXX hardcoded format, and currently only 'charged'; add other fields
1556 # if they become necessary
1557 my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1558 $history{$date} ||= 0;
1559 $history{$date} += $cust_bill->charged;
1560 # just so we have a numeric sort key
1561 $monthorder{$date} ||= $cust_bill->_date;
1563 my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1565 my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1566 $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1569 # service locations: another option for template customization
1571 foreach my $item (@detail_items) {
1572 if ( $item->{locationnum} ) {
1573 $location_info{ $item->{locationnum} } ||= {
1574 FS::cust_location->by_key( $item->{locationnum} )->location_hash
1578 $invoice_data{location_info} = \%location_info;
1580 # debugging hook: call this with 'diag' => 1 to just get a hash of
1581 # the invoice variables
1582 return \%invoice_data if ( $params{'diag'} );
1584 # All sections and items are built; now fill in templates.
1585 my @includelist = ();
1586 push @includelist, 'summary' if $summarypage;
1587 foreach my $include ( @includelist ) {
1589 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1592 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1594 @inc_src = $conf->config($inc_file, $agentnum);
1598 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1600 my $convert_map = $convert_maps{$format}{$include};
1602 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1603 s/--\@\]/$delimiters{$format}[1]/g;
1606 &$convert_map( $conf->config($inc_file, $agentnum) );
1610 my $inc_tt = new Text::Template (
1612 SOURCE => [ map "$_\n", @inc_src ],
1613 DELIMITERS => $delimiters{$format},
1614 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1616 unless ( $inc_tt->compile() ) {
1617 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1618 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1622 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1624 $invoice_data{$include} =~ s/\n+$//
1625 if ($format eq 'latex');
1630 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1631 /invoice_lines\((\d*)\)/;
1632 $invoice_lines += $1 || scalar(@buf);
1635 die "no invoice_lines() functions in template?"
1636 if ( $format eq 'template' && !$wasfunc );
1638 if ($format eq 'template') {
1640 if ( $invoice_lines ) {
1641 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1642 $invoice_data{'total_pages'}++
1643 if scalar(@buf) % $invoice_lines;
1646 #setup subroutine for the template
1647 $invoice_data{invoice_lines} = sub {
1648 my $lines = shift || scalar(@buf);
1660 push @collect, split("\n",
1661 $text_template->fill_in( HASH => \%invoice_data )
1663 $invoice_data{'page'}++;
1665 map "$_\n", @collect;
1667 } else { # this is where we actually create the invoice
1669 if ( $params{no_addresses} ) {
1670 delete $invoice_data{$_} foreach qw(
1671 payname company address1 address2 city state zip country
1673 $invoice_data{returnaddress} = '~';
1676 warn "filling in template for invoice ". $self->invnum. "\n"
1678 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1681 $text_template->fill_in(HASH => \%invoice_data);
1685 sub notice_name { '('.shift->table.')'; }
1687 sub template_conf { 'invoice_'; }
1689 # helper routine for generating date ranges
1690 sub _prior_month30s {
1693 [ 1, 2592000 ], # 0-30 days ago
1694 [ 2592000, 5184000 ], # 30-60 days ago
1695 [ 5184000, 7776000 ], # 60-90 days ago
1696 [ 7776000, 0 ], # 90+ days ago
1699 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
1700 $_->[1] ? $self->_date - $_->[1] - 1 : '',
1705 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1707 Returns an postscript invoice, as a scalar.
1709 Options can be passed as a hashref (recommended) or as a list of time, template
1710 and then any key/value pairs for any other options.
1712 I<time> an optional value used to control the printing of overdue messages. The
1713 default is now. It isn't the date of the invoice; that's the `_date' field.
1714 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1715 L<Time::Local> and L<Date::Parse> for conversion functions.
1717 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1724 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1725 my $ps = generate_ps($file);
1727 unlink($barcodefile) if $barcodefile;
1732 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1734 Returns an PDF invoice, as a scalar.
1736 Options can be passed as a hashref (recommended) or as a list of time, template
1737 and then any key/value pairs for any other options.
1739 I<time> an optional value used to control the printing of overdue messages. The
1740 default is now. It isn't the date of the invoice; that's the `_date' field.
1741 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1742 L<Time::Local> and L<Date::Parse> for conversion functions.
1744 I<template>, if specified, is the name of a suffix for alternate invoices.
1746 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1753 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1754 my $pdf = generate_pdf($file);
1756 unlink($barcodefile) if $barcodefile;
1761 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1763 Returns an HTML invoice, as a scalar.
1765 I<time> an optional value used to control the printing of overdue messages. The
1766 default is now. It isn't the date of the invoice; that's the `_date' field.
1767 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1768 L<Time::Local> and L<Date::Parse> for conversion functions.
1770 I<template>, if specified, is the name of a suffix for alternate invoices.
1772 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1774 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1775 when emailing the invoice as part of a multipart/related MIME email.
1783 %params = %{ shift() };
1787 $params{'format'} = 'html';
1789 $self->print_generic( %params );
1792 # quick subroutine for print_latex
1794 # There are ten characters that LaTeX treats as special characters, which
1795 # means that they do not simply typeset themselves:
1796 # # $ % & ~ _ ^ \ { }
1798 # TeX ignores blanks following an escaped character; if you want a blank (as
1799 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1803 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1804 $value =~ s/([<>])/\$$1\$/g;
1810 encode_entities($value);
1814 sub _html_escape_nbsp {
1815 my $value = _html_escape(shift);
1816 $value =~ s/ +/ /g;
1820 #utility methods for print_*
1822 sub _translate_old_latex_format {
1823 warn "_translate_old_latex_format called\n"
1830 if ( $line =~ /^%%Detail\s*$/ ) {
1832 push @template, q![@--!,
1833 q! foreach my $_tr_line (@detail_items) {!,
1834 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1835 q! $_tr_line->{'description'} .= !,
1836 q! "\\tabularnewline\n~~".!,
1837 q! join( "\\tabularnewline\n~~",!,
1838 q! @{$_tr_line->{'ext_description'}}!,
1842 while ( ( my $line_item_line = shift )
1843 !~ /^%%EndDetail\s*$/ ) {
1844 $line_item_line =~ s/'/\\'/g; # nice LTS
1845 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1846 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1847 push @template, " \$OUT .= '$line_item_line';";
1850 push @template, '}',
1853 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1855 push @template, '[@--',
1856 ' foreach my $_tr_line (@total_items) {';
1858 while ( ( my $total_item_line = shift )
1859 !~ /^%%EndTotalDetails\s*$/ ) {
1860 $total_item_line =~ s/'/\\'/g; # nice LTS
1861 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1862 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1863 push @template, " \$OUT .= '$total_item_line';";
1866 push @template, '}',
1870 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1871 push @template, $line;
1877 warn "$_\n" foreach @template;
1889 my $conf = $self->conf;
1891 #check for an invoice-specific override
1892 return $self->invoice_terms if $self->invoice_terms;
1894 #check for a customer- specific override
1895 my $cust_main = $self->cust_main;
1896 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1900 $agentnum = $cust_main->agentnum;
1901 } elsif ( my $prospect_main = $self->prospect_main ) {
1902 $agentnum = $prospect_main->agentnum;
1905 #use configured default
1906 $conf->config('invoice_default_terms', $agentnum) || '';
1916 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1917 $duedate = $self->_date() + ( $1 * 86400 );
1928 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
1931 =item balance_due_msg
1935 sub balance_due_msg {
1937 my $msg = $self->mt('Balance Due');
1938 return $msg unless $self->terms; # huh?
1939 if ( !$self->conf->exists('invoice_show_prior_due_date')
1940 or $self->conf->exists('invoice_sections') ) {
1941 # if enabled, the due date is shown with Total New Charges (see
1942 # _items_total) and not here
1943 # (yes, or if invoice_sections is enabled; this is just for compatibility)
1944 if ( $self->due_date ) {
1945 $msg .= ' - ' . $self->mt('Please pay by'). ' '.
1946 $self->due_date2str('short');
1947 } elsif ( $self->terms ) {
1948 $msg .= ' - '. $self->mt($self->terms);
1954 =item balance_due_date
1958 sub balance_due_date {
1960 my $conf = $self->conf;
1962 my $terms = $self->terms;
1963 if ( $terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1964 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
1969 sub credit_balance_msg {
1971 $self->mt('Credit Balance Remaining')
1976 Returns a string with the date, for example: "3/20/2008", localized for the
1977 customer. Use _date_pretty_unlocalized for non-end-customer display use.
1983 $self->time2str_local('short', $self->_date);
1986 =item _date_pretty_unlocalized
1988 Returns a string with the date, for example: "3/20/2008", in the format
1989 configured for the back-office. Use _date_pretty for end-customer display use.
1993 sub _date_pretty_unlocalized {
1995 time2str($date_format, $self->_date);
2000 Emails this template.
2002 Options are passed as a hashref. Available options:
2008 If specified, overrides the default From: address.
2012 If specified, overrides the name of the sent document ("Invoice" or "Quotation")
2016 (Deprecated) If specified, is the name of a suffix for alternate template files.
2020 Options accepted by generate_email can also be used.
2026 my $opt = shift || {};
2027 if ($opt and !ref($opt)) {
2028 die ref($self). '->email called with positional parameters';
2031 return if $self->hide;
2033 my $error = send_email(
2034 $self->generate_email(
2035 'subject' => $self->email_subject($opt->{template}),
2036 %$opt, # template, etc.
2040 die "can't email: $error\n" if $error;
2043 =item generate_email OPTION => VALUE ...
2051 sender address, required
2055 alternate template name, optional
2059 email subject, optional
2063 notice name instead of "Invoice", optional
2067 Returns an argument list to be passed to L<FS::Misc::send_email>.
2073 sub generate_email {
2077 my $conf = $self->conf;
2079 my $me = '[FS::Template_Mixin::generate_email]';
2082 'from' => $args{'from'},
2083 'subject' => ($args{'subject'} || $self->email_subject),
2084 'custnum' => $self->custnum,
2085 'msgtype' => 'invoice',
2088 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
2090 my $cust_main = $self->cust_main;
2092 if (ref($args{'to'}) eq 'ARRAY') {
2093 $return{'to'} = $args{'to'};
2094 } elsif ( $cust_main ) {
2095 $return{'to'} = [ $cust_main->invoicing_list_emailonly ];
2098 my $tc = $self->template_conf;
2100 my @text; # array of lines
2101 my $html; # a big string
2102 my @related_parts; # will contain the text/HTML alternative, and images
2103 my $related; # will contain the multipart/related object
2105 if ( $conf->exists($tc. 'email_pdf') ) {
2106 if ( my $msgnum = $conf->config($tc.'email_pdf_msgnum') ) {
2108 warn "$me using '${tc}email_pdf_msgnum' in multipart message"
2111 my $msg_template = FS::msg_template->by_key($msgnum)
2112 or die "${tc}email_pdf_msgnum $msgnum not found\n";
2113 my %prepared = $msg_template->prepare(
2114 cust_main => $self->cust_main,
2118 @text = split(/(?=\n)/, $prepared{'text_body'});
2119 $html = $prepared{'html_body'};
2121 } elsif ( my @note = $conf->config($tc.'email_pdf_note') ) {
2123 warn "$me using '${tc}email_pdf_note' in multipart message"
2125 @text = $conf->config($tc.'email_pdf_note');
2126 $html = join('<BR>', @text);
2128 } # else use the plain text invoice
2133 if ( $conf->config($tc.'template') ) {
2135 warn "$me generating plain text invoice"
2138 # 'print_text' argument is no longer used
2139 @text = $self->print_text(\%args);
2143 warn "$me no plain text version exists; sending empty message body"
2150 my $text_part = build MIME::Entity (
2151 'Type' => 'text/plain',
2152 'Encoding' => 'quoted-printable',
2153 'Charset' => 'UTF-8',
2154 #'Encoding' => '7bit',
2156 'Disposition' => 'inline',
2161 if ( $conf->exists($tc.'html') ) {
2162 warn "$me generating HTML invoice"
2165 $args{'from'} =~ /\@([\w\.\-]+)/;
2166 my $from = $1 || 'example.com';
2167 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2170 my $agentnum = $cust_main ? $cust_main->agentnum
2171 : $self->prospect_main->agentnum;
2172 if ( defined($args{'template'}) && length($args{'template'})
2173 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
2176 $logo = 'logo_'. $args{'template'}. '.png';
2180 my $image_data = $conf->config_binary( $logo, $agentnum);
2182 push @related_parts, build MIME::Entity
2183 'Type' => 'image/png',
2184 'Encoding' => 'base64',
2185 'Data' => $image_data,
2186 'Filename' => 'logo.png',
2187 'Content-ID' => "<$content_id>",
2190 if ( ref($self) eq 'FS::cust_bill' && $conf->exists('invoice-barcode') ) {
2191 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2192 push @related_parts, build MIME::Entity
2193 'Type' => 'image/png',
2194 'Encoding' => 'base64',
2195 'Data' => $self->invoice_barcode(0),
2196 'Filename' => 'barcode.png',
2197 'Content-ID' => "<$barcode_content_id>",
2199 $args{'barcode_cid'} = $barcode_content_id;
2202 $html = $self->print_html({ 'cid'=>$content_id, %args });
2209 warn "$me creating HTML/text multipart message"
2212 $return{'nobody'} = 1;
2214 my $alternative = build MIME::Entity
2215 'Type' => 'multipart/alternative',
2216 #'Encoding' => '7bit',
2217 'Disposition' => 'inline'
2221 $alternative->add_part($text_part);
2224 $alternative->attach(
2225 'Type' => 'text/html',
2226 'Encoding' => 'quoted-printable',
2227 'Data' => [ '<html>',
2230 ' '. encode_entities($return{'subject'}),
2233 ' <body bgcolor="#e8e8e8">',
2238 'Disposition' => 'inline',
2239 #'Filename' => 'invoice.pdf',
2242 unshift @related_parts, $alternative;
2244 $related = build MIME::Entity 'Type' => 'multipart/related',
2245 'Encoding' => '7bit';
2247 #false laziness w/Misc::send_email
2248 $related->head->replace('Content-type',
2249 $related->mime_type.
2250 '; boundary="'. $related->head->multipart_boundary. '"'.
2251 '; type=multipart/alternative'
2254 $related->add_part($_) foreach @related_parts;
2258 my @otherparts = ();
2259 if ( ref($self) eq 'FS::cust_bill' && $cust_main->email_csv_cdr ) {
2261 if ( $conf->config('voip-cdr_email_attach') eq 'zip' ) {
2263 my $data = join('', map "$_\n",
2264 $self->call_details(prepend_billed_number=>1)
2267 my $zip = new Archive::Zip;
2268 my $file = $zip->addString( $data, 'usage-'.$self->invnum.'.csv' );
2269 $file->desiredCompressionMethod( COMPRESSION_DEFLATED );
2272 my $SH = IO::Scalar->new(\$zipdata);
2273 my $status = $zip->writeToFileHandle($SH);
2274 die "Error zipping CDR attachment: $!" unless $status == AZ_OK;
2276 push @otherparts, build MIME::Entity
2277 'Type' => 'application/zip',
2278 'Encoding' => 'base64',
2280 'Disposition' => 'attachment',
2281 'Filename' => 'usage-'. $self->invnum. '.zip',
2284 } else { # } elsif ( $conf->config('voip-cdr_email_attach') eq 'csv' ) {
2286 push @otherparts, build MIME::Entity
2287 'Type' => 'text/csv',
2288 'Encoding' => '7bit',
2289 'Data' => [ map { "$_\n" }
2290 $self->call_details('prepend_billed_number' => 1)
2292 'Disposition' => 'attachment',
2293 'Filename' => 'usage-'. $self->invnum. '.csv',
2300 if ( $conf->exists($tc.'email_pdf') ) {
2305 # multipart/alternative
2311 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
2312 push @otherparts, $pdf;
2316 $return{'content-type'} = 'multipart/mixed'; # of the outer container
2318 $return{'mimeparts'} = [ $related, @otherparts ];
2319 $return{'type'} = 'multipart/related'; # of the first part
2321 $return{'mimeparts'} = [ $text_part, @otherparts ];
2322 $return{'type'} = 'text/plain';
2324 } elsif ( $html ) { # no PDF or CSV, strip the outer container
2325 $return{'mimeparts'} = \@related_parts;
2326 $return{'content-type'} = 'multipart/related';
2327 $return{'type'} = 'multipart/alternative';
2328 } else { # no HTML either
2329 $return{'body'} = \@text;
2330 $return{'content-type'} = 'text/plain';
2339 Returns a list suitable for passing to MIME::Entity->build(), representing
2340 this invoice as PDF attachment.
2347 'Type' => 'application/pdf',
2348 'Encoding' => 'base64',
2349 'Data' => [ $self->print_pdf(@_) ],
2350 'Disposition' => 'attachment',
2351 'Filename' => 'invoice-'. $self->invnum. '.pdf',
2355 =item postal_mail_fsinc
2357 Sends this invoice to the Freeside Internet Services, Inc. print and mail
2363 use IO::Socket::SSL;
2365 use HTTP::Request::Common qw( POST );
2368 sub postal_mail_fsinc {
2369 my ( $self, %opt ) = @_;
2371 my $url = 'https://ws.freeside.biz/print';
2373 my $cust_main = $self->cust_main;
2374 my $agentnum = $cust_main->agentnum;
2375 my $bill_location = $cust_main->bill_location;
2377 die "Extra charges for international mailing; contact support\@freeside.biz to enable\n"
2378 if $bill_location->country ne 'US';
2380 my $conf = new FS::Conf;
2382 my @company_address = $conf->config('company_address', $agentnum);
2383 my ( $company_address1, $company_address2, $company_city, $company_state, $company_zip );
2384 if ( $company_address[2] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2385 $company_address1 = $company_address[0];
2386 $company_address2 = $company_address[1];
2388 $company_state = $2;
2390 } elsif ( $company_address[1] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2391 $company_address1 = $company_address[0];
2392 $company_address2 = '';
2394 $company_state = $2;
2397 die "Unparsable company_address; contact support\@freeside.biz\n";
2399 $company_city =~ s/,$//;
2401 my $file = $self->print_pdf(%opt, 'no_addresses' => 1);
2402 my $pages = CAM::PDF->new($file)->numPages;
2404 my $ua = LWP::UserAgent->new(
2406 verify_hostname => 0,
2407 SSL_verify_mode => IO::Socket::SSL::SSL_VERIFY_NONE,
2410 my $response = $ua->request( POST $url, [
2411 'support-key' => scalar($conf->config('support-key')),
2412 'file' => encode_base64($file),
2416 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
2417 'company_address1' => $company_address1,
2418 'company_address2' => $company_address2,
2419 'company_city' => $company_city,
2420 'company_state' => $company_state,
2421 'company_zip' => $company_zip,
2422 'company_country' => 'US',
2423 'company_phonenum' => scalar($conf->config('company_phonenum', $agentnum)),
2424 'company_email' => scalar($conf->config('invoice_from', $agentnum)),
2427 'name' => ( $cust_main->payname
2428 && $cust_main->payby !~ /^(CARD|DCRD|CHEK|DCHK)$/
2429 ? $cust_main->payname
2430 : $cust_main->contact_firstlast
2432 'company' => $cust_main->company,
2433 'address1' => $bill_location->address1,
2434 'address2' => $bill_location->address2,
2435 'city' => $bill_location->city,
2436 'state' => $bill_location->state,
2437 'zip' => $bill_location->zip,
2438 'country' => $bill_location->country,
2441 die "Print connection error: ". $response->message. "\n"
2442 unless $response->is_success;
2445 my $content = eval { decode_json($response->content) };
2446 die "Print JSON error : $@\n" if $@;
2448 die $content->{error}."\n"
2449 if $content->{error};
2451 #TODO: store this so we can query for a status later
2452 warn "Invoice printed, ID ". $content->{id}. "\n";
2457 =item _items_sections OPTIONS
2459 Generate section information for all items appearing on this invoice.
2460 This will only be called for multi-section invoices.
2462 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
2463 related display records (L<FS::cust_bill_pkg_display>) and organize
2464 them into two groups ("early" and "late" according to whether they come
2465 before or after the total), then into sections. A subtotal is calculated
2468 Section descriptions are returned in sort weight order. Each consists
2469 of a hash containing:
2471 description: the package category name, escaped
2472 subtotal: the total charges in that section
2473 tax_section: a flag indicating that the section contains only tax charges
2474 summarized: same as tax_section, for some reason
2475 sort_weight: the package category's sort weight
2477 If 'condense' is set on the display record, it also contains everything
2478 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
2479 coderefs to generate parts of the invoice. This is not advised.
2481 The method returns two arrayrefs, one of "early" sections and one of "late"
2484 OPTIONS may include:
2486 by_location: a flag to divide the invoice into sections by location.
2487 Each section hash will have a 'location' element containing a hashref of
2488 the location fields (see L<FS::cust_location>). The section description
2489 will be the location label, but the template can use any of the location
2490 fields to create a suitable label.
2492 by_category: a flag to divide the invoice into sections using display
2493 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
2494 behavior. Each section hash will have a 'category' element containing
2495 the section name from the display record (which probably equals the
2496 category name of the package, but may not in some cases).
2498 summary: a flag indicating that this is a summary-format invoice.
2499 Turning this on has the following effects:
2500 - Ignores display items with the 'summary' flag.
2501 - Places all sections in the "early" group even if they have post_total.
2502 - Creates sections for all non-disabled package categories, even if they
2503 have no charges on this invoice, as well as a section with no name.
2505 escape: an escape function to use for section titles.
2507 extra_sections: an arrayref of additional sections to return after the
2508 sorted list. If there are any of these, section subtotals exclude
2511 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
2512 passed through to C<_condense_section()>.
2516 use vars qw(%pkg_category_cache);
2517 sub _items_sections {
2521 my $escape = $opt{escape};
2522 my @extra_sections = @{ $opt{extra_sections} || [] };
2524 # $subtotal{$locationnum}{$categoryname} = amount.
2525 # if we're not using by_location, $locationnum is undef.
2526 # if we're not using by_category, you guessed it, $categoryname is undef.
2527 # if we're not using either one, we shouldn't be here in the first place...
2529 my %late_subtotal = ();
2532 # About tax items + multisection invoices:
2533 # If either invoice_*summary option is enabled, AND there is a
2534 # package category with the name of the tax, then there will be
2535 # a display record assigning the tax item to that category.
2537 # However, the taxes are always placed in the "Taxes, Surcharges,
2538 # and Fees" section regardless of that. The only effect of the
2539 # display record is to create a subtotal for the summary page.
2542 my $pkg_hash = $self->cust_pkg_hash;
2544 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2547 my $usage = $cust_bill_pkg->usage;
2550 if ( $opt{by_location} ) {
2551 if ( $cust_bill_pkg->pkgnum ) {
2552 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2557 $locationnum = undef;
2560 # as in _items_cust_pkg, if a line item has no display records,
2561 # cust_bill_pkg_display() returns a default record for it
2563 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2564 next if ( $display->summary && $opt{summary} );
2566 my $section = $display->section;
2567 my $type = $display->type;
2568 # Set $section = undef if we're sectioning by location and this
2569 # line item _has_ a location (i.e. isn't a fee).
2570 $section = undef if $locationnum;
2572 # set this flag if the section is not tax-only
2573 $not_tax{$locationnum}{$section} = 1
2574 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
2576 # there's actually a very important piece of logic buried in here:
2577 # incrementing $late_subtotal{$section} CREATES
2578 # $late_subtotal{$section}. keys(%late_subtotal) is later used
2579 # to define the list of late sections, and likewise keys(%subtotal).
2580 # When _items_cust_bill_pkg is called to generate line items for
2581 # real, it will be called with 'section' => $section for each
2583 if ( $display->post_total && !$opt{summary} ) {
2584 if (! $type || $type eq 'S') {
2585 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2586 if $cust_bill_pkg->setup != 0
2587 || $cust_bill_pkg->setup_show_zero;
2591 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
2592 if $cust_bill_pkg->recur != 0
2593 || $cust_bill_pkg->recur_show_zero;
2596 if ($type && $type eq 'R') {
2597 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2598 if $cust_bill_pkg->recur != 0
2599 || $cust_bill_pkg->recur_show_zero;
2602 if ($type && $type eq 'U') {
2603 $late_subtotal{$locationnum}{$section} += $usage
2604 unless scalar(@extra_sections);
2607 } else { # it's a pre-total (normal) section
2609 # skip tax items unless they're explicitly included in a section
2610 next if $cust_bill_pkg->pkgnum == 0 and
2611 ! $cust_bill_pkg->feepart and
2614 if ( $type eq 'S' ) {
2615 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2616 if $cust_bill_pkg->setup != 0
2617 || $cust_bill_pkg->setup_show_zero;
2618 } elsif ( $type eq 'R' ) {
2619 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2620 if $cust_bill_pkg->recur != 0
2621 || $cust_bill_pkg->recur_show_zero;
2622 } elsif ( $type eq 'U' ) {
2623 $subtotal{$locationnum}{$section} += $usage
2624 unless scalar(@extra_sections);
2625 } elsif ( !$type ) {
2626 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2627 + $cust_bill_pkg->recur;
2636 %pkg_category_cache = ();
2638 # summary invoices need subtotals for all non-disabled package categories,
2639 # even if they're zero
2640 # but currently assume that there are no location sections, or at least
2641 # that the summary page doesn't care about them
2642 if ( $opt{summary} ) {
2643 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2644 $subtotal{''}{$category->categoryname} ||= 0;
2646 $subtotal{''}{''} ||= 0;
2650 foreach my $post_total (0,1) {
2652 my $s = $post_total ? \%late_subtotal : \%subtotal;
2653 foreach my $locationnum (keys %$s) {
2654 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2656 'subtotal' => $s->{$locationnum}{$sectionname},
2659 if ( $locationnum ) {
2660 $section->{'locationnum'} = $locationnum;
2661 my $location = FS::cust_location->by_key($locationnum);
2662 $section->{'description'} = &{ $escape }($location->location_label);
2663 # Better ideas? This will roughly group them by proximity,
2664 # which alpha sorting on any of the address fields won't.
2665 # Sorting by locationnum is meaningless.
2666 # We have to sort on _something_ or the order may change
2667 # randomly from one invoice to the next, which will confuse
2669 $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
2671 $section->{'location'} = {
2672 label_prefix => &{ $escape }($location->label_prefix),
2673 map { $_ => &{ $escape }($location->get($_)) }
2677 $section->{'category'} = $sectionname;
2678 $section->{'description'} = &{ $escape }($sectionname);
2679 if ( _pkg_category($sectionname) ) {
2680 $section->{'sort_weight'} = _pkg_category($sectionname)->weight;
2681 if ( _pkg_category($sectionname)->condense ) {
2682 $section = { %$section, $self->_condense_section($opt{format}) };
2686 if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
2687 # then it's a tax-only section
2688 $section->{'summarized'} = 'Y';
2689 $section->{'tax_section'} = 'Y';
2691 push @these, $section;
2692 } # foreach $sectionname
2693 } #foreach $locationnum
2694 push @these, @extra_sections if $post_total == 0;
2695 # need an alpha sort for location sections, because postal codes can
2697 $sections[ $post_total ] = [ sort {
2698 $opt{'by_location'} ?
2699 ($a->{sort_weight} cmp $b->{sort_weight}) :
2700 ($a->{sort_weight} <=> $b->{sort_weight})
2702 } #foreach $post_total
2704 return @sections; # early, late
2707 #helper subs for above
2711 $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2715 my $categoryname = shift;
2716 $pkg_category_cache{$categoryname} ||=
2717 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2720 my %condensed_format = (
2721 'label' => [ qw( Description Qty Amount ) ],
2723 sub { shift->{description} },
2724 sub { shift->{quantity} },
2725 sub { my($href, %opt) = @_;
2726 ($opt{dollar} || ''). $href->{amount};
2729 'align' => [ qw( l r r ) ],
2730 'span' => [ qw( 5 1 1 ) ], # unitprices?
2731 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
2734 sub _condense_section {
2735 my ( $self, $format ) = ( shift, shift );
2737 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2738 qw( description_generator
2741 total_line_generator
2746 sub _condensed_generator_defaults {
2747 my ( $self, $format ) = ( shift, shift );
2748 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2757 sub _condensed_header_generator {
2758 my ( $self, $format ) = ( shift, shift );
2760 my ( $f, $prefix, $suffix, $separator, $column ) =
2761 _condensed_generator_defaults($format);
2763 if ($format eq 'latex') {
2764 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2765 $suffix = "\\\\\n\\hline";
2768 sub { my ($d,$a,$s,$w) = @_;
2769 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2771 } elsif ( $format eq 'html' ) {
2772 $prefix = '<th></th>';
2776 sub { my ($d,$a,$s,$w) = @_;
2777 return qq!<th align="$html_align{$a}">$d</th>!;
2785 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2787 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2790 $prefix. join($separator, @result). $suffix;
2795 sub _condensed_description_generator {
2796 my ( $self, $format ) = ( shift, shift );
2798 my ( $f, $prefix, $suffix, $separator, $column ) =
2799 _condensed_generator_defaults($format);
2801 my $money_char = '$';
2802 if ($format eq 'latex') {
2803 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2805 $separator = " & \n";
2807 sub { my ($d,$a,$s,$w) = @_;
2808 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2810 $money_char = '\\dollar';
2811 }elsif ( $format eq 'html' ) {
2812 $prefix = '"><td align="center"></td>';
2816 sub { my ($d,$a,$s,$w) = @_;
2817 return qq!<td align="$html_align{$a}">$d</td>!;
2819 #$money_char = $conf->config('money_char') || '$';
2820 $money_char = ''; # this is madness
2828 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2830 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2832 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2833 map { $f->{$_}->[$i] } qw(align span width)
2837 $prefix. join( $separator, @result ). $suffix;
2842 sub _condensed_total_generator {
2843 my ( $self, $format ) = ( shift, shift );
2845 my ( $f, $prefix, $suffix, $separator, $column ) =
2846 _condensed_generator_defaults($format);
2849 if ($format eq 'latex') {
2852 $separator = " & \n";
2854 sub { my ($d,$a,$s,$w) = @_;
2855 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2857 }elsif ( $format eq 'html' ) {
2861 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2863 sub { my ($d,$a,$s,$w) = @_;
2864 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2873 # my $r = &{$f->{fields}->[$i]}(@args);
2874 # $r .= ' Total' unless $i;
2876 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2878 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
2879 map { $f->{$_}->[$i] } qw(align span width)
2883 $prefix. join( $separator, @result ). $suffix;
2888 =item total_line_generator FORMAT
2890 Returns a coderef used for generation of invoice total line items for this
2891 usage_class. FORMAT is either html or latex
2895 # should not be used: will have issues with hash element names (description vs
2896 # total_item and amount vs total_amount -- another array of functions?
2898 sub _condensed_total_line_generator {
2899 my ( $self, $format ) = ( shift, shift );
2901 my ( $f, $prefix, $suffix, $separator, $column ) =
2902 _condensed_generator_defaults($format);
2905 if ($format eq 'latex') {
2908 $separator = " & \n";
2910 sub { my ($d,$a,$s,$w) = @_;
2911 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2913 }elsif ( $format eq 'html' ) {
2917 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2919 sub { my ($d,$a,$s,$w) = @_;
2920 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2929 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2931 &{$column}( &{$f->{fields}->[$i]}(@args),
2932 map { $f->{$_}->[$i] } qw(align span width)
2936 $prefix. join( $separator, @result ). $suffix;
2941 =item _items_pkg [ OPTIONS ]
2943 Return line item hashes for each package item on this invoice. Nearly
2946 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
2948 OPTIONS are passed through to _items_cust_bill_pkg, and should include
2949 'format' and 'escape_function' at minimum.
2951 To produce items for a specific invoice section, OPTIONS should include
2952 'section', a hashref containing 'category' and/or 'locationnum' keys.
2954 'section' may also contain a key named 'condensed'. If this is present
2955 and has a true value, _items_pkg will try to merge identical items into items
2956 with 'quantity' equal to the number of items (not the sum of their separate
2957 quantities, for some reason).
2963 # The order of these is important. Bundled line items will be merged into
2964 # the most recent non-hidden item, so it needs to be the one with:
2966 # - the same start date
2967 # - no pkgpart_override
2969 # So: sort by pkgnum,
2971 # then sort the base line item before any overrides
2972 # then sort hidden before non-hidden add-ons
2973 # then sort by override pkgpart (for consistency)
2974 sort { $a->pkgnum <=> $b->pkgnum or
2975 $a->sdate <=> $b->sdate or
2976 ($a->pkgpart_override ? 0 : -1) or
2977 ($b->pkgpart_override ? 0 : 1) or
2978 $b->hidden cmp $a->hidden or
2979 $a->pkgpart_override <=> $b->pkgpart_override
2981 # and of course exclude taxes and fees
2982 grep { $_->pkgnum > 0 } $self->cust_bill_pkg;
2988 my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
2989 my $escape_function = $options{escape_function};
2992 foreach my $cust_bill_pkg (@cust_bill_pkg) {
2993 # cache this, so we don't look it up again in every section
2994 my $part_fee = $cust_bill_pkg->get('part_fee')
2995 || $cust_bill_pkg->part_fee;
2996 $cust_bill_pkg->set('part_fee', $part_fee);
2998 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
2999 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
3002 if ( exists($options{section}) and exists($options{section}{category}) )
3004 my $categoryname = $options{section}{category};
3005 # then filter for items that have that section
3006 if ( $part_fee->categoryname ne $categoryname ) {
3007 warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
3010 } # otherwise include them all in the main section
3011 # XXX what to do when sectioning by location?
3014 my %base_invnums; # invnum => invoice date
3015 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
3016 if ($_->base_invnum) {
3017 # XXX what if base_bill has been voided?
3018 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
3019 my $base_date = $self->time2str_local('short', $base_bill->_date)
3021 $base_invnums{$_->base_invnum} = $base_date || '';
3024 foreach (sort keys(%base_invnums)) {
3025 next if $_ == $self->invnum;
3026 # per convention, we must escape ext_description lines
3028 &{$escape_function}(
3029 $self->mt('from invoice #[_1] on [_2]', $_, $base_invnums{$_})
3032 my $desc = $part_fee->itemdesc_locale($self->cust_main->locale);
3033 # but not escape the base description line
3036 { feepart => $cust_bill_pkg->feepart,
3037 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
3038 description => $desc,
3039 ext_description => \@ext_desc
3050 warn "$me _items_pkg searching for all package line items\n"
3053 my @cust_bill_pkg = $self->_items_nontax;
3055 warn "$me _items_pkg filtering line items\n"
3057 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3059 if ($options{section} && $options{section}->{condensed}) {
3061 warn "$me _items_pkg condensing section\n"
3065 local $Storable::canonical = 1;
3066 foreach ( @items ) {
3068 delete $item->{ref};
3069 delete $item->{ext_description};
3070 my $key = freeze($item);
3071 $itemshash{$key} ||= 0;
3072 $itemshash{$key} ++; # += $item->{quantity};
3074 @items = sort { $a->{description} cmp $b->{description} }
3075 map { my $i = thaw($_);
3076 $i->{quantity} = $itemshash{$_};
3078 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
3084 warn "$me _items_pkg returning ". scalar(@items). " items\n"
3091 return 0 unless $a->itemdesc cmp $b->itemdesc;
3092 return -1 if $b->itemdesc eq 'Tax';
3093 return 1 if $a->itemdesc eq 'Tax';
3094 return -1 if $b->itemdesc eq 'Other surcharges';
3095 return 1 if $a->itemdesc eq 'Other surcharges';
3096 $a->itemdesc cmp $b->itemdesc;
3101 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
3102 $self->cust_bill_pkg;
3103 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3105 if ( $self->conf->exists('always_show_tax') ) {
3106 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
3107 if (0 == grep { $_->{description} eq $itemdesc } @items) {
3109 { 'description' => $itemdesc,
3116 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
3118 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
3119 list of hashrefs describing the line items they generate on the invoice.
3121 OPTIONS may include:
3123 format: the invoice format.
3125 escape_function: the function used to escape strings.
3127 DEPRECATED? (expensive, mostly unused?)
3128 format_function: the function used to format CDRs.
3130 section: a hashref containing 'category' and/or 'locationnum'; if this
3131 is present, only returns line items that belong to that category and/or
3132 location (whichever is defined).
3134 multisection: a flag indicating that this is a multisection invoice,
3135 which does something complicated.
3137 preref_callback: coderef run for each line item, code should return HTML to be
3138 displayed before that line item (quotations only)
3140 Returns a list of hashrefs, each of which may contain:
3142 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
3143 ext_description, which is an arrayref of detail lines to show below
3148 sub _items_cust_bill_pkg {
3150 my $conf = $self->conf;
3151 my $cust_bill_pkgs = shift;
3154 my $format = $opt{format} || '';
3155 my $escape_function = $opt{escape_function} || sub { shift };
3156 my $format_function = $opt{format_function} || '';
3157 my $no_usage = $opt{no_usage} || '';
3158 my $unsquelched = $opt{unsquelched} || ''; #unused
3159 my ($section, $locationnum, $category);
3160 if ( $opt{section} ) {
3161 $category = $opt{section}->{category};
3162 $locationnum = $opt{section}->{locationnum};
3164 my $summary_page = $opt{summary_page} || ''; #unused
3165 my $multisection = defined($category) || defined($locationnum);
3166 # this variable is the value of the config setting, not whether it applies
3167 # to this particular line item.
3168 my $discount_show_always = $conf->exists('discount-show-always');
3170 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 40;
3172 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
3174 # for location labels: use default location on the invoice date
3175 my $default_locationnum;
3176 if ( $self->custnum ) {
3178 my @h_search = FS::h_cust_main->sql_h_search($self->_date);
3179 $h_cust_main = qsearchs({
3180 'table' => 'h_cust_main',
3181 'hashref' => { custnum => $self->custnum },
3182 'extra_sql' => $h_search[1],
3183 'addl_from' => $h_search[3],
3185 $default_locationnum = $h_cust_main->ship_locationnum;
3186 } elsif ( $self->prospectnum ) {
3187 my $cust_location = qsearchs('cust_location',
3188 { prospectnum => $self->prospectnum,
3190 $default_locationnum = $cust_location->locationnum if $cust_location;
3193 my @b = (); # accumulator for the line item hashes that we'll return
3194 my ($s, $r, $u, $d) = ( undef, undef, undef, undef );
3195 # the 'current' line item hashes for setup, recur, usage, discount
3196 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
3198 # if the current line item is waiting to go out, and the one we're about
3199 # to start is not bundled, then push out the current one and start a new
3201 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3202 if ( $_ && !$cust_bill_pkg->hidden ) {
3203 $_->{amount} = sprintf( "%.2f", $_->{amount} );
3204 $_->{amount} =~ s/^\-0\.00$/0.00/;
3205 if (exists($_->{unit_amount})) {
3206 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3209 # we already decided to create this display line; don't reconsider it
3211 # if $_->{amount} != 0
3212 # || $discount_show_always
3213 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3214 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3220 if ( $locationnum ) {
3221 # this is a location section; skip packages that aren't at this
3223 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
3224 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
3228 # Consider display records for this item to determine if it belongs
3229 # in this section. Note that if there are no display records, there
3230 # will be a default pseudo-record that includes all charge types
3231 # and has no section name.
3232 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
3233 ? $cust_bill_pkg->cust_bill_pkg_display
3234 : ( $cust_bill_pkg );
3236 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
3237 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
3240 if ( defined($category) ) {
3241 # then this is a package category section; process all display records
3242 # that belong to this section.
3243 @cust_bill_pkg_display = grep { $_->section eq $category }
3244 @cust_bill_pkg_display;
3246 # otherwise, process all display records that aren't usage summaries
3247 # (I don't think there should be usage summaries if you aren't using
3248 # category sections, but this is the historical behavior)
3249 @cust_bill_pkg_display = grep { !$_->summary }
3250 @cust_bill_pkg_display;
3253 my $classname = ''; # package class name, will fill in later
3255 foreach my $display (@cust_bill_pkg_display) {
3257 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
3258 $display->billpkgdisplaynum. "\n"
3261 my $type = $display->type;
3263 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
3264 $desc = substr($desc, 0, $maxlength). '...'
3265 if $format eq 'latex' && length($desc) > $maxlength;
3267 my %details_opt = ( 'format' => $format,
3268 'escape_function' => $escape_function,
3269 'format_function' => $format_function,
3270 'no_usage' => $opt{'no_usage'},
3273 if ( ref($cust_bill_pkg) eq 'FS::quotation_pkg' ) {
3274 # XXX this should be pulled out into quotation_pkg
3276 warn "$me _items_cust_bill_pkg cust_bill_pkg is quotation_pkg\n"
3278 # quotation_pkgs are never fees, so don't worry about the case where
3279 # part_pkg is undefined
3281 my @details = $cust_bill_pkg->details;
3283 # and I guess they're never bundled either?
3284 if ( $cust_bill_pkg->setup != 0 ) {
3285 my $description = $desc;
3286 $description .= ' Setup'
3287 if $cust_bill_pkg->recur != 0
3288 || $discount_show_always
3289 || $cust_bill_pkg->recur_show_zero;
3291 # keep it consistent, please
3293 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3294 'description' => $description,
3295 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
3296 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitsetup),
3297 'quantity' => $cust_bill_pkg->quantity,
3298 'ext_description' => \@details,
3299 'preref_html' => ( $opt{preref_callback}
3300 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3305 if ( $cust_bill_pkg->recur != 0 ) {
3308 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3309 'description' => "$desc (". $cust_bill_pkg->part_pkg->freq_pretty.")",
3310 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
3311 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitrecur),
3312 'quantity' => $cust_bill_pkg->quantity,
3313 'ext_description' => \@details,
3314 'preref_html' => ( $opt{preref_callback}
3315 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3321 } elsif ( $cust_bill_pkg->pkgnum > 0 ) {
3322 # a "normal" package line item (not a quotation, not a fee, not a tax)
3324 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
3327 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3328 my $part_pkg = $cust_pkg->part_pkg;
3330 # which pkgpart to show for display purposes?
3331 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
3333 # start/end dates for invoice formats that do nonstandard
3335 my %item_dates = ();
3336 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
3337 unless $part_pkg->option('disable_line_item_date_ranges',1);
3339 # not normally used, but pass this to the template anyway
3340 $classname = $part_pkg->classname;
3342 if ( (!$type || $type eq 'S')
3343 && ( $cust_bill_pkg->setup != 0
3344 || $cust_bill_pkg->setup_show_zero
3345 || ($discount_show_always and $cust_bill_pkg->unitsetup > 0)
3350 warn "$me _items_cust_bill_pkg adding setup\n"
3353 # append the word 'Setup' to the setup line if there's going to be
3354 # a recur line for the same package (i.e. not a one-time charge)
3355 my $description = $desc;
3356 $description .= ' Setup'
3357 if $cust_bill_pkg->recur != 0
3358 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3359 || $cust_bill_pkg->recur_show_zero;
3361 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3363 if $part_pkg->is_prepaid #for prepaid, "display the validity period
3364 # triggered by the recurring charge freq
3366 && $cust_bill_pkg->recur == 0
3367 && ! $cust_bill_pkg->recur_show_zero;
3372 # always pass the svc_label through to the template, even if
3373 # not displaying it as an ext_description
3374 my @svc_labels = map &{$escape_function}($_),
3375 $cust_pkg->h_labels_short($self->_date, undef, 'I');
3377 $svc_label = $svc_labels[0];
3379 unless ( $cust_pkg->part_pkg->hide_svc_detail
3380 || $cust_bill_pkg->hidden )
3383 push @d, @svc_labels
3384 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3385 # show the location label if it's not the customer's default
3386 # location, and we're not grouping items by location already
3387 if ( $cust_pkg->locationnum != $default_locationnum
3388 and !defined($locationnum) ) {
3389 my $loc = $cust_pkg->location_label;
3390 $loc = substr($loc, 0, $maxlength). '...'
3391 if $format eq 'latex' && length($loc) > $maxlength;
3392 push @d, &{$escape_function}($loc);
3395 } #unless hiding service details
3397 push @d, $cust_bill_pkg->details(%details_opt)
3398 if $cust_bill_pkg->recur == 0;
3400 if ( $cust_bill_pkg->hidden ) {
3401 $s->{amount} += $cust_bill_pkg->setup;
3402 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3403 push @{ $s->{ext_description} }, @d;
3407 description => $description,
3408 pkgpart => $pkgpart,
3409 pkgnum => $cust_bill_pkg->pkgnum,
3410 amount => $cust_bill_pkg->setup,
3411 setup_show_zero => $cust_bill_pkg->setup_show_zero,
3412 unit_amount => $cust_bill_pkg->unitsetup,
3413 quantity => $cust_bill_pkg->quantity,
3414 ext_description => \@d,
3415 svc_label => ($svc_label || ''),
3416 locationnum => $cust_pkg->locationnum, # sure, why not?
3422 # should we show a recur line?
3423 # if type eq 'S', then NO, because we've been told not to.
3424 # otherwise, show the recur line if:
3425 # - there's a recurring charge
3426 # - or recur_show_zero is on
3427 # - or there's a positive unitrecur (so it's been discounted to zero)
3428 # and discount-show-always is on
3429 if ( ( !$type || $type eq 'R' || $type eq 'U' )
3431 $cust_bill_pkg->recur != 0
3433 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3434 || $cust_bill_pkg->recur_show_zero
3439 warn "$me _items_cust_bill_pkg adding recur/usage\n"
3442 my $is_summary = $display->summary;
3443 my $description = $desc;
3444 if ( $type eq 'U' and defined($r) ) {
3445 # don't just show the same description as the recur line
3446 $description = $self->mt('Usage charges');
3449 my $part_pkg = $cust_pkg->part_pkg;
3451 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3455 my @seconds = (); # for display of usage info
3458 #at least until cust_bill_pkg has "past" ranges in addition to
3459 #the "future" sdate/edate ones... see #3032
3460 my @dates = ( $self->_date );
3461 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
3462 push @dates, $prev->sdate if $prev;
3463 push @dates, undef if !$prev;
3465 my @svc_labels = map &{$escape_function}($_),
3466 $cust_pkg->h_labels_short(@dates, 'I');
3467 $svc_label = $svc_labels[0];
3469 # show service labels, unless...
3470 # the package is set not to display them
3471 unless ( $part_pkg->hide_svc_detail
3472 # or this is a tax-like line item
3473 || $cust_bill_pkg->itemdesc
3474 # or this is a hidden (bundled) line item
3475 || $cust_bill_pkg->hidden
3476 # or this is a usage summary line
3477 || $is_summary && $type && $type eq 'U'
3478 # or this is a usage line and there's a recurring line
3479 # for the package in the same section (which will
3480 # have service labels already)
3481 || ($type eq 'U' and defined($r))
3485 warn "$me _items_cust_bill_pkg adding service details\n"
3488 push @d, @svc_labels
3489 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3490 warn "$me _items_cust_bill_pkg done adding service details\n"
3493 # show the location label if it's not the customer's default
3494 # location, and we're not grouping items by location already
3495 if ( $cust_pkg->locationnum != $default_locationnum
3496 and !defined($locationnum) ) {
3497 my $loc = $cust_pkg->location_label;
3498 $loc = substr($loc, 0, $maxlength). '...'
3499 if $format eq 'latex' && length($loc) > $maxlength;
3500 push @d, &{$escape_function}($loc);
3503 # Display of seconds_since_sqlradacct:
3504 # On the invoice, when processing @detail_items, look for a field
3505 # named 'seconds'. This will contain total seconds for each
3506 # service, in the same order as @ext_description. For services
3507 # that don't support this it will show undef.
3508 if ( $conf->exists('svc_acct-usage_seconds')
3509 and ! $cust_bill_pkg->pkgpart_override ) {
3510 foreach my $cust_svc (
3511 $cust_pkg->h_cust_svc(@dates, 'I')
3514 # eval because not having any part_export_usage exports
3515 # is a fatal error, last_bill/_date because that's how
3516 # sqlradius_hour billing does it
3518 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
3520 push @seconds, $sec;
3522 } #if svc_acct-usage_seconds
3524 } # if we are showing service labels
3526 unless ( $is_summary ) {
3527 warn "$me _items_cust_bill_pkg adding details\n"
3530 #instead of omitting details entirely in this case (unwanted side
3531 # effects), just omit CDRs
3532 $details_opt{'no_usage'} = 1
3533 if $type && $type eq 'R';
3535 push @d, $cust_bill_pkg->details(%details_opt);
3538 warn "$me _items_cust_bill_pkg calculating amount\n"
3543 $amount = $cust_bill_pkg->recur;
3544 } elsif ($type eq 'R') {
3545 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
3546 } elsif ($type eq 'U') {
3547 $amount = $cust_bill_pkg->usage;
3550 if ( !$type || $type eq 'R' ) {
3552 warn "$me _items_cust_bill_pkg adding recur\n"
3556 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
3559 if ( $cust_bill_pkg->hidden ) {
3560 $r->{amount} += $amount;
3561 $r->{unit_amount} += $unit_amount;
3562 push @{ $r->{ext_description} }, @d;
3565 description => $description,
3566 pkgpart => $pkgpart,
3567 pkgnum => $cust_bill_pkg->pkgnum,
3569 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3570 unit_amount => $unit_amount,
3571 quantity => $cust_bill_pkg->quantity,
3573 ext_description => \@d,
3574 svc_label => ($svc_label || ''),
3575 locationnum => $cust_pkg->locationnum,
3577 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3580 } else { # $type eq 'U'
3582 warn "$me _items_cust_bill_pkg adding usage\n"
3585 if ( $cust_bill_pkg->hidden and defined($u) ) {
3586 # if this is a hidden package and there's already a usage
3587 # line for the bundle, add this package's total amount and
3588 # usage details to it
3589 $u->{amount} += $amount;
3590 push @{ $u->{ext_description} }, @d;
3591 } elsif ( $amount ) {
3592 # create a new usage line
3594 description => $description,
3595 pkgpart => $pkgpart,
3596 pkgnum => $cust_bill_pkg->pkgnum,
3599 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3601 ext_description => \@d,
3602 locationnum => $cust_pkg->locationnum,
3604 } # else this has no usage, so don't create a usage section
3607 } # recurring or usage with recurring charge
3609 } else { # taxes and fees
3611 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3614 # items of this kind should normally not have sdate/edate.
3616 'description' => $desc,
3617 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
3618 + $cust_bill_pkg->recur)
3621 } # if quotation / package line item / other line item
3623 # decide whether to show active discounts here
3625 # case 1: we are showing a single line for the package
3627 # case 2: we are showing a setup line for a package that has
3628 # no base recurring fee
3629 or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3630 # case 3: we are showing a recur line for a package that has
3631 # a base recurring fee
3632 or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3635 my $item_discount = $cust_bill_pkg->_item_discount;
3636 if ( $item_discount ) {
3637 # $item_discount->{amount} is negative
3639 if ( $d and $cust_bill_pkg->hidden ) {
3640 $d->{amount} += $item_discount->{amount};
3642 $d = $item_discount;
3643 $_ = &{$escape_function}($_) foreach @{ $d->{ext_description} };
3646 # update the active line (before the discount) to show the
3647 # original price (whether this is a hidden line or not)
3649 # quotation discounts keep track of setup and recur; invoice
3650 # discounts currently don't
3651 if ( exists $item_discount->{setup_amount} ) {
3653 $s->{amount} -= $item_discount->{setup_amount} if $s;
3654 $r->{amount} -= $item_discount->{recur_amount} if $r;
3658 # $active_line is the line item hashref for the line that will
3659 # show the original price
3660 # (use the recur or single line for the package, unless we're
3661 # showing a setup line for a package with no recurring fee)
3662 my $active_line = $r;
3663 if ( $type eq 'S' ) {
3666 $active_line->{amount} -= $item_discount->{amount};
3670 } # if there are any discounts
3671 } # if this is an appropriate place to show discounts
3673 } # foreach $display
3677 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3679 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3680 if exists($_->{amount});
3681 $_->{amount} =~ s/^\-0\.00$/0.00/;
3682 if (exists($_->{unit_amount})) {
3683 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3687 #if $_->{amount} != 0
3688 # || $discount_show_always
3689 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3690 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3694 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3701 =item _items_discounts_avail
3703 Returns an array of line item hashrefs representing available term discounts
3704 for this invoice. This makes the same assumptions that apply to term
3705 discounts in general: that the package is billed monthly, at a flat rate,
3706 with no usage charges. A prorated first month will be handled, as will
3707 a setup fee if the discount is allowed to apply to setup fees.
3711 sub _items_discounts_avail {
3714 #maybe move this method from cust_bill when quotations support discount_plans
3715 return () unless $self->can('discount_plans');
3716 my %plans = $self->discount_plans;
3718 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3719 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3723 my $plan = $plans{$months};
3725 my $term_total = sprintf('%.2f', $plan->discounted_total);
3726 my $percent = sprintf('%.0f',
3727 100 * (1 - $term_total / $plan->base_total) );
3728 my $permonth = sprintf('%.2f', $term_total / $months);
3729 my $detail = $self->mt('discount on item'). ' '.
3730 join(', ', map { "#$_" } $plan->pkgnums)
3733 # discounts for non-integer months don't work anyway
3734 $months = sprintf("%d", $months);
3737 description => $self->mt('Save [_1]% by paying for [_2] months',
3739 amount => $self->mt('[_1] ([_2] per month)',
3740 $term_total, $money_char.$permonth),
3741 ext_description => ($detail || ''),
3744 sort { $b <=> $a } keys %plans;