5 use vars qw( @ISA @EXPORT_OK $DEBUG $me $conf
7 $import $ignore_expired_card
8 $skip_fuzzyfiles @fuzzyfields
11 use vars qw( $realtime_bop_decline_quiet ); #ugh
15 use Scalar::Util qw( blessed );
16 use List::Util qw( min );
17 use Time::Local qw(timelocal);
20 use Digest::MD5 qw(md5_base64);
23 use File::Temp qw( tempfile );
24 use String::Approx qw(amatch);
25 use Business::CreditCard 0.28;
27 use FS::UID qw( getotaker dbh driver_name );
28 use FS::Record qw( qsearchs qsearch dbdef );
29 use FS::Misc qw( generate_email send_email generate_ps do_print );
30 use FS::Msgcat qw(gettext);
35 use FS::cust_bill_pkg;
36 use FS::cust_bill_pkg_display;
37 use FS::cust_bill_pkg_tax_location;
38 use FS::cust_bill_pkg_tax_rate_location;
40 use FS::cust_pay_pending;
41 use FS::cust_pay_void;
42 use FS::cust_pay_batch;
45 use FS::part_referral;
46 use FS::cust_main_county;
47 use FS::cust_location;
49 use FS::cust_main_exemption;
50 use FS::cust_tax_adjustment;
52 use FS::tax_rate_location;
53 use FS::cust_tax_location;
54 use FS::part_pkg_taxrate;
56 use FS::cust_main_invoice;
57 use FS::cust_credit_bill;
58 use FS::cust_bill_pay;
59 use FS::prepay_credit;
63 use FS::part_event_condition;
66 use FS::payment_gateway;
67 use FS::agent_payment_gateway;
69 use FS::payinfo_Mixin;
72 @ISA = qw( FS::payinfo_Mixin FS::Record );
74 @EXPORT_OK = qw( smart_search );
76 $realtime_bop_decline_quiet = 0;
78 # 1 is mostly method/subroutine entry and options
79 # 2 traces progress of some operations
80 # 3 is even more information including possibly sensitive data
82 $me = '[FS::cust_main]';
85 $ignore_expired_card = 0;
88 @fuzzyfields = ( 'first', 'last', 'company', 'address1' );
90 @encrypted_fields = ('payinfo', 'paycvv');
91 sub nohistory_fields { ('paycvv'); }
93 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
95 #ask FS::UID to run this stuff for us later
96 #$FS::UID::callback{'FS::cust_main'} = sub {
97 install_callback FS::UID sub {
99 #yes, need it for stuff below (prolly should be cached)
104 my ( $hashref, $cache ) = @_;
105 if ( exists $hashref->{'pkgnum'} ) {
106 #@{ $self->{'_pkgnum'} } = ();
107 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
108 $self->{'_pkgnum'} = $subcache;
109 #push @{ $self->{'_pkgnum'} },
110 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
116 FS::cust_main - Object methods for cust_main records
122 $record = new FS::cust_main \%hash;
123 $record = new FS::cust_main { 'column' => 'value' };
125 $error = $record->insert;
127 $error = $new_record->replace($old_record);
129 $error = $record->delete;
131 $error = $record->check;
133 @cust_pkg = $record->all_pkgs;
135 @cust_pkg = $record->ncancelled_pkgs;
137 @cust_pkg = $record->suspended_pkgs;
139 $error = $record->bill;
140 $error = $record->bill %options;
141 $error = $record->bill 'time' => $time;
143 $error = $record->collect;
144 $error = $record->collect %options;
145 $error = $record->collect 'invoice_time' => $time,
150 An FS::cust_main object represents a customer. FS::cust_main inherits from
151 FS::Record. The following fields are currently supported:
157 Primary key (assigned automatically for new customers)
161 Agent (see L<FS::agent>)
165 Advertising source (see L<FS::part_referral>)
177 Cocial security number (optional)
193 (optional, see L<FS::cust_main_county>)
197 (see L<FS::cust_main_county>)
203 (see L<FS::cust_main_county>)
239 (optional, see L<FS::cust_main_county>)
243 (see L<FS::cust_main_county>)
249 (see L<FS::cust_main_county>)
265 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
269 Payment Information (See L<FS::payinfo_Mixin> for data format)
273 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
277 Card Verification Value, "CVV2" (also known as CVC2 or CID), the 3 or 4 digit number on the back (or front, for American Express) of the credit card
281 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
285 Start date month (maestro/solo cards only)
289 Start date year (maestro/solo cards only)
293 Issue number (maestro/solo cards only)
297 Name on card or billing name
301 IP address from which payment information was received
305 Tax exempt, empty or `Y'
309 Order taker (assigned automatically, see L<FS::UID>)
315 =item referral_custnum
317 Referring customer number
321 Enable individual CDR spooling, empty or `Y'
325 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
329 Discourage individual CDR printing, empty or `Y'
339 Creates a new customer. To add the customer to the database, see L<"insert">.
341 Note that this stores the hash reference, not a distinct copy of the hash it
342 points to. You can ask the object for a copy with the I<hash> method.
346 sub table { 'cust_main'; }
348 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
350 Adds this customer to the database. If there is an error, returns the error,
351 otherwise returns false.
353 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
354 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
355 are inserted atomicly, or the transaction is rolled back. Passing an empty
356 hash reference is equivalent to not supplying this parameter. There should be
357 a better explanation of this, but until then, here's an example:
360 tie %hash, 'Tie::RefHash'; #this part is important
362 $cust_pkg => [ $svc_acct ],
365 $cust_main->insert( \%hash );
367 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
368 be set as the invoicing list (see L<"invoicing_list">). Errors return as
369 expected and rollback the entire transaction; it is not necessary to call
370 check_invoicing_list first. The invoicing_list is set after the records in the
371 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
372 invoicing_list destination to the newly-created svc_acct. Here's an example:
374 $cust_main->insert( {}, [ $email, 'POST' ] );
376 Currently available options are: I<depend_jobnum>, I<noexport> and I<tax_exemption>.
378 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
379 on the supplied jobnum (they will not run until the specific job completes).
380 This can be used to defer provisioning until some action completes (such
381 as running the customer's credit card successfully).
383 The I<noexport> option is deprecated. If I<noexport> is set true, no
384 provisioning jobs (exports) are scheduled. (You can schedule them later with
385 the B<reexport> method.)
387 The I<tax_exemption> option can be set to an arrayref of tax names.
388 FS::cust_main_exemption records will be created and inserted.
394 my $cust_pkgs = @_ ? shift : {};
395 my $invoicing_list = @_ ? shift : '';
397 warn "$me insert called with options ".
398 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
401 local $SIG{HUP} = 'IGNORE';
402 local $SIG{INT} = 'IGNORE';
403 local $SIG{QUIT} = 'IGNORE';
404 local $SIG{TERM} = 'IGNORE';
405 local $SIG{TSTP} = 'IGNORE';
406 local $SIG{PIPE} = 'IGNORE';
408 my $oldAutoCommit = $FS::UID::AutoCommit;
409 local $FS::UID::AutoCommit = 0;
412 my $prepay_identifier = '';
413 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
415 if ( $self->payby eq 'PREPAY' ) {
417 $self->payby('BILL');
418 $prepay_identifier = $self->payinfo;
421 warn " looking up prepaid card $prepay_identifier\n"
424 my $error = $self->get_prepay( $prepay_identifier,
425 'amount_ref' => \$amount,
426 'seconds_ref' => \$seconds,
427 'upbytes_ref' => \$upbytes,
428 'downbytes_ref' => \$downbytes,
429 'totalbytes_ref' => \$totalbytes,
432 $dbh->rollback if $oldAutoCommit;
433 #return "error applying prepaid card (transaction rolled back): $error";
437 $payby = 'PREP' if $amount;
439 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
442 $self->payby('BILL');
443 $amount = $self->paid;
447 warn " inserting $self\n"
450 $self->signupdate(time) unless $self->signupdate;
452 $self->auto_agent_custid()
453 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
455 my $error = $self->SUPER::insert;
457 $dbh->rollback if $oldAutoCommit;
458 #return "inserting cust_main record (transaction rolled back): $error";
462 warn " setting invoicing list\n"
465 if ( $invoicing_list ) {
466 $error = $self->check_invoicing_list( $invoicing_list );
468 $dbh->rollback if $oldAutoCommit;
469 #return "checking invoicing_list (transaction rolled back): $error";
472 $self->invoicing_list( $invoicing_list );
475 warn " setting cust_main_exemption\n"
478 my $tax_exemption = delete $options{'tax_exemption'};
479 if ( $tax_exemption ) {
480 foreach my $taxname ( @$tax_exemption ) {
481 my $cust_main_exemption = new FS::cust_main_exemption {
482 'custnum' => $self->custnum,
483 'taxname' => $taxname,
485 my $error = $cust_main_exemption->insert;
487 $dbh->rollback if $oldAutoCommit;
488 return "inserting cust_main_exemption (transaction rolled back): $error";
493 if ( $conf->config('cust_main-skeleton_tables')
494 && $conf->config('cust_main-skeleton_custnum') ) {
496 warn " inserting skeleton records\n"
499 my $error = $self->start_copy_skel;
501 $dbh->rollback if $oldAutoCommit;
507 warn " ordering packages\n"
510 $error = $self->order_pkgs( $cust_pkgs,
512 'seconds_ref' => \$seconds,
513 'upbytes_ref' => \$upbytes,
514 'downbytes_ref' => \$downbytes,
515 'totalbytes_ref' => \$totalbytes,
518 $dbh->rollback if $oldAutoCommit;
523 $dbh->rollback if $oldAutoCommit;
524 return "No svc_acct record to apply pre-paid time";
526 if ( $upbytes || $downbytes || $totalbytes ) {
527 $dbh->rollback if $oldAutoCommit;
528 return "No svc_acct record to apply pre-paid data";
532 warn " inserting initial $payby payment of $amount\n"
534 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
536 $dbh->rollback if $oldAutoCommit;
537 return "inserting payment (transaction rolled back): $error";
541 unless ( $import || $skip_fuzzyfiles ) {
542 warn " queueing fuzzyfiles update\n"
544 $error = $self->queue_fuzzyfiles_update;
546 $dbh->rollback if $oldAutoCommit;
547 return "updating fuzzy search cache: $error";
551 warn " insert complete; committing transaction\n"
554 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
559 use File::CounterFile;
560 sub auto_agent_custid {
563 my $format = $conf->config('cust_main-auto_agent_custid');
565 if ( $format eq '1YMMXXXXXXXX' ) {
567 my $counter = new File::CounterFile 'cust_main.agent_custid';
570 my $ym = 100000000000 + time2str('%y%m00000000', time);
571 if ( $ym > $counter->value ) {
572 $counter->{'value'} = $agent_custid = $ym;
573 $counter->{'updated'} = 1;
575 $agent_custid = $counter->inc;
581 die "Unknown cust_main-auto_agent_custid format: $format";
584 $self->agent_custid($agent_custid);
588 sub start_copy_skel {
591 #'mg_user_preference' => {},
592 #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
593 #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
594 #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
595 #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
596 my @tables = eval(join('\n',$conf->config('cust_main-skeleton_tables')));
599 _copy_skel( 'cust_main', #tablename
600 $conf->config('cust_main-skeleton_custnum'), #sourceid
601 $self->custnum, #destid
602 @tables, #child tables
606 #recursive subroutine, not a method
608 my( $table, $sourceid, $destid, %child_tables ) = @_;
611 if ( $table =~ /^(\w+)\.(\w+)$/ ) {
612 ( $table, $primary_key ) = ( $1, $2 );
614 my $dbdef_table = dbdef->table($table);
615 $primary_key = $dbdef_table->primary_key
616 or return "$table has no primary key".
617 " (or do you need to run dbdef-create?)";
620 warn " _copy_skel: $table.$primary_key $sourceid to $destid for ".
621 join (', ', keys %child_tables). "\n"
624 foreach my $child_table_def ( keys %child_tables ) {
628 if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
629 ( $child_table, $child_pkey ) = ( $1, $2 );
631 $child_table = $child_table_def;
633 $child_pkey = dbdef->table($child_table)->primary_key;
634 # or return "$table has no primary key".
635 # " (or do you need to run dbdef-create?)\n";
639 if ( keys %{ $child_tables{$child_table_def} } ) {
641 return "$child_table has no primary key".
642 " (run dbdef-create or try specifying it?)\n"
645 #false laziness w/Record::insert and only works on Pg
646 #refactor the proper last-inserted-id stuff out of Record::insert if this
647 # ever gets use for anything besides a quick kludge for one customer
648 my $default = dbdef->table($child_table)->column($child_pkey)->default;
649 $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
650 or return "can't parse $child_table.$child_pkey default value ".
651 " for sequence name: $default";
656 my @sel_columns = grep { $_ ne $primary_key }
657 dbdef->table($child_table)->columns;
658 my $sel_columns = join(', ', @sel_columns );
660 my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
661 my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
662 my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
664 my $sel_st = "SELECT $sel_columns FROM $child_table".
665 " WHERE $primary_key = $sourceid";
668 my $sel_sth = dbh->prepare( $sel_st )
669 or return dbh->errstr;
671 $sel_sth->execute or return $sel_sth->errstr;
673 while ( my $row = $sel_sth->fetchrow_hashref ) {
675 warn " selected row: ".
676 join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
680 "INSERT INTO $child_table $ins_columns VALUES $placeholders";
681 my $ins_sth =dbh->prepare($statement)
682 or return dbh->errstr;
683 my @param = ( $destid, map $row->{$_}, @ins_columns );
684 warn " $statement: [ ". join(', ', @param). " ]\n"
686 $ins_sth->execute( @param )
687 or return $ins_sth->errstr;
689 #next unless keys %{ $child_tables{$child_table} };
690 next unless $sequence;
692 #another section of that laziness
693 my $seq_sql = "SELECT currval('$sequence')";
694 my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
695 $seq_sth->execute or return $seq_sth->errstr;
696 my $insertid = $seq_sth->fetchrow_arrayref->[0];
698 # don't drink soap! recurse! recurse! okay!
700 _copy_skel( $child_table_def,
701 $row->{$child_pkey}, #sourceid
703 %{ $child_tables{$child_table_def} },
705 return $error if $error;
715 =item order_pkg HASHREF | OPTION => VALUE ...
717 Orders a single package.
719 Options may be passed as a list of key/value pairs or as a hash reference.
730 Optional FS::cust_location object
734 Optional arryaref of FS::svc_* service objects.
738 If this option is set to a job queue jobnum (see L<FS::queue>), all provisioning
739 jobs will have a dependancy on the supplied job (they will not run until the
740 specific job completes). This can be used to defer provisioning until some
741 action completes (such as running the customer's credit card successfully).
745 Optional subject for a ticket created and attached to this customer
749 Optional queue name for ticket additions
757 my $opt = ref($_[0]) ? shift : { @_ };
759 warn "$me order_pkg called with options ".
760 join(', ', map { "$_: $opt->{$_}" } keys %$opt ). "\n"
763 my $cust_pkg = $opt->{'cust_pkg'};
764 my $svcs = $opt->{'svcs'} || [];
766 my %svc_options = ();
767 $svc_options{'depend_jobnum'} = $opt->{'depend_jobnum'}
768 if exists($opt->{'depend_jobnum'}) && $opt->{'depend_jobnum'};
770 my %insert_params = map { $opt->{$_} ? ( $_ => $opt->{$_} ) : () }
771 qw( ticket_subject ticket_queue );
773 local $SIG{HUP} = 'IGNORE';
774 local $SIG{INT} = 'IGNORE';
775 local $SIG{QUIT} = 'IGNORE';
776 local $SIG{TERM} = 'IGNORE';
777 local $SIG{TSTP} = 'IGNORE';
778 local $SIG{PIPE} = 'IGNORE';
780 my $oldAutoCommit = $FS::UID::AutoCommit;
781 local $FS::UID::AutoCommit = 0;
784 if ( $opt->{'cust_location'} &&
785 ( ! $cust_pkg->locationnum || $cust_pkg->locationnum == -1 ) ) {
786 my $error = $opt->{'cust_location'}->insert;
788 $dbh->rollback if $oldAutoCommit;
789 return "inserting cust_location (transaction rolled back): $error";
791 $cust_pkg->locationnum($opt->{'cust_location'}->locationnum);
794 $cust_pkg->custnum( $self->custnum );
796 my $error = $cust_pkg->insert( %insert_params );
798 $dbh->rollback if $oldAutoCommit;
799 return "inserting cust_pkg (transaction rolled back): $error";
802 foreach my $svc_something ( @{ $opt->{'svcs'} } ) {
803 if ( $svc_something->svcnum ) {
804 my $old_cust_svc = $svc_something->cust_svc;
805 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
806 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
807 $error = $new_cust_svc->replace($old_cust_svc);
809 $svc_something->pkgnum( $cust_pkg->pkgnum );
810 if ( $svc_something->isa('FS::svc_acct') ) {
811 foreach ( grep { $opt->{$_.'_ref'} && ${ $opt->{$_.'_ref'} } }
812 qw( seconds upbytes downbytes totalbytes ) ) {
813 $svc_something->$_( $svc_something->$_() + ${ $opt->{$_.'_ref'} } );
814 ${ $opt->{$_.'_ref'} } = 0;
817 $error = $svc_something->insert(%svc_options);
820 $dbh->rollback if $oldAutoCommit;
821 return "inserting svc_ (transaction rolled back): $error";
825 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
830 #deprecated #=item order_pkgs HASHREF [ , SECONDSREF ] [ , OPTION => VALUE ... ]
831 =item order_pkgs HASHREF [ , OPTION => VALUE ... ]
833 Like the insert method on an existing record, this method orders multiple
834 packages and included services atomicaly. Pass a Tie::RefHash data structure
835 to this method containing FS::cust_pkg and FS::svc_I<tablename> objects.
836 There should be a better explanation of this, but until then, here's an
840 tie %hash, 'Tie::RefHash'; #this part is important
842 $cust_pkg => [ $svc_acct ],
845 $cust_main->order_pkgs( \%hash, 'noexport'=>1 );
847 Services can be new, in which case they are inserted, or existing unaudited
848 services, in which case they are linked to the newly-created package.
850 Currently available options are: I<depend_jobnum>, I<noexport>, I<seconds_ref>,
851 I<upbytes_ref>, I<downbytes_ref>, and I<totalbytes_ref>.
853 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
854 on the supplied jobnum (they will not run until the specific job completes).
855 This can be used to defer provisioning until some action completes (such
856 as running the customer's credit card successfully).
858 The I<noexport> option is deprecated. If I<noexport> is set true, no
859 provisioning jobs (exports) are scheduled. (You can schedule them later with
860 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
861 on the cust_main object is not recommended, as existing services will also be
864 If I<seconds_ref>, I<upbytes_ref>, I<downbytes_ref>, or I<totalbytes_ref> is
865 provided, the scalars (provided by references) will be incremented by the
866 values of the prepaid card.`
872 my $cust_pkgs = shift;
873 my $seconds_ref = ref($_[0]) ? shift : ''; #deprecated
875 $seconds_ref ||= $options{'seconds_ref'};
877 warn "$me order_pkgs called with options ".
878 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
881 local $SIG{HUP} = 'IGNORE';
882 local $SIG{INT} = 'IGNORE';
883 local $SIG{QUIT} = 'IGNORE';
884 local $SIG{TERM} = 'IGNORE';
885 local $SIG{TSTP} = 'IGNORE';
886 local $SIG{PIPE} = 'IGNORE';
888 my $oldAutoCommit = $FS::UID::AutoCommit;
889 local $FS::UID::AutoCommit = 0;
892 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
894 foreach my $cust_pkg ( keys %$cust_pkgs ) {
896 my $error = $self->order_pkg(
897 'cust_pkg' => $cust_pkg,
898 'svcs' => $cust_pkgs->{$cust_pkg},
899 'seconds_ref' => $seconds_ref,
900 map { $_ => $options{$_} } qw( upbytes_ref downbytes_ref totalbytes_ref
905 $dbh->rollback if $oldAutoCommit;
911 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
915 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
917 Recharges this (existing) customer with the specified prepaid card (see
918 L<FS::prepay_credit>), specified either by I<identifier> or as an
919 FS::prepay_credit object. If there is an error, returns the error, otherwise
922 Optionally, five scalar references can be passed as well. They will have their
923 values filled in with the amount, number of seconds, and number of upload,
924 download, and total bytes applied by this prepaid card.
928 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
929 #the only place that uses these args
930 sub recharge_prepay {
931 my( $self, $prepay_credit, $amountref, $secondsref,
932 $upbytesref, $downbytesref, $totalbytesref ) = @_;
934 local $SIG{HUP} = 'IGNORE';
935 local $SIG{INT} = 'IGNORE';
936 local $SIG{QUIT} = 'IGNORE';
937 local $SIG{TERM} = 'IGNORE';
938 local $SIG{TSTP} = 'IGNORE';
939 local $SIG{PIPE} = 'IGNORE';
941 my $oldAutoCommit = $FS::UID::AutoCommit;
942 local $FS::UID::AutoCommit = 0;
945 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
947 my $error = $self->get_prepay( $prepay_credit,
948 'amount_ref' => \$amount,
949 'seconds_ref' => \$seconds,
950 'upbytes_ref' => \$upbytes,
951 'downbytes_ref' => \$downbytes,
952 'totalbytes_ref' => \$totalbytes,
954 || $self->increment_seconds($seconds)
955 || $self->increment_upbytes($upbytes)
956 || $self->increment_downbytes($downbytes)
957 || $self->increment_totalbytes($totalbytes)
958 || $self->insert_cust_pay_prepay( $amount,
960 ? $prepay_credit->identifier
965 $dbh->rollback if $oldAutoCommit;
969 if ( defined($amountref) ) { $$amountref = $amount; }
970 if ( defined($secondsref) ) { $$secondsref = $seconds; }
971 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
972 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
973 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
975 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
980 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
982 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
983 specified either by I<identifier> or as an FS::prepay_credit object.
985 Available options are: I<amount_ref>, I<seconds_ref>, I<upbytes_ref>, I<downbytes_ref>, and I<totalbytes_ref>. The scalars (provided by references) will be
986 incremented by the values of the prepaid card.
988 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
989 check or set this customer's I<agentnum>.
991 If there is an error, returns the error, otherwise returns false.
997 my( $self, $prepay_credit, %opt ) = @_;
999 local $SIG{HUP} = 'IGNORE';
1000 local $SIG{INT} = 'IGNORE';
1001 local $SIG{QUIT} = 'IGNORE';
1002 local $SIG{TERM} = 'IGNORE';
1003 local $SIG{TSTP} = 'IGNORE';
1004 local $SIG{PIPE} = 'IGNORE';
1006 my $oldAutoCommit = $FS::UID::AutoCommit;
1007 local $FS::UID::AutoCommit = 0;
1010 unless ( ref($prepay_credit) ) {
1012 my $identifier = $prepay_credit;
1014 $prepay_credit = qsearchs(
1016 { 'identifier' => $prepay_credit },
1021 unless ( $prepay_credit ) {
1022 $dbh->rollback if $oldAutoCommit;
1023 return "Invalid prepaid card: ". $identifier;
1028 if ( $prepay_credit->agentnum ) {
1029 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
1030 $dbh->rollback if $oldAutoCommit;
1031 return "prepaid card not valid for agent ". $self->agentnum;
1033 $self->agentnum($prepay_credit->agentnum);
1036 my $error = $prepay_credit->delete;
1038 $dbh->rollback if $oldAutoCommit;
1039 return "removing prepay_credit (transaction rolled back): $error";
1042 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
1043 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
1045 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1050 =item increment_upbytes SECONDS
1052 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1053 the specified number of upbytes. If there is an error, returns the error,
1054 otherwise returns false.
1058 sub increment_upbytes {
1059 _increment_column( shift, 'upbytes', @_);
1062 =item increment_downbytes SECONDS
1064 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1065 the specified number of downbytes. If there is an error, returns the error,
1066 otherwise returns false.
1070 sub increment_downbytes {
1071 _increment_column( shift, 'downbytes', @_);
1074 =item increment_totalbytes SECONDS
1076 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1077 the specified number of totalbytes. If there is an error, returns the error,
1078 otherwise returns false.
1082 sub increment_totalbytes {
1083 _increment_column( shift, 'totalbytes', @_);
1086 =item increment_seconds SECONDS
1088 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1089 the specified number of seconds. If there is an error, returns the error,
1090 otherwise returns false.
1094 sub increment_seconds {
1095 _increment_column( shift, 'seconds', @_);
1098 =item _increment_column AMOUNT
1100 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1101 the specified number of seconds or bytes. If there is an error, returns
1102 the error, otherwise returns false.
1106 sub _increment_column {
1107 my( $self, $column, $amount ) = @_;
1108 warn "$me increment_column called: $column, $amount\n"
1111 return '' unless $amount;
1113 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1114 $self->ncancelled_pkgs;
1116 if ( ! @cust_pkg ) {
1117 return 'No packages with primary or single services found'.
1118 ' to apply pre-paid time';
1119 } elsif ( scalar(@cust_pkg) > 1 ) {
1120 #maybe have a way to specify the package/account?
1121 return 'Multiple packages found to apply pre-paid time';
1124 my $cust_pkg = $cust_pkg[0];
1125 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1129 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1131 if ( ! @cust_svc ) {
1132 return 'No account found to apply pre-paid time';
1133 } elsif ( scalar(@cust_svc) > 1 ) {
1134 return 'Multiple accounts found to apply pre-paid time';
1137 my $svc_acct = $cust_svc[0]->svc_x;
1138 warn " found service svcnum ". $svc_acct->pkgnum.
1139 ' ('. $svc_acct->email. ")\n"
1142 $column = "increment_$column";
1143 $svc_acct->$column($amount);
1147 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1149 Inserts a prepayment in the specified amount for this customer. An optional
1150 second argument can specify the prepayment identifier for tracking purposes.
1151 If there is an error, returns the error, otherwise returns false.
1155 sub insert_cust_pay_prepay {
1156 shift->insert_cust_pay('PREP', @_);
1159 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1161 Inserts a cash payment in the specified amount for this customer. An optional
1162 second argument can specify the payment identifier for tracking purposes.
1163 If there is an error, returns the error, otherwise returns false.
1167 sub insert_cust_pay_cash {
1168 shift->insert_cust_pay('CASH', @_);
1171 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1173 Inserts a Western Union payment in the specified amount for this customer. An
1174 optional second argument can specify the prepayment identifier for tracking
1175 purposes. If there is an error, returns the error, otherwise returns false.
1179 sub insert_cust_pay_west {
1180 shift->insert_cust_pay('WEST', @_);
1183 sub insert_cust_pay {
1184 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1185 my $payinfo = scalar(@_) ? shift : '';
1187 my $cust_pay = new FS::cust_pay {
1188 'custnum' => $self->custnum,
1189 'paid' => sprintf('%.2f', $amount),
1190 #'_date' => #date the prepaid card was purchased???
1192 'payinfo' => $payinfo,
1200 This method is deprecated. See the I<depend_jobnum> option to the insert and
1201 order_pkgs methods for a better way to defer provisioning.
1203 Re-schedules all exports by calling the B<reexport> method of all associated
1204 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
1205 otherwise returns false.
1212 carp "WARNING: FS::cust_main::reexport is deprectated; ".
1213 "use the depend_jobnum option to insert or order_pkgs to delay export";
1215 local $SIG{HUP} = 'IGNORE';
1216 local $SIG{INT} = 'IGNORE';
1217 local $SIG{QUIT} = 'IGNORE';
1218 local $SIG{TERM} = 'IGNORE';
1219 local $SIG{TSTP} = 'IGNORE';
1220 local $SIG{PIPE} = 'IGNORE';
1222 my $oldAutoCommit = $FS::UID::AutoCommit;
1223 local $FS::UID::AutoCommit = 0;
1226 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1227 my $error = $cust_pkg->reexport;
1229 $dbh->rollback if $oldAutoCommit;
1234 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1239 =item delete NEW_CUSTNUM
1241 This deletes the customer. If there is an error, returns the error, otherwise
1244 This will completely remove all traces of the customer record. This is not
1245 what you want when a customer cancels service; for that, cancel all of the
1246 customer's packages (see L</cancel>).
1248 If the customer has any uncancelled packages, you need to pass a new (valid)
1249 customer number for those packages to be transferred to. Cancelled packages
1250 will be deleted. Did I mention that this is NOT what you want when a customer
1251 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
1253 You can't delete a customer with invoices (see L<FS::cust_bill>),
1254 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
1255 refunds (see L<FS::cust_refund>).
1262 local $SIG{HUP} = 'IGNORE';
1263 local $SIG{INT} = 'IGNORE';
1264 local $SIG{QUIT} = 'IGNORE';
1265 local $SIG{TERM} = 'IGNORE';
1266 local $SIG{TSTP} = 'IGNORE';
1267 local $SIG{PIPE} = 'IGNORE';
1269 my $oldAutoCommit = $FS::UID::AutoCommit;
1270 local $FS::UID::AutoCommit = 0;
1273 if ( $self->cust_bill ) {
1274 $dbh->rollback if $oldAutoCommit;
1275 return "Can't delete a customer with invoices";
1277 if ( $self->cust_credit ) {
1278 $dbh->rollback if $oldAutoCommit;
1279 return "Can't delete a customer with credits";
1281 if ( $self->cust_pay ) {
1282 $dbh->rollback if $oldAutoCommit;
1283 return "Can't delete a customer with payments";
1285 if ( $self->cust_refund ) {
1286 $dbh->rollback if $oldAutoCommit;
1287 return "Can't delete a customer with refunds";
1290 my @cust_pkg = $self->ncancelled_pkgs;
1292 my $new_custnum = shift;
1293 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1294 $dbh->rollback if $oldAutoCommit;
1295 return "Invalid new customer number: $new_custnum";
1297 foreach my $cust_pkg ( @cust_pkg ) {
1298 my %hash = $cust_pkg->hash;
1299 $hash{'custnum'} = $new_custnum;
1300 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1301 my $error = $new_cust_pkg->replace($cust_pkg,
1302 options => { $cust_pkg->options },
1305 $dbh->rollback if $oldAutoCommit;
1310 my @cancelled_cust_pkg = $self->all_pkgs;
1311 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1312 my $error = $cust_pkg->delete;
1314 $dbh->rollback if $oldAutoCommit;
1319 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1320 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1322 my $error = $cust_main_invoice->delete;
1324 $dbh->rollback if $oldAutoCommit;
1329 foreach my $cust_main_exemption (
1330 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } )
1332 my $error = $cust_main_exemption->delete;
1334 $dbh->rollback if $oldAutoCommit;
1339 my $error = $self->SUPER::delete;
1341 $dbh->rollback if $oldAutoCommit;
1345 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1350 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1353 Replaces the OLD_RECORD with this one in the database. If there is an error,
1354 returns the error, otherwise returns false.
1356 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1357 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1358 expected and rollback the entire transaction; it is not necessary to call
1359 check_invoicing_list first. Here's an example:
1361 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1363 Currently available options are: I<tax_exemption>.
1365 The I<tax_exemption> option can be set to an arrayref of tax names.
1366 FS::cust_main_exemption records will be deleted and inserted as appropriate.
1373 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1375 : $self->replace_old;
1379 warn "$me replace called\n"
1382 my $curuser = $FS::CurrentUser::CurrentUser;
1383 if ( $self->payby eq 'COMP'
1384 && $self->payby ne $old->payby
1385 && ! $curuser->access_right('Complimentary customer')
1388 return "You are not permitted to create complimentary accounts.";
1391 local($ignore_expired_card) = 1
1392 if $old->payby =~ /^(CARD|DCRD)$/
1393 && $self->payby =~ /^(CARD|DCRD)$/
1394 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1396 local $SIG{HUP} = 'IGNORE';
1397 local $SIG{INT} = 'IGNORE';
1398 local $SIG{QUIT} = 'IGNORE';
1399 local $SIG{TERM} = 'IGNORE';
1400 local $SIG{TSTP} = 'IGNORE';
1401 local $SIG{PIPE} = 'IGNORE';
1403 my $oldAutoCommit = $FS::UID::AutoCommit;
1404 local $FS::UID::AutoCommit = 0;
1407 my $error = $self->SUPER::replace($old);
1410 $dbh->rollback if $oldAutoCommit;
1414 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1415 my $invoicing_list = shift @param;
1416 $error = $self->check_invoicing_list( $invoicing_list );
1418 $dbh->rollback if $oldAutoCommit;
1421 $self->invoicing_list( $invoicing_list );
1424 my %options = @param;
1426 my $tax_exemption = delete $options{'tax_exemption'};
1427 if ( $tax_exemption ) {
1429 my %cust_main_exemption =
1430 map { $_->taxname => $_ }
1431 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1433 foreach my $taxname ( @$tax_exemption ) {
1435 next if delete $cust_main_exemption{$taxname};
1437 my $cust_main_exemption = new FS::cust_main_exemption {
1438 'custnum' => $self->custnum,
1439 'taxname' => $taxname,
1441 my $error = $cust_main_exemption->insert;
1443 $dbh->rollback if $oldAutoCommit;
1444 return "inserting cust_main_exemption (transaction rolled back): $error";
1448 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1449 my $error = $cust_main_exemption->delete;
1451 $dbh->rollback if $oldAutoCommit;
1452 return "deleting cust_main_exemption (transaction rolled back): $error";
1458 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1459 grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1460 # card/check/lec info has changed, want to retry realtime_ invoice events
1461 my $error = $self->retry_realtime;
1463 $dbh->rollback if $oldAutoCommit;
1468 unless ( $import || $skip_fuzzyfiles ) {
1469 $error = $self->queue_fuzzyfiles_update;
1471 $dbh->rollback if $oldAutoCommit;
1472 return "updating fuzzy search cache: $error";
1476 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1481 =item queue_fuzzyfiles_update
1483 Used by insert & replace to update the fuzzy search cache
1487 sub queue_fuzzyfiles_update {
1490 local $SIG{HUP} = 'IGNORE';
1491 local $SIG{INT} = 'IGNORE';
1492 local $SIG{QUIT} = 'IGNORE';
1493 local $SIG{TERM} = 'IGNORE';
1494 local $SIG{TSTP} = 'IGNORE';
1495 local $SIG{PIPE} = 'IGNORE';
1497 my $oldAutoCommit = $FS::UID::AutoCommit;
1498 local $FS::UID::AutoCommit = 0;
1501 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1502 my $error = $queue->insert( map $self->getfield($_), @fuzzyfields );
1504 $dbh->rollback if $oldAutoCommit;
1505 return "queueing job (transaction rolled back): $error";
1508 if ( $self->ship_last ) {
1509 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1510 $error = $queue->insert( map $self->getfield("ship_$_"), @fuzzyfields );
1512 $dbh->rollback if $oldAutoCommit;
1513 return "queueing job (transaction rolled back): $error";
1517 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1524 Checks all fields to make sure this is a valid customer record. If there is
1525 an error, returns the error, otherwise returns false. Called by the insert
1526 and replace methods.
1533 warn "$me check BEFORE: \n". $self->_dump
1537 $self->ut_numbern('custnum')
1538 || $self->ut_number('agentnum')
1539 || $self->ut_textn('agent_custid')
1540 || $self->ut_number('refnum')
1541 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1542 || $self->ut_textn('custbatch')
1543 || $self->ut_name('last')
1544 || $self->ut_name('first')
1545 || $self->ut_snumbern('birthdate')
1546 || $self->ut_snumbern('signupdate')
1547 || $self->ut_textn('company')
1548 || $self->ut_text('address1')
1549 || $self->ut_textn('address2')
1550 || $self->ut_text('city')
1551 || $self->ut_textn('county')
1552 || $self->ut_textn('state')
1553 || $self->ut_country('country')
1554 || $self->ut_anything('comments')
1555 || $self->ut_numbern('referral_custnum')
1556 || $self->ut_textn('stateid')
1557 || $self->ut_textn('stateid_state')
1558 || $self->ut_textn('invoice_terms')
1559 || $self->ut_alphan('geocode')
1560 || $self->ut_floatn('cdr_termination_percentage')
1563 #barf. need message catalogs. i18n. etc.
1564 $error .= "Please select an advertising source."
1565 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1566 return $error if $error;
1568 return "Unknown agent"
1569 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1571 return "Unknown refnum"
1572 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1574 return "Unknown referring custnum: ". $self->referral_custnum
1575 unless ! $self->referral_custnum
1576 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1578 if ( $self->censustract ne '' ) {
1579 $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
1580 or return "Illegal census tract: ". $self->censustract;
1582 $self->censustract("$1.$2");
1585 if ( $self->ss eq '' ) {
1590 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1591 or return "Illegal social security number: ". $self->ss;
1592 $self->ss("$1-$2-$3");
1596 # bad idea to disable, causes billing to fail because of no tax rates later
1597 # unless ( $import ) {
1598 unless ( qsearch('cust_main_county', {
1599 'country' => $self->country,
1602 return "Unknown state/county/country: ".
1603 $self->state. "/". $self->county. "/". $self->country
1604 unless qsearch('cust_main_county',{
1605 'state' => $self->state,
1606 'county' => $self->county,
1607 'country' => $self->country,
1613 $self->ut_phonen('daytime', $self->country)
1614 || $self->ut_phonen('night', $self->country)
1615 || $self->ut_phonen('fax', $self->country)
1616 || $self->ut_zip('zip', $self->country)
1618 return $error if $error;
1620 if ( $conf->exists('cust_main-require_phone')
1621 && ! length($self->daytime) && ! length($self->night)
1624 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1626 : FS::Msgcat::_gettext('daytime');
1627 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1629 : FS::Msgcat::_gettext('night');
1631 return "$daytime_label or $night_label is required"
1635 if ( $self->has_ship_address
1636 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1637 $self->addr_fields )
1641 $self->ut_name('ship_last')
1642 || $self->ut_name('ship_first')
1643 || $self->ut_textn('ship_company')
1644 || $self->ut_text('ship_address1')
1645 || $self->ut_textn('ship_address2')
1646 || $self->ut_text('ship_city')
1647 || $self->ut_textn('ship_county')
1648 || $self->ut_textn('ship_state')
1649 || $self->ut_country('ship_country')
1651 return $error if $error;
1653 #false laziness with above
1654 unless ( qsearchs('cust_main_county', {
1655 'country' => $self->ship_country,
1658 return "Unknown ship_state/ship_county/ship_country: ".
1659 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1660 unless qsearch('cust_main_county',{
1661 'state' => $self->ship_state,
1662 'county' => $self->ship_county,
1663 'country' => $self->ship_country,
1669 $self->ut_phonen('ship_daytime', $self->ship_country)
1670 || $self->ut_phonen('ship_night', $self->ship_country)
1671 || $self->ut_phonen('ship_fax', $self->ship_country)
1672 || $self->ut_zip('ship_zip', $self->ship_country)
1674 return $error if $error;
1676 return "Unit # is required."
1677 if $self->ship_address2 =~ /^\s*$/
1678 && $conf->exists('cust_main-require_address2');
1680 } else { # ship_ info eq billing info, so don't store dup info in database
1682 $self->setfield("ship_$_", '')
1683 foreach $self->addr_fields;
1685 return "Unit # is required."
1686 if $self->address2 =~ /^\s*$/
1687 && $conf->exists('cust_main-require_address2');
1691 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1692 # or return "Illegal payby: ". $self->payby;
1694 FS::payby->can_payby($self->table, $self->payby)
1695 or return "Illegal payby: ". $self->payby;
1697 $error = $self->ut_numbern('paystart_month')
1698 || $self->ut_numbern('paystart_year')
1699 || $self->ut_numbern('payissue')
1700 || $self->ut_textn('paytype')
1702 return $error if $error;
1704 if ( $self->payip eq '' ) {
1707 $error = $self->ut_ip('payip');
1708 return $error if $error;
1711 # If it is encrypted and the private key is not availaible then we can't
1712 # check the credit card.
1714 my $check_payinfo = 1;
1716 if ($self->is_encrypted($self->payinfo)) {
1720 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1722 my $payinfo = $self->payinfo;
1723 $payinfo =~ s/\D//g;
1724 $payinfo =~ /^(\d{13,16})$/
1725 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1727 $self->payinfo($payinfo);
1729 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1731 return gettext('unknown_card_type')
1732 if cardtype($self->payinfo) eq "Unknown";
1734 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1736 return 'Banned credit card: banned on '.
1737 time2str('%a %h %o at %r', $ban->_date).
1738 ' by '. $ban->otaker.
1739 ' (ban# '. $ban->bannum. ')';
1742 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1743 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1744 $self->paycvv =~ /^(\d{4})$/
1745 or return "CVV2 (CID) for American Express cards is four digits.";
1748 $self->paycvv =~ /^(\d{3})$/
1749 or return "CVV2 (CVC2/CID) is three digits.";
1756 my $cardtype = cardtype($payinfo);
1757 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1759 return "Start date or issue number is required for $cardtype cards"
1760 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1762 return "Start month must be between 1 and 12"
1763 if $self->paystart_month
1764 and $self->paystart_month < 1 || $self->paystart_month > 12;
1766 return "Start year must be 1990 or later"
1767 if $self->paystart_year
1768 and $self->paystart_year < 1990;
1770 return "Issue number must be beween 1 and 99"
1772 and $self->payissue < 1 || $self->payissue > 99;
1775 $self->paystart_month('');
1776 $self->paystart_year('');
1777 $self->payissue('');
1780 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1782 my $payinfo = $self->payinfo;
1783 $payinfo =~ s/[^\d\@]//g;
1784 if ( $conf->exists('echeck-nonus') ) {
1785 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1786 $payinfo = "$1\@$2";
1788 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1789 $payinfo = "$1\@$2";
1791 $self->payinfo($payinfo);
1794 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1796 return 'Banned ACH account: banned on '.
1797 time2str('%a %h %o at %r', $ban->_date).
1798 ' by '. $ban->otaker.
1799 ' (ban# '. $ban->bannum. ')';
1802 } elsif ( $self->payby eq 'LECB' ) {
1804 my $payinfo = $self->payinfo;
1805 $payinfo =~ s/\D//g;
1806 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1808 $self->payinfo($payinfo);
1811 } elsif ( $self->payby eq 'BILL' ) {
1813 $error = $self->ut_textn('payinfo');
1814 return "Illegal P.O. number: ". $self->payinfo if $error;
1817 } elsif ( $self->payby eq 'COMP' ) {
1819 my $curuser = $FS::CurrentUser::CurrentUser;
1820 if ( ! $self->custnum
1821 && ! $curuser->access_right('Complimentary customer')
1824 return "You are not permitted to create complimentary accounts."
1827 $error = $self->ut_textn('payinfo');
1828 return "Illegal comp account issuer: ". $self->payinfo if $error;
1831 } elsif ( $self->payby eq 'PREPAY' ) {
1833 my $payinfo = $self->payinfo;
1834 $payinfo =~ s/\W//g; #anything else would just confuse things
1835 $self->payinfo($payinfo);
1836 $error = $self->ut_alpha('payinfo');
1837 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1838 return "Unknown prepayment identifier"
1839 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1844 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1845 return "Expiration date required"
1846 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1850 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1851 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1852 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1853 ( $m, $y ) = ( $2, "19$1" );
1854 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1855 ( $m, $y ) = ( $3, "20$2" );
1857 return "Illegal expiration date: ". $self->paydate;
1859 $self->paydate("$y-$m-01");
1860 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1861 return gettext('expired_card')
1863 && !$ignore_expired_card
1864 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1867 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1868 ( ! $conf->exists('require_cardname')
1869 || $self->payby !~ /^(CARD|DCRD)$/ )
1871 $self->payname( $self->first. " ". $self->getfield('last') );
1873 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1874 or return gettext('illegal_name'). " payname: ". $self->payname;
1878 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
1879 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1883 $self->otaker(getotaker) unless $self->otaker;
1885 warn "$me check AFTER: \n". $self->_dump
1888 $self->SUPER::check;
1893 Returns a list of fields which have ship_ duplicates.
1898 qw( last first company
1899 address1 address2 city county state zip country
1904 =item has_ship_address
1906 Returns true if this customer record has a separate shipping address.
1910 sub has_ship_address {
1912 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
1917 Returns a list of key/value pairs, with the following keys: address1, adddress2,
1918 city, county, state, zip, country. The shipping address is used if present.
1922 #geocode? dependent on tax-ship_address config, not available in cust_location
1923 #mostly. not yet then.
1927 my $prefix = $self->has_ship_address ? 'ship_' : '';
1929 map { $_ => $self->get($prefix.$_) }
1930 qw( address1 address2 city county state zip country geocode );
1931 #fields that cust_location has
1934 =item all_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
1936 Returns all packages (see L<FS::cust_pkg>) for this customer.
1942 my $extra_qsearch = ref($_[0]) ? shift : {};
1944 return $self->num_pkgs unless wantarray || keys(%$extra_qsearch);
1947 if ( $self->{'_pkgnum'} ) {
1948 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1950 @cust_pkg = $self->_cust_pkg($extra_qsearch);
1953 sort sort_packages @cust_pkg;
1958 Synonym for B<all_pkgs>.
1963 shift->all_pkgs(@_);
1968 Returns all locations (see L<FS::cust_location>) for this customer.
1974 qsearch('cust_location', { 'custnum' => $self->custnum } );
1977 =item location_label [ OPTION => VALUE ... ]
1979 Returns the label of the service location (see analog in L<FS::cust_location>) for this customer.
1987 used to separate the address elements (defaults to ', ')
1989 =item escape_function
1991 a callback used for escaping the text of the address elements
1997 # false laziness with FS::cust_location::line
1999 sub location_label {
2003 my $separator = $opt{join_string} || ', ';
2004 my $escape = $opt{escape_function} || sub{ shift };
2006 my $cydefault = FS::conf->new->config('countrydefault') || 'US';
2007 my $prefix = length($self->ship_last) ? 'ship_' : '';
2010 foreach (qw ( address1 address2 ) ) {
2011 my $method = "$prefix$_";
2012 $line .= ($notfirst ? $separator : ''). &$escape($self->$method)
2017 foreach (qw ( city county state zip ) ) {
2018 my $method = "$prefix$_";
2019 if ( $self->$method ) {
2020 $line .= ' (' if $method eq 'county';
2021 $line .= ($notfirst ? ' ' : $separator). &$escape($self->$method);
2022 $line .= ' )' if $method eq 'county';
2026 $line .= $separator. &$escape(code2country($self->country))
2027 if $self->country ne $cydefault;
2032 =item ncancelled_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
2034 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
2038 sub ncancelled_pkgs {
2040 my $extra_qsearch = ref($_[0]) ? shift : {};
2042 return $self->num_ncancelled_pkgs unless wantarray;
2045 if ( $self->{'_pkgnum'} ) {
2047 warn "$me ncancelled_pkgs: returning cached objects"
2050 @cust_pkg = grep { ! $_->getfield('cancel') }
2051 values %{ $self->{'_pkgnum'}->cache };
2055 warn "$me ncancelled_pkgs: searching for packages with custnum ".
2056 $self->custnum. "\n"
2059 $extra_qsearch->{'extra_sql'} .= ' AND ( cancel IS NULL OR cancel = 0 ) ';
2061 @cust_pkg = $self->_cust_pkg($extra_qsearch);
2065 sort sort_packages @cust_pkg;
2071 my $extra_qsearch = ref($_[0]) ? shift : {};
2073 $extra_qsearch->{'select'} ||= '*';
2074 $extra_qsearch->{'select'} .=
2075 ',( SELECT COUNT(*) FROM cust_svc WHERE cust_pkg.pkgnum = cust_svc.pkgnum )
2079 $_->{'_num_cust_svc'} = $_->get('_num_cust_svc');
2084 'table' => 'cust_pkg',
2085 'hashref' => { 'custnum' => $self->custnum },
2090 # This should be generalized to use config options to determine order.
2093 my $locationsort = ( $a->locationnum || 0 ) <=> ( $b->locationnum || 0 );
2094 return $locationsort if $locationsort;
2096 if ( $a->get('cancel') xor $b->get('cancel') ) {
2097 return -1 if $b->get('cancel');
2098 return 1 if $a->get('cancel');
2099 #shouldn't get here...
2102 my $a_num_cust_svc = $a->num_cust_svc;
2103 my $b_num_cust_svc = $b->num_cust_svc;
2104 return 0 if !$a_num_cust_svc && !$b_num_cust_svc;
2105 return -1 if $a_num_cust_svc && !$b_num_cust_svc;
2106 return 1 if !$a_num_cust_svc && $b_num_cust_svc;
2107 my @a_cust_svc = $a->cust_svc;
2108 my @b_cust_svc = $b->cust_svc;
2109 $a_cust_svc[0]->svc_x->label cmp $b_cust_svc[0]->svc_x->label;
2114 =item suspended_pkgs
2116 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
2120 sub suspended_pkgs {
2122 grep { $_->susp } $self->ncancelled_pkgs;
2125 =item unflagged_suspended_pkgs
2127 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
2128 customer (thouse packages without the `manual_flag' set).
2132 sub unflagged_suspended_pkgs {
2134 return $self->suspended_pkgs
2135 unless dbdef->table('cust_pkg')->column('manual_flag');
2136 grep { ! $_->manual_flag } $self->suspended_pkgs;
2139 =item unsuspended_pkgs
2141 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
2146 sub unsuspended_pkgs {
2148 grep { ! $_->susp } $self->ncancelled_pkgs;
2151 =item next_bill_date
2153 Returns the next date this customer will be billed, as a UNIX timestamp, or
2154 undef if no active package has a next bill date.
2158 sub next_bill_date {
2160 min( map $_->get('bill'), grep $_->get('bill'), $self->unsuspended_pkgs );
2163 =item num_cancelled_pkgs
2165 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
2170 sub num_cancelled_pkgs {
2171 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
2174 sub num_ncancelled_pkgs {
2175 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
2179 my( $self ) = shift;
2180 my $sql = scalar(@_) ? shift : '';
2181 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
2182 my $sth = dbh->prepare(
2183 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
2184 ) or die dbh->errstr;
2185 $sth->execute($self->custnum) or die $sth->errstr;
2186 $sth->fetchrow_arrayref->[0];
2191 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2192 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2193 on success or a list of errors.
2199 grep { $_->unsuspend } $self->suspended_pkgs;
2204 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2206 Returns a list: an empty list on success or a list of errors.
2212 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2215 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2217 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2218 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2219 of a list of pkgparts; the hashref has the following keys:
2223 =item pkgparts - listref of pkgparts
2225 =item (other options are passed to the suspend method)
2230 Returns a list: an empty list on success or a list of errors.
2234 sub suspend_if_pkgpart {
2236 my (@pkgparts, %opt);
2237 if (ref($_[0]) eq 'HASH'){
2238 @pkgparts = @{$_[0]{pkgparts}};
2243 grep { $_->suspend(%opt) }
2244 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2245 $self->unsuspended_pkgs;
2248 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2250 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2251 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2252 instead of a list of pkgparts; the hashref has the following keys:
2256 =item pkgparts - listref of pkgparts
2258 =item (other options are passed to the suspend method)
2262 Returns a list: an empty list on success or a list of errors.
2266 sub suspend_unless_pkgpart {
2268 my (@pkgparts, %opt);
2269 if (ref($_[0]) eq 'HASH'){
2270 @pkgparts = @{$_[0]{pkgparts}};
2275 grep { $_->suspend(%opt) }
2276 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2277 $self->unsuspended_pkgs;
2280 =item cancel [ OPTION => VALUE ... ]
2282 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2284 Available options are:
2288 =item quiet - can be set true to supress email cancellation notices.
2290 =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.
2292 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2294 =item nobill - can be set true to skip billing if it might otherwise be done.
2298 Always returns a list: an empty list on success or a list of errors.
2302 # nb that dates are not specified as valid options to this method
2305 my( $self, %opt ) = @_;
2307 warn "$me cancel called on customer ". $self->custnum. " with options ".
2308 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2311 return ( 'access denied' )
2312 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2314 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2316 #should try decryption (we might have the private key)
2317 # and if not maybe queue a job for the server that does?
2318 return ( "Can't (yet) ban encrypted credit cards" )
2319 if $self->is_encrypted($self->payinfo);
2321 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
2322 my $error = $ban->insert;
2323 return ( $error ) if $error;
2327 my @pkgs = $self->ncancelled_pkgs;
2329 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2331 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2332 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2336 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2337 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2340 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2343 sub _banned_pay_hashref {
2354 'payby' => $payby2ban{$self->payby},
2355 'payinfo' => md5_base64($self->payinfo),
2356 #don't ever *search* on reason! #'reason' =>
2362 Returns all notes (see L<FS::cust_main_note>) for this customer.
2369 qsearch( 'cust_main_note',
2370 { 'custnum' => $self->custnum },
2372 'ORDER BY _DATE DESC'
2378 Returns the agent (see L<FS::agent>) for this customer.
2384 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2389 Returns the customer class, as an FS::cust_class object, or the empty string
2390 if there is no customer class.
2396 if ( $self->classnum ) {
2397 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2405 Returns the customer category name, or the empty string if there is no customer
2412 my $cust_class = $self->cust_class;
2414 ? $cust_class->categoryname
2420 Returns the customer class name, or the empty string if there is no customer
2427 my $cust_class = $self->cust_class;
2429 ? $cust_class->classname
2434 =item bill_and_collect
2436 Cancels and suspends any packages due, generates bills, applies payments and
2437 credits, and applies collection events to run cards, send bills and notices,
2440 By default, warns on errors and continues with the next operation (but see the
2441 "fatal" flag below).
2443 Options are passed as name-value pairs. Currently available options are:
2449 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:
2453 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2457 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.
2461 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2465 If set true, re-charges setup fees.
2469 If set any errors prevent subsequent operations from continusing. If set
2470 specifically to "return", returns the error (or false, if there is no error).
2471 Any other true value causes errors to die.
2475 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)
2479 Options are passed to the B<bill> and B<collect> methods verbatim, so all
2480 options of those methods are also available.
2484 sub bill_and_collect {
2485 my( $self, %options ) = @_;
2489 #$options{actual_time} not $options{time} because freeside-daily -d is for
2490 #pre-printing invoices
2492 $options{'actual_time'} ||= time;
2494 $error = $self->cancel_expired_pkgs( $options{actual_time} );
2496 $error = "Error expiring custnum ". $self->custnum. ": $error";
2497 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2498 elsif ( $options{fatal} ) { die $error; }
2499 else { warn $error; }
2502 $error = $self->suspend_adjourned_pkgs( $options{actual_time} );
2504 $error = "Error adjourning custnum ". $self->custnum. ": $error";
2505 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2506 elsif ( $options{fatal} ) { die $error; }
2507 else { warn $error; }
2510 $error = $self->bill( %options );
2512 $error = "Error billing custnum ". $self->custnum. ": $error";
2513 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2514 elsif ( $options{fatal} ) { die $error; }
2515 else { warn $error; }
2518 $error = $self->apply_payments_and_credits;
2520 $error = "Error applying custnum ". $self->custnum. ": $error";
2521 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2522 elsif ( $options{fatal} ) { die $error; }
2523 else { warn $error; }
2526 unless ( $conf->exists('cancelled_cust-noevents')
2527 && ! $self->num_ncancelled_pkgs
2529 $error = $self->collect( %options );
2531 $error = "Error collecting custnum ". $self->custnum. ": $error";
2532 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
2533 elsif ($options{fatal} ) { die $error; }
2534 else { warn $error; }
2542 sub cancel_expired_pkgs {
2543 my ( $self, $time, %options ) = @_;
2545 my @cancel_pkgs = $self->ncancelled_pkgs( {
2546 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
2551 foreach my $cust_pkg ( @cancel_pkgs ) {
2552 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
2553 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
2554 'reason_otaker' => $cpr->otaker
2558 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
2561 scalar(@errors) ? join(' / ', @errors) : '';
2565 sub suspend_adjourned_pkgs {
2566 my ( $self, $time, %options ) = @_;
2568 my @susp_pkgs = $self->ncancelled_pkgs( {
2570 " AND ( susp IS NULL OR susp = 0 )
2571 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
2572 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
2577 #only because there's no SQL test for is_prepaid :/
2579 grep { ( $_->part_pkg->is_prepaid
2584 && $_->adjourn <= $time
2592 foreach my $cust_pkg ( @susp_pkgs ) {
2593 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
2594 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
2595 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
2596 'reason_otaker' => $cpr->otaker
2600 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
2603 scalar(@errors) ? join(' / ', @errors) : '';
2609 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
2610 conjunction with the collect method by calling B<bill_and_collect>.
2612 If there is an error, returns the error, otherwise returns false.
2614 Options are passed as name-value pairs. Currently available options are:
2620 If set true, re-charges setup fees.
2624 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:
2628 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2632 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2634 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2638 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
2642 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.
2646 This boolean value informs the us that the package is being cancelled. This
2647 typically might mean not charging the normal recurring fee but only usage
2648 fees since the last billing. Setup charges may be charged. Not all package
2649 plans support this feature (they tend to charge 0).
2653 Optional terms to be printed on this invoice. Otherwise, customer-specific
2654 terms or the default terms are used.
2661 my( $self, %options ) = @_;
2662 return '' if $self->payby eq 'COMP';
2663 warn "$me bill customer ". $self->custnum. "\n"
2666 my $time = $options{'time'} || time;
2667 my $invoice_time = $options{'invoice_time'} || $time;
2669 $options{'not_pkgpart'} ||= {};
2670 $options{'not_pkgpart'} = { map { $_ => 1 }
2671 split(/\s*,\s*/, $options{'not_pkgpart'})
2673 unless ref($options{'not_pkgpart'});
2675 local $SIG{HUP} = 'IGNORE';
2676 local $SIG{INT} = 'IGNORE';
2677 local $SIG{QUIT} = 'IGNORE';
2678 local $SIG{TERM} = 'IGNORE';
2679 local $SIG{TSTP} = 'IGNORE';
2680 local $SIG{PIPE} = 'IGNORE';
2682 my $oldAutoCommit = $FS::UID::AutoCommit;
2683 local $FS::UID::AutoCommit = 0;
2686 $self->select_for_update; #mutex
2688 my $error = $self->do_cust_event(
2689 'debug' => ( $options{'debug'} || 0 ),
2690 'time' => $invoice_time,
2691 'check_freq' => $options{'check_freq'},
2692 'stage' => 'pre-bill',
2695 $dbh->rollback if $oldAutoCommit;
2699 #keep auto-charge and non-auto-charge line items separate
2700 my @passes = ( '', 'no_auto' );
2702 my %cust_bill_pkg = map { $_ => [] } @passes;
2705 # find the packages which are due for billing, find out how much they are
2706 # & generate invoice database.
2709 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
2710 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
2712 my %taxlisthash = map { $_ => {} } @passes;
2714 my @precommit_hooks = ();
2716 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
2717 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
2719 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
2721 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2723 #? to avoid use of uninitialized value errors... ?
2724 $cust_pkg->setfield('bill', '')
2725 unless defined($cust_pkg->bill);
2727 #my $part_pkg = $cust_pkg->part_pkg;
2729 my $real_pkgpart = $cust_pkg->pkgpart;
2730 my %hash = $cust_pkg->hash;
2732 foreach my $part_pkg ( $cust_pkg->part_pkg->self_and_bill_linked ) {
2734 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
2736 my $pass = ($cust_pkg->no_auto || $part_pkg->no_auto) ? 'no_auto' : '';
2739 $self->_make_lines( 'part_pkg' => $part_pkg,
2740 'cust_pkg' => $cust_pkg,
2741 'precommit_hooks' => \@precommit_hooks,
2742 'line_items' => $cust_bill_pkg{$pass},
2743 'setup' => $total_setup{$pass},
2744 'recur' => $total_recur{$pass},
2745 'tax_matrix' => $taxlisthash{$pass},
2747 'real_pkgpart' => $real_pkgpart,
2748 'options' => \%options,
2751 $dbh->rollback if $oldAutoCommit;
2755 } #foreach my $part_pkg
2757 } #foreach my $cust_pkg
2759 #if the customer isn't on an automatic payby, everything can go on a single
2761 #if ( $cust_main->payby !~ /^(CARD|CHEK)$/ ) {
2762 #merge everything into one list
2765 foreach my $pass (@passes) { # keys %cust_bill_pkg ) {
2767 my @cust_bill_pkg = @{ $cust_bill_pkg{$pass} };
2769 next unless @cust_bill_pkg; #don't create an invoice w/o line items
2771 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
2772 !$conf->exists('postal_invoice-recurring_only')
2776 my $postal_pkg = $self->charge_postal_fee();
2777 if ( $postal_pkg && !ref( $postal_pkg ) ) {
2779 $dbh->rollback if $oldAutoCommit;
2780 return "can't charge postal invoice fee for customer ".
2781 $self->custnum. ": $postal_pkg";
2783 } elsif ( $postal_pkg ) {
2785 my $real_pkgpart = $postal_pkg->pkgpart;
2786 foreach my $part_pkg ( $postal_pkg->part_pkg->self_and_bill_linked ) {
2787 my %postal_options = %options;
2788 delete $postal_options{cancel};
2790 $self->_make_lines( 'part_pkg' => $part_pkg,
2791 'cust_pkg' => $postal_pkg,
2792 'precommit_hooks' => \@precommit_hooks,
2793 'line_items' => \@cust_bill_pkg,
2794 'setup' => $total_setup{$pass},
2795 'recur' => $total_recur{$pass},
2796 'tax_matrix' => $taxlisthash{$pass},
2798 'real_pkgpart' => $real_pkgpart,
2799 'options' => \%postal_options,
2802 $dbh->rollback if $oldAutoCommit;
2811 my $listref_or_error =
2812 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
2814 unless ( ref( $listref_or_error ) ) {
2815 $dbh->rollback if $oldAutoCommit;
2816 return $listref_or_error;
2819 foreach my $taxline ( @$listref_or_error ) {
2820 ${ $total_setup{$pass} } =
2821 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
2822 push @cust_bill_pkg, $taxline;
2825 #add tax adjustments
2826 warn "adding tax adjustments...\n" if $DEBUG > 2;
2827 foreach my $cust_tax_adjustment (
2828 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
2834 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
2836 my $itemdesc = $cust_tax_adjustment->taxname;
2837 $itemdesc = '' if $itemdesc eq 'Tax';
2839 push @cust_bill_pkg, new FS::cust_bill_pkg {
2845 'itemdesc' => $itemdesc,
2846 'itemcomment' => $cust_tax_adjustment->comment,
2847 'cust_tax_adjustment' => $cust_tax_adjustment,
2848 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2853 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
2855 my @cust_bill = $self->cust_bill;
2856 my $balance = $self->balance;
2857 my $previous_balance = scalar(@cust_bill)
2858 ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
2861 $previous_balance += $cust_bill[$#cust_bill]->charged
2862 if scalar(@cust_bill);
2863 #my $balance_adjustments =
2864 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
2866 #create the new invoice
2867 my $cust_bill = new FS::cust_bill ( {
2868 'custnum' => $self->custnum,
2869 '_date' => ( $invoice_time ),
2870 'charged' => $charged,
2871 'billing_balance' => $balance,
2872 'previous_balance' => $previous_balance,
2873 'invoice_terms' => $options{'invoice_terms'},
2875 $error = $cust_bill->insert;
2877 $dbh->rollback if $oldAutoCommit;
2878 return "can't create invoice for customer #". $self->custnum. ": $error";
2881 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
2882 $cust_bill_pkg->invnum($cust_bill->invnum);
2883 my $error = $cust_bill_pkg->insert;
2885 $dbh->rollback if $oldAutoCommit;
2886 return "can't create invoice line item: $error";
2890 } #foreach my $pass ( keys %cust_bill_pkg )
2892 foreach my $hook ( @precommit_hooks ) {
2894 &{$hook}; #($self) ?
2897 $dbh->rollback if $oldAutoCommit;
2898 return "$@ running precommit hook $hook\n";
2902 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2906 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
2908 This is a weird one. Perhaps it should not even be exposed.
2910 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
2911 Usually used internally by bill method B<bill>.
2913 If there is an error, returns the error, otherwise returns reference to a
2914 list of line items suitable for insertion.
2920 An array ref of the line items being billed.
2924 A strange beast. The keys to this hash are internal identifiers consisting
2925 of the name of the tax object type, a space, and its unique identifier ( e.g.
2926 'cust_main_county 23' ). The values of the hash are listrefs. The first
2927 item in the list is the tax object. The remaining items are either line
2928 items or floating point values (currency amounts).
2930 The taxes are calculated on this entity. Calculated exemption records are
2931 transferred to the LINEITEMREF items on the assumption that they are related.
2937 This specifies the date appearing on the associated invoice. Some
2938 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
2943 sub calculate_taxes {
2944 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
2946 my @tax_line_items = ();
2948 warn "having a look at the taxes we found...\n" if $DEBUG > 2;
2950 # keys are tax names (as printed on invoices / itemdesc )
2951 # values are listrefs of taxlisthash keys (internal identifiers)
2954 # keys are taxlisthash keys (internal identifiers)
2955 # values are (cumulative) amounts
2958 # keys are taxlisthash keys (internal identifiers)
2959 # values are listrefs of cust_bill_pkg_tax_location hashrefs
2960 my %tax_location = ();
2962 # keys are taxlisthash keys (internal identifiers)
2963 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
2964 my %tax_rate_location = ();
2966 foreach my $tax ( keys %$taxlisthash ) {
2967 my $tax_object = shift @{ $taxlisthash->{$tax} };
2968 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
2969 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
2970 my $hashref_or_error =
2971 $tax_object->taxline( $taxlisthash->{$tax},
2972 'custnum' => $self->custnum,
2973 'invoice_time' => $invoice_time
2975 return $hashref_or_error unless ref($hashref_or_error);
2977 unshift @{ $taxlisthash->{$tax} }, $tax_object;
2979 my $name = $hashref_or_error->{'name'};
2980 my $amount = $hashref_or_error->{'amount'};
2982 #warn "adding $amount as $name\n";
2983 $taxname{ $name } ||= [];
2984 push @{ $taxname{ $name } }, $tax;
2986 $tax{ $tax } += $amount;
2988 $tax_location{ $tax } ||= [];
2989 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
2990 push @{ $tax_location{ $tax } },
2992 'taxnum' => $tax_object->taxnum,
2993 'taxtype' => ref($tax_object),
2994 'pkgnum' => $tax_object->get('pkgnum'),
2995 'locationnum' => $tax_object->get('locationnum'),
2996 'amount' => sprintf('%.2f', $amount ),
3000 $tax_rate_location{ $tax } ||= [];
3001 if ( ref($tax_object) eq 'FS::tax_rate' ) {
3002 my $taxratelocationnum =
3003 $tax_object->tax_rate_location->taxratelocationnum;
3004 push @{ $tax_rate_location{ $tax } },
3006 'taxnum' => $tax_object->taxnum,
3007 'taxtype' => ref($tax_object),
3008 'amount' => sprintf('%.2f', $amount ),
3009 'locationtaxid' => $tax_object->location,
3010 'taxratelocationnum' => $taxratelocationnum,
3016 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
3017 my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
3018 foreach my $tax ( keys %$taxlisthash ) {
3019 foreach ( @{ $taxlisthash->{$tax} }[1 ... scalar(@{ $taxlisthash->{$tax} })] ) {
3020 next unless ref($_) eq 'FS::cust_bill_pkg';
3022 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
3023 splice( @{ $_->_cust_tax_exempt_pkg } );
3027 #consolidate and create tax line items
3028 warn "consolidating and generating...\n" if $DEBUG > 2;
3029 foreach my $taxname ( keys %taxname ) {
3032 my @cust_bill_pkg_tax_location = ();
3033 my @cust_bill_pkg_tax_rate_location = ();
3034 warn "adding $taxname\n" if $DEBUG > 1;
3035 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
3036 next if $seen{$taxitem}++;
3037 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
3038 $tax += $tax{$taxitem};
3039 push @cust_bill_pkg_tax_location,
3040 map { new FS::cust_bill_pkg_tax_location $_ }
3041 @{ $tax_location{ $taxitem } };
3042 push @cust_bill_pkg_tax_rate_location,
3043 map { new FS::cust_bill_pkg_tax_rate_location $_ }
3044 @{ $tax_rate_location{ $taxitem } };
3048 $tax = sprintf('%.2f', $tax );
3050 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
3056 if ( $pkg_category and
3057 $conf->config('invoice_latexsummary') ||
3058 $conf->config('invoice_htmlsummary')
3062 my %hash = ( 'section' => $pkg_category->categoryname );
3063 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3067 push @tax_line_items, new FS::cust_bill_pkg {
3073 'itemdesc' => $taxname,
3074 'display' => \@display,
3075 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
3076 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
3085 my ($self, %params) = @_;
3087 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
3088 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
3089 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
3090 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
3091 my $total_setup = $params{setup} or die "no setup accumulator specified";
3092 my $total_recur = $params{recur} or die "no recur accumulator specified";
3093 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
3094 my $time = $params{'time'} or die "no time specified";
3095 my (%options) = %{$params{options}};
3098 my $real_pkgpart = $params{real_pkgpart};
3099 my %hash = $cust_pkg->hash;
3100 my $old_cust_pkg = new FS::cust_pkg \%hash;
3106 $cust_pkg->pkgpart($part_pkg->pkgpart);
3114 if ( $options{'resetup'}
3115 || ( ! $cust_pkg->setup
3116 && ( ! $cust_pkg->start_date
3117 || $cust_pkg->start_date <= $time
3119 && ( ! $conf->exists('disable_setup_suspended_pkgs')
3120 || ( $conf->exists('disable_setup_suspended_pkgs') &&
3121 ! $cust_pkg->getfield('susp')
3128 warn " bill setup\n" if $DEBUG > 1;
3131 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
3132 return "$@ running calc_setup for $cust_pkg\n"
3135 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
3137 $cust_pkg->setfield('setup', $time)
3138 unless $cust_pkg->setup;
3139 #do need it, but it won't get written to the db
3140 #|| $cust_pkg->pkgpart != $real_pkgpart;
3142 $cust_pkg->setfield('start_date', '')
3143 if $cust_pkg->start_date;
3148 # bill recurring fee
3151 #XXX unit stuff here too
3155 if ( ! $cust_pkg->get('susp')
3156 and ! $cust_pkg->get('start_date')
3157 and ( $part_pkg->getfield('freq') ne '0'
3158 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
3160 || ( $part_pkg->plan eq 'voip_cdr'
3161 && $part_pkg->option('bill_every_call')
3163 || ( $options{cancel} )
3166 # XXX should this be a package event? probably. events are called
3167 # at collection time at the moment, though...
3168 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
3169 if $part_pkg->can('reset_usage');
3170 #don't want to reset usage just cause we want a line item??
3171 #&& $part_pkg->pkgpart == $real_pkgpart;
3173 warn " bill recur\n" if $DEBUG > 1;
3176 # XXX shared with $recur_prog
3177 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
3181 #over two params! lets at least switch to a hashref for the rest...
3182 my $increment_next_bill = ( $part_pkg->freq ne '0'
3183 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
3184 && !$options{cancel}
3186 my %param = ( 'precommit_hooks' => $precommit_hooks,
3187 'increment_next_bill' => $increment_next_bill,
3188 'discounts' => \@discounts,
3191 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
3192 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
3193 return "$@ running $method for $cust_pkg\n"
3196 if ( $increment_next_bill ) {
3198 my $next_bill = $part_pkg->add_freq($sdate);
3199 return "unparsable frequency: ". $part_pkg->freq
3200 if $next_bill == -1;
3202 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
3203 # only for figuring next bill date, nothing else, so, reset $sdate again
3205 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
3206 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
3207 $cust_pkg->last_bill($sdate);
3209 $cust_pkg->setfield('bill', $next_bill );
3215 warn "\$setup is undefined" unless defined($setup);
3216 warn "\$recur is undefined" unless defined($recur);
3217 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
3220 # If there's line items, create em cust_bill_pkg records
3221 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
3226 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
3227 # hmm.. and if just the options are modified in some weird price plan?
3229 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
3232 my $error = $cust_pkg->replace( $old_cust_pkg,
3233 'options' => { $cust_pkg->options },
3235 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
3236 if $error; #just in case
3239 $setup = sprintf( "%.2f", $setup );
3240 $recur = sprintf( "%.2f", $recur );
3241 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
3242 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
3244 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
3245 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
3248 if ( $setup != 0 || $recur != 0 ) {
3250 warn " charges (setup=$setup, recur=$recur); adding line items\n"
3253 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
3255 warn " adding customer package invoice detail: $_\n"
3256 foreach @cust_pkg_detail;
3258 push @details, @cust_pkg_detail;
3260 my $cust_bill_pkg = new FS::cust_bill_pkg {
3261 'pkgnum' => $cust_pkg->pkgnum,
3263 'unitsetup' => $unitsetup,
3265 'unitrecur' => $unitrecur,
3266 'quantity' => $cust_pkg->quantity,
3267 'details' => \@details,
3268 'discounts' => \@discounts,
3269 'hidden' => $part_pkg->hidden,
3272 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
3273 $cust_bill_pkg->sdate( $hash{last_bill} );
3274 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
3275 $cust_bill_pkg->edate( $time ) if $options{cancel};
3276 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
3277 $cust_bill_pkg->sdate( $sdate );
3278 $cust_bill_pkg->edate( $cust_pkg->bill );
3279 #$cust_bill_pkg->edate( $time ) if $options{cancel};
3282 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
3283 unless $part_pkg->pkgpart == $real_pkgpart;
3285 $$total_setup += $setup;
3286 $$total_recur += $recur;
3293 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
3294 return $error if $error;
3296 push @$cust_bill_pkgs, $cust_bill_pkg;
3298 } #if $setup != 0 || $recur != 0
3308 my $part_pkg = shift;
3309 my $taxlisthash = shift;
3310 my $cust_bill_pkg = shift;
3311 my $cust_pkg = shift;
3312 my $invoice_time = shift;
3313 my $real_pkgpart = shift;
3314 my $options = shift;
3316 my %cust_bill_pkg = ();
3320 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
3321 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
3322 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
3323 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
3325 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
3327 if ( $conf->exists('enable_taxproducts')
3328 && ( scalar($part_pkg->part_pkg_taxoverride)
3329 || $part_pkg->has_taxproduct
3334 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3335 return "fatal: Can't (yet) use tax-pkg_address with taxproducts";
3338 foreach my $class (@classes) {
3339 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class );
3340 return $err_or_ref unless ref($err_or_ref);
3341 $taxes{$class} = $err_or_ref;
3344 unless (exists $taxes{''}) {
3345 my $err_or_ref = $self->_gather_taxes( $part_pkg, '' );
3346 return $err_or_ref unless ref($err_or_ref);
3347 $taxes{''} = $err_or_ref;
3352 my @loc_keys = qw( city county state country );
3354 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3355 my $cust_location = $cust_pkg->cust_location;
3356 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
3359 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
3362 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
3365 $taxhash{'taxclass'} = $part_pkg->taxclass;
3368 my %taxhash_elim = %taxhash;
3369 my @elim = qw( city county state );
3372 #first try a match with taxclass
3373 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
3375 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
3376 #then try a match without taxclass
3377 my %no_taxclass = %taxhash_elim;
3378 $no_taxclass{ 'taxclass' } = '';
3379 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
3382 $taxhash_elim{ shift(@elim) } = '';
3384 } while ( !scalar(@taxes) && scalar(@elim) );
3386 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
3388 if $self->cust_main_exemption; #just to be safe
3390 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3392 $_->set('pkgnum', $cust_pkg->pkgnum );
3393 $_->set('locationnum', $cust_pkg->locationnum );
3397 $taxes{''} = [ @taxes ];
3398 $taxes{'setup'} = [ @taxes ];
3399 $taxes{'recur'} = [ @taxes ];
3400 $taxes{$_} = [ @taxes ] foreach (@classes);
3402 # # maybe eliminate this entirely, along with all the 0% records
3403 # unless ( @taxes ) {
3405 # "fatal: can't find tax rate for state/county/country/taxclass ".
3406 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
3409 } #if $conf->exists('enable_taxproducts') ...
3414 my $separate = $conf->exists('separate_usage');
3415 my $usage_mandate = $cust_pkg->part_pkg->option('usage_mandate', 'Hush!');
3416 if ( $separate || $cust_bill_pkg->hidden || $usage_mandate ) {
3418 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
3419 my %hash = $cust_bill_pkg->hidden # maybe for all bill linked?
3420 ? ( 'section' => $temp_pkg->part_pkg->categoryname )
3423 my $section = $cust_pkg->part_pkg->option('usage_section', 'Hush!');
3424 my $summary = $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
3426 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3427 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
3429 push @display, new FS::cust_bill_pkg_display
3432 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
3436 if ($separate && $section && $summary) {
3437 push @display, new FS::cust_bill_pkg_display { type => 'U',
3442 if ($usage_mandate || $section && $summary) {
3443 $hash{post_total} = 'Y';
3446 $hash{section} = $section if ($separate || $usage_mandate);
3447 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
3450 $cust_bill_pkg->set('display', \@display);
3452 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
3453 foreach my $key (keys %tax_cust_bill_pkg) {
3454 my @taxes = @{ $taxes{$key} || [] };
3455 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
3457 my %localtaxlisthash = ();
3458 foreach my $tax ( @taxes ) {
3460 my $taxname = ref( $tax ). ' '. $tax->taxnum;
3461 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
3462 # ' locationnum'. $cust_pkg->locationnum
3463 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
3465 $taxlisthash->{ $taxname } ||= [ $tax ];
3466 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
3468 $localtaxlisthash{ $taxname } ||= [ $tax ];
3469 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
3473 warn "finding taxed taxes...\n" if $DEBUG > 2;
3474 foreach my $tax ( keys %localtaxlisthash ) {
3475 my $tax_object = shift @{ $localtaxlisthash{$tax} };
3476 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
3478 next unless $tax_object->can('tax_on_tax');
3480 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
3481 my $totname = ref( $tot ). ' '. $tot->taxnum;
3483 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
3485 next unless exists( $localtaxlisthash{ $totname } ); # only increase
3487 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
3488 my $hashref_or_error =
3489 $tax_object->taxline( $localtaxlisthash{$tax},
3490 'custnum' => $self->custnum,
3491 'invoice_time' => $invoice_time,
3493 return $hashref_or_error
3494 unless ref($hashref_or_error);
3496 $taxlisthash->{ $totname } ||= [ $tot ];
3497 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
3509 my $part_pkg = shift;
3513 my $geocode = $self->geocode('cch');
3515 my @taxclassnums = map { $_->taxclassnum }
3516 $part_pkg->part_pkg_taxoverride($class);
3518 unless (@taxclassnums) {
3519 @taxclassnums = map { $_->taxclassnum }
3520 grep { $_->taxable eq 'Y' }
3521 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
3523 warn "Found taxclassnum values of ". join(',', @taxclassnums)
3528 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
3530 @taxes = qsearch({ 'table' => 'tax_rate',
3531 'hashref' => { 'geocode' => $geocode, },
3532 'extra_sql' => $extra_sql,
3534 if scalar(@taxclassnums);
3536 warn "Found taxes ".
3537 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
3544 =item collect [ HASHREF | OPTION => VALUE ... ]
3546 (Attempt to) collect money for this customer's outstanding invoices (see
3547 L<FS::cust_bill>). Usually used after the bill method.
3549 Actions are now triggered by billing events; see L<FS::part_event> and the
3550 billing events web interface. Old-style invoice events (see
3551 L<FS::part_bill_event>) have been deprecated.
3553 If there is an error, returns the error, otherwise returns false.
3555 Options are passed as name-value pairs.
3557 Currently available options are:
3563 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.
3567 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3571 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3575 set true to surpress email card/ACH decline notices.
3579 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)
3585 # allows for one time override of normal customer billing method
3590 my( $self, %options ) = @_;
3591 my $invoice_time = $options{'invoice_time'} || time;
3594 local $SIG{HUP} = 'IGNORE';
3595 local $SIG{INT} = 'IGNORE';
3596 local $SIG{QUIT} = 'IGNORE';
3597 local $SIG{TERM} = 'IGNORE';
3598 local $SIG{TSTP} = 'IGNORE';
3599 local $SIG{PIPE} = 'IGNORE';
3601 my $oldAutoCommit = $FS::UID::AutoCommit;
3602 local $FS::UID::AutoCommit = 0;
3605 $self->select_for_update; #mutex
3608 my $balance = $self->balance;
3609 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
3612 if ( exists($options{'retry_card'}) ) {
3613 carp 'retry_card option passed to collect is deprecated; use retry';
3614 $options{'retry'} ||= $options{'retry_card'};
3616 if ( exists($options{'retry'}) && $options{'retry'} ) {
3617 my $error = $self->retry_realtime;
3619 $dbh->rollback if $oldAutoCommit;
3624 my $error = $self->do_cust_event(
3625 'debug' => ( $options{'debug'} || 0 ),
3626 'time' => $invoice_time,
3627 'check_freq' => $options{'check_freq'},
3628 'stage' => 'collect',
3631 $dbh->rollback if $oldAutoCommit;
3635 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3640 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
3642 Runs billing events; see L<FS::part_event> and the billing events web
3645 If there is an error, returns the error, otherwise returns false.
3647 Options are passed as name-value pairs.
3649 Currently available options are:
3655 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.
3659 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3663 "collect" (the default) or "pre-bill"
3667 set true to surpress email card/ACH decline notices.
3671 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)
3677 # allows for one time override of normal customer billing method
3681 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3684 my( $self, %options ) = @_;
3685 my $time = $options{'time'} || time;
3688 local $SIG{HUP} = 'IGNORE';
3689 local $SIG{INT} = 'IGNORE';
3690 local $SIG{QUIT} = 'IGNORE';
3691 local $SIG{TERM} = 'IGNORE';
3692 local $SIG{TSTP} = 'IGNORE';
3693 local $SIG{PIPE} = 'IGNORE';
3695 my $oldAutoCommit = $FS::UID::AutoCommit;
3696 local $FS::UID::AutoCommit = 0;
3699 $self->select_for_update; #mutex
3702 my $balance = $self->balance;
3703 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
3706 # if ( exists($options{'retry_card'}) ) {
3707 # carp 'retry_card option passed to collect is deprecated; use retry';
3708 # $options{'retry'} ||= $options{'retry_card'};
3710 # if ( exists($options{'retry'}) && $options{'retry'} ) {
3711 # my $error = $self->retry_realtime;
3713 # $dbh->rollback if $oldAutoCommit;
3718 # false laziness w/pay_batch::import_results
3720 my $due_cust_event = $self->due_cust_event(
3721 'debug' => ( $options{'debug'} || 0 ),
3723 'check_freq' => $options{'check_freq'},
3724 'stage' => ( $options{'stage'} || 'collect' ),
3726 unless( ref($due_cust_event) ) {
3727 $dbh->rollback if $oldAutoCommit;
3728 return $due_cust_event;
3731 foreach my $cust_event ( @$due_cust_event ) {
3735 #re-eval event conditions (a previous event could have changed things)
3736 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
3737 #don't leave stray "new/locked" records around
3738 my $error = $cust_event->delete;
3740 #gah, even with transactions
3741 $dbh->commit if $oldAutoCommit; #well.
3748 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
3749 warn " running cust_event ". $cust_event->eventnum. "\n"
3753 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
3754 if ( my $error = $cust_event->do_event() ) {
3755 #XXX wtf is this? figure out a proper dealio with return value
3757 # gah, even with transactions.
3758 $dbh->commit if $oldAutoCommit; #well.
3765 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3770 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
3772 Inserts database records for and returns an ordered listref of new events due
3773 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
3774 events are due, an empty listref is returned. If there is an error, returns a
3775 scalar error message.
3777 To actually run the events, call each event's test_condition method, and if
3778 still true, call the event's do_event method.
3780 Options are passed as a hashref or as a list of name-value pairs. Available
3787 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.
3791 "collect" (the default) or "pre-bill"
3795 "Current time" for the events.
3799 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)
3803 Only return events for the specified eventtable (by default, events of all eventtables are returned)
3807 Explicitly pass the objects to be tested (typically used with eventtable).
3811 Set to true to return the objects, but not actually insert them into the
3818 sub due_cust_event {
3820 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
3823 #my $DEBUG = $opt{'debug'}
3824 local($DEBUG) = $opt{'debug'}
3825 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
3827 warn "$me due_cust_event called with options ".
3828 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
3831 $opt{'time'} ||= time;
3833 local $SIG{HUP} = 'IGNORE';
3834 local $SIG{INT} = 'IGNORE';
3835 local $SIG{QUIT} = 'IGNORE';
3836 local $SIG{TERM} = 'IGNORE';
3837 local $SIG{TSTP} = 'IGNORE';
3838 local $SIG{PIPE} = 'IGNORE';
3840 my $oldAutoCommit = $FS::UID::AutoCommit;
3841 local $FS::UID::AutoCommit = 0;
3844 $self->select_for_update #mutex
3845 unless $opt{testonly};
3848 # find possible events (initial search)
3851 my @cust_event = ();
3853 my @eventtable = $opt{'eventtable'}
3854 ? ( $opt{'eventtable'} )
3855 : FS::part_event->eventtables_runorder;
3857 foreach my $eventtable ( @eventtable ) {
3860 if ( $opt{'objects'} ) {
3862 @objects = @{ $opt{'objects'} };
3866 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
3867 @objects = ( $eventtable eq 'cust_main' )
3869 : ( $self->$eventtable() );
3873 my @e_cust_event = ();
3875 my $cross = "CROSS JOIN $eventtable";
3876 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
3877 unless $eventtable eq 'cust_main';
3879 foreach my $object ( @objects ) {
3881 #this first search uses the condition_sql magic for optimization.
3882 #the more possible events we can eliminate in this step the better
3884 my $cross_where = '';
3885 my $pkey = $object->primary_key;
3886 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
3888 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
3890 FS::part_event_condition->where_conditions_sql( $eventtable,
3891 'time'=>$opt{'time'}
3893 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
3895 $extra_sql = "AND $extra_sql" if $extra_sql;
3897 #here is the agent virtualization
3898 $extra_sql .= " AND ( part_event.agentnum IS NULL
3899 OR part_event.agentnum = ". $self->agentnum. ' )';
3901 $extra_sql .= " $order";
3903 warn "searching for events for $eventtable ". $object->$pkey. "\n"
3904 if $opt{'debug'} > 2;
3905 my @part_event = qsearch( {
3906 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
3907 'select' => 'part_event.*',
3908 'table' => 'part_event',
3909 'addl_from' => "$cross $join",
3910 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
3911 'eventtable' => $eventtable,
3914 'extra_sql' => "AND $cross_where $extra_sql",
3918 my $pkey = $object->primary_key;
3919 warn " ". scalar(@part_event).
3920 " possible events found for $eventtable ". $object->$pkey(). "\n";
3923 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
3927 warn " ". scalar(@e_cust_event).
3928 " subtotal possible cust events found for $eventtable\n"
3931 push @cust_event, @e_cust_event;
3935 warn " ". scalar(@cust_event).
3936 " total possible cust events found in initial search\n"
3944 $opt{stage} ||= 'collect';
3946 grep { my $stage = $_->part_event->event_stage;
3947 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
3957 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
3958 'stats_hashref' => \%unsat ),
3961 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
3964 warn " invalid conditions not eliminated with condition_sql:\n".
3965 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
3966 if keys %unsat && $DEBUG; # > 1;
3972 unless( $opt{testonly} ) {
3973 foreach my $cust_event ( @cust_event ) {
3975 my $error = $cust_event->insert();
3977 $dbh->rollback if $oldAutoCommit;
3984 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3990 warn " returning events: ". Dumper(@cust_event). "\n"
3997 =item retry_realtime
3999 Schedules realtime / batch credit card / electronic check / LEC billing
4000 events for for retry. Useful if card information has changed or manual
4001 retry is desired. The 'collect' method must be called to actually retry
4004 Implementation details: For either this customer, or for each of this
4005 customer's open invoices, changes the status of the first "done" (with
4006 statustext error) realtime processing event to "failed".
4010 sub retry_realtime {
4013 local $SIG{HUP} = 'IGNORE';
4014 local $SIG{INT} = 'IGNORE';
4015 local $SIG{QUIT} = 'IGNORE';
4016 local $SIG{TERM} = 'IGNORE';
4017 local $SIG{TSTP} = 'IGNORE';
4018 local $SIG{PIPE} = 'IGNORE';
4020 my $oldAutoCommit = $FS::UID::AutoCommit;
4021 local $FS::UID::AutoCommit = 0;
4024 #a little false laziness w/due_cust_event (not too bad, really)
4026 my $join = FS::part_event_condition->join_conditions_sql;
4027 my $order = FS::part_event_condition->order_conditions_sql;
4030 . join ( ' OR ' , map {
4031 "( part_event.eventtable = " . dbh->quote($_)
4032 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
4033 } FS::part_event->eventtables)
4036 #here is the agent virtualization
4037 my $agent_virt = " ( part_event.agentnum IS NULL
4038 OR part_event.agentnum = ". $self->agentnum. ' )';
4040 #XXX this shouldn't be hardcoded, actions should declare it...
4041 my @realtime_events = qw(
4042 cust_bill_realtime_card
4043 cust_bill_realtime_check
4044 cust_bill_realtime_lec
4048 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
4053 my @cust_event = qsearchs({
4054 'table' => 'cust_event',
4055 'select' => 'cust_event.*',
4056 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
4057 'hashref' => { 'status' => 'done' },
4058 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
4059 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
4062 my %seen_invnum = ();
4063 foreach my $cust_event (@cust_event) {
4065 #max one for the customer, one for each open invoice
4066 my $cust_X = $cust_event->cust_X;
4067 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
4071 or $cust_event->part_event->eventtable eq 'cust_bill'
4074 my $error = $cust_event->retry;
4076 $dbh->rollback if $oldAutoCommit;
4077 return "error scheduling event for retry: $error";
4082 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4087 # some horrid false laziness here to avoid refactor fallout
4088 # eventually realtime realtime_bop and realtime_refund_bop should go
4089 # away and be replaced by _new_realtime_bop and _new_realtime_refund_bop
4091 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
4093 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4094 via a Business::OnlinePayment realtime gateway. See
4095 L<http://420.am/business-onlinepayment> for supported gateways.
4097 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4099 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
4101 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4102 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4103 if set, will override the value from the customer record.
4105 I<description> is a free-text field passed to the gateway. It defaults to
4106 the value defined by the business-onlinepayment-description configuration
4107 option, or "Internet services" if that is unset.
4109 If an I<invnum> is specified, this payment (if successful) is applied to the
4110 specified invoice. If you don't specify an I<invnum> you might want to
4111 call the B<apply_payments> method or set the I<apply> option.
4113 I<apply> can be set to true to apply a resulting payment.
4115 I<quiet> can be set true to surpress email decline notices.
4117 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4118 resulting paynum, if any.
4120 I<payunique> is a unique identifier for this payment.
4122 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
4129 return $self->_new_realtime_bop(@_)
4130 if $self->_new_bop_required();
4132 my($method, $amount);
4134 if (ref($_[0]) eq 'HASH') {
4135 %options = %{$_[0]};
4136 $method = $options{method};
4137 $amount = $options{amount};
4139 ( $method, $amount ) = ( shift, shift );
4143 warn "$me realtime_bop: $method $amount\n";
4144 warn " $_ => $options{$_}\n" foreach keys %options;
4147 return "Amount must be greater than 0" unless $amount > 0;
4149 unless ( $options{'description'} ) {
4150 if ( $conf->exists('business-onlinepayment-description') ) {
4151 my $dtempl = $conf->config('business-onlinepayment-description');
4153 my $agent = $self->agent->agent;
4155 $options{'description'} = eval qq("$dtempl");
4157 $options{'description'} = 'Internet services';
4161 return $self->fake_bop($method, $amount, %options) if $options{'fake'};
4163 eval "use Business::OnlinePayment";
4166 my $payinfo = exists($options{'payinfo'})
4167 ? $options{'payinfo'}
4170 my %method2payby = (
4177 # check for banned credit card/ACH
4180 my $ban = qsearchs('banned_pay', {
4181 'payby' => $method2payby{$method},
4182 'payinfo' => md5_base64($payinfo),
4184 return "Banned credit card" if $ban;
4187 # set taxclass and trans_is_recur based on invnum if there is one
4191 my $trans_is_recur = 0;
4192 if ( $options{'invnum'} ) {
4194 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
4195 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
4198 map { $_->part_pkg }
4200 map { $_->cust_pkg }
4201 $cust_bill->cust_bill_pkg;
4203 my @taxclasses = map $_->taxclass, @part_pkg;
4204 $taxclass = $taxclasses[0]
4205 unless grep { $taxclasses[0] ne $_ } @taxclasses; #unless there are
4206 #different taxclasses
4208 if grep { $_->freq ne '0' } @part_pkg;
4216 #look for an agent gateway override first
4218 if ( $method eq 'CC' ) {
4219 $cardtype = cardtype($payinfo);
4220 } elsif ( $method eq 'ECHECK' ) {
4223 $cardtype = $method;
4227 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4228 cardtype => $cardtype,
4229 taxclass => $taxclass, } )
4230 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4232 taxclass => $taxclass, } )
4233 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4234 cardtype => $cardtype,
4236 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4238 taxclass => '', } );
4240 my $payment_gateway = '';
4241 my( $processor, $login, $password, $action, @bop_options );
4242 if ( $override ) { #use a payment gateway override
4244 $payment_gateway = $override->payment_gateway;
4246 $processor = $payment_gateway->gateway_module;
4247 $login = $payment_gateway->gateway_username;
4248 $password = $payment_gateway->gateway_password;
4249 $action = $payment_gateway->gateway_action;
4250 @bop_options = $payment_gateway->options;
4252 } else { #use the standard settings from the config
4254 ( $processor, $login, $password, $action, @bop_options ) =
4255 $self->default_payment_gateway($method);
4263 my $address = exists($options{'address1'})
4264 ? $options{'address1'}
4266 my $address2 = exists($options{'address2'})
4267 ? $options{'address2'}
4269 $address .= ", ". $address2 if length($address2);
4271 my $o_payname = exists($options{'payname'})
4272 ? $options{'payname'}
4274 my($payname, $payfirst, $paylast);
4275 if ( $o_payname && $method ne 'ECHECK' ) {
4276 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4277 or return "Illegal payname $payname";
4278 ($payfirst, $paylast) = ($1, $2);
4280 $payfirst = $self->getfield('first');
4281 $paylast = $self->getfield('last');
4282 $payname = "$payfirst $paylast";
4285 my @invoicing_list = $self->invoicing_list_emailonly;
4286 if ( $conf->exists('emailinvoiceautoalways')
4287 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4288 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4289 push @invoicing_list, $self->all_emails;
4292 my $email = ($conf->exists('business-onlinepayment-email-override'))
4293 ? $conf->config('business-onlinepayment-email-override')
4294 : $invoicing_list[0];
4298 my $payip = exists($options{'payip'})
4301 $content{customer_ip} = $payip
4304 $content{invoice_number} = $options{'invnum'}
4305 if exists($options{'invnum'}) && length($options{'invnum'});
4307 $content{email_customer} =
4308 ( $conf->exists('business-onlinepayment-email_customer')
4309 || $conf->exists('business-onlinepayment-email-override') );
4312 if ( $method eq 'CC' ) {
4314 $content{card_number} = $payinfo;
4315 $paydate = exists($options{'paydate'})
4316 ? $options{'paydate'}
4318 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4319 $content{expiration} = "$2/$1";
4321 my $paycvv = exists($options{'paycvv'})
4322 ? $options{'paycvv'}
4324 $content{cvv2} = $paycvv
4327 my $paystart_month = exists($options{'paystart_month'})
4328 ? $options{'paystart_month'}
4329 : $self->paystart_month;
4331 my $paystart_year = exists($options{'paystart_year'})
4332 ? $options{'paystart_year'}
4333 : $self->paystart_year;
4335 $content{card_start} = "$paystart_month/$paystart_year"
4336 if $paystart_month && $paystart_year;
4338 my $payissue = exists($options{'payissue'})
4339 ? $options{'payissue'}
4341 $content{issue_number} = $payissue if $payissue;
4343 if ( $self->_bop_recurring_billing( 'payinfo' => $payinfo,
4344 'trans_is_recur' => $trans_is_recur,
4348 $content{recurring_billing} = 'YES';
4349 $content{acct_code} = 'rebill'
4350 if $conf->exists('credit_card-recurring_billing_acct_code');
4353 } elsif ( $method eq 'ECHECK' ) {
4354 ( $content{account_number}, $content{routing_code} ) =
4355 split('@', $payinfo);
4356 $content{bank_name} = $o_payname;
4357 $content{bank_state} = exists($options{'paystate'})
4358 ? $options{'paystate'}
4359 : $self->getfield('paystate');
4360 $content{account_type} = exists($options{'paytype'})
4361 ? uc($options{'paytype'}) || 'CHECKING'
4362 : uc($self->getfield('paytype')) || 'CHECKING';
4363 $content{account_name} = $payname;
4364 $content{customer_org} = $self->company ? 'B' : 'I';
4365 $content{state_id} = exists($options{'stateid'})
4366 ? $options{'stateid'}
4367 : $self->getfield('stateid');
4368 $content{state_id_state} = exists($options{'stateid_state'})
4369 ? $options{'stateid_state'}
4370 : $self->getfield('stateid_state');
4371 $content{customer_ssn} = exists($options{'ss'})
4374 } elsif ( $method eq 'LEC' ) {
4375 $content{phone} = $payinfo;
4379 # run transaction(s)
4382 my $balance = exists( $options{'balance'} )
4383 ? $options{'balance'}
4386 $self->select_for_update; #mutex ... just until we get our pending record in
4388 #the checks here are intended to catch concurrent payments
4389 #double-form-submission prevention is taken care of in cust_pay_pending::check
4392 return "The customer's balance has changed; $method transaction aborted."
4393 if $self->balance < $balance;
4394 #&& $self->balance < $amount; #might as well anyway?
4396 #also check and make sure there aren't *other* pending payments for this cust
4398 my @pending = qsearch('cust_pay_pending', {
4399 'custnum' => $self->custnum,
4400 'status' => { op=>'!=', value=>'done' }
4402 return "A payment is already being processed for this customer (".
4403 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
4404 "); $method transaction aborted."
4405 if scalar(@pending);
4407 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
4409 my $cust_pay_pending = new FS::cust_pay_pending {
4410 'custnum' => $self->custnum,
4411 #'invnum' => $options{'invnum'},
4414 'payby' => $method2payby{$method},
4415 'payinfo' => $payinfo,
4416 'paydate' => $paydate,
4417 'recurring_billing' => $content{recurring_billing},
4418 'pkgnum' => $options{'pkgnum'},
4420 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
4422 $cust_pay_pending->payunique( $options{payunique} )
4423 if defined($options{payunique}) && length($options{payunique});
4424 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
4425 return $cpp_new_err if $cpp_new_err;
4427 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
4429 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
4430 $transaction->content(
4433 'password' => $password,
4434 'action' => $action1,
4435 'description' => $options{'description'},
4436 'amount' => $amount,
4437 #'invoice_number' => $options{'invnum'},
4438 'customer_id' => $self->custnum,
4439 'last_name' => $paylast,
4440 'first_name' => $payfirst,
4442 'address' => $address,
4443 'city' => ( exists($options{'city'})
4446 'state' => ( exists($options{'state'})
4449 'zip' => ( exists($options{'zip'})
4452 'country' => ( exists($options{'country'})
4453 ? $options{'country'}
4455 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4457 'phone' => $self->daytime || $self->night,
4461 $cust_pay_pending->status('pending');
4462 my $cpp_pending_err = $cust_pay_pending->replace;
4463 return $cpp_pending_err if $cpp_pending_err;
4466 my $BOP_TESTING = 0;
4467 my $BOP_TESTING_SUCCESS = 1;
4469 unless ( $BOP_TESTING ) {
4470 $transaction->submit();
4472 if ( $BOP_TESTING_SUCCESS ) {
4473 $transaction->is_success(1);
4474 $transaction->authorization('fake auth');
4476 $transaction->is_success(0);
4477 $transaction->error_message('fake failure');
4481 if ( $transaction->is_success() && $action2 ) {
4483 $cust_pay_pending->status('authorized');
4484 my $cpp_authorized_err = $cust_pay_pending->replace;
4485 return $cpp_authorized_err if $cpp_authorized_err;
4487 my $auth = $transaction->authorization;
4488 my $ordernum = $transaction->can('order_number')
4489 ? $transaction->order_number
4493 new Business::OnlinePayment( $processor, @bop_options );
4500 password => $password,
4501 order_number => $ordernum,
4503 authorization => $auth,
4504 description => $options{'description'},
4507 foreach my $field (qw( authorization_source_code returned_ACI
4508 transaction_identifier validation_code
4509 transaction_sequence_num local_transaction_date
4510 local_transaction_time AVS_result_code )) {
4511 $capture{$field} = $transaction->$field() if $transaction->can($field);
4514 $capture->content( %capture );
4518 unless ( $capture->is_success ) {
4519 my $e = "Authorization successful but capture failed, custnum #".
4520 $self->custnum. ': '. $capture->result_code.
4521 ": ". $capture->error_message;
4528 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
4529 my $cpp_captured_err = $cust_pay_pending->replace;
4530 return $cpp_captured_err if $cpp_captured_err;
4533 # remove paycvv after initial transaction
4536 #false laziness w/misc/process/payment.cgi - check both to make sure working
4538 if ( defined $self->dbdef_table->column('paycvv')
4539 && length($self->paycvv)
4540 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
4542 my $error = $self->remove_cvv;
4544 warn "WARNING: error removing cvv: $error\n";
4552 if ( $transaction->is_success() ) {
4555 if ( $payment_gateway ) { # agent override
4556 $paybatch = $payment_gateway->gatewaynum. '-';
4559 $paybatch .= "$processor:". $transaction->authorization;
4561 $paybatch .= ':'. $transaction->order_number
4562 if $transaction->can('order_number')
4563 && length($transaction->order_number);
4565 my $cust_pay = new FS::cust_pay ( {
4566 'custnum' => $self->custnum,
4567 'invnum' => $options{'invnum'},
4570 'payby' => $method2payby{$method},
4571 'payinfo' => $payinfo,
4572 'paybatch' => $paybatch,
4573 'paydate' => $paydate,
4574 'pkgnum' => $options{'pkgnum'},
4576 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
4577 $cust_pay->payunique( $options{payunique} )
4578 if defined($options{payunique}) && length($options{payunique});
4580 my $oldAutoCommit = $FS::UID::AutoCommit;
4581 local $FS::UID::AutoCommit = 0;
4584 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
4586 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
4589 $cust_pay->invnum(''); #try again with no specific invnum
4590 my $error2 = $cust_pay->insert( $options{'manual'} ?
4591 ( 'manual' => 1 ) : ()
4594 # gah. but at least we have a record of the state we had to abort in
4595 # from cust_pay_pending now.
4596 my $e = "WARNING: $method captured but payment not recorded - ".
4597 "error inserting payment ($processor): $error2".
4598 " (previously tried insert with invnum #$options{'invnum'}" .
4599 ": $error ) - pending payment saved as paypendingnum ".
4600 $cust_pay_pending->paypendingnum. "\n";
4606 if ( $options{'paynum_ref'} ) {
4607 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
4610 $cust_pay_pending->status('done');
4611 $cust_pay_pending->statustext('captured');
4612 $cust_pay_pending->paynum($cust_pay->paynum);
4613 my $cpp_done_err = $cust_pay_pending->replace;
4615 if ( $cpp_done_err ) {
4617 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4618 my $e = "WARNING: $method captured but payment not recorded - ".
4619 "error updating status for paypendingnum ".
4620 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4626 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4628 if ( $options{'apply'} ) {
4629 my $apply_error = $self->apply_payments_and_credits;
4630 if ( $apply_error ) {
4631 warn "WARNING: error applying payment: $apply_error\n";
4632 #but we still should return no error cause the payment otherwise went
4637 return ''; #no error
4643 my $perror = "$processor error: ". $transaction->error_message;
4645 unless ( $transaction->error_message ) {
4648 if ( $transaction->can('response_page') ) {
4650 'page' => ( $transaction->can('response_page')
4651 ? $transaction->response_page
4654 'code' => ( $transaction->can('response_code')
4655 ? $transaction->response_code
4658 'headers' => ( $transaction->can('response_headers')
4659 ? $transaction->response_headers
4665 "No additional debugging information available for $processor";
4668 $perror .= "No error_message returned from $processor -- ".
4669 ( ref($t_response) ? Dumper($t_response) : $t_response );
4673 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
4674 && $conf->exists('emaildecline')
4675 && grep { $_ ne 'POST' } $self->invoicing_list
4676 && ! grep { $transaction->error_message =~ /$_/ }
4677 $conf->config('emaildecline-exclude')
4679 my @templ = $conf->config('declinetemplate');
4680 my $template = new Text::Template (
4682 SOURCE => [ map "$_\n", @templ ],
4683 ) or return "($perror) can't create template: $Text::Template::ERROR";
4684 $template->compile()
4685 or return "($perror) can't compile template: $Text::Template::ERROR";
4689 scalar( $conf->config('company_name', $self->agentnum ) ),
4690 'company_address' =>
4691 join("\n", $conf->config('company_address', $self->agentnum ) ),
4692 'error' => $transaction->error_message,
4695 my $error = send_email(
4696 'from' => $conf->config('invoice_from', $self->agentnum ),
4697 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
4698 'subject' => 'Your payment could not be processed',
4699 'body' => [ $template->fill_in(HASH => $templ_hash) ],
4702 $perror .= " (also received error sending decline notification: $error)"
4707 $cust_pay_pending->status('done');
4708 $cust_pay_pending->statustext("declined: $perror");
4709 my $cpp_done_err = $cust_pay_pending->replace;
4710 if ( $cpp_done_err ) {
4711 my $e = "WARNING: $method declined but pending payment not resolved - ".
4712 "error updating status for paypendingnum ".
4713 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4715 $perror = "$e ($perror)";
4723 sub _bop_recurring_billing {
4724 my( $self, %opt ) = @_;
4726 my $method = scalar($conf->config('credit_card-recurring_billing_flag'));
4728 if ( defined($method) && $method eq 'transaction_is_recur' ) {
4730 return 1 if $opt{'trans_is_recur'};
4734 my %hash = ( 'custnum' => $self->custnum,
4739 if qsearch('cust_pay', { %hash, 'payinfo' => $opt{'payinfo'} } )
4740 || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo('CARD',
4751 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
4753 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
4754 via a Business::OnlinePayment realtime gateway. See
4755 L<http://420.am/business-onlinepayment> for supported gateways.
4757 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4759 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
4761 Most gateways require a reference to an original payment transaction to refund,
4762 so you probably need to specify a I<paynum>.
4764 I<amount> defaults to the original amount of the payment if not specified.
4766 I<reason> specifies a reason for the refund.
4768 I<paydate> specifies the expiration date for a credit card overriding the
4769 value from the customer record or the payment record. Specified as yyyy-mm-dd
4771 Implementation note: If I<amount> is unspecified or equal to the amount of the
4772 orignal payment, first an attempt is made to "void" the transaction via
4773 the gateway (to cancel a not-yet settled transaction) and then if that fails,
4774 the normal attempt is made to "refund" ("credit") the transaction via the
4775 gateway is attempted.
4777 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4778 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4779 #if set, will override the value from the customer record.
4781 #If an I<invnum> is specified, this payment (if successful) is applied to the
4782 #specified invoice. If you don't specify an I<invnum> you might want to
4783 #call the B<apply_payments> method.
4787 #some false laziness w/realtime_bop, not enough to make it worth merging
4788 #but some useful small subs should be pulled out
4789 sub realtime_refund_bop {
4792 return $self->_new_realtime_refund_bop(@_)
4793 if $self->_new_bop_required();
4795 my( $method, %options ) = @_;
4797 warn "$me realtime_refund_bop: $method refund\n";
4798 warn " $_ => $options{$_}\n" foreach keys %options;
4801 eval "use Business::OnlinePayment";
4805 # look up the original payment and optionally a gateway for that payment
4809 my $amount = $options{'amount'};
4811 my( $processor, $login, $password, @bop_options ) ;
4812 my( $auth, $order_number ) = ( '', '', '' );
4814 if ( $options{'paynum'} ) {
4816 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
4817 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
4818 or return "Unknown paynum $options{'paynum'}";
4819 $amount ||= $cust_pay->paid;
4821 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
4822 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
4823 $cust_pay->paybatch;
4824 my $gatewaynum = '';
4825 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
4827 if ( $gatewaynum ) { #gateway for the payment to be refunded
4829 my $payment_gateway =
4830 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
4831 die "payment gateway $gatewaynum not found"
4832 unless $payment_gateway;
4834 $processor = $payment_gateway->gateway_module;
4835 $login = $payment_gateway->gateway_username;
4836 $password = $payment_gateway->gateway_password;
4837 @bop_options = $payment_gateway->options;
4839 } else { #try the default gateway
4841 my( $conf_processor, $unused_action );
4842 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
4843 $self->default_payment_gateway($method);
4845 return "processor of payment $options{'paynum'} $processor does not".
4846 " match default processor $conf_processor"
4847 unless $processor eq $conf_processor;
4852 } else { # didn't specify a paynum, so look for agent gateway overrides
4853 # like a normal transaction
4856 if ( $method eq 'CC' ) {
4857 $cardtype = cardtype($self->payinfo);
4858 } elsif ( $method eq 'ECHECK' ) {
4861 $cardtype = $method;
4864 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4865 cardtype => $cardtype,
4867 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4869 taxclass => '', } );
4871 if ( $override ) { #use a payment gateway override
4873 my $payment_gateway = $override->payment_gateway;
4875 $processor = $payment_gateway->gateway_module;
4876 $login = $payment_gateway->gateway_username;
4877 $password = $payment_gateway->gateway_password;
4878 #$action = $payment_gateway->gateway_action;
4879 @bop_options = $payment_gateway->options;
4881 } else { #use the standard settings from the config
4884 ( $processor, $login, $password, $unused_action, @bop_options ) =
4885 $self->default_payment_gateway($method);
4890 return "neither amount nor paynum specified" unless $amount;
4895 'password' => $password,
4896 'order_number' => $order_number,
4897 'amount' => $amount,
4898 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4900 $content{authorization} = $auth
4901 if length($auth); #echeck/ACH transactions have an order # but no auth
4902 #(at least with authorize.net)
4904 my $disable_void_after;
4905 if ($conf->exists('disable_void_after')
4906 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
4907 $disable_void_after = $1;
4910 #first try void if applicable
4911 if ( $cust_pay && $cust_pay->paid == $amount
4913 ( not defined($disable_void_after) )
4914 || ( time < ($cust_pay->_date + $disable_void_after ) )
4917 warn " attempting void\n" if $DEBUG > 1;
4918 my $void = new Business::OnlinePayment( $processor, @bop_options );
4919 if ( $void->can('info') ) {
4920 if ( $cust_pay->payby eq 'CARD'
4921 && $void->info('CC_void_requires_card') )
4923 $content{'card_number'} = $cust_pay->payinfo
4924 } elsif ( $cust_pay->payby eq 'CHEK'
4925 && $void->info('ECHECK_void_requires_account') )
4927 ( $content{'account_number'}, $content{'routing_code'} ) =
4928 split('@', $cust_pay->payinfo);
4929 $content{'name'} = $self->get('first'). ' '. $self->get('last');
4932 $void->content( 'action' => 'void', %content );
4934 if ( $void->is_success ) {
4935 my $error = $cust_pay->void($options{'reason'});
4937 # gah, even with transactions.
4938 my $e = 'WARNING: Card/ACH voided but database not updated - '.
4939 "error voiding payment: $error";
4943 warn " void successful\n" if $DEBUG > 1;
4948 warn " void unsuccessful, trying refund\n"
4952 my $address = $self->address1;
4953 $address .= ", ". $self->address2 if $self->address2;
4955 my($payname, $payfirst, $paylast);
4956 if ( $self->payname && $method ne 'ECHECK' ) {
4957 $payname = $self->payname;
4958 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4959 or return "Illegal payname $payname";
4960 ($payfirst, $paylast) = ($1, $2);
4962 $payfirst = $self->getfield('first');
4963 $paylast = $self->getfield('last');
4964 $payname = "$payfirst $paylast";
4967 my @invoicing_list = $self->invoicing_list_emailonly;
4968 if ( $conf->exists('emailinvoiceautoalways')
4969 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4970 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4971 push @invoicing_list, $self->all_emails;
4974 my $email = ($conf->exists('business-onlinepayment-email-override'))
4975 ? $conf->config('business-onlinepayment-email-override')
4976 : $invoicing_list[0];
4978 my $payip = exists($options{'payip'})
4981 $content{customer_ip} = $payip
4985 if ( $method eq 'CC' ) {
4988 $content{card_number} = $payinfo = $cust_pay->payinfo;
4989 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
4990 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
4991 ($content{expiration} = "$2/$1"); # where available
4993 $content{card_number} = $payinfo = $self->payinfo;
4994 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
4995 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4996 $content{expiration} = "$2/$1";
4999 } elsif ( $method eq 'ECHECK' ) {
5002 $payinfo = $cust_pay->payinfo;
5004 $payinfo = $self->payinfo;
5006 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
5007 $content{bank_name} = $self->payname;
5008 $content{account_type} = 'CHECKING';
5009 $content{account_name} = $payname;
5010 $content{customer_org} = $self->company ? 'B' : 'I';
5011 $content{customer_ssn} = $self->ss;
5012 } elsif ( $method eq 'LEC' ) {
5013 $content{phone} = $payinfo = $self->payinfo;
5017 my $refund = new Business::OnlinePayment( $processor, @bop_options );
5018 my %sub_content = $refund->content(
5019 'action' => 'credit',
5020 'customer_id' => $self->custnum,
5021 'last_name' => $paylast,
5022 'first_name' => $payfirst,
5024 'address' => $address,
5025 'city' => $self->city,
5026 'state' => $self->state,
5027 'zip' => $self->zip,
5028 'country' => $self->country,
5030 'phone' => $self->daytime || $self->night,
5033 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
5037 return "$processor error: ". $refund->error_message
5038 unless $refund->is_success();
5040 my %method2payby = (
5046 my $paybatch = "$processor:". $refund->authorization;
5047 $paybatch .= ':'. $refund->order_number
5048 if $refund->can('order_number') && $refund->order_number;
5050 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
5051 my @cust_bill_pay = $cust_pay->cust_bill_pay;
5052 last unless @cust_bill_pay;
5053 my $cust_bill_pay = pop @cust_bill_pay;
5054 my $error = $cust_bill_pay->delete;
5058 my $cust_refund = new FS::cust_refund ( {
5059 'custnum' => $self->custnum,
5060 'paynum' => $options{'paynum'},
5061 'refund' => $amount,
5063 'payby' => $method2payby{$method},
5064 'payinfo' => $payinfo,
5065 'paybatch' => $paybatch,
5066 'reason' => $options{'reason'} || 'card or ACH refund',
5068 my $error = $cust_refund->insert;
5070 $cust_refund->paynum(''); #try again with no specific paynum
5071 my $error2 = $cust_refund->insert;
5073 # gah, even with transactions.
5074 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
5075 "error inserting refund ($processor): $error2".
5076 " (previously tried insert with paynum #$options{'paynum'}" .
5087 # does the configuration indicate the new bop routines are required?
5089 sub _new_bop_required {
5092 my $botpp = 'Business::OnlineThirdPartyPayment';
5095 if ( ( $conf->exists('business-onlinepayment-namespace')
5096 && $conf->config('business-onlinepayment-namespace') eq $botpp
5098 or scalar( grep { $_->gateway_namespace eq $botpp }
5099 qsearch( 'payment_gateway', { 'disabled' => '' } )
5107 =item realtime_collect [ OPTION => VALUE ... ]
5109 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
5110 via a Business::OnlinePayment or Business::OnlineThirdPartyPayment realtime
5111 gateway. See L<http://420.am/business-onlinepayment> and
5112 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5114 On failure returns an error message.
5116 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.
5118 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>, I<pkgnum>
5120 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>. If none is specified
5121 then it is deduced from the customer record.
5123 If no I<amount> is specified, then the customer balance is used.
5125 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5126 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5127 if set, will override the value from the customer record.
5129 I<description> is a free-text field passed to the gateway. It defaults to
5130 the value defined by the business-onlinepayment-description configuration
5131 option, or "Internet services" if that is unset.
5133 If an I<invnum> is specified, this payment (if successful) is applied to the
5134 specified invoice. If you don't specify an I<invnum> you might want to
5135 call the B<apply_payments> method or set the I<apply> option.
5137 I<apply> can be set to true to apply a resulting payment.
5139 I<quiet> can be set true to surpress email decline notices.
5141 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5142 resulting paynum, if any.
5144 I<payunique> is a unique identifier for this payment.
5146 I<session_id> is a session identifier associated with this payment.
5148 I<depend_jobnum> allows payment capture to unlock export jobs
5152 sub realtime_collect {
5153 my( $self, %options ) = @_;
5156 warn "$me realtime_collect:\n";
5157 warn " $_ => $options{$_}\n" foreach keys %options;
5160 $options{amount} = $self->balance unless exists( $options{amount} );
5161 $options{method} = FS::payby->payby2bop($self->payby)
5162 unless exists( $options{method} );
5164 return $self->realtime_bop({%options});
5168 =item _realtime_bop { [ ARG => VALUE ... ] }
5170 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
5171 via a Business::OnlinePayment realtime gateway. See
5172 L<http://420.am/business-onlinepayment> for supported gateways.
5174 Required arguments in the hashref are I<method>, and I<amount>
5176 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5178 Available optional arguments are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
5180 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5181 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5182 if set, will override the value from the customer record.
5184 I<description> is a free-text field passed to the gateway. It defaults to
5185 the value defined by the business-onlinepayment-description configuration
5186 option, or "Internet services" if that is unset.
5188 If an I<invnum> is specified, this payment (if successful) is applied to the
5189 specified invoice. If you don't specify an I<invnum> you might want to
5190 call the B<apply_payments> method.
5192 I<quiet> can be set true to surpress email decline notices.
5194 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5195 resulting paynum, if any.
5197 I<payunique> is a unique identifier for this payment.
5199 I<session_id> is a session identifier associated with this payment.
5201 I<depend_jobnum> allows payment capture to unlock export jobs
5203 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
5207 # some helper routines
5208 sub _payment_gateway {
5209 my ($self, $options) = @_;
5211 $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
5212 unless exists($options->{payment_gateway});
5214 $options->{payment_gateway};
5218 my ($self, $options) = @_;
5221 'login' => $options->{payment_gateway}->gateway_username,
5222 'password' => $options->{payment_gateway}->gateway_password,
5227 my ($self, $options) = @_;
5229 $options->{payment_gateway}->gatewaynum
5230 ? $options->{payment_gateway}->options
5231 : @{ $options->{payment_gateway}->get('options') };
5235 my ($self, $options) = @_;
5237 unless ( $options->{'description'} ) {
5238 if ( $conf->exists('business-onlinepayment-description') ) {
5239 my $dtempl = $conf->config('business-onlinepayment-description');
5241 my $agent = $self->agent->agent;
5243 $options->{'description'} = eval qq("$dtempl");
5245 $options->{'description'} = 'Internet services';
5249 $options->{payinfo} = $self->payinfo unless exists( $options->{payinfo} );
5250 $options->{invnum} ||= '';
5251 $options->{payname} = $self->payname unless exists( $options->{payname} );
5255 my ($self, $options) = @_;
5258 $content{address} = exists($options->{'address1'})
5259 ? $options->{'address1'}
5261 my $address2 = exists($options->{'address2'})
5262 ? $options->{'address2'}
5264 $content{address} .= ", ". $address2 if length($address2);
5266 my $payip = exists($options->{'payip'}) ? $options->{'payip'} : $self->payip;
5267 $content{customer_ip} = $payip if length($payip);
5269 $content{invoice_number} = $options->{'invnum'}
5270 if exists($options->{'invnum'}) && length($options->{'invnum'});
5272 $content{email_customer} =
5273 ( $conf->exists('business-onlinepayment-email_customer')
5274 || $conf->exists('business-onlinepayment-email-override') );
5276 $content{payfirst} = $self->getfield('first');
5277 $content{paylast} = $self->getfield('last');
5279 $content{account_name} = "$content{payfirst} $content{paylast}"
5280 if $options->{method} eq 'ECHECK';
5282 $content{name} = $options->{payname};
5283 $content{name} = $content{account_name} if exists($content{account_name});
5285 $content{city} = exists($options->{city})
5288 $content{state} = exists($options->{state})
5291 $content{zip} = exists($options->{zip})
5294 $content{country} = exists($options->{country})
5295 ? $options->{country}
5297 $content{referer} = 'http://cleanwhisker.420.am/'; #XXX fix referer :/
5298 $content{phone} = $self->daytime || $self->night;
5303 my %bop_method2payby = (
5309 sub _new_realtime_bop {
5313 if (ref($_[0]) eq 'HASH') {
5314 %options = %{$_[0]};
5316 my ( $method, $amount ) = ( shift, shift );
5318 $options{method} = $method;
5319 $options{amount} = $amount;
5323 warn "$me realtime_bop (new): $options{method} $options{amount}\n";
5324 warn " $_ => $options{$_}\n" foreach keys %options;
5327 return $self->fake_bop(%options) if $options{'fake'};
5329 $self->_bop_defaults(\%options);
5332 # set trans_is_recur based on invnum if there is one
5335 my $trans_is_recur = 0;
5336 if ( $options{'invnum'} ) {
5338 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
5339 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
5342 map { $_->part_pkg }
5344 map { $_->cust_pkg }
5345 $cust_bill->cust_bill_pkg;
5348 if grep { $_->freq ne '0' } @part_pkg;
5356 my $payment_gateway = $self->_payment_gateway( \%options );
5357 my $namespace = $payment_gateway->gateway_namespace;
5359 eval "use $namespace";
5363 # check for banned credit card/ACH
5366 my $ban = qsearchs('banned_pay', {
5367 'payby' => $bop_method2payby{$options{method}},
5368 'payinfo' => md5_base64($options{payinfo}),
5370 return "Banned credit card" if $ban;
5376 my (%bop_content) = $self->_bop_content(\%options);
5378 if ( $options{method} ne 'ECHECK' ) {
5379 $options{payname} =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5380 or return "Illegal payname $options{payname}";
5381 ($bop_content{payfirst}, $bop_content{paylast}) = ($1, $2);
5384 my @invoicing_list = $self->invoicing_list_emailonly;
5385 if ( $conf->exists('emailinvoiceautoalways')
5386 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5387 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5388 push @invoicing_list, $self->all_emails;
5391 my $email = ($conf->exists('business-onlinepayment-email-override'))
5392 ? $conf->config('business-onlinepayment-email-override')
5393 : $invoicing_list[0];
5397 if ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'CC' ) {
5399 $content{card_number} = $options{payinfo};
5400 $paydate = exists($options{'paydate'})
5401 ? $options{'paydate'}
5403 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
5404 $content{expiration} = "$2/$1";
5406 my $paycvv = exists($options{'paycvv'})
5407 ? $options{'paycvv'}
5409 $content{cvv2} = $paycvv
5412 my $paystart_month = exists($options{'paystart_month'})
5413 ? $options{'paystart_month'}
5414 : $self->paystart_month;
5416 my $paystart_year = exists($options{'paystart_year'})
5417 ? $options{'paystart_year'}
5418 : $self->paystart_year;
5420 $content{card_start} = "$paystart_month/$paystart_year"
5421 if $paystart_month && $paystart_year;
5423 my $payissue = exists($options{'payissue'})
5424 ? $options{'payissue'}
5426 $content{issue_number} = $payissue if $payissue;
5428 if ( $self->_bop_recurring_billing( 'payinfo' => $options{'payinfo'},
5429 'trans_is_recur' => $trans_is_recur,
5433 $content{recurring_billing} = 'YES';
5434 $content{acct_code} = 'rebill'
5435 if $conf->exists('credit_card-recurring_billing_acct_code');
5438 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'ECHECK' ){
5439 ( $content{account_number}, $content{routing_code} ) =
5440 split('@', $options{payinfo});
5441 $content{bank_name} = $options{payname};
5442 $content{bank_state} = exists($options{'paystate'})
5443 ? $options{'paystate'}
5444 : $self->getfield('paystate');
5445 $content{account_type} = exists($options{'paytype'})
5446 ? uc($options{'paytype'}) || 'CHECKING'
5447 : uc($self->getfield('paytype')) || 'CHECKING';
5448 $content{customer_org} = $self->company ? 'B' : 'I';
5449 $content{state_id} = exists($options{'stateid'})
5450 ? $options{'stateid'}
5451 : $self->getfield('stateid');
5452 $content{state_id_state} = exists($options{'stateid_state'})
5453 ? $options{'stateid_state'}
5454 : $self->getfield('stateid_state');
5455 $content{customer_ssn} = exists($options{'ss'})
5458 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'LEC' ) {
5459 $content{phone} = $options{payinfo};
5460 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5467 # run transaction(s)
5470 my $balance = exists( $options{'balance'} )
5471 ? $options{'balance'}
5474 $self->select_for_update; #mutex ... just until we get our pending record in
5476 #the checks here are intended to catch concurrent payments
5477 #double-form-submission prevention is taken care of in cust_pay_pending::check
5480 return "The customer's balance has changed; $options{method} transaction aborted."
5481 if $self->balance < $balance;
5482 #&& $self->balance < $options{amount}; #might as well anyway?
5484 #also check and make sure there aren't *other* pending payments for this cust
5486 my @pending = qsearch('cust_pay_pending', {
5487 'custnum' => $self->custnum,
5488 'status' => { op=>'!=', value=>'done' }
5490 return "A payment is already being processed for this customer (".
5491 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
5492 "); $options{method} transaction aborted."
5493 if scalar(@pending);
5495 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
5497 my $cust_pay_pending = new FS::cust_pay_pending {
5498 'custnum' => $self->custnum,
5499 #'invnum' => $options{'invnum'},
5500 'paid' => $options{amount},
5502 'payby' => $bop_method2payby{$options{method}},
5503 'payinfo' => $options{payinfo},
5504 'paydate' => $paydate,
5505 'recurring_billing' => $content{recurring_billing},
5506 'pkgnum' => $options{'pkgnum'},
5508 'gatewaynum' => $payment_gateway->gatewaynum || '',
5509 'session_id' => $options{session_id} || '',
5510 'jobnum' => $options{depend_jobnum} || '',
5512 $cust_pay_pending->payunique( $options{payunique} )
5513 if defined($options{payunique}) && length($options{payunique});
5514 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
5515 return $cpp_new_err if $cpp_new_err;
5517 my( $action1, $action2 ) =
5518 split( /\s*\,\s*/, $payment_gateway->gateway_action );
5520 my $transaction = new $namespace( $payment_gateway->gateway_module,
5521 $self->_bop_options(\%options),
5524 $transaction->content(
5525 'type' => $options{method},
5526 $self->_bop_auth(\%options),
5527 'action' => $action1,
5528 'description' => $options{'description'},
5529 'amount' => $options{amount},
5530 #'invoice_number' => $options{'invnum'},
5531 'customer_id' => $self->custnum,
5533 'reference' => $cust_pay_pending->paypendingnum, #for now
5538 $cust_pay_pending->status('pending');
5539 my $cpp_pending_err = $cust_pay_pending->replace;
5540 return $cpp_pending_err if $cpp_pending_err;
5543 my $BOP_TESTING = 0;
5544 my $BOP_TESTING_SUCCESS = 1;
5546 unless ( $BOP_TESTING ) {
5547 $transaction->submit();
5549 if ( $BOP_TESTING_SUCCESS ) {
5550 $transaction->is_success(1);
5551 $transaction->authorization('fake auth');
5553 $transaction->is_success(0);
5554 $transaction->error_message('fake failure');
5558 if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5560 return { reference => $cust_pay_pending->paypendingnum,
5561 map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
5563 } elsif ( $transaction->is_success() && $action2 ) {
5565 $cust_pay_pending->status('authorized');
5566 my $cpp_authorized_err = $cust_pay_pending->replace;
5567 return $cpp_authorized_err if $cpp_authorized_err;
5569 my $auth = $transaction->authorization;
5570 my $ordernum = $transaction->can('order_number')
5571 ? $transaction->order_number
5575 new Business::OnlinePayment( $payment_gateway->gateway_module,
5576 $self->_bop_options(\%options),
5581 type => $options{method},
5583 $self->_bop_auth(\%options),
5584 order_number => $ordernum,
5585 amount => $options{amount},
5586 authorization => $auth,
5587 description => $options{'description'},
5590 foreach my $field (qw( authorization_source_code returned_ACI
5591 transaction_identifier validation_code
5592 transaction_sequence_num local_transaction_date
5593 local_transaction_time AVS_result_code )) {
5594 $capture{$field} = $transaction->$field() if $transaction->can($field);
5597 $capture->content( %capture );
5601 unless ( $capture->is_success ) {
5602 my $e = "Authorization successful but capture failed, custnum #".
5603 $self->custnum. ': '. $capture->result_code.
5604 ": ". $capture->error_message;
5612 # remove paycvv after initial transaction
5615 #false laziness w/misc/process/payment.cgi - check both to make sure working
5617 if ( defined $self->dbdef_table->column('paycvv')
5618 && length($self->paycvv)
5619 && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
5621 my $error = $self->remove_cvv;
5623 warn "WARNING: error removing cvv: $error\n";
5631 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5643 if (ref($_[0]) eq 'HASH') {
5644 %options = %{$_[0]};
5646 my ( $method, $amount ) = ( shift, shift );
5648 $options{method} = $method;
5649 $options{amount} = $amount;
5652 if ( $options{'fake_failure'} ) {
5653 return "Error: No error; test failure requested with fake_failure";
5657 #if ( $payment_gateway->gatewaynum ) { # agent override
5658 # $paybatch = $payment_gateway->gatewaynum. '-';
5661 #$paybatch .= "$processor:". $transaction->authorization;
5663 #$paybatch .= ':'. $transaction->order_number
5664 # if $transaction->can('order_number')
5665 # && length($transaction->order_number);
5667 my $paybatch = 'FakeProcessor:54:32';
5669 my $cust_pay = new FS::cust_pay ( {
5670 'custnum' => $self->custnum,
5671 'invnum' => $options{'invnum'},
5672 'paid' => $options{amount},
5674 'payby' => $bop_method2payby{$options{method}},
5675 #'payinfo' => $payinfo,
5676 'payinfo' => '4111111111111111',
5677 'paybatch' => $paybatch,
5678 #'paydate' => $paydate,
5679 'paydate' => '2012-05-01',
5681 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
5683 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5686 $cust_pay->invnum(''); #try again with no specific invnum
5687 my $error2 = $cust_pay->insert( $options{'manual'} ?
5688 ( 'manual' => 1 ) : ()
5691 # gah, even with transactions.
5692 my $e = 'WARNING: Card/ACH debited but database not updated - '.
5693 "error inserting (fake!) payment: $error2".
5694 " (previously tried insert with invnum #$options{'invnum'}" .
5701 if ( $options{'paynum_ref'} ) {
5702 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5705 return ''; #no error
5710 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
5712 # Wraps up processing of a realtime credit card, ACH (electronic check) or
5713 # phone bill transaction.
5715 sub _realtime_bop_result {
5716 my( $self, $cust_pay_pending, $transaction, %options ) = @_;
5718 warn "$me _realtime_bop_result: pending transaction ".
5719 $cust_pay_pending->paypendingnum. "\n";
5720 warn " $_ => $options{$_}\n" foreach keys %options;
5723 my $payment_gateway = $options{payment_gateway}
5724 or return "no payment gateway in arguments to _realtime_bop_result";
5726 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
5727 my $cpp_captured_err = $cust_pay_pending->replace;
5728 return $cpp_captured_err if $cpp_captured_err;
5730 if ( $transaction->is_success() ) {
5733 if ( $payment_gateway->gatewaynum ) { # agent override
5734 $paybatch = $payment_gateway->gatewaynum. '-';
5737 $paybatch .= $payment_gateway->gateway_module. ":".
5738 $transaction->authorization;
5740 $paybatch .= ':'. $transaction->order_number
5741 if $transaction->can('order_number')
5742 && length($transaction->order_number);
5744 my $cust_pay = new FS::cust_pay ( {
5745 'custnum' => $self->custnum,
5746 'invnum' => $options{'invnum'},
5747 'paid' => $cust_pay_pending->paid,
5749 'payby' => $cust_pay_pending->payby,
5750 #'payinfo' => $payinfo,
5751 'paybatch' => $paybatch,
5752 'paydate' => $cust_pay_pending->paydate,
5753 'pkgnum' => $cust_pay_pending->pkgnum,
5755 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
5756 $cust_pay->payunique( $options{payunique} )
5757 if defined($options{payunique}) && length($options{payunique});
5759 my $oldAutoCommit = $FS::UID::AutoCommit;
5760 local $FS::UID::AutoCommit = 0;
5763 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
5765 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5768 $cust_pay->invnum(''); #try again with no specific invnum
5769 my $error2 = $cust_pay->insert( $options{'manual'} ?
5770 ( 'manual' => 1 ) : ()
5773 # gah. but at least we have a record of the state we had to abort in
5774 # from cust_pay_pending now.
5775 my $e = "WARNING: $options{method} captured but payment not recorded -".
5776 " error inserting payment (". $payment_gateway->gateway_module.
5778 " (previously tried insert with invnum #$options{'invnum'}" .
5779 ": $error ) - pending payment saved as paypendingnum ".
5780 $cust_pay_pending->paypendingnum. "\n";
5786 my $jobnum = $cust_pay_pending->jobnum;
5788 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5790 unless ( $placeholder ) {
5791 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5792 my $e = "WARNING: $options{method} captured but job $jobnum not ".
5793 "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
5798 $error = $placeholder->delete;
5801 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5802 my $e = "WARNING: $options{method} captured but could not delete ".
5803 "job $jobnum for paypendingnum ".
5804 $cust_pay_pending->paypendingnum. ": $error\n";
5811 if ( $options{'paynum_ref'} ) {
5812 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5815 $cust_pay_pending->status('done');
5816 $cust_pay_pending->statustext('captured');
5817 $cust_pay_pending->paynum($cust_pay->paynum);
5818 my $cpp_done_err = $cust_pay_pending->replace;
5820 if ( $cpp_done_err ) {
5822 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5823 my $e = "WARNING: $options{method} captured but payment not recorded - ".
5824 "error updating status for paypendingnum ".
5825 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5831 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5833 if ( $options{'apply'} ) {
5834 my $apply_error = $self->apply_payments_and_credits;
5835 if ( $apply_error ) {
5836 warn "WARNING: error applying payment: $apply_error\n";
5837 #but we still should return no error cause the payment otherwise went
5842 return ''; #no error
5848 my $perror = $payment_gateway->gateway_module. " error: ".
5849 $transaction->error_message;
5851 my $jobnum = $cust_pay_pending->jobnum;
5853 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5855 if ( $placeholder ) {
5856 my $error = $placeholder->depended_delete;
5857 $error ||= $placeholder->delete;
5858 warn "error removing provisioning jobs after declined paypendingnum ".
5859 $cust_pay_pending->paypendingnum. "\n";
5861 my $e = "error finding job $jobnum for declined paypendingnum ".
5862 $cust_pay_pending->paypendingnum. "\n";
5868 unless ( $transaction->error_message ) {
5871 if ( $transaction->can('response_page') ) {
5873 'page' => ( $transaction->can('response_page')
5874 ? $transaction->response_page
5877 'code' => ( $transaction->can('response_code')
5878 ? $transaction->response_code
5881 'headers' => ( $transaction->can('response_headers')
5882 ? $transaction->response_headers
5888 "No additional debugging information available for ".
5889 $payment_gateway->gateway_module;
5892 $perror .= "No error_message returned from ".
5893 $payment_gateway->gateway_module. " -- ".
5894 ( ref($t_response) ? Dumper($t_response) : $t_response );
5898 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
5899 && $conf->exists('emaildecline')
5900 && grep { $_ ne 'POST' } $self->invoicing_list
5901 && ! grep { $transaction->error_message =~ /$_/ }
5902 $conf->config('emaildecline-exclude')
5904 my @templ = $conf->config('declinetemplate');
5905 my $template = new Text::Template (
5907 SOURCE => [ map "$_\n", @templ ],
5908 ) or return "($perror) can't create template: $Text::Template::ERROR";
5909 $template->compile()
5910 or return "($perror) can't compile template: $Text::Template::ERROR";
5914 scalar( $conf->config('company_name', $self->agentnum ) ),
5915 'company_address' =>
5916 join("\n", $conf->config('company_address', $self->agentnum ) ),
5917 'error' => $transaction->error_message,
5920 my $error = send_email(
5921 'from' => $conf->config('invoice_from', $self->agentnum ),
5922 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
5923 'subject' => 'Your payment could not be processed',
5924 'body' => [ $template->fill_in(HASH => $templ_hash) ],
5927 $perror .= " (also received error sending decline notification: $error)"
5932 $cust_pay_pending->status('done');
5933 $cust_pay_pending->statustext("declined: $perror");
5934 my $cpp_done_err = $cust_pay_pending->replace;
5935 if ( $cpp_done_err ) {
5936 my $e = "WARNING: $options{method} declined but pending payment not ".
5937 "resolved - error updating status for paypendingnum ".
5938 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5940 $perror = "$e ($perror)";
5948 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
5950 Verifies successful third party processing of a realtime credit card,
5951 ACH (electronic check) or phone bill transaction via a
5952 Business::OnlineThirdPartyPayment realtime gateway. See
5953 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5955 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
5957 The additional options I<payname>, I<city>, I<state>,
5958 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5959 if set, will override the value from the customer record.
5961 I<description> is a free-text field passed to the gateway. It defaults to
5962 "Internet services".
5964 If an I<invnum> is specified, this payment (if successful) is applied to the
5965 specified invoice. If you don't specify an I<invnum> you might want to
5966 call the B<apply_payments> method.
5968 I<quiet> can be set true to surpress email decline notices.
5970 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5971 resulting paynum, if any.
5973 I<payunique> is a unique identifier for this payment.
5975 Returns a hashref containing elements bill_error (which will be undefined
5976 upon success) and session_id of any associated session.
5980 sub realtime_botpp_capture {
5981 my( $self, $cust_pay_pending, %options ) = @_;
5983 warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
5984 warn " $_ => $options{$_}\n" foreach keys %options;
5987 eval "use Business::OnlineThirdPartyPayment";
5991 # select the gateway
5994 my $method = FS::payby->payby2bop($cust_pay_pending->payby);
5996 my $payment_gateway = $cust_pay_pending->gatewaynum
5997 ? qsearchs( 'payment_gateway',
5998 { gatewaynum => $cust_pay_pending->gatewaynum }
6000 : $self->agent->payment_gateway( 'method' => $method,
6001 # 'invnum' => $cust_pay_pending->invnum,
6002 # 'payinfo' => $cust_pay_pending->payinfo,
6005 $options{payment_gateway} = $payment_gateway; # for the helper subs
6011 my @invoicing_list = $self->invoicing_list_emailonly;
6012 if ( $conf->exists('emailinvoiceautoalways')
6013 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
6014 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
6015 push @invoicing_list, $self->all_emails;
6018 my $email = ($conf->exists('business-onlinepayment-email-override'))
6019 ? $conf->config('business-onlinepayment-email-override')
6020 : $invoicing_list[0];
6024 $content{email_customer} =
6025 ( $conf->exists('business-onlinepayment-email_customer')
6026 || $conf->exists('business-onlinepayment-email-override') );
6029 # run transaction(s)
6033 new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
6034 $self->_bop_options(\%options),
6037 $transaction->reference({ %options });
6039 $transaction->content(
6041 $self->_bop_auth(\%options),
6042 'action' => 'Post Authorization',
6043 'description' => $options{'description'},
6044 'amount' => $cust_pay_pending->paid,
6045 #'invoice_number' => $options{'invnum'},
6046 'customer_id' => $self->custnum,
6047 'referer' => 'http://cleanwhisker.420.am/',
6048 'reference' => $cust_pay_pending->paypendingnum,
6050 'phone' => $self->daytime || $self->night,
6052 # plus whatever is required for bogus capture avoidance
6055 $transaction->submit();
6058 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
6061 bill_error => $error,
6062 session_id => $cust_pay_pending->session_id,
6067 =item default_payment_gateway DEPRECATED -- use agent->payment_gateway
6071 sub default_payment_gateway {
6072 my( $self, $method ) = @_;
6074 die "Real-time processing not enabled\n"
6075 unless $conf->exists('business-onlinepayment');
6077 #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
6080 my $bop_config = 'business-onlinepayment';
6081 $bop_config .= '-ach'
6082 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
6083 my ( $processor, $login, $password, $action, @bop_options ) =
6084 $conf->config($bop_config);
6085 $action ||= 'normal authorization';
6086 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
6087 die "No real-time processor is enabled - ".
6088 "did you set the business-onlinepayment configuration value?\n"
6091 ( $processor, $login, $password, $action, @bop_options )
6096 Removes the I<paycvv> field from the database directly.
6098 If there is an error, returns the error, otherwise returns false.
6104 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
6105 or return dbh->errstr;
6106 $sth->execute($self->custnum)
6107 or return $sth->errstr;
6112 =item _new_realtime_refund_bop METHOD [ OPTION => VALUE ... ]
6114 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
6115 via a Business::OnlinePayment realtime gateway. See
6116 L<http://420.am/business-onlinepayment> for supported gateways.
6118 Available methods are: I<CC>, I<ECHECK> and I<LEC>
6120 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
6122 Most gateways require a reference to an original payment transaction to refund,
6123 so you probably need to specify a I<paynum>.
6125 I<amount> defaults to the original amount of the payment if not specified.
6127 I<reason> specifies a reason for the refund.
6129 I<paydate> specifies the expiration date for a credit card overriding the
6130 value from the customer record or the payment record. Specified as yyyy-mm-dd
6132 Implementation note: If I<amount> is unspecified or equal to the amount of the
6133 orignal payment, first an attempt is made to "void" the transaction via
6134 the gateway (to cancel a not-yet settled transaction) and then if that fails,
6135 the normal attempt is made to "refund" ("credit") the transaction via the
6136 gateway is attempted.
6138 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
6139 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
6140 #if set, will override the value from the customer record.
6142 #If an I<invnum> is specified, this payment (if successful) is applied to the
6143 #specified invoice. If you don't specify an I<invnum> you might want to
6144 #call the B<apply_payments> method.
6148 #some false laziness w/realtime_bop, not enough to make it worth merging
6149 #but some useful small subs should be pulled out
6150 sub _new_realtime_refund_bop {
6154 if (ref($_[0]) ne 'HASH') {
6155 %options = %{$_[0]};
6159 $options{method} = $method;
6163 warn "$me realtime_refund_bop (new): $options{method} refund\n";
6164 warn " $_ => $options{$_}\n" foreach keys %options;
6168 # look up the original payment and optionally a gateway for that payment
6172 my $amount = $options{'amount'};
6174 my( $processor, $login, $password, @bop_options, $namespace ) ;
6175 my( $auth, $order_number ) = ( '', '', '' );
6177 if ( $options{'paynum'} ) {
6179 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
6180 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
6181 or return "Unknown paynum $options{'paynum'}";
6182 $amount ||= $cust_pay->paid;
6184 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
6185 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
6186 $cust_pay->paybatch;
6187 my $gatewaynum = '';
6188 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
6190 if ( $gatewaynum ) { #gateway for the payment to be refunded
6192 my $payment_gateway =
6193 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
6194 die "payment gateway $gatewaynum not found"
6195 unless $payment_gateway;
6197 $processor = $payment_gateway->gateway_module;
6198 $login = $payment_gateway->gateway_username;
6199 $password = $payment_gateway->gateway_password;
6200 $namespace = $payment_gateway->gateway_namespace;
6201 @bop_options = $payment_gateway->options;
6203 } else { #try the default gateway
6206 my $payment_gateway =
6207 $self->agent->payment_gateway('method' => $options{method});
6209 ( $conf_processor, $login, $password, $namespace ) =
6210 map { my $method = "gateway_$_"; $payment_gateway->$method }
6211 qw( module username password namespace );
6213 @bop_options = $payment_gateway->gatewaynum
6214 ? $payment_gateway->options
6215 : @{ $payment_gateway->get('options') };
6217 return "processor of payment $options{'paynum'} $processor does not".
6218 " match default processor $conf_processor"
6219 unless $processor eq $conf_processor;
6224 } else { # didn't specify a paynum, so look for agent gateway overrides
6225 # like a normal transaction
6227 my $payment_gateway =
6228 $self->agent->payment_gateway( 'method' => $options{method},
6229 #'payinfo' => $payinfo,
6231 my( $processor, $login, $password, $namespace ) =
6232 map { my $method = "gateway_$_"; $payment_gateway->$method }
6233 qw( module username password namespace );
6235 my @bop_options = $payment_gateway->gatewaynum
6236 ? $payment_gateway->options
6237 : @{ $payment_gateway->get('options') };
6240 return "neither amount nor paynum specified" unless $amount;
6242 eval "use $namespace";
6246 'type' => $options{method},
6248 'password' => $password,
6249 'order_number' => $order_number,
6250 'amount' => $amount,
6251 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
6253 $content{authorization} = $auth
6254 if length($auth); #echeck/ACH transactions have an order # but no auth
6255 #(at least with authorize.net)
6257 my $disable_void_after;
6258 if ($conf->exists('disable_void_after')
6259 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
6260 $disable_void_after = $1;
6263 #first try void if applicable
6264 if ( $cust_pay && $cust_pay->paid == $amount
6266 ( not defined($disable_void_after) )
6267 || ( time < ($cust_pay->_date + $disable_void_after ) )
6270 warn " attempting void\n" if $DEBUG > 1;
6271 my $void = new Business::OnlinePayment( $processor, @bop_options );
6272 if ( $void->can('info') ) {
6273 if ( $cust_pay->payby eq 'CARD'
6274 && $void->info('CC_void_requires_card') )
6276 $content{'card_number'} = $cust_pay->payinfo;
6277 } elsif ( $cust_pay->payby eq 'CHEK'
6278 && $void->info('ECHECK_void_requires_account') )
6280 ( $content{'account_number'}, $content{'routing_code'} ) =
6281 split('@', $cust_pay->payinfo);
6282 $content{'name'} = $self->get('first'). ' '. $self->get('last');
6285 $void->content( 'action' => 'void', %content );
6287 if ( $void->is_success ) {
6288 my $error = $cust_pay->void($options{'reason'});
6290 # gah, even with transactions.
6291 my $e = 'WARNING: Card/ACH voided but database not updated - '.
6292 "error voiding payment: $error";
6296 warn " void successful\n" if $DEBUG > 1;
6301 warn " void unsuccessful, trying refund\n"
6305 my $address = $self->address1;
6306 $address .= ", ". $self->address2 if $self->address2;
6308 my($payname, $payfirst, $paylast);
6309 if ( $self->payname && $options{method} ne 'ECHECK' ) {
6310 $payname = $self->payname;
6311 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
6312 or return "Illegal payname $payname";
6313 ($payfirst, $paylast) = ($1, $2);
6315 $payfirst = $self->getfield('first');
6316 $paylast = $self->getfield('last');
6317 $payname = "$payfirst $paylast";
6320 my @invoicing_list = $self->invoicing_list_emailonly;
6321 if ( $conf->exists('emailinvoiceautoalways')
6322 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
6323 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
6324 push @invoicing_list, $self->all_emails;
6327 my $email = ($conf->exists('business-onlinepayment-email-override'))
6328 ? $conf->config('business-onlinepayment-email-override')
6329 : $invoicing_list[0];
6331 my $payip = exists($options{'payip'})
6334 $content{customer_ip} = $payip
6338 if ( $options{method} eq 'CC' ) {
6341 $content{card_number} = $payinfo = $cust_pay->payinfo;
6342 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
6343 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
6344 ($content{expiration} = "$2/$1"); # where available
6346 $content{card_number} = $payinfo = $self->payinfo;
6347 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
6348 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
6349 $content{expiration} = "$2/$1";
6352 } elsif ( $options{method} eq 'ECHECK' ) {
6355 $payinfo = $cust_pay->payinfo;
6357 $payinfo = $self->payinfo;
6359 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
6360 $content{bank_name} = $self->payname;
6361 $content{account_type} = 'CHECKING';
6362 $content{account_name} = $payname;
6363 $content{customer_org} = $self->company ? 'B' : 'I';
6364 $content{customer_ssn} = $self->ss;
6365 } elsif ( $options{method} eq 'LEC' ) {
6366 $content{phone} = $payinfo = $self->payinfo;
6370 my $refund = new Business::OnlinePayment( $processor, @bop_options );
6371 my %sub_content = $refund->content(
6372 'action' => 'credit',
6373 'customer_id' => $self->custnum,
6374 'last_name' => $paylast,
6375 'first_name' => $payfirst,
6377 'address' => $address,
6378 'city' => $self->city,
6379 'state' => $self->state,
6380 'zip' => $self->zip,
6381 'country' => $self->country,
6383 'phone' => $self->daytime || $self->night,
6386 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
6390 return "$processor error: ". $refund->error_message
6391 unless $refund->is_success();
6393 my $paybatch = "$processor:". $refund->authorization;
6394 $paybatch .= ':'. $refund->order_number
6395 if $refund->can('order_number') && $refund->order_number;
6397 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
6398 my @cust_bill_pay = $cust_pay->cust_bill_pay;
6399 last unless @cust_bill_pay;
6400 my $cust_bill_pay = pop @cust_bill_pay;
6401 my $error = $cust_bill_pay->delete;
6405 my $cust_refund = new FS::cust_refund ( {
6406 'custnum' => $self->custnum,
6407 'paynum' => $options{'paynum'},
6408 'refund' => $amount,
6410 'payby' => $bop_method2payby{$options{method}},
6411 'payinfo' => $payinfo,
6412 'paybatch' => $paybatch,
6413 'reason' => $options{'reason'} || 'card or ACH refund',
6415 my $error = $cust_refund->insert;
6417 $cust_refund->paynum(''); #try again with no specific paynum
6418 my $error2 = $cust_refund->insert;
6420 # gah, even with transactions.
6421 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
6422 "error inserting refund ($processor): $error2".
6423 " (previously tried insert with paynum #$options{'paynum'}" .
6434 =item batch_card OPTION => VALUE...
6436 Adds a payment for this invoice to the pending credit card batch (see
6437 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
6438 runs the payment using a realtime gateway.
6443 my ($self, %options) = @_;
6446 if (exists($options{amount})) {
6447 $amount = $options{amount};
6449 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
6451 return '' unless $amount > 0;
6453 my $invnum = delete $options{invnum};
6454 my $payby = $options{invnum} || $self->payby; #dubious
6456 if ($options{'realtime'}) {
6457 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
6463 my $oldAutoCommit = $FS::UID::AutoCommit;
6464 local $FS::UID::AutoCommit = 0;
6467 #this needs to handle mysql as well as Pg, like svc_acct.pm
6468 #(make it into a common function if folks need to do batching with mysql)
6469 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
6470 or return "Cannot lock pay_batch: " . $dbh->errstr;
6474 'payby' => FS::payby->payby2payment($payby),
6477 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
6479 unless ( $pay_batch ) {
6480 $pay_batch = new FS::pay_batch \%pay_batch;
6481 my $error = $pay_batch->insert;
6483 $dbh->rollback if $oldAutoCommit;
6484 die "error creating new batch: $error\n";
6488 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
6489 'batchnum' => $pay_batch->batchnum,
6490 'custnum' => $self->custnum,
6493 foreach (qw( address1 address2 city state zip country payby payinfo paydate
6495 $options{$_} = '' unless exists($options{$_});
6498 my $cust_pay_batch = new FS::cust_pay_batch ( {
6499 'batchnum' => $pay_batch->batchnum,
6500 'invnum' => $invnum || 0, # is there a better value?
6501 # this field should be
6503 # cust_bill_pay_batch now
6504 'custnum' => $self->custnum,
6505 'last' => $self->getfield('last'),
6506 'first' => $self->getfield('first'),
6507 'address1' => $options{address1} || $self->address1,
6508 'address2' => $options{address2} || $self->address2,
6509 'city' => $options{city} || $self->city,
6510 'state' => $options{state} || $self->state,
6511 'zip' => $options{zip} || $self->zip,
6512 'country' => $options{country} || $self->country,
6513 'payby' => $options{payby} || $self->payby,
6514 'payinfo' => $options{payinfo} || $self->payinfo,
6515 'exp' => $options{paydate} || $self->paydate,
6516 'payname' => $options{payname} || $self->payname,
6517 'amount' => $amount, # consolidating
6520 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
6521 if $old_cust_pay_batch;
6524 if ($old_cust_pay_batch) {
6525 $error = $cust_pay_batch->replace($old_cust_pay_batch)
6527 $error = $cust_pay_batch->insert;
6531 $dbh->rollback if $oldAutoCommit;
6535 my $unapplied = $self->total_unapplied_credits
6536 + $self->total_unapplied_payments
6537 + $self->in_transit_payments;
6538 foreach my $cust_bill ($self->open_cust_bill) {
6539 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
6540 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
6541 'invnum' => $cust_bill->invnum,
6542 'paybatchnum' => $cust_pay_batch->paybatchnum,
6543 'amount' => $cust_bill->owed,
6546 if ($unapplied >= $cust_bill_pay_batch->amount){
6547 $unapplied -= $cust_bill_pay_batch->amount;
6550 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
6551 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
6553 $error = $cust_bill_pay_batch->insert;
6555 $dbh->rollback if $oldAutoCommit;
6560 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6564 =item apply_payments_and_credits [ OPTION => VALUE ... ]
6566 Applies unapplied payments and credits.
6568 In most cases, this new method should be used in place of sequential
6569 apply_payments and apply_credits methods.
6571 A hash of optional arguments may be passed. Currently "manual" is supported.
6572 If true, a payment receipt is sent instead of a statement when
6573 'payment_receipt_email' configuration option is set.
6575 If there is an error, returns the error, otherwise returns false.
6579 sub apply_payments_and_credits {
6580 my( $self, %options ) = @_;
6582 local $SIG{HUP} = 'IGNORE';
6583 local $SIG{INT} = 'IGNORE';
6584 local $SIG{QUIT} = 'IGNORE';
6585 local $SIG{TERM} = 'IGNORE';
6586 local $SIG{TSTP} = 'IGNORE';
6587 local $SIG{PIPE} = 'IGNORE';
6589 my $oldAutoCommit = $FS::UID::AutoCommit;
6590 local $FS::UID::AutoCommit = 0;
6593 $self->select_for_update; #mutex
6595 foreach my $cust_bill ( $self->open_cust_bill ) {
6596 my $error = $cust_bill->apply_payments_and_credits(%options);
6598 $dbh->rollback if $oldAutoCommit;
6599 return "Error applying: $error";
6603 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6608 =item apply_credits OPTION => VALUE ...
6610 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
6611 to outstanding invoice balances in chronological order (or reverse
6612 chronological order if the I<order> option is set to B<newest>) and returns the
6613 value of any remaining unapplied credits available for refund (see
6614 L<FS::cust_refund>).
6616 Dies if there is an error.
6624 local $SIG{HUP} = 'IGNORE';
6625 local $SIG{INT} = 'IGNORE';
6626 local $SIG{QUIT} = 'IGNORE';
6627 local $SIG{TERM} = 'IGNORE';
6628 local $SIG{TSTP} = 'IGNORE';
6629 local $SIG{PIPE} = 'IGNORE';
6631 my $oldAutoCommit = $FS::UID::AutoCommit;
6632 local $FS::UID::AutoCommit = 0;
6635 $self->select_for_update; #mutex
6637 unless ( $self->total_unapplied_credits ) {
6638 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6642 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
6643 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
6645 my @invoices = $self->open_cust_bill;
6646 @invoices = sort { $b->_date <=> $a->_date } @invoices
6647 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
6649 if ( $conf->exists('pkg-balances') ) {
6650 # limit @credits to those w/ a pkgnum grepped from $self
6652 foreach my $i (@invoices) {
6653 foreach my $li ( $i->cust_bill_pkg ) {
6654 $pkgnums{$li->pkgnum} = 1;
6657 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
6662 foreach my $cust_bill ( @invoices ) {
6664 if ( !defined($credit) || $credit->credited == 0) {
6665 $credit = pop @credits or last;
6669 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
6670 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
6672 $owed = $cust_bill->owed;
6674 unless ( $owed > 0 ) {
6675 push @credits, $credit;
6679 my $amount = min( $credit->credited, $owed );
6681 my $cust_credit_bill = new FS::cust_credit_bill ( {
6682 'crednum' => $credit->crednum,
6683 'invnum' => $cust_bill->invnum,
6684 'amount' => $amount,
6686 $cust_credit_bill->pkgnum( $credit->pkgnum )
6687 if $conf->exists('pkg-balances') && $credit->pkgnum;
6688 my $error = $cust_credit_bill->insert;
6690 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6694 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6698 my $total_unapplied_credits = $self->total_unapplied_credits;
6700 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6702 return $total_unapplied_credits;
6705 =item apply_payments [ OPTION => VALUE ... ]
6707 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
6708 to outstanding invoice balances in chronological order.
6710 #and returns the value of any remaining unapplied payments.
6712 A hash of optional arguments may be passed. Currently "manual" is supported.
6713 If true, a payment receipt is sent instead of a statement when
6714 'payment_receipt_email' configuration option is set.
6716 Dies if there is an error.
6720 sub apply_payments {
6721 my( $self, %options ) = @_;
6723 local $SIG{HUP} = 'IGNORE';
6724 local $SIG{INT} = 'IGNORE';
6725 local $SIG{QUIT} = 'IGNORE';
6726 local $SIG{TERM} = 'IGNORE';
6727 local $SIG{TSTP} = 'IGNORE';
6728 local $SIG{PIPE} = 'IGNORE';
6730 my $oldAutoCommit = $FS::UID::AutoCommit;
6731 local $FS::UID::AutoCommit = 0;
6734 $self->select_for_update; #mutex
6738 my @payments = sort { $b->_date <=> $a->_date }
6739 grep { $_->unapplied > 0 }
6742 my @invoices = sort { $a->_date <=> $b->_date}
6743 grep { $_->owed > 0 }
6746 if ( $conf->exists('pkg-balances') ) {
6747 # limit @payments to those w/ a pkgnum grepped from $self
6749 foreach my $i (@invoices) {
6750 foreach my $li ( $i->cust_bill_pkg ) {
6751 $pkgnums{$li->pkgnum} = 1;
6754 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
6759 foreach my $cust_bill ( @invoices ) {
6761 if ( !defined($payment) || $payment->unapplied == 0 ) {
6762 $payment = pop @payments or last;
6766 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
6767 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
6769 $owed = $cust_bill->owed;
6771 unless ( $owed > 0 ) {
6772 push @payments, $payment;
6776 my $amount = min( $payment->unapplied, $owed );
6778 my $cust_bill_pay = new FS::cust_bill_pay ( {
6779 'paynum' => $payment->paynum,
6780 'invnum' => $cust_bill->invnum,
6781 'amount' => $amount,
6783 $cust_bill_pay->pkgnum( $payment->pkgnum )
6784 if $conf->exists('pkg-balances') && $payment->pkgnum;
6785 my $error = $cust_bill_pay->insert(%options);
6787 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6791 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6795 my $total_unapplied_payments = $self->total_unapplied_payments;
6797 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6799 return $total_unapplied_payments;
6804 Returns the total owed for this customer on all invoices
6805 (see L<FS::cust_bill/owed>).
6811 $self->total_owed_date(2145859200); #12/31/2037
6814 =item total_owed_date TIME
6816 Returns the total owed for this customer on all invoices with date earlier than
6817 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6818 see L<Time::Local> and L<Date::Parse> for conversion functions.
6822 sub total_owed_date {
6826 # my $custnum = $self->custnum;
6828 # my $owed_sql = FS::cust_bill->owed_sql;
6831 # SELECT SUM($owed_sql) FROM cust_bill
6832 # WHERE custnum = $custnum
6833 # AND _date <= $time
6836 # my $sth = dbh->prepare($sql) or die dbh->errstr;
6837 # $sth->execute() or die $sth->errstr;
6839 # return sprintf( '%.2f', $sth->fetchrow_arrayref->[0] );
6842 foreach my $cust_bill (
6843 grep { $_->_date <= $time }
6844 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6846 $total_bill += $cust_bill->owed;
6848 sprintf( "%.2f", $total_bill );
6852 =item total_owed_pkgnum PKGNUM
6854 Returns the total owed on all invoices for this customer's specific package
6855 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
6859 sub total_owed_pkgnum {
6860 my( $self, $pkgnum ) = @_;
6861 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
6864 =item total_owed_date_pkgnum TIME PKGNUM
6866 Returns the total owed for this customer's specific package when using
6867 experimental package balances on all invoices with date earlier than
6868 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6869 see L<Time::Local> and L<Date::Parse> for conversion functions.
6873 sub total_owed_date_pkgnum {
6874 my( $self, $time, $pkgnum ) = @_;
6877 foreach my $cust_bill (
6878 grep { $_->_date <= $time }
6879 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6881 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
6883 sprintf( "%.2f", $total_bill );
6889 Returns the total amount of all payments.
6896 $total += $_->paid foreach $self->cust_pay;
6897 sprintf( "%.2f", $total );
6900 =item total_unapplied_credits
6902 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6903 customer. See L<FS::cust_credit/credited>.
6905 =item total_credited
6907 Old name for total_unapplied_credits. Don't use.
6911 sub total_credited {
6912 #carp "total_credited deprecated, use total_unapplied_credits";
6913 shift->total_unapplied_credits(@_);
6916 sub total_unapplied_credits {
6918 my $total_credit = 0;
6919 $total_credit += $_->credited foreach $self->cust_credit;
6920 sprintf( "%.2f", $total_credit );
6923 =item total_unapplied_credits_pkgnum PKGNUM
6925 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6926 customer. See L<FS::cust_credit/credited>.
6930 sub total_unapplied_credits_pkgnum {
6931 my( $self, $pkgnum ) = @_;
6932 my $total_credit = 0;
6933 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
6934 sprintf( "%.2f", $total_credit );
6938 =item total_unapplied_payments
6940 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
6941 See L<FS::cust_pay/unapplied>.
6945 sub total_unapplied_payments {
6947 my $total_unapplied = 0;
6948 $total_unapplied += $_->unapplied foreach $self->cust_pay;
6949 sprintf( "%.2f", $total_unapplied );
6952 =item total_unapplied_payments_pkgnum PKGNUM
6954 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
6955 specific package when using experimental package balances. See
6956 L<FS::cust_pay/unapplied>.
6960 sub total_unapplied_payments_pkgnum {
6961 my( $self, $pkgnum ) = @_;
6962 my $total_unapplied = 0;
6963 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
6964 sprintf( "%.2f", $total_unapplied );
6968 =item total_unapplied_refunds
6970 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
6971 customer. See L<FS::cust_refund/unapplied>.
6975 sub total_unapplied_refunds {
6977 my $total_unapplied = 0;
6978 $total_unapplied += $_->unapplied foreach $self->cust_refund;
6979 sprintf( "%.2f", $total_unapplied );
6984 Returns the balance for this customer (total_owed plus total_unrefunded, minus
6985 total_unapplied_credits minus total_unapplied_payments).
6993 + $self->total_unapplied_refunds
6994 - $self->total_unapplied_credits
6995 - $self->total_unapplied_payments
6999 =item balance_date TIME
7001 Returns the balance for this customer, only considering invoices with date
7002 earlier than TIME (total_owed_date minus total_credited minus
7003 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
7004 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
7013 $self->total_owed_date($time)
7014 + $self->total_unapplied_refunds
7015 - $self->total_unapplied_credits
7016 - $self->total_unapplied_payments
7020 =item balance_date_range START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
7022 Returns the balance for this customer, only considering invoices with date
7023 earlier than START_TIME, and optionally not later than END_TIME
7024 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
7026 Times are specified as SQL fragments or numeric
7027 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
7028 L<Date::Parse> for conversion functions. The empty string can be passed
7029 to disable that time constraint completely.
7031 Available options are:
7035 =item unapplied_date
7037 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)
7043 sub balance_date_range {
7045 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
7046 ') FROM cust_main WHERE custnum='. $self->custnum;
7047 sprintf( "%.2f", $self->scalar_sql($sql) );
7050 =item balance_pkgnum PKGNUM
7052 Returns the balance for this customer's specific package when using
7053 experimental package balances (total_owed plus total_unrefunded, minus
7054 total_unapplied_credits minus total_unapplied_payments)
7058 sub balance_pkgnum {
7059 my( $self, $pkgnum ) = @_;
7062 $self->total_owed_pkgnum($pkgnum)
7063 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
7064 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
7065 - $self->total_unapplied_credits_pkgnum($pkgnum)
7066 - $self->total_unapplied_payments_pkgnum($pkgnum)
7070 =item in_transit_payments
7072 Returns the total of requests for payments for this customer pending in
7073 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
7077 sub in_transit_payments {
7079 my $in_transit_payments = 0;
7080 foreach my $pay_batch ( qsearch('pay_batch', {
7083 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
7084 'batchnum' => $pay_batch->batchnum,
7085 'custnum' => $self->custnum,
7087 $in_transit_payments += $cust_pay_batch->amount;
7090 sprintf( "%.2f", $in_transit_payments );
7095 Returns a hash of useful information for making a payment.
7105 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
7106 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
7107 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
7111 For credit card transactions:
7123 For electronic check transactions:
7138 $return{balance} = $self->balance;
7140 $return{payname} = $self->payname
7141 || ( $self->first. ' '. $self->get('last') );
7143 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
7145 $return{payby} = $self->payby;
7146 $return{stateid_state} = $self->stateid_state;
7148 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
7149 $return{card_type} = cardtype($self->payinfo);
7150 $return{payinfo} = $self->paymask;
7152 @return{'month', 'year'} = $self->paydate_monthyear;
7156 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
7157 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
7158 $return{payinfo1} = $payinfo1;
7159 $return{payinfo2} = $payinfo2;
7160 $return{paytype} = $self->paytype;
7161 $return{paystate} = $self->paystate;
7165 #doubleclick protection
7167 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
7173 =item paydate_monthyear
7175 Returns a two-element list consisting of the month and year of this customer's
7176 paydate (credit card expiration date for CARD customers)
7180 sub paydate_monthyear {
7182 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
7184 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
7191 =item tax_exemption TAXNAME
7196 my( $self, $taxname ) = @_;
7198 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
7199 'taxname' => $taxname,
7204 =item cust_main_exemption
7208 sub cust_main_exemption {
7210 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
7213 =item invoicing_list [ ARRAYREF ]
7215 If an arguement is given, sets these email addresses as invoice recipients
7216 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
7217 (except as warnings), so use check_invoicing_list first.
7219 Returns a list of email addresses (with svcnum entries expanded).
7221 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
7222 check it without disturbing anything by passing nothing.
7224 This interface may change in the future.
7228 sub invoicing_list {
7229 my( $self, $arrayref ) = @_;
7232 my @cust_main_invoice;
7233 if ( $self->custnum ) {
7234 @cust_main_invoice =
7235 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7237 @cust_main_invoice = ();
7239 foreach my $cust_main_invoice ( @cust_main_invoice ) {
7240 #warn $cust_main_invoice->destnum;
7241 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
7242 #warn $cust_main_invoice->destnum;
7243 my $error = $cust_main_invoice->delete;
7244 warn $error if $error;
7247 if ( $self->custnum ) {
7248 @cust_main_invoice =
7249 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7251 @cust_main_invoice = ();
7253 my %seen = map { $_->address => 1 } @cust_main_invoice;
7254 foreach my $address ( @{$arrayref} ) {
7255 next if exists $seen{$address} && $seen{$address};
7256 $seen{$address} = 1;
7257 my $cust_main_invoice = new FS::cust_main_invoice ( {
7258 'custnum' => $self->custnum,
7261 my $error = $cust_main_invoice->insert;
7262 warn $error if $error;
7266 if ( $self->custnum ) {
7268 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7275 =item check_invoicing_list ARRAYREF
7277 Checks these arguements as valid input for the invoicing_list method. If there
7278 is an error, returns the error, otherwise returns false.
7282 sub check_invoicing_list {
7283 my( $self, $arrayref ) = @_;
7285 foreach my $address ( @$arrayref ) {
7287 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
7288 return 'Can\'t add FAX invoice destination with a blank FAX number.';
7291 my $cust_main_invoice = new FS::cust_main_invoice ( {
7292 'custnum' => $self->custnum,
7295 my $error = $self->custnum
7296 ? $cust_main_invoice->check
7297 : $cust_main_invoice->checkdest
7299 return $error if $error;
7303 return "Email address required"
7304 if $conf->exists('cust_main-require_invoicing_list_email')
7305 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
7310 =item set_default_invoicing_list
7312 Sets the invoicing list to all accounts associated with this customer,
7313 overwriting any previous invoicing list.
7317 sub set_default_invoicing_list {
7319 $self->invoicing_list($self->all_emails);
7324 Returns the email addresses of all accounts provisioned for this customer.
7331 foreach my $cust_pkg ( $self->all_pkgs ) {
7332 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
7334 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
7335 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
7337 $list{$_}=1 foreach map { $_->email } @svc_acct;
7342 =item invoicing_list_addpost
7344 Adds postal invoicing to this customer. If this customer is already configured
7345 to receive postal invoices, does nothing.
7349 sub invoicing_list_addpost {
7351 return if grep { $_ eq 'POST' } $self->invoicing_list;
7352 my @invoicing_list = $self->invoicing_list;
7353 push @invoicing_list, 'POST';
7354 $self->invoicing_list(\@invoicing_list);
7357 =item invoicing_list_emailonly
7359 Returns the list of email invoice recipients (invoicing_list without non-email
7360 destinations such as POST and FAX).
7364 sub invoicing_list_emailonly {
7366 warn "$me invoicing_list_emailonly called"
7368 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
7371 =item invoicing_list_emailonly_scalar
7373 Returns the list of email invoice recipients (invoicing_list without non-email
7374 destinations such as POST and FAX) as a comma-separated scalar.
7378 sub invoicing_list_emailonly_scalar {
7380 warn "$me invoicing_list_emailonly_scalar called"
7382 join(', ', $self->invoicing_list_emailonly);
7385 =item referral_custnum_cust_main
7387 Returns the customer who referred this customer (or the empty string, if
7388 this customer was not referred).
7390 Note the difference with referral_cust_main method: This method,
7391 referral_custnum_cust_main returns the single customer (if any) who referred
7392 this customer, while referral_cust_main returns an array of customers referred
7397 sub referral_custnum_cust_main {
7399 return '' unless $self->referral_custnum;
7400 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7403 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
7405 Returns an array of customers referred by this customer (referral_custnum set
7406 to this custnum). If DEPTH is given, recurses up to the given depth, returning
7407 customers referred by customers referred by this customer and so on, inclusive.
7408 The default behavior is DEPTH 1 (no recursion).
7410 Note the difference with referral_custnum_cust_main method: This method,
7411 referral_cust_main, returns an array of customers referred BY this customer,
7412 while referral_custnum_cust_main returns the single customer (if any) who
7413 referred this customer.
7417 sub referral_cust_main {
7419 my $depth = @_ ? shift : 1;
7420 my $exclude = @_ ? shift : {};
7423 map { $exclude->{$_->custnum}++; $_; }
7424 grep { ! $exclude->{ $_->custnum } }
7425 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
7429 map { $_->referral_cust_main($depth-1, $exclude) }
7436 =item referral_cust_main_ncancelled
7438 Same as referral_cust_main, except only returns customers with uncancelled
7443 sub referral_cust_main_ncancelled {
7445 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
7448 =item referral_cust_pkg [ DEPTH ]
7450 Like referral_cust_main, except returns a flat list of all unsuspended (and
7451 uncancelled) packages for each customer. The number of items in this list may
7452 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
7456 sub referral_cust_pkg {
7458 my $depth = @_ ? shift : 1;
7460 map { $_->unsuspended_pkgs }
7461 grep { $_->unsuspended_pkgs }
7462 $self->referral_cust_main($depth);
7465 =item referring_cust_main
7467 Returns the single cust_main record for the customer who referred this customer
7468 (referral_custnum), or false.
7472 sub referring_cust_main {
7474 return '' unless $self->referral_custnum;
7475 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7478 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
7480 Applies a credit to this customer. If there is an error, returns the error,
7481 otherwise returns false.
7483 REASON can be a text string, an FS::reason object, or a scalar reference to
7484 a reasonnum. If a text string, it will be automatically inserted as a new
7485 reason, and a 'reason_type' option must be passed to indicate the
7486 FS::reason_type for the new reason.
7488 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
7490 Any other options are passed to FS::cust_credit::insert.
7495 my( $self, $amount, $reason, %options ) = @_;
7497 my $cust_credit = new FS::cust_credit {
7498 'custnum' => $self->custnum,
7499 'amount' => $amount,
7502 if ( ref($reason) ) {
7504 if ( ref($reason) eq 'SCALAR' ) {
7505 $cust_credit->reasonnum( $$reason );
7507 $cust_credit->reasonnum( $reason->reasonnum );
7511 $cust_credit->set('reason', $reason)
7514 $cust_credit->addlinfo( delete $options{'addlinfo'} )
7515 if exists($options{'addlinfo'});
7517 $cust_credit->insert(%options);
7521 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
7523 Creates a one-time charge for this customer. If there is an error, returns
7524 the error, otherwise returns false.
7526 New-style, with a hashref of options:
7528 my $error = $cust_main->charge(
7532 'start_date' => str2time('7/4/2009'),
7533 'pkg' => 'Description',
7534 'comment' => 'Comment',
7535 'additional' => [], #extra invoice detail
7536 'classnum' => 1, #pkg_class
7538 'setuptax' => '', # or 'Y' for tax exempt
7541 'taxclass' => 'Tax class',
7544 'taxproduct' => 2, #part_pkg_taxproduct
7545 'override' => {}, #XXX describe
7547 #will be filled in with the new object
7548 'cust_pkg_ref' => \$cust_pkg,
7550 #generate an invoice immediately
7552 'invoice_terms' => '', #with these terms
7558 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
7564 my ( $amount, $quantity, $start_date, $classnum );
7565 my ( $pkg, $comment, $additional );
7566 my ( $setuptax, $taxclass ); #internal taxes
7567 my ( $taxproduct, $override ); #vendor (CCH) taxes
7569 my $cust_pkg_ref = '';
7570 my ( $bill_now, $invoice_terms ) = ( 0, '' );
7571 if ( ref( $_[0] ) ) {
7572 $amount = $_[0]->{amount};
7573 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
7574 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
7575 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
7576 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
7577 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
7578 : '$'. sprintf("%.2f",$amount);
7579 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
7580 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
7581 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
7582 $additional = $_[0]->{additional} || [];
7583 $taxproduct = $_[0]->{taxproductnum};
7584 $override = { '' => $_[0]->{tax_override} };
7585 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
7586 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
7587 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
7592 $pkg = @_ ? shift : 'One-time charge';
7593 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
7595 $taxclass = @_ ? shift : '';
7599 local $SIG{HUP} = 'IGNORE';
7600 local $SIG{INT} = 'IGNORE';
7601 local $SIG{QUIT} = 'IGNORE';
7602 local $SIG{TERM} = 'IGNORE';
7603 local $SIG{TSTP} = 'IGNORE';
7604 local $SIG{PIPE} = 'IGNORE';
7606 my $oldAutoCommit = $FS::UID::AutoCommit;
7607 local $FS::UID::AutoCommit = 0;
7610 my $part_pkg = new FS::part_pkg ( {
7612 'comment' => $comment,
7616 'classnum' => ( $classnum ? $classnum : '' ),
7617 'setuptax' => $setuptax,
7618 'taxclass' => $taxclass,
7619 'taxproductnum' => $taxproduct,
7622 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
7623 ( 0 .. @$additional - 1 )
7625 'additional_count' => scalar(@$additional),
7626 'setup_fee' => $amount,
7629 my $error = $part_pkg->insert( options => \%options,
7630 tax_overrides => $override,
7633 $dbh->rollback if $oldAutoCommit;
7637 my $pkgpart = $part_pkg->pkgpart;
7638 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
7639 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
7640 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
7641 $error = $type_pkgs->insert;
7643 $dbh->rollback if $oldAutoCommit;
7648 my $cust_pkg = new FS::cust_pkg ( {
7649 'custnum' => $self->custnum,
7650 'pkgpart' => $pkgpart,
7651 'quantity' => $quantity,
7652 'start_date' => $start_date,
7653 'no_auto' => $no_auto,
7656 $error = $cust_pkg->insert;
7658 $dbh->rollback if $oldAutoCommit;
7660 } elsif ( $cust_pkg_ref ) {
7661 ${$cust_pkg_ref} = $cust_pkg;
7665 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
7666 'pkg_list' => [ $cust_pkg ],
7669 $dbh->rollback if $oldAutoCommit;
7674 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
7679 #=item charge_postal_fee
7681 #Applies a one time charge this customer. If there is an error,
7682 #returns the error, returns the cust_pkg charge object or false
7683 #if there was no charge.
7687 # This should be a customer event. For that to work requires that bill
7688 # also be a customer event.
7690 sub charge_postal_fee {
7693 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
7694 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
7696 my $cust_pkg = new FS::cust_pkg ( {
7697 'custnum' => $self->custnum,
7698 'pkgpart' => $pkgpart,
7702 my $error = $cust_pkg->insert;
7703 $error ? $error : $cust_pkg;
7708 Returns all the invoices (see L<FS::cust_bill>) for this customer.
7714 map { $_ } #return $self->num_cust_bill unless wantarray;
7715 sort { $a->_date <=> $b->_date }
7716 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
7719 =item open_cust_bill
7721 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
7726 sub open_cust_bill {
7730 'table' => 'cust_bill',
7731 'hashref' => { 'custnum' => $self->custnum, },
7732 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
7733 'order_by' => 'ORDER BY _date ASC',
7738 =item cust_statements
7740 Returns all the statements (see L<FS::cust_statement>) for this customer.
7744 sub cust_statement {
7746 map { $_ } #return $self->num_cust_statement unless wantarray;
7747 sort { $a->_date <=> $b->_date }
7748 qsearch('cust_statement', { 'custnum' => $self->custnum, } )
7753 Returns all the credits (see L<FS::cust_credit>) for this customer.
7759 map { $_ } #return $self->num_cust_credit unless wantarray;
7760 sort { $a->_date <=> $b->_date }
7761 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
7764 =item cust_credit_pkgnum
7766 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
7767 package when using experimental package balances.
7771 sub cust_credit_pkgnum {
7772 my( $self, $pkgnum ) = @_;
7773 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
7774 sort { $a->_date <=> $b->_date }
7775 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
7776 'pkgnum' => $pkgnum,
7783 Returns all the payments (see L<FS::cust_pay>) for this customer.
7789 return $self->num_cust_pay unless wantarray;
7790 sort { $a->_date <=> $b->_date }
7791 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
7796 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
7797 called automatically when the cust_pay method is used in a scalar context.
7803 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
7804 my $sth = dbh->prepare($sql) or die dbh->errstr;
7805 $sth->execute($self->custnum) or die $sth->errstr;
7806 $sth->fetchrow_arrayref->[0];
7809 =item cust_pay_pkgnum
7811 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
7812 package when using experimental package balances.
7816 sub cust_pay_pkgnum {
7817 my( $self, $pkgnum ) = @_;
7818 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
7819 sort { $a->_date <=> $b->_date }
7820 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
7821 'pkgnum' => $pkgnum,
7828 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
7834 map { $_ } #return $self->num_cust_pay_void unless wantarray;
7835 sort { $a->_date <=> $b->_date }
7836 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
7839 =item cust_pay_batch
7841 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
7845 sub cust_pay_batch {
7847 map { $_ } #return $self->num_cust_pay_batch unless wantarray;
7848 sort { $a->paybatchnum <=> $b->paybatchnum }
7849 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
7852 =item cust_pay_pending
7854 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
7855 (without status "done").
7859 sub cust_pay_pending {
7861 return $self->num_cust_pay_pending unless wantarray;
7862 sort { $a->_date <=> $b->_date }
7863 qsearch( 'cust_pay_pending', {
7864 'custnum' => $self->custnum,
7865 'status' => { op=>'!=', value=>'done' },
7870 =item num_cust_pay_pending
7872 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
7873 customer (without status "done"). Also called automatically when the
7874 cust_pay_pending method is used in a scalar context.
7878 sub num_cust_pay_pending {
7880 my $sql = " SELECT COUNT(*) FROM cust_pay_pending ".
7881 " WHERE custnum = ? AND status != 'done' ";
7882 my $sth = dbh->prepare($sql) or die dbh->errstr;
7883 $sth->execute($self->custnum) or die $sth->errstr;
7884 $sth->fetchrow_arrayref->[0];
7889 Returns all the refunds (see L<FS::cust_refund>) for this customer.
7895 map { $_ } #return $self->num_cust_refund unless wantarray;
7896 sort { $a->_date <=> $b->_date }
7897 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
7900 =item display_custnum
7902 Returns the displayed customer number for this customer: agent_custid if
7903 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
7907 sub display_custnum {
7909 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
7910 return $self->agent_custid;
7912 return $self->custnum;
7918 Returns a name string for this customer, either "Company (Last, First)" or
7925 my $name = $self->contact;
7926 $name = $self->company. " ($name)" if $self->company;
7932 Returns a name string for this (service/shipping) contact, either
7933 "Company (Last, First)" or "Last, First".
7939 if ( $self->get('ship_last') ) {
7940 my $name = $self->ship_contact;
7941 $name = $self->ship_company. " ($name)" if $self->ship_company;
7950 Returns a name string for this customer, either "Company" or "First Last".
7956 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
7959 =item ship_name_short
7961 Returns a name string for this (service/shipping) contact, either "Company"
7966 sub ship_name_short {
7968 if ( $self->get('ship_last') ) {
7969 $self->ship_company !~ /^\s*$/
7970 ? $self->ship_company
7971 : $self->ship_contact_firstlast;
7973 $self->name_company_or_firstlast;
7979 Returns this customer's full (billing) contact name only, "Last, First"
7985 $self->get('last'). ', '. $self->first;
7990 Returns this customer's full (shipping) contact name only, "Last, First"
7996 $self->get('ship_last')
7997 ? $self->get('ship_last'). ', '. $self->ship_first
8001 =item contact_firstlast
8003 Returns this customers full (billing) contact name only, "First Last".
8007 sub contact_firstlast {
8009 $self->first. ' '. $self->get('last');
8012 =item ship_contact_firstlast
8014 Returns this customer's full (shipping) contact name only, "First Last".
8018 sub ship_contact_firstlast {
8020 $self->get('ship_last')
8021 ? $self->first. ' '. $self->get('ship_last')
8022 : $self->contact_firstlast;
8027 Returns this customer's full country name
8033 code2country($self->country);
8036 =item geocode DATA_VENDOR
8038 Returns a value for the customer location as encoded by DATA_VENDOR.
8039 Currently this only makes sense for "CCH" as DATA_VENDOR.
8044 my ($self, $data_vendor) = (shift, shift); #always cch for now
8046 my $geocode = $self->get('geocode'); #XXX only one data_vendor for geocode
8047 return $geocode if $geocode;
8049 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
8053 my($zip,$plus4) = split /-/, $self->get("${prefix}zip")
8054 if $self->country eq 'US';
8058 #CCH specific location stuff
8059 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
8061 my @cust_tax_location =
8063 'table' => 'cust_tax_location',
8064 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
8065 'extra_sql' => $extra_sql,
8066 'order_by' => 'ORDER BY plus4hi',#overlapping with distinct ends
8069 $geocode = $cust_tax_location[0]->geocode
8070 if scalar(@cust_tax_location);
8079 Returns a status string for this customer, currently:
8083 =item prospect - No packages have ever been ordered
8085 =item active - One or more recurring packages is active
8087 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
8089 =item suspended - All non-cancelled recurring packages are suspended
8091 =item cancelled - All recurring packages are cancelled
8097 sub status { shift->cust_status(@_); }
8101 for my $status (qw( prospect active inactive suspended cancelled )) {
8102 my $method = $status.'_sql';
8103 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
8104 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
8105 $sth->execute( ($self->custnum) x $numnum )
8106 or die "Error executing 'SELECT $sql': ". $sth->errstr;
8107 return $status if $sth->fetchrow_arrayref->[0];
8111 =item ucfirst_cust_status
8113 =item ucfirst_status
8115 Returns the status with the first character capitalized.
8119 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
8121 sub ucfirst_cust_status {
8123 ucfirst($self->cust_status);
8128 Returns a hex triplet color string for this customer's status.
8132 use vars qw(%statuscolor);
8133 tie %statuscolor, 'Tie::IxHash',
8134 'prospect' => '7e0079', #'000000', #black? naw, purple
8135 'active' => '00CC00', #green
8136 'inactive' => '0000CC', #blue
8137 'suspended' => 'FF9900', #yellow
8138 'cancelled' => 'FF0000', #red
8141 sub statuscolor { shift->cust_statuscolor(@_); }
8143 sub cust_statuscolor {
8145 $statuscolor{$self->cust_status};
8150 Returns an array of hashes representing the customer's RT tickets.
8157 my $num = $conf->config('cust_main-max_tickets') || 10;
8160 if ( $conf->config('ticket_system') ) {
8161 unless ( $conf->config('ticket_system-custom_priority_field') ) {
8163 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
8167 foreach my $priority (
8168 $conf->config('ticket_system-custom_priority_field-values'), ''
8170 last if scalar(@tickets) >= $num;
8172 @{ FS::TicketSystem->customer_tickets( $self->custnum,
8173 $num - scalar(@tickets),
8183 # Return services representing svc_accts in customer support packages
8184 sub support_services {
8186 my %packages = map { $_ => 1 } $conf->config('support_packages');
8188 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
8189 grep { $_->part_svc->svcdb eq 'svc_acct' }
8190 map { $_->cust_svc }
8191 grep { exists $packages{ $_->pkgpart } }
8192 $self->ncancelled_pkgs;
8196 # Return a list of latitude/longitude for one of the services (if any)
8197 sub service_coordinates {
8201 grep { $_->latitude && $_->longitude }
8203 map { $_->cust_svc }
8204 $self->ncancelled_pkgs;
8206 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
8211 =head1 CLASS METHODS
8217 Class method that returns the list of possible status strings for customers
8218 (see L<the status method|/status>). For example:
8220 @statuses = FS::cust_main->statuses();
8225 #my $self = shift; #could be class...
8231 Returns an SQL expression identifying prospective cust_main records (customers
8232 with no packages ever ordered)
8236 use vars qw($select_count_pkgs);
8237 $select_count_pkgs =
8238 "SELECT COUNT(*) FROM cust_pkg
8239 WHERE cust_pkg.custnum = cust_main.custnum";
8241 sub select_count_pkgs_sql {
8245 sub prospect_sql { "
8246 0 = ( $select_count_pkgs )
8251 Returns an SQL expression identifying active cust_main records (customers with
8252 active recurring packages).
8257 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
8263 Returns an SQL expression identifying inactive cust_main records (customers with
8264 no active recurring packages, but otherwise unsuspended/uncancelled).
8268 sub inactive_sql { "
8269 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
8271 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
8277 Returns an SQL expression identifying suspended cust_main records.
8282 sub suspended_sql { susp_sql(@_); }
8284 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
8286 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
8292 Returns an SQL expression identifying cancelled cust_main records.
8296 sub cancelled_sql { cancel_sql(@_); }
8299 my $recurring_sql = FS::cust_pkg->recurring_sql;
8300 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
8303 0 < ( $select_count_pkgs )
8304 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
8305 AND 0 = ( $select_count_pkgs AND $recurring_sql
8306 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
8308 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
8314 =item uncancelled_sql
8316 Returns an SQL expression identifying un-cancelled cust_main records.
8320 sub uncancelled_sql { uncancel_sql(@_); }
8321 sub uncancel_sql { "
8322 ( 0 < ( $select_count_pkgs
8323 AND ( cust_pkg.cancel IS NULL
8324 OR cust_pkg.cancel = 0
8327 OR 0 = ( $select_count_pkgs )
8333 Returns an SQL fragment to retreive the balance.
8338 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
8339 WHERE cust_bill.custnum = cust_main.custnum )
8340 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
8341 WHERE cust_pay.custnum = cust_main.custnum )
8342 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
8343 WHERE cust_credit.custnum = cust_main.custnum )
8344 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
8345 WHERE cust_refund.custnum = cust_main.custnum )
8348 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8350 Returns an SQL fragment to retreive the balance for this customer, only
8351 considering invoices with date earlier than START_TIME, and optionally not
8352 later than END_TIME (total_owed_date minus total_unapplied_credits minus
8353 total_unapplied_payments).
8355 Times are specified as SQL fragments or numeric
8356 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
8357 L<Date::Parse> for conversion functions. The empty string can be passed
8358 to disable that time constraint completely.
8360 Available options are:
8364 =item unapplied_date
8366 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)
8371 set to true to remove all customer comparison clauses, for totals
8376 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
8381 JOIN clause (typically used with the total option)
8387 sub balance_date_sql {
8388 my( $class, $start, $end, %opt ) = @_;
8390 my $owed = FS::cust_bill->owed_sql;
8391 my $unapp_refund = FS::cust_refund->unapplied_sql;
8392 my $unapp_credit = FS::cust_credit->unapplied_sql;
8393 my $unapp_pay = FS::cust_pay->unapplied_sql;
8395 my $j = $opt{'join'} || '';
8397 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
8398 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
8399 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
8400 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
8402 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
8403 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
8404 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
8405 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
8410 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
8412 Returns an SQL fragment to retreive the total unapplied payments for this
8413 customer, only considering invoices with date earlier than START_TIME, and
8414 optionally not later than END_TIME.
8416 Times are specified as SQL fragments or numeric
8417 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
8418 L<Date::Parse> for conversion functions. The empty string can be passed
8419 to disable that time constraint completely.
8421 Available options are:
8425 sub unapplied_payments_date_sql {
8426 my( $class, $start, $end, ) = @_;
8428 my $unapp_pay = FS::cust_pay->unapplied_sql;
8430 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
8431 'unapplied_date'=>1 );
8433 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
8436 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8438 Helper method for balance_date_sql; name (and usage) subject to change
8439 (suggestions welcome).
8441 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
8442 cust_refund, cust_credit or cust_pay).
8444 If TABLE is "cust_bill" or the unapplied_date option is true, only
8445 considers records with date earlier than START_TIME, and optionally not
8446 later than END_TIME .
8450 sub _money_table_where {
8451 my( $class, $table, $start, $end, %opt ) = @_;
8454 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
8455 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
8456 push @where, "$table._date <= $start" if defined($start) && length($start);
8457 push @where, "$table._date > $end" if defined($end) && length($end);
8459 push @where, @{$opt{'where'}} if $opt{'where'};
8460 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
8466 =item search HASHREF
8470 Returns a qsearch hash expression to search for parameters specified in
8471 HASHREF. Valid parameters are
8479 =item cancelled_pkgs
8485 listref of start date, end date
8495 =item current_balance
8497 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
8501 =item flattened_pkgs
8510 my ($class, $params) = @_;
8521 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
8523 "cust_main.agentnum = $1";
8530 #prospect active inactive suspended cancelled
8531 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
8532 my $method = $params->{'status'}. '_sql';
8533 #push @where, $class->$method();
8534 push @where, FS::cust_main->$method();
8538 # parse cancelled package checkbox
8543 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
8544 unless $params->{'cancelled_pkgs'};
8547 # parse without census tract checkbox
8550 push @where, "(censustract = '' or censustract is null)"
8551 if $params->{'no_censustract'};
8557 foreach my $field (qw( signupdate )) {
8559 next unless exists($params->{$field});
8561 my($beginning, $ending) = @{$params->{$field}};
8564 "cust_main.$field IS NOT NULL",
8565 "cust_main.$field >= $beginning",
8566 "cust_main.$field <= $ending";
8568 $orderby ||= "ORDER BY cust_main.$field";
8576 if ( $params->{'classnum'} ) {
8578 my @classnum = ref( $params->{'classnum'} )
8579 ? @{ $params->{'classnum'} }
8580 : ( $params->{'classnum'} );
8582 @classnum = grep /^(\d*)$/, @classnum;
8585 push @where, '( '. join(' OR ', map {
8586 $_ ? "cust_main.classnum = $_"
8587 : "cust_main.classnum IS NULL"
8600 if ( $params->{'payby'} ) {
8602 my @payby = ref( $params->{'payby'} )
8603 ? @{ $params->{'payby'} }
8604 : ( $params->{'payby'} );
8606 @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
8608 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )'
8614 # paydate_year / paydate_month
8617 if ( $params->{'paydate_year'} =~ /^(\d{4})$/ ) {
8619 $params->{'paydate_month'} =~ /^(\d\d?)$/
8620 or die "paydate_year without paydate_month?";
8624 'paydate IS NOT NULL',
8626 "CAST(paydate AS timestamp) < CAST('$year-$month-01' AS timestamp )"
8634 if ( $params->{'invoice_terms'} =~ /^([\w ]+)$/ ) {
8636 if ( $1 eq 'NULL' ) {
8638 "( cust_main.invoice_terms IS NULL OR cust_main.invoice_terms = '' )";
8641 "cust_main.invoice_terms IS NOT NULL",
8642 "cust_main.invoice_terms = '$1'";
8650 if ( $params->{'current_balance'} ) {
8652 #my $balance_sql = $class->balance_sql();
8653 my $balance_sql = FS::cust_main->balance_sql();
8655 my @current_balance =
8656 ref( $params->{'current_balance'} )
8657 ? @{ $params->{'current_balance'} }
8658 : ( $params->{'current_balance'} );
8660 push @where, map { s/current_balance/$balance_sql/; $_ }
8669 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
8671 "cust_main.custbatch = '$1'";
8675 # setup queries, subs, etc. for the search
8678 $orderby ||= 'ORDER BY custnum';
8680 # here is the agent virtualization
8681 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
8683 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
8685 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
8687 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
8689 my $select = join(', ',
8690 'cust_main.custnum',
8691 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
8694 my(@extra_headers) = ();
8695 my(@extra_fields) = ();
8697 if ($params->{'flattened_pkgs'}) {
8699 if ($dbh->{Driver}->{Name} eq 'Pg') {
8701 $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";
8703 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
8704 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
8705 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
8707 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
8708 "omitting packing information from report.";
8711 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";
8713 my $sth = dbh->prepare($header_query) or die dbh->errstr;
8714 $sth->execute() or die $sth->errstr;
8715 my $headerrow = $sth->fetchrow_arrayref;
8716 my $headercount = $headerrow ? $headerrow->[0] : 0;
8717 while($headercount) {
8718 unshift @extra_headers, "Package ". $headercount;
8719 unshift @extra_fields, eval q!sub {my $c = shift;
8720 my @a = split '\|', $c->magic;
8721 my $p = $a[!.--$headercount. q!];
8729 'table' => 'cust_main',
8730 'select' => $select,
8732 'extra_sql' => $extra_sql,
8733 'order_by' => $orderby,
8734 'count_query' => $count_query,
8735 'extra_headers' => \@extra_headers,
8736 'extra_fields' => \@extra_fields,
8741 =item email_search_result HASHREF
8745 Emails a notice to the specified customers.
8747 Valid parameters are those of the L<search> method, plus the following:
8769 Optional job queue job for status updates.
8773 Returns an error message, or false for success.
8775 If an error occurs during any email, stops the enture send and returns that
8776 error. Presumably if you're getting SMTP errors aborting is better than
8777 retrying everything.
8781 sub email_search_result {
8782 my($class, $params) = @_;
8784 my $from = delete $params->{from};
8785 my $subject = delete $params->{subject};
8786 my $html_body = delete $params->{html_body};
8787 my $text_body = delete $params->{text_body};
8789 my $job = delete $params->{'job'};
8791 $params->{'payby'} = [ split(/\0/, $params->{'payby'}) ]
8792 unless ref($params->{'payby'});
8794 my $sql_query = $class->search($params);
8796 my $count_query = delete($sql_query->{'count_query'});
8797 my $count_sth = dbh->prepare($count_query)
8798 or die "Error preparing $count_query: ". dbh->errstr;
8800 or die "Error executing $count_query: ". $count_sth->errstr;
8801 my $count_arrayref = $count_sth->fetchrow_arrayref;
8802 my $num_cust = $count_arrayref->[0];
8804 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
8805 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
8808 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
8810 #eventually order+limit magic to reduce memory use?
8811 foreach my $cust_main ( qsearch($sql_query) ) {
8813 my $to = $cust_main->invoicing_list_emailonly_scalar;
8816 my $error = send_email(
8820 'subject' => $subject,
8821 'html_body' => $html_body,
8822 'text_body' => $text_body,
8825 return $error if $error;
8827 if ( $job ) { #progressbar foo
8829 if ( time - $min_sec > $last ) {
8830 my $error = $job->update_statustext(
8831 int( 100 * $num / $num_cust )
8833 die $error if $error;
8843 use Storable qw(thaw);
8846 sub process_email_search_result {
8848 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
8850 my $param = thaw(decode_base64(shift));
8851 warn Dumper($param) if $DEBUG;
8853 $param->{'job'} = $job;
8855 $param->{'payby'} = [ split(/\0/, $param->{'payby'}) ]
8856 unless ref($param->{'payby'});
8858 my $error = FS::cust_main->email_search_result( $param );
8859 die $error if $error;
8863 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
8865 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
8866 records. Currently, I<first>, I<last>, I<company> and/or I<address1> may be
8867 specified (the appropriate ship_ field is also searched).
8869 Additional options are the same as FS::Record::qsearch
8874 my( $self, $fuzzy, $hash, @opt) = @_;
8879 check_and_rebuild_fuzzyfiles();
8880 foreach my $field ( keys %$fuzzy ) {
8882 my $all = $self->all_X($field);
8883 next unless scalar(@$all);
8886 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
8889 foreach ( keys %match ) {
8890 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
8891 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
8894 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
8897 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
8899 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
8907 Returns a masked version of the named field
8912 my ($self,$field) = @_;
8916 'x'x(length($self->getfield($field))-4).
8917 substr($self->getfield($field), (length($self->getfield($field))-4));
8927 =item smart_search OPTION => VALUE ...
8929 Accepts the following options: I<search>, the string to search for. The string
8930 will be searched for as a customer number, phone number, name or company name,
8931 as an exact, or, in some cases, a substring or fuzzy match (see the source code
8932 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
8933 skip fuzzy matching when an exact match is found.
8935 Any additional options are treated as an additional qualifier on the search
8938 Returns a (possibly empty) array of FS::cust_main objects.
8945 #here is the agent virtualization
8946 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8950 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
8951 my $search = delete $options{'search'};
8952 ( my $alphanum_search = $search ) =~ s/\W//g;
8954 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
8956 #false laziness w/Record::ut_phone
8957 my $phonen = "$1-$2-$3";
8958 $phonen .= " x$4" if $4;
8960 push @cust_main, qsearch( {
8961 'table' => 'cust_main',
8962 'hashref' => { %options },
8963 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8965 join(' OR ', map "$_ = '$phonen'",
8966 qw( daytime night fax
8967 ship_daytime ship_night ship_fax )
8970 " AND $agentnums_sql", #agent virtualization
8973 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
8974 #try looking for matches with extensions unless one was specified
8976 push @cust_main, qsearch( {
8977 'table' => 'cust_main',
8978 'hashref' => { %options },
8979 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8981 join(' OR ', map "$_ LIKE '$phonen\%'",
8983 ship_daytime ship_night )
8986 " AND $agentnums_sql", #agent virtualization
8991 # custnum search (also try agent_custid), with some tweaking options if your
8992 # legacy cust "numbers" have letters
8995 if ( $search =~ /^\s*(\d+)\s*$/
8996 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
8997 && $search =~ /^\s*(\w\w?\d+)\s*$/
8999 || ( $conf->exists('address1-search' )
9000 && $search =~ /^\s*(\d+\-?\w*)\s*$/ #i.e. 1234A or 9432-D
9007 if ( $num =~ /^(\d+)$/ && $num <= 2147483647 ) { #need a bigint custnum? wow
9008 push @cust_main, qsearch( {
9009 'table' => 'cust_main',
9010 'hashref' => { 'custnum' => $num, %options },
9011 'extra_sql' => " AND $agentnums_sql", #agent virtualization
9015 push @cust_main, qsearch( {
9016 'table' => 'cust_main',
9017 'hashref' => { 'agent_custid' => $num, %options },
9018 'extra_sql' => " AND $agentnums_sql", #agent virtualization
9021 if ( $conf->exists('address1-search') ) {
9022 my $len = length($num);
9024 foreach my $prefix ( '', 'ship_' ) {
9025 push @cust_main, qsearch( {
9026 'table' => 'cust_main',
9027 'hashref' => { %options, },
9029 ( keys(%options) ? ' AND ' : ' WHERE ' ).
9030 " LOWER(SUBSTRING(${prefix}address1 FROM 1 FOR $len)) = '$num' ".
9031 " AND $agentnums_sql",
9036 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
9038 my($company, $last, $first) = ( $1, $2, $3 );
9040 # "Company (Last, First)"
9041 #this is probably something a browser remembered,
9042 #so just do an exact search (but case-insensitive, so USPS standardization
9043 #doesn't throw a wrench in the works)
9045 foreach my $prefix ( '', 'ship_' ) {
9046 push @cust_main, qsearch( {
9047 'table' => 'cust_main',
9048 'hashref' => { %options },
9050 ( keys(%options) ? ' AND ' : ' WHERE ' ).
9052 " LOWER(${prefix}first) = ". dbh->quote(lc($first)),
9053 " LOWER(${prefix}last) = ". dbh->quote(lc($last)),
9054 " LOWER(${prefix}company) = ". dbh->quote(lc($company)),
9060 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
9061 # try (ship_){last,company}
9065 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
9066 # # full strings the browser remembers won't work
9067 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
9069 use Lingua::EN::NameParse;
9070 my $NameParse = new Lingua::EN::NameParse(
9072 allow_reversed => 1,
9075 my($last, $first) = ( '', '' );
9076 #maybe disable this too and just rely on NameParse?
9077 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
9079 ($last, $first) = ( $1, $2 );
9081 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
9082 } elsif ( ! $NameParse->parse($value) ) {
9084 my %name = $NameParse->components;
9085 $first = $name{'given_name_1'};
9086 $last = $name{'surname_1'};
9090 if ( $first && $last ) {
9092 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
9095 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
9097 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
9098 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
9101 push @cust_main, qsearch( {
9102 'table' => 'cust_main',
9103 'hashref' => \%options,
9104 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
9107 # or it just be something that was typed in... (try that in a sec)
9111 my $q_value = dbh->quote($value);
9114 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
9115 $sql .= " ( LOWER(last) = $q_value
9116 OR LOWER(company) = $q_value
9117 OR LOWER(ship_last) = $q_value
9118 OR LOWER(ship_company) = $q_value
9120 $sql .= " OR LOWER(address1) = $q_value
9121 OR LOWER(ship_address1) = $q_value
9123 if $conf->exists('address1-search');
9126 push @cust_main, qsearch( {
9127 'table' => 'cust_main',
9128 'hashref' => \%options,
9129 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
9132 #no exact match, trying substring/fuzzy
9133 #always do substring & fuzzy (unless they're explicity config'ed off)
9134 #getting complaints searches are not returning enough
9135 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
9137 #still some false laziness w/search (was search/cust_main.cgi)
9142 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
9143 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
9146 if ( $first && $last ) {
9149 { 'first' => { op=>'ILIKE', value=>"%$first%" },
9150 'last' => { op=>'ILIKE', value=>"%$last%" },
9152 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
9153 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
9160 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
9161 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
9165 if ( $conf->exists('address1-search') ) {
9167 { 'address1' => { op=>'ILIKE', value=>"%$value%" }, },
9168 { 'ship_address1' => { op=>'ILIKE', value=>"%$value%" }, },
9172 foreach my $hashref ( @hashrefs ) {
9174 push @cust_main, qsearch( {
9175 'table' => 'cust_main',
9176 'hashref' => { %$hashref,
9179 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
9188 " AND $agentnums_sql", #extra_sql #agent virtualization
9191 if ( $first && $last ) {
9192 push @cust_main, FS::cust_main->fuzzy_search(
9193 { 'last' => $last, #fuzzy hashref
9194 'first' => $first }, #
9198 foreach my $field ( 'last', 'company' ) {
9200 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
9202 if ( $conf->exists('address1-search') ) {
9204 FS::cust_main->fuzzy_search( { 'address1' => $value }, @fuzopts );
9211 #eliminate duplicates
9213 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
9221 Accepts the following options: I<email>, the email address to search for. The
9222 email address will be searched for as an email invoice destination and as an
9225 #Any additional options are treated as an additional qualifier on the search
9226 #(i.e. I<agentnum>).
9228 Returns a (possibly empty) array of FS::cust_main objects (but usually just
9238 my $email = delete $options{'email'};
9240 #we're only being used by RT at the moment... no agent virtualization yet
9241 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
9245 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
9247 my ( $user, $domain ) = ( $1, $2 );
9249 warn "$me smart_search: searching for $user in domain $domain"
9255 'table' => 'cust_main_invoice',
9256 'hashref' => { 'dest' => $email },
9263 map $_->cust_svc->cust_pkg,
9265 'table' => 'svc_acct',
9266 'hashref' => { 'username' => $user, },
9268 'AND ( SELECT domain FROM svc_domain
9269 WHERE svc_acct.domsvc = svc_domain.svcnum
9270 ) = '. dbh->quote($domain),
9276 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
9278 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
9285 =item check_and_rebuild_fuzzyfiles
9289 sub check_and_rebuild_fuzzyfiles {
9290 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9291 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
9294 =item rebuild_fuzzyfiles
9298 sub rebuild_fuzzyfiles {
9300 use Fcntl qw(:flock);
9302 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9303 mkdir $dir, 0700 unless -d $dir;
9305 foreach my $fuzzy ( @fuzzyfields ) {
9307 open(LOCK,">>$dir/cust_main.$fuzzy")
9308 or die "can't open $dir/cust_main.$fuzzy: $!";
9310 or die "can't lock $dir/cust_main.$fuzzy: $!";
9312 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
9313 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
9315 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
9316 my $sth = dbh->prepare("SELECT $field FROM cust_main".
9317 " WHERE $field != '' AND $field IS NOT NULL");
9318 $sth->execute or die $sth->errstr;
9320 while ( my $row = $sth->fetchrow_arrayref ) {
9321 print CACHE $row->[0]. "\n";
9326 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
9328 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
9339 my( $self, $field ) = @_;
9340 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9341 open(CACHE,"<$dir/cust_main.$field")
9342 or die "can't open $dir/cust_main.$field: $!";
9343 my @array = map { chomp; $_; } <CACHE>;
9348 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
9352 sub append_fuzzyfiles {
9353 #my( $first, $last, $company ) = @_;
9355 &check_and_rebuild_fuzzyfiles;
9357 use Fcntl qw(:flock);
9359 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9361 foreach my $field (@fuzzyfields) {
9366 open(CACHE,">>$dir/cust_main.$field")
9367 or die "can't open $dir/cust_main.$field: $!";
9368 flock(CACHE,LOCK_EX)
9369 or die "can't lock $dir/cust_main.$field: $!";
9371 print CACHE "$value\n";
9373 flock(CACHE,LOCK_UN)
9374 or die "can't unlock $dir/cust_main.$field: $!";
9389 #warn join('-',keys %$param);
9390 my $fh = $param->{filehandle};
9391 my @fields = @{$param->{fields}};
9393 eval "use Text::CSV_XS;";
9396 my $csv = new Text::CSV_XS;
9403 local $SIG{HUP} = 'IGNORE';
9404 local $SIG{INT} = 'IGNORE';
9405 local $SIG{QUIT} = 'IGNORE';
9406 local $SIG{TERM} = 'IGNORE';
9407 local $SIG{TSTP} = 'IGNORE';
9408 local $SIG{PIPE} = 'IGNORE';
9410 my $oldAutoCommit = $FS::UID::AutoCommit;
9411 local $FS::UID::AutoCommit = 0;
9414 #while ( $columns = $csv->getline($fh) ) {
9416 while ( defined($line=<$fh>) ) {
9418 $csv->parse($line) or do {
9419 $dbh->rollback if $oldAutoCommit;
9420 return "can't parse: ". $csv->error_input();
9423 my @columns = $csv->fields();
9424 #warn join('-',@columns);
9427 foreach my $field ( @fields ) {
9428 $row{$field} = shift @columns;
9431 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
9432 unless ( $cust_main ) {
9433 $dbh->rollback if $oldAutoCommit;
9434 return "unknown custnum $row{'custnum'}";
9437 if ( $row{'amount'} > 0 ) {
9438 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
9440 $dbh->rollback if $oldAutoCommit;
9444 } elsif ( $row{'amount'} < 0 ) {
9445 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
9448 $dbh->rollback if $oldAutoCommit;
9458 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
9460 return "Empty file!" unless $imported;
9466 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9468 Sends a templated email notification to the customer (see L<Text::Template>).
9470 OPTIONS is a hash and may include
9472 I<from> - the email sender (default is invoice_from)
9474 I<to> - comma-separated scalar or arrayref of recipients
9475 (default is invoicing_list)
9477 I<subject> - The subject line of the sent email notification
9478 (default is "Notice from company_name")
9480 I<extra_fields> - a hashref of name/value pairs which will be substituted
9483 The following variables are vavailable in the template.
9485 I<$first> - the customer first name
9486 I<$last> - the customer last name
9487 I<$company> - the customer company
9488 I<$payby> - a description of the method of payment for the customer
9489 # would be nice to use FS::payby::shortname
9490 I<$payinfo> - the account information used to collect for this customer
9491 I<$expdate> - the expiration of the customer payment in seconds from epoch
9496 my ($self, $template, %options) = @_;
9498 return unless $conf->exists($template);
9500 my $from = $conf->config('invoice_from', $self->agentnum)
9501 if $conf->exists('invoice_from', $self->agentnum);
9502 $from = $options{from} if exists($options{from});
9504 my $to = join(',', $self->invoicing_list_emailonly);
9505 $to = $options{to} if exists($options{to});
9507 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
9508 if $conf->exists('company_name', $self->agentnum);
9509 $subject = $options{subject} if exists($options{subject});
9511 my $notify_template = new Text::Template (TYPE => 'ARRAY',
9512 SOURCE => [ map "$_\n",
9513 $conf->config($template)]
9515 or die "can't create new Text::Template object: Text::Template::ERROR";
9516 $notify_template->compile()
9517 or die "can't compile template: Text::Template::ERROR";
9519 $FS::notify_template::_template::company_name =
9520 $conf->config('company_name', $self->agentnum);
9521 $FS::notify_template::_template::company_address =
9522 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
9524 my $paydate = $self->paydate || '2037-12-31';
9525 $FS::notify_template::_template::first = $self->first;
9526 $FS::notify_template::_template::last = $self->last;
9527 $FS::notify_template::_template::company = $self->company;
9528 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
9529 my $payby = $self->payby;
9530 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9531 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9533 #credit cards expire at the end of the month/year of their exp date
9534 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9535 $FS::notify_template::_template::payby = 'credit card';
9536 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9537 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9539 }elsif ($payby eq 'COMP') {
9540 $FS::notify_template::_template::payby = 'complimentary account';
9542 $FS::notify_template::_template::payby = 'current method';
9544 $FS::notify_template::_template::expdate = $expire_time;
9546 for (keys %{$options{extra_fields}}){
9548 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
9551 send_email(from => $from,
9553 subject => $subject,
9554 body => $notify_template->fill_in( PACKAGE =>
9555 'FS::notify_template::_template' ),
9560 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9562 Generates a templated notification to the customer (see L<Text::Template>).
9564 OPTIONS is a hash and may include
9566 I<extra_fields> - a hashref of name/value pairs which will be substituted
9567 into the template. These values may override values mentioned below
9568 and those from the customer record.
9570 The following variables are available in the template instead of or in addition
9571 to the fields of the customer record.
9573 I<$payby> - a description of the method of payment for the customer
9574 # would be nice to use FS::payby::shortname
9575 I<$payinfo> - the masked account information used to collect for this customer
9576 I<$expdate> - the expiration of the customer payment method in seconds from epoch
9577 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
9581 sub generate_letter {
9582 my ($self, $template, %options) = @_;
9584 return unless $conf->exists($template);
9586 my $letter_template = new Text::Template
9588 SOURCE => [ map "$_\n", $conf->config($template)],
9589 DELIMITERS => [ '[@--', '--@]' ],
9591 or die "can't create new Text::Template object: Text::Template::ERROR";
9593 $letter_template->compile()
9594 or die "can't compile template: Text::Template::ERROR";
9596 my %letter_data = map { $_ => $self->$_ } $self->fields;
9597 $letter_data{payinfo} = $self->mask_payinfo;
9599 #my $paydate = $self->paydate || '2037-12-31';
9600 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
9602 my $payby = $self->payby;
9603 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9604 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9606 #credit cards expire at the end of the month/year of their exp date
9607 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9608 $letter_data{payby} = 'credit card';
9609 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9610 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9612 }elsif ($payby eq 'COMP') {
9613 $letter_data{payby} = 'complimentary account';
9615 $letter_data{payby} = 'current method';
9617 $letter_data{expdate} = $expire_time;
9619 for (keys %{$options{extra_fields}}){
9620 $letter_data{$_} = $options{extra_fields}->{$_};
9623 unless(exists($letter_data{returnaddress})){
9624 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
9625 $self->agent_template)
9627 if ( length($retadd) ) {
9628 $letter_data{returnaddress} = $retadd;
9629 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
9630 $letter_data{returnaddress} =
9631 join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
9632 $conf->config('company_address', $self->agentnum)
9635 $letter_data{returnaddress} = '~';
9639 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
9641 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
9643 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
9644 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
9648 ) or die "can't open temp file: $!\n";
9650 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
9652 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
9656 =item print_ps TEMPLATE
9658 Returns an postscript letter filled in from TEMPLATE, as a scalar.
9664 my $file = $self->generate_letter(@_);
9665 FS::Misc::generate_ps($file);
9668 =item print TEMPLATE
9670 Prints the filled in template.
9672 TEMPLATE is the name of a L<Text::Template> to fill in and print.
9676 sub queueable_print {
9679 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
9680 or die "invalid customer number: " . $opt{custvnum};
9682 my $error = $self->print( $opt{template} );
9683 die $error if $error;
9687 my ($self, $template) = (shift, shift);
9688 do_print [ $self->print_ps($template) ];
9691 #these three subs should just go away once agent stuff is all config overrides
9693 sub agent_template {
9695 $self->_agent_plandata('agent_templatename');
9698 sub agent_invoice_from {
9700 $self->_agent_plandata('agent_invoice_from');
9703 sub _agent_plandata {
9704 my( $self, $option ) = @_;
9706 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
9707 #agent-specific Conf
9709 use FS::part_event::Condition;
9711 my $agentnum = $self->agentnum;
9714 if ( driver_name =~ /^Pg/i ) {
9716 } elsif ( driver_name =~ /^mysql/i ) {
9719 die "don't know how to use regular expressions in ". driver_name. " databases";
9722 my $part_event_option =
9724 'select' => 'part_event_option.*',
9725 'table' => 'part_event_option',
9727 LEFT JOIN part_event USING ( eventpart )
9728 LEFT JOIN part_event_option AS peo_agentnum
9729 ON ( part_event.eventpart = peo_agentnum.eventpart
9730 AND peo_agentnum.optionname = 'agentnum'
9731 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
9733 LEFT JOIN part_event_condition
9734 ON ( part_event.eventpart = part_event_condition.eventpart
9735 AND part_event_condition.conditionname = 'cust_bill_age'
9737 LEFT JOIN part_event_condition_option
9738 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
9739 AND part_event_condition_option.optionname = 'age'
9742 #'hashref' => { 'optionname' => $option },
9743 #'hashref' => { 'part_event_option.optionname' => $option },
9745 " WHERE part_event_option.optionname = ". dbh->quote($option).
9746 " AND action = 'cust_bill_send_agent' ".
9747 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
9748 " AND peo_agentnum.optionname = 'agentnum' ".
9749 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
9751 CASE WHEN part_event_condition_option.optionname IS NULL
9753 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
9755 , part_event.weight".
9759 unless ( $part_event_option ) {
9760 return $self->agent->invoice_template || ''
9761 if $option eq 'agent_templatename';
9765 $part_event_option->optionvalue;
9770 ## actual sub, not a method, designed to be called from the queue.
9771 ## sets up the customer, and calls the bill_and_collect
9772 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
9773 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
9774 $cust_main->bill_and_collect(
9779 sub _upgrade_data { #class method
9780 my ($class, %opts) = @_;
9782 my $sql = 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL';
9783 my $sth = dbh->prepare($sql) or die dbh->errstr;
9784 $sth->execute or die $sth->errstr;
9794 The delete method should possibly take an FS::cust_main object reference
9795 instead of a scalar customer number.
9797 Bill and collect options should probably be passed as references instead of a
9800 There should probably be a configuration file with a list of allowed credit
9803 No multiple currency support (probably a larger project than just this module).
9805 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
9807 Birthdates rely on negative epoch values.
9809 The payby for card/check batches is broken. With mixed batching, bad
9812 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
9816 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
9817 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
9818 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.