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;
48 use FS::cust_main_exemption;
49 use FS::cust_tax_adjustment;
51 use FS::tax_rate_location;
52 use FS::cust_tax_location;
53 use FS::part_pkg_taxrate;
55 use FS::cust_main_invoice;
56 use FS::cust_credit_bill;
57 use FS::cust_bill_pay;
58 use FS::prepay_credit;
62 use FS::part_event_condition;
65 use FS::payment_gateway;
66 use FS::agent_payment_gateway;
68 use FS::payinfo_Mixin;
71 @ISA = qw( FS::payinfo_Mixin FS::Record );
73 @EXPORT_OK = qw( smart_search );
75 $realtime_bop_decline_quiet = 0;
77 # 1 is mostly method/subroutine entry and options
78 # 2 traces progress of some operations
79 # 3 is even more information including possibly sensitive data
81 $me = '[FS::cust_main]';
84 $ignore_expired_card = 0;
87 @fuzzyfields = ( 'first', 'last', 'company', 'address1' );
89 @encrypted_fields = ('payinfo', 'paycvv');
90 sub nohistory_fields { ('paycvv'); }
92 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
94 #ask FS::UID to run this stuff for us later
95 #$FS::UID::callback{'FS::cust_main'} = sub {
96 install_callback FS::UID sub {
98 #yes, need it for stuff below (prolly should be cached)
103 my ( $hashref, $cache ) = @_;
104 if ( exists $hashref->{'pkgnum'} ) {
105 #@{ $self->{'_pkgnum'} } = ();
106 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
107 $self->{'_pkgnum'} = $subcache;
108 #push @{ $self->{'_pkgnum'} },
109 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
115 FS::cust_main - Object methods for cust_main records
121 $record = new FS::cust_main \%hash;
122 $record = new FS::cust_main { 'column' => 'value' };
124 $error = $record->insert;
126 $error = $new_record->replace($old_record);
128 $error = $record->delete;
130 $error = $record->check;
132 @cust_pkg = $record->all_pkgs;
134 @cust_pkg = $record->ncancelled_pkgs;
136 @cust_pkg = $record->suspended_pkgs;
138 $error = $record->bill;
139 $error = $record->bill %options;
140 $error = $record->bill 'time' => $time;
142 $error = $record->collect;
143 $error = $record->collect %options;
144 $error = $record->collect 'invoice_time' => $time,
149 An FS::cust_main object represents a customer. FS::cust_main inherits from
150 FS::Record. The following fields are currently supported:
156 Primary key (assigned automatically for new customers)
160 Agent (see L<FS::agent>)
164 Advertising source (see L<FS::part_referral>)
176 Cocial security number (optional)
192 (optional, see L<FS::cust_main_county>)
196 (see L<FS::cust_main_county>)
202 (see L<FS::cust_main_county>)
238 (optional, see L<FS::cust_main_county>)
242 (see L<FS::cust_main_county>)
248 (see L<FS::cust_main_county>)
264 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
268 Payment Information (See L<FS::payinfo_Mixin> for data format)
272 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
276 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
280 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
284 Start date month (maestro/solo cards only)
288 Start date year (maestro/solo cards only)
292 Issue number (maestro/solo cards only)
296 Name on card or billing name
300 IP address from which payment information was received
304 Tax exempt, empty or `Y'
308 Order taker (assigned automatically, see L<FS::UID>)
314 =item referral_custnum
316 Referring customer number
320 Enable individual CDR spooling, empty or `Y'
324 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
328 Discourage individual CDR printing, empty or `Y'
338 Creates a new customer. To add the customer to the database, see L<"insert">.
340 Note that this stores the hash reference, not a distinct copy of the hash it
341 points to. You can ask the object for a copy with the I<hash> method.
345 sub table { 'cust_main'; }
347 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
349 Adds this customer to the database. If there is an error, returns the error,
350 otherwise returns false.
352 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
353 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
354 are inserted atomicly, or the transaction is rolled back. Passing an empty
355 hash reference is equivalent to not supplying this parameter. There should be
356 a better explanation of this, but until then, here's an example:
359 tie %hash, 'Tie::RefHash'; #this part is important
361 $cust_pkg => [ $svc_acct ],
364 $cust_main->insert( \%hash );
366 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
367 be set as the invoicing list (see L<"invoicing_list">). Errors return as
368 expected and rollback the entire transaction; it is not necessary to call
369 check_invoicing_list first. The invoicing_list is set after the records in the
370 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
371 invoicing_list destination to the newly-created svc_acct. Here's an example:
373 $cust_main->insert( {}, [ $email, 'POST' ] );
375 Currently available options are: I<depend_jobnum>, I<noexport> and I<tax_exemption>.
377 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
378 on the supplied jobnum (they will not run until the specific job completes).
379 This can be used to defer provisioning until some action completes (such
380 as running the customer's credit card successfully).
382 The I<noexport> option is deprecated. If I<noexport> is set true, no
383 provisioning jobs (exports) are scheduled. (You can schedule them later with
384 the B<reexport> method.)
386 The I<tax_exemption> option can be set to an arrayref of tax names.
387 FS::cust_main_exemption records will be created and inserted.
393 my $cust_pkgs = @_ ? shift : {};
394 my $invoicing_list = @_ ? shift : '';
396 warn "$me insert called with options ".
397 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
400 local $SIG{HUP} = 'IGNORE';
401 local $SIG{INT} = 'IGNORE';
402 local $SIG{QUIT} = 'IGNORE';
403 local $SIG{TERM} = 'IGNORE';
404 local $SIG{TSTP} = 'IGNORE';
405 local $SIG{PIPE} = 'IGNORE';
407 my $oldAutoCommit = $FS::UID::AutoCommit;
408 local $FS::UID::AutoCommit = 0;
411 my $prepay_identifier = '';
412 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
414 if ( $self->payby eq 'PREPAY' ) {
416 $self->payby('BILL');
417 $prepay_identifier = $self->payinfo;
420 warn " looking up prepaid card $prepay_identifier\n"
423 my $error = $self->get_prepay( $prepay_identifier,
424 'amount_ref' => \$amount,
425 'seconds_ref' => \$seconds,
426 'upbytes_ref' => \$upbytes,
427 'downbytes_ref' => \$downbytes,
428 'totalbytes_ref' => \$totalbytes,
431 $dbh->rollback if $oldAutoCommit;
432 #return "error applying prepaid card (transaction rolled back): $error";
436 $payby = 'PREP' if $amount;
438 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
441 $self->payby('BILL');
442 $amount = $self->paid;
446 warn " inserting $self\n"
449 $self->signupdate(time) unless $self->signupdate;
451 $self->auto_agent_custid()
452 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
454 my $error = $self->SUPER::insert;
456 $dbh->rollback if $oldAutoCommit;
457 #return "inserting cust_main record (transaction rolled back): $error";
461 warn " setting invoicing list\n"
464 if ( $invoicing_list ) {
465 $error = $self->check_invoicing_list( $invoicing_list );
467 $dbh->rollback if $oldAutoCommit;
468 #return "checking invoicing_list (transaction rolled back): $error";
471 $self->invoicing_list( $invoicing_list );
474 warn " setting cust_main_exemption\n"
477 my $tax_exemption = delete $options{'tax_exemption'};
478 if ( $tax_exemption ) {
479 foreach my $taxname ( @$tax_exemption ) {
480 my $cust_main_exemption = new FS::cust_main_exemption {
481 'custnum' => $self->custnum,
482 'taxname' => $taxname,
484 my $error = $cust_main_exemption->insert;
486 $dbh->rollback if $oldAutoCommit;
487 return "inserting cust_main_exemption (transaction rolled back): $error";
492 if ( $conf->config('cust_main-skeleton_tables')
493 && $conf->config('cust_main-skeleton_custnum') ) {
495 warn " inserting skeleton records\n"
498 my $error = $self->start_copy_skel;
500 $dbh->rollback if $oldAutoCommit;
506 warn " ordering packages\n"
509 $error = $self->order_pkgs( $cust_pkgs,
511 'seconds_ref' => \$seconds,
512 'upbytes_ref' => \$upbytes,
513 'downbytes_ref' => \$downbytes,
514 'totalbytes_ref' => \$totalbytes,
517 $dbh->rollback if $oldAutoCommit;
522 $dbh->rollback if $oldAutoCommit;
523 return "No svc_acct record to apply pre-paid time";
525 if ( $upbytes || $downbytes || $totalbytes ) {
526 $dbh->rollback if $oldAutoCommit;
527 return "No svc_acct record to apply pre-paid data";
531 warn " inserting initial $payby payment of $amount\n"
533 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
535 $dbh->rollback if $oldAutoCommit;
536 return "inserting payment (transaction rolled back): $error";
540 unless ( $import || $skip_fuzzyfiles ) {
541 warn " queueing fuzzyfiles update\n"
543 $error = $self->queue_fuzzyfiles_update;
545 $dbh->rollback if $oldAutoCommit;
546 return "updating fuzzy search cache: $error";
550 warn " insert complete; committing transaction\n"
553 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
558 use File::CounterFile;
559 sub auto_agent_custid {
562 my $format = $conf->config('cust_main-auto_agent_custid');
564 if ( $format eq '1YMMXXXXXXXX' ) {
566 my $counter = new File::CounterFile 'cust_main.agent_custid';
569 my $ym = 100000000000 + time2str('%y%m00000000', time);
570 if ( $ym > $counter->value ) {
571 $counter->{'value'} = $agent_custid = $ym;
572 $counter->{'updated'} = 1;
574 $agent_custid = $counter->inc;
580 die "Unknown cust_main-auto_agent_custid format: $format";
583 $self->agent_custid($agent_custid);
587 sub start_copy_skel {
590 #'mg_user_preference' => {},
591 #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
592 #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
593 #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
594 #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
595 my @tables = eval(join('\n',$conf->config('cust_main-skeleton_tables')));
598 _copy_skel( 'cust_main', #tablename
599 $conf->config('cust_main-skeleton_custnum'), #sourceid
600 $self->custnum, #destid
601 @tables, #child tables
605 #recursive subroutine, not a method
607 my( $table, $sourceid, $destid, %child_tables ) = @_;
610 if ( $table =~ /^(\w+)\.(\w+)$/ ) {
611 ( $table, $primary_key ) = ( $1, $2 );
613 my $dbdef_table = dbdef->table($table);
614 $primary_key = $dbdef_table->primary_key
615 or return "$table has no primary key".
616 " (or do you need to run dbdef-create?)";
619 warn " _copy_skel: $table.$primary_key $sourceid to $destid for ".
620 join (', ', keys %child_tables). "\n"
623 foreach my $child_table_def ( keys %child_tables ) {
627 if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
628 ( $child_table, $child_pkey ) = ( $1, $2 );
630 $child_table = $child_table_def;
632 $child_pkey = dbdef->table($child_table)->primary_key;
633 # or return "$table has no primary key".
634 # " (or do you need to run dbdef-create?)\n";
638 if ( keys %{ $child_tables{$child_table_def} } ) {
640 return "$child_table has no primary key".
641 " (run dbdef-create or try specifying it?)\n"
644 #false laziness w/Record::insert and only works on Pg
645 #refactor the proper last-inserted-id stuff out of Record::insert if this
646 # ever gets use for anything besides a quick kludge for one customer
647 my $default = dbdef->table($child_table)->column($child_pkey)->default;
648 $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
649 or return "can't parse $child_table.$child_pkey default value ".
650 " for sequence name: $default";
655 my @sel_columns = grep { $_ ne $primary_key }
656 dbdef->table($child_table)->columns;
657 my $sel_columns = join(', ', @sel_columns );
659 my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
660 my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
661 my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
663 my $sel_st = "SELECT $sel_columns FROM $child_table".
664 " WHERE $primary_key = $sourceid";
667 my $sel_sth = dbh->prepare( $sel_st )
668 or return dbh->errstr;
670 $sel_sth->execute or return $sel_sth->errstr;
672 while ( my $row = $sel_sth->fetchrow_hashref ) {
674 warn " selected row: ".
675 join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
679 "INSERT INTO $child_table $ins_columns VALUES $placeholders";
680 my $ins_sth =dbh->prepare($statement)
681 or return dbh->errstr;
682 my @param = ( $destid, map $row->{$_}, @ins_columns );
683 warn " $statement: [ ". join(', ', @param). " ]\n"
685 $ins_sth->execute( @param )
686 or return $ins_sth->errstr;
688 #next unless keys %{ $child_tables{$child_table} };
689 next unless $sequence;
691 #another section of that laziness
692 my $seq_sql = "SELECT currval('$sequence')";
693 my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
694 $seq_sth->execute or return $seq_sth->errstr;
695 my $insertid = $seq_sth->fetchrow_arrayref->[0];
697 # don't drink soap! recurse! recurse! okay!
699 _copy_skel( $child_table_def,
700 $row->{$child_pkey}, #sourceid
702 %{ $child_tables{$child_table_def} },
704 return $error if $error;
714 =item order_pkg HASHREF | OPTION => VALUE ...
716 Orders a single package.
718 Options may be passed as a list of key/value pairs or as a hash reference.
729 Optional FS::cust_location object
733 Optional arryaref of FS::svc_* service objects.
737 If this option is set to a job queue jobnum (see L<FS::queue>), all provisioning
738 jobs will have a dependancy on the supplied job (they will not run until the
739 specific job completes). This can be used to defer provisioning until some
740 action completes (such as running the customer's credit card successfully).
744 Optional subject for a ticket created and attached to this customer
748 Optional queue name for ticket additions
756 my $opt = ref($_[0]) ? shift : { @_ };
758 warn "$me order_pkg called with options ".
759 join(', ', map { "$_: $opt->{$_}" } keys %$opt ). "\n"
762 my $cust_pkg = $opt->{'cust_pkg'};
763 my $svcs = $opt->{'svcs'} || [];
765 my %svc_options = ();
766 $svc_options{'depend_jobnum'} = $opt->{'depend_jobnum'}
767 if exists($opt->{'depend_jobnum'}) && $opt->{'depend_jobnum'};
769 my %insert_params = map { $opt->{$_} ? ( $_ => $opt->{$_} ) : () }
770 qw( ticket_subject ticket_queue );
772 local $SIG{HUP} = 'IGNORE';
773 local $SIG{INT} = 'IGNORE';
774 local $SIG{QUIT} = 'IGNORE';
775 local $SIG{TERM} = 'IGNORE';
776 local $SIG{TSTP} = 'IGNORE';
777 local $SIG{PIPE} = 'IGNORE';
779 my $oldAutoCommit = $FS::UID::AutoCommit;
780 local $FS::UID::AutoCommit = 0;
783 if ( $opt->{'cust_location'} &&
784 ( ! $cust_pkg->locationnum || $cust_pkg->locationnum == -1 ) ) {
785 my $error = $opt->{'cust_location'}->insert;
787 $dbh->rollback if $oldAutoCommit;
788 return "inserting cust_location (transaction rolled back): $error";
790 $cust_pkg->locationnum($opt->{'cust_location'}->locationnum);
793 $cust_pkg->custnum( $self->custnum );
795 my $error = $cust_pkg->insert( %insert_params );
797 $dbh->rollback if $oldAutoCommit;
798 return "inserting cust_pkg (transaction rolled back): $error";
801 foreach my $svc_something ( @{ $opt->{'svcs'} } ) {
802 if ( $svc_something->svcnum ) {
803 my $old_cust_svc = $svc_something->cust_svc;
804 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
805 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
806 $error = $new_cust_svc->replace($old_cust_svc);
808 $svc_something->pkgnum( $cust_pkg->pkgnum );
809 if ( $svc_something->isa('FS::svc_acct') ) {
810 foreach ( grep { $opt->{$_.'_ref'} && ${ $opt->{$_.'_ref'} } }
811 qw( seconds upbytes downbytes totalbytes ) ) {
812 $svc_something->$_( $svc_something->$_() + ${ $opt->{$_.'_ref'} } );
813 ${ $opt->{$_.'_ref'} } = 0;
816 $error = $svc_something->insert(%svc_options);
819 $dbh->rollback if $oldAutoCommit;
820 return "inserting svc_ (transaction rolled back): $error";
824 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
829 #deprecated #=item order_pkgs HASHREF [ , SECONDSREF ] [ , OPTION => VALUE ... ]
830 =item order_pkgs HASHREF [ , OPTION => VALUE ... ]
832 Like the insert method on an existing record, this method orders multiple
833 packages and included services atomicaly. Pass a Tie::RefHash data structure
834 to this method containing FS::cust_pkg and FS::svc_I<tablename> objects.
835 There should be a better explanation of this, but until then, here's an
839 tie %hash, 'Tie::RefHash'; #this part is important
841 $cust_pkg => [ $svc_acct ],
844 $cust_main->order_pkgs( \%hash, 'noexport'=>1 );
846 Services can be new, in which case they are inserted, or existing unaudited
847 services, in which case they are linked to the newly-created package.
849 Currently available options are: I<depend_jobnum>, I<noexport>, I<seconds_ref>,
850 I<upbytes_ref>, I<downbytes_ref>, and I<totalbytes_ref>.
852 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
853 on the supplied jobnum (they will not run until the specific job completes).
854 This can be used to defer provisioning until some action completes (such
855 as running the customer's credit card successfully).
857 The I<noexport> option is deprecated. If I<noexport> is set true, no
858 provisioning jobs (exports) are scheduled. (You can schedule them later with
859 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
860 on the cust_main object is not recommended, as existing services will also be
863 If I<seconds_ref>, I<upbytes_ref>, I<downbytes_ref>, or I<totalbytes_ref> is
864 provided, the scalars (provided by references) will be incremented by the
865 values of the prepaid card.`
871 my $cust_pkgs = shift;
872 my $seconds_ref = ref($_[0]) ? shift : ''; #deprecated
874 $seconds_ref ||= $options{'seconds_ref'};
876 warn "$me order_pkgs called with options ".
877 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
880 local $SIG{HUP} = 'IGNORE';
881 local $SIG{INT} = 'IGNORE';
882 local $SIG{QUIT} = 'IGNORE';
883 local $SIG{TERM} = 'IGNORE';
884 local $SIG{TSTP} = 'IGNORE';
885 local $SIG{PIPE} = 'IGNORE';
887 my $oldAutoCommit = $FS::UID::AutoCommit;
888 local $FS::UID::AutoCommit = 0;
891 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
893 foreach my $cust_pkg ( keys %$cust_pkgs ) {
895 my $error = $self->order_pkg(
896 'cust_pkg' => $cust_pkg,
897 'svcs' => $cust_pkgs->{$cust_pkg},
898 'seconds_ref' => $seconds_ref,
899 map { $_ => $options{$_} } qw( upbytes_ref downbytes_ref totalbytes_ref
904 $dbh->rollback if $oldAutoCommit;
910 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
914 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
916 Recharges this (existing) customer with the specified prepaid card (see
917 L<FS::prepay_credit>), specified either by I<identifier> or as an
918 FS::prepay_credit object. If there is an error, returns the error, otherwise
921 Optionally, five scalar references can be passed as well. They will have their
922 values filled in with the amount, number of seconds, and number of upload,
923 download, and total bytes applied by this prepaid card.
927 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
928 #the only place that uses these args
929 sub recharge_prepay {
930 my( $self, $prepay_credit, $amountref, $secondsref,
931 $upbytesref, $downbytesref, $totalbytesref ) = @_;
933 local $SIG{HUP} = 'IGNORE';
934 local $SIG{INT} = 'IGNORE';
935 local $SIG{QUIT} = 'IGNORE';
936 local $SIG{TERM} = 'IGNORE';
937 local $SIG{TSTP} = 'IGNORE';
938 local $SIG{PIPE} = 'IGNORE';
940 my $oldAutoCommit = $FS::UID::AutoCommit;
941 local $FS::UID::AutoCommit = 0;
944 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
946 my $error = $self->get_prepay( $prepay_credit,
947 'amount_ref' => \$amount,
948 'seconds_ref' => \$seconds,
949 'upbytes_ref' => \$upbytes,
950 'downbytes_ref' => \$downbytes,
951 'totalbytes_ref' => \$totalbytes,
953 || $self->increment_seconds($seconds)
954 || $self->increment_upbytes($upbytes)
955 || $self->increment_downbytes($downbytes)
956 || $self->increment_totalbytes($totalbytes)
957 || $self->insert_cust_pay_prepay( $amount,
959 ? $prepay_credit->identifier
964 $dbh->rollback if $oldAutoCommit;
968 if ( defined($amountref) ) { $$amountref = $amount; }
969 if ( defined($secondsref) ) { $$secondsref = $seconds; }
970 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
971 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
972 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
974 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
979 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
981 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
982 specified either by I<identifier> or as an FS::prepay_credit object.
984 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
985 incremented by the values of the prepaid card.
987 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
988 check or set this customer's I<agentnum>.
990 If there is an error, returns the error, otherwise returns false.
996 my( $self, $prepay_credit, %opt ) = @_;
998 local $SIG{HUP} = 'IGNORE';
999 local $SIG{INT} = 'IGNORE';
1000 local $SIG{QUIT} = 'IGNORE';
1001 local $SIG{TERM} = 'IGNORE';
1002 local $SIG{TSTP} = 'IGNORE';
1003 local $SIG{PIPE} = 'IGNORE';
1005 my $oldAutoCommit = $FS::UID::AutoCommit;
1006 local $FS::UID::AutoCommit = 0;
1009 unless ( ref($prepay_credit) ) {
1011 my $identifier = $prepay_credit;
1013 $prepay_credit = qsearchs(
1015 { 'identifier' => $prepay_credit },
1020 unless ( $prepay_credit ) {
1021 $dbh->rollback if $oldAutoCommit;
1022 return "Invalid prepaid card: ". $identifier;
1027 if ( $prepay_credit->agentnum ) {
1028 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
1029 $dbh->rollback if $oldAutoCommit;
1030 return "prepaid card not valid for agent ". $self->agentnum;
1032 $self->agentnum($prepay_credit->agentnum);
1035 my $error = $prepay_credit->delete;
1037 $dbh->rollback if $oldAutoCommit;
1038 return "removing prepay_credit (transaction rolled back): $error";
1041 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
1042 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
1044 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1049 =item increment_upbytes SECONDS
1051 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1052 the specified number of upbytes. If there is an error, returns the error,
1053 otherwise returns false.
1057 sub increment_upbytes {
1058 _increment_column( shift, 'upbytes', @_);
1061 =item increment_downbytes SECONDS
1063 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1064 the specified number of downbytes. If there is an error, returns the error,
1065 otherwise returns false.
1069 sub increment_downbytes {
1070 _increment_column( shift, 'downbytes', @_);
1073 =item increment_totalbytes SECONDS
1075 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1076 the specified number of totalbytes. If there is an error, returns the error,
1077 otherwise returns false.
1081 sub increment_totalbytes {
1082 _increment_column( shift, 'totalbytes', @_);
1085 =item increment_seconds SECONDS
1087 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1088 the specified number of seconds. If there is an error, returns the error,
1089 otherwise returns false.
1093 sub increment_seconds {
1094 _increment_column( shift, 'seconds', @_);
1097 =item _increment_column AMOUNT
1099 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1100 the specified number of seconds or bytes. If there is an error, returns
1101 the error, otherwise returns false.
1105 sub _increment_column {
1106 my( $self, $column, $amount ) = @_;
1107 warn "$me increment_column called: $column, $amount\n"
1110 return '' unless $amount;
1112 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1113 $self->ncancelled_pkgs;
1115 if ( ! @cust_pkg ) {
1116 return 'No packages with primary or single services found'.
1117 ' to apply pre-paid time';
1118 } elsif ( scalar(@cust_pkg) > 1 ) {
1119 #maybe have a way to specify the package/account?
1120 return 'Multiple packages found to apply pre-paid time';
1123 my $cust_pkg = $cust_pkg[0];
1124 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1128 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1130 if ( ! @cust_svc ) {
1131 return 'No account found to apply pre-paid time';
1132 } elsif ( scalar(@cust_svc) > 1 ) {
1133 return 'Multiple accounts found to apply pre-paid time';
1136 my $svc_acct = $cust_svc[0]->svc_x;
1137 warn " found service svcnum ". $svc_acct->pkgnum.
1138 ' ('. $svc_acct->email. ")\n"
1141 $column = "increment_$column";
1142 $svc_acct->$column($amount);
1146 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1148 Inserts a prepayment in the specified amount for this customer. An optional
1149 second argument can specify the prepayment identifier for tracking purposes.
1150 If there is an error, returns the error, otherwise returns false.
1154 sub insert_cust_pay_prepay {
1155 shift->insert_cust_pay('PREP', @_);
1158 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1160 Inserts a cash payment in the specified amount for this customer. An optional
1161 second argument can specify the payment identifier for tracking purposes.
1162 If there is an error, returns the error, otherwise returns false.
1166 sub insert_cust_pay_cash {
1167 shift->insert_cust_pay('CASH', @_);
1170 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1172 Inserts a Western Union payment in the specified amount for this customer. An
1173 optional second argument can specify the prepayment identifier for tracking
1174 purposes. If there is an error, returns the error, otherwise returns false.
1178 sub insert_cust_pay_west {
1179 shift->insert_cust_pay('WEST', @_);
1182 sub insert_cust_pay {
1183 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1184 my $payinfo = scalar(@_) ? shift : '';
1186 my $cust_pay = new FS::cust_pay {
1187 'custnum' => $self->custnum,
1188 'paid' => sprintf('%.2f', $amount),
1189 #'_date' => #date the prepaid card was purchased???
1191 'payinfo' => $payinfo,
1199 This method is deprecated. See the I<depend_jobnum> option to the insert and
1200 order_pkgs methods for a better way to defer provisioning.
1202 Re-schedules all exports by calling the B<reexport> method of all associated
1203 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
1204 otherwise returns false.
1211 carp "WARNING: FS::cust_main::reexport is deprectated; ".
1212 "use the depend_jobnum option to insert or order_pkgs to delay export";
1214 local $SIG{HUP} = 'IGNORE';
1215 local $SIG{INT} = 'IGNORE';
1216 local $SIG{QUIT} = 'IGNORE';
1217 local $SIG{TERM} = 'IGNORE';
1218 local $SIG{TSTP} = 'IGNORE';
1219 local $SIG{PIPE} = 'IGNORE';
1221 my $oldAutoCommit = $FS::UID::AutoCommit;
1222 local $FS::UID::AutoCommit = 0;
1225 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1226 my $error = $cust_pkg->reexport;
1228 $dbh->rollback if $oldAutoCommit;
1233 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1238 =item delete NEW_CUSTNUM
1240 This deletes the customer. If there is an error, returns the error, otherwise
1243 This will completely remove all traces of the customer record. This is not
1244 what you want when a customer cancels service; for that, cancel all of the
1245 customer's packages (see L</cancel>).
1247 If the customer has any uncancelled packages, you need to pass a new (valid)
1248 customer number for those packages to be transferred to. Cancelled packages
1249 will be deleted. Did I mention that this is NOT what you want when a customer
1250 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
1252 You can't delete a customer with invoices (see L<FS::cust_bill>),
1253 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
1254 refunds (see L<FS::cust_refund>).
1261 local $SIG{HUP} = 'IGNORE';
1262 local $SIG{INT} = 'IGNORE';
1263 local $SIG{QUIT} = 'IGNORE';
1264 local $SIG{TERM} = 'IGNORE';
1265 local $SIG{TSTP} = 'IGNORE';
1266 local $SIG{PIPE} = 'IGNORE';
1268 my $oldAutoCommit = $FS::UID::AutoCommit;
1269 local $FS::UID::AutoCommit = 0;
1272 if ( $self->cust_bill ) {
1273 $dbh->rollback if $oldAutoCommit;
1274 return "Can't delete a customer with invoices";
1276 if ( $self->cust_credit ) {
1277 $dbh->rollback if $oldAutoCommit;
1278 return "Can't delete a customer with credits";
1280 if ( $self->cust_pay ) {
1281 $dbh->rollback if $oldAutoCommit;
1282 return "Can't delete a customer with payments";
1284 if ( $self->cust_refund ) {
1285 $dbh->rollback if $oldAutoCommit;
1286 return "Can't delete a customer with refunds";
1289 my @cust_pkg = $self->ncancelled_pkgs;
1291 my $new_custnum = shift;
1292 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1293 $dbh->rollback if $oldAutoCommit;
1294 return "Invalid new customer number: $new_custnum";
1296 foreach my $cust_pkg ( @cust_pkg ) {
1297 my %hash = $cust_pkg->hash;
1298 $hash{'custnum'} = $new_custnum;
1299 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1300 my $error = $new_cust_pkg->replace($cust_pkg,
1301 options => { $cust_pkg->options },
1304 $dbh->rollback if $oldAutoCommit;
1309 my @cancelled_cust_pkg = $self->all_pkgs;
1310 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1311 my $error = $cust_pkg->delete;
1313 $dbh->rollback if $oldAutoCommit;
1318 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1319 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1321 my $error = $cust_main_invoice->delete;
1323 $dbh->rollback if $oldAutoCommit;
1328 foreach my $cust_main_exemption (
1329 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } )
1331 my $error = $cust_main_exemption->delete;
1333 $dbh->rollback if $oldAutoCommit;
1338 my $error = $self->SUPER::delete;
1340 $dbh->rollback if $oldAutoCommit;
1344 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1349 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1352 Replaces the OLD_RECORD with this one in the database. If there is an error,
1353 returns the error, otherwise returns false.
1355 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1356 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1357 expected and rollback the entire transaction; it is not necessary to call
1358 check_invoicing_list first. Here's an example:
1360 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1362 Currently available options are: I<tax_exemption>.
1364 The I<tax_exemption> option can be set to an arrayref of tax names.
1365 FS::cust_main_exemption records will be deleted and inserted as appropriate.
1372 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1374 : $self->replace_old;
1378 warn "$me replace called\n"
1381 my $curuser = $FS::CurrentUser::CurrentUser;
1382 if ( $self->payby eq 'COMP'
1383 && $self->payby ne $old->payby
1384 && ! $curuser->access_right('Complimentary customer')
1387 return "You are not permitted to create complimentary accounts.";
1390 local($ignore_expired_card) = 1
1391 if $old->payby =~ /^(CARD|DCRD)$/
1392 && $self->payby =~ /^(CARD|DCRD)$/
1393 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1395 local $SIG{HUP} = 'IGNORE';
1396 local $SIG{INT} = 'IGNORE';
1397 local $SIG{QUIT} = 'IGNORE';
1398 local $SIG{TERM} = 'IGNORE';
1399 local $SIG{TSTP} = 'IGNORE';
1400 local $SIG{PIPE} = 'IGNORE';
1402 my $oldAutoCommit = $FS::UID::AutoCommit;
1403 local $FS::UID::AutoCommit = 0;
1406 my $error = $self->SUPER::replace($old);
1409 $dbh->rollback if $oldAutoCommit;
1413 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1414 my $invoicing_list = shift @param;
1415 $error = $self->check_invoicing_list( $invoicing_list );
1417 $dbh->rollback if $oldAutoCommit;
1420 $self->invoicing_list( $invoicing_list );
1423 my %options = @param;
1425 my $tax_exemption = delete $options{'tax_exemption'};
1426 if ( $tax_exemption ) {
1428 my %cust_main_exemption =
1429 map { $_->taxname => $_ }
1430 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1432 foreach my $taxname ( @$tax_exemption ) {
1434 next if delete $cust_main_exemption{$taxname};
1436 my $cust_main_exemption = new FS::cust_main_exemption {
1437 'custnum' => $self->custnum,
1438 'taxname' => $taxname,
1440 my $error = $cust_main_exemption->insert;
1442 $dbh->rollback if $oldAutoCommit;
1443 return "inserting cust_main_exemption (transaction rolled back): $error";
1447 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1448 my $error = $cust_main_exemption->delete;
1450 $dbh->rollback if $oldAutoCommit;
1451 return "deleting cust_main_exemption (transaction rolled back): $error";
1457 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1458 grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1459 # card/check/lec info has changed, want to retry realtime_ invoice events
1460 my $error = $self->retry_realtime;
1462 $dbh->rollback if $oldAutoCommit;
1467 unless ( $import || $skip_fuzzyfiles ) {
1468 $error = $self->queue_fuzzyfiles_update;
1470 $dbh->rollback if $oldAutoCommit;
1471 return "updating fuzzy search cache: $error";
1475 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1480 =item queue_fuzzyfiles_update
1482 Used by insert & replace to update the fuzzy search cache
1486 sub queue_fuzzyfiles_update {
1489 local $SIG{HUP} = 'IGNORE';
1490 local $SIG{INT} = 'IGNORE';
1491 local $SIG{QUIT} = 'IGNORE';
1492 local $SIG{TERM} = 'IGNORE';
1493 local $SIG{TSTP} = 'IGNORE';
1494 local $SIG{PIPE} = 'IGNORE';
1496 my $oldAutoCommit = $FS::UID::AutoCommit;
1497 local $FS::UID::AutoCommit = 0;
1500 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1501 my $error = $queue->insert( map $self->getfield($_), @fuzzyfields );
1503 $dbh->rollback if $oldAutoCommit;
1504 return "queueing job (transaction rolled back): $error";
1507 if ( $self->ship_last ) {
1508 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1509 $error = $queue->insert( map $self->getfield("ship_$_"), @fuzzyfields );
1511 $dbh->rollback if $oldAutoCommit;
1512 return "queueing job (transaction rolled back): $error";
1516 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1523 Checks all fields to make sure this is a valid customer record. If there is
1524 an error, returns the error, otherwise returns false. Called by the insert
1525 and replace methods.
1532 warn "$me check BEFORE: \n". $self->_dump
1536 $self->ut_numbern('custnum')
1537 || $self->ut_number('agentnum')
1538 || $self->ut_textn('agent_custid')
1539 || $self->ut_number('refnum')
1540 || $self->ut_textn('custbatch')
1541 || $self->ut_name('last')
1542 || $self->ut_name('first')
1543 || $self->ut_snumbern('birthdate')
1544 || $self->ut_snumbern('signupdate')
1545 || $self->ut_textn('company')
1546 || $self->ut_text('address1')
1547 || $self->ut_textn('address2')
1548 || $self->ut_text('city')
1549 || $self->ut_textn('county')
1550 || $self->ut_textn('state')
1551 || $self->ut_country('country')
1552 || $self->ut_anything('comments')
1553 || $self->ut_numbern('referral_custnum')
1554 || $self->ut_textn('stateid')
1555 || $self->ut_textn('stateid_state')
1556 || $self->ut_textn('invoice_terms')
1557 || $self->ut_alphan('geocode')
1558 || $self->ut_floatn('cdr_termination_percentage')
1561 #barf. need message catalogs. i18n. etc.
1562 $error .= "Please select an advertising source."
1563 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1564 return $error if $error;
1566 return "Unknown agent"
1567 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1569 return "Unknown refnum"
1570 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1572 return "Unknown referring custnum: ". $self->referral_custnum
1573 unless ! $self->referral_custnum
1574 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1576 if ( $self->censustract ne '' ) {
1577 $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
1578 or return "Illegal census tract: ". $self->censustract;
1580 $self->censustract("$1.$2");
1583 if ( $self->ss eq '' ) {
1588 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1589 or return "Illegal social security number: ". $self->ss;
1590 $self->ss("$1-$2-$3");
1594 # bad idea to disable, causes billing to fail because of no tax rates later
1595 # unless ( $import ) {
1596 unless ( qsearch('cust_main_county', {
1597 'country' => $self->country,
1600 return "Unknown state/county/country: ".
1601 $self->state. "/". $self->county. "/". $self->country
1602 unless qsearch('cust_main_county',{
1603 'state' => $self->state,
1604 'county' => $self->county,
1605 'country' => $self->country,
1611 $self->ut_phonen('daytime', $self->country)
1612 || $self->ut_phonen('night', $self->country)
1613 || $self->ut_phonen('fax', $self->country)
1614 || $self->ut_zip('zip', $self->country)
1616 return $error if $error;
1618 if ( $conf->exists('cust_main-require_phone')
1619 && ! length($self->daytime) && ! length($self->night)
1622 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1624 : FS::Msgcat::_gettext('daytime');
1625 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1627 : FS::Msgcat::_gettext('night');
1629 return "$daytime_label or $night_label is required"
1633 if ( $self->has_ship_address
1634 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1635 $self->addr_fields )
1639 $self->ut_name('ship_last')
1640 || $self->ut_name('ship_first')
1641 || $self->ut_textn('ship_company')
1642 || $self->ut_text('ship_address1')
1643 || $self->ut_textn('ship_address2')
1644 || $self->ut_text('ship_city')
1645 || $self->ut_textn('ship_county')
1646 || $self->ut_textn('ship_state')
1647 || $self->ut_country('ship_country')
1649 return $error if $error;
1651 #false laziness with above
1652 unless ( qsearchs('cust_main_county', {
1653 'country' => $self->ship_country,
1656 return "Unknown ship_state/ship_county/ship_country: ".
1657 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1658 unless qsearch('cust_main_county',{
1659 'state' => $self->ship_state,
1660 'county' => $self->ship_county,
1661 'country' => $self->ship_country,
1667 $self->ut_phonen('ship_daytime', $self->ship_country)
1668 || $self->ut_phonen('ship_night', $self->ship_country)
1669 || $self->ut_phonen('ship_fax', $self->ship_country)
1670 || $self->ut_zip('ship_zip', $self->ship_country)
1672 return $error if $error;
1674 return "Unit # is required."
1675 if $self->ship_address2 =~ /^\s*$/
1676 && $conf->exists('cust_main-require_address2');
1678 } else { # ship_ info eq billing info, so don't store dup info in database
1680 $self->setfield("ship_$_", '')
1681 foreach $self->addr_fields;
1683 return "Unit # is required."
1684 if $self->address2 =~ /^\s*$/
1685 && $conf->exists('cust_main-require_address2');
1689 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1690 # or return "Illegal payby: ". $self->payby;
1692 FS::payby->can_payby($self->table, $self->payby)
1693 or return "Illegal payby: ". $self->payby;
1695 $error = $self->ut_numbern('paystart_month')
1696 || $self->ut_numbern('paystart_year')
1697 || $self->ut_numbern('payissue')
1698 || $self->ut_textn('paytype')
1700 return $error if $error;
1702 if ( $self->payip eq '' ) {
1705 $error = $self->ut_ip('payip');
1706 return $error if $error;
1709 # If it is encrypted and the private key is not availaible then we can't
1710 # check the credit card.
1712 my $check_payinfo = 1;
1714 if ($self->is_encrypted($self->payinfo)) {
1718 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1720 my $payinfo = $self->payinfo;
1721 $payinfo =~ s/\D//g;
1722 $payinfo =~ /^(\d{13,16})$/
1723 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1725 $self->payinfo($payinfo);
1727 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1729 return gettext('unknown_card_type')
1730 if cardtype($self->payinfo) eq "Unknown";
1732 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1734 return 'Banned credit card: banned on '.
1735 time2str('%a %h %o at %r', $ban->_date).
1736 ' by '. $ban->otaker.
1737 ' (ban# '. $ban->bannum. ')';
1740 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1741 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1742 $self->paycvv =~ /^(\d{4})$/
1743 or return "CVV2 (CID) for American Express cards is four digits.";
1746 $self->paycvv =~ /^(\d{3})$/
1747 or return "CVV2 (CVC2/CID) is three digits.";
1754 my $cardtype = cardtype($payinfo);
1755 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1757 return "Start date or issue number is required for $cardtype cards"
1758 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1760 return "Start month must be between 1 and 12"
1761 if $self->paystart_month
1762 and $self->paystart_month < 1 || $self->paystart_month > 12;
1764 return "Start year must be 1990 or later"
1765 if $self->paystart_year
1766 and $self->paystart_year < 1990;
1768 return "Issue number must be beween 1 and 99"
1770 and $self->payissue < 1 || $self->payissue > 99;
1773 $self->paystart_month('');
1774 $self->paystart_year('');
1775 $self->payissue('');
1778 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1780 my $payinfo = $self->payinfo;
1781 $payinfo =~ s/[^\d\@]//g;
1782 if ( $conf->exists('echeck-nonus') ) {
1783 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1784 $payinfo = "$1\@$2";
1786 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1787 $payinfo = "$1\@$2";
1789 $self->payinfo($payinfo);
1792 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1794 return 'Banned ACH account: banned on '.
1795 time2str('%a %h %o at %r', $ban->_date).
1796 ' by '. $ban->otaker.
1797 ' (ban# '. $ban->bannum. ')';
1800 } elsif ( $self->payby eq 'LECB' ) {
1802 my $payinfo = $self->payinfo;
1803 $payinfo =~ s/\D//g;
1804 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1806 $self->payinfo($payinfo);
1809 } elsif ( $self->payby eq 'BILL' ) {
1811 $error = $self->ut_textn('payinfo');
1812 return "Illegal P.O. number: ". $self->payinfo if $error;
1815 } elsif ( $self->payby eq 'COMP' ) {
1817 my $curuser = $FS::CurrentUser::CurrentUser;
1818 if ( ! $self->custnum
1819 && ! $curuser->access_right('Complimentary customer')
1822 return "You are not permitted to create complimentary accounts."
1825 $error = $self->ut_textn('payinfo');
1826 return "Illegal comp account issuer: ". $self->payinfo if $error;
1829 } elsif ( $self->payby eq 'PREPAY' ) {
1831 my $payinfo = $self->payinfo;
1832 $payinfo =~ s/\W//g; #anything else would just confuse things
1833 $self->payinfo($payinfo);
1834 $error = $self->ut_alpha('payinfo');
1835 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1836 return "Unknown prepayment identifier"
1837 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1842 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1843 return "Expiration date required"
1844 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1848 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1849 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1850 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1851 ( $m, $y ) = ( $2, "19$1" );
1852 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1853 ( $m, $y ) = ( $3, "20$2" );
1855 return "Illegal expiration date: ". $self->paydate;
1857 $self->paydate("$y-$m-01");
1858 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1859 return gettext('expired_card')
1861 && !$ignore_expired_card
1862 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1865 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1866 ( ! $conf->exists('require_cardname')
1867 || $self->payby !~ /^(CARD|DCRD)$/ )
1869 $self->payname( $self->first. " ". $self->getfield('last') );
1871 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1872 or return gettext('illegal_name'). " payname: ". $self->payname;
1876 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
1877 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1881 $self->otaker(getotaker) unless $self->otaker;
1883 warn "$me check AFTER: \n". $self->_dump
1886 $self->SUPER::check;
1891 Returns a list of fields which have ship_ duplicates.
1896 qw( last first company
1897 address1 address2 city county state zip country
1902 =item has_ship_address
1904 Returns true if this customer record has a separate shipping address.
1908 sub has_ship_address {
1910 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
1913 =item all_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
1915 Returns all packages (see L<FS::cust_pkg>) for this customer.
1921 my $extra_qsearch = ref($_[0]) ? shift : {};
1923 return $self->num_pkgs unless wantarray || keys(%$extra_qsearch);
1926 if ( $self->{'_pkgnum'} ) {
1927 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1929 @cust_pkg = $self->_cust_pkg($extra_qsearch);
1932 sort sort_packages @cust_pkg;
1937 Synonym for B<all_pkgs>.
1942 shift->all_pkgs(@_);
1947 Returns all locations (see L<FS::cust_location>) for this customer.
1953 qsearch('cust_location', { 'custnum' => $self->custnum } );
1956 =item location_label [ OPTION => VALUE ... ]
1958 Returns the label of the service location (see analog in L<FS::cust_location>) for this customer.
1966 used to separate the address elements (defaults to ', ')
1968 =item escape_function
1970 a callback used for escaping the text of the address elements
1976 # false laziness with FS::cust_location::line
1978 sub location_label {
1982 my $separator = $opt{join_string} || ', ';
1983 my $escape = $opt{escape_function} || sub{ shift };
1985 my $cydefault = FS::conf->new->config('countrydefault') || 'US';
1986 my $prefix = length($self->ship_last) ? 'ship_' : '';
1989 foreach (qw ( address1 address2 ) ) {
1990 my $method = "$prefix$_";
1991 $line .= ($notfirst ? $separator : ''). &$escape($self->$method)
1996 foreach (qw ( city county state zip ) ) {
1997 my $method = "$prefix$_";
1998 if ( $self->$method ) {
1999 $line .= ' (' if $method eq 'county';
2000 $line .= ($notfirst ? ' ' : $separator). &$escape($self->$method);
2001 $line .= ' )' if $method eq 'county';
2005 $line .= $separator. &$escape(code2country($self->country))
2006 if $self->country ne $cydefault;
2011 =item ncancelled_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
2013 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
2017 sub ncancelled_pkgs {
2019 my $extra_qsearch = ref($_[0]) ? shift : {};
2021 return $self->num_ncancelled_pkgs unless wantarray;
2024 if ( $self->{'_pkgnum'} ) {
2026 warn "$me ncancelled_pkgs: returning cached objects"
2029 @cust_pkg = grep { ! $_->getfield('cancel') }
2030 values %{ $self->{'_pkgnum'}->cache };
2034 warn "$me ncancelled_pkgs: searching for packages with custnum ".
2035 $self->custnum. "\n"
2038 $extra_qsearch->{'extra_sql'} .= ' AND ( cancel IS NULL OR cancel = 0 ) ';
2040 @cust_pkg = $self->_cust_pkg($extra_qsearch);
2044 sort sort_packages @cust_pkg;
2050 my $extra_qsearch = ref($_[0]) ? shift : {};
2052 $extra_qsearch->{'select'} ||= '*';
2053 $extra_qsearch->{'select'} .=
2054 ',( SELECT COUNT(*) FROM cust_svc WHERE cust_pkg.pkgnum = cust_svc.pkgnum )
2058 $_->{'_num_cust_svc'} = $_->get('_num_cust_svc');
2063 'table' => 'cust_pkg',
2064 'hashref' => { 'custnum' => $self->custnum },
2069 # This should be generalized to use config options to determine order.
2072 my $locationsort = ( $a->locationnum || 0 ) <=> ( $b->locationnum || 0 );
2073 return $locationsort if $locationsort;
2075 if ( $a->get('cancel') xor $b->get('cancel') ) {
2076 return -1 if $b->get('cancel');
2077 return 1 if $a->get('cancel');
2078 #shouldn't get here...
2081 my $a_num_cust_svc = $a->num_cust_svc;
2082 my $b_num_cust_svc = $b->num_cust_svc;
2083 return 0 if !$a_num_cust_svc && !$b_num_cust_svc;
2084 return -1 if $a_num_cust_svc && !$b_num_cust_svc;
2085 return 1 if !$a_num_cust_svc && $b_num_cust_svc;
2086 my @a_cust_svc = $a->cust_svc;
2087 my @b_cust_svc = $b->cust_svc;
2088 $a_cust_svc[0]->svc_x->label cmp $b_cust_svc[0]->svc_x->label;
2093 =item suspended_pkgs
2095 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
2099 sub suspended_pkgs {
2101 grep { $_->susp } $self->ncancelled_pkgs;
2104 =item unflagged_suspended_pkgs
2106 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
2107 customer (thouse packages without the `manual_flag' set).
2111 sub unflagged_suspended_pkgs {
2113 return $self->suspended_pkgs
2114 unless dbdef->table('cust_pkg')->column('manual_flag');
2115 grep { ! $_->manual_flag } $self->suspended_pkgs;
2118 =item unsuspended_pkgs
2120 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
2125 sub unsuspended_pkgs {
2127 grep { ! $_->susp } $self->ncancelled_pkgs;
2130 =item next_bill_date
2132 Returns the next date this customer will be billed, as a UNIX timestamp, or
2133 undef if no active package has a next bill date.
2137 sub next_bill_date {
2139 min( map $_->get('bill'), grep $_->get('bill'), $self->unsuspended_pkgs );
2142 =item num_cancelled_pkgs
2144 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
2149 sub num_cancelled_pkgs {
2150 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
2153 sub num_ncancelled_pkgs {
2154 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
2158 my( $self ) = shift;
2159 my $sql = scalar(@_) ? shift : '';
2160 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
2161 my $sth = dbh->prepare(
2162 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
2163 ) or die dbh->errstr;
2164 $sth->execute($self->custnum) or die $sth->errstr;
2165 $sth->fetchrow_arrayref->[0];
2170 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2171 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2172 on success or a list of errors.
2178 grep { $_->unsuspend } $self->suspended_pkgs;
2183 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2185 Returns a list: an empty list on success or a list of errors.
2191 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2194 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2196 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2197 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2198 of a list of pkgparts; the hashref has the following keys:
2202 =item pkgparts - listref of pkgparts
2204 =item (other options are passed to the suspend method)
2209 Returns a list: an empty list on success or a list of errors.
2213 sub suspend_if_pkgpart {
2215 my (@pkgparts, %opt);
2216 if (ref($_[0]) eq 'HASH'){
2217 @pkgparts = @{$_[0]{pkgparts}};
2222 grep { $_->suspend(%opt) }
2223 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2224 $self->unsuspended_pkgs;
2227 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2229 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2230 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2231 instead of a list of pkgparts; the hashref has the following keys:
2235 =item pkgparts - listref of pkgparts
2237 =item (other options are passed to the suspend method)
2241 Returns a list: an empty list on success or a list of errors.
2245 sub suspend_unless_pkgpart {
2247 my (@pkgparts, %opt);
2248 if (ref($_[0]) eq 'HASH'){
2249 @pkgparts = @{$_[0]{pkgparts}};
2254 grep { $_->suspend(%opt) }
2255 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2256 $self->unsuspended_pkgs;
2259 =item cancel [ OPTION => VALUE ... ]
2261 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2263 Available options are:
2267 =item quiet - can be set true to supress email cancellation notices.
2269 =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.
2271 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2273 =item nobill - can be set true to skip billing if it might otherwise be done.
2277 Always returns a list: an empty list on success or a list of errors.
2281 # nb that dates are not specified as valid options to this method
2284 my( $self, %opt ) = @_;
2286 warn "$me cancel called on customer ". $self->custnum. " with options ".
2287 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2290 return ( 'access denied' )
2291 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2293 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2295 #should try decryption (we might have the private key)
2296 # and if not maybe queue a job for the server that does?
2297 return ( "Can't (yet) ban encrypted credit cards" )
2298 if $self->is_encrypted($self->payinfo);
2300 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
2301 my $error = $ban->insert;
2302 return ( $error ) if $error;
2306 my @pkgs = $self->ncancelled_pkgs;
2308 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2310 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2311 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2315 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2316 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2319 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2322 sub _banned_pay_hashref {
2333 'payby' => $payby2ban{$self->payby},
2334 'payinfo' => md5_base64($self->payinfo),
2335 #don't ever *search* on reason! #'reason' =>
2341 Returns all notes (see L<FS::cust_main_note>) for this customer.
2348 qsearch( 'cust_main_note',
2349 { 'custnum' => $self->custnum },
2351 'ORDER BY _DATE DESC'
2357 Returns the agent (see L<FS::agent>) for this customer.
2363 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2366 =item bill_and_collect
2368 Cancels and suspends any packages due, generates bills, applies payments and
2369 credits, and applies collection events to run cards, send bills and notices,
2372 By default, warns on errors and continues with the next operation (but see the
2373 "fatal" flag below).
2375 Options are passed as name-value pairs. Currently available options are:
2381 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:
2385 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2389 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.
2393 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2397 If set true, re-charges setup fees.
2401 If set any errors prevent subsequent operations from continusing. If set
2402 specifically to "return", returns the error (or false, if there is no error).
2403 Any other true value causes errors to die.
2407 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)
2411 Options are passed to the B<bill> and B<collect> methods verbatim, so all
2412 options of those methods are also available.
2416 sub bill_and_collect {
2417 my( $self, %options ) = @_;
2421 #$options{actual_time} not $options{time} because freeside-daily -d is for
2422 #pre-printing invoices
2424 $options{'actual_time'} ||= time;
2426 $error = $self->cancel_expired_pkgs( $options{actual_time} );
2428 $error = "Error expiring custnum ". $self->custnum. ": $error";
2429 if ( $options{'fatal'} eq 'return' ) { return $error; }
2430 elsif ( $options{'fatal'} ) { die $error; }
2431 else { warn $error; }
2434 $error = $self->suspend_adjourned_pkgs( $options{actual_time} );
2436 $error = "Error adjourning custnum ". $self->custnum. ": $error";
2437 if ( $options{'fatal'} eq 'return' ) { return $error; }
2438 elsif ( $options{'fatal'} ) { die $error; }
2439 else { warn $error; }
2442 $error = $self->bill( %options );
2444 $error = "Error billing custnum ". $self->custnum. ": $error";
2445 if ( $options{'fatal'} eq 'return' ) { return $error; }
2446 elsif ( $options{'fatal'} ) { die $error; }
2447 else { warn $error; }
2450 $error = $self->apply_payments_and_credits;
2452 $error = "Error applying custnum ". $self->custnum. ": $error";
2453 if ( $options{'fatal'} eq 'return' ) { return $error; }
2454 elsif ( $options{'fatal'} ) { die $error; }
2455 else { warn $error; }
2458 unless ( $conf->exists('cancelled_cust-noevents')
2459 && ! $self->num_ncancelled_pkgs
2461 $error = $self->collect( %options );
2463 $error = "Error collecting custnum ". $self->custnum. ": $error";
2464 if ( $options{'fatal'} eq 'return' ) { return $error; }
2465 elsif ( $options{'fatal'} ) { die $error; }
2466 else { warn $error; }
2474 sub cancel_expired_pkgs {
2475 my ( $self, $time, %options ) = @_;
2477 my @cancel_pkgs = $self->ncancelled_pkgs( {
2478 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
2483 foreach my $cust_pkg ( @cancel_pkgs ) {
2484 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
2485 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
2486 'reason_otaker' => $cpr->otaker
2490 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
2493 scalar(@errors) ? join(' / ', @errors) : '';
2497 sub suspend_adjourned_pkgs {
2498 my ( $self, $time, %options ) = @_;
2500 my @susp_pkgs = $self->ncancelled_pkgs( {
2502 " AND ( susp IS NULL OR susp = 0 )
2503 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
2504 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
2509 #only because there's no SQL test for is_prepaid :/
2511 grep { ( $_->part_pkg->is_prepaid
2516 && $_->adjourn <= $time
2524 foreach my $cust_pkg ( @susp_pkgs ) {
2525 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
2526 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
2527 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
2528 'reason_otaker' => $cpr->otaker
2532 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
2535 scalar(@errors) ? join(' / ', @errors) : '';
2541 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
2542 conjunction with the collect method by calling B<bill_and_collect>.
2544 If there is an error, returns the error, otherwise returns false.
2546 Options are passed as name-value pairs. Currently available options are:
2552 If set true, re-charges setup fees.
2556 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:
2560 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2564 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2566 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2570 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
2574 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.
2578 This boolean value informs the us that the package is being cancelled. This
2579 typically might mean not charging the normal recurring fee but only usage
2580 fees since the last billing. Setup charges may be charged. Not all package
2581 plans support this feature (they tend to charge 0).
2585 Optional terms to be printed on this invoice. Otherwise, customer-specific
2586 terms or the default terms are used.
2593 my( $self, %options ) = @_;
2594 return '' if $self->payby eq 'COMP';
2595 warn "$me bill customer ". $self->custnum. "\n"
2598 my $time = $options{'time'} || time;
2599 my $invoice_time = $options{'invoice_time'} || $time;
2601 $options{'not_pkgpart'} ||= {};
2602 $options{'not_pkgpart'} = { map { $_ => 1 }
2603 split(/\s*,\s*/, $options{'not_pkgpart'})
2605 unless ref($options{'not_pkgpart'});
2607 local $SIG{HUP} = 'IGNORE';
2608 local $SIG{INT} = 'IGNORE';
2609 local $SIG{QUIT} = 'IGNORE';
2610 local $SIG{TERM} = 'IGNORE';
2611 local $SIG{TSTP} = 'IGNORE';
2612 local $SIG{PIPE} = 'IGNORE';
2614 my $oldAutoCommit = $FS::UID::AutoCommit;
2615 local $FS::UID::AutoCommit = 0;
2618 $self->select_for_update; #mutex
2620 my $error = $self->do_cust_event(
2621 'debug' => ( $options{'debug'} || 0 ),
2622 'time' => $invoice_time,
2623 'check_freq' => $options{'check_freq'},
2624 'stage' => 'pre-bill',
2627 $dbh->rollback if $oldAutoCommit;
2631 my @cust_bill_pkg = ();
2634 # find the packages which are due for billing, find out how much they are
2635 # & generate invoice database.
2638 my( $total_setup, $total_recur, $postal_charge ) = ( 0, 0, 0 );
2640 my @precommit_hooks = ();
2642 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
2643 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
2645 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
2647 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2649 #? to avoid use of uninitialized value errors... ?
2650 $cust_pkg->setfield('bill', '')
2651 unless defined($cust_pkg->bill);
2653 #my $part_pkg = $cust_pkg->part_pkg;
2655 my $real_pkgpart = $cust_pkg->pkgpart;
2656 my %hash = $cust_pkg->hash;
2658 foreach my $part_pkg ( $cust_pkg->part_pkg->self_and_bill_linked ) {
2660 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
2663 $self->_make_lines( 'part_pkg' => $part_pkg,
2664 'cust_pkg' => $cust_pkg,
2665 'precommit_hooks' => \@precommit_hooks,
2666 'line_items' => \@cust_bill_pkg,
2667 'setup' => \$total_setup,
2668 'recur' => \$total_recur,
2669 'tax_matrix' => \%taxlisthash,
2671 'real_pkgpart' => $real_pkgpart,
2672 'options' => \%options,
2675 $dbh->rollback if $oldAutoCommit;
2679 } #foreach my $part_pkg
2681 } #foreach my $cust_pkg
2683 unless ( @cust_bill_pkg ) { #don't create an invoice w/o line items
2684 #but do commit any package date cycling that happened
2685 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2689 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
2690 !$conf->exists('postal_invoice-recurring_only')
2694 my $postal_pkg = $self->charge_postal_fee();
2695 if ( $postal_pkg && !ref( $postal_pkg ) ) {
2697 $dbh->rollback if $oldAutoCommit;
2698 return "can't charge postal invoice fee for customer ".
2699 $self->custnum. ": $postal_pkg";
2701 } elsif ( $postal_pkg ) {
2703 my $real_pkgpart = $postal_pkg->pkgpart;
2704 foreach my $part_pkg ( $postal_pkg->part_pkg->self_and_bill_linked ) {
2705 my %postal_options = %options;
2706 delete $postal_options{cancel};
2708 $self->_make_lines( 'part_pkg' => $part_pkg,
2709 'cust_pkg' => $postal_pkg,
2710 'precommit_hooks' => \@precommit_hooks,
2711 'line_items' => \@cust_bill_pkg,
2712 'setup' => \$total_setup,
2713 'recur' => \$total_recur,
2714 'tax_matrix' => \%taxlisthash,
2716 'real_pkgpart' => $real_pkgpart,
2717 'options' => \%postal_options,
2720 $dbh->rollback if $oldAutoCommit;
2729 warn "having a look at the taxes we found...\n" if $DEBUG > 2;
2731 # keys are tax names (as printed on invoices / itemdesc )
2732 # values are listrefs of taxlisthash keys (internal identifiers)
2735 # keys are taxlisthash keys (internal identifiers)
2736 # values are (cumulative) amounts
2739 # keys are taxlisthash keys (internal identifiers)
2740 # values are listrefs of cust_bill_pkg_tax_location hashrefs
2741 my %tax_location = ();
2743 # keys are taxlisthash keys (internal identifiers)
2744 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
2745 my %tax_rate_location = ();
2747 foreach my $tax ( keys %taxlisthash ) {
2748 my $tax_object = shift @{ $taxlisthash{$tax} };
2749 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
2750 warn " ". join('/', @{ $taxlisthash{$tax} } ). "\n" if $DEBUG > 2;
2751 my $hashref_or_error =
2752 $tax_object->taxline( $taxlisthash{$tax},
2753 'custnum' => $self->custnum,
2754 'invoice_time' => $invoice_time
2756 unless ( ref($hashref_or_error) ) {
2757 $dbh->rollback if $oldAutoCommit;
2758 return $hashref_or_error;
2760 unshift @{ $taxlisthash{$tax} }, $tax_object;
2762 my $name = $hashref_or_error->{'name'};
2763 my $amount = $hashref_or_error->{'amount'};
2765 #warn "adding $amount as $name\n";
2766 $taxname{ $name } ||= [];
2767 push @{ $taxname{ $name } }, $tax;
2769 $tax{ $tax } += $amount;
2771 $tax_location{ $tax } ||= [];
2772 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
2773 push @{ $tax_location{ $tax } },
2775 'taxnum' => $tax_object->taxnum,
2776 'taxtype' => ref($tax_object),
2777 'pkgnum' => $tax_object->get('pkgnum'),
2778 'locationnum' => $tax_object->get('locationnum'),
2779 'amount' => sprintf('%.2f', $amount ),
2783 $tax_rate_location{ $tax } ||= [];
2784 if ( ref($tax_object) eq 'FS::tax_rate' ) {
2785 my $taxratelocationnum =
2786 $tax_object->tax_rate_location->taxratelocationnum;
2787 push @{ $tax_rate_location{ $tax } },
2789 'taxnum' => $tax_object->taxnum,
2790 'taxtype' => ref($tax_object),
2791 'amount' => sprintf('%.2f', $amount ),
2792 'locationtaxid' => $tax_object->location,
2793 'taxratelocationnum' => $taxratelocationnum,
2799 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
2800 my %packagemap = map { $_->pkgnum => $_ } @cust_bill_pkg;
2801 foreach my $tax ( keys %taxlisthash ) {
2802 foreach ( @{ $taxlisthash{$tax} }[1 ... scalar(@{ $taxlisthash{$tax} })] ) {
2803 next unless ref($_) eq 'FS::cust_bill_pkg';
2805 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
2806 splice( @{ $_->_cust_tax_exempt_pkg } );
2810 #consolidate and create tax line items
2811 warn "consolidating and generating...\n" if $DEBUG > 2;
2812 foreach my $taxname ( keys %taxname ) {
2815 my @cust_bill_pkg_tax_location = ();
2816 my @cust_bill_pkg_tax_rate_location = ();
2817 warn "adding $taxname\n" if $DEBUG > 1;
2818 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
2819 next if $seen{$taxitem}++;
2820 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
2821 $tax += $tax{$taxitem};
2822 push @cust_bill_pkg_tax_location,
2823 map { new FS::cust_bill_pkg_tax_location $_ }
2824 @{ $tax_location{ $taxitem } };
2825 push @cust_bill_pkg_tax_rate_location,
2826 map { new FS::cust_bill_pkg_tax_rate_location $_ }
2827 @{ $tax_rate_location{ $taxitem } };
2831 $tax = sprintf('%.2f', $tax );
2832 $total_setup = sprintf('%.2f', $total_setup+$tax );
2834 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
2840 if ( $pkg_category and
2841 $conf->config('invoice_latexsummary') ||
2842 $conf->config('invoice_htmlsummary')
2846 my %hash = ( 'section' => $pkg_category->categoryname );
2847 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
2851 push @cust_bill_pkg, new FS::cust_bill_pkg {
2857 'itemdesc' => $taxname,
2858 'display' => \@display,
2859 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2860 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
2865 #add tax adjustments
2866 warn "adding tax adjustments...\n" if $DEBUG > 2;
2867 foreach my $cust_tax_adjustment (
2868 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
2874 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
2875 $total_setup = sprintf('%.2f', $total_setup+$tax );
2877 my $itemdesc = $cust_tax_adjustment->taxname;
2878 $itemdesc = '' if $itemdesc eq 'Tax';
2880 push @cust_bill_pkg, new FS::cust_bill_pkg {
2886 'itemdesc' => $itemdesc,
2887 'itemcomment' => $cust_tax_adjustment->comment,
2888 'cust_tax_adjustment' => $cust_tax_adjustment,
2889 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2894 my $charged = sprintf('%.2f', $total_setup + $total_recur );
2896 my @cust_bill = $self->cust_bill;
2897 my $balance = $self->balance;
2898 my $previous_balance = scalar(@cust_bill)
2899 ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
2902 $previous_balance += $cust_bill[$#cust_bill]->charged
2903 if scalar(@cust_bill);
2904 #my $balance_adjustments =
2905 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
2907 #create the new invoice
2908 my $cust_bill = new FS::cust_bill ( {
2909 'custnum' => $self->custnum,
2910 '_date' => ( $invoice_time ),
2911 'charged' => $charged,
2912 'billing_balance' => $balance,
2913 'previous_balance' => $previous_balance,
2914 'invoice_terms' => $options{'invoice_terms'},
2916 $error = $cust_bill->insert;
2918 $dbh->rollback if $oldAutoCommit;
2919 return "can't create invoice for customer #". $self->custnum. ": $error";
2922 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
2923 $cust_bill_pkg->invnum($cust_bill->invnum);
2924 my $error = $cust_bill_pkg->insert;
2926 $dbh->rollback if $oldAutoCommit;
2927 return "can't create invoice line item: $error";
2932 foreach my $hook ( @precommit_hooks ) {
2934 &{$hook}; #($self) ?
2937 $dbh->rollback if $oldAutoCommit;
2938 return "$@ running precommit hook $hook\n";
2942 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2948 my ($self, %params) = @_;
2950 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
2951 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
2952 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
2953 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
2954 my $total_setup = $params{setup} or die "no setup accumulator specified";
2955 my $total_recur = $params{recur} or die "no recur accumulator specified";
2956 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
2957 my $time = $params{'time'} or die "no time specified";
2958 my (%options) = %{$params{options}};
2961 my $real_pkgpart = $params{real_pkgpart};
2962 my %hash = $cust_pkg->hash;
2963 my $old_cust_pkg = new FS::cust_pkg \%hash;
2969 $cust_pkg->pkgpart($part_pkg->pkgpart);
2977 if ( $options{'resetup'}
2978 || ( ! $cust_pkg->setup
2979 && ( ! $cust_pkg->start_date
2980 || $cust_pkg->start_date <= $time
2982 && ( ! $conf->exists('disable_setup_suspended_pkgs')
2983 || ( $conf->exists('disable_setup_suspended_pkgs') &&
2984 ! $cust_pkg->getfield('susp')
2991 warn " bill setup\n" if $DEBUG > 1;
2994 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2995 return "$@ running calc_setup for $cust_pkg\n"
2998 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
3000 $cust_pkg->setfield('setup', $time)
3001 unless $cust_pkg->setup;
3002 #do need it, but it won't get written to the db
3003 #|| $cust_pkg->pkgpart != $real_pkgpart;
3005 $cust_pkg->setfield('start_date', '')
3006 if $cust_pkg->start_date;
3011 # bill recurring fee
3014 #XXX unit stuff here too
3018 if ( ! $cust_pkg->get('susp')
3019 and ! $cust_pkg->get('start_date')
3020 and ( $part_pkg->getfield('freq') ne '0'
3021 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
3023 || ( $part_pkg->plan eq 'voip_cdr'
3024 && $part_pkg->option('bill_every_call')
3026 || ( $options{cancel} )
3029 # XXX should this be a package event? probably. events are called
3030 # at collection time at the moment, though...
3031 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
3032 if $part_pkg->can('reset_usage');
3033 #don't want to reset usage just cause we want a line item??
3034 #&& $part_pkg->pkgpart == $real_pkgpart;
3036 warn " bill recur\n" if $DEBUG > 1;
3039 # XXX shared with $recur_prog
3040 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
3044 #over two params! lets at least switch to a hashref for the rest...
3045 my $increment_next_bill = ( $part_pkg->freq ne '0'
3046 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
3047 && !$options{cancel}
3049 my %param = ( 'precommit_hooks' => $precommit_hooks,
3050 'increment_next_bill' => $increment_next_bill,
3053 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
3054 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
3055 return "$@ running $method for $cust_pkg\n"
3058 if ( $increment_next_bill ) {
3060 my $next_bill = $part_pkg->add_freq($sdate);
3061 return "unparsable frequency: ". $part_pkg->freq
3062 if $next_bill == -1;
3064 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
3065 # only for figuring next bill date, nothing else, so, reset $sdate again
3067 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
3068 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
3069 $cust_pkg->last_bill($sdate);
3071 $cust_pkg->setfield('bill', $next_bill );
3077 warn "\$setup is undefined" unless defined($setup);
3078 warn "\$recur is undefined" unless defined($recur);
3079 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
3082 # If there's line items, create em cust_bill_pkg records
3083 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
3088 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
3089 # hmm.. and if just the options are modified in some weird price plan?
3091 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
3094 my $error = $cust_pkg->replace( $old_cust_pkg,
3095 'options' => { $cust_pkg->options },
3097 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
3098 if $error; #just in case
3101 $setup = sprintf( "%.2f", $setup );
3102 $recur = sprintf( "%.2f", $recur );
3103 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
3104 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
3106 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
3107 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
3110 if ( $setup != 0 || $recur != 0 ) {
3112 warn " charges (setup=$setup, recur=$recur); adding line items\n"
3115 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
3117 warn " adding customer package invoice detail: $_\n"
3118 foreach @cust_pkg_detail;
3120 push @details, @cust_pkg_detail;
3122 my $cust_bill_pkg = new FS::cust_bill_pkg {
3123 'pkgnum' => $cust_pkg->pkgnum,
3125 'unitsetup' => $unitsetup,
3127 'unitrecur' => $unitrecur,
3128 'quantity' => $cust_pkg->quantity,
3129 'details' => \@details,
3130 'hidden' => $part_pkg->hidden,
3133 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
3134 $cust_bill_pkg->sdate( $hash{last_bill} );
3135 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
3136 $cust_bill_pkg->edate( $time ) if $options{cancel};
3137 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
3138 $cust_bill_pkg->sdate( $sdate );
3139 $cust_bill_pkg->edate( $cust_pkg->bill );
3140 #$cust_bill_pkg->edate( $time ) if $options{cancel};
3143 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
3144 unless $part_pkg->pkgpart == $real_pkgpart;
3146 $$total_setup += $setup;
3147 $$total_recur += $recur;
3154 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
3155 return $error if $error;
3157 push @$cust_bill_pkgs, $cust_bill_pkg;
3159 } #if $setup != 0 || $recur != 0
3169 my $part_pkg = shift;
3170 my $taxlisthash = shift;
3171 my $cust_bill_pkg = shift;
3172 my $cust_pkg = shift;
3173 my $invoice_time = shift;
3174 my $real_pkgpart = shift;
3175 my $options = shift;
3177 my %cust_bill_pkg = ();
3181 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
3182 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
3183 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
3184 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
3186 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
3188 if ( $conf->exists('enable_taxproducts')
3189 && ( scalar($part_pkg->part_pkg_taxoverride)
3190 || $part_pkg->has_taxproduct
3195 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3196 return "fatal: Can't (yet) use tax-pkg_address with taxproducts";
3199 foreach my $class (@classes) {
3200 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class );
3201 return $err_or_ref unless ref($err_or_ref);
3202 $taxes{$class} = $err_or_ref;
3205 unless (exists $taxes{''}) {
3206 my $err_or_ref = $self->_gather_taxes( $part_pkg, '' );
3207 return $err_or_ref unless ref($err_or_ref);
3208 $taxes{''} = $err_or_ref;
3213 my @loc_keys = qw( state county country );
3215 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3216 my $cust_location = $cust_pkg->cust_location;
3217 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
3220 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
3223 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
3226 $taxhash{'taxclass'} = $part_pkg->taxclass;
3228 my @taxes = qsearch( 'cust_main_county', \%taxhash );
3230 my %taxhash_elim = %taxhash;
3232 my @elim = qw( taxclass county state );
3233 while ( !scalar(@taxes) && scalar(@elim) ) {
3234 $taxhash_elim{ shift(@elim) } = '';
3235 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
3238 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
3240 if $self->cust_main_exemption; #just to be safe
3242 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3244 $_->set('pkgnum', $cust_pkg->pkgnum );
3245 $_->set('locationnum', $cust_pkg->locationnum );
3249 $taxes{''} = [ @taxes ];
3250 $taxes{'setup'} = [ @taxes ];
3251 $taxes{'recur'} = [ @taxes ];
3252 $taxes{$_} = [ @taxes ] foreach (@classes);
3254 # # maybe eliminate this entirely, along with all the 0% records
3255 # unless ( @taxes ) {
3257 # "fatal: can't find tax rate for state/county/country/taxclass ".
3258 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
3261 } #if $conf->exists('enable_taxproducts') ...
3266 my $separate = $conf->exists('separate_usage');
3267 my $usage_mandate = $cust_pkg->part_pkg->option('usage_mandate', 'Hush!');
3268 if ( $separate || $cust_bill_pkg->hidden || $usage_mandate ) {
3270 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
3271 my %hash = $cust_bill_pkg->hidden # maybe for all bill linked?
3272 ? ( 'section' => $temp_pkg->part_pkg->categoryname )
3275 my $section = $cust_pkg->part_pkg->option('usage_section', 'Hush!');
3276 my $summary = $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
3278 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3279 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
3281 push @display, new FS::cust_bill_pkg_display
3284 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
3288 if ($separate && $section && $summary) {
3289 push @display, new FS::cust_bill_pkg_display { type => 'U',
3294 if ($usage_mandate || $section && $summary) {
3295 $hash{post_total} = 'Y';
3298 $hash{section} = $section if ($separate || $usage_mandate);
3299 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
3302 $cust_bill_pkg->set('display', \@display);
3304 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
3305 foreach my $key (keys %tax_cust_bill_pkg) {
3306 my @taxes = @{ $taxes{$key} || [] };
3307 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
3309 my %localtaxlisthash = ();
3310 foreach my $tax ( @taxes ) {
3312 my $taxname = ref( $tax ). ' '. $tax->taxnum;
3313 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
3314 # ' locationnum'. $cust_pkg->locationnum
3315 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
3317 $taxlisthash->{ $taxname } ||= [ $tax ];
3318 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
3320 $localtaxlisthash{ $taxname } ||= [ $tax ];
3321 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
3325 warn "finding taxed taxes...\n" if $DEBUG > 2;
3326 foreach my $tax ( keys %localtaxlisthash ) {
3327 my $tax_object = shift @{ $localtaxlisthash{$tax} };
3328 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
3330 next unless $tax_object->can('tax_on_tax');
3332 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
3333 my $totname = ref( $tot ). ' '. $tot->taxnum;
3335 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
3337 next unless exists( $localtaxlisthash{ $totname } ); # only increase
3339 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
3340 my $hashref_or_error =
3341 $tax_object->taxline( $localtaxlisthash{$tax},
3342 'custnum' => $self->custnum,
3343 'invoice_time' => $invoice_time,
3345 return $hashref_or_error
3346 unless ref($hashref_or_error);
3348 $taxlisthash->{ $totname } ||= [ $tot ];
3349 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
3361 my $part_pkg = shift;
3365 my $geocode = $self->geocode('cch');
3367 my @taxclassnums = map { $_->taxclassnum }
3368 $part_pkg->part_pkg_taxoverride($class);
3370 unless (@taxclassnums) {
3371 @taxclassnums = map { $_->taxclassnum }
3372 grep { $_->taxable eq 'Y' }
3373 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
3375 warn "Found taxclassnum values of ". join(',', @taxclassnums)
3380 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
3382 @taxes = qsearch({ 'table' => 'tax_rate',
3383 'hashref' => { 'geocode' => $geocode, },
3384 'extra_sql' => $extra_sql,
3386 if scalar(@taxclassnums);
3388 warn "Found taxes ".
3389 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
3396 =item collect [ HASHREF | OPTION => VALUE ... ]
3398 (Attempt to) collect money for this customer's outstanding invoices (see
3399 L<FS::cust_bill>). Usually used after the bill method.
3401 Actions are now triggered by billing events; see L<FS::part_event> and the
3402 billing events web interface. Old-style invoice events (see
3403 L<FS::part_bill_event>) have been deprecated.
3405 If there is an error, returns the error, otherwise returns false.
3407 Options are passed as name-value pairs.
3409 Currently available options are:
3415 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.
3419 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3423 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3427 set true to surpress email card/ACH decline notices.
3431 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)
3437 # allows for one time override of normal customer billing method
3442 my( $self, %options ) = @_;
3443 my $invoice_time = $options{'invoice_time'} || time;
3446 local $SIG{HUP} = 'IGNORE';
3447 local $SIG{INT} = 'IGNORE';
3448 local $SIG{QUIT} = 'IGNORE';
3449 local $SIG{TERM} = 'IGNORE';
3450 local $SIG{TSTP} = 'IGNORE';
3451 local $SIG{PIPE} = 'IGNORE';
3453 my $oldAutoCommit = $FS::UID::AutoCommit;
3454 local $FS::UID::AutoCommit = 0;
3457 $self->select_for_update; #mutex
3460 my $balance = $self->balance;
3461 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
3464 if ( exists($options{'retry_card'}) ) {
3465 carp 'retry_card option passed to collect is deprecated; use retry';
3466 $options{'retry'} ||= $options{'retry_card'};
3468 if ( exists($options{'retry'}) && $options{'retry'} ) {
3469 my $error = $self->retry_realtime;
3471 $dbh->rollback if $oldAutoCommit;
3476 my $error = $self->do_cust_event(
3477 'debug' => ( $options{'debug'} || 0 ),
3478 'time' => $invoice_time,
3479 'check_freq' => $options{'check_freq'},
3480 'stage' => 'collect',
3483 $dbh->rollback if $oldAutoCommit;
3487 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3492 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
3494 Runs billing events; see L<FS::part_event> and the billing events web
3497 If there is an error, returns the error, otherwise returns false.
3499 Options are passed as name-value pairs.
3501 Currently available options are:
3507 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.
3511 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3515 "collect" (the default) or "pre-bill"
3519 set true to surpress email card/ACH decline notices.
3523 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)
3529 # allows for one time override of normal customer billing method
3533 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3536 my( $self, %options ) = @_;
3537 my $time = $options{'time'} || time;
3540 local $SIG{HUP} = 'IGNORE';
3541 local $SIG{INT} = 'IGNORE';
3542 local $SIG{QUIT} = 'IGNORE';
3543 local $SIG{TERM} = 'IGNORE';
3544 local $SIG{TSTP} = 'IGNORE';
3545 local $SIG{PIPE} = 'IGNORE';
3547 my $oldAutoCommit = $FS::UID::AutoCommit;
3548 local $FS::UID::AutoCommit = 0;
3551 $self->select_for_update; #mutex
3554 my $balance = $self->balance;
3555 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
3558 # if ( exists($options{'retry_card'}) ) {
3559 # carp 'retry_card option passed to collect is deprecated; use retry';
3560 # $options{'retry'} ||= $options{'retry_card'};
3562 # if ( exists($options{'retry'}) && $options{'retry'} ) {
3563 # my $error = $self->retry_realtime;
3565 # $dbh->rollback if $oldAutoCommit;
3570 # false laziness w/pay_batch::import_results
3572 my $due_cust_event = $self->due_cust_event(
3573 'debug' => ( $options{'debug'} || 0 ),
3575 'check_freq' => $options{'check_freq'},
3576 'stage' => ( $options{'stage'} || 'collect' ),
3578 unless( ref($due_cust_event) ) {
3579 $dbh->rollback if $oldAutoCommit;
3580 return $due_cust_event;
3583 foreach my $cust_event ( @$due_cust_event ) {
3587 #re-eval event conditions (a previous event could have changed things)
3588 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
3589 #don't leave stray "new/locked" records around
3590 my $error = $cust_event->delete;
3592 #gah, even with transactions
3593 $dbh->commit if $oldAutoCommit; #well.
3600 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
3601 warn " running cust_event ". $cust_event->eventnum. "\n"
3605 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
3606 if ( my $error = $cust_event->do_event() ) {
3607 #XXX wtf is this? figure out a proper dealio with return value
3609 # gah, even with transactions.
3610 $dbh->commit if $oldAutoCommit; #well.
3617 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3622 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
3624 Inserts database records for and returns an ordered listref of new events due
3625 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
3626 events are due, an empty listref is returned. If there is an error, returns a
3627 scalar error message.
3629 To actually run the events, call each event's test_condition method, and if
3630 still true, call the event's do_event method.
3632 Options are passed as a hashref or as a list of name-value pairs. Available
3639 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.
3643 "collect" (the default) or "pre-bill"
3647 "Current time" for the events.
3651 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)
3655 Only return events for the specified eventtable (by default, events of all eventtables are returned)
3659 Explicitly pass the objects to be tested (typically used with eventtable).
3663 Set to true to return the objects, but not actually insert them into the
3670 sub due_cust_event {
3672 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
3675 #my $DEBUG = $opt{'debug'}
3676 local($DEBUG) = $opt{'debug'}
3677 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
3679 warn "$me due_cust_event called with options ".
3680 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
3683 $opt{'time'} ||= time;
3685 local $SIG{HUP} = 'IGNORE';
3686 local $SIG{INT} = 'IGNORE';
3687 local $SIG{QUIT} = 'IGNORE';
3688 local $SIG{TERM} = 'IGNORE';
3689 local $SIG{TSTP} = 'IGNORE';
3690 local $SIG{PIPE} = 'IGNORE';
3692 my $oldAutoCommit = $FS::UID::AutoCommit;
3693 local $FS::UID::AutoCommit = 0;
3696 $self->select_for_update #mutex
3697 unless $opt{testonly};
3700 # find possible events (initial search)
3703 my @cust_event = ();
3705 my @eventtable = $opt{'eventtable'}
3706 ? ( $opt{'eventtable'} )
3707 : FS::part_event->eventtables_runorder;
3709 foreach my $eventtable ( @eventtable ) {
3712 if ( $opt{'objects'} ) {
3714 @objects = @{ $opt{'objects'} };
3718 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
3719 @objects = ( $eventtable eq 'cust_main' )
3721 : ( $self->$eventtable() );
3725 my @e_cust_event = ();
3727 my $cross = "CROSS JOIN $eventtable";
3728 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
3729 unless $eventtable eq 'cust_main';
3731 foreach my $object ( @objects ) {
3733 #this first search uses the condition_sql magic for optimization.
3734 #the more possible events we can eliminate in this step the better
3736 my $cross_where = '';
3737 my $pkey = $object->primary_key;
3738 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
3740 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
3742 FS::part_event_condition->where_conditions_sql( $eventtable,
3743 'time'=>$opt{'time'}
3745 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
3747 $extra_sql = "AND $extra_sql" if $extra_sql;
3749 #here is the agent virtualization
3750 $extra_sql .= " AND ( part_event.agentnum IS NULL
3751 OR part_event.agentnum = ". $self->agentnum. ' )';
3753 $extra_sql .= " $order";
3755 warn "searching for events for $eventtable ". $object->$pkey. "\n"
3756 if $opt{'debug'} > 2;
3757 my @part_event = qsearch( {
3758 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
3759 'select' => 'part_event.*',
3760 'table' => 'part_event',
3761 'addl_from' => "$cross $join",
3762 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
3763 'eventtable' => $eventtable,
3766 'extra_sql' => "AND $cross_where $extra_sql",
3770 my $pkey = $object->primary_key;
3771 warn " ". scalar(@part_event).
3772 " possible events found for $eventtable ". $object->$pkey(). "\n";
3775 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
3779 warn " ". scalar(@e_cust_event).
3780 " subtotal possible cust events found for $eventtable\n"
3783 push @cust_event, @e_cust_event;
3787 warn " ". scalar(@cust_event).
3788 " total possible cust events found in initial search\n"
3796 $opt{stage} ||= 'collect';
3798 grep { my $stage = $_->part_event->event_stage;
3799 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
3809 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
3810 'stats_hashref' => \%unsat ),
3813 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
3816 warn " invalid conditions not eliminated with condition_sql:\n".
3817 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
3824 unless( $opt{testonly} ) {
3825 foreach my $cust_event ( @cust_event ) {
3827 my $error = $cust_event->insert();
3829 $dbh->rollback if $oldAutoCommit;
3836 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3842 warn " returning events: ". Dumper(@cust_event). "\n"
3849 =item retry_realtime
3851 Schedules realtime / batch credit card / electronic check / LEC billing
3852 events for for retry. Useful if card information has changed or manual
3853 retry is desired. The 'collect' method must be called to actually retry
3856 Implementation details: For either this customer, or for each of this
3857 customer's open invoices, changes the status of the first "done" (with
3858 statustext error) realtime processing event to "failed".
3862 sub retry_realtime {
3865 local $SIG{HUP} = 'IGNORE';
3866 local $SIG{INT} = 'IGNORE';
3867 local $SIG{QUIT} = 'IGNORE';
3868 local $SIG{TERM} = 'IGNORE';
3869 local $SIG{TSTP} = 'IGNORE';
3870 local $SIG{PIPE} = 'IGNORE';
3872 my $oldAutoCommit = $FS::UID::AutoCommit;
3873 local $FS::UID::AutoCommit = 0;
3876 #a little false laziness w/due_cust_event (not too bad, really)
3878 my $join = FS::part_event_condition->join_conditions_sql;
3879 my $order = FS::part_event_condition->order_conditions_sql;
3882 . join ( ' OR ' , map {
3883 "( part_event.eventtable = " . dbh->quote($_)
3884 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
3885 } FS::part_event->eventtables)
3888 #here is the agent virtualization
3889 my $agent_virt = " ( part_event.agentnum IS NULL
3890 OR part_event.agentnum = ". $self->agentnum. ' )';
3892 #XXX this shouldn't be hardcoded, actions should declare it...
3893 my @realtime_events = qw(
3894 cust_bill_realtime_card
3895 cust_bill_realtime_check
3896 cust_bill_realtime_lec
3900 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
3905 my @cust_event = qsearchs({
3906 'table' => 'cust_event',
3907 'select' => 'cust_event.*',
3908 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
3909 'hashref' => { 'status' => 'done' },
3910 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
3911 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
3914 my %seen_invnum = ();
3915 foreach my $cust_event (@cust_event) {
3917 #max one for the customer, one for each open invoice
3918 my $cust_X = $cust_event->cust_X;
3919 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
3923 or $cust_event->part_event->eventtable eq 'cust_bill'
3926 my $error = $cust_event->retry;
3928 $dbh->rollback if $oldAutoCommit;
3929 return "error scheduling event for retry: $error";
3934 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3939 # some horrid false laziness here to avoid refactor fallout
3940 # eventually realtime realtime_bop and realtime_refund_bop should go
3941 # away and be replaced by _new_realtime_bop and _new_realtime_refund_bop
3943 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
3945 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
3946 via a Business::OnlinePayment realtime gateway. See
3947 L<http://420.am/business-onlinepayment> for supported gateways.
3949 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3951 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
3953 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3954 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3955 if set, will override the value from the customer record.
3957 I<description> is a free-text field passed to the gateway. It defaults to
3958 the value defined by the business-onlinepayment-description configuration
3959 option, or "Internet services" if that is unset.
3961 If an I<invnum> is specified, this payment (if successful) is applied to the
3962 specified invoice. If you don't specify an I<invnum> you might want to
3963 call the B<apply_payments> method or set the I<apply> option.
3965 I<apply> can be set to true to apply a resulting payment.
3967 I<quiet> can be set true to surpress email decline notices.
3969 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
3970 resulting paynum, if any.
3972 I<payunique> is a unique identifier for this payment.
3974 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
3981 return $self->_new_realtime_bop(@_)
3982 if $self->_new_bop_required();
3984 my($method, $amount);
3986 if (ref($_[0]) eq 'HASH') {
3987 %options = %{$_[0]};
3988 $method = $options{method};
3989 $amount = $options{amount};
3991 ( $method, $amount ) = ( shift, shift );
3995 warn "$me realtime_bop: $method $amount\n";
3996 warn " $_ => $options{$_}\n" foreach keys %options;
3999 unless ( $options{'description'} ) {
4000 if ( $conf->exists('business-onlinepayment-description') ) {
4001 my $dtempl = $conf->config('business-onlinepayment-description');
4003 my $agent = $self->agent->agent;
4005 $options{'description'} = eval qq("$dtempl");
4007 $options{'description'} = 'Internet services';
4011 return $self->fake_bop($method, $amount, %options) if $options{'fake'};
4013 eval "use Business::OnlinePayment";
4016 my $payinfo = exists($options{'payinfo'})
4017 ? $options{'payinfo'}
4020 my %method2payby = (
4027 # check for banned credit card/ACH
4030 my $ban = qsearchs('banned_pay', {
4031 'payby' => $method2payby{$method},
4032 'payinfo' => md5_base64($payinfo),
4034 return "Banned credit card" if $ban;
4037 # set taxclass and trans_is_recur based on invnum if there is one
4041 my $trans_is_recur = 0;
4042 if ( $options{'invnum'} ) {
4044 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
4045 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
4048 map { $_->part_pkg }
4050 map { $_->cust_pkg }
4051 $cust_bill->cust_bill_pkg;
4053 my @taxclasses = map $_->taxclass, @part_pkg;
4054 $taxclass = $taxclasses[0]
4055 unless grep { $taxclasses[0] ne $_ } @taxclasses; #unless there are
4056 #different taxclasses
4058 if grep { $_->freq ne '0' } @part_pkg;
4066 #look for an agent gateway override first
4068 if ( $method eq 'CC' ) {
4069 $cardtype = cardtype($payinfo);
4070 } elsif ( $method eq 'ECHECK' ) {
4073 $cardtype = $method;
4077 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4078 cardtype => $cardtype,
4079 taxclass => $taxclass, } )
4080 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4082 taxclass => $taxclass, } )
4083 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4084 cardtype => $cardtype,
4086 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4088 taxclass => '', } );
4090 my $payment_gateway = '';
4091 my( $processor, $login, $password, $action, @bop_options );
4092 if ( $override ) { #use a payment gateway override
4094 $payment_gateway = $override->payment_gateway;
4096 $processor = $payment_gateway->gateway_module;
4097 $login = $payment_gateway->gateway_username;
4098 $password = $payment_gateway->gateway_password;
4099 $action = $payment_gateway->gateway_action;
4100 @bop_options = $payment_gateway->options;
4102 } else { #use the standard settings from the config
4104 ( $processor, $login, $password, $action, @bop_options ) =
4105 $self->default_payment_gateway($method);
4113 my $address = exists($options{'address1'})
4114 ? $options{'address1'}
4116 my $address2 = exists($options{'address2'})
4117 ? $options{'address2'}
4119 $address .= ", ". $address2 if length($address2);
4121 my $o_payname = exists($options{'payname'})
4122 ? $options{'payname'}
4124 my($payname, $payfirst, $paylast);
4125 if ( $o_payname && $method ne 'ECHECK' ) {
4126 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4127 or return "Illegal payname $payname";
4128 ($payfirst, $paylast) = ($1, $2);
4130 $payfirst = $self->getfield('first');
4131 $paylast = $self->getfield('last');
4132 $payname = "$payfirst $paylast";
4135 my @invoicing_list = $self->invoicing_list_emailonly;
4136 if ( $conf->exists('emailinvoiceautoalways')
4137 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4138 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4139 push @invoicing_list, $self->all_emails;
4142 my $email = ($conf->exists('business-onlinepayment-email-override'))
4143 ? $conf->config('business-onlinepayment-email-override')
4144 : $invoicing_list[0];
4148 my $payip = exists($options{'payip'})
4151 $content{customer_ip} = $payip
4154 $content{invoice_number} = $options{'invnum'}
4155 if exists($options{'invnum'}) && length($options{'invnum'});
4157 $content{email_customer} =
4158 ( $conf->exists('business-onlinepayment-email_customer')
4159 || $conf->exists('business-onlinepayment-email-override') );
4162 if ( $method eq 'CC' ) {
4164 $content{card_number} = $payinfo;
4165 $paydate = exists($options{'paydate'})
4166 ? $options{'paydate'}
4168 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4169 $content{expiration} = "$2/$1";
4171 my $paycvv = exists($options{'paycvv'})
4172 ? $options{'paycvv'}
4174 $content{cvv2} = $paycvv
4177 my $paystart_month = exists($options{'paystart_month'})
4178 ? $options{'paystart_month'}
4179 : $self->paystart_month;
4181 my $paystart_year = exists($options{'paystart_year'})
4182 ? $options{'paystart_year'}
4183 : $self->paystart_year;
4185 $content{card_start} = "$paystart_month/$paystart_year"
4186 if $paystart_month && $paystart_year;
4188 my $payissue = exists($options{'payissue'})
4189 ? $options{'payissue'}
4191 $content{issue_number} = $payissue if $payissue;
4193 if ( $self->_bop_recurring_billing( 'payinfo' => $payinfo,
4194 'trans_is_recur' => $trans_is_recur,
4198 $content{recurring_billing} = 'YES';
4199 $content{acct_code} = 'rebill'
4200 if $conf->exists('credit_card-recurring_billing_acct_code');
4203 } elsif ( $method eq 'ECHECK' ) {
4204 ( $content{account_number}, $content{routing_code} ) =
4205 split('@', $payinfo);
4206 $content{bank_name} = $o_payname;
4207 $content{bank_state} = exists($options{'paystate'})
4208 ? $options{'paystate'}
4209 : $self->getfield('paystate');
4210 $content{account_type} = exists($options{'paytype'})
4211 ? uc($options{'paytype'}) || 'CHECKING'
4212 : uc($self->getfield('paytype')) || 'CHECKING';
4213 $content{account_name} = $payname;
4214 $content{customer_org} = $self->company ? 'B' : 'I';
4215 $content{state_id} = exists($options{'stateid'})
4216 ? $options{'stateid'}
4217 : $self->getfield('stateid');
4218 $content{state_id_state} = exists($options{'stateid_state'})
4219 ? $options{'stateid_state'}
4220 : $self->getfield('stateid_state');
4221 $content{customer_ssn} = exists($options{'ss'})
4224 } elsif ( $method eq 'LEC' ) {
4225 $content{phone} = $payinfo;
4229 # run transaction(s)
4232 my $balance = exists( $options{'balance'} )
4233 ? $options{'balance'}
4236 $self->select_for_update; #mutex ... just until we get our pending record in
4238 #the checks here are intended to catch concurrent payments
4239 #double-form-submission prevention is taken care of in cust_pay_pending::check
4242 return "The customer's balance has changed; $method transaction aborted."
4243 if $self->balance < $balance;
4244 #&& $self->balance < $amount; #might as well anyway?
4246 #also check and make sure there aren't *other* pending payments for this cust
4248 my @pending = qsearch('cust_pay_pending', {
4249 'custnum' => $self->custnum,
4250 'status' => { op=>'!=', value=>'done' }
4252 return "A payment is already being processed for this customer (".
4253 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
4254 "); $method transaction aborted."
4255 if scalar(@pending);
4257 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
4259 my $cust_pay_pending = new FS::cust_pay_pending {
4260 'custnum' => $self->custnum,
4261 #'invnum' => $options{'invnum'},
4264 'payby' => $method2payby{$method},
4265 'payinfo' => $payinfo,
4266 'paydate' => $paydate,
4267 'recurring_billing' => $content{recurring_billing},
4268 'pkgnum' => $options{'pkgnum'},
4270 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
4272 $cust_pay_pending->payunique( $options{payunique} )
4273 if defined($options{payunique}) && length($options{payunique});
4274 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
4275 return $cpp_new_err if $cpp_new_err;
4277 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
4279 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
4280 $transaction->content(
4283 'password' => $password,
4284 'action' => $action1,
4285 'description' => $options{'description'},
4286 'amount' => $amount,
4287 #'invoice_number' => $options{'invnum'},
4288 'customer_id' => $self->custnum,
4289 'last_name' => $paylast,
4290 'first_name' => $payfirst,
4292 'address' => $address,
4293 'city' => ( exists($options{'city'})
4296 'state' => ( exists($options{'state'})
4299 'zip' => ( exists($options{'zip'})
4302 'country' => ( exists($options{'country'})
4303 ? $options{'country'}
4305 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4307 'phone' => $self->daytime || $self->night,
4311 $cust_pay_pending->status('pending');
4312 my $cpp_pending_err = $cust_pay_pending->replace;
4313 return $cpp_pending_err if $cpp_pending_err;
4316 my $BOP_TESTING = 0;
4317 my $BOP_TESTING_SUCCESS = 1;
4319 unless ( $BOP_TESTING ) {
4320 $transaction->submit();
4322 if ( $BOP_TESTING_SUCCESS ) {
4323 $transaction->is_success(1);
4324 $transaction->authorization('fake auth');
4326 $transaction->is_success(0);
4327 $transaction->error_message('fake failure');
4331 if ( $transaction->is_success() && $action2 ) {
4333 $cust_pay_pending->status('authorized');
4334 my $cpp_authorized_err = $cust_pay_pending->replace;
4335 return $cpp_authorized_err if $cpp_authorized_err;
4337 my $auth = $transaction->authorization;
4338 my $ordernum = $transaction->can('order_number')
4339 ? $transaction->order_number
4343 new Business::OnlinePayment( $processor, @bop_options );
4350 password => $password,
4351 order_number => $ordernum,
4353 authorization => $auth,
4354 description => $options{'description'},
4357 foreach my $field (qw( authorization_source_code returned_ACI
4358 transaction_identifier validation_code
4359 transaction_sequence_num local_transaction_date
4360 local_transaction_time AVS_result_code )) {
4361 $capture{$field} = $transaction->$field() if $transaction->can($field);
4364 $capture->content( %capture );
4368 unless ( $capture->is_success ) {
4369 my $e = "Authorization successful but capture failed, custnum #".
4370 $self->custnum. ': '. $capture->result_code.
4371 ": ". $capture->error_message;
4378 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
4379 my $cpp_captured_err = $cust_pay_pending->replace;
4380 return $cpp_captured_err if $cpp_captured_err;
4383 # remove paycvv after initial transaction
4386 #false laziness w/misc/process/payment.cgi - check both to make sure working
4388 if ( defined $self->dbdef_table->column('paycvv')
4389 && length($self->paycvv)
4390 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
4392 my $error = $self->remove_cvv;
4394 warn "WARNING: error removing cvv: $error\n";
4402 if ( $transaction->is_success() ) {
4405 if ( $payment_gateway ) { # agent override
4406 $paybatch = $payment_gateway->gatewaynum. '-';
4409 $paybatch .= "$processor:". $transaction->authorization;
4411 $paybatch .= ':'. $transaction->order_number
4412 if $transaction->can('order_number')
4413 && length($transaction->order_number);
4415 my $cust_pay = new FS::cust_pay ( {
4416 'custnum' => $self->custnum,
4417 'invnum' => $options{'invnum'},
4420 'payby' => $method2payby{$method},
4421 'payinfo' => $payinfo,
4422 'paybatch' => $paybatch,
4423 'paydate' => $paydate,
4424 'pkgnum' => $options{'pkgnum'},
4426 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
4427 $cust_pay->payunique( $options{payunique} )
4428 if defined($options{payunique}) && length($options{payunique});
4430 my $oldAutoCommit = $FS::UID::AutoCommit;
4431 local $FS::UID::AutoCommit = 0;
4434 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
4436 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
4439 $cust_pay->invnum(''); #try again with no specific invnum
4440 my $error2 = $cust_pay->insert( $options{'manual'} ?
4441 ( 'manual' => 1 ) : ()
4444 # gah. but at least we have a record of the state we had to abort in
4445 # from cust_pay_pending now.
4446 my $e = "WARNING: $method captured but payment not recorded - ".
4447 "error inserting payment ($processor): $error2".
4448 " (previously tried insert with invnum #$options{'invnum'}" .
4449 ": $error ) - pending payment saved as paypendingnum ".
4450 $cust_pay_pending->paypendingnum. "\n";
4456 if ( $options{'paynum_ref'} ) {
4457 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
4460 $cust_pay_pending->status('done');
4461 $cust_pay_pending->statustext('captured');
4462 $cust_pay_pending->paynum($cust_pay->paynum);
4463 my $cpp_done_err = $cust_pay_pending->replace;
4465 if ( $cpp_done_err ) {
4467 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4468 my $e = "WARNING: $method captured but payment not recorded - ".
4469 "error updating status for paypendingnum ".
4470 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4476 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4478 if ( $options{'apply'} ) {
4479 my $apply_error = $self->apply_payments_and_credits;
4480 if ( $apply_error ) {
4481 warn "WARNING: error applying payment: $apply_error\n";
4482 #but we still should return no error cause the payment otherwise went
4487 return ''; #no error
4493 my $perror = "$processor error: ". $transaction->error_message;
4495 unless ( $transaction->error_message ) {
4498 if ( $transaction->can('response_page') ) {
4500 'page' => ( $transaction->can('response_page')
4501 ? $transaction->response_page
4504 'code' => ( $transaction->can('response_code')
4505 ? $transaction->response_code
4508 'headers' => ( $transaction->can('response_headers')
4509 ? $transaction->response_headers
4515 "No additional debugging information available for $processor";
4518 $perror .= "No error_message returned from $processor -- ".
4519 ( ref($t_response) ? Dumper($t_response) : $t_response );
4523 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
4524 && $conf->exists('emaildecline')
4525 && grep { $_ ne 'POST' } $self->invoicing_list
4526 && ! grep { $transaction->error_message =~ /$_/ }
4527 $conf->config('emaildecline-exclude')
4529 my @templ = $conf->config('declinetemplate');
4530 my $template = new Text::Template (
4532 SOURCE => [ map "$_\n", @templ ],
4533 ) or return "($perror) can't create template: $Text::Template::ERROR";
4534 $template->compile()
4535 or return "($perror) can't compile template: $Text::Template::ERROR";
4539 scalar( $conf->config('company_name', $self->agentnum ) ),
4540 'company_address' =>
4541 join("\n", $conf->config('company_address', $self->agentnum ) ),
4542 'error' => $transaction->error_message,
4545 my $error = send_email(
4546 'from' => $conf->config('invoice_from', $self->agentnum ),
4547 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
4548 'subject' => 'Your payment could not be processed',
4549 'body' => [ $template->fill_in(HASH => $templ_hash) ],
4552 $perror .= " (also received error sending decline notification: $error)"
4557 $cust_pay_pending->status('done');
4558 $cust_pay_pending->statustext("declined: $perror");
4559 my $cpp_done_err = $cust_pay_pending->replace;
4560 if ( $cpp_done_err ) {
4561 my $e = "WARNING: $method declined but pending payment not resolved - ".
4562 "error updating status for paypendingnum ".
4563 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4565 $perror = "$e ($perror)";
4573 sub _bop_recurring_billing {
4574 my( $self, %opt ) = @_;
4576 my $method = scalar($conf->config('credit_card-recurring_billing_flag'));
4578 if ( defined($method) && $method eq 'transaction_is_recur' ) {
4580 return 1 if $opt{'trans_is_recur'};
4584 my %hash = ( 'custnum' => $self->custnum,
4589 if qsearch('cust_pay', { %hash, 'payinfo' => $opt{'payinfo'} } )
4590 || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo('CARD',
4601 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
4603 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
4604 via a Business::OnlinePayment realtime gateway. See
4605 L<http://420.am/business-onlinepayment> for supported gateways.
4607 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4609 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
4611 Most gateways require a reference to an original payment transaction to refund,
4612 so you probably need to specify a I<paynum>.
4614 I<amount> defaults to the original amount of the payment if not specified.
4616 I<reason> specifies a reason for the refund.
4618 I<paydate> specifies the expiration date for a credit card overriding the
4619 value from the customer record or the payment record. Specified as yyyy-mm-dd
4621 Implementation note: If I<amount> is unspecified or equal to the amount of the
4622 orignal payment, first an attempt is made to "void" the transaction via
4623 the gateway (to cancel a not-yet settled transaction) and then if that fails,
4624 the normal attempt is made to "refund" ("credit") the transaction via the
4625 gateway is attempted.
4627 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4628 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4629 #if set, will override the value from the customer record.
4631 #If an I<invnum> is specified, this payment (if successful) is applied to the
4632 #specified invoice. If you don't specify an I<invnum> you might want to
4633 #call the B<apply_payments> method.
4637 #some false laziness w/realtime_bop, not enough to make it worth merging
4638 #but some useful small subs should be pulled out
4639 sub realtime_refund_bop {
4642 return $self->_new_realtime_refund_bop(@_)
4643 if $self->_new_bop_required();
4645 my( $method, %options ) = @_;
4647 warn "$me realtime_refund_bop: $method refund\n";
4648 warn " $_ => $options{$_}\n" foreach keys %options;
4651 eval "use Business::OnlinePayment";
4655 # look up the original payment and optionally a gateway for that payment
4659 my $amount = $options{'amount'};
4661 my( $processor, $login, $password, @bop_options ) ;
4662 my( $auth, $order_number ) = ( '', '', '' );
4664 if ( $options{'paynum'} ) {
4666 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
4667 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
4668 or return "Unknown paynum $options{'paynum'}";
4669 $amount ||= $cust_pay->paid;
4671 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
4672 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
4673 $cust_pay->paybatch;
4674 my $gatewaynum = '';
4675 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
4677 if ( $gatewaynum ) { #gateway for the payment to be refunded
4679 my $payment_gateway =
4680 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
4681 die "payment gateway $gatewaynum not found"
4682 unless $payment_gateway;
4684 $processor = $payment_gateway->gateway_module;
4685 $login = $payment_gateway->gateway_username;
4686 $password = $payment_gateway->gateway_password;
4687 @bop_options = $payment_gateway->options;
4689 } else { #try the default gateway
4691 my( $conf_processor, $unused_action );
4692 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
4693 $self->default_payment_gateway($method);
4695 return "processor of payment $options{'paynum'} $processor does not".
4696 " match default processor $conf_processor"
4697 unless $processor eq $conf_processor;
4702 } else { # didn't specify a paynum, so look for agent gateway overrides
4703 # like a normal transaction
4706 if ( $method eq 'CC' ) {
4707 $cardtype = cardtype($self->payinfo);
4708 } elsif ( $method eq 'ECHECK' ) {
4711 $cardtype = $method;
4714 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4715 cardtype => $cardtype,
4717 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4719 taxclass => '', } );
4721 if ( $override ) { #use a payment gateway override
4723 my $payment_gateway = $override->payment_gateway;
4725 $processor = $payment_gateway->gateway_module;
4726 $login = $payment_gateway->gateway_username;
4727 $password = $payment_gateway->gateway_password;
4728 #$action = $payment_gateway->gateway_action;
4729 @bop_options = $payment_gateway->options;
4731 } else { #use the standard settings from the config
4734 ( $processor, $login, $password, $unused_action, @bop_options ) =
4735 $self->default_payment_gateway($method);
4740 return "neither amount nor paynum specified" unless $amount;
4745 'password' => $password,
4746 'order_number' => $order_number,
4747 'amount' => $amount,
4748 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4750 $content{authorization} = $auth
4751 if length($auth); #echeck/ACH transactions have an order # but no auth
4752 #(at least with authorize.net)
4754 my $disable_void_after;
4755 if ($conf->exists('disable_void_after')
4756 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
4757 $disable_void_after = $1;
4760 #first try void if applicable
4761 if ( $cust_pay && $cust_pay->paid == $amount
4763 ( not defined($disable_void_after) )
4764 || ( time < ($cust_pay->_date + $disable_void_after ) )
4767 warn " attempting void\n" if $DEBUG > 1;
4768 my $void = new Business::OnlinePayment( $processor, @bop_options );
4769 $content{'card_number'} = $cust_pay->payinfo
4770 if $cust_pay->payby eq 'CARD'
4771 && $void->can('info') && $void->info('CC_void_requires_card');
4772 $void->content( 'action' => 'void', %content );
4774 if ( $void->is_success ) {
4775 my $error = $cust_pay->void($options{'reason'});
4777 # gah, even with transactions.
4778 my $e = 'WARNING: Card/ACH voided but database not updated - '.
4779 "error voiding payment: $error";
4783 warn " void successful\n" if $DEBUG > 1;
4788 warn " void unsuccessful, trying refund\n"
4792 my $address = $self->address1;
4793 $address .= ", ". $self->address2 if $self->address2;
4795 my($payname, $payfirst, $paylast);
4796 if ( $self->payname && $method ne 'ECHECK' ) {
4797 $payname = $self->payname;
4798 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4799 or return "Illegal payname $payname";
4800 ($payfirst, $paylast) = ($1, $2);
4802 $payfirst = $self->getfield('first');
4803 $paylast = $self->getfield('last');
4804 $payname = "$payfirst $paylast";
4807 my @invoicing_list = $self->invoicing_list_emailonly;
4808 if ( $conf->exists('emailinvoiceautoalways')
4809 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4810 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4811 push @invoicing_list, $self->all_emails;
4814 my $email = ($conf->exists('business-onlinepayment-email-override'))
4815 ? $conf->config('business-onlinepayment-email-override')
4816 : $invoicing_list[0];
4818 my $payip = exists($options{'payip'})
4821 $content{customer_ip} = $payip
4825 if ( $method eq 'CC' ) {
4828 $content{card_number} = $payinfo = $cust_pay->payinfo;
4829 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
4830 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
4831 ($content{expiration} = "$2/$1"); # where available
4833 $content{card_number} = $payinfo = $self->payinfo;
4834 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
4835 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4836 $content{expiration} = "$2/$1";
4839 } elsif ( $method eq 'ECHECK' ) {
4842 $payinfo = $cust_pay->payinfo;
4844 $payinfo = $self->payinfo;
4846 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
4847 $content{bank_name} = $self->payname;
4848 $content{account_type} = 'CHECKING';
4849 $content{account_name} = $payname;
4850 $content{customer_org} = $self->company ? 'B' : 'I';
4851 $content{customer_ssn} = $self->ss;
4852 } elsif ( $method eq 'LEC' ) {
4853 $content{phone} = $payinfo = $self->payinfo;
4857 my $refund = new Business::OnlinePayment( $processor, @bop_options );
4858 my %sub_content = $refund->content(
4859 'action' => 'credit',
4860 'customer_id' => $self->custnum,
4861 'last_name' => $paylast,
4862 'first_name' => $payfirst,
4864 'address' => $address,
4865 'city' => $self->city,
4866 'state' => $self->state,
4867 'zip' => $self->zip,
4868 'country' => $self->country,
4870 'phone' => $self->daytime || $self->night,
4873 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
4877 return "$processor error: ". $refund->error_message
4878 unless $refund->is_success();
4880 my %method2payby = (
4886 my $paybatch = "$processor:". $refund->authorization;
4887 $paybatch .= ':'. $refund->order_number
4888 if $refund->can('order_number') && $refund->order_number;
4890 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
4891 my @cust_bill_pay = $cust_pay->cust_bill_pay;
4892 last unless @cust_bill_pay;
4893 my $cust_bill_pay = pop @cust_bill_pay;
4894 my $error = $cust_bill_pay->delete;
4898 my $cust_refund = new FS::cust_refund ( {
4899 'custnum' => $self->custnum,
4900 'paynum' => $options{'paynum'},
4901 'refund' => $amount,
4903 'payby' => $method2payby{$method},
4904 'payinfo' => $payinfo,
4905 'paybatch' => $paybatch,
4906 'reason' => $options{'reason'} || 'card or ACH refund',
4908 my $error = $cust_refund->insert;
4910 $cust_refund->paynum(''); #try again with no specific paynum
4911 my $error2 = $cust_refund->insert;
4913 # gah, even with transactions.
4914 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
4915 "error inserting refund ($processor): $error2".
4916 " (previously tried insert with paynum #$options{'paynum'}" .
4927 # does the configuration indicate the new bop routines are required?
4929 sub _new_bop_required {
4932 my $botpp = 'Business::OnlineThirdPartyPayment';
4935 if ( ( $conf->exists('business-onlinepayment-namespace')
4936 && $conf->config('business-onlinepayment-namespace') eq $botpp
4938 or scalar( grep { $_->gateway_namespace eq $botpp }
4939 qsearch( 'payment_gateway', { 'disabled' => '' } )
4947 =item realtime_collect [ OPTION => VALUE ... ]
4949 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4950 via a Business::OnlinePayment or Business::OnlineThirdPartyPayment realtime
4951 gateway. See L<http://420.am/business-onlinepayment> and
4952 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
4954 On failure returns an error message.
4956 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.
4958 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>, I<pkgnum>
4960 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>. If none is specified
4961 then it is deduced from the customer record.
4963 If no I<amount> is specified, then the customer balance is used.
4965 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4966 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4967 if set, will override the value from the customer record.
4969 I<description> is a free-text field passed to the gateway. It defaults to
4970 the value defined by the business-onlinepayment-description configuration
4971 option, or "Internet services" if that is unset.
4973 If an I<invnum> is specified, this payment (if successful) is applied to the
4974 specified invoice. If you don't specify an I<invnum> you might want to
4975 call the B<apply_payments> method or set the I<apply> option.
4977 I<apply> can be set to true to apply a resulting payment.
4979 I<quiet> can be set true to surpress email decline notices.
4981 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4982 resulting paynum, if any.
4984 I<payunique> is a unique identifier for this payment.
4986 I<session_id> is a session identifier associated with this payment.
4988 I<depend_jobnum> allows payment capture to unlock export jobs
4992 sub realtime_collect {
4993 my( $self, %options ) = @_;
4996 warn "$me realtime_collect:\n";
4997 warn " $_ => $options{$_}\n" foreach keys %options;
5000 $options{amount} = $self->balance unless exists( $options{amount} );
5001 $options{method} = FS::payby->payby2bop($self->payby)
5002 unless exists( $options{method} );
5004 return $self->realtime_bop({%options});
5008 =item _realtime_bop { [ ARG => VALUE ... ] }
5010 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
5011 via a Business::OnlinePayment realtime gateway. See
5012 L<http://420.am/business-onlinepayment> for supported gateways.
5014 Required arguments in the hashref are I<method>, and I<amount>
5016 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5018 Available optional arguments are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
5020 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5021 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5022 if set, will override the value from the customer record.
5024 I<description> is a free-text field passed to the gateway. It defaults to
5025 the value defined by the business-onlinepayment-description configuration
5026 option, or "Internet services" if that is unset.
5028 If an I<invnum> is specified, this payment (if successful) is applied to the
5029 specified invoice. If you don't specify an I<invnum> you might want to
5030 call the B<apply_payments> method.
5032 I<quiet> can be set true to surpress email decline notices.
5034 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5035 resulting paynum, if any.
5037 I<payunique> is a unique identifier for this payment.
5039 I<session_id> is a session identifier associated with this payment.
5041 I<depend_jobnum> allows payment capture to unlock export jobs
5043 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
5047 # some helper routines
5048 sub _payment_gateway {
5049 my ($self, $options) = @_;
5051 $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
5052 unless exists($options->{payment_gateway});
5054 $options->{payment_gateway};
5058 my ($self, $options) = @_;
5061 'login' => $options->{payment_gateway}->gateway_username,
5062 'password' => $options->{payment_gateway}->gateway_password,
5067 my ($self, $options) = @_;
5069 $options->{payment_gateway}->gatewaynum
5070 ? $options->{payment_gateway}->options
5071 : @{ $options->{payment_gateway}->get('options') };
5075 my ($self, $options) = @_;
5077 unless ( $options->{'description'} ) {
5078 if ( $conf->exists('business-onlinepayment-description') ) {
5079 my $dtempl = $conf->config('business-onlinepayment-description');
5081 my $agent = $self->agent->agent;
5083 $options->{'description'} = eval qq("$dtempl");
5085 $options->{'description'} = 'Internet services';
5089 $options->{payinfo} = $self->payinfo unless exists( $options->{payinfo} );
5090 $options->{invnum} ||= '';
5091 $options->{payname} = $self->payname unless exists( $options->{payname} );
5095 my ($self, $options) = @_;
5098 $content{address} = exists($options->{'address1'})
5099 ? $options->{'address1'}
5101 my $address2 = exists($options->{'address2'})
5102 ? $options->{'address2'}
5104 $content{address} .= ", ". $address2 if length($address2);
5106 my $payip = exists($options->{'payip'}) ? $options->{'payip'} : $self->payip;
5107 $content{customer_ip} = $payip if length($payip);
5109 $content{invoice_number} = $options->{'invnum'}
5110 if exists($options->{'invnum'}) && length($options->{'invnum'});
5112 $content{email_customer} =
5113 ( $conf->exists('business-onlinepayment-email_customer')
5114 || $conf->exists('business-onlinepayment-email-override') );
5116 $content{payfirst} = $self->getfield('first');
5117 $content{paylast} = $self->getfield('last');
5119 $content{account_name} = "$content{payfirst} $content{paylast}"
5120 if $options->{method} eq 'ECHECK';
5122 $content{name} = $options->{payname};
5123 $content{name} = $content{account_name} if exists($content{account_name});
5125 $content{city} = exists($options->{city})
5128 $content{state} = exists($options->{state})
5131 $content{zip} = exists($options->{zip})
5134 $content{country} = exists($options->{country})
5135 ? $options->{country}
5137 $content{referer} = 'http://cleanwhisker.420.am/'; #XXX fix referer :/
5138 $content{phone} = $self->daytime || $self->night;
5143 my %bop_method2payby = (
5149 sub _new_realtime_bop {
5153 if (ref($_[0]) eq 'HASH') {
5154 %options = %{$_[0]};
5156 my ( $method, $amount ) = ( shift, shift );
5158 $options{method} = $method;
5159 $options{amount} = $amount;
5163 warn "$me realtime_bop (new): $options{method} $options{amount}\n";
5164 warn " $_ => $options{$_}\n" foreach keys %options;
5167 return $self->fake_bop(%options) if $options{'fake'};
5169 $self->_bop_defaults(\%options);
5172 # set trans_is_recur based on invnum if there is one
5175 my $trans_is_recur = 0;
5176 if ( $options{'invnum'} ) {
5178 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
5179 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
5182 map { $_->part_pkg }
5184 map { $_->cust_pkg }
5185 $cust_bill->cust_bill_pkg;
5188 if grep { $_->freq ne '0' } @part_pkg;
5196 my $payment_gateway = $self->_payment_gateway( \%options );
5197 my $namespace = $payment_gateway->gateway_namespace;
5199 eval "use $namespace";
5203 # check for banned credit card/ACH
5206 my $ban = qsearchs('banned_pay', {
5207 'payby' => $bop_method2payby{$options{method}},
5208 'payinfo' => md5_base64($options{payinfo}),
5210 return "Banned credit card" if $ban;
5216 my (%bop_content) = $self->_bop_content(\%options);
5218 if ( $options{method} ne 'ECHECK' ) {
5219 $options{payname} =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5220 or return "Illegal payname $options{payname}";
5221 ($bop_content{payfirst}, $bop_content{paylast}) = ($1, $2);
5224 my @invoicing_list = $self->invoicing_list_emailonly;
5225 if ( $conf->exists('emailinvoiceautoalways')
5226 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5227 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5228 push @invoicing_list, $self->all_emails;
5231 my $email = ($conf->exists('business-onlinepayment-email-override'))
5232 ? $conf->config('business-onlinepayment-email-override')
5233 : $invoicing_list[0];
5237 if ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'CC' ) {
5239 $content{card_number} = $options{payinfo};
5240 $paydate = exists($options{'paydate'})
5241 ? $options{'paydate'}
5243 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
5244 $content{expiration} = "$2/$1";
5246 my $paycvv = exists($options{'paycvv'})
5247 ? $options{'paycvv'}
5249 $content{cvv2} = $paycvv
5252 my $paystart_month = exists($options{'paystart_month'})
5253 ? $options{'paystart_month'}
5254 : $self->paystart_month;
5256 my $paystart_year = exists($options{'paystart_year'})
5257 ? $options{'paystart_year'}
5258 : $self->paystart_year;
5260 $content{card_start} = "$paystart_month/$paystart_year"
5261 if $paystart_month && $paystart_year;
5263 my $payissue = exists($options{'payissue'})
5264 ? $options{'payissue'}
5266 $content{issue_number} = $payissue if $payissue;
5268 if ( $self->_bop_recurring_billing( 'payinfo' => $options{'payinfo'},
5269 'trans_is_recur' => $trans_is_recur,
5273 $content{recurring_billing} = 'YES';
5274 $content{acct_code} = 'rebill'
5275 if $conf->exists('credit_card-recurring_billing_acct_code');
5278 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'ECHECK' ){
5279 ( $content{account_number}, $content{routing_code} ) =
5280 split('@', $options{payinfo});
5281 $content{bank_name} = $options{payname};
5282 $content{bank_state} = exists($options{'paystate'})
5283 ? $options{'paystate'}
5284 : $self->getfield('paystate');
5285 $content{account_type} = exists($options{'paytype'})
5286 ? uc($options{'paytype'}) || 'CHECKING'
5287 : uc($self->getfield('paytype')) || 'CHECKING';
5288 $content{customer_org} = $self->company ? 'B' : 'I';
5289 $content{state_id} = exists($options{'stateid'})
5290 ? $options{'stateid'}
5291 : $self->getfield('stateid');
5292 $content{state_id_state} = exists($options{'stateid_state'})
5293 ? $options{'stateid_state'}
5294 : $self->getfield('stateid_state');
5295 $content{customer_ssn} = exists($options{'ss'})
5298 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'LEC' ) {
5299 $content{phone} = $options{payinfo};
5300 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5307 # run transaction(s)
5310 my $balance = exists( $options{'balance'} )
5311 ? $options{'balance'}
5314 $self->select_for_update; #mutex ... just until we get our pending record in
5316 #the checks here are intended to catch concurrent payments
5317 #double-form-submission prevention is taken care of in cust_pay_pending::check
5320 return "The customer's balance has changed; $options{method} transaction aborted."
5321 if $self->balance < $balance;
5322 #&& $self->balance < $options{amount}; #might as well anyway?
5324 #also check and make sure there aren't *other* pending payments for this cust
5326 my @pending = qsearch('cust_pay_pending', {
5327 'custnum' => $self->custnum,
5328 'status' => { op=>'!=', value=>'done' }
5330 return "A payment is already being processed for this customer (".
5331 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
5332 "); $options{method} transaction aborted."
5333 if scalar(@pending);
5335 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
5337 my $cust_pay_pending = new FS::cust_pay_pending {
5338 'custnum' => $self->custnum,
5339 #'invnum' => $options{'invnum'},
5340 'paid' => $options{amount},
5342 'payby' => $bop_method2payby{$options{method}},
5343 'payinfo' => $options{payinfo},
5344 'paydate' => $paydate,
5345 'recurring_billing' => $content{recurring_billing},
5346 'pkgnum' => $options{'pkgnum'},
5348 'gatewaynum' => $payment_gateway->gatewaynum || '',
5349 'session_id' => $options{session_id} || '',
5350 'jobnum' => $options{depend_jobnum} || '',
5352 $cust_pay_pending->payunique( $options{payunique} )
5353 if defined($options{payunique}) && length($options{payunique});
5354 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
5355 return $cpp_new_err if $cpp_new_err;
5357 my( $action1, $action2 ) =
5358 split( /\s*\,\s*/, $payment_gateway->gateway_action );
5360 my $transaction = new $namespace( $payment_gateway->gateway_module,
5361 $self->_bop_options(\%options),
5364 $transaction->content(
5365 'type' => $options{method},
5366 $self->_bop_auth(\%options),
5367 'action' => $action1,
5368 'description' => $options{'description'},
5369 'amount' => $options{amount},
5370 #'invoice_number' => $options{'invnum'},
5371 'customer_id' => $self->custnum,
5373 'reference' => $cust_pay_pending->paypendingnum, #for now
5378 $cust_pay_pending->status('pending');
5379 my $cpp_pending_err = $cust_pay_pending->replace;
5380 return $cpp_pending_err if $cpp_pending_err;
5383 my $BOP_TESTING = 0;
5384 my $BOP_TESTING_SUCCESS = 1;
5386 unless ( $BOP_TESTING ) {
5387 $transaction->submit();
5389 if ( $BOP_TESTING_SUCCESS ) {
5390 $transaction->is_success(1);
5391 $transaction->authorization('fake auth');
5393 $transaction->is_success(0);
5394 $transaction->error_message('fake failure');
5398 if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5400 return { reference => $cust_pay_pending->paypendingnum,
5401 map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
5403 } elsif ( $transaction->is_success() && $action2 ) {
5405 $cust_pay_pending->status('authorized');
5406 my $cpp_authorized_err = $cust_pay_pending->replace;
5407 return $cpp_authorized_err if $cpp_authorized_err;
5409 my $auth = $transaction->authorization;
5410 my $ordernum = $transaction->can('order_number')
5411 ? $transaction->order_number
5415 new Business::OnlinePayment( $payment_gateway->gateway_module,
5416 $self->_bop_options(\%options),
5421 type => $options{method},
5423 $self->_bop_auth(\%options),
5424 order_number => $ordernum,
5425 amount => $options{amount},
5426 authorization => $auth,
5427 description => $options{'description'},
5430 foreach my $field (qw( authorization_source_code returned_ACI
5431 transaction_identifier validation_code
5432 transaction_sequence_num local_transaction_date
5433 local_transaction_time AVS_result_code )) {
5434 $capture{$field} = $transaction->$field() if $transaction->can($field);
5437 $capture->content( %capture );
5441 unless ( $capture->is_success ) {
5442 my $e = "Authorization successful but capture failed, custnum #".
5443 $self->custnum. ': '. $capture->result_code.
5444 ": ". $capture->error_message;
5452 # remove paycvv after initial transaction
5455 #false laziness w/misc/process/payment.cgi - check both to make sure working
5457 if ( defined $self->dbdef_table->column('paycvv')
5458 && length($self->paycvv)
5459 && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
5461 my $error = $self->remove_cvv;
5463 warn "WARNING: error removing cvv: $error\n";
5471 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5483 if (ref($_[0]) eq 'HASH') {
5484 %options = %{$_[0]};
5486 my ( $method, $amount ) = ( shift, shift );
5488 $options{method} = $method;
5489 $options{amount} = $amount;
5492 if ( $options{'fake_failure'} ) {
5493 return "Error: No error; test failure requested with fake_failure";
5497 #if ( $payment_gateway->gatewaynum ) { # agent override
5498 # $paybatch = $payment_gateway->gatewaynum. '-';
5501 #$paybatch .= "$processor:". $transaction->authorization;
5503 #$paybatch .= ':'. $transaction->order_number
5504 # if $transaction->can('order_number')
5505 # && length($transaction->order_number);
5507 my $paybatch = 'FakeProcessor:54:32';
5509 my $cust_pay = new FS::cust_pay ( {
5510 'custnum' => $self->custnum,
5511 'invnum' => $options{'invnum'},
5512 'paid' => $options{amount},
5514 'payby' => $bop_method2payby{$options{method}},
5515 #'payinfo' => $payinfo,
5516 'payinfo' => '4111111111111111',
5517 'paybatch' => $paybatch,
5518 #'paydate' => $paydate,
5519 'paydate' => '2012-05-01',
5521 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
5523 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5526 $cust_pay->invnum(''); #try again with no specific invnum
5527 my $error2 = $cust_pay->insert( $options{'manual'} ?
5528 ( 'manual' => 1 ) : ()
5531 # gah, even with transactions.
5532 my $e = 'WARNING: Card/ACH debited but database not updated - '.
5533 "error inserting (fake!) payment: $error2".
5534 " (previously tried insert with invnum #$options{'invnum'}" .
5541 if ( $options{'paynum_ref'} ) {
5542 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5545 return ''; #no error
5550 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
5552 # Wraps up processing of a realtime credit card, ACH (electronic check) or
5553 # phone bill transaction.
5555 sub _realtime_bop_result {
5556 my( $self, $cust_pay_pending, $transaction, %options ) = @_;
5558 warn "$me _realtime_bop_result: pending transaction ".
5559 $cust_pay_pending->paypendingnum. "\n";
5560 warn " $_ => $options{$_}\n" foreach keys %options;
5563 my $payment_gateway = $options{payment_gateway}
5564 or return "no payment gateway in arguments to _realtime_bop_result";
5566 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
5567 my $cpp_captured_err = $cust_pay_pending->replace;
5568 return $cpp_captured_err if $cpp_captured_err;
5570 if ( $transaction->is_success() ) {
5573 if ( $payment_gateway->gatewaynum ) { # agent override
5574 $paybatch = $payment_gateway->gatewaynum. '-';
5577 $paybatch .= $payment_gateway->gateway_module. ":".
5578 $transaction->authorization;
5580 $paybatch .= ':'. $transaction->order_number
5581 if $transaction->can('order_number')
5582 && length($transaction->order_number);
5584 my $cust_pay = new FS::cust_pay ( {
5585 'custnum' => $self->custnum,
5586 'invnum' => $options{'invnum'},
5587 'paid' => $cust_pay_pending->paid,
5589 'payby' => $cust_pay_pending->payby,
5590 #'payinfo' => $payinfo,
5591 'paybatch' => $paybatch,
5592 'paydate' => $cust_pay_pending->paydate,
5593 'pkgnum' => $cust_pay_pending->pkgnum,
5595 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
5596 $cust_pay->payunique( $options{payunique} )
5597 if defined($options{payunique}) && length($options{payunique});
5599 my $oldAutoCommit = $FS::UID::AutoCommit;
5600 local $FS::UID::AutoCommit = 0;
5603 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
5605 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5608 $cust_pay->invnum(''); #try again with no specific invnum
5609 my $error2 = $cust_pay->insert( $options{'manual'} ?
5610 ( 'manual' => 1 ) : ()
5613 # gah. but at least we have a record of the state we had to abort in
5614 # from cust_pay_pending now.
5615 my $e = "WARNING: $options{method} captured but payment not recorded -".
5616 " error inserting payment (". $payment_gateway->gateway_module.
5618 " (previously tried insert with invnum #$options{'invnum'}" .
5619 ": $error ) - pending payment saved as paypendingnum ".
5620 $cust_pay_pending->paypendingnum. "\n";
5626 my $jobnum = $cust_pay_pending->jobnum;
5628 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5630 unless ( $placeholder ) {
5631 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5632 my $e = "WARNING: $options{method} captured but job $jobnum not ".
5633 "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
5638 $error = $placeholder->delete;
5641 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5642 my $e = "WARNING: $options{method} captured but could not delete ".
5643 "job $jobnum for paypendingnum ".
5644 $cust_pay_pending->paypendingnum. ": $error\n";
5651 if ( $options{'paynum_ref'} ) {
5652 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5655 $cust_pay_pending->status('done');
5656 $cust_pay_pending->statustext('captured');
5657 $cust_pay_pending->paynum($cust_pay->paynum);
5658 my $cpp_done_err = $cust_pay_pending->replace;
5660 if ( $cpp_done_err ) {
5662 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5663 my $e = "WARNING: $options{method} captured but payment not recorded - ".
5664 "error updating status for paypendingnum ".
5665 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5671 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5673 if ( $options{'apply'} ) {
5674 my $apply_error = $self->apply_payments_and_credits;
5675 if ( $apply_error ) {
5676 warn "WARNING: error applying payment: $apply_error\n";
5677 #but we still should return no error cause the payment otherwise went
5682 return ''; #no error
5688 my $perror = $payment_gateway->gateway_module. " error: ".
5689 $transaction->error_message;
5691 my $jobnum = $cust_pay_pending->jobnum;
5693 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5695 if ( $placeholder ) {
5696 my $error = $placeholder->depended_delete;
5697 $error ||= $placeholder->delete;
5698 warn "error removing provisioning jobs after declined paypendingnum ".
5699 $cust_pay_pending->paypendingnum. "\n";
5701 my $e = "error finding job $jobnum for declined paypendingnum ".
5702 $cust_pay_pending->paypendingnum. "\n";
5708 unless ( $transaction->error_message ) {
5711 if ( $transaction->can('response_page') ) {
5713 'page' => ( $transaction->can('response_page')
5714 ? $transaction->response_page
5717 'code' => ( $transaction->can('response_code')
5718 ? $transaction->response_code
5721 'headers' => ( $transaction->can('response_headers')
5722 ? $transaction->response_headers
5728 "No additional debugging information available for ".
5729 $payment_gateway->gateway_module;
5732 $perror .= "No error_message returned from ".
5733 $payment_gateway->gateway_module. " -- ".
5734 ( ref($t_response) ? Dumper($t_response) : $t_response );
5738 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
5739 && $conf->exists('emaildecline')
5740 && grep { $_ ne 'POST' } $self->invoicing_list
5741 && ! grep { $transaction->error_message =~ /$_/ }
5742 $conf->config('emaildecline-exclude')
5744 my @templ = $conf->config('declinetemplate');
5745 my $template = new Text::Template (
5747 SOURCE => [ map "$_\n", @templ ],
5748 ) or return "($perror) can't create template: $Text::Template::ERROR";
5749 $template->compile()
5750 or return "($perror) can't compile template: $Text::Template::ERROR";
5754 scalar( $conf->config('company_name', $self->agentnum ) ),
5755 'company_address' =>
5756 join("\n", $conf->config('company_address', $self->agentnum ) ),
5757 'error' => $transaction->error_message,
5760 my $error = send_email(
5761 'from' => $conf->config('invoice_from', $self->agentnum ),
5762 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
5763 'subject' => 'Your payment could not be processed',
5764 'body' => [ $template->fill_in(HASH => $templ_hash) ],
5767 $perror .= " (also received error sending decline notification: $error)"
5772 $cust_pay_pending->status('done');
5773 $cust_pay_pending->statustext("declined: $perror");
5774 my $cpp_done_err = $cust_pay_pending->replace;
5775 if ( $cpp_done_err ) {
5776 my $e = "WARNING: $options{method} declined but pending payment not ".
5777 "resolved - error updating status for paypendingnum ".
5778 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5780 $perror = "$e ($perror)";
5788 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
5790 Verifies successful third party processing of a realtime credit card,
5791 ACH (electronic check) or phone bill transaction via a
5792 Business::OnlineThirdPartyPayment realtime gateway. See
5793 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5795 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
5797 The additional options I<payname>, I<city>, I<state>,
5798 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5799 if set, will override the value from the customer record.
5801 I<description> is a free-text field passed to the gateway. It defaults to
5802 "Internet services".
5804 If an I<invnum> is specified, this payment (if successful) is applied to the
5805 specified invoice. If you don't specify an I<invnum> you might want to
5806 call the B<apply_payments> method.
5808 I<quiet> can be set true to surpress email decline notices.
5810 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5811 resulting paynum, if any.
5813 I<payunique> is a unique identifier for this payment.
5815 Returns a hashref containing elements bill_error (which will be undefined
5816 upon success) and session_id of any associated session.
5820 sub realtime_botpp_capture {
5821 my( $self, $cust_pay_pending, %options ) = @_;
5823 warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
5824 warn " $_ => $options{$_}\n" foreach keys %options;
5827 eval "use Business::OnlineThirdPartyPayment";
5831 # select the gateway
5834 my $method = FS::payby->payby2bop($cust_pay_pending->payby);
5836 my $payment_gateway = $cust_pay_pending->gatewaynum
5837 ? qsearchs( 'payment_gateway',
5838 { gatewaynum => $cust_pay_pending->gatewaynum }
5840 : $self->agent->payment_gateway( 'method' => $method,
5841 # 'invnum' => $cust_pay_pending->invnum,
5842 # 'payinfo' => $cust_pay_pending->payinfo,
5845 $options{payment_gateway} = $payment_gateway; # for the helper subs
5851 my @invoicing_list = $self->invoicing_list_emailonly;
5852 if ( $conf->exists('emailinvoiceautoalways')
5853 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5854 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5855 push @invoicing_list, $self->all_emails;
5858 my $email = ($conf->exists('business-onlinepayment-email-override'))
5859 ? $conf->config('business-onlinepayment-email-override')
5860 : $invoicing_list[0];
5864 $content{email_customer} =
5865 ( $conf->exists('business-onlinepayment-email_customer')
5866 || $conf->exists('business-onlinepayment-email-override') );
5869 # run transaction(s)
5873 new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
5874 $self->_bop_options(\%options),
5877 $transaction->reference({ %options });
5879 $transaction->content(
5881 $self->_bop_auth(\%options),
5882 'action' => 'Post Authorization',
5883 'description' => $options{'description'},
5884 'amount' => $cust_pay_pending->paid,
5885 #'invoice_number' => $options{'invnum'},
5886 'customer_id' => $self->custnum,
5887 'referer' => 'http://cleanwhisker.420.am/',
5888 'reference' => $cust_pay_pending->paypendingnum,
5890 'phone' => $self->daytime || $self->night,
5892 # plus whatever is required for bogus capture avoidance
5895 $transaction->submit();
5898 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5901 bill_error => $error,
5902 session_id => $cust_pay_pending->session_id,
5907 =item default_payment_gateway DEPRECATED -- use agent->payment_gateway
5911 sub default_payment_gateway {
5912 my( $self, $method ) = @_;
5914 die "Real-time processing not enabled\n"
5915 unless $conf->exists('business-onlinepayment');
5917 #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
5920 my $bop_config = 'business-onlinepayment';
5921 $bop_config .= '-ach'
5922 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
5923 my ( $processor, $login, $password, $action, @bop_options ) =
5924 $conf->config($bop_config);
5925 $action ||= 'normal authorization';
5926 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
5927 die "No real-time processor is enabled - ".
5928 "did you set the business-onlinepayment configuration value?\n"
5931 ( $processor, $login, $password, $action, @bop_options )
5936 Removes the I<paycvv> field from the database directly.
5938 If there is an error, returns the error, otherwise returns false.
5944 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
5945 or return dbh->errstr;
5946 $sth->execute($self->custnum)
5947 or return $sth->errstr;
5952 =item _new_realtime_refund_bop METHOD [ OPTION => VALUE ... ]
5954 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
5955 via a Business::OnlinePayment realtime gateway. See
5956 L<http://420.am/business-onlinepayment> for supported gateways.
5958 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5960 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
5962 Most gateways require a reference to an original payment transaction to refund,
5963 so you probably need to specify a I<paynum>.
5965 I<amount> defaults to the original amount of the payment if not specified.
5967 I<reason> specifies a reason for the refund.
5969 I<paydate> specifies the expiration date for a credit card overriding the
5970 value from the customer record or the payment record. Specified as yyyy-mm-dd
5972 Implementation note: If I<amount> is unspecified or equal to the amount of the
5973 orignal payment, first an attempt is made to "void" the transaction via
5974 the gateway (to cancel a not-yet settled transaction) and then if that fails,
5975 the normal attempt is made to "refund" ("credit") the transaction via the
5976 gateway is attempted.
5978 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5979 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5980 #if set, will override the value from the customer record.
5982 #If an I<invnum> is specified, this payment (if successful) is applied to the
5983 #specified invoice. If you don't specify an I<invnum> you might want to
5984 #call the B<apply_payments> method.
5988 #some false laziness w/realtime_bop, not enough to make it worth merging
5989 #but some useful small subs should be pulled out
5990 sub _new_realtime_refund_bop {
5994 if (ref($_[0]) ne 'HASH') {
5995 %options = %{$_[0]};
5999 $options{method} = $method;
6003 warn "$me realtime_refund_bop (new): $options{method} refund\n";
6004 warn " $_ => $options{$_}\n" foreach keys %options;
6008 # look up the original payment and optionally a gateway for that payment
6012 my $amount = $options{'amount'};
6014 my( $processor, $login, $password, @bop_options, $namespace ) ;
6015 my( $auth, $order_number ) = ( '', '', '' );
6017 if ( $options{'paynum'} ) {
6019 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
6020 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
6021 or return "Unknown paynum $options{'paynum'}";
6022 $amount ||= $cust_pay->paid;
6024 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
6025 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
6026 $cust_pay->paybatch;
6027 my $gatewaynum = '';
6028 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
6030 if ( $gatewaynum ) { #gateway for the payment to be refunded
6032 my $payment_gateway =
6033 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
6034 die "payment gateway $gatewaynum not found"
6035 unless $payment_gateway;
6037 $processor = $payment_gateway->gateway_module;
6038 $login = $payment_gateway->gateway_username;
6039 $password = $payment_gateway->gateway_password;
6040 $namespace = $payment_gateway->gateway_namespace;
6041 @bop_options = $payment_gateway->options;
6043 } else { #try the default gateway
6046 my $payment_gateway =
6047 $self->agent->payment_gateway('method' => $options{method});
6049 ( $conf_processor, $login, $password, $namespace ) =
6050 map { my $method = "gateway_$_"; $payment_gateway->$method }
6051 qw( module username password namespace );
6053 @bop_options = $payment_gateway->gatewaynum
6054 ? $payment_gateway->options
6055 : @{ $payment_gateway->get('options') };
6057 return "processor of payment $options{'paynum'} $processor does not".
6058 " match default processor $conf_processor"
6059 unless $processor eq $conf_processor;
6064 } else { # didn't specify a paynum, so look for agent gateway overrides
6065 # like a normal transaction
6067 my $payment_gateway =
6068 $self->agent->payment_gateway( 'method' => $options{method},
6069 #'payinfo' => $payinfo,
6071 my( $processor, $login, $password, $namespace ) =
6072 map { my $method = "gateway_$_"; $payment_gateway->$method }
6073 qw( module username password namespace );
6075 my @bop_options = $payment_gateway->gatewaynum
6076 ? $payment_gateway->options
6077 : @{ $payment_gateway->get('options') };
6080 return "neither amount nor paynum specified" unless $amount;
6082 eval "use $namespace";
6086 'type' => $options{method},
6088 'password' => $password,
6089 'order_number' => $order_number,
6090 'amount' => $amount,
6091 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
6093 $content{authorization} = $auth
6094 if length($auth); #echeck/ACH transactions have an order # but no auth
6095 #(at least with authorize.net)
6097 my $disable_void_after;
6098 if ($conf->exists('disable_void_after')
6099 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
6100 $disable_void_after = $1;
6103 #first try void if applicable
6104 if ( $cust_pay && $cust_pay->paid == $amount
6106 ( not defined($disable_void_after) )
6107 || ( time < ($cust_pay->_date + $disable_void_after ) )
6110 warn " attempting void\n" if $DEBUG > 1;
6111 my $void = new Business::OnlinePayment( $processor, @bop_options );
6112 $content{'card_number'} = $cust_pay->payinfo
6113 if $cust_pay->payby eq 'CARD'
6114 && $void->can('info') && $void->info('CC_void_requires_card');
6115 $void->content( 'action' => 'void', %content );
6117 if ( $void->is_success ) {
6118 my $error = $cust_pay->void($options{'reason'});
6120 # gah, even with transactions.
6121 my $e = 'WARNING: Card/ACH voided but database not updated - '.
6122 "error voiding payment: $error";
6126 warn " void successful\n" if $DEBUG > 1;
6131 warn " void unsuccessful, trying refund\n"
6135 my $address = $self->address1;
6136 $address .= ", ". $self->address2 if $self->address2;
6138 my($payname, $payfirst, $paylast);
6139 if ( $self->payname && $options{method} ne 'ECHECK' ) {
6140 $payname = $self->payname;
6141 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
6142 or return "Illegal payname $payname";
6143 ($payfirst, $paylast) = ($1, $2);
6145 $payfirst = $self->getfield('first');
6146 $paylast = $self->getfield('last');
6147 $payname = "$payfirst $paylast";
6150 my @invoicing_list = $self->invoicing_list_emailonly;
6151 if ( $conf->exists('emailinvoiceautoalways')
6152 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
6153 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
6154 push @invoicing_list, $self->all_emails;
6157 my $email = ($conf->exists('business-onlinepayment-email-override'))
6158 ? $conf->config('business-onlinepayment-email-override')
6159 : $invoicing_list[0];
6161 my $payip = exists($options{'payip'})
6164 $content{customer_ip} = $payip
6168 if ( $options{method} eq 'CC' ) {
6171 $content{card_number} = $payinfo = $cust_pay->payinfo;
6172 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
6173 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
6174 ($content{expiration} = "$2/$1"); # where available
6176 $content{card_number} = $payinfo = $self->payinfo;
6177 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
6178 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
6179 $content{expiration} = "$2/$1";
6182 } elsif ( $options{method} eq 'ECHECK' ) {
6185 $payinfo = $cust_pay->payinfo;
6187 $payinfo = $self->payinfo;
6189 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
6190 $content{bank_name} = $self->payname;
6191 $content{account_type} = 'CHECKING';
6192 $content{account_name} = $payname;
6193 $content{customer_org} = $self->company ? 'B' : 'I';
6194 $content{customer_ssn} = $self->ss;
6195 } elsif ( $options{method} eq 'LEC' ) {
6196 $content{phone} = $payinfo = $self->payinfo;
6200 my $refund = new Business::OnlinePayment( $processor, @bop_options );
6201 my %sub_content = $refund->content(
6202 'action' => 'credit',
6203 'customer_id' => $self->custnum,
6204 'last_name' => $paylast,
6205 'first_name' => $payfirst,
6207 'address' => $address,
6208 'city' => $self->city,
6209 'state' => $self->state,
6210 'zip' => $self->zip,
6211 'country' => $self->country,
6213 'phone' => $self->daytime || $self->night,
6216 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
6220 return "$processor error: ". $refund->error_message
6221 unless $refund->is_success();
6223 my $paybatch = "$processor:". $refund->authorization;
6224 $paybatch .= ':'. $refund->order_number
6225 if $refund->can('order_number') && $refund->order_number;
6227 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
6228 my @cust_bill_pay = $cust_pay->cust_bill_pay;
6229 last unless @cust_bill_pay;
6230 my $cust_bill_pay = pop @cust_bill_pay;
6231 my $error = $cust_bill_pay->delete;
6235 my $cust_refund = new FS::cust_refund ( {
6236 'custnum' => $self->custnum,
6237 'paynum' => $options{'paynum'},
6238 'refund' => $amount,
6240 'payby' => $bop_method2payby{$options{method}},
6241 'payinfo' => $payinfo,
6242 'paybatch' => $paybatch,
6243 'reason' => $options{'reason'} || 'card or ACH refund',
6245 my $error = $cust_refund->insert;
6247 $cust_refund->paynum(''); #try again with no specific paynum
6248 my $error2 = $cust_refund->insert;
6250 # gah, even with transactions.
6251 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
6252 "error inserting refund ($processor): $error2".
6253 " (previously tried insert with paynum #$options{'paynum'}" .
6264 =item batch_card OPTION => VALUE...
6266 Adds a payment for this invoice to the pending credit card batch (see
6267 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
6268 runs the payment using a realtime gateway.
6273 my ($self, %options) = @_;
6276 if (exists($options{amount})) {
6277 $amount = $options{amount};
6279 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
6281 return '' unless $amount > 0;
6283 my $invnum = delete $options{invnum};
6284 my $payby = $options{invnum} || $self->payby; #dubious
6286 if ($options{'realtime'}) {
6287 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
6293 my $oldAutoCommit = $FS::UID::AutoCommit;
6294 local $FS::UID::AutoCommit = 0;
6297 #this needs to handle mysql as well as Pg, like svc_acct.pm
6298 #(make it into a common function if folks need to do batching with mysql)
6299 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
6300 or return "Cannot lock pay_batch: " . $dbh->errstr;
6304 'payby' => FS::payby->payby2payment($payby),
6307 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
6309 unless ( $pay_batch ) {
6310 $pay_batch = new FS::pay_batch \%pay_batch;
6311 my $error = $pay_batch->insert;
6313 $dbh->rollback if $oldAutoCommit;
6314 die "error creating new batch: $error\n";
6318 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
6319 'batchnum' => $pay_batch->batchnum,
6320 'custnum' => $self->custnum,
6323 foreach (qw( address1 address2 city state zip country payby payinfo paydate
6325 $options{$_} = '' unless exists($options{$_});
6328 my $cust_pay_batch = new FS::cust_pay_batch ( {
6329 'batchnum' => $pay_batch->batchnum,
6330 'invnum' => $invnum || 0, # is there a better value?
6331 # this field should be
6333 # cust_bill_pay_batch now
6334 'custnum' => $self->custnum,
6335 'last' => $self->getfield('last'),
6336 'first' => $self->getfield('first'),
6337 'address1' => $options{address1} || $self->address1,
6338 'address2' => $options{address2} || $self->address2,
6339 'city' => $options{city} || $self->city,
6340 'state' => $options{state} || $self->state,
6341 'zip' => $options{zip} || $self->zip,
6342 'country' => $options{country} || $self->country,
6343 'payby' => $options{payby} || $self->payby,
6344 'payinfo' => $options{payinfo} || $self->payinfo,
6345 'exp' => $options{paydate} || $self->paydate,
6346 'payname' => $options{payname} || $self->payname,
6347 'amount' => $amount, # consolidating
6350 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
6351 if $old_cust_pay_batch;
6354 if ($old_cust_pay_batch) {
6355 $error = $cust_pay_batch->replace($old_cust_pay_batch)
6357 $error = $cust_pay_batch->insert;
6361 $dbh->rollback if $oldAutoCommit;
6365 my $unapplied = $self->total_unapplied_credits
6366 + $self->total_unapplied_payments
6367 + $self->in_transit_payments;
6368 foreach my $cust_bill ($self->open_cust_bill) {
6369 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
6370 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
6371 'invnum' => $cust_bill->invnum,
6372 'paybatchnum' => $cust_pay_batch->paybatchnum,
6373 'amount' => $cust_bill->owed,
6376 if ($unapplied >= $cust_bill_pay_batch->amount){
6377 $unapplied -= $cust_bill_pay_batch->amount;
6380 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
6381 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
6383 $error = $cust_bill_pay_batch->insert;
6385 $dbh->rollback if $oldAutoCommit;
6390 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6394 =item apply_payments_and_credits [ OPTION => VALUE ... ]
6396 Applies unapplied payments and credits.
6398 In most cases, this new method should be used in place of sequential
6399 apply_payments and apply_credits methods.
6401 A hash of optional arguments may be passed. Currently "manual" is supported.
6402 If true, a payment receipt is sent instead of a statement when
6403 'payment_receipt_email' configuration option is set.
6405 If there is an error, returns the error, otherwise returns false.
6409 sub apply_payments_and_credits {
6410 my( $self, %options ) = @_;
6412 local $SIG{HUP} = 'IGNORE';
6413 local $SIG{INT} = 'IGNORE';
6414 local $SIG{QUIT} = 'IGNORE';
6415 local $SIG{TERM} = 'IGNORE';
6416 local $SIG{TSTP} = 'IGNORE';
6417 local $SIG{PIPE} = 'IGNORE';
6419 my $oldAutoCommit = $FS::UID::AutoCommit;
6420 local $FS::UID::AutoCommit = 0;
6423 $self->select_for_update; #mutex
6425 foreach my $cust_bill ( $self->open_cust_bill ) {
6426 my $error = $cust_bill->apply_payments_and_credits(%options);
6428 $dbh->rollback if $oldAutoCommit;
6429 return "Error applying: $error";
6433 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6438 =item apply_credits OPTION => VALUE ...
6440 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
6441 to outstanding invoice balances in chronological order (or reverse
6442 chronological order if the I<order> option is set to B<newest>) and returns the
6443 value of any remaining unapplied credits available for refund (see
6444 L<FS::cust_refund>).
6446 Dies if there is an error.
6454 local $SIG{HUP} = 'IGNORE';
6455 local $SIG{INT} = 'IGNORE';
6456 local $SIG{QUIT} = 'IGNORE';
6457 local $SIG{TERM} = 'IGNORE';
6458 local $SIG{TSTP} = 'IGNORE';
6459 local $SIG{PIPE} = 'IGNORE';
6461 my $oldAutoCommit = $FS::UID::AutoCommit;
6462 local $FS::UID::AutoCommit = 0;
6465 $self->select_for_update; #mutex
6467 unless ( $self->total_unapplied_credits ) {
6468 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6472 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
6473 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
6475 my @invoices = $self->open_cust_bill;
6476 @invoices = sort { $b->_date <=> $a->_date } @invoices
6477 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
6479 if ( $conf->exists('pkg-balances') ) {
6480 # limit @credits to those w/ a pkgnum grepped from $self
6482 foreach my $i (@invoices) {
6483 foreach my $li ( $i->cust_bill_pkg ) {
6484 $pkgnums{$li->pkgnum} = 1;
6487 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
6492 foreach my $cust_bill ( @invoices ) {
6494 if ( !defined($credit) || $credit->credited == 0) {
6495 $credit = pop @credits or last;
6499 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
6500 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
6502 $owed = $cust_bill->owed;
6504 unless ( $owed > 0 ) {
6505 push @credits, $credit;
6509 my $amount = min( $credit->credited, $owed );
6511 my $cust_credit_bill = new FS::cust_credit_bill ( {
6512 'crednum' => $credit->crednum,
6513 'invnum' => $cust_bill->invnum,
6514 'amount' => $amount,
6516 $cust_credit_bill->pkgnum( $credit->pkgnum )
6517 if $conf->exists('pkg-balances') && $credit->pkgnum;
6518 my $error = $cust_credit_bill->insert;
6520 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6524 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6528 my $total_unapplied_credits = $self->total_unapplied_credits;
6530 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6532 return $total_unapplied_credits;
6535 =item apply_payments [ OPTION => VALUE ... ]
6537 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
6538 to outstanding invoice balances in chronological order.
6540 #and returns the value of any remaining unapplied payments.
6542 A hash of optional arguments may be passed. Currently "manual" is supported.
6543 If true, a payment receipt is sent instead of a statement when
6544 'payment_receipt_email' configuration option is set.
6546 Dies if there is an error.
6550 sub apply_payments {
6551 my( $self, %options ) = @_;
6553 local $SIG{HUP} = 'IGNORE';
6554 local $SIG{INT} = 'IGNORE';
6555 local $SIG{QUIT} = 'IGNORE';
6556 local $SIG{TERM} = 'IGNORE';
6557 local $SIG{TSTP} = 'IGNORE';
6558 local $SIG{PIPE} = 'IGNORE';
6560 my $oldAutoCommit = $FS::UID::AutoCommit;
6561 local $FS::UID::AutoCommit = 0;
6564 $self->select_for_update; #mutex
6568 my @payments = sort { $b->_date <=> $a->_date }
6569 grep { $_->unapplied > 0 }
6572 my @invoices = sort { $a->_date <=> $b->_date}
6573 grep { $_->owed > 0 }
6576 if ( $conf->exists('pkg-balances') ) {
6577 # limit @payments to those w/ a pkgnum grepped from $self
6579 foreach my $i (@invoices) {
6580 foreach my $li ( $i->cust_bill_pkg ) {
6581 $pkgnums{$li->pkgnum} = 1;
6584 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
6589 foreach my $cust_bill ( @invoices ) {
6591 if ( !defined($payment) || $payment->unapplied == 0 ) {
6592 $payment = pop @payments or last;
6596 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
6597 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
6599 $owed = $cust_bill->owed;
6601 unless ( $owed > 0 ) {
6602 push @payments, $payment;
6606 my $amount = min( $payment->unapplied, $owed );
6608 my $cust_bill_pay = new FS::cust_bill_pay ( {
6609 'paynum' => $payment->paynum,
6610 'invnum' => $cust_bill->invnum,
6611 'amount' => $amount,
6613 $cust_bill_pay->pkgnum( $payment->pkgnum )
6614 if $conf->exists('pkg-balances') && $payment->pkgnum;
6615 my $error = $cust_bill_pay->insert(%options);
6617 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6621 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6625 my $total_unapplied_payments = $self->total_unapplied_payments;
6627 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6629 return $total_unapplied_payments;
6634 Returns the total owed for this customer on all invoices
6635 (see L<FS::cust_bill/owed>).
6641 $self->total_owed_date(2145859200); #12/31/2037
6644 =item total_owed_date TIME
6646 Returns the total owed for this customer on all invoices with date earlier than
6647 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6648 see L<Time::Local> and L<Date::Parse> for conversion functions.
6652 sub total_owed_date {
6656 # my $custnum = $self->custnum;
6658 # my $owed_sql = FS::cust_bill->owed_sql;
6661 # SELECT SUM($owed_sql) FROM cust_bill
6662 # WHERE custnum = $custnum
6663 # AND _date <= $time
6666 # my $sth = dbh->prepare($sql) or die dbh->errstr;
6667 # $sth->execute() or die $sth->errstr;
6669 # return sprintf( '%.2f', $sth->fetchrow_arrayref->[0] );
6672 foreach my $cust_bill (
6673 grep { $_->_date <= $time }
6674 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6676 $total_bill += $cust_bill->owed;
6678 sprintf( "%.2f", $total_bill );
6682 =item total_owed_pkgnum PKGNUM
6684 Returns the total owed on all invoices for this customer's specific package
6685 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
6689 sub total_owed_pkgnum {
6690 my( $self, $pkgnum ) = @_;
6691 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
6694 =item total_owed_date_pkgnum TIME PKGNUM
6696 Returns the total owed for this customer's specific package when using
6697 experimental package balances on all invoices with date earlier than
6698 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6699 see L<Time::Local> and L<Date::Parse> for conversion functions.
6703 sub total_owed_date_pkgnum {
6704 my( $self, $time, $pkgnum ) = @_;
6707 foreach my $cust_bill (
6708 grep { $_->_date <= $time }
6709 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6711 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
6713 sprintf( "%.2f", $total_bill );
6719 Returns the total amount of all payments.
6726 $total += $_->paid foreach $self->cust_pay;
6727 sprintf( "%.2f", $total );
6730 =item total_unapplied_credits
6732 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6733 customer. See L<FS::cust_credit/credited>.
6735 =item total_credited
6737 Old name for total_unapplied_credits. Don't use.
6741 sub total_credited {
6742 #carp "total_credited deprecated, use total_unapplied_credits";
6743 shift->total_unapplied_credits(@_);
6746 sub total_unapplied_credits {
6748 my $total_credit = 0;
6749 $total_credit += $_->credited foreach $self->cust_credit;
6750 sprintf( "%.2f", $total_credit );
6753 =item total_unapplied_credits_pkgnum PKGNUM
6755 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6756 customer. See L<FS::cust_credit/credited>.
6760 sub total_unapplied_credits_pkgnum {
6761 my( $self, $pkgnum ) = @_;
6762 my $total_credit = 0;
6763 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
6764 sprintf( "%.2f", $total_credit );
6768 =item total_unapplied_payments
6770 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
6771 See L<FS::cust_pay/unapplied>.
6775 sub total_unapplied_payments {
6777 my $total_unapplied = 0;
6778 $total_unapplied += $_->unapplied foreach $self->cust_pay;
6779 sprintf( "%.2f", $total_unapplied );
6782 =item total_unapplied_payments_pkgnum PKGNUM
6784 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
6785 specific package when using experimental package balances. See
6786 L<FS::cust_pay/unapplied>.
6790 sub total_unapplied_payments_pkgnum {
6791 my( $self, $pkgnum ) = @_;
6792 my $total_unapplied = 0;
6793 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
6794 sprintf( "%.2f", $total_unapplied );
6798 =item total_unapplied_refunds
6800 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
6801 customer. See L<FS::cust_refund/unapplied>.
6805 sub total_unapplied_refunds {
6807 my $total_unapplied = 0;
6808 $total_unapplied += $_->unapplied foreach $self->cust_refund;
6809 sprintf( "%.2f", $total_unapplied );
6814 Returns the balance for this customer (total_owed plus total_unrefunded, minus
6815 total_unapplied_credits minus total_unapplied_payments).
6823 + $self->total_unapplied_refunds
6824 - $self->total_unapplied_credits
6825 - $self->total_unapplied_payments
6829 =item balance_date TIME
6831 Returns the balance for this customer, only considering invoices with date
6832 earlier than TIME (total_owed_date minus total_credited minus
6833 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
6834 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
6843 $self->total_owed_date($time)
6844 + $self->total_unapplied_refunds
6845 - $self->total_unapplied_credits
6846 - $self->total_unapplied_payments
6850 =item balance_date_range START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
6852 Returns the balance for this customer, only considering invoices with date
6853 earlier than START_TIME, and optionally not later than END_TIME
6854 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
6856 Times are specified as SQL fragments or numeric
6857 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
6858 L<Date::Parse> for conversion functions. The empty string can be passed
6859 to disable that time constraint completely.
6861 Available options are:
6865 =item unapplied_date
6867 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)
6873 sub balance_date_range {
6875 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
6876 ') FROM cust_main WHERE custnum='. $self->custnum;
6877 sprintf( "%.2f", $self->scalar_sql($sql) );
6880 =item balance_pkgnum PKGNUM
6882 Returns the balance for this customer's specific package when using
6883 experimental package balances (total_owed plus total_unrefunded, minus
6884 total_unapplied_credits minus total_unapplied_payments)
6888 sub balance_pkgnum {
6889 my( $self, $pkgnum ) = @_;
6892 $self->total_owed_pkgnum($pkgnum)
6893 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
6894 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
6895 - $self->total_unapplied_credits_pkgnum($pkgnum)
6896 - $self->total_unapplied_payments_pkgnum($pkgnum)
6900 =item in_transit_payments
6902 Returns the total of requests for payments for this customer pending in
6903 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
6907 sub in_transit_payments {
6909 my $in_transit_payments = 0;
6910 foreach my $pay_batch ( qsearch('pay_batch', {
6913 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
6914 'batchnum' => $pay_batch->batchnum,
6915 'custnum' => $self->custnum,
6917 $in_transit_payments += $cust_pay_batch->amount;
6920 sprintf( "%.2f", $in_transit_payments );
6925 Returns a hash of useful information for making a payment.
6935 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
6936 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
6937 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
6941 For credit card transactions:
6953 For electronic check transactions:
6968 $return{balance} = $self->balance;
6970 $return{payname} = $self->payname
6971 || ( $self->first. ' '. $self->get('last') );
6973 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
6975 $return{payby} = $self->payby;
6976 $return{stateid_state} = $self->stateid_state;
6978 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
6979 $return{card_type} = cardtype($self->payinfo);
6980 $return{payinfo} = $self->paymask;
6982 @return{'month', 'year'} = $self->paydate_monthyear;
6986 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
6987 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
6988 $return{payinfo1} = $payinfo1;
6989 $return{payinfo2} = $payinfo2;
6990 $return{paytype} = $self->paytype;
6991 $return{paystate} = $self->paystate;
6995 #doubleclick protection
6997 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
7003 =item paydate_monthyear
7005 Returns a two-element list consisting of the month and year of this customer's
7006 paydate (credit card expiration date for CARD customers)
7010 sub paydate_monthyear {
7012 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
7014 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
7021 =item tax_exemption TAXNAME
7026 my( $self, $taxname ) = @_;
7028 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
7029 'taxname' => $taxname,
7034 =item cust_main_exemption
7038 sub cust_main_exemption {
7040 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
7043 =item invoicing_list [ ARRAYREF ]
7045 If an arguement is given, sets these email addresses as invoice recipients
7046 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
7047 (except as warnings), so use check_invoicing_list first.
7049 Returns a list of email addresses (with svcnum entries expanded).
7051 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
7052 check it without disturbing anything by passing nothing.
7054 This interface may change in the future.
7058 sub invoicing_list {
7059 my( $self, $arrayref ) = @_;
7062 my @cust_main_invoice;
7063 if ( $self->custnum ) {
7064 @cust_main_invoice =
7065 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7067 @cust_main_invoice = ();
7069 foreach my $cust_main_invoice ( @cust_main_invoice ) {
7070 #warn $cust_main_invoice->destnum;
7071 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
7072 #warn $cust_main_invoice->destnum;
7073 my $error = $cust_main_invoice->delete;
7074 warn $error if $error;
7077 if ( $self->custnum ) {
7078 @cust_main_invoice =
7079 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7081 @cust_main_invoice = ();
7083 my %seen = map { $_->address => 1 } @cust_main_invoice;
7084 foreach my $address ( @{$arrayref} ) {
7085 next if exists $seen{$address} && $seen{$address};
7086 $seen{$address} = 1;
7087 my $cust_main_invoice = new FS::cust_main_invoice ( {
7088 'custnum' => $self->custnum,
7091 my $error = $cust_main_invoice->insert;
7092 warn $error if $error;
7096 if ( $self->custnum ) {
7098 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7105 =item check_invoicing_list ARRAYREF
7107 Checks these arguements as valid input for the invoicing_list method. If there
7108 is an error, returns the error, otherwise returns false.
7112 sub check_invoicing_list {
7113 my( $self, $arrayref ) = @_;
7115 foreach my $address ( @$arrayref ) {
7117 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
7118 return 'Can\'t add FAX invoice destination with a blank FAX number.';
7121 my $cust_main_invoice = new FS::cust_main_invoice ( {
7122 'custnum' => $self->custnum,
7125 my $error = $self->custnum
7126 ? $cust_main_invoice->check
7127 : $cust_main_invoice->checkdest
7129 return $error if $error;
7133 return "Email address required"
7134 if $conf->exists('cust_main-require_invoicing_list_email')
7135 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
7140 =item set_default_invoicing_list
7142 Sets the invoicing list to all accounts associated with this customer,
7143 overwriting any previous invoicing list.
7147 sub set_default_invoicing_list {
7149 $self->invoicing_list($self->all_emails);
7154 Returns the email addresses of all accounts provisioned for this customer.
7161 foreach my $cust_pkg ( $self->all_pkgs ) {
7162 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
7164 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
7165 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
7167 $list{$_}=1 foreach map { $_->email } @svc_acct;
7172 =item invoicing_list_addpost
7174 Adds postal invoicing to this customer. If this customer is already configured
7175 to receive postal invoices, does nothing.
7179 sub invoicing_list_addpost {
7181 return if grep { $_ eq 'POST' } $self->invoicing_list;
7182 my @invoicing_list = $self->invoicing_list;
7183 push @invoicing_list, 'POST';
7184 $self->invoicing_list(\@invoicing_list);
7187 =item invoicing_list_emailonly
7189 Returns the list of email invoice recipients (invoicing_list without non-email
7190 destinations such as POST and FAX).
7194 sub invoicing_list_emailonly {
7196 warn "$me invoicing_list_emailonly called"
7198 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
7201 =item invoicing_list_emailonly_scalar
7203 Returns the list of email invoice recipients (invoicing_list without non-email
7204 destinations such as POST and FAX) as a comma-separated scalar.
7208 sub invoicing_list_emailonly_scalar {
7210 warn "$me invoicing_list_emailonly_scalar called"
7212 join(', ', $self->invoicing_list_emailonly);
7215 =item referral_custnum_cust_main
7217 Returns the customer who referred this customer (or the empty string, if
7218 this customer was not referred).
7220 Note the difference with referral_cust_main method: This method,
7221 referral_custnum_cust_main returns the single customer (if any) who referred
7222 this customer, while referral_cust_main returns an array of customers referred
7227 sub referral_custnum_cust_main {
7229 return '' unless $self->referral_custnum;
7230 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7233 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
7235 Returns an array of customers referred by this customer (referral_custnum set
7236 to this custnum). If DEPTH is given, recurses up to the given depth, returning
7237 customers referred by customers referred by this customer and so on, inclusive.
7238 The default behavior is DEPTH 1 (no recursion).
7240 Note the difference with referral_custnum_cust_main method: This method,
7241 referral_cust_main, returns an array of customers referred BY this customer,
7242 while referral_custnum_cust_main returns the single customer (if any) who
7243 referred this customer.
7247 sub referral_cust_main {
7249 my $depth = @_ ? shift : 1;
7250 my $exclude = @_ ? shift : {};
7253 map { $exclude->{$_->custnum}++; $_; }
7254 grep { ! $exclude->{ $_->custnum } }
7255 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
7259 map { $_->referral_cust_main($depth-1, $exclude) }
7266 =item referral_cust_main_ncancelled
7268 Same as referral_cust_main, except only returns customers with uncancelled
7273 sub referral_cust_main_ncancelled {
7275 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
7278 =item referral_cust_pkg [ DEPTH ]
7280 Like referral_cust_main, except returns a flat list of all unsuspended (and
7281 uncancelled) packages for each customer. The number of items in this list may
7282 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
7286 sub referral_cust_pkg {
7288 my $depth = @_ ? shift : 1;
7290 map { $_->unsuspended_pkgs }
7291 grep { $_->unsuspended_pkgs }
7292 $self->referral_cust_main($depth);
7295 =item referring_cust_main
7297 Returns the single cust_main record for the customer who referred this customer
7298 (referral_custnum), or false.
7302 sub referring_cust_main {
7304 return '' unless $self->referral_custnum;
7305 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7308 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
7310 Applies a credit to this customer. If there is an error, returns the error,
7311 otherwise returns false.
7313 REASON can be a text string, an FS::reason object, or a scalar reference to
7314 a reasonnum. If a text string, it will be automatically inserted as a new
7315 reason, and a 'reason_type' option must be passed to indicate the
7316 FS::reason_type for the new reason.
7318 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
7320 Any other options are passed to FS::cust_credit::insert.
7325 my( $self, $amount, $reason, %options ) = @_;
7327 my $cust_credit = new FS::cust_credit {
7328 'custnum' => $self->custnum,
7329 'amount' => $amount,
7332 if ( ref($reason) ) {
7334 if ( ref($reason) eq 'SCALAR' ) {
7335 $cust_credit->reasonnum( $$reason );
7337 $cust_credit->reasonnum( $reason->reasonnum );
7341 $cust_credit->set('reason', $reason)
7344 $cust_credit->addlinfo( delete $options{'addlinfo'} )
7345 if exists($options{'addlinfo'});
7347 $cust_credit->insert(%options);
7351 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
7353 Creates a one-time charge for this customer. If there is an error, returns
7354 the error, otherwise returns false.
7356 New-style, with a hashref of options:
7358 my $error = $cust_main->charge(
7362 'start_date' => str2time('7/4/2009'),
7363 'pkg' => 'Description',
7364 'comment' => 'Comment',
7365 'additional' => [], #extra invoice detail
7366 'classnum' => 1, #pkg_class
7368 'setuptax' => '', # or 'Y' for tax exempt
7371 'taxclass' => 'Tax class',
7374 'taxproduct' => 2, #part_pkg_taxproduct
7375 'override' => {}, #XXX describe
7377 #will be filled in with the new object
7378 'cust_pkg_ref' => \$cust_pkg,
7380 #generate an invoice immediately
7382 'invoice_terms' => '', #with these terms
7388 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
7394 my ( $amount, $quantity, $start_date, $classnum );
7395 my ( $pkg, $comment, $additional );
7396 my ( $setuptax, $taxclass ); #internal taxes
7397 my ( $taxproduct, $override ); #vendor (CCH) taxes
7398 my $cust_pkg_ref = '';
7399 my ( $bill_now, $invoice_terms ) = ( 0, '' );
7400 if ( ref( $_[0] ) ) {
7401 $amount = $_[0]->{amount};
7402 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
7403 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
7404 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
7405 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
7406 : '$'. sprintf("%.2f",$amount);
7407 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
7408 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
7409 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
7410 $additional = $_[0]->{additional} || [];
7411 $taxproduct = $_[0]->{taxproductnum};
7412 $override = { '' => $_[0]->{tax_override} };
7413 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
7414 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
7415 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
7420 $pkg = @_ ? shift : 'One-time charge';
7421 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
7423 $taxclass = @_ ? shift : '';
7427 local $SIG{HUP} = 'IGNORE';
7428 local $SIG{INT} = 'IGNORE';
7429 local $SIG{QUIT} = 'IGNORE';
7430 local $SIG{TERM} = 'IGNORE';
7431 local $SIG{TSTP} = 'IGNORE';
7432 local $SIG{PIPE} = 'IGNORE';
7434 my $oldAutoCommit = $FS::UID::AutoCommit;
7435 local $FS::UID::AutoCommit = 0;
7438 my $part_pkg = new FS::part_pkg ( {
7440 'comment' => $comment,
7444 'classnum' => $classnum ? $classnum : '',
7445 'setuptax' => $setuptax,
7446 'taxclass' => $taxclass,
7447 'taxproductnum' => $taxproduct,
7450 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
7451 ( 0 .. @$additional - 1 )
7453 'additional_count' => scalar(@$additional),
7454 'setup_fee' => $amount,
7457 my $error = $part_pkg->insert( options => \%options,
7458 tax_overrides => $override,
7461 $dbh->rollback if $oldAutoCommit;
7465 my $pkgpart = $part_pkg->pkgpart;
7466 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
7467 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
7468 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
7469 $error = $type_pkgs->insert;
7471 $dbh->rollback if $oldAutoCommit;
7476 my $cust_pkg = new FS::cust_pkg ( {
7477 'custnum' => $self->custnum,
7478 'pkgpart' => $pkgpart,
7479 'quantity' => $quantity,
7480 'start_date' => $start_date,
7483 $error = $cust_pkg->insert;
7485 $dbh->rollback if $oldAutoCommit;
7487 } elsif ( $cust_pkg_ref ) {
7488 ${$cust_pkg_ref} = $cust_pkg;
7492 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
7493 'pkg_list' => [ $cust_pkg ],
7496 $dbh->rollback if $oldAutoCommit;
7501 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
7506 #=item charge_postal_fee
7508 #Applies a one time charge this customer. If there is an error,
7509 #returns the error, returns the cust_pkg charge object or false
7510 #if there was no charge.
7514 # This should be a customer event. For that to work requires that bill
7515 # also be a customer event.
7517 sub charge_postal_fee {
7520 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
7521 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
7523 my $cust_pkg = new FS::cust_pkg ( {
7524 'custnum' => $self->custnum,
7525 'pkgpart' => $pkgpart,
7529 my $error = $cust_pkg->insert;
7530 $error ? $error : $cust_pkg;
7535 Returns all the invoices (see L<FS::cust_bill>) for this customer.
7541 map { $_ } #return $self->num_cust_bill unless wantarray;
7542 sort { $a->_date <=> $b->_date }
7543 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
7546 =item open_cust_bill
7548 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
7553 sub open_cust_bill {
7557 'table' => 'cust_bill',
7558 'hashref' => { 'custnum' => $self->custnum, },
7559 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
7560 'order_by' => 'ORDER BY _date ASC',
7565 =item cust_statements
7567 Returns all the statements (see L<FS::cust_statement>) for this customer.
7571 sub cust_statement {
7573 map { $_ } #return $self->num_cust_statement unless wantarray;
7574 sort { $a->_date <=> $b->_date }
7575 qsearch('cust_statement', { 'custnum' => $self->custnum, } )
7580 Returns all the credits (see L<FS::cust_credit>) for this customer.
7586 map { $_ } #return $self->num_cust_credit unless wantarray;
7587 sort { $a->_date <=> $b->_date }
7588 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
7591 =item cust_credit_pkgnum
7593 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
7594 package when using experimental package balances.
7598 sub cust_credit_pkgnum {
7599 my( $self, $pkgnum ) = @_;
7600 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
7601 sort { $a->_date <=> $b->_date }
7602 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
7603 'pkgnum' => $pkgnum,
7610 Returns all the payments (see L<FS::cust_pay>) for this customer.
7616 return $self->num_cust_pay unless wantarray;
7617 sort { $a->_date <=> $b->_date }
7618 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
7623 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
7624 called automatically when the cust_pay method is used in a scalar context.
7630 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
7631 my $sth = dbh->prepare($sql) or die dbh->errstr;
7632 $sth->execute($self->custnum) or die $sth->errstr;
7633 $sth->fetchrow_arrayref->[0];
7636 =item cust_pay_pkgnum
7638 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
7639 package when using experimental package balances.
7643 sub cust_pay_pkgnum {
7644 my( $self, $pkgnum ) = @_;
7645 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
7646 sort { $a->_date <=> $b->_date }
7647 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
7648 'pkgnum' => $pkgnum,
7655 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
7661 map { $_ } #return $self->num_cust_pay_void unless wantarray;
7662 sort { $a->_date <=> $b->_date }
7663 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
7666 =item cust_pay_batch
7668 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
7672 sub cust_pay_batch {
7674 map { $_ } #return $self->num_cust_pay_batch unless wantarray;
7675 sort { $a->paybatchnum <=> $b->paybatchnum }
7676 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
7679 =item cust_pay_pending
7681 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
7682 (without status "done").
7686 sub cust_pay_pending {
7688 return $self->num_cust_pay_pending unless wantarray;
7689 sort { $a->_date <=> $b->_date }
7690 qsearch( 'cust_pay_pending', {
7691 'custnum' => $self->custnum,
7692 'status' => { op=>'!=', value=>'done' },
7697 =item num_cust_pay_pending
7699 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
7700 customer (without status "done"). Also called automatically when the
7701 cust_pay_pending method is used in a scalar context.
7705 sub num_cust_pay_pending {
7707 my $sql = " SELECT COUNT(*) FROM cust_pay_pending ".
7708 " WHERE custnum = ? AND status != 'done' ";
7709 my $sth = dbh->prepare($sql) or die dbh->errstr;
7710 $sth->execute($self->custnum) or die $sth->errstr;
7711 $sth->fetchrow_arrayref->[0];
7716 Returns all the refunds (see L<FS::cust_refund>) for this customer.
7722 map { $_ } #return $self->num_cust_refund unless wantarray;
7723 sort { $a->_date <=> $b->_date }
7724 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
7727 =item display_custnum
7729 Returns the displayed customer number for this customer: agent_custid if
7730 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
7734 sub display_custnum {
7736 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
7737 return $self->agent_custid;
7739 return $self->custnum;
7745 Returns a name string for this customer, either "Company (Last, First)" or
7752 my $name = $self->contact;
7753 $name = $self->company. " ($name)" if $self->company;
7759 Returns a name string for this (service/shipping) contact, either
7760 "Company (Last, First)" or "Last, First".
7766 if ( $self->get('ship_last') ) {
7767 my $name = $self->ship_contact;
7768 $name = $self->ship_company. " ($name)" if $self->ship_company;
7777 Returns a name string for this customer, either "Company" or "First Last".
7783 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
7786 =item ship_name_short
7788 Returns a name string for this (service/shipping) contact, either "Company"
7793 sub ship_name_short {
7795 if ( $self->get('ship_last') ) {
7796 $self->ship_company !~ /^\s*$/
7797 ? $self->ship_company
7798 : $self->ship_contact_firstlast;
7800 $self->name_company_or_firstlast;
7806 Returns this customer's full (billing) contact name only, "Last, First"
7812 $self->get('last'). ', '. $self->first;
7817 Returns this customer's full (shipping) contact name only, "Last, First"
7823 $self->get('ship_last')
7824 ? $self->get('ship_last'). ', '. $self->ship_first
7828 =item contact_firstlast
7830 Returns this customers full (billing) contact name only, "First Last".
7834 sub contact_firstlast {
7836 $self->first. ' '. $self->get('last');
7839 =item ship_contact_firstlast
7841 Returns this customer's full (shipping) contact name only, "First Last".
7845 sub ship_contact_firstlast {
7847 $self->get('ship_last')
7848 ? $self->first. ' '. $self->get('ship_last')
7849 : $self->contact_firstlast;
7854 Returns this customer's full country name
7860 code2country($self->country);
7863 =item geocode DATA_VENDOR
7865 Returns a value for the customer location as encoded by DATA_VENDOR.
7866 Currently this only makes sense for "CCH" as DATA_VENDOR.
7871 my ($self, $data_vendor) = (shift, shift); #always cch for now
7873 my $geocode = $self->get('geocode'); #XXX only one data_vendor for geocode
7874 return $geocode if $geocode;
7876 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
7880 my($zip,$plus4) = split /-/, $self->get("${prefix}zip")
7881 if $self->country eq 'US';
7885 #CCH specific location stuff
7886 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
7888 my @cust_tax_location =
7890 'table' => 'cust_tax_location',
7891 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
7892 'extra_sql' => $extra_sql,
7893 'order_by' => 'ORDER BY plus4hi',#overlapping with distinct ends
7896 $geocode = $cust_tax_location[0]->geocode
7897 if scalar(@cust_tax_location);
7906 Returns a status string for this customer, currently:
7910 =item prospect - No packages have ever been ordered
7912 =item active - One or more recurring packages is active
7914 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
7916 =item suspended - All non-cancelled recurring packages are suspended
7918 =item cancelled - All recurring packages are cancelled
7924 sub status { shift->cust_status(@_); }
7928 for my $status (qw( prospect active inactive suspended cancelled )) {
7929 my $method = $status.'_sql';
7930 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
7931 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
7932 $sth->execute( ($self->custnum) x $numnum )
7933 or die "Error executing 'SELECT $sql': ". $sth->errstr;
7934 return $status if $sth->fetchrow_arrayref->[0];
7938 =item ucfirst_cust_status
7940 =item ucfirst_status
7942 Returns the status with the first character capitalized.
7946 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
7948 sub ucfirst_cust_status {
7950 ucfirst($self->cust_status);
7955 Returns a hex triplet color string for this customer's status.
7959 use vars qw(%statuscolor);
7960 tie %statuscolor, 'Tie::IxHash',
7961 'prospect' => '7e0079', #'000000', #black? naw, purple
7962 'active' => '00CC00', #green
7963 'inactive' => '0000CC', #blue
7964 'suspended' => 'FF9900', #yellow
7965 'cancelled' => 'FF0000', #red
7968 sub statuscolor { shift->cust_statuscolor(@_); }
7970 sub cust_statuscolor {
7972 $statuscolor{$self->cust_status};
7977 Returns an array of hashes representing the customer's RT tickets.
7984 my $num = $conf->config('cust_main-max_tickets') || 10;
7987 if ( $conf->config('ticket_system') ) {
7988 unless ( $conf->config('ticket_system-custom_priority_field') ) {
7990 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
7994 foreach my $priority (
7995 $conf->config('ticket_system-custom_priority_field-values'), ''
7997 last if scalar(@tickets) >= $num;
7999 @{ FS::TicketSystem->customer_tickets( $self->custnum,
8000 $num - scalar(@tickets),
8010 # Return services representing svc_accts in customer support packages
8011 sub support_services {
8013 my %packages = map { $_ => 1 } $conf->config('support_packages');
8015 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
8016 grep { $_->part_svc->svcdb eq 'svc_acct' }
8017 map { $_->cust_svc }
8018 grep { exists $packages{ $_->pkgpart } }
8019 $self->ncancelled_pkgs;
8023 # Return a list of latitude/longitude for one of the services (if any)
8024 sub service_coordinates {
8028 grep { $_->latitude && $_->longitude }
8030 map { $_->cust_svc }
8031 $self->ncancelled_pkgs;
8033 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
8038 =head1 CLASS METHODS
8044 Class method that returns the list of possible status strings for customers
8045 (see L<the status method|/status>). For example:
8047 @statuses = FS::cust_main->statuses();
8052 #my $self = shift; #could be class...
8058 Returns an SQL expression identifying prospective cust_main records (customers
8059 with no packages ever ordered)
8063 use vars qw($select_count_pkgs);
8064 $select_count_pkgs =
8065 "SELECT COUNT(*) FROM cust_pkg
8066 WHERE cust_pkg.custnum = cust_main.custnum";
8068 sub select_count_pkgs_sql {
8072 sub prospect_sql { "
8073 0 = ( $select_count_pkgs )
8078 Returns an SQL expression identifying active cust_main records (customers with
8079 active recurring packages).
8084 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
8090 Returns an SQL expression identifying inactive cust_main records (customers with
8091 no active recurring packages, but otherwise unsuspended/uncancelled).
8095 sub inactive_sql { "
8096 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
8098 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
8104 Returns an SQL expression identifying suspended cust_main records.
8109 sub suspended_sql { susp_sql(@_); }
8111 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
8113 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
8119 Returns an SQL expression identifying cancelled cust_main records.
8123 sub cancelled_sql { cancel_sql(@_); }
8126 my $recurring_sql = FS::cust_pkg->recurring_sql;
8127 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
8130 0 < ( $select_count_pkgs )
8131 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
8132 AND 0 = ( $select_count_pkgs AND $recurring_sql
8133 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
8135 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
8141 =item uncancelled_sql
8143 Returns an SQL expression identifying un-cancelled cust_main records.
8147 sub uncancelled_sql { uncancel_sql(@_); }
8148 sub uncancel_sql { "
8149 ( 0 < ( $select_count_pkgs
8150 AND ( cust_pkg.cancel IS NULL
8151 OR cust_pkg.cancel = 0
8154 OR 0 = ( $select_count_pkgs )
8160 Returns an SQL fragment to retreive the balance.
8165 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
8166 WHERE cust_bill.custnum = cust_main.custnum )
8167 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
8168 WHERE cust_pay.custnum = cust_main.custnum )
8169 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
8170 WHERE cust_credit.custnum = cust_main.custnum )
8171 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
8172 WHERE cust_refund.custnum = cust_main.custnum )
8175 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8177 Returns an SQL fragment to retreive the balance for this customer, only
8178 considering invoices with date earlier than START_TIME, and optionally not
8179 later than END_TIME (total_owed_date minus total_unapplied_credits minus
8180 total_unapplied_payments).
8182 Times are specified as SQL fragments or numeric
8183 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
8184 L<Date::Parse> for conversion functions. The empty string can be passed
8185 to disable that time constraint completely.
8187 Available options are:
8191 =item unapplied_date
8193 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)
8198 set to true to remove all customer comparison clauses, for totals
8203 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
8208 JOIN clause (typically used with the total option)
8214 sub balance_date_sql {
8215 my( $class, $start, $end, %opt ) = @_;
8217 my $owed = FS::cust_bill->owed_sql;
8218 my $unapp_refund = FS::cust_refund->unapplied_sql;
8219 my $unapp_credit = FS::cust_credit->unapplied_sql;
8220 my $unapp_pay = FS::cust_pay->unapplied_sql;
8222 my $j = $opt{'join'} || '';
8224 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
8225 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
8226 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
8227 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
8229 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
8230 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
8231 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
8232 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
8237 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
8239 Returns an SQL fragment to retreive the total unapplied payments for this
8240 customer, only considering invoices with date earlier than START_TIME, and
8241 optionally not later than END_TIME.
8243 Times are specified as SQL fragments or numeric
8244 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
8245 L<Date::Parse> for conversion functions. The empty string can be passed
8246 to disable that time constraint completely.
8248 Available options are:
8252 sub unapplied_payments_date_sql {
8253 my( $class, $start, $end, ) = @_;
8255 my $unapp_pay = FS::cust_pay->unapplied_sql;
8257 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
8258 'unapplied_date'=>1 );
8260 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
8263 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8265 Helper method for balance_date_sql; name (and usage) subject to change
8266 (suggestions welcome).
8268 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
8269 cust_refund, cust_credit or cust_pay).
8271 If TABLE is "cust_bill" or the unapplied_date option is true, only
8272 considers records with date earlier than START_TIME, and optionally not
8273 later than END_TIME .
8277 sub _money_table_where {
8278 my( $class, $table, $start, $end, %opt ) = @_;
8281 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
8282 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
8283 push @where, "$table._date <= $start" if defined($start) && length($start);
8284 push @where, "$table._date > $end" if defined($end) && length($end);
8286 push @where, @{$opt{'where'}} if $opt{'where'};
8287 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
8293 =item search HASHREF
8297 Returns a qsearch hash expression to search for parameters specified in
8298 HASHREF. Valid parameters are
8306 =item cancelled_pkgs
8312 listref of start date, end date
8322 =item current_balance
8324 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
8328 =item flattened_pkgs
8337 my ($class, $params) = @_;
8348 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
8350 "cust_main.agentnum = $1";
8357 #prospect active inactive suspended cancelled
8358 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
8359 my $method = $params->{'status'}. '_sql';
8360 #push @where, $class->$method();
8361 push @where, FS::cust_main->$method();
8365 # parse cancelled package checkbox
8370 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
8371 unless $params->{'cancelled_pkgs'};
8374 # parse without census tract checkbox
8377 push @where, "(censustract = '' or censustract is null)"
8378 if $params->{'no_censustract'};
8384 foreach my $field (qw( signupdate )) {
8386 next unless exists($params->{$field});
8388 my($beginning, $ending) = @{$params->{$field}};
8391 "cust_main.$field IS NOT NULL",
8392 "cust_main.$field >= $beginning",
8393 "cust_main.$field <= $ending";
8395 $orderby ||= "ORDER BY cust_main.$field";
8403 if ( $params->{'payby'} ) {
8405 my @payby = ref( $params->{'payby'} )
8406 ? @{ $params->{'payby'} }
8407 : ( $params->{'payby'} );
8409 @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
8411 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )'
8416 my @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
8418 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )';
8422 # paydate_year / paydate_month
8425 if ( $params->{'paydate_year'} =~ /^(\d{4})$/ ) {
8427 $params->{'paydate_month'} =~ /^(\d\d?)$/
8428 or die "paydate_year without paydate_month?";
8432 'paydate IS NOT NULL',
8434 "CAST(paydate AS timestamp) < CAST('$year-$month-01' AS timestamp )"
8442 if ( $params->{'invoice_terms'} =~ /^([\w ]+)$/ ) {
8444 if ( $1 eq 'NULL' ) {
8446 "( cust_main.invoice_terms IS NULL OR cust_main.invoice_terms = '' )";
8449 "cust_main.invoice_terms IS NOT NULL",
8450 "cust_main.invoice_terms = '$1'";
8458 if ( $params->{'current_balance'} ) {
8460 #my $balance_sql = $class->balance_sql();
8461 my $balance_sql = FS::cust_main->balance_sql();
8463 my @current_balance =
8464 ref( $params->{'current_balance'} )
8465 ? @{ $params->{'current_balance'} }
8466 : ( $params->{'current_balance'} );
8468 push @where, map { s/current_balance/$balance_sql/; $_ }
8477 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
8479 "cust_main.custbatch = '$1'";
8483 # setup queries, subs, etc. for the search
8486 $orderby ||= 'ORDER BY custnum';
8488 # here is the agent virtualization
8489 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
8491 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
8493 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
8495 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
8497 my $select = join(', ',
8498 'cust_main.custnum',
8499 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
8502 my(@extra_headers) = ();
8503 my(@extra_fields) = ();
8505 if ($params->{'flattened_pkgs'}) {
8507 if ($dbh->{Driver}->{Name} eq 'Pg') {
8509 $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";
8511 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
8512 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
8513 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
8515 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
8516 "omitting packing information from report.";
8519 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";
8521 my $sth = dbh->prepare($header_query) or die dbh->errstr;
8522 $sth->execute() or die $sth->errstr;
8523 my $headerrow = $sth->fetchrow_arrayref;
8524 my $headercount = $headerrow ? $headerrow->[0] : 0;
8525 while($headercount) {
8526 unshift @extra_headers, "Package ". $headercount;
8527 unshift @extra_fields, eval q!sub {my $c = shift;
8528 my @a = split '\|', $c->magic;
8529 my $p = $a[!.--$headercount. q!];
8537 'table' => 'cust_main',
8538 'select' => $select,
8540 'extra_sql' => $extra_sql,
8541 'order_by' => $orderby,
8542 'count_query' => $count_query,
8543 'extra_headers' => \@extra_headers,
8544 'extra_fields' => \@extra_fields,
8549 =item email_search_result HASHREF
8553 Emails a notice to the specified customers.
8555 Valid parameters are those of the L<search> method, plus the following:
8577 Optional job queue job for status updates.
8581 Returns an error message, or false for success.
8583 If an error occurs during any email, stops the enture send and returns that
8584 error. Presumably if you're getting SMTP errors aborting is better than
8585 retrying everything.
8589 sub email_search_result {
8590 my($class, $params) = @_;
8592 my $from = delete $params->{from};
8593 my $subject = delete $params->{subject};
8594 my $html_body = delete $params->{html_body};
8595 my $text_body = delete $params->{text_body};
8597 my $job = delete $params->{'job'};
8599 $params->{'payby'} = [ split(/\0/, $params->{'payby'}) ]
8600 unless ref($params->{'payby'});
8602 my $sql_query = $class->search($params);
8604 my $count_query = delete($sql_query->{'count_query'});
8605 my $count_sth = dbh->prepare($count_query)
8606 or die "Error preparing $count_query: ". dbh->errstr;
8608 or die "Error executing $count_query: ". $count_sth->errstr;
8609 my $count_arrayref = $count_sth->fetchrow_arrayref;
8610 my $num_cust = $count_arrayref->[0];
8612 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
8613 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
8616 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
8618 #eventually order+limit magic to reduce memory use?
8619 foreach my $cust_main ( qsearch($sql_query) ) {
8621 my $to = $cust_main->invoicing_list_emailonly_scalar;
8624 my $error = send_email(
8628 'subject' => $subject,
8629 'html_body' => $html_body,
8630 'text_body' => $text_body,
8633 return $error if $error;
8635 if ( $job ) { #progressbar foo
8637 if ( time - $min_sec > $last ) {
8638 my $error = $job->update_statustext(
8639 int( 100 * $num / $num_cust )
8641 die $error if $error;
8651 use Storable qw(thaw);
8654 sub process_email_search_result {
8656 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
8658 my $param = thaw(decode_base64(shift));
8659 warn Dumper($param) if $DEBUG;
8661 $param->{'job'} = $job;
8663 $param->{'payby'} = [ split(/\0/, $param->{'payby'}) ]
8664 unless ref($param->{'payby'});
8666 my $error = FS::cust_main->email_search_result( $param );
8667 die $error if $error;
8671 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
8673 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
8674 records. Currently, I<first>, I<last>, I<company> and/or I<address1> may be
8675 specified (the appropriate ship_ field is also searched).
8677 Additional options are the same as FS::Record::qsearch
8682 my( $self, $fuzzy, $hash, @opt) = @_;
8687 check_and_rebuild_fuzzyfiles();
8688 foreach my $field ( keys %$fuzzy ) {
8690 my $all = $self->all_X($field);
8691 next unless scalar(@$all);
8694 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
8697 foreach ( keys %match ) {
8698 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
8699 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
8702 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
8705 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
8707 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
8715 Returns a masked version of the named field
8720 my ($self,$field) = @_;
8724 'x'x(length($self->getfield($field))-4).
8725 substr($self->getfield($field), (length($self->getfield($field))-4));
8735 =item smart_search OPTION => VALUE ...
8737 Accepts the following options: I<search>, the string to search for. The string
8738 will be searched for as a customer number, phone number, name or company name,
8739 as an exact, or, in some cases, a substring or fuzzy match (see the source code
8740 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
8741 skip fuzzy matching when an exact match is found.
8743 Any additional options are treated as an additional qualifier on the search
8746 Returns a (possibly empty) array of FS::cust_main objects.
8753 #here is the agent virtualization
8754 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8758 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
8759 my $search = delete $options{'search'};
8760 ( my $alphanum_search = $search ) =~ s/\W//g;
8762 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
8764 #false laziness w/Record::ut_phone
8765 my $phonen = "$1-$2-$3";
8766 $phonen .= " x$4" if $4;
8768 push @cust_main, qsearch( {
8769 'table' => 'cust_main',
8770 'hashref' => { %options },
8771 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8773 join(' OR ', map "$_ = '$phonen'",
8774 qw( daytime night fax
8775 ship_daytime ship_night ship_fax )
8778 " AND $agentnums_sql", #agent virtualization
8781 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
8782 #try looking for matches with extensions unless one was specified
8784 push @cust_main, qsearch( {
8785 'table' => 'cust_main',
8786 'hashref' => { %options },
8787 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8789 join(' OR ', map "$_ LIKE '$phonen\%'",
8791 ship_daytime ship_night )
8794 " AND $agentnums_sql", #agent virtualization
8799 # custnum search (also try agent_custid), with some tweaking options if your
8800 # legacy cust "numbers" have letters
8803 if ( $search =~ /^\s*(\d+)\s*$/
8804 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
8805 && $search =~ /^\s*(\w\w?\d+)\s*$/
8807 || ( $conf->exists('address1-search' )
8808 && $search =~ /^\s*(\d+\-?\w*)\s*$/ #i.e. 1234A or 9432-D
8815 if ( $num =~ /^(\d+)$/ && $num <= 2147483647 ) { #need a bigint custnum? wow
8816 push @cust_main, qsearch( {
8817 'table' => 'cust_main',
8818 'hashref' => { 'custnum' => $num, %options },
8819 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8823 push @cust_main, qsearch( {
8824 'table' => 'cust_main',
8825 'hashref' => { 'agent_custid' => $num, %options },
8826 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8829 if ( $conf->exists('address1-search') ) {
8830 my $len = length($num);
8832 foreach my $prefix ( '', 'ship_' ) {
8833 push @cust_main, qsearch( {
8834 'table' => 'cust_main',
8835 'hashref' => { %options, },
8837 ( keys(%options) ? ' AND ' : ' WHERE ' ).
8838 " LOWER(SUBSTRING(${prefix}address1 FROM 1 FOR $len)) = '$num' ".
8839 " AND $agentnums_sql",
8844 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
8846 my($company, $last, $first) = ( $1, $2, $3 );
8848 # "Company (Last, First)"
8849 #this is probably something a browser remembered,
8850 #so just do an exact search (but case-insensitive, so USPS standardization
8851 #doesn't throw a wrench in the works)
8853 foreach my $prefix ( '', 'ship_' ) {
8854 push @cust_main, qsearch( {
8855 'table' => 'cust_main',
8856 'hashref' => { %options },
8858 ( keys(%options) ? ' AND ' : ' WHERE ' ).
8860 " LOWER(${prefix}first) = ". dbh->quote(lc($first)),
8861 " LOWER(${prefix}last) = ". dbh->quote(lc($last)),
8862 " LOWER(${prefix}company) = ". dbh->quote(lc($company)),
8868 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
8869 # try (ship_){last,company}
8873 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
8874 # # full strings the browser remembers won't work
8875 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
8877 use Lingua::EN::NameParse;
8878 my $NameParse = new Lingua::EN::NameParse(
8880 allow_reversed => 1,
8883 my($last, $first) = ( '', '' );
8884 #maybe disable this too and just rely on NameParse?
8885 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
8887 ($last, $first) = ( $1, $2 );
8889 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
8890 } elsif ( ! $NameParse->parse($value) ) {
8892 my %name = $NameParse->components;
8893 $first = $name{'given_name_1'};
8894 $last = $name{'surname_1'};
8898 if ( $first && $last ) {
8900 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
8903 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8905 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
8906 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
8909 push @cust_main, qsearch( {
8910 'table' => 'cust_main',
8911 'hashref' => \%options,
8912 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8915 # or it just be something that was typed in... (try that in a sec)
8919 my $q_value = dbh->quote($value);
8922 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8923 $sql .= " ( LOWER(last) = $q_value
8924 OR LOWER(company) = $q_value
8925 OR LOWER(ship_last) = $q_value
8926 OR LOWER(ship_company) = $q_value
8928 $sql .= " OR LOWER(address1) = $q_value
8929 OR LOWER(ship_address1) = $q_value
8931 if $conf->exists('address1-search');
8934 push @cust_main, qsearch( {
8935 'table' => 'cust_main',
8936 'hashref' => \%options,
8937 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8940 #no exact match, trying substring/fuzzy
8941 #always do substring & fuzzy (unless they're explicity config'ed off)
8942 #getting complaints searches are not returning enough
8943 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
8945 #still some false laziness w/search (was search/cust_main.cgi)
8950 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
8951 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
8954 if ( $first && $last ) {
8957 { 'first' => { op=>'ILIKE', value=>"%$first%" },
8958 'last' => { op=>'ILIKE', value=>"%$last%" },
8960 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
8961 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
8968 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
8969 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
8973 if ( $conf->exists('address1-search') ) {
8975 { 'address1' => { op=>'ILIKE', value=>"%$value%" }, },
8976 { 'ship_address1' => { op=>'ILIKE', value=>"%$value%" }, },
8980 foreach my $hashref ( @hashrefs ) {
8982 push @cust_main, qsearch( {
8983 'table' => 'cust_main',
8984 'hashref' => { %$hashref,
8987 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
8996 " AND $agentnums_sql", #extra_sql #agent virtualization
8999 if ( $first && $last ) {
9000 push @cust_main, FS::cust_main->fuzzy_search(
9001 { 'last' => $last, #fuzzy hashref
9002 'first' => $first }, #
9006 foreach my $field ( 'last', 'company' ) {
9008 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
9010 if ( $conf->exists('address1-search') ) {
9012 FS::cust_main->fuzzy_search( { 'address1' => $value }, @fuzopts );
9019 #eliminate duplicates
9021 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
9029 Accepts the following options: I<email>, the email address to search for. The
9030 email address will be searched for as an email invoice destination and as an
9033 #Any additional options are treated as an additional qualifier on the search
9034 #(i.e. I<agentnum>).
9036 Returns a (possibly empty) array of FS::cust_main objects (but usually just
9046 my $email = delete $options{'email'};
9048 #we're only being used by RT at the moment... no agent virtualization yet
9049 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
9053 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
9055 my ( $user, $domain ) = ( $1, $2 );
9057 warn "$me smart_search: searching for $user in domain $domain"
9063 'table' => 'cust_main_invoice',
9064 'hashref' => { 'dest' => $email },
9071 map $_->cust_svc->cust_pkg,
9073 'table' => 'svc_acct',
9074 'hashref' => { 'username' => $user, },
9076 'AND ( SELECT domain FROM svc_domain
9077 WHERE svc_acct.domsvc = svc_domain.svcnum
9078 ) = '. dbh->quote($domain),
9084 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
9086 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
9093 =item check_and_rebuild_fuzzyfiles
9097 sub check_and_rebuild_fuzzyfiles {
9098 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9099 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
9102 =item rebuild_fuzzyfiles
9106 sub rebuild_fuzzyfiles {
9108 use Fcntl qw(:flock);
9110 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9111 mkdir $dir, 0700 unless -d $dir;
9113 foreach my $fuzzy ( @fuzzyfields ) {
9115 open(LOCK,">>$dir/cust_main.$fuzzy")
9116 or die "can't open $dir/cust_main.$fuzzy: $!";
9118 or die "can't lock $dir/cust_main.$fuzzy: $!";
9120 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
9121 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
9123 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
9124 my $sth = dbh->prepare("SELECT $field FROM cust_main".
9125 " WHERE $field != '' AND $field IS NOT NULL");
9126 $sth->execute or die $sth->errstr;
9128 while ( my $row = $sth->fetchrow_arrayref ) {
9129 print CACHE $row->[0]. "\n";
9134 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
9136 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
9147 my( $self, $field ) = @_;
9148 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9149 open(CACHE,"<$dir/cust_main.$field")
9150 or die "can't open $dir/cust_main.$field: $!";
9151 my @array = map { chomp; $_; } <CACHE>;
9156 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
9160 sub append_fuzzyfiles {
9161 #my( $first, $last, $company ) = @_;
9163 &check_and_rebuild_fuzzyfiles;
9165 use Fcntl qw(:flock);
9167 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9169 foreach my $field (@fuzzyfields) {
9174 open(CACHE,">>$dir/cust_main.$field")
9175 or die "can't open $dir/cust_main.$field: $!";
9176 flock(CACHE,LOCK_EX)
9177 or die "can't lock $dir/cust_main.$field: $!";
9179 print CACHE "$value\n";
9181 flock(CACHE,LOCK_UN)
9182 or die "can't unlock $dir/cust_main.$field: $!";
9197 #warn join('-',keys %$param);
9198 my $fh = $param->{filehandle};
9199 my @fields = @{$param->{fields}};
9201 eval "use Text::CSV_XS;";
9204 my $csv = new Text::CSV_XS;
9211 local $SIG{HUP} = 'IGNORE';
9212 local $SIG{INT} = 'IGNORE';
9213 local $SIG{QUIT} = 'IGNORE';
9214 local $SIG{TERM} = 'IGNORE';
9215 local $SIG{TSTP} = 'IGNORE';
9216 local $SIG{PIPE} = 'IGNORE';
9218 my $oldAutoCommit = $FS::UID::AutoCommit;
9219 local $FS::UID::AutoCommit = 0;
9222 #while ( $columns = $csv->getline($fh) ) {
9224 while ( defined($line=<$fh>) ) {
9226 $csv->parse($line) or do {
9227 $dbh->rollback if $oldAutoCommit;
9228 return "can't parse: ". $csv->error_input();
9231 my @columns = $csv->fields();
9232 #warn join('-',@columns);
9235 foreach my $field ( @fields ) {
9236 $row{$field} = shift @columns;
9239 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
9240 unless ( $cust_main ) {
9241 $dbh->rollback if $oldAutoCommit;
9242 return "unknown custnum $row{'custnum'}";
9245 if ( $row{'amount'} > 0 ) {
9246 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
9248 $dbh->rollback if $oldAutoCommit;
9252 } elsif ( $row{'amount'} < 0 ) {
9253 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
9256 $dbh->rollback if $oldAutoCommit;
9266 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
9268 return "Empty file!" unless $imported;
9274 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9276 Sends a templated email notification to the customer (see L<Text::Template>).
9278 OPTIONS is a hash and may include
9280 I<from> - the email sender (default is invoice_from)
9282 I<to> - comma-separated scalar or arrayref of recipients
9283 (default is invoicing_list)
9285 I<subject> - The subject line of the sent email notification
9286 (default is "Notice from company_name")
9288 I<extra_fields> - a hashref of name/value pairs which will be substituted
9291 The following variables are vavailable in the template.
9293 I<$first> - the customer first name
9294 I<$last> - the customer last name
9295 I<$company> - the customer company
9296 I<$payby> - a description of the method of payment for the customer
9297 # would be nice to use FS::payby::shortname
9298 I<$payinfo> - the account information used to collect for this customer
9299 I<$expdate> - the expiration of the customer payment in seconds from epoch
9304 my ($self, $template, %options) = @_;
9306 return unless $conf->exists($template);
9308 my $from = $conf->config('invoice_from', $self->agentnum)
9309 if $conf->exists('invoice_from', $self->agentnum);
9310 $from = $options{from} if exists($options{from});
9312 my $to = join(',', $self->invoicing_list_emailonly);
9313 $to = $options{to} if exists($options{to});
9315 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
9316 if $conf->exists('company_name', $self->agentnum);
9317 $subject = $options{subject} if exists($options{subject});
9319 my $notify_template = new Text::Template (TYPE => 'ARRAY',
9320 SOURCE => [ map "$_\n",
9321 $conf->config($template)]
9323 or die "can't create new Text::Template object: Text::Template::ERROR";
9324 $notify_template->compile()
9325 or die "can't compile template: Text::Template::ERROR";
9327 $FS::notify_template::_template::company_name =
9328 $conf->config('company_name', $self->agentnum);
9329 $FS::notify_template::_template::company_address =
9330 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
9332 my $paydate = $self->paydate || '2037-12-31';
9333 $FS::notify_template::_template::first = $self->first;
9334 $FS::notify_template::_template::last = $self->last;
9335 $FS::notify_template::_template::company = $self->company;
9336 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
9337 my $payby = $self->payby;
9338 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9339 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9341 #credit cards expire at the end of the month/year of their exp date
9342 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9343 $FS::notify_template::_template::payby = 'credit card';
9344 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9345 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9347 }elsif ($payby eq 'COMP') {
9348 $FS::notify_template::_template::payby = 'complimentary account';
9350 $FS::notify_template::_template::payby = 'current method';
9352 $FS::notify_template::_template::expdate = $expire_time;
9354 for (keys %{$options{extra_fields}}){
9356 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
9359 send_email(from => $from,
9361 subject => $subject,
9362 body => $notify_template->fill_in( PACKAGE =>
9363 'FS::notify_template::_template' ),
9368 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9370 Generates a templated notification to the customer (see L<Text::Template>).
9372 OPTIONS is a hash and may include
9374 I<extra_fields> - a hashref of name/value pairs which will be substituted
9375 into the template. These values may override values mentioned below
9376 and those from the customer record.
9378 The following variables are available in the template instead of or in addition
9379 to the fields of the customer record.
9381 I<$payby> - a description of the method of payment for the customer
9382 # would be nice to use FS::payby::shortname
9383 I<$payinfo> - the masked account information used to collect for this customer
9384 I<$expdate> - the expiration of the customer payment method in seconds from epoch
9385 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
9389 sub generate_letter {
9390 my ($self, $template, %options) = @_;
9392 return unless $conf->exists($template);
9394 my $letter_template = new Text::Template
9396 SOURCE => [ map "$_\n", $conf->config($template)],
9397 DELIMITERS => [ '[@--', '--@]' ],
9399 or die "can't create new Text::Template object: Text::Template::ERROR";
9401 $letter_template->compile()
9402 or die "can't compile template: Text::Template::ERROR";
9404 my %letter_data = map { $_ => $self->$_ } $self->fields;
9405 $letter_data{payinfo} = $self->mask_payinfo;
9407 #my $paydate = $self->paydate || '2037-12-31';
9408 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
9410 my $payby = $self->payby;
9411 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9412 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9414 #credit cards expire at the end of the month/year of their exp date
9415 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9416 $letter_data{payby} = 'credit card';
9417 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9418 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9420 }elsif ($payby eq 'COMP') {
9421 $letter_data{payby} = 'complimentary account';
9423 $letter_data{payby} = 'current method';
9425 $letter_data{expdate} = $expire_time;
9427 for (keys %{$options{extra_fields}}){
9428 $letter_data{$_} = $options{extra_fields}->{$_};
9431 unless(exists($letter_data{returnaddress})){
9432 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
9433 $self->agent_template)
9435 if ( length($retadd) ) {
9436 $letter_data{returnaddress} = $retadd;
9437 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
9438 $letter_data{returnaddress} =
9439 join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
9440 $conf->config('company_address', $self->agentnum)
9443 $letter_data{returnaddress} = '~';
9447 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
9449 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
9451 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
9452 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
9456 ) or die "can't open temp file: $!\n";
9458 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
9460 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
9464 =item print_ps TEMPLATE
9466 Returns an postscript letter filled in from TEMPLATE, as a scalar.
9472 my $file = $self->generate_letter(@_);
9473 FS::Misc::generate_ps($file);
9476 =item print TEMPLATE
9478 Prints the filled in template.
9480 TEMPLATE is the name of a L<Text::Template> to fill in and print.
9484 sub queueable_print {
9487 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
9488 or die "invalid customer number: " . $opt{custvnum};
9490 my $error = $self->print( $opt{template} );
9491 die $error if $error;
9495 my ($self, $template) = (shift, shift);
9496 do_print [ $self->print_ps($template) ];
9499 #these three subs should just go away once agent stuff is all config overrides
9501 sub agent_template {
9503 $self->_agent_plandata('agent_templatename');
9506 sub agent_invoice_from {
9508 $self->_agent_plandata('agent_invoice_from');
9511 sub _agent_plandata {
9512 my( $self, $option ) = @_;
9514 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
9515 #agent-specific Conf
9517 use FS::part_event::Condition;
9519 my $agentnum = $self->agentnum;
9522 if ( driver_name =~ /^Pg/i ) {
9524 } elsif ( driver_name =~ /^mysql/i ) {
9527 die "don't know how to use regular expressions in ". driver_name. " databases";
9530 my $part_event_option =
9532 'select' => 'part_event_option.*',
9533 'table' => 'part_event_option',
9535 LEFT JOIN part_event USING ( eventpart )
9536 LEFT JOIN part_event_option AS peo_agentnum
9537 ON ( part_event.eventpart = peo_agentnum.eventpart
9538 AND peo_agentnum.optionname = 'agentnum'
9539 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
9541 LEFT JOIN part_event_condition
9542 ON ( part_event.eventpart = part_event_condition.eventpart
9543 AND part_event_condition.conditionname = 'cust_bill_age'
9545 LEFT JOIN part_event_condition_option
9546 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
9547 AND part_event_condition_option.optionname = 'age'
9550 #'hashref' => { 'optionname' => $option },
9551 #'hashref' => { 'part_event_option.optionname' => $option },
9553 " WHERE part_event_option.optionname = ". dbh->quote($option).
9554 " AND action = 'cust_bill_send_agent' ".
9555 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
9556 " AND peo_agentnum.optionname = 'agentnum' ".
9557 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
9559 CASE WHEN part_event_condition_option.optionname IS NULL
9561 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
9563 , part_event.weight".
9567 unless ( $part_event_option ) {
9568 return $self->agent->invoice_template || ''
9569 if $option eq 'agent_templatename';
9573 $part_event_option->optionvalue;
9578 ## actual sub, not a method, designed to be called from the queue.
9579 ## sets up the customer, and calls the bill_and_collect
9580 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
9581 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
9582 $cust_main->bill_and_collect(
9587 sub _upgrade_data { #class method
9588 my ($class, %opts) = @_;
9590 my $sql = 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL';
9591 my $sth = dbh->prepare($sql) or die dbh->errstr;
9592 $sth->execute or die $sth->errstr;
9602 The delete method should possibly take an FS::cust_main object reference
9603 instead of a scalar customer number.
9605 Bill and collect options should probably be passed as references instead of a
9608 There should probably be a configuration file with a list of allowed credit
9611 No multiple currency support (probably a larger project than just this module).
9613 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
9615 Birthdates rely on negative epoch values.
9617 The payby for card/check batches is broken. With mixed batching, bad
9620 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
9624 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
9625 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
9626 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.