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 = _omit_zero_value_bundles(@{ $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;
3069 # it's silly to have a zero value postal_pkg, but....
3070 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
3076 my $listref_or_error =
3077 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
3079 unless ( ref( $listref_or_error ) ) {
3080 $dbh->rollback if $oldAutoCommit;
3081 return $listref_or_error;
3084 foreach my $taxline ( @$listref_or_error ) {
3085 ${ $total_setup{$pass} } =
3086 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
3087 push @cust_bill_pkg, $taxline;
3090 #add tax adjustments
3091 warn "adding tax adjustments...\n" if $DEBUG > 2;
3092 foreach my $cust_tax_adjustment (
3093 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
3099 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
3101 my $itemdesc = $cust_tax_adjustment->taxname;
3102 $itemdesc = '' if $itemdesc eq 'Tax';
3104 push @cust_bill_pkg, new FS::cust_bill_pkg {
3110 'itemdesc' => $itemdesc,
3111 'itemcomment' => $cust_tax_adjustment->comment,
3112 'cust_tax_adjustment' => $cust_tax_adjustment,
3113 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
3118 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
3120 my @cust_bill = $self->cust_bill;
3121 my $balance = $self->balance;
3122 my $previous_balance = scalar(@cust_bill)
3123 ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
3126 $previous_balance += $cust_bill[$#cust_bill]->charged
3127 if scalar(@cust_bill);
3128 #my $balance_adjustments =
3129 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
3131 #create the new invoice
3132 my $cust_bill = new FS::cust_bill ( {
3133 'custnum' => $self->custnum,
3134 '_date' => ( $invoice_time ),
3135 'charged' => $charged,
3136 'billing_balance' => $balance,
3137 'previous_balance' => $previous_balance,
3138 'invoice_terms' => $options{'invoice_terms'},
3140 $error = $cust_bill->insert;
3142 $dbh->rollback if $oldAutoCommit;
3143 return "can't create invoice for customer #". $self->custnum. ": $error";
3146 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
3147 $cust_bill_pkg->invnum($cust_bill->invnum);
3148 my $error = $cust_bill_pkg->insert;
3150 $dbh->rollback if $oldAutoCommit;
3151 return "can't create invoice line item: $error";
3155 } #foreach my $pass ( keys %cust_bill_pkg )
3157 foreach my $hook ( @precommit_hooks ) {
3159 &{$hook}; #($self) ?
3162 $dbh->rollback if $oldAutoCommit;
3163 return "$@ running precommit hook $hook\n";
3167 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3171 #discard bundled packages of 0 value
3172 sub _omit_zero_value_bundles {
3174 my @cust_bill_pkg = ();
3175 my @cust_bill_pkg_bundle = ();
3178 foreach my $cust_bill_pkg ( @_ ) {
3179 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
3180 push @cust_bill_pkg, @cust_bill_pkg_bundle if $sum > 0;
3181 @cust_bill_pkg_bundle = ();
3184 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
3185 push @cust_bill_pkg_bundle, $cust_bill_pkg;
3187 push @cust_bill_pkg, @cust_bill_pkg_bundle if $sum > 0;
3193 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
3195 This is a weird one. Perhaps it should not even be exposed.
3197 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
3198 Usually used internally by bill method B<bill>.
3200 If there is an error, returns the error, otherwise returns reference to a
3201 list of line items suitable for insertion.
3207 An array ref of the line items being billed.
3211 A strange beast. The keys to this hash are internal identifiers consisting
3212 of the name of the tax object type, a space, and its unique identifier ( e.g.
3213 'cust_main_county 23' ). The values of the hash are listrefs. The first
3214 item in the list is the tax object. The remaining items are either line
3215 items or floating point values (currency amounts).
3217 The taxes are calculated on this entity. Calculated exemption records are
3218 transferred to the LINEITEMREF items on the assumption that they are related.
3224 This specifies the date appearing on the associated invoice. Some
3225 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
3230 sub calculate_taxes {
3231 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
3233 my @tax_line_items = ();
3235 warn "having a look at the taxes we found...\n" if $DEBUG > 2;
3237 # keys are tax names (as printed on invoices / itemdesc )
3238 # values are listrefs of taxlisthash keys (internal identifiers)
3241 # keys are taxlisthash keys (internal identifiers)
3242 # values are (cumulative) amounts
3245 # keys are taxlisthash keys (internal identifiers)
3246 # values are listrefs of cust_bill_pkg_tax_location hashrefs
3247 my %tax_location = ();
3249 # keys are taxlisthash keys (internal identifiers)
3250 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
3251 my %tax_rate_location = ();
3253 foreach my $tax ( keys %$taxlisthash ) {
3254 my $tax_object = shift @{ $taxlisthash->{$tax} };
3255 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
3256 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
3257 my $hashref_or_error =
3258 $tax_object->taxline( $taxlisthash->{$tax},
3259 'custnum' => $self->custnum,
3260 'invoice_time' => $invoice_time
3262 return $hashref_or_error unless ref($hashref_or_error);
3264 unshift @{ $taxlisthash->{$tax} }, $tax_object;
3266 my $name = $hashref_or_error->{'name'};
3267 my $amount = $hashref_or_error->{'amount'};
3269 #warn "adding $amount as $name\n";
3270 $taxname{ $name } ||= [];
3271 push @{ $taxname{ $name } }, $tax;
3273 $tax{ $tax } += $amount;
3275 $tax_location{ $tax } ||= [];
3276 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
3277 push @{ $tax_location{ $tax } },
3279 'taxnum' => $tax_object->taxnum,
3280 'taxtype' => ref($tax_object),
3281 'pkgnum' => $tax_object->get('pkgnum'),
3282 'locationnum' => $tax_object->get('locationnum'),
3283 'amount' => sprintf('%.2f', $amount ),
3287 $tax_rate_location{ $tax } ||= [];
3288 if ( ref($tax_object) eq 'FS::tax_rate' ) {
3289 my $taxratelocationnum =
3290 $tax_object->tax_rate_location->taxratelocationnum;
3291 push @{ $tax_rate_location{ $tax } },
3293 'taxnum' => $tax_object->taxnum,
3294 'taxtype' => ref($tax_object),
3295 'amount' => sprintf('%.2f', $amount ),
3296 'locationtaxid' => $tax_object->location,
3297 'taxratelocationnum' => $taxratelocationnum,
3303 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
3304 my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
3305 foreach my $tax ( keys %$taxlisthash ) {
3306 foreach ( @{ $taxlisthash->{$tax} }[1 ... scalar(@{ $taxlisthash->{$tax} })] ) {
3307 next unless ref($_) eq 'FS::cust_bill_pkg';
3309 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
3310 splice( @{ $_->_cust_tax_exempt_pkg } );
3314 #consolidate and create tax line items
3315 warn "consolidating and generating...\n" if $DEBUG > 2;
3316 foreach my $taxname ( keys %taxname ) {
3319 my @cust_bill_pkg_tax_location = ();
3320 my @cust_bill_pkg_tax_rate_location = ();
3321 warn "adding $taxname\n" if $DEBUG > 1;
3322 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
3323 next if $seen{$taxitem}++;
3324 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
3325 $tax += $tax{$taxitem};
3326 push @cust_bill_pkg_tax_location,
3327 map { new FS::cust_bill_pkg_tax_location $_ }
3328 @{ $tax_location{ $taxitem } };
3329 push @cust_bill_pkg_tax_rate_location,
3330 map { new FS::cust_bill_pkg_tax_rate_location $_ }
3331 @{ $tax_rate_location{ $taxitem } };
3335 $tax = sprintf('%.2f', $tax );
3337 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
3343 if ( $pkg_category and
3344 $conf->config('invoice_latexsummary') ||
3345 $conf->config('invoice_htmlsummary')
3349 my %hash = ( 'section' => $pkg_category->categoryname );
3350 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3354 push @tax_line_items, new FS::cust_bill_pkg {
3360 'itemdesc' => $taxname,
3361 'display' => \@display,
3362 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
3363 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
3372 my ($self, %params) = @_;
3374 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
3375 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
3376 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
3377 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
3378 my $total_setup = $params{setup} or die "no setup accumulator specified";
3379 my $total_recur = $params{recur} or die "no recur accumulator specified";
3380 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
3381 my $time = $params{'time'} or die "no time specified";
3382 my (%options) = %{$params{options}};
3385 my $real_pkgpart = $params{real_pkgpart};
3386 my %hash = $cust_pkg->hash;
3387 my $old_cust_pkg = new FS::cust_pkg \%hash;
3393 $cust_pkg->pkgpart($part_pkg->pkgpart);
3401 if ( $options{'resetup'}
3402 || ( ! $cust_pkg->setup
3403 && ( ! $cust_pkg->start_date
3404 || $cust_pkg->start_date <= $time
3406 && ( ! $conf->exists('disable_setup_suspended_pkgs')
3407 || ( $conf->exists('disable_setup_suspended_pkgs') &&
3408 ! $cust_pkg->getfield('susp')
3415 warn " bill setup\n" if $DEBUG > 1;
3418 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
3419 return "$@ running calc_setup for $cust_pkg\n"
3422 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
3424 $cust_pkg->setfield('setup', $time)
3425 unless $cust_pkg->setup;
3426 #do need it, but it won't get written to the db
3427 #|| $cust_pkg->pkgpart != $real_pkgpart;
3429 $cust_pkg->setfield('start_date', '')
3430 if $cust_pkg->start_date;
3435 # bill recurring fee
3438 #XXX unit stuff here too
3442 if ( ! $cust_pkg->get('susp')
3443 and ! $cust_pkg->get('start_date')
3444 and ( $part_pkg->getfield('freq') ne '0'
3445 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
3447 || ( $part_pkg->plan eq 'voip_cdr'
3448 && $part_pkg->option('bill_every_call')
3450 || ( $options{cancel} )
3453 # XXX should this be a package event? probably. events are called
3454 # at collection time at the moment, though...
3455 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
3456 if $part_pkg->can('reset_usage');
3457 #don't want to reset usage just cause we want a line item??
3458 #&& $part_pkg->pkgpart == $real_pkgpart;
3460 warn " bill recur\n" if $DEBUG > 1;
3463 # XXX shared with $recur_prog
3464 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
3468 #over two params! lets at least switch to a hashref for the rest...
3469 my $increment_next_bill = ( $part_pkg->freq ne '0'
3470 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
3471 && !$options{cancel}
3473 my %param = ( 'precommit_hooks' => $precommit_hooks,
3474 'increment_next_bill' => $increment_next_bill,
3475 'discounts' => \@discounts,
3476 'real_pkgpart' => $real_pkgpart,
3479 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
3480 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
3481 return "$@ running $method for $cust_pkg\n"
3484 if ( $increment_next_bill ) {
3486 my $next_bill = $part_pkg->add_freq($sdate);
3487 return "unparsable frequency: ". $part_pkg->freq
3488 if $next_bill == -1;
3490 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
3491 # only for figuring next bill date, nothing else, so, reset $sdate again
3493 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
3494 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
3495 $cust_pkg->last_bill($sdate);
3497 $cust_pkg->setfield('bill', $next_bill );
3503 warn "\$setup is undefined" unless defined($setup);
3504 warn "\$recur is undefined" unless defined($recur);
3505 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
3508 # If there's line items, create em cust_bill_pkg records
3509 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
3512 if ( $lineitems || $options{has_hidden} ) {
3514 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
3515 # hmm.. and if just the options are modified in some weird price plan?
3517 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
3520 my $error = $cust_pkg->replace( $old_cust_pkg,
3521 'options' => { $cust_pkg->options },
3523 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
3524 if $error; #just in case
3527 $setup = sprintf( "%.2f", $setup );
3528 $recur = sprintf( "%.2f", $recur );
3529 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
3530 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
3532 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
3533 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
3538 !$part_pkg->hidden && $options{has_hidden} ) #include some $0 lines
3541 warn " charges (setup=$setup, recur=$recur); adding line items\n"
3544 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
3546 warn " adding customer package invoice detail: $_\n"
3547 foreach @cust_pkg_detail;
3549 push @details, @cust_pkg_detail;
3551 my $cust_bill_pkg = new FS::cust_bill_pkg {
3552 'pkgnum' => $cust_pkg->pkgnum,
3554 'unitsetup' => $unitsetup,
3556 'unitrecur' => $unitrecur,
3557 'quantity' => $cust_pkg->quantity,
3558 'details' => \@details,
3559 'discounts' => \@discounts,
3560 'hidden' => $part_pkg->hidden,
3563 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
3564 $cust_bill_pkg->sdate( $hash{last_bill} );
3565 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
3566 $cust_bill_pkg->edate( $time ) if $options{cancel};
3567 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
3568 $cust_bill_pkg->sdate( $sdate );
3569 $cust_bill_pkg->edate( $cust_pkg->bill );
3570 #$cust_bill_pkg->edate( $time ) if $options{cancel};
3573 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
3574 unless $part_pkg->pkgpart == $real_pkgpart;
3576 $$total_setup += $setup;
3577 $$total_recur += $recur;
3584 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
3585 return $error if $error;
3587 push @$cust_bill_pkgs, $cust_bill_pkg;
3589 } #if $setup != 0 || $recur != 0
3599 my $part_pkg = shift;
3600 my $taxlisthash = shift;
3601 my $cust_bill_pkg = shift;
3602 my $cust_pkg = shift;
3603 my $invoice_time = shift;
3604 my $real_pkgpart = shift;
3605 my $options = shift;
3607 my %cust_bill_pkg = ();
3611 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
3612 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
3613 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
3614 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
3616 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
3618 if ( $conf->exists('enable_taxproducts')
3619 && ( scalar($part_pkg->part_pkg_taxoverride)
3620 || $part_pkg->has_taxproduct
3625 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3626 return "fatal: Can't (yet) use tax-pkg_address with taxproducts";
3629 foreach my $class (@classes) {
3630 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class );
3631 return $err_or_ref unless ref($err_or_ref);
3632 $taxes{$class} = $err_or_ref;
3635 unless (exists $taxes{''}) {
3636 my $err_or_ref = $self->_gather_taxes( $part_pkg, '' );
3637 return $err_or_ref unless ref($err_or_ref);
3638 $taxes{''} = $err_or_ref;
3643 my @loc_keys = qw( city county state country );
3645 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3646 my $cust_location = $cust_pkg->cust_location;
3647 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
3650 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
3653 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
3656 $taxhash{'taxclass'} = $part_pkg->taxclass;
3659 my %taxhash_elim = %taxhash;
3660 my @elim = qw( city county state );
3663 #first try a match with taxclass
3664 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
3666 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
3667 #then try a match without taxclass
3668 my %no_taxclass = %taxhash_elim;
3669 $no_taxclass{ 'taxclass' } = '';
3670 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
3673 $taxhash_elim{ shift(@elim) } = '';
3675 } while ( !scalar(@taxes) && scalar(@elim) );
3677 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
3679 if $self->cust_main_exemption; #just to be safe
3681 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3683 $_->set('pkgnum', $cust_pkg->pkgnum );
3684 $_->set('locationnum', $cust_pkg->locationnum );
3688 $taxes{''} = [ @taxes ];
3689 $taxes{'setup'} = [ @taxes ];
3690 $taxes{'recur'} = [ @taxes ];
3691 $taxes{$_} = [ @taxes ] foreach (@classes);
3693 # # maybe eliminate this entirely, along with all the 0% records
3694 # unless ( @taxes ) {
3696 # "fatal: can't find tax rate for state/county/country/taxclass ".
3697 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
3700 } #if $conf->exists('enable_taxproducts') ...
3705 my $separate = $conf->exists('separate_usage');
3706 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
3707 my $usage_mandate = $temp_pkg->part_pkg->option('usage_mandate', 'Hush!');
3708 my $section = $temp_pkg->part_pkg->categoryname;
3709 if ( $separate || $section || $usage_mandate ) {
3711 my %hash = ( 'section' => $section );
3713 $section = $temp_pkg->part_pkg->option('usage_section', 'Hush!');
3714 my $summary = $temp_pkg->part_pkg->option('summarize_usage', 'Hush!');
3716 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3717 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
3719 push @display, new FS::cust_bill_pkg_display
3722 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
3726 if ($separate && $section && $summary) {
3727 push @display, new FS::cust_bill_pkg_display { type => 'U',
3732 if ($usage_mandate || $section && $summary) {
3733 $hash{post_total} = 'Y';
3736 if ($separate || $usage_mandate) {
3737 $hash{section} = $section if ($separate || $usage_mandate);
3738 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
3742 $cust_bill_pkg->set('display', \@display);
3744 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
3745 foreach my $key (keys %tax_cust_bill_pkg) {
3746 my @taxes = @{ $taxes{$key} || [] };
3747 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
3749 my %localtaxlisthash = ();
3750 foreach my $tax ( @taxes ) {
3752 my $taxname = ref( $tax ). ' '. $tax->taxnum;
3753 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
3754 # ' locationnum'. $cust_pkg->locationnum
3755 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
3757 $taxlisthash->{ $taxname } ||= [ $tax ];
3758 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
3760 $localtaxlisthash{ $taxname } ||= [ $tax ];
3761 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
3765 warn "finding taxed taxes...\n" if $DEBUG > 2;
3766 foreach my $tax ( keys %localtaxlisthash ) {
3767 my $tax_object = shift @{ $localtaxlisthash{$tax} };
3768 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
3770 next unless $tax_object->can('tax_on_tax');
3772 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
3773 my $totname = ref( $tot ). ' '. $tot->taxnum;
3775 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
3777 next unless exists( $localtaxlisthash{ $totname } ); # only increase
3779 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
3780 my $hashref_or_error =
3781 $tax_object->taxline( $localtaxlisthash{$tax},
3782 'custnum' => $self->custnum,
3783 'invoice_time' => $invoice_time,
3785 return $hashref_or_error
3786 unless ref($hashref_or_error);
3788 $taxlisthash->{ $totname } ||= [ $tot ];
3789 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
3801 my $part_pkg = shift;
3805 my $geocode = $self->geocode('cch');
3807 my @taxclassnums = map { $_->taxclassnum }
3808 $part_pkg->part_pkg_taxoverride($class);
3810 unless (@taxclassnums) {
3811 @taxclassnums = map { $_->taxclassnum }
3812 grep { $_->taxable eq 'Y' }
3813 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
3815 warn "Found taxclassnum values of ". join(',', @taxclassnums)
3820 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
3822 @taxes = qsearch({ 'table' => 'tax_rate',
3823 'hashref' => { 'geocode' => $geocode, },
3824 'extra_sql' => $extra_sql,
3826 if scalar(@taxclassnums);
3828 warn "Found taxes ".
3829 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
3836 =item collect [ HASHREF | OPTION => VALUE ... ]
3838 (Attempt to) collect money for this customer's outstanding invoices (see
3839 L<FS::cust_bill>). Usually used after the bill method.
3841 Actions are now triggered by billing events; see L<FS::part_event> and the
3842 billing events web interface. Old-style invoice events (see
3843 L<FS::part_bill_event>) have been deprecated.
3845 If there is an error, returns the error, otherwise returns false.
3847 Options are passed as name-value pairs.
3849 Currently available options are:
3855 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.
3859 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3863 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3867 set true to surpress email card/ACH decline notices.
3871 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)
3877 # allows for one time override of normal customer billing method
3882 my( $self, %options ) = @_;
3883 my $invoice_time = $options{'invoice_time'} || time;
3886 local $SIG{HUP} = 'IGNORE';
3887 local $SIG{INT} = 'IGNORE';
3888 local $SIG{QUIT} = 'IGNORE';
3889 local $SIG{TERM} = 'IGNORE';
3890 local $SIG{TSTP} = 'IGNORE';
3891 local $SIG{PIPE} = 'IGNORE';
3893 my $oldAutoCommit = $FS::UID::AutoCommit;
3894 local $FS::UID::AutoCommit = 0;
3897 $self->select_for_update; #mutex
3900 my $balance = $self->balance;
3901 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
3904 if ( exists($options{'retry_card'}) ) {
3905 carp 'retry_card option passed to collect is deprecated; use retry';
3906 $options{'retry'} ||= $options{'retry_card'};
3908 if ( exists($options{'retry'}) && $options{'retry'} ) {
3909 my $error = $self->retry_realtime;
3911 $dbh->rollback if $oldAutoCommit;
3916 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3918 #never want to roll back an event just because it returned an error
3919 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
3921 $self->do_cust_event(
3922 'debug' => ( $options{'debug'} || 0 ),
3923 'time' => $invoice_time,
3924 'check_freq' => $options{'check_freq'},
3925 'stage' => 'collect',
3930 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
3932 Runs billing events; see L<FS::part_event> and the billing events web
3935 If there is an error, returns the error, otherwise returns false.
3937 Options are passed as name-value pairs.
3939 Currently available options are:
3945 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.
3949 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3953 "collect" (the default) or "pre-bill"
3957 set true to surpress email card/ACH decline notices.
3961 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)
3967 # allows for one time override of normal customer billing method
3971 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3974 my( $self, %options ) = @_;
3975 my $time = $options{'time'} || time;
3978 local $SIG{HUP} = 'IGNORE';
3979 local $SIG{INT} = 'IGNORE';
3980 local $SIG{QUIT} = 'IGNORE';
3981 local $SIG{TERM} = 'IGNORE';
3982 local $SIG{TSTP} = 'IGNORE';
3983 local $SIG{PIPE} = 'IGNORE';
3985 my $oldAutoCommit = $FS::UID::AutoCommit;
3986 local $FS::UID::AutoCommit = 0;
3989 $self->select_for_update; #mutex
3992 my $balance = $self->balance;
3993 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
3996 # if ( exists($options{'retry_card'}) ) {
3997 # carp 'retry_card option passed to collect is deprecated; use retry';
3998 # $options{'retry'} ||= $options{'retry_card'};
4000 # if ( exists($options{'retry'}) && $options{'retry'} ) {
4001 # my $error = $self->retry_realtime;
4003 # $dbh->rollback if $oldAutoCommit;
4008 # false laziness w/pay_batch::import_results
4010 my $due_cust_event = $self->due_cust_event(
4011 'debug' => ( $options{'debug'} || 0 ),
4013 'check_freq' => $options{'check_freq'},
4014 'stage' => ( $options{'stage'} || 'collect' ),
4016 unless( ref($due_cust_event) ) {
4017 $dbh->rollback if $oldAutoCommit;
4018 return $due_cust_event;
4021 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4022 #never want to roll back an event just because it or a different one
4024 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
4026 foreach my $cust_event ( @$due_cust_event ) {
4030 #re-eval event conditions (a previous event could have changed things)
4031 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
4032 #don't leave stray "new/locked" records around
4033 my $error = $cust_event->delete;
4034 return $error if $error;
4039 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
4040 warn " running cust_event ". $cust_event->eventnum. "\n"
4043 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
4044 if ( my $error = $cust_event->do_event() ) {
4045 #XXX wtf is this? figure out a proper dealio with return value
4057 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
4059 Inserts database records for and returns an ordered listref of new events due
4060 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
4061 events are due, an empty listref is returned. If there is an error, returns a
4062 scalar error message.
4064 To actually run the events, call each event's test_condition method, and if
4065 still true, call the event's do_event method.
4067 Options are passed as a hashref or as a list of name-value pairs. Available
4074 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.
4078 "collect" (the default) or "pre-bill"
4082 "Current time" for the events.
4086 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)
4090 Only return events for the specified eventtable (by default, events of all eventtables are returned)
4094 Explicitly pass the objects to be tested (typically used with eventtable).
4098 Set to true to return the objects, but not actually insert them into the
4105 sub due_cust_event {
4107 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
4110 #my $DEBUG = $opt{'debug'}
4111 local($DEBUG) = $opt{'debug'}
4112 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
4114 warn "$me due_cust_event called with options ".
4115 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
4118 $opt{'time'} ||= time;
4120 local $SIG{HUP} = 'IGNORE';
4121 local $SIG{INT} = 'IGNORE';
4122 local $SIG{QUIT} = 'IGNORE';
4123 local $SIG{TERM} = 'IGNORE';
4124 local $SIG{TSTP} = 'IGNORE';
4125 local $SIG{PIPE} = 'IGNORE';
4127 my $oldAutoCommit = $FS::UID::AutoCommit;
4128 local $FS::UID::AutoCommit = 0;
4131 $self->select_for_update #mutex
4132 unless $opt{testonly};
4135 # find possible events (initial search)
4138 my @cust_event = ();
4140 my @eventtable = $opt{'eventtable'}
4141 ? ( $opt{'eventtable'} )
4142 : FS::part_event->eventtables_runorder;
4144 foreach my $eventtable ( @eventtable ) {
4147 if ( $opt{'objects'} ) {
4149 @objects = @{ $opt{'objects'} };
4153 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
4154 @objects = ( $eventtable eq 'cust_main' )
4156 : ( $self->$eventtable() );
4160 my @e_cust_event = ();
4162 my $cross = "CROSS JOIN $eventtable";
4163 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
4164 unless $eventtable eq 'cust_main';
4166 foreach my $object ( @objects ) {
4168 #this first search uses the condition_sql magic for optimization.
4169 #the more possible events we can eliminate in this step the better
4171 my $cross_where = '';
4172 my $pkey = $object->primary_key;
4173 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
4175 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
4177 FS::part_event_condition->where_conditions_sql( $eventtable,
4178 'time'=>$opt{'time'}
4180 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
4182 $extra_sql = "AND $extra_sql" if $extra_sql;
4184 #here is the agent virtualization
4185 $extra_sql .= " AND ( part_event.agentnum IS NULL
4186 OR part_event.agentnum = ". $self->agentnum. ' )';
4188 $extra_sql .= " $order";
4190 warn "searching for events for $eventtable ". $object->$pkey. "\n"
4191 if $opt{'debug'} > 2;
4192 my @part_event = qsearch( {
4193 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
4194 'select' => 'part_event.*',
4195 'table' => 'part_event',
4196 'addl_from' => "$cross $join",
4197 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
4198 'eventtable' => $eventtable,
4201 'extra_sql' => "AND $cross_where $extra_sql",
4205 my $pkey = $object->primary_key;
4206 warn " ". scalar(@part_event).
4207 " possible events found for $eventtable ". $object->$pkey(). "\n";
4210 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
4214 warn " ". scalar(@e_cust_event).
4215 " subtotal possible cust events found for $eventtable\n"
4218 push @cust_event, @e_cust_event;
4222 warn " ". scalar(@cust_event).
4223 " total possible cust events found in initial search\n"
4231 $opt{stage} ||= 'collect';
4233 grep { my $stage = $_->part_event->event_stage;
4234 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
4244 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
4245 'stats_hashref' => \%unsat ),
4248 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
4251 warn " invalid conditions not eliminated with condition_sql:\n".
4252 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
4253 if keys %unsat && $DEBUG; # > 1;
4259 unless( $opt{testonly} ) {
4260 foreach my $cust_event ( @cust_event ) {
4262 my $error = $cust_event->insert();
4264 $dbh->rollback if $oldAutoCommit;
4271 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4277 warn " returning events: ". Dumper(@cust_event). "\n"
4284 =item retry_realtime
4286 Schedules realtime / batch credit card / electronic check / LEC billing
4287 events for for retry. Useful if card information has changed or manual
4288 retry is desired. The 'collect' method must be called to actually retry
4291 Implementation details: For either this customer, or for each of this
4292 customer's open invoices, changes the status of the first "done" (with
4293 statustext error) realtime processing event to "failed".
4297 sub retry_realtime {
4300 local $SIG{HUP} = 'IGNORE';
4301 local $SIG{INT} = 'IGNORE';
4302 local $SIG{QUIT} = 'IGNORE';
4303 local $SIG{TERM} = 'IGNORE';
4304 local $SIG{TSTP} = 'IGNORE';
4305 local $SIG{PIPE} = 'IGNORE';
4307 my $oldAutoCommit = $FS::UID::AutoCommit;
4308 local $FS::UID::AutoCommit = 0;
4311 #a little false laziness w/due_cust_event (not too bad, really)
4313 my $join = FS::part_event_condition->join_conditions_sql;
4314 my $order = FS::part_event_condition->order_conditions_sql;
4317 . join ( ' OR ' , map {
4318 "( part_event.eventtable = " . dbh->quote($_)
4319 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
4320 } FS::part_event->eventtables)
4323 #here is the agent virtualization
4324 my $agent_virt = " ( part_event.agentnum IS NULL
4325 OR part_event.agentnum = ". $self->agentnum. ' )';
4327 #XXX this shouldn't be hardcoded, actions should declare it...
4328 my @realtime_events = qw(
4329 cust_bill_realtime_card
4330 cust_bill_realtime_check
4331 cust_bill_realtime_lec
4335 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
4340 my @cust_event = qsearchs({
4341 'table' => 'cust_event',
4342 'select' => 'cust_event.*',
4343 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
4344 'hashref' => { 'status' => 'done' },
4345 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
4346 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
4349 my %seen_invnum = ();
4350 foreach my $cust_event (@cust_event) {
4352 #max one for the customer, one for each open invoice
4353 my $cust_X = $cust_event->cust_X;
4354 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
4358 or $cust_event->part_event->eventtable eq 'cust_bill'
4361 my $error = $cust_event->retry;
4363 $dbh->rollback if $oldAutoCommit;
4364 return "error scheduling event for retry: $error";
4369 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4377 =item realtime_collect [ OPTION => VALUE ... ]
4379 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4380 via a Business::OnlinePayment or Business::OnlineThirdPartyPayment realtime
4381 gateway. See L<http://420.am/business-onlinepayment> and
4382 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
4384 On failure returns an error message.
4386 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.
4388 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>, I<pkgnum>
4390 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>. If none is specified
4391 then it is deduced from the customer record.
4393 If no I<amount> is specified, then the customer balance is used.
4395 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4396 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4397 if set, will override the value from the customer record.
4399 I<description> is a free-text field passed to the gateway. It defaults to
4400 the value defined by the business-onlinepayment-description configuration
4401 option, or "Internet services" if that is unset.
4403 If an I<invnum> is specified, this payment (if successful) is applied to the
4404 specified invoice. If you don't specify an I<invnum> you might want to
4405 call the B<apply_payments> method or set the I<apply> option.
4407 I<apply> can be set to true to apply a resulting payment.
4409 I<quiet> can be set true to surpress email decline notices.
4411 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4412 resulting paynum, if any.
4414 I<payunique> is a unique identifier for this payment.
4416 I<session_id> is a session identifier associated with this payment.
4418 I<depend_jobnum> allows payment capture to unlock export jobs
4422 sub realtime_collect {
4423 my( $self, %options ) = @_;
4426 warn "$me realtime_collect:\n";
4427 warn " $_ => $options{$_}\n" foreach keys %options;
4430 $options{amount} = $self->balance unless exists( $options{amount} );
4431 $options{method} = FS::payby->payby2bop($self->payby)
4432 unless exists( $options{method} );
4434 return $self->realtime_bop({%options});
4438 =item realtime_bop { [ ARG => VALUE ... ] }
4440 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4441 via a Business::OnlinePayment realtime gateway. See
4442 L<http://420.am/business-onlinepayment> for supported gateways.
4444 Required arguments in the hashref are I<method>, and I<amount>
4446 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4448 Available optional arguments are: I<description>, I<invnum>, I<apply>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
4450 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4451 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4452 if set, will override the value from the customer record.
4454 I<description> is a free-text field passed to the gateway. It defaults to
4455 the value defined by the business-onlinepayment-description configuration
4456 option, or "Internet services" if that is unset.
4458 If an I<invnum> is specified, this payment (if successful) is applied to the
4459 specified invoice. If you don't specify an I<invnum> you might want to
4460 call the B<apply_payments> method or set the I<apply> option.
4462 I<apply> can be set to true to apply a resulting payment.
4464 I<quiet> can be set true to surpress email decline notices.
4466 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4467 resulting paynum, if any.
4469 I<payunique> is a unique identifier for this payment.
4471 I<session_id> is a session identifier associated with this payment.
4473 I<depend_jobnum> allows payment capture to unlock export jobs
4475 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
4479 # some helper routines
4480 sub _bop_recurring_billing {
4481 my( $self, %opt ) = @_;
4483 my $method = scalar($conf->config('credit_card-recurring_billing_flag'));
4485 if ( defined($method) && $method eq 'transaction_is_recur' ) {
4487 return 1 if $opt{'trans_is_recur'};
4491 my %hash = ( 'custnum' => $self->custnum,
4496 if qsearch('cust_pay', { %hash, 'payinfo' => $opt{'payinfo'} } )
4497 || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo('CARD',
4507 sub _payment_gateway {
4508 my ($self, $options) = @_;
4510 $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
4511 unless exists($options->{payment_gateway});
4513 $options->{payment_gateway};
4517 my ($self, $options) = @_;
4520 'login' => $options->{payment_gateway}->gateway_username,
4521 'password' => $options->{payment_gateway}->gateway_password,
4526 my ($self, $options) = @_;
4528 $options->{payment_gateway}->gatewaynum
4529 ? $options->{payment_gateway}->options
4530 : @{ $options->{payment_gateway}->get('options') };
4535 my ($self, $options) = @_;
4537 unless ( $options->{'description'} ) {
4538 if ( $conf->exists('business-onlinepayment-description') ) {
4539 my $dtempl = $conf->config('business-onlinepayment-description');
4541 my $agent = $self->agent->agent;
4543 $options->{'description'} = eval qq("$dtempl");
4545 $options->{'description'} = 'Internet services';
4549 $options->{payinfo} = $self->payinfo unless exists( $options->{payinfo} );
4550 $options->{invnum} ||= '';
4551 $options->{payname} = $self->payname unless exists( $options->{payname} );
4555 my ($self, $options) = @_;
4558 my $payip = exists($options->{'payip'}) ? $options->{'payip'} : $self->payip;
4559 $content{customer_ip} = $payip if length($payip);
4561 $content{invoice_number} = $options->{'invnum'}
4562 if exists($options->{'invnum'}) && length($options->{'invnum'});
4564 $content{email_customer} =
4565 ( $conf->exists('business-onlinepayment-email_customer')
4566 || $conf->exists('business-onlinepayment-email-override') );
4568 my ($payname, $payfirst, $paylast);
4569 if ( $options->{payname} && $options->{method} ne 'ECHECK' ) {
4570 ($payname = $options->{payname}) =~
4571 /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4572 or return "Illegal payname $payname";
4573 ($payfirst, $paylast) = ($1, $2);
4575 $payfirst = $self->getfield('first');
4576 $paylast = $self->getfield('last');
4577 $payname = "$payfirst $paylast";
4580 $content{last_name} = $paylast;
4581 $content{first_name} = $payfirst;
4583 $content{name} = $payname;
4585 $content{address} = exists($options->{'address1'})
4586 ? $options->{'address1'}
4588 my $address2 = exists($options->{'address2'})
4589 ? $options->{'address2'}
4591 $content{address} .= ", ". $address2 if length($address2);
4593 $content{city} = exists($options->{city})
4596 $content{state} = exists($options->{state})
4599 $content{zip} = exists($options->{zip})
4602 $content{country} = exists($options->{country})
4603 ? $options->{country}
4606 $content{referer} = 'http://cleanwhisker.420.am/'; #XXX fix referer :/
4607 $content{phone} = $self->daytime || $self->night;
4612 my %bop_method2payby = (
4622 if (ref($_[0]) eq 'HASH') {
4623 %options = %{$_[0]};
4625 my ( $method, $amount ) = ( shift, shift );
4627 $options{method} = $method;
4628 $options{amount} = $amount;
4632 warn "$me realtime_bop (new): $options{method} $options{amount}\n";
4633 warn " $_ => $options{$_}\n" foreach keys %options;
4636 return $self->fake_bop(%options) if $options{'fake'};
4638 $self->_bop_defaults(\%options);
4641 # set trans_is_recur based on invnum if there is one
4644 my $trans_is_recur = 0;
4645 if ( $options{'invnum'} ) {
4647 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
4648 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
4651 map { $_->part_pkg }
4653 map { $_->cust_pkg }
4654 $cust_bill->cust_bill_pkg;
4657 if grep { $_->freq ne '0' } @part_pkg;
4665 my $payment_gateway = $self->_payment_gateway( \%options );
4666 my $namespace = $payment_gateway->gateway_namespace;
4668 eval "use $namespace";
4672 # check for banned credit card/ACH
4675 my $ban = qsearchs('banned_pay', {
4676 'payby' => $bop_method2payby{$options{method}},
4677 'payinfo' => md5_base64($options{payinfo}),
4679 return "Banned credit card" if $ban;
4685 my $bop_content = $self->_bop_content(\%options);
4686 return $bop_content unless ref($bop_content);
4688 my @invoicing_list = $self->invoicing_list_emailonly;
4689 if ( $conf->exists('emailinvoiceautoalways')
4690 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4691 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4692 push @invoicing_list, $self->all_emails;
4695 my $email = ($conf->exists('business-onlinepayment-email-override'))
4696 ? $conf->config('business-onlinepayment-email-override')
4697 : $invoicing_list[0];
4701 if ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'CC' ) {
4703 $content{card_number} = $options{payinfo};
4704 $paydate = exists($options{'paydate'})
4705 ? $options{'paydate'}
4707 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4708 $content{expiration} = "$2/$1";
4710 my $paycvv = exists($options{'paycvv'})
4711 ? $options{'paycvv'}
4713 $content{cvv2} = $paycvv
4716 my $paystart_month = exists($options{'paystart_month'})
4717 ? $options{'paystart_month'}
4718 : $self->paystart_month;
4720 my $paystart_year = exists($options{'paystart_year'})
4721 ? $options{'paystart_year'}
4722 : $self->paystart_year;
4724 $content{card_start} = "$paystart_month/$paystart_year"
4725 if $paystart_month && $paystart_year;
4727 my $payissue = exists($options{'payissue'})
4728 ? $options{'payissue'}
4730 $content{issue_number} = $payissue if $payissue;
4732 if ( $self->_bop_recurring_billing( 'payinfo' => $options{'payinfo'},
4733 'trans_is_recur' => $trans_is_recur,
4737 $content{recurring_billing} = 'YES';
4738 $content{acct_code} = 'rebill'
4739 if $conf->exists('credit_card-recurring_billing_acct_code');
4742 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'ECHECK' ){
4743 ( $content{account_number}, $content{routing_code} ) =
4744 split('@', $options{payinfo});
4745 $content{bank_name} = $options{payname};
4746 $content{bank_state} = exists($options{'paystate'})
4747 ? $options{'paystate'}
4748 : $self->getfield('paystate');
4749 $content{account_type} = exists($options{'paytype'})
4750 ? uc($options{'paytype'}) || 'CHECKING'
4751 : uc($self->getfield('paytype')) || 'CHECKING';
4752 $content{account_name} = $self->getfield('first'). ' '.
4753 $self->getfield('last');
4755 $content{customer_org} = $self->company ? 'B' : 'I';
4756 $content{state_id} = exists($options{'stateid'})
4757 ? $options{'stateid'}
4758 : $self->getfield('stateid');
4759 $content{state_id_state} = exists($options{'stateid_state'})
4760 ? $options{'stateid_state'}
4761 : $self->getfield('stateid_state');
4762 $content{customer_ssn} = exists($options{'ss'})
4765 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'LEC' ) {
4766 $content{phone} = $options{payinfo};
4767 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
4774 # run transaction(s)
4777 my $balance = exists( $options{'balance'} )
4778 ? $options{'balance'}
4781 $self->select_for_update; #mutex ... just until we get our pending record in
4783 #the checks here are intended to catch concurrent payments
4784 #double-form-submission prevention is taken care of in cust_pay_pending::check
4787 return "The customer's balance has changed; $options{method} transaction aborted."
4788 if $self->balance < $balance;
4789 #&& $self->balance < $options{amount}; #might as well anyway?
4791 #also check and make sure there aren't *other* pending payments for this cust
4793 my @pending = qsearch('cust_pay_pending', {
4794 'custnum' => $self->custnum,
4795 'status' => { op=>'!=', value=>'done' }
4797 return "A payment is already being processed for this customer (".
4798 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
4799 "); $options{method} transaction aborted."
4800 if scalar(@pending);
4802 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
4804 my $cust_pay_pending = new FS::cust_pay_pending {
4805 'custnum' => $self->custnum,
4806 #'invnum' => $options{'invnum'},
4807 'paid' => $options{amount},
4809 'payby' => $bop_method2payby{$options{method}},
4810 'payinfo' => $options{payinfo},
4811 'paydate' => $paydate,
4812 'recurring_billing' => $content{recurring_billing},
4813 'pkgnum' => $options{'pkgnum'},
4815 'gatewaynum' => $payment_gateway->gatewaynum || '',
4816 'session_id' => $options{session_id} || '',
4817 'jobnum' => $options{depend_jobnum} || '',
4819 $cust_pay_pending->payunique( $options{payunique} )
4820 if defined($options{payunique}) && length($options{payunique});
4821 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
4822 return $cpp_new_err if $cpp_new_err;
4824 my( $action1, $action2 ) =
4825 split( /\s*\,\s*/, $payment_gateway->gateway_action );
4827 my $transaction = new $namespace( $payment_gateway->gateway_module,
4828 $self->_bop_options(\%options),
4831 $transaction->content(
4832 'type' => $options{method},
4833 $self->_bop_auth(\%options),
4834 'action' => $action1,
4835 'description' => $options{'description'},
4836 'amount' => $options{amount},
4837 #'invoice_number' => $options{'invnum'},
4838 'customer_id' => $self->custnum,
4840 'reference' => $cust_pay_pending->paypendingnum, #for now
4845 $cust_pay_pending->status('pending');
4846 my $cpp_pending_err = $cust_pay_pending->replace;
4847 return $cpp_pending_err if $cpp_pending_err;
4850 my $BOP_TESTING = 0;
4851 my $BOP_TESTING_SUCCESS = 1;
4853 unless ( $BOP_TESTING ) {
4854 $transaction->test_transaction(1)
4855 if $conf->exists('business-onlinepayment-test_transaction');
4856 $transaction->submit();
4858 if ( $BOP_TESTING_SUCCESS ) {
4859 $transaction->is_success(1);
4860 $transaction->authorization('fake auth');
4862 $transaction->is_success(0);
4863 $transaction->error_message('fake failure');
4867 if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
4869 return { reference => $cust_pay_pending->paypendingnum,
4870 map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
4872 } elsif ( $transaction->is_success() && $action2 ) {
4874 $cust_pay_pending->status('authorized');
4875 my $cpp_authorized_err = $cust_pay_pending->replace;
4876 return $cpp_authorized_err if $cpp_authorized_err;
4878 my $auth = $transaction->authorization;
4879 my $ordernum = $transaction->can('order_number')
4880 ? $transaction->order_number
4884 new Business::OnlinePayment( $payment_gateway->gateway_module,
4885 $self->_bop_options(\%options),
4890 type => $options{method},
4892 $self->_bop_auth(\%options),
4893 order_number => $ordernum,
4894 amount => $options{amount},
4895 authorization => $auth,
4896 description => $options{'description'},
4899 foreach my $field (qw( authorization_source_code returned_ACI
4900 transaction_identifier validation_code
4901 transaction_sequence_num local_transaction_date
4902 local_transaction_time AVS_result_code )) {
4903 $capture{$field} = $transaction->$field() if $transaction->can($field);
4906 $capture->content( %capture );
4908 $capture->test_transaction(1)
4909 if $conf->exists('business-onlinepayment-test_transaction');
4912 unless ( $capture->is_success ) {
4913 my $e = "Authorization successful but capture failed, custnum #".
4914 $self->custnum. ': '. $capture->result_code.
4915 ": ". $capture->error_message;
4923 # remove paycvv after initial transaction
4926 #false laziness w/misc/process/payment.cgi - check both to make sure working
4928 if ( defined $self->dbdef_table->column('paycvv')
4929 && length($self->paycvv)
4930 && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
4932 my $error = $self->remove_cvv;
4934 warn "WARNING: error removing cvv: $error\n";
4943 if ( $transaction->can('card_token') && $transaction->card_token ) {
4945 $self->card_token($transaction->card_token);
4947 if ( $options{'payinfo'} eq $self->payinfo ) {
4948 $self->payinfo($transaction->card_token);
4949 my $error = $self->replace;
4951 warn "WARNING: error storing token: $error, but proceeding anyway\n";
4961 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
4973 if (ref($_[0]) eq 'HASH') {
4974 %options = %{$_[0]};
4976 my ( $method, $amount ) = ( shift, shift );
4978 $options{method} = $method;
4979 $options{amount} = $amount;
4982 if ( $options{'fake_failure'} ) {
4983 return "Error: No error; test failure requested with fake_failure";
4987 #if ( $payment_gateway->gatewaynum ) { # agent override
4988 # $paybatch = $payment_gateway->gatewaynum. '-';
4991 #$paybatch .= "$processor:". $transaction->authorization;
4993 #$paybatch .= ':'. $transaction->order_number
4994 # if $transaction->can('order_number')
4995 # && length($transaction->order_number);
4997 my $paybatch = 'FakeProcessor:54:32';
4999 my $cust_pay = new FS::cust_pay ( {
5000 'custnum' => $self->custnum,
5001 'invnum' => $options{'invnum'},
5002 'paid' => $options{amount},
5004 'payby' => $bop_method2payby{$options{method}},
5005 #'payinfo' => $payinfo,
5006 'payinfo' => '4111111111111111',
5007 'paybatch' => $paybatch,
5008 #'paydate' => $paydate,
5009 'paydate' => '2012-05-01',
5011 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
5013 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5016 $cust_pay->invnum(''); #try again with no specific invnum
5017 my $error2 = $cust_pay->insert( $options{'manual'} ?
5018 ( 'manual' => 1 ) : ()
5021 # gah, even with transactions.
5022 my $e = 'WARNING: Card/ACH debited but database not updated - '.
5023 "error inserting (fake!) payment: $error2".
5024 " (previously tried insert with invnum #$options{'invnum'}" .
5031 if ( $options{'paynum_ref'} ) {
5032 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5035 return ''; #no error
5040 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
5042 # Wraps up processing of a realtime credit card, ACH (electronic check) or
5043 # phone bill transaction.
5045 sub _realtime_bop_result {
5046 my( $self, $cust_pay_pending, $transaction, %options ) = @_;
5048 warn "$me _realtime_bop_result: pending transaction ".
5049 $cust_pay_pending->paypendingnum. "\n";
5050 warn " $_ => $options{$_}\n" foreach keys %options;
5053 my $payment_gateway = $options{payment_gateway}
5054 or return "no payment gateway in arguments to _realtime_bop_result";
5056 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
5057 my $cpp_captured_err = $cust_pay_pending->replace;
5058 return $cpp_captured_err if $cpp_captured_err;
5060 if ( $transaction->is_success() ) {
5063 if ( $payment_gateway->gatewaynum ) { # agent override
5064 $paybatch = $payment_gateway->gatewaynum. '-';
5067 $paybatch .= $payment_gateway->gateway_module. ":".
5068 $transaction->authorization;
5070 $paybatch .= ':'. $transaction->order_number
5071 if $transaction->can('order_number')
5072 && length($transaction->order_number);
5074 my $cust_pay = new FS::cust_pay ( {
5075 'custnum' => $self->custnum,
5076 'invnum' => $options{'invnum'},
5077 'paid' => $cust_pay_pending->paid,
5079 'payby' => $cust_pay_pending->payby,
5080 'payinfo' => $options{'payinfo'},
5081 'paybatch' => $paybatch,
5082 'paydate' => $cust_pay_pending->paydate,
5083 'pkgnum' => $cust_pay_pending->pkgnum,
5085 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
5086 $cust_pay->payunique( $options{payunique} )
5087 if defined($options{payunique}) && length($options{payunique});
5089 my $oldAutoCommit = $FS::UID::AutoCommit;
5090 local $FS::UID::AutoCommit = 0;
5093 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
5095 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5098 $cust_pay->invnum(''); #try again with no specific invnum
5099 my $error2 = $cust_pay->insert( $options{'manual'} ?
5100 ( 'manual' => 1 ) : ()
5103 # gah. but at least we have a record of the state we had to abort in
5104 # from cust_pay_pending now.
5105 my $e = "WARNING: $options{method} captured but payment not recorded -".
5106 " error inserting payment (". $payment_gateway->gateway_module.
5108 " (previously tried insert with invnum #$options{'invnum'}" .
5109 ": $error ) - pending payment saved as paypendingnum ".
5110 $cust_pay_pending->paypendingnum. "\n";
5116 my $jobnum = $cust_pay_pending->jobnum;
5118 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5120 unless ( $placeholder ) {
5121 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5122 my $e = "WARNING: $options{method} captured but job $jobnum not ".
5123 "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
5128 $error = $placeholder->delete;
5131 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5132 my $e = "WARNING: $options{method} captured but could not delete ".
5133 "job $jobnum for paypendingnum ".
5134 $cust_pay_pending->paypendingnum. ": $error\n";
5141 if ( $options{'paynum_ref'} ) {
5142 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5145 $cust_pay_pending->status('done');
5146 $cust_pay_pending->statustext('captured');
5147 $cust_pay_pending->paynum($cust_pay->paynum);
5148 my $cpp_done_err = $cust_pay_pending->replace;
5150 if ( $cpp_done_err ) {
5152 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5153 my $e = "WARNING: $options{method} captured but payment not recorded - ".
5154 "error updating status for paypendingnum ".
5155 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5161 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5163 if ( $options{'apply'} ) {
5164 my $apply_error = $self->apply_payments_and_credits;
5165 if ( $apply_error ) {
5166 warn "WARNING: error applying payment: $apply_error\n";
5167 #but we still should return no error cause the payment otherwise went
5172 return ''; #no error
5178 my $perror = $payment_gateway->gateway_module. " error: ".
5179 $transaction->error_message;
5181 my $jobnum = $cust_pay_pending->jobnum;
5183 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5185 if ( $placeholder ) {
5186 my $error = $placeholder->depended_delete;
5187 $error ||= $placeholder->delete;
5188 warn "error removing provisioning jobs after declined paypendingnum ".
5189 $cust_pay_pending->paypendingnum. "\n";
5191 my $e = "error finding job $jobnum for declined paypendingnum ".
5192 $cust_pay_pending->paypendingnum. "\n";
5198 unless ( $transaction->error_message ) {
5201 if ( $transaction->can('response_page') ) {
5203 'page' => ( $transaction->can('response_page')
5204 ? $transaction->response_page
5207 'code' => ( $transaction->can('response_code')
5208 ? $transaction->response_code
5211 'headers' => ( $transaction->can('response_headers')
5212 ? $transaction->response_headers
5218 "No additional debugging information available for ".
5219 $payment_gateway->gateway_module;
5222 $perror .= "No error_message returned from ".
5223 $payment_gateway->gateway_module. " -- ".
5224 ( ref($t_response) ? Dumper($t_response) : $t_response );
5228 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
5229 && $conf->exists('emaildecline')
5230 && grep { $_ ne 'POST' } $self->invoicing_list
5231 && ! grep { $transaction->error_message =~ /$_/ }
5232 $conf->config('emaildecline-exclude')
5235 # Send a decline alert to the customer.
5236 my $msgnum = $conf->config('decline_msgnum', $self->agentnum);
5239 # include the raw error message in the transaction state
5240 $cust_pay_pending->setfield('error', $transaction->error_message);
5241 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
5242 $error = $msg_template->send( 'cust_main' => $self,
5243 'object' => $cust_pay_pending );
5247 my @templ = $conf->config('declinetemplate');
5248 my $template = new Text::Template (
5250 SOURCE => [ map "$_\n", @templ ],
5251 ) or return "($perror) can't create template: $Text::Template::ERROR";
5252 $template->compile()
5253 or return "($perror) can't compile template: $Text::Template::ERROR";
5257 scalar( $conf->config('company_name', $self->agentnum ) ),
5258 'company_address' =>
5259 join("\n", $conf->config('company_address', $self->agentnum ) ),
5260 'error' => $transaction->error_message,
5263 my $error = send_email(
5264 'from' => $conf->config('invoice_from', $self->agentnum ),
5265 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
5266 'subject' => 'Your payment could not be processed',
5267 'body' => [ $template->fill_in(HASH => $templ_hash) ],
5271 $perror .= " (also received error sending decline notification: $error)"
5276 $cust_pay_pending->status('done');
5277 $cust_pay_pending->statustext("declined: $perror");
5278 my $cpp_done_err = $cust_pay_pending->replace;
5279 if ( $cpp_done_err ) {
5280 my $e = "WARNING: $options{method} declined but pending payment not ".
5281 "resolved - error updating status for paypendingnum ".
5282 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5284 $perror = "$e ($perror)";
5292 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
5294 Verifies successful third party processing of a realtime credit card,
5295 ACH (electronic check) or phone bill transaction via a
5296 Business::OnlineThirdPartyPayment realtime gateway. See
5297 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5299 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
5301 The additional options I<payname>, I<city>, I<state>,
5302 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5303 if set, will override the value from the customer record.
5305 I<description> is a free-text field passed to the gateway. It defaults to
5306 "Internet services".
5308 If an I<invnum> is specified, this payment (if successful) is applied to the
5309 specified invoice. If you don't specify an I<invnum> you might want to
5310 call the B<apply_payments> method.
5312 I<quiet> can be set true to surpress email decline notices.
5314 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5315 resulting paynum, if any.
5317 I<payunique> is a unique identifier for this payment.
5319 Returns a hashref containing elements bill_error (which will be undefined
5320 upon success) and session_id of any associated session.
5324 sub realtime_botpp_capture {
5325 my( $self, $cust_pay_pending, %options ) = @_;
5327 warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
5328 warn " $_ => $options{$_}\n" foreach keys %options;
5331 eval "use Business::OnlineThirdPartyPayment";
5335 # select the gateway
5338 my $method = FS::payby->payby2bop($cust_pay_pending->payby);
5340 my $payment_gateway = $cust_pay_pending->gatewaynum
5341 ? qsearchs( 'payment_gateway',
5342 { gatewaynum => $cust_pay_pending->gatewaynum }
5344 : $self->agent->payment_gateway( 'method' => $method,
5345 # 'invnum' => $cust_pay_pending->invnum,
5346 # 'payinfo' => $cust_pay_pending->payinfo,
5349 $options{payment_gateway} = $payment_gateway; # for the helper subs
5355 my @invoicing_list = $self->invoicing_list_emailonly;
5356 if ( $conf->exists('emailinvoiceautoalways')
5357 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5358 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5359 push @invoicing_list, $self->all_emails;
5362 my $email = ($conf->exists('business-onlinepayment-email-override'))
5363 ? $conf->config('business-onlinepayment-email-override')
5364 : $invoicing_list[0];
5368 $content{email_customer} =
5369 ( $conf->exists('business-onlinepayment-email_customer')
5370 || $conf->exists('business-onlinepayment-email-override') );
5373 # run transaction(s)
5377 new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
5378 $self->_bop_options(\%options),
5381 $transaction->reference({ %options });
5383 $transaction->content(
5385 $self->_bop_auth(\%options),
5386 'action' => 'Post Authorization',
5387 'description' => $options{'description'},
5388 'amount' => $cust_pay_pending->paid,
5389 #'invoice_number' => $options{'invnum'},
5390 'customer_id' => $self->custnum,
5391 'referer' => 'http://cleanwhisker.420.am/',
5392 'reference' => $cust_pay_pending->paypendingnum,
5394 'phone' => $self->daytime || $self->night,
5396 # plus whatever is required for bogus capture avoidance
5399 $transaction->submit();
5402 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5405 bill_error => $error,
5406 session_id => $cust_pay_pending->session_id,
5411 =item default_payment_gateway DEPRECATED -- use agent->payment_gateway
5415 sub default_payment_gateway {
5416 my( $self, $method ) = @_;
5418 die "Real-time processing not enabled\n"
5419 unless $conf->exists('business-onlinepayment');
5421 #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
5424 my $bop_config = 'business-onlinepayment';
5425 $bop_config .= '-ach'
5426 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
5427 my ( $processor, $login, $password, $action, @bop_options ) =
5428 $conf->config($bop_config);
5429 $action ||= 'normal authorization';
5430 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
5431 die "No real-time processor is enabled - ".
5432 "did you set the business-onlinepayment configuration value?\n"
5435 ( $processor, $login, $password, $action, @bop_options )
5440 Removes the I<paycvv> field from the database directly.
5442 If there is an error, returns the error, otherwise returns false.
5448 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
5449 or return dbh->errstr;
5450 $sth->execute($self->custnum)
5451 or return $sth->errstr;
5456 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
5458 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
5459 via a Business::OnlinePayment realtime gateway. See
5460 L<http://420.am/business-onlinepayment> for supported gateways.
5462 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5464 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
5466 Most gateways require a reference to an original payment transaction to refund,
5467 so you probably need to specify a I<paynum>.
5469 I<amount> defaults to the original amount of the payment if not specified.
5471 I<reason> specifies a reason for the refund.
5473 I<paydate> specifies the expiration date for a credit card overriding the
5474 value from the customer record or the payment record. Specified as yyyy-mm-dd
5476 Implementation note: If I<amount> is unspecified or equal to the amount of the
5477 orignal payment, first an attempt is made to "void" the transaction via
5478 the gateway (to cancel a not-yet settled transaction) and then if that fails,
5479 the normal attempt is made to "refund" ("credit") the transaction via the
5480 gateway is attempted.
5482 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5483 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5484 #if set, will override the value from the customer record.
5486 #If an I<invnum> is specified, this payment (if successful) is applied to the
5487 #specified invoice. If you don't specify an I<invnum> you might want to
5488 #call the B<apply_payments> method.
5492 #some false laziness w/realtime_bop, not enough to make it worth merging
5493 #but some useful small subs should be pulled out
5494 sub realtime_refund_bop {
5498 if (ref($_[0]) eq 'HASH') {
5499 %options = %{$_[0]};
5503 $options{method} = $method;
5507 warn "$me realtime_refund_bop (new): $options{method} refund\n";
5508 warn " $_ => $options{$_}\n" foreach keys %options;
5512 # look up the original payment and optionally a gateway for that payment
5516 my $amount = $options{'amount'};
5518 my( $processor, $login, $password, @bop_options, $namespace ) ;
5519 my( $auth, $order_number ) = ( '', '', '' );
5521 if ( $options{'paynum'} ) {
5523 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
5524 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
5525 or return "Unknown paynum $options{'paynum'}";
5526 $amount ||= $cust_pay->paid;
5528 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
5529 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
5530 $cust_pay->paybatch;
5531 my $gatewaynum = '';
5532 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
5534 if ( $gatewaynum ) { #gateway for the payment to be refunded
5536 my $payment_gateway =
5537 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
5538 die "payment gateway $gatewaynum not found"
5539 unless $payment_gateway;
5541 $processor = $payment_gateway->gateway_module;
5542 $login = $payment_gateway->gateway_username;
5543 $password = $payment_gateway->gateway_password;
5544 $namespace = $payment_gateway->gateway_namespace;
5545 @bop_options = $payment_gateway->options;
5547 } else { #try the default gateway
5550 my $payment_gateway =
5551 $self->agent->payment_gateway('method' => $options{method});
5553 ( $conf_processor, $login, $password, $namespace ) =
5554 map { my $method = "gateway_$_"; $payment_gateway->$method }
5555 qw( module username password namespace );
5557 @bop_options = $payment_gateway->gatewaynum
5558 ? $payment_gateway->options
5559 : @{ $payment_gateway->get('options') };
5561 return "processor of payment $options{'paynum'} $processor does not".
5562 " match default processor $conf_processor"
5563 unless $processor eq $conf_processor;
5568 } else { # didn't specify a paynum, so look for agent gateway overrides
5569 # like a normal transaction
5571 my $payment_gateway =
5572 $self->agent->payment_gateway( 'method' => $options{method},
5573 #'payinfo' => $payinfo,
5575 my( $processor, $login, $password, $namespace ) =
5576 map { my $method = "gateway_$_"; $payment_gateway->$method }
5577 qw( module username password namespace );
5579 my @bop_options = $payment_gateway->gatewaynum
5580 ? $payment_gateway->options
5581 : @{ $payment_gateway->get('options') };
5584 return "neither amount nor paynum specified" unless $amount;
5586 eval "use $namespace";
5590 'type' => $options{method},
5592 'password' => $password,
5593 'order_number' => $order_number,
5594 'amount' => $amount,
5595 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
5597 $content{authorization} = $auth
5598 if length($auth); #echeck/ACH transactions have an order # but no auth
5599 #(at least with authorize.net)
5601 my $disable_void_after;
5602 if ($conf->exists('disable_void_after')
5603 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
5604 $disable_void_after = $1;
5607 #first try void if applicable
5608 if ( $cust_pay && $cust_pay->paid == $amount
5610 ( not defined($disable_void_after) )
5611 || ( time < ($cust_pay->_date + $disable_void_after ) )
5614 warn " attempting void\n" if $DEBUG > 1;
5615 my $void = new Business::OnlinePayment( $processor, @bop_options );
5616 if ( $void->can('info') ) {
5617 if ( $cust_pay->payby eq 'CARD'
5618 && $void->info('CC_void_requires_card') )
5620 $content{'card_number'} = $cust_pay->payinfo;
5621 } elsif ( $cust_pay->payby eq 'CHEK'
5622 && $void->info('ECHECK_void_requires_account') )
5624 ( $content{'account_number'}, $content{'routing_code'} ) =
5625 split('@', $cust_pay->payinfo);
5626 $content{'name'} = $self->get('first'). ' '. $self->get('last');
5629 $void->content( 'action' => 'void', %content );
5630 $void->test_transaction(1)
5631 if $conf->exists('business-onlinepayment-test_transaction');
5633 if ( $void->is_success ) {
5634 my $error = $cust_pay->void($options{'reason'});
5636 # gah, even with transactions.
5637 my $e = 'WARNING: Card/ACH voided but database not updated - '.
5638 "error voiding payment: $error";
5642 warn " void successful\n" if $DEBUG > 1;
5647 warn " void unsuccessful, trying refund\n"
5651 my $address = $self->address1;
5652 $address .= ", ". $self->address2 if $self->address2;
5654 my($payname, $payfirst, $paylast);
5655 if ( $self->payname && $options{method} ne 'ECHECK' ) {
5656 $payname = $self->payname;
5657 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5658 or return "Illegal payname $payname";
5659 ($payfirst, $paylast) = ($1, $2);
5661 $payfirst = $self->getfield('first');
5662 $paylast = $self->getfield('last');
5663 $payname = "$payfirst $paylast";
5666 my @invoicing_list = $self->invoicing_list_emailonly;
5667 if ( $conf->exists('emailinvoiceautoalways')
5668 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5669 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5670 push @invoicing_list, $self->all_emails;
5673 my $email = ($conf->exists('business-onlinepayment-email-override'))
5674 ? $conf->config('business-onlinepayment-email-override')
5675 : $invoicing_list[0];
5677 my $payip = exists($options{'payip'})
5680 $content{customer_ip} = $payip
5684 if ( $options{method} eq 'CC' ) {
5687 $content{card_number} = $payinfo = $cust_pay->payinfo;
5688 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
5689 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
5690 ($content{expiration} = "$2/$1"); # where available
5692 $content{card_number} = $payinfo = $self->payinfo;
5693 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
5694 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
5695 $content{expiration} = "$2/$1";
5698 } elsif ( $options{method} eq 'ECHECK' ) {
5701 $payinfo = $cust_pay->payinfo;
5703 $payinfo = $self->payinfo;
5705 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
5706 $content{bank_name} = $self->payname;
5707 $content{account_type} = 'CHECKING';
5708 $content{account_name} = $payname;
5709 $content{customer_org} = $self->company ? 'B' : 'I';
5710 $content{customer_ssn} = $self->ss;
5711 } elsif ( $options{method} eq 'LEC' ) {
5712 $content{phone} = $payinfo = $self->payinfo;
5716 my $refund = new Business::OnlinePayment( $processor, @bop_options );
5717 my %sub_content = $refund->content(
5718 'action' => 'credit',
5719 'customer_id' => $self->custnum,
5720 'last_name' => $paylast,
5721 'first_name' => $payfirst,
5723 'address' => $address,
5724 'city' => $self->city,
5725 'state' => $self->state,
5726 'zip' => $self->zip,
5727 'country' => $self->country,
5729 'phone' => $self->daytime || $self->night,
5732 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
5734 $refund->test_transaction(1)
5735 if $conf->exists('business-onlinepayment-test_transaction');
5738 return "$processor error: ". $refund->error_message
5739 unless $refund->is_success();
5741 my $paybatch = "$processor:". $refund->authorization;
5742 $paybatch .= ':'. $refund->order_number
5743 if $refund->can('order_number') && $refund->order_number;
5745 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
5746 my @cust_bill_pay = $cust_pay->cust_bill_pay;
5747 last unless @cust_bill_pay;
5748 my $cust_bill_pay = pop @cust_bill_pay;
5749 my $error = $cust_bill_pay->delete;
5753 my $cust_refund = new FS::cust_refund ( {
5754 'custnum' => $self->custnum,
5755 'paynum' => $options{'paynum'},
5756 'refund' => $amount,
5758 'payby' => $bop_method2payby{$options{method}},
5759 'payinfo' => $payinfo,
5760 'paybatch' => $paybatch,
5761 'reason' => $options{'reason'} || 'card or ACH refund',
5763 my $error = $cust_refund->insert;
5765 $cust_refund->paynum(''); #try again with no specific paynum
5766 my $error2 = $cust_refund->insert;
5768 # gah, even with transactions.
5769 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
5770 "error inserting refund ($processor): $error2".
5771 " (previously tried insert with paynum #$options{'paynum'}" .
5782 =item batch_card OPTION => VALUE...
5784 Adds a payment for this invoice to the pending credit card batch (see
5785 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
5786 runs the payment using a realtime gateway.
5791 my ($self, %options) = @_;
5794 if (exists($options{amount})) {
5795 $amount = $options{amount};
5797 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
5799 return '' unless $amount > 0;
5801 my $invnum = delete $options{invnum};
5802 my $payby = $options{invnum} || $self->payby; #dubious
5804 if ($options{'realtime'}) {
5805 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
5811 my $oldAutoCommit = $FS::UID::AutoCommit;
5812 local $FS::UID::AutoCommit = 0;
5815 #this needs to handle mysql as well as Pg, like svc_acct.pm
5816 #(make it into a common function if folks need to do batching with mysql)
5817 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
5818 or return "Cannot lock pay_batch: " . $dbh->errstr;
5822 'payby' => FS::payby->payby2payment($payby),
5825 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
5827 unless ( $pay_batch ) {
5828 $pay_batch = new FS::pay_batch \%pay_batch;
5829 my $error = $pay_batch->insert;
5831 $dbh->rollback if $oldAutoCommit;
5832 die "error creating new batch: $error\n";
5836 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
5837 'batchnum' => $pay_batch->batchnum,
5838 'custnum' => $self->custnum,
5841 foreach (qw( address1 address2 city state zip country payby payinfo paydate
5843 $options{$_} = '' unless exists($options{$_});
5846 my $cust_pay_batch = new FS::cust_pay_batch ( {
5847 'batchnum' => $pay_batch->batchnum,
5848 'invnum' => $invnum || 0, # is there a better value?
5849 # this field should be
5851 # cust_bill_pay_batch now
5852 'custnum' => $self->custnum,
5853 'last' => $self->getfield('last'),
5854 'first' => $self->getfield('first'),
5855 'address1' => $options{address1} || $self->address1,
5856 'address2' => $options{address2} || $self->address2,
5857 'city' => $options{city} || $self->city,
5858 'state' => $options{state} || $self->state,
5859 'zip' => $options{zip} || $self->zip,
5860 'country' => $options{country} || $self->country,
5861 'payby' => $options{payby} || $self->payby,
5862 'payinfo' => $options{payinfo} || $self->payinfo,
5863 'exp' => $options{paydate} || $self->paydate,
5864 'payname' => $options{payname} || $self->payname,
5865 'amount' => $amount, # consolidating
5868 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
5869 if $old_cust_pay_batch;
5872 if ($old_cust_pay_batch) {
5873 $error = $cust_pay_batch->replace($old_cust_pay_batch)
5875 $error = $cust_pay_batch->insert;
5879 $dbh->rollback if $oldAutoCommit;
5883 my $unapplied = $self->total_unapplied_credits
5884 + $self->total_unapplied_payments
5885 + $self->in_transit_payments;
5886 foreach my $cust_bill ($self->open_cust_bill) {
5887 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
5888 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
5889 'invnum' => $cust_bill->invnum,
5890 'paybatchnum' => $cust_pay_batch->paybatchnum,
5891 'amount' => $cust_bill->owed,
5894 if ($unapplied >= $cust_bill_pay_batch->amount){
5895 $unapplied -= $cust_bill_pay_batch->amount;
5898 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
5899 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
5901 $error = $cust_bill_pay_batch->insert;
5903 $dbh->rollback if $oldAutoCommit;
5908 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5912 =item apply_payments_and_credits [ OPTION => VALUE ... ]
5914 Applies unapplied payments and credits.
5916 In most cases, this new method should be used in place of sequential
5917 apply_payments and apply_credits methods.
5919 A hash of optional arguments may be passed. Currently "manual" is supported.
5920 If true, a payment receipt is sent instead of a statement when
5921 'payment_receipt_email' configuration option is set.
5923 If there is an error, returns the error, otherwise returns false.
5927 sub apply_payments_and_credits {
5928 my( $self, %options ) = @_;
5930 local $SIG{HUP} = 'IGNORE';
5931 local $SIG{INT} = 'IGNORE';
5932 local $SIG{QUIT} = 'IGNORE';
5933 local $SIG{TERM} = 'IGNORE';
5934 local $SIG{TSTP} = 'IGNORE';
5935 local $SIG{PIPE} = 'IGNORE';
5937 my $oldAutoCommit = $FS::UID::AutoCommit;
5938 local $FS::UID::AutoCommit = 0;
5941 $self->select_for_update; #mutex
5943 foreach my $cust_bill ( $self->open_cust_bill ) {
5944 my $error = $cust_bill->apply_payments_and_credits(%options);
5946 $dbh->rollback if $oldAutoCommit;
5947 return "Error applying: $error";
5951 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5956 =item apply_credits OPTION => VALUE ...
5958 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
5959 to outstanding invoice balances in chronological order (or reverse
5960 chronological order if the I<order> option is set to B<newest>) and returns the
5961 value of any remaining unapplied credits available for refund (see
5962 L<FS::cust_refund>).
5964 Dies if there is an error.
5972 local $SIG{HUP} = 'IGNORE';
5973 local $SIG{INT} = 'IGNORE';
5974 local $SIG{QUIT} = 'IGNORE';
5975 local $SIG{TERM} = 'IGNORE';
5976 local $SIG{TSTP} = 'IGNORE';
5977 local $SIG{PIPE} = 'IGNORE';
5979 my $oldAutoCommit = $FS::UID::AutoCommit;
5980 local $FS::UID::AutoCommit = 0;
5983 $self->select_for_update; #mutex
5985 unless ( $self->total_unapplied_credits ) {
5986 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5990 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
5991 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
5993 my @invoices = $self->open_cust_bill;
5994 @invoices = sort { $b->_date <=> $a->_date } @invoices
5995 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
5997 if ( $conf->exists('pkg-balances') ) {
5998 # limit @credits to those w/ a pkgnum grepped from $self
6000 foreach my $i (@invoices) {
6001 foreach my $li ( $i->cust_bill_pkg ) {
6002 $pkgnums{$li->pkgnum} = 1;
6005 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
6010 foreach my $cust_bill ( @invoices ) {
6012 if ( !defined($credit) || $credit->credited == 0) {
6013 $credit = pop @credits or last;
6017 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
6018 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
6020 $owed = $cust_bill->owed;
6022 unless ( $owed > 0 ) {
6023 push @credits, $credit;
6027 my $amount = min( $credit->credited, $owed );
6029 my $cust_credit_bill = new FS::cust_credit_bill ( {
6030 'crednum' => $credit->crednum,
6031 'invnum' => $cust_bill->invnum,
6032 'amount' => $amount,
6034 $cust_credit_bill->pkgnum( $credit->pkgnum )
6035 if $conf->exists('pkg-balances') && $credit->pkgnum;
6036 my $error = $cust_credit_bill->insert;
6038 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6042 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6046 my $total_unapplied_credits = $self->total_unapplied_credits;
6048 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6050 return $total_unapplied_credits;
6053 =item apply_payments [ OPTION => VALUE ... ]
6055 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
6056 to outstanding invoice balances in chronological order.
6058 #and returns the value of any remaining unapplied payments.
6060 A hash of optional arguments may be passed. Currently "manual" is supported.
6061 If true, a payment receipt is sent instead of a statement when
6062 'payment_receipt_email' configuration option is set.
6064 Dies if there is an error.
6068 sub apply_payments {
6069 my( $self, %options ) = @_;
6071 local $SIG{HUP} = 'IGNORE';
6072 local $SIG{INT} = 'IGNORE';
6073 local $SIG{QUIT} = 'IGNORE';
6074 local $SIG{TERM} = 'IGNORE';
6075 local $SIG{TSTP} = 'IGNORE';
6076 local $SIG{PIPE} = 'IGNORE';
6078 my $oldAutoCommit = $FS::UID::AutoCommit;
6079 local $FS::UID::AutoCommit = 0;
6082 $self->select_for_update; #mutex
6086 my @payments = sort { $b->_date <=> $a->_date }
6087 grep { $_->unapplied > 0 }
6090 my @invoices = sort { $a->_date <=> $b->_date}
6091 grep { $_->owed > 0 }
6094 if ( $conf->exists('pkg-balances') ) {
6095 # limit @payments to those w/ a pkgnum grepped from $self
6097 foreach my $i (@invoices) {
6098 foreach my $li ( $i->cust_bill_pkg ) {
6099 $pkgnums{$li->pkgnum} = 1;
6102 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
6107 foreach my $cust_bill ( @invoices ) {
6109 if ( !defined($payment) || $payment->unapplied == 0 ) {
6110 $payment = pop @payments or last;
6114 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
6115 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
6117 $owed = $cust_bill->owed;
6119 unless ( $owed > 0 ) {
6120 push @payments, $payment;
6124 my $amount = min( $payment->unapplied, $owed );
6126 my $cust_bill_pay = new FS::cust_bill_pay ( {
6127 'paynum' => $payment->paynum,
6128 'invnum' => $cust_bill->invnum,
6129 'amount' => $amount,
6131 $cust_bill_pay->pkgnum( $payment->pkgnum )
6132 if $conf->exists('pkg-balances') && $payment->pkgnum;
6133 my $error = $cust_bill_pay->insert(%options);
6135 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6139 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6143 my $total_unapplied_payments = $self->total_unapplied_payments;
6145 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6147 return $total_unapplied_payments;
6152 Returns the total owed for this customer on all invoices
6153 (see L<FS::cust_bill/owed>).
6159 $self->total_owed_date(2145859200); #12/31/2037
6162 =item total_owed_date TIME
6164 Returns the total owed for this customer on all invoices with date earlier than
6165 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6166 see L<Time::Local> and L<Date::Parse> for conversion functions.
6170 sub total_owed_date {
6174 my $custnum = $self->custnum;
6176 my $owed_sql = FS::cust_bill->owed_sql;
6179 SELECT SUM($owed_sql) FROM cust_bill
6180 WHERE custnum = $custnum
6184 sprintf( "%.2f", $self->scalar_sql($sql) );
6188 =item total_owed_pkgnum PKGNUM
6190 Returns the total owed on all invoices for this customer's specific package
6191 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
6195 sub total_owed_pkgnum {
6196 my( $self, $pkgnum ) = @_;
6197 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
6200 =item total_owed_date_pkgnum TIME PKGNUM
6202 Returns the total owed for this customer's specific package when using
6203 experimental package balances on all invoices with date earlier than
6204 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6205 see L<Time::Local> and L<Date::Parse> for conversion functions.
6209 sub total_owed_date_pkgnum {
6210 my( $self, $time, $pkgnum ) = @_;
6213 foreach my $cust_bill (
6214 grep { $_->_date <= $time }
6215 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6217 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
6219 sprintf( "%.2f", $total_bill );
6225 Returns the total amount of all payments.
6232 $total += $_->paid foreach $self->cust_pay;
6233 sprintf( "%.2f", $total );
6236 =item total_unapplied_credits
6238 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6239 customer. See L<FS::cust_credit/credited>.
6241 =item total_credited
6243 Old name for total_unapplied_credits. Don't use.
6247 sub total_credited {
6248 #carp "total_credited deprecated, use total_unapplied_credits";
6249 shift->total_unapplied_credits(@_);
6252 sub total_unapplied_credits {
6255 my $custnum = $self->custnum;
6257 my $unapplied_sql = FS::cust_credit->unapplied_sql;
6260 SELECT SUM($unapplied_sql) FROM cust_credit
6261 WHERE custnum = $custnum
6264 sprintf( "%.2f", $self->scalar_sql($sql) );
6268 =item total_unapplied_credits_pkgnum PKGNUM
6270 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6271 customer. See L<FS::cust_credit/credited>.
6275 sub total_unapplied_credits_pkgnum {
6276 my( $self, $pkgnum ) = @_;
6277 my $total_credit = 0;
6278 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
6279 sprintf( "%.2f", $total_credit );
6283 =item total_unapplied_payments
6285 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
6286 See L<FS::cust_pay/unapplied>.
6290 sub total_unapplied_payments {
6293 my $custnum = $self->custnum;
6295 my $unapplied_sql = FS::cust_pay->unapplied_sql;
6298 SELECT SUM($unapplied_sql) FROM cust_pay
6299 WHERE custnum = $custnum
6302 sprintf( "%.2f", $self->scalar_sql($sql) );
6306 =item total_unapplied_payments_pkgnum PKGNUM
6308 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
6309 specific package when using experimental package balances. See
6310 L<FS::cust_pay/unapplied>.
6314 sub total_unapplied_payments_pkgnum {
6315 my( $self, $pkgnum ) = @_;
6316 my $total_unapplied = 0;
6317 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
6318 sprintf( "%.2f", $total_unapplied );
6322 =item total_unapplied_refunds
6324 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
6325 customer. See L<FS::cust_refund/unapplied>.
6329 sub total_unapplied_refunds {
6331 my $custnum = $self->custnum;
6333 my $unapplied_sql = FS::cust_refund->unapplied_sql;
6336 SELECT SUM($unapplied_sql) FROM cust_refund
6337 WHERE custnum = $custnum
6340 sprintf( "%.2f", $self->scalar_sql($sql) );
6346 Returns the balance for this customer (total_owed plus total_unrefunded, minus
6347 total_unapplied_credits minus total_unapplied_payments).
6353 $self->balance_date_range;
6356 =item balance_date TIME
6358 Returns the balance for this customer, only considering invoices with date
6359 earlier than TIME (total_owed_date minus total_credited minus
6360 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
6361 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
6368 $self->balance_date_range(shift);
6371 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
6373 Returns the balance for this customer, optionally considering invoices with
6374 date earlier than START_TIME, and not later than END_TIME
6375 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
6377 Times are specified as SQL fragments or numeric
6378 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
6379 L<Date::Parse> for conversion functions. The empty string can be passed
6380 to disable that time constraint completely.
6382 Available options are:
6386 =item unapplied_date
6388 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)
6394 sub balance_date_range {
6396 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
6397 ') FROM cust_main WHERE custnum='. $self->custnum;
6398 sprintf( '%.2f', $self->scalar_sql($sql) );
6401 =item balance_pkgnum PKGNUM
6403 Returns the balance for this customer's specific package when using
6404 experimental package balances (total_owed plus total_unrefunded, minus
6405 total_unapplied_credits minus total_unapplied_payments)
6409 sub balance_pkgnum {
6410 my( $self, $pkgnum ) = @_;
6413 $self->total_owed_pkgnum($pkgnum)
6414 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
6415 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
6416 - $self->total_unapplied_credits_pkgnum($pkgnum)
6417 - $self->total_unapplied_payments_pkgnum($pkgnum)
6421 =item in_transit_payments
6423 Returns the total of requests for payments for this customer pending in
6424 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
6428 sub in_transit_payments {
6430 my $in_transit_payments = 0;
6431 foreach my $pay_batch ( qsearch('pay_batch', {
6434 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
6435 'batchnum' => $pay_batch->batchnum,
6436 'custnum' => $self->custnum,
6438 $in_transit_payments += $cust_pay_batch->amount;
6441 sprintf( "%.2f", $in_transit_payments );
6446 Returns a hash of useful information for making a payment.
6456 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
6457 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
6458 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
6462 For credit card transactions:
6474 For electronic check transactions:
6489 $return{balance} = $self->balance;
6491 $return{payname} = $self->payname
6492 || ( $self->first. ' '. $self->get('last') );
6494 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
6496 $return{payby} = $self->payby;
6497 $return{stateid_state} = $self->stateid_state;
6499 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
6500 $return{card_type} = cardtype($self->payinfo);
6501 $return{payinfo} = $self->paymask;
6503 @return{'month', 'year'} = $self->paydate_monthyear;
6507 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
6508 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
6509 $return{payinfo1} = $payinfo1;
6510 $return{payinfo2} = $payinfo2;
6511 $return{paytype} = $self->paytype;
6512 $return{paystate} = $self->paystate;
6516 #doubleclick protection
6518 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
6524 =item paydate_monthyear
6526 Returns a two-element list consisting of the month and year of this customer's
6527 paydate (credit card expiration date for CARD customers)
6531 sub paydate_monthyear {
6533 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
6535 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
6542 =item tax_exemption TAXNAME
6547 my( $self, $taxname ) = @_;
6549 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
6550 'taxname' => $taxname,
6555 =item cust_main_exemption
6559 sub cust_main_exemption {
6561 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
6564 =item invoicing_list [ ARRAYREF ]
6566 If an arguement is given, sets these email addresses as invoice recipients
6567 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
6568 (except as warnings), so use check_invoicing_list first.
6570 Returns a list of email addresses (with svcnum entries expanded).
6572 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
6573 check it without disturbing anything by passing nothing.
6575 This interface may change in the future.
6579 sub invoicing_list {
6580 my( $self, $arrayref ) = @_;
6583 my @cust_main_invoice;
6584 if ( $self->custnum ) {
6585 @cust_main_invoice =
6586 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6588 @cust_main_invoice = ();
6590 foreach my $cust_main_invoice ( @cust_main_invoice ) {
6591 #warn $cust_main_invoice->destnum;
6592 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
6593 #warn $cust_main_invoice->destnum;
6594 my $error = $cust_main_invoice->delete;
6595 warn $error if $error;
6598 if ( $self->custnum ) {
6599 @cust_main_invoice =
6600 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6602 @cust_main_invoice = ();
6604 my %seen = map { $_->address => 1 } @cust_main_invoice;
6605 foreach my $address ( @{$arrayref} ) {
6606 next if exists $seen{$address} && $seen{$address};
6607 $seen{$address} = 1;
6608 my $cust_main_invoice = new FS::cust_main_invoice ( {
6609 'custnum' => $self->custnum,
6612 my $error = $cust_main_invoice->insert;
6613 warn $error if $error;
6617 if ( $self->custnum ) {
6619 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6626 =item check_invoicing_list ARRAYREF
6628 Checks these arguements as valid input for the invoicing_list method. If there
6629 is an error, returns the error, otherwise returns false.
6633 sub check_invoicing_list {
6634 my( $self, $arrayref ) = @_;
6636 foreach my $address ( @$arrayref ) {
6638 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
6639 return 'Can\'t add FAX invoice destination with a blank FAX number.';
6642 my $cust_main_invoice = new FS::cust_main_invoice ( {
6643 'custnum' => $self->custnum,
6646 my $error = $self->custnum
6647 ? $cust_main_invoice->check
6648 : $cust_main_invoice->checkdest
6650 return $error if $error;
6654 return "Email address required"
6655 if $conf->exists('cust_main-require_invoicing_list_email')
6656 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
6661 =item set_default_invoicing_list
6663 Sets the invoicing list to all accounts associated with this customer,
6664 overwriting any previous invoicing list.
6668 sub set_default_invoicing_list {
6670 $self->invoicing_list($self->all_emails);
6675 Returns the email addresses of all accounts provisioned for this customer.
6682 foreach my $cust_pkg ( $self->all_pkgs ) {
6683 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
6685 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
6686 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
6688 $list{$_}=1 foreach map { $_->email } @svc_acct;
6693 =item invoicing_list_addpost
6695 Adds postal invoicing to this customer. If this customer is already configured
6696 to receive postal invoices, does nothing.
6700 sub invoicing_list_addpost {
6702 return if grep { $_ eq 'POST' } $self->invoicing_list;
6703 my @invoicing_list = $self->invoicing_list;
6704 push @invoicing_list, 'POST';
6705 $self->invoicing_list(\@invoicing_list);
6708 =item invoicing_list_emailonly
6710 Returns the list of email invoice recipients (invoicing_list without non-email
6711 destinations such as POST and FAX).
6715 sub invoicing_list_emailonly {
6717 warn "$me invoicing_list_emailonly called"
6719 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
6722 =item invoicing_list_emailonly_scalar
6724 Returns the list of email invoice recipients (invoicing_list without non-email
6725 destinations such as POST and FAX) as a comma-separated scalar.
6729 sub invoicing_list_emailonly_scalar {
6731 warn "$me invoicing_list_emailonly_scalar called"
6733 join(', ', $self->invoicing_list_emailonly);
6736 =item referral_custnum_cust_main
6738 Returns the customer who referred this customer (or the empty string, if
6739 this customer was not referred).
6741 Note the difference with referral_cust_main method: This method,
6742 referral_custnum_cust_main returns the single customer (if any) who referred
6743 this customer, while referral_cust_main returns an array of customers referred
6748 sub referral_custnum_cust_main {
6750 return '' unless $self->referral_custnum;
6751 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
6754 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
6756 Returns an array of customers referred by this customer (referral_custnum set
6757 to this custnum). If DEPTH is given, recurses up to the given depth, returning
6758 customers referred by customers referred by this customer and so on, inclusive.
6759 The default behavior is DEPTH 1 (no recursion).
6761 Note the difference with referral_custnum_cust_main method: This method,
6762 referral_cust_main, returns an array of customers referred BY this customer,
6763 while referral_custnum_cust_main returns the single customer (if any) who
6764 referred this customer.
6768 sub referral_cust_main {
6770 my $depth = @_ ? shift : 1;
6771 my $exclude = @_ ? shift : {};
6774 map { $exclude->{$_->custnum}++; $_; }
6775 grep { ! $exclude->{ $_->custnum } }
6776 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
6780 map { $_->referral_cust_main($depth-1, $exclude) }
6787 =item referral_cust_main_ncancelled
6789 Same as referral_cust_main, except only returns customers with uncancelled
6794 sub referral_cust_main_ncancelled {
6796 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
6799 =item referral_cust_pkg [ DEPTH ]
6801 Like referral_cust_main, except returns a flat list of all unsuspended (and
6802 uncancelled) packages for each customer. The number of items in this list may
6803 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
6807 sub referral_cust_pkg {
6809 my $depth = @_ ? shift : 1;
6811 map { $_->unsuspended_pkgs }
6812 grep { $_->unsuspended_pkgs }
6813 $self->referral_cust_main($depth);
6816 =item referring_cust_main
6818 Returns the single cust_main record for the customer who referred this customer
6819 (referral_custnum), or false.
6823 sub referring_cust_main {
6825 return '' unless $self->referral_custnum;
6826 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
6829 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
6831 Applies a credit to this customer. If there is an error, returns the error,
6832 otherwise returns false.
6834 REASON can be a text string, an FS::reason object, or a scalar reference to
6835 a reasonnum. If a text string, it will be automatically inserted as a new
6836 reason, and a 'reason_type' option must be passed to indicate the
6837 FS::reason_type for the new reason.
6839 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
6841 Any other options are passed to FS::cust_credit::insert.
6846 my( $self, $amount, $reason, %options ) = @_;
6848 my $cust_credit = new FS::cust_credit {
6849 'custnum' => $self->custnum,
6850 'amount' => $amount,
6853 if ( ref($reason) ) {
6855 if ( ref($reason) eq 'SCALAR' ) {
6856 $cust_credit->reasonnum( $$reason );
6858 $cust_credit->reasonnum( $reason->reasonnum );
6862 $cust_credit->set('reason', $reason)
6865 for (qw( addlinfo eventnum )) {
6866 $cust_credit->$_( delete $options{$_} )
6867 if exists($options{$_});
6870 $cust_credit->insert(%options);
6874 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
6876 Creates a one-time charge for this customer. If there is an error, returns
6877 the error, otherwise returns false.
6879 New-style, with a hashref of options:
6881 my $error = $cust_main->charge(
6885 'start_date' => str2time('7/4/2009'),
6886 'pkg' => 'Description',
6887 'comment' => 'Comment',
6888 'additional' => [], #extra invoice detail
6889 'classnum' => 1, #pkg_class
6891 'setuptax' => '', # or 'Y' for tax exempt
6894 'taxclass' => 'Tax class',
6897 'taxproduct' => 2, #part_pkg_taxproduct
6898 'override' => {}, #XXX describe
6900 #will be filled in with the new object
6901 'cust_pkg_ref' => \$cust_pkg,
6903 #generate an invoice immediately
6905 'invoice_terms' => '', #with these terms
6911 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
6917 my ( $amount, $quantity, $start_date, $classnum );
6918 my ( $pkg, $comment, $additional );
6919 my ( $setuptax, $taxclass ); #internal taxes
6920 my ( $taxproduct, $override ); #vendor (CCH) taxes
6922 my $cust_pkg_ref = '';
6923 my ( $bill_now, $invoice_terms ) = ( 0, '' );
6924 if ( ref( $_[0] ) ) {
6925 $amount = $_[0]->{amount};
6926 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
6927 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
6928 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
6929 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
6930 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
6931 : '$'. sprintf("%.2f",$amount);
6932 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
6933 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
6934 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
6935 $additional = $_[0]->{additional} || [];
6936 $taxproduct = $_[0]->{taxproductnum};
6937 $override = { '' => $_[0]->{tax_override} };
6938 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
6939 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
6940 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
6945 $pkg = @_ ? shift : 'One-time charge';
6946 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
6948 $taxclass = @_ ? shift : '';
6952 local $SIG{HUP} = 'IGNORE';
6953 local $SIG{INT} = 'IGNORE';
6954 local $SIG{QUIT} = 'IGNORE';
6955 local $SIG{TERM} = 'IGNORE';
6956 local $SIG{TSTP} = 'IGNORE';
6957 local $SIG{PIPE} = 'IGNORE';
6959 my $oldAutoCommit = $FS::UID::AutoCommit;
6960 local $FS::UID::AutoCommit = 0;
6963 my $part_pkg = new FS::part_pkg ( {
6965 'comment' => $comment,
6969 'classnum' => ( $classnum ? $classnum : '' ),
6970 'setuptax' => $setuptax,
6971 'taxclass' => $taxclass,
6972 'taxproductnum' => $taxproduct,
6975 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
6976 ( 0 .. @$additional - 1 )
6978 'additional_count' => scalar(@$additional),
6979 'setup_fee' => $amount,
6982 my $error = $part_pkg->insert( options => \%options,
6983 tax_overrides => $override,
6986 $dbh->rollback if $oldAutoCommit;
6990 my $pkgpart = $part_pkg->pkgpart;
6991 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
6992 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
6993 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
6994 $error = $type_pkgs->insert;
6996 $dbh->rollback if $oldAutoCommit;
7001 my $cust_pkg = new FS::cust_pkg ( {
7002 'custnum' => $self->custnum,
7003 'pkgpart' => $pkgpart,
7004 'quantity' => $quantity,
7005 'start_date' => $start_date,
7006 'no_auto' => $no_auto,
7009 $error = $cust_pkg->insert;
7011 $dbh->rollback if $oldAutoCommit;
7013 } elsif ( $cust_pkg_ref ) {
7014 ${$cust_pkg_ref} = $cust_pkg;
7018 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
7019 'pkg_list' => [ $cust_pkg ],
7022 $dbh->rollback if $oldAutoCommit;
7027 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
7032 #=item charge_postal_fee
7034 #Applies a one time charge this customer. If there is an error,
7035 #returns the error, returns the cust_pkg charge object or false
7036 #if there was no charge.
7040 # This should be a customer event. For that to work requires that bill
7041 # also be a customer event.
7043 sub charge_postal_fee {
7046 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
7047 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
7049 my $cust_pkg = new FS::cust_pkg ( {
7050 'custnum' => $self->custnum,
7051 'pkgpart' => $pkgpart,
7055 my $error = $cust_pkg->insert;
7056 $error ? $error : $cust_pkg;
7061 Returns all the invoices (see L<FS::cust_bill>) for this customer.
7067 map { $_ } #return $self->num_cust_bill unless wantarray;
7068 sort { $a->_date <=> $b->_date }
7069 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
7072 =item open_cust_bill
7074 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
7079 sub open_cust_bill {
7083 'table' => 'cust_bill',
7084 'hashref' => { 'custnum' => $self->custnum, },
7085 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
7086 'order_by' => 'ORDER BY _date ASC',
7091 =item cust_statements
7093 Returns all the statements (see L<FS::cust_statement>) for this customer.
7097 sub cust_statement {
7099 map { $_ } #return $self->num_cust_statement unless wantarray;
7100 sort { $a->_date <=> $b->_date }
7101 qsearch('cust_statement', { 'custnum' => $self->custnum, } )
7106 Returns all the credits (see L<FS::cust_credit>) for this customer.
7112 map { $_ } #return $self->num_cust_credit unless wantarray;
7113 sort { $a->_date <=> $b->_date }
7114 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
7117 =item cust_credit_pkgnum
7119 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
7120 package when using experimental package balances.
7124 sub cust_credit_pkgnum {
7125 my( $self, $pkgnum ) = @_;
7126 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
7127 sort { $a->_date <=> $b->_date }
7128 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
7129 'pkgnum' => $pkgnum,
7136 Returns all the payments (see L<FS::cust_pay>) for this customer.
7142 return $self->num_cust_pay unless wantarray;
7143 sort { $a->_date <=> $b->_date }
7144 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
7149 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
7150 called automatically when the cust_pay method is used in a scalar context.
7156 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
7157 my $sth = dbh->prepare($sql) or die dbh->errstr;
7158 $sth->execute($self->custnum) or die $sth->errstr;
7159 $sth->fetchrow_arrayref->[0];
7162 =item cust_pay_pkgnum
7164 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
7165 package when using experimental package balances.
7169 sub cust_pay_pkgnum {
7170 my( $self, $pkgnum ) = @_;
7171 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
7172 sort { $a->_date <=> $b->_date }
7173 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
7174 'pkgnum' => $pkgnum,
7181 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
7187 map { $_ } #return $self->num_cust_pay_void unless wantarray;
7188 sort { $a->_date <=> $b->_date }
7189 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
7192 =item cust_pay_batch
7194 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
7198 sub cust_pay_batch {
7200 map { $_ } #return $self->num_cust_pay_batch unless wantarray;
7201 sort { $a->paybatchnum <=> $b->paybatchnum }
7202 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
7205 =item cust_pay_pending
7207 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
7208 (without status "done").
7212 sub cust_pay_pending {
7214 return $self->num_cust_pay_pending unless wantarray;
7215 sort { $a->_date <=> $b->_date }
7216 qsearch( 'cust_pay_pending', {
7217 'custnum' => $self->custnum,
7218 'status' => { op=>'!=', value=>'done' },
7223 =item cust_pay_pending_attempt
7225 Returns all payment attempts / declined payments for this customer, as pending
7226 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
7227 a corresponding payment (see L<FS::cust_pay>).
7231 sub cust_pay_pending_attempt {
7233 return $self->num_cust_pay_pending_attempt unless wantarray;
7234 sort { $a->_date <=> $b->_date }
7235 qsearch( 'cust_pay_pending', {
7236 'custnum' => $self->custnum,
7243 =item num_cust_pay_pending
7245 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
7246 customer (without status "done"). Also called automatically when the
7247 cust_pay_pending method is used in a scalar context.
7251 sub num_cust_pay_pending {
7254 " SELECT COUNT(*) FROM cust_pay_pending ".
7255 " WHERE custnum = ? AND status != 'done' ",
7260 =item num_cust_pay_pending_attempt
7262 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
7263 customer, with status "done" but without a corresp. Also called automatically when the
7264 cust_pay_pending method is used in a scalar context.
7268 sub num_cust_pay_pending_attempt {
7271 " SELECT COUNT(*) FROM cust_pay_pending ".
7272 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
7279 Returns all the refunds (see L<FS::cust_refund>) for this customer.
7285 map { $_ } #return $self->num_cust_refund unless wantarray;
7286 sort { $a->_date <=> $b->_date }
7287 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
7290 =item display_custnum
7292 Returns the displayed customer number for this customer: agent_custid if
7293 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
7297 sub display_custnum {
7299 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
7300 return $self->agent_custid;
7302 return $self->custnum;
7308 Returns a name string for this customer, either "Company (Last, First)" or
7315 my $name = $self->contact;
7316 $name = $self->company. " ($name)" if $self->company;
7322 Returns a name string for this (service/shipping) contact, either
7323 "Company (Last, First)" or "Last, First".
7329 if ( $self->get('ship_last') ) {
7330 my $name = $self->ship_contact;
7331 $name = $self->ship_company. " ($name)" if $self->ship_company;
7340 Returns a name string for this customer, either "Company" or "First Last".
7346 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
7349 =item ship_name_short
7351 Returns a name string for this (service/shipping) contact, either "Company"
7356 sub ship_name_short {
7358 if ( $self->get('ship_last') ) {
7359 $self->ship_company !~ /^\s*$/
7360 ? $self->ship_company
7361 : $self->ship_contact_firstlast;
7363 $self->name_company_or_firstlast;
7369 Returns this customer's full (billing) contact name only, "Last, First"
7375 $self->get('last'). ', '. $self->first;
7380 Returns this customer's full (shipping) contact name only, "Last, First"
7386 $self->get('ship_last')
7387 ? $self->get('ship_last'). ', '. $self->ship_first
7391 =item contact_firstlast
7393 Returns this customers full (billing) contact name only, "First Last".
7397 sub contact_firstlast {
7399 $self->first. ' '. $self->get('last');
7402 =item ship_contact_firstlast
7404 Returns this customer's full (shipping) contact name only, "First Last".
7408 sub ship_contact_firstlast {
7410 $self->get('ship_last')
7411 ? $self->first. ' '. $self->get('ship_last')
7412 : $self->contact_firstlast;
7417 Returns this customer's full country name
7423 code2country($self->country);
7426 =item geocode DATA_VENDOR
7428 Returns a value for the customer location as encoded by DATA_VENDOR.
7429 Currently this only makes sense for "CCH" as DATA_VENDOR.
7434 my ($self, $data_vendor) = (shift, shift); #always cch for now
7436 my $geocode = $self->get('geocode'); #XXX only one data_vendor for geocode
7437 return $geocode if $geocode;
7439 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
7443 my($zip,$plus4) = split /-/, $self->get("${prefix}zip")
7444 if $self->country eq 'US';
7448 #CCH specific location stuff
7449 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
7451 my @cust_tax_location =
7453 'table' => 'cust_tax_location',
7454 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
7455 'extra_sql' => $extra_sql,
7456 'order_by' => 'ORDER BY plus4hi',#overlapping with distinct ends
7459 $geocode = $cust_tax_location[0]->geocode
7460 if scalar(@cust_tax_location);
7469 Returns a status string for this customer, currently:
7473 =item prospect - No packages have ever been ordered
7475 =item ordered - Recurring packages all are new (not yet billed).
7477 =item active - One or more recurring packages is active
7479 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
7481 =item suspended - All non-cancelled recurring packages are suspended
7483 =item cancelled - All recurring packages are cancelled
7489 sub status { shift->cust_status(@_); }
7493 # prospect ordered active inactive suspended cancelled
7494 for my $status ( FS::cust_main->statuses() ) {
7495 my $method = $status.'_sql';
7496 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
7497 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
7498 $sth->execute( ($self->custnum) x $numnum )
7499 or die "Error executing 'SELECT $sql': ". $sth->errstr;
7500 return $status if $sth->fetchrow_arrayref->[0];
7504 =item ucfirst_cust_status
7506 =item ucfirst_status
7508 Returns the status with the first character capitalized.
7512 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
7514 sub ucfirst_cust_status {
7516 ucfirst($self->cust_status);
7521 Returns a hex triplet color string for this customer's status.
7525 use vars qw(%statuscolor);
7526 tie %statuscolor, 'Tie::IxHash',
7527 'prospect' => '7e0079', #'000000', #black? naw, purple
7528 'active' => '00CC00', #green
7529 'ordered' => '009999', #teal? cyan?
7530 'inactive' => '0000CC', #blue
7531 'suspended' => 'FF9900', #yellow
7532 'cancelled' => 'FF0000', #red
7535 sub statuscolor { shift->cust_statuscolor(@_); }
7537 sub cust_statuscolor {
7539 $statuscolor{$self->cust_status};
7544 Returns an array of hashes representing the customer's RT tickets.
7551 my $num = $conf->config('cust_main-max_tickets') || 10;
7554 if ( $conf->config('ticket_system') ) {
7555 unless ( $conf->config('ticket_system-custom_priority_field') ) {
7557 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
7561 foreach my $priority (
7562 $conf->config('ticket_system-custom_priority_field-values'), ''
7564 last if scalar(@tickets) >= $num;
7566 @{ FS::TicketSystem->customer_tickets( $self->custnum,
7567 $num - scalar(@tickets),
7577 # Return services representing svc_accts in customer support packages
7578 sub support_services {
7580 my %packages = map { $_ => 1 } $conf->config('support_packages');
7582 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
7583 grep { $_->part_svc->svcdb eq 'svc_acct' }
7584 map { $_->cust_svc }
7585 grep { exists $packages{ $_->pkgpart } }
7586 $self->ncancelled_pkgs;
7590 # Return a list of latitude/longitude for one of the services (if any)
7591 sub service_coordinates {
7595 grep { $_->latitude && $_->longitude }
7597 map { $_->cust_svc }
7598 $self->ncancelled_pkgs;
7600 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
7605 =head1 CLASS METHODS
7611 Class method that returns the list of possible status strings for customers
7612 (see L<the status method|/status>). For example:
7614 @statuses = FS::cust_main->statuses();
7619 #my $self = shift; #could be class...
7625 Returns an SQL expression identifying prospective cust_main records (customers
7626 with no packages ever ordered)
7630 use vars qw($select_count_pkgs);
7631 $select_count_pkgs =
7632 "SELECT COUNT(*) FROM cust_pkg
7633 WHERE cust_pkg.custnum = cust_main.custnum";
7635 sub select_count_pkgs_sql {
7640 " 0 = ( $select_count_pkgs ) ";
7645 Returns an SQL expression identifying ordered cust_main records (customers with
7646 recurring packages not yet setup).
7651 FS::cust_main->none_active_sql.
7652 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->ordered_sql. " ) ";
7657 Returns an SQL expression identifying active cust_main records (customers with
7658 active recurring packages).
7663 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
7666 =item none_active_sql
7668 Returns an SQL expression identifying cust_main records with no active
7669 recurring packages. This includes customers of status prospect, ordered,
7670 inactive, and suspended.
7674 sub none_active_sql {
7675 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
7680 Returns an SQL expression identifying inactive cust_main records (customers with
7681 no active recurring packages, but otherwise unsuspended/uncancelled).
7686 FS::cust_main->none_active_sql.
7687 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
7693 Returns an SQL expression identifying suspended cust_main records.
7698 sub suspended_sql { susp_sql(@_); }
7700 FS::cust_main->none_active_sql.
7701 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
7707 Returns an SQL expression identifying cancelled cust_main records.
7711 sub cancelled_sql { cancel_sql(@_); }
7714 my $recurring_sql = FS::cust_pkg->recurring_sql;
7715 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
7718 0 < ( $select_count_pkgs )
7719 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
7720 AND 0 = ( $select_count_pkgs AND $recurring_sql
7721 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
7723 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
7729 =item uncancelled_sql
7731 Returns an SQL expression identifying un-cancelled cust_main records.
7735 sub uncancelled_sql { uncancel_sql(@_); }
7736 sub uncancel_sql { "
7737 ( 0 < ( $select_count_pkgs
7738 AND ( cust_pkg.cancel IS NULL
7739 OR cust_pkg.cancel = 0
7742 OR 0 = ( $select_count_pkgs )
7748 Returns an SQL fragment to retreive the balance.
7753 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
7754 WHERE cust_bill.custnum = cust_main.custnum )
7755 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
7756 WHERE cust_pay.custnum = cust_main.custnum )
7757 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
7758 WHERE cust_credit.custnum = cust_main.custnum )
7759 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
7760 WHERE cust_refund.custnum = cust_main.custnum )
7763 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
7765 Returns an SQL fragment to retreive the balance for this customer, optionally
7766 considering invoices with date earlier than START_TIME, and not
7767 later than END_TIME (total_owed_date minus total_unapplied_credits minus
7768 total_unapplied_payments).
7770 Times are specified as SQL fragments or numeric
7771 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
7772 L<Date::Parse> for conversion functions. The empty string can be passed
7773 to disable that time constraint completely.
7775 Available options are:
7779 =item unapplied_date
7781 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)
7786 set to true to remove all customer comparison clauses, for totals
7791 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
7796 JOIN clause (typically used with the total option)
7800 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
7801 time will be ignored. Note that START_TIME and END_TIME only limit the date
7802 range for invoices and I<unapplied> payments, credits, and refunds.
7808 sub balance_date_sql {
7809 my( $class, $start, $end, %opt ) = @_;
7811 my $cutoff = $opt{'cutoff'};
7813 my $owed = FS::cust_bill->owed_sql($cutoff);
7814 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
7815 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
7816 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
7818 my $j = $opt{'join'} || '';
7820 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
7821 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
7822 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
7823 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
7825 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
7826 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
7827 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
7828 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
7833 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
7835 Returns an SQL fragment to retreive the total unapplied payments for this
7836 customer, only considering invoices with date earlier than START_TIME, and
7837 optionally not later than END_TIME.
7839 Times are specified as SQL fragments or numeric
7840 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
7841 L<Date::Parse> for conversion functions. The empty string can be passed
7842 to disable that time constraint completely.
7844 Available options are:
7848 sub unapplied_payments_date_sql {
7849 my( $class, $start, $end, %opt ) = @_;
7851 my $cutoff = $opt{'cutoff'};
7853 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
7855 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
7856 'unapplied_date'=>1 );
7858 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
7861 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
7863 Helper method for balance_date_sql; name (and usage) subject to change
7864 (suggestions welcome).
7866 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
7867 cust_refund, cust_credit or cust_pay).
7869 If TABLE is "cust_bill" or the unapplied_date option is true, only
7870 considers records with date earlier than START_TIME, and optionally not
7871 later than END_TIME .
7875 sub _money_table_where {
7876 my( $class, $table, $start, $end, %opt ) = @_;
7879 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
7880 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
7881 push @where, "$table._date <= $start" if defined($start) && length($start);
7882 push @where, "$table._date > $end" if defined($end) && length($end);
7884 push @where, @{$opt{'where'}} if $opt{'where'};
7885 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
7891 =item search HASHREF
7895 Returns a qsearch hash expression to search for parameters specified in
7896 HASHREF. Valid parameters are
7904 =item cancelled_pkgs
7910 listref of start date, end date
7920 =item current_balance
7922 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
7926 =item flattened_pkgs
7935 my ($class, $params) = @_;
7946 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
7948 "cust_main.agentnum = $1";
7952 # do the same for user
7955 if ( $params->{'usernum'} =~ /^(\d+)$/ and $1 ) {
7957 "cust_main.usernum = $1";
7964 #prospect ordered active inactive suspended cancelled
7965 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
7966 my $method = $params->{'status'}. '_sql';
7967 #push @where, $class->$method();
7968 push @where, FS::cust_main->$method();
7972 # parse cancelled package checkbox
7977 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
7978 unless $params->{'cancelled_pkgs'};
7981 # parse without census tract checkbox
7984 push @where, "(censustract = '' or censustract is null)"
7985 if $params->{'no_censustract'};
7991 foreach my $field (qw( signupdate )) {
7993 next unless exists($params->{$field});
7995 my($beginning, $ending, $hour) = @{$params->{$field}};
7998 "cust_main.$field IS NOT NULL",
7999 "cust_main.$field >= $beginning",
8000 "cust_main.$field <= $ending";
8002 # XXX: do this for mysql and/or pull it out of here
8004 if ($dbh->{Driver}->{Name} eq 'Pg') {
8005 push @where, "extract(hour from to_timestamp(cust_main.$field)) = $hour";
8008 warn "search by time of day not supported on ".$dbh->{Driver}->{Name}." databases";
8012 $orderby ||= "ORDER BY cust_main.$field";
8020 if ( $params->{'classnum'} ) {
8022 my @classnum = ref( $params->{'classnum'} )
8023 ? @{ $params->{'classnum'} }
8024 : ( $params->{'classnum'} );
8026 @classnum = grep /^(\d*)$/, @classnum;
8029 push @where, '( '. join(' OR ', map {
8030 $_ ? "cust_main.classnum = $_"
8031 : "cust_main.classnum IS NULL"
8044 if ( $params->{'payby'} ) {
8046 my @payby = ref( $params->{'payby'} )
8047 ? @{ $params->{'payby'} }
8048 : ( $params->{'payby'} );
8050 @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
8052 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )'
8058 # paydate_year / paydate_month
8061 if ( $params->{'paydate_year'} =~ /^(\d{4})$/ ) {
8063 $params->{'paydate_month'} =~ /^(\d\d?)$/
8064 or die "paydate_year without paydate_month?";
8068 'paydate IS NOT NULL',
8070 "CAST(paydate AS timestamp) < CAST('$year-$month-01' AS timestamp )"
8078 if ( $params->{'invoice_terms'} =~ /^([\w ]+)$/ ) {
8080 if ( $1 eq 'NULL' ) {
8082 "( cust_main.invoice_terms IS NULL OR cust_main.invoice_terms = '' )";
8085 "cust_main.invoice_terms IS NOT NULL",
8086 "cust_main.invoice_terms = '$1'";
8094 if ( $params->{'current_balance'} ) {
8096 #my $balance_sql = $class->balance_sql();
8097 my $balance_sql = FS::cust_main->balance_sql();
8099 my @current_balance =
8100 ref( $params->{'current_balance'} )
8101 ? @{ $params->{'current_balance'} }
8102 : ( $params->{'current_balance'} );
8104 push @where, map { s/current_balance/$balance_sql/; $_ }
8113 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
8115 "cust_main.custbatch = '$1'";
8119 # setup queries, subs, etc. for the search
8122 $orderby ||= 'ORDER BY custnum';
8124 # here is the agent virtualization
8125 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
8127 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
8129 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
8131 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
8133 my $select = join(', ',
8134 'cust_main.custnum',
8135 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
8138 my(@extra_headers) = ();
8139 my(@extra_fields) = ();
8141 if ($params->{'flattened_pkgs'}) {
8143 if ($dbh->{Driver}->{Name} eq 'Pg') {
8145 $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";
8147 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
8148 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
8149 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
8151 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
8152 "omitting packing information from report.";
8155 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";
8157 my $sth = dbh->prepare($header_query) or die dbh->errstr;
8158 $sth->execute() or die $sth->errstr;
8159 my $headerrow = $sth->fetchrow_arrayref;
8160 my $headercount = $headerrow ? $headerrow->[0] : 0;
8161 while($headercount) {
8162 unshift @extra_headers, "Package ". $headercount;
8163 unshift @extra_fields, eval q!sub {my $c = shift;
8164 my @a = split '\|', $c->magic;
8165 my $p = $a[!.--$headercount. q!];
8173 'table' => 'cust_main',
8174 'select' => $select,
8176 'extra_sql' => $extra_sql,
8177 'order_by' => $orderby,
8178 'count_query' => $count_query,
8179 'extra_headers' => \@extra_headers,
8180 'extra_fields' => \@extra_fields,
8185 =item email_search_result HASHREF
8189 Emails a notice to the specified customers.
8191 Valid parameters are those of the L<search> method, plus the following:
8213 Optional job queue job for status updates.
8217 Returns an error message, or false for success.
8219 If an error occurs during any email, stops the enture send and returns that
8220 error. Presumably if you're getting SMTP errors aborting is better than
8221 retrying everything.
8225 sub email_search_result {
8226 my($class, $params) = @_;
8228 my $from = delete $params->{from};
8229 my $subject = delete $params->{subject};
8230 my $html_body = delete $params->{html_body};
8231 my $text_body = delete $params->{text_body};
8234 my $job = delete $params->{'job'}
8235 or die "email_search_result must run from the job queue.\n";
8237 $params->{'payby'} = [ split(/\0/, $params->{'payby'}) ]
8238 unless ref($params->{'payby'});
8240 my $sql_query = $class->search($params);
8242 my $count_query = delete($sql_query->{'count_query'});
8243 my $count_sth = dbh->prepare($count_query)
8244 or die "Error preparing $count_query: ". dbh->errstr;
8246 or die "Error executing $count_query: ". $count_sth->errstr;
8247 my $count_arrayref = $count_sth->fetchrow_arrayref;
8248 my $num_cust = $count_arrayref->[0];
8250 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
8251 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
8254 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
8255 my @retry_jobs = ();
8258 #eventually order+limit magic to reduce memory use?
8259 foreach my $cust_main ( qsearch($sql_query) ) {
8261 #progressbar first, so that the count is right
8263 if ( time - $min_sec > $last ) {
8264 my $error = $job->update_statustext(
8265 int( 100 * $num / $num_cust )
8267 die $error if $error;
8271 my $to = $cust_main->invoicing_list_emailonly_scalar;
8277 'subject' => $subject,
8278 'html_body' => $html_body,
8279 'text_body' => $text_body,
8282 $error = send_email( generate_email( @message ) );
8285 # queue the sending of this message so that the user can see what we
8286 # tried to do, and retry if desired
8287 my $queue = new FS::queue {
8288 'job' => 'FS::Misc::process_send_email',
8289 'custnum' => $cust_main->custnum,
8290 'status' => 'failed',
8291 'statustext' => $error,
8293 $queue->insert(@message);
8294 push @retry_jobs, $queue;
8301 if($success == 0 and
8302 (scalar(@retry_jobs) > 10 or $num == $num_cust)
8304 # 10 is arbitrary, but if we have enough failures, that's
8305 # probably a configuration or network problem, and we
8306 # abort the batch and run away screaming.
8307 # We NEVER do this if anything was successfully sent.
8308 $_->delete foreach (@retry_jobs);
8309 return "multiple failures: '$error'\n";
8314 # fail the job, but with a status message that makes it clear
8315 # something was sent.
8316 return "Sent $success, failed ".scalar(@retry_jobs).". Failed attempts placed in job queue.\n";
8322 sub process_email_search_result {
8324 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
8326 my $param = thaw(decode_base64(shift));
8327 warn Dumper($param) if $DEBUG;
8329 $param->{'job'} = $job;
8331 $param->{'payby'} = [ split(/\0/, $param->{'payby'}) ]
8332 unless ref($param->{'payby'});
8334 my $error = FS::cust_main->email_search_result( $param );
8335 die $error if $error;
8339 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
8341 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
8342 records. Currently, I<first>, I<last>, I<company> and/or I<address1> may be
8343 specified (the appropriate ship_ field is also searched).
8345 Additional options are the same as FS::Record::qsearch
8350 my( $self, $fuzzy, $hash, @opt) = @_;
8355 check_and_rebuild_fuzzyfiles();
8356 foreach my $field ( keys %$fuzzy ) {
8358 my $all = $self->all_X($field);
8359 next unless scalar(@$all);
8362 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
8365 foreach ( keys %match ) {
8366 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
8367 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
8370 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
8373 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
8375 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
8383 Returns a masked version of the named field
8388 my ($self,$field) = @_;
8392 'x'x(length($self->getfield($field))-4).
8393 substr($self->getfield($field), (length($self->getfield($field))-4));
8403 =item smart_search OPTION => VALUE ...
8405 Accepts the following options: I<search>, the string to search for. The string
8406 will be searched for as a customer number, phone number, name or company name,
8407 as an exact, or, in some cases, a substring or fuzzy match (see the source code
8408 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
8409 skip fuzzy matching when an exact match is found.
8411 Any additional options are treated as an additional qualifier on the search
8414 Returns a (possibly empty) array of FS::cust_main objects.
8421 #here is the agent virtualization
8422 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8426 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
8427 my $search = delete $options{'search'};
8428 ( my $alphanum_search = $search ) =~ s/\W//g;
8430 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
8432 #false laziness w/Record::ut_phone
8433 my $phonen = "$1-$2-$3";
8434 $phonen .= " x$4" if $4;
8436 push @cust_main, qsearch( {
8437 'table' => 'cust_main',
8438 'hashref' => { %options },
8439 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8441 join(' OR ', map "$_ = '$phonen'",
8442 qw( daytime night fax
8443 ship_daytime ship_night ship_fax )
8446 " AND $agentnums_sql", #agent virtualization
8449 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
8450 #try looking for matches with extensions unless one was specified
8452 push @cust_main, qsearch( {
8453 'table' => 'cust_main',
8454 'hashref' => { %options },
8455 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8457 join(' OR ', map "$_ LIKE '$phonen\%'",
8459 ship_daytime ship_night )
8462 " AND $agentnums_sql", #agent virtualization
8467 # custnum search (also try agent_custid), with some tweaking options if your
8468 # legacy cust "numbers" have letters
8471 if ( $search =~ /^\s*(\d+)\s*$/
8472 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
8473 && $search =~ /^\s*(\w\w?\d+)\s*$/
8475 || ( $conf->exists('address1-search' )
8476 && $search =~ /^\s*(\d+\-?\w*)\s*$/ #i.e. 1234A or 9432-D
8483 if ( $num =~ /^(\d+)$/ && $num <= 2147483647 ) { #need a bigint custnum? wow
8484 push @cust_main, qsearch( {
8485 'table' => 'cust_main',
8486 'hashref' => { 'custnum' => $num, %options },
8487 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8491 push @cust_main, qsearch( {
8492 'table' => 'cust_main',
8493 'hashref' => { 'agent_custid' => $num, %options },
8494 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8497 if ( $conf->exists('address1-search') ) {
8498 my $len = length($num);
8500 foreach my $prefix ( '', 'ship_' ) {
8501 push @cust_main, qsearch( {
8502 'table' => 'cust_main',
8503 'hashref' => { %options, },
8505 ( keys(%options) ? ' AND ' : ' WHERE ' ).
8506 " LOWER(SUBSTRING(${prefix}address1 FROM 1 FOR $len)) = '$num' ".
8507 " AND $agentnums_sql",
8512 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
8514 my($company, $last, $first) = ( $1, $2, $3 );
8516 # "Company (Last, First)"
8517 #this is probably something a browser remembered,
8518 #so just do an exact search (but case-insensitive, so USPS standardization
8519 #doesn't throw a wrench in the works)
8521 foreach my $prefix ( '', 'ship_' ) {
8522 push @cust_main, qsearch( {
8523 'table' => 'cust_main',
8524 'hashref' => { %options },
8526 ( keys(%options) ? ' AND ' : ' WHERE ' ).
8528 " LOWER(${prefix}first) = ". dbh->quote(lc($first)),
8529 " LOWER(${prefix}last) = ". dbh->quote(lc($last)),
8530 " LOWER(${prefix}company) = ". dbh->quote(lc($company)),
8536 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
8537 # try (ship_){last,company}
8541 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
8542 # # full strings the browser remembers won't work
8543 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
8545 use Lingua::EN::NameParse;
8546 my $NameParse = new Lingua::EN::NameParse(
8548 allow_reversed => 1,
8551 my($last, $first) = ( '', '' );
8552 #maybe disable this too and just rely on NameParse?
8553 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
8555 ($last, $first) = ( $1, $2 );
8557 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
8558 } elsif ( ! $NameParse->parse($value) ) {
8560 my %name = $NameParse->components;
8561 $first = $name{'given_name_1'};
8562 $last = $name{'surname_1'};
8566 if ( $first && $last ) {
8568 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
8571 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8573 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
8574 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
8577 push @cust_main, qsearch( {
8578 'table' => 'cust_main',
8579 'hashref' => \%options,
8580 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8583 # or it just be something that was typed in... (try that in a sec)
8587 my $q_value = dbh->quote($value);
8590 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8591 $sql .= " ( LOWER(last) = $q_value
8592 OR LOWER(company) = $q_value
8593 OR LOWER(ship_last) = $q_value
8594 OR LOWER(ship_company) = $q_value
8596 $sql .= " OR LOWER(address1) = $q_value
8597 OR LOWER(ship_address1) = $q_value
8599 if $conf->exists('address1-search');
8602 push @cust_main, qsearch( {
8603 'table' => 'cust_main',
8604 'hashref' => \%options,
8605 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8608 #no exact match, trying substring/fuzzy
8609 #always do substring & fuzzy (unless they're explicity config'ed off)
8610 #getting complaints searches are not returning enough
8611 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
8613 #still some false laziness w/search (was search/cust_main.cgi)
8618 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
8619 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
8622 if ( $first && $last ) {
8625 { 'first' => { op=>'ILIKE', value=>"%$first%" },
8626 'last' => { op=>'ILIKE', value=>"%$last%" },
8628 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
8629 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
8636 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
8637 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
8641 if ( $conf->exists('address1-search') ) {
8643 { 'address1' => { op=>'ILIKE', value=>"%$value%" }, },
8644 { 'ship_address1' => { op=>'ILIKE', value=>"%$value%" }, },
8648 foreach my $hashref ( @hashrefs ) {
8650 push @cust_main, qsearch( {
8651 'table' => 'cust_main',
8652 'hashref' => { %$hashref,
8655 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
8664 " AND $agentnums_sql", #extra_sql #agent virtualization
8667 if ( $first && $last ) {
8668 push @cust_main, FS::cust_main->fuzzy_search(
8669 { 'last' => $last, #fuzzy hashref
8670 'first' => $first }, #
8674 foreach my $field ( 'last', 'company' ) {
8676 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
8678 if ( $conf->exists('address1-search') ) {
8680 FS::cust_main->fuzzy_search( { 'address1' => $value }, @fuzopts );
8687 #eliminate duplicates
8689 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8697 Accepts the following options: I<email>, the email address to search for. The
8698 email address will be searched for as an email invoice destination and as an
8701 #Any additional options are treated as an additional qualifier on the search
8702 #(i.e. I<agentnum>).
8704 Returns a (possibly empty) array of FS::cust_main objects (but usually just
8714 my $email = delete $options{'email'};
8716 #we're only being used by RT at the moment... no agent virtualization yet
8717 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8721 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
8723 my ( $user, $domain ) = ( $1, $2 );
8725 warn "$me smart_search: searching for $user in domain $domain"
8731 'table' => 'cust_main_invoice',
8732 'hashref' => { 'dest' => $email },
8739 map $_->cust_svc->cust_pkg,
8741 'table' => 'svc_acct',
8742 'hashref' => { 'username' => $user, },
8744 'AND ( SELECT domain FROM svc_domain
8745 WHERE svc_acct.domsvc = svc_domain.svcnum
8746 ) = '. dbh->quote($domain),
8752 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8754 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
8761 =item check_and_rebuild_fuzzyfiles
8765 sub check_and_rebuild_fuzzyfiles {
8766 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8767 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
8770 =item rebuild_fuzzyfiles
8774 sub rebuild_fuzzyfiles {
8776 use Fcntl qw(:flock);
8778 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8779 mkdir $dir, 0700 unless -d $dir;
8781 foreach my $fuzzy ( @fuzzyfields ) {
8783 open(LOCK,">>$dir/cust_main.$fuzzy")
8784 or die "can't open $dir/cust_main.$fuzzy: $!";
8786 or die "can't lock $dir/cust_main.$fuzzy: $!";
8788 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
8789 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
8791 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
8792 my $sth = dbh->prepare("SELECT $field FROM cust_main".
8793 " WHERE $field != '' AND $field IS NOT NULL");
8794 $sth->execute or die $sth->errstr;
8796 while ( my $row = $sth->fetchrow_arrayref ) {
8797 print CACHE $row->[0]. "\n";
8802 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
8804 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
8815 my( $self, $field ) = @_;
8816 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8817 open(CACHE,"<$dir/cust_main.$field")
8818 or die "can't open $dir/cust_main.$field: $!";
8819 my @array = map { chomp; $_; } <CACHE>;
8824 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
8828 sub append_fuzzyfiles {
8829 #my( $first, $last, $company ) = @_;
8831 &check_and_rebuild_fuzzyfiles;
8833 use Fcntl qw(:flock);
8835 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8837 foreach my $field (@fuzzyfields) {
8842 open(CACHE,">>$dir/cust_main.$field")
8843 or die "can't open $dir/cust_main.$field: $!";
8844 flock(CACHE,LOCK_EX)
8845 or die "can't lock $dir/cust_main.$field: $!";
8847 print CACHE "$value\n";
8849 flock(CACHE,LOCK_UN)
8850 or die "can't unlock $dir/cust_main.$field: $!";
8865 #warn join('-',keys %$param);
8866 my $fh = $param->{filehandle};
8867 my @fields = @{$param->{fields}};
8869 eval "use Text::CSV_XS;";
8872 my $csv = new Text::CSV_XS;
8879 local $SIG{HUP} = 'IGNORE';
8880 local $SIG{INT} = 'IGNORE';
8881 local $SIG{QUIT} = 'IGNORE';
8882 local $SIG{TERM} = 'IGNORE';
8883 local $SIG{TSTP} = 'IGNORE';
8884 local $SIG{PIPE} = 'IGNORE';
8886 my $oldAutoCommit = $FS::UID::AutoCommit;
8887 local $FS::UID::AutoCommit = 0;
8890 #while ( $columns = $csv->getline($fh) ) {
8892 while ( defined($line=<$fh>) ) {
8894 $csv->parse($line) or do {
8895 $dbh->rollback if $oldAutoCommit;
8896 return "can't parse: ". $csv->error_input();
8899 my @columns = $csv->fields();
8900 #warn join('-',@columns);
8903 foreach my $field ( @fields ) {
8904 $row{$field} = shift @columns;
8907 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
8908 unless ( $cust_main ) {
8909 $dbh->rollback if $oldAutoCommit;
8910 return "unknown custnum $row{'custnum'}";
8913 if ( $row{'amount'} > 0 ) {
8914 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
8916 $dbh->rollback if $oldAutoCommit;
8920 } elsif ( $row{'amount'} < 0 ) {
8921 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
8924 $dbh->rollback if $oldAutoCommit;
8934 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
8936 return "Empty file!" unless $imported;
8942 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
8944 Deprecated. Use event notification and message templates
8945 (L<FS::msg_template>) instead.
8947 Sends a templated email notification to the customer (see L<Text::Template>).
8949 OPTIONS is a hash and may include
8951 I<from> - the email sender (default is invoice_from)
8953 I<to> - comma-separated scalar or arrayref of recipients
8954 (default is invoicing_list)
8956 I<subject> - The subject line of the sent email notification
8957 (default is "Notice from company_name")
8959 I<extra_fields> - a hashref of name/value pairs which will be substituted
8962 The following variables are vavailable in the template.
8964 I<$first> - the customer first name
8965 I<$last> - the customer last name
8966 I<$company> - the customer company
8967 I<$payby> - a description of the method of payment for the customer
8968 # would be nice to use FS::payby::shortname
8969 I<$payinfo> - the account information used to collect for this customer
8970 I<$expdate> - the expiration of the customer payment in seconds from epoch
8975 my ($self, $template, %options) = @_;
8977 return unless $conf->exists($template);
8979 my $from = $conf->config('invoice_from', $self->agentnum)
8980 if $conf->exists('invoice_from', $self->agentnum);
8981 $from = $options{from} if exists($options{from});
8983 my $to = join(',', $self->invoicing_list_emailonly);
8984 $to = $options{to} if exists($options{to});
8986 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
8987 if $conf->exists('company_name', $self->agentnum);
8988 $subject = $options{subject} if exists($options{subject});
8990 my $notify_template = new Text::Template (TYPE => 'ARRAY',
8991 SOURCE => [ map "$_\n",
8992 $conf->config($template)]
8994 or die "can't create new Text::Template object: Text::Template::ERROR";
8995 $notify_template->compile()
8996 or die "can't compile template: Text::Template::ERROR";
8998 $FS::notify_template::_template::company_name =
8999 $conf->config('company_name', $self->agentnum);
9000 $FS::notify_template::_template::company_address =
9001 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
9003 my $paydate = $self->paydate || '2037-12-31';
9004 $FS::notify_template::_template::first = $self->first;
9005 $FS::notify_template::_template::last = $self->last;
9006 $FS::notify_template::_template::company = $self->company;
9007 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
9008 my $payby = $self->payby;
9009 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9010 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9012 #credit cards expire at the end of the month/year of their exp date
9013 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9014 $FS::notify_template::_template::payby = 'credit card';
9015 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9016 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9018 }elsif ($payby eq 'COMP') {
9019 $FS::notify_template::_template::payby = 'complimentary account';
9021 $FS::notify_template::_template::payby = 'current method';
9023 $FS::notify_template::_template::expdate = $expire_time;
9025 for (keys %{$options{extra_fields}}){
9027 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
9030 send_email(from => $from,
9032 subject => $subject,
9033 body => $notify_template->fill_in( PACKAGE =>
9034 'FS::notify_template::_template' ),
9039 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9041 Generates a templated notification to the customer (see L<Text::Template>).
9043 OPTIONS is a hash and may include
9045 I<extra_fields> - a hashref of name/value pairs which will be substituted
9046 into the template. These values may override values mentioned below
9047 and those from the customer record.
9049 The following variables are available in the template instead of or in addition
9050 to the fields of the customer record.
9052 I<$payby> - a description of the method of payment for the customer
9053 # would be nice to use FS::payby::shortname
9054 I<$payinfo> - the masked account information used to collect for this customer
9055 I<$expdate> - the expiration of the customer payment method in seconds from epoch
9056 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
9060 # a lot like cust_bill::print_latex
9061 sub generate_letter {
9062 my ($self, $template, %options) = @_;
9064 return unless $conf->exists($template);
9066 my $letter_template = new Text::Template
9068 SOURCE => [ map "$_\n", $conf->config($template)],
9069 DELIMITERS => [ '[@--', '--@]' ],
9071 or die "can't create new Text::Template object: Text::Template::ERROR";
9073 $letter_template->compile()
9074 or die "can't compile template: Text::Template::ERROR";
9076 my %letter_data = map { $_ => $self->$_ } $self->fields;
9077 $letter_data{payinfo} = $self->mask_payinfo;
9079 #my $paydate = $self->paydate || '2037-12-31';
9080 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
9082 my $payby = $self->payby;
9083 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9084 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9086 #credit cards expire at the end of the month/year of their exp date
9087 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9088 $letter_data{payby} = 'credit card';
9089 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9090 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9092 }elsif ($payby eq 'COMP') {
9093 $letter_data{payby} = 'complimentary account';
9095 $letter_data{payby} = 'current method';
9097 $letter_data{expdate} = $expire_time;
9099 for (keys %{$options{extra_fields}}){
9100 $letter_data{$_} = $options{extra_fields}->{$_};
9103 unless(exists($letter_data{returnaddress})){
9104 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
9105 $self->agent_template)
9107 if ( length($retadd) ) {
9108 $letter_data{returnaddress} = $retadd;
9109 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
9110 $letter_data{returnaddress} =
9111 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
9115 ( $conf->config('company_name', $self->agentnum),
9116 $conf->config('company_address', $self->agentnum),
9120 $letter_data{returnaddress} = '~';
9124 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
9126 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
9128 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
9130 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
9134 ) or die "can't open temp file: $!\n";
9135 print $lh $conf->config_binary('logo.eps', $self->agentnum)
9136 or die "can't write temp file: $!\n";
9138 $letter_data{'logo_file'} = $lh->filename;
9140 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
9144 ) or die "can't open temp file: $!\n";
9146 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
9148 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
9149 return ($1, $letter_data{'logo_file'});
9153 =item print_ps TEMPLATE
9155 Returns an postscript letter filled in from TEMPLATE, as a scalar.
9161 my($file, $lfile) = $self->generate_letter(@_);
9162 my $ps = FS::Misc::generate_ps($file);
9163 unlink($file.'.tex');
9169 =item print TEMPLATE
9171 Prints the filled in template.
9173 TEMPLATE is the name of a L<Text::Template> to fill in and print.
9177 sub queueable_print {
9180 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
9181 or die "invalid customer number: " . $opt{custvnum};
9183 my $error = $self->print( $opt{template} );
9184 die $error if $error;
9188 my ($self, $template) = (shift, shift);
9189 do_print [ $self->print_ps($template) ];
9192 #these three subs should just go away once agent stuff is all config overrides
9194 sub agent_template {
9196 $self->_agent_plandata('agent_templatename');
9199 sub agent_invoice_from {
9201 $self->_agent_plandata('agent_invoice_from');
9204 sub _agent_plandata {
9205 my( $self, $option ) = @_;
9207 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
9208 #agent-specific Conf
9210 use FS::part_event::Condition;
9212 my $agentnum = $self->agentnum;
9214 my $regexp = regexp_sql();
9216 my $part_event_option =
9218 'select' => 'part_event_option.*',
9219 'table' => 'part_event_option',
9221 LEFT JOIN part_event USING ( eventpart )
9222 LEFT JOIN part_event_option AS peo_agentnum
9223 ON ( part_event.eventpart = peo_agentnum.eventpart
9224 AND peo_agentnum.optionname = 'agentnum'
9225 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
9227 LEFT JOIN part_event_condition
9228 ON ( part_event.eventpart = part_event_condition.eventpart
9229 AND part_event_condition.conditionname = 'cust_bill_age'
9231 LEFT JOIN part_event_condition_option
9232 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
9233 AND part_event_condition_option.optionname = 'age'
9236 #'hashref' => { 'optionname' => $option },
9237 #'hashref' => { 'part_event_option.optionname' => $option },
9239 " WHERE part_event_option.optionname = ". dbh->quote($option).
9240 " AND action = 'cust_bill_send_agent' ".
9241 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
9242 " AND peo_agentnum.optionname = 'agentnum' ".
9243 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
9245 CASE WHEN part_event_condition_option.optionname IS NULL
9247 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
9249 , part_event.weight".
9253 unless ( $part_event_option ) {
9254 return $self->agent->invoice_template || ''
9255 if $option eq 'agent_templatename';
9259 $part_event_option->optionvalue;
9263 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
9265 Subroutine (not a method), designed to be called from the queue.
9267 Takes a list of options and values.
9269 Pulls up the customer record via the custnum option and calls bill_and_collect.
9274 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
9276 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
9277 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
9279 $cust_main->bill_and_collect( %args );
9282 sub process_bill_and_collect {
9284 my $param = thaw(decode_base64(shift));
9285 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
9286 or die "custnum '$param->{custnum}' not found!\n";
9287 $param->{'job'} = $job;
9288 $param->{'fatal'} = 1; # runs from job queue, will be caught
9289 $param->{'retry'} = 1;
9291 $cust_main->bill_and_collect( %$param );
9294 sub _upgrade_data { #class method
9295 my ($class, %opts) = @_;
9297 my $sql = 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL';
9298 my $sth = dbh->prepare($sql) or die dbh->errstr;
9299 $sth->execute or die $sth->errstr;
9301 local($ignore_expired_card) = 1;
9302 local($skip_fuzzyfiles) = 1;
9303 $class->_upgrade_otaker(%opts);
9313 The delete method should possibly take an FS::cust_main object reference
9314 instead of a scalar customer number.
9316 Bill and collect options should probably be passed as references instead of a
9319 There should probably be a configuration file with a list of allowed credit
9322 No multiple currency support (probably a larger project than just this module).
9324 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
9326 Birthdates rely on negative epoch values.
9328 The payby for card/check batches is broken. With mixed batching, bad
9331 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
9335 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
9336 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
9337 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.