4 use vars qw( @ISA $DEBUG $me
5 $money_char $date_format $rdate_format $date_format_long );
7 use vars qw( $invoice_lines @buf ); #yuck
8 use Fcntl qw(:flock); #for spool_csv
10 use List::Util qw(min max sum);
13 use Text::Template 1.20;
15 use String::ShellQuote;
18 use Storable qw( freeze thaw );
20 use FS::UID qw( datasrc );
21 use FS::Misc qw( send_email send_fax generate_ps generate_pdf do_print );
22 use FS::Record qw( qsearch qsearchs dbh );
23 use FS::cust_main_Mixin;
25 use FS::cust_statement;
26 use FS::cust_bill_pkg;
27 use FS::cust_bill_pkg_display;
28 use FS::cust_bill_pkg_detail;
32 use FS::cust_credit_bill;
34 use FS::cust_pay_batch;
35 use FS::cust_bill_event;
38 use FS::cust_bill_pay;
39 use FS::cust_bill_pay_batch;
40 use FS::part_bill_event;
43 use FS::cust_bill_batch;
44 use FS::cust_bill_pay_pkg;
45 use FS::cust_credit_bill_pkg;
46 use FS::discount_plan;
49 @ISA = qw( FS::cust_main_Mixin FS::Record );
52 $me = '[FS::cust_bill]';
54 #ask FS::UID to run this stuff for us later
55 FS::UID->install_callback( sub {
56 my $conf = new FS::Conf; #global
57 $money_char = $conf->config('money_char') || '$';
58 $date_format = $conf->config('date_format') || '%x'; #/YY
59 $rdate_format = $conf->config('date_format') || '%m/%d/%Y'; #/YYYY
60 $date_format_long = $conf->config('date_format_long') || '%b %o, %Y';
65 FS::cust_bill - Object methods for cust_bill records
71 $record = new FS::cust_bill \%hash;
72 $record = new FS::cust_bill { 'column' => 'value' };
74 $error = $record->insert;
76 $error = $new_record->replace($old_record);
78 $error = $record->delete;
80 $error = $record->check;
82 ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
84 @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
86 ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
88 @cust_pay_objects = $cust_bill->cust_pay;
90 $tax_amount = $record->tax;
92 @lines = $cust_bill->print_text;
93 @lines = $cust_bill->print_text $time;
97 An FS::cust_bill object represents an invoice; a declaration that a customer
98 owes you money. The specific charges are itemized as B<cust_bill_pkg> records
99 (see L<FS::cust_bill_pkg>). FS::cust_bill inherits from FS::Record. The
100 following fields are currently supported:
106 =item invnum - primary key (assigned automatically for new invoices)
108 =item custnum - customer (see L<FS::cust_main>)
110 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
111 L<Time::Local> and L<Date::Parse> for conversion functions.
113 =item charged - amount of this invoice
115 =item invoice_terms - optional terms override for this specific invoice
119 Customer info at invoice generation time
123 =item previous_balance
125 =item billing_balance
133 =item printed - deprecated
141 =item closed - books closed flag, empty or `Y'
143 =item statementnum - invoice aggregation (see L<FS::cust_statement>)
145 =item agent_invid - legacy invoice number
147 =item promised_date - customer promised payment date, for collection
157 Creates a new invoice. To add the invoice to the database, see L<"insert">.
158 Invoices are normally created by calling the bill method of a customer object
159 (see L<FS::cust_main>).
163 sub table { 'cust_bill'; }
165 sub cust_linked { $_[0]->cust_main_custnum; }
166 sub cust_unlinked_msg {
168 "WARNING: can't find cust_main.custnum ". $self->custnum.
169 ' (cust_bill.invnum '. $self->invnum. ')';
174 Adds this invoice to the database ("Posts" the invoice). If there is an error,
175 returns the error, otherwise returns false.
181 warn "$me insert called\n" if $DEBUG;
183 local $SIG{HUP} = 'IGNORE';
184 local $SIG{INT} = 'IGNORE';
185 local $SIG{QUIT} = 'IGNORE';
186 local $SIG{TERM} = 'IGNORE';
187 local $SIG{TSTP} = 'IGNORE';
188 local $SIG{PIPE} = 'IGNORE';
190 my $oldAutoCommit = $FS::UID::AutoCommit;
191 local $FS::UID::AutoCommit = 0;
194 my $error = $self->SUPER::insert;
196 $dbh->rollback if $oldAutoCommit;
200 if ( $self->get('cust_bill_pkg') ) {
201 foreach my $cust_bill_pkg ( @{$self->get('cust_bill_pkg')} ) {
202 $cust_bill_pkg->invnum($self->invnum);
203 my $error = $cust_bill_pkg->insert;
205 $dbh->rollback if $oldAutoCommit;
206 return "can't create invoice line item: $error";
211 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
218 This method now works but you probably shouldn't use it. Instead, apply a
219 credit against the invoice.
221 Using this method to delete invoices outright is really, really bad. There
222 would be no record you ever posted this invoice, and there are no check to
223 make sure charged = 0 or that there are no associated cust_bill_pkg records.
225 Really, don't use it.
231 return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
233 local $SIG{HUP} = 'IGNORE';
234 local $SIG{INT} = 'IGNORE';
235 local $SIG{QUIT} = 'IGNORE';
236 local $SIG{TERM} = 'IGNORE';
237 local $SIG{TSTP} = 'IGNORE';
238 local $SIG{PIPE} = 'IGNORE';
240 my $oldAutoCommit = $FS::UID::AutoCommit;
241 local $FS::UID::AutoCommit = 0;
244 foreach my $table (qw(
256 foreach my $linked ( $self->$table() ) {
257 my $error = $linked->delete;
259 $dbh->rollback if $oldAutoCommit;
266 my $error = $self->SUPER::delete(@_);
268 $dbh->rollback if $oldAutoCommit;
272 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
278 =item replace [ OLD_RECORD ]
280 You can, but probably shouldn't modify invoices...
282 Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
283 supplied, replaces this record. If there is an error, returns the error,
284 otherwise returns false.
288 #replace can be inherited from Record.pm
290 # replace_check is now the preferred way to #implement replace data checks
291 # (so $object->replace() works without an argument)
294 my( $new, $old ) = ( shift, shift );
295 return "Can't modify closed invoice" if $old->closed =~ /^Y/i;
296 #return "Can't change _date!" unless $old->_date eq $new->_date;
297 return "Can't change _date" unless $old->_date == $new->_date;
298 return "Can't change charged" unless $old->charged == $new->charged
299 || $old->charged == 0
300 || $new->{'Hash'}{'cc_surcharge_replace_hack'};
306 =item add_cc_surcharge
312 sub add_cc_surcharge {
313 my ($self, $pkgnum, $amount) = (shift, shift, shift);
316 my $cust_bill_pkg = new FS::cust_bill_pkg({
317 'invnum' => $self->invnum,
321 $error = $cust_bill_pkg->insert;
322 return $error if $error;
324 $self->{'Hash'}{'cc_surcharge_replace_hack'} = 1;
325 $self->charged($self->charged+$amount);
326 $error = $self->replace;
327 return $error if $error;
329 $self->apply_payments_and_credits;
335 Checks all fields to make sure this is a valid invoice. If there is an error,
336 returns the error, otherwise returns false. Called by the insert and replace
345 $self->ut_numbern('invnum')
346 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum' )
347 || $self->ut_numbern('_date')
348 || $self->ut_money('charged')
349 || $self->ut_numbern('printed')
350 || $self->ut_enum('closed', [ '', 'Y' ])
351 || $self->ut_foreign_keyn('statementnum', 'cust_statement', 'statementnum' )
352 || $self->ut_numbern('agent_invid') #varchar?
354 return $error if $error;
356 $self->_date(time) unless $self->_date;
358 $self->printed(0) if $self->printed eq '';
365 Returns the displayed invoice number for this invoice: agent_invid if
366 cust_bill-default_agent_invid is set and it has a value, invnum otherwise.
372 my $conf = $self->conf;
373 if ( $conf->exists('cust_bill-default_agent_invid') && $self->agent_invid ){
374 return $self->agent_invid;
376 return $self->invnum;
382 Returns a list consisting of the total previous balance for this customer,
383 followed by the previous outstanding invoices (as FS::cust_bill objects also).
390 my @cust_bill = sort { $a->_date <=> $b->_date }
391 grep { $_->owed != 0 && $_->_date < $self->_date }
392 qsearch( 'cust_bill', { 'custnum' => $self->custnum } )
394 foreach ( @cust_bill ) { $total += $_->owed; }
400 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
407 { 'table' => 'cust_bill_pkg',
408 'hashref' => { 'invnum' => $self->invnum },
409 'order_by' => 'ORDER BY billpkgnum',
414 =item cust_bill_pkg_pkgnum PKGNUM
416 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice and
421 sub cust_bill_pkg_pkgnum {
422 my( $self, $pkgnum ) = @_;
424 { 'table' => 'cust_bill_pkg',
425 'hashref' => { 'invnum' => $self->invnum,
428 'order_by' => 'ORDER BY billpkgnum',
435 Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
442 my @cust_pkg = map { $_->pkgnum > 0 ? $_->cust_pkg : () }
443 $self->cust_bill_pkg;
445 grep { ! $saw{$_->pkgnum}++ } @cust_pkg;
450 Returns true if any of the packages (or their definitions) corresponding to the
451 line items for this invoice have the no_auto flag set.
457 grep { $_->no_auto || $_->part_pkg->no_auto } $self->cust_pkg;
460 =item open_cust_bill_pkg
462 Returns the open line items for this invoice.
464 Note that cust_bill_pkg with both setup and recur fees are returned as two
465 separate line items, each with only one fee.
469 # modeled after cust_main::open_cust_bill
470 sub open_cust_bill_pkg {
473 # grep { $_->owed > 0 } $self->cust_bill_pkg
475 my %other = ( 'recur' => 'setup',
476 'setup' => 'recur', );
478 foreach my $field ( qw( recur setup )) {
479 push @open, map { $_->set( $other{$field}, 0 ); $_; }
480 grep { $_->owed($field) > 0 }
481 $self->cust_bill_pkg;
487 =item cust_bill_event
489 Returns the completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
493 sub cust_bill_event {
495 qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
498 =item num_cust_bill_event
500 Returns the number of completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
504 sub num_cust_bill_event {
507 "SELECT COUNT(*) FROM cust_bill_event WHERE invnum = ?";
508 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
509 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
510 $sth->fetchrow_arrayref->[0];
515 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
519 #false laziness w/cust_pkg.pm
523 'table' => 'cust_event',
524 'addl_from' => 'JOIN part_event USING ( eventpart )',
525 'hashref' => { 'tablenum' => $self->invnum },
526 'extra_sql' => " AND eventtable = 'cust_bill' ",
532 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
536 #false laziness w/cust_pkg.pm
540 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
541 " WHERE tablenum = ? AND eventtable = 'cust_bill'";
542 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
543 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
544 $sth->fetchrow_arrayref->[0];
549 Returns the customer (see L<FS::cust_main>) for this invoice.
555 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
558 =item cust_suspend_if_balance_over AMOUNT
560 Suspends the customer associated with this invoice if the total amount owed on
561 this invoice and all older invoices is greater than the specified amount.
563 Returns a list: an empty list on success or a list of errors.
567 sub cust_suspend_if_balance_over {
568 my( $self, $amount ) = ( shift, shift );
569 my $cust_main = $self->cust_main;
570 if ( $cust_main->total_owed_date($self->_date) < $amount ) {
573 $cust_main->suspend(@_);
579 Depreciated. See the cust_credited method.
581 #Returns a list consisting of the total previous credited (see
582 #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
583 #outstanding credits (FS::cust_credit objects).
589 croak "FS::cust_bill->cust_credit depreciated; see ".
590 "FS::cust_bill->cust_credit_bill";
593 #my @cust_credit = sort { $a->_date <=> $b->_date }
594 # grep { $_->credited != 0 && $_->_date < $self->_date }
595 # qsearch('cust_credit', { 'custnum' => $self->custnum } )
597 #foreach (@cust_credit) { $total += $_->credited; }
598 #$total, @cust_credit;
603 Depreciated. See the cust_bill_pay method.
605 #Returns all payments (see L<FS::cust_pay>) for this invoice.
611 croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
613 #sort { $a->_date <=> $b->_date }
614 # qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
620 qsearch('cust_pay_batch', { 'invnum' => $self->invnum } );
623 sub cust_bill_pay_batch {
625 qsearch('cust_bill_pay_batch', { 'invnum' => $self->invnum } );
630 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
636 map { $_ } #return $self->num_cust_bill_pay unless wantarray;
637 sort { $a->_date <=> $b->_date }
638 qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
643 =item cust_credit_bill
645 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
651 map { $_ } #return $self->num_cust_credit_bill unless wantarray;
652 sort { $a->_date <=> $b->_date }
653 qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
657 sub cust_credit_bill {
658 shift->cust_credited(@_);
661 #=item cust_bill_pay_pkgnum PKGNUM
663 #Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
664 #with matching pkgnum.
668 #sub cust_bill_pay_pkgnum {
669 # my( $self, $pkgnum ) = @_;
670 # map { $_ } #return $self->num_cust_bill_pay_pkgnum($pkgnum) unless wantarray;
671 # sort { $a->_date <=> $b->_date }
672 # qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum,
673 # 'pkgnum' => $pkgnum,
678 =item cust_bill_pay_pkg PKGNUM
680 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
681 applied against the matching pkgnum.
685 sub cust_bill_pay_pkg {
686 my( $self, $pkgnum ) = @_;
689 'select' => 'cust_bill_pay_pkg.*',
690 'table' => 'cust_bill_pay_pkg',
691 'addl_from' => ' LEFT JOIN cust_bill_pay USING ( billpaynum ) '.
692 ' LEFT JOIN cust_bill_pkg USING ( billpkgnum ) ',
693 'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
694 " AND cust_bill_pkg.pkgnum = $pkgnum",
699 #=item cust_credited_pkgnum PKGNUM
701 #=item cust_credit_bill_pkgnum PKGNUM
703 #Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice
704 #with matching pkgnum.
708 #sub cust_credited_pkgnum {
709 # my( $self, $pkgnum ) = @_;
710 # map { $_ } #return $self->num_cust_credit_bill_pkgnum($pkgnum) unless wantarray;
711 # sort { $a->_date <=> $b->_date }
712 # qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum,
713 # 'pkgnum' => $pkgnum,
718 #sub cust_credit_bill_pkgnum {
719 # shift->cust_credited_pkgnum(@_);
722 =item cust_credit_bill_pkg PKGNUM
724 Returns all credit applications (see L<FS::cust_credit_bill>) for this invoice
725 applied against the matching pkgnum.
729 sub cust_credit_bill_pkg {
730 my( $self, $pkgnum ) = @_;
733 'select' => 'cust_credit_bill_pkg.*',
734 'table' => 'cust_credit_bill_pkg',
735 'addl_from' => ' LEFT JOIN cust_credit_bill USING ( creditbillnum ) '.
736 ' LEFT JOIN cust_bill_pkg USING ( billpkgnum ) ',
737 'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
738 " AND cust_bill_pkg.pkgnum = $pkgnum",
743 =item cust_bill_batch
745 Returns all invoice batch records (L<FS::cust_bill_batch>) for this invoice.
749 sub cust_bill_batch {
751 qsearch('cust_bill_batch', { 'invnum' => $self->invnum });
756 Returns all discount plans (L<FS::discount_plan>) for this invoice, as a
757 hash keyed by term length.
763 FS::discount_plan->all($self);
768 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
775 my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
777 foreach (@taxlines) { $total += $_->setup; }
783 Returns the amount owed (still outstanding) on this invoice, which is charged
784 minus all payment applications (see L<FS::cust_bill_pay>) and credit
785 applications (see L<FS::cust_credit_bill>).
791 my $balance = $self->charged;
792 $balance -= $_->amount foreach ( $self->cust_bill_pay );
793 $balance -= $_->amount foreach ( $self->cust_credited );
794 $balance = sprintf( "%.2f", $balance);
795 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
800 my( $self, $pkgnum ) = @_;
802 #my $balance = $self->charged;
804 $balance += $_->setup + $_->recur for $self->cust_bill_pkg_pkgnum($pkgnum);
806 $balance -= $_->amount for $self->cust_bill_pay_pkg($pkgnum);
807 $balance -= $_->amount for $self->cust_credit_bill_pkg($pkgnum);
809 $balance = sprintf( "%.2f", $balance);
810 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
816 Returns true if this invoice should be hidden. See the
817 selfservice-hide_invoices-taxclass configuraiton setting.
823 my $conf = $self->conf;
824 my $hide_taxclass = $conf->config('selfservice-hide_invoices-taxclass')
826 my @cust_bill_pkg = $self->cust_bill_pkg;
827 my @part_pkg = grep $_, map $_->part_pkg, @cust_bill_pkg;
828 ! grep { $_->taxclass ne $hide_taxclass } @part_pkg;
831 =item apply_payments_and_credits [ OPTION => VALUE ... ]
833 Applies unapplied payments and credits to this invoice.
835 A hash of optional arguments may be passed. Currently "manual" is supported.
836 If true, a payment receipt is sent instead of a statement when
837 'payment_receipt_email' configuration option is set.
839 If there is an error, returns the error, otherwise returns false.
843 sub apply_payments_and_credits {
844 my( $self, %options ) = @_;
845 my $conf = $self->conf;
847 local $SIG{HUP} = 'IGNORE';
848 local $SIG{INT} = 'IGNORE';
849 local $SIG{QUIT} = 'IGNORE';
850 local $SIG{TERM} = 'IGNORE';
851 local $SIG{TSTP} = 'IGNORE';
852 local $SIG{PIPE} = 'IGNORE';
854 my $oldAutoCommit = $FS::UID::AutoCommit;
855 local $FS::UID::AutoCommit = 0;
858 $self->select_for_update; #mutex
860 my @payments = grep { $_->unapplied > 0 } $self->cust_main->cust_pay;
861 my @credits = grep { $_->credited > 0 } $self->cust_main->cust_credit;
863 if ( $conf->exists('pkg-balances') ) {
864 # limit @payments & @credits to those w/ a pkgnum grepped from $self
865 my %pkgnums = map { $_ => 1 } map $_->pkgnum, $self->cust_bill_pkg;
866 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
867 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
870 while ( $self->owed > 0 and ( @payments || @credits ) ) {
873 if ( @payments && @credits ) {
875 #decide which goes first by weight of top (unapplied) line item
877 my @open_lineitems = $self->open_cust_bill_pkg;
880 max( map { $_->part_pkg->pay_weight || 0 }
885 my $max_credit_weight =
886 max( map { $_->part_pkg->credit_weight || 0 }
892 #if both are the same... payments first? it has to be something
893 if ( $max_pay_weight >= $max_credit_weight ) {
899 } elsif ( @payments ) {
901 } elsif ( @credits ) {
904 die "guru meditation #12 and 35";
908 if ( $app eq 'pay' ) {
910 my $payment = shift @payments;
911 $unapp_amount = $payment->unapplied;
912 $app = new FS::cust_bill_pay { 'paynum' => $payment->paynum };
913 $app->pkgnum( $payment->pkgnum )
914 if $conf->exists('pkg-balances') && $payment->pkgnum;
916 } elsif ( $app eq 'credit' ) {
918 my $credit = shift @credits;
919 $unapp_amount = $credit->credited;
920 $app = new FS::cust_credit_bill { 'crednum' => $credit->crednum };
921 $app->pkgnum( $credit->pkgnum )
922 if $conf->exists('pkg-balances') && $credit->pkgnum;
925 die "guru meditation #12 and 35";
929 if ( $conf->exists('pkg-balances') && $app->pkgnum ) {
930 warn "owed_pkgnum ". $app->pkgnum;
931 $owed = $self->owed_pkgnum($app->pkgnum);
935 next unless $owed > 0;
937 warn "min ( $unapp_amount, $owed )\n" if $DEBUG;
938 $app->amount( sprintf('%.2f', min( $unapp_amount, $owed ) ) );
940 $app->invnum( $self->invnum );
942 my $error = $app->insert(%options);
944 $dbh->rollback if $oldAutoCommit;
945 return "Error inserting ". $app->table. " record: $error";
947 die $error if $error;
951 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
956 =item generate_email OPTION => VALUE ...
964 sender address, required
968 alternate template name, optional
972 text attachment arrayref, optional
976 email subject, optional
980 notice name instead of "Invoice", optional
984 Returns an argument list to be passed to L<FS::Misc::send_email>.
994 my $conf = $self->conf;
996 my $me = '[FS::cust_bill::generate_email]';
999 'from' => $args{'from'},
1000 'subject' => (($args{'subject'}) ? $args{'subject'} : 'Invoice'),
1004 'unsquelch_cdr' => $conf->exists('voip-cdr_email'),
1005 'template' => $args{'template'},
1006 'notice_name' => ( $args{'notice_name'} || 'Invoice' ),
1007 'no_coupon' => $args{'no_coupon'},
1010 my $cust_main = $self->cust_main;
1012 if (ref($args{'to'}) eq 'ARRAY') {
1013 $return{'to'} = $args{'to'};
1015 $return{'to'} = [ grep { $_ !~ /^(POST|FAX)$/ }
1016 $cust_main->invoicing_list
1020 if ( $conf->exists('invoice_html') ) {
1022 warn "$me creating HTML/text multipart message"
1025 $return{'nobody'} = 1;
1027 my $alternative = build MIME::Entity
1028 'Type' => 'multipart/alternative',
1029 #'Encoding' => '7bit',
1030 'Disposition' => 'inline'
1034 if ( $conf->exists('invoice_email_pdf')
1035 and scalar($conf->config('invoice_email_pdf_note')) ) {
1037 warn "$me using 'invoice_email_pdf_note' in multipart message"
1039 $data = [ map { $_ . "\n" }
1040 $conf->config('invoice_email_pdf_note')
1045 warn "$me not using 'invoice_email_pdf_note' in multipart message"
1047 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1048 $data = $args{'print_text'};
1050 $data = [ $self->print_text(\%opt) ];
1055 $alternative->attach(
1056 'Type' => 'text/plain',
1057 'Encoding' => 'quoted-printable',
1058 #'Encoding' => '7bit',
1060 'Disposition' => 'inline',
1067 if ( $conf->exists('invoice_email_pdf')
1068 and scalar($conf->config('invoice_email_pdf_note')) ) {
1070 $htmldata = join('<BR>', $conf->config('invoice_email_pdf_note') );
1074 $args{'from'} =~ /\@([\w\.\-]+)/;
1075 my $from = $1 || 'example.com';
1076 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
1079 my $agentnum = $cust_main->agentnum;
1080 if ( defined($args{'template'}) && length($args{'template'})
1081 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
1084 $logo = 'logo_'. $args{'template'}. '.png';
1088 my $image_data = $conf->config_binary( $logo, $agentnum);
1090 $image = build MIME::Entity
1091 'Type' => 'image/png',
1092 'Encoding' => 'base64',
1093 'Data' => $image_data,
1094 'Filename' => 'logo.png',
1095 'Content-ID' => "<$content_id>",
1098 if ($conf->exists('invoice-barcode')) {
1099 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
1100 $barcode = build MIME::Entity
1101 'Type' => 'image/png',
1102 'Encoding' => 'base64',
1103 'Data' => $self->invoice_barcode(0),
1104 'Filename' => 'barcode.png',
1105 'Content-ID' => "<$barcode_content_id>",
1107 $opt{'barcode_cid'} = $barcode_content_id;
1110 $htmldata = $self->print_html({ 'cid'=>$content_id, %opt });
1113 $alternative->attach(
1114 'Type' => 'text/html',
1115 'Encoding' => 'quoted-printable',
1116 'Data' => [ '<html>',
1119 ' '. encode_entities($return{'subject'}),
1122 ' <body bgcolor="#e8e8e8">',
1127 'Disposition' => 'inline',
1128 #'Filename' => 'invoice.pdf',
1132 my @otherparts = ();
1133 if ( $cust_main->email_csv_cdr ) {
1135 push @otherparts, build MIME::Entity
1136 'Type' => 'text/csv',
1137 'Encoding' => '7bit',
1138 'Data' => [ map { "$_\n" }
1139 $self->call_details('prepend_billed_number' => 1)
1141 'Disposition' => 'attachment',
1142 'Filename' => 'usage-'. $self->invnum. '.csv',
1147 if ( $conf->exists('invoice_email_pdf') ) {
1152 # multipart/alternative
1158 my $related = build MIME::Entity 'Type' => 'multipart/related',
1159 'Encoding' => '7bit';
1161 #false laziness w/Misc::send_email
1162 $related->head->replace('Content-type',
1163 $related->mime_type.
1164 '; boundary="'. $related->head->multipart_boundary. '"'.
1165 '; type=multipart/alternative'
1168 $related->add_part($alternative);
1170 $related->add_part($image) if $image;
1172 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%opt);
1174 $return{'mimeparts'} = [ $related, $pdf, @otherparts ];
1178 #no other attachment:
1180 # multipart/alternative
1185 $return{'content-type'} = 'multipart/related';
1186 if ($conf->exists('invoice-barcode') && $barcode) {
1187 $return{'mimeparts'} = [ $alternative, $image, $barcode, @otherparts ];
1189 $return{'mimeparts'} = [ $alternative, $image, @otherparts ];
1191 $return{'type'} = 'multipart/alternative'; #Content-Type of first part...
1192 #$return{'disposition'} = 'inline';
1198 if ( $conf->exists('invoice_email_pdf') ) {
1199 warn "$me creating PDF attachment"
1202 #mime parts arguments a la MIME::Entity->build().
1203 $return{'mimeparts'} = [
1204 { $self->mimebuild_pdf(\%opt) }
1208 if ( $conf->exists('invoice_email_pdf')
1209 and scalar($conf->config('invoice_email_pdf_note')) ) {
1211 warn "$me using 'invoice_email_pdf_note'"
1213 $return{'body'} = [ map { $_ . "\n" }
1214 $conf->config('invoice_email_pdf_note')
1219 warn "$me not using 'invoice_email_pdf_note'"
1221 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1222 $return{'body'} = $args{'print_text'};
1224 $return{'body'} = [ $self->print_text(\%opt) ];
1237 Returns a list suitable for passing to MIME::Entity->build(), representing
1238 this invoice as PDF attachment.
1245 'Type' => 'application/pdf',
1246 'Encoding' => 'base64',
1247 'Data' => [ $self->print_pdf(@_) ],
1248 'Disposition' => 'attachment',
1249 'Filename' => 'invoice-'. $self->invnum. '.pdf',
1253 =item send HASHREF | [ TEMPLATE [ , AGENTNUM [ , INVOICE_FROM [ , AMOUNT ] ] ] ]
1255 Sends this invoice to the destinations configured for this customer: sends
1256 email, prints and/or faxes. See L<FS::cust_main_invoice>.
1258 Options can be passed as a hashref (recommended) or as a list of up to
1259 four values for templatename, agentnum, invoice_from and amount.
1261 I<template>, if specified, is the name of a suffix for alternate invoices.
1263 I<agentnum>, if specified, means that this invoice will only be sent for customers
1264 of the specified agent or agent(s). AGENTNUM can be a scalar agentnum (for a
1265 single agent) or an arrayref of agentnums.
1267 I<invoice_from>, if specified, overrides the default email invoice From: address.
1269 I<amount>, if specified, only sends the invoice if the total amount owed on this
1270 invoice and all older invoices is greater than the specified amount.
1272 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1276 sub queueable_send {
1279 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1280 or die "invalid invoice number: " . $opt{invnum};
1282 my @args = ( $opt{template}, $opt{agentnum} );
1283 push @args, $opt{invoice_from}
1284 if exists($opt{invoice_from}) && $opt{invoice_from};
1286 my $error = $self->send( @args );
1287 die $error if $error;
1293 my $conf = $self->conf;
1295 my( $template, $invoice_from, $notice_name );
1297 my $balance_over = 0;
1301 $template = $opt->{'template'} || '';
1302 if ( $agentnums = $opt->{'agentnum'} ) {
1303 $agentnums = [ $agentnums ] unless ref($agentnums);
1305 $invoice_from = $opt->{'invoice_from'};
1306 $balance_over = $opt->{'balance_over'} if $opt->{'balance_over'};
1307 $notice_name = $opt->{'notice_name'};
1309 $template = scalar(@_) ? shift : '';
1310 if ( scalar(@_) && $_[0] ) {
1311 $agentnums = ref($_[0]) ? shift : [ shift ];
1313 $invoice_from = shift if scalar(@_);
1314 $balance_over = shift if scalar(@_) && $_[0] !~ /^\s*$/;
1317 return 'N/A' unless ! $agentnums
1318 or grep { $_ == $self->cust_main->agentnum } @$agentnums;
1321 unless $self->cust_main->total_owed_date($self->_date) > $balance_over;
1323 $invoice_from ||= $self->_agent_invoice_from || #XXX should go away
1324 $conf->config('invoice_from', $self->cust_main->agentnum );
1327 'template' => $template,
1328 'invoice_from' => $invoice_from,
1329 'notice_name' => ( $notice_name || 'Invoice' ),
1332 my @invoicing_list = $self->cust_main->invoicing_list;
1334 #$self->email_invoice(\%opt)
1336 if grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list;
1338 #$self->print_invoice(\%opt)
1340 if grep { $_ eq 'POST' } @invoicing_list; #postal
1342 $self->fax_invoice(\%opt)
1343 if grep { $_ eq 'FAX' } @invoicing_list; #fax
1349 =item email HASHREF | [ TEMPLATE [ , INVOICE_FROM ] ]
1351 Emails this invoice.
1353 Options can be passed as a hashref (recommended) or as a list of up to
1354 two values for templatename and invoice_from.
1356 I<template>, if specified, is the name of a suffix for alternate invoices.
1358 I<invoice_from>, if specified, overrides the default email invoice From: address.
1360 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1364 sub queueable_email {
1367 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1368 or die "invalid invoice number: " . $opt{invnum};
1370 my %args = ( 'template' => $opt{template} );
1371 $args{$_} = $opt{$_}
1372 foreach grep { exists($opt{$_}) && $opt{$_} }
1373 qw( invoice_from notice_name no_coupon );
1375 my $error = $self->email( \%args );
1376 die $error if $error;
1380 #sub email_invoice {
1383 return if $self->hide;
1384 my $conf = $self->conf;
1386 my( $template, $invoice_from, $notice_name, $no_coupon );
1389 $template = $opt->{'template'} || '';
1390 $invoice_from = $opt->{'invoice_from'};
1391 $notice_name = $opt->{'notice_name'} || 'Invoice';
1392 $no_coupon = $opt->{'no_coupon'} || 0;
1394 $template = scalar(@_) ? shift : '';
1395 $invoice_from = shift if scalar(@_);
1396 $notice_name = 'Invoice';
1400 $invoice_from ||= $self->_agent_invoice_from || #XXX should go away
1401 $conf->config('invoice_from', $self->cust_main->agentnum );
1403 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
1404 $self->cust_main->invoicing_list;
1406 if ( ! @invoicing_list ) { #no recipients
1407 if ( $conf->exists('cust_bill-no_recipients-error') ) {
1408 die 'No recipients for customer #'. $self->custnum;
1410 #default: better to notify this person than silence
1411 @invoicing_list = ($invoice_from);
1415 my $subject = $self->email_subject($template);
1417 my $error = send_email(
1418 $self->generate_email(
1419 'from' => $invoice_from,
1420 'to' => [ grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list ],
1421 'subject' => $subject,
1422 'template' => $template,
1423 'notice_name' => $notice_name,
1424 'no_coupon' => $no_coupon,
1427 die "can't email invoice: $error\n" if $error;
1428 #die "$error\n" if $error;
1434 my $conf = $self->conf;
1436 #my $template = scalar(@_) ? shift : '';
1439 my $subject = $conf->config('invoice_subject', $self->cust_main->agentnum)
1442 my $cust_main = $self->cust_main;
1443 my $name = $cust_main->name;
1444 my $name_short = $cust_main->name_short;
1445 my $invoice_number = $self->invnum;
1446 my $invoice_date = $self->_date_pretty;
1448 eval qq("$subject");
1451 =item lpr_data HASHREF | [ TEMPLATE ]
1453 Returns the postscript or plaintext for this invoice as an arrayref.
1455 Options can be passed as a hashref (recommended) or as a single optional value
1458 I<template>, if specified, is the name of a suffix for alternate invoices.
1460 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1466 my $conf = $self->conf;
1467 my( $template, $notice_name );
1470 $template = $opt->{'template'} || '';
1471 $notice_name = $opt->{'notice_name'} || 'Invoice';
1473 $template = scalar(@_) ? shift : '';
1474 $notice_name = 'Invoice';
1478 'template' => $template,
1479 'notice_name' => $notice_name,
1482 my $method = $conf->exists('invoice_latex') ? 'print_ps' : 'print_text';
1483 [ $self->$method( \%opt ) ];
1486 =item print HASHREF | [ TEMPLATE ]
1488 Prints this invoice.
1490 Options can be passed as a hashref (recommended) or as a single optional
1493 I<template>, if specified, is the name of a suffix for alternate invoices.
1495 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1499 #sub print_invoice {
1502 return if $self->hide;
1503 my $conf = $self->conf;
1505 my( $template, $notice_name );
1508 $template = $opt->{'template'} || '';
1509 $notice_name = $opt->{'notice_name'} || 'Invoice';
1511 $template = scalar(@_) ? shift : '';
1512 $notice_name = 'Invoice';
1516 'template' => $template,
1517 'notice_name' => $notice_name,
1520 if($conf->exists('invoice_print_pdf')) {
1521 # Add the invoice to the current batch.
1522 $self->batch_invoice(\%opt);
1525 do_print $self->lpr_data(\%opt);
1529 =item fax_invoice HASHREF | [ TEMPLATE ]
1533 Options can be passed as a hashref (recommended) or as a single optional
1536 I<template>, if specified, is the name of a suffix for alternate invoices.
1538 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1544 return if $self->hide;
1545 my $conf = $self->conf;
1547 my( $template, $notice_name );
1550 $template = $opt->{'template'} || '';
1551 $notice_name = $opt->{'notice_name'} || 'Invoice';
1553 $template = scalar(@_) ? shift : '';
1554 $notice_name = 'Invoice';
1557 die 'FAX invoice destination not (yet?) supported with plain text invoices.'
1558 unless $conf->exists('invoice_latex');
1560 my $dialstring = $self->cust_main->getfield('fax');
1564 'template' => $template,
1565 'notice_name' => $notice_name,
1568 my $error = send_fax( 'docdata' => $self->lpr_data(\%opt),
1569 'dialstring' => $dialstring,
1571 die $error if $error;
1575 =item batch_invoice [ HASHREF ]
1577 Place this invoice into the open batch (see C<FS::bill_batch>). If there
1578 isn't an open batch, one will be created.
1583 my ($self, $opt) = @_;
1584 my $bill_batch = $self->get_open_bill_batch;
1585 my $cust_bill_batch = FS::cust_bill_batch->new({
1586 batchnum => $bill_batch->batchnum,
1587 invnum => $self->invnum,
1589 return $cust_bill_batch->insert($opt);
1592 =item get_open_batch
1594 Returns the currently open batch as an FS::bill_batch object, creating a new
1595 one if necessary. (A per-agent batch if invoice_print_pdf-spoolagent is
1600 sub get_open_bill_batch {
1602 my $conf = $self->conf;
1603 my $hashref = { status => 'O' };
1604 $hashref->{'agentnum'} = $conf->exists('invoice_print_pdf-spoolagent')
1605 ? $self->cust_main->agentnum
1607 my $batch = qsearchs('bill_batch', $hashref);
1608 return $batch if $batch;
1609 $batch = FS::bill_batch->new($hashref);
1610 my $error = $batch->insert;
1611 die $error if $error;
1615 =item ftp_invoice [ TEMPLATENAME ]
1617 Sends this invoice data via FTP.
1619 TEMPLATENAME is unused?
1625 my $conf = $self->conf;
1626 my $template = scalar(@_) ? shift : '';
1629 'protocol' => 'ftp',
1630 'server' => $conf->config('cust_bill-ftpserver'),
1631 'username' => $conf->config('cust_bill-ftpusername'),
1632 'password' => $conf->config('cust_bill-ftppassword'),
1633 'dir' => $conf->config('cust_bill-ftpdir'),
1634 'format' => $conf->config('cust_bill-ftpformat'),
1638 =item spool_invoice [ TEMPLATENAME ]
1640 Spools this invoice data (see L<FS::spool_csv>)
1642 TEMPLATENAME is unused?
1648 my $conf = $self->conf;
1649 my $template = scalar(@_) ? shift : '';
1652 'format' => $conf->config('cust_bill-spoolformat'),
1653 'agent_spools' => $conf->exists('cust_bill-spoolagent'),
1657 =item send_if_newest [ TEMPLATENAME [ , AGENTNUM [ , INVOICE_FROM ] ] ]
1659 Like B<send>, but only sends the invoice if it is the newest open invoice for
1664 sub send_if_newest {
1669 grep { $_->owed > 0 }
1670 qsearch('cust_bill', {
1671 'custnum' => $self->custnum,
1672 #'_date' => { op=>'>', value=>$self->_date },
1673 'invnum' => { op=>'>', value=>$self->invnum },
1680 =item send_csv OPTION => VALUE, ...
1682 Sends invoice as a CSV data-file to a remote host with the specified protocol.
1686 protocol - currently only "ftp"
1692 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
1693 and YYMMDDHHMMSS is a timestamp.
1695 See L</print_csv> for a description of the output format.
1700 my($self, %opt) = @_;
1704 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1705 mkdir $spooldir, 0700 unless -d $spooldir;
1707 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1708 my $file = "$spooldir/$tracctnum.csv";
1710 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1712 open(CSV, ">$file") or die "can't open $file: $!";
1720 if ( $opt{protocol} eq 'ftp' ) {
1721 eval "use Net::FTP;";
1723 $net = Net::FTP->new($opt{server}) or die @$;
1725 die "unknown protocol: $opt{protocol}";
1728 $net->login( $opt{username}, $opt{password} )
1729 or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
1731 $net->binary or die "can't set binary mode";
1733 $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
1735 $net->put($file) or die "can't put $file: $!";
1745 Spools CSV invoice data.
1751 =item format - 'default' or 'billco'
1753 =item dest - if set (to POST, EMAIL or FAX), only sends spools invoices if the customer has the corresponding invoice destinations set (see L<FS::cust_main_invoice>).
1755 =item agent_spools - if set to a true value, will spool to per-agent files rather than a single global file
1757 =item balanceover - if set, only spools the invoice if the total amount owed on this invoice and all older invoices is greater than the specified amount.
1764 my($self, %opt) = @_;
1766 my $cust_main = $self->cust_main;
1768 if ( $opt{'dest'} ) {
1769 my %invoicing_list = map { /^(POST|FAX)$/ or 'EMAIL' =~ /^(.*)$/; $1 => 1 }
1770 $cust_main->invoicing_list;
1771 return 'N/A' unless $invoicing_list{$opt{'dest'}}
1772 || ! keys %invoicing_list;
1775 if ( $opt{'balanceover'} ) {
1777 if $cust_main->total_owed_date($self->_date) < $opt{'balanceover'};
1780 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1781 mkdir $spooldir, 0700 unless -d $spooldir;
1783 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1787 ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1788 ( lc($opt{'format'}) eq 'billco' ? '-header' : '' ) .
1791 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1793 open(CSV, ">>$file") or die "can't open $file: $!";
1794 flock(CSV, LOCK_EX);
1799 if ( lc($opt{'format'}) eq 'billco' ) {
1801 flock(CSV, LOCK_UN);
1806 ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1809 open(CSV,">>$file") or die "can't open $file: $!";
1810 flock(CSV, LOCK_EX);
1816 flock(CSV, LOCK_UN);
1823 =item print_csv OPTION => VALUE, ...
1825 Returns CSV data for this invoice.
1829 format - 'default' or 'billco'
1831 Returns a list consisting of two scalars. The first is a single line of CSV
1832 header information for this invoice. The second is one or more lines of CSV
1833 detail information for this invoice.
1835 If I<format> is not specified or "default", the fields of the CSV file are as
1838 record_type, invnum, custnum, _date, charged, first, last, company, address1, address2, city, state, zip, country, pkg, setup, recur, sdate, edate
1842 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
1844 B<record_type> is C<cust_bill> for the initial header line only. The
1845 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
1846 fields are filled in.
1848 B<record_type> is C<cust_bill_pkg> for detail lines. Only the first two fields
1849 (B<record_type> and B<invnum>) and the last five fields (B<pkg> through B<edate>)
1852 =item invnum - invoice number
1854 =item custnum - customer number
1856 =item _date - invoice date
1858 =item charged - total invoice amount
1860 =item first - customer first name
1862 =item last - customer first name
1864 =item company - company name
1866 =item address1 - address line 1
1868 =item address2 - address line 1
1878 =item pkg - line item description
1880 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
1882 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
1884 =item sdate - start date for recurring fee
1886 =item edate - end date for recurring fee
1890 If I<format> is "billco", the fields of the header CSV file are as follows:
1892 +-------------------------------------------------------------------+
1893 | FORMAT HEADER FILE |
1894 |-------------------------------------------------------------------|
1895 | Field | Description | Name | Type | Width |
1896 | 1 | N/A-Leave Empty | RC | CHAR | 2 |
1897 | 2 | N/A-Leave Empty | CUSTID | CHAR | 15 |
1898 | 3 | Transaction Account No | TRACCTNUM | CHAR | 15 |
1899 | 4 | Transaction Invoice No | TRINVOICE | CHAR | 15 |
1900 | 5 | Transaction Zip Code | TRZIP | CHAR | 5 |
1901 | 6 | Transaction Company Bill To | TRCOMPANY | CHAR | 30 |
1902 | 7 | Transaction Contact Bill To | TRNAME | CHAR | 30 |
1903 | 8 | Additional Address Unit Info | TRADDR1 | CHAR | 30 |
1904 | 9 | Bill To Street Address | TRADDR2 | CHAR | 30 |
1905 | 10 | Ancillary Billing Information | TRADDR3 | CHAR | 30 |
1906 | 11 | Transaction City Bill To | TRCITY | CHAR | 20 |
1907 | 12 | Transaction State Bill To | TRSTATE | CHAR | 2 |
1908 | 13 | Bill Cycle Close Date | CLOSEDATE | CHAR | 10 |
1909 | 14 | Bill Due Date | DUEDATE | CHAR | 10 |
1910 | 15 | Previous Balance | BALFWD | NUM* | 9 |
1911 | 16 | Pmt/CR Applied | CREDAPPLY | NUM* | 9 |
1912 | 17 | Total Current Charges | CURRENTCHG | NUM* | 9 |
1913 | 18 | Total Amt Due | TOTALDUE | NUM* | 9 |
1914 | 19 | Total Amt Due | AMTDUE | NUM* | 9 |
1915 | 20 | 30 Day Aging | AMT30 | NUM* | 9 |
1916 | 21 | 60 Day Aging | AMT60 | NUM* | 9 |
1917 | 22 | 90 Day Aging | AMT90 | NUM* | 9 |
1918 | 23 | Y/N | AGESWITCH | CHAR | 1 |
1919 | 24 | Remittance automation | SCANLINE | CHAR | 100 |
1920 | 25 | Total Taxes & Fees | TAXTOT | NUM* | 9 |
1921 | 26 | Customer Reference Number | CUSTREF | CHAR | 15 |
1922 | 27 | Federal Tax*** | FEDTAX | NUM* | 9 |
1923 | 28 | State Tax*** | STATETAX | NUM* | 9 |
1924 | 29 | Other Taxes & Fees*** | OTHERTAX | NUM* | 9 |
1925 +-------+-------------------------------+------------+------+-------+
1927 If I<format> is "billco", the fields of the detail CSV file are as follows:
1929 FORMAT FOR DETAIL FILE
1931 Field | Description | Name | Type | Width
1932 1 | N/A-Leave Empty | RC | CHAR | 2
1933 2 | N/A-Leave Empty | CUSTID | CHAR | 15
1934 3 | Account Number | TRACCTNUM | CHAR | 15
1935 4 | Invoice Number | TRINVOICE | CHAR | 15
1936 5 | Line Sequence (sort order) | LINESEQ | NUM | 6
1937 6 | Transaction Detail | DETAILS | CHAR | 100
1938 7 | Amount | AMT | NUM* | 9
1939 8 | Line Format Control** | LNCTRL | CHAR | 2
1940 9 | Grouping Code | GROUP | CHAR | 2
1941 10 | User Defined | ACCT CODE | CHAR | 15
1946 my($self, %opt) = @_;
1948 eval "use Text::CSV_XS";
1951 my $cust_main = $self->cust_main;
1953 my $csv = Text::CSV_XS->new({'always_quote'=>1});
1955 if ( lc($opt{'format'}) eq 'billco' ) {
1958 $taxtotal += $_->{'amount'} foreach $self->_items_tax;
1960 my $duedate = $self->due_date2str('%m/%d/%Y'); #date_format?
1962 my( $previous_balance, @unused ) = $self->previous; #previous balance
1964 my $pmt_cr_applied = 0;
1965 $pmt_cr_applied += $_->{'amount'}
1966 foreach ( $self->_items_payments, $self->_items_credits ) ;
1968 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
1971 '', # 1 | N/A-Leave Empty CHAR 2
1972 '', # 2 | N/A-Leave Empty CHAR 15
1973 $opt{'tracctnum'}, # 3 | Transaction Account No CHAR 15
1974 $self->invnum, # 4 | Transaction Invoice No CHAR 15
1975 $cust_main->zip, # 5 | Transaction Zip Code CHAR 5
1976 $cust_main->company, # 6 | Transaction Company Bill To CHAR 30
1977 #$cust_main->payname, # 7 | Transaction Contact Bill To CHAR 30
1978 $cust_main->contact, # 7 | Transaction Contact Bill To CHAR 30
1979 $cust_main->address2, # 8 | Additional Address Unit Info CHAR 30
1980 $cust_main->address1, # 9 | Bill To Street Address CHAR 30
1981 '', # 10 | Ancillary Billing Information CHAR 30
1982 $cust_main->city, # 11 | Transaction City Bill To CHAR 20
1983 $cust_main->state, # 12 | Transaction State Bill To CHAR 2
1986 time2str("%m/%d/%Y", $self->_date), # 13 | Bill Cycle Close Date CHAR 10
1989 $duedate, # 14 | Bill Due Date CHAR 10
1991 $previous_balance, # 15 | Previous Balance NUM* 9
1992 $pmt_cr_applied, # 16 | Pmt/CR Applied NUM* 9
1993 sprintf("%.2f", $self->charged), # 17 | Total Current Charges NUM* 9
1994 $totaldue, # 18 | Total Amt Due NUM* 9
1995 $totaldue, # 19 | Total Amt Due NUM* 9
1996 '', # 20 | 30 Day Aging NUM* 9
1997 '', # 21 | 60 Day Aging NUM* 9
1998 '', # 22 | 90 Day Aging NUM* 9
1999 'N', # 23 | Y/N CHAR 1
2000 '', # 24 | Remittance automation CHAR 100
2001 $taxtotal, # 25 | Total Taxes & Fees NUM* 9
2002 $self->custnum, # 26 | Customer Reference Number CHAR 15
2003 '0', # 27 | Federal Tax*** NUM* 9
2004 sprintf("%.2f", $taxtotal), # 28 | State Tax*** NUM* 9
2005 '0', # 29 | Other Taxes & Fees*** NUM* 9
2014 time2str("%x", $self->_date),
2015 sprintf("%.2f", $self->charged),
2016 ( map { $cust_main->getfield($_) }
2017 qw( first last company address1 address2 city state zip country ) ),
2019 ) or die "can't create csv";
2022 my $header = $csv->string. "\n";
2025 if ( lc($opt{'format'}) eq 'billco' ) {
2028 foreach my $item ( $self->_items_pkg ) {
2031 '', # 1 | N/A-Leave Empty CHAR 2
2032 '', # 2 | N/A-Leave Empty CHAR 15
2033 $opt{'tracctnum'}, # 3 | Account Number CHAR 15
2034 $self->invnum, # 4 | Invoice Number CHAR 15
2035 $lineseq++, # 5 | Line Sequence (sort order) NUM 6
2036 $item->{'description'}, # 6 | Transaction Detail CHAR 100
2037 $item->{'amount'}, # 7 | Amount NUM* 9
2038 '', # 8 | Line Format Control** CHAR 2
2039 '', # 9 | Grouping Code CHAR 2
2040 '', # 10 | User Defined CHAR 15
2043 $detail .= $csv->string. "\n";
2049 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2051 my($pkg, $setup, $recur, $sdate, $edate);
2052 if ( $cust_bill_pkg->pkgnum ) {
2054 ($pkg, $setup, $recur, $sdate, $edate) = (
2055 $cust_bill_pkg->part_pkg->pkg,
2056 ( $cust_bill_pkg->setup != 0
2057 ? sprintf("%.2f", $cust_bill_pkg->setup )
2059 ( $cust_bill_pkg->recur != 0
2060 ? sprintf("%.2f", $cust_bill_pkg->recur )
2062 ( $cust_bill_pkg->sdate
2063 ? time2str("%x", $cust_bill_pkg->sdate)
2065 ($cust_bill_pkg->edate
2066 ?time2str("%x", $cust_bill_pkg->edate)
2070 } else { #pkgnum tax
2071 next unless $cust_bill_pkg->setup != 0;
2072 $pkg = $cust_bill_pkg->desc;
2073 $setup = sprintf('%10.2f', $cust_bill_pkg->setup );
2074 ( $sdate, $edate ) = ( '', '' );
2080 ( map { '' } (1..11) ),
2081 ($pkg, $setup, $recur, $sdate, $edate)
2082 ) or die "can't create csv";
2084 $detail .= $csv->string. "\n";
2090 ( $header, $detail );
2096 Pays this invoice with a compliemntary payment. If there is an error,
2097 returns the error, otherwise returns false.
2103 my $cust_pay = new FS::cust_pay ( {
2104 'invnum' => $self->invnum,
2105 'paid' => $self->owed,
2108 'payinfo' => $self->cust_main->payinfo,
2116 Attempts to pay this invoice with a credit card payment via a
2117 Business::OnlinePayment realtime gateway. See
2118 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2119 for supported processors.
2125 $self->realtime_bop( 'CC', @_ );
2130 Attempts to pay this invoice with an electronic check (ACH) payment via a
2131 Business::OnlinePayment realtime gateway. See
2132 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2133 for supported processors.
2139 $self->realtime_bop( 'ECHECK', @_ );
2144 Attempts to pay this invoice with phone bill (LEC) payment via a
2145 Business::OnlinePayment realtime gateway. See
2146 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2147 for supported processors.
2153 $self->realtime_bop( 'LEC', @_ );
2157 my( $self, $method ) = (shift,shift);
2158 my $conf = $self->conf;
2161 my $cust_main = $self->cust_main;
2162 my $balance = $cust_main->balance;
2163 my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
2164 $amount = sprintf("%.2f", $amount);
2165 return "not run (balance $balance)" unless $amount > 0;
2167 my $description = 'Internet Services';
2168 if ( $conf->exists('business-onlinepayment-description') ) {
2169 my $dtempl = $conf->config('business-onlinepayment-description');
2171 my $agent_obj = $cust_main->agent
2172 or die "can't retreive agent for $cust_main (agentnum ".
2173 $cust_main->agentnum. ")";
2174 my $agent = $agent_obj->agent;
2175 my $pkgs = join(', ',
2176 map { $_->part_pkg->pkg }
2177 grep { $_->pkgnum } $self->cust_bill_pkg
2179 $description = eval qq("$dtempl");
2182 $cust_main->realtime_bop($method, $amount,
2183 'description' => $description,
2184 'invnum' => $self->invnum,
2185 #this didn't do what we want, it just calls apply_payments_and_credits
2187 'apply_to_invoice' => 1,
2190 #this changes application behavior: auto payments
2191 #triggered against a specific invoice are now applied
2192 #to that invoice instead of oldest open.
2198 =item batch_card OPTION => VALUE...
2200 Adds a payment for this invoice to the pending credit card batch (see
2201 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2202 runs the payment using a realtime gateway.
2207 my ($self, %options) = @_;
2208 my $cust_main = $self->cust_main;
2210 $options{invnum} = $self->invnum;
2212 $cust_main->batch_card(%options);
2215 sub _agent_template {
2217 $self->cust_main->agent_template;
2220 sub _agent_invoice_from {
2222 $self->cust_main->agent_invoice_from;
2225 =item print_text HASHREF | [ TIME [ , TEMPLATE [ , OPTION => VALUE ... ] ] ]
2227 Returns an text invoice, as a list of lines.
2229 Options can be passed as a hashref (recommended) or as a list of time, template
2230 and then any key/value pairs for any other options.
2232 I<time>, if specified, is used to control the printing of overdue messages. The
2233 default is now. It isn't the date of the invoice; that's the `_date' field.
2234 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2235 L<Time::Local> and L<Date::Parse> for conversion functions.
2237 I<template>, if specified, is the name of a suffix for alternate invoices.
2239 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
2245 my( $today, $template, %opt );
2247 %opt = %{ shift() };
2248 $today = delete($opt{'time'}) || '';
2249 $template = delete($opt{template}) || '';
2251 ( $today, $template, %opt ) = @_;
2254 my %params = ( 'format' => 'template' );
2255 $params{'time'} = $today if $today;
2256 $params{'template'} = $template if $template;
2257 $params{$_} = $opt{$_}
2258 foreach grep $opt{$_}, qw( unsquelch_cdr notice_name );
2260 $self->print_generic( %params );
2263 =item print_latex HASHREF | [ TIME [ , TEMPLATE [ , OPTION => VALUE ... ] ] ]
2265 Internal method - returns a filename of a filled-in LaTeX template for this
2266 invoice (Note: add ".tex" to get the actual filename), and a filename of
2267 an associated logo (with the .eps extension included).
2269 See print_ps and print_pdf for methods that return PostScript and PDF output.
2271 Options can be passed as a hashref (recommended) or as a list of time, template
2272 and then any key/value pairs for any other options.
2274 I<time>, if specified, is used to control the printing of overdue messages. The
2275 default is now. It isn't the date of the invoice; that's the `_date' field.
2276 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2277 L<Time::Local> and L<Date::Parse> for conversion functions.
2279 I<template>, if specified, is the name of a suffix for alternate invoices.
2281 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
2287 my $conf = $self->conf;
2288 my( $today, $template, %opt );
2290 %opt = %{ shift() };
2291 $today = delete($opt{'time'}) || '';
2292 $template = delete($opt{template}) || '';
2294 ( $today, $template, %opt ) = @_;
2297 my %params = ( 'format' => 'latex' );
2298 $params{'time'} = $today if $today;
2299 $params{'template'} = $template if $template;
2300 $params{$_} = $opt{$_}
2301 foreach grep $opt{$_}, qw( unsquelch_cdr notice_name );
2303 $template ||= $self->_agent_template;
2305 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2306 my $lh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
2310 ) or die "can't open temp file: $!\n";
2312 my $agentnum = $self->cust_main->agentnum;
2314 if ( $template && $conf->exists("logo_${template}.eps", $agentnum) ) {
2315 print $lh $conf->config_binary("logo_${template}.eps", $agentnum)
2316 or die "can't write temp file: $!\n";
2318 print $lh $conf->config_binary('logo.eps', $agentnum)
2319 or die "can't write temp file: $!\n";
2322 $params{'logo_file'} = $lh->filename;
2324 if($conf->exists('invoice-barcode')){
2325 my $png_file = $self->invoice_barcode($dir);
2326 my $eps_file = $png_file;
2327 $eps_file =~ s/\.png$/.eps/g;
2328 $png_file =~ /(barcode.*png)/;
2330 $eps_file =~ /(barcode.*eps)/;
2333 my $curr_dir = cwd();
2335 # after painfuly long experimentation, it was determined that sam2p won't
2336 # accept : and other chars in the path, no matter how hard I tried to
2337 # escape them, hence the chdir (and chdir back, just to be safe)
2338 system('sam2p', '-j:quiet', $png_file, 'EPS:', $eps_file ) == 0
2339 or die "sam2p failed: $!\n";
2343 $params{'barcode_file'} = $eps_file;
2346 my @filled_in = $self->print_generic( %params );
2348 my $fh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
2352 ) or die "can't open temp file: $!\n";
2353 binmode($fh, ':utf8'); # language support
2354 print $fh join('', @filled_in );
2357 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
2358 return ($1, $params{'logo_file'}, $params{'barcode_file'});
2362 =item invoice_barcode DIR_OR_FALSE
2364 Generates an invoice barcode PNG. If DIR_OR_FALSE is a true value,
2365 it is taken as the temp directory where the PNG file will be generated and the
2366 PNG file name is returned. Otherwise, the PNG image itself is returned.
2370 sub invoice_barcode {
2371 my ($self, $dir) = (shift,shift);
2373 my $gdbar = new GD::Barcode('Code39',$self->invnum);
2374 die "can't create barcode: " . $GD::Barcode::errStr unless $gdbar;
2375 my $gd = $gdbar->plot(Height => 30);
2378 my $bh = new File::Temp( TEMPLATE => 'barcode.'. $self->invnum. '.XXXXXXXX',
2382 ) or die "can't open temp file: $!\n";
2383 print $bh $gd->png or die "cannot write barcode to file: $!\n";
2384 my $png_file = $bh->filename;
2391 =item print_generic OPTION => VALUE ...
2393 Internal method - returns a filled-in template for this invoice as a scalar.
2395 See print_ps and print_pdf for methods that return PostScript and PDF output.
2397 Non optional options include
2398 format - latex, html, template
2400 Optional options include
2402 template - a value used as a suffix for a configuration template
2404 time - a value used to control the printing of overdue messages. The
2405 default is now. It isn't the date of the invoice; that's the `_date' field.
2406 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2407 L<Time::Local> and L<Date::Parse> for conversion functions.
2411 unsquelch_cdr - overrides any per customer cdr squelching when true
2413 notice_name - overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
2415 locale - override customer's locale
2419 #what's with all the sprintf('%10.2f')'s in here? will it cause any
2420 # (alignment in text invoice?) problems to change them all to '%.2f' ?
2421 # yes: fixed width/plain text printing will be borked
2423 my( $self, %params ) = @_;
2424 my $conf = $self->conf;
2425 my $today = $params{today} ? $params{today} : time;
2426 warn "$me print_generic called on $self with suffix $params{template}\n"
2429 my $format = $params{format};
2430 die "Unknown format: $format"
2431 unless $format =~ /^(latex|html|template)$/;
2433 my $cust_main = $self->cust_main;
2434 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
2435 unless $cust_main->payname
2436 && $cust_main->payby !~ /^(CARD|DCRD|CHEK|DCHK)$/;
2438 my %delimiters = ( 'latex' => [ '[@--', '--@]' ],
2439 'html' => [ '<%=', '%>' ],
2440 'template' => [ '{', '}' ],
2443 warn "$me print_generic creating template\n"
2446 #create the template
2447 my $template = $params{template} ? $params{template} : $self->_agent_template;
2448 my $templatefile = "invoice_$format";
2449 $templatefile .= "_$template"
2450 if length($template) && $conf->exists($templatefile."_$template");
2451 my @invoice_template = map "$_\n", $conf->config($templatefile)
2452 or die "cannot load config data $templatefile";
2455 if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
2456 #change this to a die when the old code is removed
2457 warn "old-style invoice template $templatefile; ".
2458 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
2459 $old_latex = 'true';
2460 @invoice_template = _translate_old_latex_format(@invoice_template);
2463 warn "$me print_generic creating T:T object\n"
2466 my $text_template = new Text::Template(
2468 SOURCE => \@invoice_template,
2469 DELIMITERS => $delimiters{$format},
2472 warn "$me print_generic compiling T:T object\n"
2475 $text_template->compile()
2476 or die "Can't compile $templatefile: $Text::Template::ERROR\n";
2479 # additional substitution could possibly cause breakage in existing templates
2480 my %convert_maps = (
2482 'notes' => sub { map "$_", @_ },
2483 'footer' => sub { map "$_", @_ },
2484 'smallfooter' => sub { map "$_", @_ },
2485 'returnaddress' => sub { map "$_", @_ },
2486 'coupon' => sub { map "$_", @_ },
2487 'summary' => sub { map "$_", @_ },
2493 s/%%(.*)$/<!-- $1 -->/g;
2494 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
2495 s/\\begin\{enumerate\}/<ol>/g;
2497 s/\\end\{enumerate\}/<\/ol>/g;
2498 s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
2507 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
2509 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
2514 s/\\\\\*?\s*$/<BR>/;
2515 s/\\hyphenation\{[\w\s\-]+}//;
2520 'coupon' => sub { "" },
2521 'summary' => sub { "" },
2528 s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
2529 s/\\begin\{enumerate\}//g;
2531 s/\\end\{enumerate\}//g;
2532 s/\\textbf\{(.*)\}/$1/g;
2539 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
2541 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
2546 s/\\\\\*?\s*$/\n/; # dubious
2547 s/\\hyphenation\{[\w\s\-]+}//;
2551 'coupon' => sub { "" },
2552 'summary' => sub { "" },
2557 # hashes for differing output formats
2558 my %nbsps = ( 'latex' => '~',
2559 'html' => '', # '&nbps;' would be nice
2560 'template' => '', # not used
2562 my $nbsp = $nbsps{$format};
2564 my %escape_functions = ( 'latex' => \&_latex_escape,
2565 'html' => \&_html_escape_nbsp,#\&encode_entities,
2566 'template' => sub { shift },
2568 my $escape_function = $escape_functions{$format};
2569 my $escape_function_nonbsp = ($format eq 'html')
2570 ? \&_html_escape : $escape_function;
2572 my %date_formats = ( 'latex' => $date_format_long,
2573 'html' => $date_format_long,
2576 $date_formats{'html'} =~ s/ / /g;
2578 my $date_format = $date_formats{$format};
2580 my %embolden_functions = ( 'latex' => sub { return '\textbf{'. shift(). '}'
2582 'html' => sub { return '<b>'. shift(). '</b>'
2584 'template' => sub { shift },
2586 my $embolden_function = $embolden_functions{$format};
2588 my %newline_tokens = ( 'latex' => '\\\\',
2592 my $newline_token = $newline_tokens{$format};
2594 warn "$me generating template variables\n"
2597 # generate template variables
2600 defined( $conf->config_orbase( "invoice_${format}returnaddress",
2604 && length( $conf->config_orbase( "invoice_${format}returnaddress",
2610 $returnaddress = join("\n",
2611 $conf->config_orbase("invoice_${format}returnaddress", $template)
2614 } elsif ( grep /\S/,
2615 $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
2617 my $convert_map = $convert_maps{$format}{'returnaddress'};
2620 &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
2625 } elsif ( grep /\S/, $conf->config('company_address', $self->cust_main->agentnum) ) {
2627 my $convert_map = $convert_maps{$format}{'returnaddress'};
2628 $returnaddress = join( "\n", &$convert_map(
2629 map { s/( {2,})/'~' x length($1)/eg;
2633 ( $conf->config('company_name', $self->cust_main->agentnum),
2634 $conf->config('company_address', $self->cust_main->agentnum),
2641 my $warning = "Couldn't find a return address; ".
2642 "do you need to set the company_address configuration value?";
2644 $returnaddress = $nbsp;
2645 #$returnaddress = $warning;
2649 warn "$me generating invoice data\n"
2652 my $agentnum = $self->cust_main->agentnum;
2654 my %invoice_data = (
2657 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
2658 'company_address' => join("\n", $conf->config('company_address', $agentnum) ). "\n",
2659 'company_phonenum'=> scalar( $conf->config('company_phonenum', $agentnum) ),
2660 'returnaddress' => $returnaddress,
2661 'agent' => &$escape_function($cust_main->agent->agent),
2664 'invnum' => $self->invnum,
2665 'date' => time2str($date_format, $self->_date),
2666 'today' => time2str($date_format_long, $today),
2667 'terms' => $self->terms,
2668 'template' => $template, #params{'template'},
2669 'notice_name' => ($params{'notice_name'} || 'Invoice'),#escape_function?
2670 'current_charges' => sprintf("%.2f", $self->charged),
2671 'duedate' => $self->due_date2str($rdate_format), #date_format?
2674 'custnum' => $cust_main->display_custnum,
2675 'agent_custid' => &$escape_function($cust_main->agent_custid),
2676 ( map { $_ => &$escape_function($cust_main->$_()) } qw(
2677 payname company address1 address2 city state zip fax
2681 'ship_enable' => $conf->exists('invoice-ship_address'),
2682 'unitprices' => $conf->exists('invoice-unitprice'),
2683 'smallernotes' => $conf->exists('invoice-smallernotes'),
2684 'smallerfooter' => $conf->exists('invoice-smallerfooter'),
2685 'balance_due_below_line' => $conf->exists('balance_due_below_line'),
2687 #layout info -- would be fancy to calc some of this and bury the template
2689 'topmargin' => scalar($conf->config('invoice_latextopmargin', $agentnum)),
2690 'headsep' => scalar($conf->config('invoice_latexheadsep', $agentnum)),
2691 'textheight' => scalar($conf->config('invoice_latextextheight', $agentnum)),
2692 'extracouponspace' => scalar($conf->config('invoice_latexextracouponspace', $agentnum)),
2693 'couponfootsep' => scalar($conf->config('invoice_latexcouponfootsep', $agentnum)),
2694 'verticalreturnaddress' => $conf->exists('invoice_latexverticalreturnaddress', $agentnum),
2695 'addresssep' => scalar($conf->config('invoice_latexaddresssep', $agentnum)),
2696 'amountenclosedsep' => scalar($conf->config('invoice_latexcouponamountenclosedsep', $agentnum)),
2697 'coupontoaddresssep' => scalar($conf->config('invoice_latexcoupontoaddresssep', $agentnum)),
2698 'addcompanytoaddress' => $conf->exists('invoice_latexcouponaddcompanytoaddress', $agentnum),
2700 # better hang on to conf_dir for a while (for old templates)
2701 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
2703 #these are only used when doing paged plaintext
2710 my $lh = FS::L10N->get_handle( $params{'locale'} || $cust_main->locale );
2711 $invoice_data{'emt'} = sub { &$escape_function($self->mt(@_)) };
2712 my %info = FS::Locales->locale_info($cust_main->locale || 'en_US');
2713 # eval to avoid death for unimplemented languages
2714 my $dh = eval { Date::Language->new($info{'name'}) } ||
2715 Date::Language->new(); # fall back to English
2716 # prototype here to silence warnings
2717 $invoice_data{'time2str'} = sub ($;$$) { $dh->time2str(@_) };
2718 # eventually use this date handle everywhere in here, too
2720 my $min_sdate = 999999999999;
2722 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2723 next unless $cust_bill_pkg->pkgnum > 0;
2724 $min_sdate = $cust_bill_pkg->sdate
2725 if length($cust_bill_pkg->sdate) && $cust_bill_pkg->sdate < $min_sdate;
2726 $max_edate = $cust_bill_pkg->edate
2727 if length($cust_bill_pkg->edate) && $cust_bill_pkg->edate > $max_edate;
2730 $invoice_data{'bill_period'} = '';
2731 $invoice_data{'bill_period'} = time2str('%e %h', $min_sdate)
2732 . " to " . time2str('%e %h', $max_edate)
2733 if ($max_edate != 0 && $min_sdate != 999999999999);
2735 $invoice_data{finance_section} = '';
2736 if ( $conf->config('finance_pkgclass') ) {
2738 qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
2739 $invoice_data{finance_section} = $pkg_class->categoryname;
2741 $invoice_data{finance_amount} = '0.00';
2742 $invoice_data{finance_section} ||= 'Finance Charges'; #avoid config confusion
2744 my $countrydefault = $conf->config('countrydefault') || 'US';
2745 my $prefix = $cust_main->has_ship_address ? 'ship_' : '';
2746 foreach ( qw( contact company address1 address2 city state zip country fax) ){
2747 my $method = $prefix.$_;
2748 $invoice_data{"ship_$_"} = _latex_escape($cust_main->$method);
2750 $invoice_data{'ship_country'} = ''
2751 if ( $invoice_data{'ship_country'} eq $countrydefault );
2753 $invoice_data{'cid'} = $params{'cid'}
2756 if ( $cust_main->country eq $countrydefault ) {
2757 $invoice_data{'country'} = '';
2759 $invoice_data{'country'} = &$escape_function(code2country($cust_main->country));
2763 $invoice_data{'address'} = \@address;
2765 $cust_main->payname.
2766 ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
2767 ? " (P.O. #". $cust_main->payinfo. ")"
2771 push @address, $cust_main->company
2772 if $cust_main->company;
2773 push @address, $cust_main->address1;
2774 push @address, $cust_main->address2
2775 if $cust_main->address2;
2777 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
2778 push @address, $invoice_data{'country'}
2779 if $invoice_data{'country'};
2781 while (scalar(@address) < 5);
2783 $invoice_data{'logo_file'} = $params{'logo_file'}
2784 if $params{'logo_file'};
2785 $invoice_data{'barcode_file'} = $params{'barcode_file'}
2786 if $params{'barcode_file'};
2787 $invoice_data{'barcode_img'} = $params{'barcode_img'}
2788 if $params{'barcode_img'};
2789 $invoice_data{'barcode_cid'} = $params{'barcode_cid'}
2790 if $params{'barcode_cid'};
2792 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2793 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
2794 #my $balance_due = $self->owed + $pr_total - $cr_total;
2795 my $balance_due = $self->owed + $pr_total;
2797 # the customer's current balance as shown on the invoice before this one
2798 $invoice_data{'true_previous_balance'} = sprintf("%.2f", ($self->previous_balance || 0) );
2800 # the change in balance from that invoice to this one
2801 $invoice_data{'balance_adjustments'} = sprintf("%.2f", ($self->previous_balance || 0) - ($self->billing_balance || 0) );
2803 # the sum of amount owed on all previous invoices
2804 $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
2806 # the sum of amount owed on all invoices
2807 $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
2809 # info from customer's last invoice before this one, for some
2811 $invoice_data{'last_bill'} = {};
2812 my $last_bill = $pr_cust_bill[-1];
2814 $invoice_data{'last_bill'} = {
2815 '_date' => $last_bill->_date, #unformatted
2816 # all we need for now
2820 my $summarypage = '';
2821 if ( $conf->exists('invoice_usesummary', $agentnum) ) {
2824 $invoice_data{'summarypage'} = $summarypage;
2826 warn "$me substituting variables in notes, footer, smallfooter\n"
2829 my @include = (qw( notes footer smallfooter ));
2830 push @include, 'coupon' unless $params{'no_coupon'};
2831 foreach my $include (@include) {
2833 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
2836 if ( $conf->exists($inc_file, $agentnum)
2837 && length( $conf->config($inc_file, $agentnum) ) ) {
2839 @inc_src = $conf->config($inc_file, $agentnum);
2843 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
2845 my $convert_map = $convert_maps{$format}{$include};
2847 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
2848 s/--\@\]/$delimiters{$format}[1]/g;
2851 &$convert_map( $conf->config($inc_file, $agentnum) );
2855 my $inc_tt = new Text::Template (
2857 SOURCE => [ map "$_\n", @inc_src ],
2858 DELIMITERS => $delimiters{$format},
2859 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
2861 unless ( $inc_tt->compile() ) {
2862 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
2863 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
2867 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
2869 $invoice_data{$include} =~ s/\n+$//
2870 if ($format eq 'latex');
2873 # let invoices use either of these as needed
2874 $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
2875 ? $cust_main->payinfo : '';
2876 $invoice_data{'po_line'} =
2877 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
2878 ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
2881 my %money_chars = ( 'latex' => '',
2882 'html' => $conf->config('money_char') || '$',
2885 my $money_char = $money_chars{$format};
2887 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
2888 'html' => $conf->config('money_char') || '$',
2891 my $other_money_char = $other_money_chars{$format};
2892 $invoice_data{'dollar'} = $other_money_char;
2894 my @detail_items = ();
2895 my @total_items = ();
2899 $invoice_data{'detail_items'} = \@detail_items;
2900 $invoice_data{'total_items'} = \@total_items;
2901 $invoice_data{'buf'} = \@buf;
2902 $invoice_data{'sections'} = \@sections;
2904 warn "$me generating sections\n"
2907 my $previous_section = { 'description' => $self->mt('Previous Charges'),
2908 'subtotal' => $other_money_char.
2909 sprintf('%.2f', $pr_total),
2910 'summarized' => '', #why? $summarypage ? 'Y' : '',
2912 $previous_section->{posttotal} = '0 / 30 / 60 / 90 days overdue '.
2913 join(' / ', map { $cust_main->balance_date_range(@$_) }
2914 $self->_prior_month30s
2916 if $conf->exists('invoice_include_aging');
2919 my $tax_section = { 'description' => $self->mt('Taxes, Surcharges, and Fees'),
2920 'subtotal' => $taxtotal, # adjusted below
2922 my $tax_weight = _pkg_category($tax_section->{description})
2923 ? _pkg_category($tax_section->{description})->weight
2925 $tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
2926 $tax_section->{'sort_weight'} = $tax_weight;
2929 my $adjusttotal = 0;
2930 my $adjust_section = { 'description' =>
2931 $self->mt('Credits, Payments, and Adjustments'),
2932 'subtotal' => 0, # adjusted below
2934 my $adjust_weight = _pkg_category($adjust_section->{description})
2935 ? _pkg_category($adjust_section->{description})->weight
2937 $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
2938 $adjust_section->{'sort_weight'} = $adjust_weight;
2940 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
2941 my $multisection = $conf->exists('invoice_sections', $cust_main->agentnum);
2942 $invoice_data{'multisection'} = $multisection;
2943 my $late_sections = [];
2944 my $extra_sections = [];
2945 my $extra_lines = ();
2946 if ( $multisection ) {
2947 ($extra_sections, $extra_lines) =
2948 $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
2949 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum);
2951 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
2953 push @detail_items, @$extra_lines if $extra_lines;
2955 $self->_items_sections( $late_sections, # this could stand a refactor
2957 $escape_function_nonbsp,
2961 if ($conf->exists('svc_phone_sections')) {
2962 my ($phone_sections, $phone_lines) =
2963 $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
2964 push @{$late_sections}, @$phone_sections;
2965 push @detail_items, @$phone_lines;
2967 if ($conf->exists('voip-cust_accountcode_cdr') && $cust_main->accountcode_cdr) {
2968 my ($accountcode_section, $accountcode_lines) =
2969 $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
2970 if ( scalar(@$accountcode_lines) ) {
2971 push @{$late_sections}, $accountcode_section;
2972 push @detail_items, @$accountcode_lines;
2975 } else {# not multisection
2976 # make a default section
2977 push @sections, { 'description' => '', 'subtotal' => '',
2978 'no_subtotal' => 1 };
2979 # and calculate the finance charge total, since it won't get done otherwise.
2980 # XXX possibly other totals?
2981 # XXX possibly finance_pkgclass should not be used in this manner?
2982 if ( $conf->exists('finance_pkgclass') ) {
2983 my @finance_charges;
2984 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2985 if ( grep { $_->section eq $invoice_data{finance_section} }
2986 $cust_bill_pkg->cust_bill_pkg_display ) {
2987 # I think these are always setup fees, but just to be sure...
2988 push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
2991 $invoice_data{finance_amount} =
2992 sprintf('%.2f', sum( @finance_charges ) || 0);
2996 unless ( $conf->exists('disable_previous_balance')
2997 || $conf->exists('previous_balance-summary_only')
3001 warn "$me adding previous balances\n"
3004 foreach my $line_item ( $self->_items_previous ) {
3007 ext_description => [],
3009 $detail->{'ref'} = $line_item->{'pkgnum'};
3010 $detail->{'quantity'} = 1;
3011 $detail->{'section'} = $previous_section;
3012 $detail->{'description'} = &$escape_function($line_item->{'description'});
3013 if ( exists $line_item->{'ext_description'} ) {
3014 @{$detail->{'ext_description'}} = map {
3015 &$escape_function($_);
3016 } @{$line_item->{'ext_description'}};
3018 $detail->{'amount'} = ( $old_latex ? '' : $money_char).
3019 $line_item->{'amount'};
3020 $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
3022 push @detail_items, $detail;
3023 push @buf, [ $detail->{'description'},
3024 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
3030 if ( @pr_cust_bill && !$conf->exists('disable_previous_balance') ) {
3031 push @buf, ['','-----------'];
3032 push @buf, [ $self->mt('Total Previous Balance'),
3033 $money_char. sprintf("%10.2f", $pr_total) ];
3037 if ( $conf->exists('svc_phone-did-summary') ) {
3038 warn "$me adding DID summary\n"
3041 my ($didsummary,$minutes) = $self->_did_summary;
3042 my $didsummary_desc = 'DID Activity Summary (since last invoice)';
3044 { 'description' => $didsummary_desc,
3045 'ext_description' => [ $didsummary, $minutes ],
3049 foreach my $section (@sections, @$late_sections) {
3051 warn "$me adding section \n". Dumper($section)
3054 # begin some normalization
3055 $section->{'subtotal'} = $section->{'amount'}
3057 && !exists($section->{subtotal})
3058 && exists($section->{amount});
3060 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
3061 if ( $invoice_data{finance_section} &&
3062 $section->{'description'} eq $invoice_data{finance_section} );
3064 $section->{'subtotal'} = $other_money_char.
3065 sprintf('%.2f', $section->{'subtotal'})
3068 # continue some normalization
3069 $section->{'amount'} = $section->{'subtotal'}
3073 if ( $section->{'description'} ) {
3074 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
3079 warn "$me setting options\n"
3082 my $multilocation = scalar($cust_main->cust_location); #too expensive?
3084 $options{'section'} = $section if $multisection;
3085 $options{'format'} = $format;
3086 $options{'escape_function'} = $escape_function;
3087 $options{'no_usage'} = 1 unless $unsquelched;
3088 $options{'unsquelched'} = $unsquelched;
3089 $options{'summary_page'} = $summarypage;
3090 $options{'skip_usage'} =
3091 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
3092 $options{'multilocation'} = $multilocation;
3093 $options{'multisection'} = $multisection;
3095 warn "$me searching for line items\n"
3098 foreach my $line_item ( $self->_items_pkg(%options) ) {
3100 warn "$me adding line item $line_item\n"
3104 ext_description => [],
3106 $detail->{'ref'} = $line_item->{'pkgnum'};
3107 $detail->{'quantity'} = $line_item->{'quantity'};
3108 $detail->{'section'} = $section;
3109 $detail->{'description'} = &$escape_function($line_item->{'description'});
3110 if ( exists $line_item->{'ext_description'} ) {
3111 @{$detail->{'ext_description'}} = @{$line_item->{'ext_description'}};
3113 $detail->{'amount'} = ( $old_latex ? '' : $money_char ).
3114 $line_item->{'amount'};
3115 $detail->{'unit_amount'} = ( $old_latex ? '' : $money_char ).
3116 $line_item->{'unit_amount'};
3117 $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
3119 $detail->{'sdate'} = $line_item->{'sdate'};
3120 $detail->{'edate'} = $line_item->{'edate'};
3121 $detail->{'seconds'} = $line_item->{'seconds'};
3123 push @detail_items, $detail;
3124 push @buf, ( [ $detail->{'description'},
3125 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
3127 map { [ " ". $_, '' ] } @{$detail->{'ext_description'}},
3131 if ( $section->{'description'} ) {
3132 push @buf, ( ['','-----------'],
3133 [ $section->{'description'}. ' sub-total',
3134 $section->{'subtotal'} # already formatted this
3143 $invoice_data{current_less_finance} =
3144 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
3146 if ( $multisection && !$conf->exists('disable_previous_balance')
3147 || $conf->exists('previous_balance-summary_only') )
3149 unshift @sections, $previous_section if $pr_total;
3152 warn "$me adding taxes\n"
3155 foreach my $tax ( $self->_items_tax ) {
3157 $taxtotal += $tax->{'amount'};
3159 my $description = &$escape_function( $tax->{'description'} );
3160 my $amount = sprintf( '%.2f', $tax->{'amount'} );
3162 if ( $multisection ) {
3164 my $money = $old_latex ? '' : $money_char;
3165 push @detail_items, {
3166 ext_description => [],
3169 description => $description,
3170 amount => $money. $amount,
3172 section => $tax_section,
3177 push @total_items, {
3178 'total_item' => $description,
3179 'total_amount' => $other_money_char. $amount,
3184 push @buf,[ $description,
3185 $money_char. $amount,
3192 $total->{'total_item'} = $self->mt('Sub-total');
3193 $total->{'total_amount'} =
3194 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
3196 if ( $multisection ) {
3197 $tax_section->{'subtotal'} = $other_money_char.
3198 sprintf('%.2f', $taxtotal);
3199 $tax_section->{'pretotal'} = 'New charges sub-total '.
3200 $total->{'total_amount'};
3201 push @sections, $tax_section if $taxtotal;
3203 unshift @total_items, $total;
3206 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
3208 push @buf,['','-----------'];
3209 push @buf,[$self->mt(
3210 $conf->exists('disable_previous_balance')
3212 : 'Total New Charges'
3214 $money_char. sprintf("%10.2f",$self->charged) ];
3220 $item = $conf->config('previous_balance-exclude_from_total')
3221 || 'Total New Charges'
3222 if $conf->exists('previous_balance-exclude_from_total');
3223 my $amount = $self->charged +
3224 ( $conf->exists('disable_previous_balance') ||
3225 $conf->exists('previous_balance-exclude_from_total')
3229 $total->{'total_item'} = &$embolden_function($self->mt($item));
3230 $total->{'total_amount'} =
3231 &$embolden_function( $other_money_char. sprintf( '%.2f', $amount ) );
3232 if ( $multisection ) {
3233 if ( $adjust_section->{'sort_weight'} ) {
3234 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
3235 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
3237 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
3238 $other_money_char. sprintf('%.2f', $self->charged );
3241 push @total_items, $total;
3243 push @buf,['','-----------'];
3246 sprintf( '%10.2f', $amount )
3251 unless ( $conf->exists('disable_previous_balance') ) {
3252 #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
3255 my $credittotal = 0;
3256 foreach my $credit ( $self->_items_credits('trim_len'=>60) ) {
3259 $total->{'total_item'} = &$escape_function($credit->{'description'});
3260 $credittotal += $credit->{'amount'};
3261 $total->{'total_amount'} = '-'. $other_money_char. $credit->{'amount'};
3262 $adjusttotal += $credit->{'amount'};
3263 if ( $multisection ) {
3264 my $money = $old_latex ? '' : $money_char;
3265 push @detail_items, {
3266 ext_description => [],
3269 description => &$escape_function($credit->{'description'}),
3270 amount => $money. $credit->{'amount'},
3272 section => $adjust_section,
3275 push @total_items, $total;
3279 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
3282 foreach my $credit ( $self->_items_credits('trim_len'=>32) ) {
3283 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
3287 my $paymenttotal = 0;
3288 foreach my $payment ( $self->_items_payments ) {
3290 $total->{'total_item'} = &$escape_function($payment->{'description'});
3291 $paymenttotal += $payment->{'amount'};
3292 $total->{'total_amount'} = '-'. $other_money_char. $payment->{'amount'};
3293 $adjusttotal += $payment->{'amount'};
3294 if ( $multisection ) {
3295 my $money = $old_latex ? '' : $money_char;
3296 push @detail_items, {
3297 ext_description => [],
3300 description => &$escape_function($payment->{'description'}),
3301 amount => $money. $payment->{'amount'},
3303 section => $adjust_section,
3306 push @total_items, $total;
3308 push @buf, [ $payment->{'description'},
3309 $money_char. sprintf("%10.2f", $payment->{'amount'}),
3312 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
3314 if ( $multisection ) {
3315 $adjust_section->{'subtotal'} = $other_money_char.
3316 sprintf('%.2f', $adjusttotal);
3317 push @sections, $adjust_section
3318 unless $adjust_section->{sort_weight};
3321 # create Balance Due message
3324 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
3325 $total->{'total_amount'} =
3326 &$embolden_function(
3327 $other_money_char. sprintf('%.2f', $summarypage
3329 $self->billing_balance
3330 : $self->owed + $pr_total
3333 if ( $multisection && !$adjust_section->{sort_weight} ) {
3334 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
3335 $total->{'total_amount'};
3337 push @total_items, $total;
3339 push @buf,['','-----------'];
3340 push @buf,[$self->balance_due_msg, $money_char.
3341 sprintf("%10.2f", $balance_due ) ];
3344 if ( $conf->exists('previous_balance-show_credit')
3345 and $cust_main->balance < 0 ) {
3346 my $credit_total = {
3347 'total_item' => &$embolden_function($self->credit_balance_msg),
3348 'total_amount' => &$embolden_function(
3349 $other_money_char. sprintf('%.2f', -$cust_main->balance)
3352 if ( $multisection ) {
3353 $adjust_section->{'posttotal'} .= $newline_token .
3354 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
3357 push @total_items, $credit_total;
3359 push @buf,['','-----------'];
3360 push @buf,[$self->credit_balance_msg, $money_char.
3361 sprintf("%10.2f", -$cust_main->balance ) ];
3365 if ( $multisection ) {
3366 if ($conf->exists('svc_phone_sections')) {
3368 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
3369 $total->{'total_amount'} =
3370 &$embolden_function(
3371 $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
3373 my $last_section = pop @sections;
3374 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
3375 $total->{'total_amount'};
3376 push @sections, $last_section;
3378 push @sections, @$late_sections
3382 # make a discounts-available section, even without multisection
3383 if ( $conf->exists('discount-show_available')
3384 and my @discounts_avail = $self->_items_discounts_avail ) {
3385 my $discount_section = {
3386 'description' => $self->mt('Discounts Available'),
3391 push @sections, $discount_section;
3392 push @detail_items, map { +{
3393 'ref' => '', #should this be something else?
3394 'section' => $discount_section,
3395 'description' => &$escape_function( $_->{description} ),
3396 'amount' => $money_char . &$escape_function( $_->{amount} ),
3397 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
3398 } } @discounts_avail;
3401 # All sections and items are built; now fill in templates.
3402 my @includelist = ();
3403 push @includelist, 'summary' if $summarypage;
3404 foreach my $include ( @includelist ) {
3406 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
3409 if ( length( $conf->config($inc_file, $agentnum) ) ) {
3411 @inc_src = $conf->config($inc_file, $agentnum);
3415 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
3417 my $convert_map = $convert_maps{$format}{$include};
3419 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
3420 s/--\@\]/$delimiters{$format}[1]/g;
3423 &$convert_map( $conf->config($inc_file, $agentnum) );
3427 my $inc_tt = new Text::Template (
3429 SOURCE => [ map "$_\n", @inc_src ],
3430 DELIMITERS => $delimiters{$format},
3431 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
3433 unless ( $inc_tt->compile() ) {
3434 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
3435 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
3439 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
3441 $invoice_data{$include} =~ s/\n+$//
3442 if ($format eq 'latex');
3447 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
3448 /invoice_lines\((\d*)\)/;
3449 $invoice_lines += $1 || scalar(@buf);
3452 die "no invoice_lines() functions in template?"
3453 if ( $format eq 'template' && !$wasfunc );
3455 if ($format eq 'template') {
3457 if ( $invoice_lines ) {
3458 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
3459 $invoice_data{'total_pages'}++
3460 if scalar(@buf) % $invoice_lines;
3463 #setup subroutine for the template
3464 $invoice_data{invoice_lines} = sub {
3465 my $lines = shift || scalar(@buf);
3477 push @collect, split("\n",
3478 $text_template->fill_in( HASH => \%invoice_data )
3480 $invoice_data{'page'}++;
3482 map "$_\n", @collect;
3484 # this is where we actually create the invoice
3485 warn "filling in template for invoice ". $self->invnum. "\n"
3487 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
3490 $text_template->fill_in(HASH => \%invoice_data);
3494 # helper routine for generating date ranges
3495 sub _prior_month30s {
3498 [ 1, 2592000 ], # 0-30 days ago
3499 [ 2592000, 5184000 ], # 30-60 days ago
3500 [ 5184000, 7776000 ], # 60-90 days ago
3501 [ 7776000, 0 ], # 90+ days ago
3504 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
3505 $_->[1] ? $self->_date - $_->[1] - 1 : '',
3510 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
3512 Returns an postscript invoice, as a scalar.
3514 Options can be passed as a hashref (recommended) or as a list of time, template
3515 and then any key/value pairs for any other options.
3517 I<time> an optional value used to control the printing of overdue messages. The
3518 default is now. It isn't the date of the invoice; that's the `_date' field.
3519 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3520 L<Time::Local> and L<Date::Parse> for conversion functions.
3522 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
3529 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
3530 my $ps = generate_ps($file);
3532 unlink($barcodefile) if $barcodefile;
3537 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
3539 Returns an PDF invoice, as a scalar.
3541 Options can be passed as a hashref (recommended) or as a list of time, template
3542 and then any key/value pairs for any other options.
3544 I<time> an optional value used to control the printing of overdue messages. The
3545 default is now. It isn't the date of the invoice; that's the `_date' field.
3546 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3547 L<Time::Local> and L<Date::Parse> for conversion functions.
3549 I<template>, if specified, is the name of a suffix for alternate invoices.
3551 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
3558 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
3559 my $pdf = generate_pdf($file);
3561 unlink($barcodefile) if $barcodefile;
3566 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
3568 Returns an HTML invoice, as a scalar.
3570 I<time> an optional value used to control the printing of overdue messages. The
3571 default is now. It isn't the date of the invoice; that's the `_date' field.
3572 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3573 L<Time::Local> and L<Date::Parse> for conversion functions.
3575 I<template>, if specified, is the name of a suffix for alternate invoices.
3577 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
3579 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
3580 when emailing the invoice as part of a multipart/related MIME email.
3588 %params = %{ shift() };
3590 $params{'time'} = shift;
3591 $params{'template'} = shift;
3592 $params{'cid'} = shift;
3595 $params{'format'} = 'html';
3597 $self->print_generic( %params );
3600 # quick subroutine for print_latex
3602 # There are ten characters that LaTeX treats as special characters, which
3603 # means that they do not simply typeset themselves:
3604 # # $ % & ~ _ ^ \ { }
3606 # TeX ignores blanks following an escaped character; if you want a blank (as
3607 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
3611 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
3612 $value =~ s/([<>])/\$$1\$/g;
3618 encode_entities($value);
3622 sub _html_escape_nbsp {
3623 my $value = _html_escape(shift);
3624 $value =~ s/ +/ /g;
3628 #utility methods for print_*
3630 sub _translate_old_latex_format {
3631 warn "_translate_old_latex_format called\n"
3638 if ( $line =~ /^%%Detail\s*$/ ) {
3640 push @template, q![@--!,
3641 q! foreach my $_tr_line (@detail_items) {!,
3642 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
3643 q! $_tr_line->{'description'} .= !,
3644 q! "\\tabularnewline\n~~".!,
3645 q! join( "\\tabularnewline\n~~",!,
3646 q! @{$_tr_line->{'ext_description'}}!,
3650 while ( ( my $line_item_line = shift )
3651 !~ /^%%EndDetail\s*$/ ) {
3652 $line_item_line =~ s/'/\\'/g; # nice LTS
3653 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
3654 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
3655 push @template, " \$OUT .= '$line_item_line';";
3658 push @template, '}',
3661 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
3663 push @template, '[@--',
3664 ' foreach my $_tr_line (@total_items) {';
3666 while ( ( my $total_item_line = shift )
3667 !~ /^%%EndTotalDetails\s*$/ ) {
3668 $total_item_line =~ s/'/\\'/g; # nice LTS
3669 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
3670 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
3671 push @template, " \$OUT .= '$total_item_line';";
3674 push @template, '}',
3678 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
3679 push @template, $line;
3685 warn "$_\n" foreach @template;
3693 my $conf = $self->conf;
3695 #check for an invoice-specific override
3696 return $self->invoice_terms if $self->invoice_terms;
3698 #check for a customer- specific override
3699 my $cust_main = $self->cust_main;
3700 return $cust_main->invoice_terms if $cust_main->invoice_terms;
3702 #use configured default
3703 $conf->config('invoice_default_terms') || '';
3709 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
3710 $duedate = $self->_date() + ( $1 * 86400 );
3717 $self->due_date ? time2str(shift, $self->due_date) : '';
3720 sub balance_due_msg {
3722 my $msg = $self->mt('Balance Due');
3723 return $msg unless $self->terms;
3724 if ( $self->due_date ) {
3725 $msg .= ' - ' . $self->mt('Please pay by'). ' '.
3726 $self->due_date2str($date_format);
3727 } elsif ( $self->terms ) {
3728 $msg .= ' - '. $self->terms;
3733 sub balance_due_date {
3735 my $conf = $self->conf;
3737 if ( $conf->exists('invoice_default_terms')
3738 && $conf->config('invoice_default_terms')=~ /^\s*Net\s*(\d+)\s*$/ ) {
3739 $duedate = time2str($rdate_format, $self->_date + ($1*86400) );
3744 sub credit_balance_msg {
3746 $self->mt('Credit Balance Remaining')
3749 =item invnum_date_pretty
3751 Returns a string with the invoice number and date, for example:
3752 "Invoice #54 (3/20/2008)"
3756 sub invnum_date_pretty {
3758 $self->mt('Invoice #'). $self->invnum. ' ('. $self->_date_pretty. ')';
3763 Returns a string with the date, for example: "3/20/2008"
3769 time2str($date_format, $self->_date);
3772 =item _items_sections LATE SUMMARYPAGE ESCAPE EXTRA_SECTIONS FORMAT
3774 Generate section information for all items appearing on this invoice.
3775 This will only be called for multi-section invoices.
3777 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
3778 related display records (L<FS::cust_bill_pkg_display>) and organize
3779 them into two groups ("early" and "late" according to whether they come
3780 before or after the total), then into sections. A subtotal is calculated
3783 Section descriptions are returned in sort weight order. Each consists
3784 of a hash containing:
3786 description: the package category name, escaped
3787 subtotal: the total charges in that section
3788 tax_section: a flag indicating that the section contains only tax charges
3789 summarized: same as tax_section, for some reason
3790 sort_weight: the package category's sort weight
3792 If 'condense' is set on the display record, it also contains everything
3793 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
3794 coderefs to generate parts of the invoice. This is not advised.
3798 LATE: an arrayref to push the "late" section hashes onto. The "early"
3799 group is simply returned from the method.
3801 SUMMARYPAGE: a flag indicating whether this is a summary-format invoice.
3802 Turning this on has the following effects:
3803 - Ignores display items with the 'summary' flag.
3804 - Combines all items into the "early" group.
3805 - Creates sections for all non-disabled package categories, even if they
3806 have no charges on this invoice, as well as a section with no name.
3808 ESCAPE: an escape function to use for section titles.
3810 EXTRA_SECTIONS: an arrayref of additional sections to return after the
3811 sorted list. If there are any of these, section subtotals exclude
3814 FORMAT: 'latex', 'html', or 'template' (i.e. text). Not used, but
3815 passed through to C<_condense_section()>.
3819 use vars qw(%pkg_category_cache);
3820 sub _items_sections {
3823 my $summarypage = shift;
3825 my $extra_sections = shift;
3829 my %late_subtotal = ();
3832 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
3835 my $usage = $cust_bill_pkg->usage;
3837 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
3838 next if ( $display->summary && $summarypage );
3840 my $section = $display->section;
3841 my $type = $display->type;
3843 $not_tax{$section} = 1
3844 unless $cust_bill_pkg->pkgnum == 0;
3846 if ( $display->post_total && !$summarypage ) {
3847 if (! $type || $type eq 'S') {
3848 $late_subtotal{$section} += $cust_bill_pkg->setup
3849 if $cust_bill_pkg->setup != 0;
3853 $late_subtotal{$section} += $cust_bill_pkg->recur
3854 if $cust_bill_pkg->recur != 0;
3857 if ($type && $type eq 'R') {
3858 $late_subtotal{$section} += $cust_bill_pkg->recur - $usage
3859 if $cust_bill_pkg->recur != 0;
3862 if ($type && $type eq 'U') {
3863 $late_subtotal{$section} += $usage
3864 unless scalar(@$extra_sections);
3869 next if $cust_bill_pkg->pkgnum == 0 && ! $section;
3871 if (! $type || $type eq 'S') {
3872 $subtotal{$section} += $cust_bill_pkg->setup
3873 if $cust_bill_pkg->setup != 0;
3877 $subtotal{$section} += $cust_bill_pkg->recur
3878 if $cust_bill_pkg->recur != 0;
3881 if ($type && $type eq 'R') {
3882 $subtotal{$section} += $cust_bill_pkg->recur - $usage
3883 if $cust_bill_pkg->recur != 0;
3886 if ($type && $type eq 'U') {
3887 $subtotal{$section} += $usage
3888 unless scalar(@$extra_sections);
3897 %pkg_category_cache = ();
3899 push @$late, map { { 'description' => &{$escape}($_),
3900 'subtotal' => $late_subtotal{$_},
3902 'sort_weight' => ( _pkg_category($_)
3903 ? _pkg_category($_)->weight
3906 ((_pkg_category($_) && _pkg_category($_)->condense)
3907 ? $self->_condense_section($format)
3911 sort _sectionsort keys %late_subtotal;
3914 if ( $summarypage ) {
3915 @sections = grep { exists($subtotal{$_}) || ! _pkg_category($_)->disabled }
3916 map { $_->categoryname } qsearch('pkg_category', {});
3917 push @sections, '' if exists($subtotal{''});
3919 @sections = keys %subtotal;
3922 my @early = map { { 'description' => &{$escape}($_),
3923 'subtotal' => $subtotal{$_},
3924 'summarized' => $not_tax{$_} ? '' : 'Y',
3925 'tax_section' => $not_tax{$_} ? '' : 'Y',
3926 'sort_weight' => ( _pkg_category($_)
3927 ? _pkg_category($_)->weight
3930 ((_pkg_category($_) && _pkg_category($_)->condense)
3931 ? $self->_condense_section($format)
3936 push @early, @$extra_sections if $extra_sections;
3938 sort { $a->{sort_weight} <=> $b->{sort_weight} } @early;
3942 #helper subs for above
3945 _pkg_category($a)->weight <=> _pkg_category($b)->weight;
3949 my $categoryname = shift;
3950 $pkg_category_cache{$categoryname} ||=
3951 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
3954 my %condensed_format = (
3955 'label' => [ qw( Description Qty Amount ) ],
3957 sub { shift->{description} },
3958 sub { shift->{quantity} },
3959 sub { my($href, %opt) = @_;
3960 ($opt{dollar} || ''). $href->{amount};
3963 'align' => [ qw( l r r ) ],
3964 'span' => [ qw( 5 1 1 ) ], # unitprices?
3965 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
3968 sub _condense_section {
3969 my ( $self, $format ) = ( shift, shift );
3971 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
3972 qw( description_generator
3975 total_line_generator
3980 sub _condensed_generator_defaults {
3981 my ( $self, $format ) = ( shift, shift );
3982 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
3991 sub _condensed_header_generator {
3992 my ( $self, $format ) = ( shift, shift );
3994 my ( $f, $prefix, $suffix, $separator, $column ) =
3995 _condensed_generator_defaults($format);
3997 if ($format eq 'latex') {
3998 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
3999 $suffix = "\\\\\n\\hline";
4002 sub { my ($d,$a,$s,$w) = @_;
4003 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
4005 } elsif ( $format eq 'html' ) {
4006 $prefix = '<th></th>';
4010 sub { my ($d,$a,$s,$w) = @_;
4011 return qq!<th align="$html_align{$a}">$d</th>!;
4019 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
4021 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
4024 $prefix. join($separator, @result). $suffix;
4029 sub _condensed_description_generator {
4030 my ( $self, $format ) = ( shift, shift );
4032 my ( $f, $prefix, $suffix, $separator, $column ) =
4033 _condensed_generator_defaults($format);
4035 my $money_char = '$';
4036 if ($format eq 'latex') {
4037 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
4039 $separator = " & \n";
4041 sub { my ($d,$a,$s,$w) = @_;
4042 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
4044 $money_char = '\\dollar';
4045 }elsif ( $format eq 'html' ) {
4046 $prefix = '"><td align="center"></td>';
4050 sub { my ($d,$a,$s,$w) = @_;
4051 return qq!<td align="$html_align{$a}">$d</td>!;
4053 #$money_char = $conf->config('money_char') || '$';
4054 $money_char = ''; # this is madness
4062 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
4064 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
4066 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
4067 map { $f->{$_}->[$i] } qw(align span width)
4071 $prefix. join( $separator, @result ). $suffix;
4076 sub _condensed_total_generator {
4077 my ( $self, $format ) = ( shift, shift );
4079 my ( $f, $prefix, $suffix, $separator, $column ) =
4080 _condensed_generator_defaults($format);
4083 if ($format eq 'latex') {
4086 $separator = " & \n";
4088 sub { my ($d,$a,$s,$w) = @_;
4089 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
4091 }elsif ( $format eq 'html' ) {
4095 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
4097 sub { my ($d,$a,$s,$w) = @_;
4098 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
4107 # my $r = &{$f->{fields}->[$i]}(@args);
4108 # $r .= ' Total' unless $i;
4110 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
4112 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
4113 map { $f->{$_}->[$i] } qw(align span width)
4117 $prefix. join( $separator, @result ). $suffix;
4122 =item total_line_generator FORMAT
4124 Returns a coderef used for generation of invoice total line items for this
4125 usage_class. FORMAT is either html or latex
4129 # should not be used: will have issues with hash element names (description vs
4130 # total_item and amount vs total_amount -- another array of functions?
4132 sub _condensed_total_line_generator {
4133 my ( $self, $format ) = ( shift, shift );
4135 my ( $f, $prefix, $suffix, $separator, $column ) =
4136 _condensed_generator_defaults($format);
4139 if ($format eq 'latex') {
4142 $separator = " & \n";
4144 sub { my ($d,$a,$s,$w) = @_;
4145 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
4147 }elsif ( $format eq 'html' ) {
4151 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
4153 sub { my ($d,$a,$s,$w) = @_;
4154 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
4163 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
4165 &{$column}( &{$f->{fields}->[$i]}(@args),
4166 map { $f->{$_}->[$i] } qw(align span width)
4170 $prefix. join( $separator, @result ). $suffix;
4175 #sub _items_extra_usage_sections {
4177 # my $escape = shift;
4179 # my %sections = ();
4181 # my %usage_class = map{ $_->classname, $_ } qsearch('usage_class', {});
4182 # foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
4184 # next unless $cust_bill_pkg->pkgnum > 0;
4186 # foreach my $section ( keys %usage_class ) {
4188 # my $usage = $cust_bill_pkg->usage($section);
4190 # next unless $usage && $usage > 0;
4192 # $sections{$section} ||= 0;
4193 # $sections{$section} += $usage;
4199 # map { { 'description' => &{$escape}($_),
4200 # 'subtotal' => $sections{$_},
4201 # 'summarized' => '',
4202 # 'tax_section' => '',
4205 # sort {$usage_class{$a}->weight <=> $usage_class{$b}->weight} keys %sections;
4209 sub _items_extra_usage_sections {
4211 my $conf = $self->conf;
4219 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
4221 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
4222 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
4223 next unless $cust_bill_pkg->pkgnum > 0;
4225 foreach my $classnum ( keys %usage_class ) {
4226 my $section = $usage_class{$classnum}->classname;
4227 $classnums{$section} = $classnum;
4229 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail($classnum) ) {
4230 my $amount = $detail->amount;
4231 next unless $amount && $amount > 0;
4233 $sections{$section} ||= { 'subtotal'=>0, 'calls'=>0, 'duration'=>0 };
4234 $sections{$section}{amount} += $amount; #subtotal
4235 $sections{$section}{calls}++;
4236 $sections{$section}{duration} += $detail->duration;
4238 my $desc = $detail->regionname;
4239 my $description = $desc;
4240 $description = substr($desc, 0, $maxlength). '...'
4241 if $format eq 'latex' && length($desc) > $maxlength;
4243 $lines{$section}{$desc} ||= {
4244 description => &{$escape}($description),
4245 #pkgpart => $part_pkg->pkgpart,
4246 pkgnum => $cust_bill_pkg->pkgnum,
4251 #unit_amount => $cust_bill_pkg->unitrecur,
4252 quantity => $cust_bill_pkg->quantity,
4253 product_code => 'N/A',
4254 ext_description => [],
4257 $lines{$section}{$desc}{amount} += $amount;
4258 $lines{$section}{$desc}{calls}++;
4259 $lines{$section}{$desc}{duration} += $detail->duration;
4265 my %sectionmap = ();
4266 foreach (keys %sections) {
4267 my $usage_class = $usage_class{$classnums{$_}};
4268 $sectionmap{$_} = { 'description' => &{$escape}($_),
4269 'amount' => $sections{$_}{amount}, #subtotal
4270 'calls' => $sections{$_}{calls},
4271 'duration' => $sections{$_}{duration},
4273 'tax_section' => '',
4274 'sort_weight' => $usage_class->weight,
4275 ( $usage_class->format
4276 ? ( map { $_ => $usage_class->$_($format) }
4277 qw( description_generator header_generator total_generator total_line_generator )
4284 my @sections = sort { $a->{sort_weight} <=> $b->{sort_weight} }
4288 foreach my $section ( keys %lines ) {
4289 foreach my $line ( keys %{$lines{$section}} ) {
4290 my $l = $lines{$section}{$line};
4291 $l->{section} = $sectionmap{$section};
4292 $l->{amount} = sprintf( "%.2f", $l->{amount} );
4293 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
4298 return(\@sections, \@lines);
4304 my $end = $self->_date;
4306 # start at date of previous invoice + 1 second or 0 if no previous invoice
4307 my $start = $self->scalar_sql("SELECT max(_date) FROM cust_bill WHERE custnum = ? and invnum != ?",$self->custnum,$self->invnum);
4308 $start = 0 if !$start;
4311 my $cust_main = $self->cust_main;
4312 my @pkgs = $cust_main->all_pkgs;
4313 my($num_activated,$num_deactivated,$num_portedin,$num_portedout,$minutes)
4316 foreach my $pkg ( @pkgs ) {
4317 my @h_cust_svc = $pkg->h_cust_svc($end);
4318 foreach my $h_cust_svc ( @h_cust_svc ) {
4319 next if grep {$_ eq $h_cust_svc->svcnum} @seen;
4320 next unless $h_cust_svc->part_svc->svcdb eq 'svc_phone';
4322 my $inserted = $h_cust_svc->date_inserted;
4323 my $deleted = $h_cust_svc->date_deleted;
4324 my $phone_inserted = $h_cust_svc->h_svc_x($inserted+5);
4326 $phone_deleted = $h_cust_svc->h_svc_x($deleted) if $deleted;
4328 # DID either activated or ported in; cannot be both for same DID simultaneously
4329 if ($inserted >= $start && $inserted <= $end && $phone_inserted
4330 && (!$phone_inserted->lnp_status
4331 || $phone_inserted->lnp_status eq ''
4332 || $phone_inserted->lnp_status eq 'native')) {
4335 else { # this one not so clean, should probably move to (h_)svc_phone
4336 my $phone_portedin = qsearchs( 'h_svc_phone',
4337 { 'svcnum' => $h_cust_svc->svcnum,
4338 'lnp_status' => 'portedin' },
4339 FS::h_svc_phone->sql_h_searchs($end),
4341 $num_portedin++ if $phone_portedin;
4344 # DID either deactivated or ported out; cannot be both for same DID simultaneously
4345 if($deleted >= $start && $deleted <= $end && $phone_deleted
4346 && (!$phone_deleted->lnp_status
4347 || $phone_deleted->lnp_status ne 'portingout')) {
4350 elsif($deleted >= $start && $deleted <= $end && $phone_deleted
4351 && $phone_deleted->lnp_status
4352 && $phone_deleted->lnp_status eq 'portingout') {
4356 # increment usage minutes
4357 if ( $phone_inserted ) {
4358 my @cdrs = $phone_inserted->get_cdrs('begin'=>$start,'end'=>$end,'billsec_sum'=>1);
4359 $minutes = $cdrs[0]->billsec_sum if scalar(@cdrs) == 1;
4362 warn "WARNING: no matching h_svc_phone insert record for insert time $inserted, svcnum " . $h_cust_svc->svcnum;
4365 # don't look at this service again
4366 push @seen, $h_cust_svc->svcnum;
4370 $minutes = sprintf("%d", $minutes);
4371 ("Activated: $num_activated Ported-In: $num_portedin Deactivated: "
4372 . "$num_deactivated Ported-Out: $num_portedout ",
4373 "Total Minutes: $minutes");
4376 sub _items_accountcode_cdr {
4381 my $section = { 'amount' => 0,
4384 'sort_weight' => '',
4386 'description' => 'Usage by Account Code',
4392 my %accountcodes = ();
4394 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
4395 next unless $cust_bill_pkg->pkgnum > 0;
4397 my @header = $cust_bill_pkg->details_header;
4398 next unless scalar(@header);
4399 $section->{'header'} = join(',',@header);
4401 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
4403 $section->{'header'} = $detail->formatted('format' => $format)
4404 if($detail->detail eq $section->{'header'});
4406 my $accountcode = $detail->accountcode;
4407 next unless $accountcode;
4409 my $amount = $detail->amount;
4410 next unless $amount && $amount > 0;
4412 $accountcodes{$accountcode} ||= {
4413 description => $accountcode,
4420 product_code => 'N/A',
4421 section => $section,
4422 ext_description => [ $section->{'header'} ],
4426 $section->{'amount'} += $amount;
4427 $accountcodes{$accountcode}{'amount'} += $amount;
4428 $accountcodes{$accountcode}{calls}++;
4429 $accountcodes{$accountcode}{duration} += $detail->duration;
4430 push @{$accountcodes{$accountcode}{detail_temp}}, $detail;
4434 foreach my $l ( values %accountcodes ) {
4435 $l->{amount} = sprintf( "%.2f", $l->{amount} );
4436 my @sorted_detail = sort { $a->startdate <=> $b->startdate } @{$l->{detail_temp}};
4437 foreach my $sorted_detail ( @sorted_detail ) {
4438 push @{$l->{ext_description}}, $sorted_detail->formatted('format'=>$format);
4440 delete $l->{detail_temp};
4444 my @sorted_lines = sort { $a->{'description'} <=> $b->{'description'} } @lines;
4446 return ($section,\@sorted_lines);
4449 sub _items_svc_phone_sections {
4451 my $conf = $self->conf;
4459 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
4461 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
4462 $usage_class{''} ||= new FS::usage_class { 'classname' => '', 'weight' => 0 };
4464 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
4465 next unless $cust_bill_pkg->pkgnum > 0;
4467 my @header = $cust_bill_pkg->details_header;
4468 next unless scalar(@header);
4470 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
4472 my $phonenum = $detail->phonenum;
4473 next unless $phonenum;
4475 my $amount = $detail->amount;
4476 next unless $amount && $amount > 0;
4478 $sections{$phonenum} ||= { 'amount' => 0,
4481 'sort_weight' => -1,
4482 'phonenum' => $phonenum,
4484 $sections{$phonenum}{amount} += $amount; #subtotal
4485 $sections{$phonenum}{calls}++;
4486 $sections{$phonenum}{duration} += $detail->duration;
4488 my $desc = $detail->regionname;
4489 my $description = $desc;
4490 $description = substr($desc, 0, $maxlength). '...'
4491 if $format eq 'latex' && length($desc) > $maxlength;
4493 $lines{$phonenum}{$desc} ||= {
4494 description => &{$escape}($description),
4495 #pkgpart => $part_pkg->pkgpart,
4503 product_code => 'N/A',
4504 ext_description => [],
4507 $lines{$phonenum}{$desc}{amount} += $amount;
4508 $lines{$phonenum}{$desc}{calls}++;
4509 $lines{$phonenum}{$desc}{duration} += $detail->duration;
4511 my $line = $usage_class{$detail->classnum}->classname;
4512 $sections{"$phonenum $line"} ||=
4516 'sort_weight' => $usage_class{$detail->classnum}->weight,
4517 'phonenum' => $phonenum,
4518 'header' => [ @header ],
4520 $sections{"$phonenum $line"}{amount} += $amount; #subtotal
4521 $sections{"$phonenum $line"}{calls}++;
4522 $sections{"$phonenum $line"}{duration} += $detail->duration;
4524 $lines{"$phonenum $line"}{$desc} ||= {
4525 description => &{$escape}($description),
4526 #pkgpart => $part_pkg->pkgpart,
4534 product_code => 'N/A',
4535 ext_description => [],
4538 $lines{"$phonenum $line"}{$desc}{amount} += $amount;
4539 $lines{"$phonenum $line"}{$desc}{calls}++;
4540 $lines{"$phonenum $line"}{$desc}{duration} += $detail->duration;
4541 push @{$lines{"$phonenum $line"}{$desc}{ext_description}},
4542 $detail->formatted('format' => $format);
4547 my %sectionmap = ();
4548 my $simple = new FS::usage_class { format => 'simple' }; #bleh
4549 foreach ( keys %sections ) {
4550 my @header = @{ $sections{$_}{header} || [] };
4552 new FS::usage_class { format => 'usage_'. (scalar(@header) || 6). 'col' };
4553 my $summary = $sections{$_}{sort_weight} < 0 ? 1 : 0;
4554 my $usage_class = $summary ? $simple : $usage_simple;
4555 my $ending = $summary ? ' usage charges' : '';
4558 $gen_opt{label} = [ map{ &{$escape}($_) } @header ];
4560 $sectionmap{$_} = { 'description' => &{$escape}($_. $ending),
4561 'amount' => $sections{$_}{amount}, #subtotal
4562 'calls' => $sections{$_}{calls},
4563 'duration' => $sections{$_}{duration},
4565 'tax_section' => '',
4566 'phonenum' => $sections{$_}{phonenum},
4567 'sort_weight' => $sections{$_}{sort_weight},
4568 'post_total' => $summary, #inspire pagebreak
4570 ( map { $_ => $usage_class->$_($format, %gen_opt) }
4571 qw( description_generator
4574 total_line_generator
4581 my @sections = sort { $a->{phonenum} cmp $b->{phonenum} ||
4582 $a->{sort_weight} <=> $b->{sort_weight}
4587 foreach my $section ( keys %lines ) {
4588 foreach my $line ( keys %{$lines{$section}} ) {
4589 my $l = $lines{$section}{$line};
4590 $l->{section} = $sectionmap{$section};
4591 $l->{amount} = sprintf( "%.2f", $l->{amount} );
4592 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
4597 if($conf->exists('phone_usage_class_summary')) {
4598 # this only works with Latex
4602 # after this, we'll have only two sections per DID:
4603 # Calls Summary and Calls Detail
4604 foreach my $section ( @sections ) {
4605 if($section->{'post_total'}) {
4606 $section->{'description'} = 'Calls Summary: '.$section->{'phonenum'};
4607 $section->{'total_line_generator'} = sub { '' };
4608 $section->{'total_generator'} = sub { '' };
4609 $section->{'header_generator'} = sub { '' };
4610 $section->{'description_generator'} = '';
4611 push @newsections, $section;
4612 my %calls_detail = %$section;
4613 $calls_detail{'post_total'} = '';
4614 $calls_detail{'sort_weight'} = '';
4615 $calls_detail{'description_generator'} = sub { '' };
4616 $calls_detail{'header_generator'} = sub {
4617 return ' & Date/Time & Called Number & Duration & Price'
4618 if $format eq 'latex';
4621 $calls_detail{'description'} = 'Calls Detail: '
4622 . $section->{'phonenum'};
4623 push @newsections, \%calls_detail;
4627 # after this, each usage class is collapsed/summarized into a single
4628 # line under the Calls Summary section
4629 foreach my $newsection ( @newsections ) {
4630 if($newsection->{'post_total'}) { # this means Calls Summary
4631 foreach my $section ( @sections ) {
4632 next unless ($section->{'phonenum'} eq $newsection->{'phonenum'}
4633 && !$section->{'post_total'});
4634 my $newdesc = $section->{'description'};
4635 my $tn = $section->{'phonenum'};
4636 $newdesc =~ s/$tn//g;
4637 my $line = { ext_description => [],
4641 calls => $section->{'calls'},
4642 section => $newsection,
4643 duration => $section->{'duration'},
4644 description => $newdesc,
4645 amount => sprintf("%.2f",$section->{'amount'}),
4646 product_code => 'N/A',
4648 push @newlines, $line;
4653 # after this, Calls Details is populated with all CDRs
4654 foreach my $newsection ( @newsections ) {
4655 if(!$newsection->{'post_total'}) { # this means Calls Details
4656 foreach my $line ( @lines ) {
4657 next unless (scalar(@{$line->{'ext_description'}}) &&
4658 $line->{'section'}->{'phonenum'} eq $newsection->{'phonenum'}
4660 my @extdesc = @{$line->{'ext_description'}};
4662 foreach my $extdesc ( @extdesc ) {
4663 $extdesc =~ s/scriptsize/normalsize/g if $format eq 'latex';
4664 push @newextdesc, $extdesc;
4666 $line->{'ext_description'} = \@newextdesc;
4667 $line->{'section'} = $newsection;
4668 push @newlines, $line;
4673 return(\@newsections, \@newlines);
4676 return(\@sections, \@lines);
4680 sub _items { # seems to be unused
4683 #my @display = scalar(@_)
4685 # : qw( _items_previous _items_pkg );
4686 # #: qw( _items_pkg );
4687 # #: qw( _items_previous _items_pkg _items_tax _items_credits _items_payments );
4688 my @display = qw( _items_previous _items_pkg );
4691 foreach my $display ( @display ) {
4692 push @b, $self->$display(@_);
4697 sub _items_previous {
4699 my $conf = $self->conf;
4700 my $cust_main = $self->cust_main;
4701 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
4703 foreach ( @pr_cust_bill ) {
4704 my $date = $conf->exists('invoice_show_prior_due_date')
4705 ? 'due '. $_->due_date2str($date_format)
4706 : time2str($date_format, $_->_date);
4708 'description' => $self->mt('Previous Balance, Invoice #'). $_->invnum. " ($date)",
4709 #'pkgpart' => 'N/A',
4711 'amount' => sprintf("%.2f", $_->owed),
4717 # 'description' => 'Previous Balance',
4718 # #'pkgpart' => 'N/A',
4719 # 'pkgnum' => 'N/A',
4720 # 'amount' => sprintf("%10.2f", $pr_total ),
4721 # 'ext_description' => [ map {
4722 # "Invoice ". $_->invnum.
4723 # " (". time2str("%x",$_->_date). ") ".
4724 # sprintf("%10.2f", $_->owed)
4725 # } @pr_cust_bill ],
4730 =item _items_pkg [ OPTIONS ]
4732 Return line item hashes for each package item on this invoice. Nearly
4735 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
4737 The only OPTIONS accepted is 'section', which may point to a hashref
4738 with a key named 'condensed', which may have a true value. If it
4739 does, this method tries to merge identical items into items with
4740 'quantity' equal to the number of items (not the sum of their
4741 separate quantities, for some reason).
4749 warn "$me _items_pkg searching for all package line items\n"
4752 my @cust_bill_pkg = grep { $_->pkgnum } $self->cust_bill_pkg;
4754 warn "$me _items_pkg filtering line items\n"
4756 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
4758 if ($options{section} && $options{section}->{condensed}) {
4760 warn "$me _items_pkg condensing section\n"
4764 local $Storable::canonical = 1;
4765 foreach ( @items ) {
4767 delete $item->{ref};
4768 delete $item->{ext_description};
4769 my $key = freeze($item);
4770 $itemshash{$key} ||= 0;
4771 $itemshash{$key} ++; # += $item->{quantity};
4773 @items = sort { $a->{description} cmp $b->{description} }
4774 map { my $i = thaw($_);
4775 $i->{quantity} = $itemshash{$_};
4777 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
4783 warn "$me _items_pkg returning ". scalar(@items). " items\n"
4790 return 0 unless $a->itemdesc cmp $b->itemdesc;
4791 return -1 if $b->itemdesc eq 'Tax';
4792 return 1 if $a->itemdesc eq 'Tax';
4793 return -1 if $b->itemdesc eq 'Other surcharges';
4794 return 1 if $a->itemdesc eq 'Other surcharges';
4795 $a->itemdesc cmp $b->itemdesc;
4800 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum } $self->cust_bill_pkg;
4801 $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
4804 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
4806 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
4807 list of hashrefs describing the line items they generate on the invoice.
4809 OPTIONS may include:
4811 format: the invoice format.
4813 escape_function: the function used to escape strings.
4815 DEPRECATED? (expensive, mostly unused?)
4816 format_function: the function used to format CDRs.
4818 section: a hashref containing 'description'; if this is present,
4819 cust_bill_pkg_display records not belonging to this section are
4822 multisection: a flag indicating that this is a multisection invoice,
4823 which does something complicated.
4825 multilocation: a flag to display the location label for the package.
4827 Returns a list of hashrefs, each of which may contain:
4829 pkgnum, description, amount, unit_amount, quantity, _is_setup, and
4830 ext_description, which is an arrayref of detail lines to show below
4835 sub _items_cust_bill_pkg {
4837 my $conf = $self->conf;
4838 my $cust_bill_pkgs = shift;
4841 my $format = $opt{format} || '';
4842 my $escape_function = $opt{escape_function} || sub { shift };
4843 my $format_function = $opt{format_function} || '';
4844 my $no_usage = $opt{no_usage} || '';
4845 my $unsquelched = $opt{unsquelched} || ''; #unused
4846 my $section = $opt{section}->{description} if $opt{section};
4847 my $summary_page = $opt{summary_page} || ''; #unused
4848 my $multilocation = $opt{multilocation} || '';
4849 my $multisection = $opt{multisection} || '';
4850 my $discount_show_always = 0;
4852 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
4855 my ($s, $r, $u) = ( undef, undef, undef );
4856 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
4859 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ) ) {
4860 if ( $_ && !$cust_bill_pkg->hidden ) {
4861 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
4862 $_->{amount} =~ s/^\-0\.00$/0.00/;
4863 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} ),
4865 if $_->{amount} != 0
4866 || $discount_show_always
4867 || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
4868 || ( $_->{_is_setup} && $_->{setup_show_zero} )
4874 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
4875 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
4878 foreach my $display ( grep { defined($section)
4879 ? $_->section eq $section
4882 #grep { !$_->summary || !$summary_page } # bunk!
4883 grep { !$_->summary || $multisection }
4884 $cust_bill_pkg->cust_bill_pkg_display
4888 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
4889 $display->billpkgdisplaynum. "\n"
4892 my $type = $display->type;
4894 my $desc = $cust_bill_pkg->desc;
4895 $desc = substr($desc, 0, $maxlength). '...'
4896 if $format eq 'latex' && length($desc) > $maxlength;
4898 my %details_opt = ( 'format' => $format,
4899 'escape_function' => $escape_function,
4900 'format_function' => $format_function,
4901 'no_usage' => $opt{'no_usage'},
4904 if ( $cust_bill_pkg->pkgnum > 0 ) {
4906 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
4909 my $cust_pkg = $cust_bill_pkg->cust_pkg;
4911 # start/end dates for invoice formats that do nonstandard
4913 my %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate');
4915 if ( (!$type || $type eq 'S')
4916 && ( $cust_bill_pkg->setup != 0
4917 || $cust_bill_pkg->setup_show_zero
4922 warn "$me _items_cust_bill_pkg adding setup\n"
4925 my $description = $desc;
4926 $description .= ' Setup'
4927 if $cust_bill_pkg->recur != 0
4928 || $discount_show_always
4929 || $cust_bill_pkg->recur_show_zero;
4932 unless ( $cust_pkg->part_pkg->hide_svc_detail
4933 || $cust_bill_pkg->hidden )
4936 push @d, map &{$escape_function}($_),
4937 $cust_pkg->h_labels_short($self->_date, undef, 'I')
4938 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
4940 if ( $multilocation ) {
4941 my $loc = $cust_pkg->location_label;
4942 $loc = substr($loc, 0, $maxlength). '...'
4943 if $format eq 'latex' && length($loc) > $maxlength;
4944 push @d, &{$escape_function}($loc);
4947 } #unless hiding service details
4949 push @d, $cust_bill_pkg->details(%details_opt)
4950 if $cust_bill_pkg->recur == 0;
4952 if ( $cust_bill_pkg->hidden ) {
4953 $s->{amount} += $cust_bill_pkg->setup;
4954 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
4955 push @{ $s->{ext_description} }, @d;
4959 description => $description,
4960 #pkgpart => $part_pkg->pkgpart,
4961 pkgnum => $cust_bill_pkg->pkgnum,
4962 amount => $cust_bill_pkg->setup,
4963 setup_show_zero => $cust_bill_pkg->setup_show_zero,
4964 unit_amount => $cust_bill_pkg->unitsetup,
4965 quantity => $cust_bill_pkg->quantity,
4966 ext_description => \@d,
4972 if ( ( !$type || $type eq 'R' || $type eq 'U' )
4974 $cust_bill_pkg->recur != 0
4975 || $cust_bill_pkg->setup == 0
4976 || $discount_show_always
4977 || $cust_bill_pkg->recur_show_zero
4982 warn "$me _items_cust_bill_pkg adding recur/usage\n"
4985 my $is_summary = $display->summary;
4986 my $description = ($is_summary && $type && $type eq 'U')
4987 ? "Usage charges" : $desc;
4989 $description .= " (" . time2str($date_format, $cust_bill_pkg->sdate).
4990 " - ". time2str($date_format, $cust_bill_pkg->edate).
4992 unless $conf->exists('disable_line_item_date_ranges')
4993 || $cust_pkg->part_pkg->option('disable_line_item_date_ranges',1);
4996 my @seconds = (); # for display of usage info
4998 #at least until cust_bill_pkg has "past" ranges in addition to
4999 #the "future" sdate/edate ones... see #3032
5000 my @dates = ( $self->_date );
5001 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
5002 push @dates, $prev->sdate if $prev;
5003 push @dates, undef if !$prev;
5005 unless ( $cust_pkg->part_pkg->hide_svc_detail
5006 || $cust_bill_pkg->itemdesc
5007 || $cust_bill_pkg->hidden
5008 || $is_summary && $type && $type eq 'U' )
5011 warn "$me _items_cust_bill_pkg adding service details\n"
5014 push @d, map &{$escape_function}($_),
5015 $cust_pkg->h_labels_short(@dates, 'I')
5016 #$cust_bill_pkg->edate,
5017 #$cust_bill_pkg->sdate)
5018 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
5020 warn "$me _items_cust_bill_pkg done adding service details\n"
5023 if ( $multilocation ) {
5024 my $loc = $cust_pkg->location_label;
5025 $loc = substr($loc, 0, $maxlength). '...'
5026 if $format eq 'latex' && length($loc) > $maxlength;
5027 push @d, &{$escape_function}($loc);
5030 # Display of seconds_since_sqlradacct:
5031 # On the invoice, when processing @detail_items, look for a field
5032 # named 'seconds'. This will contain total seconds for each
5033 # service, in the same order as @ext_description. For services
5034 # that don't support this it will show undef.
5035 if ( $conf->exists('svc_acct-usage_seconds')
5036 and ! $cust_bill_pkg->pkgpart_override ) {
5037 foreach my $cust_svc (
5038 $cust_pkg->h_cust_svc(@dates, 'I')
5041 # eval because not having any part_export_usage exports
5042 # is a fatal error, last_bill/_date because that's how
5043 # sqlradius_hour billing does it
5045 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
5047 push @seconds, $sec;
5049 } #if svc_acct-usage_seconds
5053 unless ( $is_summary ) {
5054 warn "$me _items_cust_bill_pkg adding details\n"
5057 #instead of omitting details entirely in this case (unwanted side
5058 # effects), just omit CDRs
5059 $details_opt{'no_usage'} = 1
5060 if $type && $type eq 'R';
5062 push @d, $cust_bill_pkg->details(%details_opt);
5065 warn "$me _items_cust_bill_pkg calculating amount\n"
5070 $amount = $cust_bill_pkg->recur;
5071 } elsif ($type eq 'R') {
5072 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
5073 } elsif ($type eq 'U') {
5074 $amount = $cust_bill_pkg->usage;
5077 if ( !$type || $type eq 'R' ) {
5079 warn "$me _items_cust_bill_pkg adding recur\n"
5082 if ( $cust_bill_pkg->hidden ) {
5083 $r->{amount} += $amount;
5084 $r->{unit_amount} += $cust_bill_pkg->unitrecur;
5085 push @{ $r->{ext_description} }, @d;
5088 description => $description,
5089 #pkgpart => $part_pkg->pkgpart,
5090 pkgnum => $cust_bill_pkg->pkgnum,
5092 recur_show_zero => $cust_bill_pkg->recur_show_zero,
5093 unit_amount => $cust_bill_pkg->unitrecur,
5094 quantity => $cust_bill_pkg->quantity,
5096 ext_description => \@d,
5098 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
5101 } else { # $type eq 'U'
5103 warn "$me _items_cust_bill_pkg adding usage\n"
5106 if ( $cust_bill_pkg->hidden ) {
5107 $u->{amount} += $amount;
5108 $u->{unit_amount} += $cust_bill_pkg->unitrecur;
5109 push @{ $u->{ext_description} }, @d;
5112 description => $description,
5113 #pkgpart => $part_pkg->pkgpart,
5114 pkgnum => $cust_bill_pkg->pkgnum,
5116 recur_show_zero => $cust_bill_pkg->recur_show_zero,
5117 unit_amount => $cust_bill_pkg->unitrecur,
5118 quantity => $cust_bill_pkg->quantity,
5120 ext_description => \@d,
5125 } # recurring or usage with recurring charge
5127 } else { #pkgnum tax or one-shot line item (??)
5129 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
5132 if ( $cust_bill_pkg->setup != 0 ) {
5134 'description' => $desc,
5135 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
5138 if ( $cust_bill_pkg->recur != 0 ) {
5140 'description' => "$desc (".
5141 time2str($date_format, $cust_bill_pkg->sdate). ' - '.
5142 time2str($date_format, $cust_bill_pkg->edate). ')',
5143 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
5151 $discount_show_always = ($cust_bill_pkg->cust_bill_pkg_discount
5152 && $conf->exists('discount-show-always'));
5156 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ) ) {
5158 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
5159 $_->{amount} =~ s/^\-0\.00$/0.00/;
5160 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} ),
5162 if $_->{amount} != 0
5163 || $discount_show_always
5164 || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
5165 || ( $_->{_is_setup} && $_->{setup_show_zero} )
5169 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
5176 sub _items_credits {
5177 my( $self, %opt ) = @_;
5178 my $trim_len = $opt{'trim_len'} || 60;
5182 foreach ( $self->cust_credited ) {
5184 #something more elaborate if $_->amount ne $_->cust_credit->credited ?
5186 my $reason = substr($_->cust_credit->reason, 0, $trim_len);
5187 $reason .= '...' if length($reason) < length($_->cust_credit->reason);
5188 $reason = " ($reason) " if $reason;
5191 #'description' => 'Credit ref\#'. $_->crednum.
5192 # " (". time2str("%x",$_->cust_credit->_date) .")".
5194 'description' => $self->mt('Credit applied').' '.
5195 time2str($date_format,$_->cust_credit->_date). $reason,
5196 'amount' => sprintf("%.2f",$_->amount),
5204 sub _items_payments {
5208 #get & print payments
5209 foreach ( $self->cust_bill_pay ) {
5211 #something more elaborate if $_->amount ne ->cust_pay->paid ?
5214 'description' => $self->mt('Payment received').' '.
5215 time2str($date_format,$_->cust_pay->_date ),
5216 'amount' => sprintf("%.2f", $_->amount )
5224 =item _items_discounts_avail
5226 Returns an array of line item hashrefs representing available term discounts
5227 for this invoice. This makes the same assumptions that apply to term
5228 discounts in general: that the package is billed monthly, at a flat rate,
5229 with no usage charges. A prorated first month will be handled, as will
5230 a setup fee if the discount is allowed to apply to setup fees.
5234 sub _items_discounts_avail {
5236 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
5238 my %plans = $self->discount_plans;
5240 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
5244 my $plan = $plans{$months};
5246 my $term_total = sprintf('%.2f', $plan->discounted_total);
5247 my $percent = sprintf('%.0f',
5248 100 * (1 - $term_total / $plan->base_total) );
5249 my $permonth = sprintf('%.2f', $term_total / $months);
5250 my $detail = $self->mt('discount on item'). ' '.
5251 join(', ', map { "#$_" } $plan->pkgnums)
5255 description => $self->mt('Save [_1]% by paying for [_2] months',
5257 amount => $self->mt('[_1] ([_2] per month)',
5258 $term_total, $money_char.$permonth),
5259 ext_description => ($detail || ''),
5262 sort { $b <=> $a } keys %plans;
5266 =item call_details [ OPTION => VALUE ... ]
5268 Returns an array of CSV strings representing the call details for this invoice
5269 The only option available is the boolean prepend_billed_number
5274 my ($self, %opt) = @_;
5276 my $format_function = sub { shift };
5278 if ($opt{prepend_billed_number}) {
5279 $format_function = sub {
5283 $row->amount ? $row->phonenum. ",". $detail : '"Billed number",'. $detail;
5288 my @details = map { $_->details( 'format_function' => $format_function,
5289 'escape_function' => sub{ return() },
5293 $self->cust_bill_pkg;
5294 my $header = $details[0];
5295 ( $header, grep { $_ ne $header } @details );
5305 =item process_reprint
5309 sub process_reprint {
5310 process_re_X('print', @_);
5313 =item process_reemail
5317 sub process_reemail {
5318 process_re_X('email', @_);
5326 process_re_X('fax', @_);
5334 process_re_X('ftp', @_);
5341 sub process_respool {
5342 process_re_X('spool', @_);
5345 use Storable qw(thaw);
5349 my( $method, $job ) = ( shift, shift );
5350 warn "$me process_re_X $method for job $job\n" if $DEBUG;
5352 my $param = thaw(decode_base64(shift));
5353 warn Dumper($param) if $DEBUG;
5364 my($method, $job, %param ) = @_;
5366 warn "re_X $method for job $job with param:\n".
5367 join( '', map { " $_ => ". $param{$_}. "\n" } keys %param );
5370 #some false laziness w/search/cust_bill.html
5372 my $orderby = 'ORDER BY cust_bill._date';
5374 my $extra_sql = ' WHERE '. FS::cust_bill->search_sql_where(\%param);
5376 my $addl_from = 'LEFT JOIN cust_main USING ( custnum )';
5378 my @cust_bill = qsearch( {
5379 #'select' => "cust_bill.*",
5380 'table' => 'cust_bill',
5381 'addl_from' => $addl_from,
5383 'extra_sql' => $extra_sql,
5384 'order_by' => $orderby,
5388 $method .= '_invoice' unless $method eq 'email' || $method eq 'print';
5390 warn " $me re_X $method: ". scalar(@cust_bill). " invoices found\n"
5393 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
5394 foreach my $cust_bill ( @cust_bill ) {
5395 $cust_bill->$method();
5397 if ( $job ) { #progressbar foo
5399 if ( time - $min_sec > $last ) {
5400 my $error = $job->update_statustext(
5401 int( 100 * $num / scalar(@cust_bill) )
5403 die $error if $error;
5414 =head1 CLASS METHODS
5420 Returns an SQL fragment to retreive the amount owed (charged minus credited and paid).
5425 my ($class, $start, $end) = @_;
5427 $class->paid_sql($start, $end). ' - '.
5428 $class->credited_sql($start, $end);
5433 Returns an SQL fragment to retreive the net amount (charged minus credited).
5438 my ($class, $start, $end) = @_;
5439 'charged - '. $class->credited_sql($start, $end);
5444 Returns an SQL fragment to retreive the amount paid against this invoice.
5449 my ($class, $start, $end) = @_;
5450 $start &&= "AND cust_bill_pay._date <= $start";
5451 $end &&= "AND cust_bill_pay._date > $end";
5452 $start = '' unless defined($start);
5453 $end = '' unless defined($end);
5454 "( SELECT COALESCE(SUM(amount),0) FROM cust_bill_pay
5455 WHERE cust_bill.invnum = cust_bill_pay.invnum $start $end )";
5460 Returns an SQL fragment to retreive the amount credited against this invoice.
5465 my ($class, $start, $end) = @_;
5466 $start &&= "AND cust_credit_bill._date <= $start";
5467 $end &&= "AND cust_credit_bill._date > $end";
5468 $start = '' unless defined($start);
5469 $end = '' unless defined($end);
5470 "( SELECT COALESCE(SUM(amount),0) FROM cust_credit_bill
5471 WHERE cust_bill.invnum = cust_credit_bill.invnum $start $end )";
5476 Returns an SQL fragment to retrieve the due date of an invoice.
5477 Currently only supported on PostgreSQL.
5482 my $conf = new FS::Conf;
5486 cust_bill.invoice_terms,
5487 cust_main.invoice_terms,
5488 \''.($conf->config('invoice_default_terms') || '').'\'
5489 ), E\'Net (\\\\d+)\'
5491 ) * 86400 + cust_bill._date'
5494 =item search_sql_where HASHREF
5496 Class method which returns an SQL WHERE fragment to search for parameters
5497 specified in HASHREF. Valid parameters are
5503 List reference of start date, end date, as UNIX timestamps.
5513 List reference of charged limits (exclusive).
5517 List reference of charged limits (exclusive).
5521 flag, return open invoices only
5525 flag, return net invoices only
5529 =item newest_percust
5533 Note: validates all passed-in data; i.e. safe to use with unchecked CGI params.
5537 sub search_sql_where {
5538 my($class, $param) = @_;
5540 warn "$me search_sql_where called with params: \n".
5541 join("\n", map { " $_: ". $param->{$_} } keys %$param ). "\n";
5547 if ( $param->{'agentnum'} =~ /^(\d+)$/ ) {
5548 push @search, "cust_main.agentnum = $1";
5552 if ( $param->{'custnum'} =~ /^(\d+)$/ ) {
5553 push @search, "cust_bill.custnum = $1";
5557 if ( $param->{_date} ) {
5558 my($beginning, $ending) = @{$param->{_date}};
5560 push @search, "cust_bill._date >= $beginning",
5561 "cust_bill._date < $ending";
5565 if ( $param->{'invnum_min'} =~ /^(\d+)$/ ) {
5566 push @search, "cust_bill.invnum >= $1";
5568 if ( $param->{'invnum_max'} =~ /^(\d+)$/ ) {
5569 push @search, "cust_bill.invnum <= $1";
5573 if ( $param->{charged} ) {
5574 my @charged = ref($param->{charged})
5575 ? @{ $param->{charged} }
5576 : ($param->{charged});
5578 push @search, map { s/^charged/cust_bill.charged/; $_; }
5582 my $owed_sql = FS::cust_bill->owed_sql;
5585 if ( $param->{owed} ) {
5586 my @owed = ref($param->{owed})
5587 ? @{ $param->{owed} }
5589 push @search, map { s/^owed/$owed_sql/; $_; }
5594 push @search, "0 != $owed_sql"
5595 if $param->{'open'};
5596 push @search, '0 != '. FS::cust_bill->net_sql
5600 push @search, "cust_bill._date < ". (time-86400*$param->{'days'})
5601 if $param->{'days'};
5604 if ( $param->{'newest_percust'} ) {
5606 #$distinct = 'DISTINCT ON ( cust_bill.custnum )';
5607 #$orderby = 'ORDER BY cust_bill.custnum ASC, cust_bill._date DESC';
5609 my @newest_where = map { my $x = $_;
5610 $x =~ s/\bcust_bill\./newest_cust_bill./g;
5613 grep ! /^cust_main./, @search;
5614 my $newest_where = scalar(@newest_where)
5615 ? ' AND '. join(' AND ', @newest_where)
5619 push @search, "cust_bill._date = (
5620 SELECT(MAX(newest_cust_bill._date)) FROM cust_bill AS newest_cust_bill
5621 WHERE newest_cust_bill.custnum = cust_bill.custnum
5627 #promised_date - also has an option to accept nulls
5628 if ( $param->{promised_date} ) {
5629 my($beginning, $ending, $null) = @{$param->{promised_date}};
5631 push @search, "(( cust_bill.promised_date >= $beginning AND ".
5632 "cust_bill.promised_date < $ending )" .
5633 ($null ? ' OR cust_bill.promised_date IS NULL ) ' : ')');
5636 #agent virtualization
5637 my $curuser = $FS::CurrentUser::CurrentUser;
5638 if ( $curuser->username eq 'fs_queue'
5639 && $param->{'CurrentUser'} =~ /^(\w+)$/ ) {
5641 my $newuser = qsearchs('access_user', {
5642 'username' => $username,
5646 $curuser = $newuser;
5648 warn "$me WARNING: (fs_queue) can't find CurrentUser $username\n";
5651 push @search, $curuser->agentnums_sql;
5653 join(' AND ', @search );
5665 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
5666 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base