2 use base qw( FS::cust_bill::Search FS::Template_Mixin
3 FS::cust_main_Mixin FS::Record
7 use vars qw( $DEBUG $me );
10 use Fcntl qw(:flock); #for spool_csv
12 use List::Util qw(min max sum);
16 use Storable qw( freeze thaw );
18 use FS::UID qw( datasrc );
19 use FS::Misc qw( send_fax do_print );
20 use FS::Record qw( qsearch qsearchs dbh );
21 use FS::cust_statement;
22 use FS::cust_bill_pkg;
23 use FS::cust_bill_pkg_display;
24 use FS::cust_bill_pkg_detail;
28 use FS::cust_credit_bill;
32 use FS::cust_bill_pay;
35 use FS::cust_bill_batch;
36 use FS::cust_bill_pay_pkg;
37 use FS::cust_credit_bill_pkg;
38 use FS::discount_plan;
39 use FS::cust_bill_void;
45 $me = '[FS::cust_bill]';
49 FS::cust_bill - Object methods for cust_bill records
55 $record = new FS::cust_bill \%hash;
56 $record = new FS::cust_bill { 'column' => 'value' };
58 $error = $record->insert;
60 $error = $new_record->replace($old_record);
62 $error = $record->delete;
64 $error = $record->check;
66 ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
68 @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
70 ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
72 @cust_pay_objects = $cust_bill->cust_pay;
74 $tax_amount = $record->tax;
76 @lines = $cust_bill->print_text;
77 @lines = $cust_bill->print_text('time' => $time);
81 An FS::cust_bill object represents an invoice; a declaration that a customer
82 owes you money. The specific charges are itemized as B<cust_bill_pkg> records
83 (see L<FS::cust_bill_pkg>). FS::cust_bill inherits from FS::Record. The
84 following fields are currently supported:
90 =item invnum - primary key (assigned automatically for new invoices)
92 =item custnum - customer (see L<FS::cust_main>)
94 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
95 L<Time::Local> and L<Date::Parse> for conversion functions.
97 =item charged - amount of this invoice
99 =item invoice_terms - optional terms override for this specific invoice
107 =item billing_balance - the customer's balance immediately before generating
108 this invoice. DEPRECATED. Use the L<FS::cust_main/balance_date> method
109 to determine the customer's balance at a specific time.
111 =item previous_balance - the customer's balance immediately after generating
112 the invoice before this one. DEPRECATED.
114 =item printed - formerly used to track the number of times an invoice had
115 been printed; no longer used.
123 =item closed - books closed flag, empty or `Y'
125 =item statementnum - invoice aggregation (see L<FS::cust_statement>)
127 =item agent_invid - legacy invoice number
129 =item promised_date - customer promised payment date, for collection
131 =item pending - invoice is still being generated, empty or 'Y'
141 Creates a new invoice. To add the invoice to the database, see L<"insert">.
142 Invoices are normally created by calling the bill method of a customer object
143 (see L<FS::cust_main>).
147 sub table { 'cust_bill'; }
148 sub template_conf { 'invoice_'; }
152 my $agentnum = $self->cust_main->agentnum;
153 my $tc = $self->template_conf;
155 $self->conf->exists($tc.'sections', $agentnum) ||
156 $self->conf->exists($tc.'sections_by_location', $agentnum);
159 # should be the ONLY occurrence of "Invoice" in invoice rendering code.
160 # (except email_subject and invnum_date_pretty)
163 $self->conf->config('notice_name') || 'Invoice'
166 sub cust_linked { $_[0]->cust_main_custnum || $_[0]->custnum }
167 sub cust_unlinked_msg {
169 "WARNING: can't find cust_main.custnum ". $self->custnum.
170 ' (cust_bill.invnum '. $self->invnum. ')';
175 Adds this invoice to the database ("Posts" the invoice). If there is an error,
176 returns the error, otherwise returns false.
182 warn "$me insert called\n" if $DEBUG;
184 local $SIG{HUP} = 'IGNORE';
185 local $SIG{INT} = 'IGNORE';
186 local $SIG{QUIT} = 'IGNORE';
187 local $SIG{TERM} = 'IGNORE';
188 local $SIG{TSTP} = 'IGNORE';
189 local $SIG{PIPE} = 'IGNORE';
191 my $oldAutoCommit = $FS::UID::AutoCommit;
192 local $FS::UID::AutoCommit = 0;
195 my $error = $self->SUPER::insert;
197 $dbh->rollback if $oldAutoCommit;
201 if ( $self->get('cust_bill_pkg') ) {
202 foreach my $cust_bill_pkg ( @{$self->get('cust_bill_pkg')} ) {
203 $cust_bill_pkg->invnum($self->invnum);
204 my $error = $cust_bill_pkg->insert;
206 $dbh->rollback if $oldAutoCommit;
207 return "can't create invoice line item: $error";
212 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
217 =item void [ REASON [ , REPROCESS_CDRS ] ]
219 Voids this invoice: deletes the invoice and adds a record of the voided invoice
220 to the FS::cust_bill_void table (and related tables starting from
221 FS::cust_bill_pkg_void).
227 my $reason = scalar(@_) ? shift : '';
228 my $reprocess_cdrs = scalar(@_) ? shift : '';
230 unless (ref($reason) || !$reason) {
231 $reason = FS::reason->new_or_existing(
233 'type' => 'Invoice void',
238 local $SIG{HUP} = 'IGNORE';
239 local $SIG{INT} = 'IGNORE';
240 local $SIG{QUIT} = 'IGNORE';
241 local $SIG{TERM} = 'IGNORE';
242 local $SIG{TSTP} = 'IGNORE';
243 local $SIG{PIPE} = 'IGNORE';
245 my $oldAutoCommit = $FS::UID::AutoCommit;
246 local $FS::UID::AutoCommit = 0;
249 my $cust_bill_void = new FS::cust_bill_void ( {
250 map { $_ => $self->get($_) } $self->fields
252 $cust_bill_void->reasonnum($reason->reasonnum) if $reason;
253 my $error = $cust_bill_void->insert;
255 $dbh->rollback if $oldAutoCommit;
259 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
260 my $error = $cust_bill_pkg->void($reason, $reprocess_cdrs);
262 $dbh->rollback if $oldAutoCommit;
267 $error = $self->delete;
269 $dbh->rollback if $oldAutoCommit;
273 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
281 DO NOT USE THIS METHOD. Instead, apply a credit against the invoice, or use
284 This is only for internal use by V<void>, which is what you should be using.
286 DO NOT USE THIS METHOD. Whatever reason you think you have is almost certainly
287 wrong. Use B<void>, that's what it is for. Really. This means you.
293 return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
295 local $SIG{HUP} = 'IGNORE';
296 local $SIG{INT} = 'IGNORE';
297 local $SIG{QUIT} = 'IGNORE';
298 local $SIG{TERM} = 'IGNORE';
299 local $SIG{TSTP} = 'IGNORE';
300 local $SIG{PIPE} = 'IGNORE';
302 my $oldAutoCommit = $FS::UID::AutoCommit;
303 local $FS::UID::AutoCommit = 0;
306 foreach my $table (qw(
313 #cust_event # problematic
314 #cust_pay_batch # unnecessary
316 foreach my $linked ( $self->$table() ) {
317 my $error = $linked->delete;
319 $dbh->rollback if $oldAutoCommit;
326 my $error = $self->SUPER::delete(@_);
328 $dbh->rollback if $oldAutoCommit;
332 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
338 =item replace [ OLD_RECORD ]
340 You can, but probably shouldn't modify invoices...
342 Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
343 supplied, replaces this record. If there is an error, returns the error,
344 otherwise returns false.
348 #replace can be inherited from Record.pm
350 # replace_check is now the preferred way to #implement replace data checks
351 # (so $object->replace() works without an argument)
354 my( $new, $old ) = ( shift, shift );
355 return "Can't modify closed invoice" if $old->closed =~ /^Y/i;
356 #return "Can't change _date!" unless $old->_date eq $new->_date;
357 return "Can't change _date" unless $old->_date == $new->_date;
358 return "Can't change charged" unless $old->charged == $new->charged
359 || $old->pending eq 'Y'
360 || $old->charged == 0
361 || $new->{'Hash'}{'cc_surcharge_replace_hack'};
367 =item add_cc_surcharge
373 sub add_cc_surcharge {
374 my ($self, $pkgnum, $amount) = (shift, shift, shift);
377 my $cust_bill_pkg = new FS::cust_bill_pkg({
378 'invnum' => $self->invnum,
382 $error = $cust_bill_pkg->insert;
383 return $error if $error;
385 $self->{'Hash'}{'cc_surcharge_replace_hack'} = 1;
386 $self->charged($self->charged+$amount);
387 $error = $self->replace;
388 return $error if $error;
390 $self->apply_payments_and_credits;
396 Checks all fields to make sure this is a valid invoice. If there is an error,
397 returns the error, otherwise returns false. Called by the insert and replace
406 $self->ut_numbern('invnum')
407 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum' )
408 || $self->ut_numbern('_date')
409 || $self->ut_money('charged')
410 || $self->ut_numbern('printed')
411 || $self->ut_enum('closed', [ '', 'Y' ])
412 || $self->ut_foreign_keyn('statementnum', 'cust_statement', 'statementnum' )
413 || $self->ut_numbern('agent_invid') #varchar?
414 || $self->ut_flag('pending')
416 return $error if $error;
418 $self->_date(time) unless $self->_date;
420 $self->printed(0) if $self->printed eq '';
427 Returns the displayed invoice number for this invoice: agent_invid if
428 cust_bill-default_agent_invid is set and it has a value, invnum otherwise.
434 if ( $self->agent_invid
435 && FS::Conf->new->exists('cust_bill-default_agent_invid') ) {
436 return $self->agent_invid;
438 return $self->invnum;
444 Returns the customer's last invoice before this one.
450 if ( !$self->get('previous_bill') ) {
451 $self->set('previous_bill', qsearchs({
452 'table' => 'cust_bill',
453 'hashref' => { 'custnum' => $self->custnum,
454 '_date' => { op=>'<', value=>$self->_date } },
455 'order_by' => 'ORDER BY _date DESC LIMIT 1',
458 $self->get('previous_bill');
463 Returns a list consisting of the total previous balance for this customer,
464 followed by the previous outstanding invoices (as FS::cust_bill objects also).
470 # simple memoize; we use this a lot
471 if (!$self->get('previous')) {
473 my @cust_bill = sort { $a->_date <=> $b->_date }
474 grep { $_->owed != 0 }
475 qsearch( 'cust_bill', { 'custnum' => $self->custnum,
476 #'_date' => { op=>'<', value=>$self->_date },
477 'invnum' => { op=>'<', value=>$self->invnum },
480 foreach ( @cust_bill ) { $total += $_->owed; }
481 $self->set('previous', [$total, @cust_bill]);
483 return @{ $self->get('previous') };
486 =item enable_previous
488 Whether to show the 'Previous Charges' section when printing this invoice.
489 The negation of the 'disable_previous_balance' config setting.
493 sub enable_previous {
495 my $agentnum = $self->cust_main->agentnum;
496 !$self->conf->exists('disable_previous_balance', $agentnum);
501 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
508 { 'table' => 'cust_bill_pkg',
509 'hashref' => { 'invnum' => $self->invnum },
510 'order_by' => 'ORDER BY billpkgnum', #important? otherwise we could use
511 # the AUTLOADED FK search. or should
512 # that default to ORDER by the pkey?
517 =item cust_bill_pkg_pkgnum PKGNUM
519 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice and
524 sub cust_bill_pkg_pkgnum {
525 my( $self, $pkgnum ) = @_;
527 { 'table' => 'cust_bill_pkg',
528 'hashref' => { 'invnum' => $self->invnum,
531 'order_by' => 'ORDER BY billpkgnum',
538 Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
545 my @cust_pkg = map { $_->pkgnum > 0 ? $_->cust_pkg : () }
546 $self->cust_bill_pkg;
548 grep { ! $saw{$_->pkgnum}++ } @cust_pkg;
553 Returns true if any of the packages (or their definitions) corresponding to the
554 line items for this invoice have the no_auto flag set.
560 grep { $_->no_auto || $_->part_pkg->no_auto } $self->cust_pkg;
563 =item open_cust_bill_pkg
565 Returns the open line items for this invoice.
567 Note that cust_bill_pkg with both setup and recur fees are returned as two
568 separate line items, each with only one fee.
572 # modeled after cust_main::open_cust_bill
573 sub open_cust_bill_pkg {
576 # grep { $_->owed > 0 } $self->cust_bill_pkg
578 my %other = ( 'recur' => 'setup',
579 'setup' => 'recur', );
581 foreach my $field ( qw( recur setup )) {
582 push @open, map { $_->set( $other{$field}, 0 ); $_; }
583 grep { $_->owed($field) > 0 }
584 $self->cust_bill_pkg;
592 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
596 #false laziness w/cust_pkg.pm
600 'table' => 'cust_event',
601 'addl_from' => 'JOIN part_event USING ( eventpart )',
602 'hashref' => { 'tablenum' => $self->invnum },
603 'extra_sql' => " AND eventtable = 'cust_bill' ",
609 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
613 #false laziness w/cust_pkg.pm
617 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
618 " WHERE tablenum = ? AND eventtable = 'cust_bill'";
619 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
620 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
621 $sth->fetchrow_arrayref->[0];
626 Returns the customer (see L<FS::cust_main>) for this invoice.
630 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this invoice
632 Returns a list: an empty list on success or a list of errors.
639 grep { $_->suspend(@_) }
640 grep {! $_->getfield('cancel') }
645 =item cust_suspend_if_balance_over AMOUNT
647 Suspends the customer associated with this invoice if the total amount owed on
648 this invoice and all older invoices is greater than the specified amount.
650 Returns a list: an empty list on success or a list of errors.
654 sub cust_suspend_if_balance_over {
655 my( $self, $amount ) = ( shift, shift );
656 my $cust_main = $self->cust_main;
657 if ( $cust_main->total_owed_date($self->_date) < $amount ) {
660 $cust_main->suspend(@_);
666 Cancel the packages on this invoice. Largely similar to the cust_main version, but does not bother yet with banned payment options
671 my( $self, %opt ) = @_;
673 warn "$me cancel called on cust_bill ". $self->invnum . " with options ".
674 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
677 return ( 'Access denied' )
678 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
680 my @pkgs = $self->cust_pkg;
682 if ( !$opt{nobill} && $self->conf->exists('bill_usage_on_cancel') ) {
684 my $error = $self->cust_main->bill( pkg_list => [ @pkgs ], cancel => 1 );
685 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
690 map { $_->cancel(%opt) }
691 grep { ! $_->getfield('cancel') }
697 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
703 map { $_ } #return $self->num_cust_bill_pay unless wantarray;
704 sort { $a->_date <=> $b->_date }
705 qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
710 =item cust_credit_bill
712 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
718 map { $_ } #return $self->num_cust_credit_bill unless wantarray;
719 sort { $a->_date <=> $b->_date }
720 qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
724 sub cust_credit_bill {
725 shift->cust_credited(@_);
728 #=item cust_bill_pay_pkgnum PKGNUM
730 #Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
731 #with matching pkgnum.
735 #sub cust_bill_pay_pkgnum {
736 # my( $self, $pkgnum ) = @_;
737 # map { $_ } #return $self->num_cust_bill_pay_pkgnum($pkgnum) unless wantarray;
738 # sort { $a->_date <=> $b->_date }
739 # qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum,
740 # 'pkgnum' => $pkgnum,
745 =item cust_bill_pay_pkg PKGNUM
747 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
748 applied against the matching pkgnum.
752 sub cust_bill_pay_pkg {
753 my( $self, $pkgnum ) = @_;
756 'select' => 'cust_bill_pay_pkg.*',
757 'table' => 'cust_bill_pay_pkg',
758 'addl_from' => ' LEFT JOIN cust_bill_pay USING ( billpaynum ) '.
759 ' LEFT JOIN cust_bill_pkg USING ( billpkgnum ) ',
760 'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
761 " AND cust_bill_pkg.pkgnum = $pkgnum",
766 #=item cust_credited_pkgnum PKGNUM
768 #=item cust_credit_bill_pkgnum PKGNUM
770 #Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice
771 #with matching pkgnum.
775 #sub cust_credited_pkgnum {
776 # my( $self, $pkgnum ) = @_;
777 # map { $_ } #return $self->num_cust_credit_bill_pkgnum($pkgnum) unless wantarray;
778 # sort { $a->_date <=> $b->_date }
779 # qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum,
780 # 'pkgnum' => $pkgnum,
785 #sub cust_credit_bill_pkgnum {
786 # shift->cust_credited_pkgnum(@_);
789 =item cust_credit_bill_pkg PKGNUM
791 Returns all credit applications (see L<FS::cust_credit_bill>) for this invoice
792 applied against the matching pkgnum.
796 sub cust_credit_bill_pkg {
797 my( $self, $pkgnum ) = @_;
800 'select' => 'cust_credit_bill_pkg.*',
801 'table' => 'cust_credit_bill_pkg',
802 'addl_from' => ' LEFT JOIN cust_credit_bill USING ( creditbillnum ) '.
803 ' LEFT JOIN cust_bill_pkg USING ( billpkgnum ) ',
804 'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
805 " AND cust_bill_pkg.pkgnum = $pkgnum",
810 =item cust_bill_batch
812 Returns all invoice batch records (L<FS::cust_bill_batch>) for this invoice.
816 sub cust_bill_batch {
818 qsearch('cust_bill_batch', { 'invnum' => $self->invnum });
823 Returns all discount plans (L<FS::discount_plan>) for this invoice, as a
824 hash keyed by term length.
830 FS::discount_plan->all($self);
835 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
842 my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
844 foreach (@taxlines) { $total += $_->setup; }
850 Returns the amount owed (still outstanding) on this invoice, which is charged
851 minus all payment applications (see L<FS::cust_bill_pay>) and credit
852 applications (see L<FS::cust_credit_bill>).
858 my $balance = $self->charged;
859 $balance -= $_->amount foreach ( $self->cust_bill_pay );
860 $balance -= $_->amount foreach ( $self->cust_credited );
861 $balance = sprintf( "%.2f", $balance);
862 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
867 my( $self, $pkgnum ) = @_;
869 #my $balance = $self->charged;
871 $balance += $_->setup + $_->recur for $self->cust_bill_pkg_pkgnum($pkgnum);
873 $balance -= $_->amount for $self->cust_bill_pay_pkg($pkgnum);
874 $balance -= $_->amount for $self->cust_credit_bill_pkg($pkgnum);
876 $balance = sprintf( "%.2f", $balance);
877 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
883 Returns true if this invoice should be hidden. See the
884 selfservice-hide_invoices-taxclass configuraiton setting.
890 my $conf = $self->conf;
891 my $hide_taxclass = $conf->config('selfservice-hide_invoices-taxclass')
893 my @cust_bill_pkg = $self->cust_bill_pkg;
894 my @part_pkg = grep $_, map $_->part_pkg, @cust_bill_pkg;
895 ! grep { $_->taxclass ne $hide_taxclass } @part_pkg;
898 =item apply_payments_and_credits [ OPTION => VALUE ... ]
900 Applies unapplied payments and credits to this invoice.
901 Payments with the no_auto_apply flag set will not be applied.
903 A hash of optional arguments may be passed. Currently "manual" is supported.
904 If true, a payment receipt is sent instead of a statement when
905 'payment_receipt_email' configuration option is set.
907 If there is an error, returns the error, otherwise returns false.
911 sub apply_payments_and_credits {
912 my( $self, %options ) = @_;
913 my $conf = $self->conf;
915 local $SIG{HUP} = 'IGNORE';
916 local $SIG{INT} = 'IGNORE';
917 local $SIG{QUIT} = 'IGNORE';
918 local $SIG{TERM} = 'IGNORE';
919 local $SIG{TSTP} = 'IGNORE';
920 local $SIG{PIPE} = 'IGNORE';
922 my $oldAutoCommit = $FS::UID::AutoCommit;
923 local $FS::UID::AutoCommit = 0;
926 $self->select_for_update; #mutex
928 my @payments = grep { $_->unapplied > 0 }
929 grep { !$_->no_auto_apply }
930 $self->cust_main->cust_pay;
931 my @credits = grep { $_->credited > 0 } $self->cust_main->cust_credit;
933 if ( $conf->exists('pkg-balances') ) {
934 # limit @payments & @credits to those w/ a pkgnum grepped from $self
935 my %pkgnums = map { $_ => 1 } map $_->pkgnum, $self->cust_bill_pkg;
936 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
937 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
940 while ( $self->owed > 0 and ( @payments || @credits ) ) {
943 if ( @payments && @credits ) {
945 #decide which goes first by weight of top (unapplied) line item
947 my @open_lineitems = $self->open_cust_bill_pkg;
950 max( map { $_->part_pkg->pay_weight || 0 }
955 my $max_credit_weight =
956 max( map { $_->part_pkg->credit_weight || 0 }
962 #if both are the same... payments first? it has to be something
963 if ( $max_pay_weight >= $max_credit_weight ) {
969 } elsif ( @payments ) {
971 } elsif ( @credits ) {
974 die "guru meditation #12 and 35";
978 if ( $app eq 'pay' ) {
980 my $payment = shift @payments;
981 $unapp_amount = $payment->unapplied;
982 $app = new FS::cust_bill_pay { 'paynum' => $payment->paynum };
983 $app->pkgnum( $payment->pkgnum )
984 if $conf->exists('pkg-balances') && $payment->pkgnum;
986 } elsif ( $app eq 'credit' ) {
988 my $credit = shift @credits;
989 $unapp_amount = $credit->credited;
990 $app = new FS::cust_credit_bill { 'crednum' => $credit->crednum };
991 $app->pkgnum( $credit->pkgnum )
992 if $conf->exists('pkg-balances') && $credit->pkgnum;
995 die "guru meditation #12 and 35";
999 if ( $conf->exists('pkg-balances') && $app->pkgnum ) {
1000 warn "owed_pkgnum ". $app->pkgnum;
1001 $owed = $self->owed_pkgnum($app->pkgnum);
1003 $owed = $self->owed;
1005 next unless $owed > 0;
1007 warn "min ( $unapp_amount, $owed )\n" if $DEBUG;
1008 $app->amount( sprintf('%.2f', min( $unapp_amount, $owed ) ) );
1010 $app->invnum( $self->invnum );
1012 my $error = $app->insert(%options);
1014 $dbh->rollback if $oldAutoCommit;
1015 return "Error inserting ". $app->table. " record: $error";
1017 die $error if $error;
1021 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1028 Sends this invoice to the destinations configured for this customer: sends
1029 email, prints and/or faxes. See L<FS::cust_main_invoice>.
1031 Options can be passed as a hashref. Positional parameters are no longer
1034 I<template>: a suffix for alternate invoices
1036 I<agentnum>: obsolete, now does nothing.
1038 I<from> overrides the default email invoice From: address.
1040 I<amount>: obsolete, does nothing
1042 I<notice_name> overrides "Invoice" as the name of the sent document
1043 (templates from 10/2009 or newer required).
1045 I<lpr> overrides the system 'lpr' option as the command to print a document
1046 from standard input.
1052 my $opt = ref($_[0]) ? $_[0] : +{ @_ };
1053 my $conf = $self->conf;
1055 my $cust_main = $self->cust_main;
1057 my @invoicing_list = $cust_main->invoicing_list;
1060 if ( grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list )
1061 && ! $cust_main->invoice_noemail;
1064 if grep { $_ eq 'POST' } @invoicing_list; #postal
1066 #this has never been used post-$ORIGINAL_ISP afaik
1067 $self->fax_invoice($opt)
1068 if grep { $_ eq 'FAX' } @invoicing_list; #fax
1076 my $opt = shift || {};
1077 if ($opt and !ref($opt)) {
1078 die ref($self). '->email called with positional parameters';
1081 my $conf = $self->conf;
1083 my $from = delete $opt->{from};
1085 # this is where we set the From: address
1086 $from ||= $self->_agent_invoice_from || #XXX should go away
1087 $conf->invoice_from_full( $self->cust_main->agentnum );
1089 my @invoicing_list = $self->cust_main->invoicing_list_emailonly;
1091 if ( ! @invoicing_list ) { #no recipients
1092 if ( $conf->exists('cust_bill-no_recipients-error') ) {
1093 die 'No recipients for customer #'. $self->custnum;
1095 #default: better to notify this person than silence
1096 @invoicing_list = ($from);
1100 $self->SUPER::email( {
1102 'to' => \@invoicing_list,
1108 #this stays here for now because its explicitly used as
1109 # FS::cust_bill::queueable_email
1110 sub queueable_email {
1113 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1114 or die "invalid invoice number: " . $opt{invnum};
1116 $self->set('mode', $opt{mode})
1119 my %args = map {$_ => $opt{$_}}
1121 qw( from notice_name no_coupon template );
1123 my $error = $self->email( \%args );
1124 die $error if $error;
1130 my $conf = $self->conf;
1132 #my $template = scalar(@_) ? shift : '';
1135 my $subject = $conf->config('invoice_subject', $self->cust_main->agentnum)
1138 my $cust_main = $self->cust_main;
1139 my $name = $cust_main->name;
1140 my $name_short = $cust_main->name_short;
1141 my $invoice_number = $self->invnum;
1142 my $invoice_date = $self->_date_pretty;
1144 eval qq("$subject");
1149 'Invoice-'. $self->invnum. '.pdf';
1152 =item lpr_data HASHREF
1154 Returns the postscript or plaintext for this invoice as an arrayref.
1156 Options must be passed as a hashref. Positional parameters are no longer
1159 I<template>, if specified, is the name of a suffix for alternate invoices.
1161 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1167 my $conf = $self->conf;
1168 my $opt = shift || {};
1169 if ($opt and !ref($opt)) {
1170 # nobody does this anyway
1171 die "FS::cust_bill::lpr_data called with positional parameters";
1174 my $method = $conf->exists('invoice_latex') ? 'print_ps' : 'print_text';
1175 [ $self->$method( $opt ) ];
1180 Prints this invoice.
1182 Options must be passed as a hashref.
1184 I<template>, if specified, is the name of a suffix for alternate invoices.
1186 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1192 return if $self->hide;
1193 my $conf = $self->conf;
1194 my $opt = shift || {};
1195 if ($opt and !ref($opt)) {
1196 die "FS::cust_bill::print called with positional parameters";
1199 my $lpr = delete $opt->{lpr};
1200 if($conf->exists('invoice_print_pdf')) {
1201 # Add the invoice to the current batch.
1202 $self->batch_invoice($opt);
1206 $self->lpr_data($opt),
1207 'agentnum' => $self->cust_main->agentnum,
1213 =item fax_invoice HASHREF
1217 Options must be passed as a hashref.
1219 I<template>, if specified, is the name of a suffix for alternate invoices.
1221 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1227 return if $self->hide;
1228 my $conf = $self->conf;
1229 my $opt = shift || {};
1230 if ($opt and !ref($opt)) {
1231 die "FS::cust_bill::fax_invoice called with positional parameters";
1234 die 'FAX invoice destination not (yet?) supported with plain text invoices.'
1235 unless $conf->exists('invoice_latex');
1237 my $dialstring = $self->cust_main->getfield('fax');
1240 my $error = send_fax( 'docdata' => $self->lpr_data($opt),
1241 'dialstring' => $dialstring,
1243 die $error if $error;
1247 =item batch_invoice [ HASHREF ]
1249 Place this invoice into the open batch (see C<FS::bill_batch>). If there
1250 isn't an open batch, one will be created.
1252 HASHREF may contain any options to be passed to C<print_pdf>.
1257 my ($self, $opt) = @_;
1258 my $bill_batch = $self->get_open_bill_batch;
1259 my $cust_bill_batch = FS::cust_bill_batch->new({
1260 batchnum => $bill_batch->batchnum,
1261 invnum => $self->invnum,
1263 if ( $self->mode ) {
1264 $opt->{mode} ||= $self->mode;
1265 $opt->{mode} = $opt->{mode}->modenum if ref $opt->{mode};
1267 return $cust_bill_batch->insert($opt);
1270 =item get_open_batch
1272 Returns the currently open batch as an FS::bill_batch object, creating a new
1273 one if necessary. (A per-agent batch if invoice_print_pdf-spoolagent is
1278 sub get_open_bill_batch {
1280 my $conf = $self->conf;
1281 my $hashref = { status => 'O' };
1282 $hashref->{'agentnum'} = $conf->exists('invoice_print_pdf-spoolagent')
1283 ? $self->cust_main->agentnum
1285 my $batch = qsearchs('bill_batch', $hashref);
1286 return $batch if $batch;
1287 $batch = FS::bill_batch->new($hashref);
1288 my $error = $batch->insert;
1289 die $error if $error;
1293 =item ftp_invoice [ TEMPLATENAME ]
1295 Sends this invoice data via FTP.
1297 TEMPLATENAME is unused?
1303 my $conf = $self->conf;
1304 my $template = scalar(@_) ? shift : '';
1307 'protocol' => 'ftp',
1308 'server' => $conf->config('cust_bill-ftpserver'),
1309 'username' => $conf->config('cust_bill-ftpusername'),
1310 'password' => $conf->config('cust_bill-ftppassword'),
1311 'dir' => $conf->config('cust_bill-ftpdir'),
1312 'format' => $conf->config('cust_bill-ftpformat'),
1316 =item spool_invoice [ TEMPLATENAME ]
1318 Spools this invoice data (see L<FS::spool_csv>)
1320 TEMPLATENAME is unused?
1326 my $conf = $self->conf;
1327 my $template = scalar(@_) ? shift : '';
1330 'format' => $conf->config('cust_bill-spoolformat'),
1331 'agent_spools' => $conf->exists('cust_bill-spoolagent'),
1335 =item send_csv OPTION => VALUE, ...
1337 Sends invoice as a CSV data-file to a remote host with the specified protocol.
1341 protocol - currently only "ftp"
1347 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
1348 and YYMMDDHHMMSS is a timestamp.
1350 See L</print_csv> for a description of the output format.
1355 my($self, %opt) = @_;
1359 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1360 mkdir $spooldir, 0700 unless -d $spooldir;
1362 # don't localize dates here, they're a defined format
1363 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1364 my $file = "$spooldir/$tracctnum.csv";
1366 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1368 open(CSV, ">$file") or die "can't open $file: $!";
1376 if ( $opt{protocol} eq 'ftp' ) {
1377 eval "use Net::FTP;";
1379 $net = Net::FTP->new($opt{server}) or die @$;
1381 die "unknown protocol: $opt{protocol}";
1384 $net->login( $opt{username}, $opt{password} )
1385 or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
1387 $net->binary or die "can't set binary mode";
1389 $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
1391 $net->put($file) or die "can't put $file: $!";
1401 Spools CSV invoice data.
1407 =item format - any of FS::Misc::::Invoicing::spool_formats
1409 =item dest - if set (to POST, EMAIL or FAX), only sends spools invoices if the
1410 customer has the corresponding invoice destinations set (see
1411 L<FS::cust_main_invoice>).
1413 =item agent_spools - if set to a true value, will spool to per-agent files
1414 rather than a single global file
1416 =item upload_targetnum - if set to a target (see L<FS::upload_target>), will
1417 append to that spool. L<FS::Cron::upload> will then send the spool file to
1420 =item balanceover - if set, only spools the invoice if the total amount owed on
1421 this invoice and all older invoices is greater than the specified amount.
1423 =item time - the "current time". Controls the printing of past due messages
1431 my($self, %opt) = @_;
1433 my $time = $opt{'time'} || time;
1434 my $cust_main = $self->cust_main;
1436 if ( $opt{'dest'} ) {
1437 my %invoicing_list = map { /^(POST|FAX)$/ or 'EMAIL' =~ /^(.*)$/; $1 => 1 }
1438 $cust_main->invoicing_list;
1439 return 'N/A' unless $invoicing_list{$opt{'dest'}}
1440 || ! keys %invoicing_list;
1443 if ( $opt{'balanceover'} ) {
1445 if $cust_main->total_owed_date($self->_date) < $opt{'balanceover'};
1448 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1449 mkdir $spooldir, 0700 unless -d $spooldir;
1451 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', $time);
1454 if ( $opt{'agent_spools'} ) {
1455 $file = 'agentnum'.$cust_main->agentnum;
1460 if ( $opt{'upload_targetnum'} ) {
1461 $spooldir .= '/target'.$opt{'upload_targetnum'};
1462 mkdir $spooldir, 0700 unless -d $spooldir;
1463 } # otherwise it just goes into export.xxx/cust_bill
1465 if ( lc($opt{'format'}) eq 'billco' ) {
1469 $file = "$spooldir/$file.csv";
1471 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum);
1473 open(CSV, ">>$file") or die "can't open $file: $!";
1474 flock(CSV, LOCK_EX);
1479 if ( lc($opt{'format'}) eq 'billco' ) {
1481 flock(CSV, LOCK_UN);
1484 $file =~ s/-header.csv$/-detail.csv/;
1486 open(CSV,">>$file") or die "can't open $file: $!";
1487 flock(CSV, LOCK_EX);
1491 print CSV $detail if defined($detail);
1493 flock(CSV, LOCK_UN);
1500 =item print_csv OPTION => VALUE, ...
1502 Returns CSV data for this invoice.
1506 format - 'default', 'billco', 'oneline', 'bridgestone'
1508 Returns a list consisting of two scalars. The first is a single line of CSV
1509 header information for this invoice. The second is one or more lines of CSV
1510 detail information for this invoice.
1512 If I<format> is not specified or "default", the fields of the CSV file are as
1515 record_type, invnum, custnum, _date, charged, first, last, company, address1,
1516 address2, city, state, zip, country, pkg, setup, recur, sdate, edate
1520 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
1522 B<record_type> is C<cust_bill> for the initial header line only. The
1523 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
1524 fields are filled in.
1526 B<record_type> is C<cust_bill_pkg> for detail lines. Only the first two fields
1527 (B<record_type> and B<invnum>) and the last five fields (B<pkg> through B<edate>)
1530 =item invnum - invoice number
1532 =item custnum - customer number
1534 =item _date - invoice date
1536 =item charged - total invoice amount
1538 =item first - customer first name
1540 =item last - customer first name
1542 =item company - company name
1544 =item address1 - address line 1
1546 =item address2 - address line 1
1556 =item pkg - line item description
1558 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
1560 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
1562 =item sdate - start date for recurring fee
1564 =item edate - end date for recurring fee
1568 If I<format> is "billco", the fields of the header CSV file are as follows:
1570 +-------------------------------------------------------------------+
1571 | FORMAT HEADER FILE |
1572 |-------------------------------------------------------------------|
1573 | Field | Description | Name | Type | Width |
1574 | 1 | N/A-Leave Empty | RC | CHAR | 2 |
1575 | 2 | N/A-Leave Empty | CUSTID | CHAR | 15 |
1576 | 3 | Transaction Account No | TRACCTNUM | CHAR | 15 |
1577 | 4 | Transaction Invoice No | TRINVOICE | CHAR | 15 |
1578 | 5 | Transaction Zip Code | TRZIP | CHAR | 5 |
1579 | 6 | Transaction Company Bill To | TRCOMPANY | CHAR | 30 |
1580 | 7 | Transaction Contact Bill To | TRNAME | CHAR | 30 |
1581 | 8 | Additional Address Unit Info | TRADDR1 | CHAR | 30 |
1582 | 9 | Bill To Street Address | TRADDR2 | CHAR | 30 |
1583 | 10 | Ancillary Billing Information | TRADDR3 | CHAR | 30 |
1584 | 11 | Transaction City Bill To | TRCITY | CHAR | 20 |
1585 | 12 | Transaction State Bill To | TRSTATE | CHAR | 2 |
1586 | 13 | Bill Cycle Close Date | CLOSEDATE | CHAR | 10 |
1587 | 14 | Bill Due Date | DUEDATE | CHAR | 10 |
1588 | 15 | Previous Balance | BALFWD | NUM* | 9 |
1589 | 16 | Pmt/CR Applied | CREDAPPLY | NUM* | 9 |
1590 | 17 | Total Current Charges | CURRENTCHG | NUM* | 9 |
1591 | 18 | Total Amt Due | TOTALDUE | NUM* | 9 |
1592 | 19 | Total Amt Due | AMTDUE | NUM* | 9 |
1593 | 20 | 30 Day Aging | AMT30 | NUM* | 9 |
1594 | 21 | 60 Day Aging | AMT60 | NUM* | 9 |
1595 | 22 | 90 Day Aging | AMT90 | NUM* | 9 |
1596 | 23 | Y/N | AGESWITCH | CHAR | 1 |
1597 | 24 | Remittance automation | SCANLINE | CHAR | 100 |
1598 | 25 | Total Taxes & Fees | TAXTOT | NUM* | 9 |
1599 | 26 | Customer Reference Number | CUSTREF | CHAR | 15 |
1600 | 27 | Federal Tax*** | FEDTAX | NUM* | 9 |
1601 | 28 | State Tax*** | STATETAX | NUM* | 9 |
1602 | 29 | Other Taxes & Fees*** | OTHERTAX | NUM* | 9 |
1603 +-------+-------------------------------+------------+------+-------+
1605 If I<format> is "billco", the fields of the detail CSV file are as follows:
1607 FORMAT FOR DETAIL FILE
1609 Field | Description | Name | Type | Width
1610 1 | N/A-Leave Empty | RC | CHAR | 2
1611 2 | N/A-Leave Empty | CUSTID | CHAR | 15
1612 3 | Account Number | TRACCTNUM | CHAR | 15
1613 4 | Invoice Number | TRINVOICE | CHAR | 15
1614 5 | Line Sequence (sort order) | LINESEQ | NUM | 6
1615 6 | Transaction Detail | DETAILS | CHAR | 100
1616 7 | Amount | AMT | NUM* | 9
1617 8 | Line Format Control** | LNCTRL | CHAR | 2
1618 9 | Grouping Code | GROUP | CHAR | 2
1619 10 | User Defined | ACCT CODE | CHAR | 15
1621 If format is 'oneline', there is no detail file. Each invoice has a
1622 header line only, with the fields:
1624 Agent number, agent name, customer number, first name, last name, address
1625 line 1, address line 2, city, state, zip, invoice date, invoice number,
1626 amount charged, amount due, previous balance, due date.
1628 and then, for each line item, three columns containing the package number,
1629 description, and amount.
1631 If format is 'bridgestone', there is no detail file. Each invoice has a
1632 header line with the following fields in a fixed-width format:
1634 Customer number (in display format), date, name (first last), company,
1635 address 1, address 2, city, state, zip.
1637 This is a mailing list format, and has no per-invoice fields. To avoid
1638 sending redundant notices, the spooling event should have a "once" or
1639 "once_percust_every" condition.
1644 my($self, %opt) = @_;
1646 eval "use Text::CSV_XS";
1649 my $cust_main = $self->cust_main;
1651 my $csv = Text::CSV_XS->new({'always_quote'=>1});
1652 my $format = lc($opt{'format'});
1654 my $time = $opt{'time'} || time;
1656 my $tracctnum = ''; #leaking out from billco-specific sections :/
1657 if ( $format eq 'billco' ) {
1660 $self->conf->config('billco-account_num', $cust_main->agentnum);
1662 $tracctnum = $account_num eq 'display_custnum'
1663 ? $cust_main->display_custnum
1664 : $opt{'tracctnum'};
1667 $taxtotal += $_->{'amount'} foreach $self->_items_tax;
1669 my $duedate = $self->due_date2str('%m/%d/%Y'); # hardcoded, NOT date_format
1671 my( $previous_balance, @unused ) = $self->previous; #previous balance
1673 my $pmt_cr_applied = 0;
1674 $pmt_cr_applied += $_->{'amount'}
1675 foreach ( $self->_items_payments(%opt), $self->_items_credits(%opt) ) ;
1677 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
1680 '', # 1 | N/A-Leave Empty CHAR 2
1681 '', # 2 | N/A-Leave Empty CHAR 15
1682 $tracctnum, # 3 | Transaction Account No CHAR 15
1683 $self->invnum, # 4 | Transaction Invoice No CHAR 15
1684 $cust_main->zip, # 5 | Transaction Zip Code CHAR 5
1685 $cust_main->company, # 6 | Transaction Company Bill To CHAR 30
1686 #$cust_main->payname, # 7 | Transaction Contact Bill To CHAR 30
1687 $cust_main->contact, # 7 | Transaction Contact Bill To CHAR 30
1688 $cust_main->address2, # 8 | Additional Address Unit Info CHAR 30
1689 $cust_main->address1, # 9 | Bill To Street Address CHAR 30
1690 '', # 10 | Ancillary Billing Information CHAR 30
1691 $cust_main->city, # 11 | Transaction City Bill To CHAR 20
1692 $cust_main->state, # 12 | Transaction State Bill To CHAR 2
1695 time2str("%m/%d/%Y", $self->_date), # 13 | Bill Cycle Close Date CHAR 10
1698 $duedate, # 14 | Bill Due Date CHAR 10
1700 $previous_balance, # 15 | Previous Balance NUM* 9
1701 $pmt_cr_applied, # 16 | Pmt/CR Applied NUM* 9
1702 sprintf("%.2f", $self->charged), # 17 | Total Current Charges NUM* 9
1703 $totaldue, # 18 | Total Amt Due NUM* 9
1704 $totaldue, # 19 | Total Amt Due NUM* 9
1705 '', # 20 | 30 Day Aging NUM* 9
1706 '', # 21 | 60 Day Aging NUM* 9
1707 '', # 22 | 90 Day Aging NUM* 9
1708 'N', # 23 | Y/N CHAR 1
1709 '', # 24 | Remittance automation CHAR 100
1710 $taxtotal, # 25 | Total Taxes & Fees NUM* 9
1711 $self->custnum, # 26 | Customer Reference Number CHAR 15
1712 '0', # 27 | Federal Tax*** NUM* 9
1713 sprintf("%.2f", $taxtotal), # 28 | State Tax*** NUM* 9
1714 '0', # 29 | Other Taxes & Fees*** NUM* 9
1717 } elsif ( $format eq 'oneline' ) { #name
1719 my ($previous_balance) = $self->previous;
1720 $previous_balance = sprintf('%.2f', $previous_balance);
1721 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
1727 $self->_items_pkg, #_items_nontax? no sections or anything
1732 $cust_main->agentnum,
1733 $cust_main->agent->agent,
1737 $cust_main->company,
1738 $cust_main->address1,
1739 $cust_main->address2,
1745 time2str("%x", $self->_date),
1750 $self->due_date2str("%x"),
1755 } elsif ( $format eq 'bridgestone' ) {
1757 # bypass the CSV stuff and just return this
1758 my $longdate = time2str('%B %d, %Y', $time); #current time, right?
1759 my $zip = $cust_main->zip;
1761 my $prefix = $self->conf->config('bridgestone-prefix', $cust_main->agentnum)
1765 "%-5s%-15s%-20s%-30s%-30s%-30s%-30s%-20s%-2s%-9s\n",
1767 $cust_main->display_custnum,
1769 uc(substr($cust_main->contact_firstlast,0,30)),
1770 uc(substr($cust_main->company ,0,30)),
1771 uc(substr($cust_main->address1 ,0,30)),
1772 uc(substr($cust_main->address2 ,0,30)),
1773 uc(substr($cust_main->city ,0,20)),
1774 uc($cust_main->state),
1780 } elsif ( $format eq 'ics' ) {
1782 my $bill = $cust_main->bill_location;
1783 my $zip = $bill->zip;
1787 if ( $zip =~ /^(\d{5})(\d{4})$/ ) {
1792 # minor false laziness with print_generic
1793 my ($previous_balance) = $self->previous;
1794 my $balance_due = $self->owed + $previous_balance;
1795 my $payment_total = sum(0, map { $_->{'amount'} } $self->_items_payments);
1796 my $credit_total = sum(0, map { $_->{'amount'} } $self->_items_credits);
1799 if ( $self->due_date and $time >= $self->due_date ) {
1800 $past_due = sprintf('Past due:$%0.2f Due Immediately', $balance_due);
1804 my $header = sprintf(
1805 '%-10s%-30s%-48s%-2s%-50s%-30s%-30s%-25s%-2s%-5s%-4s%-8s%-8s%-10s%-10s%-10s%-10s%-10s%-10s%-480s%-35s',
1806 $cust_main->display_custnum, #BID
1807 uc($cust_main->first), #FNAME
1808 uc($cust_main->last), #LNAME
1809 '00', #BATCH, should this ever be anything else?
1810 uc($cust_main->company), #COMP
1811 uc($bill->address1), #STREET1
1812 uc($bill->address2), #STREET2
1813 uc($bill->city), #CITY
1814 uc($bill->state), #STATE
1817 time2str('%Y%m%d', $self->_date), #BILL_DATE
1818 $self->due_date2str('%Y%m%d'), #DUE_DATE,
1819 ( map {sprintf('%0.2f', $_)}
1820 $balance_due, #AMNT_DUE
1821 $previous_balance, #PREV_BAL
1822 $payment_total, #PYMT_RCVD
1823 $credit_total, #CREDITS
1824 $previous_balance, #BEG_BAL--is this correct?
1825 $self->charged, #NEW_CHRG
1828 $past_due, #PAST_MSG
1832 my %svc_class = ('' => ''); # maybe cache this more persistently?
1834 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1836 my $show_pkgnum = $cust_bill_pkg->pkgnum || '';
1837 my $cust_pkg = $cust_bill_pkg->cust_pkg if $show_pkgnum;
1841 my @dates = ( $self->_date, undef );
1842 if ( my $prev = $cust_bill_pkg->previous_cust_bill_pkg ) {
1843 $dates[1] = $prev->sdate; #questionable
1846 # generate an 01 detail for each service
1847 my @svcs = $cust_pkg->h_cust_svc(@dates, 'I');
1848 foreach my $cust_svc ( @svcs ) {
1849 $show_pkgnum = ''; # hide it if we're showing svcnums
1851 my $svcpart = $cust_svc->svcpart;
1852 if (!exists($svc_class{$svcpart})) {
1853 my $classnum = $cust_svc->part_svc->classnum;
1854 my $part_svc_class = FS::part_svc_class->by_key($classnum)
1856 $svc_class{$svcpart} = $part_svc_class ?
1857 $part_svc_class->classname :
1861 my @h_label = $cust_svc->label(@dates, 'I');
1862 push @details, sprintf('01%-9s%-20s%-47s',
1864 $svc_class{$svcpart},
1867 } #foreach $cust_svc
1870 my $desc = $cust_bill_pkg->desc; # itemdesc or part_pkg.pkg
1871 if ($cust_bill_pkg->recur > 0) {
1872 $desc .= ' '.time2str('%d-%b-%Y', $cust_bill_pkg->sdate).' to '.
1873 time2str('%d-%b-%Y', $cust_bill_pkg->edate - 86400);
1875 push @details, sprintf('02%-6s%-60s%-10s',
1878 sprintf('%0.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
1880 } #foreach $cust_bill_pkg
1882 # Tag this row so that we know whether this is one page (1), two pages
1883 # (2), # or "big" (B). The tag will be stripped off before uploading.
1884 if ( scalar(@details) < 12 ) {
1886 } elsif ( scalar(@details) < 58 ) {
1892 return join('', $header, @details, "\n");
1900 time2str("%x", $self->_date),
1901 sprintf("%.2f", $self->charged),
1902 ( map { $cust_main->getfield($_) }
1903 qw( first last company address1 address2 city state zip country ) ),
1905 ) or die "can't create csv";
1908 my $header = $csv->string. "\n";
1911 if ( lc($opt{'format'}) eq 'billco' ) {
1914 my %items_opt = ( format => 'template',
1915 escape_function => sub { shift } );
1916 # I don't know what characters billco actually tolerates in spool entries.
1917 # Text::CSV will take care of delimiters, though.
1919 my @items = ( $self->_items_pkg(%items_opt),
1920 $self->_items_fee(%items_opt) );
1921 foreach my $item (@items) {
1923 my $description = $item->{'description'};
1924 if ( $item->{'_is_discount'} and exists($item->{ext_description}[0]) ) {
1925 $description .= ': ' . $item->{ext_description}[0];
1929 '', # 1 | N/A-Leave Empty CHAR 2
1930 '', # 2 | N/A-Leave Empty CHAR 15
1931 $tracctnum, # 3 | Account Number CHAR 15
1932 $self->invnum, # 4 | Invoice Number CHAR 15
1933 $lineseq++, # 5 | Line Sequence (sort order) NUM 6
1934 $description, # 6 | Transaction Detail CHAR 100
1935 $item->{'amount'}, # 7 | Amount NUM* 9
1936 '', # 8 | Line Format Control** CHAR 2
1937 '', # 9 | Grouping Code CHAR 2
1938 '', # 10 | User Defined CHAR 15
1941 $detail .= $csv->string. "\n";
1945 } elsif ( lc($opt{'format'}) eq 'oneline' ) {
1951 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1953 my($pkg, $setup, $recur, $sdate, $edate);
1954 if ( $cust_bill_pkg->pkgnum ) {
1956 ($pkg, $setup, $recur, $sdate, $edate) = (
1957 $cust_bill_pkg->part_pkg->pkg,
1958 ( $cust_bill_pkg->setup != 0
1959 ? sprintf("%.2f", $cust_bill_pkg->setup )
1961 ( $cust_bill_pkg->recur != 0
1962 ? sprintf("%.2f", $cust_bill_pkg->recur )
1964 ( $cust_bill_pkg->sdate
1965 ? time2str("%x", $cust_bill_pkg->sdate)
1967 ($cust_bill_pkg->edate
1968 ? time2str("%x", $cust_bill_pkg->edate)
1972 } else { #pkgnum tax
1973 next unless $cust_bill_pkg->setup != 0;
1974 $pkg = $cust_bill_pkg->desc;
1975 $setup = sprintf('%10.2f', $cust_bill_pkg->setup );
1976 ( $sdate, $edate ) = ( '', '' );
1982 ( map { '' } (1..11) ),
1983 ($pkg, $setup, $recur, $sdate, $edate)
1984 ) or die "can't create csv";
1986 $detail .= $csv->string. "\n";
1992 ( $header, $detail );
1997 croak 'cust_bill->comp is deprecated (COMP payments are deprecated)';
2002 Attempts to pay this invoice with a credit card payment via a
2003 Business::OnlinePayment realtime gateway. See
2004 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2005 for supported processors.
2011 $self->realtime_bop( 'CC', @_ );
2016 Attempts to pay this invoice with an electronic check (ACH) payment via a
2017 Business::OnlinePayment realtime gateway. See
2018 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2019 for supported processors.
2025 $self->realtime_bop( 'ECHECK', @_ );
2030 Attempts to pay this invoice with phone bill (LEC) payment via a
2031 Business::OnlinePayment realtime gateway. See
2032 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2033 for supported processors.
2039 $self->realtime_bop( 'LEC', @_ );
2043 my( $self, $method ) = (shift,shift);
2044 my $conf = $self->conf;
2047 my $cust_main = $self->cust_main;
2048 my $balance = $cust_main->balance;
2049 my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
2050 $amount = sprintf("%.2f", $amount);
2051 return "not run (balance $balance)" unless $amount > 0;
2053 my $description = 'Internet Services';
2054 if ( $conf->exists('business-onlinepayment-description') ) {
2055 my $dtempl = $conf->config('business-onlinepayment-description');
2057 my $agent_obj = $cust_main->agent
2058 or die "can't retreive agent for $cust_main (agentnum ".
2059 $cust_main->agentnum. ")";
2060 my $agent = $agent_obj->agent;
2061 my $pkgs = join(', ',
2062 map { $_->part_pkg->pkg }
2063 grep { $_->pkgnum } $self->cust_bill_pkg
2065 $description = eval qq("$dtempl");
2068 $cust_main->realtime_bop($method, $amount,
2069 'description' => $description,
2070 'invnum' => $self->invnum,
2071 #this didn't do what we want, it just calls apply_payments_and_credits
2073 'apply_to_invoice' => 1,
2076 #this changes application behavior: auto payments
2077 #triggered against a specific invoice are now applied
2078 #to that invoice instead of oldest open.
2084 =item batch_card OPTION => VALUE...
2086 Adds a payment for this invoice to the pending credit card batch (see
2087 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2088 runs the payment using a realtime gateway.
2093 my ($self, %options) = @_;
2094 my $cust_main = $self->cust_main;
2096 $options{invnum} = $self->invnum;
2098 $cust_main->batch_card(%options);
2101 sub _agent_template {
2103 $self->cust_main->agent_template;
2106 sub _agent_invoice_from {
2108 $self->cust_main->agent_invoice_from;
2111 =item invoice_barcode DIR_OR_FALSE
2113 Generates an invoice barcode PNG. If DIR_OR_FALSE is a true value,
2114 it is taken as the temp directory where the PNG file will be generated and the
2115 PNG file name is returned. Otherwise, the PNG image itself is returned.
2119 sub invoice_barcode {
2120 my ($self, $dir) = (shift,shift);
2122 my $gdbar = new GD::Barcode('Code39',$self->invnum);
2123 die "can't create barcode: " . $GD::Barcode::errStr unless $gdbar;
2124 my $gd = $gdbar->plot(Height => 30);
2127 my $bh = new File::Temp( TEMPLATE => 'barcode.'. $self->invnum. '.XXXXXXXX',
2131 ) or die "can't open temp file: $!\n";
2132 print $bh $gd->png or die "cannot write barcode to file: $!\n";
2133 my $png_file = $bh->filename;
2140 =item invnum_date_pretty
2142 Returns a string with the invoice number and date, for example:
2143 "Invoice #54 (3/20/2008)".
2145 Intended for back-end context, with regard to translation and date formatting.
2149 #note: this uses _date_pretty_unlocalized because _date_pretty is too expensive
2150 # for backend use (and also does the wrong thing, localizing for end customer
2151 # instead of backoffice configured date format)
2152 sub invnum_date_pretty {
2154 #$self->mt('Invoice #').
2155 'Invoice #'. #XXX should be translated ala web UI user (not invoice customer)
2156 $self->invnum. ' ('. $self->_date_pretty_unlocalized. ')';
2159 #sub _items_extra_usage_sections {
2161 # my $escape = shift;
2163 # my %sections = ();
2165 # my %usage_class = map{ $_->classname, $_ } qsearch('usage_class', {});
2166 # foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2168 # next unless $cust_bill_pkg->pkgnum > 0;
2170 # foreach my $section ( keys %usage_class ) {
2172 # my $usage = $cust_bill_pkg->usage($section);
2174 # next unless $usage && $usage > 0;
2176 # $sections{$section} ||= 0;
2177 # $sections{$section} += $usage;
2183 # map { { 'description' => &{$escape}($_),
2184 # 'subtotal' => $sections{$_},
2185 # 'summarized' => '',
2186 # 'tax_section' => '',
2189 # sort {$usage_class{$a}->weight <=> $usage_class{$b}->weight} keys %sections;
2193 sub _items_extra_usage_sections {
2195 my $conf = $self->conf;
2203 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 40;
2205 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
2206 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2207 next unless $cust_bill_pkg->pkgnum > 0;
2209 foreach my $classnum ( keys %usage_class ) {
2210 my $section = $usage_class{$classnum}->classname;
2211 $classnums{$section} = $classnum;
2213 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail($classnum) ) {
2214 my $amount = $detail->amount;
2215 next unless $amount && $amount > 0;
2217 $sections{$section} ||= { 'subtotal'=>0, 'calls'=>0, 'duration'=>0 };
2218 $sections{$section}{amount} += $amount; #subtotal
2219 $sections{$section}{calls}++;
2220 $sections{$section}{duration} += $detail->duration;
2222 my $desc = $detail->regionname;
2223 my $description = $desc;
2224 $description = substr($desc, 0, $maxlength). '...'
2225 if $format eq 'latex' && length($desc) > $maxlength;
2227 $lines{$section}{$desc} ||= {
2228 description => &{$escape}($description),
2229 #pkgpart => $part_pkg->pkgpart,
2230 pkgnum => $cust_bill_pkg->pkgnum,
2235 #unit_amount => $cust_bill_pkg->unitrecur,
2236 quantity => $cust_bill_pkg->quantity,
2237 product_code => 'N/A',
2238 ext_description => [],
2241 $lines{$section}{$desc}{amount} += $amount;
2242 $lines{$section}{$desc}{calls}++;
2243 $lines{$section}{$desc}{duration} += $detail->duration;
2249 my %sectionmap = ();
2250 foreach (keys %sections) {
2251 my $usage_class = $usage_class{$classnums{$_}};
2252 $sectionmap{$_} = { 'description' => &{$escape}($_),
2253 'amount' => $sections{$_}{amount}, #subtotal
2254 'calls' => $sections{$_}{calls},
2255 'duration' => $sections{$_}{duration},
2257 'tax_section' => '',
2258 'sort_weight' => $usage_class->weight,
2259 ( $usage_class->format
2260 ? ( map { $_ => $usage_class->$_($format) }
2261 qw( description_generator header_generator total_generator total_line_generator )
2268 my @sections = sort { $a->{sort_weight} <=> $b->{sort_weight} }
2272 foreach my $section ( keys %lines ) {
2273 foreach my $line ( keys %{$lines{$section}} ) {
2274 my $l = $lines{$section}{$line};
2275 $l->{section} = $sectionmap{$section};
2276 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2277 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
2282 return(\@sections, \@lines);
2288 my $end = $self->_date;
2290 # start at date of previous invoice + 1 second or 0 if no previous invoice
2291 my $start = $self->scalar_sql("SELECT max(_date) FROM cust_bill WHERE custnum = ? and invnum != ?",$self->custnum,$self->invnum);
2292 $start = 0 if !$start;
2295 my $cust_main = $self->cust_main;
2296 my @pkgs = $cust_main->all_pkgs;
2297 my($num_activated,$num_deactivated,$num_portedin,$num_portedout,$minutes)
2300 foreach my $pkg ( @pkgs ) {
2301 my @h_cust_svc = $pkg->h_cust_svc($end);
2302 foreach my $h_cust_svc ( @h_cust_svc ) {
2303 next if grep {$_ eq $h_cust_svc->svcnum} @seen;
2304 next unless $h_cust_svc->part_svc->svcdb eq 'svc_phone';
2306 my $inserted = $h_cust_svc->date_inserted;
2307 my $deleted = $h_cust_svc->date_deleted;
2308 my $phone_inserted = $h_cust_svc->h_svc_x($inserted+5);
2310 $phone_deleted = $h_cust_svc->h_svc_x($deleted) if $deleted;
2312 # DID either activated or ported in; cannot be both for same DID simultaneously
2313 if ($inserted >= $start && $inserted <= $end && $phone_inserted
2314 && (!$phone_inserted->lnp_status
2315 || $phone_inserted->lnp_status eq ''
2316 || $phone_inserted->lnp_status eq 'native')) {
2319 else { # this one not so clean, should probably move to (h_)svc_phone
2320 local($FS::Record::qsearch_qualify_columns) = 0;
2321 my $phone_portedin = qsearchs( 'h_svc_phone',
2322 { 'svcnum' => $h_cust_svc->svcnum,
2323 'lnp_status' => 'portedin' },
2324 FS::h_svc_phone->sql_h_searchs($end),
2326 $num_portedin++ if $phone_portedin;
2329 # DID either deactivated or ported out; cannot be both for same DID simultaneously
2330 if($deleted >= $start && $deleted <= $end && $phone_deleted
2331 && (!$phone_deleted->lnp_status
2332 || $phone_deleted->lnp_status ne 'portingout')) {
2335 elsif($deleted >= $start && $deleted <= $end && $phone_deleted
2336 && $phone_deleted->lnp_status
2337 && $phone_deleted->lnp_status eq 'portingout') {
2341 # increment usage minutes
2342 if ( $phone_inserted ) {
2343 my @cdrs = $phone_inserted->get_cdrs('begin'=>$start,'end'=>$end,'billsec_sum'=>1);
2344 $minutes = $cdrs[0]->billsec_sum if scalar(@cdrs) == 1;
2347 warn "WARNING: no matching h_svc_phone insert record for insert time $inserted, svcnum " . $h_cust_svc->svcnum;
2350 # don't look at this service again
2351 push @seen, $h_cust_svc->svcnum;
2355 $minutes = sprintf("%d", $minutes);
2356 ("Activated: $num_activated Ported-In: $num_portedin Deactivated: "
2357 . "$num_deactivated Ported-Out: $num_portedout ",
2358 "Total Minutes: $minutes");
2361 sub _items_accountcode_cdr {
2366 my $section = { 'amount' => 0,
2369 'sort_weight' => '',
2371 'description' => 'Usage by Account Code',
2377 my %accountcodes = ();
2379 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2380 next unless $cust_bill_pkg->pkgnum > 0;
2382 my @header = $cust_bill_pkg->details_header;
2383 next unless scalar(@header);
2384 $section->{'header'} = join(',',@header);
2386 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
2388 $section->{'header'} = $detail->formatted('format' => $format)
2389 if($detail->detail eq $section->{'header'});
2391 my $accountcode = $detail->accountcode;
2392 next unless $accountcode;
2394 my $amount = $detail->amount;
2395 next unless $amount && $amount > 0;
2397 $accountcodes{$accountcode} ||= {
2398 description => $accountcode,
2405 product_code => 'N/A',
2406 section => $section,
2407 ext_description => [ $section->{'header'} ],
2411 $section->{'amount'} += $amount;
2412 $accountcodes{$accountcode}{'amount'} += $amount;
2413 $accountcodes{$accountcode}{calls}++;
2414 $accountcodes{$accountcode}{duration} += $detail->duration;
2415 push @{$accountcodes{$accountcode}{detail_temp}}, $detail;
2419 foreach my $l ( values %accountcodes ) {
2420 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2421 my @sorted_detail = sort { $a->startdate <=> $b->startdate } @{$l->{detail_temp}};
2422 foreach my $sorted_detail ( @sorted_detail ) {
2423 push @{$l->{ext_description}}, $sorted_detail->formatted('format'=>$format);
2425 delete $l->{detail_temp};
2429 my @sorted_lines = sort { $a->{'description'} <=> $b->{'description'} } @lines;
2431 return ($section,\@sorted_lines);
2434 sub _items_svc_phone_sections {
2436 my $conf = $self->conf;
2444 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 40;
2446 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
2447 $usage_class{''} ||= new FS::usage_class { 'classname' => '', 'weight' => 0 };
2449 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2450 next unless $cust_bill_pkg->pkgnum > 0;
2452 my @header = $cust_bill_pkg->details_header;
2453 next unless scalar(@header);
2455 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
2457 my $phonenum = $detail->phonenum;
2458 next unless $phonenum;
2460 my $amount = $detail->amount;
2461 next unless $amount && $amount > 0;
2463 $sections{$phonenum} ||= { 'amount' => 0,
2466 'sort_weight' => -1,
2467 'phonenum' => $phonenum,
2469 $sections{$phonenum}{amount} += $amount; #subtotal
2470 $sections{$phonenum}{calls}++;
2471 $sections{$phonenum}{duration} += $detail->duration;
2473 my $desc = $detail->regionname;
2474 my $description = $desc;
2475 $description = substr($desc, 0, $maxlength). '...'
2476 if $format eq 'latex' && length($desc) > $maxlength;
2478 $lines{$phonenum}{$desc} ||= {
2479 description => &{$escape}($description),
2480 #pkgpart => $part_pkg->pkgpart,
2488 product_code => 'N/A',
2489 ext_description => [],
2492 $lines{$phonenum}{$desc}{amount} += $amount;
2493 $lines{$phonenum}{$desc}{calls}++;
2494 $lines{$phonenum}{$desc}{duration} += $detail->duration;
2496 my $line = $usage_class{$detail->classnum}->classname;
2497 $sections{"$phonenum $line"} ||=
2501 'sort_weight' => $usage_class{$detail->classnum}->weight,
2502 'phonenum' => $phonenum,
2503 'header' => [ @header ],
2505 $sections{"$phonenum $line"}{amount} += $amount; #subtotal
2506 $sections{"$phonenum $line"}{calls}++;
2507 $sections{"$phonenum $line"}{duration} += $detail->duration;
2509 $lines{"$phonenum $line"}{$desc} ||= {
2510 description => &{$escape}($description),
2511 #pkgpart => $part_pkg->pkgpart,
2519 product_code => 'N/A',
2520 ext_description => [],
2523 $lines{"$phonenum $line"}{$desc}{amount} += $amount;
2524 $lines{"$phonenum $line"}{$desc}{calls}++;
2525 $lines{"$phonenum $line"}{$desc}{duration} += $detail->duration;
2526 push @{$lines{"$phonenum $line"}{$desc}{ext_description}},
2527 $detail->formatted('format' => $format);
2532 my %sectionmap = ();
2533 my $simple = new FS::usage_class { format => 'simple' }; #bleh
2534 foreach ( keys %sections ) {
2535 my @header = @{ $sections{$_}{header} || [] };
2537 new FS::usage_class { format => 'usage_'. (scalar(@header) || 6). 'col' };
2538 my $summary = $sections{$_}{sort_weight} < 0 ? 1 : 0;
2539 my $usage_class = $summary ? $simple : $usage_simple;
2540 my $ending = $summary ? ' usage charges' : '';
2543 $gen_opt{label} = [ map{ &{$escape}($_) } @header ];
2545 $sectionmap{$_} = { 'description' => &{$escape}($_. $ending),
2546 'amount' => $sections{$_}{amount}, #subtotal
2547 'calls' => $sections{$_}{calls},
2548 'duration' => $sections{$_}{duration},
2550 'tax_section' => '',
2551 'phonenum' => $sections{$_}{phonenum},
2552 'sort_weight' => $sections{$_}{sort_weight},
2553 'post_total' => $summary, #inspire pagebreak
2555 ( map { $_ => $usage_class->$_($format, %gen_opt) }
2556 qw( description_generator
2559 total_line_generator
2566 my @sections = sort { $a->{phonenum} cmp $b->{phonenum} ||
2567 $a->{sort_weight} <=> $b->{sort_weight}
2572 foreach my $section ( keys %lines ) {
2573 foreach my $line ( keys %{$lines{$section}} ) {
2574 my $l = $lines{$section}{$line};
2575 $l->{section} = $sectionmap{$section};
2576 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2577 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
2582 if($conf->exists('phone_usage_class_summary')) {
2583 # this only works with Latex
2587 # after this, we'll have only two sections per DID:
2588 # Calls Summary and Calls Detail
2589 foreach my $section ( @sections ) {
2590 if($section->{'post_total'}) {
2591 $section->{'description'} = 'Calls Summary: '.$section->{'phonenum'};
2592 $section->{'total_line_generator'} = sub { '' };
2593 $section->{'total_generator'} = sub { '' };
2594 $section->{'header_generator'} = sub { '' };
2595 $section->{'description_generator'} = '';
2596 push @newsections, $section;
2597 my %calls_detail = %$section;
2598 $calls_detail{'post_total'} = '';
2599 $calls_detail{'sort_weight'} = '';
2600 $calls_detail{'description_generator'} = sub { '' };
2601 $calls_detail{'header_generator'} = sub {
2602 return ' & Date/Time & Called Number & Duration & Price'
2603 if $format eq 'latex';
2606 $calls_detail{'description'} = 'Calls Detail: '
2607 . $section->{'phonenum'};
2608 push @newsections, \%calls_detail;
2612 # after this, each usage class is collapsed/summarized into a single
2613 # line under the Calls Summary section
2614 foreach my $newsection ( @newsections ) {
2615 if($newsection->{'post_total'}) { # this means Calls Summary
2616 foreach my $section ( @sections ) {
2617 next unless ($section->{'phonenum'} eq $newsection->{'phonenum'}
2618 && !$section->{'post_total'});
2619 my $newdesc = $section->{'description'};
2620 my $tn = $section->{'phonenum'};
2621 $newdesc =~ s/$tn//g;
2622 my $line = { ext_description => [],
2626 calls => $section->{'calls'},
2627 section => $newsection,
2628 duration => $section->{'duration'},
2629 description => $newdesc,
2630 amount => sprintf("%.2f",$section->{'amount'}),
2631 product_code => 'N/A',
2633 push @newlines, $line;
2638 # after this, Calls Details is populated with all CDRs
2639 foreach my $newsection ( @newsections ) {
2640 if(!$newsection->{'post_total'}) { # this means Calls Details
2641 foreach my $line ( @lines ) {
2642 next unless (scalar(@{$line->{'ext_description'}}) &&
2643 $line->{'section'}->{'phonenum'} eq $newsection->{'phonenum'}
2645 my @extdesc = @{$line->{'ext_description'}};
2647 foreach my $extdesc ( @extdesc ) {
2648 $extdesc =~ s/scriptsize/normalsize/g if $format eq 'latex';
2649 push @newextdesc, $extdesc;
2651 $line->{'ext_description'} = \@newextdesc;
2652 $line->{'section'} = $newsection;
2653 push @newlines, $line;
2658 return(\@newsections, \@newlines);
2661 return(\@sections, \@lines);
2665 =sub _items_usage_class_summary OPTIONS
2667 Returns a list of detail items summarizing the usage charges on this
2668 invoice. Each one will have 'amount', 'description' (the usage charge name),
2669 and 'usage_classnum'.
2671 OPTIONS can include 'escape' (a function to escape the descriptions).
2675 sub _items_usage_class_summary {
2679 my $escape = $opt{escape} || sub { $_[0] };
2680 my $money_char = $opt{money_char};
2681 my $invnum = $self->invnum;
2682 my @classes = qsearch({
2683 'table' => 'usage_class',
2684 'select' => 'classnum, classname, SUM(amount) AS amount,'.
2685 ' COUNT(*) AS calls, SUM(duration) AS duration',
2686 'addl_from' => ' LEFT JOIN cust_bill_pkg_detail USING (classnum)' .
2687 ' LEFT JOIN cust_bill_pkg USING (billpkgnum)',
2688 'extra_sql' => " WHERE cust_bill_pkg.invnum = $invnum".
2689 ' GROUP BY classnum, classname, weight'.
2690 ' HAVING (usage_class.disabled IS NULL OR SUM(amount) > 0)'.
2691 ' ORDER BY weight ASC',
2695 description => &{$escape}($self->mt('Usage Summary')),
2699 foreach my $class (@classes) {
2700 $section->{subtotal} += $class->get('amount');
2702 'description' => &{$escape}($class->classname),
2703 'amount' => $money_char.sprintf('%.2f', $class->get('amount')),
2704 'quantity' => $class->get('calls'),
2705 'duration' => $class->get('duration'),
2706 'usage_classnum' => $class->classnum,
2707 'section' => $section,
2710 $section->{subtotal} = $money_char.sprintf('%.2f', $section->{subtotal});
2714 sub _items_previous {
2716 my $conf = $self->conf;
2717 my $cust_main = $self->cust_main;
2718 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2720 foreach ( @pr_cust_bill ) {
2721 my $date = $conf->exists('invoice_show_prior_due_date')
2722 ? 'due '. $_->due_date2str('short')
2723 : $self->time2str_local('short', $_->_date);
2725 'description' => $self->mt('Previous Balance, Invoice #'). $_->invnum. " ($date)",
2726 #'pkgpart' => 'N/A',
2728 'amount' => sprintf("%.2f", $_->owed),
2734 # 'description' => 'Previous Balance',
2735 # #'pkgpart' => 'N/A',
2736 # 'pkgnum' => 'N/A',
2737 # 'amount' => sprintf("%10.2f", $pr_total ),
2738 # 'ext_description' => [ map {
2739 # "Invoice ". $_->invnum.
2740 # " (". time2str("%x",$_->_date). ") ".
2741 # sprintf("%10.2f", $_->owed)
2742 # } @pr_cust_bill ],
2747 sub _items_credits {
2748 my( $self, %opt ) = @_;
2749 my $trim_len = $opt{'trim_len'} || 40;
2754 if ( $self->conf->exists('previous_balance-payments_since') ) {
2755 if ( $opt{'template'} eq 'statement' ) {
2756 # then the current bill is a "statement" (i.e. an invoice sent as
2757 # a payment receipt)
2758 # and in that case we want to see payments on or after THIS invoice
2759 @objects = qsearch('cust_credit', {
2760 'custnum' => $self->custnum,
2761 '_date' => {op => '>=', value => $self->_date},
2765 $date = $self->previous_bill->_date if $self->previous_bill;
2766 @objects = qsearch('cust_credit', {
2767 'custnum' => $self->custnum,
2768 '_date' => {op => '>=', value => $date},
2772 @objects = $self->cust_credited;
2775 foreach my $obj ( @objects ) {
2776 my $cust_credit = $obj->isa('FS::cust_credit') ? $obj : $obj->cust_credit;
2778 my $reason = substr($cust_credit->reason, 0, $trim_len);
2779 $reason .= '...' if length($reason) < length($cust_credit->reason);
2780 $reason = " ($reason) " if $reason;
2783 #'description' => 'Credit ref\#'. $_->crednum.
2784 # " (". time2str("%x",$_->cust_credit->_date) .")".
2786 'description' => $self->mt('Credit applied').' '.
2787 $self->time2str_local('short', $obj->_date). $reason,
2788 'amount' => sprintf("%.2f",$obj->amount),
2796 sub _items_payments {
2801 my $detailed = $self->conf->exists('invoice_payment_details');
2803 if ( $self->conf->exists('previous_balance-payments_since') ) {
2804 # then show payments dated on/after the previous bill...
2805 if ( $opt{'template'} eq 'statement' ) {
2806 # then the current bill is a "statement" (i.e. an invoice sent as
2807 # a payment receipt)
2808 # and in that case we want to see payments on or after THIS invoice
2809 @objects = qsearch('cust_pay', {
2810 'custnum' => $self->custnum,
2811 '_date' => {op => '>=', value => $self->_date},
2814 # the normal case: payments on or after the previous invoice
2816 $date = $self->previous_bill->_date if $self->previous_bill;
2817 @objects = qsearch('cust_pay', {
2818 'custnum' => $self->custnum,
2819 '_date' => {op => '>=', value => $date},
2821 # and before the current bill...
2822 @objects = grep { $_->_date < $self->_date } @objects;
2825 @objects = $self->cust_bill_pay;
2828 foreach my $obj (@objects) {
2829 my $cust_pay = $obj->isa('FS::cust_pay') ? $obj : $obj->cust_pay;
2830 my $desc = $self->mt('Payment received').' '.
2831 $self->time2str_local('short', $cust_pay->_date );
2832 $desc .= $self->mt(' via ') .
2833 $cust_pay->payby_payinfo_pretty( $self->cust_main->locale )
2837 'description' => $desc,
2838 'amount' => sprintf("%.2f", $obj->amount )
2848 my $conf = $self->conf;
2851 my ($pr_total) = $self->previous;
2852 my ($previous_charges_desc, $new_charges_desc, $new_charges_amount);
2854 if ( $conf->exists('previous_balance-exclude_from_total') ) {
2855 # if enabled, specifically add a line for the previous balance total
2856 $previous_charges_desc = $self->mt(
2857 $conf->config('previous_balance-text') || 'Previous Balance'
2860 # then return separate lines for previous balance and total new charges
2863 { total_item => $previous_charges_desc,
2864 total_amount => sprintf('%.2f',$pr_total)
2869 if ( $conf->exists('previous_balance-exclude_from_total')
2870 or !$self->enable_previous ) {
2871 # show new charges only
2873 $new_charges_desc = $self->mt(
2874 $conf->config('previous_balance-text-total_new_charges')
2875 || 'Total New Charges'
2878 $new_charges_amount = $self->charged;
2881 # show new charges + previous invoice total
2883 $new_charges_desc = $self->mt('Total Charges');
2884 if ( $self->enable_previous ) {
2885 $new_charges_amount = sprintf('%.2f', $self->charged + $pr_total);
2887 $new_charges_amount = sprintf('%.2f', $self->charged);
2892 if ( $conf->exists('invoice_show_prior_due_date') ) {
2893 # then the due date should be shown with Total New Charges,
2894 # and should NOT be shown with the Balance Due message.
2895 if ( $self->due_date ) {
2896 # localize the "Please pay by" message and the date itself
2897 # (grammar issues with this, yeah)
2898 $new_charges_desc .= ' - ' . $self->mt('Please pay by') . ' ' .
2899 $self->due_date2str('short');
2900 } elsif ( $self->terms ) {
2901 # phrases like "due on receipt" should be localized
2902 $new_charges_desc .= ' - ' . $self->mt($self->terms);
2907 { total_item => $new_charges_desc,
2908 total_amount => $new_charges_amount,
2916 =item has_call_details
2918 Returns true if this invoice has call details.
2922 sub has_call_details {
2925 SELECT 1 FROM cust_bill_pkg_detail
2926 LEFT JOIN cust_bill_pkg USING (billpkgnum)
2927 WHERE cust_bill_pkg_detail.format = 'C'
2928 AND cust_bill_pkg.invnum = ?
2933 =item call_details [ OPTION => VALUE ... ]
2935 Returns an array of CSV strings representing the call details for this invoice
2936 The only option available is the boolean prepend_billed_number
2941 my ($self, %opt) = @_;
2943 my $format_function = sub { shift };
2945 if ($opt{prepend_billed_number}) {
2946 $format_function = sub {
2950 $row->amount ? $row->phonenum. ",". $detail : '"Billed number",'. $detail;
2955 my @details = map { $_->details( 'format_function' => $format_function,
2956 'escape_function' => sub{ return() },
2960 $self->cust_bill_pkg;
2961 my $header = $details[0];
2962 ( $header, grep { $_ ne $header } @details );
2965 =item cust_pay_batch
2967 Returns all L<FS::cust_pay_batch> records linked to this invoice. Deprecated,
2972 sub cust_pay_batch {
2973 carp "FS::cust_bill->cust_pay_batch is deprecated";
2975 qsearch('cust_pay_batch', { 'invnum' => $self->invnum });
2984 =item process_reprint
2988 sub process_reprint {
2989 process_re_X('print', @_);
2992 =item process_reemail
2996 sub process_reemail {
2997 process_re_X('email', @_);
3005 process_re_X('fax', @_);
3013 process_re_X('ftp', @_);
3020 sub process_respool {
3021 process_re_X('spool', @_);
3026 my( $method, $job ) = ( shift, shift );
3027 warn "$me process_re_X $method for job $job\n" if $DEBUG;
3030 warn Dumper($param) if $DEBUG;
3040 # this is called from search/cust_bill.html and given all its search
3041 # parameters, so it needs to perform the same search.
3044 # spool_invoice ftp_invoice fax_invoice print_invoice
3045 my($method, $job, %param ) = @_;
3047 warn "re_X $method for job $job with param:\n".
3048 join( '', map { " $_ => ". $param{$_}. "\n" } keys %param );
3051 #some false laziness w/search/cust_bill.html
3052 $param{'order_by'} = 'cust_bill._date';
3054 my $query = FS::cust_bill->search(\%param);
3055 delete $query->{'count_query'};
3056 delete $query->{'count_addl'};
3058 $query->{debug} = 1; # was in here before, is obviously useful
3060 my @cust_bill = qsearch( $query );
3062 $method .= '_invoice' unless $method eq 'email' || $method eq 'print';
3064 warn " $me re_X $method: ". scalar(@cust_bill). " invoices found\n"
3067 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
3068 foreach my $cust_bill ( @cust_bill ) {
3069 $cust_bill->$method();
3071 if ( $job ) { #progressbar foo
3073 if ( time - $min_sec > $last ) {
3074 my $error = $job->update_statustext(
3075 int( 100 * $num / scalar(@cust_bill) )
3077 die $error if $error;
3088 +{ ( map { $_=>$self->$_ } $self->fields ),
3089 'owed' => $self->owed,
3090 #XXX last payment applied date
3096 =head1 CLASS METHODS
3102 Returns an SQL fragment to retreive the amount owed (charged minus credited and paid).
3107 my ($class, $start, $end) = @_;
3109 $class->paid_sql($start, $end). ' - '.
3110 $class->credited_sql($start, $end);
3115 Returns an SQL fragment to retreive the net amount (charged minus credited).
3120 my ($class, $start, $end) = @_;
3121 'charged - '. $class->credited_sql($start, $end);
3126 Returns an SQL fragment to retreive the amount paid against this invoice.
3131 my ($class, $start, $end) = @_;
3132 $start &&= "AND cust_bill_pay._date <= $start";
3133 $end &&= "AND cust_bill_pay._date > $end";
3134 $start = '' unless defined($start);
3135 $end = '' unless defined($end);
3136 "( SELECT COALESCE(SUM(amount),0) FROM cust_bill_pay
3137 WHERE cust_bill.invnum = cust_bill_pay.invnum $start $end )";
3142 Returns an SQL fragment to retreive the amount credited against this invoice.
3147 my ($class, $start, $end) = @_;
3148 $start &&= "AND cust_credit_bill._date <= $start";
3149 $end &&= "AND cust_credit_bill._date > $end";
3150 $start = '' unless defined($start);
3151 $end = '' unless defined($end);
3152 "( SELECT COALESCE(SUM(amount),0) FROM cust_credit_bill
3153 WHERE cust_bill.invnum = cust_credit_bill.invnum $start $end )";
3158 Returns an SQL fragment to retrieve the due date of an invoice.
3159 Currently only supported on PostgreSQL.
3164 die "don't use: doesn't account for agent-specific invoice_default_terms";
3166 #we're passed a $conf but not a specific customer (that's in the query), so
3167 # to make this work we'd need an agentnum-aware "condition_sql_conf" like
3168 # "condition_sql_option" that retreives a conf value with SQL in an agent-
3171 my $conf = new FS::Conf;
3175 cust_bill.invoice_terms,
3176 cust_main.invoice_terms,
3177 \''.($conf->config('invoice_default_terms') || '').'\'
3178 ), E\'Net (\\\\d+)\'
3180 ) * 86400 + cust_bill._date'
3191 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
3192 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base