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->config_bool('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;
1218 foreach my $line_item ( $self->_items_pkg(%options),
1219 $self->_items_fee(%options) ) {
1221 # When bill is sectioned by location, fees may be displayed within the
1222 # appropriate location section. Suppress this fee from the taxes/fees
1223 # end section, so it doesn't appear to be charged twice and make the
1224 # subtotals seem incorrect
1226 if $line_item->{locationnum}
1227 && ref $options{section}
1228 && !exists $options{section}->{locationnum}
1229 && $self->has_sections
1230 && $conf->config($tc.'sections_method') eq 'location';
1232 warn "$me adding line item ".
1233 join(', ', map "$_=>".$line_item->{$_}, keys %$line_item). "\n"
1236 push @buf, ( [ $line_item->{'description'},
1237 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1239 map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}},
1242 $line_item->{'ref'} = $line_item->{'pkgnum'};
1243 $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()?
1244 $line_item->{'section'} = $section;
1245 $line_item->{'description'} = &$escape_function($line_item->{'description'});
1246 $line_item->{'amount'} = $money_char.$line_item->{'amount'};
1248 if ( length($line_item->{'unit_amount'}) ) {
1249 $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'};
1251 $line_item->{'ext_description'} ||= [];
1253 if ( $options{section_with_taxes} && ref $line_item->{pkg_tax} ) {
1254 for my $line_tax ( @{$ line_item->{pkg_tax} } ) {
1256 # It is rarely possible for the same tax record to be presented here
1257 # multiple times. See cust_bill_pkg::_pkg_tax_list for more info
1258 next if $seen_tax_lines{ $line_tax->{billpkgtaxlocationnum} };
1259 $seen_tax_lines{ $line_tax->{billpkgtaxlocationnum} } = 1;
1261 $section_tax_lines{ $line_tax->{taxname} } += $line_tax->{amount};
1265 push @detail_items, $line_item;
1268 # If conf flag invoice_sections_with_taxes:
1269 # - Add @detail_items for taxes into each section
1270 # - Update section subtotal to include taxes
1271 if ( $options{section_with_taxes} && %section_tax_lines ) {
1272 for my $taxname ( keys %section_tax_lines ) {
1274 push @detail_items, {
1275 section => $section,
1276 amount => sprintf($money_char."%.2f",$section_tax_lines{$taxname}),
1277 description => &$escape_function($taxname),
1280 # Append taxes to total. If line format resembles "$5.00 to $12.00"
1281 # append to the second value.
1283 # $section->{subtotal} = '$5.00 to 12.00'; # for testing:
1284 if ($section->{subtotal} =~ /to/) {
1285 my @subtotal = split /\s/, $section->{subtotal};
1286 $subtotal[2] =~ s/[^\d\.]//g;
1287 $subtotal[2] = sprintf(
1289 ( $subtotal[2] + $section_tax_lines{$taxname} )
1291 $section->{subtotal} = join ' ', @subtotal;
1293 $section->{subtotal} =~ s/[^\d\.]//g;
1294 $section->{subtotal} = sprintf(
1295 $money_char . "%.2f",
1296 ( $section->{subtotal} + $section_tax_lines{$taxname} )
1303 if ( $section->{'description'} ) {
1304 push @buf, ( ['','-----------'],
1305 [ $section->{'description'}. ' sub-total',
1306 $section->{'subtotal'} # already formatted this
1315 $invoice_data{current_less_finance} =
1316 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
1318 # if there's anything in the Previous Charges section, prepend it to the list
1319 if ( $pr_total and $previous_section ne $default_section ) {
1320 unshift @sections, $previous_section;
1321 # but not @summary_subtotals
1324 warn "$me adding taxes\n"
1327 # create a tax section if we don't yet have one
1328 my @items_tax = $self->_items_tax;
1329 my $tax_description = 'Taxes, Surcharges, and Fees';
1331 List::Util::first { $_->{description} eq $tax_description } @sections;
1332 if (!$tax_section) {
1333 $tax_section = { 'description' => $tax_description };
1334 push @sections, $tax_section if $multisection and @items_tax > 0;
1336 $tax_section->{tax_section} = 1; # mark this section as containing taxes
1337 # if this is an existing tax section, we're merging the tax items into it.
1338 # grab the taxtotal that's already there, strip the money symbol if any
1339 my $taxtotal = $tax_section->{'subtotal'} || 0;
1340 $taxtotal =~ s/^\Q$other_money_char\E//;
1343 #my $tax_weight = _pkg_category($tax_section->{description})
1344 # ? _pkg_category($tax_section->{description})->weight
1346 #$tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
1347 #$tax_section->{'sort_weight'} = $tax_weight;
1349 my $invoice_sections_with_taxes = $conf->config_bool(
1350 'invoice_sections_with_taxes', $cust_main->agentnum
1353 foreach my $tax ( @items_tax ) {
1356 my $description = &$escape_function( $tax->{'description'} );
1357 my $amount = sprintf( '%.2f', $tax->{'amount'} );
1359 if ( $multisection ) {
1360 if ( !$invoice_sections_with_taxes ) {
1362 $taxtotal += $tax->{'amount'};
1364 push @detail_items, {
1365 ext_description => [],
1368 description => $description,
1369 amount => $money_char. $amount,
1371 section => $tax_section,
1377 $taxtotal += $tax->{'amount'};
1379 push @total_items, {
1380 'total_item' => $description,
1381 'total_amount' => $other_money_char. $amount,
1386 push @buf,[ $description,
1387 $money_char. $amount,
1394 $total->{'total_item'} = $self->mt('Sub-total');
1395 $total->{'total_amount'} =
1396 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
1398 if ( $multisection ) {
1400 if ( $conf->config_bool('invoice_sections_with_taxes', $cust_main->agentnum) ) {
1401 # If all tax items are displayed in location/category sections,
1402 # remove the empty tax section
1403 @sections = grep{ $_ ne $tax_section } @sections
1404 unless grep{ $_->{section} eq $tax_section } @detail_items;
1407 if ( $taxtotal > 0 ) {
1408 # there are taxes, so prepare the section to be displayed.
1409 # $taxtotal already includes any line items that were already in the
1410 # section (fees, taxes that are charged as packages for some reason).
1411 # also set 'summarized' to false so that this isn't a summary-only
1413 $tax_section->{'subtotal'} = $other_money_char.
1414 sprintf('%.2f', $taxtotal);
1415 $tax_section->{'pretotal'} = 'New charges sub-total '.
1416 $total->{'total_amount'};
1417 $tax_section->{'description'} = $self->mt($tax_description);
1418 $tax_section->{'summarized'} = '';
1420 # append tax section unless it's already there
1421 push @sections, $tax_section
1422 unless grep {$_ eq $tax_section} @sections;
1424 push @summary_subtotals, $tax_section
1425 unless grep {$_ eq $tax_section} @summary_subtotals;
1429 unshift @total_items, $total;
1432 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1438 my %embolden_functions = (
1439 'latex' => sub { return '\textbf{'. shift(). '}' },
1440 'html' => sub { return '<b>'. shift(). '</b>' },
1441 'template' => sub { shift },
1443 my $embolden_function = $embolden_functions{$format};
1445 if ( $multisection ) {
1447 if ( $adjust_section->{'sort_weight'} ) {
1448 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1449 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1451 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1452 $other_money_char. sprintf('%.2f', $self->charged );
1457 if ( $self->can('_items_total') ) { # should always be true now
1459 # even for multisection, need plain text version
1461 my @new_total_items = $self->_items_total;
1463 push @buf,['','-----------'];
1465 foreach ( @new_total_items ) {
1466 my ($item, $amount) = ($_->{'total_item'}, $_->{'total_amount'});
1467 $_->{'total_item'} = &$embolden_function( $item );
1469 if ( ref($amount) ) {
1470 $_->{'total_amount'} = &$embolden_function(
1471 $other_money_char.$amount->[0]. ' to '.
1472 $other_money_char.$amount->[1]
1475 $_->{'total_amount'} = &$embolden_function( $other_money_char.$amount );
1478 # but if it's multisection, don't append to @total_items. the adjust
1479 # section has all this stuff
1480 push @total_items, $_ if !$multisection;
1481 push @buf, [ $item, $money_char.sprintf('%10.2f',$amount) ];
1484 push @buf, [ '', '' ];
1486 # if we're showing previous invoices, also show previous
1487 # credits and payments
1488 if ( $self->enable_previous
1489 and $self->can('_items_credits')
1490 and $self->can('_items_payments') )
1494 my $credittotal = 0;
1495 foreach my $credit (
1496 $self->_items_credits( 'template' => $template, 'trim_len' => 40 )
1500 $total->{'total_item'} = &$escape_function($credit->{'description'});
1501 $credittotal += $credit->{'amount'};
1502 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1503 if ( $multisection ) {
1504 push @detail_items, {
1505 ext_description => [],
1508 description => &$escape_function($credit->{'description'}),
1509 amount => $money_char . $credit->{'amount'},
1511 section => $adjust_section,
1514 push @total_items, $total;
1518 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1521 foreach my $credit (
1522 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1524 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1528 my $paymenttotal = 0;
1529 foreach my $payment (
1530 $self->_items_payments( 'template' => $template )
1533 $total->{'total_item'} = &$escape_function($payment->{'description'});
1534 $paymenttotal += $payment->{'amount'};
1535 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1536 if ( $multisection ) {
1537 push @detail_items, {
1538 ext_description => [],
1541 description => &$escape_function($payment->{'description'}),
1542 amount => $money_char . $payment->{'amount'},
1544 section => $adjust_section,
1547 push @total_items, $total;
1549 push @buf, [ $payment->{'description'},
1550 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1553 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1555 if ( $multisection ) {
1556 $adjust_section->{'subtotal'} = $other_money_char.
1557 sprintf('%.2f', $credittotal + $paymenttotal);
1559 #why this? because {sort_weight} forces the adjust_section to appear
1560 #in @extra_sections instead of @sections. obviously.
1561 push @sections, $adjust_section
1562 unless $adjust_section->{sort_weight};
1563 # do not summarize; adjustments there are shown according to
1567 # create Balance Due message
1570 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1571 $total->{'total_amount'} =
1572 &$embolden_function(
1573 $other_money_char. sprintf('%.2f', #why? $summarypage
1574 # ? $self->charged +
1575 # $self->billing_balance
1580 if ( $multisection && !$adjust_section->{sort_weight} ) {
1581 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1582 $total->{'total_amount'};
1584 push @total_items, $total;
1586 push @buf,['','-----------'];
1587 push @buf,[$self->balance_due_msg, $money_char.
1588 sprintf("%10.2f", $balance_due ) ];
1591 if ( $conf->exists('previous_balance-show_credit')
1592 and $cust_main->balance < 0 ) {
1593 my $credit_total = {
1594 'total_item' => &$embolden_function($self->credit_balance_msg),
1595 'total_amount' => &$embolden_function(
1596 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1599 if ( $multisection ) {
1600 $adjust_section->{'posttotal'} .= $newline_token .
1601 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1604 push @total_items, $credit_total;
1606 push @buf,['','-----------'];
1607 push @buf,[$self->credit_balance_msg, $money_char.
1608 sprintf("%10.2f", -$cust_main->balance ) ];
1612 } #end of default total adding ! can('_items_total')
1614 if ( $multisection ) {
1615 if ( $conf->exists('svc_phone_sections')
1616 && $self->can('_items_svc_phone_sections')
1620 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1621 $total->{'total_amount'} =
1622 &$embolden_function(
1623 $other_money_char. sprintf('%.2f', $balance_due)
1625 my $last_section = pop @sections;
1626 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1627 $total->{'total_amount'};
1628 push @sections, $last_section;
1630 push @sections, @$late_sections
1634 # make a discounts-available section, even without multisection
1635 if ( $conf->exists('discount-show_available')
1636 and my @discounts_avail = $self->_items_discounts_avail ) {
1637 my $discount_section = {
1638 'description' => $self->mt('Discounts Available'),
1643 push @sections, $discount_section; # do not summarize
1644 push @detail_items, map { +{
1645 'ref' => '', #should this be something else?
1646 'section' => $discount_section,
1647 'description' => &$escape_function( $_->{description} ),
1648 'amount' => $money_char . &$escape_function( $_->{amount} ),
1649 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1650 } } @discounts_avail;
1653 # not adding any more sections after this
1654 $invoice_data{summary_subtotals} = \@summary_subtotals;
1657 if ( $conf->exists('usage_class_summary')
1658 and $self->can('_items_usage_class_summary') ) {
1659 my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function, 'money_char' => $other_money_char);
1660 if ( @usage_subtotals ) {
1661 unshift @sections, $usage_subtotals[0]->{section}; # do not summarize
1662 unshift @detail_items, @usage_subtotals;
1666 # invoice history "section" (not really a section)
1667 # not to be included in any subtotals, completely independent of
1669 if ( $conf->exists('previous_invoice_history') and $cust_main->isa('FS::cust_main') ) {
1672 foreach my $cust_bill ( $cust_main->cust_bill ) {
1673 # XXX hardcoded format, and currently only 'charged'; add other fields
1674 # if they become necessary
1675 my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1676 $history{$date} ||= 0;
1677 $history{$date} += $cust_bill->charged;
1678 # just so we have a numeric sort key
1679 $monthorder{$date} ||= $cust_bill->_date;
1681 my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1683 my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1684 $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1687 # service locations: another option for template customization
1689 foreach my $item (@detail_items) {
1690 if ( $item->{locationnum} ) {
1691 $location_info{ $item->{locationnum} } ||= {
1692 FS::cust_location->by_key( $item->{locationnum} )->location_hash
1696 $invoice_data{location_info} = \%location_info;
1698 # debugging hook: call this with 'diag' => 1 to just get a hash of
1699 # the invoice variables
1700 return \%invoice_data if ( $params{'diag'} );
1702 # All sections and items are built; now fill in templates.
1703 my @includelist = ();
1704 push @includelist, 'summary' if $summarypage;
1705 foreach my $include ( @includelist ) {
1707 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1710 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1712 @inc_src = $conf->config($inc_file, $agentnum);
1716 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1718 my $convert_map = $convert_maps{$format}{$include};
1720 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1721 s/--\@\]/$delimiters{$format}[1]/g;
1724 &$convert_map( $conf->config($inc_file, $agentnum) );
1728 my $inc_tt = new Text::Template (
1730 SOURCE => [ map "$_\n", @inc_src ],
1731 DELIMITERS => $delimiters{$format},
1732 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1734 unless ( $inc_tt->compile() ) {
1735 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1736 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1740 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1742 $invoice_data{$include} =~ s/\n+$//
1743 if ($format eq 'latex');
1748 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1749 /invoice_lines\((\d*)\)/;
1750 $invoice_lines += $1 || scalar(@buf);
1753 die "no invoice_lines() functions in template?"
1754 if ( $format eq 'template' && !$wasfunc );
1756 if ( $invoice_lines ) {
1757 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1758 $invoice_data{'total_pages'}++
1759 if scalar(@buf) % $invoice_lines;
1762 #setup subroutine for the template
1763 $invoice_data{invoice_lines} = sub {
1764 my $lines = shift || scalar(@buf);
1773 if ($format eq 'template') {
1778 push @collect, split("\n",
1779 $text_template->fill_in( HASH => \%invoice_data )
1781 $invoice_data{'page'}++;
1783 map "$_\n", @collect;
1785 } else { # this is where we actually create the invoice
1787 if ( $params{no_addresses} ) {
1788 delete $invoice_data{$_} foreach qw(
1789 payname company address1 address2 city state zip country
1791 $invoice_data{returnaddress} = '~';
1794 warn "filling in template for invoice ". $self->invnum. "\n"
1796 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1799 $text_template->fill_in(HASH => \%invoice_data);
1803 sub notice_name { '('.shift->table.')'; }
1805 # this is not supposed to happen
1806 sub template_conf { warn "bare FS::Template_Mixin::template_conf";
1810 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1812 Returns an postscript invoice, as a scalar.
1814 Options can be passed as a hashref (recommended) or as a list of time, template
1815 and then any key/value pairs for any other options.
1817 I<time> an optional value used to control the printing of overdue messages. The
1818 default is now. It isn't the date of the invoice; that's the `_date' field.
1819 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1820 L<Time::Local> and L<Date::Parse> for conversion functions.
1822 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1829 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1830 my $ps = generate_ps($file);
1832 unlink($barcodefile) if $barcodefile;
1837 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1839 Returns an PDF invoice, as a scalar.
1841 Options can be passed as a hashref (recommended) or as a list of time, template
1842 and then any key/value pairs for any other options.
1844 I<time> an optional value used to control the printing of overdue messages. The
1845 default is now. It isn't the date of the invoice; that's the `_date' field.
1846 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1847 L<Time::Local> and L<Date::Parse> for conversion functions.
1849 I<template>, if specified, is the name of a suffix for alternate invoices.
1851 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1858 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1859 my $pdf = generate_pdf($file);
1861 unlink($barcodefile) if $barcodefile;
1866 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1868 Returns an HTML invoice, as a scalar.
1870 I<time> an optional value used to control the printing of overdue messages. The
1871 default is now. It isn't the date of the invoice; that's the `_date' field.
1872 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1873 L<Time::Local> and L<Date::Parse> for conversion functions.
1875 I<template>, if specified, is the name of a suffix for alternate invoices.
1877 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1879 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1880 when emailing the invoice as part of a multipart/related MIME email.
1888 %params = %{ shift() };
1892 $params{'format'} = 'html';
1894 $self->print_generic( %params );
1897 # quick subroutine for print_latex
1899 # There are ten characters that LaTeX treats as special characters, which
1900 # means that they do not simply typeset themselves:
1901 # # $ % & ~ _ ^ \ { }
1903 # TeX ignores blanks following an escaped character; if you want a blank (as
1904 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1908 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1909 $value =~ s/([<>])/\$$1\$/g;
1915 encode_entities($value);
1919 sub _html_escape_nbsp {
1920 my $value = _html_escape(shift);
1921 $value =~ s/ +/ /g;
1925 #utility methods for print_*
1927 sub _translate_old_latex_format {
1928 warn "_translate_old_latex_format called\n"
1935 if ( $line =~ /^%%Detail\s*$/ ) {
1937 push @template, q![@--!,
1938 q! foreach my $_tr_line (@detail_items) {!,
1939 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1940 q! $_tr_line->{'description'} .= !,
1941 q! "\\tabularnewline\n~~".!,
1942 q! join( "\\tabularnewline\n~~",!,
1943 q! @{$_tr_line->{'ext_description'}}!,
1947 while ( ( my $line_item_line = shift )
1948 !~ /^%%EndDetail\s*$/ ) {
1949 $line_item_line =~ s/'/\\'/g; # nice LTS
1950 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1951 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1952 push @template, " \$OUT .= '$line_item_line';";
1955 push @template, '}',
1958 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1960 push @template, '[@--',
1961 ' foreach my $_tr_line (@total_items) {';
1963 while ( ( my $total_item_line = shift )
1964 !~ /^%%EndTotalDetails\s*$/ ) {
1965 $total_item_line =~ s/'/\\'/g; # nice LTS
1966 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1967 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1968 push @template, " \$OUT .= '$total_item_line';";
1971 push @template, '}',
1975 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1976 push @template, $line;
1982 warn "$_\n" foreach @template;
1994 my $conf = $self->conf;
1996 #check for an invoice-specific override
1997 return $self->invoice_terms if $self->invoice_terms;
1999 #check for a customer- specific override
2000 my $cust_main = $self->cust_main;
2001 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
2005 $agentnum = $cust_main->agentnum;
2006 } elsif ( my $prospect_main = $self->prospect_main ) {
2007 $agentnum = $prospect_main->agentnum;
2010 #use configured default
2011 $conf->config('invoice_default_terms', $agentnum) || '';
2021 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
2022 $duedate = $self->_date() + ( $1 * 86400 );
2023 } elsif ( $self->terms =~ /^End of Month$/ ) {
2024 my ($mon,$year) = (localtime($self->_date) )[4,5];
2026 until ( $mon < 12 ) { $mon -= 12; $year++; }
2027 my $nextmonth_first = timelocal(0,0,0,1,$mon,$year);
2028 $duedate = $nextmonth_first - 86400;
2039 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
2042 =item invoice_pay_by_msg
2044 displays the invoice_pay_by_msg or default Please pay by [_1] if empty.
2048 sub invoice_pay_by_msg {
2052 $self->conf->config('invoice_pay_by_msg', $self->agentnum)
2053 || 'Please pay by [_1]';
2054 $msg .= ' - ' . $self->mt($please_pay_by, $self->due_date2str('short')) . ' ';
2059 =item balance_due_msg
2063 sub balance_due_msg {
2065 my $msg = $self->mt('Balance Due');
2066 return $msg unless $self->terms; # huh?
2067 if ( !$self->conf->exists('invoice_show_prior_due_date')
2068 || $self->has_sections ) {
2069 # if enabled, the due date is shown with Total New Charges (see
2070 # _items_total) and not here
2071 # (yes, or if invoice_sections is enabled; this is just for compatibility)
2072 if ( $self->due_date ) {
2073 $msg .= $self->invoice_pay_by_msg
2074 unless $self->conf->config_bool('invoice_omit_due_date',$self->agentnum);
2075 } elsif ( $self->terms ) {
2076 $msg .= ' - '. $self->mt($self->terms);
2082 =item balance_due_date
2086 sub balance_due_date {
2088 my $conf = $self->conf;
2090 my $terms = $self->terms;
2091 if ( $terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
2092 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
2097 sub credit_balance_msg {
2099 $self->mt('Credit Balance Remaining')
2104 Returns a string with the date, for example: "3/20/2008", localized for the
2105 customer. Use _date_pretty_unlocalized for non-end-customer display use.
2111 $self->time2str_local('short', $self->_date);
2114 =item _date_pretty_unlocalized
2116 Returns a string with the date, for example: "3/20/2008", in the format
2117 configured for the back-office. Use _date_pretty for end-customer display use.
2121 sub _date_pretty_unlocalized {
2123 time2str($date_format, $self->_date);
2128 Emails this template.
2130 Options are passed as a hashref. Available options:
2136 If specified, overrides the default From: address.
2140 If specified, overrides the name of the sent document ("Invoice" or "Quotation")
2144 (Deprecated) If specified, is the name of a suffix for alternate template files.
2148 Options accepted by generate_email can also be used.
2154 my $opt = shift || {};
2155 if ($opt and !ref($opt)) {
2156 die ref($self). '->email called with positional parameters';
2159 return if $self->hide;
2161 my $error = send_email(
2162 $self->generate_email(
2163 'subject' => $self->email_subject($opt->{template}),
2164 %$opt, # template, etc.
2168 die "can't email: $error\n" if $error;
2171 =item generate_email OPTION => VALUE ...
2179 sender address, required
2183 alternate template name, optional
2187 email subject, optional
2191 notice name instead of "Invoice", optional
2195 Returns an argument list to be passed to L<FS::Misc::send_email>.
2202 sub generate_email {
2206 my $conf = $self->conf;
2208 my $me = '[FS::Template_Mixin::generate_email]';
2211 'from' => $args{'from'},
2212 'subject' => ($args{'subject'} || $self->email_subject),
2213 'custnum' => $self->custnum,
2214 'msgtype' => 'invoice',
2217 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
2219 my $cust_main = $self->cust_main;
2221 if (ref($args{'to'}) eq 'ARRAY') {
2222 $return{'to'} = $args{'to'};
2223 } elsif ( $cust_main ) {
2224 $return{'to'} = [ $cust_main->invoicing_list_emailonly ];
2227 my $tc = $self->template_conf;
2229 my @text; # array of lines
2230 my $html; # a big string
2231 my @related_parts; # will contain the text/HTML alternative, and images
2232 my $related; # will contain the multipart/related object
2234 if ( $conf->exists($tc. 'email_pdf') ) {
2235 if ( my $msgnum = $conf->config($tc.'email_pdf_msgnum') ) {
2237 warn "$me using '${tc}email_pdf_msgnum' in multipart message"
2240 my $msg_template = FS::msg_template->by_key($msgnum)
2241 or die "${tc}email_pdf_msgnum $msgnum not found\n";
2242 my $cust_msg = $msg_template->prepare(
2243 cust_main => $self->cust_main,
2245 msgtype => 'invoice',
2248 # XXX hack to make this work in the new cust_msg era; consider replacing
2249 # with cust_bill_send_with_notice events.
2250 my @parts = $cust_msg->parts;
2251 foreach my $part (@parts) { # will only have two parts, normally
2252 if ( $part->mime_type eq 'text/plain' ) {
2253 @text = @{ $part->body };
2254 } elsif ( $part->mime_type eq 'text/html' ) {
2255 $html = $part->bodyhandle->as_string;
2259 } elsif ( my @note = $conf->config($tc.'email_pdf_note') ) {
2261 warn "$me using '${tc}email_pdf_note' in multipart message"
2263 @text = $conf->config($tc.'email_pdf_note');
2264 $html = join('<BR>', @text);
2266 } # else use the plain text invoice
2271 if ( $conf->config($tc.'template') ) {
2273 warn "$me generating plain text invoice"
2276 @text = $self->print_text(\%args);
2280 warn "$me no plain text version exists; sending empty message body"
2287 my $text_part = build MIME::Entity (
2288 'Type' => 'text/plain',
2289 'Encoding' => 'quoted-printable',
2290 'Charset' => 'UTF-8',
2291 #'Encoding' => '7bit',
2294 { Encode::encode('UTF-8', $_, Encode::FB_WARN | Encode::LEAVE_SRC ) }
2297 'Disposition' => 'inline',
2302 if ( $conf->exists($tc.'html') ) {
2303 warn "$me generating HTML invoice"
2306 $args{'from'} =~ /\@([\w\.\-]+)/;
2307 my $from = $1 || 'example.com';
2308 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2311 my $agentnum = $cust_main ? $cust_main->agentnum
2312 : $self->prospect_main->agentnum;
2313 if ( defined($args{'template'}) && length($args{'template'})
2314 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
2317 $logo = 'logo_'. $args{'template'}. '.png';
2321 my $image_data = $conf->config_binary( $logo, $agentnum);
2323 push @related_parts, build MIME::Entity
2324 'Type' => 'image/png',
2325 'Encoding' => 'base64',
2326 'Data' => $image_data,
2327 'Filename' => 'logo.png',
2328 'Content-ID' => "<$content_id>",
2331 if ( ref($self) eq 'FS::cust_bill' && $conf->exists('invoice-barcode') ) {
2332 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2333 push @related_parts, build MIME::Entity
2334 'Type' => 'image/png',
2335 'Encoding' => 'base64',
2336 'Data' => $self->invoice_barcode(0),
2337 'Filename' => 'barcode.png',
2338 'Content-ID' => "<$barcode_content_id>",
2340 $args{'barcode_cid'} = $barcode_content_id;
2343 $html = $self->print_html({ 'cid'=>$content_id, %args });
2350 warn "$me creating HTML/text multipart message"
2353 $return{'nobody'} = 1;
2355 my $alternative = build MIME::Entity
2356 'Type' => 'multipart/alternative',
2357 #'Encoding' => '7bit',
2358 'Disposition' => 'inline'
2362 $alternative->add_part($text_part);
2365 $alternative->attach(
2366 'Type' => 'text/html',
2367 'Encoding' => 'quoted-printable',
2368 'Data' => [ '<html>',
2371 ' '. encode_entities($return{'subject'}),
2374 ' <body bgcolor="#e8e8e8">',
2378 Encode::FB_WARN | Encode::LEAVE_SRC
2383 'Disposition' => 'inline',
2384 #'Filename' => 'invoice.pdf',
2387 unshift @related_parts, $alternative;
2389 $related = build MIME::Entity 'Type' => 'multipart/related',
2390 'Encoding' => '7bit';
2392 #false laziness w/Misc::send_email
2393 $related->head->replace('Content-type',
2394 $related->mime_type.
2395 '; boundary="'. $related->head->multipart_boundary. '"'.
2396 '; type=multipart/alternative'
2399 $related->add_part($_) foreach @related_parts;
2403 my @otherparts = ();
2404 if ( ref($self) eq 'FS::cust_bill' && $cust_main->email_csv_cdr ) {
2406 if ( $conf->config('voip-cdr_email_attach') eq 'zip' ) {
2408 my $data = join('', map "$_\n",
2409 $self->call_details(prepend_billed_number=>1)
2412 my $zip = new Archive::Zip;
2413 my $file = $zip->addString( $data, 'usage-'.$self->invnum.'.csv' );
2414 $file->desiredCompressionMethod( COMPRESSION_DEFLATED );
2417 my $SH = IO::Scalar->new(\$zipdata);
2418 my $status = $zip->writeToFileHandle($SH);
2419 die "Error zipping CDR attachment: $!" unless $status == AZ_OK;
2421 push @otherparts, build MIME::Entity
2422 'Type' => 'application/zip',
2423 'Encoding' => 'base64',
2425 'Disposition' => 'attachment',
2426 'Filename' => 'usage-'. $self->invnum. '.zip',
2429 } else { # } elsif ( $conf->config('voip-cdr_email_attach') eq 'csv' ) {
2431 push @otherparts, build MIME::Entity
2432 'Type' => 'text/csv',
2433 'Encoding' => '7bit',
2434 'Data' => [ map { "$_\n" }
2435 $self->call_details('prepend_billed_number' => 1)
2437 'Disposition' => 'attachment',
2438 'Filename' => 'usage-'. $self->invnum. '.csv',
2445 if ( $conf->exists($tc.'email_pdf') ) {
2450 # multipart/alternative
2456 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
2457 push @otherparts, $pdf;
2461 $return{'content-type'} = 'multipart/mixed'; # of the outer container
2463 $return{'mimeparts'} = [ $related, @otherparts ];
2464 $return{'type'} = 'multipart/related'; # of the first part
2466 $return{'mimeparts'} = [ $text_part, @otherparts ];
2467 $return{'type'} = 'text/plain';
2469 } elsif ( $html ) { # no PDF or CSV, strip the outer container
2470 $return{'mimeparts'} = \@related_parts;
2471 $return{'content-type'} = 'multipart/related';
2472 $return{'type'} = 'multipart/alternative';
2473 } else { # no HTML either
2474 $return{'body'} = \@text;
2475 $return{'content-type'} = 'text/plain';
2484 Returns a list suitable for passing to MIME::Entity->build(), representing
2485 this quotation or invoice as PDF attachment.
2492 'Type' => 'application/pdf',
2493 'Encoding' => 'base64',
2494 'Data' => [ $self->print_pdf(@_) ],
2495 'Disposition' => 'attachment',
2496 'Filename' => $self->pdf_filename,
2500 =item postal_mail_fsinc
2502 Sends this invoice to the Freeside Internet Services, Inc. print and mail
2508 use IO::Socket::SSL;
2510 use HTTP::Request::Common qw( POST );
2511 use Cpanel::JSON::XS;
2513 sub postal_mail_fsinc {
2514 my ( $self, %opt ) = @_;
2516 if ( $FS::Misc::DISABLE_PRINT ) {
2517 warn 'postal_mail_fsinc() disabled by $FS::Misc::DISABLE_PRINT' if $DEBUG;
2521 my $url = 'https://ws.freeside.biz/print';
2523 my $cust_main = $self->cust_main;
2524 my $agentnum = $cust_main->agentnum;
2525 my $bill_location = $cust_main->bill_location;
2527 die "Extra charges for international mailing; contact support\@freeside.biz to enable\n"
2528 if $bill_location->country ne 'US';
2530 my $conf = new FS::Conf;
2532 my @company_address = $conf->config('company_address', $agentnum);
2533 my ( $company_address1, $company_address2, $company_city, $company_state, $company_zip );
2534 if ( $company_address[2] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2535 $company_address1 = $company_address[0];
2536 $company_address2 = $company_address[1];
2538 $company_state = $2;
2540 } elsif ( $company_address[1] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2541 $company_address1 = $company_address[0];
2542 $company_address2 = '';
2544 $company_state = $2;
2547 die "Unparsable company_address; contact support\@freeside.biz\n";
2549 $company_city =~ s/,$//;
2551 my $file = $self->print_pdf(%opt, 'no_addresses' => 1);
2552 my $pages = CAM::PDF->new($file)->numPages;
2554 my $ua = LWP::UserAgent->new(
2556 verify_hostname => 0,
2557 SSL_verify_mode => IO::Socket::SSL::SSL_VERIFY_NONE,
2558 SSL_version => 'SSLv3',
2561 my $response = $ua->request( POST $url, [
2562 'support-key' => scalar($conf->config('support-key')),
2563 'file' => encode_base64($file),
2567 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
2568 'company_address1' => $company_address1,
2569 'company_address2' => $company_address2,
2570 'company_city' => $company_city,
2571 'company_state' => $company_state,
2572 'company_zip' => $company_zip,
2573 'company_country' => 'US',
2574 'company_phonenum' => scalar($conf->config('company_phonenum', $agentnum)),
2575 'company_email' => scalar($conf->config('invoice_from', $agentnum)),
2578 'name' => $cust_main->invoice_attn
2579 || $cust_main->contact_firstlast,
2580 'company' => $cust_main->company,
2581 'address1' => $bill_location->address1,
2582 'address2' => $bill_location->address2,
2583 'city' => $bill_location->city,
2584 'state' => $bill_location->state,
2585 'zip' => $bill_location->zip,
2586 'country' => $bill_location->country,
2589 die "Print connection error: ". $response->message.
2590 ' ('. $response->as_string. ")\n"
2591 unless $response->is_success;
2594 my $content = eval { decode_json($response->content) };
2595 die "Print JSON error : $@\n" if $@;
2597 die $content->{error}."\n"
2598 if $content->{error};
2600 #TODO: store this so we can query for a status later
2601 warn "Invoice printed, ID ". $content->{id}. "\n";
2607 =item _items_sections OPTIONS
2609 Generate section information for all items appearing on this invoice.
2610 This will only be called for multi-section invoices.
2612 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
2613 related display records (L<FS::cust_bill_pkg_display>) and organize
2614 them into two groups ("early" and "late" according to whether they come
2615 before or after the total), then into sections. A subtotal is calculated
2618 Section descriptions are returned in sort weight order. Each consists
2619 of a hash containing:
2621 description: the package category name, escaped
2622 subtotal: the total charges in that section
2623 tax_section: a flag indicating that the section contains only tax charges
2624 summarized: same as tax_section, for some reason
2625 sort_weight: the package category's sort weight
2627 If 'condense' is set on the display record, it also contains everything
2628 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
2629 coderefs to generate parts of the invoice. This is not advised.
2631 The method returns two arrayrefs, one of "early" sections and one of "late"
2634 OPTIONS may include:
2636 by_location: a flag to divide the invoice into sections by location.
2637 Each section hash will have a 'location' element containing a hashref of
2638 the location fields (see L<FS::cust_location>). The section description
2639 will be the location label, but the template can use any of the location
2640 fields to create a suitable label.
2642 by_category: a flag to divide the invoice into sections using display
2643 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
2644 behavior. Each section hash will have a 'category' element containing
2645 the section name from the display record (which probably equals the
2646 category name of the package, but may not in some cases).
2648 summary: a flag indicating that this is a summary-format invoice.
2649 Turning this on has the following effects:
2650 - Ignores display items with the 'summary' flag.
2651 - Places all sections in the "early" group even if they have post_total.
2652 - Creates sections for all non-disabled package categories, even if they
2653 have no charges on this invoice, as well as a section with no name.
2655 escape: an escape function to use for section titles.
2657 extra_sections: an arrayref of additional sections to return after the
2658 sorted list. If there are any of these, section subtotals exclude
2661 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
2662 passed through to C<_condense_section()>.
2666 use vars qw(%pkg_category_cache);
2667 sub _items_sections {
2671 my $escape = $opt{escape};
2672 my @extra_sections = @{ $opt{extra_sections} || [] };
2674 # $subtotal{$locationnum}{$categoryname} = amount.
2675 # if we're not using by_location, $locationnum is undef.
2676 # if we're not using by_category, you guessed it, $categoryname is undef.
2677 # if we're not using either one, we shouldn't be here in the first place...
2679 my %late_subtotal = ();
2682 # About tax items + multisection invoices:
2683 # If either invoice_*summary option is enabled, AND there is a
2684 # package category with the name of the tax, then there will be
2685 # a display record assigning the tax item to that category.
2687 # However, the taxes are always placed in the "Taxes, Surcharges,
2688 # and Fees" section regardless of that. The only effect of the
2689 # display record is to create a subtotal for the summary page.
2692 my $pkg_hash = $self->cust_pkg_hash;
2694 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2697 my $usage = $cust_bill_pkg->usage;
2700 if ( $opt{by_location} ) {
2701 if ( $cust_bill_pkg->pkgnum ) {
2702 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2707 $locationnum = undef;
2710 # as in _items_cust_pkg, if a line item has no display records,
2711 # cust_bill_pkg_display() returns a default record for it
2713 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2714 next if ( $display->summary && $opt{summary} );
2716 #my $section = $display->section;
2717 #false laziness with the method, but for efficiency inside this loop
2718 my $section = $display->get('section');
2719 if ( !$section && !$cust_bill_pkg->hidden ) {
2720 $section = $cust_bill_pkg->get('categoryname'); #cust_bill->cust_bill_pkg added it (XXX quotations / quotation_section)
2723 my $type = $display->type;
2724 # Set $section = undef if we're sectioning by location and this
2725 # line item _has_ a location (i.e. isn't a fee).
2726 $section = undef if $locationnum;
2728 # set this flag if the section is not tax-only
2729 $not_tax{$locationnum}{$section} = 1
2730 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
2732 # there's actually a very important piece of logic buried in here:
2733 # incrementing $late_subtotal{$section} CREATES
2734 # $late_subtotal{$section}. keys(%late_subtotal) is later used
2735 # to define the list of late sections, and likewise keys(%subtotal).
2736 # When _items_cust_bill_pkg is called to generate line items for
2737 # real, it will be called with 'section' => $section for each
2739 if ( $display->post_total && !$opt{summary} ) {
2740 if (! $type || $type eq 'S') {
2741 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2742 if $cust_bill_pkg->setup != 0
2743 || $cust_bill_pkg->setup_show_zero;
2747 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
2748 if $cust_bill_pkg->recur != 0
2749 || $cust_bill_pkg->recur_show_zero;
2752 if ($type && $type eq 'R') {
2753 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2754 if $cust_bill_pkg->recur != 0
2755 || $cust_bill_pkg->recur_show_zero;
2758 if ($type && $type eq 'U') {
2759 $late_subtotal{$locationnum}{$section} += $usage
2760 unless scalar(@extra_sections);
2763 } else { # it's a pre-total (normal) section
2765 # skip tax items unless they're explicitly included in a section
2766 next if $cust_bill_pkg->pkgnum == 0 and
2767 ! $cust_bill_pkg->feepart and
2770 if ( $type eq 'S' ) {
2771 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2772 if $cust_bill_pkg->setup != 0
2773 || $cust_bill_pkg->setup_show_zero;
2774 } elsif ( $type eq 'R' ) {
2775 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2776 if $cust_bill_pkg->recur != 0
2777 || $cust_bill_pkg->recur_show_zero;
2778 } elsif ( $type eq 'U' ) {
2779 $subtotal{$locationnum}{$section} += $usage
2780 unless scalar(@extra_sections);
2781 } elsif ( !$type ) {
2782 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2783 + $cust_bill_pkg->recur;
2792 %pkg_category_cache = ();
2794 # summary invoices need subtotals for all non-disabled package categories,
2795 # even if they're zero
2796 # but currently assume that there are no location sections, or at least
2797 # that the summary page doesn't care about them
2798 if ( $opt{summary} ) {
2799 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2800 $subtotal{''}{$category->categoryname} ||= 0;
2802 $subtotal{''}{''} ||= 0;
2806 foreach my $post_total (0,1) {
2808 my $s = $post_total ? \%late_subtotal : \%subtotal;
2809 foreach my $locationnum (keys %$s) {
2810 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2812 'subtotal' => $s->{$locationnum}{$sectionname},
2815 if ( $locationnum ) {
2816 $section->{'locationnum'} = $locationnum;
2817 my $location = FS::cust_location->by_key($locationnum);
2818 $section->{'description'} = &{ $escape }($location->location_label);
2819 # Better ideas? This will roughly group them by proximity,
2820 # which alpha sorting on any of the address fields won't.
2821 # Sorting by locationnum is meaningless.
2822 # We have to sort on _something_ or the order may change
2823 # randomly from one invoice to the next, which will confuse
2825 $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
2827 $section->{'location'} = {
2828 label_prefix => &{ $escape }($location->label_prefix),
2829 map { $_ => &{ $escape }($location->get($_)) }
2833 $section->{'category'} = $sectionname;
2834 $section->{'description'} = &{ $escape }($sectionname);
2835 if ( _pkg_category($sectionname) ) {
2836 $section->{'sort_weight'} = _pkg_category($sectionname)->weight;
2837 if ( _pkg_category($sectionname)->condense ) {
2838 $section = { %$section, $self->_condense_section($opt{format}) };
2842 if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
2843 # then it's a tax-only section
2844 $section->{'summarized'} = 'Y';
2845 $section->{'tax_section'} = 'Y';
2847 push @these, $section;
2848 } # foreach $sectionname
2849 } #foreach $locationnum
2850 push @these, @extra_sections if $post_total == 0;
2851 # need an alpha sort for location sections, because postal codes can
2853 $sections[ $post_total ] = [ sort {
2854 $opt{'by_location'} ?
2855 ($a->{sort_weight} cmp $b->{sort_weight}) :
2856 ($a->{sort_weight} <=> $b->{sort_weight})
2858 } #foreach $post_total
2860 return @sections; # early, late
2863 #helper subs for above
2867 $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2871 my $categoryname = shift;
2872 $pkg_category_cache{$categoryname} ||=
2873 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2876 my %condensed_format = (
2877 'label' => [ qw( Description Qty Amount ) ],
2879 sub { shift->{description} },
2880 sub { shift->{quantity} },
2881 sub { my($href, %opt) = @_;
2882 ($opt{dollar} || ''). $href->{amount};
2885 'align' => [ qw( l r r ) ],
2886 'span' => [ qw( 5 1 1 ) ], # unitprices?
2887 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
2890 sub _condense_section {
2891 my ( $self, $format ) = ( shift, shift );
2893 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2894 qw( description_generator
2897 total_line_generator
2902 sub _condensed_generator_defaults {
2903 my ( $self, $format ) = ( shift, shift );
2904 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2913 sub _condensed_header_generator {
2914 my ( $self, $format ) = ( shift, shift );
2916 my ( $f, $prefix, $suffix, $separator, $column ) =
2917 _condensed_generator_defaults($format);
2919 if ($format eq 'latex') {
2920 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2921 $suffix = "\\\\\n\\hline";
2924 sub { my ($d,$a,$s,$w) = @_;
2925 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2927 } elsif ( $format eq 'html' ) {
2928 $prefix = '<th></th>';
2932 sub { my ($d,$a,$s,$w) = @_;
2933 return qq!<th align="$html_align{$a}">$d</th>!;
2941 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2943 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2946 $prefix. join($separator, @result). $suffix;
2951 sub _condensed_description_generator {
2952 my ( $self, $format ) = ( shift, shift );
2954 my ( $f, $prefix, $suffix, $separator, $column ) =
2955 _condensed_generator_defaults($format);
2957 my $money_char = '$';
2958 if ($format eq 'latex') {
2959 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2961 $separator = " & \n";
2963 sub { my ($d,$a,$s,$w) = @_;
2964 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2966 $money_char = '\\dollar';
2967 }elsif ( $format eq 'html' ) {
2968 $prefix = '"><td align="center"></td>';
2972 sub { my ($d,$a,$s,$w) = @_;
2973 return qq!<td align="$html_align{$a}">$d</td>!;
2975 #$money_char = $conf->config('money_char') || '$';
2976 $money_char = ''; # this is madness
2984 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2986 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2988 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2989 map { $f->{$_}->[$i] } qw(align span width)
2993 $prefix. join( $separator, @result ). $suffix;
2998 sub _condensed_total_generator {
2999 my ( $self, $format ) = ( shift, shift );
3001 my ( $f, $prefix, $suffix, $separator, $column ) =
3002 _condensed_generator_defaults($format);
3005 if ($format eq 'latex') {
3008 $separator = " & \n";
3010 sub { my ($d,$a,$s,$w) = @_;
3011 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
3013 }elsif ( $format eq 'html' ) {
3017 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
3019 sub { my ($d,$a,$s,$w) = @_;
3020 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
3029 # my $r = &{$f->{fields}->[$i]}(@args);
3030 # $r .= ' Total' unless $i;
3032 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
3034 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
3035 map { $f->{$_}->[$i] } qw(align span width)
3039 $prefix. join( $separator, @result ). $suffix;
3044 =item total_line_generator FORMAT
3046 Returns a coderef used for generation of invoice total line items for this
3047 usage_class. FORMAT is either html or latex
3051 # should not be used: will have issues with hash element names (description vs
3052 # total_item and amount vs total_amount -- another array of functions?
3054 sub _condensed_total_line_generator {
3055 my ( $self, $format ) = ( shift, shift );
3057 my ( $f, $prefix, $suffix, $separator, $column ) =
3058 _condensed_generator_defaults($format);
3061 if ($format eq 'latex') {
3064 $separator = " & \n";
3066 sub { my ($d,$a,$s,$w) = @_;
3067 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
3069 }elsif ( $format eq 'html' ) {
3073 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
3075 sub { my ($d,$a,$s,$w) = @_;
3076 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
3085 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
3087 &{$column}( &{$f->{fields}->[$i]}(@args),
3088 map { $f->{$_}->[$i] } qw(align span width)
3092 $prefix. join( $separator, @result ). $suffix;
3097 =item _items_pkg [ OPTIONS ]
3099 Return line item hashes for each package item on this invoice. Nearly
3102 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
3104 OPTIONS are passed through to _items_cust_bill_pkg, and should include
3105 'format' and 'escape_function' at minimum.
3107 To produce items for a specific invoice section, OPTIONS should include
3108 'section', a hashref containing 'category' and/or 'locationnum' keys.
3110 'section' may also contain a key named 'condensed'. If this is present
3111 and has a true value, _items_pkg will try to merge identical items into items
3112 with 'quantity' equal to the number of items (not the sum of their separate
3113 quantities, for some reason).
3119 # The order of these is important. Bundled line items will be merged into
3120 # the most recent non-hidden item, so it needs to be the one with:
3122 # - the same start date
3123 # - no pkgpart_override
3125 # So: sort by pkgnum,
3127 # then sort the base line item before any overrides
3128 # then sort hidden before non-hidden add-ons
3129 # then sort by override pkgpart (for consistency)
3130 sort { $a->pkgnum <=> $b->pkgnum or
3131 $a->sdate <=> $b->sdate or
3132 ($a->pkgpart_override ? 0 : -1) or
3133 ($b->pkgpart_override ? 0 : 1) or
3134 $b->hidden cmp $a->hidden or
3135 $a->pkgpart_override <=> $b->pkgpart_override
3137 # and of course exclude taxes and fees
3138 grep { $_->pkgnum > 0 } $self->cust_bill_pkg;
3144 my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
3145 my $escape_function = $options{escape_function};
3147 my $locale = $self->cust_main
3148 ? $self->cust_main->locale
3149 : $self->prospect_main->locale;
3152 foreach my $cust_bill_pkg (@cust_bill_pkg) {
3153 # cache this, so we don't look it up again in every section
3154 my $part_fee = $cust_bill_pkg->get('part_fee')
3155 || $cust_bill_pkg->part_fee;
3156 $cust_bill_pkg->set('part_fee', $part_fee);
3158 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
3159 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
3163 # If _items_fee is called while building a sectioned invoice,
3164 # - invoice_sections_method: category
3165 # Skip fee records that do not match the section category.
3166 # - invoice_sections_method: location
3167 # Skip fee records always for location sections.
3168 # The fee records will be presented in the tax/fee section instead.
3170 exists( $options{section} )
3174 exists( $options{section}{category} )
3176 $part_fee->categoryname ne $options{section}{category}
3179 exists( $options{section}{location})
3182 warn "skipping fee '".$part_fee->itemdesc.
3183 "'--not in section $options{section}{category}\n" if $DEBUG;
3188 my %base_invnums; # invnum => invoice date
3189 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
3190 if ($_->base_invnum) {
3191 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
3192 my $base_date = $self->time2str_local('short', $base_bill->_date)
3194 $base_invnums{$_->base_invnum} = $base_date || '';
3197 foreach (sort keys(%base_invnums)) {
3198 next if $_ == $self->invnum;
3199 # per convention, we must escape ext_description lines
3201 &{$escape_function}(
3202 $self->mt('from invoice #[_1] on [_2]', $_, $base_invnums{$_})
3205 my $desc = $part_fee->itemdesc_locale($locale);
3206 # but not escape the base description line
3208 my @pkg_tax = $cust_bill_pkg->_pkg_tax_list
3209 if $options{section_with_taxes};
3212 { feepart => $cust_bill_pkg->feepart,
3213 billpkgnum => $cust_bill_pkg->billpkgnum,
3214 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
3215 description => $desc,
3216 pkg_tax => \@pkg_tax,
3217 ext_description => \@ext_desc,
3228 warn "$me _items_pkg searching for all package line items\n"
3231 my @cust_bill_pkg = $self->_items_nontax;
3233 warn "$me _items_pkg filtering line items\n"
3235 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3237 if ($options{section} && $options{section}->{condensed}) {
3239 warn "$me _items_pkg condensing section\n"
3243 local $Storable::canonical = 1;
3244 foreach ( @items ) {
3246 delete $item->{ref};
3247 delete $item->{ext_description};
3248 my $key = freeze($item);
3249 $itemshash{$key} ||= 0;
3250 $itemshash{$key} ++; # += $item->{quantity};
3252 @items = sort { $a->{description} cmp $b->{description} }
3253 map { my $i = thaw($_);
3254 $i->{quantity} = $itemshash{$_};
3256 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
3262 warn "$me _items_pkg returning ". scalar(@items). " items\n"
3269 return 0 unless $a->itemdesc cmp $b->itemdesc;
3270 return -1 if $b->itemdesc eq 'Tax';
3271 return 1 if $a->itemdesc eq 'Tax';
3272 return -1 if $b->itemdesc eq 'Other surcharges';
3273 return 1 if $a->itemdesc eq 'Other surcharges';
3274 $a->itemdesc cmp $b->itemdesc;
3279 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
3280 $self->cust_bill_pkg;
3281 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3283 if ( $self->conf->exists('always_show_tax') ) {
3284 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
3285 if (0 == grep { $_->{description} eq $itemdesc } @items) {
3287 { 'description' => $itemdesc,
3294 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
3296 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
3297 list of hashrefs describing the line items they generate on the invoice.
3299 OPTIONS may include:
3301 format: the invoice format.
3303 escape_function: the function used to escape strings.
3305 DEPRECATED? (expensive, mostly unused?)
3306 format_function: the function used to format CDRs.
3308 section: a hashref containing 'category' and/or 'locationnum'; if this
3309 is present, only returns line items that belong to that category and/or
3310 location (whichever is defined).
3312 multisection: a flag indicating that this is a multisection invoice,
3313 which does something complicated.
3315 section_with_taxes: Look up and include applied taxes for each record
3317 Returns a list of hashrefs, each of which may contain:
3319 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
3320 ext_description, which is an arrayref of detail lines to show below
3325 sub _items_cust_bill_pkg {
3327 my $conf = $self->conf;
3328 my $cust_bill_pkgs = shift;
3331 my $format = $opt{format} || '';
3332 my $escape_function = $opt{escape_function} || sub { shift };
3333 my $format_function = $opt{format_function} || '';
3334 my $no_usage = $opt{no_usage} || '';
3335 my $unsquelched = $opt{unsquelched} || ''; #unused
3336 my ($section, $locationnum, $category);
3337 if ( $opt{section} ) {
3338 $category = $opt{section}->{category};
3339 $locationnum = $opt{section}->{locationnum};
3341 my $summary_page = $opt{summary_page} || ''; #unused
3342 my $multisection = defined($category) || defined($locationnum);
3343 # this variable is the value of the config setting, not whether it applies
3344 # to this particular line item.
3345 my $discount_show_always = $conf->exists('discount-show-always');
3347 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 40;
3349 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
3351 my $agentnum = $self->agentnum;
3353 # for location labels: use default location on the invoice date
3354 my $default_locationnum;
3355 if ( $conf->exists('invoice-all_pkg_addresses') ) {
3356 $default_locationnum = 0; # treat them all as non-default
3357 } elsif ( $self->custnum ) {
3359 my @h_search = FS::h_cust_main->sql_h_search($self->_date);
3360 $h_cust_main = qsearchs({
3361 'table' => 'h_cust_main',
3362 'hashref' => { custnum => $self->custnum },
3363 'extra_sql' => $h_search[1],
3364 'addl_from' => $h_search[3],
3366 $default_locationnum = $h_cust_main->ship_locationnum;
3367 } elsif ( $self->prospectnum ) {
3368 my $cust_location = qsearchs('cust_location',
3369 { prospectnum => $self->prospectnum,
3371 $default_locationnum = $cust_location->locationnum if $cust_location;
3374 my @b = (); # accumulator for the line item hashes that we'll return
3375 my ($s, $r, $u, $d) = ( undef, undef, undef, undef );
3376 # the 'current' line item hashes for setup, recur, usage, discount
3377 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
3379 # if the current line item is waiting to go out, and the one we're about
3380 # to start is not bundled, then push out the current one and start a new
3383 $d->{amount} = $d->{setup_amount} + $d->{recur_amount};
3385 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3386 if ( $_ && !$cust_bill_pkg->hidden ) {
3387 $_->{amount} = sprintf( "%.2f", $_->{amount} );
3388 $_->{amount} =~ s/^\-0\.00$/0.00/;
3389 if (exists($_->{unit_amount})) {
3390 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3393 # we already decided to create this display line; don't reconsider it
3395 # if $_->{amount} != 0
3396 # || $discount_show_always
3397 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3398 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3404 if ( $locationnum ) {
3405 # this is a location section; skip packages that aren't at this
3407 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
3408 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
3412 # Consider display records for this item to determine if it belongs
3413 # in this section. Note that if there are no display records, there
3414 # will be a default pseudo-record that includes all charge types
3415 # and has no section name.
3416 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
3417 ? $cust_bill_pkg->cust_bill_pkg_display
3418 : ( $cust_bill_pkg );
3420 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
3421 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
3424 if ( defined($category) ) {
3425 # then this is a package category section; process all display records
3426 # that belong to this section.
3427 @cust_bill_pkg_display = grep { $_->section eq $category }
3428 @cust_bill_pkg_display;
3430 # otherwise, process all display records that aren't usage summaries
3431 # (I don't think there should be usage summaries if you aren't using
3432 # category sections, but this is the historical behavior)
3433 @cust_bill_pkg_display = grep { !$_->summary }
3434 @cust_bill_pkg_display;
3437 my $classname = ''; # package class name, will fill in later
3439 foreach my $display (@cust_bill_pkg_display) {
3441 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
3442 $display->billpkgdisplaynum. "\n"
3445 my $type = $display->type;
3447 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
3448 $desc = substr($desc, 0, $maxlength). '...'
3449 if $format eq 'latex' && length($desc) > $maxlength;
3451 my %details_opt = ( 'format' => $format,
3452 'escape_function' => $escape_function,
3453 'format_function' => $format_function,
3454 'no_usage' => $opt{'no_usage'},
3457 if ( $cust_bill_pkg->pkgnum > 0 ) {
3458 # a "normal" package line item (not a quotation, not a fee, not a tax)
3460 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
3463 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3464 my $part_pkg = $cust_pkg->part_pkg;
3466 # which pkgpart to show for display purposes?
3467 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
3469 # start/end dates for invoice formats that do nonstandard
3471 my %item_dates = ();
3472 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
3473 unless $part_pkg->option('disable_line_item_date_ranges',1);
3475 # not normally used, but pass this to the template anyway
3476 $classname = $part_pkg->classname;
3478 my @pkg_tax = $cust_bill_pkg->_pkg_tax_list
3479 if $opt{section_with_taxes};
3481 if ( (!$type || $type eq 'S')
3482 && ( $cust_bill_pkg->setup != 0
3483 || $cust_bill_pkg->setup_show_zero
3484 || ($discount_show_always and $cust_bill_pkg->unitsetup > 0)
3489 warn "$me _items_cust_bill_pkg adding setup\n"
3492 # append the word 'Setup' to the setup line if there's going to be
3493 # a recur line for the same package (i.e. not a one-time charge)
3495 my $description = $desc;
3496 $description .= ' Setup'
3497 if $cust_bill_pkg->recur != 0
3498 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3499 || $cust_bill_pkg->recur_show_zero;
3501 my $disable_date_ranges =
3502 $opt{disable_line_item_date_ranges}
3503 || $part_pkg->option('disable_line_item_date_ranges', 1);
3505 $description .= $cust_bill_pkg->time_period_pretty(
3508 disable_date_ranges => $disable_date_ranges,
3510 if $part_pkg->is_prepaid #for prepaid, "display the validity period
3511 # triggered by the recurring charge freq
3513 && $cust_bill_pkg->recur == 0
3514 && ! $cust_bill_pkg->recur_show_zero;
3517 my @svc_labels = ();
3520 unless ( $part_pkg->hide_svc_detail ) {
3522 # still pass the svc_label through to the template, even if
3523 # not displaying it as an ext_description
3524 @svc_labels = map &{$escape_function}($_),
3525 $cust_pkg->h_labels_short($self->_date,
3528 $self->conf->{locale},
3530 $svc_label = $svc_labels[0];
3534 unless ( $part_pkg->hide_svc_detail
3535 || $cust_bill_pkg->hidden )
3538 push @d, @svc_labels
3539 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3540 # show the location label if it's not the customer's default
3541 # location, and we're not grouping items by location already
3542 if ( $cust_pkg->locationnum != $default_locationnum
3543 and !defined($locationnum) ) {
3544 my $loc = $cust_pkg->location_label;
3545 $loc = substr($loc, 0, $maxlength). '...'
3546 if $format eq 'latex' && length($loc) > $maxlength;
3547 push @d, &{$escape_function}($loc);
3550 } #unless hiding service details
3552 push @d, $cust_bill_pkg->details(%details_opt)
3553 if $cust_bill_pkg->recur == 0;
3555 if ( $cust_bill_pkg->hidden ) {
3556 $s->{amount} += $cust_bill_pkg->setup;
3557 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3558 push @{ $s->{ext_description} }, @d;
3561 billpkgnum => $cust_bill_pkg->billpkgnum,
3563 description => $description,
3564 pkgpart => $pkgpart,
3565 pkgnum => $cust_bill_pkg->pkgnum,
3566 amount => $cust_bill_pkg->setup,
3567 setup_show_zero => $cust_bill_pkg->setup_show_zero,
3568 unit_amount => $cust_bill_pkg->unitsetup,
3569 quantity => $cust_bill_pkg->quantity,
3570 ext_description => \@d,
3571 svc_label => ($svc_label || ''),
3572 locationnum => $cust_pkg->locationnum, # sure, why not?
3573 pkg_tax => \@pkg_tax,
3579 # should we show a recur line?
3580 # if type eq 'S', then NO, because we've been told not to.
3581 # otherwise, show the recur line if:
3582 # - there's a recurring charge
3583 # - or recur_show_zero is on
3584 # - or there's a positive unitrecur (so it's been discounted to zero)
3585 # and discount-show-always is on
3586 if ( ( !$type || $type eq 'R' || $type eq 'U' )
3588 $cust_bill_pkg->recur != 0
3590 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3591 || $cust_bill_pkg->recur_show_zero
3596 warn "$me _items_cust_bill_pkg adding recur/usage\n"
3599 my $is_summary = $display->summary;
3600 my $description = $desc;
3601 if ( $type eq 'U' and defined($r) ) {
3602 # don't just show the same description as the recur line
3603 $description = $self->mt('Usage charges');
3606 my $disable_date_ranges =
3607 $opt{disable_line_item_date_ranges}
3608 || $part_pkg->option('disable_line_item_date_ranges', 1);
3610 $description .= $cust_bill_pkg->time_period_pretty(
3613 disable_date_ranges => $disable_date_ranges,
3617 my @seconds = (); # for display of usage info
3618 my @svc_labels = ();
3621 #at least until cust_bill_pkg has "past" ranges in addition to
3622 #the "future" sdate/edate ones... see #3032
3623 my @dates = ( $self->_date );
3624 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
3625 push @dates, $prev->sdate if $prev;
3626 push @dates, undef if !$prev;
3628 unless ( $part_pkg->hide_svc_detail ) {
3629 @svc_labels = map &{$escape_function}($_),
3630 $cust_pkg->h_labels_short(@dates,
3632 $self->conf->{locale});
3633 $svc_label = $svc_labels[0];
3636 # show service labels, unless...
3637 # the package is set not to display them
3638 unless ( $part_pkg->hide_svc_detail
3639 # or this is a tax-like line item
3640 || $cust_bill_pkg->itemdesc
3641 # or this is a hidden (bundled) line item
3642 || $cust_bill_pkg->hidden
3643 # or this is a usage summary line
3644 || $is_summary && $type && $type eq 'U'
3645 # or this is a usage line and there's a recurring line
3646 # for the package in the same section (which will
3647 # have service labels already)
3648 || ($type eq 'U' and defined($r))
3652 warn "$me _items_cust_bill_pkg adding service details\n"
3655 push @d, @svc_labels
3656 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3657 warn "$me _items_cust_bill_pkg done adding service details\n"
3660 # show the location label if it's not the customer's default
3661 # location, and we're not grouping items by location already
3662 if ( $cust_pkg->locationnum != $default_locationnum
3663 and !defined($locationnum) ) {
3664 my $loc = $cust_pkg->location_label;
3665 $loc = substr($loc, 0, $maxlength). '...'
3666 if $format eq 'latex' && length($loc) > $maxlength;
3667 push @d, &{$escape_function}($loc);
3670 # Display of seconds_since_sqlradacct:
3671 # On the invoice, when processing @detail_items, look for a field
3672 # named 'seconds'. This will contain total seconds for each
3673 # service, in the same order as @ext_description. For services
3674 # that don't support this it will show undef.
3675 if ( $conf->exists('svc_acct-usage_seconds')
3676 and ! $cust_bill_pkg->pkgpart_override ) {
3677 foreach my $cust_svc (
3678 $cust_pkg->h_cust_svc(@dates, 'I')
3681 # eval because not having any part_export_usage exports
3682 # is a fatal error, last_bill/_date because that's how
3683 # sqlradius_hour billing does it
3685 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
3687 push @seconds, $sec;
3689 } #if svc_acct-usage_seconds
3691 } # if we are showing service labels
3693 unless ( $is_summary ) {
3694 warn "$me _items_cust_bill_pkg adding details\n"
3697 #instead of omitting details entirely in this case (unwanted side
3698 # effects), just omit CDRs
3699 $details_opt{'no_usage'} = 1
3700 if $type && $type eq 'R';
3702 push @d, $cust_bill_pkg->details(%details_opt);
3705 warn "$me _items_cust_bill_pkg calculating amount\n"
3710 $amount = $cust_bill_pkg->recur;
3711 } elsif ($type eq 'R') {
3712 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
3713 } elsif ($type eq 'U') {
3714 $amount = $cust_bill_pkg->usage;
3717 if ( !$type || $type eq 'R' ) {
3719 warn "$me _items_cust_bill_pkg adding recur\n"
3723 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
3726 if ( $cust_bill_pkg->hidden ) {
3727 $r->{amount} += $amount;
3728 $r->{unit_amount} += $unit_amount;
3729 push @{ $r->{ext_description} }, @d;
3732 billpkgnum => $cust_bill_pkg->billpkgnum,
3733 description => $description,
3734 pkgpart => $pkgpart,
3735 pkgnum => $cust_bill_pkg->pkgnum,
3737 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3738 unit_amount => $unit_amount,
3739 quantity => $cust_bill_pkg->quantity,
3741 ext_description => \@d,
3742 svc_label => ($svc_label || ''),
3743 locationnum => $cust_pkg->locationnum,
3744 pkg_tax => \@pkg_tax,
3746 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3749 } else { # $type eq 'U'
3751 warn "$me _items_cust_bill_pkg adding usage\n"
3754 if ( $cust_bill_pkg->hidden and defined($u) ) {
3755 # if this is a hidden package and there's already a usage
3756 # line for the bundle, add this package's total amount and
3757 # usage details to it
3758 $u->{amount} += $amount;
3759 push @{ $u->{ext_description} }, @d;
3760 } elsif ( $amount ) {
3761 # create a new usage line
3763 billpkgnum => $cust_bill_pkg->billpkgnum,
3764 description => $description,
3765 pkgpart => $pkgpart,
3766 pkgnum => $cust_bill_pkg->pkgnum,
3769 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3771 ext_description => \@d,
3772 locationnum => $cust_pkg->locationnum,
3773 pkg_tax => \@pkg_tax,
3775 } # else this has no usage, so don't create a usage section
3778 } # recurring or usage with recurring charge
3780 } else { # taxes and fees
3782 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3785 # items of this kind should normally not have sdate/edate.
3787 'description' => $desc,
3788 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
3789 + $cust_bill_pkg->recur)
3792 } # if package line item / other line item
3794 # decide whether to show active discounts here
3796 # case 1: we are showing a single line for the package
3798 # case 2: we are showing a setup line for a package that has
3799 # no base recurring fee
3800 or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3801 # case 3: we are showing a recur line for a package that has
3802 # a base recurring fee
3803 or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3806 my $item_discount = $cust_bill_pkg->_item_discount;
3807 if ( $item_discount ) {
3808 # $item_discount->{amount} is negative
3810 if ( $d and $cust_bill_pkg->hidden ) {
3811 $d->{setup_amount} += $item_discount->{setup_amount};
3812 $d->{recur_amount} += $item_discount->{recur_amount};
3814 $d = $item_discount;
3815 $_ = &{$escape_function}($_) foreach @{ $d->{ext_description} };
3818 # update the active line (before the discount) to show the
3819 # original price (whether this is a hidden line or not)
3821 $s->{amount} -= $item_discount->{setup_amount} if $s;
3822 $r->{amount} -= $item_discount->{recur_amount} if $r;
3824 } # if there are any discounts
3825 } # if this is an appropriate place to show discounts
3827 } # foreach $display
3831 # discount amount is internally split up
3833 $d->{amount} = $d->{setup_amount} + $d->{recur_amount};
3836 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3838 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3839 if exists($_->{amount});
3840 $_->{amount} =~ s/^\-0\.00$/0.00/;
3841 if (exists($_->{unit_amount})) {
3842 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3846 #if $_->{amount} != 0
3847 # || $discount_show_always
3848 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3849 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3853 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3860 =item _items_discounts_avail
3862 Returns an array of line item hashrefs representing available term discounts
3863 for this invoice. This makes the same assumptions that apply to term
3864 discounts in general: that the package is billed monthly, at a flat rate,
3865 with no usage charges. A prorated first month will be handled, as will
3866 a setup fee if the discount is allowed to apply to setup fees.
3870 sub _items_discounts_avail {
3873 #maybe move this method from cust_bill when quotations support discount_plans
3874 return () unless $self->can('discount_plans');
3875 my %plans = $self->discount_plans;
3877 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3878 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3882 my $plan = $plans{$months};
3884 my $term_total = sprintf('%.2f', $plan->discounted_total);
3885 my $percent = sprintf('%.0f',
3886 100 * (1 - $term_total / $plan->base_total) );
3887 my $permonth = sprintf('%.2f', $term_total / $months);
3888 my $detail = $self->mt('discount on item'). ' '.
3889 join(', ', map { "#$_" } $plan->pkgnums)
3892 # discounts for non-integer months don't work anyway
3893 $months = sprintf("%d", $months);
3896 description => $self->mt('Save [_1]% by paying for [_2] months',
3898 amount => $self->mt('[_1] ([_2] per month)',
3899 $term_total, $money_char.$permonth),
3900 ext_description => ($detail || ''),
3903 sort { $b <=> $a } keys %plans;
3907 =item has_sections AGENTNUM
3909 Return true if invoice_sections should be enabled for this bill.
3910 (Inherited by both cust_bill and cust_bill_void)
3913 * False if not an invoice
3914 * True always if conf invoice_sections is enabled
3915 * True always if sections_by_location is enabled
3916 * True if conf invoice_sections_multilocation > 1,
3917 and location_count >= invoice_sections_multilocation
3923 my ($self, $agentnum) = @_;
3925 return 0 unless $self->invnum > 0;
3927 $agentnum ||= $self->agentnum;
3928 return 1 if $self->conf->config_bool('invoice_sections', $agentnum);
3929 return 1 if $self->conf->exists('sections_by_location', $agentnum);
3931 my $location_min = $self->conf->config(
3932 'invoice_sections_multilocation', $agentnum,
3937 && $self->location_count >= $location_min;
3943 =item location_count
3945 Return the number of locations billed on this invoice
3949 sub location_count {
3951 return 0 unless $self->invnum;
3953 # SELECT COUNT( DISTINCT cust_pkg.locationnum )
3954 # FROM cust_bill_pkg
3955 # LEFT JOIN cust_pkg USING (pkgnum)
3956 # WHERE invnum = 278
3957 # AND cust_bill_pkg.pkgnum > 0
3959 my $result = qsearchs({
3960 select => 'COUNT(DISTINCT cust_pkg.locationnum) as location_count',
3961 table => 'cust_bill_pkg',
3962 addl_from => 'LEFT JOIN cust_pkg USING (pkgnum)',
3963 extra_sql => 'WHERE invnum = '.dbh->quote( $self->invnum )
3964 . ' AND cust_bill_pkg.pkgnum > 0'
3966 ref $result ? $result->location_count : 0;