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;
3227 my @taxes = qsearch( 'cust_main_county', \%taxhash );
3229 my %taxhash_elim = %taxhash;
3231 my @elim = qw( taxclass city county state );
3232 while ( !scalar(@taxes) && scalar(@elim) ) {
3233 $taxhash_elim{ shift(@elim) } = '';
3234 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
3237 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
3239 if $self->cust_main_exemption; #just to be safe
3241 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3243 $_->set('pkgnum', $cust_pkg->pkgnum );
3244 $_->set('locationnum', $cust_pkg->locationnum );
3248 $taxes{''} = [ @taxes ];
3249 $taxes{'setup'} = [ @taxes ];
3250 $taxes{'recur'} = [ @taxes ];
3251 $taxes{$_} = [ @taxes ] foreach (@classes);
3253 # # maybe eliminate this entirely, along with all the 0% records
3254 # unless ( @taxes ) {
3256 # "fatal: can't find tax rate for state/county/country/taxclass ".
3257 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
3260 } #if $conf->exists('enable_taxproducts') ...
3265 my $separate = $conf->exists('separate_usage');
3266 my $usage_mandate = $cust_pkg->part_pkg->option('usage_mandate', 'Hush!');
3267 if ( $separate || $cust_bill_pkg->hidden || $usage_mandate ) {
3269 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
3270 my %hash = $cust_bill_pkg->hidden # maybe for all bill linked?
3271 ? ( 'section' => $temp_pkg->part_pkg->categoryname )
3274 my $section = $cust_pkg->part_pkg->option('usage_section', 'Hush!');
3275 my $summary = $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
3277 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3278 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
3280 push @display, new FS::cust_bill_pkg_display
3283 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
3287 if ($separate && $section && $summary) {
3288 push @display, new FS::cust_bill_pkg_display { type => 'U',
3293 if ($usage_mandate || $section && $summary) {
3294 $hash{post_total} = 'Y';
3297 $hash{section} = $section if ($separate || $usage_mandate);
3298 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
3301 $cust_bill_pkg->set('display', \@display);
3303 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
3304 foreach my $key (keys %tax_cust_bill_pkg) {
3305 my @taxes = @{ $taxes{$key} || [] };
3306 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
3308 my %localtaxlisthash = ();
3309 foreach my $tax ( @taxes ) {
3311 my $taxname = ref( $tax ). ' '. $tax->taxnum;
3312 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
3313 # ' locationnum'. $cust_pkg->locationnum
3314 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
3316 $taxlisthash->{ $taxname } ||= [ $tax ];
3317 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
3319 $localtaxlisthash{ $taxname } ||= [ $tax ];
3320 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
3324 warn "finding taxed taxes...\n" if $DEBUG > 2;
3325 foreach my $tax ( keys %localtaxlisthash ) {
3326 my $tax_object = shift @{ $localtaxlisthash{$tax} };
3327 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
3329 next unless $tax_object->can('tax_on_tax');
3331 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
3332 my $totname = ref( $tot ). ' '. $tot->taxnum;
3334 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
3336 next unless exists( $localtaxlisthash{ $totname } ); # only increase
3338 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
3339 my $hashref_or_error =
3340 $tax_object->taxline( $localtaxlisthash{$tax},
3341 'custnum' => $self->custnum,
3342 'invoice_time' => $invoice_time,
3344 return $hashref_or_error
3345 unless ref($hashref_or_error);
3347 $taxlisthash->{ $totname } ||= [ $tot ];
3348 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
3360 my $part_pkg = shift;
3364 my $geocode = $self->geocode('cch');
3366 my @taxclassnums = map { $_->taxclassnum }
3367 $part_pkg->part_pkg_taxoverride($class);
3369 unless (@taxclassnums) {
3370 @taxclassnums = map { $_->taxclassnum }
3371 grep { $_->taxable eq 'Y' }
3372 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
3374 warn "Found taxclassnum values of ". join(',', @taxclassnums)
3379 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
3381 @taxes = qsearch({ 'table' => 'tax_rate',
3382 'hashref' => { 'geocode' => $geocode, },
3383 'extra_sql' => $extra_sql,
3385 if scalar(@taxclassnums);
3387 warn "Found taxes ".
3388 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
3395 =item collect [ HASHREF | OPTION => VALUE ... ]
3397 (Attempt to) collect money for this customer's outstanding invoices (see
3398 L<FS::cust_bill>). Usually used after the bill method.
3400 Actions are now triggered by billing events; see L<FS::part_event> and the
3401 billing events web interface. Old-style invoice events (see
3402 L<FS::part_bill_event>) have been deprecated.
3404 If there is an error, returns the error, otherwise returns false.
3406 Options are passed as name-value pairs.
3408 Currently available options are:
3414 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.
3418 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3422 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3426 set true to surpress email card/ACH decline notices.
3430 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)
3436 # allows for one time override of normal customer billing method
3441 my( $self, %options ) = @_;
3442 my $invoice_time = $options{'invoice_time'} || time;
3445 local $SIG{HUP} = 'IGNORE';
3446 local $SIG{INT} = 'IGNORE';
3447 local $SIG{QUIT} = 'IGNORE';
3448 local $SIG{TERM} = 'IGNORE';
3449 local $SIG{TSTP} = 'IGNORE';
3450 local $SIG{PIPE} = 'IGNORE';
3452 my $oldAutoCommit = $FS::UID::AutoCommit;
3453 local $FS::UID::AutoCommit = 0;
3456 $self->select_for_update; #mutex
3459 my $balance = $self->balance;
3460 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
3463 if ( exists($options{'retry_card'}) ) {
3464 carp 'retry_card option passed to collect is deprecated; use retry';
3465 $options{'retry'} ||= $options{'retry_card'};
3467 if ( exists($options{'retry'}) && $options{'retry'} ) {
3468 my $error = $self->retry_realtime;
3470 $dbh->rollback if $oldAutoCommit;
3475 my $error = $self->do_cust_event(
3476 'debug' => ( $options{'debug'} || 0 ),
3477 'time' => $invoice_time,
3478 'check_freq' => $options{'check_freq'},
3479 'stage' => 'collect',
3482 $dbh->rollback if $oldAutoCommit;
3486 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3491 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
3493 Runs billing events; see L<FS::part_event> and the billing events web
3496 If there is an error, returns the error, otherwise returns false.
3498 Options are passed as name-value pairs.
3500 Currently available options are:
3506 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.
3510 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3514 "collect" (the default) or "pre-bill"
3518 set true to surpress email card/ACH decline notices.
3522 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)
3528 # allows for one time override of normal customer billing method
3532 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3535 my( $self, %options ) = @_;
3536 my $time = $options{'time'} || time;
3539 local $SIG{HUP} = 'IGNORE';
3540 local $SIG{INT} = 'IGNORE';
3541 local $SIG{QUIT} = 'IGNORE';
3542 local $SIG{TERM} = 'IGNORE';
3543 local $SIG{TSTP} = 'IGNORE';
3544 local $SIG{PIPE} = 'IGNORE';
3546 my $oldAutoCommit = $FS::UID::AutoCommit;
3547 local $FS::UID::AutoCommit = 0;
3550 $self->select_for_update; #mutex
3553 my $balance = $self->balance;
3554 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
3557 # if ( exists($options{'retry_card'}) ) {
3558 # carp 'retry_card option passed to collect is deprecated; use retry';
3559 # $options{'retry'} ||= $options{'retry_card'};
3561 # if ( exists($options{'retry'}) && $options{'retry'} ) {
3562 # my $error = $self->retry_realtime;
3564 # $dbh->rollback if $oldAutoCommit;
3569 # false laziness w/pay_batch::import_results
3571 my $due_cust_event = $self->due_cust_event(
3572 'debug' => ( $options{'debug'} || 0 ),
3574 'check_freq' => $options{'check_freq'},
3575 'stage' => ( $options{'stage'} || 'collect' ),
3577 unless( ref($due_cust_event) ) {
3578 $dbh->rollback if $oldAutoCommit;
3579 return $due_cust_event;
3582 foreach my $cust_event ( @$due_cust_event ) {
3586 #re-eval event conditions (a previous event could have changed things)
3587 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
3588 #don't leave stray "new/locked" records around
3589 my $error = $cust_event->delete;
3591 #gah, even with transactions
3592 $dbh->commit if $oldAutoCommit; #well.
3599 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
3600 warn " running cust_event ". $cust_event->eventnum. "\n"
3604 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
3605 if ( my $error = $cust_event->do_event() ) {
3606 #XXX wtf is this? figure out a proper dealio with return value
3608 # gah, even with transactions.
3609 $dbh->commit if $oldAutoCommit; #well.
3616 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3621 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
3623 Inserts database records for and returns an ordered listref of new events due
3624 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
3625 events are due, an empty listref is returned. If there is an error, returns a
3626 scalar error message.
3628 To actually run the events, call each event's test_condition method, and if
3629 still true, call the event's do_event method.
3631 Options are passed as a hashref or as a list of name-value pairs. Available
3638 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.
3642 "collect" (the default) or "pre-bill"
3646 "Current time" for the events.
3650 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)
3654 Only return events for the specified eventtable (by default, events of all eventtables are returned)
3658 Explicitly pass the objects to be tested (typically used with eventtable).
3662 Set to true to return the objects, but not actually insert them into the
3669 sub due_cust_event {
3671 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
3674 #my $DEBUG = $opt{'debug'}
3675 local($DEBUG) = $opt{'debug'}
3676 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
3678 warn "$me due_cust_event called with options ".
3679 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
3682 $opt{'time'} ||= time;
3684 local $SIG{HUP} = 'IGNORE';
3685 local $SIG{INT} = 'IGNORE';
3686 local $SIG{QUIT} = 'IGNORE';
3687 local $SIG{TERM} = 'IGNORE';
3688 local $SIG{TSTP} = 'IGNORE';
3689 local $SIG{PIPE} = 'IGNORE';
3691 my $oldAutoCommit = $FS::UID::AutoCommit;
3692 local $FS::UID::AutoCommit = 0;
3695 $self->select_for_update #mutex
3696 unless $opt{testonly};
3699 # find possible events (initial search)
3702 my @cust_event = ();
3704 my @eventtable = $opt{'eventtable'}
3705 ? ( $opt{'eventtable'} )
3706 : FS::part_event->eventtables_runorder;
3708 foreach my $eventtable ( @eventtable ) {
3711 if ( $opt{'objects'} ) {
3713 @objects = @{ $opt{'objects'} };
3717 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
3718 @objects = ( $eventtable eq 'cust_main' )
3720 : ( $self->$eventtable() );
3724 my @e_cust_event = ();
3726 my $cross = "CROSS JOIN $eventtable";
3727 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
3728 unless $eventtable eq 'cust_main';
3730 foreach my $object ( @objects ) {
3732 #this first search uses the condition_sql magic for optimization.
3733 #the more possible events we can eliminate in this step the better
3735 my $cross_where = '';
3736 my $pkey = $object->primary_key;
3737 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
3739 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
3741 FS::part_event_condition->where_conditions_sql( $eventtable,
3742 'time'=>$opt{'time'}
3744 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
3746 $extra_sql = "AND $extra_sql" if $extra_sql;
3748 #here is the agent virtualization
3749 $extra_sql .= " AND ( part_event.agentnum IS NULL
3750 OR part_event.agentnum = ". $self->agentnum. ' )';
3752 $extra_sql .= " $order";
3754 warn "searching for events for $eventtable ". $object->$pkey. "\n"
3755 if $opt{'debug'} > 2;
3756 my @part_event = qsearch( {
3757 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
3758 'select' => 'part_event.*',
3759 'table' => 'part_event',
3760 'addl_from' => "$cross $join",
3761 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
3762 'eventtable' => $eventtable,
3765 'extra_sql' => "AND $cross_where $extra_sql",
3769 my $pkey = $object->primary_key;
3770 warn " ". scalar(@part_event).
3771 " possible events found for $eventtable ". $object->$pkey(). "\n";
3774 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
3778 warn " ". scalar(@e_cust_event).
3779 " subtotal possible cust events found for $eventtable\n"
3782 push @cust_event, @e_cust_event;
3786 warn " ". scalar(@cust_event).
3787 " total possible cust events found in initial search\n"
3795 $opt{stage} ||= 'collect';
3797 grep { my $stage = $_->part_event->event_stage;
3798 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
3808 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
3809 'stats_hashref' => \%unsat ),
3812 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
3815 warn " invalid conditions not eliminated with condition_sql:\n".
3816 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
3823 unless( $opt{testonly} ) {
3824 foreach my $cust_event ( @cust_event ) {
3826 my $error = $cust_event->insert();
3828 $dbh->rollback if $oldAutoCommit;
3835 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3841 warn " returning events: ". Dumper(@cust_event). "\n"
3848 =item retry_realtime
3850 Schedules realtime / batch credit card / electronic check / LEC billing
3851 events for for retry. Useful if card information has changed or manual
3852 retry is desired. The 'collect' method must be called to actually retry
3855 Implementation details: For either this customer, or for each of this
3856 customer's open invoices, changes the status of the first "done" (with
3857 statustext error) realtime processing event to "failed".
3861 sub retry_realtime {
3864 local $SIG{HUP} = 'IGNORE';
3865 local $SIG{INT} = 'IGNORE';
3866 local $SIG{QUIT} = 'IGNORE';
3867 local $SIG{TERM} = 'IGNORE';
3868 local $SIG{TSTP} = 'IGNORE';
3869 local $SIG{PIPE} = 'IGNORE';
3871 my $oldAutoCommit = $FS::UID::AutoCommit;
3872 local $FS::UID::AutoCommit = 0;
3875 #a little false laziness w/due_cust_event (not too bad, really)
3877 my $join = FS::part_event_condition->join_conditions_sql;
3878 my $order = FS::part_event_condition->order_conditions_sql;
3881 . join ( ' OR ' , map {
3882 "( part_event.eventtable = " . dbh->quote($_)
3883 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
3884 } FS::part_event->eventtables)
3887 #here is the agent virtualization
3888 my $agent_virt = " ( part_event.agentnum IS NULL
3889 OR part_event.agentnum = ". $self->agentnum. ' )';
3891 #XXX this shouldn't be hardcoded, actions should declare it...
3892 my @realtime_events = qw(
3893 cust_bill_realtime_card
3894 cust_bill_realtime_check
3895 cust_bill_realtime_lec
3899 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
3904 my @cust_event = qsearchs({
3905 'table' => 'cust_event',
3906 'select' => 'cust_event.*',
3907 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
3908 'hashref' => { 'status' => 'done' },
3909 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
3910 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
3913 my %seen_invnum = ();
3914 foreach my $cust_event (@cust_event) {
3916 #max one for the customer, one for each open invoice
3917 my $cust_X = $cust_event->cust_X;
3918 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
3922 or $cust_event->part_event->eventtable eq 'cust_bill'
3925 my $error = $cust_event->retry;
3927 $dbh->rollback if $oldAutoCommit;
3928 return "error scheduling event for retry: $error";
3933 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3938 # some horrid false laziness here to avoid refactor fallout
3939 # eventually realtime realtime_bop and realtime_refund_bop should go
3940 # away and be replaced by _new_realtime_bop and _new_realtime_refund_bop
3942 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
3944 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
3945 via a Business::OnlinePayment realtime gateway. See
3946 L<http://420.am/business-onlinepayment> for supported gateways.
3948 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3950 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
3952 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3953 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3954 if set, will override the value from the customer record.
3956 I<description> is a free-text field passed to the gateway. It defaults to
3957 "Internet services".
3959 If an I<invnum> is specified, this payment (if successful) is applied to the
3960 specified invoice. If you don't specify an I<invnum> you might want to
3961 call the B<apply_payments> method or set the I<apply> option.
3963 I<apply> can be set to true to apply a resulting payment.
3965 I<quiet> can be set true to surpress email decline notices.
3967 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
3968 resulting paynum, if any.
3970 I<payunique> is a unique identifier for this payment.
3972 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
3979 return $self->_new_realtime_bop(@_)
3980 if $self->_new_bop_required();
3982 my($method, $amount);
3984 if (ref($_[0]) eq 'HASH') {
3985 %options = %{$_[0]};
3986 $method = $options{method};
3987 $amount = $options{amount};
3989 ( $method, $amount ) = ( shift, shift );
3993 warn "$me realtime_bop: $method $amount\n";
3994 warn " $_ => $options{$_}\n" foreach keys %options;
3997 $options{'description'} ||= 'Internet services';
3999 return $self->fake_bop($method, $amount, %options) if $options{'fake'};
4001 eval "use Business::OnlinePayment";
4004 my $payinfo = exists($options{'payinfo'})
4005 ? $options{'payinfo'}
4008 my %method2payby = (
4015 # check for banned credit card/ACH
4018 my $ban = qsearchs('banned_pay', {
4019 'payby' => $method2payby{$method},
4020 'payinfo' => md5_base64($payinfo),
4022 return "Banned credit card" if $ban;
4025 # set taxclass and trans_is_recur based on invnum if there is one
4029 my $trans_is_recur = 0;
4030 if ( $options{'invnum'} ) {
4032 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
4033 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
4036 map { $_->part_pkg }
4038 map { $_->cust_pkg }
4039 $cust_bill->cust_bill_pkg;
4041 my @taxclasses = map $_->taxclass, @part_pkg;
4042 $taxclass = $taxclasses[0]
4043 unless grep { $taxclasses[0] ne $_ } @taxclasses; #unless there are
4044 #different taxclasses
4046 if grep { $_->freq ne '0' } @part_pkg;
4054 #look for an agent gateway override first
4056 if ( $method eq 'CC' ) {
4057 $cardtype = cardtype($payinfo);
4058 } elsif ( $method eq 'ECHECK' ) {
4061 $cardtype = $method;
4065 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4066 cardtype => $cardtype,
4067 taxclass => $taxclass, } )
4068 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4070 taxclass => $taxclass, } )
4071 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4072 cardtype => $cardtype,
4074 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4076 taxclass => '', } );
4078 my $payment_gateway = '';
4079 my( $processor, $login, $password, $action, @bop_options );
4080 if ( $override ) { #use a payment gateway override
4082 $payment_gateway = $override->payment_gateway;
4084 $processor = $payment_gateway->gateway_module;
4085 $login = $payment_gateway->gateway_username;
4086 $password = $payment_gateway->gateway_password;
4087 $action = $payment_gateway->gateway_action;
4088 @bop_options = $payment_gateway->options;
4090 } else { #use the standard settings from the config
4092 ( $processor, $login, $password, $action, @bop_options ) =
4093 $self->default_payment_gateway($method);
4101 my $address = exists($options{'address1'})
4102 ? $options{'address1'}
4104 my $address2 = exists($options{'address2'})
4105 ? $options{'address2'}
4107 $address .= ", ". $address2 if length($address2);
4109 my $o_payname = exists($options{'payname'})
4110 ? $options{'payname'}
4112 my($payname, $payfirst, $paylast);
4113 if ( $o_payname && $method ne 'ECHECK' ) {
4114 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4115 or return "Illegal payname $payname";
4116 ($payfirst, $paylast) = ($1, $2);
4118 $payfirst = $self->getfield('first');
4119 $paylast = $self->getfield('last');
4120 $payname = "$payfirst $paylast";
4123 my @invoicing_list = $self->invoicing_list_emailonly;
4124 if ( $conf->exists('emailinvoiceautoalways')
4125 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4126 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4127 push @invoicing_list, $self->all_emails;
4130 my $email = ($conf->exists('business-onlinepayment-email-override'))
4131 ? $conf->config('business-onlinepayment-email-override')
4132 : $invoicing_list[0];
4136 my $payip = exists($options{'payip'})
4139 $content{customer_ip} = $payip
4142 $content{invoice_number} = $options{'invnum'}
4143 if exists($options{'invnum'}) && length($options{'invnum'});
4145 $content{email_customer} =
4146 ( $conf->exists('business-onlinepayment-email_customer')
4147 || $conf->exists('business-onlinepayment-email-override') );
4150 if ( $method eq 'CC' ) {
4152 $content{card_number} = $payinfo;
4153 $paydate = exists($options{'paydate'})
4154 ? $options{'paydate'}
4156 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4157 $content{expiration} = "$2/$1";
4159 my $paycvv = exists($options{'paycvv'})
4160 ? $options{'paycvv'}
4162 $content{cvv2} = $paycvv
4165 my $paystart_month = exists($options{'paystart_month'})
4166 ? $options{'paystart_month'}
4167 : $self->paystart_month;
4169 my $paystart_year = exists($options{'paystart_year'})
4170 ? $options{'paystart_year'}
4171 : $self->paystart_year;
4173 $content{card_start} = "$paystart_month/$paystart_year"
4174 if $paystart_month && $paystart_year;
4176 my $payissue = exists($options{'payissue'})
4177 ? $options{'payissue'}
4179 $content{issue_number} = $payissue if $payissue;
4181 if ( $self->_bop_recurring_billing( 'payinfo' => $payinfo,
4182 'trans_is_recur' => $trans_is_recur,
4186 $content{recurring_billing} = 'YES';
4187 $content{acct_code} = 'rebill'
4188 if $conf->exists('credit_card-recurring_billing_acct_code');
4191 } elsif ( $method eq 'ECHECK' ) {
4192 ( $content{account_number}, $content{routing_code} ) =
4193 split('@', $payinfo);
4194 $content{bank_name} = $o_payname;
4195 $content{bank_state} = exists($options{'paystate'})
4196 ? $options{'paystate'}
4197 : $self->getfield('paystate');
4198 $content{account_type} = exists($options{'paytype'})
4199 ? uc($options{'paytype'}) || 'CHECKING'
4200 : uc($self->getfield('paytype')) || 'CHECKING';
4201 $content{account_name} = $payname;
4202 $content{customer_org} = $self->company ? 'B' : 'I';
4203 $content{state_id} = exists($options{'stateid'})
4204 ? $options{'stateid'}
4205 : $self->getfield('stateid');
4206 $content{state_id_state} = exists($options{'stateid_state'})
4207 ? $options{'stateid_state'}
4208 : $self->getfield('stateid_state');
4209 $content{customer_ssn} = exists($options{'ss'})
4212 } elsif ( $method eq 'LEC' ) {
4213 $content{phone} = $payinfo;
4217 # run transaction(s)
4220 my $balance = exists( $options{'balance'} )
4221 ? $options{'balance'}
4224 $self->select_for_update; #mutex ... just until we get our pending record in
4226 #the checks here are intended to catch concurrent payments
4227 #double-form-submission prevention is taken care of in cust_pay_pending::check
4230 return "The customer's balance has changed; $method transaction aborted."
4231 if $self->balance < $balance;
4232 #&& $self->balance < $amount; #might as well anyway?
4234 #also check and make sure there aren't *other* pending payments for this cust
4236 my @pending = qsearch('cust_pay_pending', {
4237 'custnum' => $self->custnum,
4238 'status' => { op=>'!=', value=>'done' }
4240 return "A payment is already being processed for this customer (".
4241 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
4242 "); $method transaction aborted."
4243 if scalar(@pending);
4245 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
4247 my $cust_pay_pending = new FS::cust_pay_pending {
4248 'custnum' => $self->custnum,
4249 #'invnum' => $options{'invnum'},
4252 'payby' => $method2payby{$method},
4253 'payinfo' => $payinfo,
4254 'paydate' => $paydate,
4255 'recurring_billing' => $content{recurring_billing},
4256 'pkgnum' => $options{'pkgnum'},
4258 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
4260 $cust_pay_pending->payunique( $options{payunique} )
4261 if defined($options{payunique}) && length($options{payunique});
4262 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
4263 return $cpp_new_err if $cpp_new_err;
4265 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
4267 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
4268 $transaction->content(
4271 'password' => $password,
4272 'action' => $action1,
4273 'description' => $options{'description'},
4274 'amount' => $amount,
4275 #'invoice_number' => $options{'invnum'},
4276 'customer_id' => $self->custnum,
4277 'last_name' => $paylast,
4278 'first_name' => $payfirst,
4280 'address' => $address,
4281 'city' => ( exists($options{'city'})
4284 'state' => ( exists($options{'state'})
4287 'zip' => ( exists($options{'zip'})
4290 'country' => ( exists($options{'country'})
4291 ? $options{'country'}
4293 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4295 'phone' => $self->daytime || $self->night,
4299 $cust_pay_pending->status('pending');
4300 my $cpp_pending_err = $cust_pay_pending->replace;
4301 return $cpp_pending_err if $cpp_pending_err;
4304 my $BOP_TESTING = 0;
4305 my $BOP_TESTING_SUCCESS = 1;
4307 unless ( $BOP_TESTING ) {
4308 $transaction->submit();
4310 if ( $BOP_TESTING_SUCCESS ) {
4311 $transaction->is_success(1);
4312 $transaction->authorization('fake auth');
4314 $transaction->is_success(0);
4315 $transaction->error_message('fake failure');
4319 if ( $transaction->is_success() && $action2 ) {
4321 $cust_pay_pending->status('authorized');
4322 my $cpp_authorized_err = $cust_pay_pending->replace;
4323 return $cpp_authorized_err if $cpp_authorized_err;
4325 my $auth = $transaction->authorization;
4326 my $ordernum = $transaction->can('order_number')
4327 ? $transaction->order_number
4331 new Business::OnlinePayment( $processor, @bop_options );
4338 password => $password,
4339 order_number => $ordernum,
4341 authorization => $auth,
4342 description => $options{'description'},
4345 foreach my $field (qw( authorization_source_code returned_ACI
4346 transaction_identifier validation_code
4347 transaction_sequence_num local_transaction_date
4348 local_transaction_time AVS_result_code )) {
4349 $capture{$field} = $transaction->$field() if $transaction->can($field);
4352 $capture->content( %capture );
4356 unless ( $capture->is_success ) {
4357 my $e = "Authorization successful but capture failed, custnum #".
4358 $self->custnum. ': '. $capture->result_code.
4359 ": ". $capture->error_message;
4366 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
4367 my $cpp_captured_err = $cust_pay_pending->replace;
4368 return $cpp_captured_err if $cpp_captured_err;
4371 # remove paycvv after initial transaction
4374 #false laziness w/misc/process/payment.cgi - check both to make sure working
4376 if ( defined $self->dbdef_table->column('paycvv')
4377 && length($self->paycvv)
4378 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
4380 my $error = $self->remove_cvv;
4382 warn "WARNING: error removing cvv: $error\n";
4390 if ( $transaction->is_success() ) {
4393 if ( $payment_gateway ) { # agent override
4394 $paybatch = $payment_gateway->gatewaynum. '-';
4397 $paybatch .= "$processor:". $transaction->authorization;
4399 $paybatch .= ':'. $transaction->order_number
4400 if $transaction->can('order_number')
4401 && length($transaction->order_number);
4403 my $cust_pay = new FS::cust_pay ( {
4404 'custnum' => $self->custnum,
4405 'invnum' => $options{'invnum'},
4408 'payby' => $method2payby{$method},
4409 'payinfo' => $payinfo,
4410 'paybatch' => $paybatch,
4411 'paydate' => $paydate,
4412 'pkgnum' => $options{'pkgnum'},
4414 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
4415 $cust_pay->payunique( $options{payunique} )
4416 if defined($options{payunique}) && length($options{payunique});
4418 my $oldAutoCommit = $FS::UID::AutoCommit;
4419 local $FS::UID::AutoCommit = 0;
4422 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
4424 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
4427 $cust_pay->invnum(''); #try again with no specific invnum
4428 my $error2 = $cust_pay->insert( $options{'manual'} ?
4429 ( 'manual' => 1 ) : ()
4432 # gah. but at least we have a record of the state we had to abort in
4433 # from cust_pay_pending now.
4434 my $e = "WARNING: $method captured but payment not recorded - ".
4435 "error inserting payment ($processor): $error2".
4436 " (previously tried insert with invnum #$options{'invnum'}" .
4437 ": $error ) - pending payment saved as paypendingnum ".
4438 $cust_pay_pending->paypendingnum. "\n";
4444 if ( $options{'paynum_ref'} ) {
4445 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
4448 $cust_pay_pending->status('done');
4449 $cust_pay_pending->statustext('captured');
4450 $cust_pay_pending->paynum($cust_pay->paynum);
4451 my $cpp_done_err = $cust_pay_pending->replace;
4453 if ( $cpp_done_err ) {
4455 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4456 my $e = "WARNING: $method captured but payment not recorded - ".
4457 "error updating status for paypendingnum ".
4458 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4464 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4466 if ( $options{'apply'} ) {
4467 my $apply_error = $self->apply_payments_and_credits;
4468 if ( $apply_error ) {
4469 warn "WARNING: error applying payment: $apply_error\n";
4470 #but we still should return no error cause the payment otherwise went
4475 return ''; #no error
4481 my $perror = "$processor error: ". $transaction->error_message;
4483 unless ( $transaction->error_message ) {
4486 if ( $transaction->can('response_page') ) {
4488 'page' => ( $transaction->can('response_page')
4489 ? $transaction->response_page
4492 'code' => ( $transaction->can('response_code')
4493 ? $transaction->response_code
4496 'headers' => ( $transaction->can('response_headers')
4497 ? $transaction->response_headers
4503 "No additional debugging information available for $processor";
4506 $perror .= "No error_message returned from $processor -- ".
4507 ( ref($t_response) ? Dumper($t_response) : $t_response );
4511 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
4512 && $conf->exists('emaildecline')
4513 && grep { $_ ne 'POST' } $self->invoicing_list
4514 && ! grep { $transaction->error_message =~ /$_/ }
4515 $conf->config('emaildecline-exclude')
4517 my @templ = $conf->config('declinetemplate');
4518 my $template = new Text::Template (
4520 SOURCE => [ map "$_\n", @templ ],
4521 ) or return "($perror) can't create template: $Text::Template::ERROR";
4522 $template->compile()
4523 or return "($perror) can't compile template: $Text::Template::ERROR";
4527 scalar( $conf->config('company_name', $self->agentnum ) ),
4528 'company_address' =>
4529 join("\n", $conf->config('company_address', $self->agentnum ) ),
4530 'error' => $transaction->error_message,
4533 my $error = send_email(
4534 'from' => $conf->config('invoice_from', $self->agentnum ),
4535 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
4536 'subject' => 'Your payment could not be processed',
4537 'body' => [ $template->fill_in(HASH => $templ_hash) ],
4540 $perror .= " (also received error sending decline notification: $error)"
4545 $cust_pay_pending->status('done');
4546 $cust_pay_pending->statustext("declined: $perror");
4547 my $cpp_done_err = $cust_pay_pending->replace;
4548 if ( $cpp_done_err ) {
4549 my $e = "WARNING: $method declined but pending payment not resolved - ".
4550 "error updating status for paypendingnum ".
4551 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4553 $perror = "$e ($perror)";
4561 sub _bop_recurring_billing {
4562 my( $self, %opt ) = @_;
4564 my $method = scalar($conf->config('credit_card-recurring_billing_flag'));
4566 if ( defined($method) && $method eq 'transaction_is_recur' ) {
4568 return 1 if $opt{'trans_is_recur'};
4572 my %hash = ( 'custnum' => $self->custnum,
4577 if qsearch('cust_pay', { %hash, 'payinfo' => $opt{'payinfo'} } )
4578 || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo('CARD',
4589 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
4591 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
4592 via a Business::OnlinePayment realtime gateway. See
4593 L<http://420.am/business-onlinepayment> for supported gateways.
4595 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4597 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
4599 Most gateways require a reference to an original payment transaction to refund,
4600 so you probably need to specify a I<paynum>.
4602 I<amount> defaults to the original amount of the payment if not specified.
4604 I<reason> specifies a reason for the refund.
4606 I<paydate> specifies the expiration date for a credit card overriding the
4607 value from the customer record or the payment record. Specified as yyyy-mm-dd
4609 Implementation note: If I<amount> is unspecified or equal to the amount of the
4610 orignal payment, first an attempt is made to "void" the transaction via
4611 the gateway (to cancel a not-yet settled transaction) and then if that fails,
4612 the normal attempt is made to "refund" ("credit") the transaction via the
4613 gateway is attempted.
4615 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4616 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4617 #if set, will override the value from the customer record.
4619 #If an I<invnum> is specified, this payment (if successful) is applied to the
4620 #specified invoice. If you don't specify an I<invnum> you might want to
4621 #call the B<apply_payments> method.
4625 #some false laziness w/realtime_bop, not enough to make it worth merging
4626 #but some useful small subs should be pulled out
4627 sub realtime_refund_bop {
4630 return $self->_new_realtime_refund_bop(@_)
4631 if $self->_new_bop_required();
4633 my( $method, %options ) = @_;
4635 warn "$me realtime_refund_bop: $method refund\n";
4636 warn " $_ => $options{$_}\n" foreach keys %options;
4639 eval "use Business::OnlinePayment";
4643 # look up the original payment and optionally a gateway for that payment
4647 my $amount = $options{'amount'};
4649 my( $processor, $login, $password, @bop_options ) ;
4650 my( $auth, $order_number ) = ( '', '', '' );
4652 if ( $options{'paynum'} ) {
4654 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
4655 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
4656 or return "Unknown paynum $options{'paynum'}";
4657 $amount ||= $cust_pay->paid;
4659 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
4660 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
4661 $cust_pay->paybatch;
4662 my $gatewaynum = '';
4663 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
4665 if ( $gatewaynum ) { #gateway for the payment to be refunded
4667 my $payment_gateway =
4668 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
4669 die "payment gateway $gatewaynum not found"
4670 unless $payment_gateway;
4672 $processor = $payment_gateway->gateway_module;
4673 $login = $payment_gateway->gateway_username;
4674 $password = $payment_gateway->gateway_password;
4675 @bop_options = $payment_gateway->options;
4677 } else { #try the default gateway
4679 my( $conf_processor, $unused_action );
4680 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
4681 $self->default_payment_gateway($method);
4683 return "processor of payment $options{'paynum'} $processor does not".
4684 " match default processor $conf_processor"
4685 unless $processor eq $conf_processor;
4690 } else { # didn't specify a paynum, so look for agent gateway overrides
4691 # like a normal transaction
4694 if ( $method eq 'CC' ) {
4695 $cardtype = cardtype($self->payinfo);
4696 } elsif ( $method eq 'ECHECK' ) {
4699 $cardtype = $method;
4702 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4703 cardtype => $cardtype,
4705 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4707 taxclass => '', } );
4709 if ( $override ) { #use a payment gateway override
4711 my $payment_gateway = $override->payment_gateway;
4713 $processor = $payment_gateway->gateway_module;
4714 $login = $payment_gateway->gateway_username;
4715 $password = $payment_gateway->gateway_password;
4716 #$action = $payment_gateway->gateway_action;
4717 @bop_options = $payment_gateway->options;
4719 } else { #use the standard settings from the config
4722 ( $processor, $login, $password, $unused_action, @bop_options ) =
4723 $self->default_payment_gateway($method);
4728 return "neither amount nor paynum specified" unless $amount;
4733 'password' => $password,
4734 'order_number' => $order_number,
4735 'amount' => $amount,
4736 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4738 $content{authorization} = $auth
4739 if length($auth); #echeck/ACH transactions have an order # but no auth
4740 #(at least with authorize.net)
4742 my $disable_void_after;
4743 if ($conf->exists('disable_void_after')
4744 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
4745 $disable_void_after = $1;
4748 #first try void if applicable
4749 if ( $cust_pay && $cust_pay->paid == $amount
4751 ( not defined($disable_void_after) )
4752 || ( time < ($cust_pay->_date + $disable_void_after ) )
4755 warn " attempting void\n" if $DEBUG > 1;
4756 my $void = new Business::OnlinePayment( $processor, @bop_options );
4757 $void->content( 'action' => 'void', %content );
4759 if ( $void->is_success ) {
4760 my $error = $cust_pay->void($options{'reason'});
4762 # gah, even with transactions.
4763 my $e = 'WARNING: Card/ACH voided but database not updated - '.
4764 "error voiding payment: $error";
4768 warn " void successful\n" if $DEBUG > 1;
4773 warn " void unsuccessful, trying refund\n"
4777 my $address = $self->address1;
4778 $address .= ", ". $self->address2 if $self->address2;
4780 my($payname, $payfirst, $paylast);
4781 if ( $self->payname && $method ne 'ECHECK' ) {
4782 $payname = $self->payname;
4783 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4784 or return "Illegal payname $payname";
4785 ($payfirst, $paylast) = ($1, $2);
4787 $payfirst = $self->getfield('first');
4788 $paylast = $self->getfield('last');
4789 $payname = "$payfirst $paylast";
4792 my @invoicing_list = $self->invoicing_list_emailonly;
4793 if ( $conf->exists('emailinvoiceautoalways')
4794 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4795 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4796 push @invoicing_list, $self->all_emails;
4799 my $email = ($conf->exists('business-onlinepayment-email-override'))
4800 ? $conf->config('business-onlinepayment-email-override')
4801 : $invoicing_list[0];
4803 my $payip = exists($options{'payip'})
4806 $content{customer_ip} = $payip
4810 if ( $method eq 'CC' ) {
4813 $content{card_number} = $payinfo = $cust_pay->payinfo;
4814 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
4815 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
4816 ($content{expiration} = "$2/$1"); # where available
4818 $content{card_number} = $payinfo = $self->payinfo;
4819 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
4820 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4821 $content{expiration} = "$2/$1";
4824 } elsif ( $method eq 'ECHECK' ) {
4827 $payinfo = $cust_pay->payinfo;
4829 $payinfo = $self->payinfo;
4831 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
4832 $content{bank_name} = $self->payname;
4833 $content{account_type} = 'CHECKING';
4834 $content{account_name} = $payname;
4835 $content{customer_org} = $self->company ? 'B' : 'I';
4836 $content{customer_ssn} = $self->ss;
4837 } elsif ( $method eq 'LEC' ) {
4838 $content{phone} = $payinfo = $self->payinfo;
4842 my $refund = new Business::OnlinePayment( $processor, @bop_options );
4843 my %sub_content = $refund->content(
4844 'action' => 'credit',
4845 'customer_id' => $self->custnum,
4846 'last_name' => $paylast,
4847 'first_name' => $payfirst,
4849 'address' => $address,
4850 'city' => $self->city,
4851 'state' => $self->state,
4852 'zip' => $self->zip,
4853 'country' => $self->country,
4855 'phone' => $self->daytime || $self->night,
4858 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
4862 return "$processor error: ". $refund->error_message
4863 unless $refund->is_success();
4865 my %method2payby = (
4871 my $paybatch = "$processor:". $refund->authorization;
4872 $paybatch .= ':'. $refund->order_number
4873 if $refund->can('order_number') && $refund->order_number;
4875 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
4876 my @cust_bill_pay = $cust_pay->cust_bill_pay;
4877 last unless @cust_bill_pay;
4878 my $cust_bill_pay = pop @cust_bill_pay;
4879 my $error = $cust_bill_pay->delete;
4883 my $cust_refund = new FS::cust_refund ( {
4884 'custnum' => $self->custnum,
4885 'paynum' => $options{'paynum'},
4886 'refund' => $amount,
4888 'payby' => $method2payby{$method},
4889 'payinfo' => $payinfo,
4890 'paybatch' => $paybatch,
4891 'reason' => $options{'reason'} || 'card or ACH refund',
4893 my $error = $cust_refund->insert;
4895 $cust_refund->paynum(''); #try again with no specific paynum
4896 my $error2 = $cust_refund->insert;
4898 # gah, even with transactions.
4899 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
4900 "error inserting refund ($processor): $error2".
4901 " (previously tried insert with paynum #$options{'paynum'}" .
4912 # does the configuration indicate the new bop routines are required?
4914 sub _new_bop_required {
4917 my $botpp = 'Business::OnlineThirdPartyPayment';
4920 if ( $conf->config('business-onlinepayment-namespace') eq $botpp ||
4921 scalar( grep { $_->gateway_namespace eq $botpp }
4922 qsearch( 'payment_gateway', { 'disabled' => '' } )
4930 =item realtime_collect [ OPTION => VALUE ... ]
4932 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4933 via a Business::OnlinePayment or Business::OnlineThirdPartyPayment realtime
4934 gateway. See L<http://420.am/business-onlinepayment> and
4935 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
4937 On failure returns an error message.
4939 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.
4941 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>, I<pkgnum>
4943 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>. If none is specified
4944 then it is deduced from the customer record.
4946 If no I<amount> is specified, then the customer balance is used.
4948 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4949 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4950 if set, will override the value from the customer record.
4952 I<description> is a free-text field passed to the gateway. It defaults to
4953 "Internet services".
4955 If an I<invnum> is specified, this payment (if successful) is applied to the
4956 specified invoice. If you don't specify an I<invnum> you might want to
4957 call the B<apply_payments> method or set the I<apply> option.
4959 I<apply> can be set to true to apply a resulting payment.
4961 I<quiet> can be set true to surpress email decline notices.
4963 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4964 resulting paynum, if any.
4966 I<payunique> is a unique identifier for this payment.
4968 I<session_id> is a session identifier associated with this payment.
4970 I<depend_jobnum> allows payment capture to unlock export jobs
4974 sub realtime_collect {
4975 my( $self, %options ) = @_;
4978 warn "$me realtime_collect:\n";
4979 warn " $_ => $options{$_}\n" foreach keys %options;
4982 $options{amount} = $self->balance unless exists( $options{amount} );
4983 $options{method} = FS::payby->payby2bop($self->payby)
4984 unless exists( $options{method} );
4986 return $self->realtime_bop({%options});
4990 =item _realtime_bop { [ ARG => VALUE ... ] }
4992 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4993 via a Business::OnlinePayment realtime gateway. See
4994 L<http://420.am/business-onlinepayment> for supported gateways.
4996 Required arguments in the hashref are I<method>, and I<amount>
4998 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5000 Available optional arguments are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
5002 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5003 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5004 if set, will override the value from the customer record.
5006 I<description> is a free-text field passed to the gateway. It defaults to
5007 "Internet services".
5009 If an I<invnum> is specified, this payment (if successful) is applied to the
5010 specified invoice. If you don't specify an I<invnum> you might want to
5011 call the B<apply_payments> method.
5013 I<quiet> can be set true to surpress email decline notices.
5015 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5016 resulting paynum, if any.
5018 I<payunique> is a unique identifier for this payment.
5020 I<session_id> is a session identifier associated with this payment.
5022 I<depend_jobnum> allows payment capture to unlock export jobs
5024 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
5028 # some helper routines
5029 sub _payment_gateway {
5030 my ($self, $options) = @_;
5032 $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
5033 unless exists($options->{payment_gateway});
5035 $options->{payment_gateway};
5039 my ($self, $options) = @_;
5042 'login' => $options->{payment_gateway}->gateway_username,
5043 'password' => $options->{payment_gateway}->gateway_password,
5048 my ($self, $options) = @_;
5050 $options->{payment_gateway}->gatewaynum
5051 ? $options->{payment_gateway}->options
5052 : @{ $options->{payment_gateway}->get('options') };
5056 my ($self, $options) = @_;
5058 $options->{description} ||= 'Internet services';
5059 $options->{payinfo} = $self->payinfo unless exists( $options->{payinfo} );
5060 $options->{invnum} ||= '';
5061 $options->{payname} = $self->payname unless exists( $options->{payname} );
5065 my ($self, $options) = @_;
5068 $content{address} = exists($options->{'address1'})
5069 ? $options->{'address1'}
5071 my $address2 = exists($options->{'address2'})
5072 ? $options->{'address2'}
5074 $content{address} .= ", ". $address2 if length($address2);
5076 my $payip = exists($options->{'payip'}) ? $options->{'payip'} : $self->payip;
5077 $content{customer_ip} = $payip if length($payip);
5079 $content{invoice_number} = $options->{'invnum'}
5080 if exists($options->{'invnum'}) && length($options->{'invnum'});
5082 $content{email_customer} =
5083 ( $conf->exists('business-onlinepayment-email_customer')
5084 || $conf->exists('business-onlinepayment-email-override') );
5086 $content{payfirst} = $self->getfield('first');
5087 $content{paylast} = $self->getfield('last');
5089 $content{account_name} = "$content{payfirst} $content{paylast}"
5090 if $options->{method} eq 'ECHECK';
5092 $content{name} = $options->{payname};
5093 $content{name} = $content{account_name} if exists($content{account_name});
5095 $content{city} = exists($options->{city})
5098 $content{state} = exists($options->{state})
5101 $content{zip} = exists($options->{zip})
5104 $content{country} = exists($options->{country})
5105 ? $options->{country}
5107 $content{referer} = 'http://cleanwhisker.420.am/'; #XXX fix referer :/
5108 $content{phone} = $self->daytime || $self->night;
5113 my %bop_method2payby = (
5119 sub _new_realtime_bop {
5123 if (ref($_[0]) eq 'HASH') {
5124 %options = %{$_[0]};
5126 my ( $method, $amount ) = ( shift, shift );
5128 $options{method} = $method;
5129 $options{amount} = $amount;
5133 warn "$me realtime_bop (new): $options{method} $options{amount}\n";
5134 warn " $_ => $options{$_}\n" foreach keys %options;
5137 return $self->fake_bop(%options) if $options{'fake'};
5139 $self->_bop_defaults(\%options);
5142 # set trans_is_recur based on invnum if there is one
5145 my $trans_is_recur = 0;
5146 if ( $options{'invnum'} ) {
5148 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
5149 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
5152 map { $_->part_pkg }
5154 map { $_->cust_pkg }
5155 $cust_bill->cust_bill_pkg;
5158 if grep { $_->freq ne '0' } @part_pkg;
5166 my $payment_gateway = $self->_payment_gateway( \%options );
5167 my $namespace = $payment_gateway->gateway_namespace;
5169 eval "use $namespace";
5173 # check for banned credit card/ACH
5176 my $ban = qsearchs('banned_pay', {
5177 'payby' => $bop_method2payby{$options{method}},
5178 'payinfo' => md5_base64($options{payinfo}),
5180 return "Banned credit card" if $ban;
5186 my (%bop_content) = $self->_bop_content(\%options);
5188 if ( $options{method} ne 'ECHECK' ) {
5189 $options{payname} =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5190 or return "Illegal payname $options{payname}";
5191 ($bop_content{payfirst}, $bop_content{paylast}) = ($1, $2);
5194 my @invoicing_list = $self->invoicing_list_emailonly;
5195 if ( $conf->exists('emailinvoiceautoalways')
5196 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5197 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5198 push @invoicing_list, $self->all_emails;
5201 my $email = ($conf->exists('business-onlinepayment-email-override'))
5202 ? $conf->config('business-onlinepayment-email-override')
5203 : $invoicing_list[0];
5207 if ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'CC' ) {
5209 $content{card_number} = $options{payinfo};
5210 $paydate = exists($options{'paydate'})
5211 ? $options{'paydate'}
5213 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
5214 $content{expiration} = "$2/$1";
5216 my $paycvv = exists($options{'paycvv'})
5217 ? $options{'paycvv'}
5219 $content{cvv2} = $paycvv
5222 my $paystart_month = exists($options{'paystart_month'})
5223 ? $options{'paystart_month'}
5224 : $self->paystart_month;
5226 my $paystart_year = exists($options{'paystart_year'})
5227 ? $options{'paystart_year'}
5228 : $self->paystart_year;
5230 $content{card_start} = "$paystart_month/$paystart_year"
5231 if $paystart_month && $paystart_year;
5233 my $payissue = exists($options{'payissue'})
5234 ? $options{'payissue'}
5236 $content{issue_number} = $payissue if $payissue;
5238 if ( $self->_bop_recurring_billing( 'payinfo' => $options{'payinfo'},
5239 'trans_is_recur' => $trans_is_recur,
5243 $content{recurring_billing} = 'YES';
5244 $content{acct_code} = 'rebill'
5245 if $conf->exists('credit_card-recurring_billing_acct_code');
5248 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'ECHECK' ){
5249 ( $content{account_number}, $content{routing_code} ) =
5250 split('@', $options{payinfo});
5251 $content{bank_name} = $options{payname};
5252 $content{bank_state} = exists($options{'paystate'})
5253 ? $options{'paystate'}
5254 : $self->getfield('paystate');
5255 $content{account_type} = exists($options{'paytype'})
5256 ? uc($options{'paytype'}) || 'CHECKING'
5257 : uc($self->getfield('paytype')) || 'CHECKING';
5258 $content{customer_org} = $self->company ? 'B' : 'I';
5259 $content{state_id} = exists($options{'stateid'})
5260 ? $options{'stateid'}
5261 : $self->getfield('stateid');
5262 $content{state_id_state} = exists($options{'stateid_state'})
5263 ? $options{'stateid_state'}
5264 : $self->getfield('stateid_state');
5265 $content{customer_ssn} = exists($options{'ss'})
5268 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'LEC' ) {
5269 $content{phone} = $options{payinfo};
5270 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5277 # run transaction(s)
5280 my $balance = exists( $options{'balance'} )
5281 ? $options{'balance'}
5284 $self->select_for_update; #mutex ... just until we get our pending record in
5286 #the checks here are intended to catch concurrent payments
5287 #double-form-submission prevention is taken care of in cust_pay_pending::check
5290 return "The customer's balance has changed; $options{method} transaction aborted."
5291 if $self->balance < $balance;
5292 #&& $self->balance < $options{amount}; #might as well anyway?
5294 #also check and make sure there aren't *other* pending payments for this cust
5296 my @pending = qsearch('cust_pay_pending', {
5297 'custnum' => $self->custnum,
5298 'status' => { op=>'!=', value=>'done' }
5300 return "A payment is already being processed for this customer (".
5301 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
5302 "); $options{method} transaction aborted."
5303 if scalar(@pending);
5305 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
5307 my $cust_pay_pending = new FS::cust_pay_pending {
5308 'custnum' => $self->custnum,
5309 #'invnum' => $options{'invnum'},
5310 'paid' => $options{amount},
5312 'payby' => $bop_method2payby{$options{method}},
5313 'payinfo' => $options{payinfo},
5314 'paydate' => $paydate,
5315 'recurring_billing' => $content{recurring_billing},
5316 'pkgnum' => $options{'pkgnum'},
5318 'gatewaynum' => $payment_gateway->gatewaynum || '',
5319 'session_id' => $options{session_id} || '',
5320 'jobnum' => $options{depend_jobnum} || '',
5322 $cust_pay_pending->payunique( $options{payunique} )
5323 if defined($options{payunique}) && length($options{payunique});
5324 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
5325 return $cpp_new_err if $cpp_new_err;
5327 my( $action1, $action2 ) =
5328 split( /\s*\,\s*/, $payment_gateway->gateway_action );
5330 my $transaction = new $namespace( $payment_gateway->gateway_module,
5331 $self->_bop_options(\%options),
5334 $transaction->content(
5335 'type' => $options{method},
5336 $self->_bop_auth(\%options),
5337 'action' => $action1,
5338 'description' => $options{'description'},
5339 'amount' => $options{amount},
5340 #'invoice_number' => $options{'invnum'},
5341 'customer_id' => $self->custnum,
5343 'reference' => $cust_pay_pending->paypendingnum, #for now
5348 $cust_pay_pending->status('pending');
5349 my $cpp_pending_err = $cust_pay_pending->replace;
5350 return $cpp_pending_err if $cpp_pending_err;
5353 my $BOP_TESTING = 0;
5354 my $BOP_TESTING_SUCCESS = 1;
5356 unless ( $BOP_TESTING ) {
5357 $transaction->submit();
5359 if ( $BOP_TESTING_SUCCESS ) {
5360 $transaction->is_success(1);
5361 $transaction->authorization('fake auth');
5363 $transaction->is_success(0);
5364 $transaction->error_message('fake failure');
5368 if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5370 return { reference => $cust_pay_pending->paypendingnum,
5371 map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
5373 } elsif ( $transaction->is_success() && $action2 ) {
5375 $cust_pay_pending->status('authorized');
5376 my $cpp_authorized_err = $cust_pay_pending->replace;
5377 return $cpp_authorized_err if $cpp_authorized_err;
5379 my $auth = $transaction->authorization;
5380 my $ordernum = $transaction->can('order_number')
5381 ? $transaction->order_number
5385 new Business::OnlinePayment( $payment_gateway->gateway_module,
5386 $self->_bop_options(\%options),
5391 type => $options{method},
5393 $self->_bop_auth(\%options),
5394 order_number => $ordernum,
5395 amount => $options{amount},
5396 authorization => $auth,
5397 description => $options{'description'},
5400 foreach my $field (qw( authorization_source_code returned_ACI
5401 transaction_identifier validation_code
5402 transaction_sequence_num local_transaction_date
5403 local_transaction_time AVS_result_code )) {
5404 $capture{$field} = $transaction->$field() if $transaction->can($field);
5407 $capture->content( %capture );
5411 unless ( $capture->is_success ) {
5412 my $e = "Authorization successful but capture failed, custnum #".
5413 $self->custnum. ': '. $capture->result_code.
5414 ": ". $capture->error_message;
5422 # remove paycvv after initial transaction
5425 #false laziness w/misc/process/payment.cgi - check both to make sure working
5427 if ( defined $self->dbdef_table->column('paycvv')
5428 && length($self->paycvv)
5429 && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
5431 my $error = $self->remove_cvv;
5433 warn "WARNING: error removing cvv: $error\n";
5441 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5453 if (ref($_[0]) eq 'HASH') {
5454 %options = %{$_[0]};
5456 my ( $method, $amount ) = ( shift, shift );
5458 $options{method} = $method;
5459 $options{amount} = $amount;
5462 if ( $options{'fake_failure'} ) {
5463 return "Error: No error; test failure requested with fake_failure";
5467 #if ( $payment_gateway->gatewaynum ) { # agent override
5468 # $paybatch = $payment_gateway->gatewaynum. '-';
5471 #$paybatch .= "$processor:". $transaction->authorization;
5473 #$paybatch .= ':'. $transaction->order_number
5474 # if $transaction->can('order_number')
5475 # && length($transaction->order_number);
5477 my $paybatch = 'FakeProcessor:54:32';
5479 my $cust_pay = new FS::cust_pay ( {
5480 'custnum' => $self->custnum,
5481 'invnum' => $options{'invnum'},
5482 'paid' => $options{amount},
5484 'payby' => $bop_method2payby{$options{method}},
5485 #'payinfo' => $payinfo,
5486 'payinfo' => '4111111111111111',
5487 'paybatch' => $paybatch,
5488 #'paydate' => $paydate,
5489 'paydate' => '2012-05-01',
5491 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
5493 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5496 $cust_pay->invnum(''); #try again with no specific invnum
5497 my $error2 = $cust_pay->insert( $options{'manual'} ?
5498 ( 'manual' => 1 ) : ()
5501 # gah, even with transactions.
5502 my $e = 'WARNING: Card/ACH debited but database not updated - '.
5503 "error inserting (fake!) payment: $error2".
5504 " (previously tried insert with invnum #$options{'invnum'}" .
5511 if ( $options{'paynum_ref'} ) {
5512 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5515 return ''; #no error
5520 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
5522 # Wraps up processing of a realtime credit card, ACH (electronic check) or
5523 # phone bill transaction.
5525 sub _realtime_bop_result {
5526 my( $self, $cust_pay_pending, $transaction, %options ) = @_;
5528 warn "$me _realtime_bop_result: pending transaction ".
5529 $cust_pay_pending->paypendingnum. "\n";
5530 warn " $_ => $options{$_}\n" foreach keys %options;
5533 my $payment_gateway = $options{payment_gateway}
5534 or return "no payment gateway in arguments to _realtime_bop_result";
5536 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
5537 my $cpp_captured_err = $cust_pay_pending->replace;
5538 return $cpp_captured_err if $cpp_captured_err;
5540 if ( $transaction->is_success() ) {
5543 if ( $payment_gateway->gatewaynum ) { # agent override
5544 $paybatch = $payment_gateway->gatewaynum. '-';
5547 $paybatch .= $payment_gateway->gateway_module. ":".
5548 $transaction->authorization;
5550 $paybatch .= ':'. $transaction->order_number
5551 if $transaction->can('order_number')
5552 && length($transaction->order_number);
5554 my $cust_pay = new FS::cust_pay ( {
5555 'custnum' => $self->custnum,
5556 'invnum' => $options{'invnum'},
5557 'paid' => $cust_pay_pending->paid,
5559 'payby' => $cust_pay_pending->payby,
5560 #'payinfo' => $payinfo,
5561 'paybatch' => $paybatch,
5562 'paydate' => $cust_pay_pending->paydate,
5563 'pkgnum' => $cust_pay_pending->pkgnum,
5565 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
5566 $cust_pay->payunique( $options{payunique} )
5567 if defined($options{payunique}) && length($options{payunique});
5569 my $oldAutoCommit = $FS::UID::AutoCommit;
5570 local $FS::UID::AutoCommit = 0;
5573 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
5575 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5578 $cust_pay->invnum(''); #try again with no specific invnum
5579 my $error2 = $cust_pay->insert( $options{'manual'} ?
5580 ( 'manual' => 1 ) : ()
5583 # gah. but at least we have a record of the state we had to abort in
5584 # from cust_pay_pending now.
5585 my $e = "WARNING: $options{method} captured but payment not recorded -".
5586 " error inserting payment (". $payment_gateway->gateway_module.
5588 " (previously tried insert with invnum #$options{'invnum'}" .
5589 ": $error ) - pending payment saved as paypendingnum ".
5590 $cust_pay_pending->paypendingnum. "\n";
5596 my $jobnum = $cust_pay_pending->jobnum;
5598 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5600 unless ( $placeholder ) {
5601 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5602 my $e = "WARNING: $options{method} captured but job $jobnum not ".
5603 "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
5608 $error = $placeholder->delete;
5611 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5612 my $e = "WARNING: $options{method} captured but could not delete ".
5613 "job $jobnum for paypendingnum ".
5614 $cust_pay_pending->paypendingnum. ": $error\n";
5621 if ( $options{'paynum_ref'} ) {
5622 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5625 $cust_pay_pending->status('done');
5626 $cust_pay_pending->statustext('captured');
5627 $cust_pay_pending->paynum($cust_pay->paynum);
5628 my $cpp_done_err = $cust_pay_pending->replace;
5630 if ( $cpp_done_err ) {
5632 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5633 my $e = "WARNING: $options{method} captured but payment not recorded - ".
5634 "error updating status for paypendingnum ".
5635 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5641 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5643 if ( $options{'apply'} ) {
5644 my $apply_error = $self->apply_payments_and_credits;
5645 if ( $apply_error ) {
5646 warn "WARNING: error applying payment: $apply_error\n";
5647 #but we still should return no error cause the payment otherwise went
5652 return ''; #no error
5658 my $perror = $payment_gateway->gateway_module. " error: ".
5659 $transaction->error_message;
5661 my $jobnum = $cust_pay_pending->jobnum;
5663 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5665 if ( $placeholder ) {
5666 my $error = $placeholder->depended_delete;
5667 $error ||= $placeholder->delete;
5668 warn "error removing provisioning jobs after declined paypendingnum ".
5669 $cust_pay_pending->paypendingnum. "\n";
5671 my $e = "error finding job $jobnum for declined paypendingnum ".
5672 $cust_pay_pending->paypendingnum. "\n";
5678 unless ( $transaction->error_message ) {
5681 if ( $transaction->can('response_page') ) {
5683 'page' => ( $transaction->can('response_page')
5684 ? $transaction->response_page
5687 'code' => ( $transaction->can('response_code')
5688 ? $transaction->response_code
5691 'headers' => ( $transaction->can('response_headers')
5692 ? $transaction->response_headers
5698 "No additional debugging information available for ".
5699 $payment_gateway->gateway_module;
5702 $perror .= "No error_message returned from ".
5703 $payment_gateway->gateway_module. " -- ".
5704 ( ref($t_response) ? Dumper($t_response) : $t_response );
5708 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
5709 && $conf->exists('emaildecline')
5710 && grep { $_ ne 'POST' } $self->invoicing_list
5711 && ! grep { $transaction->error_message =~ /$_/ }
5712 $conf->config('emaildecline-exclude')
5714 my @templ = $conf->config('declinetemplate');
5715 my $template = new Text::Template (
5717 SOURCE => [ map "$_\n", @templ ],
5718 ) or return "($perror) can't create template: $Text::Template::ERROR";
5719 $template->compile()
5720 or return "($perror) can't compile template: $Text::Template::ERROR";
5724 scalar( $conf->config('company_name', $self->agentnum ) ),
5725 'company_address' =>
5726 join("\n", $conf->config('company_address', $self->agentnum ) ),
5727 'error' => $transaction->error_message,
5730 my $error = send_email(
5731 'from' => $conf->config('invoice_from', $self->agentnum ),
5732 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
5733 'subject' => 'Your payment could not be processed',
5734 'body' => [ $template->fill_in(HASH => $templ_hash) ],
5737 $perror .= " (also received error sending decline notification: $error)"
5742 $cust_pay_pending->status('done');
5743 $cust_pay_pending->statustext("declined: $perror");
5744 my $cpp_done_err = $cust_pay_pending->replace;
5745 if ( $cpp_done_err ) {
5746 my $e = "WARNING: $options{method} declined but pending payment not ".
5747 "resolved - error updating status for paypendingnum ".
5748 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5750 $perror = "$e ($perror)";
5758 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
5760 Verifies successful third party processing of a realtime credit card,
5761 ACH (electronic check) or phone bill transaction via a
5762 Business::OnlineThirdPartyPayment realtime gateway. See
5763 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5765 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
5767 The additional options I<payname>, I<city>, I<state>,
5768 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5769 if set, will override the value from the customer record.
5771 I<description> is a free-text field passed to the gateway. It defaults to
5772 "Internet services".
5774 If an I<invnum> is specified, this payment (if successful) is applied to the
5775 specified invoice. If you don't specify an I<invnum> you might want to
5776 call the B<apply_payments> method.
5778 I<quiet> can be set true to surpress email decline notices.
5780 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5781 resulting paynum, if any.
5783 I<payunique> is a unique identifier for this payment.
5785 Returns a hashref containing elements bill_error (which will be undefined
5786 upon success) and session_id of any associated session.
5790 sub realtime_botpp_capture {
5791 my( $self, $cust_pay_pending, %options ) = @_;
5793 warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
5794 warn " $_ => $options{$_}\n" foreach keys %options;
5797 eval "use Business::OnlineThirdPartyPayment";
5801 # select the gateway
5804 my $method = FS::payby->payby2bop($cust_pay_pending->payby);
5806 my $payment_gateway = $cust_pay_pending->gatewaynum
5807 ? qsearchs( 'payment_gateway',
5808 { gatewaynum => $cust_pay_pending->gatewaynum }
5810 : $self->agent->payment_gateway( 'method' => $method,
5811 # 'invnum' => $cust_pay_pending->invnum,
5812 # 'payinfo' => $cust_pay_pending->payinfo,
5815 $options{payment_gateway} = $payment_gateway; # for the helper subs
5821 my @invoicing_list = $self->invoicing_list_emailonly;
5822 if ( $conf->exists('emailinvoiceautoalways')
5823 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5824 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5825 push @invoicing_list, $self->all_emails;
5828 my $email = ($conf->exists('business-onlinepayment-email-override'))
5829 ? $conf->config('business-onlinepayment-email-override')
5830 : $invoicing_list[0];
5834 $content{email_customer} =
5835 ( $conf->exists('business-onlinepayment-email_customer')
5836 || $conf->exists('business-onlinepayment-email-override') );
5839 # run transaction(s)
5843 new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
5844 $self->_bop_options(\%options),
5847 $transaction->reference({ %options });
5849 $transaction->content(
5851 $self->_bop_auth(\%options),
5852 'action' => 'Post Authorization',
5853 'description' => $options{'description'},
5854 'amount' => $cust_pay_pending->paid,
5855 #'invoice_number' => $options{'invnum'},
5856 'customer_id' => $self->custnum,
5857 'referer' => 'http://cleanwhisker.420.am/',
5858 'reference' => $cust_pay_pending->paypendingnum,
5860 'phone' => $self->daytime || $self->night,
5862 # plus whatever is required for bogus capture avoidance
5865 $transaction->submit();
5868 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5871 bill_error => $error,
5872 session_id => $cust_pay_pending->session_id,
5877 =item default_payment_gateway DEPRECATED -- use agent->payment_gateway
5881 sub default_payment_gateway {
5882 my( $self, $method ) = @_;
5884 die "Real-time processing not enabled\n"
5885 unless $conf->exists('business-onlinepayment');
5887 #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
5890 my $bop_config = 'business-onlinepayment';
5891 $bop_config .= '-ach'
5892 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
5893 my ( $processor, $login, $password, $action, @bop_options ) =
5894 $conf->config($bop_config);
5895 $action ||= 'normal authorization';
5896 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
5897 die "No real-time processor is enabled - ".
5898 "did you set the business-onlinepayment configuration value?\n"
5901 ( $processor, $login, $password, $action, @bop_options )
5906 Removes the I<paycvv> field from the database directly.
5908 If there is an error, returns the error, otherwise returns false.
5914 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
5915 or return dbh->errstr;
5916 $sth->execute($self->custnum)
5917 or return $sth->errstr;
5922 =item _new_realtime_refund_bop METHOD [ OPTION => VALUE ... ]
5924 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
5925 via a Business::OnlinePayment realtime gateway. See
5926 L<http://420.am/business-onlinepayment> for supported gateways.
5928 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5930 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
5932 Most gateways require a reference to an original payment transaction to refund,
5933 so you probably need to specify a I<paynum>.
5935 I<amount> defaults to the original amount of the payment if not specified.
5937 I<reason> specifies a reason for the refund.
5939 I<paydate> specifies the expiration date for a credit card overriding the
5940 value from the customer record or the payment record. Specified as yyyy-mm-dd
5942 Implementation note: If I<amount> is unspecified or equal to the amount of the
5943 orignal payment, first an attempt is made to "void" the transaction via
5944 the gateway (to cancel a not-yet settled transaction) and then if that fails,
5945 the normal attempt is made to "refund" ("credit") the transaction via the
5946 gateway is attempted.
5948 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5949 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5950 #if set, will override the value from the customer record.
5952 #If an I<invnum> is specified, this payment (if successful) is applied to the
5953 #specified invoice. If you don't specify an I<invnum> you might want to
5954 #call the B<apply_payments> method.
5958 #some false laziness w/realtime_bop, not enough to make it worth merging
5959 #but some useful small subs should be pulled out
5960 sub _new_realtime_refund_bop {
5964 if (ref($_[0]) ne 'HASH') {
5965 %options = %{$_[0]};
5969 $options{method} = $method;
5973 warn "$me realtime_refund_bop (new): $options{method} refund\n";
5974 warn " $_ => $options{$_}\n" foreach keys %options;
5978 # look up the original payment and optionally a gateway for that payment
5982 my $amount = $options{'amount'};
5984 my( $processor, $login, $password, @bop_options, $namespace ) ;
5985 my( $auth, $order_number ) = ( '', '', '' );
5987 if ( $options{'paynum'} ) {
5989 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
5990 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
5991 or return "Unknown paynum $options{'paynum'}";
5992 $amount ||= $cust_pay->paid;
5994 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
5995 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
5996 $cust_pay->paybatch;
5997 my $gatewaynum = '';
5998 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
6000 if ( $gatewaynum ) { #gateway for the payment to be refunded
6002 my $payment_gateway =
6003 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
6004 die "payment gateway $gatewaynum not found"
6005 unless $payment_gateway;
6007 $processor = $payment_gateway->gateway_module;
6008 $login = $payment_gateway->gateway_username;
6009 $password = $payment_gateway->gateway_password;
6010 $namespace = $payment_gateway->gateway_namespace;
6011 @bop_options = $payment_gateway->options;
6013 } else { #try the default gateway
6016 my $payment_gateway =
6017 $self->agent->payment_gateway('method' => $options{method});
6019 ( $conf_processor, $login, $password, $namespace ) =
6020 map { my $method = "gateway_$_"; $payment_gateway->$method }
6021 qw( module username password namespace );
6023 @bop_options = $payment_gateway->gatewaynum
6024 ? $payment_gateway->options
6025 : @{ $payment_gateway->get('options') };
6027 return "processor of payment $options{'paynum'} $processor does not".
6028 " match default processor $conf_processor"
6029 unless $processor eq $conf_processor;
6034 } else { # didn't specify a paynum, so look for agent gateway overrides
6035 # like a normal transaction
6037 my $payment_gateway =
6038 $self->agent->payment_gateway( 'method' => $options{method},
6039 #'payinfo' => $payinfo,
6041 my( $processor, $login, $password, $namespace ) =
6042 map { my $method = "gateway_$_"; $payment_gateway->$method }
6043 qw( module username password namespace );
6045 my @bop_options = $payment_gateway->gatewaynum
6046 ? $payment_gateway->options
6047 : @{ $payment_gateway->get('options') };
6050 return "neither amount nor paynum specified" unless $amount;
6052 eval "use $namespace";
6056 'type' => $options{method},
6058 'password' => $password,
6059 'order_number' => $order_number,
6060 'amount' => $amount,
6061 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
6063 $content{authorization} = $auth
6064 if length($auth); #echeck/ACH transactions have an order # but no auth
6065 #(at least with authorize.net)
6067 my $disable_void_after;
6068 if ($conf->exists('disable_void_after')
6069 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
6070 $disable_void_after = $1;
6073 #first try void if applicable
6074 if ( $cust_pay && $cust_pay->paid == $amount
6076 ( not defined($disable_void_after) )
6077 || ( time < ($cust_pay->_date + $disable_void_after ) )
6080 warn " attempting void\n" if $DEBUG > 1;
6081 my $void = new Business::OnlinePayment( $processor, @bop_options );
6082 $void->content( 'action' => 'void', %content );
6084 if ( $void->is_success ) {
6085 my $error = $cust_pay->void($options{'reason'});
6087 # gah, even with transactions.
6088 my $e = 'WARNING: Card/ACH voided but database not updated - '.
6089 "error voiding payment: $error";
6093 warn " void successful\n" if $DEBUG > 1;
6098 warn " void unsuccessful, trying refund\n"
6102 my $address = $self->address1;
6103 $address .= ", ". $self->address2 if $self->address2;
6105 my($payname, $payfirst, $paylast);
6106 if ( $self->payname && $options{method} ne 'ECHECK' ) {
6107 $payname = $self->payname;
6108 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
6109 or return "Illegal payname $payname";
6110 ($payfirst, $paylast) = ($1, $2);
6112 $payfirst = $self->getfield('first');
6113 $paylast = $self->getfield('last');
6114 $payname = "$payfirst $paylast";
6117 my @invoicing_list = $self->invoicing_list_emailonly;
6118 if ( $conf->exists('emailinvoiceautoalways')
6119 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
6120 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
6121 push @invoicing_list, $self->all_emails;
6124 my $email = ($conf->exists('business-onlinepayment-email-override'))
6125 ? $conf->config('business-onlinepayment-email-override')
6126 : $invoicing_list[0];
6128 my $payip = exists($options{'payip'})
6131 $content{customer_ip} = $payip
6135 if ( $options{method} eq 'CC' ) {
6138 $content{card_number} = $payinfo = $cust_pay->payinfo;
6139 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
6140 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
6141 ($content{expiration} = "$2/$1"); # where available
6143 $content{card_number} = $payinfo = $self->payinfo;
6144 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
6145 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
6146 $content{expiration} = "$2/$1";
6149 } elsif ( $options{method} eq 'ECHECK' ) {
6152 $payinfo = $cust_pay->payinfo;
6154 $payinfo = $self->payinfo;
6156 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
6157 $content{bank_name} = $self->payname;
6158 $content{account_type} = 'CHECKING';
6159 $content{account_name} = $payname;
6160 $content{customer_org} = $self->company ? 'B' : 'I';
6161 $content{customer_ssn} = $self->ss;
6162 } elsif ( $options{method} eq 'LEC' ) {
6163 $content{phone} = $payinfo = $self->payinfo;
6167 my $refund = new Business::OnlinePayment( $processor, @bop_options );
6168 my %sub_content = $refund->content(
6169 'action' => 'credit',
6170 'customer_id' => $self->custnum,
6171 'last_name' => $paylast,
6172 'first_name' => $payfirst,
6174 'address' => $address,
6175 'city' => $self->city,
6176 'state' => $self->state,
6177 'zip' => $self->zip,
6178 'country' => $self->country,
6180 'phone' => $self->daytime || $self->night,
6183 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
6187 return "$processor error: ". $refund->error_message
6188 unless $refund->is_success();
6190 my $paybatch = "$processor:". $refund->authorization;
6191 $paybatch .= ':'. $refund->order_number
6192 if $refund->can('order_number') && $refund->order_number;
6194 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
6195 my @cust_bill_pay = $cust_pay->cust_bill_pay;
6196 last unless @cust_bill_pay;
6197 my $cust_bill_pay = pop @cust_bill_pay;
6198 my $error = $cust_bill_pay->delete;
6202 my $cust_refund = new FS::cust_refund ( {
6203 'custnum' => $self->custnum,
6204 'paynum' => $options{'paynum'},
6205 'refund' => $amount,
6207 'payby' => $bop_method2payby{$options{method}},
6208 'payinfo' => $payinfo,
6209 'paybatch' => $paybatch,
6210 'reason' => $options{'reason'} || 'card or ACH refund',
6212 my $error = $cust_refund->insert;
6214 $cust_refund->paynum(''); #try again with no specific paynum
6215 my $error2 = $cust_refund->insert;
6217 # gah, even with transactions.
6218 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
6219 "error inserting refund ($processor): $error2".
6220 " (previously tried insert with paynum #$options{'paynum'}" .
6231 =item batch_card OPTION => VALUE...
6233 Adds a payment for this invoice to the pending credit card batch (see
6234 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
6235 runs the payment using a realtime gateway.
6240 my ($self, %options) = @_;
6243 if (exists($options{amount})) {
6244 $amount = $options{amount};
6246 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
6248 return '' unless $amount > 0;
6250 my $invnum = delete $options{invnum};
6251 my $payby = $options{invnum} || $self->payby; #dubious
6253 if ($options{'realtime'}) {
6254 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
6260 my $oldAutoCommit = $FS::UID::AutoCommit;
6261 local $FS::UID::AutoCommit = 0;
6264 #this needs to handle mysql as well as Pg, like svc_acct.pm
6265 #(make it into a common function if folks need to do batching with mysql)
6266 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
6267 or return "Cannot lock pay_batch: " . $dbh->errstr;
6271 'payby' => FS::payby->payby2payment($payby),
6274 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
6276 unless ( $pay_batch ) {
6277 $pay_batch = new FS::pay_batch \%pay_batch;
6278 my $error = $pay_batch->insert;
6280 $dbh->rollback if $oldAutoCommit;
6281 die "error creating new batch: $error\n";
6285 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
6286 'batchnum' => $pay_batch->batchnum,
6287 'custnum' => $self->custnum,
6290 foreach (qw( address1 address2 city state zip country payby payinfo paydate
6292 $options{$_} = '' unless exists($options{$_});
6295 my $cust_pay_batch = new FS::cust_pay_batch ( {
6296 'batchnum' => $pay_batch->batchnum,
6297 'invnum' => $invnum || 0, # is there a better value?
6298 # this field should be
6300 # cust_bill_pay_batch now
6301 'custnum' => $self->custnum,
6302 'last' => $self->getfield('last'),
6303 'first' => $self->getfield('first'),
6304 'address1' => $options{address1} || $self->address1,
6305 'address2' => $options{address2} || $self->address2,
6306 'city' => $options{city} || $self->city,
6307 'state' => $options{state} || $self->state,
6308 'zip' => $options{zip} || $self->zip,
6309 'country' => $options{country} || $self->country,
6310 'payby' => $options{payby} || $self->payby,
6311 'payinfo' => $options{payinfo} || $self->payinfo,
6312 'exp' => $options{paydate} || $self->paydate,
6313 'payname' => $options{payname} || $self->payname,
6314 'amount' => $amount, # consolidating
6317 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
6318 if $old_cust_pay_batch;
6321 if ($old_cust_pay_batch) {
6322 $error = $cust_pay_batch->replace($old_cust_pay_batch)
6324 $error = $cust_pay_batch->insert;
6328 $dbh->rollback if $oldAutoCommit;
6332 my $unapplied = $self->total_unapplied_credits
6333 + $self->total_unapplied_payments
6334 + $self->in_transit_payments;
6335 foreach my $cust_bill ($self->open_cust_bill) {
6336 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
6337 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
6338 'invnum' => $cust_bill->invnum,
6339 'paybatchnum' => $cust_pay_batch->paybatchnum,
6340 'amount' => $cust_bill->owed,
6343 if ($unapplied >= $cust_bill_pay_batch->amount){
6344 $unapplied -= $cust_bill_pay_batch->amount;
6347 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
6348 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
6350 $error = $cust_bill_pay_batch->insert;
6352 $dbh->rollback if $oldAutoCommit;
6357 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6361 =item apply_payments_and_credits [ OPTION => VALUE ... ]
6363 Applies unapplied payments and credits.
6365 In most cases, this new method should be used in place of sequential
6366 apply_payments and apply_credits methods.
6368 A hash of optional arguments may be passed. Currently "manual" is supported.
6369 If true, a payment receipt is sent instead of a statement when
6370 'payment_receipt_email' configuration option is set.
6372 If there is an error, returns the error, otherwise returns false.
6376 sub apply_payments_and_credits {
6377 my( $self, %options ) = @_;
6379 local $SIG{HUP} = 'IGNORE';
6380 local $SIG{INT} = 'IGNORE';
6381 local $SIG{QUIT} = 'IGNORE';
6382 local $SIG{TERM} = 'IGNORE';
6383 local $SIG{TSTP} = 'IGNORE';
6384 local $SIG{PIPE} = 'IGNORE';
6386 my $oldAutoCommit = $FS::UID::AutoCommit;
6387 local $FS::UID::AutoCommit = 0;
6390 $self->select_for_update; #mutex
6392 foreach my $cust_bill ( $self->open_cust_bill ) {
6393 my $error = $cust_bill->apply_payments_and_credits(%options);
6395 $dbh->rollback if $oldAutoCommit;
6396 return "Error applying: $error";
6400 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6405 =item apply_credits OPTION => VALUE ...
6407 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
6408 to outstanding invoice balances in chronological order (or reverse
6409 chronological order if the I<order> option is set to B<newest>) and returns the
6410 value of any remaining unapplied credits available for refund (see
6411 L<FS::cust_refund>).
6413 Dies if there is an error.
6421 local $SIG{HUP} = 'IGNORE';
6422 local $SIG{INT} = 'IGNORE';
6423 local $SIG{QUIT} = 'IGNORE';
6424 local $SIG{TERM} = 'IGNORE';
6425 local $SIG{TSTP} = 'IGNORE';
6426 local $SIG{PIPE} = 'IGNORE';
6428 my $oldAutoCommit = $FS::UID::AutoCommit;
6429 local $FS::UID::AutoCommit = 0;
6432 $self->select_for_update; #mutex
6434 unless ( $self->total_unapplied_credits ) {
6435 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6439 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
6440 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
6442 my @invoices = $self->open_cust_bill;
6443 @invoices = sort { $b->_date <=> $a->_date } @invoices
6444 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
6446 if ( $conf->exists('pkg-balances') ) {
6447 # limit @credits to those w/ a pkgnum grepped from $self
6449 foreach my $i (@invoices) {
6450 foreach my $li ( $i->cust_bill_pkg ) {
6451 $pkgnums{$li->pkgnum} = 1;
6454 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
6459 foreach my $cust_bill ( @invoices ) {
6461 if ( !defined($credit) || $credit->credited == 0) {
6462 $credit = pop @credits or last;
6466 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
6467 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
6469 $owed = $cust_bill->owed;
6471 unless ( $owed > 0 ) {
6472 push @credits, $credit;
6476 my $amount = min( $credit->credited, $owed );
6478 my $cust_credit_bill = new FS::cust_credit_bill ( {
6479 'crednum' => $credit->crednum,
6480 'invnum' => $cust_bill->invnum,
6481 'amount' => $amount,
6483 $cust_credit_bill->pkgnum( $credit->pkgnum )
6484 if $conf->exists('pkg-balances') && $credit->pkgnum;
6485 my $error = $cust_credit_bill->insert;
6487 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6491 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6495 my $total_unapplied_credits = $self->total_unapplied_credits;
6497 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6499 return $total_unapplied_credits;
6502 =item apply_payments [ OPTION => VALUE ... ]
6504 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
6505 to outstanding invoice balances in chronological order.
6507 #and returns the value of any remaining unapplied payments.
6509 A hash of optional arguments may be passed. Currently "manual" is supported.
6510 If true, a payment receipt is sent instead of a statement when
6511 'payment_receipt_email' configuration option is set.
6513 Dies if there is an error.
6517 sub apply_payments {
6518 my( $self, %options ) = @_;
6520 local $SIG{HUP} = 'IGNORE';
6521 local $SIG{INT} = 'IGNORE';
6522 local $SIG{QUIT} = 'IGNORE';
6523 local $SIG{TERM} = 'IGNORE';
6524 local $SIG{TSTP} = 'IGNORE';
6525 local $SIG{PIPE} = 'IGNORE';
6527 my $oldAutoCommit = $FS::UID::AutoCommit;
6528 local $FS::UID::AutoCommit = 0;
6531 $self->select_for_update; #mutex
6535 my @payments = sort { $b->_date <=> $a->_date }
6536 grep { $_->unapplied > 0 }
6539 my @invoices = sort { $a->_date <=> $b->_date}
6540 grep { $_->owed > 0 }
6543 if ( $conf->exists('pkg-balances') ) {
6544 # limit @payments to those w/ a pkgnum grepped from $self
6546 foreach my $i (@invoices) {
6547 foreach my $li ( $i->cust_bill_pkg ) {
6548 $pkgnums{$li->pkgnum} = 1;
6551 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
6556 foreach my $cust_bill ( @invoices ) {
6558 if ( !defined($payment) || $payment->unapplied == 0 ) {
6559 $payment = pop @payments or last;
6563 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
6564 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
6566 $owed = $cust_bill->owed;
6568 unless ( $owed > 0 ) {
6569 push @payments, $payment;
6573 my $amount = min( $payment->unapplied, $owed );
6575 my $cust_bill_pay = new FS::cust_bill_pay ( {
6576 'paynum' => $payment->paynum,
6577 'invnum' => $cust_bill->invnum,
6578 'amount' => $amount,
6580 $cust_bill_pay->pkgnum( $payment->pkgnum )
6581 if $conf->exists('pkg-balances') && $payment->pkgnum;
6582 my $error = $cust_bill_pay->insert(%options);
6584 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6588 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6592 my $total_unapplied_payments = $self->total_unapplied_payments;
6594 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6596 return $total_unapplied_payments;
6601 Returns the total owed for this customer on all invoices
6602 (see L<FS::cust_bill/owed>).
6608 $self->total_owed_date(2145859200); #12/31/2037
6611 =item total_owed_date TIME
6613 Returns the total owed for this customer on all invoices with date earlier than
6614 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6615 see L<Time::Local> and L<Date::Parse> for conversion functions.
6619 sub total_owed_date {
6623 # my $custnum = $self->custnum;
6625 # my $owed_sql = FS::cust_bill->owed_sql;
6628 # SELECT SUM($owed_sql) FROM cust_bill
6629 # WHERE custnum = $custnum
6630 # AND _date <= $time
6633 # my $sth = dbh->prepare($sql) or die dbh->errstr;
6634 # $sth->execute() or die $sth->errstr;
6636 # return sprintf( '%.2f', $sth->fetchrow_arrayref->[0] );
6639 foreach my $cust_bill (
6640 grep { $_->_date <= $time }
6641 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6643 $total_bill += $cust_bill->owed;
6645 sprintf( "%.2f", $total_bill );
6649 =item total_owed_pkgnum PKGNUM
6651 Returns the total owed on all invoices for this customer's specific package
6652 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
6656 sub total_owed_pkgnum {
6657 my( $self, $pkgnum ) = @_;
6658 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
6661 =item total_owed_date_pkgnum TIME PKGNUM
6663 Returns the total owed for this customer's specific package when using
6664 experimental package balances on all invoices with date earlier than
6665 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6666 see L<Time::Local> and L<Date::Parse> for conversion functions.
6670 sub total_owed_date_pkgnum {
6671 my( $self, $time, $pkgnum ) = @_;
6674 foreach my $cust_bill (
6675 grep { $_->_date <= $time }
6676 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6678 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
6680 sprintf( "%.2f", $total_bill );
6686 Returns the total amount of all payments.
6693 $total += $_->paid foreach $self->cust_pay;
6694 sprintf( "%.2f", $total );
6697 =item total_unapplied_credits
6699 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6700 customer. See L<FS::cust_credit/credited>.
6702 =item total_credited
6704 Old name for total_unapplied_credits. Don't use.
6708 sub total_credited {
6709 #carp "total_credited deprecated, use total_unapplied_credits";
6710 shift->total_unapplied_credits(@_);
6713 sub total_unapplied_credits {
6715 my $total_credit = 0;
6716 $total_credit += $_->credited foreach $self->cust_credit;
6717 sprintf( "%.2f", $total_credit );
6720 =item total_unapplied_credits_pkgnum PKGNUM
6722 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6723 customer. See L<FS::cust_credit/credited>.
6727 sub total_unapplied_credits_pkgnum {
6728 my( $self, $pkgnum ) = @_;
6729 my $total_credit = 0;
6730 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
6731 sprintf( "%.2f", $total_credit );
6735 =item total_unapplied_payments
6737 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
6738 See L<FS::cust_pay/unapplied>.
6742 sub total_unapplied_payments {
6744 my $total_unapplied = 0;
6745 $total_unapplied += $_->unapplied foreach $self->cust_pay;
6746 sprintf( "%.2f", $total_unapplied );
6749 =item total_unapplied_payments_pkgnum PKGNUM
6751 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
6752 specific package when using experimental package balances. See
6753 L<FS::cust_pay/unapplied>.
6757 sub total_unapplied_payments_pkgnum {
6758 my( $self, $pkgnum ) = @_;
6759 my $total_unapplied = 0;
6760 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
6761 sprintf( "%.2f", $total_unapplied );
6765 =item total_unapplied_refunds
6767 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
6768 customer. See L<FS::cust_refund/unapplied>.
6772 sub total_unapplied_refunds {
6774 my $total_unapplied = 0;
6775 $total_unapplied += $_->unapplied foreach $self->cust_refund;
6776 sprintf( "%.2f", $total_unapplied );
6781 Returns the balance for this customer (total_owed plus total_unrefunded, minus
6782 total_unapplied_credits minus total_unapplied_payments).
6790 + $self->total_unapplied_refunds
6791 - $self->total_unapplied_credits
6792 - $self->total_unapplied_payments
6796 =item balance_date TIME
6798 Returns the balance for this customer, only considering invoices with date
6799 earlier than TIME (total_owed_date minus total_credited minus
6800 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
6801 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
6810 $self->total_owed_date($time)
6811 + $self->total_unapplied_refunds
6812 - $self->total_unapplied_credits
6813 - $self->total_unapplied_payments
6817 =item balance_pkgnum PKGNUM
6819 Returns the balance for this customer's specific package when using
6820 experimental package balances (total_owed plus total_unrefunded, minus
6821 total_unapplied_credits minus total_unapplied_payments)
6825 sub balance_pkgnum {
6826 my( $self, $pkgnum ) = @_;
6829 $self->total_owed_pkgnum($pkgnum)
6830 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
6831 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
6832 - $self->total_unapplied_credits_pkgnum($pkgnum)
6833 - $self->total_unapplied_payments_pkgnum($pkgnum)
6837 =item in_transit_payments
6839 Returns the total of requests for payments for this customer pending in
6840 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
6844 sub in_transit_payments {
6846 my $in_transit_payments = 0;
6847 foreach my $pay_batch ( qsearch('pay_batch', {
6850 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
6851 'batchnum' => $pay_batch->batchnum,
6852 'custnum' => $self->custnum,
6854 $in_transit_payments += $cust_pay_batch->amount;
6857 sprintf( "%.2f", $in_transit_payments );
6862 Returns a hash of useful information for making a payment.
6872 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
6873 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
6874 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
6878 For credit card transactions:
6890 For electronic check transactions:
6905 $return{balance} = $self->balance;
6907 $return{payname} = $self->payname
6908 || ( $self->first. ' '. $self->get('last') );
6910 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
6912 $return{payby} = $self->payby;
6913 $return{stateid_state} = $self->stateid_state;
6915 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
6916 $return{card_type} = cardtype($self->payinfo);
6917 $return{payinfo} = $self->paymask;
6919 @return{'month', 'year'} = $self->paydate_monthyear;
6923 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
6924 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
6925 $return{payinfo1} = $payinfo1;
6926 $return{payinfo2} = $payinfo2;
6927 $return{paytype} = $self->paytype;
6928 $return{paystate} = $self->paystate;
6932 #doubleclick protection
6934 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
6940 =item paydate_monthyear
6942 Returns a two-element list consisting of the month and year of this customer's
6943 paydate (credit card expiration date for CARD customers)
6947 sub paydate_monthyear {
6949 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
6951 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
6958 =item tax_exemption TAXNAME
6963 my( $self, $taxname ) = @_;
6965 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
6966 'taxname' => $taxname,
6971 =item cust_main_exemption
6975 sub cust_main_exemption {
6977 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
6980 =item invoicing_list [ ARRAYREF ]
6982 If an arguement is given, sets these email addresses as invoice recipients
6983 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
6984 (except as warnings), so use check_invoicing_list first.
6986 Returns a list of email addresses (with svcnum entries expanded).
6988 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
6989 check it without disturbing anything by passing nothing.
6991 This interface may change in the future.
6995 sub invoicing_list {
6996 my( $self, $arrayref ) = @_;
6999 my @cust_main_invoice;
7000 if ( $self->custnum ) {
7001 @cust_main_invoice =
7002 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7004 @cust_main_invoice = ();
7006 foreach my $cust_main_invoice ( @cust_main_invoice ) {
7007 #warn $cust_main_invoice->destnum;
7008 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
7009 #warn $cust_main_invoice->destnum;
7010 my $error = $cust_main_invoice->delete;
7011 warn $error if $error;
7014 if ( $self->custnum ) {
7015 @cust_main_invoice =
7016 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7018 @cust_main_invoice = ();
7020 my %seen = map { $_->address => 1 } @cust_main_invoice;
7021 foreach my $address ( @{$arrayref} ) {
7022 next if exists $seen{$address} && $seen{$address};
7023 $seen{$address} = 1;
7024 my $cust_main_invoice = new FS::cust_main_invoice ( {
7025 'custnum' => $self->custnum,
7028 my $error = $cust_main_invoice->insert;
7029 warn $error if $error;
7033 if ( $self->custnum ) {
7035 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7042 =item check_invoicing_list ARRAYREF
7044 Checks these arguements as valid input for the invoicing_list method. If there
7045 is an error, returns the error, otherwise returns false.
7049 sub check_invoicing_list {
7050 my( $self, $arrayref ) = @_;
7052 foreach my $address ( @$arrayref ) {
7054 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
7055 return 'Can\'t add FAX invoice destination with a blank FAX number.';
7058 my $cust_main_invoice = new FS::cust_main_invoice ( {
7059 'custnum' => $self->custnum,
7062 my $error = $self->custnum
7063 ? $cust_main_invoice->check
7064 : $cust_main_invoice->checkdest
7066 return $error if $error;
7070 return "Email address required"
7071 if $conf->exists('cust_main-require_invoicing_list_email')
7072 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
7077 =item set_default_invoicing_list
7079 Sets the invoicing list to all accounts associated with this customer,
7080 overwriting any previous invoicing list.
7084 sub set_default_invoicing_list {
7086 $self->invoicing_list($self->all_emails);
7091 Returns the email addresses of all accounts provisioned for this customer.
7098 foreach my $cust_pkg ( $self->all_pkgs ) {
7099 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
7101 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
7102 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
7104 $list{$_}=1 foreach map { $_->email } @svc_acct;
7109 =item invoicing_list_addpost
7111 Adds postal invoicing to this customer. If this customer is already configured
7112 to receive postal invoices, does nothing.
7116 sub invoicing_list_addpost {
7118 return if grep { $_ eq 'POST' } $self->invoicing_list;
7119 my @invoicing_list = $self->invoicing_list;
7120 push @invoicing_list, 'POST';
7121 $self->invoicing_list(\@invoicing_list);
7124 =item invoicing_list_emailonly
7126 Returns the list of email invoice recipients (invoicing_list without non-email
7127 destinations such as POST and FAX).
7131 sub invoicing_list_emailonly {
7133 warn "$me invoicing_list_emailonly called"
7135 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
7138 =item invoicing_list_emailonly_scalar
7140 Returns the list of email invoice recipients (invoicing_list without non-email
7141 destinations such as POST and FAX) as a comma-separated scalar.
7145 sub invoicing_list_emailonly_scalar {
7147 warn "$me invoicing_list_emailonly_scalar called"
7149 join(', ', $self->invoicing_list_emailonly);
7152 =item referral_custnum_cust_main
7154 Returns the customer who referred this customer (or the empty string, if
7155 this customer was not referred).
7157 Note the difference with referral_cust_main method: This method,
7158 referral_custnum_cust_main returns the single customer (if any) who referred
7159 this customer, while referral_cust_main returns an array of customers referred
7164 sub referral_custnum_cust_main {
7166 return '' unless $self->referral_custnum;
7167 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7170 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
7172 Returns an array of customers referred by this customer (referral_custnum set
7173 to this custnum). If DEPTH is given, recurses up to the given depth, returning
7174 customers referred by customers referred by this customer and so on, inclusive.
7175 The default behavior is DEPTH 1 (no recursion).
7177 Note the difference with referral_custnum_cust_main method: This method,
7178 referral_cust_main, returns an array of customers referred BY this customer,
7179 while referral_custnum_cust_main returns the single customer (if any) who
7180 referred this customer.
7184 sub referral_cust_main {
7186 my $depth = @_ ? shift : 1;
7187 my $exclude = @_ ? shift : {};
7190 map { $exclude->{$_->custnum}++; $_; }
7191 grep { ! $exclude->{ $_->custnum } }
7192 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
7196 map { $_->referral_cust_main($depth-1, $exclude) }
7203 =item referral_cust_main_ncancelled
7205 Same as referral_cust_main, except only returns customers with uncancelled
7210 sub referral_cust_main_ncancelled {
7212 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
7215 =item referral_cust_pkg [ DEPTH ]
7217 Like referral_cust_main, except returns a flat list of all unsuspended (and
7218 uncancelled) packages for each customer. The number of items in this list may
7219 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
7223 sub referral_cust_pkg {
7225 my $depth = @_ ? shift : 1;
7227 map { $_->unsuspended_pkgs }
7228 grep { $_->unsuspended_pkgs }
7229 $self->referral_cust_main($depth);
7232 =item referring_cust_main
7234 Returns the single cust_main record for the customer who referred this customer
7235 (referral_custnum), or false.
7239 sub referring_cust_main {
7241 return '' unless $self->referral_custnum;
7242 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7245 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
7247 Applies a credit to this customer. If there is an error, returns the error,
7248 otherwise returns false.
7250 REASON can be a text string, an FS::reason object, or a scalar reference to
7251 a reasonnum. If a text string, it will be automatically inserted as a new
7252 reason, and a 'reason_type' option must be passed to indicate the
7253 FS::reason_type for the new reason.
7255 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
7257 Any other options are passed to FS::cust_credit::insert.
7262 my( $self, $amount, $reason, %options ) = @_;
7264 my $cust_credit = new FS::cust_credit {
7265 'custnum' => $self->custnum,
7266 'amount' => $amount,
7269 if ( ref($reason) ) {
7271 if ( ref($reason) eq 'SCALAR' ) {
7272 $cust_credit->reasonnum( $$reason );
7274 $cust_credit->reasonnum( $reason->reasonnum );
7278 $cust_credit->set('reason', $reason)
7281 $cust_credit->addlinfo( delete $options{'addlinfo'} )
7282 if exists($options{'addlinfo'});
7284 $cust_credit->insert(%options);
7288 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
7290 Creates a one-time charge for this customer. If there is an error, returns
7291 the error, otherwise returns false.
7293 New-style, with a hashref of options:
7295 my $error = $cust_main->charge(
7299 'start_date' => str2time('7/4/2009'),
7300 'pkg' => 'Description',
7301 'comment' => 'Comment',
7302 'additional' => [], #extra invoice detail
7303 'classnum' => 1, #pkg_class
7305 'setuptax' => '', # or 'Y' for tax exempt
7308 'taxclass' => 'Tax class',
7311 'taxproduct' => 2, #part_pkg_taxproduct
7312 'override' => {}, #XXX describe
7314 #will be filled in with the new object
7315 'cust_pkg_ref' => \$cust_pkg,
7317 #generate an invoice immediately
7319 'invoice_terms' => '', #with these terms
7325 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
7331 my ( $amount, $quantity, $start_date, $classnum );
7332 my ( $pkg, $comment, $additional );
7333 my ( $setuptax, $taxclass ); #internal taxes
7334 my ( $taxproduct, $override ); #vendor (CCH) taxes
7335 my $cust_pkg_ref = '';
7336 my ( $bill_now, $invoice_terms ) = ( 0, '' );
7337 if ( ref( $_[0] ) ) {
7338 $amount = $_[0]->{amount};
7339 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
7340 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
7341 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
7342 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
7343 : '$'. sprintf("%.2f",$amount);
7344 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
7345 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
7346 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
7347 $additional = $_[0]->{additional} || [];
7348 $taxproduct = $_[0]->{taxproductnum};
7349 $override = { '' => $_[0]->{tax_override} };
7350 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
7351 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
7352 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
7357 $pkg = @_ ? shift : 'One-time charge';
7358 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
7360 $taxclass = @_ ? shift : '';
7364 local $SIG{HUP} = 'IGNORE';
7365 local $SIG{INT} = 'IGNORE';
7366 local $SIG{QUIT} = 'IGNORE';
7367 local $SIG{TERM} = 'IGNORE';
7368 local $SIG{TSTP} = 'IGNORE';
7369 local $SIG{PIPE} = 'IGNORE';
7371 my $oldAutoCommit = $FS::UID::AutoCommit;
7372 local $FS::UID::AutoCommit = 0;
7375 my $part_pkg = new FS::part_pkg ( {
7377 'comment' => $comment,
7381 'classnum' => ( $classnum ? $classnum : '' ),
7382 'setuptax' => $setuptax,
7383 'taxclass' => $taxclass,
7384 'taxproductnum' => $taxproduct,
7387 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
7388 ( 0 .. @$additional - 1 )
7390 'additional_count' => scalar(@$additional),
7391 'setup_fee' => $amount,
7394 my $error = $part_pkg->insert( options => \%options,
7395 tax_overrides => $override,
7398 $dbh->rollback if $oldAutoCommit;
7402 my $pkgpart = $part_pkg->pkgpart;
7403 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
7404 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
7405 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
7406 $error = $type_pkgs->insert;
7408 $dbh->rollback if $oldAutoCommit;
7413 my $cust_pkg = new FS::cust_pkg ( {
7414 'custnum' => $self->custnum,
7415 'pkgpart' => $pkgpart,
7416 'quantity' => $quantity,
7417 'start_date' => $start_date,
7420 $error = $cust_pkg->insert;
7422 $dbh->rollback if $oldAutoCommit;
7424 } elsif ( $cust_pkg_ref ) {
7425 ${$cust_pkg_ref} = $cust_pkg;
7429 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
7430 'pkg_list' => [ $cust_pkg ],
7433 $dbh->rollback if $oldAutoCommit;
7438 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
7443 #=item charge_postal_fee
7445 #Applies a one time charge this customer. If there is an error,
7446 #returns the error, returns the cust_pkg charge object or false
7447 #if there was no charge.
7451 # This should be a customer event. For that to work requires that bill
7452 # also be a customer event.
7454 sub charge_postal_fee {
7457 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
7458 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
7460 my $cust_pkg = new FS::cust_pkg ( {
7461 'custnum' => $self->custnum,
7462 'pkgpart' => $pkgpart,
7466 my $error = $cust_pkg->insert;
7467 $error ? $error : $cust_pkg;
7472 Returns all the invoices (see L<FS::cust_bill>) for this customer.
7478 map { $_ } #return $self->num_cust_bill unless wantarray;
7479 sort { $a->_date <=> $b->_date }
7480 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
7483 =item open_cust_bill
7485 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
7490 sub open_cust_bill {
7494 'table' => 'cust_bill',
7495 'hashref' => { 'custnum' => $self->custnum, },
7496 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
7497 'order_by' => 'ORDER BY _date ASC',
7502 =item cust_statements
7504 Returns all the statements (see L<FS::cust_statement>) for this customer.
7508 sub cust_statement {
7510 map { $_ } #return $self->num_cust_statement unless wantarray;
7511 sort { $a->_date <=> $b->_date }
7512 qsearch('cust_statement', { 'custnum' => $self->custnum, } )
7517 Returns all the credits (see L<FS::cust_credit>) for this customer.
7523 map { $_ } #return $self->num_cust_credit unless wantarray;
7524 sort { $a->_date <=> $b->_date }
7525 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
7528 =item cust_credit_pkgnum
7530 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
7531 package when using experimental package balances.
7535 sub cust_credit_pkgnum {
7536 my( $self, $pkgnum ) = @_;
7537 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
7538 sort { $a->_date <=> $b->_date }
7539 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
7540 'pkgnum' => $pkgnum,
7547 Returns all the payments (see L<FS::cust_pay>) for this customer.
7553 return $self->num_cust_pay unless wantarray;
7554 sort { $a->_date <=> $b->_date }
7555 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
7560 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
7561 called automatically when the cust_pay method is used in a scalar context.
7567 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
7568 my $sth = dbh->prepare($sql) or die dbh->errstr;
7569 $sth->execute($self->custnum) or die $sth->errstr;
7570 $sth->fetchrow_arrayref->[0];
7573 =item cust_pay_pkgnum
7575 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
7576 package when using experimental package balances.
7580 sub cust_pay_pkgnum {
7581 my( $self, $pkgnum ) = @_;
7582 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
7583 sort { $a->_date <=> $b->_date }
7584 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
7585 'pkgnum' => $pkgnum,
7592 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
7598 map { $_ } #return $self->num_cust_pay_void unless wantarray;
7599 sort { $a->_date <=> $b->_date }
7600 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
7603 =item cust_pay_batch
7605 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
7609 sub cust_pay_batch {
7611 map { $_ } #return $self->num_cust_pay_batch unless wantarray;
7612 sort { $a->paybatchnum <=> $b->paybatchnum }
7613 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
7616 =item cust_pay_pending
7618 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
7619 (without status "done").
7623 sub cust_pay_pending {
7625 return $self->num_cust_pay_pending unless wantarray;
7626 sort { $a->_date <=> $b->_date }
7627 qsearch( 'cust_pay_pending', {
7628 'custnum' => $self->custnum,
7629 'status' => { op=>'!=', value=>'done' },
7634 =item num_cust_pay_pending
7636 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
7637 customer (without status "done"). Also called automatically when the
7638 cust_pay_pending method is used in a scalar context.
7642 sub num_cust_pay_pending {
7644 my $sql = " SELECT COUNT(*) FROM cust_pay_pending ".
7645 " WHERE custnum = ? AND status != 'done' ";
7646 my $sth = dbh->prepare($sql) or die dbh->errstr;
7647 $sth->execute($self->custnum) or die $sth->errstr;
7648 $sth->fetchrow_arrayref->[0];
7653 Returns all the refunds (see L<FS::cust_refund>) for this customer.
7659 map { $_ } #return $self->num_cust_refund unless wantarray;
7660 sort { $a->_date <=> $b->_date }
7661 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
7664 =item display_custnum
7666 Returns the displayed customer number for this customer: agent_custid if
7667 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
7671 sub display_custnum {
7673 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
7674 return $self->agent_custid;
7676 return $self->custnum;
7682 Returns a name string for this customer, either "Company (Last, First)" or
7689 my $name = $self->contact;
7690 $name = $self->company. " ($name)" if $self->company;
7696 Returns a name string for this (service/shipping) contact, either
7697 "Company (Last, First)" or "Last, First".
7703 if ( $self->get('ship_last') ) {
7704 my $name = $self->ship_contact;
7705 $name = $self->ship_company. " ($name)" if $self->ship_company;
7714 Returns a name string for this customer, either "Company" or "First Last".
7720 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
7723 =item ship_name_short
7725 Returns a name string for this (service/shipping) contact, either "Company"
7730 sub ship_name_short {
7732 if ( $self->get('ship_last') ) {
7733 $self->ship_company !~ /^\s*$/
7734 ? $self->ship_company
7735 : $self->ship_contact_firstlast;
7737 $self->name_company_or_firstlast;
7743 Returns this customer's full (billing) contact name only, "Last, First"
7749 $self->get('last'). ', '. $self->first;
7754 Returns this customer's full (shipping) contact name only, "Last, First"
7760 $self->get('ship_last')
7761 ? $self->get('ship_last'). ', '. $self->ship_first
7765 =item contact_firstlast
7767 Returns this customers full (billing) contact name only, "First Last".
7771 sub contact_firstlast {
7773 $self->first. ' '. $self->get('last');
7776 =item ship_contact_firstlast
7778 Returns this customer's full (shipping) contact name only, "First Last".
7782 sub ship_contact_firstlast {
7784 $self->get('ship_last')
7785 ? $self->first. ' '. $self->get('ship_last')
7786 : $self->contact_firstlast;
7791 Returns this customer's full country name
7797 code2country($self->country);
7800 =item geocode DATA_VENDOR
7802 Returns a value for the customer location as encoded by DATA_VENDOR.
7803 Currently this only makes sense for "CCH" as DATA_VENDOR.
7808 my ($self, $data_vendor) = (shift, shift); #always cch for now
7810 my $geocode = $self->get('geocode'); #XXX only one data_vendor for geocode
7811 return $geocode if $geocode;
7813 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
7817 my ($zip,$plus4) = split /-/, $self->get("${prefix}zip")
7818 if $self->country eq 'US';
7820 #CCH specific location stuff
7821 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
7823 my @cust_tax_location =
7825 'table' => 'cust_tax_location',
7826 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
7827 'extra_sql' => $extra_sql,
7828 'order_by' => 'ORDER BY plus4hi',#overlapping with distinct ends
7831 $geocode = $cust_tax_location[0]->geocode
7832 if scalar(@cust_tax_location);
7841 Returns a status string for this customer, currently:
7845 =item prospect - No packages have ever been ordered
7847 =item active - One or more recurring packages is active
7849 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
7851 =item suspended - All non-cancelled recurring packages are suspended
7853 =item cancelled - All recurring packages are cancelled
7859 sub status { shift->cust_status(@_); }
7863 for my $status (qw( prospect active inactive suspended cancelled )) {
7864 my $method = $status.'_sql';
7865 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
7866 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
7867 $sth->execute( ($self->custnum) x $numnum )
7868 or die "Error executing 'SELECT $sql': ". $sth->errstr;
7869 return $status if $sth->fetchrow_arrayref->[0];
7873 =item ucfirst_cust_status
7875 =item ucfirst_status
7877 Returns the status with the first character capitalized.
7881 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
7883 sub ucfirst_cust_status {
7885 ucfirst($self->cust_status);
7890 Returns a hex triplet color string for this customer's status.
7894 use vars qw(%statuscolor);
7895 tie %statuscolor, 'Tie::IxHash',
7896 'prospect' => '7e0079', #'000000', #black? naw, purple
7897 'active' => '00CC00', #green
7898 'inactive' => '0000CC', #blue
7899 'suspended' => 'FF9900', #yellow
7900 'cancelled' => 'FF0000', #red
7903 sub statuscolor { shift->cust_statuscolor(@_); }
7905 sub cust_statuscolor {
7907 $statuscolor{$self->cust_status};
7912 Returns an array of hashes representing the customer's RT tickets.
7919 my $num = $conf->config('cust_main-max_tickets') || 10;
7922 if ( $conf->config('ticket_system') ) {
7923 unless ( $conf->config('ticket_system-custom_priority_field') ) {
7925 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
7929 foreach my $priority (
7930 $conf->config('ticket_system-custom_priority_field-values'), ''
7932 last if scalar(@tickets) >= $num;
7934 @{ FS::TicketSystem->customer_tickets( $self->custnum,
7935 $num - scalar(@tickets),
7945 # Return services representing svc_accts in customer support packages
7946 sub support_services {
7948 my %packages = map { $_ => 1 } $conf->config('support_packages');
7950 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
7951 grep { $_->part_svc->svcdb eq 'svc_acct' }
7952 map { $_->cust_svc }
7953 grep { exists $packages{ $_->pkgpart } }
7954 $self->ncancelled_pkgs;
7958 # Return a list of latitude/longitude for one of the services (if any)
7959 sub service_coordinates {
7963 grep { $_->latitude && $_->longitude }
7965 map { $_->cust_svc }
7966 $self->ncancelled_pkgs;
7968 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
7973 =head1 CLASS METHODS
7979 Class method that returns the list of possible status strings for customers
7980 (see L<the status method|/status>). For example:
7982 @statuses = FS::cust_main->statuses();
7987 #my $self = shift; #could be class...
7993 Returns an SQL expression identifying prospective cust_main records (customers
7994 with no packages ever ordered)
7998 use vars qw($select_count_pkgs);
7999 $select_count_pkgs =
8000 "SELECT COUNT(*) FROM cust_pkg
8001 WHERE cust_pkg.custnum = cust_main.custnum";
8003 sub select_count_pkgs_sql {
8007 sub prospect_sql { "
8008 0 = ( $select_count_pkgs )
8013 Returns an SQL expression identifying active cust_main records (customers with
8014 active recurring packages).
8019 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
8025 Returns an SQL expression identifying inactive cust_main records (customers with
8026 no active recurring packages, but otherwise unsuspended/uncancelled).
8030 sub inactive_sql { "
8031 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
8033 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
8039 Returns an SQL expression identifying suspended cust_main records.
8044 sub suspended_sql { susp_sql(@_); }
8046 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
8048 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
8054 Returns an SQL expression identifying cancelled cust_main records.
8058 sub cancelled_sql { cancel_sql(@_); }
8061 my $recurring_sql = FS::cust_pkg->recurring_sql;
8062 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
8065 0 < ( $select_count_pkgs )
8066 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
8067 AND 0 = ( $select_count_pkgs AND $recurring_sql
8068 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
8070 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
8076 =item uncancelled_sql
8078 Returns an SQL expression identifying un-cancelled cust_main records.
8082 sub uncancelled_sql { uncancel_sql(@_); }
8083 sub uncancel_sql { "
8084 ( 0 < ( $select_count_pkgs
8085 AND ( cust_pkg.cancel IS NULL
8086 OR cust_pkg.cancel = 0
8089 OR 0 = ( $select_count_pkgs )
8095 Returns an SQL fragment to retreive the balance.
8100 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
8101 WHERE cust_bill.custnum = cust_main.custnum )
8102 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
8103 WHERE cust_pay.custnum = cust_main.custnum )
8104 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
8105 WHERE cust_credit.custnum = cust_main.custnum )
8106 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
8107 WHERE cust_refund.custnum = cust_main.custnum )
8110 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8112 Returns an SQL fragment to retreive the balance for this customer, only
8113 considering invoices with date earlier than START_TIME, and optionally not
8114 later than END_TIME (total_owed_date minus total_unapplied_credits minus
8115 total_unapplied_payments).
8117 Times are specified as SQL fragments or numeric
8118 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
8119 L<Date::Parse> for conversion functions. The empty string can be passed
8120 to disable that time constraint completely.
8122 Available options are:
8126 =item unapplied_date
8128 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)
8133 set to true to remove all customer comparison clauses, for totals
8138 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
8143 JOIN clause (typically used with the total option)
8149 sub balance_date_sql {
8150 my( $class, $start, $end, %opt ) = @_;
8152 my $owed = FS::cust_bill->owed_sql;
8153 my $unapp_refund = FS::cust_refund->unapplied_sql;
8154 my $unapp_credit = FS::cust_credit->unapplied_sql;
8155 my $unapp_pay = FS::cust_pay->unapplied_sql;
8157 my $j = $opt{'join'} || '';
8159 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
8160 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
8161 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
8162 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
8164 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
8165 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
8166 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
8167 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
8172 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
8174 Returns an SQL fragment to retreive the total unapplied payments for this
8175 customer, only considering invoices with date earlier than START_TIME, and
8176 optionally not later than END_TIME.
8178 Times are specified as SQL fragments or numeric
8179 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
8180 L<Date::Parse> for conversion functions. The empty string can be passed
8181 to disable that time constraint completely.
8183 Available options are:
8187 sub unapplied_payments_date_sql {
8188 my( $class, $start, $end, ) = @_;
8190 my $unapp_pay = FS::cust_pay->unapplied_sql;
8192 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
8193 'unapplied_date'=>1 );
8195 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
8198 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8200 Helper method for balance_date_sql; name (and usage) subject to change
8201 (suggestions welcome).
8203 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
8204 cust_refund, cust_credit or cust_pay).
8206 If TABLE is "cust_bill" or the unapplied_date option is true, only
8207 considers records with date earlier than START_TIME, and optionally not
8208 later than END_TIME .
8212 sub _money_table_where {
8213 my( $class, $table, $start, $end, %opt ) = @_;
8216 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
8217 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
8218 push @where, "$table._date <= $start" if defined($start) && length($start);
8219 push @where, "$table._date > $end" if defined($end) && length($end);
8221 push @where, @{$opt{'where'}} if $opt{'where'};
8222 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
8228 =item search_sql HASHREF
8232 Returns a qsearch hash expression to search for parameters specified in HREF.
8233 Valid parameters are
8241 =item cancelled_pkgs
8247 listref of start date, end date
8253 =item current_balance
8255 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
8259 =item flattened_pkgs
8268 my ($class, $params) = @_;
8279 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
8281 "cust_main.agentnum = $1";
8288 #prospect active inactive suspended cancelled
8289 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
8290 my $method = $params->{'status'}. '_sql';
8291 #push @where, $class->$method();
8292 push @where, FS::cust_main->$method();
8296 # parse cancelled package checkbox
8301 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
8302 unless $params->{'cancelled_pkgs'};
8305 # parse without census tract checkbox
8308 push @where, "(censustract = '' or censustract is null)"
8309 if $params->{'no_censustract'};
8315 foreach my $field (qw( signupdate )) {
8317 next unless exists($params->{$field});
8319 my($beginning, $ending) = @{$params->{$field}};
8322 "cust_main.$field IS NOT NULL",
8323 "cust_main.$field >= $beginning",
8324 "cust_main.$field <= $ending";
8326 $orderby ||= "ORDER BY cust_main.$field";
8334 my @classnum = grep /^(\d*)$/, @{ $params->{'classnum'} };
8336 push @where, '( '. join(' OR ', map {
8337 $_ ? "cust_main.classnum = $_"
8338 : "cust_main.classnum IS NULL"
8349 my @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
8351 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )';
8358 #my $balance_sql = $class->balance_sql();
8359 my $balance_sql = FS::cust_main->balance_sql();
8361 push @where, map { s/current_balance/$balance_sql/; $_ }
8362 @{ $params->{'current_balance'} };
8368 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
8370 "cust_main.custbatch = '$1'";
8374 # setup queries, subs, etc. for the search
8377 $orderby ||= 'ORDER BY custnum';
8379 # here is the agent virtualization
8380 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
8382 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
8384 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
8386 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
8388 my $select = join(', ',
8389 'cust_main.custnum',
8390 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
8393 my(@extra_headers) = ();
8394 my(@extra_fields) = ();
8396 if ($params->{'flattened_pkgs'}) {
8398 if ($dbh->{Driver}->{Name} eq 'Pg') {
8400 $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";
8402 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
8403 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
8404 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
8406 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
8407 "omitting packing information from report.";
8410 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";
8412 my $sth = dbh->prepare($header_query) or die dbh->errstr;
8413 $sth->execute() or die $sth->errstr;
8414 my $headerrow = $sth->fetchrow_arrayref;
8415 my $headercount = $headerrow ? $headerrow->[0] : 0;
8416 while($headercount) {
8417 unshift @extra_headers, "Package ". $headercount;
8418 unshift @extra_fields, eval q!sub {my $c = shift;
8419 my @a = split '\|', $c->magic;
8420 my $p = $a[!.--$headercount. q!];
8428 'table' => 'cust_main',
8429 'select' => $select,
8431 'extra_sql' => $extra_sql,
8432 'order_by' => $orderby,
8433 'count_query' => $count_query,
8434 'extra_headers' => \@extra_headers,
8435 'extra_fields' => \@extra_fields,
8440 =item email_search_sql HASHREF
8444 Emails a notice to the specified customers.
8446 Valid parameters are those of the L<search_sql> method, plus the following:
8468 Optional job queue job for status updates.
8472 Returns an error message, or false for success.
8474 If an error occurs during any email, stops the enture send and returns that
8475 error. Presumably if you're getting SMTP errors aborting is better than
8476 retrying everything.
8480 sub email_search_sql {
8481 my($class, $params) = @_;
8483 my $from = delete $params->{from};
8484 my $subject = delete $params->{subject};
8485 my $html_body = delete $params->{html_body};
8486 my $text_body = delete $params->{text_body};
8488 my $job = delete $params->{'job'};
8490 $params->{'payby'} = [ split(/\0/, $params->{'payby'}) ]
8491 unless ref($params->{'payby'});
8493 my $sql_query = $class->search_sql($params);
8495 my $count_query = delete($sql_query->{'count_query'});
8496 my $count_sth = dbh->prepare($count_query)
8497 or die "Error preparing $count_query: ". dbh->errstr;
8499 or die "Error executing $count_query: ". $count_sth->errstr;
8500 my $count_arrayref = $count_sth->fetchrow_arrayref;
8501 my $num_cust = $count_arrayref->[0];
8503 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
8504 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
8507 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
8509 #eventually order+limit magic to reduce memory use?
8510 foreach my $cust_main ( qsearch($sql_query) ) {
8512 my $to = $cust_main->invoicing_list_emailonly_scalar;
8515 my $error = send_email(
8519 'subject' => $subject,
8520 'html_body' => $html_body,
8521 'text_body' => $text_body,
8524 return $error if $error;
8526 if ( $job ) { #progressbar foo
8528 if ( time - $min_sec > $last ) {
8529 my $error = $job->update_statustext(
8530 int( 100 * $num / $num_cust )
8532 die $error if $error;
8542 use Storable qw(thaw);
8545 sub process_email_search_sql {
8547 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
8549 my $param = thaw(decode_base64(shift));
8550 warn Dumper($param) if $DEBUG;
8552 $param->{'job'} = $job;
8554 $param->{'payby'} = [ split(/\0/, $param->{'payby'}) ]
8555 unless ref($param->{'payby'});
8557 my $error = FS::cust_main->email_search_sql( $param );
8558 die $error if $error;
8562 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
8564 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
8565 records. Currently, I<first>, I<last>, I<company> and/or I<address1> may be
8566 specified (the appropriate ship_ field is also searched).
8568 Additional options are the same as FS::Record::qsearch
8573 my( $self, $fuzzy, $hash, @opt) = @_;
8578 check_and_rebuild_fuzzyfiles();
8579 foreach my $field ( keys %$fuzzy ) {
8581 my $all = $self->all_X($field);
8582 next unless scalar(@$all);
8585 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
8588 foreach ( keys %match ) {
8589 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
8590 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
8593 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
8596 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
8598 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
8606 Returns a masked version of the named field
8611 my ($self,$field) = @_;
8615 'x'x(length($self->getfield($field))-4).
8616 substr($self->getfield($field), (length($self->getfield($field))-4));
8626 =item smart_search OPTION => VALUE ...
8628 Accepts the following options: I<search>, the string to search for. The string
8629 will be searched for as a customer number, phone number, name or company name,
8630 as an exact, or, in some cases, a substring or fuzzy match (see the source code
8631 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
8632 skip fuzzy matching when an exact match is found.
8634 Any additional options are treated as an additional qualifier on the search
8637 Returns a (possibly empty) array of FS::cust_main objects.
8644 #here is the agent virtualization
8645 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8649 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
8650 my $search = delete $options{'search'};
8651 ( my $alphanum_search = $search ) =~ s/\W//g;
8653 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
8655 #false laziness w/Record::ut_phone
8656 my $phonen = "$1-$2-$3";
8657 $phonen .= " x$4" if $4;
8659 push @cust_main, qsearch( {
8660 'table' => 'cust_main',
8661 'hashref' => { %options },
8662 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8664 join(' OR ', map "$_ = '$phonen'",
8665 qw( daytime night fax
8666 ship_daytime ship_night ship_fax )
8669 " AND $agentnums_sql", #agent virtualization
8672 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
8673 #try looking for matches with extensions unless one was specified
8675 push @cust_main, qsearch( {
8676 'table' => 'cust_main',
8677 'hashref' => { %options },
8678 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8680 join(' OR ', map "$_ LIKE '$phonen\%'",
8682 ship_daytime ship_night )
8685 " AND $agentnums_sql", #agent virtualization
8690 # custnum search (also try agent_custid), with some tweaking options if your
8691 # legacy cust "numbers" have letters
8694 if ( $search =~ /^\s*(\d+)\s*$/
8695 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
8696 && $search =~ /^\s*(\w\w?\d+)\s*$/
8698 || ( $conf->exists('address1-search' )
8699 && $search =~ /^\s*(\d+\-?\w*)\s*$/ #i.e. 1234A or 9432-D
8706 if ( $num =~ /^(\d+)$/ && $num <= 2147483647 ) { #need a bigint custnum? wow
8707 push @cust_main, qsearch( {
8708 'table' => 'cust_main',
8709 'hashref' => { 'custnum' => $num, %options },
8710 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8714 push @cust_main, qsearch( {
8715 'table' => 'cust_main',
8716 'hashref' => { 'agent_custid' => $num, %options },
8717 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8720 if ( $conf->exists('address1-search') ) {
8721 my $len = length($num);
8723 foreach my $prefix ( '', 'ship_' ) {
8724 push @cust_main, qsearch( {
8725 'table' => 'cust_main',
8726 'hashref' => { %options, },
8728 ( keys(%options) ? ' AND ' : ' WHERE ' ).
8729 " LOWER(SUBSTRING(${prefix}address1 FROM 1 FOR $len)) = '$num' ".
8730 " AND $agentnums_sql",
8735 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
8737 my($company, $last, $first) = ( $1, $2, $3 );
8739 # "Company (Last, First)"
8740 #this is probably something a browser remembered,
8741 #so just do an exact (but case-insensitive) search
8743 foreach my $prefix ( '', 'ship_' ) {
8744 push @cust_main, qsearch( {
8745 'table' => 'cust_main',
8746 'hashref' => { $prefix.'first' => $first,
8747 $prefix.'last' => $last,
8748 $prefix.'company' => $company,
8751 'extra_sql' => " AND $agentnums_sql",
8755 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
8756 # try (ship_){last,company}
8760 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
8761 # # full strings the browser remembers won't work
8762 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
8764 use Lingua::EN::NameParse;
8765 my $NameParse = new Lingua::EN::NameParse(
8767 allow_reversed => 1,
8770 my($last, $first) = ( '', '' );
8771 #maybe disable this too and just rely on NameParse?
8772 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
8774 ($last, $first) = ( $1, $2 );
8776 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
8777 } elsif ( ! $NameParse->parse($value) ) {
8779 my %name = $NameParse->components;
8780 $first = $name{'given_name_1'};
8781 $last = $name{'surname_1'};
8785 if ( $first && $last ) {
8787 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
8790 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8792 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
8793 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
8796 push @cust_main, qsearch( {
8797 'table' => 'cust_main',
8798 'hashref' => \%options,
8799 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8802 # or it just be something that was typed in... (try that in a sec)
8806 my $q_value = dbh->quote($value);
8809 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8810 $sql .= " ( LOWER(last) = $q_value
8811 OR LOWER(company) = $q_value
8812 OR LOWER(ship_last) = $q_value
8813 OR LOWER(ship_company) = $q_value
8815 $sql .= " OR LOWER(address1) = $q_value
8816 OR LOWER(ship_address1) = $q_value
8818 if $conf->exists('address1-search');
8821 push @cust_main, qsearch( {
8822 'table' => 'cust_main',
8823 'hashref' => \%options,
8824 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8827 #no exact match, trying substring/fuzzy
8828 #always do substring & fuzzy (unless they're explicity config'ed off)
8829 #getting complaints searches are not returning enough
8830 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
8832 #still some false laziness w/search_sql (was search/cust_main.cgi)
8837 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
8838 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
8841 if ( $first && $last ) {
8844 { 'first' => { op=>'ILIKE', value=>"%$first%" },
8845 'last' => { op=>'ILIKE', value=>"%$last%" },
8847 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
8848 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
8855 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
8856 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
8860 if ( $conf->exists('address1-search') ) {
8862 { 'address1' => { op=>'ILIKE', value=>"%$value%" }, },
8863 { 'ship_address1' => { op=>'ILIKE', value=>"%$value%" }, },
8867 foreach my $hashref ( @hashrefs ) {
8869 push @cust_main, qsearch( {
8870 'table' => 'cust_main',
8871 'hashref' => { %$hashref,
8874 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
8883 " AND $agentnums_sql", #extra_sql #agent virtualization
8886 if ( $first && $last ) {
8887 push @cust_main, FS::cust_main->fuzzy_search(
8888 { 'last' => $last, #fuzzy hashref
8889 'first' => $first }, #
8893 foreach my $field ( 'last', 'company' ) {
8895 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
8897 if ( $conf->exists('address1-search') ) {
8899 FS::cust_main->fuzzy_search( { 'address1' => $value }, @fuzopts );
8906 #eliminate duplicates
8908 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8916 Accepts the following options: I<email>, the email address to search for. The
8917 email address will be searched for as an email invoice destination and as an
8920 #Any additional options are treated as an additional qualifier on the search
8921 #(i.e. I<agentnum>).
8923 Returns a (possibly empty) array of FS::cust_main objects (but usually just
8933 my $email = delete $options{'email'};
8935 #we're only being used by RT at the moment... no agent virtualization yet
8936 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8940 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
8942 my ( $user, $domain ) = ( $1, $2 );
8944 warn "$me smart_search: searching for $user in domain $domain"
8950 'table' => 'cust_main_invoice',
8951 'hashref' => { 'dest' => $email },
8958 map $_->cust_svc->cust_pkg,
8960 'table' => 'svc_acct',
8961 'hashref' => { 'username' => $user, },
8963 'AND ( SELECT domain FROM svc_domain
8964 WHERE svc_acct.domsvc = svc_domain.svcnum
8965 ) = '. dbh->quote($domain),
8971 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8973 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
8980 =item check_and_rebuild_fuzzyfiles
8984 sub check_and_rebuild_fuzzyfiles {
8985 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8986 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
8989 =item rebuild_fuzzyfiles
8993 sub rebuild_fuzzyfiles {
8995 use Fcntl qw(:flock);
8997 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8998 mkdir $dir, 0700 unless -d $dir;
9000 foreach my $fuzzy ( @fuzzyfields ) {
9002 open(LOCK,">>$dir/cust_main.$fuzzy")
9003 or die "can't open $dir/cust_main.$fuzzy: $!";
9005 or die "can't lock $dir/cust_main.$fuzzy: $!";
9007 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
9008 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
9010 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
9011 my $sth = dbh->prepare("SELECT $field FROM cust_main".
9012 " WHERE $field != '' AND $field IS NOT NULL");
9013 $sth->execute or die $sth->errstr;
9015 while ( my $row = $sth->fetchrow_arrayref ) {
9016 print CACHE $row->[0]. "\n";
9021 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
9023 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
9034 my( $self, $field ) = @_;
9035 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9036 open(CACHE,"<$dir/cust_main.$field")
9037 or die "can't open $dir/cust_main.$field: $!";
9038 my @array = map { chomp; $_; } <CACHE>;
9043 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
9047 sub append_fuzzyfiles {
9048 #my( $first, $last, $company ) = @_;
9050 &check_and_rebuild_fuzzyfiles;
9052 use Fcntl qw(:flock);
9054 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9056 foreach my $field (@fuzzyfields) {
9061 open(CACHE,">>$dir/cust_main.$field")
9062 or die "can't open $dir/cust_main.$field: $!";
9063 flock(CACHE,LOCK_EX)
9064 or die "can't lock $dir/cust_main.$field: $!";
9066 print CACHE "$value\n";
9068 flock(CACHE,LOCK_UN)
9069 or die "can't unlock $dir/cust_main.$field: $!";
9084 #warn join('-',keys %$param);
9085 my $fh = $param->{filehandle};
9086 my @fields = @{$param->{fields}};
9088 eval "use Text::CSV_XS;";
9091 my $csv = new Text::CSV_XS;
9098 local $SIG{HUP} = 'IGNORE';
9099 local $SIG{INT} = 'IGNORE';
9100 local $SIG{QUIT} = 'IGNORE';
9101 local $SIG{TERM} = 'IGNORE';
9102 local $SIG{TSTP} = 'IGNORE';
9103 local $SIG{PIPE} = 'IGNORE';
9105 my $oldAutoCommit = $FS::UID::AutoCommit;
9106 local $FS::UID::AutoCommit = 0;
9109 #while ( $columns = $csv->getline($fh) ) {
9111 while ( defined($line=<$fh>) ) {
9113 $csv->parse($line) or do {
9114 $dbh->rollback if $oldAutoCommit;
9115 return "can't parse: ". $csv->error_input();
9118 my @columns = $csv->fields();
9119 #warn join('-',@columns);
9122 foreach my $field ( @fields ) {
9123 $row{$field} = shift @columns;
9126 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
9127 unless ( $cust_main ) {
9128 $dbh->rollback if $oldAutoCommit;
9129 return "unknown custnum $row{'custnum'}";
9132 if ( $row{'amount'} > 0 ) {
9133 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
9135 $dbh->rollback if $oldAutoCommit;
9139 } elsif ( $row{'amount'} < 0 ) {
9140 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
9143 $dbh->rollback if $oldAutoCommit;
9153 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
9155 return "Empty file!" unless $imported;
9161 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9163 Sends a templated email notification to the customer (see L<Text::Template>).
9165 OPTIONS is a hash and may include
9167 I<from> - the email sender (default is invoice_from)
9169 I<to> - comma-separated scalar or arrayref of recipients
9170 (default is invoicing_list)
9172 I<subject> - The subject line of the sent email notification
9173 (default is "Notice from company_name")
9175 I<extra_fields> - a hashref of name/value pairs which will be substituted
9178 The following variables are vavailable in the template.
9180 I<$first> - the customer first name
9181 I<$last> - the customer last name
9182 I<$company> - the customer company
9183 I<$payby> - a description of the method of payment for the customer
9184 # would be nice to use FS::payby::shortname
9185 I<$payinfo> - the account information used to collect for this customer
9186 I<$expdate> - the expiration of the customer payment in seconds from epoch
9191 my ($self, $template, %options) = @_;
9193 return unless $conf->exists($template);
9195 my $from = $conf->config('invoice_from', $self->agentnum)
9196 if $conf->exists('invoice_from', $self->agentnum);
9197 $from = $options{from} if exists($options{from});
9199 my $to = join(',', $self->invoicing_list_emailonly);
9200 $to = $options{to} if exists($options{to});
9202 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
9203 if $conf->exists('company_name', $self->agentnum);
9204 $subject = $options{subject} if exists($options{subject});
9206 my $notify_template = new Text::Template (TYPE => 'ARRAY',
9207 SOURCE => [ map "$_\n",
9208 $conf->config($template)]
9210 or die "can't create new Text::Template object: Text::Template::ERROR";
9211 $notify_template->compile()
9212 or die "can't compile template: Text::Template::ERROR";
9214 $FS::notify_template::_template::company_name =
9215 $conf->config('company_name', $self->agentnum);
9216 $FS::notify_template::_template::company_address =
9217 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
9219 my $paydate = $self->paydate || '2037-12-31';
9220 $FS::notify_template::_template::first = $self->first;
9221 $FS::notify_template::_template::last = $self->last;
9222 $FS::notify_template::_template::company = $self->company;
9223 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
9224 my $payby = $self->payby;
9225 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9226 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9228 #credit cards expire at the end of the month/year of their exp date
9229 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9230 $FS::notify_template::_template::payby = 'credit card';
9231 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9232 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9234 }elsif ($payby eq 'COMP') {
9235 $FS::notify_template::_template::payby = 'complimentary account';
9237 $FS::notify_template::_template::payby = 'current method';
9239 $FS::notify_template::_template::expdate = $expire_time;
9241 for (keys %{$options{extra_fields}}){
9243 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
9246 send_email(from => $from,
9248 subject => $subject,
9249 body => $notify_template->fill_in( PACKAGE =>
9250 'FS::notify_template::_template' ),
9255 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9257 Generates a templated notification to the customer (see L<Text::Template>).
9259 OPTIONS is a hash and may include
9261 I<extra_fields> - a hashref of name/value pairs which will be substituted
9262 into the template. These values may override values mentioned below
9263 and those from the customer record.
9265 The following variables are available in the template instead of or in addition
9266 to the fields of the customer record.
9268 I<$payby> - a description of the method of payment for the customer
9269 # would be nice to use FS::payby::shortname
9270 I<$payinfo> - the masked account information used to collect for this customer
9271 I<$expdate> - the expiration of the customer payment method in seconds from epoch
9272 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
9276 sub generate_letter {
9277 my ($self, $template, %options) = @_;
9279 return unless $conf->exists($template);
9281 my $letter_template = new Text::Template
9283 SOURCE => [ map "$_\n", $conf->config($template)],
9284 DELIMITERS => [ '[@--', '--@]' ],
9286 or die "can't create new Text::Template object: Text::Template::ERROR";
9288 $letter_template->compile()
9289 or die "can't compile template: Text::Template::ERROR";
9291 my %letter_data = map { $_ => $self->$_ } $self->fields;
9292 $letter_data{payinfo} = $self->mask_payinfo;
9294 #my $paydate = $self->paydate || '2037-12-31';
9295 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
9297 my $payby = $self->payby;
9298 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9299 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9301 #credit cards expire at the end of the month/year of their exp date
9302 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9303 $letter_data{payby} = 'credit card';
9304 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9305 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9307 }elsif ($payby eq 'COMP') {
9308 $letter_data{payby} = 'complimentary account';
9310 $letter_data{payby} = 'current method';
9312 $letter_data{expdate} = $expire_time;
9314 for (keys %{$options{extra_fields}}){
9315 $letter_data{$_} = $options{extra_fields}->{$_};
9318 unless(exists($letter_data{returnaddress})){
9319 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
9320 $self->agent_template)
9322 if ( length($retadd) ) {
9323 $letter_data{returnaddress} = $retadd;
9324 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
9325 $letter_data{returnaddress} =
9326 join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
9327 $conf->config('company_address', $self->agentnum)
9330 $letter_data{returnaddress} = '~';
9334 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
9336 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
9338 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
9339 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
9343 ) or die "can't open temp file: $!\n";
9345 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
9347 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
9351 =item print_ps TEMPLATE
9353 Returns an postscript letter filled in from TEMPLATE, as a scalar.
9359 my $file = $self->generate_letter(@_);
9360 FS::Misc::generate_ps($file);
9363 =item print TEMPLATE
9365 Prints the filled in template.
9367 TEMPLATE is the name of a L<Text::Template> to fill in and print.
9371 sub queueable_print {
9374 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
9375 or die "invalid customer number: " . $opt{custvnum};
9377 my $error = $self->print( $opt{template} );
9378 die $error if $error;
9382 my ($self, $template) = (shift, shift);
9383 do_print [ $self->print_ps($template) ];
9386 #these three subs should just go away once agent stuff is all config overrides
9388 sub agent_template {
9390 $self->_agent_plandata('agent_templatename');
9393 sub agent_invoice_from {
9395 $self->_agent_plandata('agent_invoice_from');
9398 sub _agent_plandata {
9399 my( $self, $option ) = @_;
9401 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
9402 #agent-specific Conf
9404 use FS::part_event::Condition;
9406 my $agentnum = $self->agentnum;
9409 if ( driver_name =~ /^Pg/i ) {
9411 } elsif ( driver_name =~ /^mysql/i ) {
9414 die "don't know how to use regular expressions in ". driver_name. " databases";
9417 my $part_event_option =
9419 'select' => 'part_event_option.*',
9420 'table' => 'part_event_option',
9422 LEFT JOIN part_event USING ( eventpart )
9423 LEFT JOIN part_event_option AS peo_agentnum
9424 ON ( part_event.eventpart = peo_agentnum.eventpart
9425 AND peo_agentnum.optionname = 'agentnum'
9426 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
9428 LEFT JOIN part_event_condition
9429 ON ( part_event.eventpart = part_event_condition.eventpart
9430 AND part_event_condition.conditionname = 'cust_bill_age'
9432 LEFT JOIN part_event_condition_option
9433 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
9434 AND part_event_condition_option.optionname = 'age'
9437 #'hashref' => { 'optionname' => $option },
9438 #'hashref' => { 'part_event_option.optionname' => $option },
9440 " WHERE part_event_option.optionname = ". dbh->quote($option).
9441 " AND action = 'cust_bill_send_agent' ".
9442 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
9443 " AND peo_agentnum.optionname = 'agentnum' ".
9444 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
9446 CASE WHEN part_event_condition_option.optionname IS NULL
9448 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
9450 , part_event.weight".
9454 unless ( $part_event_option ) {
9455 return $self->agent->invoice_template || ''
9456 if $option eq 'agent_templatename';
9460 $part_event_option->optionvalue;
9465 ## actual sub, not a method, designed to be called from the queue.
9466 ## sets up the customer, and calls the bill_and_collect
9467 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
9468 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
9469 $cust_main->bill_and_collect(
9474 sub _upgrade_data { #class method
9475 my ($class, %opts) = @_;
9477 my $sql = 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL';
9478 my $sth = dbh->prepare($sql) or die dbh->errstr;
9479 $sth->execute or die $sth->errstr;
9489 The delete method should possibly take an FS::cust_main object reference
9490 instead of a scalar customer number.
9492 Bill and collect options should probably be passed as references instead of a
9495 There should probably be a configuration file with a list of allowed credit
9498 No multiple currency support (probably a larger project than just this module).
9500 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
9502 Birthdates rely on negative epoch values.
9504 The payby for card/check batches is broken. With mixed batching, bad
9507 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
9511 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
9512 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
9513 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.