5 use vars qw( @ISA @EXPORT_OK $DEBUG $me $conf @encrypted_fields
6 $import $skip_fuzzyfiles $ignore_expired_card @paytypes);
7 use vars qw( $realtime_bop_decline_quiet ); #ugh
11 use Scalar::Util qw( blessed );
12 use List::Util qw( min );
13 use Time::Local qw(timelocal);
16 use Digest::MD5 qw(md5_base64);
19 use File::Temp qw( tempfile );
20 use String::Approx qw(amatch);
21 use Business::CreditCard 0.28;
23 use FS::UID qw( getotaker dbh driver_name );
24 use FS::Record qw( qsearchs qsearch dbdef );
25 use FS::Misc qw( generate_email send_email generate_ps do_print );
26 use FS::Msgcat qw(gettext);
31 use FS::cust_bill_pkg;
32 use FS::cust_bill_pkg_display;
33 use FS::cust_bill_pkg_tax_location;
34 use FS::cust_bill_pkg_tax_rate_location;
36 use FS::cust_pay_pending;
37 use FS::cust_pay_void;
38 use FS::cust_pay_batch;
41 use FS::part_referral;
42 use FS::cust_main_county;
43 use FS::cust_location;
44 use FS::cust_main_exemption;
45 use FS::cust_tax_adjustment;
47 use FS::tax_rate_location;
48 use FS::cust_tax_location;
49 use FS::part_pkg_taxrate;
51 use FS::cust_main_invoice;
52 use FS::cust_credit_bill;
53 use FS::cust_bill_pay;
54 use FS::prepay_credit;
58 use FS::part_event_condition;
61 use FS::payment_gateway;
62 use FS::agent_payment_gateway;
64 use FS::payinfo_Mixin;
67 @ISA = qw( FS::payinfo_Mixin FS::Record );
69 @EXPORT_OK = qw( smart_search );
71 $realtime_bop_decline_quiet = 0;
73 # 1 is mostly method/subroutine entry and options
74 # 2 traces progress of some operations
75 # 3 is even more information including possibly sensitive data
77 $me = '[FS::cust_main]';
81 $ignore_expired_card = 0;
83 @encrypted_fields = ('payinfo', 'paycvv');
84 sub nohistory_fields { ('paycvv'); }
86 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
88 #ask FS::UID to run this stuff for us later
89 #$FS::UID::callback{'FS::cust_main'} = sub {
90 install_callback FS::UID sub {
92 #yes, need it for stuff below (prolly should be cached)
97 my ( $hashref, $cache ) = @_;
98 if ( exists $hashref->{'pkgnum'} ) {
99 #@{ $self->{'_pkgnum'} } = ();
100 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
101 $self->{'_pkgnum'} = $subcache;
102 #push @{ $self->{'_pkgnum'} },
103 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
109 FS::cust_main - Object methods for cust_main records
115 $record = new FS::cust_main \%hash;
116 $record = new FS::cust_main { 'column' => 'value' };
118 $error = $record->insert;
120 $error = $new_record->replace($old_record);
122 $error = $record->delete;
124 $error = $record->check;
126 @cust_pkg = $record->all_pkgs;
128 @cust_pkg = $record->ncancelled_pkgs;
130 @cust_pkg = $record->suspended_pkgs;
132 $error = $record->bill;
133 $error = $record->bill %options;
134 $error = $record->bill 'time' => $time;
136 $error = $record->collect;
137 $error = $record->collect %options;
138 $error = $record->collect 'invoice_time' => $time,
143 An FS::cust_main object represents a customer. FS::cust_main inherits from
144 FS::Record. The following fields are currently supported:
150 Primary key (assigned automatically for new customers)
154 Agent (see L<FS::agent>)
158 Advertising source (see L<FS::part_referral>)
170 Cocial security number (optional)
186 (optional, see L<FS::cust_main_county>)
190 (see L<FS::cust_main_county>)
196 (see L<FS::cust_main_county>)
232 (optional, see L<FS::cust_main_county>)
236 (see L<FS::cust_main_county>)
242 (see L<FS::cust_main_county>)
258 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
262 Payment Information (See L<FS::payinfo_Mixin> for data format)
266 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
270 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
274 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
278 Start date month (maestro/solo cards only)
282 Start date year (maestro/solo cards only)
286 Issue number (maestro/solo cards only)
290 Name on card or billing name
294 IP address from which payment information was received
298 Tax exempt, empty or `Y'
302 Order taker (assigned automatically, see L<FS::UID>)
308 =item referral_custnum
310 Referring customer number
314 Enable individual CDR spooling, empty or `Y'
318 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
322 Discourage individual CDR printing, empty or `Y'
332 Creates a new customer. To add the customer to the database, see L<"insert">.
334 Note that this stores the hash reference, not a distinct copy of the hash it
335 points to. You can ask the object for a copy with the I<hash> method.
339 sub table { 'cust_main'; }
341 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
343 Adds this customer to the database. If there is an error, returns the error,
344 otherwise returns false.
346 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
347 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
348 are inserted atomicly, or the transaction is rolled back. Passing an empty
349 hash reference is equivalent to not supplying this parameter. There should be
350 a better explanation of this, but until then, here's an example:
353 tie %hash, 'Tie::RefHash'; #this part is important
355 $cust_pkg => [ $svc_acct ],
358 $cust_main->insert( \%hash );
360 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
361 be set as the invoicing list (see L<"invoicing_list">). Errors return as
362 expected and rollback the entire transaction; it is not necessary to call
363 check_invoicing_list first. The invoicing_list is set after the records in the
364 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
365 invoicing_list destination to the newly-created svc_acct. Here's an example:
367 $cust_main->insert( {}, [ $email, 'POST' ] );
369 Currently available options are: I<depend_jobnum>, I<noexport> and I<tax_exemption>.
371 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
372 on the supplied jobnum (they will not run until the specific job completes).
373 This can be used to defer provisioning until some action completes (such
374 as running the customer's credit card successfully).
376 The I<noexport> option is deprecated. If I<noexport> is set true, no
377 provisioning jobs (exports) are scheduled. (You can schedule them later with
378 the B<reexport> method.)
380 The I<tax_exemption> option can be set to an arrayref of tax names.
381 FS::cust_main_exemption records will be created and inserted.
387 my $cust_pkgs = @_ ? shift : {};
388 my $invoicing_list = @_ ? shift : '';
390 warn "$me insert called with options ".
391 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
394 local $SIG{HUP} = 'IGNORE';
395 local $SIG{INT} = 'IGNORE';
396 local $SIG{QUIT} = 'IGNORE';
397 local $SIG{TERM} = 'IGNORE';
398 local $SIG{TSTP} = 'IGNORE';
399 local $SIG{PIPE} = 'IGNORE';
401 my $oldAutoCommit = $FS::UID::AutoCommit;
402 local $FS::UID::AutoCommit = 0;
405 my $prepay_identifier = '';
406 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
408 if ( $self->payby eq 'PREPAY' ) {
410 $self->payby('BILL');
411 $prepay_identifier = $self->payinfo;
414 warn " looking up prepaid card $prepay_identifier\n"
417 my $error = $self->get_prepay( $prepay_identifier,
418 'amount_ref' => \$amount,
419 'seconds_ref' => \$seconds,
420 'upbytes_ref' => \$upbytes,
421 'downbytes_ref' => \$downbytes,
422 'totalbytes_ref' => \$totalbytes,
425 $dbh->rollback if $oldAutoCommit;
426 #return "error applying prepaid card (transaction rolled back): $error";
430 $payby = 'PREP' if $amount;
432 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
435 $self->payby('BILL');
436 $amount = $self->paid;
440 warn " inserting $self\n"
443 $self->signupdate(time) unless $self->signupdate;
445 $self->auto_agent_custid()
446 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
448 my $error = $self->SUPER::insert;
450 $dbh->rollback if $oldAutoCommit;
451 #return "inserting cust_main record (transaction rolled back): $error";
455 warn " setting invoicing list\n"
458 if ( $invoicing_list ) {
459 $error = $self->check_invoicing_list( $invoicing_list );
461 $dbh->rollback if $oldAutoCommit;
462 #return "checking invoicing_list (transaction rolled back): $error";
465 $self->invoicing_list( $invoicing_list );
468 warn " setting cust_main_exemption\n"
471 my $tax_exemption = delete $options{'tax_exemption'};
472 if ( $tax_exemption ) {
473 foreach my $taxname ( @$tax_exemption ) {
474 my $cust_main_exemption = new FS::cust_main_exemption {
475 'custnum' => $self->custnum,
476 'taxname' => $taxname,
478 my $error = $cust_main_exemption->insert;
480 $dbh->rollback if $oldAutoCommit;
481 return "inserting cust_main_exemption (transaction rolled back): $error";
486 if ( $conf->config('cust_main-skeleton_tables')
487 && $conf->config('cust_main-skeleton_custnum') ) {
489 warn " inserting skeleton records\n"
492 my $error = $self->start_copy_skel;
494 $dbh->rollback if $oldAutoCommit;
500 warn " ordering packages\n"
503 $error = $self->order_pkgs( $cust_pkgs,
505 'seconds_ref' => \$seconds,
506 'upbytes_ref' => \$upbytes,
507 'downbytes_ref' => \$downbytes,
508 'totalbytes_ref' => \$totalbytes,
511 $dbh->rollback if $oldAutoCommit;
516 $dbh->rollback if $oldAutoCommit;
517 return "No svc_acct record to apply pre-paid time";
519 if ( $upbytes || $downbytes || $totalbytes ) {
520 $dbh->rollback if $oldAutoCommit;
521 return "No svc_acct record to apply pre-paid data";
525 warn " inserting initial $payby payment of $amount\n"
527 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
529 $dbh->rollback if $oldAutoCommit;
530 return "inserting payment (transaction rolled back): $error";
534 unless ( $import || $skip_fuzzyfiles ) {
535 warn " queueing fuzzyfiles update\n"
537 $error = $self->queue_fuzzyfiles_update;
539 $dbh->rollback if $oldAutoCommit;
540 return "updating fuzzy search cache: $error";
544 warn " insert complete; committing transaction\n"
547 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
552 use File::CounterFile;
553 sub auto_agent_custid {
556 my $format = $conf->config('cust_main-auto_agent_custid');
558 if ( $format eq '1YMMXXXXXXXX' ) {
560 my $counter = new File::CounterFile 'cust_main.agent_custid';
563 my $ym = 100000000000 + time2str('%y%m00000000', time);
564 if ( $ym > $counter->value ) {
565 $counter->{'value'} = $agent_custid = $ym;
566 $counter->{'updated'} = 1;
568 $agent_custid = $counter->inc;
574 die "Unknown cust_main-auto_agent_custid format: $format";
577 $self->agent_custid($agent_custid);
581 sub start_copy_skel {
584 #'mg_user_preference' => {},
585 #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
586 #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
587 #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
588 #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
589 my @tables = eval(join('\n',$conf->config('cust_main-skeleton_tables')));
592 _copy_skel( 'cust_main', #tablename
593 $conf->config('cust_main-skeleton_custnum'), #sourceid
594 $self->custnum, #destid
595 @tables, #child tables
599 #recursive subroutine, not a method
601 my( $table, $sourceid, $destid, %child_tables ) = @_;
604 if ( $table =~ /^(\w+)\.(\w+)$/ ) {
605 ( $table, $primary_key ) = ( $1, $2 );
607 my $dbdef_table = dbdef->table($table);
608 $primary_key = $dbdef_table->primary_key
609 or return "$table has no primary key".
610 " (or do you need to run dbdef-create?)";
613 warn " _copy_skel: $table.$primary_key $sourceid to $destid for ".
614 join (', ', keys %child_tables). "\n"
617 foreach my $child_table_def ( keys %child_tables ) {
621 if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
622 ( $child_table, $child_pkey ) = ( $1, $2 );
624 $child_table = $child_table_def;
626 $child_pkey = dbdef->table($child_table)->primary_key;
627 # or return "$table has no primary key".
628 # " (or do you need to run dbdef-create?)\n";
632 if ( keys %{ $child_tables{$child_table_def} } ) {
634 return "$child_table has no primary key".
635 " (run dbdef-create or try specifying it?)\n"
638 #false laziness w/Record::insert and only works on Pg
639 #refactor the proper last-inserted-id stuff out of Record::insert if this
640 # ever gets use for anything besides a quick kludge for one customer
641 my $default = dbdef->table($child_table)->column($child_pkey)->default;
642 $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
643 or return "can't parse $child_table.$child_pkey default value ".
644 " for sequence name: $default";
649 my @sel_columns = grep { $_ ne $primary_key }
650 dbdef->table($child_table)->columns;
651 my $sel_columns = join(', ', @sel_columns );
653 my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
654 my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
655 my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
657 my $sel_st = "SELECT $sel_columns FROM $child_table".
658 " WHERE $primary_key = $sourceid";
661 my $sel_sth = dbh->prepare( $sel_st )
662 or return dbh->errstr;
664 $sel_sth->execute or return $sel_sth->errstr;
666 while ( my $row = $sel_sth->fetchrow_hashref ) {
668 warn " selected row: ".
669 join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
673 "INSERT INTO $child_table $ins_columns VALUES $placeholders";
674 my $ins_sth =dbh->prepare($statement)
675 or return dbh->errstr;
676 my @param = ( $destid, map $row->{$_}, @ins_columns );
677 warn " $statement: [ ". join(', ', @param). " ]\n"
679 $ins_sth->execute( @param )
680 or return $ins_sth->errstr;
682 #next unless keys %{ $child_tables{$child_table} };
683 next unless $sequence;
685 #another section of that laziness
686 my $seq_sql = "SELECT currval('$sequence')";
687 my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
688 $seq_sth->execute or return $seq_sth->errstr;
689 my $insertid = $seq_sth->fetchrow_arrayref->[0];
691 # don't drink soap! recurse! recurse! okay!
693 _copy_skel( $child_table_def,
694 $row->{$child_pkey}, #sourceid
696 %{ $child_tables{$child_table_def} },
698 return $error if $error;
708 =item order_pkg HASHREF | OPTION => VALUE ...
710 Orders a single package.
712 Options may be passed as a list of key/value pairs or as a hash reference.
723 Optional FS::cust_location object
727 Optional arryaref of FS::svc_* service objects.
731 If this option is set to a job queue jobnum (see L<FS::queue>), all provisioning
732 jobs will have a dependancy on the supplied job (they will not run until the
733 specific job completes). This can be used to defer provisioning until some
734 action completes (such as running the customer's credit card successfully).
738 Optional subject for a ticket created and attached to this customer
742 Optional queue name for ticket additions
750 my $opt = ref($_[0]) ? shift : { @_ };
752 warn "$me order_pkg called with options ".
753 join(', ', map { "$_: $opt->{$_}" } keys %$opt ). "\n"
756 my $cust_pkg = $opt->{'cust_pkg'};
757 my $svcs = $opt->{'svcs'} || [];
759 my %svc_options = ();
760 $svc_options{'depend_jobnum'} = $opt->{'depend_jobnum'}
761 if exists($opt->{'depend_jobnum'}) && $opt->{'depend_jobnum'};
763 my %insert_params = map { $opt->{$_} ? ( $_ => $opt->{$_} ) : () }
764 qw( ticket_subject ticket_queue );
766 local $SIG{HUP} = 'IGNORE';
767 local $SIG{INT} = 'IGNORE';
768 local $SIG{QUIT} = 'IGNORE';
769 local $SIG{TERM} = 'IGNORE';
770 local $SIG{TSTP} = 'IGNORE';
771 local $SIG{PIPE} = 'IGNORE';
773 my $oldAutoCommit = $FS::UID::AutoCommit;
774 local $FS::UID::AutoCommit = 0;
777 if ( $opt->{'cust_location'} &&
778 ( ! $cust_pkg->locationnum || $cust_pkg->locationnum == -1 ) ) {
779 my $error = $opt->{'cust_location'}->insert;
781 $dbh->rollback if $oldAutoCommit;
782 return "inserting cust_location (transaction rolled back): $error";
784 $cust_pkg->locationnum($opt->{'cust_location'}->locationnum);
787 $cust_pkg->custnum( $self->custnum );
789 my $error = $cust_pkg->insert( %insert_params );
791 $dbh->rollback if $oldAutoCommit;
792 return "inserting cust_pkg (transaction rolled back): $error";
795 foreach my $svc_something ( @{ $opt->{'svcs'} } ) {
796 if ( $svc_something->svcnum ) {
797 my $old_cust_svc = $svc_something->cust_svc;
798 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
799 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
800 $error = $new_cust_svc->replace($old_cust_svc);
802 $svc_something->pkgnum( $cust_pkg->pkgnum );
803 if ( $svc_something->isa('FS::svc_acct') ) {
804 foreach ( grep { $opt->{$_.'_ref'} && ${ $opt->{$_.'_ref'} } }
805 qw( seconds upbytes downbytes totalbytes ) ) {
806 $svc_something->$_( $svc_something->$_() + ${ $opt->{$_.'_ref'} } );
807 ${ $opt->{$_.'_ref'} } = 0;
810 $error = $svc_something->insert(%svc_options);
813 $dbh->rollback if $oldAutoCommit;
814 return "inserting svc_ (transaction rolled back): $error";
818 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
823 #deprecated #=item order_pkgs HASHREF [ , SECONDSREF ] [ , OPTION => VALUE ... ]
824 =item order_pkgs HASHREF [ , OPTION => VALUE ... ]
826 Like the insert method on an existing record, this method orders multiple
827 packages and included services atomicaly. Pass a Tie::RefHash data structure
828 to this method containing FS::cust_pkg and FS::svc_I<tablename> objects.
829 There should be a better explanation of this, but until then, here's an
833 tie %hash, 'Tie::RefHash'; #this part is important
835 $cust_pkg => [ $svc_acct ],
838 $cust_main->order_pkgs( \%hash, 'noexport'=>1 );
840 Services can be new, in which case they are inserted, or existing unaudited
841 services, in which case they are linked to the newly-created package.
843 Currently available options are: I<depend_jobnum>, I<noexport>, I<seconds_ref>,
844 I<upbytes_ref>, I<downbytes_ref>, and I<totalbytes_ref>.
846 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
847 on the supplied jobnum (they will not run until the specific job completes).
848 This can be used to defer provisioning until some action completes (such
849 as running the customer's credit card successfully).
851 The I<noexport> option is deprecated. If I<noexport> is set true, no
852 provisioning jobs (exports) are scheduled. (You can schedule them later with
853 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
854 on the cust_main object is not recommended, as existing services will also be
857 If I<seconds_ref>, I<upbytes_ref>, I<downbytes_ref>, or I<totalbytes_ref> is
858 provided, the scalars (provided by references) will be incremented by the
859 values of the prepaid card.`
865 my $cust_pkgs = shift;
866 my $seconds_ref = ref($_[0]) ? shift : ''; #deprecated
868 $seconds_ref ||= $options{'seconds_ref'};
870 warn "$me order_pkgs called with options ".
871 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
874 local $SIG{HUP} = 'IGNORE';
875 local $SIG{INT} = 'IGNORE';
876 local $SIG{QUIT} = 'IGNORE';
877 local $SIG{TERM} = 'IGNORE';
878 local $SIG{TSTP} = 'IGNORE';
879 local $SIG{PIPE} = 'IGNORE';
881 my $oldAutoCommit = $FS::UID::AutoCommit;
882 local $FS::UID::AutoCommit = 0;
885 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
887 foreach my $cust_pkg ( keys %$cust_pkgs ) {
889 my $error = $self->order_pkg(
890 'cust_pkg' => $cust_pkg,
891 'svcs' => $cust_pkgs->{$cust_pkg},
892 'seconds_ref' => $seconds_ref,
893 map { $_ => $options{$_} } qw( upbytes_ref downbytes_ref totalbytes_ref
898 $dbh->rollback if $oldAutoCommit;
904 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
908 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
910 Recharges this (existing) customer with the specified prepaid card (see
911 L<FS::prepay_credit>), specified either by I<identifier> or as an
912 FS::prepay_credit object. If there is an error, returns the error, otherwise
915 Optionally, five scalar references can be passed as well. They will have their
916 values filled in with the amount, number of seconds, and number of upload,
917 download, and total bytes applied by this prepaid card.
921 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
922 #the only place that uses these args
923 sub recharge_prepay {
924 my( $self, $prepay_credit, $amountref, $secondsref,
925 $upbytesref, $downbytesref, $totalbytesref ) = @_;
927 local $SIG{HUP} = 'IGNORE';
928 local $SIG{INT} = 'IGNORE';
929 local $SIG{QUIT} = 'IGNORE';
930 local $SIG{TERM} = 'IGNORE';
931 local $SIG{TSTP} = 'IGNORE';
932 local $SIG{PIPE} = 'IGNORE';
934 my $oldAutoCommit = $FS::UID::AutoCommit;
935 local $FS::UID::AutoCommit = 0;
938 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
940 my $error = $self->get_prepay( $prepay_credit,
941 'amount_ref' => \$amount,
942 'seconds_ref' => \$seconds,
943 'upbytes_ref' => \$upbytes,
944 'downbytes_ref' => \$downbytes,
945 'totalbytes_ref' => \$totalbytes,
947 || $self->increment_seconds($seconds)
948 || $self->increment_upbytes($upbytes)
949 || $self->increment_downbytes($downbytes)
950 || $self->increment_totalbytes($totalbytes)
951 || $self->insert_cust_pay_prepay( $amount,
953 ? $prepay_credit->identifier
958 $dbh->rollback if $oldAutoCommit;
962 if ( defined($amountref) ) { $$amountref = $amount; }
963 if ( defined($secondsref) ) { $$secondsref = $seconds; }
964 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
965 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
966 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
968 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
973 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
975 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
976 specified either by I<identifier> or as an FS::prepay_credit object.
978 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
979 incremented by the values of the prepaid card.
981 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
982 check or set this customer's I<agentnum>.
984 If there is an error, returns the error, otherwise returns false.
990 my( $self, $prepay_credit, %opt ) = @_;
992 local $SIG{HUP} = 'IGNORE';
993 local $SIG{INT} = 'IGNORE';
994 local $SIG{QUIT} = 'IGNORE';
995 local $SIG{TERM} = 'IGNORE';
996 local $SIG{TSTP} = 'IGNORE';
997 local $SIG{PIPE} = 'IGNORE';
999 my $oldAutoCommit = $FS::UID::AutoCommit;
1000 local $FS::UID::AutoCommit = 0;
1003 unless ( ref($prepay_credit) ) {
1005 my $identifier = $prepay_credit;
1007 $prepay_credit = qsearchs(
1009 { 'identifier' => $prepay_credit },
1014 unless ( $prepay_credit ) {
1015 $dbh->rollback if $oldAutoCommit;
1016 return "Invalid prepaid card: ". $identifier;
1021 if ( $prepay_credit->agentnum ) {
1022 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
1023 $dbh->rollback if $oldAutoCommit;
1024 return "prepaid card not valid for agent ". $self->agentnum;
1026 $self->agentnum($prepay_credit->agentnum);
1029 my $error = $prepay_credit->delete;
1031 $dbh->rollback if $oldAutoCommit;
1032 return "removing prepay_credit (transaction rolled back): $error";
1035 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
1036 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
1038 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1043 =item increment_upbytes SECONDS
1045 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1046 the specified number of upbytes. If there is an error, returns the error,
1047 otherwise returns false.
1051 sub increment_upbytes {
1052 _increment_column( shift, 'upbytes', @_);
1055 =item increment_downbytes SECONDS
1057 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1058 the specified number of downbytes. If there is an error, returns the error,
1059 otherwise returns false.
1063 sub increment_downbytes {
1064 _increment_column( shift, 'downbytes', @_);
1067 =item increment_totalbytes SECONDS
1069 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1070 the specified number of totalbytes. If there is an error, returns the error,
1071 otherwise returns false.
1075 sub increment_totalbytes {
1076 _increment_column( shift, 'totalbytes', @_);
1079 =item increment_seconds SECONDS
1081 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1082 the specified number of seconds. If there is an error, returns the error,
1083 otherwise returns false.
1087 sub increment_seconds {
1088 _increment_column( shift, 'seconds', @_);
1091 =item _increment_column AMOUNT
1093 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1094 the specified number of seconds or bytes. If there is an error, returns
1095 the error, otherwise returns false.
1099 sub _increment_column {
1100 my( $self, $column, $amount ) = @_;
1101 warn "$me increment_column called: $column, $amount\n"
1104 return '' unless $amount;
1106 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1107 $self->ncancelled_pkgs;
1109 if ( ! @cust_pkg ) {
1110 return 'No packages with primary or single services found'.
1111 ' to apply pre-paid time';
1112 } elsif ( scalar(@cust_pkg) > 1 ) {
1113 #maybe have a way to specify the package/account?
1114 return 'Multiple packages found to apply pre-paid time';
1117 my $cust_pkg = $cust_pkg[0];
1118 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1122 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1124 if ( ! @cust_svc ) {
1125 return 'No account found to apply pre-paid time';
1126 } elsif ( scalar(@cust_svc) > 1 ) {
1127 return 'Multiple accounts found to apply pre-paid time';
1130 my $svc_acct = $cust_svc[0]->svc_x;
1131 warn " found service svcnum ". $svc_acct->pkgnum.
1132 ' ('. $svc_acct->email. ")\n"
1135 $column = "increment_$column";
1136 $svc_acct->$column($amount);
1140 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1142 Inserts a prepayment in the specified amount for this customer. An optional
1143 second argument can specify the prepayment identifier for tracking purposes.
1144 If there is an error, returns the error, otherwise returns false.
1148 sub insert_cust_pay_prepay {
1149 shift->insert_cust_pay('PREP', @_);
1152 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1154 Inserts a cash payment in the specified amount for this customer. An optional
1155 second argument can specify the payment identifier for tracking purposes.
1156 If there is an error, returns the error, otherwise returns false.
1160 sub insert_cust_pay_cash {
1161 shift->insert_cust_pay('CASH', @_);
1164 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1166 Inserts a Western Union payment in the specified amount for this customer. An
1167 optional second argument can specify the prepayment identifier for tracking
1168 purposes. If there is an error, returns the error, otherwise returns false.
1172 sub insert_cust_pay_west {
1173 shift->insert_cust_pay('WEST', @_);
1176 sub insert_cust_pay {
1177 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1178 my $payinfo = scalar(@_) ? shift : '';
1180 my $cust_pay = new FS::cust_pay {
1181 'custnum' => $self->custnum,
1182 'paid' => sprintf('%.2f', $amount),
1183 #'_date' => #date the prepaid card was purchased???
1185 'payinfo' => $payinfo,
1193 This method is deprecated. See the I<depend_jobnum> option to the insert and
1194 order_pkgs methods for a better way to defer provisioning.
1196 Re-schedules all exports by calling the B<reexport> method of all associated
1197 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
1198 otherwise returns false.
1205 carp "WARNING: FS::cust_main::reexport is deprectated; ".
1206 "use the depend_jobnum option to insert or order_pkgs to delay export";
1208 local $SIG{HUP} = 'IGNORE';
1209 local $SIG{INT} = 'IGNORE';
1210 local $SIG{QUIT} = 'IGNORE';
1211 local $SIG{TERM} = 'IGNORE';
1212 local $SIG{TSTP} = 'IGNORE';
1213 local $SIG{PIPE} = 'IGNORE';
1215 my $oldAutoCommit = $FS::UID::AutoCommit;
1216 local $FS::UID::AutoCommit = 0;
1219 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1220 my $error = $cust_pkg->reexport;
1222 $dbh->rollback if $oldAutoCommit;
1227 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1232 =item delete NEW_CUSTNUM
1234 This deletes the customer. If there is an error, returns the error, otherwise
1237 This will completely remove all traces of the customer record. This is not
1238 what you want when a customer cancels service; for that, cancel all of the
1239 customer's packages (see L</cancel>).
1241 If the customer has any uncancelled packages, you need to pass a new (valid)
1242 customer number for those packages to be transferred to. Cancelled packages
1243 will be deleted. Did I mention that this is NOT what you want when a customer
1244 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
1246 You can't delete a customer with invoices (see L<FS::cust_bill>),
1247 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
1248 refunds (see L<FS::cust_refund>).
1255 local $SIG{HUP} = 'IGNORE';
1256 local $SIG{INT} = 'IGNORE';
1257 local $SIG{QUIT} = 'IGNORE';
1258 local $SIG{TERM} = 'IGNORE';
1259 local $SIG{TSTP} = 'IGNORE';
1260 local $SIG{PIPE} = 'IGNORE';
1262 my $oldAutoCommit = $FS::UID::AutoCommit;
1263 local $FS::UID::AutoCommit = 0;
1266 if ( $self->cust_bill ) {
1267 $dbh->rollback if $oldAutoCommit;
1268 return "Can't delete a customer with invoices";
1270 if ( $self->cust_credit ) {
1271 $dbh->rollback if $oldAutoCommit;
1272 return "Can't delete a customer with credits";
1274 if ( $self->cust_pay ) {
1275 $dbh->rollback if $oldAutoCommit;
1276 return "Can't delete a customer with payments";
1278 if ( $self->cust_refund ) {
1279 $dbh->rollback if $oldAutoCommit;
1280 return "Can't delete a customer with refunds";
1283 my @cust_pkg = $self->ncancelled_pkgs;
1285 my $new_custnum = shift;
1286 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1287 $dbh->rollback if $oldAutoCommit;
1288 return "Invalid new customer number: $new_custnum";
1290 foreach my $cust_pkg ( @cust_pkg ) {
1291 my %hash = $cust_pkg->hash;
1292 $hash{'custnum'} = $new_custnum;
1293 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1294 my $error = $new_cust_pkg->replace($cust_pkg,
1295 options => { $cust_pkg->options },
1298 $dbh->rollback if $oldAutoCommit;
1303 my @cancelled_cust_pkg = $self->all_pkgs;
1304 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1305 my $error = $cust_pkg->delete;
1307 $dbh->rollback if $oldAutoCommit;
1312 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1313 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1315 my $error = $cust_main_invoice->delete;
1317 $dbh->rollback if $oldAutoCommit;
1322 foreach my $cust_main_exemption (
1323 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } )
1325 my $error = $cust_main_exemption->delete;
1327 $dbh->rollback if $oldAutoCommit;
1332 my $error = $self->SUPER::delete;
1334 $dbh->rollback if $oldAutoCommit;
1338 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1343 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1346 Replaces the OLD_RECORD with this one in the database. If there is an error,
1347 returns the error, otherwise returns false.
1349 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1350 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1351 expected and rollback the entire transaction; it is not necessary to call
1352 check_invoicing_list first. Here's an example:
1354 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1356 Currently available options are: I<tax_exemption>.
1358 The I<tax_exemption> option can be set to an arrayref of tax names.
1359 FS::cust_main_exemption records will be deleted and inserted as appropriate.
1366 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1368 : $self->replace_old;
1372 warn "$me replace called\n"
1375 my $curuser = $FS::CurrentUser::CurrentUser;
1376 if ( $self->payby eq 'COMP'
1377 && $self->payby ne $old->payby
1378 && ! $curuser->access_right('Complimentary customer')
1381 return "You are not permitted to create complimentary accounts.";
1384 local($ignore_expired_card) = 1
1385 if $old->payby =~ /^(CARD|DCRD)$/
1386 && $self->payby =~ /^(CARD|DCRD)$/
1387 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1389 local $SIG{HUP} = 'IGNORE';
1390 local $SIG{INT} = 'IGNORE';
1391 local $SIG{QUIT} = 'IGNORE';
1392 local $SIG{TERM} = 'IGNORE';
1393 local $SIG{TSTP} = 'IGNORE';
1394 local $SIG{PIPE} = 'IGNORE';
1396 my $oldAutoCommit = $FS::UID::AutoCommit;
1397 local $FS::UID::AutoCommit = 0;
1400 my $error = $self->SUPER::replace($old);
1403 $dbh->rollback if $oldAutoCommit;
1407 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1408 my $invoicing_list = shift @param;
1409 $error = $self->check_invoicing_list( $invoicing_list );
1411 $dbh->rollback if $oldAutoCommit;
1414 $self->invoicing_list( $invoicing_list );
1417 my %options = @param;
1419 my $tax_exemption = delete $options{'tax_exemption'};
1420 if ( $tax_exemption ) {
1422 my %cust_main_exemption =
1423 map { $_->taxname => $_ }
1424 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1426 foreach my $taxname ( @$tax_exemption ) {
1428 next if delete $cust_main_exemption{$taxname};
1430 my $cust_main_exemption = new FS::cust_main_exemption {
1431 'custnum' => $self->custnum,
1432 'taxname' => $taxname,
1434 my $error = $cust_main_exemption->insert;
1436 $dbh->rollback if $oldAutoCommit;
1437 return "inserting cust_main_exemption (transaction rolled back): $error";
1441 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1442 my $error = $cust_main_exemption->delete;
1444 $dbh->rollback if $oldAutoCommit;
1445 return "deleting cust_main_exemption (transaction rolled back): $error";
1451 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1452 grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1453 # card/check/lec info has changed, want to retry realtime_ invoice events
1454 my $error = $self->retry_realtime;
1456 $dbh->rollback if $oldAutoCommit;
1461 unless ( $import || $skip_fuzzyfiles ) {
1462 $error = $self->queue_fuzzyfiles_update;
1464 $dbh->rollback if $oldAutoCommit;
1465 return "updating fuzzy search cache: $error";
1469 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1474 =item queue_fuzzyfiles_update
1476 Used by insert & replace to update the fuzzy search cache
1480 sub queue_fuzzyfiles_update {
1483 local $SIG{HUP} = 'IGNORE';
1484 local $SIG{INT} = 'IGNORE';
1485 local $SIG{QUIT} = 'IGNORE';
1486 local $SIG{TERM} = 'IGNORE';
1487 local $SIG{TSTP} = 'IGNORE';
1488 local $SIG{PIPE} = 'IGNORE';
1490 my $oldAutoCommit = $FS::UID::AutoCommit;
1491 local $FS::UID::AutoCommit = 0;
1494 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1495 my $error = $queue->insert( map $self->getfield($_),
1496 qw(first last company)
1499 $dbh->rollback if $oldAutoCommit;
1500 return "queueing job (transaction rolled back): $error";
1503 if ( $self->ship_last ) {
1504 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1505 $error = $queue->insert( map $self->getfield("ship_$_"),
1506 qw(first last company)
1509 $dbh->rollback if $oldAutoCommit;
1510 return "queueing job (transaction rolled back): $error";
1514 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1521 Checks all fields to make sure this is a valid customer record. If there is
1522 an error, returns the error, otherwise returns false. Called by the insert
1523 and replace methods.
1530 warn "$me check BEFORE: \n". $self->_dump
1534 $self->ut_numbern('custnum')
1535 || $self->ut_number('agentnum')
1536 || $self->ut_textn('agent_custid')
1537 || $self->ut_number('refnum')
1538 || $self->ut_textn('custbatch')
1539 || $self->ut_name('last')
1540 || $self->ut_name('first')
1541 || $self->ut_snumbern('birthdate')
1542 || $self->ut_snumbern('signupdate')
1543 || $self->ut_textn('company')
1544 || $self->ut_text('address1')
1545 || $self->ut_textn('address2')
1546 || $self->ut_text('city')
1547 || $self->ut_textn('county')
1548 || $self->ut_textn('state')
1549 || $self->ut_country('country')
1550 || $self->ut_anything('comments')
1551 || $self->ut_numbern('referral_custnum')
1552 || $self->ut_textn('stateid')
1553 || $self->ut_textn('stateid_state')
1554 || $self->ut_textn('invoice_terms')
1555 || $self->ut_alphan('geocode')
1556 || $self->ut_floatn('cdr_termination_percentage')
1559 #barf. need message catalogs. i18n. etc.
1560 $error .= "Please select an advertising source."
1561 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1562 return $error if $error;
1564 return "Unknown agent"
1565 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1567 return "Unknown refnum"
1568 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1570 return "Unknown referring custnum: ". $self->referral_custnum
1571 unless ! $self->referral_custnum
1572 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1574 if ( $self->censustract ne '' ) {
1575 $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
1576 or return "Illegal census tract: ". $self->censustract;
1578 $self->censustract("$1.$2");
1581 if ( $self->ss eq '' ) {
1586 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1587 or return "Illegal social security number: ". $self->ss;
1588 $self->ss("$1-$2-$3");
1592 # bad idea to disable, causes billing to fail because of no tax rates later
1593 # unless ( $import ) {
1594 unless ( qsearch('cust_main_county', {
1595 'country' => $self->country,
1598 return "Unknown state/county/country: ".
1599 $self->state. "/". $self->county. "/". $self->country
1600 unless qsearch('cust_main_county',{
1601 'state' => $self->state,
1602 'county' => $self->county,
1603 'country' => $self->country,
1609 $self->ut_phonen('daytime', $self->country)
1610 || $self->ut_phonen('night', $self->country)
1611 || $self->ut_phonen('fax', $self->country)
1612 || $self->ut_zip('zip', $self->country)
1614 return $error if $error;
1616 if ( $conf->exists('cust_main-require_phone')
1617 && ! length($self->daytime) && ! length($self->night)
1620 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1622 : FS::Msgcat::_gettext('daytime');
1623 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1625 : FS::Msgcat::_gettext('night');
1627 return "$daytime_label or $night_label is required"
1631 if ( $self->has_ship_address
1632 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1633 $self->addr_fields )
1637 $self->ut_name('ship_last')
1638 || $self->ut_name('ship_first')
1639 || $self->ut_textn('ship_company')
1640 || $self->ut_text('ship_address1')
1641 || $self->ut_textn('ship_address2')
1642 || $self->ut_text('ship_city')
1643 || $self->ut_textn('ship_county')
1644 || $self->ut_textn('ship_state')
1645 || $self->ut_country('ship_country')
1647 return $error if $error;
1649 #false laziness with above
1650 unless ( qsearchs('cust_main_county', {
1651 'country' => $self->ship_country,
1654 return "Unknown ship_state/ship_county/ship_country: ".
1655 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1656 unless qsearch('cust_main_county',{
1657 'state' => $self->ship_state,
1658 'county' => $self->ship_county,
1659 'country' => $self->ship_country,
1665 $self->ut_phonen('ship_daytime', $self->ship_country)
1666 || $self->ut_phonen('ship_night', $self->ship_country)
1667 || $self->ut_phonen('ship_fax', $self->ship_country)
1668 || $self->ut_zip('ship_zip', $self->ship_country)
1670 return $error if $error;
1672 return "Unit # is required."
1673 if $self->ship_address2 =~ /^\s*$/
1674 && $conf->exists('cust_main-require_address2');
1676 } else { # ship_ info eq billing info, so don't store dup info in database
1678 $self->setfield("ship_$_", '')
1679 foreach $self->addr_fields;
1681 return "Unit # is required."
1682 if $self->address2 =~ /^\s*$/
1683 && $conf->exists('cust_main-require_address2');
1687 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1688 # or return "Illegal payby: ". $self->payby;
1690 FS::payby->can_payby($self->table, $self->payby)
1691 or return "Illegal payby: ". $self->payby;
1693 $error = $self->ut_numbern('paystart_month')
1694 || $self->ut_numbern('paystart_year')
1695 || $self->ut_numbern('payissue')
1696 || $self->ut_textn('paytype')
1698 return $error if $error;
1700 if ( $self->payip eq '' ) {
1703 $error = $self->ut_ip('payip');
1704 return $error if $error;
1707 # If it is encrypted and the private key is not availaible then we can't
1708 # check the credit card.
1710 my $check_payinfo = 1;
1712 if ($self->is_encrypted($self->payinfo)) {
1716 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1718 my $payinfo = $self->payinfo;
1719 $payinfo =~ s/\D//g;
1720 $payinfo =~ /^(\d{13,16})$/
1721 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1723 $self->payinfo($payinfo);
1725 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1727 return gettext('unknown_card_type')
1728 if cardtype($self->payinfo) eq "Unknown";
1730 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1732 return 'Banned credit card: banned on '.
1733 time2str('%a %h %o at %r', $ban->_date).
1734 ' by '. $ban->otaker.
1735 ' (ban# '. $ban->bannum. ')';
1738 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1739 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1740 $self->paycvv =~ /^(\d{4})$/
1741 or return "CVV2 (CID) for American Express cards is four digits.";
1744 $self->paycvv =~ /^(\d{3})$/
1745 or return "CVV2 (CVC2/CID) is three digits.";
1752 my $cardtype = cardtype($payinfo);
1753 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1755 return "Start date or issue number is required for $cardtype cards"
1756 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1758 return "Start month must be between 1 and 12"
1759 if $self->paystart_month
1760 and $self->paystart_month < 1 || $self->paystart_month > 12;
1762 return "Start year must be 1990 or later"
1763 if $self->paystart_year
1764 and $self->paystart_year < 1990;
1766 return "Issue number must be beween 1 and 99"
1768 and $self->payissue < 1 || $self->payissue > 99;
1771 $self->paystart_month('');
1772 $self->paystart_year('');
1773 $self->payissue('');
1776 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1778 my $payinfo = $self->payinfo;
1779 $payinfo =~ s/[^\d\@]//g;
1780 if ( $conf->exists('echeck-nonus') ) {
1781 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1782 $payinfo = "$1\@$2";
1784 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1785 $payinfo = "$1\@$2";
1787 $self->payinfo($payinfo);
1790 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1792 return 'Banned ACH account: banned on '.
1793 time2str('%a %h %o at %r', $ban->_date).
1794 ' by '. $ban->otaker.
1795 ' (ban# '. $ban->bannum. ')';
1798 } elsif ( $self->payby eq 'LECB' ) {
1800 my $payinfo = $self->payinfo;
1801 $payinfo =~ s/\D//g;
1802 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1804 $self->payinfo($payinfo);
1807 } elsif ( $self->payby eq 'BILL' ) {
1809 $error = $self->ut_textn('payinfo');
1810 return "Illegal P.O. number: ". $self->payinfo if $error;
1813 } elsif ( $self->payby eq 'COMP' ) {
1815 my $curuser = $FS::CurrentUser::CurrentUser;
1816 if ( ! $self->custnum
1817 && ! $curuser->access_right('Complimentary customer')
1820 return "You are not permitted to create complimentary accounts."
1823 $error = $self->ut_textn('payinfo');
1824 return "Illegal comp account issuer: ". $self->payinfo if $error;
1827 } elsif ( $self->payby eq 'PREPAY' ) {
1829 my $payinfo = $self->payinfo;
1830 $payinfo =~ s/\W//g; #anything else would just confuse things
1831 $self->payinfo($payinfo);
1832 $error = $self->ut_alpha('payinfo');
1833 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1834 return "Unknown prepayment identifier"
1835 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1840 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1841 return "Expiration date required"
1842 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1846 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1847 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1848 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1849 ( $m, $y ) = ( $2, "19$1" );
1850 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1851 ( $m, $y ) = ( $3, "20$2" );
1853 return "Illegal expiration date: ". $self->paydate;
1855 $self->paydate("$y-$m-01");
1856 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1857 return gettext('expired_card')
1859 && !$ignore_expired_card
1860 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1863 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1864 ( ! $conf->exists('require_cardname')
1865 || $self->payby !~ /^(CARD|DCRD)$/ )
1867 $self->payname( $self->first. " ". $self->getfield('last') );
1869 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1870 or return gettext('illegal_name'). " payname: ". $self->payname;
1874 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
1875 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1879 $self->otaker(getotaker) unless $self->otaker;
1881 warn "$me check AFTER: \n". $self->_dump
1884 $self->SUPER::check;
1889 Returns a list of fields which have ship_ duplicates.
1894 qw( last first company
1895 address1 address2 city county state zip country
1900 =item has_ship_address
1902 Returns true if this customer record has a separate shipping address.
1906 sub has_ship_address {
1908 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
1911 =item all_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
1913 Returns all packages (see L<FS::cust_pkg>) for this customer.
1919 my $extra_qsearch = ref($_[0]) ? shift : {};
1921 return $self->num_pkgs unless wantarray || keys(%$extra_qsearch);
1924 if ( $self->{'_pkgnum'} ) {
1925 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1927 @cust_pkg = $self->_cust_pkg($extra_qsearch);
1930 sort sort_packages @cust_pkg;
1935 Synonym for B<all_pkgs>.
1940 shift->all_pkgs(@_);
1945 Returns all locations (see L<FS::cust_location>) for this customer.
1951 qsearch('cust_location', { 'custnum' => $self->custnum } );
1954 =item ncancelled_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
1956 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1960 sub ncancelled_pkgs {
1962 my $extra_qsearch = ref($_[0]) ? shift : {};
1964 return $self->num_ncancelled_pkgs unless wantarray;
1967 if ( $self->{'_pkgnum'} ) {
1969 warn "$me ncancelled_pkgs: returning cached objects"
1972 @cust_pkg = grep { ! $_->getfield('cancel') }
1973 values %{ $self->{'_pkgnum'}->cache };
1977 warn "$me ncancelled_pkgs: searching for packages with custnum ".
1978 $self->custnum. "\n"
1981 $extra_qsearch->{'extra_sql'} .= ' AND ( cancel IS NULL OR cancel = 0 ) ';
1983 @cust_pkg = $self->_cust_pkg($extra_qsearch);
1987 sort sort_packages @cust_pkg;
1993 my $extra_qsearch = ref($_[0]) ? shift : {};
1995 $extra_qsearch->{'select'} ||= '*';
1996 $extra_qsearch->{'select'} .=
1997 ',( SELECT COUNT(*) FROM cust_svc WHERE cust_pkg.pkgnum = cust_svc.pkgnum )
2001 $_->{'_num_cust_svc'} = $_->get('_num_cust_svc');
2006 'table' => 'cust_pkg',
2007 'hashref' => { 'custnum' => $self->custnum },
2012 # This should be generalized to use config options to determine order.
2015 if ( $a->get('cancel') xor $b->get('cancel') ) {
2016 return -1 if $b->get('cancel');
2017 return 1 if $a->get('cancel');
2018 #shouldn't get here...
2021 my $a_num_cust_svc = $a->num_cust_svc;
2022 my $b_num_cust_svc = $b->num_cust_svc;
2023 return 0 if !$a_num_cust_svc && !$b_num_cust_svc;
2024 return -1 if $a_num_cust_svc && !$b_num_cust_svc;
2025 return 1 if !$a_num_cust_svc && $b_num_cust_svc;
2026 my @a_cust_svc = $a->cust_svc;
2027 my @b_cust_svc = $b->cust_svc;
2028 $a_cust_svc[0]->svc_x->label cmp $b_cust_svc[0]->svc_x->label;
2033 =item suspended_pkgs
2035 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
2039 sub suspended_pkgs {
2041 grep { $_->susp } $self->ncancelled_pkgs;
2044 =item unflagged_suspended_pkgs
2046 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
2047 customer (thouse packages without the `manual_flag' set).
2051 sub unflagged_suspended_pkgs {
2053 return $self->suspended_pkgs
2054 unless dbdef->table('cust_pkg')->column('manual_flag');
2055 grep { ! $_->manual_flag } $self->suspended_pkgs;
2058 =item unsuspended_pkgs
2060 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
2065 sub unsuspended_pkgs {
2067 grep { ! $_->susp } $self->ncancelled_pkgs;
2070 =item next_bill_date
2072 Returns the next date this customer will be billed, as a UNIX timestamp, or
2073 undef if no active package has a next bill date.
2077 sub next_bill_date {
2079 min( map $_->get('bill'), grep $_->get('bill'), $self->unsuspended_pkgs );
2082 =item num_cancelled_pkgs
2084 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
2089 sub num_cancelled_pkgs {
2090 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
2093 sub num_ncancelled_pkgs {
2094 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
2098 my( $self ) = shift;
2099 my $sql = scalar(@_) ? shift : '';
2100 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
2101 my $sth = dbh->prepare(
2102 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
2103 ) or die dbh->errstr;
2104 $sth->execute($self->custnum) or die $sth->errstr;
2105 $sth->fetchrow_arrayref->[0];
2110 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2111 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2112 on success or a list of errors.
2118 grep { $_->unsuspend } $self->suspended_pkgs;
2123 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2125 Returns a list: an empty list on success or a list of errors.
2131 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2134 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2136 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2137 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2138 of a list of pkgparts; the hashref has the following keys:
2142 =item pkgparts - listref of pkgparts
2144 =item (other options are passed to the suspend method)
2149 Returns a list: an empty list on success or a list of errors.
2153 sub suspend_if_pkgpart {
2155 my (@pkgparts, %opt);
2156 if (ref($_[0]) eq 'HASH'){
2157 @pkgparts = @{$_[0]{pkgparts}};
2162 grep { $_->suspend(%opt) }
2163 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2164 $self->unsuspended_pkgs;
2167 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2169 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2170 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2171 instead of a list of pkgparts; the hashref has the following keys:
2175 =item pkgparts - listref of pkgparts
2177 =item (other options are passed to the suspend method)
2181 Returns a list: an empty list on success or a list of errors.
2185 sub suspend_unless_pkgpart {
2187 my (@pkgparts, %opt);
2188 if (ref($_[0]) eq 'HASH'){
2189 @pkgparts = @{$_[0]{pkgparts}};
2194 grep { $_->suspend(%opt) }
2195 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2196 $self->unsuspended_pkgs;
2199 =item cancel [ OPTION => VALUE ... ]
2201 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2203 Available options are:
2207 =item quiet - can be set true to supress email cancellation notices.
2209 =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.
2211 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2213 =item nobill - can be set true to skip billing if it might otherwise be done.
2217 Always returns a list: an empty list on success or a list of errors.
2221 # nb that dates are not specified as valid options to this method
2224 my( $self, %opt ) = @_;
2226 warn "$me cancel called on customer ". $self->custnum. " with options ".
2227 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2230 return ( 'access denied' )
2231 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2233 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2235 #should try decryption (we might have the private key)
2236 # and if not maybe queue a job for the server that does?
2237 return ( "Can't (yet) ban encrypted credit cards" )
2238 if $self->is_encrypted($self->payinfo);
2240 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
2241 my $error = $ban->insert;
2242 return ( $error ) if $error;
2246 my @pkgs = $self->ncancelled_pkgs;
2248 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2250 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2251 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2255 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2256 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2259 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2262 sub _banned_pay_hashref {
2273 'payby' => $payby2ban{$self->payby},
2274 'payinfo' => md5_base64($self->payinfo),
2275 #don't ever *search* on reason! #'reason' =>
2281 Returns all notes (see L<FS::cust_main_note>) for this customer.
2288 qsearch( 'cust_main_note',
2289 { 'custnum' => $self->custnum },
2291 'ORDER BY _DATE DESC'
2297 Returns the agent (see L<FS::agent>) for this customer.
2303 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2306 =item bill_and_collect
2308 Cancels and suspends any packages due, generates bills, applies payments and
2311 Warns on errors (Does not currently: If there is an error, returns the error, otherwise returns false.)
2313 Options are passed as name-value pairs. Currently available options are:
2319 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:
2323 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2327 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.
2331 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2335 If set true, re-charges setup fees.
2339 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)
2343 Options are passed to the B<bill> and B<collect> methods verbatim, so all
2344 options of those methods are also available.
2348 sub bill_and_collect {
2349 my( $self, %options ) = @_;
2351 #$options{actual_time} not $options{time} because freeside-daily -d is for
2352 #pre-printing invoices
2353 $self->cancel_expired_pkgs( $options{actual_time} );
2354 $self->suspend_adjourned_pkgs( $options{actual_time} );
2356 my $error = $self->bill( %options );
2357 warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
2359 $self->apply_payments_and_credits;
2361 unless ( $conf->exists('cancelled_cust-noevents')
2362 && ! $self->num_ncancelled_pkgs
2365 $error = $self->collect( %options );
2366 warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
2372 sub cancel_expired_pkgs {
2373 my ( $self, $time ) = @_;
2375 my @cancel_pkgs = $self->ncancelled_pkgs( {
2376 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
2379 foreach my $cust_pkg ( @cancel_pkgs ) {
2380 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
2381 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
2382 'reason_otaker' => $cpr->otaker
2386 warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
2387 " for custnum ". $self->custnum. ": $error"
2393 sub suspend_adjourned_pkgs {
2394 my ( $self, $time ) = @_;
2396 my @susp_pkgs = $self->ncancelled_pkgs( {
2398 " AND ( susp IS NULL OR susp = 0 )
2399 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
2400 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
2405 #only because there's no SQL test for is_prepaid :/
2407 grep { ( $_->part_pkg->is_prepaid
2412 && $_->adjourn <= $time
2418 foreach my $cust_pkg ( @susp_pkgs ) {
2419 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
2420 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
2421 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
2422 'reason_otaker' => $cpr->otaker
2427 warn "Error suspending package ". $cust_pkg->pkgnum.
2428 " for custnum ". $self->custnum. ": $error"
2436 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
2437 conjunction with the collect method by calling B<bill_and_collect>.
2439 If there is an error, returns the error, otherwise returns false.
2441 Options are passed as name-value pairs. Currently available options are:
2447 If set true, re-charges setup fees.
2451 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:
2455 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2459 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2461 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2465 A hashref of pkgparts to exclude from this billing run.
2469 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.
2473 This boolean value informs the us that the package is being cancelled. This
2474 typically might mean not charging the normal recurring fee but only usage
2475 fees since the last billing. Setup charges may be charged. Not all package
2476 plans support this feature (they tend to charge 0).
2483 my( $self, %options ) = @_;
2484 return '' if $self->payby eq 'COMP';
2485 warn "$me bill customer ". $self->custnum. "\n"
2488 my $time = $options{'time'} || time;
2489 my $invoice_time = $options{'invoice_time'} || $time;
2491 $options{'not_pkgpart'} ||= {};
2493 local $SIG{HUP} = 'IGNORE';
2494 local $SIG{INT} = 'IGNORE';
2495 local $SIG{QUIT} = 'IGNORE';
2496 local $SIG{TERM} = 'IGNORE';
2497 local $SIG{TSTP} = 'IGNORE';
2498 local $SIG{PIPE} = 'IGNORE';
2500 my $oldAutoCommit = $FS::UID::AutoCommit;
2501 local $FS::UID::AutoCommit = 0;
2504 $self->select_for_update; #mutex
2506 my $error = $self->do_cust_event(
2507 'debug' => ( $options{'debug'} || 0 ),
2508 'time' => $invoice_time,
2509 'check_freq' => $options{'check_freq'},
2510 'stage' => 'pre-bill',
2513 $dbh->rollback if $oldAutoCommit;
2517 my @cust_bill_pkg = ();
2520 # find the packages which are due for billing, find out how much they are
2521 # & generate invoice database.
2524 my( $total_setup, $total_recur, $postal_charge ) = ( 0, 0, 0 );
2526 my @precommit_hooks = ();
2528 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
2529 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
2531 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
2533 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2535 #? to avoid use of uninitialized value errors... ?
2536 $cust_pkg->setfield('bill', '')
2537 unless defined($cust_pkg->bill);
2539 #my $part_pkg = $cust_pkg->part_pkg;
2541 my $real_pkgpart = $cust_pkg->pkgpart;
2542 my %hash = $cust_pkg->hash;
2544 foreach my $part_pkg ( $cust_pkg->part_pkg->self_and_bill_linked ) {
2546 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
2549 $self->_make_lines( 'part_pkg' => $part_pkg,
2550 'cust_pkg' => $cust_pkg,
2551 'precommit_hooks' => \@precommit_hooks,
2552 'line_items' => \@cust_bill_pkg,
2553 'setup' => \$total_setup,
2554 'recur' => \$total_recur,
2555 'tax_matrix' => \%taxlisthash,
2557 'real_pkgpart' => $real_pkgpart,
2558 'options' => \%options,
2561 $dbh->rollback if $oldAutoCommit;
2565 } #foreach my $part_pkg
2567 } #foreach my $cust_pkg
2569 unless ( @cust_bill_pkg ) { #don't create an invoice w/o line items
2570 #but do commit any package date cycling that happened
2571 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2575 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
2576 !$conf->exists('postal_invoice-recurring_only')
2580 my $postal_pkg = $self->charge_postal_fee();
2581 if ( $postal_pkg && !ref( $postal_pkg ) ) {
2583 $dbh->rollback if $oldAutoCommit;
2584 return "can't charge postal invoice fee for customer ".
2585 $self->custnum. ": $postal_pkg";
2587 } elsif ( $postal_pkg ) {
2589 my $real_pkgpart = $postal_pkg->pkgpart;
2590 foreach my $part_pkg ( $postal_pkg->part_pkg->self_and_bill_linked ) {
2591 my %postal_options = %options;
2592 delete $postal_options{cancel};
2594 $self->_make_lines( 'part_pkg' => $part_pkg,
2595 'cust_pkg' => $postal_pkg,
2596 'precommit_hooks' => \@precommit_hooks,
2597 'line_items' => \@cust_bill_pkg,
2598 'setup' => \$total_setup,
2599 'recur' => \$total_recur,
2600 'tax_matrix' => \%taxlisthash,
2602 'real_pkgpart' => $real_pkgpart,
2603 'options' => \%postal_options,
2606 $dbh->rollback if $oldAutoCommit;
2615 warn "having a look at the taxes we found...\n" if $DEBUG > 2;
2617 # keys are tax names (as printed on invoices / itemdesc )
2618 # values are listrefs of taxlisthash keys (internal identifiers)
2621 # keys are taxlisthash keys (internal identifiers)
2622 # values are (cumulative) amounts
2625 # keys are taxlisthash keys (internal identifiers)
2626 # values are listrefs of cust_bill_pkg_tax_location hashrefs
2627 my %tax_location = ();
2629 # keys are taxlisthash keys (internal identifiers)
2630 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
2631 my %tax_rate_location = ();
2633 foreach my $tax ( keys %taxlisthash ) {
2634 my $tax_object = shift @{ $taxlisthash{$tax} };
2635 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
2636 warn " ". join('/', @{ $taxlisthash{$tax} } ). "\n" if $DEBUG > 2;
2637 my $hashref_or_error =
2638 $tax_object->taxline( $taxlisthash{$tax},
2639 'custnum' => $self->custnum,
2640 'invoice_time' => $invoice_time
2642 unless ( ref($hashref_or_error) ) {
2643 $dbh->rollback if $oldAutoCommit;
2644 return $hashref_or_error;
2646 unshift @{ $taxlisthash{$tax} }, $tax_object;
2648 my $name = $hashref_or_error->{'name'};
2649 my $amount = $hashref_or_error->{'amount'};
2651 #warn "adding $amount as $name\n";
2652 $taxname{ $name } ||= [];
2653 push @{ $taxname{ $name } }, $tax;
2655 $tax{ $tax } += $amount;
2657 $tax_location{ $tax } ||= [];
2658 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
2659 push @{ $tax_location{ $tax } },
2661 'taxnum' => $tax_object->taxnum,
2662 'taxtype' => ref($tax_object),
2663 'pkgnum' => $tax_object->get('pkgnum'),
2664 'locationnum' => $tax_object->get('locationnum'),
2665 'amount' => sprintf('%.2f', $amount ),
2669 $tax_rate_location{ $tax } ||= [];
2670 if ( ref($tax_object) eq 'FS::tax_rate' ) {
2671 my $taxratelocationnum =
2672 $tax_object->tax_rate_location->taxratelocationnum;
2673 push @{ $tax_rate_location{ $tax } },
2675 'taxnum' => $tax_object->taxnum,
2676 'taxtype' => ref($tax_object),
2677 'amount' => sprintf('%.2f', $amount ),
2678 'locationtaxid' => $tax_object->location,
2679 'taxratelocationnum' => $taxratelocationnum,
2685 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
2686 my %packagemap = map { $_->pkgnum => $_ } @cust_bill_pkg;
2687 foreach my $tax ( keys %taxlisthash ) {
2688 foreach ( @{ $taxlisthash{$tax} }[1 ... scalar(@{ $taxlisthash{$tax} })] ) {
2689 next unless ref($_) eq 'FS::cust_bill_pkg';
2691 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
2692 splice( @{ $_->_cust_tax_exempt_pkg } );
2696 #consolidate and create tax line items
2697 warn "consolidating and generating...\n" if $DEBUG > 2;
2698 foreach my $taxname ( keys %taxname ) {
2701 my @cust_bill_pkg_tax_location = ();
2702 my @cust_bill_pkg_tax_rate_location = ();
2703 warn "adding $taxname\n" if $DEBUG > 1;
2704 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
2705 next if $seen{$taxitem}++;
2706 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
2707 $tax += $tax{$taxitem};
2708 push @cust_bill_pkg_tax_location,
2709 map { new FS::cust_bill_pkg_tax_location $_ }
2710 @{ $tax_location{ $taxitem } };
2711 push @cust_bill_pkg_tax_rate_location,
2712 map { new FS::cust_bill_pkg_tax_rate_location $_ }
2713 @{ $tax_rate_location{ $taxitem } };
2717 $tax = sprintf('%.2f', $tax );
2718 $total_setup = sprintf('%.2f', $total_setup+$tax );
2720 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
2726 if ( $pkg_category and
2727 $conf->config('invoice_latexsummary') ||
2728 $conf->config('invoice_htmlsummary')
2732 my %hash = ( 'section' => $pkg_category->categoryname );
2733 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
2737 push @cust_bill_pkg, new FS::cust_bill_pkg {
2743 'itemdesc' => $taxname,
2744 'display' => \@display,
2745 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2746 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
2751 #add tax adjustments
2752 warn "adding tax adjustments...\n" if $DEBUG > 2;
2753 foreach my $cust_tax_adjustment (
2754 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
2760 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
2761 $total_setup = sprintf('%.2f', $total_setup+$tax );
2763 my $itemdesc = $cust_tax_adjustment->taxname;
2764 $itemdesc = '' if $itemdesc eq 'Tax';
2766 push @cust_bill_pkg, new FS::cust_bill_pkg {
2772 'itemdesc' => $itemdesc,
2773 'itemcomment' => $cust_tax_adjustment->comment,
2774 'cust_tax_adjustment' => $cust_tax_adjustment,
2775 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2780 my $charged = sprintf('%.2f', $total_setup + $total_recur );
2782 my @cust_bill = $self->cust_bill;
2783 my $balance = $self->balance;
2784 my $previous_balance = scalar(@cust_bill)
2785 ? $cust_bill[$#cust_bill]->billing_balance
2788 $previous_balance += $cust_bill[$#cust_bill]->charged
2789 if scalar(@cust_bill);
2790 #my $balance_adjustments =
2791 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
2793 #create the new invoice
2794 my $cust_bill = new FS::cust_bill ( {
2795 'custnum' => $self->custnum,
2796 '_date' => ( $invoice_time ),
2797 'charged' => $charged,
2798 'billing_balance' => $balance,
2799 'previous_balance' => $previous_balance,
2801 $error = $cust_bill->insert;
2803 $dbh->rollback if $oldAutoCommit;
2804 return "can't create invoice for customer #". $self->custnum. ": $error";
2807 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
2808 $cust_bill_pkg->invnum($cust_bill->invnum);
2809 my $error = $cust_bill_pkg->insert;
2811 $dbh->rollback if $oldAutoCommit;
2812 return "can't create invoice line item: $error";
2817 foreach my $hook ( @precommit_hooks ) {
2819 &{$hook}; #($self) ?
2822 $dbh->rollback if $oldAutoCommit;
2823 return "$@ running precommit hook $hook\n";
2827 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2833 my ($self, %params) = @_;
2835 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
2836 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
2837 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
2838 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
2839 my $total_setup = $params{setup} or die "no setup accumulator specified";
2840 my $total_recur = $params{recur} or die "no recur accumulator specified";
2841 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
2842 my $time = $params{'time'} or die "no time specified";
2843 my (%options) = %{$params{options}};
2846 my $real_pkgpart = $params{real_pkgpart};
2847 my %hash = $cust_pkg->hash;
2848 my $old_cust_pkg = new FS::cust_pkg \%hash;
2854 $cust_pkg->pkgpart($part_pkg->pkgpart);
2862 if ( $options{'resetup'}
2863 || ( ! $cust_pkg->setup
2864 && ( ! $cust_pkg->start_date
2865 || $cust_pkg->start_date <= $time
2867 && ( ! $conf->exists('disable_setup_suspended_pkgs')
2868 || ( $conf->exists('disable_setup_suspended_pkgs') &&
2869 ! $cust_pkg->getfield('susp')
2876 warn " bill setup\n" if $DEBUG > 1;
2879 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2880 return "$@ running calc_setup for $cust_pkg\n"
2883 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
2885 $cust_pkg->setfield('setup', $time)
2886 unless $cust_pkg->setup;
2887 #do need it, but it won't get written to the db
2888 #|| $cust_pkg->pkgpart != $real_pkgpart;
2890 $cust_pkg->setfield('start_date', '')
2891 if $cust_pkg->start_date;
2896 # bill recurring fee
2899 #XXX unit stuff here too
2903 if ( ! $cust_pkg->get('susp')
2904 and ! $cust_pkg->get('start_date')
2905 and ( $part_pkg->getfield('freq') ne '0'
2906 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
2908 || ( $part_pkg->plan eq 'voip_cdr'
2909 && $part_pkg->option('bill_every_call')
2911 || ( $options{cancel} )
2914 # XXX should this be a package event? probably. events are called
2915 # at collection time at the moment, though...
2916 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
2917 if $part_pkg->can('reset_usage');
2918 #don't want to reset usage just cause we want a line item??
2919 #&& $part_pkg->pkgpart == $real_pkgpart;
2921 warn " bill recur\n" if $DEBUG > 1;
2924 # XXX shared with $recur_prog
2925 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
2929 #over two params! lets at least switch to a hashref for the rest...
2930 my $increment_next_bill = ( $part_pkg->freq ne '0'
2931 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
2932 && !$options{cancel}
2934 my %param = ( 'precommit_hooks' => $precommit_hooks,
2935 'increment_next_bill' => $increment_next_bill,
2938 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
2939 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
2940 return "$@ running $method for $cust_pkg\n"
2943 if ( $increment_next_bill ) {
2945 my $next_bill = $part_pkg->add_freq($sdate);
2946 return "unparsable frequency: ". $part_pkg->freq
2947 if $next_bill == -1;
2949 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
2950 # only for figuring next bill date, nothing else, so, reset $sdate again
2952 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2953 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
2954 $cust_pkg->last_bill($sdate);
2956 $cust_pkg->setfield('bill', $next_bill );
2962 warn "\$setup is undefined" unless defined($setup);
2963 warn "\$recur is undefined" unless defined($recur);
2964 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2967 # If there's line items, create em cust_bill_pkg records
2968 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
2973 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
2974 # hmm.. and if just the options are modified in some weird price plan?
2976 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
2979 my $error = $cust_pkg->replace( $old_cust_pkg,
2980 'options' => { $cust_pkg->options },
2982 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
2983 if $error; #just in case
2986 $setup = sprintf( "%.2f", $setup );
2987 $recur = sprintf( "%.2f", $recur );
2988 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2989 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2991 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2992 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2995 if ( $setup != 0 || $recur != 0 ) {
2997 warn " charges (setup=$setup, recur=$recur); adding line items\n"
3000 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
3002 warn " adding customer package invoice detail: $_\n"
3003 foreach @cust_pkg_detail;
3005 push @details, @cust_pkg_detail;
3007 my $cust_bill_pkg = new FS::cust_bill_pkg {
3008 'pkgnum' => $cust_pkg->pkgnum,
3010 'unitsetup' => $unitsetup,
3012 'unitrecur' => $unitrecur,
3013 'quantity' => $cust_pkg->quantity,
3014 'details' => \@details,
3015 'hidden' => $part_pkg->hidden,
3018 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
3019 $cust_bill_pkg->sdate( $hash{last_bill} );
3020 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
3021 $cust_bill_pkg->edate( $time ) if $options{cancel};
3022 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
3023 $cust_bill_pkg->sdate( $sdate );
3024 $cust_bill_pkg->edate( $cust_pkg->bill );
3025 #$cust_bill_pkg->edate( $time ) if $options{cancel};
3028 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
3029 unless $part_pkg->pkgpart == $real_pkgpart;
3031 $$total_setup += $setup;
3032 $$total_recur += $recur;
3039 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
3040 return $error if $error;
3042 push @$cust_bill_pkgs, $cust_bill_pkg;
3044 } #if $setup != 0 || $recur != 0
3054 my $part_pkg = shift;
3055 my $taxlisthash = shift;
3056 my $cust_bill_pkg = shift;
3057 my $cust_pkg = shift;
3058 my $invoice_time = shift;
3059 my $real_pkgpart = shift;
3060 my $options = shift;
3062 my %cust_bill_pkg = ();
3066 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
3067 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
3068 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
3069 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
3071 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
3073 if ( $conf->exists('enable_taxproducts')
3074 && ( scalar($part_pkg->part_pkg_taxoverride)
3075 || $part_pkg->has_taxproduct
3080 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3081 return "fatal: Can't (yet) use tax-pkg_address with taxproducts";
3084 foreach my $class (@classes) {
3085 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class );
3086 return $err_or_ref unless ref($err_or_ref);
3087 $taxes{$class} = $err_or_ref;
3090 unless (exists $taxes{''}) {
3091 my $err_or_ref = $self->_gather_taxes( $part_pkg, '' );
3092 return $err_or_ref unless ref($err_or_ref);
3093 $taxes{''} = $err_or_ref;
3098 my @loc_keys = qw( state county country );
3100 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3101 my $cust_location = $cust_pkg->cust_location;
3102 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
3105 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
3108 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
3111 $taxhash{'taxclass'} = $part_pkg->taxclass;
3113 my @taxes = qsearch( 'cust_main_county', \%taxhash );
3115 my %taxhash_elim = %taxhash;
3117 my @elim = qw( taxclass county state );
3118 while ( !scalar(@taxes) && scalar(@elim) ) {
3119 $taxhash_elim{ shift(@elim) } = '';
3120 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
3123 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
3125 if $self->cust_main_exemption; #just to be safe
3127 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3129 $_->set('pkgnum', $cust_pkg->pkgnum );
3130 $_->set('locationnum', $cust_pkg->locationnum );
3134 $taxes{''} = [ @taxes ];
3135 $taxes{'setup'} = [ @taxes ];
3136 $taxes{'recur'} = [ @taxes ];
3137 $taxes{$_} = [ @taxes ] foreach (@classes);
3139 # # maybe eliminate this entirely, along with all the 0% records
3140 # unless ( @taxes ) {
3142 # "fatal: can't find tax rate for state/county/country/taxclass ".
3143 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
3146 } #if $conf->exists('enable_taxproducts') ...
3151 my $separate = $conf->exists('separate_usage');
3152 my $usage_mandate = $cust_pkg->part_pkg->option('usage_mandate', 'Hush!');
3153 if ( $separate || $cust_bill_pkg->hidden || $usage_mandate ) {
3155 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
3156 my %hash = $cust_bill_pkg->hidden # maybe for all bill linked?
3157 ? ( 'section' => $temp_pkg->part_pkg->categoryname )
3160 my $section = $cust_pkg->part_pkg->option('usage_section', 'Hush!');
3161 my $summary = $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
3163 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3164 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
3166 push @display, new FS::cust_bill_pkg_display
3169 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
3173 if ($separate && $section && $summary) {
3174 push @display, new FS::cust_bill_pkg_display { type => 'U',
3179 if ($usage_mandate || $section && $summary) {
3180 $hash{post_total} = 'Y';
3183 $hash{section} = $section if ($separate || $usage_mandate);
3184 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
3187 $cust_bill_pkg->set('display', \@display);
3189 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
3190 foreach my $key (keys %tax_cust_bill_pkg) {
3191 my @taxes = @{ $taxes{$key} || [] };
3192 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
3194 my %localtaxlisthash = ();
3195 foreach my $tax ( @taxes ) {
3197 my $taxname = ref( $tax ). ' '. $tax->taxnum;
3198 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
3199 # ' locationnum'. $cust_pkg->locationnum
3200 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
3202 $taxlisthash->{ $taxname } ||= [ $tax ];
3203 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
3205 $localtaxlisthash{ $taxname } ||= [ $tax ];
3206 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
3210 warn "finding taxed taxes...\n" if $DEBUG > 2;
3211 foreach my $tax ( keys %localtaxlisthash ) {
3212 my $tax_object = shift @{ $localtaxlisthash{$tax} };
3213 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
3215 next unless $tax_object->can('tax_on_tax');
3217 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
3218 my $totname = ref( $tot ). ' '. $tot->taxnum;
3220 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
3222 next unless exists( $localtaxlisthash{ $totname } ); # only increase
3224 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
3225 my $hashref_or_error =
3226 $tax_object->taxline( $localtaxlisthash{$tax},
3227 'custnum' => $self->custnum,
3228 'invoice_time' => $invoice_time,
3230 return $hashref_or_error
3231 unless ref($hashref_or_error);
3233 $taxlisthash->{ $totname } ||= [ $tot ];
3234 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
3246 my $part_pkg = shift;
3250 my $geocode = $self->geocode('cch');
3252 my @taxclassnums = map { $_->taxclassnum }
3253 $part_pkg->part_pkg_taxoverride($class);
3255 unless (@taxclassnums) {
3256 @taxclassnums = map { $_->taxclassnum }
3257 grep { $_->taxable eq 'Y' }
3258 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
3260 warn "Found taxclassnum values of ". join(',', @taxclassnums)
3265 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
3267 @taxes = qsearch({ 'table' => 'tax_rate',
3268 'hashref' => { 'geocode' => $geocode, },
3269 'extra_sql' => $extra_sql,
3271 if scalar(@taxclassnums);
3273 warn "Found taxes ".
3274 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
3281 =item collect [ HASHREF | OPTION => VALUE ... ]
3283 (Attempt to) collect money for this customer's outstanding invoices (see
3284 L<FS::cust_bill>). Usually used after the bill method.
3286 Actions are now triggered by billing events; see L<FS::part_event> and the
3287 billing events web interface. Old-style invoice events (see
3288 L<FS::part_bill_event>) have been deprecated.
3290 If there is an error, returns the error, otherwise returns false.
3292 Options are passed as name-value pairs.
3294 Currently available options are:
3300 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.
3304 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3308 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3312 set true to surpress email card/ACH decline notices.
3316 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)
3322 # allows for one time override of normal customer billing method
3327 my( $self, %options ) = @_;
3328 my $invoice_time = $options{'invoice_time'} || time;
3331 local $SIG{HUP} = 'IGNORE';
3332 local $SIG{INT} = 'IGNORE';
3333 local $SIG{QUIT} = 'IGNORE';
3334 local $SIG{TERM} = 'IGNORE';
3335 local $SIG{TSTP} = 'IGNORE';
3336 local $SIG{PIPE} = 'IGNORE';
3338 my $oldAutoCommit = $FS::UID::AutoCommit;
3339 local $FS::UID::AutoCommit = 0;
3342 $self->select_for_update; #mutex
3345 my $balance = $self->balance;
3346 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
3349 if ( exists($options{'retry_card'}) ) {
3350 carp 'retry_card option passed to collect is deprecated; use retry';
3351 $options{'retry'} ||= $options{'retry_card'};
3353 if ( exists($options{'retry'}) && $options{'retry'} ) {
3354 my $error = $self->retry_realtime;
3356 $dbh->rollback if $oldAutoCommit;
3361 my $error = $self->do_cust_event(
3362 'debug' => ( $options{'debug'} || 0 ),
3363 'time' => $invoice_time,
3364 'check_freq' => $options{'check_freq'},
3365 'stage' => 'collect',
3368 $dbh->rollback if $oldAutoCommit;
3372 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3377 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
3379 Runs billing events; see L<FS::part_event> and the billing events web
3382 If there is an error, returns the error, otherwise returns false.
3384 Options are passed as name-value pairs.
3386 Currently available options are:
3392 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.
3396 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3400 "collect" (the default) or "pre-bill"
3404 set true to surpress email card/ACH decline notices.
3408 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)
3414 # allows for one time override of normal customer billing method
3418 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3421 my( $self, %options ) = @_;
3422 my $time = $options{'time'} || time;
3425 local $SIG{HUP} = 'IGNORE';
3426 local $SIG{INT} = 'IGNORE';
3427 local $SIG{QUIT} = 'IGNORE';
3428 local $SIG{TERM} = 'IGNORE';
3429 local $SIG{TSTP} = 'IGNORE';
3430 local $SIG{PIPE} = 'IGNORE';
3432 my $oldAutoCommit = $FS::UID::AutoCommit;
3433 local $FS::UID::AutoCommit = 0;
3436 $self->select_for_update; #mutex
3439 my $balance = $self->balance;
3440 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
3443 # if ( exists($options{'retry_card'}) ) {
3444 # carp 'retry_card option passed to collect is deprecated; use retry';
3445 # $options{'retry'} ||= $options{'retry_card'};
3447 # if ( exists($options{'retry'}) && $options{'retry'} ) {
3448 # my $error = $self->retry_realtime;
3450 # $dbh->rollback if $oldAutoCommit;
3455 # false laziness w/pay_batch::import_results
3457 my $due_cust_event = $self->due_cust_event(
3458 'debug' => ( $options{'debug'} || 0 ),
3460 'check_freq' => $options{'check_freq'},
3461 'stage' => ( $options{'stage'} || 'collect' ),
3463 unless( ref($due_cust_event) ) {
3464 $dbh->rollback if $oldAutoCommit;
3465 return $due_cust_event;
3468 foreach my $cust_event ( @$due_cust_event ) {
3472 #re-eval event conditions (a previous event could have changed things)
3473 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
3474 #don't leave stray "new/locked" records around
3475 my $error = $cust_event->delete;
3477 #gah, even with transactions
3478 $dbh->commit if $oldAutoCommit; #well.
3485 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
3486 warn " running cust_event ". $cust_event->eventnum. "\n"
3490 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
3491 if ( my $error = $cust_event->do_event() ) {
3492 #XXX wtf is this? figure out a proper dealio with return value
3494 # gah, even with transactions.
3495 $dbh->commit if $oldAutoCommit; #well.
3502 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3507 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
3509 Inserts database records for and returns an ordered listref of new events due
3510 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
3511 events are due, an empty listref is returned. If there is an error, returns a
3512 scalar error message.
3514 To actually run the events, call each event's test_condition method, and if
3515 still true, call the event's do_event method.
3517 Options are passed as a hashref or as a list of name-value pairs. Available
3524 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.
3528 "collect" (the default) or "pre-bill"
3532 "Current time" for the events.
3536 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)
3540 Only return events for the specified eventtable (by default, events of all eventtables are returned)
3544 Explicitly pass the objects to be tested (typically used with eventtable).
3548 Set to true to return the objects, but not actually insert them into the
3555 sub due_cust_event {
3557 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
3560 #my $DEBUG = $opt{'debug'}
3561 local($DEBUG) = $opt{'debug'}
3562 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
3564 warn "$me due_cust_event called with options ".
3565 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
3568 $opt{'time'} ||= time;
3570 local $SIG{HUP} = 'IGNORE';
3571 local $SIG{INT} = 'IGNORE';
3572 local $SIG{QUIT} = 'IGNORE';
3573 local $SIG{TERM} = 'IGNORE';
3574 local $SIG{TSTP} = 'IGNORE';
3575 local $SIG{PIPE} = 'IGNORE';
3577 my $oldAutoCommit = $FS::UID::AutoCommit;
3578 local $FS::UID::AutoCommit = 0;
3581 $self->select_for_update #mutex
3582 unless $opt{testonly};
3585 # find possible events (initial search)
3588 my @cust_event = ();
3590 my @eventtable = $opt{'eventtable'}
3591 ? ( $opt{'eventtable'} )
3592 : FS::part_event->eventtables_runorder;
3594 foreach my $eventtable ( @eventtable ) {
3597 if ( $opt{'objects'} ) {
3599 @objects = @{ $opt{'objects'} };
3603 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
3604 @objects = ( $eventtable eq 'cust_main' )
3606 : ( $self->$eventtable() );
3610 my @e_cust_event = ();
3612 my $cross = "CROSS JOIN $eventtable";
3613 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
3614 unless $eventtable eq 'cust_main';
3616 foreach my $object ( @objects ) {
3618 #this first search uses the condition_sql magic for optimization.
3619 #the more possible events we can eliminate in this step the better
3621 my $cross_where = '';
3622 my $pkey = $object->primary_key;
3623 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
3625 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
3627 FS::part_event_condition->where_conditions_sql( $eventtable,
3628 'time'=>$opt{'time'}
3630 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
3632 $extra_sql = "AND $extra_sql" if $extra_sql;
3634 #here is the agent virtualization
3635 $extra_sql .= " AND ( part_event.agentnum IS NULL
3636 OR part_event.agentnum = ". $self->agentnum. ' )';
3638 $extra_sql .= " $order";
3640 warn "searching for events for $eventtable ". $object->$pkey. "\n"
3641 if $opt{'debug'} > 2;
3642 my @part_event = qsearch( {
3643 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
3644 'select' => 'part_event.*',
3645 'table' => 'part_event',
3646 'addl_from' => "$cross $join",
3647 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
3648 'eventtable' => $eventtable,
3651 'extra_sql' => "AND $cross_where $extra_sql",
3655 my $pkey = $object->primary_key;
3656 warn " ". scalar(@part_event).
3657 " possible events found for $eventtable ". $object->$pkey(). "\n";
3660 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
3664 warn " ". scalar(@e_cust_event).
3665 " subtotal possible cust events found for $eventtable\n"
3668 push @cust_event, @e_cust_event;
3672 warn " ". scalar(@cust_event).
3673 " total possible cust events found in initial search\n"
3681 $opt{stage} ||= 'collect';
3683 grep { my $stage = $_->part_event->event_stage;
3684 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
3694 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
3695 'stats_hashref' => \%unsat ),
3698 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
3701 warn " invalid conditions not eliminated with condition_sql:\n".
3702 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
3709 unless( $opt{testonly} ) {
3710 foreach my $cust_event ( @cust_event ) {
3712 my $error = $cust_event->insert();
3714 $dbh->rollback if $oldAutoCommit;
3721 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3727 warn " returning events: ". Dumper(@cust_event). "\n"
3734 =item retry_realtime
3736 Schedules realtime / batch credit card / electronic check / LEC billing
3737 events for for retry. Useful if card information has changed or manual
3738 retry is desired. The 'collect' method must be called to actually retry
3741 Implementation details: For either this customer, or for each of this
3742 customer's open invoices, changes the status of the first "done" (with
3743 statustext error) realtime processing event to "failed".
3747 sub retry_realtime {
3750 local $SIG{HUP} = 'IGNORE';
3751 local $SIG{INT} = 'IGNORE';
3752 local $SIG{QUIT} = 'IGNORE';
3753 local $SIG{TERM} = 'IGNORE';
3754 local $SIG{TSTP} = 'IGNORE';
3755 local $SIG{PIPE} = 'IGNORE';
3757 my $oldAutoCommit = $FS::UID::AutoCommit;
3758 local $FS::UID::AutoCommit = 0;
3761 #a little false laziness w/due_cust_event (not too bad, really)
3763 my $join = FS::part_event_condition->join_conditions_sql;
3764 my $order = FS::part_event_condition->order_conditions_sql;
3767 . join ( ' OR ' , map {
3768 "( part_event.eventtable = " . dbh->quote($_)
3769 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
3770 } FS::part_event->eventtables)
3773 #here is the agent virtualization
3774 my $agent_virt = " ( part_event.agentnum IS NULL
3775 OR part_event.agentnum = ". $self->agentnum. ' )';
3777 #XXX this shouldn't be hardcoded, actions should declare it...
3778 my @realtime_events = qw(
3779 cust_bill_realtime_card
3780 cust_bill_realtime_check
3781 cust_bill_realtime_lec
3785 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
3790 my @cust_event = qsearchs({
3791 'table' => 'cust_event',
3792 'select' => 'cust_event.*',
3793 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
3794 'hashref' => { 'status' => 'done' },
3795 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
3796 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
3799 my %seen_invnum = ();
3800 foreach my $cust_event (@cust_event) {
3802 #max one for the customer, one for each open invoice
3803 my $cust_X = $cust_event->cust_X;
3804 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
3808 or $cust_event->part_event->eventtable eq 'cust_bill'
3811 my $error = $cust_event->retry;
3813 $dbh->rollback if $oldAutoCommit;
3814 return "error scheduling event for retry: $error";
3819 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3824 # some horrid false laziness here to avoid refactor fallout
3825 # eventually realtime realtime_bop and realtime_refund_bop should go
3826 # away and be replaced by _new_realtime_bop and _new_realtime_refund_bop
3828 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
3830 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
3831 via a Business::OnlinePayment realtime gateway. See
3832 L<http://420.am/business-onlinepayment> for supported gateways.
3834 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3836 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
3838 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3839 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3840 if set, will override the value from the customer record.
3842 I<description> is a free-text field passed to the gateway. It defaults to
3843 "Internet services".
3845 If an I<invnum> is specified, this payment (if successful) is applied to the
3846 specified invoice. If you don't specify an I<invnum> you might want to
3847 call the B<apply_payments> method.
3849 I<quiet> can be set true to surpress email decline notices.
3851 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
3852 resulting paynum, if any.
3854 I<payunique> is a unique identifier for this payment.
3856 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
3863 return $self->_new_realtime_bop(@_)
3864 if $self->_new_bop_required();
3866 my( $method, $amount, %options ) = @_;
3868 warn "$me realtime_bop: $method $amount\n";
3869 warn " $_ => $options{$_}\n" foreach keys %options;
3872 $options{'description'} ||= 'Internet services';
3874 return $self->fake_bop($method, $amount, %options) if $options{'fake'};
3876 eval "use Business::OnlinePayment";
3879 my $payinfo = exists($options{'payinfo'})
3880 ? $options{'payinfo'}
3883 my %method2payby = (
3890 # check for banned credit card/ACH
3893 my $ban = qsearchs('banned_pay', {
3894 'payby' => $method2payby{$method},
3895 'payinfo' => md5_base64($payinfo),
3897 return "Banned credit card" if $ban;
3900 # set taxclass and trans_is_recur based on invnum if there is one
3904 my $trans_is_recur = 0;
3905 if ( $options{'invnum'} ) {
3907 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
3908 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
3911 map { $_->part_pkg }
3913 map { $_->cust_pkg }
3914 $cust_bill->cust_bill_pkg;
3916 my @taxclasses = map $_->taxclass, @part_pkg;
3917 $taxclass = $taxclasses[0]
3918 unless grep { $taxclasses[0] ne $_ } @taxclasses; #unless there are
3919 #different taxclasses
3921 if grep { $_->freq ne '0' } @part_pkg;
3929 #look for an agent gateway override first
3931 if ( $method eq 'CC' ) {
3932 $cardtype = cardtype($payinfo);
3933 } elsif ( $method eq 'ECHECK' ) {
3936 $cardtype = $method;
3940 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3941 cardtype => $cardtype,
3942 taxclass => $taxclass, } )
3943 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3945 taxclass => $taxclass, } )
3946 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3947 cardtype => $cardtype,
3949 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3951 taxclass => '', } );
3953 my $payment_gateway = '';
3954 my( $processor, $login, $password, $action, @bop_options );
3955 if ( $override ) { #use a payment gateway override
3957 $payment_gateway = $override->payment_gateway;
3959 $processor = $payment_gateway->gateway_module;
3960 $login = $payment_gateway->gateway_username;
3961 $password = $payment_gateway->gateway_password;
3962 $action = $payment_gateway->gateway_action;
3963 @bop_options = $payment_gateway->options;
3965 } else { #use the standard settings from the config
3967 ( $processor, $login, $password, $action, @bop_options ) =
3968 $self->default_payment_gateway($method);
3976 my $address = exists($options{'address1'})
3977 ? $options{'address1'}
3979 my $address2 = exists($options{'address2'})
3980 ? $options{'address2'}
3982 $address .= ", ". $address2 if length($address2);
3984 my $o_payname = exists($options{'payname'})
3985 ? $options{'payname'}
3987 my($payname, $payfirst, $paylast);
3988 if ( $o_payname && $method ne 'ECHECK' ) {
3989 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3990 or return "Illegal payname $payname";
3991 ($payfirst, $paylast) = ($1, $2);
3993 $payfirst = $self->getfield('first');
3994 $paylast = $self->getfield('last');
3995 $payname = "$payfirst $paylast";
3998 my @invoicing_list = $self->invoicing_list_emailonly;
3999 if ( $conf->exists('emailinvoiceautoalways')
4000 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4001 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4002 push @invoicing_list, $self->all_emails;
4005 my $email = ($conf->exists('business-onlinepayment-email-override'))
4006 ? $conf->config('business-onlinepayment-email-override')
4007 : $invoicing_list[0];
4011 my $payip = exists($options{'payip'})
4014 $content{customer_ip} = $payip
4017 $content{invoice_number} = $options{'invnum'}
4018 if exists($options{'invnum'}) && length($options{'invnum'});
4020 $content{email_customer} =
4021 ( $conf->exists('business-onlinepayment-email_customer')
4022 || $conf->exists('business-onlinepayment-email-override') );
4025 if ( $method eq 'CC' ) {
4027 $content{card_number} = $payinfo;
4028 $paydate = exists($options{'paydate'})
4029 ? $options{'paydate'}
4031 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4032 $content{expiration} = "$2/$1";
4034 my $paycvv = exists($options{'paycvv'})
4035 ? $options{'paycvv'}
4037 $content{cvv2} = $paycvv
4040 my $paystart_month = exists($options{'paystart_month'})
4041 ? $options{'paystart_month'}
4042 : $self->paystart_month;
4044 my $paystart_year = exists($options{'paystart_year'})
4045 ? $options{'paystart_year'}
4046 : $self->paystart_year;
4048 $content{card_start} = "$paystart_month/$paystart_year"
4049 if $paystart_month && $paystart_year;
4051 my $payissue = exists($options{'payissue'})
4052 ? $options{'payissue'}
4054 $content{issue_number} = $payissue if $payissue;
4056 if ( $self->_bop_recurring_billing( 'payinfo' => $payinfo,
4057 'trans_is_recur' => $trans_is_recur,
4061 $content{recurring_billing} = 'YES';
4062 $content{acct_code} = 'rebill'
4063 if $conf->exists('credit_card-recurring_billing_acct_code');
4066 } elsif ( $method eq 'ECHECK' ) {
4067 ( $content{account_number}, $content{routing_code} ) =
4068 split('@', $payinfo);
4069 $content{bank_name} = $o_payname;
4070 $content{bank_state} = exists($options{'paystate'})
4071 ? $options{'paystate'}
4072 : $self->getfield('paystate');
4073 $content{account_type} = exists($options{'paytype'})
4074 ? uc($options{'paytype'}) || 'CHECKING'
4075 : uc($self->getfield('paytype')) || 'CHECKING';
4076 $content{account_name} = $payname;
4077 $content{customer_org} = $self->company ? 'B' : 'I';
4078 $content{state_id} = exists($options{'stateid'})
4079 ? $options{'stateid'}
4080 : $self->getfield('stateid');
4081 $content{state_id_state} = exists($options{'stateid_state'})
4082 ? $options{'stateid_state'}
4083 : $self->getfield('stateid_state');
4084 $content{customer_ssn} = exists($options{'ss'})
4087 } elsif ( $method eq 'LEC' ) {
4088 $content{phone} = $payinfo;
4092 # run transaction(s)
4095 my $balance = exists( $options{'balance'} )
4096 ? $options{'balance'}
4099 $self->select_for_update; #mutex ... just until we get our pending record in
4101 #the checks here are intended to catch concurrent payments
4102 #double-form-submission prevention is taken care of in cust_pay_pending::check
4105 return "The customer's balance has changed; $method transaction aborted."
4106 if $self->balance < $balance;
4107 #&& $self->balance < $amount; #might as well anyway?
4109 #also check and make sure there aren't *other* pending payments for this cust
4111 my @pending = qsearch('cust_pay_pending', {
4112 'custnum' => $self->custnum,
4113 'status' => { op=>'!=', value=>'done' }
4115 return "A payment is already being processed for this customer (".
4116 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
4117 "); $method transaction aborted."
4118 if scalar(@pending);
4120 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
4122 my $cust_pay_pending = new FS::cust_pay_pending {
4123 'custnum' => $self->custnum,
4124 #'invnum' => $options{'invnum'},
4127 'payby' => $method2payby{$method},
4128 'payinfo' => $payinfo,
4129 'paydate' => $paydate,
4130 'recurring_billing' => $content{recurring_billing},
4131 'pkgnum' => $options{'pkgnum'},
4133 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
4135 $cust_pay_pending->payunique( $options{payunique} )
4136 if defined($options{payunique}) && length($options{payunique});
4137 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
4138 return $cpp_new_err if $cpp_new_err;
4140 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
4142 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
4143 $transaction->content(
4146 'password' => $password,
4147 'action' => $action1,
4148 'description' => $options{'description'},
4149 'amount' => $amount,
4150 #'invoice_number' => $options{'invnum'},
4151 'customer_id' => $self->custnum,
4152 'last_name' => $paylast,
4153 'first_name' => $payfirst,
4155 'address' => $address,
4156 'city' => ( exists($options{'city'})
4159 'state' => ( exists($options{'state'})
4162 'zip' => ( exists($options{'zip'})
4165 'country' => ( exists($options{'country'})
4166 ? $options{'country'}
4168 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4170 'phone' => $self->daytime || $self->night,
4174 $cust_pay_pending->status('pending');
4175 my $cpp_pending_err = $cust_pay_pending->replace;
4176 return $cpp_pending_err if $cpp_pending_err;
4179 my $BOP_TESTING = 0;
4180 my $BOP_TESTING_SUCCESS = 1;
4182 unless ( $BOP_TESTING ) {
4183 $transaction->submit();
4185 if ( $BOP_TESTING_SUCCESS ) {
4186 $transaction->is_success(1);
4187 $transaction->authorization('fake auth');
4189 $transaction->is_success(0);
4190 $transaction->error_message('fake failure');
4194 if ( $transaction->is_success() && $action2 ) {
4196 $cust_pay_pending->status('authorized');
4197 my $cpp_authorized_err = $cust_pay_pending->replace;
4198 return $cpp_authorized_err if $cpp_authorized_err;
4200 my $auth = $transaction->authorization;
4201 my $ordernum = $transaction->can('order_number')
4202 ? $transaction->order_number
4206 new Business::OnlinePayment( $processor, @bop_options );
4213 password => $password,
4214 order_number => $ordernum,
4216 authorization => $auth,
4217 description => $options{'description'},
4220 foreach my $field (qw( authorization_source_code returned_ACI
4221 transaction_identifier validation_code
4222 transaction_sequence_num local_transaction_date
4223 local_transaction_time AVS_result_code )) {
4224 $capture{$field} = $transaction->$field() if $transaction->can($field);
4227 $capture->content( %capture );
4231 unless ( $capture->is_success ) {
4232 my $e = "Authorization successful but capture failed, custnum #".
4233 $self->custnum. ': '. $capture->result_code.
4234 ": ". $capture->error_message;
4241 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
4242 my $cpp_captured_err = $cust_pay_pending->replace;
4243 return $cpp_captured_err if $cpp_captured_err;
4246 # remove paycvv after initial transaction
4249 #false laziness w/misc/process/payment.cgi - check both to make sure working
4251 if ( defined $self->dbdef_table->column('paycvv')
4252 && length($self->paycvv)
4253 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
4255 my $error = $self->remove_cvv;
4257 warn "WARNING: error removing cvv: $error\n";
4265 if ( $transaction->is_success() ) {
4268 if ( $payment_gateway ) { # agent override
4269 $paybatch = $payment_gateway->gatewaynum. '-';
4272 $paybatch .= "$processor:". $transaction->authorization;
4274 $paybatch .= ':'. $transaction->order_number
4275 if $transaction->can('order_number')
4276 && length($transaction->order_number);
4278 my $cust_pay = new FS::cust_pay ( {
4279 'custnum' => $self->custnum,
4280 'invnum' => $options{'invnum'},
4283 'payby' => $method2payby{$method},
4284 'payinfo' => $payinfo,
4285 'paybatch' => $paybatch,
4286 'paydate' => $paydate,
4287 'pkgnum' => $options{'pkgnum'},
4289 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
4290 $cust_pay->payunique( $options{payunique} )
4291 if defined($options{payunique}) && length($options{payunique});
4293 my $oldAutoCommit = $FS::UID::AutoCommit;
4294 local $FS::UID::AutoCommit = 0;
4297 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
4299 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
4302 $cust_pay->invnum(''); #try again with no specific invnum
4303 my $error2 = $cust_pay->insert( $options{'manual'} ?
4304 ( 'manual' => 1 ) : ()
4307 # gah. but at least we have a record of the state we had to abort in
4308 # from cust_pay_pending now.
4309 my $e = "WARNING: $method captured but payment not recorded - ".
4310 "error inserting payment ($processor): $error2".
4311 " (previously tried insert with invnum #$options{'invnum'}" .
4312 ": $error ) - pending payment saved as paypendingnum ".
4313 $cust_pay_pending->paypendingnum. "\n";
4319 if ( $options{'paynum_ref'} ) {
4320 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
4323 $cust_pay_pending->status('done');
4324 $cust_pay_pending->statustext('captured');
4325 $cust_pay_pending->paynum($cust_pay->paynum);
4326 my $cpp_done_err = $cust_pay_pending->replace;
4328 if ( $cpp_done_err ) {
4330 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4331 my $e = "WARNING: $method captured but payment not recorded - ".
4332 "error updating status for paypendingnum ".
4333 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4339 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4340 return ''; #no error
4346 my $perror = "$processor error: ". $transaction->error_message;
4348 unless ( $transaction->error_message ) {
4351 if ( $transaction->can('response_page') ) {
4353 'page' => ( $transaction->can('response_page')
4354 ? $transaction->response_page
4357 'code' => ( $transaction->can('response_code')
4358 ? $transaction->response_code
4361 'headers' => ( $transaction->can('response_headers')
4362 ? $transaction->response_headers
4368 "No additional debugging information available for $processor";
4371 $perror .= "No error_message returned from $processor -- ".
4372 ( ref($t_response) ? Dumper($t_response) : $t_response );
4376 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
4377 && $conf->exists('emaildecline')
4378 && grep { $_ ne 'POST' } $self->invoicing_list
4379 && ! grep { $transaction->error_message =~ /$_/ }
4380 $conf->config('emaildecline-exclude')
4382 my @templ = $conf->config('declinetemplate');
4383 my $template = new Text::Template (
4385 SOURCE => [ map "$_\n", @templ ],
4386 ) or return "($perror) can't create template: $Text::Template::ERROR";
4387 $template->compile()
4388 or return "($perror) can't compile template: $Text::Template::ERROR";
4392 scalar( $conf->config('company_name', $self->agentnum ) ),
4393 'company_address' =>
4394 join("\n", $conf->config('company_address', $self->agentnum ) ),
4395 'error' => $transaction->error_message,
4398 my $error = send_email(
4399 'from' => $conf->config('invoice_from', $self->agentnum ),
4400 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
4401 'subject' => 'Your payment could not be processed',
4402 'body' => [ $template->fill_in(HASH => $templ_hash) ],
4405 $perror .= " (also received error sending decline notification: $error)"
4410 $cust_pay_pending->status('done');
4411 $cust_pay_pending->statustext("declined: $perror");
4412 my $cpp_done_err = $cust_pay_pending->replace;
4413 if ( $cpp_done_err ) {
4414 my $e = "WARNING: $method declined but pending payment not resolved - ".
4415 "error updating status for paypendingnum ".
4416 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4418 $perror = "$e ($perror)";
4426 sub _bop_recurring_billing {
4427 my( $self, %opt ) = @_;
4429 my $method = $conf->config('credit_card-recurring_billing_flag');
4431 if ( $method eq 'transaction_is_recur' ) {
4433 return 1 if $opt{'trans_is_recur'};
4437 my %hash = ( 'custnum' => $self->custnum,
4442 if qsearch('cust_pay', { %hash, 'payinfo' => $opt{'payinfo'} } )
4443 || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo('CARD',
4454 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
4456 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
4457 via a Business::OnlinePayment realtime gateway. See
4458 L<http://420.am/business-onlinepayment> for supported gateways.
4460 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4462 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
4464 Most gateways require a reference to an original payment transaction to refund,
4465 so you probably need to specify a I<paynum>.
4467 I<amount> defaults to the original amount of the payment if not specified.
4469 I<reason> specifies a reason for the refund.
4471 I<paydate> specifies the expiration date for a credit card overriding the
4472 value from the customer record or the payment record. Specified as yyyy-mm-dd
4474 Implementation note: If I<amount> is unspecified or equal to the amount of the
4475 orignal payment, first an attempt is made to "void" the transaction via
4476 the gateway (to cancel a not-yet settled transaction) and then if that fails,
4477 the normal attempt is made to "refund" ("credit") the transaction via the
4478 gateway is attempted.
4480 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4481 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4482 #if set, will override the value from the customer record.
4484 #If an I<invnum> is specified, this payment (if successful) is applied to the
4485 #specified invoice. If you don't specify an I<invnum> you might want to
4486 #call the B<apply_payments> method.
4490 #some false laziness w/realtime_bop, not enough to make it worth merging
4491 #but some useful small subs should be pulled out
4492 sub realtime_refund_bop {
4495 return $self->_new_realtime_refund_bop(@_)
4496 if $self->_new_bop_required();
4498 my( $method, %options ) = @_;
4500 warn "$me realtime_refund_bop: $method refund\n";
4501 warn " $_ => $options{$_}\n" foreach keys %options;
4504 eval "use Business::OnlinePayment";
4508 # look up the original payment and optionally a gateway for that payment
4512 my $amount = $options{'amount'};
4514 my( $processor, $login, $password, @bop_options ) ;
4515 my( $auth, $order_number ) = ( '', '', '' );
4517 if ( $options{'paynum'} ) {
4519 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
4520 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
4521 or return "Unknown paynum $options{'paynum'}";
4522 $amount ||= $cust_pay->paid;
4524 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
4525 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
4526 $cust_pay->paybatch;
4527 my $gatewaynum = '';
4528 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
4530 if ( $gatewaynum ) { #gateway for the payment to be refunded
4532 my $payment_gateway =
4533 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
4534 die "payment gateway $gatewaynum not found"
4535 unless $payment_gateway;
4537 $processor = $payment_gateway->gateway_module;
4538 $login = $payment_gateway->gateway_username;
4539 $password = $payment_gateway->gateway_password;
4540 @bop_options = $payment_gateway->options;
4542 } else { #try the default gateway
4544 my( $conf_processor, $unused_action );
4545 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
4546 $self->default_payment_gateway($method);
4548 return "processor of payment $options{'paynum'} $processor does not".
4549 " match default processor $conf_processor"
4550 unless $processor eq $conf_processor;
4555 } else { # didn't specify a paynum, so look for agent gateway overrides
4556 # like a normal transaction
4559 if ( $method eq 'CC' ) {
4560 $cardtype = cardtype($self->payinfo);
4561 } elsif ( $method eq 'ECHECK' ) {
4564 $cardtype = $method;
4567 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4568 cardtype => $cardtype,
4570 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4572 taxclass => '', } );
4574 if ( $override ) { #use a payment gateway override
4576 my $payment_gateway = $override->payment_gateway;
4578 $processor = $payment_gateway->gateway_module;
4579 $login = $payment_gateway->gateway_username;
4580 $password = $payment_gateway->gateway_password;
4581 #$action = $payment_gateway->gateway_action;
4582 @bop_options = $payment_gateway->options;
4584 } else { #use the standard settings from the config
4587 ( $processor, $login, $password, $unused_action, @bop_options ) =
4588 $self->default_payment_gateway($method);
4593 return "neither amount nor paynum specified" unless $amount;
4598 'password' => $password,
4599 'order_number' => $order_number,
4600 'amount' => $amount,
4601 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4603 $content{authorization} = $auth
4604 if length($auth); #echeck/ACH transactions have an order # but no auth
4605 #(at least with authorize.net)
4607 my $disable_void_after;
4608 if ($conf->exists('disable_void_after')
4609 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
4610 $disable_void_after = $1;
4613 #first try void if applicable
4614 if ( $cust_pay && $cust_pay->paid == $amount
4616 ( not defined($disable_void_after) )
4617 || ( time < ($cust_pay->_date + $disable_void_after ) )
4620 warn " attempting void\n" if $DEBUG > 1;
4621 my $void = new Business::OnlinePayment( $processor, @bop_options );
4622 $void->content( 'action' => 'void', %content );
4624 if ( $void->is_success ) {
4625 my $error = $cust_pay->void($options{'reason'});
4627 # gah, even with transactions.
4628 my $e = 'WARNING: Card/ACH voided but database not updated - '.
4629 "error voiding payment: $error";
4633 warn " void successful\n" if $DEBUG > 1;
4638 warn " void unsuccessful, trying refund\n"
4642 my $address = $self->address1;
4643 $address .= ", ". $self->address2 if $self->address2;
4645 my($payname, $payfirst, $paylast);
4646 if ( $self->payname && $method ne 'ECHECK' ) {
4647 $payname = $self->payname;
4648 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4649 or return "Illegal payname $payname";
4650 ($payfirst, $paylast) = ($1, $2);
4652 $payfirst = $self->getfield('first');
4653 $paylast = $self->getfield('last');
4654 $payname = "$payfirst $paylast";
4657 my @invoicing_list = $self->invoicing_list_emailonly;
4658 if ( $conf->exists('emailinvoiceautoalways')
4659 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4660 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4661 push @invoicing_list, $self->all_emails;
4664 my $email = ($conf->exists('business-onlinepayment-email-override'))
4665 ? $conf->config('business-onlinepayment-email-override')
4666 : $invoicing_list[0];
4668 my $payip = exists($options{'payip'})
4671 $content{customer_ip} = $payip
4675 if ( $method eq 'CC' ) {
4678 $content{card_number} = $payinfo = $cust_pay->payinfo;
4679 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
4680 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
4681 ($content{expiration} = "$2/$1"); # where available
4683 $content{card_number} = $payinfo = $self->payinfo;
4684 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
4685 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4686 $content{expiration} = "$2/$1";
4689 } elsif ( $method eq 'ECHECK' ) {
4692 $payinfo = $cust_pay->payinfo;
4694 $payinfo = $self->payinfo;
4696 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
4697 $content{bank_name} = $self->payname;
4698 $content{account_type} = 'CHECKING';
4699 $content{account_name} = $payname;
4700 $content{customer_org} = $self->company ? 'B' : 'I';
4701 $content{customer_ssn} = $self->ss;
4702 } elsif ( $method eq 'LEC' ) {
4703 $content{phone} = $payinfo = $self->payinfo;
4707 my $refund = new Business::OnlinePayment( $processor, @bop_options );
4708 my %sub_content = $refund->content(
4709 'action' => 'credit',
4710 'customer_id' => $self->custnum,
4711 'last_name' => $paylast,
4712 'first_name' => $payfirst,
4714 'address' => $address,
4715 'city' => $self->city,
4716 'state' => $self->state,
4717 'zip' => $self->zip,
4718 'country' => $self->country,
4720 'phone' => $self->daytime || $self->night,
4723 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
4727 return "$processor error: ". $refund->error_message
4728 unless $refund->is_success();
4730 my %method2payby = (
4736 my $paybatch = "$processor:". $refund->authorization;
4737 $paybatch .= ':'. $refund->order_number
4738 if $refund->can('order_number') && $refund->order_number;
4740 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
4741 my @cust_bill_pay = $cust_pay->cust_bill_pay;
4742 last unless @cust_bill_pay;
4743 my $cust_bill_pay = pop @cust_bill_pay;
4744 my $error = $cust_bill_pay->delete;
4748 my $cust_refund = new FS::cust_refund ( {
4749 'custnum' => $self->custnum,
4750 'paynum' => $options{'paynum'},
4751 'refund' => $amount,
4753 'payby' => $method2payby{$method},
4754 'payinfo' => $payinfo,
4755 'paybatch' => $paybatch,
4756 'reason' => $options{'reason'} || 'card or ACH refund',
4758 my $error = $cust_refund->insert;
4760 $cust_refund->paynum(''); #try again with no specific paynum
4761 my $error2 = $cust_refund->insert;
4763 # gah, even with transactions.
4764 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
4765 "error inserting refund ($processor): $error2".
4766 " (previously tried insert with paynum #$options{'paynum'}" .
4777 # does the configuration indicate the new bop routines are required?
4779 sub _new_bop_required {
4782 my $botpp = 'Business::OnlineThirdPartyPayment';
4785 if ( $conf->config('business-onlinepayment-namespace') eq $botpp ||
4786 scalar( grep { $_->gateway_namespace eq $botpp }
4787 qsearch( 'payment_gateway', { 'disabled' => '' } )
4796 =item realtime_collect [ OPTION => VALUE ... ]
4798 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4799 via a Business::OnlinePayment or Business::OnlineThirdPartyPayment realtime
4800 gateway. See L<http://420.am/business-onlinepayment> and
4801 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
4803 On failure returns an error message.
4805 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.
4807 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>, I<pkgnum>
4809 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>. If none is specified
4810 then it is deduced from the customer record.
4812 If no I<amount> is specified, then the customer balance is used.
4814 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4815 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4816 if set, will override the value from the customer record.
4818 I<description> is a free-text field passed to the gateway. It defaults to
4819 "Internet services".
4821 If an I<invnum> is specified, this payment (if successful) is applied to the
4822 specified invoice. If you don't specify an I<invnum> you might want to
4823 call the B<apply_payments> method.
4825 I<quiet> can be set true to surpress email decline notices.
4827 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4828 resulting paynum, if any.
4830 I<payunique> is a unique identifier for this payment.
4832 I<session_id> is a session identifier associated with this payment.
4834 I<depend_jobnum> allows payment capture to unlock export jobs
4838 sub realtime_collect {
4839 my( $self, %options ) = @_;
4842 warn "$me realtime_collect:\n";
4843 warn " $_ => $options{$_}\n" foreach keys %options;
4846 $options{amount} = $self->balance unless exists( $options{amount} );
4847 $options{method} = FS::payby->payby2bop($self->payby)
4848 unless exists( $options{method} );
4850 return $self->realtime_bop({%options});
4854 =item _realtime_bop { [ ARG => VALUE ... ] }
4856 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4857 via a Business::OnlinePayment realtime gateway. See
4858 L<http://420.am/business-onlinepayment> for supported gateways.
4860 Required arguments in the hashref are I<method>, and I<amount>
4862 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4864 Available optional arguments are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
4866 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4867 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4868 if set, will override the value from the customer record.
4870 I<description> is a free-text field passed to the gateway. It defaults to
4871 "Internet services".
4873 If an I<invnum> is specified, this payment (if successful) is applied to the
4874 specified invoice. If you don't specify an I<invnum> you might want to
4875 call the B<apply_payments> method.
4877 I<quiet> can be set true to surpress email decline notices.
4879 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4880 resulting paynum, if any.
4882 I<payunique> is a unique identifier for this payment.
4884 I<session_id> is a session identifier associated with this payment.
4886 I<depend_jobnum> allows payment capture to unlock export jobs
4888 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
4892 # some helper routines
4893 sub _payment_gateway {
4894 my ($self, $options) = @_;
4896 $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
4897 unless exists($options->{payment_gateway});
4899 $options->{payment_gateway};
4903 my ($self, $options) = @_;
4906 'login' => $options->{payment_gateway}->gateway_username,
4907 'password' => $options->{payment_gateway}->gateway_password,
4912 my ($self, $options) = @_;
4914 $options->{payment_gateway}->gatewaynum
4915 ? $options->{payment_gateway}->options
4916 : @{ $options->{payment_gateway}->get('options') };
4920 my ($self, $options) = @_;
4922 $options->{description} ||= 'Internet services';
4923 $options->{payinfo} = $self->payinfo unless exists( $options->{payinfo} );
4924 $options->{invnum} ||= '';
4925 $options->{payname} = $self->payname unless exists( $options->{payname} );
4929 my ($self, $options) = @_;
4932 $content{address} = exists($options->{'address1'})
4933 ? $options->{'address1'}
4935 my $address2 = exists($options->{'address2'})
4936 ? $options->{'address2'}
4938 $content{address} .= ", ". $address2 if length($address2);
4940 my $payip = exists($options->{'payip'}) ? $options->{'payip'} : $self->payip;
4941 $content{customer_ip} = $payip if length($payip);
4943 $content{invoice_number} = $options->{'invnum'}
4944 if exists($options->{'invnum'}) && length($options->{'invnum'});
4946 $content{email_customer} =
4947 ( $conf->exists('business-onlinepayment-email_customer')
4948 || $conf->exists('business-onlinepayment-email-override') );
4950 $content{payfirst} = $self->getfield('first');
4951 $content{paylast} = $self->getfield('last');
4953 $content{account_name} = "$content{payfirst} $content{paylast}"
4954 if $options->{method} eq 'ECHECK';
4956 $content{name} = $options->{payname};
4957 $content{name} = $content{account_name} if exists($content{account_name});
4959 $content{city} = exists($options->{city})
4962 $content{state} = exists($options->{state})
4965 $content{zip} = exists($options->{zip})
4968 $content{country} = exists($options->{country})
4969 ? $options->{country}
4971 $content{referer} = 'http://cleanwhisker.420.am/'; #XXX fix referer :/
4972 $content{phone} = $self->daytime || $self->night;
4977 my %bop_method2payby = (
4983 sub _new_realtime_bop {
4987 if (ref($_[0]) eq 'HASH') {
4988 %options = %{$_[0]};
4990 my ( $method, $amount ) = ( shift, shift );
4992 $options{method} = $method;
4993 $options{amount} = $amount;
4997 warn "$me realtime_bop (new): $options{method} $options{amount}\n";
4998 warn " $_ => $options{$_}\n" foreach keys %options;
5001 return $self->fake_bop(%options) if $options{'fake'};
5003 $self->_bop_defaults(\%options);
5006 # set trans_is_recur based on invnum if there is one
5009 my $trans_is_recur = 0;
5010 if ( $options{'invnum'} ) {
5012 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
5013 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
5016 map { $_->part_pkg }
5018 map { $_->cust_pkg }
5019 $cust_bill->cust_bill_pkg;
5022 if grep { $_->freq ne '0' } @part_pkg;
5030 my $payment_gateway = $self->_payment_gateway( \%options );
5031 my $namespace = $payment_gateway->gateway_namespace;
5033 eval "use $namespace";
5037 # check for banned credit card/ACH
5040 my $ban = qsearchs('banned_pay', {
5041 'payby' => $bop_method2payby{$options{method}},
5042 'payinfo' => md5_base64($options{payinfo}),
5044 return "Banned credit card" if $ban;
5050 my (%bop_content) = $self->_bop_content(\%options);
5052 if ( $options{method} ne 'ECHECK' ) {
5053 $options{payname} =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5054 or return "Illegal payname $options{payname}";
5055 ($bop_content{payfirst}, $bop_content{paylast}) = ($1, $2);
5058 my @invoicing_list = $self->invoicing_list_emailonly;
5059 if ( $conf->exists('emailinvoiceautoalways')
5060 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5061 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5062 push @invoicing_list, $self->all_emails;
5065 my $email = ($conf->exists('business-onlinepayment-email-override'))
5066 ? $conf->config('business-onlinepayment-email-override')
5067 : $invoicing_list[0];
5071 if ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'CC' ) {
5073 $content{card_number} = $options{payinfo};
5074 $paydate = exists($options{'paydate'})
5075 ? $options{'paydate'}
5077 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
5078 $content{expiration} = "$2/$1";
5080 my $paycvv = exists($options{'paycvv'})
5081 ? $options{'paycvv'}
5083 $content{cvv2} = $paycvv
5086 my $paystart_month = exists($options{'paystart_month'})
5087 ? $options{'paystart_month'}
5088 : $self->paystart_month;
5090 my $paystart_year = exists($options{'paystart_year'})
5091 ? $options{'paystart_year'}
5092 : $self->paystart_year;
5094 $content{card_start} = "$paystart_month/$paystart_year"
5095 if $paystart_month && $paystart_year;
5097 my $payissue = exists($options{'payissue'})
5098 ? $options{'payissue'}
5100 $content{issue_number} = $payissue if $payissue;
5102 if ( $self->_bop_recurring_billing( 'payinfo' => $options{'payinfo'},
5103 'trans_is_recur' => $trans_is_recur,
5107 $content{recurring_billing} = 'YES';
5108 $content{acct_code} = 'rebill'
5109 if $conf->exists('credit_card-recurring_billing_acct_code');
5112 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'ECHECK' ){
5113 ( $content{account_number}, $content{routing_code} ) =
5114 split('@', $options{payinfo});
5115 $content{bank_name} = $options{payname};
5116 $content{bank_state} = exists($options{'paystate'})
5117 ? $options{'paystate'}
5118 : $self->getfield('paystate');
5119 $content{account_type} = exists($options{'paytype'})
5120 ? uc($options{'paytype'}) || 'CHECKING'
5121 : uc($self->getfield('paytype')) || 'CHECKING';
5122 $content{customer_org} = $self->company ? 'B' : 'I';
5123 $content{state_id} = exists($options{'stateid'})
5124 ? $options{'stateid'}
5125 : $self->getfield('stateid');
5126 $content{state_id_state} = exists($options{'stateid_state'})
5127 ? $options{'stateid_state'}
5128 : $self->getfield('stateid_state');
5129 $content{customer_ssn} = exists($options{'ss'})
5132 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'LEC' ) {
5133 $content{phone} = $options{payinfo};
5134 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5141 # run transaction(s)
5144 my $balance = exists( $options{'balance'} )
5145 ? $options{'balance'}
5148 $self->select_for_update; #mutex ... just until we get our pending record in
5150 #the checks here are intended to catch concurrent payments
5151 #double-form-submission prevention is taken care of in cust_pay_pending::check
5154 return "The customer's balance has changed; $options{method} transaction aborted."
5155 if $self->balance < $balance;
5156 #&& $self->balance < $options{amount}; #might as well anyway?
5158 #also check and make sure there aren't *other* pending payments for this cust
5160 my @pending = qsearch('cust_pay_pending', {
5161 'custnum' => $self->custnum,
5162 'status' => { op=>'!=', value=>'done' }
5164 return "A payment is already being processed for this customer (".
5165 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
5166 "); $options{method} transaction aborted."
5167 if scalar(@pending);
5169 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
5171 my $cust_pay_pending = new FS::cust_pay_pending {
5172 'custnum' => $self->custnum,
5173 #'invnum' => $options{'invnum'},
5174 'paid' => $options{amount},
5176 'payby' => $bop_method2payby{$options{method}},
5177 'payinfo' => $options{payinfo},
5178 'paydate' => $paydate,
5179 'recurring_billing' => $content{recurring_billing},
5180 'pkgnum' => $options{'pkgnum'},
5182 'gatewaynum' => $payment_gateway->gatewaynum || '',
5183 'session_id' => $options{session_id} || '',
5184 'jobnum' => $options{depend_jobnum} || '',
5186 $cust_pay_pending->payunique( $options{payunique} )
5187 if defined($options{payunique}) && length($options{payunique});
5188 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
5189 return $cpp_new_err if $cpp_new_err;
5191 my( $action1, $action2 ) =
5192 split( /\s*\,\s*/, $payment_gateway->gateway_action );
5194 my $transaction = new $namespace( $payment_gateway->gateway_module,
5195 $self->_bop_options(\%options),
5198 $transaction->content(
5199 'type' => $options{method},
5200 $self->_bop_auth(\%options),
5201 'action' => $action1,
5202 'description' => $options{'description'},
5203 'amount' => $options{amount},
5204 #'invoice_number' => $options{'invnum'},
5205 'customer_id' => $self->custnum,
5207 'reference' => $cust_pay_pending->paypendingnum, #for now
5212 $cust_pay_pending->status('pending');
5213 my $cpp_pending_err = $cust_pay_pending->replace;
5214 return $cpp_pending_err if $cpp_pending_err;
5217 my $BOP_TESTING = 0;
5218 my $BOP_TESTING_SUCCESS = 1;
5220 unless ( $BOP_TESTING ) {
5221 $transaction->submit();
5223 if ( $BOP_TESTING_SUCCESS ) {
5224 $transaction->is_success(1);
5225 $transaction->authorization('fake auth');
5227 $transaction->is_success(0);
5228 $transaction->error_message('fake failure');
5232 if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5234 return { reference => $cust_pay_pending->paypendingnum,
5235 map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
5237 } elsif ( $transaction->is_success() && $action2 ) {
5239 $cust_pay_pending->status('authorized');
5240 my $cpp_authorized_err = $cust_pay_pending->replace;
5241 return $cpp_authorized_err if $cpp_authorized_err;
5243 my $auth = $transaction->authorization;
5244 my $ordernum = $transaction->can('order_number')
5245 ? $transaction->order_number
5249 new Business::OnlinePayment( $payment_gateway->gateway_module,
5250 $self->_bop_options(\%options),
5255 type => $options{method},
5257 $self->_bop_auth(\%options),
5258 order_number => $ordernum,
5259 amount => $options{amount},
5260 authorization => $auth,
5261 description => $options{'description'},
5264 foreach my $field (qw( authorization_source_code returned_ACI
5265 transaction_identifier validation_code
5266 transaction_sequence_num local_transaction_date
5267 local_transaction_time AVS_result_code )) {
5268 $capture{$field} = $transaction->$field() if $transaction->can($field);
5271 $capture->content( %capture );
5275 unless ( $capture->is_success ) {
5276 my $e = "Authorization successful but capture failed, custnum #".
5277 $self->custnum. ': '. $capture->result_code.
5278 ": ". $capture->error_message;
5286 # remove paycvv after initial transaction
5289 #false laziness w/misc/process/payment.cgi - check both to make sure working
5291 if ( defined $self->dbdef_table->column('paycvv')
5292 && length($self->paycvv)
5293 && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
5295 my $error = $self->remove_cvv;
5297 warn "WARNING: error removing cvv: $error\n";
5305 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5317 if (ref($_[0]) eq 'HASH') {
5318 %options = %{$_[0]};
5320 my ( $method, $amount ) = ( shift, shift );
5322 $options{method} = $method;
5323 $options{amount} = $amount;
5326 if ( $options{'fake_failure'} ) {
5327 return "Error: No error; test failure requested with fake_failure";
5331 #if ( $payment_gateway->gatewaynum ) { # agent override
5332 # $paybatch = $payment_gateway->gatewaynum. '-';
5335 #$paybatch .= "$processor:". $transaction->authorization;
5337 #$paybatch .= ':'. $transaction->order_number
5338 # if $transaction->can('order_number')
5339 # && length($transaction->order_number);
5341 my $paybatch = 'FakeProcessor:54:32';
5343 my $cust_pay = new FS::cust_pay ( {
5344 'custnum' => $self->custnum,
5345 'invnum' => $options{'invnum'},
5346 'paid' => $options{amount},
5348 'payby' => $bop_method2payby{$options{method}},
5349 #'payinfo' => $payinfo,
5350 'payinfo' => '4111111111111111',
5351 'paybatch' => $paybatch,
5352 #'paydate' => $paydate,
5353 'paydate' => '2012-05-01',
5355 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
5357 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5360 $cust_pay->invnum(''); #try again with no specific invnum
5361 my $error2 = $cust_pay->insert( $options{'manual'} ?
5362 ( 'manual' => 1 ) : ()
5365 # gah, even with transactions.
5366 my $e = 'WARNING: Card/ACH debited but database not updated - '.
5367 "error inserting (fake!) payment: $error2".
5368 " (previously tried insert with invnum #$options{'invnum'}" .
5375 if ( $options{'paynum_ref'} ) {
5376 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5379 return ''; #no error
5384 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
5386 # Wraps up processing of a realtime credit card, ACH (electronic check) or
5387 # phone bill transaction.
5389 sub _realtime_bop_result {
5390 my( $self, $cust_pay_pending, $transaction, %options ) = @_;
5392 warn "$me _realtime_bop_result: pending transaction ".
5393 $cust_pay_pending->paypendingnum. "\n";
5394 warn " $_ => $options{$_}\n" foreach keys %options;
5397 my $payment_gateway = $options{payment_gateway}
5398 or return "no payment gateway in arguments to _realtime_bop_result";
5400 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
5401 my $cpp_captured_err = $cust_pay_pending->replace;
5402 return $cpp_captured_err if $cpp_captured_err;
5404 if ( $transaction->is_success() ) {
5407 if ( $payment_gateway->gatewaynum ) { # agent override
5408 $paybatch = $payment_gateway->gatewaynum. '-';
5411 $paybatch .= $payment_gateway->gateway_module. ":".
5412 $transaction->authorization;
5414 $paybatch .= ':'. $transaction->order_number
5415 if $transaction->can('order_number')
5416 && length($transaction->order_number);
5418 my $cust_pay = new FS::cust_pay ( {
5419 'custnum' => $self->custnum,
5420 'invnum' => $options{'invnum'},
5421 'paid' => $cust_pay_pending->paid,
5423 'payby' => $cust_pay_pending->payby,
5424 #'payinfo' => $payinfo,
5425 'paybatch' => $paybatch,
5426 'paydate' => $cust_pay_pending->paydate,
5427 'pkgnum' => $cust_pay_pending->pkgnum,
5429 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
5430 $cust_pay->payunique( $options{payunique} )
5431 if defined($options{payunique}) && length($options{payunique});
5433 my $oldAutoCommit = $FS::UID::AutoCommit;
5434 local $FS::UID::AutoCommit = 0;
5437 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
5439 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5442 $cust_pay->invnum(''); #try again with no specific invnum
5443 my $error2 = $cust_pay->insert( $options{'manual'} ?
5444 ( 'manual' => 1 ) : ()
5447 # gah. but at least we have a record of the state we had to abort in
5448 # from cust_pay_pending now.
5449 my $e = "WARNING: $options{method} captured but payment not recorded -".
5450 " error inserting payment (". $payment_gateway->gateway_module.
5452 " (previously tried insert with invnum #$options{'invnum'}" .
5453 ": $error ) - pending payment saved as paypendingnum ".
5454 $cust_pay_pending->paypendingnum. "\n";
5460 my $jobnum = $cust_pay_pending->jobnum;
5462 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5464 unless ( $placeholder ) {
5465 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5466 my $e = "WARNING: $options{method} captured but job $jobnum not ".
5467 "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
5472 $error = $placeholder->delete;
5475 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5476 my $e = "WARNING: $options{method} captured but could not delete ".
5477 "job $jobnum for paypendingnum ".
5478 $cust_pay_pending->paypendingnum. ": $error\n";
5485 if ( $options{'paynum_ref'} ) {
5486 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5489 $cust_pay_pending->status('done');
5490 $cust_pay_pending->statustext('captured');
5491 $cust_pay_pending->paynum($cust_pay->paynum);
5492 my $cpp_done_err = $cust_pay_pending->replace;
5494 if ( $cpp_done_err ) {
5496 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5497 my $e = "WARNING: $options{method} captured but payment not recorded - ".
5498 "error updating status for paypendingnum ".
5499 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5505 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5506 return ''; #no error
5512 my $perror = $payment_gateway->gateway_module. " error: ".
5513 $transaction->error_message;
5515 my $jobnum = $cust_pay_pending->jobnum;
5517 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5519 if ( $placeholder ) {
5520 my $error = $placeholder->depended_delete;
5521 $error ||= $placeholder->delete;
5522 warn "error removing provisioning jobs after declined paypendingnum ".
5523 $cust_pay_pending->paypendingnum. "\n";
5525 my $e = "error finding job $jobnum for declined paypendingnum ".
5526 $cust_pay_pending->paypendingnum. "\n";
5532 unless ( $transaction->error_message ) {
5535 if ( $transaction->can('response_page') ) {
5537 'page' => ( $transaction->can('response_page')
5538 ? $transaction->response_page
5541 'code' => ( $transaction->can('response_code')
5542 ? $transaction->response_code
5545 'headers' => ( $transaction->can('response_headers')
5546 ? $transaction->response_headers
5552 "No additional debugging information available for ".
5553 $payment_gateway->gateway_module;
5556 $perror .= "No error_message returned from ".
5557 $payment_gateway->gateway_module. " -- ".
5558 ( ref($t_response) ? Dumper($t_response) : $t_response );
5562 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
5563 && $conf->exists('emaildecline')
5564 && grep { $_ ne 'POST' } $self->invoicing_list
5565 && ! grep { $transaction->error_message =~ /$_/ }
5566 $conf->config('emaildecline-exclude')
5568 my @templ = $conf->config('declinetemplate');
5569 my $template = new Text::Template (
5571 SOURCE => [ map "$_\n", @templ ],
5572 ) or return "($perror) can't create template: $Text::Template::ERROR";
5573 $template->compile()
5574 or return "($perror) can't compile template: $Text::Template::ERROR";
5578 scalar( $conf->config('company_name', $self->agentnum ) ),
5579 'company_address' =>
5580 join("\n", $conf->config('company_address', $self->agentnum ) ),
5581 'error' => $transaction->error_message,
5584 my $error = send_email(
5585 'from' => $conf->config('invoice_from', $self->agentnum ),
5586 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
5587 'subject' => 'Your payment could not be processed',
5588 'body' => [ $template->fill_in(HASH => $templ_hash) ],
5591 $perror .= " (also received error sending decline notification: $error)"
5596 $cust_pay_pending->status('done');
5597 $cust_pay_pending->statustext("declined: $perror");
5598 my $cpp_done_err = $cust_pay_pending->replace;
5599 if ( $cpp_done_err ) {
5600 my $e = "WARNING: $options{method} declined but pending payment not ".
5601 "resolved - error updating status for paypendingnum ".
5602 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5604 $perror = "$e ($perror)";
5612 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
5614 Verifies successful third party processing of a realtime credit card,
5615 ACH (electronic check) or phone bill transaction via a
5616 Business::OnlineThirdPartyPayment realtime gateway. See
5617 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5619 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
5621 The additional options I<payname>, I<city>, I<state>,
5622 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5623 if set, will override the value from the customer record.
5625 I<description> is a free-text field passed to the gateway. It defaults to
5626 "Internet services".
5628 If an I<invnum> is specified, this payment (if successful) is applied to the
5629 specified invoice. If you don't specify an I<invnum> you might want to
5630 call the B<apply_payments> method.
5632 I<quiet> can be set true to surpress email decline notices.
5634 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5635 resulting paynum, if any.
5637 I<payunique> is a unique identifier for this payment.
5639 Returns a hashref containing elements bill_error (which will be undefined
5640 upon success) and session_id of any associated session.
5644 sub realtime_botpp_capture {
5645 my( $self, $cust_pay_pending, %options ) = @_;
5647 warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
5648 warn " $_ => $options{$_}\n" foreach keys %options;
5651 eval "use Business::OnlineThirdPartyPayment";
5655 # select the gateway
5658 my $method = FS::payby->payby2bop($cust_pay_pending->payby);
5660 my $payment_gateway = $cust_pay_pending->gatewaynum
5661 ? qsearchs( 'payment_gateway',
5662 { gatewaynum => $cust_pay_pending->gatewaynum }
5664 : $self->agent->payment_gateway( 'method' => $method,
5665 # 'invnum' => $cust_pay_pending->invnum,
5666 # 'payinfo' => $cust_pay_pending->payinfo,
5669 $options{payment_gateway} = $payment_gateway; # for the helper subs
5675 my @invoicing_list = $self->invoicing_list_emailonly;
5676 if ( $conf->exists('emailinvoiceautoalways')
5677 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5678 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5679 push @invoicing_list, $self->all_emails;
5682 my $email = ($conf->exists('business-onlinepayment-email-override'))
5683 ? $conf->config('business-onlinepayment-email-override')
5684 : $invoicing_list[0];
5688 $content{email_customer} =
5689 ( $conf->exists('business-onlinepayment-email_customer')
5690 || $conf->exists('business-onlinepayment-email-override') );
5693 # run transaction(s)
5697 new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
5698 $self->_bop_options(\%options),
5701 $transaction->reference({ %options });
5703 $transaction->content(
5705 $self->_bop_auth(\%options),
5706 'action' => 'Post Authorization',
5707 'description' => $options{'description'},
5708 'amount' => $cust_pay_pending->paid,
5709 #'invoice_number' => $options{'invnum'},
5710 'customer_id' => $self->custnum,
5711 'referer' => 'http://cleanwhisker.420.am/',
5712 'reference' => $cust_pay_pending->paypendingnum,
5714 'phone' => $self->daytime || $self->night,
5716 # plus whatever is required for bogus capture avoidance
5719 $transaction->submit();
5722 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5725 bill_error => $error,
5726 session_id => $cust_pay_pending->session_id,
5731 =item default_payment_gateway DEPRECATED -- use agent->payment_gateway
5735 sub default_payment_gateway {
5736 my( $self, $method ) = @_;
5738 die "Real-time processing not enabled\n"
5739 unless $conf->exists('business-onlinepayment');
5741 #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
5744 my $bop_config = 'business-onlinepayment';
5745 $bop_config .= '-ach'
5746 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
5747 my ( $processor, $login, $password, $action, @bop_options ) =
5748 $conf->config($bop_config);
5749 $action ||= 'normal authorization';
5750 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
5751 die "No real-time processor is enabled - ".
5752 "did you set the business-onlinepayment configuration value?\n"
5755 ( $processor, $login, $password, $action, @bop_options )
5760 Removes the I<paycvv> field from the database directly.
5762 If there is an error, returns the error, otherwise returns false.
5768 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
5769 or return dbh->errstr;
5770 $sth->execute($self->custnum)
5771 or return $sth->errstr;
5776 =item _new_realtime_refund_bop METHOD [ OPTION => VALUE ... ]
5778 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
5779 via a Business::OnlinePayment realtime gateway. See
5780 L<http://420.am/business-onlinepayment> for supported gateways.
5782 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5784 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
5786 Most gateways require a reference to an original payment transaction to refund,
5787 so you probably need to specify a I<paynum>.
5789 I<amount> defaults to the original amount of the payment if not specified.
5791 I<reason> specifies a reason for the refund.
5793 I<paydate> specifies the expiration date for a credit card overriding the
5794 value from the customer record or the payment record. Specified as yyyy-mm-dd
5796 Implementation note: If I<amount> is unspecified or equal to the amount of the
5797 orignal payment, first an attempt is made to "void" the transaction via
5798 the gateway (to cancel a not-yet settled transaction) and then if that fails,
5799 the normal attempt is made to "refund" ("credit") the transaction via the
5800 gateway is attempted.
5802 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5803 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5804 #if set, will override the value from the customer record.
5806 #If an I<invnum> is specified, this payment (if successful) is applied to the
5807 #specified invoice. If you don't specify an I<invnum> you might want to
5808 #call the B<apply_payments> method.
5812 #some false laziness w/realtime_bop, not enough to make it worth merging
5813 #but some useful small subs should be pulled out
5814 sub _new_realtime_refund_bop {
5818 if (ref($_[0]) ne 'HASH') {
5819 %options = %{$_[0]};
5823 $options{method} = $method;
5827 warn "$me realtime_refund_bop (new): $options{method} refund\n";
5828 warn " $_ => $options{$_}\n" foreach keys %options;
5832 # look up the original payment and optionally a gateway for that payment
5836 my $amount = $options{'amount'};
5838 my( $processor, $login, $password, @bop_options, $namespace ) ;
5839 my( $auth, $order_number ) = ( '', '', '' );
5841 if ( $options{'paynum'} ) {
5843 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
5844 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
5845 or return "Unknown paynum $options{'paynum'}";
5846 $amount ||= $cust_pay->paid;
5848 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
5849 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
5850 $cust_pay->paybatch;
5851 my $gatewaynum = '';
5852 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
5854 if ( $gatewaynum ) { #gateway for the payment to be refunded
5856 my $payment_gateway =
5857 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
5858 die "payment gateway $gatewaynum not found"
5859 unless $payment_gateway;
5861 $processor = $payment_gateway->gateway_module;
5862 $login = $payment_gateway->gateway_username;
5863 $password = $payment_gateway->gateway_password;
5864 $namespace = $payment_gateway->gateway_namespace;
5865 @bop_options = $payment_gateway->options;
5867 } else { #try the default gateway
5870 my $payment_gateway =
5871 $self->agent->payment_gateway('method' => $options{method});
5873 ( $conf_processor, $login, $password, $namespace ) =
5874 map { my $method = "gateway_$_"; $payment_gateway->$method }
5875 qw( module username password namespace );
5877 @bop_options = $payment_gateway->gatewaynum
5878 ? $payment_gateway->options
5879 : @{ $payment_gateway->get('options') };
5881 return "processor of payment $options{'paynum'} $processor does not".
5882 " match default processor $conf_processor"
5883 unless $processor eq $conf_processor;
5888 } else { # didn't specify a paynum, so look for agent gateway overrides
5889 # like a normal transaction
5891 my $payment_gateway =
5892 $self->agent->payment_gateway( 'method' => $options{method},
5893 #'payinfo' => $payinfo,
5895 my( $processor, $login, $password, $namespace ) =
5896 map { my $method = "gateway_$_"; $payment_gateway->$method }
5897 qw( module username password namespace );
5899 my @bop_options = $payment_gateway->gatewaynum
5900 ? $payment_gateway->options
5901 : @{ $payment_gateway->get('options') };
5904 return "neither amount nor paynum specified" unless $amount;
5906 eval "use $namespace";
5910 'type' => $options{method},
5912 'password' => $password,
5913 'order_number' => $order_number,
5914 'amount' => $amount,
5915 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
5917 $content{authorization} = $auth
5918 if length($auth); #echeck/ACH transactions have an order # but no auth
5919 #(at least with authorize.net)
5921 my $disable_void_after;
5922 if ($conf->exists('disable_void_after')
5923 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
5924 $disable_void_after = $1;
5927 #first try void if applicable
5928 if ( $cust_pay && $cust_pay->paid == $amount
5930 ( not defined($disable_void_after) )
5931 || ( time < ($cust_pay->_date + $disable_void_after ) )
5934 warn " attempting void\n" if $DEBUG > 1;
5935 my $void = new Business::OnlinePayment( $processor, @bop_options );
5936 $void->content( 'action' => 'void', %content );
5938 if ( $void->is_success ) {
5939 my $error = $cust_pay->void($options{'reason'});
5941 # gah, even with transactions.
5942 my $e = 'WARNING: Card/ACH voided but database not updated - '.
5943 "error voiding payment: $error";
5947 warn " void successful\n" if $DEBUG > 1;
5952 warn " void unsuccessful, trying refund\n"
5956 my $address = $self->address1;
5957 $address .= ", ". $self->address2 if $self->address2;
5959 my($payname, $payfirst, $paylast);
5960 if ( $self->payname && $options{method} ne 'ECHECK' ) {
5961 $payname = $self->payname;
5962 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5963 or return "Illegal payname $payname";
5964 ($payfirst, $paylast) = ($1, $2);
5966 $payfirst = $self->getfield('first');
5967 $paylast = $self->getfield('last');
5968 $payname = "$payfirst $paylast";
5971 my @invoicing_list = $self->invoicing_list_emailonly;
5972 if ( $conf->exists('emailinvoiceautoalways')
5973 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5974 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5975 push @invoicing_list, $self->all_emails;
5978 my $email = ($conf->exists('business-onlinepayment-email-override'))
5979 ? $conf->config('business-onlinepayment-email-override')
5980 : $invoicing_list[0];
5982 my $payip = exists($options{'payip'})
5985 $content{customer_ip} = $payip
5989 if ( $options{method} eq 'CC' ) {
5992 $content{card_number} = $payinfo = $cust_pay->payinfo;
5993 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
5994 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
5995 ($content{expiration} = "$2/$1"); # where available
5997 $content{card_number} = $payinfo = $self->payinfo;
5998 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
5999 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
6000 $content{expiration} = "$2/$1";
6003 } elsif ( $options{method} eq 'ECHECK' ) {
6006 $payinfo = $cust_pay->payinfo;
6008 $payinfo = $self->payinfo;
6010 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
6011 $content{bank_name} = $self->payname;
6012 $content{account_type} = 'CHECKING';
6013 $content{account_name} = $payname;
6014 $content{customer_org} = $self->company ? 'B' : 'I';
6015 $content{customer_ssn} = $self->ss;
6016 } elsif ( $options{method} eq 'LEC' ) {
6017 $content{phone} = $payinfo = $self->payinfo;
6021 my $refund = new Business::OnlinePayment( $processor, @bop_options );
6022 my %sub_content = $refund->content(
6023 'action' => 'credit',
6024 'customer_id' => $self->custnum,
6025 'last_name' => $paylast,
6026 'first_name' => $payfirst,
6028 'address' => $address,
6029 'city' => $self->city,
6030 'state' => $self->state,
6031 'zip' => $self->zip,
6032 'country' => $self->country,
6034 'phone' => $self->daytime || $self->night,
6037 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
6041 return "$processor error: ". $refund->error_message
6042 unless $refund->is_success();
6044 my $paybatch = "$processor:". $refund->authorization;
6045 $paybatch .= ':'. $refund->order_number
6046 if $refund->can('order_number') && $refund->order_number;
6048 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
6049 my @cust_bill_pay = $cust_pay->cust_bill_pay;
6050 last unless @cust_bill_pay;
6051 my $cust_bill_pay = pop @cust_bill_pay;
6052 my $error = $cust_bill_pay->delete;
6056 my $cust_refund = new FS::cust_refund ( {
6057 'custnum' => $self->custnum,
6058 'paynum' => $options{'paynum'},
6059 'refund' => $amount,
6061 'payby' => $bop_method2payby{$options{method}},
6062 'payinfo' => $payinfo,
6063 'paybatch' => $paybatch,
6064 'reason' => $options{'reason'} || 'card or ACH refund',
6066 my $error = $cust_refund->insert;
6068 $cust_refund->paynum(''); #try again with no specific paynum
6069 my $error2 = $cust_refund->insert;
6071 # gah, even with transactions.
6072 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
6073 "error inserting refund ($processor): $error2".
6074 " (previously tried insert with paynum #$options{'paynum'}" .
6085 =item batch_card OPTION => VALUE...
6087 Adds a payment for this invoice to the pending credit card batch (see
6088 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
6089 runs the payment using a realtime gateway.
6094 my ($self, %options) = @_;
6097 if (exists($options{amount})) {
6098 $amount = $options{amount};
6100 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
6102 return '' unless $amount > 0;
6104 my $invnum = delete $options{invnum};
6105 my $payby = $options{invnum} || $self->payby; #dubious
6107 if ($options{'realtime'}) {
6108 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
6114 my $oldAutoCommit = $FS::UID::AutoCommit;
6115 local $FS::UID::AutoCommit = 0;
6118 #this needs to handle mysql as well as Pg, like svc_acct.pm
6119 #(make it into a common function if folks need to do batching with mysql)
6120 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
6121 or return "Cannot lock pay_batch: " . $dbh->errstr;
6125 'payby' => FS::payby->payby2payment($payby),
6128 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
6130 unless ( $pay_batch ) {
6131 $pay_batch = new FS::pay_batch \%pay_batch;
6132 my $error = $pay_batch->insert;
6134 $dbh->rollback if $oldAutoCommit;
6135 die "error creating new batch: $error\n";
6139 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
6140 'batchnum' => $pay_batch->batchnum,
6141 'custnum' => $self->custnum,
6144 foreach (qw( address1 address2 city state zip country payby payinfo paydate
6146 $options{$_} = '' unless exists($options{$_});
6149 my $cust_pay_batch = new FS::cust_pay_batch ( {
6150 'batchnum' => $pay_batch->batchnum,
6151 'invnum' => $invnum || 0, # is there a better value?
6152 # this field should be
6154 # cust_bill_pay_batch now
6155 'custnum' => $self->custnum,
6156 'last' => $self->getfield('last'),
6157 'first' => $self->getfield('first'),
6158 'address1' => $options{address1} || $self->address1,
6159 'address2' => $options{address2} || $self->address2,
6160 'city' => $options{city} || $self->city,
6161 'state' => $options{state} || $self->state,
6162 'zip' => $options{zip} || $self->zip,
6163 'country' => $options{country} || $self->country,
6164 'payby' => $options{payby} || $self->payby,
6165 'payinfo' => $options{payinfo} || $self->payinfo,
6166 'exp' => $options{paydate} || $self->paydate,
6167 'payname' => $options{payname} || $self->payname,
6168 'amount' => $amount, # consolidating
6171 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
6172 if $old_cust_pay_batch;
6175 if ($old_cust_pay_batch) {
6176 $error = $cust_pay_batch->replace($old_cust_pay_batch)
6178 $error = $cust_pay_batch->insert;
6182 $dbh->rollback if $oldAutoCommit;
6186 my $unapplied = $self->total_unapplied_credits
6187 + $self->total_unapplied_payments
6188 + $self->in_transit_payments;
6189 foreach my $cust_bill ($self->open_cust_bill) {
6190 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
6191 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
6192 'invnum' => $cust_bill->invnum,
6193 'paybatchnum' => $cust_pay_batch->paybatchnum,
6194 'amount' => $cust_bill->owed,
6197 if ($unapplied >= $cust_bill_pay_batch->amount){
6198 $unapplied -= $cust_bill_pay_batch->amount;
6201 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
6202 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
6204 $error = $cust_bill_pay_batch->insert;
6206 $dbh->rollback if $oldAutoCommit;
6211 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6215 =item apply_payments_and_credits [ OPTION => VALUE ... ]
6217 Applies unapplied payments and credits.
6219 In most cases, this new method should be used in place of sequential
6220 apply_payments and apply_credits methods.
6222 A hash of optional arguments may be passed. Currently "manual" is supported.
6223 If true, a payment receipt is sent instead of a statement when
6224 'payment_receipt_email' configuration option is set.
6226 If there is an error, returns the error, otherwise returns false.
6230 sub apply_payments_and_credits {
6231 my( $self, %options ) = @_;
6233 local $SIG{HUP} = 'IGNORE';
6234 local $SIG{INT} = 'IGNORE';
6235 local $SIG{QUIT} = 'IGNORE';
6236 local $SIG{TERM} = 'IGNORE';
6237 local $SIG{TSTP} = 'IGNORE';
6238 local $SIG{PIPE} = 'IGNORE';
6240 my $oldAutoCommit = $FS::UID::AutoCommit;
6241 local $FS::UID::AutoCommit = 0;
6244 $self->select_for_update; #mutex
6246 foreach my $cust_bill ( $self->open_cust_bill ) {
6247 my $error = $cust_bill->apply_payments_and_credits(%options);
6249 $dbh->rollback if $oldAutoCommit;
6250 return "Error applying: $error";
6254 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6259 =item apply_credits OPTION => VALUE ...
6261 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
6262 to outstanding invoice balances in chronological order (or reverse
6263 chronological order if the I<order> option is set to B<newest>) and returns the
6264 value of any remaining unapplied credits available for refund (see
6265 L<FS::cust_refund>).
6267 Dies if there is an error.
6275 local $SIG{HUP} = 'IGNORE';
6276 local $SIG{INT} = 'IGNORE';
6277 local $SIG{QUIT} = 'IGNORE';
6278 local $SIG{TERM} = 'IGNORE';
6279 local $SIG{TSTP} = 'IGNORE';
6280 local $SIG{PIPE} = 'IGNORE';
6282 my $oldAutoCommit = $FS::UID::AutoCommit;
6283 local $FS::UID::AutoCommit = 0;
6286 $self->select_for_update; #mutex
6288 unless ( $self->total_unapplied_credits ) {
6289 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6293 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
6294 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
6296 my @invoices = $self->open_cust_bill;
6297 @invoices = sort { $b->_date <=> $a->_date } @invoices
6298 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
6300 if ( $conf->exists('pkg-balances') ) {
6301 # limit @credits to those w/ a pkgnum grepped from $self
6303 foreach my $i (@invoices) {
6304 foreach my $li ( $i->cust_bill_pkg ) {
6305 $pkgnums{$li->pkgnum} = 1;
6308 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
6313 foreach my $cust_bill ( @invoices ) {
6315 if ( !defined($credit) || $credit->credited == 0) {
6316 $credit = pop @credits or last;
6320 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
6321 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
6323 $owed = $cust_bill->owed;
6325 unless ( $owed > 0 ) {
6326 push @credits, $credit;
6330 my $amount = min( $credit->credited, $owed );
6332 my $cust_credit_bill = new FS::cust_credit_bill ( {
6333 'crednum' => $credit->crednum,
6334 'invnum' => $cust_bill->invnum,
6335 'amount' => $amount,
6337 $cust_credit_bill->pkgnum( $credit->pkgnum )
6338 if $conf->exists('pkg-balances') && $credit->pkgnum;
6339 my $error = $cust_credit_bill->insert;
6341 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6345 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6349 my $total_unapplied_credits = $self->total_unapplied_credits;
6351 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6353 return $total_unapplied_credits;
6356 =item apply_payments [ OPTION => VALUE ... ]
6358 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
6359 to outstanding invoice balances in chronological order.
6361 #and returns the value of any remaining unapplied payments.
6363 A hash of optional arguments may be passed. Currently "manual" is supported.
6364 If true, a payment receipt is sent instead of a statement when
6365 'payment_receipt_email' configuration option is set.
6368 Dies if there is an error.
6372 sub apply_payments {
6373 my( $self, %options ) = @_;
6375 local $SIG{HUP} = 'IGNORE';
6376 local $SIG{INT} = 'IGNORE';
6377 local $SIG{QUIT} = 'IGNORE';
6378 local $SIG{TERM} = 'IGNORE';
6379 local $SIG{TSTP} = 'IGNORE';
6380 local $SIG{PIPE} = 'IGNORE';
6382 my $oldAutoCommit = $FS::UID::AutoCommit;
6383 local $FS::UID::AutoCommit = 0;
6386 $self->select_for_update; #mutex
6390 my @payments = sort { $b->_date <=> $a->_date }
6391 grep { $_->unapplied > 0 }
6394 my @invoices = sort { $a->_date <=> $b->_date}
6395 grep { $_->owed > 0 }
6398 if ( $conf->exists('pkg-balances') ) {
6399 # limit @payments to those w/ a pkgnum grepped from $self
6401 foreach my $i (@invoices) {
6402 foreach my $li ( $i->cust_bill_pkg ) {
6403 $pkgnums{$li->pkgnum} = 1;
6406 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
6411 foreach my $cust_bill ( @invoices ) {
6413 if ( !defined($payment) || $payment->unapplied == 0 ) {
6414 $payment = pop @payments or last;
6418 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
6419 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
6421 $owed = $cust_bill->owed;
6423 unless ( $owed > 0 ) {
6424 push @payments, $payment;
6428 my $amount = min( $payment->unapplied, $owed );
6430 my $cust_bill_pay = new FS::cust_bill_pay ( {
6431 'paynum' => $payment->paynum,
6432 'invnum' => $cust_bill->invnum,
6433 'amount' => $amount,
6435 $cust_bill_pay->pkgnum( $payment->pkgnum )
6436 if $conf->exists('pkg-balances') && $payment->pkgnum;
6437 my $error = $cust_bill_pay->insert(%options);
6439 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6443 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6447 my $total_unapplied_payments = $self->total_unapplied_payments;
6449 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6451 return $total_unapplied_payments;
6456 Returns the total owed for this customer on all invoices
6457 (see L<FS::cust_bill/owed>).
6463 $self->total_owed_date(2145859200); #12/31/2037
6466 =item total_owed_date TIME
6468 Returns the total owed for this customer on all invoices with date earlier than
6469 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6470 see L<Time::Local> and L<Date::Parse> for conversion functions.
6474 sub total_owed_date {
6478 # my $custnum = $self->custnum;
6480 # my $owed_sql = FS::cust_bill->owed_sql;
6483 # SELECT SUM($owed_sql) FROM cust_bill
6484 # WHERE custnum = $custnum
6485 # AND _date <= $time
6488 # my $sth = dbh->prepare($sql) or die dbh->errstr;
6489 # $sth->execute() or die $sth->errstr;
6491 # return sprintf( '%.2f', $sth->fetchrow_arrayref->[0] );
6494 foreach my $cust_bill (
6495 grep { $_->_date <= $time }
6496 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6498 $total_bill += $cust_bill->owed;
6500 sprintf( "%.2f", $total_bill );
6504 =item total_owed_pkgnum PKGNUM
6506 Returns the total owed on all invoices for this customer's specific package
6507 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
6511 sub total_owed_pkgnum {
6512 my( $self, $pkgnum ) = @_;
6513 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
6516 =item total_owed_date_pkgnum TIME PKGNUM
6518 Returns the total owed for this customer's specific package when using
6519 experimental package balances on all invoices with date earlier than
6520 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6521 see L<Time::Local> and L<Date::Parse> for conversion functions.
6525 sub total_owed_date_pkgnum {
6526 my( $self, $time, $pkgnum ) = @_;
6529 foreach my $cust_bill (
6530 grep { $_->_date <= $time }
6531 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6533 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
6535 sprintf( "%.2f", $total_bill );
6541 Returns the total amount of all payments.
6548 $total += $_->paid foreach $self->cust_pay;
6549 sprintf( "%.2f", $total );
6552 =item total_unapplied_credits
6554 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6555 customer. See L<FS::cust_credit/credited>.
6557 =item total_credited
6559 Old name for total_unapplied_credits. Don't use.
6563 sub total_credited {
6564 #carp "total_credited deprecated, use total_unapplied_credits";
6565 shift->total_unapplied_credits(@_);
6568 sub total_unapplied_credits {
6570 my $total_credit = 0;
6571 $total_credit += $_->credited foreach $self->cust_credit;
6572 sprintf( "%.2f", $total_credit );
6575 =item total_unapplied_credits_pkgnum PKGNUM
6577 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6578 customer. See L<FS::cust_credit/credited>.
6582 sub total_unapplied_credits_pkgnum {
6583 my( $self, $pkgnum ) = @_;
6584 my $total_credit = 0;
6585 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
6586 sprintf( "%.2f", $total_credit );
6590 =item total_unapplied_payments
6592 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
6593 See L<FS::cust_pay/unapplied>.
6597 sub total_unapplied_payments {
6599 my $total_unapplied = 0;
6600 $total_unapplied += $_->unapplied foreach $self->cust_pay;
6601 sprintf( "%.2f", $total_unapplied );
6604 =item total_unapplied_payments_pkgnum PKGNUM
6606 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
6607 specific package when using experimental package balances. See
6608 L<FS::cust_pay/unapplied>.
6612 sub total_unapplied_payments_pkgnum {
6613 my( $self, $pkgnum ) = @_;
6614 my $total_unapplied = 0;
6615 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
6616 sprintf( "%.2f", $total_unapplied );
6620 =item total_unapplied_refunds
6622 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
6623 customer. See L<FS::cust_refund/unapplied>.
6627 sub total_unapplied_refunds {
6629 my $total_unapplied = 0;
6630 $total_unapplied += $_->unapplied foreach $self->cust_refund;
6631 sprintf( "%.2f", $total_unapplied );
6636 Returns the balance for this customer (total_owed plus total_unrefunded, minus
6637 total_unapplied_credits minus total_unapplied_payments).
6645 + $self->total_unapplied_refunds
6646 - $self->total_unapplied_credits
6647 - $self->total_unapplied_payments
6651 =item balance_date TIME
6653 Returns the balance for this customer, only considering invoices with date
6654 earlier than TIME (total_owed_date minus total_credited minus
6655 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
6656 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
6665 $self->total_owed_date($time)
6666 + $self->total_unapplied_refunds
6667 - $self->total_unapplied_credits
6668 - $self->total_unapplied_payments
6672 =item balance_pkgnum PKGNUM
6674 Returns the balance for this customer's specific package when using
6675 experimental package balances (total_owed plus total_unrefunded, minus
6676 total_unapplied_credits minus total_unapplied_payments)
6680 sub balance_pkgnum {
6681 my( $self, $pkgnum ) = @_;
6684 $self->total_owed_pkgnum($pkgnum)
6685 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
6686 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
6687 - $self->total_unapplied_credits_pkgnum($pkgnum)
6688 - $self->total_unapplied_payments_pkgnum($pkgnum)
6692 =item in_transit_payments
6694 Returns the total of requests for payments for this customer pending in
6695 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
6699 sub in_transit_payments {
6701 my $in_transit_payments = 0;
6702 foreach my $pay_batch ( qsearch('pay_batch', {
6705 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
6706 'batchnum' => $pay_batch->batchnum,
6707 'custnum' => $self->custnum,
6709 $in_transit_payments += $cust_pay_batch->amount;
6712 sprintf( "%.2f", $in_transit_payments );
6717 Returns a hash of useful information for making a payment.
6727 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
6728 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
6729 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
6733 For credit card transactions:
6745 For electronic check transactions:
6760 $return{balance} = $self->balance;
6762 $return{payname} = $self->payname
6763 || ( $self->first. ' '. $self->get('last') );
6765 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
6767 $return{payby} = $self->payby;
6768 $return{stateid_state} = $self->stateid_state;
6770 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
6771 $return{card_type} = cardtype($self->payinfo);
6772 $return{payinfo} = $self->paymask;
6774 @return{'month', 'year'} = $self->paydate_monthyear;
6778 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
6779 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
6780 $return{payinfo1} = $payinfo1;
6781 $return{payinfo2} = $payinfo2;
6782 $return{paytype} = $self->paytype;
6783 $return{paystate} = $self->paystate;
6787 #doubleclick protection
6789 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
6795 =item paydate_monthyear
6797 Returns a two-element list consisting of the month and year of this customer's
6798 paydate (credit card expiration date for CARD customers)
6802 sub paydate_monthyear {
6804 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
6806 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
6813 =item tax_exemption TAXNAME
6818 my( $self, $taxname ) = @_;
6820 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
6821 'taxname' => $taxname,
6826 =item cust_main_exemption
6830 sub cust_main_exemption {
6832 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
6835 =item invoicing_list [ ARRAYREF ]
6837 If an arguement is given, sets these email addresses as invoice recipients
6838 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
6839 (except as warnings), so use check_invoicing_list first.
6841 Returns a list of email addresses (with svcnum entries expanded).
6843 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
6844 check it without disturbing anything by passing nothing.
6846 This interface may change in the future.
6850 sub invoicing_list {
6851 my( $self, $arrayref ) = @_;
6854 my @cust_main_invoice;
6855 if ( $self->custnum ) {
6856 @cust_main_invoice =
6857 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6859 @cust_main_invoice = ();
6861 foreach my $cust_main_invoice ( @cust_main_invoice ) {
6862 #warn $cust_main_invoice->destnum;
6863 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
6864 #warn $cust_main_invoice->destnum;
6865 my $error = $cust_main_invoice->delete;
6866 warn $error if $error;
6869 if ( $self->custnum ) {
6870 @cust_main_invoice =
6871 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6873 @cust_main_invoice = ();
6875 my %seen = map { $_->address => 1 } @cust_main_invoice;
6876 foreach my $address ( @{$arrayref} ) {
6877 next if exists $seen{$address} && $seen{$address};
6878 $seen{$address} = 1;
6879 my $cust_main_invoice = new FS::cust_main_invoice ( {
6880 'custnum' => $self->custnum,
6883 my $error = $cust_main_invoice->insert;
6884 warn $error if $error;
6888 if ( $self->custnum ) {
6890 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6897 =item check_invoicing_list ARRAYREF
6899 Checks these arguements as valid input for the invoicing_list method. If there
6900 is an error, returns the error, otherwise returns false.
6904 sub check_invoicing_list {
6905 my( $self, $arrayref ) = @_;
6907 foreach my $address ( @$arrayref ) {
6909 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
6910 return 'Can\'t add FAX invoice destination with a blank FAX number.';
6913 my $cust_main_invoice = new FS::cust_main_invoice ( {
6914 'custnum' => $self->custnum,
6917 my $error = $self->custnum
6918 ? $cust_main_invoice->check
6919 : $cust_main_invoice->checkdest
6921 return $error if $error;
6925 return "Email address required"
6926 if $conf->exists('cust_main-require_invoicing_list_email')
6927 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
6932 =item set_default_invoicing_list
6934 Sets the invoicing list to all accounts associated with this customer,
6935 overwriting any previous invoicing list.
6939 sub set_default_invoicing_list {
6941 $self->invoicing_list($self->all_emails);
6946 Returns the email addresses of all accounts provisioned for this customer.
6953 foreach my $cust_pkg ( $self->all_pkgs ) {
6954 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
6956 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
6957 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
6959 $list{$_}=1 foreach map { $_->email } @svc_acct;
6964 =item invoicing_list_addpost
6966 Adds postal invoicing to this customer. If this customer is already configured
6967 to receive postal invoices, does nothing.
6971 sub invoicing_list_addpost {
6973 return if grep { $_ eq 'POST' } $self->invoicing_list;
6974 my @invoicing_list = $self->invoicing_list;
6975 push @invoicing_list, 'POST';
6976 $self->invoicing_list(\@invoicing_list);
6979 =item invoicing_list_emailonly
6981 Returns the list of email invoice recipients (invoicing_list without non-email
6982 destinations such as POST and FAX).
6986 sub invoicing_list_emailonly {
6988 warn "$me invoicing_list_emailonly called"
6990 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
6993 =item invoicing_list_emailonly_scalar
6995 Returns the list of email invoice recipients (invoicing_list without non-email
6996 destinations such as POST and FAX) as a comma-separated scalar.
7000 sub invoicing_list_emailonly_scalar {
7002 warn "$me invoicing_list_emailonly_scalar called"
7004 join(', ', $self->invoicing_list_emailonly);
7007 =item referral_custnum_cust_main
7009 Returns the customer who referred this customer (or the empty string, if
7010 this customer was not referred).
7012 Note the difference with referral_cust_main method: This method,
7013 referral_custnum_cust_main returns the single customer (if any) who referred
7014 this customer, while referral_cust_main returns an array of customers referred
7019 sub referral_custnum_cust_main {
7021 return '' unless $self->referral_custnum;
7022 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7025 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
7027 Returns an array of customers referred by this customer (referral_custnum set
7028 to this custnum). If DEPTH is given, recurses up to the given depth, returning
7029 customers referred by customers referred by this customer and so on, inclusive.
7030 The default behavior is DEPTH 1 (no recursion).
7032 Note the difference with referral_custnum_cust_main method: This method,
7033 referral_cust_main, returns an array of customers referred BY this customer,
7034 while referral_custnum_cust_main returns the single customer (if any) who
7035 referred this customer.
7039 sub referral_cust_main {
7041 my $depth = @_ ? shift : 1;
7042 my $exclude = @_ ? shift : {};
7045 map { $exclude->{$_->custnum}++; $_; }
7046 grep { ! $exclude->{ $_->custnum } }
7047 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
7051 map { $_->referral_cust_main($depth-1, $exclude) }
7058 =item referral_cust_main_ncancelled
7060 Same as referral_cust_main, except only returns customers with uncancelled
7065 sub referral_cust_main_ncancelled {
7067 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
7070 =item referral_cust_pkg [ DEPTH ]
7072 Like referral_cust_main, except returns a flat list of all unsuspended (and
7073 uncancelled) packages for each customer. The number of items in this list may
7074 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
7078 sub referral_cust_pkg {
7080 my $depth = @_ ? shift : 1;
7082 map { $_->unsuspended_pkgs }
7083 grep { $_->unsuspended_pkgs }
7084 $self->referral_cust_main($depth);
7087 =item referring_cust_main
7089 Returns the single cust_main record for the customer who referred this customer
7090 (referral_custnum), or false.
7094 sub referring_cust_main {
7096 return '' unless $self->referral_custnum;
7097 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7100 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
7102 Applies a credit to this customer. If there is an error, returns the error,
7103 otherwise returns false.
7105 REASON can be a text string, an FS::reason object, or a scalar reference to
7106 a reasonnum. If a text string, it will be automatically inserted as a new
7107 reason, and a 'reason_type' option must be passed to indicate the
7108 FS::reason_type for the new reason.
7110 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
7112 Any other options are passed to FS::cust_credit::insert.
7117 my( $self, $amount, $reason, %options ) = @_;
7119 my $cust_credit = new FS::cust_credit {
7120 'custnum' => $self->custnum,
7121 'amount' => $amount,
7124 if ( ref($reason) ) {
7126 if ( ref($reason) eq 'SCALAR' ) {
7127 $cust_credit->reasonnum( $$reason );
7129 $cust_credit->reasonnum( $reason->reasonnum );
7133 $cust_credit->set('reason', $reason)
7136 $cust_credit->addlinfo( delete $options{'addlinfo'} )
7137 if exists($options{'addlinfo'});
7139 $cust_credit->insert(%options);
7143 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
7145 Creates a one-time charge for this customer. If there is an error, returns
7146 the error, otherwise returns false.
7148 New-style, with a hashref of options:
7150 my $error = $cust_main->charge(
7154 'start_date' => str2time('7/4/2009'),
7155 'pkg' => 'Description',
7156 'comment' => 'Comment',
7157 'additional' => [], #extra invoice detail
7158 'classnum' => 1, #pkg_class
7160 'setuptax' => '', # or 'Y' for tax exempt
7163 'taxclass' => 'Tax class',
7166 'taxproduct' => 2, #part_pkg_taxproduct
7167 'override' => {}, #XXX describe
7173 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
7179 my ( $amount, $quantity, $start_date, $classnum );
7180 my ( $pkg, $comment, $additional );
7181 my ( $setuptax, $taxclass ); #internal taxes
7182 my ( $taxproduct, $override ); #vendor (CCH) taxes
7183 if ( ref( $_[0] ) ) {
7184 $amount = $_[0]->{amount};
7185 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
7186 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
7187 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
7188 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
7189 : '$'. sprintf("%.2f",$amount);
7190 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
7191 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
7192 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
7193 $additional = $_[0]->{additional} || [];
7194 $taxproduct = $_[0]->{taxproductnum};
7195 $override = { '' => $_[0]->{tax_override} };
7200 $pkg = @_ ? shift : 'One-time charge';
7201 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
7203 $taxclass = @_ ? shift : '';
7207 local $SIG{HUP} = 'IGNORE';
7208 local $SIG{INT} = 'IGNORE';
7209 local $SIG{QUIT} = 'IGNORE';
7210 local $SIG{TERM} = 'IGNORE';
7211 local $SIG{TSTP} = 'IGNORE';
7212 local $SIG{PIPE} = 'IGNORE';
7214 my $oldAutoCommit = $FS::UID::AutoCommit;
7215 local $FS::UID::AutoCommit = 0;
7218 my $part_pkg = new FS::part_pkg ( {
7220 'comment' => $comment,
7224 'classnum' => $classnum ? $classnum : '',
7225 'setuptax' => $setuptax,
7226 'taxclass' => $taxclass,
7227 'taxproductnum' => $taxproduct,
7230 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
7231 ( 0 .. @$additional - 1 )
7233 'additional_count' => scalar(@$additional),
7234 'setup_fee' => $amount,
7237 my $error = $part_pkg->insert( options => \%options,
7238 tax_overrides => $override,
7241 $dbh->rollback if $oldAutoCommit;
7245 my $pkgpart = $part_pkg->pkgpart;
7246 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
7247 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
7248 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
7249 $error = $type_pkgs->insert;
7251 $dbh->rollback if $oldAutoCommit;
7256 my $cust_pkg = new FS::cust_pkg ( {
7257 'custnum' => $self->custnum,
7258 'pkgpart' => $pkgpart,
7259 'quantity' => $quantity,
7260 'start_date' => $start_date,
7263 $error = $cust_pkg->insert;
7265 $dbh->rollback if $oldAutoCommit;
7269 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
7274 #=item charge_postal_fee
7276 #Applies a one time charge this customer. If there is an error,
7277 #returns the error, returns the cust_pkg charge object or false
7278 #if there was no charge.
7282 # This should be a customer event. For that to work requires that bill
7283 # also be a customer event.
7285 sub charge_postal_fee {
7288 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
7289 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
7291 my $cust_pkg = new FS::cust_pkg ( {
7292 'custnum' => $self->custnum,
7293 'pkgpart' => $pkgpart,
7297 my $error = $cust_pkg->insert;
7298 $error ? $error : $cust_pkg;
7303 Returns all the invoices (see L<FS::cust_bill>) for this customer.
7309 sort { $a->_date <=> $b->_date }
7310 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
7313 =item open_cust_bill
7315 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
7320 sub open_cust_bill {
7324 'table' => 'cust_bill',
7325 'hashref' => { 'custnum' => $self->custnum, },
7326 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
7327 'order_by' => 'ORDER BY _date ASC',
7332 =item cust_statements
7334 Returns all the statements (see L<FS::cust_statement>) for this customer.
7338 sub cust_statement {
7340 sort { $a->_date <=> $b->_date }
7341 qsearch('cust_statement', { 'custnum' => $self->custnum, } )
7346 Returns all the credits (see L<FS::cust_credit>) for this customer.
7352 sort { $a->_date <=> $b->_date }
7353 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
7356 =item cust_credit_pkgnum
7358 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
7359 package when using experimental package balances.
7363 sub cust_credit_pkgnum {
7364 my( $self, $pkgnum ) = @_;
7365 sort { $a->_date <=> $b->_date }
7366 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
7367 'pkgnum' => $pkgnum,
7374 Returns all the payments (see L<FS::cust_pay>) for this customer.
7380 return $self->num_cust_pay unless wantarray;
7381 sort { $a->_date <=> $b->_date }
7382 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
7387 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
7388 called automatically when the cust_pay method is used in a scalar context.
7394 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
7395 my $sth = dbh->prepare($sql) or die dbh->errstr;
7396 $sth->execute($self->custnum) or die $sth->errstr;
7397 $sth->fetchrow_arrayref->[0];
7400 =item cust_pay_pkgnum
7402 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
7403 package when using experimental package balances.
7407 sub cust_pay_pkgnum {
7408 my( $self, $pkgnum ) = @_;
7409 sort { $a->_date <=> $b->_date }
7410 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
7411 'pkgnum' => $pkgnum,
7418 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
7424 sort { $a->_date <=> $b->_date }
7425 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
7428 =item cust_pay_batch
7430 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
7434 sub cust_pay_batch {
7436 sort { $a->paybatchnum <=> $b->paybatchnum }
7437 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
7440 =item cust_pay_pending
7442 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
7443 (without status "done").
7447 sub cust_pay_pending {
7449 return $self->num_cust_pay_pending unless wantarray;
7450 sort { $a->_date <=> $b->_date }
7451 qsearch( 'cust_pay_pending', {
7452 'custnum' => $self->custnum,
7453 'status' => { op=>'!=', value=>'done' },
7458 =item num_cust_pay_pending
7460 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
7461 customer (without status "done"). Also called automatically when the
7462 cust_pay_pending method is used in a scalar context.
7466 sub num_cust_pay_pending {
7468 my $sql = " SELECT COUNT(*) FROM cust_pay_pending ".
7469 " WHERE custnum = ? AND status != 'done' ";
7470 my $sth = dbh->prepare($sql) or die dbh->errstr;
7471 $sth->execute($self->custnum) or die $sth->errstr;
7472 $sth->fetchrow_arrayref->[0];
7477 Returns all the refunds (see L<FS::cust_refund>) for this customer.
7483 sort { $a->_date <=> $b->_date }
7484 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
7487 =item display_custnum
7489 Returns the displayed customer number for this customer: agent_custid if
7490 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
7494 sub display_custnum {
7496 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
7497 return $self->agent_custid;
7499 return $self->custnum;
7505 Returns a name string for this customer, either "Company (Last, First)" or
7512 my $name = $self->contact;
7513 $name = $self->company. " ($name)" if $self->company;
7519 Returns a name string for this (service/shipping) contact, either
7520 "Company (Last, First)" or "Last, First".
7526 if ( $self->get('ship_last') ) {
7527 my $name = $self->ship_contact;
7528 $name = $self->ship_company. " ($name)" if $self->ship_company;
7537 Returns a name string for this customer, either "Company" or "First Last".
7543 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
7546 =item ship_name_short
7548 Returns a name string for this (service/shipping) contact, either "Company"
7553 sub ship_name_short {
7555 if ( $self->get('ship_last') ) {
7556 $self->ship_company !~ /^\s*$/
7557 ? $self->ship_company
7558 : $self->ship_contact_firstlast;
7560 $self->name_company_or_firstlast;
7566 Returns this customer's full (billing) contact name only, "Last, First"
7572 $self->get('last'). ', '. $self->first;
7577 Returns this customer's full (shipping) contact name only, "Last, First"
7583 $self->get('ship_last')
7584 ? $self->get('ship_last'). ', '. $self->ship_first
7588 =item contact_firstlast
7590 Returns this customers full (billing) contact name only, "First Last".
7594 sub contact_firstlast {
7596 $self->first. ' '. $self->get('last');
7599 =item ship_contact_firstlast
7601 Returns this customer's full (shipping) contact name only, "First Last".
7605 sub ship_contact_firstlast {
7607 $self->get('ship_last')
7608 ? $self->first. ' '. $self->get('ship_last')
7609 : $self->contact_firstlast;
7614 Returns this customer's full country name
7620 code2country($self->country);
7623 =item geocode DATA_VENDOR
7625 Returns a value for the customer location as encoded by DATA_VENDOR.
7626 Currently this only makes sense for "CCH" as DATA_VENDOR.
7631 my ($self, $data_vendor) = (shift, shift); #always cch for now
7633 my $geocode = $self->get('geocode'); #XXX only one data_vendor for geocode
7634 return $geocode if $geocode;
7636 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
7640 my ($zip,$plus4) = split /-/, $self->get("${prefix}zip")
7641 if $self->country eq 'US';
7643 #CCH specific location stuff
7644 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
7646 my @cust_tax_location =
7648 'table' => 'cust_tax_location',
7649 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
7650 'extra_sql' => $extra_sql,
7651 'order_by' => 'ORDER BY plus4hi',#overlapping with distinct ends
7654 $geocode = $cust_tax_location[0]->geocode
7655 if scalar(@cust_tax_location);
7664 Returns a status string for this customer, currently:
7668 =item prospect - No packages have ever been ordered
7670 =item active - One or more recurring packages is active
7672 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
7674 =item suspended - All non-cancelled recurring packages are suspended
7676 =item cancelled - All recurring packages are cancelled
7682 sub status { shift->cust_status(@_); }
7686 for my $status (qw( prospect active inactive suspended cancelled )) {
7687 my $method = $status.'_sql';
7688 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
7689 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
7690 $sth->execute( ($self->custnum) x $numnum )
7691 or die "Error executing 'SELECT $sql': ". $sth->errstr;
7692 return $status if $sth->fetchrow_arrayref->[0];
7696 =item ucfirst_cust_status
7698 =item ucfirst_status
7700 Returns the status with the first character capitalized.
7704 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
7706 sub ucfirst_cust_status {
7708 ucfirst($self->cust_status);
7713 Returns a hex triplet color string for this customer's status.
7717 use vars qw(%statuscolor);
7718 tie %statuscolor, 'Tie::IxHash',
7719 'prospect' => '7e0079', #'000000', #black? naw, purple
7720 'active' => '00CC00', #green
7721 'inactive' => '0000CC', #blue
7722 'suspended' => 'FF9900', #yellow
7723 'cancelled' => 'FF0000', #red
7726 sub statuscolor { shift->cust_statuscolor(@_); }
7728 sub cust_statuscolor {
7730 $statuscolor{$self->cust_status};
7735 Returns an array of hashes representing the customer's RT tickets.
7742 my $num = $conf->config('cust_main-max_tickets') || 10;
7745 if ( $conf->config('ticket_system') ) {
7746 unless ( $conf->config('ticket_system-custom_priority_field') ) {
7748 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
7752 foreach my $priority (
7753 $conf->config('ticket_system-custom_priority_field-values'), ''
7755 last if scalar(@tickets) >= $num;
7757 @{ FS::TicketSystem->customer_tickets( $self->custnum,
7758 $num - scalar(@tickets),
7768 # Return services representing svc_accts in customer support packages
7769 sub support_services {
7771 my %packages = map { $_ => 1 } $conf->config('support_packages');
7773 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
7774 grep { $_->part_svc->svcdb eq 'svc_acct' }
7775 map { $_->cust_svc }
7776 grep { exists $packages{ $_->pkgpart } }
7777 $self->ncancelled_pkgs;
7781 # Return a list of latitude/longitude for one of the services (if any)
7782 sub service_coordinates {
7786 grep { $_->latitude && $_->longitude }
7788 map { $_->cust_svc }
7789 $self->ncancelled_pkgs;
7791 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
7796 =head1 CLASS METHODS
7802 Class method that returns the list of possible status strings for customers
7803 (see L<the status method|/status>). For example:
7805 @statuses = FS::cust_main->statuses();
7810 #my $self = shift; #could be class...
7816 Returns an SQL expression identifying prospective cust_main records (customers
7817 with no packages ever ordered)
7821 use vars qw($select_count_pkgs);
7822 $select_count_pkgs =
7823 "SELECT COUNT(*) FROM cust_pkg
7824 WHERE cust_pkg.custnum = cust_main.custnum";
7826 sub select_count_pkgs_sql {
7830 sub prospect_sql { "
7831 0 = ( $select_count_pkgs )
7836 Returns an SQL expression identifying active cust_main records (customers with
7837 active recurring packages).
7842 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
7848 Returns an SQL expression identifying inactive cust_main records (customers with
7849 no active recurring packages, but otherwise unsuspended/uncancelled).
7853 sub inactive_sql { "
7854 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
7856 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
7862 Returns an SQL expression identifying suspended cust_main records.
7867 sub suspended_sql { susp_sql(@_); }
7869 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
7871 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
7877 Returns an SQL expression identifying cancelled cust_main records.
7881 sub cancelled_sql { cancel_sql(@_); }
7884 my $recurring_sql = FS::cust_pkg->recurring_sql;
7885 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
7888 0 < ( $select_count_pkgs )
7889 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
7890 AND 0 = ( $select_count_pkgs AND $recurring_sql
7891 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
7893 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
7899 =item uncancelled_sql
7901 Returns an SQL expression identifying un-cancelled cust_main records.
7905 sub uncancelled_sql { uncancel_sql(@_); }
7906 sub uncancel_sql { "
7907 ( 0 < ( $select_count_pkgs
7908 AND ( cust_pkg.cancel IS NULL
7909 OR cust_pkg.cancel = 0
7912 OR 0 = ( $select_count_pkgs )
7918 Returns an SQL fragment to retreive the balance.
7923 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
7924 WHERE cust_bill.custnum = cust_main.custnum )
7925 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
7926 WHERE cust_pay.custnum = cust_main.custnum )
7927 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
7928 WHERE cust_credit.custnum = cust_main.custnum )
7929 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
7930 WHERE cust_refund.custnum = cust_main.custnum )
7933 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
7935 Returns an SQL fragment to retreive the balance for this customer, only
7936 considering invoices with date earlier than START_TIME, and optionally not
7937 later than END_TIME (total_owed_date minus total_unapplied_credits minus
7938 total_unapplied_payments).
7940 Times are specified as SQL fragments or numeric
7941 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
7942 L<Date::Parse> for conversion functions. The empty string can be passed
7943 to disable that time constraint completely.
7945 Available options are:
7949 =item unapplied_date
7951 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)
7956 set to true to remove all customer comparison clauses, for totals
7961 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
7966 JOIN clause (typically used with the total option)
7972 sub balance_date_sql {
7973 my( $class, $start, $end, %opt ) = @_;
7975 my $owed = FS::cust_bill->owed_sql;
7976 my $unapp_refund = FS::cust_refund->unapplied_sql;
7977 my $unapp_credit = FS::cust_credit->unapplied_sql;
7978 my $unapp_pay = FS::cust_pay->unapplied_sql;
7980 my $j = $opt{'join'} || '';
7982 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
7983 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
7984 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
7985 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
7987 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
7988 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
7989 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
7990 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
7995 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
7997 Returns an SQL fragment to retreive the total unapplied payments for this
7998 customer, only considering invoices with date earlier than START_TIME, and
7999 optionally not later than END_TIME.
8001 Times are specified as SQL fragments or numeric
8002 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
8003 L<Date::Parse> for conversion functions. The empty string can be passed
8004 to disable that time constraint completely.
8006 Available options are:
8010 sub unapplied_payments_date_sql {
8011 my( $class, $start, $end, ) = @_;
8013 my $unapp_pay = FS::cust_pay->unapplied_sql;
8015 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
8016 'unapplied_date'=>1 );
8018 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
8021 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8023 Helper method for balance_date_sql; name (and usage) subject to change
8024 (suggestions welcome).
8026 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
8027 cust_refund, cust_credit or cust_pay).
8029 If TABLE is "cust_bill" or the unapplied_date option is true, only
8030 considers records with date earlier than START_TIME, and optionally not
8031 later than END_TIME .
8035 sub _money_table_where {
8036 my( $class, $table, $start, $end, %opt ) = @_;
8039 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
8040 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
8041 push @where, "$table._date <= $start" if defined($start) && length($start);
8042 push @where, "$table._date > $end" if defined($end) && length($end);
8044 push @where, @{$opt{'where'}} if $opt{'where'};
8045 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
8051 =item search_sql HASHREF
8055 Returns a qsearch hash expression to search for parameters specified in HREF.
8056 Valid parameters are
8064 =item cancelled_pkgs
8070 listref of start date, end date
8076 =item current_balance
8078 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
8082 =item flattened_pkgs
8091 my ($class, $params) = @_;
8102 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
8104 "cust_main.agentnum = $1";
8111 #prospect active inactive suspended cancelled
8112 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
8113 my $method = $params->{'status'}. '_sql';
8114 #push @where, $class->$method();
8115 push @where, FS::cust_main->$method();
8119 # parse cancelled package checkbox
8124 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
8125 unless $params->{'cancelled_pkgs'};
8128 # parse without census tract checkbox
8131 push @where, "(censustract = '' or censustract is null)"
8132 if $params->{'no_censustract'};
8138 foreach my $field (qw( signupdate )) {
8140 next unless exists($params->{$field});
8142 my($beginning, $ending) = @{$params->{$field}};
8145 "cust_main.$field IS NOT NULL",
8146 "cust_main.$field >= $beginning",
8147 "cust_main.$field <= $ending";
8149 $orderby ||= "ORDER BY cust_main.$field";
8157 my @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
8159 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )';
8166 #my $balance_sql = $class->balance_sql();
8167 my $balance_sql = FS::cust_main->balance_sql();
8169 push @where, map { s/current_balance/$balance_sql/; $_ }
8170 @{ $params->{'current_balance'} };
8176 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
8178 "cust_main.custbatch = '$1'";
8182 # setup queries, subs, etc. for the search
8185 $orderby ||= 'ORDER BY custnum';
8187 # here is the agent virtualization
8188 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
8190 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
8192 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
8194 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
8196 my $select = join(', ',
8197 'cust_main.custnum',
8198 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
8201 my(@extra_headers) = ();
8202 my(@extra_fields) = ();
8204 if ($params->{'flattened_pkgs'}) {
8206 if ($dbh->{Driver}->{Name} eq 'Pg') {
8208 $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";
8210 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
8211 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
8212 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
8214 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
8215 "omitting packing information from report.";
8218 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";
8220 my $sth = dbh->prepare($header_query) or die dbh->errstr;
8221 $sth->execute() or die $sth->errstr;
8222 my $headerrow = $sth->fetchrow_arrayref;
8223 my $headercount = $headerrow ? $headerrow->[0] : 0;
8224 while($headercount) {
8225 unshift @extra_headers, "Package ". $headercount;
8226 unshift @extra_fields, eval q!sub {my $c = shift;
8227 my @a = split '\|', $c->magic;
8228 my $p = $a[!.--$headercount. q!];
8236 'table' => 'cust_main',
8237 'select' => $select,
8239 'extra_sql' => $extra_sql,
8240 'order_by' => $orderby,
8241 'count_query' => $count_query,
8242 'extra_headers' => \@extra_headers,
8243 'extra_fields' => \@extra_fields,
8248 =item email_search_sql HASHREF
8252 Emails a notice to the specified customers.
8254 Valid parameters are those of the L<search_sql> method, plus the following:
8276 Optional job queue job for status updates.
8280 Returns an error message, or false for success.
8282 If an error occurs during any email, stops the enture send and returns that
8283 error. Presumably if you're getting SMTP errors aborting is better than
8284 retrying everything.
8288 sub email_search_sql {
8289 my($class, $params) = @_;
8291 my $from = delete $params->{from};
8292 my $subject = delete $params->{subject};
8293 my $html_body = delete $params->{html_body};
8294 my $text_body = delete $params->{text_body};
8296 my $job = delete $params->{'job'};
8298 $params->{'payby'} = [ split(/\0/, $params->{'payby'}) ]
8299 unless ref($params->{'payby'});
8301 my $sql_query = $class->search_sql($params);
8303 my $count_query = delete($sql_query->{'count_query'});
8304 my $count_sth = dbh->prepare($count_query)
8305 or die "Error preparing $count_query: ". dbh->errstr;
8307 or die "Error executing $count_query: ". $count_sth->errstr;
8308 my $count_arrayref = $count_sth->fetchrow_arrayref;
8309 my $num_cust = $count_arrayref->[0];
8311 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
8312 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
8315 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
8317 #eventually order+limit magic to reduce memory use?
8318 foreach my $cust_main ( qsearch($sql_query) ) {
8320 my $to = $cust_main->invoicing_list_emailonly_scalar;
8323 my $error = send_email(
8327 'subject' => $subject,
8328 'html_body' => $html_body,
8329 'text_body' => $text_body,
8332 return $error if $error;
8334 if ( $job ) { #progressbar foo
8336 if ( time - $min_sec > $last ) {
8337 my $error = $job->update_statustext(
8338 int( 100 * $num / $num_cust )
8340 die $error if $error;
8350 use Storable qw(thaw);
8353 sub process_email_search_sql {
8355 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
8357 my $param = thaw(decode_base64(shift));
8358 warn Dumper($param) if $DEBUG;
8360 $param->{'job'} = $job;
8362 $param->{'payby'} = [ split(/\0/, $param->{'payby'}) ]
8363 unless ref($param->{'payby'});
8365 my $error = FS::cust_main->email_search_sql( $param );
8366 die $error if $error;
8370 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
8372 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
8373 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
8374 appropriate ship_ field is also searched).
8376 Additional options are the same as FS::Record::qsearch
8381 my( $self, $fuzzy, $hash, @opt) = @_;
8386 check_and_rebuild_fuzzyfiles();
8387 foreach my $field ( keys %$fuzzy ) {
8389 my $all = $self->all_X($field);
8390 next unless scalar(@$all);
8393 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
8396 foreach ( keys %match ) {
8397 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
8398 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
8401 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
8404 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
8406 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
8414 Returns a masked version of the named field
8419 my ($self,$field) = @_;
8423 'x'x(length($self->getfield($field))-4).
8424 substr($self->getfield($field), (length($self->getfield($field))-4));
8434 =item smart_search OPTION => VALUE ...
8436 Accepts the following options: I<search>, the string to search for. The string
8437 will be searched for as a customer number, phone number, name or company name,
8438 as an exact, or, in some cases, a substring or fuzzy match (see the source code
8439 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
8440 skip fuzzy matching when an exact match is found.
8442 Any additional options are treated as an additional qualifier on the search
8445 Returns a (possibly empty) array of FS::cust_main objects.
8452 #here is the agent virtualization
8453 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8457 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
8458 my $search = delete $options{'search'};
8459 ( my $alphanum_search = $search ) =~ s/\W//g;
8461 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
8463 #false laziness w/Record::ut_phone
8464 my $phonen = "$1-$2-$3";
8465 $phonen .= " x$4" if $4;
8467 push @cust_main, qsearch( {
8468 'table' => 'cust_main',
8469 'hashref' => { %options },
8470 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8472 join(' OR ', map "$_ = '$phonen'",
8473 qw( daytime night fax
8474 ship_daytime ship_night ship_fax )
8477 " AND $agentnums_sql", #agent virtualization
8480 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
8481 #try looking for matches with extensions unless one was specified
8483 push @cust_main, qsearch( {
8484 'table' => 'cust_main',
8485 'hashref' => { %options },
8486 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8488 join(' OR ', map "$_ LIKE '$phonen\%'",
8490 ship_daytime ship_night )
8493 " AND $agentnums_sql", #agent virtualization
8498 # custnum search (also try agent_custid), with some tweaking options if your
8499 # legacy cust "numbers" have letters
8502 if ( $search =~ /^\s*(\d+)\s*$/
8503 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
8504 && $search =~ /^\s*(\w\w?\d+)\s*$/
8511 if ( $num <= 2147483647 ) { #need a bigint custnum? wow.
8512 push @cust_main, qsearch( {
8513 'table' => 'cust_main',
8514 'hashref' => { 'custnum' => $num, %options },
8515 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8519 push @cust_main, qsearch( {
8520 'table' => 'cust_main',
8521 'hashref' => { 'agent_custid' => $num, %options },
8522 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8525 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
8527 my($company, $last, $first) = ( $1, $2, $3 );
8529 # "Company (Last, First)"
8530 #this is probably something a browser remembered,
8531 #so just do an exact search
8533 foreach my $prefix ( '', 'ship_' ) {
8534 push @cust_main, qsearch( {
8535 'table' => 'cust_main',
8536 'hashref' => { $prefix.'first' => $first,
8537 $prefix.'last' => $last,
8538 $prefix.'company' => $company,
8541 'extra_sql' => " AND $agentnums_sql",
8545 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
8546 # try (ship_){last,company}
8550 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
8551 # # full strings the browser remembers won't work
8552 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
8554 use Lingua::EN::NameParse;
8555 my $NameParse = new Lingua::EN::NameParse(
8557 allow_reversed => 1,
8560 my($last, $first) = ( '', '' );
8561 #maybe disable this too and just rely on NameParse?
8562 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
8564 ($last, $first) = ( $1, $2 );
8566 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
8567 } elsif ( ! $NameParse->parse($value) ) {
8569 my %name = $NameParse->components;
8570 $first = $name{'given_name_1'};
8571 $last = $name{'surname_1'};
8575 if ( $first && $last ) {
8577 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
8580 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8582 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
8583 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
8586 push @cust_main, qsearch( {
8587 'table' => 'cust_main',
8588 'hashref' => \%options,
8589 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8592 # or it just be something that was typed in... (try that in a sec)
8596 my $q_value = dbh->quote($value);
8599 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8600 $sql .= " ( LOWER(last) = $q_value
8601 OR LOWER(company) = $q_value
8602 OR LOWER(ship_last) = $q_value
8603 OR LOWER(ship_company) = $q_value
8606 push @cust_main, qsearch( {
8607 'table' => 'cust_main',
8608 'hashref' => \%options,
8609 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8612 #no exact match, trying substring/fuzzy
8613 #always do substring & fuzzy (unless they're explicity config'ed off)
8614 #getting complaints searches are not returning enough
8615 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
8617 #still some false laziness w/search_sql (was search/cust_main.cgi)
8622 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
8623 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
8626 if ( $first && $last ) {
8629 { 'first' => { op=>'ILIKE', value=>"%$first%" },
8630 'last' => { op=>'ILIKE', value=>"%$last%" },
8632 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
8633 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
8640 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
8641 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
8645 foreach my $hashref ( @hashrefs ) {
8647 push @cust_main, qsearch( {
8648 'table' => 'cust_main',
8649 'hashref' => { %$hashref,
8652 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
8661 " AND $agentnums_sql", #extra_sql #agent virtualization
8664 if ( $first && $last ) {
8665 push @cust_main, FS::cust_main->fuzzy_search(
8666 { 'last' => $last, #fuzzy hashref
8667 'first' => $first }, #
8671 foreach my $field ( 'last', 'company' ) {
8673 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
8680 #eliminate duplicates
8682 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8690 Accepts the following options: I<email>, the email address to search for. The
8691 email address will be searched for as an email invoice destination and as an
8694 #Any additional options are treated as an additional qualifier on the search
8695 #(i.e. I<agentnum>).
8697 Returns a (possibly empty) array of FS::cust_main objects (but usually just
8707 my $email = delete $options{'email'};
8709 #we're only being used by RT at the moment... no agent virtualization yet
8710 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8714 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
8716 my ( $user, $domain ) = ( $1, $2 );
8718 warn "$me smart_search: searching for $user in domain $domain"
8724 'table' => 'cust_main_invoice',
8725 'hashref' => { 'dest' => $email },
8732 map $_->cust_svc->cust_pkg,
8734 'table' => 'svc_acct',
8735 'hashref' => { 'username' => $user, },
8737 'AND ( SELECT domain FROM svc_domain
8738 WHERE svc_acct.domsvc = svc_domain.svcnum
8739 ) = '. dbh->quote($domain),
8745 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8747 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
8754 =item check_and_rebuild_fuzzyfiles
8758 use vars qw(@fuzzyfields);
8759 @fuzzyfields = ( 'last', 'first', 'company' );
8761 sub check_and_rebuild_fuzzyfiles {
8762 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8763 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
8766 =item rebuild_fuzzyfiles
8770 sub rebuild_fuzzyfiles {
8772 use Fcntl qw(:flock);
8774 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8775 mkdir $dir, 0700 unless -d $dir;
8777 foreach my $fuzzy ( @fuzzyfields ) {
8779 open(LOCK,">>$dir/cust_main.$fuzzy")
8780 or die "can't open $dir/cust_main.$fuzzy: $!";
8782 or die "can't lock $dir/cust_main.$fuzzy: $!";
8784 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
8785 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
8787 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
8788 my $sth = dbh->prepare("SELECT $field FROM cust_main".
8789 " WHERE $field != '' AND $field IS NOT NULL");
8790 $sth->execute or die $sth->errstr;
8792 while ( my $row = $sth->fetchrow_arrayref ) {
8793 print CACHE $row->[0]. "\n";
8798 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
8800 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
8811 my( $self, $field ) = @_;
8812 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8813 open(CACHE,"<$dir/cust_main.$field")
8814 or die "can't open $dir/cust_main.$field: $!";
8815 my @array = map { chomp; $_; } <CACHE>;
8820 =item append_fuzzyfiles LASTNAME COMPANY
8824 sub append_fuzzyfiles {
8825 #my( $first, $last, $company ) = @_;
8827 &check_and_rebuild_fuzzyfiles;
8829 use Fcntl qw(:flock);
8831 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8833 foreach my $field (qw( first last company )) {
8838 open(CACHE,">>$dir/cust_main.$field")
8839 or die "can't open $dir/cust_main.$field: $!";
8840 flock(CACHE,LOCK_EX)
8841 or die "can't lock $dir/cust_main.$field: $!";
8843 print CACHE "$value\n";
8845 flock(CACHE,LOCK_UN)
8846 or die "can't unlock $dir/cust_main.$field: $!";
8861 #warn join('-',keys %$param);
8862 my $fh = $param->{filehandle};
8863 my @fields = @{$param->{fields}};
8865 eval "use Text::CSV_XS;";
8868 my $csv = new Text::CSV_XS;
8875 local $SIG{HUP} = 'IGNORE';
8876 local $SIG{INT} = 'IGNORE';
8877 local $SIG{QUIT} = 'IGNORE';
8878 local $SIG{TERM} = 'IGNORE';
8879 local $SIG{TSTP} = 'IGNORE';
8880 local $SIG{PIPE} = 'IGNORE';
8882 my $oldAutoCommit = $FS::UID::AutoCommit;
8883 local $FS::UID::AutoCommit = 0;
8886 #while ( $columns = $csv->getline($fh) ) {
8888 while ( defined($line=<$fh>) ) {
8890 $csv->parse($line) or do {
8891 $dbh->rollback if $oldAutoCommit;
8892 return "can't parse: ". $csv->error_input();
8895 my @columns = $csv->fields();
8896 #warn join('-',@columns);
8899 foreach my $field ( @fields ) {
8900 $row{$field} = shift @columns;
8903 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
8904 unless ( $cust_main ) {
8905 $dbh->rollback if $oldAutoCommit;
8906 return "unknown custnum $row{'custnum'}";
8909 if ( $row{'amount'} > 0 ) {
8910 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
8912 $dbh->rollback if $oldAutoCommit;
8916 } elsif ( $row{'amount'} < 0 ) {
8917 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
8920 $dbh->rollback if $oldAutoCommit;
8930 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
8932 return "Empty file!" unless $imported;
8938 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
8940 Sends a templated email notification to the customer (see L<Text::Template>).
8942 OPTIONS is a hash and may include
8944 I<from> - the email sender (default is invoice_from)
8946 I<to> - comma-separated scalar or arrayref of recipients
8947 (default is invoicing_list)
8949 I<subject> - The subject line of the sent email notification
8950 (default is "Notice from company_name")
8952 I<extra_fields> - a hashref of name/value pairs which will be substituted
8955 The following variables are vavailable in the template.
8957 I<$first> - the customer first name
8958 I<$last> - the customer last name
8959 I<$company> - the customer company
8960 I<$payby> - a description of the method of payment for the customer
8961 # would be nice to use FS::payby::shortname
8962 I<$payinfo> - the account information used to collect for this customer
8963 I<$expdate> - the expiration of the customer payment in seconds from epoch
8968 my ($self, $template, %options) = @_;
8970 return unless $conf->exists($template);
8972 my $from = $conf->config('invoice_from', $self->agentnum)
8973 if $conf->exists('invoice_from', $self->agentnum);
8974 $from = $options{from} if exists($options{from});
8976 my $to = join(',', $self->invoicing_list_emailonly);
8977 $to = $options{to} if exists($options{to});
8979 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
8980 if $conf->exists('company_name', $self->agentnum);
8981 $subject = $options{subject} if exists($options{subject});
8983 my $notify_template = new Text::Template (TYPE => 'ARRAY',
8984 SOURCE => [ map "$_\n",
8985 $conf->config($template)]
8987 or die "can't create new Text::Template object: Text::Template::ERROR";
8988 $notify_template->compile()
8989 or die "can't compile template: Text::Template::ERROR";
8991 $FS::notify_template::_template::company_name =
8992 $conf->config('company_name', $self->agentnum);
8993 $FS::notify_template::_template::company_address =
8994 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
8996 my $paydate = $self->paydate || '2037-12-31';
8997 $FS::notify_template::_template::first = $self->first;
8998 $FS::notify_template::_template::last = $self->last;
8999 $FS::notify_template::_template::company = $self->company;
9000 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
9001 my $payby = $self->payby;
9002 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9003 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9005 #credit cards expire at the end of the month/year of their exp date
9006 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9007 $FS::notify_template::_template::payby = 'credit card';
9008 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9009 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9011 }elsif ($payby eq 'COMP') {
9012 $FS::notify_template::_template::payby = 'complimentary account';
9014 $FS::notify_template::_template::payby = 'current method';
9016 $FS::notify_template::_template::expdate = $expire_time;
9018 for (keys %{$options{extra_fields}}){
9020 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
9023 send_email(from => $from,
9025 subject => $subject,
9026 body => $notify_template->fill_in( PACKAGE =>
9027 'FS::notify_template::_template' ),
9032 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9034 Generates a templated notification to the customer (see L<Text::Template>).
9036 OPTIONS is a hash and may include
9038 I<extra_fields> - a hashref of name/value pairs which will be substituted
9039 into the template. These values may override values mentioned below
9040 and those from the customer record.
9042 The following variables are available in the template instead of or in addition
9043 to the fields of the customer record.
9045 I<$payby> - a description of the method of payment for the customer
9046 # would be nice to use FS::payby::shortname
9047 I<$payinfo> - the masked account information used to collect for this customer
9048 I<$expdate> - the expiration of the customer payment method in seconds from epoch
9049 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
9053 sub generate_letter {
9054 my ($self, $template, %options) = @_;
9056 return unless $conf->exists($template);
9058 my $letter_template = new Text::Template
9060 SOURCE => [ map "$_\n", $conf->config($template)],
9061 DELIMITERS => [ '[@--', '--@]' ],
9063 or die "can't create new Text::Template object: Text::Template::ERROR";
9065 $letter_template->compile()
9066 or die "can't compile template: Text::Template::ERROR";
9068 my %letter_data = map { $_ => $self->$_ } $self->fields;
9069 $letter_data{payinfo} = $self->mask_payinfo;
9071 #my $paydate = $self->paydate || '2037-12-31';
9072 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
9074 my $payby = $self->payby;
9075 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9076 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9078 #credit cards expire at the end of the month/year of their exp date
9079 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9080 $letter_data{payby} = 'credit card';
9081 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9082 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9084 }elsif ($payby eq 'COMP') {
9085 $letter_data{payby} = 'complimentary account';
9087 $letter_data{payby} = 'current method';
9089 $letter_data{expdate} = $expire_time;
9091 for (keys %{$options{extra_fields}}){
9092 $letter_data{$_} = $options{extra_fields}->{$_};
9095 unless(exists($letter_data{returnaddress})){
9096 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
9097 $self->agent_template)
9099 if ( length($retadd) ) {
9100 $letter_data{returnaddress} = $retadd;
9101 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
9102 $letter_data{returnaddress} =
9103 join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
9104 $conf->config('company_address', $self->agentnum)
9107 $letter_data{returnaddress} = '~';
9111 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
9113 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
9115 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
9116 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
9120 ) or die "can't open temp file: $!\n";
9122 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
9124 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
9128 =item print_ps TEMPLATE
9130 Returns an postscript letter filled in from TEMPLATE, as a scalar.
9136 my $file = $self->generate_letter(@_);
9137 FS::Misc::generate_ps($file);
9140 =item print TEMPLATE
9142 Prints the filled in template.
9144 TEMPLATE is the name of a L<Text::Template> to fill in and print.
9148 sub queueable_print {
9151 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
9152 or die "invalid customer number: " . $opt{custvnum};
9154 my $error = $self->print( $opt{template} );
9155 die $error if $error;
9159 my ($self, $template) = (shift, shift);
9160 do_print [ $self->print_ps($template) ];
9163 #these three subs should just go away once agent stuff is all config overrides
9165 sub agent_template {
9167 $self->_agent_plandata('agent_templatename');
9170 sub agent_invoice_from {
9172 $self->_agent_plandata('agent_invoice_from');
9175 sub _agent_plandata {
9176 my( $self, $option ) = @_;
9178 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
9179 #agent-specific Conf
9181 use FS::part_event::Condition;
9183 my $agentnum = $self->agentnum;
9186 if ( driver_name =~ /^Pg/i ) {
9188 } elsif ( driver_name =~ /^mysql/i ) {
9191 die "don't know how to use regular expressions in ". driver_name. " databases";
9194 my $part_event_option =
9196 'select' => 'part_event_option.*',
9197 'table' => 'part_event_option',
9199 LEFT JOIN part_event USING ( eventpart )
9200 LEFT JOIN part_event_option AS peo_agentnum
9201 ON ( part_event.eventpart = peo_agentnum.eventpart
9202 AND peo_agentnum.optionname = 'agentnum'
9203 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
9205 LEFT JOIN part_event_condition
9206 ON ( part_event.eventpart = part_event_condition.eventpart
9207 AND part_event_condition.conditionname = 'cust_bill_age'
9209 LEFT JOIN part_event_condition_option
9210 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
9211 AND part_event_condition_option.optionname = 'age'
9214 #'hashref' => { 'optionname' => $option },
9215 #'hashref' => { 'part_event_option.optionname' => $option },
9217 " WHERE part_event_option.optionname = ". dbh->quote($option).
9218 " AND action = 'cust_bill_send_agent' ".
9219 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
9220 " AND peo_agentnum.optionname = 'agentnum' ".
9221 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
9223 CASE WHEN part_event_condition_option.optionname IS NULL
9225 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
9227 , part_event.weight".
9231 unless ( $part_event_option ) {
9232 return $self->agent->invoice_template || ''
9233 if $option eq 'agent_templatename';
9237 $part_event_option->optionvalue;
9242 ## actual sub, not a method, designed to be called from the queue.
9243 ## sets up the customer, and calls the bill_and_collect
9244 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
9245 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
9246 $cust_main->bill_and_collect(
9251 sub _upgrade_data { #class method
9252 my ($class, %opts) = @_;
9254 my $sql = 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL';
9255 my $sth = dbh->prepare($sql) or die dbh->errstr;
9256 $sth->execute or die $sth->errstr;
9266 The delete method should possibly take an FS::cust_main object reference
9267 instead of a scalar customer number.
9269 Bill and collect options should probably be passed as references instead of a
9272 There should probably be a configuration file with a list of allowed credit
9275 No multiple currency support (probably a larger project than just this module).
9277 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
9279 Birthdates rely on negative epoch values.
9281 The payby for card/check batches is broken. With mixed batching, bad
9284 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
9288 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
9289 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
9290 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.