5 use base qw( FS::otaker_Mixin FS::payinfo_Mixin FS::Record );
6 use vars qw( @EXPORT_OK $DEBUG $me $conf
8 $import $ignore_expired_card
9 $skip_fuzzyfiles @fuzzyfields
12 use vars qw( $realtime_bop_decline_quiet ); #ugh
16 use Scalar::Util qw( blessed );
17 use List::Util qw( min );
18 use Time::Local qw(timelocal);
19 use Storable qw(thaw);
23 use Digest::MD5 qw(md5_base64);
26 use File::Temp qw( tempfile );
27 use String::Approx qw(amatch);
28 use Business::CreditCard 0.28;
30 use FS::UID qw( getotaker dbh driver_name );
31 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
32 use FS::Misc qw( generate_email send_email generate_ps do_print );
33 use FS::Msgcat qw(gettext);
38 use FS::cust_bill_pkg;
39 use FS::cust_bill_pkg_display;
40 use FS::cust_bill_pkg_tax_location;
41 use FS::cust_bill_pkg_tax_rate_location;
43 use FS::cust_pay_pending;
44 use FS::cust_pay_void;
45 use FS::cust_pay_batch;
48 use FS::part_referral;
49 use FS::cust_main_county;
50 use FS::cust_location;
52 use FS::cust_main_exemption;
53 use FS::cust_tax_adjustment;
55 use FS::tax_rate_location;
56 use FS::cust_tax_location;
57 use FS::part_pkg_taxrate;
59 use FS::cust_main_invoice;
61 use FS::cust_credit_bill;
62 use FS::cust_bill_pay;
63 use FS::prepay_credit;
67 use FS::part_event_condition;
71 use FS::payment_gateway;
72 use FS::agent_payment_gateway;
76 @EXPORT_OK = qw( smart_search );
78 $realtime_bop_decline_quiet = 0;
80 # 1 is mostly method/subroutine entry and options
81 # 2 traces progress of some operations
82 # 3 is even more information including possibly sensitive data
84 $me = '[FS::cust_main]';
87 $ignore_expired_card = 0;
90 @fuzzyfields = ( 'first', 'last', 'company', 'address1' );
92 @encrypted_fields = ('payinfo', 'paycvv');
93 sub nohistory_fields { ('payinfo', 'paycvv'); }
95 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
97 #ask FS::UID to run this stuff for us later
98 #$FS::UID::callback{'FS::cust_main'} = sub {
99 install_callback FS::UID sub {
100 $conf = new FS::Conf;
101 #yes, need it for stuff below (prolly should be cached)
106 my ( $hashref, $cache ) = @_;
107 if ( exists $hashref->{'pkgnum'} ) {
108 #@{ $self->{'_pkgnum'} } = ();
109 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
110 $self->{'_pkgnum'} = $subcache;
111 #push @{ $self->{'_pkgnum'} },
112 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
118 FS::cust_main - Object methods for cust_main records
124 $record = new FS::cust_main \%hash;
125 $record = new FS::cust_main { 'column' => 'value' };
127 $error = $record->insert;
129 $error = $new_record->replace($old_record);
131 $error = $record->delete;
133 $error = $record->check;
135 @cust_pkg = $record->all_pkgs;
137 @cust_pkg = $record->ncancelled_pkgs;
139 @cust_pkg = $record->suspended_pkgs;
141 $error = $record->bill;
142 $error = $record->bill %options;
143 $error = $record->bill 'time' => $time;
145 $error = $record->collect;
146 $error = $record->collect %options;
147 $error = $record->collect 'invoice_time' => $time,
152 An FS::cust_main object represents a customer. FS::cust_main inherits from
153 FS::Record. The following fields are currently supported:
159 Primary key (assigned automatically for new customers)
163 Agent (see L<FS::agent>)
167 Advertising source (see L<FS::part_referral>)
179 Cocial security number (optional)
195 (optional, see L<FS::cust_main_county>)
199 (see L<FS::cust_main_county>)
205 (see L<FS::cust_main_county>)
241 (optional, see L<FS::cust_main_county>)
245 (see L<FS::cust_main_county>)
251 (see L<FS::cust_main_county>)
267 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
271 Payment Information (See L<FS::payinfo_Mixin> for data format)
275 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
279 Card Verification Value, "CVV2" (also known as CVC2 or CID), the 3 or 4 digit number on the back (or front, for American Express) of the credit card
283 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
287 Start date month (maestro/solo cards only)
291 Start date year (maestro/solo cards only)
295 Issue number (maestro/solo cards only)
299 Name on card or billing name
303 IP address from which payment information was received
307 Tax exempt, empty or `Y'
311 Order taker (see L<FS::access_user>)
317 =item referral_custnum
319 Referring customer number
323 Enable individual CDR spooling, empty or `Y'
327 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
331 Discourage individual CDR printing, empty or `Y'
341 Creates a new customer. To add the customer to the database, see L<"insert">.
343 Note that this stores the hash reference, not a distinct copy of the hash it
344 points to. You can ask the object for a copy with the I<hash> method.
348 sub table { 'cust_main'; }
350 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
352 Adds this customer to the database. If there is an error, returns the error,
353 otherwise returns false.
355 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
356 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
357 are inserted atomicly, or the transaction is rolled back. Passing an empty
358 hash reference is equivalent to not supplying this parameter. There should be
359 a better explanation of this, but until then, here's an example:
362 tie %hash, 'Tie::RefHash'; #this part is important
364 $cust_pkg => [ $svc_acct ],
367 $cust_main->insert( \%hash );
369 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
370 be set as the invoicing list (see L<"invoicing_list">). Errors return as
371 expected and rollback the entire transaction; it is not necessary to call
372 check_invoicing_list first. The invoicing_list is set after the records in the
373 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
374 invoicing_list destination to the newly-created svc_acct. Here's an example:
376 $cust_main->insert( {}, [ $email, 'POST' ] );
378 Currently available options are: I<depend_jobnum>, I<noexport> and I<tax_exemption>.
380 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
381 on the supplied jobnum (they will not run until the specific job completes).
382 This can be used to defer provisioning until some action completes (such
383 as running the customer's credit card successfully).
385 The I<noexport> option is deprecated. If I<noexport> is set true, no
386 provisioning jobs (exports) are scheduled. (You can schedule them later with
387 the B<reexport> method.)
389 The I<tax_exemption> option can be set to an arrayref of tax names.
390 FS::cust_main_exemption records will be created and inserted.
396 my $cust_pkgs = @_ ? shift : {};
397 my $invoicing_list = @_ ? shift : '';
399 warn "$me insert called with options ".
400 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
403 local $SIG{HUP} = 'IGNORE';
404 local $SIG{INT} = 'IGNORE';
405 local $SIG{QUIT} = 'IGNORE';
406 local $SIG{TERM} = 'IGNORE';
407 local $SIG{TSTP} = 'IGNORE';
408 local $SIG{PIPE} = 'IGNORE';
410 my $oldAutoCommit = $FS::UID::AutoCommit;
411 local $FS::UID::AutoCommit = 0;
414 my $prepay_identifier = '';
415 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
417 if ( $self->payby eq 'PREPAY' ) {
419 $self->payby('BILL');
420 $prepay_identifier = $self->payinfo;
423 warn " looking up prepaid card $prepay_identifier\n"
426 my $error = $self->get_prepay( $prepay_identifier,
427 'amount_ref' => \$amount,
428 'seconds_ref' => \$seconds,
429 'upbytes_ref' => \$upbytes,
430 'downbytes_ref' => \$downbytes,
431 'totalbytes_ref' => \$totalbytes,
434 $dbh->rollback if $oldAutoCommit;
435 #return "error applying prepaid card (transaction rolled back): $error";
439 $payby = 'PREP' if $amount;
441 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
444 $self->payby('BILL');
445 $amount = $self->paid;
449 warn " inserting $self\n"
452 $self->signupdate(time) unless $self->signupdate;
454 $self->auto_agent_custid()
455 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
457 my $error = $self->SUPER::insert;
459 $dbh->rollback if $oldAutoCommit;
460 #return "inserting cust_main record (transaction rolled back): $error";
464 warn " setting invoicing list\n"
467 if ( $invoicing_list ) {
468 $error = $self->check_invoicing_list( $invoicing_list );
470 $dbh->rollback if $oldAutoCommit;
471 #return "checking invoicing_list (transaction rolled back): $error";
474 $self->invoicing_list( $invoicing_list );
477 warn " setting customer tags\n"
480 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
481 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
482 'custnum' => $self->custnum };
483 my $error = $cust_tag->insert;
485 $dbh->rollback if $oldAutoCommit;
490 if ( $invoicing_list ) {
491 $error = $self->check_invoicing_list( $invoicing_list );
493 $dbh->rollback if $oldAutoCommit;
494 #return "checking invoicing_list (transaction rolled back): $error";
497 $self->invoicing_list( $invoicing_list );
501 warn " setting cust_main_exemption\n"
504 my $tax_exemption = delete $options{'tax_exemption'};
505 if ( $tax_exemption ) {
506 foreach my $taxname ( @$tax_exemption ) {
507 my $cust_main_exemption = new FS::cust_main_exemption {
508 'custnum' => $self->custnum,
509 'taxname' => $taxname,
511 my $error = $cust_main_exemption->insert;
513 $dbh->rollback if $oldAutoCommit;
514 return "inserting cust_main_exemption (transaction rolled back): $error";
519 if ( $conf->config('cust_main-skeleton_tables')
520 && $conf->config('cust_main-skeleton_custnum') ) {
522 warn " inserting skeleton records\n"
525 my $error = $self->start_copy_skel;
527 $dbh->rollback if $oldAutoCommit;
533 warn " ordering packages\n"
536 $error = $self->order_pkgs( $cust_pkgs,
538 'seconds_ref' => \$seconds,
539 'upbytes_ref' => \$upbytes,
540 'downbytes_ref' => \$downbytes,
541 'totalbytes_ref' => \$totalbytes,
544 $dbh->rollback if $oldAutoCommit;
549 $dbh->rollback if $oldAutoCommit;
550 return "No svc_acct record to apply pre-paid time";
552 if ( $upbytes || $downbytes || $totalbytes ) {
553 $dbh->rollback if $oldAutoCommit;
554 return "No svc_acct record to apply pre-paid data";
558 warn " inserting initial $payby payment of $amount\n"
560 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
562 $dbh->rollback if $oldAutoCommit;
563 return "inserting payment (transaction rolled back): $error";
567 unless ( $import || $skip_fuzzyfiles ) {
568 warn " queueing fuzzyfiles update\n"
570 $error = $self->queue_fuzzyfiles_update;
572 $dbh->rollback if $oldAutoCommit;
573 return "updating fuzzy search cache: $error";
578 warn " exporting\n" if $DEBUG > 1;
580 my $export_args = $options{'export_args'} || [];
583 map qsearch( 'part_export', {exportnum=>$_} ),
584 $conf->config('cust_main-exports'); #, $agentnum
586 foreach my $part_export ( @part_export ) {
587 my $error = $part_export->export_insert($self, @$export_args);
589 $dbh->rollback if $oldAutoCommit;
590 return "exporting to ". $part_export->exporttype.
591 " (transaction rolled back): $error";
595 #foreach my $depend_jobnum ( @$depend_jobnums ) {
596 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
598 # foreach my $jobnum ( @jobnums ) {
599 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
600 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
602 # my $error = $queue->depend_insert($depend_jobnum);
604 # $dbh->rollback if $oldAutoCommit;
605 # return "error queuing job dependancy: $error";
612 #if ( exists $options{'jobnums'} ) {
613 # push @{ $options{'jobnums'} }, @jobnums;
616 warn " insert complete; committing transaction\n"
619 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
624 use File::CounterFile;
625 sub auto_agent_custid {
628 my $format = $conf->config('cust_main-auto_agent_custid');
630 if ( $format eq '1YMMXXXXXXXX' ) {
632 my $counter = new File::CounterFile 'cust_main.agent_custid';
635 my $ym = 100000000000 + time2str('%y%m00000000', time);
636 if ( $ym > $counter->value ) {
637 $counter->{'value'} = $agent_custid = $ym;
638 $counter->{'updated'} = 1;
640 $agent_custid = $counter->inc;
646 die "Unknown cust_main-auto_agent_custid format: $format";
649 $self->agent_custid($agent_custid);
653 sub start_copy_skel {
656 #'mg_user_preference' => {},
657 #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
658 #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
659 #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
660 #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
661 my @tables = eval(join('\n',$conf->config('cust_main-skeleton_tables')));
664 _copy_skel( 'cust_main', #tablename
665 $conf->config('cust_main-skeleton_custnum'), #sourceid
666 $self->custnum, #destid
667 @tables, #child tables
671 #recursive subroutine, not a method
673 my( $table, $sourceid, $destid, %child_tables ) = @_;
676 if ( $table =~ /^(\w+)\.(\w+)$/ ) {
677 ( $table, $primary_key ) = ( $1, $2 );
679 my $dbdef_table = dbdef->table($table);
680 $primary_key = $dbdef_table->primary_key
681 or return "$table has no primary key".
682 " (or do you need to run dbdef-create?)";
685 warn " _copy_skel: $table.$primary_key $sourceid to $destid for ".
686 join (', ', keys %child_tables). "\n"
689 foreach my $child_table_def ( keys %child_tables ) {
693 if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
694 ( $child_table, $child_pkey ) = ( $1, $2 );
696 $child_table = $child_table_def;
698 $child_pkey = dbdef->table($child_table)->primary_key;
699 # or return "$table has no primary key".
700 # " (or do you need to run dbdef-create?)\n";
704 if ( keys %{ $child_tables{$child_table_def} } ) {
706 return "$child_table has no primary key".
707 " (run dbdef-create or try specifying it?)\n"
710 #false laziness w/Record::insert and only works on Pg
711 #refactor the proper last-inserted-id stuff out of Record::insert if this
712 # ever gets use for anything besides a quick kludge for one customer
713 my $default = dbdef->table($child_table)->column($child_pkey)->default;
714 $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
715 or return "can't parse $child_table.$child_pkey default value ".
716 " for sequence name: $default";
721 my @sel_columns = grep { $_ ne $primary_key }
722 dbdef->table($child_table)->columns;
723 my $sel_columns = join(', ', @sel_columns );
725 my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
726 my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
727 my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
729 my $sel_st = "SELECT $sel_columns FROM $child_table".
730 " WHERE $primary_key = $sourceid";
733 my $sel_sth = dbh->prepare( $sel_st )
734 or return dbh->errstr;
736 $sel_sth->execute or return $sel_sth->errstr;
738 while ( my $row = $sel_sth->fetchrow_hashref ) {
740 warn " selected row: ".
741 join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
745 "INSERT INTO $child_table $ins_columns VALUES $placeholders";
746 my $ins_sth =dbh->prepare($statement)
747 or return dbh->errstr;
748 my @param = ( $destid, map $row->{$_}, @ins_columns );
749 warn " $statement: [ ". join(', ', @param). " ]\n"
751 $ins_sth->execute( @param )
752 or return $ins_sth->errstr;
754 #next unless keys %{ $child_tables{$child_table} };
755 next unless $sequence;
757 #another section of that laziness
758 my $seq_sql = "SELECT currval('$sequence')";
759 my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
760 $seq_sth->execute or return $seq_sth->errstr;
761 my $insertid = $seq_sth->fetchrow_arrayref->[0];
763 # don't drink soap! recurse! recurse! okay!
765 _copy_skel( $child_table_def,
766 $row->{$child_pkey}, #sourceid
768 %{ $child_tables{$child_table_def} },
770 return $error if $error;
780 =item order_pkg HASHREF | OPTION => VALUE ...
782 Orders a single package.
784 Options may be passed as a list of key/value pairs or as a hash reference.
795 Optional FS::cust_location object
799 Optional arryaref of FS::svc_* service objects.
803 If this option is set to a job queue jobnum (see L<FS::queue>), all provisioning
804 jobs will have a dependancy on the supplied job (they will not run until the
805 specific job completes). This can be used to defer provisioning until some
806 action completes (such as running the customer's credit card successfully).
810 Optional subject for a ticket created and attached to this customer
814 Optional queue name for ticket additions
822 my $opt = ref($_[0]) ? shift : { @_ };
824 warn "$me order_pkg called with options ".
825 join(', ', map { "$_: $opt->{$_}" } keys %$opt ). "\n"
828 my $cust_pkg = $opt->{'cust_pkg'};
829 my $svcs = $opt->{'svcs'} || [];
831 my %svc_options = ();
832 $svc_options{'depend_jobnum'} = $opt->{'depend_jobnum'}
833 if exists($opt->{'depend_jobnum'}) && $opt->{'depend_jobnum'};
835 my %insert_params = map { $opt->{$_} ? ( $_ => $opt->{$_} ) : () }
836 qw( ticket_subject ticket_queue );
838 local $SIG{HUP} = 'IGNORE';
839 local $SIG{INT} = 'IGNORE';
840 local $SIG{QUIT} = 'IGNORE';
841 local $SIG{TERM} = 'IGNORE';
842 local $SIG{TSTP} = 'IGNORE';
843 local $SIG{PIPE} = 'IGNORE';
845 my $oldAutoCommit = $FS::UID::AutoCommit;
846 local $FS::UID::AutoCommit = 0;
849 if ( $opt->{'cust_location'} &&
850 ( ! $cust_pkg->locationnum || $cust_pkg->locationnum == -1 ) ) {
851 my $error = $opt->{'cust_location'}->insert;
853 $dbh->rollback if $oldAutoCommit;
854 return "inserting cust_location (transaction rolled back): $error";
856 $cust_pkg->locationnum($opt->{'cust_location'}->locationnum);
859 $cust_pkg->custnum( $self->custnum );
861 my $error = $cust_pkg->insert( %insert_params );
863 $dbh->rollback if $oldAutoCommit;
864 return "inserting cust_pkg (transaction rolled back): $error";
867 foreach my $svc_something ( @{ $opt->{'svcs'} } ) {
868 if ( $svc_something->svcnum ) {
869 my $old_cust_svc = $svc_something->cust_svc;
870 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
871 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
872 $error = $new_cust_svc->replace($old_cust_svc);
874 $svc_something->pkgnum( $cust_pkg->pkgnum );
875 if ( $svc_something->isa('FS::svc_acct') ) {
876 foreach ( grep { $opt->{$_.'_ref'} && ${ $opt->{$_.'_ref'} } }
877 qw( seconds upbytes downbytes totalbytes ) ) {
878 $svc_something->$_( $svc_something->$_() + ${ $opt->{$_.'_ref'} } );
879 ${ $opt->{$_.'_ref'} } = 0;
882 $error = $svc_something->insert(%svc_options);
885 $dbh->rollback if $oldAutoCommit;
886 return "inserting svc_ (transaction rolled back): $error";
890 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
895 #deprecated #=item order_pkgs HASHREF [ , SECONDSREF ] [ , OPTION => VALUE ... ]
896 =item order_pkgs HASHREF [ , OPTION => VALUE ... ]
898 Like the insert method on an existing record, this method orders multiple
899 packages and included services atomicaly. Pass a Tie::RefHash data structure
900 to this method containing FS::cust_pkg and FS::svc_I<tablename> objects.
901 There should be a better explanation of this, but until then, here's an
905 tie %hash, 'Tie::RefHash'; #this part is important
907 $cust_pkg => [ $svc_acct ],
910 $cust_main->order_pkgs( \%hash, 'noexport'=>1 );
912 Services can be new, in which case they are inserted, or existing unaudited
913 services, in which case they are linked to the newly-created package.
915 Currently available options are: I<depend_jobnum>, I<noexport>, I<seconds_ref>,
916 I<upbytes_ref>, I<downbytes_ref>, and I<totalbytes_ref>.
918 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
919 on the supplied jobnum (they will not run until the specific job completes).
920 This can be used to defer provisioning until some action completes (such
921 as running the customer's credit card successfully).
923 The I<noexport> option is deprecated. If I<noexport> is set true, no
924 provisioning jobs (exports) are scheduled. (You can schedule them later with
925 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
926 on the cust_main object is not recommended, as existing services will also be
929 If I<seconds_ref>, I<upbytes_ref>, I<downbytes_ref>, or I<totalbytes_ref> is
930 provided, the scalars (provided by references) will be incremented by the
931 values of the prepaid card.`
937 my $cust_pkgs = shift;
938 my $seconds_ref = ref($_[0]) ? shift : ''; #deprecated
940 $seconds_ref ||= $options{'seconds_ref'};
942 warn "$me order_pkgs called with options ".
943 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
946 local $SIG{HUP} = 'IGNORE';
947 local $SIG{INT} = 'IGNORE';
948 local $SIG{QUIT} = 'IGNORE';
949 local $SIG{TERM} = 'IGNORE';
950 local $SIG{TSTP} = 'IGNORE';
951 local $SIG{PIPE} = 'IGNORE';
953 my $oldAutoCommit = $FS::UID::AutoCommit;
954 local $FS::UID::AutoCommit = 0;
957 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
959 foreach my $cust_pkg ( keys %$cust_pkgs ) {
961 my $error = $self->order_pkg(
962 'cust_pkg' => $cust_pkg,
963 'svcs' => $cust_pkgs->{$cust_pkg},
964 'seconds_ref' => $seconds_ref,
965 map { $_ => $options{$_} } qw( upbytes_ref downbytes_ref totalbytes_ref
970 $dbh->rollback if $oldAutoCommit;
976 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
980 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
982 Recharges this (existing) customer with the specified prepaid card (see
983 L<FS::prepay_credit>), specified either by I<identifier> or as an
984 FS::prepay_credit object. If there is an error, returns the error, otherwise
987 Optionally, five scalar references can be passed as well. They will have their
988 values filled in with the amount, number of seconds, and number of upload,
989 download, and total bytes applied by this prepaid card.
993 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
994 #the only place that uses these args
995 sub recharge_prepay {
996 my( $self, $prepay_credit, $amountref, $secondsref,
997 $upbytesref, $downbytesref, $totalbytesref ) = @_;
999 local $SIG{HUP} = 'IGNORE';
1000 local $SIG{INT} = 'IGNORE';
1001 local $SIG{QUIT} = 'IGNORE';
1002 local $SIG{TERM} = 'IGNORE';
1003 local $SIG{TSTP} = 'IGNORE';
1004 local $SIG{PIPE} = 'IGNORE';
1006 my $oldAutoCommit = $FS::UID::AutoCommit;
1007 local $FS::UID::AutoCommit = 0;
1010 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
1012 my $error = $self->get_prepay( $prepay_credit,
1013 'amount_ref' => \$amount,
1014 'seconds_ref' => \$seconds,
1015 'upbytes_ref' => \$upbytes,
1016 'downbytes_ref' => \$downbytes,
1017 'totalbytes_ref' => \$totalbytes,
1019 || $self->increment_seconds($seconds)
1020 || $self->increment_upbytes($upbytes)
1021 || $self->increment_downbytes($downbytes)
1022 || $self->increment_totalbytes($totalbytes)
1023 || $self->insert_cust_pay_prepay( $amount,
1025 ? $prepay_credit->identifier
1030 $dbh->rollback if $oldAutoCommit;
1034 if ( defined($amountref) ) { $$amountref = $amount; }
1035 if ( defined($secondsref) ) { $$secondsref = $seconds; }
1036 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
1037 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
1038 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
1040 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1045 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
1047 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
1048 specified either by I<identifier> or as an FS::prepay_credit object.
1050 Available options are: I<amount_ref>, I<seconds_ref>, I<upbytes_ref>, I<downbytes_ref>, and I<totalbytes_ref>. The scalars (provided by references) will be
1051 incremented by the values of the prepaid card.
1053 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
1054 check or set this customer's I<agentnum>.
1056 If there is an error, returns the error, otherwise returns false.
1062 my( $self, $prepay_credit, %opt ) = @_;
1064 local $SIG{HUP} = 'IGNORE';
1065 local $SIG{INT} = 'IGNORE';
1066 local $SIG{QUIT} = 'IGNORE';
1067 local $SIG{TERM} = 'IGNORE';
1068 local $SIG{TSTP} = 'IGNORE';
1069 local $SIG{PIPE} = 'IGNORE';
1071 my $oldAutoCommit = $FS::UID::AutoCommit;
1072 local $FS::UID::AutoCommit = 0;
1075 unless ( ref($prepay_credit) ) {
1077 my $identifier = $prepay_credit;
1079 $prepay_credit = qsearchs(
1081 { 'identifier' => $prepay_credit },
1086 unless ( $prepay_credit ) {
1087 $dbh->rollback if $oldAutoCommit;
1088 return "Invalid prepaid card: ". $identifier;
1093 if ( $prepay_credit->agentnum ) {
1094 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
1095 $dbh->rollback if $oldAutoCommit;
1096 return "prepaid card not valid for agent ". $self->agentnum;
1098 $self->agentnum($prepay_credit->agentnum);
1101 my $error = $prepay_credit->delete;
1103 $dbh->rollback if $oldAutoCommit;
1104 return "removing prepay_credit (transaction rolled back): $error";
1107 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
1108 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
1110 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1115 =item increment_upbytes SECONDS
1117 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1118 the specified number of upbytes. If there is an error, returns the error,
1119 otherwise returns false.
1123 sub increment_upbytes {
1124 _increment_column( shift, 'upbytes', @_);
1127 =item increment_downbytes SECONDS
1129 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1130 the specified number of downbytes. If there is an error, returns the error,
1131 otherwise returns false.
1135 sub increment_downbytes {
1136 _increment_column( shift, 'downbytes', @_);
1139 =item increment_totalbytes SECONDS
1141 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1142 the specified number of totalbytes. If there is an error, returns the error,
1143 otherwise returns false.
1147 sub increment_totalbytes {
1148 _increment_column( shift, 'totalbytes', @_);
1151 =item increment_seconds SECONDS
1153 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1154 the specified number of seconds. If there is an error, returns the error,
1155 otherwise returns false.
1159 sub increment_seconds {
1160 _increment_column( shift, 'seconds', @_);
1163 =item _increment_column AMOUNT
1165 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1166 the specified number of seconds or bytes. If there is an error, returns
1167 the error, otherwise returns false.
1171 sub _increment_column {
1172 my( $self, $column, $amount ) = @_;
1173 warn "$me increment_column called: $column, $amount\n"
1176 return '' unless $amount;
1178 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1179 $self->ncancelled_pkgs;
1181 if ( ! @cust_pkg ) {
1182 return 'No packages with primary or single services found'.
1183 ' to apply pre-paid time';
1184 } elsif ( scalar(@cust_pkg) > 1 ) {
1185 #maybe have a way to specify the package/account?
1186 return 'Multiple packages found to apply pre-paid time';
1189 my $cust_pkg = $cust_pkg[0];
1190 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1194 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1196 if ( ! @cust_svc ) {
1197 return 'No account found to apply pre-paid time';
1198 } elsif ( scalar(@cust_svc) > 1 ) {
1199 return 'Multiple accounts found to apply pre-paid time';
1202 my $svc_acct = $cust_svc[0]->svc_x;
1203 warn " found service svcnum ". $svc_acct->pkgnum.
1204 ' ('. $svc_acct->email. ")\n"
1207 $column = "increment_$column";
1208 $svc_acct->$column($amount);
1212 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1214 Inserts a prepayment in the specified amount for this customer. An optional
1215 second argument can specify the prepayment identifier for tracking purposes.
1216 If there is an error, returns the error, otherwise returns false.
1220 sub insert_cust_pay_prepay {
1221 shift->insert_cust_pay('PREP', @_);
1224 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1226 Inserts a cash payment in the specified amount for this customer. An optional
1227 second argument can specify the payment identifier for tracking purposes.
1228 If there is an error, returns the error, otherwise returns false.
1232 sub insert_cust_pay_cash {
1233 shift->insert_cust_pay('CASH', @_);
1236 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1238 Inserts a Western Union payment in the specified amount for this customer. An
1239 optional second argument can specify the prepayment identifier for tracking
1240 purposes. If there is an error, returns the error, otherwise returns false.
1244 sub insert_cust_pay_west {
1245 shift->insert_cust_pay('WEST', @_);
1248 sub insert_cust_pay {
1249 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1250 my $payinfo = scalar(@_) ? shift : '';
1252 my $cust_pay = new FS::cust_pay {
1253 'custnum' => $self->custnum,
1254 'paid' => sprintf('%.2f', $amount),
1255 #'_date' => #date the prepaid card was purchased???
1257 'payinfo' => $payinfo,
1265 This method is deprecated. See the I<depend_jobnum> option to the insert and
1266 order_pkgs methods for a better way to defer provisioning.
1268 Re-schedules all exports by calling the B<reexport> method of all associated
1269 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
1270 otherwise returns false.
1277 carp "WARNING: FS::cust_main::reexport is deprectated; ".
1278 "use the depend_jobnum option to insert or order_pkgs to delay export";
1280 local $SIG{HUP} = 'IGNORE';
1281 local $SIG{INT} = 'IGNORE';
1282 local $SIG{QUIT} = 'IGNORE';
1283 local $SIG{TERM} = 'IGNORE';
1284 local $SIG{TSTP} = 'IGNORE';
1285 local $SIG{PIPE} = 'IGNORE';
1287 my $oldAutoCommit = $FS::UID::AutoCommit;
1288 local $FS::UID::AutoCommit = 0;
1291 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1292 my $error = $cust_pkg->reexport;
1294 $dbh->rollback if $oldAutoCommit;
1299 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1304 =item delete [ OPTION => VALUE ... ]
1306 This deletes the customer. If there is an error, returns the error, otherwise
1309 This will completely remove all traces of the customer record. This is not
1310 what you want when a customer cancels service; for that, cancel all of the
1311 customer's packages (see L</cancel>).
1313 If the customer has any uncancelled packages, you need to pass a new (valid)
1314 customer number for those packages to be transferred to, as the "new_customer"
1315 option. Cancelled packages will be deleted. Did I mention that this is NOT
1316 what you want when a customer cancels service and that you really should be
1317 looking at L<FS::cust_pkg/cancel>?
1319 You can't delete a customer with invoices (see L<FS::cust_bill>),
1320 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1321 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1322 set the "delete_financials" option to a true value.
1327 my( $self, %opt ) = @_;
1329 local $SIG{HUP} = 'IGNORE';
1330 local $SIG{INT} = 'IGNORE';
1331 local $SIG{QUIT} = 'IGNORE';
1332 local $SIG{TERM} = 'IGNORE';
1333 local $SIG{TSTP} = 'IGNORE';
1334 local $SIG{PIPE} = 'IGNORE';
1336 my $oldAutoCommit = $FS::UID::AutoCommit;
1337 local $FS::UID::AutoCommit = 0;
1340 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1341 $dbh->rollback if $oldAutoCommit;
1342 return "Can't delete a master agent customer";
1345 #use FS::access_user
1346 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1347 $dbh->rollback if $oldAutoCommit;
1348 return "Can't delete a master employee customer";
1351 tie my %financial_tables, 'Tie::IxHash',
1352 'cust_bill' => 'invoices',
1353 'cust_statement' => 'statements',
1354 'cust_credit' => 'credits',
1355 'cust_pay' => 'payments',
1356 'cust_refund' => 'refunds',
1359 foreach my $table ( keys %financial_tables ) {
1361 my @records = $self->$table();
1363 if ( @records && ! $opt{'delete_financials'} ) {
1364 $dbh->rollback if $oldAutoCommit;
1365 return "Can't delete a customer with ". $financial_tables{$table};
1368 foreach my $record ( @records ) {
1369 my $error = $record->delete;
1371 $dbh->rollback if $oldAutoCommit;
1372 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1378 my @cust_pkg = $self->ncancelled_pkgs;
1380 my $new_custnum = $opt{'new_custnum'};
1381 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1382 $dbh->rollback if $oldAutoCommit;
1383 return "Invalid new customer number: $new_custnum";
1385 foreach my $cust_pkg ( @cust_pkg ) {
1386 my %hash = $cust_pkg->hash;
1387 $hash{'custnum'} = $new_custnum;
1388 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1389 my $error = $new_cust_pkg->replace($cust_pkg,
1390 options => { $cust_pkg->options },
1393 $dbh->rollback if $oldAutoCommit;
1398 my @cancelled_cust_pkg = $self->all_pkgs;
1399 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1400 my $error = $cust_pkg->delete;
1402 $dbh->rollback if $oldAutoCommit;
1407 #cust_tax_adjustment in financials?
1408 #cust_pay_pending? ouch
1410 foreach my $table (qw(
1411 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1412 cust_location cust_main_note cust_tax_adjustment
1413 cust_pay_void cust_pay_batch queue cust_tax_exempt
1415 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1416 my $error = $record->delete;
1418 $dbh->rollback if $oldAutoCommit;
1424 my $sth = $dbh->prepare(
1425 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1427 my $errstr = $dbh->errstr;
1428 $dbh->rollback if $oldAutoCommit;
1431 $sth->execute($self->custnum) or do {
1432 my $errstr = $sth->errstr;
1433 $dbh->rollback if $oldAutoCommit;
1439 my $ticket_dbh = '';
1440 if ($conf->config('ticket_system') eq 'RT_Internal') {
1442 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1443 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1444 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1445 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1448 if ( $ticket_dbh ) {
1450 my $ticket_sth = $ticket_dbh->prepare(
1451 'DELETE FROM Links WHERE Target = ?'
1453 my $errstr = $ticket_dbh->errstr;
1454 $dbh->rollback if $oldAutoCommit;
1457 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1459 my $errstr = $ticket_sth->errstr;
1460 $dbh->rollback if $oldAutoCommit;
1464 #check and see if the customer is the only link on the ticket, and
1465 #if so, set the ticket to deleted status in RT?
1466 #maybe someday, for now this will at least fix tickets not displaying
1470 #delete the customer record
1472 my $error = $self->SUPER::delete;
1474 $dbh->rollback if $oldAutoCommit;
1478 # cust_main exports!
1480 #my $export_args = $options{'export_args'} || [];
1483 map qsearch( 'part_export', {exportnum=>$_} ),
1484 $conf->config('cust_main-exports'); #, $agentnum
1486 foreach my $part_export ( @part_export ) {
1487 my $error = $part_export->export_delete( $self ); #, @$export_args);
1489 $dbh->rollback if $oldAutoCommit;
1490 return "exporting to ". $part_export->exporttype.
1491 " (transaction rolled back): $error";
1495 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1500 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1503 Replaces the OLD_RECORD with this one in the database. If there is an error,
1504 returns the error, otherwise returns false.
1506 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1507 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1508 expected and rollback the entire transaction; it is not necessary to call
1509 check_invoicing_list first. Here's an example:
1511 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1513 Currently available options are: I<tax_exemption>.
1515 The I<tax_exemption> option can be set to an arrayref of tax names.
1516 FS::cust_main_exemption records will be deleted and inserted as appropriate.
1523 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1525 : $self->replace_old;
1529 warn "$me replace called\n"
1532 my $curuser = $FS::CurrentUser::CurrentUser;
1533 if ( $self->payby eq 'COMP'
1534 && $self->payby ne $old->payby
1535 && ! $curuser->access_right('Complimentary customer')
1538 return "You are not permitted to create complimentary accounts.";
1541 local($ignore_expired_card) = 1
1542 if $old->payby =~ /^(CARD|DCRD)$/
1543 && $self->payby =~ /^(CARD|DCRD)$/
1544 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1546 local $SIG{HUP} = 'IGNORE';
1547 local $SIG{INT} = 'IGNORE';
1548 local $SIG{QUIT} = 'IGNORE';
1549 local $SIG{TERM} = 'IGNORE';
1550 local $SIG{TSTP} = 'IGNORE';
1551 local $SIG{PIPE} = 'IGNORE';
1553 my $oldAutoCommit = $FS::UID::AutoCommit;
1554 local $FS::UID::AutoCommit = 0;
1557 my $error = $self->SUPER::replace($old);
1560 $dbh->rollback if $oldAutoCommit;
1564 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1565 my $invoicing_list = shift @param;
1566 $error = $self->check_invoicing_list( $invoicing_list );
1568 $dbh->rollback if $oldAutoCommit;
1571 $self->invoicing_list( $invoicing_list );
1574 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1576 #this could be more efficient than deleting and re-inserting, if it matters
1577 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1578 my $error = $cust_tag->delete;
1580 $dbh->rollback if $oldAutoCommit;
1584 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1585 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1586 'custnum' => $self->custnum };
1587 my $error = $cust_tag->insert;
1589 $dbh->rollback if $oldAutoCommit;
1596 my %options = @param;
1598 my $tax_exemption = delete $options{'tax_exemption'};
1599 if ( $tax_exemption ) {
1601 my %cust_main_exemption =
1602 map { $_->taxname => $_ }
1603 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1605 foreach my $taxname ( @$tax_exemption ) {
1607 next if delete $cust_main_exemption{$taxname};
1609 my $cust_main_exemption = new FS::cust_main_exemption {
1610 'custnum' => $self->custnum,
1611 'taxname' => $taxname,
1613 my $error = $cust_main_exemption->insert;
1615 $dbh->rollback if $oldAutoCommit;
1616 return "inserting cust_main_exemption (transaction rolled back): $error";
1620 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1621 my $error = $cust_main_exemption->delete;
1623 $dbh->rollback if $oldAutoCommit;
1624 return "deleting cust_main_exemption (transaction rolled back): $error";
1630 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1631 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1632 && $self->get('payinfo') !~ /^99\d{14}$/
1634 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1639 # card/check/lec info has changed, want to retry realtime_ invoice events
1640 my $error = $self->retry_realtime;
1642 $dbh->rollback if $oldAutoCommit;
1647 unless ( $import || $skip_fuzzyfiles ) {
1648 $error = $self->queue_fuzzyfiles_update;
1650 $dbh->rollback if $oldAutoCommit;
1651 return "updating fuzzy search cache: $error";
1655 # cust_main exports!
1657 my $export_args = $options{'export_args'} || [];
1660 map qsearch( 'part_export', {exportnum=>$_} ),
1661 $conf->config('cust_main-exports'); #, $agentnum
1663 foreach my $part_export ( @part_export ) {
1664 my $error = $part_export->export_replace( $self, $old, @$export_args);
1666 $dbh->rollback if $oldAutoCommit;
1667 return "exporting to ". $part_export->exporttype.
1668 " (transaction rolled back): $error";
1672 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1677 =item queue_fuzzyfiles_update
1679 Used by insert & replace to update the fuzzy search cache
1683 sub queue_fuzzyfiles_update {
1686 local $SIG{HUP} = 'IGNORE';
1687 local $SIG{INT} = 'IGNORE';
1688 local $SIG{QUIT} = 'IGNORE';
1689 local $SIG{TERM} = 'IGNORE';
1690 local $SIG{TSTP} = 'IGNORE';
1691 local $SIG{PIPE} = 'IGNORE';
1693 my $oldAutoCommit = $FS::UID::AutoCommit;
1694 local $FS::UID::AutoCommit = 0;
1697 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1698 my $error = $queue->insert( map $self->getfield($_), @fuzzyfields );
1700 $dbh->rollback if $oldAutoCommit;
1701 return "queueing job (transaction rolled back): $error";
1704 if ( $self->ship_last ) {
1705 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1706 $error = $queue->insert( map $self->getfield("ship_$_"), @fuzzyfields );
1708 $dbh->rollback if $oldAutoCommit;
1709 return "queueing job (transaction rolled back): $error";
1713 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1720 Checks all fields to make sure this is a valid customer record. If there is
1721 an error, returns the error, otherwise returns false. Called by the insert
1722 and replace methods.
1729 warn "$me check BEFORE: \n". $self->_dump
1733 $self->ut_numbern('custnum')
1734 || $self->ut_number('agentnum')
1735 || $self->ut_textn('agent_custid')
1736 || $self->ut_number('refnum')
1737 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1738 || $self->ut_textn('custbatch')
1739 || $self->ut_name('last')
1740 || $self->ut_name('first')
1741 || $self->ut_snumbern('birthdate')
1742 || $self->ut_snumbern('signupdate')
1743 || $self->ut_textn('company')
1744 || $self->ut_text('address1')
1745 || $self->ut_textn('address2')
1746 || $self->ut_text('city')
1747 || $self->ut_textn('county')
1748 || $self->ut_textn('state')
1749 || $self->ut_country('country')
1750 || $self->ut_anything('comments')
1751 || $self->ut_numbern('referral_custnum')
1752 || $self->ut_textn('stateid')
1753 || $self->ut_textn('stateid_state')
1754 || $self->ut_textn('invoice_terms')
1755 || $self->ut_alphan('geocode')
1756 || $self->ut_floatn('cdr_termination_percentage')
1759 #barf. need message catalogs. i18n. etc.
1760 $error .= "Please select an advertising source."
1761 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1762 return $error if $error;
1764 return "Unknown agent"
1765 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1767 return "Unknown refnum"
1768 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1770 return "Unknown referring custnum: ". $self->referral_custnum
1771 unless ! $self->referral_custnum
1772 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1774 if ( $self->censustract ne '' ) {
1775 $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
1776 or return "Illegal census tract: ". $self->censustract;
1778 $self->censustract("$1.$2");
1781 if ( $self->ss eq '' ) {
1786 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1787 or return "Illegal social security number: ". $self->ss;
1788 $self->ss("$1-$2-$3");
1792 # bad idea to disable, causes billing to fail because of no tax rates later
1793 # unless ( $import ) {
1794 unless ( qsearch('cust_main_county', {
1795 'country' => $self->country,
1798 return "Unknown state/county/country: ".
1799 $self->state. "/". $self->county. "/". $self->country
1800 unless qsearch('cust_main_county',{
1801 'state' => $self->state,
1802 'county' => $self->county,
1803 'country' => $self->country,
1809 $self->ut_phonen('daytime', $self->country)
1810 || $self->ut_phonen('night', $self->country)
1811 || $self->ut_phonen('fax', $self->country)
1812 || $self->ut_zip('zip', $self->country)
1814 return $error if $error;
1816 if ( $conf->exists('cust_main-require_phone')
1817 && ! length($self->daytime) && ! length($self->night)
1820 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1822 : FS::Msgcat::_gettext('daytime');
1823 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1825 : FS::Msgcat::_gettext('night');
1827 return "$daytime_label or $night_label is required"
1831 if ( $self->has_ship_address
1832 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1833 $self->addr_fields )
1837 $self->ut_name('ship_last')
1838 || $self->ut_name('ship_first')
1839 || $self->ut_textn('ship_company')
1840 || $self->ut_text('ship_address1')
1841 || $self->ut_textn('ship_address2')
1842 || $self->ut_text('ship_city')
1843 || $self->ut_textn('ship_county')
1844 || $self->ut_textn('ship_state')
1845 || $self->ut_country('ship_country')
1847 return $error if $error;
1849 #false laziness with above
1850 unless ( qsearchs('cust_main_county', {
1851 'country' => $self->ship_country,
1854 return "Unknown ship_state/ship_county/ship_country: ".
1855 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1856 unless qsearch('cust_main_county',{
1857 'state' => $self->ship_state,
1858 'county' => $self->ship_county,
1859 'country' => $self->ship_country,
1865 $self->ut_phonen('ship_daytime', $self->ship_country)
1866 || $self->ut_phonen('ship_night', $self->ship_country)
1867 || $self->ut_phonen('ship_fax', $self->ship_country)
1868 || $self->ut_zip('ship_zip', $self->ship_country)
1870 return $error if $error;
1872 return "Unit # is required."
1873 if $self->ship_address2 =~ /^\s*$/
1874 && $conf->exists('cust_main-require_address2');
1876 } else { # ship_ info eq billing info, so don't store dup info in database
1878 $self->setfield("ship_$_", '')
1879 foreach $self->addr_fields;
1881 return "Unit # is required."
1882 if $self->address2 =~ /^\s*$/
1883 && $conf->exists('cust_main-require_address2');
1887 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1888 # or return "Illegal payby: ". $self->payby;
1890 FS::payby->can_payby($self->table, $self->payby)
1891 or return "Illegal payby: ". $self->payby;
1893 $error = $self->ut_numbern('paystart_month')
1894 || $self->ut_numbern('paystart_year')
1895 || $self->ut_numbern('payissue')
1896 || $self->ut_textn('paytype')
1898 return $error if $error;
1900 if ( $self->payip eq '' ) {
1903 $error = $self->ut_ip('payip');
1904 return $error if $error;
1907 # If it is encrypted and the private key is not availaible then we can't
1908 # check the credit card.
1909 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1911 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1913 my $payinfo = $self->payinfo;
1914 $payinfo =~ s/\D//g;
1915 $payinfo =~ /^(\d{13,16})$/
1916 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1918 $self->payinfo($payinfo);
1920 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1922 return gettext('unknown_card_type')
1923 if $self->payinfo !~ /^99\d{14}$/ #token
1924 && cardtype($self->payinfo) eq "Unknown";
1926 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1928 return 'Banned credit card: banned on '.
1929 time2str('%a %h %o at %r', $ban->_date).
1930 ' by '. $ban->otaker.
1931 ' (ban# '. $ban->bannum. ')';
1934 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1935 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1936 $self->paycvv =~ /^(\d{4})$/
1937 or return "CVV2 (CID) for American Express cards is four digits.";
1940 $self->paycvv =~ /^(\d{3})$/
1941 or return "CVV2 (CVC2/CID) is three digits.";
1948 my $cardtype = cardtype($payinfo);
1949 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1951 return "Start date or issue number is required for $cardtype cards"
1952 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1954 return "Start month must be between 1 and 12"
1955 if $self->paystart_month
1956 and $self->paystart_month < 1 || $self->paystart_month > 12;
1958 return "Start year must be 1990 or later"
1959 if $self->paystart_year
1960 and $self->paystart_year < 1990;
1962 return "Issue number must be beween 1 and 99"
1964 and $self->payissue < 1 || $self->payissue > 99;
1967 $self->paystart_month('');
1968 $self->paystart_year('');
1969 $self->payissue('');
1972 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1974 my $payinfo = $self->payinfo;
1975 $payinfo =~ s/[^\d\@]//g;
1976 if ( $conf->exists('echeck-nonus') ) {
1977 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1978 $payinfo = "$1\@$2";
1980 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1981 $payinfo = "$1\@$2";
1983 $self->payinfo($payinfo);
1986 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1988 return 'Banned ACH account: banned on '.
1989 time2str('%a %h %o at %r', $ban->_date).
1990 ' by '. $ban->otaker.
1991 ' (ban# '. $ban->bannum. ')';
1994 } elsif ( $self->payby eq 'LECB' ) {
1996 my $payinfo = $self->payinfo;
1997 $payinfo =~ s/\D//g;
1998 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
2000 $self->payinfo($payinfo);
2003 } elsif ( $self->payby eq 'BILL' ) {
2005 $error = $self->ut_textn('payinfo');
2006 return "Illegal P.O. number: ". $self->payinfo if $error;
2009 } elsif ( $self->payby eq 'COMP' ) {
2011 my $curuser = $FS::CurrentUser::CurrentUser;
2012 if ( ! $self->custnum
2013 && ! $curuser->access_right('Complimentary customer')
2016 return "You are not permitted to create complimentary accounts."
2019 $error = $self->ut_textn('payinfo');
2020 return "Illegal comp account issuer: ". $self->payinfo if $error;
2023 } elsif ( $self->payby eq 'PREPAY' ) {
2025 my $payinfo = $self->payinfo;
2026 $payinfo =~ s/\W//g; #anything else would just confuse things
2027 $self->payinfo($payinfo);
2028 $error = $self->ut_alpha('payinfo');
2029 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2030 return "Unknown prepayment identifier"
2031 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2036 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2037 return "Expiration date required"
2038 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
2042 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2043 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2044 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2045 ( $m, $y ) = ( $2, "19$1" );
2046 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2047 ( $m, $y ) = ( $3, "20$2" );
2049 return "Illegal expiration date: ". $self->paydate;
2051 $self->paydate("$y-$m-01");
2052 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2053 return gettext('expired_card')
2055 && !$ignore_expired_card
2056 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2059 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2060 ( ! $conf->exists('require_cardname')
2061 || $self->payby !~ /^(CARD|DCRD)$/ )
2063 $self->payname( $self->first. " ". $self->getfield('last') );
2065 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
2066 or return gettext('illegal_name'). " payname: ". $self->payname;
2070 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2071 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2075 $self->otaker(getotaker) unless $self->otaker;
2077 warn "$me check AFTER: \n". $self->_dump
2080 $self->SUPER::check;
2085 Returns a list of fields which have ship_ duplicates.
2090 qw( last first company
2091 address1 address2 city county state zip country
2096 =item has_ship_address
2098 Returns true if this customer record has a separate shipping address.
2102 sub has_ship_address {
2104 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
2109 Returns a list of key/value pairs, with the following keys: address1, adddress2,
2110 city, county, state, zip, country. The shipping address is used if present.
2114 #geocode? dependent on tax-ship_address config, not available in cust_location
2115 #mostly. not yet then.
2119 my $prefix = $self->has_ship_address ? 'ship_' : '';
2121 map { $_ => $self->get($prefix.$_) }
2122 qw( address1 address2 city county state zip country geocode );
2123 #fields that cust_location has
2126 =item all_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
2128 Returns all packages (see L<FS::cust_pkg>) for this customer.
2134 my $extra_qsearch = ref($_[0]) ? shift : {};
2136 return $self->num_pkgs unless wantarray || keys(%$extra_qsearch);
2139 if ( $self->{'_pkgnum'} ) {
2140 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
2142 @cust_pkg = $self->_cust_pkg($extra_qsearch);
2145 sort sort_packages @cust_pkg;
2150 Synonym for B<all_pkgs>.
2155 shift->all_pkgs(@_);
2160 Returns all locations (see L<FS::cust_location>) for this customer.
2166 qsearch('cust_location', { 'custnum' => $self->custnum } );
2169 =item location_label [ OPTION => VALUE ... ]
2171 Returns the label of the service location (see analog in L<FS::cust_location>) for this customer.
2179 used to separate the address elements (defaults to ', ')
2181 =item escape_function
2183 a callback used for escaping the text of the address elements
2189 # false laziness with FS::cust_location::line
2191 sub location_label {
2195 my $separator = $opt{join_string} || ', ';
2196 my $escape = $opt{escape_function} || sub{ shift };
2198 my $cydefault = FS::conf->new->config('countrydefault') || 'US';
2199 my $prefix = length($self->ship_last) ? 'ship_' : '';
2202 foreach (qw ( address1 address2 ) ) {
2203 my $method = "$prefix$_";
2204 $line .= ($notfirst ? $separator : ''). &$escape($self->$method)
2209 foreach (qw ( city county state zip ) ) {
2210 my $method = "$prefix$_";
2211 if ( $self->$method ) {
2212 $line .= ' (' if $method eq 'county';
2213 $line .= ($notfirst ? ' ' : $separator). &$escape($self->$method);
2214 $line .= ' )' if $method eq 'county';
2218 $line .= $separator. &$escape(code2country($self->country))
2219 if $self->country ne $cydefault;
2224 =item ncancelled_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
2226 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
2230 sub ncancelled_pkgs {
2232 my $extra_qsearch = ref($_[0]) ? shift : {};
2234 return $self->num_ncancelled_pkgs unless wantarray;
2237 if ( $self->{'_pkgnum'} ) {
2239 warn "$me ncancelled_pkgs: returning cached objects"
2242 @cust_pkg = grep { ! $_->getfield('cancel') }
2243 values %{ $self->{'_pkgnum'}->cache };
2247 warn "$me ncancelled_pkgs: searching for packages with custnum ".
2248 $self->custnum. "\n"
2251 $extra_qsearch->{'extra_sql'} .= ' AND ( cancel IS NULL OR cancel = 0 ) ';
2253 @cust_pkg = $self->_cust_pkg($extra_qsearch);
2257 sort sort_packages @cust_pkg;
2263 my $extra_qsearch = ref($_[0]) ? shift : {};
2265 $extra_qsearch->{'select'} ||= '*';
2266 $extra_qsearch->{'select'} .=
2267 ',( SELECT COUNT(*) FROM cust_svc WHERE cust_pkg.pkgnum = cust_svc.pkgnum )
2271 $_->{'_num_cust_svc'} = $_->get('_num_cust_svc');
2276 'table' => 'cust_pkg',
2277 'hashref' => { 'custnum' => $self->custnum },
2282 # This should be generalized to use config options to determine order.
2285 my $locationsort = ( $a->locationnum || 0 ) <=> ( $b->locationnum || 0 );
2286 return $locationsort if $locationsort;
2288 if ( $a->get('cancel') xor $b->get('cancel') ) {
2289 return -1 if $b->get('cancel');
2290 return 1 if $a->get('cancel');
2291 #shouldn't get here...
2294 my $a_num_cust_svc = $a->num_cust_svc;
2295 my $b_num_cust_svc = $b->num_cust_svc;
2296 return 0 if !$a_num_cust_svc && !$b_num_cust_svc;
2297 return -1 if $a_num_cust_svc && !$b_num_cust_svc;
2298 return 1 if !$a_num_cust_svc && $b_num_cust_svc;
2299 my @a_cust_svc = $a->cust_svc;
2300 my @b_cust_svc = $b->cust_svc;
2301 return 0 if !scalar(@a_cust_svc) && !scalar(@b_cust_svc);
2302 return -1 if scalar(@a_cust_svc) && !scalar(@b_cust_svc);
2303 return 1 if !scalar(@a_cust_svc) && scalar(@b_cust_svc);
2304 $a_cust_svc[0]->svc_x->label cmp $b_cust_svc[0]->svc_x->label;
2309 =item suspended_pkgs
2311 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
2315 sub suspended_pkgs {
2317 grep { $_->susp } $self->ncancelled_pkgs;
2320 =item unflagged_suspended_pkgs
2322 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
2323 customer (thouse packages without the `manual_flag' set).
2327 sub unflagged_suspended_pkgs {
2329 return $self->suspended_pkgs
2330 unless dbdef->table('cust_pkg')->column('manual_flag');
2331 grep { ! $_->manual_flag } $self->suspended_pkgs;
2334 =item unsuspended_pkgs
2336 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
2341 sub unsuspended_pkgs {
2343 grep { ! $_->susp } $self->ncancelled_pkgs;
2346 =item next_bill_date
2348 Returns the next date this customer will be billed, as a UNIX timestamp, or
2349 undef if no active package has a next bill date.
2353 sub next_bill_date {
2355 min( map $_->get('bill'), grep $_->get('bill'), $self->unsuspended_pkgs );
2358 =item num_cancelled_pkgs
2360 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
2365 sub num_cancelled_pkgs {
2366 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
2369 sub num_ncancelled_pkgs {
2370 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
2374 my( $self ) = shift;
2375 my $sql = scalar(@_) ? shift : '';
2376 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
2377 my $sth = dbh->prepare(
2378 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
2379 ) or die dbh->errstr;
2380 $sth->execute($self->custnum) or die $sth->errstr;
2381 $sth->fetchrow_arrayref->[0];
2386 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2387 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2388 on success or a list of errors.
2394 grep { $_->unsuspend } $self->suspended_pkgs;
2399 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2401 Returns a list: an empty list on success or a list of errors.
2407 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2410 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2412 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2413 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2414 of a list of pkgparts; the hashref has the following keys:
2418 =item pkgparts - listref of pkgparts
2420 =item (other options are passed to the suspend method)
2425 Returns a list: an empty list on success or a list of errors.
2429 sub suspend_if_pkgpart {
2431 my (@pkgparts, %opt);
2432 if (ref($_[0]) eq 'HASH'){
2433 @pkgparts = @{$_[0]{pkgparts}};
2438 grep { $_->suspend(%opt) }
2439 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2440 $self->unsuspended_pkgs;
2443 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2445 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2446 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2447 instead of a list of pkgparts; the hashref has the following keys:
2451 =item pkgparts - listref of pkgparts
2453 =item (other options are passed to the suspend method)
2457 Returns a list: an empty list on success or a list of errors.
2461 sub suspend_unless_pkgpart {
2463 my (@pkgparts, %opt);
2464 if (ref($_[0]) eq 'HASH'){
2465 @pkgparts = @{$_[0]{pkgparts}};
2470 grep { $_->suspend(%opt) }
2471 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2472 $self->unsuspended_pkgs;
2475 =item cancel [ OPTION => VALUE ... ]
2477 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2479 Available options are:
2483 =item quiet - can be set true to supress email cancellation notices.
2485 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason. The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason.
2487 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2489 =item nobill - can be set true to skip billing if it might otherwise be done.
2493 Always returns a list: an empty list on success or a list of errors.
2497 # nb that dates are not specified as valid options to this method
2500 my( $self, %opt ) = @_;
2502 warn "$me cancel called on customer ". $self->custnum. " with options ".
2503 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2506 return ( 'access denied' )
2507 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2509 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2511 #should try decryption (we might have the private key)
2512 # and if not maybe queue a job for the server that does?
2513 return ( "Can't (yet) ban encrypted credit cards" )
2514 if $self->is_encrypted($self->payinfo);
2516 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
2517 my $error = $ban->insert;
2518 return ( $error ) if $error;
2522 my @pkgs = $self->ncancelled_pkgs;
2524 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2526 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2527 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2531 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2532 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2535 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2538 sub _banned_pay_hashref {
2549 'payby' => $payby2ban{$self->payby},
2550 'payinfo' => md5_base64($self->payinfo),
2551 #don't ever *search* on reason! #'reason' =>
2557 Returns all notes (see L<FS::cust_main_note>) for this customer.
2564 qsearch( 'cust_main_note',
2565 { 'custnum' => $self->custnum },
2567 'ORDER BY _DATE DESC'
2573 Returns the agent (see L<FS::agent>) for this customer.
2579 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2584 Returns the agent name (see L<FS::agent>) for this customer.
2590 $self->agent->agent;
2595 Returns any tags associated with this customer, as FS::cust_tag objects,
2596 or an empty list if there are no tags.
2602 qsearch('cust_tag', { 'custnum' => $self->custnum } );
2607 Returns any tags associated with this customer, as FS::part_tag objects,
2608 or an empty list if there are no tags.
2614 map $_->part_tag, $self->cust_tag;
2620 Returns the customer class, as an FS::cust_class object, or the empty string
2621 if there is no customer class.
2627 if ( $self->classnum ) {
2628 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2636 Returns the customer category name, or the empty string if there is no customer
2643 my $cust_class = $self->cust_class;
2645 ? $cust_class->categoryname
2651 Returns the customer class name, or the empty string if there is no customer
2658 my $cust_class = $self->cust_class;
2660 ? $cust_class->classname
2665 =item bill_and_collect
2667 Cancels and suspends any packages due, generates bills, applies payments and
2668 credits, and applies collection events to run cards, send bills and notices,
2671 By default, warns on errors and continues with the next operation (but see the
2672 "fatal" flag below).
2674 Options are passed as name-value pairs. Currently available options are:
2680 Bills the customer as if it were that time. Specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions. For example:
2684 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2688 Used in conjunction with the I<time> option, this option specifies the date of for the generated invoices. Other calculations, such as whether or not to generate the invoice in the first place, are not affected.
2692 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2696 If set true, re-charges setup fees.
2700 If set any errors prevent subsequent operations from continusing. If set
2701 specifically to "return", returns the error (or false, if there is no error).
2702 Any other true value causes errors to die.
2706 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
2710 Optional FS::queue entry to receive status updates.
2714 Options are passed to the B<bill> and B<collect> methods verbatim, so all
2715 options of those methods are also available.
2719 sub bill_and_collect {
2720 my( $self, %options ) = @_;
2724 #$options{actual_time} not $options{time} because freeside-daily -d is for
2725 #pre-printing invoices
2727 $options{'actual_time'} ||= time;
2728 my $job = $options{'job'};
2730 $job->update_statustext('0,cleaning expired packages') if $job;
2731 $error = $self->cancel_expired_pkgs( $options{actual_time} );
2733 $error = "Error expiring custnum ". $self->custnum. ": $error";
2734 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2735 elsif ( $options{fatal} ) { die $error; }
2736 else { warn $error; }
2739 $error = $self->suspend_adjourned_pkgs( $options{actual_time} );
2741 $error = "Error adjourning custnum ". $self->custnum. ": $error";
2742 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2743 elsif ( $options{fatal} ) { die $error; }
2744 else { warn $error; }
2747 $job->update_statustext('20,billing packages') if $job;
2748 $error = $self->bill( %options );
2750 $error = "Error billing custnum ". $self->custnum. ": $error";
2751 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2752 elsif ( $options{fatal} ) { die $error; }
2753 else { warn $error; }
2756 $job->update_statustext('50,applying payments and credits') if $job;
2757 $error = $self->apply_payments_and_credits;
2759 $error = "Error applying custnum ". $self->custnum. ": $error";
2760 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2761 elsif ( $options{fatal} ) { die $error; }
2762 else { warn $error; }
2765 $job->update_statustext('70,running collection events') if $job;
2766 unless ( $conf->exists('cancelled_cust-noevents')
2767 && ! $self->num_ncancelled_pkgs
2769 $error = $self->collect( %options );
2771 $error = "Error collecting custnum ". $self->custnum. ": $error";
2772 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
2773 elsif ($options{fatal} ) { die $error; }
2774 else { warn $error; }
2777 $job->update_statustext('100,finished') if $job;
2783 sub cancel_expired_pkgs {
2784 my ( $self, $time, %options ) = @_;
2786 my @cancel_pkgs = $self->ncancelled_pkgs( {
2787 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
2792 foreach my $cust_pkg ( @cancel_pkgs ) {
2793 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
2794 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
2795 'reason_otaker' => $cpr->otaker
2799 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
2802 scalar(@errors) ? join(' / ', @errors) : '';
2806 sub suspend_adjourned_pkgs {
2807 my ( $self, $time, %options ) = @_;
2809 my @susp_pkgs = $self->ncancelled_pkgs( {
2811 " AND ( susp IS NULL OR susp = 0 )
2812 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
2813 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
2818 #only because there's no SQL test for is_prepaid :/
2820 grep { ( $_->part_pkg->is_prepaid
2825 && $_->adjourn <= $time
2833 foreach my $cust_pkg ( @susp_pkgs ) {
2834 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
2835 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
2836 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
2837 'reason_otaker' => $cpr->otaker
2841 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
2844 scalar(@errors) ? join(' / ', @errors) : '';
2850 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
2851 conjunction with the collect method by calling B<bill_and_collect>.
2853 If there is an error, returns the error, otherwise returns false.
2855 Options are passed as name-value pairs. Currently available options are:
2861 If set true, re-charges setup fees.
2865 Bills the customer as if it were that time. Specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions. For example:
2869 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2873 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2875 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2879 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
2883 Used in conjunction with the I<time> option, this option specifies the date of for the generated invoices. Other calculations, such as whether or not to generate the invoice in the first place, are not affected.
2887 This boolean value informs the us that the package is being cancelled. This
2888 typically might mean not charging the normal recurring fee but only usage
2889 fees since the last billing. Setup charges may be charged. Not all package
2890 plans support this feature (they tend to charge 0).
2894 Optional terms to be printed on this invoice. Otherwise, customer-specific
2895 terms or the default terms are used.
2902 my( $self, %options ) = @_;
2903 return '' if $self->payby eq 'COMP';
2904 warn "$me bill customer ". $self->custnum. "\n"
2907 my $time = $options{'time'} || time;
2908 my $invoice_time = $options{'invoice_time'} || $time;
2910 $options{'not_pkgpart'} ||= {};
2911 $options{'not_pkgpart'} = { map { $_ => 1 }
2912 split(/\s*,\s*/, $options{'not_pkgpart'})
2914 unless ref($options{'not_pkgpart'});
2916 local $SIG{HUP} = 'IGNORE';
2917 local $SIG{INT} = 'IGNORE';
2918 local $SIG{QUIT} = 'IGNORE';
2919 local $SIG{TERM} = 'IGNORE';
2920 local $SIG{TSTP} = 'IGNORE';
2921 local $SIG{PIPE} = 'IGNORE';
2923 my $oldAutoCommit = $FS::UID::AutoCommit;
2924 local $FS::UID::AutoCommit = 0;
2927 warn "$me acquiring lock on customer ". $self->custnum. "\n"
2930 $self->select_for_update; #mutex
2932 warn "$me running pre-bill events for customer ". $self->custnum. "\n"
2935 my $error = $self->do_cust_event(
2936 'debug' => ( $options{'debug'} || 0 ),
2937 'time' => $invoice_time,
2938 'check_freq' => $options{'check_freq'},
2939 'stage' => 'pre-bill',
2942 $dbh->rollback if $oldAutoCommit;
2946 warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
2949 #keep auto-charge and non-auto-charge line items separate
2950 my @passes = ( '', 'no_auto' );
2952 my %cust_bill_pkg = map { $_ => [] } @passes;
2955 # find the packages which are due for billing, find out how much they are
2956 # & generate invoice database.
2959 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
2960 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
2962 my %taxlisthash = map { $_ => {} } @passes;
2964 my @precommit_hooks = ();
2966 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
2967 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
2969 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
2971 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2973 #? to avoid use of uninitialized value errors... ?
2974 $cust_pkg->setfield('bill', '')
2975 unless defined($cust_pkg->bill);
2977 #my $part_pkg = $cust_pkg->part_pkg;
2979 my $real_pkgpart = $cust_pkg->pkgpart;
2980 my %hash = $cust_pkg->hash;
2982 # we could implement this bit as FS::part_pkg::has_hidden, but we already
2983 # suffer from performance issues
2984 $options{has_hidden} = 0;
2985 my @part_pkg = $cust_pkg->part_pkg->self_and_bill_linked;
2986 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
2988 foreach my $part_pkg ( @part_pkg ) {
2990 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
2992 my $pass = ($cust_pkg->no_auto || $part_pkg->no_auto) ? 'no_auto' : '';
2995 $self->_make_lines( 'part_pkg' => $part_pkg,
2996 'cust_pkg' => $cust_pkg,
2997 'precommit_hooks' => \@precommit_hooks,
2998 'line_items' => $cust_bill_pkg{$pass},
2999 'setup' => $total_setup{$pass},
3000 'recur' => $total_recur{$pass},
3001 'tax_matrix' => $taxlisthash{$pass},
3003 'real_pkgpart' => $real_pkgpart,
3004 'options' => \%options,
3007 $dbh->rollback if $oldAutoCommit;
3011 } #foreach my $part_pkg
3013 } #foreach my $cust_pkg
3015 #if the customer isn't on an automatic payby, everything can go on a single
3017 #if ( $cust_main->payby !~ /^(CARD|CHEK)$/ ) {
3018 #merge everything into one list
3021 foreach my $pass (@passes) { # keys %cust_bill_pkg ) {
3023 my @cust_bill_pkg = @{ $cust_bill_pkg{$pass} };
3025 next unless @cust_bill_pkg; #don't create an invoice w/o line items
3027 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
3028 !$conf->exists('postal_invoice-recurring_only')
3032 my $postal_pkg = $self->charge_postal_fee();
3033 if ( $postal_pkg && !ref( $postal_pkg ) ) {
3035 $dbh->rollback if $oldAutoCommit;
3036 return "can't charge postal invoice fee for customer ".
3037 $self->custnum. ": $postal_pkg";
3039 } elsif ( $postal_pkg ) {
3041 my $real_pkgpart = $postal_pkg->pkgpart;
3042 # we could implement this bit as FS::part_pkg::has_hidden, but we already
3043 # suffer from performance issues
3044 $options{has_hidden} = 0;
3045 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
3046 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
3048 foreach my $part_pkg ( @part_pkg ) {
3049 my %postal_options = %options;
3050 delete $postal_options{cancel};
3052 $self->_make_lines( 'part_pkg' => $part_pkg,
3053 'cust_pkg' => $postal_pkg,
3054 'precommit_hooks' => \@precommit_hooks,
3055 'line_items' => \@cust_bill_pkg,
3056 'setup' => $total_setup{$pass},
3057 'recur' => $total_recur{$pass},
3058 'tax_matrix' => $taxlisthash{$pass},
3060 'real_pkgpart' => $real_pkgpart,
3061 'options' => \%postal_options,
3064 $dbh->rollback if $oldAutoCommit;
3073 my $listref_or_error =
3074 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
3076 unless ( ref( $listref_or_error ) ) {
3077 $dbh->rollback if $oldAutoCommit;
3078 return $listref_or_error;
3081 foreach my $taxline ( @$listref_or_error ) {
3082 ${ $total_setup{$pass} } =
3083 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
3084 push @cust_bill_pkg, $taxline;
3087 #add tax adjustments
3088 warn "adding tax adjustments...\n" if $DEBUG > 2;
3089 foreach my $cust_tax_adjustment (
3090 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
3096 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
3098 my $itemdesc = $cust_tax_adjustment->taxname;
3099 $itemdesc = '' if $itemdesc eq 'Tax';
3101 push @cust_bill_pkg, new FS::cust_bill_pkg {
3107 'itemdesc' => $itemdesc,
3108 'itemcomment' => $cust_tax_adjustment->comment,
3109 'cust_tax_adjustment' => $cust_tax_adjustment,
3110 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
3115 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
3117 my @cust_bill = $self->cust_bill;
3118 my $balance = $self->balance;
3119 my $previous_balance = scalar(@cust_bill)
3120 ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
3123 $previous_balance += $cust_bill[$#cust_bill]->charged
3124 if scalar(@cust_bill);
3125 #my $balance_adjustments =
3126 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
3128 #create the new invoice
3129 my $cust_bill = new FS::cust_bill ( {
3130 'custnum' => $self->custnum,
3131 '_date' => ( $invoice_time ),
3132 'charged' => $charged,
3133 'billing_balance' => $balance,
3134 'previous_balance' => $previous_balance,
3135 'invoice_terms' => $options{'invoice_terms'},
3137 $error = $cust_bill->insert;
3139 $dbh->rollback if $oldAutoCommit;
3140 return "can't create invoice for customer #". $self->custnum. ": $error";
3143 my @cust_bill_pkg_bundle = ();
3144 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
3145 $cust_bill_pkg->invnum($cust_bill->invnum);
3146 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
3147 $error = $self->_insert_cust_bill_pkg_bundle( @cust_bill_pkg_bundle );
3149 $dbh->rollback if $oldAutoCommit;
3152 @cust_bill_pkg_bundle = ();
3154 push @cust_bill_pkg_bundle, $cust_bill_pkg;
3156 if (scalar(@cust_bill_pkg_bundle)) {
3157 $error = $self->_insert_cust_bill_pkg_bundle( @cust_bill_pkg_bundle );
3159 $dbh->rollback if $oldAutoCommit;
3164 } #foreach my $pass ( keys %cust_bill_pkg )
3166 foreach my $hook ( @precommit_hooks ) {
3168 &{$hook}; #($self) ?
3171 $dbh->rollback if $oldAutoCommit;
3172 return "$@ running precommit hook $hook\n";
3176 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3180 #insert line items while discarding bundled packages of 0 value
3181 sub _insert_cust_bill_pkg_bundle {
3183 my @cust_bill_pkg = @_;
3186 $sum += $_->setup + $_->recur foreach @cust_bill_pkg;
3187 return '' unless $sum > 0;
3189 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
3190 my $error = $cust_bill_pkg->insert;
3191 return "can't create invoice line item: $error" if $error;
3196 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
3198 This is a weird one. Perhaps it should not even be exposed.
3200 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
3201 Usually used internally by bill method B<bill>.
3203 If there is an error, returns the error, otherwise returns reference to a
3204 list of line items suitable for insertion.
3210 An array ref of the line items being billed.
3214 A strange beast. The keys to this hash are internal identifiers consisting
3215 of the name of the tax object type, a space, and its unique identifier ( e.g.
3216 'cust_main_county 23' ). The values of the hash are listrefs. The first
3217 item in the list is the tax object. The remaining items are either line
3218 items or floating point values (currency amounts).
3220 The taxes are calculated on this entity. Calculated exemption records are
3221 transferred to the LINEITEMREF items on the assumption that they are related.
3227 This specifies the date appearing on the associated invoice. Some
3228 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
3233 sub calculate_taxes {
3234 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
3236 my @tax_line_items = ();
3238 warn "having a look at the taxes we found...\n" if $DEBUG > 2;
3240 # keys are tax names (as printed on invoices / itemdesc )
3241 # values are listrefs of taxlisthash keys (internal identifiers)
3244 # keys are taxlisthash keys (internal identifiers)
3245 # values are (cumulative) amounts
3248 # keys are taxlisthash keys (internal identifiers)
3249 # values are listrefs of cust_bill_pkg_tax_location hashrefs
3250 my %tax_location = ();
3252 # keys are taxlisthash keys (internal identifiers)
3253 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
3254 my %tax_rate_location = ();
3256 foreach my $tax ( keys %$taxlisthash ) {
3257 my $tax_object = shift @{ $taxlisthash->{$tax} };
3258 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
3259 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
3260 my $hashref_or_error =
3261 $tax_object->taxline( $taxlisthash->{$tax},
3262 'custnum' => $self->custnum,
3263 'invoice_time' => $invoice_time
3265 return $hashref_or_error unless ref($hashref_or_error);
3267 unshift @{ $taxlisthash->{$tax} }, $tax_object;
3269 my $name = $hashref_or_error->{'name'};
3270 my $amount = $hashref_or_error->{'amount'};
3272 #warn "adding $amount as $name\n";
3273 $taxname{ $name } ||= [];
3274 push @{ $taxname{ $name } }, $tax;
3276 $tax{ $tax } += $amount;
3278 $tax_location{ $tax } ||= [];
3279 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
3280 push @{ $tax_location{ $tax } },
3282 'taxnum' => $tax_object->taxnum,
3283 'taxtype' => ref($tax_object),
3284 'pkgnum' => $tax_object->get('pkgnum'),
3285 'locationnum' => $tax_object->get('locationnum'),
3286 'amount' => sprintf('%.2f', $amount ),
3290 $tax_rate_location{ $tax } ||= [];
3291 if ( ref($tax_object) eq 'FS::tax_rate' ) {
3292 my $taxratelocationnum =
3293 $tax_object->tax_rate_location->taxratelocationnum;
3294 push @{ $tax_rate_location{ $tax } },
3296 'taxnum' => $tax_object->taxnum,
3297 'taxtype' => ref($tax_object),
3298 'amount' => sprintf('%.2f', $amount ),
3299 'locationtaxid' => $tax_object->location,
3300 'taxratelocationnum' => $taxratelocationnum,
3306 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
3307 my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
3308 foreach my $tax ( keys %$taxlisthash ) {
3309 foreach ( @{ $taxlisthash->{$tax} }[1 ... scalar(@{ $taxlisthash->{$tax} })] ) {
3310 next unless ref($_) eq 'FS::cust_bill_pkg';
3312 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
3313 splice( @{ $_->_cust_tax_exempt_pkg } );
3317 #consolidate and create tax line items
3318 warn "consolidating and generating...\n" if $DEBUG > 2;
3319 foreach my $taxname ( keys %taxname ) {
3322 my @cust_bill_pkg_tax_location = ();
3323 my @cust_bill_pkg_tax_rate_location = ();
3324 warn "adding $taxname\n" if $DEBUG > 1;
3325 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
3326 next if $seen{$taxitem}++;
3327 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
3328 $tax += $tax{$taxitem};
3329 push @cust_bill_pkg_tax_location,
3330 map { new FS::cust_bill_pkg_tax_location $_ }
3331 @{ $tax_location{ $taxitem } };
3332 push @cust_bill_pkg_tax_rate_location,
3333 map { new FS::cust_bill_pkg_tax_rate_location $_ }
3334 @{ $tax_rate_location{ $taxitem } };
3338 $tax = sprintf('%.2f', $tax );
3340 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
3346 if ( $pkg_category and
3347 $conf->config('invoice_latexsummary') ||
3348 $conf->config('invoice_htmlsummary')
3352 my %hash = ( 'section' => $pkg_category->categoryname );
3353 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3357 push @tax_line_items, new FS::cust_bill_pkg {
3363 'itemdesc' => $taxname,
3364 'display' => \@display,
3365 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
3366 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
3375 my ($self, %params) = @_;
3377 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
3378 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
3379 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
3380 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
3381 my $total_setup = $params{setup} or die "no setup accumulator specified";
3382 my $total_recur = $params{recur} or die "no recur accumulator specified";
3383 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
3384 my $time = $params{'time'} or die "no time specified";
3385 my (%options) = %{$params{options}};
3388 my $real_pkgpart = $params{real_pkgpart};
3389 my %hash = $cust_pkg->hash;
3390 my $old_cust_pkg = new FS::cust_pkg \%hash;
3396 $cust_pkg->pkgpart($part_pkg->pkgpart);
3404 if ( $options{'resetup'}
3405 || ( ! $cust_pkg->setup
3406 && ( ! $cust_pkg->start_date
3407 || $cust_pkg->start_date <= $time
3409 && ( ! $conf->exists('disable_setup_suspended_pkgs')
3410 || ( $conf->exists('disable_setup_suspended_pkgs') &&
3411 ! $cust_pkg->getfield('susp')
3418 warn " bill setup\n" if $DEBUG > 1;
3421 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
3422 return "$@ running calc_setup for $cust_pkg\n"
3425 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
3427 $cust_pkg->setfield('setup', $time)
3428 unless $cust_pkg->setup;
3429 #do need it, but it won't get written to the db
3430 #|| $cust_pkg->pkgpart != $real_pkgpart;
3432 $cust_pkg->setfield('start_date', '')
3433 if $cust_pkg->start_date;
3438 # bill recurring fee
3441 #XXX unit stuff here too
3445 if ( ! $cust_pkg->get('susp')
3446 and ! $cust_pkg->get('start_date')
3447 and ( $part_pkg->getfield('freq') ne '0'
3448 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
3450 || ( $part_pkg->plan eq 'voip_cdr'
3451 && $part_pkg->option('bill_every_call')
3453 || ( $options{cancel} )
3456 # XXX should this be a package event? probably. events are called
3457 # at collection time at the moment, though...
3458 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
3459 if $part_pkg->can('reset_usage');
3460 #don't want to reset usage just cause we want a line item??
3461 #&& $part_pkg->pkgpart == $real_pkgpart;
3463 warn " bill recur\n" if $DEBUG > 1;
3466 # XXX shared with $recur_prog
3467 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
3471 #over two params! lets at least switch to a hashref for the rest...
3472 my $increment_next_bill = ( $part_pkg->freq ne '0'
3473 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
3474 && !$options{cancel}
3476 my %param = ( 'precommit_hooks' => $precommit_hooks,
3477 'increment_next_bill' => $increment_next_bill,
3478 'discounts' => \@discounts,
3481 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
3482 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
3483 return "$@ running $method for $cust_pkg\n"
3486 if ( $increment_next_bill ) {
3488 my $next_bill = $part_pkg->add_freq($sdate);
3489 return "unparsable frequency: ". $part_pkg->freq
3490 if $next_bill == -1;
3492 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
3493 # only for figuring next bill date, nothing else, so, reset $sdate again
3495 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
3496 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
3497 $cust_pkg->last_bill($sdate);
3499 $cust_pkg->setfield('bill', $next_bill );
3505 warn "\$setup is undefined" unless defined($setup);
3506 warn "\$recur is undefined" unless defined($recur);
3507 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
3510 # If there's line items, create em cust_bill_pkg records
3511 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
3514 if ( $lineitems || $options{has_hidden} ) {
3516 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
3517 # hmm.. and if just the options are modified in some weird price plan?
3519 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
3522 my $error = $cust_pkg->replace( $old_cust_pkg,
3523 'options' => { $cust_pkg->options },
3525 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
3526 if $error; #just in case
3529 $setup = sprintf( "%.2f", $setup );
3530 $recur = sprintf( "%.2f", $recur );
3531 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
3532 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
3534 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
3535 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
3540 !$part_pkg->hidden && $options{has_hidden} ) #include some $0 lines
3543 warn " charges (setup=$setup, recur=$recur); adding line items\n"
3546 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
3548 warn " adding customer package invoice detail: $_\n"
3549 foreach @cust_pkg_detail;
3551 push @details, @cust_pkg_detail;
3553 my $cust_bill_pkg = new FS::cust_bill_pkg {
3554 'pkgnum' => $cust_pkg->pkgnum,
3556 'unitsetup' => $unitsetup,
3558 'unitrecur' => $unitrecur,
3559 'quantity' => $cust_pkg->quantity,
3560 'details' => \@details,
3561 'discounts' => \@discounts,
3562 'hidden' => $part_pkg->hidden,
3565 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
3566 $cust_bill_pkg->sdate( $hash{last_bill} );
3567 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
3568 $cust_bill_pkg->edate( $time ) if $options{cancel};
3569 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
3570 $cust_bill_pkg->sdate( $sdate );
3571 $cust_bill_pkg->edate( $cust_pkg->bill );
3572 #$cust_bill_pkg->edate( $time ) if $options{cancel};
3575 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
3576 unless $part_pkg->pkgpart == $real_pkgpart;
3578 $$total_setup += $setup;
3579 $$total_recur += $recur;
3586 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
3587 return $error if $error;
3589 push @$cust_bill_pkgs, $cust_bill_pkg;
3591 } #if $setup != 0 || $recur != 0
3601 my $part_pkg = shift;
3602 my $taxlisthash = shift;
3603 my $cust_bill_pkg = shift;
3604 my $cust_pkg = shift;
3605 my $invoice_time = shift;
3606 my $real_pkgpart = shift;
3607 my $options = shift;
3609 my %cust_bill_pkg = ();
3613 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
3614 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
3615 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
3616 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
3618 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
3620 if ( $conf->exists('enable_taxproducts')
3621 && ( scalar($part_pkg->part_pkg_taxoverride)
3622 || $part_pkg->has_taxproduct
3627 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3628 return "fatal: Can't (yet) use tax-pkg_address with taxproducts";
3631 foreach my $class (@classes) {
3632 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class );
3633 return $err_or_ref unless ref($err_or_ref);
3634 $taxes{$class} = $err_or_ref;
3637 unless (exists $taxes{''}) {
3638 my $err_or_ref = $self->_gather_taxes( $part_pkg, '' );
3639 return $err_or_ref unless ref($err_or_ref);
3640 $taxes{''} = $err_or_ref;
3645 my @loc_keys = qw( city county state country );
3647 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3648 my $cust_location = $cust_pkg->cust_location;
3649 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
3652 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
3655 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
3658 $taxhash{'taxclass'} = $part_pkg->taxclass;
3661 my %taxhash_elim = %taxhash;
3662 my @elim = qw( city county state );
3665 #first try a match with taxclass
3666 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
3668 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
3669 #then try a match without taxclass
3670 my %no_taxclass = %taxhash_elim;
3671 $no_taxclass{ 'taxclass' } = '';
3672 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
3675 $taxhash_elim{ shift(@elim) } = '';
3677 } while ( !scalar(@taxes) && scalar(@elim) );
3679 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
3681 if $self->cust_main_exemption; #just to be safe
3683 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3685 $_->set('pkgnum', $cust_pkg->pkgnum );
3686 $_->set('locationnum', $cust_pkg->locationnum );
3690 $taxes{''} = [ @taxes ];
3691 $taxes{'setup'} = [ @taxes ];
3692 $taxes{'recur'} = [ @taxes ];
3693 $taxes{$_} = [ @taxes ] foreach (@classes);
3695 # # maybe eliminate this entirely, along with all the 0% records
3696 # unless ( @taxes ) {
3698 # "fatal: can't find tax rate for state/county/country/taxclass ".
3699 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
3702 } #if $conf->exists('enable_taxproducts') ...
3707 my $separate = $conf->exists('separate_usage');
3708 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
3709 my $usage_mandate = $temp_pkg->part_pkg->option('usage_mandate', 'Hush!');
3710 my $section = $temp_pkg->part_pkg->categoryname;
3711 if ( $separate || $section || $usage_mandate ) {
3713 my %hash = ( 'section' => $section );
3715 $section = $temp_pkg->part_pkg->option('usage_section', 'Hush!');
3716 my $summary = $temp_pkg->part_pkg->option('summarize_usage', 'Hush!');
3718 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3719 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
3721 push @display, new FS::cust_bill_pkg_display
3724 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
3728 if ($separate && $section && $summary) {
3729 push @display, new FS::cust_bill_pkg_display { type => 'U',
3734 if ($usage_mandate || $section && $summary) {
3735 $hash{post_total} = 'Y';
3738 if ($separate || $usage_mandate) {
3739 $hash{section} = $section if ($separate || $usage_mandate);
3740 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
3744 $cust_bill_pkg->set('display', \@display);
3746 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
3747 foreach my $key (keys %tax_cust_bill_pkg) {
3748 my @taxes = @{ $taxes{$key} || [] };
3749 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
3751 my %localtaxlisthash = ();
3752 foreach my $tax ( @taxes ) {
3754 my $taxname = ref( $tax ). ' '. $tax->taxnum;
3755 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
3756 # ' locationnum'. $cust_pkg->locationnum
3757 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
3759 $taxlisthash->{ $taxname } ||= [ $tax ];
3760 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
3762 $localtaxlisthash{ $taxname } ||= [ $tax ];
3763 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
3767 warn "finding taxed taxes...\n" if $DEBUG > 2;
3768 foreach my $tax ( keys %localtaxlisthash ) {
3769 my $tax_object = shift @{ $localtaxlisthash{$tax} };
3770 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
3772 next unless $tax_object->can('tax_on_tax');
3774 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
3775 my $totname = ref( $tot ). ' '. $tot->taxnum;
3777 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
3779 next unless exists( $localtaxlisthash{ $totname } ); # only increase
3781 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
3782 my $hashref_or_error =
3783 $tax_object->taxline( $localtaxlisthash{$tax},
3784 'custnum' => $self->custnum,
3785 'invoice_time' => $invoice_time,
3787 return $hashref_or_error
3788 unless ref($hashref_or_error);
3790 $taxlisthash->{ $totname } ||= [ $tot ];
3791 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
3803 my $part_pkg = shift;
3807 my $geocode = $self->geocode('cch');
3809 my @taxclassnums = map { $_->taxclassnum }
3810 $part_pkg->part_pkg_taxoverride($class);
3812 unless (@taxclassnums) {
3813 @taxclassnums = map { $_->taxclassnum }
3814 grep { $_->taxable eq 'Y' }
3815 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
3817 warn "Found taxclassnum values of ". join(',', @taxclassnums)
3822 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
3824 @taxes = qsearch({ 'table' => 'tax_rate',
3825 'hashref' => { 'geocode' => $geocode, },
3826 'extra_sql' => $extra_sql,
3828 if scalar(@taxclassnums);
3830 warn "Found taxes ".
3831 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
3838 =item collect [ HASHREF | OPTION => VALUE ... ]
3840 (Attempt to) collect money for this customer's outstanding invoices (see
3841 L<FS::cust_bill>). Usually used after the bill method.
3843 Actions are now triggered by billing events; see L<FS::part_event> and the
3844 billing events web interface. Old-style invoice events (see
3845 L<FS::part_bill_event>) have been deprecated.
3847 If there is an error, returns the error, otherwise returns false.
3849 Options are passed as name-value pairs.
3851 Currently available options are:
3857 Use this time when deciding when to print invoices and late notices on those invoices. The default is now. It is specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions.
3861 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3865 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3869 set true to surpress email card/ACH decline notices.
3873 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
3879 # allows for one time override of normal customer billing method
3884 my( $self, %options ) = @_;
3885 my $invoice_time = $options{'invoice_time'} || time;
3888 local $SIG{HUP} = 'IGNORE';
3889 local $SIG{INT} = 'IGNORE';
3890 local $SIG{QUIT} = 'IGNORE';
3891 local $SIG{TERM} = 'IGNORE';
3892 local $SIG{TSTP} = 'IGNORE';
3893 local $SIG{PIPE} = 'IGNORE';
3895 my $oldAutoCommit = $FS::UID::AutoCommit;
3896 local $FS::UID::AutoCommit = 0;
3899 $self->select_for_update; #mutex
3902 my $balance = $self->balance;
3903 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
3906 if ( exists($options{'retry_card'}) ) {
3907 carp 'retry_card option passed to collect is deprecated; use retry';
3908 $options{'retry'} ||= $options{'retry_card'};
3910 if ( exists($options{'retry'}) && $options{'retry'} ) {
3911 my $error = $self->retry_realtime;
3913 $dbh->rollback if $oldAutoCommit;
3918 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3920 #never want to roll back an event just because it returned an error
3921 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
3923 $self->do_cust_event(
3924 'debug' => ( $options{'debug'} || 0 ),
3925 'time' => $invoice_time,
3926 'check_freq' => $options{'check_freq'},
3927 'stage' => 'collect',
3932 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
3934 Runs billing events; see L<FS::part_event> and the billing events web
3937 If there is an error, returns the error, otherwise returns false.
3939 Options are passed as name-value pairs.
3941 Currently available options are:
3947 Use this time when deciding when to print invoices and late notices on those invoices. The default is now. It is specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions.
3951 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3955 "collect" (the default) or "pre-bill"
3959 set true to surpress email card/ACH decline notices.
3963 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
3969 # allows for one time override of normal customer billing method
3973 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3976 my( $self, %options ) = @_;
3977 my $time = $options{'time'} || time;
3980 local $SIG{HUP} = 'IGNORE';
3981 local $SIG{INT} = 'IGNORE';
3982 local $SIG{QUIT} = 'IGNORE';
3983 local $SIG{TERM} = 'IGNORE';
3984 local $SIG{TSTP} = 'IGNORE';
3985 local $SIG{PIPE} = 'IGNORE';
3987 my $oldAutoCommit = $FS::UID::AutoCommit;
3988 local $FS::UID::AutoCommit = 0;
3991 $self->select_for_update; #mutex
3994 my $balance = $self->balance;
3995 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
3998 # if ( exists($options{'retry_card'}) ) {
3999 # carp 'retry_card option passed to collect is deprecated; use retry';
4000 # $options{'retry'} ||= $options{'retry_card'};
4002 # if ( exists($options{'retry'}) && $options{'retry'} ) {
4003 # my $error = $self->retry_realtime;
4005 # $dbh->rollback if $oldAutoCommit;
4010 # false laziness w/pay_batch::import_results
4012 my $due_cust_event = $self->due_cust_event(
4013 'debug' => ( $options{'debug'} || 0 ),
4015 'check_freq' => $options{'check_freq'},
4016 'stage' => ( $options{'stage'} || 'collect' ),
4018 unless( ref($due_cust_event) ) {
4019 $dbh->rollback if $oldAutoCommit;
4020 return $due_cust_event;
4023 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4024 #never want to roll back an event just because it or a different one
4026 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
4028 foreach my $cust_event ( @$due_cust_event ) {
4032 #re-eval event conditions (a previous event could have changed things)
4033 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
4034 #don't leave stray "new/locked" records around
4035 my $error = $cust_event->delete;
4036 return $error if $error;
4041 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
4042 warn " running cust_event ". $cust_event->eventnum. "\n"
4045 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
4046 if ( my $error = $cust_event->do_event() ) {
4047 #XXX wtf is this? figure out a proper dealio with return value
4059 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
4061 Inserts database records for and returns an ordered listref of new events due
4062 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
4063 events are due, an empty listref is returned. If there is an error, returns a
4064 scalar error message.
4066 To actually run the events, call each event's test_condition method, and if
4067 still true, call the event's do_event method.
4069 Options are passed as a hashref or as a list of name-value pairs. Available
4076 Search only for events of this check frequency (how often events of this type are checked); currently "1d" (daily, the default) and "1m" (monthly) are recognized.
4080 "collect" (the default) or "pre-bill"
4084 "Current time" for the events.
4088 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
4092 Only return events for the specified eventtable (by default, events of all eventtables are returned)
4096 Explicitly pass the objects to be tested (typically used with eventtable).
4100 Set to true to return the objects, but not actually insert them into the
4107 sub due_cust_event {
4109 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
4112 #my $DEBUG = $opt{'debug'}
4113 local($DEBUG) = $opt{'debug'}
4114 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
4116 warn "$me due_cust_event called with options ".
4117 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
4120 $opt{'time'} ||= time;
4122 local $SIG{HUP} = 'IGNORE';
4123 local $SIG{INT} = 'IGNORE';
4124 local $SIG{QUIT} = 'IGNORE';
4125 local $SIG{TERM} = 'IGNORE';
4126 local $SIG{TSTP} = 'IGNORE';
4127 local $SIG{PIPE} = 'IGNORE';
4129 my $oldAutoCommit = $FS::UID::AutoCommit;
4130 local $FS::UID::AutoCommit = 0;
4133 $self->select_for_update #mutex
4134 unless $opt{testonly};
4137 # find possible events (initial search)
4140 my @cust_event = ();
4142 my @eventtable = $opt{'eventtable'}
4143 ? ( $opt{'eventtable'} )
4144 : FS::part_event->eventtables_runorder;
4146 foreach my $eventtable ( @eventtable ) {
4149 if ( $opt{'objects'} ) {
4151 @objects = @{ $opt{'objects'} };
4155 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
4156 @objects = ( $eventtable eq 'cust_main' )
4158 : ( $self->$eventtable() );
4162 my @e_cust_event = ();
4164 my $cross = "CROSS JOIN $eventtable";
4165 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
4166 unless $eventtable eq 'cust_main';
4168 foreach my $object ( @objects ) {
4170 #this first search uses the condition_sql magic for optimization.
4171 #the more possible events we can eliminate in this step the better
4173 my $cross_where = '';
4174 my $pkey = $object->primary_key;
4175 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
4177 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
4179 FS::part_event_condition->where_conditions_sql( $eventtable,
4180 'time'=>$opt{'time'}
4182 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
4184 $extra_sql = "AND $extra_sql" if $extra_sql;
4186 #here is the agent virtualization
4187 $extra_sql .= " AND ( part_event.agentnum IS NULL
4188 OR part_event.agentnum = ". $self->agentnum. ' )';
4190 $extra_sql .= " $order";
4192 warn "searching for events for $eventtable ". $object->$pkey. "\n"
4193 if $opt{'debug'} > 2;
4194 my @part_event = qsearch( {
4195 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
4196 'select' => 'part_event.*',
4197 'table' => 'part_event',
4198 'addl_from' => "$cross $join",
4199 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
4200 'eventtable' => $eventtable,
4203 'extra_sql' => "AND $cross_where $extra_sql",
4207 my $pkey = $object->primary_key;
4208 warn " ". scalar(@part_event).
4209 " possible events found for $eventtable ". $object->$pkey(). "\n";
4212 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
4216 warn " ". scalar(@e_cust_event).
4217 " subtotal possible cust events found for $eventtable\n"
4220 push @cust_event, @e_cust_event;
4224 warn " ". scalar(@cust_event).
4225 " total possible cust events found in initial search\n"
4233 $opt{stage} ||= 'collect';
4235 grep { my $stage = $_->part_event->event_stage;
4236 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
4246 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
4247 'stats_hashref' => \%unsat ),
4250 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
4253 warn " invalid conditions not eliminated with condition_sql:\n".
4254 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
4255 if keys %unsat && $DEBUG; # > 1;
4261 unless( $opt{testonly} ) {
4262 foreach my $cust_event ( @cust_event ) {
4264 my $error = $cust_event->insert();
4266 $dbh->rollback if $oldAutoCommit;
4273 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4279 warn " returning events: ". Dumper(@cust_event). "\n"
4286 =item retry_realtime
4288 Schedules realtime / batch credit card / electronic check / LEC billing
4289 events for for retry. Useful if card information has changed or manual
4290 retry is desired. The 'collect' method must be called to actually retry
4293 Implementation details: For either this customer, or for each of this
4294 customer's open invoices, changes the status of the first "done" (with
4295 statustext error) realtime processing event to "failed".
4299 sub retry_realtime {
4302 local $SIG{HUP} = 'IGNORE';
4303 local $SIG{INT} = 'IGNORE';
4304 local $SIG{QUIT} = 'IGNORE';
4305 local $SIG{TERM} = 'IGNORE';
4306 local $SIG{TSTP} = 'IGNORE';
4307 local $SIG{PIPE} = 'IGNORE';
4309 my $oldAutoCommit = $FS::UID::AutoCommit;
4310 local $FS::UID::AutoCommit = 0;
4313 #a little false laziness w/due_cust_event (not too bad, really)
4315 my $join = FS::part_event_condition->join_conditions_sql;
4316 my $order = FS::part_event_condition->order_conditions_sql;
4319 . join ( ' OR ' , map {
4320 "( part_event.eventtable = " . dbh->quote($_)
4321 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
4322 } FS::part_event->eventtables)
4325 #here is the agent virtualization
4326 my $agent_virt = " ( part_event.agentnum IS NULL
4327 OR part_event.agentnum = ". $self->agentnum. ' )';
4329 #XXX this shouldn't be hardcoded, actions should declare it...
4330 my @realtime_events = qw(
4331 cust_bill_realtime_card
4332 cust_bill_realtime_check
4333 cust_bill_realtime_lec
4337 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
4342 my @cust_event = qsearchs({
4343 'table' => 'cust_event',
4344 'select' => 'cust_event.*',
4345 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
4346 'hashref' => { 'status' => 'done' },
4347 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
4348 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
4351 my %seen_invnum = ();
4352 foreach my $cust_event (@cust_event) {
4354 #max one for the customer, one for each open invoice
4355 my $cust_X = $cust_event->cust_X;
4356 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
4360 or $cust_event->part_event->eventtable eq 'cust_bill'
4363 my $error = $cust_event->retry;
4365 $dbh->rollback if $oldAutoCommit;
4366 return "error scheduling event for retry: $error";
4371 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4379 =item realtime_collect [ OPTION => VALUE ... ]
4381 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4382 via a Business::OnlinePayment or Business::OnlineThirdPartyPayment realtime
4383 gateway. See L<http://420.am/business-onlinepayment> and
4384 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
4386 On failure returns an error message.
4388 Returns false or a hashref upon success. The hashref contains keys popup_url reference, and collectitems. The first is a URL to which a browser should be redirected for completion of collection. The second is a reference id for the transaction suitable for the end user. The collectitems is a reference to a list of name value pairs suitable for assigning to a html form and posted to popup_url.
4390 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>, I<pkgnum>
4392 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>. If none is specified
4393 then it is deduced from the customer record.
4395 If no I<amount> is specified, then the customer balance is used.
4397 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4398 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4399 if set, will override the value from the customer record.
4401 I<description> is a free-text field passed to the gateway. It defaults to
4402 the value defined by the business-onlinepayment-description configuration
4403 option, or "Internet services" if that is unset.
4405 If an I<invnum> is specified, this payment (if successful) is applied to the
4406 specified invoice. If you don't specify an I<invnum> you might want to
4407 call the B<apply_payments> method or set the I<apply> option.
4409 I<apply> can be set to true to apply a resulting payment.
4411 I<quiet> can be set true to surpress email decline notices.
4413 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4414 resulting paynum, if any.
4416 I<payunique> is a unique identifier for this payment.
4418 I<session_id> is a session identifier associated with this payment.
4420 I<depend_jobnum> allows payment capture to unlock export jobs
4424 sub realtime_collect {
4425 my( $self, %options ) = @_;
4428 warn "$me realtime_collect:\n";
4429 warn " $_ => $options{$_}\n" foreach keys %options;
4432 $options{amount} = $self->balance unless exists( $options{amount} );
4433 $options{method} = FS::payby->payby2bop($self->payby)
4434 unless exists( $options{method} );
4436 return $self->realtime_bop({%options});
4440 =item realtime_bop { [ ARG => VALUE ... ] }
4442 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4443 via a Business::OnlinePayment realtime gateway. See
4444 L<http://420.am/business-onlinepayment> for supported gateways.
4446 Required arguments in the hashref are I<method>, and I<amount>
4448 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4450 Available optional arguments are: I<description>, I<invnum>, I<apply>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
4452 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4453 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4454 if set, will override the value from the customer record.
4456 I<description> is a free-text field passed to the gateway. It defaults to
4457 the value defined by the business-onlinepayment-description configuration
4458 option, or "Internet services" if that is unset.
4460 If an I<invnum> is specified, this payment (if successful) is applied to the
4461 specified invoice. If you don't specify an I<invnum> you might want to
4462 call the B<apply_payments> method or set the I<apply> option.
4464 I<apply> can be set to true to apply a resulting payment.
4466 I<quiet> can be set true to surpress email decline notices.
4468 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4469 resulting paynum, if any.
4471 I<payunique> is a unique identifier for this payment.
4473 I<session_id> is a session identifier associated with this payment.
4475 I<depend_jobnum> allows payment capture to unlock export jobs
4477 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
4481 # some helper routines
4482 sub _bop_recurring_billing {
4483 my( $self, %opt ) = @_;
4485 my $method = scalar($conf->config('credit_card-recurring_billing_flag'));
4487 if ( defined($method) && $method eq 'transaction_is_recur' ) {
4489 return 1 if $opt{'trans_is_recur'};
4493 my %hash = ( 'custnum' => $self->custnum,
4498 if qsearch('cust_pay', { %hash, 'payinfo' => $opt{'payinfo'} } )
4499 || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo('CARD',
4509 sub _payment_gateway {
4510 my ($self, $options) = @_;
4512 $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
4513 unless exists($options->{payment_gateway});
4515 $options->{payment_gateway};
4519 my ($self, $options) = @_;
4522 'login' => $options->{payment_gateway}->gateway_username,
4523 'password' => $options->{payment_gateway}->gateway_password,
4528 my ($self, $options) = @_;
4530 $options->{payment_gateway}->gatewaynum
4531 ? $options->{payment_gateway}->options
4532 : @{ $options->{payment_gateway}->get('options') };
4537 my ($self, $options) = @_;
4539 unless ( $options->{'description'} ) {
4540 if ( $conf->exists('business-onlinepayment-description') ) {
4541 my $dtempl = $conf->config('business-onlinepayment-description');
4543 my $agent = $self->agent->agent;
4545 $options->{'description'} = eval qq("$dtempl");
4547 $options->{'description'} = 'Internet services';
4551 $options->{payinfo} = $self->payinfo unless exists( $options->{payinfo} );
4552 $options->{invnum} ||= '';
4553 $options->{payname} = $self->payname unless exists( $options->{payname} );
4557 my ($self, $options) = @_;
4560 my $payip = exists($options->{'payip'}) ? $options->{'payip'} : $self->payip;
4561 $content{customer_ip} = $payip if length($payip);
4563 $content{invoice_number} = $options->{'invnum'}
4564 if exists($options->{'invnum'}) && length($options->{'invnum'});
4566 $content{email_customer} =
4567 ( $conf->exists('business-onlinepayment-email_customer')
4568 || $conf->exists('business-onlinepayment-email-override') );
4570 my ($payname, $payfirst, $paylast);
4571 if ( $options->{payname} && $options->{method} ne 'ECHECK' ) {
4572 ($payname = $options->{payname}) =~
4573 /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4574 or return "Illegal payname $payname";
4575 ($payfirst, $paylast) = ($1, $2);
4577 $payfirst = $self->getfield('first');
4578 $paylast = $self->getfield('last');
4579 $payname = "$payfirst $paylast";
4582 $content{last_name} = $paylast;
4583 $content{first_name} = $payfirst;
4585 $content{name} = $payname;
4587 $content{address} = exists($options->{'address1'})
4588 ? $options->{'address1'}
4590 my $address2 = exists($options->{'address2'})
4591 ? $options->{'address2'}
4593 $content{address} .= ", ". $address2 if length($address2);
4595 $content{city} = exists($options->{city})
4598 $content{state} = exists($options->{state})
4601 $content{zip} = exists($options->{zip})
4604 $content{country} = exists($options->{country})
4605 ? $options->{country}
4608 $content{referer} = 'http://cleanwhisker.420.am/'; #XXX fix referer :/
4609 $content{phone} = $self->daytime || $self->night;
4614 my %bop_method2payby = (
4624 if (ref($_[0]) eq 'HASH') {
4625 %options = %{$_[0]};
4627 my ( $method, $amount ) = ( shift, shift );
4629 $options{method} = $method;
4630 $options{amount} = $amount;
4634 warn "$me realtime_bop (new): $options{method} $options{amount}\n";
4635 warn " $_ => $options{$_}\n" foreach keys %options;
4638 return $self->fake_bop(%options) if $options{'fake'};
4640 $self->_bop_defaults(\%options);
4643 # set trans_is_recur based on invnum if there is one
4646 my $trans_is_recur = 0;
4647 if ( $options{'invnum'} ) {
4649 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
4650 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
4653 map { $_->part_pkg }
4655 map { $_->cust_pkg }
4656 $cust_bill->cust_bill_pkg;
4659 if grep { $_->freq ne '0' } @part_pkg;
4667 my $payment_gateway = $self->_payment_gateway( \%options );
4668 my $namespace = $payment_gateway->gateway_namespace;
4670 eval "use $namespace";
4674 # check for banned credit card/ACH
4677 my $ban = qsearchs('banned_pay', {
4678 'payby' => $bop_method2payby{$options{method}},
4679 'payinfo' => md5_base64($options{payinfo}),
4681 return "Banned credit card" if $ban;
4687 my $bop_content = $self->_bop_content(\%options);
4688 return $bop_content unless ref($bop_content);
4690 my @invoicing_list = $self->invoicing_list_emailonly;
4691 if ( $conf->exists('emailinvoiceautoalways')
4692 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4693 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4694 push @invoicing_list, $self->all_emails;
4697 my $email = ($conf->exists('business-onlinepayment-email-override'))
4698 ? $conf->config('business-onlinepayment-email-override')
4699 : $invoicing_list[0];
4703 if ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'CC' ) {
4705 $content{card_number} = $options{payinfo};
4706 $paydate = exists($options{'paydate'})
4707 ? $options{'paydate'}
4709 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4710 $content{expiration} = "$2/$1";
4712 my $paycvv = exists($options{'paycvv'})
4713 ? $options{'paycvv'}
4715 $content{cvv2} = $paycvv
4718 my $paystart_month = exists($options{'paystart_month'})
4719 ? $options{'paystart_month'}
4720 : $self->paystart_month;
4722 my $paystart_year = exists($options{'paystart_year'})
4723 ? $options{'paystart_year'}
4724 : $self->paystart_year;
4726 $content{card_start} = "$paystart_month/$paystart_year"
4727 if $paystart_month && $paystart_year;
4729 my $payissue = exists($options{'payissue'})
4730 ? $options{'payissue'}
4732 $content{issue_number} = $payissue if $payissue;
4734 if ( $self->_bop_recurring_billing( 'payinfo' => $options{'payinfo'},
4735 'trans_is_recur' => $trans_is_recur,
4739 $content{recurring_billing} = 'YES';
4740 $content{acct_code} = 'rebill'
4741 if $conf->exists('credit_card-recurring_billing_acct_code');
4744 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'ECHECK' ){
4745 ( $content{account_number}, $content{routing_code} ) =
4746 split('@', $options{payinfo});
4747 $content{bank_name} = $options{payname};
4748 $content{bank_state} = exists($options{'paystate'})
4749 ? $options{'paystate'}
4750 : $self->getfield('paystate');
4751 $content{account_type} = exists($options{'paytype'})
4752 ? uc($options{'paytype'}) || 'CHECKING'
4753 : uc($self->getfield('paytype')) || 'CHECKING';
4754 $content{account_name} = $self->getfield('first'). ' '.
4755 $self->getfield('last');
4757 $content{customer_org} = $self->company ? 'B' : 'I';
4758 $content{state_id} = exists($options{'stateid'})
4759 ? $options{'stateid'}
4760 : $self->getfield('stateid');
4761 $content{state_id_state} = exists($options{'stateid_state'})
4762 ? $options{'stateid_state'}
4763 : $self->getfield('stateid_state');
4764 $content{customer_ssn} = exists($options{'ss'})
4767 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'LEC' ) {
4768 $content{phone} = $options{payinfo};
4769 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
4776 # run transaction(s)
4779 my $balance = exists( $options{'balance'} )
4780 ? $options{'balance'}
4783 $self->select_for_update; #mutex ... just until we get our pending record in
4785 #the checks here are intended to catch concurrent payments
4786 #double-form-submission prevention is taken care of in cust_pay_pending::check
4789 return "The customer's balance has changed; $options{method} transaction aborted."
4790 if $self->balance < $balance;
4791 #&& $self->balance < $options{amount}; #might as well anyway?
4793 #also check and make sure there aren't *other* pending payments for this cust
4795 my @pending = qsearch('cust_pay_pending', {
4796 'custnum' => $self->custnum,
4797 'status' => { op=>'!=', value=>'done' }
4799 return "A payment is already being processed for this customer (".
4800 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
4801 "); $options{method} transaction aborted."
4802 if scalar(@pending);
4804 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
4806 my $cust_pay_pending = new FS::cust_pay_pending {
4807 'custnum' => $self->custnum,
4808 #'invnum' => $options{'invnum'},
4809 'paid' => $options{amount},
4811 'payby' => $bop_method2payby{$options{method}},
4812 'payinfo' => $options{payinfo},
4813 'paydate' => $paydate,
4814 'recurring_billing' => $content{recurring_billing},
4815 'pkgnum' => $options{'pkgnum'},
4817 'gatewaynum' => $payment_gateway->gatewaynum || '',
4818 'session_id' => $options{session_id} || '',
4819 'jobnum' => $options{depend_jobnum} || '',
4821 $cust_pay_pending->payunique( $options{payunique} )
4822 if defined($options{payunique}) && length($options{payunique});
4823 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
4824 return $cpp_new_err if $cpp_new_err;
4826 my( $action1, $action2 ) =
4827 split( /\s*\,\s*/, $payment_gateway->gateway_action );
4829 my $transaction = new $namespace( $payment_gateway->gateway_module,
4830 $self->_bop_options(\%options),
4833 $transaction->content(
4834 'type' => $options{method},
4835 $self->_bop_auth(\%options),
4836 'action' => $action1,
4837 'description' => $options{'description'},
4838 'amount' => $options{amount},
4839 #'invoice_number' => $options{'invnum'},
4840 'customer_id' => $self->custnum,
4842 'reference' => $cust_pay_pending->paypendingnum, #for now
4847 $cust_pay_pending->status('pending');
4848 my $cpp_pending_err = $cust_pay_pending->replace;
4849 return $cpp_pending_err if $cpp_pending_err;
4852 my $BOP_TESTING = 0;
4853 my $BOP_TESTING_SUCCESS = 1;
4855 unless ( $BOP_TESTING ) {
4856 $transaction->test_transaction(1)
4857 if $conf->exists('business-onlinepayment-test_transaction');
4858 $transaction->submit();
4860 if ( $BOP_TESTING_SUCCESS ) {
4861 $transaction->is_success(1);
4862 $transaction->authorization('fake auth');
4864 $transaction->is_success(0);
4865 $transaction->error_message('fake failure');
4869 if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
4871 return { reference => $cust_pay_pending->paypendingnum,
4872 map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
4874 } elsif ( $transaction->is_success() && $action2 ) {
4876 $cust_pay_pending->status('authorized');
4877 my $cpp_authorized_err = $cust_pay_pending->replace;
4878 return $cpp_authorized_err if $cpp_authorized_err;
4880 my $auth = $transaction->authorization;
4881 my $ordernum = $transaction->can('order_number')
4882 ? $transaction->order_number
4886 new Business::OnlinePayment( $payment_gateway->gateway_module,
4887 $self->_bop_options(\%options),
4892 type => $options{method},
4894 $self->_bop_auth(\%options),
4895 order_number => $ordernum,
4896 amount => $options{amount},
4897 authorization => $auth,
4898 description => $options{'description'},
4901 foreach my $field (qw( authorization_source_code returned_ACI
4902 transaction_identifier validation_code
4903 transaction_sequence_num local_transaction_date
4904 local_transaction_time AVS_result_code )) {
4905 $capture{$field} = $transaction->$field() if $transaction->can($field);
4908 $capture->content( %capture );
4910 $capture->test_transaction(1)
4911 if $conf->exists('business-onlinepayment-test_transaction');
4914 unless ( $capture->is_success ) {
4915 my $e = "Authorization successful but capture failed, custnum #".
4916 $self->custnum. ': '. $capture->result_code.
4917 ": ". $capture->error_message;
4925 # remove paycvv after initial transaction
4928 #false laziness w/misc/process/payment.cgi - check both to make sure working
4930 if ( defined $self->dbdef_table->column('paycvv')
4931 && length($self->paycvv)
4932 && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
4934 my $error = $self->remove_cvv;
4936 warn "WARNING: error removing cvv: $error\n";
4945 if ( $transaction->can('card_token') && $transaction->card_token ) {
4947 $self->card_token($transaction->card_token);
4949 if ( $options{'payinfo'} eq $self->payinfo ) {
4950 $self->payinfo($transaction->card_token);
4951 my $error = $self->replace;
4953 warn "WARNING: error storing token: $error, but proceeding anyway\n";
4963 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
4975 if (ref($_[0]) eq 'HASH') {
4976 %options = %{$_[0]};
4978 my ( $method, $amount ) = ( shift, shift );
4980 $options{method} = $method;
4981 $options{amount} = $amount;
4984 if ( $options{'fake_failure'} ) {
4985 return "Error: No error; test failure requested with fake_failure";
4989 #if ( $payment_gateway->gatewaynum ) { # agent override
4990 # $paybatch = $payment_gateway->gatewaynum. '-';
4993 #$paybatch .= "$processor:". $transaction->authorization;
4995 #$paybatch .= ':'. $transaction->order_number
4996 # if $transaction->can('order_number')
4997 # && length($transaction->order_number);
4999 my $paybatch = 'FakeProcessor:54:32';
5001 my $cust_pay = new FS::cust_pay ( {
5002 'custnum' => $self->custnum,
5003 'invnum' => $options{'invnum'},
5004 'paid' => $options{amount},
5006 'payby' => $bop_method2payby{$options{method}},
5007 #'payinfo' => $payinfo,
5008 'payinfo' => '4111111111111111',
5009 'paybatch' => $paybatch,
5010 #'paydate' => $paydate,
5011 'paydate' => '2012-05-01',
5013 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
5015 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5018 $cust_pay->invnum(''); #try again with no specific invnum
5019 my $error2 = $cust_pay->insert( $options{'manual'} ?
5020 ( 'manual' => 1 ) : ()
5023 # gah, even with transactions.
5024 my $e = 'WARNING: Card/ACH debited but database not updated - '.
5025 "error inserting (fake!) payment: $error2".
5026 " (previously tried insert with invnum #$options{'invnum'}" .
5033 if ( $options{'paynum_ref'} ) {
5034 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5037 return ''; #no error
5042 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
5044 # Wraps up processing of a realtime credit card, ACH (electronic check) or
5045 # phone bill transaction.
5047 sub _realtime_bop_result {
5048 my( $self, $cust_pay_pending, $transaction, %options ) = @_;
5050 warn "$me _realtime_bop_result: pending transaction ".
5051 $cust_pay_pending->paypendingnum. "\n";
5052 warn " $_ => $options{$_}\n" foreach keys %options;
5055 my $payment_gateway = $options{payment_gateway}
5056 or return "no payment gateway in arguments to _realtime_bop_result";
5058 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
5059 my $cpp_captured_err = $cust_pay_pending->replace;
5060 return $cpp_captured_err if $cpp_captured_err;
5062 if ( $transaction->is_success() ) {
5065 if ( $payment_gateway->gatewaynum ) { # agent override
5066 $paybatch = $payment_gateway->gatewaynum. '-';
5069 $paybatch .= $payment_gateway->gateway_module. ":".
5070 $transaction->authorization;
5072 $paybatch .= ':'. $transaction->order_number
5073 if $transaction->can('order_number')
5074 && length($transaction->order_number);
5076 my $cust_pay = new FS::cust_pay ( {
5077 'custnum' => $self->custnum,
5078 'invnum' => $options{'invnum'},
5079 'paid' => $cust_pay_pending->paid,
5081 'payby' => $cust_pay_pending->payby,
5082 'payinfo' => $options{'payinfo'},
5083 'paybatch' => $paybatch,
5084 'paydate' => $cust_pay_pending->paydate,
5085 'pkgnum' => $cust_pay_pending->pkgnum,
5087 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
5088 $cust_pay->payunique( $options{payunique} )
5089 if defined($options{payunique}) && length($options{payunique});
5091 my $oldAutoCommit = $FS::UID::AutoCommit;
5092 local $FS::UID::AutoCommit = 0;
5095 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
5097 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5100 $cust_pay->invnum(''); #try again with no specific invnum
5101 my $error2 = $cust_pay->insert( $options{'manual'} ?
5102 ( 'manual' => 1 ) : ()
5105 # gah. but at least we have a record of the state we had to abort in
5106 # from cust_pay_pending now.
5107 my $e = "WARNING: $options{method} captured but payment not recorded -".
5108 " error inserting payment (". $payment_gateway->gateway_module.
5110 " (previously tried insert with invnum #$options{'invnum'}" .
5111 ": $error ) - pending payment saved as paypendingnum ".
5112 $cust_pay_pending->paypendingnum. "\n";
5118 my $jobnum = $cust_pay_pending->jobnum;
5120 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5122 unless ( $placeholder ) {
5123 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5124 my $e = "WARNING: $options{method} captured but job $jobnum not ".
5125 "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
5130 $error = $placeholder->delete;
5133 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5134 my $e = "WARNING: $options{method} captured but could not delete ".
5135 "job $jobnum for paypendingnum ".
5136 $cust_pay_pending->paypendingnum. ": $error\n";
5143 if ( $options{'paynum_ref'} ) {
5144 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5147 $cust_pay_pending->status('done');
5148 $cust_pay_pending->statustext('captured');
5149 $cust_pay_pending->paynum($cust_pay->paynum);
5150 my $cpp_done_err = $cust_pay_pending->replace;
5152 if ( $cpp_done_err ) {
5154 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5155 my $e = "WARNING: $options{method} captured but payment not recorded - ".
5156 "error updating status for paypendingnum ".
5157 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5163 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5165 if ( $options{'apply'} ) {
5166 my $apply_error = $self->apply_payments_and_credits;
5167 if ( $apply_error ) {
5168 warn "WARNING: error applying payment: $apply_error\n";
5169 #but we still should return no error cause the payment otherwise went
5174 return ''; #no error
5180 my $perror = $payment_gateway->gateway_module. " error: ".
5181 $transaction->error_message;
5183 my $jobnum = $cust_pay_pending->jobnum;
5185 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5187 if ( $placeholder ) {
5188 my $error = $placeholder->depended_delete;
5189 $error ||= $placeholder->delete;
5190 warn "error removing provisioning jobs after declined paypendingnum ".
5191 $cust_pay_pending->paypendingnum. "\n";
5193 my $e = "error finding job $jobnum for declined paypendingnum ".
5194 $cust_pay_pending->paypendingnum. "\n";
5200 unless ( $transaction->error_message ) {
5203 if ( $transaction->can('response_page') ) {
5205 'page' => ( $transaction->can('response_page')
5206 ? $transaction->response_page
5209 'code' => ( $transaction->can('response_code')
5210 ? $transaction->response_code
5213 'headers' => ( $transaction->can('response_headers')
5214 ? $transaction->response_headers
5220 "No additional debugging information available for ".
5221 $payment_gateway->gateway_module;
5224 $perror .= "No error_message returned from ".
5225 $payment_gateway->gateway_module. " -- ".
5226 ( ref($t_response) ? Dumper($t_response) : $t_response );
5230 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
5231 && $conf->exists('emaildecline')
5232 && grep { $_ ne 'POST' } $self->invoicing_list
5233 && ! grep { $transaction->error_message =~ /$_/ }
5234 $conf->config('emaildecline-exclude')
5237 # Send a decline alert to the customer.
5238 my $msgnum = $conf->config('decline_msgnum', $self->agentnum);
5241 # include the raw error message in the transaction state
5242 $cust_pay_pending->setfield('error', $transaction->error_message);
5243 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
5244 $error = $msg_template->send( 'cust_main' => $self,
5245 'object' => $cust_pay_pending );
5249 my @templ = $conf->config('declinetemplate');
5250 my $template = new Text::Template (
5252 SOURCE => [ map "$_\n", @templ ],
5253 ) or return "($perror) can't create template: $Text::Template::ERROR";
5254 $template->compile()
5255 or return "($perror) can't compile template: $Text::Template::ERROR";
5259 scalar( $conf->config('company_name', $self->agentnum ) ),
5260 'company_address' =>
5261 join("\n", $conf->config('company_address', $self->agentnum ) ),
5262 'error' => $transaction->error_message,
5265 my $error = send_email(
5266 'from' => $conf->config('invoice_from', $self->agentnum ),
5267 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
5268 'subject' => 'Your payment could not be processed',
5269 'body' => [ $template->fill_in(HASH => $templ_hash) ],
5273 $perror .= " (also received error sending decline notification: $error)"
5278 $cust_pay_pending->status('done');
5279 $cust_pay_pending->statustext("declined: $perror");
5280 my $cpp_done_err = $cust_pay_pending->replace;
5281 if ( $cpp_done_err ) {
5282 my $e = "WARNING: $options{method} declined but pending payment not ".
5283 "resolved - error updating status for paypendingnum ".
5284 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5286 $perror = "$e ($perror)";
5294 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
5296 Verifies successful third party processing of a realtime credit card,
5297 ACH (electronic check) or phone bill transaction via a
5298 Business::OnlineThirdPartyPayment realtime gateway. See
5299 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5301 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
5303 The additional options I<payname>, I<city>, I<state>,
5304 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5305 if set, will override the value from the customer record.
5307 I<description> is a free-text field passed to the gateway. It defaults to
5308 "Internet services".
5310 If an I<invnum> is specified, this payment (if successful) is applied to the
5311 specified invoice. If you don't specify an I<invnum> you might want to
5312 call the B<apply_payments> method.
5314 I<quiet> can be set true to surpress email decline notices.
5316 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5317 resulting paynum, if any.
5319 I<payunique> is a unique identifier for this payment.
5321 Returns a hashref containing elements bill_error (which will be undefined
5322 upon success) and session_id of any associated session.
5326 sub realtime_botpp_capture {
5327 my( $self, $cust_pay_pending, %options ) = @_;
5329 warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
5330 warn " $_ => $options{$_}\n" foreach keys %options;
5333 eval "use Business::OnlineThirdPartyPayment";
5337 # select the gateway
5340 my $method = FS::payby->payby2bop($cust_pay_pending->payby);
5342 my $payment_gateway = $cust_pay_pending->gatewaynum
5343 ? qsearchs( 'payment_gateway',
5344 { gatewaynum => $cust_pay_pending->gatewaynum }
5346 : $self->agent->payment_gateway( 'method' => $method,
5347 # 'invnum' => $cust_pay_pending->invnum,
5348 # 'payinfo' => $cust_pay_pending->payinfo,
5351 $options{payment_gateway} = $payment_gateway; # for the helper subs
5357 my @invoicing_list = $self->invoicing_list_emailonly;
5358 if ( $conf->exists('emailinvoiceautoalways')
5359 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5360 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5361 push @invoicing_list, $self->all_emails;
5364 my $email = ($conf->exists('business-onlinepayment-email-override'))
5365 ? $conf->config('business-onlinepayment-email-override')
5366 : $invoicing_list[0];
5370 $content{email_customer} =
5371 ( $conf->exists('business-onlinepayment-email_customer')
5372 || $conf->exists('business-onlinepayment-email-override') );
5375 # run transaction(s)
5379 new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
5380 $self->_bop_options(\%options),
5383 $transaction->reference({ %options });
5385 $transaction->content(
5387 $self->_bop_auth(\%options),
5388 'action' => 'Post Authorization',
5389 'description' => $options{'description'},
5390 'amount' => $cust_pay_pending->paid,
5391 #'invoice_number' => $options{'invnum'},
5392 'customer_id' => $self->custnum,
5393 'referer' => 'http://cleanwhisker.420.am/',
5394 'reference' => $cust_pay_pending->paypendingnum,
5396 'phone' => $self->daytime || $self->night,
5398 # plus whatever is required for bogus capture avoidance
5401 $transaction->submit();
5404 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5407 bill_error => $error,
5408 session_id => $cust_pay_pending->session_id,
5413 =item default_payment_gateway DEPRECATED -- use agent->payment_gateway
5417 sub default_payment_gateway {
5418 my( $self, $method ) = @_;
5420 die "Real-time processing not enabled\n"
5421 unless $conf->exists('business-onlinepayment');
5423 #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
5426 my $bop_config = 'business-onlinepayment';
5427 $bop_config .= '-ach'
5428 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
5429 my ( $processor, $login, $password, $action, @bop_options ) =
5430 $conf->config($bop_config);
5431 $action ||= 'normal authorization';
5432 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
5433 die "No real-time processor is enabled - ".
5434 "did you set the business-onlinepayment configuration value?\n"
5437 ( $processor, $login, $password, $action, @bop_options )
5442 Removes the I<paycvv> field from the database directly.
5444 If there is an error, returns the error, otherwise returns false.
5450 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
5451 or return dbh->errstr;
5452 $sth->execute($self->custnum)
5453 or return $sth->errstr;
5458 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
5460 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
5461 via a Business::OnlinePayment realtime gateway. See
5462 L<http://420.am/business-onlinepayment> for supported gateways.
5464 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5466 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
5468 Most gateways require a reference to an original payment transaction to refund,
5469 so you probably need to specify a I<paynum>.
5471 I<amount> defaults to the original amount of the payment if not specified.
5473 I<reason> specifies a reason for the refund.
5475 I<paydate> specifies the expiration date for a credit card overriding the
5476 value from the customer record or the payment record. Specified as yyyy-mm-dd
5478 Implementation note: If I<amount> is unspecified or equal to the amount of the
5479 orignal payment, first an attempt is made to "void" the transaction via
5480 the gateway (to cancel a not-yet settled transaction) and then if that fails,
5481 the normal attempt is made to "refund" ("credit") the transaction via the
5482 gateway is attempted.
5484 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5485 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5486 #if set, will override the value from the customer record.
5488 #If an I<invnum> is specified, this payment (if successful) is applied to the
5489 #specified invoice. If you don't specify an I<invnum> you might want to
5490 #call the B<apply_payments> method.
5494 #some false laziness w/realtime_bop, not enough to make it worth merging
5495 #but some useful small subs should be pulled out
5496 sub realtime_refund_bop {
5500 if (ref($_[0]) eq 'HASH') {
5501 %options = %{$_[0]};
5505 $options{method} = $method;
5509 warn "$me realtime_refund_bop (new): $options{method} refund\n";
5510 warn " $_ => $options{$_}\n" foreach keys %options;
5514 # look up the original payment and optionally a gateway for that payment
5518 my $amount = $options{'amount'};
5520 my( $processor, $login, $password, @bop_options, $namespace ) ;
5521 my( $auth, $order_number ) = ( '', '', '' );
5523 if ( $options{'paynum'} ) {
5525 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
5526 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
5527 or return "Unknown paynum $options{'paynum'}";
5528 $amount ||= $cust_pay->paid;
5530 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
5531 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
5532 $cust_pay->paybatch;
5533 my $gatewaynum = '';
5534 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
5536 if ( $gatewaynum ) { #gateway for the payment to be refunded
5538 my $payment_gateway =
5539 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
5540 die "payment gateway $gatewaynum not found"
5541 unless $payment_gateway;
5543 $processor = $payment_gateway->gateway_module;
5544 $login = $payment_gateway->gateway_username;
5545 $password = $payment_gateway->gateway_password;
5546 $namespace = $payment_gateway->gateway_namespace;
5547 @bop_options = $payment_gateway->options;
5549 } else { #try the default gateway
5552 my $payment_gateway =
5553 $self->agent->payment_gateway('method' => $options{method});
5555 ( $conf_processor, $login, $password, $namespace ) =
5556 map { my $method = "gateway_$_"; $payment_gateway->$method }
5557 qw( module username password namespace );
5559 @bop_options = $payment_gateway->gatewaynum
5560 ? $payment_gateway->options
5561 : @{ $payment_gateway->get('options') };
5563 return "processor of payment $options{'paynum'} $processor does not".
5564 " match default processor $conf_processor"
5565 unless $processor eq $conf_processor;
5570 } else { # didn't specify a paynum, so look for agent gateway overrides
5571 # like a normal transaction
5573 my $payment_gateway =
5574 $self->agent->payment_gateway( 'method' => $options{method},
5575 #'payinfo' => $payinfo,
5577 my( $processor, $login, $password, $namespace ) =
5578 map { my $method = "gateway_$_"; $payment_gateway->$method }
5579 qw( module username password namespace );
5581 my @bop_options = $payment_gateway->gatewaynum
5582 ? $payment_gateway->options
5583 : @{ $payment_gateway->get('options') };
5586 return "neither amount nor paynum specified" unless $amount;
5588 eval "use $namespace";
5592 'type' => $options{method},
5594 'password' => $password,
5595 'order_number' => $order_number,
5596 'amount' => $amount,
5597 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
5599 $content{authorization} = $auth
5600 if length($auth); #echeck/ACH transactions have an order # but no auth
5601 #(at least with authorize.net)
5603 my $disable_void_after;
5604 if ($conf->exists('disable_void_after')
5605 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
5606 $disable_void_after = $1;
5609 #first try void if applicable
5610 if ( $cust_pay && $cust_pay->paid == $amount
5612 ( not defined($disable_void_after) )
5613 || ( time < ($cust_pay->_date + $disable_void_after ) )
5616 warn " attempting void\n" if $DEBUG > 1;
5617 my $void = new Business::OnlinePayment( $processor, @bop_options );
5618 if ( $void->can('info') ) {
5619 if ( $cust_pay->payby eq 'CARD'
5620 && $void->info('CC_void_requires_card') )
5622 $content{'card_number'} = $cust_pay->payinfo;
5623 } elsif ( $cust_pay->payby eq 'CHEK'
5624 && $void->info('ECHECK_void_requires_account') )
5626 ( $content{'account_number'}, $content{'routing_code'} ) =
5627 split('@', $cust_pay->payinfo);
5628 $content{'name'} = $self->get('first'). ' '. $self->get('last');
5631 $void->content( 'action' => 'void', %content );
5632 $void->test_transaction(1)
5633 if $conf->exists('business-onlinepayment-test_transaction');
5635 if ( $void->is_success ) {
5636 my $error = $cust_pay->void($options{'reason'});
5638 # gah, even with transactions.
5639 my $e = 'WARNING: Card/ACH voided but database not updated - '.
5640 "error voiding payment: $error";
5644 warn " void successful\n" if $DEBUG > 1;
5649 warn " void unsuccessful, trying refund\n"
5653 my $address = $self->address1;
5654 $address .= ", ". $self->address2 if $self->address2;
5656 my($payname, $payfirst, $paylast);
5657 if ( $self->payname && $options{method} ne 'ECHECK' ) {
5658 $payname = $self->payname;
5659 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5660 or return "Illegal payname $payname";
5661 ($payfirst, $paylast) = ($1, $2);
5663 $payfirst = $self->getfield('first');
5664 $paylast = $self->getfield('last');
5665 $payname = "$payfirst $paylast";
5668 my @invoicing_list = $self->invoicing_list_emailonly;
5669 if ( $conf->exists('emailinvoiceautoalways')
5670 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5671 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5672 push @invoicing_list, $self->all_emails;
5675 my $email = ($conf->exists('business-onlinepayment-email-override'))
5676 ? $conf->config('business-onlinepayment-email-override')
5677 : $invoicing_list[0];
5679 my $payip = exists($options{'payip'})
5682 $content{customer_ip} = $payip
5686 if ( $options{method} eq 'CC' ) {
5689 $content{card_number} = $payinfo = $cust_pay->payinfo;
5690 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
5691 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
5692 ($content{expiration} = "$2/$1"); # where available
5694 $content{card_number} = $payinfo = $self->payinfo;
5695 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
5696 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
5697 $content{expiration} = "$2/$1";
5700 } elsif ( $options{method} eq 'ECHECK' ) {
5703 $payinfo = $cust_pay->payinfo;
5705 $payinfo = $self->payinfo;
5707 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
5708 $content{bank_name} = $self->payname;
5709 $content{account_type} = 'CHECKING';
5710 $content{account_name} = $payname;
5711 $content{customer_org} = $self->company ? 'B' : 'I';
5712 $content{customer_ssn} = $self->ss;
5713 } elsif ( $options{method} eq 'LEC' ) {
5714 $content{phone} = $payinfo = $self->payinfo;
5718 my $refund = new Business::OnlinePayment( $processor, @bop_options );
5719 my %sub_content = $refund->content(
5720 'action' => 'credit',
5721 'customer_id' => $self->custnum,
5722 'last_name' => $paylast,
5723 'first_name' => $payfirst,
5725 'address' => $address,
5726 'city' => $self->city,
5727 'state' => $self->state,
5728 'zip' => $self->zip,
5729 'country' => $self->country,
5731 'phone' => $self->daytime || $self->night,
5734 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
5736 $refund->test_transaction(1)
5737 if $conf->exists('business-onlinepayment-test_transaction');
5740 return "$processor error: ". $refund->error_message
5741 unless $refund->is_success();
5743 my $paybatch = "$processor:". $refund->authorization;
5744 $paybatch .= ':'. $refund->order_number
5745 if $refund->can('order_number') && $refund->order_number;
5747 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
5748 my @cust_bill_pay = $cust_pay->cust_bill_pay;
5749 last unless @cust_bill_pay;
5750 my $cust_bill_pay = pop @cust_bill_pay;
5751 my $error = $cust_bill_pay->delete;
5755 my $cust_refund = new FS::cust_refund ( {
5756 'custnum' => $self->custnum,
5757 'paynum' => $options{'paynum'},
5758 'refund' => $amount,
5760 'payby' => $bop_method2payby{$options{method}},
5761 'payinfo' => $payinfo,
5762 'paybatch' => $paybatch,
5763 'reason' => $options{'reason'} || 'card or ACH refund',
5765 my $error = $cust_refund->insert;
5767 $cust_refund->paynum(''); #try again with no specific paynum
5768 my $error2 = $cust_refund->insert;
5770 # gah, even with transactions.
5771 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
5772 "error inserting refund ($processor): $error2".
5773 " (previously tried insert with paynum #$options{'paynum'}" .
5784 =item batch_card OPTION => VALUE...
5786 Adds a payment for this invoice to the pending credit card batch (see
5787 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
5788 runs the payment using a realtime gateway.
5793 my ($self, %options) = @_;
5796 if (exists($options{amount})) {
5797 $amount = $options{amount};
5799 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
5801 return '' unless $amount > 0;
5803 my $invnum = delete $options{invnum};
5804 my $payby = $options{invnum} || $self->payby; #dubious
5806 if ($options{'realtime'}) {
5807 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
5813 my $oldAutoCommit = $FS::UID::AutoCommit;
5814 local $FS::UID::AutoCommit = 0;
5817 #this needs to handle mysql as well as Pg, like svc_acct.pm
5818 #(make it into a common function if folks need to do batching with mysql)
5819 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
5820 or return "Cannot lock pay_batch: " . $dbh->errstr;
5824 'payby' => FS::payby->payby2payment($payby),
5827 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
5829 unless ( $pay_batch ) {
5830 $pay_batch = new FS::pay_batch \%pay_batch;
5831 my $error = $pay_batch->insert;
5833 $dbh->rollback if $oldAutoCommit;
5834 die "error creating new batch: $error\n";
5838 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
5839 'batchnum' => $pay_batch->batchnum,
5840 'custnum' => $self->custnum,
5843 foreach (qw( address1 address2 city state zip country payby payinfo paydate
5845 $options{$_} = '' unless exists($options{$_});
5848 my $cust_pay_batch = new FS::cust_pay_batch ( {
5849 'batchnum' => $pay_batch->batchnum,
5850 'invnum' => $invnum || 0, # is there a better value?
5851 # this field should be
5853 # cust_bill_pay_batch now
5854 'custnum' => $self->custnum,
5855 'last' => $self->getfield('last'),
5856 'first' => $self->getfield('first'),
5857 'address1' => $options{address1} || $self->address1,
5858 'address2' => $options{address2} || $self->address2,
5859 'city' => $options{city} || $self->city,
5860 'state' => $options{state} || $self->state,
5861 'zip' => $options{zip} || $self->zip,
5862 'country' => $options{country} || $self->country,
5863 'payby' => $options{payby} || $self->payby,
5864 'payinfo' => $options{payinfo} || $self->payinfo,
5865 'exp' => $options{paydate} || $self->paydate,
5866 'payname' => $options{payname} || $self->payname,
5867 'amount' => $amount, # consolidating
5870 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
5871 if $old_cust_pay_batch;
5874 if ($old_cust_pay_batch) {
5875 $error = $cust_pay_batch->replace($old_cust_pay_batch)
5877 $error = $cust_pay_batch->insert;
5881 $dbh->rollback if $oldAutoCommit;
5885 my $unapplied = $self->total_unapplied_credits
5886 + $self->total_unapplied_payments
5887 + $self->in_transit_payments;
5888 foreach my $cust_bill ($self->open_cust_bill) {
5889 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
5890 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
5891 'invnum' => $cust_bill->invnum,
5892 'paybatchnum' => $cust_pay_batch->paybatchnum,
5893 'amount' => $cust_bill->owed,
5896 if ($unapplied >= $cust_bill_pay_batch->amount){
5897 $unapplied -= $cust_bill_pay_batch->amount;
5900 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
5901 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
5903 $error = $cust_bill_pay_batch->insert;
5905 $dbh->rollback if $oldAutoCommit;
5910 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5914 =item apply_payments_and_credits [ OPTION => VALUE ... ]
5916 Applies unapplied payments and credits.
5918 In most cases, this new method should be used in place of sequential
5919 apply_payments and apply_credits methods.
5921 A hash of optional arguments may be passed. Currently "manual" is supported.
5922 If true, a payment receipt is sent instead of a statement when
5923 'payment_receipt_email' configuration option is set.
5925 If there is an error, returns the error, otherwise returns false.
5929 sub apply_payments_and_credits {
5930 my( $self, %options ) = @_;
5932 local $SIG{HUP} = 'IGNORE';
5933 local $SIG{INT} = 'IGNORE';
5934 local $SIG{QUIT} = 'IGNORE';
5935 local $SIG{TERM} = 'IGNORE';
5936 local $SIG{TSTP} = 'IGNORE';
5937 local $SIG{PIPE} = 'IGNORE';
5939 my $oldAutoCommit = $FS::UID::AutoCommit;
5940 local $FS::UID::AutoCommit = 0;
5943 $self->select_for_update; #mutex
5945 foreach my $cust_bill ( $self->open_cust_bill ) {
5946 my $error = $cust_bill->apply_payments_and_credits(%options);
5948 $dbh->rollback if $oldAutoCommit;
5949 return "Error applying: $error";
5953 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5958 =item apply_credits OPTION => VALUE ...
5960 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
5961 to outstanding invoice balances in chronological order (or reverse
5962 chronological order if the I<order> option is set to B<newest>) and returns the
5963 value of any remaining unapplied credits available for refund (see
5964 L<FS::cust_refund>).
5966 Dies if there is an error.
5974 local $SIG{HUP} = 'IGNORE';
5975 local $SIG{INT} = 'IGNORE';
5976 local $SIG{QUIT} = 'IGNORE';
5977 local $SIG{TERM} = 'IGNORE';
5978 local $SIG{TSTP} = 'IGNORE';
5979 local $SIG{PIPE} = 'IGNORE';
5981 my $oldAutoCommit = $FS::UID::AutoCommit;
5982 local $FS::UID::AutoCommit = 0;
5985 $self->select_for_update; #mutex
5987 unless ( $self->total_unapplied_credits ) {
5988 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5992 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
5993 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
5995 my @invoices = $self->open_cust_bill;
5996 @invoices = sort { $b->_date <=> $a->_date } @invoices
5997 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
5999 if ( $conf->exists('pkg-balances') ) {
6000 # limit @credits to those w/ a pkgnum grepped from $self
6002 foreach my $i (@invoices) {
6003 foreach my $li ( $i->cust_bill_pkg ) {
6004 $pkgnums{$li->pkgnum} = 1;
6007 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
6012 foreach my $cust_bill ( @invoices ) {
6014 if ( !defined($credit) || $credit->credited == 0) {
6015 $credit = pop @credits or last;
6019 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
6020 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
6022 $owed = $cust_bill->owed;
6024 unless ( $owed > 0 ) {
6025 push @credits, $credit;
6029 my $amount = min( $credit->credited, $owed );
6031 my $cust_credit_bill = new FS::cust_credit_bill ( {
6032 'crednum' => $credit->crednum,
6033 'invnum' => $cust_bill->invnum,
6034 'amount' => $amount,
6036 $cust_credit_bill->pkgnum( $credit->pkgnum )
6037 if $conf->exists('pkg-balances') && $credit->pkgnum;
6038 my $error = $cust_credit_bill->insert;
6040 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6044 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6048 my $total_unapplied_credits = $self->total_unapplied_credits;
6050 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6052 return $total_unapplied_credits;
6055 =item apply_payments [ OPTION => VALUE ... ]
6057 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
6058 to outstanding invoice balances in chronological order.
6060 #and returns the value of any remaining unapplied payments.
6062 A hash of optional arguments may be passed. Currently "manual" is supported.
6063 If true, a payment receipt is sent instead of a statement when
6064 'payment_receipt_email' configuration option is set.
6066 Dies if there is an error.
6070 sub apply_payments {
6071 my( $self, %options ) = @_;
6073 local $SIG{HUP} = 'IGNORE';
6074 local $SIG{INT} = 'IGNORE';
6075 local $SIG{QUIT} = 'IGNORE';
6076 local $SIG{TERM} = 'IGNORE';
6077 local $SIG{TSTP} = 'IGNORE';
6078 local $SIG{PIPE} = 'IGNORE';
6080 my $oldAutoCommit = $FS::UID::AutoCommit;
6081 local $FS::UID::AutoCommit = 0;
6084 $self->select_for_update; #mutex
6088 my @payments = sort { $b->_date <=> $a->_date }
6089 grep { $_->unapplied > 0 }
6092 my @invoices = sort { $a->_date <=> $b->_date}
6093 grep { $_->owed > 0 }
6096 if ( $conf->exists('pkg-balances') ) {
6097 # limit @payments to those w/ a pkgnum grepped from $self
6099 foreach my $i (@invoices) {
6100 foreach my $li ( $i->cust_bill_pkg ) {
6101 $pkgnums{$li->pkgnum} = 1;
6104 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
6109 foreach my $cust_bill ( @invoices ) {
6111 if ( !defined($payment) || $payment->unapplied == 0 ) {
6112 $payment = pop @payments or last;
6116 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
6117 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
6119 $owed = $cust_bill->owed;
6121 unless ( $owed > 0 ) {
6122 push @payments, $payment;
6126 my $amount = min( $payment->unapplied, $owed );
6128 my $cust_bill_pay = new FS::cust_bill_pay ( {
6129 'paynum' => $payment->paynum,
6130 'invnum' => $cust_bill->invnum,
6131 'amount' => $amount,
6133 $cust_bill_pay->pkgnum( $payment->pkgnum )
6134 if $conf->exists('pkg-balances') && $payment->pkgnum;
6135 my $error = $cust_bill_pay->insert(%options);
6137 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6141 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6145 my $total_unapplied_payments = $self->total_unapplied_payments;
6147 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6149 return $total_unapplied_payments;
6154 Returns the total owed for this customer on all invoices
6155 (see L<FS::cust_bill/owed>).
6161 $self->total_owed_date(2145859200); #12/31/2037
6164 =item total_owed_date TIME
6166 Returns the total owed for this customer on all invoices with date earlier than
6167 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6168 see L<Time::Local> and L<Date::Parse> for conversion functions.
6172 sub total_owed_date {
6176 my $custnum = $self->custnum;
6178 my $owed_sql = FS::cust_bill->owed_sql;
6181 SELECT SUM($owed_sql) FROM cust_bill
6182 WHERE custnum = $custnum
6186 sprintf( "%.2f", $self->scalar_sql($sql) );
6190 =item total_owed_pkgnum PKGNUM
6192 Returns the total owed on all invoices for this customer's specific package
6193 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
6197 sub total_owed_pkgnum {
6198 my( $self, $pkgnum ) = @_;
6199 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
6202 =item total_owed_date_pkgnum TIME PKGNUM
6204 Returns the total owed for this customer's specific package when using
6205 experimental package balances on all invoices with date earlier than
6206 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6207 see L<Time::Local> and L<Date::Parse> for conversion functions.
6211 sub total_owed_date_pkgnum {
6212 my( $self, $time, $pkgnum ) = @_;
6215 foreach my $cust_bill (
6216 grep { $_->_date <= $time }
6217 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6219 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
6221 sprintf( "%.2f", $total_bill );
6227 Returns the total amount of all payments.
6234 $total += $_->paid foreach $self->cust_pay;
6235 sprintf( "%.2f", $total );
6238 =item total_unapplied_credits
6240 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6241 customer. See L<FS::cust_credit/credited>.
6243 =item total_credited
6245 Old name for total_unapplied_credits. Don't use.
6249 sub total_credited {
6250 #carp "total_credited deprecated, use total_unapplied_credits";
6251 shift->total_unapplied_credits(@_);
6254 sub total_unapplied_credits {
6257 my $custnum = $self->custnum;
6259 my $unapplied_sql = FS::cust_credit->unapplied_sql;
6262 SELECT SUM($unapplied_sql) FROM cust_credit
6263 WHERE custnum = $custnum
6266 sprintf( "%.2f", $self->scalar_sql($sql) );
6270 =item total_unapplied_credits_pkgnum PKGNUM
6272 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6273 customer. See L<FS::cust_credit/credited>.
6277 sub total_unapplied_credits_pkgnum {
6278 my( $self, $pkgnum ) = @_;
6279 my $total_credit = 0;
6280 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
6281 sprintf( "%.2f", $total_credit );
6285 =item total_unapplied_payments
6287 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
6288 See L<FS::cust_pay/unapplied>.
6292 sub total_unapplied_payments {
6295 my $custnum = $self->custnum;
6297 my $unapplied_sql = FS::cust_pay->unapplied_sql;
6300 SELECT SUM($unapplied_sql) FROM cust_pay
6301 WHERE custnum = $custnum
6304 sprintf( "%.2f", $self->scalar_sql($sql) );
6308 =item total_unapplied_payments_pkgnum PKGNUM
6310 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
6311 specific package when using experimental package balances. See
6312 L<FS::cust_pay/unapplied>.
6316 sub total_unapplied_payments_pkgnum {
6317 my( $self, $pkgnum ) = @_;
6318 my $total_unapplied = 0;
6319 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
6320 sprintf( "%.2f", $total_unapplied );
6324 =item total_unapplied_refunds
6326 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
6327 customer. See L<FS::cust_refund/unapplied>.
6331 sub total_unapplied_refunds {
6333 my $custnum = $self->custnum;
6335 my $unapplied_sql = FS::cust_refund->unapplied_sql;
6338 SELECT SUM($unapplied_sql) FROM cust_refund
6339 WHERE custnum = $custnum
6342 sprintf( "%.2f", $self->scalar_sql($sql) );
6348 Returns the balance for this customer (total_owed plus total_unrefunded, minus
6349 total_unapplied_credits minus total_unapplied_payments).
6355 $self->balance_date_range;
6358 =item balance_date TIME
6360 Returns the balance for this customer, only considering invoices with date
6361 earlier than TIME (total_owed_date minus total_credited minus
6362 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
6363 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
6370 $self->balance_date_range(shift);
6373 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
6375 Returns the balance for this customer, optionally considering invoices with
6376 date earlier than START_TIME, and not later than END_TIME
6377 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
6379 Times are specified as SQL fragments or numeric
6380 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
6381 L<Date::Parse> for conversion functions. The empty string can be passed
6382 to disable that time constraint completely.
6384 Available options are:
6388 =item unapplied_date
6390 set to true to disregard unapplied credits, payments and refunds outside the specified time period - by default the time period restriction only applies to invoices (useful for reporting, probably a bad idea for event triggering)
6396 sub balance_date_range {
6398 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
6399 ') FROM cust_main WHERE custnum='. $self->custnum;
6400 sprintf( '%.2f', $self->scalar_sql($sql) );
6403 =item balance_pkgnum PKGNUM
6405 Returns the balance for this customer's specific package when using
6406 experimental package balances (total_owed plus total_unrefunded, minus
6407 total_unapplied_credits minus total_unapplied_payments)
6411 sub balance_pkgnum {
6412 my( $self, $pkgnum ) = @_;
6415 $self->total_owed_pkgnum($pkgnum)
6416 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
6417 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
6418 - $self->total_unapplied_credits_pkgnum($pkgnum)
6419 - $self->total_unapplied_payments_pkgnum($pkgnum)
6423 =item in_transit_payments
6425 Returns the total of requests for payments for this customer pending in
6426 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
6430 sub in_transit_payments {
6432 my $in_transit_payments = 0;
6433 foreach my $pay_batch ( qsearch('pay_batch', {
6436 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
6437 'batchnum' => $pay_batch->batchnum,
6438 'custnum' => $self->custnum,
6440 $in_transit_payments += $cust_pay_batch->amount;
6443 sprintf( "%.2f", $in_transit_payments );
6448 Returns a hash of useful information for making a payment.
6458 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
6459 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
6460 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
6464 For credit card transactions:
6476 For electronic check transactions:
6491 $return{balance} = $self->balance;
6493 $return{payname} = $self->payname
6494 || ( $self->first. ' '. $self->get('last') );
6496 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
6498 $return{payby} = $self->payby;
6499 $return{stateid_state} = $self->stateid_state;
6501 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
6502 $return{card_type} = cardtype($self->payinfo);
6503 $return{payinfo} = $self->paymask;
6505 @return{'month', 'year'} = $self->paydate_monthyear;
6509 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
6510 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
6511 $return{payinfo1} = $payinfo1;
6512 $return{payinfo2} = $payinfo2;
6513 $return{paytype} = $self->paytype;
6514 $return{paystate} = $self->paystate;
6518 #doubleclick protection
6520 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
6526 =item paydate_monthyear
6528 Returns a two-element list consisting of the month and year of this customer's
6529 paydate (credit card expiration date for CARD customers)
6533 sub paydate_monthyear {
6535 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
6537 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
6544 =item tax_exemption TAXNAME
6549 my( $self, $taxname ) = @_;
6551 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
6552 'taxname' => $taxname,
6557 =item cust_main_exemption
6561 sub cust_main_exemption {
6563 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
6566 =item invoicing_list [ ARRAYREF ]
6568 If an arguement is given, sets these email addresses as invoice recipients
6569 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
6570 (except as warnings), so use check_invoicing_list first.
6572 Returns a list of email addresses (with svcnum entries expanded).
6574 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
6575 check it without disturbing anything by passing nothing.
6577 This interface may change in the future.
6581 sub invoicing_list {
6582 my( $self, $arrayref ) = @_;
6585 my @cust_main_invoice;
6586 if ( $self->custnum ) {
6587 @cust_main_invoice =
6588 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6590 @cust_main_invoice = ();
6592 foreach my $cust_main_invoice ( @cust_main_invoice ) {
6593 #warn $cust_main_invoice->destnum;
6594 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
6595 #warn $cust_main_invoice->destnum;
6596 my $error = $cust_main_invoice->delete;
6597 warn $error if $error;
6600 if ( $self->custnum ) {
6601 @cust_main_invoice =
6602 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6604 @cust_main_invoice = ();
6606 my %seen = map { $_->address => 1 } @cust_main_invoice;
6607 foreach my $address ( @{$arrayref} ) {
6608 next if exists $seen{$address} && $seen{$address};
6609 $seen{$address} = 1;
6610 my $cust_main_invoice = new FS::cust_main_invoice ( {
6611 'custnum' => $self->custnum,
6614 my $error = $cust_main_invoice->insert;
6615 warn $error if $error;
6619 if ( $self->custnum ) {
6621 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6628 =item check_invoicing_list ARRAYREF
6630 Checks these arguements as valid input for the invoicing_list method. If there
6631 is an error, returns the error, otherwise returns false.
6635 sub check_invoicing_list {
6636 my( $self, $arrayref ) = @_;
6638 foreach my $address ( @$arrayref ) {
6640 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
6641 return 'Can\'t add FAX invoice destination with a blank FAX number.';
6644 my $cust_main_invoice = new FS::cust_main_invoice ( {
6645 'custnum' => $self->custnum,
6648 my $error = $self->custnum
6649 ? $cust_main_invoice->check
6650 : $cust_main_invoice->checkdest
6652 return $error if $error;
6656 return "Email address required"
6657 if $conf->exists('cust_main-require_invoicing_list_email')
6658 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
6663 =item set_default_invoicing_list
6665 Sets the invoicing list to all accounts associated with this customer,
6666 overwriting any previous invoicing list.
6670 sub set_default_invoicing_list {
6672 $self->invoicing_list($self->all_emails);
6677 Returns the email addresses of all accounts provisioned for this customer.
6684 foreach my $cust_pkg ( $self->all_pkgs ) {
6685 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
6687 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
6688 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
6690 $list{$_}=1 foreach map { $_->email } @svc_acct;
6695 =item invoicing_list_addpost
6697 Adds postal invoicing to this customer. If this customer is already configured
6698 to receive postal invoices, does nothing.
6702 sub invoicing_list_addpost {
6704 return if grep { $_ eq 'POST' } $self->invoicing_list;
6705 my @invoicing_list = $self->invoicing_list;
6706 push @invoicing_list, 'POST';
6707 $self->invoicing_list(\@invoicing_list);
6710 =item invoicing_list_emailonly
6712 Returns the list of email invoice recipients (invoicing_list without non-email
6713 destinations such as POST and FAX).
6717 sub invoicing_list_emailonly {
6719 warn "$me invoicing_list_emailonly called"
6721 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
6724 =item invoicing_list_emailonly_scalar
6726 Returns the list of email invoice recipients (invoicing_list without non-email
6727 destinations such as POST and FAX) as a comma-separated scalar.
6731 sub invoicing_list_emailonly_scalar {
6733 warn "$me invoicing_list_emailonly_scalar called"
6735 join(', ', $self->invoicing_list_emailonly);
6738 =item referral_custnum_cust_main
6740 Returns the customer who referred this customer (or the empty string, if
6741 this customer was not referred).
6743 Note the difference with referral_cust_main method: This method,
6744 referral_custnum_cust_main returns the single customer (if any) who referred
6745 this customer, while referral_cust_main returns an array of customers referred
6750 sub referral_custnum_cust_main {
6752 return '' unless $self->referral_custnum;
6753 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
6756 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
6758 Returns an array of customers referred by this customer (referral_custnum set
6759 to this custnum). If DEPTH is given, recurses up to the given depth, returning
6760 customers referred by customers referred by this customer and so on, inclusive.
6761 The default behavior is DEPTH 1 (no recursion).
6763 Note the difference with referral_custnum_cust_main method: This method,
6764 referral_cust_main, returns an array of customers referred BY this customer,
6765 while referral_custnum_cust_main returns the single customer (if any) who
6766 referred this customer.
6770 sub referral_cust_main {
6772 my $depth = @_ ? shift : 1;
6773 my $exclude = @_ ? shift : {};
6776 map { $exclude->{$_->custnum}++; $_; }
6777 grep { ! $exclude->{ $_->custnum } }
6778 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
6782 map { $_->referral_cust_main($depth-1, $exclude) }
6789 =item referral_cust_main_ncancelled
6791 Same as referral_cust_main, except only returns customers with uncancelled
6796 sub referral_cust_main_ncancelled {
6798 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
6801 =item referral_cust_pkg [ DEPTH ]
6803 Like referral_cust_main, except returns a flat list of all unsuspended (and
6804 uncancelled) packages for each customer. The number of items in this list may
6805 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
6809 sub referral_cust_pkg {
6811 my $depth = @_ ? shift : 1;
6813 map { $_->unsuspended_pkgs }
6814 grep { $_->unsuspended_pkgs }
6815 $self->referral_cust_main($depth);
6818 =item referring_cust_main
6820 Returns the single cust_main record for the customer who referred this customer
6821 (referral_custnum), or false.
6825 sub referring_cust_main {
6827 return '' unless $self->referral_custnum;
6828 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
6831 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
6833 Applies a credit to this customer. If there is an error, returns the error,
6834 otherwise returns false.
6836 REASON can be a text string, an FS::reason object, or a scalar reference to
6837 a reasonnum. If a text string, it will be automatically inserted as a new
6838 reason, and a 'reason_type' option must be passed to indicate the
6839 FS::reason_type for the new reason.
6841 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
6843 Any other options are passed to FS::cust_credit::insert.
6848 my( $self, $amount, $reason, %options ) = @_;
6850 my $cust_credit = new FS::cust_credit {
6851 'custnum' => $self->custnum,
6852 'amount' => $amount,
6855 if ( ref($reason) ) {
6857 if ( ref($reason) eq 'SCALAR' ) {
6858 $cust_credit->reasonnum( $$reason );
6860 $cust_credit->reasonnum( $reason->reasonnum );
6864 $cust_credit->set('reason', $reason)
6867 for (qw( addlinfo eventnum )) {
6868 $cust_credit->$_( delete $options{$_} )
6869 if exists($options{$_});
6872 $cust_credit->insert(%options);
6876 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
6878 Creates a one-time charge for this customer. If there is an error, returns
6879 the error, otherwise returns false.
6881 New-style, with a hashref of options:
6883 my $error = $cust_main->charge(
6887 'start_date' => str2time('7/4/2009'),
6888 'pkg' => 'Description',
6889 'comment' => 'Comment',
6890 'additional' => [], #extra invoice detail
6891 'classnum' => 1, #pkg_class
6893 'setuptax' => '', # or 'Y' for tax exempt
6896 'taxclass' => 'Tax class',
6899 'taxproduct' => 2, #part_pkg_taxproduct
6900 'override' => {}, #XXX describe
6902 #will be filled in with the new object
6903 'cust_pkg_ref' => \$cust_pkg,
6905 #generate an invoice immediately
6907 'invoice_terms' => '', #with these terms
6913 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
6919 my ( $amount, $quantity, $start_date, $classnum );
6920 my ( $pkg, $comment, $additional );
6921 my ( $setuptax, $taxclass ); #internal taxes
6922 my ( $taxproduct, $override ); #vendor (CCH) taxes
6924 my $cust_pkg_ref = '';
6925 my ( $bill_now, $invoice_terms ) = ( 0, '' );
6926 if ( ref( $_[0] ) ) {
6927 $amount = $_[0]->{amount};
6928 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
6929 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
6930 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
6931 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
6932 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
6933 : '$'. sprintf("%.2f",$amount);
6934 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
6935 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
6936 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
6937 $additional = $_[0]->{additional} || [];
6938 $taxproduct = $_[0]->{taxproductnum};
6939 $override = { '' => $_[0]->{tax_override} };
6940 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
6941 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
6942 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
6947 $pkg = @_ ? shift : 'One-time charge';
6948 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
6950 $taxclass = @_ ? shift : '';
6954 local $SIG{HUP} = 'IGNORE';
6955 local $SIG{INT} = 'IGNORE';
6956 local $SIG{QUIT} = 'IGNORE';
6957 local $SIG{TERM} = 'IGNORE';
6958 local $SIG{TSTP} = 'IGNORE';
6959 local $SIG{PIPE} = 'IGNORE';
6961 my $oldAutoCommit = $FS::UID::AutoCommit;
6962 local $FS::UID::AutoCommit = 0;
6965 my $part_pkg = new FS::part_pkg ( {
6967 'comment' => $comment,
6971 'classnum' => ( $classnum ? $classnum : '' ),
6972 'setuptax' => $setuptax,
6973 'taxclass' => $taxclass,
6974 'taxproductnum' => $taxproduct,
6977 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
6978 ( 0 .. @$additional - 1 )
6980 'additional_count' => scalar(@$additional),
6981 'setup_fee' => $amount,
6984 my $error = $part_pkg->insert( options => \%options,
6985 tax_overrides => $override,
6988 $dbh->rollback if $oldAutoCommit;
6992 my $pkgpart = $part_pkg->pkgpart;
6993 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
6994 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
6995 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
6996 $error = $type_pkgs->insert;
6998 $dbh->rollback if $oldAutoCommit;
7003 my $cust_pkg = new FS::cust_pkg ( {
7004 'custnum' => $self->custnum,
7005 'pkgpart' => $pkgpart,
7006 'quantity' => $quantity,
7007 'start_date' => $start_date,
7008 'no_auto' => $no_auto,
7011 $error = $cust_pkg->insert;
7013 $dbh->rollback if $oldAutoCommit;
7015 } elsif ( $cust_pkg_ref ) {
7016 ${$cust_pkg_ref} = $cust_pkg;
7020 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
7021 'pkg_list' => [ $cust_pkg ],
7024 $dbh->rollback if $oldAutoCommit;
7029 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
7034 #=item charge_postal_fee
7036 #Applies a one time charge this customer. If there is an error,
7037 #returns the error, returns the cust_pkg charge object or false
7038 #if there was no charge.
7042 # This should be a customer event. For that to work requires that bill
7043 # also be a customer event.
7045 sub charge_postal_fee {
7048 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
7049 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
7051 my $cust_pkg = new FS::cust_pkg ( {
7052 'custnum' => $self->custnum,
7053 'pkgpart' => $pkgpart,
7057 my $error = $cust_pkg->insert;
7058 $error ? $error : $cust_pkg;
7063 Returns all the invoices (see L<FS::cust_bill>) for this customer.
7069 map { $_ } #return $self->num_cust_bill unless wantarray;
7070 sort { $a->_date <=> $b->_date }
7071 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
7074 =item open_cust_bill
7076 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
7081 sub open_cust_bill {
7085 'table' => 'cust_bill',
7086 'hashref' => { 'custnum' => $self->custnum, },
7087 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
7088 'order_by' => 'ORDER BY _date ASC',
7093 =item cust_statements
7095 Returns all the statements (see L<FS::cust_statement>) for this customer.
7099 sub cust_statement {
7101 map { $_ } #return $self->num_cust_statement unless wantarray;
7102 sort { $a->_date <=> $b->_date }
7103 qsearch('cust_statement', { 'custnum' => $self->custnum, } )
7108 Returns all the credits (see L<FS::cust_credit>) for this customer.
7114 map { $_ } #return $self->num_cust_credit unless wantarray;
7115 sort { $a->_date <=> $b->_date }
7116 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
7119 =item cust_credit_pkgnum
7121 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
7122 package when using experimental package balances.
7126 sub cust_credit_pkgnum {
7127 my( $self, $pkgnum ) = @_;
7128 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
7129 sort { $a->_date <=> $b->_date }
7130 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
7131 'pkgnum' => $pkgnum,
7138 Returns all the payments (see L<FS::cust_pay>) for this customer.
7144 return $self->num_cust_pay unless wantarray;
7145 sort { $a->_date <=> $b->_date }
7146 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
7151 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
7152 called automatically when the cust_pay method is used in a scalar context.
7158 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
7159 my $sth = dbh->prepare($sql) or die dbh->errstr;
7160 $sth->execute($self->custnum) or die $sth->errstr;
7161 $sth->fetchrow_arrayref->[0];
7164 =item cust_pay_pkgnum
7166 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
7167 package when using experimental package balances.
7171 sub cust_pay_pkgnum {
7172 my( $self, $pkgnum ) = @_;
7173 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
7174 sort { $a->_date <=> $b->_date }
7175 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
7176 'pkgnum' => $pkgnum,
7183 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
7189 map { $_ } #return $self->num_cust_pay_void unless wantarray;
7190 sort { $a->_date <=> $b->_date }
7191 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
7194 =item cust_pay_batch
7196 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
7200 sub cust_pay_batch {
7202 map { $_ } #return $self->num_cust_pay_batch unless wantarray;
7203 sort { $a->paybatchnum <=> $b->paybatchnum }
7204 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
7207 =item cust_pay_pending
7209 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
7210 (without status "done").
7214 sub cust_pay_pending {
7216 return $self->num_cust_pay_pending unless wantarray;
7217 sort { $a->_date <=> $b->_date }
7218 qsearch( 'cust_pay_pending', {
7219 'custnum' => $self->custnum,
7220 'status' => { op=>'!=', value=>'done' },
7225 =item cust_pay_pending_attempt
7227 Returns all payment attempts / declined payments for this customer, as pending
7228 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
7229 a corresponding payment (see L<FS::cust_pay>).
7233 sub cust_pay_pending_attempt {
7235 return $self->num_cust_pay_pending_attempt unless wantarray;
7236 sort { $a->_date <=> $b->_date }
7237 qsearch( 'cust_pay_pending', {
7238 'custnum' => $self->custnum,
7245 =item num_cust_pay_pending
7247 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
7248 customer (without status "done"). Also called automatically when the
7249 cust_pay_pending method is used in a scalar context.
7253 sub num_cust_pay_pending {
7256 " SELECT COUNT(*) FROM cust_pay_pending ".
7257 " WHERE custnum = ? AND status != 'done' ",
7262 =item num_cust_pay_pending_attempt
7264 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
7265 customer, with status "done" but without a corresp. Also called automatically when the
7266 cust_pay_pending method is used in a scalar context.
7270 sub num_cust_pay_pending_attempt {
7273 " SELECT COUNT(*) FROM cust_pay_pending ".
7274 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
7281 Returns all the refunds (see L<FS::cust_refund>) for this customer.
7287 map { $_ } #return $self->num_cust_refund unless wantarray;
7288 sort { $a->_date <=> $b->_date }
7289 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
7292 =item display_custnum
7294 Returns the displayed customer number for this customer: agent_custid if
7295 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
7299 sub display_custnum {
7301 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
7302 return $self->agent_custid;
7304 return $self->custnum;
7310 Returns a name string for this customer, either "Company (Last, First)" or
7317 my $name = $self->contact;
7318 $name = $self->company. " ($name)" if $self->company;
7324 Returns a name string for this (service/shipping) contact, either
7325 "Company (Last, First)" or "Last, First".
7331 if ( $self->get('ship_last') ) {
7332 my $name = $self->ship_contact;
7333 $name = $self->ship_company. " ($name)" if $self->ship_company;
7342 Returns a name string for this customer, either "Company" or "First Last".
7348 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
7351 =item ship_name_short
7353 Returns a name string for this (service/shipping) contact, either "Company"
7358 sub ship_name_short {
7360 if ( $self->get('ship_last') ) {
7361 $self->ship_company !~ /^\s*$/
7362 ? $self->ship_company
7363 : $self->ship_contact_firstlast;
7365 $self->name_company_or_firstlast;
7371 Returns this customer's full (billing) contact name only, "Last, First"
7377 $self->get('last'). ', '. $self->first;
7382 Returns this customer's full (shipping) contact name only, "Last, First"
7388 $self->get('ship_last')
7389 ? $self->get('ship_last'). ', '. $self->ship_first
7393 =item contact_firstlast
7395 Returns this customers full (billing) contact name only, "First Last".
7399 sub contact_firstlast {
7401 $self->first. ' '. $self->get('last');
7404 =item ship_contact_firstlast
7406 Returns this customer's full (shipping) contact name only, "First Last".
7410 sub ship_contact_firstlast {
7412 $self->get('ship_last')
7413 ? $self->first. ' '. $self->get('ship_last')
7414 : $self->contact_firstlast;
7419 Returns this customer's full country name
7425 code2country($self->country);
7428 =item geocode DATA_VENDOR
7430 Returns a value for the customer location as encoded by DATA_VENDOR.
7431 Currently this only makes sense for "CCH" as DATA_VENDOR.
7436 my ($self, $data_vendor) = (shift, shift); #always cch for now
7438 my $geocode = $self->get('geocode'); #XXX only one data_vendor for geocode
7439 return $geocode if $geocode;
7441 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
7445 my($zip,$plus4) = split /-/, $self->get("${prefix}zip")
7446 if $self->country eq 'US';
7450 #CCH specific location stuff
7451 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
7453 my @cust_tax_location =
7455 'table' => 'cust_tax_location',
7456 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
7457 'extra_sql' => $extra_sql,
7458 'order_by' => 'ORDER BY plus4hi',#overlapping with distinct ends
7461 $geocode = $cust_tax_location[0]->geocode
7462 if scalar(@cust_tax_location);
7471 Returns a status string for this customer, currently:
7475 =item prospect - No packages have ever been ordered
7477 =item ordered - Recurring packages all are new (not yet billed).
7479 =item active - One or more recurring packages is active
7481 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
7483 =item suspended - All non-cancelled recurring packages are suspended
7485 =item cancelled - All recurring packages are cancelled
7491 sub status { shift->cust_status(@_); }
7495 # prospect ordered active inactive suspended cancelled
7496 for my $status ( FS::cust_main->statuses() ) {
7497 my $method = $status.'_sql';
7498 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
7499 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
7500 $sth->execute( ($self->custnum) x $numnum )
7501 or die "Error executing 'SELECT $sql': ". $sth->errstr;
7502 return $status if $sth->fetchrow_arrayref->[0];
7506 =item ucfirst_cust_status
7508 =item ucfirst_status
7510 Returns the status with the first character capitalized.
7514 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
7516 sub ucfirst_cust_status {
7518 ucfirst($self->cust_status);
7523 Returns a hex triplet color string for this customer's status.
7527 use vars qw(%statuscolor);
7528 tie %statuscolor, 'Tie::IxHash',
7529 'prospect' => '7e0079', #'000000', #black? naw, purple
7530 'active' => '00CC00', #green
7531 'ordered' => '009999', #teal? cyan?
7532 'inactive' => '0000CC', #blue
7533 'suspended' => 'FF9900', #yellow
7534 'cancelled' => 'FF0000', #red
7537 sub statuscolor { shift->cust_statuscolor(@_); }
7539 sub cust_statuscolor {
7541 $statuscolor{$self->cust_status};
7546 Returns an array of hashes representing the customer's RT tickets.
7553 my $num = $conf->config('cust_main-max_tickets') || 10;
7556 if ( $conf->config('ticket_system') ) {
7557 unless ( $conf->config('ticket_system-custom_priority_field') ) {
7559 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
7563 foreach my $priority (
7564 $conf->config('ticket_system-custom_priority_field-values'), ''
7566 last if scalar(@tickets) >= $num;
7568 @{ FS::TicketSystem->customer_tickets( $self->custnum,
7569 $num - scalar(@tickets),
7579 # Return services representing svc_accts in customer support packages
7580 sub support_services {
7582 my %packages = map { $_ => 1 } $conf->config('support_packages');
7584 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
7585 grep { $_->part_svc->svcdb eq 'svc_acct' }
7586 map { $_->cust_svc }
7587 grep { exists $packages{ $_->pkgpart } }
7588 $self->ncancelled_pkgs;
7592 # Return a list of latitude/longitude for one of the services (if any)
7593 sub service_coordinates {
7597 grep { $_->latitude && $_->longitude }
7599 map { $_->cust_svc }
7600 $self->ncancelled_pkgs;
7602 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
7607 =head1 CLASS METHODS
7613 Class method that returns the list of possible status strings for customers
7614 (see L<the status method|/status>). For example:
7616 @statuses = FS::cust_main->statuses();
7621 #my $self = shift; #could be class...
7627 Returns an SQL expression identifying prospective cust_main records (customers
7628 with no packages ever ordered)
7632 use vars qw($select_count_pkgs);
7633 $select_count_pkgs =
7634 "SELECT COUNT(*) FROM cust_pkg
7635 WHERE cust_pkg.custnum = cust_main.custnum";
7637 sub select_count_pkgs_sql {
7642 " 0 = ( $select_count_pkgs ) ";
7647 Returns an SQL expression identifying ordered cust_main records (customers with
7648 recurring packages not yet setup).
7653 FS::cust_main->none_active_sql.
7654 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->ordered_sql. " ) ";
7659 Returns an SQL expression identifying active cust_main records (customers with
7660 active recurring packages).
7665 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
7668 =item none_active_sql
7670 Returns an SQL expression identifying cust_main records with no active
7671 recurring packages. This includes customers of status prospect, ordered,
7672 inactive, and suspended.
7676 sub none_active_sql {
7677 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
7682 Returns an SQL expression identifying inactive cust_main records (customers with
7683 no active recurring packages, but otherwise unsuspended/uncancelled).
7688 FS::cust_main->none_active_sql.
7689 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
7695 Returns an SQL expression identifying suspended cust_main records.
7700 sub suspended_sql { susp_sql(@_); }
7702 FS::cust_main->none_active_sql.
7703 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
7709 Returns an SQL expression identifying cancelled cust_main records.
7713 sub cancelled_sql { cancel_sql(@_); }
7716 my $recurring_sql = FS::cust_pkg->recurring_sql;
7717 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
7720 0 < ( $select_count_pkgs )
7721 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
7722 AND 0 = ( $select_count_pkgs AND $recurring_sql
7723 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
7725 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
7731 =item uncancelled_sql
7733 Returns an SQL expression identifying un-cancelled cust_main records.
7737 sub uncancelled_sql { uncancel_sql(@_); }
7738 sub uncancel_sql { "
7739 ( 0 < ( $select_count_pkgs
7740 AND ( cust_pkg.cancel IS NULL
7741 OR cust_pkg.cancel = 0
7744 OR 0 = ( $select_count_pkgs )
7750 Returns an SQL fragment to retreive the balance.
7755 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
7756 WHERE cust_bill.custnum = cust_main.custnum )
7757 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
7758 WHERE cust_pay.custnum = cust_main.custnum )
7759 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
7760 WHERE cust_credit.custnum = cust_main.custnum )
7761 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
7762 WHERE cust_refund.custnum = cust_main.custnum )
7765 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
7767 Returns an SQL fragment to retreive the balance for this customer, optionally
7768 considering invoices with date earlier than START_TIME, and not
7769 later than END_TIME (total_owed_date minus total_unapplied_credits minus
7770 total_unapplied_payments).
7772 Times are specified as SQL fragments or numeric
7773 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
7774 L<Date::Parse> for conversion functions. The empty string can be passed
7775 to disable that time constraint completely.
7777 Available options are:
7781 =item unapplied_date
7783 set to true to disregard unapplied credits, payments and refunds outside the specified time period - by default the time period restriction only applies to invoices (useful for reporting, probably a bad idea for event triggering)
7788 set to true to remove all customer comparison clauses, for totals
7793 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
7798 JOIN clause (typically used with the total option)
7802 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
7803 time will be ignored. Note that START_TIME and END_TIME only limit the date
7804 range for invoices and I<unapplied> payments, credits, and refunds.
7810 sub balance_date_sql {
7811 my( $class, $start, $end, %opt ) = @_;
7813 my $cutoff = $opt{'cutoff'};
7815 my $owed = FS::cust_bill->owed_sql($cutoff);
7816 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
7817 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
7818 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
7820 my $j = $opt{'join'} || '';
7822 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
7823 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
7824 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
7825 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
7827 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
7828 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
7829 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
7830 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
7835 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
7837 Returns an SQL fragment to retreive the total unapplied payments for this
7838 customer, only considering invoices with date earlier than START_TIME, and
7839 optionally not later than END_TIME.
7841 Times are specified as SQL fragments or numeric
7842 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
7843 L<Date::Parse> for conversion functions. The empty string can be passed
7844 to disable that time constraint completely.
7846 Available options are:
7850 sub unapplied_payments_date_sql {
7851 my( $class, $start, $end, %opt ) = @_;
7853 my $cutoff = $opt{'cutoff'};
7855 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
7857 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
7858 'unapplied_date'=>1 );
7860 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
7863 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
7865 Helper method for balance_date_sql; name (and usage) subject to change
7866 (suggestions welcome).
7868 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
7869 cust_refund, cust_credit or cust_pay).
7871 If TABLE is "cust_bill" or the unapplied_date option is true, only
7872 considers records with date earlier than START_TIME, and optionally not
7873 later than END_TIME .
7877 sub _money_table_where {
7878 my( $class, $table, $start, $end, %opt ) = @_;
7881 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
7882 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
7883 push @where, "$table._date <= $start" if defined($start) && length($start);
7884 push @where, "$table._date > $end" if defined($end) && length($end);
7886 push @where, @{$opt{'where'}} if $opt{'where'};
7887 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
7893 =item search HASHREF
7897 Returns a qsearch hash expression to search for parameters specified in
7898 HASHREF. Valid parameters are
7906 =item cancelled_pkgs
7912 listref of start date, end date
7922 =item current_balance
7924 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
7928 =item flattened_pkgs
7937 my ($class, $params) = @_;
7948 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
7950 "cust_main.agentnum = $1";
7954 # do the same for user
7957 if ( $params->{'usernum'} =~ /^(\d+)$/ and $1 ) {
7959 "cust_main.usernum = $1";
7966 #prospect ordered active inactive suspended cancelled
7967 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
7968 my $method = $params->{'status'}. '_sql';
7969 #push @where, $class->$method();
7970 push @where, FS::cust_main->$method();
7974 # parse cancelled package checkbox
7979 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
7980 unless $params->{'cancelled_pkgs'};
7983 # parse without census tract checkbox
7986 push @where, "(censustract = '' or censustract is null)"
7987 if $params->{'no_censustract'};
7993 foreach my $field (qw( signupdate )) {
7995 next unless exists($params->{$field});
7997 my($beginning, $ending, $hour) = @{$params->{$field}};
8000 "cust_main.$field IS NOT NULL",
8001 "cust_main.$field >= $beginning",
8002 "cust_main.$field <= $ending";
8004 # XXX: do this for mysql and/or pull it out of here
8006 if ($dbh->{Driver}->{Name} eq 'Pg') {
8007 push @where, "extract(hour from to_timestamp(cust_main.$field)) = $hour";
8010 warn "search by time of day not supported on ".$dbh->{Driver}->{Name}." databases";
8014 $orderby ||= "ORDER BY cust_main.$field";
8022 if ( $params->{'classnum'} ) {
8024 my @classnum = ref( $params->{'classnum'} )
8025 ? @{ $params->{'classnum'} }
8026 : ( $params->{'classnum'} );
8028 @classnum = grep /^(\d*)$/, @classnum;
8031 push @where, '( '. join(' OR ', map {
8032 $_ ? "cust_main.classnum = $_"
8033 : "cust_main.classnum IS NULL"
8046 if ( $params->{'payby'} ) {
8048 my @payby = ref( $params->{'payby'} )
8049 ? @{ $params->{'payby'} }
8050 : ( $params->{'payby'} );
8052 @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
8054 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )'
8060 # paydate_year / paydate_month
8063 if ( $params->{'paydate_year'} =~ /^(\d{4})$/ ) {
8065 $params->{'paydate_month'} =~ /^(\d\d?)$/
8066 or die "paydate_year without paydate_month?";
8070 'paydate IS NOT NULL',
8072 "CAST(paydate AS timestamp) < CAST('$year-$month-01' AS timestamp )"
8080 if ( $params->{'invoice_terms'} =~ /^([\w ]+)$/ ) {
8082 if ( $1 eq 'NULL' ) {
8084 "( cust_main.invoice_terms IS NULL OR cust_main.invoice_terms = '' )";
8087 "cust_main.invoice_terms IS NOT NULL",
8088 "cust_main.invoice_terms = '$1'";
8096 if ( $params->{'current_balance'} ) {
8098 #my $balance_sql = $class->balance_sql();
8099 my $balance_sql = FS::cust_main->balance_sql();
8101 my @current_balance =
8102 ref( $params->{'current_balance'} )
8103 ? @{ $params->{'current_balance'} }
8104 : ( $params->{'current_balance'} );
8106 push @where, map { s/current_balance/$balance_sql/; $_ }
8115 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
8117 "cust_main.custbatch = '$1'";
8121 # setup queries, subs, etc. for the search
8124 $orderby ||= 'ORDER BY custnum';
8126 # here is the agent virtualization
8127 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
8129 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
8131 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
8133 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
8135 my $select = join(', ',
8136 'cust_main.custnum',
8137 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
8140 my(@extra_headers) = ();
8141 my(@extra_fields) = ();
8143 if ($params->{'flattened_pkgs'}) {
8145 if ($dbh->{Driver}->{Name} eq 'Pg') {
8147 $select .= ", array_to_string(array(select pkg from cust_pkg left join part_pkg using ( pkgpart ) where cust_main.custnum = cust_pkg.custnum $pkgwhere),'|') as magic";
8149 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
8150 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
8151 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
8153 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
8154 "omitting packing information from report.";
8157 my $header_query = "SELECT COUNT(cust_pkg.custnum = cust_main.custnum) AS count FROM cust_main $addl_from $extra_sql $pkgwhere group by cust_main.custnum order by count desc limit 1";
8159 my $sth = dbh->prepare($header_query) or die dbh->errstr;
8160 $sth->execute() or die $sth->errstr;
8161 my $headerrow = $sth->fetchrow_arrayref;
8162 my $headercount = $headerrow ? $headerrow->[0] : 0;
8163 while($headercount) {
8164 unshift @extra_headers, "Package ". $headercount;
8165 unshift @extra_fields, eval q!sub {my $c = shift;
8166 my @a = split '\|', $c->magic;
8167 my $p = $a[!.--$headercount. q!];
8175 'table' => 'cust_main',
8176 'select' => $select,
8178 'extra_sql' => $extra_sql,
8179 'order_by' => $orderby,
8180 'count_query' => $count_query,
8181 'extra_headers' => \@extra_headers,
8182 'extra_fields' => \@extra_fields,
8187 =item email_search_result HASHREF
8191 Emails a notice to the specified customers.
8193 Valid parameters are those of the L<search> method, plus the following:
8215 Optional job queue job for status updates.
8219 Returns an error message, or false for success.
8221 If an error occurs during any email, stops the enture send and returns that
8222 error. Presumably if you're getting SMTP errors aborting is better than
8223 retrying everything.
8227 sub email_search_result {
8228 my($class, $params) = @_;
8230 my $from = delete $params->{from};
8231 my $subject = delete $params->{subject};
8232 my $html_body = delete $params->{html_body};
8233 my $text_body = delete $params->{text_body};
8236 my $job = delete $params->{'job'}
8237 or die "email_search_result must run from the job queue.\n";
8239 $params->{'payby'} = [ split(/\0/, $params->{'payby'}) ]
8240 unless ref($params->{'payby'});
8242 my $sql_query = $class->search($params);
8244 my $count_query = delete($sql_query->{'count_query'});
8245 my $count_sth = dbh->prepare($count_query)
8246 or die "Error preparing $count_query: ". dbh->errstr;
8248 or die "Error executing $count_query: ". $count_sth->errstr;
8249 my $count_arrayref = $count_sth->fetchrow_arrayref;
8250 my $num_cust = $count_arrayref->[0];
8252 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
8253 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
8256 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
8257 my @retry_jobs = ();
8260 #eventually order+limit magic to reduce memory use?
8261 foreach my $cust_main ( qsearch($sql_query) ) {
8263 #progressbar first, so that the count is right
8265 if ( time - $min_sec > $last ) {
8266 my $error = $job->update_statustext(
8267 int( 100 * $num / $num_cust )
8269 die $error if $error;
8273 my $to = $cust_main->invoicing_list_emailonly_scalar;
8279 'subject' => $subject,
8280 'html_body' => $html_body,
8281 'text_body' => $text_body,
8284 $error = send_email( generate_email( @message ) );
8287 # queue the sending of this message so that the user can see what we
8288 # tried to do, and retry if desired
8289 my $queue = new FS::queue {
8290 'job' => 'FS::Misc::process_send_email',
8291 'custnum' => $cust_main->custnum,
8292 'status' => 'failed',
8293 'statustext' => $error,
8295 $queue->insert(@message);
8296 push @retry_jobs, $queue;
8303 if($success == 0 and
8304 (scalar(@retry_jobs) > 10 or $num == $num_cust)
8306 # 10 is arbitrary, but if we have enough failures, that's
8307 # probably a configuration or network problem, and we
8308 # abort the batch and run away screaming.
8309 # We NEVER do this if anything was successfully sent.
8310 $_->delete foreach (@retry_jobs);
8311 return "multiple failures: '$error'\n";
8316 # fail the job, but with a status message that makes it clear
8317 # something was sent.
8318 return "Sent $success, failed ".scalar(@retry_jobs).". Failed attempts placed in job queue.\n";
8324 sub process_email_search_result {
8326 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
8328 my $param = thaw(decode_base64(shift));
8329 warn Dumper($param) if $DEBUG;
8331 $param->{'job'} = $job;
8333 $param->{'payby'} = [ split(/\0/, $param->{'payby'}) ]
8334 unless ref($param->{'payby'});
8336 my $error = FS::cust_main->email_search_result( $param );
8337 die $error if $error;
8341 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
8343 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
8344 records. Currently, I<first>, I<last>, I<company> and/or I<address1> may be
8345 specified (the appropriate ship_ field is also searched).
8347 Additional options are the same as FS::Record::qsearch
8352 my( $self, $fuzzy, $hash, @opt) = @_;
8357 check_and_rebuild_fuzzyfiles();
8358 foreach my $field ( keys %$fuzzy ) {
8360 my $all = $self->all_X($field);
8361 next unless scalar(@$all);
8364 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
8367 foreach ( keys %match ) {
8368 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
8369 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
8372 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
8375 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
8377 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
8385 Returns a masked version of the named field
8390 my ($self,$field) = @_;
8394 'x'x(length($self->getfield($field))-4).
8395 substr($self->getfield($field), (length($self->getfield($field))-4));
8405 =item smart_search OPTION => VALUE ...
8407 Accepts the following options: I<search>, the string to search for. The string
8408 will be searched for as a customer number, phone number, name or company name,
8409 as an exact, or, in some cases, a substring or fuzzy match (see the source code
8410 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
8411 skip fuzzy matching when an exact match is found.
8413 Any additional options are treated as an additional qualifier on the search
8416 Returns a (possibly empty) array of FS::cust_main objects.
8423 #here is the agent virtualization
8424 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8428 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
8429 my $search = delete $options{'search'};
8430 ( my $alphanum_search = $search ) =~ s/\W//g;
8432 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
8434 #false laziness w/Record::ut_phone
8435 my $phonen = "$1-$2-$3";
8436 $phonen .= " x$4" if $4;
8438 push @cust_main, qsearch( {
8439 'table' => 'cust_main',
8440 'hashref' => { %options },
8441 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8443 join(' OR ', map "$_ = '$phonen'",
8444 qw( daytime night fax
8445 ship_daytime ship_night ship_fax )
8448 " AND $agentnums_sql", #agent virtualization
8451 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
8452 #try looking for matches with extensions unless one was specified
8454 push @cust_main, qsearch( {
8455 'table' => 'cust_main',
8456 'hashref' => { %options },
8457 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8459 join(' OR ', map "$_ LIKE '$phonen\%'",
8461 ship_daytime ship_night )
8464 " AND $agentnums_sql", #agent virtualization
8469 # custnum search (also try agent_custid), with some tweaking options if your
8470 # legacy cust "numbers" have letters
8473 if ( $search =~ /^\s*(\d+)\s*$/
8474 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
8475 && $search =~ /^\s*(\w\w?\d+)\s*$/
8477 || ( $conf->exists('address1-search' )
8478 && $search =~ /^\s*(\d+\-?\w*)\s*$/ #i.e. 1234A or 9432-D
8485 if ( $num =~ /^(\d+)$/ && $num <= 2147483647 ) { #need a bigint custnum? wow
8486 push @cust_main, qsearch( {
8487 'table' => 'cust_main',
8488 'hashref' => { 'custnum' => $num, %options },
8489 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8493 push @cust_main, qsearch( {
8494 'table' => 'cust_main',
8495 'hashref' => { 'agent_custid' => $num, %options },
8496 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8499 if ( $conf->exists('address1-search') ) {
8500 my $len = length($num);
8502 foreach my $prefix ( '', 'ship_' ) {
8503 push @cust_main, qsearch( {
8504 'table' => 'cust_main',
8505 'hashref' => { %options, },
8507 ( keys(%options) ? ' AND ' : ' WHERE ' ).
8508 " LOWER(SUBSTRING(${prefix}address1 FROM 1 FOR $len)) = '$num' ".
8509 " AND $agentnums_sql",
8514 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
8516 my($company, $last, $first) = ( $1, $2, $3 );
8518 # "Company (Last, First)"
8519 #this is probably something a browser remembered,
8520 #so just do an exact search (but case-insensitive, so USPS standardization
8521 #doesn't throw a wrench in the works)
8523 foreach my $prefix ( '', 'ship_' ) {
8524 push @cust_main, qsearch( {
8525 'table' => 'cust_main',
8526 'hashref' => { %options },
8528 ( keys(%options) ? ' AND ' : ' WHERE ' ).
8530 " LOWER(${prefix}first) = ". dbh->quote(lc($first)),
8531 " LOWER(${prefix}last) = ". dbh->quote(lc($last)),
8532 " LOWER(${prefix}company) = ". dbh->quote(lc($company)),
8538 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
8539 # try (ship_){last,company}
8543 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
8544 # # full strings the browser remembers won't work
8545 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
8547 use Lingua::EN::NameParse;
8548 my $NameParse = new Lingua::EN::NameParse(
8550 allow_reversed => 1,
8553 my($last, $first) = ( '', '' );
8554 #maybe disable this too and just rely on NameParse?
8555 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
8557 ($last, $first) = ( $1, $2 );
8559 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
8560 } elsif ( ! $NameParse->parse($value) ) {
8562 my %name = $NameParse->components;
8563 $first = $name{'given_name_1'};
8564 $last = $name{'surname_1'};
8568 if ( $first && $last ) {
8570 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
8573 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8575 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
8576 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
8579 push @cust_main, qsearch( {
8580 'table' => 'cust_main',
8581 'hashref' => \%options,
8582 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8585 # or it just be something that was typed in... (try that in a sec)
8589 my $q_value = dbh->quote($value);
8592 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8593 $sql .= " ( LOWER(last) = $q_value
8594 OR LOWER(company) = $q_value
8595 OR LOWER(ship_last) = $q_value
8596 OR LOWER(ship_company) = $q_value
8598 $sql .= " OR LOWER(address1) = $q_value
8599 OR LOWER(ship_address1) = $q_value
8601 if $conf->exists('address1-search');
8604 push @cust_main, qsearch( {
8605 'table' => 'cust_main',
8606 'hashref' => \%options,
8607 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8610 #no exact match, trying substring/fuzzy
8611 #always do substring & fuzzy (unless they're explicity config'ed off)
8612 #getting complaints searches are not returning enough
8613 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
8615 #still some false laziness w/search (was search/cust_main.cgi)
8620 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
8621 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
8624 if ( $first && $last ) {
8627 { 'first' => { op=>'ILIKE', value=>"%$first%" },
8628 'last' => { op=>'ILIKE', value=>"%$last%" },
8630 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
8631 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
8638 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
8639 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
8643 if ( $conf->exists('address1-search') ) {
8645 { 'address1' => { op=>'ILIKE', value=>"%$value%" }, },
8646 { 'ship_address1' => { op=>'ILIKE', value=>"%$value%" }, },
8650 foreach my $hashref ( @hashrefs ) {
8652 push @cust_main, qsearch( {
8653 'table' => 'cust_main',
8654 'hashref' => { %$hashref,
8657 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
8666 " AND $agentnums_sql", #extra_sql #agent virtualization
8669 if ( $first && $last ) {
8670 push @cust_main, FS::cust_main->fuzzy_search(
8671 { 'last' => $last, #fuzzy hashref
8672 'first' => $first }, #
8676 foreach my $field ( 'last', 'company' ) {
8678 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
8680 if ( $conf->exists('address1-search') ) {
8682 FS::cust_main->fuzzy_search( { 'address1' => $value }, @fuzopts );
8689 #eliminate duplicates
8691 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8699 Accepts the following options: I<email>, the email address to search for. The
8700 email address will be searched for as an email invoice destination and as an
8703 #Any additional options are treated as an additional qualifier on the search
8704 #(i.e. I<agentnum>).
8706 Returns a (possibly empty) array of FS::cust_main objects (but usually just
8716 my $email = delete $options{'email'};
8718 #we're only being used by RT at the moment... no agent virtualization yet
8719 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8723 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
8725 my ( $user, $domain ) = ( $1, $2 );
8727 warn "$me smart_search: searching for $user in domain $domain"
8733 'table' => 'cust_main_invoice',
8734 'hashref' => { 'dest' => $email },
8741 map $_->cust_svc->cust_pkg,
8743 'table' => 'svc_acct',
8744 'hashref' => { 'username' => $user, },
8746 'AND ( SELECT domain FROM svc_domain
8747 WHERE svc_acct.domsvc = svc_domain.svcnum
8748 ) = '. dbh->quote($domain),
8754 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8756 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
8763 =item check_and_rebuild_fuzzyfiles
8767 sub check_and_rebuild_fuzzyfiles {
8768 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8769 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
8772 =item rebuild_fuzzyfiles
8776 sub rebuild_fuzzyfiles {
8778 use Fcntl qw(:flock);
8780 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8781 mkdir $dir, 0700 unless -d $dir;
8783 foreach my $fuzzy ( @fuzzyfields ) {
8785 open(LOCK,">>$dir/cust_main.$fuzzy")
8786 or die "can't open $dir/cust_main.$fuzzy: $!";
8788 or die "can't lock $dir/cust_main.$fuzzy: $!";
8790 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
8791 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
8793 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
8794 my $sth = dbh->prepare("SELECT $field FROM cust_main".
8795 " WHERE $field != '' AND $field IS NOT NULL");
8796 $sth->execute or die $sth->errstr;
8798 while ( my $row = $sth->fetchrow_arrayref ) {
8799 print CACHE $row->[0]. "\n";
8804 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
8806 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
8817 my( $self, $field ) = @_;
8818 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8819 open(CACHE,"<$dir/cust_main.$field")
8820 or die "can't open $dir/cust_main.$field: $!";
8821 my @array = map { chomp; $_; } <CACHE>;
8826 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
8830 sub append_fuzzyfiles {
8831 #my( $first, $last, $company ) = @_;
8833 &check_and_rebuild_fuzzyfiles;
8835 use Fcntl qw(:flock);
8837 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8839 foreach my $field (@fuzzyfields) {
8844 open(CACHE,">>$dir/cust_main.$field")
8845 or die "can't open $dir/cust_main.$field: $!";
8846 flock(CACHE,LOCK_EX)
8847 or die "can't lock $dir/cust_main.$field: $!";
8849 print CACHE "$value\n";
8851 flock(CACHE,LOCK_UN)
8852 or die "can't unlock $dir/cust_main.$field: $!";
8867 #warn join('-',keys %$param);
8868 my $fh = $param->{filehandle};
8869 my @fields = @{$param->{fields}};
8871 eval "use Text::CSV_XS;";
8874 my $csv = new Text::CSV_XS;
8881 local $SIG{HUP} = 'IGNORE';
8882 local $SIG{INT} = 'IGNORE';
8883 local $SIG{QUIT} = 'IGNORE';
8884 local $SIG{TERM} = 'IGNORE';
8885 local $SIG{TSTP} = 'IGNORE';
8886 local $SIG{PIPE} = 'IGNORE';
8888 my $oldAutoCommit = $FS::UID::AutoCommit;
8889 local $FS::UID::AutoCommit = 0;
8892 #while ( $columns = $csv->getline($fh) ) {
8894 while ( defined($line=<$fh>) ) {
8896 $csv->parse($line) or do {
8897 $dbh->rollback if $oldAutoCommit;
8898 return "can't parse: ". $csv->error_input();
8901 my @columns = $csv->fields();
8902 #warn join('-',@columns);
8905 foreach my $field ( @fields ) {
8906 $row{$field} = shift @columns;
8909 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
8910 unless ( $cust_main ) {
8911 $dbh->rollback if $oldAutoCommit;
8912 return "unknown custnum $row{'custnum'}";
8915 if ( $row{'amount'} > 0 ) {
8916 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
8918 $dbh->rollback if $oldAutoCommit;
8922 } elsif ( $row{'amount'} < 0 ) {
8923 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
8926 $dbh->rollback if $oldAutoCommit;
8936 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
8938 return "Empty file!" unless $imported;
8944 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
8946 Deprecated. Use event notification and message templates
8947 (L<FS::msg_template>) instead.
8949 Sends a templated email notification to the customer (see L<Text::Template>).
8951 OPTIONS is a hash and may include
8953 I<from> - the email sender (default is invoice_from)
8955 I<to> - comma-separated scalar or arrayref of recipients
8956 (default is invoicing_list)
8958 I<subject> - The subject line of the sent email notification
8959 (default is "Notice from company_name")
8961 I<extra_fields> - a hashref of name/value pairs which will be substituted
8964 The following variables are vavailable in the template.
8966 I<$first> - the customer first name
8967 I<$last> - the customer last name
8968 I<$company> - the customer company
8969 I<$payby> - a description of the method of payment for the customer
8970 # would be nice to use FS::payby::shortname
8971 I<$payinfo> - the account information used to collect for this customer
8972 I<$expdate> - the expiration of the customer payment in seconds from epoch
8977 my ($self, $template, %options) = @_;
8979 return unless $conf->exists($template);
8981 my $from = $conf->config('invoice_from', $self->agentnum)
8982 if $conf->exists('invoice_from', $self->agentnum);
8983 $from = $options{from} if exists($options{from});
8985 my $to = join(',', $self->invoicing_list_emailonly);
8986 $to = $options{to} if exists($options{to});
8988 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
8989 if $conf->exists('company_name', $self->agentnum);
8990 $subject = $options{subject} if exists($options{subject});
8992 my $notify_template = new Text::Template (TYPE => 'ARRAY',
8993 SOURCE => [ map "$_\n",
8994 $conf->config($template)]
8996 or die "can't create new Text::Template object: Text::Template::ERROR";
8997 $notify_template->compile()
8998 or die "can't compile template: Text::Template::ERROR";
9000 $FS::notify_template::_template::company_name =
9001 $conf->config('company_name', $self->agentnum);
9002 $FS::notify_template::_template::company_address =
9003 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
9005 my $paydate = $self->paydate || '2037-12-31';
9006 $FS::notify_template::_template::first = $self->first;
9007 $FS::notify_template::_template::last = $self->last;
9008 $FS::notify_template::_template::company = $self->company;
9009 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
9010 my $payby = $self->payby;
9011 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9012 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9014 #credit cards expire at the end of the month/year of their exp date
9015 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9016 $FS::notify_template::_template::payby = 'credit card';
9017 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9018 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9020 }elsif ($payby eq 'COMP') {
9021 $FS::notify_template::_template::payby = 'complimentary account';
9023 $FS::notify_template::_template::payby = 'current method';
9025 $FS::notify_template::_template::expdate = $expire_time;
9027 for (keys %{$options{extra_fields}}){
9029 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
9032 send_email(from => $from,
9034 subject => $subject,
9035 body => $notify_template->fill_in( PACKAGE =>
9036 'FS::notify_template::_template' ),
9041 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9043 Generates a templated notification to the customer (see L<Text::Template>).
9045 OPTIONS is a hash and may include
9047 I<extra_fields> - a hashref of name/value pairs which will be substituted
9048 into the template. These values may override values mentioned below
9049 and those from the customer record.
9051 The following variables are available in the template instead of or in addition
9052 to the fields of the customer record.
9054 I<$payby> - a description of the method of payment for the customer
9055 # would be nice to use FS::payby::shortname
9056 I<$payinfo> - the masked account information used to collect for this customer
9057 I<$expdate> - the expiration of the customer payment method in seconds from epoch
9058 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
9062 # a lot like cust_bill::print_latex
9063 sub generate_letter {
9064 my ($self, $template, %options) = @_;
9066 return unless $conf->exists($template);
9068 my $letter_template = new Text::Template
9070 SOURCE => [ map "$_\n", $conf->config($template)],
9071 DELIMITERS => [ '[@--', '--@]' ],
9073 or die "can't create new Text::Template object: Text::Template::ERROR";
9075 $letter_template->compile()
9076 or die "can't compile template: Text::Template::ERROR";
9078 my %letter_data = map { $_ => $self->$_ } $self->fields;
9079 $letter_data{payinfo} = $self->mask_payinfo;
9081 #my $paydate = $self->paydate || '2037-12-31';
9082 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
9084 my $payby = $self->payby;
9085 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9086 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9088 #credit cards expire at the end of the month/year of their exp date
9089 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9090 $letter_data{payby} = 'credit card';
9091 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9092 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9094 }elsif ($payby eq 'COMP') {
9095 $letter_data{payby} = 'complimentary account';
9097 $letter_data{payby} = 'current method';
9099 $letter_data{expdate} = $expire_time;
9101 for (keys %{$options{extra_fields}}){
9102 $letter_data{$_} = $options{extra_fields}->{$_};
9105 unless(exists($letter_data{returnaddress})){
9106 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
9107 $self->agent_template)
9109 if ( length($retadd) ) {
9110 $letter_data{returnaddress} = $retadd;
9111 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
9112 $letter_data{returnaddress} =
9113 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
9117 ( $conf->config('company_name', $self->agentnum),
9118 $conf->config('company_address', $self->agentnum),
9122 $letter_data{returnaddress} = '~';
9126 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
9128 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
9130 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
9132 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
9136 ) or die "can't open temp file: $!\n";
9137 print $lh $conf->config_binary('logo.eps', $self->agentnum)
9138 or die "can't write temp file: $!\n";
9140 $letter_data{'logo_file'} = $lh->filename;
9142 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
9146 ) or die "can't open temp file: $!\n";
9148 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
9150 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
9151 return ($1, $letter_data{'logo_file'});
9155 =item print_ps TEMPLATE
9157 Returns an postscript letter filled in from TEMPLATE, as a scalar.
9163 my($file, $lfile) = $self->generate_letter(@_);
9164 my $ps = FS::Misc::generate_ps($file);
9165 unlink($file.'.tex');
9171 =item print TEMPLATE
9173 Prints the filled in template.
9175 TEMPLATE is the name of a L<Text::Template> to fill in and print.
9179 sub queueable_print {
9182 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
9183 or die "invalid customer number: " . $opt{custvnum};
9185 my $error = $self->print( $opt{template} );
9186 die $error if $error;
9190 my ($self, $template) = (shift, shift);
9191 do_print [ $self->print_ps($template) ];
9194 #these three subs should just go away once agent stuff is all config overrides
9196 sub agent_template {
9198 $self->_agent_plandata('agent_templatename');
9201 sub agent_invoice_from {
9203 $self->_agent_plandata('agent_invoice_from');
9206 sub _agent_plandata {
9207 my( $self, $option ) = @_;
9209 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
9210 #agent-specific Conf
9212 use FS::part_event::Condition;
9214 my $agentnum = $self->agentnum;
9216 my $regexp = regexp_sql();
9218 my $part_event_option =
9220 'select' => 'part_event_option.*',
9221 'table' => 'part_event_option',
9223 LEFT JOIN part_event USING ( eventpart )
9224 LEFT JOIN part_event_option AS peo_agentnum
9225 ON ( part_event.eventpart = peo_agentnum.eventpart
9226 AND peo_agentnum.optionname = 'agentnum'
9227 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
9229 LEFT JOIN part_event_condition
9230 ON ( part_event.eventpart = part_event_condition.eventpart
9231 AND part_event_condition.conditionname = 'cust_bill_age'
9233 LEFT JOIN part_event_condition_option
9234 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
9235 AND part_event_condition_option.optionname = 'age'
9238 #'hashref' => { 'optionname' => $option },
9239 #'hashref' => { 'part_event_option.optionname' => $option },
9241 " WHERE part_event_option.optionname = ". dbh->quote($option).
9242 " AND action = 'cust_bill_send_agent' ".
9243 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
9244 " AND peo_agentnum.optionname = 'agentnum' ".
9245 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
9247 CASE WHEN part_event_condition_option.optionname IS NULL
9249 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
9251 , part_event.weight".
9255 unless ( $part_event_option ) {
9256 return $self->agent->invoice_template || ''
9257 if $option eq 'agent_templatename';
9261 $part_event_option->optionvalue;
9265 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
9267 Subroutine (not a method), designed to be called from the queue.
9269 Takes a list of options and values.
9271 Pulls up the customer record via the custnum option and calls bill_and_collect.
9276 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
9278 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
9279 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
9281 $cust_main->bill_and_collect( %args );
9284 sub process_bill_and_collect {
9286 my $param = thaw(decode_base64(shift));
9287 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
9288 or die "custnum '$param->{custnum}' not found!\n";
9289 $param->{'job'} = $job;
9290 $param->{'fatal'} = 1; # runs from job queue, will be caught
9291 $param->{'retry'} = 1;
9293 $cust_main->bill_and_collect( %$param );
9296 sub _upgrade_data { #class method
9297 my ($class, %opts) = @_;
9299 my $sql = 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL';
9300 my $sth = dbh->prepare($sql) or die dbh->errstr;
9301 $sth->execute or die $sth->errstr;
9303 local($ignore_expired_card) = 1;
9304 local($skip_fuzzyfiles) = 1;
9305 $class->_upgrade_otaker(%opts);
9315 The delete method should possibly take an FS::cust_main object reference
9316 instead of a scalar customer number.
9318 Bill and collect options should probably be passed as references instead of a
9321 There should probably be a configuration file with a list of allowed credit
9324 No multiple currency support (probably a larger project than just this module).
9326 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
9328 Birthdates rely on negative epoch values.
9330 The payby for card/check batches is broken. With mixed batching, bad
9333 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
9337 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
9338 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
9339 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.