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 );
1915 =item all_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
1917 Returns all packages (see L<FS::cust_pkg>) for this customer.
1923 my $extra_qsearch = ref($_[0]) ? shift : {};
1925 return $self->num_pkgs unless wantarray || keys(%$extra_qsearch);
1928 if ( $self->{'_pkgnum'} ) {
1929 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1931 @cust_pkg = $self->_cust_pkg($extra_qsearch);
1934 sort sort_packages @cust_pkg;
1939 Synonym for B<all_pkgs>.
1944 shift->all_pkgs(@_);
1949 Returns all locations (see L<FS::cust_location>) for this customer.
1955 qsearch('cust_location', { 'custnum' => $self->custnum } );
1958 =item location_label [ OPTION => VALUE ... ]
1960 Returns the label of the service location (see analog in L<FS::cust_location>) for this customer.
1968 used to separate the address elements (defaults to ', ')
1970 =item escape_function
1972 a callback used for escaping the text of the address elements
1978 # false laziness with FS::cust_location::line
1980 sub location_label {
1984 my $separator = $opt{join_string} || ', ';
1985 my $escape = $opt{escape_function} || sub{ shift };
1987 my $cydefault = FS::conf->new->config('countrydefault') || 'US';
1988 my $prefix = length($self->ship_last) ? 'ship_' : '';
1991 foreach (qw ( address1 address2 ) ) {
1992 my $method = "$prefix$_";
1993 $line .= ($notfirst ? $separator : ''). &$escape($self->$method)
1998 foreach (qw ( city county state zip ) ) {
1999 my $method = "$prefix$_";
2000 if ( $self->$method ) {
2001 $line .= ' (' if $method eq 'county';
2002 $line .= ($notfirst ? ' ' : $separator). &$escape($self->$method);
2003 $line .= ' )' if $method eq 'county';
2007 $line .= $separator. &$escape(code2country($self->country))
2008 if $self->country ne $cydefault;
2013 =item ncancelled_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
2015 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
2019 sub ncancelled_pkgs {
2021 my $extra_qsearch = ref($_[0]) ? shift : {};
2023 return $self->num_ncancelled_pkgs unless wantarray;
2026 if ( $self->{'_pkgnum'} ) {
2028 warn "$me ncancelled_pkgs: returning cached objects"
2031 @cust_pkg = grep { ! $_->getfield('cancel') }
2032 values %{ $self->{'_pkgnum'}->cache };
2036 warn "$me ncancelled_pkgs: searching for packages with custnum ".
2037 $self->custnum. "\n"
2040 $extra_qsearch->{'extra_sql'} .= ' AND ( cancel IS NULL OR cancel = 0 ) ';
2042 @cust_pkg = $self->_cust_pkg($extra_qsearch);
2046 sort sort_packages @cust_pkg;
2052 my $extra_qsearch = ref($_[0]) ? shift : {};
2054 $extra_qsearch->{'select'} ||= '*';
2055 $extra_qsearch->{'select'} .=
2056 ',( SELECT COUNT(*) FROM cust_svc WHERE cust_pkg.pkgnum = cust_svc.pkgnum )
2060 $_->{'_num_cust_svc'} = $_->get('_num_cust_svc');
2065 'table' => 'cust_pkg',
2066 'hashref' => { 'custnum' => $self->custnum },
2071 # This should be generalized to use config options to determine order.
2074 my $locationsort = ( $a->locationnum || 0 ) <=> ( $b->locationnum || 0 );
2075 return $locationsort if $locationsort;
2077 if ( $a->get('cancel') xor $b->get('cancel') ) {
2078 return -1 if $b->get('cancel');
2079 return 1 if $a->get('cancel');
2080 #shouldn't get here...
2083 my $a_num_cust_svc = $a->num_cust_svc;
2084 my $b_num_cust_svc = $b->num_cust_svc;
2085 return 0 if !$a_num_cust_svc && !$b_num_cust_svc;
2086 return -1 if $a_num_cust_svc && !$b_num_cust_svc;
2087 return 1 if !$a_num_cust_svc && $b_num_cust_svc;
2088 my @a_cust_svc = $a->cust_svc;
2089 my @b_cust_svc = $b->cust_svc;
2090 $a_cust_svc[0]->svc_x->label cmp $b_cust_svc[0]->svc_x->label;
2095 =item suspended_pkgs
2097 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
2101 sub suspended_pkgs {
2103 grep { $_->susp } $self->ncancelled_pkgs;
2106 =item unflagged_suspended_pkgs
2108 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
2109 customer (thouse packages without the `manual_flag' set).
2113 sub unflagged_suspended_pkgs {
2115 return $self->suspended_pkgs
2116 unless dbdef->table('cust_pkg')->column('manual_flag');
2117 grep { ! $_->manual_flag } $self->suspended_pkgs;
2120 =item unsuspended_pkgs
2122 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
2127 sub unsuspended_pkgs {
2129 grep { ! $_->susp } $self->ncancelled_pkgs;
2132 =item next_bill_date
2134 Returns the next date this customer will be billed, as a UNIX timestamp, or
2135 undef if no active package has a next bill date.
2139 sub next_bill_date {
2141 min( map $_->get('bill'), grep $_->get('bill'), $self->unsuspended_pkgs );
2144 =item num_cancelled_pkgs
2146 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
2151 sub num_cancelled_pkgs {
2152 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
2155 sub num_ncancelled_pkgs {
2156 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
2160 my( $self ) = shift;
2161 my $sql = scalar(@_) ? shift : '';
2162 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
2163 my $sth = dbh->prepare(
2164 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
2165 ) or die dbh->errstr;
2166 $sth->execute($self->custnum) or die $sth->errstr;
2167 $sth->fetchrow_arrayref->[0];
2172 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2173 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2174 on success or a list of errors.
2180 grep { $_->unsuspend } $self->suspended_pkgs;
2185 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2187 Returns a list: an empty list on success or a list of errors.
2193 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2196 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2198 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2199 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2200 of a list of pkgparts; the hashref has the following keys:
2204 =item pkgparts - listref of pkgparts
2206 =item (other options are passed to the suspend method)
2211 Returns a list: an empty list on success or a list of errors.
2215 sub suspend_if_pkgpart {
2217 my (@pkgparts, %opt);
2218 if (ref($_[0]) eq 'HASH'){
2219 @pkgparts = @{$_[0]{pkgparts}};
2224 grep { $_->suspend(%opt) }
2225 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2226 $self->unsuspended_pkgs;
2229 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2231 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2232 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2233 instead of a list of pkgparts; the hashref has the following keys:
2237 =item pkgparts - listref of pkgparts
2239 =item (other options are passed to the suspend method)
2243 Returns a list: an empty list on success or a list of errors.
2247 sub suspend_unless_pkgpart {
2249 my (@pkgparts, %opt);
2250 if (ref($_[0]) eq 'HASH'){
2251 @pkgparts = @{$_[0]{pkgparts}};
2256 grep { $_->suspend(%opt) }
2257 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2258 $self->unsuspended_pkgs;
2261 =item cancel [ OPTION => VALUE ... ]
2263 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2265 Available options are:
2269 =item quiet - can be set true to supress email cancellation notices.
2271 =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.
2273 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2275 =item nobill - can be set true to skip billing if it might otherwise be done.
2279 Always returns a list: an empty list on success or a list of errors.
2283 # nb that dates are not specified as valid options to this method
2286 my( $self, %opt ) = @_;
2288 warn "$me cancel called on customer ". $self->custnum. " with options ".
2289 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2292 return ( 'access denied' )
2293 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2295 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2297 #should try decryption (we might have the private key)
2298 # and if not maybe queue a job for the server that does?
2299 return ( "Can't (yet) ban encrypted credit cards" )
2300 if $self->is_encrypted($self->payinfo);
2302 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
2303 my $error = $ban->insert;
2304 return ( $error ) if $error;
2308 my @pkgs = $self->ncancelled_pkgs;
2310 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2312 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2313 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2317 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2318 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2321 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2324 sub _banned_pay_hashref {
2335 'payby' => $payby2ban{$self->payby},
2336 'payinfo' => md5_base64($self->payinfo),
2337 #don't ever *search* on reason! #'reason' =>
2343 Returns all notes (see L<FS::cust_main_note>) for this customer.
2350 qsearch( 'cust_main_note',
2351 { 'custnum' => $self->custnum },
2353 'ORDER BY _DATE DESC'
2359 Returns the agent (see L<FS::agent>) for this customer.
2365 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2370 Returns the customer class, as an FS::cust_class object, or the empty string
2371 if there is no customer class.
2377 if ( $self->classnum ) {
2378 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2386 Returns the customer category name, or the empty string if there is no customer
2393 my $cust_class = $self->cust_class;
2395 ? $cust_class->categoryname
2401 Returns the customer class name, or the empty string if there is no customer
2408 my $cust_class = $self->cust_class;
2410 ? $cust_class->classname
2415 =item bill_and_collect
2417 Cancels and suspends any packages due, generates bills, applies payments and
2418 credits, and applies collection events to run cards, send bills and notices,
2421 By default, warns on errors and continues with the next operation (but see the
2422 "fatal" flag below).
2424 Options are passed as name-value pairs. Currently available options are:
2430 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:
2434 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2438 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.
2442 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2446 If set true, re-charges setup fees.
2450 If set any errors prevent subsequent operations from continusing. If set
2451 specifically to "return", returns the error (or false, if there is no error).
2452 Any other true value causes errors to die.
2456 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)
2460 Options are passed to the B<bill> and B<collect> methods verbatim, so all
2461 options of those methods are also available.
2465 sub bill_and_collect {
2466 my( $self, %options ) = @_;
2470 #$options{actual_time} not $options{time} because freeside-daily -d is for
2471 #pre-printing invoices
2473 $options{'actual_time'} ||= time;
2475 $error = $self->cancel_expired_pkgs( $options{actual_time} );
2477 $error = "Error expiring custnum ". $self->custnum. ": $error";
2478 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2479 elsif ( $options{fatal} ) { die $error; }
2480 else { warn $error; }
2483 $error = $self->suspend_adjourned_pkgs( $options{actual_time} );
2485 $error = "Error adjourning custnum ". $self->custnum. ": $error";
2486 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2487 elsif ( $options{fatal} ) { die $error; }
2488 else { warn $error; }
2491 $error = $self->bill( %options );
2493 $error = "Error billing custnum ". $self->custnum. ": $error";
2494 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2495 elsif ( $options{fatal} ) { die $error; }
2496 else { warn $error; }
2499 $error = $self->apply_payments_and_credits;
2501 $error = "Error applying custnum ". $self->custnum. ": $error";
2502 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2503 elsif ( $options{fatal} ) { die $error; }
2504 else { warn $error; }
2507 unless ( $conf->exists('cancelled_cust-noevents')
2508 && ! $self->num_ncancelled_pkgs
2510 $error = $self->collect( %options );
2512 $error = "Error collecting custnum ". $self->custnum. ": $error";
2513 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
2514 elsif ($options{fatal} ) { die $error; }
2515 else { warn $error; }
2523 sub cancel_expired_pkgs {
2524 my ( $self, $time, %options ) = @_;
2526 my @cancel_pkgs = $self->ncancelled_pkgs( {
2527 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
2532 foreach my $cust_pkg ( @cancel_pkgs ) {
2533 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
2534 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
2535 'reason_otaker' => $cpr->otaker
2539 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
2542 scalar(@errors) ? join(' / ', @errors) : '';
2546 sub suspend_adjourned_pkgs {
2547 my ( $self, $time, %options ) = @_;
2549 my @susp_pkgs = $self->ncancelled_pkgs( {
2551 " AND ( susp IS NULL OR susp = 0 )
2552 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
2553 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
2558 #only because there's no SQL test for is_prepaid :/
2560 grep { ( $_->part_pkg->is_prepaid
2565 && $_->adjourn <= $time
2573 foreach my $cust_pkg ( @susp_pkgs ) {
2574 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
2575 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
2576 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
2577 'reason_otaker' => $cpr->otaker
2581 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
2584 scalar(@errors) ? join(' / ', @errors) : '';
2590 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
2591 conjunction with the collect method by calling B<bill_and_collect>.
2593 If there is an error, returns the error, otherwise returns false.
2595 Options are passed as name-value pairs. Currently available options are:
2601 If set true, re-charges setup fees.
2605 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:
2609 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2613 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2615 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2619 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
2623 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.
2627 This boolean value informs the us that the package is being cancelled. This
2628 typically might mean not charging the normal recurring fee but only usage
2629 fees since the last billing. Setup charges may be charged. Not all package
2630 plans support this feature (they tend to charge 0).
2634 Optional terms to be printed on this invoice. Otherwise, customer-specific
2635 terms or the default terms are used.
2642 my( $self, %options ) = @_;
2643 return '' if $self->payby eq 'COMP';
2644 warn "$me bill customer ". $self->custnum. "\n"
2647 my $time = $options{'time'} || time;
2648 my $invoice_time = $options{'invoice_time'} || $time;
2650 $options{'not_pkgpart'} ||= {};
2651 $options{'not_pkgpart'} = { map { $_ => 1 }
2652 split(/\s*,\s*/, $options{'not_pkgpart'})
2654 unless ref($options{'not_pkgpart'});
2656 local $SIG{HUP} = 'IGNORE';
2657 local $SIG{INT} = 'IGNORE';
2658 local $SIG{QUIT} = 'IGNORE';
2659 local $SIG{TERM} = 'IGNORE';
2660 local $SIG{TSTP} = 'IGNORE';
2661 local $SIG{PIPE} = 'IGNORE';
2663 my $oldAutoCommit = $FS::UID::AutoCommit;
2664 local $FS::UID::AutoCommit = 0;
2667 $self->select_for_update; #mutex
2669 my $error = $self->do_cust_event(
2670 'debug' => ( $options{'debug'} || 0 ),
2671 'time' => $invoice_time,
2672 'check_freq' => $options{'check_freq'},
2673 'stage' => 'pre-bill',
2676 $dbh->rollback if $oldAutoCommit;
2680 my @cust_bill_pkg = ();
2683 # find the packages which are due for billing, find out how much they are
2684 # & generate invoice database.
2687 my( $total_setup, $total_recur, $postal_charge ) = ( 0, 0, 0 );
2689 my @precommit_hooks = ();
2691 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
2692 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
2694 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
2696 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2698 #? to avoid use of uninitialized value errors... ?
2699 $cust_pkg->setfield('bill', '')
2700 unless defined($cust_pkg->bill);
2702 #my $part_pkg = $cust_pkg->part_pkg;
2704 my $real_pkgpart = $cust_pkg->pkgpart;
2705 my %hash = $cust_pkg->hash;
2707 foreach my $part_pkg ( $cust_pkg->part_pkg->self_and_bill_linked ) {
2709 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
2712 $self->_make_lines( 'part_pkg' => $part_pkg,
2713 'cust_pkg' => $cust_pkg,
2714 'precommit_hooks' => \@precommit_hooks,
2715 'line_items' => \@cust_bill_pkg,
2716 'setup' => \$total_setup,
2717 'recur' => \$total_recur,
2718 'tax_matrix' => \%taxlisthash,
2720 'real_pkgpart' => $real_pkgpart,
2721 'options' => \%options,
2724 $dbh->rollback if $oldAutoCommit;
2728 } #foreach my $part_pkg
2730 } #foreach my $cust_pkg
2732 unless ( @cust_bill_pkg ) { #don't create an invoice w/o line items
2733 #but do commit any package date cycling that happened
2734 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2738 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
2739 !$conf->exists('postal_invoice-recurring_only')
2743 my $postal_pkg = $self->charge_postal_fee();
2744 if ( $postal_pkg && !ref( $postal_pkg ) ) {
2746 $dbh->rollback if $oldAutoCommit;
2747 return "can't charge postal invoice fee for customer ".
2748 $self->custnum. ": $postal_pkg";
2750 } elsif ( $postal_pkg ) {
2752 my $real_pkgpart = $postal_pkg->pkgpart;
2753 foreach my $part_pkg ( $postal_pkg->part_pkg->self_and_bill_linked ) {
2754 my %postal_options = %options;
2755 delete $postal_options{cancel};
2757 $self->_make_lines( 'part_pkg' => $part_pkg,
2758 'cust_pkg' => $postal_pkg,
2759 'precommit_hooks' => \@precommit_hooks,
2760 'line_items' => \@cust_bill_pkg,
2761 'setup' => \$total_setup,
2762 'recur' => \$total_recur,
2763 'tax_matrix' => \%taxlisthash,
2765 'real_pkgpart' => $real_pkgpart,
2766 'options' => \%postal_options,
2769 $dbh->rollback if $oldAutoCommit;
2778 my $listref_or_error =
2779 $self->calculate_taxes( \@cust_bill_pkg, \%taxlisthash, $invoice_time);
2781 unless ( ref( $listref_or_error ) ) {
2782 $dbh->rollback if $oldAutoCommit;
2783 return $listref_or_error;
2786 foreach my $taxline ( @$listref_or_error ) {
2787 $total_setup = sprintf('%.2f', $total_setup+$taxline->setup );
2788 push @cust_bill_pkg, $taxline;
2791 #add tax adjustments
2792 warn "adding tax adjustments...\n" if $DEBUG > 2;
2793 foreach my $cust_tax_adjustment (
2794 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
2800 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
2802 my $itemdesc = $cust_tax_adjustment->taxname;
2803 $itemdesc = '' if $itemdesc eq 'Tax';
2805 push @cust_bill_pkg, new FS::cust_bill_pkg {
2811 'itemdesc' => $itemdesc,
2812 'itemcomment' => $cust_tax_adjustment->comment,
2813 'cust_tax_adjustment' => $cust_tax_adjustment,
2814 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2819 my $charged = sprintf('%.2f', $total_setup + $total_recur );
2821 my @cust_bill = $self->cust_bill;
2822 my $balance = $self->balance;
2823 my $previous_balance = scalar(@cust_bill)
2824 ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
2827 $previous_balance += $cust_bill[$#cust_bill]->charged
2828 if scalar(@cust_bill);
2829 #my $balance_adjustments =
2830 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
2832 #create the new invoice
2833 my $cust_bill = new FS::cust_bill ( {
2834 'custnum' => $self->custnum,
2835 '_date' => ( $invoice_time ),
2836 'charged' => $charged,
2837 'billing_balance' => $balance,
2838 'previous_balance' => $previous_balance,
2839 'invoice_terms' => $options{'invoice_terms'},
2841 $error = $cust_bill->insert;
2843 $dbh->rollback if $oldAutoCommit;
2844 return "can't create invoice for customer #". $self->custnum. ": $error";
2847 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
2848 $cust_bill_pkg->invnum($cust_bill->invnum);
2849 my $error = $cust_bill_pkg->insert;
2851 $dbh->rollback if $oldAutoCommit;
2852 return "can't create invoice line item: $error";
2857 foreach my $hook ( @precommit_hooks ) {
2859 &{$hook}; #($self) ?
2862 $dbh->rollback if $oldAutoCommit;
2863 return "$@ running precommit hook $hook\n";
2867 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2871 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
2873 This is a weird one. Perhaps it should not even be exposed.
2875 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
2876 Usually used internally by bill method B<bill>.
2878 If there is an error, returns the error, otherwise returns reference to a
2879 list of line items suitable for insertion.
2885 An array ref of the line items being billed.
2889 A strange beast. The keys to this hash are internal identifiers consisting
2890 of the name of the tax object type, a space, and its unique identifier ( e.g.
2891 'cust_main_county 23' ). The values of the hash are listrefs. The first
2892 item in the list is the tax object. The remaining items are either line
2893 items or floating point values (currency amounts).
2895 The taxes are calculated on this entity. Calculated exemption records are
2896 transferred to the LINEITEMREF items on the assumption that they are related.
2902 This specifies the date appearing on the associated invoice. Some
2903 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
2908 sub calculate_taxes {
2909 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
2911 my @tax_line_items = ();
2913 warn "having a look at the taxes we found...\n" if $DEBUG > 2;
2915 # keys are tax names (as printed on invoices / itemdesc )
2916 # values are listrefs of taxlisthash keys (internal identifiers)
2919 # keys are taxlisthash keys (internal identifiers)
2920 # values are (cumulative) amounts
2923 # keys are taxlisthash keys (internal identifiers)
2924 # values are listrefs of cust_bill_pkg_tax_location hashrefs
2925 my %tax_location = ();
2927 # keys are taxlisthash keys (internal identifiers)
2928 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
2929 my %tax_rate_location = ();
2931 foreach my $tax ( keys %$taxlisthash ) {
2932 my $tax_object = shift @{ $taxlisthash->{$tax} };
2933 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
2934 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
2935 my $hashref_or_error =
2936 $tax_object->taxline( $taxlisthash->{$tax},
2937 'custnum' => $self->custnum,
2938 'invoice_time' => $invoice_time
2940 return $hashref_or_error unless ref($hashref_or_error);
2942 unshift @{ $taxlisthash->{$tax} }, $tax_object;
2944 my $name = $hashref_or_error->{'name'};
2945 my $amount = $hashref_or_error->{'amount'};
2947 #warn "adding $amount as $name\n";
2948 $taxname{ $name } ||= [];
2949 push @{ $taxname{ $name } }, $tax;
2951 $tax{ $tax } += $amount;
2953 $tax_location{ $tax } ||= [];
2954 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
2955 push @{ $tax_location{ $tax } },
2957 'taxnum' => $tax_object->taxnum,
2958 'taxtype' => ref($tax_object),
2959 'pkgnum' => $tax_object->get('pkgnum'),
2960 'locationnum' => $tax_object->get('locationnum'),
2961 'amount' => sprintf('%.2f', $amount ),
2965 $tax_rate_location{ $tax } ||= [];
2966 if ( ref($tax_object) eq 'FS::tax_rate' ) {
2967 my $taxratelocationnum =
2968 $tax_object->tax_rate_location->taxratelocationnum;
2969 push @{ $tax_rate_location{ $tax } },
2971 'taxnum' => $tax_object->taxnum,
2972 'taxtype' => ref($tax_object),
2973 'amount' => sprintf('%.2f', $amount ),
2974 'locationtaxid' => $tax_object->location,
2975 'taxratelocationnum' => $taxratelocationnum,
2981 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
2982 my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
2983 foreach my $tax ( keys %$taxlisthash ) {
2984 foreach ( @{ $taxlisthash->{$tax} }[1 ... scalar(@{ $taxlisthash->{$tax} })] ) {
2985 next unless ref($_) eq 'FS::cust_bill_pkg';
2987 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
2988 splice( @{ $_->_cust_tax_exempt_pkg } );
2992 #consolidate and create tax line items
2993 warn "consolidating and generating...\n" if $DEBUG > 2;
2994 foreach my $taxname ( keys %taxname ) {
2997 my @cust_bill_pkg_tax_location = ();
2998 my @cust_bill_pkg_tax_rate_location = ();
2999 warn "adding $taxname\n" if $DEBUG > 1;
3000 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
3001 next if $seen{$taxitem}++;
3002 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
3003 $tax += $tax{$taxitem};
3004 push @cust_bill_pkg_tax_location,
3005 map { new FS::cust_bill_pkg_tax_location $_ }
3006 @{ $tax_location{ $taxitem } };
3007 push @cust_bill_pkg_tax_rate_location,
3008 map { new FS::cust_bill_pkg_tax_rate_location $_ }
3009 @{ $tax_rate_location{ $taxitem } };
3013 $tax = sprintf('%.2f', $tax );
3015 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
3021 if ( $pkg_category and
3022 $conf->config('invoice_latexsummary') ||
3023 $conf->config('invoice_htmlsummary')
3027 my %hash = ( 'section' => $pkg_category->categoryname );
3028 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3032 push @tax_line_items, new FS::cust_bill_pkg {
3038 'itemdesc' => $taxname,
3039 'display' => \@display,
3040 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
3041 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
3050 my ($self, %params) = @_;
3052 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
3053 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
3054 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
3055 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
3056 my $total_setup = $params{setup} or die "no setup accumulator specified";
3057 my $total_recur = $params{recur} or die "no recur accumulator specified";
3058 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
3059 my $time = $params{'time'} or die "no time specified";
3060 my (%options) = %{$params{options}};
3063 my $real_pkgpart = $params{real_pkgpart};
3064 my %hash = $cust_pkg->hash;
3065 my $old_cust_pkg = new FS::cust_pkg \%hash;
3071 $cust_pkg->pkgpart($part_pkg->pkgpart);
3079 if ( $options{'resetup'}
3080 || ( ! $cust_pkg->setup
3081 && ( ! $cust_pkg->start_date
3082 || $cust_pkg->start_date <= $time
3084 && ( ! $conf->exists('disable_setup_suspended_pkgs')
3085 || ( $conf->exists('disable_setup_suspended_pkgs') &&
3086 ! $cust_pkg->getfield('susp')
3093 warn " bill setup\n" if $DEBUG > 1;
3096 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
3097 return "$@ running calc_setup for $cust_pkg\n"
3100 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
3102 $cust_pkg->setfield('setup', $time)
3103 unless $cust_pkg->setup;
3104 #do need it, but it won't get written to the db
3105 #|| $cust_pkg->pkgpart != $real_pkgpart;
3107 $cust_pkg->setfield('start_date', '')
3108 if $cust_pkg->start_date;
3113 # bill recurring fee
3116 #XXX unit stuff here too
3120 if ( ! $cust_pkg->get('susp')
3121 and ! $cust_pkg->get('start_date')
3122 and ( $part_pkg->getfield('freq') ne '0'
3123 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
3125 || ( $part_pkg->plan eq 'voip_cdr'
3126 && $part_pkg->option('bill_every_call')
3128 || ( $options{cancel} )
3131 # XXX should this be a package event? probably. events are called
3132 # at collection time at the moment, though...
3133 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
3134 if $part_pkg->can('reset_usage');
3135 #don't want to reset usage just cause we want a line item??
3136 #&& $part_pkg->pkgpart == $real_pkgpart;
3138 warn " bill recur\n" if $DEBUG > 1;
3141 # XXX shared with $recur_prog
3142 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
3146 #over two params! lets at least switch to a hashref for the rest...
3147 my $increment_next_bill = ( $part_pkg->freq ne '0'
3148 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
3149 && !$options{cancel}
3151 my %param = ( 'precommit_hooks' => $precommit_hooks,
3152 'increment_next_bill' => $increment_next_bill,
3153 'discounts' => \@discounts,
3156 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
3157 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
3158 return "$@ running $method for $cust_pkg\n"
3161 if ( $increment_next_bill ) {
3163 my $next_bill = $part_pkg->add_freq($sdate);
3164 return "unparsable frequency: ". $part_pkg->freq
3165 if $next_bill == -1;
3167 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
3168 # only for figuring next bill date, nothing else, so, reset $sdate again
3170 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
3171 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
3172 $cust_pkg->last_bill($sdate);
3174 $cust_pkg->setfield('bill', $next_bill );
3180 warn "\$setup is undefined" unless defined($setup);
3181 warn "\$recur is undefined" unless defined($recur);
3182 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
3185 # If there's line items, create em cust_bill_pkg records
3186 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
3191 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
3192 # hmm.. and if just the options are modified in some weird price plan?
3194 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
3197 my $error = $cust_pkg->replace( $old_cust_pkg,
3198 'options' => { $cust_pkg->options },
3200 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
3201 if $error; #just in case
3204 $setup = sprintf( "%.2f", $setup );
3205 $recur = sprintf( "%.2f", $recur );
3206 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
3207 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
3209 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
3210 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
3213 if ( $setup != 0 || $recur != 0 ) {
3215 warn " charges (setup=$setup, recur=$recur); adding line items\n"
3218 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
3220 warn " adding customer package invoice detail: $_\n"
3221 foreach @cust_pkg_detail;
3223 push @details, @cust_pkg_detail;
3225 my $cust_bill_pkg = new FS::cust_bill_pkg {
3226 'pkgnum' => $cust_pkg->pkgnum,
3228 'unitsetup' => $unitsetup,
3230 'unitrecur' => $unitrecur,
3231 'quantity' => $cust_pkg->quantity,
3232 'details' => \@details,
3233 'discounts' => \@discounts,
3234 'hidden' => $part_pkg->hidden,
3237 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
3238 $cust_bill_pkg->sdate( $hash{last_bill} );
3239 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
3240 $cust_bill_pkg->edate( $time ) if $options{cancel};
3241 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
3242 $cust_bill_pkg->sdate( $sdate );
3243 $cust_bill_pkg->edate( $cust_pkg->bill );
3244 #$cust_bill_pkg->edate( $time ) if $options{cancel};
3247 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
3248 unless $part_pkg->pkgpart == $real_pkgpart;
3250 $$total_setup += $setup;
3251 $$total_recur += $recur;
3258 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
3259 return $error if $error;
3261 push @$cust_bill_pkgs, $cust_bill_pkg;
3263 } #if $setup != 0 || $recur != 0
3273 my $part_pkg = shift;
3274 my $taxlisthash = shift;
3275 my $cust_bill_pkg = shift;
3276 my $cust_pkg = shift;
3277 my $invoice_time = shift;
3278 my $real_pkgpart = shift;
3279 my $options = shift;
3281 my %cust_bill_pkg = ();
3285 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
3286 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
3287 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
3288 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
3290 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
3292 if ( $conf->exists('enable_taxproducts')
3293 && ( scalar($part_pkg->part_pkg_taxoverride)
3294 || $part_pkg->has_taxproduct
3299 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3300 return "fatal: Can't (yet) use tax-pkg_address with taxproducts";
3303 foreach my $class (@classes) {
3304 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class );
3305 return $err_or_ref unless ref($err_or_ref);
3306 $taxes{$class} = $err_or_ref;
3309 unless (exists $taxes{''}) {
3310 my $err_or_ref = $self->_gather_taxes( $part_pkg, '' );
3311 return $err_or_ref unless ref($err_or_ref);
3312 $taxes{''} = $err_or_ref;
3317 my @loc_keys = qw( city county state country );
3319 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3320 my $cust_location = $cust_pkg->cust_location;
3321 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
3324 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
3327 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
3330 $taxhash{'taxclass'} = $part_pkg->taxclass;
3333 my %taxhash_elim = %taxhash;
3334 my @elim = qw( city county state );
3337 #first try a match with taxclass
3338 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
3340 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
3341 #then try a match without taxclass
3342 my %no_taxclass = %taxhash_elim;
3343 $no_taxclass{ 'taxclass' } = '';
3344 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
3347 $taxhash_elim{ shift(@elim) } = '';
3349 } while ( !scalar(@taxes) && scalar(@elim) );
3351 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
3353 if $self->cust_main_exemption; #just to be safe
3355 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3357 $_->set('pkgnum', $cust_pkg->pkgnum );
3358 $_->set('locationnum', $cust_pkg->locationnum );
3362 $taxes{''} = [ @taxes ];
3363 $taxes{'setup'} = [ @taxes ];
3364 $taxes{'recur'} = [ @taxes ];
3365 $taxes{$_} = [ @taxes ] foreach (@classes);
3367 # # maybe eliminate this entirely, along with all the 0% records
3368 # unless ( @taxes ) {
3370 # "fatal: can't find tax rate for state/county/country/taxclass ".
3371 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
3374 } #if $conf->exists('enable_taxproducts') ...
3379 my $separate = $conf->exists('separate_usage');
3380 my $usage_mandate = $cust_pkg->part_pkg->option('usage_mandate', 'Hush!');
3381 if ( $separate || $cust_bill_pkg->hidden || $usage_mandate ) {
3383 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
3384 my %hash = $cust_bill_pkg->hidden # maybe for all bill linked?
3385 ? ( 'section' => $temp_pkg->part_pkg->categoryname )
3388 my $section = $cust_pkg->part_pkg->option('usage_section', 'Hush!');
3389 my $summary = $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
3391 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3392 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
3394 push @display, new FS::cust_bill_pkg_display
3397 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
3401 if ($separate && $section && $summary) {
3402 push @display, new FS::cust_bill_pkg_display { type => 'U',
3407 if ($usage_mandate || $section && $summary) {
3408 $hash{post_total} = 'Y';
3411 $hash{section} = $section if ($separate || $usage_mandate);
3412 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
3415 $cust_bill_pkg->set('display', \@display);
3417 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
3418 foreach my $key (keys %tax_cust_bill_pkg) {
3419 my @taxes = @{ $taxes{$key} || [] };
3420 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
3422 my %localtaxlisthash = ();
3423 foreach my $tax ( @taxes ) {
3425 my $taxname = ref( $tax ). ' '. $tax->taxnum;
3426 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
3427 # ' locationnum'. $cust_pkg->locationnum
3428 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
3430 $taxlisthash->{ $taxname } ||= [ $tax ];
3431 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
3433 $localtaxlisthash{ $taxname } ||= [ $tax ];
3434 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
3438 warn "finding taxed taxes...\n" if $DEBUG > 2;
3439 foreach my $tax ( keys %localtaxlisthash ) {
3440 my $tax_object = shift @{ $localtaxlisthash{$tax} };
3441 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
3443 next unless $tax_object->can('tax_on_tax');
3445 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
3446 my $totname = ref( $tot ). ' '. $tot->taxnum;
3448 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
3450 next unless exists( $localtaxlisthash{ $totname } ); # only increase
3452 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
3453 my $hashref_or_error =
3454 $tax_object->taxline( $localtaxlisthash{$tax},
3455 'custnum' => $self->custnum,
3456 'invoice_time' => $invoice_time,
3458 return $hashref_or_error
3459 unless ref($hashref_or_error);
3461 $taxlisthash->{ $totname } ||= [ $tot ];
3462 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
3474 my $part_pkg = shift;
3478 my $geocode = $self->geocode('cch');
3480 my @taxclassnums = map { $_->taxclassnum }
3481 $part_pkg->part_pkg_taxoverride($class);
3483 unless (@taxclassnums) {
3484 @taxclassnums = map { $_->taxclassnum }
3485 grep { $_->taxable eq 'Y' }
3486 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
3488 warn "Found taxclassnum values of ". join(',', @taxclassnums)
3493 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
3495 @taxes = qsearch({ 'table' => 'tax_rate',
3496 'hashref' => { 'geocode' => $geocode, },
3497 'extra_sql' => $extra_sql,
3499 if scalar(@taxclassnums);
3501 warn "Found taxes ".
3502 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
3509 =item collect [ HASHREF | OPTION => VALUE ... ]
3511 (Attempt to) collect money for this customer's outstanding invoices (see
3512 L<FS::cust_bill>). Usually used after the bill method.
3514 Actions are now triggered by billing events; see L<FS::part_event> and the
3515 billing events web interface. Old-style invoice events (see
3516 L<FS::part_bill_event>) have been deprecated.
3518 If there is an error, returns the error, otherwise returns false.
3520 Options are passed as name-value pairs.
3522 Currently available options are:
3528 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.
3532 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3536 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3540 set true to surpress email card/ACH decline notices.
3544 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)
3550 # allows for one time override of normal customer billing method
3555 my( $self, %options ) = @_;
3556 my $invoice_time = $options{'invoice_time'} || time;
3559 local $SIG{HUP} = 'IGNORE';
3560 local $SIG{INT} = 'IGNORE';
3561 local $SIG{QUIT} = 'IGNORE';
3562 local $SIG{TERM} = 'IGNORE';
3563 local $SIG{TSTP} = 'IGNORE';
3564 local $SIG{PIPE} = 'IGNORE';
3566 my $oldAutoCommit = $FS::UID::AutoCommit;
3567 local $FS::UID::AutoCommit = 0;
3570 $self->select_for_update; #mutex
3573 my $balance = $self->balance;
3574 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
3577 if ( exists($options{'retry_card'}) ) {
3578 carp 'retry_card option passed to collect is deprecated; use retry';
3579 $options{'retry'} ||= $options{'retry_card'};
3581 if ( exists($options{'retry'}) && $options{'retry'} ) {
3582 my $error = $self->retry_realtime;
3584 $dbh->rollback if $oldAutoCommit;
3589 my $error = $self->do_cust_event(
3590 'debug' => ( $options{'debug'} || 0 ),
3591 'time' => $invoice_time,
3592 'check_freq' => $options{'check_freq'},
3593 'stage' => 'collect',
3596 $dbh->rollback if $oldAutoCommit;
3600 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3605 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
3607 Runs billing events; see L<FS::part_event> and the billing events web
3610 If there is an error, returns the error, otherwise returns false.
3612 Options are passed as name-value pairs.
3614 Currently available options are:
3620 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.
3624 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3628 "collect" (the default) or "pre-bill"
3632 set true to surpress email card/ACH decline notices.
3636 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)
3642 # allows for one time override of normal customer billing method
3646 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3649 my( $self, %options ) = @_;
3650 my $time = $options{'time'} || time;
3653 local $SIG{HUP} = 'IGNORE';
3654 local $SIG{INT} = 'IGNORE';
3655 local $SIG{QUIT} = 'IGNORE';
3656 local $SIG{TERM} = 'IGNORE';
3657 local $SIG{TSTP} = 'IGNORE';
3658 local $SIG{PIPE} = 'IGNORE';
3660 my $oldAutoCommit = $FS::UID::AutoCommit;
3661 local $FS::UID::AutoCommit = 0;
3664 $self->select_for_update; #mutex
3667 my $balance = $self->balance;
3668 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
3671 # if ( exists($options{'retry_card'}) ) {
3672 # carp 'retry_card option passed to collect is deprecated; use retry';
3673 # $options{'retry'} ||= $options{'retry_card'};
3675 # if ( exists($options{'retry'}) && $options{'retry'} ) {
3676 # my $error = $self->retry_realtime;
3678 # $dbh->rollback if $oldAutoCommit;
3683 # false laziness w/pay_batch::import_results
3685 my $due_cust_event = $self->due_cust_event(
3686 'debug' => ( $options{'debug'} || 0 ),
3688 'check_freq' => $options{'check_freq'},
3689 'stage' => ( $options{'stage'} || 'collect' ),
3691 unless( ref($due_cust_event) ) {
3692 $dbh->rollback if $oldAutoCommit;
3693 return $due_cust_event;
3696 foreach my $cust_event ( @$due_cust_event ) {
3700 #re-eval event conditions (a previous event could have changed things)
3701 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
3702 #don't leave stray "new/locked" records around
3703 my $error = $cust_event->delete;
3705 #gah, even with transactions
3706 $dbh->commit if $oldAutoCommit; #well.
3713 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
3714 warn " running cust_event ". $cust_event->eventnum. "\n"
3718 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
3719 if ( my $error = $cust_event->do_event() ) {
3720 #XXX wtf is this? figure out a proper dealio with return value
3722 # gah, even with transactions.
3723 $dbh->commit if $oldAutoCommit; #well.
3730 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3735 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
3737 Inserts database records for and returns an ordered listref of new events due
3738 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
3739 events are due, an empty listref is returned. If there is an error, returns a
3740 scalar error message.
3742 To actually run the events, call each event's test_condition method, and if
3743 still true, call the event's do_event method.
3745 Options are passed as a hashref or as a list of name-value pairs. Available
3752 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.
3756 "collect" (the default) or "pre-bill"
3760 "Current time" for the events.
3764 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)
3768 Only return events for the specified eventtable (by default, events of all eventtables are returned)
3772 Explicitly pass the objects to be tested (typically used with eventtable).
3776 Set to true to return the objects, but not actually insert them into the
3783 sub due_cust_event {
3785 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
3788 #my $DEBUG = $opt{'debug'}
3789 local($DEBUG) = $opt{'debug'}
3790 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
3792 warn "$me due_cust_event called with options ".
3793 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
3796 $opt{'time'} ||= time;
3798 local $SIG{HUP} = 'IGNORE';
3799 local $SIG{INT} = 'IGNORE';
3800 local $SIG{QUIT} = 'IGNORE';
3801 local $SIG{TERM} = 'IGNORE';
3802 local $SIG{TSTP} = 'IGNORE';
3803 local $SIG{PIPE} = 'IGNORE';
3805 my $oldAutoCommit = $FS::UID::AutoCommit;
3806 local $FS::UID::AutoCommit = 0;
3809 $self->select_for_update #mutex
3810 unless $opt{testonly};
3813 # find possible events (initial search)
3816 my @cust_event = ();
3818 my @eventtable = $opt{'eventtable'}
3819 ? ( $opt{'eventtable'} )
3820 : FS::part_event->eventtables_runorder;
3822 foreach my $eventtable ( @eventtable ) {
3825 if ( $opt{'objects'} ) {
3827 @objects = @{ $opt{'objects'} };
3831 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
3832 @objects = ( $eventtable eq 'cust_main' )
3834 : ( $self->$eventtable() );
3838 my @e_cust_event = ();
3840 my $cross = "CROSS JOIN $eventtable";
3841 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
3842 unless $eventtable eq 'cust_main';
3844 foreach my $object ( @objects ) {
3846 #this first search uses the condition_sql magic for optimization.
3847 #the more possible events we can eliminate in this step the better
3849 my $cross_where = '';
3850 my $pkey = $object->primary_key;
3851 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
3853 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
3855 FS::part_event_condition->where_conditions_sql( $eventtable,
3856 'time'=>$opt{'time'}
3858 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
3860 $extra_sql = "AND $extra_sql" if $extra_sql;
3862 #here is the agent virtualization
3863 $extra_sql .= " AND ( part_event.agentnum IS NULL
3864 OR part_event.agentnum = ". $self->agentnum. ' )';
3866 $extra_sql .= " $order";
3868 warn "searching for events for $eventtable ". $object->$pkey. "\n"
3869 if $opt{'debug'} > 2;
3870 my @part_event = qsearch( {
3871 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
3872 'select' => 'part_event.*',
3873 'table' => 'part_event',
3874 'addl_from' => "$cross $join",
3875 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
3876 'eventtable' => $eventtable,
3879 'extra_sql' => "AND $cross_where $extra_sql",
3883 my $pkey = $object->primary_key;
3884 warn " ". scalar(@part_event).
3885 " possible events found for $eventtable ". $object->$pkey(). "\n";
3888 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
3892 warn " ". scalar(@e_cust_event).
3893 " subtotal possible cust events found for $eventtable\n"
3896 push @cust_event, @e_cust_event;
3900 warn " ". scalar(@cust_event).
3901 " total possible cust events found in initial search\n"
3909 $opt{stage} ||= 'collect';
3911 grep { my $stage = $_->part_event->event_stage;
3912 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
3922 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
3923 'stats_hashref' => \%unsat ),
3926 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
3929 warn " invalid conditions not eliminated with condition_sql:\n".
3930 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
3931 if keys %unsat && $DEBUG; # > 1;
3937 unless( $opt{testonly} ) {
3938 foreach my $cust_event ( @cust_event ) {
3940 my $error = $cust_event->insert();
3942 $dbh->rollback if $oldAutoCommit;
3949 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3955 warn " returning events: ". Dumper(@cust_event). "\n"
3962 =item retry_realtime
3964 Schedules realtime / batch credit card / electronic check / LEC billing
3965 events for for retry. Useful if card information has changed or manual
3966 retry is desired. The 'collect' method must be called to actually retry
3969 Implementation details: For either this customer, or for each of this
3970 customer's open invoices, changes the status of the first "done" (with
3971 statustext error) realtime processing event to "failed".
3975 sub retry_realtime {
3978 local $SIG{HUP} = 'IGNORE';
3979 local $SIG{INT} = 'IGNORE';
3980 local $SIG{QUIT} = 'IGNORE';
3981 local $SIG{TERM} = 'IGNORE';
3982 local $SIG{TSTP} = 'IGNORE';
3983 local $SIG{PIPE} = 'IGNORE';
3985 my $oldAutoCommit = $FS::UID::AutoCommit;
3986 local $FS::UID::AutoCommit = 0;
3989 #a little false laziness w/due_cust_event (not too bad, really)
3991 my $join = FS::part_event_condition->join_conditions_sql;
3992 my $order = FS::part_event_condition->order_conditions_sql;
3995 . join ( ' OR ' , map {
3996 "( part_event.eventtable = " . dbh->quote($_)
3997 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
3998 } FS::part_event->eventtables)
4001 #here is the agent virtualization
4002 my $agent_virt = " ( part_event.agentnum IS NULL
4003 OR part_event.agentnum = ". $self->agentnum. ' )';
4005 #XXX this shouldn't be hardcoded, actions should declare it...
4006 my @realtime_events = qw(
4007 cust_bill_realtime_card
4008 cust_bill_realtime_check
4009 cust_bill_realtime_lec
4013 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
4018 my @cust_event = qsearchs({
4019 'table' => 'cust_event',
4020 'select' => 'cust_event.*',
4021 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
4022 'hashref' => { 'status' => 'done' },
4023 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
4024 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
4027 my %seen_invnum = ();
4028 foreach my $cust_event (@cust_event) {
4030 #max one for the customer, one for each open invoice
4031 my $cust_X = $cust_event->cust_X;
4032 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
4036 or $cust_event->part_event->eventtable eq 'cust_bill'
4039 my $error = $cust_event->retry;
4041 $dbh->rollback if $oldAutoCommit;
4042 return "error scheduling event for retry: $error";
4047 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4052 # some horrid false laziness here to avoid refactor fallout
4053 # eventually realtime realtime_bop and realtime_refund_bop should go
4054 # away and be replaced by _new_realtime_bop and _new_realtime_refund_bop
4056 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
4058 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4059 via a Business::OnlinePayment realtime gateway. See
4060 L<http://420.am/business-onlinepayment> for supported gateways.
4062 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4064 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
4066 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4067 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4068 if set, will override the value from the customer record.
4070 I<description> is a free-text field passed to the gateway. It defaults to
4071 the value defined by the business-onlinepayment-description configuration
4072 option, or "Internet services" if that is unset.
4074 If an I<invnum> is specified, this payment (if successful) is applied to the
4075 specified invoice. If you don't specify an I<invnum> you might want to
4076 call the B<apply_payments> method or set the I<apply> option.
4078 I<apply> can be set to true to apply a resulting payment.
4080 I<quiet> can be set true to surpress email decline notices.
4082 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4083 resulting paynum, if any.
4085 I<payunique> is a unique identifier for this payment.
4087 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
4094 return $self->_new_realtime_bop(@_)
4095 if $self->_new_bop_required();
4097 my($method, $amount);
4099 if (ref($_[0]) eq 'HASH') {
4100 %options = %{$_[0]};
4101 $method = $options{method};
4102 $amount = $options{amount};
4104 ( $method, $amount ) = ( shift, shift );
4108 warn "$me realtime_bop: $method $amount\n";
4109 warn " $_ => $options{$_}\n" foreach keys %options;
4112 return "Amount must be greater than 0" unless $amount > 0;
4114 unless ( $options{'description'} ) {
4115 if ( $conf->exists('business-onlinepayment-description') ) {
4116 my $dtempl = $conf->config('business-onlinepayment-description');
4118 my $agent = $self->agent->agent;
4120 $options{'description'} = eval qq("$dtempl");
4122 $options{'description'} = 'Internet services';
4126 return $self->fake_bop($method, $amount, %options) if $options{'fake'};
4128 eval "use Business::OnlinePayment";
4131 my $payinfo = exists($options{'payinfo'})
4132 ? $options{'payinfo'}
4135 my %method2payby = (
4142 # check for banned credit card/ACH
4145 my $ban = qsearchs('banned_pay', {
4146 'payby' => $method2payby{$method},
4147 'payinfo' => md5_base64($payinfo),
4149 return "Banned credit card" if $ban;
4152 # set taxclass and trans_is_recur based on invnum if there is one
4156 my $trans_is_recur = 0;
4157 if ( $options{'invnum'} ) {
4159 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
4160 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
4163 map { $_->part_pkg }
4165 map { $_->cust_pkg }
4166 $cust_bill->cust_bill_pkg;
4168 my @taxclasses = map $_->taxclass, @part_pkg;
4169 $taxclass = $taxclasses[0]
4170 unless grep { $taxclasses[0] ne $_ } @taxclasses; #unless there are
4171 #different taxclasses
4173 if grep { $_->freq ne '0' } @part_pkg;
4181 #look for an agent gateway override first
4183 if ( $method eq 'CC' ) {
4184 $cardtype = cardtype($payinfo);
4185 } elsif ( $method eq 'ECHECK' ) {
4188 $cardtype = $method;
4192 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4193 cardtype => $cardtype,
4194 taxclass => $taxclass, } )
4195 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4197 taxclass => $taxclass, } )
4198 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4199 cardtype => $cardtype,
4201 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4203 taxclass => '', } );
4205 my $payment_gateway = '';
4206 my( $processor, $login, $password, $action, @bop_options );
4207 if ( $override ) { #use a payment gateway override
4209 $payment_gateway = $override->payment_gateway;
4211 $processor = $payment_gateway->gateway_module;
4212 $login = $payment_gateway->gateway_username;
4213 $password = $payment_gateway->gateway_password;
4214 $action = $payment_gateway->gateway_action;
4215 @bop_options = $payment_gateway->options;
4217 } else { #use the standard settings from the config
4219 ( $processor, $login, $password, $action, @bop_options ) =
4220 $self->default_payment_gateway($method);
4228 my $address = exists($options{'address1'})
4229 ? $options{'address1'}
4231 my $address2 = exists($options{'address2'})
4232 ? $options{'address2'}
4234 $address .= ", ". $address2 if length($address2);
4236 my $o_payname = exists($options{'payname'})
4237 ? $options{'payname'}
4239 my($payname, $payfirst, $paylast);
4240 if ( $o_payname && $method ne 'ECHECK' ) {
4241 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4242 or return "Illegal payname $payname";
4243 ($payfirst, $paylast) = ($1, $2);
4245 $payfirst = $self->getfield('first');
4246 $paylast = $self->getfield('last');
4247 $payname = "$payfirst $paylast";
4250 my @invoicing_list = $self->invoicing_list_emailonly;
4251 if ( $conf->exists('emailinvoiceautoalways')
4252 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4253 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4254 push @invoicing_list, $self->all_emails;
4257 my $email = ($conf->exists('business-onlinepayment-email-override'))
4258 ? $conf->config('business-onlinepayment-email-override')
4259 : $invoicing_list[0];
4263 my $payip = exists($options{'payip'})
4266 $content{customer_ip} = $payip
4269 $content{invoice_number} = $options{'invnum'}
4270 if exists($options{'invnum'}) && length($options{'invnum'});
4272 $content{email_customer} =
4273 ( $conf->exists('business-onlinepayment-email_customer')
4274 || $conf->exists('business-onlinepayment-email-override') );
4277 if ( $method eq 'CC' ) {
4279 $content{card_number} = $payinfo;
4280 $paydate = exists($options{'paydate'})
4281 ? $options{'paydate'}
4283 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4284 $content{expiration} = "$2/$1";
4286 my $paycvv = exists($options{'paycvv'})
4287 ? $options{'paycvv'}
4289 $content{cvv2} = $paycvv
4292 my $paystart_month = exists($options{'paystart_month'})
4293 ? $options{'paystart_month'}
4294 : $self->paystart_month;
4296 my $paystart_year = exists($options{'paystart_year'})
4297 ? $options{'paystart_year'}
4298 : $self->paystart_year;
4300 $content{card_start} = "$paystart_month/$paystart_year"
4301 if $paystart_month && $paystart_year;
4303 my $payissue = exists($options{'payissue'})
4304 ? $options{'payissue'}
4306 $content{issue_number} = $payissue if $payissue;
4308 if ( $self->_bop_recurring_billing( 'payinfo' => $payinfo,
4309 'trans_is_recur' => $trans_is_recur,
4313 $content{recurring_billing} = 'YES';
4314 $content{acct_code} = 'rebill'
4315 if $conf->exists('credit_card-recurring_billing_acct_code');
4318 } elsif ( $method eq 'ECHECK' ) {
4319 ( $content{account_number}, $content{routing_code} ) =
4320 split('@', $payinfo);
4321 $content{bank_name} = $o_payname;
4322 $content{bank_state} = exists($options{'paystate'})
4323 ? $options{'paystate'}
4324 : $self->getfield('paystate');
4325 $content{account_type} = exists($options{'paytype'})
4326 ? uc($options{'paytype'}) || 'CHECKING'
4327 : uc($self->getfield('paytype')) || 'CHECKING';
4328 $content{account_name} = $payname;
4329 $content{customer_org} = $self->company ? 'B' : 'I';
4330 $content{state_id} = exists($options{'stateid'})
4331 ? $options{'stateid'}
4332 : $self->getfield('stateid');
4333 $content{state_id_state} = exists($options{'stateid_state'})
4334 ? $options{'stateid_state'}
4335 : $self->getfield('stateid_state');
4336 $content{customer_ssn} = exists($options{'ss'})
4339 } elsif ( $method eq 'LEC' ) {
4340 $content{phone} = $payinfo;
4344 # run transaction(s)
4347 my $balance = exists( $options{'balance'} )
4348 ? $options{'balance'}
4351 $self->select_for_update; #mutex ... just until we get our pending record in
4353 #the checks here are intended to catch concurrent payments
4354 #double-form-submission prevention is taken care of in cust_pay_pending::check
4357 return "The customer's balance has changed; $method transaction aborted."
4358 if $self->balance < $balance;
4359 #&& $self->balance < $amount; #might as well anyway?
4361 #also check and make sure there aren't *other* pending payments for this cust
4363 my @pending = qsearch('cust_pay_pending', {
4364 'custnum' => $self->custnum,
4365 'status' => { op=>'!=', value=>'done' }
4367 return "A payment is already being processed for this customer (".
4368 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
4369 "); $method transaction aborted."
4370 if scalar(@pending);
4372 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
4374 my $cust_pay_pending = new FS::cust_pay_pending {
4375 'custnum' => $self->custnum,
4376 #'invnum' => $options{'invnum'},
4379 'payby' => $method2payby{$method},
4380 'payinfo' => $payinfo,
4381 'paydate' => $paydate,
4382 'recurring_billing' => $content{recurring_billing},
4383 'pkgnum' => $options{'pkgnum'},
4385 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
4387 $cust_pay_pending->payunique( $options{payunique} )
4388 if defined($options{payunique}) && length($options{payunique});
4389 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
4390 return $cpp_new_err if $cpp_new_err;
4392 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
4394 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
4395 $transaction->content(
4398 'password' => $password,
4399 'action' => $action1,
4400 'description' => $options{'description'},
4401 'amount' => $amount,
4402 #'invoice_number' => $options{'invnum'},
4403 'customer_id' => $self->custnum,
4404 'last_name' => $paylast,
4405 'first_name' => $payfirst,
4407 'address' => $address,
4408 'city' => ( exists($options{'city'})
4411 'state' => ( exists($options{'state'})
4414 'zip' => ( exists($options{'zip'})
4417 'country' => ( exists($options{'country'})
4418 ? $options{'country'}
4420 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4422 'phone' => $self->daytime || $self->night,
4426 $cust_pay_pending->status('pending');
4427 my $cpp_pending_err = $cust_pay_pending->replace;
4428 return $cpp_pending_err if $cpp_pending_err;
4431 my $BOP_TESTING = 0;
4432 my $BOP_TESTING_SUCCESS = 1;
4434 unless ( $BOP_TESTING ) {
4435 $transaction->submit();
4437 if ( $BOP_TESTING_SUCCESS ) {
4438 $transaction->is_success(1);
4439 $transaction->authorization('fake auth');
4441 $transaction->is_success(0);
4442 $transaction->error_message('fake failure');
4446 if ( $transaction->is_success() && $action2 ) {
4448 $cust_pay_pending->status('authorized');
4449 my $cpp_authorized_err = $cust_pay_pending->replace;
4450 return $cpp_authorized_err if $cpp_authorized_err;
4452 my $auth = $transaction->authorization;
4453 my $ordernum = $transaction->can('order_number')
4454 ? $transaction->order_number
4458 new Business::OnlinePayment( $processor, @bop_options );
4465 password => $password,
4466 order_number => $ordernum,
4468 authorization => $auth,
4469 description => $options{'description'},
4472 foreach my $field (qw( authorization_source_code returned_ACI
4473 transaction_identifier validation_code
4474 transaction_sequence_num local_transaction_date
4475 local_transaction_time AVS_result_code )) {
4476 $capture{$field} = $transaction->$field() if $transaction->can($field);
4479 $capture->content( %capture );
4483 unless ( $capture->is_success ) {
4484 my $e = "Authorization successful but capture failed, custnum #".
4485 $self->custnum. ': '. $capture->result_code.
4486 ": ". $capture->error_message;
4493 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
4494 my $cpp_captured_err = $cust_pay_pending->replace;
4495 return $cpp_captured_err if $cpp_captured_err;
4498 # remove paycvv after initial transaction
4501 #false laziness w/misc/process/payment.cgi - check both to make sure working
4503 if ( defined $self->dbdef_table->column('paycvv')
4504 && length($self->paycvv)
4505 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
4507 my $error = $self->remove_cvv;
4509 warn "WARNING: error removing cvv: $error\n";
4517 if ( $transaction->is_success() ) {
4520 if ( $payment_gateway ) { # agent override
4521 $paybatch = $payment_gateway->gatewaynum. '-';
4524 $paybatch .= "$processor:". $transaction->authorization;
4526 $paybatch .= ':'. $transaction->order_number
4527 if $transaction->can('order_number')
4528 && length($transaction->order_number);
4530 my $cust_pay = new FS::cust_pay ( {
4531 'custnum' => $self->custnum,
4532 'invnum' => $options{'invnum'},
4535 'payby' => $method2payby{$method},
4536 'payinfo' => $payinfo,
4537 'paybatch' => $paybatch,
4538 'paydate' => $paydate,
4539 'pkgnum' => $options{'pkgnum'},
4541 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
4542 $cust_pay->payunique( $options{payunique} )
4543 if defined($options{payunique}) && length($options{payunique});
4545 my $oldAutoCommit = $FS::UID::AutoCommit;
4546 local $FS::UID::AutoCommit = 0;
4549 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
4551 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
4554 $cust_pay->invnum(''); #try again with no specific invnum
4555 my $error2 = $cust_pay->insert( $options{'manual'} ?
4556 ( 'manual' => 1 ) : ()
4559 # gah. but at least we have a record of the state we had to abort in
4560 # from cust_pay_pending now.
4561 my $e = "WARNING: $method captured but payment not recorded - ".
4562 "error inserting payment ($processor): $error2".
4563 " (previously tried insert with invnum #$options{'invnum'}" .
4564 ": $error ) - pending payment saved as paypendingnum ".
4565 $cust_pay_pending->paypendingnum. "\n";
4571 if ( $options{'paynum_ref'} ) {
4572 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
4575 $cust_pay_pending->status('done');
4576 $cust_pay_pending->statustext('captured');
4577 $cust_pay_pending->paynum($cust_pay->paynum);
4578 my $cpp_done_err = $cust_pay_pending->replace;
4580 if ( $cpp_done_err ) {
4582 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4583 my $e = "WARNING: $method captured but payment not recorded - ".
4584 "error updating status for paypendingnum ".
4585 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4591 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4593 if ( $options{'apply'} ) {
4594 my $apply_error = $self->apply_payments_and_credits;
4595 if ( $apply_error ) {
4596 warn "WARNING: error applying payment: $apply_error\n";
4597 #but we still should return no error cause the payment otherwise went
4602 return ''; #no error
4608 my $perror = "$processor error: ". $transaction->error_message;
4610 unless ( $transaction->error_message ) {
4613 if ( $transaction->can('response_page') ) {
4615 'page' => ( $transaction->can('response_page')
4616 ? $transaction->response_page
4619 'code' => ( $transaction->can('response_code')
4620 ? $transaction->response_code
4623 'headers' => ( $transaction->can('response_headers')
4624 ? $transaction->response_headers
4630 "No additional debugging information available for $processor";
4633 $perror .= "No error_message returned from $processor -- ".
4634 ( ref($t_response) ? Dumper($t_response) : $t_response );
4638 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
4639 && $conf->exists('emaildecline')
4640 && grep { $_ ne 'POST' } $self->invoicing_list
4641 && ! grep { $transaction->error_message =~ /$_/ }
4642 $conf->config('emaildecline-exclude')
4644 my @templ = $conf->config('declinetemplate');
4645 my $template = new Text::Template (
4647 SOURCE => [ map "$_\n", @templ ],
4648 ) or return "($perror) can't create template: $Text::Template::ERROR";
4649 $template->compile()
4650 or return "($perror) can't compile template: $Text::Template::ERROR";
4654 scalar( $conf->config('company_name', $self->agentnum ) ),
4655 'company_address' =>
4656 join("\n", $conf->config('company_address', $self->agentnum ) ),
4657 'error' => $transaction->error_message,
4660 my $error = send_email(
4661 'from' => $conf->config('invoice_from', $self->agentnum ),
4662 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
4663 'subject' => 'Your payment could not be processed',
4664 'body' => [ $template->fill_in(HASH => $templ_hash) ],
4667 $perror .= " (also received error sending decline notification: $error)"
4672 $cust_pay_pending->status('done');
4673 $cust_pay_pending->statustext("declined: $perror");
4674 my $cpp_done_err = $cust_pay_pending->replace;
4675 if ( $cpp_done_err ) {
4676 my $e = "WARNING: $method declined but pending payment not resolved - ".
4677 "error updating status for paypendingnum ".
4678 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4680 $perror = "$e ($perror)";
4688 sub _bop_recurring_billing {
4689 my( $self, %opt ) = @_;
4691 my $method = scalar($conf->config('credit_card-recurring_billing_flag'));
4693 if ( defined($method) && $method eq 'transaction_is_recur' ) {
4695 return 1 if $opt{'trans_is_recur'};
4699 my %hash = ( 'custnum' => $self->custnum,
4704 if qsearch('cust_pay', { %hash, 'payinfo' => $opt{'payinfo'} } )
4705 || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo('CARD',
4716 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
4718 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
4719 via a Business::OnlinePayment realtime gateway. See
4720 L<http://420.am/business-onlinepayment> for supported gateways.
4722 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4724 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
4726 Most gateways require a reference to an original payment transaction to refund,
4727 so you probably need to specify a I<paynum>.
4729 I<amount> defaults to the original amount of the payment if not specified.
4731 I<reason> specifies a reason for the refund.
4733 I<paydate> specifies the expiration date for a credit card overriding the
4734 value from the customer record or the payment record. Specified as yyyy-mm-dd
4736 Implementation note: If I<amount> is unspecified or equal to the amount of the
4737 orignal payment, first an attempt is made to "void" the transaction via
4738 the gateway (to cancel a not-yet settled transaction) and then if that fails,
4739 the normal attempt is made to "refund" ("credit") the transaction via the
4740 gateway is attempted.
4742 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4743 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4744 #if set, will override the value from the customer record.
4746 #If an I<invnum> is specified, this payment (if successful) is applied to the
4747 #specified invoice. If you don't specify an I<invnum> you might want to
4748 #call the B<apply_payments> method.
4752 #some false laziness w/realtime_bop, not enough to make it worth merging
4753 #but some useful small subs should be pulled out
4754 sub realtime_refund_bop {
4757 return $self->_new_realtime_refund_bop(@_)
4758 if $self->_new_bop_required();
4760 my( $method, %options ) = @_;
4762 warn "$me realtime_refund_bop: $method refund\n";
4763 warn " $_ => $options{$_}\n" foreach keys %options;
4766 eval "use Business::OnlinePayment";
4770 # look up the original payment and optionally a gateway for that payment
4774 my $amount = $options{'amount'};
4776 my( $processor, $login, $password, @bop_options ) ;
4777 my( $auth, $order_number ) = ( '', '', '' );
4779 if ( $options{'paynum'} ) {
4781 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
4782 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
4783 or return "Unknown paynum $options{'paynum'}";
4784 $amount ||= $cust_pay->paid;
4786 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
4787 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
4788 $cust_pay->paybatch;
4789 my $gatewaynum = '';
4790 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
4792 if ( $gatewaynum ) { #gateway for the payment to be refunded
4794 my $payment_gateway =
4795 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
4796 die "payment gateway $gatewaynum not found"
4797 unless $payment_gateway;
4799 $processor = $payment_gateway->gateway_module;
4800 $login = $payment_gateway->gateway_username;
4801 $password = $payment_gateway->gateway_password;
4802 @bop_options = $payment_gateway->options;
4804 } else { #try the default gateway
4806 my( $conf_processor, $unused_action );
4807 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
4808 $self->default_payment_gateway($method);
4810 return "processor of payment $options{'paynum'} $processor does not".
4811 " match default processor $conf_processor"
4812 unless $processor eq $conf_processor;
4817 } else { # didn't specify a paynum, so look for agent gateway overrides
4818 # like a normal transaction
4821 if ( $method eq 'CC' ) {
4822 $cardtype = cardtype($self->payinfo);
4823 } elsif ( $method eq 'ECHECK' ) {
4826 $cardtype = $method;
4829 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4830 cardtype => $cardtype,
4832 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4834 taxclass => '', } );
4836 if ( $override ) { #use a payment gateway override
4838 my $payment_gateway = $override->payment_gateway;
4840 $processor = $payment_gateway->gateway_module;
4841 $login = $payment_gateway->gateway_username;
4842 $password = $payment_gateway->gateway_password;
4843 #$action = $payment_gateway->gateway_action;
4844 @bop_options = $payment_gateway->options;
4846 } else { #use the standard settings from the config
4849 ( $processor, $login, $password, $unused_action, @bop_options ) =
4850 $self->default_payment_gateway($method);
4855 return "neither amount nor paynum specified" unless $amount;
4860 'password' => $password,
4861 'order_number' => $order_number,
4862 'amount' => $amount,
4863 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4865 $content{authorization} = $auth
4866 if length($auth); #echeck/ACH transactions have an order # but no auth
4867 #(at least with authorize.net)
4869 my $disable_void_after;
4870 if ($conf->exists('disable_void_after')
4871 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
4872 $disable_void_after = $1;
4875 #first try void if applicable
4876 if ( $cust_pay && $cust_pay->paid == $amount
4878 ( not defined($disable_void_after) )
4879 || ( time < ($cust_pay->_date + $disable_void_after ) )
4882 warn " attempting void\n" if $DEBUG > 1;
4883 my $void = new Business::OnlinePayment( $processor, @bop_options );
4884 $content{'card_number'} = $cust_pay->payinfo
4885 if $cust_pay->payby eq 'CARD'
4886 && $void->can('info') && $void->info('CC_void_requires_card');
4887 $void->content( 'action' => 'void', %content );
4889 if ( $void->is_success ) {
4890 my $error = $cust_pay->void($options{'reason'});
4892 # gah, even with transactions.
4893 my $e = 'WARNING: Card/ACH voided but database not updated - '.
4894 "error voiding payment: $error";
4898 warn " void successful\n" if $DEBUG > 1;
4903 warn " void unsuccessful, trying refund\n"
4907 my $address = $self->address1;
4908 $address .= ", ". $self->address2 if $self->address2;
4910 my($payname, $payfirst, $paylast);
4911 if ( $self->payname && $method ne 'ECHECK' ) {
4912 $payname = $self->payname;
4913 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4914 or return "Illegal payname $payname";
4915 ($payfirst, $paylast) = ($1, $2);
4917 $payfirst = $self->getfield('first');
4918 $paylast = $self->getfield('last');
4919 $payname = "$payfirst $paylast";
4922 my @invoicing_list = $self->invoicing_list_emailonly;
4923 if ( $conf->exists('emailinvoiceautoalways')
4924 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4925 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4926 push @invoicing_list, $self->all_emails;
4929 my $email = ($conf->exists('business-onlinepayment-email-override'))
4930 ? $conf->config('business-onlinepayment-email-override')
4931 : $invoicing_list[0];
4933 my $payip = exists($options{'payip'})
4936 $content{customer_ip} = $payip
4940 if ( $method eq 'CC' ) {
4943 $content{card_number} = $payinfo = $cust_pay->payinfo;
4944 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
4945 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
4946 ($content{expiration} = "$2/$1"); # where available
4948 $content{card_number} = $payinfo = $self->payinfo;
4949 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
4950 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4951 $content{expiration} = "$2/$1";
4954 } elsif ( $method eq 'ECHECK' ) {
4957 $payinfo = $cust_pay->payinfo;
4959 $payinfo = $self->payinfo;
4961 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
4962 $content{bank_name} = $self->payname;
4963 $content{account_type} = 'CHECKING';
4964 $content{account_name} = $payname;
4965 $content{customer_org} = $self->company ? 'B' : 'I';
4966 $content{customer_ssn} = $self->ss;
4967 } elsif ( $method eq 'LEC' ) {
4968 $content{phone} = $payinfo = $self->payinfo;
4972 my $refund = new Business::OnlinePayment( $processor, @bop_options );
4973 my %sub_content = $refund->content(
4974 'action' => 'credit',
4975 'customer_id' => $self->custnum,
4976 'last_name' => $paylast,
4977 'first_name' => $payfirst,
4979 'address' => $address,
4980 'city' => $self->city,
4981 'state' => $self->state,
4982 'zip' => $self->zip,
4983 'country' => $self->country,
4985 'phone' => $self->daytime || $self->night,
4988 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
4992 return "$processor error: ". $refund->error_message
4993 unless $refund->is_success();
4995 my %method2payby = (
5001 my $paybatch = "$processor:". $refund->authorization;
5002 $paybatch .= ':'. $refund->order_number
5003 if $refund->can('order_number') && $refund->order_number;
5005 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
5006 my @cust_bill_pay = $cust_pay->cust_bill_pay;
5007 last unless @cust_bill_pay;
5008 my $cust_bill_pay = pop @cust_bill_pay;
5009 my $error = $cust_bill_pay->delete;
5013 my $cust_refund = new FS::cust_refund ( {
5014 'custnum' => $self->custnum,
5015 'paynum' => $options{'paynum'},
5016 'refund' => $amount,
5018 'payby' => $method2payby{$method},
5019 'payinfo' => $payinfo,
5020 'paybatch' => $paybatch,
5021 'reason' => $options{'reason'} || 'card or ACH refund',
5023 my $error = $cust_refund->insert;
5025 $cust_refund->paynum(''); #try again with no specific paynum
5026 my $error2 = $cust_refund->insert;
5028 # gah, even with transactions.
5029 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
5030 "error inserting refund ($processor): $error2".
5031 " (previously tried insert with paynum #$options{'paynum'}" .
5042 # does the configuration indicate the new bop routines are required?
5044 sub _new_bop_required {
5047 my $botpp = 'Business::OnlineThirdPartyPayment';
5050 if ( ( $conf->exists('business-onlinepayment-namespace')
5051 && $conf->config('business-onlinepayment-namespace') eq $botpp
5053 or scalar( grep { $_->gateway_namespace eq $botpp }
5054 qsearch( 'payment_gateway', { 'disabled' => '' } )
5062 =item realtime_collect [ OPTION => VALUE ... ]
5064 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
5065 via a Business::OnlinePayment or Business::OnlineThirdPartyPayment realtime
5066 gateway. See L<http://420.am/business-onlinepayment> and
5067 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5069 On failure returns an error message.
5071 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.
5073 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>, I<pkgnum>
5075 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>. If none is specified
5076 then it is deduced from the customer record.
5078 If no I<amount> is specified, then the customer balance is used.
5080 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5081 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5082 if set, will override the value from the customer record.
5084 I<description> is a free-text field passed to the gateway. It defaults to
5085 the value defined by the business-onlinepayment-description configuration
5086 option, or "Internet services" if that is unset.
5088 If an I<invnum> is specified, this payment (if successful) is applied to the
5089 specified invoice. If you don't specify an I<invnum> you might want to
5090 call the B<apply_payments> method or set the I<apply> option.
5092 I<apply> can be set to true to apply a resulting payment.
5094 I<quiet> can be set true to surpress email decline notices.
5096 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5097 resulting paynum, if any.
5099 I<payunique> is a unique identifier for this payment.
5101 I<session_id> is a session identifier associated with this payment.
5103 I<depend_jobnum> allows payment capture to unlock export jobs
5107 sub realtime_collect {
5108 my( $self, %options ) = @_;
5111 warn "$me realtime_collect:\n";
5112 warn " $_ => $options{$_}\n" foreach keys %options;
5115 $options{amount} = $self->balance unless exists( $options{amount} );
5116 $options{method} = FS::payby->payby2bop($self->payby)
5117 unless exists( $options{method} );
5119 return $self->realtime_bop({%options});
5123 =item _realtime_bop { [ ARG => VALUE ... ] }
5125 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
5126 via a Business::OnlinePayment realtime gateway. See
5127 L<http://420.am/business-onlinepayment> for supported gateways.
5129 Required arguments in the hashref are I<method>, and I<amount>
5131 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5133 Available optional arguments are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
5135 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5136 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5137 if set, will override the value from the customer record.
5139 I<description> is a free-text field passed to the gateway. It defaults to
5140 the value defined by the business-onlinepayment-description configuration
5141 option, or "Internet services" if that is unset.
5143 If an I<invnum> is specified, this payment (if successful) is applied to the
5144 specified invoice. If you don't specify an I<invnum> you might want to
5145 call the B<apply_payments> method.
5147 I<quiet> can be set true to surpress email decline notices.
5149 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5150 resulting paynum, if any.
5152 I<payunique> is a unique identifier for this payment.
5154 I<session_id> is a session identifier associated with this payment.
5156 I<depend_jobnum> allows payment capture to unlock export jobs
5158 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
5162 # some helper routines
5163 sub _payment_gateway {
5164 my ($self, $options) = @_;
5166 $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
5167 unless exists($options->{payment_gateway});
5169 $options->{payment_gateway};
5173 my ($self, $options) = @_;
5176 'login' => $options->{payment_gateway}->gateway_username,
5177 'password' => $options->{payment_gateway}->gateway_password,
5182 my ($self, $options) = @_;
5184 $options->{payment_gateway}->gatewaynum
5185 ? $options->{payment_gateway}->options
5186 : @{ $options->{payment_gateway}->get('options') };
5190 my ($self, $options) = @_;
5192 unless ( $options->{'description'} ) {
5193 if ( $conf->exists('business-onlinepayment-description') ) {
5194 my $dtempl = $conf->config('business-onlinepayment-description');
5196 my $agent = $self->agent->agent;
5198 $options->{'description'} = eval qq("$dtempl");
5200 $options->{'description'} = 'Internet services';
5204 $options->{payinfo} = $self->payinfo unless exists( $options->{payinfo} );
5205 $options->{invnum} ||= '';
5206 $options->{payname} = $self->payname unless exists( $options->{payname} );
5210 my ($self, $options) = @_;
5213 $content{address} = exists($options->{'address1'})
5214 ? $options->{'address1'}
5216 my $address2 = exists($options->{'address2'})
5217 ? $options->{'address2'}
5219 $content{address} .= ", ". $address2 if length($address2);
5221 my $payip = exists($options->{'payip'}) ? $options->{'payip'} : $self->payip;
5222 $content{customer_ip} = $payip if length($payip);
5224 $content{invoice_number} = $options->{'invnum'}
5225 if exists($options->{'invnum'}) && length($options->{'invnum'});
5227 $content{email_customer} =
5228 ( $conf->exists('business-onlinepayment-email_customer')
5229 || $conf->exists('business-onlinepayment-email-override') );
5231 $content{payfirst} = $self->getfield('first');
5232 $content{paylast} = $self->getfield('last');
5234 $content{account_name} = "$content{payfirst} $content{paylast}"
5235 if $options->{method} eq 'ECHECK';
5237 $content{name} = $options->{payname};
5238 $content{name} = $content{account_name} if exists($content{account_name});
5240 $content{city} = exists($options->{city})
5243 $content{state} = exists($options->{state})
5246 $content{zip} = exists($options->{zip})
5249 $content{country} = exists($options->{country})
5250 ? $options->{country}
5252 $content{referer} = 'http://cleanwhisker.420.am/'; #XXX fix referer :/
5253 $content{phone} = $self->daytime || $self->night;
5258 my %bop_method2payby = (
5264 sub _new_realtime_bop {
5268 if (ref($_[0]) eq 'HASH') {
5269 %options = %{$_[0]};
5271 my ( $method, $amount ) = ( shift, shift );
5273 $options{method} = $method;
5274 $options{amount} = $amount;
5278 warn "$me realtime_bop (new): $options{method} $options{amount}\n";
5279 warn " $_ => $options{$_}\n" foreach keys %options;
5282 return $self->fake_bop(%options) if $options{'fake'};
5284 $self->_bop_defaults(\%options);
5287 # set trans_is_recur based on invnum if there is one
5290 my $trans_is_recur = 0;
5291 if ( $options{'invnum'} ) {
5293 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
5294 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
5297 map { $_->part_pkg }
5299 map { $_->cust_pkg }
5300 $cust_bill->cust_bill_pkg;
5303 if grep { $_->freq ne '0' } @part_pkg;
5311 my $payment_gateway = $self->_payment_gateway( \%options );
5312 my $namespace = $payment_gateway->gateway_namespace;
5314 eval "use $namespace";
5318 # check for banned credit card/ACH
5321 my $ban = qsearchs('banned_pay', {
5322 'payby' => $bop_method2payby{$options{method}},
5323 'payinfo' => md5_base64($options{payinfo}),
5325 return "Banned credit card" if $ban;
5331 my (%bop_content) = $self->_bop_content(\%options);
5333 if ( $options{method} ne 'ECHECK' ) {
5334 $options{payname} =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5335 or return "Illegal payname $options{payname}";
5336 ($bop_content{payfirst}, $bop_content{paylast}) = ($1, $2);
5339 my @invoicing_list = $self->invoicing_list_emailonly;
5340 if ( $conf->exists('emailinvoiceautoalways')
5341 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5342 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5343 push @invoicing_list, $self->all_emails;
5346 my $email = ($conf->exists('business-onlinepayment-email-override'))
5347 ? $conf->config('business-onlinepayment-email-override')
5348 : $invoicing_list[0];
5352 if ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'CC' ) {
5354 $content{card_number} = $options{payinfo};
5355 $paydate = exists($options{'paydate'})
5356 ? $options{'paydate'}
5358 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
5359 $content{expiration} = "$2/$1";
5361 my $paycvv = exists($options{'paycvv'})
5362 ? $options{'paycvv'}
5364 $content{cvv2} = $paycvv
5367 my $paystart_month = exists($options{'paystart_month'})
5368 ? $options{'paystart_month'}
5369 : $self->paystart_month;
5371 my $paystart_year = exists($options{'paystart_year'})
5372 ? $options{'paystart_year'}
5373 : $self->paystart_year;
5375 $content{card_start} = "$paystart_month/$paystart_year"
5376 if $paystart_month && $paystart_year;
5378 my $payissue = exists($options{'payissue'})
5379 ? $options{'payissue'}
5381 $content{issue_number} = $payissue if $payissue;
5383 if ( $self->_bop_recurring_billing( 'payinfo' => $options{'payinfo'},
5384 'trans_is_recur' => $trans_is_recur,
5388 $content{recurring_billing} = 'YES';
5389 $content{acct_code} = 'rebill'
5390 if $conf->exists('credit_card-recurring_billing_acct_code');
5393 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'ECHECK' ){
5394 ( $content{account_number}, $content{routing_code} ) =
5395 split('@', $options{payinfo});
5396 $content{bank_name} = $options{payname};
5397 $content{bank_state} = exists($options{'paystate'})
5398 ? $options{'paystate'}
5399 : $self->getfield('paystate');
5400 $content{account_type} = exists($options{'paytype'})
5401 ? uc($options{'paytype'}) || 'CHECKING'
5402 : uc($self->getfield('paytype')) || 'CHECKING';
5403 $content{customer_org} = $self->company ? 'B' : 'I';
5404 $content{state_id} = exists($options{'stateid'})
5405 ? $options{'stateid'}
5406 : $self->getfield('stateid');
5407 $content{state_id_state} = exists($options{'stateid_state'})
5408 ? $options{'stateid_state'}
5409 : $self->getfield('stateid_state');
5410 $content{customer_ssn} = exists($options{'ss'})
5413 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'LEC' ) {
5414 $content{phone} = $options{payinfo};
5415 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5422 # run transaction(s)
5425 my $balance = exists( $options{'balance'} )
5426 ? $options{'balance'}
5429 $self->select_for_update; #mutex ... just until we get our pending record in
5431 #the checks here are intended to catch concurrent payments
5432 #double-form-submission prevention is taken care of in cust_pay_pending::check
5435 return "The customer's balance has changed; $options{method} transaction aborted."
5436 if $self->balance < $balance;
5437 #&& $self->balance < $options{amount}; #might as well anyway?
5439 #also check and make sure there aren't *other* pending payments for this cust
5441 my @pending = qsearch('cust_pay_pending', {
5442 'custnum' => $self->custnum,
5443 'status' => { op=>'!=', value=>'done' }
5445 return "A payment is already being processed for this customer (".
5446 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
5447 "); $options{method} transaction aborted."
5448 if scalar(@pending);
5450 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
5452 my $cust_pay_pending = new FS::cust_pay_pending {
5453 'custnum' => $self->custnum,
5454 #'invnum' => $options{'invnum'},
5455 'paid' => $options{amount},
5457 'payby' => $bop_method2payby{$options{method}},
5458 'payinfo' => $options{payinfo},
5459 'paydate' => $paydate,
5460 'recurring_billing' => $content{recurring_billing},
5461 'pkgnum' => $options{'pkgnum'},
5463 'gatewaynum' => $payment_gateway->gatewaynum || '',
5464 'session_id' => $options{session_id} || '',
5465 'jobnum' => $options{depend_jobnum} || '',
5467 $cust_pay_pending->payunique( $options{payunique} )
5468 if defined($options{payunique}) && length($options{payunique});
5469 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
5470 return $cpp_new_err if $cpp_new_err;
5472 my( $action1, $action2 ) =
5473 split( /\s*\,\s*/, $payment_gateway->gateway_action );
5475 my $transaction = new $namespace( $payment_gateway->gateway_module,
5476 $self->_bop_options(\%options),
5479 $transaction->content(
5480 'type' => $options{method},
5481 $self->_bop_auth(\%options),
5482 'action' => $action1,
5483 'description' => $options{'description'},
5484 'amount' => $options{amount},
5485 #'invoice_number' => $options{'invnum'},
5486 'customer_id' => $self->custnum,
5488 'reference' => $cust_pay_pending->paypendingnum, #for now
5493 $cust_pay_pending->status('pending');
5494 my $cpp_pending_err = $cust_pay_pending->replace;
5495 return $cpp_pending_err if $cpp_pending_err;
5498 my $BOP_TESTING = 0;
5499 my $BOP_TESTING_SUCCESS = 1;
5501 unless ( $BOP_TESTING ) {
5502 $transaction->submit();
5504 if ( $BOP_TESTING_SUCCESS ) {
5505 $transaction->is_success(1);
5506 $transaction->authorization('fake auth');
5508 $transaction->is_success(0);
5509 $transaction->error_message('fake failure');
5513 if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5515 return { reference => $cust_pay_pending->paypendingnum,
5516 map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
5518 } elsif ( $transaction->is_success() && $action2 ) {
5520 $cust_pay_pending->status('authorized');
5521 my $cpp_authorized_err = $cust_pay_pending->replace;
5522 return $cpp_authorized_err if $cpp_authorized_err;
5524 my $auth = $transaction->authorization;
5525 my $ordernum = $transaction->can('order_number')
5526 ? $transaction->order_number
5530 new Business::OnlinePayment( $payment_gateway->gateway_module,
5531 $self->_bop_options(\%options),
5536 type => $options{method},
5538 $self->_bop_auth(\%options),
5539 order_number => $ordernum,
5540 amount => $options{amount},
5541 authorization => $auth,
5542 description => $options{'description'},
5545 foreach my $field (qw( authorization_source_code returned_ACI
5546 transaction_identifier validation_code
5547 transaction_sequence_num local_transaction_date
5548 local_transaction_time AVS_result_code )) {
5549 $capture{$field} = $transaction->$field() if $transaction->can($field);
5552 $capture->content( %capture );
5556 unless ( $capture->is_success ) {
5557 my $e = "Authorization successful but capture failed, custnum #".
5558 $self->custnum. ': '. $capture->result_code.
5559 ": ". $capture->error_message;
5567 # remove paycvv after initial transaction
5570 #false laziness w/misc/process/payment.cgi - check both to make sure working
5572 if ( defined $self->dbdef_table->column('paycvv')
5573 && length($self->paycvv)
5574 && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
5576 my $error = $self->remove_cvv;
5578 warn "WARNING: error removing cvv: $error\n";
5586 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5598 if (ref($_[0]) eq 'HASH') {
5599 %options = %{$_[0]};
5601 my ( $method, $amount ) = ( shift, shift );
5603 $options{method} = $method;
5604 $options{amount} = $amount;
5607 if ( $options{'fake_failure'} ) {
5608 return "Error: No error; test failure requested with fake_failure";
5612 #if ( $payment_gateway->gatewaynum ) { # agent override
5613 # $paybatch = $payment_gateway->gatewaynum. '-';
5616 #$paybatch .= "$processor:". $transaction->authorization;
5618 #$paybatch .= ':'. $transaction->order_number
5619 # if $transaction->can('order_number')
5620 # && length($transaction->order_number);
5622 my $paybatch = 'FakeProcessor:54:32';
5624 my $cust_pay = new FS::cust_pay ( {
5625 'custnum' => $self->custnum,
5626 'invnum' => $options{'invnum'},
5627 'paid' => $options{amount},
5629 'payby' => $bop_method2payby{$options{method}},
5630 #'payinfo' => $payinfo,
5631 'payinfo' => '4111111111111111',
5632 'paybatch' => $paybatch,
5633 #'paydate' => $paydate,
5634 'paydate' => '2012-05-01',
5636 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
5638 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5641 $cust_pay->invnum(''); #try again with no specific invnum
5642 my $error2 = $cust_pay->insert( $options{'manual'} ?
5643 ( 'manual' => 1 ) : ()
5646 # gah, even with transactions.
5647 my $e = 'WARNING: Card/ACH debited but database not updated - '.
5648 "error inserting (fake!) payment: $error2".
5649 " (previously tried insert with invnum #$options{'invnum'}" .
5656 if ( $options{'paynum_ref'} ) {
5657 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5660 return ''; #no error
5665 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
5667 # Wraps up processing of a realtime credit card, ACH (electronic check) or
5668 # phone bill transaction.
5670 sub _realtime_bop_result {
5671 my( $self, $cust_pay_pending, $transaction, %options ) = @_;
5673 warn "$me _realtime_bop_result: pending transaction ".
5674 $cust_pay_pending->paypendingnum. "\n";
5675 warn " $_ => $options{$_}\n" foreach keys %options;
5678 my $payment_gateway = $options{payment_gateway}
5679 or return "no payment gateway in arguments to _realtime_bop_result";
5681 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
5682 my $cpp_captured_err = $cust_pay_pending->replace;
5683 return $cpp_captured_err if $cpp_captured_err;
5685 if ( $transaction->is_success() ) {
5688 if ( $payment_gateway->gatewaynum ) { # agent override
5689 $paybatch = $payment_gateway->gatewaynum. '-';
5692 $paybatch .= $payment_gateway->gateway_module. ":".
5693 $transaction->authorization;
5695 $paybatch .= ':'. $transaction->order_number
5696 if $transaction->can('order_number')
5697 && length($transaction->order_number);
5699 my $cust_pay = new FS::cust_pay ( {
5700 'custnum' => $self->custnum,
5701 'invnum' => $options{'invnum'},
5702 'paid' => $cust_pay_pending->paid,
5704 'payby' => $cust_pay_pending->payby,
5705 #'payinfo' => $payinfo,
5706 'paybatch' => $paybatch,
5707 'paydate' => $cust_pay_pending->paydate,
5708 'pkgnum' => $cust_pay_pending->pkgnum,
5710 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
5711 $cust_pay->payunique( $options{payunique} )
5712 if defined($options{payunique}) && length($options{payunique});
5714 my $oldAutoCommit = $FS::UID::AutoCommit;
5715 local $FS::UID::AutoCommit = 0;
5718 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
5720 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5723 $cust_pay->invnum(''); #try again with no specific invnum
5724 my $error2 = $cust_pay->insert( $options{'manual'} ?
5725 ( 'manual' => 1 ) : ()
5728 # gah. but at least we have a record of the state we had to abort in
5729 # from cust_pay_pending now.
5730 my $e = "WARNING: $options{method} captured but payment not recorded -".
5731 " error inserting payment (". $payment_gateway->gateway_module.
5733 " (previously tried insert with invnum #$options{'invnum'}" .
5734 ": $error ) - pending payment saved as paypendingnum ".
5735 $cust_pay_pending->paypendingnum. "\n";
5741 my $jobnum = $cust_pay_pending->jobnum;
5743 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5745 unless ( $placeholder ) {
5746 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5747 my $e = "WARNING: $options{method} captured but job $jobnum not ".
5748 "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
5753 $error = $placeholder->delete;
5756 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5757 my $e = "WARNING: $options{method} captured but could not delete ".
5758 "job $jobnum for paypendingnum ".
5759 $cust_pay_pending->paypendingnum. ": $error\n";
5766 if ( $options{'paynum_ref'} ) {
5767 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5770 $cust_pay_pending->status('done');
5771 $cust_pay_pending->statustext('captured');
5772 $cust_pay_pending->paynum($cust_pay->paynum);
5773 my $cpp_done_err = $cust_pay_pending->replace;
5775 if ( $cpp_done_err ) {
5777 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5778 my $e = "WARNING: $options{method} captured but payment not recorded - ".
5779 "error updating status for paypendingnum ".
5780 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5786 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5788 if ( $options{'apply'} ) {
5789 my $apply_error = $self->apply_payments_and_credits;
5790 if ( $apply_error ) {
5791 warn "WARNING: error applying payment: $apply_error\n";
5792 #but we still should return no error cause the payment otherwise went
5797 return ''; #no error
5803 my $perror = $payment_gateway->gateway_module. " error: ".
5804 $transaction->error_message;
5806 my $jobnum = $cust_pay_pending->jobnum;
5808 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5810 if ( $placeholder ) {
5811 my $error = $placeholder->depended_delete;
5812 $error ||= $placeholder->delete;
5813 warn "error removing provisioning jobs after declined paypendingnum ".
5814 $cust_pay_pending->paypendingnum. "\n";
5816 my $e = "error finding job $jobnum for declined paypendingnum ".
5817 $cust_pay_pending->paypendingnum. "\n";
5823 unless ( $transaction->error_message ) {
5826 if ( $transaction->can('response_page') ) {
5828 'page' => ( $transaction->can('response_page')
5829 ? $transaction->response_page
5832 'code' => ( $transaction->can('response_code')
5833 ? $transaction->response_code
5836 'headers' => ( $transaction->can('response_headers')
5837 ? $transaction->response_headers
5843 "No additional debugging information available for ".
5844 $payment_gateway->gateway_module;
5847 $perror .= "No error_message returned from ".
5848 $payment_gateway->gateway_module. " -- ".
5849 ( ref($t_response) ? Dumper($t_response) : $t_response );
5853 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
5854 && $conf->exists('emaildecline')
5855 && grep { $_ ne 'POST' } $self->invoicing_list
5856 && ! grep { $transaction->error_message =~ /$_/ }
5857 $conf->config('emaildecline-exclude')
5859 my @templ = $conf->config('declinetemplate');
5860 my $template = new Text::Template (
5862 SOURCE => [ map "$_\n", @templ ],
5863 ) or return "($perror) can't create template: $Text::Template::ERROR";
5864 $template->compile()
5865 or return "($perror) can't compile template: $Text::Template::ERROR";
5869 scalar( $conf->config('company_name', $self->agentnum ) ),
5870 'company_address' =>
5871 join("\n", $conf->config('company_address', $self->agentnum ) ),
5872 'error' => $transaction->error_message,
5875 my $error = send_email(
5876 'from' => $conf->config('invoice_from', $self->agentnum ),
5877 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
5878 'subject' => 'Your payment could not be processed',
5879 'body' => [ $template->fill_in(HASH => $templ_hash) ],
5882 $perror .= " (also received error sending decline notification: $error)"
5887 $cust_pay_pending->status('done');
5888 $cust_pay_pending->statustext("declined: $perror");
5889 my $cpp_done_err = $cust_pay_pending->replace;
5890 if ( $cpp_done_err ) {
5891 my $e = "WARNING: $options{method} declined but pending payment not ".
5892 "resolved - error updating status for paypendingnum ".
5893 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5895 $perror = "$e ($perror)";
5903 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
5905 Verifies successful third party processing of a realtime credit card,
5906 ACH (electronic check) or phone bill transaction via a
5907 Business::OnlineThirdPartyPayment realtime gateway. See
5908 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5910 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
5912 The additional options I<payname>, I<city>, I<state>,
5913 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5914 if set, will override the value from the customer record.
5916 I<description> is a free-text field passed to the gateway. It defaults to
5917 "Internet services".
5919 If an I<invnum> is specified, this payment (if successful) is applied to the
5920 specified invoice. If you don't specify an I<invnum> you might want to
5921 call the B<apply_payments> method.
5923 I<quiet> can be set true to surpress email decline notices.
5925 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5926 resulting paynum, if any.
5928 I<payunique> is a unique identifier for this payment.
5930 Returns a hashref containing elements bill_error (which will be undefined
5931 upon success) and session_id of any associated session.
5935 sub realtime_botpp_capture {
5936 my( $self, $cust_pay_pending, %options ) = @_;
5938 warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
5939 warn " $_ => $options{$_}\n" foreach keys %options;
5942 eval "use Business::OnlineThirdPartyPayment";
5946 # select the gateway
5949 my $method = FS::payby->payby2bop($cust_pay_pending->payby);
5951 my $payment_gateway = $cust_pay_pending->gatewaynum
5952 ? qsearchs( 'payment_gateway',
5953 { gatewaynum => $cust_pay_pending->gatewaynum }
5955 : $self->agent->payment_gateway( 'method' => $method,
5956 # 'invnum' => $cust_pay_pending->invnum,
5957 # 'payinfo' => $cust_pay_pending->payinfo,
5960 $options{payment_gateway} = $payment_gateway; # for the helper subs
5966 my @invoicing_list = $self->invoicing_list_emailonly;
5967 if ( $conf->exists('emailinvoiceautoalways')
5968 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5969 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5970 push @invoicing_list, $self->all_emails;
5973 my $email = ($conf->exists('business-onlinepayment-email-override'))
5974 ? $conf->config('business-onlinepayment-email-override')
5975 : $invoicing_list[0];
5979 $content{email_customer} =
5980 ( $conf->exists('business-onlinepayment-email_customer')
5981 || $conf->exists('business-onlinepayment-email-override') );
5984 # run transaction(s)
5988 new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
5989 $self->_bop_options(\%options),
5992 $transaction->reference({ %options });
5994 $transaction->content(
5996 $self->_bop_auth(\%options),
5997 'action' => 'Post Authorization',
5998 'description' => $options{'description'},
5999 'amount' => $cust_pay_pending->paid,
6000 #'invoice_number' => $options{'invnum'},
6001 'customer_id' => $self->custnum,
6002 'referer' => 'http://cleanwhisker.420.am/',
6003 'reference' => $cust_pay_pending->paypendingnum,
6005 'phone' => $self->daytime || $self->night,
6007 # plus whatever is required for bogus capture avoidance
6010 $transaction->submit();
6013 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
6016 bill_error => $error,
6017 session_id => $cust_pay_pending->session_id,
6022 =item default_payment_gateway DEPRECATED -- use agent->payment_gateway
6026 sub default_payment_gateway {
6027 my( $self, $method ) = @_;
6029 die "Real-time processing not enabled\n"
6030 unless $conf->exists('business-onlinepayment');
6032 #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
6035 my $bop_config = 'business-onlinepayment';
6036 $bop_config .= '-ach'
6037 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
6038 my ( $processor, $login, $password, $action, @bop_options ) =
6039 $conf->config($bop_config);
6040 $action ||= 'normal authorization';
6041 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
6042 die "No real-time processor is enabled - ".
6043 "did you set the business-onlinepayment configuration value?\n"
6046 ( $processor, $login, $password, $action, @bop_options )
6051 Removes the I<paycvv> field from the database directly.
6053 If there is an error, returns the error, otherwise returns false.
6059 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
6060 or return dbh->errstr;
6061 $sth->execute($self->custnum)
6062 or return $sth->errstr;
6067 =item _new_realtime_refund_bop METHOD [ OPTION => VALUE ... ]
6069 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
6070 via a Business::OnlinePayment realtime gateway. See
6071 L<http://420.am/business-onlinepayment> for supported gateways.
6073 Available methods are: I<CC>, I<ECHECK> and I<LEC>
6075 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
6077 Most gateways require a reference to an original payment transaction to refund,
6078 so you probably need to specify a I<paynum>.
6080 I<amount> defaults to the original amount of the payment if not specified.
6082 I<reason> specifies a reason for the refund.
6084 I<paydate> specifies the expiration date for a credit card overriding the
6085 value from the customer record or the payment record. Specified as yyyy-mm-dd
6087 Implementation note: If I<amount> is unspecified or equal to the amount of the
6088 orignal payment, first an attempt is made to "void" the transaction via
6089 the gateway (to cancel a not-yet settled transaction) and then if that fails,
6090 the normal attempt is made to "refund" ("credit") the transaction via the
6091 gateway is attempted.
6093 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
6094 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
6095 #if set, will override the value from the customer record.
6097 #If an I<invnum> is specified, this payment (if successful) is applied to the
6098 #specified invoice. If you don't specify an I<invnum> you might want to
6099 #call the B<apply_payments> method.
6103 #some false laziness w/realtime_bop, not enough to make it worth merging
6104 #but some useful small subs should be pulled out
6105 sub _new_realtime_refund_bop {
6109 if (ref($_[0]) ne 'HASH') {
6110 %options = %{$_[0]};
6114 $options{method} = $method;
6118 warn "$me realtime_refund_bop (new): $options{method} refund\n";
6119 warn " $_ => $options{$_}\n" foreach keys %options;
6123 # look up the original payment and optionally a gateway for that payment
6127 my $amount = $options{'amount'};
6129 my( $processor, $login, $password, @bop_options, $namespace ) ;
6130 my( $auth, $order_number ) = ( '', '', '' );
6132 if ( $options{'paynum'} ) {
6134 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
6135 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
6136 or return "Unknown paynum $options{'paynum'}";
6137 $amount ||= $cust_pay->paid;
6139 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
6140 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
6141 $cust_pay->paybatch;
6142 my $gatewaynum = '';
6143 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
6145 if ( $gatewaynum ) { #gateway for the payment to be refunded
6147 my $payment_gateway =
6148 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
6149 die "payment gateway $gatewaynum not found"
6150 unless $payment_gateway;
6152 $processor = $payment_gateway->gateway_module;
6153 $login = $payment_gateway->gateway_username;
6154 $password = $payment_gateway->gateway_password;
6155 $namespace = $payment_gateway->gateway_namespace;
6156 @bop_options = $payment_gateway->options;
6158 } else { #try the default gateway
6161 my $payment_gateway =
6162 $self->agent->payment_gateway('method' => $options{method});
6164 ( $conf_processor, $login, $password, $namespace ) =
6165 map { my $method = "gateway_$_"; $payment_gateway->$method }
6166 qw( module username password namespace );
6168 @bop_options = $payment_gateway->gatewaynum
6169 ? $payment_gateway->options
6170 : @{ $payment_gateway->get('options') };
6172 return "processor of payment $options{'paynum'} $processor does not".
6173 " match default processor $conf_processor"
6174 unless $processor eq $conf_processor;
6179 } else { # didn't specify a paynum, so look for agent gateway overrides
6180 # like a normal transaction
6182 my $payment_gateway =
6183 $self->agent->payment_gateway( 'method' => $options{method},
6184 #'payinfo' => $payinfo,
6186 my( $processor, $login, $password, $namespace ) =
6187 map { my $method = "gateway_$_"; $payment_gateway->$method }
6188 qw( module username password namespace );
6190 my @bop_options = $payment_gateway->gatewaynum
6191 ? $payment_gateway->options
6192 : @{ $payment_gateway->get('options') };
6195 return "neither amount nor paynum specified" unless $amount;
6197 eval "use $namespace";
6201 'type' => $options{method},
6203 'password' => $password,
6204 'order_number' => $order_number,
6205 'amount' => $amount,
6206 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
6208 $content{authorization} = $auth
6209 if length($auth); #echeck/ACH transactions have an order # but no auth
6210 #(at least with authorize.net)
6212 my $disable_void_after;
6213 if ($conf->exists('disable_void_after')
6214 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
6215 $disable_void_after = $1;
6218 #first try void if applicable
6219 if ( $cust_pay && $cust_pay->paid == $amount
6221 ( not defined($disable_void_after) )
6222 || ( time < ($cust_pay->_date + $disable_void_after ) )
6225 warn " attempting void\n" if $DEBUG > 1;
6226 my $void = new Business::OnlinePayment( $processor, @bop_options );
6227 $content{'card_number'} = $cust_pay->payinfo
6228 if $cust_pay->payby eq 'CARD'
6229 && $void->can('info') && $void->info('CC_void_requires_card');
6230 $void->content( 'action' => 'void', %content );
6232 if ( $void->is_success ) {
6233 my $error = $cust_pay->void($options{'reason'});
6235 # gah, even with transactions.
6236 my $e = 'WARNING: Card/ACH voided but database not updated - '.
6237 "error voiding payment: $error";
6241 warn " void successful\n" if $DEBUG > 1;
6246 warn " void unsuccessful, trying refund\n"
6250 my $address = $self->address1;
6251 $address .= ", ". $self->address2 if $self->address2;
6253 my($payname, $payfirst, $paylast);
6254 if ( $self->payname && $options{method} ne 'ECHECK' ) {
6255 $payname = $self->payname;
6256 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
6257 or return "Illegal payname $payname";
6258 ($payfirst, $paylast) = ($1, $2);
6260 $payfirst = $self->getfield('first');
6261 $paylast = $self->getfield('last');
6262 $payname = "$payfirst $paylast";
6265 my @invoicing_list = $self->invoicing_list_emailonly;
6266 if ( $conf->exists('emailinvoiceautoalways')
6267 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
6268 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
6269 push @invoicing_list, $self->all_emails;
6272 my $email = ($conf->exists('business-onlinepayment-email-override'))
6273 ? $conf->config('business-onlinepayment-email-override')
6274 : $invoicing_list[0];
6276 my $payip = exists($options{'payip'})
6279 $content{customer_ip} = $payip
6283 if ( $options{method} eq 'CC' ) {
6286 $content{card_number} = $payinfo = $cust_pay->payinfo;
6287 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
6288 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
6289 ($content{expiration} = "$2/$1"); # where available
6291 $content{card_number} = $payinfo = $self->payinfo;
6292 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
6293 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
6294 $content{expiration} = "$2/$1";
6297 } elsif ( $options{method} eq 'ECHECK' ) {
6300 $payinfo = $cust_pay->payinfo;
6302 $payinfo = $self->payinfo;
6304 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
6305 $content{bank_name} = $self->payname;
6306 $content{account_type} = 'CHECKING';
6307 $content{account_name} = $payname;
6308 $content{customer_org} = $self->company ? 'B' : 'I';
6309 $content{customer_ssn} = $self->ss;
6310 } elsif ( $options{method} eq 'LEC' ) {
6311 $content{phone} = $payinfo = $self->payinfo;
6315 my $refund = new Business::OnlinePayment( $processor, @bop_options );
6316 my %sub_content = $refund->content(
6317 'action' => 'credit',
6318 'customer_id' => $self->custnum,
6319 'last_name' => $paylast,
6320 'first_name' => $payfirst,
6322 'address' => $address,
6323 'city' => $self->city,
6324 'state' => $self->state,
6325 'zip' => $self->zip,
6326 'country' => $self->country,
6328 'phone' => $self->daytime || $self->night,
6331 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
6335 return "$processor error: ". $refund->error_message
6336 unless $refund->is_success();
6338 my $paybatch = "$processor:". $refund->authorization;
6339 $paybatch .= ':'. $refund->order_number
6340 if $refund->can('order_number') && $refund->order_number;
6342 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
6343 my @cust_bill_pay = $cust_pay->cust_bill_pay;
6344 last unless @cust_bill_pay;
6345 my $cust_bill_pay = pop @cust_bill_pay;
6346 my $error = $cust_bill_pay->delete;
6350 my $cust_refund = new FS::cust_refund ( {
6351 'custnum' => $self->custnum,
6352 'paynum' => $options{'paynum'},
6353 'refund' => $amount,
6355 'payby' => $bop_method2payby{$options{method}},
6356 'payinfo' => $payinfo,
6357 'paybatch' => $paybatch,
6358 'reason' => $options{'reason'} || 'card or ACH refund',
6360 my $error = $cust_refund->insert;
6362 $cust_refund->paynum(''); #try again with no specific paynum
6363 my $error2 = $cust_refund->insert;
6365 # gah, even with transactions.
6366 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
6367 "error inserting refund ($processor): $error2".
6368 " (previously tried insert with paynum #$options{'paynum'}" .
6379 =item batch_card OPTION => VALUE...
6381 Adds a payment for this invoice to the pending credit card batch (see
6382 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
6383 runs the payment using a realtime gateway.
6388 my ($self, %options) = @_;
6391 if (exists($options{amount})) {
6392 $amount = $options{amount};
6394 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
6396 return '' unless $amount > 0;
6398 my $invnum = delete $options{invnum};
6399 my $payby = $options{invnum} || $self->payby; #dubious
6401 if ($options{'realtime'}) {
6402 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
6408 my $oldAutoCommit = $FS::UID::AutoCommit;
6409 local $FS::UID::AutoCommit = 0;
6412 #this needs to handle mysql as well as Pg, like svc_acct.pm
6413 #(make it into a common function if folks need to do batching with mysql)
6414 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
6415 or return "Cannot lock pay_batch: " . $dbh->errstr;
6419 'payby' => FS::payby->payby2payment($payby),
6422 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
6424 unless ( $pay_batch ) {
6425 $pay_batch = new FS::pay_batch \%pay_batch;
6426 my $error = $pay_batch->insert;
6428 $dbh->rollback if $oldAutoCommit;
6429 die "error creating new batch: $error\n";
6433 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
6434 'batchnum' => $pay_batch->batchnum,
6435 'custnum' => $self->custnum,
6438 foreach (qw( address1 address2 city state zip country payby payinfo paydate
6440 $options{$_} = '' unless exists($options{$_});
6443 my $cust_pay_batch = new FS::cust_pay_batch ( {
6444 'batchnum' => $pay_batch->batchnum,
6445 'invnum' => $invnum || 0, # is there a better value?
6446 # this field should be
6448 # cust_bill_pay_batch now
6449 'custnum' => $self->custnum,
6450 'last' => $self->getfield('last'),
6451 'first' => $self->getfield('first'),
6452 'address1' => $options{address1} || $self->address1,
6453 'address2' => $options{address2} || $self->address2,
6454 'city' => $options{city} || $self->city,
6455 'state' => $options{state} || $self->state,
6456 'zip' => $options{zip} || $self->zip,
6457 'country' => $options{country} || $self->country,
6458 'payby' => $options{payby} || $self->payby,
6459 'payinfo' => $options{payinfo} || $self->payinfo,
6460 'exp' => $options{paydate} || $self->paydate,
6461 'payname' => $options{payname} || $self->payname,
6462 'amount' => $amount, # consolidating
6465 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
6466 if $old_cust_pay_batch;
6469 if ($old_cust_pay_batch) {
6470 $error = $cust_pay_batch->replace($old_cust_pay_batch)
6472 $error = $cust_pay_batch->insert;
6476 $dbh->rollback if $oldAutoCommit;
6480 my $unapplied = $self->total_unapplied_credits
6481 + $self->total_unapplied_payments
6482 + $self->in_transit_payments;
6483 foreach my $cust_bill ($self->open_cust_bill) {
6484 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
6485 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
6486 'invnum' => $cust_bill->invnum,
6487 'paybatchnum' => $cust_pay_batch->paybatchnum,
6488 'amount' => $cust_bill->owed,
6491 if ($unapplied >= $cust_bill_pay_batch->amount){
6492 $unapplied -= $cust_bill_pay_batch->amount;
6495 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
6496 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
6498 $error = $cust_bill_pay_batch->insert;
6500 $dbh->rollback if $oldAutoCommit;
6505 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6509 =item apply_payments_and_credits [ OPTION => VALUE ... ]
6511 Applies unapplied payments and credits.
6513 In most cases, this new method should be used in place of sequential
6514 apply_payments and apply_credits methods.
6516 A hash of optional arguments may be passed. Currently "manual" is supported.
6517 If true, a payment receipt is sent instead of a statement when
6518 'payment_receipt_email' configuration option is set.
6520 If there is an error, returns the error, otherwise returns false.
6524 sub apply_payments_and_credits {
6525 my( $self, %options ) = @_;
6527 local $SIG{HUP} = 'IGNORE';
6528 local $SIG{INT} = 'IGNORE';
6529 local $SIG{QUIT} = 'IGNORE';
6530 local $SIG{TERM} = 'IGNORE';
6531 local $SIG{TSTP} = 'IGNORE';
6532 local $SIG{PIPE} = 'IGNORE';
6534 my $oldAutoCommit = $FS::UID::AutoCommit;
6535 local $FS::UID::AutoCommit = 0;
6538 $self->select_for_update; #mutex
6540 foreach my $cust_bill ( $self->open_cust_bill ) {
6541 my $error = $cust_bill->apply_payments_and_credits(%options);
6543 $dbh->rollback if $oldAutoCommit;
6544 return "Error applying: $error";
6548 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6553 =item apply_credits OPTION => VALUE ...
6555 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
6556 to outstanding invoice balances in chronological order (or reverse
6557 chronological order if the I<order> option is set to B<newest>) and returns the
6558 value of any remaining unapplied credits available for refund (see
6559 L<FS::cust_refund>).
6561 Dies if there is an error.
6569 local $SIG{HUP} = 'IGNORE';
6570 local $SIG{INT} = 'IGNORE';
6571 local $SIG{QUIT} = 'IGNORE';
6572 local $SIG{TERM} = 'IGNORE';
6573 local $SIG{TSTP} = 'IGNORE';
6574 local $SIG{PIPE} = 'IGNORE';
6576 my $oldAutoCommit = $FS::UID::AutoCommit;
6577 local $FS::UID::AutoCommit = 0;
6580 $self->select_for_update; #mutex
6582 unless ( $self->total_unapplied_credits ) {
6583 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6587 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
6588 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
6590 my @invoices = $self->open_cust_bill;
6591 @invoices = sort { $b->_date <=> $a->_date } @invoices
6592 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
6594 if ( $conf->exists('pkg-balances') ) {
6595 # limit @credits to those w/ a pkgnum grepped from $self
6597 foreach my $i (@invoices) {
6598 foreach my $li ( $i->cust_bill_pkg ) {
6599 $pkgnums{$li->pkgnum} = 1;
6602 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
6607 foreach my $cust_bill ( @invoices ) {
6609 if ( !defined($credit) || $credit->credited == 0) {
6610 $credit = pop @credits or last;
6614 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
6615 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
6617 $owed = $cust_bill->owed;
6619 unless ( $owed > 0 ) {
6620 push @credits, $credit;
6624 my $amount = min( $credit->credited, $owed );
6626 my $cust_credit_bill = new FS::cust_credit_bill ( {
6627 'crednum' => $credit->crednum,
6628 'invnum' => $cust_bill->invnum,
6629 'amount' => $amount,
6631 $cust_credit_bill->pkgnum( $credit->pkgnum )
6632 if $conf->exists('pkg-balances') && $credit->pkgnum;
6633 my $error = $cust_credit_bill->insert;
6635 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6639 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6643 my $total_unapplied_credits = $self->total_unapplied_credits;
6645 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6647 return $total_unapplied_credits;
6650 =item apply_payments [ OPTION => VALUE ... ]
6652 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
6653 to outstanding invoice balances in chronological order.
6655 #and returns the value of any remaining unapplied payments.
6657 A hash of optional arguments may be passed. Currently "manual" is supported.
6658 If true, a payment receipt is sent instead of a statement when
6659 'payment_receipt_email' configuration option is set.
6661 Dies if there is an error.
6665 sub apply_payments {
6666 my( $self, %options ) = @_;
6668 local $SIG{HUP} = 'IGNORE';
6669 local $SIG{INT} = 'IGNORE';
6670 local $SIG{QUIT} = 'IGNORE';
6671 local $SIG{TERM} = 'IGNORE';
6672 local $SIG{TSTP} = 'IGNORE';
6673 local $SIG{PIPE} = 'IGNORE';
6675 my $oldAutoCommit = $FS::UID::AutoCommit;
6676 local $FS::UID::AutoCommit = 0;
6679 $self->select_for_update; #mutex
6683 my @payments = sort { $b->_date <=> $a->_date }
6684 grep { $_->unapplied > 0 }
6687 my @invoices = sort { $a->_date <=> $b->_date}
6688 grep { $_->owed > 0 }
6691 if ( $conf->exists('pkg-balances') ) {
6692 # limit @payments to those w/ a pkgnum grepped from $self
6694 foreach my $i (@invoices) {
6695 foreach my $li ( $i->cust_bill_pkg ) {
6696 $pkgnums{$li->pkgnum} = 1;
6699 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
6704 foreach my $cust_bill ( @invoices ) {
6706 if ( !defined($payment) || $payment->unapplied == 0 ) {
6707 $payment = pop @payments or last;
6711 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
6712 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
6714 $owed = $cust_bill->owed;
6716 unless ( $owed > 0 ) {
6717 push @payments, $payment;
6721 my $amount = min( $payment->unapplied, $owed );
6723 my $cust_bill_pay = new FS::cust_bill_pay ( {
6724 'paynum' => $payment->paynum,
6725 'invnum' => $cust_bill->invnum,
6726 'amount' => $amount,
6728 $cust_bill_pay->pkgnum( $payment->pkgnum )
6729 if $conf->exists('pkg-balances') && $payment->pkgnum;
6730 my $error = $cust_bill_pay->insert(%options);
6732 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6736 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6740 my $total_unapplied_payments = $self->total_unapplied_payments;
6742 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6744 return $total_unapplied_payments;
6749 Returns the total owed for this customer on all invoices
6750 (see L<FS::cust_bill/owed>).
6756 $self->total_owed_date(2145859200); #12/31/2037
6759 =item total_owed_date TIME
6761 Returns the total owed for this customer on all invoices with date earlier than
6762 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6763 see L<Time::Local> and L<Date::Parse> for conversion functions.
6767 sub total_owed_date {
6771 # my $custnum = $self->custnum;
6773 # my $owed_sql = FS::cust_bill->owed_sql;
6776 # SELECT SUM($owed_sql) FROM cust_bill
6777 # WHERE custnum = $custnum
6778 # AND _date <= $time
6781 # my $sth = dbh->prepare($sql) or die dbh->errstr;
6782 # $sth->execute() or die $sth->errstr;
6784 # return sprintf( '%.2f', $sth->fetchrow_arrayref->[0] );
6787 foreach my $cust_bill (
6788 grep { $_->_date <= $time }
6789 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6791 $total_bill += $cust_bill->owed;
6793 sprintf( "%.2f", $total_bill );
6797 =item total_owed_pkgnum PKGNUM
6799 Returns the total owed on all invoices for this customer's specific package
6800 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
6804 sub total_owed_pkgnum {
6805 my( $self, $pkgnum ) = @_;
6806 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
6809 =item total_owed_date_pkgnum TIME PKGNUM
6811 Returns the total owed for this customer's specific package when using
6812 experimental package balances on all invoices with date earlier than
6813 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6814 see L<Time::Local> and L<Date::Parse> for conversion functions.
6818 sub total_owed_date_pkgnum {
6819 my( $self, $time, $pkgnum ) = @_;
6822 foreach my $cust_bill (
6823 grep { $_->_date <= $time }
6824 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6826 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
6828 sprintf( "%.2f", $total_bill );
6834 Returns the total amount of all payments.
6841 $total += $_->paid foreach $self->cust_pay;
6842 sprintf( "%.2f", $total );
6845 =item total_unapplied_credits
6847 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6848 customer. See L<FS::cust_credit/credited>.
6850 =item total_credited
6852 Old name for total_unapplied_credits. Don't use.
6856 sub total_credited {
6857 #carp "total_credited deprecated, use total_unapplied_credits";
6858 shift->total_unapplied_credits(@_);
6861 sub total_unapplied_credits {
6863 my $total_credit = 0;
6864 $total_credit += $_->credited foreach $self->cust_credit;
6865 sprintf( "%.2f", $total_credit );
6868 =item total_unapplied_credits_pkgnum PKGNUM
6870 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6871 customer. See L<FS::cust_credit/credited>.
6875 sub total_unapplied_credits_pkgnum {
6876 my( $self, $pkgnum ) = @_;
6877 my $total_credit = 0;
6878 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
6879 sprintf( "%.2f", $total_credit );
6883 =item total_unapplied_payments
6885 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
6886 See L<FS::cust_pay/unapplied>.
6890 sub total_unapplied_payments {
6892 my $total_unapplied = 0;
6893 $total_unapplied += $_->unapplied foreach $self->cust_pay;
6894 sprintf( "%.2f", $total_unapplied );
6897 =item total_unapplied_payments_pkgnum PKGNUM
6899 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
6900 specific package when using experimental package balances. See
6901 L<FS::cust_pay/unapplied>.
6905 sub total_unapplied_payments_pkgnum {
6906 my( $self, $pkgnum ) = @_;
6907 my $total_unapplied = 0;
6908 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
6909 sprintf( "%.2f", $total_unapplied );
6913 =item total_unapplied_refunds
6915 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
6916 customer. See L<FS::cust_refund/unapplied>.
6920 sub total_unapplied_refunds {
6922 my $total_unapplied = 0;
6923 $total_unapplied += $_->unapplied foreach $self->cust_refund;
6924 sprintf( "%.2f", $total_unapplied );
6929 Returns the balance for this customer (total_owed plus total_unrefunded, minus
6930 total_unapplied_credits minus total_unapplied_payments).
6938 + $self->total_unapplied_refunds
6939 - $self->total_unapplied_credits
6940 - $self->total_unapplied_payments
6944 =item balance_date TIME
6946 Returns the balance for this customer, only considering invoices with date
6947 earlier than TIME (total_owed_date minus total_credited minus
6948 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
6949 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
6958 $self->total_owed_date($time)
6959 + $self->total_unapplied_refunds
6960 - $self->total_unapplied_credits
6961 - $self->total_unapplied_payments
6965 =item balance_date_range START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
6967 Returns the balance for this customer, only considering invoices with date
6968 earlier than START_TIME, and optionally not later than END_TIME
6969 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
6971 Times are specified as SQL fragments or numeric
6972 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
6973 L<Date::Parse> for conversion functions. The empty string can be passed
6974 to disable that time constraint completely.
6976 Available options are:
6980 =item unapplied_date
6982 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)
6988 sub balance_date_range {
6990 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
6991 ') FROM cust_main WHERE custnum='. $self->custnum;
6992 sprintf( "%.2f", $self->scalar_sql($sql) );
6995 =item balance_pkgnum PKGNUM
6997 Returns the balance for this customer's specific package when using
6998 experimental package balances (total_owed plus total_unrefunded, minus
6999 total_unapplied_credits minus total_unapplied_payments)
7003 sub balance_pkgnum {
7004 my( $self, $pkgnum ) = @_;
7007 $self->total_owed_pkgnum($pkgnum)
7008 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
7009 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
7010 - $self->total_unapplied_credits_pkgnum($pkgnum)
7011 - $self->total_unapplied_payments_pkgnum($pkgnum)
7015 =item in_transit_payments
7017 Returns the total of requests for payments for this customer pending in
7018 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
7022 sub in_transit_payments {
7024 my $in_transit_payments = 0;
7025 foreach my $pay_batch ( qsearch('pay_batch', {
7028 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
7029 'batchnum' => $pay_batch->batchnum,
7030 'custnum' => $self->custnum,
7032 $in_transit_payments += $cust_pay_batch->amount;
7035 sprintf( "%.2f", $in_transit_payments );
7040 Returns a hash of useful information for making a payment.
7050 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
7051 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
7052 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
7056 For credit card transactions:
7068 For electronic check transactions:
7083 $return{balance} = $self->balance;
7085 $return{payname} = $self->payname
7086 || ( $self->first. ' '. $self->get('last') );
7088 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
7090 $return{payby} = $self->payby;
7091 $return{stateid_state} = $self->stateid_state;
7093 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
7094 $return{card_type} = cardtype($self->payinfo);
7095 $return{payinfo} = $self->paymask;
7097 @return{'month', 'year'} = $self->paydate_monthyear;
7101 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
7102 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
7103 $return{payinfo1} = $payinfo1;
7104 $return{payinfo2} = $payinfo2;
7105 $return{paytype} = $self->paytype;
7106 $return{paystate} = $self->paystate;
7110 #doubleclick protection
7112 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
7118 =item paydate_monthyear
7120 Returns a two-element list consisting of the month and year of this customer's
7121 paydate (credit card expiration date for CARD customers)
7125 sub paydate_monthyear {
7127 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
7129 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
7136 =item tax_exemption TAXNAME
7141 my( $self, $taxname ) = @_;
7143 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
7144 'taxname' => $taxname,
7149 =item cust_main_exemption
7153 sub cust_main_exemption {
7155 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
7158 =item invoicing_list [ ARRAYREF ]
7160 If an arguement is given, sets these email addresses as invoice recipients
7161 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
7162 (except as warnings), so use check_invoicing_list first.
7164 Returns a list of email addresses (with svcnum entries expanded).
7166 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
7167 check it without disturbing anything by passing nothing.
7169 This interface may change in the future.
7173 sub invoicing_list {
7174 my( $self, $arrayref ) = @_;
7177 my @cust_main_invoice;
7178 if ( $self->custnum ) {
7179 @cust_main_invoice =
7180 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7182 @cust_main_invoice = ();
7184 foreach my $cust_main_invoice ( @cust_main_invoice ) {
7185 #warn $cust_main_invoice->destnum;
7186 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
7187 #warn $cust_main_invoice->destnum;
7188 my $error = $cust_main_invoice->delete;
7189 warn $error if $error;
7192 if ( $self->custnum ) {
7193 @cust_main_invoice =
7194 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7196 @cust_main_invoice = ();
7198 my %seen = map { $_->address => 1 } @cust_main_invoice;
7199 foreach my $address ( @{$arrayref} ) {
7200 next if exists $seen{$address} && $seen{$address};
7201 $seen{$address} = 1;
7202 my $cust_main_invoice = new FS::cust_main_invoice ( {
7203 'custnum' => $self->custnum,
7206 my $error = $cust_main_invoice->insert;
7207 warn $error if $error;
7211 if ( $self->custnum ) {
7213 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7220 =item check_invoicing_list ARRAYREF
7222 Checks these arguements as valid input for the invoicing_list method. If there
7223 is an error, returns the error, otherwise returns false.
7227 sub check_invoicing_list {
7228 my( $self, $arrayref ) = @_;
7230 foreach my $address ( @$arrayref ) {
7232 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
7233 return 'Can\'t add FAX invoice destination with a blank FAX number.';
7236 my $cust_main_invoice = new FS::cust_main_invoice ( {
7237 'custnum' => $self->custnum,
7240 my $error = $self->custnum
7241 ? $cust_main_invoice->check
7242 : $cust_main_invoice->checkdest
7244 return $error if $error;
7248 return "Email address required"
7249 if $conf->exists('cust_main-require_invoicing_list_email')
7250 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
7255 =item set_default_invoicing_list
7257 Sets the invoicing list to all accounts associated with this customer,
7258 overwriting any previous invoicing list.
7262 sub set_default_invoicing_list {
7264 $self->invoicing_list($self->all_emails);
7269 Returns the email addresses of all accounts provisioned for this customer.
7276 foreach my $cust_pkg ( $self->all_pkgs ) {
7277 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
7279 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
7280 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
7282 $list{$_}=1 foreach map { $_->email } @svc_acct;
7287 =item invoicing_list_addpost
7289 Adds postal invoicing to this customer. If this customer is already configured
7290 to receive postal invoices, does nothing.
7294 sub invoicing_list_addpost {
7296 return if grep { $_ eq 'POST' } $self->invoicing_list;
7297 my @invoicing_list = $self->invoicing_list;
7298 push @invoicing_list, 'POST';
7299 $self->invoicing_list(\@invoicing_list);
7302 =item invoicing_list_emailonly
7304 Returns the list of email invoice recipients (invoicing_list without non-email
7305 destinations such as POST and FAX).
7309 sub invoicing_list_emailonly {
7311 warn "$me invoicing_list_emailonly called"
7313 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
7316 =item invoicing_list_emailonly_scalar
7318 Returns the list of email invoice recipients (invoicing_list without non-email
7319 destinations such as POST and FAX) as a comma-separated scalar.
7323 sub invoicing_list_emailonly_scalar {
7325 warn "$me invoicing_list_emailonly_scalar called"
7327 join(', ', $self->invoicing_list_emailonly);
7330 =item referral_custnum_cust_main
7332 Returns the customer who referred this customer (or the empty string, if
7333 this customer was not referred).
7335 Note the difference with referral_cust_main method: This method,
7336 referral_custnum_cust_main returns the single customer (if any) who referred
7337 this customer, while referral_cust_main returns an array of customers referred
7342 sub referral_custnum_cust_main {
7344 return '' unless $self->referral_custnum;
7345 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7348 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
7350 Returns an array of customers referred by this customer (referral_custnum set
7351 to this custnum). If DEPTH is given, recurses up to the given depth, returning
7352 customers referred by customers referred by this customer and so on, inclusive.
7353 The default behavior is DEPTH 1 (no recursion).
7355 Note the difference with referral_custnum_cust_main method: This method,
7356 referral_cust_main, returns an array of customers referred BY this customer,
7357 while referral_custnum_cust_main returns the single customer (if any) who
7358 referred this customer.
7362 sub referral_cust_main {
7364 my $depth = @_ ? shift : 1;
7365 my $exclude = @_ ? shift : {};
7368 map { $exclude->{$_->custnum}++; $_; }
7369 grep { ! $exclude->{ $_->custnum } }
7370 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
7374 map { $_->referral_cust_main($depth-1, $exclude) }
7381 =item referral_cust_main_ncancelled
7383 Same as referral_cust_main, except only returns customers with uncancelled
7388 sub referral_cust_main_ncancelled {
7390 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
7393 =item referral_cust_pkg [ DEPTH ]
7395 Like referral_cust_main, except returns a flat list of all unsuspended (and
7396 uncancelled) packages for each customer. The number of items in this list may
7397 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
7401 sub referral_cust_pkg {
7403 my $depth = @_ ? shift : 1;
7405 map { $_->unsuspended_pkgs }
7406 grep { $_->unsuspended_pkgs }
7407 $self->referral_cust_main($depth);
7410 =item referring_cust_main
7412 Returns the single cust_main record for the customer who referred this customer
7413 (referral_custnum), or false.
7417 sub referring_cust_main {
7419 return '' unless $self->referral_custnum;
7420 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7423 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
7425 Applies a credit to this customer. If there is an error, returns the error,
7426 otherwise returns false.
7428 REASON can be a text string, an FS::reason object, or a scalar reference to
7429 a reasonnum. If a text string, it will be automatically inserted as a new
7430 reason, and a 'reason_type' option must be passed to indicate the
7431 FS::reason_type for the new reason.
7433 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
7435 Any other options are passed to FS::cust_credit::insert.
7440 my( $self, $amount, $reason, %options ) = @_;
7442 my $cust_credit = new FS::cust_credit {
7443 'custnum' => $self->custnum,
7444 'amount' => $amount,
7447 if ( ref($reason) ) {
7449 if ( ref($reason) eq 'SCALAR' ) {
7450 $cust_credit->reasonnum( $$reason );
7452 $cust_credit->reasonnum( $reason->reasonnum );
7456 $cust_credit->set('reason', $reason)
7459 $cust_credit->addlinfo( delete $options{'addlinfo'} )
7460 if exists($options{'addlinfo'});
7462 $cust_credit->insert(%options);
7466 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
7468 Creates a one-time charge for this customer. If there is an error, returns
7469 the error, otherwise returns false.
7471 New-style, with a hashref of options:
7473 my $error = $cust_main->charge(
7477 'start_date' => str2time('7/4/2009'),
7478 'pkg' => 'Description',
7479 'comment' => 'Comment',
7480 'additional' => [], #extra invoice detail
7481 'classnum' => 1, #pkg_class
7483 'setuptax' => '', # or 'Y' for tax exempt
7486 'taxclass' => 'Tax class',
7489 'taxproduct' => 2, #part_pkg_taxproduct
7490 'override' => {}, #XXX describe
7492 #will be filled in with the new object
7493 'cust_pkg_ref' => \$cust_pkg,
7495 #generate an invoice immediately
7497 'invoice_terms' => '', #with these terms
7503 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
7509 my ( $amount, $quantity, $start_date, $classnum );
7510 my ( $pkg, $comment, $additional );
7511 my ( $setuptax, $taxclass ); #internal taxes
7512 my ( $taxproduct, $override ); #vendor (CCH) taxes
7513 my $cust_pkg_ref = '';
7514 my ( $bill_now, $invoice_terms ) = ( 0, '' );
7515 if ( ref( $_[0] ) ) {
7516 $amount = $_[0]->{amount};
7517 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
7518 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
7519 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
7520 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
7521 : '$'. sprintf("%.2f",$amount);
7522 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
7523 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
7524 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
7525 $additional = $_[0]->{additional} || [];
7526 $taxproduct = $_[0]->{taxproductnum};
7527 $override = { '' => $_[0]->{tax_override} };
7528 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
7529 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
7530 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
7535 $pkg = @_ ? shift : 'One-time charge';
7536 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
7538 $taxclass = @_ ? shift : '';
7542 local $SIG{HUP} = 'IGNORE';
7543 local $SIG{INT} = 'IGNORE';
7544 local $SIG{QUIT} = 'IGNORE';
7545 local $SIG{TERM} = 'IGNORE';
7546 local $SIG{TSTP} = 'IGNORE';
7547 local $SIG{PIPE} = 'IGNORE';
7549 my $oldAutoCommit = $FS::UID::AutoCommit;
7550 local $FS::UID::AutoCommit = 0;
7553 my $part_pkg = new FS::part_pkg ( {
7555 'comment' => $comment,
7559 'classnum' => ( $classnum ? $classnum : '' ),
7560 'setuptax' => $setuptax,
7561 'taxclass' => $taxclass,
7562 'taxproductnum' => $taxproduct,
7565 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
7566 ( 0 .. @$additional - 1 )
7568 'additional_count' => scalar(@$additional),
7569 'setup_fee' => $amount,
7572 my $error = $part_pkg->insert( options => \%options,
7573 tax_overrides => $override,
7576 $dbh->rollback if $oldAutoCommit;
7580 my $pkgpart = $part_pkg->pkgpart;
7581 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
7582 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
7583 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
7584 $error = $type_pkgs->insert;
7586 $dbh->rollback if $oldAutoCommit;
7591 my $cust_pkg = new FS::cust_pkg ( {
7592 'custnum' => $self->custnum,
7593 'pkgpart' => $pkgpart,
7594 'quantity' => $quantity,
7595 'start_date' => $start_date,
7598 $error = $cust_pkg->insert;
7600 $dbh->rollback if $oldAutoCommit;
7602 } elsif ( $cust_pkg_ref ) {
7603 ${$cust_pkg_ref} = $cust_pkg;
7607 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
7608 'pkg_list' => [ $cust_pkg ],
7611 $dbh->rollback if $oldAutoCommit;
7616 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
7621 #=item charge_postal_fee
7623 #Applies a one time charge this customer. If there is an error,
7624 #returns the error, returns the cust_pkg charge object or false
7625 #if there was no charge.
7629 # This should be a customer event. For that to work requires that bill
7630 # also be a customer event.
7632 sub charge_postal_fee {
7635 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
7636 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
7638 my $cust_pkg = new FS::cust_pkg ( {
7639 'custnum' => $self->custnum,
7640 'pkgpart' => $pkgpart,
7644 my $error = $cust_pkg->insert;
7645 $error ? $error : $cust_pkg;
7650 Returns all the invoices (see L<FS::cust_bill>) for this customer.
7656 map { $_ } #return $self->num_cust_bill unless wantarray;
7657 sort { $a->_date <=> $b->_date }
7658 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
7661 =item open_cust_bill
7663 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
7668 sub open_cust_bill {
7672 'table' => 'cust_bill',
7673 'hashref' => { 'custnum' => $self->custnum, },
7674 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
7675 'order_by' => 'ORDER BY _date ASC',
7680 =item cust_statements
7682 Returns all the statements (see L<FS::cust_statement>) for this customer.
7686 sub cust_statement {
7688 map { $_ } #return $self->num_cust_statement unless wantarray;
7689 sort { $a->_date <=> $b->_date }
7690 qsearch('cust_statement', { 'custnum' => $self->custnum, } )
7695 Returns all the credits (see L<FS::cust_credit>) for this customer.
7701 map { $_ } #return $self->num_cust_credit unless wantarray;
7702 sort { $a->_date <=> $b->_date }
7703 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
7706 =item cust_credit_pkgnum
7708 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
7709 package when using experimental package balances.
7713 sub cust_credit_pkgnum {
7714 my( $self, $pkgnum ) = @_;
7715 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
7716 sort { $a->_date <=> $b->_date }
7717 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
7718 'pkgnum' => $pkgnum,
7725 Returns all the payments (see L<FS::cust_pay>) for this customer.
7731 return $self->num_cust_pay unless wantarray;
7732 sort { $a->_date <=> $b->_date }
7733 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
7738 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
7739 called automatically when the cust_pay method is used in a scalar context.
7745 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
7746 my $sth = dbh->prepare($sql) or die dbh->errstr;
7747 $sth->execute($self->custnum) or die $sth->errstr;
7748 $sth->fetchrow_arrayref->[0];
7751 =item cust_pay_pkgnum
7753 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
7754 package when using experimental package balances.
7758 sub cust_pay_pkgnum {
7759 my( $self, $pkgnum ) = @_;
7760 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
7761 sort { $a->_date <=> $b->_date }
7762 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
7763 'pkgnum' => $pkgnum,
7770 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
7776 map { $_ } #return $self->num_cust_pay_void unless wantarray;
7777 sort { $a->_date <=> $b->_date }
7778 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
7781 =item cust_pay_batch
7783 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
7787 sub cust_pay_batch {
7789 map { $_ } #return $self->num_cust_pay_batch unless wantarray;
7790 sort { $a->paybatchnum <=> $b->paybatchnum }
7791 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
7794 =item cust_pay_pending
7796 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
7797 (without status "done").
7801 sub cust_pay_pending {
7803 return $self->num_cust_pay_pending unless wantarray;
7804 sort { $a->_date <=> $b->_date }
7805 qsearch( 'cust_pay_pending', {
7806 'custnum' => $self->custnum,
7807 'status' => { op=>'!=', value=>'done' },
7812 =item num_cust_pay_pending
7814 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
7815 customer (without status "done"). Also called automatically when the
7816 cust_pay_pending method is used in a scalar context.
7820 sub num_cust_pay_pending {
7822 my $sql = " SELECT COUNT(*) FROM cust_pay_pending ".
7823 " WHERE custnum = ? AND status != 'done' ";
7824 my $sth = dbh->prepare($sql) or die dbh->errstr;
7825 $sth->execute($self->custnum) or die $sth->errstr;
7826 $sth->fetchrow_arrayref->[0];
7831 Returns all the refunds (see L<FS::cust_refund>) for this customer.
7837 map { $_ } #return $self->num_cust_refund unless wantarray;
7838 sort { $a->_date <=> $b->_date }
7839 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
7842 =item display_custnum
7844 Returns the displayed customer number for this customer: agent_custid if
7845 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
7849 sub display_custnum {
7851 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
7852 return $self->agent_custid;
7854 return $self->custnum;
7860 Returns a name string for this customer, either "Company (Last, First)" or
7867 my $name = $self->contact;
7868 $name = $self->company. " ($name)" if $self->company;
7874 Returns a name string for this (service/shipping) contact, either
7875 "Company (Last, First)" or "Last, First".
7881 if ( $self->get('ship_last') ) {
7882 my $name = $self->ship_contact;
7883 $name = $self->ship_company. " ($name)" if $self->ship_company;
7892 Returns a name string for this customer, either "Company" or "First Last".
7898 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
7901 =item ship_name_short
7903 Returns a name string for this (service/shipping) contact, either "Company"
7908 sub ship_name_short {
7910 if ( $self->get('ship_last') ) {
7911 $self->ship_company !~ /^\s*$/
7912 ? $self->ship_company
7913 : $self->ship_contact_firstlast;
7915 $self->name_company_or_firstlast;
7921 Returns this customer's full (billing) contact name only, "Last, First"
7927 $self->get('last'). ', '. $self->first;
7932 Returns this customer's full (shipping) contact name only, "Last, First"
7938 $self->get('ship_last')
7939 ? $self->get('ship_last'). ', '. $self->ship_first
7943 =item contact_firstlast
7945 Returns this customers full (billing) contact name only, "First Last".
7949 sub contact_firstlast {
7951 $self->first. ' '. $self->get('last');
7954 =item ship_contact_firstlast
7956 Returns this customer's full (shipping) contact name only, "First Last".
7960 sub ship_contact_firstlast {
7962 $self->get('ship_last')
7963 ? $self->first. ' '. $self->get('ship_last')
7964 : $self->contact_firstlast;
7969 Returns this customer's full country name
7975 code2country($self->country);
7978 =item geocode DATA_VENDOR
7980 Returns a value for the customer location as encoded by DATA_VENDOR.
7981 Currently this only makes sense for "CCH" as DATA_VENDOR.
7986 my ($self, $data_vendor) = (shift, shift); #always cch for now
7988 my $geocode = $self->get('geocode'); #XXX only one data_vendor for geocode
7989 return $geocode if $geocode;
7991 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
7995 my($zip,$plus4) = split /-/, $self->get("${prefix}zip")
7996 if $self->country eq 'US';
8000 #CCH specific location stuff
8001 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
8003 my @cust_tax_location =
8005 'table' => 'cust_tax_location',
8006 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
8007 'extra_sql' => $extra_sql,
8008 'order_by' => 'ORDER BY plus4hi',#overlapping with distinct ends
8011 $geocode = $cust_tax_location[0]->geocode
8012 if scalar(@cust_tax_location);
8021 Returns a status string for this customer, currently:
8025 =item prospect - No packages have ever been ordered
8027 =item active - One or more recurring packages is active
8029 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
8031 =item suspended - All non-cancelled recurring packages are suspended
8033 =item cancelled - All recurring packages are cancelled
8039 sub status { shift->cust_status(@_); }
8043 for my $status (qw( prospect active inactive suspended cancelled )) {
8044 my $method = $status.'_sql';
8045 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
8046 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
8047 $sth->execute( ($self->custnum) x $numnum )
8048 or die "Error executing 'SELECT $sql': ". $sth->errstr;
8049 return $status if $sth->fetchrow_arrayref->[0];
8053 =item ucfirst_cust_status
8055 =item ucfirst_status
8057 Returns the status with the first character capitalized.
8061 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
8063 sub ucfirst_cust_status {
8065 ucfirst($self->cust_status);
8070 Returns a hex triplet color string for this customer's status.
8074 use vars qw(%statuscolor);
8075 tie %statuscolor, 'Tie::IxHash',
8076 'prospect' => '7e0079', #'000000', #black? naw, purple
8077 'active' => '00CC00', #green
8078 'inactive' => '0000CC', #blue
8079 'suspended' => 'FF9900', #yellow
8080 'cancelled' => 'FF0000', #red
8083 sub statuscolor { shift->cust_statuscolor(@_); }
8085 sub cust_statuscolor {
8087 $statuscolor{$self->cust_status};
8092 Returns an array of hashes representing the customer's RT tickets.
8099 my $num = $conf->config('cust_main-max_tickets') || 10;
8102 if ( $conf->config('ticket_system') ) {
8103 unless ( $conf->config('ticket_system-custom_priority_field') ) {
8105 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
8109 foreach my $priority (
8110 $conf->config('ticket_system-custom_priority_field-values'), ''
8112 last if scalar(@tickets) >= $num;
8114 @{ FS::TicketSystem->customer_tickets( $self->custnum,
8115 $num - scalar(@tickets),
8125 # Return services representing svc_accts in customer support packages
8126 sub support_services {
8128 my %packages = map { $_ => 1 } $conf->config('support_packages');
8130 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
8131 grep { $_->part_svc->svcdb eq 'svc_acct' }
8132 map { $_->cust_svc }
8133 grep { exists $packages{ $_->pkgpart } }
8134 $self->ncancelled_pkgs;
8138 # Return a list of latitude/longitude for one of the services (if any)
8139 sub service_coordinates {
8143 grep { $_->latitude && $_->longitude }
8145 map { $_->cust_svc }
8146 $self->ncancelled_pkgs;
8148 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
8153 =head1 CLASS METHODS
8159 Class method that returns the list of possible status strings for customers
8160 (see L<the status method|/status>). For example:
8162 @statuses = FS::cust_main->statuses();
8167 #my $self = shift; #could be class...
8173 Returns an SQL expression identifying prospective cust_main records (customers
8174 with no packages ever ordered)
8178 use vars qw($select_count_pkgs);
8179 $select_count_pkgs =
8180 "SELECT COUNT(*) FROM cust_pkg
8181 WHERE cust_pkg.custnum = cust_main.custnum";
8183 sub select_count_pkgs_sql {
8187 sub prospect_sql { "
8188 0 = ( $select_count_pkgs )
8193 Returns an SQL expression identifying active cust_main records (customers with
8194 active recurring packages).
8199 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
8205 Returns an SQL expression identifying inactive cust_main records (customers with
8206 no active recurring packages, but otherwise unsuspended/uncancelled).
8210 sub inactive_sql { "
8211 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
8213 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
8219 Returns an SQL expression identifying suspended cust_main records.
8224 sub suspended_sql { susp_sql(@_); }
8226 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
8228 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
8234 Returns an SQL expression identifying cancelled cust_main records.
8238 sub cancelled_sql { cancel_sql(@_); }
8241 my $recurring_sql = FS::cust_pkg->recurring_sql;
8242 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
8245 0 < ( $select_count_pkgs )
8246 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
8247 AND 0 = ( $select_count_pkgs AND $recurring_sql
8248 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
8250 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
8256 =item uncancelled_sql
8258 Returns an SQL expression identifying un-cancelled cust_main records.
8262 sub uncancelled_sql { uncancel_sql(@_); }
8263 sub uncancel_sql { "
8264 ( 0 < ( $select_count_pkgs
8265 AND ( cust_pkg.cancel IS NULL
8266 OR cust_pkg.cancel = 0
8269 OR 0 = ( $select_count_pkgs )
8275 Returns an SQL fragment to retreive the balance.
8280 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
8281 WHERE cust_bill.custnum = cust_main.custnum )
8282 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
8283 WHERE cust_pay.custnum = cust_main.custnum )
8284 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
8285 WHERE cust_credit.custnum = cust_main.custnum )
8286 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
8287 WHERE cust_refund.custnum = cust_main.custnum )
8290 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8292 Returns an SQL fragment to retreive the balance for this customer, only
8293 considering invoices with date earlier than START_TIME, and optionally not
8294 later than END_TIME (total_owed_date minus total_unapplied_credits minus
8295 total_unapplied_payments).
8297 Times are specified as SQL fragments or numeric
8298 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
8299 L<Date::Parse> for conversion functions. The empty string can be passed
8300 to disable that time constraint completely.
8302 Available options are:
8306 =item unapplied_date
8308 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)
8313 set to true to remove all customer comparison clauses, for totals
8318 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
8323 JOIN clause (typically used with the total option)
8329 sub balance_date_sql {
8330 my( $class, $start, $end, %opt ) = @_;
8332 my $owed = FS::cust_bill->owed_sql;
8333 my $unapp_refund = FS::cust_refund->unapplied_sql;
8334 my $unapp_credit = FS::cust_credit->unapplied_sql;
8335 my $unapp_pay = FS::cust_pay->unapplied_sql;
8337 my $j = $opt{'join'} || '';
8339 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
8340 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
8341 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
8342 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
8344 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
8345 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
8346 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
8347 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
8352 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
8354 Returns an SQL fragment to retreive the total unapplied payments for this
8355 customer, only considering invoices with date earlier than START_TIME, and
8356 optionally not later than END_TIME.
8358 Times are specified as SQL fragments or numeric
8359 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
8360 L<Date::Parse> for conversion functions. The empty string can be passed
8361 to disable that time constraint completely.
8363 Available options are:
8367 sub unapplied_payments_date_sql {
8368 my( $class, $start, $end, ) = @_;
8370 my $unapp_pay = FS::cust_pay->unapplied_sql;
8372 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
8373 'unapplied_date'=>1 );
8375 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
8378 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8380 Helper method for balance_date_sql; name (and usage) subject to change
8381 (suggestions welcome).
8383 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
8384 cust_refund, cust_credit or cust_pay).
8386 If TABLE is "cust_bill" or the unapplied_date option is true, only
8387 considers records with date earlier than START_TIME, and optionally not
8388 later than END_TIME .
8392 sub _money_table_where {
8393 my( $class, $table, $start, $end, %opt ) = @_;
8396 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
8397 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
8398 push @where, "$table._date <= $start" if defined($start) && length($start);
8399 push @where, "$table._date > $end" if defined($end) && length($end);
8401 push @where, @{$opt{'where'}} if $opt{'where'};
8402 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
8408 =item search HASHREF
8412 Returns a qsearch hash expression to search for parameters specified in
8413 HASHREF. Valid parameters are
8421 =item cancelled_pkgs
8427 listref of start date, end date
8437 =item current_balance
8439 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
8443 =item flattened_pkgs
8452 my ($class, $params) = @_;
8463 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
8465 "cust_main.agentnum = $1";
8472 #prospect active inactive suspended cancelled
8473 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
8474 my $method = $params->{'status'}. '_sql';
8475 #push @where, $class->$method();
8476 push @where, FS::cust_main->$method();
8480 # parse cancelled package checkbox
8485 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
8486 unless $params->{'cancelled_pkgs'};
8489 # parse without census tract checkbox
8492 push @where, "(censustract = '' or censustract is null)"
8493 if $params->{'no_censustract'};
8499 foreach my $field (qw( signupdate )) {
8501 next unless exists($params->{$field});
8503 my($beginning, $ending) = @{$params->{$field}};
8506 "cust_main.$field IS NOT NULL",
8507 "cust_main.$field >= $beginning",
8508 "cust_main.$field <= $ending";
8510 $orderby ||= "ORDER BY cust_main.$field";
8518 if ( $params->{'classnum'} ) {
8520 my @classnum = ref( $params->{'classnum'} )
8521 ? @{ $params->{'classnum'} }
8522 : ( $params->{'classnum'} );
8524 @classnum = grep /^(\d*)$/, @classnum;
8527 push @where, '( '. join(' OR ', map {
8528 $_ ? "cust_main.classnum = $_"
8529 : "cust_main.classnum IS NULL"
8542 if ( $params->{'payby'} ) {
8544 my @payby = ref( $params->{'payby'} )
8545 ? @{ $params->{'payby'} }
8546 : ( $params->{'payby'} );
8548 @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
8550 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )'
8556 # paydate_year / paydate_month
8559 if ( $params->{'paydate_year'} =~ /^(\d{4})$/ ) {
8561 $params->{'paydate_month'} =~ /^(\d\d?)$/
8562 or die "paydate_year without paydate_month?";
8566 'paydate IS NOT NULL',
8568 "CAST(paydate AS timestamp) < CAST('$year-$month-01' AS timestamp )"
8576 if ( $params->{'invoice_terms'} =~ /^([\w ]+)$/ ) {
8578 if ( $1 eq 'NULL' ) {
8580 "( cust_main.invoice_terms IS NULL OR cust_main.invoice_terms = '' )";
8583 "cust_main.invoice_terms IS NOT NULL",
8584 "cust_main.invoice_terms = '$1'";
8592 if ( $params->{'current_balance'} ) {
8594 #my $balance_sql = $class->balance_sql();
8595 my $balance_sql = FS::cust_main->balance_sql();
8597 my @current_balance =
8598 ref( $params->{'current_balance'} )
8599 ? @{ $params->{'current_balance'} }
8600 : ( $params->{'current_balance'} );
8602 push @where, map { s/current_balance/$balance_sql/; $_ }
8611 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
8613 "cust_main.custbatch = '$1'";
8617 # setup queries, subs, etc. for the search
8620 $orderby ||= 'ORDER BY custnum';
8622 # here is the agent virtualization
8623 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
8625 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
8627 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
8629 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
8631 my $select = join(', ',
8632 'cust_main.custnum',
8633 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
8636 my(@extra_headers) = ();
8637 my(@extra_fields) = ();
8639 if ($params->{'flattened_pkgs'}) {
8641 if ($dbh->{Driver}->{Name} eq 'Pg') {
8643 $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";
8645 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
8646 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
8647 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
8649 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
8650 "omitting packing information from report.";
8653 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";
8655 my $sth = dbh->prepare($header_query) or die dbh->errstr;
8656 $sth->execute() or die $sth->errstr;
8657 my $headerrow = $sth->fetchrow_arrayref;
8658 my $headercount = $headerrow ? $headerrow->[0] : 0;
8659 while($headercount) {
8660 unshift @extra_headers, "Package ". $headercount;
8661 unshift @extra_fields, eval q!sub {my $c = shift;
8662 my @a = split '\|', $c->magic;
8663 my $p = $a[!.--$headercount. q!];
8671 'table' => 'cust_main',
8672 'select' => $select,
8674 'extra_sql' => $extra_sql,
8675 'order_by' => $orderby,
8676 'count_query' => $count_query,
8677 'extra_headers' => \@extra_headers,
8678 'extra_fields' => \@extra_fields,
8683 =item email_search_result HASHREF
8687 Emails a notice to the specified customers.
8689 Valid parameters are those of the L<search> method, plus the following:
8711 Optional job queue job for status updates.
8715 Returns an error message, or false for success.
8717 If an error occurs during any email, stops the enture send and returns that
8718 error. Presumably if you're getting SMTP errors aborting is better than
8719 retrying everything.
8723 sub email_search_result {
8724 my($class, $params) = @_;
8726 my $from = delete $params->{from};
8727 my $subject = delete $params->{subject};
8728 my $html_body = delete $params->{html_body};
8729 my $text_body = delete $params->{text_body};
8731 my $job = delete $params->{'job'};
8733 $params->{'payby'} = [ split(/\0/, $params->{'payby'}) ]
8734 unless ref($params->{'payby'});
8736 my $sql_query = $class->search($params);
8738 my $count_query = delete($sql_query->{'count_query'});
8739 my $count_sth = dbh->prepare($count_query)
8740 or die "Error preparing $count_query: ". dbh->errstr;
8742 or die "Error executing $count_query: ". $count_sth->errstr;
8743 my $count_arrayref = $count_sth->fetchrow_arrayref;
8744 my $num_cust = $count_arrayref->[0];
8746 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
8747 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
8750 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
8752 #eventually order+limit magic to reduce memory use?
8753 foreach my $cust_main ( qsearch($sql_query) ) {
8755 my $to = $cust_main->invoicing_list_emailonly_scalar;
8758 my $error = send_email(
8762 'subject' => $subject,
8763 'html_body' => $html_body,
8764 'text_body' => $text_body,
8767 return $error if $error;
8769 if ( $job ) { #progressbar foo
8771 if ( time - $min_sec > $last ) {
8772 my $error = $job->update_statustext(
8773 int( 100 * $num / $num_cust )
8775 die $error if $error;
8785 use Storable qw(thaw);
8788 sub process_email_search_result {
8790 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
8792 my $param = thaw(decode_base64(shift));
8793 warn Dumper($param) if $DEBUG;
8795 $param->{'job'} = $job;
8797 $param->{'payby'} = [ split(/\0/, $param->{'payby'}) ]
8798 unless ref($param->{'payby'});
8800 my $error = FS::cust_main->email_search_result( $param );
8801 die $error if $error;
8805 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
8807 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
8808 records. Currently, I<first>, I<last>, I<company> and/or I<address1> may be
8809 specified (the appropriate ship_ field is also searched).
8811 Additional options are the same as FS::Record::qsearch
8816 my( $self, $fuzzy, $hash, @opt) = @_;
8821 check_and_rebuild_fuzzyfiles();
8822 foreach my $field ( keys %$fuzzy ) {
8824 my $all = $self->all_X($field);
8825 next unless scalar(@$all);
8828 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
8831 foreach ( keys %match ) {
8832 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
8833 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
8836 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
8839 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
8841 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
8849 Returns a masked version of the named field
8854 my ($self,$field) = @_;
8858 'x'x(length($self->getfield($field))-4).
8859 substr($self->getfield($field), (length($self->getfield($field))-4));
8869 =item smart_search OPTION => VALUE ...
8871 Accepts the following options: I<search>, the string to search for. The string
8872 will be searched for as a customer number, phone number, name or company name,
8873 as an exact, or, in some cases, a substring or fuzzy match (see the source code
8874 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
8875 skip fuzzy matching when an exact match is found.
8877 Any additional options are treated as an additional qualifier on the search
8880 Returns a (possibly empty) array of FS::cust_main objects.
8887 #here is the agent virtualization
8888 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8892 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
8893 my $search = delete $options{'search'};
8894 ( my $alphanum_search = $search ) =~ s/\W//g;
8896 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
8898 #false laziness w/Record::ut_phone
8899 my $phonen = "$1-$2-$3";
8900 $phonen .= " x$4" if $4;
8902 push @cust_main, qsearch( {
8903 'table' => 'cust_main',
8904 'hashref' => { %options },
8905 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8907 join(' OR ', map "$_ = '$phonen'",
8908 qw( daytime night fax
8909 ship_daytime ship_night ship_fax )
8912 " AND $agentnums_sql", #agent virtualization
8915 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
8916 #try looking for matches with extensions unless one was specified
8918 push @cust_main, qsearch( {
8919 'table' => 'cust_main',
8920 'hashref' => { %options },
8921 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8923 join(' OR ', map "$_ LIKE '$phonen\%'",
8925 ship_daytime ship_night )
8928 " AND $agentnums_sql", #agent virtualization
8933 # custnum search (also try agent_custid), with some tweaking options if your
8934 # legacy cust "numbers" have letters
8937 if ( $search =~ /^\s*(\d+)\s*$/
8938 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
8939 && $search =~ /^\s*(\w\w?\d+)\s*$/
8941 || ( $conf->exists('address1-search' )
8942 && $search =~ /^\s*(\d+\-?\w*)\s*$/ #i.e. 1234A or 9432-D
8949 if ( $num =~ /^(\d+)$/ && $num <= 2147483647 ) { #need a bigint custnum? wow
8950 push @cust_main, qsearch( {
8951 'table' => 'cust_main',
8952 'hashref' => { 'custnum' => $num, %options },
8953 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8957 push @cust_main, qsearch( {
8958 'table' => 'cust_main',
8959 'hashref' => { 'agent_custid' => $num, %options },
8960 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8963 if ( $conf->exists('address1-search') ) {
8964 my $len = length($num);
8966 foreach my $prefix ( '', 'ship_' ) {
8967 push @cust_main, qsearch( {
8968 'table' => 'cust_main',
8969 'hashref' => { %options, },
8971 ( keys(%options) ? ' AND ' : ' WHERE ' ).
8972 " LOWER(SUBSTRING(${prefix}address1 FROM 1 FOR $len)) = '$num' ".
8973 " AND $agentnums_sql",
8978 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
8980 my($company, $last, $first) = ( $1, $2, $3 );
8982 # "Company (Last, First)"
8983 #this is probably something a browser remembered,
8984 #so just do an exact search (but case-insensitive, so USPS standardization
8985 #doesn't throw a wrench in the works)
8987 foreach my $prefix ( '', 'ship_' ) {
8988 push @cust_main, qsearch( {
8989 'table' => 'cust_main',
8990 'hashref' => { %options },
8992 ( keys(%options) ? ' AND ' : ' WHERE ' ).
8994 " LOWER(${prefix}first) = ". dbh->quote(lc($first)),
8995 " LOWER(${prefix}last) = ". dbh->quote(lc($last)),
8996 " LOWER(${prefix}company) = ". dbh->quote(lc($company)),
9002 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
9003 # try (ship_){last,company}
9007 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
9008 # # full strings the browser remembers won't work
9009 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
9011 use Lingua::EN::NameParse;
9012 my $NameParse = new Lingua::EN::NameParse(
9014 allow_reversed => 1,
9017 my($last, $first) = ( '', '' );
9018 #maybe disable this too and just rely on NameParse?
9019 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
9021 ($last, $first) = ( $1, $2 );
9023 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
9024 } elsif ( ! $NameParse->parse($value) ) {
9026 my %name = $NameParse->components;
9027 $first = $name{'given_name_1'};
9028 $last = $name{'surname_1'};
9032 if ( $first && $last ) {
9034 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
9037 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
9039 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
9040 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
9043 push @cust_main, qsearch( {
9044 'table' => 'cust_main',
9045 'hashref' => \%options,
9046 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
9049 # or it just be something that was typed in... (try that in a sec)
9053 my $q_value = dbh->quote($value);
9056 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
9057 $sql .= " ( LOWER(last) = $q_value
9058 OR LOWER(company) = $q_value
9059 OR LOWER(ship_last) = $q_value
9060 OR LOWER(ship_company) = $q_value
9062 $sql .= " OR LOWER(address1) = $q_value
9063 OR LOWER(ship_address1) = $q_value
9065 if $conf->exists('address1-search');
9068 push @cust_main, qsearch( {
9069 'table' => 'cust_main',
9070 'hashref' => \%options,
9071 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
9074 #no exact match, trying substring/fuzzy
9075 #always do substring & fuzzy (unless they're explicity config'ed off)
9076 #getting complaints searches are not returning enough
9077 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
9079 #still some false laziness w/search (was search/cust_main.cgi)
9084 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
9085 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
9088 if ( $first && $last ) {
9091 { 'first' => { op=>'ILIKE', value=>"%$first%" },
9092 'last' => { op=>'ILIKE', value=>"%$last%" },
9094 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
9095 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
9102 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
9103 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
9107 if ( $conf->exists('address1-search') ) {
9109 { 'address1' => { op=>'ILIKE', value=>"%$value%" }, },
9110 { 'ship_address1' => { op=>'ILIKE', value=>"%$value%" }, },
9114 foreach my $hashref ( @hashrefs ) {
9116 push @cust_main, qsearch( {
9117 'table' => 'cust_main',
9118 'hashref' => { %$hashref,
9121 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
9130 " AND $agentnums_sql", #extra_sql #agent virtualization
9133 if ( $first && $last ) {
9134 push @cust_main, FS::cust_main->fuzzy_search(
9135 { 'last' => $last, #fuzzy hashref
9136 'first' => $first }, #
9140 foreach my $field ( 'last', 'company' ) {
9142 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
9144 if ( $conf->exists('address1-search') ) {
9146 FS::cust_main->fuzzy_search( { 'address1' => $value }, @fuzopts );
9153 #eliminate duplicates
9155 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
9163 Accepts the following options: I<email>, the email address to search for. The
9164 email address will be searched for as an email invoice destination and as an
9167 #Any additional options are treated as an additional qualifier on the search
9168 #(i.e. I<agentnum>).
9170 Returns a (possibly empty) array of FS::cust_main objects (but usually just
9180 my $email = delete $options{'email'};
9182 #we're only being used by RT at the moment... no agent virtualization yet
9183 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
9187 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
9189 my ( $user, $domain ) = ( $1, $2 );
9191 warn "$me smart_search: searching for $user in domain $domain"
9197 'table' => 'cust_main_invoice',
9198 'hashref' => { 'dest' => $email },
9205 map $_->cust_svc->cust_pkg,
9207 'table' => 'svc_acct',
9208 'hashref' => { 'username' => $user, },
9210 'AND ( SELECT domain FROM svc_domain
9211 WHERE svc_acct.domsvc = svc_domain.svcnum
9212 ) = '. dbh->quote($domain),
9218 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
9220 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
9227 =item check_and_rebuild_fuzzyfiles
9231 sub check_and_rebuild_fuzzyfiles {
9232 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9233 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
9236 =item rebuild_fuzzyfiles
9240 sub rebuild_fuzzyfiles {
9242 use Fcntl qw(:flock);
9244 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9245 mkdir $dir, 0700 unless -d $dir;
9247 foreach my $fuzzy ( @fuzzyfields ) {
9249 open(LOCK,">>$dir/cust_main.$fuzzy")
9250 or die "can't open $dir/cust_main.$fuzzy: $!";
9252 or die "can't lock $dir/cust_main.$fuzzy: $!";
9254 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
9255 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
9257 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
9258 my $sth = dbh->prepare("SELECT $field FROM cust_main".
9259 " WHERE $field != '' AND $field IS NOT NULL");
9260 $sth->execute or die $sth->errstr;
9262 while ( my $row = $sth->fetchrow_arrayref ) {
9263 print CACHE $row->[0]. "\n";
9268 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
9270 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
9281 my( $self, $field ) = @_;
9282 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9283 open(CACHE,"<$dir/cust_main.$field")
9284 or die "can't open $dir/cust_main.$field: $!";
9285 my @array = map { chomp; $_; } <CACHE>;
9290 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
9294 sub append_fuzzyfiles {
9295 #my( $first, $last, $company ) = @_;
9297 &check_and_rebuild_fuzzyfiles;
9299 use Fcntl qw(:flock);
9301 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9303 foreach my $field (@fuzzyfields) {
9308 open(CACHE,">>$dir/cust_main.$field")
9309 or die "can't open $dir/cust_main.$field: $!";
9310 flock(CACHE,LOCK_EX)
9311 or die "can't lock $dir/cust_main.$field: $!";
9313 print CACHE "$value\n";
9315 flock(CACHE,LOCK_UN)
9316 or die "can't unlock $dir/cust_main.$field: $!";
9331 #warn join('-',keys %$param);
9332 my $fh = $param->{filehandle};
9333 my @fields = @{$param->{fields}};
9335 eval "use Text::CSV_XS;";
9338 my $csv = new Text::CSV_XS;
9345 local $SIG{HUP} = 'IGNORE';
9346 local $SIG{INT} = 'IGNORE';
9347 local $SIG{QUIT} = 'IGNORE';
9348 local $SIG{TERM} = 'IGNORE';
9349 local $SIG{TSTP} = 'IGNORE';
9350 local $SIG{PIPE} = 'IGNORE';
9352 my $oldAutoCommit = $FS::UID::AutoCommit;
9353 local $FS::UID::AutoCommit = 0;
9356 #while ( $columns = $csv->getline($fh) ) {
9358 while ( defined($line=<$fh>) ) {
9360 $csv->parse($line) or do {
9361 $dbh->rollback if $oldAutoCommit;
9362 return "can't parse: ". $csv->error_input();
9365 my @columns = $csv->fields();
9366 #warn join('-',@columns);
9369 foreach my $field ( @fields ) {
9370 $row{$field} = shift @columns;
9373 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
9374 unless ( $cust_main ) {
9375 $dbh->rollback if $oldAutoCommit;
9376 return "unknown custnum $row{'custnum'}";
9379 if ( $row{'amount'} > 0 ) {
9380 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
9382 $dbh->rollback if $oldAutoCommit;
9386 } elsif ( $row{'amount'} < 0 ) {
9387 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
9390 $dbh->rollback if $oldAutoCommit;
9400 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
9402 return "Empty file!" unless $imported;
9408 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9410 Sends a templated email notification to the customer (see L<Text::Template>).
9412 OPTIONS is a hash and may include
9414 I<from> - the email sender (default is invoice_from)
9416 I<to> - comma-separated scalar or arrayref of recipients
9417 (default is invoicing_list)
9419 I<subject> - The subject line of the sent email notification
9420 (default is "Notice from company_name")
9422 I<extra_fields> - a hashref of name/value pairs which will be substituted
9425 The following variables are vavailable in the template.
9427 I<$first> - the customer first name
9428 I<$last> - the customer last name
9429 I<$company> - the customer company
9430 I<$payby> - a description of the method of payment for the customer
9431 # would be nice to use FS::payby::shortname
9432 I<$payinfo> - the account information used to collect for this customer
9433 I<$expdate> - the expiration of the customer payment in seconds from epoch
9438 my ($self, $template, %options) = @_;
9440 return unless $conf->exists($template);
9442 my $from = $conf->config('invoice_from', $self->agentnum)
9443 if $conf->exists('invoice_from', $self->agentnum);
9444 $from = $options{from} if exists($options{from});
9446 my $to = join(',', $self->invoicing_list_emailonly);
9447 $to = $options{to} if exists($options{to});
9449 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
9450 if $conf->exists('company_name', $self->agentnum);
9451 $subject = $options{subject} if exists($options{subject});
9453 my $notify_template = new Text::Template (TYPE => 'ARRAY',
9454 SOURCE => [ map "$_\n",
9455 $conf->config($template)]
9457 or die "can't create new Text::Template object: Text::Template::ERROR";
9458 $notify_template->compile()
9459 or die "can't compile template: Text::Template::ERROR";
9461 $FS::notify_template::_template::company_name =
9462 $conf->config('company_name', $self->agentnum);
9463 $FS::notify_template::_template::company_address =
9464 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
9466 my $paydate = $self->paydate || '2037-12-31';
9467 $FS::notify_template::_template::first = $self->first;
9468 $FS::notify_template::_template::last = $self->last;
9469 $FS::notify_template::_template::company = $self->company;
9470 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
9471 my $payby = $self->payby;
9472 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9473 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9475 #credit cards expire at the end of the month/year of their exp date
9476 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9477 $FS::notify_template::_template::payby = 'credit card';
9478 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9479 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9481 }elsif ($payby eq 'COMP') {
9482 $FS::notify_template::_template::payby = 'complimentary account';
9484 $FS::notify_template::_template::payby = 'current method';
9486 $FS::notify_template::_template::expdate = $expire_time;
9488 for (keys %{$options{extra_fields}}){
9490 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
9493 send_email(from => $from,
9495 subject => $subject,
9496 body => $notify_template->fill_in( PACKAGE =>
9497 'FS::notify_template::_template' ),
9502 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9504 Generates a templated notification to the customer (see L<Text::Template>).
9506 OPTIONS is a hash and may include
9508 I<extra_fields> - a hashref of name/value pairs which will be substituted
9509 into the template. These values may override values mentioned below
9510 and those from the customer record.
9512 The following variables are available in the template instead of or in addition
9513 to the fields of the customer record.
9515 I<$payby> - a description of the method of payment for the customer
9516 # would be nice to use FS::payby::shortname
9517 I<$payinfo> - the masked account information used to collect for this customer
9518 I<$expdate> - the expiration of the customer payment method in seconds from epoch
9519 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
9523 sub generate_letter {
9524 my ($self, $template, %options) = @_;
9526 return unless $conf->exists($template);
9528 my $letter_template = new Text::Template
9530 SOURCE => [ map "$_\n", $conf->config($template)],
9531 DELIMITERS => [ '[@--', '--@]' ],
9533 or die "can't create new Text::Template object: Text::Template::ERROR";
9535 $letter_template->compile()
9536 or die "can't compile template: Text::Template::ERROR";
9538 my %letter_data = map { $_ => $self->$_ } $self->fields;
9539 $letter_data{payinfo} = $self->mask_payinfo;
9541 #my $paydate = $self->paydate || '2037-12-31';
9542 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
9544 my $payby = $self->payby;
9545 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9546 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9548 #credit cards expire at the end of the month/year of their exp date
9549 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9550 $letter_data{payby} = 'credit card';
9551 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9552 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9554 }elsif ($payby eq 'COMP') {
9555 $letter_data{payby} = 'complimentary account';
9557 $letter_data{payby} = 'current method';
9559 $letter_data{expdate} = $expire_time;
9561 for (keys %{$options{extra_fields}}){
9562 $letter_data{$_} = $options{extra_fields}->{$_};
9565 unless(exists($letter_data{returnaddress})){
9566 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
9567 $self->agent_template)
9569 if ( length($retadd) ) {
9570 $letter_data{returnaddress} = $retadd;
9571 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
9572 $letter_data{returnaddress} =
9573 join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
9574 $conf->config('company_address', $self->agentnum)
9577 $letter_data{returnaddress} = '~';
9581 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
9583 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
9585 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
9586 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
9590 ) or die "can't open temp file: $!\n";
9592 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
9594 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
9598 =item print_ps TEMPLATE
9600 Returns an postscript letter filled in from TEMPLATE, as a scalar.
9606 my $file = $self->generate_letter(@_);
9607 FS::Misc::generate_ps($file);
9610 =item print TEMPLATE
9612 Prints the filled in template.
9614 TEMPLATE is the name of a L<Text::Template> to fill in and print.
9618 sub queueable_print {
9621 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
9622 or die "invalid customer number: " . $opt{custvnum};
9624 my $error = $self->print( $opt{template} );
9625 die $error if $error;
9629 my ($self, $template) = (shift, shift);
9630 do_print [ $self->print_ps($template) ];
9633 #these three subs should just go away once agent stuff is all config overrides
9635 sub agent_template {
9637 $self->_agent_plandata('agent_templatename');
9640 sub agent_invoice_from {
9642 $self->_agent_plandata('agent_invoice_from');
9645 sub _agent_plandata {
9646 my( $self, $option ) = @_;
9648 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
9649 #agent-specific Conf
9651 use FS::part_event::Condition;
9653 my $agentnum = $self->agentnum;
9656 if ( driver_name =~ /^Pg/i ) {
9658 } elsif ( driver_name =~ /^mysql/i ) {
9661 die "don't know how to use regular expressions in ". driver_name. " databases";
9664 my $part_event_option =
9666 'select' => 'part_event_option.*',
9667 'table' => 'part_event_option',
9669 LEFT JOIN part_event USING ( eventpart )
9670 LEFT JOIN part_event_option AS peo_agentnum
9671 ON ( part_event.eventpart = peo_agentnum.eventpart
9672 AND peo_agentnum.optionname = 'agentnum'
9673 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
9675 LEFT JOIN part_event_condition
9676 ON ( part_event.eventpart = part_event_condition.eventpart
9677 AND part_event_condition.conditionname = 'cust_bill_age'
9679 LEFT JOIN part_event_condition_option
9680 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
9681 AND part_event_condition_option.optionname = 'age'
9684 #'hashref' => { 'optionname' => $option },
9685 #'hashref' => { 'part_event_option.optionname' => $option },
9687 " WHERE part_event_option.optionname = ". dbh->quote($option).
9688 " AND action = 'cust_bill_send_agent' ".
9689 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
9690 " AND peo_agentnum.optionname = 'agentnum' ".
9691 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
9693 CASE WHEN part_event_condition_option.optionname IS NULL
9695 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
9697 , part_event.weight".
9701 unless ( $part_event_option ) {
9702 return $self->agent->invoice_template || ''
9703 if $option eq 'agent_templatename';
9707 $part_event_option->optionvalue;
9712 ## actual sub, not a method, designed to be called from the queue.
9713 ## sets up the customer, and calls the bill_and_collect
9714 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
9715 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
9716 $cust_main->bill_and_collect(
9721 sub _upgrade_data { #class method
9722 my ($class, %opts) = @_;
9724 my $sql = 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL';
9725 my $sth = dbh->prepare($sql) or die dbh->errstr;
9726 $sth->execute or die $sth->errstr;
9736 The delete method should possibly take an FS::cust_main object reference
9737 instead of a scalar customer number.
9739 Bill and collect options should probably be passed as references instead of a
9742 There should probably be a configuration file with a list of allowed credit
9745 No multiple currency support (probably a larger project than just this module).
9747 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
9749 Birthdates rely on negative epoch values.
9751 The payby for card/check batches is broken. With mixed batching, bad
9754 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
9758 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
9759 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
9760 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.