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->getfield('susp') and
2861 ( $part_pkg->getfield('freq') ne '0' &&
2862 ( $cust_pkg->getfield('bill') || 0 ) <= $time
2864 || ( $part_pkg->plan eq 'voip_cdr'
2865 && $part_pkg->option('bill_every_call')
2867 || ( $options{cancel} )
2870 # XXX should this be a package event? probably. events are called
2871 # at collection time at the moment, though...
2872 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
2873 if $part_pkg->can('reset_usage');
2874 #don't want to reset usage just cause we want a line item??
2875 #&& $part_pkg->pkgpart == $real_pkgpart;
2877 warn " bill recur\n" if $DEBUG > 1;
2880 # XXX shared with $recur_prog
2881 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
2885 #over two params! lets at least switch to a hashref for the rest...
2886 my $increment_next_bill = ( $part_pkg->freq ne '0'
2887 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
2888 && !$options{cancel}
2890 my %param = ( 'precommit_hooks' => $precommit_hooks,
2891 'increment_next_bill' => $increment_next_bill,
2894 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
2895 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
2896 return "$@ running $method for $cust_pkg\n"
2899 if ( $increment_next_bill ) {
2901 my $next_bill = $part_pkg->add_freq($sdate);
2902 return "unparsable frequency: ". $part_pkg->freq
2903 if $next_bill == -1;
2905 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
2906 # only for figuring next bill date, nothing else, so, reset $sdate again
2908 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2909 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
2910 $cust_pkg->last_bill($sdate);
2912 $cust_pkg->setfield('bill', $next_bill );
2918 warn "\$setup is undefined" unless defined($setup);
2919 warn "\$recur is undefined" unless defined($recur);
2920 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2923 # If there's line items, create em cust_bill_pkg records
2924 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
2929 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
2930 # hmm.. and if just the options are modified in some weird price plan?
2932 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
2935 my $error = $cust_pkg->replace( $old_cust_pkg,
2936 'options' => { $cust_pkg->options },
2938 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
2939 if $error; #just in case
2942 $setup = sprintf( "%.2f", $setup );
2943 $recur = sprintf( "%.2f", $recur );
2944 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2945 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2947 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2948 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2951 if ( $setup != 0 || $recur != 0 ) {
2953 warn " charges (setup=$setup, recur=$recur); adding line items\n"
2956 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
2958 warn " adding customer package invoice detail: $_\n"
2959 foreach @cust_pkg_detail;
2961 push @details, @cust_pkg_detail;
2963 my $cust_bill_pkg = new FS::cust_bill_pkg {
2964 'pkgnum' => $cust_pkg->pkgnum,
2966 'unitsetup' => $unitsetup,
2968 'unitrecur' => $unitrecur,
2969 'quantity' => $cust_pkg->quantity,
2970 'details' => \@details,
2971 'hidden' => $part_pkg->hidden,
2974 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
2975 $cust_bill_pkg->sdate( $hash{last_bill} );
2976 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
2977 $cust_bill_pkg->edate( $time ) if $options{cancel};
2978 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
2979 $cust_bill_pkg->sdate( $sdate );
2980 $cust_bill_pkg->edate( $cust_pkg->bill );
2981 #$cust_bill_pkg->edate( $time ) if $options{cancel};
2984 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
2985 unless $part_pkg->pkgpart == $real_pkgpart;
2987 $$total_setup += $setup;
2988 $$total_recur += $recur;
2995 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart);
2996 return $error if $error;
2998 push @$cust_bill_pkgs, $cust_bill_pkg;
3000 } #if $setup != 0 || $recur != 0
3010 my $part_pkg = shift;
3011 my $taxlisthash = shift;
3012 my $cust_bill_pkg = shift;
3013 my $cust_pkg = shift;
3014 my $invoice_time = shift;
3015 my $real_pkgpart = shift;
3017 my %cust_bill_pkg = ();
3021 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
3022 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
3023 push @classes, 'setup' if $cust_bill_pkg->setup;
3024 push @classes, 'recur' if $cust_bill_pkg->recur;
3026 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
3028 if ( $conf->exists('enable_taxproducts')
3029 && ( scalar($part_pkg->part_pkg_taxoverride)
3030 || $part_pkg->has_taxproduct
3035 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3036 return "fatal: Can't (yet) use tax-pkg_address with taxproducts";
3039 foreach my $class (@classes) {
3040 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class );
3041 return $err_or_ref unless ref($err_or_ref);
3042 $taxes{$class} = $err_or_ref;
3045 unless (exists $taxes{''}) {
3046 my $err_or_ref = $self->_gather_taxes( $part_pkg, '' );
3047 return $err_or_ref unless ref($err_or_ref);
3048 $taxes{''} = $err_or_ref;
3053 my @loc_keys = qw( state county country );
3055 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3056 my $cust_location = $cust_pkg->cust_location;
3057 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
3060 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
3063 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
3066 $taxhash{'taxclass'} = $part_pkg->taxclass;
3068 my @taxes = qsearch( 'cust_main_county', \%taxhash );
3070 my %taxhash_elim = %taxhash;
3072 my @elim = qw( taxclass county state );
3073 while ( !scalar(@taxes) && scalar(@elim) ) {
3074 $taxhash_elim{ shift(@elim) } = '';
3075 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
3078 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
3080 if $self->cust_main_exemption; #just to be safe
3082 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3084 $_->set('pkgnum', $cust_pkg->pkgnum );
3085 $_->set('locationnum', $cust_pkg->locationnum );
3089 $taxes{''} = [ @taxes ];
3090 $taxes{'setup'} = [ @taxes ];
3091 $taxes{'recur'} = [ @taxes ];
3092 $taxes{$_} = [ @taxes ] foreach (@classes);
3094 # # maybe eliminate this entirely, along with all the 0% records
3095 # unless ( @taxes ) {
3097 # "fatal: can't find tax rate for state/county/country/taxclass ".
3098 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
3101 } #if $conf->exists('enable_taxproducts') ...
3106 if ( $conf->exists('separate_usage') || $cust_bill_pkg->hidden ) {
3108 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
3109 my %hash = $cust_bill_pkg->hidden # maybe for all bill linked?
3110 ? ( 'section' => $temp_pkg->part_pkg->categoryname )
3113 my $section = $cust_pkg->part_pkg->option('usage_section', 'Hush!');
3114 my $summary = $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
3115 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3116 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
3118 if ($section && $summary) {
3119 push @display, new FS::cust_bill_pkg_display { type => 'U',
3123 $hash{post_total} = 'Y';
3126 $hash{section} = $section if $conf->exists('separate_usage');
3127 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
3130 $cust_bill_pkg->set('display', \@display);
3132 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
3133 foreach my $key (keys %tax_cust_bill_pkg) {
3134 my @taxes = @{ $taxes{$key} || [] };
3135 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
3137 my %localtaxlisthash = ();
3138 foreach my $tax ( @taxes ) {
3140 my $taxname = ref( $tax ). ' '. $tax->taxnum;
3141 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
3142 # ' locationnum'. $cust_pkg->locationnum
3143 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
3145 $taxlisthash->{ $taxname } ||= [ $tax ];
3146 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
3148 $localtaxlisthash{ $taxname } ||= [ $tax ];
3149 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
3153 warn "finding taxed taxes...\n" if $DEBUG > 2;
3154 foreach my $tax ( keys %localtaxlisthash ) {
3155 my $tax_object = shift @{ $localtaxlisthash{$tax} };
3156 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
3158 next unless $tax_object->can('tax_on_tax');
3160 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
3161 my $totname = ref( $tot ). ' '. $tot->taxnum;
3163 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
3165 next unless exists( $localtaxlisthash{ $totname } ); # only increase
3167 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
3168 my $hashref_or_error =
3169 $tax_object->taxline( $localtaxlisthash{$tax},
3170 'custnum' => $self->custnum,
3171 'invoice_time' => $invoice_time,
3173 return $hashref_or_error
3174 unless ref($hashref_or_error);
3176 $taxlisthash->{ $totname } ||= [ $tot ];
3177 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
3189 my $part_pkg = shift;
3193 my $geocode = $self->geocode('cch');
3195 my @taxclassnums = map { $_->taxclassnum }
3196 $part_pkg->part_pkg_taxoverride($class);
3198 unless (@taxclassnums) {
3199 @taxclassnums = map { $_->taxclassnum }
3200 grep { $_->taxable eq 'Y' }
3201 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
3203 warn "Found taxclassnum values of ". join(',', @taxclassnums)
3208 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
3210 @taxes = qsearch({ 'table' => 'tax_rate',
3211 'hashref' => { 'geocode' => $geocode, },
3212 'extra_sql' => $extra_sql,
3214 if scalar(@taxclassnums);
3216 warn "Found taxes ".
3217 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
3224 =item collect OPTIONS
3226 (Attempt to) collect money for this customer's outstanding invoices (see
3227 L<FS::cust_bill>). Usually used after the bill method.
3229 Actions are now triggered by billing events; see L<FS::part_event> and the
3230 billing events web interface. Old-style invoice events (see
3231 L<FS::part_bill_event>) have been deprecated.
3233 If there is an error, returns the error, otherwise returns false.
3235 Options are passed as name-value pairs.
3237 Currently available options are:
3243 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.
3247 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3251 set true to surpress email card/ACH decline notices.
3255 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3259 allows for one time override of normal customer billing method
3263 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)
3271 my( $self, %options ) = @_;
3272 my $invoice_time = $options{'invoice_time'} || time;
3275 local $SIG{HUP} = 'IGNORE';
3276 local $SIG{INT} = 'IGNORE';
3277 local $SIG{QUIT} = 'IGNORE';
3278 local $SIG{TERM} = 'IGNORE';
3279 local $SIG{TSTP} = 'IGNORE';
3280 local $SIG{PIPE} = 'IGNORE';
3282 my $oldAutoCommit = $FS::UID::AutoCommit;
3283 local $FS::UID::AutoCommit = 0;
3286 $self->select_for_update; #mutex
3289 my $balance = $self->balance;
3290 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
3293 if ( exists($options{'retry_card'}) ) {
3294 carp 'retry_card option passed to collect is deprecated; use retry';
3295 $options{'retry'} ||= $options{'retry_card'};
3297 if ( exists($options{'retry'}) && $options{'retry'} ) {
3298 my $error = $self->retry_realtime;
3300 $dbh->rollback if $oldAutoCommit;
3305 # false laziness w/pay_batch::import_results
3307 my $due_cust_event = $self->due_cust_event(
3308 'debug' => ( $options{'debug'} || 0 ),
3309 'time' => $invoice_time,
3310 'check_freq' => $options{'check_freq'},
3312 unless( ref($due_cust_event) ) {
3313 $dbh->rollback if $oldAutoCommit;
3314 return $due_cust_event;
3317 foreach my $cust_event ( @$due_cust_event ) {
3321 #re-eval event conditions (a previous event could have changed things)
3322 unless ( $cust_event->test_conditions( 'time' => $invoice_time ) ) {
3323 #don't leave stray "new/locked" records around
3324 my $error = $cust_event->delete;
3326 #gah, even with transactions
3327 $dbh->commit if $oldAutoCommit; #well.
3334 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
3335 warn " running cust_event ". $cust_event->eventnum. "\n"
3339 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
3340 if ( my $error = $cust_event->do_event() ) {
3341 #XXX wtf is this? figure out a proper dealio with return value
3343 # gah, even with transactions.
3344 $dbh->commit if $oldAutoCommit; #well.
3351 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3356 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
3358 Inserts database records for and returns an ordered listref of new events due
3359 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
3360 events are due, an empty listref is returned. If there is an error, returns a
3361 scalar error message.
3363 To actually run the events, call each event's test_condition method, and if
3364 still true, call the event's do_event method.
3366 Options are passed as a hashref or as a list of name-value pairs. Available
3373 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.
3377 "Current time" for the events.
3381 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)
3385 Only return events for the specified eventtable (by default, events of all eventtables are returned)
3389 Explicitly pass the objects to be tested (typically used with eventtable).
3393 Set to true to return the objects, but not actually insert them into the
3400 sub due_cust_event {
3402 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
3405 #my $DEBUG = $opt{'debug'}
3406 local($DEBUG) = $opt{'debug'}
3407 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
3409 warn "$me due_cust_event called with options ".
3410 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
3413 $opt{'time'} ||= time;
3415 local $SIG{HUP} = 'IGNORE';
3416 local $SIG{INT} = 'IGNORE';
3417 local $SIG{QUIT} = 'IGNORE';
3418 local $SIG{TERM} = 'IGNORE';
3419 local $SIG{TSTP} = 'IGNORE';
3420 local $SIG{PIPE} = 'IGNORE';
3422 my $oldAutoCommit = $FS::UID::AutoCommit;
3423 local $FS::UID::AutoCommit = 0;
3426 $self->select_for_update #mutex
3427 unless $opt{testonly};
3430 # 1: find possible events (initial search)
3433 my @cust_event = ();
3435 my @eventtable = $opt{'eventtable'}
3436 ? ( $opt{'eventtable'} )
3437 : FS::part_event->eventtables_runorder;
3439 foreach my $eventtable ( @eventtable ) {
3442 if ( $opt{'objects'} ) {
3444 @objects = @{ $opt{'objects'} };
3448 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
3449 @objects = ( $eventtable eq 'cust_main' )
3451 : ( $self->$eventtable() );
3455 my @e_cust_event = ();
3457 my $cross = "CROSS JOIN $eventtable";
3458 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
3459 unless $eventtable eq 'cust_main';
3461 foreach my $object ( @objects ) {
3463 #this first search uses the condition_sql magic for optimization.
3464 #the more possible events we can eliminate in this step the better
3466 my $cross_where = '';
3467 my $pkey = $object->primary_key;
3468 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
3470 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
3472 FS::part_event_condition->where_conditions_sql( $eventtable,
3473 'time'=>$opt{'time'}
3475 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
3477 $extra_sql = "AND $extra_sql" if $extra_sql;
3479 #here is the agent virtualization
3480 $extra_sql .= " AND ( part_event.agentnum IS NULL
3481 OR part_event.agentnum = ". $self->agentnum. ' )';
3483 $extra_sql .= " $order";
3485 warn "searching for events for $eventtable ". $object->$pkey. "\n"
3486 if $opt{'debug'} > 2;
3487 my @part_event = qsearch( {
3488 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
3489 'select' => 'part_event.*',
3490 'table' => 'part_event',
3491 'addl_from' => "$cross $join",
3492 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
3493 'eventtable' => $eventtable,
3496 'extra_sql' => "AND $cross_where $extra_sql",
3500 my $pkey = $object->primary_key;
3501 warn " ". scalar(@part_event).
3502 " possible events found for $eventtable ". $object->$pkey(). "\n";
3505 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
3509 warn " ". scalar(@e_cust_event).
3510 " subtotal possible cust events found for $eventtable\n"
3513 push @cust_event, @e_cust_event;
3517 warn " ". scalar(@cust_event).
3518 " total possible cust events found in initial search\n"
3522 # 2: test conditions
3527 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
3528 'stats_hashref' => \%unsat ),
3531 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
3534 warn " invalid conditions not eliminated with condition_sql:\n".
3535 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
3542 unless( $opt{testonly} ) {
3543 foreach my $cust_event ( @cust_event ) {
3545 my $error = $cust_event->insert();
3547 $dbh->rollback if $oldAutoCommit;
3554 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3560 warn " returning events: ". Dumper(@cust_event). "\n"
3567 =item retry_realtime
3569 Schedules realtime / batch credit card / electronic check / LEC billing
3570 events for for retry. Useful if card information has changed or manual
3571 retry is desired. The 'collect' method must be called to actually retry
3574 Implementation details: For either this customer, or for each of this
3575 customer's open invoices, changes the status of the first "done" (with
3576 statustext error) realtime processing event to "failed".
3580 sub retry_realtime {
3583 local $SIG{HUP} = 'IGNORE';
3584 local $SIG{INT} = 'IGNORE';
3585 local $SIG{QUIT} = 'IGNORE';
3586 local $SIG{TERM} = 'IGNORE';
3587 local $SIG{TSTP} = 'IGNORE';
3588 local $SIG{PIPE} = 'IGNORE';
3590 my $oldAutoCommit = $FS::UID::AutoCommit;
3591 local $FS::UID::AutoCommit = 0;
3594 #a little false laziness w/due_cust_event (not too bad, really)
3596 my $join = FS::part_event_condition->join_conditions_sql;
3597 my $order = FS::part_event_condition->order_conditions_sql;
3600 . join ( ' OR ' , map {
3601 "( part_event.eventtable = " . dbh->quote($_)
3602 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
3603 } FS::part_event->eventtables)
3606 #here is the agent virtualization
3607 my $agent_virt = " ( part_event.agentnum IS NULL
3608 OR part_event.agentnum = ". $self->agentnum. ' )';
3610 #XXX this shouldn't be hardcoded, actions should declare it...
3611 my @realtime_events = qw(
3612 cust_bill_realtime_card
3613 cust_bill_realtime_check
3614 cust_bill_realtime_lec
3618 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
3623 my @cust_event = qsearchs({
3624 'table' => 'cust_event',
3625 'select' => 'cust_event.*',
3626 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
3627 'hashref' => { 'status' => 'done' },
3628 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
3629 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
3632 my %seen_invnum = ();
3633 foreach my $cust_event (@cust_event) {
3635 #max one for the customer, one for each open invoice
3636 my $cust_X = $cust_event->cust_X;
3637 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
3641 or $cust_event->part_event->eventtable eq 'cust_bill'
3644 my $error = $cust_event->retry;
3646 $dbh->rollback if $oldAutoCommit;
3647 return "error scheduling event for retry: $error";
3652 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3657 # some horrid false laziness here to avoid refactor fallout
3658 # eventually realtime realtime_bop and realtime_refund_bop should go
3659 # away and be replaced by _new_realtime_bop and _new_realtime_refund_bop
3661 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
3663 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
3664 via a Business::OnlinePayment realtime gateway. See
3665 L<http://420.am/business-onlinepayment> for supported gateways.
3667 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3669 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
3671 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3672 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3673 if set, will override the value from the customer record.
3675 I<description> is a free-text field passed to the gateway. It defaults to
3676 "Internet services".
3678 If an I<invnum> is specified, this payment (if successful) is applied to the
3679 specified invoice. If you don't specify an I<invnum> you might want to
3680 call the B<apply_payments> method.
3682 I<quiet> can be set true to surpress email decline notices.
3684 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
3685 resulting paynum, if any.
3687 I<payunique> is a unique identifier for this payment.
3689 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
3696 return $self->_new_realtime_bop(@_)
3697 if $self->_new_bop_required();
3699 my( $method, $amount, %options ) = @_;
3701 warn "$me realtime_bop: $method $amount\n";
3702 warn " $_ => $options{$_}\n" foreach keys %options;
3705 $options{'description'} ||= 'Internet services';
3707 return $self->fake_bop($method, $amount, %options) if $options{'fake'};
3709 eval "use Business::OnlinePayment";
3712 my $payinfo = exists($options{'payinfo'})
3713 ? $options{'payinfo'}
3716 my %method2payby = (
3723 # check for banned credit card/ACH
3726 my $ban = qsearchs('banned_pay', {
3727 'payby' => $method2payby{$method},
3728 'payinfo' => md5_base64($payinfo),
3730 return "Banned credit card" if $ban;
3733 # set taxclass and trans_is_recur based on invnum if there is one
3737 my $trans_is_recur = 0;
3738 if ( $options{'invnum'} ) {
3740 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
3741 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
3744 map { $_->part_pkg }
3746 map { $_->cust_pkg }
3747 $cust_bill->cust_bill_pkg;
3749 my @taxclasses = map $_->taxclass, @part_pkg;
3750 $taxclass = $taxclasses[0]
3751 unless grep { $taxclasses[0] ne $_ } @taxclasses; #unless there are
3752 #different taxclasses
3754 if grep { $_->freq ne '0' } @part_pkg;
3762 #look for an agent gateway override first
3764 if ( $method eq 'CC' ) {
3765 $cardtype = cardtype($payinfo);
3766 } elsif ( $method eq 'ECHECK' ) {
3769 $cardtype = $method;
3773 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3774 cardtype => $cardtype,
3775 taxclass => $taxclass, } )
3776 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3778 taxclass => $taxclass, } )
3779 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3780 cardtype => $cardtype,
3782 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3784 taxclass => '', } );
3786 my $payment_gateway = '';
3787 my( $processor, $login, $password, $action, @bop_options );
3788 if ( $override ) { #use a payment gateway override
3790 $payment_gateway = $override->payment_gateway;
3792 $processor = $payment_gateway->gateway_module;
3793 $login = $payment_gateway->gateway_username;
3794 $password = $payment_gateway->gateway_password;
3795 $action = $payment_gateway->gateway_action;
3796 @bop_options = $payment_gateway->options;
3798 } else { #use the standard settings from the config
3800 ( $processor, $login, $password, $action, @bop_options ) =
3801 $self->default_payment_gateway($method);
3809 my $address = exists($options{'address1'})
3810 ? $options{'address1'}
3812 my $address2 = exists($options{'address2'})
3813 ? $options{'address2'}
3815 $address .= ", ". $address2 if length($address2);
3817 my $o_payname = exists($options{'payname'})
3818 ? $options{'payname'}
3820 my($payname, $payfirst, $paylast);
3821 if ( $o_payname && $method ne 'ECHECK' ) {
3822 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3823 or return "Illegal payname $payname";
3824 ($payfirst, $paylast) = ($1, $2);
3826 $payfirst = $self->getfield('first');
3827 $paylast = $self->getfield('last');
3828 $payname = "$payfirst $paylast";
3831 my @invoicing_list = $self->invoicing_list_emailonly;
3832 if ( $conf->exists('emailinvoiceautoalways')
3833 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3834 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3835 push @invoicing_list, $self->all_emails;
3838 my $email = ($conf->exists('business-onlinepayment-email-override'))
3839 ? $conf->config('business-onlinepayment-email-override')
3840 : $invoicing_list[0];
3844 my $payip = exists($options{'payip'})
3847 $content{customer_ip} = $payip
3850 $content{invoice_number} = $options{'invnum'}
3851 if exists($options{'invnum'}) && length($options{'invnum'});
3853 $content{email_customer} =
3854 ( $conf->exists('business-onlinepayment-email_customer')
3855 || $conf->exists('business-onlinepayment-email-override') );
3858 if ( $method eq 'CC' ) {
3860 $content{card_number} = $payinfo;
3861 $paydate = exists($options{'paydate'})
3862 ? $options{'paydate'}
3864 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3865 $content{expiration} = "$2/$1";
3867 my $paycvv = exists($options{'paycvv'})
3868 ? $options{'paycvv'}
3870 $content{cvv2} = $paycvv
3873 my $paystart_month = exists($options{'paystart_month'})
3874 ? $options{'paystart_month'}
3875 : $self->paystart_month;
3877 my $paystart_year = exists($options{'paystart_year'})
3878 ? $options{'paystart_year'}
3879 : $self->paystart_year;
3881 $content{card_start} = "$paystart_month/$paystart_year"
3882 if $paystart_month && $paystart_year;
3884 my $payissue = exists($options{'payissue'})
3885 ? $options{'payissue'}
3887 $content{issue_number} = $payissue if $payissue;
3889 if ( $self->_bop_recurring_billing( 'payinfo' => $payinfo,
3890 'trans_is_recur' => $trans_is_recur,
3894 $content{recurring_billing} = 'YES';
3895 $content{acct_code} = 'rebill'
3896 if $conf->exists('credit_card-recurring_billing_acct_code');
3899 } elsif ( $method eq 'ECHECK' ) {
3900 ( $content{account_number}, $content{routing_code} ) =
3901 split('@', $payinfo);
3902 $content{bank_name} = $o_payname;
3903 $content{bank_state} = exists($options{'paystate'})
3904 ? $options{'paystate'}
3905 : $self->getfield('paystate');
3906 $content{account_type} = exists($options{'paytype'})
3907 ? uc($options{'paytype'}) || 'CHECKING'
3908 : uc($self->getfield('paytype')) || 'CHECKING';
3909 $content{account_name} = $payname;
3910 $content{customer_org} = $self->company ? 'B' : 'I';
3911 $content{state_id} = exists($options{'stateid'})
3912 ? $options{'stateid'}
3913 : $self->getfield('stateid');
3914 $content{state_id_state} = exists($options{'stateid_state'})
3915 ? $options{'stateid_state'}
3916 : $self->getfield('stateid_state');
3917 $content{customer_ssn} = exists($options{'ss'})
3920 } elsif ( $method eq 'LEC' ) {
3921 $content{phone} = $payinfo;
3925 # run transaction(s)
3928 my $balance = exists( $options{'balance'} )
3929 ? $options{'balance'}
3932 $self->select_for_update; #mutex ... just until we get our pending record in
3934 #the checks here are intended to catch concurrent payments
3935 #double-form-submission prevention is taken care of in cust_pay_pending::check
3938 return "The customer's balance has changed; $method transaction aborted."
3939 if $self->balance < $balance;
3940 #&& $self->balance < $amount; #might as well anyway?
3942 #also check and make sure there aren't *other* pending payments for this cust
3944 my @pending = qsearch('cust_pay_pending', {
3945 'custnum' => $self->custnum,
3946 'status' => { op=>'!=', value=>'done' }
3948 return "A payment is already being processed for this customer (".
3949 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
3950 "); $method transaction aborted."
3951 if scalar(@pending);
3953 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
3955 my $cust_pay_pending = new FS::cust_pay_pending {
3956 'custnum' => $self->custnum,
3957 #'invnum' => $options{'invnum'},
3960 'payby' => $method2payby{$method},
3961 'payinfo' => $payinfo,
3962 'paydate' => $paydate,
3963 'recurring_billing' => $content{recurring_billing},
3965 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
3967 $cust_pay_pending->payunique( $options{payunique} )
3968 if defined($options{payunique}) && length($options{payunique});
3969 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
3970 return $cpp_new_err if $cpp_new_err;
3972 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
3974 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
3975 $transaction->content(
3978 'password' => $password,
3979 'action' => $action1,
3980 'description' => $options{'description'},
3981 'amount' => $amount,
3982 #'invoice_number' => $options{'invnum'},
3983 'customer_id' => $self->custnum,
3984 'last_name' => $paylast,
3985 'first_name' => $payfirst,
3987 'address' => $address,
3988 'city' => ( exists($options{'city'})
3991 'state' => ( exists($options{'state'})
3994 'zip' => ( exists($options{'zip'})
3997 'country' => ( exists($options{'country'})
3998 ? $options{'country'}
4000 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4002 'phone' => $self->daytime || $self->night,
4006 $cust_pay_pending->status('pending');
4007 my $cpp_pending_err = $cust_pay_pending->replace;
4008 return $cpp_pending_err if $cpp_pending_err;
4011 my $BOP_TESTING = 0;
4012 my $BOP_TESTING_SUCCESS = 1;
4014 unless ( $BOP_TESTING ) {
4015 $transaction->submit();
4017 if ( $BOP_TESTING_SUCCESS ) {
4018 $transaction->is_success(1);
4019 $transaction->authorization('fake auth');
4021 $transaction->is_success(0);
4022 $transaction->error_message('fake failure');
4026 if ( $transaction->is_success() && $action2 ) {
4028 $cust_pay_pending->status('authorized');
4029 my $cpp_authorized_err = $cust_pay_pending->replace;
4030 return $cpp_authorized_err if $cpp_authorized_err;
4032 my $auth = $transaction->authorization;
4033 my $ordernum = $transaction->can('order_number')
4034 ? $transaction->order_number
4038 new Business::OnlinePayment( $processor, @bop_options );
4045 password => $password,
4046 order_number => $ordernum,
4048 authorization => $auth,
4049 description => $options{'description'},
4052 foreach my $field (qw( authorization_source_code returned_ACI
4053 transaction_identifier validation_code
4054 transaction_sequence_num local_transaction_date
4055 local_transaction_time AVS_result_code )) {
4056 $capture{$field} = $transaction->$field() if $transaction->can($field);
4059 $capture->content( %capture );
4063 unless ( $capture->is_success ) {
4064 my $e = "Authorization successful but capture failed, custnum #".
4065 $self->custnum. ': '. $capture->result_code.
4066 ": ". $capture->error_message;
4073 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
4074 my $cpp_captured_err = $cust_pay_pending->replace;
4075 return $cpp_captured_err if $cpp_captured_err;
4078 # remove paycvv after initial transaction
4081 #false laziness w/misc/process/payment.cgi - check both to make sure working
4083 if ( defined $self->dbdef_table->column('paycvv')
4084 && length($self->paycvv)
4085 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
4087 my $error = $self->remove_cvv;
4089 warn "WARNING: error removing cvv: $error\n";
4097 if ( $transaction->is_success() ) {
4100 if ( $payment_gateway ) { # agent override
4101 $paybatch = $payment_gateway->gatewaynum. '-';
4104 $paybatch .= "$processor:". $transaction->authorization;
4106 $paybatch .= ':'. $transaction->order_number
4107 if $transaction->can('order_number')
4108 && length($transaction->order_number);
4110 my $cust_pay = new FS::cust_pay ( {
4111 'custnum' => $self->custnum,
4112 'invnum' => $options{'invnum'},
4115 'payby' => $method2payby{$method},
4116 'payinfo' => $payinfo,
4117 'paybatch' => $paybatch,
4118 'paydate' => $paydate,
4120 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
4121 $cust_pay->payunique( $options{payunique} )
4122 if defined($options{payunique}) && length($options{payunique});
4124 my $oldAutoCommit = $FS::UID::AutoCommit;
4125 local $FS::UID::AutoCommit = 0;
4128 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
4130 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
4133 $cust_pay->invnum(''); #try again with no specific invnum
4134 my $error2 = $cust_pay->insert( $options{'manual'} ?
4135 ( 'manual' => 1 ) : ()
4138 # gah. but at least we have a record of the state we had to abort in
4139 # from cust_pay_pending now.
4140 my $e = "WARNING: $method captured but payment not recorded - ".
4141 "error inserting payment ($processor): $error2".
4142 " (previously tried insert with invnum #$options{'invnum'}" .
4143 ": $error ) - pending payment saved as paypendingnum ".
4144 $cust_pay_pending->paypendingnum. "\n";
4150 if ( $options{'paynum_ref'} ) {
4151 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
4154 $cust_pay_pending->status('done');
4155 $cust_pay_pending->statustext('captured');
4156 $cust_pay_pending->paynum($cust_pay->paynum);
4157 my $cpp_done_err = $cust_pay_pending->replace;
4159 if ( $cpp_done_err ) {
4161 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4162 my $e = "WARNING: $method captured but payment not recorded - ".
4163 "error updating status for paypendingnum ".
4164 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4170 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4171 return ''; #no error
4177 my $perror = "$processor error: ". $transaction->error_message;
4179 unless ( $transaction->error_message ) {
4182 if ( $transaction->can('response_page') ) {
4184 'page' => ( $transaction->can('response_page')
4185 ? $transaction->response_page
4188 'code' => ( $transaction->can('response_code')
4189 ? $transaction->response_code
4192 'headers' => ( $transaction->can('response_headers')
4193 ? $transaction->response_headers
4199 "No additional debugging information available for $processor";
4202 $perror .= "No error_message returned from $processor -- ".
4203 ( ref($t_response) ? Dumper($t_response) : $t_response );
4207 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
4208 && $conf->exists('emaildecline')
4209 && grep { $_ ne 'POST' } $self->invoicing_list
4210 && ! grep { $transaction->error_message =~ /$_/ }
4211 $conf->config('emaildecline-exclude')
4213 my @templ = $conf->config('declinetemplate');
4214 my $template = new Text::Template (
4216 SOURCE => [ map "$_\n", @templ ],
4217 ) or return "($perror) can't create template: $Text::Template::ERROR";
4218 $template->compile()
4219 or return "($perror) can't compile template: $Text::Template::ERROR";
4221 my $templ_hash = { error => $transaction->error_message };
4223 my $error = send_email(
4224 'from' => $conf->config('invoice_from', $self->agentnum ),
4225 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
4226 'subject' => 'Your payment could not be processed',
4227 'body' => [ $template->fill_in(HASH => $templ_hash) ],
4230 $perror .= " (also received error sending decline notification: $error)"
4235 $cust_pay_pending->status('done');
4236 $cust_pay_pending->statustext("declined: $perror");
4237 my $cpp_done_err = $cust_pay_pending->replace;
4238 if ( $cpp_done_err ) {
4239 my $e = "WARNING: $method declined but pending payment not resolved - ".
4240 "error updating status for paypendingnum ".
4241 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4243 $perror = "$e ($perror)";
4251 sub _bop_recurring_billing {
4252 my( $self, %opt ) = @_;
4254 my $method = $conf->config('credit_card-recurring_billing_flag');
4256 if ( $method eq 'transaction_is_recur' ) {
4258 return 1 if $opt{'trans_is_recur'};
4262 my %hash = ( 'custnum' => $self->custnum,
4267 if qsearch('cust_pay', { %hash, 'payinfo' => $opt{'payinfo'} } )
4268 || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo('CARD',
4279 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
4281 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
4282 via a Business::OnlinePayment realtime gateway. See
4283 L<http://420.am/business-onlinepayment> for supported gateways.
4285 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4287 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
4289 Most gateways require a reference to an original payment transaction to refund,
4290 so you probably need to specify a I<paynum>.
4292 I<amount> defaults to the original amount of the payment if not specified.
4294 I<reason> specifies a reason for the refund.
4296 I<paydate> specifies the expiration date for a credit card overriding the
4297 value from the customer record or the payment record. Specified as yyyy-mm-dd
4299 Implementation note: If I<amount> is unspecified or equal to the amount of the
4300 orignal payment, first an attempt is made to "void" the transaction via
4301 the gateway (to cancel a not-yet settled transaction) and then if that fails,
4302 the normal attempt is made to "refund" ("credit") the transaction via the
4303 gateway is attempted.
4305 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4306 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4307 #if set, will override the value from the customer record.
4309 #If an I<invnum> is specified, this payment (if successful) is applied to the
4310 #specified invoice. If you don't specify an I<invnum> you might want to
4311 #call the B<apply_payments> method.
4315 #some false laziness w/realtime_bop, not enough to make it worth merging
4316 #but some useful small subs should be pulled out
4317 sub realtime_refund_bop {
4320 return $self->_new_realtime_refund_bop(@_)
4321 if $self->_new_bop_required();
4323 my( $method, %options ) = @_;
4325 warn "$me realtime_refund_bop: $method refund\n";
4326 warn " $_ => $options{$_}\n" foreach keys %options;
4329 eval "use Business::OnlinePayment";
4333 # look up the original payment and optionally a gateway for that payment
4337 my $amount = $options{'amount'};
4339 my( $processor, $login, $password, @bop_options ) ;
4340 my( $auth, $order_number ) = ( '', '', '' );
4342 if ( $options{'paynum'} ) {
4344 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
4345 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
4346 or return "Unknown paynum $options{'paynum'}";
4347 $amount ||= $cust_pay->paid;
4349 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
4350 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
4351 $cust_pay->paybatch;
4352 my $gatewaynum = '';
4353 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
4355 if ( $gatewaynum ) { #gateway for the payment to be refunded
4357 my $payment_gateway =
4358 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
4359 die "payment gateway $gatewaynum not found"
4360 unless $payment_gateway;
4362 $processor = $payment_gateway->gateway_module;
4363 $login = $payment_gateway->gateway_username;
4364 $password = $payment_gateway->gateway_password;
4365 @bop_options = $payment_gateway->options;
4367 } else { #try the default gateway
4369 my( $conf_processor, $unused_action );
4370 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
4371 $self->default_payment_gateway($method);
4373 return "processor of payment $options{'paynum'} $processor does not".
4374 " match default processor $conf_processor"
4375 unless $processor eq $conf_processor;
4380 } else { # didn't specify a paynum, so look for agent gateway overrides
4381 # like a normal transaction
4384 if ( $method eq 'CC' ) {
4385 $cardtype = cardtype($self->payinfo);
4386 } elsif ( $method eq 'ECHECK' ) {
4389 $cardtype = $method;
4392 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4393 cardtype => $cardtype,
4395 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4397 taxclass => '', } );
4399 if ( $override ) { #use a payment gateway override
4401 my $payment_gateway = $override->payment_gateway;
4403 $processor = $payment_gateway->gateway_module;
4404 $login = $payment_gateway->gateway_username;
4405 $password = $payment_gateway->gateway_password;
4406 #$action = $payment_gateway->gateway_action;
4407 @bop_options = $payment_gateway->options;
4409 } else { #use the standard settings from the config
4412 ( $processor, $login, $password, $unused_action, @bop_options ) =
4413 $self->default_payment_gateway($method);
4418 return "neither amount nor paynum specified" unless $amount;
4423 'password' => $password,
4424 'order_number' => $order_number,
4425 'amount' => $amount,
4426 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4428 $content{authorization} = $auth
4429 if length($auth); #echeck/ACH transactions have an order # but no auth
4430 #(at least with authorize.net)
4432 my $disable_void_after;
4433 if ($conf->exists('disable_void_after')
4434 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
4435 $disable_void_after = $1;
4438 #first try void if applicable
4439 if ( $cust_pay && $cust_pay->paid == $amount
4441 ( not defined($disable_void_after) )
4442 || ( time < ($cust_pay->_date + $disable_void_after ) )
4445 warn " attempting void\n" if $DEBUG > 1;
4446 my $void = new Business::OnlinePayment( $processor, @bop_options );
4447 $void->content( 'action' => 'void', %content );
4449 if ( $void->is_success ) {
4450 my $error = $cust_pay->void($options{'reason'});
4452 # gah, even with transactions.
4453 my $e = 'WARNING: Card/ACH voided but database not updated - '.
4454 "error voiding payment: $error";
4458 warn " void successful\n" if $DEBUG > 1;
4463 warn " void unsuccessful, trying refund\n"
4467 my $address = $self->address1;
4468 $address .= ", ". $self->address2 if $self->address2;
4470 my($payname, $payfirst, $paylast);
4471 if ( $self->payname && $method ne 'ECHECK' ) {
4472 $payname = $self->payname;
4473 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4474 or return "Illegal payname $payname";
4475 ($payfirst, $paylast) = ($1, $2);
4477 $payfirst = $self->getfield('first');
4478 $paylast = $self->getfield('last');
4479 $payname = "$payfirst $paylast";
4482 my @invoicing_list = $self->invoicing_list_emailonly;
4483 if ( $conf->exists('emailinvoiceautoalways')
4484 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4485 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4486 push @invoicing_list, $self->all_emails;
4489 my $email = ($conf->exists('business-onlinepayment-email-override'))
4490 ? $conf->config('business-onlinepayment-email-override')
4491 : $invoicing_list[0];
4493 my $payip = exists($options{'payip'})
4496 $content{customer_ip} = $payip
4500 if ( $method eq 'CC' ) {
4503 $content{card_number} = $payinfo = $cust_pay->payinfo;
4504 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
4505 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
4506 ($content{expiration} = "$2/$1"); # where available
4508 $content{card_number} = $payinfo = $self->payinfo;
4509 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
4510 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4511 $content{expiration} = "$2/$1";
4514 } elsif ( $method eq 'ECHECK' ) {
4517 $payinfo = $cust_pay->payinfo;
4519 $payinfo = $self->payinfo;
4521 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
4522 $content{bank_name} = $self->payname;
4523 $content{account_type} = 'CHECKING';
4524 $content{account_name} = $payname;
4525 $content{customer_org} = $self->company ? 'B' : 'I';
4526 $content{customer_ssn} = $self->ss;
4527 } elsif ( $method eq 'LEC' ) {
4528 $content{phone} = $payinfo = $self->payinfo;
4532 my $refund = new Business::OnlinePayment( $processor, @bop_options );
4533 my %sub_content = $refund->content(
4534 'action' => 'credit',
4535 'customer_id' => $self->custnum,
4536 'last_name' => $paylast,
4537 'first_name' => $payfirst,
4539 'address' => $address,
4540 'city' => $self->city,
4541 'state' => $self->state,
4542 'zip' => $self->zip,
4543 'country' => $self->country,
4545 'phone' => $self->daytime || $self->night,
4548 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
4552 return "$processor error: ". $refund->error_message
4553 unless $refund->is_success();
4555 my %method2payby = (
4561 my $paybatch = "$processor:". $refund->authorization;
4562 $paybatch .= ':'. $refund->order_number
4563 if $refund->can('order_number') && $refund->order_number;
4565 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
4566 my @cust_bill_pay = $cust_pay->cust_bill_pay;
4567 last unless @cust_bill_pay;
4568 my $cust_bill_pay = pop @cust_bill_pay;
4569 my $error = $cust_bill_pay->delete;
4573 my $cust_refund = new FS::cust_refund ( {
4574 'custnum' => $self->custnum,
4575 'paynum' => $options{'paynum'},
4576 'refund' => $amount,
4578 'payby' => $method2payby{$method},
4579 'payinfo' => $payinfo,
4580 'paybatch' => $paybatch,
4581 'reason' => $options{'reason'} || 'card or ACH refund',
4583 my $error = $cust_refund->insert;
4585 $cust_refund->paynum(''); #try again with no specific paynum
4586 my $error2 = $cust_refund->insert;
4588 # gah, even with transactions.
4589 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
4590 "error inserting refund ($processor): $error2".
4591 " (previously tried insert with paynum #$options{'paynum'}" .
4602 # does the configuration indicate the new bop routines are required?
4604 sub _new_bop_required {
4607 my $botpp = 'Business::OnlineThirdPartyPayment';
4610 if ( $conf->config('business-onlinepayment-namespace') eq $botpp ||
4611 scalar( grep { $_->gateway_namespace eq $botpp }
4612 qsearch( 'payment_gateway', { 'disabled' => '' } )
4621 =item realtime_collect [ OPTION => VALUE ... ]
4623 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4624 via a Business::OnlinePayment or Business::OnlineThirdPartyPayment realtime
4625 gateway. See L<http://420.am/business-onlinepayment> and
4626 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
4628 On failure returns an error message.
4630 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.
4632 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
4634 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>. If none is specified
4635 then it is deduced from the customer record.
4637 If no I<amount> is specified, then the customer balance is used.
4639 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4640 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4641 if set, will override the value from the customer record.
4643 I<description> is a free-text field passed to the gateway. It defaults to
4644 "Internet services".
4646 If an I<invnum> is specified, this payment (if successful) is applied to the
4647 specified invoice. If you don't specify an I<invnum> you might want to
4648 call the B<apply_payments> method.
4650 I<quiet> can be set true to surpress email decline notices.
4652 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4653 resulting paynum, if any.
4655 I<payunique> is a unique identifier for this payment.
4657 I<session_id> is a session identifier associated with this payment.
4659 I<depend_jobnum> allows payment capture to unlock export jobs
4663 sub realtime_collect {
4664 my( $self, %options ) = @_;
4667 warn "$me realtime_collect:\n";
4668 warn " $_ => $options{$_}\n" foreach keys %options;
4671 $options{amount} = $self->balance unless exists( $options{amount} );
4672 $options{method} = FS::payby->payby2bop($self->payby)
4673 unless exists( $options{method} );
4675 return $self->realtime_bop({%options});
4679 =item _realtime_bop { [ ARG => VALUE ... ] }
4681 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4682 via a Business::OnlinePayment realtime gateway. See
4683 L<http://420.am/business-onlinepayment> for supported gateways.
4685 Required arguments in the hashref are I<method>, and I<amount>
4687 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4689 Available optional arguments are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
4691 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4692 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4693 if set, will override the value from the customer record.
4695 I<description> is a free-text field passed to the gateway. It defaults to
4696 "Internet services".
4698 If an I<invnum> is specified, this payment (if successful) is applied to the
4699 specified invoice. If you don't specify an I<invnum> you might want to
4700 call the B<apply_payments> method.
4702 I<quiet> can be set true to surpress email decline notices.
4704 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4705 resulting paynum, if any.
4707 I<payunique> is a unique identifier for this payment.
4709 I<session_id> is a session identifier associated with this payment.
4711 I<depend_jobnum> allows payment capture to unlock export jobs
4713 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
4717 # some helper routines
4718 sub _payment_gateway {
4719 my ($self, $options) = @_;
4721 $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
4722 unless exists($options->{payment_gateway});
4724 $options->{payment_gateway};
4728 my ($self, $options) = @_;
4731 'login' => $options->{payment_gateway}->gateway_username,
4732 'password' => $options->{payment_gateway}->gateway_password,
4737 my ($self, $options) = @_;
4739 $options->{payment_gateway}->gatewaynum
4740 ? $options->{payment_gateway}->options
4741 : @{ $options->{payment_gateway}->get('options') };
4745 my ($self, $options) = @_;
4747 $options->{description} ||= 'Internet services';
4748 $options->{payinfo} = $self->payinfo unless exists( $options->{payinfo} );
4749 $options->{invnum} ||= '';
4750 $options->{payname} = $self->payname unless exists( $options->{payname} );
4754 my ($self, $options) = @_;
4757 $content{address} = exists($options->{'address1'})
4758 ? $options->{'address1'}
4760 my $address2 = exists($options->{'address2'})
4761 ? $options->{'address2'}
4763 $content{address} .= ", ". $address2 if length($address2);
4765 my $payip = exists($options->{'payip'}) ? $options->{'payip'} : $self->payip;
4766 $content{customer_ip} = $payip if length($payip);
4768 $content{invoice_number} = $options->{'invnum'}
4769 if exists($options->{'invnum'}) && length($options->{'invnum'});
4771 $content{email_customer} =
4772 ( $conf->exists('business-onlinepayment-email_customer')
4773 || $conf->exists('business-onlinepayment-email-override') );
4775 $content{payfirst} = $self->getfield('first');
4776 $content{paylast} = $self->getfield('last');
4778 $content{account_name} = "$content{payfirst} $content{paylast}"
4779 if $options->{method} eq 'ECHECK';
4781 $content{name} = $options->{payname};
4782 $content{name} = $content{account_name} if exists($content{account_name});
4784 $content{city} = exists($options->{city})
4787 $content{state} = exists($options->{state})
4790 $content{zip} = exists($options->{zip})
4793 $content{country} = exists($options->{country})
4794 ? $options->{country}
4796 $content{referer} = 'http://cleanwhisker.420.am/'; #XXX fix referer :/
4797 $content{phone} = $self->daytime || $self->night;
4802 my %bop_method2payby = (
4808 sub _new_realtime_bop {
4812 if (ref($_[0]) eq 'HASH') {
4813 %options = %{$_[0]};
4815 my ( $method, $amount ) = ( shift, shift );
4817 $options{method} = $method;
4818 $options{amount} = $amount;
4822 warn "$me realtime_bop (new): $options{method} $options{amount}\n";
4823 warn " $_ => $options{$_}\n" foreach keys %options;
4826 return $self->fake_bop(%options) if $options{'fake'};
4828 $self->_bop_defaults(\%options);
4831 # set trans_is_recur based on invnum if there is one
4834 my $trans_is_recur = 0;
4835 if ( $options{'invnum'} ) {
4837 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
4838 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
4841 map { $_->part_pkg }
4843 map { $_->cust_pkg }
4844 $cust_bill->cust_bill_pkg;
4847 if grep { $_->freq ne '0' } @part_pkg;
4855 my $payment_gateway = $self->_payment_gateway( \%options );
4856 my $namespace = $payment_gateway->gateway_namespace;
4858 eval "use $namespace";
4862 # check for banned credit card/ACH
4865 my $ban = qsearchs('banned_pay', {
4866 'payby' => $bop_method2payby{$options{method}},
4867 'payinfo' => md5_base64($options{payinfo}),
4869 return "Banned credit card" if $ban;
4875 my (%bop_content) = $self->_bop_content(\%options);
4877 if ( $options{method} ne 'ECHECK' ) {
4878 $options{payname} =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4879 or return "Illegal payname $options{payname}";
4880 ($bop_content{payfirst}, $bop_content{paylast}) = ($1, $2);
4883 my @invoicing_list = $self->invoicing_list_emailonly;
4884 if ( $conf->exists('emailinvoiceautoalways')
4885 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4886 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4887 push @invoicing_list, $self->all_emails;
4890 my $email = ($conf->exists('business-onlinepayment-email-override'))
4891 ? $conf->config('business-onlinepayment-email-override')
4892 : $invoicing_list[0];
4896 if ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'CC' ) {
4898 $content{card_number} = $options{payinfo};
4899 $paydate = exists($options{'paydate'})
4900 ? $options{'paydate'}
4902 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4903 $content{expiration} = "$2/$1";
4905 my $paycvv = exists($options{'paycvv'})
4906 ? $options{'paycvv'}
4908 $content{cvv2} = $paycvv
4911 my $paystart_month = exists($options{'paystart_month'})
4912 ? $options{'paystart_month'}
4913 : $self->paystart_month;
4915 my $paystart_year = exists($options{'paystart_year'})
4916 ? $options{'paystart_year'}
4917 : $self->paystart_year;
4919 $content{card_start} = "$paystart_month/$paystart_year"
4920 if $paystart_month && $paystart_year;
4922 my $payissue = exists($options{'payissue'})
4923 ? $options{'payissue'}
4925 $content{issue_number} = $payissue if $payissue;
4927 if ( $self->_bop_recurring_billing( 'payinfo' => $options{'payinfo'},
4928 'trans_is_recur' => $trans_is_recur,
4932 $content{recurring_billing} = 'YES';
4933 $content{acct_code} = 'rebill'
4934 if $conf->exists('credit_card-recurring_billing_acct_code');
4937 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'ECHECK' ){
4938 ( $content{account_number}, $content{routing_code} ) =
4939 split('@', $options{payinfo});
4940 $content{bank_name} = $options{payname};
4941 $content{bank_state} = exists($options{'paystate'})
4942 ? $options{'paystate'}
4943 : $self->getfield('paystate');
4944 $content{account_type} = exists($options{'paytype'})
4945 ? uc($options{'paytype'}) || 'CHECKING'
4946 : uc($self->getfield('paytype')) || 'CHECKING';
4947 $content{customer_org} = $self->company ? 'B' : 'I';
4948 $content{state_id} = exists($options{'stateid'})
4949 ? $options{'stateid'}
4950 : $self->getfield('stateid');
4951 $content{state_id_state} = exists($options{'stateid_state'})
4952 ? $options{'stateid_state'}
4953 : $self->getfield('stateid_state');
4954 $content{customer_ssn} = exists($options{'ss'})
4957 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'LEC' ) {
4958 $content{phone} = $options{payinfo};
4959 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
4966 # run transaction(s)
4969 my $balance = exists( $options{'balance'} )
4970 ? $options{'balance'}
4973 $self->select_for_update; #mutex ... just until we get our pending record in
4975 #the checks here are intended to catch concurrent payments
4976 #double-form-submission prevention is taken care of in cust_pay_pending::check
4979 return "The customer's balance has changed; $options{method} transaction aborted."
4980 if $self->balance < $balance;
4981 #&& $self->balance < $options{amount}; #might as well anyway?
4983 #also check and make sure there aren't *other* pending payments for this cust
4985 my @pending = qsearch('cust_pay_pending', {
4986 'custnum' => $self->custnum,
4987 'status' => { op=>'!=', value=>'done' }
4989 return "A payment is already being processed for this customer (".
4990 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
4991 "); $options{method} transaction aborted."
4992 if scalar(@pending);
4994 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
4996 my $cust_pay_pending = new FS::cust_pay_pending {
4997 'custnum' => $self->custnum,
4998 #'invnum' => $options{'invnum'},
4999 'paid' => $options{amount},
5001 'payby' => $bop_method2payby{$options{method}},
5002 'payinfo' => $options{payinfo},
5003 'paydate' => $paydate,
5004 'recurring_billing' => $content{recurring_billing},
5006 'gatewaynum' => $payment_gateway->gatewaynum || '',
5007 'session_id' => $options{session_id} || '',
5008 'jobnum' => $options{depend_jobnum} || '',
5010 $cust_pay_pending->payunique( $options{payunique} )
5011 if defined($options{payunique}) && length($options{payunique});
5012 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
5013 return $cpp_new_err if $cpp_new_err;
5015 my( $action1, $action2 ) =
5016 split( /\s*\,\s*/, $payment_gateway->gateway_action );
5018 my $transaction = new $namespace( $payment_gateway->gateway_module,
5019 $self->_bop_options(\%options),
5022 $transaction->content(
5023 'type' => $options{method},
5024 $self->_bop_auth(\%options),
5025 'action' => $action1,
5026 'description' => $options{'description'},
5027 'amount' => $options{amount},
5028 #'invoice_number' => $options{'invnum'},
5029 'customer_id' => $self->custnum,
5031 'reference' => $cust_pay_pending->paypendingnum, #for now
5036 $cust_pay_pending->status('pending');
5037 my $cpp_pending_err = $cust_pay_pending->replace;
5038 return $cpp_pending_err if $cpp_pending_err;
5041 my $BOP_TESTING = 0;
5042 my $BOP_TESTING_SUCCESS = 1;
5044 unless ( $BOP_TESTING ) {
5045 $transaction->submit();
5047 if ( $BOP_TESTING_SUCCESS ) {
5048 $transaction->is_success(1);
5049 $transaction->authorization('fake auth');
5051 $transaction->is_success(0);
5052 $transaction->error_message('fake failure');
5056 if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5058 return { reference => $cust_pay_pending->paypendingnum,
5059 map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
5061 } elsif ( $transaction->is_success() && $action2 ) {
5063 $cust_pay_pending->status('authorized');
5064 my $cpp_authorized_err = $cust_pay_pending->replace;
5065 return $cpp_authorized_err if $cpp_authorized_err;
5067 my $auth = $transaction->authorization;
5068 my $ordernum = $transaction->can('order_number')
5069 ? $transaction->order_number
5073 new Business::OnlinePayment( $payment_gateway->gateway_module,
5074 $self->_bop_options(\%options),
5079 type => $options{method},
5081 $self->_bop_auth(\%options),
5082 order_number => $ordernum,
5083 amount => $options{amount},
5084 authorization => $auth,
5085 description => $options{'description'},
5088 foreach my $field (qw( authorization_source_code returned_ACI
5089 transaction_identifier validation_code
5090 transaction_sequence_num local_transaction_date
5091 local_transaction_time AVS_result_code )) {
5092 $capture{$field} = $transaction->$field() if $transaction->can($field);
5095 $capture->content( %capture );
5099 unless ( $capture->is_success ) {
5100 my $e = "Authorization successful but capture failed, custnum #".
5101 $self->custnum. ': '. $capture->result_code.
5102 ": ". $capture->error_message;
5110 # remove paycvv after initial transaction
5113 #false laziness w/misc/process/payment.cgi - check both to make sure working
5115 if ( defined $self->dbdef_table->column('paycvv')
5116 && length($self->paycvv)
5117 && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
5119 my $error = $self->remove_cvv;
5121 warn "WARNING: error removing cvv: $error\n";
5129 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5141 if (ref($_[0]) eq 'HASH') {
5142 %options = %{$_[0]};
5144 my ( $method, $amount ) = ( shift, shift );
5146 $options{method} = $method;
5147 $options{amount} = $amount;
5150 if ( $options{'fake_failure'} ) {
5151 return "Error: No error; test failure requested with fake_failure";
5155 #if ( $payment_gateway->gatewaynum ) { # agent override
5156 # $paybatch = $payment_gateway->gatewaynum. '-';
5159 #$paybatch .= "$processor:". $transaction->authorization;
5161 #$paybatch .= ':'. $transaction->order_number
5162 # if $transaction->can('order_number')
5163 # && length($transaction->order_number);
5165 my $paybatch = 'FakeProcessor:54:32';
5167 my $cust_pay = new FS::cust_pay ( {
5168 'custnum' => $self->custnum,
5169 'invnum' => $options{'invnum'},
5170 'paid' => $options{amount},
5172 'payby' => $bop_method2payby{$options{method}},
5173 #'payinfo' => $payinfo,
5174 'payinfo' => '4111111111111111',
5175 'paybatch' => $paybatch,
5176 #'paydate' => $paydate,
5177 'paydate' => '2012-05-01',
5179 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
5181 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5184 $cust_pay->invnum(''); #try again with no specific invnum
5185 my $error2 = $cust_pay->insert( $options{'manual'} ?
5186 ( 'manual' => 1 ) : ()
5189 # gah, even with transactions.
5190 my $e = 'WARNING: Card/ACH debited but database not updated - '.
5191 "error inserting (fake!) payment: $error2".
5192 " (previously tried insert with invnum #$options{'invnum'}" .
5199 if ( $options{'paynum_ref'} ) {
5200 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5203 return ''; #no error
5208 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
5210 # Wraps up processing of a realtime credit card, ACH (electronic check) or
5211 # phone bill transaction.
5213 sub _realtime_bop_result {
5214 my( $self, $cust_pay_pending, $transaction, %options ) = @_;
5216 warn "$me _realtime_bop_result: pending transaction ".
5217 $cust_pay_pending->paypendingnum. "\n";
5218 warn " $_ => $options{$_}\n" foreach keys %options;
5221 my $payment_gateway = $options{payment_gateway}
5222 or return "no payment gateway in arguments to _realtime_bop_result";
5224 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
5225 my $cpp_captured_err = $cust_pay_pending->replace;
5226 return $cpp_captured_err if $cpp_captured_err;
5228 if ( $transaction->is_success() ) {
5231 if ( $payment_gateway->gatewaynum ) { # agent override
5232 $paybatch = $payment_gateway->gatewaynum. '-';
5235 $paybatch .= $payment_gateway->gateway_module. ":".
5236 $transaction->authorization;
5238 $paybatch .= ':'. $transaction->order_number
5239 if $transaction->can('order_number')
5240 && length($transaction->order_number);
5242 my $cust_pay = new FS::cust_pay ( {
5243 'custnum' => $self->custnum,
5244 'invnum' => $options{'invnum'},
5245 'paid' => $cust_pay_pending->paid,
5247 'payby' => $cust_pay_pending->payby,
5248 #'payinfo' => $payinfo,
5249 'paybatch' => $paybatch,
5250 'paydate' => $cust_pay_pending->paydate,
5252 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
5253 $cust_pay->payunique( $options{payunique} )
5254 if defined($options{payunique}) && length($options{payunique});
5256 my $oldAutoCommit = $FS::UID::AutoCommit;
5257 local $FS::UID::AutoCommit = 0;
5260 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
5262 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5265 $cust_pay->invnum(''); #try again with no specific invnum
5266 my $error2 = $cust_pay->insert( $options{'manual'} ?
5267 ( 'manual' => 1 ) : ()
5270 # gah. but at least we have a record of the state we had to abort in
5271 # from cust_pay_pending now.
5272 my $e = "WARNING: $options{method} captured but payment not recorded -".
5273 " error inserting payment (". $payment_gateway->gateway_module.
5275 " (previously tried insert with invnum #$options{'invnum'}" .
5276 ": $error ) - pending payment saved as paypendingnum ".
5277 $cust_pay_pending->paypendingnum. "\n";
5283 my $jobnum = $cust_pay_pending->jobnum;
5285 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5287 unless ( $placeholder ) {
5288 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5289 my $e = "WARNING: $options{method} captured but job $jobnum not ".
5290 "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
5295 $error = $placeholder->delete;
5298 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5299 my $e = "WARNING: $options{method} captured but could not delete ".
5300 "job $jobnum for paypendingnum ".
5301 $cust_pay_pending->paypendingnum. ": $error\n";
5308 if ( $options{'paynum_ref'} ) {
5309 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5312 $cust_pay_pending->status('done');
5313 $cust_pay_pending->statustext('captured');
5314 $cust_pay_pending->paynum($cust_pay->paynum);
5315 my $cpp_done_err = $cust_pay_pending->replace;
5317 if ( $cpp_done_err ) {
5319 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5320 my $e = "WARNING: $options{method} captured but payment not recorded - ".
5321 "error updating status for paypendingnum ".
5322 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5328 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5329 return ''; #no error
5335 my $perror = $payment_gateway->gateway_module. " error: ".
5336 $transaction->error_message;
5338 my $jobnum = $cust_pay_pending->jobnum;
5340 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5342 if ( $placeholder ) {
5343 my $error = $placeholder->depended_delete;
5344 $error ||= $placeholder->delete;
5345 warn "error removing provisioning jobs after declined paypendingnum ".
5346 $cust_pay_pending->paypendingnum. "\n";
5348 my $e = "error finding job $jobnum for declined paypendingnum ".
5349 $cust_pay_pending->paypendingnum. "\n";
5355 unless ( $transaction->error_message ) {
5358 if ( $transaction->can('response_page') ) {
5360 'page' => ( $transaction->can('response_page')
5361 ? $transaction->response_page
5364 'code' => ( $transaction->can('response_code')
5365 ? $transaction->response_code
5368 'headers' => ( $transaction->can('response_headers')
5369 ? $transaction->response_headers
5375 "No additional debugging information available for ".
5376 $payment_gateway->gateway_module;
5379 $perror .= "No error_message returned from ".
5380 $payment_gateway->gateway_module. " -- ".
5381 ( ref($t_response) ? Dumper($t_response) : $t_response );
5385 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
5386 && $conf->exists('emaildecline')
5387 && grep { $_ ne 'POST' } $self->invoicing_list
5388 && ! grep { $transaction->error_message =~ /$_/ }
5389 $conf->config('emaildecline-exclude')
5391 my @templ = $conf->config('declinetemplate');
5392 my $template = new Text::Template (
5394 SOURCE => [ map "$_\n", @templ ],
5395 ) or return "($perror) can't create template: $Text::Template::ERROR";
5396 $template->compile()
5397 or return "($perror) can't compile template: $Text::Template::ERROR";
5399 my $templ_hash = { error => $transaction->error_message };
5401 my $error = send_email(
5402 'from' => $conf->config('invoice_from', $self->agentnum ),
5403 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
5404 'subject' => 'Your payment could not be processed',
5405 'body' => [ $template->fill_in(HASH => $templ_hash) ],
5408 $perror .= " (also received error sending decline notification: $error)"
5413 $cust_pay_pending->status('done');
5414 $cust_pay_pending->statustext("declined: $perror");
5415 my $cpp_done_err = $cust_pay_pending->replace;
5416 if ( $cpp_done_err ) {
5417 my $e = "WARNING: $options{method} declined but pending payment not ".
5418 "resolved - error updating status for paypendingnum ".
5419 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5421 $perror = "$e ($perror)";
5429 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
5431 Verifies successful third party processing of a realtime credit card,
5432 ACH (electronic check) or phone bill transaction via a
5433 Business::OnlineThirdPartyPayment realtime gateway. See
5434 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5436 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
5438 The additional options I<payname>, I<city>, I<state>,
5439 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5440 if set, will override the value from the customer record.
5442 I<description> is a free-text field passed to the gateway. It defaults to
5443 "Internet services".
5445 If an I<invnum> is specified, this payment (if successful) is applied to the
5446 specified invoice. If you don't specify an I<invnum> you might want to
5447 call the B<apply_payments> method.
5449 I<quiet> can be set true to surpress email decline notices.
5451 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5452 resulting paynum, if any.
5454 I<payunique> is a unique identifier for this payment.
5456 Returns a hashref containing elements bill_error (which will be undefined
5457 upon success) and session_id of any associated session.
5461 sub realtime_botpp_capture {
5462 my( $self, $cust_pay_pending, %options ) = @_;
5464 warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
5465 warn " $_ => $options{$_}\n" foreach keys %options;
5468 eval "use Business::OnlineThirdPartyPayment";
5472 # select the gateway
5475 my $method = FS::payby->payby2bop($cust_pay_pending->payby);
5477 my $payment_gateway = $cust_pay_pending->gatewaynum
5478 ? qsearchs( 'payment_gateway',
5479 { gatewaynum => $cust_pay_pending->gatewaynum }
5481 : $self->agent->payment_gateway( 'method' => $method,
5482 # 'invnum' => $cust_pay_pending->invnum,
5483 # 'payinfo' => $cust_pay_pending->payinfo,
5486 $options{payment_gateway} = $payment_gateway; # for the helper subs
5492 my @invoicing_list = $self->invoicing_list_emailonly;
5493 if ( $conf->exists('emailinvoiceautoalways')
5494 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5495 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5496 push @invoicing_list, $self->all_emails;
5499 my $email = ($conf->exists('business-onlinepayment-email-override'))
5500 ? $conf->config('business-onlinepayment-email-override')
5501 : $invoicing_list[0];
5505 $content{email_customer} =
5506 ( $conf->exists('business-onlinepayment-email_customer')
5507 || $conf->exists('business-onlinepayment-email-override') );
5510 # run transaction(s)
5514 new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
5515 $self->_bop_options(\%options),
5518 $transaction->reference({ %options });
5520 $transaction->content(
5522 $self->_bop_auth(\%options),
5523 'action' => 'Post Authorization',
5524 'description' => $options{'description'},
5525 'amount' => $cust_pay_pending->paid,
5526 #'invoice_number' => $options{'invnum'},
5527 'customer_id' => $self->custnum,
5528 'referer' => 'http://cleanwhisker.420.am/',
5529 'reference' => $cust_pay_pending->paypendingnum,
5531 'phone' => $self->daytime || $self->night,
5533 # plus whatever is required for bogus capture avoidance
5536 $transaction->submit();
5539 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5542 bill_error => $error,
5543 session_id => $cust_pay_pending->session_id,
5548 =item default_payment_gateway DEPRECATED -- use agent->payment_gateway
5552 sub default_payment_gateway {
5553 my( $self, $method ) = @_;
5555 die "Real-time processing not enabled\n"
5556 unless $conf->exists('business-onlinepayment');
5558 #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
5561 my $bop_config = 'business-onlinepayment';
5562 $bop_config .= '-ach'
5563 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
5564 my ( $processor, $login, $password, $action, @bop_options ) =
5565 $conf->config($bop_config);
5566 $action ||= 'normal authorization';
5567 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
5568 die "No real-time processor is enabled - ".
5569 "did you set the business-onlinepayment configuration value?\n"
5572 ( $processor, $login, $password, $action, @bop_options )
5577 Removes the I<paycvv> field from the database directly.
5579 If there is an error, returns the error, otherwise returns false.
5585 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
5586 or return dbh->errstr;
5587 $sth->execute($self->custnum)
5588 or return $sth->errstr;
5593 =item _new_realtime_refund_bop METHOD [ OPTION => VALUE ... ]
5595 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
5596 via a Business::OnlinePayment realtime gateway. See
5597 L<http://420.am/business-onlinepayment> for supported gateways.
5599 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5601 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
5603 Most gateways require a reference to an original payment transaction to refund,
5604 so you probably need to specify a I<paynum>.
5606 I<amount> defaults to the original amount of the payment if not specified.
5608 I<reason> specifies a reason for the refund.
5610 I<paydate> specifies the expiration date for a credit card overriding the
5611 value from the customer record or the payment record. Specified as yyyy-mm-dd
5613 Implementation note: If I<amount> is unspecified or equal to the amount of the
5614 orignal payment, first an attempt is made to "void" the transaction via
5615 the gateway (to cancel a not-yet settled transaction) and then if that fails,
5616 the normal attempt is made to "refund" ("credit") the transaction via the
5617 gateway is attempted.
5619 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5620 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5621 #if set, will override the value from the customer record.
5623 #If an I<invnum> is specified, this payment (if successful) is applied to the
5624 #specified invoice. If you don't specify an I<invnum> you might want to
5625 #call the B<apply_payments> method.
5629 #some false laziness w/realtime_bop, not enough to make it worth merging
5630 #but some useful small subs should be pulled out
5631 sub _new_realtime_refund_bop {
5635 if (ref($_[0]) ne 'HASH') {
5636 %options = %{$_[0]};
5640 $options{method} = $method;
5644 warn "$me realtime_refund_bop (new): $options{method} refund\n";
5645 warn " $_ => $options{$_}\n" foreach keys %options;
5649 # look up the original payment and optionally a gateway for that payment
5653 my $amount = $options{'amount'};
5655 my( $processor, $login, $password, @bop_options, $namespace ) ;
5656 my( $auth, $order_number ) = ( '', '', '' );
5658 if ( $options{'paynum'} ) {
5660 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
5661 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
5662 or return "Unknown paynum $options{'paynum'}";
5663 $amount ||= $cust_pay->paid;
5665 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
5666 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
5667 $cust_pay->paybatch;
5668 my $gatewaynum = '';
5669 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
5671 if ( $gatewaynum ) { #gateway for the payment to be refunded
5673 my $payment_gateway =
5674 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
5675 die "payment gateway $gatewaynum not found"
5676 unless $payment_gateway;
5678 $processor = $payment_gateway->gateway_module;
5679 $login = $payment_gateway->gateway_username;
5680 $password = $payment_gateway->gateway_password;
5681 $namespace = $payment_gateway->gateway_namespace;
5682 @bop_options = $payment_gateway->options;
5684 } else { #try the default gateway
5687 my $payment_gateway =
5688 $self->agent->payment_gateway('method' => $options{method});
5690 ( $conf_processor, $login, $password, $namespace ) =
5691 map { my $method = "gateway_$_"; $payment_gateway->$method }
5692 qw( module username password namespace );
5694 @bop_options = $payment_gateway->gatewaynum
5695 ? $payment_gateway->options
5696 : @{ $payment_gateway->get('options') };
5698 return "processor of payment $options{'paynum'} $processor does not".
5699 " match default processor $conf_processor"
5700 unless $processor eq $conf_processor;
5705 } else { # didn't specify a paynum, so look for agent gateway overrides
5706 # like a normal transaction
5708 my $payment_gateway =
5709 $self->agent->payment_gateway( 'method' => $options{method},
5710 #'payinfo' => $payinfo,
5712 my( $processor, $login, $password, $namespace ) =
5713 map { my $method = "gateway_$_"; $payment_gateway->$method }
5714 qw( module username password namespace );
5716 my @bop_options = $payment_gateway->gatewaynum
5717 ? $payment_gateway->options
5718 : @{ $payment_gateway->get('options') };
5721 return "neither amount nor paynum specified" unless $amount;
5723 eval "use $namespace";
5727 'type' => $options{method},
5729 'password' => $password,
5730 'order_number' => $order_number,
5731 'amount' => $amount,
5732 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
5734 $content{authorization} = $auth
5735 if length($auth); #echeck/ACH transactions have an order # but no auth
5736 #(at least with authorize.net)
5738 my $disable_void_after;
5739 if ($conf->exists('disable_void_after')
5740 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
5741 $disable_void_after = $1;
5744 #first try void if applicable
5745 if ( $cust_pay && $cust_pay->paid == $amount
5747 ( not defined($disable_void_after) )
5748 || ( time < ($cust_pay->_date + $disable_void_after ) )
5751 warn " attempting void\n" if $DEBUG > 1;
5752 my $void = new Business::OnlinePayment( $processor, @bop_options );
5753 $void->content( 'action' => 'void', %content );
5755 if ( $void->is_success ) {
5756 my $error = $cust_pay->void($options{'reason'});
5758 # gah, even with transactions.
5759 my $e = 'WARNING: Card/ACH voided but database not updated - '.
5760 "error voiding payment: $error";
5764 warn " void successful\n" if $DEBUG > 1;
5769 warn " void unsuccessful, trying refund\n"
5773 my $address = $self->address1;
5774 $address .= ", ". $self->address2 if $self->address2;
5776 my($payname, $payfirst, $paylast);
5777 if ( $self->payname && $options{method} ne 'ECHECK' ) {
5778 $payname = $self->payname;
5779 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5780 or return "Illegal payname $payname";
5781 ($payfirst, $paylast) = ($1, $2);
5783 $payfirst = $self->getfield('first');
5784 $paylast = $self->getfield('last');
5785 $payname = "$payfirst $paylast";
5788 my @invoicing_list = $self->invoicing_list_emailonly;
5789 if ( $conf->exists('emailinvoiceautoalways')
5790 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5791 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5792 push @invoicing_list, $self->all_emails;
5795 my $email = ($conf->exists('business-onlinepayment-email-override'))
5796 ? $conf->config('business-onlinepayment-email-override')
5797 : $invoicing_list[0];
5799 my $payip = exists($options{'payip'})
5802 $content{customer_ip} = $payip
5806 if ( $options{method} eq 'CC' ) {
5809 $content{card_number} = $payinfo = $cust_pay->payinfo;
5810 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
5811 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
5812 ($content{expiration} = "$2/$1"); # where available
5814 $content{card_number} = $payinfo = $self->payinfo;
5815 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
5816 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
5817 $content{expiration} = "$2/$1";
5820 } elsif ( $options{method} eq 'ECHECK' ) {
5823 $payinfo = $cust_pay->payinfo;
5825 $payinfo = $self->payinfo;
5827 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
5828 $content{bank_name} = $self->payname;
5829 $content{account_type} = 'CHECKING';
5830 $content{account_name} = $payname;
5831 $content{customer_org} = $self->company ? 'B' : 'I';
5832 $content{customer_ssn} = $self->ss;
5833 } elsif ( $options{method} eq 'LEC' ) {
5834 $content{phone} = $payinfo = $self->payinfo;
5838 my $refund = new Business::OnlinePayment( $processor, @bop_options );
5839 my %sub_content = $refund->content(
5840 'action' => 'credit',
5841 'customer_id' => $self->custnum,
5842 'last_name' => $paylast,
5843 'first_name' => $payfirst,
5845 'address' => $address,
5846 'city' => $self->city,
5847 'state' => $self->state,
5848 'zip' => $self->zip,
5849 'country' => $self->country,
5851 'phone' => $self->daytime || $self->night,
5854 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
5858 return "$processor error: ". $refund->error_message
5859 unless $refund->is_success();
5861 my $paybatch = "$processor:". $refund->authorization;
5862 $paybatch .= ':'. $refund->order_number
5863 if $refund->can('order_number') && $refund->order_number;
5865 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
5866 my @cust_bill_pay = $cust_pay->cust_bill_pay;
5867 last unless @cust_bill_pay;
5868 my $cust_bill_pay = pop @cust_bill_pay;
5869 my $error = $cust_bill_pay->delete;
5873 my $cust_refund = new FS::cust_refund ( {
5874 'custnum' => $self->custnum,
5875 'paynum' => $options{'paynum'},
5876 'refund' => $amount,
5878 'payby' => $bop_method2payby{$options{method}},
5879 'payinfo' => $payinfo,
5880 'paybatch' => $paybatch,
5881 'reason' => $options{'reason'} || 'card or ACH refund',
5883 my $error = $cust_refund->insert;
5885 $cust_refund->paynum(''); #try again with no specific paynum
5886 my $error2 = $cust_refund->insert;
5888 # gah, even with transactions.
5889 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
5890 "error inserting refund ($processor): $error2".
5891 " (previously tried insert with paynum #$options{'paynum'}" .
5902 =item batch_card OPTION => VALUE...
5904 Adds a payment for this invoice to the pending credit card batch (see
5905 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
5906 runs the payment using a realtime gateway.
5911 my ($self, %options) = @_;
5914 if (exists($options{amount})) {
5915 $amount = $options{amount};
5917 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
5919 return '' unless $amount > 0;
5921 my $invnum = delete $options{invnum};
5922 my $payby = $options{invnum} || $self->payby; #dubious
5924 if ($options{'realtime'}) {
5925 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
5931 my $oldAutoCommit = $FS::UID::AutoCommit;
5932 local $FS::UID::AutoCommit = 0;
5935 #this needs to handle mysql as well as Pg, like svc_acct.pm
5936 #(make it into a common function if folks need to do batching with mysql)
5937 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
5938 or return "Cannot lock pay_batch: " . $dbh->errstr;
5942 'payby' => FS::payby->payby2payment($payby),
5945 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
5947 unless ( $pay_batch ) {
5948 $pay_batch = new FS::pay_batch \%pay_batch;
5949 my $error = $pay_batch->insert;
5951 $dbh->rollback if $oldAutoCommit;
5952 die "error creating new batch: $error\n";
5956 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
5957 'batchnum' => $pay_batch->batchnum,
5958 'custnum' => $self->custnum,
5961 foreach (qw( address1 address2 city state zip country payby payinfo paydate
5963 $options{$_} = '' unless exists($options{$_});
5966 my $cust_pay_batch = new FS::cust_pay_batch ( {
5967 'batchnum' => $pay_batch->batchnum,
5968 'invnum' => $invnum || 0, # is there a better value?
5969 # this field should be
5971 # cust_bill_pay_batch now
5972 'custnum' => $self->custnum,
5973 'last' => $self->getfield('last'),
5974 'first' => $self->getfield('first'),
5975 'address1' => $options{address1} || $self->address1,
5976 'address2' => $options{address2} || $self->address2,
5977 'city' => $options{city} || $self->city,
5978 'state' => $options{state} || $self->state,
5979 'zip' => $options{zip} || $self->zip,
5980 'country' => $options{country} || $self->country,
5981 'payby' => $options{payby} || $self->payby,
5982 'payinfo' => $options{payinfo} || $self->payinfo,
5983 'exp' => $options{paydate} || $self->paydate,
5984 'payname' => $options{payname} || $self->payname,
5985 'amount' => $amount, # consolidating
5988 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
5989 if $old_cust_pay_batch;
5992 if ($old_cust_pay_batch) {
5993 $error = $cust_pay_batch->replace($old_cust_pay_batch)
5995 $error = $cust_pay_batch->insert;
5999 $dbh->rollback if $oldAutoCommit;
6003 my $unapplied = $self->total_unapplied_credits
6004 + $self->total_unapplied_payments
6005 + $self->in_transit_payments;
6006 foreach my $cust_bill ($self->open_cust_bill) {
6007 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
6008 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
6009 'invnum' => $cust_bill->invnum,
6010 'paybatchnum' => $cust_pay_batch->paybatchnum,
6011 'amount' => $cust_bill->owed,
6014 if ($unapplied >= $cust_bill_pay_batch->amount){
6015 $unapplied -= $cust_bill_pay_batch->amount;
6018 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
6019 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
6021 $error = $cust_bill_pay_batch->insert;
6023 $dbh->rollback if $oldAutoCommit;
6028 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6032 =item apply_payments_and_credits
6034 Applies unapplied payments and credits.
6036 In most cases, this new method should be used in place of sequential
6037 apply_payments and apply_credits methods.
6039 If there is an error, returns the error, otherwise returns false.
6043 sub apply_payments_and_credits {
6046 local $SIG{HUP} = 'IGNORE';
6047 local $SIG{INT} = 'IGNORE';
6048 local $SIG{QUIT} = 'IGNORE';
6049 local $SIG{TERM} = 'IGNORE';
6050 local $SIG{TSTP} = 'IGNORE';
6051 local $SIG{PIPE} = 'IGNORE';
6053 my $oldAutoCommit = $FS::UID::AutoCommit;
6054 local $FS::UID::AutoCommit = 0;
6057 $self->select_for_update; #mutex
6059 foreach my $cust_bill ( $self->open_cust_bill ) {
6060 my $error = $cust_bill->apply_payments_and_credits;
6062 $dbh->rollback if $oldAutoCommit;
6063 return "Error applying: $error";
6067 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6072 =item apply_credits OPTION => VALUE ...
6074 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
6075 to outstanding invoice balances in chronological order (or reverse
6076 chronological order if the I<order> option is set to B<newest>) and returns the
6077 value of any remaining unapplied credits available for refund (see
6078 L<FS::cust_refund>).
6080 Dies if there is an error.
6088 local $SIG{HUP} = 'IGNORE';
6089 local $SIG{INT} = 'IGNORE';
6090 local $SIG{QUIT} = 'IGNORE';
6091 local $SIG{TERM} = 'IGNORE';
6092 local $SIG{TSTP} = 'IGNORE';
6093 local $SIG{PIPE} = 'IGNORE';
6095 my $oldAutoCommit = $FS::UID::AutoCommit;
6096 local $FS::UID::AutoCommit = 0;
6099 $self->select_for_update; #mutex
6101 unless ( $self->total_unapplied_credits ) {
6102 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6106 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
6107 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
6109 my @invoices = $self->open_cust_bill;
6110 @invoices = sort { $b->_date <=> $a->_date } @invoices
6111 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
6113 if ( $conf->exists('pkg-balances') ) {
6114 # limit @credits to those w/ a pkgnum grepped from $self
6116 foreach my $i (@invoices) {
6117 foreach my $li ( $i->cust_bill_pkg ) {
6118 $pkgnums{$li->pkgnum} = 1;
6121 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
6126 foreach my $cust_bill ( @invoices ) {
6128 if ( !defined($credit) || $credit->credited == 0) {
6129 $credit = pop @credits or last;
6133 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
6134 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
6136 $owed = $cust_bill->owed;
6138 unless ( $owed > 0 ) {
6139 push @credits, $credit;
6143 my $amount = min( $credit->credited, $owed );
6145 my $cust_credit_bill = new FS::cust_credit_bill ( {
6146 'crednum' => $credit->crednum,
6147 'invnum' => $cust_bill->invnum,
6148 'amount' => $amount,
6150 $cust_credit_bill->pkgnum( $credit->pkgnum )
6151 if $conf->exists('pkg-balances') && $credit->pkgnum;
6152 my $error = $cust_credit_bill->insert;
6154 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6158 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6162 my $total_unapplied_credits = $self->total_unapplied_credits;
6164 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6166 return $total_unapplied_credits;
6169 =item apply_payments
6171 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
6172 to outstanding invoice balances in chronological order.
6174 #and returns the value of any remaining unapplied payments.
6176 Dies if there is an error.
6180 sub apply_payments {
6183 local $SIG{HUP} = 'IGNORE';
6184 local $SIG{INT} = 'IGNORE';
6185 local $SIG{QUIT} = 'IGNORE';
6186 local $SIG{TERM} = 'IGNORE';
6187 local $SIG{TSTP} = 'IGNORE';
6188 local $SIG{PIPE} = 'IGNORE';
6190 my $oldAutoCommit = $FS::UID::AutoCommit;
6191 local $FS::UID::AutoCommit = 0;
6194 $self->select_for_update; #mutex
6198 my @payments = sort { $b->_date <=> $a->_date }
6199 grep { $_->unapplied > 0 }
6202 my @invoices = sort { $a->_date <=> $b->_date}
6203 grep { $_->owed > 0 }
6206 if ( $conf->exists('pkg-balances') ) {
6207 # limit @payments to those w/ a pkgnum grepped from $self
6209 foreach my $i (@invoices) {
6210 foreach my $li ( $i->cust_bill_pkg ) {
6211 $pkgnums{$li->pkgnum} = 1;
6214 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
6219 foreach my $cust_bill ( @invoices ) {
6221 if ( !defined($payment) || $payment->unapplied == 0 ) {
6222 $payment = pop @payments or last;
6226 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
6227 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
6229 $owed = $cust_bill->owed;
6231 unless ( $owed > 0 ) {
6232 push @payments, $payment;
6236 my $amount = min( $payment->unapplied, $owed );
6238 my $cust_bill_pay = new FS::cust_bill_pay ( {
6239 'paynum' => $payment->paynum,
6240 'invnum' => $cust_bill->invnum,
6241 'amount' => $amount,
6243 $cust_bill_pay->pkgnum( $payment->pkgnum )
6244 if $conf->exists('pkg-balances') && $payment->pkgnum;
6245 my $error = $cust_bill_pay->insert;
6247 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6251 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6255 my $total_unapplied_payments = $self->total_unapplied_payments;
6257 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6259 return $total_unapplied_payments;
6264 Returns the total owed for this customer on all invoices
6265 (see L<FS::cust_bill/owed>).
6271 $self->total_owed_date(2145859200); #12/31/2037
6274 =item total_owed_date TIME
6276 Returns the total owed for this customer on all invoices with date earlier than
6277 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6278 see L<Time::Local> and L<Date::Parse> for conversion functions.
6282 sub total_owed_date {
6286 # my $custnum = $self->custnum;
6288 # my $owed_sql = FS::cust_bill->owed_sql;
6291 # SELECT SUM($owed_sql) FROM cust_bill
6292 # WHERE custnum = $custnum
6293 # AND _date <= $time
6296 # my $sth = dbh->prepare($sql) or die dbh->errstr;
6297 # $sth->execute() or die $sth->errstr;
6299 # return sprintf( '%.2f', $sth->fetchrow_arrayref->[0] );
6302 foreach my $cust_bill (
6303 grep { $_->_date <= $time }
6304 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6306 $total_bill += $cust_bill->owed;
6308 sprintf( "%.2f", $total_bill );
6312 =item total_owed_pkgnum PKGNUM
6314 Returns the total owed on all invoices for this customer's specific package
6315 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
6319 sub total_owed_pkgnum {
6320 my( $self, $pkgnum ) = @_;
6321 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
6324 =item total_owed_date_pkgnum TIME PKGNUM
6326 Returns the total owed for this customer's specific package when using
6327 experimental package balances on all invoices with date earlier than
6328 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6329 see L<Time::Local> and L<Date::Parse> for conversion functions.
6333 sub total_owed_date_pkgnum {
6334 my( $self, $time, $pkgnum ) = @_;
6337 foreach my $cust_bill (
6338 grep { $_->_date <= $time }
6339 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6341 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
6343 sprintf( "%.2f", $total_bill );
6349 Returns the total amount of all payments.
6356 $total += $_->paid foreach $self->cust_pay;
6357 sprintf( "%.2f", $total );
6360 =item total_unapplied_credits
6362 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6363 customer. See L<FS::cust_credit/credited>.
6365 =item total_credited
6367 Old name for total_unapplied_credits. Don't use.
6371 sub total_credited {
6372 #carp "total_credited deprecated, use total_unapplied_credits";
6373 shift->total_unapplied_credits(@_);
6376 sub total_unapplied_credits {
6378 my $total_credit = 0;
6379 $total_credit += $_->credited foreach $self->cust_credit;
6380 sprintf( "%.2f", $total_credit );
6383 =item total_unapplied_credits_pkgnum PKGNUM
6385 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6386 customer. See L<FS::cust_credit/credited>.
6390 sub total_unapplied_credits_pkgnum {
6391 my( $self, $pkgnum ) = @_;
6392 my $total_credit = 0;
6393 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
6394 sprintf( "%.2f", $total_credit );
6398 =item total_unapplied_payments
6400 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
6401 See L<FS::cust_pay/unapplied>.
6405 sub total_unapplied_payments {
6407 my $total_unapplied = 0;
6408 $total_unapplied += $_->unapplied foreach $self->cust_pay;
6409 sprintf( "%.2f", $total_unapplied );
6412 =item total_unapplied_payments_pkgnum PKGNUM
6414 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
6415 specific package when using experimental package balances. See
6416 L<FS::cust_pay/unapplied>.
6420 sub total_unapplied_payments_pkgnum {
6421 my( $self, $pkgnum ) = @_;
6422 my $total_unapplied = 0;
6423 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
6424 sprintf( "%.2f", $total_unapplied );
6428 =item total_unapplied_refunds
6430 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
6431 customer. See L<FS::cust_refund/unapplied>.
6435 sub total_unapplied_refunds {
6437 my $total_unapplied = 0;
6438 $total_unapplied += $_->unapplied foreach $self->cust_refund;
6439 sprintf( "%.2f", $total_unapplied );
6444 Returns the balance for this customer (total_owed plus total_unrefunded, minus
6445 total_unapplied_credits minus total_unapplied_payments).
6453 + $self->total_unapplied_refunds
6454 - $self->total_unapplied_credits
6455 - $self->total_unapplied_payments
6459 =item balance_date TIME
6461 Returns the balance for this customer, only considering invoices with date
6462 earlier than TIME (total_owed_date minus total_credited minus
6463 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
6464 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
6473 $self->total_owed_date($time)
6474 + $self->total_unapplied_refunds
6475 - $self->total_unapplied_credits
6476 - $self->total_unapplied_payments
6480 =item balance_pkgnum PKGNUM
6482 Returns the balance for this customer's specific package when using
6483 experimental package balances (total_owed plus total_unrefunded, minus
6484 total_unapplied_credits minus total_unapplied_payments)
6488 sub balance_pkgnum {
6489 my( $self, $pkgnum ) = @_;
6492 $self->total_owed_pkgnum($pkgnum)
6493 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
6494 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
6495 - $self->total_unapplied_credits_pkgnum($pkgnum)
6496 - $self->total_unapplied_payments_pkgnum($pkgnum)
6500 =item in_transit_payments
6502 Returns the total of requests for payments for this customer pending in
6503 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
6507 sub in_transit_payments {
6509 my $in_transit_payments = 0;
6510 foreach my $pay_batch ( qsearch('pay_batch', {
6513 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
6514 'batchnum' => $pay_batch->batchnum,
6515 'custnum' => $self->custnum,
6517 $in_transit_payments += $cust_pay_batch->amount;
6520 sprintf( "%.2f", $in_transit_payments );
6525 Returns a hash of useful information for making a payment.
6535 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
6536 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
6537 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
6541 For credit card transactions:
6553 For electronic check transactions:
6568 $return{balance} = $self->balance;
6570 $return{payname} = $self->payname
6571 || ( $self->first. ' '. $self->get('last') );
6573 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
6575 $return{payby} = $self->payby;
6576 $return{stateid_state} = $self->stateid_state;
6578 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
6579 $return{card_type} = cardtype($self->payinfo);
6580 $return{payinfo} = $self->paymask;
6582 @return{'month', 'year'} = $self->paydate_monthyear;
6586 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
6587 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
6588 $return{payinfo1} = $payinfo1;
6589 $return{payinfo2} = $payinfo2;
6590 $return{paytype} = $self->paytype;
6591 $return{paystate} = $self->paystate;
6595 #doubleclick protection
6597 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
6603 =item paydate_monthyear
6605 Returns a two-element list consisting of the month and year of this customer's
6606 paydate (credit card expiration date for CARD customers)
6610 sub paydate_monthyear {
6612 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
6614 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
6621 =item tax_exemption TAXNAME
6626 my( $self, $taxname ) = @_;
6628 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
6629 'taxname' => $taxname,
6634 =item cust_main_exemption
6638 sub cust_main_exemption {
6640 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
6643 =item invoicing_list [ ARRAYREF ]
6645 If an arguement is given, sets these email addresses as invoice recipients
6646 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
6647 (except as warnings), so use check_invoicing_list first.
6649 Returns a list of email addresses (with svcnum entries expanded).
6651 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
6652 check it without disturbing anything by passing nothing.
6654 This interface may change in the future.
6658 sub invoicing_list {
6659 my( $self, $arrayref ) = @_;
6662 my @cust_main_invoice;
6663 if ( $self->custnum ) {
6664 @cust_main_invoice =
6665 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6667 @cust_main_invoice = ();
6669 foreach my $cust_main_invoice ( @cust_main_invoice ) {
6670 #warn $cust_main_invoice->destnum;
6671 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
6672 #warn $cust_main_invoice->destnum;
6673 my $error = $cust_main_invoice->delete;
6674 warn $error if $error;
6677 if ( $self->custnum ) {
6678 @cust_main_invoice =
6679 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6681 @cust_main_invoice = ();
6683 my %seen = map { $_->address => 1 } @cust_main_invoice;
6684 foreach my $address ( @{$arrayref} ) {
6685 next if exists $seen{$address} && $seen{$address};
6686 $seen{$address} = 1;
6687 my $cust_main_invoice = new FS::cust_main_invoice ( {
6688 'custnum' => $self->custnum,
6691 my $error = $cust_main_invoice->insert;
6692 warn $error if $error;
6696 if ( $self->custnum ) {
6698 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6705 =item check_invoicing_list ARRAYREF
6707 Checks these arguements as valid input for the invoicing_list method. If there
6708 is an error, returns the error, otherwise returns false.
6712 sub check_invoicing_list {
6713 my( $self, $arrayref ) = @_;
6715 foreach my $address ( @$arrayref ) {
6717 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
6718 return 'Can\'t add FAX invoice destination with a blank FAX number.';
6721 my $cust_main_invoice = new FS::cust_main_invoice ( {
6722 'custnum' => $self->custnum,
6725 my $error = $self->custnum
6726 ? $cust_main_invoice->check
6727 : $cust_main_invoice->checkdest
6729 return $error if $error;
6733 return "Email address required"
6734 if $conf->exists('cust_main-require_invoicing_list_email')
6735 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
6740 =item set_default_invoicing_list
6742 Sets the invoicing list to all accounts associated with this customer,
6743 overwriting any previous invoicing list.
6747 sub set_default_invoicing_list {
6749 $self->invoicing_list($self->all_emails);
6754 Returns the email addresses of all accounts provisioned for this customer.
6761 foreach my $cust_pkg ( $self->all_pkgs ) {
6762 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
6764 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
6765 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
6767 $list{$_}=1 foreach map { $_->email } @svc_acct;
6772 =item invoicing_list_addpost
6774 Adds postal invoicing to this customer. If this customer is already configured
6775 to receive postal invoices, does nothing.
6779 sub invoicing_list_addpost {
6781 return if grep { $_ eq 'POST' } $self->invoicing_list;
6782 my @invoicing_list = $self->invoicing_list;
6783 push @invoicing_list, 'POST';
6784 $self->invoicing_list(\@invoicing_list);
6787 =item invoicing_list_emailonly
6789 Returns the list of email invoice recipients (invoicing_list without non-email
6790 destinations such as POST and FAX).
6794 sub invoicing_list_emailonly {
6796 warn "$me invoicing_list_emailonly called"
6798 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
6801 =item invoicing_list_emailonly_scalar
6803 Returns the list of email invoice recipients (invoicing_list without non-email
6804 destinations such as POST and FAX) as a comma-separated scalar.
6808 sub invoicing_list_emailonly_scalar {
6810 warn "$me invoicing_list_emailonly_scalar called"
6812 join(', ', $self->invoicing_list_emailonly);
6815 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
6817 Returns an array of customers referred by this customer (referral_custnum set
6818 to this custnum). If DEPTH is given, recurses up to the given depth, returning
6819 customers referred by customers referred by this customer and so on, inclusive.
6820 The default behavior is DEPTH 1 (no recursion).
6824 sub referral_cust_main {
6826 my $depth = @_ ? shift : 1;
6827 my $exclude = @_ ? shift : {};
6830 map { $exclude->{$_->custnum}++; $_; }
6831 grep { ! $exclude->{ $_->custnum } }
6832 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
6836 map { $_->referral_cust_main($depth-1, $exclude) }
6843 =item referral_cust_main_ncancelled
6845 Same as referral_cust_main, except only returns customers with uncancelled
6850 sub referral_cust_main_ncancelled {
6852 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
6855 =item referral_cust_pkg [ DEPTH ]
6857 Like referral_cust_main, except returns a flat list of all unsuspended (and
6858 uncancelled) packages for each customer. The number of items in this list may
6859 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
6863 sub referral_cust_pkg {
6865 my $depth = @_ ? shift : 1;
6867 map { $_->unsuspended_pkgs }
6868 grep { $_->unsuspended_pkgs }
6869 $self->referral_cust_main($depth);
6872 =item referring_cust_main
6874 Returns the single cust_main record for the customer who referred this customer
6875 (referral_custnum), or false.
6879 sub referring_cust_main {
6881 return '' unless $self->referral_custnum;
6882 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
6885 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
6887 Applies a credit to this customer. If there is an error, returns the error,
6888 otherwise returns false.
6890 REASON can be a text string, an FS::reason object, or a scalar reference to
6891 a reasonnum. If a text string, it will be automatically inserted as a new
6892 reason, and a 'reason_type' option must be passed to indicate the
6893 FS::reason_type for the new reason.
6895 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
6897 Any other options are passed to FS::cust_credit::insert.
6902 my( $self, $amount, $reason, %options ) = @_;
6904 my $cust_credit = new FS::cust_credit {
6905 'custnum' => $self->custnum,
6906 'amount' => $amount,
6909 if ( ref($reason) ) {
6911 if ( ref($reason) eq 'SCALAR' ) {
6912 $cust_credit->reasonnum( $$reason );
6914 $cust_credit->reasonnum( $reason->reasonnum );
6918 $cust_credit->set('reason', $reason)
6921 $cust_credit->addlinfo( delete $options{'addlinfo'} )
6922 if exists($options{'addlinfo'});
6924 $cust_credit->insert(%options);
6928 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
6930 Creates a one-time charge for this customer. If there is an error, returns
6931 the error, otherwise returns false.
6933 New-style, with a hashref of options:
6935 my $error = $cust_main->charge(
6939 'start_date' => str2time('7/4/2009'),
6940 'pkg' => 'Description',
6941 'comment' => 'Comment',
6942 'additional' => [], #extra invoice detail
6943 'classnum' => 1, #pkg_class
6945 'setuptax' => '', # or 'Y' for tax exempt
6948 'taxclass' => 'Tax class',
6951 'taxproduct' => 2, #part_pkg_taxproduct
6952 'override' => {}, #XXX describe
6958 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
6964 my ( $amount, $quantity, $start_date, $classnum );
6965 my ( $pkg, $comment, $additional );
6966 my ( $setuptax, $taxclass ); #internal taxes
6967 my ( $taxproduct, $override ); #vendor (CCH) taxes
6968 if ( ref( $_[0] ) ) {
6969 $amount = $_[0]->{amount};
6970 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
6971 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
6972 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
6973 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
6974 : '$'. sprintf("%.2f",$amount);
6975 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
6976 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
6977 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
6978 $additional = $_[0]->{additional} || [];
6979 $taxproduct = $_[0]->{taxproductnum};
6980 $override = { '' => $_[0]->{tax_override} };
6985 $pkg = @_ ? shift : 'One-time charge';
6986 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
6988 $taxclass = @_ ? shift : '';
6992 local $SIG{HUP} = 'IGNORE';
6993 local $SIG{INT} = 'IGNORE';
6994 local $SIG{QUIT} = 'IGNORE';
6995 local $SIG{TERM} = 'IGNORE';
6996 local $SIG{TSTP} = 'IGNORE';
6997 local $SIG{PIPE} = 'IGNORE';
6999 my $oldAutoCommit = $FS::UID::AutoCommit;
7000 local $FS::UID::AutoCommit = 0;
7003 my $part_pkg = new FS::part_pkg ( {
7005 'comment' => $comment,
7009 'classnum' => $classnum ? $classnum : '',
7010 'setuptax' => $setuptax,
7011 'taxclass' => $taxclass,
7012 'taxproductnum' => $taxproduct,
7015 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
7016 ( 0 .. @$additional - 1 )
7018 'additional_count' => scalar(@$additional),
7019 'setup_fee' => $amount,
7022 my $error = $part_pkg->insert( options => \%options,
7023 tax_overrides => $override,
7026 $dbh->rollback if $oldAutoCommit;
7030 my $pkgpart = $part_pkg->pkgpart;
7031 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
7032 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
7033 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
7034 $error = $type_pkgs->insert;
7036 $dbh->rollback if $oldAutoCommit;
7041 my $cust_pkg = new FS::cust_pkg ( {
7042 'custnum' => $self->custnum,
7043 'pkgpart' => $pkgpart,
7044 'quantity' => $quantity,
7045 'start_date' => $start_date,
7048 $error = $cust_pkg->insert;
7050 $dbh->rollback if $oldAutoCommit;
7054 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
7059 #=item charge_postal_fee
7061 #Applies a one time charge this customer. If there is an error,
7062 #returns the error, returns the cust_pkg charge object or false
7063 #if there was no charge.
7067 # This should be a customer event. For that to work requires that bill
7068 # also be a customer event.
7070 sub charge_postal_fee {
7073 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
7074 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
7076 my $cust_pkg = new FS::cust_pkg ( {
7077 'custnum' => $self->custnum,
7078 'pkgpart' => $pkgpart,
7082 my $error = $cust_pkg->insert;
7083 $error ? $error : $cust_pkg;
7088 Returns all the invoices (see L<FS::cust_bill>) for this customer.
7094 sort { $a->_date <=> $b->_date }
7095 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
7098 =item open_cust_bill
7100 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
7105 sub open_cust_bill {
7109 'table' => 'cust_bill',
7110 'hashref' => { 'custnum' => $self->custnum, },
7111 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
7112 'order_by' => 'ORDER BY _date ASC',
7119 Returns all the credits (see L<FS::cust_credit>) for this customer.
7125 sort { $a->_date <=> $b->_date }
7126 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
7129 =item cust_credit_pkgnum
7131 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
7132 package when using experimental package balances.
7136 sub cust_credit_pkgnum {
7137 my( $self, $pkgnum ) = @_;
7138 sort { $a->_date <=> $b->_date }
7139 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
7140 'pkgnum' => $pkgnum,
7147 Returns all the payments (see L<FS::cust_pay>) for this customer.
7153 sort { $a->_date <=> $b->_date }
7154 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
7157 =item cust_pay_pkgnum
7159 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
7160 package when using experimental package balances.
7164 sub cust_pay_pkgnum {
7165 my( $self, $pkgnum ) = @_;
7166 sort { $a->_date <=> $b->_date }
7167 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
7168 'pkgnum' => $pkgnum,
7175 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
7181 sort { $a->_date <=> $b->_date }
7182 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
7185 =item cust_pay_batch
7187 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
7191 sub cust_pay_batch {
7193 sort { $a->paybatchnum <=> $b->paybatchnum }
7194 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
7197 =item cust_pay_pending
7199 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
7200 (without status "done").
7204 sub cust_pay_pending {
7206 return $self->num_cust_pay_pending unless wantarray;
7207 sort { $a->_date <=> $b->_date }
7208 qsearch( 'cust_pay_pending', {
7209 'custnum' => $self->custnum,
7210 'status' => { op=>'!=', value=>'done' },
7215 =item num_cust_pay_pending
7217 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
7218 customer (without status "done"). Also called automatically when the
7219 cust_pay_pending method is used in a scalar context.
7223 sub num_cust_pay_pending {
7225 my $sql = " SELECT COUNT(*) FROM cust_pay_pending ".
7226 " WHERE custnum = ? AND status != 'done' ";
7227 my $sth = dbh->prepare($sql) or die dbh->errstr;
7228 $sth->execute($self->custnum) or die $sth->errstr;
7229 $sth->fetchrow_arrayref->[0];
7234 Returns all the refunds (see L<FS::cust_refund>) for this customer.
7240 sort { $a->_date <=> $b->_date }
7241 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
7244 =item display_custnum
7246 Returns the displayed customer number for this customer: agent_custid if
7247 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
7251 sub display_custnum {
7253 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
7254 return $self->agent_custid;
7256 return $self->custnum;
7262 Returns a name string for this customer, either "Company (Last, First)" or
7269 my $name = $self->contact;
7270 $name = $self->company. " ($name)" if $self->company;
7276 Returns a name string for this (service/shipping) contact, either
7277 "Company (Last, First)" or "Last, First".
7283 if ( $self->get('ship_last') ) {
7284 my $name = $self->ship_contact;
7285 $name = $self->ship_company. " ($name)" if $self->ship_company;
7294 Returns a name string for this customer, either "Company" or "First Last".
7300 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
7303 =item ship_name_short
7305 Returns a name string for this (service/shipping) contact, either "Company"
7310 sub ship_name_short {
7312 if ( $self->get('ship_last') ) {
7313 $self->ship_company !~ /^\s*$/
7314 ? $self->ship_company
7315 : $self->ship_contact_firstlast;
7317 $self->name_company_or_firstlast;
7323 Returns this customer's full (billing) contact name only, "Last, First"
7329 $self->get('last'). ', '. $self->first;
7334 Returns this customer's full (shipping) contact name only, "Last, First"
7340 $self->get('ship_last')
7341 ? $self->get('ship_last'). ', '. $self->ship_first
7345 =item contact_firstlast
7347 Returns this customers full (billing) contact name only, "First Last".
7351 sub contact_firstlast {
7353 $self->first. ' '. $self->get('last');
7356 =item ship_contact_firstlast
7358 Returns this customer's full (shipping) contact name only, "First Last".
7362 sub ship_contact_firstlast {
7364 $self->get('ship_last')
7365 ? $self->first. ' '. $self->get('ship_last')
7366 : $self->contact_firstlast;
7371 Returns this customer's full country name
7377 code2country($self->country);
7380 =item geocode DATA_VENDOR
7382 Returns a value for the customer location as encoded by DATA_VENDOR.
7383 Currently this only makes sense for "CCH" as DATA_VENDOR.
7388 my ($self, $data_vendor) = (shift, shift); #always cch for now
7390 my $geocode = $self->get('geocode'); #XXX only one data_vendor for geocode
7391 return $geocode if $geocode;
7393 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
7397 my ($zip,$plus4) = split /-/, $self->get("${prefix}zip")
7398 if $self->country eq 'US';
7400 #CCH specific location stuff
7401 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
7403 my @cust_tax_location =
7405 'table' => 'cust_tax_location',
7406 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
7407 'extra_sql' => $extra_sql,
7408 'order_by' => 'ORDER BY plus4hi',#overlapping with distinct ends
7411 $geocode = $cust_tax_location[0]->geocode
7412 if scalar(@cust_tax_location);
7421 Returns a status string for this customer, currently:
7425 =item prospect - No packages have ever been ordered
7427 =item active - One or more recurring packages is active
7429 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
7431 =item suspended - All non-cancelled recurring packages are suspended
7433 =item cancelled - All recurring packages are cancelled
7439 sub status { shift->cust_status(@_); }
7443 for my $status (qw( prospect active inactive suspended cancelled )) {
7444 my $method = $status.'_sql';
7445 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
7446 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
7447 $sth->execute( ($self->custnum) x $numnum )
7448 or die "Error executing 'SELECT $sql': ". $sth->errstr;
7449 return $status if $sth->fetchrow_arrayref->[0];
7453 =item ucfirst_cust_status
7455 =item ucfirst_status
7457 Returns the status with the first character capitalized.
7461 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
7463 sub ucfirst_cust_status {
7465 ucfirst($self->cust_status);
7470 Returns a hex triplet color string for this customer's status.
7474 use vars qw(%statuscolor);
7475 tie %statuscolor, 'Tie::IxHash',
7476 'prospect' => '7e0079', #'000000', #black? naw, purple
7477 'active' => '00CC00', #green
7478 'inactive' => '0000CC', #blue
7479 'suspended' => 'FF9900', #yellow
7480 'cancelled' => 'FF0000', #red
7483 sub statuscolor { shift->cust_statuscolor(@_); }
7485 sub cust_statuscolor {
7487 $statuscolor{$self->cust_status};
7492 Returns an array of hashes representing the customer's RT tickets.
7499 my $num = $conf->config('cust_main-max_tickets') || 10;
7502 if ( $conf->config('ticket_system') ) {
7503 unless ( $conf->config('ticket_system-custom_priority_field') ) {
7505 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
7509 foreach my $priority (
7510 $conf->config('ticket_system-custom_priority_field-values'), ''
7512 last if scalar(@tickets) >= $num;
7514 @{ FS::TicketSystem->customer_tickets( $self->custnum,
7515 $num - scalar(@tickets),
7525 # Return services representing svc_accts in customer support packages
7526 sub support_services {
7528 my %packages = map { $_ => 1 } $conf->config('support_packages');
7530 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
7531 grep { $_->part_svc->svcdb eq 'svc_acct' }
7532 map { $_->cust_svc }
7533 grep { exists $packages{ $_->pkgpart } }
7534 $self->ncancelled_pkgs;
7538 # Return a list of latitude/longitude for one of the services (if any)
7539 sub service_coordinates {
7543 grep { $_->latitude && $_->longitude }
7545 map { $_->cust_svc }
7546 $self->ncancelled_pkgs;
7548 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
7553 =head1 CLASS METHODS
7559 Class method that returns the list of possible status strings for customers
7560 (see L<the status method|/status>). For example:
7562 @statuses = FS::cust_main->statuses();
7567 #my $self = shift; #could be class...
7573 Returns an SQL expression identifying prospective cust_main records (customers
7574 with no packages ever ordered)
7578 use vars qw($select_count_pkgs);
7579 $select_count_pkgs =
7580 "SELECT COUNT(*) FROM cust_pkg
7581 WHERE cust_pkg.custnum = cust_main.custnum";
7583 sub select_count_pkgs_sql {
7587 sub prospect_sql { "
7588 0 = ( $select_count_pkgs )
7593 Returns an SQL expression identifying active cust_main records (customers with
7594 active recurring packages).
7599 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
7605 Returns an SQL expression identifying inactive cust_main records (customers with
7606 no active recurring packages, but otherwise unsuspended/uncancelled).
7610 sub inactive_sql { "
7611 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
7613 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
7619 Returns an SQL expression identifying suspended cust_main records.
7624 sub suspended_sql { susp_sql(@_); }
7626 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
7628 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
7634 Returns an SQL expression identifying cancelled cust_main records.
7638 sub cancelled_sql { cancel_sql(@_); }
7641 my $recurring_sql = FS::cust_pkg->recurring_sql;
7642 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
7645 0 < ( $select_count_pkgs )
7646 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
7647 AND 0 = ( $select_count_pkgs AND $recurring_sql
7648 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
7650 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
7656 =item uncancelled_sql
7658 Returns an SQL expression identifying un-cancelled cust_main records.
7662 sub uncancelled_sql { uncancel_sql(@_); }
7663 sub uncancel_sql { "
7664 ( 0 < ( $select_count_pkgs
7665 AND ( cust_pkg.cancel IS NULL
7666 OR cust_pkg.cancel = 0
7669 OR 0 = ( $select_count_pkgs )
7675 Returns an SQL fragment to retreive the balance.
7680 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
7681 WHERE cust_bill.custnum = cust_main.custnum )
7682 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
7683 WHERE cust_pay.custnum = cust_main.custnum )
7684 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
7685 WHERE cust_credit.custnum = cust_main.custnum )
7686 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
7687 WHERE cust_refund.custnum = cust_main.custnum )
7690 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
7692 Returns an SQL fragment to retreive the balance for this customer, only
7693 considering invoices with date earlier than START_TIME, and optionally not
7694 later than END_TIME (total_owed_date minus total_unapplied_credits minus
7695 total_unapplied_payments).
7697 Times are specified as SQL fragments or numeric
7698 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
7699 L<Date::Parse> for conversion functions. The empty string can be passed
7700 to disable that time constraint completely.
7702 Available options are:
7706 =item unapplied_date
7708 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)
7713 set to true to remove all customer comparison clauses, for totals
7718 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
7723 JOIN clause (typically used with the total option)
7729 sub balance_date_sql {
7730 my( $class, $start, $end, %opt ) = @_;
7732 my $owed = FS::cust_bill->owed_sql;
7733 my $unapp_refund = FS::cust_refund->unapplied_sql;
7734 my $unapp_credit = FS::cust_credit->unapplied_sql;
7735 my $unapp_pay = FS::cust_pay->unapplied_sql;
7737 my $j = $opt{'join'} || '';
7739 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
7740 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
7741 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
7742 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
7744 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
7745 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
7746 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
7747 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
7752 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
7754 Returns an SQL fragment to retreive the total unapplied payments for this
7755 customer, only considering invoices with date earlier than START_TIME, and
7756 optionally not later than END_TIME.
7758 Times are specified as SQL fragments or numeric
7759 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
7760 L<Date::Parse> for conversion functions. The empty string can be passed
7761 to disable that time constraint completely.
7763 Available options are:
7767 sub unapplied_payments_date_sql {
7768 my( $class, $start, $end, ) = @_;
7770 my $unapp_pay = FS::cust_pay->unapplied_sql;
7772 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
7773 'unapplied_date'=>1 );
7775 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
7778 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
7780 Helper method for balance_date_sql; name (and usage) subject to change
7781 (suggestions welcome).
7783 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
7784 cust_refund, cust_credit or cust_pay).
7786 If TABLE is "cust_bill" or the unapplied_date option is true, only
7787 considers records with date earlier than START_TIME, and optionally not
7788 later than END_TIME .
7792 sub _money_table_where {
7793 my( $class, $table, $start, $end, %opt ) = @_;
7796 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
7797 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
7798 push @where, "$table._date <= $start" if defined($start) && length($start);
7799 push @where, "$table._date > $end" if defined($end) && length($end);
7801 push @where, @{$opt{'where'}} if $opt{'where'};
7802 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
7808 =item search_sql HASHREF
7812 Returns a qsearch hash expression to search for parameters specified in HREF.
7813 Valid parameters are
7821 =item cancelled_pkgs
7827 listref of start date, end date
7833 =item current_balance
7835 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
7839 =item flattened_pkgs
7848 my ($class, $params) = @_;
7859 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
7861 "cust_main.agentnum = $1";
7868 #prospect active inactive suspended cancelled
7869 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
7870 my $method = $params->{'status'}. '_sql';
7871 #push @where, $class->$method();
7872 push @where, FS::cust_main->$method();
7876 # parse cancelled package checkbox
7881 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
7882 unless $params->{'cancelled_pkgs'};
7885 # parse without census tract checkbox
7888 push @where, "(censustract = '' or censustract is null)"
7889 if $params->{'no_censustract'};
7895 foreach my $field (qw( signupdate )) {
7897 next unless exists($params->{$field});
7899 my($beginning, $ending) = @{$params->{$field}};
7902 "cust_main.$field IS NOT NULL",
7903 "cust_main.$field >= $beginning",
7904 "cust_main.$field <= $ending";
7906 $orderby ||= "ORDER BY cust_main.$field";
7914 my @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
7916 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )';
7923 #my $balance_sql = $class->balance_sql();
7924 my $balance_sql = FS::cust_main->balance_sql();
7926 push @where, map { s/current_balance/$balance_sql/; $_ }
7927 @{ $params->{'current_balance'} };
7933 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
7935 "cust_main.custbatch = '$1'";
7939 # setup queries, subs, etc. for the search
7942 $orderby ||= 'ORDER BY custnum';
7944 # here is the agent virtualization
7945 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
7947 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
7949 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
7951 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
7953 my $select = join(', ',
7954 'cust_main.custnum',
7955 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
7958 my(@extra_headers) = ();
7959 my(@extra_fields) = ();
7961 if ($params->{'flattened_pkgs'}) {
7963 if ($dbh->{Driver}->{Name} eq 'Pg') {
7965 $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";
7967 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
7968 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
7969 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
7971 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
7972 "omitting packing information from report.";
7975 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";
7977 my $sth = dbh->prepare($header_query) or die dbh->errstr;
7978 $sth->execute() or die $sth->errstr;
7979 my $headerrow = $sth->fetchrow_arrayref;
7980 my $headercount = $headerrow ? $headerrow->[0] : 0;
7981 while($headercount) {
7982 unshift @extra_headers, "Package ". $headercount;
7983 unshift @extra_fields, eval q!sub {my $c = shift;
7984 my @a = split '\|', $c->magic;
7985 my $p = $a[!.--$headercount. q!];
7993 'table' => 'cust_main',
7994 'select' => $select,
7996 'extra_sql' => $extra_sql,
7997 'order_by' => $orderby,
7998 'count_query' => $count_query,
7999 'extra_headers' => \@extra_headers,
8000 'extra_fields' => \@extra_fields,
8005 =item email_search_sql HASHREF
8009 Emails a notice to the specified customers.
8011 Valid parameters are those of the L<search_sql> method, plus the following:
8033 Optional job queue job for status updates.
8037 Returns an error message, or false for success.
8039 If an error occurs during any email, stops the enture send and returns that
8040 error. Presumably if you're getting SMTP errors aborting is better than
8041 retrying everything.
8045 sub email_search_sql {
8046 my($class, $params) = @_;
8048 my $from = delete $params->{from};
8049 my $subject = delete $params->{subject};
8050 my $html_body = delete $params->{html_body};
8051 my $text_body = delete $params->{text_body};
8053 my $job = delete $params->{'job'};
8055 my $sql_query = $class->search_sql($params);
8057 my $count_query = delete($sql_query->{'count_query'});
8058 my $count_sth = dbh->prepare($count_query)
8059 or die "Error preparing $count_query: ". dbh->errstr;
8061 or die "Error executing $count_query: ". $count_sth->errstr;
8062 my $count_arrayref = $count_sth->fetchrow_arrayref;
8063 my $num_cust = $count_arrayref->[0];
8065 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
8066 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
8069 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
8071 #eventually order+limit magic to reduce memory use?
8072 foreach my $cust_main ( qsearch($sql_query) ) {
8074 my $to = $cust_main->invoicing_list_emailonly_scalar;
8077 my $error = send_email(
8081 'subject' => $subject,
8082 'html_body' => $html_body,
8083 'text_body' => $text_body,
8086 return $error if $error;
8088 if ( $job ) { #progressbar foo
8090 if ( time - $min_sec > $last ) {
8091 my $error = $job->update_statustext(
8092 int( 100 * $num / $num_cust )
8094 die $error if $error;
8104 use Storable qw(thaw);
8107 sub process_email_search_sql {
8109 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
8111 my $param = thaw(decode_base64(shift));
8112 warn Dumper($param) if $DEBUG;
8114 $param->{'job'} = $job;
8116 my $error = FS::cust_main->email_search_sql( $param );
8117 die $error if $error;
8121 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
8123 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
8124 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
8125 appropriate ship_ field is also searched).
8127 Additional options are the same as FS::Record::qsearch
8132 my( $self, $fuzzy, $hash, @opt) = @_;
8137 check_and_rebuild_fuzzyfiles();
8138 foreach my $field ( keys %$fuzzy ) {
8140 my $all = $self->all_X($field);
8141 next unless scalar(@$all);
8144 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
8147 foreach ( keys %match ) {
8148 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
8149 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
8152 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
8155 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
8157 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
8165 Returns a masked version of the named field
8170 my ($self,$field) = @_;
8174 'x'x(length($self->getfield($field))-4).
8175 substr($self->getfield($field), (length($self->getfield($field))-4));
8185 =item smart_search OPTION => VALUE ...
8187 Accepts the following options: I<search>, the string to search for. The string
8188 will be searched for as a customer number, phone number, name or company name,
8189 as an exact, or, in some cases, a substring or fuzzy match (see the source code
8190 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
8191 skip fuzzy matching when an exact match is found.
8193 Any additional options are treated as an additional qualifier on the search
8196 Returns a (possibly empty) array of FS::cust_main objects.
8203 #here is the agent virtualization
8204 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8208 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
8209 my $search = delete $options{'search'};
8210 ( my $alphanum_search = $search ) =~ s/\W//g;
8212 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
8214 #false laziness w/Record::ut_phone
8215 my $phonen = "$1-$2-$3";
8216 $phonen .= " x$4" if $4;
8218 push @cust_main, qsearch( {
8219 'table' => 'cust_main',
8220 'hashref' => { %options },
8221 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8223 join(' OR ', map "$_ = '$phonen'",
8224 qw( daytime night fax
8225 ship_daytime ship_night ship_fax )
8228 " AND $agentnums_sql", #agent virtualization
8231 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
8232 #try looking for matches with extensions unless one was specified
8234 push @cust_main, qsearch( {
8235 'table' => 'cust_main',
8236 'hashref' => { %options },
8237 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8239 join(' OR ', map "$_ LIKE '$phonen\%'",
8241 ship_daytime ship_night )
8244 " AND $agentnums_sql", #agent virtualization
8249 # custnum search (also try agent_custid), with some tweaking options if your
8250 # legacy cust "numbers" have letters
8253 if ( $search =~ /^\s*(\d+)\s*$/
8254 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
8255 && $search =~ /^\s*(\w\w?\d+)\s*$/
8262 if ( $num <= 2147483647 ) { #need a bigint custnum? wow.
8263 push @cust_main, qsearch( {
8264 'table' => 'cust_main',
8265 'hashref' => { 'custnum' => $num, %options },
8266 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8270 push @cust_main, qsearch( {
8271 'table' => 'cust_main',
8272 'hashref' => { 'agent_custid' => $num, %options },
8273 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8276 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
8278 my($company, $last, $first) = ( $1, $2, $3 );
8280 # "Company (Last, First)"
8281 #this is probably something a browser remembered,
8282 #so just do an exact search
8284 foreach my $prefix ( '', 'ship_' ) {
8285 push @cust_main, qsearch( {
8286 'table' => 'cust_main',
8287 'hashref' => { $prefix.'first' => $first,
8288 $prefix.'last' => $last,
8289 $prefix.'company' => $company,
8292 'extra_sql' => " AND $agentnums_sql",
8296 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
8297 # try (ship_){last,company}
8301 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
8302 # # full strings the browser remembers won't work
8303 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
8305 use Lingua::EN::NameParse;
8306 my $NameParse = new Lingua::EN::NameParse(
8308 allow_reversed => 1,
8311 my($last, $first) = ( '', '' );
8312 #maybe disable this too and just rely on NameParse?
8313 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
8315 ($last, $first) = ( $1, $2 );
8317 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
8318 } elsif ( ! $NameParse->parse($value) ) {
8320 my %name = $NameParse->components;
8321 $first = $name{'given_name_1'};
8322 $last = $name{'surname_1'};
8326 if ( $first && $last ) {
8328 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
8331 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8333 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
8334 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
8337 push @cust_main, qsearch( {
8338 'table' => 'cust_main',
8339 'hashref' => \%options,
8340 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8343 # or it just be something that was typed in... (try that in a sec)
8347 my $q_value = dbh->quote($value);
8350 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8351 $sql .= " ( LOWER(last) = $q_value
8352 OR LOWER(company) = $q_value
8353 OR LOWER(ship_last) = $q_value
8354 OR LOWER(ship_company) = $q_value
8357 push @cust_main, qsearch( {
8358 'table' => 'cust_main',
8359 'hashref' => \%options,
8360 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8363 #no exact match, trying substring/fuzzy
8364 #always do substring & fuzzy (unless they're explicity config'ed off)
8365 #getting complaints searches are not returning enough
8366 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
8368 #still some false laziness w/search_sql (was search/cust_main.cgi)
8373 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
8374 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
8377 if ( $first && $last ) {
8380 { 'first' => { op=>'ILIKE', value=>"%$first%" },
8381 'last' => { op=>'ILIKE', value=>"%$last%" },
8383 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
8384 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
8391 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
8392 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
8396 foreach my $hashref ( @hashrefs ) {
8398 push @cust_main, qsearch( {
8399 'table' => 'cust_main',
8400 'hashref' => { %$hashref,
8403 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
8412 " AND $agentnums_sql", #extra_sql #agent virtualization
8415 if ( $first && $last ) {
8416 push @cust_main, FS::cust_main->fuzzy_search(
8417 { 'last' => $last, #fuzzy hashref
8418 'first' => $first }, #
8422 foreach my $field ( 'last', 'company' ) {
8424 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
8431 #eliminate duplicates
8433 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8441 Accepts the following options: I<email>, the email address to search for. The
8442 email address will be searched for as an email invoice destination and as an
8445 #Any additional options are treated as an additional qualifier on the search
8446 #(i.e. I<agentnum>).
8448 Returns a (possibly empty) array of FS::cust_main objects (but usually just
8458 my $email = delete $options{'email'};
8460 #we're only being used by RT at the moment... no agent virtualization yet
8461 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8465 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
8467 my ( $user, $domain ) = ( $1, $2 );
8469 warn "$me smart_search: searching for $user in domain $domain"
8475 'table' => 'cust_main_invoice',
8476 'hashref' => { 'dest' => $email },
8483 map $_->cust_svc->cust_pkg,
8485 'table' => 'svc_acct',
8486 'hashref' => { 'username' => $user, },
8488 'AND ( SELECT domain FROM svc_domain
8489 WHERE svc_acct.domsvc = svc_domain.svcnum
8490 ) = '. dbh->quote($domain),
8496 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8498 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
8505 =item check_and_rebuild_fuzzyfiles
8509 use vars qw(@fuzzyfields);
8510 @fuzzyfields = ( 'last', 'first', 'company' );
8512 sub check_and_rebuild_fuzzyfiles {
8513 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8514 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
8517 =item rebuild_fuzzyfiles
8521 sub rebuild_fuzzyfiles {
8523 use Fcntl qw(:flock);
8525 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8526 mkdir $dir, 0700 unless -d $dir;
8528 foreach my $fuzzy ( @fuzzyfields ) {
8530 open(LOCK,">>$dir/cust_main.$fuzzy")
8531 or die "can't open $dir/cust_main.$fuzzy: $!";
8533 or die "can't lock $dir/cust_main.$fuzzy: $!";
8535 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
8536 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
8538 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
8539 my $sth = dbh->prepare("SELECT $field FROM cust_main".
8540 " WHERE $field != '' AND $field IS NOT NULL");
8541 $sth->execute or die $sth->errstr;
8543 while ( my $row = $sth->fetchrow_arrayref ) {
8544 print CACHE $row->[0]. "\n";
8549 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
8551 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
8562 my( $self, $field ) = @_;
8563 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8564 open(CACHE,"<$dir/cust_main.$field")
8565 or die "can't open $dir/cust_main.$field: $!";
8566 my @array = map { chomp; $_; } <CACHE>;
8571 =item append_fuzzyfiles LASTNAME COMPANY
8575 sub append_fuzzyfiles {
8576 #my( $first, $last, $company ) = @_;
8578 &check_and_rebuild_fuzzyfiles;
8580 use Fcntl qw(:flock);
8582 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8584 foreach my $field (qw( first last company )) {
8589 open(CACHE,">>$dir/cust_main.$field")
8590 or die "can't open $dir/cust_main.$field: $!";
8591 flock(CACHE,LOCK_EX)
8592 or die "can't lock $dir/cust_main.$field: $!";
8594 print CACHE "$value\n";
8596 flock(CACHE,LOCK_UN)
8597 or die "can't unlock $dir/cust_main.$field: $!";
8612 #warn join('-',keys %$param);
8613 my $fh = $param->{filehandle};
8614 my @fields = @{$param->{fields}};
8616 eval "use Text::CSV_XS;";
8619 my $csv = new Text::CSV_XS;
8626 local $SIG{HUP} = 'IGNORE';
8627 local $SIG{INT} = 'IGNORE';
8628 local $SIG{QUIT} = 'IGNORE';
8629 local $SIG{TERM} = 'IGNORE';
8630 local $SIG{TSTP} = 'IGNORE';
8631 local $SIG{PIPE} = 'IGNORE';
8633 my $oldAutoCommit = $FS::UID::AutoCommit;
8634 local $FS::UID::AutoCommit = 0;
8637 #while ( $columns = $csv->getline($fh) ) {
8639 while ( defined($line=<$fh>) ) {
8641 $csv->parse($line) or do {
8642 $dbh->rollback if $oldAutoCommit;
8643 return "can't parse: ". $csv->error_input();
8646 my @columns = $csv->fields();
8647 #warn join('-',@columns);
8650 foreach my $field ( @fields ) {
8651 $row{$field} = shift @columns;
8654 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
8655 unless ( $cust_main ) {
8656 $dbh->rollback if $oldAutoCommit;
8657 return "unknown custnum $row{'custnum'}";
8660 if ( $row{'amount'} > 0 ) {
8661 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
8663 $dbh->rollback if $oldAutoCommit;
8667 } elsif ( $row{'amount'} < 0 ) {
8668 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
8671 $dbh->rollback if $oldAutoCommit;
8681 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
8683 return "Empty file!" unless $imported;
8689 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
8691 Sends a templated email notification to the customer (see L<Text::Template>).
8693 OPTIONS is a hash and may include
8695 I<from> - the email sender (default is invoice_from)
8697 I<to> - comma-separated scalar or arrayref of recipients
8698 (default is invoicing_list)
8700 I<subject> - The subject line of the sent email notification
8701 (default is "Notice from company_name")
8703 I<extra_fields> - a hashref of name/value pairs which will be substituted
8706 The following variables are vavailable in the template.
8708 I<$first> - the customer first name
8709 I<$last> - the customer last name
8710 I<$company> - the customer company
8711 I<$payby> - a description of the method of payment for the customer
8712 # would be nice to use FS::payby::shortname
8713 I<$payinfo> - the account information used to collect for this customer
8714 I<$expdate> - the expiration of the customer payment in seconds from epoch
8719 my ($self, $template, %options) = @_;
8721 return unless $conf->exists($template);
8723 my $from = $conf->config('invoice_from', $self->agentnum)
8724 if $conf->exists('invoice_from', $self->agentnum);
8725 $from = $options{from} if exists($options{from});
8727 my $to = join(',', $self->invoicing_list_emailonly);
8728 $to = $options{to} if exists($options{to});
8730 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
8731 if $conf->exists('company_name', $self->agentnum);
8732 $subject = $options{subject} if exists($options{subject});
8734 my $notify_template = new Text::Template (TYPE => 'ARRAY',
8735 SOURCE => [ map "$_\n",
8736 $conf->config($template)]
8738 or die "can't create new Text::Template object: Text::Template::ERROR";
8739 $notify_template->compile()
8740 or die "can't compile template: Text::Template::ERROR";
8742 $FS::notify_template::_template::company_name =
8743 $conf->config('company_name', $self->agentnum);
8744 $FS::notify_template::_template::company_address =
8745 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
8747 my $paydate = $self->paydate || '2037-12-31';
8748 $FS::notify_template::_template::first = $self->first;
8749 $FS::notify_template::_template::last = $self->last;
8750 $FS::notify_template::_template::company = $self->company;
8751 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
8752 my $payby = $self->payby;
8753 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
8754 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
8756 #credit cards expire at the end of the month/year of their exp date
8757 if ($payby eq 'CARD' || $payby eq 'DCRD') {
8758 $FS::notify_template::_template::payby = 'credit card';
8759 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
8760 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
8762 }elsif ($payby eq 'COMP') {
8763 $FS::notify_template::_template::payby = 'complimentary account';
8765 $FS::notify_template::_template::payby = 'current method';
8767 $FS::notify_template::_template::expdate = $expire_time;
8769 for (keys %{$options{extra_fields}}){
8771 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
8774 send_email(from => $from,
8776 subject => $subject,
8777 body => $notify_template->fill_in( PACKAGE =>
8778 'FS::notify_template::_template' ),
8783 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
8785 Generates a templated notification to the customer (see L<Text::Template>).
8787 OPTIONS is a hash and may include
8789 I<extra_fields> - a hashref of name/value pairs which will be substituted
8790 into the template. These values may override values mentioned below
8791 and those from the customer record.
8793 The following variables are available in the template instead of or in addition
8794 to the fields of the customer record.
8796 I<$payby> - a description of the method of payment for the customer
8797 # would be nice to use FS::payby::shortname
8798 I<$payinfo> - the masked account information used to collect for this customer
8799 I<$expdate> - the expiration of the customer payment method in seconds from epoch
8800 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
8804 sub generate_letter {
8805 my ($self, $template, %options) = @_;
8807 return unless $conf->exists($template);
8809 my $letter_template = new Text::Template
8811 SOURCE => [ map "$_\n", $conf->config($template)],
8812 DELIMITERS => [ '[@--', '--@]' ],
8814 or die "can't create new Text::Template object: Text::Template::ERROR";
8816 $letter_template->compile()
8817 or die "can't compile template: Text::Template::ERROR";
8819 my %letter_data = map { $_ => $self->$_ } $self->fields;
8820 $letter_data{payinfo} = $self->mask_payinfo;
8822 #my $paydate = $self->paydate || '2037-12-31';
8823 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
8825 my $payby = $self->payby;
8826 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
8827 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
8829 #credit cards expire at the end of the month/year of their exp date
8830 if ($payby eq 'CARD' || $payby eq 'DCRD') {
8831 $letter_data{payby} = 'credit card';
8832 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
8833 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
8835 }elsif ($payby eq 'COMP') {
8836 $letter_data{payby} = 'complimentary account';
8838 $letter_data{payby} = 'current method';
8840 $letter_data{expdate} = $expire_time;
8842 for (keys %{$options{extra_fields}}){
8843 $letter_data{$_} = $options{extra_fields}->{$_};
8846 unless(exists($letter_data{returnaddress})){
8847 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
8848 $self->agent_template)
8850 if ( length($retadd) ) {
8851 $letter_data{returnaddress} = $retadd;
8852 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
8853 $letter_data{returnaddress} =
8854 join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
8855 $conf->config('company_address', $self->agentnum)
8858 $letter_data{returnaddress} = '~';
8862 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
8864 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
8866 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
8867 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
8871 ) or die "can't open temp file: $!\n";
8873 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
8875 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
8879 =item print_ps TEMPLATE
8881 Returns an postscript letter filled in from TEMPLATE, as a scalar.
8887 my $file = $self->generate_letter(@_);
8888 FS::Misc::generate_ps($file);
8891 =item print TEMPLATE
8893 Prints the filled in template.
8895 TEMPLATE is the name of a L<Text::Template> to fill in and print.
8899 sub queueable_print {
8902 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
8903 or die "invalid customer number: " . $opt{custvnum};
8905 my $error = $self->print( $opt{template} );
8906 die $error if $error;
8910 my ($self, $template) = (shift, shift);
8911 do_print [ $self->print_ps($template) ];
8914 #these three subs should just go away once agent stuff is all config overrides
8916 sub agent_template {
8918 $self->_agent_plandata('agent_templatename');
8921 sub agent_invoice_from {
8923 $self->_agent_plandata('agent_invoice_from');
8926 sub _agent_plandata {
8927 my( $self, $option ) = @_;
8929 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
8930 #agent-specific Conf
8932 use FS::part_event::Condition;
8934 my $agentnum = $self->agentnum;
8937 if ( driver_name =~ /^Pg/i ) {
8939 } elsif ( driver_name =~ /^mysql/i ) {
8942 die "don't know how to use regular expressions in ". driver_name. " databases";
8945 my $part_event_option =
8947 'select' => 'part_event_option.*',
8948 'table' => 'part_event_option',
8950 LEFT JOIN part_event USING ( eventpart )
8951 LEFT JOIN part_event_option AS peo_agentnum
8952 ON ( part_event.eventpart = peo_agentnum.eventpart
8953 AND peo_agentnum.optionname = 'agentnum'
8954 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
8956 LEFT JOIN part_event_condition
8957 ON ( part_event.eventpart = part_event_condition.eventpart
8958 AND part_event_condition.conditionname = 'cust_bill_age'
8960 LEFT JOIN part_event_condition_option
8961 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
8962 AND part_event_condition_option.optionname = 'age'
8965 #'hashref' => { 'optionname' => $option },
8966 #'hashref' => { 'part_event_option.optionname' => $option },
8968 " WHERE part_event_option.optionname = ". dbh->quote($option).
8969 " AND action = 'cust_bill_send_agent' ".
8970 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
8971 " AND peo_agentnum.optionname = 'agentnum' ".
8972 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
8974 CASE WHEN part_event_condition_option.optionname IS NULL
8976 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
8978 , part_event.weight".
8982 unless ( $part_event_option ) {
8983 return $self->agent->invoice_template || ''
8984 if $option eq 'agent_templatename';
8988 $part_event_option->optionvalue;
8993 ## actual sub, not a method, designed to be called from the queue.
8994 ## sets up the customer, and calls the bill_and_collect
8995 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
8996 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
8997 $cust_main->bill_and_collect(
9002 sub _upgrade_data { #class method
9003 my ($class, %opts) = @_;
9005 my $sql = 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL';
9006 my $sth = dbh->prepare($sql) or die dbh->errstr;
9007 $sth->execute or die $sth->errstr;
9017 The delete method should possibly take an FS::cust_main object reference
9018 instead of a scalar customer number.
9020 Bill and collect options should probably be passed as references instead of a
9023 There should probably be a configuration file with a list of allowed credit
9026 No multiple currency support (probably a larger project than just this module).
9028 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
9030 Birthdates rely on negative epoch values.
9032 The payby for card/check batches is broken. With mixed batching, bad
9035 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
9039 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
9040 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
9041 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.