1 package FS::Template_Mixin;
4 use vars qw( $DEBUG $me
9 use vars qw( $invoice_lines @buf ); #yuck
10 use List::Util qw(sum); #can't import first, it conflicts with cust_main.first
13 use Time::Local qw( timelocal );
14 use Text::Template 1.20;
16 use Archive::Zip qw( :ERROR_CODES :CONSTANTS );
21 use FS::Misc qw( send_email );
22 use FS::Record qw( qsearch qsearchs );
24 use FS::Misc qw( generate_ps generate_pdf );
31 $me = '[FS::Template_Mixin]';
32 FS::UID->install_callback( sub {
33 my $conf = new FS::Conf; #global
34 $money_char = $conf->config('money_char') || '$';
35 $date_format = $conf->config('date_format') || '%x'; #/YY
40 Returns a configuration handle (L<FS::Conf>) set to the customer's locale.
42 If the "mode" pseudo-field is set on the object, the configuration handle
43 will be an L<FS::invoice_conf> for that invoice mode (and the customer's
50 my $mode = $self->get('mode');
51 if ($self->{_conf} and !defined($mode)) {
52 return $self->{_conf};
55 my $cust_main = $self->cust_main;
56 my $locale = $cust_main ? $cust_main->locale : '';
59 if ( ref $mode and $mode->isa('FS::invoice_mode') ) {
60 $mode = $mode->modenum;
61 } elsif ( $mode =~ /\D/ ) {
62 die "invalid invoice mode $mode";
64 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => $locale });
66 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => '' });
67 # it doesn't have a locale, but system conf still might
68 $conf->set('locale' => $locale) if $conf;
71 # if $mode is unspecified, or if there is no invoice_conf matching this mode
72 # and locale, then use the system config only (but with the locale)
73 $conf ||= FS::Conf->new({ 'locale' => $locale });
75 return $self->{_conf} = $conf;
78 =item print_text OPTIONS
80 Returns an text invoice, as a list of lines.
82 Options can be passed as a hash.
84 I<time>, if specified, is used to control the printing of overdue messages. The
85 default is now. It isn't the date of the invoice; that's the `_date' field.
86 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
87 L<Time::Local> and L<Date::Parse> for conversion functions.
89 I<template>, if specified, is the name of a suffix for alternate invoices.
91 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
99 %params = %{ shift() };
104 $params{'format'} = 'template'; # for some reason
106 $self->print_generic( %params );
109 =item print_latex HASHREF
111 Internal method - returns a filename of a filled-in LaTeX template for this
112 invoice (Note: add ".tex" to get the actual filename), and a filename of
113 an associated logo (with the .eps extension included).
115 See print_ps and print_pdf for methods that return PostScript and PDF output.
117 Options can be passed as a hash.
119 I<time>, if specified, is used to control the printing of overdue messages. The
120 default is now. It isn't the date of the invoice; that's the `_date' field.
121 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
122 L<Time::Local> and L<Date::Parse> for conversion functions.
124 I<template>, if specified, is the name of a suffix for alternate invoices.
125 This is strongly deprecated; see L<FS::invoice_conf> for the right way to
126 customize invoice templates for different purposes.
128 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
137 %params = %{ shift() };
142 $params{'format'} = 'latex';
143 my $conf = $self->conf;
145 # this needs to go away
146 my $template = $params{'template'};
147 # and this especially
148 $template ||= $self->_agent_template
149 if $self->can('_agent_template');
152 $self->set('mode', $params{mode})
155 my $pkey = $self->primary_key;
156 my $tmp_template = $self->table. '.'. $self->$pkey. '.XXXXXXXX';
158 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
159 my $lh = new File::Temp(
160 TEMPLATE => $tmp_template,
164 ) or die "can't open temp file: $!\n";
166 my $agentnum = $self->agentnum;
168 if ( $template && $conf->exists("logo_${template}.eps", $agentnum) ) {
169 print $lh $conf->config_binary("logo_${template}.eps", $agentnum)
170 or die "can't write temp file: $!\n";
172 print $lh $conf->config_binary('logo.eps', $agentnum)
173 or die "can't write temp file: $!\n";
176 $params{'logo_file'} = $lh->filename;
178 if( $conf->exists('invoice-barcode')
179 && $self->can('invoice_barcode')
180 && $self->invnum ) { # don't try to barcode statements
181 my $png_file = $self->invoice_barcode($dir);
182 my $eps_file = $png_file;
183 $eps_file =~ s/\.png$/.eps/g;
184 $png_file =~ /(barcode.*png)/;
186 $eps_file =~ /(barcode.*eps)/;
189 my $curr_dir = cwd();
191 # after painfuly long experimentation, it was determined that sam2p won't
192 # accept : and other chars in the path, no matter how hard I tried to
193 # escape them, hence the chdir (and chdir back, just to be safe)
194 system('sam2p', '-j:quiet', $png_file, 'EPS:', $eps_file ) == 0
195 or die "sam2p failed: $!\n";
199 $params{'barcode_file'} = $eps_file;
202 my @filled_in = $self->print_generic( %params );
204 my $fh = new File::Temp( TEMPLATE => $tmp_template,
208 ) or die "can't open temp file: $!\n";
209 binmode($fh, ':utf8'); # language support
210 print $fh join('', @filled_in );
213 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
214 return ($1, $params{'logo_file'}, $params{'barcode_file'});
220 my $cust_main = $self->cust_main;
221 $cust_main ? $cust_main->agentnum : $self->prospect_main->agentnum;
224 =item print_generic OPTION => VALUE ...
226 Internal method - returns a filled-in template for this invoice as a scalar.
228 See print_ps and print_pdf for methods that return PostScript and PDF output.
236 The B<format> option is required and should be set to html, latex (print and PDF) or template (plaintext).
246 Overrides "Invoice" as the name of the sent document.
250 Used to control the printing of overdue messages. The
251 default is now. It isn't the date of the invoice; that's the `_date' field.
252 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
253 L<Time::Local> and L<Date::Parse> for conversion functions.
257 Logo file (path to temporary EPS file on the local filesystem)
261 CID for inline (emailed) images (logo)
265 Override customer's locale
269 Overrides any per customer cdr squelching when true
273 Supress the (invoice, quotation, statement, etc.) number
281 Supress the payment coupon
285 Barcode file (path to temporary EPS file on the local filesystem)
289 Flag indicating the barcode image should be a link (normal HTML dipaly)
293 Barcode CID for inline (emailed) images
295 =item preref_callback
297 Coderef run for each line item, code should return HTML to be displayed
298 before that line item (quotations only)
302 Dprecated. Used as a suffix for a configuration template. Please
303 don't use this, it deprecated in favor of more flexible alternatives.
309 #what's with all the sprintf('%10.2f')'s in here? will it cause any
310 # (alignment in text invoice?) problems to change them all to '%.2f' ?
311 # yes: fixed width/plain text printing will be borked
313 my( $self, %params ) = @_;
314 my $conf = $self->conf;
316 my $today = $params{today} ? $params{today} : time;
317 warn "$me print_generic called on $self with suffix $params{template}\n"
320 my $format = $params{format};
321 die "Unknown format: $format"
322 unless $format =~ /^(latex|html|template)$/;
324 my $cust_main = $self->cust_main || $self->prospect_main;
326 my $locale = $params{'locale'} || $cust_main->locale;
328 my %delimiters = ( 'latex' => [ '[@--', '--@]' ],
329 'html' => [ '<%=', '%>' ],
330 'template' => [ '{', '}' ],
333 warn "$me print_generic creating template\n"
336 # set the notice name here, and nowhere else.
337 my $notice_name = $params{notice_name}
338 || $conf->config('notice_name')
339 || $self->notice_name;
342 my $template = $params{template} ? $params{template} : $self->_agent_template;
343 my $templatefile = $self->template_conf. $format;
344 $templatefile .= "_$template"
345 if length($template) && $conf->exists($templatefile."_$template");
347 $self->set('_template',$template);
350 my @invoice_template = map "$_\n", $conf->config($templatefile)
351 or die "cannot load config data $templatefile";
353 if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
354 #change this to a die when the old code is removed
355 # it's been almost ten years, changing it to a die
356 die "old-style invoice template $templatefile; ".
357 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
358 #$old_latex = 'true';
359 #@invoice_template = _translate_old_latex_format(@invoice_template);
362 warn "$me print_generic creating T:T object\n"
365 my $text_template = new Text::Template(
367 SOURCE => \@invoice_template,
368 DELIMITERS => $delimiters{$format},
371 warn "$me print_generic compiling T:T object\n"
374 $text_template->compile()
375 or die "Can't compile $templatefile: $Text::Template::ERROR\n";
378 # additional substitution could possibly cause breakage in existing templates
381 'notes' => sub { map "$_", @_ },
382 'footer' => sub { map "$_", @_ },
383 'smallfooter' => sub { map "$_", @_ },
384 'returnaddress' => sub { map "$_", @_ },
385 'coupon' => sub { map "$_", @_ },
386 'summary' => sub { map "$_", @_ },
392 s/%%(.*)$/<!-- $1 -->/g;
393 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
394 s/\\begin\{enumerate\}/<ol>/g;
396 s/\\end\{enumerate\}/<\/ol>/g;
397 s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
406 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
408 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
414 s/\\hyphenation\{[\w\s\-]+}//;
419 'coupon' => sub { "" },
420 'summary' => sub { "" },
427 s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
428 s/\\begin\{enumerate\}//g;
430 s/\\end\{enumerate\}//g;
431 s/\\textbf\{(.*)\}/$1/g;
438 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
440 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
445 s/\\\\\*?\s*$/\n/; # dubious
446 s/\\hyphenation\{[\w\s\-]+}//;
450 'coupon' => sub { "" },
451 'summary' => sub { "" },
456 # hashes for differing output formats
457 my %nbsps = ( 'latex' => '~',
458 'html' => '', # '&nbps;' would be nice
459 'template' => '', # not used
461 my $nbsp = $nbsps{$format};
463 my %escape_functions = ( 'latex' => \&_latex_escape,
464 'html' => \&_html_escape_nbsp,#\&encode_entities,
465 'template' => sub { shift },
467 my $escape_function = $escape_functions{$format};
468 my $escape_function_nonbsp = ($format eq 'html')
469 ? \&_html_escape : $escape_function;
471 my %newline_tokens = ( 'latex' => '\\\\',
475 my $newline_token = $newline_tokens{$format};
477 warn "$me generating template variables\n"
480 # generate template variables
484 defined( $conf->config_orbase( "invoice_${format}returnaddress",
488 && length( $conf->config_orbase( "invoice_${format}returnaddress",
494 $returnaddress = join("\n",
495 $conf->config_orbase("invoice_${format}returnaddress", $template)
499 $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
501 my $convert_map = $convert_maps{$format}{'returnaddress'};
504 &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
509 } elsif ( grep /\S/, $conf->config('company_address', $cust_main->agentnum) ) {
511 my $convert_map = $convert_maps{$format}{'returnaddress'};
512 $returnaddress = join( "\n", &$convert_map(
513 map { s/( {2,})/'~' x length($1)/eg;
517 ( $conf->config('company_name', $cust_main->agentnum),
518 $conf->config('company_address', $cust_main->agentnum),
525 my $warning = "Couldn't find a return address; ".
526 "do you need to set the company_address configuration value?";
528 $returnaddress = $nbsp;
529 #$returnaddress = $warning;
533 warn "$me generating invoice data\n"
536 my $agentnum = $cust_main->agentnum;
541 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
542 'company_address' => join("\n", $conf->config('company_address', $agentnum) ). "\n",
543 'company_phonenum'=> scalar( $conf->config('company_phonenum', $agentnum) ),
544 'returnaddress' => $returnaddress,
545 'agent' => &$escape_function($cust_main->agent->agent),
547 #invoice/quotation info
548 'no_number' => $params{'no_number'},
549 'invnum' => ( $params{'no_number'} ? '' : $self->invnum ),
550 'quotationnum' => $self->quotationnum,
551 'no_date' => $params{'no_date'},
552 '_date' => ( $params{'no_date'} ? '' : $self->_date ),
553 # workaround for inconsistent behavior in the early plain text
554 # templates; see RT#28271
555 'date' => ( $params{'no_date'}
557 : ($format eq 'template'
559 : $self->time2str_local('long', $self->_date, $format)
562 'today' => $self->time2str_local('long', $today, $format),
563 'terms' => $self->terms,
564 'template' => $template, #params{'template'},
565 'notice_name' => $notice_name, # escape?
566 'current_charges' => sprintf("%.2f", $self->charged),
567 'duedate' => $self->due_date2str('rdate'), #date_format?
568 'duedate_long' => $self->due_date2str('long'),
571 'custnum' => $cust_main->display_custnum,
572 'prospectnum' => $cust_main->prospectnum,
573 'agent_custid' => &$escape_function($cust_main->agent_custid),
574 ( map { $_ => &$escape_function($cust_main->$_()) }
575 qw( company address1 address2 city state zip fax )
577 'payname' => &$escape_function( $cust_main->invoice_attn
578 || $cust_main->contact_firstlast ),
581 'ship_enable' => $cust_main->invoice_ship_address || $conf->exists('invoice-ship_address'),
582 'unitprices' => $conf->exists('invoice-unitprice'),
583 'smallernotes' => $conf->exists('invoice-smallernotes'),
584 'smallerfooter' => $conf->exists('invoice-smallerfooter'),
585 'balance_due_below_line' => $conf->exists('balance_due_below_line'),
587 #layout info -- would be fancy to calc some of this and bury the template
589 'topmargin' => scalar($conf->config('invoice_latextopmargin', $agentnum)),
590 'headsep' => scalar($conf->config('invoice_latexheadsep', $agentnum)),
591 'textheight' => scalar($conf->config('invoice_latextextheight', $agentnum)),
592 'extracouponspace' => scalar($conf->config('invoice_latexextracouponspace', $agentnum)),
593 'couponfootsep' => scalar($conf->config('invoice_latexcouponfootsep', $agentnum)),
594 'verticalreturnaddress' => $conf->exists('invoice_latexverticalreturnaddress', $agentnum),
595 'addresssep' => scalar($conf->config('invoice_latexaddresssep', $agentnum)),
596 'amountenclosedsep' => scalar($conf->config('invoice_latexcouponamountenclosedsep', $agentnum)),
597 'coupontoaddresssep' => scalar($conf->config('invoice_latexcoupontoaddresssep', $agentnum)),
598 'addcompanytoaddress' => $conf->exists('invoice_latexcouponaddcompanytoaddress', $agentnum),
600 # better hang on to conf_dir for a while (for old templates)
601 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
603 #these are only used when doing paged plaintext
609 #quotations have $name
610 $invoice_data{'name'} = $invoice_data{'payname'};
613 $invoice_data{'emt'} = sub { &$escape_function($self->mt(@_)) };
614 # prototype here to silence warnings
615 $invoice_data{'time2str'} = sub ($;$$) { $self->time2str_local(@_, $format) };
617 my $min_sdate = 999999999999;
619 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
620 next unless $cust_bill_pkg->pkgnum > 0;
621 $min_sdate = $cust_bill_pkg->sdate
622 if length($cust_bill_pkg->sdate) && $cust_bill_pkg->sdate < $min_sdate;
623 $max_edate = $cust_bill_pkg->edate
624 if length($cust_bill_pkg->edate) && $cust_bill_pkg->edate > $max_edate;
627 $invoice_data{'bill_period'} = '';
628 $invoice_data{'bill_period'} =
629 $self->time2str_local('%e %h', $min_sdate, $format)
631 $self->time2str_local('%e %h', $max_edate, $format)
632 if ($max_edate != 0 && $min_sdate != 999999999999);
634 $invoice_data{finance_section} = '';
635 if ( $conf->config('finance_pkgclass') ) {
637 qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
638 $invoice_data{finance_section} = $pkg_class->categoryname;
640 $invoice_data{finance_amount} = '0.00';
641 $invoice_data{finance_section} ||= 'Finance Charges'; #avoid config confusion
643 my $countrydefault = $conf->config('countrydefault') || 'US';
644 foreach ( qw( address1 address2 city state zip country fax) ){
645 my $method = 'ship_'.$_;
646 $invoice_data{"ship_$_"} = $escape_function->($cust_main->$method);
648 if ( length($cust_main->ship_company) ) {
649 $invoice_data{'ship_company'} = $escape_function->($cust_main->ship_company);
651 $invoice_data{'ship_company'} = $escape_function->($cust_main->company);
653 $invoice_data{'ship_contact'} = $escape_function->($cust_main->contact);
654 $invoice_data{'ship_country'} = ''
655 if ( $invoice_data{'ship_country'} eq $countrydefault );
657 $invoice_data{'cid'} = $params{'cid'}
660 if ( $cust_main->bill_locationnum
661 && $cust_main->bill_location->country ne $countrydefault ) {
662 $invoice_data{'country'} = &$escape_function($cust_main->bill_country_full);
664 $invoice_data{'country'} = '';
668 $invoice_data{'address'} = \@address;
670 $invoice_data{'payname'}.
671 ( $cust_main->po_number
672 ? " (P.O. #". $cust_main->po_number. ")"
676 push @address, $cust_main->company
677 if $cust_main->company;
678 push @address, $cust_main->address1;
679 push @address, $cust_main->address2
680 if $cust_main->address2;
682 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
683 push @address, $invoice_data{'country'}
684 if $invoice_data{'country'};
686 while (scalar(@address) < 5);
688 $invoice_data{'logo_file'} = $params{'logo_file'}
689 if $params{'logo_file'};
690 $invoice_data{'barcode_file'} = $params{'barcode_file'}
691 if $params{'barcode_file'};
692 $invoice_data{'barcode_img'} = $params{'barcode_img'}
693 if $params{'barcode_img'};
694 $invoice_data{'barcode_cid'} = $params{'barcode_cid'}
695 if $params{'barcode_cid'};
699 # using owed_on_invoice() instead of owed() here for $balance_due
700 # using _items_previous_total() instead of ->previous() for $pr_total
702 # owed_on_invoice() is aware of configuration flags that affect how an
703 # invoice is rendered. May not return actual current balance. Will
704 # return balance appropriate for the invoice being rendered, based
705 # on which past due items, current charges, and future payments are
708 # Going forward, usage of owed(), or bypassing cust_bill helper methods
709 # when generating invoice lines may lead to incorrect or misleading
712 # Helper methods that are aware of invoicing conf flags:
713 # - owed_on_invoice # use instead of owed()
714 # - _items_previous() # use instead of previous()
715 # - _items_credits() # use instead of cust_credit()
716 # - _items_payments()
718 # - _items_previous_total() # use instead of previous()
719 # - _items_payments_total()
720 # - _items_credits_total() # use instead of cust_credit()
722 my $pr_total = $self->_items_previous_total();
724 my $balance_due = $self->owed_on_invoice();
725 $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
727 # flag telling this invoice to have a first-page summary
728 my $summarypage = '';
730 if ( $self->custnum && $self->invnum ) {
731 # XXX should be an FS::cust_bill method to set the defaults, instead
732 # of checking the type here
734 # info from customer's last invoice before this one, for some
736 $invoice_data{'last_bill'} = {};
738 # my $last_bill = $self->previous_bill;
739 # if ( $last_bill ) {
741 # Populate template stash for previous balance and payments
743 # Used on summary page as "Previous Balance"
744 $invoice_data{'true_previous_balance'} = sprintf("%.2f", $pr_total);
746 # Used on summary page as "Payments"
747 $invoice_data{'balance_adjustments'} = sprintf("%.2f",
748 $self->_items_payments_total() + $self->_items_credits_total()
751 # Used in invoice template as "Previous Balance"
752 $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
754 # $invoice_data{last_bill}{_date}:
755 # Not used in default templates, but may be in use by someone
757 # ! May be a problem field if they are using it... this field
758 # stores the date of the previous invoice... it is possible to
759 # carry a balance, but have the immediately previous invoice paid off.
760 # In this case, this field might be presenting bad data? Not
761 # altering the problematic behavior, because someone might be
762 # expecting this bad behavior in their templates for some other
763 # purpose, such as a "your last bill was dated %_date%"
764 my $last_bill = $self->previous_bill;
765 $invoice_data{'last_bill'}{'_date'}
767 ? $last_bill->_date()
770 # $invoice_data{previous_payments}
771 # Not used in default templates, but may be in use by someone
773 # Returns an array of hrefs representing payments, each with keys:
774 # - _date: epoch timestamp
775 # - date: text formatted date
776 # - amount: money formatted amount string
777 # - payinfo: string from payby_payinfo_pretty()
778 # - paynum: id for cust_pay
779 # - description: Text description for bill line item
781 my @payments = $self->_items_payments();
782 $invoice_data{previous_payments} = \@payments;
784 # $invoice_data{previous_credits}
785 # Not used in default templates, but may be in use by someone
787 # Returns an array of hrefs representing credits, each with keys:
788 # - _date: epoch timestamp
789 # - date: text formatted date
790 # - amount: money formatted amount string
791 # - crednum: id for cust_credit
792 # - description: Text description for bill line item
793 # - creditreason: reason() from cust_credit
795 my @credits = $self->_items_credits();
796 $invoice_data{previous_credits} = \@credits;
798 # Populate formatted date field
799 for my $pmt_href (@payments, @credits) {
800 $pmt_href->{date} = $self->time2str_local(
808 # There are no outstanding invoices = YAPH
809 $invoice_data{'true_previous_balance'} =
810 $invoice_data{'balance_adjustments'} =
811 $invoice_data{'previous_balance'} = '0.00';
812 $invoice_data{'previous_payments'} =
813 $invoice_data{'previous_credits'} = [];
816 # Condencing a lot of debug staements here
818 warn "\$invoice_data{$_}: $invoice_data{$_}"
820 true_previous_balance
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 # if (well, probably when) we still need PO numbers in the brave new world of
893 # 4.x, then we'll have to add them back as their own customer fields
894 # # let invoices use either of these as needed
895 # $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
896 # ? $cust_main->payinfo : '';
897 # $invoice_data{'po_line'} =
898 # ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
899 # ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
902 my %money_chars = ( 'latex' => '',
903 'html' => $conf->config('money_char') || '$',
906 my $money_char = $money_chars{$format};
909 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
910 'html' => $conf->config('money_char') || '$',
913 my $other_money_char = $other_money_chars{$format};
914 $invoice_data{'dollar'} = $other_money_char;
916 my %minus_signs = ( 'latex' => '$-$',
918 'template' => '- ' );
919 my $minus = $minus_signs{$format};
921 my @detail_items = ();
922 my @total_items = ();
926 $invoice_data{'detail_items'} = \@detail_items;
927 $invoice_data{'total_items'} = \@total_items;
928 $invoice_data{'buf'} = \@buf;
929 $invoice_data{'sections'} = \@sections;
931 warn "$me generating sections\n"
934 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
935 my $multisection = $self->has_sections;
936 $conf->exists($tc.'sections', $cust_main->agentnum) ||
937 $conf->exists($tc.'sections_by_location', $cust_main->agentnum);
938 $invoice_data{'multisection'} = $multisection;
940 my $extra_sections = [];
941 my $extra_lines = ();
943 # default section ('Charges')
944 my $default_section = { 'description' => '',
949 # Previous Charges section
950 # subtotal is the first return value from $self->previous
951 my $previous_section;
952 # if the invoice has major sections, or if we're summarizing previous
953 # charges with a single line, or if we've been specifically told to put them
954 # in a section, create a section for previous charges:
955 if ( $multisection or
956 $conf->exists('previous_balance-summary_only') or
957 $conf->exists('previous_balance-section') ) {
959 $previous_section = { 'description' => $self->mt('Previous Charges'),
960 'subtotal' => $other_money_char.
961 sprintf('%.2f', $pr_total),
962 'summarized' => '', #why? $summarypage ? 'Y' : '',
965 # Include balance aging line and template variables
966 my @aged_balances = $self->_items_aging_balances();
967 ( $invoice_data{aged_balance_current},
968 $invoice_data{aged_balance_30d},
969 $invoice_data{aged_balance_60d},
970 $invoice_data{aged_balance_90d}
973 if ($conf->exists('invoice_include_aging')) {
974 $previous_section->{posttotal} = sprintf(
975 '0 / 30 / 60 / 90 days overdue %.2f / %.2f / %.2f / %.2f',
981 # otherwise put them in the main section
982 $previous_section = $default_section;
985 my $adjust_section = {
986 'description' => $self->mt('Credits, Payments, and Adjustments'),
987 'adjust_section' => 1,
988 'subtotal' => 0, # adjusted below
990 my $adjust_weight = _pkg_category($adjust_section->{description})
991 ? _pkg_category($adjust_section->{description})->weight
993 $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
994 # Note: 'sort_weight' here is actually a flag telling whether there is an
995 # explicit package category for the adjust section. If so, certain behavior
997 $adjust_section->{'sort_weight'} = $adjust_weight;
1000 if ( $multisection ) {
1001 ($extra_sections, $extra_lines) =
1002 $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
1003 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum)
1004 && $self->can('_items_extra_usage_sections');
1006 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
1008 push @detail_items, @$extra_lines if $extra_lines;
1010 # the code is written so that both methods can be used together, but
1011 # we haven't yet changed the template to take advantage of that, so for
1012 # now, treat them as mutually exclusive.
1013 my %section_method = ( by_category => 1 );
1014 if ( $conf->config($tc.'sections_method') eq 'location' ) {
1015 %section_method = ( by_location => 1 );
1017 my ($early, $late) =
1018 $self->_items_sections( 'summary' => $summarypage,
1019 'escape' => $escape_function_nonbsp,
1020 'extra_sections' => $extra_sections,
1021 'format' => $format,
1024 push @sections, @$early;
1025 $late_sections = $late;
1027 if ( $conf->exists('svc_phone_sections')
1028 && $self->can('_items_svc_phone_sections')
1031 my ($phone_sections, $phone_lines) =
1032 $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
1033 push @{$late_sections}, @$phone_sections;
1034 push @detail_items, @$phone_lines;
1036 if ( $conf->exists('voip-cust_accountcode_cdr')
1037 && $cust_main->accountcode_cdr
1038 && $self->can('_items_accountcode_cdr')
1041 my ($accountcode_section, $accountcode_lines) =
1042 $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
1043 if ( scalar(@$accountcode_lines) ) {
1044 push @{$late_sections}, $accountcode_section;
1045 push @detail_items, @$accountcode_lines;
1048 } else {# not multisection
1049 # make a default section
1050 push @sections, $default_section;
1051 # and calculate the finance charge total, since it won't get done otherwise.
1052 # and the default section total
1053 # XXX possibly finance_pkgclass should not be used in this manner?
1054 my @finance_charges;
1056 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1057 if ( $invoice_data{finance_section} and
1058 grep { $_->section eq $invoice_data{finance_section} }
1059 $cust_bill_pkg->cust_bill_pkg_display ) {
1060 # I think these are always setup fees, but just to be sure...
1061 push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1063 push @charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1066 $invoice_data{finance_amount} =
1067 sprintf('%.2f', sum( @finance_charges ) || 0);
1068 $default_section->{subtotal} = $other_money_char.
1069 sprintf('%.2f', sum( @charges ) || 0);
1072 # start setting up summary subtotals
1073 my @summary_subtotals;
1074 my $method = $conf->config('summary_subtotals_method');
1075 if ( $method and $method ne $conf->config($tc.'sections_method') ) {
1076 # then re-section them by the correct method
1077 my %section_method = ( by_category => 1 );
1078 if ( $conf->config('summary_subtotals_method') eq 'location' ) {
1079 %section_method = ( by_location => 1 );
1081 my ($early, $late) =
1082 $self->_items_sections( 'summary' => $summarypage,
1083 'escape' => $escape_function_nonbsp,
1084 'extra_sections' => $extra_sections,
1085 'format' => $format,
1088 foreach ( @$early ) {
1089 next if $_->{subtotal} == 0;
1090 $_->{subtotal} = $other_money_char.sprintf('%.2f', $_->{subtotal});
1091 push @summary_subtotals, $_;
1094 # subtotal sectioning is the same as for the actual invoice sections
1095 @summary_subtotals = @sections;
1098 # Hereafter, push sections to both @sections and @summary_subtotals
1099 # if they belong in both places (e.g. tax section). Late sections are
1100 # never in @summary_subtotals.
1102 # previous invoice balances in the Previous Charges section if there
1103 # is one, otherwise in the main detail section
1104 # (except if summary_only is enabled, don't show them at all)
1105 if ( $self->can('_items_previous') &&
1106 $self->enable_previous &&
1107 ! $conf->exists('previous_balance-summary_only') ) {
1109 warn "$me adding previous balances\n"
1112 foreach my $line_item ( $self->_items_previous ) {
1115 ref => $line_item->{'pkgnum'},
1116 pkgpart => $line_item->{'pkgpart'},
1117 #quantity => 1, # not really correct
1118 section => $previous_section, # which might be $default_section
1119 description => &$escape_function($line_item->{'description'}),
1120 ext_description => [ map { &$escape_function($_) }
1121 @{ $line_item->{'ext_description'} || [] }
1123 amount => $money_char . $line_item->{'amount'},
1124 product_code => $line_item->{'pkgpart'} || 'N/A',
1127 push @detail_items, $detail;
1128 push @buf, [ $detail->{'description'},
1129 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1135 if ( $pr_total && $self->enable_previous ) {
1136 push @buf, ['','-----------'];
1137 push @buf, [ $self->mt('Total Previous Balance'),
1138 $money_char. sprintf("%10.2f", $pr_total) ];
1142 if ( $conf->exists('svc_phone-did-summary') && $self->can('_did_summary') ) {
1143 warn "$me adding DID summary\n"
1146 my ($didsummary,$minutes) = $self->_did_summary;
1147 my $didsummary_desc = 'DID Activity Summary (since last invoice)';
1149 { 'description' => $didsummary_desc,
1150 'ext_description' => [ $didsummary, $minutes ],
1154 foreach my $section (@sections, @$late_sections) {
1156 # begin some normalization
1157 $section->{'subtotal'} = $section->{'amount'}
1159 && !exists($section->{subtotal})
1160 && exists($section->{amount});
1162 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
1163 if ( $invoice_data{finance_section} &&
1164 $section->{'description'} eq $invoice_data{finance_section} );
1166 if ( $multisection ) {
1168 if ( ref($section->{'subtotal'}) ) {
1170 $section->{'subtotal'} =
1171 sprintf("$other_money_char%.2f to $other_money_char%.2f",
1172 $section->{'subtotal'}[0],
1173 $section->{'subtotal'}[1]
1178 $section->{'subtotal'} = $other_money_char.
1179 sprintf('%.2f', $section->{'subtotal'})
1183 # continue some normalization
1184 $section->{'amount'} = $section->{'subtotal'}
1188 if ( $section->{'description'} ) {
1189 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
1194 warn "$me setting options\n"
1198 $options{'section'} = $section if $multisection;
1199 $options{'section_with_taxes'} = 1
1200 if $conf->exists('invoice_sections_with_taxes');
1201 $options{'format'} = $format;
1202 $options{'escape_function'} = $escape_function;
1203 $options{'no_usage'} = 1 unless $unsquelched;
1204 $options{'unsquelched'} = $unsquelched;
1205 $options{'summary_page'} = $summarypage;
1206 $options{'skip_usage'} =
1207 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
1208 $options{'preref_callback'} = $params{'preref_callback'};
1210 warn "$me searching for line items\n"
1213 my %section_tax_lines;
1215 foreach my $line_item ( $self->_items_pkg(%options),
1216 $self->_items_fee(%options) ) {
1218 warn "$me adding line item ".
1219 join(', ', map "$_=>".$line_item->{$_}, keys %$line_item). "\n"
1222 push @buf, ( [ $line_item->{'description'},
1223 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1225 map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}},
1228 $line_item->{'ref'} = $line_item->{'pkgnum'};
1229 $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()?
1230 $line_item->{'section'} = $section;
1231 $line_item->{'description'} = &$escape_function($line_item->{'description'});
1232 $line_item->{'amount'} = $money_char.$line_item->{'amount'};
1234 if ( length($line_item->{'unit_amount'}) ) {
1235 $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'};
1237 $line_item->{'ext_description'} ||= [];
1239 if ( $options{section_with_taxes} && ref $line_item->{pkg_tax} ) {
1240 for my $line_tax ( @{$ line_item->{pkg_tax} } ) {
1242 # It is rarely possible for the same tax record to be presented here
1243 # multiple times. See cust_bill_pkg::_pkg_tax_list for more info
1244 next if $seen_tax_lines{ $line_tax->{billpkgtaxlocationnum} };
1245 $seen_tax_lines{ $line_tax->{billpkgtaxlocationnum} } = 1;
1247 $section_tax_lines{ $line_tax->{taxname} } += $line_tax->{amount};
1251 push @detail_items, $line_item;
1254 # If conf flag invoice_sections_with_taxes:
1255 # - Add @detail_items for taxes into each section
1256 # - Update section subtotal to include taxes
1257 if ( $options{section_with_taxes} && %section_tax_lines ) {
1258 for my $taxname ( keys %section_tax_lines ) {
1260 push @detail_items, {
1261 section => $section,
1262 amount => sprintf($money_char."%.2f",$section_tax_lines{$taxname}),
1263 description => &$escape_function($taxname),
1266 # Append taxes to total. If line format resembles "$5.00 to $12.00"
1267 # append to the second value.
1269 # $section->{subtotal} = '$5.00 to 12.00'; # for testing:
1270 if ($section->{subtotal} =~ /to/) {
1271 my @subtotal = split /\s/, $section->{subtotal};
1272 $subtotal[2] =~ s/[^\d\.]//g;
1273 $subtotal[2] = sprintf(
1275 ( $subtotal[2] + $section_tax_lines{$taxname} )
1277 $section->{subtotal} = join ' ', @subtotal;
1279 $section->{subtotal} =~ s/[^\d\.]//g;
1280 $section->{subtotal} = sprintf(
1281 $money_char . "%.2f",
1282 ( $section->{subtotal} + $section_tax_lines{$taxname} )
1289 if ( $section->{'description'} ) {
1290 push @buf, ( ['','-----------'],
1291 [ $section->{'description'}. ' sub-total',
1292 $section->{'subtotal'} # already formatted this
1301 $invoice_data{current_less_finance} =
1302 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
1304 # if there's anything in the Previous Charges section, prepend it to the list
1305 if ( $pr_total and $previous_section ne $default_section ) {
1306 unshift @sections, $previous_section;
1307 # but not @summary_subtotals
1310 warn "$me adding taxes\n"
1313 # create a tax section if we don't yet have one
1314 my @items_tax = $self->_items_tax;
1315 my $tax_description = 'Taxes, Surcharges, and Fees';
1317 List::Util::first { $_->{description} eq $tax_description } @sections;
1318 if (!$tax_section) {
1319 $tax_section = { 'description' => $tax_description };
1320 push @sections, $tax_section if $multisection and @items_tax > 0;
1322 $tax_section->{tax_section} = 1; # mark this section as containing taxes
1323 # if this is an existing tax section, we're merging the tax items into it.
1324 # grab the taxtotal that's already there, strip the money symbol if any
1325 my $taxtotal = $tax_section->{'subtotal'} || 0;
1326 $taxtotal =~ s/^\Q$other_money_char\E//;
1329 #my $tax_weight = _pkg_category($tax_section->{description})
1330 # ? _pkg_category($tax_section->{description})->weight
1332 #$tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
1333 #$tax_section->{'sort_weight'} = $tax_weight;
1335 foreach my $tax ( @items_tax ) {
1337 $taxtotal += $tax->{'amount'};
1339 my $description = &$escape_function( $tax->{'description'} );
1340 my $amount = sprintf( '%.2f', $tax->{'amount'} );
1342 if ( $multisection ) {
1344 push @detail_items, {
1345 ext_description => [],
1348 description => $description,
1349 amount => $money_char. $amount,
1351 section => $tax_section,
1356 push @total_items, {
1357 'total_item' => $description,
1358 'total_amount' => $other_money_char. $amount,
1363 push @buf,[ $description,
1364 $money_char. $amount,
1371 $total->{'total_item'} = $self->mt('Sub-total');
1372 $total->{'total_amount'} =
1373 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
1375 if ( $multisection ) {
1376 if ( $taxtotal > 0 ) {
1377 # there are taxes, so prepare the section to be displayed.
1378 # $taxtotal already includes any line items that were already in the
1379 # section (fees, taxes that are charged as packages for some reason).
1380 # also set 'summarized' to false so that this isn't a summary-only
1382 $tax_section->{'subtotal'} = $other_money_char.
1383 sprintf('%.2f', $taxtotal);
1384 $tax_section->{'pretotal'} = 'New charges sub-total '.
1385 $total->{'total_amount'};
1386 $tax_section->{'description'} = $self->mt($tax_description);
1387 $tax_section->{'summarized'} = '';
1389 if ( $conf->exists('invoice_sections_with_taxes')) {
1391 # remove tax section if taxes are itemized within other sections
1392 @sections = grep{ $_ ne $tax_section } @sections;
1394 } elsif ( !grep $tax_section, @sections ) {
1396 # append it if it's not already there
1397 push @sections, $tax_section;
1398 push @summary_subtotals, $tax_section;
1404 unshift @total_items, $total;
1407 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1413 my %embolden_functions = (
1414 'latex' => sub { return '\textbf{'. shift(). '}' },
1415 'html' => sub { return '<b>'. shift(). '</b>' },
1416 'template' => sub { shift },
1418 my $embolden_function = $embolden_functions{$format};
1420 if ( $multisection ) {
1422 if ( $adjust_section->{'sort_weight'} ) {
1423 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1424 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1426 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1427 $other_money_char. sprintf('%.2f', $self->charged );
1432 if ( $self->can('_items_total') ) { # should always be true now
1434 # even for multisection, need plain text version
1436 my @new_total_items = $self->_items_total;
1438 push @buf,['','-----------'];
1440 foreach ( @new_total_items ) {
1441 my ($item, $amount) = ($_->{'total_item'}, $_->{'total_amount'});
1442 $_->{'total_item'} = &$embolden_function( $item );
1444 if ( ref($amount) ) {
1445 $_->{'total_amount'} = &$embolden_function(
1446 $other_money_char.$amount->[0]. ' to '.
1447 $other_money_char.$amount->[1]
1450 $_->{'total_amount'} = &$embolden_function( $other_money_char.$amount );
1453 # but if it's multisection, don't append to @total_items. the adjust
1454 # section has all this stuff
1455 push @total_items, $_ if !$multisection;
1456 push @buf, [ $item, $money_char.sprintf('%10.2f',$amount) ];
1459 push @buf, [ '', '' ];
1461 # if we're showing previous invoices, also show previous
1462 # credits and payments
1463 if ( $self->enable_previous
1464 and $self->can('_items_credits')
1465 and $self->can('_items_payments') )
1469 my $credittotal = 0;
1470 foreach my $credit (
1471 $self->_items_credits( 'template' => $template, 'trim_len' => 40 )
1475 $total->{'total_item'} = &$escape_function($credit->{'description'});
1476 $credittotal += $credit->{'amount'};
1477 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1478 if ( $multisection ) {
1479 push @detail_items, {
1480 ext_description => [],
1483 description => &$escape_function($credit->{'description'}),
1484 amount => $money_char . $credit->{'amount'},
1486 section => $adjust_section,
1489 push @total_items, $total;
1493 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1496 foreach my $credit (
1497 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1499 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1503 my $paymenttotal = 0;
1504 foreach my $payment (
1505 $self->_items_payments( 'template' => $template )
1508 $total->{'total_item'} = &$escape_function($payment->{'description'});
1509 $paymenttotal += $payment->{'amount'};
1510 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1511 if ( $multisection ) {
1512 push @detail_items, {
1513 ext_description => [],
1516 description => &$escape_function($payment->{'description'}),
1517 amount => $money_char . $payment->{'amount'},
1519 section => $adjust_section,
1522 push @total_items, $total;
1524 push @buf, [ $payment->{'description'},
1525 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1528 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1530 if ( $multisection ) {
1531 $adjust_section->{'subtotal'} = $other_money_char.
1532 sprintf('%.2f', $credittotal + $paymenttotal);
1534 #why this? because {sort_weight} forces the adjust_section to appear
1535 #in @extra_sections instead of @sections. obviously.
1536 push @sections, $adjust_section
1537 unless $adjust_section->{sort_weight};
1538 # do not summarize; adjustments there are shown according to
1542 # create Balance Due message
1545 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1546 $total->{'total_amount'} =
1547 &$embolden_function(
1548 $other_money_char. sprintf('%.2f', #why? $summarypage
1549 # ? $self->charged +
1550 # $self->billing_balance
1555 if ( $multisection && !$adjust_section->{sort_weight} ) {
1556 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1557 $total->{'total_amount'};
1559 push @total_items, $total;
1561 push @buf,['','-----------'];
1562 push @buf,[$self->balance_due_msg, $money_char.
1563 sprintf("%10.2f", $balance_due ) ];
1566 if ( $conf->exists('previous_balance-show_credit')
1567 and $cust_main->balance < 0 ) {
1568 my $credit_total = {
1569 'total_item' => &$embolden_function($self->credit_balance_msg),
1570 'total_amount' => &$embolden_function(
1571 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1574 if ( $multisection ) {
1575 $adjust_section->{'posttotal'} .= $newline_token .
1576 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1579 push @total_items, $credit_total;
1581 push @buf,['','-----------'];
1582 push @buf,[$self->credit_balance_msg, $money_char.
1583 sprintf("%10.2f", -$cust_main->balance ) ];
1587 } #end of default total adding ! can('_items_total')
1589 if ( $multisection ) {
1590 if ( $conf->exists('svc_phone_sections')
1591 && $self->can('_items_svc_phone_sections')
1595 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1596 $total->{'total_amount'} =
1597 &$embolden_function(
1598 $other_money_char. sprintf('%.2f', $balance_due)
1600 my $last_section = pop @sections;
1601 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1602 $total->{'total_amount'};
1603 push @sections, $last_section;
1605 push @sections, @$late_sections
1609 # make a discounts-available section, even without multisection
1610 if ( $conf->exists('discount-show_available')
1611 and my @discounts_avail = $self->_items_discounts_avail ) {
1612 my $discount_section = {
1613 'description' => $self->mt('Discounts Available'),
1618 push @sections, $discount_section; # do not summarize
1619 push @detail_items, map { +{
1620 'ref' => '', #should this be something else?
1621 'section' => $discount_section,
1622 'description' => &$escape_function( $_->{description} ),
1623 'amount' => $money_char . &$escape_function( $_->{amount} ),
1624 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1625 } } @discounts_avail;
1628 # not adding any more sections after this
1629 $invoice_data{summary_subtotals} = \@summary_subtotals;
1632 if ( $conf->exists('usage_class_summary')
1633 and $self->can('_items_usage_class_summary') ) {
1634 my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function, 'money_char' => $other_money_char);
1635 if ( @usage_subtotals ) {
1636 unshift @sections, $usage_subtotals[0]->{section}; # do not summarize
1637 unshift @detail_items, @usage_subtotals;
1641 # invoice history "section" (not really a section)
1642 # not to be included in any subtotals, completely independent of
1644 if ( $conf->exists('previous_invoice_history') and $cust_main->isa('FS::cust_main') ) {
1647 foreach my $cust_bill ( $cust_main->cust_bill ) {
1648 # XXX hardcoded format, and currently only 'charged'; add other fields
1649 # if they become necessary
1650 my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1651 $history{$date} ||= 0;
1652 $history{$date} += $cust_bill->charged;
1653 # just so we have a numeric sort key
1654 $monthorder{$date} ||= $cust_bill->_date;
1656 my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1658 my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1659 $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1662 # service locations: another option for template customization
1664 foreach my $item (@detail_items) {
1665 if ( $item->{locationnum} ) {
1666 $location_info{ $item->{locationnum} } ||= {
1667 FS::cust_location->by_key( $item->{locationnum} )->location_hash
1671 $invoice_data{location_info} = \%location_info;
1673 # debugging hook: call this with 'diag' => 1 to just get a hash of
1674 # the invoice variables
1675 return \%invoice_data if ( $params{'diag'} );
1677 # All sections and items are built; now fill in templates.
1678 my @includelist = ();
1679 push @includelist, 'summary' if $summarypage;
1680 foreach my $include ( @includelist ) {
1682 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1685 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1687 @inc_src = $conf->config($inc_file, $agentnum);
1691 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1693 my $convert_map = $convert_maps{$format}{$include};
1695 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1696 s/--\@\]/$delimiters{$format}[1]/g;
1699 &$convert_map( $conf->config($inc_file, $agentnum) );
1703 my $inc_tt = new Text::Template (
1705 SOURCE => [ map "$_\n", @inc_src ],
1706 DELIMITERS => $delimiters{$format},
1707 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1709 unless ( $inc_tt->compile() ) {
1710 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1711 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1715 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1717 $invoice_data{$include} =~ s/\n+$//
1718 if ($format eq 'latex');
1723 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1724 /invoice_lines\((\d*)\)/;
1725 $invoice_lines += $1 || scalar(@buf);
1728 die "no invoice_lines() functions in template?"
1729 if ( $format eq 'template' && !$wasfunc );
1731 if ( $invoice_lines ) {
1732 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1733 $invoice_data{'total_pages'}++
1734 if scalar(@buf) % $invoice_lines;
1737 #setup subroutine for the template
1738 $invoice_data{invoice_lines} = sub {
1739 my $lines = shift || scalar(@buf);
1748 if ($format eq 'template') {
1753 push @collect, split("\n",
1754 $text_template->fill_in( HASH => \%invoice_data )
1756 $invoice_data{'page'}++;
1758 map "$_\n", @collect;
1760 } else { # this is where we actually create the invoice
1762 if ( $params{no_addresses} ) {
1763 delete $invoice_data{$_} foreach qw(
1764 payname company address1 address2 city state zip country
1766 $invoice_data{returnaddress} = '~';
1769 warn "filling in template for invoice ". $self->invnum. "\n"
1771 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1774 $text_template->fill_in(HASH => \%invoice_data);
1778 sub notice_name { '('.shift->table.')'; }
1780 # this is not supposed to happen
1781 sub template_conf { warn "bare FS::Template_Mixin::template_conf";
1785 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1787 Returns an postscript invoice, as a scalar.
1789 Options can be passed as a hashref (recommended) or as a list of time, template
1790 and then any key/value pairs for any other options.
1792 I<time> an optional value used to control the printing of overdue messages. The
1793 default is now. It isn't the date of the invoice; that's the `_date' field.
1794 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1795 L<Time::Local> and L<Date::Parse> for conversion functions.
1797 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1804 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1805 my $ps = generate_ps($file);
1807 unlink($barcodefile) if $barcodefile;
1812 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1814 Returns an PDF invoice, as a scalar.
1816 Options can be passed as a hashref (recommended) or as a list of time, template
1817 and then any key/value pairs for any other options.
1819 I<time> an optional value used to control the printing of overdue messages. The
1820 default is now. It isn't the date of the invoice; that's the `_date' field.
1821 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1822 L<Time::Local> and L<Date::Parse> for conversion functions.
1824 I<template>, if specified, is the name of a suffix for alternate invoices.
1826 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1833 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1834 my $pdf = generate_pdf($file);
1836 unlink($barcodefile) if $barcodefile;
1841 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1843 Returns an HTML invoice, as a scalar.
1845 I<time> an optional value used to control the printing of overdue messages. The
1846 default is now. It isn't the date of the invoice; that's the `_date' field.
1847 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1848 L<Time::Local> and L<Date::Parse> for conversion functions.
1850 I<template>, if specified, is the name of a suffix for alternate invoices.
1852 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1854 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1855 when emailing the invoice as part of a multipart/related MIME email.
1863 %params = %{ shift() };
1867 $params{'format'} = 'html';
1869 $self->print_generic( %params );
1872 # quick subroutine for print_latex
1874 # There are ten characters that LaTeX treats as special characters, which
1875 # means that they do not simply typeset themselves:
1876 # # $ % & ~ _ ^ \ { }
1878 # TeX ignores blanks following an escaped character; if you want a blank (as
1879 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1883 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1884 $value =~ s/([<>])/\$$1\$/g;
1890 encode_entities($value);
1894 sub _html_escape_nbsp {
1895 my $value = _html_escape(shift);
1896 $value =~ s/ +/ /g;
1900 #utility methods for print_*
1902 sub _translate_old_latex_format {
1903 warn "_translate_old_latex_format called\n"
1910 if ( $line =~ /^%%Detail\s*$/ ) {
1912 push @template, q![@--!,
1913 q! foreach my $_tr_line (@detail_items) {!,
1914 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1915 q! $_tr_line->{'description'} .= !,
1916 q! "\\tabularnewline\n~~".!,
1917 q! join( "\\tabularnewline\n~~",!,
1918 q! @{$_tr_line->{'ext_description'}}!,
1922 while ( ( my $line_item_line = shift )
1923 !~ /^%%EndDetail\s*$/ ) {
1924 $line_item_line =~ s/'/\\'/g; # nice LTS
1925 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1926 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1927 push @template, " \$OUT .= '$line_item_line';";
1930 push @template, '}',
1933 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1935 push @template, '[@--',
1936 ' foreach my $_tr_line (@total_items) {';
1938 while ( ( my $total_item_line = shift )
1939 !~ /^%%EndTotalDetails\s*$/ ) {
1940 $total_item_line =~ s/'/\\'/g; # nice LTS
1941 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1942 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1943 push @template, " \$OUT .= '$total_item_line';";
1946 push @template, '}',
1950 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1951 push @template, $line;
1957 warn "$_\n" foreach @template;
1969 my $conf = $self->conf;
1971 #check for an invoice-specific override
1972 return $self->invoice_terms if $self->invoice_terms;
1974 #check for a customer- specific override
1975 my $cust_main = $self->cust_main;
1976 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1980 $agentnum = $cust_main->agentnum;
1981 } elsif ( my $prospect_main = $self->prospect_main ) {
1982 $agentnum = $prospect_main->agentnum;
1985 #use configured default
1986 $conf->config('invoice_default_terms', $agentnum) || '';
1996 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1997 $duedate = $self->_date() + ( $1 * 86400 );
1998 } elsif ( $self->terms =~ /^End of Month$/ ) {
1999 my ($mon,$year) = (localtime($self->_date) )[4,5];
2001 until ( $mon < 12 ) { $mon -= 12; $year++; }
2002 my $nextmonth_first = timelocal(0,0,0,1,$mon,$year);
2003 $duedate = $nextmonth_first - 86400;
2014 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
2017 =item invoice_pay_by_msg
2019 displays the invoice_pay_by_msg or default Please pay by [_1] if empty.
2023 sub invoice_pay_by_msg {
2027 $self->conf->config('invoice_pay_by_msg', $self->agentnum)
2028 || 'Please pay by [_1]';
2029 $msg .= ' - ' . $self->mt($please_pay_by, $self->due_date2str('short')) . ' ';
2034 =item balance_due_msg
2038 sub balance_due_msg {
2040 my $msg = $self->mt('Balance Due');
2041 return $msg unless $self->terms; # huh?
2042 if ( !$self->conf->exists('invoice_show_prior_due_date')
2043 or $self->conf->exists('invoice_sections') ) {
2044 # if enabled, the due date is shown with Total New Charges (see
2045 # _items_total) and not here
2046 # (yes, or if invoice_sections is enabled; this is just for compatibility)
2047 if ( $self->due_date ) {
2048 $msg .= $self->invoice_pay_by_msg
2049 unless $self->conf->config_bool('invoice_omit_due_date',$self->agentnum);
2050 } elsif ( $self->terms ) {
2051 $msg .= ' - '. $self->mt($self->terms);
2057 =item balance_due_date
2061 sub balance_due_date {
2063 my $conf = $self->conf;
2065 my $terms = $self->terms;
2066 if ( $terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
2067 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
2072 sub credit_balance_msg {
2074 $self->mt('Credit Balance Remaining')
2079 Returns a string with the date, for example: "3/20/2008", localized for the
2080 customer. Use _date_pretty_unlocalized for non-end-customer display use.
2086 $self->time2str_local('short', $self->_date);
2089 =item _date_pretty_unlocalized
2091 Returns a string with the date, for example: "3/20/2008", in the format
2092 configured for the back-office. Use _date_pretty for end-customer display use.
2096 sub _date_pretty_unlocalized {
2098 time2str($date_format, $self->_date);
2103 Emails this template.
2105 Options are passed as a hashref. Available options:
2111 If specified, overrides the default From: address.
2115 If specified, overrides the name of the sent document ("Invoice" or "Quotation")
2119 (Deprecated) If specified, is the name of a suffix for alternate template files.
2123 Options accepted by generate_email can also be used.
2129 my $opt = shift || {};
2130 if ($opt and !ref($opt)) {
2131 die ref($self). '->email called with positional parameters';
2134 return if $self->hide;
2136 my $error = send_email(
2137 $self->generate_email(
2138 'subject' => $self->email_subject($opt->{template}),
2139 %$opt, # template, etc.
2143 die "can't email: $error\n" if $error;
2146 =item generate_email OPTION => VALUE ...
2154 sender address, required
2158 alternate template name, optional
2162 email subject, optional
2166 notice name instead of "Invoice", optional
2170 Returns an argument list to be passed to L<FS::Misc::send_email>.
2177 sub generate_email {
2181 my $conf = $self->conf;
2183 my $me = '[FS::Template_Mixin::generate_email]';
2186 'from' => $args{'from'},
2187 'subject' => ($args{'subject'} || $self->email_subject),
2188 'custnum' => $self->custnum,
2189 'msgtype' => 'invoice',
2192 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
2194 my $cust_main = $self->cust_main;
2196 if (ref($args{'to'}) eq 'ARRAY') {
2197 $return{'to'} = $args{'to'};
2198 } elsif ( $cust_main ) {
2199 $return{'to'} = [ $cust_main->invoicing_list_emailonly ];
2202 my $tc = $self->template_conf;
2204 my @text; # array of lines
2205 my $html; # a big string
2206 my @related_parts; # will contain the text/HTML alternative, and images
2207 my $related; # will contain the multipart/related object
2209 if ( $conf->exists($tc. 'email_pdf') ) {
2210 if ( my $msgnum = $conf->config($tc.'email_pdf_msgnum') ) {
2212 warn "$me using '${tc}email_pdf_msgnum' in multipart message"
2215 my $msg_template = FS::msg_template->by_key($msgnum)
2216 or die "${tc}email_pdf_msgnum $msgnum not found\n";
2217 my $cust_msg = $msg_template->prepare(
2218 cust_main => $self->cust_main,
2220 msgtype => 'invoice',
2223 # XXX hack to make this work in the new cust_msg era; consider replacing
2224 # with cust_bill_send_with_notice events.
2225 my @parts = $cust_msg->parts;
2226 foreach my $part (@parts) { # will only have two parts, normally
2227 if ( $part->mime_type eq 'text/plain' ) {
2228 @text = @{ $part->body };
2229 } elsif ( $part->mime_type eq 'text/html' ) {
2230 $html = $part->bodyhandle->as_string;
2234 } elsif ( my @note = $conf->config($tc.'email_pdf_note') ) {
2236 warn "$me using '${tc}email_pdf_note' in multipart message"
2238 @text = $conf->config($tc.'email_pdf_note');
2239 $html = join('<BR>', @text);
2241 } # else use the plain text invoice
2246 if ( $conf->config($tc.'template') ) {
2248 warn "$me generating plain text invoice"
2251 # 'print_text' argument is no longer used
2252 @text = map Encode::encode_utf8($_), $self->print_text(\%args);
2256 warn "$me no plain text version exists; sending empty message body"
2263 my $text_part = build MIME::Entity (
2264 'Type' => 'text/plain',
2265 'Encoding' => 'quoted-printable',
2266 'Charset' => 'UTF-8',
2267 #'Encoding' => '7bit',
2269 'Disposition' => 'inline',
2274 if ( $conf->exists($tc.'html') ) {
2275 warn "$me generating HTML invoice"
2278 $args{'from'} =~ /\@([\w\.\-]+)/;
2279 my $from = $1 || 'example.com';
2280 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2283 my $agentnum = $cust_main ? $cust_main->agentnum
2284 : $self->prospect_main->agentnum;
2285 if ( defined($args{'template'}) && length($args{'template'})
2286 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
2289 $logo = 'logo_'. $args{'template'}. '.png';
2293 my $image_data = $conf->config_binary( $logo, $agentnum);
2295 push @related_parts, build MIME::Entity
2296 'Type' => 'image/png',
2297 'Encoding' => 'base64',
2298 'Data' => $image_data,
2299 'Filename' => 'logo.png',
2300 'Content-ID' => "<$content_id>",
2303 if ( ref($self) eq 'FS::cust_bill' && $conf->exists('invoice-barcode') ) {
2304 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2305 push @related_parts, build MIME::Entity
2306 'Type' => 'image/png',
2307 'Encoding' => 'base64',
2308 'Data' => $self->invoice_barcode(0),
2309 'Filename' => 'barcode.png',
2310 'Content-ID' => "<$barcode_content_id>",
2312 $args{'barcode_cid'} = $barcode_content_id;
2315 $html = $self->print_html({ 'cid'=>$content_id, %args });
2322 warn "$me creating HTML/text multipart message"
2325 $return{'nobody'} = 1;
2327 my $alternative = build MIME::Entity
2328 'Type' => 'multipart/alternative',
2329 #'Encoding' => '7bit',
2330 'Disposition' => 'inline'
2334 $alternative->add_part($text_part);
2337 $alternative->attach(
2338 'Type' => 'text/html',
2339 'Encoding' => 'quoted-printable',
2340 'Data' => [ '<html>',
2343 ' '. encode_entities($return{'subject'}),
2346 ' <body bgcolor="#e8e8e8">',
2347 Encode::encode_utf8($html),
2351 'Disposition' => 'inline',
2352 #'Filename' => 'invoice.pdf',
2355 unshift @related_parts, $alternative;
2357 $related = build MIME::Entity 'Type' => 'multipart/related',
2358 'Encoding' => '7bit';
2360 #false laziness w/Misc::send_email
2361 $related->head->replace('Content-type',
2362 $related->mime_type.
2363 '; boundary="'. $related->head->multipart_boundary. '"'.
2364 '; type=multipart/alternative'
2367 $related->add_part($_) foreach @related_parts;
2371 my @otherparts = ();
2372 if ( ref($self) eq 'FS::cust_bill' && $cust_main->email_csv_cdr ) {
2374 if ( $conf->config('voip-cdr_email_attach') eq 'zip' ) {
2376 my $data = join('', map "$_\n",
2377 $self->call_details(prepend_billed_number=>1)
2380 my $zip = new Archive::Zip;
2381 my $file = $zip->addString( $data, 'usage-'.$self->invnum.'.csv' );
2382 $file->desiredCompressionMethod( COMPRESSION_DEFLATED );
2385 my $SH = IO::Scalar->new(\$zipdata);
2386 my $status = $zip->writeToFileHandle($SH);
2387 die "Error zipping CDR attachment: $!" unless $status == AZ_OK;
2389 push @otherparts, build MIME::Entity
2390 'Type' => 'application/zip',
2391 'Encoding' => 'base64',
2393 'Disposition' => 'attachment',
2394 'Filename' => 'usage-'. $self->invnum. '.zip',
2397 } else { # } elsif ( $conf->config('voip-cdr_email_attach') eq 'csv' ) {
2399 push @otherparts, build MIME::Entity
2400 'Type' => 'text/csv',
2401 'Encoding' => '7bit',
2402 'Data' => [ map { "$_\n" }
2403 $self->call_details('prepend_billed_number' => 1)
2405 'Disposition' => 'attachment',
2406 'Filename' => 'usage-'. $self->invnum. '.csv',
2413 if ( $conf->exists($tc.'email_pdf') ) {
2418 # multipart/alternative
2424 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
2425 push @otherparts, $pdf;
2429 $return{'content-type'} = 'multipart/mixed'; # of the outer container
2431 $return{'mimeparts'} = [ $related, @otherparts ];
2432 $return{'type'} = 'multipart/related'; # of the first part
2434 $return{'mimeparts'} = [ $text_part, @otherparts ];
2435 $return{'type'} = 'text/plain';
2437 } elsif ( $html ) { # no PDF or CSV, strip the outer container
2438 $return{'mimeparts'} = \@related_parts;
2439 $return{'content-type'} = 'multipart/related';
2440 $return{'type'} = 'multipart/alternative';
2441 } else { # no HTML either
2442 $return{'body'} = \@text;
2443 $return{'content-type'} = 'text/plain';
2452 Returns a list suitable for passing to MIME::Entity->build(), representing
2453 this quotation or invoice as PDF attachment.
2460 'Type' => 'application/pdf',
2461 'Encoding' => 'base64',
2462 'Data' => [ $self->print_pdf(@_) ],
2463 'Disposition' => 'attachment',
2464 'Filename' => $self->pdf_filename,
2468 =item postal_mail_fsinc
2470 Sends this invoice to the Freeside Internet Services, Inc. print and mail
2476 use IO::Socket::SSL;
2478 use HTTP::Request::Common qw( POST );
2479 use Cpanel::JSON::XS;
2481 sub postal_mail_fsinc {
2482 my ( $self, %opt ) = @_;
2484 my $url = 'https://ws.freeside.biz/print';
2486 my $cust_main = $self->cust_main;
2487 my $agentnum = $cust_main->agentnum;
2488 my $bill_location = $cust_main->bill_location;
2490 die "Extra charges for international mailing; contact support\@freeside.biz to enable\n"
2491 if $bill_location->country ne 'US';
2493 my $conf = new FS::Conf;
2495 my @company_address = $conf->config('company_address', $agentnum);
2496 my ( $company_address1, $company_address2, $company_city, $company_state, $company_zip );
2497 if ( $company_address[2] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2498 $company_address1 = $company_address[0];
2499 $company_address2 = $company_address[1];
2501 $company_state = $2;
2503 } elsif ( $company_address[1] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2504 $company_address1 = $company_address[0];
2505 $company_address2 = '';
2507 $company_state = $2;
2510 die "Unparsable company_address; contact support\@freeside.biz\n";
2512 $company_city =~ s/,$//;
2514 my $file = $self->print_pdf(%opt, 'no_addresses' => 1);
2515 my $pages = CAM::PDF->new($file)->numPages;
2517 my $ua = LWP::UserAgent->new(
2519 verify_hostname => 0,
2520 SSL_verify_mode => IO::Socket::SSL::SSL_VERIFY_NONE,
2521 SSL_version => 'SSLv3',
2524 my $response = $ua->request( POST $url, [
2525 'support-key' => scalar($conf->config('support-key')),
2526 'file' => encode_base64($file),
2530 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
2531 'company_address1' => $company_address1,
2532 'company_address2' => $company_address2,
2533 'company_city' => $company_city,
2534 'company_state' => $company_state,
2535 'company_zip' => $company_zip,
2536 'company_country' => 'US',
2537 'company_phonenum' => scalar($conf->config('company_phonenum', $agentnum)),
2538 'company_email' => scalar($conf->config('invoice_from', $agentnum)),
2541 'name' => $cust_main->invoice_attn
2542 || $cust_main->contact_firstlast,
2543 'company' => $cust_main->company,
2544 'address1' => $bill_location->address1,
2545 'address2' => $bill_location->address2,
2546 'city' => $bill_location->city,
2547 'state' => $bill_location->state,
2548 'zip' => $bill_location->zip,
2549 'country' => $bill_location->country,
2552 die "Print connection error: ". $response->message.
2553 ' ('. $response->as_string. ")\n"
2554 unless $response->is_success;
2557 my $content = eval { decode_json($response->content) };
2558 die "Print JSON error : $@\n" if $@;
2560 die $content->{error}."\n"
2561 if $content->{error};
2563 #TODO: store this so we can query for a status later
2564 warn "Invoice printed, ID ". $content->{id}. "\n";
2570 =item _items_sections OPTIONS
2572 Generate section information for all items appearing on this invoice.
2573 This will only be called for multi-section invoices.
2575 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
2576 related display records (L<FS::cust_bill_pkg_display>) and organize
2577 them into two groups ("early" and "late" according to whether they come
2578 before or after the total), then into sections. A subtotal is calculated
2581 Section descriptions are returned in sort weight order. Each consists
2582 of a hash containing:
2584 description: the package category name, escaped
2585 subtotal: the total charges in that section
2586 tax_section: a flag indicating that the section contains only tax charges
2587 summarized: same as tax_section, for some reason
2588 sort_weight: the package category's sort weight
2590 If 'condense' is set on the display record, it also contains everything
2591 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
2592 coderefs to generate parts of the invoice. This is not advised.
2594 The method returns two arrayrefs, one of "early" sections and one of "late"
2597 OPTIONS may include:
2599 by_location: a flag to divide the invoice into sections by location.
2600 Each section hash will have a 'location' element containing a hashref of
2601 the location fields (see L<FS::cust_location>). The section description
2602 will be the location label, but the template can use any of the location
2603 fields to create a suitable label.
2605 by_category: a flag to divide the invoice into sections using display
2606 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
2607 behavior. Each section hash will have a 'category' element containing
2608 the section name from the display record (which probably equals the
2609 category name of the package, but may not in some cases).
2611 summary: a flag indicating that this is a summary-format invoice.
2612 Turning this on has the following effects:
2613 - Ignores display items with the 'summary' flag.
2614 - Places all sections in the "early" group even if they have post_total.
2615 - Creates sections for all non-disabled package categories, even if they
2616 have no charges on this invoice, as well as a section with no name.
2618 escape: an escape function to use for section titles.
2620 extra_sections: an arrayref of additional sections to return after the
2621 sorted list. If there are any of these, section subtotals exclude
2624 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
2625 passed through to C<_condense_section()>.
2629 use vars qw(%pkg_category_cache);
2630 sub _items_sections {
2634 my $escape = $opt{escape};
2635 my @extra_sections = @{ $opt{extra_sections} || [] };
2637 # $subtotal{$locationnum}{$categoryname} = amount.
2638 # if we're not using by_location, $locationnum is undef.
2639 # if we're not using by_category, you guessed it, $categoryname is undef.
2640 # if we're not using either one, we shouldn't be here in the first place...
2642 my %late_subtotal = ();
2645 # About tax items + multisection invoices:
2646 # If either invoice_*summary option is enabled, AND there is a
2647 # package category with the name of the tax, then there will be
2648 # a display record assigning the tax item to that category.
2650 # However, the taxes are always placed in the "Taxes, Surcharges,
2651 # and Fees" section regardless of that. The only effect of the
2652 # display record is to create a subtotal for the summary page.
2655 my $pkg_hash = $self->cust_pkg_hash;
2657 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2660 my $usage = $cust_bill_pkg->usage;
2663 if ( $opt{by_location} ) {
2664 if ( $cust_bill_pkg->pkgnum ) {
2665 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2670 $locationnum = undef;
2673 # as in _items_cust_pkg, if a line item has no display records,
2674 # cust_bill_pkg_display() returns a default record for it
2676 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2677 next if ( $display->summary && $opt{summary} );
2679 my $section = $display->section;
2680 my $type = $display->type;
2681 # Set $section = undef if we're sectioning by location and this
2682 # line item _has_ a location (i.e. isn't a fee).
2683 $section = undef if $locationnum;
2685 # set this flag if the section is not tax-only
2686 $not_tax{$locationnum}{$section} = 1
2687 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
2689 # there's actually a very important piece of logic buried in here:
2690 # incrementing $late_subtotal{$section} CREATES
2691 # $late_subtotal{$section}. keys(%late_subtotal) is later used
2692 # to define the list of late sections, and likewise keys(%subtotal).
2693 # When _items_cust_bill_pkg is called to generate line items for
2694 # real, it will be called with 'section' => $section for each
2696 if ( $display->post_total && !$opt{summary} ) {
2697 if (! $type || $type eq 'S') {
2698 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2699 if $cust_bill_pkg->setup != 0
2700 || $cust_bill_pkg->setup_show_zero;
2704 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
2705 if $cust_bill_pkg->recur != 0
2706 || $cust_bill_pkg->recur_show_zero;
2709 if ($type && $type eq 'R') {
2710 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2711 if $cust_bill_pkg->recur != 0
2712 || $cust_bill_pkg->recur_show_zero;
2715 if ($type && $type eq 'U') {
2716 $late_subtotal{$locationnum}{$section} += $usage
2717 unless scalar(@extra_sections);
2720 } else { # it's a pre-total (normal) section
2722 # skip tax items unless they're explicitly included in a section
2723 next if $cust_bill_pkg->pkgnum == 0 and
2724 ! $cust_bill_pkg->feepart and
2727 if ( $type eq 'S' ) {
2728 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2729 if $cust_bill_pkg->setup != 0
2730 || $cust_bill_pkg->setup_show_zero;
2731 } elsif ( $type eq 'R' ) {
2732 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2733 if $cust_bill_pkg->recur != 0
2734 || $cust_bill_pkg->recur_show_zero;
2735 } elsif ( $type eq 'U' ) {
2736 $subtotal{$locationnum}{$section} += $usage
2737 unless scalar(@extra_sections);
2738 } elsif ( !$type ) {
2739 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2740 + $cust_bill_pkg->recur;
2749 %pkg_category_cache = ();
2751 # summary invoices need subtotals for all non-disabled package categories,
2752 # even if they're zero
2753 # but currently assume that there are no location sections, or at least
2754 # that the summary page doesn't care about them
2755 if ( $opt{summary} ) {
2756 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2757 $subtotal{''}{$category->categoryname} ||= 0;
2759 $subtotal{''}{''} ||= 0;
2763 foreach my $post_total (0,1) {
2765 my $s = $post_total ? \%late_subtotal : \%subtotal;
2766 foreach my $locationnum (keys %$s) {
2767 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2769 'subtotal' => $s->{$locationnum}{$sectionname},
2772 if ( $locationnum ) {
2773 $section->{'locationnum'} = $locationnum;
2774 my $location = FS::cust_location->by_key($locationnum);
2775 $section->{'description'} = &{ $escape }($location->location_label);
2776 # Better ideas? This will roughly group them by proximity,
2777 # which alpha sorting on any of the address fields won't.
2778 # Sorting by locationnum is meaningless.
2779 # We have to sort on _something_ or the order may change
2780 # randomly from one invoice to the next, which will confuse
2782 $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
2784 $section->{'location'} = {
2785 label_prefix => &{ $escape }($location->label_prefix),
2786 map { $_ => &{ $escape }($location->get($_)) }
2790 $section->{'category'} = $sectionname;
2791 $section->{'description'} = &{ $escape }($sectionname);
2792 if ( _pkg_category($sectionname) ) {
2793 $section->{'sort_weight'} = _pkg_category($sectionname)->weight;
2794 if ( _pkg_category($sectionname)->condense ) {
2795 $section = { %$section, $self->_condense_section($opt{format}) };
2799 if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
2800 # then it's a tax-only section
2801 $section->{'summarized'} = 'Y';
2802 $section->{'tax_section'} = 'Y';
2804 push @these, $section;
2805 } # foreach $sectionname
2806 } #foreach $locationnum
2807 push @these, @extra_sections if $post_total == 0;
2808 # need an alpha sort for location sections, because postal codes can
2810 $sections[ $post_total ] = [ sort {
2811 $opt{'by_location'} ?
2812 ($a->{sort_weight} cmp $b->{sort_weight}) :
2813 ($a->{sort_weight} <=> $b->{sort_weight})
2815 } #foreach $post_total
2817 return @sections; # early, late
2820 #helper subs for above
2824 $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2828 my $categoryname = shift;
2829 $pkg_category_cache{$categoryname} ||=
2830 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2833 my %condensed_format = (
2834 'label' => [ qw( Description Qty Amount ) ],
2836 sub { shift->{description} },
2837 sub { shift->{quantity} },
2838 sub { my($href, %opt) = @_;
2839 ($opt{dollar} || ''). $href->{amount};
2842 'align' => [ qw( l r r ) ],
2843 'span' => [ qw( 5 1 1 ) ], # unitprices?
2844 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
2847 sub _condense_section {
2848 my ( $self, $format ) = ( shift, shift );
2850 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2851 qw( description_generator
2854 total_line_generator
2859 sub _condensed_generator_defaults {
2860 my ( $self, $format ) = ( shift, shift );
2861 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2870 sub _condensed_header_generator {
2871 my ( $self, $format ) = ( shift, shift );
2873 my ( $f, $prefix, $suffix, $separator, $column ) =
2874 _condensed_generator_defaults($format);
2876 if ($format eq 'latex') {
2877 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2878 $suffix = "\\\\\n\\hline";
2881 sub { my ($d,$a,$s,$w) = @_;
2882 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2884 } elsif ( $format eq 'html' ) {
2885 $prefix = '<th></th>';
2889 sub { my ($d,$a,$s,$w) = @_;
2890 return qq!<th align="$html_align{$a}">$d</th>!;
2898 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2900 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2903 $prefix. join($separator, @result). $suffix;
2908 sub _condensed_description_generator {
2909 my ( $self, $format ) = ( shift, shift );
2911 my ( $f, $prefix, $suffix, $separator, $column ) =
2912 _condensed_generator_defaults($format);
2914 my $money_char = '$';
2915 if ($format eq 'latex') {
2916 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2918 $separator = " & \n";
2920 sub { my ($d,$a,$s,$w) = @_;
2921 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2923 $money_char = '\\dollar';
2924 }elsif ( $format eq 'html' ) {
2925 $prefix = '"><td align="center"></td>';
2929 sub { my ($d,$a,$s,$w) = @_;
2930 return qq!<td align="$html_align{$a}">$d</td>!;
2932 #$money_char = $conf->config('money_char') || '$';
2933 $money_char = ''; # this is madness
2941 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2943 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2945 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2946 map { $f->{$_}->[$i] } qw(align span width)
2950 $prefix. join( $separator, @result ). $suffix;
2955 sub _condensed_total_generator {
2956 my ( $self, $format ) = ( shift, shift );
2958 my ( $f, $prefix, $suffix, $separator, $column ) =
2959 _condensed_generator_defaults($format);
2962 if ($format eq 'latex') {
2965 $separator = " & \n";
2967 sub { my ($d,$a,$s,$w) = @_;
2968 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2970 }elsif ( $format eq 'html' ) {
2974 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2976 sub { my ($d,$a,$s,$w) = @_;
2977 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2986 # my $r = &{$f->{fields}->[$i]}(@args);
2987 # $r .= ' Total' unless $i;
2989 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2991 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
2992 map { $f->{$_}->[$i] } qw(align span width)
2996 $prefix. join( $separator, @result ). $suffix;
3001 =item total_line_generator FORMAT
3003 Returns a coderef used for generation of invoice total line items for this
3004 usage_class. FORMAT is either html or latex
3008 # should not be used: will have issues with hash element names (description vs
3009 # total_item and amount vs total_amount -- another array of functions?
3011 sub _condensed_total_line_generator {
3012 my ( $self, $format ) = ( shift, shift );
3014 my ( $f, $prefix, $suffix, $separator, $column ) =
3015 _condensed_generator_defaults($format);
3018 if ($format eq 'latex') {
3021 $separator = " & \n";
3023 sub { my ($d,$a,$s,$w) = @_;
3024 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
3026 }elsif ( $format eq 'html' ) {
3030 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
3032 sub { my ($d,$a,$s,$w) = @_;
3033 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
3042 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
3044 &{$column}( &{$f->{fields}->[$i]}(@args),
3045 map { $f->{$_}->[$i] } qw(align span width)
3049 $prefix. join( $separator, @result ). $suffix;
3054 =item _items_pkg [ OPTIONS ]
3056 Return line item hashes for each package item on this invoice. Nearly
3059 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
3061 OPTIONS are passed through to _items_cust_bill_pkg, and should include
3062 'format' and 'escape_function' at minimum.
3064 To produce items for a specific invoice section, OPTIONS should include
3065 'section', a hashref containing 'category' and/or 'locationnum' keys.
3067 'section' may also contain a key named 'condensed'. If this is present
3068 and has a true value, _items_pkg will try to merge identical items into items
3069 with 'quantity' equal to the number of items (not the sum of their separate
3070 quantities, for some reason).
3076 # The order of these is important. Bundled line items will be merged into
3077 # the most recent non-hidden item, so it needs to be the one with:
3079 # - the same start date
3080 # - no pkgpart_override
3082 # So: sort by pkgnum,
3084 # then sort the base line item before any overrides
3085 # then sort hidden before non-hidden add-ons
3086 # then sort by override pkgpart (for consistency)
3087 sort { $a->pkgnum <=> $b->pkgnum or
3088 $a->sdate <=> $b->sdate or
3089 ($a->pkgpart_override ? 0 : -1) or
3090 ($b->pkgpart_override ? 0 : 1) or
3091 $b->hidden cmp $a->hidden or
3092 $a->pkgpart_override <=> $b->pkgpart_override
3094 # and of course exclude taxes and fees
3095 grep { $_->pkgnum > 0 } $self->cust_bill_pkg;
3101 my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
3102 my $escape_function = $options{escape_function};
3105 foreach my $cust_bill_pkg (@cust_bill_pkg) {
3106 # cache this, so we don't look it up again in every section
3107 my $part_fee = $cust_bill_pkg->get('part_fee')
3108 || $cust_bill_pkg->part_fee;
3109 $cust_bill_pkg->set('part_fee', $part_fee);
3111 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
3112 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
3115 if ( exists($options{section}) and exists($options{section}{category}) )
3117 my $categoryname = $options{section}{category};
3118 # then filter for items that have that section
3119 if ( $part_fee->categoryname ne $categoryname ) {
3120 warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
3123 } # otherwise include them all in the main section
3124 # XXX what to do when sectioning by location?
3127 my %base_invnums; # invnum => invoice date
3128 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
3129 if ($_->base_invnum) {
3130 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
3131 my $base_date = $self->time2str_local('short', $base_bill->_date)
3133 $base_invnums{$_->base_invnum} = $base_date || '';
3136 foreach (sort keys(%base_invnums)) {
3137 next if $_ == $self->invnum;
3138 # per convention, we must escape ext_description lines
3140 &{$escape_function}(
3141 $self->mt('from invoice #[_1] on [_2]', $_, $base_invnums{$_})
3144 my $desc = $part_fee->itemdesc_locale($self->cust_main->locale);
3145 # but not escape the base description line
3147 my @pkg_tax = $cust_bill_pkg->_pkg_tax_list
3148 if $options{section_with_taxes};
3151 { feepart => $cust_bill_pkg->feepart,
3152 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
3153 description => $desc,
3154 pkg_tax => \@pkg_tax,
3155 ext_description => \@ext_desc,
3166 warn "$me _items_pkg searching for all package line items\n"
3169 my @cust_bill_pkg = $self->_items_nontax;
3171 warn "$me _items_pkg filtering line items\n"
3173 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3175 if ($options{section} && $options{section}->{condensed}) {
3177 warn "$me _items_pkg condensing section\n"
3181 local $Storable::canonical = 1;
3182 foreach ( @items ) {
3184 delete $item->{ref};
3185 delete $item->{ext_description};
3186 my $key = freeze($item);
3187 $itemshash{$key} ||= 0;
3188 $itemshash{$key} ++; # += $item->{quantity};
3190 @items = sort { $a->{description} cmp $b->{description} }
3191 map { my $i = thaw($_);
3192 $i->{quantity} = $itemshash{$_};
3194 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
3200 warn "$me _items_pkg returning ". scalar(@items). " items\n"
3207 return 0 unless $a->itemdesc cmp $b->itemdesc;
3208 return -1 if $b->itemdesc eq 'Tax';
3209 return 1 if $a->itemdesc eq 'Tax';
3210 return -1 if $b->itemdesc eq 'Other surcharges';
3211 return 1 if $a->itemdesc eq 'Other surcharges';
3212 $a->itemdesc cmp $b->itemdesc;
3217 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
3218 $self->cust_bill_pkg;
3219 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3221 if ( $self->conf->exists('always_show_tax') ) {
3222 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
3223 if (0 == grep { $_->{description} eq $itemdesc } @items) {
3225 { 'description' => $itemdesc,
3232 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
3234 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
3235 list of hashrefs describing the line items they generate on the invoice.
3237 OPTIONS may include:
3239 format: the invoice format.
3241 escape_function: the function used to escape strings.
3243 DEPRECATED? (expensive, mostly unused?)
3244 format_function: the function used to format CDRs.
3246 section: a hashref containing 'category' and/or 'locationnum'; if this
3247 is present, only returns line items that belong to that category and/or
3248 location (whichever is defined).
3250 multisection: a flag indicating that this is a multisection invoice,
3251 which does something complicated.
3253 section_with_taxes: Look up and include applied taxes for each record
3255 Returns a list of hashrefs, each of which may contain:
3257 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
3258 ext_description, which is an arrayref of detail lines to show below
3263 sub _items_cust_bill_pkg {
3265 my $conf = $self->conf;
3266 my $cust_bill_pkgs = shift;
3269 my $format = $opt{format} || '';
3270 my $escape_function = $opt{escape_function} || sub { shift };
3271 my $format_function = $opt{format_function} || '';
3272 my $no_usage = $opt{no_usage} || '';
3273 my $unsquelched = $opt{unsquelched} || ''; #unused
3274 my ($section, $locationnum, $category);
3275 if ( $opt{section} ) {
3276 $category = $opt{section}->{category};
3277 $locationnum = $opt{section}->{locationnum};
3279 my $summary_page = $opt{summary_page} || ''; #unused
3280 my $multisection = defined($category) || defined($locationnum);
3281 # this variable is the value of the config setting, not whether it applies
3282 # to this particular line item.
3283 my $discount_show_always = $conf->exists('discount-show-always');
3285 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 40;
3287 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
3289 # for location labels: use default location on the invoice date
3290 my $default_locationnum;
3291 if ( $conf->exists('invoice-all_pkg_addresses') ) {
3292 $default_locationnum = 0; # treat them all as non-default
3293 } elsif ( $self->custnum ) {
3295 my @h_search = FS::h_cust_main->sql_h_search($self->_date);
3296 $h_cust_main = qsearchs({
3297 'table' => 'h_cust_main',
3298 'hashref' => { custnum => $self->custnum },
3299 'extra_sql' => $h_search[1],
3300 'addl_from' => $h_search[3],
3302 $default_locationnum = $h_cust_main->ship_locationnum;
3303 } elsif ( $self->prospectnum ) {
3304 my $cust_location = qsearchs('cust_location',
3305 { prospectnum => $self->prospectnum,
3307 $default_locationnum = $cust_location->locationnum if $cust_location;
3310 my @b = (); # accumulator for the line item hashes that we'll return
3311 my ($s, $r, $u, $d) = ( undef, undef, undef, undef );
3312 # the 'current' line item hashes for setup, recur, usage, discount
3313 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
3315 # if the current line item is waiting to go out, and the one we're about
3316 # to start is not bundled, then push out the current one and start a new
3319 $d->{amount} = $d->{setup_amount} + $d->{recur_amount};
3321 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3322 if ( $_ && !$cust_bill_pkg->hidden ) {
3323 $_->{amount} = sprintf( "%.2f", $_->{amount} );
3324 $_->{amount} =~ s/^\-0\.00$/0.00/;
3325 if (exists($_->{unit_amount})) {
3326 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3329 # we already decided to create this display line; don't reconsider it
3331 # if $_->{amount} != 0
3332 # || $discount_show_always
3333 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3334 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3340 if ( $locationnum ) {
3341 # this is a location section; skip packages that aren't at this
3343 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
3344 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
3348 # Consider display records for this item to determine if it belongs
3349 # in this section. Note that if there are no display records, there
3350 # will be a default pseudo-record that includes all charge types
3351 # and has no section name.
3352 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
3353 ? $cust_bill_pkg->cust_bill_pkg_display
3354 : ( $cust_bill_pkg );
3356 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
3357 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
3360 if ( defined($category) ) {
3361 # then this is a package category section; process all display records
3362 # that belong to this section.
3363 @cust_bill_pkg_display = grep { $_->section eq $category }
3364 @cust_bill_pkg_display;
3366 # otherwise, process all display records that aren't usage summaries
3367 # (I don't think there should be usage summaries if you aren't using
3368 # category sections, but this is the historical behavior)
3369 @cust_bill_pkg_display = grep { !$_->summary }
3370 @cust_bill_pkg_display;
3373 my $classname = ''; # package class name, will fill in later
3375 foreach my $display (@cust_bill_pkg_display) {
3377 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
3378 $display->billpkgdisplaynum. "\n"
3381 my $type = $display->type;
3383 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
3384 $desc = substr($desc, 0, $maxlength). '...'
3385 if $format eq 'latex' && length($desc) > $maxlength;
3387 my %details_opt = ( 'format' => $format,
3388 'escape_function' => $escape_function,
3389 'format_function' => $format_function,
3390 'no_usage' => $opt{'no_usage'},
3393 if ( $cust_bill_pkg->pkgnum > 0 ) {
3394 # a "normal" package line item (not a quotation, not a fee, not a tax)
3396 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
3399 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3400 my $part_pkg = $cust_pkg->part_pkg;
3402 # which pkgpart to show for display purposes?
3403 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
3405 # start/end dates for invoice formats that do nonstandard
3407 my %item_dates = ();
3408 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
3409 unless $part_pkg->option('disable_line_item_date_ranges',1);
3411 # not normally used, but pass this to the template anyway
3412 $classname = $part_pkg->classname;
3414 my @pkg_tax = $cust_bill_pkg->_pkg_tax_list
3415 if $opt{section_with_taxes};
3417 if ( (!$type || $type eq 'S')
3418 && ( $cust_bill_pkg->setup != 0
3419 || $cust_bill_pkg->setup_show_zero
3420 || ($discount_show_always and $cust_bill_pkg->unitsetup > 0)
3425 warn "$me _items_cust_bill_pkg adding setup\n"
3428 # append the word 'Setup' to the setup line if there's going to be
3429 # a recur line for the same package (i.e. not a one-time charge)
3431 my $description = $desc;
3432 $description .= ' Setup'
3433 if $cust_bill_pkg->recur != 0
3434 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3435 || $cust_bill_pkg->recur_show_zero;
3437 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3439 if $part_pkg->is_prepaid #for prepaid, "display the validity period
3440 # triggered by the recurring charge freq
3442 && $cust_bill_pkg->recur == 0
3443 && ! $cust_bill_pkg->recur_show_zero;
3446 my @svc_labels = ();
3449 unless ( $part_pkg->hide_svc_detail ) {
3451 # still pass the svc_label through to the template, even if
3452 # not displaying it as an ext_description
3453 @svc_labels = map &{$escape_function}($_),
3454 $cust_pkg->h_labels_short($self->_date,
3457 $self->conf->{locale},
3459 $svc_label = $svc_labels[0];
3463 unless ( $part_pkg->hide_svc_detail
3464 || $cust_bill_pkg->hidden )
3467 push @d, @svc_labels
3468 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3469 # show the location label if it's not the customer's default
3470 # location, and we're not grouping items by location already
3471 if ( $cust_pkg->locationnum != $default_locationnum
3472 and !defined($locationnum) ) {
3473 my $loc = $cust_pkg->location_label;
3474 $loc = substr($loc, 0, $maxlength). '...'
3475 if $format eq 'latex' && length($loc) > $maxlength;
3476 push @d, &{$escape_function}($loc);
3479 } #unless hiding service details
3481 push @d, $cust_bill_pkg->details(%details_opt)
3482 if $cust_bill_pkg->recur == 0;
3484 if ( $cust_bill_pkg->hidden ) {
3485 $s->{amount} += $cust_bill_pkg->setup;
3486 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3487 push @{ $s->{ext_description} }, @d;
3490 billpkgnum => $cust_bill_pkg->billpkgnum,
3492 description => $description,
3493 pkgpart => $pkgpart,
3494 pkgnum => $cust_bill_pkg->pkgnum,
3495 amount => $cust_bill_pkg->setup,
3496 setup_show_zero => $cust_bill_pkg->setup_show_zero,
3497 unit_amount => $cust_bill_pkg->unitsetup,
3498 quantity => $cust_bill_pkg->quantity,
3499 ext_description => \@d,
3500 svc_label => ($svc_label || ''),
3501 locationnum => $cust_pkg->locationnum, # sure, why not?
3502 pkg_tax => \@pkg_tax,
3508 # should we show a recur line?
3509 # if type eq 'S', then NO, because we've been told not to.
3510 # otherwise, show the recur line if:
3511 # - there's a recurring charge
3512 # - or recur_show_zero is on
3513 # - or there's a positive unitrecur (so it's been discounted to zero)
3514 # and discount-show-always is on
3515 if ( ( !$type || $type eq 'R' || $type eq 'U' )
3517 $cust_bill_pkg->recur != 0
3519 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3520 || $cust_bill_pkg->recur_show_zero
3525 warn "$me _items_cust_bill_pkg adding recur/usage\n"
3528 my $is_summary = $display->summary;
3529 my $description = $desc;
3530 if ( $type eq 'U' and defined($r) ) {
3531 # don't just show the same description as the recur line
3532 $description = $self->mt('Usage charges');
3535 my $part_pkg = $cust_pkg->part_pkg;
3537 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3541 my @seconds = (); # for display of usage info
3542 my @svc_labels = ();
3545 #at least until cust_bill_pkg has "past" ranges in addition to
3546 #the "future" sdate/edate ones... see #3032
3547 my @dates = ( $self->_date );
3548 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
3549 push @dates, $prev->sdate if $prev;
3550 push @dates, undef if !$prev;
3552 unless ( $part_pkg->hide_svc_detail ) {
3553 @svc_labels = map &{$escape_function}($_),
3554 $cust_pkg->h_labels_short(@dates,
3556 $self->conf->{locale});
3557 $svc_label = $svc_labels[0];
3560 # show service labels, unless...
3561 # the package is set not to display them
3562 unless ( $part_pkg->hide_svc_detail
3563 # or this is a tax-like line item
3564 || $cust_bill_pkg->itemdesc
3565 # or this is a hidden (bundled) line item
3566 || $cust_bill_pkg->hidden
3567 # or this is a usage summary line
3568 || $is_summary && $type && $type eq 'U'
3569 # or this is a usage line and there's a recurring line
3570 # for the package in the same section (which will
3571 # have service labels already)
3572 || ($type eq 'U' and defined($r))
3576 warn "$me _items_cust_bill_pkg adding service details\n"
3579 push @d, @svc_labels
3580 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3581 warn "$me _items_cust_bill_pkg done adding service details\n"
3584 # show the location label if it's not the customer's default
3585 # location, and we're not grouping items by location already
3586 if ( $cust_pkg->locationnum != $default_locationnum
3587 and !defined($locationnum) ) {
3588 my $loc = $cust_pkg->location_label;
3589 $loc = substr($loc, 0, $maxlength). '...'
3590 if $format eq 'latex' && length($loc) > $maxlength;
3591 push @d, &{$escape_function}($loc);
3594 # Display of seconds_since_sqlradacct:
3595 # On the invoice, when processing @detail_items, look for a field
3596 # named 'seconds'. This will contain total seconds for each
3597 # service, in the same order as @ext_description. For services
3598 # that don't support this it will show undef.
3599 if ( $conf->exists('svc_acct-usage_seconds')
3600 and ! $cust_bill_pkg->pkgpart_override ) {
3601 foreach my $cust_svc (
3602 $cust_pkg->h_cust_svc(@dates, 'I')
3605 # eval because not having any part_export_usage exports
3606 # is a fatal error, last_bill/_date because that's how
3607 # sqlradius_hour billing does it
3609 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
3611 push @seconds, $sec;
3613 } #if svc_acct-usage_seconds
3615 } # if we are showing service labels
3617 unless ( $is_summary ) {
3618 warn "$me _items_cust_bill_pkg adding details\n"
3621 #instead of omitting details entirely in this case (unwanted side
3622 # effects), just omit CDRs
3623 $details_opt{'no_usage'} = 1
3624 if $type && $type eq 'R';
3626 push @d, $cust_bill_pkg->details(%details_opt);
3629 warn "$me _items_cust_bill_pkg calculating amount\n"
3634 $amount = $cust_bill_pkg->recur;
3635 } elsif ($type eq 'R') {
3636 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
3637 } elsif ($type eq 'U') {
3638 $amount = $cust_bill_pkg->usage;
3641 if ( !$type || $type eq 'R' ) {
3643 warn "$me _items_cust_bill_pkg adding recur\n"
3647 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
3650 if ( $cust_bill_pkg->hidden ) {
3651 $r->{amount} += $amount;
3652 $r->{unit_amount} += $unit_amount;
3653 push @{ $r->{ext_description} }, @d;
3656 billpkgnum => $cust_bill_pkg->billpkgnum,
3657 description => $description,
3658 pkgpart => $pkgpart,
3659 pkgnum => $cust_bill_pkg->pkgnum,
3661 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3662 unit_amount => $unit_amount,
3663 quantity => $cust_bill_pkg->quantity,
3665 ext_description => \@d,
3666 svc_label => ($svc_label || ''),
3667 locationnum => $cust_pkg->locationnum,
3668 pkg_tax => \@pkg_tax,
3670 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3673 } else { # $type eq 'U'
3675 warn "$me _items_cust_bill_pkg adding usage\n"
3678 if ( $cust_bill_pkg->hidden and defined($u) ) {
3679 # if this is a hidden package and there's already a usage
3680 # line for the bundle, add this package's total amount and
3681 # usage details to it
3682 $u->{amount} += $amount;
3683 push @{ $u->{ext_description} }, @d;
3684 } elsif ( $amount ) {
3685 # create a new usage line
3687 billpkgnum => $cust_bill_pkg->billpkgnum,
3688 description => $description,
3689 pkgpart => $pkgpart,
3690 pkgnum => $cust_bill_pkg->pkgnum,
3693 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3695 ext_description => \@d,
3696 locationnum => $cust_pkg->locationnum,
3697 pkg_tax => \@pkg_tax,
3699 } # else this has no usage, so don't create a usage section
3702 } # recurring or usage with recurring charge
3704 } else { # taxes and fees
3706 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3709 # items of this kind should normally not have sdate/edate.
3711 'description' => $desc,
3712 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
3713 + $cust_bill_pkg->recur)
3716 } # if package line item / other line item
3718 # decide whether to show active discounts here
3720 # case 1: we are showing a single line for the package
3722 # case 2: we are showing a setup line for a package that has
3723 # no base recurring fee
3724 or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3725 # case 3: we are showing a recur line for a package that has
3726 # a base recurring fee
3727 or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3730 my $item_discount = $cust_bill_pkg->_item_discount;
3731 if ( $item_discount ) {
3732 # $item_discount->{amount} is negative
3734 if ( $d and $cust_bill_pkg->hidden ) {
3735 $d->{setup_amount} += $item_discount->{setup_amount};
3736 $d->{recur_amount} += $item_discount->{recur_amount};
3738 $d = $item_discount;
3739 $_ = &{$escape_function}($_) foreach @{ $d->{ext_description} };
3742 # update the active line (before the discount) to show the
3743 # original price (whether this is a hidden line or not)
3745 $s->{amount} -= $item_discount->{setup_amount} if $s;
3746 $r->{amount} -= $item_discount->{recur_amount} if $r;
3748 } # if there are any discounts
3749 } # if this is an appropriate place to show discounts
3751 } # foreach $display
3755 # discount amount is internally split up
3757 $d->{amount} = $d->{setup_amount} + $d->{recur_amount};
3760 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3762 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3763 if exists($_->{amount});
3764 $_->{amount} =~ s/^\-0\.00$/0.00/;
3765 if (exists($_->{unit_amount})) {
3766 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3770 #if $_->{amount} != 0
3771 # || $discount_show_always
3772 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3773 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3777 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3784 =item _items_discounts_avail
3786 Returns an array of line item hashrefs representing available term discounts
3787 for this invoice. This makes the same assumptions that apply to term
3788 discounts in general: that the package is billed monthly, at a flat rate,
3789 with no usage charges. A prorated first month will be handled, as will
3790 a setup fee if the discount is allowed to apply to setup fees.
3794 sub _items_discounts_avail {
3797 #maybe move this method from cust_bill when quotations support discount_plans
3798 return () unless $self->can('discount_plans');
3799 my %plans = $self->discount_plans;
3801 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3802 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3806 my $plan = $plans{$months};
3808 my $term_total = sprintf('%.2f', $plan->discounted_total);
3809 my $percent = sprintf('%.0f',
3810 100 * (1 - $term_total / $plan->base_total) );
3811 my $permonth = sprintf('%.2f', $term_total / $months);
3812 my $detail = $self->mt('discount on item'). ' '.
3813 join(', ', map { "#$_" } $plan->pkgnums)
3816 # discounts for non-integer months don't work anyway
3817 $months = sprintf("%d", $months);
3820 description => $self->mt('Save [_1]% by paying for [_2] months',
3822 amount => $self->mt('[_1] ([_2] per month)',
3823 $term_total, $money_char.$permonth),
3824 ext_description => ($detail || ''),
3827 sort { $b <=> $a } keys %plans;