5 use vars qw( @ISA @EXPORT_OK $DEBUG $me $conf
7 $import $ignore_expired_card
8 $skip_fuzzyfiles @fuzzyfields
11 use vars qw( $realtime_bop_decline_quiet ); #ugh
15 use Scalar::Util qw( blessed );
16 use List::Util qw( min );
17 use Time::Local qw(timelocal);
20 use Digest::MD5 qw(md5_base64);
23 use File::Temp qw( tempfile );
24 use String::Approx qw(amatch);
25 use Business::CreditCard 0.28;
27 use FS::UID qw( getotaker dbh driver_name );
28 use FS::Record qw( qsearchs qsearch dbdef );
29 use FS::Misc qw( generate_email send_email generate_ps do_print );
30 use FS::Msgcat qw(gettext);
35 use FS::cust_bill_pkg;
36 use FS::cust_bill_pkg_display;
37 use FS::cust_bill_pkg_tax_location;
38 use FS::cust_bill_pkg_tax_rate_location;
40 use FS::cust_pay_pending;
41 use FS::cust_pay_void;
42 use FS::cust_pay_batch;
45 use FS::part_referral;
46 use FS::cust_main_county;
47 use FS::cust_location;
49 use FS::cust_main_exemption;
50 use FS::cust_tax_adjustment;
52 use FS::tax_rate_location;
53 use FS::cust_tax_location;
54 use FS::part_pkg_taxrate;
56 use FS::cust_main_invoice;
57 use FS::cust_credit_bill;
58 use FS::cust_bill_pay;
59 use FS::prepay_credit;
63 use FS::part_event_condition;
66 use FS::payment_gateway;
67 use FS::agent_payment_gateway;
69 use FS::payinfo_Mixin;
72 @ISA = qw( FS::payinfo_Mixin FS::Record );
74 @EXPORT_OK = qw( smart_search );
76 $realtime_bop_decline_quiet = 0;
78 # 1 is mostly method/subroutine entry and options
79 # 2 traces progress of some operations
80 # 3 is even more information including possibly sensitive data
82 $me = '[FS::cust_main]';
85 $ignore_expired_card = 0;
88 @fuzzyfields = ( 'first', 'last', 'company', 'address1' );
90 @encrypted_fields = ('payinfo', 'paycvv');
91 sub nohistory_fields { ('paycvv'); }
93 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
95 #ask FS::UID to run this stuff for us later
96 #$FS::UID::callback{'FS::cust_main'} = sub {
97 install_callback FS::UID sub {
99 #yes, need it for stuff below (prolly should be cached)
104 my ( $hashref, $cache ) = @_;
105 if ( exists $hashref->{'pkgnum'} ) {
106 #@{ $self->{'_pkgnum'} } = ();
107 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
108 $self->{'_pkgnum'} = $subcache;
109 #push @{ $self->{'_pkgnum'} },
110 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
116 FS::cust_main - Object methods for cust_main records
122 $record = new FS::cust_main \%hash;
123 $record = new FS::cust_main { 'column' => 'value' };
125 $error = $record->insert;
127 $error = $new_record->replace($old_record);
129 $error = $record->delete;
131 $error = $record->check;
133 @cust_pkg = $record->all_pkgs;
135 @cust_pkg = $record->ncancelled_pkgs;
137 @cust_pkg = $record->suspended_pkgs;
139 $error = $record->bill;
140 $error = $record->bill %options;
141 $error = $record->bill 'time' => $time;
143 $error = $record->collect;
144 $error = $record->collect %options;
145 $error = $record->collect 'invoice_time' => $time,
150 An FS::cust_main object represents a customer. FS::cust_main inherits from
151 FS::Record. The following fields are currently supported:
157 Primary key (assigned automatically for new customers)
161 Agent (see L<FS::agent>)
165 Advertising source (see L<FS::part_referral>)
177 Cocial security number (optional)
193 (optional, see L<FS::cust_main_county>)
197 (see L<FS::cust_main_county>)
203 (see L<FS::cust_main_county>)
239 (optional, see L<FS::cust_main_county>)
243 (see L<FS::cust_main_county>)
249 (see L<FS::cust_main_county>)
265 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
269 Payment Information (See L<FS::payinfo_Mixin> for data format)
273 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
277 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
281 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
285 Start date month (maestro/solo cards only)
289 Start date year (maestro/solo cards only)
293 Issue number (maestro/solo cards only)
297 Name on card or billing name
301 IP address from which payment information was received
305 Tax exempt, empty or `Y'
309 Order taker (assigned automatically, see L<FS::UID>)
315 =item referral_custnum
317 Referring customer number
321 Enable individual CDR spooling, empty or `Y'
325 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
329 Discourage individual CDR printing, empty or `Y'
339 Creates a new customer. To add the customer to the database, see L<"insert">.
341 Note that this stores the hash reference, not a distinct copy of the hash it
342 points to. You can ask the object for a copy with the I<hash> method.
346 sub table { 'cust_main'; }
348 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
350 Adds this customer to the database. If there is an error, returns the error,
351 otherwise returns false.
353 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
354 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
355 are inserted atomicly, or the transaction is rolled back. Passing an empty
356 hash reference is equivalent to not supplying this parameter. There should be
357 a better explanation of this, but until then, here's an example:
360 tie %hash, 'Tie::RefHash'; #this part is important
362 $cust_pkg => [ $svc_acct ],
365 $cust_main->insert( \%hash );
367 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
368 be set as the invoicing list (see L<"invoicing_list">). Errors return as
369 expected and rollback the entire transaction; it is not necessary to call
370 check_invoicing_list first. The invoicing_list is set after the records in the
371 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
372 invoicing_list destination to the newly-created svc_acct. Here's an example:
374 $cust_main->insert( {}, [ $email, 'POST' ] );
376 Currently available options are: I<depend_jobnum>, I<noexport> and I<tax_exemption>.
378 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
379 on the supplied jobnum (they will not run until the specific job completes).
380 This can be used to defer provisioning until some action completes (such
381 as running the customer's credit card successfully).
383 The I<noexport> option is deprecated. If I<noexport> is set true, no
384 provisioning jobs (exports) are scheduled. (You can schedule them later with
385 the B<reexport> method.)
387 The I<tax_exemption> option can be set to an arrayref of tax names.
388 FS::cust_main_exemption records will be created and inserted.
394 my $cust_pkgs = @_ ? shift : {};
395 my $invoicing_list = @_ ? shift : '';
397 warn "$me insert called with options ".
398 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
401 local $SIG{HUP} = 'IGNORE';
402 local $SIG{INT} = 'IGNORE';
403 local $SIG{QUIT} = 'IGNORE';
404 local $SIG{TERM} = 'IGNORE';
405 local $SIG{TSTP} = 'IGNORE';
406 local $SIG{PIPE} = 'IGNORE';
408 my $oldAutoCommit = $FS::UID::AutoCommit;
409 local $FS::UID::AutoCommit = 0;
412 my $prepay_identifier = '';
413 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
415 if ( $self->payby eq 'PREPAY' ) {
417 $self->payby('BILL');
418 $prepay_identifier = $self->payinfo;
421 warn " looking up prepaid card $prepay_identifier\n"
424 my $error = $self->get_prepay( $prepay_identifier,
425 'amount_ref' => \$amount,
426 'seconds_ref' => \$seconds,
427 'upbytes_ref' => \$upbytes,
428 'downbytes_ref' => \$downbytes,
429 'totalbytes_ref' => \$totalbytes,
432 $dbh->rollback if $oldAutoCommit;
433 #return "error applying prepaid card (transaction rolled back): $error";
437 $payby = 'PREP' if $amount;
439 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
442 $self->payby('BILL');
443 $amount = $self->paid;
447 warn " inserting $self\n"
450 $self->signupdate(time) unless $self->signupdate;
452 $self->auto_agent_custid()
453 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
455 my $error = $self->SUPER::insert;
457 $dbh->rollback if $oldAutoCommit;
458 #return "inserting cust_main record (transaction rolled back): $error";
462 warn " setting invoicing list\n"
465 if ( $invoicing_list ) {
466 $error = $self->check_invoicing_list( $invoicing_list );
468 $dbh->rollback if $oldAutoCommit;
469 #return "checking invoicing_list (transaction rolled back): $error";
472 $self->invoicing_list( $invoicing_list );
475 warn " setting cust_main_exemption\n"
478 my $tax_exemption = delete $options{'tax_exemption'};
479 if ( $tax_exemption ) {
480 foreach my $taxname ( @$tax_exemption ) {
481 my $cust_main_exemption = new FS::cust_main_exemption {
482 'custnum' => $self->custnum,
483 'taxname' => $taxname,
485 my $error = $cust_main_exemption->insert;
487 $dbh->rollback if $oldAutoCommit;
488 return "inserting cust_main_exemption (transaction rolled back): $error";
493 if ( $conf->config('cust_main-skeleton_tables')
494 && $conf->config('cust_main-skeleton_custnum') ) {
496 warn " inserting skeleton records\n"
499 my $error = $self->start_copy_skel;
501 $dbh->rollback if $oldAutoCommit;
507 warn " ordering packages\n"
510 $error = $self->order_pkgs( $cust_pkgs,
512 'seconds_ref' => \$seconds,
513 'upbytes_ref' => \$upbytes,
514 'downbytes_ref' => \$downbytes,
515 'totalbytes_ref' => \$totalbytes,
518 $dbh->rollback if $oldAutoCommit;
523 $dbh->rollback if $oldAutoCommit;
524 return "No svc_acct record to apply pre-paid time";
526 if ( $upbytes || $downbytes || $totalbytes ) {
527 $dbh->rollback if $oldAutoCommit;
528 return "No svc_acct record to apply pre-paid data";
532 warn " inserting initial $payby payment of $amount\n"
534 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
536 $dbh->rollback if $oldAutoCommit;
537 return "inserting payment (transaction rolled back): $error";
541 unless ( $import || $skip_fuzzyfiles ) {
542 warn " queueing fuzzyfiles update\n"
544 $error = $self->queue_fuzzyfiles_update;
546 $dbh->rollback if $oldAutoCommit;
547 return "updating fuzzy search cache: $error";
551 warn " insert complete; committing transaction\n"
554 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
559 use File::CounterFile;
560 sub auto_agent_custid {
563 my $format = $conf->config('cust_main-auto_agent_custid');
565 if ( $format eq '1YMMXXXXXXXX' ) {
567 my $counter = new File::CounterFile 'cust_main.agent_custid';
570 my $ym = 100000000000 + time2str('%y%m00000000', time);
571 if ( $ym > $counter->value ) {
572 $counter->{'value'} = $agent_custid = $ym;
573 $counter->{'updated'} = 1;
575 $agent_custid = $counter->inc;
581 die "Unknown cust_main-auto_agent_custid format: $format";
584 $self->agent_custid($agent_custid);
588 sub start_copy_skel {
591 #'mg_user_preference' => {},
592 #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
593 #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
594 #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
595 #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
596 my @tables = eval(join('\n',$conf->config('cust_main-skeleton_tables')));
599 _copy_skel( 'cust_main', #tablename
600 $conf->config('cust_main-skeleton_custnum'), #sourceid
601 $self->custnum, #destid
602 @tables, #child tables
606 #recursive subroutine, not a method
608 my( $table, $sourceid, $destid, %child_tables ) = @_;
611 if ( $table =~ /^(\w+)\.(\w+)$/ ) {
612 ( $table, $primary_key ) = ( $1, $2 );
614 my $dbdef_table = dbdef->table($table);
615 $primary_key = $dbdef_table->primary_key
616 or return "$table has no primary key".
617 " (or do you need to run dbdef-create?)";
620 warn " _copy_skel: $table.$primary_key $sourceid to $destid for ".
621 join (', ', keys %child_tables). "\n"
624 foreach my $child_table_def ( keys %child_tables ) {
628 if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
629 ( $child_table, $child_pkey ) = ( $1, $2 );
631 $child_table = $child_table_def;
633 $child_pkey = dbdef->table($child_table)->primary_key;
634 # or return "$table has no primary key".
635 # " (or do you need to run dbdef-create?)\n";
639 if ( keys %{ $child_tables{$child_table_def} } ) {
641 return "$child_table has no primary key".
642 " (run dbdef-create or try specifying it?)\n"
645 #false laziness w/Record::insert and only works on Pg
646 #refactor the proper last-inserted-id stuff out of Record::insert if this
647 # ever gets use for anything besides a quick kludge for one customer
648 my $default = dbdef->table($child_table)->column($child_pkey)->default;
649 $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
650 or return "can't parse $child_table.$child_pkey default value ".
651 " for sequence name: $default";
656 my @sel_columns = grep { $_ ne $primary_key }
657 dbdef->table($child_table)->columns;
658 my $sel_columns = join(', ', @sel_columns );
660 my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
661 my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
662 my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
664 my $sel_st = "SELECT $sel_columns FROM $child_table".
665 " WHERE $primary_key = $sourceid";
668 my $sel_sth = dbh->prepare( $sel_st )
669 or return dbh->errstr;
671 $sel_sth->execute or return $sel_sth->errstr;
673 while ( my $row = $sel_sth->fetchrow_hashref ) {
675 warn " selected row: ".
676 join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
680 "INSERT INTO $child_table $ins_columns VALUES $placeholders";
681 my $ins_sth =dbh->prepare($statement)
682 or return dbh->errstr;
683 my @param = ( $destid, map $row->{$_}, @ins_columns );
684 warn " $statement: [ ". join(', ', @param). " ]\n"
686 $ins_sth->execute( @param )
687 or return $ins_sth->errstr;
689 #next unless keys %{ $child_tables{$child_table} };
690 next unless $sequence;
692 #another section of that laziness
693 my $seq_sql = "SELECT currval('$sequence')";
694 my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
695 $seq_sth->execute or return $seq_sth->errstr;
696 my $insertid = $seq_sth->fetchrow_arrayref->[0];
698 # don't drink soap! recurse! recurse! okay!
700 _copy_skel( $child_table_def,
701 $row->{$child_pkey}, #sourceid
703 %{ $child_tables{$child_table_def} },
705 return $error if $error;
715 =item order_pkg HASHREF | OPTION => VALUE ...
717 Orders a single package.
719 Options may be passed as a list of key/value pairs or as a hash reference.
730 Optional FS::cust_location object
734 Optional arryaref of FS::svc_* service objects.
738 If this option is set to a job queue jobnum (see L<FS::queue>), all provisioning
739 jobs will have a dependancy on the supplied job (they will not run until the
740 specific job completes). This can be used to defer provisioning until some
741 action completes (such as running the customer's credit card successfully).
745 Optional subject for a ticket created and attached to this customer
749 Optional queue name for ticket additions
757 my $opt = ref($_[0]) ? shift : { @_ };
759 warn "$me order_pkg called with options ".
760 join(', ', map { "$_: $opt->{$_}" } keys %$opt ). "\n"
763 my $cust_pkg = $opt->{'cust_pkg'};
764 my $svcs = $opt->{'svcs'} || [];
766 my %svc_options = ();
767 $svc_options{'depend_jobnum'} = $opt->{'depend_jobnum'}
768 if exists($opt->{'depend_jobnum'}) && $opt->{'depend_jobnum'};
770 my %insert_params = map { $opt->{$_} ? ( $_ => $opt->{$_} ) : () }
771 qw( ticket_subject ticket_queue );
773 local $SIG{HUP} = 'IGNORE';
774 local $SIG{INT} = 'IGNORE';
775 local $SIG{QUIT} = 'IGNORE';
776 local $SIG{TERM} = 'IGNORE';
777 local $SIG{TSTP} = 'IGNORE';
778 local $SIG{PIPE} = 'IGNORE';
780 my $oldAutoCommit = $FS::UID::AutoCommit;
781 local $FS::UID::AutoCommit = 0;
784 if ( $opt->{'cust_location'} &&
785 ( ! $cust_pkg->locationnum || $cust_pkg->locationnum == -1 ) ) {
786 my $error = $opt->{'cust_location'}->insert;
788 $dbh->rollback if $oldAutoCommit;
789 return "inserting cust_location (transaction rolled back): $error";
791 $cust_pkg->locationnum($opt->{'cust_location'}->locationnum);
794 $cust_pkg->custnum( $self->custnum );
796 my $error = $cust_pkg->insert( %insert_params );
798 $dbh->rollback if $oldAutoCommit;
799 return "inserting cust_pkg (transaction rolled back): $error";
802 foreach my $svc_something ( @{ $opt->{'svcs'} } ) {
803 if ( $svc_something->svcnum ) {
804 my $old_cust_svc = $svc_something->cust_svc;
805 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
806 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
807 $error = $new_cust_svc->replace($old_cust_svc);
809 $svc_something->pkgnum( $cust_pkg->pkgnum );
810 if ( $svc_something->isa('FS::svc_acct') ) {
811 foreach ( grep { $opt->{$_.'_ref'} && ${ $opt->{$_.'_ref'} } }
812 qw( seconds upbytes downbytes totalbytes ) ) {
813 $svc_something->$_( $svc_something->$_() + ${ $opt->{$_.'_ref'} } );
814 ${ $opt->{$_.'_ref'} } = 0;
817 $error = $svc_something->insert(%svc_options);
820 $dbh->rollback if $oldAutoCommit;
821 return "inserting svc_ (transaction rolled back): $error";
825 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
830 #deprecated #=item order_pkgs HASHREF [ , SECONDSREF ] [ , OPTION => VALUE ... ]
831 =item order_pkgs HASHREF [ , OPTION => VALUE ... ]
833 Like the insert method on an existing record, this method orders multiple
834 packages and included services atomicaly. Pass a Tie::RefHash data structure
835 to this method containing FS::cust_pkg and FS::svc_I<tablename> objects.
836 There should be a better explanation of this, but until then, here's an
840 tie %hash, 'Tie::RefHash'; #this part is important
842 $cust_pkg => [ $svc_acct ],
845 $cust_main->order_pkgs( \%hash, 'noexport'=>1 );
847 Services can be new, in which case they are inserted, or existing unaudited
848 services, in which case they are linked to the newly-created package.
850 Currently available options are: I<depend_jobnum>, I<noexport>, I<seconds_ref>,
851 I<upbytes_ref>, I<downbytes_ref>, and I<totalbytes_ref>.
853 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
854 on the supplied jobnum (they will not run until the specific job completes).
855 This can be used to defer provisioning until some action completes (such
856 as running the customer's credit card successfully).
858 The I<noexport> option is deprecated. If I<noexport> is set true, no
859 provisioning jobs (exports) are scheduled. (You can schedule them later with
860 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
861 on the cust_main object is not recommended, as existing services will also be
864 If I<seconds_ref>, I<upbytes_ref>, I<downbytes_ref>, or I<totalbytes_ref> is
865 provided, the scalars (provided by references) will be incremented by the
866 values of the prepaid card.`
872 my $cust_pkgs = shift;
873 my $seconds_ref = ref($_[0]) ? shift : ''; #deprecated
875 $seconds_ref ||= $options{'seconds_ref'};
877 warn "$me order_pkgs called with options ".
878 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
881 local $SIG{HUP} = 'IGNORE';
882 local $SIG{INT} = 'IGNORE';
883 local $SIG{QUIT} = 'IGNORE';
884 local $SIG{TERM} = 'IGNORE';
885 local $SIG{TSTP} = 'IGNORE';
886 local $SIG{PIPE} = 'IGNORE';
888 my $oldAutoCommit = $FS::UID::AutoCommit;
889 local $FS::UID::AutoCommit = 0;
892 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
894 foreach my $cust_pkg ( keys %$cust_pkgs ) {
896 my $error = $self->order_pkg(
897 'cust_pkg' => $cust_pkg,
898 'svcs' => $cust_pkgs->{$cust_pkg},
899 'seconds_ref' => $seconds_ref,
900 map { $_ => $options{$_} } qw( upbytes_ref downbytes_ref totalbytes_ref
905 $dbh->rollback if $oldAutoCommit;
911 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
915 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
917 Recharges this (existing) customer with the specified prepaid card (see
918 L<FS::prepay_credit>), specified either by I<identifier> or as an
919 FS::prepay_credit object. If there is an error, returns the error, otherwise
922 Optionally, five scalar references can be passed as well. They will have their
923 values filled in with the amount, number of seconds, and number of upload,
924 download, and total bytes applied by this prepaid card.
928 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
929 #the only place that uses these args
930 sub recharge_prepay {
931 my( $self, $prepay_credit, $amountref, $secondsref,
932 $upbytesref, $downbytesref, $totalbytesref ) = @_;
934 local $SIG{HUP} = 'IGNORE';
935 local $SIG{INT} = 'IGNORE';
936 local $SIG{QUIT} = 'IGNORE';
937 local $SIG{TERM} = 'IGNORE';
938 local $SIG{TSTP} = 'IGNORE';
939 local $SIG{PIPE} = 'IGNORE';
941 my $oldAutoCommit = $FS::UID::AutoCommit;
942 local $FS::UID::AutoCommit = 0;
945 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
947 my $error = $self->get_prepay( $prepay_credit,
948 'amount_ref' => \$amount,
949 'seconds_ref' => \$seconds,
950 'upbytes_ref' => \$upbytes,
951 'downbytes_ref' => \$downbytes,
952 'totalbytes_ref' => \$totalbytes,
954 || $self->increment_seconds($seconds)
955 || $self->increment_upbytes($upbytes)
956 || $self->increment_downbytes($downbytes)
957 || $self->increment_totalbytes($totalbytes)
958 || $self->insert_cust_pay_prepay( $amount,
960 ? $prepay_credit->identifier
965 $dbh->rollback if $oldAutoCommit;
969 if ( defined($amountref) ) { $$amountref = $amount; }
970 if ( defined($secondsref) ) { $$secondsref = $seconds; }
971 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
972 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
973 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
975 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
980 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
982 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
983 specified either by I<identifier> or as an FS::prepay_credit object.
985 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
986 incremented by the values of the prepaid card.
988 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
989 check or set this customer's I<agentnum>.
991 If there is an error, returns the error, otherwise returns false.
997 my( $self, $prepay_credit, %opt ) = @_;
999 local $SIG{HUP} = 'IGNORE';
1000 local $SIG{INT} = 'IGNORE';
1001 local $SIG{QUIT} = 'IGNORE';
1002 local $SIG{TERM} = 'IGNORE';
1003 local $SIG{TSTP} = 'IGNORE';
1004 local $SIG{PIPE} = 'IGNORE';
1006 my $oldAutoCommit = $FS::UID::AutoCommit;
1007 local $FS::UID::AutoCommit = 0;
1010 unless ( ref($prepay_credit) ) {
1012 my $identifier = $prepay_credit;
1014 $prepay_credit = qsearchs(
1016 { 'identifier' => $prepay_credit },
1021 unless ( $prepay_credit ) {
1022 $dbh->rollback if $oldAutoCommit;
1023 return "Invalid prepaid card: ". $identifier;
1028 if ( $prepay_credit->agentnum ) {
1029 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
1030 $dbh->rollback if $oldAutoCommit;
1031 return "prepaid card not valid for agent ". $self->agentnum;
1033 $self->agentnum($prepay_credit->agentnum);
1036 my $error = $prepay_credit->delete;
1038 $dbh->rollback if $oldAutoCommit;
1039 return "removing prepay_credit (transaction rolled back): $error";
1042 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
1043 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
1045 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1050 =item increment_upbytes SECONDS
1052 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1053 the specified number of upbytes. If there is an error, returns the error,
1054 otherwise returns false.
1058 sub increment_upbytes {
1059 _increment_column( shift, 'upbytes', @_);
1062 =item increment_downbytes SECONDS
1064 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1065 the specified number of downbytes. If there is an error, returns the error,
1066 otherwise returns false.
1070 sub increment_downbytes {
1071 _increment_column( shift, 'downbytes', @_);
1074 =item increment_totalbytes SECONDS
1076 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1077 the specified number of totalbytes. If there is an error, returns the error,
1078 otherwise returns false.
1082 sub increment_totalbytes {
1083 _increment_column( shift, 'totalbytes', @_);
1086 =item increment_seconds SECONDS
1088 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1089 the specified number of seconds. If there is an error, returns the error,
1090 otherwise returns false.
1094 sub increment_seconds {
1095 _increment_column( shift, 'seconds', @_);
1098 =item _increment_column AMOUNT
1100 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1101 the specified number of seconds or bytes. If there is an error, returns
1102 the error, otherwise returns false.
1106 sub _increment_column {
1107 my( $self, $column, $amount ) = @_;
1108 warn "$me increment_column called: $column, $amount\n"
1111 return '' unless $amount;
1113 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1114 $self->ncancelled_pkgs;
1116 if ( ! @cust_pkg ) {
1117 return 'No packages with primary or single services found'.
1118 ' to apply pre-paid time';
1119 } elsif ( scalar(@cust_pkg) > 1 ) {
1120 #maybe have a way to specify the package/account?
1121 return 'Multiple packages found to apply pre-paid time';
1124 my $cust_pkg = $cust_pkg[0];
1125 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1129 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1131 if ( ! @cust_svc ) {
1132 return 'No account found to apply pre-paid time';
1133 } elsif ( scalar(@cust_svc) > 1 ) {
1134 return 'Multiple accounts found to apply pre-paid time';
1137 my $svc_acct = $cust_svc[0]->svc_x;
1138 warn " found service svcnum ". $svc_acct->pkgnum.
1139 ' ('. $svc_acct->email. ")\n"
1142 $column = "increment_$column";
1143 $svc_acct->$column($amount);
1147 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1149 Inserts a prepayment in the specified amount for this customer. An optional
1150 second argument can specify the prepayment identifier for tracking purposes.
1151 If there is an error, returns the error, otherwise returns false.
1155 sub insert_cust_pay_prepay {
1156 shift->insert_cust_pay('PREP', @_);
1159 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1161 Inserts a cash payment in the specified amount for this customer. An optional
1162 second argument can specify the payment identifier for tracking purposes.
1163 If there is an error, returns the error, otherwise returns false.
1167 sub insert_cust_pay_cash {
1168 shift->insert_cust_pay('CASH', @_);
1171 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1173 Inserts a Western Union payment in the specified amount for this customer. An
1174 optional second argument can specify the prepayment identifier for tracking
1175 purposes. If there is an error, returns the error, otherwise returns false.
1179 sub insert_cust_pay_west {
1180 shift->insert_cust_pay('WEST', @_);
1183 sub insert_cust_pay {
1184 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1185 my $payinfo = scalar(@_) ? shift : '';
1187 my $cust_pay = new FS::cust_pay {
1188 'custnum' => $self->custnum,
1189 'paid' => sprintf('%.2f', $amount),
1190 #'_date' => #date the prepaid card was purchased???
1192 'payinfo' => $payinfo,
1200 This method is deprecated. See the I<depend_jobnum> option to the insert and
1201 order_pkgs methods for a better way to defer provisioning.
1203 Re-schedules all exports by calling the B<reexport> method of all associated
1204 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
1205 otherwise returns false.
1212 carp "WARNING: FS::cust_main::reexport is deprectated; ".
1213 "use the depend_jobnum option to insert or order_pkgs to delay export";
1215 local $SIG{HUP} = 'IGNORE';
1216 local $SIG{INT} = 'IGNORE';
1217 local $SIG{QUIT} = 'IGNORE';
1218 local $SIG{TERM} = 'IGNORE';
1219 local $SIG{TSTP} = 'IGNORE';
1220 local $SIG{PIPE} = 'IGNORE';
1222 my $oldAutoCommit = $FS::UID::AutoCommit;
1223 local $FS::UID::AutoCommit = 0;
1226 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1227 my $error = $cust_pkg->reexport;
1229 $dbh->rollback if $oldAutoCommit;
1234 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1239 =item delete NEW_CUSTNUM
1241 This deletes the customer. If there is an error, returns the error, otherwise
1244 This will completely remove all traces of the customer record. This is not
1245 what you want when a customer cancels service; for that, cancel all of the
1246 customer's packages (see L</cancel>).
1248 If the customer has any uncancelled packages, you need to pass a new (valid)
1249 customer number for those packages to be transferred to. Cancelled packages
1250 will be deleted. Did I mention that this is NOT what you want when a customer
1251 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
1253 You can't delete a customer with invoices (see L<FS::cust_bill>),
1254 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
1255 refunds (see L<FS::cust_refund>).
1262 local $SIG{HUP} = 'IGNORE';
1263 local $SIG{INT} = 'IGNORE';
1264 local $SIG{QUIT} = 'IGNORE';
1265 local $SIG{TERM} = 'IGNORE';
1266 local $SIG{TSTP} = 'IGNORE';
1267 local $SIG{PIPE} = 'IGNORE';
1269 my $oldAutoCommit = $FS::UID::AutoCommit;
1270 local $FS::UID::AutoCommit = 0;
1273 if ( $self->cust_bill ) {
1274 $dbh->rollback if $oldAutoCommit;
1275 return "Can't delete a customer with invoices";
1277 if ( $self->cust_credit ) {
1278 $dbh->rollback if $oldAutoCommit;
1279 return "Can't delete a customer with credits";
1281 if ( $self->cust_pay ) {
1282 $dbh->rollback if $oldAutoCommit;
1283 return "Can't delete a customer with payments";
1285 if ( $self->cust_refund ) {
1286 $dbh->rollback if $oldAutoCommit;
1287 return "Can't delete a customer with refunds";
1290 my @cust_pkg = $self->ncancelled_pkgs;
1292 my $new_custnum = shift;
1293 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1294 $dbh->rollback if $oldAutoCommit;
1295 return "Invalid new customer number: $new_custnum";
1297 foreach my $cust_pkg ( @cust_pkg ) {
1298 my %hash = $cust_pkg->hash;
1299 $hash{'custnum'} = $new_custnum;
1300 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1301 my $error = $new_cust_pkg->replace($cust_pkg,
1302 options => { $cust_pkg->options },
1305 $dbh->rollback if $oldAutoCommit;
1310 my @cancelled_cust_pkg = $self->all_pkgs;
1311 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1312 my $error = $cust_pkg->delete;
1314 $dbh->rollback if $oldAutoCommit;
1319 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1320 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1322 my $error = $cust_main_invoice->delete;
1324 $dbh->rollback if $oldAutoCommit;
1329 foreach my $cust_main_exemption (
1330 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } )
1332 my $error = $cust_main_exemption->delete;
1334 $dbh->rollback if $oldAutoCommit;
1339 my $error = $self->SUPER::delete;
1341 $dbh->rollback if $oldAutoCommit;
1345 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1350 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1353 Replaces the OLD_RECORD with this one in the database. If there is an error,
1354 returns the error, otherwise returns false.
1356 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1357 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1358 expected and rollback the entire transaction; it is not necessary to call
1359 check_invoicing_list first. Here's an example:
1361 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1363 Currently available options are: I<tax_exemption>.
1365 The I<tax_exemption> option can be set to an arrayref of tax names.
1366 FS::cust_main_exemption records will be deleted and inserted as appropriate.
1373 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1375 : $self->replace_old;
1379 warn "$me replace called\n"
1382 my $curuser = $FS::CurrentUser::CurrentUser;
1383 if ( $self->payby eq 'COMP'
1384 && $self->payby ne $old->payby
1385 && ! $curuser->access_right('Complimentary customer')
1388 return "You are not permitted to create complimentary accounts.";
1391 local($ignore_expired_card) = 1
1392 if $old->payby =~ /^(CARD|DCRD)$/
1393 && $self->payby =~ /^(CARD|DCRD)$/
1394 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1396 local $SIG{HUP} = 'IGNORE';
1397 local $SIG{INT} = 'IGNORE';
1398 local $SIG{QUIT} = 'IGNORE';
1399 local $SIG{TERM} = 'IGNORE';
1400 local $SIG{TSTP} = 'IGNORE';
1401 local $SIG{PIPE} = 'IGNORE';
1403 my $oldAutoCommit = $FS::UID::AutoCommit;
1404 local $FS::UID::AutoCommit = 0;
1407 my $error = $self->SUPER::replace($old);
1410 $dbh->rollback if $oldAutoCommit;
1414 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1415 my $invoicing_list = shift @param;
1416 $error = $self->check_invoicing_list( $invoicing_list );
1418 $dbh->rollback if $oldAutoCommit;
1421 $self->invoicing_list( $invoicing_list );
1424 my %options = @param;
1426 my $tax_exemption = delete $options{'tax_exemption'};
1427 if ( $tax_exemption ) {
1429 my %cust_main_exemption =
1430 map { $_->taxname => $_ }
1431 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1433 foreach my $taxname ( @$tax_exemption ) {
1435 next if delete $cust_main_exemption{$taxname};
1437 my $cust_main_exemption = new FS::cust_main_exemption {
1438 'custnum' => $self->custnum,
1439 'taxname' => $taxname,
1441 my $error = $cust_main_exemption->insert;
1443 $dbh->rollback if $oldAutoCommit;
1444 return "inserting cust_main_exemption (transaction rolled back): $error";
1448 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1449 my $error = $cust_main_exemption->delete;
1451 $dbh->rollback if $oldAutoCommit;
1452 return "deleting cust_main_exemption (transaction rolled back): $error";
1458 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1459 grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1460 # card/check/lec info has changed, want to retry realtime_ invoice events
1461 my $error = $self->retry_realtime;
1463 $dbh->rollback if $oldAutoCommit;
1468 unless ( $import || $skip_fuzzyfiles ) {
1469 $error = $self->queue_fuzzyfiles_update;
1471 $dbh->rollback if $oldAutoCommit;
1472 return "updating fuzzy search cache: $error";
1476 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1481 =item queue_fuzzyfiles_update
1483 Used by insert & replace to update the fuzzy search cache
1487 sub queue_fuzzyfiles_update {
1490 local $SIG{HUP} = 'IGNORE';
1491 local $SIG{INT} = 'IGNORE';
1492 local $SIG{QUIT} = 'IGNORE';
1493 local $SIG{TERM} = 'IGNORE';
1494 local $SIG{TSTP} = 'IGNORE';
1495 local $SIG{PIPE} = 'IGNORE';
1497 my $oldAutoCommit = $FS::UID::AutoCommit;
1498 local $FS::UID::AutoCommit = 0;
1501 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1502 my $error = $queue->insert( map $self->getfield($_), @fuzzyfields );
1504 $dbh->rollback if $oldAutoCommit;
1505 return "queueing job (transaction rolled back): $error";
1508 if ( $self->ship_last ) {
1509 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1510 $error = $queue->insert( map $self->getfield("ship_$_"), @fuzzyfields );
1512 $dbh->rollback if $oldAutoCommit;
1513 return "queueing job (transaction rolled back): $error";
1517 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1524 Checks all fields to make sure this is a valid customer record. If there is
1525 an error, returns the error, otherwise returns false. Called by the insert
1526 and replace methods.
1533 warn "$me check BEFORE: \n". $self->_dump
1537 $self->ut_numbern('custnum')
1538 || $self->ut_number('agentnum')
1539 || $self->ut_textn('agent_custid')
1540 || $self->ut_number('refnum')
1541 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1542 || $self->ut_textn('custbatch')
1543 || $self->ut_name('last')
1544 || $self->ut_name('first')
1545 || $self->ut_snumbern('birthdate')
1546 || $self->ut_snumbern('signupdate')
1547 || $self->ut_textn('company')
1548 || $self->ut_text('address1')
1549 || $self->ut_textn('address2')
1550 || $self->ut_text('city')
1551 || $self->ut_textn('county')
1552 || $self->ut_textn('state')
1553 || $self->ut_country('country')
1554 || $self->ut_anything('comments')
1555 || $self->ut_numbern('referral_custnum')
1556 || $self->ut_textn('stateid')
1557 || $self->ut_textn('stateid_state')
1558 || $self->ut_textn('invoice_terms')
1559 || $self->ut_alphan('geocode')
1560 || $self->ut_floatn('cdr_termination_percentage')
1563 #barf. need message catalogs. i18n. etc.
1564 $error .= "Please select an advertising source."
1565 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1566 return $error if $error;
1568 return "Unknown agent"
1569 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1571 return "Unknown refnum"
1572 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1574 return "Unknown referring custnum: ". $self->referral_custnum
1575 unless ! $self->referral_custnum
1576 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1578 if ( $self->censustract ne '' ) {
1579 $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
1580 or return "Illegal census tract: ". $self->censustract;
1582 $self->censustract("$1.$2");
1585 if ( $self->ss eq '' ) {
1590 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1591 or return "Illegal social security number: ". $self->ss;
1592 $self->ss("$1-$2-$3");
1596 # bad idea to disable, causes billing to fail because of no tax rates later
1597 # unless ( $import ) {
1598 unless ( qsearch('cust_main_county', {
1599 'country' => $self->country,
1602 return "Unknown state/county/country: ".
1603 $self->state. "/". $self->county. "/". $self->country
1604 unless qsearch('cust_main_county',{
1605 'state' => $self->state,
1606 'county' => $self->county,
1607 'country' => $self->country,
1613 $self->ut_phonen('daytime', $self->country)
1614 || $self->ut_phonen('night', $self->country)
1615 || $self->ut_phonen('fax', $self->country)
1616 || $self->ut_zip('zip', $self->country)
1618 return $error if $error;
1620 if ( $conf->exists('cust_main-require_phone')
1621 && ! length($self->daytime) && ! length($self->night)
1624 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1626 : FS::Msgcat::_gettext('daytime');
1627 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1629 : FS::Msgcat::_gettext('night');
1631 return "$daytime_label or $night_label is required"
1635 if ( $self->has_ship_address
1636 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1637 $self->addr_fields )
1641 $self->ut_name('ship_last')
1642 || $self->ut_name('ship_first')
1643 || $self->ut_textn('ship_company')
1644 || $self->ut_text('ship_address1')
1645 || $self->ut_textn('ship_address2')
1646 || $self->ut_text('ship_city')
1647 || $self->ut_textn('ship_county')
1648 || $self->ut_textn('ship_state')
1649 || $self->ut_country('ship_country')
1651 return $error if $error;
1653 #false laziness with above
1654 unless ( qsearchs('cust_main_county', {
1655 'country' => $self->ship_country,
1658 return "Unknown ship_state/ship_county/ship_country: ".
1659 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1660 unless qsearch('cust_main_county',{
1661 'state' => $self->ship_state,
1662 'county' => $self->ship_county,
1663 'country' => $self->ship_country,
1669 $self->ut_phonen('ship_daytime', $self->ship_country)
1670 || $self->ut_phonen('ship_night', $self->ship_country)
1671 || $self->ut_phonen('ship_fax', $self->ship_country)
1672 || $self->ut_zip('ship_zip', $self->ship_country)
1674 return $error if $error;
1676 return "Unit # is required."
1677 if $self->ship_address2 =~ /^\s*$/
1678 && $conf->exists('cust_main-require_address2');
1680 } else { # ship_ info eq billing info, so don't store dup info in database
1682 $self->setfield("ship_$_", '')
1683 foreach $self->addr_fields;
1685 return "Unit # is required."
1686 if $self->address2 =~ /^\s*$/
1687 && $conf->exists('cust_main-require_address2');
1691 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1692 # or return "Illegal payby: ". $self->payby;
1694 FS::payby->can_payby($self->table, $self->payby)
1695 or return "Illegal payby: ". $self->payby;
1697 $error = $self->ut_numbern('paystart_month')
1698 || $self->ut_numbern('paystart_year')
1699 || $self->ut_numbern('payissue')
1700 || $self->ut_textn('paytype')
1702 return $error if $error;
1704 if ( $self->payip eq '' ) {
1707 $error = $self->ut_ip('payip');
1708 return $error if $error;
1711 # If it is encrypted and the private key is not availaible then we can't
1712 # check the credit card.
1714 my $check_payinfo = 1;
1716 if ($self->is_encrypted($self->payinfo)) {
1720 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1722 my $payinfo = $self->payinfo;
1723 $payinfo =~ s/\D//g;
1724 $payinfo =~ /^(\d{13,16})$/
1725 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1727 $self->payinfo($payinfo);
1729 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1731 return gettext('unknown_card_type')
1732 if cardtype($self->payinfo) eq "Unknown";
1734 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1736 return 'Banned credit card: banned on '.
1737 time2str('%a %h %o at %r', $ban->_date).
1738 ' by '. $ban->otaker.
1739 ' (ban# '. $ban->bannum. ')';
1742 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1743 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1744 $self->paycvv =~ /^(\d{4})$/
1745 or return "CVV2 (CID) for American Express cards is four digits.";
1748 $self->paycvv =~ /^(\d{3})$/
1749 or return "CVV2 (CVC2/CID) is three digits.";
1756 my $cardtype = cardtype($payinfo);
1757 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1759 return "Start date or issue number is required for $cardtype cards"
1760 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1762 return "Start month must be between 1 and 12"
1763 if $self->paystart_month
1764 and $self->paystart_month < 1 || $self->paystart_month > 12;
1766 return "Start year must be 1990 or later"
1767 if $self->paystart_year
1768 and $self->paystart_year < 1990;
1770 return "Issue number must be beween 1 and 99"
1772 and $self->payissue < 1 || $self->payissue > 99;
1775 $self->paystart_month('');
1776 $self->paystart_year('');
1777 $self->payissue('');
1780 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1782 my $payinfo = $self->payinfo;
1783 $payinfo =~ s/[^\d\@]//g;
1784 if ( $conf->exists('echeck-nonus') ) {
1785 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1786 $payinfo = "$1\@$2";
1788 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1789 $payinfo = "$1\@$2";
1791 $self->payinfo($payinfo);
1794 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1796 return 'Banned ACH account: banned on '.
1797 time2str('%a %h %o at %r', $ban->_date).
1798 ' by '. $ban->otaker.
1799 ' (ban# '. $ban->bannum. ')';
1802 } elsif ( $self->payby eq 'LECB' ) {
1804 my $payinfo = $self->payinfo;
1805 $payinfo =~ s/\D//g;
1806 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1808 $self->payinfo($payinfo);
1811 } elsif ( $self->payby eq 'BILL' ) {
1813 $error = $self->ut_textn('payinfo');
1814 return "Illegal P.O. number: ". $self->payinfo if $error;
1817 } elsif ( $self->payby eq 'COMP' ) {
1819 my $curuser = $FS::CurrentUser::CurrentUser;
1820 if ( ! $self->custnum
1821 && ! $curuser->access_right('Complimentary customer')
1824 return "You are not permitted to create complimentary accounts."
1827 $error = $self->ut_textn('payinfo');
1828 return "Illegal comp account issuer: ". $self->payinfo if $error;
1831 } elsif ( $self->payby eq 'PREPAY' ) {
1833 my $payinfo = $self->payinfo;
1834 $payinfo =~ s/\W//g; #anything else would just confuse things
1835 $self->payinfo($payinfo);
1836 $error = $self->ut_alpha('payinfo');
1837 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1838 return "Unknown prepayment identifier"
1839 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1844 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1845 return "Expiration date required"
1846 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1850 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1851 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1852 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1853 ( $m, $y ) = ( $2, "19$1" );
1854 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1855 ( $m, $y ) = ( $3, "20$2" );
1857 return "Illegal expiration date: ". $self->paydate;
1859 $self->paydate("$y-$m-01");
1860 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1861 return gettext('expired_card')
1863 && !$ignore_expired_card
1864 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1867 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1868 ( ! $conf->exists('require_cardname')
1869 || $self->payby !~ /^(CARD|DCRD)$/ )
1871 $self->payname( $self->first. " ". $self->getfield('last') );
1873 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1874 or return gettext('illegal_name'). " payname: ". $self->payname;
1878 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
1879 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1883 $self->otaker(getotaker) unless $self->otaker;
1885 warn "$me check AFTER: \n". $self->_dump
1888 $self->SUPER::check;
1893 Returns a list of fields which have ship_ duplicates.
1898 qw( last first company
1899 address1 address2 city county state zip country
1904 =item has_ship_address
1906 Returns true if this customer record has a separate shipping address.
1910 sub has_ship_address {
1912 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
1915 =item all_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
1917 Returns all packages (see L<FS::cust_pkg>) for this customer.
1923 my $extra_qsearch = ref($_[0]) ? shift : {};
1925 return $self->num_pkgs unless wantarray || keys(%$extra_qsearch);
1928 if ( $self->{'_pkgnum'} ) {
1929 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1931 @cust_pkg = $self->_cust_pkg($extra_qsearch);
1934 sort sort_packages @cust_pkg;
1939 Synonym for B<all_pkgs>.
1944 shift->all_pkgs(@_);
1949 Returns all locations (see L<FS::cust_location>) for this customer.
1955 qsearch('cust_location', { 'custnum' => $self->custnum } );
1958 =item ncancelled_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
1960 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1964 sub ncancelled_pkgs {
1966 my $extra_qsearch = ref($_[0]) ? shift : {};
1968 return $self->num_ncancelled_pkgs unless wantarray;
1971 if ( $self->{'_pkgnum'} ) {
1973 warn "$me ncancelled_pkgs: returning cached objects"
1976 @cust_pkg = grep { ! $_->getfield('cancel') }
1977 values %{ $self->{'_pkgnum'}->cache };
1981 warn "$me ncancelled_pkgs: searching for packages with custnum ".
1982 $self->custnum. "\n"
1985 $extra_qsearch->{'extra_sql'} .= ' AND ( cancel IS NULL OR cancel = 0 ) ';
1987 @cust_pkg = $self->_cust_pkg($extra_qsearch);
1991 sort sort_packages @cust_pkg;
1997 my $extra_qsearch = ref($_[0]) ? shift : {};
1999 $extra_qsearch->{'select'} ||= '*';
2000 $extra_qsearch->{'select'} .=
2001 ',( SELECT COUNT(*) FROM cust_svc WHERE cust_pkg.pkgnum = cust_svc.pkgnum )
2005 $_->{'_num_cust_svc'} = $_->get('_num_cust_svc');
2010 'table' => 'cust_pkg',
2011 'hashref' => { 'custnum' => $self->custnum },
2016 # This should be generalized to use config options to determine order.
2019 if ( $a->get('cancel') xor $b->get('cancel') ) {
2020 return -1 if $b->get('cancel');
2021 return 1 if $a->get('cancel');
2022 #shouldn't get here...
2025 my $a_num_cust_svc = $a->num_cust_svc;
2026 my $b_num_cust_svc = $b->num_cust_svc;
2027 return 0 if !$a_num_cust_svc && !$b_num_cust_svc;
2028 return -1 if $a_num_cust_svc && !$b_num_cust_svc;
2029 return 1 if !$a_num_cust_svc && $b_num_cust_svc;
2030 my @a_cust_svc = $a->cust_svc;
2031 my @b_cust_svc = $b->cust_svc;
2032 $a_cust_svc[0]->svc_x->label cmp $b_cust_svc[0]->svc_x->label;
2037 =item suspended_pkgs
2039 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
2043 sub suspended_pkgs {
2045 grep { $_->susp } $self->ncancelled_pkgs;
2048 =item unflagged_suspended_pkgs
2050 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
2051 customer (thouse packages without the `manual_flag' set).
2055 sub unflagged_suspended_pkgs {
2057 return $self->suspended_pkgs
2058 unless dbdef->table('cust_pkg')->column('manual_flag');
2059 grep { ! $_->manual_flag } $self->suspended_pkgs;
2062 =item unsuspended_pkgs
2064 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
2069 sub unsuspended_pkgs {
2071 grep { ! $_->susp } $self->ncancelled_pkgs;
2074 =item next_bill_date
2076 Returns the next date this customer will be billed, as a UNIX timestamp, or
2077 undef if no active package has a next bill date.
2081 sub next_bill_date {
2083 min( map $_->get('bill'), grep $_->get('bill'), $self->unsuspended_pkgs );
2086 =item num_cancelled_pkgs
2088 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
2093 sub num_cancelled_pkgs {
2094 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
2097 sub num_ncancelled_pkgs {
2098 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
2102 my( $self ) = shift;
2103 my $sql = scalar(@_) ? shift : '';
2104 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
2105 my $sth = dbh->prepare(
2106 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
2107 ) or die dbh->errstr;
2108 $sth->execute($self->custnum) or die $sth->errstr;
2109 $sth->fetchrow_arrayref->[0];
2114 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2115 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2116 on success or a list of errors.
2122 grep { $_->unsuspend } $self->suspended_pkgs;
2127 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2129 Returns a list: an empty list on success or a list of errors.
2135 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2138 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2140 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2141 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2142 of a list of pkgparts; the hashref has the following keys:
2146 =item pkgparts - listref of pkgparts
2148 =item (other options are passed to the suspend method)
2153 Returns a list: an empty list on success or a list of errors.
2157 sub suspend_if_pkgpart {
2159 my (@pkgparts, %opt);
2160 if (ref($_[0]) eq 'HASH'){
2161 @pkgparts = @{$_[0]{pkgparts}};
2166 grep { $_->suspend(%opt) }
2167 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2168 $self->unsuspended_pkgs;
2171 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2173 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2174 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2175 instead of a list of pkgparts; the hashref has the following keys:
2179 =item pkgparts - listref of pkgparts
2181 =item (other options are passed to the suspend method)
2185 Returns a list: an empty list on success or a list of errors.
2189 sub suspend_unless_pkgpart {
2191 my (@pkgparts, %opt);
2192 if (ref($_[0]) eq 'HASH'){
2193 @pkgparts = @{$_[0]{pkgparts}};
2198 grep { $_->suspend(%opt) }
2199 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2200 $self->unsuspended_pkgs;
2203 =item cancel [ OPTION => VALUE ... ]
2205 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2207 Available options are:
2211 =item quiet - can be set true to supress email cancellation notices.
2213 =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.
2215 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2217 =item nobill - can be set true to skip billing if it might otherwise be done.
2221 Always returns a list: an empty list on success or a list of errors.
2225 # nb that dates are not specified as valid options to this method
2228 my( $self, %opt ) = @_;
2230 warn "$me cancel called on customer ". $self->custnum. " with options ".
2231 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2234 return ( 'access denied' )
2235 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2237 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2239 #should try decryption (we might have the private key)
2240 # and if not maybe queue a job for the server that does?
2241 return ( "Can't (yet) ban encrypted credit cards" )
2242 if $self->is_encrypted($self->payinfo);
2244 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
2245 my $error = $ban->insert;
2246 return ( $error ) if $error;
2250 my @pkgs = $self->ncancelled_pkgs;
2252 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2254 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2255 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2259 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2260 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2263 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2266 sub _banned_pay_hashref {
2277 'payby' => $payby2ban{$self->payby},
2278 'payinfo' => md5_base64($self->payinfo),
2279 #don't ever *search* on reason! #'reason' =>
2285 Returns all notes (see L<FS::cust_main_note>) for this customer.
2292 qsearch( 'cust_main_note',
2293 { 'custnum' => $self->custnum },
2295 'ORDER BY _DATE DESC'
2301 Returns the agent (see L<FS::agent>) for this customer.
2307 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2312 Returns the customer class, as an FS::cust_class object, or the empty string
2313 if there is no customer class.
2319 if ( $self->classnum ) {
2320 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2328 Returns the customer category name, or the empty string if there is no customer
2335 my $cust_class = $self->cust_class;
2337 ? $cust_class->categoryname
2343 Returns the customer class name, or the empty string if there is no customer
2350 my $cust_class = $self->cust_class;
2352 ? $cust_class->classname
2357 =item bill_and_collect
2359 Cancels and suspends any packages due, generates bills, applies payments and
2362 Warns on errors (Does not currently: If there is an error, returns the error, otherwise returns false.)
2364 Options are passed as name-value pairs. Currently available options are:
2370 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:
2374 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2378 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.
2382 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2386 If set true, re-charges setup fees.
2390 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)
2394 Options are passed to the B<bill> and B<collect> methods verbatim, so all
2395 options of those methods are also available.
2399 sub bill_and_collect {
2400 my( $self, %options ) = @_;
2402 #$options{actual_time} not $options{time} because freeside-daily -d is for
2403 #pre-printing invoices
2404 $self->cancel_expired_pkgs( $options{actual_time} );
2405 $self->suspend_adjourned_pkgs( $options{actual_time} );
2407 my $error = $self->bill( %options );
2408 warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
2410 $self->apply_payments_and_credits;
2412 unless ( $conf->exists('cancelled_cust-noevents')
2413 && ! $self->num_ncancelled_pkgs
2416 $error = $self->collect( %options );
2417 warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
2423 sub cancel_expired_pkgs {
2424 my ( $self, $time ) = @_;
2426 my @cancel_pkgs = $self->ncancelled_pkgs( {
2427 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
2430 foreach my $cust_pkg ( @cancel_pkgs ) {
2431 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
2432 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
2433 'reason_otaker' => $cpr->otaker
2437 warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
2438 " for custnum ". $self->custnum. ": $error"
2444 sub suspend_adjourned_pkgs {
2445 my ( $self, $time ) = @_;
2447 my @susp_pkgs = $self->ncancelled_pkgs( {
2449 " AND ( susp IS NULL OR susp = 0 )
2450 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
2451 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
2456 #only because there's no SQL test for is_prepaid :/
2458 grep { ( $_->part_pkg->is_prepaid
2463 && $_->adjourn <= $time
2469 foreach my $cust_pkg ( @susp_pkgs ) {
2470 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
2471 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
2472 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
2473 'reason_otaker' => $cpr->otaker
2478 warn "Error suspending package ". $cust_pkg->pkgnum.
2479 " for custnum ". $self->custnum. ": $error"
2487 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
2488 conjunction with the collect method by calling B<bill_and_collect>.
2490 If there is an error, returns the error, otherwise returns false.
2492 Options are passed as name-value pairs. Currently available options are:
2498 If set true, re-charges setup fees.
2502 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:
2506 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2510 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2512 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2516 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
2520 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.
2524 This boolean value informs the us that the package is being cancelled. This
2525 typically might mean not charging the normal recurring fee but only usage
2526 fees since the last billing. Setup charges may be charged. Not all package
2527 plans support this feature (they tend to charge 0).
2531 Options terms to be printed on this invocice. Otherwise, customer-specific
2532 terms or the default terms are used.
2539 my( $self, %options ) = @_;
2540 return '' if $self->payby eq 'COMP';
2541 warn "$me bill customer ". $self->custnum. "\n"
2544 my $time = $options{'time'} || time;
2545 my $invoice_time = $options{'invoice_time'} || $time;
2547 $options{'not_pkgpart'} ||= {};
2548 $options{'not_pkgpart'} = { map { $_ => 1 }
2549 split(/\s*,\s*/, $options{'not_pkgpart'})
2551 unless ref($options{'not_pkgpart'});
2553 local $SIG{HUP} = 'IGNORE';
2554 local $SIG{INT} = 'IGNORE';
2555 local $SIG{QUIT} = 'IGNORE';
2556 local $SIG{TERM} = 'IGNORE';
2557 local $SIG{TSTP} = 'IGNORE';
2558 local $SIG{PIPE} = 'IGNORE';
2560 my $oldAutoCommit = $FS::UID::AutoCommit;
2561 local $FS::UID::AutoCommit = 0;
2564 $self->select_for_update; #mutex
2566 my $error = $self->do_cust_event(
2567 'debug' => ( $options{'debug'} || 0 ),
2568 'time' => $invoice_time,
2569 'check_freq' => $options{'check_freq'},
2570 'stage' => 'pre-bill',
2573 $dbh->rollback if $oldAutoCommit;
2577 my @cust_bill_pkg = ();
2580 # find the packages which are due for billing, find out how much they are
2581 # & generate invoice database.
2584 my( $total_setup, $total_recur, $postal_charge ) = ( 0, 0, 0 );
2586 my @precommit_hooks = ();
2588 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
2589 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
2591 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
2593 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2595 #? to avoid use of uninitialized value errors... ?
2596 $cust_pkg->setfield('bill', '')
2597 unless defined($cust_pkg->bill);
2599 #my $part_pkg = $cust_pkg->part_pkg;
2601 my $real_pkgpart = $cust_pkg->pkgpart;
2602 my %hash = $cust_pkg->hash;
2604 foreach my $part_pkg ( $cust_pkg->part_pkg->self_and_bill_linked ) {
2606 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
2609 $self->_make_lines( 'part_pkg' => $part_pkg,
2610 'cust_pkg' => $cust_pkg,
2611 'precommit_hooks' => \@precommit_hooks,
2612 'line_items' => \@cust_bill_pkg,
2613 'setup' => \$total_setup,
2614 'recur' => \$total_recur,
2615 'tax_matrix' => \%taxlisthash,
2617 'real_pkgpart' => $real_pkgpart,
2618 'options' => \%options,
2621 $dbh->rollback if $oldAutoCommit;
2625 } #foreach my $part_pkg
2627 } #foreach my $cust_pkg
2629 unless ( @cust_bill_pkg ) { #don't create an invoice w/o line items
2630 #but do commit any package date cycling that happened
2631 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2635 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
2636 !$conf->exists('postal_invoice-recurring_only')
2640 my $postal_pkg = $self->charge_postal_fee();
2641 if ( $postal_pkg && !ref( $postal_pkg ) ) {
2643 $dbh->rollback if $oldAutoCommit;
2644 return "can't charge postal invoice fee for customer ".
2645 $self->custnum. ": $postal_pkg";
2647 } elsif ( $postal_pkg ) {
2649 my $real_pkgpart = $postal_pkg->pkgpart;
2650 foreach my $part_pkg ( $postal_pkg->part_pkg->self_and_bill_linked ) {
2651 my %postal_options = %options;
2652 delete $postal_options{cancel};
2654 $self->_make_lines( 'part_pkg' => $part_pkg,
2655 'cust_pkg' => $postal_pkg,
2656 'precommit_hooks' => \@precommit_hooks,
2657 'line_items' => \@cust_bill_pkg,
2658 'setup' => \$total_setup,
2659 'recur' => \$total_recur,
2660 'tax_matrix' => \%taxlisthash,
2662 'real_pkgpart' => $real_pkgpart,
2663 'options' => \%postal_options,
2666 $dbh->rollback if $oldAutoCommit;
2675 my $listref_or_error =
2676 $self->calculate_taxes( \@cust_bill_pkg, \%taxlisthash, $invoice_time);
2678 unless ( ref( $listref_or_error ) ) {
2679 $dbh->rollback if $oldAutoCommit;
2680 return $listref_or_error;
2683 foreach my $taxline ( @$listref_or_error ) {
2684 $total_setup = sprintf('%.2f', $total_setup+$taxline->setup );
2685 push @cust_bill_pkg, $taxline;
2688 #add tax adjustments
2689 warn "adding tax adjustments...\n" if $DEBUG > 2;
2690 foreach my $cust_tax_adjustment (
2691 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
2697 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
2699 my $itemdesc = $cust_tax_adjustment->taxname;
2700 $itemdesc = '' if $itemdesc eq 'Tax';
2702 push @cust_bill_pkg, new FS::cust_bill_pkg {
2708 'itemdesc' => $itemdesc,
2709 'itemcomment' => $cust_tax_adjustment->comment,
2710 'cust_tax_adjustment' => $cust_tax_adjustment,
2711 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2716 my $charged = sprintf('%.2f', $total_setup + $total_recur );
2718 my @cust_bill = $self->cust_bill;
2719 my $balance = $self->balance;
2720 my $previous_balance = scalar(@cust_bill)
2721 ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
2724 $previous_balance += $cust_bill[$#cust_bill]->charged
2725 if scalar(@cust_bill);
2726 #my $balance_adjustments =
2727 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
2729 #create the new invoice
2730 my $cust_bill = new FS::cust_bill ( {
2731 'custnum' => $self->custnum,
2732 '_date' => ( $invoice_time ),
2733 'charged' => $charged,
2734 'billing_balance' => $balance,
2735 'previous_balance' => $previous_balance,
2736 'invoice_terms' => $options{'invoice_terms'},
2738 $error = $cust_bill->insert;
2740 $dbh->rollback if $oldAutoCommit;
2741 return "can't create invoice for customer #". $self->custnum. ": $error";
2744 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
2745 $cust_bill_pkg->invnum($cust_bill->invnum);
2746 my $error = $cust_bill_pkg->insert;
2748 $dbh->rollback if $oldAutoCommit;
2749 return "can't create invoice line item: $error";
2754 foreach my $hook ( @precommit_hooks ) {
2756 &{$hook}; #($self) ?
2759 $dbh->rollback if $oldAutoCommit;
2760 return "$@ running precommit hook $hook\n";
2764 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2768 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
2770 This is a weird one. Perhaps it should not even be exposed.
2772 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
2773 Usually used internally by bill method B<bill>.
2775 If there is an error, returns the error, otherwise returns reference to a
2776 list of line items suitable for insertion.
2782 An array ref of the line items being billed.
2786 A strange beast. The keys to this hash are internal identifiers consisting
2787 of the name of the tax object type, a space, and its unique identifier ( e.g.
2788 'cust_main_county 23' ). The values of the hash are listrefs. The first
2789 item in the list is the tax object. The remaining items are either line
2790 items or floating point values (currency amounts).
2792 The taxes are calculated on this entity. Calculated exemption records are
2793 transferred to the LINEITEMREF items on the assumption that they are related.
2799 This specifies the date appearing on the associated invoice. Some
2800 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
2805 sub calculate_taxes {
2806 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
2808 my @tax_line_items = ();
2810 warn "having a look at the taxes we found...\n" if $DEBUG > 2;
2812 # keys are tax names (as printed on invoices / itemdesc )
2813 # values are listrefs of taxlisthash keys (internal identifiers)
2816 # keys are taxlisthash keys (internal identifiers)
2817 # values are (cumulative) amounts
2820 # keys are taxlisthash keys (internal identifiers)
2821 # values are listrefs of cust_bill_pkg_tax_location hashrefs
2822 my %tax_location = ();
2824 # keys are taxlisthash keys (internal identifiers)
2825 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
2826 my %tax_rate_location = ();
2828 foreach my $tax ( keys %$taxlisthash ) {
2829 my $tax_object = shift @{ $taxlisthash->{$tax} };
2830 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
2831 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
2832 my $hashref_or_error =
2833 $tax_object->taxline( $taxlisthash->{$tax},
2834 'custnum' => $self->custnum,
2835 'invoice_time' => $invoice_time
2837 return $hashref_or_error unless ref($hashref_or_error);
2839 unshift @{ $taxlisthash->{$tax} }, $tax_object;
2841 my $name = $hashref_or_error->{'name'};
2842 my $amount = $hashref_or_error->{'amount'};
2844 #warn "adding $amount as $name\n";
2845 $taxname{ $name } ||= [];
2846 push @{ $taxname{ $name } }, $tax;
2848 $tax{ $tax } += $amount;
2850 $tax_location{ $tax } ||= [];
2851 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
2852 push @{ $tax_location{ $tax } },
2854 'taxnum' => $tax_object->taxnum,
2855 'taxtype' => ref($tax_object),
2856 'pkgnum' => $tax_object->get('pkgnum'),
2857 'locationnum' => $tax_object->get('locationnum'),
2858 'amount' => sprintf('%.2f', $amount ),
2862 $tax_rate_location{ $tax } ||= [];
2863 if ( ref($tax_object) eq 'FS::tax_rate' ) {
2864 my $taxratelocationnum =
2865 $tax_object->tax_rate_location->taxratelocationnum;
2866 push @{ $tax_rate_location{ $tax } },
2868 'taxnum' => $tax_object->taxnum,
2869 'taxtype' => ref($tax_object),
2870 'amount' => sprintf('%.2f', $amount ),
2871 'locationtaxid' => $tax_object->location,
2872 'taxratelocationnum' => $taxratelocationnum,
2878 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
2879 my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
2880 foreach my $tax ( keys %$taxlisthash ) {
2881 foreach ( @{ $taxlisthash->{$tax} }[1 ... scalar(@{ $taxlisthash->{$tax} })] ) {
2882 next unless ref($_) eq 'FS::cust_bill_pkg';
2884 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
2885 splice( @{ $_->_cust_tax_exempt_pkg } );
2889 #consolidate and create tax line items
2890 warn "consolidating and generating...\n" if $DEBUG > 2;
2891 foreach my $taxname ( keys %taxname ) {
2894 my @cust_bill_pkg_tax_location = ();
2895 my @cust_bill_pkg_tax_rate_location = ();
2896 warn "adding $taxname\n" if $DEBUG > 1;
2897 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
2898 next if $seen{$taxitem}++;
2899 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
2900 $tax += $tax{$taxitem};
2901 push @cust_bill_pkg_tax_location,
2902 map { new FS::cust_bill_pkg_tax_location $_ }
2903 @{ $tax_location{ $taxitem } };
2904 push @cust_bill_pkg_tax_rate_location,
2905 map { new FS::cust_bill_pkg_tax_rate_location $_ }
2906 @{ $tax_rate_location{ $taxitem } };
2910 $tax = sprintf('%.2f', $tax );
2912 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
2918 if ( $pkg_category and
2919 $conf->config('invoice_latexsummary') ||
2920 $conf->config('invoice_htmlsummary')
2924 my %hash = ( 'section' => $pkg_category->categoryname );
2925 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
2929 push @tax_line_items, new FS::cust_bill_pkg {
2935 'itemdesc' => $taxname,
2936 'display' => \@display,
2937 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2938 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
2947 my ($self, %params) = @_;
2949 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
2950 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
2951 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
2952 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
2953 my $total_setup = $params{setup} or die "no setup accumulator specified";
2954 my $total_recur = $params{recur} or die "no recur accumulator specified";
2955 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
2956 my $time = $params{'time'} or die "no time specified";
2957 my (%options) = %{$params{options}};
2960 my $real_pkgpart = $params{real_pkgpart};
2961 my %hash = $cust_pkg->hash;
2962 my $old_cust_pkg = new FS::cust_pkg \%hash;
2968 $cust_pkg->pkgpart($part_pkg->pkgpart);
2976 if ( $options{'resetup'}
2977 || ( ! $cust_pkg->setup
2978 && ( ! $cust_pkg->start_date
2979 || $cust_pkg->start_date <= $time
2981 && ( ! $conf->exists('disable_setup_suspended_pkgs')
2982 || ( $conf->exists('disable_setup_suspended_pkgs') &&
2983 ! $cust_pkg->getfield('susp')
2990 warn " bill setup\n" if $DEBUG > 1;
2993 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2994 return "$@ running calc_setup for $cust_pkg\n"
2997 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
2999 $cust_pkg->setfield('setup', $time)
3000 unless $cust_pkg->setup;
3001 #do need it, but it won't get written to the db
3002 #|| $cust_pkg->pkgpart != $real_pkgpart;
3004 $cust_pkg->setfield('start_date', '')
3005 if $cust_pkg->start_date;
3010 # bill recurring fee
3013 #XXX unit stuff here too
3017 if ( ! $cust_pkg->get('susp')
3018 and ! $cust_pkg->get('start_date')
3019 and ( $part_pkg->getfield('freq') ne '0'
3020 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
3022 || ( $part_pkg->plan eq 'voip_cdr'
3023 && $part_pkg->option('bill_every_call')
3025 || ( $options{cancel} )
3028 # XXX should this be a package event? probably. events are called
3029 # at collection time at the moment, though...
3030 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
3031 if $part_pkg->can('reset_usage');
3032 #don't want to reset usage just cause we want a line item??
3033 #&& $part_pkg->pkgpart == $real_pkgpart;
3035 warn " bill recur\n" if $DEBUG > 1;
3038 # XXX shared with $recur_prog
3039 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
3043 #over two params! lets at least switch to a hashref for the rest...
3044 my $increment_next_bill = ( $part_pkg->freq ne '0'
3045 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
3046 && !$options{cancel}
3048 my %param = ( 'precommit_hooks' => $precommit_hooks,
3049 'increment_next_bill' => $increment_next_bill,
3052 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
3053 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
3054 return "$@ running $method for $cust_pkg\n"
3057 if ( $increment_next_bill ) {
3059 my $next_bill = $part_pkg->add_freq($sdate);
3060 return "unparsable frequency: ". $part_pkg->freq
3061 if $next_bill == -1;
3063 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
3064 # only for figuring next bill date, nothing else, so, reset $sdate again
3066 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
3067 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
3068 $cust_pkg->last_bill($sdate);
3070 $cust_pkg->setfield('bill', $next_bill );
3076 warn "\$setup is undefined" unless defined($setup);
3077 warn "\$recur is undefined" unless defined($recur);
3078 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
3081 # If there's line items, create em cust_bill_pkg records
3082 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
3087 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
3088 # hmm.. and if just the options are modified in some weird price plan?
3090 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
3093 my $error = $cust_pkg->replace( $old_cust_pkg,
3094 'options' => { $cust_pkg->options },
3096 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
3097 if $error; #just in case
3100 $setup = sprintf( "%.2f", $setup );
3101 $recur = sprintf( "%.2f", $recur );
3102 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
3103 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
3105 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
3106 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
3109 if ( $setup != 0 || $recur != 0 ) {
3111 warn " charges (setup=$setup, recur=$recur); adding line items\n"
3114 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
3116 warn " adding customer package invoice detail: $_\n"
3117 foreach @cust_pkg_detail;
3119 push @details, @cust_pkg_detail;
3121 my $cust_bill_pkg = new FS::cust_bill_pkg {
3122 'pkgnum' => $cust_pkg->pkgnum,
3124 'unitsetup' => $unitsetup,
3126 'unitrecur' => $unitrecur,
3127 'quantity' => $cust_pkg->quantity,
3128 'details' => \@details,
3129 'hidden' => $part_pkg->hidden,
3132 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
3133 $cust_bill_pkg->sdate( $hash{last_bill} );
3134 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
3135 $cust_bill_pkg->edate( $time ) if $options{cancel};
3136 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
3137 $cust_bill_pkg->sdate( $sdate );
3138 $cust_bill_pkg->edate( $cust_pkg->bill );
3139 #$cust_bill_pkg->edate( $time ) if $options{cancel};
3142 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
3143 unless $part_pkg->pkgpart == $real_pkgpart;
3145 $$total_setup += $setup;
3146 $$total_recur += $recur;
3153 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
3154 return $error if $error;
3156 push @$cust_bill_pkgs, $cust_bill_pkg;
3158 } #if $setup != 0 || $recur != 0
3168 my $part_pkg = shift;
3169 my $taxlisthash = shift;
3170 my $cust_bill_pkg = shift;
3171 my $cust_pkg = shift;
3172 my $invoice_time = shift;
3173 my $real_pkgpart = shift;
3174 my $options = shift;
3176 my %cust_bill_pkg = ();
3180 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
3181 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
3182 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
3183 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
3185 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
3187 if ( $conf->exists('enable_taxproducts')
3188 && ( scalar($part_pkg->part_pkg_taxoverride)
3189 || $part_pkg->has_taxproduct
3194 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3195 return "fatal: Can't (yet) use tax-pkg_address with taxproducts";
3198 foreach my $class (@classes) {
3199 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class );
3200 return $err_or_ref unless ref($err_or_ref);
3201 $taxes{$class} = $err_or_ref;
3204 unless (exists $taxes{''}) {
3205 my $err_or_ref = $self->_gather_taxes( $part_pkg, '' );
3206 return $err_or_ref unless ref($err_or_ref);
3207 $taxes{''} = $err_or_ref;
3212 my @loc_keys = qw( city county state country );
3214 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3215 my $cust_location = $cust_pkg->cust_location;
3216 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
3219 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
3222 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
3225 $taxhash{'taxclass'} = $part_pkg->taxclass;
3228 my %taxhash_elim = %taxhash;
3229 my @elim = qw( city county state );
3232 #first try a match with taxclass
3233 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
3235 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
3236 #then try a match without taxclass
3237 my %no_taxclass = %taxhash_elim;
3238 $no_taxclass{ 'taxclass' } = '';
3239 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
3242 $taxhash_elim{ shift(@elim) } = '';
3244 } while ( !scalar(@taxes) && scalar(@elim) );
3246 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
3248 if $self->cust_main_exemption; #just to be safe
3250 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3252 $_->set('pkgnum', $cust_pkg->pkgnum );
3253 $_->set('locationnum', $cust_pkg->locationnum );
3257 $taxes{''} = [ @taxes ];
3258 $taxes{'setup'} = [ @taxes ];
3259 $taxes{'recur'} = [ @taxes ];
3260 $taxes{$_} = [ @taxes ] foreach (@classes);
3262 # # maybe eliminate this entirely, along with all the 0% records
3263 # unless ( @taxes ) {
3265 # "fatal: can't find tax rate for state/county/country/taxclass ".
3266 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
3269 } #if $conf->exists('enable_taxproducts') ...
3274 my $separate = $conf->exists('separate_usage');
3275 my $usage_mandate = $cust_pkg->part_pkg->option('usage_mandate', 'Hush!');
3276 if ( $separate || $cust_bill_pkg->hidden || $usage_mandate ) {
3278 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
3279 my %hash = $cust_bill_pkg->hidden # maybe for all bill linked?
3280 ? ( 'section' => $temp_pkg->part_pkg->categoryname )
3283 my $section = $cust_pkg->part_pkg->option('usage_section', 'Hush!');
3284 my $summary = $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
3286 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3287 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
3289 push @display, new FS::cust_bill_pkg_display
3292 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
3296 if ($separate && $section && $summary) {
3297 push @display, new FS::cust_bill_pkg_display { type => 'U',
3302 if ($usage_mandate || $section && $summary) {
3303 $hash{post_total} = 'Y';
3306 $hash{section} = $section if ($separate || $usage_mandate);
3307 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
3310 $cust_bill_pkg->set('display', \@display);
3312 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
3313 foreach my $key (keys %tax_cust_bill_pkg) {
3314 my @taxes = @{ $taxes{$key} || [] };
3315 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
3317 my %localtaxlisthash = ();
3318 foreach my $tax ( @taxes ) {
3320 my $taxname = ref( $tax ). ' '. $tax->taxnum;
3321 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
3322 # ' locationnum'. $cust_pkg->locationnum
3323 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
3325 $taxlisthash->{ $taxname } ||= [ $tax ];
3326 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
3328 $localtaxlisthash{ $taxname } ||= [ $tax ];
3329 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
3333 warn "finding taxed taxes...\n" if $DEBUG > 2;
3334 foreach my $tax ( keys %localtaxlisthash ) {
3335 my $tax_object = shift @{ $localtaxlisthash{$tax} };
3336 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
3338 next unless $tax_object->can('tax_on_tax');
3340 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
3341 my $totname = ref( $tot ). ' '. $tot->taxnum;
3343 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
3345 next unless exists( $localtaxlisthash{ $totname } ); # only increase
3347 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
3348 my $hashref_or_error =
3349 $tax_object->taxline( $localtaxlisthash{$tax},
3350 'custnum' => $self->custnum,
3351 'invoice_time' => $invoice_time,
3353 return $hashref_or_error
3354 unless ref($hashref_or_error);
3356 $taxlisthash->{ $totname } ||= [ $tot ];
3357 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
3369 my $part_pkg = shift;
3373 my $geocode = $self->geocode('cch');
3375 my @taxclassnums = map { $_->taxclassnum }
3376 $part_pkg->part_pkg_taxoverride($class);
3378 unless (@taxclassnums) {
3379 @taxclassnums = map { $_->taxclassnum }
3380 grep { $_->taxable eq 'Y' }
3381 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
3383 warn "Found taxclassnum values of ". join(',', @taxclassnums)
3388 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
3390 @taxes = qsearch({ 'table' => 'tax_rate',
3391 'hashref' => { 'geocode' => $geocode, },
3392 'extra_sql' => $extra_sql,
3394 if scalar(@taxclassnums);
3396 warn "Found taxes ".
3397 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
3404 =item collect [ HASHREF | OPTION => VALUE ... ]
3406 (Attempt to) collect money for this customer's outstanding invoices (see
3407 L<FS::cust_bill>). Usually used after the bill method.
3409 Actions are now triggered by billing events; see L<FS::part_event> and the
3410 billing events web interface. Old-style invoice events (see
3411 L<FS::part_bill_event>) have been deprecated.
3413 If there is an error, returns the error, otherwise returns false.
3415 Options are passed as name-value pairs.
3417 Currently available options are:
3423 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.
3427 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3431 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3435 set true to surpress email card/ACH decline notices.
3439 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)
3445 # allows for one time override of normal customer billing method
3450 my( $self, %options ) = @_;
3451 my $invoice_time = $options{'invoice_time'} || time;
3454 local $SIG{HUP} = 'IGNORE';
3455 local $SIG{INT} = 'IGNORE';
3456 local $SIG{QUIT} = 'IGNORE';
3457 local $SIG{TERM} = 'IGNORE';
3458 local $SIG{TSTP} = 'IGNORE';
3459 local $SIG{PIPE} = 'IGNORE';
3461 my $oldAutoCommit = $FS::UID::AutoCommit;
3462 local $FS::UID::AutoCommit = 0;
3465 $self->select_for_update; #mutex
3468 my $balance = $self->balance;
3469 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
3472 if ( exists($options{'retry_card'}) ) {
3473 carp 'retry_card option passed to collect is deprecated; use retry';
3474 $options{'retry'} ||= $options{'retry_card'};
3476 if ( exists($options{'retry'}) && $options{'retry'} ) {
3477 my $error = $self->retry_realtime;
3479 $dbh->rollback if $oldAutoCommit;
3484 my $error = $self->do_cust_event(
3485 'debug' => ( $options{'debug'} || 0 ),
3486 'time' => $invoice_time,
3487 'check_freq' => $options{'check_freq'},
3488 'stage' => 'collect',
3491 $dbh->rollback if $oldAutoCommit;
3495 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3500 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
3502 Runs billing events; see L<FS::part_event> and the billing events web
3505 If there is an error, returns the error, otherwise returns false.
3507 Options are passed as name-value pairs.
3509 Currently available options are:
3515 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.
3519 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3523 "collect" (the default) or "pre-bill"
3527 set true to surpress email card/ACH decline notices.
3531 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)
3537 # allows for one time override of normal customer billing method
3541 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3544 my( $self, %options ) = @_;
3545 my $time = $options{'time'} || time;
3548 local $SIG{HUP} = 'IGNORE';
3549 local $SIG{INT} = 'IGNORE';
3550 local $SIG{QUIT} = 'IGNORE';
3551 local $SIG{TERM} = 'IGNORE';
3552 local $SIG{TSTP} = 'IGNORE';
3553 local $SIG{PIPE} = 'IGNORE';
3555 my $oldAutoCommit = $FS::UID::AutoCommit;
3556 local $FS::UID::AutoCommit = 0;
3559 $self->select_for_update; #mutex
3562 my $balance = $self->balance;
3563 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
3566 # if ( exists($options{'retry_card'}) ) {
3567 # carp 'retry_card option passed to collect is deprecated; use retry';
3568 # $options{'retry'} ||= $options{'retry_card'};
3570 # if ( exists($options{'retry'}) && $options{'retry'} ) {
3571 # my $error = $self->retry_realtime;
3573 # $dbh->rollback if $oldAutoCommit;
3578 # false laziness w/pay_batch::import_results
3580 my $due_cust_event = $self->due_cust_event(
3581 'debug' => ( $options{'debug'} || 0 ),
3583 'check_freq' => $options{'check_freq'},
3584 'stage' => ( $options{'stage'} || 'collect' ),
3586 unless( ref($due_cust_event) ) {
3587 $dbh->rollback if $oldAutoCommit;
3588 return $due_cust_event;
3591 foreach my $cust_event ( @$due_cust_event ) {
3595 #re-eval event conditions (a previous event could have changed things)
3596 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
3597 #don't leave stray "new/locked" records around
3598 my $error = $cust_event->delete;
3600 #gah, even with transactions
3601 $dbh->commit if $oldAutoCommit; #well.
3608 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
3609 warn " running cust_event ". $cust_event->eventnum. "\n"
3613 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
3614 if ( my $error = $cust_event->do_event() ) {
3615 #XXX wtf is this? figure out a proper dealio with return value
3617 # gah, even with transactions.
3618 $dbh->commit if $oldAutoCommit; #well.
3625 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3630 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
3632 Inserts database records for and returns an ordered listref of new events due
3633 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
3634 events are due, an empty listref is returned. If there is an error, returns a
3635 scalar error message.
3637 To actually run the events, call each event's test_condition method, and if
3638 still true, call the event's do_event method.
3640 Options are passed as a hashref or as a list of name-value pairs. Available
3647 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.
3651 "collect" (the default) or "pre-bill"
3655 "Current time" for the events.
3659 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)
3663 Only return events for the specified eventtable (by default, events of all eventtables are returned)
3667 Explicitly pass the objects to be tested (typically used with eventtable).
3671 Set to true to return the objects, but not actually insert them into the
3678 sub due_cust_event {
3680 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
3683 #my $DEBUG = $opt{'debug'}
3684 local($DEBUG) = $opt{'debug'}
3685 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
3687 warn "$me due_cust_event called with options ".
3688 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
3691 $opt{'time'} ||= time;
3693 local $SIG{HUP} = 'IGNORE';
3694 local $SIG{INT} = 'IGNORE';
3695 local $SIG{QUIT} = 'IGNORE';
3696 local $SIG{TERM} = 'IGNORE';
3697 local $SIG{TSTP} = 'IGNORE';
3698 local $SIG{PIPE} = 'IGNORE';
3700 my $oldAutoCommit = $FS::UID::AutoCommit;
3701 local $FS::UID::AutoCommit = 0;
3704 $self->select_for_update #mutex
3705 unless $opt{testonly};
3708 # find possible events (initial search)
3711 my @cust_event = ();
3713 my @eventtable = $opt{'eventtable'}
3714 ? ( $opt{'eventtable'} )
3715 : FS::part_event->eventtables_runorder;
3717 foreach my $eventtable ( @eventtable ) {
3720 if ( $opt{'objects'} ) {
3722 @objects = @{ $opt{'objects'} };
3726 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
3727 @objects = ( $eventtable eq 'cust_main' )
3729 : ( $self->$eventtable() );
3733 my @e_cust_event = ();
3735 my $cross = "CROSS JOIN $eventtable";
3736 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
3737 unless $eventtable eq 'cust_main';
3739 foreach my $object ( @objects ) {
3741 #this first search uses the condition_sql magic for optimization.
3742 #the more possible events we can eliminate in this step the better
3744 my $cross_where = '';
3745 my $pkey = $object->primary_key;
3746 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
3748 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
3750 FS::part_event_condition->where_conditions_sql( $eventtable,
3751 'time'=>$opt{'time'}
3753 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
3755 $extra_sql = "AND $extra_sql" if $extra_sql;
3757 #here is the agent virtualization
3758 $extra_sql .= " AND ( part_event.agentnum IS NULL
3759 OR part_event.agentnum = ". $self->agentnum. ' )';
3761 $extra_sql .= " $order";
3763 warn "searching for events for $eventtable ". $object->$pkey. "\n"
3764 if $opt{'debug'} > 2;
3765 my @part_event = qsearch( {
3766 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
3767 'select' => 'part_event.*',
3768 'table' => 'part_event',
3769 'addl_from' => "$cross $join",
3770 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
3771 'eventtable' => $eventtable,
3774 'extra_sql' => "AND $cross_where $extra_sql",
3778 my $pkey = $object->primary_key;
3779 warn " ". scalar(@part_event).
3780 " possible events found for $eventtable ". $object->$pkey(). "\n";
3783 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
3787 warn " ". scalar(@e_cust_event).
3788 " subtotal possible cust events found for $eventtable\n"
3791 push @cust_event, @e_cust_event;
3795 warn " ". scalar(@cust_event).
3796 " total possible cust events found in initial search\n"
3804 $opt{stage} ||= 'collect';
3806 grep { my $stage = $_->part_event->event_stage;
3807 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
3817 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
3818 'stats_hashref' => \%unsat ),
3821 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
3824 warn " invalid conditions not eliminated with condition_sql:\n".
3825 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
3832 unless( $opt{testonly} ) {
3833 foreach my $cust_event ( @cust_event ) {
3835 my $error = $cust_event->insert();
3837 $dbh->rollback if $oldAutoCommit;
3844 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3850 warn " returning events: ". Dumper(@cust_event). "\n"
3857 =item retry_realtime
3859 Schedules realtime / batch credit card / electronic check / LEC billing
3860 events for for retry. Useful if card information has changed or manual
3861 retry is desired. The 'collect' method must be called to actually retry
3864 Implementation details: For either this customer, or for each of this
3865 customer's open invoices, changes the status of the first "done" (with
3866 statustext error) realtime processing event to "failed".
3870 sub retry_realtime {
3873 local $SIG{HUP} = 'IGNORE';
3874 local $SIG{INT} = 'IGNORE';
3875 local $SIG{QUIT} = 'IGNORE';
3876 local $SIG{TERM} = 'IGNORE';
3877 local $SIG{TSTP} = 'IGNORE';
3878 local $SIG{PIPE} = 'IGNORE';
3880 my $oldAutoCommit = $FS::UID::AutoCommit;
3881 local $FS::UID::AutoCommit = 0;
3884 #a little false laziness w/due_cust_event (not too bad, really)
3886 my $join = FS::part_event_condition->join_conditions_sql;
3887 my $order = FS::part_event_condition->order_conditions_sql;
3890 . join ( ' OR ' , map {
3891 "( part_event.eventtable = " . dbh->quote($_)
3892 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
3893 } FS::part_event->eventtables)
3896 #here is the agent virtualization
3897 my $agent_virt = " ( part_event.agentnum IS NULL
3898 OR part_event.agentnum = ". $self->agentnum. ' )';
3900 #XXX this shouldn't be hardcoded, actions should declare it...
3901 my @realtime_events = qw(
3902 cust_bill_realtime_card
3903 cust_bill_realtime_check
3904 cust_bill_realtime_lec
3908 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
3913 my @cust_event = qsearchs({
3914 'table' => 'cust_event',
3915 'select' => 'cust_event.*',
3916 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
3917 'hashref' => { 'status' => 'done' },
3918 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
3919 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
3922 my %seen_invnum = ();
3923 foreach my $cust_event (@cust_event) {
3925 #max one for the customer, one for each open invoice
3926 my $cust_X = $cust_event->cust_X;
3927 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
3931 or $cust_event->part_event->eventtable eq 'cust_bill'
3934 my $error = $cust_event->retry;
3936 $dbh->rollback if $oldAutoCommit;
3937 return "error scheduling event for retry: $error";
3942 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3947 # some horrid false laziness here to avoid refactor fallout
3948 # eventually realtime realtime_bop and realtime_refund_bop should go
3949 # away and be replaced by _new_realtime_bop and _new_realtime_refund_bop
3951 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
3953 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
3954 via a Business::OnlinePayment realtime gateway. See
3955 L<http://420.am/business-onlinepayment> for supported gateways.
3957 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3959 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
3961 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3962 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3963 if set, will override the value from the customer record.
3965 I<description> is a free-text field passed to the gateway. It defaults to
3966 the value defined by the business-onlinepayment-description configuration
3967 option, or "Internet services" if that is unset.
3969 If an I<invnum> is specified, this payment (if successful) is applied to the
3970 specified invoice. If you don't specify an I<invnum> you might want to
3971 call the B<apply_payments> method or set the I<apply> option.
3973 I<apply> can be set to true to apply a resulting payment.
3975 I<quiet> can be set true to surpress email decline notices.
3977 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
3978 resulting paynum, if any.
3980 I<payunique> is a unique identifier for this payment.
3982 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
3989 return $self->_new_realtime_bop(@_)
3990 if $self->_new_bop_required();
3992 my($method, $amount);
3994 if (ref($_[0]) eq 'HASH') {
3995 %options = %{$_[0]};
3996 $method = $options{method};
3997 $amount = $options{amount};
3999 ( $method, $amount ) = ( shift, shift );
4003 warn "$me realtime_bop: $method $amount\n";
4004 warn " $_ => $options{$_}\n" foreach keys %options;
4007 unless ( $options{'description'} ) {
4008 if ( $conf->exists('business-onlinepayment-description') ) {
4009 my $dtempl = $conf->config('business-onlinepayment-description');
4011 my $agent = $self->agent->agent;
4013 $options{'description'} = eval qq("$dtempl");
4015 $options{'description'} = 'Internet services';
4019 return $self->fake_bop($method, $amount, %options) if $options{'fake'};
4021 eval "use Business::OnlinePayment";
4024 my $payinfo = exists($options{'payinfo'})
4025 ? $options{'payinfo'}
4028 my %method2payby = (
4035 # check for banned credit card/ACH
4038 my $ban = qsearchs('banned_pay', {
4039 'payby' => $method2payby{$method},
4040 'payinfo' => md5_base64($payinfo),
4042 return "Banned credit card" if $ban;
4045 # set taxclass and trans_is_recur based on invnum if there is one
4049 my $trans_is_recur = 0;
4050 if ( $options{'invnum'} ) {
4052 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
4053 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
4056 map { $_->part_pkg }
4058 map { $_->cust_pkg }
4059 $cust_bill->cust_bill_pkg;
4061 my @taxclasses = map $_->taxclass, @part_pkg;
4062 $taxclass = $taxclasses[0]
4063 unless grep { $taxclasses[0] ne $_ } @taxclasses; #unless there are
4064 #different taxclasses
4066 if grep { $_->freq ne '0' } @part_pkg;
4074 #look for an agent gateway override first
4076 if ( $method eq 'CC' ) {
4077 $cardtype = cardtype($payinfo);
4078 } elsif ( $method eq 'ECHECK' ) {
4081 $cardtype = $method;
4085 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4086 cardtype => $cardtype,
4087 taxclass => $taxclass, } )
4088 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4090 taxclass => $taxclass, } )
4091 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4092 cardtype => $cardtype,
4094 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4096 taxclass => '', } );
4098 my $payment_gateway = '';
4099 my( $processor, $login, $password, $action, @bop_options );
4100 if ( $override ) { #use a payment gateway override
4102 $payment_gateway = $override->payment_gateway;
4104 $processor = $payment_gateway->gateway_module;
4105 $login = $payment_gateway->gateway_username;
4106 $password = $payment_gateway->gateway_password;
4107 $action = $payment_gateway->gateway_action;
4108 @bop_options = $payment_gateway->options;
4110 } else { #use the standard settings from the config
4112 ( $processor, $login, $password, $action, @bop_options ) =
4113 $self->default_payment_gateway($method);
4121 my $address = exists($options{'address1'})
4122 ? $options{'address1'}
4124 my $address2 = exists($options{'address2'})
4125 ? $options{'address2'}
4127 $address .= ", ". $address2 if length($address2);
4129 my $o_payname = exists($options{'payname'})
4130 ? $options{'payname'}
4132 my($payname, $payfirst, $paylast);
4133 if ( $o_payname && $method ne 'ECHECK' ) {
4134 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4135 or return "Illegal payname $payname";
4136 ($payfirst, $paylast) = ($1, $2);
4138 $payfirst = $self->getfield('first');
4139 $paylast = $self->getfield('last');
4140 $payname = "$payfirst $paylast";
4143 my @invoicing_list = $self->invoicing_list_emailonly;
4144 if ( $conf->exists('emailinvoiceautoalways')
4145 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4146 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4147 push @invoicing_list, $self->all_emails;
4150 my $email = ($conf->exists('business-onlinepayment-email-override'))
4151 ? $conf->config('business-onlinepayment-email-override')
4152 : $invoicing_list[0];
4156 my $payip = exists($options{'payip'})
4159 $content{customer_ip} = $payip
4162 $content{invoice_number} = $options{'invnum'}
4163 if exists($options{'invnum'}) && length($options{'invnum'});
4165 $content{email_customer} =
4166 ( $conf->exists('business-onlinepayment-email_customer')
4167 || $conf->exists('business-onlinepayment-email-override') );
4170 if ( $method eq 'CC' ) {
4172 $content{card_number} = $payinfo;
4173 $paydate = exists($options{'paydate'})
4174 ? $options{'paydate'}
4176 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4177 $content{expiration} = "$2/$1";
4179 my $paycvv = exists($options{'paycvv'})
4180 ? $options{'paycvv'}
4182 $content{cvv2} = $paycvv
4185 my $paystart_month = exists($options{'paystart_month'})
4186 ? $options{'paystart_month'}
4187 : $self->paystart_month;
4189 my $paystart_year = exists($options{'paystart_year'})
4190 ? $options{'paystart_year'}
4191 : $self->paystart_year;
4193 $content{card_start} = "$paystart_month/$paystart_year"
4194 if $paystart_month && $paystart_year;
4196 my $payissue = exists($options{'payissue'})
4197 ? $options{'payissue'}
4199 $content{issue_number} = $payissue if $payissue;
4201 if ( $self->_bop_recurring_billing( 'payinfo' => $payinfo,
4202 'trans_is_recur' => $trans_is_recur,
4206 $content{recurring_billing} = 'YES';
4207 $content{acct_code} = 'rebill'
4208 if $conf->exists('credit_card-recurring_billing_acct_code');
4211 } elsif ( $method eq 'ECHECK' ) {
4212 ( $content{account_number}, $content{routing_code} ) =
4213 split('@', $payinfo);
4214 $content{bank_name} = $o_payname;
4215 $content{bank_state} = exists($options{'paystate'})
4216 ? $options{'paystate'}
4217 : $self->getfield('paystate');
4218 $content{account_type} = exists($options{'paytype'})
4219 ? uc($options{'paytype'}) || 'CHECKING'
4220 : uc($self->getfield('paytype')) || 'CHECKING';
4221 $content{account_name} = $payname;
4222 $content{customer_org} = $self->company ? 'B' : 'I';
4223 $content{state_id} = exists($options{'stateid'})
4224 ? $options{'stateid'}
4225 : $self->getfield('stateid');
4226 $content{state_id_state} = exists($options{'stateid_state'})
4227 ? $options{'stateid_state'}
4228 : $self->getfield('stateid_state');
4229 $content{customer_ssn} = exists($options{'ss'})
4232 } elsif ( $method eq 'LEC' ) {
4233 $content{phone} = $payinfo;
4237 # run transaction(s)
4240 my $balance = exists( $options{'balance'} )
4241 ? $options{'balance'}
4244 $self->select_for_update; #mutex ... just until we get our pending record in
4246 #the checks here are intended to catch concurrent payments
4247 #double-form-submission prevention is taken care of in cust_pay_pending::check
4250 return "The customer's balance has changed; $method transaction aborted."
4251 if $self->balance < $balance;
4252 #&& $self->balance < $amount; #might as well anyway?
4254 #also check and make sure there aren't *other* pending payments for this cust
4256 my @pending = qsearch('cust_pay_pending', {
4257 'custnum' => $self->custnum,
4258 'status' => { op=>'!=', value=>'done' }
4260 return "A payment is already being processed for this customer (".
4261 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
4262 "); $method transaction aborted."
4263 if scalar(@pending);
4265 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
4267 my $cust_pay_pending = new FS::cust_pay_pending {
4268 'custnum' => $self->custnum,
4269 #'invnum' => $options{'invnum'},
4272 'payby' => $method2payby{$method},
4273 'payinfo' => $payinfo,
4274 'paydate' => $paydate,
4275 'recurring_billing' => $content{recurring_billing},
4276 'pkgnum' => $options{'pkgnum'},
4278 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
4280 $cust_pay_pending->payunique( $options{payunique} )
4281 if defined($options{payunique}) && length($options{payunique});
4282 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
4283 return $cpp_new_err if $cpp_new_err;
4285 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
4287 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
4288 $transaction->content(
4291 'password' => $password,
4292 'action' => $action1,
4293 'description' => $options{'description'},
4294 'amount' => $amount,
4295 #'invoice_number' => $options{'invnum'},
4296 'customer_id' => $self->custnum,
4297 'last_name' => $paylast,
4298 'first_name' => $payfirst,
4300 'address' => $address,
4301 'city' => ( exists($options{'city'})
4304 'state' => ( exists($options{'state'})
4307 'zip' => ( exists($options{'zip'})
4310 'country' => ( exists($options{'country'})
4311 ? $options{'country'}
4313 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4315 'phone' => $self->daytime || $self->night,
4319 $cust_pay_pending->status('pending');
4320 my $cpp_pending_err = $cust_pay_pending->replace;
4321 return $cpp_pending_err if $cpp_pending_err;
4324 my $BOP_TESTING = 0;
4325 my $BOP_TESTING_SUCCESS = 1;
4327 unless ( $BOP_TESTING ) {
4328 $transaction->submit();
4330 if ( $BOP_TESTING_SUCCESS ) {
4331 $transaction->is_success(1);
4332 $transaction->authorization('fake auth');
4334 $transaction->is_success(0);
4335 $transaction->error_message('fake failure');
4339 if ( $transaction->is_success() && $action2 ) {
4341 $cust_pay_pending->status('authorized');
4342 my $cpp_authorized_err = $cust_pay_pending->replace;
4343 return $cpp_authorized_err if $cpp_authorized_err;
4345 my $auth = $transaction->authorization;
4346 my $ordernum = $transaction->can('order_number')
4347 ? $transaction->order_number
4351 new Business::OnlinePayment( $processor, @bop_options );
4358 password => $password,
4359 order_number => $ordernum,
4361 authorization => $auth,
4362 description => $options{'description'},
4365 foreach my $field (qw( authorization_source_code returned_ACI
4366 transaction_identifier validation_code
4367 transaction_sequence_num local_transaction_date
4368 local_transaction_time AVS_result_code )) {
4369 $capture{$field} = $transaction->$field() if $transaction->can($field);
4372 $capture->content( %capture );
4376 unless ( $capture->is_success ) {
4377 my $e = "Authorization successful but capture failed, custnum #".
4378 $self->custnum. ': '. $capture->result_code.
4379 ": ". $capture->error_message;
4386 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
4387 my $cpp_captured_err = $cust_pay_pending->replace;
4388 return $cpp_captured_err if $cpp_captured_err;
4391 # remove paycvv after initial transaction
4394 #false laziness w/misc/process/payment.cgi - check both to make sure working
4396 if ( defined $self->dbdef_table->column('paycvv')
4397 && length($self->paycvv)
4398 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
4400 my $error = $self->remove_cvv;
4402 warn "WARNING: error removing cvv: $error\n";
4410 if ( $transaction->is_success() ) {
4413 if ( $payment_gateway ) { # agent override
4414 $paybatch = $payment_gateway->gatewaynum. '-';
4417 $paybatch .= "$processor:". $transaction->authorization;
4419 $paybatch .= ':'. $transaction->order_number
4420 if $transaction->can('order_number')
4421 && length($transaction->order_number);
4423 my $cust_pay = new FS::cust_pay ( {
4424 'custnum' => $self->custnum,
4425 'invnum' => $options{'invnum'},
4428 'payby' => $method2payby{$method},
4429 'payinfo' => $payinfo,
4430 'paybatch' => $paybatch,
4431 'paydate' => $paydate,
4432 'pkgnum' => $options{'pkgnum'},
4434 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
4435 $cust_pay->payunique( $options{payunique} )
4436 if defined($options{payunique}) && length($options{payunique});
4438 my $oldAutoCommit = $FS::UID::AutoCommit;
4439 local $FS::UID::AutoCommit = 0;
4442 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
4444 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
4447 $cust_pay->invnum(''); #try again with no specific invnum
4448 my $error2 = $cust_pay->insert( $options{'manual'} ?
4449 ( 'manual' => 1 ) : ()
4452 # gah. but at least we have a record of the state we had to abort in
4453 # from cust_pay_pending now.
4454 my $e = "WARNING: $method captured but payment not recorded - ".
4455 "error inserting payment ($processor): $error2".
4456 " (previously tried insert with invnum #$options{'invnum'}" .
4457 ": $error ) - pending payment saved as paypendingnum ".
4458 $cust_pay_pending->paypendingnum. "\n";
4464 if ( $options{'paynum_ref'} ) {
4465 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
4468 $cust_pay_pending->status('done');
4469 $cust_pay_pending->statustext('captured');
4470 $cust_pay_pending->paynum($cust_pay->paynum);
4471 my $cpp_done_err = $cust_pay_pending->replace;
4473 if ( $cpp_done_err ) {
4475 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4476 my $e = "WARNING: $method captured but payment not recorded - ".
4477 "error updating status for paypendingnum ".
4478 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4484 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4486 if ( $options{'apply'} ) {
4487 my $apply_error = $self->apply_payments_and_credits;
4488 if ( $apply_error ) {
4489 warn "WARNING: error applying payment: $apply_error\n";
4490 #but we still should return no error cause the payment otherwise went
4495 return ''; #no error
4501 my $perror = "$processor error: ". $transaction->error_message;
4503 unless ( $transaction->error_message ) {
4506 if ( $transaction->can('response_page') ) {
4508 'page' => ( $transaction->can('response_page')
4509 ? $transaction->response_page
4512 'code' => ( $transaction->can('response_code')
4513 ? $transaction->response_code
4516 'headers' => ( $transaction->can('response_headers')
4517 ? $transaction->response_headers
4523 "No additional debugging information available for $processor";
4526 $perror .= "No error_message returned from $processor -- ".
4527 ( ref($t_response) ? Dumper($t_response) : $t_response );
4531 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
4532 && $conf->exists('emaildecline')
4533 && grep { $_ ne 'POST' } $self->invoicing_list
4534 && ! grep { $transaction->error_message =~ /$_/ }
4535 $conf->config('emaildecline-exclude')
4537 my @templ = $conf->config('declinetemplate');
4538 my $template = new Text::Template (
4540 SOURCE => [ map "$_\n", @templ ],
4541 ) or return "($perror) can't create template: $Text::Template::ERROR";
4542 $template->compile()
4543 or return "($perror) can't compile template: $Text::Template::ERROR";
4547 scalar( $conf->config('company_name', $self->agentnum ) ),
4548 'company_address' =>
4549 join("\n", $conf->config('company_address', $self->agentnum ) ),
4550 'error' => $transaction->error_message,
4553 my $error = send_email(
4554 'from' => $conf->config('invoice_from', $self->agentnum ),
4555 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
4556 'subject' => 'Your payment could not be processed',
4557 'body' => [ $template->fill_in(HASH => $templ_hash) ],
4560 $perror .= " (also received error sending decline notification: $error)"
4565 $cust_pay_pending->status('done');
4566 $cust_pay_pending->statustext("declined: $perror");
4567 my $cpp_done_err = $cust_pay_pending->replace;
4568 if ( $cpp_done_err ) {
4569 my $e = "WARNING: $method declined but pending payment not resolved - ".
4570 "error updating status for paypendingnum ".
4571 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4573 $perror = "$e ($perror)";
4581 sub _bop_recurring_billing {
4582 my( $self, %opt ) = @_;
4584 my $method = scalar($conf->config('credit_card-recurring_billing_flag'));
4586 if ( defined($method) && $method eq 'transaction_is_recur' ) {
4588 return 1 if $opt{'trans_is_recur'};
4592 my %hash = ( 'custnum' => $self->custnum,
4597 if qsearch('cust_pay', { %hash, 'payinfo' => $opt{'payinfo'} } )
4598 || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo('CARD',
4609 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
4611 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
4612 via a Business::OnlinePayment realtime gateway. See
4613 L<http://420.am/business-onlinepayment> for supported gateways.
4615 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4617 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
4619 Most gateways require a reference to an original payment transaction to refund,
4620 so you probably need to specify a I<paynum>.
4622 I<amount> defaults to the original amount of the payment if not specified.
4624 I<reason> specifies a reason for the refund.
4626 I<paydate> specifies the expiration date for a credit card overriding the
4627 value from the customer record or the payment record. Specified as yyyy-mm-dd
4629 Implementation note: If I<amount> is unspecified or equal to the amount of the
4630 orignal payment, first an attempt is made to "void" the transaction via
4631 the gateway (to cancel a not-yet settled transaction) and then if that fails,
4632 the normal attempt is made to "refund" ("credit") the transaction via the
4633 gateway is attempted.
4635 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4636 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4637 #if set, will override the value from the customer record.
4639 #If an I<invnum> is specified, this payment (if successful) is applied to the
4640 #specified invoice. If you don't specify an I<invnum> you might want to
4641 #call the B<apply_payments> method.
4645 #some false laziness w/realtime_bop, not enough to make it worth merging
4646 #but some useful small subs should be pulled out
4647 sub realtime_refund_bop {
4650 return $self->_new_realtime_refund_bop(@_)
4651 if $self->_new_bop_required();
4653 my( $method, %options ) = @_;
4655 warn "$me realtime_refund_bop: $method refund\n";
4656 warn " $_ => $options{$_}\n" foreach keys %options;
4659 eval "use Business::OnlinePayment";
4663 # look up the original payment and optionally a gateway for that payment
4667 my $amount = $options{'amount'};
4669 my( $processor, $login, $password, @bop_options ) ;
4670 my( $auth, $order_number ) = ( '', '', '' );
4672 if ( $options{'paynum'} ) {
4674 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
4675 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
4676 or return "Unknown paynum $options{'paynum'}";
4677 $amount ||= $cust_pay->paid;
4679 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
4680 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
4681 $cust_pay->paybatch;
4682 my $gatewaynum = '';
4683 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
4685 if ( $gatewaynum ) { #gateway for the payment to be refunded
4687 my $payment_gateway =
4688 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
4689 die "payment gateway $gatewaynum not found"
4690 unless $payment_gateway;
4692 $processor = $payment_gateway->gateway_module;
4693 $login = $payment_gateway->gateway_username;
4694 $password = $payment_gateway->gateway_password;
4695 @bop_options = $payment_gateway->options;
4697 } else { #try the default gateway
4699 my( $conf_processor, $unused_action );
4700 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
4701 $self->default_payment_gateway($method);
4703 return "processor of payment $options{'paynum'} $processor does not".
4704 " match default processor $conf_processor"
4705 unless $processor eq $conf_processor;
4710 } else { # didn't specify a paynum, so look for agent gateway overrides
4711 # like a normal transaction
4714 if ( $method eq 'CC' ) {
4715 $cardtype = cardtype($self->payinfo);
4716 } elsif ( $method eq 'ECHECK' ) {
4719 $cardtype = $method;
4722 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4723 cardtype => $cardtype,
4725 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4727 taxclass => '', } );
4729 if ( $override ) { #use a payment gateway override
4731 my $payment_gateway = $override->payment_gateway;
4733 $processor = $payment_gateway->gateway_module;
4734 $login = $payment_gateway->gateway_username;
4735 $password = $payment_gateway->gateway_password;
4736 #$action = $payment_gateway->gateway_action;
4737 @bop_options = $payment_gateway->options;
4739 } else { #use the standard settings from the config
4742 ( $processor, $login, $password, $unused_action, @bop_options ) =
4743 $self->default_payment_gateway($method);
4748 return "neither amount nor paynum specified" unless $amount;
4753 'password' => $password,
4754 'order_number' => $order_number,
4755 'amount' => $amount,
4756 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4758 $content{authorization} = $auth
4759 if length($auth); #echeck/ACH transactions have an order # but no auth
4760 #(at least with authorize.net)
4762 my $disable_void_after;
4763 if ($conf->exists('disable_void_after')
4764 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
4765 $disable_void_after = $1;
4768 #first try void if applicable
4769 if ( $cust_pay && $cust_pay->paid == $amount
4771 ( not defined($disable_void_after) )
4772 || ( time < ($cust_pay->_date + $disable_void_after ) )
4775 warn " attempting void\n" if $DEBUG > 1;
4776 my $void = new Business::OnlinePayment( $processor, @bop_options );
4777 $void->content( 'action' => 'void', %content );
4779 if ( $void->is_success ) {
4780 my $error = $cust_pay->void($options{'reason'});
4782 # gah, even with transactions.
4783 my $e = 'WARNING: Card/ACH voided but database not updated - '.
4784 "error voiding payment: $error";
4788 warn " void successful\n" if $DEBUG > 1;
4793 warn " void unsuccessful, trying refund\n"
4797 my $address = $self->address1;
4798 $address .= ", ". $self->address2 if $self->address2;
4800 my($payname, $payfirst, $paylast);
4801 if ( $self->payname && $method ne 'ECHECK' ) {
4802 $payname = $self->payname;
4803 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4804 or return "Illegal payname $payname";
4805 ($payfirst, $paylast) = ($1, $2);
4807 $payfirst = $self->getfield('first');
4808 $paylast = $self->getfield('last');
4809 $payname = "$payfirst $paylast";
4812 my @invoicing_list = $self->invoicing_list_emailonly;
4813 if ( $conf->exists('emailinvoiceautoalways')
4814 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4815 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4816 push @invoicing_list, $self->all_emails;
4819 my $email = ($conf->exists('business-onlinepayment-email-override'))
4820 ? $conf->config('business-onlinepayment-email-override')
4821 : $invoicing_list[0];
4823 my $payip = exists($options{'payip'})
4826 $content{customer_ip} = $payip
4830 if ( $method eq 'CC' ) {
4833 $content{card_number} = $payinfo = $cust_pay->payinfo;
4834 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
4835 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
4836 ($content{expiration} = "$2/$1"); # where available
4838 $content{card_number} = $payinfo = $self->payinfo;
4839 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
4840 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4841 $content{expiration} = "$2/$1";
4844 } elsif ( $method eq 'ECHECK' ) {
4847 $payinfo = $cust_pay->payinfo;
4849 $payinfo = $self->payinfo;
4851 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
4852 $content{bank_name} = $self->payname;
4853 $content{account_type} = 'CHECKING';
4854 $content{account_name} = $payname;
4855 $content{customer_org} = $self->company ? 'B' : 'I';
4856 $content{customer_ssn} = $self->ss;
4857 } elsif ( $method eq 'LEC' ) {
4858 $content{phone} = $payinfo = $self->payinfo;
4862 my $refund = new Business::OnlinePayment( $processor, @bop_options );
4863 my %sub_content = $refund->content(
4864 'action' => 'credit',
4865 'customer_id' => $self->custnum,
4866 'last_name' => $paylast,
4867 'first_name' => $payfirst,
4869 'address' => $address,
4870 'city' => $self->city,
4871 'state' => $self->state,
4872 'zip' => $self->zip,
4873 'country' => $self->country,
4875 'phone' => $self->daytime || $self->night,
4878 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
4882 return "$processor error: ". $refund->error_message
4883 unless $refund->is_success();
4885 my %method2payby = (
4891 my $paybatch = "$processor:". $refund->authorization;
4892 $paybatch .= ':'. $refund->order_number
4893 if $refund->can('order_number') && $refund->order_number;
4895 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
4896 my @cust_bill_pay = $cust_pay->cust_bill_pay;
4897 last unless @cust_bill_pay;
4898 my $cust_bill_pay = pop @cust_bill_pay;
4899 my $error = $cust_bill_pay->delete;
4903 my $cust_refund = new FS::cust_refund ( {
4904 'custnum' => $self->custnum,
4905 'paynum' => $options{'paynum'},
4906 'refund' => $amount,
4908 'payby' => $method2payby{$method},
4909 'payinfo' => $payinfo,
4910 'paybatch' => $paybatch,
4911 'reason' => $options{'reason'} || 'card or ACH refund',
4913 my $error = $cust_refund->insert;
4915 $cust_refund->paynum(''); #try again with no specific paynum
4916 my $error2 = $cust_refund->insert;
4918 # gah, even with transactions.
4919 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
4920 "error inserting refund ($processor): $error2".
4921 " (previously tried insert with paynum #$options{'paynum'}" .
4932 # does the configuration indicate the new bop routines are required?
4934 sub _new_bop_required {
4937 my $botpp = 'Business::OnlineThirdPartyPayment';
4940 if ( $conf->config('business-onlinepayment-namespace') eq $botpp ||
4941 scalar( grep { $_->gateway_namespace eq $botpp }
4942 qsearch( 'payment_gateway', { 'disabled' => '' } )
4950 =item realtime_collect [ OPTION => VALUE ... ]
4952 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4953 via a Business::OnlinePayment or Business::OnlineThirdPartyPayment realtime
4954 gateway. See L<http://420.am/business-onlinepayment> and
4955 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
4957 On failure returns an error message.
4959 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.
4961 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>, I<pkgnum>
4963 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>. If none is specified
4964 then it is deduced from the customer record.
4966 If no I<amount> is specified, then the customer balance is used.
4968 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4969 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4970 if set, will override the value from the customer record.
4972 I<description> is a free-text field passed to the gateway. It defaults to
4973 the value defined by the business-onlinepayment-description configuration
4974 option, or "Internet services" if that is unset.
4976 If an I<invnum> is specified, this payment (if successful) is applied to the
4977 specified invoice. If you don't specify an I<invnum> you might want to
4978 call the B<apply_payments> method or set the I<apply> option.
4980 I<apply> can be set to true to apply a resulting payment.
4982 I<quiet> can be set true to surpress email decline notices.
4984 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4985 resulting paynum, if any.
4987 I<payunique> is a unique identifier for this payment.
4989 I<session_id> is a session identifier associated with this payment.
4991 I<depend_jobnum> allows payment capture to unlock export jobs
4995 sub realtime_collect {
4996 my( $self, %options ) = @_;
4999 warn "$me realtime_collect:\n";
5000 warn " $_ => $options{$_}\n" foreach keys %options;
5003 $options{amount} = $self->balance unless exists( $options{amount} );
5004 $options{method} = FS::payby->payby2bop($self->payby)
5005 unless exists( $options{method} );
5007 return $self->realtime_bop({%options});
5011 =item _realtime_bop { [ ARG => VALUE ... ] }
5013 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
5014 via a Business::OnlinePayment realtime gateway. See
5015 L<http://420.am/business-onlinepayment> for supported gateways.
5017 Required arguments in the hashref are I<method>, and I<amount>
5019 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5021 Available optional arguments are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
5023 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5024 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5025 if set, will override the value from the customer record.
5027 I<description> is a free-text field passed to the gateway. It defaults to
5028 the value defined by the business-onlinepayment-description configuration
5029 option, or "Internet services" if that is unset.
5031 If an I<invnum> is specified, this payment (if successful) is applied to the
5032 specified invoice. If you don't specify an I<invnum> you might want to
5033 call the B<apply_payments> method.
5035 I<quiet> can be set true to surpress email decline notices.
5037 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5038 resulting paynum, if any.
5040 I<payunique> is a unique identifier for this payment.
5042 I<session_id> is a session identifier associated with this payment.
5044 I<depend_jobnum> allows payment capture to unlock export jobs
5046 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
5050 # some helper routines
5051 sub _payment_gateway {
5052 my ($self, $options) = @_;
5054 $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
5055 unless exists($options->{payment_gateway});
5057 $options->{payment_gateway};
5061 my ($self, $options) = @_;
5064 'login' => $options->{payment_gateway}->gateway_username,
5065 'password' => $options->{payment_gateway}->gateway_password,
5070 my ($self, $options) = @_;
5072 $options->{payment_gateway}->gatewaynum
5073 ? $options->{payment_gateway}->options
5074 : @{ $options->{payment_gateway}->get('options') };
5078 my ($self, $options) = @_;
5080 unless ( $options->{'description'} ) {
5081 if ( $conf->exists('business-onlinepayment-description') ) {
5082 my $dtempl = $conf->config('business-onlinepayment-description');
5084 my $agent = $self->agent->agent;
5086 $options->{'description'} = eval qq("$dtempl");
5088 $options->{'description'} = 'Internet services';
5092 $options->{payinfo} = $self->payinfo unless exists( $options->{payinfo} );
5093 $options->{invnum} ||= '';
5094 $options->{payname} = $self->payname unless exists( $options->{payname} );
5098 my ($self, $options) = @_;
5101 $content{address} = exists($options->{'address1'})
5102 ? $options->{'address1'}
5104 my $address2 = exists($options->{'address2'})
5105 ? $options->{'address2'}
5107 $content{address} .= ", ". $address2 if length($address2);
5109 my $payip = exists($options->{'payip'}) ? $options->{'payip'} : $self->payip;
5110 $content{customer_ip} = $payip if length($payip);
5112 $content{invoice_number} = $options->{'invnum'}
5113 if exists($options->{'invnum'}) && length($options->{'invnum'});
5115 $content{email_customer} =
5116 ( $conf->exists('business-onlinepayment-email_customer')
5117 || $conf->exists('business-onlinepayment-email-override') );
5119 $content{payfirst} = $self->getfield('first');
5120 $content{paylast} = $self->getfield('last');
5122 $content{account_name} = "$content{payfirst} $content{paylast}"
5123 if $options->{method} eq 'ECHECK';
5125 $content{name} = $options->{payname};
5126 $content{name} = $content{account_name} if exists($content{account_name});
5128 $content{city} = exists($options->{city})
5131 $content{state} = exists($options->{state})
5134 $content{zip} = exists($options->{zip})
5137 $content{country} = exists($options->{country})
5138 ? $options->{country}
5140 $content{referer} = 'http://cleanwhisker.420.am/'; #XXX fix referer :/
5141 $content{phone} = $self->daytime || $self->night;
5146 my %bop_method2payby = (
5152 sub _new_realtime_bop {
5156 if (ref($_[0]) eq 'HASH') {
5157 %options = %{$_[0]};
5159 my ( $method, $amount ) = ( shift, shift );
5161 $options{method} = $method;
5162 $options{amount} = $amount;
5166 warn "$me realtime_bop (new): $options{method} $options{amount}\n";
5167 warn " $_ => $options{$_}\n" foreach keys %options;
5170 return $self->fake_bop(%options) if $options{'fake'};
5172 $self->_bop_defaults(\%options);
5175 # set trans_is_recur based on invnum if there is one
5178 my $trans_is_recur = 0;
5179 if ( $options{'invnum'} ) {
5181 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
5182 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
5185 map { $_->part_pkg }
5187 map { $_->cust_pkg }
5188 $cust_bill->cust_bill_pkg;
5191 if grep { $_->freq ne '0' } @part_pkg;
5199 my $payment_gateway = $self->_payment_gateway( \%options );
5200 my $namespace = $payment_gateway->gateway_namespace;
5202 eval "use $namespace";
5206 # check for banned credit card/ACH
5209 my $ban = qsearchs('banned_pay', {
5210 'payby' => $bop_method2payby{$options{method}},
5211 'payinfo' => md5_base64($options{payinfo}),
5213 return "Banned credit card" if $ban;
5219 my (%bop_content) = $self->_bop_content(\%options);
5221 if ( $options{method} ne 'ECHECK' ) {
5222 $options{payname} =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5223 or return "Illegal payname $options{payname}";
5224 ($bop_content{payfirst}, $bop_content{paylast}) = ($1, $2);
5227 my @invoicing_list = $self->invoicing_list_emailonly;
5228 if ( $conf->exists('emailinvoiceautoalways')
5229 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5230 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5231 push @invoicing_list, $self->all_emails;
5234 my $email = ($conf->exists('business-onlinepayment-email-override'))
5235 ? $conf->config('business-onlinepayment-email-override')
5236 : $invoicing_list[0];
5240 if ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'CC' ) {
5242 $content{card_number} = $options{payinfo};
5243 $paydate = exists($options{'paydate'})
5244 ? $options{'paydate'}
5246 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
5247 $content{expiration} = "$2/$1";
5249 my $paycvv = exists($options{'paycvv'})
5250 ? $options{'paycvv'}
5252 $content{cvv2} = $paycvv
5255 my $paystart_month = exists($options{'paystart_month'})
5256 ? $options{'paystart_month'}
5257 : $self->paystart_month;
5259 my $paystart_year = exists($options{'paystart_year'})
5260 ? $options{'paystart_year'}
5261 : $self->paystart_year;
5263 $content{card_start} = "$paystart_month/$paystart_year"
5264 if $paystart_month && $paystart_year;
5266 my $payissue = exists($options{'payissue'})
5267 ? $options{'payissue'}
5269 $content{issue_number} = $payissue if $payissue;
5271 if ( $self->_bop_recurring_billing( 'payinfo' => $options{'payinfo'},
5272 'trans_is_recur' => $trans_is_recur,
5276 $content{recurring_billing} = 'YES';
5277 $content{acct_code} = 'rebill'
5278 if $conf->exists('credit_card-recurring_billing_acct_code');
5281 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'ECHECK' ){
5282 ( $content{account_number}, $content{routing_code} ) =
5283 split('@', $options{payinfo});
5284 $content{bank_name} = $options{payname};
5285 $content{bank_state} = exists($options{'paystate'})
5286 ? $options{'paystate'}
5287 : $self->getfield('paystate');
5288 $content{account_type} = exists($options{'paytype'})
5289 ? uc($options{'paytype'}) || 'CHECKING'
5290 : uc($self->getfield('paytype')) || 'CHECKING';
5291 $content{customer_org} = $self->company ? 'B' : 'I';
5292 $content{state_id} = exists($options{'stateid'})
5293 ? $options{'stateid'}
5294 : $self->getfield('stateid');
5295 $content{state_id_state} = exists($options{'stateid_state'})
5296 ? $options{'stateid_state'}
5297 : $self->getfield('stateid_state');
5298 $content{customer_ssn} = exists($options{'ss'})
5301 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'LEC' ) {
5302 $content{phone} = $options{payinfo};
5303 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5310 # run transaction(s)
5313 my $balance = exists( $options{'balance'} )
5314 ? $options{'balance'}
5317 $self->select_for_update; #mutex ... just until we get our pending record in
5319 #the checks here are intended to catch concurrent payments
5320 #double-form-submission prevention is taken care of in cust_pay_pending::check
5323 return "The customer's balance has changed; $options{method} transaction aborted."
5324 if $self->balance < $balance;
5325 #&& $self->balance < $options{amount}; #might as well anyway?
5327 #also check and make sure there aren't *other* pending payments for this cust
5329 my @pending = qsearch('cust_pay_pending', {
5330 'custnum' => $self->custnum,
5331 'status' => { op=>'!=', value=>'done' }
5333 return "A payment is already being processed for this customer (".
5334 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
5335 "); $options{method} transaction aborted."
5336 if scalar(@pending);
5338 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
5340 my $cust_pay_pending = new FS::cust_pay_pending {
5341 'custnum' => $self->custnum,
5342 #'invnum' => $options{'invnum'},
5343 'paid' => $options{amount},
5345 'payby' => $bop_method2payby{$options{method}},
5346 'payinfo' => $options{payinfo},
5347 'paydate' => $paydate,
5348 'recurring_billing' => $content{recurring_billing},
5349 'pkgnum' => $options{'pkgnum'},
5351 'gatewaynum' => $payment_gateway->gatewaynum || '',
5352 'session_id' => $options{session_id} || '',
5353 'jobnum' => $options{depend_jobnum} || '',
5355 $cust_pay_pending->payunique( $options{payunique} )
5356 if defined($options{payunique}) && length($options{payunique});
5357 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
5358 return $cpp_new_err if $cpp_new_err;
5360 my( $action1, $action2 ) =
5361 split( /\s*\,\s*/, $payment_gateway->gateway_action );
5363 my $transaction = new $namespace( $payment_gateway->gateway_module,
5364 $self->_bop_options(\%options),
5367 $transaction->content(
5368 'type' => $options{method},
5369 $self->_bop_auth(\%options),
5370 'action' => $action1,
5371 'description' => $options{'description'},
5372 'amount' => $options{amount},
5373 #'invoice_number' => $options{'invnum'},
5374 'customer_id' => $self->custnum,
5376 'reference' => $cust_pay_pending->paypendingnum, #for now
5381 $cust_pay_pending->status('pending');
5382 my $cpp_pending_err = $cust_pay_pending->replace;
5383 return $cpp_pending_err if $cpp_pending_err;
5386 my $BOP_TESTING = 0;
5387 my $BOP_TESTING_SUCCESS = 1;
5389 unless ( $BOP_TESTING ) {
5390 $transaction->submit();
5392 if ( $BOP_TESTING_SUCCESS ) {
5393 $transaction->is_success(1);
5394 $transaction->authorization('fake auth');
5396 $transaction->is_success(0);
5397 $transaction->error_message('fake failure');
5401 if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5403 return { reference => $cust_pay_pending->paypendingnum,
5404 map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
5406 } elsif ( $transaction->is_success() && $action2 ) {
5408 $cust_pay_pending->status('authorized');
5409 my $cpp_authorized_err = $cust_pay_pending->replace;
5410 return $cpp_authorized_err if $cpp_authorized_err;
5412 my $auth = $transaction->authorization;
5413 my $ordernum = $transaction->can('order_number')
5414 ? $transaction->order_number
5418 new Business::OnlinePayment( $payment_gateway->gateway_module,
5419 $self->_bop_options(\%options),
5424 type => $options{method},
5426 $self->_bop_auth(\%options),
5427 order_number => $ordernum,
5428 amount => $options{amount},
5429 authorization => $auth,
5430 description => $options{'description'},
5433 foreach my $field (qw( authorization_source_code returned_ACI
5434 transaction_identifier validation_code
5435 transaction_sequence_num local_transaction_date
5436 local_transaction_time AVS_result_code )) {
5437 $capture{$field} = $transaction->$field() if $transaction->can($field);
5440 $capture->content( %capture );
5444 unless ( $capture->is_success ) {
5445 my $e = "Authorization successful but capture failed, custnum #".
5446 $self->custnum. ': '. $capture->result_code.
5447 ": ". $capture->error_message;
5455 # remove paycvv after initial transaction
5458 #false laziness w/misc/process/payment.cgi - check both to make sure working
5460 if ( defined $self->dbdef_table->column('paycvv')
5461 && length($self->paycvv)
5462 && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
5464 my $error = $self->remove_cvv;
5466 warn "WARNING: error removing cvv: $error\n";
5474 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5486 if (ref($_[0]) eq 'HASH') {
5487 %options = %{$_[0]};
5489 my ( $method, $amount ) = ( shift, shift );
5491 $options{method} = $method;
5492 $options{amount} = $amount;
5495 if ( $options{'fake_failure'} ) {
5496 return "Error: No error; test failure requested with fake_failure";
5500 #if ( $payment_gateway->gatewaynum ) { # agent override
5501 # $paybatch = $payment_gateway->gatewaynum. '-';
5504 #$paybatch .= "$processor:". $transaction->authorization;
5506 #$paybatch .= ':'. $transaction->order_number
5507 # if $transaction->can('order_number')
5508 # && length($transaction->order_number);
5510 my $paybatch = 'FakeProcessor:54:32';
5512 my $cust_pay = new FS::cust_pay ( {
5513 'custnum' => $self->custnum,
5514 'invnum' => $options{'invnum'},
5515 'paid' => $options{amount},
5517 'payby' => $bop_method2payby{$options{method}},
5518 #'payinfo' => $payinfo,
5519 'payinfo' => '4111111111111111',
5520 'paybatch' => $paybatch,
5521 #'paydate' => $paydate,
5522 'paydate' => '2012-05-01',
5524 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
5526 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5529 $cust_pay->invnum(''); #try again with no specific invnum
5530 my $error2 = $cust_pay->insert( $options{'manual'} ?
5531 ( 'manual' => 1 ) : ()
5534 # gah, even with transactions.
5535 my $e = 'WARNING: Card/ACH debited but database not updated - '.
5536 "error inserting (fake!) payment: $error2".
5537 " (previously tried insert with invnum #$options{'invnum'}" .
5544 if ( $options{'paynum_ref'} ) {
5545 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5548 return ''; #no error
5553 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
5555 # Wraps up processing of a realtime credit card, ACH (electronic check) or
5556 # phone bill transaction.
5558 sub _realtime_bop_result {
5559 my( $self, $cust_pay_pending, $transaction, %options ) = @_;
5561 warn "$me _realtime_bop_result: pending transaction ".
5562 $cust_pay_pending->paypendingnum. "\n";
5563 warn " $_ => $options{$_}\n" foreach keys %options;
5566 my $payment_gateway = $options{payment_gateway}
5567 or return "no payment gateway in arguments to _realtime_bop_result";
5569 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
5570 my $cpp_captured_err = $cust_pay_pending->replace;
5571 return $cpp_captured_err if $cpp_captured_err;
5573 if ( $transaction->is_success() ) {
5576 if ( $payment_gateway->gatewaynum ) { # agent override
5577 $paybatch = $payment_gateway->gatewaynum. '-';
5580 $paybatch .= $payment_gateway->gateway_module. ":".
5581 $transaction->authorization;
5583 $paybatch .= ':'. $transaction->order_number
5584 if $transaction->can('order_number')
5585 && length($transaction->order_number);
5587 my $cust_pay = new FS::cust_pay ( {
5588 'custnum' => $self->custnum,
5589 'invnum' => $options{'invnum'},
5590 'paid' => $cust_pay_pending->paid,
5592 'payby' => $cust_pay_pending->payby,
5593 #'payinfo' => $payinfo,
5594 'paybatch' => $paybatch,
5595 'paydate' => $cust_pay_pending->paydate,
5596 'pkgnum' => $cust_pay_pending->pkgnum,
5598 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
5599 $cust_pay->payunique( $options{payunique} )
5600 if defined($options{payunique}) && length($options{payunique});
5602 my $oldAutoCommit = $FS::UID::AutoCommit;
5603 local $FS::UID::AutoCommit = 0;
5606 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
5608 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5611 $cust_pay->invnum(''); #try again with no specific invnum
5612 my $error2 = $cust_pay->insert( $options{'manual'} ?
5613 ( 'manual' => 1 ) : ()
5616 # gah. but at least we have a record of the state we had to abort in
5617 # from cust_pay_pending now.
5618 my $e = "WARNING: $options{method} captured but payment not recorded -".
5619 " error inserting payment (". $payment_gateway->gateway_module.
5621 " (previously tried insert with invnum #$options{'invnum'}" .
5622 ": $error ) - pending payment saved as paypendingnum ".
5623 $cust_pay_pending->paypendingnum. "\n";
5629 my $jobnum = $cust_pay_pending->jobnum;
5631 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5633 unless ( $placeholder ) {
5634 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5635 my $e = "WARNING: $options{method} captured but job $jobnum not ".
5636 "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
5641 $error = $placeholder->delete;
5644 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5645 my $e = "WARNING: $options{method} captured but could not delete ".
5646 "job $jobnum for paypendingnum ".
5647 $cust_pay_pending->paypendingnum. ": $error\n";
5654 if ( $options{'paynum_ref'} ) {
5655 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5658 $cust_pay_pending->status('done');
5659 $cust_pay_pending->statustext('captured');
5660 $cust_pay_pending->paynum($cust_pay->paynum);
5661 my $cpp_done_err = $cust_pay_pending->replace;
5663 if ( $cpp_done_err ) {
5665 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5666 my $e = "WARNING: $options{method} captured but payment not recorded - ".
5667 "error updating status for paypendingnum ".
5668 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5674 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5676 if ( $options{'apply'} ) {
5677 my $apply_error = $self->apply_payments_and_credits;
5678 if ( $apply_error ) {
5679 warn "WARNING: error applying payment: $apply_error\n";
5680 #but we still should return no error cause the payment otherwise went
5685 return ''; #no error
5691 my $perror = $payment_gateway->gateway_module. " error: ".
5692 $transaction->error_message;
5694 my $jobnum = $cust_pay_pending->jobnum;
5696 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5698 if ( $placeholder ) {
5699 my $error = $placeholder->depended_delete;
5700 $error ||= $placeholder->delete;
5701 warn "error removing provisioning jobs after declined paypendingnum ".
5702 $cust_pay_pending->paypendingnum. "\n";
5704 my $e = "error finding job $jobnum for declined paypendingnum ".
5705 $cust_pay_pending->paypendingnum. "\n";
5711 unless ( $transaction->error_message ) {
5714 if ( $transaction->can('response_page') ) {
5716 'page' => ( $transaction->can('response_page')
5717 ? $transaction->response_page
5720 'code' => ( $transaction->can('response_code')
5721 ? $transaction->response_code
5724 'headers' => ( $transaction->can('response_headers')
5725 ? $transaction->response_headers
5731 "No additional debugging information available for ".
5732 $payment_gateway->gateway_module;
5735 $perror .= "No error_message returned from ".
5736 $payment_gateway->gateway_module. " -- ".
5737 ( ref($t_response) ? Dumper($t_response) : $t_response );
5741 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
5742 && $conf->exists('emaildecline')
5743 && grep { $_ ne 'POST' } $self->invoicing_list
5744 && ! grep { $transaction->error_message =~ /$_/ }
5745 $conf->config('emaildecline-exclude')
5747 my @templ = $conf->config('declinetemplate');
5748 my $template = new Text::Template (
5750 SOURCE => [ map "$_\n", @templ ],
5751 ) or return "($perror) can't create template: $Text::Template::ERROR";
5752 $template->compile()
5753 or return "($perror) can't compile template: $Text::Template::ERROR";
5757 scalar( $conf->config('company_name', $self->agentnum ) ),
5758 'company_address' =>
5759 join("\n", $conf->config('company_address', $self->agentnum ) ),
5760 'error' => $transaction->error_message,
5763 my $error = send_email(
5764 'from' => $conf->config('invoice_from', $self->agentnum ),
5765 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
5766 'subject' => 'Your payment could not be processed',
5767 'body' => [ $template->fill_in(HASH => $templ_hash) ],
5770 $perror .= " (also received error sending decline notification: $error)"
5775 $cust_pay_pending->status('done');
5776 $cust_pay_pending->statustext("declined: $perror");
5777 my $cpp_done_err = $cust_pay_pending->replace;
5778 if ( $cpp_done_err ) {
5779 my $e = "WARNING: $options{method} declined but pending payment not ".
5780 "resolved - error updating status for paypendingnum ".
5781 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5783 $perror = "$e ($perror)";
5791 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
5793 Verifies successful third party processing of a realtime credit card,
5794 ACH (electronic check) or phone bill transaction via a
5795 Business::OnlineThirdPartyPayment realtime gateway. See
5796 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5798 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
5800 The additional options I<payname>, I<city>, I<state>,
5801 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5802 if set, will override the value from the customer record.
5804 I<description> is a free-text field passed to the gateway. It defaults to
5805 "Internet services".
5807 If an I<invnum> is specified, this payment (if successful) is applied to the
5808 specified invoice. If you don't specify an I<invnum> you might want to
5809 call the B<apply_payments> method.
5811 I<quiet> can be set true to surpress email decline notices.
5813 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5814 resulting paynum, if any.
5816 I<payunique> is a unique identifier for this payment.
5818 Returns a hashref containing elements bill_error (which will be undefined
5819 upon success) and session_id of any associated session.
5823 sub realtime_botpp_capture {
5824 my( $self, $cust_pay_pending, %options ) = @_;
5826 warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
5827 warn " $_ => $options{$_}\n" foreach keys %options;
5830 eval "use Business::OnlineThirdPartyPayment";
5834 # select the gateway
5837 my $method = FS::payby->payby2bop($cust_pay_pending->payby);
5839 my $payment_gateway = $cust_pay_pending->gatewaynum
5840 ? qsearchs( 'payment_gateway',
5841 { gatewaynum => $cust_pay_pending->gatewaynum }
5843 : $self->agent->payment_gateway( 'method' => $method,
5844 # 'invnum' => $cust_pay_pending->invnum,
5845 # 'payinfo' => $cust_pay_pending->payinfo,
5848 $options{payment_gateway} = $payment_gateway; # for the helper subs
5854 my @invoicing_list = $self->invoicing_list_emailonly;
5855 if ( $conf->exists('emailinvoiceautoalways')
5856 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5857 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5858 push @invoicing_list, $self->all_emails;
5861 my $email = ($conf->exists('business-onlinepayment-email-override'))
5862 ? $conf->config('business-onlinepayment-email-override')
5863 : $invoicing_list[0];
5867 $content{email_customer} =
5868 ( $conf->exists('business-onlinepayment-email_customer')
5869 || $conf->exists('business-onlinepayment-email-override') );
5872 # run transaction(s)
5876 new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
5877 $self->_bop_options(\%options),
5880 $transaction->reference({ %options });
5882 $transaction->content(
5884 $self->_bop_auth(\%options),
5885 'action' => 'Post Authorization',
5886 'description' => $options{'description'},
5887 'amount' => $cust_pay_pending->paid,
5888 #'invoice_number' => $options{'invnum'},
5889 'customer_id' => $self->custnum,
5890 'referer' => 'http://cleanwhisker.420.am/',
5891 'reference' => $cust_pay_pending->paypendingnum,
5893 'phone' => $self->daytime || $self->night,
5895 # plus whatever is required for bogus capture avoidance
5898 $transaction->submit();
5901 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5904 bill_error => $error,
5905 session_id => $cust_pay_pending->session_id,
5910 =item default_payment_gateway DEPRECATED -- use agent->payment_gateway
5914 sub default_payment_gateway {
5915 my( $self, $method ) = @_;
5917 die "Real-time processing not enabled\n"
5918 unless $conf->exists('business-onlinepayment');
5920 #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
5923 my $bop_config = 'business-onlinepayment';
5924 $bop_config .= '-ach'
5925 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
5926 my ( $processor, $login, $password, $action, @bop_options ) =
5927 $conf->config($bop_config);
5928 $action ||= 'normal authorization';
5929 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
5930 die "No real-time processor is enabled - ".
5931 "did you set the business-onlinepayment configuration value?\n"
5934 ( $processor, $login, $password, $action, @bop_options )
5939 Removes the I<paycvv> field from the database directly.
5941 If there is an error, returns the error, otherwise returns false.
5947 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
5948 or return dbh->errstr;
5949 $sth->execute($self->custnum)
5950 or return $sth->errstr;
5955 =item _new_realtime_refund_bop METHOD [ OPTION => VALUE ... ]
5957 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
5958 via a Business::OnlinePayment realtime gateway. See
5959 L<http://420.am/business-onlinepayment> for supported gateways.
5961 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5963 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
5965 Most gateways require a reference to an original payment transaction to refund,
5966 so you probably need to specify a I<paynum>.
5968 I<amount> defaults to the original amount of the payment if not specified.
5970 I<reason> specifies a reason for the refund.
5972 I<paydate> specifies the expiration date for a credit card overriding the
5973 value from the customer record or the payment record. Specified as yyyy-mm-dd
5975 Implementation note: If I<amount> is unspecified or equal to the amount of the
5976 orignal payment, first an attempt is made to "void" the transaction via
5977 the gateway (to cancel a not-yet settled transaction) and then if that fails,
5978 the normal attempt is made to "refund" ("credit") the transaction via the
5979 gateway is attempted.
5981 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5982 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5983 #if set, will override the value from the customer record.
5985 #If an I<invnum> is specified, this payment (if successful) is applied to the
5986 #specified invoice. If you don't specify an I<invnum> you might want to
5987 #call the B<apply_payments> method.
5991 #some false laziness w/realtime_bop, not enough to make it worth merging
5992 #but some useful small subs should be pulled out
5993 sub _new_realtime_refund_bop {
5997 if (ref($_[0]) ne 'HASH') {
5998 %options = %{$_[0]};
6002 $options{method} = $method;
6006 warn "$me realtime_refund_bop (new): $options{method} refund\n";
6007 warn " $_ => $options{$_}\n" foreach keys %options;
6011 # look up the original payment and optionally a gateway for that payment
6015 my $amount = $options{'amount'};
6017 my( $processor, $login, $password, @bop_options, $namespace ) ;
6018 my( $auth, $order_number ) = ( '', '', '' );
6020 if ( $options{'paynum'} ) {
6022 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
6023 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
6024 or return "Unknown paynum $options{'paynum'}";
6025 $amount ||= $cust_pay->paid;
6027 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
6028 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
6029 $cust_pay->paybatch;
6030 my $gatewaynum = '';
6031 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
6033 if ( $gatewaynum ) { #gateway for the payment to be refunded
6035 my $payment_gateway =
6036 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
6037 die "payment gateway $gatewaynum not found"
6038 unless $payment_gateway;
6040 $processor = $payment_gateway->gateway_module;
6041 $login = $payment_gateway->gateway_username;
6042 $password = $payment_gateway->gateway_password;
6043 $namespace = $payment_gateway->gateway_namespace;
6044 @bop_options = $payment_gateway->options;
6046 } else { #try the default gateway
6049 my $payment_gateway =
6050 $self->agent->payment_gateway('method' => $options{method});
6052 ( $conf_processor, $login, $password, $namespace ) =
6053 map { my $method = "gateway_$_"; $payment_gateway->$method }
6054 qw( module username password namespace );
6056 @bop_options = $payment_gateway->gatewaynum
6057 ? $payment_gateway->options
6058 : @{ $payment_gateway->get('options') };
6060 return "processor of payment $options{'paynum'} $processor does not".
6061 " match default processor $conf_processor"
6062 unless $processor eq $conf_processor;
6067 } else { # didn't specify a paynum, so look for agent gateway overrides
6068 # like a normal transaction
6070 my $payment_gateway =
6071 $self->agent->payment_gateway( 'method' => $options{method},
6072 #'payinfo' => $payinfo,
6074 my( $processor, $login, $password, $namespace ) =
6075 map { my $method = "gateway_$_"; $payment_gateway->$method }
6076 qw( module username password namespace );
6078 my @bop_options = $payment_gateway->gatewaynum
6079 ? $payment_gateway->options
6080 : @{ $payment_gateway->get('options') };
6083 return "neither amount nor paynum specified" unless $amount;
6085 eval "use $namespace";
6089 'type' => $options{method},
6091 'password' => $password,
6092 'order_number' => $order_number,
6093 'amount' => $amount,
6094 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
6096 $content{authorization} = $auth
6097 if length($auth); #echeck/ACH transactions have an order # but no auth
6098 #(at least with authorize.net)
6100 my $disable_void_after;
6101 if ($conf->exists('disable_void_after')
6102 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
6103 $disable_void_after = $1;
6106 #first try void if applicable
6107 if ( $cust_pay && $cust_pay->paid == $amount
6109 ( not defined($disable_void_after) )
6110 || ( time < ($cust_pay->_date + $disable_void_after ) )
6113 warn " attempting void\n" if $DEBUG > 1;
6114 my $void = new Business::OnlinePayment( $processor, @bop_options );
6115 $void->content( 'action' => 'void', %content );
6117 if ( $void->is_success ) {
6118 my $error = $cust_pay->void($options{'reason'});
6120 # gah, even with transactions.
6121 my $e = 'WARNING: Card/ACH voided but database not updated - '.
6122 "error voiding payment: $error";
6126 warn " void successful\n" if $DEBUG > 1;
6131 warn " void unsuccessful, trying refund\n"
6135 my $address = $self->address1;
6136 $address .= ", ". $self->address2 if $self->address2;
6138 my($payname, $payfirst, $paylast);
6139 if ( $self->payname && $options{method} ne 'ECHECK' ) {
6140 $payname = $self->payname;
6141 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
6142 or return "Illegal payname $payname";
6143 ($payfirst, $paylast) = ($1, $2);
6145 $payfirst = $self->getfield('first');
6146 $paylast = $self->getfield('last');
6147 $payname = "$payfirst $paylast";
6150 my @invoicing_list = $self->invoicing_list_emailonly;
6151 if ( $conf->exists('emailinvoiceautoalways')
6152 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
6153 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
6154 push @invoicing_list, $self->all_emails;
6157 my $email = ($conf->exists('business-onlinepayment-email-override'))
6158 ? $conf->config('business-onlinepayment-email-override')
6159 : $invoicing_list[0];
6161 my $payip = exists($options{'payip'})
6164 $content{customer_ip} = $payip
6168 if ( $options{method} eq 'CC' ) {
6171 $content{card_number} = $payinfo = $cust_pay->payinfo;
6172 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
6173 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
6174 ($content{expiration} = "$2/$1"); # where available
6176 $content{card_number} = $payinfo = $self->payinfo;
6177 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
6178 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
6179 $content{expiration} = "$2/$1";
6182 } elsif ( $options{method} eq 'ECHECK' ) {
6185 $payinfo = $cust_pay->payinfo;
6187 $payinfo = $self->payinfo;
6189 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
6190 $content{bank_name} = $self->payname;
6191 $content{account_type} = 'CHECKING';
6192 $content{account_name} = $payname;
6193 $content{customer_org} = $self->company ? 'B' : 'I';
6194 $content{customer_ssn} = $self->ss;
6195 } elsif ( $options{method} eq 'LEC' ) {
6196 $content{phone} = $payinfo = $self->payinfo;
6200 my $refund = new Business::OnlinePayment( $processor, @bop_options );
6201 my %sub_content = $refund->content(
6202 'action' => 'credit',
6203 'customer_id' => $self->custnum,
6204 'last_name' => $paylast,
6205 'first_name' => $payfirst,
6207 'address' => $address,
6208 'city' => $self->city,
6209 'state' => $self->state,
6210 'zip' => $self->zip,
6211 'country' => $self->country,
6213 'phone' => $self->daytime || $self->night,
6216 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
6220 return "$processor error: ". $refund->error_message
6221 unless $refund->is_success();
6223 my $paybatch = "$processor:". $refund->authorization;
6224 $paybatch .= ':'. $refund->order_number
6225 if $refund->can('order_number') && $refund->order_number;
6227 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
6228 my @cust_bill_pay = $cust_pay->cust_bill_pay;
6229 last unless @cust_bill_pay;
6230 my $cust_bill_pay = pop @cust_bill_pay;
6231 my $error = $cust_bill_pay->delete;
6235 my $cust_refund = new FS::cust_refund ( {
6236 'custnum' => $self->custnum,
6237 'paynum' => $options{'paynum'},
6238 'refund' => $amount,
6240 'payby' => $bop_method2payby{$options{method}},
6241 'payinfo' => $payinfo,
6242 'paybatch' => $paybatch,
6243 'reason' => $options{'reason'} || 'card or ACH refund',
6245 my $error = $cust_refund->insert;
6247 $cust_refund->paynum(''); #try again with no specific paynum
6248 my $error2 = $cust_refund->insert;
6250 # gah, even with transactions.
6251 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
6252 "error inserting refund ($processor): $error2".
6253 " (previously tried insert with paynum #$options{'paynum'}" .
6264 =item batch_card OPTION => VALUE...
6266 Adds a payment for this invoice to the pending credit card batch (see
6267 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
6268 runs the payment using a realtime gateway.
6273 my ($self, %options) = @_;
6276 if (exists($options{amount})) {
6277 $amount = $options{amount};
6279 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
6281 return '' unless $amount > 0;
6283 my $invnum = delete $options{invnum};
6284 my $payby = $options{invnum} || $self->payby; #dubious
6286 if ($options{'realtime'}) {
6287 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
6293 my $oldAutoCommit = $FS::UID::AutoCommit;
6294 local $FS::UID::AutoCommit = 0;
6297 #this needs to handle mysql as well as Pg, like svc_acct.pm
6298 #(make it into a common function if folks need to do batching with mysql)
6299 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
6300 or return "Cannot lock pay_batch: " . $dbh->errstr;
6304 'payby' => FS::payby->payby2payment($payby),
6307 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
6309 unless ( $pay_batch ) {
6310 $pay_batch = new FS::pay_batch \%pay_batch;
6311 my $error = $pay_batch->insert;
6313 $dbh->rollback if $oldAutoCommit;
6314 die "error creating new batch: $error\n";
6318 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
6319 'batchnum' => $pay_batch->batchnum,
6320 'custnum' => $self->custnum,
6323 foreach (qw( address1 address2 city state zip country payby payinfo paydate
6325 $options{$_} = '' unless exists($options{$_});
6328 my $cust_pay_batch = new FS::cust_pay_batch ( {
6329 'batchnum' => $pay_batch->batchnum,
6330 'invnum' => $invnum || 0, # is there a better value?
6331 # this field should be
6333 # cust_bill_pay_batch now
6334 'custnum' => $self->custnum,
6335 'last' => $self->getfield('last'),
6336 'first' => $self->getfield('first'),
6337 'address1' => $options{address1} || $self->address1,
6338 'address2' => $options{address2} || $self->address2,
6339 'city' => $options{city} || $self->city,
6340 'state' => $options{state} || $self->state,
6341 'zip' => $options{zip} || $self->zip,
6342 'country' => $options{country} || $self->country,
6343 'payby' => $options{payby} || $self->payby,
6344 'payinfo' => $options{payinfo} || $self->payinfo,
6345 'exp' => $options{paydate} || $self->paydate,
6346 'payname' => $options{payname} || $self->payname,
6347 'amount' => $amount, # consolidating
6350 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
6351 if $old_cust_pay_batch;
6354 if ($old_cust_pay_batch) {
6355 $error = $cust_pay_batch->replace($old_cust_pay_batch)
6357 $error = $cust_pay_batch->insert;
6361 $dbh->rollback if $oldAutoCommit;
6365 my $unapplied = $self->total_unapplied_credits
6366 + $self->total_unapplied_payments
6367 + $self->in_transit_payments;
6368 foreach my $cust_bill ($self->open_cust_bill) {
6369 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
6370 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
6371 'invnum' => $cust_bill->invnum,
6372 'paybatchnum' => $cust_pay_batch->paybatchnum,
6373 'amount' => $cust_bill->owed,
6376 if ($unapplied >= $cust_bill_pay_batch->amount){
6377 $unapplied -= $cust_bill_pay_batch->amount;
6380 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
6381 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
6383 $error = $cust_bill_pay_batch->insert;
6385 $dbh->rollback if $oldAutoCommit;
6390 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6394 =item apply_payments_and_credits [ OPTION => VALUE ... ]
6396 Applies unapplied payments and credits.
6398 In most cases, this new method should be used in place of sequential
6399 apply_payments and apply_credits methods.
6401 A hash of optional arguments may be passed. Currently "manual" is supported.
6402 If true, a payment receipt is sent instead of a statement when
6403 'payment_receipt_email' configuration option is set.
6405 If there is an error, returns the error, otherwise returns false.
6409 sub apply_payments_and_credits {
6410 my( $self, %options ) = @_;
6412 local $SIG{HUP} = 'IGNORE';
6413 local $SIG{INT} = 'IGNORE';
6414 local $SIG{QUIT} = 'IGNORE';
6415 local $SIG{TERM} = 'IGNORE';
6416 local $SIG{TSTP} = 'IGNORE';
6417 local $SIG{PIPE} = 'IGNORE';
6419 my $oldAutoCommit = $FS::UID::AutoCommit;
6420 local $FS::UID::AutoCommit = 0;
6423 $self->select_for_update; #mutex
6425 foreach my $cust_bill ( $self->open_cust_bill ) {
6426 my $error = $cust_bill->apply_payments_and_credits(%options);
6428 $dbh->rollback if $oldAutoCommit;
6429 return "Error applying: $error";
6433 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6438 =item apply_credits OPTION => VALUE ...
6440 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
6441 to outstanding invoice balances in chronological order (or reverse
6442 chronological order if the I<order> option is set to B<newest>) and returns the
6443 value of any remaining unapplied credits available for refund (see
6444 L<FS::cust_refund>).
6446 Dies if there is an error.
6454 local $SIG{HUP} = 'IGNORE';
6455 local $SIG{INT} = 'IGNORE';
6456 local $SIG{QUIT} = 'IGNORE';
6457 local $SIG{TERM} = 'IGNORE';
6458 local $SIG{TSTP} = 'IGNORE';
6459 local $SIG{PIPE} = 'IGNORE';
6461 my $oldAutoCommit = $FS::UID::AutoCommit;
6462 local $FS::UID::AutoCommit = 0;
6465 $self->select_for_update; #mutex
6467 unless ( $self->total_unapplied_credits ) {
6468 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6472 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
6473 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
6475 my @invoices = $self->open_cust_bill;
6476 @invoices = sort { $b->_date <=> $a->_date } @invoices
6477 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
6479 if ( $conf->exists('pkg-balances') ) {
6480 # limit @credits to those w/ a pkgnum grepped from $self
6482 foreach my $i (@invoices) {
6483 foreach my $li ( $i->cust_bill_pkg ) {
6484 $pkgnums{$li->pkgnum} = 1;
6487 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
6492 foreach my $cust_bill ( @invoices ) {
6494 if ( !defined($credit) || $credit->credited == 0) {
6495 $credit = pop @credits or last;
6499 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
6500 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
6502 $owed = $cust_bill->owed;
6504 unless ( $owed > 0 ) {
6505 push @credits, $credit;
6509 my $amount = min( $credit->credited, $owed );
6511 my $cust_credit_bill = new FS::cust_credit_bill ( {
6512 'crednum' => $credit->crednum,
6513 'invnum' => $cust_bill->invnum,
6514 'amount' => $amount,
6516 $cust_credit_bill->pkgnum( $credit->pkgnum )
6517 if $conf->exists('pkg-balances') && $credit->pkgnum;
6518 my $error = $cust_credit_bill->insert;
6520 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6524 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6528 my $total_unapplied_credits = $self->total_unapplied_credits;
6530 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6532 return $total_unapplied_credits;
6535 =item apply_payments [ OPTION => VALUE ... ]
6537 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
6538 to outstanding invoice balances in chronological order.
6540 #and returns the value of any remaining unapplied payments.
6542 A hash of optional arguments may be passed. Currently "manual" is supported.
6543 If true, a payment receipt is sent instead of a statement when
6544 'payment_receipt_email' configuration option is set.
6546 Dies if there is an error.
6550 sub apply_payments {
6551 my( $self, %options ) = @_;
6553 local $SIG{HUP} = 'IGNORE';
6554 local $SIG{INT} = 'IGNORE';
6555 local $SIG{QUIT} = 'IGNORE';
6556 local $SIG{TERM} = 'IGNORE';
6557 local $SIG{TSTP} = 'IGNORE';
6558 local $SIG{PIPE} = 'IGNORE';
6560 my $oldAutoCommit = $FS::UID::AutoCommit;
6561 local $FS::UID::AutoCommit = 0;
6564 $self->select_for_update; #mutex
6568 my @payments = sort { $b->_date <=> $a->_date }
6569 grep { $_->unapplied > 0 }
6572 my @invoices = sort { $a->_date <=> $b->_date}
6573 grep { $_->owed > 0 }
6576 if ( $conf->exists('pkg-balances') ) {
6577 # limit @payments to those w/ a pkgnum grepped from $self
6579 foreach my $i (@invoices) {
6580 foreach my $li ( $i->cust_bill_pkg ) {
6581 $pkgnums{$li->pkgnum} = 1;
6584 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
6589 foreach my $cust_bill ( @invoices ) {
6591 if ( !defined($payment) || $payment->unapplied == 0 ) {
6592 $payment = pop @payments or last;
6596 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
6597 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
6599 $owed = $cust_bill->owed;
6601 unless ( $owed > 0 ) {
6602 push @payments, $payment;
6606 my $amount = min( $payment->unapplied, $owed );
6608 my $cust_bill_pay = new FS::cust_bill_pay ( {
6609 'paynum' => $payment->paynum,
6610 'invnum' => $cust_bill->invnum,
6611 'amount' => $amount,
6613 $cust_bill_pay->pkgnum( $payment->pkgnum )
6614 if $conf->exists('pkg-balances') && $payment->pkgnum;
6615 my $error = $cust_bill_pay->insert(%options);
6617 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6621 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6625 my $total_unapplied_payments = $self->total_unapplied_payments;
6627 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6629 return $total_unapplied_payments;
6634 Returns the total owed for this customer on all invoices
6635 (see L<FS::cust_bill/owed>).
6641 $self->total_owed_date(2145859200); #12/31/2037
6644 =item total_owed_date TIME
6646 Returns the total owed for this customer on all invoices with date earlier than
6647 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6648 see L<Time::Local> and L<Date::Parse> for conversion functions.
6652 sub total_owed_date {
6656 # my $custnum = $self->custnum;
6658 # my $owed_sql = FS::cust_bill->owed_sql;
6661 # SELECT SUM($owed_sql) FROM cust_bill
6662 # WHERE custnum = $custnum
6663 # AND _date <= $time
6666 # my $sth = dbh->prepare($sql) or die dbh->errstr;
6667 # $sth->execute() or die $sth->errstr;
6669 # return sprintf( '%.2f', $sth->fetchrow_arrayref->[0] );
6672 foreach my $cust_bill (
6673 grep { $_->_date <= $time }
6674 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6676 $total_bill += $cust_bill->owed;
6678 sprintf( "%.2f", $total_bill );
6682 =item total_owed_pkgnum PKGNUM
6684 Returns the total owed on all invoices for this customer's specific package
6685 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
6689 sub total_owed_pkgnum {
6690 my( $self, $pkgnum ) = @_;
6691 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
6694 =item total_owed_date_pkgnum TIME PKGNUM
6696 Returns the total owed for this customer's specific package when using
6697 experimental package balances on all invoices with date earlier than
6698 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6699 see L<Time::Local> and L<Date::Parse> for conversion functions.
6703 sub total_owed_date_pkgnum {
6704 my( $self, $time, $pkgnum ) = @_;
6707 foreach my $cust_bill (
6708 grep { $_->_date <= $time }
6709 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6711 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
6713 sprintf( "%.2f", $total_bill );
6719 Returns the total amount of all payments.
6726 $total += $_->paid foreach $self->cust_pay;
6727 sprintf( "%.2f", $total );
6730 =item total_unapplied_credits
6732 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6733 customer. See L<FS::cust_credit/credited>.
6735 =item total_credited
6737 Old name for total_unapplied_credits. Don't use.
6741 sub total_credited {
6742 #carp "total_credited deprecated, use total_unapplied_credits";
6743 shift->total_unapplied_credits(@_);
6746 sub total_unapplied_credits {
6748 my $total_credit = 0;
6749 $total_credit += $_->credited foreach $self->cust_credit;
6750 sprintf( "%.2f", $total_credit );
6753 =item total_unapplied_credits_pkgnum PKGNUM
6755 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6756 customer. See L<FS::cust_credit/credited>.
6760 sub total_unapplied_credits_pkgnum {
6761 my( $self, $pkgnum ) = @_;
6762 my $total_credit = 0;
6763 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
6764 sprintf( "%.2f", $total_credit );
6768 =item total_unapplied_payments
6770 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
6771 See L<FS::cust_pay/unapplied>.
6775 sub total_unapplied_payments {
6777 my $total_unapplied = 0;
6778 $total_unapplied += $_->unapplied foreach $self->cust_pay;
6779 sprintf( "%.2f", $total_unapplied );
6782 =item total_unapplied_payments_pkgnum PKGNUM
6784 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
6785 specific package when using experimental package balances. See
6786 L<FS::cust_pay/unapplied>.
6790 sub total_unapplied_payments_pkgnum {
6791 my( $self, $pkgnum ) = @_;
6792 my $total_unapplied = 0;
6793 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
6794 sprintf( "%.2f", $total_unapplied );
6798 =item total_unapplied_refunds
6800 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
6801 customer. See L<FS::cust_refund/unapplied>.
6805 sub total_unapplied_refunds {
6807 my $total_unapplied = 0;
6808 $total_unapplied += $_->unapplied foreach $self->cust_refund;
6809 sprintf( "%.2f", $total_unapplied );
6814 Returns the balance for this customer (total_owed plus total_unrefunded, minus
6815 total_unapplied_credits minus total_unapplied_payments).
6823 + $self->total_unapplied_refunds
6824 - $self->total_unapplied_credits
6825 - $self->total_unapplied_payments
6829 =item balance_date TIME
6831 Returns the balance for this customer, only considering invoices with date
6832 earlier than TIME (total_owed_date minus total_credited minus
6833 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
6834 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
6843 $self->total_owed_date($time)
6844 + $self->total_unapplied_refunds
6845 - $self->total_unapplied_credits
6846 - $self->total_unapplied_payments
6850 =item balance_pkgnum PKGNUM
6852 Returns the balance for this customer's specific package when using
6853 experimental package balances (total_owed plus total_unrefunded, minus
6854 total_unapplied_credits minus total_unapplied_payments)
6858 sub balance_pkgnum {
6859 my( $self, $pkgnum ) = @_;
6862 $self->total_owed_pkgnum($pkgnum)
6863 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
6864 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
6865 - $self->total_unapplied_credits_pkgnum($pkgnum)
6866 - $self->total_unapplied_payments_pkgnum($pkgnum)
6870 =item in_transit_payments
6872 Returns the total of requests for payments for this customer pending in
6873 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
6877 sub in_transit_payments {
6879 my $in_transit_payments = 0;
6880 foreach my $pay_batch ( qsearch('pay_batch', {
6883 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
6884 'batchnum' => $pay_batch->batchnum,
6885 'custnum' => $self->custnum,
6887 $in_transit_payments += $cust_pay_batch->amount;
6890 sprintf( "%.2f", $in_transit_payments );
6895 Returns a hash of useful information for making a payment.
6905 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
6906 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
6907 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
6911 For credit card transactions:
6923 For electronic check transactions:
6938 $return{balance} = $self->balance;
6940 $return{payname} = $self->payname
6941 || ( $self->first. ' '. $self->get('last') );
6943 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
6945 $return{payby} = $self->payby;
6946 $return{stateid_state} = $self->stateid_state;
6948 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
6949 $return{card_type} = cardtype($self->payinfo);
6950 $return{payinfo} = $self->paymask;
6952 @return{'month', 'year'} = $self->paydate_monthyear;
6956 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
6957 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
6958 $return{payinfo1} = $payinfo1;
6959 $return{payinfo2} = $payinfo2;
6960 $return{paytype} = $self->paytype;
6961 $return{paystate} = $self->paystate;
6965 #doubleclick protection
6967 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
6973 =item paydate_monthyear
6975 Returns a two-element list consisting of the month and year of this customer's
6976 paydate (credit card expiration date for CARD customers)
6980 sub paydate_monthyear {
6982 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
6984 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
6991 =item tax_exemption TAXNAME
6996 my( $self, $taxname ) = @_;
6998 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
6999 'taxname' => $taxname,
7004 =item cust_main_exemption
7008 sub cust_main_exemption {
7010 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
7013 =item invoicing_list [ ARRAYREF ]
7015 If an arguement is given, sets these email addresses as invoice recipients
7016 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
7017 (except as warnings), so use check_invoicing_list first.
7019 Returns a list of email addresses (with svcnum entries expanded).
7021 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
7022 check it without disturbing anything by passing nothing.
7024 This interface may change in the future.
7028 sub invoicing_list {
7029 my( $self, $arrayref ) = @_;
7032 my @cust_main_invoice;
7033 if ( $self->custnum ) {
7034 @cust_main_invoice =
7035 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7037 @cust_main_invoice = ();
7039 foreach my $cust_main_invoice ( @cust_main_invoice ) {
7040 #warn $cust_main_invoice->destnum;
7041 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
7042 #warn $cust_main_invoice->destnum;
7043 my $error = $cust_main_invoice->delete;
7044 warn $error if $error;
7047 if ( $self->custnum ) {
7048 @cust_main_invoice =
7049 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7051 @cust_main_invoice = ();
7053 my %seen = map { $_->address => 1 } @cust_main_invoice;
7054 foreach my $address ( @{$arrayref} ) {
7055 next if exists $seen{$address} && $seen{$address};
7056 $seen{$address} = 1;
7057 my $cust_main_invoice = new FS::cust_main_invoice ( {
7058 'custnum' => $self->custnum,
7061 my $error = $cust_main_invoice->insert;
7062 warn $error if $error;
7066 if ( $self->custnum ) {
7068 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7075 =item check_invoicing_list ARRAYREF
7077 Checks these arguements as valid input for the invoicing_list method. If there
7078 is an error, returns the error, otherwise returns false.
7082 sub check_invoicing_list {
7083 my( $self, $arrayref ) = @_;
7085 foreach my $address ( @$arrayref ) {
7087 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
7088 return 'Can\'t add FAX invoice destination with a blank FAX number.';
7091 my $cust_main_invoice = new FS::cust_main_invoice ( {
7092 'custnum' => $self->custnum,
7095 my $error = $self->custnum
7096 ? $cust_main_invoice->check
7097 : $cust_main_invoice->checkdest
7099 return $error if $error;
7103 return "Email address required"
7104 if $conf->exists('cust_main-require_invoicing_list_email')
7105 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
7110 =item set_default_invoicing_list
7112 Sets the invoicing list to all accounts associated with this customer,
7113 overwriting any previous invoicing list.
7117 sub set_default_invoicing_list {
7119 $self->invoicing_list($self->all_emails);
7124 Returns the email addresses of all accounts provisioned for this customer.
7131 foreach my $cust_pkg ( $self->all_pkgs ) {
7132 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
7134 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
7135 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
7137 $list{$_}=1 foreach map { $_->email } @svc_acct;
7142 =item invoicing_list_addpost
7144 Adds postal invoicing to this customer. If this customer is already configured
7145 to receive postal invoices, does nothing.
7149 sub invoicing_list_addpost {
7151 return if grep { $_ eq 'POST' } $self->invoicing_list;
7152 my @invoicing_list = $self->invoicing_list;
7153 push @invoicing_list, 'POST';
7154 $self->invoicing_list(\@invoicing_list);
7157 =item invoicing_list_emailonly
7159 Returns the list of email invoice recipients (invoicing_list without non-email
7160 destinations such as POST and FAX).
7164 sub invoicing_list_emailonly {
7166 warn "$me invoicing_list_emailonly called"
7168 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
7171 =item invoicing_list_emailonly_scalar
7173 Returns the list of email invoice recipients (invoicing_list without non-email
7174 destinations such as POST and FAX) as a comma-separated scalar.
7178 sub invoicing_list_emailonly_scalar {
7180 warn "$me invoicing_list_emailonly_scalar called"
7182 join(', ', $self->invoicing_list_emailonly);
7185 =item referral_custnum_cust_main
7187 Returns the customer who referred this customer (or the empty string, if
7188 this customer was not referred).
7190 Note the difference with referral_cust_main method: This method,
7191 referral_custnum_cust_main returns the single customer (if any) who referred
7192 this customer, while referral_cust_main returns an array of customers referred
7197 sub referral_custnum_cust_main {
7199 return '' unless $self->referral_custnum;
7200 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7203 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
7205 Returns an array of customers referred by this customer (referral_custnum set
7206 to this custnum). If DEPTH is given, recurses up to the given depth, returning
7207 customers referred by customers referred by this customer and so on, inclusive.
7208 The default behavior is DEPTH 1 (no recursion).
7210 Note the difference with referral_custnum_cust_main method: This method,
7211 referral_cust_main, returns an array of customers referred BY this customer,
7212 while referral_custnum_cust_main returns the single customer (if any) who
7213 referred this customer.
7217 sub referral_cust_main {
7219 my $depth = @_ ? shift : 1;
7220 my $exclude = @_ ? shift : {};
7223 map { $exclude->{$_->custnum}++; $_; }
7224 grep { ! $exclude->{ $_->custnum } }
7225 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
7229 map { $_->referral_cust_main($depth-1, $exclude) }
7236 =item referral_cust_main_ncancelled
7238 Same as referral_cust_main, except only returns customers with uncancelled
7243 sub referral_cust_main_ncancelled {
7245 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
7248 =item referral_cust_pkg [ DEPTH ]
7250 Like referral_cust_main, except returns a flat list of all unsuspended (and
7251 uncancelled) packages for each customer. The number of items in this list may
7252 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
7256 sub referral_cust_pkg {
7258 my $depth = @_ ? shift : 1;
7260 map { $_->unsuspended_pkgs }
7261 grep { $_->unsuspended_pkgs }
7262 $self->referral_cust_main($depth);
7265 =item referring_cust_main
7267 Returns the single cust_main record for the customer who referred this customer
7268 (referral_custnum), or false.
7272 sub referring_cust_main {
7274 return '' unless $self->referral_custnum;
7275 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7278 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
7280 Applies a credit to this customer. If there is an error, returns the error,
7281 otherwise returns false.
7283 REASON can be a text string, an FS::reason object, or a scalar reference to
7284 a reasonnum. If a text string, it will be automatically inserted as a new
7285 reason, and a 'reason_type' option must be passed to indicate the
7286 FS::reason_type for the new reason.
7288 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
7290 Any other options are passed to FS::cust_credit::insert.
7295 my( $self, $amount, $reason, %options ) = @_;
7297 my $cust_credit = new FS::cust_credit {
7298 'custnum' => $self->custnum,
7299 'amount' => $amount,
7302 if ( ref($reason) ) {
7304 if ( ref($reason) eq 'SCALAR' ) {
7305 $cust_credit->reasonnum( $$reason );
7307 $cust_credit->reasonnum( $reason->reasonnum );
7311 $cust_credit->set('reason', $reason)
7314 $cust_credit->addlinfo( delete $options{'addlinfo'} )
7315 if exists($options{'addlinfo'});
7317 $cust_credit->insert(%options);
7321 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
7323 Creates a one-time charge for this customer. If there is an error, returns
7324 the error, otherwise returns false.
7326 New-style, with a hashref of options:
7328 my $error = $cust_main->charge(
7332 'start_date' => str2time('7/4/2009'),
7333 'pkg' => 'Description',
7334 'comment' => 'Comment',
7335 'additional' => [], #extra invoice detail
7336 'classnum' => 1, #pkg_class
7338 'setuptax' => '', # or 'Y' for tax exempt
7341 'taxclass' => 'Tax class',
7344 'taxproduct' => 2, #part_pkg_taxproduct
7345 'override' => {}, #XXX describe
7347 #will be filled in with the new object
7348 'cust_pkg_ref' => \$cust_pkg,
7350 #generate an invoice immediately
7352 'invoice_terms' => '', #with these terms
7358 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
7364 my ( $amount, $quantity, $start_date, $classnum );
7365 my ( $pkg, $comment, $additional );
7366 my ( $setuptax, $taxclass ); #internal taxes
7367 my ( $taxproduct, $override ); #vendor (CCH) taxes
7368 my $cust_pkg_ref = '';
7369 my ( $bill_now, $invoice_terms ) = ( 0, '' );
7370 if ( ref( $_[0] ) ) {
7371 $amount = $_[0]->{amount};
7372 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
7373 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
7374 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
7375 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
7376 : '$'. sprintf("%.2f",$amount);
7377 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
7378 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
7379 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
7380 $additional = $_[0]->{additional} || [];
7381 $taxproduct = $_[0]->{taxproductnum};
7382 $override = { '' => $_[0]->{tax_override} };
7383 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
7384 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
7385 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
7390 $pkg = @_ ? shift : 'One-time charge';
7391 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
7393 $taxclass = @_ ? shift : '';
7397 local $SIG{HUP} = 'IGNORE';
7398 local $SIG{INT} = 'IGNORE';
7399 local $SIG{QUIT} = 'IGNORE';
7400 local $SIG{TERM} = 'IGNORE';
7401 local $SIG{TSTP} = 'IGNORE';
7402 local $SIG{PIPE} = 'IGNORE';
7404 my $oldAutoCommit = $FS::UID::AutoCommit;
7405 local $FS::UID::AutoCommit = 0;
7408 my $part_pkg = new FS::part_pkg ( {
7410 'comment' => $comment,
7414 'classnum' => ( $classnum ? $classnum : '' ),
7415 'setuptax' => $setuptax,
7416 'taxclass' => $taxclass,
7417 'taxproductnum' => $taxproduct,
7420 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
7421 ( 0 .. @$additional - 1 )
7423 'additional_count' => scalar(@$additional),
7424 'setup_fee' => $amount,
7427 my $error = $part_pkg->insert( options => \%options,
7428 tax_overrides => $override,
7431 $dbh->rollback if $oldAutoCommit;
7435 my $pkgpart = $part_pkg->pkgpart;
7436 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
7437 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
7438 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
7439 $error = $type_pkgs->insert;
7441 $dbh->rollback if $oldAutoCommit;
7446 my $cust_pkg = new FS::cust_pkg ( {
7447 'custnum' => $self->custnum,
7448 'pkgpart' => $pkgpart,
7449 'quantity' => $quantity,
7450 'start_date' => $start_date,
7453 $error = $cust_pkg->insert;
7455 $dbh->rollback if $oldAutoCommit;
7457 } elsif ( $cust_pkg_ref ) {
7458 ${$cust_pkg_ref} = $cust_pkg;
7462 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
7463 'pkg_list' => [ $cust_pkg ],
7466 $dbh->rollback if $oldAutoCommit;
7471 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
7476 #=item charge_postal_fee
7478 #Applies a one time charge this customer. If there is an error,
7479 #returns the error, returns the cust_pkg charge object or false
7480 #if there was no charge.
7484 # This should be a customer event. For that to work requires that bill
7485 # also be a customer event.
7487 sub charge_postal_fee {
7490 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
7491 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
7493 my $cust_pkg = new FS::cust_pkg ( {
7494 'custnum' => $self->custnum,
7495 'pkgpart' => $pkgpart,
7499 my $error = $cust_pkg->insert;
7500 $error ? $error : $cust_pkg;
7505 Returns all the invoices (see L<FS::cust_bill>) for this customer.
7511 map { $_ } #return $self->num_cust_bill unless wantarray;
7512 sort { $a->_date <=> $b->_date }
7513 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
7516 =item open_cust_bill
7518 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
7523 sub open_cust_bill {
7527 'table' => 'cust_bill',
7528 'hashref' => { 'custnum' => $self->custnum, },
7529 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
7530 'order_by' => 'ORDER BY _date ASC',
7535 =item cust_statements
7537 Returns all the statements (see L<FS::cust_statement>) for this customer.
7541 sub cust_statement {
7543 map { $_ } #return $self->num_cust_statement unless wantarray;
7544 sort { $a->_date <=> $b->_date }
7545 qsearch('cust_statement', { 'custnum' => $self->custnum, } )
7550 Returns all the credits (see L<FS::cust_credit>) for this customer.
7556 map { $_ } #return $self->num_cust_credit unless wantarray;
7557 sort { $a->_date <=> $b->_date }
7558 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
7561 =item cust_credit_pkgnum
7563 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
7564 package when using experimental package balances.
7568 sub cust_credit_pkgnum {
7569 my( $self, $pkgnum ) = @_;
7570 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
7571 sort { $a->_date <=> $b->_date }
7572 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
7573 'pkgnum' => $pkgnum,
7580 Returns all the payments (see L<FS::cust_pay>) for this customer.
7586 return $self->num_cust_pay unless wantarray;
7587 sort { $a->_date <=> $b->_date }
7588 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
7593 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
7594 called automatically when the cust_pay method is used in a scalar context.
7600 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
7601 my $sth = dbh->prepare($sql) or die dbh->errstr;
7602 $sth->execute($self->custnum) or die $sth->errstr;
7603 $sth->fetchrow_arrayref->[0];
7606 =item cust_pay_pkgnum
7608 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
7609 package when using experimental package balances.
7613 sub cust_pay_pkgnum {
7614 my( $self, $pkgnum ) = @_;
7615 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
7616 sort { $a->_date <=> $b->_date }
7617 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
7618 'pkgnum' => $pkgnum,
7625 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
7631 map { $_ } #return $self->num_cust_pay_void unless wantarray;
7632 sort { $a->_date <=> $b->_date }
7633 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
7636 =item cust_pay_batch
7638 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
7642 sub cust_pay_batch {
7644 map { $_ } #return $self->num_cust_pay_batch unless wantarray;
7645 sort { $a->paybatchnum <=> $b->paybatchnum }
7646 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
7649 =item cust_pay_pending
7651 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
7652 (without status "done").
7656 sub cust_pay_pending {
7658 return $self->num_cust_pay_pending unless wantarray;
7659 sort { $a->_date <=> $b->_date }
7660 qsearch( 'cust_pay_pending', {
7661 'custnum' => $self->custnum,
7662 'status' => { op=>'!=', value=>'done' },
7667 =item num_cust_pay_pending
7669 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
7670 customer (without status "done"). Also called automatically when the
7671 cust_pay_pending method is used in a scalar context.
7675 sub num_cust_pay_pending {
7677 my $sql = " SELECT COUNT(*) FROM cust_pay_pending ".
7678 " WHERE custnum = ? AND status != 'done' ";
7679 my $sth = dbh->prepare($sql) or die dbh->errstr;
7680 $sth->execute($self->custnum) or die $sth->errstr;
7681 $sth->fetchrow_arrayref->[0];
7686 Returns all the refunds (see L<FS::cust_refund>) for this customer.
7692 map { $_ } #return $self->num_cust_refund unless wantarray;
7693 sort { $a->_date <=> $b->_date }
7694 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
7697 =item display_custnum
7699 Returns the displayed customer number for this customer: agent_custid if
7700 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
7704 sub display_custnum {
7706 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
7707 return $self->agent_custid;
7709 return $self->custnum;
7715 Returns a name string for this customer, either "Company (Last, First)" or
7722 my $name = $self->contact;
7723 $name = $self->company. " ($name)" if $self->company;
7729 Returns a name string for this (service/shipping) contact, either
7730 "Company (Last, First)" or "Last, First".
7736 if ( $self->get('ship_last') ) {
7737 my $name = $self->ship_contact;
7738 $name = $self->ship_company. " ($name)" if $self->ship_company;
7747 Returns a name string for this customer, either "Company" or "First Last".
7753 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
7756 =item ship_name_short
7758 Returns a name string for this (service/shipping) contact, either "Company"
7763 sub ship_name_short {
7765 if ( $self->get('ship_last') ) {
7766 $self->ship_company !~ /^\s*$/
7767 ? $self->ship_company
7768 : $self->ship_contact_firstlast;
7770 $self->name_company_or_firstlast;
7776 Returns this customer's full (billing) contact name only, "Last, First"
7782 $self->get('last'). ', '. $self->first;
7787 Returns this customer's full (shipping) contact name only, "Last, First"
7793 $self->get('ship_last')
7794 ? $self->get('ship_last'). ', '. $self->ship_first
7798 =item contact_firstlast
7800 Returns this customers full (billing) contact name only, "First Last".
7804 sub contact_firstlast {
7806 $self->first. ' '. $self->get('last');
7809 =item ship_contact_firstlast
7811 Returns this customer's full (shipping) contact name only, "First Last".
7815 sub ship_contact_firstlast {
7817 $self->get('ship_last')
7818 ? $self->first. ' '. $self->get('ship_last')
7819 : $self->contact_firstlast;
7824 Returns this customer's full country name
7830 code2country($self->country);
7833 =item geocode DATA_VENDOR
7835 Returns a value for the customer location as encoded by DATA_VENDOR.
7836 Currently this only makes sense for "CCH" as DATA_VENDOR.
7841 my ($self, $data_vendor) = (shift, shift); #always cch for now
7843 my $geocode = $self->get('geocode'); #XXX only one data_vendor for geocode
7844 return $geocode if $geocode;
7846 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
7850 my ($zip,$plus4) = split /-/, $self->get("${prefix}zip")
7851 if $self->country eq 'US';
7853 #CCH specific location stuff
7854 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
7856 my @cust_tax_location =
7858 'table' => 'cust_tax_location',
7859 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
7860 'extra_sql' => $extra_sql,
7861 'order_by' => 'ORDER BY plus4hi',#overlapping with distinct ends
7864 $geocode = $cust_tax_location[0]->geocode
7865 if scalar(@cust_tax_location);
7874 Returns a status string for this customer, currently:
7878 =item prospect - No packages have ever been ordered
7880 =item active - One or more recurring packages is active
7882 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
7884 =item suspended - All non-cancelled recurring packages are suspended
7886 =item cancelled - All recurring packages are cancelled
7892 sub status { shift->cust_status(@_); }
7896 for my $status (qw( prospect active inactive suspended cancelled )) {
7897 my $method = $status.'_sql';
7898 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
7899 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
7900 $sth->execute( ($self->custnum) x $numnum )
7901 or die "Error executing 'SELECT $sql': ". $sth->errstr;
7902 return $status if $sth->fetchrow_arrayref->[0];
7906 =item ucfirst_cust_status
7908 =item ucfirst_status
7910 Returns the status with the first character capitalized.
7914 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
7916 sub ucfirst_cust_status {
7918 ucfirst($self->cust_status);
7923 Returns a hex triplet color string for this customer's status.
7927 use vars qw(%statuscolor);
7928 tie %statuscolor, 'Tie::IxHash',
7929 'prospect' => '7e0079', #'000000', #black? naw, purple
7930 'active' => '00CC00', #green
7931 'inactive' => '0000CC', #blue
7932 'suspended' => 'FF9900', #yellow
7933 'cancelled' => 'FF0000', #red
7936 sub statuscolor { shift->cust_statuscolor(@_); }
7938 sub cust_statuscolor {
7940 $statuscolor{$self->cust_status};
7945 Returns an array of hashes representing the customer's RT tickets.
7952 my $num = $conf->config('cust_main-max_tickets') || 10;
7955 if ( $conf->config('ticket_system') ) {
7956 unless ( $conf->config('ticket_system-custom_priority_field') ) {
7958 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
7962 foreach my $priority (
7963 $conf->config('ticket_system-custom_priority_field-values'), ''
7965 last if scalar(@tickets) >= $num;
7967 @{ FS::TicketSystem->customer_tickets( $self->custnum,
7968 $num - scalar(@tickets),
7978 # Return services representing svc_accts in customer support packages
7979 sub support_services {
7981 my %packages = map { $_ => 1 } $conf->config('support_packages');
7983 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
7984 grep { $_->part_svc->svcdb eq 'svc_acct' }
7985 map { $_->cust_svc }
7986 grep { exists $packages{ $_->pkgpart } }
7987 $self->ncancelled_pkgs;
7991 # Return a list of latitude/longitude for one of the services (if any)
7992 sub service_coordinates {
7996 grep { $_->latitude && $_->longitude }
7998 map { $_->cust_svc }
7999 $self->ncancelled_pkgs;
8001 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
8006 =head1 CLASS METHODS
8012 Class method that returns the list of possible status strings for customers
8013 (see L<the status method|/status>). For example:
8015 @statuses = FS::cust_main->statuses();
8020 #my $self = shift; #could be class...
8026 Returns an SQL expression identifying prospective cust_main records (customers
8027 with no packages ever ordered)
8031 use vars qw($select_count_pkgs);
8032 $select_count_pkgs =
8033 "SELECT COUNT(*) FROM cust_pkg
8034 WHERE cust_pkg.custnum = cust_main.custnum";
8036 sub select_count_pkgs_sql {
8040 sub prospect_sql { "
8041 0 = ( $select_count_pkgs )
8046 Returns an SQL expression identifying active cust_main records (customers with
8047 active recurring packages).
8052 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
8058 Returns an SQL expression identifying inactive cust_main records (customers with
8059 no active recurring packages, but otherwise unsuspended/uncancelled).
8063 sub inactive_sql { "
8064 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
8066 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
8072 Returns an SQL expression identifying suspended cust_main records.
8077 sub suspended_sql { susp_sql(@_); }
8079 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
8081 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
8087 Returns an SQL expression identifying cancelled cust_main records.
8091 sub cancelled_sql { cancel_sql(@_); }
8094 my $recurring_sql = FS::cust_pkg->recurring_sql;
8095 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
8098 0 < ( $select_count_pkgs )
8099 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
8100 AND 0 = ( $select_count_pkgs AND $recurring_sql
8101 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
8103 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
8109 =item uncancelled_sql
8111 Returns an SQL expression identifying un-cancelled cust_main records.
8115 sub uncancelled_sql { uncancel_sql(@_); }
8116 sub uncancel_sql { "
8117 ( 0 < ( $select_count_pkgs
8118 AND ( cust_pkg.cancel IS NULL
8119 OR cust_pkg.cancel = 0
8122 OR 0 = ( $select_count_pkgs )
8128 Returns an SQL fragment to retreive the balance.
8133 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
8134 WHERE cust_bill.custnum = cust_main.custnum )
8135 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
8136 WHERE cust_pay.custnum = cust_main.custnum )
8137 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
8138 WHERE cust_credit.custnum = cust_main.custnum )
8139 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
8140 WHERE cust_refund.custnum = cust_main.custnum )
8143 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8145 Returns an SQL fragment to retreive the balance for this customer, only
8146 considering invoices with date earlier than START_TIME, and optionally not
8147 later than END_TIME (total_owed_date minus total_unapplied_credits minus
8148 total_unapplied_payments).
8150 Times are specified as SQL fragments or numeric
8151 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
8152 L<Date::Parse> for conversion functions. The empty string can be passed
8153 to disable that time constraint completely.
8155 Available options are:
8159 =item unapplied_date
8161 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)
8166 set to true to remove all customer comparison clauses, for totals
8171 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
8176 JOIN clause (typically used with the total option)
8182 sub balance_date_sql {
8183 my( $class, $start, $end, %opt ) = @_;
8185 my $owed = FS::cust_bill->owed_sql;
8186 my $unapp_refund = FS::cust_refund->unapplied_sql;
8187 my $unapp_credit = FS::cust_credit->unapplied_sql;
8188 my $unapp_pay = FS::cust_pay->unapplied_sql;
8190 my $j = $opt{'join'} || '';
8192 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
8193 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
8194 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
8195 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
8197 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
8198 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
8199 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
8200 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
8205 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
8207 Returns an SQL fragment to retreive the total unapplied payments for this
8208 customer, only considering invoices with date earlier than START_TIME, and
8209 optionally not later than END_TIME.
8211 Times are specified as SQL fragments or numeric
8212 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
8213 L<Date::Parse> for conversion functions. The empty string can be passed
8214 to disable that time constraint completely.
8216 Available options are:
8220 sub unapplied_payments_date_sql {
8221 my( $class, $start, $end, ) = @_;
8223 my $unapp_pay = FS::cust_pay->unapplied_sql;
8225 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
8226 'unapplied_date'=>1 );
8228 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
8231 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8233 Helper method for balance_date_sql; name (and usage) subject to change
8234 (suggestions welcome).
8236 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
8237 cust_refund, cust_credit or cust_pay).
8239 If TABLE is "cust_bill" or the unapplied_date option is true, only
8240 considers records with date earlier than START_TIME, and optionally not
8241 later than END_TIME .
8245 sub _money_table_where {
8246 my( $class, $table, $start, $end, %opt ) = @_;
8249 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
8250 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
8251 push @where, "$table._date <= $start" if defined($start) && length($start);
8252 push @where, "$table._date > $end" if defined($end) && length($end);
8254 push @where, @{$opt{'where'}} if $opt{'where'};
8255 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
8261 =item search_sql HASHREF
8265 Returns a qsearch hash expression to search for parameters specified in HREF.
8266 Valid parameters are
8274 =item cancelled_pkgs
8280 listref of start date, end date
8290 =item current_balance
8292 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
8296 =item flattened_pkgs
8305 my ($class, $params) = @_;
8316 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
8318 "cust_main.agentnum = $1";
8325 #prospect active inactive suspended cancelled
8326 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
8327 my $method = $params->{'status'}. '_sql';
8328 #push @where, $class->$method();
8329 push @where, FS::cust_main->$method();
8333 # parse cancelled package checkbox
8338 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
8339 unless $params->{'cancelled_pkgs'};
8342 # parse without census tract checkbox
8345 push @where, "(censustract = '' or censustract is null)"
8346 if $params->{'no_censustract'};
8352 foreach my $field (qw( signupdate )) {
8354 next unless exists($params->{$field});
8356 my($beginning, $ending) = @{$params->{$field}};
8359 "cust_main.$field IS NOT NULL",
8360 "cust_main.$field >= $beginning",
8361 "cust_main.$field <= $ending";
8363 $orderby ||= "ORDER BY cust_main.$field";
8371 my @classnum = grep /^(\d*)$/, @{ $params->{'classnum'} };
8373 push @where, '( '. join(' OR ', map {
8374 $_ ? "cust_main.classnum = $_"
8375 : "cust_main.classnum IS NULL"
8386 my @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
8388 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )';
8392 # paydate_year / paydate_month
8395 if ( $params->{'paydate_year'} =~ /^(\d{4})$/ ) {
8397 $params->{'paydate_month'} =~ /^(\d\d?)$/
8398 or die "paydate_year without paydate_month?";
8402 'paydate IS NOT NULL',
8404 "CAST(paydate AS timestamp) < CAST('$year-$month-01' AS timestamp )"
8412 if ( $params->{'invoice_terms'} =~ /^([\w ]+)$/ ) {
8414 if ( $1 eq 'NULL' ) {
8416 "( cust_main.invoice_terms IS NULL OR cust_main.invoice_terms = '' )";
8419 "cust_main.invoice_terms IS NOT NULL",
8420 "cust_main.invoice_terms = '$1'";
8428 #my $balance_sql = $class->balance_sql();
8429 my $balance_sql = FS::cust_main->balance_sql();
8431 my @current_balance = @{ $params->{'current_balance'} };
8433 push @where, map { s/current_balance/$balance_sql/; $_ }
8440 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
8442 "cust_main.custbatch = '$1'";
8446 # setup queries, subs, etc. for the search
8449 $orderby ||= 'ORDER BY custnum';
8451 # here is the agent virtualization
8452 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
8454 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
8456 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
8458 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
8460 my $select = join(', ',
8461 'cust_main.custnum',
8462 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
8465 my(@extra_headers) = ();
8466 my(@extra_fields) = ();
8468 if ($params->{'flattened_pkgs'}) {
8470 if ($dbh->{Driver}->{Name} eq 'Pg') {
8472 $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";
8474 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
8475 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
8476 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
8478 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
8479 "omitting packing information from report.";
8482 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";
8484 my $sth = dbh->prepare($header_query) or die dbh->errstr;
8485 $sth->execute() or die $sth->errstr;
8486 my $headerrow = $sth->fetchrow_arrayref;
8487 my $headercount = $headerrow ? $headerrow->[0] : 0;
8488 while($headercount) {
8489 unshift @extra_headers, "Package ". $headercount;
8490 unshift @extra_fields, eval q!sub {my $c = shift;
8491 my @a = split '\|', $c->magic;
8492 my $p = $a[!.--$headercount. q!];
8500 'table' => 'cust_main',
8501 'select' => $select,
8503 'extra_sql' => $extra_sql,
8504 'order_by' => $orderby,
8505 'count_query' => $count_query,
8506 'extra_headers' => \@extra_headers,
8507 'extra_fields' => \@extra_fields,
8512 =item email_search_sql HASHREF
8516 Emails a notice to the specified customers.
8518 Valid parameters are those of the L<search_sql> method, plus the following:
8540 Optional job queue job for status updates.
8544 Returns an error message, or false for success.
8546 If an error occurs during any email, stops the enture send and returns that
8547 error. Presumably if you're getting SMTP errors aborting is better than
8548 retrying everything.
8552 sub email_search_sql {
8553 my($class, $params) = @_;
8555 my $from = delete $params->{from};
8556 my $subject = delete $params->{subject};
8557 my $html_body = delete $params->{html_body};
8558 my $text_body = delete $params->{text_body};
8560 my $job = delete $params->{'job'};
8562 $params->{'payby'} = [ split(/\0/, $params->{'payby'}) ]
8563 unless ref($params->{'payby'});
8565 my $sql_query = $class->search_sql($params);
8567 my $count_query = delete($sql_query->{'count_query'});
8568 my $count_sth = dbh->prepare($count_query)
8569 or die "Error preparing $count_query: ". dbh->errstr;
8571 or die "Error executing $count_query: ". $count_sth->errstr;
8572 my $count_arrayref = $count_sth->fetchrow_arrayref;
8573 my $num_cust = $count_arrayref->[0];
8575 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
8576 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
8579 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
8581 #eventually order+limit magic to reduce memory use?
8582 foreach my $cust_main ( qsearch($sql_query) ) {
8584 my $to = $cust_main->invoicing_list_emailonly_scalar;
8587 my $error = send_email(
8591 'subject' => $subject,
8592 'html_body' => $html_body,
8593 'text_body' => $text_body,
8596 return $error if $error;
8598 if ( $job ) { #progressbar foo
8600 if ( time - $min_sec > $last ) {
8601 my $error = $job->update_statustext(
8602 int( 100 * $num / $num_cust )
8604 die $error if $error;
8614 use Storable qw(thaw);
8617 sub process_email_search_sql {
8619 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
8621 my $param = thaw(decode_base64(shift));
8622 warn Dumper($param) if $DEBUG;
8624 $param->{'job'} = $job;
8626 $param->{'payby'} = [ split(/\0/, $param->{'payby'}) ]
8627 unless ref($param->{'payby'});
8629 my $error = FS::cust_main->email_search_sql( $param );
8630 die $error if $error;
8634 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
8636 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
8637 records. Currently, I<first>, I<last>, I<company> and/or I<address1> may be
8638 specified (the appropriate ship_ field is also searched).
8640 Additional options are the same as FS::Record::qsearch
8645 my( $self, $fuzzy, $hash, @opt) = @_;
8650 check_and_rebuild_fuzzyfiles();
8651 foreach my $field ( keys %$fuzzy ) {
8653 my $all = $self->all_X($field);
8654 next unless scalar(@$all);
8657 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
8660 foreach ( keys %match ) {
8661 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
8662 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
8665 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
8668 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
8670 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
8678 Returns a masked version of the named field
8683 my ($self,$field) = @_;
8687 'x'x(length($self->getfield($field))-4).
8688 substr($self->getfield($field), (length($self->getfield($field))-4));
8698 =item smart_search OPTION => VALUE ...
8700 Accepts the following options: I<search>, the string to search for. The string
8701 will be searched for as a customer number, phone number, name or company name,
8702 as an exact, or, in some cases, a substring or fuzzy match (see the source code
8703 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
8704 skip fuzzy matching when an exact match is found.
8706 Any additional options are treated as an additional qualifier on the search
8709 Returns a (possibly empty) array of FS::cust_main objects.
8716 #here is the agent virtualization
8717 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8721 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
8722 my $search = delete $options{'search'};
8723 ( my $alphanum_search = $search ) =~ s/\W//g;
8725 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
8727 #false laziness w/Record::ut_phone
8728 my $phonen = "$1-$2-$3";
8729 $phonen .= " x$4" if $4;
8731 push @cust_main, qsearch( {
8732 'table' => 'cust_main',
8733 'hashref' => { %options },
8734 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8736 join(' OR ', map "$_ = '$phonen'",
8737 qw( daytime night fax
8738 ship_daytime ship_night ship_fax )
8741 " AND $agentnums_sql", #agent virtualization
8744 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
8745 #try looking for matches with extensions unless one was specified
8747 push @cust_main, qsearch( {
8748 'table' => 'cust_main',
8749 'hashref' => { %options },
8750 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8752 join(' OR ', map "$_ LIKE '$phonen\%'",
8754 ship_daytime ship_night )
8757 " AND $agentnums_sql", #agent virtualization
8762 # custnum search (also try agent_custid), with some tweaking options if your
8763 # legacy cust "numbers" have letters
8766 if ( $search =~ /^\s*(\d+)\s*$/
8767 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
8768 && $search =~ /^\s*(\w\w?\d+)\s*$/
8770 || ( $conf->exists('address1-search' )
8771 && $search =~ /^\s*(\d+\-?\w*)\s*$/ #i.e. 1234A or 9432-D
8778 if ( $num =~ /^(\d+)$/ && $num <= 2147483647 ) { #need a bigint custnum? wow
8779 push @cust_main, qsearch( {
8780 'table' => 'cust_main',
8781 'hashref' => { 'custnum' => $num, %options },
8782 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8786 push @cust_main, qsearch( {
8787 'table' => 'cust_main',
8788 'hashref' => { 'agent_custid' => $num, %options },
8789 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8792 if ( $conf->exists('address1-search') ) {
8793 my $len = length($num);
8795 foreach my $prefix ( '', 'ship_' ) {
8796 push @cust_main, qsearch( {
8797 'table' => 'cust_main',
8798 'hashref' => { %options, },
8800 ( keys(%options) ? ' AND ' : ' WHERE ' ).
8801 " LOWER(SUBSTRING(${prefix}address1 FROM 1 FOR $len)) = '$num' ".
8802 " AND $agentnums_sql",
8807 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
8809 my($company, $last, $first) = ( $1, $2, $3 );
8811 # "Company (Last, First)"
8812 #this is probably something a browser remembered,
8813 #so just do an exact search (but case-insensitive, so USPS standardization
8814 #doesn't throw a wrench in the works)
8816 foreach my $prefix ( '', 'ship_' ) {
8817 push @cust_main, qsearch( {
8818 'table' => 'cust_main',
8819 'hashref' => { %options },
8821 ( keys(%options) ? ' AND ' : ' WHERE ' ).
8823 " LOWER(${prefix}first) = ". dbh->quote(lc($first)),
8824 " LOWER(${prefix}last) = ". dbh->quote(lc($last)),
8825 " LOWER(${prefix}company) = ". dbh->quote(lc($company)),
8831 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
8832 # try (ship_){last,company}
8836 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
8837 # # full strings the browser remembers won't work
8838 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
8840 use Lingua::EN::NameParse;
8841 my $NameParse = new Lingua::EN::NameParse(
8843 allow_reversed => 1,
8846 my($last, $first) = ( '', '' );
8847 #maybe disable this too and just rely on NameParse?
8848 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
8850 ($last, $first) = ( $1, $2 );
8852 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
8853 } elsif ( ! $NameParse->parse($value) ) {
8855 my %name = $NameParse->components;
8856 $first = $name{'given_name_1'};
8857 $last = $name{'surname_1'};
8861 if ( $first && $last ) {
8863 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
8866 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8868 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
8869 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
8872 push @cust_main, qsearch( {
8873 'table' => 'cust_main',
8874 'hashref' => \%options,
8875 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8878 # or it just be something that was typed in... (try that in a sec)
8882 my $q_value = dbh->quote($value);
8885 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8886 $sql .= " ( LOWER(last) = $q_value
8887 OR LOWER(company) = $q_value
8888 OR LOWER(ship_last) = $q_value
8889 OR LOWER(ship_company) = $q_value
8891 $sql .= " OR LOWER(address1) = $q_value
8892 OR LOWER(ship_address1) = $q_value
8894 if $conf->exists('address1-search');
8897 push @cust_main, qsearch( {
8898 'table' => 'cust_main',
8899 'hashref' => \%options,
8900 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8903 #no exact match, trying substring/fuzzy
8904 #always do substring & fuzzy (unless they're explicity config'ed off)
8905 #getting complaints searches are not returning enough
8906 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
8908 #still some false laziness w/search_sql (was search/cust_main.cgi)
8913 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
8914 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
8917 if ( $first && $last ) {
8920 { 'first' => { op=>'ILIKE', value=>"%$first%" },
8921 'last' => { op=>'ILIKE', value=>"%$last%" },
8923 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
8924 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
8931 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
8932 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
8936 if ( $conf->exists('address1-search') ) {
8938 { 'address1' => { op=>'ILIKE', value=>"%$value%" }, },
8939 { 'ship_address1' => { op=>'ILIKE', value=>"%$value%" }, },
8943 foreach my $hashref ( @hashrefs ) {
8945 push @cust_main, qsearch( {
8946 'table' => 'cust_main',
8947 'hashref' => { %$hashref,
8950 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
8959 " AND $agentnums_sql", #extra_sql #agent virtualization
8962 if ( $first && $last ) {
8963 push @cust_main, FS::cust_main->fuzzy_search(
8964 { 'last' => $last, #fuzzy hashref
8965 'first' => $first }, #
8969 foreach my $field ( 'last', 'company' ) {
8971 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
8973 if ( $conf->exists('address1-search') ) {
8975 FS::cust_main->fuzzy_search( { 'address1' => $value }, @fuzopts );
8982 #eliminate duplicates
8984 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8992 Accepts the following options: I<email>, the email address to search for. The
8993 email address will be searched for as an email invoice destination and as an
8996 #Any additional options are treated as an additional qualifier on the search
8997 #(i.e. I<agentnum>).
8999 Returns a (possibly empty) array of FS::cust_main objects (but usually just
9009 my $email = delete $options{'email'};
9011 #we're only being used by RT at the moment... no agent virtualization yet
9012 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
9016 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
9018 my ( $user, $domain ) = ( $1, $2 );
9020 warn "$me smart_search: searching for $user in domain $domain"
9026 'table' => 'cust_main_invoice',
9027 'hashref' => { 'dest' => $email },
9034 map $_->cust_svc->cust_pkg,
9036 'table' => 'svc_acct',
9037 'hashref' => { 'username' => $user, },
9039 'AND ( SELECT domain FROM svc_domain
9040 WHERE svc_acct.domsvc = svc_domain.svcnum
9041 ) = '. dbh->quote($domain),
9047 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
9049 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
9056 =item check_and_rebuild_fuzzyfiles
9060 sub check_and_rebuild_fuzzyfiles {
9061 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9062 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
9065 =item rebuild_fuzzyfiles
9069 sub rebuild_fuzzyfiles {
9071 use Fcntl qw(:flock);
9073 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9074 mkdir $dir, 0700 unless -d $dir;
9076 foreach my $fuzzy ( @fuzzyfields ) {
9078 open(LOCK,">>$dir/cust_main.$fuzzy")
9079 or die "can't open $dir/cust_main.$fuzzy: $!";
9081 or die "can't lock $dir/cust_main.$fuzzy: $!";
9083 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
9084 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
9086 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
9087 my $sth = dbh->prepare("SELECT $field FROM cust_main".
9088 " WHERE $field != '' AND $field IS NOT NULL");
9089 $sth->execute or die $sth->errstr;
9091 while ( my $row = $sth->fetchrow_arrayref ) {
9092 print CACHE $row->[0]. "\n";
9097 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
9099 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
9110 my( $self, $field ) = @_;
9111 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9112 open(CACHE,"<$dir/cust_main.$field")
9113 or die "can't open $dir/cust_main.$field: $!";
9114 my @array = map { chomp; $_; } <CACHE>;
9119 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
9123 sub append_fuzzyfiles {
9124 #my( $first, $last, $company ) = @_;
9126 &check_and_rebuild_fuzzyfiles;
9128 use Fcntl qw(:flock);
9130 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9132 foreach my $field (@fuzzyfields) {
9137 open(CACHE,">>$dir/cust_main.$field")
9138 or die "can't open $dir/cust_main.$field: $!";
9139 flock(CACHE,LOCK_EX)
9140 or die "can't lock $dir/cust_main.$field: $!";
9142 print CACHE "$value\n";
9144 flock(CACHE,LOCK_UN)
9145 or die "can't unlock $dir/cust_main.$field: $!";
9160 #warn join('-',keys %$param);
9161 my $fh = $param->{filehandle};
9162 my @fields = @{$param->{fields}};
9164 eval "use Text::CSV_XS;";
9167 my $csv = new Text::CSV_XS;
9174 local $SIG{HUP} = 'IGNORE';
9175 local $SIG{INT} = 'IGNORE';
9176 local $SIG{QUIT} = 'IGNORE';
9177 local $SIG{TERM} = 'IGNORE';
9178 local $SIG{TSTP} = 'IGNORE';
9179 local $SIG{PIPE} = 'IGNORE';
9181 my $oldAutoCommit = $FS::UID::AutoCommit;
9182 local $FS::UID::AutoCommit = 0;
9185 #while ( $columns = $csv->getline($fh) ) {
9187 while ( defined($line=<$fh>) ) {
9189 $csv->parse($line) or do {
9190 $dbh->rollback if $oldAutoCommit;
9191 return "can't parse: ". $csv->error_input();
9194 my @columns = $csv->fields();
9195 #warn join('-',@columns);
9198 foreach my $field ( @fields ) {
9199 $row{$field} = shift @columns;
9202 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
9203 unless ( $cust_main ) {
9204 $dbh->rollback if $oldAutoCommit;
9205 return "unknown custnum $row{'custnum'}";
9208 if ( $row{'amount'} > 0 ) {
9209 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
9211 $dbh->rollback if $oldAutoCommit;
9215 } elsif ( $row{'amount'} < 0 ) {
9216 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
9219 $dbh->rollback if $oldAutoCommit;
9229 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
9231 return "Empty file!" unless $imported;
9237 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9239 Sends a templated email notification to the customer (see L<Text::Template>).
9241 OPTIONS is a hash and may include
9243 I<from> - the email sender (default is invoice_from)
9245 I<to> - comma-separated scalar or arrayref of recipients
9246 (default is invoicing_list)
9248 I<subject> - The subject line of the sent email notification
9249 (default is "Notice from company_name")
9251 I<extra_fields> - a hashref of name/value pairs which will be substituted
9254 The following variables are vavailable in the template.
9256 I<$first> - the customer first name
9257 I<$last> - the customer last name
9258 I<$company> - the customer company
9259 I<$payby> - a description of the method of payment for the customer
9260 # would be nice to use FS::payby::shortname
9261 I<$payinfo> - the account information used to collect for this customer
9262 I<$expdate> - the expiration of the customer payment in seconds from epoch
9267 my ($self, $template, %options) = @_;
9269 return unless $conf->exists($template);
9271 my $from = $conf->config('invoice_from', $self->agentnum)
9272 if $conf->exists('invoice_from', $self->agentnum);
9273 $from = $options{from} if exists($options{from});
9275 my $to = join(',', $self->invoicing_list_emailonly);
9276 $to = $options{to} if exists($options{to});
9278 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
9279 if $conf->exists('company_name', $self->agentnum);
9280 $subject = $options{subject} if exists($options{subject});
9282 my $notify_template = new Text::Template (TYPE => 'ARRAY',
9283 SOURCE => [ map "$_\n",
9284 $conf->config($template)]
9286 or die "can't create new Text::Template object: Text::Template::ERROR";
9287 $notify_template->compile()
9288 or die "can't compile template: Text::Template::ERROR";
9290 $FS::notify_template::_template::company_name =
9291 $conf->config('company_name', $self->agentnum);
9292 $FS::notify_template::_template::company_address =
9293 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
9295 my $paydate = $self->paydate || '2037-12-31';
9296 $FS::notify_template::_template::first = $self->first;
9297 $FS::notify_template::_template::last = $self->last;
9298 $FS::notify_template::_template::company = $self->company;
9299 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
9300 my $payby = $self->payby;
9301 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9302 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9304 #credit cards expire at the end of the month/year of their exp date
9305 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9306 $FS::notify_template::_template::payby = 'credit card';
9307 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9308 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9310 }elsif ($payby eq 'COMP') {
9311 $FS::notify_template::_template::payby = 'complimentary account';
9313 $FS::notify_template::_template::payby = 'current method';
9315 $FS::notify_template::_template::expdate = $expire_time;
9317 for (keys %{$options{extra_fields}}){
9319 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
9322 send_email(from => $from,
9324 subject => $subject,
9325 body => $notify_template->fill_in( PACKAGE =>
9326 'FS::notify_template::_template' ),
9331 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9333 Generates a templated notification to the customer (see L<Text::Template>).
9335 OPTIONS is a hash and may include
9337 I<extra_fields> - a hashref of name/value pairs which will be substituted
9338 into the template. These values may override values mentioned below
9339 and those from the customer record.
9341 The following variables are available in the template instead of or in addition
9342 to the fields of the customer record.
9344 I<$payby> - a description of the method of payment for the customer
9345 # would be nice to use FS::payby::shortname
9346 I<$payinfo> - the masked account information used to collect for this customer
9347 I<$expdate> - the expiration of the customer payment method in seconds from epoch
9348 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
9352 sub generate_letter {
9353 my ($self, $template, %options) = @_;
9355 return unless $conf->exists($template);
9357 my $letter_template = new Text::Template
9359 SOURCE => [ map "$_\n", $conf->config($template)],
9360 DELIMITERS => [ '[@--', '--@]' ],
9362 or die "can't create new Text::Template object: Text::Template::ERROR";
9364 $letter_template->compile()
9365 or die "can't compile template: Text::Template::ERROR";
9367 my %letter_data = map { $_ => $self->$_ } $self->fields;
9368 $letter_data{payinfo} = $self->mask_payinfo;
9370 #my $paydate = $self->paydate || '2037-12-31';
9371 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
9373 my $payby = $self->payby;
9374 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9375 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9377 #credit cards expire at the end of the month/year of their exp date
9378 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9379 $letter_data{payby} = 'credit card';
9380 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9381 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9383 }elsif ($payby eq 'COMP') {
9384 $letter_data{payby} = 'complimentary account';
9386 $letter_data{payby} = 'current method';
9388 $letter_data{expdate} = $expire_time;
9390 for (keys %{$options{extra_fields}}){
9391 $letter_data{$_} = $options{extra_fields}->{$_};
9394 unless(exists($letter_data{returnaddress})){
9395 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
9396 $self->agent_template)
9398 if ( length($retadd) ) {
9399 $letter_data{returnaddress} = $retadd;
9400 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
9401 $letter_data{returnaddress} =
9402 join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
9403 $conf->config('company_address', $self->agentnum)
9406 $letter_data{returnaddress} = '~';
9410 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
9412 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
9414 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
9415 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
9419 ) or die "can't open temp file: $!\n";
9421 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
9423 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
9427 =item print_ps TEMPLATE
9429 Returns an postscript letter filled in from TEMPLATE, as a scalar.
9435 my $file = $self->generate_letter(@_);
9436 FS::Misc::generate_ps($file);
9439 =item print TEMPLATE
9441 Prints the filled in template.
9443 TEMPLATE is the name of a L<Text::Template> to fill in and print.
9447 sub queueable_print {
9450 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
9451 or die "invalid customer number: " . $opt{custvnum};
9453 my $error = $self->print( $opt{template} );
9454 die $error if $error;
9458 my ($self, $template) = (shift, shift);
9459 do_print [ $self->print_ps($template) ];
9462 #these three subs should just go away once agent stuff is all config overrides
9464 sub agent_template {
9466 $self->_agent_plandata('agent_templatename');
9469 sub agent_invoice_from {
9471 $self->_agent_plandata('agent_invoice_from');
9474 sub _agent_plandata {
9475 my( $self, $option ) = @_;
9477 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
9478 #agent-specific Conf
9480 use FS::part_event::Condition;
9482 my $agentnum = $self->agentnum;
9485 if ( driver_name =~ /^Pg/i ) {
9487 } elsif ( driver_name =~ /^mysql/i ) {
9490 die "don't know how to use regular expressions in ". driver_name. " databases";
9493 my $part_event_option =
9495 'select' => 'part_event_option.*',
9496 'table' => 'part_event_option',
9498 LEFT JOIN part_event USING ( eventpart )
9499 LEFT JOIN part_event_option AS peo_agentnum
9500 ON ( part_event.eventpart = peo_agentnum.eventpart
9501 AND peo_agentnum.optionname = 'agentnum'
9502 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
9504 LEFT JOIN part_event_condition
9505 ON ( part_event.eventpart = part_event_condition.eventpart
9506 AND part_event_condition.conditionname = 'cust_bill_age'
9508 LEFT JOIN part_event_condition_option
9509 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
9510 AND part_event_condition_option.optionname = 'age'
9513 #'hashref' => { 'optionname' => $option },
9514 #'hashref' => { 'part_event_option.optionname' => $option },
9516 " WHERE part_event_option.optionname = ". dbh->quote($option).
9517 " AND action = 'cust_bill_send_agent' ".
9518 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
9519 " AND peo_agentnum.optionname = 'agentnum' ".
9520 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
9522 CASE WHEN part_event_condition_option.optionname IS NULL
9524 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
9526 , part_event.weight".
9530 unless ( $part_event_option ) {
9531 return $self->agent->invoice_template || ''
9532 if $option eq 'agent_templatename';
9536 $part_event_option->optionvalue;
9541 ## actual sub, not a method, designed to be called from the queue.
9542 ## sets up the customer, and calls the bill_and_collect
9543 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
9544 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
9545 $cust_main->bill_and_collect(
9550 sub _upgrade_data { #class method
9551 my ($class, %opts) = @_;
9553 my $sql = 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL';
9554 my $sth = dbh->prepare($sql) or die dbh->errstr;
9555 $sth->execute or die $sth->errstr;
9565 The delete method should possibly take an FS::cust_main object reference
9566 instead of a scalar customer number.
9568 Bill and collect options should probably be passed as references instead of a
9571 There should probably be a configuration file with a list of allowed credit
9574 No multiple currency support (probably a larger project than just this module).
9576 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
9578 Birthdates rely on negative epoch values.
9580 The payby for card/check batches is broken. With mixed batching, bad
9583 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
9587 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
9588 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
9589 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.