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 );
20 use FS::cust_statement;
21 use FS::cust_bill_pkg;
22 use FS::cust_bill_pkg_display;
23 use FS::cust_bill_pkg_detail;
27 use FS::cust_credit_bill;
29 use FS::cust_bill_event;
32 use FS::cust_bill_pay;
33 use FS::part_bill_event;
36 use FS::cust_bill_batch;
37 use FS::cust_bill_pay_pkg;
38 use FS::cust_credit_bill_pkg;
39 use FS::discount_plan;
40 use FS::cust_bill_void;
44 $me = '[FS::cust_bill]';
48 FS::cust_bill - Object methods for cust_bill records
54 $record = new FS::cust_bill \%hash;
55 $record = new FS::cust_bill { 'column' => 'value' };
57 $error = $record->insert;
59 $error = $new_record->replace($old_record);
61 $error = $record->delete;
63 $error = $record->check;
65 ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
67 @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
69 ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
71 @cust_pay_objects = $cust_bill->cust_pay;
73 $tax_amount = $record->tax;
75 @lines = $cust_bill->print_text;
76 @lines = $cust_bill->print_text('time' => $time);
80 An FS::cust_bill object represents an invoice; a declaration that a customer
81 owes you money. The specific charges are itemized as B<cust_bill_pkg> records
82 (see L<FS::cust_bill_pkg>). FS::cust_bill inherits from FS::Record. The
83 following fields are currently supported:
89 =item invnum - primary key (assigned automatically for new invoices)
91 =item custnum - customer (see L<FS::cust_main>)
93 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
94 L<Time::Local> and L<Date::Parse> for conversion functions.
96 =item charged - amount of this invoice
98 =item invoice_terms - optional terms override for this specific invoice
106 =item billing_balance - the customer's balance immediately before generating
107 this invoice. DEPRECATED. Use the L<FS::cust_main/balance_date> method
108 to determine the customer's balance at a specific time.
110 =item previous_balance - the customer's balance immediately after generating
111 the invoice before this one. DEPRECATED.
113 =item printed - formerly used to track the number of times an invoice had
114 been printed; no longer used.
122 =item closed - books closed flag, empty or `Y'
124 =item statementnum - invoice aggregation (see L<FS::cust_statement>)
126 =item agent_invid - legacy invoice number
128 =item promised_date - customer promised payment date, for collection
130 =item pending - invoice is still being generated, empty or 'Y'
140 Creates a new invoice. To add the invoice to the database, see L<"insert">.
141 Invoices are normally created by calling the bill method of a customer object
142 (see L<FS::cust_main>).
146 sub table { 'cust_bill'; }
148 # should be the ONLY occurrence of "Invoice" in invoice rendering code.
149 # (except email_subject and invnum_date_pretty)
152 $self->conf->config('notice_name') || 'Invoice'
155 sub cust_linked { $_[0]->cust_main_custnum || $_[0]->custnum }
156 sub cust_unlinked_msg {
158 "WARNING: can't find cust_main.custnum ". $self->custnum.
159 ' (cust_bill.invnum '. $self->invnum. ')';
164 Adds this invoice to the database ("Posts" the invoice). If there is an error,
165 returns the error, otherwise returns false.
171 warn "$me insert called\n" if $DEBUG;
173 local $SIG{HUP} = 'IGNORE';
174 local $SIG{INT} = 'IGNORE';
175 local $SIG{QUIT} = 'IGNORE';
176 local $SIG{TERM} = 'IGNORE';
177 local $SIG{TSTP} = 'IGNORE';
178 local $SIG{PIPE} = 'IGNORE';
180 my $oldAutoCommit = $FS::UID::AutoCommit;
181 local $FS::UID::AutoCommit = 0;
184 my $error = $self->SUPER::insert;
186 $dbh->rollback if $oldAutoCommit;
190 if ( $self->get('cust_bill_pkg') ) {
191 foreach my $cust_bill_pkg ( @{$self->get('cust_bill_pkg')} ) {
192 $cust_bill_pkg->invnum($self->invnum);
193 my $error = $cust_bill_pkg->insert;
195 $dbh->rollback if $oldAutoCommit;
196 return "can't create invoice line item: $error";
201 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
208 Voids this invoice: deletes the invoice and adds a record of the voided invoice
209 to the FS::cust_bill_void table (and related tables starting from
210 FS::cust_bill_pkg_void).
216 my $reason = scalar(@_) ? shift : '';
218 local $SIG{HUP} = 'IGNORE';
219 local $SIG{INT} = 'IGNORE';
220 local $SIG{QUIT} = 'IGNORE';
221 local $SIG{TERM} = 'IGNORE';
222 local $SIG{TSTP} = 'IGNORE';
223 local $SIG{PIPE} = 'IGNORE';
225 my $oldAutoCommit = $FS::UID::AutoCommit;
226 local $FS::UID::AutoCommit = 0;
229 my $cust_bill_void = new FS::cust_bill_void ( {
230 map { $_ => $self->get($_) } $self->fields
232 $cust_bill_void->reason($reason);
233 my $error = $cust_bill_void->insert;
235 $dbh->rollback if $oldAutoCommit;
239 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
240 my $error = $cust_bill_pkg->void($reason);
242 $dbh->rollback if $oldAutoCommit;
247 $error = $self->delete;
249 $dbh->rollback if $oldAutoCommit;
253 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
261 This method now works but you probably shouldn't use it. Instead, apply a
262 credit against the invoice, or use the new void method.
264 Using this method to delete invoices outright is really, really bad. There
265 would be no record you ever posted this invoice, and there are no check to
266 make sure charged = 0 or that there are no associated cust_bill_pkg records.
268 Really, don't use it.
274 return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
276 local $SIG{HUP} = 'IGNORE';
277 local $SIG{INT} = 'IGNORE';
278 local $SIG{QUIT} = 'IGNORE';
279 local $SIG{TERM} = 'IGNORE';
280 local $SIG{TSTP} = 'IGNORE';
281 local $SIG{PIPE} = 'IGNORE';
283 my $oldAutoCommit = $FS::UID::AutoCommit;
284 local $FS::UID::AutoCommit = 0;
287 foreach my $table (qw(
298 foreach my $linked ( $self->$table() ) {
299 my $error = $linked->delete;
301 $dbh->rollback if $oldAutoCommit;
308 my $error = $self->SUPER::delete(@_);
310 $dbh->rollback if $oldAutoCommit;
314 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
320 =item replace [ OLD_RECORD ]
322 You can, but probably shouldn't modify invoices...
324 Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
325 supplied, replaces this record. If there is an error, returns the error,
326 otherwise returns false.
330 #replace can be inherited from Record.pm
332 # replace_check is now the preferred way to #implement replace data checks
333 # (so $object->replace() works without an argument)
336 my( $new, $old ) = ( shift, shift );
337 return "Can't modify closed invoice" if $old->closed =~ /^Y/i;
338 #return "Can't change _date!" unless $old->_date eq $new->_date;
339 return "Can't change _date" unless $old->_date == $new->_date;
340 return "Can't change charged" unless $old->charged == $new->charged
341 || $old->pending eq 'Y'
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?
396 || $self->ut_flag('pending')
398 return $error if $error;
400 $self->_date(time) unless $self->_date;
402 $self->printed(0) if $self->printed eq '';
409 Returns the displayed invoice number for this invoice: agent_invid if
410 cust_bill-default_agent_invid is set and it has a value, invnum otherwise.
416 if ( $self->agent_invid
417 && FS::Conf->new->exists('cust_bill-default_agent_invid') ) {
418 return $self->agent_invid;
420 return $self->invnum;
426 Returns the customer's last invoice before this one.
432 if ( !$self->get('previous_bill') ) {
433 $self->set('previous_bill', qsearchs({
434 'table' => 'cust_bill',
435 'hashref' => { 'custnum' => $self->custnum,
436 '_date' => { op=>'<', value=>$self->_date } },
437 'order_by' => 'ORDER BY _date DESC LIMIT 1',
440 $self->get('previous_bill');
445 Returns a list consisting of the total previous balance for this customer,
446 followed by the previous outstanding invoices (as FS::cust_bill objects also).
453 my @cust_bill = sort { $a->_date <=> $b->_date }
454 grep { $_->owed != 0 }
455 qsearch( 'cust_bill', { 'custnum' => $self->custnum,
456 #'_date' => { op=>'<', value=>$self->_date },
457 'invnum' => { op=>'<', value=>$self->invnum },
460 foreach ( @cust_bill ) { $total += $_->owed; }
464 =item enable_previous
466 Whether to show the 'Previous Charges' section when printing this invoice.
467 The negation of the 'disable_previous_balance' config setting.
471 sub enable_previous {
473 my $agentnum = $self->cust_main->agentnum;
474 !$self->conf->exists('disable_previous_balance', $agentnum);
479 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
486 { 'table' => 'cust_bill_pkg',
487 'hashref' => { 'invnum' => $self->invnum },
488 'order_by' => 'ORDER BY billpkgnum', #important? otherwise we could use
489 # the AUTLOADED FK search. or should
490 # that default to ORDER by the pkey?
495 =item cust_bill_pkg_pkgnum PKGNUM
497 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice and
502 sub cust_bill_pkg_pkgnum {
503 my( $self, $pkgnum ) = @_;
505 { 'table' => 'cust_bill_pkg',
506 'hashref' => { 'invnum' => $self->invnum,
509 'order_by' => 'ORDER BY billpkgnum',
516 Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
523 my @cust_pkg = map { $_->pkgnum > 0 ? $_->cust_pkg : () }
524 $self->cust_bill_pkg;
526 grep { ! $saw{$_->pkgnum}++ } @cust_pkg;
531 Returns true if any of the packages (or their definitions) corresponding to the
532 line items for this invoice have the no_auto flag set.
538 grep { $_->no_auto || $_->part_pkg->no_auto } $self->cust_pkg;
541 =item open_cust_bill_pkg
543 Returns the open line items for this invoice.
545 Note that cust_bill_pkg with both setup and recur fees are returned as two
546 separate line items, each with only one fee.
550 # modeled after cust_main::open_cust_bill
551 sub open_cust_bill_pkg {
554 # grep { $_->owed > 0 } $self->cust_bill_pkg
556 my %other = ( 'recur' => 'setup',
557 'setup' => 'recur', );
559 foreach my $field ( qw( recur setup )) {
560 push @open, map { $_->set( $other{$field}, 0 ); $_; }
561 grep { $_->owed($field) > 0 }
562 $self->cust_bill_pkg;
568 =item cust_bill_event
570 Returns the completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
574 sub cust_bill_event {
576 qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
579 =item num_cust_bill_event
581 Returns the number of completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
585 sub num_cust_bill_event {
588 "SELECT COUNT(*) FROM cust_bill_event WHERE invnum = ?";
589 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
590 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
591 $sth->fetchrow_arrayref->[0];
596 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
600 #false laziness w/cust_pkg.pm
604 'table' => 'cust_event',
605 'addl_from' => 'JOIN part_event USING ( eventpart )',
606 'hashref' => { 'tablenum' => $self->invnum },
607 'extra_sql' => " AND eventtable = 'cust_bill' ",
613 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
617 #false laziness w/cust_pkg.pm
621 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
622 " WHERE tablenum = ? AND eventtable = 'cust_bill'";
623 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
624 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
625 $sth->fetchrow_arrayref->[0];
630 Returns the customer (see L<FS::cust_main>) for this invoice.
634 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this invoice
636 Returns a list: an empty list on success or a list of errors.
643 grep { $_->suspend(@_) }
644 grep {! $_->getfield('cancel') }
649 =item cust_suspend_if_balance_over AMOUNT
651 Suspends the customer associated with this invoice if the total amount owed on
652 this invoice and all older invoices is greater than the specified amount.
654 Returns a list: an empty list on success or a list of errors.
658 sub cust_suspend_if_balance_over {
659 my( $self, $amount ) = ( shift, shift );
660 my $cust_main = $self->cust_main;
661 if ( $cust_main->total_owed_date($self->_date) < $amount ) {
664 $cust_main->suspend(@_);
670 Cancel the packages on this invoice. Largely similar to the cust_main version, but does not bother yet with banned payment options
675 my( $self, %opt ) = @_;
677 warn "$me cancel called on cust_bill ". $self->invnum . " with options ".
678 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
681 return ( 'Access denied' )
682 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
684 my @pkgs = $self->cust_pkg;
686 if ( !$opt{nobill} && $self->conf->exists('bill_usage_on_cancel') ) {
688 my $error = $self->cust_main->bill( pkg_list => [ @pkgs ], cancel => 1 );
689 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
694 map { $_->cancel(%opt) }
695 grep { ! $_->getfield('cancel') }
701 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
707 map { $_ } #return $self->num_cust_bill_pay unless wantarray;
708 sort { $a->_date <=> $b->_date }
709 qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
714 =item cust_credit_bill
716 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
722 map { $_ } #return $self->num_cust_credit_bill unless wantarray;
723 sort { $a->_date <=> $b->_date }
724 qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
728 sub cust_credit_bill {
729 shift->cust_credited(@_);
732 #=item cust_bill_pay_pkgnum PKGNUM
734 #Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
735 #with matching pkgnum.
739 #sub cust_bill_pay_pkgnum {
740 # my( $self, $pkgnum ) = @_;
741 # map { $_ } #return $self->num_cust_bill_pay_pkgnum($pkgnum) unless wantarray;
742 # sort { $a->_date <=> $b->_date }
743 # qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum,
744 # 'pkgnum' => $pkgnum,
749 =item cust_bill_pay_pkg PKGNUM
751 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
752 applied against the matching pkgnum.
756 sub cust_bill_pay_pkg {
757 my( $self, $pkgnum ) = @_;
760 'select' => 'cust_bill_pay_pkg.*',
761 'table' => 'cust_bill_pay_pkg',
762 'addl_from' => ' LEFT JOIN cust_bill_pay USING ( billpaynum ) '.
763 ' LEFT JOIN cust_bill_pkg USING ( billpkgnum ) ',
764 'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
765 " AND cust_bill_pkg.pkgnum = $pkgnum",
770 #=item cust_credited_pkgnum PKGNUM
772 #=item cust_credit_bill_pkgnum PKGNUM
774 #Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice
775 #with matching pkgnum.
779 #sub cust_credited_pkgnum {
780 # my( $self, $pkgnum ) = @_;
781 # map { $_ } #return $self->num_cust_credit_bill_pkgnum($pkgnum) unless wantarray;
782 # sort { $a->_date <=> $b->_date }
783 # qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum,
784 # 'pkgnum' => $pkgnum,
789 #sub cust_credit_bill_pkgnum {
790 # shift->cust_credited_pkgnum(@_);
793 =item cust_credit_bill_pkg PKGNUM
795 Returns all credit applications (see L<FS::cust_credit_bill>) for this invoice
796 applied against the matching pkgnum.
800 sub cust_credit_bill_pkg {
801 my( $self, $pkgnum ) = @_;
804 'select' => 'cust_credit_bill_pkg.*',
805 'table' => 'cust_credit_bill_pkg',
806 'addl_from' => ' LEFT JOIN cust_credit_bill USING ( creditbillnum ) '.
807 ' LEFT JOIN cust_bill_pkg USING ( billpkgnum ) ',
808 'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
809 " AND cust_bill_pkg.pkgnum = $pkgnum",
814 =item cust_bill_batch
816 Returns all invoice batch records (L<FS::cust_bill_batch>) for this invoice.
820 sub cust_bill_batch {
822 qsearch('cust_bill_batch', { 'invnum' => $self->invnum });
827 Returns all discount plans (L<FS::discount_plan>) for this invoice, as a
828 hash keyed by term length.
834 FS::discount_plan->all($self);
839 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
846 my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
848 foreach (@taxlines) { $total += $_->setup; }
854 Returns the amount owed (still outstanding) on this invoice, which is charged
855 minus all payment applications (see L<FS::cust_bill_pay>) and credit
856 applications (see L<FS::cust_credit_bill>).
862 my $balance = $self->charged;
863 $balance -= $_->amount foreach ( $self->cust_bill_pay );
864 $balance -= $_->amount foreach ( $self->cust_credited );
865 $balance = sprintf( "%.2f", $balance);
866 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
871 my( $self, $pkgnum ) = @_;
873 #my $balance = $self->charged;
875 $balance += $_->setup + $_->recur for $self->cust_bill_pkg_pkgnum($pkgnum);
877 $balance -= $_->amount for $self->cust_bill_pay_pkg($pkgnum);
878 $balance -= $_->amount for $self->cust_credit_bill_pkg($pkgnum);
880 $balance = sprintf( "%.2f", $balance);
881 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
887 Returns true if this invoice should be hidden. See the
888 selfservice-hide_invoices-taxclass configuraiton setting.
894 my $conf = $self->conf;
895 my $hide_taxclass = $conf->config('selfservice-hide_invoices-taxclass')
897 my @cust_bill_pkg = $self->cust_bill_pkg;
898 my @part_pkg = grep $_, map $_->part_pkg, @cust_bill_pkg;
899 ! grep { $_->taxclass ne $hide_taxclass } @part_pkg;
902 =item apply_payments_and_credits [ OPTION => VALUE ... ]
904 Applies unapplied payments and credits to this invoice.
906 A hash of optional arguments may be passed. Currently "manual" is supported.
907 If true, a payment receipt is sent instead of a statement when
908 'payment_receipt_email' configuration option is set.
910 If there is an error, returns the error, otherwise returns false.
914 sub apply_payments_and_credits {
915 my( $self, %options ) = @_;
916 my $conf = $self->conf;
918 local $SIG{HUP} = 'IGNORE';
919 local $SIG{INT} = 'IGNORE';
920 local $SIG{QUIT} = 'IGNORE';
921 local $SIG{TERM} = 'IGNORE';
922 local $SIG{TSTP} = 'IGNORE';
923 local $SIG{PIPE} = 'IGNORE';
925 my $oldAutoCommit = $FS::UID::AutoCommit;
926 local $FS::UID::AutoCommit = 0;
929 $self->select_for_update; #mutex
931 my @payments = grep { $_->unapplied > 0 } $self->cust_main->cust_pay;
932 my @credits = grep { $_->credited > 0 } $self->cust_main->cust_credit;
934 if ( $conf->exists('pkg-balances') ) {
935 # limit @payments & @credits to those w/ a pkgnum grepped from $self
936 my %pkgnums = map { $_ => 1 } map $_->pkgnum, $self->cust_bill_pkg;
937 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
938 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
941 while ( $self->owed > 0 and ( @payments || @credits ) ) {
944 if ( @payments && @credits ) {
946 #decide which goes first by weight of top (unapplied) line item
948 my @open_lineitems = $self->open_cust_bill_pkg;
951 max( map { $_->part_pkg->pay_weight || 0 }
956 my $max_credit_weight =
957 max( map { $_->part_pkg->credit_weight || 0 }
963 #if both are the same... payments first? it has to be something
964 if ( $max_pay_weight >= $max_credit_weight ) {
970 } elsif ( @payments ) {
972 } elsif ( @credits ) {
975 die "guru meditation #12 and 35";
979 if ( $app eq 'pay' ) {
981 my $payment = shift @payments;
982 $unapp_amount = $payment->unapplied;
983 $app = new FS::cust_bill_pay { 'paynum' => $payment->paynum };
984 $app->pkgnum( $payment->pkgnum )
985 if $conf->exists('pkg-balances') && $payment->pkgnum;
987 } elsif ( $app eq 'credit' ) {
989 my $credit = shift @credits;
990 $unapp_amount = $credit->credited;
991 $app = new FS::cust_credit_bill { 'crednum' => $credit->crednum };
992 $app->pkgnum( $credit->pkgnum )
993 if $conf->exists('pkg-balances') && $credit->pkgnum;
996 die "guru meditation #12 and 35";
1000 if ( $conf->exists('pkg-balances') && $app->pkgnum ) {
1001 warn "owed_pkgnum ". $app->pkgnum;
1002 $owed = $self->owed_pkgnum($app->pkgnum);
1004 $owed = $self->owed;
1006 next unless $owed > 0;
1008 warn "min ( $unapp_amount, $owed )\n" if $DEBUG;
1009 $app->amount( sprintf('%.2f', min( $unapp_amount, $owed ) ) );
1011 $app->invnum( $self->invnum );
1013 my $error = $app->insert(%options);
1015 $dbh->rollback if $oldAutoCommit;
1016 return "Error inserting ". $app->table. " record: $error";
1018 die $error if $error;
1022 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1029 Sends this invoice to the destinations configured for this customer: sends
1030 email, prints and/or faxes. See L<FS::cust_main_invoice>.
1032 Options can be passed as a hashref. Positional parameters are no longer
1035 I<template>: a suffix for alternate invoices
1037 I<agentnum>: obsolete, now does nothing.
1039 I<from> overrides the default email invoice From: address.
1041 I<amount>: obsolete, does nothing
1043 I<notice_name> overrides "Invoice" as the name of the sent document
1044 (templates from 10/2009 or newer required).
1046 I<lpr> overrides the system 'lpr' option as the command to print a document
1047 from standard input.
1053 my $opt = ref($_[0]) ? $_[0] : +{ @_ };
1054 my $conf = $self->conf;
1056 my $cust_main = $self->cust_main;
1058 my @invoicing_list = $cust_main->invoicing_list;
1061 if ( grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list )
1062 && ! $cust_main->invoice_noemail;
1065 if grep { $_ eq 'POST' } @invoicing_list; #postal
1067 #this has never been used post-$ORIGINAL_ISP afaik
1068 $self->fax_invoice($opt)
1069 if grep { $_ eq 'FAX' } @invoicing_list; #fax
1077 my $opt = shift || {};
1078 if ($opt and !ref($opt)) {
1079 die ref($self). '->email called with positional parameters';
1082 my $conf = $self->conf;
1084 my $from = delete $opt->{from};
1086 # this is where we set the From: address
1087 $from ||= $self->_agent_invoice_from || #XXX should go away
1088 $conf->config('invoice_from', $self->cust_main->agentnum );
1090 my @invoicing_list = $self->cust_main->invoicing_list_emailonly;
1092 if ( ! @invoicing_list ) { #no recipients
1093 if ( $conf->exists('cust_bill-no_recipients-error') ) {
1094 die 'No recipients for customer #'. $self->custnum;
1096 #default: better to notify this person than silence
1097 @invoicing_list = ($from);
1101 $self->SUPER::email( {
1103 'to' => \@invoicing_list,
1109 #this stays here for now because its explicitly used as
1110 # FS::cust_bill::queueable_email
1111 sub queueable_email {
1114 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1115 or die "invalid invoice number: " . $opt{invnum};
1117 my %args = map {$_ => $opt{$_}}
1119 qw( from notice_name no_coupon template );
1121 my $error = $self->email( \%args );
1122 die $error if $error;
1128 my $conf = $self->conf;
1130 #my $template = scalar(@_) ? shift : '';
1133 my $subject = $conf->config('invoice_subject', $self->cust_main->agentnum)
1136 my $cust_main = $self->cust_main;
1137 my $name = $cust_main->name;
1138 my $name_short = $cust_main->name_short;
1139 my $invoice_number = $self->invnum;
1140 my $invoice_date = $self->_date_pretty;
1142 eval qq("$subject");
1145 =item lpr_data HASHREF
1147 Returns the postscript or plaintext for this invoice as an arrayref.
1149 Options must be passed as a hashref. Positional parameters are no longer
1152 I<template>, if specified, is the name of a suffix for alternate invoices.
1154 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1160 my $conf = $self->conf;
1161 my $opt = shift || {};
1162 if ($opt and !ref($opt)) {
1163 # nobody does this anyway
1164 die "FS::cust_bill::lpr_data called with positional parameters";
1167 my $method = $conf->exists('invoice_latex') ? 'print_ps' : 'print_text';
1168 [ $self->$method( $opt ) ];
1173 Prints this invoice.
1175 Options must be passed as a hashref.
1177 I<template>, if specified, is the name of a suffix for alternate invoices.
1179 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1185 return if $self->hide;
1186 my $conf = $self->conf;
1187 my $opt = shift || {};
1188 if ($opt and !ref($opt)) {
1189 die "FS::cust_bill::print called with positional parameters";
1192 my $lpr = delete $opt->{lpr};
1193 if($conf->exists('invoice_print_pdf')) {
1194 # Add the invoice to the current batch.
1195 $self->batch_invoice($opt);
1199 $self->lpr_data($opt),
1200 'agentnum' => $self->cust_main->agentnum,
1206 =item fax_invoice HASHREF
1210 Options must be passed as a hashref.
1212 I<template>, if specified, is the name of a suffix for alternate invoices.
1214 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1220 return if $self->hide;
1221 my $conf = $self->conf;
1222 my $opt = shift || {};
1223 if ($opt and !ref($opt)) {
1224 die "FS::cust_bill::fax_invoice called with positional parameters";
1227 die 'FAX invoice destination not (yet?) supported with plain text invoices.'
1228 unless $conf->exists('invoice_latex');
1230 my $dialstring = $self->cust_main->getfield('fax');
1233 my $error = send_fax( 'docdata' => $self->lpr_data($opt),
1234 'dialstring' => $dialstring,
1236 die $error if $error;
1240 =item batch_invoice [ HASHREF ]
1242 Place this invoice into the open batch (see C<FS::bill_batch>). If there
1243 isn't an open batch, one will be created.
1245 HASHREF may contain any options to be passed to C<print_pdf>.
1250 my ($self, $opt) = @_;
1251 my $bill_batch = $self->get_open_bill_batch;
1252 my $cust_bill_batch = FS::cust_bill_batch->new({
1253 batchnum => $bill_batch->batchnum,
1254 invnum => $self->invnum,
1256 return $cust_bill_batch->insert($opt);
1259 =item get_open_batch
1261 Returns the currently open batch as an FS::bill_batch object, creating a new
1262 one if necessary. (A per-agent batch if invoice_print_pdf-spoolagent is
1267 sub get_open_bill_batch {
1269 my $conf = $self->conf;
1270 my $hashref = { status => 'O' };
1271 $hashref->{'agentnum'} = $conf->exists('invoice_print_pdf-spoolagent')
1272 ? $self->cust_main->agentnum
1274 my $batch = qsearchs('bill_batch', $hashref);
1275 return $batch if $batch;
1276 $batch = FS::bill_batch->new($hashref);
1277 my $error = $batch->insert;
1278 die $error if $error;
1282 =item ftp_invoice [ TEMPLATENAME ]
1284 Sends this invoice data via FTP.
1286 TEMPLATENAME is unused?
1292 my $conf = $self->conf;
1293 my $template = scalar(@_) ? shift : '';
1296 'protocol' => 'ftp',
1297 'server' => $conf->config('cust_bill-ftpserver'),
1298 'username' => $conf->config('cust_bill-ftpusername'),
1299 'password' => $conf->config('cust_bill-ftppassword'),
1300 'dir' => $conf->config('cust_bill-ftpdir'),
1301 'format' => $conf->config('cust_bill-ftpformat'),
1305 =item spool_invoice [ TEMPLATENAME ]
1307 Spools this invoice data (see L<FS::spool_csv>)
1309 TEMPLATENAME is unused?
1315 my $conf = $self->conf;
1316 my $template = scalar(@_) ? shift : '';
1319 'format' => $conf->config('cust_bill-spoolformat'),
1320 'agent_spools' => $conf->exists('cust_bill-spoolagent'),
1324 =item send_csv OPTION => VALUE, ...
1326 Sends invoice as a CSV data-file to a remote host with the specified protocol.
1330 protocol - currently only "ftp"
1336 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
1337 and YYMMDDHHMMSS is a timestamp.
1339 See L</print_csv> for a description of the output format.
1344 my($self, %opt) = @_;
1348 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1349 mkdir $spooldir, 0700 unless -d $spooldir;
1351 # don't localize dates here, they're a defined format
1352 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1353 my $file = "$spooldir/$tracctnum.csv";
1355 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1357 open(CSV, ">$file") or die "can't open $file: $!";
1365 if ( $opt{protocol} eq 'ftp' ) {
1366 eval "use Net::FTP;";
1368 $net = Net::FTP->new($opt{server}) or die @$;
1370 die "unknown protocol: $opt{protocol}";
1373 $net->login( $opt{username}, $opt{password} )
1374 or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
1376 $net->binary or die "can't set binary mode";
1378 $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
1380 $net->put($file) or die "can't put $file: $!";
1390 Spools CSV invoice data.
1396 =item format - any of FS::Misc::::Invoicing::spool_formats
1398 =item dest - if set (to POST, EMAIL or FAX), only sends spools invoices if the
1399 customer has the corresponding invoice destinations set (see
1400 L<FS::cust_main_invoice>).
1402 =item agent_spools - if set to a true value, will spool to per-agent files
1403 rather than a single global file
1405 =item upload_targetnum - if set to a target (see L<FS::upload_target>), will
1406 append to that spool. L<FS::Cron::upload> will then send the spool file to
1409 =item balanceover - if set, only spools the invoice if the total amount owed on
1410 this invoice and all older invoices is greater than the specified amount.
1412 =item time - the "current time". Controls the printing of past due messages
1420 my($self, %opt) = @_;
1422 my $time = $opt{'time'} || time;
1423 my $cust_main = $self->cust_main;
1425 if ( $opt{'dest'} ) {
1426 my %invoicing_list = map { /^(POST|FAX)$/ or 'EMAIL' =~ /^(.*)$/; $1 => 1 }
1427 $cust_main->invoicing_list;
1428 return 'N/A' unless $invoicing_list{$opt{'dest'}}
1429 || ! keys %invoicing_list;
1432 if ( $opt{'balanceover'} ) {
1434 if $cust_main->total_owed_date($self->_date) < $opt{'balanceover'};
1437 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1438 mkdir $spooldir, 0700 unless -d $spooldir;
1440 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', $time);
1443 if ( $opt{'agent_spools'} ) {
1444 $file = 'agentnum'.$cust_main->agentnum;
1449 if ( $opt{'upload_targetnum'} ) {
1450 $spooldir .= '/target'.$opt{'upload_targetnum'};
1451 mkdir $spooldir, 0700 unless -d $spooldir;
1452 } # otherwise it just goes into export.xxx/cust_bill
1454 if ( lc($opt{'format'}) eq 'billco' ) {
1458 $file = "$spooldir/$file.csv";
1460 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum);
1462 open(CSV, ">>$file") or die "can't open $file: $!";
1463 flock(CSV, LOCK_EX);
1468 if ( lc($opt{'format'}) eq 'billco' ) {
1470 flock(CSV, LOCK_UN);
1473 $file =~ s/-header.csv$/-detail.csv/;
1475 open(CSV,">>$file") or die "can't open $file: $!";
1476 flock(CSV, LOCK_EX);
1480 print CSV $detail if defined($detail);
1482 flock(CSV, LOCK_UN);
1489 =item print_csv OPTION => VALUE, ...
1491 Returns CSV data for this invoice.
1495 format - 'default', 'billco', 'oneline', 'bridgestone'
1497 Returns a list consisting of two scalars. The first is a single line of CSV
1498 header information for this invoice. The second is one or more lines of CSV
1499 detail information for this invoice.
1501 If I<format> is not specified or "default", the fields of the CSV file are as
1504 record_type, invnum, custnum, _date, charged, first, last, company, address1,
1505 address2, city, state, zip, country, pkg, setup, recur, sdate, edate
1509 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
1511 B<record_type> is C<cust_bill> for the initial header line only. The
1512 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
1513 fields are filled in.
1515 B<record_type> is C<cust_bill_pkg> for detail lines. Only the first two fields
1516 (B<record_type> and B<invnum>) and the last five fields (B<pkg> through B<edate>)
1519 =item invnum - invoice number
1521 =item custnum - customer number
1523 =item _date - invoice date
1525 =item charged - total invoice amount
1527 =item first - customer first name
1529 =item last - customer first name
1531 =item company - company name
1533 =item address1 - address line 1
1535 =item address2 - address line 1
1545 =item pkg - line item description
1547 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
1549 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
1551 =item sdate - start date for recurring fee
1553 =item edate - end date for recurring fee
1557 If I<format> is "billco", the fields of the header CSV file are as follows:
1559 +-------------------------------------------------------------------+
1560 | FORMAT HEADER FILE |
1561 |-------------------------------------------------------------------|
1562 | Field | Description | Name | Type | Width |
1563 | 1 | N/A-Leave Empty | RC | CHAR | 2 |
1564 | 2 | N/A-Leave Empty | CUSTID | CHAR | 15 |
1565 | 3 | Transaction Account No | TRACCTNUM | CHAR | 15 |
1566 | 4 | Transaction Invoice No | TRINVOICE | CHAR | 15 |
1567 | 5 | Transaction Zip Code | TRZIP | CHAR | 5 |
1568 | 6 | Transaction Company Bill To | TRCOMPANY | CHAR | 30 |
1569 | 7 | Transaction Contact Bill To | TRNAME | CHAR | 30 |
1570 | 8 | Additional Address Unit Info | TRADDR1 | CHAR | 30 |
1571 | 9 | Bill To Street Address | TRADDR2 | CHAR | 30 |
1572 | 10 | Ancillary Billing Information | TRADDR3 | CHAR | 30 |
1573 | 11 | Transaction City Bill To | TRCITY | CHAR | 20 |
1574 | 12 | Transaction State Bill To | TRSTATE | CHAR | 2 |
1575 | 13 | Bill Cycle Close Date | CLOSEDATE | CHAR | 10 |
1576 | 14 | Bill Due Date | DUEDATE | CHAR | 10 |
1577 | 15 | Previous Balance | BALFWD | NUM* | 9 |
1578 | 16 | Pmt/CR Applied | CREDAPPLY | NUM* | 9 |
1579 | 17 | Total Current Charges | CURRENTCHG | NUM* | 9 |
1580 | 18 | Total Amt Due | TOTALDUE | NUM* | 9 |
1581 | 19 | Total Amt Due | AMTDUE | NUM* | 9 |
1582 | 20 | 30 Day Aging | AMT30 | NUM* | 9 |
1583 | 21 | 60 Day Aging | AMT60 | NUM* | 9 |
1584 | 22 | 90 Day Aging | AMT90 | NUM* | 9 |
1585 | 23 | Y/N | AGESWITCH | CHAR | 1 |
1586 | 24 | Remittance automation | SCANLINE | CHAR | 100 |
1587 | 25 | Total Taxes & Fees | TAXTOT | NUM* | 9 |
1588 | 26 | Customer Reference Number | CUSTREF | CHAR | 15 |
1589 | 27 | Federal Tax*** | FEDTAX | NUM* | 9 |
1590 | 28 | State Tax*** | STATETAX | NUM* | 9 |
1591 | 29 | Other Taxes & Fees*** | OTHERTAX | NUM* | 9 |
1592 +-------+-------------------------------+------------+------+-------+
1594 If I<format> is "billco", the fields of the detail CSV file are as follows:
1596 FORMAT FOR DETAIL FILE
1598 Field | Description | Name | Type | Width
1599 1 | N/A-Leave Empty | RC | CHAR | 2
1600 2 | N/A-Leave Empty | CUSTID | CHAR | 15
1601 3 | Account Number | TRACCTNUM | CHAR | 15
1602 4 | Invoice Number | TRINVOICE | CHAR | 15
1603 5 | Line Sequence (sort order) | LINESEQ | NUM | 6
1604 6 | Transaction Detail | DETAILS | CHAR | 100
1605 7 | Amount | AMT | NUM* | 9
1606 8 | Line Format Control** | LNCTRL | CHAR | 2
1607 9 | Grouping Code | GROUP | CHAR | 2
1608 10 | User Defined | ACCT CODE | CHAR | 15
1610 If format is 'oneline', there is no detail file. Each invoice has a
1611 header line only, with the fields:
1613 Agent number, agent name, customer number, first name, last name, address
1614 line 1, address line 2, city, state, zip, invoice date, invoice number,
1615 amount charged, amount due, previous balance, due date.
1617 and then, for each line item, three columns containing the package number,
1618 description, and amount.
1620 If format is 'bridgestone', there is no detail file. Each invoice has a
1621 header line with the following fields in a fixed-width format:
1623 Customer number (in display format), date, name (first last), company,
1624 address 1, address 2, city, state, zip.
1626 This is a mailing list format, and has no per-invoice fields. To avoid
1627 sending redundant notices, the spooling event should have a "once" or
1628 "once_percust_every" condition.
1633 my($self, %opt) = @_;
1635 eval "use Text::CSV_XS";
1638 my $cust_main = $self->cust_main;
1640 my $csv = Text::CSV_XS->new({'always_quote'=>1});
1641 my $format = lc($opt{'format'});
1643 my $time = $opt{'time'} || time;
1645 my $tracctnum = ''; #leaking out from billco-specific sections :/
1646 if ( $format eq 'billco' ) {
1649 $self->conf->config('billco-account_num', $cust_main->agentnum);
1651 $tracctnum = $account_num eq 'display_custnum'
1652 ? $cust_main->display_custnum
1653 : $opt{'tracctnum'};
1656 $taxtotal += $_->{'amount'} foreach $self->_items_tax;
1658 my $duedate = $self->due_date2str('%m/%d/%Y'); # hardcoded, NOT date_format
1660 my( $previous_balance, @unused ) = $self->previous; #previous balance
1662 my $pmt_cr_applied = 0;
1663 $pmt_cr_applied += $_->{'amount'}
1664 foreach ( $self->_items_payments(%opt), $self->_items_credits(%opt) ) ;
1666 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
1669 '', # 1 | N/A-Leave Empty CHAR 2
1670 '', # 2 | N/A-Leave Empty CHAR 15
1671 $tracctnum, # 3 | Transaction Account No CHAR 15
1672 $self->invnum, # 4 | Transaction Invoice No CHAR 15
1673 $cust_main->zip, # 5 | Transaction Zip Code CHAR 5
1674 $cust_main->company, # 6 | Transaction Company Bill To CHAR 30
1675 #$cust_main->payname, # 7 | Transaction Contact Bill To CHAR 30
1676 $cust_main->contact, # 7 | Transaction Contact Bill To CHAR 30
1677 $cust_main->address2, # 8 | Additional Address Unit Info CHAR 30
1678 $cust_main->address1, # 9 | Bill To Street Address CHAR 30
1679 '', # 10 | Ancillary Billing Information CHAR 30
1680 $cust_main->city, # 11 | Transaction City Bill To CHAR 20
1681 $cust_main->state, # 12 | Transaction State Bill To CHAR 2
1684 time2str("%m/%d/%Y", $self->_date), # 13 | Bill Cycle Close Date CHAR 10
1687 $duedate, # 14 | Bill Due Date CHAR 10
1689 $previous_balance, # 15 | Previous Balance NUM* 9
1690 $pmt_cr_applied, # 16 | Pmt/CR Applied NUM* 9
1691 sprintf("%.2f", $self->charged), # 17 | Total Current Charges NUM* 9
1692 $totaldue, # 18 | Total Amt Due NUM* 9
1693 $totaldue, # 19 | Total Amt Due NUM* 9
1694 '', # 20 | 30 Day Aging NUM* 9
1695 '', # 21 | 60 Day Aging NUM* 9
1696 '', # 22 | 90 Day Aging NUM* 9
1697 'N', # 23 | Y/N CHAR 1
1698 '', # 24 | Remittance automation CHAR 100
1699 $taxtotal, # 25 | Total Taxes & Fees NUM* 9
1700 $self->custnum, # 26 | Customer Reference Number CHAR 15
1701 '0', # 27 | Federal Tax*** NUM* 9
1702 sprintf("%.2f", $taxtotal), # 28 | State Tax*** NUM* 9
1703 '0', # 29 | Other Taxes & Fees*** NUM* 9
1706 } elsif ( $format eq 'oneline' ) { #name
1708 my ($previous_balance) = $self->previous;
1709 $previous_balance = sprintf('%.2f', $previous_balance);
1710 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
1716 $self->_items_pkg, #_items_nontax? no sections or anything
1721 $cust_main->agentnum,
1722 $cust_main->agent->agent,
1726 $cust_main->company,
1727 $cust_main->address1,
1728 $cust_main->address2,
1734 time2str("%x", $self->_date),
1739 $self->due_date2str("%x"),
1744 } elsif ( $format eq 'bridgestone' ) {
1746 # bypass the CSV stuff and just return this
1747 my $longdate = time2str('%B %d, %Y', $time); #current time, right?
1748 my $zip = $cust_main->zip;
1750 my $prefix = $self->conf->config('bridgestone-prefix', $cust_main->agentnum)
1754 "%-5s%-15s%-20s%-30s%-30s%-30s%-30s%-20s%-2s%-9s\n",
1756 $cust_main->display_custnum,
1758 uc(substr($cust_main->contact_firstlast,0,30)),
1759 uc(substr($cust_main->company ,0,30)),
1760 uc(substr($cust_main->address1 ,0,30)),
1761 uc(substr($cust_main->address2 ,0,30)),
1762 uc(substr($cust_main->city ,0,20)),
1763 uc($cust_main->state),
1769 } elsif ( $format eq 'ics' ) {
1771 my $bill = $cust_main->bill_location;
1772 my $zip = $bill->zip;
1776 if ( $zip =~ /^(\d{5})(\d{4})$/ ) {
1781 # minor false laziness with print_generic
1782 my ($previous_balance) = $self->previous;
1783 my $balance_due = $self->owed + $previous_balance;
1784 my $payment_total = sum(0, map { $_->{'amount'} } $self->_items_payments);
1785 my $credit_total = sum(0, map { $_->{'amount'} } $self->_items_credits);
1788 if ( $self->due_date and $time >= $self->due_date ) {
1789 $past_due = sprintf('Past due:$%0.2f Due Immediately', $balance_due);
1793 my $header = sprintf(
1794 '%-10s%-30s%-48s%-2s%-50s%-30s%-30s%-25s%-2s%-5s%-4s%-8s%-8s%-10s%-10s%-10s%-10s%-10s%-10s%-480s%-35s',
1795 $cust_main->display_custnum, #BID
1796 uc($cust_main->first), #FNAME
1797 uc($cust_main->last), #LNAME
1798 '00', #BATCH, should this ever be anything else?
1799 uc($cust_main->company), #COMP
1800 uc($bill->address1), #STREET1
1801 uc($bill->address2), #STREET2
1802 uc($bill->city), #CITY
1803 uc($bill->state), #STATE
1806 time2str('%Y%m%d', $self->_date), #BILL_DATE
1807 $self->due_date2str('%Y%m%d'), #DUE_DATE,
1808 ( map {sprintf('%0.2f', $_)}
1809 $balance_due, #AMNT_DUE
1810 $previous_balance, #PREV_BAL
1811 $payment_total, #PYMT_RCVD
1812 $credit_total, #CREDITS
1813 $previous_balance, #BEG_BAL--is this correct?
1814 $self->charged, #NEW_CHRG
1817 $past_due, #PAST_MSG
1821 my %svc_class = ('' => ''); # maybe cache this more persistently?
1823 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1825 my $show_pkgnum = $cust_bill_pkg->pkgnum || '';
1826 my $cust_pkg = $cust_bill_pkg->cust_pkg if $show_pkgnum;
1830 my @dates = ( $self->_date, undef );
1831 if ( my $prev = $cust_bill_pkg->previous_cust_bill_pkg ) {
1832 $dates[1] = $prev->sdate; #questionable
1835 # generate an 01 detail for each service
1836 my @svcs = $cust_pkg->h_cust_svc(@dates, 'I');
1837 foreach my $cust_svc ( @svcs ) {
1838 $show_pkgnum = ''; # hide it if we're showing svcnums
1840 my $svcpart = $cust_svc->svcpart;
1841 if (!exists($svc_class{$svcpart})) {
1842 my $classnum = $cust_svc->part_svc->classnum;
1843 my $part_svc_class = FS::part_svc_class->by_key($classnum)
1845 $svc_class{$svcpart} = $part_svc_class ?
1846 $part_svc_class->classname :
1850 my @h_label = $cust_svc->label(@dates, 'I');
1851 push @details, sprintf('01%-9s%-20s%-47s',
1853 $svc_class{$svcpart},
1856 } #foreach $cust_svc
1859 my $desc = $cust_bill_pkg->desc; # itemdesc or part_pkg.pkg
1860 if ($cust_bill_pkg->recur > 0) {
1861 $desc .= ' '.time2str('%d-%b-%Y', $cust_bill_pkg->sdate).' to '.
1862 time2str('%d-%b-%Y', $cust_bill_pkg->edate - 86400);
1864 push @details, sprintf('02%-6s%-60s%-10s',
1867 sprintf('%0.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
1869 } #foreach $cust_bill_pkg
1871 # Tag this row so that we know whether this is one page (1), two pages
1872 # (2), # or "big" (B). The tag will be stripped off before uploading.
1873 if ( scalar(@details) < 12 ) {
1875 } elsif ( scalar(@details) < 58 ) {
1881 return join('', $header, @details, "\n");
1889 time2str("%x", $self->_date),
1890 sprintf("%.2f", $self->charged),
1891 ( map { $cust_main->getfield($_) }
1892 qw( first last company address1 address2 city state zip country ) ),
1894 ) or die "can't create csv";
1897 my $header = $csv->string. "\n";
1900 if ( lc($opt{'format'}) eq 'billco' ) {
1903 foreach my $item ( $self->_items_pkg ) {
1906 '', # 1 | N/A-Leave Empty CHAR 2
1907 '', # 2 | N/A-Leave Empty CHAR 15
1908 $tracctnum, # 3 | Account Number CHAR 15
1909 $self->invnum, # 4 | Invoice Number CHAR 15
1910 $lineseq++, # 5 | Line Sequence (sort order) NUM 6
1911 $item->{'description'}, # 6 | Transaction Detail CHAR 100
1912 $item->{'amount'}, # 7 | Amount NUM* 9
1913 '', # 8 | Line Format Control** CHAR 2
1914 '', # 9 | Grouping Code CHAR 2
1915 '', # 10 | User Defined CHAR 15
1918 $detail .= $csv->string. "\n";
1922 } elsif ( lc($opt{'format'}) eq 'oneline' ) {
1928 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1930 my($pkg, $setup, $recur, $sdate, $edate);
1931 if ( $cust_bill_pkg->pkgnum ) {
1933 ($pkg, $setup, $recur, $sdate, $edate) = (
1934 $cust_bill_pkg->part_pkg->pkg,
1935 ( $cust_bill_pkg->setup != 0
1936 ? sprintf("%.2f", $cust_bill_pkg->setup )
1938 ( $cust_bill_pkg->recur != 0
1939 ? sprintf("%.2f", $cust_bill_pkg->recur )
1941 ( $cust_bill_pkg->sdate
1942 ? time2str("%x", $cust_bill_pkg->sdate)
1944 ($cust_bill_pkg->edate
1945 ? time2str("%x", $cust_bill_pkg->edate)
1949 } else { #pkgnum tax
1950 next unless $cust_bill_pkg->setup != 0;
1951 $pkg = $cust_bill_pkg->desc;
1952 $setup = sprintf('%10.2f', $cust_bill_pkg->setup );
1953 ( $sdate, $edate ) = ( '', '' );
1959 ( map { '' } (1..11) ),
1960 ($pkg, $setup, $recur, $sdate, $edate)
1961 ) or die "can't create csv";
1963 $detail .= $csv->string. "\n";
1969 ( $header, $detail );
1975 Pays this invoice with a compliemntary payment. If there is an error,
1976 returns the error, otherwise returns false.
1982 my $cust_pay = new FS::cust_pay ( {
1983 'invnum' => $self->invnum,
1984 'paid' => $self->owed,
1987 'payinfo' => $self->cust_main->payinfo,
1995 Attempts to pay this invoice with a credit card payment via a
1996 Business::OnlinePayment realtime gateway. See
1997 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1998 for supported processors.
2004 $self->realtime_bop( 'CC', @_ );
2009 Attempts to pay this invoice with an electronic check (ACH) payment via a
2010 Business::OnlinePayment realtime gateway. See
2011 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2012 for supported processors.
2018 $self->realtime_bop( 'ECHECK', @_ );
2023 Attempts to pay this invoice with phone bill (LEC) payment via a
2024 Business::OnlinePayment realtime gateway. See
2025 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2026 for supported processors.
2032 $self->realtime_bop( 'LEC', @_ );
2036 my( $self, $method ) = (shift,shift);
2037 my $conf = $self->conf;
2040 my $cust_main = $self->cust_main;
2041 my $balance = $cust_main->balance;
2042 my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
2043 $amount = sprintf("%.2f", $amount);
2044 return "not run (balance $balance)" unless $amount > 0;
2046 my $description = 'Internet Services';
2047 if ( $conf->exists('business-onlinepayment-description') ) {
2048 my $dtempl = $conf->config('business-onlinepayment-description');
2050 my $agent_obj = $cust_main->agent
2051 or die "can't retreive agent for $cust_main (agentnum ".
2052 $cust_main->agentnum. ")";
2053 my $agent = $agent_obj->agent;
2054 my $pkgs = join(', ',
2055 map { $_->part_pkg->pkg }
2056 grep { $_->pkgnum } $self->cust_bill_pkg
2058 $description = eval qq("$dtempl");
2061 $cust_main->realtime_bop($method, $amount,
2062 'description' => $description,
2063 'invnum' => $self->invnum,
2064 #this didn't do what we want, it just calls apply_payments_and_credits
2066 'apply_to_invoice' => 1,
2069 #this changes application behavior: auto payments
2070 #triggered against a specific invoice are now applied
2071 #to that invoice instead of oldest open.
2077 =item batch_card OPTION => VALUE...
2079 Adds a payment for this invoice to the pending credit card batch (see
2080 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2081 runs the payment using a realtime gateway.
2086 my ($self, %options) = @_;
2087 my $cust_main = $self->cust_main;
2089 $options{invnum} = $self->invnum;
2091 $cust_main->batch_card(%options);
2094 sub _agent_template {
2096 $self->cust_main->agent_template;
2099 sub _agent_invoice_from {
2101 $self->cust_main->agent_invoice_from;
2104 =item invoice_barcode DIR_OR_FALSE
2106 Generates an invoice barcode PNG. If DIR_OR_FALSE is a true value,
2107 it is taken as the temp directory where the PNG file will be generated and the
2108 PNG file name is returned. Otherwise, the PNG image itself is returned.
2112 sub invoice_barcode {
2113 my ($self, $dir) = (shift,shift);
2115 my $gdbar = new GD::Barcode('Code39',$self->invnum);
2116 die "can't create barcode: " . $GD::Barcode::errStr unless $gdbar;
2117 my $gd = $gdbar->plot(Height => 30);
2120 my $bh = new File::Temp( TEMPLATE => 'barcode.'. $self->invnum. '.XXXXXXXX',
2124 ) or die "can't open temp file: $!\n";
2125 print $bh $gd->png or die "cannot write barcode to file: $!\n";
2126 my $png_file = $bh->filename;
2133 =item invnum_date_pretty
2135 Returns a string with the invoice number and date, for example:
2136 "Invoice #54 (3/20/2008)".
2138 Intended for back-end context, with regard to translation and date formatting.
2142 #note: this uses _date_pretty_unlocalized because _date_pretty is too expensive
2143 # for backend use (and also does the wrong thing, localizing for end customer
2144 # instead of backoffice configured date format)
2145 sub invnum_date_pretty {
2147 #$self->mt('Invoice #').
2148 'Invoice #'. #XXX should be translated ala web UI user (not invoice customer)
2149 $self->invnum. ' ('. $self->_date_pretty_unlocalized. ')';
2152 #sub _items_extra_usage_sections {
2154 # my $escape = shift;
2156 # my %sections = ();
2158 # my %usage_class = map{ $_->classname, $_ } qsearch('usage_class', {});
2159 # foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2161 # next unless $cust_bill_pkg->pkgnum > 0;
2163 # foreach my $section ( keys %usage_class ) {
2165 # my $usage = $cust_bill_pkg->usage($section);
2167 # next unless $usage && $usage > 0;
2169 # $sections{$section} ||= 0;
2170 # $sections{$section} += $usage;
2176 # map { { 'description' => &{$escape}($_),
2177 # 'subtotal' => $sections{$_},
2178 # 'summarized' => '',
2179 # 'tax_section' => '',
2182 # sort {$usage_class{$a}->weight <=> $usage_class{$b}->weight} keys %sections;
2186 sub _items_extra_usage_sections {
2188 my $conf = $self->conf;
2196 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
2198 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
2199 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2200 next unless $cust_bill_pkg->pkgnum > 0;
2202 foreach my $classnum ( keys %usage_class ) {
2203 my $section = $usage_class{$classnum}->classname;
2204 $classnums{$section} = $classnum;
2206 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail($classnum) ) {
2207 my $amount = $detail->amount;
2208 next unless $amount && $amount > 0;
2210 $sections{$section} ||= { 'subtotal'=>0, 'calls'=>0, 'duration'=>0 };
2211 $sections{$section}{amount} += $amount; #subtotal
2212 $sections{$section}{calls}++;
2213 $sections{$section}{duration} += $detail->duration;
2215 my $desc = $detail->regionname;
2216 my $description = $desc;
2217 $description = substr($desc, 0, $maxlength). '...'
2218 if $format eq 'latex' && length($desc) > $maxlength;
2220 $lines{$section}{$desc} ||= {
2221 description => &{$escape}($description),
2222 #pkgpart => $part_pkg->pkgpart,
2223 pkgnum => $cust_bill_pkg->pkgnum,
2228 #unit_amount => $cust_bill_pkg->unitrecur,
2229 quantity => $cust_bill_pkg->quantity,
2230 product_code => 'N/A',
2231 ext_description => [],
2234 $lines{$section}{$desc}{amount} += $amount;
2235 $lines{$section}{$desc}{calls}++;
2236 $lines{$section}{$desc}{duration} += $detail->duration;
2242 my %sectionmap = ();
2243 foreach (keys %sections) {
2244 my $usage_class = $usage_class{$classnums{$_}};
2245 $sectionmap{$_} = { 'description' => &{$escape}($_),
2246 'amount' => $sections{$_}{amount}, #subtotal
2247 'calls' => $sections{$_}{calls},
2248 'duration' => $sections{$_}{duration},
2250 'tax_section' => '',
2251 'sort_weight' => $usage_class->weight,
2252 ( $usage_class->format
2253 ? ( map { $_ => $usage_class->$_($format) }
2254 qw( description_generator header_generator total_generator total_line_generator )
2261 my @sections = sort { $a->{sort_weight} <=> $b->{sort_weight} }
2265 foreach my $section ( keys %lines ) {
2266 foreach my $line ( keys %{$lines{$section}} ) {
2267 my $l = $lines{$section}{$line};
2268 $l->{section} = $sectionmap{$section};
2269 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2270 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
2275 return(\@sections, \@lines);
2281 my $end = $self->_date;
2283 # start at date of previous invoice + 1 second or 0 if no previous invoice
2284 my $start = $self->scalar_sql("SELECT max(_date) FROM cust_bill WHERE custnum = ? and invnum != ?",$self->custnum,$self->invnum);
2285 $start = 0 if !$start;
2288 my $cust_main = $self->cust_main;
2289 my @pkgs = $cust_main->all_pkgs;
2290 my($num_activated,$num_deactivated,$num_portedin,$num_portedout,$minutes)
2293 foreach my $pkg ( @pkgs ) {
2294 my @h_cust_svc = $pkg->h_cust_svc($end);
2295 foreach my $h_cust_svc ( @h_cust_svc ) {
2296 next if grep {$_ eq $h_cust_svc->svcnum} @seen;
2297 next unless $h_cust_svc->part_svc->svcdb eq 'svc_phone';
2299 my $inserted = $h_cust_svc->date_inserted;
2300 my $deleted = $h_cust_svc->date_deleted;
2301 my $phone_inserted = $h_cust_svc->h_svc_x($inserted+5);
2303 $phone_deleted = $h_cust_svc->h_svc_x($deleted) if $deleted;
2305 # DID either activated or ported in; cannot be both for same DID simultaneously
2306 if ($inserted >= $start && $inserted <= $end && $phone_inserted
2307 && (!$phone_inserted->lnp_status
2308 || $phone_inserted->lnp_status eq ''
2309 || $phone_inserted->lnp_status eq 'native')) {
2312 else { # this one not so clean, should probably move to (h_)svc_phone
2313 local($FS::Record::qsearch_qualify_columns) = 0;
2314 my $phone_portedin = qsearchs( 'h_svc_phone',
2315 { 'svcnum' => $h_cust_svc->svcnum,
2316 'lnp_status' => 'portedin' },
2317 FS::h_svc_phone->sql_h_searchs($end),
2319 $num_portedin++ if $phone_portedin;
2322 # DID either deactivated or ported out; cannot be both for same DID simultaneously
2323 if($deleted >= $start && $deleted <= $end && $phone_deleted
2324 && (!$phone_deleted->lnp_status
2325 || $phone_deleted->lnp_status ne 'portingout')) {
2328 elsif($deleted >= $start && $deleted <= $end && $phone_deleted
2329 && $phone_deleted->lnp_status
2330 && $phone_deleted->lnp_status eq 'portingout') {
2334 # increment usage minutes
2335 if ( $phone_inserted ) {
2336 my @cdrs = $phone_inserted->get_cdrs('begin'=>$start,'end'=>$end,'billsec_sum'=>1);
2337 $minutes = $cdrs[0]->billsec_sum if scalar(@cdrs) == 1;
2340 warn "WARNING: no matching h_svc_phone insert record for insert time $inserted, svcnum " . $h_cust_svc->svcnum;
2343 # don't look at this service again
2344 push @seen, $h_cust_svc->svcnum;
2348 $minutes = sprintf("%d", $minutes);
2349 ("Activated: $num_activated Ported-In: $num_portedin Deactivated: "
2350 . "$num_deactivated Ported-Out: $num_portedout ",
2351 "Total Minutes: $minutes");
2354 sub _items_accountcode_cdr {
2359 my $section = { 'amount' => 0,
2362 'sort_weight' => '',
2364 'description' => 'Usage by Account Code',
2370 my %accountcodes = ();
2372 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2373 next unless $cust_bill_pkg->pkgnum > 0;
2375 my @header = $cust_bill_pkg->details_header;
2376 next unless scalar(@header);
2377 $section->{'header'} = join(',',@header);
2379 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
2381 $section->{'header'} = $detail->formatted('format' => $format)
2382 if($detail->detail eq $section->{'header'});
2384 my $accountcode = $detail->accountcode;
2385 next unless $accountcode;
2387 my $amount = $detail->amount;
2388 next unless $amount && $amount > 0;
2390 $accountcodes{$accountcode} ||= {
2391 description => $accountcode,
2398 product_code => 'N/A',
2399 section => $section,
2400 ext_description => [ $section->{'header'} ],
2404 $section->{'amount'} += $amount;
2405 $accountcodes{$accountcode}{'amount'} += $amount;
2406 $accountcodes{$accountcode}{calls}++;
2407 $accountcodes{$accountcode}{duration} += $detail->duration;
2408 push @{$accountcodes{$accountcode}{detail_temp}}, $detail;
2412 foreach my $l ( values %accountcodes ) {
2413 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2414 my @sorted_detail = sort { $a->startdate <=> $b->startdate } @{$l->{detail_temp}};
2415 foreach my $sorted_detail ( @sorted_detail ) {
2416 push @{$l->{ext_description}}, $sorted_detail->formatted('format'=>$format);
2418 delete $l->{detail_temp};
2422 my @sorted_lines = sort { $a->{'description'} <=> $b->{'description'} } @lines;
2424 return ($section,\@sorted_lines);
2427 sub _items_svc_phone_sections {
2429 my $conf = $self->conf;
2437 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
2439 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
2440 $usage_class{''} ||= new FS::usage_class { 'classname' => '', 'weight' => 0 };
2442 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2443 next unless $cust_bill_pkg->pkgnum > 0;
2445 my @header = $cust_bill_pkg->details_header;
2446 next unless scalar(@header);
2448 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
2450 my $phonenum = $detail->phonenum;
2451 next unless $phonenum;
2453 my $amount = $detail->amount;
2454 next unless $amount && $amount > 0;
2456 $sections{$phonenum} ||= { 'amount' => 0,
2459 'sort_weight' => -1,
2460 'phonenum' => $phonenum,
2462 $sections{$phonenum}{amount} += $amount; #subtotal
2463 $sections{$phonenum}{calls}++;
2464 $sections{$phonenum}{duration} += $detail->duration;
2466 my $desc = $detail->regionname;
2467 my $description = $desc;
2468 $description = substr($desc, 0, $maxlength). '...'
2469 if $format eq 'latex' && length($desc) > $maxlength;
2471 $lines{$phonenum}{$desc} ||= {
2472 description => &{$escape}($description),
2473 #pkgpart => $part_pkg->pkgpart,
2481 product_code => 'N/A',
2482 ext_description => [],
2485 $lines{$phonenum}{$desc}{amount} += $amount;
2486 $lines{$phonenum}{$desc}{calls}++;
2487 $lines{$phonenum}{$desc}{duration} += $detail->duration;
2489 my $line = $usage_class{$detail->classnum}->classname;
2490 $sections{"$phonenum $line"} ||=
2494 'sort_weight' => $usage_class{$detail->classnum}->weight,
2495 'phonenum' => $phonenum,
2496 'header' => [ @header ],
2498 $sections{"$phonenum $line"}{amount} += $amount; #subtotal
2499 $sections{"$phonenum $line"}{calls}++;
2500 $sections{"$phonenum $line"}{duration} += $detail->duration;
2502 $lines{"$phonenum $line"}{$desc} ||= {
2503 description => &{$escape}($description),
2504 #pkgpart => $part_pkg->pkgpart,
2512 product_code => 'N/A',
2513 ext_description => [],
2516 $lines{"$phonenum $line"}{$desc}{amount} += $amount;
2517 $lines{"$phonenum $line"}{$desc}{calls}++;
2518 $lines{"$phonenum $line"}{$desc}{duration} += $detail->duration;
2519 push @{$lines{"$phonenum $line"}{$desc}{ext_description}},
2520 $detail->formatted('format' => $format);
2525 my %sectionmap = ();
2526 my $simple = new FS::usage_class { format => 'simple' }; #bleh
2527 foreach ( keys %sections ) {
2528 my @header = @{ $sections{$_}{header} || [] };
2530 new FS::usage_class { format => 'usage_'. (scalar(@header) || 6). 'col' };
2531 my $summary = $sections{$_}{sort_weight} < 0 ? 1 : 0;
2532 my $usage_class = $summary ? $simple : $usage_simple;
2533 my $ending = $summary ? ' usage charges' : '';
2536 $gen_opt{label} = [ map{ &{$escape}($_) } @header ];
2538 $sectionmap{$_} = { 'description' => &{$escape}($_. $ending),
2539 'amount' => $sections{$_}{amount}, #subtotal
2540 'calls' => $sections{$_}{calls},
2541 'duration' => $sections{$_}{duration},
2543 'tax_section' => '',
2544 'phonenum' => $sections{$_}{phonenum},
2545 'sort_weight' => $sections{$_}{sort_weight},
2546 'post_total' => $summary, #inspire pagebreak
2548 ( map { $_ => $usage_class->$_($format, %gen_opt) }
2549 qw( description_generator
2552 total_line_generator
2559 my @sections = sort { $a->{phonenum} cmp $b->{phonenum} ||
2560 $a->{sort_weight} <=> $b->{sort_weight}
2565 foreach my $section ( keys %lines ) {
2566 foreach my $line ( keys %{$lines{$section}} ) {
2567 my $l = $lines{$section}{$line};
2568 $l->{section} = $sectionmap{$section};
2569 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2570 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
2575 if($conf->exists('phone_usage_class_summary')) {
2576 # this only works with Latex
2580 # after this, we'll have only two sections per DID:
2581 # Calls Summary and Calls Detail
2582 foreach my $section ( @sections ) {
2583 if($section->{'post_total'}) {
2584 $section->{'description'} = 'Calls Summary: '.$section->{'phonenum'};
2585 $section->{'total_line_generator'} = sub { '' };
2586 $section->{'total_generator'} = sub { '' };
2587 $section->{'header_generator'} = sub { '' };
2588 $section->{'description_generator'} = '';
2589 push @newsections, $section;
2590 my %calls_detail = %$section;
2591 $calls_detail{'post_total'} = '';
2592 $calls_detail{'sort_weight'} = '';
2593 $calls_detail{'description_generator'} = sub { '' };
2594 $calls_detail{'header_generator'} = sub {
2595 return ' & Date/Time & Called Number & Duration & Price'
2596 if $format eq 'latex';
2599 $calls_detail{'description'} = 'Calls Detail: '
2600 . $section->{'phonenum'};
2601 push @newsections, \%calls_detail;
2605 # after this, each usage class is collapsed/summarized into a single
2606 # line under the Calls Summary section
2607 foreach my $newsection ( @newsections ) {
2608 if($newsection->{'post_total'}) { # this means Calls Summary
2609 foreach my $section ( @sections ) {
2610 next unless ($section->{'phonenum'} eq $newsection->{'phonenum'}
2611 && !$section->{'post_total'});
2612 my $newdesc = $section->{'description'};
2613 my $tn = $section->{'phonenum'};
2614 $newdesc =~ s/$tn//g;
2615 my $line = { ext_description => [],
2619 calls => $section->{'calls'},
2620 section => $newsection,
2621 duration => $section->{'duration'},
2622 description => $newdesc,
2623 amount => sprintf("%.2f",$section->{'amount'}),
2624 product_code => 'N/A',
2626 push @newlines, $line;
2631 # after this, Calls Details is populated with all CDRs
2632 foreach my $newsection ( @newsections ) {
2633 if(!$newsection->{'post_total'}) { # this means Calls Details
2634 foreach my $line ( @lines ) {
2635 next unless (scalar(@{$line->{'ext_description'}}) &&
2636 $line->{'section'}->{'phonenum'} eq $newsection->{'phonenum'}
2638 my @extdesc = @{$line->{'ext_description'}};
2640 foreach my $extdesc ( @extdesc ) {
2641 $extdesc =~ s/scriptsize/normalsize/g if $format eq 'latex';
2642 push @newextdesc, $extdesc;
2644 $line->{'ext_description'} = \@newextdesc;
2645 $line->{'section'} = $newsection;
2646 push @newlines, $line;
2651 return(\@newsections, \@newlines);
2654 return(\@sections, \@lines);
2658 =sub _items_usage_class_summary OPTIONS
2660 Returns a list of detail items summarizing the usage charges on this
2661 invoice. Each one will have 'amount', 'description' (the usage charge name),
2662 and 'usage_classnum'.
2664 OPTIONS can include 'escape' (a function to escape the descriptions).
2668 sub _items_usage_class_summary {
2672 my $escape = $opt{escape} || sub { $_[0] };
2673 my $invnum = $self->invnum;
2674 my @classes = qsearch({
2675 'table' => 'usage_class',
2676 'select' => 'classnum, classname, SUM(amount) AS amount',
2677 'addl_from' => ' LEFT JOIN cust_bill_pkg_detail USING (classnum)' .
2678 ' LEFT JOIN cust_bill_pkg USING (billpkgnum)',
2679 'extra_sql' => " WHERE cust_bill_pkg.invnum = $invnum".
2680 ' GROUP BY classnum, classname, weight'.
2681 ' HAVING (usage_class.disabled IS NULL OR SUM(amount) > 0)'.
2682 ' ORDER BY weight ASC',
2686 description => &{$escape}($self->mt('Usage Summary')),
2690 foreach my $class (@classes) {
2692 'description' => &{$escape}($class->classname),
2693 'amount' => sprintf('%.2f', $class->amount),
2694 'usage_classnum' => $class->classnum,
2695 'section' => $section,
2701 sub _items_previous {
2703 my $conf = $self->conf;
2704 my $cust_main = $self->cust_main;
2705 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2707 foreach ( @pr_cust_bill ) {
2708 my $date = $conf->exists('invoice_show_prior_due_date')
2709 ? 'due '. $_->due_date2str('short')
2710 : $self->time2str_local('short', $_->_date);
2712 'description' => $self->mt('Previous Balance, Invoice #'). $_->invnum. " ($date)",
2713 #'pkgpart' => 'N/A',
2715 'amount' => sprintf("%.2f", $_->owed),
2721 # 'description' => 'Previous Balance',
2722 # #'pkgpart' => 'N/A',
2723 # 'pkgnum' => 'N/A',
2724 # 'amount' => sprintf("%10.2f", $pr_total ),
2725 # 'ext_description' => [ map {
2726 # "Invoice ". $_->invnum.
2727 # " (". time2str("%x",$_->_date). ") ".
2728 # sprintf("%10.2f", $_->owed)
2729 # } @pr_cust_bill ],
2734 sub _items_credits {
2735 my( $self, %opt ) = @_;
2736 my $trim_len = $opt{'trim_len'} || 60;
2741 if ( $self->conf->exists('previous_balance-payments_since') ) {
2742 if ( $opt{'template'} eq 'statement' ) {
2743 # then the current bill is a "statement" (i.e. an invoice sent as
2744 # a payment receipt)
2745 # and in that case we want to see payments on or after THIS invoice
2746 @objects = qsearch('cust_credit', {
2747 'custnum' => $self->custnum,
2748 '_date' => {op => '>=', value => $self->_date},
2752 $date = $self->previous_bill->_date if $self->previous_bill;
2753 @objects = qsearch('cust_credit', {
2754 'custnum' => $self->custnum,
2755 '_date' => {op => '>=', value => $date},
2759 @objects = $self->cust_credited;
2762 foreach my $obj ( @objects ) {
2763 my $cust_credit = $obj->isa('FS::cust_credit') ? $obj : $obj->cust_credit;
2765 my $reason = substr($cust_credit->reason, 0, $trim_len);
2766 $reason .= '...' if length($reason) < length($cust_credit->reason);
2767 $reason = " ($reason) " if $reason;
2770 #'description' => 'Credit ref\#'. $_->crednum.
2771 # " (". time2str("%x",$_->cust_credit->_date) .")".
2773 'description' => $self->mt('Credit applied').' '.
2774 $self->time2str_local('short', $obj->_date). $reason,
2775 'amount' => sprintf("%.2f",$obj->amount),
2783 sub _items_payments {
2788 my $detailed = $self->conf->exists('invoice_payment_details');
2790 if ( $self->conf->exists('previous_balance-payments_since') ) {
2791 # then show payments dated on/after the previous bill...
2792 if ( $opt{'template'} eq 'statement' ) {
2793 # then the current bill is a "statement" (i.e. an invoice sent as
2794 # a payment receipt)
2795 # and in that case we want to see payments on or after THIS invoice
2796 @objects = qsearch('cust_pay', {
2797 'custnum' => $self->custnum,
2798 '_date' => {op => '>=', value => $self->_date},
2801 # the normal case: payments on or after the previous invoice
2803 $date = $self->previous_bill->_date if $self->previous_bill;
2804 @objects = qsearch('cust_pay', {
2805 'custnum' => $self->custnum,
2806 '_date' => {op => '>=', value => $date},
2808 # and before the current bill...
2809 @objects = grep { $_->_date < $self->_date } @objects;
2812 @objects = $self->cust_bill_pay;
2815 foreach my $obj (@objects) {
2816 my $cust_pay = $obj->isa('FS::cust_pay') ? $obj : $obj->cust_pay;
2817 my $desc = $self->mt('Payment received').' '.
2818 $self->time2str_local('short', $cust_pay->_date );
2819 $desc .= $self->mt(' via ') .
2820 $cust_pay->payby_payinfo_pretty( $self->cust_main->locale )
2824 'description' => $desc,
2825 'amount' => sprintf("%.2f", $obj->amount )
2833 =item call_details [ OPTION => VALUE ... ]
2835 Returns an array of CSV strings representing the call details for this invoice
2836 The only option available is the boolean prepend_billed_number
2841 my ($self, %opt) = @_;
2843 my $format_function = sub { shift };
2845 if ($opt{prepend_billed_number}) {
2846 $format_function = sub {
2850 $row->amount ? $row->phonenum. ",". $detail : '"Billed number",'. $detail;
2855 my @details = map { $_->details( 'format_function' => $format_function,
2856 'escape_function' => sub{ return() },
2860 $self->cust_bill_pkg;
2861 my $header = $details[0];
2862 ( $header, grep { $_ ne $header } @details );
2872 =item process_reprint
2876 sub process_reprint {
2877 process_re_X('print', @_);
2880 =item process_reemail
2884 sub process_reemail {
2885 process_re_X('email', @_);
2893 process_re_X('fax', @_);
2901 process_re_X('ftp', @_);
2908 sub process_respool {
2909 process_re_X('spool', @_);
2914 my( $method, $job ) = ( shift, shift );
2915 warn "$me process_re_X $method for job $job\n" if $DEBUG;
2918 warn Dumper($param) if $DEBUG;
2929 # spool_invoice ftp_invoice fax_invoice print_invoice
2930 my($method, $job, %param ) = @_;
2932 warn "re_X $method for job $job with param:\n".
2933 join( '', map { " $_ => ". $param{$_}. "\n" } keys %param );
2936 #some false laziness w/search/cust_bill.html
2938 my $orderby = 'ORDER BY cust_bill._date';
2940 my $extra_sql = ' WHERE '. FS::cust_bill->search_sql_where(\%param);
2942 my $addl_from = 'LEFT JOIN cust_main USING ( custnum )';
2944 my @cust_bill = qsearch( {
2945 #'select' => "cust_bill.*",
2946 'table' => 'cust_bill',
2947 'addl_from' => $addl_from,
2949 'extra_sql' => $extra_sql,
2950 'order_by' => $orderby,
2954 $method .= '_invoice' unless $method eq 'email' || $method eq 'print';
2956 warn " $me re_X $method: ". scalar(@cust_bill). " invoices found\n"
2959 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
2960 foreach my $cust_bill ( @cust_bill ) {
2961 $cust_bill->$method();
2963 if ( $job ) { #progressbar foo
2965 if ( time - $min_sec > $last ) {
2966 my $error = $job->update_statustext(
2967 int( 100 * $num / scalar(@cust_bill) )
2969 die $error if $error;
2980 +{ ( map { $_=>$self->$_ } $self->fields ),
2981 'owed' => $self->owed,
2982 #XXX last payment applied date
2988 =head1 CLASS METHODS
2994 Returns an SQL fragment to retreive the amount owed (charged minus credited and paid).
2999 my ($class, $start, $end) = @_;
3001 $class->paid_sql($start, $end). ' - '.
3002 $class->credited_sql($start, $end);
3007 Returns an SQL fragment to retreive the net amount (charged minus credited).
3012 my ($class, $start, $end) = @_;
3013 'charged - '. $class->credited_sql($start, $end);
3018 Returns an SQL fragment to retreive the amount paid against this invoice.
3023 my ($class, $start, $end) = @_;
3024 $start &&= "AND cust_bill_pay._date <= $start";
3025 $end &&= "AND cust_bill_pay._date > $end";
3026 $start = '' unless defined($start);
3027 $end = '' unless defined($end);
3028 "( SELECT COALESCE(SUM(amount),0) FROM cust_bill_pay
3029 WHERE cust_bill.invnum = cust_bill_pay.invnum $start $end )";
3034 Returns an SQL fragment to retreive the amount credited against this invoice.
3039 my ($class, $start, $end) = @_;
3040 $start &&= "AND cust_credit_bill._date <= $start";
3041 $end &&= "AND cust_credit_bill._date > $end";
3042 $start = '' unless defined($start);
3043 $end = '' unless defined($end);
3044 "( SELECT COALESCE(SUM(amount),0) FROM cust_credit_bill
3045 WHERE cust_bill.invnum = cust_credit_bill.invnum $start $end )";
3050 Returns an SQL fragment to retrieve the due date of an invoice.
3051 Currently only supported on PostgreSQL.
3056 die "don't use: doesn't account for agent-specific invoice_default_terms";
3058 #we're passed a $conf but not a specific customer (that's in the query), so
3059 # to make this work we'd need an agentnum-aware "condition_sql_conf" like
3060 # "condition_sql_option" that retreives a conf value with SQL in an agent-
3063 my $conf = new FS::Conf;
3067 cust_bill.invoice_terms,
3068 cust_main.invoice_terms,
3069 \''.($conf->config('invoice_default_terms') || '').'\'
3070 ), E\'Net (\\\\d+)\'
3072 ) * 86400 + cust_bill._date'
3083 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
3084 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base