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);
39 use FS::cust_bill_pkg;
40 use FS::cust_bill_pkg_display;
41 use FS::cust_bill_pkg_tax_location;
42 use FS::cust_bill_pkg_tax_rate_location;
44 use FS::cust_pay_pending;
45 use FS::cust_pay_void;
46 use FS::cust_pay_batch;
49 use FS::part_referral;
50 use FS::cust_main_county;
51 use FS::cust_location;
53 use FS::cust_main_exemption;
54 use FS::cust_tax_adjustment;
56 use FS::tax_rate_location;
57 use FS::cust_tax_location;
58 use FS::part_pkg_taxrate;
60 use FS::cust_main_invoice;
62 use FS::cust_credit_bill;
63 use FS::cust_bill_pay;
64 use FS::prepay_credit;
68 use FS::part_event_condition;
72 use FS::payment_gateway;
73 use FS::agent_payment_gateway;
77 @EXPORT_OK = qw( smart_search );
79 $realtime_bop_decline_quiet = 0;
81 # 1 is mostly method/subroutine entry and options
82 # 2 traces progress of some operations
83 # 3 is even more information including possibly sensitive data
85 $me = '[FS::cust_main]';
88 $ignore_expired_card = 0;
91 @fuzzyfields = ( 'first', 'last', 'company', 'address1' );
93 @encrypted_fields = ('payinfo', 'paycvv');
94 sub nohistory_fields { ('payinfo', 'paycvv'); }
96 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
98 #ask FS::UID to run this stuff for us later
99 #$FS::UID::callback{'FS::cust_main'} = sub {
100 install_callback FS::UID sub {
101 $conf = new FS::Conf;
102 #yes, need it for stuff below (prolly should be cached)
107 my ( $hashref, $cache ) = @_;
108 if ( exists $hashref->{'pkgnum'} ) {
109 #@{ $self->{'_pkgnum'} } = ();
110 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
111 $self->{'_pkgnum'} = $subcache;
112 #push @{ $self->{'_pkgnum'} },
113 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
119 FS::cust_main - Object methods for cust_main records
125 $record = new FS::cust_main \%hash;
126 $record = new FS::cust_main { 'column' => 'value' };
128 $error = $record->insert;
130 $error = $new_record->replace($old_record);
132 $error = $record->delete;
134 $error = $record->check;
136 @cust_pkg = $record->all_pkgs;
138 @cust_pkg = $record->ncancelled_pkgs;
140 @cust_pkg = $record->suspended_pkgs;
142 $error = $record->bill;
143 $error = $record->bill %options;
144 $error = $record->bill 'time' => $time;
146 $error = $record->collect;
147 $error = $record->collect %options;
148 $error = $record->collect 'invoice_time' => $time,
153 An FS::cust_main object represents a customer. FS::cust_main inherits from
154 FS::Record. The following fields are currently supported:
160 Primary key (assigned automatically for new customers)
164 Agent (see L<FS::agent>)
168 Advertising source (see L<FS::part_referral>)
180 Cocial security number (optional)
196 (optional, see L<FS::cust_main_county>)
200 (see L<FS::cust_main_county>)
206 (see L<FS::cust_main_county>)
242 (optional, see L<FS::cust_main_county>)
246 (see L<FS::cust_main_county>)
252 (see L<FS::cust_main_county>)
268 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
272 Payment Information (See L<FS::payinfo_Mixin> for data format)
276 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
280 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
284 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
288 Start date month (maestro/solo cards only)
292 Start date year (maestro/solo cards only)
296 Issue number (maestro/solo cards only)
300 Name on card or billing name
304 IP address from which payment information was received
308 Tax exempt, empty or `Y'
312 Order taker (see L<FS::access_user>)
318 =item referral_custnum
320 Referring customer number
324 Enable individual CDR spooling, empty or `Y'
328 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
332 Discourage individual CDR printing, empty or `Y'
342 Creates a new customer. To add the customer to the database, see L<"insert">.
344 Note that this stores the hash reference, not a distinct copy of the hash it
345 points to. You can ask the object for a copy with the I<hash> method.
349 sub table { 'cust_main'; }
351 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
353 Adds this customer to the database. If there is an error, returns the error,
354 otherwise returns false.
356 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
357 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
358 are inserted atomicly, or the transaction is rolled back. Passing an empty
359 hash reference is equivalent to not supplying this parameter. There should be
360 a better explanation of this, but until then, here's an example:
363 tie %hash, 'Tie::RefHash'; #this part is important
365 $cust_pkg => [ $svc_acct ],
368 $cust_main->insert( \%hash );
370 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
371 be set as the invoicing list (see L<"invoicing_list">). Errors return as
372 expected and rollback the entire transaction; it is not necessary to call
373 check_invoicing_list first. The invoicing_list is set after the records in the
374 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
375 invoicing_list destination to the newly-created svc_acct. Here's an example:
377 $cust_main->insert( {}, [ $email, 'POST' ] );
379 Currently available options are: I<depend_jobnum>, I<noexport> and I<tax_exemption>.
381 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
382 on the supplied jobnum (they will not run until the specific job completes).
383 This can be used to defer provisioning until some action completes (such
384 as running the customer's credit card successfully).
386 The I<noexport> option is deprecated. If I<noexport> is set true, no
387 provisioning jobs (exports) are scheduled. (You can schedule them later with
388 the B<reexport> method.)
390 The I<tax_exemption> option can be set to an arrayref of tax names.
391 FS::cust_main_exemption records will be created and inserted.
397 my $cust_pkgs = @_ ? shift : {};
398 my $invoicing_list = @_ ? shift : '';
400 warn "$me insert called with options ".
401 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
404 local $SIG{HUP} = 'IGNORE';
405 local $SIG{INT} = 'IGNORE';
406 local $SIG{QUIT} = 'IGNORE';
407 local $SIG{TERM} = 'IGNORE';
408 local $SIG{TSTP} = 'IGNORE';
409 local $SIG{PIPE} = 'IGNORE';
411 my $oldAutoCommit = $FS::UID::AutoCommit;
412 local $FS::UID::AutoCommit = 0;
415 my $prepay_identifier = '';
416 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
418 if ( $self->payby eq 'PREPAY' ) {
420 $self->payby('BILL');
421 $prepay_identifier = $self->payinfo;
424 warn " looking up prepaid card $prepay_identifier\n"
427 my $error = $self->get_prepay( $prepay_identifier,
428 'amount_ref' => \$amount,
429 'seconds_ref' => \$seconds,
430 'upbytes_ref' => \$upbytes,
431 'downbytes_ref' => \$downbytes,
432 'totalbytes_ref' => \$totalbytes,
435 $dbh->rollback if $oldAutoCommit;
436 #return "error applying prepaid card (transaction rolled back): $error";
440 $payby = 'PREP' if $amount;
442 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
445 $self->payby('BILL');
446 $amount = $self->paid;
450 warn " inserting $self\n"
453 $self->signupdate(time) unless $self->signupdate;
455 $self->auto_agent_custid()
456 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
458 my $error = $self->SUPER::insert;
460 $dbh->rollback if $oldAutoCommit;
461 #return "inserting cust_main record (transaction rolled back): $error";
465 warn " setting invoicing list\n"
468 if ( $invoicing_list ) {
469 $error = $self->check_invoicing_list( $invoicing_list );
471 $dbh->rollback if $oldAutoCommit;
472 #return "checking invoicing_list (transaction rolled back): $error";
475 $self->invoicing_list( $invoicing_list );
478 warn " setting customer tags\n"
481 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
482 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
483 'custnum' => $self->custnum };
484 my $error = $cust_tag->insert;
486 $dbh->rollback if $oldAutoCommit;
491 if ( $invoicing_list ) {
492 $error = $self->check_invoicing_list( $invoicing_list );
494 $dbh->rollback if $oldAutoCommit;
495 #return "checking invoicing_list (transaction rolled back): $error";
498 $self->invoicing_list( $invoicing_list );
502 warn " setting cust_main_exemption\n"
505 my $tax_exemption = delete $options{'tax_exemption'};
506 if ( $tax_exemption ) {
507 foreach my $taxname ( @$tax_exemption ) {
508 my $cust_main_exemption = new FS::cust_main_exemption {
509 'custnum' => $self->custnum,
510 'taxname' => $taxname,
512 my $error = $cust_main_exemption->insert;
514 $dbh->rollback if $oldAutoCommit;
515 return "inserting cust_main_exemption (transaction rolled back): $error";
520 if ( $conf->config('cust_main-skeleton_tables')
521 && $conf->config('cust_main-skeleton_custnum') ) {
523 warn " inserting skeleton records\n"
526 my $error = $self->start_copy_skel;
528 $dbh->rollback if $oldAutoCommit;
534 warn " ordering packages\n"
537 $error = $self->order_pkgs( $cust_pkgs,
539 'seconds_ref' => \$seconds,
540 'upbytes_ref' => \$upbytes,
541 'downbytes_ref' => \$downbytes,
542 'totalbytes_ref' => \$totalbytes,
545 $dbh->rollback if $oldAutoCommit;
550 $dbh->rollback if $oldAutoCommit;
551 return "No svc_acct record to apply pre-paid time";
553 if ( $upbytes || $downbytes || $totalbytes ) {
554 $dbh->rollback if $oldAutoCommit;
555 return "No svc_acct record to apply pre-paid data";
559 warn " inserting initial $payby payment of $amount\n"
561 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
563 $dbh->rollback if $oldAutoCommit;
564 return "inserting payment (transaction rolled back): $error";
568 unless ( $import || $skip_fuzzyfiles ) {
569 warn " queueing fuzzyfiles update\n"
571 $error = $self->queue_fuzzyfiles_update;
573 $dbh->rollback if $oldAutoCommit;
574 return "updating fuzzy search cache: $error";
579 warn " exporting\n" if $DEBUG > 1;
581 my $export_args = $options{'export_args'} || [];
584 map qsearch( 'part_export', {exportnum=>$_} ),
585 $conf->config('cust_main-exports'); #, $agentnum
587 foreach my $part_export ( @part_export ) {
588 my $error = $part_export->export_insert($self, @$export_args);
590 $dbh->rollback if $oldAutoCommit;
591 return "exporting to ". $part_export->exporttype.
592 " (transaction rolled back): $error";
596 #foreach my $depend_jobnum ( @$depend_jobnums ) {
597 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
599 # foreach my $jobnum ( @jobnums ) {
600 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
601 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
603 # my $error = $queue->depend_insert($depend_jobnum);
605 # $dbh->rollback if $oldAutoCommit;
606 # return "error queuing job dependancy: $error";
613 #if ( exists $options{'jobnums'} ) {
614 # push @{ $options{'jobnums'} }, @jobnums;
617 warn " insert complete; committing transaction\n"
620 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
625 use File::CounterFile;
626 sub auto_agent_custid {
629 my $format = $conf->config('cust_main-auto_agent_custid');
631 if ( $format eq '1YMMXXXXXXXX' ) {
633 my $counter = new File::CounterFile 'cust_main.agent_custid';
636 my $ym = 100000000000 + time2str('%y%m00000000', time);
637 if ( $ym > $counter->value ) {
638 $counter->{'value'} = $agent_custid = $ym;
639 $counter->{'updated'} = 1;
641 $agent_custid = $counter->inc;
647 die "Unknown cust_main-auto_agent_custid format: $format";
650 $self->agent_custid($agent_custid);
654 sub start_copy_skel {
657 #'mg_user_preference' => {},
658 #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
659 #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
660 #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
661 #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
662 my @tables = eval(join('\n',$conf->config('cust_main-skeleton_tables')));
665 _copy_skel( 'cust_main', #tablename
666 $conf->config('cust_main-skeleton_custnum'), #sourceid
667 $self->custnum, #destid
668 @tables, #child tables
672 #recursive subroutine, not a method
674 my( $table, $sourceid, $destid, %child_tables ) = @_;
677 if ( $table =~ /^(\w+)\.(\w+)$/ ) {
678 ( $table, $primary_key ) = ( $1, $2 );
680 my $dbdef_table = dbdef->table($table);
681 $primary_key = $dbdef_table->primary_key
682 or return "$table has no primary key".
683 " (or do you need to run dbdef-create?)";
686 warn " _copy_skel: $table.$primary_key $sourceid to $destid for ".
687 join (', ', keys %child_tables). "\n"
690 foreach my $child_table_def ( keys %child_tables ) {
694 if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
695 ( $child_table, $child_pkey ) = ( $1, $2 );
697 $child_table = $child_table_def;
699 $child_pkey = dbdef->table($child_table)->primary_key;
700 # or return "$table has no primary key".
701 # " (or do you need to run dbdef-create?)\n";
705 if ( keys %{ $child_tables{$child_table_def} } ) {
707 return "$child_table has no primary key".
708 " (run dbdef-create or try specifying it?)\n"
711 #false laziness w/Record::insert and only works on Pg
712 #refactor the proper last-inserted-id stuff out of Record::insert if this
713 # ever gets use for anything besides a quick kludge for one customer
714 my $default = dbdef->table($child_table)->column($child_pkey)->default;
715 $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
716 or return "can't parse $child_table.$child_pkey default value ".
717 " for sequence name: $default";
722 my @sel_columns = grep { $_ ne $primary_key }
723 dbdef->table($child_table)->columns;
724 my $sel_columns = join(', ', @sel_columns );
726 my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
727 my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
728 my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
730 my $sel_st = "SELECT $sel_columns FROM $child_table".
731 " WHERE $primary_key = $sourceid";
734 my $sel_sth = dbh->prepare( $sel_st )
735 or return dbh->errstr;
737 $sel_sth->execute or return $sel_sth->errstr;
739 while ( my $row = $sel_sth->fetchrow_hashref ) {
741 warn " selected row: ".
742 join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
746 "INSERT INTO $child_table $ins_columns VALUES $placeholders";
747 my $ins_sth =dbh->prepare($statement)
748 or return dbh->errstr;
749 my @param = ( $destid, map $row->{$_}, @ins_columns );
750 warn " $statement: [ ". join(', ', @param). " ]\n"
752 $ins_sth->execute( @param )
753 or return $ins_sth->errstr;
755 #next unless keys %{ $child_tables{$child_table} };
756 next unless $sequence;
758 #another section of that laziness
759 my $seq_sql = "SELECT currval('$sequence')";
760 my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
761 $seq_sth->execute or return $seq_sth->errstr;
762 my $insertid = $seq_sth->fetchrow_arrayref->[0];
764 # don't drink soap! recurse! recurse! okay!
766 _copy_skel( $child_table_def,
767 $row->{$child_pkey}, #sourceid
769 %{ $child_tables{$child_table_def} },
771 return $error if $error;
781 =item order_pkg HASHREF | OPTION => VALUE ...
783 Orders a single package.
785 Options may be passed as a list of key/value pairs or as a hash reference.
796 Optional FS::cust_location object
800 Optional arryaref of FS::svc_* service objects.
804 If this option is set to a job queue jobnum (see L<FS::queue>), all provisioning
805 jobs will have a dependancy on the supplied job (they will not run until the
806 specific job completes). This can be used to defer provisioning until some
807 action completes (such as running the customer's credit card successfully).
811 Optional subject for a ticket created and attached to this customer
815 Optional queue name for ticket additions
823 my $opt = ref($_[0]) ? shift : { @_ };
825 warn "$me order_pkg called with options ".
826 join(', ', map { "$_: $opt->{$_}" } keys %$opt ). "\n"
829 my $cust_pkg = $opt->{'cust_pkg'};
830 my $svcs = $opt->{'svcs'} || [];
832 my %svc_options = ();
833 $svc_options{'depend_jobnum'} = $opt->{'depend_jobnum'}
834 if exists($opt->{'depend_jobnum'}) && $opt->{'depend_jobnum'};
836 my %insert_params = map { $opt->{$_} ? ( $_ => $opt->{$_} ) : () }
837 qw( ticket_subject ticket_queue );
839 local $SIG{HUP} = 'IGNORE';
840 local $SIG{INT} = 'IGNORE';
841 local $SIG{QUIT} = 'IGNORE';
842 local $SIG{TERM} = 'IGNORE';
843 local $SIG{TSTP} = 'IGNORE';
844 local $SIG{PIPE} = 'IGNORE';
846 my $oldAutoCommit = $FS::UID::AutoCommit;
847 local $FS::UID::AutoCommit = 0;
850 if ( $opt->{'cust_location'} &&
851 ( ! $cust_pkg->locationnum || $cust_pkg->locationnum == -1 ) ) {
852 my $error = $opt->{'cust_location'}->insert;
854 $dbh->rollback if $oldAutoCommit;
855 return "inserting cust_location (transaction rolled back): $error";
857 $cust_pkg->locationnum($opt->{'cust_location'}->locationnum);
860 $cust_pkg->custnum( $self->custnum );
862 my $error = $cust_pkg->insert( %insert_params );
864 $dbh->rollback if $oldAutoCommit;
865 return "inserting cust_pkg (transaction rolled back): $error";
868 foreach my $svc_something ( @{ $opt->{'svcs'} } ) {
869 if ( $svc_something->svcnum ) {
870 my $old_cust_svc = $svc_something->cust_svc;
871 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
872 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
873 $error = $new_cust_svc->replace($old_cust_svc);
875 $svc_something->pkgnum( $cust_pkg->pkgnum );
876 if ( $svc_something->isa('FS::svc_acct') ) {
877 foreach ( grep { $opt->{$_.'_ref'} && ${ $opt->{$_.'_ref'} } }
878 qw( seconds upbytes downbytes totalbytes ) ) {
879 $svc_something->$_( $svc_something->$_() + ${ $opt->{$_.'_ref'} } );
880 ${ $opt->{$_.'_ref'} } = 0;
883 $error = $svc_something->insert(%svc_options);
886 $dbh->rollback if $oldAutoCommit;
887 return "inserting svc_ (transaction rolled back): $error";
891 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
896 #deprecated #=item order_pkgs HASHREF [ , SECONDSREF ] [ , OPTION => VALUE ... ]
897 =item order_pkgs HASHREF [ , OPTION => VALUE ... ]
899 Like the insert method on an existing record, this method orders multiple
900 packages and included services atomicaly. Pass a Tie::RefHash data structure
901 to this method containing FS::cust_pkg and FS::svc_I<tablename> objects.
902 There should be a better explanation of this, but until then, here's an
906 tie %hash, 'Tie::RefHash'; #this part is important
908 $cust_pkg => [ $svc_acct ],
911 $cust_main->order_pkgs( \%hash, 'noexport'=>1 );
913 Services can be new, in which case they are inserted, or existing unaudited
914 services, in which case they are linked to the newly-created package.
916 Currently available options are: I<depend_jobnum>, I<noexport>, I<seconds_ref>,
917 I<upbytes_ref>, I<downbytes_ref>, and I<totalbytes_ref>.
919 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
920 on the supplied jobnum (they will not run until the specific job completes).
921 This can be used to defer provisioning until some action completes (such
922 as running the customer's credit card successfully).
924 The I<noexport> option is deprecated. If I<noexport> is set true, no
925 provisioning jobs (exports) are scheduled. (You can schedule them later with
926 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
927 on the cust_main object is not recommended, as existing services will also be
930 If I<seconds_ref>, I<upbytes_ref>, I<downbytes_ref>, or I<totalbytes_ref> is
931 provided, the scalars (provided by references) will be incremented by the
932 values of the prepaid card.`
938 my $cust_pkgs = shift;
939 my $seconds_ref = ref($_[0]) ? shift : ''; #deprecated
941 $seconds_ref ||= $options{'seconds_ref'};
943 warn "$me order_pkgs called with options ".
944 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
947 local $SIG{HUP} = 'IGNORE';
948 local $SIG{INT} = 'IGNORE';
949 local $SIG{QUIT} = 'IGNORE';
950 local $SIG{TERM} = 'IGNORE';
951 local $SIG{TSTP} = 'IGNORE';
952 local $SIG{PIPE} = 'IGNORE';
954 my $oldAutoCommit = $FS::UID::AutoCommit;
955 local $FS::UID::AutoCommit = 0;
958 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
960 foreach my $cust_pkg ( keys %$cust_pkgs ) {
962 my $error = $self->order_pkg(
963 'cust_pkg' => $cust_pkg,
964 'svcs' => $cust_pkgs->{$cust_pkg},
965 'seconds_ref' => $seconds_ref,
966 map { $_ => $options{$_} } qw( upbytes_ref downbytes_ref totalbytes_ref
971 $dbh->rollback if $oldAutoCommit;
977 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
981 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
983 Recharges this (existing) customer with the specified prepaid card (see
984 L<FS::prepay_credit>), specified either by I<identifier> or as an
985 FS::prepay_credit object. If there is an error, returns the error, otherwise
988 Optionally, five scalar references can be passed as well. They will have their
989 values filled in with the amount, number of seconds, and number of upload,
990 download, and total bytes applied by this prepaid card.
994 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
995 #the only place that uses these args
996 sub recharge_prepay {
997 my( $self, $prepay_credit, $amountref, $secondsref,
998 $upbytesref, $downbytesref, $totalbytesref ) = @_;
1000 local $SIG{HUP} = 'IGNORE';
1001 local $SIG{INT} = 'IGNORE';
1002 local $SIG{QUIT} = 'IGNORE';
1003 local $SIG{TERM} = 'IGNORE';
1004 local $SIG{TSTP} = 'IGNORE';
1005 local $SIG{PIPE} = 'IGNORE';
1007 my $oldAutoCommit = $FS::UID::AutoCommit;
1008 local $FS::UID::AutoCommit = 0;
1011 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
1013 my $error = $self->get_prepay( $prepay_credit,
1014 'amount_ref' => \$amount,
1015 'seconds_ref' => \$seconds,
1016 'upbytes_ref' => \$upbytes,
1017 'downbytes_ref' => \$downbytes,
1018 'totalbytes_ref' => \$totalbytes,
1020 || $self->increment_seconds($seconds)
1021 || $self->increment_upbytes($upbytes)
1022 || $self->increment_downbytes($downbytes)
1023 || $self->increment_totalbytes($totalbytes)
1024 || $self->insert_cust_pay_prepay( $amount,
1026 ? $prepay_credit->identifier
1031 $dbh->rollback if $oldAutoCommit;
1035 if ( defined($amountref) ) { $$amountref = $amount; }
1036 if ( defined($secondsref) ) { $$secondsref = $seconds; }
1037 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
1038 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
1039 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
1041 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1046 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
1048 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
1049 specified either by I<identifier> or as an FS::prepay_credit object.
1051 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
1052 incremented by the values of the prepaid card.
1054 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
1055 check or set this customer's I<agentnum>.
1057 If there is an error, returns the error, otherwise returns false.
1063 my( $self, $prepay_credit, %opt ) = @_;
1065 local $SIG{HUP} = 'IGNORE';
1066 local $SIG{INT} = 'IGNORE';
1067 local $SIG{QUIT} = 'IGNORE';
1068 local $SIG{TERM} = 'IGNORE';
1069 local $SIG{TSTP} = 'IGNORE';
1070 local $SIG{PIPE} = 'IGNORE';
1072 my $oldAutoCommit = $FS::UID::AutoCommit;
1073 local $FS::UID::AutoCommit = 0;
1076 unless ( ref($prepay_credit) ) {
1078 my $identifier = $prepay_credit;
1080 $prepay_credit = qsearchs(
1082 { 'identifier' => $prepay_credit },
1087 unless ( $prepay_credit ) {
1088 $dbh->rollback if $oldAutoCommit;
1089 return "Invalid prepaid card: ". $identifier;
1094 if ( $prepay_credit->agentnum ) {
1095 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
1096 $dbh->rollback if $oldAutoCommit;
1097 return "prepaid card not valid for agent ". $self->agentnum;
1099 $self->agentnum($prepay_credit->agentnum);
1102 my $error = $prepay_credit->delete;
1104 $dbh->rollback if $oldAutoCommit;
1105 return "removing prepay_credit (transaction rolled back): $error";
1108 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
1109 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
1111 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1116 =item increment_upbytes SECONDS
1118 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1119 the specified number of upbytes. If there is an error, returns the error,
1120 otherwise returns false.
1124 sub increment_upbytes {
1125 _increment_column( shift, 'upbytes', @_);
1128 =item increment_downbytes SECONDS
1130 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1131 the specified number of downbytes. If there is an error, returns the error,
1132 otherwise returns false.
1136 sub increment_downbytes {
1137 _increment_column( shift, 'downbytes', @_);
1140 =item increment_totalbytes SECONDS
1142 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1143 the specified number of totalbytes. If there is an error, returns the error,
1144 otherwise returns false.
1148 sub increment_totalbytes {
1149 _increment_column( shift, 'totalbytes', @_);
1152 =item increment_seconds SECONDS
1154 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1155 the specified number of seconds. If there is an error, returns the error,
1156 otherwise returns false.
1160 sub increment_seconds {
1161 _increment_column( shift, 'seconds', @_);
1164 =item _increment_column AMOUNT
1166 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1167 the specified number of seconds or bytes. If there is an error, returns
1168 the error, otherwise returns false.
1172 sub _increment_column {
1173 my( $self, $column, $amount ) = @_;
1174 warn "$me increment_column called: $column, $amount\n"
1177 return '' unless $amount;
1179 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1180 $self->ncancelled_pkgs;
1182 if ( ! @cust_pkg ) {
1183 return 'No packages with primary or single services found'.
1184 ' to apply pre-paid time';
1185 } elsif ( scalar(@cust_pkg) > 1 ) {
1186 #maybe have a way to specify the package/account?
1187 return 'Multiple packages found to apply pre-paid time';
1190 my $cust_pkg = $cust_pkg[0];
1191 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1195 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1197 if ( ! @cust_svc ) {
1198 return 'No account found to apply pre-paid time';
1199 } elsif ( scalar(@cust_svc) > 1 ) {
1200 return 'Multiple accounts found to apply pre-paid time';
1203 my $svc_acct = $cust_svc[0]->svc_x;
1204 warn " found service svcnum ". $svc_acct->pkgnum.
1205 ' ('. $svc_acct->email. ")\n"
1208 $column = "increment_$column";
1209 $svc_acct->$column($amount);
1213 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1215 Inserts a prepayment in the specified amount for this customer. An optional
1216 second argument can specify the prepayment identifier for tracking purposes.
1217 If there is an error, returns the error, otherwise returns false.
1221 sub insert_cust_pay_prepay {
1222 shift->insert_cust_pay('PREP', @_);
1225 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1227 Inserts a cash payment in the specified amount for this customer. An optional
1228 second argument can specify the payment identifier for tracking purposes.
1229 If there is an error, returns the error, otherwise returns false.
1233 sub insert_cust_pay_cash {
1234 shift->insert_cust_pay('CASH', @_);
1237 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1239 Inserts a Western Union payment in the specified amount for this customer. An
1240 optional second argument can specify the prepayment identifier for tracking
1241 purposes. If there is an error, returns the error, otherwise returns false.
1245 sub insert_cust_pay_west {
1246 shift->insert_cust_pay('WEST', @_);
1249 sub insert_cust_pay {
1250 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1251 my $payinfo = scalar(@_) ? shift : '';
1253 my $cust_pay = new FS::cust_pay {
1254 'custnum' => $self->custnum,
1255 'paid' => sprintf('%.2f', $amount),
1256 #'_date' => #date the prepaid card was purchased???
1258 'payinfo' => $payinfo,
1266 This method is deprecated. See the I<depend_jobnum> option to the insert and
1267 order_pkgs methods for a better way to defer provisioning.
1269 Re-schedules all exports by calling the B<reexport> method of all associated
1270 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
1271 otherwise returns false.
1278 carp "WARNING: FS::cust_main::reexport is deprectated; ".
1279 "use the depend_jobnum option to insert or order_pkgs to delay export";
1281 local $SIG{HUP} = 'IGNORE';
1282 local $SIG{INT} = 'IGNORE';
1283 local $SIG{QUIT} = 'IGNORE';
1284 local $SIG{TERM} = 'IGNORE';
1285 local $SIG{TSTP} = 'IGNORE';
1286 local $SIG{PIPE} = 'IGNORE';
1288 my $oldAutoCommit = $FS::UID::AutoCommit;
1289 local $FS::UID::AutoCommit = 0;
1292 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1293 my $error = $cust_pkg->reexport;
1295 $dbh->rollback if $oldAutoCommit;
1300 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1305 =item delete [ OPTION => VALUE ... ]
1307 This deletes the customer. If there is an error, returns the error, otherwise
1310 This will completely remove all traces of the customer record. This is not
1311 what you want when a customer cancels service; for that, cancel all of the
1312 customer's packages (see L</cancel>).
1314 If the customer has any uncancelled packages, you need to pass a new (valid)
1315 customer number for those packages to be transferred to, as the "new_customer"
1316 option. Cancelled packages will be deleted. Did I mention that this is NOT
1317 what you want when a customer cancels service and that you really should be
1318 looking at L<FS::cust_pkg/cancel>?
1320 You can't delete a customer with invoices (see L<FS::cust_bill>),
1321 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1322 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1323 set the "delete_financials" option to a true value.
1328 my( $self, %opt ) = @_;
1330 local $SIG{HUP} = 'IGNORE';
1331 local $SIG{INT} = 'IGNORE';
1332 local $SIG{QUIT} = 'IGNORE';
1333 local $SIG{TERM} = 'IGNORE';
1334 local $SIG{TSTP} = 'IGNORE';
1335 local $SIG{PIPE} = 'IGNORE';
1337 my $oldAutoCommit = $FS::UID::AutoCommit;
1338 local $FS::UID::AutoCommit = 0;
1341 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1342 $dbh->rollback if $oldAutoCommit;
1343 return "Can't delete a master agent customer";
1346 #use FS::access_user
1347 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1348 $dbh->rollback if $oldAutoCommit;
1349 return "Can't delete a master employee customer";
1352 tie my %financial_tables, 'Tie::IxHash',
1353 'cust_bill' => 'invoices',
1354 'cust_statement' => 'statements',
1355 'cust_credit' => 'credits',
1356 'cust_pay' => 'payments',
1357 'cust_refund' => 'refunds',
1360 foreach my $table ( keys %financial_tables ) {
1362 my @records = $self->$table();
1364 if ( @records && ! $opt{'delete_financials'} ) {
1365 $dbh->rollback if $oldAutoCommit;
1366 return "Can't delete a customer with ". $financial_tables{$table};
1369 foreach my $record ( @records ) {
1370 my $error = $record->delete;
1372 $dbh->rollback if $oldAutoCommit;
1373 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1379 my @cust_pkg = $self->ncancelled_pkgs;
1381 my $new_custnum = $opt{'new_custnum'};
1382 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1383 $dbh->rollback if $oldAutoCommit;
1384 return "Invalid new customer number: $new_custnum";
1386 foreach my $cust_pkg ( @cust_pkg ) {
1387 my %hash = $cust_pkg->hash;
1388 $hash{'custnum'} = $new_custnum;
1389 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1390 my $error = $new_cust_pkg->replace($cust_pkg,
1391 options => { $cust_pkg->options },
1394 $dbh->rollback if $oldAutoCommit;
1399 my @cancelled_cust_pkg = $self->all_pkgs;
1400 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1401 my $error = $cust_pkg->delete;
1403 $dbh->rollback if $oldAutoCommit;
1408 #cust_tax_adjustment in financials?
1409 #cust_pay_pending? ouch
1411 foreach my $table (qw(
1412 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1413 cust_location cust_main_note cust_tax_adjustment
1414 cust_pay_void cust_pay_batch queue cust_tax_exempt
1416 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1417 my $error = $record->delete;
1419 $dbh->rollback if $oldAutoCommit;
1425 my $sth = $dbh->prepare(
1426 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1428 my $errstr = $dbh->errstr;
1429 $dbh->rollback if $oldAutoCommit;
1432 $sth->execute($self->custnum) or do {
1433 my $errstr = $sth->errstr;
1434 $dbh->rollback if $oldAutoCommit;
1440 my $ticket_dbh = '';
1441 if ($conf->config('ticket_system') eq 'RT_Internal') {
1443 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1444 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1445 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1446 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1449 if ( $ticket_dbh ) {
1451 my $ticket_sth = $ticket_dbh->prepare(
1452 'DELETE FROM Links WHERE Target = ?'
1454 my $errstr = $ticket_dbh->errstr;
1455 $dbh->rollback if $oldAutoCommit;
1458 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1460 my $errstr = $ticket_sth->errstr;
1461 $dbh->rollback if $oldAutoCommit;
1465 #check and see if the customer is the only link on the ticket, and
1466 #if so, set the ticket to deleted status in RT?
1467 #maybe someday, for now this will at least fix tickets not displaying
1471 #delete the customer record
1473 my $error = $self->SUPER::delete;
1475 $dbh->rollback if $oldAutoCommit;
1479 # cust_main exports!
1481 #my $export_args = $options{'export_args'} || [];
1484 map qsearch( 'part_export', {exportnum=>$_} ),
1485 $conf->config('cust_main-exports'); #, $agentnum
1487 foreach my $part_export ( @part_export ) {
1488 my $error = $part_export->export_delete( $self ); #, @$export_args);
1490 $dbh->rollback if $oldAutoCommit;
1491 return "exporting to ". $part_export->exporttype.
1492 " (transaction rolled back): $error";
1496 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1501 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1504 Replaces the OLD_RECORD with this one in the database. If there is an error,
1505 returns the error, otherwise returns false.
1507 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1508 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1509 expected and rollback the entire transaction; it is not necessary to call
1510 check_invoicing_list first. Here's an example:
1512 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1514 Currently available options are: I<tax_exemption>.
1516 The I<tax_exemption> option can be set to an arrayref of tax names.
1517 FS::cust_main_exemption records will be deleted and inserted as appropriate.
1524 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1526 : $self->replace_old;
1530 warn "$me replace called\n"
1533 my $curuser = $FS::CurrentUser::CurrentUser;
1534 if ( $self->payby eq 'COMP'
1535 && $self->payby ne $old->payby
1536 && ! $curuser->access_right('Complimentary customer')
1539 return "You are not permitted to create complimentary accounts.";
1542 local($ignore_expired_card) = 1
1543 if $old->payby =~ /^(CARD|DCRD)$/
1544 && $self->payby =~ /^(CARD|DCRD)$/
1545 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1547 local $SIG{HUP} = 'IGNORE';
1548 local $SIG{INT} = 'IGNORE';
1549 local $SIG{QUIT} = 'IGNORE';
1550 local $SIG{TERM} = 'IGNORE';
1551 local $SIG{TSTP} = 'IGNORE';
1552 local $SIG{PIPE} = 'IGNORE';
1554 my $oldAutoCommit = $FS::UID::AutoCommit;
1555 local $FS::UID::AutoCommit = 0;
1558 my $error = $self->SUPER::replace($old);
1561 $dbh->rollback if $oldAutoCommit;
1565 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1566 my $invoicing_list = shift @param;
1567 $error = $self->check_invoicing_list( $invoicing_list );
1569 $dbh->rollback if $oldAutoCommit;
1572 $self->invoicing_list( $invoicing_list );
1575 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1577 #this could be more efficient than deleting and re-inserting, if it matters
1578 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1579 my $error = $cust_tag->delete;
1581 $dbh->rollback if $oldAutoCommit;
1585 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1586 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1587 'custnum' => $self->custnum };
1588 my $error = $cust_tag->insert;
1590 $dbh->rollback if $oldAutoCommit;
1597 my %options = @param;
1599 my $tax_exemption = delete $options{'tax_exemption'};
1600 if ( $tax_exemption ) {
1602 my %cust_main_exemption =
1603 map { $_->taxname => $_ }
1604 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1606 foreach my $taxname ( @$tax_exemption ) {
1608 next if delete $cust_main_exemption{$taxname};
1610 my $cust_main_exemption = new FS::cust_main_exemption {
1611 'custnum' => $self->custnum,
1612 'taxname' => $taxname,
1614 my $error = $cust_main_exemption->insert;
1616 $dbh->rollback if $oldAutoCommit;
1617 return "inserting cust_main_exemption (transaction rolled back): $error";
1621 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1622 my $error = $cust_main_exemption->delete;
1624 $dbh->rollback if $oldAutoCommit;
1625 return "deleting cust_main_exemption (transaction rolled back): $error";
1631 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1632 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1633 && $self->get('payinfo') !~ /^99\d{14}$/
1635 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1640 # card/check/lec info has changed, want to retry realtime_ invoice events
1641 my $error = $self->retry_realtime;
1643 $dbh->rollback if $oldAutoCommit;
1648 unless ( $import || $skip_fuzzyfiles ) {
1649 $error = $self->queue_fuzzyfiles_update;
1651 $dbh->rollback if $oldAutoCommit;
1652 return "updating fuzzy search cache: $error";
1656 # cust_main exports!
1658 my $export_args = $options{'export_args'} || [];
1661 map qsearch( 'part_export', {exportnum=>$_} ),
1662 $conf->config('cust_main-exports'); #, $agentnum
1664 foreach my $part_export ( @part_export ) {
1665 my $error = $part_export->export_replace( $self, $old, @$export_args);
1667 $dbh->rollback if $oldAutoCommit;
1668 return "exporting to ". $part_export->exporttype.
1669 " (transaction rolled back): $error";
1673 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1678 =item queue_fuzzyfiles_update
1680 Used by insert & replace to update the fuzzy search cache
1684 sub queue_fuzzyfiles_update {
1687 local $SIG{HUP} = 'IGNORE';
1688 local $SIG{INT} = 'IGNORE';
1689 local $SIG{QUIT} = 'IGNORE';
1690 local $SIG{TERM} = 'IGNORE';
1691 local $SIG{TSTP} = 'IGNORE';
1692 local $SIG{PIPE} = 'IGNORE';
1694 my $oldAutoCommit = $FS::UID::AutoCommit;
1695 local $FS::UID::AutoCommit = 0;
1698 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1699 my $error = $queue->insert( map $self->getfield($_), @fuzzyfields );
1701 $dbh->rollback if $oldAutoCommit;
1702 return "queueing job (transaction rolled back): $error";
1705 if ( $self->ship_last ) {
1706 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1707 $error = $queue->insert( map $self->getfield("ship_$_"), @fuzzyfields );
1709 $dbh->rollback if $oldAutoCommit;
1710 return "queueing job (transaction rolled back): $error";
1714 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1721 Checks all fields to make sure this is a valid customer record. If there is
1722 an error, returns the error, otherwise returns false. Called by the insert
1723 and replace methods.
1730 warn "$me check BEFORE: \n". $self->_dump
1734 $self->ut_numbern('custnum')
1735 || $self->ut_number('agentnum')
1736 || $self->ut_textn('agent_custid')
1737 || $self->ut_number('refnum')
1738 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1739 || $self->ut_textn('custbatch')
1740 || $self->ut_name('last')
1741 || $self->ut_name('first')
1742 || $self->ut_snumbern('birthdate')
1743 || $self->ut_snumbern('signupdate')
1744 || $self->ut_textn('company')
1745 || $self->ut_text('address1')
1746 || $self->ut_textn('address2')
1747 || $self->ut_text('city')
1748 || $self->ut_textn('county')
1749 || $self->ut_textn('state')
1750 || $self->ut_country('country')
1751 || $self->ut_anything('comments')
1752 || $self->ut_numbern('referral_custnum')
1753 || $self->ut_textn('stateid')
1754 || $self->ut_textn('stateid_state')
1755 || $self->ut_textn('invoice_terms')
1756 || $self->ut_alphan('geocode')
1757 || $self->ut_floatn('cdr_termination_percentage')
1760 #barf. need message catalogs. i18n. etc.
1761 $error .= "Please select an advertising source."
1762 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1763 return $error if $error;
1765 return "Unknown agent"
1766 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1768 return "Unknown refnum"
1769 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1771 return "Unknown referring custnum: ". $self->referral_custnum
1772 unless ! $self->referral_custnum
1773 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1775 if ( $self->censustract ne '' ) {
1776 $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
1777 or return "Illegal census tract: ". $self->censustract;
1779 $self->censustract("$1.$2");
1782 if ( $self->ss eq '' ) {
1787 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1788 or return "Illegal social security number: ". $self->ss;
1789 $self->ss("$1-$2-$3");
1793 # bad idea to disable, causes billing to fail because of no tax rates later
1794 # except we don't fail any more
1795 unless ( $import ) {
1796 unless ( qsearch('cust_main_county', {
1797 'country' => $self->country,
1800 return "Unknown state/county/country: ".
1801 $self->state. "/". $self->county. "/". $self->country
1802 unless qsearch('cust_main_county',{
1803 'state' => $self->state,
1804 'county' => $self->county,
1805 'country' => $self->country,
1811 $self->ut_phonen('daytime', $self->country)
1812 || $self->ut_phonen('night', $self->country)
1813 || $self->ut_phonen('fax', $self->country)
1814 || $self->ut_zip('zip', $self->country)
1816 return $error if $error;
1818 if ( $conf->exists('cust_main-require_phone')
1819 && ! length($self->daytime) && ! length($self->night)
1822 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1824 : FS::Msgcat::_gettext('daytime');
1825 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1827 : FS::Msgcat::_gettext('night');
1829 return "$daytime_label or $night_label is required"
1833 if ( $self->has_ship_address
1834 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1835 $self->addr_fields )
1839 $self->ut_name('ship_last')
1840 || $self->ut_name('ship_first')
1841 || $self->ut_textn('ship_company')
1842 || $self->ut_text('ship_address1')
1843 || $self->ut_textn('ship_address2')
1844 || $self->ut_text('ship_city')
1845 || $self->ut_textn('ship_county')
1846 || $self->ut_textn('ship_state')
1847 || $self->ut_country('ship_country')
1849 return $error if $error;
1851 #false laziness with above
1852 unless ( qsearchs('cust_main_county', {
1853 'country' => $self->ship_country,
1856 return "Unknown ship_state/ship_county/ship_country: ".
1857 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1858 unless qsearch('cust_main_county',{
1859 'state' => $self->ship_state,
1860 'county' => $self->ship_county,
1861 'country' => $self->ship_country,
1867 $self->ut_phonen('ship_daytime', $self->ship_country)
1868 || $self->ut_phonen('ship_night', $self->ship_country)
1869 || $self->ut_phonen('ship_fax', $self->ship_country)
1870 || $self->ut_zip('ship_zip', $self->ship_country)
1872 return $error if $error;
1874 return "Unit # is required."
1875 if $self->ship_address2 =~ /^\s*$/
1876 && $conf->exists('cust_main-require_address2');
1878 } else { # ship_ info eq billing info, so don't store dup info in database
1880 $self->setfield("ship_$_", '')
1881 foreach $self->addr_fields;
1883 return "Unit # is required."
1884 if $self->address2 =~ /^\s*$/
1885 && $conf->exists('cust_main-require_address2');
1889 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1890 # or return "Illegal payby: ". $self->payby;
1892 FS::payby->can_payby($self->table, $self->payby)
1893 or return "Illegal payby: ". $self->payby;
1895 $error = $self->ut_numbern('paystart_month')
1896 || $self->ut_numbern('paystart_year')
1897 || $self->ut_numbern('payissue')
1898 || $self->ut_textn('paytype')
1900 return $error if $error;
1902 if ( $self->payip eq '' ) {
1905 $error = $self->ut_ip('payip');
1906 return $error if $error;
1909 # If it is encrypted and the private key is not availaible then we can't
1910 # check the credit card.
1911 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1913 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1915 my $payinfo = $self->payinfo;
1916 $payinfo =~ s/\D//g;
1917 $payinfo =~ /^(\d{13,16})$/
1918 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1920 $self->payinfo($payinfo);
1922 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1924 return gettext('unknown_card_type')
1925 if $self->payinfo !~ /^99\d{14}$/ #token
1926 && cardtype($self->payinfo) eq "Unknown";
1928 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1930 return 'Banned credit card: banned on '.
1931 time2str('%a %h %o at %r', $ban->_date).
1932 ' by '. $ban->otaker.
1933 ' (ban# '. $ban->bannum. ')';
1936 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1937 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1938 $self->paycvv =~ /^(\d{4})$/
1939 or return "CVV2 (CID) for American Express cards is four digits.";
1942 $self->paycvv =~ /^(\d{3})$/
1943 or return "CVV2 (CVC2/CID) is three digits.";
1950 my $cardtype = cardtype($payinfo);
1951 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1953 return "Start date or issue number is required for $cardtype cards"
1954 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1956 return "Start month must be between 1 and 12"
1957 if $self->paystart_month
1958 and $self->paystart_month < 1 || $self->paystart_month > 12;
1960 return "Start year must be 1990 or later"
1961 if $self->paystart_year
1962 and $self->paystart_year < 1990;
1964 return "Issue number must be beween 1 and 99"
1966 and $self->payissue < 1 || $self->payissue > 99;
1969 $self->paystart_month('');
1970 $self->paystart_year('');
1971 $self->payissue('');
1974 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1976 my $payinfo = $self->payinfo;
1977 $payinfo =~ s/[^\d\@]//g;
1978 if ( $conf->exists('echeck-nonus') ) {
1979 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1980 $payinfo = "$1\@$2";
1982 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1983 $payinfo = "$1\@$2";
1985 $self->payinfo($payinfo);
1988 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1990 return 'Banned ACH account: banned on '.
1991 time2str('%a %h %o at %r', $ban->_date).
1992 ' by '. $ban->otaker.
1993 ' (ban# '. $ban->bannum. ')';
1996 } elsif ( $self->payby eq 'LECB' ) {
1998 my $payinfo = $self->payinfo;
1999 $payinfo =~ s/\D//g;
2000 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
2002 $self->payinfo($payinfo);
2005 } elsif ( $self->payby eq 'BILL' ) {
2007 $error = $self->ut_textn('payinfo');
2008 return "Illegal P.O. number: ". $self->payinfo if $error;
2011 } elsif ( $self->payby eq 'COMP' ) {
2013 my $curuser = $FS::CurrentUser::CurrentUser;
2014 if ( ! $self->custnum
2015 && ! $curuser->access_right('Complimentary customer')
2018 return "You are not permitted to create complimentary accounts."
2021 $error = $self->ut_textn('payinfo');
2022 return "Illegal comp account issuer: ". $self->payinfo if $error;
2025 } elsif ( $self->payby eq 'PREPAY' ) {
2027 my $payinfo = $self->payinfo;
2028 $payinfo =~ s/\W//g; #anything else would just confuse things
2029 $self->payinfo($payinfo);
2030 $error = $self->ut_alpha('payinfo');
2031 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2032 return "Unknown prepayment identifier"
2033 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2038 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2039 return "Expiration date required"
2040 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
2044 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2045 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2046 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2047 ( $m, $y ) = ( $2, "19$1" );
2048 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2049 ( $m, $y ) = ( $3, "20$2" );
2051 return "Illegal expiration date: ". $self->paydate;
2053 $self->paydate("$y-$m-01");
2054 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2055 return gettext('expired_card')
2057 && !$ignore_expired_card
2058 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2061 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2062 ( ! $conf->exists('require_cardname')
2063 || $self->payby !~ /^(CARD|DCRD)$/ )
2065 $self->payname( $self->first. " ". $self->getfield('last') );
2067 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
2068 or return gettext('illegal_name'). " payname: ". $self->payname;
2072 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2073 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2077 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2079 warn "$me check AFTER: \n". $self->_dump
2082 $self->SUPER::check;
2087 Returns a list of fields which have ship_ duplicates.
2092 qw( last first company
2093 address1 address2 city county state zip country
2098 =item has_ship_address
2100 Returns true if this customer record has a separate shipping address.
2104 sub has_ship_address {
2106 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
2111 Returns a list of key/value pairs, with the following keys: address1, adddress2,
2112 city, county, state, zip, country. The shipping address is used if present.
2116 #geocode? dependent on tax-ship_address config, not available in cust_location
2117 #mostly. not yet then.
2121 my $prefix = $self->has_ship_address ? 'ship_' : '';
2123 map { $_ => $self->get($prefix.$_) }
2124 qw( address1 address2 city county state zip country geocode );
2125 #fields that cust_location has
2128 =item all_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
2130 Returns all packages (see L<FS::cust_pkg>) for this customer.
2136 my $extra_qsearch = ref($_[0]) ? shift : {};
2138 return $self->num_pkgs unless wantarray || keys(%$extra_qsearch);
2141 if ( $self->{'_pkgnum'} ) {
2142 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
2144 @cust_pkg = $self->_cust_pkg($extra_qsearch);
2147 sort sort_packages @cust_pkg;
2152 Synonym for B<all_pkgs>.
2157 shift->all_pkgs(@_);
2162 Returns all locations (see L<FS::cust_location>) for this customer.
2168 qsearch('cust_location', { 'custnum' => $self->custnum } );
2171 =item location_label [ OPTION => VALUE ... ]
2173 Returns the label of the service location (see analog in L<FS::cust_location>) for this customer.
2181 used to separate the address elements (defaults to ', ')
2183 =item escape_function
2185 a callback used for escaping the text of the address elements
2191 # false laziness with FS::cust_location::line
2193 sub location_label {
2197 my $separator = $opt{join_string} || ', ';
2198 my $escape = $opt{escape_function} || sub{ shift };
2200 my $cydefault = FS::conf->new->config('countrydefault') || 'US';
2201 my $prefix = length($self->ship_last) ? 'ship_' : '';
2204 foreach (qw ( address1 address2 ) ) {
2205 my $method = "$prefix$_";
2206 $line .= ($notfirst ? $separator : ''). &$escape($self->$method)
2211 foreach (qw ( city county state zip ) ) {
2212 my $method = "$prefix$_";
2213 if ( $self->$method ) {
2214 $line .= ' (' if $method eq 'county';
2215 $line .= ($notfirst ? ' ' : $separator). &$escape($self->$method);
2216 $line .= ' )' if $method eq 'county';
2220 $line .= $separator. &$escape(code2country($self->country))
2221 if $self->country ne $cydefault;
2226 =item ncancelled_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
2228 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
2232 sub ncancelled_pkgs {
2234 my $extra_qsearch = ref($_[0]) ? shift : {};
2236 return $self->num_ncancelled_pkgs unless wantarray;
2239 if ( $self->{'_pkgnum'} ) {
2241 warn "$me ncancelled_pkgs: returning cached objects"
2244 @cust_pkg = grep { ! $_->getfield('cancel') }
2245 values %{ $self->{'_pkgnum'}->cache };
2249 warn "$me ncancelled_pkgs: searching for packages with custnum ".
2250 $self->custnum. "\n"
2253 $extra_qsearch->{'extra_sql'} .= ' AND ( cancel IS NULL OR cancel = 0 ) ';
2255 @cust_pkg = $self->_cust_pkg($extra_qsearch);
2259 sort sort_packages @cust_pkg;
2265 my $extra_qsearch = ref($_[0]) ? shift : {};
2267 $extra_qsearch->{'select'} ||= '*';
2268 $extra_qsearch->{'select'} .=
2269 ',( SELECT COUNT(*) FROM cust_svc WHERE cust_pkg.pkgnum = cust_svc.pkgnum )
2273 $_->{'_num_cust_svc'} = $_->get('_num_cust_svc');
2278 'table' => 'cust_pkg',
2279 'hashref' => { 'custnum' => $self->custnum },
2284 # This should be generalized to use config options to determine order.
2287 my $locationsort = ( $a->locationnum || 0 ) <=> ( $b->locationnum || 0 );
2288 return $locationsort if $locationsort;
2290 if ( $a->get('cancel') xor $b->get('cancel') ) {
2291 return -1 if $b->get('cancel');
2292 return 1 if $a->get('cancel');
2293 #shouldn't get here...
2296 my $a_num_cust_svc = $a->num_cust_svc;
2297 my $b_num_cust_svc = $b->num_cust_svc;
2298 return 0 if !$a_num_cust_svc && !$b_num_cust_svc;
2299 return -1 if $a_num_cust_svc && !$b_num_cust_svc;
2300 return 1 if !$a_num_cust_svc && $b_num_cust_svc;
2301 my @a_cust_svc = $a->cust_svc;
2302 my @b_cust_svc = $b->cust_svc;
2303 return 0 if !scalar(@a_cust_svc) && !scalar(@b_cust_svc);
2304 return -1 if scalar(@a_cust_svc) && !scalar(@b_cust_svc);
2305 return 1 if !scalar(@a_cust_svc) && scalar(@b_cust_svc);
2306 $a_cust_svc[0]->svc_x->label cmp $b_cust_svc[0]->svc_x->label;
2311 =item suspended_pkgs
2313 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
2317 sub suspended_pkgs {
2319 grep { $_->susp } $self->ncancelled_pkgs;
2322 =item unflagged_suspended_pkgs
2324 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
2325 customer (thouse packages without the `manual_flag' set).
2329 sub unflagged_suspended_pkgs {
2331 return $self->suspended_pkgs
2332 unless dbdef->table('cust_pkg')->column('manual_flag');
2333 grep { ! $_->manual_flag } $self->suspended_pkgs;
2336 =item unsuspended_pkgs
2338 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
2343 sub unsuspended_pkgs {
2345 grep { ! $_->susp } $self->ncancelled_pkgs;
2348 =item next_bill_date
2350 Returns the next date this customer will be billed, as a UNIX timestamp, or
2351 undef if no active package has a next bill date.
2355 sub next_bill_date {
2357 min( map $_->get('bill'), grep $_->get('bill'), $self->unsuspended_pkgs );
2360 =item num_cancelled_pkgs
2362 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
2367 sub num_cancelled_pkgs {
2368 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
2371 sub num_ncancelled_pkgs {
2372 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
2376 my( $self ) = shift;
2377 my $sql = scalar(@_) ? shift : '';
2378 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
2379 my $sth = dbh->prepare(
2380 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
2381 ) or die dbh->errstr;
2382 $sth->execute($self->custnum) or die $sth->errstr;
2383 $sth->fetchrow_arrayref->[0];
2388 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2389 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2390 on success or a list of errors.
2396 grep { $_->unsuspend } $self->suspended_pkgs;
2401 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2403 Returns a list: an empty list on success or a list of errors.
2409 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2412 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2414 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2415 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2416 of a list of pkgparts; the hashref has the following keys:
2420 =item pkgparts - listref of pkgparts
2422 =item (other options are passed to the suspend method)
2427 Returns a list: an empty list on success or a list of errors.
2431 sub suspend_if_pkgpart {
2433 my (@pkgparts, %opt);
2434 if (ref($_[0]) eq 'HASH'){
2435 @pkgparts = @{$_[0]{pkgparts}};
2440 grep { $_->suspend(%opt) }
2441 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2442 $self->unsuspended_pkgs;
2445 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2447 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2448 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2449 instead of a list of pkgparts; the hashref has the following keys:
2453 =item pkgparts - listref of pkgparts
2455 =item (other options are passed to the suspend method)
2459 Returns a list: an empty list on success or a list of errors.
2463 sub suspend_unless_pkgpart {
2465 my (@pkgparts, %opt);
2466 if (ref($_[0]) eq 'HASH'){
2467 @pkgparts = @{$_[0]{pkgparts}};
2472 grep { $_->suspend(%opt) }
2473 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2474 $self->unsuspended_pkgs;
2477 =item cancel [ OPTION => VALUE ... ]
2479 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2481 Available options are:
2485 =item quiet - can be set true to supress email cancellation notices.
2487 =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.
2489 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2491 =item nobill - can be set true to skip billing if it might otherwise be done.
2495 Always returns a list: an empty list on success or a list of errors.
2499 # nb that dates are not specified as valid options to this method
2502 my( $self, %opt ) = @_;
2504 warn "$me cancel called on customer ". $self->custnum. " with options ".
2505 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2508 return ( 'access denied' )
2509 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2511 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2513 #should try decryption (we might have the private key)
2514 # and if not maybe queue a job for the server that does?
2515 return ( "Can't (yet) ban encrypted credit cards" )
2516 if $self->is_encrypted($self->payinfo);
2518 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
2519 my $error = $ban->insert;
2520 return ( $error ) if $error;
2524 my @pkgs = $self->ncancelled_pkgs;
2526 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2528 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2529 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2533 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2534 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2537 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2540 sub _banned_pay_hashref {
2551 'payby' => $payby2ban{$self->payby},
2552 'payinfo' => md5_base64($self->payinfo),
2553 #don't ever *search* on reason! #'reason' =>
2559 Returns all notes (see L<FS::cust_main_note>) for this customer.
2566 qsearch( 'cust_main_note',
2567 { 'custnum' => $self->custnum },
2569 'ORDER BY _DATE DESC'
2575 Returns the agent (see L<FS::agent>) for this customer.
2581 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2586 Returns the agent name (see L<FS::agent>) for this customer.
2592 $self->agent->agent;
2597 Returns any tags associated with this customer, as FS::cust_tag objects,
2598 or an empty list if there are no tags.
2604 qsearch('cust_tag', { 'custnum' => $self->custnum } );
2609 Returns any tags associated with this customer, as FS::part_tag objects,
2610 or an empty list if there are no tags.
2616 map $_->part_tag, $self->cust_tag;
2622 Returns the customer class, as an FS::cust_class object, or the empty string
2623 if there is no customer class.
2629 if ( $self->classnum ) {
2630 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2638 Returns the customer category name, or the empty string if there is no customer
2645 my $cust_class = $self->cust_class;
2647 ? $cust_class->categoryname
2653 Returns the customer class name, or the empty string if there is no customer
2660 my $cust_class = $self->cust_class;
2662 ? $cust_class->classname
2667 =item bill_and_collect
2669 Cancels and suspends any packages due, generates bills, applies payments and
2670 credits, and applies collection events to run cards, send bills and notices,
2673 By default, warns on errors and continues with the next operation (but see the
2674 "fatal" flag below).
2676 Options are passed as name-value pairs. Currently available options are:
2682 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:
2686 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2690 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.
2694 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2698 If set true, re-charges setup fees.
2702 If set any errors prevent subsequent operations from continusing. If set
2703 specifically to "return", returns the error (or false, if there is no error).
2704 Any other true value causes errors to die.
2708 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)
2712 Optional FS::queue entry to receive status updates.
2716 Options are passed to the B<bill> and B<collect> methods verbatim, so all
2717 options of those methods are also available.
2721 sub bill_and_collect {
2722 my( $self, %options ) = @_;
2726 #$options{actual_time} not $options{time} because freeside-daily -d is for
2727 #pre-printing invoices
2729 $options{'actual_time'} ||= time;
2730 my $job = $options{'job'};
2732 $job->update_statustext('0,cleaning expired packages') if $job;
2733 $error = $self->cancel_expired_pkgs( $options{actual_time} );
2735 $error = "Error expiring custnum ". $self->custnum. ": $error";
2736 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2737 elsif ( $options{fatal} ) { die $error; }
2738 else { warn $error; }
2741 $error = $self->suspend_adjourned_pkgs( $options{actual_time} );
2743 $error = "Error adjourning custnum ". $self->custnum. ": $error";
2744 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2745 elsif ( $options{fatal} ) { die $error; }
2746 else { warn $error; }
2749 $job->update_statustext('20,billing packages') if $job;
2750 $error = $self->bill( %options );
2752 $error = "Error billing custnum ". $self->custnum. ": $error";
2753 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2754 elsif ( $options{fatal} ) { die $error; }
2755 else { warn $error; }
2758 $job->update_statustext('50,applying payments and credits') if $job;
2759 $error = $self->apply_payments_and_credits;
2761 $error = "Error applying custnum ". $self->custnum. ": $error";
2762 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2763 elsif ( $options{fatal} ) { die $error; }
2764 else { warn $error; }
2767 $job->update_statustext('70,running collection events') if $job;
2768 unless ( $conf->exists('cancelled_cust-noevents')
2769 && ! $self->num_ncancelled_pkgs
2771 $error = $self->collect( %options );
2773 $error = "Error collecting custnum ". $self->custnum. ": $error";
2774 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
2775 elsif ($options{fatal} ) { die $error; }
2776 else { warn $error; }
2779 $job->update_statustext('100,finished') if $job;
2785 sub cancel_expired_pkgs {
2786 my ( $self, $time, %options ) = @_;
2788 my @cancel_pkgs = $self->ncancelled_pkgs( {
2789 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
2794 foreach my $cust_pkg ( @cancel_pkgs ) {
2795 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
2796 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
2797 'reason_otaker' => $cpr->otaker
2801 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
2804 scalar(@errors) ? join(' / ', @errors) : '';
2808 sub suspend_adjourned_pkgs {
2809 my ( $self, $time, %options ) = @_;
2811 my @susp_pkgs = $self->ncancelled_pkgs( {
2813 " AND ( susp IS NULL OR susp = 0 )
2814 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
2815 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
2820 #only because there's no SQL test for is_prepaid :/
2822 grep { ( $_->part_pkg->is_prepaid
2827 && $_->adjourn <= $time
2835 foreach my $cust_pkg ( @susp_pkgs ) {
2836 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
2837 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
2838 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
2839 'reason_otaker' => $cpr->otaker
2843 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
2846 scalar(@errors) ? join(' / ', @errors) : '';
2852 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
2853 conjunction with the collect method by calling B<bill_and_collect>.
2855 If there is an error, returns the error, otherwise returns false.
2857 Options are passed as name-value pairs. Currently available options are:
2863 If set true, re-charges setup fees.
2867 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:
2871 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2875 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2877 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2881 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
2885 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.
2889 This boolean value informs the us that the package is being cancelled. This
2890 typically might mean not charging the normal recurring fee but only usage
2891 fees since the last billing. Setup charges may be charged. Not all package
2892 plans support this feature (they tend to charge 0).
2896 Optional terms to be printed on this invoice. Otherwise, customer-specific
2897 terms or the default terms are used.
2904 my( $self, %options ) = @_;
2905 return '' if $self->payby eq 'COMP';
2906 warn "$me bill customer ". $self->custnum. "\n"
2909 my $time = $options{'time'} || time;
2910 my $invoice_time = $options{'invoice_time'} || $time;
2912 $options{'not_pkgpart'} ||= {};
2913 $options{'not_pkgpart'} = { map { $_ => 1 }
2914 split(/\s*,\s*/, $options{'not_pkgpart'})
2916 unless ref($options{'not_pkgpart'});
2918 local $SIG{HUP} = 'IGNORE';
2919 local $SIG{INT} = 'IGNORE';
2920 local $SIG{QUIT} = 'IGNORE';
2921 local $SIG{TERM} = 'IGNORE';
2922 local $SIG{TSTP} = 'IGNORE';
2923 local $SIG{PIPE} = 'IGNORE';
2925 my $oldAutoCommit = $FS::UID::AutoCommit;
2926 local $FS::UID::AutoCommit = 0;
2929 warn "$me acquiring lock on customer ". $self->custnum. "\n"
2932 $self->select_for_update; #mutex
2934 warn "$me running pre-bill events for customer ". $self->custnum. "\n"
2937 my $error = $self->do_cust_event(
2938 'debug' => ( $options{'debug'} || 0 ),
2939 'time' => $invoice_time,
2940 'check_freq' => $options{'check_freq'},
2941 'stage' => 'pre-bill',
2944 $dbh->rollback if $oldAutoCommit;
2948 warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
2951 #keep auto-charge and non-auto-charge line items separate
2952 my @passes = ( '', 'no_auto' );
2954 my %cust_bill_pkg = map { $_ => [] } @passes;
2957 # find the packages which are due for billing, find out how much they are
2958 # & generate invoice database.
2961 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
2962 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
2964 my %taxlisthash = map { $_ => {} } @passes;
2966 my @precommit_hooks = ();
2968 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
2969 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
2971 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
2973 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2975 #? to avoid use of uninitialized value errors... ?
2976 $cust_pkg->setfield('bill', '')
2977 unless defined($cust_pkg->bill);
2979 #my $part_pkg = $cust_pkg->part_pkg;
2981 my $real_pkgpart = $cust_pkg->pkgpart;
2982 my %hash = $cust_pkg->hash;
2984 # we could implement this bit as FS::part_pkg::has_hidden, but we already
2985 # suffer from performance issues
2986 $options{has_hidden} = 0;
2987 my @part_pkg = $cust_pkg->part_pkg->self_and_bill_linked;
2988 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
2990 foreach my $part_pkg ( @part_pkg ) {
2992 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
2994 my $pass = ($cust_pkg->no_auto || $part_pkg->no_auto) ? 'no_auto' : '';
2997 $self->_make_lines( 'part_pkg' => $part_pkg,
2998 'cust_pkg' => $cust_pkg,
2999 'precommit_hooks' => \@precommit_hooks,
3000 'line_items' => $cust_bill_pkg{$pass},
3001 'setup' => $total_setup{$pass},
3002 'recur' => $total_recur{$pass},
3003 'tax_matrix' => $taxlisthash{$pass},
3005 'real_pkgpart' => $real_pkgpart,
3006 'options' => \%options,
3009 $dbh->rollback if $oldAutoCommit;
3013 } #foreach my $part_pkg
3015 } #foreach my $cust_pkg
3017 #if the customer isn't on an automatic payby, everything can go on a single
3019 #if ( $cust_main->payby !~ /^(CARD|CHEK)$/ ) {
3020 #merge everything into one list
3023 foreach my $pass (@passes) { # keys %cust_bill_pkg ) {
3025 my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
3027 next unless @cust_bill_pkg; #don't create an invoice w/o line items
3029 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
3030 !$conf->exists('postal_invoice-recurring_only')
3034 my $postal_pkg = $self->charge_postal_fee();
3035 if ( $postal_pkg && !ref( $postal_pkg ) ) {
3037 $dbh->rollback if $oldAutoCommit;
3038 return "can't charge postal invoice fee for customer ".
3039 $self->custnum. ": $postal_pkg";
3041 } elsif ( $postal_pkg ) {
3043 my $real_pkgpart = $postal_pkg->pkgpart;
3044 # we could implement this bit as FS::part_pkg::has_hidden, but we already
3045 # suffer from performance issues
3046 $options{has_hidden} = 0;
3047 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
3048 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
3050 foreach my $part_pkg ( @part_pkg ) {
3051 my %postal_options = %options;
3052 delete $postal_options{cancel};
3054 $self->_make_lines( 'part_pkg' => $part_pkg,
3055 'cust_pkg' => $postal_pkg,
3056 'precommit_hooks' => \@precommit_hooks,
3057 'line_items' => \@cust_bill_pkg,
3058 'setup' => $total_setup{$pass},
3059 'recur' => $total_recur{$pass},
3060 'tax_matrix' => $taxlisthash{$pass},
3062 'real_pkgpart' => $real_pkgpart,
3063 'options' => \%postal_options,
3066 $dbh->rollback if $oldAutoCommit;
3071 # it's silly to have a zero value postal_pkg, but....
3072 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
3078 my $listref_or_error =
3079 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
3081 unless ( ref( $listref_or_error ) ) {
3082 $dbh->rollback if $oldAutoCommit;
3083 return $listref_or_error;
3086 foreach my $taxline ( @$listref_or_error ) {
3087 ${ $total_setup{$pass} } =
3088 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
3089 push @cust_bill_pkg, $taxline;
3092 #add tax adjustments
3093 warn "adding tax adjustments...\n" if $DEBUG > 2;
3094 foreach my $cust_tax_adjustment (
3095 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
3101 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
3103 my $itemdesc = $cust_tax_adjustment->taxname;
3104 $itemdesc = '' if $itemdesc eq 'Tax';
3106 push @cust_bill_pkg, new FS::cust_bill_pkg {
3112 'itemdesc' => $itemdesc,
3113 'itemcomment' => $cust_tax_adjustment->comment,
3114 'cust_tax_adjustment' => $cust_tax_adjustment,
3115 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
3120 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
3122 my @cust_bill = $self->cust_bill;
3123 my $balance = $self->balance;
3124 my $previous_balance = scalar(@cust_bill)
3125 ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
3128 $previous_balance += $cust_bill[$#cust_bill]->charged
3129 if scalar(@cust_bill);
3130 #my $balance_adjustments =
3131 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
3133 #create the new invoice
3134 my $cust_bill = new FS::cust_bill ( {
3135 'custnum' => $self->custnum,
3136 '_date' => ( $invoice_time ),
3137 'charged' => $charged,
3138 'billing_balance' => $balance,
3139 'previous_balance' => $previous_balance,
3140 'invoice_terms' => $options{'invoice_terms'},
3142 $error = $cust_bill->insert;
3144 $dbh->rollback if $oldAutoCommit;
3145 return "can't create invoice for customer #". $self->custnum. ": $error";
3148 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
3149 $cust_bill_pkg->invnum($cust_bill->invnum);
3150 my $error = $cust_bill_pkg->insert;
3152 $dbh->rollback if $oldAutoCommit;
3153 return "can't create invoice line item: $error";
3157 } #foreach my $pass ( keys %cust_bill_pkg )
3159 foreach my $hook ( @precommit_hooks ) {
3161 &{$hook}; #($self) ?
3164 $dbh->rollback if $oldAutoCommit;
3165 return "$@ running precommit hook $hook\n";
3169 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3173 #discard bundled packages of 0 value
3174 sub _omit_zero_value_bundles {
3176 my @cust_bill_pkg = ();
3177 my @cust_bill_pkg_bundle = ();
3180 foreach my $cust_bill_pkg ( @_ ) {
3181 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
3182 push @cust_bill_pkg, @cust_bill_pkg_bundle if $sum > 0;
3183 @cust_bill_pkg_bundle = ();
3186 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
3187 push @cust_bill_pkg_bundle, $cust_bill_pkg;
3189 push @cust_bill_pkg, @cust_bill_pkg_bundle if $sum > 0;
3195 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
3197 This is a weird one. Perhaps it should not even be exposed.
3199 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
3200 Usually used internally by bill method B<bill>.
3202 If there is an error, returns the error, otherwise returns reference to a
3203 list of line items suitable for insertion.
3209 An array ref of the line items being billed.
3213 A strange beast. The keys to this hash are internal identifiers consisting
3214 of the name of the tax object type, a space, and its unique identifier ( e.g.
3215 'cust_main_county 23' ). The values of the hash are listrefs. The first
3216 item in the list is the tax object. The remaining items are either line
3217 items or floating point values (currency amounts).
3219 The taxes are calculated on this entity. Calculated exemption records are
3220 transferred to the LINEITEMREF items on the assumption that they are related.
3226 This specifies the date appearing on the associated invoice. Some
3227 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
3232 sub calculate_taxes {
3233 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
3235 my @tax_line_items = ();
3237 warn "having a look at the taxes we found...\n" if $DEBUG > 2;
3239 # keys are tax names (as printed on invoices / itemdesc )
3240 # values are listrefs of taxlisthash keys (internal identifiers)
3243 # keys are taxlisthash keys (internal identifiers)
3244 # values are (cumulative) amounts
3247 # keys are taxlisthash keys (internal identifiers)
3248 # values are listrefs of cust_bill_pkg_tax_location hashrefs
3249 my %tax_location = ();
3251 # keys are taxlisthash keys (internal identifiers)
3252 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
3253 my %tax_rate_location = ();
3255 foreach my $tax ( keys %$taxlisthash ) {
3256 my $tax_object = shift @{ $taxlisthash->{$tax} };
3257 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
3258 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
3259 my $hashref_or_error =
3260 $tax_object->taxline( $taxlisthash->{$tax},
3261 'custnum' => $self->custnum,
3262 'invoice_time' => $invoice_time
3264 return $hashref_or_error unless ref($hashref_or_error);
3266 unshift @{ $taxlisthash->{$tax} }, $tax_object;
3268 my $name = $hashref_or_error->{'name'};
3269 my $amount = $hashref_or_error->{'amount'};
3271 #warn "adding $amount as $name\n";
3272 $taxname{ $name } ||= [];
3273 push @{ $taxname{ $name } }, $tax;
3275 $tax{ $tax } += $amount;
3277 $tax_location{ $tax } ||= [];
3278 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
3279 push @{ $tax_location{ $tax } },
3281 'taxnum' => $tax_object->taxnum,
3282 'taxtype' => ref($tax_object),
3283 'pkgnum' => $tax_object->get('pkgnum'),
3284 'locationnum' => $tax_object->get('locationnum'),
3285 'amount' => sprintf('%.2f', $amount ),
3289 $tax_rate_location{ $tax } ||= [];
3290 if ( ref($tax_object) eq 'FS::tax_rate' ) {
3291 my $taxratelocationnum =
3292 $tax_object->tax_rate_location->taxratelocationnum;
3293 push @{ $tax_rate_location{ $tax } },
3295 'taxnum' => $tax_object->taxnum,
3296 'taxtype' => ref($tax_object),
3297 'amount' => sprintf('%.2f', $amount ),
3298 'locationtaxid' => $tax_object->location,
3299 'taxratelocationnum' => $taxratelocationnum,
3305 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
3306 my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
3307 foreach my $tax ( keys %$taxlisthash ) {
3308 foreach ( @{ $taxlisthash->{$tax} }[1 ... scalar(@{ $taxlisthash->{$tax} })] ) {
3309 next unless ref($_) eq 'FS::cust_bill_pkg';
3311 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
3312 splice( @{ $_->_cust_tax_exempt_pkg } );
3316 #consolidate and create tax line items
3317 warn "consolidating and generating...\n" if $DEBUG > 2;
3318 foreach my $taxname ( keys %taxname ) {
3321 my @cust_bill_pkg_tax_location = ();
3322 my @cust_bill_pkg_tax_rate_location = ();
3323 warn "adding $taxname\n" if $DEBUG > 1;
3324 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
3325 next if $seen{$taxitem}++;
3326 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
3327 $tax += $tax{$taxitem};
3328 push @cust_bill_pkg_tax_location,
3329 map { new FS::cust_bill_pkg_tax_location $_ }
3330 @{ $tax_location{ $taxitem } };
3331 push @cust_bill_pkg_tax_rate_location,
3332 map { new FS::cust_bill_pkg_tax_rate_location $_ }
3333 @{ $tax_rate_location{ $taxitem } };
3337 $tax = sprintf('%.2f', $tax );
3339 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
3345 if ( $pkg_category and
3346 $conf->config('invoice_latexsummary') ||
3347 $conf->config('invoice_htmlsummary')
3351 my %hash = ( 'section' => $pkg_category->categoryname );
3352 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3356 push @tax_line_items, new FS::cust_bill_pkg {
3362 'itemdesc' => $taxname,
3363 'display' => \@display,
3364 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
3365 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
3374 my ($self, %params) = @_;
3376 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
3377 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
3378 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
3379 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
3380 my $total_setup = $params{setup} or die "no setup accumulator specified";
3381 my $total_recur = $params{recur} or die "no recur accumulator specified";
3382 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
3383 my $time = $params{'time'} or die "no time specified";
3384 my (%options) = %{$params{options}};
3387 my $real_pkgpart = $params{real_pkgpart};
3388 my %hash = $cust_pkg->hash;
3389 my $old_cust_pkg = new FS::cust_pkg \%hash;
3395 $cust_pkg->pkgpart($part_pkg->pkgpart);
3403 if ( $options{'resetup'}
3404 || ( ! $cust_pkg->setup
3405 && ( ! $cust_pkg->start_date
3406 || $cust_pkg->start_date <= $time
3408 && ( ! $conf->exists('disable_setup_suspended_pkgs')
3409 || ( $conf->exists('disable_setup_suspended_pkgs') &&
3410 ! $cust_pkg->getfield('susp')
3417 warn " bill setup\n" if $DEBUG > 1;
3420 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
3421 return "$@ running calc_setup for $cust_pkg\n"
3424 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
3426 $cust_pkg->setfield('setup', $time)
3427 unless $cust_pkg->setup;
3428 #do need it, but it won't get written to the db
3429 #|| $cust_pkg->pkgpart != $real_pkgpart;
3431 $cust_pkg->setfield('start_date', '')
3432 if $cust_pkg->start_date;
3437 # bill recurring fee
3440 #XXX unit stuff here too
3444 if ( ! $cust_pkg->get('susp')
3445 and ! $cust_pkg->get('start_date')
3446 and ( $part_pkg->getfield('freq') ne '0'
3447 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
3449 || ( $part_pkg->plan eq 'voip_cdr'
3450 && $part_pkg->option('bill_every_call')
3452 || ( $options{cancel} )
3455 # XXX should this be a package event? probably. events are called
3456 # at collection time at the moment, though...
3457 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
3458 if $part_pkg->can('reset_usage');
3459 #don't want to reset usage just cause we want a line item??
3460 #&& $part_pkg->pkgpart == $real_pkgpart;
3462 warn " bill recur\n" if $DEBUG > 1;
3465 # XXX shared with $recur_prog
3466 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
3470 #over two params! lets at least switch to a hashref for the rest...
3471 my $increment_next_bill = ( $part_pkg->freq ne '0'
3472 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
3473 && !$options{cancel}
3475 my %param = ( 'precommit_hooks' => $precommit_hooks,
3476 'increment_next_bill' => $increment_next_bill,
3477 'discounts' => \@discounts,
3478 'real_pkgpart' => $real_pkgpart,
3481 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
3482 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
3483 return "$@ running $method for $cust_pkg\n"
3486 if ( $increment_next_bill ) {
3488 my $next_bill = $part_pkg->add_freq($sdate);
3489 return "unparsable frequency: ". $part_pkg->freq
3490 if $next_bill == -1;
3492 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
3493 # only for figuring next bill date, nothing else, so, reset $sdate again
3495 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
3496 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
3497 $cust_pkg->last_bill($sdate);
3499 $cust_pkg->setfield('bill', $next_bill );
3505 warn "\$setup is undefined" unless defined($setup);
3506 warn "\$recur is undefined" unless defined($recur);
3507 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
3510 # If there's line items, create em cust_bill_pkg records
3511 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
3514 if ( $lineitems || $options{has_hidden} ) {
3516 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
3517 # hmm.. and if just the options are modified in some weird price plan?
3519 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
3522 my $error = $cust_pkg->replace( $old_cust_pkg,
3523 'options' => { $cust_pkg->options },
3525 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
3526 if $error; #just in case
3529 $setup = sprintf( "%.2f", $setup );
3530 $recur = sprintf( "%.2f", $recur );
3531 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
3532 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
3534 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
3535 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
3540 !$part_pkg->hidden && $options{has_hidden} ) #include some $0 lines
3543 warn " charges (setup=$setup, recur=$recur); adding line items\n"
3546 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
3548 warn " adding customer package invoice detail: $_\n"
3549 foreach @cust_pkg_detail;
3551 push @details, @cust_pkg_detail;
3553 my $cust_bill_pkg = new FS::cust_bill_pkg {
3554 'pkgnum' => $cust_pkg->pkgnum,
3556 'unitsetup' => $unitsetup,
3558 'unitrecur' => $unitrecur,
3559 'quantity' => $cust_pkg->quantity,
3560 'details' => \@details,
3561 'discounts' => \@discounts,
3562 'hidden' => $part_pkg->hidden,
3565 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
3566 $cust_bill_pkg->sdate( $hash{last_bill} );
3567 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
3568 $cust_bill_pkg->edate( $time ) if $options{cancel};
3569 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
3570 $cust_bill_pkg->sdate( $sdate );
3571 $cust_bill_pkg->edate( $cust_pkg->bill );
3572 #$cust_bill_pkg->edate( $time ) if $options{cancel};
3575 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
3576 unless $part_pkg->pkgpart == $real_pkgpart;
3578 $$total_setup += $setup;
3579 $$total_recur += $recur;
3586 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
3587 return $error if $error;
3589 push @$cust_bill_pkgs, $cust_bill_pkg;
3591 } #if $setup != 0 || $recur != 0
3601 my $part_pkg = shift;
3602 my $taxlisthash = shift;
3603 my $cust_bill_pkg = shift;
3604 my $cust_pkg = shift;
3605 my $invoice_time = shift;
3606 my $real_pkgpart = shift;
3607 my $options = shift;
3609 my %cust_bill_pkg = ();
3613 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
3614 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
3615 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
3616 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
3618 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
3620 if ( $conf->exists('enable_taxproducts')
3621 && ( scalar($part_pkg->part_pkg_taxoverride)
3622 || $part_pkg->has_taxproduct
3627 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3628 return "fatal: Can't (yet) use tax-pkg_address with taxproducts";
3631 foreach my $class (@classes) {
3632 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class );
3633 return $err_or_ref unless ref($err_or_ref);
3634 $taxes{$class} = $err_or_ref;
3637 unless (exists $taxes{''}) {
3638 my $err_or_ref = $self->_gather_taxes( $part_pkg, '' );
3639 return $err_or_ref unless ref($err_or_ref);
3640 $taxes{''} = $err_or_ref;
3645 my @loc_keys = qw( city county state country );
3647 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3648 my $cust_location = $cust_pkg->cust_location;
3649 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
3652 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
3655 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
3658 $taxhash{'taxclass'} = $part_pkg->taxclass;
3661 my %taxhash_elim = %taxhash;
3662 my @elim = qw( city county state );
3665 #first try a match with taxclass
3666 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
3668 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
3669 #then try a match without taxclass
3670 my %no_taxclass = %taxhash_elim;
3671 $no_taxclass{ 'taxclass' } = '';
3672 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
3675 $taxhash_elim{ shift(@elim) } = '';
3677 } while ( !scalar(@taxes) && scalar(@elim) );
3679 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
3681 if $self->cust_main_exemption; #just to be safe
3683 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3685 $_->set('pkgnum', $cust_pkg->pkgnum );
3686 $_->set('locationnum', $cust_pkg->locationnum );
3690 $taxes{''} = [ @taxes ];
3691 $taxes{'setup'} = [ @taxes ];
3692 $taxes{'recur'} = [ @taxes ];
3693 $taxes{$_} = [ @taxes ] foreach (@classes);
3695 # # maybe eliminate this entirely, along with all the 0% records
3696 # unless ( @taxes ) {
3698 # "fatal: can't find tax rate for state/county/country/taxclass ".
3699 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
3702 } #if $conf->exists('enable_taxproducts') ...
3707 my $separate = $conf->exists('separate_usage');
3708 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
3709 my $usage_mandate = $temp_pkg->part_pkg->option('usage_mandate', 'Hush!');
3710 my $section = $temp_pkg->part_pkg->categoryname;
3711 if ( $separate || $section || $usage_mandate ) {
3713 my %hash = ( 'section' => $section );
3715 $section = $temp_pkg->part_pkg->option('usage_section', 'Hush!');
3716 my $summary = $temp_pkg->part_pkg->option('summarize_usage', 'Hush!');
3718 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3719 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
3721 push @display, new FS::cust_bill_pkg_display
3724 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
3728 if ($separate && $section && $summary) {
3729 push @display, new FS::cust_bill_pkg_display { type => 'U',
3734 if ($usage_mandate || $section && $summary) {
3735 $hash{post_total} = 'Y';
3738 if ($separate || $usage_mandate) {
3739 $hash{section} = $section if ($separate || $usage_mandate);
3740 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
3744 $cust_bill_pkg->set('display', \@display);
3746 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
3747 foreach my $key (keys %tax_cust_bill_pkg) {
3748 my @taxes = @{ $taxes{$key} || [] };
3749 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
3751 my %localtaxlisthash = ();
3752 foreach my $tax ( @taxes ) {
3754 my $taxname = ref( $tax ). ' '. $tax->taxnum;
3755 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
3756 # ' locationnum'. $cust_pkg->locationnum
3757 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
3759 $taxlisthash->{ $taxname } ||= [ $tax ];
3760 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
3762 $localtaxlisthash{ $taxname } ||= [ $tax ];
3763 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
3767 warn "finding taxed taxes...\n" if $DEBUG > 2;
3768 foreach my $tax ( keys %localtaxlisthash ) {
3769 my $tax_object = shift @{ $localtaxlisthash{$tax} };
3770 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
3772 next unless $tax_object->can('tax_on_tax');
3774 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
3775 my $totname = ref( $tot ). ' '. $tot->taxnum;
3777 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
3779 next unless exists( $localtaxlisthash{ $totname } ); # only increase
3781 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
3782 my $hashref_or_error =
3783 $tax_object->taxline( $localtaxlisthash{$tax},
3784 'custnum' => $self->custnum,
3785 'invoice_time' => $invoice_time,
3787 return $hashref_or_error
3788 unless ref($hashref_or_error);
3790 $taxlisthash->{ $totname } ||= [ $tot ];
3791 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
3803 my $part_pkg = shift;
3807 my $geocode = $self->geocode('cch');
3809 my @taxclassnums = map { $_->taxclassnum }
3810 $part_pkg->part_pkg_taxoverride($class);
3812 unless (@taxclassnums) {
3813 @taxclassnums = map { $_->taxclassnum }
3814 grep { $_->taxable eq 'Y' }
3815 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
3817 warn "Found taxclassnum values of ". join(',', @taxclassnums)
3822 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
3824 @taxes = qsearch({ 'table' => 'tax_rate',
3825 'hashref' => { 'geocode' => $geocode, },
3826 'extra_sql' => $extra_sql,
3828 if scalar(@taxclassnums);
3830 warn "Found taxes ".
3831 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
3838 =item collect [ HASHREF | OPTION => VALUE ... ]
3840 (Attempt to) collect money for this customer's outstanding invoices (see
3841 L<FS::cust_bill>). Usually used after the bill method.
3843 Actions are now triggered by billing events; see L<FS::part_event> and the
3844 billing events web interface. Old-style invoice events (see
3845 L<FS::part_bill_event>) have been deprecated.
3847 If there is an error, returns the error, otherwise returns false.
3849 Options are passed as name-value pairs.
3851 Currently available options are:
3857 Use this time when deciding when to print invoices and late notices on those invoices. The default is now. It is specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions.
3861 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3865 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3869 set true to surpress email card/ACH decline notices.
3873 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
3879 # allows for one time override of normal customer billing method
3884 my( $self, %options ) = @_;
3885 my $invoice_time = $options{'invoice_time'} || time;
3888 local $SIG{HUP} = 'IGNORE';
3889 local $SIG{INT} = 'IGNORE';
3890 local $SIG{QUIT} = 'IGNORE';
3891 local $SIG{TERM} = 'IGNORE';
3892 local $SIG{TSTP} = 'IGNORE';
3893 local $SIG{PIPE} = 'IGNORE';
3895 my $oldAutoCommit = $FS::UID::AutoCommit;
3896 local $FS::UID::AutoCommit = 0;
3899 $self->select_for_update; #mutex
3902 my $balance = $self->balance;
3903 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
3906 if ( exists($options{'retry_card'}) ) {
3907 carp 'retry_card option passed to collect is deprecated; use retry';
3908 $options{'retry'} ||= $options{'retry_card'};
3910 if ( exists($options{'retry'}) && $options{'retry'} ) {
3911 my $error = $self->retry_realtime;
3913 $dbh->rollback if $oldAutoCommit;
3918 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3920 #never want to roll back an event just because it returned an error
3921 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
3923 $self->do_cust_event(
3924 'debug' => ( $options{'debug'} || 0 ),
3925 'time' => $invoice_time,
3926 'check_freq' => $options{'check_freq'},
3927 'stage' => 'collect',
3932 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
3934 Runs billing events; see L<FS::part_event> and the billing events web
3937 If there is an error, returns the error, otherwise returns false.
3939 Options are passed as name-value pairs.
3941 Currently available options are:
3947 Use this time when deciding when to print invoices and late notices on those invoices. The default is now. It is specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions.
3951 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3955 "collect" (the default) or "pre-bill"
3959 set true to surpress email card/ACH decline notices.
3963 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
3969 # allows for one time override of normal customer billing method
3973 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3976 my( $self, %options ) = @_;
3977 my $time = $options{'time'} || time;
3980 local $SIG{HUP} = 'IGNORE';
3981 local $SIG{INT} = 'IGNORE';
3982 local $SIG{QUIT} = 'IGNORE';
3983 local $SIG{TERM} = 'IGNORE';
3984 local $SIG{TSTP} = 'IGNORE';
3985 local $SIG{PIPE} = 'IGNORE';
3987 my $oldAutoCommit = $FS::UID::AutoCommit;
3988 local $FS::UID::AutoCommit = 0;
3991 $self->select_for_update; #mutex
3994 my $balance = $self->balance;
3995 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
3998 # if ( exists($options{'retry_card'}) ) {
3999 # carp 'retry_card option passed to collect is deprecated; use retry';
4000 # $options{'retry'} ||= $options{'retry_card'};
4002 # if ( exists($options{'retry'}) && $options{'retry'} ) {
4003 # my $error = $self->retry_realtime;
4005 # $dbh->rollback if $oldAutoCommit;
4010 # false laziness w/pay_batch::import_results
4012 my $due_cust_event = $self->due_cust_event(
4013 'debug' => ( $options{'debug'} || 0 ),
4015 'check_freq' => $options{'check_freq'},
4016 'stage' => ( $options{'stage'} || 'collect' ),
4018 unless( ref($due_cust_event) ) {
4019 $dbh->rollback if $oldAutoCommit;
4020 return $due_cust_event;
4023 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4024 #never want to roll back an event just because it or a different one
4026 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
4028 foreach my $cust_event ( @$due_cust_event ) {
4032 #re-eval event conditions (a previous event could have changed things)
4033 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
4034 #don't leave stray "new/locked" records around
4035 my $error = $cust_event->delete;
4036 return $error if $error;
4041 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
4042 warn " running cust_event ". $cust_event->eventnum. "\n"
4045 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
4046 if ( my $error = $cust_event->do_event() ) {
4047 #XXX wtf is this? figure out a proper dealio with return value
4059 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
4061 Inserts database records for and returns an ordered listref of new events due
4062 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
4063 events are due, an empty listref is returned. If there is an error, returns a
4064 scalar error message.
4066 To actually run the events, call each event's test_condition method, and if
4067 still true, call the event's do_event method.
4069 Options are passed as a hashref or as a list of name-value pairs. Available
4076 Search only for events of this check frequency (how often events of this type are checked); currently "1d" (daily, the default) and "1m" (monthly) are recognized.
4080 "collect" (the default) or "pre-bill"
4084 "Current time" for the events.
4088 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
4092 Only return events for the specified eventtable (by default, events of all eventtables are returned)
4096 Explicitly pass the objects to be tested (typically used with eventtable).
4100 Set to true to return the objects, but not actually insert them into the
4107 sub due_cust_event {
4109 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
4112 #my $DEBUG = $opt{'debug'}
4113 local($DEBUG) = $opt{'debug'}
4114 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
4116 warn "$me due_cust_event called with options ".
4117 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
4120 $opt{'time'} ||= time;
4122 local $SIG{HUP} = 'IGNORE';
4123 local $SIG{INT} = 'IGNORE';
4124 local $SIG{QUIT} = 'IGNORE';
4125 local $SIG{TERM} = 'IGNORE';
4126 local $SIG{TSTP} = 'IGNORE';
4127 local $SIG{PIPE} = 'IGNORE';
4129 my $oldAutoCommit = $FS::UID::AutoCommit;
4130 local $FS::UID::AutoCommit = 0;
4133 $self->select_for_update #mutex
4134 unless $opt{testonly};
4137 # find possible events (initial search)
4140 my @cust_event = ();
4142 my @eventtable = $opt{'eventtable'}
4143 ? ( $opt{'eventtable'} )
4144 : FS::part_event->eventtables_runorder;
4146 foreach my $eventtable ( @eventtable ) {
4149 if ( $opt{'objects'} ) {
4151 @objects = @{ $opt{'objects'} };
4155 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
4156 @objects = ( $eventtable eq 'cust_main' )
4158 : ( $self->$eventtable() );
4162 my @e_cust_event = ();
4164 my $cross = "CROSS JOIN $eventtable";
4165 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
4166 unless $eventtable eq 'cust_main';
4168 foreach my $object ( @objects ) {
4170 #this first search uses the condition_sql magic for optimization.
4171 #the more possible events we can eliminate in this step the better
4173 my $cross_where = '';
4174 my $pkey = $object->primary_key;
4175 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
4177 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
4179 FS::part_event_condition->where_conditions_sql( $eventtable,
4180 'time'=>$opt{'time'}
4182 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
4184 $extra_sql = "AND $extra_sql" if $extra_sql;
4186 #here is the agent virtualization
4187 $extra_sql .= " AND ( part_event.agentnum IS NULL
4188 OR part_event.agentnum = ". $self->agentnum. ' )';
4190 $extra_sql .= " $order";
4192 warn "searching for events for $eventtable ". $object->$pkey. "\n"
4193 if $opt{'debug'} > 2;
4194 my @part_event = qsearch( {
4195 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
4196 'select' => 'part_event.*',
4197 'table' => 'part_event',
4198 'addl_from' => "$cross $join",
4199 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
4200 'eventtable' => $eventtable,
4203 'extra_sql' => "AND $cross_where $extra_sql",
4207 my $pkey = $object->primary_key;
4208 warn " ". scalar(@part_event).
4209 " possible events found for $eventtable ". $object->$pkey(). "\n";
4212 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
4216 warn " ". scalar(@e_cust_event).
4217 " subtotal possible cust events found for $eventtable\n"
4220 push @cust_event, @e_cust_event;
4224 warn " ". scalar(@cust_event).
4225 " total possible cust events found in initial search\n"
4233 $opt{stage} ||= 'collect';
4235 grep { my $stage = $_->part_event->event_stage;
4236 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
4246 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
4247 'stats_hashref' => \%unsat ),
4250 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
4253 warn " invalid conditions not eliminated with condition_sql:\n".
4254 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
4255 if keys %unsat && $DEBUG; # > 1;
4261 unless( $opt{testonly} ) {
4262 foreach my $cust_event ( @cust_event ) {
4264 my $error = $cust_event->insert();
4266 $dbh->rollback if $oldAutoCommit;
4273 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4279 warn " returning events: ". Dumper(@cust_event). "\n"
4286 =item retry_realtime
4288 Schedules realtime / batch credit card / electronic check / LEC billing
4289 events for for retry. Useful if card information has changed or manual
4290 retry is desired. The 'collect' method must be called to actually retry
4293 Implementation details: For either this customer, or for each of this
4294 customer's open invoices, changes the status of the first "done" (with
4295 statustext error) realtime processing event to "failed".
4299 sub retry_realtime {
4302 local $SIG{HUP} = 'IGNORE';
4303 local $SIG{INT} = 'IGNORE';
4304 local $SIG{QUIT} = 'IGNORE';
4305 local $SIG{TERM} = 'IGNORE';
4306 local $SIG{TSTP} = 'IGNORE';
4307 local $SIG{PIPE} = 'IGNORE';
4309 my $oldAutoCommit = $FS::UID::AutoCommit;
4310 local $FS::UID::AutoCommit = 0;
4313 #a little false laziness w/due_cust_event (not too bad, really)
4315 my $join = FS::part_event_condition->join_conditions_sql;
4316 my $order = FS::part_event_condition->order_conditions_sql;
4319 . join ( ' OR ' , map {
4320 "( part_event.eventtable = " . dbh->quote($_)
4321 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
4322 } FS::part_event->eventtables)
4325 #here is the agent virtualization
4326 my $agent_virt = " ( part_event.agentnum IS NULL
4327 OR part_event.agentnum = ". $self->agentnum. ' )';
4329 #XXX this shouldn't be hardcoded, actions should declare it...
4330 my @realtime_events = qw(
4331 cust_bill_realtime_card
4332 cust_bill_realtime_check
4333 cust_bill_realtime_lec
4337 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
4342 my @cust_event = qsearchs({
4343 'table' => 'cust_event',
4344 'select' => 'cust_event.*',
4345 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
4346 'hashref' => { 'status' => 'done' },
4347 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
4348 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
4351 my %seen_invnum = ();
4352 foreach my $cust_event (@cust_event) {
4354 #max one for the customer, one for each open invoice
4355 my $cust_X = $cust_event->cust_X;
4356 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
4360 or $cust_event->part_event->eventtable eq 'cust_bill'
4363 my $error = $cust_event->retry;
4365 $dbh->rollback if $oldAutoCommit;
4366 return "error scheduling event for retry: $error";
4371 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4379 =item realtime_collect [ OPTION => VALUE ... ]
4381 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4382 via a Business::OnlinePayment or Business::OnlineThirdPartyPayment realtime
4383 gateway. See L<http://420.am/business-onlinepayment> and
4384 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
4386 On failure returns an error message.
4388 Returns false or a hashref upon success. The hashref contains keys popup_url reference, and collectitems. The first is a URL to which a browser should be redirected for completion of collection. The second is a reference id for the transaction suitable for the end user. The collectitems is a reference to a list of name value pairs suitable for assigning to a html form and posted to popup_url.
4390 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>, I<pkgnum>
4392 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>. If none is specified
4393 then it is deduced from the customer record.
4395 If no I<amount> is specified, then the customer balance is used.
4397 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4398 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4399 if set, will override the value from the customer record.
4401 I<description> is a free-text field passed to the gateway. It defaults to
4402 the value defined by the business-onlinepayment-description configuration
4403 option, or "Internet services" if that is unset.
4405 If an I<invnum> is specified, this payment (if successful) is applied to the
4406 specified invoice. If you don't specify an I<invnum> you might want to
4407 call the B<apply_payments> method or set the I<apply> option.
4409 I<apply> can be set to true to apply a resulting payment.
4411 I<quiet> can be set true to surpress email decline notices.
4413 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4414 resulting paynum, if any.
4416 I<payunique> is a unique identifier for this payment.
4418 I<session_id> is a session identifier associated with this payment.
4420 I<depend_jobnum> allows payment capture to unlock export jobs
4424 sub realtime_collect {
4425 my( $self, %options ) = @_;
4428 warn "$me realtime_collect:\n";
4429 warn " $_ => $options{$_}\n" foreach keys %options;
4432 $options{amount} = $self->balance unless exists( $options{amount} );
4433 $options{method} = FS::payby->payby2bop($self->payby)
4434 unless exists( $options{method} );
4436 return $self->realtime_bop({%options});
4440 =item realtime_bop { [ ARG => VALUE ... ] }
4442 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4443 via a Business::OnlinePayment realtime gateway. See
4444 L<http://420.am/business-onlinepayment> for supported gateways.
4446 Required arguments in the hashref are I<method>, and I<amount>
4448 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4450 Available optional arguments are: I<description>, I<invnum>, I<apply>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
4452 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4453 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4454 if set, will override the value from the customer record.
4456 I<description> is a free-text field passed to the gateway. It defaults to
4457 the value defined by the business-onlinepayment-description configuration
4458 option, or "Internet services" if that is unset.
4460 If an I<invnum> is specified, this payment (if successful) is applied to the
4461 specified invoice. If you don't specify an I<invnum> you might want to
4462 call the B<apply_payments> method or set the I<apply> option.
4464 I<apply> can be set to true to apply a resulting payment.
4466 I<quiet> can be set true to surpress email decline notices.
4468 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4469 resulting paynum, if any.
4471 I<payunique> is a unique identifier for this payment.
4473 I<session_id> is a session identifier associated with this payment.
4475 I<depend_jobnum> allows payment capture to unlock export jobs
4477 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
4481 # some helper routines
4482 sub _bop_recurring_billing {
4483 my( $self, %opt ) = @_;
4485 my $method = scalar($conf->config('credit_card-recurring_billing_flag'));
4487 if ( defined($method) && $method eq 'transaction_is_recur' ) {
4489 return 1 if $opt{'trans_is_recur'};
4493 my %hash = ( 'custnum' => $self->custnum,
4498 if qsearch('cust_pay', { %hash, 'payinfo' => $opt{'payinfo'} } )
4499 || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo('CARD',
4509 sub _payment_gateway {
4510 my ($self, $options) = @_;
4512 $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
4513 unless exists($options->{payment_gateway});
4515 $options->{payment_gateway};
4519 my ($self, $options) = @_;
4522 'login' => $options->{payment_gateway}->gateway_username,
4523 'password' => $options->{payment_gateway}->gateway_password,
4528 my ($self, $options) = @_;
4530 $options->{payment_gateway}->gatewaynum
4531 ? $options->{payment_gateway}->options
4532 : @{ $options->{payment_gateway}->get('options') };
4537 my ($self, $options) = @_;
4539 unless ( $options->{'description'} ) {
4540 if ( $conf->exists('business-onlinepayment-description') ) {
4541 my $dtempl = $conf->config('business-onlinepayment-description');
4543 my $agent = $self->agent->agent;
4545 $options->{'description'} = eval qq("$dtempl");
4547 $options->{'description'} = 'Internet services';
4551 $options->{payinfo} = $self->payinfo unless exists( $options->{payinfo} );
4552 $options->{invnum} ||= '';
4553 $options->{payname} = $self->payname unless exists( $options->{payname} );
4557 my ($self, $options) = @_;
4560 my $payip = exists($options->{'payip'}) ? $options->{'payip'} : $self->payip;
4561 $content{customer_ip} = $payip if length($payip);
4563 $content{invoice_number} = $options->{'invnum'}
4564 if exists($options->{'invnum'}) && length($options->{'invnum'});
4566 $content{email_customer} =
4567 ( $conf->exists('business-onlinepayment-email_customer')
4568 || $conf->exists('business-onlinepayment-email-override') );
4570 my ($payname, $payfirst, $paylast);
4571 if ( $options->{payname} && $options->{method} ne 'ECHECK' ) {
4572 ($payname = $options->{payname}) =~
4573 /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4574 or return "Illegal payname $payname";
4575 ($payfirst, $paylast) = ($1, $2);
4577 $payfirst = $self->getfield('first');
4578 $paylast = $self->getfield('last');
4579 $payname = "$payfirst $paylast";
4582 $content{last_name} = $paylast;
4583 $content{first_name} = $payfirst;
4585 $content{name} = $payname;
4587 $content{address} = exists($options->{'address1'})
4588 ? $options->{'address1'}
4590 my $address2 = exists($options->{'address2'})
4591 ? $options->{'address2'}
4593 $content{address} .= ", ". $address2 if length($address2);
4595 $content{city} = exists($options->{city})
4598 $content{state} = exists($options->{state})
4601 $content{zip} = exists($options->{zip})
4604 $content{country} = exists($options->{country})
4605 ? $options->{country}
4608 $content{referer} = 'http://cleanwhisker.420.am/'; #XXX fix referer :/
4609 $content{phone} = $self->daytime || $self->night;
4614 my %bop_method2payby = (
4624 if (ref($_[0]) eq 'HASH') {
4625 %options = %{$_[0]};
4627 my ( $method, $amount ) = ( shift, shift );
4629 $options{method} = $method;
4630 $options{amount} = $amount;
4634 warn "$me realtime_bop (new): $options{method} $options{amount}\n";
4635 warn " $_ => $options{$_}\n" foreach keys %options;
4638 return $self->fake_bop(%options) if $options{'fake'};
4640 $self->_bop_defaults(\%options);
4643 # set trans_is_recur based on invnum if there is one
4646 my $trans_is_recur = 0;
4647 if ( $options{'invnum'} ) {
4649 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
4650 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
4653 map { $_->part_pkg }
4655 map { $_->cust_pkg }
4656 $cust_bill->cust_bill_pkg;
4659 if grep { $_->freq ne '0' } @part_pkg;
4667 my $payment_gateway = $self->_payment_gateway( \%options );
4668 my $namespace = $payment_gateway->gateway_namespace;
4670 eval "use $namespace";
4674 # check for banned credit card/ACH
4677 my $ban = qsearchs('banned_pay', {
4678 'payby' => $bop_method2payby{$options{method}},
4679 'payinfo' => md5_base64($options{payinfo}),
4681 return "Banned credit card" if $ban;
4687 my $bop_content = $self->_bop_content(\%options);
4688 return $bop_content unless ref($bop_content);
4690 my @invoicing_list = $self->invoicing_list_emailonly;
4691 if ( $conf->exists('emailinvoiceautoalways')
4692 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4693 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4694 push @invoicing_list, $self->all_emails;
4697 my $email = ($conf->exists('business-onlinepayment-email-override'))
4698 ? $conf->config('business-onlinepayment-email-override')
4699 : $invoicing_list[0];
4703 if ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'CC' ) {
4705 $content{card_number} = $options{payinfo};
4706 $paydate = exists($options{'paydate'})
4707 ? $options{'paydate'}
4709 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4710 $content{expiration} = "$2/$1";
4712 my $paycvv = exists($options{'paycvv'})
4713 ? $options{'paycvv'}
4715 $content{cvv2} = $paycvv
4718 my $paystart_month = exists($options{'paystart_month'})
4719 ? $options{'paystart_month'}
4720 : $self->paystart_month;
4722 my $paystart_year = exists($options{'paystart_year'})
4723 ? $options{'paystart_year'}
4724 : $self->paystart_year;
4726 $content{card_start} = "$paystart_month/$paystart_year"
4727 if $paystart_month && $paystart_year;
4729 my $payissue = exists($options{'payissue'})
4730 ? $options{'payissue'}
4732 $content{issue_number} = $payissue if $payissue;
4734 if ( $self->_bop_recurring_billing( 'payinfo' => $options{'payinfo'},
4735 'trans_is_recur' => $trans_is_recur,
4739 $content{recurring_billing} = 'YES';
4740 $content{acct_code} = 'rebill'
4741 if $conf->exists('credit_card-recurring_billing_acct_code');
4744 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'ECHECK' ){
4745 ( $content{account_number}, $content{routing_code} ) =
4746 split('@', $options{payinfo});
4747 $content{bank_name} = $options{payname};
4748 $content{bank_state} = exists($options{'paystate'})
4749 ? $options{'paystate'}
4750 : $self->getfield('paystate');
4751 $content{account_type} = exists($options{'paytype'})
4752 ? uc($options{'paytype'}) || 'CHECKING'
4753 : uc($self->getfield('paytype')) || 'CHECKING';
4754 $content{account_name} = $self->getfield('first'). ' '.
4755 $self->getfield('last');
4757 $content{customer_org} = $self->company ? 'B' : 'I';
4758 $content{state_id} = exists($options{'stateid'})
4759 ? $options{'stateid'}
4760 : $self->getfield('stateid');
4761 $content{state_id_state} = exists($options{'stateid_state'})
4762 ? $options{'stateid_state'}
4763 : $self->getfield('stateid_state');
4764 $content{customer_ssn} = exists($options{'ss'})
4767 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'LEC' ) {
4768 $content{phone} = $options{payinfo};
4769 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
4776 # run transaction(s)
4779 my $balance = exists( $options{'balance'} )
4780 ? $options{'balance'}
4783 $self->select_for_update; #mutex ... just until we get our pending record in
4785 #the checks here are intended to catch concurrent payments
4786 #double-form-submission prevention is taken care of in cust_pay_pending::check
4789 return "The customer's balance has changed; $options{method} transaction aborted."
4790 if $self->balance < $balance;
4791 #&& $self->balance < $options{amount}; #might as well anyway?
4793 #also check and make sure there aren't *other* pending payments for this cust
4795 my @pending = qsearch('cust_pay_pending', {
4796 'custnum' => $self->custnum,
4797 'status' => { op=>'!=', value=>'done' }
4799 return "A payment is already being processed for this customer (".
4800 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
4801 "); $options{method} transaction aborted."
4802 if scalar(@pending);
4804 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
4806 my $cust_pay_pending = new FS::cust_pay_pending {
4807 'custnum' => $self->custnum,
4808 #'invnum' => $options{'invnum'},
4809 'paid' => $options{amount},
4811 'payby' => $bop_method2payby{$options{method}},
4812 'payinfo' => $options{payinfo},
4813 'paydate' => $paydate,
4814 'recurring_billing' => $content{recurring_billing},
4815 'pkgnum' => $options{'pkgnum'},
4817 'gatewaynum' => $payment_gateway->gatewaynum || '',
4818 'session_id' => $options{session_id} || '',
4819 'jobnum' => $options{depend_jobnum} || '',
4821 $cust_pay_pending->payunique( $options{payunique} )
4822 if defined($options{payunique}) && length($options{payunique});
4823 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
4824 return $cpp_new_err if $cpp_new_err;
4826 my( $action1, $action2 ) =
4827 split( /\s*\,\s*/, $payment_gateway->gateway_action );
4829 my $transaction = new $namespace( $payment_gateway->gateway_module,
4830 $self->_bop_options(\%options),
4833 $transaction->content(
4834 'type' => $options{method},
4835 $self->_bop_auth(\%options),
4836 'action' => $action1,
4837 'description' => $options{'description'},
4838 'amount' => $options{amount},
4839 #'invoice_number' => $options{'invnum'},
4840 'customer_id' => $self->custnum,
4842 'reference' => $cust_pay_pending->paypendingnum, #for now
4847 $cust_pay_pending->status('pending');
4848 my $cpp_pending_err = $cust_pay_pending->replace;
4849 return $cpp_pending_err if $cpp_pending_err;
4852 my $BOP_TESTING = 0;
4853 my $BOP_TESTING_SUCCESS = 1;
4855 unless ( $BOP_TESTING ) {
4856 $transaction->test_transaction(1)
4857 if $conf->exists('business-onlinepayment-test_transaction');
4858 $transaction->submit();
4860 if ( $BOP_TESTING_SUCCESS ) {
4861 $transaction->is_success(1);
4862 $transaction->authorization('fake auth');
4864 $transaction->is_success(0);
4865 $transaction->error_message('fake failure');
4869 if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
4871 return { reference => $cust_pay_pending->paypendingnum,
4872 map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
4874 } elsif ( $transaction->is_success() && $action2 ) {
4876 $cust_pay_pending->status('authorized');
4877 my $cpp_authorized_err = $cust_pay_pending->replace;
4878 return $cpp_authorized_err if $cpp_authorized_err;
4880 my $auth = $transaction->authorization;
4881 my $ordernum = $transaction->can('order_number')
4882 ? $transaction->order_number
4886 new Business::OnlinePayment( $payment_gateway->gateway_module,
4887 $self->_bop_options(\%options),
4892 type => $options{method},
4894 $self->_bop_auth(\%options),
4895 order_number => $ordernum,
4896 amount => $options{amount},
4897 authorization => $auth,
4898 description => $options{'description'},
4901 foreach my $field (qw( authorization_source_code returned_ACI
4902 transaction_identifier validation_code
4903 transaction_sequence_num local_transaction_date
4904 local_transaction_time AVS_result_code )) {
4905 $capture{$field} = $transaction->$field() if $transaction->can($field);
4908 $capture->content( %capture );
4910 $capture->test_transaction(1)
4911 if $conf->exists('business-onlinepayment-test_transaction');
4914 unless ( $capture->is_success ) {
4915 my $e = "Authorization successful but capture failed, custnum #".
4916 $self->custnum. ': '. $capture->result_code.
4917 ": ". $capture->error_message;
4925 # remove paycvv after initial transaction
4928 #false laziness w/misc/process/payment.cgi - check both to make sure working
4930 if ( length($self->paycvv)
4931 && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
4933 my $error = $self->remove_cvv;
4935 warn "WARNING: error removing cvv: $error\n";
4944 if ( $transaction->can('card_token') && $transaction->card_token ) {
4946 $self->card_token($transaction->card_token);
4948 if ( $options{'payinfo'} eq $self->payinfo ) {
4949 $self->payinfo($transaction->card_token);
4950 my $error = $self->replace;
4952 warn "WARNING: error storing token: $error, but proceeding anyway\n";
4962 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
4974 if (ref($_[0]) eq 'HASH') {
4975 %options = %{$_[0]};
4977 my ( $method, $amount ) = ( shift, shift );
4979 $options{method} = $method;
4980 $options{amount} = $amount;
4983 if ( $options{'fake_failure'} ) {
4984 return "Error: No error; test failure requested with fake_failure";
4988 #if ( $payment_gateway->gatewaynum ) { # agent override
4989 # $paybatch = $payment_gateway->gatewaynum. '-';
4992 #$paybatch .= "$processor:". $transaction->authorization;
4994 #$paybatch .= ':'. $transaction->order_number
4995 # if $transaction->can('order_number')
4996 # && length($transaction->order_number);
4998 my $paybatch = 'FakeProcessor:54:32';
5000 my $cust_pay = new FS::cust_pay ( {
5001 'custnum' => $self->custnum,
5002 'invnum' => $options{'invnum'},
5003 'paid' => $options{amount},
5005 'payby' => $bop_method2payby{$options{method}},
5006 #'payinfo' => $payinfo,
5007 'payinfo' => '4111111111111111',
5008 'paybatch' => $paybatch,
5009 #'paydate' => $paydate,
5010 'paydate' => '2012-05-01',
5012 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
5014 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5017 $cust_pay->invnum(''); #try again with no specific invnum
5018 my $error2 = $cust_pay->insert( $options{'manual'} ?
5019 ( 'manual' => 1 ) : ()
5022 # gah, even with transactions.
5023 my $e = 'WARNING: Card/ACH debited but database not updated - '.
5024 "error inserting (fake!) payment: $error2".
5025 " (previously tried insert with invnum #$options{'invnum'}" .
5032 if ( $options{'paynum_ref'} ) {
5033 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5036 return ''; #no error
5041 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
5043 # Wraps up processing of a realtime credit card, ACH (electronic check) or
5044 # phone bill transaction.
5046 sub _realtime_bop_result {
5047 my( $self, $cust_pay_pending, $transaction, %options ) = @_;
5049 warn "$me _realtime_bop_result: pending transaction ".
5050 $cust_pay_pending->paypendingnum. "\n";
5051 warn " $_ => $options{$_}\n" foreach keys %options;
5054 my $payment_gateway = $options{payment_gateway}
5055 or return "no payment gateway in arguments to _realtime_bop_result";
5057 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
5058 my $cpp_captured_err = $cust_pay_pending->replace;
5059 return $cpp_captured_err if $cpp_captured_err;
5061 if ( $transaction->is_success() ) {
5064 if ( $payment_gateway->gatewaynum ) { # agent override
5065 $paybatch = $payment_gateway->gatewaynum. '-';
5068 $paybatch .= $payment_gateway->gateway_module. ":".
5069 $transaction->authorization;
5071 $paybatch .= ':'. $transaction->order_number
5072 if $transaction->can('order_number')
5073 && length($transaction->order_number);
5075 my $cust_pay = new FS::cust_pay ( {
5076 'custnum' => $self->custnum,
5077 'invnum' => $options{'invnum'},
5078 'paid' => $cust_pay_pending->paid,
5080 'payby' => $cust_pay_pending->payby,
5081 'payinfo' => $options{'payinfo'},
5082 'paybatch' => $paybatch,
5083 'paydate' => $cust_pay_pending->paydate,
5084 'pkgnum' => $cust_pay_pending->pkgnum,
5086 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
5087 $cust_pay->payunique( $options{payunique} )
5088 if defined($options{payunique}) && length($options{payunique});
5090 my $oldAutoCommit = $FS::UID::AutoCommit;
5091 local $FS::UID::AutoCommit = 0;
5094 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
5096 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5099 $cust_pay->invnum(''); #try again with no specific invnum
5100 my $error2 = $cust_pay->insert( $options{'manual'} ?
5101 ( 'manual' => 1 ) : ()
5104 # gah. but at least we have a record of the state we had to abort in
5105 # from cust_pay_pending now.
5106 my $e = "WARNING: $options{method} captured but payment not recorded -".
5107 " error inserting payment (". $payment_gateway->gateway_module.
5109 " (previously tried insert with invnum #$options{'invnum'}" .
5110 ": $error ) - pending payment saved as paypendingnum ".
5111 $cust_pay_pending->paypendingnum. "\n";
5117 my $jobnum = $cust_pay_pending->jobnum;
5119 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5121 unless ( $placeholder ) {
5122 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5123 my $e = "WARNING: $options{method} captured but job $jobnum not ".
5124 "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
5129 $error = $placeholder->delete;
5132 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5133 my $e = "WARNING: $options{method} captured but could not delete ".
5134 "job $jobnum for paypendingnum ".
5135 $cust_pay_pending->paypendingnum. ": $error\n";
5142 if ( $options{'paynum_ref'} ) {
5143 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5146 $cust_pay_pending->status('done');
5147 $cust_pay_pending->statustext('captured');
5148 $cust_pay_pending->paynum($cust_pay->paynum);
5149 my $cpp_done_err = $cust_pay_pending->replace;
5151 if ( $cpp_done_err ) {
5153 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5154 my $e = "WARNING: $options{method} captured but payment not recorded - ".
5155 "error updating status for paypendingnum ".
5156 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5162 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5164 if ( $options{'apply'} ) {
5165 my $apply_error = $self->apply_payments_and_credits;
5166 if ( $apply_error ) {
5167 warn "WARNING: error applying payment: $apply_error\n";
5168 #but we still should return no error cause the payment otherwise went
5173 return ''; #no error
5179 my $perror = $payment_gateway->gateway_module. " error: ".
5180 $transaction->error_message;
5182 my $jobnum = $cust_pay_pending->jobnum;
5184 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5186 if ( $placeholder ) {
5187 my $error = $placeholder->depended_delete;
5188 $error ||= $placeholder->delete;
5189 warn "error removing provisioning jobs after declined paypendingnum ".
5190 $cust_pay_pending->paypendingnum. "\n";
5192 my $e = "error finding job $jobnum for declined paypendingnum ".
5193 $cust_pay_pending->paypendingnum. "\n";
5199 unless ( $transaction->error_message ) {
5202 if ( $transaction->can('response_page') ) {
5204 'page' => ( $transaction->can('response_page')
5205 ? $transaction->response_page
5208 'code' => ( $transaction->can('response_code')
5209 ? $transaction->response_code
5212 'headers' => ( $transaction->can('response_headers')
5213 ? $transaction->response_headers
5219 "No additional debugging information available for ".
5220 $payment_gateway->gateway_module;
5223 $perror .= "No error_message returned from ".
5224 $payment_gateway->gateway_module. " -- ".
5225 ( ref($t_response) ? Dumper($t_response) : $t_response );
5229 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
5230 && $conf->exists('emaildecline')
5231 && grep { $_ ne 'POST' } $self->invoicing_list
5232 && ! grep { $transaction->error_message =~ /$_/ }
5233 $conf->config('emaildecline-exclude')
5236 # Send a decline alert to the customer.
5237 my $msgnum = $conf->config('decline_msgnum', $self->agentnum);
5240 # include the raw error message in the transaction state
5241 $cust_pay_pending->setfield('error', $transaction->error_message);
5242 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
5243 $error = $msg_template->send( 'cust_main' => $self,
5244 'object' => $cust_pay_pending );
5248 my @templ = $conf->config('declinetemplate');
5249 my $template = new Text::Template (
5251 SOURCE => [ map "$_\n", @templ ],
5252 ) or return "($perror) can't create template: $Text::Template::ERROR";
5253 $template->compile()
5254 or return "($perror) can't compile template: $Text::Template::ERROR";
5258 scalar( $conf->config('company_name', $self->agentnum ) ),
5259 'company_address' =>
5260 join("\n", $conf->config('company_address', $self->agentnum ) ),
5261 'error' => $transaction->error_message,
5264 my $error = send_email(
5265 'from' => $conf->config('invoice_from', $self->agentnum ),
5266 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
5267 'subject' => 'Your payment could not be processed',
5268 'body' => [ $template->fill_in(HASH => $templ_hash) ],
5272 $perror .= " (also received error sending decline notification: $error)"
5277 $cust_pay_pending->status('done');
5278 $cust_pay_pending->statustext("declined: $perror");
5279 my $cpp_done_err = $cust_pay_pending->replace;
5280 if ( $cpp_done_err ) {
5281 my $e = "WARNING: $options{method} declined but pending payment not ".
5282 "resolved - error updating status for paypendingnum ".
5283 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5285 $perror = "$e ($perror)";
5293 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
5295 Verifies successful third party processing of a realtime credit card,
5296 ACH (electronic check) or phone bill transaction via a
5297 Business::OnlineThirdPartyPayment realtime gateway. See
5298 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5300 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
5302 The additional options I<payname>, I<city>, I<state>,
5303 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5304 if set, will override the value from the customer record.
5306 I<description> is a free-text field passed to the gateway. It defaults to
5307 "Internet services".
5309 If an I<invnum> is specified, this payment (if successful) is applied to the
5310 specified invoice. If you don't specify an I<invnum> you might want to
5311 call the B<apply_payments> method.
5313 I<quiet> can be set true to surpress email decline notices.
5315 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5316 resulting paynum, if any.
5318 I<payunique> is a unique identifier for this payment.
5320 Returns a hashref containing elements bill_error (which will be undefined
5321 upon success) and session_id of any associated session.
5325 sub realtime_botpp_capture {
5326 my( $self, $cust_pay_pending, %options ) = @_;
5328 warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
5329 warn " $_ => $options{$_}\n" foreach keys %options;
5332 eval "use Business::OnlineThirdPartyPayment";
5336 # select the gateway
5339 my $method = FS::payby->payby2bop($cust_pay_pending->payby);
5341 my $payment_gateway = $cust_pay_pending->gatewaynum
5342 ? qsearchs( 'payment_gateway',
5343 { gatewaynum => $cust_pay_pending->gatewaynum }
5345 : $self->agent->payment_gateway( 'method' => $method,
5346 # 'invnum' => $cust_pay_pending->invnum,
5347 # 'payinfo' => $cust_pay_pending->payinfo,
5350 $options{payment_gateway} = $payment_gateway; # for the helper subs
5356 my @invoicing_list = $self->invoicing_list_emailonly;
5357 if ( $conf->exists('emailinvoiceautoalways')
5358 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5359 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5360 push @invoicing_list, $self->all_emails;
5363 my $email = ($conf->exists('business-onlinepayment-email-override'))
5364 ? $conf->config('business-onlinepayment-email-override')
5365 : $invoicing_list[0];
5369 $content{email_customer} =
5370 ( $conf->exists('business-onlinepayment-email_customer')
5371 || $conf->exists('business-onlinepayment-email-override') );
5374 # run transaction(s)
5378 new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
5379 $self->_bop_options(\%options),
5382 $transaction->reference({ %options });
5384 $transaction->content(
5386 $self->_bop_auth(\%options),
5387 'action' => 'Post Authorization',
5388 'description' => $options{'description'},
5389 'amount' => $cust_pay_pending->paid,
5390 #'invoice_number' => $options{'invnum'},
5391 'customer_id' => $self->custnum,
5392 'referer' => 'http://cleanwhisker.420.am/',
5393 'reference' => $cust_pay_pending->paypendingnum,
5395 'phone' => $self->daytime || $self->night,
5397 # plus whatever is required for bogus capture avoidance
5400 $transaction->submit();
5403 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5406 bill_error => $error,
5407 session_id => $cust_pay_pending->session_id,
5412 =item default_payment_gateway DEPRECATED -- use agent->payment_gateway
5416 sub default_payment_gateway {
5417 my( $self, $method ) = @_;
5419 die "Real-time processing not enabled\n"
5420 unless $conf->exists('business-onlinepayment');
5422 #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
5425 my $bop_config = 'business-onlinepayment';
5426 $bop_config .= '-ach'
5427 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
5428 my ( $processor, $login, $password, $action, @bop_options ) =
5429 $conf->config($bop_config);
5430 $action ||= 'normal authorization';
5431 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
5432 die "No real-time processor is enabled - ".
5433 "did you set the business-onlinepayment configuration value?\n"
5436 ( $processor, $login, $password, $action, @bop_options )
5441 Removes the I<paycvv> field from the database directly.
5443 If there is an error, returns the error, otherwise returns false.
5449 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
5450 or return dbh->errstr;
5451 $sth->execute($self->custnum)
5452 or return $sth->errstr;
5457 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
5459 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
5460 via a Business::OnlinePayment realtime gateway. See
5461 L<http://420.am/business-onlinepayment> for supported gateways.
5463 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5465 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
5467 Most gateways require a reference to an original payment transaction to refund,
5468 so you probably need to specify a I<paynum>.
5470 I<amount> defaults to the original amount of the payment if not specified.
5472 I<reason> specifies a reason for the refund.
5474 I<paydate> specifies the expiration date for a credit card overriding the
5475 value from the customer record or the payment record. Specified as yyyy-mm-dd
5477 Implementation note: If I<amount> is unspecified or equal to the amount of the
5478 orignal payment, first an attempt is made to "void" the transaction via
5479 the gateway (to cancel a not-yet settled transaction) and then if that fails,
5480 the normal attempt is made to "refund" ("credit") the transaction via the
5481 gateway is attempted.
5483 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5484 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5485 #if set, will override the value from the customer record.
5487 #If an I<invnum> is specified, this payment (if successful) is applied to the
5488 #specified invoice. If you don't specify an I<invnum> you might want to
5489 #call the B<apply_payments> method.
5493 #some false laziness w/realtime_bop, not enough to make it worth merging
5494 #but some useful small subs should be pulled out
5495 sub realtime_refund_bop {
5499 if (ref($_[0]) eq 'HASH') {
5500 %options = %{$_[0]};
5504 $options{method} = $method;
5508 warn "$me realtime_refund_bop (new): $options{method} refund\n";
5509 warn " $_ => $options{$_}\n" foreach keys %options;
5513 # look up the original payment and optionally a gateway for that payment
5517 my $amount = $options{'amount'};
5519 my( $processor, $login, $password, @bop_options, $namespace ) ;
5520 my( $auth, $order_number ) = ( '', '', '' );
5522 if ( $options{'paynum'} ) {
5524 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
5525 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
5526 or return "Unknown paynum $options{'paynum'}";
5527 $amount ||= $cust_pay->paid;
5529 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
5530 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
5531 $cust_pay->paybatch;
5532 my $gatewaynum = '';
5533 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
5535 if ( $gatewaynum ) { #gateway for the payment to be refunded
5537 my $payment_gateway =
5538 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
5539 die "payment gateway $gatewaynum not found"
5540 unless $payment_gateway;
5542 $processor = $payment_gateway->gateway_module;
5543 $login = $payment_gateway->gateway_username;
5544 $password = $payment_gateway->gateway_password;
5545 $namespace = $payment_gateway->gateway_namespace;
5546 @bop_options = $payment_gateway->options;
5548 } else { #try the default gateway
5551 my $payment_gateway =
5552 $self->agent->payment_gateway('method' => $options{method});
5554 ( $conf_processor, $login, $password, $namespace ) =
5555 map { my $method = "gateway_$_"; $payment_gateway->$method }
5556 qw( module username password namespace );
5558 @bop_options = $payment_gateway->gatewaynum
5559 ? $payment_gateway->options
5560 : @{ $payment_gateway->get('options') };
5562 return "processor of payment $options{'paynum'} $processor does not".
5563 " match default processor $conf_processor"
5564 unless $processor eq $conf_processor;
5569 } else { # didn't specify a paynum, so look for agent gateway overrides
5570 # like a normal transaction
5572 my $payment_gateway =
5573 $self->agent->payment_gateway( 'method' => $options{method},
5574 #'payinfo' => $payinfo,
5576 my( $processor, $login, $password, $namespace ) =
5577 map { my $method = "gateway_$_"; $payment_gateway->$method }
5578 qw( module username password namespace );
5580 my @bop_options = $payment_gateway->gatewaynum
5581 ? $payment_gateway->options
5582 : @{ $payment_gateway->get('options') };
5585 return "neither amount nor paynum specified" unless $amount;
5587 eval "use $namespace";
5591 'type' => $options{method},
5593 'password' => $password,
5594 'order_number' => $order_number,
5595 'amount' => $amount,
5596 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
5598 $content{authorization} = $auth
5599 if length($auth); #echeck/ACH transactions have an order # but no auth
5600 #(at least with authorize.net)
5602 my $disable_void_after;
5603 if ($conf->exists('disable_void_after')
5604 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
5605 $disable_void_after = $1;
5608 #first try void if applicable
5609 if ( $cust_pay && $cust_pay->paid == $amount
5611 ( not defined($disable_void_after) )
5612 || ( time < ($cust_pay->_date + $disable_void_after ) )
5615 warn " attempting void\n" if $DEBUG > 1;
5616 my $void = new Business::OnlinePayment( $processor, @bop_options );
5617 if ( $void->can('info') ) {
5618 if ( $cust_pay->payby eq 'CARD'
5619 && $void->info('CC_void_requires_card') )
5621 $content{'card_number'} = $cust_pay->payinfo;
5622 } elsif ( $cust_pay->payby eq 'CHEK'
5623 && $void->info('ECHECK_void_requires_account') )
5625 ( $content{'account_number'}, $content{'routing_code'} ) =
5626 split('@', $cust_pay->payinfo);
5627 $content{'name'} = $self->get('first'). ' '. $self->get('last');
5630 $void->content( 'action' => 'void', %content );
5631 $void->test_transaction(1)
5632 if $conf->exists('business-onlinepayment-test_transaction');
5634 if ( $void->is_success ) {
5635 my $error = $cust_pay->void($options{'reason'});
5637 # gah, even with transactions.
5638 my $e = 'WARNING: Card/ACH voided but database not updated - '.
5639 "error voiding payment: $error";
5643 warn " void successful\n" if $DEBUG > 1;
5648 warn " void unsuccessful, trying refund\n"
5652 my $address = $self->address1;
5653 $address .= ", ". $self->address2 if $self->address2;
5655 my($payname, $payfirst, $paylast);
5656 if ( $self->payname && $options{method} ne 'ECHECK' ) {
5657 $payname = $self->payname;
5658 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5659 or return "Illegal payname $payname";
5660 ($payfirst, $paylast) = ($1, $2);
5662 $payfirst = $self->getfield('first');
5663 $paylast = $self->getfield('last');
5664 $payname = "$payfirst $paylast";
5667 my @invoicing_list = $self->invoicing_list_emailonly;
5668 if ( $conf->exists('emailinvoiceautoalways')
5669 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5670 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5671 push @invoicing_list, $self->all_emails;
5674 my $email = ($conf->exists('business-onlinepayment-email-override'))
5675 ? $conf->config('business-onlinepayment-email-override')
5676 : $invoicing_list[0];
5678 my $payip = exists($options{'payip'})
5681 $content{customer_ip} = $payip
5685 if ( $options{method} eq 'CC' ) {
5688 $content{card_number} = $payinfo = $cust_pay->payinfo;
5689 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
5690 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
5691 ($content{expiration} = "$2/$1"); # where available
5693 $content{card_number} = $payinfo = $self->payinfo;
5694 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
5695 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
5696 $content{expiration} = "$2/$1";
5699 } elsif ( $options{method} eq 'ECHECK' ) {
5702 $payinfo = $cust_pay->payinfo;
5704 $payinfo = $self->payinfo;
5706 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
5707 $content{bank_name} = $self->payname;
5708 $content{account_type} = 'CHECKING';
5709 $content{account_name} = $payname;
5710 $content{customer_org} = $self->company ? 'B' : 'I';
5711 $content{customer_ssn} = $self->ss;
5712 } elsif ( $options{method} eq 'LEC' ) {
5713 $content{phone} = $payinfo = $self->payinfo;
5717 my $refund = new Business::OnlinePayment( $processor, @bop_options );
5718 my %sub_content = $refund->content(
5719 'action' => 'credit',
5720 'customer_id' => $self->custnum,
5721 'last_name' => $paylast,
5722 'first_name' => $payfirst,
5724 'address' => $address,
5725 'city' => $self->city,
5726 'state' => $self->state,
5727 'zip' => $self->zip,
5728 'country' => $self->country,
5730 'phone' => $self->daytime || $self->night,
5733 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
5735 $refund->test_transaction(1)
5736 if $conf->exists('business-onlinepayment-test_transaction');
5739 return "$processor error: ". $refund->error_message
5740 unless $refund->is_success();
5742 my $paybatch = "$processor:". $refund->authorization;
5743 $paybatch .= ':'. $refund->order_number
5744 if $refund->can('order_number') && $refund->order_number;
5746 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
5747 my @cust_bill_pay = $cust_pay->cust_bill_pay;
5748 last unless @cust_bill_pay;
5749 my $cust_bill_pay = pop @cust_bill_pay;
5750 my $error = $cust_bill_pay->delete;
5754 my $cust_refund = new FS::cust_refund ( {
5755 'custnum' => $self->custnum,
5756 'paynum' => $options{'paynum'},
5757 'refund' => $amount,
5759 'payby' => $bop_method2payby{$options{method}},
5760 'payinfo' => $payinfo,
5761 'paybatch' => $paybatch,
5762 'reason' => $options{'reason'} || 'card or ACH refund',
5764 my $error = $cust_refund->insert;
5766 $cust_refund->paynum(''); #try again with no specific paynum
5767 my $error2 = $cust_refund->insert;
5769 # gah, even with transactions.
5770 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
5771 "error inserting refund ($processor): $error2".
5772 " (previously tried insert with paynum #$options{'paynum'}" .
5783 =item batch_card OPTION => VALUE...
5785 Adds a payment for this invoice to the pending credit card batch (see
5786 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
5787 runs the payment using a realtime gateway.
5792 my ($self, %options) = @_;
5795 if (exists($options{amount})) {
5796 $amount = $options{amount};
5798 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
5800 return '' unless $amount > 0;
5802 my $invnum = delete $options{invnum};
5803 my $payby = $options{invnum} || $self->payby; #dubious
5805 if ($options{'realtime'}) {
5806 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
5812 my $oldAutoCommit = $FS::UID::AutoCommit;
5813 local $FS::UID::AutoCommit = 0;
5816 #this needs to handle mysql as well as Pg, like svc_acct.pm
5817 #(make it into a common function if folks need to do batching with mysql)
5818 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
5819 or return "Cannot lock pay_batch: " . $dbh->errstr;
5823 'payby' => FS::payby->payby2payment($payby),
5826 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
5828 unless ( $pay_batch ) {
5829 $pay_batch = new FS::pay_batch \%pay_batch;
5830 my $error = $pay_batch->insert;
5832 $dbh->rollback if $oldAutoCommit;
5833 die "error creating new batch: $error\n";
5837 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
5838 'batchnum' => $pay_batch->batchnum,
5839 'custnum' => $self->custnum,
5842 foreach (qw( address1 address2 city state zip country payby payinfo paydate
5844 $options{$_} = '' unless exists($options{$_});
5847 my $cust_pay_batch = new FS::cust_pay_batch ( {
5848 'batchnum' => $pay_batch->batchnum,
5849 'invnum' => $invnum || 0, # is there a better value?
5850 # this field should be
5852 # cust_bill_pay_batch now
5853 'custnum' => $self->custnum,
5854 'last' => $self->getfield('last'),
5855 'first' => $self->getfield('first'),
5856 'address1' => $options{address1} || $self->address1,
5857 'address2' => $options{address2} || $self->address2,
5858 'city' => $options{city} || $self->city,
5859 'state' => $options{state} || $self->state,
5860 'zip' => $options{zip} || $self->zip,
5861 'country' => $options{country} || $self->country,
5862 'payby' => $options{payby} || $self->payby,
5863 'payinfo' => $options{payinfo} || $self->payinfo,
5864 'exp' => $options{paydate} || $self->paydate,
5865 'payname' => $options{payname} || $self->payname,
5866 'amount' => $amount, # consolidating
5869 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
5870 if $old_cust_pay_batch;
5873 if ($old_cust_pay_batch) {
5874 $error = $cust_pay_batch->replace($old_cust_pay_batch)
5876 $error = $cust_pay_batch->insert;
5880 $dbh->rollback if $oldAutoCommit;
5884 my $unapplied = $self->total_unapplied_credits
5885 + $self->total_unapplied_payments
5886 + $self->in_transit_payments;
5887 foreach my $cust_bill ($self->open_cust_bill) {
5888 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
5889 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
5890 'invnum' => $cust_bill->invnum,
5891 'paybatchnum' => $cust_pay_batch->paybatchnum,
5892 'amount' => $cust_bill->owed,
5895 if ($unapplied >= $cust_bill_pay_batch->amount){
5896 $unapplied -= $cust_bill_pay_batch->amount;
5899 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
5900 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
5902 $error = $cust_bill_pay_batch->insert;
5904 $dbh->rollback if $oldAutoCommit;
5909 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5913 =item apply_payments_and_credits [ OPTION => VALUE ... ]
5915 Applies unapplied payments and credits.
5917 In most cases, this new method should be used in place of sequential
5918 apply_payments and apply_credits methods.
5920 A hash of optional arguments may be passed. Currently "manual" is supported.
5921 If true, a payment receipt is sent instead of a statement when
5922 'payment_receipt_email' configuration option is set.
5924 If there is an error, returns the error, otherwise returns false.
5928 sub apply_payments_and_credits {
5929 my( $self, %options ) = @_;
5931 local $SIG{HUP} = 'IGNORE';
5932 local $SIG{INT} = 'IGNORE';
5933 local $SIG{QUIT} = 'IGNORE';
5934 local $SIG{TERM} = 'IGNORE';
5935 local $SIG{TSTP} = 'IGNORE';
5936 local $SIG{PIPE} = 'IGNORE';
5938 my $oldAutoCommit = $FS::UID::AutoCommit;
5939 local $FS::UID::AutoCommit = 0;
5942 $self->select_for_update; #mutex
5944 foreach my $cust_bill ( $self->open_cust_bill ) {
5945 my $error = $cust_bill->apply_payments_and_credits(%options);
5947 $dbh->rollback if $oldAutoCommit;
5948 return "Error applying: $error";
5952 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5957 =item apply_credits OPTION => VALUE ...
5959 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
5960 to outstanding invoice balances in chronological order (or reverse
5961 chronological order if the I<order> option is set to B<newest>) and returns the
5962 value of any remaining unapplied credits available for refund (see
5963 L<FS::cust_refund>).
5965 Dies if there is an error.
5973 local $SIG{HUP} = 'IGNORE';
5974 local $SIG{INT} = 'IGNORE';
5975 local $SIG{QUIT} = 'IGNORE';
5976 local $SIG{TERM} = 'IGNORE';
5977 local $SIG{TSTP} = 'IGNORE';
5978 local $SIG{PIPE} = 'IGNORE';
5980 my $oldAutoCommit = $FS::UID::AutoCommit;
5981 local $FS::UID::AutoCommit = 0;
5984 $self->select_for_update; #mutex
5986 unless ( $self->total_unapplied_credits ) {
5987 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5991 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
5992 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
5994 my @invoices = $self->open_cust_bill;
5995 @invoices = sort { $b->_date <=> $a->_date } @invoices
5996 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
5998 if ( $conf->exists('pkg-balances') ) {
5999 # limit @credits to those w/ a pkgnum grepped from $self
6001 foreach my $i (@invoices) {
6002 foreach my $li ( $i->cust_bill_pkg ) {
6003 $pkgnums{$li->pkgnum} = 1;
6006 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
6011 foreach my $cust_bill ( @invoices ) {
6013 if ( !defined($credit) || $credit->credited == 0) {
6014 $credit = pop @credits or last;
6018 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
6019 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
6021 $owed = $cust_bill->owed;
6023 unless ( $owed > 0 ) {
6024 push @credits, $credit;
6028 my $amount = min( $credit->credited, $owed );
6030 my $cust_credit_bill = new FS::cust_credit_bill ( {
6031 'crednum' => $credit->crednum,
6032 'invnum' => $cust_bill->invnum,
6033 'amount' => $amount,
6035 $cust_credit_bill->pkgnum( $credit->pkgnum )
6036 if $conf->exists('pkg-balances') && $credit->pkgnum;
6037 my $error = $cust_credit_bill->insert;
6039 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6043 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6047 my $total_unapplied_credits = $self->total_unapplied_credits;
6049 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6051 return $total_unapplied_credits;
6054 =item apply_payments [ OPTION => VALUE ... ]
6056 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
6057 to outstanding invoice balances in chronological order.
6059 #and returns the value of any remaining unapplied payments.
6061 A hash of optional arguments may be passed. Currently "manual" is supported.
6062 If true, a payment receipt is sent instead of a statement when
6063 'payment_receipt_email' configuration option is set.
6065 Dies if there is an error.
6069 sub apply_payments {
6070 my( $self, %options ) = @_;
6072 local $SIG{HUP} = 'IGNORE';
6073 local $SIG{INT} = 'IGNORE';
6074 local $SIG{QUIT} = 'IGNORE';
6075 local $SIG{TERM} = 'IGNORE';
6076 local $SIG{TSTP} = 'IGNORE';
6077 local $SIG{PIPE} = 'IGNORE';
6079 my $oldAutoCommit = $FS::UID::AutoCommit;
6080 local $FS::UID::AutoCommit = 0;
6083 $self->select_for_update; #mutex
6087 my @payments = sort { $b->_date <=> $a->_date }
6088 grep { $_->unapplied > 0 }
6091 my @invoices = sort { $a->_date <=> $b->_date}
6092 grep { $_->owed > 0 }
6095 if ( $conf->exists('pkg-balances') ) {
6096 # limit @payments to those w/ a pkgnum grepped from $self
6098 foreach my $i (@invoices) {
6099 foreach my $li ( $i->cust_bill_pkg ) {
6100 $pkgnums{$li->pkgnum} = 1;
6103 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
6108 foreach my $cust_bill ( @invoices ) {
6110 if ( !defined($payment) || $payment->unapplied == 0 ) {
6111 $payment = pop @payments or last;
6115 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
6116 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
6118 $owed = $cust_bill->owed;
6120 unless ( $owed > 0 ) {
6121 push @payments, $payment;
6125 my $amount = min( $payment->unapplied, $owed );
6127 my $cust_bill_pay = new FS::cust_bill_pay ( {
6128 'paynum' => $payment->paynum,
6129 'invnum' => $cust_bill->invnum,
6130 'amount' => $amount,
6132 $cust_bill_pay->pkgnum( $payment->pkgnum )
6133 if $conf->exists('pkg-balances') && $payment->pkgnum;
6134 my $error = $cust_bill_pay->insert(%options);
6136 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6140 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6144 my $total_unapplied_payments = $self->total_unapplied_payments;
6146 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6148 return $total_unapplied_payments;
6153 Returns the total owed for this customer on all invoices
6154 (see L<FS::cust_bill/owed>).
6160 $self->total_owed_date(2145859200); #12/31/2037
6163 =item total_owed_date TIME
6165 Returns the total owed for this customer on all invoices with date earlier than
6166 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6167 see L<Time::Local> and L<Date::Parse> for conversion functions.
6171 sub total_owed_date {
6175 my $custnum = $self->custnum;
6177 my $owed_sql = FS::cust_bill->owed_sql;
6180 SELECT SUM($owed_sql) FROM cust_bill
6181 WHERE custnum = $custnum
6185 sprintf( "%.2f", $self->scalar_sql($sql) );
6189 =item total_owed_pkgnum PKGNUM
6191 Returns the total owed on all invoices for this customer's specific package
6192 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
6196 sub total_owed_pkgnum {
6197 my( $self, $pkgnum ) = @_;
6198 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
6201 =item total_owed_date_pkgnum TIME PKGNUM
6203 Returns the total owed for this customer's specific package when using
6204 experimental package balances on all invoices with date earlier than
6205 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6206 see L<Time::Local> and L<Date::Parse> for conversion functions.
6210 sub total_owed_date_pkgnum {
6211 my( $self, $time, $pkgnum ) = @_;
6214 foreach my $cust_bill (
6215 grep { $_->_date <= $time }
6216 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6218 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
6220 sprintf( "%.2f", $total_bill );
6226 Returns the total amount of all payments.
6233 $total += $_->paid foreach $self->cust_pay;
6234 sprintf( "%.2f", $total );
6237 =item total_unapplied_credits
6239 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6240 customer. See L<FS::cust_credit/credited>.
6242 =item total_credited
6244 Old name for total_unapplied_credits. Don't use.
6248 sub total_credited {
6249 #carp "total_credited deprecated, use total_unapplied_credits";
6250 shift->total_unapplied_credits(@_);
6253 sub total_unapplied_credits {
6256 my $custnum = $self->custnum;
6258 my $unapplied_sql = FS::cust_credit->unapplied_sql;
6261 SELECT SUM($unapplied_sql) FROM cust_credit
6262 WHERE custnum = $custnum
6265 sprintf( "%.2f", $self->scalar_sql($sql) );
6269 =item total_unapplied_credits_pkgnum PKGNUM
6271 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6272 customer. See L<FS::cust_credit/credited>.
6276 sub total_unapplied_credits_pkgnum {
6277 my( $self, $pkgnum ) = @_;
6278 my $total_credit = 0;
6279 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
6280 sprintf( "%.2f", $total_credit );
6284 =item total_unapplied_payments
6286 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
6287 See L<FS::cust_pay/unapplied>.
6291 sub total_unapplied_payments {
6294 my $custnum = $self->custnum;
6296 my $unapplied_sql = FS::cust_pay->unapplied_sql;
6299 SELECT SUM($unapplied_sql) FROM cust_pay
6300 WHERE custnum = $custnum
6303 sprintf( "%.2f", $self->scalar_sql($sql) );
6307 =item total_unapplied_payments_pkgnum PKGNUM
6309 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
6310 specific package when using experimental package balances. See
6311 L<FS::cust_pay/unapplied>.
6315 sub total_unapplied_payments_pkgnum {
6316 my( $self, $pkgnum ) = @_;
6317 my $total_unapplied = 0;
6318 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
6319 sprintf( "%.2f", $total_unapplied );
6323 =item total_unapplied_refunds
6325 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
6326 customer. See L<FS::cust_refund/unapplied>.
6330 sub total_unapplied_refunds {
6332 my $custnum = $self->custnum;
6334 my $unapplied_sql = FS::cust_refund->unapplied_sql;
6337 SELECT SUM($unapplied_sql) FROM cust_refund
6338 WHERE custnum = $custnum
6341 sprintf( "%.2f", $self->scalar_sql($sql) );
6347 Returns the balance for this customer (total_owed plus total_unrefunded, minus
6348 total_unapplied_credits minus total_unapplied_payments).
6354 $self->balance_date_range;
6357 =item balance_date TIME
6359 Returns the balance for this customer, only considering invoices with date
6360 earlier than TIME (total_owed_date minus total_credited minus
6361 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
6362 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
6369 $self->balance_date_range(shift);
6372 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
6374 Returns the balance for this customer, optionally considering invoices with
6375 date earlier than START_TIME, and not later than END_TIME
6376 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
6378 Times are specified as SQL fragments or numeric
6379 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
6380 L<Date::Parse> for conversion functions. The empty string can be passed
6381 to disable that time constraint completely.
6383 Available options are:
6387 =item unapplied_date
6389 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)
6395 sub balance_date_range {
6397 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
6398 ') FROM cust_main WHERE custnum='. $self->custnum;
6399 sprintf( '%.2f', $self->scalar_sql($sql) );
6402 =item balance_pkgnum PKGNUM
6404 Returns the balance for this customer's specific package when using
6405 experimental package balances (total_owed plus total_unrefunded, minus
6406 total_unapplied_credits minus total_unapplied_payments)
6410 sub balance_pkgnum {
6411 my( $self, $pkgnum ) = @_;
6414 $self->total_owed_pkgnum($pkgnum)
6415 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
6416 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
6417 - $self->total_unapplied_credits_pkgnum($pkgnum)
6418 - $self->total_unapplied_payments_pkgnum($pkgnum)
6422 =item in_transit_payments
6424 Returns the total of requests for payments for this customer pending in
6425 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
6429 sub in_transit_payments {
6431 my $in_transit_payments = 0;
6432 foreach my $pay_batch ( qsearch('pay_batch', {
6435 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
6436 'batchnum' => $pay_batch->batchnum,
6437 'custnum' => $self->custnum,
6439 $in_transit_payments += $cust_pay_batch->amount;
6442 sprintf( "%.2f", $in_transit_payments );
6447 Returns a hash of useful information for making a payment.
6457 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
6458 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
6459 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
6463 For credit card transactions:
6475 For electronic check transactions:
6490 $return{balance} = $self->balance;
6492 $return{payname} = $self->payname
6493 || ( $self->first. ' '. $self->get('last') );
6495 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
6497 $return{payby} = $self->payby;
6498 $return{stateid_state} = $self->stateid_state;
6500 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
6501 $return{card_type} = cardtype($self->payinfo);
6502 $return{payinfo} = $self->paymask;
6504 @return{'month', 'year'} = $self->paydate_monthyear;
6508 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
6509 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
6510 $return{payinfo1} = $payinfo1;
6511 $return{payinfo2} = $payinfo2;
6512 $return{paytype} = $self->paytype;
6513 $return{paystate} = $self->paystate;
6517 #doubleclick protection
6519 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
6525 =item paydate_monthyear
6527 Returns a two-element list consisting of the month and year of this customer's
6528 paydate (credit card expiration date for CARD customers)
6532 sub paydate_monthyear {
6534 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
6536 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
6543 =item tax_exemption TAXNAME
6548 my( $self, $taxname ) = @_;
6550 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
6551 'taxname' => $taxname,
6556 =item cust_main_exemption
6560 sub cust_main_exemption {
6562 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
6565 =item invoicing_list [ ARRAYREF ]
6567 If an arguement is given, sets these email addresses as invoice recipients
6568 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
6569 (except as warnings), so use check_invoicing_list first.
6571 Returns a list of email addresses (with svcnum entries expanded).
6573 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
6574 check it without disturbing anything by passing nothing.
6576 This interface may change in the future.
6580 sub invoicing_list {
6581 my( $self, $arrayref ) = @_;
6584 my @cust_main_invoice;
6585 if ( $self->custnum ) {
6586 @cust_main_invoice =
6587 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6589 @cust_main_invoice = ();
6591 foreach my $cust_main_invoice ( @cust_main_invoice ) {
6592 #warn $cust_main_invoice->destnum;
6593 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
6594 #warn $cust_main_invoice->destnum;
6595 my $error = $cust_main_invoice->delete;
6596 warn $error if $error;
6599 if ( $self->custnum ) {
6600 @cust_main_invoice =
6601 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6603 @cust_main_invoice = ();
6605 my %seen = map { $_->address => 1 } @cust_main_invoice;
6606 foreach my $address ( @{$arrayref} ) {
6607 next if exists $seen{$address} && $seen{$address};
6608 $seen{$address} = 1;
6609 my $cust_main_invoice = new FS::cust_main_invoice ( {
6610 'custnum' => $self->custnum,
6613 my $error = $cust_main_invoice->insert;
6614 warn $error if $error;
6618 if ( $self->custnum ) {
6620 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6627 =item check_invoicing_list ARRAYREF
6629 Checks these arguements as valid input for the invoicing_list method. If there
6630 is an error, returns the error, otherwise returns false.
6634 sub check_invoicing_list {
6635 my( $self, $arrayref ) = @_;
6637 foreach my $address ( @$arrayref ) {
6639 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
6640 return 'Can\'t add FAX invoice destination with a blank FAX number.';
6643 my $cust_main_invoice = new FS::cust_main_invoice ( {
6644 'custnum' => $self->custnum,
6647 my $error = $self->custnum
6648 ? $cust_main_invoice->check
6649 : $cust_main_invoice->checkdest
6651 return $error if $error;
6655 return "Email address required"
6656 if $conf->exists('cust_main-require_invoicing_list_email')
6657 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
6662 =item set_default_invoicing_list
6664 Sets the invoicing list to all accounts associated with this customer,
6665 overwriting any previous invoicing list.
6669 sub set_default_invoicing_list {
6671 $self->invoicing_list($self->all_emails);
6676 Returns the email addresses of all accounts provisioned for this customer.
6683 foreach my $cust_pkg ( $self->all_pkgs ) {
6684 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
6686 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
6687 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
6689 $list{$_}=1 foreach map { $_->email } @svc_acct;
6694 =item invoicing_list_addpost
6696 Adds postal invoicing to this customer. If this customer is already configured
6697 to receive postal invoices, does nothing.
6701 sub invoicing_list_addpost {
6703 return if grep { $_ eq 'POST' } $self->invoicing_list;
6704 my @invoicing_list = $self->invoicing_list;
6705 push @invoicing_list, 'POST';
6706 $self->invoicing_list(\@invoicing_list);
6709 =item invoicing_list_emailonly
6711 Returns the list of email invoice recipients (invoicing_list without non-email
6712 destinations such as POST and FAX).
6716 sub invoicing_list_emailonly {
6718 warn "$me invoicing_list_emailonly called"
6720 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
6723 =item invoicing_list_emailonly_scalar
6725 Returns the list of email invoice recipients (invoicing_list without non-email
6726 destinations such as POST and FAX) as a comma-separated scalar.
6730 sub invoicing_list_emailonly_scalar {
6732 warn "$me invoicing_list_emailonly_scalar called"
6734 join(', ', $self->invoicing_list_emailonly);
6737 =item referral_custnum_cust_main
6739 Returns the customer who referred this customer (or the empty string, if
6740 this customer was not referred).
6742 Note the difference with referral_cust_main method: This method,
6743 referral_custnum_cust_main returns the single customer (if any) who referred
6744 this customer, while referral_cust_main returns an array of customers referred
6749 sub referral_custnum_cust_main {
6751 return '' unless $self->referral_custnum;
6752 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
6755 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
6757 Returns an array of customers referred by this customer (referral_custnum set
6758 to this custnum). If DEPTH is given, recurses up to the given depth, returning
6759 customers referred by customers referred by this customer and so on, inclusive.
6760 The default behavior is DEPTH 1 (no recursion).
6762 Note the difference with referral_custnum_cust_main method: This method,
6763 referral_cust_main, returns an array of customers referred BY this customer,
6764 while referral_custnum_cust_main returns the single customer (if any) who
6765 referred this customer.
6769 sub referral_cust_main {
6771 my $depth = @_ ? shift : 1;
6772 my $exclude = @_ ? shift : {};
6775 map { $exclude->{$_->custnum}++; $_; }
6776 grep { ! $exclude->{ $_->custnum } }
6777 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
6781 map { $_->referral_cust_main($depth-1, $exclude) }
6788 =item referral_cust_main_ncancelled
6790 Same as referral_cust_main, except only returns customers with uncancelled
6795 sub referral_cust_main_ncancelled {
6797 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
6800 =item referral_cust_pkg [ DEPTH ]
6802 Like referral_cust_main, except returns a flat list of all unsuspended (and
6803 uncancelled) packages for each customer. The number of items in this list may
6804 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
6808 sub referral_cust_pkg {
6810 my $depth = @_ ? shift : 1;
6812 map { $_->unsuspended_pkgs }
6813 grep { $_->unsuspended_pkgs }
6814 $self->referral_cust_main($depth);
6817 =item referring_cust_main
6819 Returns the single cust_main record for the customer who referred this customer
6820 (referral_custnum), or false.
6824 sub referring_cust_main {
6826 return '' unless $self->referral_custnum;
6827 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
6830 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
6832 Applies a credit to this customer. If there is an error, returns the error,
6833 otherwise returns false.
6835 REASON can be a text string, an FS::reason object, or a scalar reference to
6836 a reasonnum. If a text string, it will be automatically inserted as a new
6837 reason, and a 'reason_type' option must be passed to indicate the
6838 FS::reason_type for the new reason.
6840 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
6842 Any other options are passed to FS::cust_credit::insert.
6847 my( $self, $amount, $reason, %options ) = @_;
6849 my $cust_credit = new FS::cust_credit {
6850 'custnum' => $self->custnum,
6851 'amount' => $amount,
6854 if ( ref($reason) ) {
6856 if ( ref($reason) eq 'SCALAR' ) {
6857 $cust_credit->reasonnum( $$reason );
6859 $cust_credit->reasonnum( $reason->reasonnum );
6863 $cust_credit->set('reason', $reason)
6866 for (qw( addlinfo eventnum )) {
6867 $cust_credit->$_( delete $options{$_} )
6868 if exists($options{$_});
6871 $cust_credit->insert(%options);
6875 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
6877 Creates a one-time charge for this customer. If there is an error, returns
6878 the error, otherwise returns false.
6880 New-style, with a hashref of options:
6882 my $error = $cust_main->charge(
6886 'start_date' => str2time('7/4/2009'),
6887 'pkg' => 'Description',
6888 'comment' => 'Comment',
6889 'additional' => [], #extra invoice detail
6890 'classnum' => 1, #pkg_class
6892 'setuptax' => '', # or 'Y' for tax exempt
6895 'taxclass' => 'Tax class',
6898 'taxproduct' => 2, #part_pkg_taxproduct
6899 'override' => {}, #XXX describe
6901 #will be filled in with the new object
6902 'cust_pkg_ref' => \$cust_pkg,
6904 #generate an invoice immediately
6906 'invoice_terms' => '', #with these terms
6912 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
6918 my ( $amount, $quantity, $start_date, $classnum );
6919 my ( $pkg, $comment, $additional );
6920 my ( $setuptax, $taxclass ); #internal taxes
6921 my ( $taxproduct, $override ); #vendor (CCH) taxes
6923 my $cust_pkg_ref = '';
6924 my ( $bill_now, $invoice_terms ) = ( 0, '' );
6925 if ( ref( $_[0] ) ) {
6926 $amount = $_[0]->{amount};
6927 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
6928 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
6929 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
6930 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
6931 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
6932 : '$'. sprintf("%.2f",$amount);
6933 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
6934 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
6935 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
6936 $additional = $_[0]->{additional} || [];
6937 $taxproduct = $_[0]->{taxproductnum};
6938 $override = { '' => $_[0]->{tax_override} };
6939 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
6940 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
6941 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
6946 $pkg = @_ ? shift : 'One-time charge';
6947 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
6949 $taxclass = @_ ? shift : '';
6953 local $SIG{HUP} = 'IGNORE';
6954 local $SIG{INT} = 'IGNORE';
6955 local $SIG{QUIT} = 'IGNORE';
6956 local $SIG{TERM} = 'IGNORE';
6957 local $SIG{TSTP} = 'IGNORE';
6958 local $SIG{PIPE} = 'IGNORE';
6960 my $oldAutoCommit = $FS::UID::AutoCommit;
6961 local $FS::UID::AutoCommit = 0;
6964 my $part_pkg = new FS::part_pkg ( {
6966 'comment' => $comment,
6970 'classnum' => ( $classnum ? $classnum : '' ),
6971 'setuptax' => $setuptax,
6972 'taxclass' => $taxclass,
6973 'taxproductnum' => $taxproduct,
6976 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
6977 ( 0 .. @$additional - 1 )
6979 'additional_count' => scalar(@$additional),
6980 'setup_fee' => $amount,
6983 my $error = $part_pkg->insert( options => \%options,
6984 tax_overrides => $override,
6987 $dbh->rollback if $oldAutoCommit;
6991 my $pkgpart = $part_pkg->pkgpart;
6992 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
6993 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
6994 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
6995 $error = $type_pkgs->insert;
6997 $dbh->rollback if $oldAutoCommit;
7002 my $cust_pkg = new FS::cust_pkg ( {
7003 'custnum' => $self->custnum,
7004 'pkgpart' => $pkgpart,
7005 'quantity' => $quantity,
7006 'start_date' => $start_date,
7007 'no_auto' => $no_auto,
7010 $error = $cust_pkg->insert;
7012 $dbh->rollback if $oldAutoCommit;
7014 } elsif ( $cust_pkg_ref ) {
7015 ${$cust_pkg_ref} = $cust_pkg;
7019 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
7020 'pkg_list' => [ $cust_pkg ],
7023 $dbh->rollback if $oldAutoCommit;
7028 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
7033 #=item charge_postal_fee
7035 #Applies a one time charge this customer. If there is an error,
7036 #returns the error, returns the cust_pkg charge object or false
7037 #if there was no charge.
7041 # This should be a customer event. For that to work requires that bill
7042 # also be a customer event.
7044 sub charge_postal_fee {
7047 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
7048 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
7050 my $cust_pkg = new FS::cust_pkg ( {
7051 'custnum' => $self->custnum,
7052 'pkgpart' => $pkgpart,
7056 my $error = $cust_pkg->insert;
7057 $error ? $error : $cust_pkg;
7062 Returns all the invoices (see L<FS::cust_bill>) for this customer.
7068 map { $_ } #return $self->num_cust_bill unless wantarray;
7069 sort { $a->_date <=> $b->_date }
7070 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
7073 =item open_cust_bill
7075 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
7080 sub open_cust_bill {
7084 'table' => 'cust_bill',
7085 'hashref' => { 'custnum' => $self->custnum, },
7086 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
7087 'order_by' => 'ORDER BY _date ASC',
7092 =item cust_statements
7094 Returns all the statements (see L<FS::cust_statement>) for this customer.
7098 sub cust_statement {
7100 map { $_ } #return $self->num_cust_statement unless wantarray;
7101 sort { $a->_date <=> $b->_date }
7102 qsearch('cust_statement', { 'custnum' => $self->custnum, } )
7107 Returns all the credits (see L<FS::cust_credit>) for this customer.
7113 map { $_ } #return $self->num_cust_credit unless wantarray;
7114 sort { $a->_date <=> $b->_date }
7115 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
7118 =item cust_credit_pkgnum
7120 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
7121 package when using experimental package balances.
7125 sub cust_credit_pkgnum {
7126 my( $self, $pkgnum ) = @_;
7127 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
7128 sort { $a->_date <=> $b->_date }
7129 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
7130 'pkgnum' => $pkgnum,
7137 Returns all the payments (see L<FS::cust_pay>) for this customer.
7143 return $self->num_cust_pay unless wantarray;
7144 sort { $a->_date <=> $b->_date }
7145 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
7150 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
7151 called automatically when the cust_pay method is used in a scalar context.
7157 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
7158 my $sth = dbh->prepare($sql) or die dbh->errstr;
7159 $sth->execute($self->custnum) or die $sth->errstr;
7160 $sth->fetchrow_arrayref->[0];
7163 =item cust_pay_pkgnum
7165 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
7166 package when using experimental package balances.
7170 sub cust_pay_pkgnum {
7171 my( $self, $pkgnum ) = @_;
7172 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
7173 sort { $a->_date <=> $b->_date }
7174 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
7175 'pkgnum' => $pkgnum,
7182 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
7188 map { $_ } #return $self->num_cust_pay_void unless wantarray;
7189 sort { $a->_date <=> $b->_date }
7190 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
7193 =item cust_pay_batch
7195 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
7199 sub cust_pay_batch {
7201 map { $_ } #return $self->num_cust_pay_batch unless wantarray;
7202 sort { $a->paybatchnum <=> $b->paybatchnum }
7203 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
7206 =item cust_pay_pending
7208 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
7209 (without status "done").
7213 sub cust_pay_pending {
7215 return $self->num_cust_pay_pending unless wantarray;
7216 sort { $a->_date <=> $b->_date }
7217 qsearch( 'cust_pay_pending', {
7218 'custnum' => $self->custnum,
7219 'status' => { op=>'!=', value=>'done' },
7224 =item cust_pay_pending_attempt
7226 Returns all payment attempts / declined payments for this customer, as pending
7227 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
7228 a corresponding payment (see L<FS::cust_pay>).
7232 sub cust_pay_pending_attempt {
7234 return $self->num_cust_pay_pending_attempt unless wantarray;
7235 sort { $a->_date <=> $b->_date }
7236 qsearch( 'cust_pay_pending', {
7237 'custnum' => $self->custnum,
7244 =item num_cust_pay_pending
7246 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
7247 customer (without status "done"). Also called automatically when the
7248 cust_pay_pending method is used in a scalar context.
7252 sub num_cust_pay_pending {
7255 " SELECT COUNT(*) FROM cust_pay_pending ".
7256 " WHERE custnum = ? AND status != 'done' ",
7261 =item num_cust_pay_pending_attempt
7263 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
7264 customer, with status "done" but without a corresp. Also called automatically when the
7265 cust_pay_pending method is used in a scalar context.
7269 sub num_cust_pay_pending_attempt {
7272 " SELECT COUNT(*) FROM cust_pay_pending ".
7273 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
7280 Returns all the refunds (see L<FS::cust_refund>) for this customer.
7286 map { $_ } #return $self->num_cust_refund unless wantarray;
7287 sort { $a->_date <=> $b->_date }
7288 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
7291 =item display_custnum
7293 Returns the displayed customer number for this customer: agent_custid if
7294 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
7298 sub display_custnum {
7300 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
7301 return $self->agent_custid;
7303 return $self->custnum;
7309 Returns a name string for this customer, either "Company (Last, First)" or
7316 my $name = $self->contact;
7317 $name = $self->company. " ($name)" if $self->company;
7323 Returns a name string for this (service/shipping) contact, either
7324 "Company (Last, First)" or "Last, First".
7330 if ( $self->get('ship_last') ) {
7331 my $name = $self->ship_contact;
7332 $name = $self->ship_company. " ($name)" if $self->ship_company;
7341 Returns a name string for this customer, either "Company" or "First Last".
7347 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
7350 =item ship_name_short
7352 Returns a name string for this (service/shipping) contact, either "Company"
7357 sub ship_name_short {
7359 if ( $self->get('ship_last') ) {
7360 $self->ship_company !~ /^\s*$/
7361 ? $self->ship_company
7362 : $self->ship_contact_firstlast;
7364 $self->name_company_or_firstlast;
7370 Returns this customer's full (billing) contact name only, "Last, First"
7376 $self->get('last'). ', '. $self->first;
7381 Returns this customer's full (shipping) contact name only, "Last, First"
7387 $self->get('ship_last')
7388 ? $self->get('ship_last'). ', '. $self->ship_first
7392 =item contact_firstlast
7394 Returns this customers full (billing) contact name only, "First Last".
7398 sub contact_firstlast {
7400 $self->first. ' '. $self->get('last');
7403 =item ship_contact_firstlast
7405 Returns this customer's full (shipping) contact name only, "First Last".
7409 sub ship_contact_firstlast {
7411 $self->get('ship_last')
7412 ? $self->first. ' '. $self->get('ship_last')
7413 : $self->contact_firstlast;
7418 Returns this customer's full country name
7424 code2country($self->country);
7427 =item geocode DATA_VENDOR
7429 Returns a value for the customer location as encoded by DATA_VENDOR.
7430 Currently this only makes sense for "CCH" as DATA_VENDOR.
7435 my ($self, $data_vendor) = (shift, shift); #always cch for now
7437 my $geocode = $self->get('geocode'); #XXX only one data_vendor for geocode
7438 return $geocode if $geocode;
7440 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
7444 my($zip,$plus4) = split /-/, $self->get("${prefix}zip")
7445 if $self->country eq 'US';
7449 #CCH specific location stuff
7450 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
7452 my @cust_tax_location =
7454 'table' => 'cust_tax_location',
7455 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
7456 'extra_sql' => $extra_sql,
7457 'order_by' => 'ORDER BY plus4hi',#overlapping with distinct ends
7460 $geocode = $cust_tax_location[0]->geocode
7461 if scalar(@cust_tax_location);
7470 Returns a status string for this customer, currently:
7474 =item prospect - No packages have ever been ordered
7476 =item ordered - Recurring packages all are new (not yet billed).
7478 =item active - One or more recurring packages is active
7480 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
7482 =item suspended - All non-cancelled recurring packages are suspended
7484 =item cancelled - All recurring packages are cancelled
7490 sub status { shift->cust_status(@_); }
7494 # prospect ordered active inactive suspended cancelled
7495 for my $status ( FS::cust_main->statuses() ) {
7496 my $method = $status.'_sql';
7497 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
7498 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
7499 $sth->execute( ($self->custnum) x $numnum )
7500 or die "Error executing 'SELECT $sql': ". $sth->errstr;
7501 return $status if $sth->fetchrow_arrayref->[0];
7505 =item ucfirst_cust_status
7507 =item ucfirst_status
7509 Returns the status with the first character capitalized.
7513 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
7515 sub ucfirst_cust_status {
7517 ucfirst($self->cust_status);
7522 Returns a hex triplet color string for this customer's status.
7526 use vars qw(%statuscolor);
7527 tie %statuscolor, 'Tie::IxHash',
7528 'prospect' => '7e0079', #'000000', #black? naw, purple
7529 'active' => '00CC00', #green
7530 'ordered' => '009999', #teal? cyan?
7531 'inactive' => '0000CC', #blue
7532 'suspended' => 'FF9900', #yellow
7533 'cancelled' => 'FF0000', #red
7536 sub statuscolor { shift->cust_statuscolor(@_); }
7538 sub cust_statuscolor {
7540 $statuscolor{$self->cust_status};
7545 Returns an array of hashes representing the customer's RT tickets.
7552 my $num = $conf->config('cust_main-max_tickets') || 10;
7555 if ( $conf->config('ticket_system') ) {
7556 unless ( $conf->config('ticket_system-custom_priority_field') ) {
7558 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
7562 foreach my $priority (
7563 $conf->config('ticket_system-custom_priority_field-values'), ''
7565 last if scalar(@tickets) >= $num;
7567 @{ FS::TicketSystem->customer_tickets( $self->custnum,
7568 $num - scalar(@tickets),
7578 # Return services representing svc_accts in customer support packages
7579 sub support_services {
7581 my %packages = map { $_ => 1 } $conf->config('support_packages');
7583 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
7584 grep { $_->part_svc->svcdb eq 'svc_acct' }
7585 map { $_->cust_svc }
7586 grep { exists $packages{ $_->pkgpart } }
7587 $self->ncancelled_pkgs;
7591 # Return a list of latitude/longitude for one of the services (if any)
7592 sub service_coordinates {
7596 grep { $_->latitude && $_->longitude }
7598 map { $_->cust_svc }
7599 $self->ncancelled_pkgs;
7601 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
7606 =head1 CLASS METHODS
7612 Class method that returns the list of possible status strings for customers
7613 (see L<the status method|/status>). For example:
7615 @statuses = FS::cust_main->statuses();
7620 #my $self = shift; #could be class...
7626 Returns an SQL expression identifying prospective cust_main records (customers
7627 with no packages ever ordered)
7631 use vars qw($select_count_pkgs);
7632 $select_count_pkgs =
7633 "SELECT COUNT(*) FROM cust_pkg
7634 WHERE cust_pkg.custnum = cust_main.custnum";
7636 sub select_count_pkgs_sql {
7641 " 0 = ( $select_count_pkgs ) ";
7646 Returns an SQL expression identifying ordered cust_main records (customers with
7647 recurring packages not yet setup).
7652 FS::cust_main->none_active_sql.
7653 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->ordered_sql. " ) ";
7658 Returns an SQL expression identifying active cust_main records (customers with
7659 active recurring packages).
7664 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
7667 =item none_active_sql
7669 Returns an SQL expression identifying cust_main records with no active
7670 recurring packages. This includes customers of status prospect, ordered,
7671 inactive, and suspended.
7675 sub none_active_sql {
7676 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
7681 Returns an SQL expression identifying inactive cust_main records (customers with
7682 no active recurring packages, but otherwise unsuspended/uncancelled).
7687 FS::cust_main->none_active_sql.
7688 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
7694 Returns an SQL expression identifying suspended cust_main records.
7699 sub suspended_sql { susp_sql(@_); }
7701 FS::cust_main->none_active_sql.
7702 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
7708 Returns an SQL expression identifying cancelled cust_main records.
7712 sub cancelled_sql { cancel_sql(@_); }
7715 my $recurring_sql = FS::cust_pkg->recurring_sql;
7716 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
7719 0 < ( $select_count_pkgs )
7720 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
7721 AND 0 = ( $select_count_pkgs AND $recurring_sql
7722 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
7724 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
7730 =item uncancelled_sql
7732 Returns an SQL expression identifying un-cancelled cust_main records.
7736 sub uncancelled_sql { uncancel_sql(@_); }
7737 sub uncancel_sql { "
7738 ( 0 < ( $select_count_pkgs
7739 AND ( cust_pkg.cancel IS NULL
7740 OR cust_pkg.cancel = 0
7743 OR 0 = ( $select_count_pkgs )
7749 Returns an SQL fragment to retreive the balance.
7754 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
7755 WHERE cust_bill.custnum = cust_main.custnum )
7756 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
7757 WHERE cust_pay.custnum = cust_main.custnum )
7758 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
7759 WHERE cust_credit.custnum = cust_main.custnum )
7760 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
7761 WHERE cust_refund.custnum = cust_main.custnum )
7764 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
7766 Returns an SQL fragment to retreive the balance for this customer, optionally
7767 considering invoices with date earlier than START_TIME, and not
7768 later than END_TIME (total_owed_date minus total_unapplied_credits minus
7769 total_unapplied_payments).
7771 Times are specified as SQL fragments or numeric
7772 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
7773 L<Date::Parse> for conversion functions. The empty string can be passed
7774 to disable that time constraint completely.
7776 Available options are:
7780 =item unapplied_date
7782 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)
7787 set to true to remove all customer comparison clauses, for totals
7792 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
7797 JOIN clause (typically used with the total option)
7801 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
7802 time will be ignored. Note that START_TIME and END_TIME only limit the date
7803 range for invoices and I<unapplied> payments, credits, and refunds.
7809 sub balance_date_sql {
7810 my( $class, $start, $end, %opt ) = @_;
7812 my $cutoff = $opt{'cutoff'};
7814 my $owed = FS::cust_bill->owed_sql($cutoff);
7815 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
7816 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
7817 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
7819 my $j = $opt{'join'} || '';
7821 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
7822 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
7823 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
7824 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
7826 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
7827 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
7828 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
7829 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
7834 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
7836 Returns an SQL fragment to retreive the total unapplied payments for this
7837 customer, only considering invoices with date earlier than START_TIME, and
7838 optionally not later than END_TIME.
7840 Times are specified as SQL fragments or numeric
7841 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
7842 L<Date::Parse> for conversion functions. The empty string can be passed
7843 to disable that time constraint completely.
7845 Available options are:
7849 sub unapplied_payments_date_sql {
7850 my( $class, $start, $end, %opt ) = @_;
7852 my $cutoff = $opt{'cutoff'};
7854 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
7856 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
7857 'unapplied_date'=>1 );
7859 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
7862 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
7864 Helper method for balance_date_sql; name (and usage) subject to change
7865 (suggestions welcome).
7867 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
7868 cust_refund, cust_credit or cust_pay).
7870 If TABLE is "cust_bill" or the unapplied_date option is true, only
7871 considers records with date earlier than START_TIME, and optionally not
7872 later than END_TIME .
7876 sub _money_table_where {
7877 my( $class, $table, $start, $end, %opt ) = @_;
7880 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
7881 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
7882 push @where, "$table._date <= $start" if defined($start) && length($start);
7883 push @where, "$table._date > $end" if defined($end) && length($end);
7885 push @where, @{$opt{'where'}} if $opt{'where'};
7886 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
7892 =item search HASHREF
7896 Returns a qsearch hash expression to search for parameters specified in
7897 HASHREF. Valid parameters are
7905 =item cancelled_pkgs
7911 listref of start date, end date
7921 =item current_balance
7923 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
7927 =item flattened_pkgs
7936 my ($class, $params) = @_;
7947 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
7949 "cust_main.agentnum = $1";
7953 # do the same for user
7956 if ( $params->{'usernum'} =~ /^(\d+)$/ and $1 ) {
7958 "cust_main.usernum = $1";
7965 #prospect ordered active inactive suspended cancelled
7966 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
7967 my $method = $params->{'status'}. '_sql';
7968 #push @where, $class->$method();
7969 push @where, FS::cust_main->$method();
7973 # parse cancelled package checkbox
7978 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
7979 unless $params->{'cancelled_pkgs'};
7982 # parse without census tract checkbox
7985 push @where, "(censustract = '' or censustract is null)"
7986 if $params->{'no_censustract'};
7992 foreach my $field (qw( signupdate )) {
7994 next unless exists($params->{$field});
7996 my($beginning, $ending, $hour) = @{$params->{$field}};
7999 "cust_main.$field IS NOT NULL",
8000 "cust_main.$field >= $beginning",
8001 "cust_main.$field <= $ending";
8003 # XXX: do this for mysql and/or pull it out of here
8005 if ($dbh->{Driver}->{Name} eq 'Pg') {
8006 push @where, "extract(hour from to_timestamp(cust_main.$field)) = $hour";
8009 warn "search by time of day not supported on ".$dbh->{Driver}->{Name}." databases";
8013 $orderby ||= "ORDER BY cust_main.$field";
8021 if ( $params->{'classnum'} ) {
8023 my @classnum = ref( $params->{'classnum'} )
8024 ? @{ $params->{'classnum'} }
8025 : ( $params->{'classnum'} );
8027 @classnum = grep /^(\d*)$/, @classnum;
8030 push @where, '( '. join(' OR ', map {
8031 $_ ? "cust_main.classnum = $_"
8032 : "cust_main.classnum IS NULL"
8045 if ( $params->{'payby'} ) {
8047 my @payby = ref( $params->{'payby'} )
8048 ? @{ $params->{'payby'} }
8049 : ( $params->{'payby'} );
8051 @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
8053 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )'
8059 # paydate_year / paydate_month
8062 if ( $params->{'paydate_year'} =~ /^(\d{4})$/ ) {
8064 $params->{'paydate_month'} =~ /^(\d\d?)$/
8065 or die "paydate_year without paydate_month?";
8069 'paydate IS NOT NULL',
8071 "CAST(paydate AS timestamp) < CAST('$year-$month-01' AS timestamp )"
8079 if ( $params->{'invoice_terms'} =~ /^([\w ]+)$/ ) {
8081 if ( $1 eq 'NULL' ) {
8083 "( cust_main.invoice_terms IS NULL OR cust_main.invoice_terms = '' )";
8086 "cust_main.invoice_terms IS NOT NULL",
8087 "cust_main.invoice_terms = '$1'";
8095 if ( $params->{'current_balance'} ) {
8097 #my $balance_sql = $class->balance_sql();
8098 my $balance_sql = FS::cust_main->balance_sql();
8100 my @current_balance =
8101 ref( $params->{'current_balance'} )
8102 ? @{ $params->{'current_balance'} }
8103 : ( $params->{'current_balance'} );
8105 push @where, map { s/current_balance/$balance_sql/; $_ }
8114 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
8116 "cust_main.custbatch = '$1'";
8120 # setup queries, subs, etc. for the search
8123 $orderby ||= 'ORDER BY custnum';
8125 # here is the agent virtualization
8126 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
8128 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
8130 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
8132 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
8134 my $select = join(', ',
8135 'cust_main.custnum',
8136 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
8139 my(@extra_headers) = ();
8140 my(@extra_fields) = ();
8142 if ($params->{'flattened_pkgs'}) {
8144 if ($dbh->{Driver}->{Name} eq 'Pg') {
8146 $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";
8148 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
8149 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
8150 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
8152 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
8153 "omitting packing information from report.";
8156 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";
8158 my $sth = dbh->prepare($header_query) or die dbh->errstr;
8159 $sth->execute() or die $sth->errstr;
8160 my $headerrow = $sth->fetchrow_arrayref;
8161 my $headercount = $headerrow ? $headerrow->[0] : 0;
8162 while($headercount) {
8163 unshift @extra_headers, "Package ". $headercount;
8164 unshift @extra_fields, eval q!sub {my $c = shift;
8165 my @a = split '\|', $c->magic;
8166 my $p = $a[!.--$headercount. q!];
8174 'table' => 'cust_main',
8175 'select' => $select,
8177 'extra_sql' => $extra_sql,
8178 'order_by' => $orderby,
8179 'count_query' => $count_query,
8180 'extra_headers' => \@extra_headers,
8181 'extra_fields' => \@extra_fields,
8186 =item email_search_result HASHREF
8190 Emails a notice to the specified customers.
8192 Valid parameters are those of the L<search> method, plus the following:
8214 Optional job queue job for status updates.
8218 Returns an error message, or false for success.
8220 If an error occurs during any email, stops the enture send and returns that
8221 error. Presumably if you're getting SMTP errors aborting is better than
8222 retrying everything.
8226 sub email_search_result {
8227 my($class, $params) = @_;
8229 my $from = delete $params->{from};
8230 my $subject = delete $params->{subject};
8231 my $html_body = delete $params->{html_body};
8232 my $text_body = delete $params->{text_body};
8235 my $job = delete $params->{'job'}
8236 or die "email_search_result must run from the job queue.\n";
8238 $params->{'payby'} = [ split(/\0/, $params->{'payby'}) ]
8239 unless ref($params->{'payby'});
8241 my $sql_query = $class->search($params);
8243 my $count_query = delete($sql_query->{'count_query'});
8244 my $count_sth = dbh->prepare($count_query)
8245 or die "Error preparing $count_query: ". dbh->errstr;
8247 or die "Error executing $count_query: ". $count_sth->errstr;
8248 my $count_arrayref = $count_sth->fetchrow_arrayref;
8249 my $num_cust = $count_arrayref->[0];
8251 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
8252 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
8255 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
8256 my @retry_jobs = ();
8259 #eventually order+limit magic to reduce memory use?
8260 foreach my $cust_main ( qsearch($sql_query) ) {
8262 #progressbar first, so that the count is right
8264 if ( time - $min_sec > $last ) {
8265 my $error = $job->update_statustext(
8266 int( 100 * $num / $num_cust )
8268 die $error if $error;
8272 my $to = $cust_main->invoicing_list_emailonly_scalar;
8278 'subject' => $subject,
8279 'html_body' => $html_body,
8280 'text_body' => $text_body,
8283 $error = send_email( generate_email( @message ) );
8286 # queue the sending of this message so that the user can see what we
8287 # tried to do, and retry if desired
8288 my $queue = new FS::queue {
8289 'job' => 'FS::Misc::process_send_email',
8290 'custnum' => $cust_main->custnum,
8291 'status' => 'failed',
8292 'statustext' => $error,
8294 $queue->insert(@message);
8295 push @retry_jobs, $queue;
8302 if($success == 0 and
8303 (scalar(@retry_jobs) > 10 or $num == $num_cust)
8305 # 10 is arbitrary, but if we have enough failures, that's
8306 # probably a configuration or network problem, and we
8307 # abort the batch and run away screaming.
8308 # We NEVER do this if anything was successfully sent.
8309 $_->delete foreach (@retry_jobs);
8310 return "multiple failures: '$error'\n";
8315 # fail the job, but with a status message that makes it clear
8316 # something was sent.
8317 return "Sent $success, failed ".scalar(@retry_jobs).". Failed attempts placed in job queue.\n";
8323 sub process_email_search_result {
8325 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
8327 my $param = thaw(decode_base64(shift));
8328 warn Dumper($param) if $DEBUG;
8330 $param->{'job'} = $job;
8332 $param->{'payby'} = [ split(/\0/, $param->{'payby'}) ]
8333 unless ref($param->{'payby'});
8335 my $error = FS::cust_main->email_search_result( $param );
8336 die $error if $error;
8340 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
8342 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
8343 records. Currently, I<first>, I<last>, I<company> and/or I<address1> may be
8344 specified (the appropriate ship_ field is also searched).
8346 Additional options are the same as FS::Record::qsearch
8351 my( $self, $fuzzy, $hash, @opt) = @_;
8356 check_and_rebuild_fuzzyfiles();
8357 foreach my $field ( keys %$fuzzy ) {
8359 my $all = $self->all_X($field);
8360 next unless scalar(@$all);
8363 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
8366 foreach ( keys %match ) {
8367 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
8368 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
8371 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
8374 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
8376 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
8384 Returns a masked version of the named field
8389 my ($self,$field) = @_;
8393 'x'x(length($self->getfield($field))-4).
8394 substr($self->getfield($field), (length($self->getfield($field))-4));
8404 =item smart_search OPTION => VALUE ...
8406 Accepts the following options: I<search>, the string to search for. The string
8407 will be searched for as a customer number, phone number, name or company name,
8408 as an exact, or, in some cases, a substring or fuzzy match (see the source code
8409 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
8410 skip fuzzy matching when an exact match is found.
8412 Any additional options are treated as an additional qualifier on the search
8415 Returns a (possibly empty) array of FS::cust_main objects.
8422 #here is the agent virtualization
8423 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8427 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
8428 my $search = delete $options{'search'};
8429 ( my $alphanum_search = $search ) =~ s/\W//g;
8431 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
8433 #false laziness w/Record::ut_phone
8434 my $phonen = "$1-$2-$3";
8435 $phonen .= " x$4" if $4;
8437 push @cust_main, qsearch( {
8438 'table' => 'cust_main',
8439 'hashref' => { %options },
8440 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8442 join(' OR ', map "$_ = '$phonen'",
8443 qw( daytime night fax
8444 ship_daytime ship_night ship_fax )
8447 " AND $agentnums_sql", #agent virtualization
8450 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
8451 #try looking for matches with extensions unless one was specified
8453 push @cust_main, qsearch( {
8454 'table' => 'cust_main',
8455 'hashref' => { %options },
8456 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8458 join(' OR ', map "$_ LIKE '$phonen\%'",
8460 ship_daytime ship_night )
8463 " AND $agentnums_sql", #agent virtualization
8468 # custnum search (also try agent_custid), with some tweaking options if your
8469 # legacy cust "numbers" have letters
8472 if ( $search =~ /^\s*(\d+)\s*$/
8473 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
8474 && $search =~ /^\s*(\w\w?\d+)\s*$/
8476 || ( $conf->exists('address1-search' )
8477 && $search =~ /^\s*(\d+\-?\w*)\s*$/ #i.e. 1234A or 9432-D
8484 if ( $num =~ /^(\d+)$/ && $num <= 2147483647 ) { #need a bigint custnum? wow
8485 push @cust_main, qsearch( {
8486 'table' => 'cust_main',
8487 'hashref' => { 'custnum' => $num, %options },
8488 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8492 push @cust_main, qsearch( {
8493 'table' => 'cust_main',
8494 'hashref' => { 'agent_custid' => $num, %options },
8495 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8498 if ( $conf->exists('address1-search') ) {
8499 my $len = length($num);
8501 foreach my $prefix ( '', 'ship_' ) {
8502 push @cust_main, qsearch( {
8503 'table' => 'cust_main',
8504 'hashref' => { %options, },
8506 ( keys(%options) ? ' AND ' : ' WHERE ' ).
8507 " LOWER(SUBSTRING(${prefix}address1 FROM 1 FOR $len)) = '$num' ".
8508 " AND $agentnums_sql",
8513 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
8515 my($company, $last, $first) = ( $1, $2, $3 );
8517 # "Company (Last, First)"
8518 #this is probably something a browser remembered,
8519 #so just do an exact search (but case-insensitive, so USPS standardization
8520 #doesn't throw a wrench in the works)
8522 foreach my $prefix ( '', 'ship_' ) {
8523 push @cust_main, qsearch( {
8524 'table' => 'cust_main',
8525 'hashref' => { %options },
8527 ( keys(%options) ? ' AND ' : ' WHERE ' ).
8529 " LOWER(${prefix}first) = ". dbh->quote(lc($first)),
8530 " LOWER(${prefix}last) = ". dbh->quote(lc($last)),
8531 " LOWER(${prefix}company) = ". dbh->quote(lc($company)),
8537 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
8538 # try (ship_){last,company}
8542 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
8543 # # full strings the browser remembers won't work
8544 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
8546 use Lingua::EN::NameParse;
8547 my $NameParse = new Lingua::EN::NameParse(
8549 allow_reversed => 1,
8552 my($last, $first) = ( '', '' );
8553 #maybe disable this too and just rely on NameParse?
8554 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
8556 ($last, $first) = ( $1, $2 );
8558 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
8559 } elsif ( ! $NameParse->parse($value) ) {
8561 my %name = $NameParse->components;
8562 $first = $name{'given_name_1'};
8563 $last = $name{'surname_1'};
8567 if ( $first && $last ) {
8569 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
8572 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8574 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
8575 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
8578 push @cust_main, qsearch( {
8579 'table' => 'cust_main',
8580 'hashref' => \%options,
8581 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8584 # or it just be something that was typed in... (try that in a sec)
8588 my $q_value = dbh->quote($value);
8591 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8592 $sql .= " ( LOWER(last) = $q_value
8593 OR LOWER(company) = $q_value
8594 OR LOWER(ship_last) = $q_value
8595 OR LOWER(ship_company) = $q_value
8597 $sql .= " OR LOWER(address1) = $q_value
8598 OR LOWER(ship_address1) = $q_value
8600 if $conf->exists('address1-search');
8603 push @cust_main, qsearch( {
8604 'table' => 'cust_main',
8605 'hashref' => \%options,
8606 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8609 #no exact match, trying substring/fuzzy
8610 #always do substring & fuzzy (unless they're explicity config'ed off)
8611 #getting complaints searches are not returning enough
8612 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
8614 #still some false laziness w/search (was search/cust_main.cgi)
8619 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
8620 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
8623 if ( $first && $last ) {
8626 { 'first' => { op=>'ILIKE', value=>"%$first%" },
8627 'last' => { op=>'ILIKE', value=>"%$last%" },
8629 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
8630 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
8637 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
8638 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
8642 if ( $conf->exists('address1-search') ) {
8644 { 'address1' => { op=>'ILIKE', value=>"%$value%" }, },
8645 { 'ship_address1' => { op=>'ILIKE', value=>"%$value%" }, },
8649 foreach my $hashref ( @hashrefs ) {
8651 push @cust_main, qsearch( {
8652 'table' => 'cust_main',
8653 'hashref' => { %$hashref,
8656 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
8665 " AND $agentnums_sql", #extra_sql #agent virtualization
8668 if ( $first && $last ) {
8669 push @cust_main, FS::cust_main->fuzzy_search(
8670 { 'last' => $last, #fuzzy hashref
8671 'first' => $first }, #
8675 foreach my $field ( 'last', 'company' ) {
8677 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
8679 if ( $conf->exists('address1-search') ) {
8681 FS::cust_main->fuzzy_search( { 'address1' => $value }, @fuzopts );
8688 #eliminate duplicates
8690 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8698 Accepts the following options: I<email>, the email address to search for. The
8699 email address will be searched for as an email invoice destination and as an
8702 #Any additional options are treated as an additional qualifier on the search
8703 #(i.e. I<agentnum>).
8705 Returns a (possibly empty) array of FS::cust_main objects (but usually just
8715 my $email = delete $options{'email'};
8717 #we're only being used by RT at the moment... no agent virtualization yet
8718 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8722 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
8724 my ( $user, $domain ) = ( $1, $2 );
8726 warn "$me smart_search: searching for $user in domain $domain"
8732 'table' => 'cust_main_invoice',
8733 'hashref' => { 'dest' => $email },
8740 map $_->cust_svc->cust_pkg,
8742 'table' => 'svc_acct',
8743 'hashref' => { 'username' => $user, },
8745 'AND ( SELECT domain FROM svc_domain
8746 WHERE svc_acct.domsvc = svc_domain.svcnum
8747 ) = '. dbh->quote($domain),
8753 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8755 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
8762 =item check_and_rebuild_fuzzyfiles
8766 sub check_and_rebuild_fuzzyfiles {
8767 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8768 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
8771 =item rebuild_fuzzyfiles
8775 sub rebuild_fuzzyfiles {
8777 use Fcntl qw(:flock);
8779 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8780 mkdir $dir, 0700 unless -d $dir;
8782 foreach my $fuzzy ( @fuzzyfields ) {
8784 open(LOCK,">>$dir/cust_main.$fuzzy")
8785 or die "can't open $dir/cust_main.$fuzzy: $!";
8787 or die "can't lock $dir/cust_main.$fuzzy: $!";
8789 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
8790 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
8792 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
8793 my $sth = dbh->prepare("SELECT $field FROM cust_main".
8794 " WHERE $field != '' AND $field IS NOT NULL");
8795 $sth->execute or die $sth->errstr;
8797 while ( my $row = $sth->fetchrow_arrayref ) {
8798 print CACHE $row->[0]. "\n";
8803 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
8805 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
8816 my( $self, $field ) = @_;
8817 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8818 open(CACHE,"<$dir/cust_main.$field")
8819 or die "can't open $dir/cust_main.$field: $!";
8820 my @array = map { chomp; $_; } <CACHE>;
8825 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
8829 sub append_fuzzyfiles {
8830 #my( $first, $last, $company ) = @_;
8832 &check_and_rebuild_fuzzyfiles;
8834 use Fcntl qw(:flock);
8836 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8838 foreach my $field (@fuzzyfields) {
8843 open(CACHE,">>$dir/cust_main.$field")
8844 or die "can't open $dir/cust_main.$field: $!";
8845 flock(CACHE,LOCK_EX)
8846 or die "can't lock $dir/cust_main.$field: $!";
8848 print CACHE "$value\n";
8850 flock(CACHE,LOCK_UN)
8851 or die "can't unlock $dir/cust_main.$field: $!";
8866 #warn join('-',keys %$param);
8867 my $fh = $param->{filehandle};
8868 my $agentnum = $param->{agentnum};
8869 my $format = $param->{format};
8871 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
8874 if ( $format eq 'simple' ) {
8875 @fields = qw( custnum agent_custid amount pkg );
8877 die "unknown format $format";
8880 eval "use Text::CSV_XS;";
8883 my $csv = new Text::CSV_XS;
8890 local $SIG{HUP} = 'IGNORE';
8891 local $SIG{INT} = 'IGNORE';
8892 local $SIG{QUIT} = 'IGNORE';
8893 local $SIG{TERM} = 'IGNORE';
8894 local $SIG{TSTP} = 'IGNORE';
8895 local $SIG{PIPE} = 'IGNORE';
8897 my $oldAutoCommit = $FS::UID::AutoCommit;
8898 local $FS::UID::AutoCommit = 0;
8901 #while ( $columns = $csv->getline($fh) ) {
8903 while ( defined($line=<$fh>) ) {
8905 $csv->parse($line) or do {
8906 $dbh->rollback if $oldAutoCommit;
8907 return "can't parse: ". $csv->error_input();
8910 my @columns = $csv->fields();
8911 #warn join('-',@columns);
8914 foreach my $field ( @fields ) {
8915 $row{$field} = shift @columns;
8918 if ( $row{custnum} && $row{agent_custid} ) {
8919 dbh->rollback if $oldAutoCommit;
8920 return "can't specify custnum with agent_custid $row{agent_custid}";
8924 if ( $row{agent_custid} && $agentnum ) {
8925 %hash = ( 'agent_custid' => $row{agent_custid},
8926 'agentnum' => $agentnum,
8930 if ( $row{custnum} ) {
8931 %hash = ( 'custnum' => $row{custnum} );
8934 unless ( scalar(keys %hash) ) {
8935 $dbh->rollback if $oldAutoCommit;
8936 return "can't find customer without custnum or agent_custid and agentnum";
8939 my $cust_main = qsearchs('cust_main', { %hash } );
8940 unless ( $cust_main ) {
8941 $dbh->rollback if $oldAutoCommit;
8942 my $custnum = $row{custnum} || $row{agent_custid};
8943 return "unknown custnum $custnum";
8946 if ( $row{'amount'} > 0 ) {
8947 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
8949 $dbh->rollback if $oldAutoCommit;
8953 } elsif ( $row{'amount'} < 0 ) {
8954 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
8957 $dbh->rollback if $oldAutoCommit;
8967 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
8969 return "Empty file!" unless $imported;
8975 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
8977 Deprecated. Use event notification and message templates
8978 (L<FS::msg_template>) instead.
8980 Sends a templated email notification to the customer (see L<Text::Template>).
8982 OPTIONS is a hash and may include
8984 I<from> - the email sender (default is invoice_from)
8986 I<to> - comma-separated scalar or arrayref of recipients
8987 (default is invoicing_list)
8989 I<subject> - The subject line of the sent email notification
8990 (default is "Notice from company_name")
8992 I<extra_fields> - a hashref of name/value pairs which will be substituted
8995 The following variables are vavailable in the template.
8997 I<$first> - the customer first name
8998 I<$last> - the customer last name
8999 I<$company> - the customer company
9000 I<$payby> - a description of the method of payment for the customer
9001 # would be nice to use FS::payby::shortname
9002 I<$payinfo> - the account information used to collect for this customer
9003 I<$expdate> - the expiration of the customer payment in seconds from epoch
9008 my ($self, $template, %options) = @_;
9010 return unless $conf->exists($template);
9012 my $from = $conf->config('invoice_from', $self->agentnum)
9013 if $conf->exists('invoice_from', $self->agentnum);
9014 $from = $options{from} if exists($options{from});
9016 my $to = join(',', $self->invoicing_list_emailonly);
9017 $to = $options{to} if exists($options{to});
9019 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
9020 if $conf->exists('company_name', $self->agentnum);
9021 $subject = $options{subject} if exists($options{subject});
9023 my $notify_template = new Text::Template (TYPE => 'ARRAY',
9024 SOURCE => [ map "$_\n",
9025 $conf->config($template)]
9027 or die "can't create new Text::Template object: Text::Template::ERROR";
9028 $notify_template->compile()
9029 or die "can't compile template: Text::Template::ERROR";
9031 $FS::notify_template::_template::company_name =
9032 $conf->config('company_name', $self->agentnum);
9033 $FS::notify_template::_template::company_address =
9034 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
9036 my $paydate = $self->paydate || '2037-12-31';
9037 $FS::notify_template::_template::first = $self->first;
9038 $FS::notify_template::_template::last = $self->last;
9039 $FS::notify_template::_template::company = $self->company;
9040 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
9041 my $payby = $self->payby;
9042 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9043 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9045 #credit cards expire at the end of the month/year of their exp date
9046 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9047 $FS::notify_template::_template::payby = 'credit card';
9048 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9049 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9051 }elsif ($payby eq 'COMP') {
9052 $FS::notify_template::_template::payby = 'complimentary account';
9054 $FS::notify_template::_template::payby = 'current method';
9056 $FS::notify_template::_template::expdate = $expire_time;
9058 for (keys %{$options{extra_fields}}){
9060 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
9063 send_email(from => $from,
9065 subject => $subject,
9066 body => $notify_template->fill_in( PACKAGE =>
9067 'FS::notify_template::_template' ),
9072 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9074 Generates a templated notification to the customer (see L<Text::Template>).
9076 OPTIONS is a hash and may include
9078 I<extra_fields> - a hashref of name/value pairs which will be substituted
9079 into the template. These values may override values mentioned below
9080 and those from the customer record.
9082 The following variables are available in the template instead of or in addition
9083 to the fields of the customer record.
9085 I<$payby> - a description of the method of payment for the customer
9086 # would be nice to use FS::payby::shortname
9087 I<$payinfo> - the masked account information used to collect for this customer
9088 I<$expdate> - the expiration of the customer payment method in seconds from epoch
9089 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
9093 # a lot like cust_bill::print_latex
9094 sub generate_letter {
9095 my ($self, $template, %options) = @_;
9097 return unless $conf->exists($template);
9099 my $letter_template = new Text::Template
9101 SOURCE => [ map "$_\n", $conf->config($template)],
9102 DELIMITERS => [ '[@--', '--@]' ],
9104 or die "can't create new Text::Template object: Text::Template::ERROR";
9106 $letter_template->compile()
9107 or die "can't compile template: Text::Template::ERROR";
9109 my %letter_data = map { $_ => $self->$_ } $self->fields;
9110 $letter_data{payinfo} = $self->mask_payinfo;
9112 #my $paydate = $self->paydate || '2037-12-31';
9113 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
9115 my $payby = $self->payby;
9116 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9117 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9119 #credit cards expire at the end of the month/year of their exp date
9120 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9121 $letter_data{payby} = 'credit card';
9122 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9123 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9125 }elsif ($payby eq 'COMP') {
9126 $letter_data{payby} = 'complimentary account';
9128 $letter_data{payby} = 'current method';
9130 $letter_data{expdate} = $expire_time;
9132 for (keys %{$options{extra_fields}}){
9133 $letter_data{$_} = $options{extra_fields}->{$_};
9136 unless(exists($letter_data{returnaddress})){
9137 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
9138 $self->agent_template)
9140 if ( length($retadd) ) {
9141 $letter_data{returnaddress} = $retadd;
9142 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
9143 $letter_data{returnaddress} =
9144 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
9148 ( $conf->config('company_name', $self->agentnum),
9149 $conf->config('company_address', $self->agentnum),
9153 $letter_data{returnaddress} = '~';
9157 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
9159 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
9161 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
9163 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
9167 ) or die "can't open temp file: $!\n";
9168 print $lh $conf->config_binary('logo.eps', $self->agentnum)
9169 or die "can't write temp file: $!\n";
9171 $letter_data{'logo_file'} = $lh->filename;
9173 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
9177 ) or die "can't open temp file: $!\n";
9179 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
9181 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
9182 return ($1, $letter_data{'logo_file'});
9186 =item print_ps TEMPLATE
9188 Returns an postscript letter filled in from TEMPLATE, as a scalar.
9194 my($file, $lfile) = $self->generate_letter(@_);
9195 my $ps = FS::Misc::generate_ps($file);
9196 unlink($file.'.tex');
9202 =item print TEMPLATE
9204 Prints the filled in template.
9206 TEMPLATE is the name of a L<Text::Template> to fill in and print.
9210 sub queueable_print {
9213 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
9214 or die "invalid customer number: " . $opt{custvnum};
9216 my $error = $self->print( $opt{template} );
9217 die $error if $error;
9221 my ($self, $template) = (shift, shift);
9222 do_print [ $self->print_ps($template) ];
9225 #these three subs should just go away once agent stuff is all config overrides
9227 sub agent_template {
9229 $self->_agent_plandata('agent_templatename');
9232 sub agent_invoice_from {
9234 $self->_agent_plandata('agent_invoice_from');
9237 sub _agent_plandata {
9238 my( $self, $option ) = @_;
9240 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
9241 #agent-specific Conf
9243 use FS::part_event::Condition;
9245 my $agentnum = $self->agentnum;
9247 my $regexp = regexp_sql();
9249 my $part_event_option =
9251 'select' => 'part_event_option.*',
9252 'table' => 'part_event_option',
9254 LEFT JOIN part_event USING ( eventpart )
9255 LEFT JOIN part_event_option AS peo_agentnum
9256 ON ( part_event.eventpart = peo_agentnum.eventpart
9257 AND peo_agentnum.optionname = 'agentnum'
9258 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
9260 LEFT JOIN part_event_condition
9261 ON ( part_event.eventpart = part_event_condition.eventpart
9262 AND part_event_condition.conditionname = 'cust_bill_age'
9264 LEFT JOIN part_event_condition_option
9265 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
9266 AND part_event_condition_option.optionname = 'age'
9269 #'hashref' => { 'optionname' => $option },
9270 #'hashref' => { 'part_event_option.optionname' => $option },
9272 " WHERE part_event_option.optionname = ". dbh->quote($option).
9273 " AND action = 'cust_bill_send_agent' ".
9274 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
9275 " AND peo_agentnum.optionname = 'agentnum' ".
9276 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
9278 CASE WHEN part_event_condition_option.optionname IS NULL
9280 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
9282 , part_event.weight".
9286 unless ( $part_event_option ) {
9287 return $self->agent->invoice_template || ''
9288 if $option eq 'agent_templatename';
9292 $part_event_option->optionvalue;
9296 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
9298 Subroutine (not a method), designed to be called from the queue.
9300 Takes a list of options and values.
9302 Pulls up the customer record via the custnum option and calls bill_and_collect.
9307 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
9309 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
9310 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
9312 $cust_main->bill_and_collect( %args );
9315 sub process_bill_and_collect {
9317 my $param = thaw(decode_base64(shift));
9318 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
9319 or die "custnum '$param->{custnum}' not found!\n";
9320 $param->{'job'} = $job;
9321 $param->{'fatal'} = 1; # runs from job queue, will be caught
9322 $param->{'retry'} = 1;
9324 $cust_main->bill_and_collect( %$param );
9327 sub _upgrade_data { #class method
9328 my ($class, %opts) = @_;
9330 my $sql = 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL';
9331 my $sth = dbh->prepare($sql) or die dbh->errstr;
9332 $sth->execute or die $sth->errstr;
9334 local($ignore_expired_card) = 1;
9335 local($skip_fuzzyfiles) = 1;
9336 $class->_upgrade_otaker(%opts);
9346 The delete method should possibly take an FS::cust_main object reference
9347 instead of a scalar customer number.
9349 Bill and collect options should probably be passed as references instead of a
9352 There should probably be a configuration file with a list of allowed credit
9355 No multiple currency support (probably a larger project than just this module).
9357 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
9359 Birthdates rely on negative epoch values.
9361 The payby for card/check batches is broken. With mixed batching, bad
9364 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
9368 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
9369 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
9370 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.