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 );
1915 Returns a list of key/value pairs, with the following keys: address1, adddress2,
1916 city, county, state, zip, country. The shipping address is used if present.
1920 #geocode? dependent on tax-ship_address config, not available in cust_location
1921 #mostly. not yet then.
1925 my $prefix = $self->has_ship_address ? 'ship_' : '';
1927 map { $_ => $self->get($prefix.$_) }
1928 qw( address1 address2 city county state zip country geocode );
1929 #fields that cust_location has
1932 =item all_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
1934 Returns all packages (see L<FS::cust_pkg>) for this customer.
1940 my $extra_qsearch = ref($_[0]) ? shift : {};
1942 return $self->num_pkgs unless wantarray || keys(%$extra_qsearch);
1945 if ( $self->{'_pkgnum'} ) {
1946 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1948 @cust_pkg = $self->_cust_pkg($extra_qsearch);
1951 sort sort_packages @cust_pkg;
1956 Synonym for B<all_pkgs>.
1961 shift->all_pkgs(@_);
1966 Returns all locations (see L<FS::cust_location>) for this customer.
1972 qsearch('cust_location', { 'custnum' => $self->custnum } );
1975 =item location_label [ OPTION => VALUE ... ]
1977 Returns the label of the service location (see analog in L<FS::cust_location>) for this customer.
1985 used to separate the address elements (defaults to ', ')
1987 =item escape_function
1989 a callback used for escaping the text of the address elements
1995 # false laziness with FS::cust_location::line
1997 sub location_label {
2001 my $separator = $opt{join_string} || ', ';
2002 my $escape = $opt{escape_function} || sub{ shift };
2004 my $cydefault = FS::conf->new->config('countrydefault') || 'US';
2005 my $prefix = length($self->ship_last) ? 'ship_' : '';
2008 foreach (qw ( address1 address2 ) ) {
2009 my $method = "$prefix$_";
2010 $line .= ($notfirst ? $separator : ''). &$escape($self->$method)
2015 foreach (qw ( city county state zip ) ) {
2016 my $method = "$prefix$_";
2017 if ( $self->$method ) {
2018 $line .= ' (' if $method eq 'county';
2019 $line .= ($notfirst ? ' ' : $separator). &$escape($self->$method);
2020 $line .= ' )' if $method eq 'county';
2024 $line .= $separator. &$escape(code2country($self->country))
2025 if $self->country ne $cydefault;
2030 =item ncancelled_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
2032 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
2036 sub ncancelled_pkgs {
2038 my $extra_qsearch = ref($_[0]) ? shift : {};
2040 return $self->num_ncancelled_pkgs unless wantarray;
2043 if ( $self->{'_pkgnum'} ) {
2045 warn "$me ncancelled_pkgs: returning cached objects"
2048 @cust_pkg = grep { ! $_->getfield('cancel') }
2049 values %{ $self->{'_pkgnum'}->cache };
2053 warn "$me ncancelled_pkgs: searching for packages with custnum ".
2054 $self->custnum. "\n"
2057 $extra_qsearch->{'extra_sql'} .= ' AND ( cancel IS NULL OR cancel = 0 ) ';
2059 @cust_pkg = $self->_cust_pkg($extra_qsearch);
2063 sort sort_packages @cust_pkg;
2069 my $extra_qsearch = ref($_[0]) ? shift : {};
2071 $extra_qsearch->{'select'} ||= '*';
2072 $extra_qsearch->{'select'} .=
2073 ',( SELECT COUNT(*) FROM cust_svc WHERE cust_pkg.pkgnum = cust_svc.pkgnum )
2077 $_->{'_num_cust_svc'} = $_->get('_num_cust_svc');
2082 'table' => 'cust_pkg',
2083 'hashref' => { 'custnum' => $self->custnum },
2088 # This should be generalized to use config options to determine order.
2091 my $locationsort = ( $a->locationnum || 0 ) <=> ( $b->locationnum || 0 );
2092 return $locationsort if $locationsort;
2094 if ( $a->get('cancel') xor $b->get('cancel') ) {
2095 return -1 if $b->get('cancel');
2096 return 1 if $a->get('cancel');
2097 #shouldn't get here...
2100 my $a_num_cust_svc = $a->num_cust_svc;
2101 my $b_num_cust_svc = $b->num_cust_svc;
2102 return 0 if !$a_num_cust_svc && !$b_num_cust_svc;
2103 return -1 if $a_num_cust_svc && !$b_num_cust_svc;
2104 return 1 if !$a_num_cust_svc && $b_num_cust_svc;
2105 my @a_cust_svc = $a->cust_svc;
2106 my @b_cust_svc = $b->cust_svc;
2107 $a_cust_svc[0]->svc_x->label cmp $b_cust_svc[0]->svc_x->label;
2112 =item suspended_pkgs
2114 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
2118 sub suspended_pkgs {
2120 grep { $_->susp } $self->ncancelled_pkgs;
2123 =item unflagged_suspended_pkgs
2125 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
2126 customer (thouse packages without the `manual_flag' set).
2130 sub unflagged_suspended_pkgs {
2132 return $self->suspended_pkgs
2133 unless dbdef->table('cust_pkg')->column('manual_flag');
2134 grep { ! $_->manual_flag } $self->suspended_pkgs;
2137 =item unsuspended_pkgs
2139 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
2144 sub unsuspended_pkgs {
2146 grep { ! $_->susp } $self->ncancelled_pkgs;
2149 =item next_bill_date
2151 Returns the next date this customer will be billed, as a UNIX timestamp, or
2152 undef if no active package has a next bill date.
2156 sub next_bill_date {
2158 min( map $_->get('bill'), grep $_->get('bill'), $self->unsuspended_pkgs );
2161 =item num_cancelled_pkgs
2163 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
2168 sub num_cancelled_pkgs {
2169 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
2172 sub num_ncancelled_pkgs {
2173 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
2177 my( $self ) = shift;
2178 my $sql = scalar(@_) ? shift : '';
2179 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
2180 my $sth = dbh->prepare(
2181 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
2182 ) or die dbh->errstr;
2183 $sth->execute($self->custnum) or die $sth->errstr;
2184 $sth->fetchrow_arrayref->[0];
2189 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2190 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2191 on success or a list of errors.
2197 grep { $_->unsuspend } $self->suspended_pkgs;
2202 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2204 Returns a list: an empty list on success or a list of errors.
2210 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2213 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2215 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2216 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2217 of a list of pkgparts; the hashref has the following keys:
2221 =item pkgparts - listref of pkgparts
2223 =item (other options are passed to the suspend method)
2228 Returns a list: an empty list on success or a list of errors.
2232 sub suspend_if_pkgpart {
2234 my (@pkgparts, %opt);
2235 if (ref($_[0]) eq 'HASH'){
2236 @pkgparts = @{$_[0]{pkgparts}};
2241 grep { $_->suspend(%opt) }
2242 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2243 $self->unsuspended_pkgs;
2246 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2248 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2249 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2250 instead of a list of pkgparts; the hashref has the following keys:
2254 =item pkgparts - listref of pkgparts
2256 =item (other options are passed to the suspend method)
2260 Returns a list: an empty list on success or a list of errors.
2264 sub suspend_unless_pkgpart {
2266 my (@pkgparts, %opt);
2267 if (ref($_[0]) eq 'HASH'){
2268 @pkgparts = @{$_[0]{pkgparts}};
2273 grep { $_->suspend(%opt) }
2274 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2275 $self->unsuspended_pkgs;
2278 =item cancel [ OPTION => VALUE ... ]
2280 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2282 Available options are:
2286 =item quiet - can be set true to supress email cancellation notices.
2288 =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.
2290 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2292 =item nobill - can be set true to skip billing if it might otherwise be done.
2296 Always returns a list: an empty list on success or a list of errors.
2300 # nb that dates are not specified as valid options to this method
2303 my( $self, %opt ) = @_;
2305 warn "$me cancel called on customer ". $self->custnum. " with options ".
2306 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2309 return ( 'access denied' )
2310 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2312 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2314 #should try decryption (we might have the private key)
2315 # and if not maybe queue a job for the server that does?
2316 return ( "Can't (yet) ban encrypted credit cards" )
2317 if $self->is_encrypted($self->payinfo);
2319 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
2320 my $error = $ban->insert;
2321 return ( $error ) if $error;
2325 my @pkgs = $self->ncancelled_pkgs;
2327 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2329 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2330 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2334 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2335 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2338 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2341 sub _banned_pay_hashref {
2352 'payby' => $payby2ban{$self->payby},
2353 'payinfo' => md5_base64($self->payinfo),
2354 #don't ever *search* on reason! #'reason' =>
2360 Returns all notes (see L<FS::cust_main_note>) for this customer.
2367 qsearch( 'cust_main_note',
2368 { 'custnum' => $self->custnum },
2370 'ORDER BY _DATE DESC'
2376 Returns the agent (see L<FS::agent>) for this customer.
2382 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2385 =item bill_and_collect
2387 Cancels and suspends any packages due, generates bills, applies payments and
2388 credits, and applies collection events to run cards, send bills and notices,
2391 By default, warns on errors and continues with the next operation (but see the
2392 "fatal" flag below).
2394 Options are passed as name-value pairs. Currently available options are:
2400 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:
2404 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2408 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.
2412 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2416 If set true, re-charges setup fees.
2420 If set any errors prevent subsequent operations from continusing. If set
2421 specifically to "return", returns the error (or false, if there is no error).
2422 Any other true value causes errors to die.
2426 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)
2430 Options are passed to the B<bill> and B<collect> methods verbatim, so all
2431 options of those methods are also available.
2435 sub bill_and_collect {
2436 my( $self, %options ) = @_;
2440 #$options{actual_time} not $options{time} because freeside-daily -d is for
2441 #pre-printing invoices
2443 $options{'actual_time'} ||= time;
2445 $error = $self->cancel_expired_pkgs( $options{actual_time} );
2447 $error = "Error expiring custnum ". $self->custnum. ": $error";
2448 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2449 elsif ( $options{fatal} ) { die $error; }
2450 else { warn $error; }
2453 $error = $self->suspend_adjourned_pkgs( $options{actual_time} );
2455 $error = "Error adjourning custnum ". $self->custnum. ": $error";
2456 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2457 elsif ( $options{fatal} ) { die $error; }
2458 else { warn $error; }
2461 $error = $self->bill( %options );
2463 $error = "Error billing custnum ". $self->custnum. ": $error";
2464 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2465 elsif ( $options{fatal} ) { die $error; }
2466 else { warn $error; }
2469 $error = $self->apply_payments_and_credits;
2471 $error = "Error applying custnum ". $self->custnum. ": $error";
2472 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2473 elsif ( $options{fatal} ) { die $error; }
2474 else { warn $error; }
2477 unless ( $conf->exists('cancelled_cust-noevents')
2478 && ! $self->num_ncancelled_pkgs
2480 $error = $self->collect( %options );
2482 $error = "Error collecting custnum ". $self->custnum. ": $error";
2483 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
2484 elsif ($options{fatal} ) { die $error; }
2485 else { warn $error; }
2493 sub cancel_expired_pkgs {
2494 my ( $self, $time, %options ) = @_;
2496 my @cancel_pkgs = $self->ncancelled_pkgs( {
2497 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
2502 foreach my $cust_pkg ( @cancel_pkgs ) {
2503 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
2504 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
2505 'reason_otaker' => $cpr->otaker
2509 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
2512 scalar(@errors) ? join(' / ', @errors) : '';
2516 sub suspend_adjourned_pkgs {
2517 my ( $self, $time, %options ) = @_;
2519 my @susp_pkgs = $self->ncancelled_pkgs( {
2521 " AND ( susp IS NULL OR susp = 0 )
2522 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
2523 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
2528 #only because there's no SQL test for is_prepaid :/
2530 grep { ( $_->part_pkg->is_prepaid
2535 && $_->adjourn <= $time
2543 foreach my $cust_pkg ( @susp_pkgs ) {
2544 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
2545 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
2546 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
2547 'reason_otaker' => $cpr->otaker
2551 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
2554 scalar(@errors) ? join(' / ', @errors) : '';
2560 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
2561 conjunction with the collect method by calling B<bill_and_collect>.
2563 If there is an error, returns the error, otherwise returns false.
2565 Options are passed as name-value pairs. Currently available options are:
2571 If set true, re-charges setup fees.
2575 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:
2579 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2583 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2585 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2589 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
2593 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.
2597 This boolean value informs the us that the package is being cancelled. This
2598 typically might mean not charging the normal recurring fee but only usage
2599 fees since the last billing. Setup charges may be charged. Not all package
2600 plans support this feature (they tend to charge 0).
2604 Optional terms to be printed on this invoice. Otherwise, customer-specific
2605 terms or the default terms are used.
2612 my( $self, %options ) = @_;
2613 return '' if $self->payby eq 'COMP';
2614 warn "$me bill customer ". $self->custnum. "\n"
2617 my $time = $options{'time'} || time;
2618 my $invoice_time = $options{'invoice_time'} || $time;
2620 $options{'not_pkgpart'} ||= {};
2621 $options{'not_pkgpart'} = { map { $_ => 1 }
2622 split(/\s*,\s*/, $options{'not_pkgpart'})
2624 unless ref($options{'not_pkgpart'});
2626 local $SIG{HUP} = 'IGNORE';
2627 local $SIG{INT} = 'IGNORE';
2628 local $SIG{QUIT} = 'IGNORE';
2629 local $SIG{TERM} = 'IGNORE';
2630 local $SIG{TSTP} = 'IGNORE';
2631 local $SIG{PIPE} = 'IGNORE';
2633 my $oldAutoCommit = $FS::UID::AutoCommit;
2634 local $FS::UID::AutoCommit = 0;
2637 $self->select_for_update; #mutex
2639 my $error = $self->do_cust_event(
2640 'debug' => ( $options{'debug'} || 0 ),
2641 'time' => $invoice_time,
2642 'check_freq' => $options{'check_freq'},
2643 'stage' => 'pre-bill',
2646 $dbh->rollback if $oldAutoCommit;
2650 my @cust_bill_pkg = ();
2653 # find the packages which are due for billing, find out how much they are
2654 # & generate invoice database.
2657 my( $total_setup, $total_recur, $postal_charge ) = ( 0, 0, 0 );
2659 my @precommit_hooks = ();
2661 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
2662 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
2664 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
2666 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2668 #? to avoid use of uninitialized value errors... ?
2669 $cust_pkg->setfield('bill', '')
2670 unless defined($cust_pkg->bill);
2672 #my $part_pkg = $cust_pkg->part_pkg;
2674 my $real_pkgpart = $cust_pkg->pkgpart;
2675 my %hash = $cust_pkg->hash;
2677 foreach my $part_pkg ( $cust_pkg->part_pkg->self_and_bill_linked ) {
2679 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
2682 $self->_make_lines( 'part_pkg' => $part_pkg,
2683 'cust_pkg' => $cust_pkg,
2684 'precommit_hooks' => \@precommit_hooks,
2685 'line_items' => \@cust_bill_pkg,
2686 'setup' => \$total_setup,
2687 'recur' => \$total_recur,
2688 'tax_matrix' => \%taxlisthash,
2690 'real_pkgpart' => $real_pkgpart,
2691 'options' => \%options,
2694 $dbh->rollback if $oldAutoCommit;
2698 } #foreach my $part_pkg
2700 } #foreach my $cust_pkg
2702 unless ( @cust_bill_pkg ) { #don't create an invoice w/o line items
2703 #but do commit any package date cycling that happened
2704 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2708 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
2709 !$conf->exists('postal_invoice-recurring_only')
2713 my $postal_pkg = $self->charge_postal_fee();
2714 if ( $postal_pkg && !ref( $postal_pkg ) ) {
2716 $dbh->rollback if $oldAutoCommit;
2717 return "can't charge postal invoice fee for customer ".
2718 $self->custnum. ": $postal_pkg";
2720 } elsif ( $postal_pkg ) {
2722 my $real_pkgpart = $postal_pkg->pkgpart;
2723 foreach my $part_pkg ( $postal_pkg->part_pkg->self_and_bill_linked ) {
2724 my %postal_options = %options;
2725 delete $postal_options{cancel};
2727 $self->_make_lines( 'part_pkg' => $part_pkg,
2728 'cust_pkg' => $postal_pkg,
2729 'precommit_hooks' => \@precommit_hooks,
2730 'line_items' => \@cust_bill_pkg,
2731 'setup' => \$total_setup,
2732 'recur' => \$total_recur,
2733 'tax_matrix' => \%taxlisthash,
2735 'real_pkgpart' => $real_pkgpart,
2736 'options' => \%postal_options,
2739 $dbh->rollback if $oldAutoCommit;
2748 warn "having a look at the taxes we found...\n" if $DEBUG > 2;
2750 # keys are tax names (as printed on invoices / itemdesc )
2751 # values are listrefs of taxlisthash keys (internal identifiers)
2754 # keys are taxlisthash keys (internal identifiers)
2755 # values are (cumulative) amounts
2758 # keys are taxlisthash keys (internal identifiers)
2759 # values are listrefs of cust_bill_pkg_tax_location hashrefs
2760 my %tax_location = ();
2762 # keys are taxlisthash keys (internal identifiers)
2763 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
2764 my %tax_rate_location = ();
2766 foreach my $tax ( keys %taxlisthash ) {
2767 my $tax_object = shift @{ $taxlisthash{$tax} };
2768 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
2769 warn " ". join('/', @{ $taxlisthash{$tax} } ). "\n" if $DEBUG > 2;
2770 my $hashref_or_error =
2771 $tax_object->taxline( $taxlisthash{$tax},
2772 'custnum' => $self->custnum,
2773 'invoice_time' => $invoice_time
2775 unless ( ref($hashref_or_error) ) {
2776 $dbh->rollback if $oldAutoCommit;
2777 return $hashref_or_error;
2779 unshift @{ $taxlisthash{$tax} }, $tax_object;
2781 my $name = $hashref_or_error->{'name'};
2782 my $amount = $hashref_or_error->{'amount'};
2784 #warn "adding $amount as $name\n";
2785 $taxname{ $name } ||= [];
2786 push @{ $taxname{ $name } }, $tax;
2788 $tax{ $tax } += $amount;
2790 $tax_location{ $tax } ||= [];
2791 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
2792 push @{ $tax_location{ $tax } },
2794 'taxnum' => $tax_object->taxnum,
2795 'taxtype' => ref($tax_object),
2796 'pkgnum' => $tax_object->get('pkgnum'),
2797 'locationnum' => $tax_object->get('locationnum'),
2798 'amount' => sprintf('%.2f', $amount ),
2802 $tax_rate_location{ $tax } ||= [];
2803 if ( ref($tax_object) eq 'FS::tax_rate' ) {
2804 my $taxratelocationnum =
2805 $tax_object->tax_rate_location->taxratelocationnum;
2806 push @{ $tax_rate_location{ $tax } },
2808 'taxnum' => $tax_object->taxnum,
2809 'taxtype' => ref($tax_object),
2810 'amount' => sprintf('%.2f', $amount ),
2811 'locationtaxid' => $tax_object->location,
2812 'taxratelocationnum' => $taxratelocationnum,
2818 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
2819 my %packagemap = map { $_->pkgnum => $_ } @cust_bill_pkg;
2820 foreach my $tax ( keys %taxlisthash ) {
2821 foreach ( @{ $taxlisthash{$tax} }[1 ... scalar(@{ $taxlisthash{$tax} })] ) {
2822 next unless ref($_) eq 'FS::cust_bill_pkg';
2824 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
2825 splice( @{ $_->_cust_tax_exempt_pkg } );
2829 #consolidate and create tax line items
2830 warn "consolidating and generating...\n" if $DEBUG > 2;
2831 foreach my $taxname ( keys %taxname ) {
2834 my @cust_bill_pkg_tax_location = ();
2835 my @cust_bill_pkg_tax_rate_location = ();
2836 warn "adding $taxname\n" if $DEBUG > 1;
2837 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
2838 next if $seen{$taxitem}++;
2839 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
2840 $tax += $tax{$taxitem};
2841 push @cust_bill_pkg_tax_location,
2842 map { new FS::cust_bill_pkg_tax_location $_ }
2843 @{ $tax_location{ $taxitem } };
2844 push @cust_bill_pkg_tax_rate_location,
2845 map { new FS::cust_bill_pkg_tax_rate_location $_ }
2846 @{ $tax_rate_location{ $taxitem } };
2850 $tax = sprintf('%.2f', $tax );
2851 $total_setup = sprintf('%.2f', $total_setup+$tax );
2853 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
2859 if ( $pkg_category and
2860 $conf->config('invoice_latexsummary') ||
2861 $conf->config('invoice_htmlsummary')
2865 my %hash = ( 'section' => $pkg_category->categoryname );
2866 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
2870 push @cust_bill_pkg, new FS::cust_bill_pkg {
2876 'itemdesc' => $taxname,
2877 'display' => \@display,
2878 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2879 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
2884 #add tax adjustments
2885 warn "adding tax adjustments...\n" if $DEBUG > 2;
2886 foreach my $cust_tax_adjustment (
2887 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
2893 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
2894 $total_setup = sprintf('%.2f', $total_setup+$tax );
2896 my $itemdesc = $cust_tax_adjustment->taxname;
2897 $itemdesc = '' if $itemdesc eq 'Tax';
2899 push @cust_bill_pkg, new FS::cust_bill_pkg {
2905 'itemdesc' => $itemdesc,
2906 'itemcomment' => $cust_tax_adjustment->comment,
2907 'cust_tax_adjustment' => $cust_tax_adjustment,
2908 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2913 my $charged = sprintf('%.2f', $total_setup + $total_recur );
2915 my @cust_bill = $self->cust_bill;
2916 my $balance = $self->balance;
2917 my $previous_balance = scalar(@cust_bill)
2918 ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
2921 $previous_balance += $cust_bill[$#cust_bill]->charged
2922 if scalar(@cust_bill);
2923 #my $balance_adjustments =
2924 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
2926 #create the new invoice
2927 my $cust_bill = new FS::cust_bill ( {
2928 'custnum' => $self->custnum,
2929 '_date' => ( $invoice_time ),
2930 'charged' => $charged,
2931 'billing_balance' => $balance,
2932 'previous_balance' => $previous_balance,
2933 'invoice_terms' => $options{'invoice_terms'},
2935 $error = $cust_bill->insert;
2937 $dbh->rollback if $oldAutoCommit;
2938 return "can't create invoice for customer #". $self->custnum. ": $error";
2941 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
2942 $cust_bill_pkg->invnum($cust_bill->invnum);
2943 my $error = $cust_bill_pkg->insert;
2945 $dbh->rollback if $oldAutoCommit;
2946 return "can't create invoice line item: $error";
2951 foreach my $hook ( @precommit_hooks ) {
2953 &{$hook}; #($self) ?
2956 $dbh->rollback if $oldAutoCommit;
2957 return "$@ running precommit hook $hook\n";
2961 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2967 my ($self, %params) = @_;
2969 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
2970 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
2971 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
2972 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
2973 my $total_setup = $params{setup} or die "no setup accumulator specified";
2974 my $total_recur = $params{recur} or die "no recur accumulator specified";
2975 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
2976 my $time = $params{'time'} or die "no time specified";
2977 my (%options) = %{$params{options}};
2980 my $real_pkgpart = $params{real_pkgpart};
2981 my %hash = $cust_pkg->hash;
2982 my $old_cust_pkg = new FS::cust_pkg \%hash;
2988 $cust_pkg->pkgpart($part_pkg->pkgpart);
2996 if ( $options{'resetup'}
2997 || ( ! $cust_pkg->setup
2998 && ( ! $cust_pkg->start_date
2999 || $cust_pkg->start_date <= $time
3001 && ( ! $conf->exists('disable_setup_suspended_pkgs')
3002 || ( $conf->exists('disable_setup_suspended_pkgs') &&
3003 ! $cust_pkg->getfield('susp')
3010 warn " bill setup\n" if $DEBUG > 1;
3013 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
3014 return "$@ running calc_setup for $cust_pkg\n"
3017 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
3019 $cust_pkg->setfield('setup', $time)
3020 unless $cust_pkg->setup;
3021 #do need it, but it won't get written to the db
3022 #|| $cust_pkg->pkgpart != $real_pkgpart;
3024 $cust_pkg->setfield('start_date', '')
3025 if $cust_pkg->start_date;
3030 # bill recurring fee
3033 #XXX unit stuff here too
3037 if ( ! $cust_pkg->get('susp')
3038 and ! $cust_pkg->get('start_date')
3039 and ( $part_pkg->getfield('freq') ne '0'
3040 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
3042 || ( $part_pkg->plan eq 'voip_cdr'
3043 && $part_pkg->option('bill_every_call')
3045 || ( $options{cancel} )
3048 # XXX should this be a package event? probably. events are called
3049 # at collection time at the moment, though...
3050 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
3051 if $part_pkg->can('reset_usage');
3052 #don't want to reset usage just cause we want a line item??
3053 #&& $part_pkg->pkgpart == $real_pkgpart;
3055 warn " bill recur\n" if $DEBUG > 1;
3058 # XXX shared with $recur_prog
3059 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
3063 #over two params! lets at least switch to a hashref for the rest...
3064 my $increment_next_bill = ( $part_pkg->freq ne '0'
3065 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
3066 && !$options{cancel}
3068 my %param = ( 'precommit_hooks' => $precommit_hooks,
3069 'increment_next_bill' => $increment_next_bill,
3072 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
3073 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
3074 return "$@ running $method for $cust_pkg\n"
3077 if ( $increment_next_bill ) {
3079 my $next_bill = $part_pkg->add_freq($sdate);
3080 return "unparsable frequency: ". $part_pkg->freq
3081 if $next_bill == -1;
3083 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
3084 # only for figuring next bill date, nothing else, so, reset $sdate again
3086 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
3087 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
3088 $cust_pkg->last_bill($sdate);
3090 $cust_pkg->setfield('bill', $next_bill );
3096 warn "\$setup is undefined" unless defined($setup);
3097 warn "\$recur is undefined" unless defined($recur);
3098 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
3101 # If there's line items, create em cust_bill_pkg records
3102 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
3107 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
3108 # hmm.. and if just the options are modified in some weird price plan?
3110 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
3113 my $error = $cust_pkg->replace( $old_cust_pkg,
3114 'options' => { $cust_pkg->options },
3116 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
3117 if $error; #just in case
3120 $setup = sprintf( "%.2f", $setup );
3121 $recur = sprintf( "%.2f", $recur );
3122 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
3123 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
3125 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
3126 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
3129 if ( $setup != 0 || $recur != 0 ) {
3131 warn " charges (setup=$setup, recur=$recur); adding line items\n"
3134 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
3136 warn " adding customer package invoice detail: $_\n"
3137 foreach @cust_pkg_detail;
3139 push @details, @cust_pkg_detail;
3141 my $cust_bill_pkg = new FS::cust_bill_pkg {
3142 'pkgnum' => $cust_pkg->pkgnum,
3144 'unitsetup' => $unitsetup,
3146 'unitrecur' => $unitrecur,
3147 'quantity' => $cust_pkg->quantity,
3148 'details' => \@details,
3149 'hidden' => $part_pkg->hidden,
3152 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
3153 $cust_bill_pkg->sdate( $hash{last_bill} );
3154 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
3155 $cust_bill_pkg->edate( $time ) if $options{cancel};
3156 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
3157 $cust_bill_pkg->sdate( $sdate );
3158 $cust_bill_pkg->edate( $cust_pkg->bill );
3159 #$cust_bill_pkg->edate( $time ) if $options{cancel};
3162 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
3163 unless $part_pkg->pkgpart == $real_pkgpart;
3165 $$total_setup += $setup;
3166 $$total_recur += $recur;
3173 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
3174 return $error if $error;
3176 push @$cust_bill_pkgs, $cust_bill_pkg;
3178 } #if $setup != 0 || $recur != 0
3188 my $part_pkg = shift;
3189 my $taxlisthash = shift;
3190 my $cust_bill_pkg = shift;
3191 my $cust_pkg = shift;
3192 my $invoice_time = shift;
3193 my $real_pkgpart = shift;
3194 my $options = shift;
3196 my %cust_bill_pkg = ();
3200 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
3201 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
3202 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
3203 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
3205 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
3207 if ( $conf->exists('enable_taxproducts')
3208 && ( scalar($part_pkg->part_pkg_taxoverride)
3209 || $part_pkg->has_taxproduct
3214 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3215 return "fatal: Can't (yet) use tax-pkg_address with taxproducts";
3218 foreach my $class (@classes) {
3219 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class );
3220 return $err_or_ref unless ref($err_or_ref);
3221 $taxes{$class} = $err_or_ref;
3224 unless (exists $taxes{''}) {
3225 my $err_or_ref = $self->_gather_taxes( $part_pkg, '' );
3226 return $err_or_ref unless ref($err_or_ref);
3227 $taxes{''} = $err_or_ref;
3232 my @loc_keys = qw( state county country );
3234 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3235 my $cust_location = $cust_pkg->cust_location;
3236 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
3239 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
3242 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
3245 $taxhash{'taxclass'} = $part_pkg->taxclass;
3247 my @taxes = qsearch( 'cust_main_county', \%taxhash );
3249 my %taxhash_elim = %taxhash;
3251 my @elim = qw( taxclass county state );
3252 while ( !scalar(@taxes) && scalar(@elim) ) {
3253 $taxhash_elim{ shift(@elim) } = '';
3254 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
3257 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
3259 if $self->cust_main_exemption; #just to be safe
3261 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3263 $_->set('pkgnum', $cust_pkg->pkgnum );
3264 $_->set('locationnum', $cust_pkg->locationnum );
3268 $taxes{''} = [ @taxes ];
3269 $taxes{'setup'} = [ @taxes ];
3270 $taxes{'recur'} = [ @taxes ];
3271 $taxes{$_} = [ @taxes ] foreach (@classes);
3273 # # maybe eliminate this entirely, along with all the 0% records
3274 # unless ( @taxes ) {
3276 # "fatal: can't find tax rate for state/county/country/taxclass ".
3277 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
3280 } #if $conf->exists('enable_taxproducts') ...
3285 my $separate = $conf->exists('separate_usage');
3286 my $usage_mandate = $cust_pkg->part_pkg->option('usage_mandate', 'Hush!');
3287 if ( $separate || $cust_bill_pkg->hidden || $usage_mandate ) {
3289 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
3290 my %hash = $cust_bill_pkg->hidden # maybe for all bill linked?
3291 ? ( 'section' => $temp_pkg->part_pkg->categoryname )
3294 my $section = $cust_pkg->part_pkg->option('usage_section', 'Hush!');
3295 my $summary = $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
3297 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3298 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
3300 push @display, new FS::cust_bill_pkg_display
3303 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
3307 if ($separate && $section && $summary) {
3308 push @display, new FS::cust_bill_pkg_display { type => 'U',
3313 if ($usage_mandate || $section && $summary) {
3314 $hash{post_total} = 'Y';
3317 $hash{section} = $section if ($separate || $usage_mandate);
3318 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
3321 $cust_bill_pkg->set('display', \@display);
3323 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
3324 foreach my $key (keys %tax_cust_bill_pkg) {
3325 my @taxes = @{ $taxes{$key} || [] };
3326 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
3328 my %localtaxlisthash = ();
3329 foreach my $tax ( @taxes ) {
3331 my $taxname = ref( $tax ). ' '. $tax->taxnum;
3332 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
3333 # ' locationnum'. $cust_pkg->locationnum
3334 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
3336 $taxlisthash->{ $taxname } ||= [ $tax ];
3337 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
3339 $localtaxlisthash{ $taxname } ||= [ $tax ];
3340 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
3344 warn "finding taxed taxes...\n" if $DEBUG > 2;
3345 foreach my $tax ( keys %localtaxlisthash ) {
3346 my $tax_object = shift @{ $localtaxlisthash{$tax} };
3347 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
3349 next unless $tax_object->can('tax_on_tax');
3351 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
3352 my $totname = ref( $tot ). ' '. $tot->taxnum;
3354 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
3356 next unless exists( $localtaxlisthash{ $totname } ); # only increase
3358 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
3359 my $hashref_or_error =
3360 $tax_object->taxline( $localtaxlisthash{$tax},
3361 'custnum' => $self->custnum,
3362 'invoice_time' => $invoice_time,
3364 return $hashref_or_error
3365 unless ref($hashref_or_error);
3367 $taxlisthash->{ $totname } ||= [ $tot ];
3368 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
3380 my $part_pkg = shift;
3384 my $geocode = $self->geocode('cch');
3386 my @taxclassnums = map { $_->taxclassnum }
3387 $part_pkg->part_pkg_taxoverride($class);
3389 unless (@taxclassnums) {
3390 @taxclassnums = map { $_->taxclassnum }
3391 grep { $_->taxable eq 'Y' }
3392 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
3394 warn "Found taxclassnum values of ". join(',', @taxclassnums)
3399 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
3401 @taxes = qsearch({ 'table' => 'tax_rate',
3402 'hashref' => { 'geocode' => $geocode, },
3403 'extra_sql' => $extra_sql,
3405 if scalar(@taxclassnums);
3407 warn "Found taxes ".
3408 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
3415 =item collect [ HASHREF | OPTION => VALUE ... ]
3417 (Attempt to) collect money for this customer's outstanding invoices (see
3418 L<FS::cust_bill>). Usually used after the bill method.
3420 Actions are now triggered by billing events; see L<FS::part_event> and the
3421 billing events web interface. Old-style invoice events (see
3422 L<FS::part_bill_event>) have been deprecated.
3424 If there is an error, returns the error, otherwise returns false.
3426 Options are passed as name-value pairs.
3428 Currently available options are:
3434 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.
3438 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3442 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3446 set true to surpress email card/ACH decline notices.
3450 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)
3456 # allows for one time override of normal customer billing method
3461 my( $self, %options ) = @_;
3462 my $invoice_time = $options{'invoice_time'} || time;
3465 local $SIG{HUP} = 'IGNORE';
3466 local $SIG{INT} = 'IGNORE';
3467 local $SIG{QUIT} = 'IGNORE';
3468 local $SIG{TERM} = 'IGNORE';
3469 local $SIG{TSTP} = 'IGNORE';
3470 local $SIG{PIPE} = 'IGNORE';
3472 my $oldAutoCommit = $FS::UID::AutoCommit;
3473 local $FS::UID::AutoCommit = 0;
3476 $self->select_for_update; #mutex
3479 my $balance = $self->balance;
3480 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
3483 if ( exists($options{'retry_card'}) ) {
3484 carp 'retry_card option passed to collect is deprecated; use retry';
3485 $options{'retry'} ||= $options{'retry_card'};
3487 if ( exists($options{'retry'}) && $options{'retry'} ) {
3488 my $error = $self->retry_realtime;
3490 $dbh->rollback if $oldAutoCommit;
3495 my $error = $self->do_cust_event(
3496 'debug' => ( $options{'debug'} || 0 ),
3497 'time' => $invoice_time,
3498 'check_freq' => $options{'check_freq'},
3499 'stage' => 'collect',
3502 $dbh->rollback if $oldAutoCommit;
3506 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3511 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
3513 Runs billing events; see L<FS::part_event> and the billing events web
3516 If there is an error, returns the error, otherwise returns false.
3518 Options are passed as name-value pairs.
3520 Currently available options are:
3526 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.
3530 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3534 "collect" (the default) or "pre-bill"
3538 set true to surpress email card/ACH decline notices.
3542 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)
3548 # allows for one time override of normal customer billing method
3552 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3555 my( $self, %options ) = @_;
3556 my $time = $options{'time'} || time;
3559 local $SIG{HUP} = 'IGNORE';
3560 local $SIG{INT} = 'IGNORE';
3561 local $SIG{QUIT} = 'IGNORE';
3562 local $SIG{TERM} = 'IGNORE';
3563 local $SIG{TSTP} = 'IGNORE';
3564 local $SIG{PIPE} = 'IGNORE';
3566 my $oldAutoCommit = $FS::UID::AutoCommit;
3567 local $FS::UID::AutoCommit = 0;
3570 $self->select_for_update; #mutex
3573 my $balance = $self->balance;
3574 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
3577 # if ( exists($options{'retry_card'}) ) {
3578 # carp 'retry_card option passed to collect is deprecated; use retry';
3579 # $options{'retry'} ||= $options{'retry_card'};
3581 # if ( exists($options{'retry'}) && $options{'retry'} ) {
3582 # my $error = $self->retry_realtime;
3584 # $dbh->rollback if $oldAutoCommit;
3589 # false laziness w/pay_batch::import_results
3591 my $due_cust_event = $self->due_cust_event(
3592 'debug' => ( $options{'debug'} || 0 ),
3594 'check_freq' => $options{'check_freq'},
3595 'stage' => ( $options{'stage'} || 'collect' ),
3597 unless( ref($due_cust_event) ) {
3598 $dbh->rollback if $oldAutoCommit;
3599 return $due_cust_event;
3602 foreach my $cust_event ( @$due_cust_event ) {
3606 #re-eval event conditions (a previous event could have changed things)
3607 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
3608 #don't leave stray "new/locked" records around
3609 my $error = $cust_event->delete;
3611 #gah, even with transactions
3612 $dbh->commit if $oldAutoCommit; #well.
3619 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
3620 warn " running cust_event ". $cust_event->eventnum. "\n"
3624 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
3625 if ( my $error = $cust_event->do_event() ) {
3626 #XXX wtf is this? figure out a proper dealio with return value
3628 # gah, even with transactions.
3629 $dbh->commit if $oldAutoCommit; #well.
3636 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3641 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
3643 Inserts database records for and returns an ordered listref of new events due
3644 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
3645 events are due, an empty listref is returned. If there is an error, returns a
3646 scalar error message.
3648 To actually run the events, call each event's test_condition method, and if
3649 still true, call the event's do_event method.
3651 Options are passed as a hashref or as a list of name-value pairs. Available
3658 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.
3662 "collect" (the default) or "pre-bill"
3666 "Current time" for the events.
3670 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)
3674 Only return events for the specified eventtable (by default, events of all eventtables are returned)
3678 Explicitly pass the objects to be tested (typically used with eventtable).
3682 Set to true to return the objects, but not actually insert them into the
3689 sub due_cust_event {
3691 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
3694 #my $DEBUG = $opt{'debug'}
3695 local($DEBUG) = $opt{'debug'}
3696 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
3698 warn "$me due_cust_event called with options ".
3699 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
3702 $opt{'time'} ||= time;
3704 local $SIG{HUP} = 'IGNORE';
3705 local $SIG{INT} = 'IGNORE';
3706 local $SIG{QUIT} = 'IGNORE';
3707 local $SIG{TERM} = 'IGNORE';
3708 local $SIG{TSTP} = 'IGNORE';
3709 local $SIG{PIPE} = 'IGNORE';
3711 my $oldAutoCommit = $FS::UID::AutoCommit;
3712 local $FS::UID::AutoCommit = 0;
3715 $self->select_for_update #mutex
3716 unless $opt{testonly};
3719 # find possible events (initial search)
3722 my @cust_event = ();
3724 my @eventtable = $opt{'eventtable'}
3725 ? ( $opt{'eventtable'} )
3726 : FS::part_event->eventtables_runorder;
3728 foreach my $eventtable ( @eventtable ) {
3731 if ( $opt{'objects'} ) {
3733 @objects = @{ $opt{'objects'} };
3737 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
3738 @objects = ( $eventtable eq 'cust_main' )
3740 : ( $self->$eventtable() );
3744 my @e_cust_event = ();
3746 my $cross = "CROSS JOIN $eventtable";
3747 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
3748 unless $eventtable eq 'cust_main';
3750 foreach my $object ( @objects ) {
3752 #this first search uses the condition_sql magic for optimization.
3753 #the more possible events we can eliminate in this step the better
3755 my $cross_where = '';
3756 my $pkey = $object->primary_key;
3757 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
3759 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
3761 FS::part_event_condition->where_conditions_sql( $eventtable,
3762 'time'=>$opt{'time'}
3764 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
3766 $extra_sql = "AND $extra_sql" if $extra_sql;
3768 #here is the agent virtualization
3769 $extra_sql .= " AND ( part_event.agentnum IS NULL
3770 OR part_event.agentnum = ". $self->agentnum. ' )';
3772 $extra_sql .= " $order";
3774 warn "searching for events for $eventtable ". $object->$pkey. "\n"
3775 if $opt{'debug'} > 2;
3776 my @part_event = qsearch( {
3777 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
3778 'select' => 'part_event.*',
3779 'table' => 'part_event',
3780 'addl_from' => "$cross $join",
3781 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
3782 'eventtable' => $eventtable,
3785 'extra_sql' => "AND $cross_where $extra_sql",
3789 my $pkey = $object->primary_key;
3790 warn " ". scalar(@part_event).
3791 " possible events found for $eventtable ". $object->$pkey(). "\n";
3794 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
3798 warn " ". scalar(@e_cust_event).
3799 " subtotal possible cust events found for $eventtable\n"
3802 push @cust_event, @e_cust_event;
3806 warn " ". scalar(@cust_event).
3807 " total possible cust events found in initial search\n"
3815 $opt{stage} ||= 'collect';
3817 grep { my $stage = $_->part_event->event_stage;
3818 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
3828 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
3829 'stats_hashref' => \%unsat ),
3832 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
3835 warn " invalid conditions not eliminated with condition_sql:\n".
3836 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
3837 if keys %unsat && $DEBUG; # > 1;
3843 unless( $opt{testonly} ) {
3844 foreach my $cust_event ( @cust_event ) {
3846 my $error = $cust_event->insert();
3848 $dbh->rollback if $oldAutoCommit;
3855 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3861 warn " returning events: ". Dumper(@cust_event). "\n"
3868 =item retry_realtime
3870 Schedules realtime / batch credit card / electronic check / LEC billing
3871 events for for retry. Useful if card information has changed or manual
3872 retry is desired. The 'collect' method must be called to actually retry
3875 Implementation details: For either this customer, or for each of this
3876 customer's open invoices, changes the status of the first "done" (with
3877 statustext error) realtime processing event to "failed".
3881 sub retry_realtime {
3884 local $SIG{HUP} = 'IGNORE';
3885 local $SIG{INT} = 'IGNORE';
3886 local $SIG{QUIT} = 'IGNORE';
3887 local $SIG{TERM} = 'IGNORE';
3888 local $SIG{TSTP} = 'IGNORE';
3889 local $SIG{PIPE} = 'IGNORE';
3891 my $oldAutoCommit = $FS::UID::AutoCommit;
3892 local $FS::UID::AutoCommit = 0;
3895 #a little false laziness w/due_cust_event (not too bad, really)
3897 my $join = FS::part_event_condition->join_conditions_sql;
3898 my $order = FS::part_event_condition->order_conditions_sql;
3901 . join ( ' OR ' , map {
3902 "( part_event.eventtable = " . dbh->quote($_)
3903 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
3904 } FS::part_event->eventtables)
3907 #here is the agent virtualization
3908 my $agent_virt = " ( part_event.agentnum IS NULL
3909 OR part_event.agentnum = ". $self->agentnum. ' )';
3911 #XXX this shouldn't be hardcoded, actions should declare it...
3912 my @realtime_events = qw(
3913 cust_bill_realtime_card
3914 cust_bill_realtime_check
3915 cust_bill_realtime_lec
3919 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
3924 my @cust_event = qsearchs({
3925 'table' => 'cust_event',
3926 'select' => 'cust_event.*',
3927 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
3928 'hashref' => { 'status' => 'done' },
3929 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
3930 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
3933 my %seen_invnum = ();
3934 foreach my $cust_event (@cust_event) {
3936 #max one for the customer, one for each open invoice
3937 my $cust_X = $cust_event->cust_X;
3938 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
3942 or $cust_event->part_event->eventtable eq 'cust_bill'
3945 my $error = $cust_event->retry;
3947 $dbh->rollback if $oldAutoCommit;
3948 return "error scheduling event for retry: $error";
3953 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3958 # some horrid false laziness here to avoid refactor fallout
3959 # eventually realtime realtime_bop and realtime_refund_bop should go
3960 # away and be replaced by _new_realtime_bop and _new_realtime_refund_bop
3962 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
3964 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
3965 via a Business::OnlinePayment realtime gateway. See
3966 L<http://420.am/business-onlinepayment> for supported gateways.
3968 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3970 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
3972 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3973 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3974 if set, will override the value from the customer record.
3976 I<description> is a free-text field passed to the gateway. It defaults to
3977 the value defined by the business-onlinepayment-description configuration
3978 option, or "Internet services" if that is unset.
3980 If an I<invnum> is specified, this payment (if successful) is applied to the
3981 specified invoice. If you don't specify an I<invnum> you might want to
3982 call the B<apply_payments> method or set the I<apply> option.
3984 I<apply> can be set to true to apply a resulting payment.
3986 I<quiet> can be set true to surpress email decline notices.
3988 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
3989 resulting paynum, if any.
3991 I<payunique> is a unique identifier for this payment.
3993 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
4000 return $self->_new_realtime_bop(@_)
4001 if $self->_new_bop_required();
4003 my($method, $amount);
4005 if (ref($_[0]) eq 'HASH') {
4006 %options = %{$_[0]};
4007 $method = $options{method};
4008 $amount = $options{amount};
4010 ( $method, $amount ) = ( shift, shift );
4014 warn "$me realtime_bop: $method $amount\n";
4015 warn " $_ => $options{$_}\n" foreach keys %options;
4018 return "Amount must be greater than 0" unless $amount > 0;
4020 unless ( $options{'description'} ) {
4021 if ( $conf->exists('business-onlinepayment-description') ) {
4022 my $dtempl = $conf->config('business-onlinepayment-description');
4024 my $agent = $self->agent->agent;
4026 $options{'description'} = eval qq("$dtempl");
4028 $options{'description'} = 'Internet services';
4032 return $self->fake_bop($method, $amount, %options) if $options{'fake'};
4034 eval "use Business::OnlinePayment";
4037 my $payinfo = exists($options{'payinfo'})
4038 ? $options{'payinfo'}
4041 my %method2payby = (
4048 # check for banned credit card/ACH
4051 my $ban = qsearchs('banned_pay', {
4052 'payby' => $method2payby{$method},
4053 'payinfo' => md5_base64($payinfo),
4055 return "Banned credit card" if $ban;
4058 # set taxclass and trans_is_recur based on invnum if there is one
4062 my $trans_is_recur = 0;
4063 if ( $options{'invnum'} ) {
4065 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
4066 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
4069 map { $_->part_pkg }
4071 map { $_->cust_pkg }
4072 $cust_bill->cust_bill_pkg;
4074 my @taxclasses = map $_->taxclass, @part_pkg;
4075 $taxclass = $taxclasses[0]
4076 unless grep { $taxclasses[0] ne $_ } @taxclasses; #unless there are
4077 #different taxclasses
4079 if grep { $_->freq ne '0' } @part_pkg;
4087 #look for an agent gateway override first
4089 if ( $method eq 'CC' ) {
4090 $cardtype = cardtype($payinfo);
4091 } elsif ( $method eq 'ECHECK' ) {
4094 $cardtype = $method;
4098 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4099 cardtype => $cardtype,
4100 taxclass => $taxclass, } )
4101 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4103 taxclass => $taxclass, } )
4104 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4105 cardtype => $cardtype,
4107 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4109 taxclass => '', } );
4111 my $payment_gateway = '';
4112 my( $processor, $login, $password, $action, @bop_options );
4113 if ( $override ) { #use a payment gateway override
4115 $payment_gateway = $override->payment_gateway;
4117 $processor = $payment_gateway->gateway_module;
4118 $login = $payment_gateway->gateway_username;
4119 $password = $payment_gateway->gateway_password;
4120 $action = $payment_gateway->gateway_action;
4121 @bop_options = $payment_gateway->options;
4123 } else { #use the standard settings from the config
4125 ( $processor, $login, $password, $action, @bop_options ) =
4126 $self->default_payment_gateway($method);
4134 my $address = exists($options{'address1'})
4135 ? $options{'address1'}
4137 my $address2 = exists($options{'address2'})
4138 ? $options{'address2'}
4140 $address .= ", ". $address2 if length($address2);
4142 my $o_payname = exists($options{'payname'})
4143 ? $options{'payname'}
4145 my($payname, $payfirst, $paylast);
4146 if ( $o_payname && $method ne 'ECHECK' ) {
4147 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4148 or return "Illegal payname $payname";
4149 ($payfirst, $paylast) = ($1, $2);
4151 $payfirst = $self->getfield('first');
4152 $paylast = $self->getfield('last');
4153 $payname = "$payfirst $paylast";
4156 my @invoicing_list = $self->invoicing_list_emailonly;
4157 if ( $conf->exists('emailinvoiceautoalways')
4158 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4159 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4160 push @invoicing_list, $self->all_emails;
4163 my $email = ($conf->exists('business-onlinepayment-email-override'))
4164 ? $conf->config('business-onlinepayment-email-override')
4165 : $invoicing_list[0];
4169 my $payip = exists($options{'payip'})
4172 $content{customer_ip} = $payip
4175 $content{invoice_number} = $options{'invnum'}
4176 if exists($options{'invnum'}) && length($options{'invnum'});
4178 $content{email_customer} =
4179 ( $conf->exists('business-onlinepayment-email_customer')
4180 || $conf->exists('business-onlinepayment-email-override') );
4183 if ( $method eq 'CC' ) {
4185 $content{card_number} = $payinfo;
4186 $paydate = exists($options{'paydate'})
4187 ? $options{'paydate'}
4189 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4190 $content{expiration} = "$2/$1";
4192 my $paycvv = exists($options{'paycvv'})
4193 ? $options{'paycvv'}
4195 $content{cvv2} = $paycvv
4198 my $paystart_month = exists($options{'paystart_month'})
4199 ? $options{'paystart_month'}
4200 : $self->paystart_month;
4202 my $paystart_year = exists($options{'paystart_year'})
4203 ? $options{'paystart_year'}
4204 : $self->paystart_year;
4206 $content{card_start} = "$paystart_month/$paystart_year"
4207 if $paystart_month && $paystart_year;
4209 my $payissue = exists($options{'payissue'})
4210 ? $options{'payissue'}
4212 $content{issue_number} = $payissue if $payissue;
4214 if ( $self->_bop_recurring_billing( 'payinfo' => $payinfo,
4215 'trans_is_recur' => $trans_is_recur,
4219 $content{recurring_billing} = 'YES';
4220 $content{acct_code} = 'rebill'
4221 if $conf->exists('credit_card-recurring_billing_acct_code');
4224 } elsif ( $method eq 'ECHECK' ) {
4225 ( $content{account_number}, $content{routing_code} ) =
4226 split('@', $payinfo);
4227 $content{bank_name} = $o_payname;
4228 $content{bank_state} = exists($options{'paystate'})
4229 ? $options{'paystate'}
4230 : $self->getfield('paystate');
4231 $content{account_type} = exists($options{'paytype'})
4232 ? uc($options{'paytype'}) || 'CHECKING'
4233 : uc($self->getfield('paytype')) || 'CHECKING';
4234 $content{account_name} = $payname;
4235 $content{customer_org} = $self->company ? 'B' : 'I';
4236 $content{state_id} = exists($options{'stateid'})
4237 ? $options{'stateid'}
4238 : $self->getfield('stateid');
4239 $content{state_id_state} = exists($options{'stateid_state'})
4240 ? $options{'stateid_state'}
4241 : $self->getfield('stateid_state');
4242 $content{customer_ssn} = exists($options{'ss'})
4245 } elsif ( $method eq 'LEC' ) {
4246 $content{phone} = $payinfo;
4250 # run transaction(s)
4253 my $balance = exists( $options{'balance'} )
4254 ? $options{'balance'}
4257 $self->select_for_update; #mutex ... just until we get our pending record in
4259 #the checks here are intended to catch concurrent payments
4260 #double-form-submission prevention is taken care of in cust_pay_pending::check
4263 return "The customer's balance has changed; $method transaction aborted."
4264 if $self->balance < $balance;
4265 #&& $self->balance < $amount; #might as well anyway?
4267 #also check and make sure there aren't *other* pending payments for this cust
4269 my @pending = qsearch('cust_pay_pending', {
4270 'custnum' => $self->custnum,
4271 'status' => { op=>'!=', value=>'done' }
4273 return "A payment is already being processed for this customer (".
4274 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
4275 "); $method transaction aborted."
4276 if scalar(@pending);
4278 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
4280 my $cust_pay_pending = new FS::cust_pay_pending {
4281 'custnum' => $self->custnum,
4282 #'invnum' => $options{'invnum'},
4285 'payby' => $method2payby{$method},
4286 'payinfo' => $payinfo,
4287 'paydate' => $paydate,
4288 'recurring_billing' => $content{recurring_billing},
4289 'pkgnum' => $options{'pkgnum'},
4291 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
4293 $cust_pay_pending->payunique( $options{payunique} )
4294 if defined($options{payunique}) && length($options{payunique});
4295 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
4296 return $cpp_new_err if $cpp_new_err;
4298 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
4300 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
4301 $transaction->content(
4304 'password' => $password,
4305 'action' => $action1,
4306 'description' => $options{'description'},
4307 'amount' => $amount,
4308 #'invoice_number' => $options{'invnum'},
4309 'customer_id' => $self->custnum,
4310 'last_name' => $paylast,
4311 'first_name' => $payfirst,
4313 'address' => $address,
4314 'city' => ( exists($options{'city'})
4317 'state' => ( exists($options{'state'})
4320 'zip' => ( exists($options{'zip'})
4323 'country' => ( exists($options{'country'})
4324 ? $options{'country'}
4326 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4328 'phone' => $self->daytime || $self->night,
4332 $cust_pay_pending->status('pending');
4333 my $cpp_pending_err = $cust_pay_pending->replace;
4334 return $cpp_pending_err if $cpp_pending_err;
4337 my $BOP_TESTING = 0;
4338 my $BOP_TESTING_SUCCESS = 1;
4340 unless ( $BOP_TESTING ) {
4341 $transaction->submit();
4343 if ( $BOP_TESTING_SUCCESS ) {
4344 $transaction->is_success(1);
4345 $transaction->authorization('fake auth');
4347 $transaction->is_success(0);
4348 $transaction->error_message('fake failure');
4352 if ( $transaction->is_success() && $action2 ) {
4354 $cust_pay_pending->status('authorized');
4355 my $cpp_authorized_err = $cust_pay_pending->replace;
4356 return $cpp_authorized_err if $cpp_authorized_err;
4358 my $auth = $transaction->authorization;
4359 my $ordernum = $transaction->can('order_number')
4360 ? $transaction->order_number
4364 new Business::OnlinePayment( $processor, @bop_options );
4371 password => $password,
4372 order_number => $ordernum,
4374 authorization => $auth,
4375 description => $options{'description'},
4378 foreach my $field (qw( authorization_source_code returned_ACI
4379 transaction_identifier validation_code
4380 transaction_sequence_num local_transaction_date
4381 local_transaction_time AVS_result_code )) {
4382 $capture{$field} = $transaction->$field() if $transaction->can($field);
4385 $capture->content( %capture );
4389 unless ( $capture->is_success ) {
4390 my $e = "Authorization successful but capture failed, custnum #".
4391 $self->custnum. ': '. $capture->result_code.
4392 ": ". $capture->error_message;
4399 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
4400 my $cpp_captured_err = $cust_pay_pending->replace;
4401 return $cpp_captured_err if $cpp_captured_err;
4404 # remove paycvv after initial transaction
4407 #false laziness w/misc/process/payment.cgi - check both to make sure working
4409 if ( defined $self->dbdef_table->column('paycvv')
4410 && length($self->paycvv)
4411 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
4413 my $error = $self->remove_cvv;
4415 warn "WARNING: error removing cvv: $error\n";
4423 if ( $transaction->is_success() ) {
4426 if ( $payment_gateway ) { # agent override
4427 $paybatch = $payment_gateway->gatewaynum. '-';
4430 $paybatch .= "$processor:". $transaction->authorization;
4432 $paybatch .= ':'. $transaction->order_number
4433 if $transaction->can('order_number')
4434 && length($transaction->order_number);
4436 my $cust_pay = new FS::cust_pay ( {
4437 'custnum' => $self->custnum,
4438 'invnum' => $options{'invnum'},
4441 'payby' => $method2payby{$method},
4442 'payinfo' => $payinfo,
4443 'paybatch' => $paybatch,
4444 'paydate' => $paydate,
4445 'pkgnum' => $options{'pkgnum'},
4447 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
4448 $cust_pay->payunique( $options{payunique} )
4449 if defined($options{payunique}) && length($options{payunique});
4451 my $oldAutoCommit = $FS::UID::AutoCommit;
4452 local $FS::UID::AutoCommit = 0;
4455 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
4457 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
4460 $cust_pay->invnum(''); #try again with no specific invnum
4461 my $error2 = $cust_pay->insert( $options{'manual'} ?
4462 ( 'manual' => 1 ) : ()
4465 # gah. but at least we have a record of the state we had to abort in
4466 # from cust_pay_pending now.
4467 my $e = "WARNING: $method captured but payment not recorded - ".
4468 "error inserting payment ($processor): $error2".
4469 " (previously tried insert with invnum #$options{'invnum'}" .
4470 ": $error ) - pending payment saved as paypendingnum ".
4471 $cust_pay_pending->paypendingnum. "\n";
4477 if ( $options{'paynum_ref'} ) {
4478 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
4481 $cust_pay_pending->status('done');
4482 $cust_pay_pending->statustext('captured');
4483 $cust_pay_pending->paynum($cust_pay->paynum);
4484 my $cpp_done_err = $cust_pay_pending->replace;
4486 if ( $cpp_done_err ) {
4488 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4489 my $e = "WARNING: $method captured but payment not recorded - ".
4490 "error updating status for paypendingnum ".
4491 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4497 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4499 if ( $options{'apply'} ) {
4500 my $apply_error = $self->apply_payments_and_credits;
4501 if ( $apply_error ) {
4502 warn "WARNING: error applying payment: $apply_error\n";
4503 #but we still should return no error cause the payment otherwise went
4508 return ''; #no error
4514 my $perror = "$processor error: ". $transaction->error_message;
4516 unless ( $transaction->error_message ) {
4519 if ( $transaction->can('response_page') ) {
4521 'page' => ( $transaction->can('response_page')
4522 ? $transaction->response_page
4525 'code' => ( $transaction->can('response_code')
4526 ? $transaction->response_code
4529 'headers' => ( $transaction->can('response_headers')
4530 ? $transaction->response_headers
4536 "No additional debugging information available for $processor";
4539 $perror .= "No error_message returned from $processor -- ".
4540 ( ref($t_response) ? Dumper($t_response) : $t_response );
4544 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
4545 && $conf->exists('emaildecline')
4546 && grep { $_ ne 'POST' } $self->invoicing_list
4547 && ! grep { $transaction->error_message =~ /$_/ }
4548 $conf->config('emaildecline-exclude')
4550 my @templ = $conf->config('declinetemplate');
4551 my $template = new Text::Template (
4553 SOURCE => [ map "$_\n", @templ ],
4554 ) or return "($perror) can't create template: $Text::Template::ERROR";
4555 $template->compile()
4556 or return "($perror) can't compile template: $Text::Template::ERROR";
4560 scalar( $conf->config('company_name', $self->agentnum ) ),
4561 'company_address' =>
4562 join("\n", $conf->config('company_address', $self->agentnum ) ),
4563 'error' => $transaction->error_message,
4566 my $error = send_email(
4567 'from' => $conf->config('invoice_from', $self->agentnum ),
4568 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
4569 'subject' => 'Your payment could not be processed',
4570 'body' => [ $template->fill_in(HASH => $templ_hash) ],
4573 $perror .= " (also received error sending decline notification: $error)"
4578 $cust_pay_pending->status('done');
4579 $cust_pay_pending->statustext("declined: $perror");
4580 my $cpp_done_err = $cust_pay_pending->replace;
4581 if ( $cpp_done_err ) {
4582 my $e = "WARNING: $method declined but pending payment not resolved - ".
4583 "error updating status for paypendingnum ".
4584 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4586 $perror = "$e ($perror)";
4594 sub _bop_recurring_billing {
4595 my( $self, %opt ) = @_;
4597 my $method = scalar($conf->config('credit_card-recurring_billing_flag'));
4599 if ( defined($method) && $method eq 'transaction_is_recur' ) {
4601 return 1 if $opt{'trans_is_recur'};
4605 my %hash = ( 'custnum' => $self->custnum,
4610 if qsearch('cust_pay', { %hash, 'payinfo' => $opt{'payinfo'} } )
4611 || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo('CARD',
4622 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
4624 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
4625 via a Business::OnlinePayment realtime gateway. See
4626 L<http://420.am/business-onlinepayment> for supported gateways.
4628 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4630 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
4632 Most gateways require a reference to an original payment transaction to refund,
4633 so you probably need to specify a I<paynum>.
4635 I<amount> defaults to the original amount of the payment if not specified.
4637 I<reason> specifies a reason for the refund.
4639 I<paydate> specifies the expiration date for a credit card overriding the
4640 value from the customer record or the payment record. Specified as yyyy-mm-dd
4642 Implementation note: If I<amount> is unspecified or equal to the amount of the
4643 orignal payment, first an attempt is made to "void" the transaction via
4644 the gateway (to cancel a not-yet settled transaction) and then if that fails,
4645 the normal attempt is made to "refund" ("credit") the transaction via the
4646 gateway is attempted.
4648 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4649 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4650 #if set, will override the value from the customer record.
4652 #If an I<invnum> is specified, this payment (if successful) is applied to the
4653 #specified invoice. If you don't specify an I<invnum> you might want to
4654 #call the B<apply_payments> method.
4658 #some false laziness w/realtime_bop, not enough to make it worth merging
4659 #but some useful small subs should be pulled out
4660 sub realtime_refund_bop {
4663 return $self->_new_realtime_refund_bop(@_)
4664 if $self->_new_bop_required();
4666 my( $method, %options ) = @_;
4668 warn "$me realtime_refund_bop: $method refund\n";
4669 warn " $_ => $options{$_}\n" foreach keys %options;
4672 eval "use Business::OnlinePayment";
4676 # look up the original payment and optionally a gateway for that payment
4680 my $amount = $options{'amount'};
4682 my( $processor, $login, $password, @bop_options ) ;
4683 my( $auth, $order_number ) = ( '', '', '' );
4685 if ( $options{'paynum'} ) {
4687 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
4688 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
4689 or return "Unknown paynum $options{'paynum'}";
4690 $amount ||= $cust_pay->paid;
4692 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
4693 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
4694 $cust_pay->paybatch;
4695 my $gatewaynum = '';
4696 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
4698 if ( $gatewaynum ) { #gateway for the payment to be refunded
4700 my $payment_gateway =
4701 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
4702 die "payment gateway $gatewaynum not found"
4703 unless $payment_gateway;
4705 $processor = $payment_gateway->gateway_module;
4706 $login = $payment_gateway->gateway_username;
4707 $password = $payment_gateway->gateway_password;
4708 @bop_options = $payment_gateway->options;
4710 } else { #try the default gateway
4712 my( $conf_processor, $unused_action );
4713 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
4714 $self->default_payment_gateway($method);
4716 return "processor of payment $options{'paynum'} $processor does not".
4717 " match default processor $conf_processor"
4718 unless $processor eq $conf_processor;
4723 } else { # didn't specify a paynum, so look for agent gateway overrides
4724 # like a normal transaction
4727 if ( $method eq 'CC' ) {
4728 $cardtype = cardtype($self->payinfo);
4729 } elsif ( $method eq 'ECHECK' ) {
4732 $cardtype = $method;
4735 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4736 cardtype => $cardtype,
4738 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4740 taxclass => '', } );
4742 if ( $override ) { #use a payment gateway override
4744 my $payment_gateway = $override->payment_gateway;
4746 $processor = $payment_gateway->gateway_module;
4747 $login = $payment_gateway->gateway_username;
4748 $password = $payment_gateway->gateway_password;
4749 #$action = $payment_gateway->gateway_action;
4750 @bop_options = $payment_gateway->options;
4752 } else { #use the standard settings from the config
4755 ( $processor, $login, $password, $unused_action, @bop_options ) =
4756 $self->default_payment_gateway($method);
4761 return "neither amount nor paynum specified" unless $amount;
4766 'password' => $password,
4767 'order_number' => $order_number,
4768 'amount' => $amount,
4769 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4771 $content{authorization} = $auth
4772 if length($auth); #echeck/ACH transactions have an order # but no auth
4773 #(at least with authorize.net)
4775 my $disable_void_after;
4776 if ($conf->exists('disable_void_after')
4777 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
4778 $disable_void_after = $1;
4781 #first try void if applicable
4782 if ( $cust_pay && $cust_pay->paid == $amount
4784 ( not defined($disable_void_after) )
4785 || ( time < ($cust_pay->_date + $disable_void_after ) )
4788 warn " attempting void\n" if $DEBUG > 1;
4789 my $void = new Business::OnlinePayment( $processor, @bop_options );
4790 if ( $void->can('info') ) {
4791 if ( $cust_pay->payby eq 'CARD'
4792 && $void->info('CC_void_requires_card') )
4794 $content{'card_number'} = $cust_pay->payinfo
4795 } elsif ( $cust_pay->payby eq 'CHEK'
4796 && $void->info('ECHECK_void_requires_account') )
4798 ( $content{'account_number'}, $content{'routing_code'} ) =
4799 split('@', $cust_pay->payinfo);
4800 $content{'name'} = $self->get('first'). ' '. $self->get('last');
4803 $void->content( 'action' => 'void', %content );
4805 if ( $void->is_success ) {
4806 my $error = $cust_pay->void($options{'reason'});
4808 # gah, even with transactions.
4809 my $e = 'WARNING: Card/ACH voided but database not updated - '.
4810 "error voiding payment: $error";
4814 warn " void successful\n" if $DEBUG > 1;
4819 warn " void unsuccessful, trying refund\n"
4823 my $address = $self->address1;
4824 $address .= ", ". $self->address2 if $self->address2;
4826 my($payname, $payfirst, $paylast);
4827 if ( $self->payname && $method ne 'ECHECK' ) {
4828 $payname = $self->payname;
4829 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4830 or return "Illegal payname $payname";
4831 ($payfirst, $paylast) = ($1, $2);
4833 $payfirst = $self->getfield('first');
4834 $paylast = $self->getfield('last');
4835 $payname = "$payfirst $paylast";
4838 my @invoicing_list = $self->invoicing_list_emailonly;
4839 if ( $conf->exists('emailinvoiceautoalways')
4840 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4841 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4842 push @invoicing_list, $self->all_emails;
4845 my $email = ($conf->exists('business-onlinepayment-email-override'))
4846 ? $conf->config('business-onlinepayment-email-override')
4847 : $invoicing_list[0];
4849 my $payip = exists($options{'payip'})
4852 $content{customer_ip} = $payip
4856 if ( $method eq 'CC' ) {
4859 $content{card_number} = $payinfo = $cust_pay->payinfo;
4860 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
4861 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
4862 ($content{expiration} = "$2/$1"); # where available
4864 $content{card_number} = $payinfo = $self->payinfo;
4865 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
4866 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4867 $content{expiration} = "$2/$1";
4870 } elsif ( $method eq 'ECHECK' ) {
4873 $payinfo = $cust_pay->payinfo;
4875 $payinfo = $self->payinfo;
4877 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
4878 $content{bank_name} = $self->payname;
4879 $content{account_type} = 'CHECKING';
4880 $content{account_name} = $payname;
4881 $content{customer_org} = $self->company ? 'B' : 'I';
4882 $content{customer_ssn} = $self->ss;
4883 } elsif ( $method eq 'LEC' ) {
4884 $content{phone} = $payinfo = $self->payinfo;
4888 my $refund = new Business::OnlinePayment( $processor, @bop_options );
4889 my %sub_content = $refund->content(
4890 'action' => 'credit',
4891 'customer_id' => $self->custnum,
4892 'last_name' => $paylast,
4893 'first_name' => $payfirst,
4895 'address' => $address,
4896 'city' => $self->city,
4897 'state' => $self->state,
4898 'zip' => $self->zip,
4899 'country' => $self->country,
4901 'phone' => $self->daytime || $self->night,
4904 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
4908 return "$processor error: ". $refund->error_message
4909 unless $refund->is_success();
4911 my %method2payby = (
4917 my $paybatch = "$processor:". $refund->authorization;
4918 $paybatch .= ':'. $refund->order_number
4919 if $refund->can('order_number') && $refund->order_number;
4921 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
4922 my @cust_bill_pay = $cust_pay->cust_bill_pay;
4923 last unless @cust_bill_pay;
4924 my $cust_bill_pay = pop @cust_bill_pay;
4925 my $error = $cust_bill_pay->delete;
4929 my $cust_refund = new FS::cust_refund ( {
4930 'custnum' => $self->custnum,
4931 'paynum' => $options{'paynum'},
4932 'refund' => $amount,
4934 'payby' => $method2payby{$method},
4935 'payinfo' => $payinfo,
4936 'paybatch' => $paybatch,
4937 'reason' => $options{'reason'} || 'card or ACH refund',
4939 my $error = $cust_refund->insert;
4941 $cust_refund->paynum(''); #try again with no specific paynum
4942 my $error2 = $cust_refund->insert;
4944 # gah, even with transactions.
4945 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
4946 "error inserting refund ($processor): $error2".
4947 " (previously tried insert with paynum #$options{'paynum'}" .
4958 # does the configuration indicate the new bop routines are required?
4960 sub _new_bop_required {
4963 my $botpp = 'Business::OnlineThirdPartyPayment';
4966 if ( ( $conf->exists('business-onlinepayment-namespace')
4967 && $conf->config('business-onlinepayment-namespace') eq $botpp
4969 or scalar( grep { $_->gateway_namespace eq $botpp }
4970 qsearch( 'payment_gateway', { 'disabled' => '' } )
4978 =item realtime_collect [ OPTION => VALUE ... ]
4980 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4981 via a Business::OnlinePayment or Business::OnlineThirdPartyPayment realtime
4982 gateway. See L<http://420.am/business-onlinepayment> and
4983 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
4985 On failure returns an error message.
4987 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.
4989 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>, I<pkgnum>
4991 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>. If none is specified
4992 then it is deduced from the customer record.
4994 If no I<amount> is specified, then the customer balance is used.
4996 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4997 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4998 if set, will override the value from the customer record.
5000 I<description> is a free-text field passed to the gateway. It defaults to
5001 the value defined by the business-onlinepayment-description configuration
5002 option, or "Internet services" if that is unset.
5004 If an I<invnum> is specified, this payment (if successful) is applied to the
5005 specified invoice. If you don't specify an I<invnum> you might want to
5006 call the B<apply_payments> method or set the I<apply> option.
5008 I<apply> can be set to true to apply a resulting payment.
5010 I<quiet> can be set true to surpress email decline notices.
5012 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5013 resulting paynum, if any.
5015 I<payunique> is a unique identifier for this payment.
5017 I<session_id> is a session identifier associated with this payment.
5019 I<depend_jobnum> allows payment capture to unlock export jobs
5023 sub realtime_collect {
5024 my( $self, %options ) = @_;
5027 warn "$me realtime_collect:\n";
5028 warn " $_ => $options{$_}\n" foreach keys %options;
5031 $options{amount} = $self->balance unless exists( $options{amount} );
5032 $options{method} = FS::payby->payby2bop($self->payby)
5033 unless exists( $options{method} );
5035 return $self->realtime_bop({%options});
5039 =item _realtime_bop { [ ARG => VALUE ... ] }
5041 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
5042 via a Business::OnlinePayment realtime gateway. See
5043 L<http://420.am/business-onlinepayment> for supported gateways.
5045 Required arguments in the hashref are I<method>, and I<amount>
5047 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5049 Available optional arguments are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
5051 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5052 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5053 if set, will override the value from the customer record.
5055 I<description> is a free-text field passed to the gateway. It defaults to
5056 the value defined by the business-onlinepayment-description configuration
5057 option, or "Internet services" if that is unset.
5059 If an I<invnum> is specified, this payment (if successful) is applied to the
5060 specified invoice. If you don't specify an I<invnum> you might want to
5061 call the B<apply_payments> method.
5063 I<quiet> can be set true to surpress email decline notices.
5065 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5066 resulting paynum, if any.
5068 I<payunique> is a unique identifier for this payment.
5070 I<session_id> is a session identifier associated with this payment.
5072 I<depend_jobnum> allows payment capture to unlock export jobs
5074 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
5078 # some helper routines
5079 sub _payment_gateway {
5080 my ($self, $options) = @_;
5082 $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
5083 unless exists($options->{payment_gateway});
5085 $options->{payment_gateway};
5089 my ($self, $options) = @_;
5092 'login' => $options->{payment_gateway}->gateway_username,
5093 'password' => $options->{payment_gateway}->gateway_password,
5098 my ($self, $options) = @_;
5100 $options->{payment_gateway}->gatewaynum
5101 ? $options->{payment_gateway}->options
5102 : @{ $options->{payment_gateway}->get('options') };
5106 my ($self, $options) = @_;
5108 unless ( $options->{'description'} ) {
5109 if ( $conf->exists('business-onlinepayment-description') ) {
5110 my $dtempl = $conf->config('business-onlinepayment-description');
5112 my $agent = $self->agent->agent;
5114 $options->{'description'} = eval qq("$dtempl");
5116 $options->{'description'} = 'Internet services';
5120 $options->{payinfo} = $self->payinfo unless exists( $options->{payinfo} );
5121 $options->{invnum} ||= '';
5122 $options->{payname} = $self->payname unless exists( $options->{payname} );
5126 my ($self, $options) = @_;
5129 $content{address} = exists($options->{'address1'})
5130 ? $options->{'address1'}
5132 my $address2 = exists($options->{'address2'})
5133 ? $options->{'address2'}
5135 $content{address} .= ", ". $address2 if length($address2);
5137 my $payip = exists($options->{'payip'}) ? $options->{'payip'} : $self->payip;
5138 $content{customer_ip} = $payip if length($payip);
5140 $content{invoice_number} = $options->{'invnum'}
5141 if exists($options->{'invnum'}) && length($options->{'invnum'});
5143 $content{email_customer} =
5144 ( $conf->exists('business-onlinepayment-email_customer')
5145 || $conf->exists('business-onlinepayment-email-override') );
5147 $content{payfirst} = $self->getfield('first');
5148 $content{paylast} = $self->getfield('last');
5150 $content{account_name} = "$content{payfirst} $content{paylast}"
5151 if $options->{method} eq 'ECHECK';
5153 $content{name} = $options->{payname};
5154 $content{name} = $content{account_name} if exists($content{account_name});
5156 $content{city} = exists($options->{city})
5159 $content{state} = exists($options->{state})
5162 $content{zip} = exists($options->{zip})
5165 $content{country} = exists($options->{country})
5166 ? $options->{country}
5168 $content{referer} = 'http://cleanwhisker.420.am/'; #XXX fix referer :/
5169 $content{phone} = $self->daytime || $self->night;
5174 my %bop_method2payby = (
5180 sub _new_realtime_bop {
5184 if (ref($_[0]) eq 'HASH') {
5185 %options = %{$_[0]};
5187 my ( $method, $amount ) = ( shift, shift );
5189 $options{method} = $method;
5190 $options{amount} = $amount;
5194 warn "$me realtime_bop (new): $options{method} $options{amount}\n";
5195 warn " $_ => $options{$_}\n" foreach keys %options;
5198 return $self->fake_bop(%options) if $options{'fake'};
5200 $self->_bop_defaults(\%options);
5203 # set trans_is_recur based on invnum if there is one
5206 my $trans_is_recur = 0;
5207 if ( $options{'invnum'} ) {
5209 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
5210 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
5213 map { $_->part_pkg }
5215 map { $_->cust_pkg }
5216 $cust_bill->cust_bill_pkg;
5219 if grep { $_->freq ne '0' } @part_pkg;
5227 my $payment_gateway = $self->_payment_gateway( \%options );
5228 my $namespace = $payment_gateway->gateway_namespace;
5230 eval "use $namespace";
5234 # check for banned credit card/ACH
5237 my $ban = qsearchs('banned_pay', {
5238 'payby' => $bop_method2payby{$options{method}},
5239 'payinfo' => md5_base64($options{payinfo}),
5241 return "Banned credit card" if $ban;
5247 my (%bop_content) = $self->_bop_content(\%options);
5249 if ( $options{method} ne 'ECHECK' ) {
5250 $options{payname} =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5251 or return "Illegal payname $options{payname}";
5252 ($bop_content{payfirst}, $bop_content{paylast}) = ($1, $2);
5255 my @invoicing_list = $self->invoicing_list_emailonly;
5256 if ( $conf->exists('emailinvoiceautoalways')
5257 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5258 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5259 push @invoicing_list, $self->all_emails;
5262 my $email = ($conf->exists('business-onlinepayment-email-override'))
5263 ? $conf->config('business-onlinepayment-email-override')
5264 : $invoicing_list[0];
5268 if ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'CC' ) {
5270 $content{card_number} = $options{payinfo};
5271 $paydate = exists($options{'paydate'})
5272 ? $options{'paydate'}
5274 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
5275 $content{expiration} = "$2/$1";
5277 my $paycvv = exists($options{'paycvv'})
5278 ? $options{'paycvv'}
5280 $content{cvv2} = $paycvv
5283 my $paystart_month = exists($options{'paystart_month'})
5284 ? $options{'paystart_month'}
5285 : $self->paystart_month;
5287 my $paystart_year = exists($options{'paystart_year'})
5288 ? $options{'paystart_year'}
5289 : $self->paystart_year;
5291 $content{card_start} = "$paystart_month/$paystart_year"
5292 if $paystart_month && $paystart_year;
5294 my $payissue = exists($options{'payissue'})
5295 ? $options{'payissue'}
5297 $content{issue_number} = $payissue if $payissue;
5299 if ( $self->_bop_recurring_billing( 'payinfo' => $options{'payinfo'},
5300 'trans_is_recur' => $trans_is_recur,
5304 $content{recurring_billing} = 'YES';
5305 $content{acct_code} = 'rebill'
5306 if $conf->exists('credit_card-recurring_billing_acct_code');
5309 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'ECHECK' ){
5310 ( $content{account_number}, $content{routing_code} ) =
5311 split('@', $options{payinfo});
5312 $content{bank_name} = $options{payname};
5313 $content{bank_state} = exists($options{'paystate'})
5314 ? $options{'paystate'}
5315 : $self->getfield('paystate');
5316 $content{account_type} = exists($options{'paytype'})
5317 ? uc($options{'paytype'}) || 'CHECKING'
5318 : uc($self->getfield('paytype')) || 'CHECKING';
5319 $content{customer_org} = $self->company ? 'B' : 'I';
5320 $content{state_id} = exists($options{'stateid'})
5321 ? $options{'stateid'}
5322 : $self->getfield('stateid');
5323 $content{state_id_state} = exists($options{'stateid_state'})
5324 ? $options{'stateid_state'}
5325 : $self->getfield('stateid_state');
5326 $content{customer_ssn} = exists($options{'ss'})
5329 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'LEC' ) {
5330 $content{phone} = $options{payinfo};
5331 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5338 # run transaction(s)
5341 my $balance = exists( $options{'balance'} )
5342 ? $options{'balance'}
5345 $self->select_for_update; #mutex ... just until we get our pending record in
5347 #the checks here are intended to catch concurrent payments
5348 #double-form-submission prevention is taken care of in cust_pay_pending::check
5351 return "The customer's balance has changed; $options{method} transaction aborted."
5352 if $self->balance < $balance;
5353 #&& $self->balance < $options{amount}; #might as well anyway?
5355 #also check and make sure there aren't *other* pending payments for this cust
5357 my @pending = qsearch('cust_pay_pending', {
5358 'custnum' => $self->custnum,
5359 'status' => { op=>'!=', value=>'done' }
5361 return "A payment is already being processed for this customer (".
5362 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
5363 "); $options{method} transaction aborted."
5364 if scalar(@pending);
5366 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
5368 my $cust_pay_pending = new FS::cust_pay_pending {
5369 'custnum' => $self->custnum,
5370 #'invnum' => $options{'invnum'},
5371 'paid' => $options{amount},
5373 'payby' => $bop_method2payby{$options{method}},
5374 'payinfo' => $options{payinfo},
5375 'paydate' => $paydate,
5376 'recurring_billing' => $content{recurring_billing},
5377 'pkgnum' => $options{'pkgnum'},
5379 'gatewaynum' => $payment_gateway->gatewaynum || '',
5380 'session_id' => $options{session_id} || '',
5381 'jobnum' => $options{depend_jobnum} || '',
5383 $cust_pay_pending->payunique( $options{payunique} )
5384 if defined($options{payunique}) && length($options{payunique});
5385 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
5386 return $cpp_new_err if $cpp_new_err;
5388 my( $action1, $action2 ) =
5389 split( /\s*\,\s*/, $payment_gateway->gateway_action );
5391 my $transaction = new $namespace( $payment_gateway->gateway_module,
5392 $self->_bop_options(\%options),
5395 $transaction->content(
5396 'type' => $options{method},
5397 $self->_bop_auth(\%options),
5398 'action' => $action1,
5399 'description' => $options{'description'},
5400 'amount' => $options{amount},
5401 #'invoice_number' => $options{'invnum'},
5402 'customer_id' => $self->custnum,
5404 'reference' => $cust_pay_pending->paypendingnum, #for now
5409 $cust_pay_pending->status('pending');
5410 my $cpp_pending_err = $cust_pay_pending->replace;
5411 return $cpp_pending_err if $cpp_pending_err;
5414 my $BOP_TESTING = 0;
5415 my $BOP_TESTING_SUCCESS = 1;
5417 unless ( $BOP_TESTING ) {
5418 $transaction->submit();
5420 if ( $BOP_TESTING_SUCCESS ) {
5421 $transaction->is_success(1);
5422 $transaction->authorization('fake auth');
5424 $transaction->is_success(0);
5425 $transaction->error_message('fake failure');
5429 if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5431 return { reference => $cust_pay_pending->paypendingnum,
5432 map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
5434 } elsif ( $transaction->is_success() && $action2 ) {
5436 $cust_pay_pending->status('authorized');
5437 my $cpp_authorized_err = $cust_pay_pending->replace;
5438 return $cpp_authorized_err if $cpp_authorized_err;
5440 my $auth = $transaction->authorization;
5441 my $ordernum = $transaction->can('order_number')
5442 ? $transaction->order_number
5446 new Business::OnlinePayment( $payment_gateway->gateway_module,
5447 $self->_bop_options(\%options),
5452 type => $options{method},
5454 $self->_bop_auth(\%options),
5455 order_number => $ordernum,
5456 amount => $options{amount},
5457 authorization => $auth,
5458 description => $options{'description'},
5461 foreach my $field (qw( authorization_source_code returned_ACI
5462 transaction_identifier validation_code
5463 transaction_sequence_num local_transaction_date
5464 local_transaction_time AVS_result_code )) {
5465 $capture{$field} = $transaction->$field() if $transaction->can($field);
5468 $capture->content( %capture );
5472 unless ( $capture->is_success ) {
5473 my $e = "Authorization successful but capture failed, custnum #".
5474 $self->custnum. ': '. $capture->result_code.
5475 ": ". $capture->error_message;
5483 # remove paycvv after initial transaction
5486 #false laziness w/misc/process/payment.cgi - check both to make sure working
5488 if ( defined $self->dbdef_table->column('paycvv')
5489 && length($self->paycvv)
5490 && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
5492 my $error = $self->remove_cvv;
5494 warn "WARNING: error removing cvv: $error\n";
5502 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5514 if (ref($_[0]) eq 'HASH') {
5515 %options = %{$_[0]};
5517 my ( $method, $amount ) = ( shift, shift );
5519 $options{method} = $method;
5520 $options{amount} = $amount;
5523 if ( $options{'fake_failure'} ) {
5524 return "Error: No error; test failure requested with fake_failure";
5528 #if ( $payment_gateway->gatewaynum ) { # agent override
5529 # $paybatch = $payment_gateway->gatewaynum. '-';
5532 #$paybatch .= "$processor:". $transaction->authorization;
5534 #$paybatch .= ':'. $transaction->order_number
5535 # if $transaction->can('order_number')
5536 # && length($transaction->order_number);
5538 my $paybatch = 'FakeProcessor:54:32';
5540 my $cust_pay = new FS::cust_pay ( {
5541 'custnum' => $self->custnum,
5542 'invnum' => $options{'invnum'},
5543 'paid' => $options{amount},
5545 'payby' => $bop_method2payby{$options{method}},
5546 #'payinfo' => $payinfo,
5547 'payinfo' => '4111111111111111',
5548 'paybatch' => $paybatch,
5549 #'paydate' => $paydate,
5550 'paydate' => '2012-05-01',
5552 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
5554 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5557 $cust_pay->invnum(''); #try again with no specific invnum
5558 my $error2 = $cust_pay->insert( $options{'manual'} ?
5559 ( 'manual' => 1 ) : ()
5562 # gah, even with transactions.
5563 my $e = 'WARNING: Card/ACH debited but database not updated - '.
5564 "error inserting (fake!) payment: $error2".
5565 " (previously tried insert with invnum #$options{'invnum'}" .
5572 if ( $options{'paynum_ref'} ) {
5573 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5576 return ''; #no error
5581 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
5583 # Wraps up processing of a realtime credit card, ACH (electronic check) or
5584 # phone bill transaction.
5586 sub _realtime_bop_result {
5587 my( $self, $cust_pay_pending, $transaction, %options ) = @_;
5589 warn "$me _realtime_bop_result: pending transaction ".
5590 $cust_pay_pending->paypendingnum. "\n";
5591 warn " $_ => $options{$_}\n" foreach keys %options;
5594 my $payment_gateway = $options{payment_gateway}
5595 or return "no payment gateway in arguments to _realtime_bop_result";
5597 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
5598 my $cpp_captured_err = $cust_pay_pending->replace;
5599 return $cpp_captured_err if $cpp_captured_err;
5601 if ( $transaction->is_success() ) {
5604 if ( $payment_gateway->gatewaynum ) { # agent override
5605 $paybatch = $payment_gateway->gatewaynum. '-';
5608 $paybatch .= $payment_gateway->gateway_module. ":".
5609 $transaction->authorization;
5611 $paybatch .= ':'. $transaction->order_number
5612 if $transaction->can('order_number')
5613 && length($transaction->order_number);
5615 my $cust_pay = new FS::cust_pay ( {
5616 'custnum' => $self->custnum,
5617 'invnum' => $options{'invnum'},
5618 'paid' => $cust_pay_pending->paid,
5620 'payby' => $cust_pay_pending->payby,
5621 #'payinfo' => $payinfo,
5622 'paybatch' => $paybatch,
5623 'paydate' => $cust_pay_pending->paydate,
5624 'pkgnum' => $cust_pay_pending->pkgnum,
5626 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
5627 $cust_pay->payunique( $options{payunique} )
5628 if defined($options{payunique}) && length($options{payunique});
5630 my $oldAutoCommit = $FS::UID::AutoCommit;
5631 local $FS::UID::AutoCommit = 0;
5634 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
5636 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5639 $cust_pay->invnum(''); #try again with no specific invnum
5640 my $error2 = $cust_pay->insert( $options{'manual'} ?
5641 ( 'manual' => 1 ) : ()
5644 # gah. but at least we have a record of the state we had to abort in
5645 # from cust_pay_pending now.
5646 my $e = "WARNING: $options{method} captured but payment not recorded -".
5647 " error inserting payment (". $payment_gateway->gateway_module.
5649 " (previously tried insert with invnum #$options{'invnum'}" .
5650 ": $error ) - pending payment saved as paypendingnum ".
5651 $cust_pay_pending->paypendingnum. "\n";
5657 my $jobnum = $cust_pay_pending->jobnum;
5659 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5661 unless ( $placeholder ) {
5662 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5663 my $e = "WARNING: $options{method} captured but job $jobnum not ".
5664 "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
5669 $error = $placeholder->delete;
5672 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5673 my $e = "WARNING: $options{method} captured but could not delete ".
5674 "job $jobnum for paypendingnum ".
5675 $cust_pay_pending->paypendingnum. ": $error\n";
5682 if ( $options{'paynum_ref'} ) {
5683 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5686 $cust_pay_pending->status('done');
5687 $cust_pay_pending->statustext('captured');
5688 $cust_pay_pending->paynum($cust_pay->paynum);
5689 my $cpp_done_err = $cust_pay_pending->replace;
5691 if ( $cpp_done_err ) {
5693 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5694 my $e = "WARNING: $options{method} captured but payment not recorded - ".
5695 "error updating status for paypendingnum ".
5696 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5702 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5704 if ( $options{'apply'} ) {
5705 my $apply_error = $self->apply_payments_and_credits;
5706 if ( $apply_error ) {
5707 warn "WARNING: error applying payment: $apply_error\n";
5708 #but we still should return no error cause the payment otherwise went
5713 return ''; #no error
5719 my $perror = $payment_gateway->gateway_module. " error: ".
5720 $transaction->error_message;
5722 my $jobnum = $cust_pay_pending->jobnum;
5724 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5726 if ( $placeholder ) {
5727 my $error = $placeholder->depended_delete;
5728 $error ||= $placeholder->delete;
5729 warn "error removing provisioning jobs after declined paypendingnum ".
5730 $cust_pay_pending->paypendingnum. "\n";
5732 my $e = "error finding job $jobnum for declined paypendingnum ".
5733 $cust_pay_pending->paypendingnum. "\n";
5739 unless ( $transaction->error_message ) {
5742 if ( $transaction->can('response_page') ) {
5744 'page' => ( $transaction->can('response_page')
5745 ? $transaction->response_page
5748 'code' => ( $transaction->can('response_code')
5749 ? $transaction->response_code
5752 'headers' => ( $transaction->can('response_headers')
5753 ? $transaction->response_headers
5759 "No additional debugging information available for ".
5760 $payment_gateway->gateway_module;
5763 $perror .= "No error_message returned from ".
5764 $payment_gateway->gateway_module. " -- ".
5765 ( ref($t_response) ? Dumper($t_response) : $t_response );
5769 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
5770 && $conf->exists('emaildecline')
5771 && grep { $_ ne 'POST' } $self->invoicing_list
5772 && ! grep { $transaction->error_message =~ /$_/ }
5773 $conf->config('emaildecline-exclude')
5775 my @templ = $conf->config('declinetemplate');
5776 my $template = new Text::Template (
5778 SOURCE => [ map "$_\n", @templ ],
5779 ) or return "($perror) can't create template: $Text::Template::ERROR";
5780 $template->compile()
5781 or return "($perror) can't compile template: $Text::Template::ERROR";
5785 scalar( $conf->config('company_name', $self->agentnum ) ),
5786 'company_address' =>
5787 join("\n", $conf->config('company_address', $self->agentnum ) ),
5788 'error' => $transaction->error_message,
5791 my $error = send_email(
5792 'from' => $conf->config('invoice_from', $self->agentnum ),
5793 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
5794 'subject' => 'Your payment could not be processed',
5795 'body' => [ $template->fill_in(HASH => $templ_hash) ],
5798 $perror .= " (also received error sending decline notification: $error)"
5803 $cust_pay_pending->status('done');
5804 $cust_pay_pending->statustext("declined: $perror");
5805 my $cpp_done_err = $cust_pay_pending->replace;
5806 if ( $cpp_done_err ) {
5807 my $e = "WARNING: $options{method} declined but pending payment not ".
5808 "resolved - error updating status for paypendingnum ".
5809 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5811 $perror = "$e ($perror)";
5819 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
5821 Verifies successful third party processing of a realtime credit card,
5822 ACH (electronic check) or phone bill transaction via a
5823 Business::OnlineThirdPartyPayment realtime gateway. See
5824 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5826 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
5828 The additional options I<payname>, I<city>, I<state>,
5829 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5830 if set, will override the value from the customer record.
5832 I<description> is a free-text field passed to the gateway. It defaults to
5833 "Internet services".
5835 If an I<invnum> is specified, this payment (if successful) is applied to the
5836 specified invoice. If you don't specify an I<invnum> you might want to
5837 call the B<apply_payments> method.
5839 I<quiet> can be set true to surpress email decline notices.
5841 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5842 resulting paynum, if any.
5844 I<payunique> is a unique identifier for this payment.
5846 Returns a hashref containing elements bill_error (which will be undefined
5847 upon success) and session_id of any associated session.
5851 sub realtime_botpp_capture {
5852 my( $self, $cust_pay_pending, %options ) = @_;
5854 warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
5855 warn " $_ => $options{$_}\n" foreach keys %options;
5858 eval "use Business::OnlineThirdPartyPayment";
5862 # select the gateway
5865 my $method = FS::payby->payby2bop($cust_pay_pending->payby);
5867 my $payment_gateway = $cust_pay_pending->gatewaynum
5868 ? qsearchs( 'payment_gateway',
5869 { gatewaynum => $cust_pay_pending->gatewaynum }
5871 : $self->agent->payment_gateway( 'method' => $method,
5872 # 'invnum' => $cust_pay_pending->invnum,
5873 # 'payinfo' => $cust_pay_pending->payinfo,
5876 $options{payment_gateway} = $payment_gateway; # for the helper subs
5882 my @invoicing_list = $self->invoicing_list_emailonly;
5883 if ( $conf->exists('emailinvoiceautoalways')
5884 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5885 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5886 push @invoicing_list, $self->all_emails;
5889 my $email = ($conf->exists('business-onlinepayment-email-override'))
5890 ? $conf->config('business-onlinepayment-email-override')
5891 : $invoicing_list[0];
5895 $content{email_customer} =
5896 ( $conf->exists('business-onlinepayment-email_customer')
5897 || $conf->exists('business-onlinepayment-email-override') );
5900 # run transaction(s)
5904 new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
5905 $self->_bop_options(\%options),
5908 $transaction->reference({ %options });
5910 $transaction->content(
5912 $self->_bop_auth(\%options),
5913 'action' => 'Post Authorization',
5914 'description' => $options{'description'},
5915 'amount' => $cust_pay_pending->paid,
5916 #'invoice_number' => $options{'invnum'},
5917 'customer_id' => $self->custnum,
5918 'referer' => 'http://cleanwhisker.420.am/',
5919 'reference' => $cust_pay_pending->paypendingnum,
5921 'phone' => $self->daytime || $self->night,
5923 # plus whatever is required for bogus capture avoidance
5926 $transaction->submit();
5929 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5932 bill_error => $error,
5933 session_id => $cust_pay_pending->session_id,
5938 =item default_payment_gateway DEPRECATED -- use agent->payment_gateway
5942 sub default_payment_gateway {
5943 my( $self, $method ) = @_;
5945 die "Real-time processing not enabled\n"
5946 unless $conf->exists('business-onlinepayment');
5948 #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
5951 my $bop_config = 'business-onlinepayment';
5952 $bop_config .= '-ach'
5953 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
5954 my ( $processor, $login, $password, $action, @bop_options ) =
5955 $conf->config($bop_config);
5956 $action ||= 'normal authorization';
5957 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
5958 die "No real-time processor is enabled - ".
5959 "did you set the business-onlinepayment configuration value?\n"
5962 ( $processor, $login, $password, $action, @bop_options )
5967 Removes the I<paycvv> field from the database directly.
5969 If there is an error, returns the error, otherwise returns false.
5975 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
5976 or return dbh->errstr;
5977 $sth->execute($self->custnum)
5978 or return $sth->errstr;
5983 =item _new_realtime_refund_bop METHOD [ OPTION => VALUE ... ]
5985 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
5986 via a Business::OnlinePayment realtime gateway. See
5987 L<http://420.am/business-onlinepayment> for supported gateways.
5989 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5991 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
5993 Most gateways require a reference to an original payment transaction to refund,
5994 so you probably need to specify a I<paynum>.
5996 I<amount> defaults to the original amount of the payment if not specified.
5998 I<reason> specifies a reason for the refund.
6000 I<paydate> specifies the expiration date for a credit card overriding the
6001 value from the customer record or the payment record. Specified as yyyy-mm-dd
6003 Implementation note: If I<amount> is unspecified or equal to the amount of the
6004 orignal payment, first an attempt is made to "void" the transaction via
6005 the gateway (to cancel a not-yet settled transaction) and then if that fails,
6006 the normal attempt is made to "refund" ("credit") the transaction via the
6007 gateway is attempted.
6009 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
6010 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
6011 #if set, will override the value from the customer record.
6013 #If an I<invnum> is specified, this payment (if successful) is applied to the
6014 #specified invoice. If you don't specify an I<invnum> you might want to
6015 #call the B<apply_payments> method.
6019 #some false laziness w/realtime_bop, not enough to make it worth merging
6020 #but some useful small subs should be pulled out
6021 sub _new_realtime_refund_bop {
6025 if (ref($_[0]) ne 'HASH') {
6026 %options = %{$_[0]};
6030 $options{method} = $method;
6034 warn "$me realtime_refund_bop (new): $options{method} refund\n";
6035 warn " $_ => $options{$_}\n" foreach keys %options;
6039 # look up the original payment and optionally a gateway for that payment
6043 my $amount = $options{'amount'};
6045 my( $processor, $login, $password, @bop_options, $namespace ) ;
6046 my( $auth, $order_number ) = ( '', '', '' );
6048 if ( $options{'paynum'} ) {
6050 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
6051 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
6052 or return "Unknown paynum $options{'paynum'}";
6053 $amount ||= $cust_pay->paid;
6055 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
6056 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
6057 $cust_pay->paybatch;
6058 my $gatewaynum = '';
6059 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
6061 if ( $gatewaynum ) { #gateway for the payment to be refunded
6063 my $payment_gateway =
6064 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
6065 die "payment gateway $gatewaynum not found"
6066 unless $payment_gateway;
6068 $processor = $payment_gateway->gateway_module;
6069 $login = $payment_gateway->gateway_username;
6070 $password = $payment_gateway->gateway_password;
6071 $namespace = $payment_gateway->gateway_namespace;
6072 @bop_options = $payment_gateway->options;
6074 } else { #try the default gateway
6077 my $payment_gateway =
6078 $self->agent->payment_gateway('method' => $options{method});
6080 ( $conf_processor, $login, $password, $namespace ) =
6081 map { my $method = "gateway_$_"; $payment_gateway->$method }
6082 qw( module username password namespace );
6084 @bop_options = $payment_gateway->gatewaynum
6085 ? $payment_gateway->options
6086 : @{ $payment_gateway->get('options') };
6088 return "processor of payment $options{'paynum'} $processor does not".
6089 " match default processor $conf_processor"
6090 unless $processor eq $conf_processor;
6095 } else { # didn't specify a paynum, so look for agent gateway overrides
6096 # like a normal transaction
6098 my $payment_gateway =
6099 $self->agent->payment_gateway( 'method' => $options{method},
6100 #'payinfo' => $payinfo,
6102 my( $processor, $login, $password, $namespace ) =
6103 map { my $method = "gateway_$_"; $payment_gateway->$method }
6104 qw( module username password namespace );
6106 my @bop_options = $payment_gateway->gatewaynum
6107 ? $payment_gateway->options
6108 : @{ $payment_gateway->get('options') };
6111 return "neither amount nor paynum specified" unless $amount;
6113 eval "use $namespace";
6117 'type' => $options{method},
6119 'password' => $password,
6120 'order_number' => $order_number,
6121 'amount' => $amount,
6122 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
6124 $content{authorization} = $auth
6125 if length($auth); #echeck/ACH transactions have an order # but no auth
6126 #(at least with authorize.net)
6128 my $disable_void_after;
6129 if ($conf->exists('disable_void_after')
6130 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
6131 $disable_void_after = $1;
6134 #first try void if applicable
6135 if ( $cust_pay && $cust_pay->paid == $amount
6137 ( not defined($disable_void_after) )
6138 || ( time < ($cust_pay->_date + $disable_void_after ) )
6141 warn " attempting void\n" if $DEBUG > 1;
6142 my $void = new Business::OnlinePayment( $processor, @bop_options );
6143 if ( $void->can('info') ) {
6144 if ( $cust_pay->payby eq 'CARD'
6145 && $void->info('CC_void_requires_card') )
6147 $content{'card_number'} = $cust_pay->payinfo;
6148 } elsif ( $cust_pay->payby eq 'CHEK'
6149 && $void->info('ECHECK_void_requires_account') )
6151 ( $content{'account_number'}, $content{'routing_code'} ) =
6152 split('@', $cust_pay->payinfo);
6153 $content{'name'} = $self->get('first'). ' '. $self->get('last');
6156 $void->content( 'action' => 'void', %content );
6158 if ( $void->is_success ) {
6159 my $error = $cust_pay->void($options{'reason'});
6161 # gah, even with transactions.
6162 my $e = 'WARNING: Card/ACH voided but database not updated - '.
6163 "error voiding payment: $error";
6167 warn " void successful\n" if $DEBUG > 1;
6172 warn " void unsuccessful, trying refund\n"
6176 my $address = $self->address1;
6177 $address .= ", ". $self->address2 if $self->address2;
6179 my($payname, $payfirst, $paylast);
6180 if ( $self->payname && $options{method} ne 'ECHECK' ) {
6181 $payname = $self->payname;
6182 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
6183 or return "Illegal payname $payname";
6184 ($payfirst, $paylast) = ($1, $2);
6186 $payfirst = $self->getfield('first');
6187 $paylast = $self->getfield('last');
6188 $payname = "$payfirst $paylast";
6191 my @invoicing_list = $self->invoicing_list_emailonly;
6192 if ( $conf->exists('emailinvoiceautoalways')
6193 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
6194 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
6195 push @invoicing_list, $self->all_emails;
6198 my $email = ($conf->exists('business-onlinepayment-email-override'))
6199 ? $conf->config('business-onlinepayment-email-override')
6200 : $invoicing_list[0];
6202 my $payip = exists($options{'payip'})
6205 $content{customer_ip} = $payip
6209 if ( $options{method} eq 'CC' ) {
6212 $content{card_number} = $payinfo = $cust_pay->payinfo;
6213 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
6214 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
6215 ($content{expiration} = "$2/$1"); # where available
6217 $content{card_number} = $payinfo = $self->payinfo;
6218 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
6219 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
6220 $content{expiration} = "$2/$1";
6223 } elsif ( $options{method} eq 'ECHECK' ) {
6226 $payinfo = $cust_pay->payinfo;
6228 $payinfo = $self->payinfo;
6230 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
6231 $content{bank_name} = $self->payname;
6232 $content{account_type} = 'CHECKING';
6233 $content{account_name} = $payname;
6234 $content{customer_org} = $self->company ? 'B' : 'I';
6235 $content{customer_ssn} = $self->ss;
6236 } elsif ( $options{method} eq 'LEC' ) {
6237 $content{phone} = $payinfo = $self->payinfo;
6241 my $refund = new Business::OnlinePayment( $processor, @bop_options );
6242 my %sub_content = $refund->content(
6243 'action' => 'credit',
6244 'customer_id' => $self->custnum,
6245 'last_name' => $paylast,
6246 'first_name' => $payfirst,
6248 'address' => $address,
6249 'city' => $self->city,
6250 'state' => $self->state,
6251 'zip' => $self->zip,
6252 'country' => $self->country,
6254 'phone' => $self->daytime || $self->night,
6257 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
6261 return "$processor error: ". $refund->error_message
6262 unless $refund->is_success();
6264 my $paybatch = "$processor:". $refund->authorization;
6265 $paybatch .= ':'. $refund->order_number
6266 if $refund->can('order_number') && $refund->order_number;
6268 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
6269 my @cust_bill_pay = $cust_pay->cust_bill_pay;
6270 last unless @cust_bill_pay;
6271 my $cust_bill_pay = pop @cust_bill_pay;
6272 my $error = $cust_bill_pay->delete;
6276 my $cust_refund = new FS::cust_refund ( {
6277 'custnum' => $self->custnum,
6278 'paynum' => $options{'paynum'},
6279 'refund' => $amount,
6281 'payby' => $bop_method2payby{$options{method}},
6282 'payinfo' => $payinfo,
6283 'paybatch' => $paybatch,
6284 'reason' => $options{'reason'} || 'card or ACH refund',
6286 my $error = $cust_refund->insert;
6288 $cust_refund->paynum(''); #try again with no specific paynum
6289 my $error2 = $cust_refund->insert;
6291 # gah, even with transactions.
6292 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
6293 "error inserting refund ($processor): $error2".
6294 " (previously tried insert with paynum #$options{'paynum'}" .
6305 =item batch_card OPTION => VALUE...
6307 Adds a payment for this invoice to the pending credit card batch (see
6308 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
6309 runs the payment using a realtime gateway.
6314 my ($self, %options) = @_;
6317 if (exists($options{amount})) {
6318 $amount = $options{amount};
6320 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
6322 return '' unless $amount > 0;
6324 my $invnum = delete $options{invnum};
6325 my $payby = $options{invnum} || $self->payby; #dubious
6327 if ($options{'realtime'}) {
6328 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
6334 my $oldAutoCommit = $FS::UID::AutoCommit;
6335 local $FS::UID::AutoCommit = 0;
6338 #this needs to handle mysql as well as Pg, like svc_acct.pm
6339 #(make it into a common function if folks need to do batching with mysql)
6340 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
6341 or return "Cannot lock pay_batch: " . $dbh->errstr;
6345 'payby' => FS::payby->payby2payment($payby),
6348 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
6350 unless ( $pay_batch ) {
6351 $pay_batch = new FS::pay_batch \%pay_batch;
6352 my $error = $pay_batch->insert;
6354 $dbh->rollback if $oldAutoCommit;
6355 die "error creating new batch: $error\n";
6359 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
6360 'batchnum' => $pay_batch->batchnum,
6361 'custnum' => $self->custnum,
6364 foreach (qw( address1 address2 city state zip country payby payinfo paydate
6366 $options{$_} = '' unless exists($options{$_});
6369 my $cust_pay_batch = new FS::cust_pay_batch ( {
6370 'batchnum' => $pay_batch->batchnum,
6371 'invnum' => $invnum || 0, # is there a better value?
6372 # this field should be
6374 # cust_bill_pay_batch now
6375 'custnum' => $self->custnum,
6376 'last' => $self->getfield('last'),
6377 'first' => $self->getfield('first'),
6378 'address1' => $options{address1} || $self->address1,
6379 'address2' => $options{address2} || $self->address2,
6380 'city' => $options{city} || $self->city,
6381 'state' => $options{state} || $self->state,
6382 'zip' => $options{zip} || $self->zip,
6383 'country' => $options{country} || $self->country,
6384 'payby' => $options{payby} || $self->payby,
6385 'payinfo' => $options{payinfo} || $self->payinfo,
6386 'exp' => $options{paydate} || $self->paydate,
6387 'payname' => $options{payname} || $self->payname,
6388 'amount' => $amount, # consolidating
6391 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
6392 if $old_cust_pay_batch;
6395 if ($old_cust_pay_batch) {
6396 $error = $cust_pay_batch->replace($old_cust_pay_batch)
6398 $error = $cust_pay_batch->insert;
6402 $dbh->rollback if $oldAutoCommit;
6406 my $unapplied = $self->total_unapplied_credits
6407 + $self->total_unapplied_payments
6408 + $self->in_transit_payments;
6409 foreach my $cust_bill ($self->open_cust_bill) {
6410 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
6411 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
6412 'invnum' => $cust_bill->invnum,
6413 'paybatchnum' => $cust_pay_batch->paybatchnum,
6414 'amount' => $cust_bill->owed,
6417 if ($unapplied >= $cust_bill_pay_batch->amount){
6418 $unapplied -= $cust_bill_pay_batch->amount;
6421 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
6422 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
6424 $error = $cust_bill_pay_batch->insert;
6426 $dbh->rollback if $oldAutoCommit;
6431 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6435 =item apply_payments_and_credits [ OPTION => VALUE ... ]
6437 Applies unapplied payments and credits.
6439 In most cases, this new method should be used in place of sequential
6440 apply_payments and apply_credits methods.
6442 A hash of optional arguments may be passed. Currently "manual" is supported.
6443 If true, a payment receipt is sent instead of a statement when
6444 'payment_receipt_email' configuration option is set.
6446 If there is an error, returns the error, otherwise returns false.
6450 sub apply_payments_and_credits {
6451 my( $self, %options ) = @_;
6453 local $SIG{HUP} = 'IGNORE';
6454 local $SIG{INT} = 'IGNORE';
6455 local $SIG{QUIT} = 'IGNORE';
6456 local $SIG{TERM} = 'IGNORE';
6457 local $SIG{TSTP} = 'IGNORE';
6458 local $SIG{PIPE} = 'IGNORE';
6460 my $oldAutoCommit = $FS::UID::AutoCommit;
6461 local $FS::UID::AutoCommit = 0;
6464 $self->select_for_update; #mutex
6466 foreach my $cust_bill ( $self->open_cust_bill ) {
6467 my $error = $cust_bill->apply_payments_and_credits(%options);
6469 $dbh->rollback if $oldAutoCommit;
6470 return "Error applying: $error";
6474 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6479 =item apply_credits OPTION => VALUE ...
6481 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
6482 to outstanding invoice balances in chronological order (or reverse
6483 chronological order if the I<order> option is set to B<newest>) and returns the
6484 value of any remaining unapplied credits available for refund (see
6485 L<FS::cust_refund>).
6487 Dies if there is an error.
6495 local $SIG{HUP} = 'IGNORE';
6496 local $SIG{INT} = 'IGNORE';
6497 local $SIG{QUIT} = 'IGNORE';
6498 local $SIG{TERM} = 'IGNORE';
6499 local $SIG{TSTP} = 'IGNORE';
6500 local $SIG{PIPE} = 'IGNORE';
6502 my $oldAutoCommit = $FS::UID::AutoCommit;
6503 local $FS::UID::AutoCommit = 0;
6506 $self->select_for_update; #mutex
6508 unless ( $self->total_unapplied_credits ) {
6509 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6513 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
6514 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
6516 my @invoices = $self->open_cust_bill;
6517 @invoices = sort { $b->_date <=> $a->_date } @invoices
6518 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
6520 if ( $conf->exists('pkg-balances') ) {
6521 # limit @credits to those w/ a pkgnum grepped from $self
6523 foreach my $i (@invoices) {
6524 foreach my $li ( $i->cust_bill_pkg ) {
6525 $pkgnums{$li->pkgnum} = 1;
6528 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
6533 foreach my $cust_bill ( @invoices ) {
6535 if ( !defined($credit) || $credit->credited == 0) {
6536 $credit = pop @credits or last;
6540 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
6541 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
6543 $owed = $cust_bill->owed;
6545 unless ( $owed > 0 ) {
6546 push @credits, $credit;
6550 my $amount = min( $credit->credited, $owed );
6552 my $cust_credit_bill = new FS::cust_credit_bill ( {
6553 'crednum' => $credit->crednum,
6554 'invnum' => $cust_bill->invnum,
6555 'amount' => $amount,
6557 $cust_credit_bill->pkgnum( $credit->pkgnum )
6558 if $conf->exists('pkg-balances') && $credit->pkgnum;
6559 my $error = $cust_credit_bill->insert;
6561 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6565 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6569 my $total_unapplied_credits = $self->total_unapplied_credits;
6571 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6573 return $total_unapplied_credits;
6576 =item apply_payments [ OPTION => VALUE ... ]
6578 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
6579 to outstanding invoice balances in chronological order.
6581 #and returns the value of any remaining unapplied payments.
6583 A hash of optional arguments may be passed. Currently "manual" is supported.
6584 If true, a payment receipt is sent instead of a statement when
6585 'payment_receipt_email' configuration option is set.
6587 Dies if there is an error.
6591 sub apply_payments {
6592 my( $self, %options ) = @_;
6594 local $SIG{HUP} = 'IGNORE';
6595 local $SIG{INT} = 'IGNORE';
6596 local $SIG{QUIT} = 'IGNORE';
6597 local $SIG{TERM} = 'IGNORE';
6598 local $SIG{TSTP} = 'IGNORE';
6599 local $SIG{PIPE} = 'IGNORE';
6601 my $oldAutoCommit = $FS::UID::AutoCommit;
6602 local $FS::UID::AutoCommit = 0;
6605 $self->select_for_update; #mutex
6609 my @payments = sort { $b->_date <=> $a->_date }
6610 grep { $_->unapplied > 0 }
6613 my @invoices = sort { $a->_date <=> $b->_date}
6614 grep { $_->owed > 0 }
6617 if ( $conf->exists('pkg-balances') ) {
6618 # limit @payments to those w/ a pkgnum grepped from $self
6620 foreach my $i (@invoices) {
6621 foreach my $li ( $i->cust_bill_pkg ) {
6622 $pkgnums{$li->pkgnum} = 1;
6625 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
6630 foreach my $cust_bill ( @invoices ) {
6632 if ( !defined($payment) || $payment->unapplied == 0 ) {
6633 $payment = pop @payments or last;
6637 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
6638 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
6640 $owed = $cust_bill->owed;
6642 unless ( $owed > 0 ) {
6643 push @payments, $payment;
6647 my $amount = min( $payment->unapplied, $owed );
6649 my $cust_bill_pay = new FS::cust_bill_pay ( {
6650 'paynum' => $payment->paynum,
6651 'invnum' => $cust_bill->invnum,
6652 'amount' => $amount,
6654 $cust_bill_pay->pkgnum( $payment->pkgnum )
6655 if $conf->exists('pkg-balances') && $payment->pkgnum;
6656 my $error = $cust_bill_pay->insert(%options);
6658 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6662 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6666 my $total_unapplied_payments = $self->total_unapplied_payments;
6668 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6670 return $total_unapplied_payments;
6675 Returns the total owed for this customer on all invoices
6676 (see L<FS::cust_bill/owed>).
6682 $self->total_owed_date(2145859200); #12/31/2037
6685 =item total_owed_date TIME
6687 Returns the total owed for this customer on all invoices with date earlier than
6688 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6689 see L<Time::Local> and L<Date::Parse> for conversion functions.
6693 sub total_owed_date {
6697 # my $custnum = $self->custnum;
6699 # my $owed_sql = FS::cust_bill->owed_sql;
6702 # SELECT SUM($owed_sql) FROM cust_bill
6703 # WHERE custnum = $custnum
6704 # AND _date <= $time
6707 # my $sth = dbh->prepare($sql) or die dbh->errstr;
6708 # $sth->execute() or die $sth->errstr;
6710 # return sprintf( '%.2f', $sth->fetchrow_arrayref->[0] );
6713 foreach my $cust_bill (
6714 grep { $_->_date <= $time }
6715 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6717 $total_bill += $cust_bill->owed;
6719 sprintf( "%.2f", $total_bill );
6723 =item total_owed_pkgnum PKGNUM
6725 Returns the total owed on all invoices for this customer's specific package
6726 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
6730 sub total_owed_pkgnum {
6731 my( $self, $pkgnum ) = @_;
6732 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
6735 =item total_owed_date_pkgnum TIME PKGNUM
6737 Returns the total owed for this customer's specific package when using
6738 experimental package balances on all invoices with date earlier than
6739 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6740 see L<Time::Local> and L<Date::Parse> for conversion functions.
6744 sub total_owed_date_pkgnum {
6745 my( $self, $time, $pkgnum ) = @_;
6748 foreach my $cust_bill (
6749 grep { $_->_date <= $time }
6750 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6752 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
6754 sprintf( "%.2f", $total_bill );
6760 Returns the total amount of all payments.
6767 $total += $_->paid foreach $self->cust_pay;
6768 sprintf( "%.2f", $total );
6771 =item total_unapplied_credits
6773 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6774 customer. See L<FS::cust_credit/credited>.
6776 =item total_credited
6778 Old name for total_unapplied_credits. Don't use.
6782 sub total_credited {
6783 #carp "total_credited deprecated, use total_unapplied_credits";
6784 shift->total_unapplied_credits(@_);
6787 sub total_unapplied_credits {
6789 my $total_credit = 0;
6790 $total_credit += $_->credited foreach $self->cust_credit;
6791 sprintf( "%.2f", $total_credit );
6794 =item total_unapplied_credits_pkgnum PKGNUM
6796 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6797 customer. See L<FS::cust_credit/credited>.
6801 sub total_unapplied_credits_pkgnum {
6802 my( $self, $pkgnum ) = @_;
6803 my $total_credit = 0;
6804 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
6805 sprintf( "%.2f", $total_credit );
6809 =item total_unapplied_payments
6811 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
6812 See L<FS::cust_pay/unapplied>.
6816 sub total_unapplied_payments {
6818 my $total_unapplied = 0;
6819 $total_unapplied += $_->unapplied foreach $self->cust_pay;
6820 sprintf( "%.2f", $total_unapplied );
6823 =item total_unapplied_payments_pkgnum PKGNUM
6825 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
6826 specific package when using experimental package balances. See
6827 L<FS::cust_pay/unapplied>.
6831 sub total_unapplied_payments_pkgnum {
6832 my( $self, $pkgnum ) = @_;
6833 my $total_unapplied = 0;
6834 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
6835 sprintf( "%.2f", $total_unapplied );
6839 =item total_unapplied_refunds
6841 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
6842 customer. See L<FS::cust_refund/unapplied>.
6846 sub total_unapplied_refunds {
6848 my $total_unapplied = 0;
6849 $total_unapplied += $_->unapplied foreach $self->cust_refund;
6850 sprintf( "%.2f", $total_unapplied );
6855 Returns the balance for this customer (total_owed plus total_unrefunded, minus
6856 total_unapplied_credits minus total_unapplied_payments).
6864 + $self->total_unapplied_refunds
6865 - $self->total_unapplied_credits
6866 - $self->total_unapplied_payments
6870 =item balance_date TIME
6872 Returns the balance for this customer, only considering invoices with date
6873 earlier than TIME (total_owed_date minus total_credited minus
6874 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
6875 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
6884 $self->total_owed_date($time)
6885 + $self->total_unapplied_refunds
6886 - $self->total_unapplied_credits
6887 - $self->total_unapplied_payments
6891 =item balance_date_range START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
6893 Returns the balance for this customer, only considering invoices with date
6894 earlier than START_TIME, and optionally not later than END_TIME
6895 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
6897 Times are specified as SQL fragments or numeric
6898 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
6899 L<Date::Parse> for conversion functions. The empty string can be passed
6900 to disable that time constraint completely.
6902 Available options are:
6906 =item unapplied_date
6908 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)
6914 sub balance_date_range {
6916 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
6917 ') FROM cust_main WHERE custnum='. $self->custnum;
6918 sprintf( "%.2f", $self->scalar_sql($sql) );
6921 =item balance_pkgnum PKGNUM
6923 Returns the balance for this customer's specific package when using
6924 experimental package balances (total_owed plus total_unrefunded, minus
6925 total_unapplied_credits minus total_unapplied_payments)
6929 sub balance_pkgnum {
6930 my( $self, $pkgnum ) = @_;
6933 $self->total_owed_pkgnum($pkgnum)
6934 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
6935 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
6936 - $self->total_unapplied_credits_pkgnum($pkgnum)
6937 - $self->total_unapplied_payments_pkgnum($pkgnum)
6941 =item in_transit_payments
6943 Returns the total of requests for payments for this customer pending in
6944 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
6948 sub in_transit_payments {
6950 my $in_transit_payments = 0;
6951 foreach my $pay_batch ( qsearch('pay_batch', {
6954 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
6955 'batchnum' => $pay_batch->batchnum,
6956 'custnum' => $self->custnum,
6958 $in_transit_payments += $cust_pay_batch->amount;
6961 sprintf( "%.2f", $in_transit_payments );
6966 Returns a hash of useful information for making a payment.
6976 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
6977 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
6978 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
6982 For credit card transactions:
6994 For electronic check transactions:
7009 $return{balance} = $self->balance;
7011 $return{payname} = $self->payname
7012 || ( $self->first. ' '. $self->get('last') );
7014 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
7016 $return{payby} = $self->payby;
7017 $return{stateid_state} = $self->stateid_state;
7019 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
7020 $return{card_type} = cardtype($self->payinfo);
7021 $return{payinfo} = $self->paymask;
7023 @return{'month', 'year'} = $self->paydate_monthyear;
7027 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
7028 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
7029 $return{payinfo1} = $payinfo1;
7030 $return{payinfo2} = $payinfo2;
7031 $return{paytype} = $self->paytype;
7032 $return{paystate} = $self->paystate;
7036 #doubleclick protection
7038 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
7044 =item paydate_monthyear
7046 Returns a two-element list consisting of the month and year of this customer's
7047 paydate (credit card expiration date for CARD customers)
7051 sub paydate_monthyear {
7053 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
7055 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
7062 =item tax_exemption TAXNAME
7067 my( $self, $taxname ) = @_;
7069 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
7070 'taxname' => $taxname,
7075 =item cust_main_exemption
7079 sub cust_main_exemption {
7081 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
7084 =item invoicing_list [ ARRAYREF ]
7086 If an arguement is given, sets these email addresses as invoice recipients
7087 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
7088 (except as warnings), so use check_invoicing_list first.
7090 Returns a list of email addresses (with svcnum entries expanded).
7092 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
7093 check it without disturbing anything by passing nothing.
7095 This interface may change in the future.
7099 sub invoicing_list {
7100 my( $self, $arrayref ) = @_;
7103 my @cust_main_invoice;
7104 if ( $self->custnum ) {
7105 @cust_main_invoice =
7106 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7108 @cust_main_invoice = ();
7110 foreach my $cust_main_invoice ( @cust_main_invoice ) {
7111 #warn $cust_main_invoice->destnum;
7112 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
7113 #warn $cust_main_invoice->destnum;
7114 my $error = $cust_main_invoice->delete;
7115 warn $error if $error;
7118 if ( $self->custnum ) {
7119 @cust_main_invoice =
7120 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7122 @cust_main_invoice = ();
7124 my %seen = map { $_->address => 1 } @cust_main_invoice;
7125 foreach my $address ( @{$arrayref} ) {
7126 next if exists $seen{$address} && $seen{$address};
7127 $seen{$address} = 1;
7128 my $cust_main_invoice = new FS::cust_main_invoice ( {
7129 'custnum' => $self->custnum,
7132 my $error = $cust_main_invoice->insert;
7133 warn $error if $error;
7137 if ( $self->custnum ) {
7139 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7146 =item check_invoicing_list ARRAYREF
7148 Checks these arguements as valid input for the invoicing_list method. If there
7149 is an error, returns the error, otherwise returns false.
7153 sub check_invoicing_list {
7154 my( $self, $arrayref ) = @_;
7156 foreach my $address ( @$arrayref ) {
7158 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
7159 return 'Can\'t add FAX invoice destination with a blank FAX number.';
7162 my $cust_main_invoice = new FS::cust_main_invoice ( {
7163 'custnum' => $self->custnum,
7166 my $error = $self->custnum
7167 ? $cust_main_invoice->check
7168 : $cust_main_invoice->checkdest
7170 return $error if $error;
7174 return "Email address required"
7175 if $conf->exists('cust_main-require_invoicing_list_email')
7176 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
7181 =item set_default_invoicing_list
7183 Sets the invoicing list to all accounts associated with this customer,
7184 overwriting any previous invoicing list.
7188 sub set_default_invoicing_list {
7190 $self->invoicing_list($self->all_emails);
7195 Returns the email addresses of all accounts provisioned for this customer.
7202 foreach my $cust_pkg ( $self->all_pkgs ) {
7203 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
7205 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
7206 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
7208 $list{$_}=1 foreach map { $_->email } @svc_acct;
7213 =item invoicing_list_addpost
7215 Adds postal invoicing to this customer. If this customer is already configured
7216 to receive postal invoices, does nothing.
7220 sub invoicing_list_addpost {
7222 return if grep { $_ eq 'POST' } $self->invoicing_list;
7223 my @invoicing_list = $self->invoicing_list;
7224 push @invoicing_list, 'POST';
7225 $self->invoicing_list(\@invoicing_list);
7228 =item invoicing_list_emailonly
7230 Returns the list of email invoice recipients (invoicing_list without non-email
7231 destinations such as POST and FAX).
7235 sub invoicing_list_emailonly {
7237 warn "$me invoicing_list_emailonly called"
7239 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
7242 =item invoicing_list_emailonly_scalar
7244 Returns the list of email invoice recipients (invoicing_list without non-email
7245 destinations such as POST and FAX) as a comma-separated scalar.
7249 sub invoicing_list_emailonly_scalar {
7251 warn "$me invoicing_list_emailonly_scalar called"
7253 join(', ', $self->invoicing_list_emailonly);
7256 =item referral_custnum_cust_main
7258 Returns the customer who referred this customer (or the empty string, if
7259 this customer was not referred).
7261 Note the difference with referral_cust_main method: This method,
7262 referral_custnum_cust_main returns the single customer (if any) who referred
7263 this customer, while referral_cust_main returns an array of customers referred
7268 sub referral_custnum_cust_main {
7270 return '' unless $self->referral_custnum;
7271 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7274 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
7276 Returns an array of customers referred by this customer (referral_custnum set
7277 to this custnum). If DEPTH is given, recurses up to the given depth, returning
7278 customers referred by customers referred by this customer and so on, inclusive.
7279 The default behavior is DEPTH 1 (no recursion).
7281 Note the difference with referral_custnum_cust_main method: This method,
7282 referral_cust_main, returns an array of customers referred BY this customer,
7283 while referral_custnum_cust_main returns the single customer (if any) who
7284 referred this customer.
7288 sub referral_cust_main {
7290 my $depth = @_ ? shift : 1;
7291 my $exclude = @_ ? shift : {};
7294 map { $exclude->{$_->custnum}++; $_; }
7295 grep { ! $exclude->{ $_->custnum } }
7296 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
7300 map { $_->referral_cust_main($depth-1, $exclude) }
7307 =item referral_cust_main_ncancelled
7309 Same as referral_cust_main, except only returns customers with uncancelled
7314 sub referral_cust_main_ncancelled {
7316 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
7319 =item referral_cust_pkg [ DEPTH ]
7321 Like referral_cust_main, except returns a flat list of all unsuspended (and
7322 uncancelled) packages for each customer. The number of items in this list may
7323 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
7327 sub referral_cust_pkg {
7329 my $depth = @_ ? shift : 1;
7331 map { $_->unsuspended_pkgs }
7332 grep { $_->unsuspended_pkgs }
7333 $self->referral_cust_main($depth);
7336 =item referring_cust_main
7338 Returns the single cust_main record for the customer who referred this customer
7339 (referral_custnum), or false.
7343 sub referring_cust_main {
7345 return '' unless $self->referral_custnum;
7346 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7349 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
7351 Applies a credit to this customer. If there is an error, returns the error,
7352 otherwise returns false.
7354 REASON can be a text string, an FS::reason object, or a scalar reference to
7355 a reasonnum. If a text string, it will be automatically inserted as a new
7356 reason, and a 'reason_type' option must be passed to indicate the
7357 FS::reason_type for the new reason.
7359 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
7361 Any other options are passed to FS::cust_credit::insert.
7366 my( $self, $amount, $reason, %options ) = @_;
7368 my $cust_credit = new FS::cust_credit {
7369 'custnum' => $self->custnum,
7370 'amount' => $amount,
7373 if ( ref($reason) ) {
7375 if ( ref($reason) eq 'SCALAR' ) {
7376 $cust_credit->reasonnum( $$reason );
7378 $cust_credit->reasonnum( $reason->reasonnum );
7382 $cust_credit->set('reason', $reason)
7385 for (qw( addlinfo eventnum )) {
7386 $cust_credit->$_( delete $options{$_} )
7387 if exists($options{$_});
7390 $cust_credit->insert(%options);
7394 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
7397 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
7398 time will be ignored. Note that START_TIME and END_TIME only limit the date
7399 range for invoices and I<unapplied> payments, credits, and refunds.
7402 Creates a one-time charge for this customer. If there is an error, returns
7403 the error, otherwise returns false.
7405 New-style, with a hashref of options:
7407 my $error = $cust_main->charge(
7411 'start_date' => str2time('7/4/2009'),
7412 'pkg' => 'Description',
7413 'comment' => 'Comment',
7414 'additional' => [], #extra invoice detail
7415 'classnum' => 1, #pkg_class
7417 'setuptax' => '', # or 'Y' for tax exempt
7420 'taxclass' => 'Tax class',
7423 'taxproduct' => 2, #part_pkg_taxproduct
7424 'override' => {}, #XXX describe
7426 #will be filled in with the new object
7427 'cust_pkg_ref' => \$cust_pkg,
7429 #generate an invoice immediately
7431 'invoice_terms' => '', #with these terms
7437 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
7443 my ( $amount, $quantity, $start_date, $classnum );
7444 my ( $pkg, $comment, $additional );
7445 my ( $setuptax, $taxclass ); #internal taxes
7446 my ( $taxproduct, $override ); #vendor (CCH) taxes
7447 my $cust_pkg_ref = '';
7448 my ( $bill_now, $invoice_terms ) = ( 0, '' );
7449 if ( ref( $_[0] ) ) {
7450 $amount = $_[0]->{amount};
7451 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
7452 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
7453 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
7454 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
7455 : '$'. sprintf("%.2f",$amount);
7456 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
7457 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
7458 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
7459 $additional = $_[0]->{additional} || [];
7460 $taxproduct = $_[0]->{taxproductnum};
7461 $override = { '' => $_[0]->{tax_override} };
7462 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
7463 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
7464 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
7469 $pkg = @_ ? shift : 'One-time charge';
7470 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
7472 $taxclass = @_ ? shift : '';
7476 local $SIG{HUP} = 'IGNORE';
7477 local $SIG{INT} = 'IGNORE';
7478 local $SIG{QUIT} = 'IGNORE';
7479 local $SIG{TERM} = 'IGNORE';
7480 local $SIG{TSTP} = 'IGNORE';
7481 local $SIG{PIPE} = 'IGNORE';
7483 my $oldAutoCommit = $FS::UID::AutoCommit;
7484 local $FS::UID::AutoCommit = 0;
7487 my $part_pkg = new FS::part_pkg ( {
7489 'comment' => $comment,
7493 'classnum' => $classnum ? $classnum : '',
7494 'setuptax' => $setuptax,
7495 'taxclass' => $taxclass,
7496 'taxproductnum' => $taxproduct,
7499 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
7500 ( 0 .. @$additional - 1 )
7502 'additional_count' => scalar(@$additional),
7503 'setup_fee' => $amount,
7506 my $error = $part_pkg->insert( options => \%options,
7507 tax_overrides => $override,
7510 $dbh->rollback if $oldAutoCommit;
7514 my $pkgpart = $part_pkg->pkgpart;
7515 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
7516 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
7517 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
7518 $error = $type_pkgs->insert;
7520 $dbh->rollback if $oldAutoCommit;
7525 my $cust_pkg = new FS::cust_pkg ( {
7526 'custnum' => $self->custnum,
7527 'pkgpart' => $pkgpart,
7528 'quantity' => $quantity,
7529 'start_date' => $start_date,
7532 $error = $cust_pkg->insert;
7534 $dbh->rollback if $oldAutoCommit;
7536 } elsif ( $cust_pkg_ref ) {
7537 ${$cust_pkg_ref} = $cust_pkg;
7541 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
7542 'pkg_list' => [ $cust_pkg ],
7545 $dbh->rollback if $oldAutoCommit;
7550 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
7555 #=item charge_postal_fee
7557 #Applies a one time charge this customer. If there is an error,
7558 #returns the error, returns the cust_pkg charge object or false
7559 #if there was no charge.
7563 # This should be a customer event. For that to work requires that bill
7564 # also be a customer event.
7566 sub charge_postal_fee {
7569 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
7570 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
7572 my $cust_pkg = new FS::cust_pkg ( {
7573 'custnum' => $self->custnum,
7574 'pkgpart' => $pkgpart,
7578 my $error = $cust_pkg->insert;
7579 $error ? $error : $cust_pkg;
7584 Returns all the invoices (see L<FS::cust_bill>) for this customer.
7590 map { $_ } #return $self->num_cust_bill unless wantarray;
7591 sort { $a->_date <=> $b->_date }
7592 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
7595 =item open_cust_bill
7597 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
7602 sub open_cust_bill {
7606 'table' => 'cust_bill',
7607 'hashref' => { 'custnum' => $self->custnum, },
7608 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
7609 'order_by' => 'ORDER BY _date ASC',
7614 =item cust_statements
7616 Returns all the statements (see L<FS::cust_statement>) for this customer.
7620 sub cust_statement {
7622 map { $_ } #return $self->num_cust_statement unless wantarray;
7623 sort { $a->_date <=> $b->_date }
7624 qsearch('cust_statement', { 'custnum' => $self->custnum, } )
7629 Returns all the credits (see L<FS::cust_credit>) for this customer.
7635 map { $_ } #return $self->num_cust_credit unless wantarray;
7636 sort { $a->_date <=> $b->_date }
7637 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
7640 =item cust_credit_pkgnum
7642 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
7643 package when using experimental package balances.
7647 sub cust_credit_pkgnum {
7648 my( $self, $pkgnum ) = @_;
7649 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
7650 sort { $a->_date <=> $b->_date }
7651 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
7652 'pkgnum' => $pkgnum,
7659 Returns all the payments (see L<FS::cust_pay>) for this customer.
7665 return $self->num_cust_pay unless wantarray;
7666 sort { $a->_date <=> $b->_date }
7667 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
7672 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
7673 called automatically when the cust_pay method is used in a scalar context.
7679 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
7680 my $sth = dbh->prepare($sql) or die dbh->errstr;
7681 $sth->execute($self->custnum) or die $sth->errstr;
7682 $sth->fetchrow_arrayref->[0];
7685 =item cust_pay_pkgnum
7687 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
7688 package when using experimental package balances.
7692 sub cust_pay_pkgnum {
7693 my( $self, $pkgnum ) = @_;
7694 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
7695 sort { $a->_date <=> $b->_date }
7696 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
7697 'pkgnum' => $pkgnum,
7704 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
7710 map { $_ } #return $self->num_cust_pay_void unless wantarray;
7711 sort { $a->_date <=> $b->_date }
7712 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
7715 =item cust_pay_batch
7717 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
7721 sub cust_pay_batch {
7723 map { $_ } #return $self->num_cust_pay_batch unless wantarray;
7724 sort { $a->paybatchnum <=> $b->paybatchnum }
7725 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
7728 =item cust_pay_pending
7730 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
7731 (without status "done").
7735 sub cust_pay_pending {
7737 return $self->num_cust_pay_pending unless wantarray;
7738 sort { $a->_date <=> $b->_date }
7739 qsearch( 'cust_pay_pending', {
7740 'custnum' => $self->custnum,
7741 'status' => { op=>'!=', value=>'done' },
7746 =item num_cust_pay_pending
7748 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
7749 customer (without status "done"). Also called automatically when the
7750 cust_pay_pending method is used in a scalar context.
7754 sub num_cust_pay_pending {
7756 my $sql = " SELECT COUNT(*) FROM cust_pay_pending ".
7757 " WHERE custnum = ? AND status != 'done' ";
7758 my $sth = dbh->prepare($sql) or die dbh->errstr;
7759 $sth->execute($self->custnum) or die $sth->errstr;
7760 $sth->fetchrow_arrayref->[0];
7765 Returns all the refunds (see L<FS::cust_refund>) for this customer.
7771 map { $_ } #return $self->num_cust_refund unless wantarray;
7772 sort { $a->_date <=> $b->_date }
7773 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
7776 =item display_custnum
7778 Returns the displayed customer number for this customer: agent_custid if
7779 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
7783 sub display_custnum {
7785 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
7786 return $self->agent_custid;
7788 return $self->custnum;
7794 Returns a name string for this customer, either "Company (Last, First)" or
7801 my $name = $self->contact;
7802 $name = $self->company. " ($name)" if $self->company;
7808 Returns a name string for this (service/shipping) contact, either
7809 "Company (Last, First)" or "Last, First".
7815 if ( $self->get('ship_last') ) {
7816 my $name = $self->ship_contact;
7817 $name = $self->ship_company. " ($name)" if $self->ship_company;
7826 Returns a name string for this customer, either "Company" or "First Last".
7832 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
7835 =item ship_name_short
7837 Returns a name string for this (service/shipping) contact, either "Company"
7842 sub ship_name_short {
7844 if ( $self->get('ship_last') ) {
7845 $self->ship_company !~ /^\s*$/
7846 ? $self->ship_company
7847 : $self->ship_contact_firstlast;
7849 $self->name_company_or_firstlast;
7855 Returns this customer's full (billing) contact name only, "Last, First"
7861 $self->get('last'). ', '. $self->first;
7866 Returns this customer's full (shipping) contact name only, "Last, First"
7872 $self->get('ship_last')
7873 ? $self->get('ship_last'). ', '. $self->ship_first
7877 =item contact_firstlast
7879 Returns this customers full (billing) contact name only, "First Last".
7883 sub contact_firstlast {
7885 $self->first. ' '. $self->get('last');
7888 =item ship_contact_firstlast
7890 Returns this customer's full (shipping) contact name only, "First Last".
7894 sub ship_contact_firstlast {
7896 $self->get('ship_last')
7897 ? $self->first. ' '. $self->get('ship_last')
7898 : $self->contact_firstlast;
7903 Returns this customer's full country name
7909 code2country($self->country);
7912 =item geocode DATA_VENDOR
7914 Returns a value for the customer location as encoded by DATA_VENDOR.
7915 Currently this only makes sense for "CCH" as DATA_VENDOR.
7920 my ($self, $data_vendor) = (shift, shift); #always cch for now
7922 my $geocode = $self->get('geocode'); #XXX only one data_vendor for geocode
7923 return $geocode if $geocode;
7925 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
7929 my($zip,$plus4) = split /-/, $self->get("${prefix}zip")
7930 if $self->country eq 'US';
7934 #CCH specific location stuff
7935 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
7937 my @cust_tax_location =
7939 'table' => 'cust_tax_location',
7940 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
7941 'extra_sql' => $extra_sql,
7942 'order_by' => 'ORDER BY plus4hi',#overlapping with distinct ends
7945 $geocode = $cust_tax_location[0]->geocode
7946 if scalar(@cust_tax_location);
7955 Returns a status string for this customer, currently:
7959 =item prospect - No packages have ever been ordered
7961 =item active - One or more recurring packages is active
7963 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
7965 =item suspended - All non-cancelled recurring packages are suspended
7967 =item cancelled - All recurring packages are cancelled
7973 sub status { shift->cust_status(@_); }
7977 for my $status (qw( prospect active inactive suspended cancelled )) {
7978 my $method = $status.'_sql';
7979 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
7980 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
7981 $sth->execute( ($self->custnum) x $numnum )
7982 or die "Error executing 'SELECT $sql': ". $sth->errstr;
7983 return $status if $sth->fetchrow_arrayref->[0];
7987 =item ucfirst_cust_status
7989 =item ucfirst_status
7991 Returns the status with the first character capitalized.
7995 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
7997 sub ucfirst_cust_status {
7999 ucfirst($self->cust_status);
8004 Returns a hex triplet color string for this customer's status.
8008 use vars qw(%statuscolor);
8009 tie %statuscolor, 'Tie::IxHash',
8010 'prospect' => '7e0079', #'000000', #black? naw, purple
8011 'active' => '00CC00', #green
8012 'inactive' => '0000CC', #blue
8013 'suspended' => 'FF9900', #yellow
8014 'cancelled' => 'FF0000', #red
8017 sub statuscolor { shift->cust_statuscolor(@_); }
8019 sub cust_statuscolor {
8021 $statuscolor{$self->cust_status};
8026 Returns an array of hashes representing the customer's RT tickets.
8033 my $num = $conf->config('cust_main-max_tickets') || 10;
8036 if ( $conf->config('ticket_system') ) {
8037 unless ( $conf->config('ticket_system-custom_priority_field') ) {
8039 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
8043 foreach my $priority (
8044 $conf->config('ticket_system-custom_priority_field-values'), ''
8046 last if scalar(@tickets) >= $num;
8048 @{ FS::TicketSystem->customer_tickets( $self->custnum,
8049 $num - scalar(@tickets),
8059 # Return services representing svc_accts in customer support packages
8060 sub support_services {
8062 my %packages = map { $_ => 1 } $conf->config('support_packages');
8064 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
8065 grep { $_->part_svc->svcdb eq 'svc_acct' }
8066 map { $_->cust_svc }
8067 grep { exists $packages{ $_->pkgpart } }
8068 $self->ncancelled_pkgs;
8072 # Return a list of latitude/longitude for one of the services (if any)
8073 sub service_coordinates {
8077 grep { $_->latitude && $_->longitude }
8079 map { $_->cust_svc }
8080 $self->ncancelled_pkgs;
8082 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
8087 =head1 CLASS METHODS
8093 Class method that returns the list of possible status strings for customers
8094 (see L<the status method|/status>). For example:
8096 @statuses = FS::cust_main->statuses();
8101 #my $self = shift; #could be class...
8107 Returns an SQL expression identifying prospective cust_main records (customers
8108 with no packages ever ordered)
8112 use vars qw($select_count_pkgs);
8113 $select_count_pkgs =
8114 "SELECT COUNT(*) FROM cust_pkg
8115 WHERE cust_pkg.custnum = cust_main.custnum";
8117 sub select_count_pkgs_sql {
8121 sub prospect_sql { "
8122 0 = ( $select_count_pkgs )
8127 Returns an SQL expression identifying active cust_main records (customers with
8128 active recurring packages).
8133 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
8139 Returns an SQL expression identifying inactive cust_main records (customers with
8140 no active recurring packages, but otherwise unsuspended/uncancelled).
8144 sub inactive_sql { "
8145 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
8147 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
8153 Returns an SQL expression identifying suspended cust_main records.
8158 sub suspended_sql { susp_sql(@_); }
8160 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
8162 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
8168 Returns an SQL expression identifying cancelled cust_main records.
8172 sub cancelled_sql { cancel_sql(@_); }
8175 my $recurring_sql = FS::cust_pkg->recurring_sql;
8176 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
8179 0 < ( $select_count_pkgs )
8180 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
8181 AND 0 = ( $select_count_pkgs AND $recurring_sql
8182 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
8184 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
8190 =item uncancelled_sql
8192 Returns an SQL expression identifying un-cancelled cust_main records.
8196 sub uncancelled_sql { uncancel_sql(@_); }
8197 sub uncancel_sql { "
8198 ( 0 < ( $select_count_pkgs
8199 AND ( cust_pkg.cancel IS NULL
8200 OR cust_pkg.cancel = 0
8203 OR 0 = ( $select_count_pkgs )
8209 Returns an SQL fragment to retreive the balance.
8214 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
8215 WHERE cust_bill.custnum = cust_main.custnum )
8216 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
8217 WHERE cust_pay.custnum = cust_main.custnum )
8218 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
8219 WHERE cust_credit.custnum = cust_main.custnum )
8220 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
8221 WHERE cust_refund.custnum = cust_main.custnum )
8224 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8226 Returns an SQL fragment to retreive the balance for this customer, only
8227 considering invoices with date earlier than START_TIME, and optionally not
8228 later than END_TIME (total_owed_date minus total_unapplied_credits minus
8229 total_unapplied_payments).
8231 Times are specified as SQL fragments or numeric
8232 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
8233 L<Date::Parse> for conversion functions. The empty string can be passed
8234 to disable that time constraint completely.
8236 Available options are:
8240 =item unapplied_date
8242 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)
8247 set to true to remove all customer comparison clauses, for totals
8252 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
8257 JOIN clause (typically used with the total option)
8263 sub balance_date_sql {
8264 my( $class, $start, $end, %opt ) = @_;
8266 my $cutoff = $opt{'cutoff'};
8268 my $owed = FS::cust_bill->owed_sql($cutoff);
8269 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
8270 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
8271 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
8273 my $j = $opt{'join'} || '';
8275 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
8276 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
8277 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
8278 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
8280 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
8281 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
8282 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
8283 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
8288 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
8290 Returns an SQL fragment to retreive the total unapplied payments for this
8291 customer, only considering invoices with date earlier than START_TIME, and
8292 optionally not later than END_TIME.
8294 Times are specified as SQL fragments or numeric
8295 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
8296 L<Date::Parse> for conversion functions. The empty string can be passed
8297 to disable that time constraint completely.
8299 Available options are:
8303 sub unapplied_payments_date_sql {
8304 my( $class, $start, $end, ) = @_;
8306 my $unapp_pay = FS::cust_pay->unapplied_sql;
8308 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
8309 'unapplied_date'=>1 );
8311 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
8314 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8316 Helper method for balance_date_sql; name (and usage) subject to change
8317 (suggestions welcome).
8319 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
8320 cust_refund, cust_credit or cust_pay).
8322 If TABLE is "cust_bill" or the unapplied_date option is true, only
8323 considers records with date earlier than START_TIME, and optionally not
8324 later than END_TIME .
8328 sub _money_table_where {
8329 my( $class, $table, $start, $end, %opt ) = @_;
8332 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
8333 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
8334 push @where, "$table._date <= $start" if defined($start) && length($start);
8335 push @where, "$table._date > $end" if defined($end) && length($end);
8337 push @where, @{$opt{'where'}} if $opt{'where'};
8338 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
8344 =item search HASHREF
8348 Returns a qsearch hash expression to search for parameters specified in
8349 HASHREF. Valid parameters are
8357 =item cancelled_pkgs
8363 listref of start date, end date
8373 =item current_balance
8375 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
8379 =item flattened_pkgs
8388 my ($class, $params) = @_;
8399 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
8401 "cust_main.agentnum = $1";
8408 #prospect active inactive suspended cancelled
8409 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
8410 my $method = $params->{'status'}. '_sql';
8411 #push @where, $class->$method();
8412 push @where, FS::cust_main->$method();
8416 # parse cancelled package checkbox
8421 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
8422 unless $params->{'cancelled_pkgs'};
8425 # parse without census tract checkbox
8428 push @where, "(censustract = '' or censustract is null)"
8429 if $params->{'no_censustract'};
8435 foreach my $field (qw( signupdate )) {
8437 next unless exists($params->{$field});
8439 my($beginning, $ending) = @{$params->{$field}};
8442 "cust_main.$field IS NOT NULL",
8443 "cust_main.$field >= $beginning",
8444 "cust_main.$field <= $ending";
8446 $orderby ||= "ORDER BY cust_main.$field";
8454 if ( $params->{'payby'} ) {
8456 my @payby = ref( $params->{'payby'} )
8457 ? @{ $params->{'payby'} }
8458 : ( $params->{'payby'} );
8460 @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
8462 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )'
8467 my @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
8469 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )';
8473 # paydate_year / paydate_month
8476 if ( $params->{'paydate_year'} =~ /^(\d{4})$/ ) {
8478 $params->{'paydate_month'} =~ /^(\d\d?)$/
8479 or die "paydate_year without paydate_month?";
8483 'paydate IS NOT NULL',
8485 "CAST(paydate AS timestamp) < CAST('$year-$month-01' AS timestamp )"
8493 if ( $params->{'invoice_terms'} =~ /^([\w ]+)$/ ) {
8495 if ( $1 eq 'NULL' ) {
8497 "( cust_main.invoice_terms IS NULL OR cust_main.invoice_terms = '' )";
8500 "cust_main.invoice_terms IS NOT NULL",
8501 "cust_main.invoice_terms = '$1'";
8509 if ( $params->{'current_balance'} ) {
8511 #my $balance_sql = $class->balance_sql();
8512 my $balance_sql = FS::cust_main->balance_sql();
8514 my @current_balance =
8515 ref( $params->{'current_balance'} )
8516 ? @{ $params->{'current_balance'} }
8517 : ( $params->{'current_balance'} );
8519 push @where, map { s/current_balance/$balance_sql/; $_ }
8528 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
8530 "cust_main.custbatch = '$1'";
8534 # setup queries, subs, etc. for the search
8537 $orderby ||= 'ORDER BY custnum';
8539 # here is the agent virtualization
8540 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
8542 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
8544 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
8546 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
8548 my $select = join(', ',
8549 'cust_main.custnum',
8550 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
8553 my(@extra_headers) = ();
8554 my(@extra_fields) = ();
8556 if ($params->{'flattened_pkgs'}) {
8558 if ($dbh->{Driver}->{Name} eq 'Pg') {
8560 $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";
8562 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
8563 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
8564 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
8566 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
8567 "omitting packing information from report.";
8570 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";
8572 my $sth = dbh->prepare($header_query) or die dbh->errstr;
8573 $sth->execute() or die $sth->errstr;
8574 my $headerrow = $sth->fetchrow_arrayref;
8575 my $headercount = $headerrow ? $headerrow->[0] : 0;
8576 while($headercount) {
8577 unshift @extra_headers, "Package ". $headercount;
8578 unshift @extra_fields, eval q!sub {my $c = shift;
8579 my @a = split '\|', $c->magic;
8580 my $p = $a[!.--$headercount. q!];
8588 'table' => 'cust_main',
8589 'select' => $select,
8591 'extra_sql' => $extra_sql,
8592 'order_by' => $orderby,
8593 'count_query' => $count_query,
8594 'extra_headers' => \@extra_headers,
8595 'extra_fields' => \@extra_fields,
8600 =item email_search_result HASHREF
8604 Emails a notice to the specified customers.
8606 Valid parameters are those of the L<search> method, plus the following:
8628 Optional job queue job for status updates.
8632 Returns an error message, or false for success.
8634 If an error occurs during any email, stops the enture send and returns that
8635 error. Presumably if you're getting SMTP errors aborting is better than
8636 retrying everything.
8640 sub email_search_result {
8641 my($class, $params) = @_;
8643 my $from = delete $params->{from};
8644 my $subject = delete $params->{subject};
8645 my $html_body = delete $params->{html_body};
8646 my $text_body = delete $params->{text_body};
8648 my $job = delete $params->{'job'};
8650 $params->{'payby'} = [ split(/\0/, $params->{'payby'}) ]
8651 unless ref($params->{'payby'});
8653 my $sql_query = $class->search($params);
8655 my $count_query = delete($sql_query->{'count_query'});
8656 my $count_sth = dbh->prepare($count_query)
8657 or die "Error preparing $count_query: ". dbh->errstr;
8659 or die "Error executing $count_query: ". $count_sth->errstr;
8660 my $count_arrayref = $count_sth->fetchrow_arrayref;
8661 my $num_cust = $count_arrayref->[0];
8663 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
8664 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
8667 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
8669 #eventually order+limit magic to reduce memory use?
8670 foreach my $cust_main ( qsearch($sql_query) ) {
8672 my $to = $cust_main->invoicing_list_emailonly_scalar;
8675 my $error = send_email(
8679 'subject' => $subject,
8680 'html_body' => $html_body,
8681 'text_body' => $text_body,
8684 return $error if $error;
8686 if ( $job ) { #progressbar foo
8688 if ( time - $min_sec > $last ) {
8689 my $error = $job->update_statustext(
8690 int( 100 * $num / $num_cust )
8692 die $error if $error;
8702 use Storable qw(thaw);
8705 sub process_email_search_result {
8707 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
8709 my $param = thaw(decode_base64(shift));
8710 warn Dumper($param) if $DEBUG;
8712 $param->{'job'} = $job;
8714 $param->{'payby'} = [ split(/\0/, $param->{'payby'}) ]
8715 unless ref($param->{'payby'});
8717 my $error = FS::cust_main->email_search_result( $param );
8718 die $error if $error;
8722 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
8724 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
8725 records. Currently, I<first>, I<last>, I<company> and/or I<address1> may be
8726 specified (the appropriate ship_ field is also searched).
8728 Additional options are the same as FS::Record::qsearch
8733 my( $self, $fuzzy, $hash, @opt) = @_;
8738 check_and_rebuild_fuzzyfiles();
8739 foreach my $field ( keys %$fuzzy ) {
8741 my $all = $self->all_X($field);
8742 next unless scalar(@$all);
8745 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
8748 foreach ( keys %match ) {
8749 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
8750 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
8753 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
8756 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
8758 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
8766 Returns a masked version of the named field
8771 my ($self,$field) = @_;
8775 'x'x(length($self->getfield($field))-4).
8776 substr($self->getfield($field), (length($self->getfield($field))-4));
8786 =item smart_search OPTION => VALUE ...
8788 Accepts the following options: I<search>, the string to search for. The string
8789 will be searched for as a customer number, phone number, name or company name,
8790 as an exact, or, in some cases, a substring or fuzzy match (see the source code
8791 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
8792 skip fuzzy matching when an exact match is found.
8794 Any additional options are treated as an additional qualifier on the search
8797 Returns a (possibly empty) array of FS::cust_main objects.
8804 #here is the agent virtualization
8805 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8809 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
8810 my $search = delete $options{'search'};
8811 ( my $alphanum_search = $search ) =~ s/\W//g;
8813 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
8815 #false laziness w/Record::ut_phone
8816 my $phonen = "$1-$2-$3";
8817 $phonen .= " x$4" if $4;
8819 push @cust_main, qsearch( {
8820 'table' => 'cust_main',
8821 'hashref' => { %options },
8822 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8824 join(' OR ', map "$_ = '$phonen'",
8825 qw( daytime night fax
8826 ship_daytime ship_night ship_fax )
8829 " AND $agentnums_sql", #agent virtualization
8832 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
8833 #try looking for matches with extensions unless one was specified
8835 push @cust_main, qsearch( {
8836 'table' => 'cust_main',
8837 'hashref' => { %options },
8838 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8840 join(' OR ', map "$_ LIKE '$phonen\%'",
8842 ship_daytime ship_night )
8845 " AND $agentnums_sql", #agent virtualization
8850 # custnum search (also try agent_custid), with some tweaking options if your
8851 # legacy cust "numbers" have letters
8854 if ( $search =~ /^\s*(\d+)\s*$/
8855 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
8856 && $search =~ /^\s*(\w\w?\d+)\s*$/
8858 || ( $conf->exists('address1-search' )
8859 && $search =~ /^\s*(\d+\-?\w*)\s*$/ #i.e. 1234A or 9432-D
8866 if ( $num =~ /^(\d+)$/ && $num <= 2147483647 ) { #need a bigint custnum? wow
8867 push @cust_main, qsearch( {
8868 'table' => 'cust_main',
8869 'hashref' => { 'custnum' => $num, %options },
8870 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8874 push @cust_main, qsearch( {
8875 'table' => 'cust_main',
8876 'hashref' => { 'agent_custid' => $num, %options },
8877 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8880 if ( $conf->exists('address1-search') ) {
8881 my $len = length($num);
8883 foreach my $prefix ( '', 'ship_' ) {
8884 push @cust_main, qsearch( {
8885 'table' => 'cust_main',
8886 'hashref' => { %options, },
8888 ( keys(%options) ? ' AND ' : ' WHERE ' ).
8889 " LOWER(SUBSTRING(${prefix}address1 FROM 1 FOR $len)) = '$num' ".
8890 " AND $agentnums_sql",
8895 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
8897 my($company, $last, $first) = ( $1, $2, $3 );
8899 # "Company (Last, First)"
8900 #this is probably something a browser remembered,
8901 #so just do an exact search (but case-insensitive, so USPS standardization
8902 #doesn't throw a wrench in the works)
8904 foreach my $prefix ( '', 'ship_' ) {
8905 push @cust_main, qsearch( {
8906 'table' => 'cust_main',
8907 'hashref' => { %options },
8909 ( keys(%options) ? ' AND ' : ' WHERE ' ).
8911 " LOWER(${prefix}first) = ". dbh->quote(lc($first)),
8912 " LOWER(${prefix}last) = ". dbh->quote(lc($last)),
8913 " LOWER(${prefix}company) = ". dbh->quote(lc($company)),
8919 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
8920 # try (ship_){last,company}
8924 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
8925 # # full strings the browser remembers won't work
8926 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
8928 use Lingua::EN::NameParse;
8929 my $NameParse = new Lingua::EN::NameParse(
8931 allow_reversed => 1,
8934 my($last, $first) = ( '', '' );
8935 #maybe disable this too and just rely on NameParse?
8936 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
8938 ($last, $first) = ( $1, $2 );
8940 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
8941 } elsif ( ! $NameParse->parse($value) ) {
8943 my %name = $NameParse->components;
8944 $first = $name{'given_name_1'};
8945 $last = $name{'surname_1'};
8949 if ( $first && $last ) {
8951 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
8954 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8956 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
8957 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
8960 push @cust_main, qsearch( {
8961 'table' => 'cust_main',
8962 'hashref' => \%options,
8963 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8966 # or it just be something that was typed in... (try that in a sec)
8970 my $q_value = dbh->quote($value);
8973 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8974 $sql .= " ( LOWER(last) = $q_value
8975 OR LOWER(company) = $q_value
8976 OR LOWER(ship_last) = $q_value
8977 OR LOWER(ship_company) = $q_value
8979 $sql .= " OR LOWER(address1) = $q_value
8980 OR LOWER(ship_address1) = $q_value
8982 if $conf->exists('address1-search');
8985 push @cust_main, qsearch( {
8986 'table' => 'cust_main',
8987 'hashref' => \%options,
8988 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8991 #no exact match, trying substring/fuzzy
8992 #always do substring & fuzzy (unless they're explicity config'ed off)
8993 #getting complaints searches are not returning enough
8994 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
8996 #still some false laziness w/search (was search/cust_main.cgi)
9001 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
9002 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
9005 if ( $first && $last ) {
9008 { 'first' => { op=>'ILIKE', value=>"%$first%" },
9009 'last' => { op=>'ILIKE', value=>"%$last%" },
9011 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
9012 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
9019 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
9020 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
9024 if ( $conf->exists('address1-search') ) {
9026 { 'address1' => { op=>'ILIKE', value=>"%$value%" }, },
9027 { 'ship_address1' => { op=>'ILIKE', value=>"%$value%" }, },
9031 foreach my $hashref ( @hashrefs ) {
9033 push @cust_main, qsearch( {
9034 'table' => 'cust_main',
9035 'hashref' => { %$hashref,
9038 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
9047 " AND $agentnums_sql", #extra_sql #agent virtualization
9050 if ( $first && $last ) {
9051 push @cust_main, FS::cust_main->fuzzy_search(
9052 { 'last' => $last, #fuzzy hashref
9053 'first' => $first }, #
9057 foreach my $field ( 'last', 'company' ) {
9059 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
9061 if ( $conf->exists('address1-search') ) {
9063 FS::cust_main->fuzzy_search( { 'address1' => $value }, @fuzopts );
9070 #eliminate duplicates
9072 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
9080 Accepts the following options: I<email>, the email address to search for. The
9081 email address will be searched for as an email invoice destination and as an
9084 #Any additional options are treated as an additional qualifier on the search
9085 #(i.e. I<agentnum>).
9087 Returns a (possibly empty) array of FS::cust_main objects (but usually just
9097 my $email = delete $options{'email'};
9099 #we're only being used by RT at the moment... no agent virtualization yet
9100 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
9104 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
9106 my ( $user, $domain ) = ( $1, $2 );
9108 warn "$me smart_search: searching for $user in domain $domain"
9114 'table' => 'cust_main_invoice',
9115 'hashref' => { 'dest' => $email },
9122 map $_->cust_svc->cust_pkg,
9124 'table' => 'svc_acct',
9125 'hashref' => { 'username' => $user, },
9127 'AND ( SELECT domain FROM svc_domain
9128 WHERE svc_acct.domsvc = svc_domain.svcnum
9129 ) = '. dbh->quote($domain),
9135 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
9137 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
9144 =item check_and_rebuild_fuzzyfiles
9148 sub check_and_rebuild_fuzzyfiles {
9149 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9150 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
9153 =item rebuild_fuzzyfiles
9157 sub rebuild_fuzzyfiles {
9159 use Fcntl qw(:flock);
9161 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9162 mkdir $dir, 0700 unless -d $dir;
9164 foreach my $fuzzy ( @fuzzyfields ) {
9166 open(LOCK,">>$dir/cust_main.$fuzzy")
9167 or die "can't open $dir/cust_main.$fuzzy: $!";
9169 or die "can't lock $dir/cust_main.$fuzzy: $!";
9171 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
9172 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
9174 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
9175 my $sth = dbh->prepare("SELECT $field FROM cust_main".
9176 " WHERE $field != '' AND $field IS NOT NULL");
9177 $sth->execute or die $sth->errstr;
9179 while ( my $row = $sth->fetchrow_arrayref ) {
9180 print CACHE $row->[0]. "\n";
9185 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
9187 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
9198 my( $self, $field ) = @_;
9199 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9200 open(CACHE,"<$dir/cust_main.$field")
9201 or die "can't open $dir/cust_main.$field: $!";
9202 my @array = map { chomp; $_; } <CACHE>;
9207 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
9211 sub append_fuzzyfiles {
9212 #my( $first, $last, $company ) = @_;
9214 &check_and_rebuild_fuzzyfiles;
9216 use Fcntl qw(:flock);
9218 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9220 foreach my $field (@fuzzyfields) {
9225 open(CACHE,">>$dir/cust_main.$field")
9226 or die "can't open $dir/cust_main.$field: $!";
9227 flock(CACHE,LOCK_EX)
9228 or die "can't lock $dir/cust_main.$field: $!";
9230 print CACHE "$value\n";
9232 flock(CACHE,LOCK_UN)
9233 or die "can't unlock $dir/cust_main.$field: $!";
9248 #warn join('-',keys %$param);
9249 my $fh = $param->{filehandle};
9250 my @fields = @{$param->{fields}};
9252 eval "use Text::CSV_XS;";
9255 my $csv = new Text::CSV_XS;
9262 local $SIG{HUP} = 'IGNORE';
9263 local $SIG{INT} = 'IGNORE';
9264 local $SIG{QUIT} = 'IGNORE';
9265 local $SIG{TERM} = 'IGNORE';
9266 local $SIG{TSTP} = 'IGNORE';
9267 local $SIG{PIPE} = 'IGNORE';
9269 my $oldAutoCommit = $FS::UID::AutoCommit;
9270 local $FS::UID::AutoCommit = 0;
9273 #while ( $columns = $csv->getline($fh) ) {
9275 while ( defined($line=<$fh>) ) {
9277 $csv->parse($line) or do {
9278 $dbh->rollback if $oldAutoCommit;
9279 return "can't parse: ". $csv->error_input();
9282 my @columns = $csv->fields();
9283 #warn join('-',@columns);
9286 foreach my $field ( @fields ) {
9287 $row{$field} = shift @columns;
9290 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
9291 unless ( $cust_main ) {
9292 $dbh->rollback if $oldAutoCommit;
9293 return "unknown custnum $row{'custnum'}";
9296 if ( $row{'amount'} > 0 ) {
9297 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
9299 $dbh->rollback if $oldAutoCommit;
9303 } elsif ( $row{'amount'} < 0 ) {
9304 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
9307 $dbh->rollback if $oldAutoCommit;
9317 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
9319 return "Empty file!" unless $imported;
9325 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9327 Sends a templated email notification to the customer (see L<Text::Template>).
9329 OPTIONS is a hash and may include
9331 I<from> - the email sender (default is invoice_from)
9333 I<to> - comma-separated scalar or arrayref of recipients
9334 (default is invoicing_list)
9336 I<subject> - The subject line of the sent email notification
9337 (default is "Notice from company_name")
9339 I<extra_fields> - a hashref of name/value pairs which will be substituted
9342 The following variables are vavailable in the template.
9344 I<$first> - the customer first name
9345 I<$last> - the customer last name
9346 I<$company> - the customer company
9347 I<$payby> - a description of the method of payment for the customer
9348 # would be nice to use FS::payby::shortname
9349 I<$payinfo> - the account information used to collect for this customer
9350 I<$expdate> - the expiration of the customer payment in seconds from epoch
9355 my ($self, $template, %options) = @_;
9357 return unless $conf->exists($template);
9359 my $from = $conf->config('invoice_from', $self->agentnum)
9360 if $conf->exists('invoice_from', $self->agentnum);
9361 $from = $options{from} if exists($options{from});
9363 my $to = join(',', $self->invoicing_list_emailonly);
9364 $to = $options{to} if exists($options{to});
9366 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
9367 if $conf->exists('company_name', $self->agentnum);
9368 $subject = $options{subject} if exists($options{subject});
9370 my $notify_template = new Text::Template (TYPE => 'ARRAY',
9371 SOURCE => [ map "$_\n",
9372 $conf->config($template)]
9374 or die "can't create new Text::Template object: Text::Template::ERROR";
9375 $notify_template->compile()
9376 or die "can't compile template: Text::Template::ERROR";
9378 $FS::notify_template::_template::company_name =
9379 $conf->config('company_name', $self->agentnum);
9380 $FS::notify_template::_template::company_address =
9381 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
9383 my $paydate = $self->paydate || '2037-12-31';
9384 $FS::notify_template::_template::first = $self->first;
9385 $FS::notify_template::_template::last = $self->last;
9386 $FS::notify_template::_template::company = $self->company;
9387 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
9388 my $payby = $self->payby;
9389 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9390 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9392 #credit cards expire at the end of the month/year of their exp date
9393 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9394 $FS::notify_template::_template::payby = 'credit card';
9395 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9396 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9398 }elsif ($payby eq 'COMP') {
9399 $FS::notify_template::_template::payby = 'complimentary account';
9401 $FS::notify_template::_template::payby = 'current method';
9403 $FS::notify_template::_template::expdate = $expire_time;
9405 for (keys %{$options{extra_fields}}){
9407 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
9410 send_email(from => $from,
9412 subject => $subject,
9413 body => $notify_template->fill_in( PACKAGE =>
9414 'FS::notify_template::_template' ),
9419 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9421 Generates a templated notification to the customer (see L<Text::Template>).
9423 OPTIONS is a hash and may include
9425 I<extra_fields> - a hashref of name/value pairs which will be substituted
9426 into the template. These values may override values mentioned below
9427 and those from the customer record.
9429 The following variables are available in the template instead of or in addition
9430 to the fields of the customer record.
9432 I<$payby> - a description of the method of payment for the customer
9433 # would be nice to use FS::payby::shortname
9434 I<$payinfo> - the masked account information used to collect for this customer
9435 I<$expdate> - the expiration of the customer payment method in seconds from epoch
9436 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
9440 sub generate_letter {
9441 my ($self, $template, %options) = @_;
9443 return unless $conf->exists($template);
9445 my $letter_template = new Text::Template
9447 SOURCE => [ map "$_\n", $conf->config($template)],
9448 DELIMITERS => [ '[@--', '--@]' ],
9450 or die "can't create new Text::Template object: Text::Template::ERROR";
9452 $letter_template->compile()
9453 or die "can't compile template: Text::Template::ERROR";
9455 my %letter_data = map { $_ => $self->$_ } $self->fields;
9456 $letter_data{payinfo} = $self->mask_payinfo;
9458 #my $paydate = $self->paydate || '2037-12-31';
9459 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
9461 my $payby = $self->payby;
9462 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9463 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9465 #credit cards expire at the end of the month/year of their exp date
9466 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9467 $letter_data{payby} = 'credit card';
9468 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9469 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9471 }elsif ($payby eq 'COMP') {
9472 $letter_data{payby} = 'complimentary account';
9474 $letter_data{payby} = 'current method';
9476 $letter_data{expdate} = $expire_time;
9478 for (keys %{$options{extra_fields}}){
9479 $letter_data{$_} = $options{extra_fields}->{$_};
9482 unless(exists($letter_data{returnaddress})){
9483 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
9484 $self->agent_template)
9486 if ( length($retadd) ) {
9487 $letter_data{returnaddress} = $retadd;
9488 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
9489 $letter_data{returnaddress} =
9490 join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
9491 $conf->config('company_address', $self->agentnum)
9494 $letter_data{returnaddress} = '~';
9498 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
9500 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
9502 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
9503 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
9507 ) or die "can't open temp file: $!\n";
9509 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
9511 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
9515 =item print_ps TEMPLATE
9517 Returns an postscript letter filled in from TEMPLATE, as a scalar.
9523 my $file = $self->generate_letter(@_);
9524 FS::Misc::generate_ps($file);
9527 =item print TEMPLATE
9529 Prints the filled in template.
9531 TEMPLATE is the name of a L<Text::Template> to fill in and print.
9535 sub queueable_print {
9538 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
9539 or die "invalid customer number: " . $opt{custvnum};
9541 my $error = $self->print( $opt{template} );
9542 die $error if $error;
9546 my ($self, $template) = (shift, shift);
9547 do_print [ $self->print_ps($template) ];
9550 #these three subs should just go away once agent stuff is all config overrides
9552 sub agent_template {
9554 $self->_agent_plandata('agent_templatename');
9557 sub agent_invoice_from {
9559 $self->_agent_plandata('agent_invoice_from');
9562 sub _agent_plandata {
9563 my( $self, $option ) = @_;
9565 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
9566 #agent-specific Conf
9568 use FS::part_event::Condition;
9570 my $agentnum = $self->agentnum;
9573 if ( driver_name =~ /^Pg/i ) {
9575 } elsif ( driver_name =~ /^mysql/i ) {
9578 die "don't know how to use regular expressions in ". driver_name. " databases";
9581 my $part_event_option =
9583 'select' => 'part_event_option.*',
9584 'table' => 'part_event_option',
9586 LEFT JOIN part_event USING ( eventpart )
9587 LEFT JOIN part_event_option AS peo_agentnum
9588 ON ( part_event.eventpart = peo_agentnum.eventpart
9589 AND peo_agentnum.optionname = 'agentnum'
9590 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
9592 LEFT JOIN part_event_condition
9593 ON ( part_event.eventpart = part_event_condition.eventpart
9594 AND part_event_condition.conditionname = 'cust_bill_age'
9596 LEFT JOIN part_event_condition_option
9597 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
9598 AND part_event_condition_option.optionname = 'age'
9601 #'hashref' => { 'optionname' => $option },
9602 #'hashref' => { 'part_event_option.optionname' => $option },
9604 " WHERE part_event_option.optionname = ". dbh->quote($option).
9605 " AND action = 'cust_bill_send_agent' ".
9606 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
9607 " AND peo_agentnum.optionname = 'agentnum' ".
9608 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
9610 CASE WHEN part_event_condition_option.optionname IS NULL
9612 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
9614 , part_event.weight".
9618 unless ( $part_event_option ) {
9619 return $self->agent->invoice_template || ''
9620 if $option eq 'agent_templatename';
9624 $part_event_option->optionvalue;
9629 ## actual sub, not a method, designed to be called from the queue.
9630 ## sets up the customer, and calls the bill_and_collect
9631 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
9632 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
9633 $cust_main->bill_and_collect(
9638 sub _upgrade_data { #class method
9639 my ($class, %opts) = @_;
9641 my $sql = 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL';
9642 my $sth = dbh->prepare($sql) or die dbh->errstr;
9643 $sth->execute or die $sth->errstr;
9653 The delete method should possibly take an FS::cust_main object reference
9654 instead of a scalar customer number.
9656 Bill and collect options should probably be passed as references instead of a
9659 There should probably be a configuration file with a list of allowed credit
9662 No multiple currency support (probably a larger project than just this module).
9664 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
9666 Birthdates rely on negative epoch values.
9668 The payby for card/check batches is broken. With mixed batching, bad
9671 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
9675 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
9676 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
9677 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.