2 use base qw( FS::Template_Mixin FS::cust_main_Mixin FS::Record );
5 use vars qw( $DEBUG $me $date_format );
7 use Fcntl qw(:flock); #for spool_csv
9 use List::Util qw(min max sum);
13 use Storable qw( freeze thaw );
15 use FS::UID qw( datasrc );
16 use FS::Misc qw( send_email send_fax do_print );
17 use FS::Record qw( qsearch qsearchs dbh );
19 use FS::cust_statement;
20 use FS::cust_bill_pkg;
21 use FS::cust_bill_pkg_display;
22 use FS::cust_bill_pkg_detail;
26 use FS::cust_credit_bill;
28 use FS::cust_pay_batch;
29 use FS::cust_bill_event;
32 use FS::cust_bill_pay;
33 use FS::cust_bill_pay_batch;
34 use FS::part_bill_event;
37 use FS::cust_bill_batch;
38 use FS::cust_bill_pay_pkg;
39 use FS::cust_credit_bill_pkg;
40 use FS::discount_plan;
41 use FS::cust_bill_void;
45 $me = '[FS::cust_bill]';
47 #ask FS::UID to run this stuff for us later
48 FS::UID->install_callback( sub {
49 my $conf = new FS::Conf; #global
50 $date_format = $conf->config('date_format') || '%x'; #/YY
55 FS::cust_bill - Object methods for cust_bill records
61 $record = new FS::cust_bill \%hash;
62 $record = new FS::cust_bill { 'column' => 'value' };
64 $error = $record->insert;
66 $error = $new_record->replace($old_record);
68 $error = $record->delete;
70 $error = $record->check;
72 ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
74 @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
76 ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
78 @cust_pay_objects = $cust_bill->cust_pay;
80 $tax_amount = $record->tax;
82 @lines = $cust_bill->print_text;
83 @lines = $cust_bill->print_text $time;
87 An FS::cust_bill object represents an invoice; a declaration that a customer
88 owes you money. The specific charges are itemized as B<cust_bill_pkg> records
89 (see L<FS::cust_bill_pkg>). FS::cust_bill inherits from FS::Record. The
90 following fields are currently supported:
96 =item invnum - primary key (assigned automatically for new invoices)
98 =item custnum - customer (see L<FS::cust_main>)
100 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
101 L<Time::Local> and L<Date::Parse> for conversion functions.
103 =item charged - amount of this invoice
105 =item invoice_terms - optional terms override for this specific invoice
109 Customer info at invoice generation time
113 =item billing_balance - the customer's balance at the time the invoice was
114 generated (not including charges on this invoice)
116 =item previous_balance - the billing_balance of this customer's previous
117 invoice plus the charges on that invoice
125 =item printed - deprecated
133 =item closed - books closed flag, empty or `Y'
135 =item statementnum - invoice aggregation (see L<FS::cust_statement>)
137 =item agent_invid - legacy invoice number
139 =item promised_date - customer promised payment date, for collection
149 Creates a new invoice. To add the invoice to the database, see L<"insert">.
150 Invoices are normally created by calling the bill method of a customer object
151 (see L<FS::cust_main>).
155 sub table { 'cust_bill'; }
156 sub notice_name { 'Invoice'; }
158 sub cust_linked { $_[0]->cust_main_custnum; }
159 sub cust_unlinked_msg {
161 "WARNING: can't find cust_main.custnum ". $self->custnum.
162 ' (cust_bill.invnum '. $self->invnum. ')';
167 Adds this invoice to the database ("Posts" the invoice). If there is an error,
168 returns the error, otherwise returns false.
174 warn "$me insert called\n" if $DEBUG;
176 local $SIG{HUP} = 'IGNORE';
177 local $SIG{INT} = 'IGNORE';
178 local $SIG{QUIT} = 'IGNORE';
179 local $SIG{TERM} = 'IGNORE';
180 local $SIG{TSTP} = 'IGNORE';
181 local $SIG{PIPE} = 'IGNORE';
183 my $oldAutoCommit = $FS::UID::AutoCommit;
184 local $FS::UID::AutoCommit = 0;
187 my $error = $self->SUPER::insert;
189 $dbh->rollback if $oldAutoCommit;
193 if ( $self->get('cust_bill_pkg') ) {
194 foreach my $cust_bill_pkg ( @{$self->get('cust_bill_pkg')} ) {
195 $cust_bill_pkg->invnum($self->invnum);
196 my $error = $cust_bill_pkg->insert;
198 $dbh->rollback if $oldAutoCommit;
199 return "can't create invoice line item: $error";
204 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
211 Voids this invoice: deletes the invoice and adds a record of the voided invoice
212 to the FS::cust_bill_void table (and related tables starting from
213 FS::cust_bill_pkg_void).
219 my $reason = scalar(@_) ? shift : '';
221 local $SIG{HUP} = 'IGNORE';
222 local $SIG{INT} = 'IGNORE';
223 local $SIG{QUIT} = 'IGNORE';
224 local $SIG{TERM} = 'IGNORE';
225 local $SIG{TSTP} = 'IGNORE';
226 local $SIG{PIPE} = 'IGNORE';
228 my $oldAutoCommit = $FS::UID::AutoCommit;
229 local $FS::UID::AutoCommit = 0;
232 my $cust_bill_void = new FS::cust_bill_void ( {
233 map { $_ => $self->get($_) } $self->fields
235 $cust_bill_void->reason($reason);
236 my $error = $cust_bill_void->insert;
238 $dbh->rollback if $oldAutoCommit;
242 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
243 my $error = $cust_bill_pkg->void($reason);
245 $dbh->rollback if $oldAutoCommit;
250 $error = $self->delete;
252 $dbh->rollback if $oldAutoCommit;
256 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
264 This method now works but you probably shouldn't use it. Instead, apply a
265 credit against the invoice, or use the new void method.
267 Using this method to delete invoices outright is really, really bad. There
268 would be no record you ever posted this invoice, and there are no check to
269 make sure charged = 0 or that there are no associated cust_bill_pkg records.
271 Really, don't use it.
277 return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
279 local $SIG{HUP} = 'IGNORE';
280 local $SIG{INT} = 'IGNORE';
281 local $SIG{QUIT} = 'IGNORE';
282 local $SIG{TERM} = 'IGNORE';
283 local $SIG{TSTP} = 'IGNORE';
284 local $SIG{PIPE} = 'IGNORE';
286 my $oldAutoCommit = $FS::UID::AutoCommit;
287 local $FS::UID::AutoCommit = 0;
290 foreach my $table (qw(
301 foreach my $linked ( $self->$table() ) {
302 my $error = $linked->delete;
304 $dbh->rollback if $oldAutoCommit;
311 my $error = $self->SUPER::delete(@_);
313 $dbh->rollback if $oldAutoCommit;
317 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
323 =item replace [ OLD_RECORD ]
325 You can, but probably shouldn't modify invoices...
327 Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
328 supplied, replaces this record. If there is an error, returns the error,
329 otherwise returns false.
333 #replace can be inherited from Record.pm
335 # replace_check is now the preferred way to #implement replace data checks
336 # (so $object->replace() works without an argument)
339 my( $new, $old ) = ( shift, shift );
340 return "Can't modify closed invoice" if $old->closed =~ /^Y/i;
341 #return "Can't change _date!" unless $old->_date eq $new->_date;
342 return "Can't change _date" unless $old->_date == $new->_date;
343 return "Can't change charged" unless $old->charged == $new->charged
344 || $old->charged == 0
345 || $new->{'Hash'}{'cc_surcharge_replace_hack'};
351 =item add_cc_surcharge
357 sub add_cc_surcharge {
358 my ($self, $pkgnum, $amount) = (shift, shift, shift);
361 my $cust_bill_pkg = new FS::cust_bill_pkg({
362 'invnum' => $self->invnum,
366 $error = $cust_bill_pkg->insert;
367 return $error if $error;
369 $self->{'Hash'}{'cc_surcharge_replace_hack'} = 1;
370 $self->charged($self->charged+$amount);
371 $error = $self->replace;
372 return $error if $error;
374 $self->apply_payments_and_credits;
380 Checks all fields to make sure this is a valid invoice. If there is an error,
381 returns the error, otherwise returns false. Called by the insert and replace
390 $self->ut_numbern('invnum')
391 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum' )
392 || $self->ut_numbern('_date')
393 || $self->ut_money('charged')
394 || $self->ut_numbern('printed')
395 || $self->ut_enum('closed', [ '', 'Y' ])
396 || $self->ut_foreign_keyn('statementnum', 'cust_statement', 'statementnum' )
397 || $self->ut_numbern('agent_invid') #varchar?
399 return $error if $error;
401 $self->_date(time) unless $self->_date;
403 $self->printed(0) if $self->printed eq '';
410 Returns the displayed invoice number for this invoice: agent_invid if
411 cust_bill-default_agent_invid is set and it has a value, invnum otherwise.
417 my $conf = $self->conf;
418 if ( $conf->exists('cust_bill-default_agent_invid') && $self->agent_invid ){
419 return $self->agent_invid;
421 return $self->invnum;
427 Returns the customer's last invoice before this one.
433 if ( !$self->get('previous_bill') ) {
434 $self->set('previous_bill', qsearchs({
435 'table' => 'cust_bill',
436 'hashref' => { 'custnum' => $self->custnum,
437 '_date' => { op=>'<', value=>$self->_date } },
438 'order_by' => 'ORDER BY _date DESC LIMIT 1',
441 $self->get('previous_bill');
446 Returns a list consisting of the total previous balance for this customer,
447 followed by the previous outstanding invoices (as FS::cust_bill objects also).
454 my @cust_bill = sort { $a->_date <=> $b->_date }
455 grep { $_->owed != 0 }
456 qsearch( 'cust_bill', { 'custnum' => $self->custnum,
457 #'_date' => { op=>'<', value=>$self->_date },
458 'invnum' => { op=>'<', value=>$self->invnum },
461 foreach ( @cust_bill ) { $total += $_->owed; }
465 =item enable_previous
467 Whether to show the 'Previous Charges' section when printing this invoice.
468 The negation of the 'disable_previous_balance' config setting.
472 sub enable_previous {
474 my $agentnum = $self->cust_main->agentnum;
475 !$self->conf->exists('disable_previous_balance', $agentnum);
480 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
487 { 'table' => 'cust_bill_pkg',
488 'hashref' => { 'invnum' => $self->invnum },
489 'order_by' => 'ORDER BY billpkgnum',
494 =item cust_bill_pkg_pkgnum PKGNUM
496 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice and
501 sub cust_bill_pkg_pkgnum {
502 my( $self, $pkgnum ) = @_;
504 { 'table' => 'cust_bill_pkg',
505 'hashref' => { 'invnum' => $self->invnum,
508 'order_by' => 'ORDER BY billpkgnum',
515 Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
522 my @cust_pkg = map { $_->pkgnum > 0 ? $_->cust_pkg : () }
523 $self->cust_bill_pkg;
525 grep { ! $saw{$_->pkgnum}++ } @cust_pkg;
530 Returns true if any of the packages (or their definitions) corresponding to the
531 line items for this invoice have the no_auto flag set.
537 grep { $_->no_auto || $_->part_pkg->no_auto } $self->cust_pkg;
540 =item open_cust_bill_pkg
542 Returns the open line items for this invoice.
544 Note that cust_bill_pkg with both setup and recur fees are returned as two
545 separate line items, each with only one fee.
549 # modeled after cust_main::open_cust_bill
550 sub open_cust_bill_pkg {
553 # grep { $_->owed > 0 } $self->cust_bill_pkg
555 my %other = ( 'recur' => 'setup',
556 'setup' => 'recur', );
558 foreach my $field ( qw( recur setup )) {
559 push @open, map { $_->set( $other{$field}, 0 ); $_; }
560 grep { $_->owed($field) > 0 }
561 $self->cust_bill_pkg;
567 =item cust_bill_event
569 Returns the completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
573 sub cust_bill_event {
575 qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
578 =item num_cust_bill_event
580 Returns the number of completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
584 sub num_cust_bill_event {
587 "SELECT COUNT(*) FROM cust_bill_event WHERE invnum = ?";
588 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
589 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
590 $sth->fetchrow_arrayref->[0];
595 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
599 #false laziness w/cust_pkg.pm
603 'table' => 'cust_event',
604 'addl_from' => 'JOIN part_event USING ( eventpart )',
605 'hashref' => { 'tablenum' => $self->invnum },
606 'extra_sql' => " AND eventtable = 'cust_bill' ",
612 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
616 #false laziness w/cust_pkg.pm
620 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
621 " WHERE tablenum = ? AND eventtable = 'cust_bill'";
622 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
623 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
624 $sth->fetchrow_arrayref->[0];
629 Returns the customer (see L<FS::cust_main>) for this invoice.
635 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
638 =item cust_suspend_if_balance_over AMOUNT
640 Suspends the customer associated with this invoice if the total amount owed on
641 this invoice and all older invoices is greater than the specified amount.
643 Returns a list: an empty list on success or a list of errors.
647 sub cust_suspend_if_balance_over {
648 my( $self, $amount ) = ( shift, shift );
649 my $cust_main = $self->cust_main;
650 if ( $cust_main->total_owed_date($self->_date) < $amount ) {
653 $cust_main->suspend(@_);
659 Depreciated. See the cust_credited method.
661 #Returns a list consisting of the total previous credited (see
662 #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
663 #outstanding credits (FS::cust_credit objects).
669 croak "FS::cust_bill->cust_credit depreciated; see ".
670 "FS::cust_bill->cust_credit_bill";
673 #my @cust_credit = sort { $a->_date <=> $b->_date }
674 # grep { $_->credited != 0 && $_->_date < $self->_date }
675 # qsearch('cust_credit', { 'custnum' => $self->custnum } )
677 #foreach (@cust_credit) { $total += $_->credited; }
678 #$total, @cust_credit;
683 Depreciated. See the cust_bill_pay method.
685 #Returns all payments (see L<FS::cust_pay>) for this invoice.
691 croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
693 #sort { $a->_date <=> $b->_date }
694 # qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
700 qsearch('cust_pay_batch', { 'invnum' => $self->invnum } );
703 sub cust_bill_pay_batch {
705 qsearch('cust_bill_pay_batch', { 'invnum' => $self->invnum } );
710 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
716 map { $_ } #return $self->num_cust_bill_pay unless wantarray;
717 sort { $a->_date <=> $b->_date }
718 qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
723 =item cust_credit_bill
725 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
731 map { $_ } #return $self->num_cust_credit_bill unless wantarray;
732 sort { $a->_date <=> $b->_date }
733 qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
737 sub cust_credit_bill {
738 shift->cust_credited(@_);
741 #=item cust_bill_pay_pkgnum PKGNUM
743 #Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
744 #with matching pkgnum.
748 #sub cust_bill_pay_pkgnum {
749 # my( $self, $pkgnum ) = @_;
750 # map { $_ } #return $self->num_cust_bill_pay_pkgnum($pkgnum) unless wantarray;
751 # sort { $a->_date <=> $b->_date }
752 # qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum,
753 # 'pkgnum' => $pkgnum,
758 =item cust_bill_pay_pkg PKGNUM
760 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
761 applied against the matching pkgnum.
765 sub cust_bill_pay_pkg {
766 my( $self, $pkgnum ) = @_;
769 'select' => 'cust_bill_pay_pkg.*',
770 'table' => 'cust_bill_pay_pkg',
771 'addl_from' => ' LEFT JOIN cust_bill_pay USING ( billpaynum ) '.
772 ' LEFT JOIN cust_bill_pkg USING ( billpkgnum ) ',
773 'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
774 " AND cust_bill_pkg.pkgnum = $pkgnum",
779 #=item cust_credited_pkgnum PKGNUM
781 #=item cust_credit_bill_pkgnum PKGNUM
783 #Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice
784 #with matching pkgnum.
788 #sub cust_credited_pkgnum {
789 # my( $self, $pkgnum ) = @_;
790 # map { $_ } #return $self->num_cust_credit_bill_pkgnum($pkgnum) unless wantarray;
791 # sort { $a->_date <=> $b->_date }
792 # qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum,
793 # 'pkgnum' => $pkgnum,
798 #sub cust_credit_bill_pkgnum {
799 # shift->cust_credited_pkgnum(@_);
802 =item cust_credit_bill_pkg PKGNUM
804 Returns all credit applications (see L<FS::cust_credit_bill>) for this invoice
805 applied against the matching pkgnum.
809 sub cust_credit_bill_pkg {
810 my( $self, $pkgnum ) = @_;
813 'select' => 'cust_credit_bill_pkg.*',
814 'table' => 'cust_credit_bill_pkg',
815 'addl_from' => ' LEFT JOIN cust_credit_bill USING ( creditbillnum ) '.
816 ' LEFT JOIN cust_bill_pkg USING ( billpkgnum ) ',
817 'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
818 " AND cust_bill_pkg.pkgnum = $pkgnum",
823 =item cust_bill_batch
825 Returns all invoice batch records (L<FS::cust_bill_batch>) for this invoice.
829 sub cust_bill_batch {
831 qsearch('cust_bill_batch', { 'invnum' => $self->invnum });
836 Returns all discount plans (L<FS::discount_plan>) for this invoice, as a
837 hash keyed by term length.
843 FS::discount_plan->all($self);
848 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
855 my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
857 foreach (@taxlines) { $total += $_->setup; }
863 Returns the amount owed (still outstanding) on this invoice, which is charged
864 minus all payment applications (see L<FS::cust_bill_pay>) and credit
865 applications (see L<FS::cust_credit_bill>).
871 my $balance = $self->charged;
872 $balance -= $_->amount foreach ( $self->cust_bill_pay );
873 $balance -= $_->amount foreach ( $self->cust_credited );
874 $balance = sprintf( "%.2f", $balance);
875 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
880 my( $self, $pkgnum ) = @_;
882 #my $balance = $self->charged;
884 $balance += $_->setup + $_->recur for $self->cust_bill_pkg_pkgnum($pkgnum);
886 $balance -= $_->amount for $self->cust_bill_pay_pkg($pkgnum);
887 $balance -= $_->amount for $self->cust_credit_bill_pkg($pkgnum);
889 $balance = sprintf( "%.2f", $balance);
890 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
896 Returns true if this invoice should be hidden. See the
897 selfservice-hide_invoices-taxclass configuraiton setting.
903 my $conf = $self->conf;
904 my $hide_taxclass = $conf->config('selfservice-hide_invoices-taxclass')
906 my @cust_bill_pkg = $self->cust_bill_pkg;
907 my @part_pkg = grep $_, map $_->part_pkg, @cust_bill_pkg;
908 ! grep { $_->taxclass ne $hide_taxclass } @part_pkg;
911 =item apply_payments_and_credits [ OPTION => VALUE ... ]
913 Applies unapplied payments and credits to this invoice.
915 A hash of optional arguments may be passed. Currently "manual" is supported.
916 If true, a payment receipt is sent instead of a statement when
917 'payment_receipt_email' configuration option is set.
919 If there is an error, returns the error, otherwise returns false.
923 sub apply_payments_and_credits {
924 my( $self, %options ) = @_;
925 my $conf = $self->conf;
927 local $SIG{HUP} = 'IGNORE';
928 local $SIG{INT} = 'IGNORE';
929 local $SIG{QUIT} = 'IGNORE';
930 local $SIG{TERM} = 'IGNORE';
931 local $SIG{TSTP} = 'IGNORE';
932 local $SIG{PIPE} = 'IGNORE';
934 my $oldAutoCommit = $FS::UID::AutoCommit;
935 local $FS::UID::AutoCommit = 0;
938 $self->select_for_update; #mutex
940 my @payments = grep { $_->unapplied > 0 } $self->cust_main->cust_pay;
941 my @credits = grep { $_->credited > 0 } $self->cust_main->cust_credit;
943 if ( $conf->exists('pkg-balances') ) {
944 # limit @payments & @credits to those w/ a pkgnum grepped from $self
945 my %pkgnums = map { $_ => 1 } map $_->pkgnum, $self->cust_bill_pkg;
946 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
947 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
950 while ( $self->owed > 0 and ( @payments || @credits ) ) {
953 if ( @payments && @credits ) {
955 #decide which goes first by weight of top (unapplied) line item
957 my @open_lineitems = $self->open_cust_bill_pkg;
960 max( map { $_->part_pkg->pay_weight || 0 }
965 my $max_credit_weight =
966 max( map { $_->part_pkg->credit_weight || 0 }
972 #if both are the same... payments first? it has to be something
973 if ( $max_pay_weight >= $max_credit_weight ) {
979 } elsif ( @payments ) {
981 } elsif ( @credits ) {
984 die "guru meditation #12 and 35";
988 if ( $app eq 'pay' ) {
990 my $payment = shift @payments;
991 $unapp_amount = $payment->unapplied;
992 $app = new FS::cust_bill_pay { 'paynum' => $payment->paynum };
993 $app->pkgnum( $payment->pkgnum )
994 if $conf->exists('pkg-balances') && $payment->pkgnum;
996 } elsif ( $app eq 'credit' ) {
998 my $credit = shift @credits;
999 $unapp_amount = $credit->credited;
1000 $app = new FS::cust_credit_bill { 'crednum' => $credit->crednum };
1001 $app->pkgnum( $credit->pkgnum )
1002 if $conf->exists('pkg-balances') && $credit->pkgnum;
1005 die "guru meditation #12 and 35";
1009 if ( $conf->exists('pkg-balances') && $app->pkgnum ) {
1010 warn "owed_pkgnum ". $app->pkgnum;
1011 $owed = $self->owed_pkgnum($app->pkgnum);
1013 $owed = $self->owed;
1015 next unless $owed > 0;
1017 warn "min ( $unapp_amount, $owed )\n" if $DEBUG;
1018 $app->amount( sprintf('%.2f', min( $unapp_amount, $owed ) ) );
1020 $app->invnum( $self->invnum );
1022 my $error = $app->insert(%options);
1024 $dbh->rollback if $oldAutoCommit;
1025 return "Error inserting ". $app->table. " record: $error";
1027 die $error if $error;
1031 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1036 =item generate_email OPTION => VALUE ...
1044 sender address, required
1048 alternate template name, optional
1052 text attachment arrayref, optional
1056 email subject, optional
1060 notice name instead of "Invoice", optional
1064 Returns an argument list to be passed to L<FS::Misc::send_email>.
1070 sub generate_email {
1074 my $conf = $self->conf;
1076 my $me = '[FS::cust_bill::generate_email]';
1079 'from' => $args{'from'},
1080 'subject' => (($args{'subject'}) ? $args{'subject'} : 'Invoice'),
1084 'unsquelch_cdr' => $conf->exists('voip-cdr_email'),
1085 'template' => $args{'template'},
1086 'notice_name' => ( $args{'notice_name'} || 'Invoice' ),
1087 'no_coupon' => $args{'no_coupon'},
1090 my $cust_main = $self->cust_main;
1092 if (ref($args{'to'}) eq 'ARRAY') {
1093 $return{'to'} = $args{'to'};
1095 $return{'to'} = [ grep { $_ !~ /^(POST|FAX)$/ }
1096 $cust_main->invoicing_list
1100 if ( $conf->exists('invoice_html') ) {
1102 warn "$me creating HTML/text multipart message"
1105 $return{'nobody'} = 1;
1107 my $alternative = build MIME::Entity
1108 'Type' => 'multipart/alternative',
1109 #'Encoding' => '7bit',
1110 'Disposition' => 'inline'
1114 if ( $conf->exists('invoice_email_pdf')
1115 and scalar($conf->config('invoice_email_pdf_note')) ) {
1117 warn "$me using 'invoice_email_pdf_note' in multipart message"
1119 $data = [ map { $_ . "\n" }
1120 $conf->config('invoice_email_pdf_note')
1125 warn "$me not using 'invoice_email_pdf_note' in multipart message"
1127 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1128 $data = $args{'print_text'};
1130 $data = [ $self->print_text(\%opt) ];
1135 $alternative->attach(
1136 'Type' => 'text/plain',
1137 'Encoding' => 'quoted-printable',
1138 #'Encoding' => '7bit',
1140 'Disposition' => 'inline',
1147 if ( $conf->exists('invoice_email_pdf')
1148 and scalar($conf->config('invoice_email_pdf_note')) ) {
1150 $htmldata = join('<BR>', $conf->config('invoice_email_pdf_note') );
1154 $args{'from'} =~ /\@([\w\.\-]+)/;
1155 my $from = $1 || 'example.com';
1156 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
1159 my $agentnum = $cust_main->agentnum;
1160 if ( defined($args{'template'}) && length($args{'template'})
1161 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
1164 $logo = 'logo_'. $args{'template'}. '.png';
1168 my $image_data = $conf->config_binary( $logo, $agentnum);
1170 $image = build MIME::Entity
1171 'Type' => 'image/png',
1172 'Encoding' => 'base64',
1173 'Data' => $image_data,
1174 'Filename' => 'logo.png',
1175 'Content-ID' => "<$content_id>",
1178 if ($conf->exists('invoice-barcode')) {
1179 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
1180 $barcode = build MIME::Entity
1181 'Type' => 'image/png',
1182 'Encoding' => 'base64',
1183 'Data' => $self->invoice_barcode(0),
1184 'Filename' => 'barcode.png',
1185 'Content-ID' => "<$barcode_content_id>",
1187 $opt{'barcode_cid'} = $barcode_content_id;
1190 $htmldata = $self->print_html({ 'cid'=>$content_id, %opt });
1193 $alternative->attach(
1194 'Type' => 'text/html',
1195 'Encoding' => 'quoted-printable',
1196 'Data' => [ '<html>',
1199 ' '. encode_entities($return{'subject'}),
1202 ' <body bgcolor="#e8e8e8">',
1207 'Disposition' => 'inline',
1208 #'Filename' => 'invoice.pdf',
1212 my @otherparts = ();
1213 if ( $cust_main->email_csv_cdr ) {
1215 push @otherparts, build MIME::Entity
1216 'Type' => 'text/csv',
1217 'Encoding' => '7bit',
1218 'Data' => [ map { "$_\n" }
1219 $self->call_details('prepend_billed_number' => 1)
1221 'Disposition' => 'attachment',
1222 'Filename' => 'usage-'. $self->invnum. '.csv',
1227 if ( $conf->exists('invoice_email_pdf') ) {
1232 # multipart/alternative
1238 my $related = build MIME::Entity 'Type' => 'multipart/related',
1239 'Encoding' => '7bit';
1241 #false laziness w/Misc::send_email
1242 $related->head->replace('Content-type',
1243 $related->mime_type.
1244 '; boundary="'. $related->head->multipart_boundary. '"'.
1245 '; type=multipart/alternative'
1248 $related->add_part($alternative);
1250 $related->add_part($image) if $image;
1252 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%opt);
1254 $return{'mimeparts'} = [ $related, $pdf, @otherparts ];
1258 #no other attachment:
1260 # multipart/alternative
1265 $return{'content-type'} = 'multipart/related';
1266 if ($conf->exists('invoice-barcode') && $barcode) {
1267 $return{'mimeparts'} = [ $alternative, $image, $barcode, @otherparts ];
1269 $return{'mimeparts'} = [ $alternative, $image, @otherparts ];
1271 $return{'type'} = 'multipart/alternative'; #Content-Type of first part...
1272 #$return{'disposition'} = 'inline';
1278 if ( $conf->exists('invoice_email_pdf') ) {
1279 warn "$me creating PDF attachment"
1282 #mime parts arguments a la MIME::Entity->build().
1283 $return{'mimeparts'} = [
1284 { $self->mimebuild_pdf(\%opt) }
1288 if ( $conf->exists('invoice_email_pdf')
1289 and scalar($conf->config('invoice_email_pdf_note')) ) {
1291 warn "$me using 'invoice_email_pdf_note'"
1293 $return{'body'} = [ map { $_ . "\n" }
1294 $conf->config('invoice_email_pdf_note')
1299 warn "$me not using 'invoice_email_pdf_note'"
1301 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1302 $return{'body'} = $args{'print_text'};
1304 $return{'body'} = [ $self->print_text(\%opt) ];
1317 Returns a list suitable for passing to MIME::Entity->build(), representing
1318 this invoice as PDF attachment.
1325 'Type' => 'application/pdf',
1326 'Encoding' => 'base64',
1327 'Data' => [ $self->print_pdf(@_) ],
1328 'Disposition' => 'attachment',
1329 'Filename' => 'invoice-'. $self->invnum. '.pdf',
1333 =item send HASHREF | [ TEMPLATE [ , AGENTNUM [ , INVOICE_FROM [ , AMOUNT ] ] ] ]
1335 Sends this invoice to the destinations configured for this customer: sends
1336 email, prints and/or faxes. See L<FS::cust_main_invoice>.
1338 Options can be passed as a hashref (recommended) or as a list of up to
1339 four values for templatename, agentnum, invoice_from and amount.
1341 I<template>, if specified, is the name of a suffix for alternate invoices.
1343 I<agentnum>, if specified, means that this invoice will only be sent for customers
1344 of the specified agent or agent(s). AGENTNUM can be a scalar agentnum (for a
1345 single agent) or an arrayref of agentnums.
1347 I<invoice_from>, if specified, overrides the default email invoice From: address.
1349 I<amount>, if specified, only sends the invoice if the total amount owed on this
1350 invoice and all older invoices is greater than the specified amount.
1352 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1354 I<lpr>, if specified, is passed to
1358 sub queueable_send {
1361 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1362 or die "invalid invoice number: " . $opt{invnum};
1364 my @args = ( $opt{template}, $opt{agentnum} );
1365 push @args, $opt{invoice_from}
1366 if exists($opt{invoice_from}) && $opt{invoice_from};
1368 my $error = $self->send( @args );
1369 die $error if $error;
1375 my $conf = $self->conf;
1377 my( $template, $invoice_from, $notice_name );
1379 my $balance_over = 0;
1384 $template = $opt->{'template'} || '';
1385 if ( $agentnums = $opt->{'agentnum'} ) {
1386 $agentnums = [ $agentnums ] unless ref($agentnums);
1388 $invoice_from = $opt->{'invoice_from'};
1389 $balance_over = $opt->{'balance_over'} if $opt->{'balance_over'};
1390 $notice_name = $opt->{'notice_name'};
1391 $lpr = $opt->{'lpr'}
1393 $template = scalar(@_) ? shift : '';
1394 if ( scalar(@_) && $_[0] ) {
1395 $agentnums = ref($_[0]) ? shift : [ shift ];
1397 $invoice_from = shift if scalar(@_);
1398 $balance_over = shift if scalar(@_) && $_[0] !~ /^\s*$/;
1401 my $cust_main = $self->cust_main;
1403 return 'N/A' unless ! $agentnums
1404 or grep { $_ == $cust_main->agentnum } @$agentnums;
1407 unless $cust_main->total_owed_date($self->_date) > $balance_over;
1409 $invoice_from ||= $self->_agent_invoice_from || #XXX should go away
1410 $conf->config('invoice_from', $cust_main->agentnum );
1413 'template' => $template,
1414 'invoice_from' => $invoice_from,
1415 'notice_name' => ( $notice_name || 'Invoice' ),
1418 my @invoicing_list = $cust_main->invoicing_list;
1420 #$self->email_invoice(\%opt)
1422 if ( grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list )
1423 && ! $self->invoice_noemail;
1426 #$self->print_invoice(\%opt)
1428 if grep { $_ eq 'POST' } @invoicing_list; #postal
1430 #this has never been used post-$ORIGINAL_ISP afaik
1431 $self->fax_invoice(\%opt)
1432 if grep { $_ eq 'FAX' } @invoicing_list; #fax
1438 =item email HASHREF | [ TEMPLATE [ , INVOICE_FROM ] ]
1440 Emails this invoice.
1442 Options can be passed as a hashref (recommended) or as a list of up to
1443 two values for templatename and invoice_from.
1445 I<template>, if specified, is the name of a suffix for alternate invoices.
1447 I<invoice_from>, if specified, overrides the default email invoice From: address.
1449 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1453 sub queueable_email {
1456 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1457 or die "invalid invoice number: " . $opt{invnum};
1459 my %args = ( 'template' => $opt{template} );
1460 $args{$_} = $opt{$_}
1461 foreach grep { exists($opt{$_}) && $opt{$_} }
1462 qw( invoice_from notice_name no_coupon );
1464 my $error = $self->email( \%args );
1465 die $error if $error;
1469 #sub email_invoice {
1472 return if $self->hide;
1473 my $conf = $self->conf;
1475 my( $template, $invoice_from, $notice_name, $no_coupon );
1478 $template = $opt->{'template'} || '';
1479 $invoice_from = $opt->{'invoice_from'};
1480 $notice_name = $opt->{'notice_name'} || 'Invoice';
1481 $no_coupon = $opt->{'no_coupon'} || 0;
1483 $template = scalar(@_) ? shift : '';
1484 $invoice_from = shift if scalar(@_);
1485 $notice_name = 'Invoice';
1489 $invoice_from ||= $self->_agent_invoice_from || #XXX should go away
1490 $conf->config('invoice_from', $self->cust_main->agentnum );
1492 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
1493 $self->cust_main->invoicing_list;
1495 if ( ! @invoicing_list ) { #no recipients
1496 if ( $conf->exists('cust_bill-no_recipients-error') ) {
1497 die 'No recipients for customer #'. $self->custnum;
1499 #default: better to notify this person than silence
1500 @invoicing_list = ($invoice_from);
1504 my $subject = $self->email_subject($template);
1506 my $error = send_email(
1507 $self->generate_email(
1508 'from' => $invoice_from,
1509 'to' => [ grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list ],
1510 'subject' => $subject,
1511 'template' => $template,
1512 'notice_name' => $notice_name,
1513 'no_coupon' => $no_coupon,
1516 die "can't email invoice: $error\n" if $error;
1517 #die "$error\n" if $error;
1523 my $conf = $self->conf;
1525 #my $template = scalar(@_) ? shift : '';
1528 my $subject = $conf->config('invoice_subject', $self->cust_main->agentnum)
1531 my $cust_main = $self->cust_main;
1532 my $name = $cust_main->name;
1533 my $name_short = $cust_main->name_short;
1534 my $invoice_number = $self->invnum;
1535 my $invoice_date = $self->_date_pretty;
1537 eval qq("$subject");
1540 =item lpr_data HASHREF | [ TEMPLATE ]
1542 Returns the postscript or plaintext for this invoice as an arrayref.
1544 Options can be passed as a hashref (recommended) or as a single optional value
1547 I<template>, if specified, is the name of a suffix for alternate invoices.
1549 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1555 my $conf = $self->conf;
1556 my( $template, $notice_name );
1559 $template = $opt->{'template'} || '';
1560 $notice_name = $opt->{'notice_name'} || 'Invoice';
1562 $template = scalar(@_) ? shift : '';
1563 $notice_name = 'Invoice';
1567 'template' => $template,
1568 'notice_name' => $notice_name,
1571 my $method = $conf->exists('invoice_latex') ? 'print_ps' : 'print_text';
1572 [ $self->$method( \%opt ) ];
1575 =item print HASHREF | [ TEMPLATE ]
1577 Prints this invoice.
1579 Options can be passed as a hashref (recommended) or as a single optional
1582 I<template>, if specified, is the name of a suffix for alternate invoices.
1584 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1588 #sub print_invoice {
1591 return if $self->hide;
1592 my $conf = $self->conf;
1594 my( $template, $notice_name, $lpr );
1597 $template = $opt->{'template'} || '';
1598 $notice_name = $opt->{'notice_name'} || 'Invoice';
1599 $lpr = $opt->{'lpr'}
1601 $template = scalar(@_) ? shift : '';
1602 $notice_name = 'Invoice';
1607 'template' => $template,
1608 'notice_name' => $notice_name,
1611 if($conf->exists('invoice_print_pdf')) {
1612 # Add the invoice to the current batch.
1613 $self->batch_invoice(\%opt);
1617 $self->lpr_data(\%opt),
1618 'agentnum' => $self->cust_main->agentnum,
1624 =item fax_invoice HASHREF | [ TEMPLATE ]
1628 Options can be passed as a hashref (recommended) or as a single optional
1631 I<template>, if specified, is the name of a suffix for alternate invoices.
1633 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1639 return if $self->hide;
1640 my $conf = $self->conf;
1642 my( $template, $notice_name );
1645 $template = $opt->{'template'} || '';
1646 $notice_name = $opt->{'notice_name'} || 'Invoice';
1648 $template = scalar(@_) ? shift : '';
1649 $notice_name = 'Invoice';
1652 die 'FAX invoice destination not (yet?) supported with plain text invoices.'
1653 unless $conf->exists('invoice_latex');
1655 my $dialstring = $self->cust_main->getfield('fax');
1659 'template' => $template,
1660 'notice_name' => $notice_name,
1663 my $error = send_fax( 'docdata' => $self->lpr_data(\%opt),
1664 'dialstring' => $dialstring,
1666 die $error if $error;
1670 =item batch_invoice [ HASHREF ]
1672 Place this invoice into the open batch (see C<FS::bill_batch>). If there
1673 isn't an open batch, one will be created.
1678 my ($self, $opt) = @_;
1679 my $bill_batch = $self->get_open_bill_batch;
1680 my $cust_bill_batch = FS::cust_bill_batch->new({
1681 batchnum => $bill_batch->batchnum,
1682 invnum => $self->invnum,
1684 return $cust_bill_batch->insert($opt);
1687 =item get_open_batch
1689 Returns the currently open batch as an FS::bill_batch object, creating a new
1690 one if necessary. (A per-agent batch if invoice_print_pdf-spoolagent is
1695 sub get_open_bill_batch {
1697 my $conf = $self->conf;
1698 my $hashref = { status => 'O' };
1699 $hashref->{'agentnum'} = $conf->exists('invoice_print_pdf-spoolagent')
1700 ? $self->cust_main->agentnum
1702 my $batch = qsearchs('bill_batch', $hashref);
1703 return $batch if $batch;
1704 $batch = FS::bill_batch->new($hashref);
1705 my $error = $batch->insert;
1706 die $error if $error;
1710 =item ftp_invoice [ TEMPLATENAME ]
1712 Sends this invoice data via FTP.
1714 TEMPLATENAME is unused?
1720 my $conf = $self->conf;
1721 my $template = scalar(@_) ? shift : '';
1724 'protocol' => 'ftp',
1725 'server' => $conf->config('cust_bill-ftpserver'),
1726 'username' => $conf->config('cust_bill-ftpusername'),
1727 'password' => $conf->config('cust_bill-ftppassword'),
1728 'dir' => $conf->config('cust_bill-ftpdir'),
1729 'format' => $conf->config('cust_bill-ftpformat'),
1733 =item spool_invoice [ TEMPLATENAME ]
1735 Spools this invoice data (see L<FS::spool_csv>)
1737 TEMPLATENAME is unused?
1743 my $conf = $self->conf;
1744 my $template = scalar(@_) ? shift : '';
1747 'format' => $conf->config('cust_bill-spoolformat'),
1748 'agent_spools' => $conf->exists('cust_bill-spoolagent'),
1752 =item send_if_newest [ TEMPLATENAME [ , AGENTNUM [ , INVOICE_FROM ] ] ]
1754 Like B<send>, but only sends the invoice if it is the newest open invoice for
1759 sub send_if_newest {
1764 grep { $_->owed > 0 }
1765 qsearch('cust_bill', {
1766 'custnum' => $self->custnum,
1767 #'_date' => { op=>'>', value=>$self->_date },
1768 'invnum' => { op=>'>', value=>$self->invnum },
1775 =item send_csv OPTION => VALUE, ...
1777 Sends invoice as a CSV data-file to a remote host with the specified protocol.
1781 protocol - currently only "ftp"
1787 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
1788 and YYMMDDHHMMSS is a timestamp.
1790 See L</print_csv> for a description of the output format.
1795 my($self, %opt) = @_;
1799 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1800 mkdir $spooldir, 0700 unless -d $spooldir;
1802 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1803 my $file = "$spooldir/$tracctnum.csv";
1805 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1807 open(CSV, ">$file") or die "can't open $file: $!";
1815 if ( $opt{protocol} eq 'ftp' ) {
1816 eval "use Net::FTP;";
1818 $net = Net::FTP->new($opt{server}) or die @$;
1820 die "unknown protocol: $opt{protocol}";
1823 $net->login( $opt{username}, $opt{password} )
1824 or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
1826 $net->binary or die "can't set binary mode";
1828 $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
1830 $net->put($file) or die "can't put $file: $!";
1840 Spools CSV invoice data.
1846 =item format - any of FS::Misc::::Invoicing::spool_formats
1848 =item dest - if set (to POST, EMAIL or FAX), only sends spools invoices if the
1849 customer has the corresponding invoice destinations set (see
1850 L<FS::cust_main_invoice>).
1852 =item agent_spools - if set to a true value, will spool to per-agent files
1853 rather than a single global file
1855 =item upload_targetnum - if set to a target (see L<FS::upload_target>), will
1856 append to that spool. L<FS::Cron::upload> will then send the spool file to
1859 =item balanceover - if set, only spools the invoice if the total amount owed on
1860 this invoice and all older invoices is greater than the specified amount.
1862 =item time - the "current time". Controls the printing of past due messages
1870 my($self, %opt) = @_;
1872 my $time = $opt{'time'} || time;
1873 my $cust_main = $self->cust_main;
1875 if ( $opt{'dest'} ) {
1876 my %invoicing_list = map { /^(POST|FAX)$/ or 'EMAIL' =~ /^(.*)$/; $1 => 1 }
1877 $cust_main->invoicing_list;
1878 return 'N/A' unless $invoicing_list{$opt{'dest'}}
1879 || ! keys %invoicing_list;
1882 if ( $opt{'balanceover'} ) {
1884 if $cust_main->total_owed_date($self->_date) < $opt{'balanceover'};
1887 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1888 mkdir $spooldir, 0700 unless -d $spooldir;
1890 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', $time);
1893 if ( $opt{'agent_spools'} ) {
1894 $file = 'agentnum'.$cust_main->agentnum;
1899 if ( $opt{'upload_targetnum'} ) {
1900 $spooldir .= '/target'.$opt{'upload_targetnum'};
1901 mkdir $spooldir, 0700 unless -d $spooldir;
1902 } # otherwise it just goes into export.xxx/cust_bill
1904 if ( lc($opt{'format'}) eq 'billco' ) {
1908 $file = "$spooldir/$file.csv";
1910 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum);
1912 open(CSV, ">>$file") or die "can't open $file: $!";
1913 flock(CSV, LOCK_EX);
1918 if ( lc($opt{'format'}) eq 'billco' ) {
1920 flock(CSV, LOCK_UN);
1923 $file =~ s/-header.csv$/-detail.csv/;
1925 open(CSV,">>$file") or die "can't open $file: $!";
1926 flock(CSV, LOCK_EX);
1930 print CSV $detail if defined($detail);
1932 flock(CSV, LOCK_UN);
1939 =item print_csv OPTION => VALUE, ...
1941 Returns CSV data for this invoice.
1945 format - 'default', 'billco', 'oneline', 'bridgestone'
1947 Returns a list consisting of two scalars. The first is a single line of CSV
1948 header information for this invoice. The second is one or more lines of CSV
1949 detail information for this invoice.
1951 If I<format> is not specified or "default", the fields of the CSV file are as
1954 record_type, invnum, custnum, _date, charged, first, last, company, address1,
1955 address2, city, state, zip, country, pkg, setup, recur, sdate, edate
1959 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
1961 B<record_type> is C<cust_bill> for the initial header line only. The
1962 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
1963 fields are filled in.
1965 B<record_type> is C<cust_bill_pkg> for detail lines. Only the first two fields
1966 (B<record_type> and B<invnum>) and the last five fields (B<pkg> through B<edate>)
1969 =item invnum - invoice number
1971 =item custnum - customer number
1973 =item _date - invoice date
1975 =item charged - total invoice amount
1977 =item first - customer first name
1979 =item last - customer first name
1981 =item company - company name
1983 =item address1 - address line 1
1985 =item address2 - address line 1
1995 =item pkg - line item description
1997 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
1999 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
2001 =item sdate - start date for recurring fee
2003 =item edate - end date for recurring fee
2007 If I<format> is "billco", the fields of the header CSV file are as follows:
2009 +-------------------------------------------------------------------+
2010 | FORMAT HEADER FILE |
2011 |-------------------------------------------------------------------|
2012 | Field | Description | Name | Type | Width |
2013 | 1 | N/A-Leave Empty | RC | CHAR | 2 |
2014 | 2 | N/A-Leave Empty | CUSTID | CHAR | 15 |
2015 | 3 | Transaction Account No | TRACCTNUM | CHAR | 15 |
2016 | 4 | Transaction Invoice No | TRINVOICE | CHAR | 15 |
2017 | 5 | Transaction Zip Code | TRZIP | CHAR | 5 |
2018 | 6 | Transaction Company Bill To | TRCOMPANY | CHAR | 30 |
2019 | 7 | Transaction Contact Bill To | TRNAME | CHAR | 30 |
2020 | 8 | Additional Address Unit Info | TRADDR1 | CHAR | 30 |
2021 | 9 | Bill To Street Address | TRADDR2 | CHAR | 30 |
2022 | 10 | Ancillary Billing Information | TRADDR3 | CHAR | 30 |
2023 | 11 | Transaction City Bill To | TRCITY | CHAR | 20 |
2024 | 12 | Transaction State Bill To | TRSTATE | CHAR | 2 |
2025 | 13 | Bill Cycle Close Date | CLOSEDATE | CHAR | 10 |
2026 | 14 | Bill Due Date | DUEDATE | CHAR | 10 |
2027 | 15 | Previous Balance | BALFWD | NUM* | 9 |
2028 | 16 | Pmt/CR Applied | CREDAPPLY | NUM* | 9 |
2029 | 17 | Total Current Charges | CURRENTCHG | NUM* | 9 |
2030 | 18 | Total Amt Due | TOTALDUE | NUM* | 9 |
2031 | 19 | Total Amt Due | AMTDUE | NUM* | 9 |
2032 | 20 | 30 Day Aging | AMT30 | NUM* | 9 |
2033 | 21 | 60 Day Aging | AMT60 | NUM* | 9 |
2034 | 22 | 90 Day Aging | AMT90 | NUM* | 9 |
2035 | 23 | Y/N | AGESWITCH | CHAR | 1 |
2036 | 24 | Remittance automation | SCANLINE | CHAR | 100 |
2037 | 25 | Total Taxes & Fees | TAXTOT | NUM* | 9 |
2038 | 26 | Customer Reference Number | CUSTREF | CHAR | 15 |
2039 | 27 | Federal Tax*** | FEDTAX | NUM* | 9 |
2040 | 28 | State Tax*** | STATETAX | NUM* | 9 |
2041 | 29 | Other Taxes & Fees*** | OTHERTAX | NUM* | 9 |
2042 +-------+-------------------------------+------------+------+-------+
2044 If I<format> is "billco", the fields of the detail CSV file are as follows:
2046 FORMAT FOR DETAIL FILE
2048 Field | Description | Name | Type | Width
2049 1 | N/A-Leave Empty | RC | CHAR | 2
2050 2 | N/A-Leave Empty | CUSTID | CHAR | 15
2051 3 | Account Number | TRACCTNUM | CHAR | 15
2052 4 | Invoice Number | TRINVOICE | CHAR | 15
2053 5 | Line Sequence (sort order) | LINESEQ | NUM | 6
2054 6 | Transaction Detail | DETAILS | CHAR | 100
2055 7 | Amount | AMT | NUM* | 9
2056 8 | Line Format Control** | LNCTRL | CHAR | 2
2057 9 | Grouping Code | GROUP | CHAR | 2
2058 10 | User Defined | ACCT CODE | CHAR | 15
2060 If format is 'oneline', there is no detail file. Each invoice has a
2061 header line only, with the fields:
2063 Agent number, agent name, customer number, first name, last name, address
2064 line 1, address line 2, city, state, zip, invoice date, invoice number,
2065 amount charged, amount due, previous balance, due date.
2067 and then, for each line item, three columns containing the package number,
2068 description, and amount.
2070 If format is 'bridgestone', there is no detail file. Each invoice has a
2071 header line with the following fields in a fixed-width format:
2073 Customer number (in display format), date, name (first last), company,
2074 address 1, address 2, city, state, zip.
2076 This is a mailing list format, and has no per-invoice fields. To avoid
2077 sending redundant notices, the spooling event should have a "once" or
2078 "once_percust_every" condition.
2083 my($self, %opt) = @_;
2085 eval "use Text::CSV_XS";
2088 my $cust_main = $self->cust_main;
2090 my $csv = Text::CSV_XS->new({'always_quote'=>1});
2091 my $format = lc($opt{'format'});
2093 my $time = $opt{'time'} || time;
2095 if ( $format eq 'billco' ) {
2098 $taxtotal += $_->{'amount'} foreach $self->_items_tax;
2100 my $duedate = $self->due_date2str('%m/%d/%Y'); #date_format?
2102 my( $previous_balance, @unused ) = $self->previous; #previous balance
2104 my $pmt_cr_applied = 0;
2105 $pmt_cr_applied += $_->{'amount'}
2106 foreach ( $self->_items_payments, $self->_items_credits ) ;
2108 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
2111 '', # 1 | N/A-Leave Empty CHAR 2
2112 '', # 2 | N/A-Leave Empty CHAR 15
2113 $opt{'tracctnum'}, # 3 | Transaction Account No CHAR 15
2114 $self->invnum, # 4 | Transaction Invoice No CHAR 15
2115 $cust_main->zip, # 5 | Transaction Zip Code CHAR 5
2116 $cust_main->company, # 6 | Transaction Company Bill To CHAR 30
2117 #$cust_main->payname, # 7 | Transaction Contact Bill To CHAR 30
2118 $cust_main->contact, # 7 | Transaction Contact Bill To CHAR 30
2119 $cust_main->address2, # 8 | Additional Address Unit Info CHAR 30
2120 $cust_main->address1, # 9 | Bill To Street Address CHAR 30
2121 '', # 10 | Ancillary Billing Information CHAR 30
2122 $cust_main->city, # 11 | Transaction City Bill To CHAR 20
2123 $cust_main->state, # 12 | Transaction State Bill To CHAR 2
2126 time2str("%m/%d/%Y", $self->_date), # 13 | Bill Cycle Close Date CHAR 10
2129 $duedate, # 14 | Bill Due Date CHAR 10
2131 $previous_balance, # 15 | Previous Balance NUM* 9
2132 $pmt_cr_applied, # 16 | Pmt/CR Applied NUM* 9
2133 sprintf("%.2f", $self->charged), # 17 | Total Current Charges NUM* 9
2134 $totaldue, # 18 | Total Amt Due NUM* 9
2135 $totaldue, # 19 | Total Amt Due NUM* 9
2136 '', # 20 | 30 Day Aging NUM* 9
2137 '', # 21 | 60 Day Aging NUM* 9
2138 '', # 22 | 90 Day Aging NUM* 9
2139 'N', # 23 | Y/N CHAR 1
2140 '', # 24 | Remittance automation CHAR 100
2141 $taxtotal, # 25 | Total Taxes & Fees NUM* 9
2142 $self->custnum, # 26 | Customer Reference Number CHAR 15
2143 '0', # 27 | Federal Tax*** NUM* 9
2144 sprintf("%.2f", $taxtotal), # 28 | State Tax*** NUM* 9
2145 '0', # 29 | Other Taxes & Fees*** NUM* 9
2148 } elsif ( $format eq 'oneline' ) { #name
2150 my ($previous_balance) = $self->previous;
2151 $previous_balance = sprintf('%.2f', $previous_balance);
2152 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
2158 $self->_items_pkg, #_items_nontax? no sections or anything
2163 $cust_main->agentnum,
2164 $cust_main->agent->agent,
2168 $cust_main->company,
2169 $cust_main->address1,
2170 $cust_main->address2,
2176 time2str("%x", $self->_date),
2181 $self->due_date2str("%x"),
2186 } elsif ( $format eq 'bridgestone' ) {
2188 # bypass the CSV stuff and just return this
2189 my $longdate = time2str('%B %d, %Y', $time); #current time, right?
2190 my $zip = $cust_main->zip;
2192 my $prefix = $self->conf->config('bridgestone-prefix', $cust_main->agentnum)
2196 "%-5s%-15s%-20s%-30s%-30s%-30s%-30s%-20s%-2s%-9s\n",
2198 $cust_main->display_custnum,
2200 uc(substr($cust_main->contact_firstlast,0,30)),
2201 uc(substr($cust_main->company ,0,30)),
2202 uc(substr($cust_main->address1 ,0,30)),
2203 uc(substr($cust_main->address2 ,0,30)),
2204 uc(substr($cust_main->city ,0,20)),
2205 uc($cust_main->state),
2211 } elsif ( $format eq 'ics' ) {
2213 my $bill = $cust_main->bill_location;
2214 my $zip = $bill->zip;
2218 if ( $zip =~ /^(\d{5})(\d{4})$/ ) {
2223 # minor false laziness with print_generic
2224 my ($previous_balance) = $self->previous;
2225 my $balance_due = $self->owed + $previous_balance;
2226 my $payment_total = sum(0, map { $_->{'amount'} } $self->_items_payments);
2227 my $credit_total = sum(0, map { $_->{'amount'} } $self->_items_credits);
2230 if ( $self->due_date and $time >= $self->due_date ) {
2231 $past_due = sprintf('Past due:$%0.2f Due Immediately', $balance_due);
2235 my $header = sprintf(
2236 '%-10s%-30s%-48s%-2s%-50s%-30s%-30s%-25s%-2s%-5s%-4s%-8s%-8s%-10s%-10s%-10s%-10s%-10s%-10s%-480s%-35s',
2237 $cust_main->display_custnum, #BID
2238 uc($cust_main->first), #FNAME
2239 uc($cust_main->last), #LNAME
2240 '00', #BATCH, should this ever be anything else?
2241 uc($cust_main->company), #COMP
2242 uc($bill->address1), #STREET1
2243 uc($bill->address2), #STREET2
2244 uc($bill->city), #CITY
2245 uc($bill->state), #STATE
2248 time2str('%Y%m%d', $self->_date), #BILL_DATE
2249 $self->due_date2str('%Y%m%d'), #DUE_DATE,
2250 ( map {sprintf('%0.2f', $_)}
2251 $balance_due, #AMNT_DUE
2252 $previous_balance, #PREV_BAL
2253 $payment_total, #PYMT_RCVD
2254 $credit_total, #CREDITS
2255 $previous_balance, #BEG_BAL--is this correct?
2256 $self->charged, #NEW_CHRG
2259 $past_due, #PAST_MSG
2263 my %svc_class = ('' => ''); # maybe cache this more persistently?
2265 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2267 my $show_pkgnum = $cust_bill_pkg->pkgnum || '';
2268 my $cust_pkg = $cust_bill_pkg->cust_pkg if $show_pkgnum;
2272 my @dates = ( $self->_date, undef );
2273 if ( my $prev = $cust_bill_pkg->previous_cust_bill_pkg ) {
2274 $dates[1] = $prev->sdate; #questionable
2277 # generate an 01 detail for each service
2278 my @svcs = $cust_pkg->h_cust_svc(@dates, 'I');
2279 foreach my $cust_svc ( @svcs ) {
2280 $show_pkgnum = ''; # hide it if we're showing svcnums
2282 my $svcpart = $cust_svc->svcpart;
2283 if (!exists($svc_class{$svcpart})) {
2284 my $classnum = $cust_svc->part_svc->classnum;
2285 my $part_svc_class = FS::part_svc_class->by_key($classnum)
2287 $svc_class{$svcpart} = $part_svc_class ?
2288 $part_svc_class->classname :
2292 my @h_label = $cust_svc->label(@dates, 'I');
2293 push @details, sprintf('01%-9s%-20s%-47s',
2295 $svc_class{$svcpart},
2298 } #foreach $cust_svc
2301 my $desc = $cust_bill_pkg->desc; # itemdesc or part_pkg.pkg
2302 if ($cust_bill_pkg->recur > 0) {
2303 $desc .= ' '.time2str('%d-%b-%Y', $cust_bill_pkg->sdate).' to '.
2304 time2str('%d-%b-%Y', $cust_bill_pkg->edate - 86400);
2306 push @details, sprintf('02%-6s%-60s%-10s',
2309 sprintf('%0.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
2311 } #foreach $cust_bill_pkg
2313 # Tag this row so that we know whether this is one page (1), two pages
2314 # (2), # or "big" (B). The tag will be stripped off before uploading.
2315 if ( scalar(@details) < 12 ) {
2317 } elsif ( scalar(@details) < 58 ) {
2323 return join('', $header, @details, "\n");
2331 time2str("%x", $self->_date),
2332 sprintf("%.2f", $self->charged),
2333 ( map { $cust_main->getfield($_) }
2334 qw( first last company address1 address2 city state zip country ) ),
2336 ) or die "can't create csv";
2339 my $header = $csv->string. "\n";
2342 if ( lc($opt{'format'}) eq 'billco' ) {
2345 foreach my $item ( $self->_items_pkg ) {
2348 '', # 1 | N/A-Leave Empty CHAR 2
2349 '', # 2 | N/A-Leave Empty CHAR 15
2350 $opt{'tracctnum'}, # 3 | Account Number CHAR 15
2351 $self->invnum, # 4 | Invoice Number CHAR 15
2352 $lineseq++, # 5 | Line Sequence (sort order) NUM 6
2353 $item->{'description'}, # 6 | Transaction Detail CHAR 100
2354 $item->{'amount'}, # 7 | Amount NUM* 9
2355 '', # 8 | Line Format Control** CHAR 2
2356 '', # 9 | Grouping Code CHAR 2
2357 '', # 10 | User Defined CHAR 15
2360 $detail .= $csv->string. "\n";
2364 } elsif ( lc($opt{'format'}) eq 'oneline' ) {
2370 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2372 my($pkg, $setup, $recur, $sdate, $edate);
2373 if ( $cust_bill_pkg->pkgnum ) {
2375 ($pkg, $setup, $recur, $sdate, $edate) = (
2376 $cust_bill_pkg->part_pkg->pkg,
2377 ( $cust_bill_pkg->setup != 0
2378 ? sprintf("%.2f", $cust_bill_pkg->setup )
2380 ( $cust_bill_pkg->recur != 0
2381 ? sprintf("%.2f", $cust_bill_pkg->recur )
2383 ( $cust_bill_pkg->sdate
2384 ? time2str("%x", $cust_bill_pkg->sdate)
2386 ($cust_bill_pkg->edate
2387 ?time2str("%x", $cust_bill_pkg->edate)
2391 } else { #pkgnum tax
2392 next unless $cust_bill_pkg->setup != 0;
2393 $pkg = $cust_bill_pkg->desc;
2394 $setup = sprintf('%10.2f', $cust_bill_pkg->setup );
2395 ( $sdate, $edate ) = ( '', '' );
2401 ( map { '' } (1..11) ),
2402 ($pkg, $setup, $recur, $sdate, $edate)
2403 ) or die "can't create csv";
2405 $detail .= $csv->string. "\n";
2411 ( $header, $detail );
2417 Pays this invoice with a compliemntary payment. If there is an error,
2418 returns the error, otherwise returns false.
2424 my $cust_pay = new FS::cust_pay ( {
2425 'invnum' => $self->invnum,
2426 'paid' => $self->owed,
2429 'payinfo' => $self->cust_main->payinfo,
2437 Attempts to pay this invoice with a credit card payment via a
2438 Business::OnlinePayment realtime gateway. See
2439 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2440 for supported processors.
2446 $self->realtime_bop( 'CC', @_ );
2451 Attempts to pay this invoice with an electronic check (ACH) payment via a
2452 Business::OnlinePayment realtime gateway. See
2453 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2454 for supported processors.
2460 $self->realtime_bop( 'ECHECK', @_ );
2465 Attempts to pay this invoice with phone bill (LEC) payment via a
2466 Business::OnlinePayment realtime gateway. See
2467 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2468 for supported processors.
2474 $self->realtime_bop( 'LEC', @_ );
2478 my( $self, $method ) = (shift,shift);
2479 my $conf = $self->conf;
2482 my $cust_main = $self->cust_main;
2483 my $balance = $cust_main->balance;
2484 my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
2485 $amount = sprintf("%.2f", $amount);
2486 return "not run (balance $balance)" unless $amount > 0;
2488 my $description = 'Internet Services';
2489 if ( $conf->exists('business-onlinepayment-description') ) {
2490 my $dtempl = $conf->config('business-onlinepayment-description');
2492 my $agent_obj = $cust_main->agent
2493 or die "can't retreive agent for $cust_main (agentnum ".
2494 $cust_main->agentnum. ")";
2495 my $agent = $agent_obj->agent;
2496 my $pkgs = join(', ',
2497 map { $_->part_pkg->pkg }
2498 grep { $_->pkgnum } $self->cust_bill_pkg
2500 $description = eval qq("$dtempl");
2503 $cust_main->realtime_bop($method, $amount,
2504 'description' => $description,
2505 'invnum' => $self->invnum,
2506 #this didn't do what we want, it just calls apply_payments_and_credits
2508 'apply_to_invoice' => 1,
2511 #this changes application behavior: auto payments
2512 #triggered against a specific invoice are now applied
2513 #to that invoice instead of oldest open.
2519 =item batch_card OPTION => VALUE...
2521 Adds a payment for this invoice to the pending credit card batch (see
2522 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2523 runs the payment using a realtime gateway.
2528 my ($self, %options) = @_;
2529 my $cust_main = $self->cust_main;
2531 $options{invnum} = $self->invnum;
2533 $cust_main->batch_card(%options);
2536 sub _agent_template {
2538 $self->cust_main->agent_template;
2541 sub _agent_invoice_from {
2543 $self->cust_main->agent_invoice_from;
2546 =item invoice_barcode DIR_OR_FALSE
2548 Generates an invoice barcode PNG. If DIR_OR_FALSE is a true value,
2549 it is taken as the temp directory where the PNG file will be generated and the
2550 PNG file name is returned. Otherwise, the PNG image itself is returned.
2554 sub invoice_barcode {
2555 my ($self, $dir) = (shift,shift);
2557 my $gdbar = new GD::Barcode('Code39',$self->invnum);
2558 die "can't create barcode: " . $GD::Barcode::errStr unless $gdbar;
2559 my $gd = $gdbar->plot(Height => 30);
2562 my $bh = new File::Temp( TEMPLATE => 'barcode.'. $self->invnum. '.XXXXXXXX',
2566 ) or die "can't open temp file: $!\n";
2567 print $bh $gd->png or die "cannot write barcode to file: $!\n";
2568 my $png_file = $bh->filename;
2575 =item invnum_date_pretty
2577 Returns a string with the invoice number and date, for example:
2578 "Invoice #54 (3/20/2008)"
2582 sub invnum_date_pretty {
2584 $self->mt('Invoice #'). $self->invnum. ' ('. $self->_date_pretty. ')';
2587 #sub _items_extra_usage_sections {
2589 # my $escape = shift;
2591 # my %sections = ();
2593 # my %usage_class = map{ $_->classname, $_ } qsearch('usage_class', {});
2594 # foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2596 # next unless $cust_bill_pkg->pkgnum > 0;
2598 # foreach my $section ( keys %usage_class ) {
2600 # my $usage = $cust_bill_pkg->usage($section);
2602 # next unless $usage && $usage > 0;
2604 # $sections{$section} ||= 0;
2605 # $sections{$section} += $usage;
2611 # map { { 'description' => &{$escape}($_),
2612 # 'subtotal' => $sections{$_},
2613 # 'summarized' => '',
2614 # 'tax_section' => '',
2617 # sort {$usage_class{$a}->weight <=> $usage_class{$b}->weight} keys %sections;
2621 sub _items_extra_usage_sections {
2623 my $conf = $self->conf;
2631 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
2633 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
2634 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2635 next unless $cust_bill_pkg->pkgnum > 0;
2637 foreach my $classnum ( keys %usage_class ) {
2638 my $section = $usage_class{$classnum}->classname;
2639 $classnums{$section} = $classnum;
2641 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail($classnum) ) {
2642 my $amount = $detail->amount;
2643 next unless $amount && $amount > 0;
2645 $sections{$section} ||= { 'subtotal'=>0, 'calls'=>0, 'duration'=>0 };
2646 $sections{$section}{amount} += $amount; #subtotal
2647 $sections{$section}{calls}++;
2648 $sections{$section}{duration} += $detail->duration;
2650 my $desc = $detail->regionname;
2651 my $description = $desc;
2652 $description = substr($desc, 0, $maxlength). '...'
2653 if $format eq 'latex' && length($desc) > $maxlength;
2655 $lines{$section}{$desc} ||= {
2656 description => &{$escape}($description),
2657 #pkgpart => $part_pkg->pkgpart,
2658 pkgnum => $cust_bill_pkg->pkgnum,
2663 #unit_amount => $cust_bill_pkg->unitrecur,
2664 quantity => $cust_bill_pkg->quantity,
2665 product_code => 'N/A',
2666 ext_description => [],
2669 $lines{$section}{$desc}{amount} += $amount;
2670 $lines{$section}{$desc}{calls}++;
2671 $lines{$section}{$desc}{duration} += $detail->duration;
2677 my %sectionmap = ();
2678 foreach (keys %sections) {
2679 my $usage_class = $usage_class{$classnums{$_}};
2680 $sectionmap{$_} = { 'description' => &{$escape}($_),
2681 'amount' => $sections{$_}{amount}, #subtotal
2682 'calls' => $sections{$_}{calls},
2683 'duration' => $sections{$_}{duration},
2685 'tax_section' => '',
2686 'sort_weight' => $usage_class->weight,
2687 ( $usage_class->format
2688 ? ( map { $_ => $usage_class->$_($format) }
2689 qw( description_generator header_generator total_generator total_line_generator )
2696 my @sections = sort { $a->{sort_weight} <=> $b->{sort_weight} }
2700 foreach my $section ( keys %lines ) {
2701 foreach my $line ( keys %{$lines{$section}} ) {
2702 my $l = $lines{$section}{$line};
2703 $l->{section} = $sectionmap{$section};
2704 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2705 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
2710 return(\@sections, \@lines);
2716 my $end = $self->_date;
2718 # start at date of previous invoice + 1 second or 0 if no previous invoice
2719 my $start = $self->scalar_sql("SELECT max(_date) FROM cust_bill WHERE custnum = ? and invnum != ?",$self->custnum,$self->invnum);
2720 $start = 0 if !$start;
2723 my $cust_main = $self->cust_main;
2724 my @pkgs = $cust_main->all_pkgs;
2725 my($num_activated,$num_deactivated,$num_portedin,$num_portedout,$minutes)
2728 foreach my $pkg ( @pkgs ) {
2729 my @h_cust_svc = $pkg->h_cust_svc($end);
2730 foreach my $h_cust_svc ( @h_cust_svc ) {
2731 next if grep {$_ eq $h_cust_svc->svcnum} @seen;
2732 next unless $h_cust_svc->part_svc->svcdb eq 'svc_phone';
2734 my $inserted = $h_cust_svc->date_inserted;
2735 my $deleted = $h_cust_svc->date_deleted;
2736 my $phone_inserted = $h_cust_svc->h_svc_x($inserted+5);
2738 $phone_deleted = $h_cust_svc->h_svc_x($deleted) if $deleted;
2740 # DID either activated or ported in; cannot be both for same DID simultaneously
2741 if ($inserted >= $start && $inserted <= $end && $phone_inserted
2742 && (!$phone_inserted->lnp_status
2743 || $phone_inserted->lnp_status eq ''
2744 || $phone_inserted->lnp_status eq 'native')) {
2747 else { # this one not so clean, should probably move to (h_)svc_phone
2748 my $phone_portedin = qsearchs( 'h_svc_phone',
2749 { 'svcnum' => $h_cust_svc->svcnum,
2750 'lnp_status' => 'portedin' },
2751 FS::h_svc_phone->sql_h_searchs($end),
2753 $num_portedin++ if $phone_portedin;
2756 # DID either deactivated or ported out; cannot be both for same DID simultaneously
2757 if($deleted >= $start && $deleted <= $end && $phone_deleted
2758 && (!$phone_deleted->lnp_status
2759 || $phone_deleted->lnp_status ne 'portingout')) {
2762 elsif($deleted >= $start && $deleted <= $end && $phone_deleted
2763 && $phone_deleted->lnp_status
2764 && $phone_deleted->lnp_status eq 'portingout') {
2768 # increment usage minutes
2769 if ( $phone_inserted ) {
2770 my @cdrs = $phone_inserted->get_cdrs('begin'=>$start,'end'=>$end,'billsec_sum'=>1);
2771 $minutes = $cdrs[0]->billsec_sum if scalar(@cdrs) == 1;
2774 warn "WARNING: no matching h_svc_phone insert record for insert time $inserted, svcnum " . $h_cust_svc->svcnum;
2777 # don't look at this service again
2778 push @seen, $h_cust_svc->svcnum;
2782 $minutes = sprintf("%d", $minutes);
2783 ("Activated: $num_activated Ported-In: $num_portedin Deactivated: "
2784 . "$num_deactivated Ported-Out: $num_portedout ",
2785 "Total Minutes: $minutes");
2788 sub _items_accountcode_cdr {
2793 my $section = { 'amount' => 0,
2796 'sort_weight' => '',
2798 'description' => 'Usage by Account Code',
2804 my %accountcodes = ();
2806 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2807 next unless $cust_bill_pkg->pkgnum > 0;
2809 my @header = $cust_bill_pkg->details_header;
2810 next unless scalar(@header);
2811 $section->{'header'} = join(',',@header);
2813 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
2815 $section->{'header'} = $detail->formatted('format' => $format)
2816 if($detail->detail eq $section->{'header'});
2818 my $accountcode = $detail->accountcode;
2819 next unless $accountcode;
2821 my $amount = $detail->amount;
2822 next unless $amount && $amount > 0;
2824 $accountcodes{$accountcode} ||= {
2825 description => $accountcode,
2832 product_code => 'N/A',
2833 section => $section,
2834 ext_description => [ $section->{'header'} ],
2838 $section->{'amount'} += $amount;
2839 $accountcodes{$accountcode}{'amount'} += $amount;
2840 $accountcodes{$accountcode}{calls}++;
2841 $accountcodes{$accountcode}{duration} += $detail->duration;
2842 push @{$accountcodes{$accountcode}{detail_temp}}, $detail;
2846 foreach my $l ( values %accountcodes ) {
2847 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2848 my @sorted_detail = sort { $a->startdate <=> $b->startdate } @{$l->{detail_temp}};
2849 foreach my $sorted_detail ( @sorted_detail ) {
2850 push @{$l->{ext_description}}, $sorted_detail->formatted('format'=>$format);
2852 delete $l->{detail_temp};
2856 my @sorted_lines = sort { $a->{'description'} <=> $b->{'description'} } @lines;
2858 return ($section,\@sorted_lines);
2861 sub _items_svc_phone_sections {
2863 my $conf = $self->conf;
2871 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
2873 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
2874 $usage_class{''} ||= new FS::usage_class { 'classname' => '', 'weight' => 0 };
2876 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2877 next unless $cust_bill_pkg->pkgnum > 0;
2879 my @header = $cust_bill_pkg->details_header;
2880 next unless scalar(@header);
2882 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
2884 my $phonenum = $detail->phonenum;
2885 next unless $phonenum;
2887 my $amount = $detail->amount;
2888 next unless $amount && $amount > 0;
2890 $sections{$phonenum} ||= { 'amount' => 0,
2893 'sort_weight' => -1,
2894 'phonenum' => $phonenum,
2896 $sections{$phonenum}{amount} += $amount; #subtotal
2897 $sections{$phonenum}{calls}++;
2898 $sections{$phonenum}{duration} += $detail->duration;
2900 my $desc = $detail->regionname;
2901 my $description = $desc;
2902 $description = substr($desc, 0, $maxlength). '...'
2903 if $format eq 'latex' && length($desc) > $maxlength;
2905 $lines{$phonenum}{$desc} ||= {
2906 description => &{$escape}($description),
2907 #pkgpart => $part_pkg->pkgpart,
2915 product_code => 'N/A',
2916 ext_description => [],
2919 $lines{$phonenum}{$desc}{amount} += $amount;
2920 $lines{$phonenum}{$desc}{calls}++;
2921 $lines{$phonenum}{$desc}{duration} += $detail->duration;
2923 my $line = $usage_class{$detail->classnum}->classname;
2924 $sections{"$phonenum $line"} ||=
2928 'sort_weight' => $usage_class{$detail->classnum}->weight,
2929 'phonenum' => $phonenum,
2930 'header' => [ @header ],
2932 $sections{"$phonenum $line"}{amount} += $amount; #subtotal
2933 $sections{"$phonenum $line"}{calls}++;
2934 $sections{"$phonenum $line"}{duration} += $detail->duration;
2936 $lines{"$phonenum $line"}{$desc} ||= {
2937 description => &{$escape}($description),
2938 #pkgpart => $part_pkg->pkgpart,
2946 product_code => 'N/A',
2947 ext_description => [],
2950 $lines{"$phonenum $line"}{$desc}{amount} += $amount;
2951 $lines{"$phonenum $line"}{$desc}{calls}++;
2952 $lines{"$phonenum $line"}{$desc}{duration} += $detail->duration;
2953 push @{$lines{"$phonenum $line"}{$desc}{ext_description}},
2954 $detail->formatted('format' => $format);
2959 my %sectionmap = ();
2960 my $simple = new FS::usage_class { format => 'simple' }; #bleh
2961 foreach ( keys %sections ) {
2962 my @header = @{ $sections{$_}{header} || [] };
2964 new FS::usage_class { format => 'usage_'. (scalar(@header) || 6). 'col' };
2965 my $summary = $sections{$_}{sort_weight} < 0 ? 1 : 0;
2966 my $usage_class = $summary ? $simple : $usage_simple;
2967 my $ending = $summary ? ' usage charges' : '';
2970 $gen_opt{label} = [ map{ &{$escape}($_) } @header ];
2972 $sectionmap{$_} = { 'description' => &{$escape}($_. $ending),
2973 'amount' => $sections{$_}{amount}, #subtotal
2974 'calls' => $sections{$_}{calls},
2975 'duration' => $sections{$_}{duration},
2977 'tax_section' => '',
2978 'phonenum' => $sections{$_}{phonenum},
2979 'sort_weight' => $sections{$_}{sort_weight},
2980 'post_total' => $summary, #inspire pagebreak
2982 ( map { $_ => $usage_class->$_($format, %gen_opt) }
2983 qw( description_generator
2986 total_line_generator
2993 my @sections = sort { $a->{phonenum} cmp $b->{phonenum} ||
2994 $a->{sort_weight} <=> $b->{sort_weight}
2999 foreach my $section ( keys %lines ) {
3000 foreach my $line ( keys %{$lines{$section}} ) {
3001 my $l = $lines{$section}{$line};
3002 $l->{section} = $sectionmap{$section};
3003 $l->{amount} = sprintf( "%.2f", $l->{amount} );
3004 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
3009 if($conf->exists('phone_usage_class_summary')) {
3010 # this only works with Latex
3014 # after this, we'll have only two sections per DID:
3015 # Calls Summary and Calls Detail
3016 foreach my $section ( @sections ) {
3017 if($section->{'post_total'}) {
3018 $section->{'description'} = 'Calls Summary: '.$section->{'phonenum'};
3019 $section->{'total_line_generator'} = sub { '' };
3020 $section->{'total_generator'} = sub { '' };
3021 $section->{'header_generator'} = sub { '' };
3022 $section->{'description_generator'} = '';
3023 push @newsections, $section;
3024 my %calls_detail = %$section;
3025 $calls_detail{'post_total'} = '';
3026 $calls_detail{'sort_weight'} = '';
3027 $calls_detail{'description_generator'} = sub { '' };
3028 $calls_detail{'header_generator'} = sub {
3029 return ' & Date/Time & Called Number & Duration & Price'
3030 if $format eq 'latex';
3033 $calls_detail{'description'} = 'Calls Detail: '
3034 . $section->{'phonenum'};
3035 push @newsections, \%calls_detail;
3039 # after this, each usage class is collapsed/summarized into a single
3040 # line under the Calls Summary section
3041 foreach my $newsection ( @newsections ) {
3042 if($newsection->{'post_total'}) { # this means Calls Summary
3043 foreach my $section ( @sections ) {
3044 next unless ($section->{'phonenum'} eq $newsection->{'phonenum'}
3045 && !$section->{'post_total'});
3046 my $newdesc = $section->{'description'};
3047 my $tn = $section->{'phonenum'};
3048 $newdesc =~ s/$tn//g;
3049 my $line = { ext_description => [],
3053 calls => $section->{'calls'},
3054 section => $newsection,
3055 duration => $section->{'duration'},
3056 description => $newdesc,
3057 amount => sprintf("%.2f",$section->{'amount'}),
3058 product_code => 'N/A',
3060 push @newlines, $line;
3065 # after this, Calls Details is populated with all CDRs
3066 foreach my $newsection ( @newsections ) {
3067 if(!$newsection->{'post_total'}) { # this means Calls Details
3068 foreach my $line ( @lines ) {
3069 next unless (scalar(@{$line->{'ext_description'}}) &&
3070 $line->{'section'}->{'phonenum'} eq $newsection->{'phonenum'}
3072 my @extdesc = @{$line->{'ext_description'}};
3074 foreach my $extdesc ( @extdesc ) {
3075 $extdesc =~ s/scriptsize/normalsize/g if $format eq 'latex';
3076 push @newextdesc, $extdesc;
3078 $line->{'ext_description'} = \@newextdesc;
3079 $line->{'section'} = $newsection;
3080 push @newlines, $line;
3085 return(\@newsections, \@newlines);
3088 return(\@sections, \@lines);
3092 sub _items_previous {
3094 my $conf = $self->conf;
3095 my $cust_main = $self->cust_main;
3096 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
3098 foreach ( @pr_cust_bill ) {
3099 my $date = $conf->exists('invoice_show_prior_due_date')
3100 ? 'due '. $_->due_date2str($date_format)
3101 : time2str($date_format, $_->_date);
3103 'description' => $self->mt('Previous Balance, Invoice #'). $_->invnum. " ($date)",
3104 #'pkgpart' => 'N/A',
3106 'amount' => sprintf("%.2f", $_->owed),
3112 # 'description' => 'Previous Balance',
3113 # #'pkgpart' => 'N/A',
3114 # 'pkgnum' => 'N/A',
3115 # 'amount' => sprintf("%10.2f", $pr_total ),
3116 # 'ext_description' => [ map {
3117 # "Invoice ". $_->invnum.
3118 # " (". time2str("%x",$_->_date). ") ".
3119 # sprintf("%10.2f", $_->owed)
3120 # } @pr_cust_bill ],
3125 sub _items_credits {
3126 my( $self, %opt ) = @_;
3127 my $trim_len = $opt{'trim_len'} || 60;
3132 if ( $self->conf->exists('previous_balance-payments_since') ) {
3134 $date = $self->previous_bill->_date if $self->previous_bill;
3135 @objects = qsearch('cust_credit', {
3136 'custnum' => $self->custnum,
3137 '_date' => {op => '>=', value => $date},
3139 # hard to do this in the qsearch...
3140 @objects = grep { $_->_date < $self->_date } @objects;
3142 @objects = $self->cust_credited;
3145 foreach my $obj ( @objects ) {
3146 my $cust_credit = $obj->isa('FS::cust_credit') ? $obj : $obj->cust_credit;
3148 my $reason = substr($cust_credit->reason, 0, $trim_len);
3149 $reason .= '...' if length($reason) < length($cust_credit->reason);
3150 $reason = " ($reason) " if $reason;
3153 #'description' => 'Credit ref\#'. $_->crednum.
3154 # " (". time2str("%x",$_->cust_credit->_date) .")".
3156 'description' => $self->mt('Credit applied').' '.
3157 time2str($date_format,$obj->_date). $reason,
3158 'amount' => sprintf("%.2f",$obj->amount),
3166 sub _items_payments {
3170 my $detailed = $self->conf->exists('invoice_payment_details');
3172 if ( $self->conf->exists('previous_balance-payments_since') ) {
3174 $date = $self->previous_bill->_date if $self->previous_bill;
3175 @objects = qsearch('cust_pay', {
3176 'custnum' => $self->custnum,
3177 '_date' => {op => '>=', value => $date},
3179 @objects = grep { $_->_date < $self->_date } @objects;
3181 @objects = $self->cust_bill_pay;
3184 foreach my $obj (@objects) {
3185 my $cust_pay = $obj->isa('FS::cust_pay') ? $obj : $obj->cust_pay;
3186 my $desc = $self->mt('Payment received').' '.
3187 time2str($date_format, $cust_pay->_date );
3188 $desc .= $self->mt(' via ' . $cust_pay->payby_payinfo_pretty)
3192 'description' => $desc,
3193 'amount' => sprintf("%.2f", $obj->amount )
3201 =item call_details [ OPTION => VALUE ... ]
3203 Returns an array of CSV strings representing the call details for this invoice
3204 The only option available is the boolean prepend_billed_number
3209 my ($self, %opt) = @_;
3211 my $format_function = sub { shift };
3213 if ($opt{prepend_billed_number}) {
3214 $format_function = sub {
3218 $row->amount ? $row->phonenum. ",". $detail : '"Billed number",'. $detail;
3223 my @details = map { $_->details( 'format_function' => $format_function,
3224 'escape_function' => sub{ return() },
3228 $self->cust_bill_pkg;
3229 my $header = $details[0];
3230 ( $header, grep { $_ ne $header } @details );
3240 =item process_reprint
3244 sub process_reprint {
3245 process_re_X('print', @_);
3248 =item process_reemail
3252 sub process_reemail {
3253 process_re_X('email', @_);
3261 process_re_X('fax', @_);
3269 process_re_X('ftp', @_);
3276 sub process_respool {
3277 process_re_X('spool', @_);
3280 use Storable qw(thaw);
3284 my( $method, $job ) = ( shift, shift );
3285 warn "$me process_re_X $method for job $job\n" if $DEBUG;
3287 my $param = thaw(decode_base64(shift));
3288 warn Dumper($param) if $DEBUG;
3299 # spool_invoice ftp_invoice fax_invoice print_invoice
3300 my($method, $job, %param ) = @_;
3302 warn "re_X $method for job $job with param:\n".
3303 join( '', map { " $_ => ". $param{$_}. "\n" } keys %param );
3306 #some false laziness w/search/cust_bill.html
3308 my $orderby = 'ORDER BY cust_bill._date';
3310 my $extra_sql = ' WHERE '. FS::cust_bill->search_sql_where(\%param);
3312 my $addl_from = 'LEFT JOIN cust_main USING ( custnum )';
3314 my @cust_bill = qsearch( {
3315 #'select' => "cust_bill.*",
3316 'table' => 'cust_bill',
3317 'addl_from' => $addl_from,
3319 'extra_sql' => $extra_sql,
3320 'order_by' => $orderby,
3324 $method .= '_invoice' unless $method eq 'email' || $method eq 'print';
3326 warn " $me re_X $method: ". scalar(@cust_bill). " invoices found\n"
3329 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
3330 foreach my $cust_bill ( @cust_bill ) {
3331 $cust_bill->$method();
3333 if ( $job ) { #progressbar foo
3335 if ( time - $min_sec > $last ) {
3336 my $error = $job->update_statustext(
3337 int( 100 * $num / scalar(@cust_bill) )
3339 die $error if $error;
3350 =head1 CLASS METHODS
3356 Returns an SQL fragment to retreive the amount owed (charged minus credited and paid).
3361 my ($class, $start, $end) = @_;
3363 $class->paid_sql($start, $end). ' - '.
3364 $class->credited_sql($start, $end);
3369 Returns an SQL fragment to retreive the net amount (charged minus credited).
3374 my ($class, $start, $end) = @_;
3375 'charged - '. $class->credited_sql($start, $end);
3380 Returns an SQL fragment to retreive the amount paid against this invoice.
3385 my ($class, $start, $end) = @_;
3386 $start &&= "AND cust_bill_pay._date <= $start";
3387 $end &&= "AND cust_bill_pay._date > $end";
3388 $start = '' unless defined($start);
3389 $end = '' unless defined($end);
3390 "( SELECT COALESCE(SUM(amount),0) FROM cust_bill_pay
3391 WHERE cust_bill.invnum = cust_bill_pay.invnum $start $end )";
3396 Returns an SQL fragment to retreive the amount credited against this invoice.
3401 my ($class, $start, $end) = @_;
3402 $start &&= "AND cust_credit_bill._date <= $start";
3403 $end &&= "AND cust_credit_bill._date > $end";
3404 $start = '' unless defined($start);
3405 $end = '' unless defined($end);
3406 "( SELECT COALESCE(SUM(amount),0) FROM cust_credit_bill
3407 WHERE cust_bill.invnum = cust_credit_bill.invnum $start $end )";
3412 Returns an SQL fragment to retrieve the due date of an invoice.
3413 Currently only supported on PostgreSQL.
3418 my $conf = new FS::Conf;
3422 cust_bill.invoice_terms,
3423 cust_main.invoice_terms,
3424 \''.($conf->config('invoice_default_terms') || '').'\'
3425 ), E\'Net (\\\\d+)\'
3427 ) * 86400 + cust_bill._date'
3430 =item search_sql_where HASHREF
3432 Class method which returns an SQL WHERE fragment to search for parameters
3433 specified in HASHREF. Valid parameters are
3439 List reference of start date, end date, as UNIX timestamps.
3449 List reference of charged limits (exclusive).
3453 List reference of charged limits (exclusive).
3457 flag, return open invoices only
3461 flag, return net invoices only
3465 =item newest_percust
3469 Note: validates all passed-in data; i.e. safe to use with unchecked CGI params.
3473 sub search_sql_where {
3474 my($class, $param) = @_;
3476 warn "$me search_sql_where called with params: \n".
3477 join("\n", map { " $_: ". $param->{$_} } keys %$param ). "\n";
3483 if ( $param->{'agentnum'} =~ /^(\d+)$/ ) {
3484 push @search, "cust_main.agentnum = $1";
3488 if ( $param->{'refnum'} =~ /^(\d+)$/ ) {
3489 push @search, "cust_main.refnum = $1";
3493 if ( $param->{'custnum'} =~ /^(\d+)$/ ) {
3494 push @search, "cust_bill.custnum = $1";
3498 if ( $param->{'cust_classnum'} ) {
3499 my $classnums = $param->{'cust_classnum'};
3500 $classnums = [ $classnums ] if !ref($classnums);
3501 $classnums = [ grep /^\d+$/, @$classnums ];
3502 push @search, 'cust_main.classnum in ('.join(',',@$classnums).')'
3507 if ( $param->{_date} ) {
3508 my($beginning, $ending) = @{$param->{_date}};
3510 push @search, "cust_bill._date >= $beginning",
3511 "cust_bill._date < $ending";
3515 if ( $param->{'invnum_min'} =~ /^(\d+)$/ ) {
3516 push @search, "cust_bill.invnum >= $1";
3518 if ( $param->{'invnum_max'} =~ /^(\d+)$/ ) {
3519 push @search, "cust_bill.invnum <= $1";
3523 if ( $param->{charged} ) {
3524 my @charged = ref($param->{charged})
3525 ? @{ $param->{charged} }
3526 : ($param->{charged});
3528 push @search, map { s/^charged/cust_bill.charged/; $_; }
3532 my $owed_sql = FS::cust_bill->owed_sql;
3535 if ( $param->{owed} ) {
3536 my @owed = ref($param->{owed})
3537 ? @{ $param->{owed} }
3539 push @search, map { s/^owed/$owed_sql/; $_; }
3544 push @search, "0 != $owed_sql"
3545 if $param->{'open'};
3546 push @search, '0 != '. FS::cust_bill->net_sql
3550 push @search, "cust_bill._date < ". (time-86400*$param->{'days'})
3551 if $param->{'days'};
3554 if ( $param->{'newest_percust'} ) {
3556 #$distinct = 'DISTINCT ON ( cust_bill.custnum )';
3557 #$orderby = 'ORDER BY cust_bill.custnum ASC, cust_bill._date DESC';
3559 my @newest_where = map { my $x = $_;
3560 $x =~ s/\bcust_bill\./newest_cust_bill./g;
3563 grep ! /^cust_main./, @search;
3564 my $newest_where = scalar(@newest_where)
3565 ? ' AND '. join(' AND ', @newest_where)
3569 push @search, "cust_bill._date = (
3570 SELECT(MAX(newest_cust_bill._date)) FROM cust_bill AS newest_cust_bill
3571 WHERE newest_cust_bill.custnum = cust_bill.custnum
3577 #promised_date - also has an option to accept nulls
3578 if ( $param->{promised_date} ) {
3579 my($beginning, $ending, $null) = @{$param->{promised_date}};
3581 push @search, "(( cust_bill.promised_date >= $beginning AND ".
3582 "cust_bill.promised_date < $ending )" .
3583 ($null ? ' OR cust_bill.promised_date IS NULL ) ' : ')');
3586 #agent virtualization
3587 my $curuser = $FS::CurrentUser::CurrentUser;
3588 if ( $curuser->username eq 'fs_queue'
3589 && $param->{'CurrentUser'} =~ /^(\w+)$/ ) {
3591 my $newuser = qsearchs('access_user', {
3592 'username' => $username,
3596 $curuser = $newuser;
3598 warn "$me WARNING: (fs_queue) can't find CurrentUser $username\n";
3601 push @search, $curuser->agentnums_sql;
3603 join(' AND ', @search );
3615 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
3616 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base