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;
57 use FS::cust_credit_bill;
58 use FS::cust_bill_pay;
59 use FS::prepay_credit;
63 use FS::part_event_condition;
66 use FS::payment_gateway;
67 use FS::agent_payment_gateway;
69 use FS::payinfo_Mixin;
72 @ISA = qw( FS::payinfo_Mixin FS::Record );
74 @EXPORT_OK = qw( smart_search );
76 $realtime_bop_decline_quiet = 0;
78 # 1 is mostly method/subroutine entry and options
79 # 2 traces progress of some operations
80 # 3 is even more information including possibly sensitive data
82 $me = '[FS::cust_main]';
85 $ignore_expired_card = 0;
88 @fuzzyfields = ( 'first', 'last', 'company', 'address1' );
90 @encrypted_fields = ('payinfo', 'paycvv');
91 sub nohistory_fields { ('paycvv'); }
93 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
95 #ask FS::UID to run this stuff for us later
96 #$FS::UID::callback{'FS::cust_main'} = sub {
97 install_callback FS::UID sub {
99 #yes, need it for stuff below (prolly should be cached)
104 my ( $hashref, $cache ) = @_;
105 if ( exists $hashref->{'pkgnum'} ) {
106 #@{ $self->{'_pkgnum'} } = ();
107 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
108 $self->{'_pkgnum'} = $subcache;
109 #push @{ $self->{'_pkgnum'} },
110 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
116 FS::cust_main - Object methods for cust_main records
122 $record = new FS::cust_main \%hash;
123 $record = new FS::cust_main { 'column' => 'value' };
125 $error = $record->insert;
127 $error = $new_record->replace($old_record);
129 $error = $record->delete;
131 $error = $record->check;
133 @cust_pkg = $record->all_pkgs;
135 @cust_pkg = $record->ncancelled_pkgs;
137 @cust_pkg = $record->suspended_pkgs;
139 $error = $record->bill;
140 $error = $record->bill %options;
141 $error = $record->bill 'time' => $time;
143 $error = $record->collect;
144 $error = $record->collect %options;
145 $error = $record->collect 'invoice_time' => $time,
150 An FS::cust_main object represents a customer. FS::cust_main inherits from
151 FS::Record. The following fields are currently supported:
157 Primary key (assigned automatically for new customers)
161 Agent (see L<FS::agent>)
165 Advertising source (see L<FS::part_referral>)
177 Cocial security number (optional)
193 (optional, see L<FS::cust_main_county>)
197 (see L<FS::cust_main_county>)
203 (see L<FS::cust_main_county>)
239 (optional, see L<FS::cust_main_county>)
243 (see L<FS::cust_main_county>)
249 (see L<FS::cust_main_county>)
265 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
269 Payment Information (See L<FS::payinfo_Mixin> for data format)
273 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
277 Card Verification Value, "CVV2" (also known as CVC2 or CID), the 3 or 4 digit number on the back (or front, for American Express) of the credit card
281 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
285 Start date month (maestro/solo cards only)
289 Start date year (maestro/solo cards only)
293 Issue number (maestro/solo cards only)
297 Name on card or billing name
301 IP address from which payment information was received
305 Tax exempt, empty or `Y'
309 Order taker (assigned automatically, see L<FS::UID>)
315 =item referral_custnum
317 Referring customer number
321 Enable individual CDR spooling, empty or `Y'
325 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
329 Discourage individual CDR printing, empty or `Y'
339 Creates a new customer. To add the customer to the database, see L<"insert">.
341 Note that this stores the hash reference, not a distinct copy of the hash it
342 points to. You can ask the object for a copy with the I<hash> method.
346 sub table { 'cust_main'; }
348 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
350 Adds this customer to the database. If there is an error, returns the error,
351 otherwise returns false.
353 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
354 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
355 are inserted atomicly, or the transaction is rolled back. Passing an empty
356 hash reference is equivalent to not supplying this parameter. There should be
357 a better explanation of this, but until then, here's an example:
360 tie %hash, 'Tie::RefHash'; #this part is important
362 $cust_pkg => [ $svc_acct ],
365 $cust_main->insert( \%hash );
367 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
368 be set as the invoicing list (see L<"invoicing_list">). Errors return as
369 expected and rollback the entire transaction; it is not necessary to call
370 check_invoicing_list first. The invoicing_list is set after the records in the
371 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
372 invoicing_list destination to the newly-created svc_acct. Here's an example:
374 $cust_main->insert( {}, [ $email, 'POST' ] );
376 Currently available options are: I<depend_jobnum>, I<noexport> and I<tax_exemption>.
378 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
379 on the supplied jobnum (they will not run until the specific job completes).
380 This can be used to defer provisioning until some action completes (such
381 as running the customer's credit card successfully).
383 The I<noexport> option is deprecated. If I<noexport> is set true, no
384 provisioning jobs (exports) are scheduled. (You can schedule them later with
385 the B<reexport> method.)
387 The I<tax_exemption> option can be set to an arrayref of tax names.
388 FS::cust_main_exemption records will be created and inserted.
394 my $cust_pkgs = @_ ? shift : {};
395 my $invoicing_list = @_ ? shift : '';
397 warn "$me insert called with options ".
398 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
401 local $SIG{HUP} = 'IGNORE';
402 local $SIG{INT} = 'IGNORE';
403 local $SIG{QUIT} = 'IGNORE';
404 local $SIG{TERM} = 'IGNORE';
405 local $SIG{TSTP} = 'IGNORE';
406 local $SIG{PIPE} = 'IGNORE';
408 my $oldAutoCommit = $FS::UID::AutoCommit;
409 local $FS::UID::AutoCommit = 0;
412 my $prepay_identifier = '';
413 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
415 if ( $self->payby eq 'PREPAY' ) {
417 $self->payby('BILL');
418 $prepay_identifier = $self->payinfo;
421 warn " looking up prepaid card $prepay_identifier\n"
424 my $error = $self->get_prepay( $prepay_identifier,
425 'amount_ref' => \$amount,
426 'seconds_ref' => \$seconds,
427 'upbytes_ref' => \$upbytes,
428 'downbytes_ref' => \$downbytes,
429 'totalbytes_ref' => \$totalbytes,
432 $dbh->rollback if $oldAutoCommit;
433 #return "error applying prepaid card (transaction rolled back): $error";
437 $payby = 'PREP' if $amount;
439 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
442 $self->payby('BILL');
443 $amount = $self->paid;
447 warn " inserting $self\n"
450 $self->signupdate(time) unless $self->signupdate;
452 $self->auto_agent_custid()
453 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
455 my $error = $self->SUPER::insert;
457 $dbh->rollback if $oldAutoCommit;
458 #return "inserting cust_main record (transaction rolled back): $error";
462 warn " setting invoicing list\n"
465 if ( $invoicing_list ) {
466 $error = $self->check_invoicing_list( $invoicing_list );
468 $dbh->rollback if $oldAutoCommit;
469 #return "checking invoicing_list (transaction rolled back): $error";
472 $self->invoicing_list( $invoicing_list );
475 warn " setting customer tags\n"
478 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
479 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
480 'custnum' => $self->custnum };
481 my $error = $cust_tag->insert;
483 $dbh->rollback if $oldAutoCommit;
488 if ( $invoicing_list ) {
489 $error = $self->check_invoicing_list( $invoicing_list );
491 $dbh->rollback if $oldAutoCommit;
492 #return "checking invoicing_list (transaction rolled back): $error";
495 $self->invoicing_list( $invoicing_list );
499 warn " setting cust_main_exemption\n"
502 my $tax_exemption = delete $options{'tax_exemption'};
503 if ( $tax_exemption ) {
504 foreach my $taxname ( @$tax_exemption ) {
505 my $cust_main_exemption = new FS::cust_main_exemption {
506 'custnum' => $self->custnum,
507 'taxname' => $taxname,
509 my $error = $cust_main_exemption->insert;
511 $dbh->rollback if $oldAutoCommit;
512 return "inserting cust_main_exemption (transaction rolled back): $error";
517 if ( $conf->config('cust_main-skeleton_tables')
518 && $conf->config('cust_main-skeleton_custnum') ) {
520 warn " inserting skeleton records\n"
523 my $error = $self->start_copy_skel;
525 $dbh->rollback if $oldAutoCommit;
531 warn " ordering packages\n"
534 $error = $self->order_pkgs( $cust_pkgs,
536 'seconds_ref' => \$seconds,
537 'upbytes_ref' => \$upbytes,
538 'downbytes_ref' => \$downbytes,
539 'totalbytes_ref' => \$totalbytes,
542 $dbh->rollback if $oldAutoCommit;
547 $dbh->rollback if $oldAutoCommit;
548 return "No svc_acct record to apply pre-paid time";
550 if ( $upbytes || $downbytes || $totalbytes ) {
551 $dbh->rollback if $oldAutoCommit;
552 return "No svc_acct record to apply pre-paid data";
556 warn " inserting initial $payby payment of $amount\n"
558 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
560 $dbh->rollback if $oldAutoCommit;
561 return "inserting payment (transaction rolled back): $error";
565 unless ( $import || $skip_fuzzyfiles ) {
566 warn " queueing fuzzyfiles update\n"
568 $error = $self->queue_fuzzyfiles_update;
570 $dbh->rollback if $oldAutoCommit;
571 return "updating fuzzy search cache: $error";
575 warn " insert complete; committing transaction\n"
578 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
583 use File::CounterFile;
584 sub auto_agent_custid {
587 my $format = $conf->config('cust_main-auto_agent_custid');
589 if ( $format eq '1YMMXXXXXXXX' ) {
591 my $counter = new File::CounterFile 'cust_main.agent_custid';
594 my $ym = 100000000000 + time2str('%y%m00000000', time);
595 if ( $ym > $counter->value ) {
596 $counter->{'value'} = $agent_custid = $ym;
597 $counter->{'updated'} = 1;
599 $agent_custid = $counter->inc;
605 die "Unknown cust_main-auto_agent_custid format: $format";
608 $self->agent_custid($agent_custid);
612 sub start_copy_skel {
615 #'mg_user_preference' => {},
616 #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
617 #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
618 #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
619 #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
620 my @tables = eval(join('\n',$conf->config('cust_main-skeleton_tables')));
623 _copy_skel( 'cust_main', #tablename
624 $conf->config('cust_main-skeleton_custnum'), #sourceid
625 $self->custnum, #destid
626 @tables, #child tables
630 #recursive subroutine, not a method
632 my( $table, $sourceid, $destid, %child_tables ) = @_;
635 if ( $table =~ /^(\w+)\.(\w+)$/ ) {
636 ( $table, $primary_key ) = ( $1, $2 );
638 my $dbdef_table = dbdef->table($table);
639 $primary_key = $dbdef_table->primary_key
640 or return "$table has no primary key".
641 " (or do you need to run dbdef-create?)";
644 warn " _copy_skel: $table.$primary_key $sourceid to $destid for ".
645 join (', ', keys %child_tables). "\n"
648 foreach my $child_table_def ( keys %child_tables ) {
652 if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
653 ( $child_table, $child_pkey ) = ( $1, $2 );
655 $child_table = $child_table_def;
657 $child_pkey = dbdef->table($child_table)->primary_key;
658 # or return "$table has no primary key".
659 # " (or do you need to run dbdef-create?)\n";
663 if ( keys %{ $child_tables{$child_table_def} } ) {
665 return "$child_table has no primary key".
666 " (run dbdef-create or try specifying it?)\n"
669 #false laziness w/Record::insert and only works on Pg
670 #refactor the proper last-inserted-id stuff out of Record::insert if this
671 # ever gets use for anything besides a quick kludge for one customer
672 my $default = dbdef->table($child_table)->column($child_pkey)->default;
673 $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
674 or return "can't parse $child_table.$child_pkey default value ".
675 " for sequence name: $default";
680 my @sel_columns = grep { $_ ne $primary_key }
681 dbdef->table($child_table)->columns;
682 my $sel_columns = join(', ', @sel_columns );
684 my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
685 my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
686 my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
688 my $sel_st = "SELECT $sel_columns FROM $child_table".
689 " WHERE $primary_key = $sourceid";
692 my $sel_sth = dbh->prepare( $sel_st )
693 or return dbh->errstr;
695 $sel_sth->execute or return $sel_sth->errstr;
697 while ( my $row = $sel_sth->fetchrow_hashref ) {
699 warn " selected row: ".
700 join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
704 "INSERT INTO $child_table $ins_columns VALUES $placeholders";
705 my $ins_sth =dbh->prepare($statement)
706 or return dbh->errstr;
707 my @param = ( $destid, map $row->{$_}, @ins_columns );
708 warn " $statement: [ ". join(', ', @param). " ]\n"
710 $ins_sth->execute( @param )
711 or return $ins_sth->errstr;
713 #next unless keys %{ $child_tables{$child_table} };
714 next unless $sequence;
716 #another section of that laziness
717 my $seq_sql = "SELECT currval('$sequence')";
718 my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
719 $seq_sth->execute or return $seq_sth->errstr;
720 my $insertid = $seq_sth->fetchrow_arrayref->[0];
722 # don't drink soap! recurse! recurse! okay!
724 _copy_skel( $child_table_def,
725 $row->{$child_pkey}, #sourceid
727 %{ $child_tables{$child_table_def} },
729 return $error if $error;
739 =item order_pkg HASHREF | OPTION => VALUE ...
741 Orders a single package.
743 Options may be passed as a list of key/value pairs or as a hash reference.
754 Optional FS::cust_location object
758 Optional arryaref of FS::svc_* service objects.
762 If this option is set to a job queue jobnum (see L<FS::queue>), all provisioning
763 jobs will have a dependancy on the supplied job (they will not run until the
764 specific job completes). This can be used to defer provisioning until some
765 action completes (such as running the customer's credit card successfully).
769 Optional subject for a ticket created and attached to this customer
773 Optional queue name for ticket additions
781 my $opt = ref($_[0]) ? shift : { @_ };
783 warn "$me order_pkg called with options ".
784 join(', ', map { "$_: $opt->{$_}" } keys %$opt ). "\n"
787 my $cust_pkg = $opt->{'cust_pkg'};
788 my $svcs = $opt->{'svcs'} || [];
790 my %svc_options = ();
791 $svc_options{'depend_jobnum'} = $opt->{'depend_jobnum'}
792 if exists($opt->{'depend_jobnum'}) && $opt->{'depend_jobnum'};
794 my %insert_params = map { $opt->{$_} ? ( $_ => $opt->{$_} ) : () }
795 qw( ticket_subject ticket_queue );
797 local $SIG{HUP} = 'IGNORE';
798 local $SIG{INT} = 'IGNORE';
799 local $SIG{QUIT} = 'IGNORE';
800 local $SIG{TERM} = 'IGNORE';
801 local $SIG{TSTP} = 'IGNORE';
802 local $SIG{PIPE} = 'IGNORE';
804 my $oldAutoCommit = $FS::UID::AutoCommit;
805 local $FS::UID::AutoCommit = 0;
808 if ( $opt->{'cust_location'} &&
809 ( ! $cust_pkg->locationnum || $cust_pkg->locationnum == -1 ) ) {
810 my $error = $opt->{'cust_location'}->insert;
812 $dbh->rollback if $oldAutoCommit;
813 return "inserting cust_location (transaction rolled back): $error";
815 $cust_pkg->locationnum($opt->{'cust_location'}->locationnum);
818 $cust_pkg->custnum( $self->custnum );
820 my $error = $cust_pkg->insert( %insert_params );
822 $dbh->rollback if $oldAutoCommit;
823 return "inserting cust_pkg (transaction rolled back): $error";
826 foreach my $svc_something ( @{ $opt->{'svcs'} } ) {
827 if ( $svc_something->svcnum ) {
828 my $old_cust_svc = $svc_something->cust_svc;
829 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
830 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
831 $error = $new_cust_svc->replace($old_cust_svc);
833 $svc_something->pkgnum( $cust_pkg->pkgnum );
834 if ( $svc_something->isa('FS::svc_acct') ) {
835 foreach ( grep { $opt->{$_.'_ref'} && ${ $opt->{$_.'_ref'} } }
836 qw( seconds upbytes downbytes totalbytes ) ) {
837 $svc_something->$_( $svc_something->$_() + ${ $opt->{$_.'_ref'} } );
838 ${ $opt->{$_.'_ref'} } = 0;
841 $error = $svc_something->insert(%svc_options);
844 $dbh->rollback if $oldAutoCommit;
845 return "inserting svc_ (transaction rolled back): $error";
849 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
854 #deprecated #=item order_pkgs HASHREF [ , SECONDSREF ] [ , OPTION => VALUE ... ]
855 =item order_pkgs HASHREF [ , OPTION => VALUE ... ]
857 Like the insert method on an existing record, this method orders multiple
858 packages and included services atomicaly. Pass a Tie::RefHash data structure
859 to this method containing FS::cust_pkg and FS::svc_I<tablename> objects.
860 There should be a better explanation of this, but until then, here's an
864 tie %hash, 'Tie::RefHash'; #this part is important
866 $cust_pkg => [ $svc_acct ],
869 $cust_main->order_pkgs( \%hash, 'noexport'=>1 );
871 Services can be new, in which case they are inserted, or existing unaudited
872 services, in which case they are linked to the newly-created package.
874 Currently available options are: I<depend_jobnum>, I<noexport>, I<seconds_ref>,
875 I<upbytes_ref>, I<downbytes_ref>, and I<totalbytes_ref>.
877 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
878 on the supplied jobnum (they will not run until the specific job completes).
879 This can be used to defer provisioning until some action completes (such
880 as running the customer's credit card successfully).
882 The I<noexport> option is deprecated. If I<noexport> is set true, no
883 provisioning jobs (exports) are scheduled. (You can schedule them later with
884 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
885 on the cust_main object is not recommended, as existing services will also be
888 If I<seconds_ref>, I<upbytes_ref>, I<downbytes_ref>, or I<totalbytes_ref> is
889 provided, the scalars (provided by references) will be incremented by the
890 values of the prepaid card.`
896 my $cust_pkgs = shift;
897 my $seconds_ref = ref($_[0]) ? shift : ''; #deprecated
899 $seconds_ref ||= $options{'seconds_ref'};
901 warn "$me order_pkgs called with options ".
902 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
905 local $SIG{HUP} = 'IGNORE';
906 local $SIG{INT} = 'IGNORE';
907 local $SIG{QUIT} = 'IGNORE';
908 local $SIG{TERM} = 'IGNORE';
909 local $SIG{TSTP} = 'IGNORE';
910 local $SIG{PIPE} = 'IGNORE';
912 my $oldAutoCommit = $FS::UID::AutoCommit;
913 local $FS::UID::AutoCommit = 0;
916 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
918 foreach my $cust_pkg ( keys %$cust_pkgs ) {
920 my $error = $self->order_pkg(
921 'cust_pkg' => $cust_pkg,
922 'svcs' => $cust_pkgs->{$cust_pkg},
923 'seconds_ref' => $seconds_ref,
924 map { $_ => $options{$_} } qw( upbytes_ref downbytes_ref totalbytes_ref
929 $dbh->rollback if $oldAutoCommit;
935 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
939 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
941 Recharges this (existing) customer with the specified prepaid card (see
942 L<FS::prepay_credit>), specified either by I<identifier> or as an
943 FS::prepay_credit object. If there is an error, returns the error, otherwise
946 Optionally, five scalar references can be passed as well. They will have their
947 values filled in with the amount, number of seconds, and number of upload,
948 download, and total bytes applied by this prepaid card.
952 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
953 #the only place that uses these args
954 sub recharge_prepay {
955 my( $self, $prepay_credit, $amountref, $secondsref,
956 $upbytesref, $downbytesref, $totalbytesref ) = @_;
958 local $SIG{HUP} = 'IGNORE';
959 local $SIG{INT} = 'IGNORE';
960 local $SIG{QUIT} = 'IGNORE';
961 local $SIG{TERM} = 'IGNORE';
962 local $SIG{TSTP} = 'IGNORE';
963 local $SIG{PIPE} = 'IGNORE';
965 my $oldAutoCommit = $FS::UID::AutoCommit;
966 local $FS::UID::AutoCommit = 0;
969 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
971 my $error = $self->get_prepay( $prepay_credit,
972 'amount_ref' => \$amount,
973 'seconds_ref' => \$seconds,
974 'upbytes_ref' => \$upbytes,
975 'downbytes_ref' => \$downbytes,
976 'totalbytes_ref' => \$totalbytes,
978 || $self->increment_seconds($seconds)
979 || $self->increment_upbytes($upbytes)
980 || $self->increment_downbytes($downbytes)
981 || $self->increment_totalbytes($totalbytes)
982 || $self->insert_cust_pay_prepay( $amount,
984 ? $prepay_credit->identifier
989 $dbh->rollback if $oldAutoCommit;
993 if ( defined($amountref) ) { $$amountref = $amount; }
994 if ( defined($secondsref) ) { $$secondsref = $seconds; }
995 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
996 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
997 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
999 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1004 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
1006 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
1007 specified either by I<identifier> or as an FS::prepay_credit object.
1009 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
1010 incremented by the values of the prepaid card.
1012 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
1013 check or set this customer's I<agentnum>.
1015 If there is an error, returns the error, otherwise returns false.
1021 my( $self, $prepay_credit, %opt ) = @_;
1023 local $SIG{HUP} = 'IGNORE';
1024 local $SIG{INT} = 'IGNORE';
1025 local $SIG{QUIT} = 'IGNORE';
1026 local $SIG{TERM} = 'IGNORE';
1027 local $SIG{TSTP} = 'IGNORE';
1028 local $SIG{PIPE} = 'IGNORE';
1030 my $oldAutoCommit = $FS::UID::AutoCommit;
1031 local $FS::UID::AutoCommit = 0;
1034 unless ( ref($prepay_credit) ) {
1036 my $identifier = $prepay_credit;
1038 $prepay_credit = qsearchs(
1040 { 'identifier' => $prepay_credit },
1045 unless ( $prepay_credit ) {
1046 $dbh->rollback if $oldAutoCommit;
1047 return "Invalid prepaid card: ". $identifier;
1052 if ( $prepay_credit->agentnum ) {
1053 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
1054 $dbh->rollback if $oldAutoCommit;
1055 return "prepaid card not valid for agent ". $self->agentnum;
1057 $self->agentnum($prepay_credit->agentnum);
1060 my $error = $prepay_credit->delete;
1062 $dbh->rollback if $oldAutoCommit;
1063 return "removing prepay_credit (transaction rolled back): $error";
1066 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
1067 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
1069 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1074 =item increment_upbytes SECONDS
1076 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1077 the specified number of upbytes. If there is an error, returns the error,
1078 otherwise returns false.
1082 sub increment_upbytes {
1083 _increment_column( shift, 'upbytes', @_);
1086 =item increment_downbytes SECONDS
1088 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1089 the specified number of downbytes. If there is an error, returns the error,
1090 otherwise returns false.
1094 sub increment_downbytes {
1095 _increment_column( shift, 'downbytes', @_);
1098 =item increment_totalbytes SECONDS
1100 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1101 the specified number of totalbytes. If there is an error, returns the error,
1102 otherwise returns false.
1106 sub increment_totalbytes {
1107 _increment_column( shift, 'totalbytes', @_);
1110 =item increment_seconds SECONDS
1112 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1113 the specified number of seconds. If there is an error, returns the error,
1114 otherwise returns false.
1118 sub increment_seconds {
1119 _increment_column( shift, 'seconds', @_);
1122 =item _increment_column AMOUNT
1124 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1125 the specified number of seconds or bytes. If there is an error, returns
1126 the error, otherwise returns false.
1130 sub _increment_column {
1131 my( $self, $column, $amount ) = @_;
1132 warn "$me increment_column called: $column, $amount\n"
1135 return '' unless $amount;
1137 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1138 $self->ncancelled_pkgs;
1140 if ( ! @cust_pkg ) {
1141 return 'No packages with primary or single services found'.
1142 ' to apply pre-paid time';
1143 } elsif ( scalar(@cust_pkg) > 1 ) {
1144 #maybe have a way to specify the package/account?
1145 return 'Multiple packages found to apply pre-paid time';
1148 my $cust_pkg = $cust_pkg[0];
1149 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1153 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1155 if ( ! @cust_svc ) {
1156 return 'No account found to apply pre-paid time';
1157 } elsif ( scalar(@cust_svc) > 1 ) {
1158 return 'Multiple accounts found to apply pre-paid time';
1161 my $svc_acct = $cust_svc[0]->svc_x;
1162 warn " found service svcnum ". $svc_acct->pkgnum.
1163 ' ('. $svc_acct->email. ")\n"
1166 $column = "increment_$column";
1167 $svc_acct->$column($amount);
1171 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1173 Inserts a prepayment in the specified amount for this customer. An optional
1174 second argument can specify the prepayment identifier for tracking purposes.
1175 If there is an error, returns the error, otherwise returns false.
1179 sub insert_cust_pay_prepay {
1180 shift->insert_cust_pay('PREP', @_);
1183 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1185 Inserts a cash payment in the specified amount for this customer. An optional
1186 second argument can specify the payment identifier for tracking purposes.
1187 If there is an error, returns the error, otherwise returns false.
1191 sub insert_cust_pay_cash {
1192 shift->insert_cust_pay('CASH', @_);
1195 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1197 Inserts a Western Union payment in the specified amount for this customer. An
1198 optional second argument can specify the prepayment identifier for tracking
1199 purposes. If there is an error, returns the error, otherwise returns false.
1203 sub insert_cust_pay_west {
1204 shift->insert_cust_pay('WEST', @_);
1207 sub insert_cust_pay {
1208 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1209 my $payinfo = scalar(@_) ? shift : '';
1211 my $cust_pay = new FS::cust_pay {
1212 'custnum' => $self->custnum,
1213 'paid' => sprintf('%.2f', $amount),
1214 #'_date' => #date the prepaid card was purchased???
1216 'payinfo' => $payinfo,
1224 This method is deprecated. See the I<depend_jobnum> option to the insert and
1225 order_pkgs methods for a better way to defer provisioning.
1227 Re-schedules all exports by calling the B<reexport> method of all associated
1228 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
1229 otherwise returns false.
1236 carp "WARNING: FS::cust_main::reexport is deprectated; ".
1237 "use the depend_jobnum option to insert or order_pkgs to delay export";
1239 local $SIG{HUP} = 'IGNORE';
1240 local $SIG{INT} = 'IGNORE';
1241 local $SIG{QUIT} = 'IGNORE';
1242 local $SIG{TERM} = 'IGNORE';
1243 local $SIG{TSTP} = 'IGNORE';
1244 local $SIG{PIPE} = 'IGNORE';
1246 my $oldAutoCommit = $FS::UID::AutoCommit;
1247 local $FS::UID::AutoCommit = 0;
1250 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1251 my $error = $cust_pkg->reexport;
1253 $dbh->rollback if $oldAutoCommit;
1258 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1263 =item delete NEW_CUSTNUM
1265 This deletes the customer. If there is an error, returns the error, otherwise
1268 This will completely remove all traces of the customer record. This is not
1269 what you want when a customer cancels service; for that, cancel all of the
1270 customer's packages (see L</cancel>).
1272 If the customer has any uncancelled packages, you need to pass a new (valid)
1273 customer number for those packages to be transferred to. Cancelled packages
1274 will be deleted. Did I mention that this is NOT what you want when a customer
1275 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
1277 You can't delete a customer with invoices (see L<FS::cust_bill>),
1278 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
1279 refunds (see L<FS::cust_refund>).
1286 local $SIG{HUP} = 'IGNORE';
1287 local $SIG{INT} = 'IGNORE';
1288 local $SIG{QUIT} = 'IGNORE';
1289 local $SIG{TERM} = 'IGNORE';
1290 local $SIG{TSTP} = 'IGNORE';
1291 local $SIG{PIPE} = 'IGNORE';
1293 my $oldAutoCommit = $FS::UID::AutoCommit;
1294 local $FS::UID::AutoCommit = 0;
1297 if ( $self->cust_bill ) {
1298 $dbh->rollback if $oldAutoCommit;
1299 return "Can't delete a customer with invoices";
1301 if ( $self->cust_credit ) {
1302 $dbh->rollback if $oldAutoCommit;
1303 return "Can't delete a customer with credits";
1305 if ( $self->cust_pay ) {
1306 $dbh->rollback if $oldAutoCommit;
1307 return "Can't delete a customer with payments";
1309 if ( $self->cust_refund ) {
1310 $dbh->rollback if $oldAutoCommit;
1311 return "Can't delete a customer with refunds";
1314 my @cust_pkg = $self->ncancelled_pkgs;
1316 my $new_custnum = shift;
1317 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1318 $dbh->rollback if $oldAutoCommit;
1319 return "Invalid new customer number: $new_custnum";
1321 foreach my $cust_pkg ( @cust_pkg ) {
1322 my %hash = $cust_pkg->hash;
1323 $hash{'custnum'} = $new_custnum;
1324 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1325 my $error = $new_cust_pkg->replace($cust_pkg,
1326 options => { $cust_pkg->options },
1329 $dbh->rollback if $oldAutoCommit;
1334 my @cancelled_cust_pkg = $self->all_pkgs;
1335 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1336 my $error = $cust_pkg->delete;
1338 $dbh->rollback if $oldAutoCommit;
1343 foreach my $table (qw( cust_main_invoice cust_main_exemption cust_tag )) {
1344 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1345 my $error = $record->delete;
1347 $dbh->rollback if $oldAutoCommit;
1353 my $error = $self->SUPER::delete;
1355 $dbh->rollback if $oldAutoCommit;
1359 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1364 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1367 Replaces the OLD_RECORD with this one in the database. If there is an error,
1368 returns the error, otherwise returns false.
1370 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1371 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1372 expected and rollback the entire transaction; it is not necessary to call
1373 check_invoicing_list first. Here's an example:
1375 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1377 Currently available options are: I<tax_exemption>.
1379 The I<tax_exemption> option can be set to an arrayref of tax names.
1380 FS::cust_main_exemption records will be deleted and inserted as appropriate.
1387 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1389 : $self->replace_old;
1393 warn "$me replace called\n"
1396 my $curuser = $FS::CurrentUser::CurrentUser;
1397 if ( $self->payby eq 'COMP'
1398 && $self->payby ne $old->payby
1399 && ! $curuser->access_right('Complimentary customer')
1402 return "You are not permitted to create complimentary accounts.";
1405 local($ignore_expired_card) = 1
1406 if $old->payby =~ /^(CARD|DCRD)$/
1407 && $self->payby =~ /^(CARD|DCRD)$/
1408 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1410 local $SIG{HUP} = 'IGNORE';
1411 local $SIG{INT} = 'IGNORE';
1412 local $SIG{QUIT} = 'IGNORE';
1413 local $SIG{TERM} = 'IGNORE';
1414 local $SIG{TSTP} = 'IGNORE';
1415 local $SIG{PIPE} = 'IGNORE';
1417 my $oldAutoCommit = $FS::UID::AutoCommit;
1418 local $FS::UID::AutoCommit = 0;
1421 my $error = $self->SUPER::replace($old);
1424 $dbh->rollback if $oldAutoCommit;
1428 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1429 my $invoicing_list = shift @param;
1430 $error = $self->check_invoicing_list( $invoicing_list );
1432 $dbh->rollback if $oldAutoCommit;
1435 $self->invoicing_list( $invoicing_list );
1438 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1440 #this could be more efficient than deleting and re-inserting, if it matters
1441 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1442 my $error = $cust_tag->delete;
1444 $dbh->rollback if $oldAutoCommit;
1448 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1449 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1450 'custnum' => $self->custnum };
1451 my $error = $cust_tag->insert;
1453 $dbh->rollback if $oldAutoCommit;
1460 my %options = @param;
1462 my $tax_exemption = delete $options{'tax_exemption'};
1463 if ( $tax_exemption ) {
1465 my %cust_main_exemption =
1466 map { $_->taxname => $_ }
1467 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1469 foreach my $taxname ( @$tax_exemption ) {
1471 next if delete $cust_main_exemption{$taxname};
1473 my $cust_main_exemption = new FS::cust_main_exemption {
1474 'custnum' => $self->custnum,
1475 'taxname' => $taxname,
1477 my $error = $cust_main_exemption->insert;
1479 $dbh->rollback if $oldAutoCommit;
1480 return "inserting cust_main_exemption (transaction rolled back): $error";
1484 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1485 my $error = $cust_main_exemption->delete;
1487 $dbh->rollback if $oldAutoCommit;
1488 return "deleting cust_main_exemption (transaction rolled back): $error";
1494 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1495 grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1496 # card/check/lec info has changed, want to retry realtime_ invoice events
1497 my $error = $self->retry_realtime;
1499 $dbh->rollback if $oldAutoCommit;
1504 unless ( $import || $skip_fuzzyfiles ) {
1505 $error = $self->queue_fuzzyfiles_update;
1507 $dbh->rollback if $oldAutoCommit;
1508 return "updating fuzzy search cache: $error";
1512 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1517 =item queue_fuzzyfiles_update
1519 Used by insert & replace to update the fuzzy search cache
1523 sub queue_fuzzyfiles_update {
1526 local $SIG{HUP} = 'IGNORE';
1527 local $SIG{INT} = 'IGNORE';
1528 local $SIG{QUIT} = 'IGNORE';
1529 local $SIG{TERM} = 'IGNORE';
1530 local $SIG{TSTP} = 'IGNORE';
1531 local $SIG{PIPE} = 'IGNORE';
1533 my $oldAutoCommit = $FS::UID::AutoCommit;
1534 local $FS::UID::AutoCommit = 0;
1537 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1538 my $error = $queue->insert( map $self->getfield($_), @fuzzyfields );
1540 $dbh->rollback if $oldAutoCommit;
1541 return "queueing job (transaction rolled back): $error";
1544 if ( $self->ship_last ) {
1545 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1546 $error = $queue->insert( map $self->getfield("ship_$_"), @fuzzyfields );
1548 $dbh->rollback if $oldAutoCommit;
1549 return "queueing job (transaction rolled back): $error";
1553 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1560 Checks all fields to make sure this is a valid customer record. If there is
1561 an error, returns the error, otherwise returns false. Called by the insert
1562 and replace methods.
1569 warn "$me check BEFORE: \n". $self->_dump
1573 $self->ut_numbern('custnum')
1574 || $self->ut_number('agentnum')
1575 || $self->ut_textn('agent_custid')
1576 || $self->ut_number('refnum')
1577 || $self->ut_textn('custbatch')
1578 || $self->ut_name('last')
1579 || $self->ut_name('first')
1580 || $self->ut_snumbern('birthdate')
1581 || $self->ut_snumbern('signupdate')
1582 || $self->ut_textn('company')
1583 || $self->ut_text('address1')
1584 || $self->ut_textn('address2')
1585 || $self->ut_text('city')
1586 || $self->ut_textn('county')
1587 || $self->ut_textn('state')
1588 || $self->ut_country('country')
1589 || $self->ut_anything('comments')
1590 || $self->ut_numbern('referral_custnum')
1591 || $self->ut_textn('stateid')
1592 || $self->ut_textn('stateid_state')
1593 || $self->ut_textn('invoice_terms')
1594 || $self->ut_alphan('geocode')
1595 || $self->ut_floatn('cdr_termination_percentage')
1598 #barf. need message catalogs. i18n. etc.
1599 $error .= "Please select an advertising source."
1600 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1601 return $error if $error;
1603 return "Unknown agent"
1604 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1606 return "Unknown refnum"
1607 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1609 return "Unknown referring custnum: ". $self->referral_custnum
1610 unless ! $self->referral_custnum
1611 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1613 if ( $self->censustract ne '' ) {
1614 $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
1615 or return "Illegal census tract: ". $self->censustract;
1617 $self->censustract("$1.$2");
1620 if ( $self->ss eq '' ) {
1625 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1626 or return "Illegal social security number: ". $self->ss;
1627 $self->ss("$1-$2-$3");
1631 # bad idea to disable, causes billing to fail because of no tax rates later
1632 # unless ( $import ) {
1633 unless ( qsearch('cust_main_county', {
1634 'country' => $self->country,
1637 return "Unknown state/county/country: ".
1638 $self->state. "/". $self->county. "/". $self->country
1639 unless qsearch('cust_main_county',{
1640 'state' => $self->state,
1641 'county' => $self->county,
1642 'country' => $self->country,
1648 $self->ut_phonen('daytime', $self->country)
1649 || $self->ut_phonen('night', $self->country)
1650 || $self->ut_phonen('fax', $self->country)
1651 || $self->ut_zip('zip', $self->country)
1653 return $error if $error;
1655 if ( $conf->exists('cust_main-require_phone')
1656 && ! length($self->daytime) && ! length($self->night)
1659 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1661 : FS::Msgcat::_gettext('daytime');
1662 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1664 : FS::Msgcat::_gettext('night');
1666 return "$daytime_label or $night_label is required"
1670 if ( $self->has_ship_address
1671 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1672 $self->addr_fields )
1676 $self->ut_name('ship_last')
1677 || $self->ut_name('ship_first')
1678 || $self->ut_textn('ship_company')
1679 || $self->ut_text('ship_address1')
1680 || $self->ut_textn('ship_address2')
1681 || $self->ut_text('ship_city')
1682 || $self->ut_textn('ship_county')
1683 || $self->ut_textn('ship_state')
1684 || $self->ut_country('ship_country')
1686 return $error if $error;
1688 #false laziness with above
1689 unless ( qsearchs('cust_main_county', {
1690 'country' => $self->ship_country,
1693 return "Unknown ship_state/ship_county/ship_country: ".
1694 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1695 unless qsearch('cust_main_county',{
1696 'state' => $self->ship_state,
1697 'county' => $self->ship_county,
1698 'country' => $self->ship_country,
1704 $self->ut_phonen('ship_daytime', $self->ship_country)
1705 || $self->ut_phonen('ship_night', $self->ship_country)
1706 || $self->ut_phonen('ship_fax', $self->ship_country)
1707 || $self->ut_zip('ship_zip', $self->ship_country)
1709 return $error if $error;
1711 return "Unit # is required."
1712 if $self->ship_address2 =~ /^\s*$/
1713 && $conf->exists('cust_main-require_address2');
1715 } else { # ship_ info eq billing info, so don't store dup info in database
1717 $self->setfield("ship_$_", '')
1718 foreach $self->addr_fields;
1720 return "Unit # is required."
1721 if $self->address2 =~ /^\s*$/
1722 && $conf->exists('cust_main-require_address2');
1726 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1727 # or return "Illegal payby: ". $self->payby;
1729 FS::payby->can_payby($self->table, $self->payby)
1730 or return "Illegal payby: ". $self->payby;
1732 $error = $self->ut_numbern('paystart_month')
1733 || $self->ut_numbern('paystart_year')
1734 || $self->ut_numbern('payissue')
1735 || $self->ut_textn('paytype')
1737 return $error if $error;
1739 if ( $self->payip eq '' ) {
1742 $error = $self->ut_ip('payip');
1743 return $error if $error;
1746 # If it is encrypted and the private key is not availaible then we can't
1747 # check the credit card.
1749 my $check_payinfo = 1;
1751 if ($self->is_encrypted($self->payinfo)) {
1755 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1757 my $payinfo = $self->payinfo;
1758 $payinfo =~ s/\D//g;
1759 $payinfo =~ /^(\d{13,16})$/
1760 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1762 $self->payinfo($payinfo);
1764 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1766 return gettext('unknown_card_type')
1767 if cardtype($self->payinfo) eq "Unknown";
1769 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1771 return 'Banned credit card: banned on '.
1772 time2str('%a %h %o at %r', $ban->_date).
1773 ' by '. $ban->otaker.
1774 ' (ban# '. $ban->bannum. ')';
1777 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1778 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1779 $self->paycvv =~ /^(\d{4})$/
1780 or return "CVV2 (CID) for American Express cards is four digits.";
1783 $self->paycvv =~ /^(\d{3})$/
1784 or return "CVV2 (CVC2/CID) is three digits.";
1791 my $cardtype = cardtype($payinfo);
1792 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1794 return "Start date or issue number is required for $cardtype cards"
1795 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1797 return "Start month must be between 1 and 12"
1798 if $self->paystart_month
1799 and $self->paystart_month < 1 || $self->paystart_month > 12;
1801 return "Start year must be 1990 or later"
1802 if $self->paystart_year
1803 and $self->paystart_year < 1990;
1805 return "Issue number must be beween 1 and 99"
1807 and $self->payissue < 1 || $self->payissue > 99;
1810 $self->paystart_month('');
1811 $self->paystart_year('');
1812 $self->payissue('');
1815 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1817 my $payinfo = $self->payinfo;
1818 $payinfo =~ s/[^\d\@]//g;
1819 if ( $conf->exists('echeck-nonus') ) {
1820 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1821 $payinfo = "$1\@$2";
1823 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1824 $payinfo = "$1\@$2";
1826 $self->payinfo($payinfo);
1829 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1831 return 'Banned ACH account: banned on '.
1832 time2str('%a %h %o at %r', $ban->_date).
1833 ' by '. $ban->otaker.
1834 ' (ban# '. $ban->bannum. ')';
1837 } elsif ( $self->payby eq 'LECB' ) {
1839 my $payinfo = $self->payinfo;
1840 $payinfo =~ s/\D//g;
1841 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1843 $self->payinfo($payinfo);
1846 } elsif ( $self->payby eq 'BILL' ) {
1848 $error = $self->ut_textn('payinfo');
1849 return "Illegal P.O. number: ". $self->payinfo if $error;
1852 } elsif ( $self->payby eq 'COMP' ) {
1854 my $curuser = $FS::CurrentUser::CurrentUser;
1855 if ( ! $self->custnum
1856 && ! $curuser->access_right('Complimentary customer')
1859 return "You are not permitted to create complimentary accounts."
1862 $error = $self->ut_textn('payinfo');
1863 return "Illegal comp account issuer: ". $self->payinfo if $error;
1866 } elsif ( $self->payby eq 'PREPAY' ) {
1868 my $payinfo = $self->payinfo;
1869 $payinfo =~ s/\W//g; #anything else would just confuse things
1870 $self->payinfo($payinfo);
1871 $error = $self->ut_alpha('payinfo');
1872 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1873 return "Unknown prepayment identifier"
1874 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1879 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1880 return "Expiration date required"
1881 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1885 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1886 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1887 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1888 ( $m, $y ) = ( $2, "19$1" );
1889 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1890 ( $m, $y ) = ( $3, "20$2" );
1892 return "Illegal expiration date: ". $self->paydate;
1894 $self->paydate("$y-$m-01");
1895 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1896 return gettext('expired_card')
1898 && !$ignore_expired_card
1899 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1902 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1903 ( ! $conf->exists('require_cardname')
1904 || $self->payby !~ /^(CARD|DCRD)$/ )
1906 $self->payname( $self->first. " ". $self->getfield('last') );
1908 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1909 or return gettext('illegal_name'). " payname: ". $self->payname;
1913 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
1914 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1918 $self->otaker(getotaker) unless $self->otaker;
1920 warn "$me check AFTER: \n". $self->_dump
1923 $self->SUPER::check;
1928 Returns a list of fields which have ship_ duplicates.
1933 qw( last first company
1934 address1 address2 city county state zip country
1939 =item has_ship_address
1941 Returns true if this customer record has a separate shipping address.
1945 sub has_ship_address {
1947 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
1952 Returns a list of key/value pairs, with the following keys: address1, adddress2,
1953 city, county, state, zip, country. The shipping address is used if present.
1957 #geocode? dependent on tax-ship_address config, not available in cust_location
1958 #mostly. not yet then.
1962 my $prefix = $self->has_ship_address ? 'ship_' : '';
1964 map { $_ => $self->get($prefix.$_) }
1965 qw( address1 address2 city county state zip country geocode );
1966 #fields that cust_location has
1969 =item all_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
1971 Returns all packages (see L<FS::cust_pkg>) for this customer.
1977 my $extra_qsearch = ref($_[0]) ? shift : {};
1979 return $self->num_pkgs unless wantarray || keys(%$extra_qsearch);
1982 if ( $self->{'_pkgnum'} ) {
1983 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1985 @cust_pkg = $self->_cust_pkg($extra_qsearch);
1988 sort sort_packages @cust_pkg;
1993 Synonym for B<all_pkgs>.
1998 shift->all_pkgs(@_);
2003 Returns all locations (see L<FS::cust_location>) for this customer.
2009 qsearch('cust_location', { 'custnum' => $self->custnum } );
2012 =item location_label [ OPTION => VALUE ... ]
2014 Returns the label of the service location (see analog in L<FS::cust_location>) for this customer.
2022 used to separate the address elements (defaults to ', ')
2024 =item escape_function
2026 a callback used for escaping the text of the address elements
2032 # false laziness with FS::cust_location::line
2034 sub location_label {
2038 my $separator = $opt{join_string} || ', ';
2039 my $escape = $opt{escape_function} || sub{ shift };
2041 my $cydefault = FS::conf->new->config('countrydefault') || 'US';
2042 my $prefix = length($self->ship_last) ? 'ship_' : '';
2045 foreach (qw ( address1 address2 ) ) {
2046 my $method = "$prefix$_";
2047 $line .= ($notfirst ? $separator : ''). &$escape($self->$method)
2052 foreach (qw ( city county state zip ) ) {
2053 my $method = "$prefix$_";
2054 if ( $self->$method ) {
2055 $line .= ' (' if $method eq 'county';
2056 $line .= ($notfirst ? ' ' : $separator). &$escape($self->$method);
2057 $line .= ' )' if $method eq 'county';
2061 $line .= $separator. &$escape(code2country($self->country))
2062 if $self->country ne $cydefault;
2067 =item ncancelled_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
2069 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
2073 sub ncancelled_pkgs {
2075 my $extra_qsearch = ref($_[0]) ? shift : {};
2077 return $self->num_ncancelled_pkgs unless wantarray;
2080 if ( $self->{'_pkgnum'} ) {
2082 warn "$me ncancelled_pkgs: returning cached objects"
2085 @cust_pkg = grep { ! $_->getfield('cancel') }
2086 values %{ $self->{'_pkgnum'}->cache };
2090 warn "$me ncancelled_pkgs: searching for packages with custnum ".
2091 $self->custnum. "\n"
2094 $extra_qsearch->{'extra_sql'} .= ' AND ( cancel IS NULL OR cancel = 0 ) ';
2096 @cust_pkg = $self->_cust_pkg($extra_qsearch);
2100 sort sort_packages @cust_pkg;
2106 my $extra_qsearch = ref($_[0]) ? shift : {};
2108 $extra_qsearch->{'select'} ||= '*';
2109 $extra_qsearch->{'select'} .=
2110 ',( SELECT COUNT(*) FROM cust_svc WHERE cust_pkg.pkgnum = cust_svc.pkgnum )
2114 $_->{'_num_cust_svc'} = $_->get('_num_cust_svc');
2119 'table' => 'cust_pkg',
2120 'hashref' => { 'custnum' => $self->custnum },
2125 # This should be generalized to use config options to determine order.
2128 my $locationsort = ( $a->locationnum || 0 ) <=> ( $b->locationnum || 0 );
2129 return $locationsort if $locationsort;
2131 if ( $a->get('cancel') xor $b->get('cancel') ) {
2132 return -1 if $b->get('cancel');
2133 return 1 if $a->get('cancel');
2134 #shouldn't get here...
2137 my $a_num_cust_svc = $a->num_cust_svc;
2138 my $b_num_cust_svc = $b->num_cust_svc;
2139 return 0 if !$a_num_cust_svc && !$b_num_cust_svc;
2140 return -1 if $a_num_cust_svc && !$b_num_cust_svc;
2141 return 1 if !$a_num_cust_svc && $b_num_cust_svc;
2142 my @a_cust_svc = $a->cust_svc;
2143 my @b_cust_svc = $b->cust_svc;
2144 return 0 if !scalar(@a_cust_svc) && !scalar(@b_cust_svc);
2145 return -1 if scalar(@a_cust_svc) && !scalar(@b_cust_svc);
2146 return 1 if !scalar(@a_cust_svc) && scalar(@b_cust_svc);
2147 $a_cust_svc[0]->svc_x->label cmp $b_cust_svc[0]->svc_x->label;
2152 =item suspended_pkgs
2154 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
2158 sub suspended_pkgs {
2160 grep { $_->susp } $self->ncancelled_pkgs;
2163 =item unflagged_suspended_pkgs
2165 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
2166 customer (thouse packages without the `manual_flag' set).
2170 sub unflagged_suspended_pkgs {
2172 return $self->suspended_pkgs
2173 unless dbdef->table('cust_pkg')->column('manual_flag');
2174 grep { ! $_->manual_flag } $self->suspended_pkgs;
2177 =item unsuspended_pkgs
2179 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
2184 sub unsuspended_pkgs {
2186 grep { ! $_->susp } $self->ncancelled_pkgs;
2189 =item next_bill_date
2191 Returns the next date this customer will be billed, as a UNIX timestamp, or
2192 undef if no active package has a next bill date.
2196 sub next_bill_date {
2198 min( map $_->get('bill'), grep $_->get('bill'), $self->unsuspended_pkgs );
2201 =item num_cancelled_pkgs
2203 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
2208 sub num_cancelled_pkgs {
2209 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
2212 sub num_ncancelled_pkgs {
2213 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
2217 my( $self ) = shift;
2218 my $sql = scalar(@_) ? shift : '';
2219 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
2220 my $sth = dbh->prepare(
2221 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
2222 ) or die dbh->errstr;
2223 $sth->execute($self->custnum) or die $sth->errstr;
2224 $sth->fetchrow_arrayref->[0];
2229 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2230 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2231 on success or a list of errors.
2237 grep { $_->unsuspend } $self->suspended_pkgs;
2242 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2244 Returns a list: an empty list on success or a list of errors.
2250 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2253 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2255 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2256 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2257 of a list of pkgparts; the hashref has the following keys:
2261 =item pkgparts - listref of pkgparts
2263 =item (other options are passed to the suspend method)
2268 Returns a list: an empty list on success or a list of errors.
2272 sub suspend_if_pkgpart {
2274 my (@pkgparts, %opt);
2275 if (ref($_[0]) eq 'HASH'){
2276 @pkgparts = @{$_[0]{pkgparts}};
2281 grep { $_->suspend(%opt) }
2282 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2283 $self->unsuspended_pkgs;
2286 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2288 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2289 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2290 instead of a list of pkgparts; the hashref has the following keys:
2294 =item pkgparts - listref of pkgparts
2296 =item (other options are passed to the suspend method)
2300 Returns a list: an empty list on success or a list of errors.
2304 sub suspend_unless_pkgpart {
2306 my (@pkgparts, %opt);
2307 if (ref($_[0]) eq 'HASH'){
2308 @pkgparts = @{$_[0]{pkgparts}};
2313 grep { $_->suspend(%opt) }
2314 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2315 $self->unsuspended_pkgs;
2318 =item cancel [ OPTION => VALUE ... ]
2320 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2322 Available options are:
2326 =item quiet - can be set true to supress email cancellation notices.
2328 =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.
2330 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2332 =item nobill - can be set true to skip billing if it might otherwise be done.
2336 Always returns a list: an empty list on success or a list of errors.
2340 # nb that dates are not specified as valid options to this method
2343 my( $self, %opt ) = @_;
2345 warn "$me cancel called on customer ". $self->custnum. " with options ".
2346 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2349 return ( 'access denied' )
2350 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2352 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2354 #should try decryption (we might have the private key)
2355 # and if not maybe queue a job for the server that does?
2356 return ( "Can't (yet) ban encrypted credit cards" )
2357 if $self->is_encrypted($self->payinfo);
2359 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
2360 my $error = $ban->insert;
2361 return ( $error ) if $error;
2365 my @pkgs = $self->ncancelled_pkgs;
2367 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2369 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2370 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2374 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2375 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2378 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2381 sub _banned_pay_hashref {
2392 'payby' => $payby2ban{$self->payby},
2393 'payinfo' => md5_base64($self->payinfo),
2394 #don't ever *search* on reason! #'reason' =>
2400 Returns all notes (see L<FS::cust_main_note>) for this customer.
2407 qsearch( 'cust_main_note',
2408 { 'custnum' => $self->custnum },
2410 'ORDER BY _DATE DESC'
2416 Returns the agent (see L<FS::agent>) for this customer.
2422 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2427 Returns the agent name (see L<FS::agent>) for this customer.
2433 $self->agent->agent;
2438 Returns any tags associated with this customer, as FS::cust_tag objects,
2439 or an empty list if there are no tags.
2445 qsearch('cust_tag', { 'custnum' => $self->custnum } );
2450 Returns any tags associated with this customer, as FS::part_tag objects,
2451 or an empty list if there are no tags.
2457 map $_->part_tag, $self->cust_tag;
2460 =item bill_and_collect
2462 Cancels and suspends any packages due, generates bills, applies payments and
2463 credits, and applies collection events to run cards, send bills and notices,
2466 By default, warns on errors and continues with the next operation (but see the
2467 "fatal" flag below).
2469 Options are passed as name-value pairs. Currently available options are:
2475 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:
2479 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2483 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.
2487 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2491 If set true, re-charges setup fees.
2495 If set any errors prevent subsequent operations from continusing. If set
2496 specifically to "return", returns the error (or false, if there is no error).
2497 Any other true value causes errors to die.
2501 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)
2505 Options are passed to the B<bill> and B<collect> methods verbatim, so all
2506 options of those methods are also available.
2510 sub bill_and_collect {
2511 my( $self, %options ) = @_;
2515 #$options{actual_time} not $options{time} because freeside-daily -d is for
2516 #pre-printing invoices
2518 $options{'actual_time'} ||= time;
2520 $error = $self->cancel_expired_pkgs( $options{actual_time} );
2522 $error = "Error expiring custnum ". $self->custnum. ": $error";
2523 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2524 elsif ( $options{fatal} ) { die $error; }
2525 else { warn $error; }
2528 $error = $self->suspend_adjourned_pkgs( $options{actual_time} );
2530 $error = "Error adjourning custnum ". $self->custnum. ": $error";
2531 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2532 elsif ( $options{fatal} ) { die $error; }
2533 else { warn $error; }
2536 $error = $self->bill( %options );
2538 $error = "Error billing custnum ". $self->custnum. ": $error";
2539 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2540 elsif ( $options{fatal} ) { die $error; }
2541 else { warn $error; }
2544 $error = $self->apply_payments_and_credits;
2546 $error = "Error applying custnum ". $self->custnum. ": $error";
2547 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2548 elsif ( $options{fatal} ) { die $error; }
2549 else { warn $error; }
2552 unless ( $conf->exists('cancelled_cust-noevents')
2553 && ! $self->num_ncancelled_pkgs
2555 $error = $self->collect( %options );
2557 $error = "Error collecting custnum ". $self->custnum. ": $error";
2558 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
2559 elsif ($options{fatal} ) { die $error; }
2560 else { warn $error; }
2568 sub cancel_expired_pkgs {
2569 my ( $self, $time, %options ) = @_;
2571 my @cancel_pkgs = $self->ncancelled_pkgs( {
2572 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
2577 foreach my $cust_pkg ( @cancel_pkgs ) {
2578 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
2579 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
2580 'reason_otaker' => $cpr->otaker
2584 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
2587 scalar(@errors) ? join(' / ', @errors) : '';
2591 sub suspend_adjourned_pkgs {
2592 my ( $self, $time, %options ) = @_;
2594 my @susp_pkgs = $self->ncancelled_pkgs( {
2596 " AND ( susp IS NULL OR susp = 0 )
2597 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
2598 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
2603 #only because there's no SQL test for is_prepaid :/
2605 grep { ( $_->part_pkg->is_prepaid
2610 && $_->adjourn <= $time
2618 foreach my $cust_pkg ( @susp_pkgs ) {
2619 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
2620 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
2621 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
2622 'reason_otaker' => $cpr->otaker
2626 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
2629 scalar(@errors) ? join(' / ', @errors) : '';
2635 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
2636 conjunction with the collect method by calling B<bill_and_collect>.
2638 If there is an error, returns the error, otherwise returns false.
2640 Options are passed as name-value pairs. Currently available options are:
2646 If set true, re-charges setup fees.
2650 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:
2654 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2658 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2660 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2664 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
2668 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.
2672 This boolean value informs the us that the package is being cancelled. This
2673 typically might mean not charging the normal recurring fee but only usage
2674 fees since the last billing. Setup charges may be charged. Not all package
2675 plans support this feature (they tend to charge 0).
2679 Optional terms to be printed on this invoice. Otherwise, customer-specific
2680 terms or the default terms are used.
2687 my( $self, %options ) = @_;
2688 return '' if $self->payby eq 'COMP';
2689 warn "$me bill customer ". $self->custnum. "\n"
2692 my $time = $options{'time'} || time;
2693 my $invoice_time = $options{'invoice_time'} || $time;
2695 $options{'not_pkgpart'} ||= {};
2696 $options{'not_pkgpart'} = { map { $_ => 1 }
2697 split(/\s*,\s*/, $options{'not_pkgpart'})
2699 unless ref($options{'not_pkgpart'});
2701 local $SIG{HUP} = 'IGNORE';
2702 local $SIG{INT} = 'IGNORE';
2703 local $SIG{QUIT} = 'IGNORE';
2704 local $SIG{TERM} = 'IGNORE';
2705 local $SIG{TSTP} = 'IGNORE';
2706 local $SIG{PIPE} = 'IGNORE';
2708 my $oldAutoCommit = $FS::UID::AutoCommit;
2709 local $FS::UID::AutoCommit = 0;
2712 $self->select_for_update; #mutex
2714 my $error = $self->do_cust_event(
2715 'debug' => ( $options{'debug'} || 0 ),
2716 'time' => $invoice_time,
2717 'check_freq' => $options{'check_freq'},
2718 'stage' => 'pre-bill',
2721 $dbh->rollback if $oldAutoCommit;
2725 my @cust_bill_pkg = ();
2728 # find the packages which are due for billing, find out how much they are
2729 # & generate invoice database.
2732 my( $total_setup, $total_recur, $postal_charge ) = ( 0, 0, 0 );
2734 my @precommit_hooks = ();
2736 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
2737 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
2739 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
2741 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2743 #? to avoid use of uninitialized value errors... ?
2744 $cust_pkg->setfield('bill', '')
2745 unless defined($cust_pkg->bill);
2747 #my $part_pkg = $cust_pkg->part_pkg;
2749 my $real_pkgpart = $cust_pkg->pkgpart;
2750 my %hash = $cust_pkg->hash;
2752 # we could implement this bit as FS::part_pkg::has_hidden, but we already
2753 # suffer from performance issues
2754 $options{has_hidden} = 0;
2755 my @part_pkg = $cust_pkg->part_pkg->self_and_bill_linked;
2756 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
2758 foreach my $part_pkg ( @part_pkg ) {
2760 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
2763 $self->_make_lines( 'part_pkg' => $part_pkg,
2764 'cust_pkg' => $cust_pkg,
2765 'precommit_hooks' => \@precommit_hooks,
2766 'line_items' => \@cust_bill_pkg,
2767 'setup' => \$total_setup,
2768 'recur' => \$total_recur,
2769 'tax_matrix' => \%taxlisthash,
2771 'real_pkgpart' => $real_pkgpart,
2772 'options' => \%options,
2775 $dbh->rollback if $oldAutoCommit;
2779 } #foreach my $part_pkg
2781 } #foreach my $cust_pkg
2783 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
2785 unless ( @cust_bill_pkg ) { #don't create an invoice w/o line items
2786 #but do commit any package date cycling that happened
2787 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2791 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
2792 !$conf->exists('postal_invoice-recurring_only')
2796 my $postal_pkg = $self->charge_postal_fee();
2797 if ( $postal_pkg && !ref( $postal_pkg ) ) {
2799 $dbh->rollback if $oldAutoCommit;
2800 return "can't charge postal invoice fee for customer ".
2801 $self->custnum. ": $postal_pkg";
2803 } elsif ( $postal_pkg ) {
2805 my $real_pkgpart = $postal_pkg->pkgpart;
2806 # we could implement this bit as FS::part_pkg::has_hidden, but we already
2807 # suffer from performance issues
2808 $options{has_hidden} = 0;
2809 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
2810 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
2812 foreach my $part_pkg ( @part_pkg ) {
2813 my %postal_options = %options;
2814 delete $postal_options{cancel};
2816 $self->_make_lines( 'part_pkg' => $part_pkg,
2817 'cust_pkg' => $postal_pkg,
2818 'precommit_hooks' => \@precommit_hooks,
2819 'line_items' => \@cust_bill_pkg,
2820 'setup' => \$total_setup,
2821 'recur' => \$total_recur,
2822 'tax_matrix' => \%taxlisthash,
2824 'real_pkgpart' => $real_pkgpart,
2825 'options' => \%postal_options,
2828 $dbh->rollback if $oldAutoCommit;
2833 # it's silly to have a zero value postal_pkg, but....
2834 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
2840 warn "having a look at the taxes we found...\n" if $DEBUG > 2;
2842 # keys are tax names (as printed on invoices / itemdesc )
2843 # values are listrefs of taxlisthash keys (internal identifiers)
2846 # keys are taxlisthash keys (internal identifiers)
2847 # values are (cumulative) amounts
2850 # keys are taxlisthash keys (internal identifiers)
2851 # values are listrefs of cust_bill_pkg_tax_location hashrefs
2852 my %tax_location = ();
2854 # keys are taxlisthash keys (internal identifiers)
2855 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
2856 my %tax_rate_location = ();
2858 foreach my $tax ( keys %taxlisthash ) {
2859 my $tax_object = shift @{ $taxlisthash{$tax} };
2860 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
2861 warn " ". join('/', @{ $taxlisthash{$tax} } ). "\n" if $DEBUG > 2;
2862 my $hashref_or_error =
2863 $tax_object->taxline( $taxlisthash{$tax},
2864 'custnum' => $self->custnum,
2865 'invoice_time' => $invoice_time
2867 unless ( ref($hashref_or_error) ) {
2868 $dbh->rollback if $oldAutoCommit;
2869 return $hashref_or_error;
2871 unshift @{ $taxlisthash{$tax} }, $tax_object;
2873 my $name = $hashref_or_error->{'name'};
2874 my $amount = $hashref_or_error->{'amount'};
2876 #warn "adding $amount as $name\n";
2877 $taxname{ $name } ||= [];
2878 push @{ $taxname{ $name } }, $tax;
2880 $tax{ $tax } += $amount;
2882 $tax_location{ $tax } ||= [];
2883 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
2884 push @{ $tax_location{ $tax } },
2886 'taxnum' => $tax_object->taxnum,
2887 'taxtype' => ref($tax_object),
2888 'pkgnum' => $tax_object->get('pkgnum'),
2889 'locationnum' => $tax_object->get('locationnum'),
2890 'amount' => sprintf('%.2f', $amount ),
2894 $tax_rate_location{ $tax } ||= [];
2895 if ( ref($tax_object) eq 'FS::tax_rate' ) {
2896 my $taxratelocationnum =
2897 $tax_object->tax_rate_location->taxratelocationnum;
2898 push @{ $tax_rate_location{ $tax } },
2900 'taxnum' => $tax_object->taxnum,
2901 'taxtype' => ref($tax_object),
2902 'amount' => sprintf('%.2f', $amount ),
2903 'locationtaxid' => $tax_object->location,
2904 'taxratelocationnum' => $taxratelocationnum,
2910 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
2911 my %packagemap = map { $_->pkgnum => $_ } @cust_bill_pkg;
2912 foreach my $tax ( keys %taxlisthash ) {
2913 foreach ( @{ $taxlisthash{$tax} }[1 ... scalar(@{ $taxlisthash{$tax} })] ) {
2914 next unless ref($_) eq 'FS::cust_bill_pkg';
2916 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
2917 splice( @{ $_->_cust_tax_exempt_pkg } );
2921 #consolidate and create tax line items
2922 warn "consolidating and generating...\n" if $DEBUG > 2;
2923 foreach my $taxname ( keys %taxname ) {
2926 my @cust_bill_pkg_tax_location = ();
2927 my @cust_bill_pkg_tax_rate_location = ();
2928 warn "adding $taxname\n" if $DEBUG > 1;
2929 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
2930 next if $seen{$taxitem}++;
2931 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
2932 $tax += $tax{$taxitem};
2933 push @cust_bill_pkg_tax_location,
2934 map { new FS::cust_bill_pkg_tax_location $_ }
2935 @{ $tax_location{ $taxitem } };
2936 push @cust_bill_pkg_tax_rate_location,
2937 map { new FS::cust_bill_pkg_tax_rate_location $_ }
2938 @{ $tax_rate_location{ $taxitem } };
2942 $tax = sprintf('%.2f', $tax );
2943 $total_setup = sprintf('%.2f', $total_setup+$tax );
2945 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
2951 if ( $pkg_category and
2952 $conf->config('invoice_latexsummary') ||
2953 $conf->config('invoice_htmlsummary')
2957 my %hash = ( 'section' => $pkg_category->categoryname );
2958 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
2962 push @cust_bill_pkg, new FS::cust_bill_pkg {
2968 'itemdesc' => $taxname,
2969 'display' => \@display,
2970 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2971 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
2976 #add tax adjustments
2977 warn "adding tax adjustments...\n" if $DEBUG > 2;
2978 foreach my $cust_tax_adjustment (
2979 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
2985 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
2986 $total_setup = sprintf('%.2f', $total_setup+$tax );
2988 my $itemdesc = $cust_tax_adjustment->taxname;
2989 $itemdesc = '' if $itemdesc eq 'Tax';
2991 push @cust_bill_pkg, new FS::cust_bill_pkg {
2997 'itemdesc' => $itemdesc,
2998 'itemcomment' => $cust_tax_adjustment->comment,
2999 'cust_tax_adjustment' => $cust_tax_adjustment,
3000 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
3005 my $charged = sprintf('%.2f', $total_setup + $total_recur );
3007 my @cust_bill = $self->cust_bill;
3008 my $balance = $self->balance;
3009 my $previous_balance = scalar(@cust_bill)
3010 ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
3013 $previous_balance += $cust_bill[$#cust_bill]->charged
3014 if scalar(@cust_bill);
3015 #my $balance_adjustments =
3016 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
3018 #create the new invoice
3019 my $cust_bill = new FS::cust_bill ( {
3020 'custnum' => $self->custnum,
3021 '_date' => ( $invoice_time ),
3022 'charged' => $charged,
3023 'billing_balance' => $balance,
3024 'previous_balance' => $previous_balance,
3025 'invoice_terms' => $options{'invoice_terms'},
3027 $error = $cust_bill->insert;
3029 $dbh->rollback if $oldAutoCommit;
3030 return "can't create invoice for customer #". $self->custnum. ": $error";
3033 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
3034 $cust_bill_pkg->invnum($cust_bill->invnum);
3035 my $error = $cust_bill_pkg->insert;
3037 $dbh->rollback if $oldAutoCommit;
3038 return "can't create invoice line item: $error";
3043 foreach my $hook ( @precommit_hooks ) {
3045 &{$hook}; #($self) ?
3048 $dbh->rollback if $oldAutoCommit;
3049 return "$@ running precommit hook $hook\n";
3053 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3057 #discard bundled packages of 0 value
3058 sub _omit_zero_value_bundles {
3060 my @cust_bill_pkg = ();
3061 my @cust_bill_pkg_bundle = ();
3064 foreach my $cust_bill_pkg ( @_ ) {
3065 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
3066 push @cust_bill_pkg, @cust_bill_pkg_bundle if $sum > 0;
3067 @cust_bill_pkg_bundle = ();
3070 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
3071 push @cust_bill_pkg_bundle, $cust_bill_pkg;
3073 push @cust_bill_pkg, @cust_bill_pkg_bundle if $sum > 0;
3080 my ($self, %params) = @_;
3082 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
3083 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
3084 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
3085 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
3086 my $total_setup = $params{setup} or die "no setup accumulator specified";
3087 my $total_recur = $params{recur} or die "no recur accumulator specified";
3088 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
3089 my $time = $params{'time'} or die "no time specified";
3090 my (%options) = %{$params{options}};
3093 my $real_pkgpart = $params{real_pkgpart};
3094 my %hash = $cust_pkg->hash;
3095 my $old_cust_pkg = new FS::cust_pkg \%hash;
3101 $cust_pkg->pkgpart($part_pkg->pkgpart);
3109 if ( $options{'resetup'}
3110 || ( ! $cust_pkg->setup
3111 && ( ! $cust_pkg->start_date
3112 || $cust_pkg->start_date <= $time
3114 && ( ! $conf->exists('disable_setup_suspended_pkgs')
3115 || ( $conf->exists('disable_setup_suspended_pkgs') &&
3116 ! $cust_pkg->getfield('susp')
3123 warn " bill setup\n" if $DEBUG > 1;
3126 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
3127 return "$@ running calc_setup for $cust_pkg\n"
3130 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
3132 $cust_pkg->setfield('setup', $time)
3133 unless $cust_pkg->setup;
3134 #do need it, but it won't get written to the db
3135 #|| $cust_pkg->pkgpart != $real_pkgpart;
3137 $cust_pkg->setfield('start_date', '')
3138 if $cust_pkg->start_date;
3143 # bill recurring fee
3146 #XXX unit stuff here too
3150 if ( ! $cust_pkg->get('susp')
3151 and ! $cust_pkg->get('start_date')
3152 and ( $part_pkg->getfield('freq') ne '0'
3153 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
3155 || ( $part_pkg->plan eq 'voip_cdr'
3156 && $part_pkg->option('bill_every_call')
3158 || ( $options{cancel} )
3161 # XXX should this be a package event? probably. events are called
3162 # at collection time at the moment, though...
3163 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
3164 if $part_pkg->can('reset_usage');
3165 #don't want to reset usage just cause we want a line item??
3166 #&& $part_pkg->pkgpart == $real_pkgpart;
3168 warn " bill recur\n" if $DEBUG > 1;
3171 # XXX shared with $recur_prog
3172 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
3176 #over two params! lets at least switch to a hashref for the rest...
3177 my $increment_next_bill = ( $part_pkg->freq ne '0'
3178 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
3179 && !$options{cancel}
3181 my %param = ( 'precommit_hooks' => $precommit_hooks,
3182 'increment_next_bill' => $increment_next_bill,
3185 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
3186 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
3187 return "$@ running $method for $cust_pkg\n"
3190 if ( $increment_next_bill ) {
3192 my $next_bill = $part_pkg->add_freq($sdate);
3193 return "unparsable frequency: ". $part_pkg->freq
3194 if $next_bill == -1;
3196 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
3197 # only for figuring next bill date, nothing else, so, reset $sdate again
3199 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
3200 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
3201 $cust_pkg->last_bill($sdate);
3203 $cust_pkg->setfield('bill', $next_bill );
3209 warn "\$setup is undefined" unless defined($setup);
3210 warn "\$recur is undefined" unless defined($recur);
3211 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
3214 # If there's line items, create em cust_bill_pkg records
3215 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
3220 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
3221 # hmm.. and if just the options are modified in some weird price plan?
3223 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
3226 my $error = $cust_pkg->replace( $old_cust_pkg,
3227 'options' => { $cust_pkg->options },
3229 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
3230 if $error; #just in case
3233 $setup = sprintf( "%.2f", $setup );
3234 $recur = sprintf( "%.2f", $recur );
3235 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
3236 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
3238 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
3239 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
3244 !$part_pkg->hidden && $options{has_hidden} ) #include some $0 lines
3247 warn " charges (setup=$setup, recur=$recur); adding line items\n"
3250 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
3252 warn " adding customer package invoice detail: $_\n"
3253 foreach @cust_pkg_detail;
3255 push @details, @cust_pkg_detail;
3257 my $cust_bill_pkg = new FS::cust_bill_pkg {
3258 'pkgnum' => $cust_pkg->pkgnum,
3260 'unitsetup' => $unitsetup,
3262 'unitrecur' => $unitrecur,
3263 'quantity' => $cust_pkg->quantity,
3264 'details' => \@details,
3265 'hidden' => $part_pkg->hidden,
3268 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
3269 $cust_bill_pkg->sdate( $hash{last_bill} );
3270 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
3271 $cust_bill_pkg->edate( $time ) if $options{cancel};
3272 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
3273 $cust_bill_pkg->sdate( $sdate );
3274 $cust_bill_pkg->edate( $cust_pkg->bill );
3275 #$cust_bill_pkg->edate( $time ) if $options{cancel};
3278 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
3279 unless $part_pkg->pkgpart == $real_pkgpart;
3281 $$total_setup += $setup;
3282 $$total_recur += $recur;
3289 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
3290 return $error if $error;
3292 push @$cust_bill_pkgs, $cust_bill_pkg;
3294 } #if $setup != 0 || $recur != 0
3304 my $part_pkg = shift;
3305 my $taxlisthash = shift;
3306 my $cust_bill_pkg = shift;
3307 my $cust_pkg = shift;
3308 my $invoice_time = shift;
3309 my $real_pkgpart = shift;
3310 my $options = shift;
3312 my %cust_bill_pkg = ();
3316 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
3317 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
3318 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
3319 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
3321 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
3323 if ( $conf->exists('enable_taxproducts')
3324 && ( scalar($part_pkg->part_pkg_taxoverride)
3325 || $part_pkg->has_taxproduct
3330 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3331 return "fatal: Can't (yet) use tax-pkg_address with taxproducts";
3334 foreach my $class (@classes) {
3335 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class );
3336 return $err_or_ref unless ref($err_or_ref);
3337 $taxes{$class} = $err_or_ref;
3340 unless (exists $taxes{''}) {
3341 my $err_or_ref = $self->_gather_taxes( $part_pkg, '' );
3342 return $err_or_ref unless ref($err_or_ref);
3343 $taxes{''} = $err_or_ref;
3348 my @loc_keys = qw( state county country );
3350 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3351 my $cust_location = $cust_pkg->cust_location;
3352 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
3355 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
3358 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
3361 $taxhash{'taxclass'} = $part_pkg->taxclass;
3363 my @taxes = qsearch( 'cust_main_county', \%taxhash );
3365 my %taxhash_elim = %taxhash;
3367 my @elim = qw( taxclass county state );
3368 while ( !scalar(@taxes) && scalar(@elim) ) {
3369 $taxhash_elim{ shift(@elim) } = '';
3370 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
3373 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
3375 if $self->cust_main_exemption; #just to be safe
3377 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3379 $_->set('pkgnum', $cust_pkg->pkgnum );
3380 $_->set('locationnum', $cust_pkg->locationnum );
3384 $taxes{''} = [ @taxes ];
3385 $taxes{'setup'} = [ @taxes ];
3386 $taxes{'recur'} = [ @taxes ];
3387 $taxes{$_} = [ @taxes ] foreach (@classes);
3389 # # maybe eliminate this entirely, along with all the 0% records
3390 # unless ( @taxes ) {
3392 # "fatal: can't find tax rate for state/county/country/taxclass ".
3393 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
3396 } #if $conf->exists('enable_taxproducts') ...
3401 my $separate = $conf->exists('separate_usage');
3402 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
3403 my $usage_mandate = $temp_pkg->part_pkg->option('usage_mandate', 'Hush!');
3404 my $section = $temp_pkg->part_pkg->categoryname;
3405 if ( $separate || $section || $usage_mandate ) {
3407 my %hash = ( 'section' => $section );
3409 $section = $temp_pkg->part_pkg->option('usage_section', 'Hush!');
3410 my $summary = $temp_pkg->part_pkg->option('summarize_usage', 'Hush!');
3412 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3413 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
3415 push @display, new FS::cust_bill_pkg_display
3418 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
3422 if ($separate && $section && $summary) {
3423 push @display, new FS::cust_bill_pkg_display { type => 'U',
3428 if ($usage_mandate || $section && $summary) {
3429 $hash{post_total} = 'Y';
3432 if ($separate || $usage_mandate) {
3433 $hash{section} = $section if ($separate || $usage_mandate);
3434 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
3438 $cust_bill_pkg->set('display', \@display);
3440 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
3441 foreach my $key (keys %tax_cust_bill_pkg) {
3442 my @taxes = @{ $taxes{$key} || [] };
3443 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
3445 my %localtaxlisthash = ();
3446 foreach my $tax ( @taxes ) {
3448 my $taxname = ref( $tax ). ' '. $tax->taxnum;
3449 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
3450 # ' locationnum'. $cust_pkg->locationnum
3451 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
3453 $taxlisthash->{ $taxname } ||= [ $tax ];
3454 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
3456 $localtaxlisthash{ $taxname } ||= [ $tax ];
3457 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
3461 warn "finding taxed taxes...\n" if $DEBUG > 2;
3462 foreach my $tax ( keys %localtaxlisthash ) {
3463 my $tax_object = shift @{ $localtaxlisthash{$tax} };
3464 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
3466 next unless $tax_object->can('tax_on_tax');
3468 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
3469 my $totname = ref( $tot ). ' '. $tot->taxnum;
3471 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
3473 next unless exists( $localtaxlisthash{ $totname } ); # only increase
3475 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
3476 my $hashref_or_error =
3477 $tax_object->taxline( $localtaxlisthash{$tax},
3478 'custnum' => $self->custnum,
3479 'invoice_time' => $invoice_time,
3481 return $hashref_or_error
3482 unless ref($hashref_or_error);
3484 $taxlisthash->{ $totname } ||= [ $tot ];
3485 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
3497 my $part_pkg = shift;
3501 my $geocode = $self->geocode('cch');
3503 my @taxclassnums = map { $_->taxclassnum }
3504 $part_pkg->part_pkg_taxoverride($class);
3506 unless (@taxclassnums) {
3507 @taxclassnums = map { $_->taxclassnum }
3508 grep { $_->taxable eq 'Y' }
3509 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
3511 warn "Found taxclassnum values of ". join(',', @taxclassnums)
3516 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
3518 @taxes = qsearch({ 'table' => 'tax_rate',
3519 'hashref' => { 'geocode' => $geocode, },
3520 'extra_sql' => $extra_sql,
3522 if scalar(@taxclassnums);
3524 warn "Found taxes ".
3525 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
3532 =item collect [ HASHREF | OPTION => VALUE ... ]
3534 (Attempt to) collect money for this customer's outstanding invoices (see
3535 L<FS::cust_bill>). Usually used after the bill method.
3537 Actions are now triggered by billing events; see L<FS::part_event> and the
3538 billing events web interface. Old-style invoice events (see
3539 L<FS::part_bill_event>) have been deprecated.
3541 If there is an error, returns the error, otherwise returns false.
3543 Options are passed as name-value pairs.
3545 Currently available options are:
3551 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.
3555 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3559 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3563 set true to surpress email card/ACH decline notices.
3567 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)
3573 # allows for one time override of normal customer billing method
3578 my( $self, %options ) = @_;
3579 my $invoice_time = $options{'invoice_time'} || time;
3582 local $SIG{HUP} = 'IGNORE';
3583 local $SIG{INT} = 'IGNORE';
3584 local $SIG{QUIT} = 'IGNORE';
3585 local $SIG{TERM} = 'IGNORE';
3586 local $SIG{TSTP} = 'IGNORE';
3587 local $SIG{PIPE} = 'IGNORE';
3589 my $oldAutoCommit = $FS::UID::AutoCommit;
3590 local $FS::UID::AutoCommit = 0;
3593 $self->select_for_update; #mutex
3596 my $balance = $self->balance;
3597 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
3600 if ( exists($options{'retry_card'}) ) {
3601 carp 'retry_card option passed to collect is deprecated; use retry';
3602 $options{'retry'} ||= $options{'retry_card'};
3604 if ( exists($options{'retry'}) && $options{'retry'} ) {
3605 my $error = $self->retry_realtime;
3607 $dbh->rollback if $oldAutoCommit;
3612 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3614 #never want to roll back an event just because it returned an error
3615 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
3617 $self->do_cust_event(
3618 'debug' => ( $options{'debug'} || 0 ),
3619 'time' => $invoice_time,
3620 'check_freq' => $options{'check_freq'},
3621 'stage' => 'collect',
3626 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
3628 Runs billing events; see L<FS::part_event> and the billing events web
3631 If there is an error, returns the error, otherwise returns false.
3633 Options are passed as name-value pairs.
3635 Currently available options are:
3641 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.
3645 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3649 "collect" (the default) or "pre-bill"
3653 set true to surpress email card/ACH decline notices.
3657 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
3663 # allows for one time override of normal customer billing method
3667 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3670 my( $self, %options ) = @_;
3671 my $time = $options{'time'} || time;
3674 local $SIG{HUP} = 'IGNORE';
3675 local $SIG{INT} = 'IGNORE';
3676 local $SIG{QUIT} = 'IGNORE';
3677 local $SIG{TERM} = 'IGNORE';
3678 local $SIG{TSTP} = 'IGNORE';
3679 local $SIG{PIPE} = 'IGNORE';
3681 my $oldAutoCommit = $FS::UID::AutoCommit;
3682 local $FS::UID::AutoCommit = 0;
3685 $self->select_for_update; #mutex
3688 my $balance = $self->balance;
3689 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
3692 # if ( exists($options{'retry_card'}) ) {
3693 # carp 'retry_card option passed to collect is deprecated; use retry';
3694 # $options{'retry'} ||= $options{'retry_card'};
3696 # if ( exists($options{'retry'}) && $options{'retry'} ) {
3697 # my $error = $self->retry_realtime;
3699 # $dbh->rollback if $oldAutoCommit;
3704 # false laziness w/pay_batch::import_results
3706 my $due_cust_event = $self->due_cust_event(
3707 'debug' => ( $options{'debug'} || 0 ),
3709 'check_freq' => $options{'check_freq'},
3710 'stage' => ( $options{'stage'} || 'collect' ),
3712 unless( ref($due_cust_event) ) {
3713 $dbh->rollback if $oldAutoCommit;
3714 return $due_cust_event;
3717 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3718 #never want to roll back an event just because it or a different one
3720 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
3722 foreach my $cust_event ( @$due_cust_event ) {
3726 #re-eval event conditions (a previous event could have changed things)
3727 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
3728 #don't leave stray "new/locked" records around
3729 my $error = $cust_event->delete;
3730 return $error if $error;
3735 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
3736 warn " running cust_event ". $cust_event->eventnum. "\n"
3739 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
3740 if ( my $error = $cust_event->do_event() ) {
3741 #XXX wtf is this? figure out a proper dealio with return value
3753 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
3755 Inserts database records for and returns an ordered listref of new events due
3756 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
3757 events are due, an empty listref is returned. If there is an error, returns a
3758 scalar error message.
3760 To actually run the events, call each event's test_condition method, and if
3761 still true, call the event's do_event method.
3763 Options are passed as a hashref or as a list of name-value pairs. Available
3770 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.
3774 "collect" (the default) or "pre-bill"
3778 "Current time" for the events.
3782 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)
3786 Only return events for the specified eventtable (by default, events of all eventtables are returned)
3790 Explicitly pass the objects to be tested (typically used with eventtable).
3794 Set to true to return the objects, but not actually insert them into the
3801 sub due_cust_event {
3803 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
3806 #my $DEBUG = $opt{'debug'}
3807 local($DEBUG) = $opt{'debug'}
3808 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
3810 warn "$me due_cust_event called with options ".
3811 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
3814 $opt{'time'} ||= time;
3816 local $SIG{HUP} = 'IGNORE';
3817 local $SIG{INT} = 'IGNORE';
3818 local $SIG{QUIT} = 'IGNORE';
3819 local $SIG{TERM} = 'IGNORE';
3820 local $SIG{TSTP} = 'IGNORE';
3821 local $SIG{PIPE} = 'IGNORE';
3823 my $oldAutoCommit = $FS::UID::AutoCommit;
3824 local $FS::UID::AutoCommit = 0;
3827 $self->select_for_update #mutex
3828 unless $opt{testonly};
3831 # find possible events (initial search)
3834 my @cust_event = ();
3836 my @eventtable = $opt{'eventtable'}
3837 ? ( $opt{'eventtable'} )
3838 : FS::part_event->eventtables_runorder;
3840 foreach my $eventtable ( @eventtable ) {
3843 if ( $opt{'objects'} ) {
3845 @objects = @{ $opt{'objects'} };
3849 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
3850 @objects = ( $eventtable eq 'cust_main' )
3852 : ( $self->$eventtable() );
3856 my @e_cust_event = ();
3858 my $cross = "CROSS JOIN $eventtable";
3859 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
3860 unless $eventtable eq 'cust_main';
3862 foreach my $object ( @objects ) {
3864 #this first search uses the condition_sql magic for optimization.
3865 #the more possible events we can eliminate in this step the better
3867 my $cross_where = '';
3868 my $pkey = $object->primary_key;
3869 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
3871 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
3873 FS::part_event_condition->where_conditions_sql( $eventtable,
3874 'time'=>$opt{'time'}
3876 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
3878 $extra_sql = "AND $extra_sql" if $extra_sql;
3880 #here is the agent virtualization
3881 $extra_sql .= " AND ( part_event.agentnum IS NULL
3882 OR part_event.agentnum = ". $self->agentnum. ' )';
3884 $extra_sql .= " $order";
3886 warn "searching for events for $eventtable ". $object->$pkey. "\n"
3887 if $opt{'debug'} > 2;
3888 my @part_event = qsearch( {
3889 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
3890 'select' => 'part_event.*',
3891 'table' => 'part_event',
3892 'addl_from' => "$cross $join",
3893 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
3894 'eventtable' => $eventtable,
3897 'extra_sql' => "AND $cross_where $extra_sql",
3901 my $pkey = $object->primary_key;
3902 warn " ". scalar(@part_event).
3903 " possible events found for $eventtable ". $object->$pkey(). "\n";
3906 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
3910 warn " ". scalar(@e_cust_event).
3911 " subtotal possible cust events found for $eventtable\n"
3914 push @cust_event, @e_cust_event;
3918 warn " ". scalar(@cust_event).
3919 " total possible cust events found in initial search\n"
3927 $opt{stage} ||= 'collect';
3929 grep { my $stage = $_->part_event->event_stage;
3930 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
3940 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
3941 'stats_hashref' => \%unsat ),
3944 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
3947 warn " invalid conditions not eliminated with condition_sql:\n".
3948 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
3949 if keys %unsat && $DEBUG; # > 1;
3955 unless( $opt{testonly} ) {
3956 foreach my $cust_event ( @cust_event ) {
3958 my $error = $cust_event->insert();
3960 $dbh->rollback if $oldAutoCommit;
3967 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3973 warn " returning events: ". Dumper(@cust_event). "\n"
3980 =item retry_realtime
3982 Schedules realtime / batch credit card / electronic check / LEC billing
3983 events for for retry. Useful if card information has changed or manual
3984 retry is desired. The 'collect' method must be called to actually retry
3987 Implementation details: For either this customer, or for each of this
3988 customer's open invoices, changes the status of the first "done" (with
3989 statustext error) realtime processing event to "failed".
3993 sub retry_realtime {
3996 local $SIG{HUP} = 'IGNORE';
3997 local $SIG{INT} = 'IGNORE';
3998 local $SIG{QUIT} = 'IGNORE';
3999 local $SIG{TERM} = 'IGNORE';
4000 local $SIG{TSTP} = 'IGNORE';
4001 local $SIG{PIPE} = 'IGNORE';
4003 my $oldAutoCommit = $FS::UID::AutoCommit;
4004 local $FS::UID::AutoCommit = 0;
4007 #a little false laziness w/due_cust_event (not too bad, really)
4009 my $join = FS::part_event_condition->join_conditions_sql;
4010 my $order = FS::part_event_condition->order_conditions_sql;
4013 . join ( ' OR ' , map {
4014 "( part_event.eventtable = " . dbh->quote($_)
4015 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
4016 } FS::part_event->eventtables)
4019 #here is the agent virtualization
4020 my $agent_virt = " ( part_event.agentnum IS NULL
4021 OR part_event.agentnum = ". $self->agentnum. ' )';
4023 #XXX this shouldn't be hardcoded, actions should declare it...
4024 my @realtime_events = qw(
4025 cust_bill_realtime_card
4026 cust_bill_realtime_check
4027 cust_bill_realtime_lec
4031 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
4036 my @cust_event = qsearchs({
4037 'table' => 'cust_event',
4038 'select' => 'cust_event.*',
4039 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
4040 'hashref' => { 'status' => 'done' },
4041 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
4042 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
4045 my %seen_invnum = ();
4046 foreach my $cust_event (@cust_event) {
4048 #max one for the customer, one for each open invoice
4049 my $cust_X = $cust_event->cust_X;
4050 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
4054 or $cust_event->part_event->eventtable eq 'cust_bill'
4057 my $error = $cust_event->retry;
4059 $dbh->rollback if $oldAutoCommit;
4060 return "error scheduling event for retry: $error";
4065 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4070 # some horrid false laziness here to avoid refactor fallout
4071 # eventually realtime realtime_bop and realtime_refund_bop should go
4072 # away and be replaced by _new_realtime_bop and _new_realtime_refund_bop
4074 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
4076 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4077 via a Business::OnlinePayment realtime gateway. See
4078 L<http://420.am/business-onlinepayment> for supported gateways.
4080 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4082 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
4084 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4085 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4086 if set, will override the value from the customer record.
4088 I<description> is a free-text field passed to the gateway. It defaults to
4089 the value defined by the business-onlinepayment-description configuration
4090 option, or "Internet services" if that is unset.
4092 If an I<invnum> is specified, this payment (if successful) is applied to the
4093 specified invoice. If you don't specify an I<invnum> you might want to
4094 call the B<apply_payments> method or set the I<apply> option.
4096 I<apply> can be set to true to apply a resulting payment.
4098 I<quiet> can be set true to surpress email decline notices.
4100 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4101 resulting paynum, if any.
4103 I<payunique> is a unique identifier for this payment.
4105 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
4112 return $self->_new_realtime_bop(@_)
4113 if $self->_new_bop_required();
4115 my($method, $amount);
4117 if (ref($_[0]) eq 'HASH') {
4118 %options = %{$_[0]};
4119 $method = $options{method};
4120 $amount = $options{amount};
4122 ( $method, $amount ) = ( shift, shift );
4126 warn "$me realtime_bop: $method $amount\n";
4127 warn " $_ => $options{$_}\n" foreach keys %options;
4130 return "Amount must be greater than 0" unless $amount > 0;
4132 unless ( $options{'description'} ) {
4133 if ( $conf->exists('business-onlinepayment-description') ) {
4134 my $dtempl = $conf->config('business-onlinepayment-description');
4136 my $agent = $self->agent->agent;
4138 $options{'description'} = eval qq("$dtempl");
4140 $options{'description'} = 'Internet services';
4144 return $self->fake_bop($method, $amount, %options) if $options{'fake'};
4146 eval "use Business::OnlinePayment";
4149 my $payinfo = exists($options{'payinfo'})
4150 ? $options{'payinfo'}
4153 my %method2payby = (
4160 # check for banned credit card/ACH
4163 my $ban = qsearchs('banned_pay', {
4164 'payby' => $method2payby{$method},
4165 'payinfo' => md5_base64($payinfo),
4167 return "Banned credit card" if $ban;
4170 # set taxclass and trans_is_recur based on invnum if there is one
4174 my $trans_is_recur = 0;
4175 if ( $options{'invnum'} ) {
4177 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
4178 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
4181 map { $_->part_pkg }
4183 map { $_->cust_pkg }
4184 $cust_bill->cust_bill_pkg;
4186 my @taxclasses = map $_->taxclass, @part_pkg;
4187 $taxclass = $taxclasses[0]
4188 unless grep { $taxclasses[0] ne $_ } @taxclasses; #unless there are
4189 #different taxclasses
4191 if grep { $_->freq ne '0' } @part_pkg;
4199 #look for an agent gateway override first
4201 if ( $method eq 'CC' ) {
4202 $cardtype = cardtype($payinfo);
4203 } elsif ( $method eq 'ECHECK' ) {
4206 $cardtype = $method;
4210 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4211 cardtype => $cardtype,
4212 taxclass => $taxclass, } )
4213 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4215 taxclass => $taxclass, } )
4216 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4217 cardtype => $cardtype,
4219 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4221 taxclass => '', } );
4223 my $payment_gateway = '';
4224 my( $processor, $login, $password, $action, @bop_options );
4225 if ( $override ) { #use a payment gateway override
4227 $payment_gateway = $override->payment_gateway;
4229 $processor = $payment_gateway->gateway_module;
4230 $login = $payment_gateway->gateway_username;
4231 $password = $payment_gateway->gateway_password;
4232 $action = $payment_gateway->gateway_action;
4233 @bop_options = $payment_gateway->options;
4235 } else { #use the standard settings from the config
4237 ( $processor, $login, $password, $action, @bop_options ) =
4238 $self->default_payment_gateway($method);
4246 my $address = exists($options{'address1'})
4247 ? $options{'address1'}
4249 my $address2 = exists($options{'address2'})
4250 ? $options{'address2'}
4252 $address .= ", ". $address2 if length($address2);
4254 my $o_payname = exists($options{'payname'})
4255 ? $options{'payname'}
4257 my($payname, $payfirst, $paylast);
4258 if ( $o_payname && $method ne 'ECHECK' ) {
4259 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4260 or return "Illegal payname $payname";
4261 ($payfirst, $paylast) = ($1, $2);
4263 $payfirst = $self->getfield('first');
4264 $paylast = $self->getfield('last');
4265 $payname = "$payfirst $paylast";
4268 my @invoicing_list = $self->invoicing_list_emailonly;
4269 if ( $conf->exists('emailinvoiceautoalways')
4270 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4271 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4272 push @invoicing_list, $self->all_emails;
4275 my $email = ($conf->exists('business-onlinepayment-email-override'))
4276 ? $conf->config('business-onlinepayment-email-override')
4277 : $invoicing_list[0];
4281 my $payip = exists($options{'payip'})
4284 $content{customer_ip} = $payip
4287 $content{invoice_number} = $options{'invnum'}
4288 if exists($options{'invnum'}) && length($options{'invnum'});
4290 $content{email_customer} =
4291 ( $conf->exists('business-onlinepayment-email_customer')
4292 || $conf->exists('business-onlinepayment-email-override') );
4295 if ( $method eq 'CC' ) {
4297 $content{card_number} = $payinfo;
4298 $paydate = exists($options{'paydate'})
4299 ? $options{'paydate'}
4301 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4302 $content{expiration} = "$2/$1";
4304 my $paycvv = exists($options{'paycvv'})
4305 ? $options{'paycvv'}
4307 $content{cvv2} = $paycvv
4310 my $paystart_month = exists($options{'paystart_month'})
4311 ? $options{'paystart_month'}
4312 : $self->paystart_month;
4314 my $paystart_year = exists($options{'paystart_year'})
4315 ? $options{'paystart_year'}
4316 : $self->paystart_year;
4318 $content{card_start} = "$paystart_month/$paystart_year"
4319 if $paystart_month && $paystart_year;
4321 my $payissue = exists($options{'payissue'})
4322 ? $options{'payissue'}
4324 $content{issue_number} = $payissue if $payissue;
4326 if ( $self->_bop_recurring_billing( 'payinfo' => $payinfo,
4327 'trans_is_recur' => $trans_is_recur,
4331 $content{recurring_billing} = 'YES';
4332 $content{acct_code} = 'rebill'
4333 if $conf->exists('credit_card-recurring_billing_acct_code');
4336 } elsif ( $method eq 'ECHECK' ) {
4337 ( $content{account_number}, $content{routing_code} ) =
4338 split('@', $payinfo);
4339 $content{bank_name} = $o_payname;
4340 $content{bank_state} = exists($options{'paystate'})
4341 ? $options{'paystate'}
4342 : $self->getfield('paystate');
4343 $content{account_type} = exists($options{'paytype'})
4344 ? uc($options{'paytype'}) || 'CHECKING'
4345 : uc($self->getfield('paytype')) || 'CHECKING';
4346 $content{account_name} = $payname;
4347 $content{customer_org} = $self->company ? 'B' : 'I';
4348 $content{state_id} = exists($options{'stateid'})
4349 ? $options{'stateid'}
4350 : $self->getfield('stateid');
4351 $content{state_id_state} = exists($options{'stateid_state'})
4352 ? $options{'stateid_state'}
4353 : $self->getfield('stateid_state');
4354 $content{customer_ssn} = exists($options{'ss'})
4357 } elsif ( $method eq 'LEC' ) {
4358 $content{phone} = $payinfo;
4362 # run transaction(s)
4365 my $balance = exists( $options{'balance'} )
4366 ? $options{'balance'}
4369 $self->select_for_update; #mutex ... just until we get our pending record in
4371 #the checks here are intended to catch concurrent payments
4372 #double-form-submission prevention is taken care of in cust_pay_pending::check
4375 return "The customer's balance has changed; $method transaction aborted."
4376 if $self->balance < $balance;
4377 #&& $self->balance < $amount; #might as well anyway?
4379 #also check and make sure there aren't *other* pending payments for this cust
4381 my @pending = qsearch('cust_pay_pending', {
4382 'custnum' => $self->custnum,
4383 'status' => { op=>'!=', value=>'done' }
4385 return "A payment is already being processed for this customer (".
4386 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
4387 "); $method transaction aborted."
4388 if scalar(@pending);
4390 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
4392 my $cust_pay_pending = new FS::cust_pay_pending {
4393 'custnum' => $self->custnum,
4394 #'invnum' => $options{'invnum'},
4397 'payby' => $method2payby{$method},
4398 'payinfo' => $payinfo,
4399 'paydate' => $paydate,
4400 'recurring_billing' => $content{recurring_billing},
4401 'pkgnum' => $options{'pkgnum'},
4403 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
4405 $cust_pay_pending->payunique( $options{payunique} )
4406 if defined($options{payunique}) && length($options{payunique});
4407 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
4408 return $cpp_new_err if $cpp_new_err;
4410 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
4412 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
4413 $transaction->content(
4416 'password' => $password,
4417 'action' => $action1,
4418 'description' => $options{'description'},
4419 'amount' => $amount,
4420 #'invoice_number' => $options{'invnum'},
4421 'customer_id' => $self->custnum,
4422 'last_name' => $paylast,
4423 'first_name' => $payfirst,
4425 'address' => $address,
4426 'city' => ( exists($options{'city'})
4429 'state' => ( exists($options{'state'})
4432 'zip' => ( exists($options{'zip'})
4435 'country' => ( exists($options{'country'})
4436 ? $options{'country'}
4438 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4440 'phone' => $self->daytime || $self->night,
4444 $cust_pay_pending->status('pending');
4445 my $cpp_pending_err = $cust_pay_pending->replace;
4446 return $cpp_pending_err if $cpp_pending_err;
4449 my $BOP_TESTING = 0;
4450 my $BOP_TESTING_SUCCESS = 1;
4452 unless ( $BOP_TESTING ) {
4453 $transaction->submit();
4455 if ( $BOP_TESTING_SUCCESS ) {
4456 $transaction->is_success(1);
4457 $transaction->authorization('fake auth');
4459 $transaction->is_success(0);
4460 $transaction->error_message('fake failure');
4464 if ( $transaction->is_success() && $action2 ) {
4466 $cust_pay_pending->status('authorized');
4467 my $cpp_authorized_err = $cust_pay_pending->replace;
4468 return $cpp_authorized_err if $cpp_authorized_err;
4470 my $auth = $transaction->authorization;
4471 my $ordernum = $transaction->can('order_number')
4472 ? $transaction->order_number
4476 new Business::OnlinePayment( $processor, @bop_options );
4483 password => $password,
4484 order_number => $ordernum,
4486 authorization => $auth,
4487 description => $options{'description'},
4490 foreach my $field (qw( authorization_source_code returned_ACI
4491 transaction_identifier validation_code
4492 transaction_sequence_num local_transaction_date
4493 local_transaction_time AVS_result_code )) {
4494 $capture{$field} = $transaction->$field() if $transaction->can($field);
4497 $capture->content( %capture );
4501 unless ( $capture->is_success ) {
4502 my $e = "Authorization successful but capture failed, custnum #".
4503 $self->custnum. ': '. $capture->result_code.
4504 ": ". $capture->error_message;
4511 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
4512 my $cpp_captured_err = $cust_pay_pending->replace;
4513 return $cpp_captured_err if $cpp_captured_err;
4516 # remove paycvv after initial transaction
4519 #false laziness w/misc/process/payment.cgi - check both to make sure working
4521 if ( defined $self->dbdef_table->column('paycvv')
4522 && length($self->paycvv)
4523 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
4525 my $error = $self->remove_cvv;
4527 warn "WARNING: error removing cvv: $error\n";
4535 if ( $transaction->is_success() ) {
4538 if ( $payment_gateway ) { # agent override
4539 $paybatch = $payment_gateway->gatewaynum. '-';
4542 $paybatch .= "$processor:". $transaction->authorization;
4544 $paybatch .= ':'. $transaction->order_number
4545 if $transaction->can('order_number')
4546 && length($transaction->order_number);
4548 my $cust_pay = new FS::cust_pay ( {
4549 'custnum' => $self->custnum,
4550 'invnum' => $options{'invnum'},
4553 'payby' => $method2payby{$method},
4554 'payinfo' => $payinfo,
4555 'paybatch' => $paybatch,
4556 'paydate' => $paydate,
4557 'pkgnum' => $options{'pkgnum'},
4559 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
4560 $cust_pay->payunique( $options{payunique} )
4561 if defined($options{payunique}) && length($options{payunique});
4563 my $oldAutoCommit = $FS::UID::AutoCommit;
4564 local $FS::UID::AutoCommit = 0;
4567 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
4569 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
4572 $cust_pay->invnum(''); #try again with no specific invnum
4573 my $error2 = $cust_pay->insert( $options{'manual'} ?
4574 ( 'manual' => 1 ) : ()
4577 # gah. but at least we have a record of the state we had to abort in
4578 # from cust_pay_pending now.
4579 my $e = "WARNING: $method captured but payment not recorded - ".
4580 "error inserting payment ($processor): $error2".
4581 " (previously tried insert with invnum #$options{'invnum'}" .
4582 ": $error ) - pending payment saved as paypendingnum ".
4583 $cust_pay_pending->paypendingnum. "\n";
4589 if ( $options{'paynum_ref'} ) {
4590 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
4593 $cust_pay_pending->status('done');
4594 $cust_pay_pending->statustext('captured');
4595 $cust_pay_pending->paynum($cust_pay->paynum);
4596 my $cpp_done_err = $cust_pay_pending->replace;
4598 if ( $cpp_done_err ) {
4600 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4601 my $e = "WARNING: $method captured but payment not recorded - ".
4602 "error updating status for paypendingnum ".
4603 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4609 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4611 if ( $options{'apply'} ) {
4612 my $apply_error = $self->apply_payments_and_credits;
4613 if ( $apply_error ) {
4614 warn "WARNING: error applying payment: $apply_error\n";
4615 #but we still should return no error cause the payment otherwise went
4620 return ''; #no error
4626 my $perror = "$processor error: ". $transaction->error_message;
4628 unless ( $transaction->error_message ) {
4631 if ( $transaction->can('response_page') ) {
4633 'page' => ( $transaction->can('response_page')
4634 ? $transaction->response_page
4637 'code' => ( $transaction->can('response_code')
4638 ? $transaction->response_code
4641 'headers' => ( $transaction->can('response_headers')
4642 ? $transaction->response_headers
4648 "No additional debugging information available for $processor";
4651 $perror .= "No error_message returned from $processor -- ".
4652 ( ref($t_response) ? Dumper($t_response) : $t_response );
4656 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
4657 && $conf->exists('emaildecline')
4658 && grep { $_ ne 'POST' } $self->invoicing_list
4659 && ! grep { $transaction->error_message =~ /$_/ }
4660 $conf->config('emaildecline-exclude')
4663 # Send a decline alert to the customer.
4664 my $msgnum = $conf->config('decline_msgnum', $self->agentnum);
4667 # include the raw error message in the transaction state
4668 $cust_pay_pending->setfield('error', $transaction->error_message);
4669 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
4670 $error = $msg_template->send( 'cust_main' => $self,
4671 'object' => $cust_pay_pending );
4675 my @templ = $conf->config('declinetemplate');
4676 my $template = new Text::Template (
4678 SOURCE => [ map "$_\n", @templ ],
4679 ) or return "($perror) can't create template: $Text::Template::ERROR";
4680 $template->compile()
4681 or return "($perror) can't compile template: $Text::Template::ERROR";
4685 scalar( $conf->config('company_name', $self->agentnum ) ),
4686 'company_address' =>
4687 join("\n", $conf->config('company_address', $self->agentnum ) ),
4688 'error' => $transaction->error_message,
4691 my $error = send_email(
4692 'from' => $conf->config('invoice_from', $self->agentnum ),
4693 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
4694 'subject' => 'Your payment could not be processed',
4695 'body' => [ $template->fill_in(HASH => $templ_hash) ],
4699 $perror .= " (also received error sending decline notification: $error)"
4704 $cust_pay_pending->status('done');
4705 $cust_pay_pending->statustext("declined: $perror");
4706 my $cpp_done_err = $cust_pay_pending->replace;
4707 if ( $cpp_done_err ) {
4708 my $e = "WARNING: $method declined but pending payment not resolved - ".
4709 "error updating status for paypendingnum ".
4710 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4712 $perror = "$e ($perror)";
4720 sub _bop_recurring_billing {
4721 my( $self, %opt ) = @_;
4723 my $method = scalar($conf->config('credit_card-recurring_billing_flag'));
4725 if ( defined($method) && $method eq 'transaction_is_recur' ) {
4727 return 1 if $opt{'trans_is_recur'};
4731 my %hash = ( 'custnum' => $self->custnum,
4736 if qsearch('cust_pay', { %hash, 'payinfo' => $opt{'payinfo'} } )
4737 || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo('CARD',
4748 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
4750 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
4751 via a Business::OnlinePayment realtime gateway. See
4752 L<http://420.am/business-onlinepayment> for supported gateways.
4754 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4756 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
4758 Most gateways require a reference to an original payment transaction to refund,
4759 so you probably need to specify a I<paynum>.
4761 I<amount> defaults to the original amount of the payment if not specified.
4763 I<reason> specifies a reason for the refund.
4765 I<paydate> specifies the expiration date for a credit card overriding the
4766 value from the customer record or the payment record. Specified as yyyy-mm-dd
4768 Implementation note: If I<amount> is unspecified or equal to the amount of the
4769 orignal payment, first an attempt is made to "void" the transaction via
4770 the gateway (to cancel a not-yet settled transaction) and then if that fails,
4771 the normal attempt is made to "refund" ("credit") the transaction via the
4772 gateway is attempted.
4774 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4775 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4776 #if set, will override the value from the customer record.
4778 #If an I<invnum> is specified, this payment (if successful) is applied to the
4779 #specified invoice. If you don't specify an I<invnum> you might want to
4780 #call the B<apply_payments> method.
4784 #some false laziness w/realtime_bop, not enough to make it worth merging
4785 #but some useful small subs should be pulled out
4786 sub realtime_refund_bop {
4789 return $self->_new_realtime_refund_bop(@_)
4790 if $self->_new_bop_required();
4792 my( $method, %options ) = @_;
4794 warn "$me realtime_refund_bop: $method refund\n";
4795 warn " $_ => $options{$_}\n" foreach keys %options;
4798 eval "use Business::OnlinePayment";
4802 # look up the original payment and optionally a gateway for that payment
4806 my $amount = $options{'amount'};
4808 my( $processor, $login, $password, @bop_options ) ;
4809 my( $auth, $order_number ) = ( '', '', '' );
4811 if ( $options{'paynum'} ) {
4813 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
4814 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
4815 or return "Unknown paynum $options{'paynum'}";
4816 $amount ||= $cust_pay->paid;
4818 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
4819 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
4820 $cust_pay->paybatch;
4821 my $gatewaynum = '';
4822 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
4824 if ( $gatewaynum ) { #gateway for the payment to be refunded
4826 my $payment_gateway =
4827 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
4828 die "payment gateway $gatewaynum not found"
4829 unless $payment_gateway;
4831 $processor = $payment_gateway->gateway_module;
4832 $login = $payment_gateway->gateway_username;
4833 $password = $payment_gateway->gateway_password;
4834 @bop_options = $payment_gateway->options;
4836 } else { #try the default gateway
4838 my( $conf_processor, $unused_action );
4839 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
4840 $self->default_payment_gateway($method);
4842 return "processor of payment $options{'paynum'} $processor does not".
4843 " match default processor $conf_processor"
4844 unless $processor eq $conf_processor;
4849 } else { # didn't specify a paynum, so look for agent gateway overrides
4850 # like a normal transaction
4853 if ( $method eq 'CC' ) {
4854 $cardtype = cardtype($self->payinfo);
4855 } elsif ( $method eq 'ECHECK' ) {
4858 $cardtype = $method;
4861 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4862 cardtype => $cardtype,
4864 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4866 taxclass => '', } );
4868 if ( $override ) { #use a payment gateway override
4870 my $payment_gateway = $override->payment_gateway;
4872 $processor = $payment_gateway->gateway_module;
4873 $login = $payment_gateway->gateway_username;
4874 $password = $payment_gateway->gateway_password;
4875 #$action = $payment_gateway->gateway_action;
4876 @bop_options = $payment_gateway->options;
4878 } else { #use the standard settings from the config
4881 ( $processor, $login, $password, $unused_action, @bop_options ) =
4882 $self->default_payment_gateway($method);
4887 return "neither amount nor paynum specified" unless $amount;
4892 'password' => $password,
4893 'order_number' => $order_number,
4894 'amount' => $amount,
4895 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4897 $content{authorization} = $auth
4898 if length($auth); #echeck/ACH transactions have an order # but no auth
4899 #(at least with authorize.net)
4901 my $disable_void_after;
4902 if ($conf->exists('disable_void_after')
4903 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
4904 $disable_void_after = $1;
4907 #first try void if applicable
4908 if ( $cust_pay && $cust_pay->paid == $amount
4910 ( not defined($disable_void_after) )
4911 || ( time < ($cust_pay->_date + $disable_void_after ) )
4914 warn " attempting void\n" if $DEBUG > 1;
4915 my $void = new Business::OnlinePayment( $processor, @bop_options );
4916 if ( $void->can('info') ) {
4917 if ( $cust_pay->payby eq 'CARD'
4918 && $void->info('CC_void_requires_card') )
4920 $content{'card_number'} = $cust_pay->payinfo
4921 } elsif ( $cust_pay->payby eq 'CHEK'
4922 && $void->info('ECHECK_void_requires_account') )
4924 ( $content{'account_number'}, $content{'routing_code'} ) =
4925 split('@', $cust_pay->payinfo);
4926 $content{'name'} = $self->get('first'). ' '. $self->get('last');
4929 $void->content( 'action' => 'void', %content );
4931 if ( $void->is_success ) {
4932 my $error = $cust_pay->void($options{'reason'});
4934 # gah, even with transactions.
4935 my $e = 'WARNING: Card/ACH voided but database not updated - '.
4936 "error voiding payment: $error";
4940 warn " void successful\n" if $DEBUG > 1;
4945 warn " void unsuccessful, trying refund\n"
4949 my $address = $self->address1;
4950 $address .= ", ". $self->address2 if $self->address2;
4952 my($payname, $payfirst, $paylast);
4953 if ( $self->payname && $method ne 'ECHECK' ) {
4954 $payname = $self->payname;
4955 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4956 or return "Illegal payname $payname";
4957 ($payfirst, $paylast) = ($1, $2);
4959 $payfirst = $self->getfield('first');
4960 $paylast = $self->getfield('last');
4961 $payname = "$payfirst $paylast";
4964 my @invoicing_list = $self->invoicing_list_emailonly;
4965 if ( $conf->exists('emailinvoiceautoalways')
4966 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4967 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4968 push @invoicing_list, $self->all_emails;
4971 my $email = ($conf->exists('business-onlinepayment-email-override'))
4972 ? $conf->config('business-onlinepayment-email-override')
4973 : $invoicing_list[0];
4975 my $payip = exists($options{'payip'})
4978 $content{customer_ip} = $payip
4982 if ( $method eq 'CC' ) {
4985 $content{card_number} = $payinfo = $cust_pay->payinfo;
4986 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
4987 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
4988 ($content{expiration} = "$2/$1"); # where available
4990 $content{card_number} = $payinfo = $self->payinfo;
4991 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
4992 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4993 $content{expiration} = "$2/$1";
4996 } elsif ( $method eq 'ECHECK' ) {
4999 $payinfo = $cust_pay->payinfo;
5001 $payinfo = $self->payinfo;
5003 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
5004 $content{bank_name} = $self->payname;
5005 $content{account_type} = 'CHECKING';
5006 $content{account_name} = $payname;
5007 $content{customer_org} = $self->company ? 'B' : 'I';
5008 $content{customer_ssn} = $self->ss;
5009 } elsif ( $method eq 'LEC' ) {
5010 $content{phone} = $payinfo = $self->payinfo;
5014 my $refund = new Business::OnlinePayment( $processor, @bop_options );
5015 my %sub_content = $refund->content(
5016 'action' => 'credit',
5017 'customer_id' => $self->custnum,
5018 'last_name' => $paylast,
5019 'first_name' => $payfirst,
5021 'address' => $address,
5022 'city' => $self->city,
5023 'state' => $self->state,
5024 'zip' => $self->zip,
5025 'country' => $self->country,
5027 'phone' => $self->daytime || $self->night,
5030 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
5034 return "$processor error: ". $refund->error_message
5035 unless $refund->is_success();
5037 my %method2payby = (
5043 my $paybatch = "$processor:". $refund->authorization;
5044 $paybatch .= ':'. $refund->order_number
5045 if $refund->can('order_number') && $refund->order_number;
5047 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
5048 my @cust_bill_pay = $cust_pay->cust_bill_pay;
5049 last unless @cust_bill_pay;
5050 my $cust_bill_pay = pop @cust_bill_pay;
5051 my $error = $cust_bill_pay->delete;
5055 my $cust_refund = new FS::cust_refund ( {
5056 'custnum' => $self->custnum,
5057 'paynum' => $options{'paynum'},
5058 'refund' => $amount,
5060 'payby' => $method2payby{$method},
5061 'payinfo' => $payinfo,
5062 'paybatch' => $paybatch,
5063 'reason' => $options{'reason'} || 'card or ACH refund',
5065 my $error = $cust_refund->insert;
5067 $cust_refund->paynum(''); #try again with no specific paynum
5068 my $error2 = $cust_refund->insert;
5070 # gah, even with transactions.
5071 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
5072 "error inserting refund ($processor): $error2".
5073 " (previously tried insert with paynum #$options{'paynum'}" .
5084 # does the configuration indicate the new bop routines are required?
5086 sub _new_bop_required {
5089 my $botpp = 'Business::OnlineThirdPartyPayment';
5092 if ( ( $conf->exists('business-onlinepayment-namespace')
5093 && $conf->config('business-onlinepayment-namespace') eq $botpp
5095 or scalar( grep { $_->gateway_namespace eq $botpp }
5096 qsearch( 'payment_gateway', { 'disabled' => '' } )
5104 =item realtime_collect [ OPTION => VALUE ... ]
5106 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
5107 via a Business::OnlinePayment or Business::OnlineThirdPartyPayment realtime
5108 gateway. See L<http://420.am/business-onlinepayment> and
5109 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5111 On failure returns an error message.
5113 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.
5115 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>, I<pkgnum>
5117 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>. If none is specified
5118 then it is deduced from the customer record.
5120 If no I<amount> is specified, then the customer balance is used.
5122 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5123 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5124 if set, will override the value from the customer record.
5126 I<description> is a free-text field passed to the gateway. It defaults to
5127 the value defined by the business-onlinepayment-description configuration
5128 option, or "Internet services" if that is unset.
5130 If an I<invnum> is specified, this payment (if successful) is applied to the
5131 specified invoice. If you don't specify an I<invnum> you might want to
5132 call the B<apply_payments> method or set the I<apply> option.
5134 I<apply> can be set to true to apply a resulting payment.
5136 I<quiet> can be set true to surpress email decline notices.
5138 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5139 resulting paynum, if any.
5141 I<payunique> is a unique identifier for this payment.
5143 I<session_id> is a session identifier associated with this payment.
5145 I<depend_jobnum> allows payment capture to unlock export jobs
5149 sub realtime_collect {
5150 my( $self, %options ) = @_;
5153 warn "$me realtime_collect:\n";
5154 warn " $_ => $options{$_}\n" foreach keys %options;
5157 $options{amount} = $self->balance unless exists( $options{amount} );
5158 $options{method} = FS::payby->payby2bop($self->payby)
5159 unless exists( $options{method} );
5161 return $self->realtime_bop({%options});
5165 =item _realtime_bop { [ ARG => VALUE ... ] }
5167 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
5168 via a Business::OnlinePayment realtime gateway. See
5169 L<http://420.am/business-onlinepayment> for supported gateways.
5171 Required arguments in the hashref are I<method>, and I<amount>
5173 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5175 Available optional arguments are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
5177 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5178 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5179 if set, will override the value from the customer record.
5181 I<description> is a free-text field passed to the gateway. It defaults to
5182 the value defined by the business-onlinepayment-description configuration
5183 option, or "Internet services" if that is unset.
5185 If an I<invnum> is specified, this payment (if successful) is applied to the
5186 specified invoice. If you don't specify an I<invnum> you might want to
5187 call the B<apply_payments> method.
5189 I<quiet> can be set true to surpress email decline notices.
5191 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5192 resulting paynum, if any.
5194 I<payunique> is a unique identifier for this payment.
5196 I<session_id> is a session identifier associated with this payment.
5198 I<depend_jobnum> allows payment capture to unlock export jobs
5200 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
5204 # some helper routines
5205 sub _payment_gateway {
5206 my ($self, $options) = @_;
5208 $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
5209 unless exists($options->{payment_gateway});
5211 $options->{payment_gateway};
5215 my ($self, $options) = @_;
5218 'login' => $options->{payment_gateway}->gateway_username,
5219 'password' => $options->{payment_gateway}->gateway_password,
5224 my ($self, $options) = @_;
5226 $options->{payment_gateway}->gatewaynum
5227 ? $options->{payment_gateway}->options
5228 : @{ $options->{payment_gateway}->get('options') };
5232 my ($self, $options) = @_;
5234 unless ( $options->{'description'} ) {
5235 if ( $conf->exists('business-onlinepayment-description') ) {
5236 my $dtempl = $conf->config('business-onlinepayment-description');
5238 my $agent = $self->agent->agent;
5240 $options->{'description'} = eval qq("$dtempl");
5242 $options->{'description'} = 'Internet services';
5246 $options->{payinfo} = $self->payinfo unless exists( $options->{payinfo} );
5247 $options->{invnum} ||= '';
5248 $options->{payname} = $self->payname unless exists( $options->{payname} );
5252 my ($self, $options) = @_;
5255 $content{address} = exists($options->{'address1'})
5256 ? $options->{'address1'}
5258 my $address2 = exists($options->{'address2'})
5259 ? $options->{'address2'}
5261 $content{address} .= ", ". $address2 if length($address2);
5263 my $payip = exists($options->{'payip'}) ? $options->{'payip'} : $self->payip;
5264 $content{customer_ip} = $payip if length($payip);
5266 $content{invoice_number} = $options->{'invnum'}
5267 if exists($options->{'invnum'}) && length($options->{'invnum'});
5269 $content{email_customer} =
5270 ( $conf->exists('business-onlinepayment-email_customer')
5271 || $conf->exists('business-onlinepayment-email-override') );
5273 $content{payfirst} = $self->getfield('first');
5274 $content{paylast} = $self->getfield('last');
5276 $content{account_name} = "$content{payfirst} $content{paylast}"
5277 if $options->{method} eq 'ECHECK';
5279 $content{name} = $options->{payname};
5280 $content{name} = $content{account_name} if exists($content{account_name});
5282 $content{city} = exists($options->{city})
5285 $content{state} = exists($options->{state})
5288 $content{zip} = exists($options->{zip})
5291 $content{country} = exists($options->{country})
5292 ? $options->{country}
5294 $content{referer} = 'http://cleanwhisker.420.am/'; #XXX fix referer :/
5295 $content{phone} = $self->daytime || $self->night;
5300 my %bop_method2payby = (
5306 sub _new_realtime_bop {
5310 if (ref($_[0]) eq 'HASH') {
5311 %options = %{$_[0]};
5313 my ( $method, $amount ) = ( shift, shift );
5315 $options{method} = $method;
5316 $options{amount} = $amount;
5320 warn "$me realtime_bop (new): $options{method} $options{amount}\n";
5321 warn " $_ => $options{$_}\n" foreach keys %options;
5324 return $self->fake_bop(%options) if $options{'fake'};
5326 $self->_bop_defaults(\%options);
5329 # set trans_is_recur based on invnum if there is one
5332 my $trans_is_recur = 0;
5333 if ( $options{'invnum'} ) {
5335 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
5336 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
5339 map { $_->part_pkg }
5341 map { $_->cust_pkg }
5342 $cust_bill->cust_bill_pkg;
5345 if grep { $_->freq ne '0' } @part_pkg;
5353 my $payment_gateway = $self->_payment_gateway( \%options );
5354 my $namespace = $payment_gateway->gateway_namespace;
5356 eval "use $namespace";
5360 # check for banned credit card/ACH
5363 my $ban = qsearchs('banned_pay', {
5364 'payby' => $bop_method2payby{$options{method}},
5365 'payinfo' => md5_base64($options{payinfo}),
5367 return "Banned credit card" if $ban;
5373 my (%bop_content) = $self->_bop_content(\%options);
5375 if ( $options{method} ne 'ECHECK' ) {
5376 $options{payname} =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5377 or return "Illegal payname $options{payname}";
5378 ($bop_content{payfirst}, $bop_content{paylast}) = ($1, $2);
5381 my @invoicing_list = $self->invoicing_list_emailonly;
5382 if ( $conf->exists('emailinvoiceautoalways')
5383 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5384 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5385 push @invoicing_list, $self->all_emails;
5388 my $email = ($conf->exists('business-onlinepayment-email-override'))
5389 ? $conf->config('business-onlinepayment-email-override')
5390 : $invoicing_list[0];
5394 if ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'CC' ) {
5396 $content{card_number} = $options{payinfo};
5397 $paydate = exists($options{'paydate'})
5398 ? $options{'paydate'}
5400 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
5401 $content{expiration} = "$2/$1";
5403 my $paycvv = exists($options{'paycvv'})
5404 ? $options{'paycvv'}
5406 $content{cvv2} = $paycvv
5409 my $paystart_month = exists($options{'paystart_month'})
5410 ? $options{'paystart_month'}
5411 : $self->paystart_month;
5413 my $paystart_year = exists($options{'paystart_year'})
5414 ? $options{'paystart_year'}
5415 : $self->paystart_year;
5417 $content{card_start} = "$paystart_month/$paystart_year"
5418 if $paystart_month && $paystart_year;
5420 my $payissue = exists($options{'payissue'})
5421 ? $options{'payissue'}
5423 $content{issue_number} = $payissue if $payissue;
5425 if ( $self->_bop_recurring_billing( 'payinfo' => $options{'payinfo'},
5426 'trans_is_recur' => $trans_is_recur,
5430 $content{recurring_billing} = 'YES';
5431 $content{acct_code} = 'rebill'
5432 if $conf->exists('credit_card-recurring_billing_acct_code');
5435 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'ECHECK' ){
5436 ( $content{account_number}, $content{routing_code} ) =
5437 split('@', $options{payinfo});
5438 $content{bank_name} = $options{payname};
5439 $content{bank_state} = exists($options{'paystate'})
5440 ? $options{'paystate'}
5441 : $self->getfield('paystate');
5442 $content{account_type} = exists($options{'paytype'})
5443 ? uc($options{'paytype'}) || 'CHECKING'
5444 : uc($self->getfield('paytype')) || 'CHECKING';
5445 $content{customer_org} = $self->company ? 'B' : 'I';
5446 $content{state_id} = exists($options{'stateid'})
5447 ? $options{'stateid'}
5448 : $self->getfield('stateid');
5449 $content{state_id_state} = exists($options{'stateid_state'})
5450 ? $options{'stateid_state'}
5451 : $self->getfield('stateid_state');
5452 $content{customer_ssn} = exists($options{'ss'})
5455 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'LEC' ) {
5456 $content{phone} = $options{payinfo};
5457 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5464 # run transaction(s)
5467 my $balance = exists( $options{'balance'} )
5468 ? $options{'balance'}
5471 $self->select_for_update; #mutex ... just until we get our pending record in
5473 #the checks here are intended to catch concurrent payments
5474 #double-form-submission prevention is taken care of in cust_pay_pending::check
5477 return "The customer's balance has changed; $options{method} transaction aborted."
5478 if $self->balance < $balance;
5479 #&& $self->balance < $options{amount}; #might as well anyway?
5481 #also check and make sure there aren't *other* pending payments for this cust
5483 my @pending = qsearch('cust_pay_pending', {
5484 'custnum' => $self->custnum,
5485 'status' => { op=>'!=', value=>'done' }
5487 return "A payment is already being processed for this customer (".
5488 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
5489 "); $options{method} transaction aborted."
5490 if scalar(@pending);
5492 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
5494 my $cust_pay_pending = new FS::cust_pay_pending {
5495 'custnum' => $self->custnum,
5496 #'invnum' => $options{'invnum'},
5497 'paid' => $options{amount},
5499 'payby' => $bop_method2payby{$options{method}},
5500 'payinfo' => $options{payinfo},
5501 'paydate' => $paydate,
5502 'recurring_billing' => $content{recurring_billing},
5503 'pkgnum' => $options{'pkgnum'},
5505 'gatewaynum' => $payment_gateway->gatewaynum || '',
5506 'session_id' => $options{session_id} || '',
5507 'jobnum' => $options{depend_jobnum} || '',
5509 $cust_pay_pending->payunique( $options{payunique} )
5510 if defined($options{payunique}) && length($options{payunique});
5511 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
5512 return $cpp_new_err if $cpp_new_err;
5514 my( $action1, $action2 ) =
5515 split( /\s*\,\s*/, $payment_gateway->gateway_action );
5517 my $transaction = new $namespace( $payment_gateway->gateway_module,
5518 $self->_bop_options(\%options),
5521 $transaction->content(
5522 'type' => $options{method},
5523 $self->_bop_auth(\%options),
5524 'action' => $action1,
5525 'description' => $options{'description'},
5526 'amount' => $options{amount},
5527 #'invoice_number' => $options{'invnum'},
5528 'customer_id' => $self->custnum,
5530 'reference' => $cust_pay_pending->paypendingnum, #for now
5535 $cust_pay_pending->status('pending');
5536 my $cpp_pending_err = $cust_pay_pending->replace;
5537 return $cpp_pending_err if $cpp_pending_err;
5540 my $BOP_TESTING = 0;
5541 my $BOP_TESTING_SUCCESS = 1;
5543 unless ( $BOP_TESTING ) {
5544 $transaction->submit();
5546 if ( $BOP_TESTING_SUCCESS ) {
5547 $transaction->is_success(1);
5548 $transaction->authorization('fake auth');
5550 $transaction->is_success(0);
5551 $transaction->error_message('fake failure');
5555 if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5557 return { reference => $cust_pay_pending->paypendingnum,
5558 map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
5560 } elsif ( $transaction->is_success() && $action2 ) {
5562 $cust_pay_pending->status('authorized');
5563 my $cpp_authorized_err = $cust_pay_pending->replace;
5564 return $cpp_authorized_err if $cpp_authorized_err;
5566 my $auth = $transaction->authorization;
5567 my $ordernum = $transaction->can('order_number')
5568 ? $transaction->order_number
5572 new Business::OnlinePayment( $payment_gateway->gateway_module,
5573 $self->_bop_options(\%options),
5578 type => $options{method},
5580 $self->_bop_auth(\%options),
5581 order_number => $ordernum,
5582 amount => $options{amount},
5583 authorization => $auth,
5584 description => $options{'description'},
5587 foreach my $field (qw( authorization_source_code returned_ACI
5588 transaction_identifier validation_code
5589 transaction_sequence_num local_transaction_date
5590 local_transaction_time AVS_result_code )) {
5591 $capture{$field} = $transaction->$field() if $transaction->can($field);
5594 $capture->content( %capture );
5598 unless ( $capture->is_success ) {
5599 my $e = "Authorization successful but capture failed, custnum #".
5600 $self->custnum. ': '. $capture->result_code.
5601 ": ". $capture->error_message;
5609 # remove paycvv after initial transaction
5612 #false laziness w/misc/process/payment.cgi - check both to make sure working
5614 if ( length($self->paycvv)
5615 && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
5617 my $error = $self->remove_cvv;
5619 warn "WARNING: error removing cvv: $error\n";
5627 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5639 if (ref($_[0]) eq 'HASH') {
5640 %options = %{$_[0]};
5642 my ( $method, $amount ) = ( shift, shift );
5644 $options{method} = $method;
5645 $options{amount} = $amount;
5648 if ( $options{'fake_failure'} ) {
5649 return "Error: No error; test failure requested with fake_failure";
5653 #if ( $payment_gateway->gatewaynum ) { # agent override
5654 # $paybatch = $payment_gateway->gatewaynum. '-';
5657 #$paybatch .= "$processor:". $transaction->authorization;
5659 #$paybatch .= ':'. $transaction->order_number
5660 # if $transaction->can('order_number')
5661 # && length($transaction->order_number);
5663 my $paybatch = 'FakeProcessor:54:32';
5665 my $cust_pay = new FS::cust_pay ( {
5666 'custnum' => $self->custnum,
5667 'invnum' => $options{'invnum'},
5668 'paid' => $options{amount},
5670 'payby' => $bop_method2payby{$options{method}},
5671 #'payinfo' => $payinfo,
5672 'payinfo' => '4111111111111111',
5673 'paybatch' => $paybatch,
5674 #'paydate' => $paydate,
5675 'paydate' => '2012-05-01',
5677 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
5679 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5682 $cust_pay->invnum(''); #try again with no specific invnum
5683 my $error2 = $cust_pay->insert( $options{'manual'} ?
5684 ( 'manual' => 1 ) : ()
5687 # gah, even with transactions.
5688 my $e = 'WARNING: Card/ACH debited but database not updated - '.
5689 "error inserting (fake!) payment: $error2".
5690 " (previously tried insert with invnum #$options{'invnum'}" .
5697 if ( $options{'paynum_ref'} ) {
5698 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5701 return ''; #no error
5706 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
5708 # Wraps up processing of a realtime credit card, ACH (electronic check) or
5709 # phone bill transaction.
5711 sub _realtime_bop_result {
5712 my( $self, $cust_pay_pending, $transaction, %options ) = @_;
5714 warn "$me _realtime_bop_result: pending transaction ".
5715 $cust_pay_pending->paypendingnum. "\n";
5716 warn " $_ => $options{$_}\n" foreach keys %options;
5719 my $payment_gateway = $options{payment_gateway}
5720 or return "no payment gateway in arguments to _realtime_bop_result";
5722 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
5723 my $cpp_captured_err = $cust_pay_pending->replace;
5724 return $cpp_captured_err if $cpp_captured_err;
5726 if ( $transaction->is_success() ) {
5729 if ( $payment_gateway->gatewaynum ) { # agent override
5730 $paybatch = $payment_gateway->gatewaynum. '-';
5733 $paybatch .= $payment_gateway->gateway_module. ":".
5734 $transaction->authorization;
5736 $paybatch .= ':'. $transaction->order_number
5737 if $transaction->can('order_number')
5738 && length($transaction->order_number);
5740 my $cust_pay = new FS::cust_pay ( {
5741 'custnum' => $self->custnum,
5742 'invnum' => $options{'invnum'},
5743 'paid' => $cust_pay_pending->paid,
5745 'payby' => $cust_pay_pending->payby,
5746 #'payinfo' => $payinfo,
5747 'paybatch' => $paybatch,
5748 'paydate' => $cust_pay_pending->paydate,
5749 'pkgnum' => $cust_pay_pending->pkgnum,
5751 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
5752 $cust_pay->payunique( $options{payunique} )
5753 if defined($options{payunique}) && length($options{payunique});
5755 my $oldAutoCommit = $FS::UID::AutoCommit;
5756 local $FS::UID::AutoCommit = 0;
5759 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
5761 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5764 $cust_pay->invnum(''); #try again with no specific invnum
5765 my $error2 = $cust_pay->insert( $options{'manual'} ?
5766 ( 'manual' => 1 ) : ()
5769 # gah. but at least we have a record of the state we had to abort in
5770 # from cust_pay_pending now.
5771 my $e = "WARNING: $options{method} captured but payment not recorded -".
5772 " error inserting payment (". $payment_gateway->gateway_module.
5774 " (previously tried insert with invnum #$options{'invnum'}" .
5775 ": $error ) - pending payment saved as paypendingnum ".
5776 $cust_pay_pending->paypendingnum. "\n";
5782 my $jobnum = $cust_pay_pending->jobnum;
5784 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5786 unless ( $placeholder ) {
5787 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5788 my $e = "WARNING: $options{method} captured but job $jobnum not ".
5789 "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
5794 $error = $placeholder->delete;
5797 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5798 my $e = "WARNING: $options{method} captured but could not delete ".
5799 "job $jobnum for paypendingnum ".
5800 $cust_pay_pending->paypendingnum. ": $error\n";
5807 if ( $options{'paynum_ref'} ) {
5808 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5811 $cust_pay_pending->status('done');
5812 $cust_pay_pending->statustext('captured');
5813 $cust_pay_pending->paynum($cust_pay->paynum);
5814 my $cpp_done_err = $cust_pay_pending->replace;
5816 if ( $cpp_done_err ) {
5818 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5819 my $e = "WARNING: $options{method} captured but payment not recorded - ".
5820 "error updating status for paypendingnum ".
5821 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5827 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5829 if ( $options{'apply'} ) {
5830 my $apply_error = $self->apply_payments_and_credits;
5831 if ( $apply_error ) {
5832 warn "WARNING: error applying payment: $apply_error\n";
5833 #but we still should return no error cause the payment otherwise went
5838 return ''; #no error
5844 my $perror = $payment_gateway->gateway_module. " error: ".
5845 $transaction->error_message;
5847 my $jobnum = $cust_pay_pending->jobnum;
5849 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5851 if ( $placeholder ) {
5852 my $error = $placeholder->depended_delete;
5853 $error ||= $placeholder->delete;
5854 warn "error removing provisioning jobs after declined paypendingnum ".
5855 $cust_pay_pending->paypendingnum. "\n";
5857 my $e = "error finding job $jobnum for declined paypendingnum ".
5858 $cust_pay_pending->paypendingnum. "\n";
5864 unless ( $transaction->error_message ) {
5867 if ( $transaction->can('response_page') ) {
5869 'page' => ( $transaction->can('response_page')
5870 ? $transaction->response_page
5873 'code' => ( $transaction->can('response_code')
5874 ? $transaction->response_code
5877 'headers' => ( $transaction->can('response_headers')
5878 ? $transaction->response_headers
5884 "No additional debugging information available for ".
5885 $payment_gateway->gateway_module;
5888 $perror .= "No error_message returned from ".
5889 $payment_gateway->gateway_module. " -- ".
5890 ( ref($t_response) ? Dumper($t_response) : $t_response );
5894 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
5895 && $conf->exists('emaildecline')
5896 && grep { $_ ne 'POST' } $self->invoicing_list
5897 && ! grep { $transaction->error_message =~ /$_/ }
5898 $conf->config('emaildecline-exclude')
5900 my @templ = $conf->config('declinetemplate');
5901 my $template = new Text::Template (
5903 SOURCE => [ map "$_\n", @templ ],
5904 ) or return "($perror) can't create template: $Text::Template::ERROR";
5905 $template->compile()
5906 or return "($perror) can't compile template: $Text::Template::ERROR";
5910 scalar( $conf->config('company_name', $self->agentnum ) ),
5911 'company_address' =>
5912 join("\n", $conf->config('company_address', $self->agentnum ) ),
5913 'error' => $transaction->error_message,
5916 my $error = send_email(
5917 'from' => $conf->config('invoice_from', $self->agentnum ),
5918 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
5919 'subject' => 'Your payment could not be processed',
5920 'body' => [ $template->fill_in(HASH => $templ_hash) ],
5923 $perror .= " (also received error sending decline notification: $error)"
5928 $cust_pay_pending->status('done');
5929 $cust_pay_pending->statustext("declined: $perror");
5930 my $cpp_done_err = $cust_pay_pending->replace;
5931 if ( $cpp_done_err ) {
5932 my $e = "WARNING: $options{method} declined but pending payment not ".
5933 "resolved - error updating status for paypendingnum ".
5934 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5936 $perror = "$e ($perror)";
5944 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
5946 Verifies successful third party processing of a realtime credit card,
5947 ACH (electronic check) or phone bill transaction via a
5948 Business::OnlineThirdPartyPayment realtime gateway. See
5949 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5951 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
5953 The additional options I<payname>, I<city>, I<state>,
5954 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5955 if set, will override the value from the customer record.
5957 I<description> is a free-text field passed to the gateway. It defaults to
5958 "Internet services".
5960 If an I<invnum> is specified, this payment (if successful) is applied to the
5961 specified invoice. If you don't specify an I<invnum> you might want to
5962 call the B<apply_payments> method.
5964 I<quiet> can be set true to surpress email decline notices.
5966 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5967 resulting paynum, if any.
5969 I<payunique> is a unique identifier for this payment.
5971 Returns a hashref containing elements bill_error (which will be undefined
5972 upon success) and session_id of any associated session.
5976 sub realtime_botpp_capture {
5977 my( $self, $cust_pay_pending, %options ) = @_;
5979 warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
5980 warn " $_ => $options{$_}\n" foreach keys %options;
5983 eval "use Business::OnlineThirdPartyPayment";
5987 # select the gateway
5990 my $method = FS::payby->payby2bop($cust_pay_pending->payby);
5992 my $payment_gateway = $cust_pay_pending->gatewaynum
5993 ? qsearchs( 'payment_gateway',
5994 { gatewaynum => $cust_pay_pending->gatewaynum }
5996 : $self->agent->payment_gateway( 'method' => $method,
5997 # 'invnum' => $cust_pay_pending->invnum,
5998 # 'payinfo' => $cust_pay_pending->payinfo,
6001 $options{payment_gateway} = $payment_gateway; # for the helper subs
6007 my @invoicing_list = $self->invoicing_list_emailonly;
6008 if ( $conf->exists('emailinvoiceautoalways')
6009 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
6010 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
6011 push @invoicing_list, $self->all_emails;
6014 my $email = ($conf->exists('business-onlinepayment-email-override'))
6015 ? $conf->config('business-onlinepayment-email-override')
6016 : $invoicing_list[0];
6020 $content{email_customer} =
6021 ( $conf->exists('business-onlinepayment-email_customer')
6022 || $conf->exists('business-onlinepayment-email-override') );
6025 # run transaction(s)
6029 new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
6030 $self->_bop_options(\%options),
6033 $transaction->reference({ %options });
6035 $transaction->content(
6037 $self->_bop_auth(\%options),
6038 'action' => 'Post Authorization',
6039 'description' => $options{'description'},
6040 'amount' => $cust_pay_pending->paid,
6041 #'invoice_number' => $options{'invnum'},
6042 'customer_id' => $self->custnum,
6043 'referer' => 'http://cleanwhisker.420.am/',
6044 'reference' => $cust_pay_pending->paypendingnum,
6046 'phone' => $self->daytime || $self->night,
6048 # plus whatever is required for bogus capture avoidance
6051 $transaction->submit();
6054 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
6057 bill_error => $error,
6058 session_id => $cust_pay_pending->session_id,
6063 =item default_payment_gateway DEPRECATED -- use agent->payment_gateway
6067 sub default_payment_gateway {
6068 my( $self, $method ) = @_;
6070 die "Real-time processing not enabled\n"
6071 unless $conf->exists('business-onlinepayment');
6073 #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
6076 my $bop_config = 'business-onlinepayment';
6077 $bop_config .= '-ach'
6078 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
6079 my ( $processor, $login, $password, $action, @bop_options ) =
6080 $conf->config($bop_config);
6081 $action ||= 'normal authorization';
6082 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
6083 die "No real-time processor is enabled - ".
6084 "did you set the business-onlinepayment configuration value?\n"
6087 ( $processor, $login, $password, $action, @bop_options )
6092 Removes the I<paycvv> field from the database directly.
6094 If there is an error, returns the error, otherwise returns false.
6100 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
6101 or return dbh->errstr;
6102 $sth->execute($self->custnum)
6103 or return $sth->errstr;
6108 =item _new_realtime_refund_bop METHOD [ OPTION => VALUE ... ]
6110 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
6111 via a Business::OnlinePayment realtime gateway. See
6112 L<http://420.am/business-onlinepayment> for supported gateways.
6114 Available methods are: I<CC>, I<ECHECK> and I<LEC>
6116 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
6118 Most gateways require a reference to an original payment transaction to refund,
6119 so you probably need to specify a I<paynum>.
6121 I<amount> defaults to the original amount of the payment if not specified.
6123 I<reason> specifies a reason for the refund.
6125 I<paydate> specifies the expiration date for a credit card overriding the
6126 value from the customer record or the payment record. Specified as yyyy-mm-dd
6128 Implementation note: If I<amount> is unspecified or equal to the amount of the
6129 orignal payment, first an attempt is made to "void" the transaction via
6130 the gateway (to cancel a not-yet settled transaction) and then if that fails,
6131 the normal attempt is made to "refund" ("credit") the transaction via the
6132 gateway is attempted.
6134 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
6135 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
6136 #if set, will override the value from the customer record.
6138 #If an I<invnum> is specified, this payment (if successful) is applied to the
6139 #specified invoice. If you don't specify an I<invnum> you might want to
6140 #call the B<apply_payments> method.
6144 #some false laziness w/realtime_bop, not enough to make it worth merging
6145 #but some useful small subs should be pulled out
6146 sub _new_realtime_refund_bop {
6150 if (ref($_[0]) ne 'HASH') {
6151 %options = %{$_[0]};
6155 $options{method} = $method;
6159 warn "$me realtime_refund_bop (new): $options{method} refund\n";
6160 warn " $_ => $options{$_}\n" foreach keys %options;
6164 # look up the original payment and optionally a gateway for that payment
6168 my $amount = $options{'amount'};
6170 my( $processor, $login, $password, @bop_options, $namespace ) ;
6171 my( $auth, $order_number ) = ( '', '', '' );
6173 if ( $options{'paynum'} ) {
6175 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
6176 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
6177 or return "Unknown paynum $options{'paynum'}";
6178 $amount ||= $cust_pay->paid;
6180 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
6181 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
6182 $cust_pay->paybatch;
6183 my $gatewaynum = '';
6184 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
6186 if ( $gatewaynum ) { #gateway for the payment to be refunded
6188 my $payment_gateway =
6189 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
6190 die "payment gateway $gatewaynum not found"
6191 unless $payment_gateway;
6193 $processor = $payment_gateway->gateway_module;
6194 $login = $payment_gateway->gateway_username;
6195 $password = $payment_gateway->gateway_password;
6196 $namespace = $payment_gateway->gateway_namespace;
6197 @bop_options = $payment_gateway->options;
6199 } else { #try the default gateway
6202 my $payment_gateway =
6203 $self->agent->payment_gateway('method' => $options{method});
6205 ( $conf_processor, $login, $password, $namespace ) =
6206 map { my $method = "gateway_$_"; $payment_gateway->$method }
6207 qw( module username password namespace );
6209 @bop_options = $payment_gateway->gatewaynum
6210 ? $payment_gateway->options
6211 : @{ $payment_gateway->get('options') };
6213 return "processor of payment $options{'paynum'} $processor does not".
6214 " match default processor $conf_processor"
6215 unless $processor eq $conf_processor;
6220 } else { # didn't specify a paynum, so look for agent gateway overrides
6221 # like a normal transaction
6223 my $payment_gateway =
6224 $self->agent->payment_gateway( 'method' => $options{method},
6225 #'payinfo' => $payinfo,
6227 my( $processor, $login, $password, $namespace ) =
6228 map { my $method = "gateway_$_"; $payment_gateway->$method }
6229 qw( module username password namespace );
6231 my @bop_options = $payment_gateway->gatewaynum
6232 ? $payment_gateway->options
6233 : @{ $payment_gateway->get('options') };
6236 return "neither amount nor paynum specified" unless $amount;
6238 eval "use $namespace";
6242 'type' => $options{method},
6244 'password' => $password,
6245 'order_number' => $order_number,
6246 'amount' => $amount,
6247 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
6249 $content{authorization} = $auth
6250 if length($auth); #echeck/ACH transactions have an order # but no auth
6251 #(at least with authorize.net)
6253 my $disable_void_after;
6254 if ($conf->exists('disable_void_after')
6255 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
6256 $disable_void_after = $1;
6259 #first try void if applicable
6260 if ( $cust_pay && $cust_pay->paid == $amount
6262 ( not defined($disable_void_after) )
6263 || ( time < ($cust_pay->_date + $disable_void_after ) )
6266 warn " attempting void\n" if $DEBUG > 1;
6267 my $void = new Business::OnlinePayment( $processor, @bop_options );
6268 if ( $void->can('info') ) {
6269 if ( $cust_pay->payby eq 'CARD'
6270 && $void->info('CC_void_requires_card') )
6272 $content{'card_number'} = $cust_pay->payinfo;
6273 } elsif ( $cust_pay->payby eq 'CHEK'
6274 && $void->info('ECHECK_void_requires_account') )
6276 ( $content{'account_number'}, $content{'routing_code'} ) =
6277 split('@', $cust_pay->payinfo);
6278 $content{'name'} = $self->get('first'). ' '. $self->get('last');
6281 $void->content( 'action' => 'void', %content );
6283 if ( $void->is_success ) {
6284 my $error = $cust_pay->void($options{'reason'});
6286 # gah, even with transactions.
6287 my $e = 'WARNING: Card/ACH voided but database not updated - '.
6288 "error voiding payment: $error";
6292 warn " void successful\n" if $DEBUG > 1;
6297 warn " void unsuccessful, trying refund\n"
6301 my $address = $self->address1;
6302 $address .= ", ". $self->address2 if $self->address2;
6304 my($payname, $payfirst, $paylast);
6305 if ( $self->payname && $options{method} ne 'ECHECK' ) {
6306 $payname = $self->payname;
6307 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
6308 or return "Illegal payname $payname";
6309 ($payfirst, $paylast) = ($1, $2);
6311 $payfirst = $self->getfield('first');
6312 $paylast = $self->getfield('last');
6313 $payname = "$payfirst $paylast";
6316 my @invoicing_list = $self->invoicing_list_emailonly;
6317 if ( $conf->exists('emailinvoiceautoalways')
6318 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
6319 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
6320 push @invoicing_list, $self->all_emails;
6323 my $email = ($conf->exists('business-onlinepayment-email-override'))
6324 ? $conf->config('business-onlinepayment-email-override')
6325 : $invoicing_list[0];
6327 my $payip = exists($options{'payip'})
6330 $content{customer_ip} = $payip
6334 if ( $options{method} eq 'CC' ) {
6337 $content{card_number} = $payinfo = $cust_pay->payinfo;
6338 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
6339 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
6340 ($content{expiration} = "$2/$1"); # where available
6342 $content{card_number} = $payinfo = $self->payinfo;
6343 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
6344 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
6345 $content{expiration} = "$2/$1";
6348 } elsif ( $options{method} eq 'ECHECK' ) {
6351 $payinfo = $cust_pay->payinfo;
6353 $payinfo = $self->payinfo;
6355 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
6356 $content{bank_name} = $self->payname;
6357 $content{account_type} = 'CHECKING';
6358 $content{account_name} = $payname;
6359 $content{customer_org} = $self->company ? 'B' : 'I';
6360 $content{customer_ssn} = $self->ss;
6361 } elsif ( $options{method} eq 'LEC' ) {
6362 $content{phone} = $payinfo = $self->payinfo;
6366 my $refund = new Business::OnlinePayment( $processor, @bop_options );
6367 my %sub_content = $refund->content(
6368 'action' => 'credit',
6369 'customer_id' => $self->custnum,
6370 'last_name' => $paylast,
6371 'first_name' => $payfirst,
6373 'address' => $address,
6374 'city' => $self->city,
6375 'state' => $self->state,
6376 'zip' => $self->zip,
6377 'country' => $self->country,
6379 'phone' => $self->daytime || $self->night,
6382 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
6386 return "$processor error: ". $refund->error_message
6387 unless $refund->is_success();
6389 my $paybatch = "$processor:". $refund->authorization;
6390 $paybatch .= ':'. $refund->order_number
6391 if $refund->can('order_number') && $refund->order_number;
6393 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
6394 my @cust_bill_pay = $cust_pay->cust_bill_pay;
6395 last unless @cust_bill_pay;
6396 my $cust_bill_pay = pop @cust_bill_pay;
6397 my $error = $cust_bill_pay->delete;
6401 my $cust_refund = new FS::cust_refund ( {
6402 'custnum' => $self->custnum,
6403 'paynum' => $options{'paynum'},
6404 'refund' => $amount,
6406 'payby' => $bop_method2payby{$options{method}},
6407 'payinfo' => $payinfo,
6408 'paybatch' => $paybatch,
6409 'reason' => $options{'reason'} || 'card or ACH refund',
6411 my $error = $cust_refund->insert;
6413 $cust_refund->paynum(''); #try again with no specific paynum
6414 my $error2 = $cust_refund->insert;
6416 # gah, even with transactions.
6417 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
6418 "error inserting refund ($processor): $error2".
6419 " (previously tried insert with paynum #$options{'paynum'}" .
6430 =item batch_card OPTION => VALUE...
6432 Adds a payment for this invoice to the pending credit card batch (see
6433 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
6434 runs the payment using a realtime gateway.
6439 my ($self, %options) = @_;
6442 if (exists($options{amount})) {
6443 $amount = $options{amount};
6445 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
6447 return '' unless $amount > 0;
6449 my $invnum = delete $options{invnum};
6450 my $payby = $options{invnum} || $self->payby; #dubious
6452 if ($options{'realtime'}) {
6453 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
6459 my $oldAutoCommit = $FS::UID::AutoCommit;
6460 local $FS::UID::AutoCommit = 0;
6463 #this needs to handle mysql as well as Pg, like svc_acct.pm
6464 #(make it into a common function if folks need to do batching with mysql)
6465 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
6466 or return "Cannot lock pay_batch: " . $dbh->errstr;
6470 'payby' => FS::payby->payby2payment($payby),
6473 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
6475 unless ( $pay_batch ) {
6476 $pay_batch = new FS::pay_batch \%pay_batch;
6477 my $error = $pay_batch->insert;
6479 $dbh->rollback if $oldAutoCommit;
6480 die "error creating new batch: $error\n";
6484 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
6485 'batchnum' => $pay_batch->batchnum,
6486 'custnum' => $self->custnum,
6489 foreach (qw( address1 address2 city state zip country payby payinfo paydate
6491 $options{$_} = '' unless exists($options{$_});
6494 my $cust_pay_batch = new FS::cust_pay_batch ( {
6495 'batchnum' => $pay_batch->batchnum,
6496 'invnum' => $invnum || 0, # is there a better value?
6497 # this field should be
6499 # cust_bill_pay_batch now
6500 'custnum' => $self->custnum,
6501 'last' => $self->getfield('last'),
6502 'first' => $self->getfield('first'),
6503 'address1' => $options{address1} || $self->address1,
6504 'address2' => $options{address2} || $self->address2,
6505 'city' => $options{city} || $self->city,
6506 'state' => $options{state} || $self->state,
6507 'zip' => $options{zip} || $self->zip,
6508 'country' => $options{country} || $self->country,
6509 'payby' => $options{payby} || $self->payby,
6510 'payinfo' => $options{payinfo} || $self->payinfo,
6511 'exp' => $options{paydate} || $self->paydate,
6512 'payname' => $options{payname} || $self->payname,
6513 'amount' => $amount, # consolidating
6516 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
6517 if $old_cust_pay_batch;
6520 if ($old_cust_pay_batch) {
6521 $error = $cust_pay_batch->replace($old_cust_pay_batch)
6523 $error = $cust_pay_batch->insert;
6527 $dbh->rollback if $oldAutoCommit;
6531 my $unapplied = $self->total_unapplied_credits
6532 + $self->total_unapplied_payments
6533 + $self->in_transit_payments;
6534 foreach my $cust_bill ($self->open_cust_bill) {
6535 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
6536 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
6537 'invnum' => $cust_bill->invnum,
6538 'paybatchnum' => $cust_pay_batch->paybatchnum,
6539 'amount' => $cust_bill->owed,
6542 if ($unapplied >= $cust_bill_pay_batch->amount){
6543 $unapplied -= $cust_bill_pay_batch->amount;
6546 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
6547 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
6549 $error = $cust_bill_pay_batch->insert;
6551 $dbh->rollback if $oldAutoCommit;
6556 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6560 =item apply_payments_and_credits [ OPTION => VALUE ... ]
6562 Applies unapplied payments and credits.
6564 In most cases, this new method should be used in place of sequential
6565 apply_payments and apply_credits methods.
6567 A hash of optional arguments may be passed. Currently "manual" is supported.
6568 If true, a payment receipt is sent instead of a statement when
6569 'payment_receipt_email' configuration option is set.
6571 If there is an error, returns the error, otherwise returns false.
6575 sub apply_payments_and_credits {
6576 my( $self, %options ) = @_;
6578 local $SIG{HUP} = 'IGNORE';
6579 local $SIG{INT} = 'IGNORE';
6580 local $SIG{QUIT} = 'IGNORE';
6581 local $SIG{TERM} = 'IGNORE';
6582 local $SIG{TSTP} = 'IGNORE';
6583 local $SIG{PIPE} = 'IGNORE';
6585 my $oldAutoCommit = $FS::UID::AutoCommit;
6586 local $FS::UID::AutoCommit = 0;
6589 $self->select_for_update; #mutex
6591 foreach my $cust_bill ( $self->open_cust_bill ) {
6592 my $error = $cust_bill->apply_payments_and_credits(%options);
6594 $dbh->rollback if $oldAutoCommit;
6595 return "Error applying: $error";
6599 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6604 =item apply_credits OPTION => VALUE ...
6606 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
6607 to outstanding invoice balances in chronological order (or reverse
6608 chronological order if the I<order> option is set to B<newest>) and returns the
6609 value of any remaining unapplied credits available for refund (see
6610 L<FS::cust_refund>).
6612 Dies if there is an error.
6620 local $SIG{HUP} = 'IGNORE';
6621 local $SIG{INT} = 'IGNORE';
6622 local $SIG{QUIT} = 'IGNORE';
6623 local $SIG{TERM} = 'IGNORE';
6624 local $SIG{TSTP} = 'IGNORE';
6625 local $SIG{PIPE} = 'IGNORE';
6627 my $oldAutoCommit = $FS::UID::AutoCommit;
6628 local $FS::UID::AutoCommit = 0;
6631 $self->select_for_update; #mutex
6633 unless ( $self->total_unapplied_credits ) {
6634 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6638 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
6639 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
6641 my @invoices = $self->open_cust_bill;
6642 @invoices = sort { $b->_date <=> $a->_date } @invoices
6643 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
6645 if ( $conf->exists('pkg-balances') ) {
6646 # limit @credits to those w/ a pkgnum grepped from $self
6648 foreach my $i (@invoices) {
6649 foreach my $li ( $i->cust_bill_pkg ) {
6650 $pkgnums{$li->pkgnum} = 1;
6653 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
6658 foreach my $cust_bill ( @invoices ) {
6660 if ( !defined($credit) || $credit->credited == 0) {
6661 $credit = pop @credits or last;
6665 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
6666 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
6668 $owed = $cust_bill->owed;
6670 unless ( $owed > 0 ) {
6671 push @credits, $credit;
6675 my $amount = min( $credit->credited, $owed );
6677 my $cust_credit_bill = new FS::cust_credit_bill ( {
6678 'crednum' => $credit->crednum,
6679 'invnum' => $cust_bill->invnum,
6680 'amount' => $amount,
6682 $cust_credit_bill->pkgnum( $credit->pkgnum )
6683 if $conf->exists('pkg-balances') && $credit->pkgnum;
6684 my $error = $cust_credit_bill->insert;
6686 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6690 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6694 my $total_unapplied_credits = $self->total_unapplied_credits;
6696 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6698 return $total_unapplied_credits;
6701 =item apply_payments [ OPTION => VALUE ... ]
6703 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
6704 to outstanding invoice balances in chronological order.
6706 #and returns the value of any remaining unapplied payments.
6708 A hash of optional arguments may be passed. Currently "manual" is supported.
6709 If true, a payment receipt is sent instead of a statement when
6710 'payment_receipt_email' configuration option is set.
6712 Dies if there is an error.
6716 sub apply_payments {
6717 my( $self, %options ) = @_;
6719 local $SIG{HUP} = 'IGNORE';
6720 local $SIG{INT} = 'IGNORE';
6721 local $SIG{QUIT} = 'IGNORE';
6722 local $SIG{TERM} = 'IGNORE';
6723 local $SIG{TSTP} = 'IGNORE';
6724 local $SIG{PIPE} = 'IGNORE';
6726 my $oldAutoCommit = $FS::UID::AutoCommit;
6727 local $FS::UID::AutoCommit = 0;
6730 $self->select_for_update; #mutex
6734 my @payments = sort { $b->_date <=> $a->_date }
6735 grep { $_->unapplied > 0 }
6738 my @invoices = sort { $a->_date <=> $b->_date}
6739 grep { $_->owed > 0 }
6742 if ( $conf->exists('pkg-balances') ) {
6743 # limit @payments to those w/ a pkgnum grepped from $self
6745 foreach my $i (@invoices) {
6746 foreach my $li ( $i->cust_bill_pkg ) {
6747 $pkgnums{$li->pkgnum} = 1;
6750 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
6755 foreach my $cust_bill ( @invoices ) {
6757 if ( !defined($payment) || $payment->unapplied == 0 ) {
6758 $payment = pop @payments or last;
6762 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
6763 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
6765 $owed = $cust_bill->owed;
6767 unless ( $owed > 0 ) {
6768 push @payments, $payment;
6772 my $amount = min( $payment->unapplied, $owed );
6774 my $cust_bill_pay = new FS::cust_bill_pay ( {
6775 'paynum' => $payment->paynum,
6776 'invnum' => $cust_bill->invnum,
6777 'amount' => $amount,
6779 $cust_bill_pay->pkgnum( $payment->pkgnum )
6780 if $conf->exists('pkg-balances') && $payment->pkgnum;
6781 my $error = $cust_bill_pay->insert(%options);
6783 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6787 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6791 my $total_unapplied_payments = $self->total_unapplied_payments;
6793 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6795 return $total_unapplied_payments;
6800 Returns the total owed for this customer on all invoices
6801 (see L<FS::cust_bill/owed>).
6807 $self->total_owed_date(2145859200); #12/31/2037
6810 =item total_owed_date TIME
6812 Returns the total owed for this customer on all invoices with date earlier than
6813 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6814 see L<Time::Local> and L<Date::Parse> for conversion functions.
6818 sub total_owed_date {
6822 # my $custnum = $self->custnum;
6824 # my $owed_sql = FS::cust_bill->owed_sql;
6827 # SELECT SUM($owed_sql) FROM cust_bill
6828 # WHERE custnum = $custnum
6829 # AND _date <= $time
6832 # my $sth = dbh->prepare($sql) or die dbh->errstr;
6833 # $sth->execute() or die $sth->errstr;
6835 # return sprintf( '%.2f', $sth->fetchrow_arrayref->[0] );
6838 foreach my $cust_bill (
6839 grep { $_->_date <= $time }
6840 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6842 $total_bill += $cust_bill->owed;
6844 sprintf( "%.2f", $total_bill );
6848 =item total_owed_pkgnum PKGNUM
6850 Returns the total owed on all invoices for this customer's specific package
6851 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
6855 sub total_owed_pkgnum {
6856 my( $self, $pkgnum ) = @_;
6857 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
6860 =item total_owed_date_pkgnum TIME PKGNUM
6862 Returns the total owed for this customer's specific package when using
6863 experimental package balances on all invoices with date earlier than
6864 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6865 see L<Time::Local> and L<Date::Parse> for conversion functions.
6869 sub total_owed_date_pkgnum {
6870 my( $self, $time, $pkgnum ) = @_;
6873 foreach my $cust_bill (
6874 grep { $_->_date <= $time }
6875 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6877 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
6879 sprintf( "%.2f", $total_bill );
6885 Returns the total amount of all payments.
6892 $total += $_->paid foreach $self->cust_pay;
6893 sprintf( "%.2f", $total );
6896 =item total_unapplied_credits
6898 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6899 customer. See L<FS::cust_credit/credited>.
6901 =item total_credited
6903 Old name for total_unapplied_credits. Don't use.
6907 sub total_credited {
6908 #carp "total_credited deprecated, use total_unapplied_credits";
6909 shift->total_unapplied_credits(@_);
6912 sub total_unapplied_credits {
6914 my $total_credit = 0;
6915 $total_credit += $_->credited foreach $self->cust_credit;
6916 sprintf( "%.2f", $total_credit );
6919 =item total_unapplied_credits_pkgnum PKGNUM
6921 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6922 customer. See L<FS::cust_credit/credited>.
6926 sub total_unapplied_credits_pkgnum {
6927 my( $self, $pkgnum ) = @_;
6928 my $total_credit = 0;
6929 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
6930 sprintf( "%.2f", $total_credit );
6934 =item total_unapplied_payments
6936 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
6937 See L<FS::cust_pay/unapplied>.
6941 sub total_unapplied_payments {
6943 my $total_unapplied = 0;
6944 $total_unapplied += $_->unapplied foreach $self->cust_pay;
6945 sprintf( "%.2f", $total_unapplied );
6948 =item total_unapplied_payments_pkgnum PKGNUM
6950 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
6951 specific package when using experimental package balances. See
6952 L<FS::cust_pay/unapplied>.
6956 sub total_unapplied_payments_pkgnum {
6957 my( $self, $pkgnum ) = @_;
6958 my $total_unapplied = 0;
6959 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
6960 sprintf( "%.2f", $total_unapplied );
6964 =item total_unapplied_refunds
6966 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
6967 customer. See L<FS::cust_refund/unapplied>.
6971 sub total_unapplied_refunds {
6973 my $total_unapplied = 0;
6974 $total_unapplied += $_->unapplied foreach $self->cust_refund;
6975 sprintf( "%.2f", $total_unapplied );
6980 Returns the balance for this customer (total_owed plus total_unrefunded, minus
6981 total_unapplied_credits minus total_unapplied_payments).
6989 + $self->total_unapplied_refunds
6990 - $self->total_unapplied_credits
6991 - $self->total_unapplied_payments
6995 =item balance_date TIME
6997 Returns the balance for this customer, only considering invoices with date
6998 earlier than TIME (total_owed_date minus total_credited minus
6999 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
7000 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
7009 $self->total_owed_date($time)
7010 + $self->total_unapplied_refunds
7011 - $self->total_unapplied_credits
7012 - $self->total_unapplied_payments
7016 =item balance_date_range START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
7018 Returns the balance for this customer, only considering invoices with date
7019 earlier than START_TIME, and optionally not later than END_TIME
7020 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
7022 Times are specified as SQL fragments or numeric
7023 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
7024 L<Date::Parse> for conversion functions. The empty string can be passed
7025 to disable that time constraint completely.
7027 Available options are:
7031 =item unapplied_date
7033 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)
7039 sub balance_date_range {
7041 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
7042 ') FROM cust_main WHERE custnum='. $self->custnum;
7043 sprintf( '%.2f', $self->scalar_sql($sql) );
7046 =item balance_pkgnum PKGNUM
7048 Returns the balance for this customer's specific package when using
7049 experimental package balances (total_owed plus total_unrefunded, minus
7050 total_unapplied_credits minus total_unapplied_payments)
7054 sub balance_pkgnum {
7055 my( $self, $pkgnum ) = @_;
7058 $self->total_owed_pkgnum($pkgnum)
7059 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
7060 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
7061 - $self->total_unapplied_credits_pkgnum($pkgnum)
7062 - $self->total_unapplied_payments_pkgnum($pkgnum)
7066 =item in_transit_payments
7068 Returns the total of requests for payments for this customer pending in
7069 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
7073 sub in_transit_payments {
7075 my $in_transit_payments = 0;
7076 foreach my $pay_batch ( qsearch('pay_batch', {
7079 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
7080 'batchnum' => $pay_batch->batchnum,
7081 'custnum' => $self->custnum,
7083 $in_transit_payments += $cust_pay_batch->amount;
7086 sprintf( "%.2f", $in_transit_payments );
7091 Returns a hash of useful information for making a payment.
7101 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
7102 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
7103 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
7107 For credit card transactions:
7119 For electronic check transactions:
7134 $return{balance} = $self->balance;
7136 $return{payname} = $self->payname
7137 || ( $self->first. ' '. $self->get('last') );
7139 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
7141 $return{payby} = $self->payby;
7142 $return{stateid_state} = $self->stateid_state;
7144 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
7145 $return{card_type} = cardtype($self->payinfo);
7146 $return{payinfo} = $self->paymask;
7148 @return{'month', 'year'} = $self->paydate_monthyear;
7152 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
7153 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
7154 $return{payinfo1} = $payinfo1;
7155 $return{payinfo2} = $payinfo2;
7156 $return{paytype} = $self->paytype;
7157 $return{paystate} = $self->paystate;
7161 #doubleclick protection
7163 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
7169 =item paydate_monthyear
7171 Returns a two-element list consisting of the month and year of this customer's
7172 paydate (credit card expiration date for CARD customers)
7176 sub paydate_monthyear {
7178 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
7180 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
7187 =item tax_exemption TAXNAME
7192 my( $self, $taxname ) = @_;
7194 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
7195 'taxname' => $taxname,
7200 =item cust_main_exemption
7204 sub cust_main_exemption {
7206 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
7209 =item invoicing_list [ ARRAYREF ]
7211 If an arguement is given, sets these email addresses as invoice recipients
7212 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
7213 (except as warnings), so use check_invoicing_list first.
7215 Returns a list of email addresses (with svcnum entries expanded).
7217 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
7218 check it without disturbing anything by passing nothing.
7220 This interface may change in the future.
7224 sub invoicing_list {
7225 my( $self, $arrayref ) = @_;
7228 my @cust_main_invoice;
7229 if ( $self->custnum ) {
7230 @cust_main_invoice =
7231 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7233 @cust_main_invoice = ();
7235 foreach my $cust_main_invoice ( @cust_main_invoice ) {
7236 #warn $cust_main_invoice->destnum;
7237 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
7238 #warn $cust_main_invoice->destnum;
7239 my $error = $cust_main_invoice->delete;
7240 warn $error if $error;
7243 if ( $self->custnum ) {
7244 @cust_main_invoice =
7245 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7247 @cust_main_invoice = ();
7249 my %seen = map { $_->address => 1 } @cust_main_invoice;
7250 foreach my $address ( @{$arrayref} ) {
7251 next if exists $seen{$address} && $seen{$address};
7252 $seen{$address} = 1;
7253 my $cust_main_invoice = new FS::cust_main_invoice ( {
7254 'custnum' => $self->custnum,
7257 my $error = $cust_main_invoice->insert;
7258 warn $error if $error;
7262 if ( $self->custnum ) {
7264 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7271 =item check_invoicing_list ARRAYREF
7273 Checks these arguements as valid input for the invoicing_list method. If there
7274 is an error, returns the error, otherwise returns false.
7278 sub check_invoicing_list {
7279 my( $self, $arrayref ) = @_;
7281 foreach my $address ( @$arrayref ) {
7283 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
7284 return 'Can\'t add FAX invoice destination with a blank FAX number.';
7287 my $cust_main_invoice = new FS::cust_main_invoice ( {
7288 'custnum' => $self->custnum,
7291 my $error = $self->custnum
7292 ? $cust_main_invoice->check
7293 : $cust_main_invoice->checkdest
7295 return $error if $error;
7299 return "Email address required"
7300 if $conf->exists('cust_main-require_invoicing_list_email')
7301 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
7306 =item set_default_invoicing_list
7308 Sets the invoicing list to all accounts associated with this customer,
7309 overwriting any previous invoicing list.
7313 sub set_default_invoicing_list {
7315 $self->invoicing_list($self->all_emails);
7320 Returns the email addresses of all accounts provisioned for this customer.
7327 foreach my $cust_pkg ( $self->all_pkgs ) {
7328 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
7330 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
7331 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
7333 $list{$_}=1 foreach map { $_->email } @svc_acct;
7338 =item invoicing_list_addpost
7340 Adds postal invoicing to this customer. If this customer is already configured
7341 to receive postal invoices, does nothing.
7345 sub invoicing_list_addpost {
7347 return if grep { $_ eq 'POST' } $self->invoicing_list;
7348 my @invoicing_list = $self->invoicing_list;
7349 push @invoicing_list, 'POST';
7350 $self->invoicing_list(\@invoicing_list);
7353 =item invoicing_list_emailonly
7355 Returns the list of email invoice recipients (invoicing_list without non-email
7356 destinations such as POST and FAX).
7360 sub invoicing_list_emailonly {
7362 warn "$me invoicing_list_emailonly called"
7364 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
7367 =item invoicing_list_emailonly_scalar
7369 Returns the list of email invoice recipients (invoicing_list without non-email
7370 destinations such as POST and FAX) as a comma-separated scalar.
7374 sub invoicing_list_emailonly_scalar {
7376 warn "$me invoicing_list_emailonly_scalar called"
7378 join(', ', $self->invoicing_list_emailonly);
7381 =item referral_custnum_cust_main
7383 Returns the customer who referred this customer (or the empty string, if
7384 this customer was not referred).
7386 Note the difference with referral_cust_main method: This method,
7387 referral_custnum_cust_main returns the single customer (if any) who referred
7388 this customer, while referral_cust_main returns an array of customers referred
7393 sub referral_custnum_cust_main {
7395 return '' unless $self->referral_custnum;
7396 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7399 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
7401 Returns an array of customers referred by this customer (referral_custnum set
7402 to this custnum). If DEPTH is given, recurses up to the given depth, returning
7403 customers referred by customers referred by this customer and so on, inclusive.
7404 The default behavior is DEPTH 1 (no recursion).
7406 Note the difference with referral_custnum_cust_main method: This method,
7407 referral_cust_main, returns an array of customers referred BY this customer,
7408 while referral_custnum_cust_main returns the single customer (if any) who
7409 referred this customer.
7413 sub referral_cust_main {
7415 my $depth = @_ ? shift : 1;
7416 my $exclude = @_ ? shift : {};
7419 map { $exclude->{$_->custnum}++; $_; }
7420 grep { ! $exclude->{ $_->custnum } }
7421 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
7425 map { $_->referral_cust_main($depth-1, $exclude) }
7432 =item referral_cust_main_ncancelled
7434 Same as referral_cust_main, except only returns customers with uncancelled
7439 sub referral_cust_main_ncancelled {
7441 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
7444 =item referral_cust_pkg [ DEPTH ]
7446 Like referral_cust_main, except returns a flat list of all unsuspended (and
7447 uncancelled) packages for each customer. The number of items in this list may
7448 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
7452 sub referral_cust_pkg {
7454 my $depth = @_ ? shift : 1;
7456 map { $_->unsuspended_pkgs }
7457 grep { $_->unsuspended_pkgs }
7458 $self->referral_cust_main($depth);
7461 =item referring_cust_main
7463 Returns the single cust_main record for the customer who referred this customer
7464 (referral_custnum), or false.
7468 sub referring_cust_main {
7470 return '' unless $self->referral_custnum;
7471 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7474 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
7476 Applies a credit to this customer. If there is an error, returns the error,
7477 otherwise returns false.
7479 REASON can be a text string, an FS::reason object, or a scalar reference to
7480 a reasonnum. If a text string, it will be automatically inserted as a new
7481 reason, and a 'reason_type' option must be passed to indicate the
7482 FS::reason_type for the new reason.
7484 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
7486 Any other options are passed to FS::cust_credit::insert.
7491 my( $self, $amount, $reason, %options ) = @_;
7493 my $cust_credit = new FS::cust_credit {
7494 'custnum' => $self->custnum,
7495 'amount' => $amount,
7498 if ( ref($reason) ) {
7500 if ( ref($reason) eq 'SCALAR' ) {
7501 $cust_credit->reasonnum( $$reason );
7503 $cust_credit->reasonnum( $reason->reasonnum );
7507 $cust_credit->set('reason', $reason)
7510 for (qw( addlinfo eventnum )) {
7511 $cust_credit->$_( delete $options{$_} )
7512 if exists($options{$_});
7515 $cust_credit->insert(%options);
7519 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
7522 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
7523 time will be ignored. Note that START_TIME and END_TIME only limit the date
7524 range for invoices and I<unapplied> payments, credits, and refunds.
7527 Creates a one-time charge for this customer. If there is an error, returns
7528 the error, otherwise returns false.
7530 New-style, with a hashref of options:
7532 my $error = $cust_main->charge(
7536 'start_date' => str2time('7/4/2009'),
7537 'pkg' => 'Description',
7538 'comment' => 'Comment',
7539 'additional' => [], #extra invoice detail
7540 'classnum' => 1, #pkg_class
7542 'setuptax' => '', # or 'Y' for tax exempt
7545 'taxclass' => 'Tax class',
7548 'taxproduct' => 2, #part_pkg_taxproduct
7549 'override' => {}, #XXX describe
7551 #will be filled in with the new object
7552 'cust_pkg_ref' => \$cust_pkg,
7554 #generate an invoice immediately
7556 'invoice_terms' => '', #with these terms
7562 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
7568 my ( $amount, $quantity, $start_date, $classnum );
7569 my ( $pkg, $comment, $additional );
7570 my ( $setuptax, $taxclass ); #internal taxes
7571 my ( $taxproduct, $override ); #vendor (CCH) taxes
7572 my $cust_pkg_ref = '';
7573 my ( $bill_now, $invoice_terms ) = ( 0, '' );
7574 if ( ref( $_[0] ) ) {
7575 $amount = $_[0]->{amount};
7576 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
7577 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
7578 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
7579 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
7580 : '$'. sprintf("%.2f",$amount);
7581 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
7582 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
7583 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
7584 $additional = $_[0]->{additional} || [];
7585 $taxproduct = $_[0]->{taxproductnum};
7586 $override = { '' => $_[0]->{tax_override} };
7587 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
7588 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
7589 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
7594 $pkg = @_ ? shift : 'One-time charge';
7595 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
7597 $taxclass = @_ ? shift : '';
7601 local $SIG{HUP} = 'IGNORE';
7602 local $SIG{INT} = 'IGNORE';
7603 local $SIG{QUIT} = 'IGNORE';
7604 local $SIG{TERM} = 'IGNORE';
7605 local $SIG{TSTP} = 'IGNORE';
7606 local $SIG{PIPE} = 'IGNORE';
7608 my $oldAutoCommit = $FS::UID::AutoCommit;
7609 local $FS::UID::AutoCommit = 0;
7612 my $part_pkg = new FS::part_pkg ( {
7614 'comment' => $comment,
7618 'classnum' => $classnum ? $classnum : '',
7619 'setuptax' => $setuptax,
7620 'taxclass' => $taxclass,
7621 'taxproductnum' => $taxproduct,
7624 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
7625 ( 0 .. @$additional - 1 )
7627 'additional_count' => scalar(@$additional),
7628 'setup_fee' => $amount,
7631 my $error = $part_pkg->insert( options => \%options,
7632 tax_overrides => $override,
7635 $dbh->rollback if $oldAutoCommit;
7639 my $pkgpart = $part_pkg->pkgpart;
7640 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
7641 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
7642 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
7643 $error = $type_pkgs->insert;
7645 $dbh->rollback if $oldAutoCommit;
7650 my $cust_pkg = new FS::cust_pkg ( {
7651 'custnum' => $self->custnum,
7652 'pkgpart' => $pkgpart,
7653 'quantity' => $quantity,
7654 'start_date' => $start_date,
7657 $error = $cust_pkg->insert;
7659 $dbh->rollback if $oldAutoCommit;
7661 } elsif ( $cust_pkg_ref ) {
7662 ${$cust_pkg_ref} = $cust_pkg;
7666 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
7667 'pkg_list' => [ $cust_pkg ],
7670 $dbh->rollback if $oldAutoCommit;
7675 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
7680 #=item charge_postal_fee
7682 #Applies a one time charge this customer. If there is an error,
7683 #returns the error, returns the cust_pkg charge object or false
7684 #if there was no charge.
7688 # This should be a customer event. For that to work requires that bill
7689 # also be a customer event.
7691 sub charge_postal_fee {
7694 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
7695 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
7697 my $cust_pkg = new FS::cust_pkg ( {
7698 'custnum' => $self->custnum,
7699 'pkgpart' => $pkgpart,
7703 my $error = $cust_pkg->insert;
7704 $error ? $error : $cust_pkg;
7709 Returns all the invoices (see L<FS::cust_bill>) for this customer.
7715 map { $_ } #return $self->num_cust_bill unless wantarray;
7716 sort { $a->_date <=> $b->_date }
7717 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
7720 =item open_cust_bill
7722 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
7727 sub open_cust_bill {
7731 'table' => 'cust_bill',
7732 'hashref' => { 'custnum' => $self->custnum, },
7733 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
7734 'order_by' => 'ORDER BY _date ASC',
7739 =item cust_statements
7741 Returns all the statements (see L<FS::cust_statement>) for this customer.
7745 sub cust_statement {
7747 map { $_ } #return $self->num_cust_statement unless wantarray;
7748 sort { $a->_date <=> $b->_date }
7749 qsearch('cust_statement', { 'custnum' => $self->custnum, } )
7754 Returns all the credits (see L<FS::cust_credit>) for this customer.
7760 map { $_ } #return $self->num_cust_credit unless wantarray;
7761 sort { $a->_date <=> $b->_date }
7762 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
7765 =item cust_credit_pkgnum
7767 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
7768 package when using experimental package balances.
7772 sub cust_credit_pkgnum {
7773 my( $self, $pkgnum ) = @_;
7774 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
7775 sort { $a->_date <=> $b->_date }
7776 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
7777 'pkgnum' => $pkgnum,
7784 Returns all the payments (see L<FS::cust_pay>) for this customer.
7790 return $self->num_cust_pay unless wantarray;
7791 sort { $a->_date <=> $b->_date }
7792 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
7797 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
7798 called automatically when the cust_pay method is used in a scalar context.
7804 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
7805 my $sth = dbh->prepare($sql) or die dbh->errstr;
7806 $sth->execute($self->custnum) or die $sth->errstr;
7807 $sth->fetchrow_arrayref->[0];
7810 =item cust_pay_pkgnum
7812 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
7813 package when using experimental package balances.
7817 sub cust_pay_pkgnum {
7818 my( $self, $pkgnum ) = @_;
7819 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
7820 sort { $a->_date <=> $b->_date }
7821 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
7822 'pkgnum' => $pkgnum,
7829 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
7835 map { $_ } #return $self->num_cust_pay_void unless wantarray;
7836 sort { $a->_date <=> $b->_date }
7837 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
7840 =item cust_pay_batch
7842 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
7846 sub cust_pay_batch {
7848 map { $_ } #return $self->num_cust_pay_batch unless wantarray;
7849 sort { $a->paybatchnum <=> $b->paybatchnum }
7850 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
7853 =item cust_pay_pending
7855 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
7856 (without status "done").
7860 sub cust_pay_pending {
7862 return $self->num_cust_pay_pending unless wantarray;
7863 sort { $a->_date <=> $b->_date }
7864 qsearch( 'cust_pay_pending', {
7865 'custnum' => $self->custnum,
7866 'status' => { op=>'!=', value=>'done' },
7871 =item num_cust_pay_pending
7873 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
7874 customer (without status "done"). Also called automatically when the
7875 cust_pay_pending method is used in a scalar context.
7879 sub num_cust_pay_pending {
7881 my $sql = " SELECT COUNT(*) FROM cust_pay_pending ".
7882 " WHERE custnum = ? AND status != 'done' ";
7883 my $sth = dbh->prepare($sql) or die dbh->errstr;
7884 $sth->execute($self->custnum) or die $sth->errstr;
7885 $sth->fetchrow_arrayref->[0];
7890 Returns all the refunds (see L<FS::cust_refund>) for this customer.
7896 map { $_ } #return $self->num_cust_refund unless wantarray;
7897 sort { $a->_date <=> $b->_date }
7898 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
7901 =item display_custnum
7903 Returns the displayed customer number for this customer: agent_custid if
7904 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
7908 sub display_custnum {
7910 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
7911 return $self->agent_custid;
7913 return $self->custnum;
7919 Returns a name string for this customer, either "Company (Last, First)" or
7926 my $name = $self->contact;
7927 $name = $self->company. " ($name)" if $self->company;
7933 Returns a name string for this (service/shipping) contact, either
7934 "Company (Last, First)" or "Last, First".
7940 if ( $self->get('ship_last') ) {
7941 my $name = $self->ship_contact;
7942 $name = $self->ship_company. " ($name)" if $self->ship_company;
7951 Returns a name string for this customer, either "Company" or "First Last".
7957 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
7960 =item ship_name_short
7962 Returns a name string for this (service/shipping) contact, either "Company"
7967 sub ship_name_short {
7969 if ( $self->get('ship_last') ) {
7970 $self->ship_company !~ /^\s*$/
7971 ? $self->ship_company
7972 : $self->ship_contact_firstlast;
7974 $self->name_company_or_firstlast;
7980 Returns this customer's full (billing) contact name only, "Last, First"
7986 $self->get('last'). ', '. $self->first;
7991 Returns this customer's full (shipping) contact name only, "Last, First"
7997 $self->get('ship_last')
7998 ? $self->get('ship_last'). ', '. $self->ship_first
8002 =item contact_firstlast
8004 Returns this customers full (billing) contact name only, "First Last".
8008 sub contact_firstlast {
8010 $self->first. ' '. $self->get('last');
8013 =item ship_contact_firstlast
8015 Returns this customer's full (shipping) contact name only, "First Last".
8019 sub ship_contact_firstlast {
8021 $self->get('ship_last')
8022 ? $self->first. ' '. $self->get('ship_last')
8023 : $self->contact_firstlast;
8028 Returns this customer's full country name
8034 code2country($self->country);
8037 =item geocode DATA_VENDOR
8039 Returns a value for the customer location as encoded by DATA_VENDOR.
8040 Currently this only makes sense for "CCH" as DATA_VENDOR.
8045 my ($self, $data_vendor) = (shift, shift); #always cch for now
8047 my $geocode = $self->get('geocode'); #XXX only one data_vendor for geocode
8048 return $geocode if $geocode;
8050 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
8054 my($zip,$plus4) = split /-/, $self->get("${prefix}zip")
8055 if $self->country eq 'US';
8059 #CCH specific location stuff
8060 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
8062 my @cust_tax_location =
8064 'table' => 'cust_tax_location',
8065 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
8066 'extra_sql' => $extra_sql,
8067 'order_by' => 'ORDER BY plus4hi',#overlapping with distinct ends
8070 $geocode = $cust_tax_location[0]->geocode
8071 if scalar(@cust_tax_location);
8080 Returns a status string for this customer, currently:
8084 =item prospect - No packages have ever been ordered
8086 =item active - One or more recurring packages is active
8088 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
8090 =item suspended - All non-cancelled recurring packages are suspended
8092 =item cancelled - All recurring packages are cancelled
8098 sub status { shift->cust_status(@_); }
8102 for my $status (qw( prospect active inactive suspended cancelled )) {
8103 my $method = $status.'_sql';
8104 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
8105 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
8106 $sth->execute( ($self->custnum) x $numnum )
8107 or die "Error executing 'SELECT $sql': ". $sth->errstr;
8108 return $status if $sth->fetchrow_arrayref->[0];
8112 =item ucfirst_cust_status
8114 =item ucfirst_status
8116 Returns the status with the first character capitalized.
8120 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
8122 sub ucfirst_cust_status {
8124 ucfirst($self->cust_status);
8129 Returns a hex triplet color string for this customer's status.
8133 use vars qw(%statuscolor);
8134 tie %statuscolor, 'Tie::IxHash',
8135 'prospect' => '7e0079', #'000000', #black? naw, purple
8136 'active' => '00CC00', #green
8137 'inactive' => '0000CC', #blue
8138 'suspended' => 'FF9900', #yellow
8139 'cancelled' => 'FF0000', #red
8142 sub statuscolor { shift->cust_statuscolor(@_); }
8144 sub cust_statuscolor {
8146 $statuscolor{$self->cust_status};
8151 Returns an array of hashes representing the customer's RT tickets.
8158 my $num = $conf->config('cust_main-max_tickets') || 10;
8161 if ( $conf->config('ticket_system') ) {
8162 unless ( $conf->config('ticket_system-custom_priority_field') ) {
8164 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
8168 foreach my $priority (
8169 $conf->config('ticket_system-custom_priority_field-values'), ''
8171 last if scalar(@tickets) >= $num;
8173 @{ FS::TicketSystem->customer_tickets( $self->custnum,
8174 $num - scalar(@tickets),
8184 # Return services representing svc_accts in customer support packages
8185 sub support_services {
8187 my %packages = map { $_ => 1 } $conf->config('support_packages');
8189 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
8190 grep { $_->part_svc->svcdb eq 'svc_acct' }
8191 map { $_->cust_svc }
8192 grep { exists $packages{ $_->pkgpart } }
8193 $self->ncancelled_pkgs;
8197 # Return a list of latitude/longitude for one of the services (if any)
8198 sub service_coordinates {
8202 grep { $_->latitude && $_->longitude }
8204 map { $_->cust_svc }
8205 $self->ncancelled_pkgs;
8207 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
8212 =head1 CLASS METHODS
8218 Class method that returns the list of possible status strings for customers
8219 (see L<the status method|/status>). For example:
8221 @statuses = FS::cust_main->statuses();
8226 #my $self = shift; #could be class...
8232 Returns an SQL expression identifying prospective cust_main records (customers
8233 with no packages ever ordered)
8237 use vars qw($select_count_pkgs);
8238 $select_count_pkgs =
8239 "SELECT COUNT(*) FROM cust_pkg
8240 WHERE cust_pkg.custnum = cust_main.custnum";
8242 sub select_count_pkgs_sql {
8246 sub prospect_sql { "
8247 0 = ( $select_count_pkgs )
8252 Returns an SQL expression identifying active cust_main records (customers with
8253 active recurring packages).
8258 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
8264 Returns an SQL expression identifying inactive cust_main records (customers with
8265 no active recurring packages, but otherwise unsuspended/uncancelled).
8269 sub inactive_sql { "
8270 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
8272 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
8278 Returns an SQL expression identifying suspended cust_main records.
8283 sub suspended_sql { susp_sql(@_); }
8285 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
8287 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
8293 Returns an SQL expression identifying cancelled cust_main records.
8297 sub cancelled_sql { cancel_sql(@_); }
8300 my $recurring_sql = FS::cust_pkg->recurring_sql;
8301 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
8304 0 < ( $select_count_pkgs )
8305 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
8306 AND 0 = ( $select_count_pkgs AND $recurring_sql
8307 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
8309 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
8315 =item uncancelled_sql
8317 Returns an SQL expression identifying un-cancelled cust_main records.
8321 sub uncancelled_sql { uncancel_sql(@_); }
8322 sub uncancel_sql { "
8324 ( 0 < ( $select_count_pkgs
8325 AND ( cust_pkg.cancel IS NULL
8326 OR cust_pkg.cancel = 0
8329 OR 0 = ( $select_count_pkgs )
8335 Returns an SQL fragment to retreive the balance.
8340 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
8341 WHERE cust_bill.custnum = cust_main.custnum )
8342 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
8343 WHERE cust_pay.custnum = cust_main.custnum )
8344 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
8345 WHERE cust_credit.custnum = cust_main.custnum )
8346 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
8347 WHERE cust_refund.custnum = cust_main.custnum )
8350 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8352 Returns an SQL fragment to retreive the balance for this customer, only
8353 considering invoices with date earlier than START_TIME, and optionally not
8354 later than END_TIME (total_owed_date minus total_unapplied_credits minus
8355 total_unapplied_payments).
8357 Times are specified as SQL fragments or numeric
8358 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
8359 L<Date::Parse> for conversion functions. The empty string can be passed
8360 to disable that time constraint completely.
8362 Available options are:
8366 =item unapplied_date
8368 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)
8373 set to true to remove all customer comparison clauses, for totals
8378 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
8383 JOIN clause (typically used with the total option)
8389 sub balance_date_sql {
8390 my( $class, $start, $end, %opt ) = @_;
8392 my $cutoff = $opt{'cutoff'};
8394 my $owed = FS::cust_bill->owed_sql($cutoff);
8395 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
8396 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
8397 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
8399 my $j = $opt{'join'} || '';
8401 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
8402 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
8403 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
8404 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
8406 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
8407 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
8408 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
8409 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
8414 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
8416 Returns an SQL fragment to retreive the total unapplied payments for this
8417 customer, only considering invoices with date earlier than START_TIME, and
8418 optionally not later than END_TIME.
8420 Times are specified as SQL fragments or numeric
8421 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
8422 L<Date::Parse> for conversion functions. The empty string can be passed
8423 to disable that time constraint completely.
8425 Available options are:
8429 sub unapplied_payments_date_sql {
8430 my( $class, $start, $end, %opt ) = @_;
8432 my $cutoff = $opt{'cutoff'};
8434 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
8436 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
8437 'unapplied_date'=>1 );
8439 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
8442 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8444 Helper method for balance_date_sql; name (and usage) subject to change
8445 (suggestions welcome).
8447 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
8448 cust_refund, cust_credit or cust_pay).
8450 If TABLE is "cust_bill" or the unapplied_date option is true, only
8451 considers records with date earlier than START_TIME, and optionally not
8452 later than END_TIME .
8456 sub _money_table_where {
8457 my( $class, $table, $start, $end, %opt ) = @_;
8460 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
8461 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
8462 push @where, "$table._date <= $start" if defined($start) && length($start);
8463 push @where, "$table._date > $end" if defined($end) && length($end);
8465 push @where, @{$opt{'where'}} if $opt{'where'};
8466 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
8472 =item search HASHREF
8476 Returns a qsearch hash expression to search for parameters specified in
8477 HASHREF. Valid parameters are
8485 =item cancelled_pkgs
8491 listref of start date, end date
8501 =item current_balance
8503 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
8507 =item flattened_pkgs
8516 my ($class, $params) = @_;
8527 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
8529 "cust_main.agentnum = $1";
8536 #prospect active inactive suspended cancelled
8537 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
8538 my $method = $params->{'status'}. '_sql';
8539 #push @where, $class->$method();
8540 push @where, FS::cust_main->$method();
8544 # parse cancelled package checkbox
8549 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
8550 unless $params->{'cancelled_pkgs'};
8553 # parse without census tract checkbox
8556 push @where, "(censustract = '' or censustract is null)"
8557 if $params->{'no_censustract'};
8563 foreach my $field (qw( signupdate )) {
8565 next unless exists($params->{$field});
8567 my($beginning, $ending) = @{$params->{$field}};
8570 "cust_main.$field IS NOT NULL",
8571 "cust_main.$field >= $beginning",
8572 "cust_main.$field <= $ending";
8574 $orderby ||= "ORDER BY cust_main.$field";
8582 if ( $params->{'payby'} ) {
8584 my @payby = ref( $params->{'payby'} )
8585 ? @{ $params->{'payby'} }
8586 : ( $params->{'payby'} );
8588 @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
8590 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )'
8595 my @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
8597 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )';
8601 # paydate_year / paydate_month
8604 if ( $params->{'paydate_year'} =~ /^(\d{4})$/ ) {
8606 $params->{'paydate_month'} =~ /^(\d\d?)$/
8607 or die "paydate_year without paydate_month?";
8611 'paydate IS NOT NULL',
8613 "CAST(paydate AS timestamp) < CAST('$year-$month-01' AS timestamp )"
8621 if ( $params->{'invoice_terms'} =~ /^([\w ]+)$/ ) {
8623 if ( $1 eq 'NULL' ) {
8625 "( cust_main.invoice_terms IS NULL OR cust_main.invoice_terms = '' )";
8628 "cust_main.invoice_terms IS NOT NULL",
8629 "cust_main.invoice_terms = '$1'";
8637 if ( $params->{'current_balance'} ) {
8639 #my $balance_sql = $class->balance_sql();
8640 my $balance_sql = FS::cust_main->balance_sql();
8642 my @current_balance =
8643 ref( $params->{'current_balance'} )
8644 ? @{ $params->{'current_balance'} }
8645 : ( $params->{'current_balance'} );
8647 push @where, map { s/current_balance/$balance_sql/; $_ }
8656 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
8658 "cust_main.custbatch = '$1'";
8662 # setup queries, subs, etc. for the search
8665 $orderby ||= 'ORDER BY custnum';
8667 # here is the agent virtualization
8668 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
8670 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
8672 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
8674 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
8676 my $select = join(', ',
8677 'cust_main.custnum',
8678 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
8681 my(@extra_headers) = ();
8682 my(@extra_fields) = ();
8684 if ($params->{'flattened_pkgs'}) {
8686 if ($dbh->{Driver}->{Name} eq 'Pg') {
8688 $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";
8690 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
8691 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
8692 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
8694 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
8695 "omitting packing information from report.";
8698 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";
8700 my $sth = dbh->prepare($header_query) or die dbh->errstr;
8701 $sth->execute() or die $sth->errstr;
8702 my $headerrow = $sth->fetchrow_arrayref;
8703 my $headercount = $headerrow ? $headerrow->[0] : 0;
8704 while($headercount) {
8705 unshift @extra_headers, "Package ". $headercount;
8706 unshift @extra_fields, eval q!sub {my $c = shift;
8707 my @a = split '\|', $c->magic;
8708 my $p = $a[!.--$headercount. q!];
8716 'table' => 'cust_main',
8717 'select' => $select,
8719 'extra_sql' => $extra_sql,
8720 'order_by' => $orderby,
8721 'count_query' => $count_query,
8722 'extra_headers' => \@extra_headers,
8723 'extra_fields' => \@extra_fields,
8728 =item email_search_result HASHREF
8732 Emails a notice to the specified customers.
8734 Valid parameters are those of the L<search> method, plus the following:
8756 Optional job queue job for status updates.
8760 Returns an error message, or false for success.
8762 If an error occurs during any email, stops the enture send and returns that
8763 error. Presumably if you're getting SMTP errors aborting is better than
8764 retrying everything.
8768 sub email_search_result {
8769 my($class, $params) = @_;
8771 my $from = delete $params->{from};
8772 my $subject = delete $params->{subject};
8773 my $html_body = delete $params->{html_body};
8774 my $text_body = delete $params->{text_body};
8776 my $job = delete $params->{'job'};
8778 $params->{'payby'} = [ split(/\0/, $params->{'payby'}) ]
8779 unless ref($params->{'payby'});
8781 my $sql_query = $class->search($params);
8783 my $count_query = delete($sql_query->{'count_query'});
8784 my $count_sth = dbh->prepare($count_query)
8785 or die "Error preparing $count_query: ". dbh->errstr;
8787 or die "Error executing $count_query: ". $count_sth->errstr;
8788 my $count_arrayref = $count_sth->fetchrow_arrayref;
8789 my $num_cust = $count_arrayref->[0];
8791 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
8792 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
8795 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
8797 #eventually order+limit magic to reduce memory use?
8798 foreach my $cust_main ( qsearch($sql_query) ) {
8800 my $to = $cust_main->invoicing_list_emailonly_scalar;
8803 my $error = send_email(
8807 'subject' => $subject,
8808 'html_body' => $html_body,
8809 'text_body' => $text_body,
8812 return $error if $error;
8814 if ( $job ) { #progressbar foo
8816 if ( time - $min_sec > $last ) {
8817 my $error = $job->update_statustext(
8818 int( 100 * $num / $num_cust )
8820 die $error if $error;
8830 use Storable qw(thaw);
8833 sub process_email_search_result {
8835 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
8837 my $param = thaw(decode_base64(shift));
8838 warn Dumper($param) if $DEBUG;
8840 $param->{'job'} = $job;
8842 $param->{'payby'} = [ split(/\0/, $param->{'payby'}) ]
8843 unless ref($param->{'payby'});
8845 my $error = FS::cust_main->email_search_result( $param );
8846 die $error if $error;
8850 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
8852 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
8853 records. Currently, I<first>, I<last>, I<company> and/or I<address1> may be
8854 specified (the appropriate ship_ field is also searched).
8856 Additional options are the same as FS::Record::qsearch
8861 my( $self, $fuzzy, $hash, @opt) = @_;
8866 check_and_rebuild_fuzzyfiles();
8867 foreach my $field ( keys %$fuzzy ) {
8869 my $all = $self->all_X($field);
8870 next unless scalar(@$all);
8873 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
8876 foreach ( keys %match ) {
8877 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
8878 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
8881 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
8884 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
8886 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
8894 Returns a masked version of the named field
8899 my ($self,$field) = @_;
8903 'x'x(length($self->getfield($field))-4).
8904 substr($self->getfield($field), (length($self->getfield($field))-4));
8914 =item smart_search OPTION => VALUE ...
8916 Accepts the following options: I<search>, the string to search for. The string
8917 will be searched for as a customer number, phone number, name or company name,
8918 as an exact, or, in some cases, a substring or fuzzy match (see the source code
8919 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
8920 skip fuzzy matching when an exact match is found.
8922 Any additional options are treated as an additional qualifier on the search
8925 Returns a (possibly empty) array of FS::cust_main objects.
8932 #here is the agent virtualization
8933 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8937 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
8938 my $search = delete $options{'search'};
8939 ( my $alphanum_search = $search ) =~ s/\W//g;
8941 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
8943 #false laziness w/Record::ut_phone
8944 my $phonen = "$1-$2-$3";
8945 $phonen .= " x$4" if $4;
8947 push @cust_main, qsearch( {
8948 'table' => 'cust_main',
8949 'hashref' => { %options },
8950 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8952 join(' OR ', map "$_ = '$phonen'",
8953 qw( daytime night fax
8954 ship_daytime ship_night ship_fax )
8957 " AND $agentnums_sql", #agent virtualization
8960 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
8961 #try looking for matches with extensions unless one was specified
8963 push @cust_main, qsearch( {
8964 'table' => 'cust_main',
8965 'hashref' => { %options },
8966 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8968 join(' OR ', map "$_ LIKE '$phonen\%'",
8970 ship_daytime ship_night )
8973 " AND $agentnums_sql", #agent virtualization
8978 # custnum search (also try agent_custid), with some tweaking options if your
8979 # legacy cust "numbers" have letters
8982 if ( $search =~ /^\s*(\d+)\s*$/
8983 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
8984 && $search =~ /^\s*(\w\w?\d+)\s*$/
8986 || ( $conf->exists('address1-search' )
8987 && $search =~ /^\s*(\d+\-?\w*)\s*$/ #i.e. 1234A or 9432-D
8994 if ( $num =~ /^(\d+)$/ && $num <= 2147483647 ) { #need a bigint custnum? wow
8995 push @cust_main, qsearch( {
8996 'table' => 'cust_main',
8997 'hashref' => { 'custnum' => $num, %options },
8998 'extra_sql' => " AND $agentnums_sql", #agent virtualization
9002 push @cust_main, qsearch( {
9003 'table' => 'cust_main',
9004 'hashref' => { 'agent_custid' => $num, %options },
9005 'extra_sql' => " AND $agentnums_sql", #agent virtualization
9008 if ( $conf->exists('address1-search') ) {
9009 my $len = length($num);
9011 foreach my $prefix ( '', 'ship_' ) {
9012 push @cust_main, qsearch( {
9013 'table' => 'cust_main',
9014 'hashref' => { %options, },
9016 ( keys(%options) ? ' AND ' : ' WHERE ' ).
9017 " LOWER(SUBSTRING(${prefix}address1 FROM 1 FOR $len)) = '$num' ".
9018 " AND $agentnums_sql",
9023 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
9025 my($company, $last, $first) = ( $1, $2, $3 );
9027 # "Company (Last, First)"
9028 #this is probably something a browser remembered,
9029 #so just do an exact search (but case-insensitive, so USPS standardization
9030 #doesn't throw a wrench in the works)
9032 foreach my $prefix ( '', 'ship_' ) {
9033 push @cust_main, qsearch( {
9034 'table' => 'cust_main',
9035 'hashref' => { %options },
9037 ( keys(%options) ? ' AND ' : ' WHERE ' ).
9039 " LOWER(${prefix}first) = ". dbh->quote(lc($first)),
9040 " LOWER(${prefix}last) = ". dbh->quote(lc($last)),
9041 " LOWER(${prefix}company) = ". dbh->quote(lc($company)),
9047 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
9048 # try (ship_){last,company}
9052 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
9053 # # full strings the browser remembers won't work
9054 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
9056 use Lingua::EN::NameParse;
9057 my $NameParse = new Lingua::EN::NameParse(
9059 allow_reversed => 1,
9062 my($last, $first) = ( '', '' );
9063 #maybe disable this too and just rely on NameParse?
9064 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
9066 ($last, $first) = ( $1, $2 );
9068 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
9069 } elsif ( ! $NameParse->parse($value) ) {
9071 my %name = $NameParse->components;
9072 $first = $name{'given_name_1'};
9073 $last = $name{'surname_1'};
9077 if ( $first && $last ) {
9079 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
9082 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
9084 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
9085 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
9088 push @cust_main, qsearch( {
9089 'table' => 'cust_main',
9090 'hashref' => \%options,
9091 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
9094 # or it just be something that was typed in... (try that in a sec)
9098 my $q_value = dbh->quote($value);
9101 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
9102 $sql .= " ( LOWER(last) = $q_value
9103 OR LOWER(company) = $q_value
9104 OR LOWER(ship_last) = $q_value
9105 OR LOWER(ship_company) = $q_value
9107 $sql .= " OR LOWER(address1) = $q_value
9108 OR LOWER(ship_address1) = $q_value
9110 if $conf->exists('address1-search');
9113 push @cust_main, qsearch( {
9114 'table' => 'cust_main',
9115 'hashref' => \%options,
9116 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
9119 #no exact match, trying substring/fuzzy
9120 #always do substring & fuzzy (unless they're explicity config'ed off)
9121 #getting complaints searches are not returning enough
9122 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
9124 #still some false laziness w/search (was search/cust_main.cgi)
9129 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
9130 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
9133 if ( $first && $last ) {
9136 { 'first' => { op=>'ILIKE', value=>"%$first%" },
9137 'last' => { op=>'ILIKE', value=>"%$last%" },
9139 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
9140 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
9147 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
9148 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
9152 if ( $conf->exists('address1-search') ) {
9154 { 'address1' => { op=>'ILIKE', value=>"%$value%" }, },
9155 { 'ship_address1' => { op=>'ILIKE', value=>"%$value%" }, },
9159 foreach my $hashref ( @hashrefs ) {
9161 push @cust_main, qsearch( {
9162 'table' => 'cust_main',
9163 'hashref' => { %$hashref,
9166 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
9175 " AND $agentnums_sql", #extra_sql #agent virtualization
9178 if ( $first && $last ) {
9179 push @cust_main, FS::cust_main->fuzzy_search(
9180 { 'last' => $last, #fuzzy hashref
9181 'first' => $first }, #
9185 foreach my $field ( 'last', 'company' ) {
9187 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
9189 if ( $conf->exists('address1-search') ) {
9191 FS::cust_main->fuzzy_search( { 'address1' => $value }, @fuzopts );
9198 #eliminate duplicates
9200 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
9208 Accepts the following options: I<email>, the email address to search for. The
9209 email address will be searched for as an email invoice destination and as an
9212 #Any additional options are treated as an additional qualifier on the search
9213 #(i.e. I<agentnum>).
9215 Returns a (possibly empty) array of FS::cust_main objects (but usually just
9225 my $email = delete $options{'email'};
9227 #we're only being used by RT at the moment... no agent virtualization yet
9228 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
9232 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
9234 my ( $user, $domain ) = ( $1, $2 );
9236 warn "$me smart_search: searching for $user in domain $domain"
9242 'table' => 'cust_main_invoice',
9243 'hashref' => { 'dest' => $email },
9250 map $_->cust_svc->cust_pkg,
9252 'table' => 'svc_acct',
9253 'hashref' => { 'username' => $user, },
9255 'AND ( SELECT domain FROM svc_domain
9256 WHERE svc_acct.domsvc = svc_domain.svcnum
9257 ) = '. dbh->quote($domain),
9263 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
9265 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
9272 =item check_and_rebuild_fuzzyfiles
9276 sub check_and_rebuild_fuzzyfiles {
9277 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9278 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
9281 =item rebuild_fuzzyfiles
9285 sub rebuild_fuzzyfiles {
9287 use Fcntl qw(:flock);
9289 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9290 mkdir $dir, 0700 unless -d $dir;
9292 foreach my $fuzzy ( @fuzzyfields ) {
9294 open(LOCK,">>$dir/cust_main.$fuzzy")
9295 or die "can't open $dir/cust_main.$fuzzy: $!";
9297 or die "can't lock $dir/cust_main.$fuzzy: $!";
9299 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
9300 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
9302 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
9303 my $sth = dbh->prepare("SELECT $field FROM cust_main".
9304 " WHERE $field != '' AND $field IS NOT NULL");
9305 $sth->execute or die $sth->errstr;
9307 while ( my $row = $sth->fetchrow_arrayref ) {
9308 print CACHE $row->[0]. "\n";
9313 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
9315 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
9326 my( $self, $field ) = @_;
9327 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9328 open(CACHE,"<$dir/cust_main.$field")
9329 or die "can't open $dir/cust_main.$field: $!";
9330 my @array = map { chomp; $_; } <CACHE>;
9335 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
9339 sub append_fuzzyfiles {
9340 #my( $first, $last, $company ) = @_;
9342 &check_and_rebuild_fuzzyfiles;
9344 use Fcntl qw(:flock);
9346 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9348 foreach my $field (@fuzzyfields) {
9353 open(CACHE,">>$dir/cust_main.$field")
9354 or die "can't open $dir/cust_main.$field: $!";
9355 flock(CACHE,LOCK_EX)
9356 or die "can't lock $dir/cust_main.$field: $!";
9358 print CACHE "$value\n";
9360 flock(CACHE,LOCK_UN)
9361 or die "can't unlock $dir/cust_main.$field: $!";
9376 #warn join('-',keys %$param);
9377 my $fh = $param->{filehandle};
9378 my @fields = @{$param->{fields}};
9380 eval "use Text::CSV_XS;";
9383 my $csv = new Text::CSV_XS;
9390 local $SIG{HUP} = 'IGNORE';
9391 local $SIG{INT} = 'IGNORE';
9392 local $SIG{QUIT} = 'IGNORE';
9393 local $SIG{TERM} = 'IGNORE';
9394 local $SIG{TSTP} = 'IGNORE';
9395 local $SIG{PIPE} = 'IGNORE';
9397 my $oldAutoCommit = $FS::UID::AutoCommit;
9398 local $FS::UID::AutoCommit = 0;
9401 #while ( $columns = $csv->getline($fh) ) {
9403 while ( defined($line=<$fh>) ) {
9405 $csv->parse($line) or do {
9406 $dbh->rollback if $oldAutoCommit;
9407 return "can't parse: ". $csv->error_input();
9410 my @columns = $csv->fields();
9411 #warn join('-',@columns);
9414 foreach my $field ( @fields ) {
9415 $row{$field} = shift @columns;
9418 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
9419 unless ( $cust_main ) {
9420 $dbh->rollback if $oldAutoCommit;
9421 return "unknown custnum $row{'custnum'}";
9424 if ( $row{'amount'} > 0 ) {
9425 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
9427 $dbh->rollback if $oldAutoCommit;
9431 } elsif ( $row{'amount'} < 0 ) {
9432 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
9435 $dbh->rollback if $oldAutoCommit;
9445 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
9447 return "Empty file!" unless $imported;
9453 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9455 Deprecated. Use event notification and message templates
9456 (L<FS::msg_template>) instead.
9458 Sends a templated email notification to the customer (see L<Text::Template>).
9460 OPTIONS is a hash and may include
9462 I<from> - the email sender (default is invoice_from)
9464 I<to> - comma-separated scalar or arrayref of recipients
9465 (default is invoicing_list)
9467 I<bcc> - blind-copy recipient address (default is none)
9469 I<subject> - The subject line of the sent email notification
9470 (default is "Notice from company_name")
9472 I<extra_fields> - a hashref of name/value pairs which will be substituted
9475 The following variables are vavailable in the template.
9477 I<$first> - the customer first name
9478 I<$last> - the customer last name
9479 I<$company> - the customer company
9480 I<$payby> - a description of the method of payment for the customer
9481 # would be nice to use FS::payby::shortname
9482 I<$payinfo> - the account information used to collect for this customer
9483 I<$expdate> - the expiration of the customer payment in seconds from epoch
9488 my ($self, $template, %options) = @_;
9490 return unless $conf->exists($template);
9492 my $from = $conf->config('invoice_from', $self->agentnum)
9493 if $conf->exists('invoice_from', $self->agentnum);
9494 $from = $options{from} if exists($options{from});
9496 my $to = join(',', $self->invoicing_list_emailonly);
9497 $to = $options{to} if exists($options{to});
9499 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
9500 if $conf->exists('company_name', $self->agentnum);
9501 $subject = $options{subject} if exists($options{subject});
9503 my $notify_template = new Text::Template (TYPE => 'ARRAY',
9504 SOURCE => [ map "$_\n",
9505 $conf->config($template)]
9507 or die "can't create new Text::Template object: Text::Template::ERROR";
9508 $notify_template->compile()
9509 or die "can't compile template: Text::Template::ERROR";
9511 $FS::notify_template::_template::company_name =
9512 $conf->config('company_name', $self->agentnum);
9513 $FS::notify_template::_template::company_address =
9514 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
9516 my $paydate = $self->paydate || '2037-12-31';
9517 $FS::notify_template::_template::first = $self->first;
9518 $FS::notify_template::_template::last = $self->last;
9519 $FS::notify_template::_template::company = $self->company;
9520 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
9521 my $payby = $self->payby;
9522 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9523 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9525 #credit cards expire at the end of the month/year of their exp date
9526 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9527 $FS::notify_template::_template::payby = 'credit card';
9528 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9529 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9531 }elsif ($payby eq 'COMP') {
9532 $FS::notify_template::_template::payby = 'complimentary account';
9534 $FS::notify_template::_template::payby = 'current method';
9536 $FS::notify_template::_template::expdate = $expire_time;
9538 for (keys %{$options{extra_fields}}){
9540 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
9543 send_email(from => $from,
9545 bcc => $options{bcc},
9546 subject => $subject,
9547 body => $notify_template->fill_in( PACKAGE =>
9548 'FS::notify_template::_template' ),
9553 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9555 Generates a templated notification to the customer (see L<Text::Template>).
9557 OPTIONS is a hash and may include
9559 I<extra_fields> - a hashref of name/value pairs which will be substituted
9560 into the template. These values may override values mentioned below
9561 and those from the customer record.
9563 The following variables are available in the template instead of or in addition
9564 to the fields of the customer record.
9566 I<$payby> - a description of the method of payment for the customer
9567 # would be nice to use FS::payby::shortname
9568 I<$payinfo> - the masked account information used to collect for this customer
9569 I<$expdate> - the expiration of the customer payment method in seconds from epoch
9570 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
9574 # a lot like cust_bill::print_latex
9575 sub generate_letter {
9576 my ($self, $template, %options) = @_;
9578 return unless $conf->exists($template);
9580 my $letter_template = new Text::Template
9582 SOURCE => [ map "$_\n", $conf->config($template)],
9583 DELIMITERS => [ '[@--', '--@]' ],
9585 or die "can't create new Text::Template object: Text::Template::ERROR";
9587 $letter_template->compile()
9588 or die "can't compile template: Text::Template::ERROR";
9590 my %letter_data = map { $_ => $self->$_ } $self->fields;
9591 $letter_data{payinfo} = $self->mask_payinfo;
9593 #my $paydate = $self->paydate || '2037-12-31';
9594 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
9596 my $payby = $self->payby;
9597 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9598 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9600 #credit cards expire at the end of the month/year of their exp date
9601 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9602 $letter_data{payby} = 'credit card';
9603 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9604 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9606 }elsif ($payby eq 'COMP') {
9607 $letter_data{payby} = 'complimentary account';
9609 $letter_data{payby} = 'current method';
9611 $letter_data{expdate} = $expire_time;
9613 for (keys %{$options{extra_fields}}){
9614 $letter_data{$_} = $options{extra_fields}->{$_};
9617 unless(exists($letter_data{returnaddress})){
9618 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
9619 $self->agent_template)
9621 if ( length($retadd) ) {
9622 $letter_data{returnaddress} = $retadd;
9623 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
9624 $letter_data{returnaddress} =
9625 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
9629 ( $conf->config('company_name', $self->agentnum),
9630 $conf->config('company_address', $self->agentnum),
9634 $letter_data{returnaddress} = '~';
9638 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
9640 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
9642 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
9644 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
9648 ) or die "can't open temp file: $!\n";
9649 print $lh $conf->config_binary('logo.eps', $self->agentnum)
9650 or die "can't write temp file: $!\n";
9652 $letter_data{'logo_file'} = $lh->filename;
9654 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
9658 ) or die "can't open temp file: $!\n";
9660 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
9662 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
9663 return ($1, $letter_data{'logo_file'});
9667 =item print_ps TEMPLATE
9669 Returns an postscript letter filled in from TEMPLATE, as a scalar.
9675 my($file, $lfile) = $self->generate_letter(@_);
9676 my $ps = FS::Misc::generate_ps($file);
9677 unlink($file.'.tex');
9683 =item print TEMPLATE
9685 Prints the filled in template.
9687 TEMPLATE is the name of a L<Text::Template> to fill in and print.
9691 sub queueable_print {
9694 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
9695 or die "invalid customer number: " . $opt{custvnum};
9697 my $error = $self->print( $opt{template} );
9698 die $error if $error;
9702 my ($self, $template) = (shift, shift);
9703 do_print [ $self->print_ps($template) ];
9706 #these three subs should just go away once agent stuff is all config overrides
9708 sub agent_template {
9710 $self->_agent_plandata('agent_templatename');
9713 sub agent_invoice_from {
9715 $self->_agent_plandata('agent_invoice_from');
9718 sub _agent_plandata {
9719 my( $self, $option ) = @_;
9721 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
9722 #agent-specific Conf
9724 use FS::part_event::Condition;
9726 my $agentnum = $self->agentnum;
9729 if ( driver_name =~ /^Pg/i ) {
9731 } elsif ( driver_name =~ /^mysql/i ) {
9734 die "don't know how to use regular expressions in ". driver_name. " databases";
9737 my $part_event_option =
9739 'select' => 'part_event_option.*',
9740 'table' => 'part_event_option',
9742 LEFT JOIN part_event USING ( eventpart )
9743 LEFT JOIN part_event_option AS peo_agentnum
9744 ON ( part_event.eventpart = peo_agentnum.eventpart
9745 AND peo_agentnum.optionname = 'agentnum'
9746 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
9748 LEFT JOIN part_event_condition
9749 ON ( part_event.eventpart = part_event_condition.eventpart
9750 AND part_event_condition.conditionname = 'cust_bill_age'
9752 LEFT JOIN part_event_condition_option
9753 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
9754 AND part_event_condition_option.optionname = 'age'
9757 #'hashref' => { 'optionname' => $option },
9758 #'hashref' => { 'part_event_option.optionname' => $option },
9760 " WHERE part_event_option.optionname = ". dbh->quote($option).
9761 " AND action = 'cust_bill_send_agent' ".
9762 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
9763 " AND peo_agentnum.optionname = 'agentnum' ".
9764 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
9766 CASE WHEN part_event_condition_option.optionname IS NULL
9768 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
9770 , part_event.weight".
9774 unless ( $part_event_option ) {
9775 return $self->agent->invoice_template || ''
9776 if $option eq 'agent_templatename';
9780 $part_event_option->optionvalue;
9784 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
9786 Subroutine (not a method), designed to be called from the queue.
9788 Takes a list of options and values.
9790 Pulls up the customer record via the custnum option and calls bill_and_collect.
9795 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
9797 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
9798 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
9800 $cust_main->bill_and_collect( %args );
9803 sub _upgrade_data { #class method
9804 my ($class, %opts) = @_;
9807 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
9808 'UPDATE cust_main SET signupdate = (SELECT signupdate FROM h_cust_main WHERE h_cust_main.custnum = cust_main.custnum ORDER BY historynum ASC LIMIT 1) WHERE signupdate IS NULL',
9810 my $sth = dbh->prepare($sql) or die dbh->errstr;
9811 $sth->execute or die $sth->errstr;
9822 The delete method should possibly take an FS::cust_main object reference
9823 instead of a scalar customer number.
9825 Bill and collect options should probably be passed as references instead of a
9828 There should probably be a configuration file with a list of allowed credit
9831 No multiple currency support (probably a larger project than just this module).
9833 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
9835 Birthdates rely on negative epoch values.
9837 The payby for card/check batches is broken. With mixed batching, bad
9840 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
9844 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
9845 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
9846 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.