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 =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1849 ( $m, $y ) = ( $3, "20$2" );
1851 return "Illegal expiration date: ". $self->paydate;
1853 $self->paydate("$y-$m-01");
1854 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1855 return gettext('expired_card')
1857 && !$ignore_expired_card
1858 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1861 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1862 ( ! $conf->exists('require_cardname')
1863 || $self->payby !~ /^(CARD|DCRD)$/ )
1865 $self->payname( $self->first. " ". $self->getfield('last') );
1867 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1868 or return gettext('illegal_name'). " payname: ". $self->payname;
1872 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
1873 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1877 $self->otaker(getotaker) unless $self->otaker;
1879 warn "$me check AFTER: \n". $self->_dump
1882 $self->SUPER::check;
1887 Returns a list of fields which have ship_ duplicates.
1892 qw( last first company
1893 address1 address2 city county state zip country
1898 =item has_ship_address
1900 Returns true if this customer record has a separate shipping address.
1904 sub has_ship_address {
1906 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
1909 =item all_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
1911 Returns all packages (see L<FS::cust_pkg>) for this customer.
1917 my $extra_qsearch = ref($_[0]) ? shift : {};
1919 return $self->num_pkgs unless wantarray || keys(%$extra_qsearch);
1922 if ( $self->{'_pkgnum'} ) {
1923 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1925 @cust_pkg = $self->_cust_pkg($extra_qsearch);
1928 sort sort_packages @cust_pkg;
1933 Synonym for B<all_pkgs>.
1938 shift->all_pkgs(@_);
1943 Returns all locations (see L<FS::cust_location>) for this customer.
1949 qsearch('cust_location', { 'custnum' => $self->custnum } );
1952 =item ncancelled_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
1954 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1958 sub ncancelled_pkgs {
1960 my $extra_qsearch = ref($_[0]) ? shift : {};
1962 return $self->num_ncancelled_pkgs unless wantarray;
1965 if ( $self->{'_pkgnum'} ) {
1967 warn "$me ncancelled_pkgs: returning cached objects"
1970 @cust_pkg = grep { ! $_->getfield('cancel') }
1971 values %{ $self->{'_pkgnum'}->cache };
1975 warn "$me ncancelled_pkgs: searching for packages with custnum ".
1976 $self->custnum. "\n"
1979 $extra_qsearch->{'extra_sql'} .= ' AND ( cancel IS NULL OR cancel = 0 ) ';
1981 @cust_pkg = $self->_cust_pkg($extra_qsearch);
1985 sort sort_packages @cust_pkg;
1991 my $extra_qsearch = ref($_[0]) ? shift : {};
1993 $extra_qsearch->{'select'} ||= '*';
1994 $extra_qsearch->{'select'} .=
1995 ',( SELECT COUNT(*) FROM cust_svc WHERE cust_pkg.pkgnum = cust_svc.pkgnum )
1999 $_->{'_num_cust_svc'} = $_->get('_num_cust_svc');
2004 'table' => 'cust_pkg',
2005 'hashref' => { 'custnum' => $self->custnum },
2010 # This should be generalized to use config options to determine order.
2013 if ( $a->get('cancel') xor $b->get('cancel') ) {
2014 return -1 if $b->get('cancel');
2015 return 1 if $a->get('cancel');
2016 #shouldn't get here...
2019 my $a_num_cust_svc = $a->num_cust_svc;
2020 my $b_num_cust_svc = $b->num_cust_svc;
2021 return 0 if !$a_num_cust_svc && !$b_num_cust_svc;
2022 return -1 if $a_num_cust_svc && !$b_num_cust_svc;
2023 return 1 if !$a_num_cust_svc && $b_num_cust_svc;
2024 my @a_cust_svc = $a->cust_svc;
2025 my @b_cust_svc = $b->cust_svc;
2026 $a_cust_svc[0]->svc_x->label cmp $b_cust_svc[0]->svc_x->label;
2031 =item suspended_pkgs
2033 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
2037 sub suspended_pkgs {
2039 grep { $_->susp } $self->ncancelled_pkgs;
2042 =item unflagged_suspended_pkgs
2044 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
2045 customer (thouse packages without the `manual_flag' set).
2049 sub unflagged_suspended_pkgs {
2051 return $self->suspended_pkgs
2052 unless dbdef->table('cust_pkg')->column('manual_flag');
2053 grep { ! $_->manual_flag } $self->suspended_pkgs;
2056 =item unsuspended_pkgs
2058 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
2063 sub unsuspended_pkgs {
2065 grep { ! $_->susp } $self->ncancelled_pkgs;
2068 =item next_bill_date
2070 Returns the next date this customer will be billed, as a UNIX timestamp, or
2071 undef if no active package has a next bill date.
2075 sub next_bill_date {
2077 min( map $_->get('bill'), grep $_->get('bill'), $self->unsuspended_pkgs );
2080 =item num_cancelled_pkgs
2082 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
2087 sub num_cancelled_pkgs {
2088 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
2091 sub num_ncancelled_pkgs {
2092 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
2096 my( $self ) = shift;
2097 my $sql = scalar(@_) ? shift : '';
2098 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
2099 my $sth = dbh->prepare(
2100 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
2101 ) or die dbh->errstr;
2102 $sth->execute($self->custnum) or die $sth->errstr;
2103 $sth->fetchrow_arrayref->[0];
2108 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2109 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2110 on success or a list of errors.
2116 grep { $_->unsuspend } $self->suspended_pkgs;
2121 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2123 Returns a list: an empty list on success or a list of errors.
2129 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2132 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2134 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2135 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2136 of a list of pkgparts; the hashref has the following keys:
2140 =item pkgparts - listref of pkgparts
2142 =item (other options are passed to the suspend method)
2147 Returns a list: an empty list on success or a list of errors.
2151 sub suspend_if_pkgpart {
2153 my (@pkgparts, %opt);
2154 if (ref($_[0]) eq 'HASH'){
2155 @pkgparts = @{$_[0]{pkgparts}};
2160 grep { $_->suspend(%opt) }
2161 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2162 $self->unsuspended_pkgs;
2165 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2167 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2168 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2169 instead of a list of pkgparts; the hashref has the following keys:
2173 =item pkgparts - listref of pkgparts
2175 =item (other options are passed to the suspend method)
2179 Returns a list: an empty list on success or a list of errors.
2183 sub suspend_unless_pkgpart {
2185 my (@pkgparts, %opt);
2186 if (ref($_[0]) eq 'HASH'){
2187 @pkgparts = @{$_[0]{pkgparts}};
2192 grep { $_->suspend(%opt) }
2193 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2194 $self->unsuspended_pkgs;
2197 =item cancel [ OPTION => VALUE ... ]
2199 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2201 Available options are:
2205 =item quiet - can be set true to supress email cancellation notices.
2207 =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.
2209 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2211 =item nobill - can be set true to skip billing if it might otherwise be done.
2215 Always returns a list: an empty list on success or a list of errors.
2219 # nb that dates are not specified as valid options to this method
2222 my( $self, %opt ) = @_;
2224 warn "$me cancel called on customer ". $self->custnum. " with options ".
2225 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2228 return ( 'access denied' )
2229 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2231 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2233 #should try decryption (we might have the private key)
2234 # and if not maybe queue a job for the server that does?
2235 return ( "Can't (yet) ban encrypted credit cards" )
2236 if $self->is_encrypted($self->payinfo);
2238 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
2239 my $error = $ban->insert;
2240 return ( $error ) if $error;
2244 my @pkgs = $self->ncancelled_pkgs;
2246 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2248 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2249 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2253 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2254 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2257 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2260 sub _banned_pay_hashref {
2271 'payby' => $payby2ban{$self->payby},
2272 'payinfo' => md5_base64($self->payinfo),
2273 #don't ever *search* on reason! #'reason' =>
2279 Returns all notes (see L<FS::cust_main_note>) for this customer.
2286 qsearch( 'cust_main_note',
2287 { 'custnum' => $self->custnum },
2289 'ORDER BY _DATE DESC'
2295 Returns the agent (see L<FS::agent>) for this customer.
2301 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2304 =item bill_and_collect
2306 Cancels and suspends any packages due, generates bills, applies payments and
2309 Warns on errors (Does not currently: If there is an error, returns the error, otherwise returns false.)
2311 Options are passed as name-value pairs. Currently available options are:
2317 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:
2321 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2325 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.
2329 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2333 If set true, re-charges setup fees.
2337 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)
2341 Options are passed to the B<bill> and B<collect> methods verbatim, so all
2342 options of those methods are also available.
2346 sub bill_and_collect {
2347 my( $self, %options ) = @_;
2349 #$options{actual_time} not $options{time} because freeside-daily -d is for
2350 #pre-printing invoices
2351 $self->cancel_expired_pkgs( $options{actual_time} );
2352 $self->suspend_adjourned_pkgs( $options{actual_time} );
2354 my $error = $self->bill( %options );
2355 warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
2357 $self->apply_payments_and_credits;
2359 unless ( $conf->exists('cancelled_cust-noevents')
2360 && ! $self->num_ncancelled_pkgs
2363 $error = $self->collect( %options );
2364 warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
2370 sub cancel_expired_pkgs {
2371 my ( $self, $time ) = @_;
2373 my @cancel_pkgs = $self->ncancelled_pkgs( {
2374 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
2377 foreach my $cust_pkg ( @cancel_pkgs ) {
2378 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
2379 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
2380 'reason_otaker' => $cpr->otaker
2384 warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
2385 " for custnum ". $self->custnum. ": $error"
2391 sub suspend_adjourned_pkgs {
2392 my ( $self, $time ) = @_;
2394 my @susp_pkgs = $self->ncancelled_pkgs( {
2396 " AND ( susp IS NULL OR susp = 0 )
2397 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
2398 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
2403 #only because there's no SQL test for is_prepaid :/
2405 grep { ( $_->part_pkg->is_prepaid
2410 && $_->adjourn <= $time
2416 foreach my $cust_pkg ( @susp_pkgs ) {
2417 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
2418 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
2419 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
2420 'reason_otaker' => $cpr->otaker
2425 warn "Error suspending package ". $cust_pkg->pkgnum.
2426 " for custnum ". $self->custnum. ": $error"
2434 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
2435 conjunction with the collect method by calling B<bill_and_collect>.
2437 If there is an error, returns the error, otherwise returns false.
2439 Options are passed as name-value pairs. Currently available options are:
2445 If set true, re-charges setup fees.
2449 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:
2453 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2457 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2459 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2463 A hashref of pkgparts to exclude from this billing run.
2467 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.
2471 This boolean value informs the us that the package is being cancelled. This
2472 typically might mean not charging the normal recurring fee but only usage
2473 fees since the last billing. Setup charges may be charged. Not all package
2474 plans support this feature (they tend to charge 0).
2481 my( $self, %options ) = @_;
2482 return '' if $self->payby eq 'COMP';
2483 warn "$me bill customer ". $self->custnum. "\n"
2486 my $time = $options{'time'} || time;
2487 my $invoice_time = $options{'invoice_time'} || $time;
2489 $options{'not_pkgpart'} ||= {};
2492 local $SIG{HUP} = 'IGNORE';
2493 local $SIG{INT} = 'IGNORE';
2494 local $SIG{QUIT} = 'IGNORE';
2495 local $SIG{TERM} = 'IGNORE';
2496 local $SIG{TSTP} = 'IGNORE';
2497 local $SIG{PIPE} = 'IGNORE';
2499 my $oldAutoCommit = $FS::UID::AutoCommit;
2500 local $FS::UID::AutoCommit = 0;
2503 $self->select_for_update; #mutex
2505 my @cust_bill_pkg = ();
2508 # find the packages which are due for billing, find out how much they are
2509 # & generate invoice database.
2512 my( $total_setup, $total_recur, $postal_charge ) = ( 0, 0, 0 );
2514 my @precommit_hooks = ();
2516 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
2517 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
2519 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
2521 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2523 #? to avoid use of uninitialized value errors... ?
2524 $cust_pkg->setfield('bill', '')
2525 unless defined($cust_pkg->bill);
2527 #my $part_pkg = $cust_pkg->part_pkg;
2529 my $real_pkgpart = $cust_pkg->pkgpart;
2530 my %hash = $cust_pkg->hash;
2532 foreach my $part_pkg ( $cust_pkg->part_pkg->self_and_bill_linked ) {
2534 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
2537 $self->_make_lines( 'part_pkg' => $part_pkg,
2538 'cust_pkg' => $cust_pkg,
2539 'precommit_hooks' => \@precommit_hooks,
2540 'line_items' => \@cust_bill_pkg,
2541 'setup' => \$total_setup,
2542 'recur' => \$total_recur,
2543 'tax_matrix' => \%taxlisthash,
2545 'real_pkgpart' => $real_pkgpart,
2546 'options' => \%options,
2549 $dbh->rollback if $oldAutoCommit;
2553 } #foreach my $part_pkg
2555 } #foreach my $cust_pkg
2557 unless ( @cust_bill_pkg ) { #don't create an invoice w/o line items
2558 #but do commit any package date cycling that happened
2559 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2563 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
2564 !$conf->exists('postal_invoice-recurring_only')
2568 my $postal_pkg = $self->charge_postal_fee();
2569 if ( $postal_pkg && !ref( $postal_pkg ) ) {
2571 $dbh->rollback if $oldAutoCommit;
2572 return "can't charge postal invoice fee for customer ".
2573 $self->custnum. ": $postal_pkg";
2575 } elsif ( $postal_pkg ) {
2577 my $real_pkgpart = $postal_pkg->pkgpart;
2578 foreach my $part_pkg ( $postal_pkg->part_pkg->self_and_bill_linked ) {
2579 my %postal_options = %options;
2580 delete $postal_options{cancel};
2582 $self->_make_lines( 'part_pkg' => $part_pkg,
2583 'cust_pkg' => $postal_pkg,
2584 'precommit_hooks' => \@precommit_hooks,
2585 'line_items' => \@cust_bill_pkg,
2586 'setup' => \$total_setup,
2587 'recur' => \$total_recur,
2588 'tax_matrix' => \%taxlisthash,
2590 'real_pkgpart' => $real_pkgpart,
2591 'options' => \%postal_options,
2594 $dbh->rollback if $oldAutoCommit;
2603 warn "having a look at the taxes we found...\n" if $DEBUG > 2;
2605 # keys are tax names (as printed on invoices / itemdesc )
2606 # values are listrefs of taxlisthash keys (internal identifiers)
2609 # keys are taxlisthash keys (internal identifiers)
2610 # values are (cumulative) amounts
2613 # keys are taxlisthash keys (internal identifiers)
2614 # values are listrefs of cust_bill_pkg_tax_location hashrefs
2615 my %tax_location = ();
2617 # keys are taxlisthash keys (internal identifiers)
2618 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
2619 my %tax_rate_location = ();
2621 foreach my $tax ( keys %taxlisthash ) {
2622 my $tax_object = shift @{ $taxlisthash{$tax} };
2623 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
2624 warn " ". join('/', @{ $taxlisthash{$tax} } ). "\n" if $DEBUG > 2;
2625 my $hashref_or_error =
2626 $tax_object->taxline( $taxlisthash{$tax},
2627 'custnum' => $self->custnum,
2628 'invoice_time' => $invoice_time
2630 unless ( ref($hashref_or_error) ) {
2631 $dbh->rollback if $oldAutoCommit;
2632 return $hashref_or_error;
2634 unshift @{ $taxlisthash{$tax} }, $tax_object;
2636 my $name = $hashref_or_error->{'name'};
2637 my $amount = $hashref_or_error->{'amount'};
2639 #warn "adding $amount as $name\n";
2640 $taxname{ $name } ||= [];
2641 push @{ $taxname{ $name } }, $tax;
2643 $tax{ $tax } += $amount;
2645 $tax_location{ $tax } ||= [];
2646 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
2647 push @{ $tax_location{ $tax } },
2649 'taxnum' => $tax_object->taxnum,
2650 'taxtype' => ref($tax_object),
2651 'pkgnum' => $tax_object->get('pkgnum'),
2652 'locationnum' => $tax_object->get('locationnum'),
2653 'amount' => sprintf('%.2f', $amount ),
2657 $tax_rate_location{ $tax } ||= [];
2658 if ( ref($tax_object) eq 'FS::tax_rate' ) {
2659 my $taxratelocationnum =
2660 $tax_object->tax_rate_location->taxratelocationnum;
2661 push @{ $tax_rate_location{ $tax } },
2663 'taxnum' => $tax_object->taxnum,
2664 'taxtype' => ref($tax_object),
2665 'amount' => sprintf('%.2f', $amount ),
2666 'locationtaxid' => $tax_object->location,
2667 'taxratelocationnum' => $taxratelocationnum,
2673 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
2674 my %packagemap = map { $_->pkgnum => $_ } @cust_bill_pkg;
2675 foreach my $tax ( keys %taxlisthash ) {
2676 foreach ( @{ $taxlisthash{$tax} }[1 ... scalar(@{ $taxlisthash{$tax} })] ) {
2677 next unless ref($_) eq 'FS::cust_bill_pkg';
2679 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
2680 splice( @{ $_->_cust_tax_exempt_pkg } );
2684 #consolidate and create tax line items
2685 warn "consolidating and generating...\n" if $DEBUG > 2;
2686 foreach my $taxname ( keys %taxname ) {
2689 my @cust_bill_pkg_tax_location = ();
2690 my @cust_bill_pkg_tax_rate_location = ();
2691 warn "adding $taxname\n" if $DEBUG > 1;
2692 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
2693 next if $seen{$taxitem}++;
2694 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
2695 $tax += $tax{$taxitem};
2696 push @cust_bill_pkg_tax_location,
2697 map { new FS::cust_bill_pkg_tax_location $_ }
2698 @{ $tax_location{ $taxitem } };
2699 push @cust_bill_pkg_tax_rate_location,
2700 map { new FS::cust_bill_pkg_tax_rate_location $_ }
2701 @{ $tax_rate_location{ $taxitem } };
2705 $tax = sprintf('%.2f', $tax );
2706 $total_setup = sprintf('%.2f', $total_setup+$tax );
2708 push @cust_bill_pkg, new FS::cust_bill_pkg {
2714 'itemdesc' => $taxname,
2715 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2716 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
2721 #add tax adjustments
2722 warn "adding tax adjustments...\n" if $DEBUG > 2;
2723 foreach my $cust_tax_adjustment (
2724 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
2730 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
2731 $total_setup = sprintf('%.2f', $total_setup+$tax );
2733 my $itemdesc = $cust_tax_adjustment->taxname;
2734 $itemdesc = '' if $itemdesc eq 'Tax';
2736 push @cust_bill_pkg, new FS::cust_bill_pkg {
2742 'itemdesc' => $itemdesc,
2743 'itemcomment' => $cust_tax_adjustment->comment,
2744 'cust_tax_adjustment' => $cust_tax_adjustment,
2745 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2750 my $charged = sprintf('%.2f', $total_setup + $total_recur );
2752 #create the new invoice
2753 my $cust_bill = new FS::cust_bill ( {
2754 'custnum' => $self->custnum,
2755 '_date' => ( $invoice_time ),
2756 'charged' => $charged,
2758 my $error = $cust_bill->insert;
2760 $dbh->rollback if $oldAutoCommit;
2761 return "can't create invoice for customer #". $self->custnum. ": $error";
2764 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
2765 $cust_bill_pkg->invnum($cust_bill->invnum);
2766 my $error = $cust_bill_pkg->insert;
2768 $dbh->rollback if $oldAutoCommit;
2769 return "can't create invoice line item: $error";
2774 foreach my $hook ( @precommit_hooks ) {
2776 &{$hook}; #($self) ?
2779 $dbh->rollback if $oldAutoCommit;
2780 return "$@ running precommit hook $hook\n";
2784 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2790 my ($self, %params) = @_;
2792 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
2793 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
2794 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
2795 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
2796 my $total_setup = $params{setup} or die "no setup accumulator specified";
2797 my $total_recur = $params{recur} or die "no recur accumulator specified";
2798 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
2799 my $time = $params{'time'} or die "no time specified";
2800 my (%options) = %{$params{options}};
2803 my $real_pkgpart = $params{real_pkgpart};
2804 my %hash = $cust_pkg->hash;
2805 my $old_cust_pkg = new FS::cust_pkg \%hash;
2811 $cust_pkg->pkgpart($part_pkg->pkgpart);
2819 if ( $options{'resetup'}
2820 || ( ! $cust_pkg->setup
2821 && ( ! $cust_pkg->start_date
2822 || $cust_pkg->start_date <= $time
2824 && ( ! $conf->exists('disable_setup_suspended_pkgs')
2825 || ( $conf->exists('disable_setup_suspended_pkgs') &&
2826 ! $cust_pkg->getfield('susp')
2833 warn " bill setup\n" if $DEBUG > 1;
2836 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2837 return "$@ running calc_setup for $cust_pkg\n"
2840 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
2842 $cust_pkg->setfield('setup', $time)
2843 unless $cust_pkg->setup;
2844 #do need it, but it won't get written to the db
2845 #|| $cust_pkg->pkgpart != $real_pkgpart;
2847 $cust_pkg->setfield('start_date', '')
2848 if $cust_pkg->start_date;
2853 # bill recurring fee
2856 #XXX unit stuff here too
2860 if ( ! $cust_pkg->get('susp')
2861 and ! $cust_pkg->get('start_date')
2862 and ( $part_pkg->getfield('freq') ne '0'
2863 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
2865 || ( $part_pkg->plan eq 'voip_cdr'
2866 && $part_pkg->option('bill_every_call')
2868 || ( $options{cancel} )
2871 # XXX should this be a package event? probably. events are called
2872 # at collection time at the moment, though...
2873 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
2874 if $part_pkg->can('reset_usage');
2875 #don't want to reset usage just cause we want a line item??
2876 #&& $part_pkg->pkgpart == $real_pkgpart;
2878 warn " bill recur\n" if $DEBUG > 1;
2881 # XXX shared with $recur_prog
2882 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
2886 #over two params! lets at least switch to a hashref for the rest...
2887 my $increment_next_bill = ( $part_pkg->freq ne '0'
2888 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
2889 && !$options{cancel}
2891 my %param = ( 'precommit_hooks' => $precommit_hooks,
2892 'increment_next_bill' => $increment_next_bill,
2895 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
2896 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
2897 return "$@ running $method for $cust_pkg\n"
2900 if ( $increment_next_bill ) {
2902 my $next_bill = $part_pkg->add_freq($sdate);
2903 return "unparsable frequency: ". $part_pkg->freq
2904 if $next_bill == -1;
2906 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
2907 # only for figuring next bill date, nothing else, so, reset $sdate again
2909 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2910 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
2911 $cust_pkg->last_bill($sdate);
2913 $cust_pkg->setfield('bill', $next_bill );
2919 warn "\$setup is undefined" unless defined($setup);
2920 warn "\$recur is undefined" unless defined($recur);
2921 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2924 # If there's line items, create em cust_bill_pkg records
2925 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
2930 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
2931 # hmm.. and if just the options are modified in some weird price plan?
2933 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
2936 my $error = $cust_pkg->replace( $old_cust_pkg,
2937 'options' => { $cust_pkg->options },
2939 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
2940 if $error; #just in case
2943 $setup = sprintf( "%.2f", $setup );
2944 $recur = sprintf( "%.2f", $recur );
2945 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2946 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2948 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2949 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2952 if ( $setup != 0 || $recur != 0 ) {
2954 warn " charges (setup=$setup, recur=$recur); adding line items\n"
2957 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
2959 warn " adding customer package invoice detail: $_\n"
2960 foreach @cust_pkg_detail;
2962 push @details, @cust_pkg_detail;
2964 my $cust_bill_pkg = new FS::cust_bill_pkg {
2965 'pkgnum' => $cust_pkg->pkgnum,
2967 'unitsetup' => $unitsetup,
2969 'unitrecur' => $unitrecur,
2970 'quantity' => $cust_pkg->quantity,
2971 'details' => \@details,
2972 'hidden' => $part_pkg->hidden,
2975 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
2976 $cust_bill_pkg->sdate( $hash{last_bill} );
2977 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
2978 $cust_bill_pkg->edate( $time ) if $options{cancel};
2979 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
2980 $cust_bill_pkg->sdate( $sdate );
2981 $cust_bill_pkg->edate( $cust_pkg->bill );
2982 #$cust_bill_pkg->edate( $time ) if $options{cancel};
2985 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
2986 unless $part_pkg->pkgpart == $real_pkgpart;
2988 $$total_setup += $setup;
2989 $$total_recur += $recur;
2996 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart);
2997 return $error if $error;
2999 push @$cust_bill_pkgs, $cust_bill_pkg;
3001 } #if $setup != 0 || $recur != 0
3011 my $part_pkg = shift;
3012 my $taxlisthash = shift;
3013 my $cust_bill_pkg = shift;
3014 my $cust_pkg = shift;
3015 my $invoice_time = shift;
3016 my $real_pkgpart = shift;
3018 my %cust_bill_pkg = ();
3022 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
3023 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
3024 push @classes, 'setup' if $cust_bill_pkg->setup;
3025 push @classes, 'recur' if $cust_bill_pkg->recur;
3027 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
3029 if ( $conf->exists('enable_taxproducts')
3030 && ( scalar($part_pkg->part_pkg_taxoverride)
3031 || $part_pkg->has_taxproduct
3036 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3037 return "fatal: Can't (yet) use tax-pkg_address with taxproducts";
3040 foreach my $class (@classes) {
3041 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class );
3042 return $err_or_ref unless ref($err_or_ref);
3043 $taxes{$class} = $err_or_ref;
3046 unless (exists $taxes{''}) {
3047 my $err_or_ref = $self->_gather_taxes( $part_pkg, '' );
3048 return $err_or_ref unless ref($err_or_ref);
3049 $taxes{''} = $err_or_ref;
3054 my @loc_keys = qw( state county country );
3056 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3057 my $cust_location = $cust_pkg->cust_location;
3058 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
3061 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
3064 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
3067 $taxhash{'taxclass'} = $part_pkg->taxclass;
3069 my @taxes = qsearch( 'cust_main_county', \%taxhash );
3071 my %taxhash_elim = %taxhash;
3073 my @elim = qw( taxclass county state );
3074 while ( !scalar(@taxes) && scalar(@elim) ) {
3075 $taxhash_elim{ shift(@elim) } = '';
3076 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
3079 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
3081 if $self->cust_main_exemption; #just to be safe
3083 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3085 $_->set('pkgnum', $cust_pkg->pkgnum );
3086 $_->set('locationnum', $cust_pkg->locationnum );
3090 $taxes{''} = [ @taxes ];
3091 $taxes{'setup'} = [ @taxes ];
3092 $taxes{'recur'} = [ @taxes ];
3093 $taxes{$_} = [ @taxes ] foreach (@classes);
3095 # # maybe eliminate this entirely, along with all the 0% records
3096 # unless ( @taxes ) {
3098 # "fatal: can't find tax rate for state/county/country/taxclass ".
3099 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
3102 } #if $conf->exists('enable_taxproducts') ...
3107 if ( $conf->exists('separate_usage') || $cust_bill_pkg->hidden ) {
3109 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
3110 my %hash = $cust_bill_pkg->hidden # maybe for all bill linked?
3111 ? ( 'section' => $temp_pkg->part_pkg->categoryname )
3114 my $section = $cust_pkg->part_pkg->option('usage_section', 'Hush!');
3115 my $summary = $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
3116 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3117 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
3119 if ($section && $summary) {
3120 push @display, new FS::cust_bill_pkg_display { type => 'U',
3124 $hash{post_total} = 'Y';
3127 $hash{section} = $section if $conf->exists('separate_usage');
3128 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
3131 $cust_bill_pkg->set('display', \@display);
3133 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
3134 foreach my $key (keys %tax_cust_bill_pkg) {
3135 my @taxes = @{ $taxes{$key} || [] };
3136 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
3138 my %localtaxlisthash = ();
3139 foreach my $tax ( @taxes ) {
3141 my $taxname = ref( $tax ). ' '. $tax->taxnum;
3142 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
3143 # ' locationnum'. $cust_pkg->locationnum
3144 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
3146 $taxlisthash->{ $taxname } ||= [ $tax ];
3147 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
3149 $localtaxlisthash{ $taxname } ||= [ $tax ];
3150 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
3154 warn "finding taxed taxes...\n" if $DEBUG > 2;
3155 foreach my $tax ( keys %localtaxlisthash ) {
3156 my $tax_object = shift @{ $localtaxlisthash{$tax} };
3157 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
3159 next unless $tax_object->can('tax_on_tax');
3161 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
3162 my $totname = ref( $tot ). ' '. $tot->taxnum;
3164 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
3166 next unless exists( $localtaxlisthash{ $totname } ); # only increase
3168 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
3169 my $hashref_or_error =
3170 $tax_object->taxline( $localtaxlisthash{$tax},
3171 'custnum' => $self->custnum,
3172 'invoice_time' => $invoice_time,
3174 return $hashref_or_error
3175 unless ref($hashref_or_error);
3177 $taxlisthash->{ $totname } ||= [ $tot ];
3178 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
3190 my $part_pkg = shift;
3194 my $geocode = $self->geocode('cch');
3196 my @taxclassnums = map { $_->taxclassnum }
3197 $part_pkg->part_pkg_taxoverride($class);
3199 unless (@taxclassnums) {
3200 @taxclassnums = map { $_->taxclassnum }
3201 grep { $_->taxable eq 'Y' }
3202 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
3204 warn "Found taxclassnum values of ". join(',', @taxclassnums)
3209 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
3211 @taxes = qsearch({ 'table' => 'tax_rate',
3212 'hashref' => { 'geocode' => $geocode, },
3213 'extra_sql' => $extra_sql,
3215 if scalar(@taxclassnums);
3217 warn "Found taxes ".
3218 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
3225 =item collect OPTIONS
3227 (Attempt to) collect money for this customer's outstanding invoices (see
3228 L<FS::cust_bill>). Usually used after the bill method.
3230 Actions are now triggered by billing events; see L<FS::part_event> and the
3231 billing events web interface. Old-style invoice events (see
3232 L<FS::part_bill_event>) have been deprecated.
3234 If there is an error, returns the error, otherwise returns false.
3236 Options are passed as name-value pairs.
3238 Currently available options are:
3244 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.
3248 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3252 set true to surpress email card/ACH decline notices.
3256 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3260 allows for one time override of normal customer billing method
3264 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)
3272 my( $self, %options ) = @_;
3273 my $invoice_time = $options{'invoice_time'} || time;
3276 local $SIG{HUP} = 'IGNORE';
3277 local $SIG{INT} = 'IGNORE';
3278 local $SIG{QUIT} = 'IGNORE';
3279 local $SIG{TERM} = 'IGNORE';
3280 local $SIG{TSTP} = 'IGNORE';
3281 local $SIG{PIPE} = 'IGNORE';
3283 my $oldAutoCommit = $FS::UID::AutoCommit;
3284 local $FS::UID::AutoCommit = 0;
3287 $self->select_for_update; #mutex
3290 my $balance = $self->balance;
3291 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
3294 if ( exists($options{'retry_card'}) ) {
3295 carp 'retry_card option passed to collect is deprecated; use retry';
3296 $options{'retry'} ||= $options{'retry_card'};
3298 if ( exists($options{'retry'}) && $options{'retry'} ) {
3299 my $error = $self->retry_realtime;
3301 $dbh->rollback if $oldAutoCommit;
3306 # false laziness w/pay_batch::import_results
3308 my $due_cust_event = $self->due_cust_event(
3309 'debug' => ( $options{'debug'} || 0 ),
3310 'time' => $invoice_time,
3311 'check_freq' => $options{'check_freq'},
3313 unless( ref($due_cust_event) ) {
3314 $dbh->rollback if $oldAutoCommit;
3315 return $due_cust_event;
3318 foreach my $cust_event ( @$due_cust_event ) {
3322 #re-eval event conditions (a previous event could have changed things)
3323 unless ( $cust_event->test_conditions( 'time' => $invoice_time ) ) {
3324 #don't leave stray "new/locked" records around
3325 my $error = $cust_event->delete;
3327 #gah, even with transactions
3328 $dbh->commit if $oldAutoCommit; #well.
3335 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
3336 warn " running cust_event ". $cust_event->eventnum. "\n"
3340 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
3341 if ( my $error = $cust_event->do_event() ) {
3342 #XXX wtf is this? figure out a proper dealio with return value
3344 # gah, even with transactions.
3345 $dbh->commit if $oldAutoCommit; #well.
3352 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3357 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
3359 Inserts database records for and returns an ordered listref of new events due
3360 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
3361 events are due, an empty listref is returned. If there is an error, returns a
3362 scalar error message.
3364 To actually run the events, call each event's test_condition method, and if
3365 still true, call the event's do_event method.
3367 Options are passed as a hashref or as a list of name-value pairs. Available
3374 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.
3378 "Current time" for the events.
3382 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)
3386 Only return events for the specified eventtable (by default, events of all eventtables are returned)
3390 Explicitly pass the objects to be tested (typically used with eventtable).
3394 Set to true to return the objects, but not actually insert them into the
3401 sub due_cust_event {
3403 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
3406 #my $DEBUG = $opt{'debug'}
3407 local($DEBUG) = $opt{'debug'}
3408 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
3410 warn "$me due_cust_event called with options ".
3411 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
3414 $opt{'time'} ||= time;
3416 local $SIG{HUP} = 'IGNORE';
3417 local $SIG{INT} = 'IGNORE';
3418 local $SIG{QUIT} = 'IGNORE';
3419 local $SIG{TERM} = 'IGNORE';
3420 local $SIG{TSTP} = 'IGNORE';
3421 local $SIG{PIPE} = 'IGNORE';
3423 my $oldAutoCommit = $FS::UID::AutoCommit;
3424 local $FS::UID::AutoCommit = 0;
3427 $self->select_for_update #mutex
3428 unless $opt{testonly};
3431 # 1: find possible events (initial search)
3434 my @cust_event = ();
3436 my @eventtable = $opt{'eventtable'}
3437 ? ( $opt{'eventtable'} )
3438 : FS::part_event->eventtables_runorder;
3440 foreach my $eventtable ( @eventtable ) {
3443 if ( $opt{'objects'} ) {
3445 @objects = @{ $opt{'objects'} };
3449 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
3450 @objects = ( $eventtable eq 'cust_main' )
3452 : ( $self->$eventtable() );
3456 my @e_cust_event = ();
3458 my $cross = "CROSS JOIN $eventtable";
3459 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
3460 unless $eventtable eq 'cust_main';
3462 foreach my $object ( @objects ) {
3464 #this first search uses the condition_sql magic for optimization.
3465 #the more possible events we can eliminate in this step the better
3467 my $cross_where = '';
3468 my $pkey = $object->primary_key;
3469 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
3471 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
3473 FS::part_event_condition->where_conditions_sql( $eventtable,
3474 'time'=>$opt{'time'}
3476 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
3478 $extra_sql = "AND $extra_sql" if $extra_sql;
3480 #here is the agent virtualization
3481 $extra_sql .= " AND ( part_event.agentnum IS NULL
3482 OR part_event.agentnum = ". $self->agentnum. ' )';
3484 $extra_sql .= " $order";
3486 warn "searching for events for $eventtable ". $object->$pkey. "\n"
3487 if $opt{'debug'} > 2;
3488 my @part_event = qsearch( {
3489 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
3490 'select' => 'part_event.*',
3491 'table' => 'part_event',
3492 'addl_from' => "$cross $join",
3493 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
3494 'eventtable' => $eventtable,
3497 'extra_sql' => "AND $cross_where $extra_sql",
3501 my $pkey = $object->primary_key;
3502 warn " ". scalar(@part_event).
3503 " possible events found for $eventtable ". $object->$pkey(). "\n";
3506 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
3510 warn " ". scalar(@e_cust_event).
3511 " subtotal possible cust events found for $eventtable\n"
3514 push @cust_event, @e_cust_event;
3518 warn " ". scalar(@cust_event).
3519 " total possible cust events found in initial search\n"
3523 # 2: test conditions
3528 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
3529 'stats_hashref' => \%unsat ),
3532 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
3535 warn " invalid conditions not eliminated with condition_sql:\n".
3536 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
3543 unless( $opt{testonly} ) {
3544 foreach my $cust_event ( @cust_event ) {
3546 my $error = $cust_event->insert();
3548 $dbh->rollback if $oldAutoCommit;
3555 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3561 warn " returning events: ". Dumper(@cust_event). "\n"
3568 =item retry_realtime
3570 Schedules realtime / batch credit card / electronic check / LEC billing
3571 events for for retry. Useful if card information has changed or manual
3572 retry is desired. The 'collect' method must be called to actually retry
3575 Implementation details: For either this customer, or for each of this
3576 customer's open invoices, changes the status of the first "done" (with
3577 statustext error) realtime processing event to "failed".
3581 sub retry_realtime {
3584 local $SIG{HUP} = 'IGNORE';
3585 local $SIG{INT} = 'IGNORE';
3586 local $SIG{QUIT} = 'IGNORE';
3587 local $SIG{TERM} = 'IGNORE';
3588 local $SIG{TSTP} = 'IGNORE';
3589 local $SIG{PIPE} = 'IGNORE';
3591 my $oldAutoCommit = $FS::UID::AutoCommit;
3592 local $FS::UID::AutoCommit = 0;
3595 #a little false laziness w/due_cust_event (not too bad, really)
3597 my $join = FS::part_event_condition->join_conditions_sql;
3598 my $order = FS::part_event_condition->order_conditions_sql;
3601 . join ( ' OR ' , map {
3602 "( part_event.eventtable = " . dbh->quote($_)
3603 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
3604 } FS::part_event->eventtables)
3607 #here is the agent virtualization
3608 my $agent_virt = " ( part_event.agentnum IS NULL
3609 OR part_event.agentnum = ". $self->agentnum. ' )';
3611 #XXX this shouldn't be hardcoded, actions should declare it...
3612 my @realtime_events = qw(
3613 cust_bill_realtime_card
3614 cust_bill_realtime_check
3615 cust_bill_realtime_lec
3619 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
3624 my @cust_event = qsearchs({
3625 'table' => 'cust_event',
3626 'select' => 'cust_event.*',
3627 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
3628 'hashref' => { 'status' => 'done' },
3629 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
3630 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
3633 my %seen_invnum = ();
3634 foreach my $cust_event (@cust_event) {
3636 #max one for the customer, one for each open invoice
3637 my $cust_X = $cust_event->cust_X;
3638 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
3642 or $cust_event->part_event->eventtable eq 'cust_bill'
3645 my $error = $cust_event->retry;
3647 $dbh->rollback if $oldAutoCommit;
3648 return "error scheduling event for retry: $error";
3653 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3658 # some horrid false laziness here to avoid refactor fallout
3659 # eventually realtime realtime_bop and realtime_refund_bop should go
3660 # away and be replaced by _new_realtime_bop and _new_realtime_refund_bop
3662 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
3664 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
3665 via a Business::OnlinePayment realtime gateway. See
3666 L<http://420.am/business-onlinepayment> for supported gateways.
3668 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3670 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
3672 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3673 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3674 if set, will override the value from the customer record.
3676 I<description> is a free-text field passed to the gateway. It defaults to
3677 "Internet services".
3679 If an I<invnum> is specified, this payment (if successful) is applied to the
3680 specified invoice. If you don't specify an I<invnum> you might want to
3681 call the B<apply_payments> method.
3683 I<quiet> can be set true to surpress email decline notices.
3685 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
3686 resulting paynum, if any.
3688 I<payunique> is a unique identifier for this payment.
3690 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
3697 return $self->_new_realtime_bop(@_)
3698 if $self->_new_bop_required();
3700 my( $method, $amount, %options ) = @_;
3702 warn "$me realtime_bop: $method $amount\n";
3703 warn " $_ => $options{$_}\n" foreach keys %options;
3706 $options{'description'} ||= 'Internet services';
3708 return $self->fake_bop($method, $amount, %options) if $options{'fake'};
3710 eval "use Business::OnlinePayment";
3713 my $payinfo = exists($options{'payinfo'})
3714 ? $options{'payinfo'}
3717 my %method2payby = (
3724 # check for banned credit card/ACH
3727 my $ban = qsearchs('banned_pay', {
3728 'payby' => $method2payby{$method},
3729 'payinfo' => md5_base64($payinfo),
3731 return "Banned credit card" if $ban;
3734 # set taxclass and trans_is_recur based on invnum if there is one
3738 my $trans_is_recur = 0;
3739 if ( $options{'invnum'} ) {
3741 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
3742 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
3745 map { $_->part_pkg }
3747 map { $_->cust_pkg }
3748 $cust_bill->cust_bill_pkg;
3750 my @taxclasses = map $_->taxclass, @part_pkg;
3751 $taxclass = $taxclasses[0]
3752 unless grep { $taxclasses[0] ne $_ } @taxclasses; #unless there are
3753 #different taxclasses
3755 if grep { $_->freq ne '0' } @part_pkg;
3763 #look for an agent gateway override first
3765 if ( $method eq 'CC' ) {
3766 $cardtype = cardtype($payinfo);
3767 } elsif ( $method eq 'ECHECK' ) {
3770 $cardtype = $method;
3774 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3775 cardtype => $cardtype,
3776 taxclass => $taxclass, } )
3777 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3779 taxclass => $taxclass, } )
3780 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3781 cardtype => $cardtype,
3783 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3785 taxclass => '', } );
3787 my $payment_gateway = '';
3788 my( $processor, $login, $password, $action, @bop_options );
3789 if ( $override ) { #use a payment gateway override
3791 $payment_gateway = $override->payment_gateway;
3793 $processor = $payment_gateway->gateway_module;
3794 $login = $payment_gateway->gateway_username;
3795 $password = $payment_gateway->gateway_password;
3796 $action = $payment_gateway->gateway_action;
3797 @bop_options = $payment_gateway->options;
3799 } else { #use the standard settings from the config
3801 ( $processor, $login, $password, $action, @bop_options ) =
3802 $self->default_payment_gateway($method);
3810 my $address = exists($options{'address1'})
3811 ? $options{'address1'}
3813 my $address2 = exists($options{'address2'})
3814 ? $options{'address2'}
3816 $address .= ", ". $address2 if length($address2);
3818 my $o_payname = exists($options{'payname'})
3819 ? $options{'payname'}
3821 my($payname, $payfirst, $paylast);
3822 if ( $o_payname && $method ne 'ECHECK' ) {
3823 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3824 or return "Illegal payname $payname";
3825 ($payfirst, $paylast) = ($1, $2);
3827 $payfirst = $self->getfield('first');
3828 $paylast = $self->getfield('last');
3829 $payname = "$payfirst $paylast";
3832 my @invoicing_list = $self->invoicing_list_emailonly;
3833 if ( $conf->exists('emailinvoiceautoalways')
3834 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3835 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3836 push @invoicing_list, $self->all_emails;
3839 my $email = ($conf->exists('business-onlinepayment-email-override'))
3840 ? $conf->config('business-onlinepayment-email-override')
3841 : $invoicing_list[0];
3845 my $payip = exists($options{'payip'})
3848 $content{customer_ip} = $payip
3851 $content{invoice_number} = $options{'invnum'}
3852 if exists($options{'invnum'}) && length($options{'invnum'});
3854 $content{email_customer} =
3855 ( $conf->exists('business-onlinepayment-email_customer')
3856 || $conf->exists('business-onlinepayment-email-override') );
3859 if ( $method eq 'CC' ) {
3861 $content{card_number} = $payinfo;
3862 $paydate = exists($options{'paydate'})
3863 ? $options{'paydate'}
3865 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3866 $content{expiration} = "$2/$1";
3868 my $paycvv = exists($options{'paycvv'})
3869 ? $options{'paycvv'}
3871 $content{cvv2} = $paycvv
3874 my $paystart_month = exists($options{'paystart_month'})
3875 ? $options{'paystart_month'}
3876 : $self->paystart_month;
3878 my $paystart_year = exists($options{'paystart_year'})
3879 ? $options{'paystart_year'}
3880 : $self->paystart_year;
3882 $content{card_start} = "$paystart_month/$paystart_year"
3883 if $paystart_month && $paystart_year;
3885 my $payissue = exists($options{'payissue'})
3886 ? $options{'payissue'}
3888 $content{issue_number} = $payissue if $payissue;
3890 if ( $self->_bop_recurring_billing( 'payinfo' => $payinfo,
3891 'trans_is_recur' => $trans_is_recur,
3895 $content{recurring_billing} = 'YES';
3896 $content{acct_code} = 'rebill'
3897 if $conf->exists('credit_card-recurring_billing_acct_code');
3900 } elsif ( $method eq 'ECHECK' ) {
3901 ( $content{account_number}, $content{routing_code} ) =
3902 split('@', $payinfo);
3903 $content{bank_name} = $o_payname;
3904 $content{bank_state} = exists($options{'paystate'})
3905 ? $options{'paystate'}
3906 : $self->getfield('paystate');
3907 $content{account_type} = exists($options{'paytype'})
3908 ? uc($options{'paytype'}) || 'CHECKING'
3909 : uc($self->getfield('paytype')) || 'CHECKING';
3910 $content{account_name} = $payname;
3911 $content{customer_org} = $self->company ? 'B' : 'I';
3912 $content{state_id} = exists($options{'stateid'})
3913 ? $options{'stateid'}
3914 : $self->getfield('stateid');
3915 $content{state_id_state} = exists($options{'stateid_state'})
3916 ? $options{'stateid_state'}
3917 : $self->getfield('stateid_state');
3918 $content{customer_ssn} = exists($options{'ss'})
3921 } elsif ( $method eq 'LEC' ) {
3922 $content{phone} = $payinfo;
3926 # run transaction(s)
3929 my $balance = exists( $options{'balance'} )
3930 ? $options{'balance'}
3933 $self->select_for_update; #mutex ... just until we get our pending record in
3935 #the checks here are intended to catch concurrent payments
3936 #double-form-submission prevention is taken care of in cust_pay_pending::check
3939 return "The customer's balance has changed; $method transaction aborted."
3940 if $self->balance < $balance;
3941 #&& $self->balance < $amount; #might as well anyway?
3943 #also check and make sure there aren't *other* pending payments for this cust
3945 my @pending = qsearch('cust_pay_pending', {
3946 'custnum' => $self->custnum,
3947 'status' => { op=>'!=', value=>'done' }
3949 return "A payment is already being processed for this customer (".
3950 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
3951 "); $method transaction aborted."
3952 if scalar(@pending);
3954 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
3956 my $cust_pay_pending = new FS::cust_pay_pending {
3957 'custnum' => $self->custnum,
3958 #'invnum' => $options{'invnum'},
3961 'payby' => $method2payby{$method},
3962 'payinfo' => $payinfo,
3963 'paydate' => $paydate,
3964 'recurring_billing' => $content{recurring_billing},
3965 'pkgnum' => $options{'pkgnum'},
3967 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
3969 $cust_pay_pending->payunique( $options{payunique} )
3970 if defined($options{payunique}) && length($options{payunique});
3971 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
3972 return $cpp_new_err if $cpp_new_err;
3974 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
3976 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
3977 $transaction->content(
3980 'password' => $password,
3981 'action' => $action1,
3982 'description' => $options{'description'},
3983 'amount' => $amount,
3984 #'invoice_number' => $options{'invnum'},
3985 'customer_id' => $self->custnum,
3986 'last_name' => $paylast,
3987 'first_name' => $payfirst,
3989 'address' => $address,
3990 'city' => ( exists($options{'city'})
3993 'state' => ( exists($options{'state'})
3996 'zip' => ( exists($options{'zip'})
3999 'country' => ( exists($options{'country'})
4000 ? $options{'country'}
4002 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4004 'phone' => $self->daytime || $self->night,
4008 $cust_pay_pending->status('pending');
4009 my $cpp_pending_err = $cust_pay_pending->replace;
4010 return $cpp_pending_err if $cpp_pending_err;
4013 my $BOP_TESTING = 0;
4014 my $BOP_TESTING_SUCCESS = 1;
4016 unless ( $BOP_TESTING ) {
4017 $transaction->submit();
4019 if ( $BOP_TESTING_SUCCESS ) {
4020 $transaction->is_success(1);
4021 $transaction->authorization('fake auth');
4023 $transaction->is_success(0);
4024 $transaction->error_message('fake failure');
4028 if ( $transaction->is_success() && $action2 ) {
4030 $cust_pay_pending->status('authorized');
4031 my $cpp_authorized_err = $cust_pay_pending->replace;
4032 return $cpp_authorized_err if $cpp_authorized_err;
4034 my $auth = $transaction->authorization;
4035 my $ordernum = $transaction->can('order_number')
4036 ? $transaction->order_number
4040 new Business::OnlinePayment( $processor, @bop_options );
4047 password => $password,
4048 order_number => $ordernum,
4050 authorization => $auth,
4051 description => $options{'description'},
4054 foreach my $field (qw( authorization_source_code returned_ACI
4055 transaction_identifier validation_code
4056 transaction_sequence_num local_transaction_date
4057 local_transaction_time AVS_result_code )) {
4058 $capture{$field} = $transaction->$field() if $transaction->can($field);
4061 $capture->content( %capture );
4065 unless ( $capture->is_success ) {
4066 my $e = "Authorization successful but capture failed, custnum #".
4067 $self->custnum. ': '. $capture->result_code.
4068 ": ". $capture->error_message;
4075 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
4076 my $cpp_captured_err = $cust_pay_pending->replace;
4077 return $cpp_captured_err if $cpp_captured_err;
4080 # remove paycvv after initial transaction
4083 #false laziness w/misc/process/payment.cgi - check both to make sure working
4085 if ( defined $self->dbdef_table->column('paycvv')
4086 && length($self->paycvv)
4087 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
4089 my $error = $self->remove_cvv;
4091 warn "WARNING: error removing cvv: $error\n";
4099 if ( $transaction->is_success() ) {
4102 if ( $payment_gateway ) { # agent override
4103 $paybatch = $payment_gateway->gatewaynum. '-';
4106 $paybatch .= "$processor:". $transaction->authorization;
4108 $paybatch .= ':'. $transaction->order_number
4109 if $transaction->can('order_number')
4110 && length($transaction->order_number);
4112 my $cust_pay = new FS::cust_pay ( {
4113 'custnum' => $self->custnum,
4114 'invnum' => $options{'invnum'},
4117 'payby' => $method2payby{$method},
4118 'payinfo' => $payinfo,
4119 'paybatch' => $paybatch,
4120 'paydate' => $paydate,
4121 'pkgnum' => $options{'pkgnum'},
4123 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
4124 $cust_pay->payunique( $options{payunique} )
4125 if defined($options{payunique}) && length($options{payunique});
4127 my $oldAutoCommit = $FS::UID::AutoCommit;
4128 local $FS::UID::AutoCommit = 0;
4131 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
4133 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
4136 $cust_pay->invnum(''); #try again with no specific invnum
4137 my $error2 = $cust_pay->insert( $options{'manual'} ?
4138 ( 'manual' => 1 ) : ()
4141 # gah. but at least we have a record of the state we had to abort in
4142 # from cust_pay_pending now.
4143 my $e = "WARNING: $method captured but payment not recorded - ".
4144 "error inserting payment ($processor): $error2".
4145 " (previously tried insert with invnum #$options{'invnum'}" .
4146 ": $error ) - pending payment saved as paypendingnum ".
4147 $cust_pay_pending->paypendingnum. "\n";
4153 if ( $options{'paynum_ref'} ) {
4154 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
4157 $cust_pay_pending->status('done');
4158 $cust_pay_pending->statustext('captured');
4159 $cust_pay_pending->paynum($cust_pay->paynum);
4160 my $cpp_done_err = $cust_pay_pending->replace;
4162 if ( $cpp_done_err ) {
4164 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4165 my $e = "WARNING: $method captured but payment not recorded - ".
4166 "error updating status for paypendingnum ".
4167 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4173 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4174 return ''; #no error
4180 my $perror = "$processor error: ". $transaction->error_message;
4182 unless ( $transaction->error_message ) {
4185 if ( $transaction->can('response_page') ) {
4187 'page' => ( $transaction->can('response_page')
4188 ? $transaction->response_page
4191 'code' => ( $transaction->can('response_code')
4192 ? $transaction->response_code
4195 'headers' => ( $transaction->can('response_headers')
4196 ? $transaction->response_headers
4202 "No additional debugging information available for $processor";
4205 $perror .= "No error_message returned from $processor -- ".
4206 ( ref($t_response) ? Dumper($t_response) : $t_response );
4210 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
4211 && $conf->exists('emaildecline')
4212 && grep { $_ ne 'POST' } $self->invoicing_list
4213 && ! grep { $transaction->error_message =~ /$_/ }
4214 $conf->config('emaildecline-exclude')
4216 my @templ = $conf->config('declinetemplate');
4217 my $template = new Text::Template (
4219 SOURCE => [ map "$_\n", @templ ],
4220 ) or return "($perror) can't create template: $Text::Template::ERROR";
4221 $template->compile()
4222 or return "($perror) can't compile template: $Text::Template::ERROR";
4224 my $templ_hash = { error => $transaction->error_message };
4226 my $error = send_email(
4227 'from' => $conf->config('invoice_from', $self->agentnum ),
4228 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
4229 'subject' => 'Your payment could not be processed',
4230 'body' => [ $template->fill_in(HASH => $templ_hash) ],
4233 $perror .= " (also received error sending decline notification: $error)"
4238 $cust_pay_pending->status('done');
4239 $cust_pay_pending->statustext("declined: $perror");
4240 my $cpp_done_err = $cust_pay_pending->replace;
4241 if ( $cpp_done_err ) {
4242 my $e = "WARNING: $method declined but pending payment not resolved - ".
4243 "error updating status for paypendingnum ".
4244 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4246 $perror = "$e ($perror)";
4254 sub _bop_recurring_billing {
4255 my( $self, %opt ) = @_;
4257 my $method = $conf->config('credit_card-recurring_billing_flag');
4259 if ( $method eq 'transaction_is_recur' ) {
4261 return 1 if $opt{'trans_is_recur'};
4265 my %hash = ( 'custnum' => $self->custnum,
4270 if qsearch('cust_pay', { %hash, 'payinfo' => $opt{'payinfo'} } )
4271 || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo('CARD',
4282 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
4284 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
4285 via a Business::OnlinePayment realtime gateway. See
4286 L<http://420.am/business-onlinepayment> for supported gateways.
4288 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4290 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
4292 Most gateways require a reference to an original payment transaction to refund,
4293 so you probably need to specify a I<paynum>.
4295 I<amount> defaults to the original amount of the payment if not specified.
4297 I<reason> specifies a reason for the refund.
4299 I<paydate> specifies the expiration date for a credit card overriding the
4300 value from the customer record or the payment record. Specified as yyyy-mm-dd
4302 Implementation note: If I<amount> is unspecified or equal to the amount of the
4303 orignal payment, first an attempt is made to "void" the transaction via
4304 the gateway (to cancel a not-yet settled transaction) and then if that fails,
4305 the normal attempt is made to "refund" ("credit") the transaction via the
4306 gateway is attempted.
4308 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4309 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4310 #if set, will override the value from the customer record.
4312 #If an I<invnum> is specified, this payment (if successful) is applied to the
4313 #specified invoice. If you don't specify an I<invnum> you might want to
4314 #call the B<apply_payments> method.
4318 #some false laziness w/realtime_bop, not enough to make it worth merging
4319 #but some useful small subs should be pulled out
4320 sub realtime_refund_bop {
4323 return $self->_new_realtime_refund_bop(@_)
4324 if $self->_new_bop_required();
4326 my( $method, %options ) = @_;
4328 warn "$me realtime_refund_bop: $method refund\n";
4329 warn " $_ => $options{$_}\n" foreach keys %options;
4332 eval "use Business::OnlinePayment";
4336 # look up the original payment and optionally a gateway for that payment
4340 my $amount = $options{'amount'};
4342 my( $processor, $login, $password, @bop_options ) ;
4343 my( $auth, $order_number ) = ( '', '', '' );
4345 if ( $options{'paynum'} ) {
4347 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
4348 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
4349 or return "Unknown paynum $options{'paynum'}";
4350 $amount ||= $cust_pay->paid;
4352 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
4353 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
4354 $cust_pay->paybatch;
4355 my $gatewaynum = '';
4356 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
4358 if ( $gatewaynum ) { #gateway for the payment to be refunded
4360 my $payment_gateway =
4361 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
4362 die "payment gateway $gatewaynum not found"
4363 unless $payment_gateway;
4365 $processor = $payment_gateway->gateway_module;
4366 $login = $payment_gateway->gateway_username;
4367 $password = $payment_gateway->gateway_password;
4368 @bop_options = $payment_gateway->options;
4370 } else { #try the default gateway
4372 my( $conf_processor, $unused_action );
4373 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
4374 $self->default_payment_gateway($method);
4376 return "processor of payment $options{'paynum'} $processor does not".
4377 " match default processor $conf_processor"
4378 unless $processor eq $conf_processor;
4383 } else { # didn't specify a paynum, so look for agent gateway overrides
4384 # like a normal transaction
4387 if ( $method eq 'CC' ) {
4388 $cardtype = cardtype($self->payinfo);
4389 } elsif ( $method eq 'ECHECK' ) {
4392 $cardtype = $method;
4395 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4396 cardtype => $cardtype,
4398 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4400 taxclass => '', } );
4402 if ( $override ) { #use a payment gateway override
4404 my $payment_gateway = $override->payment_gateway;
4406 $processor = $payment_gateway->gateway_module;
4407 $login = $payment_gateway->gateway_username;
4408 $password = $payment_gateway->gateway_password;
4409 #$action = $payment_gateway->gateway_action;
4410 @bop_options = $payment_gateway->options;
4412 } else { #use the standard settings from the config
4415 ( $processor, $login, $password, $unused_action, @bop_options ) =
4416 $self->default_payment_gateway($method);
4421 return "neither amount nor paynum specified" unless $amount;
4426 'password' => $password,
4427 'order_number' => $order_number,
4428 'amount' => $amount,
4429 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4431 $content{authorization} = $auth
4432 if length($auth); #echeck/ACH transactions have an order # but no auth
4433 #(at least with authorize.net)
4435 my $disable_void_after;
4436 if ($conf->exists('disable_void_after')
4437 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
4438 $disable_void_after = $1;
4441 #first try void if applicable
4442 if ( $cust_pay && $cust_pay->paid == $amount
4444 ( not defined($disable_void_after) )
4445 || ( time < ($cust_pay->_date + $disable_void_after ) )
4448 warn " attempting void\n" if $DEBUG > 1;
4449 my $void = new Business::OnlinePayment( $processor, @bop_options );
4450 $void->content( 'action' => 'void', %content );
4452 if ( $void->is_success ) {
4453 my $error = $cust_pay->void($options{'reason'});
4455 # gah, even with transactions.
4456 my $e = 'WARNING: Card/ACH voided but database not updated - '.
4457 "error voiding payment: $error";
4461 warn " void successful\n" if $DEBUG > 1;
4466 warn " void unsuccessful, trying refund\n"
4470 my $address = $self->address1;
4471 $address .= ", ". $self->address2 if $self->address2;
4473 my($payname, $payfirst, $paylast);
4474 if ( $self->payname && $method ne 'ECHECK' ) {
4475 $payname = $self->payname;
4476 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4477 or return "Illegal payname $payname";
4478 ($payfirst, $paylast) = ($1, $2);
4480 $payfirst = $self->getfield('first');
4481 $paylast = $self->getfield('last');
4482 $payname = "$payfirst $paylast";
4485 my @invoicing_list = $self->invoicing_list_emailonly;
4486 if ( $conf->exists('emailinvoiceautoalways')
4487 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4488 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4489 push @invoicing_list, $self->all_emails;
4492 my $email = ($conf->exists('business-onlinepayment-email-override'))
4493 ? $conf->config('business-onlinepayment-email-override')
4494 : $invoicing_list[0];
4496 my $payip = exists($options{'payip'})
4499 $content{customer_ip} = $payip
4503 if ( $method eq 'CC' ) {
4506 $content{card_number} = $payinfo = $cust_pay->payinfo;
4507 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
4508 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
4509 ($content{expiration} = "$2/$1"); # where available
4511 $content{card_number} = $payinfo = $self->payinfo;
4512 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
4513 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4514 $content{expiration} = "$2/$1";
4517 } elsif ( $method eq 'ECHECK' ) {
4520 $payinfo = $cust_pay->payinfo;
4522 $payinfo = $self->payinfo;
4524 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
4525 $content{bank_name} = $self->payname;
4526 $content{account_type} = 'CHECKING';
4527 $content{account_name} = $payname;
4528 $content{customer_org} = $self->company ? 'B' : 'I';
4529 $content{customer_ssn} = $self->ss;
4530 } elsif ( $method eq 'LEC' ) {
4531 $content{phone} = $payinfo = $self->payinfo;
4535 my $refund = new Business::OnlinePayment( $processor, @bop_options );
4536 my %sub_content = $refund->content(
4537 'action' => 'credit',
4538 'customer_id' => $self->custnum,
4539 'last_name' => $paylast,
4540 'first_name' => $payfirst,
4542 'address' => $address,
4543 'city' => $self->city,
4544 'state' => $self->state,
4545 'zip' => $self->zip,
4546 'country' => $self->country,
4548 'phone' => $self->daytime || $self->night,
4551 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
4555 return "$processor error: ". $refund->error_message
4556 unless $refund->is_success();
4558 my %method2payby = (
4564 my $paybatch = "$processor:". $refund->authorization;
4565 $paybatch .= ':'. $refund->order_number
4566 if $refund->can('order_number') && $refund->order_number;
4568 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
4569 my @cust_bill_pay = $cust_pay->cust_bill_pay;
4570 last unless @cust_bill_pay;
4571 my $cust_bill_pay = pop @cust_bill_pay;
4572 my $error = $cust_bill_pay->delete;
4576 my $cust_refund = new FS::cust_refund ( {
4577 'custnum' => $self->custnum,
4578 'paynum' => $options{'paynum'},
4579 'refund' => $amount,
4581 'payby' => $method2payby{$method},
4582 'payinfo' => $payinfo,
4583 'paybatch' => $paybatch,
4584 'reason' => $options{'reason'} || 'card or ACH refund',
4586 my $error = $cust_refund->insert;
4588 $cust_refund->paynum(''); #try again with no specific paynum
4589 my $error2 = $cust_refund->insert;
4591 # gah, even with transactions.
4592 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
4593 "error inserting refund ($processor): $error2".
4594 " (previously tried insert with paynum #$options{'paynum'}" .
4605 # does the configuration indicate the new bop routines are required?
4607 sub _new_bop_required {
4610 my $botpp = 'Business::OnlineThirdPartyPayment';
4613 if ( $conf->config('business-onlinepayment-namespace') eq $botpp ||
4614 scalar( grep { $_->gateway_namespace eq $botpp }
4615 qsearch( 'payment_gateway', { 'disabled' => '' } )
4624 =item realtime_collect [ OPTION => VALUE ... ]
4626 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4627 via a Business::OnlinePayment or Business::OnlineThirdPartyPayment realtime
4628 gateway. See L<http://420.am/business-onlinepayment> and
4629 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
4631 On failure returns an error message.
4633 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.
4635 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>, I<pkgnum>
4637 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>. If none is specified
4638 then it is deduced from the customer record.
4640 If no I<amount> is specified, then the customer balance is used.
4642 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4643 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4644 if set, will override the value from the customer record.
4646 I<description> is a free-text field passed to the gateway. It defaults to
4647 "Internet services".
4649 If an I<invnum> is specified, this payment (if successful) is applied to the
4650 specified invoice. If you don't specify an I<invnum> you might want to
4651 call the B<apply_payments> method.
4653 I<quiet> can be set true to surpress email decline notices.
4655 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4656 resulting paynum, if any.
4658 I<payunique> is a unique identifier for this payment.
4660 I<session_id> is a session identifier associated with this payment.
4662 I<depend_jobnum> allows payment capture to unlock export jobs
4666 sub realtime_collect {
4667 my( $self, %options ) = @_;
4670 warn "$me realtime_collect:\n";
4671 warn " $_ => $options{$_}\n" foreach keys %options;
4674 $options{amount} = $self->balance unless exists( $options{amount} );
4675 $options{method} = FS::payby->payby2bop($self->payby)
4676 unless exists( $options{method} );
4678 return $self->realtime_bop({%options});
4682 =item _realtime_bop { [ ARG => VALUE ... ] }
4684 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4685 via a Business::OnlinePayment realtime gateway. See
4686 L<http://420.am/business-onlinepayment> for supported gateways.
4688 Required arguments in the hashref are I<method>, and I<amount>
4690 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4692 Available optional arguments are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
4694 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4695 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4696 if set, will override the value from the customer record.
4698 I<description> is a free-text field passed to the gateway. It defaults to
4699 "Internet services".
4701 If an I<invnum> is specified, this payment (if successful) is applied to the
4702 specified invoice. If you don't specify an I<invnum> you might want to
4703 call the B<apply_payments> method.
4705 I<quiet> can be set true to surpress email decline notices.
4707 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4708 resulting paynum, if any.
4710 I<payunique> is a unique identifier for this payment.
4712 I<session_id> is a session identifier associated with this payment.
4714 I<depend_jobnum> allows payment capture to unlock export jobs
4716 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
4720 # some helper routines
4721 sub _payment_gateway {
4722 my ($self, $options) = @_;
4724 $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
4725 unless exists($options->{payment_gateway});
4727 $options->{payment_gateway};
4731 my ($self, $options) = @_;
4734 'login' => $options->{payment_gateway}->gateway_username,
4735 'password' => $options->{payment_gateway}->gateway_password,
4740 my ($self, $options) = @_;
4742 $options->{payment_gateway}->gatewaynum
4743 ? $options->{payment_gateway}->options
4744 : @{ $options->{payment_gateway}->get('options') };
4748 my ($self, $options) = @_;
4750 $options->{description} ||= 'Internet services';
4751 $options->{payinfo} = $self->payinfo unless exists( $options->{payinfo} );
4752 $options->{invnum} ||= '';
4753 $options->{payname} = $self->payname unless exists( $options->{payname} );
4757 my ($self, $options) = @_;
4760 $content{address} = exists($options->{'address1'})
4761 ? $options->{'address1'}
4763 my $address2 = exists($options->{'address2'})
4764 ? $options->{'address2'}
4766 $content{address} .= ", ". $address2 if length($address2);
4768 my $payip = exists($options->{'payip'}) ? $options->{'payip'} : $self->payip;
4769 $content{customer_ip} = $payip if length($payip);
4771 $content{invoice_number} = $options->{'invnum'}
4772 if exists($options->{'invnum'}) && length($options->{'invnum'});
4774 $content{email_customer} =
4775 ( $conf->exists('business-onlinepayment-email_customer')
4776 || $conf->exists('business-onlinepayment-email-override') );
4778 $content{payfirst} = $self->getfield('first');
4779 $content{paylast} = $self->getfield('last');
4781 $content{account_name} = "$content{payfirst} $content{paylast}"
4782 if $options->{method} eq 'ECHECK';
4784 $content{name} = $options->{payname};
4785 $content{name} = $content{account_name} if exists($content{account_name});
4787 $content{city} = exists($options->{city})
4790 $content{state} = exists($options->{state})
4793 $content{zip} = exists($options->{zip})
4796 $content{country} = exists($options->{country})
4797 ? $options->{country}
4799 $content{referer} = 'http://cleanwhisker.420.am/'; #XXX fix referer :/
4800 $content{phone} = $self->daytime || $self->night;
4805 my %bop_method2payby = (
4811 sub _new_realtime_bop {
4815 if (ref($_[0]) eq 'HASH') {
4816 %options = %{$_[0]};
4818 my ( $method, $amount ) = ( shift, shift );
4820 $options{method} = $method;
4821 $options{amount} = $amount;
4825 warn "$me realtime_bop (new): $options{method} $options{amount}\n";
4826 warn " $_ => $options{$_}\n" foreach keys %options;
4829 return $self->fake_bop(%options) if $options{'fake'};
4831 $self->_bop_defaults(\%options);
4834 # set trans_is_recur based on invnum if there is one
4837 my $trans_is_recur = 0;
4838 if ( $options{'invnum'} ) {
4840 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
4841 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
4844 map { $_->part_pkg }
4846 map { $_->cust_pkg }
4847 $cust_bill->cust_bill_pkg;
4850 if grep { $_->freq ne '0' } @part_pkg;
4858 my $payment_gateway = $self->_payment_gateway( \%options );
4859 my $namespace = $payment_gateway->gateway_namespace;
4861 eval "use $namespace";
4865 # check for banned credit card/ACH
4868 my $ban = qsearchs('banned_pay', {
4869 'payby' => $bop_method2payby{$options{method}},
4870 'payinfo' => md5_base64($options{payinfo}),
4872 return "Banned credit card" if $ban;
4878 my (%bop_content) = $self->_bop_content(\%options);
4880 if ( $options{method} ne 'ECHECK' ) {
4881 $options{payname} =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4882 or return "Illegal payname $options{payname}";
4883 ($bop_content{payfirst}, $bop_content{paylast}) = ($1, $2);
4886 my @invoicing_list = $self->invoicing_list_emailonly;
4887 if ( $conf->exists('emailinvoiceautoalways')
4888 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4889 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4890 push @invoicing_list, $self->all_emails;
4893 my $email = ($conf->exists('business-onlinepayment-email-override'))
4894 ? $conf->config('business-onlinepayment-email-override')
4895 : $invoicing_list[0];
4899 if ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'CC' ) {
4901 $content{card_number} = $options{payinfo};
4902 $paydate = exists($options{'paydate'})
4903 ? $options{'paydate'}
4905 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4906 $content{expiration} = "$2/$1";
4908 my $paycvv = exists($options{'paycvv'})
4909 ? $options{'paycvv'}
4911 $content{cvv2} = $paycvv
4914 my $paystart_month = exists($options{'paystart_month'})
4915 ? $options{'paystart_month'}
4916 : $self->paystart_month;
4918 my $paystart_year = exists($options{'paystart_year'})
4919 ? $options{'paystart_year'}
4920 : $self->paystart_year;
4922 $content{card_start} = "$paystart_month/$paystart_year"
4923 if $paystart_month && $paystart_year;
4925 my $payissue = exists($options{'payissue'})
4926 ? $options{'payissue'}
4928 $content{issue_number} = $payissue if $payissue;
4930 if ( $self->_bop_recurring_billing( 'payinfo' => $options{'payinfo'},
4931 'trans_is_recur' => $trans_is_recur,
4935 $content{recurring_billing} = 'YES';
4936 $content{acct_code} = 'rebill'
4937 if $conf->exists('credit_card-recurring_billing_acct_code');
4940 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'ECHECK' ){
4941 ( $content{account_number}, $content{routing_code} ) =
4942 split('@', $options{payinfo});
4943 $content{bank_name} = $options{payname};
4944 $content{bank_state} = exists($options{'paystate'})
4945 ? $options{'paystate'}
4946 : $self->getfield('paystate');
4947 $content{account_type} = exists($options{'paytype'})
4948 ? uc($options{'paytype'}) || 'CHECKING'
4949 : uc($self->getfield('paytype')) || 'CHECKING';
4950 $content{customer_org} = $self->company ? 'B' : 'I';
4951 $content{state_id} = exists($options{'stateid'})
4952 ? $options{'stateid'}
4953 : $self->getfield('stateid');
4954 $content{state_id_state} = exists($options{'stateid_state'})
4955 ? $options{'stateid_state'}
4956 : $self->getfield('stateid_state');
4957 $content{customer_ssn} = exists($options{'ss'})
4960 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'LEC' ) {
4961 $content{phone} = $options{payinfo};
4962 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
4969 # run transaction(s)
4972 my $balance = exists( $options{'balance'} )
4973 ? $options{'balance'}
4976 $self->select_for_update; #mutex ... just until we get our pending record in
4978 #the checks here are intended to catch concurrent payments
4979 #double-form-submission prevention is taken care of in cust_pay_pending::check
4982 return "The customer's balance has changed; $options{method} transaction aborted."
4983 if $self->balance < $balance;
4984 #&& $self->balance < $options{amount}; #might as well anyway?
4986 #also check and make sure there aren't *other* pending payments for this cust
4988 my @pending = qsearch('cust_pay_pending', {
4989 'custnum' => $self->custnum,
4990 'status' => { op=>'!=', value=>'done' }
4992 return "A payment is already being processed for this customer (".
4993 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
4994 "); $options{method} transaction aborted."
4995 if scalar(@pending);
4997 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
4999 my $cust_pay_pending = new FS::cust_pay_pending {
5000 'custnum' => $self->custnum,
5001 #'invnum' => $options{'invnum'},
5002 'paid' => $options{amount},
5004 'payby' => $bop_method2payby{$options{method}},
5005 'payinfo' => $options{payinfo},
5006 'paydate' => $paydate,
5007 'recurring_billing' => $content{recurring_billing},
5008 'pkgnum' => $options{'pkgnum'},
5010 'gatewaynum' => $payment_gateway->gatewaynum || '',
5011 'session_id' => $options{session_id} || '',
5012 'jobnum' => $options{depend_jobnum} || '',
5014 $cust_pay_pending->payunique( $options{payunique} )
5015 if defined($options{payunique}) && length($options{payunique});
5016 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
5017 return $cpp_new_err if $cpp_new_err;
5019 my( $action1, $action2 ) =
5020 split( /\s*\,\s*/, $payment_gateway->gateway_action );
5022 my $transaction = new $namespace( $payment_gateway->gateway_module,
5023 $self->_bop_options(\%options),
5026 $transaction->content(
5027 'type' => $options{method},
5028 $self->_bop_auth(\%options),
5029 'action' => $action1,
5030 'description' => $options{'description'},
5031 'amount' => $options{amount},
5032 #'invoice_number' => $options{'invnum'},
5033 'customer_id' => $self->custnum,
5035 'reference' => $cust_pay_pending->paypendingnum, #for now
5040 $cust_pay_pending->status('pending');
5041 my $cpp_pending_err = $cust_pay_pending->replace;
5042 return $cpp_pending_err if $cpp_pending_err;
5045 my $BOP_TESTING = 0;
5046 my $BOP_TESTING_SUCCESS = 1;
5048 unless ( $BOP_TESTING ) {
5049 $transaction->submit();
5051 if ( $BOP_TESTING_SUCCESS ) {
5052 $transaction->is_success(1);
5053 $transaction->authorization('fake auth');
5055 $transaction->is_success(0);
5056 $transaction->error_message('fake failure');
5060 if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5062 return { reference => $cust_pay_pending->paypendingnum,
5063 map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
5065 } elsif ( $transaction->is_success() && $action2 ) {
5067 $cust_pay_pending->status('authorized');
5068 my $cpp_authorized_err = $cust_pay_pending->replace;
5069 return $cpp_authorized_err if $cpp_authorized_err;
5071 my $auth = $transaction->authorization;
5072 my $ordernum = $transaction->can('order_number')
5073 ? $transaction->order_number
5077 new Business::OnlinePayment( $payment_gateway->gateway_module,
5078 $self->_bop_options(\%options),
5083 type => $options{method},
5085 $self->_bop_auth(\%options),
5086 order_number => $ordernum,
5087 amount => $options{amount},
5088 authorization => $auth,
5089 description => $options{'description'},
5092 foreach my $field (qw( authorization_source_code returned_ACI
5093 transaction_identifier validation_code
5094 transaction_sequence_num local_transaction_date
5095 local_transaction_time AVS_result_code )) {
5096 $capture{$field} = $transaction->$field() if $transaction->can($field);
5099 $capture->content( %capture );
5103 unless ( $capture->is_success ) {
5104 my $e = "Authorization successful but capture failed, custnum #".
5105 $self->custnum. ': '. $capture->result_code.
5106 ": ". $capture->error_message;
5114 # remove paycvv after initial transaction
5117 #false laziness w/misc/process/payment.cgi - check both to make sure working
5119 if ( defined $self->dbdef_table->column('paycvv')
5120 && length($self->paycvv)
5121 && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
5123 my $error = $self->remove_cvv;
5125 warn "WARNING: error removing cvv: $error\n";
5133 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5145 if (ref($_[0]) eq 'HASH') {
5146 %options = %{$_[0]};
5148 my ( $method, $amount ) = ( shift, shift );
5150 $options{method} = $method;
5151 $options{amount} = $amount;
5154 if ( $options{'fake_failure'} ) {
5155 return "Error: No error; test failure requested with fake_failure";
5159 #if ( $payment_gateway->gatewaynum ) { # agent override
5160 # $paybatch = $payment_gateway->gatewaynum. '-';
5163 #$paybatch .= "$processor:". $transaction->authorization;
5165 #$paybatch .= ':'. $transaction->order_number
5166 # if $transaction->can('order_number')
5167 # && length($transaction->order_number);
5169 my $paybatch = 'FakeProcessor:54:32';
5171 my $cust_pay = new FS::cust_pay ( {
5172 'custnum' => $self->custnum,
5173 'invnum' => $options{'invnum'},
5174 'paid' => $options{amount},
5176 'payby' => $bop_method2payby{$options{method}},
5177 #'payinfo' => $payinfo,
5178 'payinfo' => '4111111111111111',
5179 'paybatch' => $paybatch,
5180 #'paydate' => $paydate,
5181 'paydate' => '2012-05-01',
5183 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
5185 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5188 $cust_pay->invnum(''); #try again with no specific invnum
5189 my $error2 = $cust_pay->insert( $options{'manual'} ?
5190 ( 'manual' => 1 ) : ()
5193 # gah, even with transactions.
5194 my $e = 'WARNING: Card/ACH debited but database not updated - '.
5195 "error inserting (fake!) payment: $error2".
5196 " (previously tried insert with invnum #$options{'invnum'}" .
5203 if ( $options{'paynum_ref'} ) {
5204 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5207 return ''; #no error
5212 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
5214 # Wraps up processing of a realtime credit card, ACH (electronic check) or
5215 # phone bill transaction.
5217 sub _realtime_bop_result {
5218 my( $self, $cust_pay_pending, $transaction, %options ) = @_;
5220 warn "$me _realtime_bop_result: pending transaction ".
5221 $cust_pay_pending->paypendingnum. "\n";
5222 warn " $_ => $options{$_}\n" foreach keys %options;
5225 my $payment_gateway = $options{payment_gateway}
5226 or return "no payment gateway in arguments to _realtime_bop_result";
5228 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
5229 my $cpp_captured_err = $cust_pay_pending->replace;
5230 return $cpp_captured_err if $cpp_captured_err;
5232 if ( $transaction->is_success() ) {
5235 if ( $payment_gateway->gatewaynum ) { # agent override
5236 $paybatch = $payment_gateway->gatewaynum. '-';
5239 $paybatch .= $payment_gateway->gateway_module. ":".
5240 $transaction->authorization;
5242 $paybatch .= ':'. $transaction->order_number
5243 if $transaction->can('order_number')
5244 && length($transaction->order_number);
5246 my $cust_pay = new FS::cust_pay ( {
5247 'custnum' => $self->custnum,
5248 'invnum' => $options{'invnum'},
5249 'paid' => $cust_pay_pending->paid,
5251 'payby' => $cust_pay_pending->payby,
5252 #'payinfo' => $payinfo,
5253 'paybatch' => $paybatch,
5254 'paydate' => $cust_pay_pending->paydate,
5255 'pkgnum' => $cust_pay_pending->pkgnum,
5257 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
5258 $cust_pay->payunique( $options{payunique} )
5259 if defined($options{payunique}) && length($options{payunique});
5261 my $oldAutoCommit = $FS::UID::AutoCommit;
5262 local $FS::UID::AutoCommit = 0;
5265 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
5267 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5270 $cust_pay->invnum(''); #try again with no specific invnum
5271 my $error2 = $cust_pay->insert( $options{'manual'} ?
5272 ( 'manual' => 1 ) : ()
5275 # gah. but at least we have a record of the state we had to abort in
5276 # from cust_pay_pending now.
5277 my $e = "WARNING: $options{method} captured but payment not recorded -".
5278 " error inserting payment (". $payment_gateway->gateway_module.
5280 " (previously tried insert with invnum #$options{'invnum'}" .
5281 ": $error ) - pending payment saved as paypendingnum ".
5282 $cust_pay_pending->paypendingnum. "\n";
5288 my $jobnum = $cust_pay_pending->jobnum;
5290 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5292 unless ( $placeholder ) {
5293 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5294 my $e = "WARNING: $options{method} captured but job $jobnum not ".
5295 "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
5300 $error = $placeholder->delete;
5303 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5304 my $e = "WARNING: $options{method} captured but could not delete ".
5305 "job $jobnum for paypendingnum ".
5306 $cust_pay_pending->paypendingnum. ": $error\n";
5313 if ( $options{'paynum_ref'} ) {
5314 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5317 $cust_pay_pending->status('done');
5318 $cust_pay_pending->statustext('captured');
5319 $cust_pay_pending->paynum($cust_pay->paynum);
5320 my $cpp_done_err = $cust_pay_pending->replace;
5322 if ( $cpp_done_err ) {
5324 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5325 my $e = "WARNING: $options{method} captured but payment not recorded - ".
5326 "error updating status for paypendingnum ".
5327 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5333 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5334 return ''; #no error
5340 my $perror = $payment_gateway->gateway_module. " error: ".
5341 $transaction->error_message;
5343 my $jobnum = $cust_pay_pending->jobnum;
5345 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5347 if ( $placeholder ) {
5348 my $error = $placeholder->depended_delete;
5349 $error ||= $placeholder->delete;
5350 warn "error removing provisioning jobs after declined paypendingnum ".
5351 $cust_pay_pending->paypendingnum. "\n";
5353 my $e = "error finding job $jobnum for declined paypendingnum ".
5354 $cust_pay_pending->paypendingnum. "\n";
5360 unless ( $transaction->error_message ) {
5363 if ( $transaction->can('response_page') ) {
5365 'page' => ( $transaction->can('response_page')
5366 ? $transaction->response_page
5369 'code' => ( $transaction->can('response_code')
5370 ? $transaction->response_code
5373 'headers' => ( $transaction->can('response_headers')
5374 ? $transaction->response_headers
5380 "No additional debugging information available for ".
5381 $payment_gateway->gateway_module;
5384 $perror .= "No error_message returned from ".
5385 $payment_gateway->gateway_module. " -- ".
5386 ( ref($t_response) ? Dumper($t_response) : $t_response );
5390 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
5391 && $conf->exists('emaildecline')
5392 && grep { $_ ne 'POST' } $self->invoicing_list
5393 && ! grep { $transaction->error_message =~ /$_/ }
5394 $conf->config('emaildecline-exclude')
5396 my @templ = $conf->config('declinetemplate');
5397 my $template = new Text::Template (
5399 SOURCE => [ map "$_\n", @templ ],
5400 ) or return "($perror) can't create template: $Text::Template::ERROR";
5401 $template->compile()
5402 or return "($perror) can't compile template: $Text::Template::ERROR";
5404 my $templ_hash = { error => $transaction->error_message };
5406 my $error = send_email(
5407 'from' => $conf->config('invoice_from', $self->agentnum ),
5408 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
5409 'subject' => 'Your payment could not be processed',
5410 'body' => [ $template->fill_in(HASH => $templ_hash) ],
5413 $perror .= " (also received error sending decline notification: $error)"
5418 $cust_pay_pending->status('done');
5419 $cust_pay_pending->statustext("declined: $perror");
5420 my $cpp_done_err = $cust_pay_pending->replace;
5421 if ( $cpp_done_err ) {
5422 my $e = "WARNING: $options{method} declined but pending payment not ".
5423 "resolved - error updating status for paypendingnum ".
5424 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5426 $perror = "$e ($perror)";
5434 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
5436 Verifies successful third party processing of a realtime credit card,
5437 ACH (electronic check) or phone bill transaction via a
5438 Business::OnlineThirdPartyPayment realtime gateway. See
5439 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5441 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
5443 The additional options I<payname>, I<city>, I<state>,
5444 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5445 if set, will override the value from the customer record.
5447 I<description> is a free-text field passed to the gateway. It defaults to
5448 "Internet services".
5450 If an I<invnum> is specified, this payment (if successful) is applied to the
5451 specified invoice. If you don't specify an I<invnum> you might want to
5452 call the B<apply_payments> method.
5454 I<quiet> can be set true to surpress email decline notices.
5456 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5457 resulting paynum, if any.
5459 I<payunique> is a unique identifier for this payment.
5461 Returns a hashref containing elements bill_error (which will be undefined
5462 upon success) and session_id of any associated session.
5466 sub realtime_botpp_capture {
5467 my( $self, $cust_pay_pending, %options ) = @_;
5469 warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
5470 warn " $_ => $options{$_}\n" foreach keys %options;
5473 eval "use Business::OnlineThirdPartyPayment";
5477 # select the gateway
5480 my $method = FS::payby->payby2bop($cust_pay_pending->payby);
5482 my $payment_gateway = $cust_pay_pending->gatewaynum
5483 ? qsearchs( 'payment_gateway',
5484 { gatewaynum => $cust_pay_pending->gatewaynum }
5486 : $self->agent->payment_gateway( 'method' => $method,
5487 # 'invnum' => $cust_pay_pending->invnum,
5488 # 'payinfo' => $cust_pay_pending->payinfo,
5491 $options{payment_gateway} = $payment_gateway; # for the helper subs
5497 my @invoicing_list = $self->invoicing_list_emailonly;
5498 if ( $conf->exists('emailinvoiceautoalways')
5499 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5500 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5501 push @invoicing_list, $self->all_emails;
5504 my $email = ($conf->exists('business-onlinepayment-email-override'))
5505 ? $conf->config('business-onlinepayment-email-override')
5506 : $invoicing_list[0];
5510 $content{email_customer} =
5511 ( $conf->exists('business-onlinepayment-email_customer')
5512 || $conf->exists('business-onlinepayment-email-override') );
5515 # run transaction(s)
5519 new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
5520 $self->_bop_options(\%options),
5523 $transaction->reference({ %options });
5525 $transaction->content(
5527 $self->_bop_auth(\%options),
5528 'action' => 'Post Authorization',
5529 'description' => $options{'description'},
5530 'amount' => $cust_pay_pending->paid,
5531 #'invoice_number' => $options{'invnum'},
5532 'customer_id' => $self->custnum,
5533 'referer' => 'http://cleanwhisker.420.am/',
5534 'reference' => $cust_pay_pending->paypendingnum,
5536 'phone' => $self->daytime || $self->night,
5538 # plus whatever is required for bogus capture avoidance
5541 $transaction->submit();
5544 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5547 bill_error => $error,
5548 session_id => $cust_pay_pending->session_id,
5553 =item default_payment_gateway DEPRECATED -- use agent->payment_gateway
5557 sub default_payment_gateway {
5558 my( $self, $method ) = @_;
5560 die "Real-time processing not enabled\n"
5561 unless $conf->exists('business-onlinepayment');
5563 #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
5566 my $bop_config = 'business-onlinepayment';
5567 $bop_config .= '-ach'
5568 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
5569 my ( $processor, $login, $password, $action, @bop_options ) =
5570 $conf->config($bop_config);
5571 $action ||= 'normal authorization';
5572 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
5573 die "No real-time processor is enabled - ".
5574 "did you set the business-onlinepayment configuration value?\n"
5577 ( $processor, $login, $password, $action, @bop_options )
5582 Removes the I<paycvv> field from the database directly.
5584 If there is an error, returns the error, otherwise returns false.
5590 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
5591 or return dbh->errstr;
5592 $sth->execute($self->custnum)
5593 or return $sth->errstr;
5598 =item _new_realtime_refund_bop METHOD [ OPTION => VALUE ... ]
5600 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
5601 via a Business::OnlinePayment realtime gateway. See
5602 L<http://420.am/business-onlinepayment> for supported gateways.
5604 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5606 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
5608 Most gateways require a reference to an original payment transaction to refund,
5609 so you probably need to specify a I<paynum>.
5611 I<amount> defaults to the original amount of the payment if not specified.
5613 I<reason> specifies a reason for the refund.
5615 I<paydate> specifies the expiration date for a credit card overriding the
5616 value from the customer record or the payment record. Specified as yyyy-mm-dd
5618 Implementation note: If I<amount> is unspecified or equal to the amount of the
5619 orignal payment, first an attempt is made to "void" the transaction via
5620 the gateway (to cancel a not-yet settled transaction) and then if that fails,
5621 the normal attempt is made to "refund" ("credit") the transaction via the
5622 gateway is attempted.
5624 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5625 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5626 #if set, will override the value from the customer record.
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.
5634 #some false laziness w/realtime_bop, not enough to make it worth merging
5635 #but some useful small subs should be pulled out
5636 sub _new_realtime_refund_bop {
5640 if (ref($_[0]) ne 'HASH') {
5641 %options = %{$_[0]};
5645 $options{method} = $method;
5649 warn "$me realtime_refund_bop (new): $options{method} refund\n";
5650 warn " $_ => $options{$_}\n" foreach keys %options;
5654 # look up the original payment and optionally a gateway for that payment
5658 my $amount = $options{'amount'};
5660 my( $processor, $login, $password, @bop_options, $namespace ) ;
5661 my( $auth, $order_number ) = ( '', '', '' );
5663 if ( $options{'paynum'} ) {
5665 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
5666 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
5667 or return "Unknown paynum $options{'paynum'}";
5668 $amount ||= $cust_pay->paid;
5670 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
5671 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
5672 $cust_pay->paybatch;
5673 my $gatewaynum = '';
5674 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
5676 if ( $gatewaynum ) { #gateway for the payment to be refunded
5678 my $payment_gateway =
5679 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
5680 die "payment gateway $gatewaynum not found"
5681 unless $payment_gateway;
5683 $processor = $payment_gateway->gateway_module;
5684 $login = $payment_gateway->gateway_username;
5685 $password = $payment_gateway->gateway_password;
5686 $namespace = $payment_gateway->gateway_namespace;
5687 @bop_options = $payment_gateway->options;
5689 } else { #try the default gateway
5692 my $payment_gateway =
5693 $self->agent->payment_gateway('method' => $options{method});
5695 ( $conf_processor, $login, $password, $namespace ) =
5696 map { my $method = "gateway_$_"; $payment_gateway->$method }
5697 qw( module username password namespace );
5699 @bop_options = $payment_gateway->gatewaynum
5700 ? $payment_gateway->options
5701 : @{ $payment_gateway->get('options') };
5703 return "processor of payment $options{'paynum'} $processor does not".
5704 " match default processor $conf_processor"
5705 unless $processor eq $conf_processor;
5710 } else { # didn't specify a paynum, so look for agent gateway overrides
5711 # like a normal transaction
5713 my $payment_gateway =
5714 $self->agent->payment_gateway( 'method' => $options{method},
5715 #'payinfo' => $payinfo,
5717 my( $processor, $login, $password, $namespace ) =
5718 map { my $method = "gateway_$_"; $payment_gateway->$method }
5719 qw( module username password namespace );
5721 my @bop_options = $payment_gateway->gatewaynum
5722 ? $payment_gateway->options
5723 : @{ $payment_gateway->get('options') };
5726 return "neither amount nor paynum specified" unless $amount;
5728 eval "use $namespace";
5732 'type' => $options{method},
5734 'password' => $password,
5735 'order_number' => $order_number,
5736 'amount' => $amount,
5737 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
5739 $content{authorization} = $auth
5740 if length($auth); #echeck/ACH transactions have an order # but no auth
5741 #(at least with authorize.net)
5743 my $disable_void_after;
5744 if ($conf->exists('disable_void_after')
5745 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
5746 $disable_void_after = $1;
5749 #first try void if applicable
5750 if ( $cust_pay && $cust_pay->paid == $amount
5752 ( not defined($disable_void_after) )
5753 || ( time < ($cust_pay->_date + $disable_void_after ) )
5756 warn " attempting void\n" if $DEBUG > 1;
5757 my $void = new Business::OnlinePayment( $processor, @bop_options );
5758 $void->content( 'action' => 'void', %content );
5760 if ( $void->is_success ) {
5761 my $error = $cust_pay->void($options{'reason'});
5763 # gah, even with transactions.
5764 my $e = 'WARNING: Card/ACH voided but database not updated - '.
5765 "error voiding payment: $error";
5769 warn " void successful\n" if $DEBUG > 1;
5774 warn " void unsuccessful, trying refund\n"
5778 my $address = $self->address1;
5779 $address .= ", ". $self->address2 if $self->address2;
5781 my($payname, $payfirst, $paylast);
5782 if ( $self->payname && $options{method} ne 'ECHECK' ) {
5783 $payname = $self->payname;
5784 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5785 or return "Illegal payname $payname";
5786 ($payfirst, $paylast) = ($1, $2);
5788 $payfirst = $self->getfield('first');
5789 $paylast = $self->getfield('last');
5790 $payname = "$payfirst $paylast";
5793 my @invoicing_list = $self->invoicing_list_emailonly;
5794 if ( $conf->exists('emailinvoiceautoalways')
5795 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5796 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5797 push @invoicing_list, $self->all_emails;
5800 my $email = ($conf->exists('business-onlinepayment-email-override'))
5801 ? $conf->config('business-onlinepayment-email-override')
5802 : $invoicing_list[0];
5804 my $payip = exists($options{'payip'})
5807 $content{customer_ip} = $payip
5811 if ( $options{method} eq 'CC' ) {
5814 $content{card_number} = $payinfo = $cust_pay->payinfo;
5815 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
5816 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
5817 ($content{expiration} = "$2/$1"); # where available
5819 $content{card_number} = $payinfo = $self->payinfo;
5820 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
5821 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
5822 $content{expiration} = "$2/$1";
5825 } elsif ( $options{method} eq 'ECHECK' ) {
5828 $payinfo = $cust_pay->payinfo;
5830 $payinfo = $self->payinfo;
5832 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
5833 $content{bank_name} = $self->payname;
5834 $content{account_type} = 'CHECKING';
5835 $content{account_name} = $payname;
5836 $content{customer_org} = $self->company ? 'B' : 'I';
5837 $content{customer_ssn} = $self->ss;
5838 } elsif ( $options{method} eq 'LEC' ) {
5839 $content{phone} = $payinfo = $self->payinfo;
5843 my $refund = new Business::OnlinePayment( $processor, @bop_options );
5844 my %sub_content = $refund->content(
5845 'action' => 'credit',
5846 'customer_id' => $self->custnum,
5847 'last_name' => $paylast,
5848 'first_name' => $payfirst,
5850 'address' => $address,
5851 'city' => $self->city,
5852 'state' => $self->state,
5853 'zip' => $self->zip,
5854 'country' => $self->country,
5856 'phone' => $self->daytime || $self->night,
5859 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
5863 return "$processor error: ". $refund->error_message
5864 unless $refund->is_success();
5866 my $paybatch = "$processor:". $refund->authorization;
5867 $paybatch .= ':'. $refund->order_number
5868 if $refund->can('order_number') && $refund->order_number;
5870 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
5871 my @cust_bill_pay = $cust_pay->cust_bill_pay;
5872 last unless @cust_bill_pay;
5873 my $cust_bill_pay = pop @cust_bill_pay;
5874 my $error = $cust_bill_pay->delete;
5878 my $cust_refund = new FS::cust_refund ( {
5879 'custnum' => $self->custnum,
5880 'paynum' => $options{'paynum'},
5881 'refund' => $amount,
5883 'payby' => $bop_method2payby{$options{method}},
5884 'payinfo' => $payinfo,
5885 'paybatch' => $paybatch,
5886 'reason' => $options{'reason'} || 'card or ACH refund',
5888 my $error = $cust_refund->insert;
5890 $cust_refund->paynum(''); #try again with no specific paynum
5891 my $error2 = $cust_refund->insert;
5893 # gah, even with transactions.
5894 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
5895 "error inserting refund ($processor): $error2".
5896 " (previously tried insert with paynum #$options{'paynum'}" .
5907 =item batch_card OPTION => VALUE...
5909 Adds a payment for this invoice to the pending credit card batch (see
5910 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
5911 runs the payment using a realtime gateway.
5916 my ($self, %options) = @_;
5919 if (exists($options{amount})) {
5920 $amount = $options{amount};
5922 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
5924 return '' unless $amount > 0;
5926 my $invnum = delete $options{invnum};
5927 my $payby = $options{invnum} || $self->payby; #dubious
5929 if ($options{'realtime'}) {
5930 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
5936 my $oldAutoCommit = $FS::UID::AutoCommit;
5937 local $FS::UID::AutoCommit = 0;
5940 #this needs to handle mysql as well as Pg, like svc_acct.pm
5941 #(make it into a common function if folks need to do batching with mysql)
5942 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
5943 or return "Cannot lock pay_batch: " . $dbh->errstr;
5947 'payby' => FS::payby->payby2payment($payby),
5950 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
5952 unless ( $pay_batch ) {
5953 $pay_batch = new FS::pay_batch \%pay_batch;
5954 my $error = $pay_batch->insert;
5956 $dbh->rollback if $oldAutoCommit;
5957 die "error creating new batch: $error\n";
5961 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
5962 'batchnum' => $pay_batch->batchnum,
5963 'custnum' => $self->custnum,
5966 foreach (qw( address1 address2 city state zip country payby payinfo paydate
5968 $options{$_} = '' unless exists($options{$_});
5971 my $cust_pay_batch = new FS::cust_pay_batch ( {
5972 'batchnum' => $pay_batch->batchnum,
5973 'invnum' => $invnum || 0, # is there a better value?
5974 # this field should be
5976 # cust_bill_pay_batch now
5977 'custnum' => $self->custnum,
5978 'last' => $self->getfield('last'),
5979 'first' => $self->getfield('first'),
5980 'address1' => $options{address1} || $self->address1,
5981 'address2' => $options{address2} || $self->address2,
5982 'city' => $options{city} || $self->city,
5983 'state' => $options{state} || $self->state,
5984 'zip' => $options{zip} || $self->zip,
5985 'country' => $options{country} || $self->country,
5986 'payby' => $options{payby} || $self->payby,
5987 'payinfo' => $options{payinfo} || $self->payinfo,
5988 'exp' => $options{paydate} || $self->paydate,
5989 'payname' => $options{payname} || $self->payname,
5990 'amount' => $amount, # consolidating
5993 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
5994 if $old_cust_pay_batch;
5997 if ($old_cust_pay_batch) {
5998 $error = $cust_pay_batch->replace($old_cust_pay_batch)
6000 $error = $cust_pay_batch->insert;
6004 $dbh->rollback if $oldAutoCommit;
6008 my $unapplied = $self->total_unapplied_credits
6009 + $self->total_unapplied_payments
6010 + $self->in_transit_payments;
6011 foreach my $cust_bill ($self->open_cust_bill) {
6012 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
6013 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
6014 'invnum' => $cust_bill->invnum,
6015 'paybatchnum' => $cust_pay_batch->paybatchnum,
6016 'amount' => $cust_bill->owed,
6019 if ($unapplied >= $cust_bill_pay_batch->amount){
6020 $unapplied -= $cust_bill_pay_batch->amount;
6023 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
6024 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
6026 $error = $cust_bill_pay_batch->insert;
6028 $dbh->rollback if $oldAutoCommit;
6033 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6037 =item apply_payments_and_credits
6039 Applies unapplied payments and credits.
6041 In most cases, this new method should be used in place of sequential
6042 apply_payments and apply_credits methods.
6044 If there is an error, returns the error, otherwise returns false.
6048 sub apply_payments_and_credits {
6051 local $SIG{HUP} = 'IGNORE';
6052 local $SIG{INT} = 'IGNORE';
6053 local $SIG{QUIT} = 'IGNORE';
6054 local $SIG{TERM} = 'IGNORE';
6055 local $SIG{TSTP} = 'IGNORE';
6056 local $SIG{PIPE} = 'IGNORE';
6058 my $oldAutoCommit = $FS::UID::AutoCommit;
6059 local $FS::UID::AutoCommit = 0;
6062 $self->select_for_update; #mutex
6064 foreach my $cust_bill ( $self->open_cust_bill ) {
6065 my $error = $cust_bill->apply_payments_and_credits;
6067 $dbh->rollback if $oldAutoCommit;
6068 return "Error applying: $error";
6072 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6077 =item apply_credits OPTION => VALUE ...
6079 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
6080 to outstanding invoice balances in chronological order (or reverse
6081 chronological order if the I<order> option is set to B<newest>) and returns the
6082 value of any remaining unapplied credits available for refund (see
6083 L<FS::cust_refund>).
6085 Dies if there is an error.
6093 local $SIG{HUP} = 'IGNORE';
6094 local $SIG{INT} = 'IGNORE';
6095 local $SIG{QUIT} = 'IGNORE';
6096 local $SIG{TERM} = 'IGNORE';
6097 local $SIG{TSTP} = 'IGNORE';
6098 local $SIG{PIPE} = 'IGNORE';
6100 my $oldAutoCommit = $FS::UID::AutoCommit;
6101 local $FS::UID::AutoCommit = 0;
6104 $self->select_for_update; #mutex
6106 unless ( $self->total_unapplied_credits ) {
6107 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6111 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
6112 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
6114 my @invoices = $self->open_cust_bill;
6115 @invoices = sort { $b->_date <=> $a->_date } @invoices
6116 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
6118 if ( $conf->exists('pkg-balances') ) {
6119 # limit @credits to those w/ a pkgnum grepped from $self
6121 foreach my $i (@invoices) {
6122 foreach my $li ( $i->cust_bill_pkg ) {
6123 $pkgnums{$li->pkgnum} = 1;
6126 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
6131 foreach my $cust_bill ( @invoices ) {
6133 if ( !defined($credit) || $credit->credited == 0) {
6134 $credit = pop @credits or last;
6138 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
6139 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
6141 $owed = $cust_bill->owed;
6143 unless ( $owed > 0 ) {
6144 push @credits, $credit;
6148 my $amount = min( $credit->credited, $owed );
6150 my $cust_credit_bill = new FS::cust_credit_bill ( {
6151 'crednum' => $credit->crednum,
6152 'invnum' => $cust_bill->invnum,
6153 'amount' => $amount,
6155 $cust_credit_bill->pkgnum( $credit->pkgnum )
6156 if $conf->exists('pkg-balances') && $credit->pkgnum;
6157 my $error = $cust_credit_bill->insert;
6159 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6163 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6167 my $total_unapplied_credits = $self->total_unapplied_credits;
6169 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6171 return $total_unapplied_credits;
6174 =item apply_payments
6176 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
6177 to outstanding invoice balances in chronological order.
6179 #and returns the value of any remaining unapplied payments.
6181 Dies if there is an error.
6185 sub apply_payments {
6188 local $SIG{HUP} = 'IGNORE';
6189 local $SIG{INT} = 'IGNORE';
6190 local $SIG{QUIT} = 'IGNORE';
6191 local $SIG{TERM} = 'IGNORE';
6192 local $SIG{TSTP} = 'IGNORE';
6193 local $SIG{PIPE} = 'IGNORE';
6195 my $oldAutoCommit = $FS::UID::AutoCommit;
6196 local $FS::UID::AutoCommit = 0;
6199 $self->select_for_update; #mutex
6203 my @payments = sort { $b->_date <=> $a->_date }
6204 grep { $_->unapplied > 0 }
6207 my @invoices = sort { $a->_date <=> $b->_date}
6208 grep { $_->owed > 0 }
6211 if ( $conf->exists('pkg-balances') ) {
6212 # limit @payments to those w/ a pkgnum grepped from $self
6214 foreach my $i (@invoices) {
6215 foreach my $li ( $i->cust_bill_pkg ) {
6216 $pkgnums{$li->pkgnum} = 1;
6219 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
6224 foreach my $cust_bill ( @invoices ) {
6226 if ( !defined($payment) || $payment->unapplied == 0 ) {
6227 $payment = pop @payments or last;
6231 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
6232 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
6234 $owed = $cust_bill->owed;
6236 unless ( $owed > 0 ) {
6237 push @payments, $payment;
6241 my $amount = min( $payment->unapplied, $owed );
6243 my $cust_bill_pay = new FS::cust_bill_pay ( {
6244 'paynum' => $payment->paynum,
6245 'invnum' => $cust_bill->invnum,
6246 'amount' => $amount,
6248 $cust_bill_pay->pkgnum( $payment->pkgnum )
6249 if $conf->exists('pkg-balances') && $payment->pkgnum;
6250 my $error = $cust_bill_pay->insert;
6252 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6256 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6260 my $total_unapplied_payments = $self->total_unapplied_payments;
6262 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6264 return $total_unapplied_payments;
6269 Returns the total owed for this customer on all invoices
6270 (see L<FS::cust_bill/owed>).
6276 $self->total_owed_date(2145859200); #12/31/2037
6279 =item total_owed_date TIME
6281 Returns the total owed for this customer on all invoices with date earlier than
6282 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6283 see L<Time::Local> and L<Date::Parse> for conversion functions.
6287 sub total_owed_date {
6291 # my $custnum = $self->custnum;
6293 # my $owed_sql = FS::cust_bill->owed_sql;
6296 # SELECT SUM($owed_sql) FROM cust_bill
6297 # WHERE custnum = $custnum
6298 # AND _date <= $time
6301 # my $sth = dbh->prepare($sql) or die dbh->errstr;
6302 # $sth->execute() or die $sth->errstr;
6304 # return sprintf( '%.2f', $sth->fetchrow_arrayref->[0] );
6307 foreach my $cust_bill (
6308 grep { $_->_date <= $time }
6309 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6311 $total_bill += $cust_bill->owed;
6313 sprintf( "%.2f", $total_bill );
6317 =item total_owed_pkgnum PKGNUM
6319 Returns the total owed on all invoices for this customer's specific package
6320 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
6324 sub total_owed_pkgnum {
6325 my( $self, $pkgnum ) = @_;
6326 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
6329 =item total_owed_date_pkgnum TIME PKGNUM
6331 Returns the total owed for this customer's specific package when using
6332 experimental package balances on all invoices with date earlier than
6333 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6334 see L<Time::Local> and L<Date::Parse> for conversion functions.
6338 sub total_owed_date_pkgnum {
6339 my( $self, $time, $pkgnum ) = @_;
6342 foreach my $cust_bill (
6343 grep { $_->_date <= $time }
6344 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6346 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
6348 sprintf( "%.2f", $total_bill );
6354 Returns the total amount of all payments.
6361 $total += $_->paid foreach $self->cust_pay;
6362 sprintf( "%.2f", $total );
6365 =item total_unapplied_credits
6367 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6368 customer. See L<FS::cust_credit/credited>.
6370 =item total_credited
6372 Old name for total_unapplied_credits. Don't use.
6376 sub total_credited {
6377 #carp "total_credited deprecated, use total_unapplied_credits";
6378 shift->total_unapplied_credits(@_);
6381 sub total_unapplied_credits {
6383 my $total_credit = 0;
6384 $total_credit += $_->credited foreach $self->cust_credit;
6385 sprintf( "%.2f", $total_credit );
6388 =item total_unapplied_credits_pkgnum PKGNUM
6390 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6391 customer. See L<FS::cust_credit/credited>.
6395 sub total_unapplied_credits_pkgnum {
6396 my( $self, $pkgnum ) = @_;
6397 my $total_credit = 0;
6398 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
6399 sprintf( "%.2f", $total_credit );
6403 =item total_unapplied_payments
6405 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
6406 See L<FS::cust_pay/unapplied>.
6410 sub total_unapplied_payments {
6412 my $total_unapplied = 0;
6413 $total_unapplied += $_->unapplied foreach $self->cust_pay;
6414 sprintf( "%.2f", $total_unapplied );
6417 =item total_unapplied_payments_pkgnum PKGNUM
6419 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
6420 specific package when using experimental package balances. See
6421 L<FS::cust_pay/unapplied>.
6425 sub total_unapplied_payments_pkgnum {
6426 my( $self, $pkgnum ) = @_;
6427 my $total_unapplied = 0;
6428 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
6429 sprintf( "%.2f", $total_unapplied );
6433 =item total_unapplied_refunds
6435 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
6436 customer. See L<FS::cust_refund/unapplied>.
6440 sub total_unapplied_refunds {
6442 my $total_unapplied = 0;
6443 $total_unapplied += $_->unapplied foreach $self->cust_refund;
6444 sprintf( "%.2f", $total_unapplied );
6449 Returns the balance for this customer (total_owed plus total_unrefunded, minus
6450 total_unapplied_credits minus total_unapplied_payments).
6458 + $self->total_unapplied_refunds
6459 - $self->total_unapplied_credits
6460 - $self->total_unapplied_payments
6464 =item balance_date TIME
6466 Returns the balance for this customer, only considering invoices with date
6467 earlier than TIME (total_owed_date minus total_credited minus
6468 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
6469 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
6478 $self->total_owed_date($time)
6479 + $self->total_unapplied_refunds
6480 - $self->total_unapplied_credits
6481 - $self->total_unapplied_payments
6485 =item balance_pkgnum PKGNUM
6487 Returns the balance for this customer's specific package when using
6488 experimental package balances (total_owed plus total_unrefunded, minus
6489 total_unapplied_credits minus total_unapplied_payments)
6493 sub balance_pkgnum {
6494 my( $self, $pkgnum ) = @_;
6497 $self->total_owed_pkgnum($pkgnum)
6498 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
6499 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
6500 - $self->total_unapplied_credits_pkgnum($pkgnum)
6501 - $self->total_unapplied_payments_pkgnum($pkgnum)
6505 =item in_transit_payments
6507 Returns the total of requests for payments for this customer pending in
6508 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
6512 sub in_transit_payments {
6514 my $in_transit_payments = 0;
6515 foreach my $pay_batch ( qsearch('pay_batch', {
6518 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
6519 'batchnum' => $pay_batch->batchnum,
6520 'custnum' => $self->custnum,
6522 $in_transit_payments += $cust_pay_batch->amount;
6525 sprintf( "%.2f", $in_transit_payments );
6530 Returns a hash of useful information for making a payment.
6540 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
6541 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
6542 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
6546 For credit card transactions:
6558 For electronic check transactions:
6573 $return{balance} = $self->balance;
6575 $return{payname} = $self->payname
6576 || ( $self->first. ' '. $self->get('last') );
6578 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
6580 $return{payby} = $self->payby;
6581 $return{stateid_state} = $self->stateid_state;
6583 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
6584 $return{card_type} = cardtype($self->payinfo);
6585 $return{payinfo} = $self->paymask;
6587 @return{'month', 'year'} = $self->paydate_monthyear;
6591 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
6592 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
6593 $return{payinfo1} = $payinfo1;
6594 $return{payinfo2} = $payinfo2;
6595 $return{paytype} = $self->paytype;
6596 $return{paystate} = $self->paystate;
6600 #doubleclick protection
6602 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
6608 =item paydate_monthyear
6610 Returns a two-element list consisting of the month and year of this customer's
6611 paydate (credit card expiration date for CARD customers)
6615 sub paydate_monthyear {
6617 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
6619 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
6626 =item tax_exemption TAXNAME
6631 my( $self, $taxname ) = @_;
6633 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
6634 'taxname' => $taxname,
6639 =item cust_main_exemption
6643 sub cust_main_exemption {
6645 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
6648 =item invoicing_list [ ARRAYREF ]
6650 If an arguement is given, sets these email addresses as invoice recipients
6651 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
6652 (except as warnings), so use check_invoicing_list first.
6654 Returns a list of email addresses (with svcnum entries expanded).
6656 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
6657 check it without disturbing anything by passing nothing.
6659 This interface may change in the future.
6663 sub invoicing_list {
6664 my( $self, $arrayref ) = @_;
6667 my @cust_main_invoice;
6668 if ( $self->custnum ) {
6669 @cust_main_invoice =
6670 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6672 @cust_main_invoice = ();
6674 foreach my $cust_main_invoice ( @cust_main_invoice ) {
6675 #warn $cust_main_invoice->destnum;
6676 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
6677 #warn $cust_main_invoice->destnum;
6678 my $error = $cust_main_invoice->delete;
6679 warn $error if $error;
6682 if ( $self->custnum ) {
6683 @cust_main_invoice =
6684 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6686 @cust_main_invoice = ();
6688 my %seen = map { $_->address => 1 } @cust_main_invoice;
6689 foreach my $address ( @{$arrayref} ) {
6690 next if exists $seen{$address} && $seen{$address};
6691 $seen{$address} = 1;
6692 my $cust_main_invoice = new FS::cust_main_invoice ( {
6693 'custnum' => $self->custnum,
6696 my $error = $cust_main_invoice->insert;
6697 warn $error if $error;
6701 if ( $self->custnum ) {
6703 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6710 =item check_invoicing_list ARRAYREF
6712 Checks these arguements as valid input for the invoicing_list method. If there
6713 is an error, returns the error, otherwise returns false.
6717 sub check_invoicing_list {
6718 my( $self, $arrayref ) = @_;
6720 foreach my $address ( @$arrayref ) {
6722 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
6723 return 'Can\'t add FAX invoice destination with a blank FAX number.';
6726 my $cust_main_invoice = new FS::cust_main_invoice ( {
6727 'custnum' => $self->custnum,
6730 my $error = $self->custnum
6731 ? $cust_main_invoice->check
6732 : $cust_main_invoice->checkdest
6734 return $error if $error;
6738 return "Email address required"
6739 if $conf->exists('cust_main-require_invoicing_list_email')
6740 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
6745 =item set_default_invoicing_list
6747 Sets the invoicing list to all accounts associated with this customer,
6748 overwriting any previous invoicing list.
6752 sub set_default_invoicing_list {
6754 $self->invoicing_list($self->all_emails);
6759 Returns the email addresses of all accounts provisioned for this customer.
6766 foreach my $cust_pkg ( $self->all_pkgs ) {
6767 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
6769 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
6770 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
6772 $list{$_}=1 foreach map { $_->email } @svc_acct;
6777 =item invoicing_list_addpost
6779 Adds postal invoicing to this customer. If this customer is already configured
6780 to receive postal invoices, does nothing.
6784 sub invoicing_list_addpost {
6786 return if grep { $_ eq 'POST' } $self->invoicing_list;
6787 my @invoicing_list = $self->invoicing_list;
6788 push @invoicing_list, 'POST';
6789 $self->invoicing_list(\@invoicing_list);
6792 =item invoicing_list_emailonly
6794 Returns the list of email invoice recipients (invoicing_list without non-email
6795 destinations such as POST and FAX).
6799 sub invoicing_list_emailonly {
6801 warn "$me invoicing_list_emailonly called"
6803 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
6806 =item invoicing_list_emailonly_scalar
6808 Returns the list of email invoice recipients (invoicing_list without non-email
6809 destinations such as POST and FAX) as a comma-separated scalar.
6813 sub invoicing_list_emailonly_scalar {
6815 warn "$me invoicing_list_emailonly_scalar called"
6817 join(', ', $self->invoicing_list_emailonly);
6820 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
6822 Returns an array of customers referred by this customer (referral_custnum set
6823 to this custnum). If DEPTH is given, recurses up to the given depth, returning
6824 customers referred by customers referred by this customer and so on, inclusive.
6825 The default behavior is DEPTH 1 (no recursion).
6829 sub referral_cust_main {
6831 my $depth = @_ ? shift : 1;
6832 my $exclude = @_ ? shift : {};
6835 map { $exclude->{$_->custnum}++; $_; }
6836 grep { ! $exclude->{ $_->custnum } }
6837 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
6841 map { $_->referral_cust_main($depth-1, $exclude) }
6848 =item referral_cust_main_ncancelled
6850 Same as referral_cust_main, except only returns customers with uncancelled
6855 sub referral_cust_main_ncancelled {
6857 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
6860 =item referral_cust_pkg [ DEPTH ]
6862 Like referral_cust_main, except returns a flat list of all unsuspended (and
6863 uncancelled) packages for each customer. The number of items in this list may
6864 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
6868 sub referral_cust_pkg {
6870 my $depth = @_ ? shift : 1;
6872 map { $_->unsuspended_pkgs }
6873 grep { $_->unsuspended_pkgs }
6874 $self->referral_cust_main($depth);
6877 =item referring_cust_main
6879 Returns the single cust_main record for the customer who referred this customer
6880 (referral_custnum), or false.
6884 sub referring_cust_main {
6886 return '' unless $self->referral_custnum;
6887 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
6890 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
6892 Applies a credit to this customer. If there is an error, returns the error,
6893 otherwise returns false.
6895 REASON can be a text string, an FS::reason object, or a scalar reference to
6896 a reasonnum. If a text string, it will be automatically inserted as a new
6897 reason, and a 'reason_type' option must be passed to indicate the
6898 FS::reason_type for the new reason.
6900 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
6902 Any other options are passed to FS::cust_credit::insert.
6907 my( $self, $amount, $reason, %options ) = @_;
6909 my $cust_credit = new FS::cust_credit {
6910 'custnum' => $self->custnum,
6911 'amount' => $amount,
6914 if ( ref($reason) ) {
6916 if ( ref($reason) eq 'SCALAR' ) {
6917 $cust_credit->reasonnum( $$reason );
6919 $cust_credit->reasonnum( $reason->reasonnum );
6923 $cust_credit->set('reason', $reason)
6926 $cust_credit->addlinfo( delete $options{'addlinfo'} )
6927 if exists($options{'addlinfo'});
6929 $cust_credit->insert(%options);
6933 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
6935 Creates a one-time charge for this customer. If there is an error, returns
6936 the error, otherwise returns false.
6938 New-style, with a hashref of options:
6940 my $error = $cust_main->charge(
6944 'start_date' => str2time('7/4/2009'),
6945 'pkg' => 'Description',
6946 'comment' => 'Comment',
6947 'additional' => [], #extra invoice detail
6948 'classnum' => 1, #pkg_class
6950 'setuptax' => '', # or 'Y' for tax exempt
6953 'taxclass' => 'Tax class',
6956 'taxproduct' => 2, #part_pkg_taxproduct
6957 'override' => {}, #XXX describe
6963 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
6969 my ( $amount, $quantity, $start_date, $classnum );
6970 my ( $pkg, $comment, $additional );
6971 my ( $setuptax, $taxclass ); #internal taxes
6972 my ( $taxproduct, $override ); #vendor (CCH) taxes
6973 if ( ref( $_[0] ) ) {
6974 $amount = $_[0]->{amount};
6975 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
6976 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
6977 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
6978 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
6979 : '$'. sprintf("%.2f",$amount);
6980 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
6981 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
6982 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
6983 $additional = $_[0]->{additional} || [];
6984 $taxproduct = $_[0]->{taxproductnum};
6985 $override = { '' => $_[0]->{tax_override} };
6990 $pkg = @_ ? shift : 'One-time charge';
6991 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
6993 $taxclass = @_ ? shift : '';
6997 local $SIG{HUP} = 'IGNORE';
6998 local $SIG{INT} = 'IGNORE';
6999 local $SIG{QUIT} = 'IGNORE';
7000 local $SIG{TERM} = 'IGNORE';
7001 local $SIG{TSTP} = 'IGNORE';
7002 local $SIG{PIPE} = 'IGNORE';
7004 my $oldAutoCommit = $FS::UID::AutoCommit;
7005 local $FS::UID::AutoCommit = 0;
7008 my $part_pkg = new FS::part_pkg ( {
7010 'comment' => $comment,
7014 'classnum' => $classnum ? $classnum : '',
7015 'setuptax' => $setuptax,
7016 'taxclass' => $taxclass,
7017 'taxproductnum' => $taxproduct,
7020 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
7021 ( 0 .. @$additional - 1 )
7023 'additional_count' => scalar(@$additional),
7024 'setup_fee' => $amount,
7027 my $error = $part_pkg->insert( options => \%options,
7028 tax_overrides => $override,
7031 $dbh->rollback if $oldAutoCommit;
7035 my $pkgpart = $part_pkg->pkgpart;
7036 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
7037 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
7038 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
7039 $error = $type_pkgs->insert;
7041 $dbh->rollback if $oldAutoCommit;
7046 my $cust_pkg = new FS::cust_pkg ( {
7047 'custnum' => $self->custnum,
7048 'pkgpart' => $pkgpart,
7049 'quantity' => $quantity,
7050 'start_date' => $start_date,
7053 $error = $cust_pkg->insert;
7055 $dbh->rollback if $oldAutoCommit;
7059 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
7064 #=item charge_postal_fee
7066 #Applies a one time charge this customer. If there is an error,
7067 #returns the error, returns the cust_pkg charge object or false
7068 #if there was no charge.
7072 # This should be a customer event. For that to work requires that bill
7073 # also be a customer event.
7075 sub charge_postal_fee {
7078 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
7079 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
7081 my $cust_pkg = new FS::cust_pkg ( {
7082 'custnum' => $self->custnum,
7083 'pkgpart' => $pkgpart,
7087 my $error = $cust_pkg->insert;
7088 $error ? $error : $cust_pkg;
7093 Returns all the invoices (see L<FS::cust_bill>) for this customer.
7099 sort { $a->_date <=> $b->_date }
7100 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
7103 =item open_cust_bill
7105 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
7110 sub open_cust_bill {
7114 'table' => 'cust_bill',
7115 'hashref' => { 'custnum' => $self->custnum, },
7116 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
7117 'order_by' => 'ORDER BY _date ASC',
7124 Returns all the credits (see L<FS::cust_credit>) for this customer.
7130 sort { $a->_date <=> $b->_date }
7131 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
7134 =item cust_credit_pkgnum
7136 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
7137 package when using experimental package balances.
7141 sub cust_credit_pkgnum {
7142 my( $self, $pkgnum ) = @_;
7143 sort { $a->_date <=> $b->_date }
7144 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
7145 'pkgnum' => $pkgnum,
7152 Returns all the payments (see L<FS::cust_pay>) for this customer.
7158 sort { $a->_date <=> $b->_date }
7159 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
7162 =item cust_pay_pkgnum
7164 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
7165 package when using experimental package balances.
7169 sub cust_pay_pkgnum {
7170 my( $self, $pkgnum ) = @_;
7171 sort { $a->_date <=> $b->_date }
7172 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
7173 'pkgnum' => $pkgnum,
7180 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
7186 sort { $a->_date <=> $b->_date }
7187 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
7190 =item cust_pay_batch
7192 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
7196 sub cust_pay_batch {
7198 sort { $a->paybatchnum <=> $b->paybatchnum }
7199 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
7202 =item cust_pay_pending
7204 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
7205 (without status "done").
7209 sub cust_pay_pending {
7211 return $self->num_cust_pay_pending unless wantarray;
7212 sort { $a->_date <=> $b->_date }
7213 qsearch( 'cust_pay_pending', {
7214 'custnum' => $self->custnum,
7215 'status' => { op=>'!=', value=>'done' },
7220 =item num_cust_pay_pending
7222 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
7223 customer (without status "done"). Also called automatically when the
7224 cust_pay_pending method is used in a scalar context.
7228 sub num_cust_pay_pending {
7230 my $sql = " SELECT COUNT(*) FROM cust_pay_pending ".
7231 " WHERE custnum = ? AND status != 'done' ";
7232 my $sth = dbh->prepare($sql) or die dbh->errstr;
7233 $sth->execute($self->custnum) or die $sth->errstr;
7234 $sth->fetchrow_arrayref->[0];
7239 Returns all the refunds (see L<FS::cust_refund>) for this customer.
7245 sort { $a->_date <=> $b->_date }
7246 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
7249 =item display_custnum
7251 Returns the displayed customer number for this customer: agent_custid if
7252 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
7256 sub display_custnum {
7258 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
7259 return $self->agent_custid;
7261 return $self->custnum;
7267 Returns a name string for this customer, either "Company (Last, First)" or
7274 my $name = $self->contact;
7275 $name = $self->company. " ($name)" if $self->company;
7281 Returns a name string for this (service/shipping) contact, either
7282 "Company (Last, First)" or "Last, First".
7288 if ( $self->get('ship_last') ) {
7289 my $name = $self->ship_contact;
7290 $name = $self->ship_company. " ($name)" if $self->ship_company;
7299 Returns a name string for this customer, either "Company" or "First Last".
7305 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
7308 =item ship_name_short
7310 Returns a name string for this (service/shipping) contact, either "Company"
7315 sub ship_name_short {
7317 if ( $self->get('ship_last') ) {
7318 $self->ship_company !~ /^\s*$/
7319 ? $self->ship_company
7320 : $self->ship_contact_firstlast;
7322 $self->name_company_or_firstlast;
7328 Returns this customer's full (billing) contact name only, "Last, First"
7334 $self->get('last'). ', '. $self->first;
7339 Returns this customer's full (shipping) contact name only, "Last, First"
7345 $self->get('ship_last')
7346 ? $self->get('ship_last'). ', '. $self->ship_first
7350 =item contact_firstlast
7352 Returns this customers full (billing) contact name only, "First Last".
7356 sub contact_firstlast {
7358 $self->first. ' '. $self->get('last');
7361 =item ship_contact_firstlast
7363 Returns this customer's full (shipping) contact name only, "First Last".
7367 sub ship_contact_firstlast {
7369 $self->get('ship_last')
7370 ? $self->first. ' '. $self->get('ship_last')
7371 : $self->contact_firstlast;
7376 Returns this customer's full country name
7382 code2country($self->country);
7385 =item geocode DATA_VENDOR
7387 Returns a value for the customer location as encoded by DATA_VENDOR.
7388 Currently this only makes sense for "CCH" as DATA_VENDOR.
7393 my ($self, $data_vendor) = (shift, shift); #always cch for now
7395 my $geocode = $self->get('geocode'); #XXX only one data_vendor for geocode
7396 return $geocode if $geocode;
7398 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
7402 my ($zip,$plus4) = split /-/, $self->get("${prefix}zip")
7403 if $self->country eq 'US';
7405 #CCH specific location stuff
7406 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
7408 my @cust_tax_location =
7410 'table' => 'cust_tax_location',
7411 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
7412 'extra_sql' => $extra_sql,
7413 'order_by' => 'ORDER BY plus4hi',#overlapping with distinct ends
7416 $geocode = $cust_tax_location[0]->geocode
7417 if scalar(@cust_tax_location);
7426 Returns a status string for this customer, currently:
7430 =item prospect - No packages have ever been ordered
7432 =item active - One or more recurring packages is active
7434 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
7436 =item suspended - All non-cancelled recurring packages are suspended
7438 =item cancelled - All recurring packages are cancelled
7444 sub status { shift->cust_status(@_); }
7448 for my $status (qw( prospect active inactive suspended cancelled )) {
7449 my $method = $status.'_sql';
7450 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
7451 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
7452 $sth->execute( ($self->custnum) x $numnum )
7453 or die "Error executing 'SELECT $sql': ". $sth->errstr;
7454 return $status if $sth->fetchrow_arrayref->[0];
7458 =item ucfirst_cust_status
7460 =item ucfirst_status
7462 Returns the status with the first character capitalized.
7466 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
7468 sub ucfirst_cust_status {
7470 ucfirst($self->cust_status);
7475 Returns a hex triplet color string for this customer's status.
7479 use vars qw(%statuscolor);
7480 tie %statuscolor, 'Tie::IxHash',
7481 'prospect' => '7e0079', #'000000', #black? naw, purple
7482 'active' => '00CC00', #green
7483 'inactive' => '0000CC', #blue
7484 'suspended' => 'FF9900', #yellow
7485 'cancelled' => 'FF0000', #red
7488 sub statuscolor { shift->cust_statuscolor(@_); }
7490 sub cust_statuscolor {
7492 $statuscolor{$self->cust_status};
7497 Returns an array of hashes representing the customer's RT tickets.
7504 my $num = $conf->config('cust_main-max_tickets') || 10;
7507 if ( $conf->config('ticket_system') ) {
7508 unless ( $conf->config('ticket_system-custom_priority_field') ) {
7510 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
7514 foreach my $priority (
7515 $conf->config('ticket_system-custom_priority_field-values'), ''
7517 last if scalar(@tickets) >= $num;
7519 @{ FS::TicketSystem->customer_tickets( $self->custnum,
7520 $num - scalar(@tickets),
7530 # Return services representing svc_accts in customer support packages
7531 sub support_services {
7533 my %packages = map { $_ => 1 } $conf->config('support_packages');
7535 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
7536 grep { $_->part_svc->svcdb eq 'svc_acct' }
7537 map { $_->cust_svc }
7538 grep { exists $packages{ $_->pkgpart } }
7539 $self->ncancelled_pkgs;
7543 # Return a list of latitude/longitude for one of the services (if any)
7544 sub service_coordinates {
7548 grep { $_->latitude && $_->longitude }
7550 map { $_->cust_svc }
7551 $self->ncancelled_pkgs;
7553 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
7558 =head1 CLASS METHODS
7564 Class method that returns the list of possible status strings for customers
7565 (see L<the status method|/status>). For example:
7567 @statuses = FS::cust_main->statuses();
7572 #my $self = shift; #could be class...
7578 Returns an SQL expression identifying prospective cust_main records (customers
7579 with no packages ever ordered)
7583 use vars qw($select_count_pkgs);
7584 $select_count_pkgs =
7585 "SELECT COUNT(*) FROM cust_pkg
7586 WHERE cust_pkg.custnum = cust_main.custnum";
7588 sub select_count_pkgs_sql {
7592 sub prospect_sql { "
7593 0 = ( $select_count_pkgs )
7598 Returns an SQL expression identifying active cust_main records (customers with
7599 active recurring packages).
7604 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
7610 Returns an SQL expression identifying inactive cust_main records (customers with
7611 no active recurring packages, but otherwise unsuspended/uncancelled).
7615 sub inactive_sql { "
7616 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
7618 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
7624 Returns an SQL expression identifying suspended cust_main records.
7629 sub suspended_sql { susp_sql(@_); }
7631 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
7633 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
7639 Returns an SQL expression identifying cancelled cust_main records.
7643 sub cancelled_sql { cancel_sql(@_); }
7646 my $recurring_sql = FS::cust_pkg->recurring_sql;
7647 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
7650 0 < ( $select_count_pkgs )
7651 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
7652 AND 0 = ( $select_count_pkgs AND $recurring_sql
7653 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
7655 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
7661 =item uncancelled_sql
7663 Returns an SQL expression identifying un-cancelled cust_main records.
7667 sub uncancelled_sql { uncancel_sql(@_); }
7668 sub uncancel_sql { "
7669 ( 0 < ( $select_count_pkgs
7670 AND ( cust_pkg.cancel IS NULL
7671 OR cust_pkg.cancel = 0
7674 OR 0 = ( $select_count_pkgs )
7680 Returns an SQL fragment to retreive the balance.
7685 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
7686 WHERE cust_bill.custnum = cust_main.custnum )
7687 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
7688 WHERE cust_pay.custnum = cust_main.custnum )
7689 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
7690 WHERE cust_credit.custnum = cust_main.custnum )
7691 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
7692 WHERE cust_refund.custnum = cust_main.custnum )
7695 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
7697 Returns an SQL fragment to retreive the balance for this customer, only
7698 considering invoices with date earlier than START_TIME, and optionally not
7699 later than END_TIME (total_owed_date minus total_unapplied_credits minus
7700 total_unapplied_payments).
7702 Times are specified as SQL fragments or numeric
7703 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
7704 L<Date::Parse> for conversion functions. The empty string can be passed
7705 to disable that time constraint completely.
7707 Available options are:
7711 =item unapplied_date
7713 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)
7718 set to true to remove all customer comparison clauses, for totals
7723 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
7728 JOIN clause (typically used with the total option)
7734 sub balance_date_sql {
7735 my( $class, $start, $end, %opt ) = @_;
7737 my $owed = FS::cust_bill->owed_sql;
7738 my $unapp_refund = FS::cust_refund->unapplied_sql;
7739 my $unapp_credit = FS::cust_credit->unapplied_sql;
7740 my $unapp_pay = FS::cust_pay->unapplied_sql;
7742 my $j = $opt{'join'} || '';
7744 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
7745 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
7746 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
7747 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
7749 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
7750 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
7751 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
7752 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
7757 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
7759 Returns an SQL fragment to retreive the total unapplied payments for this
7760 customer, only considering invoices with date earlier than START_TIME, and
7761 optionally not later than END_TIME.
7763 Times are specified as SQL fragments or numeric
7764 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
7765 L<Date::Parse> for conversion functions. The empty string can be passed
7766 to disable that time constraint completely.
7768 Available options are:
7772 sub unapplied_payments_date_sql {
7773 my( $class, $start, $end, ) = @_;
7775 my $unapp_pay = FS::cust_pay->unapplied_sql;
7777 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
7778 'unapplied_date'=>1 );
7780 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
7783 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
7785 Helper method for balance_date_sql; name (and usage) subject to change
7786 (suggestions welcome).
7788 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
7789 cust_refund, cust_credit or cust_pay).
7791 If TABLE is "cust_bill" or the unapplied_date option is true, only
7792 considers records with date earlier than START_TIME, and optionally not
7793 later than END_TIME .
7797 sub _money_table_where {
7798 my( $class, $table, $start, $end, %opt ) = @_;
7801 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
7802 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
7803 push @where, "$table._date <= $start" if defined($start) && length($start);
7804 push @where, "$table._date > $end" if defined($end) && length($end);
7806 push @where, @{$opt{'where'}} if $opt{'where'};
7807 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
7813 =item search_sql HASHREF
7817 Returns a qsearch hash expression to search for parameters specified in HREF.
7818 Valid parameters are
7826 =item cancelled_pkgs
7832 listref of start date, end date
7838 =item current_balance
7840 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
7844 =item flattened_pkgs
7853 my ($class, $params) = @_;
7864 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
7866 "cust_main.agentnum = $1";
7873 #prospect active inactive suspended cancelled
7874 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
7875 my $method = $params->{'status'}. '_sql';
7876 #push @where, $class->$method();
7877 push @where, FS::cust_main->$method();
7881 # parse cancelled package checkbox
7886 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
7887 unless $params->{'cancelled_pkgs'};
7890 # parse without census tract checkbox
7893 push @where, "(censustract = '' or censustract is null)"
7894 if $params->{'no_censustract'};
7900 foreach my $field (qw( signupdate )) {
7902 next unless exists($params->{$field});
7904 my($beginning, $ending) = @{$params->{$field}};
7907 "cust_main.$field IS NOT NULL",
7908 "cust_main.$field >= $beginning",
7909 "cust_main.$field <= $ending";
7911 $orderby ||= "ORDER BY cust_main.$field";
7919 my @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
7921 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )';
7928 #my $balance_sql = $class->balance_sql();
7929 my $balance_sql = FS::cust_main->balance_sql();
7931 push @where, map { s/current_balance/$balance_sql/; $_ }
7932 @{ $params->{'current_balance'} };
7938 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
7940 "cust_main.custbatch = '$1'";
7944 # setup queries, subs, etc. for the search
7947 $orderby ||= 'ORDER BY custnum';
7949 # here is the agent virtualization
7950 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
7952 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
7954 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
7956 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
7958 my $select = join(', ',
7959 'cust_main.custnum',
7960 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
7963 my(@extra_headers) = ();
7964 my(@extra_fields) = ();
7966 if ($params->{'flattened_pkgs'}) {
7968 if ($dbh->{Driver}->{Name} eq 'Pg') {
7970 $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";
7972 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
7973 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
7974 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
7976 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
7977 "omitting packing information from report.";
7980 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";
7982 my $sth = dbh->prepare($header_query) or die dbh->errstr;
7983 $sth->execute() or die $sth->errstr;
7984 my $headerrow = $sth->fetchrow_arrayref;
7985 my $headercount = $headerrow ? $headerrow->[0] : 0;
7986 while($headercount) {
7987 unshift @extra_headers, "Package ". $headercount;
7988 unshift @extra_fields, eval q!sub {my $c = shift;
7989 my @a = split '\|', $c->magic;
7990 my $p = $a[!.--$headercount. q!];
7998 'table' => 'cust_main',
7999 'select' => $select,
8001 'extra_sql' => $extra_sql,
8002 'order_by' => $orderby,
8003 'count_query' => $count_query,
8004 'extra_headers' => \@extra_headers,
8005 'extra_fields' => \@extra_fields,
8010 =item email_search_sql HASHREF
8014 Emails a notice to the specified customers.
8016 Valid parameters are those of the L<search_sql> method, plus the following:
8038 Optional job queue job for status updates.
8042 Returns an error message, or false for success.
8044 If an error occurs during any email, stops the enture send and returns that
8045 error. Presumably if you're getting SMTP errors aborting is better than
8046 retrying everything.
8050 sub email_search_sql {
8051 my($class, $params) = @_;
8053 my $from = delete $params->{from};
8054 my $subject = delete $params->{subject};
8055 my $html_body = delete $params->{html_body};
8056 my $text_body = delete $params->{text_body};
8058 my $job = delete $params->{'job'};
8060 my $sql_query = $class->search_sql($params);
8062 my $count_query = delete($sql_query->{'count_query'});
8063 my $count_sth = dbh->prepare($count_query)
8064 or die "Error preparing $count_query: ". dbh->errstr;
8066 or die "Error executing $count_query: ". $count_sth->errstr;
8067 my $count_arrayref = $count_sth->fetchrow_arrayref;
8068 my $num_cust = $count_arrayref->[0];
8070 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
8071 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
8074 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
8076 #eventually order+limit magic to reduce memory use?
8077 foreach my $cust_main ( qsearch($sql_query) ) {
8079 my $to = $cust_main->invoicing_list_emailonly_scalar;
8082 my $error = send_email(
8086 'subject' => $subject,
8087 'html_body' => $html_body,
8088 'text_body' => $text_body,
8091 return $error if $error;
8093 if ( $job ) { #progressbar foo
8095 if ( time - $min_sec > $last ) {
8096 my $error = $job->update_statustext(
8097 int( 100 * $num / $num_cust )
8099 die $error if $error;
8109 use Storable qw(thaw);
8112 sub process_email_search_sql {
8114 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
8116 my $param = thaw(decode_base64(shift));
8117 warn Dumper($param) if $DEBUG;
8119 $param->{'job'} = $job;
8121 my $error = FS::cust_main->email_search_sql( $param );
8122 die $error if $error;
8126 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
8128 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
8129 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
8130 appropriate ship_ field is also searched).
8132 Additional options are the same as FS::Record::qsearch
8137 my( $self, $fuzzy, $hash, @opt) = @_;
8142 check_and_rebuild_fuzzyfiles();
8143 foreach my $field ( keys %$fuzzy ) {
8145 my $all = $self->all_X($field);
8146 next unless scalar(@$all);
8149 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
8152 foreach ( keys %match ) {
8153 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
8154 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
8157 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
8160 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
8162 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
8170 Returns a masked version of the named field
8175 my ($self,$field) = @_;
8179 'x'x(length($self->getfield($field))-4).
8180 substr($self->getfield($field), (length($self->getfield($field))-4));
8190 =item smart_search OPTION => VALUE ...
8192 Accepts the following options: I<search>, the string to search for. The string
8193 will be searched for as a customer number, phone number, name or company name,
8194 as an exact, or, in some cases, a substring or fuzzy match (see the source code
8195 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
8196 skip fuzzy matching when an exact match is found.
8198 Any additional options are treated as an additional qualifier on the search
8201 Returns a (possibly empty) array of FS::cust_main objects.
8208 #here is the agent virtualization
8209 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8213 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
8214 my $search = delete $options{'search'};
8215 ( my $alphanum_search = $search ) =~ s/\W//g;
8217 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
8219 #false laziness w/Record::ut_phone
8220 my $phonen = "$1-$2-$3";
8221 $phonen .= " x$4" if $4;
8223 push @cust_main, qsearch( {
8224 'table' => 'cust_main',
8225 'hashref' => { %options },
8226 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8228 join(' OR ', map "$_ = '$phonen'",
8229 qw( daytime night fax
8230 ship_daytime ship_night ship_fax )
8233 " AND $agentnums_sql", #agent virtualization
8236 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
8237 #try looking for matches with extensions unless one was specified
8239 push @cust_main, qsearch( {
8240 'table' => 'cust_main',
8241 'hashref' => { %options },
8242 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8244 join(' OR ', map "$_ LIKE '$phonen\%'",
8246 ship_daytime ship_night )
8249 " AND $agentnums_sql", #agent virtualization
8254 # custnum search (also try agent_custid), with some tweaking options if your
8255 # legacy cust "numbers" have letters
8258 if ( $search =~ /^\s*(\d+)\s*$/
8259 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
8260 && $search =~ /^\s*(\w\w?\d+)\s*$/
8267 if ( $num <= 2147483647 ) { #need a bigint custnum? wow.
8268 push @cust_main, qsearch( {
8269 'table' => 'cust_main',
8270 'hashref' => { 'custnum' => $num, %options },
8271 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8275 push @cust_main, qsearch( {
8276 'table' => 'cust_main',
8277 'hashref' => { 'agent_custid' => $num, %options },
8278 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8281 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
8283 my($company, $last, $first) = ( $1, $2, $3 );
8285 # "Company (Last, First)"
8286 #this is probably something a browser remembered,
8287 #so just do an exact search
8289 foreach my $prefix ( '', 'ship_' ) {
8290 push @cust_main, qsearch( {
8291 'table' => 'cust_main',
8292 'hashref' => { $prefix.'first' => $first,
8293 $prefix.'last' => $last,
8294 $prefix.'company' => $company,
8297 'extra_sql' => " AND $agentnums_sql",
8301 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
8302 # try (ship_){last,company}
8306 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
8307 # # full strings the browser remembers won't work
8308 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
8310 use Lingua::EN::NameParse;
8311 my $NameParse = new Lingua::EN::NameParse(
8313 allow_reversed => 1,
8316 my($last, $first) = ( '', '' );
8317 #maybe disable this too and just rely on NameParse?
8318 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
8320 ($last, $first) = ( $1, $2 );
8322 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
8323 } elsif ( ! $NameParse->parse($value) ) {
8325 my %name = $NameParse->components;
8326 $first = $name{'given_name_1'};
8327 $last = $name{'surname_1'};
8331 if ( $first && $last ) {
8333 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
8336 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8338 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
8339 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
8342 push @cust_main, qsearch( {
8343 'table' => 'cust_main',
8344 'hashref' => \%options,
8345 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8348 # or it just be something that was typed in... (try that in a sec)
8352 my $q_value = dbh->quote($value);
8355 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8356 $sql .= " ( LOWER(last) = $q_value
8357 OR LOWER(company) = $q_value
8358 OR LOWER(ship_last) = $q_value
8359 OR LOWER(ship_company) = $q_value
8362 push @cust_main, qsearch( {
8363 'table' => 'cust_main',
8364 'hashref' => \%options,
8365 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8368 #no exact match, trying substring/fuzzy
8369 #always do substring & fuzzy (unless they're explicity config'ed off)
8370 #getting complaints searches are not returning enough
8371 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
8373 #still some false laziness w/search_sql (was search/cust_main.cgi)
8378 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
8379 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
8382 if ( $first && $last ) {
8385 { 'first' => { op=>'ILIKE', value=>"%$first%" },
8386 'last' => { op=>'ILIKE', value=>"%$last%" },
8388 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
8389 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
8396 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
8397 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
8401 foreach my $hashref ( @hashrefs ) {
8403 push @cust_main, qsearch( {
8404 'table' => 'cust_main',
8405 'hashref' => { %$hashref,
8408 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
8417 " AND $agentnums_sql", #extra_sql #agent virtualization
8420 if ( $first && $last ) {
8421 push @cust_main, FS::cust_main->fuzzy_search(
8422 { 'last' => $last, #fuzzy hashref
8423 'first' => $first }, #
8427 foreach my $field ( 'last', 'company' ) {
8429 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
8436 #eliminate duplicates
8438 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8446 Accepts the following options: I<email>, the email address to search for. The
8447 email address will be searched for as an email invoice destination and as an
8450 #Any additional options are treated as an additional qualifier on the search
8451 #(i.e. I<agentnum>).
8453 Returns a (possibly empty) array of FS::cust_main objects (but usually just
8463 my $email = delete $options{'email'};
8465 #we're only being used by RT at the moment... no agent virtualization yet
8466 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8470 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
8472 my ( $user, $domain ) = ( $1, $2 );
8474 warn "$me smart_search: searching for $user in domain $domain"
8480 'table' => 'cust_main_invoice',
8481 'hashref' => { 'dest' => $email },
8488 map $_->cust_svc->cust_pkg,
8490 'table' => 'svc_acct',
8491 'hashref' => { 'username' => $user, },
8493 'AND ( SELECT domain FROM svc_domain
8494 WHERE svc_acct.domsvc = svc_domain.svcnum
8495 ) = '. dbh->quote($domain),
8501 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8503 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
8510 =item check_and_rebuild_fuzzyfiles
8514 use vars qw(@fuzzyfields);
8515 @fuzzyfields = ( 'last', 'first', 'company' );
8517 sub check_and_rebuild_fuzzyfiles {
8518 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8519 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
8522 =item rebuild_fuzzyfiles
8526 sub rebuild_fuzzyfiles {
8528 use Fcntl qw(:flock);
8530 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8531 mkdir $dir, 0700 unless -d $dir;
8533 foreach my $fuzzy ( @fuzzyfields ) {
8535 open(LOCK,">>$dir/cust_main.$fuzzy")
8536 or die "can't open $dir/cust_main.$fuzzy: $!";
8538 or die "can't lock $dir/cust_main.$fuzzy: $!";
8540 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
8541 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
8543 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
8544 my $sth = dbh->prepare("SELECT $field FROM cust_main".
8545 " WHERE $field != '' AND $field IS NOT NULL");
8546 $sth->execute or die $sth->errstr;
8548 while ( my $row = $sth->fetchrow_arrayref ) {
8549 print CACHE $row->[0]. "\n";
8554 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
8556 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
8567 my( $self, $field ) = @_;
8568 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8569 open(CACHE,"<$dir/cust_main.$field")
8570 or die "can't open $dir/cust_main.$field: $!";
8571 my @array = map { chomp; $_; } <CACHE>;
8576 =item append_fuzzyfiles LASTNAME COMPANY
8580 sub append_fuzzyfiles {
8581 #my( $first, $last, $company ) = @_;
8583 &check_and_rebuild_fuzzyfiles;
8585 use Fcntl qw(:flock);
8587 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8589 foreach my $field (qw( first last company )) {
8594 open(CACHE,">>$dir/cust_main.$field")
8595 or die "can't open $dir/cust_main.$field: $!";
8596 flock(CACHE,LOCK_EX)
8597 or die "can't lock $dir/cust_main.$field: $!";
8599 print CACHE "$value\n";
8601 flock(CACHE,LOCK_UN)
8602 or die "can't unlock $dir/cust_main.$field: $!";
8617 #warn join('-',keys %$param);
8618 my $fh = $param->{filehandle};
8619 my @fields = @{$param->{fields}};
8621 eval "use Text::CSV_XS;";
8624 my $csv = new Text::CSV_XS;
8631 local $SIG{HUP} = 'IGNORE';
8632 local $SIG{INT} = 'IGNORE';
8633 local $SIG{QUIT} = 'IGNORE';
8634 local $SIG{TERM} = 'IGNORE';
8635 local $SIG{TSTP} = 'IGNORE';
8636 local $SIG{PIPE} = 'IGNORE';
8638 my $oldAutoCommit = $FS::UID::AutoCommit;
8639 local $FS::UID::AutoCommit = 0;
8642 #while ( $columns = $csv->getline($fh) ) {
8644 while ( defined($line=<$fh>) ) {
8646 $csv->parse($line) or do {
8647 $dbh->rollback if $oldAutoCommit;
8648 return "can't parse: ". $csv->error_input();
8651 my @columns = $csv->fields();
8652 #warn join('-',@columns);
8655 foreach my $field ( @fields ) {
8656 $row{$field} = shift @columns;
8659 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
8660 unless ( $cust_main ) {
8661 $dbh->rollback if $oldAutoCommit;
8662 return "unknown custnum $row{'custnum'}";
8665 if ( $row{'amount'} > 0 ) {
8666 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
8668 $dbh->rollback if $oldAutoCommit;
8672 } elsif ( $row{'amount'} < 0 ) {
8673 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
8676 $dbh->rollback if $oldAutoCommit;
8686 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
8688 return "Empty file!" unless $imported;
8694 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
8696 Sends a templated email notification to the customer (see L<Text::Template>).
8698 OPTIONS is a hash and may include
8700 I<from> - the email sender (default is invoice_from)
8702 I<to> - comma-separated scalar or arrayref of recipients
8703 (default is invoicing_list)
8705 I<subject> - The subject line of the sent email notification
8706 (default is "Notice from company_name")
8708 I<extra_fields> - a hashref of name/value pairs which will be substituted
8711 The following variables are vavailable in the template.
8713 I<$first> - the customer first name
8714 I<$last> - the customer last name
8715 I<$company> - the customer company
8716 I<$payby> - a description of the method of payment for the customer
8717 # would be nice to use FS::payby::shortname
8718 I<$payinfo> - the account information used to collect for this customer
8719 I<$expdate> - the expiration of the customer payment in seconds from epoch
8724 my ($self, $template, %options) = @_;
8726 return unless $conf->exists($template);
8728 my $from = $conf->config('invoice_from', $self->agentnum)
8729 if $conf->exists('invoice_from', $self->agentnum);
8730 $from = $options{from} if exists($options{from});
8732 my $to = join(',', $self->invoicing_list_emailonly);
8733 $to = $options{to} if exists($options{to});
8735 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
8736 if $conf->exists('company_name', $self->agentnum);
8737 $subject = $options{subject} if exists($options{subject});
8739 my $notify_template = new Text::Template (TYPE => 'ARRAY',
8740 SOURCE => [ map "$_\n",
8741 $conf->config($template)]
8743 or die "can't create new Text::Template object: Text::Template::ERROR";
8744 $notify_template->compile()
8745 or die "can't compile template: Text::Template::ERROR";
8747 $FS::notify_template::_template::company_name =
8748 $conf->config('company_name', $self->agentnum);
8749 $FS::notify_template::_template::company_address =
8750 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
8752 my $paydate = $self->paydate || '2037-12-31';
8753 $FS::notify_template::_template::first = $self->first;
8754 $FS::notify_template::_template::last = $self->last;
8755 $FS::notify_template::_template::company = $self->company;
8756 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
8757 my $payby = $self->payby;
8758 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
8759 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
8761 #credit cards expire at the end of the month/year of their exp date
8762 if ($payby eq 'CARD' || $payby eq 'DCRD') {
8763 $FS::notify_template::_template::payby = 'credit card';
8764 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
8765 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
8767 }elsif ($payby eq 'COMP') {
8768 $FS::notify_template::_template::payby = 'complimentary account';
8770 $FS::notify_template::_template::payby = 'current method';
8772 $FS::notify_template::_template::expdate = $expire_time;
8774 for (keys %{$options{extra_fields}}){
8776 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
8779 send_email(from => $from,
8781 subject => $subject,
8782 body => $notify_template->fill_in( PACKAGE =>
8783 'FS::notify_template::_template' ),
8788 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
8790 Generates a templated notification to the customer (see L<Text::Template>).
8792 OPTIONS is a hash and may include
8794 I<extra_fields> - a hashref of name/value pairs which will be substituted
8795 into the template. These values may override values mentioned below
8796 and those from the customer record.
8798 The following variables are available in the template instead of or in addition
8799 to the fields of the customer record.
8801 I<$payby> - a description of the method of payment for the customer
8802 # would be nice to use FS::payby::shortname
8803 I<$payinfo> - the masked account information used to collect for this customer
8804 I<$expdate> - the expiration of the customer payment method in seconds from epoch
8805 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
8809 sub generate_letter {
8810 my ($self, $template, %options) = @_;
8812 return unless $conf->exists($template);
8814 my $letter_template = new Text::Template
8816 SOURCE => [ map "$_\n", $conf->config($template)],
8817 DELIMITERS => [ '[@--', '--@]' ],
8819 or die "can't create new Text::Template object: Text::Template::ERROR";
8821 $letter_template->compile()
8822 or die "can't compile template: Text::Template::ERROR";
8824 my %letter_data = map { $_ => $self->$_ } $self->fields;
8825 $letter_data{payinfo} = $self->mask_payinfo;
8827 #my $paydate = $self->paydate || '2037-12-31';
8828 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
8830 my $payby = $self->payby;
8831 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
8832 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
8834 #credit cards expire at the end of the month/year of their exp date
8835 if ($payby eq 'CARD' || $payby eq 'DCRD') {
8836 $letter_data{payby} = 'credit card';
8837 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
8838 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
8840 }elsif ($payby eq 'COMP') {
8841 $letter_data{payby} = 'complimentary account';
8843 $letter_data{payby} = 'current method';
8845 $letter_data{expdate} = $expire_time;
8847 for (keys %{$options{extra_fields}}){
8848 $letter_data{$_} = $options{extra_fields}->{$_};
8851 unless(exists($letter_data{returnaddress})){
8852 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
8853 $self->agent_template)
8855 if ( length($retadd) ) {
8856 $letter_data{returnaddress} = $retadd;
8857 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
8858 $letter_data{returnaddress} =
8859 join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
8860 $conf->config('company_address', $self->agentnum)
8863 $letter_data{returnaddress} = '~';
8867 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
8869 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
8871 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
8872 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
8876 ) or die "can't open temp file: $!\n";
8878 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
8880 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
8884 =item print_ps TEMPLATE
8886 Returns an postscript letter filled in from TEMPLATE, as a scalar.
8892 my $file = $self->generate_letter(@_);
8893 FS::Misc::generate_ps($file);
8896 =item print TEMPLATE
8898 Prints the filled in template.
8900 TEMPLATE is the name of a L<Text::Template> to fill in and print.
8904 sub queueable_print {
8907 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
8908 or die "invalid customer number: " . $opt{custvnum};
8910 my $error = $self->print( $opt{template} );
8911 die $error if $error;
8915 my ($self, $template) = (shift, shift);
8916 do_print [ $self->print_ps($template) ];
8919 #these three subs should just go away once agent stuff is all config overrides
8921 sub agent_template {
8923 $self->_agent_plandata('agent_templatename');
8926 sub agent_invoice_from {
8928 $self->_agent_plandata('agent_invoice_from');
8931 sub _agent_plandata {
8932 my( $self, $option ) = @_;
8934 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
8935 #agent-specific Conf
8937 use FS::part_event::Condition;
8939 my $agentnum = $self->agentnum;
8942 if ( driver_name =~ /^Pg/i ) {
8944 } elsif ( driver_name =~ /^mysql/i ) {
8947 die "don't know how to use regular expressions in ". driver_name. " databases";
8950 my $part_event_option =
8952 'select' => 'part_event_option.*',
8953 'table' => 'part_event_option',
8955 LEFT JOIN part_event USING ( eventpart )
8956 LEFT JOIN part_event_option AS peo_agentnum
8957 ON ( part_event.eventpart = peo_agentnum.eventpart
8958 AND peo_agentnum.optionname = 'agentnum'
8959 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
8961 LEFT JOIN part_event_condition
8962 ON ( part_event.eventpart = part_event_condition.eventpart
8963 AND part_event_condition.conditionname = 'cust_bill_age'
8965 LEFT JOIN part_event_condition_option
8966 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
8967 AND part_event_condition_option.optionname = 'age'
8970 #'hashref' => { 'optionname' => $option },
8971 #'hashref' => { 'part_event_option.optionname' => $option },
8973 " WHERE part_event_option.optionname = ". dbh->quote($option).
8974 " AND action = 'cust_bill_send_agent' ".
8975 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
8976 " AND peo_agentnum.optionname = 'agentnum' ".
8977 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
8979 CASE WHEN part_event_condition_option.optionname IS NULL
8981 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
8983 , part_event.weight".
8987 unless ( $part_event_option ) {
8988 return $self->agent->invoice_template || ''
8989 if $option eq 'agent_templatename';
8993 $part_event_option->optionvalue;
8998 ## actual sub, not a method, designed to be called from the queue.
8999 ## sets up the customer, and calls the bill_and_collect
9000 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
9001 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
9002 $cust_main->bill_and_collect(
9007 sub _upgrade_data { #class method
9008 my ($class, %opts) = @_;
9010 my $sql = 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL';
9011 my $sth = dbh->prepare($sql) or die dbh->errstr;
9012 $sth->execute or die $sth->errstr;
9022 The delete method should possibly take an FS::cust_main object reference
9023 instead of a scalar customer number.
9025 Bill and collect options should probably be passed as references instead of a
9028 There should probably be a configuration file with a list of allowed credit
9031 No multiple currency support (probably a larger project than just this module).
9033 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
9035 Birthdates rely on negative epoch values.
9037 The payby for card/check batches is broken. With mixed batching, bad
9040 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
9044 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
9045 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
9046 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.