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 dbh );
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 Deprecated. 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 if ( $multisection ) {
937 $invoice_data{multisection} = $conf->config($tc.'sections_method') || 1;
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 = grep $_->{subtotal}, @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
1201 && $conf->config_bool('invoice_sections_with_taxes', $cust_main->agentnum);
1202 $options{'format'} = $format;
1203 $options{'escape_function'} = $escape_function;
1204 $options{'no_usage'} = 1 unless $unsquelched;
1205 $options{'unsquelched'} = $unsquelched;
1206 $options{'summary_page'} = $summarypage;
1207 $options{'skip_usage'} =
1208 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
1209 $options{'preref_callback'} = $params{'preref_callback'};
1210 $options{'disable_line_item_date_ranges'} =
1211 $conf->exists('disable_line_item_date_ranges');
1213 warn "$me searching for line items\n"
1216 my %section_tax_lines;
1219 foreach my $line_item ( $self->_items_pkg(%options),
1220 $self->_items_fee(%options) ) {
1222 warn "$me adding line item ".
1223 join(', ', map "$_=>".$line_item->{$_}, keys %$line_item). "\n"
1226 push @buf, ( [ $line_item->{'description'},
1227 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1229 map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}},
1232 $line_item->{'ref'} = $line_item->{'pkgnum'};
1233 $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()?
1234 $line_item->{'section'} = $section;
1235 $line_item->{'description'} = &$escape_function($line_item->{'description'});
1236 $line_item->{'amount'} = $money_char.$line_item->{'amount'};
1238 if ( length($line_item->{'unit_amount'}) ) {
1239 $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'};
1241 $line_item->{'ext_description'} ||= [];
1243 if ( $options{section_with_taxes} && ref $line_item->{pkg_tax} ) {
1244 for my $line_tax ( @{$ line_item->{pkg_tax} } ) {
1246 # It is rarely possible for the same tax record to be presented here
1247 # multiple times. See cust_bill_pkg::_pkg_tax_list for more info
1248 next if $seen_tax_lines{ $line_tax->{billpkgtaxlocationnum} };
1249 $seen_tax_lines{ $line_tax->{billpkgtaxlocationnum} } = 1;
1251 $section_tax_lines{ $line_tax->{taxname} } += $line_tax->{amount};
1255 push @detail_items, $line_item;
1258 # If conf flag invoice_sections_with_taxes:
1259 # - Add @detail_items for taxes into each section
1260 # - Update section subtotal to include taxes
1261 if ( $options{section_with_taxes} && %section_tax_lines ) {
1262 for my $taxname ( keys %section_tax_lines ) {
1264 push @detail_items, {
1265 section => $section,
1266 amount => sprintf($money_char."%.2f",$section_tax_lines{$taxname}),
1267 description => &$escape_function($taxname),
1270 # Append taxes to total. If line format resembles "$5.00 to $12.00"
1271 # append to the second value.
1273 if ($section->{subtotal} =~ /to/) {
1274 my @subtotal = split /\s/, $section->{subtotal};
1275 $subtotal[2] =~ s/[^\d\.]//g;
1276 $subtotal[2] = sprintf(
1278 ( $subtotal[2] + $section_tax_lines{$taxname} )
1280 $section->{subtotal} = join ' ', @subtotal;
1282 $section->{subtotal} =~ s/[^\d\.]//g;
1283 $section->{subtotal} = sprintf(
1284 $money_char . "%.2f",
1285 ( $section->{subtotal} + $section_tax_lines{$taxname} )
1292 if ( $section->{'description'} ) {
1293 push @buf, ( ['','-----------'],
1294 [ $section->{'description'}. ' sub-total',
1295 $section->{'subtotal'} # already formatted this
1304 $invoice_data{current_less_finance} =
1305 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
1307 # if there's anything in the Previous Charges section, prepend it to the list
1308 if ( $pr_total and $previous_section ne $default_section ) {
1309 unshift @sections, $previous_section;
1310 # but not @summary_subtotals
1313 warn "$me adding taxes\n"
1316 # create a tax section if we don't yet have one
1317 my @items_tax = $self->_items_tax;
1318 my $tax_description = 'Taxes, Surcharges, and Fees';
1320 List::Util::first { $_->{description} eq $tax_description } @sections;
1321 if (!$tax_section) {
1322 $tax_section = { 'description' => $tax_description };
1323 push @sections, $tax_section if $multisection and @items_tax > 0;
1325 $tax_section->{tax_section} = 1; # mark this section as containing taxes
1326 # if this is an existing tax section, we're merging the tax items into it.
1327 # grab the taxtotal that's already there, strip the money symbol if any
1328 my $taxtotal = $tax_section->{'subtotal'} || 0;
1329 $taxtotal =~ s/^\Q$other_money_char\E//;
1332 #my $tax_weight = _pkg_category($tax_section->{description})
1333 # ? _pkg_category($tax_section->{description})->weight
1335 #$tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
1336 #$tax_section->{'sort_weight'} = $tax_weight;
1338 foreach my $tax ( @items_tax ) {
1340 $taxtotal += $tax->{'amount'};
1342 my $description = &$escape_function( $tax->{'description'} );
1343 my $amount = sprintf( '%.2f', $tax->{'amount'} );
1345 if ( $multisection ) {
1347 push @detail_items, {
1348 ext_description => [],
1351 description => $description,
1352 amount => $money_char. $amount,
1354 section => $tax_section,
1359 push @total_items, {
1360 'total_item' => $description,
1361 'total_amount' => $other_money_char. $amount,
1366 push @buf,[ $description,
1367 $money_char. $amount,
1374 $total->{'total_item'} = $self->mt('Sub-total');
1375 $total->{'total_amount'} =
1376 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
1378 if ( $multisection ) {
1379 if ( $taxtotal > 0 ) {
1380 # there are taxes, so prepare the section to be displayed.
1381 # $taxtotal already includes any line items that were already in the
1382 # section (fees, taxes that are charged as packages for some reason).
1383 # also set 'summarized' to false so that this isn't a summary-only
1385 $tax_section->{'subtotal'} = $other_money_char.
1386 sprintf('%.2f', $taxtotal);
1387 $tax_section->{'pretotal'} = 'New charges sub-total '.
1388 $total->{'total_amount'};
1389 $tax_section->{'description'} = $self->mt($tax_description);
1390 $tax_section->{'summarized'} = '';
1392 if ( $conf->config_bool('invoice_sections_with_taxes', $cust_main->agentnum) ) {
1394 # remove tax section if taxes are itemized within other sections
1395 @sections = grep{ $_ ne $tax_section } @sections;
1397 } elsif ( !grep $tax_section, @sections ) {
1399 # append it if it's not already there
1400 push @sections, $tax_section;
1401 push @summary_subtotals, $tax_section;
1408 unshift @total_items, $total;
1411 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1417 my %embolden_functions = (
1418 'latex' => sub { return '\textbf{'. shift(). '}' },
1419 'html' => sub { return '<b>'. shift(). '</b>' },
1420 'template' => sub { shift },
1422 my $embolden_function = $embolden_functions{$format};
1424 if ( $multisection ) {
1426 if ( $adjust_section->{'sort_weight'} ) {
1427 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1428 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1430 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1431 $other_money_char. sprintf('%.2f', $self->charged );
1436 if ( $self->can('_items_total') ) { # should always be true now
1438 # even for multisection, need plain text version
1440 my @new_total_items = $self->_items_total;
1442 push @buf,['','-----------'];
1444 foreach ( @new_total_items ) {
1445 my ($item, $amount) = ($_->{'total_item'}, $_->{'total_amount'});
1446 $_->{'total_item'} = &$embolden_function( $item );
1448 if ( ref($amount) ) {
1449 $_->{'total_amount'} = &$embolden_function(
1450 $other_money_char.$amount->[0]. ' to '.
1451 $other_money_char.$amount->[1]
1454 $_->{'total_amount'} = &$embolden_function( $other_money_char.$amount );
1457 # but if it's multisection, don't append to @total_items. the adjust
1458 # section has all this stuff
1459 push @total_items, $_ if !$multisection;
1460 push @buf, [ $item, $money_char.sprintf('%10.2f',$amount) ];
1463 push @buf, [ '', '' ];
1465 # if we're showing previous invoices, also show previous
1466 # credits and payments
1467 if ( $self->enable_previous
1468 and $self->can('_items_credits')
1469 and $self->can('_items_payments') )
1473 my $credittotal = 0;
1474 foreach my $credit (
1475 $self->_items_credits( 'template' => $template, 'trim_len' => 40 )
1479 $total->{'total_item'} = &$escape_function($credit->{'description'});
1480 $credittotal += $credit->{'amount'};
1481 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1482 if ( $multisection ) {
1483 push @detail_items, {
1484 ext_description => [],
1487 description => &$escape_function($credit->{'description'}),
1488 amount => $money_char . $credit->{'amount'},
1490 section => $adjust_section,
1493 push @total_items, $total;
1497 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1500 foreach my $credit (
1501 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1503 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1507 my $paymenttotal = 0;
1508 foreach my $payment (
1509 $self->_items_payments( 'template' => $template )
1512 $total->{'total_item'} = &$escape_function($payment->{'description'});
1513 $paymenttotal += $payment->{'amount'};
1514 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1515 if ( $multisection ) {
1516 push @detail_items, {
1517 ext_description => [],
1520 description => &$escape_function($payment->{'description'}),
1521 amount => $money_char . $payment->{'amount'},
1523 section => $adjust_section,
1526 push @total_items, $total;
1528 push @buf, [ $payment->{'description'},
1529 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1532 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1534 if ( $multisection ) {
1535 $adjust_section->{'subtotal'} = $other_money_char.
1536 sprintf('%.2f', $credittotal + $paymenttotal);
1538 #why this? because {sort_weight} forces the adjust_section to appear
1539 #in @extra_sections instead of @sections. obviously.
1540 push @sections, $adjust_section
1541 unless $adjust_section->{sort_weight};
1542 # do not summarize; adjustments there are shown according to
1546 # create Balance Due message
1549 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1550 $total->{'total_amount'} =
1551 &$embolden_function(
1552 $other_money_char. sprintf('%.2f', #why? $summarypage
1553 # ? $self->charged +
1554 # $self->billing_balance
1559 if ( $multisection && !$adjust_section->{sort_weight} ) {
1560 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1561 $total->{'total_amount'};
1563 push @total_items, $total;
1565 push @buf,['','-----------'];
1566 push @buf,[$self->balance_due_msg, $money_char.
1567 sprintf("%10.2f", $balance_due ) ];
1570 if ( $conf->exists('previous_balance-show_credit')
1571 and $cust_main->balance < 0 ) {
1572 my $credit_total = {
1573 'total_item' => &$embolden_function($self->credit_balance_msg),
1574 'total_amount' => &$embolden_function(
1575 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1578 if ( $multisection ) {
1579 $adjust_section->{'posttotal'} .= $newline_token .
1580 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1583 push @total_items, $credit_total;
1585 push @buf,['','-----------'];
1586 push @buf,[$self->credit_balance_msg, $money_char.
1587 sprintf("%10.2f", -$cust_main->balance ) ];
1591 } #end of default total adding ! can('_items_total')
1593 if ( $multisection ) {
1594 if ( $conf->exists('svc_phone_sections')
1595 && $self->can('_items_svc_phone_sections')
1599 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1600 $total->{'total_amount'} =
1601 &$embolden_function(
1602 $other_money_char. sprintf('%.2f', $balance_due)
1604 my $last_section = pop @sections;
1605 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1606 $total->{'total_amount'};
1607 push @sections, $last_section;
1609 push @sections, @$late_sections
1613 # make a discounts-available section, even without multisection
1614 if ( $conf->exists('discount-show_available')
1615 and my @discounts_avail = $self->_items_discounts_avail ) {
1616 my $discount_section = {
1617 'description' => $self->mt('Discounts Available'),
1622 push @sections, $discount_section; # do not summarize
1623 push @detail_items, map { +{
1624 'ref' => '', #should this be something else?
1625 'section' => $discount_section,
1626 'description' => &$escape_function( $_->{description} ),
1627 'amount' => $money_char . &$escape_function( $_->{amount} ),
1628 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1629 } } @discounts_avail;
1632 # not adding any more sections after this
1633 $invoice_data{summary_subtotals} = \@summary_subtotals;
1636 if ( $conf->exists('usage_class_summary')
1637 and $self->can('_items_usage_class_summary') ) {
1638 my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function, 'money_char' => $other_money_char);
1639 if ( @usage_subtotals ) {
1640 unshift @sections, $usage_subtotals[0]->{section}; # do not summarize
1641 unshift @detail_items, @usage_subtotals;
1645 # invoice history "section" (not really a section)
1646 # not to be included in any subtotals, completely independent of
1648 if ( $conf->exists('previous_invoice_history') and $cust_main->isa('FS::cust_main') ) {
1651 foreach my $cust_bill ( $cust_main->cust_bill ) {
1652 # XXX hardcoded format, and currently only 'charged'; add other fields
1653 # if they become necessary
1654 my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1655 $history{$date} ||= 0;
1656 $history{$date} += $cust_bill->charged;
1657 # just so we have a numeric sort key
1658 $monthorder{$date} ||= $cust_bill->_date;
1660 my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1662 my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1663 $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1666 # service locations: another option for template customization
1668 foreach my $item (@detail_items) {
1669 if ( $item->{locationnum} ) {
1670 $location_info{ $item->{locationnum} } ||= {
1671 FS::cust_location->by_key( $item->{locationnum} )->location_hash
1675 $invoice_data{location_info} = \%location_info;
1677 # debugging hook: call this with 'diag' => 1 to just get a hash of
1678 # the invoice variables
1679 return \%invoice_data if ( $params{'diag'} );
1681 # All sections and items are built; now fill in templates.
1682 my @includelist = ();
1683 push @includelist, 'summary' if $summarypage;
1684 foreach my $include ( @includelist ) {
1686 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1689 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1691 @inc_src = $conf->config($inc_file, $agentnum);
1695 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1697 my $convert_map = $convert_maps{$format}{$include};
1699 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1700 s/--\@\]/$delimiters{$format}[1]/g;
1703 &$convert_map( $conf->config($inc_file, $agentnum) );
1707 my $inc_tt = new Text::Template (
1709 SOURCE => [ map "$_\n", @inc_src ],
1710 DELIMITERS => $delimiters{$format},
1711 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1713 unless ( $inc_tt->compile() ) {
1714 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1715 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1719 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1721 $invoice_data{$include} =~ s/\n+$//
1722 if ($format eq 'latex');
1727 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1728 /invoice_lines\((\d*)\)/;
1729 $invoice_lines += $1 || scalar(@buf);
1732 die "no invoice_lines() functions in template?"
1733 if ( $format eq 'template' && !$wasfunc );
1735 if ( $invoice_lines ) {
1736 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1737 $invoice_data{'total_pages'}++
1738 if scalar(@buf) % $invoice_lines;
1741 #setup subroutine for the template
1742 $invoice_data{invoice_lines} = sub {
1743 my $lines = shift || scalar(@buf);
1752 if ($format eq 'template') {
1757 push @collect, split("\n",
1758 $text_template->fill_in( HASH => \%invoice_data )
1760 $invoice_data{'page'}++;
1762 map "$_\n", @collect;
1764 } else { # this is where we actually create the invoice
1766 if ( $params{no_addresses} ) {
1767 delete $invoice_data{$_} foreach qw(
1768 payname company address1 address2 city state zip country
1770 $invoice_data{returnaddress} = '~';
1773 warn "filling in template for invoice ". $self->invnum. "\n"
1775 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1778 $text_template->fill_in(HASH => \%invoice_data);
1782 sub notice_name { '('.shift->table.')'; }
1784 # this is not supposed to happen
1785 sub template_conf { warn "bare FS::Template_Mixin::template_conf";
1789 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1791 Returns an postscript invoice, as a scalar.
1793 Options can be passed as a hashref (recommended) or as a list of time, template
1794 and then any key/value pairs for any other options.
1796 I<time> an optional value used to control the printing of overdue messages. The
1797 default is now. It isn't the date of the invoice; that's the `_date' field.
1798 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1799 L<Time::Local> and L<Date::Parse> for conversion functions.
1801 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1808 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1809 my $ps = generate_ps($file);
1811 unlink($barcodefile) if $barcodefile;
1816 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1818 Returns an PDF invoice, as a scalar.
1820 Options can be passed as a hashref (recommended) or as a list of time, template
1821 and then any key/value pairs for any other options.
1823 I<time> an optional value used to control the printing of overdue messages. The
1824 default is now. It isn't the date of the invoice; that's the `_date' field.
1825 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1826 L<Time::Local> and L<Date::Parse> for conversion functions.
1828 I<template>, if specified, is the name of a suffix for alternate invoices.
1830 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1837 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1838 my $pdf = generate_pdf($file);
1840 unlink($barcodefile) if $barcodefile;
1845 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1847 Returns an HTML invoice, as a scalar.
1849 I<time> an optional value used to control the printing of overdue messages. The
1850 default is now. It isn't the date of the invoice; that's the `_date' field.
1851 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1852 L<Time::Local> and L<Date::Parse> for conversion functions.
1854 I<template>, if specified, is the name of a suffix for alternate invoices.
1856 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1858 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1859 when emailing the invoice as part of a multipart/related MIME email.
1867 %params = %{ shift() };
1871 $params{'format'} = 'html';
1873 $self->print_generic( %params );
1876 # quick subroutine for print_latex
1878 # There are ten characters that LaTeX treats as special characters, which
1879 # means that they do not simply typeset themselves:
1880 # # $ % & ~ _ ^ \ { }
1882 # TeX ignores blanks following an escaped character; if you want a blank (as
1883 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1887 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1888 $value =~ s/([<>])/\$$1\$/g;
1894 encode_entities($value);
1898 sub _html_escape_nbsp {
1899 my $value = _html_escape(shift);
1900 $value =~ s/ +/ /g;
1904 #utility methods for print_*
1906 sub _translate_old_latex_format {
1907 warn "_translate_old_latex_format called\n"
1914 if ( $line =~ /^%%Detail\s*$/ ) {
1916 push @template, q![@--!,
1917 q! foreach my $_tr_line (@detail_items) {!,
1918 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1919 q! $_tr_line->{'description'} .= !,
1920 q! "\\tabularnewline\n~~".!,
1921 q! join( "\\tabularnewline\n~~",!,
1922 q! @{$_tr_line->{'ext_description'}}!,
1926 while ( ( my $line_item_line = shift )
1927 !~ /^%%EndDetail\s*$/ ) {
1928 $line_item_line =~ s/'/\\'/g; # nice LTS
1929 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1930 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1931 push @template, " \$OUT .= '$line_item_line';";
1934 push @template, '}',
1937 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1939 push @template, '[@--',
1940 ' foreach my $_tr_line (@total_items) {';
1942 while ( ( my $total_item_line = shift )
1943 !~ /^%%EndTotalDetails\s*$/ ) {
1944 $total_item_line =~ s/'/\\'/g; # nice LTS
1945 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1946 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1947 push @template, " \$OUT .= '$total_item_line';";
1950 push @template, '}',
1954 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1955 push @template, $line;
1961 warn "$_\n" foreach @template;
1973 my $conf = $self->conf;
1975 #check for an invoice-specific override
1976 return $self->invoice_terms if $self->invoice_terms;
1978 #check for a customer- specific override
1979 my $cust_main = $self->cust_main;
1980 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1984 $agentnum = $cust_main->agentnum;
1985 } elsif ( my $prospect_main = $self->prospect_main ) {
1986 $agentnum = $prospect_main->agentnum;
1989 #use configured default
1990 $conf->config('invoice_default_terms', $agentnum) || '';
2000 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
2001 $duedate = $self->_date() + ( $1 * 86400 );
2002 } elsif ( $self->terms =~ /^End of Month$/ ) {
2003 my ($mon,$year) = (localtime($self->_date) )[4,5];
2005 until ( $mon < 12 ) { $mon -= 12; $year++; }
2006 my $nextmonth_first = timelocal(0,0,0,1,$mon,$year);
2007 $duedate = $nextmonth_first - 86400;
2018 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
2021 =item balance_due_msg
2025 sub balance_due_msg {
2027 my $msg = $self->mt('Balance Due');
2028 return $msg unless $self->terms; # huh?
2029 if ( !$self->conf->exists('invoice_show_prior_due_date')
2030 || $self->has_sections ) {
2031 # if enabled, the due date is shown with Total New Charges (see
2032 # _items_total) and not here
2033 # (yes, or if invoice_sections is enabled; this is just for compatibility)
2034 if ( $self->due_date ) {
2036 $self->conf->config('invoice_pay_by_msg', $self->agentnum)
2037 || 'Please pay by [_1]';
2038 $msg .= ' - ' . $self->mt($please_pay_by, $self->due_date2str('short')).
2040 unless $self->conf->config_bool('invoice_omit_due_date',$self->agentnum);
2041 } elsif ( $self->terms ) {
2042 $msg .= ' - '. $self->mt($self->terms);
2048 =item balance_due_date
2052 sub balance_due_date {
2054 my $conf = $self->conf;
2056 my $terms = $self->terms;
2057 if ( $terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
2058 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
2063 sub credit_balance_msg {
2065 $self->mt('Credit Balance Remaining')
2070 Returns a string with the date, for example: "3/20/2008", localized for the
2071 customer. Use _date_pretty_unlocalized for non-end-customer display use.
2077 $self->time2str_local('short', $self->_date);
2080 =item _date_pretty_unlocalized
2082 Returns a string with the date, for example: "3/20/2008", in the format
2083 configured for the back-office. Use _date_pretty for end-customer display use.
2087 sub _date_pretty_unlocalized {
2089 time2str($date_format, $self->_date);
2094 Emails this template.
2096 Options are passed as a hashref. Available options:
2102 If specified, overrides the default From: address.
2106 If specified, overrides the name of the sent document ("Invoice" or "Quotation")
2110 (Deprecated) If specified, is the name of a suffix for alternate template files.
2114 Options accepted by generate_email can also be used.
2120 my $opt = shift || {};
2121 if ($opt and !ref($opt)) {
2122 die ref($self). '->email called with positional parameters';
2125 return if $self->hide;
2127 my $error = send_email(
2128 $self->generate_email(
2129 'subject' => $self->email_subject($opt->{template}),
2130 %$opt, # template, etc.
2134 die "can't email: $error\n" if $error;
2137 =item generate_email OPTION => VALUE ...
2145 sender address, required
2149 alternate template name, optional
2153 email subject, optional
2157 notice name instead of "Invoice", optional
2161 Returns an argument list to be passed to L<FS::Misc::send_email>.
2168 sub generate_email {
2172 my $conf = $self->conf;
2174 my $me = '[FS::Template_Mixin::generate_email]';
2177 'from' => $args{'from'},
2178 'subject' => ($args{'subject'} || $self->email_subject),
2179 'custnum' => $self->custnum,
2180 'msgtype' => 'invoice',
2183 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
2185 my $cust_main = $self->cust_main;
2187 if (ref($args{'to'}) eq 'ARRAY') {
2188 $return{'to'} = $args{'to'};
2189 } elsif ( $cust_main ) {
2190 $return{'to'} = [ $cust_main->invoicing_list_emailonly ];
2193 my $tc = $self->template_conf;
2195 my @text; # array of lines
2196 my $html; # a big string
2197 my @related_parts; # will contain the text/HTML alternative, and images
2198 my $related; # will contain the multipart/related object
2200 if ( $conf->exists($tc. 'email_pdf') ) {
2201 if ( my $msgnum = $conf->config($tc.'email_pdf_msgnum') ) {
2203 warn "$me using '${tc}email_pdf_msgnum' in multipart message"
2206 my $msg_template = FS::msg_template->by_key($msgnum)
2207 or die "${tc}email_pdf_msgnum $msgnum not found\n";
2208 my $cust_msg = $msg_template->prepare(
2209 cust_main => $self->cust_main,
2211 msgtype => 'invoice',
2214 # XXX hack to make this work in the new cust_msg era; consider replacing
2215 # with cust_bill_send_with_notice events.
2216 my @parts = $cust_msg->parts;
2217 foreach my $part (@parts) { # will only have two parts, normally
2218 if ( $part->mime_type eq 'text/plain' ) {
2219 @text = @{ $part->body };
2220 } elsif ( $part->mime_type eq 'text/html' ) {
2221 $html = $part->bodyhandle->as_string;
2225 } elsif ( my @note = $conf->config($tc.'email_pdf_note') ) {
2227 warn "$me using '${tc}email_pdf_note' in multipart message"
2229 @text = $conf->config($tc.'email_pdf_note');
2230 $html = join('<BR>', @text);
2232 } # else use the plain text invoice
2237 if ( $conf->config($tc.'template') ) {
2239 warn "$me generating plain text invoice"
2242 # 'print_text' argument is no longer used
2243 @text = map Encode::encode_utf8($_), $self->print_text(\%args);
2247 warn "$me no plain text version exists; sending empty message body"
2254 my $text_part = build MIME::Entity (
2255 'Type' => 'text/plain',
2256 'Encoding' => 'quoted-printable',
2257 'Charset' => 'UTF-8',
2258 #'Encoding' => '7bit',
2260 'Disposition' => 'inline',
2265 if ( $conf->exists($tc.'html') ) {
2266 warn "$me generating HTML invoice"
2269 $args{'from'} =~ /\@([\w\.\-]+)/;
2270 my $from = $1 || 'example.com';
2271 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2274 my $agentnum = $cust_main ? $cust_main->agentnum
2275 : $self->prospect_main->agentnum;
2276 if ( defined($args{'template'}) && length($args{'template'})
2277 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
2280 $logo = 'logo_'. $args{'template'}. '.png';
2284 my $image_data = $conf->config_binary( $logo, $agentnum);
2286 push @related_parts, build MIME::Entity
2287 'Type' => 'image/png',
2288 'Encoding' => 'base64',
2289 'Data' => $image_data,
2290 'Filename' => 'logo.png',
2291 'Content-ID' => "<$content_id>",
2294 if ( ref($self) eq 'FS::cust_bill' && $conf->exists('invoice-barcode') ) {
2295 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2296 push @related_parts, build MIME::Entity
2297 'Type' => 'image/png',
2298 'Encoding' => 'base64',
2299 'Data' => $self->invoice_barcode(0),
2300 'Filename' => 'barcode.png',
2301 'Content-ID' => "<$barcode_content_id>",
2303 $args{'barcode_cid'} = $barcode_content_id;
2306 $html = $self->print_html({ 'cid'=>$content_id, %args });
2313 warn "$me creating HTML/text multipart message"
2316 $return{'nobody'} = 1;
2318 my $alternative = build MIME::Entity
2319 'Type' => 'multipart/alternative',
2320 #'Encoding' => '7bit',
2321 'Disposition' => 'inline'
2325 $alternative->add_part($text_part);
2328 $alternative->attach(
2329 'Type' => 'text/html',
2330 'Encoding' => 'quoted-printable',
2331 'Data' => [ '<html>',
2334 ' '. encode_entities($return{'subject'}),
2337 ' <body bgcolor="#e8e8e8">',
2338 Encode::encode_utf8($html),
2342 'Disposition' => 'inline',
2343 #'Filename' => 'invoice.pdf',
2346 unshift @related_parts, $alternative;
2348 $related = build MIME::Entity 'Type' => 'multipart/related',
2349 'Encoding' => '7bit';
2351 #false laziness w/Misc::send_email
2352 $related->head->replace('Content-type',
2353 $related->mime_type.
2354 '; boundary="'. $related->head->multipart_boundary. '"'.
2355 '; type=multipart/alternative'
2358 $related->add_part($_) foreach @related_parts;
2362 my @otherparts = ();
2363 if ( ref($self) eq 'FS::cust_bill' && $cust_main->email_csv_cdr ) {
2365 if ( $conf->config('voip-cdr_email_attach') eq 'zip' ) {
2367 my $data = join('', map "$_\n",
2368 $self->call_details(prepend_billed_number=>1)
2371 my $zip = new Archive::Zip;
2372 my $file = $zip->addString( $data, 'usage-'.$self->invnum.'.csv' );
2373 $file->desiredCompressionMethod( COMPRESSION_DEFLATED );
2376 my $SH = IO::Scalar->new(\$zipdata);
2377 my $status = $zip->writeToFileHandle($SH);
2378 die "Error zipping CDR attachment: $!" unless $status == AZ_OK;
2380 push @otherparts, build MIME::Entity
2381 'Type' => 'application/zip',
2382 'Encoding' => 'base64',
2384 'Disposition' => 'attachment',
2385 'Filename' => 'usage-'. $self->invnum. '.zip',
2388 } else { # } elsif ( $conf->config('voip-cdr_email_attach') eq 'csv' ) {
2390 push @otherparts, build MIME::Entity
2391 'Type' => 'text/csv',
2392 'Encoding' => '7bit',
2393 'Data' => [ map { "$_\n" }
2394 $self->call_details('prepend_billed_number' => 1)
2396 'Disposition' => 'attachment',
2397 'Filename' => 'usage-'. $self->invnum. '.csv',
2404 if ( $conf->exists($tc.'email_pdf') ) {
2409 # multipart/alternative
2415 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
2416 push @otherparts, $pdf;
2420 $return{'content-type'} = 'multipart/mixed'; # of the outer container
2422 $return{'mimeparts'} = [ $related, @otherparts ];
2423 $return{'type'} = 'multipart/related'; # of the first part
2425 $return{'mimeparts'} = [ $text_part, @otherparts ];
2426 $return{'type'} = 'text/plain';
2428 } elsif ( $html ) { # no PDF or CSV, strip the outer container
2429 $return{'mimeparts'} = \@related_parts;
2430 $return{'content-type'} = 'multipart/related';
2431 $return{'type'} = 'multipart/alternative';
2432 } else { # no HTML either
2433 $return{'body'} = \@text;
2434 $return{'content-type'} = 'text/plain';
2443 Returns a list suitable for passing to MIME::Entity->build(), representing
2444 this quotation or invoice as PDF attachment.
2451 'Type' => 'application/pdf',
2452 'Encoding' => 'base64',
2453 'Data' => [ $self->print_pdf(@_) ],
2454 'Disposition' => 'attachment',
2455 'Filename' => $self->pdf_filename,
2459 =item postal_mail_fsinc
2461 Sends this invoice to the Freeside Internet Services, Inc. print and mail
2467 use IO::Socket::SSL;
2469 use HTTP::Request::Common qw( POST );
2470 use Cpanel::JSON::XS;
2472 sub postal_mail_fsinc {
2473 my ( $self, %opt ) = @_;
2475 my $url = 'https://ws.freeside.biz/print';
2477 my $cust_main = $self->cust_main;
2478 my $agentnum = $cust_main->agentnum;
2479 my $bill_location = $cust_main->bill_location;
2481 die "Extra charges for international mailing; contact support\@freeside.biz to enable\n"
2482 if $bill_location->country ne 'US';
2484 my $conf = new FS::Conf;
2486 my @company_address = $conf->config('company_address', $agentnum);
2487 my ( $company_address1, $company_address2, $company_city, $company_state, $company_zip );
2488 if ( $company_address[2] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2489 $company_address1 = $company_address[0];
2490 $company_address2 = $company_address[1];
2492 $company_state = $2;
2494 } elsif ( $company_address[1] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2495 $company_address1 = $company_address[0];
2496 $company_address2 = '';
2498 $company_state = $2;
2501 die "Unparsable company_address; contact support\@freeside.biz\n";
2503 $company_city =~ s/,$//;
2505 my $file = $self->print_pdf(%opt, 'no_addresses' => 1);
2506 my $pages = CAM::PDF->new($file)->numPages;
2508 my $ua = LWP::UserAgent->new(
2510 verify_hostname => 0,
2511 SSL_verify_mode => IO::Socket::SSL::SSL_VERIFY_NONE,
2512 SSL_version => 'SSLv3',
2515 my $response = $ua->request( POST $url, [
2516 'support-key' => scalar($conf->config('support-key')),
2517 'file' => encode_base64($file),
2521 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
2522 'company_address1' => $company_address1,
2523 'company_address2' => $company_address2,
2524 'company_city' => $company_city,
2525 'company_state' => $company_state,
2526 'company_zip' => $company_zip,
2527 'company_country' => 'US',
2528 'company_phonenum' => scalar($conf->config('company_phonenum', $agentnum)),
2529 'company_email' => scalar($conf->config('invoice_from', $agentnum)),
2532 'name' => $cust_main->invoice_attn
2533 || $cust_main->contact_firstlast,
2534 'company' => $cust_main->company,
2535 'address1' => $bill_location->address1,
2536 'address2' => $bill_location->address2,
2537 'city' => $bill_location->city,
2538 'state' => $bill_location->state,
2539 'zip' => $bill_location->zip,
2540 'country' => $bill_location->country,
2543 die "Print connection error: ". $response->message.
2544 ' ('. $response->as_string. ")\n"
2545 unless $response->is_success;
2548 my $content = eval { decode_json($response->content) };
2549 die "Print JSON error : $@\n" if $@;
2551 die $content->{error}."\n"
2552 if $content->{error};
2554 #TODO: store this so we can query for a status later
2555 warn "Invoice printed, ID ". $content->{id}. "\n";
2561 =item _items_sections OPTIONS
2563 Generate section information for all items appearing on this invoice.
2564 This will only be called for multi-section invoices.
2566 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
2567 related display records (L<FS::cust_bill_pkg_display>) and organize
2568 them into two groups ("early" and "late" according to whether they come
2569 before or after the total), then into sections. A subtotal is calculated
2572 Section descriptions are returned in sort weight order. Each consists
2573 of a hash containing:
2575 description: the package category name, escaped
2576 subtotal: the total charges in that section
2577 tax_section: a flag indicating that the section contains only tax charges
2578 summarized: same as tax_section, for some reason
2579 sort_weight: the package category's sort weight
2581 If 'condense' is set on the display record, it also contains everything
2582 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
2583 coderefs to generate parts of the invoice. This is not advised.
2585 The method returns two arrayrefs, one of "early" sections and one of "late"
2588 OPTIONS may include:
2590 by_location: a flag to divide the invoice into sections by location.
2591 Each section hash will have a 'location' element containing a hashref of
2592 the location fields (see L<FS::cust_location>). The section description
2593 will be the location label, but the template can use any of the location
2594 fields to create a suitable label.
2596 by_category: a flag to divide the invoice into sections using display
2597 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
2598 behavior. Each section hash will have a 'category' element containing
2599 the section name from the display record (which probably equals the
2600 category name of the package, but may not in some cases).
2602 summary: a flag indicating that this is a summary-format invoice.
2603 Turning this on has the following effects:
2604 - Ignores display items with the 'summary' flag.
2605 - Places all sections in the "early" group even if they have post_total.
2606 - Creates sections for all non-disabled package categories, even if they
2607 have no charges on this invoice, as well as a section with no name.
2609 escape: an escape function to use for section titles.
2611 extra_sections: an arrayref of additional sections to return after the
2612 sorted list. If there are any of these, section subtotals exclude
2615 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
2616 passed through to C<_condense_section()>.
2620 use vars qw(%pkg_category_cache);
2621 sub _items_sections {
2625 my $escape = $opt{escape};
2626 my @extra_sections = @{ $opt{extra_sections} || [] };
2628 # $subtotal{$locationnum}{$categoryname} = amount.
2629 # if we're not using by_location, $locationnum is undef.
2630 # if we're not using by_category, you guessed it, $categoryname is undef.
2631 # if we're not using either one, we shouldn't be here in the first place...
2633 my %late_subtotal = ();
2636 # About tax items + multisection invoices:
2637 # If either invoice_*summary option is enabled, AND there is a
2638 # package category with the name of the tax, then there will be
2639 # a display record assigning the tax item to that category.
2641 # However, the taxes are always placed in the "Taxes, Surcharges,
2642 # and Fees" section regardless of that. The only effect of the
2643 # display record is to create a subtotal for the summary page.
2646 my $pkg_hash = $self->cust_pkg_hash;
2648 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2651 my $usage = $cust_bill_pkg->usage;
2654 if ( $opt{by_location} ) {
2655 if ( $cust_bill_pkg->pkgnum ) {
2656 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2661 $locationnum = undef;
2664 # as in _items_cust_pkg, if a line item has no display records,
2665 # cust_bill_pkg_display() returns a default record for it
2667 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2668 next if ( $display->summary && $opt{summary} );
2670 #my $section = $display->section;
2671 #false laziness with the method, but for efficiency inside this loop
2672 my $section = $display->get('section');
2673 if ( !$section && !$cust_bill_pkg->hidden ) {
2674 $section = $cust_bill_pkg->get('categoryname'); #cust_bill->cust_bill_pkg added it (XXX quotations / quotation_section)
2677 my $type = $display->type;
2678 # Set $section = undef if we're sectioning by location and this
2679 # line item _has_ a location (i.e. isn't a fee).
2680 $section = undef if $locationnum;
2682 # set this flag if the section is not tax-only
2683 $not_tax{$locationnum}{$section} = 1
2684 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
2686 # there's actually a very important piece of logic buried in here:
2687 # incrementing $late_subtotal{$section} CREATES
2688 # $late_subtotal{$section}. keys(%late_subtotal) is later used
2689 # to define the list of late sections, and likewise keys(%subtotal).
2690 # When _items_cust_bill_pkg is called to generate line items for
2691 # real, it will be called with 'section' => $section for each
2693 if ( $display->post_total && !$opt{summary} ) {
2694 if (! $type || $type eq 'S') {
2695 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2696 if $cust_bill_pkg->setup != 0
2697 || $cust_bill_pkg->setup_show_zero;
2701 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
2702 if $cust_bill_pkg->recur != 0
2703 || $cust_bill_pkg->recur_show_zero;
2706 if ($type && $type eq 'R') {
2707 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2708 if $cust_bill_pkg->recur != 0
2709 || $cust_bill_pkg->recur_show_zero;
2712 if ($type && $type eq 'U') {
2713 $late_subtotal{$locationnum}{$section} += $usage
2714 unless scalar(@extra_sections);
2717 } else { # it's a pre-total (normal) section
2719 # skip tax items unless they're explicitly included in a section
2720 next if $cust_bill_pkg->pkgnum == 0 and
2721 ! $cust_bill_pkg->feepart and
2724 if ( $type eq 'S' ) {
2725 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2726 if $cust_bill_pkg->setup != 0
2727 || $cust_bill_pkg->setup_show_zero;
2728 } elsif ( $type eq 'R' ) {
2729 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2730 if $cust_bill_pkg->recur != 0
2731 || $cust_bill_pkg->recur_show_zero;
2732 } elsif ( $type eq 'U' ) {
2733 $subtotal{$locationnum}{$section} += $usage
2734 unless scalar(@extra_sections);
2735 } elsif ( !$type ) {
2736 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2737 + $cust_bill_pkg->recur;
2746 %pkg_category_cache = ();
2748 # summary invoices need subtotals for all non-disabled package categories,
2749 # even if they're zero
2750 # but currently assume that there are no location sections, or at least
2751 # that the summary page doesn't care about them
2752 if ( $opt{summary} ) {
2753 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2754 $subtotal{''}{$category->categoryname} ||= 0;
2756 $subtotal{''}{''} ||= 0;
2760 foreach my $post_total (0,1) {
2762 my $s = $post_total ? \%late_subtotal : \%subtotal;
2763 foreach my $locationnum (keys %$s) {
2764 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2766 'subtotal' => $s->{$locationnum}{$sectionname},
2769 if ( $locationnum ) {
2770 $section->{'locationnum'} = $locationnum;
2771 my $location = FS::cust_location->by_key($locationnum);
2772 $section->{'description'} = &{ $escape }($location->location_label);
2773 # Better ideas? This will roughly group them by proximity,
2774 # which alpha sorting on any of the address fields won't.
2775 # Sorting by locationnum is meaningless.
2776 # We have to sort on _something_ or the order may change
2777 # randomly from one invoice to the next, which will confuse
2779 $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
2781 $section->{'location'} = {
2782 label_prefix => &{ $escape }($location->label_prefix),
2783 map { $_ => &{ $escape }($location->get($_)) }
2787 $section->{'category'} = $sectionname;
2788 $section->{'description'} = &{ $escape }($sectionname);
2789 if ( _pkg_category($sectionname) ) {
2790 $section->{'sort_weight'} = _pkg_category($sectionname)->weight;
2791 if ( _pkg_category($sectionname)->condense ) {
2792 $section = { %$section, $self->_condense_section($opt{format}) };
2796 if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
2797 # then it's a tax-only section
2798 $section->{'summarized'} = 'Y';
2799 $section->{'tax_section'} = 'Y';
2801 push @these, $section;
2802 } # foreach $sectionname
2803 } #foreach $locationnum
2804 push @these, @extra_sections if $post_total == 0;
2805 # need an alpha sort for location sections, because postal codes can
2807 $sections[ $post_total ] = [ sort {
2808 $opt{'by_location'} ?
2809 ($a->{sort_weight} cmp $b->{sort_weight}) :
2810 ($a->{sort_weight} <=> $b->{sort_weight})
2812 } #foreach $post_total
2814 return @sections; # early, late
2817 #helper subs for above
2821 $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2825 my $categoryname = shift;
2826 $pkg_category_cache{$categoryname} ||=
2827 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2830 my %condensed_format = (
2831 'label' => [ qw( Description Qty Amount ) ],
2833 sub { shift->{description} },
2834 sub { shift->{quantity} },
2835 sub { my($href, %opt) = @_;
2836 ($opt{dollar} || ''). $href->{amount};
2839 'align' => [ qw( l r r ) ],
2840 'span' => [ qw( 5 1 1 ) ], # unitprices?
2841 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
2844 sub _condense_section {
2845 my ( $self, $format ) = ( shift, shift );
2847 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2848 qw( description_generator
2851 total_line_generator
2856 sub _condensed_generator_defaults {
2857 my ( $self, $format ) = ( shift, shift );
2858 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2867 sub _condensed_header_generator {
2868 my ( $self, $format ) = ( shift, shift );
2870 my ( $f, $prefix, $suffix, $separator, $column ) =
2871 _condensed_generator_defaults($format);
2873 if ($format eq 'latex') {
2874 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2875 $suffix = "\\\\\n\\hline";
2878 sub { my ($d,$a,$s,$w) = @_;
2879 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2881 } elsif ( $format eq 'html' ) {
2882 $prefix = '<th></th>';
2886 sub { my ($d,$a,$s,$w) = @_;
2887 return qq!<th align="$html_align{$a}">$d</th>!;
2895 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2897 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2900 $prefix. join($separator, @result). $suffix;
2905 sub _condensed_description_generator {
2906 my ( $self, $format ) = ( shift, shift );
2908 my ( $f, $prefix, $suffix, $separator, $column ) =
2909 _condensed_generator_defaults($format);
2911 my $money_char = '$';
2912 if ($format eq 'latex') {
2913 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2915 $separator = " & \n";
2917 sub { my ($d,$a,$s,$w) = @_;
2918 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2920 $money_char = '\\dollar';
2921 }elsif ( $format eq 'html' ) {
2922 $prefix = '"><td align="center"></td>';
2926 sub { my ($d,$a,$s,$w) = @_;
2927 return qq!<td align="$html_align{$a}">$d</td>!;
2929 #$money_char = $conf->config('money_char') || '$';
2930 $money_char = ''; # this is madness
2938 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2940 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2942 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2943 map { $f->{$_}->[$i] } qw(align span width)
2947 $prefix. join( $separator, @result ). $suffix;
2952 sub _condensed_total_generator {
2953 my ( $self, $format ) = ( shift, shift );
2955 my ( $f, $prefix, $suffix, $separator, $column ) =
2956 _condensed_generator_defaults($format);
2959 if ($format eq 'latex') {
2962 $separator = " & \n";
2964 sub { my ($d,$a,$s,$w) = @_;
2965 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2967 }elsif ( $format eq 'html' ) {
2971 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2973 sub { my ($d,$a,$s,$w) = @_;
2974 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2983 # my $r = &{$f->{fields}->[$i]}(@args);
2984 # $r .= ' Total' unless $i;
2986 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2988 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
2989 map { $f->{$_}->[$i] } qw(align span width)
2993 $prefix. join( $separator, @result ). $suffix;
2998 =item total_line_generator FORMAT
3000 Returns a coderef used for generation of invoice total line items for this
3001 usage_class. FORMAT is either html or latex
3005 # should not be used: will have issues with hash element names (description vs
3006 # total_item and amount vs total_amount -- another array of functions?
3008 sub _condensed_total_line_generator {
3009 my ( $self, $format ) = ( shift, shift );
3011 my ( $f, $prefix, $suffix, $separator, $column ) =
3012 _condensed_generator_defaults($format);
3015 if ($format eq 'latex') {
3018 $separator = " & \n";
3020 sub { my ($d,$a,$s,$w) = @_;
3021 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
3023 }elsif ( $format eq 'html' ) {
3027 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
3029 sub { my ($d,$a,$s,$w) = @_;
3030 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
3039 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
3041 &{$column}( &{$f->{fields}->[$i]}(@args),
3042 map { $f->{$_}->[$i] } qw(align span width)
3046 $prefix. join( $separator, @result ). $suffix;
3051 =item _items_pkg [ OPTIONS ]
3053 Return line item hashes for each package item on this invoice. Nearly
3056 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
3058 OPTIONS are passed through to _items_cust_bill_pkg, and should include
3059 'format' and 'escape_function' at minimum.
3061 To produce items for a specific invoice section, OPTIONS should include
3062 'section', a hashref containing 'category' and/or 'locationnum' keys.
3064 'section' may also contain a key named 'condensed'. If this is present
3065 and has a true value, _items_pkg will try to merge identical items into items
3066 with 'quantity' equal to the number of items (not the sum of their separate
3067 quantities, for some reason).
3073 # The order of these is important. Bundled line items will be merged into
3074 # the most recent non-hidden item, so it needs to be the one with:
3076 # - the same start date
3077 # - no pkgpart_override
3079 # So: sort by pkgnum,
3081 # then sort the base line item before any overrides
3082 # then sort hidden before non-hidden add-ons
3083 # then sort by override pkgpart (for consistency)
3084 sort { $a->pkgnum <=> $b->pkgnum or
3085 $a->sdate <=> $b->sdate or
3086 ($a->pkgpart_override ? 0 : -1) or
3087 ($b->pkgpart_override ? 0 : 1) or
3088 $b->hidden cmp $a->hidden or
3089 $a->pkgpart_override <=> $b->pkgpart_override
3091 # and of course exclude taxes and fees
3092 grep { $_->pkgnum > 0 } $self->cust_bill_pkg;
3098 my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
3099 my $escape_function = $options{escape_function};
3101 my $locale = $self->cust_main->locale;
3104 foreach my $cust_bill_pkg (@cust_bill_pkg) {
3105 # cache this, so we don't look it up again in every section
3106 my $part_fee = $cust_bill_pkg->get('part_fee')
3107 || $cust_bill_pkg->part_fee;
3108 $cust_bill_pkg->set('part_fee', $part_fee);
3110 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
3111 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
3114 if ( exists($options{section}) and exists($options{section}{category}) )
3116 my $categoryname = $options{section}{category};
3117 # then filter for items that have that section
3118 if ( $part_fee->categoryname ne $categoryname ) {
3119 warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
3122 } # otherwise include them all in the main section
3123 # XXX what to do when sectioning by location?
3126 my %base_invnums; # invnum => invoice date
3127 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
3128 if ($_->base_invnum) {
3129 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
3130 my $base_date = $self->time2str_local('short', $base_bill->_date)
3132 $base_invnums{$_->base_invnum} = $base_date || '';
3135 foreach (sort keys(%base_invnums)) {
3136 next if $_ == $self->invnum;
3137 # per convention, we must escape ext_description lines
3139 &{$escape_function}(
3140 $self->mt('from invoice #[_1] on [_2]', $_, $base_invnums{$_})
3143 my $desc = $part_fee->itemdesc_locale($locale);
3144 # but not escape the base description line
3146 my @pkg_tax = $cust_bill_pkg->_pkg_tax_list
3147 if $options{section_with_taxes};
3150 { feepart => $cust_bill_pkg->feepart,
3151 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
3152 description => $desc,
3153 pkg_tax => \@pkg_tax,
3154 ext_description => \@ext_desc
3165 warn "$me _items_pkg searching for all package line items\n"
3168 my @cust_bill_pkg = $self->_items_nontax;
3170 warn "$me _items_pkg filtering line items\n"
3172 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3174 if ($options{section} && $options{section}->{condensed}) {
3176 warn "$me _items_pkg condensing section\n"
3180 local $Storable::canonical = 1;
3181 foreach ( @items ) {
3183 delete $item->{ref};
3184 delete $item->{ext_description};
3185 my $key = freeze($item);
3186 $itemshash{$key} ||= 0;
3187 $itemshash{$key} ++; # += $item->{quantity};
3189 @items = sort { $a->{description} cmp $b->{description} }
3190 map { my $i = thaw($_);
3191 $i->{quantity} = $itemshash{$_};
3193 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
3199 warn "$me _items_pkg returning ". scalar(@items). " items\n"
3206 return 0 unless $a->itemdesc cmp $b->itemdesc;
3207 return -1 if $b->itemdesc eq 'Tax';
3208 return 1 if $a->itemdesc eq 'Tax';
3209 return -1 if $b->itemdesc eq 'Other surcharges';
3210 return 1 if $a->itemdesc eq 'Other surcharges';
3211 $a->itemdesc cmp $b->itemdesc;
3216 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
3217 $self->cust_bill_pkg;
3218 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3220 if ( $self->conf->exists('always_show_tax') ) {
3221 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
3222 if (0 == grep { $_->{description} eq $itemdesc } @items) {
3224 { 'description' => $itemdesc,
3231 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
3233 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
3234 list of hashrefs describing the line items they generate on the invoice.
3236 OPTIONS may include:
3238 format: the invoice format.
3240 escape_function: the function used to escape strings.
3242 DEPRECATED? (expensive, mostly unused?)
3243 format_function: the function used to format CDRs.
3245 section: a hashref containing 'category' and/or 'locationnum'; if this
3246 is present, only returns line items that belong to that category and/or
3247 location (whichever is defined).
3249 multisection: a flag indicating that this is a multisection invoice,
3250 which does something complicated.
3252 section_with_taxes: Look up and include applied taxes for each record
3254 Returns a list of hashrefs, each of which may contain:
3256 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
3257 ext_description, which is an arrayref of detail lines to show below
3262 sub _items_cust_bill_pkg {
3264 my $conf = $self->conf;
3265 my $cust_bill_pkgs = shift;
3268 my $format = $opt{format} || '';
3269 my $escape_function = $opt{escape_function} || sub { shift };
3270 my $format_function = $opt{format_function} || '';
3271 my $no_usage = $opt{no_usage} || '';
3272 my $unsquelched = $opt{unsquelched} || ''; #unused
3273 my ($section, $locationnum, $category);
3274 if ( $opt{section} ) {
3275 $category = $opt{section}->{category};
3276 $locationnum = $opt{section}->{locationnum};
3278 my $summary_page = $opt{summary_page} || ''; #unused
3279 my $multisection = defined($category) || defined($locationnum);
3280 # this variable is the value of the config setting, not whether it applies
3281 # to this particular line item.
3282 my $discount_show_always = $conf->exists('discount-show-always');
3284 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 40;
3286 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
3288 my $agentnum = $self->agentnum;
3290 # for location labels: use default location on the invoice date
3291 my $default_locationnum;
3292 if ( $conf->exists('invoice-all_pkg_addresses') ) {
3293 $default_locationnum = 0; # treat them all as non-default
3294 } elsif ( $self->custnum ) {
3296 my @h_search = FS::h_cust_main->sql_h_search($self->_date);
3297 $h_cust_main = qsearchs({
3298 'table' => 'h_cust_main',
3299 'hashref' => { custnum => $self->custnum },
3300 'extra_sql' => $h_search[1],
3301 'addl_from' => $h_search[3],
3303 $default_locationnum = $h_cust_main->ship_locationnum;
3304 } elsif ( $self->prospectnum ) {
3305 my $cust_location = qsearchs('cust_location',
3306 { prospectnum => $self->prospectnum,
3308 $default_locationnum = $cust_location->locationnum if $cust_location;
3311 my @b = (); # accumulator for the line item hashes that we'll return
3312 my ($s, $r, $u, $d) = ( undef, undef, undef, undef );
3313 # the 'current' line item hashes for setup, recur, usage, discount
3314 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
3316 # if the current line item is waiting to go out, and the one we're about
3317 # to start is not bundled, then push out the current one and start a new
3320 $d->{amount} = $d->{setup_amount} + $d->{recur_amount};
3322 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3323 if ( $_ && !$cust_bill_pkg->hidden ) {
3324 $_->{amount} = sprintf( "%.2f", $_->{amount} );
3325 $_->{amount} =~ s/^\-0\.00$/0.00/;
3326 if (exists($_->{unit_amount})) {
3327 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3330 # we already decided to create this display line; don't reconsider it
3332 # if $_->{amount} != 0
3333 # || $discount_show_always
3334 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3335 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3341 if ( $locationnum ) {
3342 # this is a location section; skip packages that aren't at this
3344 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
3345 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
3349 # Consider display records for this item to determine if it belongs
3350 # in this section. Note that if there are no display records, there
3351 # will be a default pseudo-record that includes all charge types
3352 # and has no section name.
3353 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
3354 ? $cust_bill_pkg->cust_bill_pkg_display
3355 : ( $cust_bill_pkg );
3357 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
3358 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
3361 if ( defined($category) ) {
3362 # then this is a package category section; process all display records
3363 # that belong to this section.
3364 @cust_bill_pkg_display = grep { $_->section eq $category }
3365 @cust_bill_pkg_display;
3367 # otherwise, process all display records that aren't usage summaries
3368 # (I don't think there should be usage summaries if you aren't using
3369 # category sections, but this is the historical behavior)
3370 @cust_bill_pkg_display = grep { !$_->summary }
3371 @cust_bill_pkg_display;
3374 my $classname = ''; # package class name, will fill in later
3376 foreach my $display (@cust_bill_pkg_display) {
3378 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
3379 $display->billpkgdisplaynum. "\n"
3382 my $type = $display->type;
3384 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
3385 $desc = substr($desc, 0, $maxlength). '...'
3386 if $format eq 'latex' && length($desc) > $maxlength;
3388 my %details_opt = ( 'format' => $format,
3389 'escape_function' => $escape_function,
3390 'format_function' => $format_function,
3391 'no_usage' => $opt{'no_usage'},
3394 if ( $cust_bill_pkg->pkgnum > 0 ) {
3395 # a "normal" package line item (not a quotation, not a fee, not a tax)
3397 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
3400 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3401 my $part_pkg = $cust_pkg->part_pkg;
3403 # which pkgpart to show for display purposes?
3404 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
3406 # start/end dates for invoice formats that do nonstandard
3408 my %item_dates = ();
3409 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
3410 unless $part_pkg->option('disable_line_item_date_ranges',1);
3412 # not normally used, but pass this to the template anyway
3413 $classname = $part_pkg->classname;
3415 my @pkg_tax = $cust_bill_pkg->_pkg_tax_list
3416 if $self->conf->exists('invoice_sections_with_taxes');
3418 if ( (!$type || $type eq 'S')
3419 && ( $cust_bill_pkg->setup != 0
3420 || $cust_bill_pkg->setup_show_zero
3421 || ($discount_show_always and $cust_bill_pkg->unitsetup > 0)
3426 warn "$me _items_cust_bill_pkg adding setup\n"
3429 # append the word 'Setup' to the setup line if there's going to be
3430 # a recur line for the same package (i.e. not a one-time charge)
3432 my $description = $desc;
3433 $description .= ' Setup'
3434 if $cust_bill_pkg->recur != 0
3435 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3436 || $cust_bill_pkg->recur_show_zero;
3438 my $disable_date_ranges =
3439 $opt{disable_line_item_date_ranges}
3440 || $part_pkg->option('disable_line_item_date_ranges', 1);
3442 $description .= $cust_bill_pkg->time_period_pretty(
3445 disable_date_ranges => $disable_date_ranges,
3447 if $part_pkg->is_prepaid #for prepaid, "display the validity period
3448 # triggered by the recurring charge freq
3450 && $cust_bill_pkg->recur == 0
3451 && ! $cust_bill_pkg->recur_show_zero;
3456 # always pass the svc_label through to the template, even if
3457 # not displaying it as an ext_description
3458 my @svc_labels = map &{$escape_function}($_),
3459 $cust_pkg->h_labels_short($self->_date,
3462 $self->conf->{locale},
3464 $svc_label = $svc_labels[0];
3466 unless ( $cust_pkg->part_pkg->hide_svc_detail
3467 || $cust_bill_pkg->hidden )
3470 push @d, @svc_labels
3471 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3472 # show the location label if it's not the customer's default
3473 # location, and we're not grouping items by location already
3474 if ( $cust_pkg->locationnum != $default_locationnum
3475 and !defined($locationnum) ) {
3476 my $loc = $cust_pkg->location_label;
3477 $loc = substr($loc, 0, $maxlength). '...'
3478 if $format eq 'latex' && length($loc) > $maxlength;
3479 push @d, &{$escape_function}($loc);
3482 } #unless hiding service details
3484 push @d, $cust_bill_pkg->details(%details_opt)
3485 if $cust_bill_pkg->recur == 0;
3487 if ( $cust_bill_pkg->hidden ) {
3488 $s->{amount} += $cust_bill_pkg->setup;
3489 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3490 push @{ $s->{ext_description} }, @d;
3493 billpkgnum => $cust_bill_pkg->billpkgnum,
3495 description => $description,
3496 pkgpart => $pkgpart,
3497 pkgnum => $cust_bill_pkg->pkgnum,
3498 amount => $cust_bill_pkg->setup,
3499 setup_show_zero => $cust_bill_pkg->setup_show_zero,
3500 unit_amount => $cust_bill_pkg->unitsetup,
3501 quantity => $cust_bill_pkg->quantity,
3502 ext_description => \@d,
3503 svc_label => ($svc_label || ''),
3504 locationnum => $cust_pkg->locationnum, # sure, why not?
3505 pkg_tax => \@pkg_tax,
3511 # should we show a recur line?
3512 # if type eq 'S', then NO, because we've been told not to.
3513 # otherwise, show the recur line if:
3514 # - there's a recurring charge
3515 # - or recur_show_zero is on
3516 # - or there's a positive unitrecur (so it's been discounted to zero)
3517 # and discount-show-always is on
3518 if ( ( !$type || $type eq 'R' || $type eq 'U' )
3520 $cust_bill_pkg->recur != 0
3522 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3523 || $cust_bill_pkg->recur_show_zero
3528 warn "$me _items_cust_bill_pkg adding recur/usage\n"
3531 my $is_summary = $display->summary;
3532 my $description = $desc;
3533 if ( $type eq 'U' and defined($r) ) {
3534 # don't just show the same description as the recur line
3535 $description = $self->mt('Usage charges');
3538 my $disable_date_ranges =
3539 $opt{disable_line_item_date_ranges}
3540 || $part_pkg->option('disable_line_item_date_ranges', 1);
3542 $description .= $cust_bill_pkg->time_period_pretty(
3545 disable_date_ranges => $disable_date_ranges,
3549 my @seconds = (); # for display of usage info
3552 #at least until cust_bill_pkg has "past" ranges in addition to
3553 #the "future" sdate/edate ones... see #3032
3554 my @dates = ( $self->_date );
3555 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
3556 push @dates, $prev->sdate if $prev;
3557 push @dates, undef if !$prev;
3559 my @svc_labels = map &{$escape_function}($_),
3560 $cust_pkg->h_labels_short(@dates,
3562 $self->conf->{locale});
3563 $svc_label = $svc_labels[0];
3565 # show service labels, unless...
3566 # the package is set not to display them
3567 unless ( $part_pkg->hide_svc_detail
3568 # or this is a tax-like line item
3569 || $cust_bill_pkg->itemdesc
3570 # or this is a hidden (bundled) line item
3571 || $cust_bill_pkg->hidden
3572 # or this is a usage summary line
3573 || $is_summary && $type && $type eq 'U'
3574 # or this is a usage line and there's a recurring line
3575 # for the package in the same section (which will
3576 # have service labels already)
3577 || ($type eq 'U' and defined($r))
3581 warn "$me _items_cust_bill_pkg adding service details\n"
3584 push @d, @svc_labels
3585 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3586 warn "$me _items_cust_bill_pkg done adding service details\n"
3589 # show the location label if it's not the customer's default
3590 # location, and we're not grouping items by location already
3591 if ( $cust_pkg->locationnum != $default_locationnum
3592 and !defined($locationnum) ) {
3593 my $loc = $cust_pkg->location_label;
3594 $loc = substr($loc, 0, $maxlength). '...'
3595 if $format eq 'latex' && length($loc) > $maxlength;
3596 push @d, &{$escape_function}($loc);
3599 # Display of seconds_since_sqlradacct:
3600 # On the invoice, when processing @detail_items, look for a field
3601 # named 'seconds'. This will contain total seconds for each
3602 # service, in the same order as @ext_description. For services
3603 # that don't support this it will show undef.
3604 if ( $conf->exists('svc_acct-usage_seconds')
3605 and ! $cust_bill_pkg->pkgpart_override ) {
3606 foreach my $cust_svc (
3607 $cust_pkg->h_cust_svc(@dates, 'I')
3610 # eval because not having any part_export_usage exports
3611 # is a fatal error, last_bill/_date because that's how
3612 # sqlradius_hour billing does it
3614 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
3616 push @seconds, $sec;
3618 } #if svc_acct-usage_seconds
3620 } # if we are showing service labels
3622 unless ( $is_summary ) {
3623 warn "$me _items_cust_bill_pkg adding details\n"
3626 #instead of omitting details entirely in this case (unwanted side
3627 # effects), just omit CDRs
3628 $details_opt{'no_usage'} = 1
3629 if $type && $type eq 'R';
3631 push @d, $cust_bill_pkg->details(%details_opt);
3634 warn "$me _items_cust_bill_pkg calculating amount\n"
3639 $amount = $cust_bill_pkg->recur;
3640 } elsif ($type eq 'R') {
3641 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
3642 } elsif ($type eq 'U') {
3643 $amount = $cust_bill_pkg->usage;
3646 if ( !$type || $type eq 'R' ) {
3648 warn "$me _items_cust_bill_pkg adding recur\n"
3652 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
3655 if ( $cust_bill_pkg->hidden ) {
3656 $r->{amount} += $amount;
3657 $r->{unit_amount} += $unit_amount;
3658 push @{ $r->{ext_description} }, @d;
3661 billpkgnum => $cust_bill_pkg->billpkgnum,
3662 description => $description,
3663 pkgpart => $pkgpart,
3664 pkgnum => $cust_bill_pkg->pkgnum,
3666 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3667 unit_amount => $unit_amount,
3668 quantity => $cust_bill_pkg->quantity,
3670 ext_description => \@d,
3671 svc_label => ($svc_label || ''),
3672 locationnum => $cust_pkg->locationnum,
3673 pkg_tax => \@pkg_tax,
3675 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3678 } else { # $type eq 'U'
3680 warn "$me _items_cust_bill_pkg adding usage\n"
3683 if ( $cust_bill_pkg->hidden and defined($u) ) {
3684 # if this is a hidden package and there's already a usage
3685 # line for the bundle, add this package's total amount and
3686 # usage details to it
3687 $u->{amount} += $amount;
3688 push @{ $u->{ext_description} }, @d;
3689 } elsif ( $amount ) {
3690 # create a new usage line
3692 billpkgnum => $cust_bill_pkg->billpkgnum,
3693 description => $description,
3694 pkgpart => $pkgpart,
3695 pkgnum => $cust_bill_pkg->pkgnum,
3698 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3700 ext_description => \@d,
3701 locationnum => $cust_pkg->locationnum,
3702 pkg_tax => \@pkg_tax,
3704 } # else this has no usage, so don't create a usage section
3707 } # recurring or usage with recurring charge
3709 } else { # taxes and fees
3711 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3714 # items of this kind should normally not have sdate/edate.
3716 'description' => $desc,
3717 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
3718 + $cust_bill_pkg->recur)
3721 } # if package line item / other line item
3723 # decide whether to show active discounts here
3725 # case 1: we are showing a single line for the package
3727 # case 2: we are showing a setup line for a package that has
3728 # no base recurring fee
3729 or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3730 # case 3: we are showing a recur line for a package that has
3731 # a base recurring fee
3732 or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3735 my $item_discount = $cust_bill_pkg->_item_discount;
3736 if ( $item_discount ) {
3737 # $item_discount->{amount} is negative
3739 if ( $d and $cust_bill_pkg->hidden ) {
3740 $d->{setup_amount} += $item_discount->{setup_amount};
3741 $d->{recur_amount} += $item_discount->{recur_amount};
3743 $d = $item_discount;
3744 $_ = &{$escape_function}($_) foreach @{ $d->{ext_description} };
3747 # update the active line (before the discount) to show the
3748 # original price (whether this is a hidden line or not)
3750 $s->{amount} -= $item_discount->{setup_amount} if $s;
3751 $r->{amount} -= $item_discount->{recur_amount} if $r;
3753 } # if there are any discounts
3754 } # if this is an appropriate place to show discounts
3756 } # foreach $display
3760 # discount amount is internally split up
3762 $d->{amount} = $d->{setup_amount} + $d->{recur_amount};
3765 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3767 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3768 if exists($_->{amount});
3769 $_->{amount} =~ s/^\-0\.00$/0.00/;
3770 if (exists($_->{unit_amount})) {
3771 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3775 #if $_->{amount} != 0
3776 # || $discount_show_always
3777 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3778 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3782 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3789 =item _items_discounts_avail
3791 Returns an array of line item hashrefs representing available term discounts
3792 for this invoice. This makes the same assumptions that apply to term
3793 discounts in general: that the package is billed monthly, at a flat rate,
3794 with no usage charges. A prorated first month will be handled, as will
3795 a setup fee if the discount is allowed to apply to setup fees.
3799 sub _items_discounts_avail {
3802 #maybe move this method from cust_bill when quotations support discount_plans
3803 return () unless $self->can('discount_plans');
3804 my %plans = $self->discount_plans;
3806 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3807 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3811 my $plan = $plans{$months};
3813 my $term_total = sprintf('%.2f', $plan->discounted_total);
3814 my $percent = sprintf('%.0f',
3815 100 * (1 - $term_total / $plan->base_total) );
3816 my $permonth = sprintf('%.2f', $term_total / $months);
3817 my $detail = $self->mt('discount on item'). ' '.
3818 join(', ', map { "#$_" } $plan->pkgnums)
3821 # discounts for non-integer months don't work anyway
3822 $months = sprintf("%d", $months);
3825 description => $self->mt('Save [_1]% by paying for [_2] months',
3827 amount => $self->mt('[_1] ([_2] per month)',
3828 $term_total, $money_char.$permonth),
3829 ext_description => ($detail || ''),
3832 sort { $b <=> $a } keys %plans;
3836 =item has_sections AGENTNUM
3838 Return true if invoice_sections should be enabled for this bill.
3839 (Inherited by both cust_bill and cust_bill_void)
3842 * False if not an invoice
3843 * True always if conf invoice_sections is enabled
3844 * True always if sections_by_location is enabled
3845 * True if conf invoice_sections_multilocation > 1,
3846 and location_count >= invoice_sections_multilocation
3852 my ($self, $agentnum) = @_;
3854 return 0 unless $self->invnum > 0;
3856 $agentnum ||= $self->agentnum;
3857 return 1 if $self->conf->config_bool('invoice_sections', $agentnum);
3858 return 1 if $self->conf->exists('sections_by_location', $agentnum);
3860 my $location_min = $self->conf->config(
3861 'invoice_sections_multilocation', $agentnum,
3866 && $self->location_count >= $location_min;
3872 =item location_count
3874 Return the number of locations billed on this invoice
3878 sub location_count {
3880 return 0 unless $self->invnum;
3882 # SELECT COUNT( DISTINCT cust_pkg.locationnum )
3883 # FROM cust_bill_pkg
3884 # LEFT JOIN cust_pkg USING (pkgnum)
3885 # WHERE invnum = 278
3886 # AND cust_bill_pkg.pkgnum > 0
3888 my $result = qsearchs({
3889 select => 'COUNT(DISTINCT cust_pkg.locationnum) as location_count',
3890 table => 'cust_bill_pkg',
3891 addl_from => 'LEFT JOIN cust_pkg USING (pkgnum)',
3892 extra_sql => 'WHERE invnum = '.dbh->quote( $self->invnum )
3893 . ' AND cust_bill_pkg.pkgnum > 0'
3895 ref $result ? $result->location_count : 0;