4 use vars qw( @ISA $DEBUG $me $conf $money_char $date_format $rdate_format );
5 use vars qw( $invoice_lines @buf ); #yuck
6 use Fcntl qw(:flock); #for spool_csv
7 use List::Util qw(min max);
9 use Text::Template 1.20;
11 use String::ShellQuote;
14 use Storable qw( freeze thaw );
15 use FS::UID qw( datasrc );
16 use FS::Misc qw( send_email send_fax generate_ps generate_pdf do_print );
17 use FS::Record qw( qsearch qsearchs dbh );
18 use FS::cust_main_Mixin;
20 use FS::cust_statement;
21 use FS::cust_bill_pkg;
22 use FS::cust_bill_pkg_display;
23 use FS::cust_bill_pkg_detail;
27 use FS::cust_credit_bill;
29 use FS::cust_pay_batch;
30 use FS::cust_bill_event;
33 use FS::cust_bill_pay;
34 use FS::cust_bill_pay_batch;
35 use FS::part_bill_event;
38 use FS::cust_bill_batch;
40 @ISA = qw( FS::cust_main_Mixin FS::Record );
43 $me = '[FS::cust_bill]';
45 #ask FS::UID to run this stuff for us later
46 FS::UID->install_callback( sub {
48 $money_char = $conf->config('money_char') || '$';
49 $date_format = $conf->config('date_format') || '%x';
50 $rdate_format = $conf->config('date_format') || '%m/%d/%Y';
55 FS::cust_bill - Object methods for cust_bill records
61 $record = new FS::cust_bill \%hash;
62 $record = new FS::cust_bill { 'column' => 'value' };
64 $error = $record->insert;
66 $error = $new_record->replace($old_record);
68 $error = $record->delete;
70 $error = $record->check;
72 ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
74 @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
76 ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
78 @cust_pay_objects = $cust_bill->cust_pay;
80 $tax_amount = $record->tax;
82 @lines = $cust_bill->print_text;
83 @lines = $cust_bill->print_text $time;
87 An FS::cust_bill object represents an invoice; a declaration that a customer
88 owes you money. The specific charges are itemized as B<cust_bill_pkg> records
89 (see L<FS::cust_bill_pkg>). FS::cust_bill inherits from FS::Record. The
90 following fields are currently supported:
96 =item invnum - primary key (assigned automatically for new invoices)
98 =item custnum - customer (see L<FS::cust_main>)
100 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
101 L<Time::Local> and L<Date::Parse> for conversion functions.
103 =item charged - amount of this invoice
105 =item invoice_terms - optional terms override for this specific invoice
109 Customer info at invoice generation time
113 =item previous_balance
115 =item billing_balance
123 =item printed - deprecated
131 =item closed - books closed flag, empty or `Y'
133 =item statementnum - invoice aggregation (see L<FS::cust_statement>)
135 =item agent_invid - legacy invoice number
145 Creates a new invoice. To add the invoice to the database, see L<"insert">.
146 Invoices are normally created by calling the bill method of a customer object
147 (see L<FS::cust_main>).
151 sub table { 'cust_bill'; }
153 sub cust_linked { $_[0]->cust_main_custnum; }
154 sub cust_unlinked_msg {
156 "WARNING: can't find cust_main.custnum ". $self->custnum.
157 ' (cust_bill.invnum '. $self->invnum. ')';
162 Adds this invoice to the database ("Posts" the invoice). If there is an error,
163 returns the error, otherwise returns false.
169 warn "$me insert called\n" if $DEBUG;
171 local $SIG{HUP} = 'IGNORE';
172 local $SIG{INT} = 'IGNORE';
173 local $SIG{QUIT} = 'IGNORE';
174 local $SIG{TERM} = 'IGNORE';
175 local $SIG{TSTP} = 'IGNORE';
176 local $SIG{PIPE} = 'IGNORE';
178 my $oldAutoCommit = $FS::UID::AutoCommit;
179 local $FS::UID::AutoCommit = 0;
182 my $error = $self->SUPER::insert;
184 $dbh->rollback if $oldAutoCommit;
188 if ( $self->get('cust_bill_pkg') ) {
189 foreach my $cust_bill_pkg ( @{$self->get('cust_bill_pkg')} ) {
190 $cust_bill_pkg->invnum($self->invnum);
191 my $error = $cust_bill_pkg->insert;
193 $dbh->rollback if $oldAutoCommit;
194 return "can't create invoice line item: $error";
199 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
206 This method now works but you probably shouldn't use it. Instead, apply a
207 credit against the invoice.
209 Using this method to delete invoices outright is really, really bad. There
210 would be no record you ever posted this invoice, and there are no check to
211 make sure charged = 0 or that there are no associated cust_bill_pkg records.
213 Really, don't use it.
219 return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
221 local $SIG{HUP} = 'IGNORE';
222 local $SIG{INT} = 'IGNORE';
223 local $SIG{QUIT} = 'IGNORE';
224 local $SIG{TERM} = 'IGNORE';
225 local $SIG{TSTP} = 'IGNORE';
226 local $SIG{PIPE} = 'IGNORE';
228 my $oldAutoCommit = $FS::UID::AutoCommit;
229 local $FS::UID::AutoCommit = 0;
232 foreach my $table (qw(
244 foreach my $linked ( $self->$table() ) {
245 my $error = $linked->delete;
247 $dbh->rollback if $oldAutoCommit;
254 my $error = $self->SUPER::delete(@_);
256 $dbh->rollback if $oldAutoCommit;
260 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
266 =item replace OLD_RECORD
268 Replaces the OLD_RECORD with this one in the database. If there is an error,
269 returns the error, otherwise returns false.
271 Only printed may be changed. printed is normally updated by calling the
272 collect method of a customer object (see L<FS::cust_main>).
276 #replace can be inherited from Record.pm
278 # replace_check is now the preferred way to #implement replace data checks
279 # (so $object->replace() works without an argument)
282 my( $new, $old ) = ( shift, shift );
283 return "Can't change custnum!" unless $old->custnum == $new->custnum;
284 #return "Can't change _date!" unless $old->_date eq $new->_date;
285 return "Can't change _date!" unless $old->_date == $new->_date;
286 return "Can't change charged!" unless $old->charged == $new->charged
287 || $old->charged == 0;
294 Checks all fields to make sure this is a valid invoice. If there is an error,
295 returns the error, otherwise returns false. Called by the insert and replace
304 $self->ut_numbern('invnum')
305 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum' )
306 || $self->ut_numbern('_date')
307 || $self->ut_money('charged')
308 || $self->ut_numbern('printed')
309 || $self->ut_enum('closed', [ '', 'Y' ])
310 || $self->ut_foreign_keyn('statementnum', 'cust_statement', 'statementnum' )
311 || $self->ut_numbern('agent_invid') #varchar?
313 return $error if $error;
315 $self->_date(time) unless $self->_date;
317 $self->printed(0) if $self->printed eq '';
324 Returns the displayed invoice number for this invoice: agent_invid if
325 cust_bill-default_agent_invid is set and it has a value, invnum otherwise.
331 if ( $conf->exists('cust_bill-default_agent_invid') && $self->agent_invid ){
332 return $self->agent_invid;
334 return $self->invnum;
340 Returns a list consisting of the total previous balance for this customer,
341 followed by the previous outstanding invoices (as FS::cust_bill objects also).
348 my @cust_bill = sort { $a->_date <=> $b->_date }
349 grep { $_->owed != 0 && $_->_date < $self->_date }
350 qsearch( 'cust_bill', { 'custnum' => $self->custnum } )
352 foreach ( @cust_bill ) { $total += $_->owed; }
358 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
365 { 'table' => 'cust_bill_pkg',
366 'hashref' => { 'invnum' => $self->invnum },
367 'order_by' => 'ORDER BY billpkgnum',
372 =item cust_bill_pkg_pkgnum PKGNUM
374 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice and
379 sub cust_bill_pkg_pkgnum {
380 my( $self, $pkgnum ) = @_;
382 { 'table' => 'cust_bill_pkg',
383 'hashref' => { 'invnum' => $self->invnum,
386 'order_by' => 'ORDER BY billpkgnum',
393 Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
400 my @cust_pkg = map { $_->pkgnum > 0 ? $_->cust_pkg : () }
401 $self->cust_bill_pkg;
403 grep { ! $saw{$_->pkgnum}++ } @cust_pkg;
408 Returns true if any of the packages (or their definitions) corresponding to the
409 line items for this invoice have the no_auto flag set.
415 grep { $_->no_auto || $_->part_pkg->no_auto } $self->cust_pkg;
418 =item open_cust_bill_pkg
420 Returns the open line items for this invoice.
422 Note that cust_bill_pkg with both setup and recur fees are returned as two
423 separate line items, each with only one fee.
427 # modeled after cust_main::open_cust_bill
428 sub open_cust_bill_pkg {
431 # grep { $_->owed > 0 } $self->cust_bill_pkg
433 my %other = ( 'recur' => 'setup',
434 'setup' => 'recur', );
436 foreach my $field ( qw( recur setup )) {
437 push @open, map { $_->set( $other{$field}, 0 ); $_; }
438 grep { $_->owed($field) > 0 }
439 $self->cust_bill_pkg;
445 =item cust_bill_event
447 Returns the completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
451 sub cust_bill_event {
453 qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
456 =item num_cust_bill_event
458 Returns the number of completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
462 sub num_cust_bill_event {
465 "SELECT COUNT(*) FROM cust_bill_event WHERE invnum = ?";
466 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
467 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
468 $sth->fetchrow_arrayref->[0];
473 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
477 #false laziness w/cust_pkg.pm
481 'table' => 'cust_event',
482 'addl_from' => 'JOIN part_event USING ( eventpart )',
483 'hashref' => { 'tablenum' => $self->invnum },
484 'extra_sql' => " AND eventtable = 'cust_bill' ",
490 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
494 #false laziness w/cust_pkg.pm
498 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
499 " WHERE tablenum = ? AND eventtable = 'cust_bill'";
500 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
501 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
502 $sth->fetchrow_arrayref->[0];
507 Returns the customer (see L<FS::cust_main>) for this invoice.
513 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
516 =item cust_suspend_if_balance_over AMOUNT
518 Suspends the customer associated with this invoice if the total amount owed on
519 this invoice and all older invoices is greater than the specified amount.
521 Returns a list: an empty list on success or a list of errors.
525 sub cust_suspend_if_balance_over {
526 my( $self, $amount ) = ( shift, shift );
527 my $cust_main = $self->cust_main;
528 if ( $cust_main->total_owed_date($self->_date) < $amount ) {
531 $cust_main->suspend(@_);
537 Depreciated. See the cust_credited method.
539 #Returns a list consisting of the total previous credited (see
540 #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
541 #outstanding credits (FS::cust_credit objects).
547 croak "FS::cust_bill->cust_credit depreciated; see ".
548 "FS::cust_bill->cust_credit_bill";
551 #my @cust_credit = sort { $a->_date <=> $b->_date }
552 # grep { $_->credited != 0 && $_->_date < $self->_date }
553 # qsearch('cust_credit', { 'custnum' => $self->custnum } )
555 #foreach (@cust_credit) { $total += $_->credited; }
556 #$total, @cust_credit;
561 Depreciated. See the cust_bill_pay method.
563 #Returns all payments (see L<FS::cust_pay>) for this invoice.
569 croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
571 #sort { $a->_date <=> $b->_date }
572 # qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
578 qsearch('cust_pay_batch', { 'invnum' => $self->invnum } );
581 sub cust_bill_pay_batch {
583 qsearch('cust_bill_pay_batch', { 'invnum' => $self->invnum } );
588 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
594 map { $_ } #return $self->num_cust_bill_pay unless wantarray;
595 sort { $a->_date <=> $b->_date }
596 qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
601 =item cust_credit_bill
603 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
609 map { $_ } #return $self->num_cust_credit_bill unless wantarray;
610 sort { $a->_date <=> $b->_date }
611 qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
615 sub cust_credit_bill {
616 shift->cust_credited(@_);
619 =item cust_bill_pay_pkgnum PKGNUM
621 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
622 with matching pkgnum.
626 sub cust_bill_pay_pkgnum {
627 my( $self, $pkgnum ) = @_;
628 map { $_ } #return $self->num_cust_bill_pay_pkgnum($pkgnum) unless wantarray;
629 sort { $a->_date <=> $b->_date }
630 qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum,
636 =item cust_credited_pkgnum PKGNUM
638 =item cust_credit_bill_pkgnum PKGNUM
640 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice
641 with matching pkgnum.
645 sub cust_credited_pkgnum {
646 my( $self, $pkgnum ) = @_;
647 map { $_ } #return $self->num_cust_credit_bill_pkgnum($pkgnum) unless wantarray;
648 sort { $a->_date <=> $b->_date }
649 qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum,
655 sub cust_credit_bill_pkgnum {
656 shift->cust_credited_pkgnum(@_);
661 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
668 my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
670 foreach (@taxlines) { $total += $_->setup; }
676 Returns the amount owed (still outstanding) on this invoice, which is charged
677 minus all payment applications (see L<FS::cust_bill_pay>) and credit
678 applications (see L<FS::cust_credit_bill>).
684 my $balance = $self->charged;
685 $balance -= $_->amount foreach ( $self->cust_bill_pay );
686 $balance -= $_->amount foreach ( $self->cust_credited );
687 $balance = sprintf( "%.2f", $balance);
688 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
693 my( $self, $pkgnum ) = @_;
695 #my $balance = $self->charged;
697 $balance += $_->setup + $_->recur for $self->cust_bill_pkg_pkgnum($pkgnum);
699 $balance -= $_->amount for $self->cust_bill_pay_pkgnum($pkgnum);
700 $balance -= $_->amount for $self->cust_credited_pkgnum($pkgnum);
702 $balance = sprintf( "%.2f", $balance);
703 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
707 =item apply_payments_and_credits [ OPTION => VALUE ... ]
709 Applies unapplied payments and credits to this invoice.
711 A hash of optional arguments may be passed. Currently "manual" is supported.
712 If true, a payment receipt is sent instead of a statement when
713 'payment_receipt_email' configuration option is set.
715 If there is an error, returns the error, otherwise returns false.
719 sub apply_payments_and_credits {
720 my( $self, %options ) = @_;
722 local $SIG{HUP} = 'IGNORE';
723 local $SIG{INT} = 'IGNORE';
724 local $SIG{QUIT} = 'IGNORE';
725 local $SIG{TERM} = 'IGNORE';
726 local $SIG{TSTP} = 'IGNORE';
727 local $SIG{PIPE} = 'IGNORE';
729 my $oldAutoCommit = $FS::UID::AutoCommit;
730 local $FS::UID::AutoCommit = 0;
733 $self->select_for_update; #mutex
735 my @payments = grep { $_->unapplied > 0 } $self->cust_main->cust_pay;
736 my @credits = grep { $_->credited > 0 } $self->cust_main->cust_credit;
738 if ( $conf->exists('pkg-balances') ) {
739 # limit @payments & @credits to those w/ a pkgnum grepped from $self
740 my %pkgnums = map { $_ => 1 } map $_->pkgnum, $self->cust_bill_pkg;
741 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
742 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
745 while ( $self->owed > 0 and ( @payments || @credits ) ) {
748 if ( @payments && @credits ) {
750 #decide which goes first by weight of top (unapplied) line item
752 my @open_lineitems = $self->open_cust_bill_pkg;
755 max( map { $_->part_pkg->pay_weight || 0 }
760 my $max_credit_weight =
761 max( map { $_->part_pkg->credit_weight || 0 }
767 #if both are the same... payments first? it has to be something
768 if ( $max_pay_weight >= $max_credit_weight ) {
774 } elsif ( @payments ) {
776 } elsif ( @credits ) {
779 die "guru meditation #12 and 35";
783 if ( $app eq 'pay' ) {
785 my $payment = shift @payments;
786 $unapp_amount = $payment->unapplied;
787 $app = new FS::cust_bill_pay { 'paynum' => $payment->paynum };
788 $app->pkgnum( $payment->pkgnum )
789 if $conf->exists('pkg-balances') && $payment->pkgnum;
791 } elsif ( $app eq 'credit' ) {
793 my $credit = shift @credits;
794 $unapp_amount = $credit->credited;
795 $app = new FS::cust_credit_bill { 'crednum' => $credit->crednum };
796 $app->pkgnum( $credit->pkgnum )
797 if $conf->exists('pkg-balances') && $credit->pkgnum;
800 die "guru meditation #12 and 35";
804 if ( $conf->exists('pkg-balances') && $app->pkgnum ) {
805 warn "owed_pkgnum ". $app->pkgnum;
806 $owed = $self->owed_pkgnum($app->pkgnum);
810 next unless $owed > 0;
812 warn "min ( $unapp_amount, $owed )\n" if $DEBUG;
813 $app->amount( sprintf('%.2f', min( $unapp_amount, $owed ) ) );
815 $app->invnum( $self->invnum );
817 my $error = $app->insert(%options);
819 $dbh->rollback if $oldAutoCommit;
820 return "Error inserting ". $app->table. " record: $error";
822 die $error if $error;
826 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
831 =item generate_email OPTION => VALUE ...
839 sender address, required
843 alternate template name, optional
847 text attachment arrayref, optional
851 email subject, optional
855 notice name instead of "Invoice", optional
859 Returns an argument list to be passed to L<FS::Misc::send_email>.
870 my $me = '[FS::cust_bill::generate_email]';
873 'from' => $args{'from'},
874 'subject' => (($args{'subject'}) ? $args{'subject'} : 'Invoice'),
878 'unsquelch_cdr' => $conf->exists('voip-cdr_email'),
879 'template' => $args{'template'},
880 'notice_name' => ( $args{'notice_name'} || 'Invoice' ),
883 my $cust_main = $self->cust_main;
885 if (ref($args{'to'}) eq 'ARRAY') {
886 $return{'to'} = $args{'to'};
888 $return{'to'} = [ grep { $_ !~ /^(POST|FAX)$/ }
889 $cust_main->invoicing_list
893 if ( $conf->exists('invoice_html') ) {
895 warn "$me creating HTML/text multipart message"
898 $return{'nobody'} = 1;
900 my $alternative = build MIME::Entity
901 'Type' => 'multipart/alternative',
902 'Encoding' => '7bit',
903 'Disposition' => 'inline'
907 if ( $conf->exists('invoice_email_pdf')
908 and scalar($conf->config('invoice_email_pdf_note')) ) {
910 warn "$me using 'invoice_email_pdf_note' in multipart message"
912 $data = [ map { $_ . "\n" }
913 $conf->config('invoice_email_pdf_note')
918 warn "$me not using 'invoice_email_pdf_note' in multipart message"
920 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
921 $data = $args{'print_text'};
923 $data = [ $self->print_text(\%opt) ];
928 $alternative->attach(
929 'Type' => 'text/plain',
930 #'Encoding' => 'quoted-printable',
931 'Encoding' => '7bit',
933 'Disposition' => 'inline',
936 $args{'from'} =~ /\@([\w\.\-]+)/;
937 my $from = $1 || 'example.com';
938 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
941 my $agentnum = $cust_main->agentnum;
942 if ( defined($args{'template'}) && length($args{'template'})
943 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
946 $logo = 'logo_'. $args{'template'}. '.png';
950 my $image_data = $conf->config_binary( $logo, $agentnum);
952 my $image = build MIME::Entity
953 'Type' => 'image/png',
954 'Encoding' => 'base64',
955 'Data' => $image_data,
956 'Filename' => 'logo.png',
957 'Content-ID' => "<$content_id>",
960 $alternative->attach(
961 'Type' => 'text/html',
962 'Encoding' => 'quoted-printable',
963 'Data' => [ '<html>',
966 ' '. encode_entities($return{'subject'}),
969 ' <body bgcolor="#e8e8e8">',
970 $self->print_html({ 'cid'=>$content_id, %opt }),
974 'Disposition' => 'inline',
975 #'Filename' => 'invoice.pdf',
979 if ( $cust_main->email_csv_cdr ) {
981 push @otherparts, build MIME::Entity
982 'Type' => 'text/csv',
983 'Encoding' => '7bit',
984 'Data' => [ map { "$_\n" }
985 $self->call_details('prepend_billed_number' => 1)
987 'Disposition' => 'attachment',
988 'Filename' => 'usage-'. $self->invnum. '.csv',
993 if ( $conf->exists('invoice_email_pdf') ) {
998 # multipart/alternative
1004 my $related = build MIME::Entity 'Type' => 'multipart/related',
1005 'Encoding' => '7bit';
1007 #false laziness w/Misc::send_email
1008 $related->head->replace('Content-type',
1009 $related->mime_type.
1010 '; boundary="'. $related->head->multipart_boundary. '"'.
1011 '; type=multipart/alternative'
1014 $related->add_part($alternative);
1016 $related->add_part($image);
1018 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%opt);
1020 $return{'mimeparts'} = [ $related, $pdf, @otherparts ];
1024 #no other attachment:
1026 # multipart/alternative
1031 $return{'content-type'} = 'multipart/related';
1032 $return{'mimeparts'} = [ $alternative, $image, @otherparts ];
1033 $return{'type'} = 'multipart/alternative'; #Content-Type of first part...
1034 #$return{'disposition'} = 'inline';
1040 if ( $conf->exists('invoice_email_pdf') ) {
1041 warn "$me creating PDF attachment"
1044 #mime parts arguments a la MIME::Entity->build().
1045 $return{'mimeparts'} = [
1046 { $self->mimebuild_pdf(\%opt) }
1050 if ( $conf->exists('invoice_email_pdf')
1051 and scalar($conf->config('invoice_email_pdf_note')) ) {
1053 warn "$me using 'invoice_email_pdf_note'"
1055 $return{'body'} = [ map { $_ . "\n" }
1056 $conf->config('invoice_email_pdf_note')
1061 warn "$me not using 'invoice_email_pdf_note'"
1063 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1064 $return{'body'} = $args{'print_text'};
1066 $return{'body'} = [ $self->print_text(\%opt) ];
1079 Returns a list suitable for passing to MIME::Entity->build(), representing
1080 this invoice as PDF attachment.
1087 'Type' => 'application/pdf',
1088 'Encoding' => 'base64',
1089 'Data' => [ $self->print_pdf(@_) ],
1090 'Disposition' => 'attachment',
1091 'Filename' => 'invoice-'. $self->invnum. '.pdf',
1095 =item send HASHREF | [ TEMPLATE [ , AGENTNUM [ , INVOICE_FROM [ , AMOUNT ] ] ] ]
1097 Sends this invoice to the destinations configured for this customer: sends
1098 email, prints and/or faxes. See L<FS::cust_main_invoice>.
1100 Options can be passed as a hashref (recommended) or as a list of up to
1101 four values for templatename, agentnum, invoice_from and amount.
1103 I<template>, if specified, is the name of a suffix for alternate invoices.
1105 I<agentnum>, if specified, means that this invoice will only be sent for customers
1106 of the specified agent or agent(s). AGENTNUM can be a scalar agentnum (for a
1107 single agent) or an arrayref of agentnums.
1109 I<invoice_from>, if specified, overrides the default email invoice From: address.
1111 I<amount>, if specified, only sends the invoice if the total amount owed on this
1112 invoice and all older invoices is greater than the specified amount.
1114 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1118 sub queueable_send {
1121 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1122 or die "invalid invoice number: " . $opt{invnum};
1124 my @args = ( $opt{template}, $opt{agentnum} );
1125 push @args, $opt{invoice_from}
1126 if exists($opt{invoice_from}) && $opt{invoice_from};
1128 my $error = $self->send( @args );
1129 die $error if $error;
1136 my( $template, $invoice_from, $notice_name );
1138 my $balance_over = 0;
1142 $template = $opt->{'template'} || '';
1143 if ( $agentnums = $opt->{'agentnum'} ) {
1144 $agentnums = [ $agentnums ] unless ref($agentnums);
1146 $invoice_from = $opt->{'invoice_from'};
1147 $balance_over = $opt->{'balance_over'} if $opt->{'balance_over'};
1148 $notice_name = $opt->{'notice_name'};
1150 $template = scalar(@_) ? shift : '';
1151 if ( scalar(@_) && $_[0] ) {
1152 $agentnums = ref($_[0]) ? shift : [ shift ];
1154 $invoice_from = shift if scalar(@_);
1155 $balance_over = shift if scalar(@_) && $_[0] !~ /^\s*$/;
1158 return 'N/A' unless ! $agentnums
1159 or grep { $_ == $self->cust_main->agentnum } @$agentnums;
1162 unless $self->cust_main->total_owed_date($self->_date) > $balance_over;
1164 $invoice_from ||= $self->_agent_invoice_from || #XXX should go away
1165 $conf->config('invoice_from', $self->cust_main->agentnum );
1168 'template' => $template,
1169 'invoice_from' => $invoice_from,
1170 'notice_name' => ( $notice_name || 'Invoice' ),
1173 my @invoicing_list = $self->cust_main->invoicing_list;
1175 #$self->email_invoice(\%opt)
1177 if grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list;
1179 #$self->print_invoice(\%opt)
1181 if grep { $_ eq 'POST' } @invoicing_list; #postal
1183 $self->fax_invoice(\%opt)
1184 if grep { $_ eq 'FAX' } @invoicing_list; #fax
1190 =item email HASHREF | [ TEMPLATE [ , INVOICE_FROM ] ]
1192 Emails this invoice.
1194 Options can be passed as a hashref (recommended) or as a list of up to
1195 two values for templatename and invoice_from.
1197 I<template>, if specified, is the name of a suffix for alternate invoices.
1199 I<invoice_from>, if specified, overrides the default email invoice From: address.
1201 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1205 sub queueable_email {
1208 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1209 or die "invalid invoice number: " . $opt{invnum};
1211 my @args = ( $opt{template} );
1212 push @args, $opt{invoice_from}
1213 if exists($opt{invoice_from}) && $opt{invoice_from};
1215 my $error = $self->email( @args );
1216 die $error if $error;
1220 #sub email_invoice {
1224 my( $template, $invoice_from, $notice_name );
1227 $template = $opt->{'template'} || '';
1228 $invoice_from = $opt->{'invoice_from'};
1229 $notice_name = $opt->{'notice_name'} || 'Invoice';
1231 $template = scalar(@_) ? shift : '';
1232 $invoice_from = shift if scalar(@_);
1233 $notice_name = 'Invoice';
1236 $invoice_from ||= $self->_agent_invoice_from || #XXX should go away
1237 $conf->config('invoice_from', $self->cust_main->agentnum );
1239 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
1240 $self->cust_main->invoicing_list;
1242 #better to notify this person than silence
1243 @invoicing_list = ($invoice_from) unless @invoicing_list;
1245 my $subject = $self->email_subject($template);
1247 my $error = send_email(
1248 $self->generate_email(
1249 'from' => $invoice_from,
1250 'to' => [ grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list ],
1251 'subject' => $subject,
1252 'template' => $template,
1253 'notice_name' => $notice_name,
1256 die "can't email invoice: $error\n" if $error;
1257 #die "$error\n" if $error;
1264 #my $template = scalar(@_) ? shift : '';
1267 my $subject = $conf->config('invoice_subject', $self->cust_main->agentnum)
1270 my $cust_main = $self->cust_main;
1271 my $name = $cust_main->name;
1272 my $name_short = $cust_main->name_short;
1273 my $invoice_number = $self->invnum;
1274 my $invoice_date = $self->_date_pretty;
1276 eval qq("$subject");
1279 =item lpr_data HASHREF | [ TEMPLATE ]
1281 Returns the postscript or plaintext for this invoice as an arrayref.
1283 Options can be passed as a hashref (recommended) or as a single optional value
1286 I<template>, if specified, is the name of a suffix for alternate invoices.
1288 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1294 my( $template, $notice_name );
1297 $template = $opt->{'template'} || '';
1298 $notice_name = $opt->{'notice_name'} || 'Invoice';
1300 $template = scalar(@_) ? shift : '';
1301 $notice_name = 'Invoice';
1305 'template' => $template,
1306 'notice_name' => $notice_name,
1309 my $method = $conf->exists('invoice_latex') ? 'print_ps' : 'print_text';
1310 [ $self->$method( \%opt ) ];
1313 =item print HASHREF | [ TEMPLATE ]
1315 Prints this invoice.
1317 Options can be passed as a hashref (recommended) or as a single optional
1320 I<template>, if specified, is the name of a suffix for alternate invoices.
1322 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1326 #sub print_invoice {
1329 my( $template, $notice_name );
1332 $template = $opt->{'template'} || '';
1333 $notice_name = $opt->{'notice_name'} || 'Invoice';
1335 $template = scalar(@_) ? shift : '';
1336 $notice_name = 'Invoice';
1340 'template' => $template,
1341 'notice_name' => $notice_name,
1344 if($conf->exists('invoice_print_pdf')) {
1345 # Add the invoice to the current batch.
1346 $self->batch_invoice(\%opt);
1349 do_print $self->lpr_data(\%opt);
1353 =item fax_invoice HASHREF | [ TEMPLATE ]
1357 Options can be passed as a hashref (recommended) or as a single optional
1360 I<template>, if specified, is the name of a suffix for alternate invoices.
1362 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1368 my( $template, $notice_name );
1371 $template = $opt->{'template'} || '';
1372 $notice_name = $opt->{'notice_name'} || 'Invoice';
1374 $template = scalar(@_) ? shift : '';
1375 $notice_name = 'Invoice';
1378 die 'FAX invoice destination not (yet?) supported with plain text invoices.'
1379 unless $conf->exists('invoice_latex');
1381 my $dialstring = $self->cust_main->getfield('fax');
1385 'template' => $template,
1386 'notice_name' => $notice_name,
1389 my $error = send_fax( 'docdata' => $self->lpr_data(\%opt),
1390 'dialstring' => $dialstring,
1392 die $error if $error;
1396 =item batch_invoice [ HASHREF ]
1398 Place this invoice into the open batch (see C<FS::bill_batch>). If there
1399 isn't an open batch, one will be created.
1404 my ($self, $opt) = @_;
1405 my $batch = FS::bill_batch->get_open_batch;
1406 my $cust_bill_batch = FS::cust_bill_batch->new({
1407 batchnum => $batch->batchnum,
1408 invnum => $self->invnum,
1410 return $cust_bill_batch->insert($opt);
1413 =item ftp_invoice [ TEMPLATENAME ]
1415 Sends this invoice data via FTP.
1417 TEMPLATENAME is unused?
1423 my $template = scalar(@_) ? shift : '';
1426 'protocol' => 'ftp',
1427 'server' => $conf->config('cust_bill-ftpserver'),
1428 'username' => $conf->config('cust_bill-ftpusername'),
1429 'password' => $conf->config('cust_bill-ftppassword'),
1430 'dir' => $conf->config('cust_bill-ftpdir'),
1431 'format' => $conf->config('cust_bill-ftpformat'),
1435 =item spool_invoice [ TEMPLATENAME ]
1437 Spools this invoice data (see L<FS::spool_csv>)
1439 TEMPLATENAME is unused?
1445 my $template = scalar(@_) ? shift : '';
1448 'format' => $conf->config('cust_bill-spoolformat'),
1449 'agent_spools' => $conf->exists('cust_bill-spoolagent'),
1453 =item send_if_newest [ TEMPLATENAME [ , AGENTNUM [ , INVOICE_FROM ] ] ]
1455 Like B<send>, but only sends the invoice if it is the newest open invoice for
1460 sub send_if_newest {
1465 grep { $_->owed > 0 }
1466 qsearch('cust_bill', {
1467 'custnum' => $self->custnum,
1468 #'_date' => { op=>'>', value=>$self->_date },
1469 'invnum' => { op=>'>', value=>$self->invnum },
1476 =item send_csv OPTION => VALUE, ...
1478 Sends invoice as a CSV data-file to a remote host with the specified protocol.
1482 protocol - currently only "ftp"
1488 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
1489 and YYMMDDHHMMSS is a timestamp.
1491 See L</print_csv> for a description of the output format.
1496 my($self, %opt) = @_;
1500 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1501 mkdir $spooldir, 0700 unless -d $spooldir;
1503 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1504 my $file = "$spooldir/$tracctnum.csv";
1506 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1508 open(CSV, ">$file") or die "can't open $file: $!";
1516 if ( $opt{protocol} eq 'ftp' ) {
1517 eval "use Net::FTP;";
1519 $net = Net::FTP->new($opt{server}) or die @$;
1521 die "unknown protocol: $opt{protocol}";
1524 $net->login( $opt{username}, $opt{password} )
1525 or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
1527 $net->binary or die "can't set binary mode";
1529 $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
1531 $net->put($file) or die "can't put $file: $!";
1541 Spools CSV invoice data.
1547 =item format - 'default' or 'billco'
1549 =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>).
1551 =item agent_spools - if set to a true value, will spool to per-agent files rather than a single global file
1553 =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.
1560 my($self, %opt) = @_;
1562 my $cust_main = $self->cust_main;
1564 if ( $opt{'dest'} ) {
1565 my %invoicing_list = map { /^(POST|FAX)$/ or 'EMAIL' =~ /^(.*)$/; $1 => 1 }
1566 $cust_main->invoicing_list;
1567 return 'N/A' unless $invoicing_list{$opt{'dest'}}
1568 || ! keys %invoicing_list;
1571 if ( $opt{'balanceover'} ) {
1573 if $cust_main->total_owed_date($self->_date) < $opt{'balanceover'};
1576 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1577 mkdir $spooldir, 0700 unless -d $spooldir;
1579 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1583 ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1584 ( lc($opt{'format'}) eq 'billco' ? '-header' : '' ) .
1587 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1589 open(CSV, ">>$file") or die "can't open $file: $!";
1590 flock(CSV, LOCK_EX);
1595 if ( lc($opt{'format'}) eq 'billco' ) {
1597 flock(CSV, LOCK_UN);
1602 ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1605 open(CSV,">>$file") or die "can't open $file: $!";
1606 flock(CSV, LOCK_EX);
1612 flock(CSV, LOCK_UN);
1619 =item print_csv OPTION => VALUE, ...
1621 Returns CSV data for this invoice.
1625 format - 'default' or 'billco'
1627 Returns a list consisting of two scalars. The first is a single line of CSV
1628 header information for this invoice. The second is one or more lines of CSV
1629 detail information for this invoice.
1631 If I<format> is not specified or "default", the fields of the CSV file are as
1634 record_type, invnum, custnum, _date, charged, first, last, company, address1, address2, city, state, zip, country, pkg, setup, recur, sdate, edate
1638 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
1640 B<record_type> is C<cust_bill> for the initial header line only. The
1641 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
1642 fields are filled in.
1644 B<record_type> is C<cust_bill_pkg> for detail lines. Only the first two fields
1645 (B<record_type> and B<invnum>) and the last five fields (B<pkg> through B<edate>)
1648 =item invnum - invoice number
1650 =item custnum - customer number
1652 =item _date - invoice date
1654 =item charged - total invoice amount
1656 =item first - customer first name
1658 =item last - customer first name
1660 =item company - company name
1662 =item address1 - address line 1
1664 =item address2 - address line 1
1674 =item pkg - line item description
1676 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
1678 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
1680 =item sdate - start date for recurring fee
1682 =item edate - end date for recurring fee
1686 If I<format> is "billco", the fields of the header CSV file are as follows:
1688 +-------------------------------------------------------------------+
1689 | FORMAT HEADER FILE |
1690 |-------------------------------------------------------------------|
1691 | Field | Description | Name | Type | Width |
1692 | 1 | N/A-Leave Empty | RC | CHAR | 2 |
1693 | 2 | N/A-Leave Empty | CUSTID | CHAR | 15 |
1694 | 3 | Transaction Account No | TRACCTNUM | CHAR | 15 |
1695 | 4 | Transaction Invoice No | TRINVOICE | CHAR | 15 |
1696 | 5 | Transaction Zip Code | TRZIP | CHAR | 5 |
1697 | 6 | Transaction Company Bill To | TRCOMPANY | CHAR | 30 |
1698 | 7 | Transaction Contact Bill To | TRNAME | CHAR | 30 |
1699 | 8 | Additional Address Unit Info | TRADDR1 | CHAR | 30 |
1700 | 9 | Bill To Street Address | TRADDR2 | CHAR | 30 |
1701 | 10 | Ancillary Billing Information | TRADDR3 | CHAR | 30 |
1702 | 11 | Transaction City Bill To | TRCITY | CHAR | 20 |
1703 | 12 | Transaction State Bill To | TRSTATE | CHAR | 2 |
1704 | 13 | Bill Cycle Close Date | CLOSEDATE | CHAR | 10 |
1705 | 14 | Bill Due Date | DUEDATE | CHAR | 10 |
1706 | 15 | Previous Balance | BALFWD | NUM* | 9 |
1707 | 16 | Pmt/CR Applied | CREDAPPLY | NUM* | 9 |
1708 | 17 | Total Current Charges | CURRENTCHG | NUM* | 9 |
1709 | 18 | Total Amt Due | TOTALDUE | NUM* | 9 |
1710 | 19 | Total Amt Due | AMTDUE | NUM* | 9 |
1711 | 20 | 30 Day Aging | AMT30 | NUM* | 9 |
1712 | 21 | 60 Day Aging | AMT60 | NUM* | 9 |
1713 | 22 | 90 Day Aging | AMT90 | NUM* | 9 |
1714 | 23 | Y/N | AGESWITCH | CHAR | 1 |
1715 | 24 | Remittance automation | SCANLINE | CHAR | 100 |
1716 | 25 | Total Taxes & Fees | TAXTOT | NUM* | 9 |
1717 | 26 | Customer Reference Number | CUSTREF | CHAR | 15 |
1718 | 27 | Federal Tax*** | FEDTAX | NUM* | 9 |
1719 | 28 | State Tax*** | STATETAX | NUM* | 9 |
1720 | 29 | Other Taxes & Fees*** | OTHERTAX | NUM* | 9 |
1721 +-------+-------------------------------+------------+------+-------+
1723 If I<format> is "billco", the fields of the detail CSV file are as follows:
1725 FORMAT FOR DETAIL FILE
1727 Field | Description | Name | Type | Width
1728 1 | N/A-Leave Empty | RC | CHAR | 2
1729 2 | N/A-Leave Empty | CUSTID | CHAR | 15
1730 3 | Account Number | TRACCTNUM | CHAR | 15
1731 4 | Invoice Number | TRINVOICE | CHAR | 15
1732 5 | Line Sequence (sort order) | LINESEQ | NUM | 6
1733 6 | Transaction Detail | DETAILS | CHAR | 100
1734 7 | Amount | AMT | NUM* | 9
1735 8 | Line Format Control** | LNCTRL | CHAR | 2
1736 9 | Grouping Code | GROUP | CHAR | 2
1737 10 | User Defined | ACCT CODE | CHAR | 15
1742 my($self, %opt) = @_;
1744 eval "use Text::CSV_XS";
1747 my $cust_main = $self->cust_main;
1749 my $csv = Text::CSV_XS->new({'always_quote'=>1});
1751 if ( lc($opt{'format'}) eq 'billco' ) {
1754 $taxtotal += $_->{'amount'} foreach $self->_items_tax;
1756 my $duedate = $self->due_date2str('%m/%d/%Y'); #date_format?
1758 my( $previous_balance, @unused ) = $self->previous; #previous balance
1760 my $pmt_cr_applied = 0;
1761 $pmt_cr_applied += $_->{'amount'}
1762 foreach ( $self->_items_payments, $self->_items_credits ) ;
1764 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
1767 '', # 1 | N/A-Leave Empty CHAR 2
1768 '', # 2 | N/A-Leave Empty CHAR 15
1769 $opt{'tracctnum'}, # 3 | Transaction Account No CHAR 15
1770 $self->invnum, # 4 | Transaction Invoice No CHAR 15
1771 $cust_main->zip, # 5 | Transaction Zip Code CHAR 5
1772 $cust_main->company, # 6 | Transaction Company Bill To CHAR 30
1773 #$cust_main->payname, # 7 | Transaction Contact Bill To CHAR 30
1774 $cust_main->contact, # 7 | Transaction Contact Bill To CHAR 30
1775 $cust_main->address2, # 8 | Additional Address Unit Info CHAR 30
1776 $cust_main->address1, # 9 | Bill To Street Address CHAR 30
1777 '', # 10 | Ancillary Billing Information CHAR 30
1778 $cust_main->city, # 11 | Transaction City Bill To CHAR 20
1779 $cust_main->state, # 12 | Transaction State Bill To CHAR 2
1782 time2str("%m/%d/%Y", $self->_date), # 13 | Bill Cycle Close Date CHAR 10
1785 $duedate, # 14 | Bill Due Date CHAR 10
1787 $previous_balance, # 15 | Previous Balance NUM* 9
1788 $pmt_cr_applied, # 16 | Pmt/CR Applied NUM* 9
1789 sprintf("%.2f", $self->charged), # 17 | Total Current Charges NUM* 9
1790 $totaldue, # 18 | Total Amt Due NUM* 9
1791 $totaldue, # 19 | Total Amt Due NUM* 9
1792 '', # 20 | 30 Day Aging NUM* 9
1793 '', # 21 | 60 Day Aging NUM* 9
1794 '', # 22 | 90 Day Aging NUM* 9
1795 'N', # 23 | Y/N CHAR 1
1796 '', # 24 | Remittance automation CHAR 100
1797 $taxtotal, # 25 | Total Taxes & Fees NUM* 9
1798 $self->custnum, # 26 | Customer Reference Number CHAR 15
1799 '0', # 27 | Federal Tax*** NUM* 9
1800 sprintf("%.2f", $taxtotal), # 28 | State Tax*** NUM* 9
1801 '0', # 29 | Other Taxes & Fees*** NUM* 9
1810 time2str("%x", $self->_date),
1811 sprintf("%.2f", $self->charged),
1812 ( map { $cust_main->getfield($_) }
1813 qw( first last company address1 address2 city state zip country ) ),
1815 ) or die "can't create csv";
1818 my $header = $csv->string. "\n";
1821 if ( lc($opt{'format'}) eq 'billco' ) {
1824 foreach my $item ( $self->_items_pkg ) {
1827 '', # 1 | N/A-Leave Empty CHAR 2
1828 '', # 2 | N/A-Leave Empty CHAR 15
1829 $opt{'tracctnum'}, # 3 | Account Number CHAR 15
1830 $self->invnum, # 4 | Invoice Number CHAR 15
1831 $lineseq++, # 5 | Line Sequence (sort order) NUM 6
1832 $item->{'description'}, # 6 | Transaction Detail CHAR 100
1833 $item->{'amount'}, # 7 | Amount NUM* 9
1834 '', # 8 | Line Format Control** CHAR 2
1835 '', # 9 | Grouping Code CHAR 2
1836 '', # 10 | User Defined CHAR 15
1839 $detail .= $csv->string. "\n";
1845 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1847 my($pkg, $setup, $recur, $sdate, $edate);
1848 if ( $cust_bill_pkg->pkgnum ) {
1850 ($pkg, $setup, $recur, $sdate, $edate) = (
1851 $cust_bill_pkg->part_pkg->pkg,
1852 ( $cust_bill_pkg->setup != 0
1853 ? sprintf("%.2f", $cust_bill_pkg->setup )
1855 ( $cust_bill_pkg->recur != 0
1856 ? sprintf("%.2f", $cust_bill_pkg->recur )
1858 ( $cust_bill_pkg->sdate
1859 ? time2str("%x", $cust_bill_pkg->sdate)
1861 ($cust_bill_pkg->edate
1862 ?time2str("%x", $cust_bill_pkg->edate)
1866 } else { #pkgnum tax
1867 next unless $cust_bill_pkg->setup != 0;
1868 $pkg = $cust_bill_pkg->desc;
1869 $setup = sprintf('%10.2f', $cust_bill_pkg->setup );
1870 ( $sdate, $edate ) = ( '', '' );
1876 ( map { '' } (1..11) ),
1877 ($pkg, $setup, $recur, $sdate, $edate)
1878 ) or die "can't create csv";
1880 $detail .= $csv->string. "\n";
1886 ( $header, $detail );
1892 Pays this invoice with a compliemntary payment. If there is an error,
1893 returns the error, otherwise returns false.
1899 my $cust_pay = new FS::cust_pay ( {
1900 'invnum' => $self->invnum,
1901 'paid' => $self->owed,
1904 'payinfo' => $self->cust_main->payinfo,
1912 Attempts to pay this invoice with a credit card payment via a
1913 Business::OnlinePayment realtime gateway. See
1914 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1915 for supported processors.
1921 $self->realtime_bop( 'CC', @_ );
1926 Attempts to pay this invoice with an electronic check (ACH) payment via a
1927 Business::OnlinePayment realtime gateway. See
1928 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1929 for supported processors.
1935 $self->realtime_bop( 'ECHECK', @_ );
1940 Attempts to pay this invoice with phone bill (LEC) payment via a
1941 Business::OnlinePayment realtime gateway. See
1942 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1943 for supported processors.
1949 $self->realtime_bop( 'LEC', @_ );
1953 my( $self, $method ) = @_;
1955 my $cust_main = $self->cust_main;
1956 my $balance = $cust_main->balance;
1957 my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
1958 $amount = sprintf("%.2f", $amount);
1959 return "not run (balance $balance)" unless $amount > 0;
1961 my $description = 'Internet Services';
1962 if ( $conf->exists('business-onlinepayment-description') ) {
1963 my $dtempl = $conf->config('business-onlinepayment-description');
1965 my $agent_obj = $cust_main->agent
1966 or die "can't retreive agent for $cust_main (agentnum ".
1967 $cust_main->agentnum. ")";
1968 my $agent = $agent_obj->agent;
1969 my $pkgs = join(', ',
1970 map { $_->part_pkg->pkg }
1971 grep { $_->pkgnum } $self->cust_bill_pkg
1973 $description = eval qq("$dtempl");
1976 $cust_main->realtime_bop($method, $amount,
1977 'description' => $description,
1978 'invnum' => $self->invnum,
1979 #this didn't do what we want, it just calls apply_payments_and_credits
1981 'apply_to_invoice' => 1,
1983 #this changes application behavior: auto payments
1984 #triggered against a specific invoice are now applied
1985 #to that invoice instead of oldest open.
1991 =item batch_card OPTION => VALUE...
1993 Adds a payment for this invoice to the pending credit card batch (see
1994 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
1995 runs the payment using a realtime gateway.
2000 my ($self, %options) = @_;
2001 my $cust_main = $self->cust_main;
2003 $options{invnum} = $self->invnum;
2005 $cust_main->batch_card(%options);
2008 sub _agent_template {
2010 $self->cust_main->agent_template;
2013 sub _agent_invoice_from {
2015 $self->cust_main->agent_invoice_from;
2018 =item print_text HASHREF | [ TIME [ , TEMPLATE [ , OPTION => VALUE ... ] ] ]
2020 Returns an text invoice, as a list of lines.
2022 Options can be passed as a hashref (recommended) or as a list of time, template
2023 and then any key/value pairs for any other options.
2025 I<time>, if specified, is used to control the printing of overdue messages. The
2026 default is now. It isn't the date of the invoice; that's the `_date' field.
2027 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2028 L<Time::Local> and L<Date::Parse> for conversion functions.
2030 I<template>, if specified, is the name of a suffix for alternate invoices.
2032 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
2038 my( $today, $template, %opt );
2040 %opt = %{ shift() };
2041 $today = delete($opt{'time'}) || '';
2042 $template = delete($opt{template}) || '';
2044 ( $today, $template, %opt ) = @_;
2047 my %params = ( 'format' => 'template' );
2048 $params{'time'} = $today if $today;
2049 $params{'template'} = $template if $template;
2050 $params{$_} = $opt{$_}
2051 foreach grep $opt{$_}, qw( unsquealch_cdr notice_name );
2053 $self->print_generic( %params );
2056 =item print_latex HASHREF | [ TIME [ , TEMPLATE [ , OPTION => VALUE ... ] ] ]
2058 Internal method - returns a filename of a filled-in LaTeX template for this
2059 invoice (Note: add ".tex" to get the actual filename), and a filename of
2060 an associated logo (with the .eps extension included).
2062 See print_ps and print_pdf for methods that return PostScript and PDF output.
2064 Options can be passed as a hashref (recommended) or as a list of time, template
2065 and then any key/value pairs for any other options.
2067 I<time>, if specified, is used to control the printing of overdue messages. The
2068 default is now. It isn't the date of the invoice; that's the `_date' field.
2069 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2070 L<Time::Local> and L<Date::Parse> for conversion functions.
2072 I<template>, if specified, is the name of a suffix for alternate invoices.
2074 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
2080 my( $today, $template, %opt );
2082 %opt = %{ shift() };
2083 $today = delete($opt{'time'}) || '';
2084 $template = delete($opt{template}) || '';
2086 ( $today, $template, %opt ) = @_;
2089 my %params = ( 'format' => 'latex' );
2090 $params{'time'} = $today if $today;
2091 $params{'template'} = $template if $template;
2092 $params{$_} = $opt{$_}
2093 foreach grep $opt{$_}, qw( unsquealch_cdr notice_name );
2095 $template ||= $self->_agent_template;
2097 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2098 my $lh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
2102 ) or die "can't open temp file: $!\n";
2104 my $agentnum = $self->cust_main->agentnum;
2106 if ( $template && $conf->exists("logo_${template}.eps", $agentnum) ) {
2107 print $lh $conf->config_binary("logo_${template}.eps", $agentnum)
2108 or die "can't write temp file: $!\n";
2110 print $lh $conf->config_binary('logo.eps', $agentnum)
2111 or die "can't write temp file: $!\n";
2114 $params{'logo_file'} = $lh->filename;
2116 my @filled_in = $self->print_generic( %params );
2118 my $fh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
2122 ) or die "can't open temp file: $!\n";
2123 print $fh join('', @filled_in );
2126 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
2127 return ($1, $params{'logo_file'});
2131 =item print_generic OPTION => VALUE ...
2133 Internal method - returns a filled-in template for this invoice as a scalar.
2135 See print_ps and print_pdf for methods that return PostScript and PDF output.
2137 Non optional options include
2138 format - latex, html, template
2140 Optional options include
2142 template - a value used as a suffix for a configuration template
2144 time - a value used to control the printing of overdue messages. The
2145 default is now. It isn't the date of the invoice; that's the `_date' field.
2146 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2147 L<Time::Local> and L<Date::Parse> for conversion functions.
2151 unsquelch_cdr - overrides any per customer cdr squelching when true
2153 notice_name - overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
2157 #what's with all the sprintf('%10.2f')'s in here? will it cause any
2158 # (alignment in text invoice?) problems to change them all to '%.2f' ?
2159 # yes: fixed width (dot matrix) text printing will be borked
2162 my( $self, %params ) = @_;
2163 my $today = $params{today} ? $params{today} : time;
2164 warn "$me print_generic called on $self with suffix $params{template}\n"
2167 my $format = $params{format};
2168 die "Unknown format: $format"
2169 unless $format =~ /^(latex|html|template)$/;
2171 my $cust_main = $self->cust_main;
2172 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
2173 unless $cust_main->payname
2174 && $cust_main->payby !~ /^(CARD|DCRD|CHEK|DCHK)$/;
2176 my %delimiters = ( 'latex' => [ '[@--', '--@]' ],
2177 'html' => [ '<%=', '%>' ],
2178 'template' => [ '{', '}' ],
2181 #create the template
2182 my $template = $params{template} ? $params{template} : $self->_agent_template;
2183 my $templatefile = "invoice_$format";
2184 $templatefile .= "_$template"
2185 if length($template);
2186 my @invoice_template = map "$_\n", $conf->config($templatefile)
2187 or die "cannot load config data $templatefile";
2190 if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
2191 #change this to a die when the old code is removed
2192 warn "old-style invoice template $templatefile; ".
2193 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
2194 $old_latex = 'true';
2195 @invoice_template = _translate_old_latex_format(@invoice_template);
2198 my $text_template = new Text::Template(
2200 SOURCE => \@invoice_template,
2201 DELIMITERS => $delimiters{$format},
2204 $text_template->compile()
2205 or die "Can't compile $templatefile: $Text::Template::ERROR\n";
2208 # additional substitution could possibly cause breakage in existing templates
2209 my %convert_maps = (
2211 'notes' => sub { map "$_", @_ },
2212 'footer' => sub { map "$_", @_ },
2213 'smallfooter' => sub { map "$_", @_ },
2214 'returnaddress' => sub { map "$_", @_ },
2215 'coupon' => sub { map "$_", @_ },
2216 'summary' => sub { map "$_", @_ },
2222 s/%%(.*)$/<!-- $1 -->/g;
2223 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
2224 s/\\begin\{enumerate\}/<ol>/g;
2226 s/\\end\{enumerate\}/<\/ol>/g;
2227 s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
2236 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
2238 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
2243 s/\\\\\*?\s*$/<BR>/;
2244 s/\\hyphenation\{[\w\s\-]+}//;
2249 'coupon' => sub { "" },
2250 'summary' => sub { "" },
2257 s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
2258 s/\\begin\{enumerate\}//g;
2260 s/\\end\{enumerate\}//g;
2261 s/\\textbf\{(.*)\}/$1/g;
2268 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
2270 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
2275 s/\\\\\*?\s*$/\n/; # dubious
2276 s/\\hyphenation\{[\w\s\-]+}//;
2280 'coupon' => sub { "" },
2281 'summary' => sub { "" },
2286 # hashes for differing output formats
2287 my %nbsps = ( 'latex' => '~',
2288 'html' => '', # '&nbps;' would be nice
2289 'template' => '', # not used
2291 my $nbsp = $nbsps{$format};
2293 my %escape_functions = ( 'latex' => \&_latex_escape,
2294 'html' => \&encode_entities,
2295 'template' => sub { shift },
2297 my $escape_function = $escape_functions{$format};
2299 my %date_formats = ( 'latex' => '%b %o, %Y',
2300 'html' => '%b %o, %Y',
2303 my $date_format = $date_formats{$format};
2305 my %embolden_functions = ( 'latex' => sub { return '\textbf{'. shift(). '}'
2307 'html' => sub { return '<b>'. shift(). '</b>'
2309 'template' => sub { shift },
2311 my $embolden_function = $embolden_functions{$format};
2314 # generate template variables
2317 defined( $conf->config_orbase( "invoice_${format}returnaddress",
2321 && length( $conf->config_orbase( "invoice_${format}returnaddress",
2327 $returnaddress = join("\n",
2328 $conf->config_orbase("invoice_${format}returnaddress", $template)
2331 } elsif ( grep /\S/,
2332 $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
2334 my $convert_map = $convert_maps{$format}{'returnaddress'};
2337 &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
2342 } elsif ( grep /\S/, $conf->config('company_address', $self->cust_main->agentnum) ) {
2344 my $convert_map = $convert_maps{$format}{'returnaddress'};
2345 $returnaddress = join( "\n", &$convert_map(
2346 map { s/( {2,})/'~' x length($1)/eg;
2350 ( $conf->config('company_name', $self->cust_main->agentnum),
2351 $conf->config('company_address', $self->cust_main->agentnum),
2358 my $warning = "Couldn't find a return address; ".
2359 "do you need to set the company_address configuration value?";
2361 $returnaddress = $nbsp;
2362 #$returnaddress = $warning;
2366 my $agentnum = $self->cust_main->agentnum;
2368 my %invoice_data = (
2371 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
2372 'company_address' => join("\n", $conf->config('company_address', $agentnum) ). "\n",
2373 'returnaddress' => $returnaddress,
2374 'agent' => &$escape_function($cust_main->agent->agent),
2377 'invnum' => $self->invnum,
2378 'date' => time2str($date_format, $self->_date),
2379 'today' => time2str('%b %o, %Y', $today),
2380 'terms' => $self->terms,
2381 'template' => $template, #params{'template'},
2382 'notice_name' => ($params{'notice_name'} || 'Invoice'),#escape_function?
2383 'current_charges' => sprintf("%.2f", $self->charged),
2384 'duedate' => $self->due_date2str($rdate_format), #date_format?
2387 'custnum' => $cust_main->display_custnum,
2388 'agent_custid' => &$escape_function($cust_main->agent_custid),
2389 ( map { $_ => &$escape_function($cust_main->$_()) } qw(
2390 payname company address1 address2 city state zip fax
2394 'ship_enable' => $conf->exists('invoice-ship_address'),
2395 'unitprices' => $conf->exists('invoice-unitprice'),
2396 'smallernotes' => $conf->exists('invoice-smallernotes'),
2397 'smallerfooter' => $conf->exists('invoice-smallerfooter'),
2398 'balance_due_below_line' => $conf->exists('balance_due_below_line'),
2400 #layout info -- would be fancy to calc some of this and bury the template
2402 'topmargin' => scalar($conf->config('invoice_latextopmargin', $agentnum)),
2403 'headsep' => scalar($conf->config('invoice_latexheadsep', $agentnum)),
2404 'textheight' => scalar($conf->config('invoice_latextextheight', $agentnum)),
2405 'extracouponspace' => scalar($conf->config('invoice_latexextracouponspace', $agentnum)),
2406 'couponfootsep' => scalar($conf->config('invoice_latexcouponfootsep', $agentnum)),
2407 'verticalreturnaddress' => $conf->exists('invoice_latexverticalreturnaddress', $agentnum),
2408 'addresssep' => scalar($conf->config('invoice_latexaddresssep', $agentnum)),
2409 'amountenclosedsep' => scalar($conf->config('invoice_latexcouponamountenclosedsep', $agentnum)),
2410 'coupontoaddresssep' => scalar($conf->config('invoice_latexcoupontoaddresssep', $agentnum)),
2411 'addcompanytoaddress' => $conf->exists('invoice_latexcouponaddcompanytoaddress', $agentnum),
2413 # better hang on to conf_dir for a while (for old templates)
2414 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
2416 #these are only used when doing paged plaintext
2422 $invoice_data{finance_section} = '';
2423 if ( $conf->config('finance_pkgclass') ) {
2425 qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
2426 $invoice_data{finance_section} = $pkg_class->categoryname;
2428 $invoice_data{finance_amount} = '0.00';
2429 $invoice_data{finance_section} ||= 'Finance Charges'; #avoid config confusion
2431 my $countrydefault = $conf->config('countrydefault') || 'US';
2432 my $prefix = $cust_main->has_ship_address ? 'ship_' : '';
2433 foreach ( qw( contact company address1 address2 city state zip country fax) ){
2434 my $method = $prefix.$_;
2435 $invoice_data{"ship_$_"} = _latex_escape($cust_main->$method);
2437 $invoice_data{'ship_country'} = ''
2438 if ( $invoice_data{'ship_country'} eq $countrydefault );
2440 $invoice_data{'cid'} = $params{'cid'}
2443 if ( $cust_main->country eq $countrydefault ) {
2444 $invoice_data{'country'} = '';
2446 $invoice_data{'country'} = &$escape_function(code2country($cust_main->country));
2450 $invoice_data{'address'} = \@address;
2452 $cust_main->payname.
2453 ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
2454 ? " (P.O. #". $cust_main->payinfo. ")"
2458 push @address, $cust_main->company
2459 if $cust_main->company;
2460 push @address, $cust_main->address1;
2461 push @address, $cust_main->address2
2462 if $cust_main->address2;
2464 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
2465 push @address, $invoice_data{'country'}
2466 if $invoice_data{'country'};
2468 while (scalar(@address) < 5);
2470 $invoice_data{'logo_file'} = $params{'logo_file'}
2471 if $params{'logo_file'};
2473 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2474 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
2475 #my $balance_due = $self->owed + $pr_total - $cr_total;
2476 my $balance_due = $self->owed + $pr_total;
2477 $invoice_data{'true_previous_balance'} = sprintf("%.2f", ($self->previous_balance || 0) );
2478 $invoice_data{'balance_adjustments'} = sprintf("%.2f", ($self->previous_balance || 0) - ($self->billing_balance || 0) );
2479 $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
2480 $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
2482 my $summarypage = '';
2483 if ( $conf->exists('invoice_usesummary', $agentnum) ) {
2486 $invoice_data{'summarypage'} = $summarypage;
2488 #do variable substitution in notes, footer, smallfooter
2489 foreach my $include (qw( notes footer smallfooter coupon )) {
2491 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
2494 if ( $conf->exists($inc_file, $agentnum)
2495 && length( $conf->config($inc_file, $agentnum) ) ) {
2497 @inc_src = $conf->config($inc_file, $agentnum);
2501 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
2503 my $convert_map = $convert_maps{$format}{$include};
2505 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
2506 s/--\@\]/$delimiters{$format}[1]/g;
2509 &$convert_map( $conf->config($inc_file, $agentnum) );
2513 my $inc_tt = new Text::Template (
2515 SOURCE => [ map "$_\n", @inc_src ],
2516 DELIMITERS => $delimiters{$format},
2517 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
2519 unless ( $inc_tt->compile() ) {
2520 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
2521 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
2525 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
2527 $invoice_data{$include} =~ s/\n+$//
2528 if ($format eq 'latex');
2531 $invoice_data{'po_line'} =
2532 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
2533 ? &$escape_function("Purchase Order #". $cust_main->payinfo)
2536 my %money_chars = ( 'latex' => '',
2537 'html' => $conf->config('money_char') || '$',
2540 my $money_char = $money_chars{$format};
2542 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
2543 'html' => $conf->config('money_char') || '$',
2546 my $other_money_char = $other_money_chars{$format};
2547 $invoice_data{'dollar'} = $other_money_char;
2549 my @detail_items = ();
2550 my @total_items = ();
2554 $invoice_data{'detail_items'} = \@detail_items;
2555 $invoice_data{'total_items'} = \@total_items;
2556 $invoice_data{'buf'} = \@buf;
2557 $invoice_data{'sections'} = \@sections;
2559 my $previous_section = { 'description' => 'Previous Charges',
2560 'subtotal' => $other_money_char.
2561 sprintf('%.2f', $pr_total),
2562 'summarized' => $summarypage ? 'Y' : '',
2564 $previous_section->{posttotal} = '0 / 30 / 60/ 90 days overdue '.
2565 join(' / ', map { $cust_main->balance_date_range(@$_) }
2566 $self->_prior_month30s
2568 if $conf->exists('invoice_include_aging');
2571 my $tax_section = { 'description' => 'Taxes, Surcharges, and Fees',
2572 'subtotal' => $taxtotal, # adjusted below
2573 'summarized' => $summarypage ? 'Y' : '',
2575 my $tax_weight = _pkg_category($tax_section->{description})
2576 ? _pkg_category($tax_section->{description})->weight
2578 $tax_section->{'summarized'} = $summarypage && !$tax_weight ? 'Y' : '';
2579 $tax_section->{'sort_weight'} = $tax_weight;
2582 my $adjusttotal = 0;
2583 my $adjust_section = { 'description' => 'Credits, Payments, and Adjustments',
2584 'subtotal' => 0, # adjusted below
2585 'summarized' => $summarypage ? 'Y' : '',
2587 my $adjust_weight = _pkg_category($adjust_section->{description})
2588 ? _pkg_category($adjust_section->{description})->weight
2590 $adjust_section->{'summarized'} = $summarypage && !$adjust_weight ? 'Y' : '';
2591 $adjust_section->{'sort_weight'} = $adjust_weight;
2593 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
2594 my $multisection = $conf->exists('invoice_sections', $cust_main->agentnum);
2595 $invoice_data{'multisection'} = $multisection;
2596 my $late_sections = [];
2597 my $extra_sections = [];
2598 my $extra_lines = ();
2599 if ( $multisection ) {
2600 ($extra_sections, $extra_lines) =
2601 $self->_items_extra_usage_sections($escape_function, $format)
2602 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum);
2604 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
2606 push @detail_items, @$extra_lines if $extra_lines;
2608 $self->_items_sections( $late_sections, # this could stand a refactor
2614 if ($conf->exists('svc_phone_sections')) {
2615 my ($phone_sections, $phone_lines) =
2616 $self->_items_svc_phone_sections($escape_function, $format);
2617 push @{$late_sections}, @$phone_sections;
2618 push @detail_items, @$phone_lines;
2621 push @sections, { 'description' => '', 'subtotal' => '' };
2624 unless ( $conf->exists('disable_previous_balance')
2625 || $conf->exists('previous_balance-summary_only')
2629 foreach my $line_item ( $self->_items_previous ) {
2632 ext_description => [],
2634 $detail->{'ref'} = $line_item->{'pkgnum'};
2635 $detail->{'quantity'} = 1;
2636 $detail->{'section'} = $previous_section;
2637 $detail->{'description'} = &$escape_function($line_item->{'description'});
2638 if ( exists $line_item->{'ext_description'} ) {
2639 @{$detail->{'ext_description'}} = map {
2640 &$escape_function($_);
2641 } @{$line_item->{'ext_description'}};
2643 $detail->{'amount'} = ( $old_latex ? '' : $money_char).
2644 $line_item->{'amount'};
2645 $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
2647 push @detail_items, $detail;
2648 push @buf, [ $detail->{'description'},
2649 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
2655 if ( @pr_cust_bill && !$conf->exists('disable_previous_balance') ) {
2656 push @buf, ['','-----------'];
2657 push @buf, [ 'Total Previous Balance',
2658 $money_char. sprintf("%10.2f", $pr_total) ];
2662 foreach my $section (@sections, @$late_sections) {
2664 # begin some normalization
2665 $section->{'subtotal'} = $section->{'amount'}
2667 && !exists($section->{subtotal})
2668 && exists($section->{amount});
2670 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
2671 if ( $invoice_data{finance_section} &&
2672 $section->{'description'} eq $invoice_data{finance_section} );
2674 $section->{'subtotal'} = $other_money_char.
2675 sprintf('%.2f', $section->{'subtotal'})
2678 # continue some normalization
2679 $section->{'amount'} = $section->{'subtotal'}
2683 if ( $section->{'description'} ) {
2684 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
2689 my $multilocation = scalar($cust_main->cust_location); #too expensive?
2691 $options{'section'} = $section if $multisection;
2692 $options{'format'} = $format;
2693 $options{'escape_function'} = $escape_function;
2694 $options{'format_function'} = sub { () } unless $unsquelched;
2695 $options{'unsquelched'} = $unsquelched;
2696 $options{'summary_page'} = $summarypage;
2697 $options{'skip_usage'} =
2698 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
2699 $options{'multilocation'} = $multilocation;
2700 $options{'multisection'} = $multisection;
2702 foreach my $line_item ( $self->_items_pkg(%options) ) {
2704 ext_description => [],
2706 $detail->{'ref'} = $line_item->{'pkgnum'};
2707 $detail->{'quantity'} = $line_item->{'quantity'};
2708 $detail->{'section'} = $section;
2709 $detail->{'description'} = &$escape_function($line_item->{'description'});
2710 if ( exists $line_item->{'ext_description'} ) {
2711 @{$detail->{'ext_description'}} = @{$line_item->{'ext_description'}};
2713 $detail->{'amount'} = ( $old_latex ? '' : $money_char ).
2714 $line_item->{'amount'};
2715 $detail->{'unit_amount'} = ( $old_latex ? '' : $money_char ).
2716 $line_item->{'unit_amount'};
2717 $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
2719 push @detail_items, $detail;
2720 push @buf, ( [ $detail->{'description'},
2721 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
2723 map { [ " ". $_, '' ] } @{$detail->{'ext_description'}},
2727 if ( $section->{'description'} ) {
2728 push @buf, ( ['','-----------'],
2729 [ $section->{'description'}. ' sub-total',
2730 $money_char. sprintf("%10.2f", $section->{'subtotal'})
2739 $invoice_data{current_less_finance} =
2740 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
2742 if ( $multisection && !$conf->exists('disable_previous_balance')
2743 || $conf->exists('previous_balance-summary_only') )
2745 unshift @sections, $previous_section if $pr_total;
2748 foreach my $tax ( $self->_items_tax ) {
2750 $taxtotal += $tax->{'amount'};
2752 my $description = &$escape_function( $tax->{'description'} );
2753 my $amount = sprintf( '%.2f', $tax->{'amount'} );
2755 if ( $multisection ) {
2757 my $money = $old_latex ? '' : $money_char;
2758 push @detail_items, {
2759 ext_description => [],
2762 description => $description,
2763 amount => $money. $amount,
2765 section => $tax_section,
2770 push @total_items, {
2771 'total_item' => $description,
2772 'total_amount' => $other_money_char. $amount,
2777 push @buf,[ $description,
2778 $money_char. $amount,
2785 $total->{'total_item'} = 'Sub-total';
2786 $total->{'total_amount'} =
2787 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
2789 if ( $multisection ) {
2790 $tax_section->{'subtotal'} = $other_money_char.
2791 sprintf('%.2f', $taxtotal);
2792 $tax_section->{'pretotal'} = 'New charges sub-total '.
2793 $total->{'total_amount'};
2794 push @sections, $tax_section if $taxtotal;
2796 unshift @total_items, $total;
2799 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
2801 push @buf,['','-----------'];
2802 push @buf,[( $conf->exists('disable_previous_balance')
2804 : 'Total New Charges'
2806 $money_char. sprintf("%10.2f",$self->charged) ];
2812 $item = $conf->config('previous_balance-exclude_from_total')
2813 || 'Total New Charges'
2814 if $conf->exists('previous_balance-exclude_from_total');
2815 my $amount = $self->charged +
2816 ( $conf->exists('disable_previous_balance') ||
2817 $conf->exists('previous_balance-exclude_from_total')
2821 $total->{'total_item'} = &$embolden_function($item);
2822 $total->{'total_amount'} =
2823 &$embolden_function( $other_money_char. sprintf( '%.2f', $amount ) );
2824 if ( $multisection ) {
2825 if ( $adjust_section->{'sort_weight'} ) {
2826 $adjust_section->{'posttotal'} = 'Balance Forward '. $other_money_char.
2827 sprintf("%.2f", ($self->billing_balance || 0) );
2829 $adjust_section->{'pretotal'} = 'New charges total '. $other_money_char.
2830 sprintf('%.2f', $self->charged );
2833 push @total_items, $total;
2835 push @buf,['','-----------'];
2838 sprintf( '%10.2f', $amount )
2843 unless ( $conf->exists('disable_previous_balance') ) {
2844 #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
2847 my $credittotal = 0;
2848 foreach my $credit ( $self->_items_credits('trim_len'=>60) ) {
2851 $total->{'total_item'} = &$escape_function($credit->{'description'});
2852 $credittotal += $credit->{'amount'};
2853 $total->{'total_amount'} = '-'. $other_money_char. $credit->{'amount'};
2854 $adjusttotal += $credit->{'amount'};
2855 if ( $multisection ) {
2856 my $money = $old_latex ? '' : $money_char;
2857 push @detail_items, {
2858 ext_description => [],
2861 description => &$escape_function($credit->{'description'}),
2862 amount => $money. $credit->{'amount'},
2864 section => $adjust_section,
2867 push @total_items, $total;
2871 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
2874 foreach my $credit ( $self->_items_credits('trim_len'=>32) ) {
2875 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
2879 my $paymenttotal = 0;
2880 foreach my $payment ( $self->_items_payments ) {
2882 $total->{'total_item'} = &$escape_function($payment->{'description'});
2883 $paymenttotal += $payment->{'amount'};
2884 $total->{'total_amount'} = '-'. $other_money_char. $payment->{'amount'};
2885 $adjusttotal += $payment->{'amount'};
2886 if ( $multisection ) {
2887 my $money = $old_latex ? '' : $money_char;
2888 push @detail_items, {
2889 ext_description => [],
2892 description => &$escape_function($payment->{'description'}),
2893 amount => $money. $payment->{'amount'},
2895 section => $adjust_section,
2898 push @total_items, $total;
2900 push @buf, [ $payment->{'description'},
2901 $money_char. sprintf("%10.2f", $payment->{'amount'}),
2904 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
2906 if ( $multisection ) {
2907 $adjust_section->{'subtotal'} = $other_money_char.
2908 sprintf('%.2f', $adjusttotal);
2909 push @sections, $adjust_section
2910 unless $adjust_section->{sort_weight};
2915 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
2916 $total->{'total_amount'} =
2917 &$embolden_function(
2918 $other_money_char. sprintf('%.2f', $summarypage
2920 $self->billing_balance
2921 : $self->owed + $pr_total
2924 if ( $multisection && !$adjust_section->{sort_weight} ) {
2925 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
2926 $total->{'total_amount'};
2928 push @total_items, $total;
2930 push @buf,['','-----------'];
2931 push @buf,[$self->balance_due_msg, $money_char.
2932 sprintf("%10.2f", $balance_due ) ];
2936 if ( $multisection ) {
2937 if ($conf->exists('svc_phone_sections')) {
2939 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
2940 $total->{'total_amount'} =
2941 &$embolden_function(
2942 $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
2944 my $last_section = pop @sections;
2945 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
2946 $total->{'total_amount'};
2947 push @sections, $last_section;
2949 push @sections, @$late_sections
2953 my @includelist = ();
2954 push @includelist, 'summary' if $summarypage;
2955 foreach my $include ( @includelist ) {
2957 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
2960 if ( length( $conf->config($inc_file, $agentnum) ) ) {
2962 @inc_src = $conf->config($inc_file, $agentnum);
2966 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
2968 my $convert_map = $convert_maps{$format}{$include};
2970 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
2971 s/--\@\]/$delimiters{$format}[1]/g;
2974 &$convert_map( $conf->config($inc_file, $agentnum) );
2978 my $inc_tt = new Text::Template (
2980 SOURCE => [ map "$_\n", @inc_src ],
2981 DELIMITERS => $delimiters{$format},
2982 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
2984 unless ( $inc_tt->compile() ) {
2985 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
2986 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
2990 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
2992 $invoice_data{$include} =~ s/\n+$//
2993 if ($format eq 'latex');
2998 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
2999 /invoice_lines\((\d*)\)/;
3000 $invoice_lines += $1 || scalar(@buf);
3003 die "no invoice_lines() functions in template?"
3004 if ( $format eq 'template' && !$wasfunc );
3006 if ($format eq 'template') {
3008 if ( $invoice_lines ) {
3009 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
3010 $invoice_data{'total_pages'}++
3011 if scalar(@buf) % $invoice_lines;
3014 #setup subroutine for the template
3015 sub FS::cust_bill::_template::invoice_lines {
3016 my $lines = shift || scalar(@FS::cust_bill::_template::buf);
3018 scalar(@FS::cust_bill::_template::buf)
3019 ? shift @FS::cust_bill::_template::buf
3028 push @collect, split("\n",
3029 $text_template->fill_in( HASH => \%invoice_data,
3030 PACKAGE => 'FS::cust_bill::_template'
3033 $FS::cust_bill::_template::page++;
3035 map "$_\n", @collect;
3037 warn "filling in template for invoice ". $self->invnum. "\n"
3039 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
3042 $text_template->fill_in(HASH => \%invoice_data);
3046 # helper routine for generating date ranges
3047 sub _prior_month30s {
3050 [ 1, 2592000 ], # 0-30 days ago
3051 [ 2592000, 5184000 ], # 30-60 days ago
3052 [ 5184000, 7776000 ], # 60-90 days ago
3053 [ 7776000, 0 ], # 90+ days ago
3056 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
3057 $_->[1] ? $self->_date - $_->[1] - 1 : '',
3062 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
3064 Returns an postscript invoice, as a scalar.
3066 Options can be passed as a hashref (recommended) or as a list of time, template
3067 and then any key/value pairs for any other options.
3069 I<time> an optional value used to control the printing of overdue messages. The
3070 default is now. It isn't the date of the invoice; that's the `_date' field.
3071 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3072 L<Time::Local> and L<Date::Parse> for conversion functions.
3074 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
3081 my ($file, $lfile) = $self->print_latex(@_);
3082 my $ps = generate_ps($file);
3083 unlink($file.'.tex');
3089 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
3091 Returns an PDF invoice, as a scalar.
3093 Options can be passed as a hashref (recommended) or as a list of time, template
3094 and then any key/value pairs for any other options.
3096 I<time> an optional value used to control the printing of overdue messages. The
3097 default is now. It isn't the date of the invoice; that's the `_date' field.
3098 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3099 L<Time::Local> and L<Date::Parse> for conversion functions.
3101 I<template>, if specified, is the name of a suffix for alternate invoices.
3103 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
3110 my ($file, $lfile) = $self->print_latex(@_);
3111 my $pdf = generate_pdf($file);
3112 unlink($file.'.tex');
3118 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
3120 Returns an HTML invoice, as a scalar.
3122 I<time> an optional value used to control the printing of overdue messages. The
3123 default is now. It isn't the date of the invoice; that's the `_date' field.
3124 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3125 L<Time::Local> and L<Date::Parse> for conversion functions.
3127 I<template>, if specified, is the name of a suffix for alternate invoices.
3129 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
3131 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
3132 when emailing the invoice as part of a multipart/related MIME email.
3140 %params = %{ shift() };
3142 $params{'time'} = shift;
3143 $params{'template'} = shift;
3144 $params{'cid'} = shift;
3147 $params{'format'} = 'html';
3149 $self->print_generic( %params );
3152 # quick subroutine for print_latex
3154 # There are ten characters that LaTeX treats as special characters, which
3155 # means that they do not simply typeset themselves:
3156 # # $ % & ~ _ ^ \ { }
3158 # TeX ignores blanks following an escaped character; if you want a blank (as
3159 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
3163 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
3164 $value =~ s/([<>])/\$$1\$/g;
3168 #utility methods for print_*
3170 sub _translate_old_latex_format {
3171 warn "_translate_old_latex_format called\n"
3178 if ( $line =~ /^%%Detail\s*$/ ) {
3180 push @template, q![@--!,
3181 q! foreach my $_tr_line (@detail_items) {!,
3182 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
3183 q! $_tr_line->{'description'} .= !,
3184 q! "\\tabularnewline\n~~".!,
3185 q! join( "\\tabularnewline\n~~",!,
3186 q! @{$_tr_line->{'ext_description'}}!,
3190 while ( ( my $line_item_line = shift )
3191 !~ /^%%EndDetail\s*$/ ) {
3192 $line_item_line =~ s/'/\\'/g; # nice LTS
3193 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
3194 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
3195 push @template, " \$OUT .= '$line_item_line';";
3198 push @template, '}',
3201 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
3203 push @template, '[@--',
3204 ' foreach my $_tr_line (@total_items) {';
3206 while ( ( my $total_item_line = shift )
3207 !~ /^%%EndTotalDetails\s*$/ ) {
3208 $total_item_line =~ s/'/\\'/g; # nice LTS
3209 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
3210 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
3211 push @template, " \$OUT .= '$total_item_line';";
3214 push @template, '}',
3218 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
3219 push @template, $line;
3225 warn "$_\n" foreach @template;
3234 #check for an invoice-specific override
3235 return $self->invoice_terms if $self->invoice_terms;
3237 #check for a customer- specific override
3238 my $cust_main = $self->cust_main;
3239 return $cust_main->invoice_terms if $cust_main->invoice_terms;
3241 #use configured default
3242 $conf->config('invoice_default_terms') || '';
3248 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
3249 $duedate = $self->_date() + ( $1 * 86400 );
3256 $self->due_date ? time2str(shift, $self->due_date) : '';
3259 sub balance_due_msg {
3261 my $msg = 'Balance Due';
3262 return $msg unless $self->terms;
3263 if ( $self->due_date ) {
3264 $msg .= ' - Please pay by '. $self->due_date2str($date_format);
3265 } elsif ( $self->terms ) {
3266 $msg .= ' - '. $self->terms;
3271 sub balance_due_date {
3274 if ( $conf->exists('invoice_default_terms')
3275 && $conf->config('invoice_default_terms')=~ /^\s*Net\s*(\d+)\s*$/ ) {
3276 $duedate = time2str($rdate_format, $self->_date + ($1*86400) );
3281 =item invnum_date_pretty
3283 Returns a string with the invoice number and date, for example:
3284 "Invoice #54 (3/20/2008)"
3288 sub invnum_date_pretty {
3290 'Invoice #'. $self->invnum. ' ('. $self->_date_pretty. ')';
3295 Returns a string with the date, for example: "3/20/2008"
3301 time2str($date_format, $self->_date);
3304 use vars qw(%pkg_category_cache);
3305 sub _items_sections {
3308 my $summarypage = shift;
3310 my $extra_sections = shift;
3314 my %late_subtotal = ();
3317 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
3320 my $usage = $cust_bill_pkg->usage;
3322 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
3323 next if ( $display->summary && $summarypage );
3325 my $section = $display->section;
3326 my $type = $display->type;
3328 $not_tax{$section} = 1
3329 unless $cust_bill_pkg->pkgnum == 0;
3331 if ( $display->post_total && !$summarypage ) {
3332 if (! $type || $type eq 'S') {
3333 $late_subtotal{$section} += $cust_bill_pkg->setup
3334 if $cust_bill_pkg->setup != 0;
3338 $late_subtotal{$section} += $cust_bill_pkg->recur
3339 if $cust_bill_pkg->recur != 0;
3342 if ($type && $type eq 'R') {
3343 $late_subtotal{$section} += $cust_bill_pkg->recur - $usage
3344 if $cust_bill_pkg->recur != 0;
3347 if ($type && $type eq 'U') {
3348 $late_subtotal{$section} += $usage
3349 unless scalar(@$extra_sections);
3354 next if $cust_bill_pkg->pkgnum == 0 && ! $section;
3356 if (! $type || $type eq 'S') {
3357 $subtotal{$section} += $cust_bill_pkg->setup
3358 if $cust_bill_pkg->setup != 0;
3362 $subtotal{$section} += $cust_bill_pkg->recur
3363 if $cust_bill_pkg->recur != 0;
3366 if ($type && $type eq 'R') {
3367 $subtotal{$section} += $cust_bill_pkg->recur - $usage
3368 if $cust_bill_pkg->recur != 0;
3371 if ($type && $type eq 'U') {
3372 $subtotal{$section} += $usage
3373 unless scalar(@$extra_sections);
3382 %pkg_category_cache = ();
3384 push @$late, map { { 'description' => &{$escape}($_),
3385 'subtotal' => $late_subtotal{$_},
3387 'sort_weight' => ( _pkg_category($_)
3388 ? _pkg_category($_)->weight
3391 ((_pkg_category($_) && _pkg_category($_)->condense)
3392 ? $self->_condense_section($format)
3396 sort _sectionsort keys %late_subtotal;
3399 if ( $summarypage ) {
3400 @sections = grep { exists($subtotal{$_}) || ! _pkg_category($_)->disabled }
3401 map { $_->categoryname } qsearch('pkg_category', {});
3402 push @sections, '' if exists($subtotal{''});
3404 @sections = keys %subtotal;
3407 my @early = map { { 'description' => &{$escape}($_),
3408 'subtotal' => $subtotal{$_},
3409 'summarized' => $not_tax{$_} ? '' : 'Y',
3410 'tax_section' => $not_tax{$_} ? '' : 'Y',
3411 'sort_weight' => ( _pkg_category($_)
3412 ? _pkg_category($_)->weight
3415 ((_pkg_category($_) && _pkg_category($_)->condense)
3416 ? $self->_condense_section($format)
3421 push @early, @$extra_sections if $extra_sections;
3423 sort { $a->{sort_weight} <=> $b->{sort_weight} } @early;
3427 #helper subs for above
3430 _pkg_category($a)->weight <=> _pkg_category($b)->weight;
3434 my $categoryname = shift;
3435 $pkg_category_cache{$categoryname} ||=
3436 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
3439 my %condensed_format = (
3440 'label' => [ qw( Description Qty Amount ) ],
3442 sub { shift->{description} },
3443 sub { shift->{quantity} },
3444 sub { my($href, %opt) = @_;
3445 ($opt{dollar} || ''). $href->{amount};
3448 'align' => [ qw( l r r ) ],
3449 'span' => [ qw( 5 1 1 ) ], # unitprices?
3450 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
3453 sub _condense_section {
3454 my ( $self, $format ) = ( shift, shift );
3456 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
3457 qw( description_generator
3460 total_line_generator
3465 sub _condensed_generator_defaults {
3466 my ( $self, $format ) = ( shift, shift );
3467 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
3476 sub _condensed_header_generator {
3477 my ( $self, $format ) = ( shift, shift );
3479 my ( $f, $prefix, $suffix, $separator, $column ) =
3480 _condensed_generator_defaults($format);
3482 if ($format eq 'latex') {
3483 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
3484 $suffix = "\\\\\n\\hline";
3487 sub { my ($d,$a,$s,$w) = @_;
3488 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
3490 } elsif ( $format eq 'html' ) {
3491 $prefix = '<th></th>';
3495 sub { my ($d,$a,$s,$w) = @_;
3496 return qq!<th align="$html_align{$a}">$d</th>!;
3504 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
3506 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
3509 $prefix. join($separator, @result). $suffix;
3514 sub _condensed_description_generator {
3515 my ( $self, $format ) = ( shift, shift );
3517 my ( $f, $prefix, $suffix, $separator, $column ) =
3518 _condensed_generator_defaults($format);
3520 my $money_char = '$';
3521 if ($format eq 'latex') {
3522 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
3524 $separator = " & \n";
3526 sub { my ($d,$a,$s,$w) = @_;
3527 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
3529 $money_char = '\\dollar';
3530 }elsif ( $format eq 'html' ) {
3531 $prefix = '"><td align="center"></td>';
3535 sub { my ($d,$a,$s,$w) = @_;
3536 return qq!<td align="$html_align{$a}">$d</td>!;
3538 #$money_char = $conf->config('money_char') || '$';
3539 $money_char = ''; # this is madness
3547 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
3549 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
3551 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
3552 map { $f->{$_}->[$i] } qw(align span width)
3556 $prefix. join( $separator, @result ). $suffix;
3561 sub _condensed_total_generator {
3562 my ( $self, $format ) = ( shift, shift );
3564 my ( $f, $prefix, $suffix, $separator, $column ) =
3565 _condensed_generator_defaults($format);
3568 if ($format eq 'latex') {
3571 $separator = " & \n";
3573 sub { my ($d,$a,$s,$w) = @_;
3574 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
3576 }elsif ( $format eq 'html' ) {
3580 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
3582 sub { my ($d,$a,$s,$w) = @_;
3583 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
3592 # my $r = &{$f->{fields}->[$i]}(@args);
3593 # $r .= ' Total' unless $i;
3595 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
3597 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
3598 map { $f->{$_}->[$i] } qw(align span width)
3602 $prefix. join( $separator, @result ). $suffix;
3607 =item total_line_generator FORMAT
3609 Returns a coderef used for generation of invoice total line items for this
3610 usage_class. FORMAT is either html or latex
3614 # should not be used: will have issues with hash element names (description vs
3615 # total_item and amount vs total_amount -- another array of functions?
3617 sub _condensed_total_line_generator {
3618 my ( $self, $format ) = ( shift, shift );
3620 my ( $f, $prefix, $suffix, $separator, $column ) =
3621 _condensed_generator_defaults($format);
3624 if ($format eq 'latex') {
3627 $separator = " & \n";
3629 sub { my ($d,$a,$s,$w) = @_;
3630 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
3632 }elsif ( $format eq 'html' ) {
3636 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
3638 sub { my ($d,$a,$s,$w) = @_;
3639 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
3648 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
3650 &{$column}( &{$f->{fields}->[$i]}(@args),
3651 map { $f->{$_}->[$i] } qw(align span width)
3655 $prefix. join( $separator, @result ). $suffix;
3660 #sub _items_extra_usage_sections {
3662 # my $escape = shift;
3664 # my %sections = ();
3666 # my %usage_class = map{ $_->classname, $_ } qsearch('usage_class', {});
3667 # foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
3669 # next unless $cust_bill_pkg->pkgnum > 0;
3671 # foreach my $section ( keys %usage_class ) {
3673 # my $usage = $cust_bill_pkg->usage($section);
3675 # next unless $usage && $usage > 0;
3677 # $sections{$section} ||= 0;
3678 # $sections{$section} += $usage;
3684 # map { { 'description' => &{$escape}($_),
3685 # 'subtotal' => $sections{$_},
3686 # 'summarized' => '',
3687 # 'tax_section' => '',
3690 # sort {$usage_class{$a}->weight <=> $usage_class{$b}->weight} keys %sections;
3694 sub _items_extra_usage_sections {
3703 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
3704 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
3705 next unless $cust_bill_pkg->pkgnum > 0;
3707 foreach my $classnum ( keys %usage_class ) {
3708 my $section = $usage_class{$classnum}->classname;
3709 $classnums{$section} = $classnum;
3711 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail($classnum) ) {
3712 my $amount = $detail->amount;
3713 next unless $amount && $amount > 0;
3715 $sections{$section} ||= { 'subtotal'=>0, 'calls'=>0, 'duration'=>0 };
3716 $sections{$section}{amount} += $amount; #subtotal
3717 $sections{$section}{calls}++;
3718 $sections{$section}{duration} += $detail->duration;
3720 my $desc = $detail->regionname;
3721 my $description = $desc;
3722 $description = substr($desc, 0, 50). '...'
3723 if $format eq 'latex' && length($desc) > 50;
3725 $lines{$section}{$desc} ||= {
3726 description => &{$escape}($description),
3727 #pkgpart => $part_pkg->pkgpart,
3728 pkgnum => $cust_bill_pkg->pkgnum,
3733 #unit_amount => $cust_bill_pkg->unitrecur,
3734 quantity => $cust_bill_pkg->quantity,
3735 product_code => 'N/A',
3736 ext_description => [],
3739 $lines{$section}{$desc}{amount} += $amount;
3740 $lines{$section}{$desc}{calls}++;
3741 $lines{$section}{$desc}{duration} += $detail->duration;
3747 my %sectionmap = ();
3748 foreach (keys %sections) {
3749 my $usage_class = $usage_class{$classnums{$_}};
3750 $sectionmap{$_} = { 'description' => &{$escape}($_),
3751 'amount' => $sections{$_}{amount}, #subtotal
3752 'calls' => $sections{$_}{calls},
3753 'duration' => $sections{$_}{duration},
3755 'tax_section' => '',
3756 'sort_weight' => $usage_class->weight,
3757 ( $usage_class->format
3758 ? ( map { $_ => $usage_class->$_($format) }
3759 qw( description_generator header_generator total_generator total_line_generator )
3766 my @sections = sort { $a->{sort_weight} <=> $b->{sort_weight} }
3770 foreach my $section ( keys %lines ) {
3771 foreach my $line ( keys %{$lines{$section}} ) {
3772 my $l = $lines{$section}{$line};
3773 $l->{section} = $sectionmap{$section};
3774 $l->{amount} = sprintf( "%.2f", $l->{amount} );
3775 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
3780 return(\@sections, \@lines);
3784 sub _items_svc_phone_sections {
3793 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
3794 $usage_class{''} ||= new FS::usage_class { 'classname' => '', 'weight' => 0 };
3796 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
3797 next unless $cust_bill_pkg->pkgnum > 0;
3799 my @header = $cust_bill_pkg->details_header;
3800 next unless scalar(@header);
3802 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
3804 my $phonenum = $detail->phonenum;
3805 next unless $phonenum;
3807 my $amount = $detail->amount;
3808 next unless $amount && $amount > 0;
3810 $sections{$phonenum} ||= { 'amount' => 0,
3813 'sort_weight' => -1,
3814 'phonenum' => $phonenum,
3816 $sections{$phonenum}{amount} += $amount; #subtotal
3817 $sections{$phonenum}{calls}++;
3818 $sections{$phonenum}{duration} += $detail->duration;
3820 my $desc = $detail->regionname;
3821 my $description = $desc;
3822 $description = substr($desc, 0, 50). '...'
3823 if $format eq 'latex' && length($desc) > 50;
3825 $lines{$phonenum}{$desc} ||= {
3826 description => &{$escape}($description),
3827 #pkgpart => $part_pkg->pkgpart,
3835 product_code => 'N/A',
3836 ext_description => [],
3839 $lines{$phonenum}{$desc}{amount} += $amount;
3840 $lines{$phonenum}{$desc}{calls}++;
3841 $lines{$phonenum}{$desc}{duration} += $detail->duration;
3843 my $line = $usage_class{$detail->classnum}->classname;
3844 $sections{"$phonenum $line"} ||=
3848 'sort_weight' => $usage_class{$detail->classnum}->weight,
3849 'phonenum' => $phonenum,
3850 'header' => [ @header ],
3852 $sections{"$phonenum $line"}{amount} += $amount; #subtotal
3853 $sections{"$phonenum $line"}{calls}++;
3854 $sections{"$phonenum $line"}{duration} += $detail->duration;
3856 $lines{"$phonenum $line"}{$desc} ||= {
3857 description => &{$escape}($description),
3858 #pkgpart => $part_pkg->pkgpart,
3866 product_code => 'N/A',
3867 ext_description => [],
3870 $lines{"$phonenum $line"}{$desc}{amount} += $amount;
3871 $lines{"$phonenum $line"}{$desc}{calls}++;
3872 $lines{"$phonenum $line"}{$desc}{duration} += $detail->duration;
3873 push @{$lines{"$phonenum $line"}{$desc}{ext_description}},
3874 $detail->formatted('format' => $format);
3879 my %sectionmap = ();
3880 my $simple = new FS::usage_class { format => 'simple' }; #bleh
3881 foreach ( keys %sections ) {
3882 my @header = @{ $sections{$_}{header} || [] };
3884 new FS::usage_class { format => 'usage_'. (scalar(@header) || 6). 'col' };
3885 my $summary = $sections{$_}{sort_weight} < 0 ? 1 : 0;
3886 my $usage_class = $summary ? $simple : $usage_simple;
3887 my $ending = $summary ? ' usage charges' : '';
3890 $gen_opt{label} = [ map{ &{$escape}($_) } @header ];
3892 $sectionmap{$_} = { 'description' => &{$escape}($_. $ending),
3893 'amount' => $sections{$_}{amount}, #subtotal
3894 'calls' => $sections{$_}{calls},
3895 'duration' => $sections{$_}{duration},
3897 'tax_section' => '',
3898 'phonenum' => $sections{$_}{phonenum},
3899 'sort_weight' => $sections{$_}{sort_weight},
3900 'post_total' => $summary, #inspire pagebreak
3902 ( map { $_ => $usage_class->$_($format, %gen_opt) }
3903 qw( description_generator
3906 total_line_generator
3913 my @sections = sort { $a->{phonenum} cmp $b->{phonenum} ||
3914 $a->{sort_weight} <=> $b->{sort_weight}
3919 foreach my $section ( keys %lines ) {
3920 foreach my $line ( keys %{$lines{$section}} ) {
3921 my $l = $lines{$section}{$line};
3922 $l->{section} = $sectionmap{$section};
3923 $l->{amount} = sprintf( "%.2f", $l->{amount} );
3924 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
3929 return(\@sections, \@lines);
3936 #my @display = scalar(@_)
3938 # : qw( _items_previous _items_pkg );
3939 # #: qw( _items_pkg );
3940 # #: qw( _items_previous _items_pkg _items_tax _items_credits _items_payments );
3941 my @display = qw( _items_previous _items_pkg );
3944 foreach my $display ( @display ) {
3945 push @b, $self->$display(@_);
3950 sub _items_previous {
3952 my $cust_main = $self->cust_main;
3953 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
3955 foreach ( @pr_cust_bill ) {
3956 my $date = $conf->exists('invoice_show_prior_due_date')
3957 ? 'due '. $_->due_date2str($date_format)
3958 : time2str($date_format, $_->_date);
3960 'description' => 'Previous Balance, Invoice #'. $_->invnum. " ($date)",
3961 #'pkgpart' => 'N/A',
3963 'amount' => sprintf("%.2f", $_->owed),
3969 # 'description' => 'Previous Balance',
3970 # #'pkgpart' => 'N/A',
3971 # 'pkgnum' => 'N/A',
3972 # 'amount' => sprintf("%10.2f", $pr_total ),
3973 # 'ext_description' => [ map {
3974 # "Invoice ". $_->invnum.
3975 # " (". time2str("%x",$_->_date). ") ".
3976 # sprintf("%10.2f", $_->owed)
3977 # } @pr_cust_bill ],
3985 my @cust_bill_pkg = grep { $_->pkgnum } $self->cust_bill_pkg;
3986 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3987 if ($options{section} && $options{section}->{condensed}) {
3989 local $Storable::canonical = 1;
3990 foreach ( @items ) {
3992 delete $item->{ref};
3993 delete $item->{ext_description};
3994 my $key = freeze($item);
3995 $itemshash{$key} ||= 0;
3996 $itemshash{$key} ++; # += $item->{quantity};
3998 @items = sort { $a->{description} cmp $b->{description} }
3999 map { my $i = thaw($_);
4000 $i->{quantity} = $itemshash{$_};
4002 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
4011 return 0 unless $a->itemdesc cmp $b->itemdesc;
4012 return -1 if $b->itemdesc eq 'Tax';
4013 return 1 if $a->itemdesc eq 'Tax';
4014 return -1 if $b->itemdesc eq 'Other surcharges';
4015 return 1 if $a->itemdesc eq 'Other surcharges';
4016 $a->itemdesc cmp $b->itemdesc;
4021 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum } $self->cust_bill_pkg;
4022 $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
4025 sub _items_cust_bill_pkg {
4027 my $cust_bill_pkg = shift;
4030 my $format = $opt{format} || '';
4031 my $escape_function = $opt{escape_function} || sub { shift };
4032 my $format_function = $opt{format_function} || '';
4033 my $unsquelched = $opt{unsquelched} || '';
4034 my $section = $opt{section}->{description} if $opt{section};
4035 my $summary_page = $opt{summary_page} || '';
4036 my $multilocation = $opt{multilocation} || '';
4037 my $multisection = $opt{multisection} || '';
4040 my ($s, $r, $u) = ( undef, undef, undef );
4041 foreach my $cust_bill_pkg ( @$cust_bill_pkg )
4044 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ) ) {
4045 if ( $_ && !$cust_bill_pkg->hidden ) {
4046 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
4047 $_->{amount} =~ s/^\-0\.00$/0.00/;
4048 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} ),
4050 unless $_->{amount} == 0;
4055 foreach my $display ( grep { defined($section)
4056 ? $_->section eq $section
4059 #grep { !$_->summary || !$summary_page } # bunk!
4060 grep { !$_->summary || $multisection }
4061 $cust_bill_pkg->cust_bill_pkg_display
4065 my $type = $display->type;
4067 my $desc = $cust_bill_pkg->desc;
4068 $desc = substr($desc, 0, 50). '...'
4069 if $format eq 'latex' && length($desc) > 50;
4071 my %details_opt = ( 'format' => $format,
4072 'escape_function' => $escape_function,
4073 'format_function' => $format_function,
4076 if ( $cust_bill_pkg->pkgnum > 0 ) {
4078 my $cust_pkg = $cust_bill_pkg->cust_pkg;
4080 if ( $cust_bill_pkg->setup != 0 && (!$type || $type eq 'S') ) {
4082 my $description = $desc;
4083 $description .= ' Setup' if $cust_bill_pkg->recur != 0;
4086 unless ( $cust_pkg->part_pkg->hide_svc_detail
4087 || $cust_bill_pkg->hidden )
4089 push @d, map &{$escape_function}($_),
4090 $cust_pkg->h_labels_short($self->_date);
4091 if ( $multilocation ) {
4092 my $loc = $cust_pkg->location_label;
4093 $loc = substr($desc, 0, 50). '...'
4094 if $format eq 'latex' && length($loc) > 50;
4095 push @d, &{$escape_function}($loc);
4098 push @d, $cust_bill_pkg->details(%details_opt)
4099 if $cust_bill_pkg->recur == 0;
4101 if ( $cust_bill_pkg->hidden ) {
4102 $s->{amount} += $cust_bill_pkg->setup;
4103 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
4104 push @{ $s->{ext_description} }, @d;
4107 description => $description,
4108 #pkgpart => $part_pkg->pkgpart,
4109 pkgnum => $cust_bill_pkg->pkgnum,
4110 amount => $cust_bill_pkg->setup,
4111 unit_amount => $cust_bill_pkg->unitsetup,
4112 quantity => $cust_bill_pkg->quantity,
4113 ext_description => \@d,
4119 if ( ( $cust_bill_pkg->recur != 0 || $cust_bill_pkg->setup == 0 ) &&
4120 ( !$type || $type eq 'R' || $type eq 'U' )
4124 my $is_summary = $display->summary;
4125 my $description = ($is_summary && $type && $type eq 'U')
4126 ? "Usage charges" : $desc;
4128 unless ( $conf->exists('disable_line_item_date_ranges') ) {
4129 $description .= " (" . time2str($date_format, $cust_bill_pkg->sdate).
4130 " - ". time2str($date_format, $cust_bill_pkg->edate). ")";
4135 #at least until cust_bill_pkg has "past" ranges in addition to
4136 #the "future" sdate/edate ones... see #3032
4137 my @dates = ( $self->_date );
4138 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
4139 push @dates, $prev->sdate if $prev;
4141 unless ( $cust_pkg->part_pkg->hide_svc_detail
4142 || $cust_bill_pkg->itemdesc
4143 || $cust_bill_pkg->hidden
4144 || $is_summary && $type && $type eq 'U' )
4146 push @d, map &{$escape_function}($_),
4147 $cust_pkg->h_labels_short(@dates)
4148 #$cust_bill_pkg->edate,
4149 #$cust_bill_pkg->sdate)
4151 if ( $multilocation ) {
4152 my $loc = $cust_pkg->location_label;
4153 $loc = substr($desc, 0, 50). '...'
4154 if $format eq 'latex' && length($loc) > 50;
4155 push @d, &{$escape_function}($loc);
4159 push @d, $cust_bill_pkg->details(%details_opt)
4160 unless ($is_summary || $type && $type eq 'R');
4164 $amount = $cust_bill_pkg->recur;
4165 }elsif($type eq 'R') {
4166 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
4167 }elsif($type eq 'U') {
4168 $amount = $cust_bill_pkg->usage;
4171 if ( !$type || $type eq 'R' ) {
4173 if ( $cust_bill_pkg->hidden ) {
4174 $r->{amount} += $amount;
4175 $r->{unit_amount} += $cust_bill_pkg->unitrecur;
4176 push @{ $r->{ext_description} }, @d;
4179 description => $description,
4180 #pkgpart => $part_pkg->pkgpart,
4181 pkgnum => $cust_bill_pkg->pkgnum,
4183 unit_amount => $cust_bill_pkg->unitrecur,
4184 quantity => $cust_bill_pkg->quantity,
4185 ext_description => \@d,
4189 } else { # $type eq 'U'
4191 if ( $cust_bill_pkg->hidden ) {
4192 $u->{amount} += $amount;
4193 $u->{unit_amount} += $cust_bill_pkg->unitrecur;
4194 push @{ $u->{ext_description} }, @d;
4197 description => $description,
4198 #pkgpart => $part_pkg->pkgpart,
4199 pkgnum => $cust_bill_pkg->pkgnum,
4201 unit_amount => $cust_bill_pkg->unitrecur,
4202 quantity => $cust_bill_pkg->quantity,
4203 ext_description => \@d,
4209 } # recurring or usage with recurring charge
4211 } else { #pkgnum tax or one-shot line item (??)
4213 if ( $cust_bill_pkg->setup != 0 ) {
4215 'description' => $desc,
4216 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
4219 if ( $cust_bill_pkg->recur != 0 ) {
4221 'description' => "$desc (".
4222 time2str($date_format, $cust_bill_pkg->sdate). ' - '.
4223 time2str($date_format, $cust_bill_pkg->edate). ')',
4224 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
4234 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ) ) {
4236 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
4237 $_->{amount} =~ s/^\-0\.00$/0.00/;
4238 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} ),
4240 unless $_->{amount} == 0;
4248 sub _items_credits {
4249 my( $self, %opt ) = @_;
4250 my $trim_len = $opt{'trim_len'} || 60;
4254 foreach ( $self->cust_credited ) {
4256 #something more elaborate if $_->amount ne $_->cust_credit->credited ?
4258 my $reason = substr($_->cust_credit->reason, 0, $trim_len);
4259 $reason .= '...' if length($reason) < length($_->cust_credit->reason);
4260 $reason = " ($reason) " if $reason;
4263 #'description' => 'Credit ref\#'. $_->crednum.
4264 # " (". time2str("%x",$_->cust_credit->_date) .")".
4266 'description' => 'Credit applied '.
4267 time2str($date_format,$_->cust_credit->_date). $reason,
4268 'amount' => sprintf("%.2f",$_->amount),
4276 sub _items_payments {
4280 #get & print payments
4281 foreach ( $self->cust_bill_pay ) {
4283 #something more elaborate if $_->amount ne ->cust_pay->paid ?
4286 'description' => "Payment received ".
4287 time2str($date_format,$_->cust_pay->_date ),
4288 'amount' => sprintf("%.2f", $_->amount )
4296 =item call_details [ OPTION => VALUE ... ]
4298 Returns an array of CSV strings representing the call details for this invoice
4299 The only option available is the boolean prepend_billed_number
4304 my ($self, %opt) = @_;
4306 my $format_function = sub { shift };
4308 if ($opt{prepend_billed_number}) {
4309 $format_function = sub {
4313 $row->amount ? $row->phonenum. ",". $detail : '"Billed number",'. $detail;
4318 my @details = map { $_->details( 'format_function' => $format_function,
4319 'escape_function' => sub{ return() },
4323 $self->cust_bill_pkg;
4324 my $header = $details[0];
4325 ( $header, grep { $_ ne $header } @details );
4335 =item process_reprint
4339 sub process_reprint {
4340 process_re_X('print', @_);
4343 =item process_reemail
4347 sub process_reemail {
4348 process_re_X('email', @_);
4356 process_re_X('fax', @_);
4364 process_re_X('ftp', @_);
4371 sub process_respool {
4372 process_re_X('spool', @_);
4375 use Storable qw(thaw);
4379 my( $method, $job ) = ( shift, shift );
4380 warn "$me process_re_X $method for job $job\n" if $DEBUG;
4382 my $param = thaw(decode_base64(shift));
4383 warn Dumper($param) if $DEBUG;
4394 my($method, $job, %param ) = @_;
4396 warn "re_X $method for job $job with param:\n".
4397 join( '', map { " $_ => ". $param{$_}. "\n" } keys %param );
4400 #some false laziness w/search/cust_bill.html
4402 my $orderby = 'ORDER BY cust_bill._date';
4404 my $extra_sql = ' WHERE '. FS::cust_bill->search_sql_where(\%param);
4406 my $addl_from = 'LEFT JOIN cust_main USING ( custnum )';
4408 my @cust_bill = qsearch( {
4409 #'select' => "cust_bill.*",
4410 'table' => 'cust_bill',
4411 'addl_from' => $addl_from,
4413 'extra_sql' => $extra_sql,
4414 'order_by' => $orderby,
4418 $method .= '_invoice' unless $method eq 'email' || $method eq 'print';
4420 warn " $me re_X $method: ". scalar(@cust_bill). " invoices found\n"
4423 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
4424 foreach my $cust_bill ( @cust_bill ) {
4425 $cust_bill->$method();
4427 if ( $job ) { #progressbar foo
4429 if ( time - $min_sec > $last ) {
4430 my $error = $job->update_statustext(
4431 int( 100 * $num / scalar(@cust_bill) )
4433 die $error if $error;
4444 =head1 CLASS METHODS
4450 Returns an SQL fragment to retreive the amount owed (charged minus credited and paid).
4455 my ($class, $start, $end) = @_;
4457 $class->paid_sql($start, $end). ' - '.
4458 $class->credited_sql($start, $end);
4463 Returns an SQL fragment to retreive the net amount (charged minus credited).
4468 my ($class, $start, $end) = @_;
4469 'charged - '. $class->credited_sql($start, $end);
4474 Returns an SQL fragment to retreive the amount paid against this invoice.
4479 my ($class, $start, $end) = @_;
4480 $start &&= "AND cust_bill_pay._date <= $start";
4481 $end &&= "AND cust_bill_pay._date > $end";
4482 $start = '' unless defined($start);
4483 $end = '' unless defined($end);
4484 "( SELECT COALESCE(SUM(amount),0) FROM cust_bill_pay
4485 WHERE cust_bill.invnum = cust_bill_pay.invnum $start $end )";
4490 Returns an SQL fragment to retreive the amount credited against this invoice.
4495 my ($class, $start, $end) = @_;
4496 $start &&= "AND cust_credit_bill._date <= $start";
4497 $end &&= "AND cust_credit_bill._date > $end";
4498 $start = '' unless defined($start);
4499 $end = '' unless defined($end);
4500 "( SELECT COALESCE(SUM(amount),0) FROM cust_credit_bill
4501 WHERE cust_bill.invnum = cust_credit_bill.invnum $start $end )";
4506 Returns an SQL fragment to retrieve the due date of an invoice.
4507 Currently only supported on PostgreSQL.
4515 cust_bill.invoice_terms,
4516 cust_main.invoice_terms,
4517 \''.($conf->config('invoice_default_terms') || '').'\'
4518 ), E\'Net (\\\\d+)\'
4520 ) * 86400 + cust_bill._date'
4523 =item search_sql_where HASHREF
4525 Class method which returns an SQL WHERE fragment to search for parameters
4526 specified in HASHREF. Valid parameters are
4532 List reference of start date, end date, as UNIX timestamps.
4542 List reference of charged limits (exclusive).
4546 List reference of charged limits (exclusive).
4550 flag, return open invoices only
4554 flag, return net invoices only
4558 =item newest_percust
4562 Note: validates all passed-in data; i.e. safe to use with unchecked CGI params.
4566 sub search_sql_where {
4567 my($class, $param) = @_;
4569 warn "$me search_sql_where called with params: \n".
4570 join("\n", map { " $_: ". $param->{$_} } keys %$param ). "\n";
4576 if ( $param->{'agentnum'} =~ /^(\d+)$/ ) {
4577 push @search, "cust_main.agentnum = $1";
4581 if ( $param->{_date} ) {
4582 my($beginning, $ending) = @{$param->{_date}};
4584 push @search, "cust_bill._date >= $beginning",
4585 "cust_bill._date < $ending";
4589 if ( $param->{'invnum_min'} =~ /^(\d+)$/ ) {
4590 push @search, "cust_bill.invnum >= $1";
4592 if ( $param->{'invnum_max'} =~ /^(\d+)$/ ) {
4593 push @search, "cust_bill.invnum <= $1";
4597 if ( $param->{charged} ) {
4598 my @charged = ref($param->{charged})
4599 ? @{ $param->{charged} }
4600 : ($param->{charged});
4602 push @search, map { s/^charged/cust_bill.charged/; $_; }
4606 my $owed_sql = FS::cust_bill->owed_sql;
4609 if ( $param->{owed} ) {
4610 my @owed = ref($param->{owed})
4611 ? @{ $param->{owed} }
4613 push @search, map { s/^owed/$owed_sql/; $_; }
4618 push @search, "0 != $owed_sql"
4619 if $param->{'open'};
4620 push @search, '0 != '. FS::cust_bill->net_sql
4624 push @search, "cust_bill._date < ". (time-86400*$param->{'days'})
4625 if $param->{'days'};
4628 if ( $param->{'newest_percust'} ) {
4630 #$distinct = 'DISTINCT ON ( cust_bill.custnum )';
4631 #$orderby = 'ORDER BY cust_bill.custnum ASC, cust_bill._date DESC';
4633 my @newest_where = map { my $x = $_;
4634 $x =~ s/\bcust_bill\./newest_cust_bill./g;
4637 grep ! /^cust_main./, @search;
4638 my $newest_where = scalar(@newest_where)
4639 ? ' AND '. join(' AND ', @newest_where)
4643 push @search, "cust_bill._date = (
4644 SELECT(MAX(newest_cust_bill._date)) FROM cust_bill AS newest_cust_bill
4645 WHERE newest_cust_bill.custnum = cust_bill.custnum
4651 #agent virtualization
4652 my $curuser = $FS::CurrentUser::CurrentUser;
4653 if ( $curuser->username eq 'fs_queue'
4654 && $param->{'CurrentUser'} =~ /^(\w+)$/ ) {
4656 my $newuser = qsearchs('access_user', {
4657 'username' => $username,
4661 $curuser = $newuser;
4663 warn "$me WARNING: (fs_queue) can't find CurrentUser $username\n";
4666 push @search, $curuser->agentnums_sql;
4668 join(' AND ', @search );
4680 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
4681 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base