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 alre
2808 # suffer from performance issues
2809 $options{has_hidden} = 0;
2810 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
2811 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
2813 foreach my $part_pkg ( @part_pkg ) {
2814 my %postal_options = %options;
2815 delete $postal_options{cancel};
2817 $self->_make_lines( 'part_pkg' => $part_pkg,
2818 'cust_pkg' => $postal_pkg,
2819 'precommit_hooks' => \@precommit_hooks,
2820 'line_items' => \@cust_bill_pkg,
2821 'setup' => \$total_setup,
2822 'recur' => \$total_recur,
2823 'tax_matrix' => \%taxlisthash,
2825 'real_pkgpart' => $real_pkgpart,
2826 'options' => \%postal_options,
2829 $dbh->rollback if $oldAutoCommit;
2834 # it's silly to have a zero value postal_pkg, but....
2835 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
2841 warn "having a look at the taxes we found...\n" if $DEBUG > 2;
2843 # keys are tax names (as printed on invoices / itemdesc )
2844 # values are listrefs of taxlisthash keys (internal identifiers)
2847 # keys are taxlisthash keys (internal identifiers)
2848 # values are (cumulative) amounts
2851 # keys are taxlisthash keys (internal identifiers)
2852 # values are listrefs of cust_bill_pkg_tax_location hashrefs
2853 my %tax_location = ();
2855 # keys are taxlisthash keys (internal identifiers)
2856 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
2857 my %tax_rate_location = ();
2859 foreach my $tax ( keys %taxlisthash ) {
2860 my $tax_object = shift @{ $taxlisthash{$tax} };
2861 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
2862 warn " ". join('/', @{ $taxlisthash{$tax} } ). "\n" if $DEBUG > 2;
2863 my $hashref_or_error =
2864 $tax_object->taxline( $taxlisthash{$tax},
2865 'custnum' => $self->custnum,
2866 'invoice_time' => $invoice_time
2868 unless ( ref($hashref_or_error) ) {
2869 $dbh->rollback if $oldAutoCommit;
2870 return $hashref_or_error;
2872 unshift @{ $taxlisthash{$tax} }, $tax_object;
2874 my $name = $hashref_or_error->{'name'};
2875 my $amount = $hashref_or_error->{'amount'};
2877 #warn "adding $amount as $name\n";
2878 $taxname{ $name } ||= [];
2879 push @{ $taxname{ $name } }, $tax;
2881 $tax{ $tax } += $amount;
2883 $tax_location{ $tax } ||= [];
2884 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
2885 push @{ $tax_location{ $tax } },
2887 'taxnum' => $tax_object->taxnum,
2888 'taxtype' => ref($tax_object),
2889 'pkgnum' => $tax_object->get('pkgnum'),
2890 'locationnum' => $tax_object->get('locationnum'),
2891 'amount' => sprintf('%.2f', $amount ),
2895 $tax_rate_location{ $tax } ||= [];
2896 if ( ref($tax_object) eq 'FS::tax_rate' ) {
2897 my $taxratelocationnum =
2898 $tax_object->tax_rate_location->taxratelocationnum;
2899 push @{ $tax_rate_location{ $tax } },
2901 'taxnum' => $tax_object->taxnum,
2902 'taxtype' => ref($tax_object),
2903 'amount' => sprintf('%.2f', $amount ),
2904 'locationtaxid' => $tax_object->location,
2905 'taxratelocationnum' => $taxratelocationnum,
2911 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
2912 my %packagemap = map { $_->pkgnum => $_ } @cust_bill_pkg;
2913 foreach my $tax ( keys %taxlisthash ) {
2914 foreach ( @{ $taxlisthash{$tax} }[1 ... scalar(@{ $taxlisthash{$tax} })] ) {
2915 next unless ref($_) eq 'FS::cust_bill_pkg';
2917 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
2918 splice( @{ $_->_cust_tax_exempt_pkg } );
2922 #consolidate and create tax line items
2923 warn "consolidating and generating...\n" if $DEBUG > 2;
2924 foreach my $taxname ( keys %taxname ) {
2927 my @cust_bill_pkg_tax_location = ();
2928 my @cust_bill_pkg_tax_rate_location = ();
2929 warn "adding $taxname\n" if $DEBUG > 1;
2930 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
2931 next if $seen{$taxitem}++;
2932 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
2933 $tax += $tax{$taxitem};
2934 push @cust_bill_pkg_tax_location,
2935 map { new FS::cust_bill_pkg_tax_location $_ }
2936 @{ $tax_location{ $taxitem } };
2937 push @cust_bill_pkg_tax_rate_location,
2938 map { new FS::cust_bill_pkg_tax_rate_location $_ }
2939 @{ $tax_rate_location{ $taxitem } };
2943 $tax = sprintf('%.2f', $tax );
2944 $total_setup = sprintf('%.2f', $total_setup+$tax );
2946 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
2952 if ( $pkg_category and
2953 $conf->config('invoice_latexsummary') ||
2954 $conf->config('invoice_htmlsummary')
2958 my %hash = ( 'section' => $pkg_category->categoryname );
2959 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
2963 push @cust_bill_pkg, new FS::cust_bill_pkg {
2969 'itemdesc' => $taxname,
2970 'display' => \@display,
2971 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2972 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
2977 #add tax adjustments
2978 warn "adding tax adjustments...\n" if $DEBUG > 2;
2979 foreach my $cust_tax_adjustment (
2980 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
2986 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
2987 $total_setup = sprintf('%.2f', $total_setup+$tax );
2989 my $itemdesc = $cust_tax_adjustment->taxname;
2990 $itemdesc = '' if $itemdesc eq 'Tax';
2992 push @cust_bill_pkg, new FS::cust_bill_pkg {
2998 'itemdesc' => $itemdesc,
2999 'itemcomment' => $cust_tax_adjustment->comment,
3000 'cust_tax_adjustment' => $cust_tax_adjustment,
3001 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
3006 my $charged = sprintf('%.2f', $total_setup + $total_recur );
3008 my @cust_bill = $self->cust_bill;
3009 my $balance = $self->balance;
3010 my $previous_balance = scalar(@cust_bill)
3011 ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
3014 $previous_balance += $cust_bill[$#cust_bill]->charged
3015 if scalar(@cust_bill);
3016 #my $balance_adjustments =
3017 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
3019 #create the new invoice
3020 my $cust_bill = new FS::cust_bill ( {
3021 'custnum' => $self->custnum,
3022 '_date' => ( $invoice_time ),
3023 'charged' => $charged,
3024 'billing_balance' => $balance,
3025 'previous_balance' => $previous_balance,
3026 'invoice_terms' => $options{'invoice_terms'},
3028 $error = $cust_bill->insert;
3030 $dbh->rollback if $oldAutoCommit;
3031 return "can't create invoice for customer #". $self->custnum. ": $error";
3034 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
3035 $cust_bill_pkg->invnum($cust_bill->invnum);
3036 my $error = $cust_bill_pkg->insert;
3038 $dbh->rollback if $oldAutoCommit;
3039 return "can't create invoice line item: $error";
3044 foreach my $hook ( @precommit_hooks ) {
3046 &{$hook}; #($self) ?
3049 $dbh->rollback if $oldAutoCommit;
3050 return "$@ running precommit hook $hook\n";
3054 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3058 #discard bundled packages of 0 value
3059 sub _omit_zero_value_bundles {
3061 my @cust_bill_pkg = ();
3062 my @cust_bill_pkg_bundle = ();
3065 foreach my $cust_bill_pkg ( @_ ) {
3066 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
3067 push @cust_bill_pkg, @cust_bill_pkg_bundle if $sum > 0;
3068 @cust_bill_pkg_bundle = ();
3071 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
3072 push @cust_bill_pkg_bundle, $cust_bill_pkg;
3074 push @cust_bill_pkg, @cust_bill_pkg_bundle if $sum > 0;
3081 my ($self, %params) = @_;
3083 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
3084 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
3085 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
3086 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
3087 my $total_setup = $params{setup} or die "no setup accumulator specified";
3088 my $total_recur = $params{recur} or die "no recur accumulator specified";
3089 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
3090 my $time = $params{'time'} or die "no time specified";
3091 my (%options) = %{$params{options}};
3094 my $real_pkgpart = $params{real_pkgpart};
3095 my %hash = $cust_pkg->hash;
3096 my $old_cust_pkg = new FS::cust_pkg \%hash;
3102 $cust_pkg->pkgpart($part_pkg->pkgpart);
3110 if ( $options{'resetup'}
3111 || ( ! $cust_pkg->setup
3112 && ( ! $cust_pkg->start_date
3113 || $cust_pkg->start_date <= $time
3115 && ( ! $conf->exists('disable_setup_suspended_pkgs')
3116 || ( $conf->exists('disable_setup_suspended_pkgs') &&
3117 ! $cust_pkg->getfield('susp')
3124 warn " bill setup\n" if $DEBUG > 1;
3127 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
3128 return "$@ running calc_setup for $cust_pkg\n"
3131 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
3133 $cust_pkg->setfield('setup', $time)
3134 unless $cust_pkg->setup;
3135 #do need it, but it won't get written to the db
3136 #|| $cust_pkg->pkgpart != $real_pkgpart;
3138 $cust_pkg->setfield('start_date', '')
3139 if $cust_pkg->start_date;
3144 # bill recurring fee
3147 #XXX unit stuff here too
3151 if ( ! $cust_pkg->get('susp')
3152 and ! $cust_pkg->get('start_date')
3153 and ( $part_pkg->getfield('freq') ne '0'
3154 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
3156 || ( $part_pkg->plan eq 'voip_cdr'
3157 && $part_pkg->option('bill_every_call')
3159 || ( $options{cancel} )
3162 # XXX should this be a package event? probably. events are called
3163 # at collection time at the moment, though...
3164 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
3165 if $part_pkg->can('reset_usage');
3166 #don't want to reset usage just cause we want a line item??
3167 #&& $part_pkg->pkgpart == $real_pkgpart;
3169 warn " bill recur\n" if $DEBUG > 1;
3172 # XXX shared with $recur_prog
3173 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
3177 #over two params! lets at least switch to a hashref for the rest...
3178 my $increment_next_bill = ( $part_pkg->freq ne '0'
3179 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
3180 && !$options{cancel}
3182 my %param = ( 'precommit_hooks' => $precommit_hooks,
3183 'increment_next_bill' => $increment_next_bill,
3186 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
3187 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
3188 return "$@ running $method for $cust_pkg\n"
3191 if ( $increment_next_bill ) {
3193 my $next_bill = $part_pkg->add_freq($sdate);
3194 return "unparsable frequency: ". $part_pkg->freq
3195 if $next_bill == -1;
3197 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
3198 # only for figuring next bill date, nothing else, so, reset $sdate again
3200 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
3201 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
3202 $cust_pkg->last_bill($sdate);
3204 $cust_pkg->setfield('bill', $next_bill );
3210 warn "\$setup is undefined" unless defined($setup);
3211 warn "\$recur is undefined" unless defined($recur);
3212 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
3215 # If there's line items, create em cust_bill_pkg records
3216 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
3219 if ( $lineitems || $options{has_hidden} ) {
3221 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
3222 # hmm.. and if just the options are modified in some weird price plan?
3224 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
3227 my $error = $cust_pkg->replace( $old_cust_pkg,
3228 'options' => { $cust_pkg->options },
3230 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
3231 if $error; #just in case
3234 $setup = sprintf( "%.2f", $setup );
3235 $recur = sprintf( "%.2f", $recur );
3236 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
3237 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
3239 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
3240 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
3245 !$part_pkg->hidden && $options{has_hidden} ) #include some $0 lines
3248 warn " charges (setup=$setup, recur=$recur); adding line items\n"
3251 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
3253 warn " adding customer package invoice detail: $_\n"
3254 foreach @cust_pkg_detail;
3256 push @details, @cust_pkg_detail;
3258 my $cust_bill_pkg = new FS::cust_bill_pkg {
3259 'pkgnum' => $cust_pkg->pkgnum,
3261 'unitsetup' => $unitsetup,
3263 'unitrecur' => $unitrecur,
3264 'quantity' => $cust_pkg->quantity,
3265 'details' => \@details,
3266 'hidden' => $part_pkg->hidden,
3269 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
3270 $cust_bill_pkg->sdate( $hash{last_bill} );
3271 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
3272 $cust_bill_pkg->edate( $time ) if $options{cancel};
3273 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
3274 $cust_bill_pkg->sdate( $sdate );
3275 $cust_bill_pkg->edate( $cust_pkg->bill );
3276 #$cust_bill_pkg->edate( $time ) if $options{cancel};
3279 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
3280 unless $part_pkg->pkgpart == $real_pkgpart;
3282 $$total_setup += $setup;
3283 $$total_recur += $recur;
3290 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
3291 return $error if $error;
3293 push @$cust_bill_pkgs, $cust_bill_pkg;
3295 } #if $setup != 0 || $recur != 0
3305 my $part_pkg = shift;
3306 my $taxlisthash = shift;
3307 my $cust_bill_pkg = shift;
3308 my $cust_pkg = shift;
3309 my $invoice_time = shift;
3310 my $real_pkgpart = shift;
3311 my $options = shift;
3313 my %cust_bill_pkg = ();
3317 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
3318 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
3319 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
3320 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
3322 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
3324 if ( $conf->exists('enable_taxproducts')
3325 && ( scalar($part_pkg->part_pkg_taxoverride)
3326 || $part_pkg->has_taxproduct
3331 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3332 return "fatal: Can't (yet) use tax-pkg_address with taxproducts";
3335 foreach my $class (@classes) {
3336 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class );
3337 return $err_or_ref unless ref($err_or_ref);
3338 $taxes{$class} = $err_or_ref;
3341 unless (exists $taxes{''}) {
3342 my $err_or_ref = $self->_gather_taxes( $part_pkg, '' );
3343 return $err_or_ref unless ref($err_or_ref);
3344 $taxes{''} = $err_or_ref;
3349 my @loc_keys = qw( state county country );
3351 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3352 my $cust_location = $cust_pkg->cust_location;
3353 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
3356 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
3359 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
3362 $taxhash{'taxclass'} = $part_pkg->taxclass;
3364 my @taxes = qsearch( 'cust_main_county', \%taxhash );
3366 my %taxhash_elim = %taxhash;
3368 my @elim = qw( taxclass county state );
3369 while ( !scalar(@taxes) && scalar(@elim) ) {
3370 $taxhash_elim{ shift(@elim) } = '';
3371 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
3374 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
3376 if $self->cust_main_exemption; #just to be safe
3378 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3380 $_->set('pkgnum', $cust_pkg->pkgnum );
3381 $_->set('locationnum', $cust_pkg->locationnum );
3385 $taxes{''} = [ @taxes ];
3386 $taxes{'setup'} = [ @taxes ];
3387 $taxes{'recur'} = [ @taxes ];
3388 $taxes{$_} = [ @taxes ] foreach (@classes);
3390 # # maybe eliminate this entirely, along with all the 0% records
3391 # unless ( @taxes ) {
3393 # "fatal: can't find tax rate for state/county/country/taxclass ".
3394 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
3397 } #if $conf->exists('enable_taxproducts') ...
3402 my $separate = $conf->exists('separate_usage');
3403 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
3404 my $usage_mandate = $temp_pkg->part_pkg->option('usage_mandate', 'Hush!');
3405 my $section = $temp_pkg->part_pkg->categoryname;
3406 if ( $separate || $section || $usage_mandate ) {
3408 my %hash = ( 'section' => $section );
3410 $section = $temp_pkg->part_pkg->option('usage_section', 'Hush!');
3411 my $summary = $temp_pkg->part_pkg->option('summarize_usage', 'Hush!');
3413 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3414 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
3416 push @display, new FS::cust_bill_pkg_display
3419 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
3423 if ($separate && $section && $summary) {
3424 push @display, new FS::cust_bill_pkg_display { type => 'U',
3429 if ($usage_mandate || $section && $summary) {
3430 $hash{post_total} = 'Y';
3433 if ($separate || $usage_mandate) {
3434 $hash{section} = $section if ($separate || $usage_mandate);
3435 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
3439 $cust_bill_pkg->set('display', \@display);
3441 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
3442 foreach my $key (keys %tax_cust_bill_pkg) {
3443 my @taxes = @{ $taxes{$key} || [] };
3444 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
3446 my %localtaxlisthash = ();
3447 foreach my $tax ( @taxes ) {
3449 my $taxname = ref( $tax ). ' '. $tax->taxnum;
3450 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
3451 # ' locationnum'. $cust_pkg->locationnum
3452 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
3454 $taxlisthash->{ $taxname } ||= [ $tax ];
3455 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
3457 $localtaxlisthash{ $taxname } ||= [ $tax ];
3458 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
3462 warn "finding taxed taxes...\n" if $DEBUG > 2;
3463 foreach my $tax ( keys %localtaxlisthash ) {
3464 my $tax_object = shift @{ $localtaxlisthash{$tax} };
3465 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
3467 next unless $tax_object->can('tax_on_tax');
3469 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
3470 my $totname = ref( $tot ). ' '. $tot->taxnum;
3472 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
3474 next unless exists( $localtaxlisthash{ $totname } ); # only increase
3476 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
3477 my $hashref_or_error =
3478 $tax_object->taxline( $localtaxlisthash{$tax},
3479 'custnum' => $self->custnum,
3480 'invoice_time' => $invoice_time,
3482 return $hashref_or_error
3483 unless ref($hashref_or_error);
3485 $taxlisthash->{ $totname } ||= [ $tot ];
3486 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
3498 my $part_pkg = shift;
3502 my $geocode = $self->geocode('cch');
3504 my @taxclassnums = map { $_->taxclassnum }
3505 $part_pkg->part_pkg_taxoverride($class);
3507 unless (@taxclassnums) {
3508 @taxclassnums = map { $_->taxclassnum }
3509 grep { $_->taxable eq 'Y' }
3510 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
3512 warn "Found taxclassnum values of ". join(',', @taxclassnums)
3517 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
3519 @taxes = qsearch({ 'table' => 'tax_rate',
3520 'hashref' => { 'geocode' => $geocode, },
3521 'extra_sql' => $extra_sql,
3523 if scalar(@taxclassnums);
3525 warn "Found taxes ".
3526 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
3533 =item collect [ HASHREF | OPTION => VALUE ... ]
3535 (Attempt to) collect money for this customer's outstanding invoices (see
3536 L<FS::cust_bill>). Usually used after the bill method.
3538 Actions are now triggered by billing events; see L<FS::part_event> and the
3539 billing events web interface. Old-style invoice events (see
3540 L<FS::part_bill_event>) have been deprecated.
3542 If there is an error, returns the error, otherwise returns false.
3544 Options are passed as name-value pairs.
3546 Currently available options are:
3552 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.
3556 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3560 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3564 set true to surpress email card/ACH decline notices.
3568 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)
3574 # allows for one time override of normal customer billing method
3579 my( $self, %options ) = @_;
3580 my $invoice_time = $options{'invoice_time'} || time;
3583 local $SIG{HUP} = 'IGNORE';
3584 local $SIG{INT} = 'IGNORE';
3585 local $SIG{QUIT} = 'IGNORE';
3586 local $SIG{TERM} = 'IGNORE';
3587 local $SIG{TSTP} = 'IGNORE';
3588 local $SIG{PIPE} = 'IGNORE';
3590 my $oldAutoCommit = $FS::UID::AutoCommit;
3591 local $FS::UID::AutoCommit = 0;
3594 $self->select_for_update; #mutex
3597 my $balance = $self->balance;
3598 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
3601 if ( exists($options{'retry_card'}) ) {
3602 carp 'retry_card option passed to collect is deprecated; use retry';
3603 $options{'retry'} ||= $options{'retry_card'};
3605 if ( exists($options{'retry'}) && $options{'retry'} ) {
3606 my $error = $self->retry_realtime;
3608 $dbh->rollback if $oldAutoCommit;
3613 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3615 #never want to roll back an event just because it returned an error
3616 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
3618 $self->do_cust_event(
3619 'debug' => ( $options{'debug'} || 0 ),
3620 'time' => $invoice_time,
3621 'check_freq' => $options{'check_freq'},
3622 'stage' => 'collect',
3627 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
3629 Runs billing events; see L<FS::part_event> and the billing events web
3632 If there is an error, returns the error, otherwise returns false.
3634 Options are passed as name-value pairs.
3636 Currently available options are:
3642 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.
3646 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3650 "collect" (the default) or "pre-bill"
3654 set true to surpress email card/ACH decline notices.
3658 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)
3664 # allows for one time override of normal customer billing method
3668 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3671 my( $self, %options ) = @_;
3672 my $time = $options{'time'} || time;
3675 local $SIG{HUP} = 'IGNORE';
3676 local $SIG{INT} = 'IGNORE';
3677 local $SIG{QUIT} = 'IGNORE';
3678 local $SIG{TERM} = 'IGNORE';
3679 local $SIG{TSTP} = 'IGNORE';
3680 local $SIG{PIPE} = 'IGNORE';
3682 my $oldAutoCommit = $FS::UID::AutoCommit;
3683 local $FS::UID::AutoCommit = 0;
3686 $self->select_for_update; #mutex
3689 my $balance = $self->balance;
3690 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
3693 # if ( exists($options{'retry_card'}) ) {
3694 # carp 'retry_card option passed to collect is deprecated; use retry';
3695 # $options{'retry'} ||= $options{'retry_card'};
3697 # if ( exists($options{'retry'}) && $options{'retry'} ) {
3698 # my $error = $self->retry_realtime;
3700 # $dbh->rollback if $oldAutoCommit;
3705 # false laziness w/pay_batch::import_results
3707 my $due_cust_event = $self->due_cust_event(
3708 'debug' => ( $options{'debug'} || 0 ),
3710 'check_freq' => $options{'check_freq'},
3711 'stage' => ( $options{'stage'} || 'collect' ),
3713 unless( ref($due_cust_event) ) {
3714 $dbh->rollback if $oldAutoCommit;
3715 return $due_cust_event;
3718 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3719 #never want to roll back an event just because it or a different one
3721 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
3723 foreach my $cust_event ( @$due_cust_event ) {
3727 #re-eval event conditions (a previous event could have changed things)
3728 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
3729 #don't leave stray "new/locked" records around
3730 my $error = $cust_event->delete;
3731 return $error if $error;
3736 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
3737 warn " running cust_event ". $cust_event->eventnum. "\n"
3740 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
3741 if ( my $error = $cust_event->do_event() ) {
3742 #XXX wtf is this? figure out a proper dealio with return value
3754 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
3756 Inserts database records for and returns an ordered listref of new events due
3757 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
3758 events are due, an empty listref is returned. If there is an error, returns a
3759 scalar error message.
3761 To actually run the events, call each event's test_condition method, and if
3762 still true, call the event's do_event method.
3764 Options are passed as a hashref or as a list of name-value pairs. Available
3771 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.
3775 "collect" (the default) or "pre-bill"
3779 "Current time" for the events.
3783 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)
3787 Only return events for the specified eventtable (by default, events of all eventtables are returned)
3791 Explicitly pass the objects to be tested (typically used with eventtable).
3795 Set to true to return the objects, but not actually insert them into the
3802 sub due_cust_event {
3804 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
3807 #my $DEBUG = $opt{'debug'}
3808 local($DEBUG) = $opt{'debug'}
3809 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
3811 warn "$me due_cust_event called with options ".
3812 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
3815 $opt{'time'} ||= time;
3817 local $SIG{HUP} = 'IGNORE';
3818 local $SIG{INT} = 'IGNORE';
3819 local $SIG{QUIT} = 'IGNORE';
3820 local $SIG{TERM} = 'IGNORE';
3821 local $SIG{TSTP} = 'IGNORE';
3822 local $SIG{PIPE} = 'IGNORE';
3824 my $oldAutoCommit = $FS::UID::AutoCommit;
3825 local $FS::UID::AutoCommit = 0;
3828 $self->select_for_update #mutex
3829 unless $opt{testonly};
3832 # find possible events (initial search)
3835 my @cust_event = ();
3837 my @eventtable = $opt{'eventtable'}
3838 ? ( $opt{'eventtable'} )
3839 : FS::part_event->eventtables_runorder;
3841 foreach my $eventtable ( @eventtable ) {
3844 if ( $opt{'objects'} ) {
3846 @objects = @{ $opt{'objects'} };
3850 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
3851 @objects = ( $eventtable eq 'cust_main' )
3853 : ( $self->$eventtable() );
3857 my @e_cust_event = ();
3859 my $cross = "CROSS JOIN $eventtable";
3860 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
3861 unless $eventtable eq 'cust_main';
3863 foreach my $object ( @objects ) {
3865 #this first search uses the condition_sql magic for optimization.
3866 #the more possible events we can eliminate in this step the better
3868 my $cross_where = '';
3869 my $pkey = $object->primary_key;
3870 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
3872 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
3874 FS::part_event_condition->where_conditions_sql( $eventtable,
3875 'time'=>$opt{'time'}
3877 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
3879 $extra_sql = "AND $extra_sql" if $extra_sql;
3881 #here is the agent virtualization
3882 $extra_sql .= " AND ( part_event.agentnum IS NULL
3883 OR part_event.agentnum = ". $self->agentnum. ' )';
3885 $extra_sql .= " $order";
3887 warn "searching for events for $eventtable ". $object->$pkey. "\n"
3888 if $opt{'debug'} > 2;
3889 my @part_event = qsearch( {
3890 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
3891 'select' => 'part_event.*',
3892 'table' => 'part_event',
3893 'addl_from' => "$cross $join",
3894 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
3895 'eventtable' => $eventtable,
3898 'extra_sql' => "AND $cross_where $extra_sql",
3902 my $pkey = $object->primary_key;
3903 warn " ". scalar(@part_event).
3904 " possible events found for $eventtable ". $object->$pkey(). "\n";
3907 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
3911 warn " ". scalar(@e_cust_event).
3912 " subtotal possible cust events found for $eventtable\n"
3915 push @cust_event, @e_cust_event;
3919 warn " ". scalar(@cust_event).
3920 " total possible cust events found in initial search\n"
3928 $opt{stage} ||= 'collect';
3930 grep { my $stage = $_->part_event->event_stage;
3931 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
3941 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
3942 'stats_hashref' => \%unsat ),
3945 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
3948 warn " invalid conditions not eliminated with condition_sql:\n".
3949 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
3950 if keys %unsat && $DEBUG; # > 1;
3956 unless( $opt{testonly} ) {
3957 foreach my $cust_event ( @cust_event ) {
3959 my $error = $cust_event->insert();
3961 $dbh->rollback if $oldAutoCommit;
3968 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3974 warn " returning events: ". Dumper(@cust_event). "\n"
3981 =item retry_realtime
3983 Schedules realtime / batch credit card / electronic check / LEC billing
3984 events for for retry. Useful if card information has changed or manual
3985 retry is desired. The 'collect' method must be called to actually retry
3988 Implementation details: For either this customer, or for each of this
3989 customer's open invoices, changes the status of the first "done" (with
3990 statustext error) realtime processing event to "failed".
3994 sub retry_realtime {
3997 local $SIG{HUP} = 'IGNORE';
3998 local $SIG{INT} = 'IGNORE';
3999 local $SIG{QUIT} = 'IGNORE';
4000 local $SIG{TERM} = 'IGNORE';
4001 local $SIG{TSTP} = 'IGNORE';
4002 local $SIG{PIPE} = 'IGNORE';
4004 my $oldAutoCommit = $FS::UID::AutoCommit;
4005 local $FS::UID::AutoCommit = 0;
4008 #a little false laziness w/due_cust_event (not too bad, really)
4010 my $join = FS::part_event_condition->join_conditions_sql;
4011 my $order = FS::part_event_condition->order_conditions_sql;
4014 . join ( ' OR ' , map {
4015 "( part_event.eventtable = " . dbh->quote($_)
4016 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
4017 } FS::part_event->eventtables)
4020 #here is the agent virtualization
4021 my $agent_virt = " ( part_event.agentnum IS NULL
4022 OR part_event.agentnum = ". $self->agentnum. ' )';
4024 #XXX this shouldn't be hardcoded, actions should declare it...
4025 my @realtime_events = qw(
4026 cust_bill_realtime_card
4027 cust_bill_realtime_check
4028 cust_bill_realtime_lec
4032 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
4037 my @cust_event = qsearchs({
4038 'table' => 'cust_event',
4039 'select' => 'cust_event.*',
4040 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
4041 'hashref' => { 'status' => 'done' },
4042 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
4043 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
4046 my %seen_invnum = ();
4047 foreach my $cust_event (@cust_event) {
4049 #max one for the customer, one for each open invoice
4050 my $cust_X = $cust_event->cust_X;
4051 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
4055 or $cust_event->part_event->eventtable eq 'cust_bill'
4058 my $error = $cust_event->retry;
4060 $dbh->rollback if $oldAutoCommit;
4061 return "error scheduling event for retry: $error";
4066 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4071 # some horrid false laziness here to avoid refactor fallout
4072 # eventually realtime realtime_bop and realtime_refund_bop should go
4073 # away and be replaced by _new_realtime_bop and _new_realtime_refund_bop
4075 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
4077 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4078 via a Business::OnlinePayment realtime gateway. See
4079 L<http://420.am/business-onlinepayment> for supported gateways.
4081 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4083 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
4085 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4086 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4087 if set, will override the value from the customer record.
4089 I<description> is a free-text field passed to the gateway. It defaults to
4090 the value defined by the business-onlinepayment-description configuration
4091 option, or "Internet services" if that is unset.
4093 If an I<invnum> is specified, this payment (if successful) is applied to the
4094 specified invoice. If you don't specify an I<invnum> you might want to
4095 call the B<apply_payments> method or set the I<apply> option.
4097 I<apply> can be set to true to apply a resulting payment.
4099 I<quiet> can be set true to surpress email decline notices.
4101 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4102 resulting paynum, if any.
4104 I<payunique> is a unique identifier for this payment.
4106 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
4113 return $self->_new_realtime_bop(@_)
4114 if $self->_new_bop_required();
4116 my($method, $amount);
4118 if (ref($_[0]) eq 'HASH') {
4119 %options = %{$_[0]};
4120 $method = $options{method};
4121 $amount = $options{amount};
4123 ( $method, $amount ) = ( shift, shift );
4127 warn "$me realtime_bop: $method $amount\n";
4128 warn " $_ => $options{$_}\n" foreach keys %options;
4131 return "Amount must be greater than 0" unless $amount > 0;
4133 unless ( $options{'description'} ) {
4134 if ( $conf->exists('business-onlinepayment-description') ) {
4135 my $dtempl = $conf->config('business-onlinepayment-description');
4137 my $agent = $self->agent->agent;
4139 $options{'description'} = eval qq("$dtempl");
4141 $options{'description'} = 'Internet services';
4145 return $self->fake_bop($method, $amount, %options) if $options{'fake'};
4147 eval "use Business::OnlinePayment";
4150 my $payinfo = exists($options{'payinfo'})
4151 ? $options{'payinfo'}
4154 my %method2payby = (
4161 # check for banned credit card/ACH
4164 my $ban = qsearchs('banned_pay', {
4165 'payby' => $method2payby{$method},
4166 'payinfo' => md5_base64($payinfo),
4168 return "Banned credit card" if $ban;
4171 # set taxclass and trans_is_recur based on invnum if there is one
4175 my $trans_is_recur = 0;
4176 if ( $options{'invnum'} ) {
4178 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
4179 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
4182 map { $_->part_pkg }
4184 map { $_->cust_pkg }
4185 $cust_bill->cust_bill_pkg;
4187 my @taxclasses = map $_->taxclass, @part_pkg;
4188 $taxclass = $taxclasses[0]
4189 unless grep { $taxclasses[0] ne $_ } @taxclasses; #unless there are
4190 #different taxclasses
4192 if grep { $_->freq ne '0' } @part_pkg;
4200 #look for an agent gateway override first
4202 if ( $method eq 'CC' ) {
4203 $cardtype = cardtype($payinfo);
4204 } elsif ( $method eq 'ECHECK' ) {
4207 $cardtype = $method;
4211 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4212 cardtype => $cardtype,
4213 taxclass => $taxclass, } )
4214 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4216 taxclass => $taxclass, } )
4217 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4218 cardtype => $cardtype,
4220 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4222 taxclass => '', } );
4224 my $payment_gateway = '';
4225 my( $processor, $login, $password, $action, @bop_options );
4226 if ( $override ) { #use a payment gateway override
4228 $payment_gateway = $override->payment_gateway;
4230 $processor = $payment_gateway->gateway_module;
4231 $login = $payment_gateway->gateway_username;
4232 $password = $payment_gateway->gateway_password;
4233 $action = $payment_gateway->gateway_action;
4234 @bop_options = $payment_gateway->options;
4236 } else { #use the standard settings from the config
4238 ( $processor, $login, $password, $action, @bop_options ) =
4239 $self->default_payment_gateway($method);
4247 my $address = exists($options{'address1'})
4248 ? $options{'address1'}
4250 my $address2 = exists($options{'address2'})
4251 ? $options{'address2'}
4253 $address .= ", ". $address2 if length($address2);
4255 my $o_payname = exists($options{'payname'})
4256 ? $options{'payname'}
4258 my($payname, $payfirst, $paylast);
4259 if ( $o_payname && $method ne 'ECHECK' ) {
4260 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4261 or return "Illegal payname $payname";
4262 ($payfirst, $paylast) = ($1, $2);
4264 $payfirst = $self->getfield('first');
4265 $paylast = $self->getfield('last');
4266 $payname = "$payfirst $paylast";
4269 my @invoicing_list = $self->invoicing_list_emailonly;
4270 if ( $conf->exists('emailinvoiceautoalways')
4271 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4272 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4273 push @invoicing_list, $self->all_emails;
4276 my $email = ($conf->exists('business-onlinepayment-email-override'))
4277 ? $conf->config('business-onlinepayment-email-override')
4278 : $invoicing_list[0];
4282 my $payip = exists($options{'payip'})
4285 $content{customer_ip} = $payip
4288 $content{invoice_number} = $options{'invnum'}
4289 if exists($options{'invnum'}) && length($options{'invnum'});
4291 $content{email_customer} =
4292 ( $conf->exists('business-onlinepayment-email_customer')
4293 || $conf->exists('business-onlinepayment-email-override') );
4296 if ( $method eq 'CC' ) {
4298 $content{card_number} = $payinfo;
4299 $paydate = exists($options{'paydate'})
4300 ? $options{'paydate'}
4302 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4303 $content{expiration} = "$2/$1";
4305 my $paycvv = exists($options{'paycvv'})
4306 ? $options{'paycvv'}
4308 $content{cvv2} = $paycvv
4311 my $paystart_month = exists($options{'paystart_month'})
4312 ? $options{'paystart_month'}
4313 : $self->paystart_month;
4315 my $paystart_year = exists($options{'paystart_year'})
4316 ? $options{'paystart_year'}
4317 : $self->paystart_year;
4319 $content{card_start} = "$paystart_month/$paystart_year"
4320 if $paystart_month && $paystart_year;
4322 my $payissue = exists($options{'payissue'})
4323 ? $options{'payissue'}
4325 $content{issue_number} = $payissue if $payissue;
4327 if ( $self->_bop_recurring_billing( 'payinfo' => $payinfo,
4328 'trans_is_recur' => $trans_is_recur,
4332 $content{recurring_billing} = 'YES';
4333 $content{acct_code} = 'rebill'
4334 if $conf->exists('credit_card-recurring_billing_acct_code');
4337 } elsif ( $method eq 'ECHECK' ) {
4338 ( $content{account_number}, $content{routing_code} ) =
4339 split('@', $payinfo);
4340 $content{bank_name} = $o_payname;
4341 $content{bank_state} = exists($options{'paystate'})
4342 ? $options{'paystate'}
4343 : $self->getfield('paystate');
4344 $content{account_type} = exists($options{'paytype'})
4345 ? uc($options{'paytype'}) || 'CHECKING'
4346 : uc($self->getfield('paytype')) || 'CHECKING';
4347 $content{account_name} = $payname;
4348 $content{customer_org} = $self->company ? 'B' : 'I';
4349 $content{state_id} = exists($options{'stateid'})
4350 ? $options{'stateid'}
4351 : $self->getfield('stateid');
4352 $content{state_id_state} = exists($options{'stateid_state'})
4353 ? $options{'stateid_state'}
4354 : $self->getfield('stateid_state');
4355 $content{customer_ssn} = exists($options{'ss'})
4358 } elsif ( $method eq 'LEC' ) {
4359 $content{phone} = $payinfo;
4363 # run transaction(s)
4366 my $balance = exists( $options{'balance'} )
4367 ? $options{'balance'}
4370 $self->select_for_update; #mutex ... just until we get our pending record in
4372 #the checks here are intended to catch concurrent payments
4373 #double-form-submission prevention is taken care of in cust_pay_pending::check
4376 return "The customer's balance has changed; $method transaction aborted."
4377 if $self->balance < $balance;
4378 #&& $self->balance < $amount; #might as well anyway?
4380 #also check and make sure there aren't *other* pending payments for this cust
4382 my @pending = qsearch('cust_pay_pending', {
4383 'custnum' => $self->custnum,
4384 'status' => { op=>'!=', value=>'done' }
4386 return "A payment is already being processed for this customer (".
4387 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
4388 "); $method transaction aborted."
4389 if scalar(@pending);
4391 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
4393 my $cust_pay_pending = new FS::cust_pay_pending {
4394 'custnum' => $self->custnum,
4395 #'invnum' => $options{'invnum'},
4398 'payby' => $method2payby{$method},
4399 'payinfo' => $payinfo,
4400 'paydate' => $paydate,
4401 'recurring_billing' => $content{recurring_billing},
4402 'pkgnum' => $options{'pkgnum'},
4404 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
4406 $cust_pay_pending->payunique( $options{payunique} )
4407 if defined($options{payunique}) && length($options{payunique});
4408 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
4409 return $cpp_new_err if $cpp_new_err;
4411 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
4413 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
4414 $transaction->content(
4417 'password' => $password,
4418 'action' => $action1,
4419 'description' => $options{'description'},
4420 'amount' => $amount,
4421 #'invoice_number' => $options{'invnum'},
4422 'customer_id' => $self->custnum,
4423 'last_name' => $paylast,
4424 'first_name' => $payfirst,
4426 'address' => $address,
4427 'city' => ( exists($options{'city'})
4430 'state' => ( exists($options{'state'})
4433 'zip' => ( exists($options{'zip'})
4436 'country' => ( exists($options{'country'})
4437 ? $options{'country'}
4439 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4441 'phone' => $self->daytime || $self->night,
4445 $cust_pay_pending->status('pending');
4446 my $cpp_pending_err = $cust_pay_pending->replace;
4447 return $cpp_pending_err if $cpp_pending_err;
4450 my $BOP_TESTING = 0;
4451 my $BOP_TESTING_SUCCESS = 1;
4453 unless ( $BOP_TESTING ) {
4454 $transaction->submit();
4456 if ( $BOP_TESTING_SUCCESS ) {
4457 $transaction->is_success(1);
4458 $transaction->authorization('fake auth');
4460 $transaction->is_success(0);
4461 $transaction->error_message('fake failure');
4465 if ( $transaction->is_success() && $action2 ) {
4467 $cust_pay_pending->status('authorized');
4468 my $cpp_authorized_err = $cust_pay_pending->replace;
4469 return $cpp_authorized_err if $cpp_authorized_err;
4471 my $auth = $transaction->authorization;
4472 my $ordernum = $transaction->can('order_number')
4473 ? $transaction->order_number
4477 new Business::OnlinePayment( $processor, @bop_options );
4484 password => $password,
4485 order_number => $ordernum,
4487 authorization => $auth,
4488 description => $options{'description'},
4491 foreach my $field (qw( authorization_source_code returned_ACI
4492 transaction_identifier validation_code
4493 transaction_sequence_num local_transaction_date
4494 local_transaction_time AVS_result_code )) {
4495 $capture{$field} = $transaction->$field() if $transaction->can($field);
4498 $capture->content( %capture );
4502 unless ( $capture->is_success ) {
4503 my $e = "Authorization successful but capture failed, custnum #".
4504 $self->custnum. ': '. $capture->result_code.
4505 ": ". $capture->error_message;
4512 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
4513 my $cpp_captured_err = $cust_pay_pending->replace;
4514 return $cpp_captured_err if $cpp_captured_err;
4517 # remove paycvv after initial transaction
4520 #false laziness w/misc/process/payment.cgi - check both to make sure working
4522 if ( defined $self->dbdef_table->column('paycvv')
4523 && length($self->paycvv)
4524 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
4526 my $error = $self->remove_cvv;
4528 warn "WARNING: error removing cvv: $error\n";
4536 if ( $transaction->is_success() ) {
4539 if ( $payment_gateway ) { # agent override
4540 $paybatch = $payment_gateway->gatewaynum. '-';
4543 $paybatch .= "$processor:". $transaction->authorization;
4545 $paybatch .= ':'. $transaction->order_number
4546 if $transaction->can('order_number')
4547 && length($transaction->order_number);
4549 my $cust_pay = new FS::cust_pay ( {
4550 'custnum' => $self->custnum,
4551 'invnum' => $options{'invnum'},
4554 'payby' => $method2payby{$method},
4555 'payinfo' => $payinfo,
4556 'paybatch' => $paybatch,
4557 'paydate' => $paydate,
4558 'pkgnum' => $options{'pkgnum'},
4560 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
4561 $cust_pay->payunique( $options{payunique} )
4562 if defined($options{payunique}) && length($options{payunique});
4564 my $oldAutoCommit = $FS::UID::AutoCommit;
4565 local $FS::UID::AutoCommit = 0;
4568 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
4570 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
4573 $cust_pay->invnum(''); #try again with no specific invnum
4574 my $error2 = $cust_pay->insert( $options{'manual'} ?
4575 ( 'manual' => 1 ) : ()
4578 # gah. but at least we have a record of the state we had to abort in
4579 # from cust_pay_pending now.
4580 my $e = "WARNING: $method captured but payment not recorded - ".
4581 "error inserting payment ($processor): $error2".
4582 " (previously tried insert with invnum #$options{'invnum'}" .
4583 ": $error ) - pending payment saved as paypendingnum ".
4584 $cust_pay_pending->paypendingnum. "\n";
4590 if ( $options{'paynum_ref'} ) {
4591 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
4594 $cust_pay_pending->status('done');
4595 $cust_pay_pending->statustext('captured');
4596 $cust_pay_pending->paynum($cust_pay->paynum);
4597 my $cpp_done_err = $cust_pay_pending->replace;
4599 if ( $cpp_done_err ) {
4601 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4602 my $e = "WARNING: $method captured but payment not recorded - ".
4603 "error updating status for paypendingnum ".
4604 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4610 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4612 if ( $options{'apply'} ) {
4613 my $apply_error = $self->apply_payments_and_credits;
4614 if ( $apply_error ) {
4615 warn "WARNING: error applying payment: $apply_error\n";
4616 #but we still should return no error cause the payment otherwise went
4621 return ''; #no error
4627 my $perror = "$processor error: ". $transaction->error_message;
4629 unless ( $transaction->error_message ) {
4632 if ( $transaction->can('response_page') ) {
4634 'page' => ( $transaction->can('response_page')
4635 ? $transaction->response_page
4638 'code' => ( $transaction->can('response_code')
4639 ? $transaction->response_code
4642 'headers' => ( $transaction->can('response_headers')
4643 ? $transaction->response_headers
4649 "No additional debugging information available for $processor";
4652 $perror .= "No error_message returned from $processor -- ".
4653 ( ref($t_response) ? Dumper($t_response) : $t_response );
4657 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
4658 && $conf->exists('emaildecline')
4659 && grep { $_ ne 'POST' } $self->invoicing_list
4660 && ! grep { $transaction->error_message =~ /$_/ }
4661 $conf->config('emaildecline-exclude')
4664 # Send a decline alert to the customer.
4665 my $msgnum = $conf->config('decline_msgnum', $self->agentnum);
4668 # include the raw error message in the transaction state
4669 $cust_pay_pending->setfield('error', $transaction->error_message);
4670 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
4671 $error = $msg_template->send( 'cust_main' => $self,
4672 'object' => $cust_pay_pending );
4676 my @templ = $conf->config('declinetemplate');
4677 my $template = new Text::Template (
4679 SOURCE => [ map "$_\n", @templ ],
4680 ) or return "($perror) can't create template: $Text::Template::ERROR";
4681 $template->compile()
4682 or return "($perror) can't compile template: $Text::Template::ERROR";
4686 scalar( $conf->config('company_name', $self->agentnum ) ),
4687 'company_address' =>
4688 join("\n", $conf->config('company_address', $self->agentnum ) ),
4689 'error' => $transaction->error_message,
4692 my $error = send_email(
4693 'from' => $conf->config('invoice_from', $self->agentnum ),
4694 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
4695 'subject' => 'Your payment could not be processed',
4696 'body' => [ $template->fill_in(HASH => $templ_hash) ],
4700 $perror .= " (also received error sending decline notification: $error)"
4705 $cust_pay_pending->status('done');
4706 $cust_pay_pending->statustext("declined: $perror");
4707 my $cpp_done_err = $cust_pay_pending->replace;
4708 if ( $cpp_done_err ) {
4709 my $e = "WARNING: $method declined but pending payment not resolved - ".
4710 "error updating status for paypendingnum ".
4711 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4713 $perror = "$e ($perror)";
4721 sub _bop_recurring_billing {
4722 my( $self, %opt ) = @_;
4724 my $method = scalar($conf->config('credit_card-recurring_billing_flag'));
4726 if ( defined($method) && $method eq 'transaction_is_recur' ) {
4728 return 1 if $opt{'trans_is_recur'};
4732 my %hash = ( 'custnum' => $self->custnum,
4737 if qsearch('cust_pay', { %hash, 'payinfo' => $opt{'payinfo'} } )
4738 || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo('CARD',
4749 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
4751 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
4752 via a Business::OnlinePayment realtime gateway. See
4753 L<http://420.am/business-onlinepayment> for supported gateways.
4755 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4757 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
4759 Most gateways require a reference to an original payment transaction to refund,
4760 so you probably need to specify a I<paynum>.
4762 I<amount> defaults to the original amount of the payment if not specified.
4764 I<reason> specifies a reason for the refund.
4766 I<paydate> specifies the expiration date for a credit card overriding the
4767 value from the customer record or the payment record. Specified as yyyy-mm-dd
4769 Implementation note: If I<amount> is unspecified or equal to the amount of the
4770 orignal payment, first an attempt is made to "void" the transaction via
4771 the gateway (to cancel a not-yet settled transaction) and then if that fails,
4772 the normal attempt is made to "refund" ("credit") the transaction via the
4773 gateway is attempted.
4775 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4776 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4777 #if set, will override the value from the customer record.
4779 #If an I<invnum> is specified, this payment (if successful) is applied to the
4780 #specified invoice. If you don't specify an I<invnum> you might want to
4781 #call the B<apply_payments> method.
4785 #some false laziness w/realtime_bop, not enough to make it worth merging
4786 #but some useful small subs should be pulled out
4787 sub realtime_refund_bop {
4790 return $self->_new_realtime_refund_bop(@_)
4791 if $self->_new_bop_required();
4793 my( $method, %options ) = @_;
4795 warn "$me realtime_refund_bop: $method refund\n";
4796 warn " $_ => $options{$_}\n" foreach keys %options;
4799 eval "use Business::OnlinePayment";
4803 # look up the original payment and optionally a gateway for that payment
4807 my $amount = $options{'amount'};
4809 my( $processor, $login, $password, @bop_options ) ;
4810 my( $auth, $order_number ) = ( '', '', '' );
4812 if ( $options{'paynum'} ) {
4814 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
4815 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
4816 or return "Unknown paynum $options{'paynum'}";
4817 $amount ||= $cust_pay->paid;
4819 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
4820 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
4821 $cust_pay->paybatch;
4822 my $gatewaynum = '';
4823 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
4825 if ( $gatewaynum ) { #gateway for the payment to be refunded
4827 my $payment_gateway =
4828 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
4829 die "payment gateway $gatewaynum not found"
4830 unless $payment_gateway;
4832 $processor = $payment_gateway->gateway_module;
4833 $login = $payment_gateway->gateway_username;
4834 $password = $payment_gateway->gateway_password;
4835 @bop_options = $payment_gateway->options;
4837 } else { #try the default gateway
4839 my( $conf_processor, $unused_action );
4840 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
4841 $self->default_payment_gateway($method);
4843 return "processor of payment $options{'paynum'} $processor does not".
4844 " match default processor $conf_processor"
4845 unless $processor eq $conf_processor;
4850 } else { # didn't specify a paynum, so look for agent gateway overrides
4851 # like a normal transaction
4854 if ( $method eq 'CC' ) {
4855 $cardtype = cardtype($self->payinfo);
4856 } elsif ( $method eq 'ECHECK' ) {
4859 $cardtype = $method;
4862 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4863 cardtype => $cardtype,
4865 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4867 taxclass => '', } );
4869 if ( $override ) { #use a payment gateway override
4871 my $payment_gateway = $override->payment_gateway;
4873 $processor = $payment_gateway->gateway_module;
4874 $login = $payment_gateway->gateway_username;
4875 $password = $payment_gateway->gateway_password;
4876 #$action = $payment_gateway->gateway_action;
4877 @bop_options = $payment_gateway->options;
4879 } else { #use the standard settings from the config
4882 ( $processor, $login, $password, $unused_action, @bop_options ) =
4883 $self->default_payment_gateway($method);
4888 return "neither amount nor paynum specified" unless $amount;
4893 'password' => $password,
4894 'order_number' => $order_number,
4895 'amount' => $amount,
4896 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4898 $content{authorization} = $auth
4899 if length($auth); #echeck/ACH transactions have an order # but no auth
4900 #(at least with authorize.net)
4902 my $disable_void_after;
4903 if ($conf->exists('disable_void_after')
4904 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
4905 $disable_void_after = $1;
4908 #first try void if applicable
4909 if ( $cust_pay && $cust_pay->paid == $amount
4911 ( not defined($disable_void_after) )
4912 || ( time < ($cust_pay->_date + $disable_void_after ) )
4915 warn " attempting void\n" if $DEBUG > 1;
4916 my $void = new Business::OnlinePayment( $processor, @bop_options );
4917 if ( $void->can('info') ) {
4918 if ( $cust_pay->payby eq 'CARD'
4919 && $void->info('CC_void_requires_card') )
4921 $content{'card_number'} = $cust_pay->payinfo
4922 } elsif ( $cust_pay->payby eq 'CHEK'
4923 && $void->info('ECHECK_void_requires_account') )
4925 ( $content{'account_number'}, $content{'routing_code'} ) =
4926 split('@', $cust_pay->payinfo);
4927 $content{'name'} = $self->get('first'). ' '. $self->get('last');
4930 $void->content( 'action' => 'void', %content );
4932 if ( $void->is_success ) {
4933 my $error = $cust_pay->void($options{'reason'});
4935 # gah, even with transactions.
4936 my $e = 'WARNING: Card/ACH voided but database not updated - '.
4937 "error voiding payment: $error";
4941 warn " void successful\n" if $DEBUG > 1;
4946 warn " void unsuccessful, trying refund\n"
4950 my $address = $self->address1;
4951 $address .= ", ". $self->address2 if $self->address2;
4953 my($payname, $payfirst, $paylast);
4954 if ( $self->payname && $method ne 'ECHECK' ) {
4955 $payname = $self->payname;
4956 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4957 or return "Illegal payname $payname";
4958 ($payfirst, $paylast) = ($1, $2);
4960 $payfirst = $self->getfield('first');
4961 $paylast = $self->getfield('last');
4962 $payname = "$payfirst $paylast";
4965 my @invoicing_list = $self->invoicing_list_emailonly;
4966 if ( $conf->exists('emailinvoiceautoalways')
4967 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4968 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4969 push @invoicing_list, $self->all_emails;
4972 my $email = ($conf->exists('business-onlinepayment-email-override'))
4973 ? $conf->config('business-onlinepayment-email-override')
4974 : $invoicing_list[0];
4976 my $payip = exists($options{'payip'})
4979 $content{customer_ip} = $payip
4983 if ( $method eq 'CC' ) {
4986 $content{card_number} = $payinfo = $cust_pay->payinfo;
4987 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
4988 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
4989 ($content{expiration} = "$2/$1"); # where available
4991 $content{card_number} = $payinfo = $self->payinfo;
4992 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
4993 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4994 $content{expiration} = "$2/$1";
4997 } elsif ( $method eq 'ECHECK' ) {
5000 $payinfo = $cust_pay->payinfo;
5002 $payinfo = $self->payinfo;
5004 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
5005 $content{bank_name} = $self->payname;
5006 $content{account_type} = 'CHECKING';
5007 $content{account_name} = $payname;
5008 $content{customer_org} = $self->company ? 'B' : 'I';
5009 $content{customer_ssn} = $self->ss;
5010 } elsif ( $method eq 'LEC' ) {
5011 $content{phone} = $payinfo = $self->payinfo;
5015 my $refund = new Business::OnlinePayment( $processor, @bop_options );
5016 my %sub_content = $refund->content(
5017 'action' => 'credit',
5018 'customer_id' => $self->custnum,
5019 'last_name' => $paylast,
5020 'first_name' => $payfirst,
5022 'address' => $address,
5023 'city' => $self->city,
5024 'state' => $self->state,
5025 'zip' => $self->zip,
5026 'country' => $self->country,
5028 'phone' => $self->daytime || $self->night,
5031 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
5035 return "$processor error: ". $refund->error_message
5036 unless $refund->is_success();
5038 my %method2payby = (
5044 my $paybatch = "$processor:". $refund->authorization;
5045 $paybatch .= ':'. $refund->order_number
5046 if $refund->can('order_number') && $refund->order_number;
5048 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
5049 my @cust_bill_pay = $cust_pay->cust_bill_pay;
5050 last unless @cust_bill_pay;
5051 my $cust_bill_pay = pop @cust_bill_pay;
5052 my $error = $cust_bill_pay->delete;
5056 my $cust_refund = new FS::cust_refund ( {
5057 'custnum' => $self->custnum,
5058 'paynum' => $options{'paynum'},
5059 'refund' => $amount,
5061 'payby' => $method2payby{$method},
5062 'payinfo' => $payinfo,
5063 'paybatch' => $paybatch,
5064 'reason' => $options{'reason'} || 'card or ACH refund',
5066 my $error = $cust_refund->insert;
5068 $cust_refund->paynum(''); #try again with no specific paynum
5069 my $error2 = $cust_refund->insert;
5071 # gah, even with transactions.
5072 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
5073 "error inserting refund ($processor): $error2".
5074 " (previously tried insert with paynum #$options{'paynum'}" .
5085 # does the configuration indicate the new bop routines are required?
5087 sub _new_bop_required {
5090 my $botpp = 'Business::OnlineThirdPartyPayment';
5093 if ( ( $conf->exists('business-onlinepayment-namespace')
5094 && $conf->config('business-onlinepayment-namespace') eq $botpp
5096 or scalar( grep { $_->gateway_namespace eq $botpp }
5097 qsearch( 'payment_gateway', { 'disabled' => '' } )
5105 =item realtime_collect [ OPTION => VALUE ... ]
5107 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
5108 via a Business::OnlinePayment or Business::OnlineThirdPartyPayment realtime
5109 gateway. See L<http://420.am/business-onlinepayment> and
5110 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5112 On failure returns an error message.
5114 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.
5116 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>, I<pkgnum>
5118 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>. If none is specified
5119 then it is deduced from the customer record.
5121 If no I<amount> is specified, then the customer balance is used.
5123 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5124 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5125 if set, will override the value from the customer record.
5127 I<description> is a free-text field passed to the gateway. It defaults to
5128 the value defined by the business-onlinepayment-description configuration
5129 option, or "Internet services" if that is unset.
5131 If an I<invnum> is specified, this payment (if successful) is applied to the
5132 specified invoice. If you don't specify an I<invnum> you might want to
5133 call the B<apply_payments> method or set the I<apply> option.
5135 I<apply> can be set to true to apply a resulting payment.
5137 I<quiet> can be set true to surpress email decline notices.
5139 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5140 resulting paynum, if any.
5142 I<payunique> is a unique identifier for this payment.
5144 I<session_id> is a session identifier associated with this payment.
5146 I<depend_jobnum> allows payment capture to unlock export jobs
5150 sub realtime_collect {
5151 my( $self, %options ) = @_;
5154 warn "$me realtime_collect:\n";
5155 warn " $_ => $options{$_}\n" foreach keys %options;
5158 $options{amount} = $self->balance unless exists( $options{amount} );
5159 $options{method} = FS::payby->payby2bop($self->payby)
5160 unless exists( $options{method} );
5162 return $self->realtime_bop({%options});
5166 =item _realtime_bop { [ ARG => VALUE ... ] }
5168 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
5169 via a Business::OnlinePayment realtime gateway. See
5170 L<http://420.am/business-onlinepayment> for supported gateways.
5172 Required arguments in the hashref are I<method>, and I<amount>
5174 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5176 Available optional arguments are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
5178 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5179 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5180 if set, will override the value from the customer record.
5182 I<description> is a free-text field passed to the gateway. It defaults to
5183 the value defined by the business-onlinepayment-description configuration
5184 option, or "Internet services" if that is unset.
5186 If an I<invnum> is specified, this payment (if successful) is applied to the
5187 specified invoice. If you don't specify an I<invnum> you might want to
5188 call the B<apply_payments> method.
5190 I<quiet> can be set true to surpress email decline notices.
5192 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5193 resulting paynum, if any.
5195 I<payunique> is a unique identifier for this payment.
5197 I<session_id> is a session identifier associated with this payment.
5199 I<depend_jobnum> allows payment capture to unlock export jobs
5201 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
5205 # some helper routines
5206 sub _payment_gateway {
5207 my ($self, $options) = @_;
5209 $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
5210 unless exists($options->{payment_gateway});
5212 $options->{payment_gateway};
5216 my ($self, $options) = @_;
5219 'login' => $options->{payment_gateway}->gateway_username,
5220 'password' => $options->{payment_gateway}->gateway_password,
5225 my ($self, $options) = @_;
5227 $options->{payment_gateway}->gatewaynum
5228 ? $options->{payment_gateway}->options
5229 : @{ $options->{payment_gateway}->get('options') };
5233 my ($self, $options) = @_;
5235 unless ( $options->{'description'} ) {
5236 if ( $conf->exists('business-onlinepayment-description') ) {
5237 my $dtempl = $conf->config('business-onlinepayment-description');
5239 my $agent = $self->agent->agent;
5241 $options->{'description'} = eval qq("$dtempl");
5243 $options->{'description'} = 'Internet services';
5247 $options->{payinfo} = $self->payinfo unless exists( $options->{payinfo} );
5248 $options->{invnum} ||= '';
5249 $options->{payname} = $self->payname unless exists( $options->{payname} );
5253 my ($self, $options) = @_;
5256 $content{address} = exists($options->{'address1'})
5257 ? $options->{'address1'}
5259 my $address2 = exists($options->{'address2'})
5260 ? $options->{'address2'}
5262 $content{address} .= ", ". $address2 if length($address2);
5264 my $payip = exists($options->{'payip'}) ? $options->{'payip'} : $self->payip;
5265 $content{customer_ip} = $payip if length($payip);
5267 $content{invoice_number} = $options->{'invnum'}
5268 if exists($options->{'invnum'}) && length($options->{'invnum'});
5270 $content{email_customer} =
5271 ( $conf->exists('business-onlinepayment-email_customer')
5272 || $conf->exists('business-onlinepayment-email-override') );
5274 $content{payfirst} = $self->getfield('first');
5275 $content{paylast} = $self->getfield('last');
5277 $content{account_name} = "$content{payfirst} $content{paylast}"
5278 if $options->{method} eq 'ECHECK';
5280 $content{name} = $options->{payname};
5281 $content{name} = $content{account_name} if exists($content{account_name});
5283 $content{city} = exists($options->{city})
5286 $content{state} = exists($options->{state})
5289 $content{zip} = exists($options->{zip})
5292 $content{country} = exists($options->{country})
5293 ? $options->{country}
5295 $content{referer} = 'http://cleanwhisker.420.am/'; #XXX fix referer :/
5296 $content{phone} = $self->daytime || $self->night;
5301 my %bop_method2payby = (
5307 sub _new_realtime_bop {
5311 if (ref($_[0]) eq 'HASH') {
5312 %options = %{$_[0]};
5314 my ( $method, $amount ) = ( shift, shift );
5316 $options{method} = $method;
5317 $options{amount} = $amount;
5321 warn "$me realtime_bop (new): $options{method} $options{amount}\n";
5322 warn " $_ => $options{$_}\n" foreach keys %options;
5325 return $self->fake_bop(%options) if $options{'fake'};
5327 $self->_bop_defaults(\%options);
5330 # set trans_is_recur based on invnum if there is one
5333 my $trans_is_recur = 0;
5334 if ( $options{'invnum'} ) {
5336 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
5337 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
5340 map { $_->part_pkg }
5342 map { $_->cust_pkg }
5343 $cust_bill->cust_bill_pkg;
5346 if grep { $_->freq ne '0' } @part_pkg;
5354 my $payment_gateway = $self->_payment_gateway( \%options );
5355 my $namespace = $payment_gateway->gateway_namespace;
5357 eval "use $namespace";
5361 # check for banned credit card/ACH
5364 my $ban = qsearchs('banned_pay', {
5365 'payby' => $bop_method2payby{$options{method}},
5366 'payinfo' => md5_base64($options{payinfo}),
5368 return "Banned credit card" if $ban;
5374 my (%bop_content) = $self->_bop_content(\%options);
5376 if ( $options{method} ne 'ECHECK' ) {
5377 $options{payname} =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5378 or return "Illegal payname $options{payname}";
5379 ($bop_content{payfirst}, $bop_content{paylast}) = ($1, $2);
5382 my @invoicing_list = $self->invoicing_list_emailonly;
5383 if ( $conf->exists('emailinvoiceautoalways')
5384 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5385 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5386 push @invoicing_list, $self->all_emails;
5389 my $email = ($conf->exists('business-onlinepayment-email-override'))
5390 ? $conf->config('business-onlinepayment-email-override')
5391 : $invoicing_list[0];
5395 if ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'CC' ) {
5397 $content{card_number} = $options{payinfo};
5398 $paydate = exists($options{'paydate'})
5399 ? $options{'paydate'}
5401 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
5402 $content{expiration} = "$2/$1";
5404 my $paycvv = exists($options{'paycvv'})
5405 ? $options{'paycvv'}
5407 $content{cvv2} = $paycvv
5410 my $paystart_month = exists($options{'paystart_month'})
5411 ? $options{'paystart_month'}
5412 : $self->paystart_month;
5414 my $paystart_year = exists($options{'paystart_year'})
5415 ? $options{'paystart_year'}
5416 : $self->paystart_year;
5418 $content{card_start} = "$paystart_month/$paystart_year"
5419 if $paystart_month && $paystart_year;
5421 my $payissue = exists($options{'payissue'})
5422 ? $options{'payissue'}
5424 $content{issue_number} = $payissue if $payissue;
5426 if ( $self->_bop_recurring_billing( 'payinfo' => $options{'payinfo'},
5427 'trans_is_recur' => $trans_is_recur,
5431 $content{recurring_billing} = 'YES';
5432 $content{acct_code} = 'rebill'
5433 if $conf->exists('credit_card-recurring_billing_acct_code');
5436 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'ECHECK' ){
5437 ( $content{account_number}, $content{routing_code} ) =
5438 split('@', $options{payinfo});
5439 $content{bank_name} = $options{payname};
5440 $content{bank_state} = exists($options{'paystate'})
5441 ? $options{'paystate'}
5442 : $self->getfield('paystate');
5443 $content{account_type} = exists($options{'paytype'})
5444 ? uc($options{'paytype'}) || 'CHECKING'
5445 : uc($self->getfield('paytype')) || 'CHECKING';
5446 $content{customer_org} = $self->company ? 'B' : 'I';
5447 $content{state_id} = exists($options{'stateid'})
5448 ? $options{'stateid'}
5449 : $self->getfield('stateid');
5450 $content{state_id_state} = exists($options{'stateid_state'})
5451 ? $options{'stateid_state'}
5452 : $self->getfield('stateid_state');
5453 $content{customer_ssn} = exists($options{'ss'})
5456 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'LEC' ) {
5457 $content{phone} = $options{payinfo};
5458 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5465 # run transaction(s)
5468 my $balance = exists( $options{'balance'} )
5469 ? $options{'balance'}
5472 $self->select_for_update; #mutex ... just until we get our pending record in
5474 #the checks here are intended to catch concurrent payments
5475 #double-form-submission prevention is taken care of in cust_pay_pending::check
5478 return "The customer's balance has changed; $options{method} transaction aborted."
5479 if $self->balance < $balance;
5480 #&& $self->balance < $options{amount}; #might as well anyway?
5482 #also check and make sure there aren't *other* pending payments for this cust
5484 my @pending = qsearch('cust_pay_pending', {
5485 'custnum' => $self->custnum,
5486 'status' => { op=>'!=', value=>'done' }
5488 return "A payment is already being processed for this customer (".
5489 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
5490 "); $options{method} transaction aborted."
5491 if scalar(@pending);
5493 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
5495 my $cust_pay_pending = new FS::cust_pay_pending {
5496 'custnum' => $self->custnum,
5497 #'invnum' => $options{'invnum'},
5498 'paid' => $options{amount},
5500 'payby' => $bop_method2payby{$options{method}},
5501 'payinfo' => $options{payinfo},
5502 'paydate' => $paydate,
5503 'recurring_billing' => $content{recurring_billing},
5504 'pkgnum' => $options{'pkgnum'},
5506 'gatewaynum' => $payment_gateway->gatewaynum || '',
5507 'session_id' => $options{session_id} || '',
5508 'jobnum' => $options{depend_jobnum} || '',
5510 $cust_pay_pending->payunique( $options{payunique} )
5511 if defined($options{payunique}) && length($options{payunique});
5512 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
5513 return $cpp_new_err if $cpp_new_err;
5515 my( $action1, $action2 ) =
5516 split( /\s*\,\s*/, $payment_gateway->gateway_action );
5518 my $transaction = new $namespace( $payment_gateway->gateway_module,
5519 $self->_bop_options(\%options),
5522 $transaction->content(
5523 'type' => $options{method},
5524 $self->_bop_auth(\%options),
5525 'action' => $action1,
5526 'description' => $options{'description'},
5527 'amount' => $options{amount},
5528 #'invoice_number' => $options{'invnum'},
5529 'customer_id' => $self->custnum,
5531 'reference' => $cust_pay_pending->paypendingnum, #for now
5536 $cust_pay_pending->status('pending');
5537 my $cpp_pending_err = $cust_pay_pending->replace;
5538 return $cpp_pending_err if $cpp_pending_err;
5541 my $BOP_TESTING = 0;
5542 my $BOP_TESTING_SUCCESS = 1;
5544 unless ( $BOP_TESTING ) {
5545 $transaction->submit();
5547 if ( $BOP_TESTING_SUCCESS ) {
5548 $transaction->is_success(1);
5549 $transaction->authorization('fake auth');
5551 $transaction->is_success(0);
5552 $transaction->error_message('fake failure');
5556 if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5558 return { reference => $cust_pay_pending->paypendingnum,
5559 map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
5561 } elsif ( $transaction->is_success() && $action2 ) {
5563 $cust_pay_pending->status('authorized');
5564 my $cpp_authorized_err = $cust_pay_pending->replace;
5565 return $cpp_authorized_err if $cpp_authorized_err;
5567 my $auth = $transaction->authorization;
5568 my $ordernum = $transaction->can('order_number')
5569 ? $transaction->order_number
5573 new Business::OnlinePayment( $payment_gateway->gateway_module,
5574 $self->_bop_options(\%options),
5579 type => $options{method},
5581 $self->_bop_auth(\%options),
5582 order_number => $ordernum,
5583 amount => $options{amount},
5584 authorization => $auth,
5585 description => $options{'description'},
5588 foreach my $field (qw( authorization_source_code returned_ACI
5589 transaction_identifier validation_code
5590 transaction_sequence_num local_transaction_date
5591 local_transaction_time AVS_result_code )) {
5592 $capture{$field} = $transaction->$field() if $transaction->can($field);
5595 $capture->content( %capture );
5599 unless ( $capture->is_success ) {
5600 my $e = "Authorization successful but capture failed, custnum #".
5601 $self->custnum. ': '. $capture->result_code.
5602 ": ". $capture->error_message;
5610 # remove paycvv after initial transaction
5613 #false laziness w/misc/process/payment.cgi - check both to make sure working
5615 if ( defined $self->dbdef_table->column('paycvv')
5616 && length($self->paycvv)
5617 && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
5619 my $error = $self->remove_cvv;
5621 warn "WARNING: error removing cvv: $error\n";
5629 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5641 if (ref($_[0]) eq 'HASH') {
5642 %options = %{$_[0]};
5644 my ( $method, $amount ) = ( shift, shift );
5646 $options{method} = $method;
5647 $options{amount} = $amount;
5650 if ( $options{'fake_failure'} ) {
5651 return "Error: No error; test failure requested with fake_failure";
5655 #if ( $payment_gateway->gatewaynum ) { # agent override
5656 # $paybatch = $payment_gateway->gatewaynum. '-';
5659 #$paybatch .= "$processor:". $transaction->authorization;
5661 #$paybatch .= ':'. $transaction->order_number
5662 # if $transaction->can('order_number')
5663 # && length($transaction->order_number);
5665 my $paybatch = 'FakeProcessor:54:32';
5667 my $cust_pay = new FS::cust_pay ( {
5668 'custnum' => $self->custnum,
5669 'invnum' => $options{'invnum'},
5670 'paid' => $options{amount},
5672 'payby' => $bop_method2payby{$options{method}},
5673 #'payinfo' => $payinfo,
5674 'payinfo' => '4111111111111111',
5675 'paybatch' => $paybatch,
5676 #'paydate' => $paydate,
5677 'paydate' => '2012-05-01',
5679 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
5681 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5684 $cust_pay->invnum(''); #try again with no specific invnum
5685 my $error2 = $cust_pay->insert( $options{'manual'} ?
5686 ( 'manual' => 1 ) : ()
5689 # gah, even with transactions.
5690 my $e = 'WARNING: Card/ACH debited but database not updated - '.
5691 "error inserting (fake!) payment: $error2".
5692 " (previously tried insert with invnum #$options{'invnum'}" .
5699 if ( $options{'paynum_ref'} ) {
5700 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5703 return ''; #no error
5708 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
5710 # Wraps up processing of a realtime credit card, ACH (electronic check) or
5711 # phone bill transaction.
5713 sub _realtime_bop_result {
5714 my( $self, $cust_pay_pending, $transaction, %options ) = @_;
5716 warn "$me _realtime_bop_result: pending transaction ".
5717 $cust_pay_pending->paypendingnum. "\n";
5718 warn " $_ => $options{$_}\n" foreach keys %options;
5721 my $payment_gateway = $options{payment_gateway}
5722 or return "no payment gateway in arguments to _realtime_bop_result";
5724 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
5725 my $cpp_captured_err = $cust_pay_pending->replace;
5726 return $cpp_captured_err if $cpp_captured_err;
5728 if ( $transaction->is_success() ) {
5731 if ( $payment_gateway->gatewaynum ) { # agent override
5732 $paybatch = $payment_gateway->gatewaynum. '-';
5735 $paybatch .= $payment_gateway->gateway_module. ":".
5736 $transaction->authorization;
5738 $paybatch .= ':'. $transaction->order_number
5739 if $transaction->can('order_number')
5740 && length($transaction->order_number);
5742 my $cust_pay = new FS::cust_pay ( {
5743 'custnum' => $self->custnum,
5744 'invnum' => $options{'invnum'},
5745 'paid' => $cust_pay_pending->paid,
5747 'payby' => $cust_pay_pending->payby,
5748 #'payinfo' => $payinfo,
5749 'paybatch' => $paybatch,
5750 'paydate' => $cust_pay_pending->paydate,
5751 'pkgnum' => $cust_pay_pending->pkgnum,
5753 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
5754 $cust_pay->payunique( $options{payunique} )
5755 if defined($options{payunique}) && length($options{payunique});
5757 my $oldAutoCommit = $FS::UID::AutoCommit;
5758 local $FS::UID::AutoCommit = 0;
5761 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
5763 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5766 $cust_pay->invnum(''); #try again with no specific invnum
5767 my $error2 = $cust_pay->insert( $options{'manual'} ?
5768 ( 'manual' => 1 ) : ()
5771 # gah. but at least we have a record of the state we had to abort in
5772 # from cust_pay_pending now.
5773 my $e = "WARNING: $options{method} captured but payment not recorded -".
5774 " error inserting payment (". $payment_gateway->gateway_module.
5776 " (previously tried insert with invnum #$options{'invnum'}" .
5777 ": $error ) - pending payment saved as paypendingnum ".
5778 $cust_pay_pending->paypendingnum. "\n";
5784 my $jobnum = $cust_pay_pending->jobnum;
5786 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5788 unless ( $placeholder ) {
5789 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5790 my $e = "WARNING: $options{method} captured but job $jobnum not ".
5791 "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
5796 $error = $placeholder->delete;
5799 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5800 my $e = "WARNING: $options{method} captured but could not delete ".
5801 "job $jobnum for paypendingnum ".
5802 $cust_pay_pending->paypendingnum. ": $error\n";
5809 if ( $options{'paynum_ref'} ) {
5810 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5813 $cust_pay_pending->status('done');
5814 $cust_pay_pending->statustext('captured');
5815 $cust_pay_pending->paynum($cust_pay->paynum);
5816 my $cpp_done_err = $cust_pay_pending->replace;
5818 if ( $cpp_done_err ) {
5820 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5821 my $e = "WARNING: $options{method} captured but payment not recorded - ".
5822 "error updating status for paypendingnum ".
5823 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5829 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5831 if ( $options{'apply'} ) {
5832 my $apply_error = $self->apply_payments_and_credits;
5833 if ( $apply_error ) {
5834 warn "WARNING: error applying payment: $apply_error\n";
5835 #but we still should return no error cause the payment otherwise went
5840 return ''; #no error
5846 my $perror = $payment_gateway->gateway_module. " error: ".
5847 $transaction->error_message;
5849 my $jobnum = $cust_pay_pending->jobnum;
5851 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5853 if ( $placeholder ) {
5854 my $error = $placeholder->depended_delete;
5855 $error ||= $placeholder->delete;
5856 warn "error removing provisioning jobs after declined paypendingnum ".
5857 $cust_pay_pending->paypendingnum. "\n";
5859 my $e = "error finding job $jobnum for declined paypendingnum ".
5860 $cust_pay_pending->paypendingnum. "\n";
5866 unless ( $transaction->error_message ) {
5869 if ( $transaction->can('response_page') ) {
5871 'page' => ( $transaction->can('response_page')
5872 ? $transaction->response_page
5875 'code' => ( $transaction->can('response_code')
5876 ? $transaction->response_code
5879 'headers' => ( $transaction->can('response_headers')
5880 ? $transaction->response_headers
5886 "No additional debugging information available for ".
5887 $payment_gateway->gateway_module;
5890 $perror .= "No error_message returned from ".
5891 $payment_gateway->gateway_module. " -- ".
5892 ( ref($t_response) ? Dumper($t_response) : $t_response );
5896 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
5897 && $conf->exists('emaildecline')
5898 && grep { $_ ne 'POST' } $self->invoicing_list
5899 && ! grep { $transaction->error_message =~ /$_/ }
5900 $conf->config('emaildecline-exclude')
5902 my @templ = $conf->config('declinetemplate');
5903 my $template = new Text::Template (
5905 SOURCE => [ map "$_\n", @templ ],
5906 ) or return "($perror) can't create template: $Text::Template::ERROR";
5907 $template->compile()
5908 or return "($perror) can't compile template: $Text::Template::ERROR";
5912 scalar( $conf->config('company_name', $self->agentnum ) ),
5913 'company_address' =>
5914 join("\n", $conf->config('company_address', $self->agentnum ) ),
5915 'error' => $transaction->error_message,
5918 my $error = send_email(
5919 'from' => $conf->config('invoice_from', $self->agentnum ),
5920 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
5921 'subject' => 'Your payment could not be processed',
5922 'body' => [ $template->fill_in(HASH => $templ_hash) ],
5925 $perror .= " (also received error sending decline notification: $error)"
5930 $cust_pay_pending->status('done');
5931 $cust_pay_pending->statustext("declined: $perror");
5932 my $cpp_done_err = $cust_pay_pending->replace;
5933 if ( $cpp_done_err ) {
5934 my $e = "WARNING: $options{method} declined but pending payment not ".
5935 "resolved - error updating status for paypendingnum ".
5936 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5938 $perror = "$e ($perror)";
5946 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
5948 Verifies successful third party processing of a realtime credit card,
5949 ACH (electronic check) or phone bill transaction via a
5950 Business::OnlineThirdPartyPayment realtime gateway. See
5951 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5953 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
5955 The additional options I<payname>, I<city>, I<state>,
5956 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5957 if set, will override the value from the customer record.
5959 I<description> is a free-text field passed to the gateway. It defaults to
5960 "Internet services".
5962 If an I<invnum> is specified, this payment (if successful) is applied to the
5963 specified invoice. If you don't specify an I<invnum> you might want to
5964 call the B<apply_payments> method.
5966 I<quiet> can be set true to surpress email decline notices.
5968 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5969 resulting paynum, if any.
5971 I<payunique> is a unique identifier for this payment.
5973 Returns a hashref containing elements bill_error (which will be undefined
5974 upon success) and session_id of any associated session.
5978 sub realtime_botpp_capture {
5979 my( $self, $cust_pay_pending, %options ) = @_;
5981 warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
5982 warn " $_ => $options{$_}\n" foreach keys %options;
5985 eval "use Business::OnlineThirdPartyPayment";
5989 # select the gateway
5992 my $method = FS::payby->payby2bop($cust_pay_pending->payby);
5994 my $payment_gateway = $cust_pay_pending->gatewaynum
5995 ? qsearchs( 'payment_gateway',
5996 { gatewaynum => $cust_pay_pending->gatewaynum }
5998 : $self->agent->payment_gateway( 'method' => $method,
5999 # 'invnum' => $cust_pay_pending->invnum,
6000 # 'payinfo' => $cust_pay_pending->payinfo,
6003 $options{payment_gateway} = $payment_gateway; # for the helper subs
6009 my @invoicing_list = $self->invoicing_list_emailonly;
6010 if ( $conf->exists('emailinvoiceautoalways')
6011 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
6012 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
6013 push @invoicing_list, $self->all_emails;
6016 my $email = ($conf->exists('business-onlinepayment-email-override'))
6017 ? $conf->config('business-onlinepayment-email-override')
6018 : $invoicing_list[0];
6022 $content{email_customer} =
6023 ( $conf->exists('business-onlinepayment-email_customer')
6024 || $conf->exists('business-onlinepayment-email-override') );
6027 # run transaction(s)
6031 new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
6032 $self->_bop_options(\%options),
6035 $transaction->reference({ %options });
6037 $transaction->content(
6039 $self->_bop_auth(\%options),
6040 'action' => 'Post Authorization',
6041 'description' => $options{'description'},
6042 'amount' => $cust_pay_pending->paid,
6043 #'invoice_number' => $options{'invnum'},
6044 'customer_id' => $self->custnum,
6045 'referer' => 'http://cleanwhisker.420.am/',
6046 'reference' => $cust_pay_pending->paypendingnum,
6048 'phone' => $self->daytime || $self->night,
6050 # plus whatever is required for bogus capture avoidance
6053 $transaction->submit();
6056 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
6059 bill_error => $error,
6060 session_id => $cust_pay_pending->session_id,
6065 =item default_payment_gateway DEPRECATED -- use agent->payment_gateway
6069 sub default_payment_gateway {
6070 my( $self, $method ) = @_;
6072 die "Real-time processing not enabled\n"
6073 unless $conf->exists('business-onlinepayment');
6075 #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
6078 my $bop_config = 'business-onlinepayment';
6079 $bop_config .= '-ach'
6080 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
6081 my ( $processor, $login, $password, $action, @bop_options ) =
6082 $conf->config($bop_config);
6083 $action ||= 'normal authorization';
6084 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
6085 die "No real-time processor is enabled - ".
6086 "did you set the business-onlinepayment configuration value?\n"
6089 ( $processor, $login, $password, $action, @bop_options )
6094 Removes the I<paycvv> field from the database directly.
6096 If there is an error, returns the error, otherwise returns false.
6102 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
6103 or return dbh->errstr;
6104 $sth->execute($self->custnum)
6105 or return $sth->errstr;
6110 =item _new_realtime_refund_bop METHOD [ OPTION => VALUE ... ]
6112 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
6113 via a Business::OnlinePayment realtime gateway. See
6114 L<http://420.am/business-onlinepayment> for supported gateways.
6116 Available methods are: I<CC>, I<ECHECK> and I<LEC>
6118 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
6120 Most gateways require a reference to an original payment transaction to refund,
6121 so you probably need to specify a I<paynum>.
6123 I<amount> defaults to the original amount of the payment if not specified.
6125 I<reason> specifies a reason for the refund.
6127 I<paydate> specifies the expiration date for a credit card overriding the
6128 value from the customer record or the payment record. Specified as yyyy-mm-dd
6130 Implementation note: If I<amount> is unspecified or equal to the amount of the
6131 orignal payment, first an attempt is made to "void" the transaction via
6132 the gateway (to cancel a not-yet settled transaction) and then if that fails,
6133 the normal attempt is made to "refund" ("credit") the transaction via the
6134 gateway is attempted.
6136 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
6137 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
6138 #if set, will override the value from the customer record.
6140 #If an I<invnum> is specified, this payment (if successful) is applied to the
6141 #specified invoice. If you don't specify an I<invnum> you might want to
6142 #call the B<apply_payments> method.
6146 #some false laziness w/realtime_bop, not enough to make it worth merging
6147 #but some useful small subs should be pulled out
6148 sub _new_realtime_refund_bop {
6152 if (ref($_[0]) ne 'HASH') {
6153 %options = %{$_[0]};
6157 $options{method} = $method;
6161 warn "$me realtime_refund_bop (new): $options{method} refund\n";
6162 warn " $_ => $options{$_}\n" foreach keys %options;
6166 # look up the original payment and optionally a gateway for that payment
6170 my $amount = $options{'amount'};
6172 my( $processor, $login, $password, @bop_options, $namespace ) ;
6173 my( $auth, $order_number ) = ( '', '', '' );
6175 if ( $options{'paynum'} ) {
6177 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
6178 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
6179 or return "Unknown paynum $options{'paynum'}";
6180 $amount ||= $cust_pay->paid;
6182 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
6183 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
6184 $cust_pay->paybatch;
6185 my $gatewaynum = '';
6186 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
6188 if ( $gatewaynum ) { #gateway for the payment to be refunded
6190 my $payment_gateway =
6191 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
6192 die "payment gateway $gatewaynum not found"
6193 unless $payment_gateway;
6195 $processor = $payment_gateway->gateway_module;
6196 $login = $payment_gateway->gateway_username;
6197 $password = $payment_gateway->gateway_password;
6198 $namespace = $payment_gateway->gateway_namespace;
6199 @bop_options = $payment_gateway->options;
6201 } else { #try the default gateway
6204 my $payment_gateway =
6205 $self->agent->payment_gateway('method' => $options{method});
6207 ( $conf_processor, $login, $password, $namespace ) =
6208 map { my $method = "gateway_$_"; $payment_gateway->$method }
6209 qw( module username password namespace );
6211 @bop_options = $payment_gateway->gatewaynum
6212 ? $payment_gateway->options
6213 : @{ $payment_gateway->get('options') };
6215 return "processor of payment $options{'paynum'} $processor does not".
6216 " match default processor $conf_processor"
6217 unless $processor eq $conf_processor;
6222 } else { # didn't specify a paynum, so look for agent gateway overrides
6223 # like a normal transaction
6225 my $payment_gateway =
6226 $self->agent->payment_gateway( 'method' => $options{method},
6227 #'payinfo' => $payinfo,
6229 my( $processor, $login, $password, $namespace ) =
6230 map { my $method = "gateway_$_"; $payment_gateway->$method }
6231 qw( module username password namespace );
6233 my @bop_options = $payment_gateway->gatewaynum
6234 ? $payment_gateway->options
6235 : @{ $payment_gateway->get('options') };
6238 return "neither amount nor paynum specified" unless $amount;
6240 eval "use $namespace";
6244 'type' => $options{method},
6246 'password' => $password,
6247 'order_number' => $order_number,
6248 'amount' => $amount,
6249 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
6251 $content{authorization} = $auth
6252 if length($auth); #echeck/ACH transactions have an order # but no auth
6253 #(at least with authorize.net)
6255 my $disable_void_after;
6256 if ($conf->exists('disable_void_after')
6257 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
6258 $disable_void_after = $1;
6261 #first try void if applicable
6262 if ( $cust_pay && $cust_pay->paid == $amount
6264 ( not defined($disable_void_after) )
6265 || ( time < ($cust_pay->_date + $disable_void_after ) )
6268 warn " attempting void\n" if $DEBUG > 1;
6269 my $void = new Business::OnlinePayment( $processor, @bop_options );
6270 if ( $void->can('info') ) {
6271 if ( $cust_pay->payby eq 'CARD'
6272 && $void->info('CC_void_requires_card') )
6274 $content{'card_number'} = $cust_pay->payinfo;
6275 } elsif ( $cust_pay->payby eq 'CHEK'
6276 && $void->info('ECHECK_void_requires_account') )
6278 ( $content{'account_number'}, $content{'routing_code'} ) =
6279 split('@', $cust_pay->payinfo);
6280 $content{'name'} = $self->get('first'). ' '. $self->get('last');
6283 $void->content( 'action' => 'void', %content );
6285 if ( $void->is_success ) {
6286 my $error = $cust_pay->void($options{'reason'});
6288 # gah, even with transactions.
6289 my $e = 'WARNING: Card/ACH voided but database not updated - '.
6290 "error voiding payment: $error";
6294 warn " void successful\n" if $DEBUG > 1;
6299 warn " void unsuccessful, trying refund\n"
6303 my $address = $self->address1;
6304 $address .= ", ". $self->address2 if $self->address2;
6306 my($payname, $payfirst, $paylast);
6307 if ( $self->payname && $options{method} ne 'ECHECK' ) {
6308 $payname = $self->payname;
6309 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
6310 or return "Illegal payname $payname";
6311 ($payfirst, $paylast) = ($1, $2);
6313 $payfirst = $self->getfield('first');
6314 $paylast = $self->getfield('last');
6315 $payname = "$payfirst $paylast";
6318 my @invoicing_list = $self->invoicing_list_emailonly;
6319 if ( $conf->exists('emailinvoiceautoalways')
6320 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
6321 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
6322 push @invoicing_list, $self->all_emails;
6325 my $email = ($conf->exists('business-onlinepayment-email-override'))
6326 ? $conf->config('business-onlinepayment-email-override')
6327 : $invoicing_list[0];
6329 my $payip = exists($options{'payip'})
6332 $content{customer_ip} = $payip
6336 if ( $options{method} eq 'CC' ) {
6339 $content{card_number} = $payinfo = $cust_pay->payinfo;
6340 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
6341 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
6342 ($content{expiration} = "$2/$1"); # where available
6344 $content{card_number} = $payinfo = $self->payinfo;
6345 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
6346 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
6347 $content{expiration} = "$2/$1";
6350 } elsif ( $options{method} eq 'ECHECK' ) {
6353 $payinfo = $cust_pay->payinfo;
6355 $payinfo = $self->payinfo;
6357 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
6358 $content{bank_name} = $self->payname;
6359 $content{account_type} = 'CHECKING';
6360 $content{account_name} = $payname;
6361 $content{customer_org} = $self->company ? 'B' : 'I';
6362 $content{customer_ssn} = $self->ss;
6363 } elsif ( $options{method} eq 'LEC' ) {
6364 $content{phone} = $payinfo = $self->payinfo;
6368 my $refund = new Business::OnlinePayment( $processor, @bop_options );
6369 my %sub_content = $refund->content(
6370 'action' => 'credit',
6371 'customer_id' => $self->custnum,
6372 'last_name' => $paylast,
6373 'first_name' => $payfirst,
6375 'address' => $address,
6376 'city' => $self->city,
6377 'state' => $self->state,
6378 'zip' => $self->zip,
6379 'country' => $self->country,
6381 'phone' => $self->daytime || $self->night,
6384 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
6388 return "$processor error: ". $refund->error_message
6389 unless $refund->is_success();
6391 my $paybatch = "$processor:". $refund->authorization;
6392 $paybatch .= ':'. $refund->order_number
6393 if $refund->can('order_number') && $refund->order_number;
6395 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
6396 my @cust_bill_pay = $cust_pay->cust_bill_pay;
6397 last unless @cust_bill_pay;
6398 my $cust_bill_pay = pop @cust_bill_pay;
6399 my $error = $cust_bill_pay->delete;
6403 my $cust_refund = new FS::cust_refund ( {
6404 'custnum' => $self->custnum,
6405 'paynum' => $options{'paynum'},
6406 'refund' => $amount,
6408 'payby' => $bop_method2payby{$options{method}},
6409 'payinfo' => $payinfo,
6410 'paybatch' => $paybatch,
6411 'reason' => $options{'reason'} || 'card or ACH refund',
6413 my $error = $cust_refund->insert;
6415 $cust_refund->paynum(''); #try again with no specific paynum
6416 my $error2 = $cust_refund->insert;
6418 # gah, even with transactions.
6419 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
6420 "error inserting refund ($processor): $error2".
6421 " (previously tried insert with paynum #$options{'paynum'}" .
6432 =item batch_card OPTION => VALUE...
6434 Adds a payment for this invoice to the pending credit card batch (see
6435 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
6436 runs the payment using a realtime gateway.
6441 my ($self, %options) = @_;
6444 if (exists($options{amount})) {
6445 $amount = $options{amount};
6447 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
6449 return '' unless $amount > 0;
6451 my $invnum = delete $options{invnum};
6452 my $payby = $options{invnum} || $self->payby; #dubious
6454 if ($options{'realtime'}) {
6455 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
6461 my $oldAutoCommit = $FS::UID::AutoCommit;
6462 local $FS::UID::AutoCommit = 0;
6465 #this needs to handle mysql as well as Pg, like svc_acct.pm
6466 #(make it into a common function if folks need to do batching with mysql)
6467 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
6468 or return "Cannot lock pay_batch: " . $dbh->errstr;
6472 'payby' => FS::payby->payby2payment($payby),
6475 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
6477 unless ( $pay_batch ) {
6478 $pay_batch = new FS::pay_batch \%pay_batch;
6479 my $error = $pay_batch->insert;
6481 $dbh->rollback if $oldAutoCommit;
6482 die "error creating new batch: $error\n";
6486 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
6487 'batchnum' => $pay_batch->batchnum,
6488 'custnum' => $self->custnum,
6491 foreach (qw( address1 address2 city state zip country payby payinfo paydate
6493 $options{$_} = '' unless exists($options{$_});
6496 my $cust_pay_batch = new FS::cust_pay_batch ( {
6497 'batchnum' => $pay_batch->batchnum,
6498 'invnum' => $invnum || 0, # is there a better value?
6499 # this field should be
6501 # cust_bill_pay_batch now
6502 'custnum' => $self->custnum,
6503 'last' => $self->getfield('last'),
6504 'first' => $self->getfield('first'),
6505 'address1' => $options{address1} || $self->address1,
6506 'address2' => $options{address2} || $self->address2,
6507 'city' => $options{city} || $self->city,
6508 'state' => $options{state} || $self->state,
6509 'zip' => $options{zip} || $self->zip,
6510 'country' => $options{country} || $self->country,
6511 'payby' => $options{payby} || $self->payby,
6512 'payinfo' => $options{payinfo} || $self->payinfo,
6513 'exp' => $options{paydate} || $self->paydate,
6514 'payname' => $options{payname} || $self->payname,
6515 'amount' => $amount, # consolidating
6518 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
6519 if $old_cust_pay_batch;
6522 if ($old_cust_pay_batch) {
6523 $error = $cust_pay_batch->replace($old_cust_pay_batch)
6525 $error = $cust_pay_batch->insert;
6529 $dbh->rollback if $oldAutoCommit;
6533 my $unapplied = $self->total_unapplied_credits
6534 + $self->total_unapplied_payments
6535 + $self->in_transit_payments;
6536 foreach my $cust_bill ($self->open_cust_bill) {
6537 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
6538 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
6539 'invnum' => $cust_bill->invnum,
6540 'paybatchnum' => $cust_pay_batch->paybatchnum,
6541 'amount' => $cust_bill->owed,
6544 if ($unapplied >= $cust_bill_pay_batch->amount){
6545 $unapplied -= $cust_bill_pay_batch->amount;
6548 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
6549 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
6551 $error = $cust_bill_pay_batch->insert;
6553 $dbh->rollback if $oldAutoCommit;
6558 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6562 =item apply_payments_and_credits [ OPTION => VALUE ... ]
6564 Applies unapplied payments and credits.
6566 In most cases, this new method should be used in place of sequential
6567 apply_payments and apply_credits methods.
6569 A hash of optional arguments may be passed. Currently "manual" is supported.
6570 If true, a payment receipt is sent instead of a statement when
6571 'payment_receipt_email' configuration option is set.
6573 If there is an error, returns the error, otherwise returns false.
6577 sub apply_payments_and_credits {
6578 my( $self, %options ) = @_;
6580 local $SIG{HUP} = 'IGNORE';
6581 local $SIG{INT} = 'IGNORE';
6582 local $SIG{QUIT} = 'IGNORE';
6583 local $SIG{TERM} = 'IGNORE';
6584 local $SIG{TSTP} = 'IGNORE';
6585 local $SIG{PIPE} = 'IGNORE';
6587 my $oldAutoCommit = $FS::UID::AutoCommit;
6588 local $FS::UID::AutoCommit = 0;
6591 $self->select_for_update; #mutex
6593 foreach my $cust_bill ( $self->open_cust_bill ) {
6594 my $error = $cust_bill->apply_payments_and_credits(%options);
6596 $dbh->rollback if $oldAutoCommit;
6597 return "Error applying: $error";
6601 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6606 =item apply_credits OPTION => VALUE ...
6608 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
6609 to outstanding invoice balances in chronological order (or reverse
6610 chronological order if the I<order> option is set to B<newest>) and returns the
6611 value of any remaining unapplied credits available for refund (see
6612 L<FS::cust_refund>).
6614 Dies if there is an error.
6622 local $SIG{HUP} = 'IGNORE';
6623 local $SIG{INT} = 'IGNORE';
6624 local $SIG{QUIT} = 'IGNORE';
6625 local $SIG{TERM} = 'IGNORE';
6626 local $SIG{TSTP} = 'IGNORE';
6627 local $SIG{PIPE} = 'IGNORE';
6629 my $oldAutoCommit = $FS::UID::AutoCommit;
6630 local $FS::UID::AutoCommit = 0;
6633 $self->select_for_update; #mutex
6635 unless ( $self->total_unapplied_credits ) {
6636 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6640 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
6641 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
6643 my @invoices = $self->open_cust_bill;
6644 @invoices = sort { $b->_date <=> $a->_date } @invoices
6645 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
6647 if ( $conf->exists('pkg-balances') ) {
6648 # limit @credits to those w/ a pkgnum grepped from $self
6650 foreach my $i (@invoices) {
6651 foreach my $li ( $i->cust_bill_pkg ) {
6652 $pkgnums{$li->pkgnum} = 1;
6655 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
6660 foreach my $cust_bill ( @invoices ) {
6662 if ( !defined($credit) || $credit->credited == 0) {
6663 $credit = pop @credits or last;
6667 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
6668 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
6670 $owed = $cust_bill->owed;
6672 unless ( $owed > 0 ) {
6673 push @credits, $credit;
6677 my $amount = min( $credit->credited, $owed );
6679 my $cust_credit_bill = new FS::cust_credit_bill ( {
6680 'crednum' => $credit->crednum,
6681 'invnum' => $cust_bill->invnum,
6682 'amount' => $amount,
6684 $cust_credit_bill->pkgnum( $credit->pkgnum )
6685 if $conf->exists('pkg-balances') && $credit->pkgnum;
6686 my $error = $cust_credit_bill->insert;
6688 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6692 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6696 my $total_unapplied_credits = $self->total_unapplied_credits;
6698 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6700 return $total_unapplied_credits;
6703 =item apply_payments [ OPTION => VALUE ... ]
6705 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
6706 to outstanding invoice balances in chronological order.
6708 #and returns the value of any remaining unapplied payments.
6710 A hash of optional arguments may be passed. Currently "manual" is supported.
6711 If true, a payment receipt is sent instead of a statement when
6712 'payment_receipt_email' configuration option is set.
6714 Dies if there is an error.
6718 sub apply_payments {
6719 my( $self, %options ) = @_;
6721 local $SIG{HUP} = 'IGNORE';
6722 local $SIG{INT} = 'IGNORE';
6723 local $SIG{QUIT} = 'IGNORE';
6724 local $SIG{TERM} = 'IGNORE';
6725 local $SIG{TSTP} = 'IGNORE';
6726 local $SIG{PIPE} = 'IGNORE';
6728 my $oldAutoCommit = $FS::UID::AutoCommit;
6729 local $FS::UID::AutoCommit = 0;
6732 $self->select_for_update; #mutex
6736 my @payments = sort { $b->_date <=> $a->_date }
6737 grep { $_->unapplied > 0 }
6740 my @invoices = sort { $a->_date <=> $b->_date}
6741 grep { $_->owed > 0 }
6744 if ( $conf->exists('pkg-balances') ) {
6745 # limit @payments to those w/ a pkgnum grepped from $self
6747 foreach my $i (@invoices) {
6748 foreach my $li ( $i->cust_bill_pkg ) {
6749 $pkgnums{$li->pkgnum} = 1;
6752 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
6757 foreach my $cust_bill ( @invoices ) {
6759 if ( !defined($payment) || $payment->unapplied == 0 ) {
6760 $payment = pop @payments or last;
6764 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
6765 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
6767 $owed = $cust_bill->owed;
6769 unless ( $owed > 0 ) {
6770 push @payments, $payment;
6774 my $amount = min( $payment->unapplied, $owed );
6776 my $cust_bill_pay = new FS::cust_bill_pay ( {
6777 'paynum' => $payment->paynum,
6778 'invnum' => $cust_bill->invnum,
6779 'amount' => $amount,
6781 $cust_bill_pay->pkgnum( $payment->pkgnum )
6782 if $conf->exists('pkg-balances') && $payment->pkgnum;
6783 my $error = $cust_bill_pay->insert(%options);
6785 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6789 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6793 my $total_unapplied_payments = $self->total_unapplied_payments;
6795 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6797 return $total_unapplied_payments;
6802 Returns the total owed for this customer on all invoices
6803 (see L<FS::cust_bill/owed>).
6809 $self->total_owed_date(2145859200); #12/31/2037
6812 =item total_owed_date TIME
6814 Returns the total owed for this customer on all invoices with date earlier than
6815 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6816 see L<Time::Local> and L<Date::Parse> for conversion functions.
6820 sub total_owed_date {
6824 # my $custnum = $self->custnum;
6826 # my $owed_sql = FS::cust_bill->owed_sql;
6829 # SELECT SUM($owed_sql) FROM cust_bill
6830 # WHERE custnum = $custnum
6831 # AND _date <= $time
6834 # my $sth = dbh->prepare($sql) or die dbh->errstr;
6835 # $sth->execute() or die $sth->errstr;
6837 # return sprintf( '%.2f', $sth->fetchrow_arrayref->[0] );
6840 foreach my $cust_bill (
6841 grep { $_->_date <= $time }
6842 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6844 $total_bill += $cust_bill->owed;
6846 sprintf( "%.2f", $total_bill );
6850 =item total_owed_pkgnum PKGNUM
6852 Returns the total owed on all invoices for this customer's specific package
6853 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
6857 sub total_owed_pkgnum {
6858 my( $self, $pkgnum ) = @_;
6859 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
6862 =item total_owed_date_pkgnum TIME PKGNUM
6864 Returns the total owed for this customer's specific package when using
6865 experimental package balances on all invoices with date earlier than
6866 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6867 see L<Time::Local> and L<Date::Parse> for conversion functions.
6871 sub total_owed_date_pkgnum {
6872 my( $self, $time, $pkgnum ) = @_;
6875 foreach my $cust_bill (
6876 grep { $_->_date <= $time }
6877 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6879 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
6881 sprintf( "%.2f", $total_bill );
6887 Returns the total amount of all payments.
6894 $total += $_->paid foreach $self->cust_pay;
6895 sprintf( "%.2f", $total );
6898 =item total_unapplied_credits
6900 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6901 customer. See L<FS::cust_credit/credited>.
6903 =item total_credited
6905 Old name for total_unapplied_credits. Don't use.
6909 sub total_credited {
6910 #carp "total_credited deprecated, use total_unapplied_credits";
6911 shift->total_unapplied_credits(@_);
6914 sub total_unapplied_credits {
6916 my $total_credit = 0;
6917 $total_credit += $_->credited foreach $self->cust_credit;
6918 sprintf( "%.2f", $total_credit );
6921 =item total_unapplied_credits_pkgnum PKGNUM
6923 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6924 customer. See L<FS::cust_credit/credited>.
6928 sub total_unapplied_credits_pkgnum {
6929 my( $self, $pkgnum ) = @_;
6930 my $total_credit = 0;
6931 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
6932 sprintf( "%.2f", $total_credit );
6936 =item total_unapplied_payments
6938 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
6939 See L<FS::cust_pay/unapplied>.
6943 sub total_unapplied_payments {
6945 my $total_unapplied = 0;
6946 $total_unapplied += $_->unapplied foreach $self->cust_pay;
6947 sprintf( "%.2f", $total_unapplied );
6950 =item total_unapplied_payments_pkgnum PKGNUM
6952 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
6953 specific package when using experimental package balances. See
6954 L<FS::cust_pay/unapplied>.
6958 sub total_unapplied_payments_pkgnum {
6959 my( $self, $pkgnum ) = @_;
6960 my $total_unapplied = 0;
6961 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
6962 sprintf( "%.2f", $total_unapplied );
6966 =item total_unapplied_refunds
6968 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
6969 customer. See L<FS::cust_refund/unapplied>.
6973 sub total_unapplied_refunds {
6975 my $total_unapplied = 0;
6976 $total_unapplied += $_->unapplied foreach $self->cust_refund;
6977 sprintf( "%.2f", $total_unapplied );
6982 Returns the balance for this customer (total_owed plus total_unrefunded, minus
6983 total_unapplied_credits minus total_unapplied_payments).
6991 + $self->total_unapplied_refunds
6992 - $self->total_unapplied_credits
6993 - $self->total_unapplied_payments
6997 =item balance_date TIME
6999 Returns the balance for this customer, only considering invoices with date
7000 earlier than TIME (total_owed_date minus total_credited minus
7001 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
7002 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
7011 $self->total_owed_date($time)
7012 + $self->total_unapplied_refunds
7013 - $self->total_unapplied_credits
7014 - $self->total_unapplied_payments
7018 =item balance_date_range START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
7020 Returns the balance for this customer, only considering invoices with date
7021 earlier than START_TIME, and optionally not later than END_TIME
7022 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
7024 Times are specified as SQL fragments or numeric
7025 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
7026 L<Date::Parse> for conversion functions. The empty string can be passed
7027 to disable that time constraint completely.
7029 Available options are:
7033 =item unapplied_date
7035 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)
7041 sub balance_date_range {
7043 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
7044 ') FROM cust_main WHERE custnum='. $self->custnum;
7045 sprintf( '%.2f', $self->scalar_sql($sql) );
7048 =item balance_pkgnum PKGNUM
7050 Returns the balance for this customer's specific package when using
7051 experimental package balances (total_owed plus total_unrefunded, minus
7052 total_unapplied_credits minus total_unapplied_payments)
7056 sub balance_pkgnum {
7057 my( $self, $pkgnum ) = @_;
7060 $self->total_owed_pkgnum($pkgnum)
7061 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
7062 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
7063 - $self->total_unapplied_credits_pkgnum($pkgnum)
7064 - $self->total_unapplied_payments_pkgnum($pkgnum)
7068 =item in_transit_payments
7070 Returns the total of requests for payments for this customer pending in
7071 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
7075 sub in_transit_payments {
7077 my $in_transit_payments = 0;
7078 foreach my $pay_batch ( qsearch('pay_batch', {
7081 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
7082 'batchnum' => $pay_batch->batchnum,
7083 'custnum' => $self->custnum,
7085 $in_transit_payments += $cust_pay_batch->amount;
7088 sprintf( "%.2f", $in_transit_payments );
7093 Returns a hash of useful information for making a payment.
7103 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
7104 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
7105 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
7109 For credit card transactions:
7121 For electronic check transactions:
7136 $return{balance} = $self->balance;
7138 $return{payname} = $self->payname
7139 || ( $self->first. ' '. $self->get('last') );
7141 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
7143 $return{payby} = $self->payby;
7144 $return{stateid_state} = $self->stateid_state;
7146 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
7147 $return{card_type} = cardtype($self->payinfo);
7148 $return{payinfo} = $self->paymask;
7150 @return{'month', 'year'} = $self->paydate_monthyear;
7154 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
7155 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
7156 $return{payinfo1} = $payinfo1;
7157 $return{payinfo2} = $payinfo2;
7158 $return{paytype} = $self->paytype;
7159 $return{paystate} = $self->paystate;
7163 #doubleclick protection
7165 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
7171 =item paydate_monthyear
7173 Returns a two-element list consisting of the month and year of this customer's
7174 paydate (credit card expiration date for CARD customers)
7178 sub paydate_monthyear {
7180 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
7182 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
7189 =item tax_exemption TAXNAME
7194 my( $self, $taxname ) = @_;
7196 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
7197 'taxname' => $taxname,
7202 =item cust_main_exemption
7206 sub cust_main_exemption {
7208 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
7211 =item invoicing_list [ ARRAYREF ]
7213 If an arguement is given, sets these email addresses as invoice recipients
7214 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
7215 (except as warnings), so use check_invoicing_list first.
7217 Returns a list of email addresses (with svcnum entries expanded).
7219 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
7220 check it without disturbing anything by passing nothing.
7222 This interface may change in the future.
7226 sub invoicing_list {
7227 my( $self, $arrayref ) = @_;
7230 my @cust_main_invoice;
7231 if ( $self->custnum ) {
7232 @cust_main_invoice =
7233 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7235 @cust_main_invoice = ();
7237 foreach my $cust_main_invoice ( @cust_main_invoice ) {
7238 #warn $cust_main_invoice->destnum;
7239 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
7240 #warn $cust_main_invoice->destnum;
7241 my $error = $cust_main_invoice->delete;
7242 warn $error if $error;
7245 if ( $self->custnum ) {
7246 @cust_main_invoice =
7247 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7249 @cust_main_invoice = ();
7251 my %seen = map { $_->address => 1 } @cust_main_invoice;
7252 foreach my $address ( @{$arrayref} ) {
7253 next if exists $seen{$address} && $seen{$address};
7254 $seen{$address} = 1;
7255 my $cust_main_invoice = new FS::cust_main_invoice ( {
7256 'custnum' => $self->custnum,
7259 my $error = $cust_main_invoice->insert;
7260 warn $error if $error;
7264 if ( $self->custnum ) {
7266 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7273 =item check_invoicing_list ARRAYREF
7275 Checks these arguements as valid input for the invoicing_list method. If there
7276 is an error, returns the error, otherwise returns false.
7280 sub check_invoicing_list {
7281 my( $self, $arrayref ) = @_;
7283 foreach my $address ( @$arrayref ) {
7285 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
7286 return 'Can\'t add FAX invoice destination with a blank FAX number.';
7289 my $cust_main_invoice = new FS::cust_main_invoice ( {
7290 'custnum' => $self->custnum,
7293 my $error = $self->custnum
7294 ? $cust_main_invoice->check
7295 : $cust_main_invoice->checkdest
7297 return $error if $error;
7301 return "Email address required"
7302 if $conf->exists('cust_main-require_invoicing_list_email')
7303 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
7308 =item set_default_invoicing_list
7310 Sets the invoicing list to all accounts associated with this customer,
7311 overwriting any previous invoicing list.
7315 sub set_default_invoicing_list {
7317 $self->invoicing_list($self->all_emails);
7322 Returns the email addresses of all accounts provisioned for this customer.
7329 foreach my $cust_pkg ( $self->all_pkgs ) {
7330 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
7332 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
7333 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
7335 $list{$_}=1 foreach map { $_->email } @svc_acct;
7340 =item invoicing_list_addpost
7342 Adds postal invoicing to this customer. If this customer is already configured
7343 to receive postal invoices, does nothing.
7347 sub invoicing_list_addpost {
7349 return if grep { $_ eq 'POST' } $self->invoicing_list;
7350 my @invoicing_list = $self->invoicing_list;
7351 push @invoicing_list, 'POST';
7352 $self->invoicing_list(\@invoicing_list);
7355 =item invoicing_list_emailonly
7357 Returns the list of email invoice recipients (invoicing_list without non-email
7358 destinations such as POST and FAX).
7362 sub invoicing_list_emailonly {
7364 warn "$me invoicing_list_emailonly called"
7366 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
7369 =item invoicing_list_emailonly_scalar
7371 Returns the list of email invoice recipients (invoicing_list without non-email
7372 destinations such as POST and FAX) as a comma-separated scalar.
7376 sub invoicing_list_emailonly_scalar {
7378 warn "$me invoicing_list_emailonly_scalar called"
7380 join(', ', $self->invoicing_list_emailonly);
7383 =item referral_custnum_cust_main
7385 Returns the customer who referred this customer (or the empty string, if
7386 this customer was not referred).
7388 Note the difference with referral_cust_main method: This method,
7389 referral_custnum_cust_main returns the single customer (if any) who referred
7390 this customer, while referral_cust_main returns an array of customers referred
7395 sub referral_custnum_cust_main {
7397 return '' unless $self->referral_custnum;
7398 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7401 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
7403 Returns an array of customers referred by this customer (referral_custnum set
7404 to this custnum). If DEPTH is given, recurses up to the given depth, returning
7405 customers referred by customers referred by this customer and so on, inclusive.
7406 The default behavior is DEPTH 1 (no recursion).
7408 Note the difference with referral_custnum_cust_main method: This method,
7409 referral_cust_main, returns an array of customers referred BY this customer,
7410 while referral_custnum_cust_main returns the single customer (if any) who
7411 referred this customer.
7415 sub referral_cust_main {
7417 my $depth = @_ ? shift : 1;
7418 my $exclude = @_ ? shift : {};
7421 map { $exclude->{$_->custnum}++; $_; }
7422 grep { ! $exclude->{ $_->custnum } }
7423 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
7427 map { $_->referral_cust_main($depth-1, $exclude) }
7434 =item referral_cust_main_ncancelled
7436 Same as referral_cust_main, except only returns customers with uncancelled
7441 sub referral_cust_main_ncancelled {
7443 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
7446 =item referral_cust_pkg [ DEPTH ]
7448 Like referral_cust_main, except returns a flat list of all unsuspended (and
7449 uncancelled) packages for each customer. The number of items in this list may
7450 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
7454 sub referral_cust_pkg {
7456 my $depth = @_ ? shift : 1;
7458 map { $_->unsuspended_pkgs }
7459 grep { $_->unsuspended_pkgs }
7460 $self->referral_cust_main($depth);
7463 =item referring_cust_main
7465 Returns the single cust_main record for the customer who referred this customer
7466 (referral_custnum), or false.
7470 sub referring_cust_main {
7472 return '' unless $self->referral_custnum;
7473 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7476 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
7478 Applies a credit to this customer. If there is an error, returns the error,
7479 otherwise returns false.
7481 REASON can be a text string, an FS::reason object, or a scalar reference to
7482 a reasonnum. If a text string, it will be automatically inserted as a new
7483 reason, and a 'reason_type' option must be passed to indicate the
7484 FS::reason_type for the new reason.
7486 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
7488 Any other options are passed to FS::cust_credit::insert.
7493 my( $self, $amount, $reason, %options ) = @_;
7495 my $cust_credit = new FS::cust_credit {
7496 'custnum' => $self->custnum,
7497 'amount' => $amount,
7500 if ( ref($reason) ) {
7502 if ( ref($reason) eq 'SCALAR' ) {
7503 $cust_credit->reasonnum( $$reason );
7505 $cust_credit->reasonnum( $reason->reasonnum );
7509 $cust_credit->set('reason', $reason)
7512 for (qw( addlinfo eventnum )) {
7513 $cust_credit->$_( delete $options{$_} )
7514 if exists($options{$_});
7517 $cust_credit->insert(%options);
7521 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
7524 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
7525 time will be ignored. Note that START_TIME and END_TIME only limit the date
7526 range for invoices and I<unapplied> payments, credits, and refunds.
7529 Creates a one-time charge for this customer. If there is an error, returns
7530 the error, otherwise returns false.
7532 New-style, with a hashref of options:
7534 my $error = $cust_main->charge(
7538 'start_date' => str2time('7/4/2009'),
7539 'pkg' => 'Description',
7540 'comment' => 'Comment',
7541 'additional' => [], #extra invoice detail
7542 'classnum' => 1, #pkg_class
7544 'setuptax' => '', # or 'Y' for tax exempt
7547 'taxclass' => 'Tax class',
7550 'taxproduct' => 2, #part_pkg_taxproduct
7551 'override' => {}, #XXX describe
7553 #will be filled in with the new object
7554 'cust_pkg_ref' => \$cust_pkg,
7556 #generate an invoice immediately
7558 'invoice_terms' => '', #with these terms
7564 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
7570 my ( $amount, $quantity, $start_date, $classnum );
7571 my ( $pkg, $comment, $additional );
7572 my ( $setuptax, $taxclass ); #internal taxes
7573 my ( $taxproduct, $override ); #vendor (CCH) taxes
7574 my $cust_pkg_ref = '';
7575 my ( $bill_now, $invoice_terms ) = ( 0, '' );
7576 if ( ref( $_[0] ) ) {
7577 $amount = $_[0]->{amount};
7578 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
7579 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
7580 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
7581 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
7582 : '$'. sprintf("%.2f",$amount);
7583 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
7584 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
7585 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
7586 $additional = $_[0]->{additional} || [];
7587 $taxproduct = $_[0]->{taxproductnum};
7588 $override = { '' => $_[0]->{tax_override} };
7589 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
7590 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
7591 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
7596 $pkg = @_ ? shift : 'One-time charge';
7597 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
7599 $taxclass = @_ ? shift : '';
7603 local $SIG{HUP} = 'IGNORE';
7604 local $SIG{INT} = 'IGNORE';
7605 local $SIG{QUIT} = 'IGNORE';
7606 local $SIG{TERM} = 'IGNORE';
7607 local $SIG{TSTP} = 'IGNORE';
7608 local $SIG{PIPE} = 'IGNORE';
7610 my $oldAutoCommit = $FS::UID::AutoCommit;
7611 local $FS::UID::AutoCommit = 0;
7614 my $part_pkg = new FS::part_pkg ( {
7616 'comment' => $comment,
7620 'classnum' => $classnum ? $classnum : '',
7621 'setuptax' => $setuptax,
7622 'taxclass' => $taxclass,
7623 'taxproductnum' => $taxproduct,
7626 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
7627 ( 0 .. @$additional - 1 )
7629 'additional_count' => scalar(@$additional),
7630 'setup_fee' => $amount,
7633 my $error = $part_pkg->insert( options => \%options,
7634 tax_overrides => $override,
7637 $dbh->rollback if $oldAutoCommit;
7641 my $pkgpart = $part_pkg->pkgpart;
7642 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
7643 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
7644 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
7645 $error = $type_pkgs->insert;
7647 $dbh->rollback if $oldAutoCommit;
7652 my $cust_pkg = new FS::cust_pkg ( {
7653 'custnum' => $self->custnum,
7654 'pkgpart' => $pkgpart,
7655 'quantity' => $quantity,
7656 'start_date' => $start_date,
7659 $error = $cust_pkg->insert;
7661 $dbh->rollback if $oldAutoCommit;
7663 } elsif ( $cust_pkg_ref ) {
7664 ${$cust_pkg_ref} = $cust_pkg;
7668 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
7669 'pkg_list' => [ $cust_pkg ],
7672 $dbh->rollback if $oldAutoCommit;
7677 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
7682 #=item charge_postal_fee
7684 #Applies a one time charge this customer. If there is an error,
7685 #returns the error, returns the cust_pkg charge object or false
7686 #if there was no charge.
7690 # This should be a customer event. For that to work requires that bill
7691 # also be a customer event.
7693 sub charge_postal_fee {
7696 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
7697 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
7699 my $cust_pkg = new FS::cust_pkg ( {
7700 'custnum' => $self->custnum,
7701 'pkgpart' => $pkgpart,
7705 my $error = $cust_pkg->insert;
7706 $error ? $error : $cust_pkg;
7711 Returns all the invoices (see L<FS::cust_bill>) for this customer.
7717 map { $_ } #return $self->num_cust_bill unless wantarray;
7718 sort { $a->_date <=> $b->_date }
7719 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
7722 =item open_cust_bill
7724 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
7729 sub open_cust_bill {
7733 'table' => 'cust_bill',
7734 'hashref' => { 'custnum' => $self->custnum, },
7735 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
7736 'order_by' => 'ORDER BY _date ASC',
7741 =item cust_statements
7743 Returns all the statements (see L<FS::cust_statement>) for this customer.
7747 sub cust_statement {
7749 map { $_ } #return $self->num_cust_statement unless wantarray;
7750 sort { $a->_date <=> $b->_date }
7751 qsearch('cust_statement', { 'custnum' => $self->custnum, } )
7756 Returns all the credits (see L<FS::cust_credit>) for this customer.
7762 map { $_ } #return $self->num_cust_credit unless wantarray;
7763 sort { $a->_date <=> $b->_date }
7764 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
7767 =item cust_credit_pkgnum
7769 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
7770 package when using experimental package balances.
7774 sub cust_credit_pkgnum {
7775 my( $self, $pkgnum ) = @_;
7776 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
7777 sort { $a->_date <=> $b->_date }
7778 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
7779 'pkgnum' => $pkgnum,
7786 Returns all the payments (see L<FS::cust_pay>) for this customer.
7792 return $self->num_cust_pay unless wantarray;
7793 sort { $a->_date <=> $b->_date }
7794 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
7799 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
7800 called automatically when the cust_pay method is used in a scalar context.
7806 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
7807 my $sth = dbh->prepare($sql) or die dbh->errstr;
7808 $sth->execute($self->custnum) or die $sth->errstr;
7809 $sth->fetchrow_arrayref->[0];
7812 =item cust_pay_pkgnum
7814 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
7815 package when using experimental package balances.
7819 sub cust_pay_pkgnum {
7820 my( $self, $pkgnum ) = @_;
7821 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
7822 sort { $a->_date <=> $b->_date }
7823 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
7824 'pkgnum' => $pkgnum,
7831 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
7837 map { $_ } #return $self->num_cust_pay_void unless wantarray;
7838 sort { $a->_date <=> $b->_date }
7839 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
7842 =item cust_pay_batch
7844 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
7848 sub cust_pay_batch {
7850 map { $_ } #return $self->num_cust_pay_batch unless wantarray;
7851 sort { $a->paybatchnum <=> $b->paybatchnum }
7852 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
7855 =item cust_pay_pending
7857 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
7858 (without status "done").
7862 sub cust_pay_pending {
7864 return $self->num_cust_pay_pending unless wantarray;
7865 sort { $a->_date <=> $b->_date }
7866 qsearch( 'cust_pay_pending', {
7867 'custnum' => $self->custnum,
7868 'status' => { op=>'!=', value=>'done' },
7873 =item num_cust_pay_pending
7875 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
7876 customer (without status "done"). Also called automatically when the
7877 cust_pay_pending method is used in a scalar context.
7881 sub num_cust_pay_pending {
7883 my $sql = " SELECT COUNT(*) FROM cust_pay_pending ".
7884 " WHERE custnum = ? AND status != 'done' ";
7885 my $sth = dbh->prepare($sql) or die dbh->errstr;
7886 $sth->execute($self->custnum) or die $sth->errstr;
7887 $sth->fetchrow_arrayref->[0];
7892 Returns all the refunds (see L<FS::cust_refund>) for this customer.
7898 map { $_ } #return $self->num_cust_refund unless wantarray;
7899 sort { $a->_date <=> $b->_date }
7900 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
7903 =item display_custnum
7905 Returns the displayed customer number for this customer: agent_custid if
7906 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
7910 sub display_custnum {
7912 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
7913 return $self->agent_custid;
7915 return $self->custnum;
7921 Returns a name string for this customer, either "Company (Last, First)" or
7928 my $name = $self->contact;
7929 $name = $self->company. " ($name)" if $self->company;
7935 Returns a name string for this (service/shipping) contact, either
7936 "Company (Last, First)" or "Last, First".
7942 if ( $self->get('ship_last') ) {
7943 my $name = $self->ship_contact;
7944 $name = $self->ship_company. " ($name)" if $self->ship_company;
7953 Returns a name string for this customer, either "Company" or "First Last".
7959 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
7962 =item ship_name_short
7964 Returns a name string for this (service/shipping) contact, either "Company"
7969 sub ship_name_short {
7971 if ( $self->get('ship_last') ) {
7972 $self->ship_company !~ /^\s*$/
7973 ? $self->ship_company
7974 : $self->ship_contact_firstlast;
7976 $self->name_company_or_firstlast;
7982 Returns this customer's full (billing) contact name only, "Last, First"
7988 $self->get('last'). ', '. $self->first;
7993 Returns this customer's full (shipping) contact name only, "Last, First"
7999 $self->get('ship_last')
8000 ? $self->get('ship_last'). ', '. $self->ship_first
8004 =item contact_firstlast
8006 Returns this customers full (billing) contact name only, "First Last".
8010 sub contact_firstlast {
8012 $self->first. ' '. $self->get('last');
8015 =item ship_contact_firstlast
8017 Returns this customer's full (shipping) contact name only, "First Last".
8021 sub ship_contact_firstlast {
8023 $self->get('ship_last')
8024 ? $self->first. ' '. $self->get('ship_last')
8025 : $self->contact_firstlast;
8030 Returns this customer's full country name
8036 code2country($self->country);
8039 =item geocode DATA_VENDOR
8041 Returns a value for the customer location as encoded by DATA_VENDOR.
8042 Currently this only makes sense for "CCH" as DATA_VENDOR.
8047 my ($self, $data_vendor) = (shift, shift); #always cch for now
8049 my $geocode = $self->get('geocode'); #XXX only one data_vendor for geocode
8050 return $geocode if $geocode;
8052 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
8056 my($zip,$plus4) = split /-/, $self->get("${prefix}zip")
8057 if $self->country eq 'US';
8061 #CCH specific location stuff
8062 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
8064 my @cust_tax_location =
8066 'table' => 'cust_tax_location',
8067 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
8068 'extra_sql' => $extra_sql,
8069 'order_by' => 'ORDER BY plus4hi',#overlapping with distinct ends
8072 $geocode = $cust_tax_location[0]->geocode
8073 if scalar(@cust_tax_location);
8082 Returns a status string for this customer, currently:
8086 =item prospect - No packages have ever been ordered
8088 =item active - One or more recurring packages is active
8090 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
8092 =item suspended - All non-cancelled recurring packages are suspended
8094 =item cancelled - All recurring packages are cancelled
8100 sub status { shift->cust_status(@_); }
8104 for my $status (qw( prospect active inactive suspended cancelled )) {
8105 my $method = $status.'_sql';
8106 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
8107 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
8108 $sth->execute( ($self->custnum) x $numnum )
8109 or die "Error executing 'SELECT $sql': ". $sth->errstr;
8110 return $status if $sth->fetchrow_arrayref->[0];
8114 =item ucfirst_cust_status
8116 =item ucfirst_status
8118 Returns the status with the first character capitalized.
8122 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
8124 sub ucfirst_cust_status {
8126 ucfirst($self->cust_status);
8131 Returns a hex triplet color string for this customer's status.
8135 use vars qw(%statuscolor);
8136 tie %statuscolor, 'Tie::IxHash',
8137 'prospect' => '7e0079', #'000000', #black? naw, purple
8138 'active' => '00CC00', #green
8139 'inactive' => '0000CC', #blue
8140 'suspended' => 'FF9900', #yellow
8141 'cancelled' => 'FF0000', #red
8144 sub statuscolor { shift->cust_statuscolor(@_); }
8146 sub cust_statuscolor {
8148 $statuscolor{$self->cust_status};
8153 Returns an array of hashes representing the customer's RT tickets.
8160 my $num = $conf->config('cust_main-max_tickets') || 10;
8163 if ( $conf->config('ticket_system') ) {
8164 unless ( $conf->config('ticket_system-custom_priority_field') ) {
8166 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
8170 foreach my $priority (
8171 $conf->config('ticket_system-custom_priority_field-values'), ''
8173 last if scalar(@tickets) >= $num;
8175 @{ FS::TicketSystem->customer_tickets( $self->custnum,
8176 $num - scalar(@tickets),
8186 # Return services representing svc_accts in customer support packages
8187 sub support_services {
8189 my %packages = map { $_ => 1 } $conf->config('support_packages');
8191 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
8192 grep { $_->part_svc->svcdb eq 'svc_acct' }
8193 map { $_->cust_svc }
8194 grep { exists $packages{ $_->pkgpart } }
8195 $self->ncancelled_pkgs;
8199 # Return a list of latitude/longitude for one of the services (if any)
8200 sub service_coordinates {
8204 grep { $_->latitude && $_->longitude }
8206 map { $_->cust_svc }
8207 $self->ncancelled_pkgs;
8209 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
8214 =head1 CLASS METHODS
8220 Class method that returns the list of possible status strings for customers
8221 (see L<the status method|/status>). For example:
8223 @statuses = FS::cust_main->statuses();
8228 #my $self = shift; #could be class...
8234 Returns an SQL expression identifying prospective cust_main records (customers
8235 with no packages ever ordered)
8239 use vars qw($select_count_pkgs);
8240 $select_count_pkgs =
8241 "SELECT COUNT(*) FROM cust_pkg
8242 WHERE cust_pkg.custnum = cust_main.custnum";
8244 sub select_count_pkgs_sql {
8248 sub prospect_sql { "
8249 0 = ( $select_count_pkgs )
8254 Returns an SQL expression identifying active cust_main records (customers with
8255 active recurring packages).
8260 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
8266 Returns an SQL expression identifying inactive cust_main records (customers with
8267 no active recurring packages, but otherwise unsuspended/uncancelled).
8271 sub inactive_sql { "
8272 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
8274 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
8280 Returns an SQL expression identifying suspended cust_main records.
8285 sub suspended_sql { susp_sql(@_); }
8287 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
8289 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
8295 Returns an SQL expression identifying cancelled cust_main records.
8299 sub cancelled_sql { cancel_sql(@_); }
8302 my $recurring_sql = FS::cust_pkg->recurring_sql;
8303 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
8306 0 < ( $select_count_pkgs )
8307 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
8308 AND 0 = ( $select_count_pkgs AND $recurring_sql
8309 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
8311 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
8317 =item uncancelled_sql
8319 Returns an SQL expression identifying un-cancelled cust_main records.
8323 sub uncancelled_sql { uncancel_sql(@_); }
8324 sub uncancel_sql { "
8326 ( 0 < ( $select_count_pkgs
8327 AND ( cust_pkg.cancel IS NULL
8328 OR cust_pkg.cancel = 0
8331 OR 0 = ( $select_count_pkgs )
8337 Returns an SQL fragment to retreive the balance.
8342 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
8343 WHERE cust_bill.custnum = cust_main.custnum )
8344 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
8345 WHERE cust_pay.custnum = cust_main.custnum )
8346 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
8347 WHERE cust_credit.custnum = cust_main.custnum )
8348 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
8349 WHERE cust_refund.custnum = cust_main.custnum )
8352 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8354 Returns an SQL fragment to retreive the balance for this customer, only
8355 considering invoices with date earlier than START_TIME, and optionally not
8356 later than END_TIME (total_owed_date minus total_unapplied_credits minus
8357 total_unapplied_payments).
8359 Times are specified as SQL fragments or numeric
8360 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
8361 L<Date::Parse> for conversion functions. The empty string can be passed
8362 to disable that time constraint completely.
8364 Available options are:
8368 =item unapplied_date
8370 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)
8375 set to true to remove all customer comparison clauses, for totals
8380 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
8385 JOIN clause (typically used with the total option)
8391 sub balance_date_sql {
8392 my( $class, $start, $end, %opt ) = @_;
8394 my $cutoff = $opt{'cutoff'};
8396 my $owed = FS::cust_bill->owed_sql($cutoff);
8397 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
8398 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
8399 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
8401 my $j = $opt{'join'} || '';
8403 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
8404 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
8405 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
8406 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
8408 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
8409 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
8410 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
8411 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
8416 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
8418 Returns an SQL fragment to retreive the total unapplied payments for this
8419 customer, only considering invoices with date earlier than START_TIME, and
8420 optionally not later than END_TIME.
8422 Times are specified as SQL fragments or numeric
8423 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
8424 L<Date::Parse> for conversion functions. The empty string can be passed
8425 to disable that time constraint completely.
8427 Available options are:
8431 sub unapplied_payments_date_sql {
8432 my( $class, $start, $end, %opt ) = @_;
8434 my $cutoff = $opt{'cutoff'};
8436 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
8438 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
8439 'unapplied_date'=>1 );
8441 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
8444 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8446 Helper method for balance_date_sql; name (and usage) subject to change
8447 (suggestions welcome).
8449 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
8450 cust_refund, cust_credit or cust_pay).
8452 If TABLE is "cust_bill" or the unapplied_date option is true, only
8453 considers records with date earlier than START_TIME, and optionally not
8454 later than END_TIME .
8458 sub _money_table_where {
8459 my( $class, $table, $start, $end, %opt ) = @_;
8462 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
8463 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
8464 push @where, "$table._date <= $start" if defined($start) && length($start);
8465 push @where, "$table._date > $end" if defined($end) && length($end);
8467 push @where, @{$opt{'where'}} if $opt{'where'};
8468 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
8474 =item search HASHREF
8478 Returns a qsearch hash expression to search for parameters specified in
8479 HASHREF. Valid parameters are
8487 =item cancelled_pkgs
8493 listref of start date, end date
8503 =item current_balance
8505 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
8509 =item flattened_pkgs
8518 my ($class, $params) = @_;
8529 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
8531 "cust_main.agentnum = $1";
8538 #prospect active inactive suspended cancelled
8539 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
8540 my $method = $params->{'status'}. '_sql';
8541 #push @where, $class->$method();
8542 push @where, FS::cust_main->$method();
8546 # parse cancelled package checkbox
8551 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
8552 unless $params->{'cancelled_pkgs'};
8555 # parse without census tract checkbox
8558 push @where, "(censustract = '' or censustract is null)"
8559 if $params->{'no_censustract'};
8565 foreach my $field (qw( signupdate )) {
8567 next unless exists($params->{$field});
8569 my($beginning, $ending) = @{$params->{$field}};
8572 "cust_main.$field IS NOT NULL",
8573 "cust_main.$field >= $beginning",
8574 "cust_main.$field <= $ending";
8576 $orderby ||= "ORDER BY cust_main.$field";
8584 if ( $params->{'payby'} ) {
8586 my @payby = ref( $params->{'payby'} )
8587 ? @{ $params->{'payby'} }
8588 : ( $params->{'payby'} );
8590 @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
8592 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )'
8597 my @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
8599 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )';
8603 # paydate_year / paydate_month
8606 if ( $params->{'paydate_year'} =~ /^(\d{4})$/ ) {
8608 $params->{'paydate_month'} =~ /^(\d\d?)$/
8609 or die "paydate_year without paydate_month?";
8613 'paydate IS NOT NULL',
8615 "CAST(paydate AS timestamp) < CAST('$year-$month-01' AS timestamp )"
8623 if ( $params->{'invoice_terms'} =~ /^([\w ]+)$/ ) {
8625 if ( $1 eq 'NULL' ) {
8627 "( cust_main.invoice_terms IS NULL OR cust_main.invoice_terms = '' )";
8630 "cust_main.invoice_terms IS NOT NULL",
8631 "cust_main.invoice_terms = '$1'";
8639 if ( $params->{'current_balance'} ) {
8641 #my $balance_sql = $class->balance_sql();
8642 my $balance_sql = FS::cust_main->balance_sql();
8644 my @current_balance =
8645 ref( $params->{'current_balance'} )
8646 ? @{ $params->{'current_balance'} }
8647 : ( $params->{'current_balance'} );
8649 push @where, map { s/current_balance/$balance_sql/; $_ }
8658 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
8660 "cust_main.custbatch = '$1'";
8664 # setup queries, subs, etc. for the search
8667 $orderby ||= 'ORDER BY custnum';
8669 # here is the agent virtualization
8670 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
8672 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
8674 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
8676 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
8678 my $select = join(', ',
8679 'cust_main.custnum',
8680 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
8683 my(@extra_headers) = ();
8684 my(@extra_fields) = ();
8686 if ($params->{'flattened_pkgs'}) {
8688 if ($dbh->{Driver}->{Name} eq 'Pg') {
8690 $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";
8692 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
8693 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
8694 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
8696 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
8697 "omitting packing information from report.";
8700 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";
8702 my $sth = dbh->prepare($header_query) or die dbh->errstr;
8703 $sth->execute() or die $sth->errstr;
8704 my $headerrow = $sth->fetchrow_arrayref;
8705 my $headercount = $headerrow ? $headerrow->[0] : 0;
8706 while($headercount) {
8707 unshift @extra_headers, "Package ". $headercount;
8708 unshift @extra_fields, eval q!sub {my $c = shift;
8709 my @a = split '\|', $c->magic;
8710 my $p = $a[!.--$headercount. q!];
8718 'table' => 'cust_main',
8719 'select' => $select,
8721 'extra_sql' => $extra_sql,
8722 'order_by' => $orderby,
8723 'count_query' => $count_query,
8724 'extra_headers' => \@extra_headers,
8725 'extra_fields' => \@extra_fields,
8730 =item email_search_result HASHREF
8734 Emails a notice to the specified customers.
8736 Valid parameters are those of the L<search> method, plus the following:
8758 Optional job queue job for status updates.
8762 Returns an error message, or false for success.
8764 If an error occurs during any email, stops the enture send and returns that
8765 error. Presumably if you're getting SMTP errors aborting is better than
8766 retrying everything.
8770 sub email_search_result {
8771 my($class, $params) = @_;
8773 my $from = delete $params->{from};
8774 my $subject = delete $params->{subject};
8775 my $html_body = delete $params->{html_body};
8776 my $text_body = delete $params->{text_body};
8778 my $job = delete $params->{'job'};
8780 $params->{'payby'} = [ split(/\0/, $params->{'payby'}) ]
8781 unless ref($params->{'payby'});
8783 my $sql_query = $class->search($params);
8785 my $count_query = delete($sql_query->{'count_query'});
8786 my $count_sth = dbh->prepare($count_query)
8787 or die "Error preparing $count_query: ". dbh->errstr;
8789 or die "Error executing $count_query: ". $count_sth->errstr;
8790 my $count_arrayref = $count_sth->fetchrow_arrayref;
8791 my $num_cust = $count_arrayref->[0];
8793 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
8794 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
8797 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
8799 #eventually order+limit magic to reduce memory use?
8800 foreach my $cust_main ( qsearch($sql_query) ) {
8802 my $to = $cust_main->invoicing_list_emailonly_scalar;
8805 my $error = send_email(
8809 'subject' => $subject,
8810 'html_body' => $html_body,
8811 'text_body' => $text_body,
8814 return $error if $error;
8816 if ( $job ) { #progressbar foo
8818 if ( time - $min_sec > $last ) {
8819 my $error = $job->update_statustext(
8820 int( 100 * $num / $num_cust )
8822 die $error if $error;
8832 use Storable qw(thaw);
8835 sub process_email_search_result {
8837 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
8839 my $param = thaw(decode_base64(shift));
8840 warn Dumper($param) if $DEBUG;
8842 $param->{'job'} = $job;
8844 $param->{'payby'} = [ split(/\0/, $param->{'payby'}) ]
8845 unless ref($param->{'payby'});
8847 my $error = FS::cust_main->email_search_result( $param );
8848 die $error if $error;
8852 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
8854 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
8855 records. Currently, I<first>, I<last>, I<company> and/or I<address1> may be
8856 specified (the appropriate ship_ field is also searched).
8858 Additional options are the same as FS::Record::qsearch
8863 my( $self, $fuzzy, $hash, @opt) = @_;
8868 check_and_rebuild_fuzzyfiles();
8869 foreach my $field ( keys %$fuzzy ) {
8871 my $all = $self->all_X($field);
8872 next unless scalar(@$all);
8875 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
8878 foreach ( keys %match ) {
8879 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
8880 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
8883 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
8886 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
8888 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
8896 Returns a masked version of the named field
8901 my ($self,$field) = @_;
8905 'x'x(length($self->getfield($field))-4).
8906 substr($self->getfield($field), (length($self->getfield($field))-4));
8916 =item smart_search OPTION => VALUE ...
8918 Accepts the following options: I<search>, the string to search for. The string
8919 will be searched for as a customer number, phone number, name or company name,
8920 as an exact, or, in some cases, a substring or fuzzy match (see the source code
8921 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
8922 skip fuzzy matching when an exact match is found.
8924 Any additional options are treated as an additional qualifier on the search
8927 Returns a (possibly empty) array of FS::cust_main objects.
8934 #here is the agent virtualization
8935 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8939 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
8940 my $search = delete $options{'search'};
8941 ( my $alphanum_search = $search ) =~ s/\W//g;
8943 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
8945 #false laziness w/Record::ut_phone
8946 my $phonen = "$1-$2-$3";
8947 $phonen .= " x$4" if $4;
8949 push @cust_main, qsearch( {
8950 'table' => 'cust_main',
8951 'hashref' => { %options },
8952 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8954 join(' OR ', map "$_ = '$phonen'",
8955 qw( daytime night fax
8956 ship_daytime ship_night ship_fax )
8959 " AND $agentnums_sql", #agent virtualization
8962 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
8963 #try looking for matches with extensions unless one was specified
8965 push @cust_main, qsearch( {
8966 'table' => 'cust_main',
8967 'hashref' => { %options },
8968 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8970 join(' OR ', map "$_ LIKE '$phonen\%'",
8972 ship_daytime ship_night )
8975 " AND $agentnums_sql", #agent virtualization
8980 # custnum search (also try agent_custid), with some tweaking options if your
8981 # legacy cust "numbers" have letters
8984 if ( $search =~ /^\s*(\d+)\s*$/
8985 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
8986 && $search =~ /^\s*(\w\w?\d+)\s*$/
8988 || ( $conf->exists('address1-search' )
8989 && $search =~ /^\s*(\d+\-?\w*)\s*$/ #i.e. 1234A or 9432-D
8996 if ( $num =~ /^(\d+)$/ && $num <= 2147483647 ) { #need a bigint custnum? wow
8997 push @cust_main, qsearch( {
8998 'table' => 'cust_main',
8999 'hashref' => { 'custnum' => $num, %options },
9000 'extra_sql' => " AND $agentnums_sql", #agent virtualization
9004 push @cust_main, qsearch( {
9005 'table' => 'cust_main',
9006 'hashref' => { 'agent_custid' => $num, %options },
9007 'extra_sql' => " AND $agentnums_sql", #agent virtualization
9010 if ( $conf->exists('address1-search') ) {
9011 my $len = length($num);
9013 foreach my $prefix ( '', 'ship_' ) {
9014 push @cust_main, qsearch( {
9015 'table' => 'cust_main',
9016 'hashref' => { %options, },
9018 ( keys(%options) ? ' AND ' : ' WHERE ' ).
9019 " LOWER(SUBSTRING(${prefix}address1 FROM 1 FOR $len)) = '$num' ".
9020 " AND $agentnums_sql",
9025 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
9027 my($company, $last, $first) = ( $1, $2, $3 );
9029 # "Company (Last, First)"
9030 #this is probably something a browser remembered,
9031 #so just do an exact search (but case-insensitive, so USPS standardization
9032 #doesn't throw a wrench in the works)
9034 foreach my $prefix ( '', 'ship_' ) {
9035 push @cust_main, qsearch( {
9036 'table' => 'cust_main',
9037 'hashref' => { %options },
9039 ( keys(%options) ? ' AND ' : ' WHERE ' ).
9041 " LOWER(${prefix}first) = ". dbh->quote(lc($first)),
9042 " LOWER(${prefix}last) = ". dbh->quote(lc($last)),
9043 " LOWER(${prefix}company) = ". dbh->quote(lc($company)),
9049 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
9050 # try (ship_){last,company}
9054 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
9055 # # full strings the browser remembers won't work
9056 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
9058 use Lingua::EN::NameParse;
9059 my $NameParse = new Lingua::EN::NameParse(
9061 allow_reversed => 1,
9064 my($last, $first) = ( '', '' );
9065 #maybe disable this too and just rely on NameParse?
9066 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
9068 ($last, $first) = ( $1, $2 );
9070 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
9071 } elsif ( ! $NameParse->parse($value) ) {
9073 my %name = $NameParse->components;
9074 $first = $name{'given_name_1'};
9075 $last = $name{'surname_1'};
9079 if ( $first && $last ) {
9081 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
9084 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
9086 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
9087 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
9090 push @cust_main, qsearch( {
9091 'table' => 'cust_main',
9092 'hashref' => \%options,
9093 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
9096 # or it just be something that was typed in... (try that in a sec)
9100 my $q_value = dbh->quote($value);
9103 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
9104 $sql .= " ( LOWER(last) = $q_value
9105 OR LOWER(company) = $q_value
9106 OR LOWER(ship_last) = $q_value
9107 OR LOWER(ship_company) = $q_value
9109 $sql .= " OR LOWER(address1) = $q_value
9110 OR LOWER(ship_address1) = $q_value
9112 if $conf->exists('address1-search');
9115 push @cust_main, qsearch( {
9116 'table' => 'cust_main',
9117 'hashref' => \%options,
9118 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
9121 #no exact match, trying substring/fuzzy
9122 #always do substring & fuzzy (unless they're explicity config'ed off)
9123 #getting complaints searches are not returning enough
9124 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
9126 #still some false laziness w/search (was search/cust_main.cgi)
9131 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
9132 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
9135 if ( $first && $last ) {
9138 { 'first' => { op=>'ILIKE', value=>"%$first%" },
9139 'last' => { op=>'ILIKE', value=>"%$last%" },
9141 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
9142 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
9149 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
9150 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
9154 if ( $conf->exists('address1-search') ) {
9156 { 'address1' => { op=>'ILIKE', value=>"%$value%" }, },
9157 { 'ship_address1' => { op=>'ILIKE', value=>"%$value%" }, },
9161 foreach my $hashref ( @hashrefs ) {
9163 push @cust_main, qsearch( {
9164 'table' => 'cust_main',
9165 'hashref' => { %$hashref,
9168 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
9177 " AND $agentnums_sql", #extra_sql #agent virtualization
9180 if ( $first && $last ) {
9181 push @cust_main, FS::cust_main->fuzzy_search(
9182 { 'last' => $last, #fuzzy hashref
9183 'first' => $first }, #
9187 foreach my $field ( 'last', 'company' ) {
9189 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
9191 if ( $conf->exists('address1-search') ) {
9193 FS::cust_main->fuzzy_search( { 'address1' => $value }, @fuzopts );
9200 #eliminate duplicates
9202 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
9210 Accepts the following options: I<email>, the email address to search for. The
9211 email address will be searched for as an email invoice destination and as an
9214 #Any additional options are treated as an additional qualifier on the search
9215 #(i.e. I<agentnum>).
9217 Returns a (possibly empty) array of FS::cust_main objects (but usually just
9227 my $email = delete $options{'email'};
9229 #we're only being used by RT at the moment... no agent virtualization yet
9230 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
9234 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
9236 my ( $user, $domain ) = ( $1, $2 );
9238 warn "$me smart_search: searching for $user in domain $domain"
9244 'table' => 'cust_main_invoice',
9245 'hashref' => { 'dest' => $email },
9252 map $_->cust_svc->cust_pkg,
9254 'table' => 'svc_acct',
9255 'hashref' => { 'username' => $user, },
9257 'AND ( SELECT domain FROM svc_domain
9258 WHERE svc_acct.domsvc = svc_domain.svcnum
9259 ) = '. dbh->quote($domain),
9265 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
9267 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
9274 =item check_and_rebuild_fuzzyfiles
9278 sub check_and_rebuild_fuzzyfiles {
9279 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9280 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
9283 =item rebuild_fuzzyfiles
9287 sub rebuild_fuzzyfiles {
9289 use Fcntl qw(:flock);
9291 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9292 mkdir $dir, 0700 unless -d $dir;
9294 foreach my $fuzzy ( @fuzzyfields ) {
9296 open(LOCK,">>$dir/cust_main.$fuzzy")
9297 or die "can't open $dir/cust_main.$fuzzy: $!";
9299 or die "can't lock $dir/cust_main.$fuzzy: $!";
9301 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
9302 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
9304 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
9305 my $sth = dbh->prepare("SELECT $field FROM cust_main".
9306 " WHERE $field != '' AND $field IS NOT NULL");
9307 $sth->execute or die $sth->errstr;
9309 while ( my $row = $sth->fetchrow_arrayref ) {
9310 print CACHE $row->[0]. "\n";
9315 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
9317 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
9328 my( $self, $field ) = @_;
9329 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9330 open(CACHE,"<$dir/cust_main.$field")
9331 or die "can't open $dir/cust_main.$field: $!";
9332 my @array = map { chomp; $_; } <CACHE>;
9337 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
9341 sub append_fuzzyfiles {
9342 #my( $first, $last, $company ) = @_;
9344 &check_and_rebuild_fuzzyfiles;
9346 use Fcntl qw(:flock);
9348 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9350 foreach my $field (@fuzzyfields) {
9355 open(CACHE,">>$dir/cust_main.$field")
9356 or die "can't open $dir/cust_main.$field: $!";
9357 flock(CACHE,LOCK_EX)
9358 or die "can't lock $dir/cust_main.$field: $!";
9360 print CACHE "$value\n";
9362 flock(CACHE,LOCK_UN)
9363 or die "can't unlock $dir/cust_main.$field: $!";
9378 #warn join('-',keys %$param);
9379 my $fh = $param->{filehandle};
9380 my @fields = @{$param->{fields}};
9382 eval "use Text::CSV_XS;";
9385 my $csv = new Text::CSV_XS;
9392 local $SIG{HUP} = 'IGNORE';
9393 local $SIG{INT} = 'IGNORE';
9394 local $SIG{QUIT} = 'IGNORE';
9395 local $SIG{TERM} = 'IGNORE';
9396 local $SIG{TSTP} = 'IGNORE';
9397 local $SIG{PIPE} = 'IGNORE';
9399 my $oldAutoCommit = $FS::UID::AutoCommit;
9400 local $FS::UID::AutoCommit = 0;
9403 #while ( $columns = $csv->getline($fh) ) {
9405 while ( defined($line=<$fh>) ) {
9407 $csv->parse($line) or do {
9408 $dbh->rollback if $oldAutoCommit;
9409 return "can't parse: ". $csv->error_input();
9412 my @columns = $csv->fields();
9413 #warn join('-',@columns);
9416 foreach my $field ( @fields ) {
9417 $row{$field} = shift @columns;
9420 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
9421 unless ( $cust_main ) {
9422 $dbh->rollback if $oldAutoCommit;
9423 return "unknown custnum $row{'custnum'}";
9426 if ( $row{'amount'} > 0 ) {
9427 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
9429 $dbh->rollback if $oldAutoCommit;
9433 } elsif ( $row{'amount'} < 0 ) {
9434 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
9437 $dbh->rollback if $oldAutoCommit;
9447 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
9449 return "Empty file!" unless $imported;
9455 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9457 Deprecated. Use event notification and message templates
9458 (L<FS::msg_template>) instead.
9460 Sends a templated email notification to the customer (see L<Text::Template>).
9462 OPTIONS is a hash and may include
9464 I<from> - the email sender (default is invoice_from)
9466 I<to> - comma-separated scalar or arrayref of recipients
9467 (default is invoicing_list)
9469 I<bcc> - blind-copy recipient address (default is none)
9471 I<subject> - The subject line of the sent email notification
9472 (default is "Notice from company_name")
9474 I<extra_fields> - a hashref of name/value pairs which will be substituted
9477 The following variables are vavailable in the template.
9479 I<$first> - the customer first name
9480 I<$last> - the customer last name
9481 I<$company> - the customer company
9482 I<$payby> - a description of the method of payment for the customer
9483 # would be nice to use FS::payby::shortname
9484 I<$payinfo> - the account information used to collect for this customer
9485 I<$expdate> - the expiration of the customer payment in seconds from epoch
9490 my ($self, $template, %options) = @_;
9492 return unless $conf->exists($template);
9494 my $from = $conf->config('invoice_from', $self->agentnum)
9495 if $conf->exists('invoice_from', $self->agentnum);
9496 $from = $options{from} if exists($options{from});
9498 my $to = join(',', $self->invoicing_list_emailonly);
9499 $to = $options{to} if exists($options{to});
9501 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
9502 if $conf->exists('company_name', $self->agentnum);
9503 $subject = $options{subject} if exists($options{subject});
9505 my $notify_template = new Text::Template (TYPE => 'ARRAY',
9506 SOURCE => [ map "$_\n",
9507 $conf->config($template)]
9509 or die "can't create new Text::Template object: Text::Template::ERROR";
9510 $notify_template->compile()
9511 or die "can't compile template: Text::Template::ERROR";
9513 $FS::notify_template::_template::company_name =
9514 $conf->config('company_name', $self->agentnum);
9515 $FS::notify_template::_template::company_address =
9516 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
9518 my $paydate = $self->paydate || '2037-12-31';
9519 $FS::notify_template::_template::first = $self->first;
9520 $FS::notify_template::_template::last = $self->last;
9521 $FS::notify_template::_template::company = $self->company;
9522 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
9523 my $payby = $self->payby;
9524 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9525 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9527 #credit cards expire at the end of the month/year of their exp date
9528 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9529 $FS::notify_template::_template::payby = 'credit card';
9530 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9531 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9533 }elsif ($payby eq 'COMP') {
9534 $FS::notify_template::_template::payby = 'complimentary account';
9536 $FS::notify_template::_template::payby = 'current method';
9538 $FS::notify_template::_template::expdate = $expire_time;
9540 for (keys %{$options{extra_fields}}){
9542 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
9545 send_email(from => $from,
9547 bcc => $options{bcc},
9548 subject => $subject,
9549 body => $notify_template->fill_in( PACKAGE =>
9550 'FS::notify_template::_template' ),
9555 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9557 Generates a templated notification to the customer (see L<Text::Template>).
9559 OPTIONS is a hash and may include
9561 I<extra_fields> - a hashref of name/value pairs which will be substituted
9562 into the template. These values may override values mentioned below
9563 and those from the customer record.
9565 The following variables are available in the template instead of or in addition
9566 to the fields of the customer record.
9568 I<$payby> - a description of the method of payment for the customer
9569 # would be nice to use FS::payby::shortname
9570 I<$payinfo> - the masked account information used to collect for this customer
9571 I<$expdate> - the expiration of the customer payment method in seconds from epoch
9572 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
9576 # a lot like cust_bill::print_latex
9577 sub generate_letter {
9578 my ($self, $template, %options) = @_;
9580 return unless $conf->exists($template);
9582 my $letter_template = new Text::Template
9584 SOURCE => [ map "$_\n", $conf->config($template)],
9585 DELIMITERS => [ '[@--', '--@]' ],
9587 or die "can't create new Text::Template object: Text::Template::ERROR";
9589 $letter_template->compile()
9590 or die "can't compile template: Text::Template::ERROR";
9592 my %letter_data = map { $_ => $self->$_ } $self->fields;
9593 $letter_data{payinfo} = $self->mask_payinfo;
9595 #my $paydate = $self->paydate || '2037-12-31';
9596 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
9598 my $payby = $self->payby;
9599 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9600 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9602 #credit cards expire at the end of the month/year of their exp date
9603 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9604 $letter_data{payby} = 'credit card';
9605 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9606 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9608 }elsif ($payby eq 'COMP') {
9609 $letter_data{payby} = 'complimentary account';
9611 $letter_data{payby} = 'current method';
9613 $letter_data{expdate} = $expire_time;
9615 for (keys %{$options{extra_fields}}){
9616 $letter_data{$_} = $options{extra_fields}->{$_};
9619 unless(exists($letter_data{returnaddress})){
9620 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
9621 $self->agent_template)
9623 if ( length($retadd) ) {
9624 $letter_data{returnaddress} = $retadd;
9625 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
9626 $letter_data{returnaddress} =
9627 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
9631 ( $conf->config('company_name', $self->agentnum),
9632 $conf->config('company_address', $self->agentnum),
9636 $letter_data{returnaddress} = '~';
9640 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
9642 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
9644 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
9646 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
9650 ) or die "can't open temp file: $!\n";
9651 print $lh $conf->config_binary('logo.eps', $self->agentnum)
9652 or die "can't write temp file: $!\n";
9654 $letter_data{'logo_file'} = $lh->filename;
9656 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
9660 ) or die "can't open temp file: $!\n";
9662 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
9664 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
9665 return ($1, $letter_data{'logo_file'});
9669 =item print_ps TEMPLATE
9671 Returns an postscript letter filled in from TEMPLATE, as a scalar.
9677 my($file, $lfile) = $self->generate_letter(@_);
9678 my $ps = FS::Misc::generate_ps($file);
9679 unlink($file.'.tex');
9685 =item print TEMPLATE
9687 Prints the filled in template.
9689 TEMPLATE is the name of a L<Text::Template> to fill in and print.
9693 sub queueable_print {
9696 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
9697 or die "invalid customer number: " . $opt{custvnum};
9699 my $error = $self->print( $opt{template} );
9700 die $error if $error;
9704 my ($self, $template) = (shift, shift);
9705 do_print [ $self->print_ps($template) ];
9708 #these three subs should just go away once agent stuff is all config overrides
9710 sub agent_template {
9712 $self->_agent_plandata('agent_templatename');
9715 sub agent_invoice_from {
9717 $self->_agent_plandata('agent_invoice_from');
9720 sub _agent_plandata {
9721 my( $self, $option ) = @_;
9723 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
9724 #agent-specific Conf
9726 use FS::part_event::Condition;
9728 my $agentnum = $self->agentnum;
9731 if ( driver_name =~ /^Pg/i ) {
9733 } elsif ( driver_name =~ /^mysql/i ) {
9736 die "don't know how to use regular expressions in ". driver_name. " databases";
9739 my $part_event_option =
9741 'select' => 'part_event_option.*',
9742 'table' => 'part_event_option',
9744 LEFT JOIN part_event USING ( eventpart )
9745 LEFT JOIN part_event_option AS peo_agentnum
9746 ON ( part_event.eventpart = peo_agentnum.eventpart
9747 AND peo_agentnum.optionname = 'agentnum'
9748 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
9750 LEFT JOIN part_event_condition
9751 ON ( part_event.eventpart = part_event_condition.eventpart
9752 AND part_event_condition.conditionname = 'cust_bill_age'
9754 LEFT JOIN part_event_condition_option
9755 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
9756 AND part_event_condition_option.optionname = 'age'
9759 #'hashref' => { 'optionname' => $option },
9760 #'hashref' => { 'part_event_option.optionname' => $option },
9762 " WHERE part_event_option.optionname = ". dbh->quote($option).
9763 " AND action = 'cust_bill_send_agent' ".
9764 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
9765 " AND peo_agentnum.optionname = 'agentnum' ".
9766 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
9768 CASE WHEN part_event_condition_option.optionname IS NULL
9770 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
9772 , part_event.weight".
9776 unless ( $part_event_option ) {
9777 return $self->agent->invoice_template || ''
9778 if $option eq 'agent_templatename';
9782 $part_event_option->optionvalue;
9786 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
9788 Subroutine (not a method), designed to be called from the queue.
9790 Takes a list of options and values.
9792 Pulls up the customer record via the custnum option and calls bill_and_collect.
9797 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
9799 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
9800 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
9802 $cust_main->bill_and_collect( %args );
9805 sub _upgrade_data { #class method
9806 my ($class, %opts) = @_;
9808 my $sql = 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL';
9809 my $sth = dbh->prepare($sql) or die dbh->errstr;
9810 $sth->execute or die $sth->errstr;
9820 The delete method should possibly take an FS::cust_main object reference
9821 instead of a scalar customer number.
9823 Bill and collect options should probably be passed as references instead of a
9826 There should probably be a configuration file with a list of allowed credit
9829 No multiple currency support (probably a larger project than just this module).
9831 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
9833 Birthdates rely on negative epoch values.
9835 The payby for card/check batches is broken. With mixed batching, bad
9838 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
9842 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
9843 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
9844 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.