2 use base qw( FS::cust_bill::Search FS::Template_Mixin
3 FS::cust_main_Mixin FS::Record
7 use vars qw( $DEBUG $me );
9 use Fcntl qw(:flock); #for spool_csv
11 use List::Util qw(min max sum);
15 use Storable qw( freeze thaw );
17 use FS::UID qw( datasrc );
18 use FS::Misc qw( send_fax do_print );
19 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;
30 use FS::cust_pay_batch;
31 use FS::cust_bill_event;
34 use FS::cust_bill_pay;
35 use FS::cust_bill_pay_batch;
36 use FS::part_bill_event;
39 use FS::cust_bill_batch;
40 use FS::cust_bill_pay_pkg;
41 use FS::cust_credit_bill_pkg;
42 use FS::discount_plan;
43 use FS::cust_bill_void;
47 $me = '[FS::cust_bill]';
51 FS::cust_bill - Object methods for cust_bill records
57 $record = new FS::cust_bill \%hash;
58 $record = new FS::cust_bill { 'column' => 'value' };
60 $error = $record->insert;
62 $error = $new_record->replace($old_record);
64 $error = $record->delete;
66 $error = $record->check;
68 ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
70 @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
72 ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
74 @cust_pay_objects = $cust_bill->cust_pay;
76 $tax_amount = $record->tax;
78 @lines = $cust_bill->print_text;
79 @lines = $cust_bill->print_text('time' => $time);
83 An FS::cust_bill object represents an invoice; a declaration that a customer
84 owes you money. The specific charges are itemized as B<cust_bill_pkg> records
85 (see L<FS::cust_bill_pkg>). FS::cust_bill inherits from FS::Record. The
86 following fields are currently supported:
92 =item invnum - primary key (assigned automatically for new invoices)
94 =item custnum - customer (see L<FS::cust_main>)
96 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
97 L<Time::Local> and L<Date::Parse> for conversion functions.
99 =item charged - amount of this invoice
101 =item invoice_terms - optional terms override for this specific invoice
109 =item billing_balance - the customer's balance immediately before generating
110 this invoice. DEPRECATED. Use the L<FS::cust_main/balance_date> method
111 to determine the customer's balance at a specific time.
113 =item previous_balance - the customer's balance immediately after generating
114 the invoice before this one. DEPRECATED.
116 =item printed - formerly used to track the number of times an invoice had
117 been printed; no longer used.
125 =item closed - books closed flag, empty or `Y'
127 =item statementnum - invoice aggregation (see L<FS::cust_statement>)
129 =item agent_invid - legacy invoice number
131 =item promised_date - customer promised payment date, for collection
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'; }
149 # should be the ONLY occurrence of "Invoice" in invoice rendering code.
150 # (except email_subject and invnum_date_pretty)
153 $self->conf->config('notice_name') || 'Invoice'
156 sub cust_linked { $_[0]->cust_main_custnum; }
157 sub cust_unlinked_msg {
159 "WARNING: can't find cust_main.custnum ". $self->custnum.
160 ' (cust_bill.invnum '. $self->invnum. ')';
165 Adds this invoice to the database ("Posts" the invoice). If there is an error,
166 returns the error, otherwise returns false.
172 warn "$me insert called\n" if $DEBUG;
174 local $SIG{HUP} = 'IGNORE';
175 local $SIG{INT} = 'IGNORE';
176 local $SIG{QUIT} = 'IGNORE';
177 local $SIG{TERM} = 'IGNORE';
178 local $SIG{TSTP} = 'IGNORE';
179 local $SIG{PIPE} = 'IGNORE';
181 my $oldAutoCommit = $FS::UID::AutoCommit;
182 local $FS::UID::AutoCommit = 0;
185 my $error = $self->SUPER::insert;
187 $dbh->rollback if $oldAutoCommit;
191 if ( $self->get('cust_bill_pkg') ) {
192 foreach my $cust_bill_pkg ( @{$self->get('cust_bill_pkg')} ) {
193 $cust_bill_pkg->invnum($self->invnum);
194 my $error = $cust_bill_pkg->insert;
196 $dbh->rollback if $oldAutoCommit;
197 return "can't create invoice line item: $error";
202 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
209 Voids this invoice: deletes the invoice and adds a record of the voided invoice
210 to the FS::cust_bill_void table (and related tables starting from
211 FS::cust_bill_pkg_void).
217 my $reason = scalar(@_) ? shift : '';
219 local $SIG{HUP} = 'IGNORE';
220 local $SIG{INT} = 'IGNORE';
221 local $SIG{QUIT} = 'IGNORE';
222 local $SIG{TERM} = 'IGNORE';
223 local $SIG{TSTP} = 'IGNORE';
224 local $SIG{PIPE} = 'IGNORE';
226 my $oldAutoCommit = $FS::UID::AutoCommit;
227 local $FS::UID::AutoCommit = 0;
230 my $cust_bill_void = new FS::cust_bill_void ( {
231 map { $_ => $self->get($_) } $self->fields
233 $cust_bill_void->reason($reason);
234 my $error = $cust_bill_void->insert;
236 $dbh->rollback if $oldAutoCommit;
240 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
241 my $error = $cust_bill_pkg->void($reason);
243 $dbh->rollback if $oldAutoCommit;
248 $error = $self->delete;
250 $dbh->rollback if $oldAutoCommit;
254 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
262 This method now works but you probably shouldn't use it. Instead, apply a
263 credit against the invoice, or use the new void method.
265 Using this method to delete invoices outright is really, really bad. There
266 would be no record you ever posted this invoice, and there are no check to
267 make sure charged = 0 or that there are no associated cust_bill_pkg records.
269 Really, don't use it.
275 return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
277 local $SIG{HUP} = 'IGNORE';
278 local $SIG{INT} = 'IGNORE';
279 local $SIG{QUIT} = 'IGNORE';
280 local $SIG{TERM} = 'IGNORE';
281 local $SIG{TSTP} = 'IGNORE';
282 local $SIG{PIPE} = 'IGNORE';
284 my $oldAutoCommit = $FS::UID::AutoCommit;
285 local $FS::UID::AutoCommit = 0;
288 foreach my $table (qw(
299 foreach my $linked ( $self->$table() ) {
300 my $error = $linked->delete;
302 $dbh->rollback if $oldAutoCommit;
309 my $error = $self->SUPER::delete(@_);
311 $dbh->rollback if $oldAutoCommit;
315 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
321 =item replace [ OLD_RECORD ]
323 You can, but probably shouldn't modify invoices...
325 Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
326 supplied, replaces this record. If there is an error, returns the error,
327 otherwise returns false.
331 #replace can be inherited from Record.pm
333 # replace_check is now the preferred way to #implement replace data checks
334 # (so $object->replace() works without an argument)
337 my( $new, $old ) = ( shift, shift );
338 return "Can't modify closed invoice" if $old->closed =~ /^Y/i;
339 #return "Can't change _date!" unless $old->_date eq $new->_date;
340 return "Can't change _date" unless $old->_date == $new->_date;
341 return "Can't change charged" unless $old->charged == $new->charged
342 || $old->charged == 0
343 || $new->{'Hash'}{'cc_surcharge_replace_hack'};
349 =item add_cc_surcharge
355 sub add_cc_surcharge {
356 my ($self, $pkgnum, $amount) = (shift, shift, shift);
359 my $cust_bill_pkg = new FS::cust_bill_pkg({
360 'invnum' => $self->invnum,
364 $error = $cust_bill_pkg->insert;
365 return $error if $error;
367 $self->{'Hash'}{'cc_surcharge_replace_hack'} = 1;
368 $self->charged($self->charged+$amount);
369 $error = $self->replace;
370 return $error if $error;
372 $self->apply_payments_and_credits;
378 Checks all fields to make sure this is a valid invoice. If there is an error,
379 returns the error, otherwise returns false. Called by the insert and replace
388 $self->ut_numbern('invnum')
389 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum' )
390 || $self->ut_numbern('_date')
391 || $self->ut_money('charged')
392 || $self->ut_numbern('printed')
393 || $self->ut_enum('closed', [ '', 'Y' ])
394 || $self->ut_foreign_keyn('statementnum', 'cust_statement', 'statementnum' )
395 || $self->ut_numbern('agent_invid') #varchar?
397 return $error if $error;
399 $self->_date(time) unless $self->_date;
401 $self->printed(0) if $self->printed eq '';
408 Returns the displayed invoice number for this invoice: agent_invid if
409 cust_bill-default_agent_invid is set and it has a value, invnum otherwise.
415 if ( $self->agent_invid
416 && FS::Conf->new->exists('cust_bill-default_agent_invid') ) {
417 return $self->agent_invid;
419 return $self->invnum;
425 Returns the customer's last invoice before this one.
431 if ( !$self->get('previous_bill') ) {
432 $self->set('previous_bill', qsearchs({
433 'table' => 'cust_bill',
434 'hashref' => { 'custnum' => $self->custnum,
435 '_date' => { op=>'<', value=>$self->_date } },
436 'order_by' => 'ORDER BY _date DESC LIMIT 1',
439 $self->get('previous_bill');
444 Returns a list consisting of the total previous balance for this customer,
445 followed by the previous outstanding invoices (as FS::cust_bill objects also).
452 my @cust_bill = sort { $a->_date <=> $b->_date }
453 grep { $_->owed != 0 }
454 qsearch( 'cust_bill', { 'custnum' => $self->custnum,
455 #'_date' => { op=>'<', value=>$self->_date },
456 'invnum' => { op=>'<', value=>$self->invnum },
459 foreach ( @cust_bill ) { $total += $_->owed; }
463 =item enable_previous
465 Whether to show the 'Previous Charges' section when printing this invoice.
466 The negation of the 'disable_previous_balance' config setting.
470 sub enable_previous {
472 my $agentnum = $self->cust_main->agentnum;
473 !$self->conf->exists('disable_previous_balance', $agentnum);
478 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
485 { 'table' => 'cust_bill_pkg',
486 'hashref' => { 'invnum' => $self->invnum },
487 'order_by' => 'ORDER BY billpkgnum',
492 =item cust_bill_pkg_pkgnum PKGNUM
494 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice and
499 sub cust_bill_pkg_pkgnum {
500 my( $self, $pkgnum ) = @_;
502 { 'table' => 'cust_bill_pkg',
503 'hashref' => { 'invnum' => $self->invnum,
506 'order_by' => 'ORDER BY billpkgnum',
513 Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
520 my @cust_pkg = map { $_->pkgnum > 0 ? $_->cust_pkg : () }
521 $self->cust_bill_pkg;
523 grep { ! $saw{$_->pkgnum}++ } @cust_pkg;
528 Returns true if any of the packages (or their definitions) corresponding to the
529 line items for this invoice have the no_auto flag set.
535 grep { $_->no_auto || $_->part_pkg->no_auto } $self->cust_pkg;
538 =item open_cust_bill_pkg
540 Returns the open line items for this invoice.
542 Note that cust_bill_pkg with both setup and recur fees are returned as two
543 separate line items, each with only one fee.
547 # modeled after cust_main::open_cust_bill
548 sub open_cust_bill_pkg {
551 # grep { $_->owed > 0 } $self->cust_bill_pkg
553 my %other = ( 'recur' => 'setup',
554 'setup' => 'recur', );
556 foreach my $field ( qw( recur setup )) {
557 push @open, map { $_->set( $other{$field}, 0 ); $_; }
558 grep { $_->owed($field) > 0 }
559 $self->cust_bill_pkg;
565 =item cust_bill_event
567 Returns the completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
571 sub cust_bill_event {
573 qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
576 =item num_cust_bill_event
578 Returns the number of completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
582 sub num_cust_bill_event {
585 "SELECT COUNT(*) FROM cust_bill_event WHERE invnum = ?";
586 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
587 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
588 $sth->fetchrow_arrayref->[0];
593 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
597 #false laziness w/cust_pkg.pm
601 'table' => 'cust_event',
602 'addl_from' => 'JOIN part_event USING ( eventpart )',
603 'hashref' => { 'tablenum' => $self->invnum },
604 'extra_sql' => " AND eventtable = 'cust_bill' ",
610 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
614 #false laziness w/cust_pkg.pm
618 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
619 " WHERE tablenum = ? AND eventtable = 'cust_bill'";
620 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
621 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
622 $sth->fetchrow_arrayref->[0];
627 Returns the customer (see L<FS::cust_main>) for this invoice.
633 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
636 =item cust_suspend_if_balance_over AMOUNT
638 Suspends the customer associated with this invoice if the total amount owed on
639 this invoice and all older invoices is greater than the specified amount.
641 Returns a list: an empty list on success or a list of errors.
645 sub cust_suspend_if_balance_over {
646 my( $self, $amount ) = ( shift, shift );
647 my $cust_main = $self->cust_main;
648 if ( $cust_main->total_owed_date($self->_date) < $amount ) {
651 $cust_main->suspend(@_);
657 Depreciated. See the cust_credited method.
659 #Returns a list consisting of the total previous credited (see
660 #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
661 #outstanding credits (FS::cust_credit objects).
667 croak "FS::cust_bill->cust_credit depreciated; see ".
668 "FS::cust_bill->cust_credit_bill";
671 #my @cust_credit = sort { $a->_date <=> $b->_date }
672 # grep { $_->credited != 0 && $_->_date < $self->_date }
673 # qsearch('cust_credit', { 'custnum' => $self->custnum } )
675 #foreach (@cust_credit) { $total += $_->credited; }
676 #$total, @cust_credit;
681 Depreciated. See the cust_bill_pay method.
683 #Returns all payments (see L<FS::cust_pay>) for this invoice.
689 croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
691 #sort { $a->_date <=> $b->_date }
692 # qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
698 qsearch('cust_pay_batch', { 'invnum' => $self->invnum } );
701 sub cust_bill_pay_batch {
703 qsearch('cust_bill_pay_batch', { 'invnum' => $self->invnum } );
708 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
714 map { $_ } #return $self->num_cust_bill_pay unless wantarray;
715 sort { $a->_date <=> $b->_date }
716 qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
721 =item cust_credit_bill
723 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
729 map { $_ } #return $self->num_cust_credit_bill unless wantarray;
730 sort { $a->_date <=> $b->_date }
731 qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
735 sub cust_credit_bill {
736 shift->cust_credited(@_);
739 #=item cust_bill_pay_pkgnum PKGNUM
741 #Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
742 #with matching pkgnum.
746 #sub cust_bill_pay_pkgnum {
747 # my( $self, $pkgnum ) = @_;
748 # map { $_ } #return $self->num_cust_bill_pay_pkgnum($pkgnum) unless wantarray;
749 # sort { $a->_date <=> $b->_date }
750 # qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum,
751 # 'pkgnum' => $pkgnum,
756 =item cust_bill_pay_pkg PKGNUM
758 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
759 applied against the matching pkgnum.
763 sub cust_bill_pay_pkg {
764 my( $self, $pkgnum ) = @_;
767 'select' => 'cust_bill_pay_pkg.*',
768 'table' => 'cust_bill_pay_pkg',
769 'addl_from' => ' LEFT JOIN cust_bill_pay USING ( billpaynum ) '.
770 ' LEFT JOIN cust_bill_pkg USING ( billpkgnum ) ',
771 'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
772 " AND cust_bill_pkg.pkgnum = $pkgnum",
777 #=item cust_credited_pkgnum PKGNUM
779 #=item cust_credit_bill_pkgnum PKGNUM
781 #Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice
782 #with matching pkgnum.
786 #sub cust_credited_pkgnum {
787 # my( $self, $pkgnum ) = @_;
788 # map { $_ } #return $self->num_cust_credit_bill_pkgnum($pkgnum) unless wantarray;
789 # sort { $a->_date <=> $b->_date }
790 # qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum,
791 # 'pkgnum' => $pkgnum,
796 #sub cust_credit_bill_pkgnum {
797 # shift->cust_credited_pkgnum(@_);
800 =item cust_credit_bill_pkg PKGNUM
802 Returns all credit applications (see L<FS::cust_credit_bill>) for this invoice
803 applied against the matching pkgnum.
807 sub cust_credit_bill_pkg {
808 my( $self, $pkgnum ) = @_;
811 'select' => 'cust_credit_bill_pkg.*',
812 'table' => 'cust_credit_bill_pkg',
813 'addl_from' => ' LEFT JOIN cust_credit_bill USING ( creditbillnum ) '.
814 ' LEFT JOIN cust_bill_pkg USING ( billpkgnum ) ',
815 'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
816 " AND cust_bill_pkg.pkgnum = $pkgnum",
821 =item cust_bill_batch
823 Returns all invoice batch records (L<FS::cust_bill_batch>) for this invoice.
827 sub cust_bill_batch {
829 qsearch('cust_bill_batch', { 'invnum' => $self->invnum });
834 Returns all discount plans (L<FS::discount_plan>) for this invoice, as a
835 hash keyed by term length.
841 FS::discount_plan->all($self);
846 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
853 my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
855 foreach (@taxlines) { $total += $_->setup; }
861 Returns the amount owed (still outstanding) on this invoice, which is charged
862 minus all payment applications (see L<FS::cust_bill_pay>) and credit
863 applications (see L<FS::cust_credit_bill>).
869 my $balance = $self->charged;
870 $balance -= $_->amount foreach ( $self->cust_bill_pay );
871 $balance -= $_->amount foreach ( $self->cust_credited );
872 $balance = sprintf( "%.2f", $balance);
873 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
878 my( $self, $pkgnum ) = @_;
880 #my $balance = $self->charged;
882 $balance += $_->setup + $_->recur for $self->cust_bill_pkg_pkgnum($pkgnum);
884 $balance -= $_->amount for $self->cust_bill_pay_pkg($pkgnum);
885 $balance -= $_->amount for $self->cust_credit_bill_pkg($pkgnum);
887 $balance = sprintf( "%.2f", $balance);
888 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
894 Returns true if this invoice should be hidden. See the
895 selfservice-hide_invoices-taxclass configuraiton setting.
901 my $conf = $self->conf;
902 my $hide_taxclass = $conf->config('selfservice-hide_invoices-taxclass')
904 my @cust_bill_pkg = $self->cust_bill_pkg;
905 my @part_pkg = grep $_, map $_->part_pkg, @cust_bill_pkg;
906 ! grep { $_->taxclass ne $hide_taxclass } @part_pkg;
909 =item apply_payments_and_credits [ OPTION => VALUE ... ]
911 Applies unapplied payments and credits to this invoice.
913 A hash of optional arguments may be passed. Currently "manual" is supported.
914 If true, a payment receipt is sent instead of a statement when
915 'payment_receipt_email' configuration option is set.
917 If there is an error, returns the error, otherwise returns false.
921 sub apply_payments_and_credits {
922 my( $self, %options ) = @_;
923 my $conf = $self->conf;
925 local $SIG{HUP} = 'IGNORE';
926 local $SIG{INT} = 'IGNORE';
927 local $SIG{QUIT} = 'IGNORE';
928 local $SIG{TERM} = 'IGNORE';
929 local $SIG{TSTP} = 'IGNORE';
930 local $SIG{PIPE} = 'IGNORE';
932 my $oldAutoCommit = $FS::UID::AutoCommit;
933 local $FS::UID::AutoCommit = 0;
936 $self->select_for_update; #mutex
938 my @payments = grep { $_->unapplied > 0 } $self->cust_main->cust_pay;
939 my @credits = grep { $_->credited > 0 } $self->cust_main->cust_credit;
941 if ( $conf->exists('pkg-balances') ) {
942 # limit @payments & @credits to those w/ a pkgnum grepped from $self
943 my %pkgnums = map { $_ => 1 } map $_->pkgnum, $self->cust_bill_pkg;
944 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
945 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
948 while ( $self->owed > 0 and ( @payments || @credits ) ) {
951 if ( @payments && @credits ) {
953 #decide which goes first by weight of top (unapplied) line item
955 my @open_lineitems = $self->open_cust_bill_pkg;
958 max( map { $_->part_pkg->pay_weight || 0 }
963 my $max_credit_weight =
964 max( map { $_->part_pkg->credit_weight || 0 }
970 #if both are the same... payments first? it has to be something
971 if ( $max_pay_weight >= $max_credit_weight ) {
977 } elsif ( @payments ) {
979 } elsif ( @credits ) {
982 die "guru meditation #12 and 35";
986 if ( $app eq 'pay' ) {
988 my $payment = shift @payments;
989 $unapp_amount = $payment->unapplied;
990 $app = new FS::cust_bill_pay { 'paynum' => $payment->paynum };
991 $app->pkgnum( $payment->pkgnum )
992 if $conf->exists('pkg-balances') && $payment->pkgnum;
994 } elsif ( $app eq 'credit' ) {
996 my $credit = shift @credits;
997 $unapp_amount = $credit->credited;
998 $app = new FS::cust_credit_bill { 'crednum' => $credit->crednum };
999 $app->pkgnum( $credit->pkgnum )
1000 if $conf->exists('pkg-balances') && $credit->pkgnum;
1003 die "guru meditation #12 and 35";
1007 if ( $conf->exists('pkg-balances') && $app->pkgnum ) {
1008 warn "owed_pkgnum ". $app->pkgnum;
1009 $owed = $self->owed_pkgnum($app->pkgnum);
1011 $owed = $self->owed;
1013 next unless $owed > 0;
1015 warn "min ( $unapp_amount, $owed )\n" if $DEBUG;
1016 $app->amount( sprintf('%.2f', min( $unapp_amount, $owed ) ) );
1018 $app->invnum( $self->invnum );
1020 my $error = $app->insert(%options);
1022 $dbh->rollback if $oldAutoCommit;
1023 return "Error inserting ". $app->table. " record: $error";
1025 die $error if $error;
1029 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1036 Sends this invoice to the destinations configured for this customer: sends
1037 email, prints and/or faxes. See L<FS::cust_main_invoice>.
1039 Options can be passed as a hashref. Positional parameters are no longer
1042 I<template>: a suffix for alternate invoices
1044 I<agentnum>: obsolete, now does nothing.
1046 I<from> overrides the default email invoice From: address.
1048 I<amount>: obsolete, does nothing
1050 I<notice_name> overrides "Invoice" as the name of the sent document
1051 (templates from 10/2009 or newer required).
1053 I<lpr> overrides the system 'lpr' option as the command to print a document
1054 from standard input.
1060 my $opt = ref($_[0]) ? $_[0] : +{ @_ };
1061 my $conf = $self->conf;
1063 my $cust_main = $self->cust_main;
1065 my @invoicing_list = $cust_main->invoicing_list;
1068 if ( grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list )
1069 && ! $cust_main->invoice_noemail;
1072 if grep { $_ eq 'POST' } @invoicing_list; #postal
1074 #this has never been used post-$ORIGINAL_ISP afaik
1075 $self->fax_invoice($opt)
1076 if grep { $_ eq 'FAX' } @invoicing_list; #fax
1084 my $opt = shift || {};
1085 if ($opt and !ref($opt)) {
1086 die ref($self). '->email called with positional parameters';
1089 my $conf = $self->conf;
1091 my $from = delete $opt->{from};
1093 # this is where we set the From: address
1094 $from ||= $self->_agent_invoice_from || #XXX should go away
1095 $conf->invoice_from_full( $self->cust_main->agentnum );
1097 my @invoicing_list = $self->cust_main->invoicing_list_emailonly;
1099 if ( ! @invoicing_list ) { #no recipients
1100 if ( $conf->exists('cust_bill-no_recipients-error') ) {
1101 die 'No recipients for customer #'. $self->custnum;
1103 #default: better to notify this person than silence
1104 @invoicing_list = ($from);
1108 $self->SUPER::email( {
1110 'to' => \@invoicing_list,
1116 #this stays here for now because its explicitly used as
1117 # FS::cust_bill::queueable_email
1118 sub queueable_email {
1121 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1122 or die "invalid invoice number: " . $opt{invnum};
1125 $self->set('mode', $opt{mode});
1128 my %args = map {$_ => $opt{$_}}
1130 qw( from notice_name no_coupon template );
1132 my $error = $self->email( \%args );
1133 die $error if $error;
1139 my $conf = $self->conf;
1141 #my $template = scalar(@_) ? shift : '';
1144 my $subject = $conf->config('invoice_subject', $self->cust_main->agentnum)
1147 my $cust_main = $self->cust_main;
1148 my $name = $cust_main->name;
1149 my $name_short = $cust_main->name_short;
1150 my $invoice_number = $self->invnum;
1151 my $invoice_date = $self->_date_pretty;
1153 eval qq("$subject");
1156 =item lpr_data HASHREF
1158 Returns the postscript or plaintext for this invoice as an arrayref.
1160 Options must be passed as a hashref. Positional parameters are no longer
1163 I<template>, if specified, is the name of a suffix for alternate invoices.
1165 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1171 my $conf = $self->conf;
1172 my $opt = shift || {};
1173 if ($opt and !ref($opt)) {
1174 # nobody does this anyway
1175 die "FS::cust_bill::lpr_data called with positional parameters";
1178 my $method = $conf->exists('invoice_latex') ? 'print_ps' : 'print_text';
1179 [ $self->$method( $opt ) ];
1184 Prints this invoice.
1186 Options must be passed as a hashref.
1188 I<template>, if specified, is the name of a suffix for alternate invoices.
1190 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1196 return if $self->hide;
1197 my $conf = $self->conf;
1198 my $opt = shift || {};
1199 if ($opt and !ref($opt)) {
1200 die "FS::cust_bill::print called with positional parameters";
1203 my $lpr = delete $opt->{lpr};
1204 if($conf->exists('invoice_print_pdf')) {
1205 # Add the invoice to the current batch.
1206 $self->batch_invoice($opt);
1210 $self->lpr_data($opt),
1211 'agentnum' => $self->cust_main->agentnum,
1217 =item fax_invoice HASHREF
1221 Options must be passed as a hashref.
1223 I<template>, if specified, is the name of a suffix for alternate invoices.
1225 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1231 return if $self->hide;
1232 my $conf = $self->conf;
1233 my $opt = shift || {};
1234 if ($opt and !ref($opt)) {
1235 die "FS::cust_bill::fax_invoice called with positional parameters";
1238 die 'FAX invoice destination not (yet?) supported with plain text invoices.'
1239 unless $conf->exists('invoice_latex');
1241 my $dialstring = $self->cust_main->getfield('fax');
1244 my $error = send_fax( 'docdata' => $self->lpr_data($opt),
1245 'dialstring' => $dialstring,
1247 die $error if $error;
1251 =item batch_invoice [ HASHREF ]
1253 Place this invoice into the open batch (see C<FS::bill_batch>). If there
1254 isn't an open batch, one will be created.
1256 HASHREF may contain any options to be passed to C<print_pdf>.
1261 my ($self, $opt) = @_;
1262 my $bill_batch = $self->get_open_bill_batch;
1263 my $cust_bill_batch = FS::cust_bill_batch->new({
1264 batchnum => $bill_batch->batchnum,
1265 invnum => $self->invnum,
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 );
1998 Pays this invoice with a compliemntary payment. If there is an error,
1999 returns the error, otherwise returns false.
2005 my $cust_pay = new FS::cust_pay ( {
2006 'invnum' => $self->invnum,
2007 'paid' => $self->owed,
2010 'payinfo' => $self->cust_main->payinfo,
2018 Attempts to pay this invoice with a credit card payment via a
2019 Business::OnlinePayment realtime gateway. See
2020 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2021 for supported processors.
2027 $self->realtime_bop( 'CC', @_ );
2032 Attempts to pay this invoice with an electronic check (ACH) payment via a
2033 Business::OnlinePayment realtime gateway. See
2034 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2035 for supported processors.
2041 $self->realtime_bop( 'ECHECK', @_ );
2046 Attempts to pay this invoice with phone bill (LEC) payment via a
2047 Business::OnlinePayment realtime gateway. See
2048 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2049 for supported processors.
2055 $self->realtime_bop( 'LEC', @_ );
2059 my( $self, $method ) = (shift,shift);
2060 my $conf = $self->conf;
2063 my $cust_main = $self->cust_main;
2064 my $balance = $cust_main->balance;
2065 my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
2066 $amount = sprintf("%.2f", $amount);
2067 return "not run (balance $balance)" unless $amount > 0;
2069 my $description = 'Internet Services';
2070 if ( $conf->exists('business-onlinepayment-description') ) {
2071 my $dtempl = $conf->config('business-onlinepayment-description');
2073 my $agent_obj = $cust_main->agent
2074 or die "can't retreive agent for $cust_main (agentnum ".
2075 $cust_main->agentnum. ")";
2076 my $agent = $agent_obj->agent;
2077 my $pkgs = join(', ',
2078 map { $_->part_pkg->pkg }
2079 grep { $_->pkgnum } $self->cust_bill_pkg
2081 $description = eval qq("$dtempl");
2084 $cust_main->realtime_bop($method, $amount,
2085 'description' => $description,
2086 'invnum' => $self->invnum,
2087 #this didn't do what we want, it just calls apply_payments_and_credits
2089 'apply_to_invoice' => 1,
2092 #this changes application behavior: auto payments
2093 #triggered against a specific invoice are now applied
2094 #to that invoice instead of oldest open.
2100 =item batch_card OPTION => VALUE...
2102 Adds a payment for this invoice to the pending credit card batch (see
2103 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2104 runs the payment using a realtime gateway.
2109 my ($self, %options) = @_;
2110 my $cust_main = $self->cust_main;
2112 $options{invnum} = $self->invnum;
2114 $cust_main->batch_card(%options);
2117 sub _agent_template {
2119 $self->cust_main->agent_template;
2122 sub _agent_invoice_from {
2124 $self->cust_main->agent_invoice_from;
2127 =item invoice_barcode DIR_OR_FALSE
2129 Generates an invoice barcode PNG. If DIR_OR_FALSE is a true value,
2130 it is taken as the temp directory where the PNG file will be generated and the
2131 PNG file name is returned. Otherwise, the PNG image itself is returned.
2135 sub invoice_barcode {
2136 my ($self, $dir) = (shift,shift);
2138 my $gdbar = new GD::Barcode('Code39',$self->invnum);
2139 die "can't create barcode: " . $GD::Barcode::errStr unless $gdbar;
2140 my $gd = $gdbar->plot(Height => 30);
2143 my $bh = new File::Temp( TEMPLATE => 'barcode.'. $self->invnum. '.XXXXXXXX',
2147 ) or die "can't open temp file: $!\n";
2148 print $bh $gd->png or die "cannot write barcode to file: $!\n";
2149 my $png_file = $bh->filename;
2156 =item invnum_date_pretty
2158 Returns a string with the invoice number and date, for example:
2159 "Invoice #54 (3/20/2008)".
2161 Intended for back-end context, with regard to translation and date formatting.
2165 #note: this uses _date_pretty_unlocalized because _date_pretty is too expensive
2166 # for backend use (and also does the wrong thing, localizing for end customer
2167 # instead of backoffice configured date format)
2168 sub invnum_date_pretty {
2170 #$self->mt('Invoice #').
2171 'Invoice #'. #XXX should be translated ala web UI user (not invoice customer)
2172 $self->invnum. ' ('. $self->_date_pretty_unlocalized. ')';
2175 #sub _items_extra_usage_sections {
2177 # my $escape = shift;
2179 # my %sections = ();
2181 # my %usage_class = map{ $_->classname, $_ } qsearch('usage_class', {});
2182 # foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2184 # next unless $cust_bill_pkg->pkgnum > 0;
2186 # foreach my $section ( keys %usage_class ) {
2188 # my $usage = $cust_bill_pkg->usage($section);
2190 # next unless $usage && $usage > 0;
2192 # $sections{$section} ||= 0;
2193 # $sections{$section} += $usage;
2199 # map { { 'description' => &{$escape}($_),
2200 # 'subtotal' => $sections{$_},
2201 # 'summarized' => '',
2202 # 'tax_section' => '',
2205 # sort {$usage_class{$a}->weight <=> $usage_class{$b}->weight} keys %sections;
2209 sub _items_extra_usage_sections {
2211 my $conf = $self->conf;
2219 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
2221 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
2222 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2223 next unless $cust_bill_pkg->pkgnum > 0;
2225 foreach my $classnum ( keys %usage_class ) {
2226 my $section = $usage_class{$classnum}->classname;
2227 $classnums{$section} = $classnum;
2229 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail($classnum) ) {
2230 my $amount = $detail->amount;
2231 next unless $amount && $amount > 0;
2233 $sections{$section} ||= { 'subtotal'=>0, 'calls'=>0, 'duration'=>0 };
2234 $sections{$section}{amount} += $amount; #subtotal
2235 $sections{$section}{calls}++;
2236 $sections{$section}{duration} += $detail->duration;
2238 my $desc = $detail->regionname;
2239 my $description = $desc;
2240 $description = substr($desc, 0, $maxlength). '...'
2241 if $format eq 'latex' && length($desc) > $maxlength;
2243 $lines{$section}{$desc} ||= {
2244 description => &{$escape}($description),
2245 #pkgpart => $part_pkg->pkgpart,
2246 pkgnum => $cust_bill_pkg->pkgnum,
2251 #unit_amount => $cust_bill_pkg->unitrecur,
2252 quantity => $cust_bill_pkg->quantity,
2253 product_code => 'N/A',
2254 ext_description => [],
2257 $lines{$section}{$desc}{amount} += $amount;
2258 $lines{$section}{$desc}{calls}++;
2259 $lines{$section}{$desc}{duration} += $detail->duration;
2265 my %sectionmap = ();
2266 foreach (keys %sections) {
2267 my $usage_class = $usage_class{$classnums{$_}};
2268 $sectionmap{$_} = { 'description' => &{$escape}($_),
2269 'amount' => $sections{$_}{amount}, #subtotal
2270 'calls' => $sections{$_}{calls},
2271 'duration' => $sections{$_}{duration},
2273 'tax_section' => '',
2274 'sort_weight' => $usage_class->weight,
2275 ( $usage_class->format
2276 ? ( map { $_ => $usage_class->$_($format) }
2277 qw( description_generator header_generator total_generator total_line_generator )
2284 my @sections = sort { $a->{sort_weight} <=> $b->{sort_weight} }
2288 foreach my $section ( keys %lines ) {
2289 foreach my $line ( keys %{$lines{$section}} ) {
2290 my $l = $lines{$section}{$line};
2291 $l->{section} = $sectionmap{$section};
2292 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2293 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
2298 return(\@sections, \@lines);
2304 my $end = $self->_date;
2306 # start at date of previous invoice + 1 second or 0 if no previous invoice
2307 my $start = $self->scalar_sql("SELECT max(_date) FROM cust_bill WHERE custnum = ? and invnum != ?",$self->custnum,$self->invnum);
2308 $start = 0 if !$start;
2311 my $cust_main = $self->cust_main;
2312 my @pkgs = $cust_main->all_pkgs;
2313 my($num_activated,$num_deactivated,$num_portedin,$num_portedout,$minutes)
2316 foreach my $pkg ( @pkgs ) {
2317 my @h_cust_svc = $pkg->h_cust_svc($end);
2318 foreach my $h_cust_svc ( @h_cust_svc ) {
2319 next if grep {$_ eq $h_cust_svc->svcnum} @seen;
2320 next unless $h_cust_svc->part_svc->svcdb eq 'svc_phone';
2322 my $inserted = $h_cust_svc->date_inserted;
2323 my $deleted = $h_cust_svc->date_deleted;
2324 my $phone_inserted = $h_cust_svc->h_svc_x($inserted+5);
2326 $phone_deleted = $h_cust_svc->h_svc_x($deleted) if $deleted;
2328 # DID either activated or ported in; cannot be both for same DID simultaneously
2329 if ($inserted >= $start && $inserted <= $end && $phone_inserted
2330 && (!$phone_inserted->lnp_status
2331 || $phone_inserted->lnp_status eq ''
2332 || $phone_inserted->lnp_status eq 'native')) {
2335 else { # this one not so clean, should probably move to (h_)svc_phone
2336 my $phone_portedin = qsearchs( 'h_svc_phone',
2337 { 'svcnum' => $h_cust_svc->svcnum,
2338 'lnp_status' => 'portedin' },
2339 FS::h_svc_phone->sql_h_searchs($end),
2341 $num_portedin++ if $phone_portedin;
2344 # DID either deactivated or ported out; cannot be both for same DID simultaneously
2345 if($deleted >= $start && $deleted <= $end && $phone_deleted
2346 && (!$phone_deleted->lnp_status
2347 || $phone_deleted->lnp_status ne 'portingout')) {
2350 elsif($deleted >= $start && $deleted <= $end && $phone_deleted
2351 && $phone_deleted->lnp_status
2352 && $phone_deleted->lnp_status eq 'portingout') {
2356 # increment usage minutes
2357 if ( $phone_inserted ) {
2358 my @cdrs = $phone_inserted->get_cdrs('begin'=>$start,'end'=>$end,'billsec_sum'=>1);
2359 $minutes = $cdrs[0]->billsec_sum if scalar(@cdrs) == 1;
2362 warn "WARNING: no matching h_svc_phone insert record for insert time $inserted, svcnum " . $h_cust_svc->svcnum;
2365 # don't look at this service again
2366 push @seen, $h_cust_svc->svcnum;
2370 $minutes = sprintf("%d", $minutes);
2371 ("Activated: $num_activated Ported-In: $num_portedin Deactivated: "
2372 . "$num_deactivated Ported-Out: $num_portedout ",
2373 "Total Minutes: $minutes");
2376 sub _items_accountcode_cdr {
2381 my $section = { 'amount' => 0,
2384 'sort_weight' => '',
2386 'description' => 'Usage by Account Code',
2392 my %accountcodes = ();
2394 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2395 next unless $cust_bill_pkg->pkgnum > 0;
2397 my @header = $cust_bill_pkg->details_header;
2398 next unless scalar(@header);
2399 $section->{'header'} = join(',',@header);
2401 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
2403 $section->{'header'} = $detail->formatted('format' => $format)
2404 if($detail->detail eq $section->{'header'});
2406 my $accountcode = $detail->accountcode;
2407 next unless $accountcode;
2409 my $amount = $detail->amount;
2410 next unless $amount && $amount > 0;
2412 $accountcodes{$accountcode} ||= {
2413 description => $accountcode,
2420 product_code => 'N/A',
2421 section => $section,
2422 ext_description => [ $section->{'header'} ],
2426 $section->{'amount'} += $amount;
2427 $accountcodes{$accountcode}{'amount'} += $amount;
2428 $accountcodes{$accountcode}{calls}++;
2429 $accountcodes{$accountcode}{duration} += $detail->duration;
2430 push @{$accountcodes{$accountcode}{detail_temp}}, $detail;
2434 foreach my $l ( values %accountcodes ) {
2435 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2436 my @sorted_detail = sort { $a->startdate <=> $b->startdate } @{$l->{detail_temp}};
2437 foreach my $sorted_detail ( @sorted_detail ) {
2438 push @{$l->{ext_description}}, $sorted_detail->formatted('format'=>$format);
2440 delete $l->{detail_temp};
2444 my @sorted_lines = sort { $a->{'description'} <=> $b->{'description'} } @lines;
2446 return ($section,\@sorted_lines);
2449 sub _items_svc_phone_sections {
2451 my $conf = $self->conf;
2459 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
2461 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
2462 $usage_class{''} ||= new FS::usage_class { 'classname' => '', 'weight' => 0 };
2464 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2465 next unless $cust_bill_pkg->pkgnum > 0;
2467 my @header = $cust_bill_pkg->details_header;
2468 next unless scalar(@header);
2470 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
2472 my $phonenum = $detail->phonenum;
2473 next unless $phonenum;
2475 my $amount = $detail->amount;
2476 next unless $amount && $amount > 0;
2478 $sections{$phonenum} ||= { 'amount' => 0,
2481 'sort_weight' => -1,
2482 'phonenum' => $phonenum,
2484 $sections{$phonenum}{amount} += $amount; #subtotal
2485 $sections{$phonenum}{calls}++;
2486 $sections{$phonenum}{duration} += $detail->duration;
2488 my $desc = $detail->regionname;
2489 my $description = $desc;
2490 $description = substr($desc, 0, $maxlength). '...'
2491 if $format eq 'latex' && length($desc) > $maxlength;
2493 $lines{$phonenum}{$desc} ||= {
2494 description => &{$escape}($description),
2495 #pkgpart => $part_pkg->pkgpart,
2503 product_code => 'N/A',
2504 ext_description => [],
2507 $lines{$phonenum}{$desc}{amount} += $amount;
2508 $lines{$phonenum}{$desc}{calls}++;
2509 $lines{$phonenum}{$desc}{duration} += $detail->duration;
2511 my $line = $usage_class{$detail->classnum}->classname;
2512 $sections{"$phonenum $line"} ||=
2516 'sort_weight' => $usage_class{$detail->classnum}->weight,
2517 'phonenum' => $phonenum,
2518 'header' => [ @header ],
2520 $sections{"$phonenum $line"}{amount} += $amount; #subtotal
2521 $sections{"$phonenum $line"}{calls}++;
2522 $sections{"$phonenum $line"}{duration} += $detail->duration;
2524 $lines{"$phonenum $line"}{$desc} ||= {
2525 description => &{$escape}($description),
2526 #pkgpart => $part_pkg->pkgpart,
2534 product_code => 'N/A',
2535 ext_description => [],
2538 $lines{"$phonenum $line"}{$desc}{amount} += $amount;
2539 $lines{"$phonenum $line"}{$desc}{calls}++;
2540 $lines{"$phonenum $line"}{$desc}{duration} += $detail->duration;
2541 push @{$lines{"$phonenum $line"}{$desc}{ext_description}},
2542 $detail->formatted('format' => $format);
2547 my %sectionmap = ();
2548 my $simple = new FS::usage_class { format => 'simple' }; #bleh
2549 foreach ( keys %sections ) {
2550 my @header = @{ $sections{$_}{header} || [] };
2552 new FS::usage_class { format => 'usage_'. (scalar(@header) || 6). 'col' };
2553 my $summary = $sections{$_}{sort_weight} < 0 ? 1 : 0;
2554 my $usage_class = $summary ? $simple : $usage_simple;
2555 my $ending = $summary ? ' usage charges' : '';
2558 $gen_opt{label} = [ map{ &{$escape}($_) } @header ];
2560 $sectionmap{$_} = { 'description' => &{$escape}($_. $ending),
2561 'amount' => $sections{$_}{amount}, #subtotal
2562 'calls' => $sections{$_}{calls},
2563 'duration' => $sections{$_}{duration},
2565 'tax_section' => '',
2566 'phonenum' => $sections{$_}{phonenum},
2567 'sort_weight' => $sections{$_}{sort_weight},
2568 'post_total' => $summary, #inspire pagebreak
2570 ( map { $_ => $usage_class->$_($format, %gen_opt) }
2571 qw( description_generator
2574 total_line_generator
2581 my @sections = sort { $a->{phonenum} cmp $b->{phonenum} ||
2582 $a->{sort_weight} <=> $b->{sort_weight}
2587 foreach my $section ( keys %lines ) {
2588 foreach my $line ( keys %{$lines{$section}} ) {
2589 my $l = $lines{$section}{$line};
2590 $l->{section} = $sectionmap{$section};
2591 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2592 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
2597 if($conf->exists('phone_usage_class_summary')) {
2598 # this only works with Latex
2602 # after this, we'll have only two sections per DID:
2603 # Calls Summary and Calls Detail
2604 foreach my $section ( @sections ) {
2605 if($section->{'post_total'}) {
2606 $section->{'description'} = 'Calls Summary: '.$section->{'phonenum'};
2607 $section->{'total_line_generator'} = sub { '' };
2608 $section->{'total_generator'} = sub { '' };
2609 $section->{'header_generator'} = sub { '' };
2610 $section->{'description_generator'} = '';
2611 push @newsections, $section;
2612 my %calls_detail = %$section;
2613 $calls_detail{'post_total'} = '';
2614 $calls_detail{'sort_weight'} = '';
2615 $calls_detail{'description_generator'} = sub { '' };
2616 $calls_detail{'header_generator'} = sub {
2617 return ' & Date/Time & Called Number & Duration & Price'
2618 if $format eq 'latex';
2621 $calls_detail{'description'} = 'Calls Detail: '
2622 . $section->{'phonenum'};
2623 push @newsections, \%calls_detail;
2627 # after this, each usage class is collapsed/summarized into a single
2628 # line under the Calls Summary section
2629 foreach my $newsection ( @newsections ) {
2630 if($newsection->{'post_total'}) { # this means Calls Summary
2631 foreach my $section ( @sections ) {
2632 next unless ($section->{'phonenum'} eq $newsection->{'phonenum'}
2633 && !$section->{'post_total'});
2634 my $newdesc = $section->{'description'};
2635 my $tn = $section->{'phonenum'};
2636 $newdesc =~ s/$tn//g;
2637 my $line = { ext_description => [],
2641 calls => $section->{'calls'},
2642 section => $newsection,
2643 duration => $section->{'duration'},
2644 description => $newdesc,
2645 amount => sprintf("%.2f",$section->{'amount'}),
2646 product_code => 'N/A',
2648 push @newlines, $line;
2653 # after this, Calls Details is populated with all CDRs
2654 foreach my $newsection ( @newsections ) {
2655 if(!$newsection->{'post_total'}) { # this means Calls Details
2656 foreach my $line ( @lines ) {
2657 next unless (scalar(@{$line->{'ext_description'}}) &&
2658 $line->{'section'}->{'phonenum'} eq $newsection->{'phonenum'}
2660 my @extdesc = @{$line->{'ext_description'}};
2662 foreach my $extdesc ( @extdesc ) {
2663 $extdesc =~ s/scriptsize/normalsize/g if $format eq 'latex';
2664 push @newextdesc, $extdesc;
2666 $line->{'ext_description'} = \@newextdesc;
2667 $line->{'section'} = $newsection;
2668 push @newlines, $line;
2673 return(\@newsections, \@newlines);
2676 return(\@sections, \@lines);
2680 =sub _items_usage_class_summary OPTIONS
2682 Returns a list of detail items summarizing the usage charges on this
2683 invoice. Each one will have 'amount', 'description' (the usage charge name),
2684 and 'usage_classnum'.
2686 OPTIONS can include 'escape' (a function to escape the descriptions).
2690 sub _items_usage_class_summary {
2694 my $escape = $opt{escape} || sub { $_[0] };
2695 my $invnum = $self->invnum;
2696 my @classes = qsearch({
2697 'table' => 'usage_class',
2698 'select' => 'classnum, classname, SUM(amount) AS amount',
2699 'addl_from' => ' LEFT JOIN cust_bill_pkg_detail USING (classnum)' .
2700 ' LEFT JOIN cust_bill_pkg USING (billpkgnum)',
2701 'extra_sql' => " WHERE cust_bill_pkg.invnum = $invnum".
2702 ' GROUP BY classnum, classname, weight'.
2703 ' HAVING (usage_class.disabled IS NULL OR SUM(amount) > 0)'.
2704 ' ORDER BY weight ASC',
2708 description => &{$escape}($self->mt('Usage Summary')),
2712 foreach my $class (@classes) {
2714 'description' => &{$escape}($class->classname),
2715 'amount' => sprintf('%.2f', $class->amount),
2716 'usage_classnum' => $class->classnum,
2717 'section' => $section,
2723 sub _items_previous {
2725 my $conf = $self->conf;
2726 my $cust_main = $self->cust_main;
2727 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2729 foreach ( @pr_cust_bill ) {
2730 my $date = $conf->exists('invoice_show_prior_due_date')
2731 ? 'due '. $_->due_date2str('short')
2732 : $self->time2str_local('short', $_->_date);
2734 'description' => $self->mt('Previous Balance, Invoice #'). $_->invnum. " ($date)",
2735 #'pkgpart' => 'N/A',
2737 'amount' => sprintf("%.2f", $_->owed),
2743 # 'description' => 'Previous Balance',
2744 # #'pkgpart' => 'N/A',
2745 # 'pkgnum' => 'N/A',
2746 # 'amount' => sprintf("%10.2f", $pr_total ),
2747 # 'ext_description' => [ map {
2748 # "Invoice ". $_->invnum.
2749 # " (". time2str("%x",$_->_date). ") ".
2750 # sprintf("%10.2f", $_->owed)
2751 # } @pr_cust_bill ],
2756 sub _items_credits {
2757 my( $self, %opt ) = @_;
2758 my $trim_len = $opt{'trim_len'} || 60;
2763 if ( $self->conf->exists('previous_balance-payments_since') ) {
2764 if ( $opt{'template'} eq 'statement' ) {
2765 # then the current bill is a "statement" (i.e. an invoice sent as
2766 # a payment receipt)
2767 # and in that case we want to see payments on or after THIS invoice
2768 @objects = qsearch('cust_credit', {
2769 'custnum' => $self->custnum,
2770 '_date' => {op => '>=', value => $self->_date},
2774 $date = $self->previous_bill->_date if $self->previous_bill;
2775 @objects = qsearch('cust_credit', {
2776 'custnum' => $self->custnum,
2777 '_date' => {op => '>=', value => $date},
2781 @objects = $self->cust_credited;
2784 foreach my $obj ( @objects ) {
2785 my $cust_credit = $obj->isa('FS::cust_credit') ? $obj : $obj->cust_credit;
2787 my $reason = substr($cust_credit->reason, 0, $trim_len);
2788 $reason .= '...' if length($reason) < length($cust_credit->reason);
2789 $reason = " ($reason) " if $reason;
2792 #'description' => 'Credit ref\#'. $_->crednum.
2793 # " (". time2str("%x",$_->cust_credit->_date) .")".
2795 'description' => $self->mt('Credit applied').' '.
2796 $self->time2str_local('short', $obj->_date). $reason,
2797 'amount' => sprintf("%.2f",$obj->amount),
2805 sub _items_payments {
2810 my $detailed = $self->conf->exists('invoice_payment_details');
2812 if ( $self->conf->exists('previous_balance-payments_since') ) {
2813 # then show payments dated on/after the previous bill...
2814 if ( $opt{'template'} eq 'statement' ) {
2815 # then the current bill is a "statement" (i.e. an invoice sent as
2816 # a payment receipt)
2817 # and in that case we want to see payments on or after THIS invoice
2818 @objects = qsearch('cust_pay', {
2819 'custnum' => $self->custnum,
2820 '_date' => {op => '>=', value => $self->_date},
2823 # the normal case: payments on or after the previous invoice
2825 $date = $self->previous_bill->_date if $self->previous_bill;
2826 @objects = qsearch('cust_pay', {
2827 'custnum' => $self->custnum,
2828 '_date' => {op => '>=', value => $date},
2830 # and before the current bill...
2831 @objects = grep { $_->_date < $self->_date } @objects;
2834 @objects = $self->cust_bill_pay;
2837 foreach my $obj (@objects) {
2838 my $cust_pay = $obj->isa('FS::cust_pay') ? $obj : $obj->cust_pay;
2839 my $desc = $self->mt('Payment received').' '.
2840 $self->time2str_local('short', $cust_pay->_date );
2841 $desc .= $self->mt(' via ') .
2842 $cust_pay->payby_payinfo_pretty( $self->cust_main->locale )
2846 'description' => $desc,
2847 'amount' => sprintf("%.2f", $obj->amount )
2855 =item call_details [ OPTION => VALUE ... ]
2857 Returns an array of CSV strings representing the call details for this invoice
2858 The only option available is the boolean prepend_billed_number
2863 my ($self, %opt) = @_;
2865 my $format_function = sub { shift };
2867 if ($opt{prepend_billed_number}) {
2868 $format_function = sub {
2872 $row->amount ? $row->phonenum. ",". $detail : '"Billed number",'. $detail;
2877 my @details = map { $_->details( 'format_function' => $format_function,
2878 'escape_function' => sub{ return() },
2882 $self->cust_bill_pkg;
2883 my $header = $details[0];
2884 ( $header, grep { $_ ne $header } @details );
2894 =item process_reprint
2898 sub process_reprint {
2899 process_re_X('print', @_);
2902 =item process_reemail
2906 sub process_reemail {
2907 process_re_X('email', @_);
2915 process_re_X('fax', @_);
2923 process_re_X('ftp', @_);
2930 sub process_respool {
2931 process_re_X('spool', @_);
2934 use Storable qw(thaw);
2938 my( $method, $job ) = ( shift, shift );
2939 warn "$me process_re_X $method for job $job\n" if $DEBUG;
2941 my $param = thaw(decode_base64(shift));
2942 warn Dumper($param) if $DEBUG;
2953 # spool_invoice ftp_invoice fax_invoice print_invoice
2954 my($method, $job, %param ) = @_;
2956 warn "re_X $method for job $job with param:\n".
2957 join( '', map { " $_ => ". $param{$_}. "\n" } keys %param );
2960 #some false laziness w/search/cust_bill.html
2962 my $orderby = 'ORDER BY cust_bill._date';
2964 my $extra_sql = ' WHERE '. FS::cust_bill->search_sql_where(\%param);
2966 my $addl_from = 'LEFT JOIN cust_main USING ( custnum )';
2968 my @cust_bill = qsearch( {
2969 #'select' => "cust_bill.*",
2970 'table' => 'cust_bill',
2971 'addl_from' => $addl_from,
2973 'extra_sql' => $extra_sql,
2974 'order_by' => $orderby,
2978 $method .= '_invoice' unless $method eq 'email' || $method eq 'print';
2980 warn " $me re_X $method: ". scalar(@cust_bill). " invoices found\n"
2983 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
2984 foreach my $cust_bill ( @cust_bill ) {
2985 $cust_bill->$method();
2987 if ( $job ) { #progressbar foo
2989 if ( time - $min_sec > $last ) {
2990 my $error = $job->update_statustext(
2991 int( 100 * $num / scalar(@cust_bill) )
2993 die $error if $error;
3004 =head1 CLASS METHODS
3010 Returns an SQL fragment to retreive the amount owed (charged minus credited and paid).
3015 my ($class, $start, $end) = @_;
3017 $class->paid_sql($start, $end). ' - '.
3018 $class->credited_sql($start, $end);
3023 Returns an SQL fragment to retreive the net amount (charged minus credited).
3028 my ($class, $start, $end) = @_;
3029 'charged - '. $class->credited_sql($start, $end);
3034 Returns an SQL fragment to retreive the amount paid against this invoice.
3039 my ($class, $start, $end) = @_;
3040 $start &&= "AND cust_bill_pay._date <= $start";
3041 $end &&= "AND cust_bill_pay._date > $end";
3042 $start = '' unless defined($start);
3043 $end = '' unless defined($end);
3044 "( SELECT COALESCE(SUM(amount),0) FROM cust_bill_pay
3045 WHERE cust_bill.invnum = cust_bill_pay.invnum $start $end )";
3050 Returns an SQL fragment to retreive the amount credited against this invoice.
3055 my ($class, $start, $end) = @_;
3056 $start &&= "AND cust_credit_bill._date <= $start";
3057 $end &&= "AND cust_credit_bill._date > $end";
3058 $start = '' unless defined($start);
3059 $end = '' unless defined($end);
3060 "( SELECT COALESCE(SUM(amount),0) FROM cust_credit_bill
3061 WHERE cust_bill.invnum = cust_credit_bill.invnum $start $end )";
3066 Returns an SQL fragment to retrieve the due date of an invoice.
3067 Currently only supported on PostgreSQL.
3072 die "don't use: doesn't account for agent-specific invoice_default_terms";
3074 #we're passed a $conf but not a specific customer (that's in the query), so
3075 # to make this work we'd need an agentnum-aware "condition_sql_conf" like
3076 # "condition_sql_option" that retreives a conf value with SQL in an agent-
3079 my $conf = new FS::Conf;
3083 cust_bill.invoice_terms,
3084 cust_main.invoice_terms,
3085 \''.($conf->config('invoice_default_terms') || '').'\'
3086 ), E\'Net (\\\\d+)\'
3088 ) * 86400 + cust_bill._date'
3099 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
3100 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base