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,
3155 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
3156 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
3157 return "$@ running $method for $cust_pkg\n"
3160 if ( $increment_next_bill ) {
3162 my $next_bill = $part_pkg->add_freq($sdate);
3163 return "unparsable frequency: ". $part_pkg->freq
3164 if $next_bill == -1;
3166 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
3167 # only for figuring next bill date, nothing else, so, reset $sdate again
3169 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
3170 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
3171 $cust_pkg->last_bill($sdate);
3173 $cust_pkg->setfield('bill', $next_bill );
3179 warn "\$setup is undefined" unless defined($setup);
3180 warn "\$recur is undefined" unless defined($recur);
3181 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
3184 # If there's line items, create em cust_bill_pkg records
3185 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
3190 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
3191 # hmm.. and if just the options are modified in some weird price plan?
3193 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
3196 my $error = $cust_pkg->replace( $old_cust_pkg,
3197 'options' => { $cust_pkg->options },
3199 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
3200 if $error; #just in case
3203 $setup = sprintf( "%.2f", $setup );
3204 $recur = sprintf( "%.2f", $recur );
3205 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
3206 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
3208 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
3209 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
3212 if ( $setup != 0 || $recur != 0 ) {
3214 warn " charges (setup=$setup, recur=$recur); adding line items\n"
3217 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
3219 warn " adding customer package invoice detail: $_\n"
3220 foreach @cust_pkg_detail;
3222 push @details, @cust_pkg_detail;
3224 my $cust_bill_pkg = new FS::cust_bill_pkg {
3225 'pkgnum' => $cust_pkg->pkgnum,
3227 'unitsetup' => $unitsetup,
3229 'unitrecur' => $unitrecur,
3230 'quantity' => $cust_pkg->quantity,
3231 'details' => \@details,
3232 'hidden' => $part_pkg->hidden,
3235 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
3236 $cust_bill_pkg->sdate( $hash{last_bill} );
3237 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
3238 $cust_bill_pkg->edate( $time ) if $options{cancel};
3239 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
3240 $cust_bill_pkg->sdate( $sdate );
3241 $cust_bill_pkg->edate( $cust_pkg->bill );
3242 #$cust_bill_pkg->edate( $time ) if $options{cancel};
3245 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
3246 unless $part_pkg->pkgpart == $real_pkgpart;
3248 $$total_setup += $setup;
3249 $$total_recur += $recur;
3256 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
3257 return $error if $error;
3259 push @$cust_bill_pkgs, $cust_bill_pkg;
3261 } #if $setup != 0 || $recur != 0
3271 my $part_pkg = shift;
3272 my $taxlisthash = shift;
3273 my $cust_bill_pkg = shift;
3274 my $cust_pkg = shift;
3275 my $invoice_time = shift;
3276 my $real_pkgpart = shift;
3277 my $options = shift;
3279 my %cust_bill_pkg = ();
3283 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
3284 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
3285 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
3286 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
3288 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
3290 if ( $conf->exists('enable_taxproducts')
3291 && ( scalar($part_pkg->part_pkg_taxoverride)
3292 || $part_pkg->has_taxproduct
3297 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3298 return "fatal: Can't (yet) use tax-pkg_address with taxproducts";
3301 foreach my $class (@classes) {
3302 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class );
3303 return $err_or_ref unless ref($err_or_ref);
3304 $taxes{$class} = $err_or_ref;
3307 unless (exists $taxes{''}) {
3308 my $err_or_ref = $self->_gather_taxes( $part_pkg, '' );
3309 return $err_or_ref unless ref($err_or_ref);
3310 $taxes{''} = $err_or_ref;
3315 my @loc_keys = qw( city county state country );
3317 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3318 my $cust_location = $cust_pkg->cust_location;
3319 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
3322 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
3325 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
3328 $taxhash{'taxclass'} = $part_pkg->taxclass;
3331 my %taxhash_elim = %taxhash;
3332 my @elim = qw( city county state );
3335 #first try a match with taxclass
3336 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
3338 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
3339 #then try a match without taxclass
3340 my %no_taxclass = %taxhash_elim;
3341 $no_taxclass{ 'taxclass' } = '';
3342 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
3345 $taxhash_elim{ shift(@elim) } = '';
3347 } while ( !scalar(@taxes) && scalar(@elim) );
3349 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
3351 if $self->cust_main_exemption; #just to be safe
3353 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3355 $_->set('pkgnum', $cust_pkg->pkgnum );
3356 $_->set('locationnum', $cust_pkg->locationnum );
3360 $taxes{''} = [ @taxes ];
3361 $taxes{'setup'} = [ @taxes ];
3362 $taxes{'recur'} = [ @taxes ];
3363 $taxes{$_} = [ @taxes ] foreach (@classes);
3365 # # maybe eliminate this entirely, along with all the 0% records
3366 # unless ( @taxes ) {
3368 # "fatal: can't find tax rate for state/county/country/taxclass ".
3369 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
3372 } #if $conf->exists('enable_taxproducts') ...
3377 my $separate = $conf->exists('separate_usage');
3378 my $usage_mandate = $cust_pkg->part_pkg->option('usage_mandate', 'Hush!');
3379 if ( $separate || $cust_bill_pkg->hidden || $usage_mandate ) {
3381 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
3382 my %hash = $cust_bill_pkg->hidden # maybe for all bill linked?
3383 ? ( 'section' => $temp_pkg->part_pkg->categoryname )
3386 my $section = $cust_pkg->part_pkg->option('usage_section', 'Hush!');
3387 my $summary = $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
3389 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3390 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
3392 push @display, new FS::cust_bill_pkg_display
3395 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
3399 if ($separate && $section && $summary) {
3400 push @display, new FS::cust_bill_pkg_display { type => 'U',
3405 if ($usage_mandate || $section && $summary) {
3406 $hash{post_total} = 'Y';
3409 $hash{section} = $section if ($separate || $usage_mandate);
3410 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
3413 $cust_bill_pkg->set('display', \@display);
3415 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
3416 foreach my $key (keys %tax_cust_bill_pkg) {
3417 my @taxes = @{ $taxes{$key} || [] };
3418 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
3420 my %localtaxlisthash = ();
3421 foreach my $tax ( @taxes ) {
3423 my $taxname = ref( $tax ). ' '. $tax->taxnum;
3424 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
3425 # ' locationnum'. $cust_pkg->locationnum
3426 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
3428 $taxlisthash->{ $taxname } ||= [ $tax ];
3429 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
3431 $localtaxlisthash{ $taxname } ||= [ $tax ];
3432 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
3436 warn "finding taxed taxes...\n" if $DEBUG > 2;
3437 foreach my $tax ( keys %localtaxlisthash ) {
3438 my $tax_object = shift @{ $localtaxlisthash{$tax} };
3439 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
3441 next unless $tax_object->can('tax_on_tax');
3443 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
3444 my $totname = ref( $tot ). ' '. $tot->taxnum;
3446 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
3448 next unless exists( $localtaxlisthash{ $totname } ); # only increase
3450 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
3451 my $hashref_or_error =
3452 $tax_object->taxline( $localtaxlisthash{$tax},
3453 'custnum' => $self->custnum,
3454 'invoice_time' => $invoice_time,
3456 return $hashref_or_error
3457 unless ref($hashref_or_error);
3459 $taxlisthash->{ $totname } ||= [ $tot ];
3460 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
3472 my $part_pkg = shift;
3476 my $geocode = $self->geocode('cch');
3478 my @taxclassnums = map { $_->taxclassnum }
3479 $part_pkg->part_pkg_taxoverride($class);
3481 unless (@taxclassnums) {
3482 @taxclassnums = map { $_->taxclassnum }
3483 grep { $_->taxable eq 'Y' }
3484 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
3486 warn "Found taxclassnum values of ". join(',', @taxclassnums)
3491 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
3493 @taxes = qsearch({ 'table' => 'tax_rate',
3494 'hashref' => { 'geocode' => $geocode, },
3495 'extra_sql' => $extra_sql,
3497 if scalar(@taxclassnums);
3499 warn "Found taxes ".
3500 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
3507 =item collect [ HASHREF | OPTION => VALUE ... ]
3509 (Attempt to) collect money for this customer's outstanding invoices (see
3510 L<FS::cust_bill>). Usually used after the bill method.
3512 Actions are now triggered by billing events; see L<FS::part_event> and the
3513 billing events web interface. Old-style invoice events (see
3514 L<FS::part_bill_event>) have been deprecated.
3516 If there is an error, returns the error, otherwise returns false.
3518 Options are passed as name-value pairs.
3520 Currently available options are:
3526 Use this time when deciding when to print invoices and late notices on those invoices. The default is now. It is specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions.
3530 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3534 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3538 set true to surpress email card/ACH decline notices.
3542 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
3548 # allows for one time override of normal customer billing method
3553 my( $self, %options ) = @_;
3554 my $invoice_time = $options{'invoice_time'} || time;
3557 local $SIG{HUP} = 'IGNORE';
3558 local $SIG{INT} = 'IGNORE';
3559 local $SIG{QUIT} = 'IGNORE';
3560 local $SIG{TERM} = 'IGNORE';
3561 local $SIG{TSTP} = 'IGNORE';
3562 local $SIG{PIPE} = 'IGNORE';
3564 my $oldAutoCommit = $FS::UID::AutoCommit;
3565 local $FS::UID::AutoCommit = 0;
3568 $self->select_for_update; #mutex
3571 my $balance = $self->balance;
3572 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
3575 if ( exists($options{'retry_card'}) ) {
3576 carp 'retry_card option passed to collect is deprecated; use retry';
3577 $options{'retry'} ||= $options{'retry_card'};
3579 if ( exists($options{'retry'}) && $options{'retry'} ) {
3580 my $error = $self->retry_realtime;
3582 $dbh->rollback if $oldAutoCommit;
3587 my $error = $self->do_cust_event(
3588 'debug' => ( $options{'debug'} || 0 ),
3589 'time' => $invoice_time,
3590 'check_freq' => $options{'check_freq'},
3591 'stage' => 'collect',
3594 $dbh->rollback if $oldAutoCommit;
3598 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3603 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
3605 Runs billing events; see L<FS::part_event> and the billing events web
3608 If there is an error, returns the error, otherwise returns false.
3610 Options are passed as name-value pairs.
3612 Currently available options are:
3618 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.
3622 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3626 "collect" (the default) or "pre-bill"
3630 set true to surpress email card/ACH decline notices.
3634 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)
3640 # allows for one time override of normal customer billing method
3644 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3647 my( $self, %options ) = @_;
3648 my $time = $options{'time'} || time;
3651 local $SIG{HUP} = 'IGNORE';
3652 local $SIG{INT} = 'IGNORE';
3653 local $SIG{QUIT} = 'IGNORE';
3654 local $SIG{TERM} = 'IGNORE';
3655 local $SIG{TSTP} = 'IGNORE';
3656 local $SIG{PIPE} = 'IGNORE';
3658 my $oldAutoCommit = $FS::UID::AutoCommit;
3659 local $FS::UID::AutoCommit = 0;
3662 $self->select_for_update; #mutex
3665 my $balance = $self->balance;
3666 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
3669 # if ( exists($options{'retry_card'}) ) {
3670 # carp 'retry_card option passed to collect is deprecated; use retry';
3671 # $options{'retry'} ||= $options{'retry_card'};
3673 # if ( exists($options{'retry'}) && $options{'retry'} ) {
3674 # my $error = $self->retry_realtime;
3676 # $dbh->rollback if $oldAutoCommit;
3681 # false laziness w/pay_batch::import_results
3683 my $due_cust_event = $self->due_cust_event(
3684 'debug' => ( $options{'debug'} || 0 ),
3686 'check_freq' => $options{'check_freq'},
3687 'stage' => ( $options{'stage'} || 'collect' ),
3689 unless( ref($due_cust_event) ) {
3690 $dbh->rollback if $oldAutoCommit;
3691 return $due_cust_event;
3694 foreach my $cust_event ( @$due_cust_event ) {
3698 #re-eval event conditions (a previous event could have changed things)
3699 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
3700 #don't leave stray "new/locked" records around
3701 my $error = $cust_event->delete;
3703 #gah, even with transactions
3704 $dbh->commit if $oldAutoCommit; #well.
3711 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
3712 warn " running cust_event ". $cust_event->eventnum. "\n"
3716 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
3717 if ( my $error = $cust_event->do_event() ) {
3718 #XXX wtf is this? figure out a proper dealio with return value
3720 # gah, even with transactions.
3721 $dbh->commit if $oldAutoCommit; #well.
3728 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3733 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
3735 Inserts database records for and returns an ordered listref of new events due
3736 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
3737 events are due, an empty listref is returned. If there is an error, returns a
3738 scalar error message.
3740 To actually run the events, call each event's test_condition method, and if
3741 still true, call the event's do_event method.
3743 Options are passed as a hashref or as a list of name-value pairs. Available
3750 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.
3754 "collect" (the default) or "pre-bill"
3758 "Current time" for the events.
3762 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)
3766 Only return events for the specified eventtable (by default, events of all eventtables are returned)
3770 Explicitly pass the objects to be tested (typically used with eventtable).
3774 Set to true to return the objects, but not actually insert them into the
3781 sub due_cust_event {
3783 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
3786 #my $DEBUG = $opt{'debug'}
3787 local($DEBUG) = $opt{'debug'}
3788 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
3790 warn "$me due_cust_event called with options ".
3791 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
3794 $opt{'time'} ||= time;
3796 local $SIG{HUP} = 'IGNORE';
3797 local $SIG{INT} = 'IGNORE';
3798 local $SIG{QUIT} = 'IGNORE';
3799 local $SIG{TERM} = 'IGNORE';
3800 local $SIG{TSTP} = 'IGNORE';
3801 local $SIG{PIPE} = 'IGNORE';
3803 my $oldAutoCommit = $FS::UID::AutoCommit;
3804 local $FS::UID::AutoCommit = 0;
3807 $self->select_for_update #mutex
3808 unless $opt{testonly};
3811 # find possible events (initial search)
3814 my @cust_event = ();
3816 my @eventtable = $opt{'eventtable'}
3817 ? ( $opt{'eventtable'} )
3818 : FS::part_event->eventtables_runorder;
3820 foreach my $eventtable ( @eventtable ) {
3823 if ( $opt{'objects'} ) {
3825 @objects = @{ $opt{'objects'} };
3829 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
3830 @objects = ( $eventtable eq 'cust_main' )
3832 : ( $self->$eventtable() );
3836 my @e_cust_event = ();
3838 my $cross = "CROSS JOIN $eventtable";
3839 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
3840 unless $eventtable eq 'cust_main';
3842 foreach my $object ( @objects ) {
3844 #this first search uses the condition_sql magic for optimization.
3845 #the more possible events we can eliminate in this step the better
3847 my $cross_where = '';
3848 my $pkey = $object->primary_key;
3849 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
3851 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
3853 FS::part_event_condition->where_conditions_sql( $eventtable,
3854 'time'=>$opt{'time'}
3856 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
3858 $extra_sql = "AND $extra_sql" if $extra_sql;
3860 #here is the agent virtualization
3861 $extra_sql .= " AND ( part_event.agentnum IS NULL
3862 OR part_event.agentnum = ". $self->agentnum. ' )';
3864 $extra_sql .= " $order";
3866 warn "searching for events for $eventtable ". $object->$pkey. "\n"
3867 if $opt{'debug'} > 2;
3868 my @part_event = qsearch( {
3869 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
3870 'select' => 'part_event.*',
3871 'table' => 'part_event',
3872 'addl_from' => "$cross $join",
3873 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
3874 'eventtable' => $eventtable,
3877 'extra_sql' => "AND $cross_where $extra_sql",
3881 my $pkey = $object->primary_key;
3882 warn " ". scalar(@part_event).
3883 " possible events found for $eventtable ". $object->$pkey(). "\n";
3886 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
3890 warn " ". scalar(@e_cust_event).
3891 " subtotal possible cust events found for $eventtable\n"
3894 push @cust_event, @e_cust_event;
3898 warn " ". scalar(@cust_event).
3899 " total possible cust events found in initial search\n"
3907 $opt{stage} ||= 'collect';
3909 grep { my $stage = $_->part_event->event_stage;
3910 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
3920 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
3921 'stats_hashref' => \%unsat ),
3924 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
3927 warn " invalid conditions not eliminated with condition_sql:\n".
3928 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
3935 unless( $opt{testonly} ) {
3936 foreach my $cust_event ( @cust_event ) {
3938 my $error = $cust_event->insert();
3940 $dbh->rollback if $oldAutoCommit;
3947 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3953 warn " returning events: ". Dumper(@cust_event). "\n"
3960 =item retry_realtime
3962 Schedules realtime / batch credit card / electronic check / LEC billing
3963 events for for retry. Useful if card information has changed or manual
3964 retry is desired. The 'collect' method must be called to actually retry
3967 Implementation details: For either this customer, or for each of this
3968 customer's open invoices, changes the status of the first "done" (with
3969 statustext error) realtime processing event to "failed".
3973 sub retry_realtime {
3976 local $SIG{HUP} = 'IGNORE';
3977 local $SIG{INT} = 'IGNORE';
3978 local $SIG{QUIT} = 'IGNORE';
3979 local $SIG{TERM} = 'IGNORE';
3980 local $SIG{TSTP} = 'IGNORE';
3981 local $SIG{PIPE} = 'IGNORE';
3983 my $oldAutoCommit = $FS::UID::AutoCommit;
3984 local $FS::UID::AutoCommit = 0;
3987 #a little false laziness w/due_cust_event (not too bad, really)
3989 my $join = FS::part_event_condition->join_conditions_sql;
3990 my $order = FS::part_event_condition->order_conditions_sql;
3993 . join ( ' OR ' , map {
3994 "( part_event.eventtable = " . dbh->quote($_)
3995 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
3996 } FS::part_event->eventtables)
3999 #here is the agent virtualization
4000 my $agent_virt = " ( part_event.agentnum IS NULL
4001 OR part_event.agentnum = ". $self->agentnum. ' )';
4003 #XXX this shouldn't be hardcoded, actions should declare it...
4004 my @realtime_events = qw(
4005 cust_bill_realtime_card
4006 cust_bill_realtime_check
4007 cust_bill_realtime_lec
4011 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
4016 my @cust_event = qsearchs({
4017 'table' => 'cust_event',
4018 'select' => 'cust_event.*',
4019 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
4020 'hashref' => { 'status' => 'done' },
4021 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
4022 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
4025 my %seen_invnum = ();
4026 foreach my $cust_event (@cust_event) {
4028 #max one for the customer, one for each open invoice
4029 my $cust_X = $cust_event->cust_X;
4030 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
4034 or $cust_event->part_event->eventtable eq 'cust_bill'
4037 my $error = $cust_event->retry;
4039 $dbh->rollback if $oldAutoCommit;
4040 return "error scheduling event for retry: $error";
4045 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4050 # some horrid false laziness here to avoid refactor fallout
4051 # eventually realtime realtime_bop and realtime_refund_bop should go
4052 # away and be replaced by _new_realtime_bop and _new_realtime_refund_bop
4054 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
4056 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4057 via a Business::OnlinePayment realtime gateway. See
4058 L<http://420.am/business-onlinepayment> for supported gateways.
4060 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4062 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
4064 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4065 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4066 if set, will override the value from the customer record.
4068 I<description> is a free-text field passed to the gateway. It defaults to
4069 the value defined by the business-onlinepayment-description configuration
4070 option, or "Internet services" if that is unset.
4072 If an I<invnum> is specified, this payment (if successful) is applied to the
4073 specified invoice. If you don't specify an I<invnum> you might want to
4074 call the B<apply_payments> method or set the I<apply> option.
4076 I<apply> can be set to true to apply a resulting payment.
4078 I<quiet> can be set true to surpress email decline notices.
4080 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4081 resulting paynum, if any.
4083 I<payunique> is a unique identifier for this payment.
4085 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
4092 return $self->_new_realtime_bop(@_)
4093 if $self->_new_bop_required();
4095 my($method, $amount);
4097 if (ref($_[0]) eq 'HASH') {
4098 %options = %{$_[0]};
4099 $method = $options{method};
4100 $amount = $options{amount};
4102 ( $method, $amount ) = ( shift, shift );
4106 warn "$me realtime_bop: $method $amount\n";
4107 warn " $_ => $options{$_}\n" foreach keys %options;
4110 return "Amount must be greater than 0" unless $amount > 0;
4112 unless ( $options{'description'} ) {
4113 if ( $conf->exists('business-onlinepayment-description') ) {
4114 my $dtempl = $conf->config('business-onlinepayment-description');
4116 my $agent = $self->agent->agent;
4118 $options{'description'} = eval qq("$dtempl");
4120 $options{'description'} = 'Internet services';
4124 return $self->fake_bop($method, $amount, %options) if $options{'fake'};
4126 eval "use Business::OnlinePayment";
4129 my $payinfo = exists($options{'payinfo'})
4130 ? $options{'payinfo'}
4133 my %method2payby = (
4140 # check for banned credit card/ACH
4143 my $ban = qsearchs('banned_pay', {
4144 'payby' => $method2payby{$method},
4145 'payinfo' => md5_base64($payinfo),
4147 return "Banned credit card" if $ban;
4150 # set taxclass and trans_is_recur based on invnum if there is one
4154 my $trans_is_recur = 0;
4155 if ( $options{'invnum'} ) {
4157 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
4158 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
4161 map { $_->part_pkg }
4163 map { $_->cust_pkg }
4164 $cust_bill->cust_bill_pkg;
4166 my @taxclasses = map $_->taxclass, @part_pkg;
4167 $taxclass = $taxclasses[0]
4168 unless grep { $taxclasses[0] ne $_ } @taxclasses; #unless there are
4169 #different taxclasses
4171 if grep { $_->freq ne '0' } @part_pkg;
4179 #look for an agent gateway override first
4181 if ( $method eq 'CC' ) {
4182 $cardtype = cardtype($payinfo);
4183 } elsif ( $method eq 'ECHECK' ) {
4186 $cardtype = $method;
4190 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4191 cardtype => $cardtype,
4192 taxclass => $taxclass, } )
4193 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4195 taxclass => $taxclass, } )
4196 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4197 cardtype => $cardtype,
4199 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4201 taxclass => '', } );
4203 my $payment_gateway = '';
4204 my( $processor, $login, $password, $action, @bop_options );
4205 if ( $override ) { #use a payment gateway override
4207 $payment_gateway = $override->payment_gateway;
4209 $processor = $payment_gateway->gateway_module;
4210 $login = $payment_gateway->gateway_username;
4211 $password = $payment_gateway->gateway_password;
4212 $action = $payment_gateway->gateway_action;
4213 @bop_options = $payment_gateway->options;
4215 } else { #use the standard settings from the config
4217 ( $processor, $login, $password, $action, @bop_options ) =
4218 $self->default_payment_gateway($method);
4226 my $address = exists($options{'address1'})
4227 ? $options{'address1'}
4229 my $address2 = exists($options{'address2'})
4230 ? $options{'address2'}
4232 $address .= ", ". $address2 if length($address2);
4234 my $o_payname = exists($options{'payname'})
4235 ? $options{'payname'}
4237 my($payname, $payfirst, $paylast);
4238 if ( $o_payname && $method ne 'ECHECK' ) {
4239 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4240 or return "Illegal payname $payname";
4241 ($payfirst, $paylast) = ($1, $2);
4243 $payfirst = $self->getfield('first');
4244 $paylast = $self->getfield('last');
4245 $payname = "$payfirst $paylast";
4248 my @invoicing_list = $self->invoicing_list_emailonly;
4249 if ( $conf->exists('emailinvoiceautoalways')
4250 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4251 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4252 push @invoicing_list, $self->all_emails;
4255 my $email = ($conf->exists('business-onlinepayment-email-override'))
4256 ? $conf->config('business-onlinepayment-email-override')
4257 : $invoicing_list[0];
4261 my $payip = exists($options{'payip'})
4264 $content{customer_ip} = $payip
4267 $content{invoice_number} = $options{'invnum'}
4268 if exists($options{'invnum'}) && length($options{'invnum'});
4270 $content{email_customer} =
4271 ( $conf->exists('business-onlinepayment-email_customer')
4272 || $conf->exists('business-onlinepayment-email-override') );
4275 if ( $method eq 'CC' ) {
4277 $content{card_number} = $payinfo;
4278 $paydate = exists($options{'paydate'})
4279 ? $options{'paydate'}
4281 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4282 $content{expiration} = "$2/$1";
4284 my $paycvv = exists($options{'paycvv'})
4285 ? $options{'paycvv'}
4287 $content{cvv2} = $paycvv
4290 my $paystart_month = exists($options{'paystart_month'})
4291 ? $options{'paystart_month'}
4292 : $self->paystart_month;
4294 my $paystart_year = exists($options{'paystart_year'})
4295 ? $options{'paystart_year'}
4296 : $self->paystart_year;
4298 $content{card_start} = "$paystart_month/$paystart_year"
4299 if $paystart_month && $paystart_year;
4301 my $payissue = exists($options{'payissue'})
4302 ? $options{'payissue'}
4304 $content{issue_number} = $payissue if $payissue;
4306 if ( $self->_bop_recurring_billing( 'payinfo' => $payinfo,
4307 'trans_is_recur' => $trans_is_recur,
4311 $content{recurring_billing} = 'YES';
4312 $content{acct_code} = 'rebill'
4313 if $conf->exists('credit_card-recurring_billing_acct_code');
4316 } elsif ( $method eq 'ECHECK' ) {
4317 ( $content{account_number}, $content{routing_code} ) =
4318 split('@', $payinfo);
4319 $content{bank_name} = $o_payname;
4320 $content{bank_state} = exists($options{'paystate'})
4321 ? $options{'paystate'}
4322 : $self->getfield('paystate');
4323 $content{account_type} = exists($options{'paytype'})
4324 ? uc($options{'paytype'}) || 'CHECKING'
4325 : uc($self->getfield('paytype')) || 'CHECKING';
4326 $content{account_name} = $payname;
4327 $content{customer_org} = $self->company ? 'B' : 'I';
4328 $content{state_id} = exists($options{'stateid'})
4329 ? $options{'stateid'}
4330 : $self->getfield('stateid');
4331 $content{state_id_state} = exists($options{'stateid_state'})
4332 ? $options{'stateid_state'}
4333 : $self->getfield('stateid_state');
4334 $content{customer_ssn} = exists($options{'ss'})
4337 } elsif ( $method eq 'LEC' ) {
4338 $content{phone} = $payinfo;
4342 # run transaction(s)
4345 my $balance = exists( $options{'balance'} )
4346 ? $options{'balance'}
4349 $self->select_for_update; #mutex ... just until we get our pending record in
4351 #the checks here are intended to catch concurrent payments
4352 #double-form-submission prevention is taken care of in cust_pay_pending::check
4355 return "The customer's balance has changed; $method transaction aborted."
4356 if $self->balance < $balance;
4357 #&& $self->balance < $amount; #might as well anyway?
4359 #also check and make sure there aren't *other* pending payments for this cust
4361 my @pending = qsearch('cust_pay_pending', {
4362 'custnum' => $self->custnum,
4363 'status' => { op=>'!=', value=>'done' }
4365 return "A payment is already being processed for this customer (".
4366 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
4367 "); $method transaction aborted."
4368 if scalar(@pending);
4370 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
4372 my $cust_pay_pending = new FS::cust_pay_pending {
4373 'custnum' => $self->custnum,
4374 #'invnum' => $options{'invnum'},
4377 'payby' => $method2payby{$method},
4378 'payinfo' => $payinfo,
4379 'paydate' => $paydate,
4380 'recurring_billing' => $content{recurring_billing},
4381 'pkgnum' => $options{'pkgnum'},
4383 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
4385 $cust_pay_pending->payunique( $options{payunique} )
4386 if defined($options{payunique}) && length($options{payunique});
4387 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
4388 return $cpp_new_err if $cpp_new_err;
4390 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
4392 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
4393 $transaction->content(
4396 'password' => $password,
4397 'action' => $action1,
4398 'description' => $options{'description'},
4399 'amount' => $amount,
4400 #'invoice_number' => $options{'invnum'},
4401 'customer_id' => $self->custnum,
4402 'last_name' => $paylast,
4403 'first_name' => $payfirst,
4405 'address' => $address,
4406 'city' => ( exists($options{'city'})
4409 'state' => ( exists($options{'state'})
4412 'zip' => ( exists($options{'zip'})
4415 'country' => ( exists($options{'country'})
4416 ? $options{'country'}
4418 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4420 'phone' => $self->daytime || $self->night,
4424 $cust_pay_pending->status('pending');
4425 my $cpp_pending_err = $cust_pay_pending->replace;
4426 return $cpp_pending_err if $cpp_pending_err;
4429 my $BOP_TESTING = 0;
4430 my $BOP_TESTING_SUCCESS = 1;
4432 unless ( $BOP_TESTING ) {
4433 $transaction->submit();
4435 if ( $BOP_TESTING_SUCCESS ) {
4436 $transaction->is_success(1);
4437 $transaction->authorization('fake auth');
4439 $transaction->is_success(0);
4440 $transaction->error_message('fake failure');
4444 if ( $transaction->is_success() && $action2 ) {
4446 $cust_pay_pending->status('authorized');
4447 my $cpp_authorized_err = $cust_pay_pending->replace;
4448 return $cpp_authorized_err if $cpp_authorized_err;
4450 my $auth = $transaction->authorization;
4451 my $ordernum = $transaction->can('order_number')
4452 ? $transaction->order_number
4456 new Business::OnlinePayment( $processor, @bop_options );
4463 password => $password,
4464 order_number => $ordernum,
4466 authorization => $auth,
4467 description => $options{'description'},
4470 foreach my $field (qw( authorization_source_code returned_ACI
4471 transaction_identifier validation_code
4472 transaction_sequence_num local_transaction_date
4473 local_transaction_time AVS_result_code )) {
4474 $capture{$field} = $transaction->$field() if $transaction->can($field);
4477 $capture->content( %capture );
4481 unless ( $capture->is_success ) {
4482 my $e = "Authorization successful but capture failed, custnum #".
4483 $self->custnum. ': '. $capture->result_code.
4484 ": ". $capture->error_message;
4491 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
4492 my $cpp_captured_err = $cust_pay_pending->replace;
4493 return $cpp_captured_err if $cpp_captured_err;
4496 # remove paycvv after initial transaction
4499 #false laziness w/misc/process/payment.cgi - check both to make sure working
4501 if ( defined $self->dbdef_table->column('paycvv')
4502 && length($self->paycvv)
4503 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
4505 my $error = $self->remove_cvv;
4507 warn "WARNING: error removing cvv: $error\n";
4515 if ( $transaction->is_success() ) {
4518 if ( $payment_gateway ) { # agent override
4519 $paybatch = $payment_gateway->gatewaynum. '-';
4522 $paybatch .= "$processor:". $transaction->authorization;
4524 $paybatch .= ':'. $transaction->order_number
4525 if $transaction->can('order_number')
4526 && length($transaction->order_number);
4528 my $cust_pay = new FS::cust_pay ( {
4529 'custnum' => $self->custnum,
4530 'invnum' => $options{'invnum'},
4533 'payby' => $method2payby{$method},
4534 'payinfo' => $payinfo,
4535 'paybatch' => $paybatch,
4536 'paydate' => $paydate,
4537 'pkgnum' => $options{'pkgnum'},
4539 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
4540 $cust_pay->payunique( $options{payunique} )
4541 if defined($options{payunique}) && length($options{payunique});
4543 my $oldAutoCommit = $FS::UID::AutoCommit;
4544 local $FS::UID::AutoCommit = 0;
4547 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
4549 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
4552 $cust_pay->invnum(''); #try again with no specific invnum
4553 my $error2 = $cust_pay->insert( $options{'manual'} ?
4554 ( 'manual' => 1 ) : ()
4557 # gah. but at least we have a record of the state we had to abort in
4558 # from cust_pay_pending now.
4559 my $e = "WARNING: $method captured but payment not recorded - ".
4560 "error inserting payment ($processor): $error2".
4561 " (previously tried insert with invnum #$options{'invnum'}" .
4562 ": $error ) - pending payment saved as paypendingnum ".
4563 $cust_pay_pending->paypendingnum. "\n";
4569 if ( $options{'paynum_ref'} ) {
4570 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
4573 $cust_pay_pending->status('done');
4574 $cust_pay_pending->statustext('captured');
4575 $cust_pay_pending->paynum($cust_pay->paynum);
4576 my $cpp_done_err = $cust_pay_pending->replace;
4578 if ( $cpp_done_err ) {
4580 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4581 my $e = "WARNING: $method captured but payment not recorded - ".
4582 "error updating status for paypendingnum ".
4583 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4589 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4591 if ( $options{'apply'} ) {
4592 my $apply_error = $self->apply_payments_and_credits;
4593 if ( $apply_error ) {
4594 warn "WARNING: error applying payment: $apply_error\n";
4595 #but we still should return no error cause the payment otherwise went
4600 return ''; #no error
4606 my $perror = "$processor error: ". $transaction->error_message;
4608 unless ( $transaction->error_message ) {
4611 if ( $transaction->can('response_page') ) {
4613 'page' => ( $transaction->can('response_page')
4614 ? $transaction->response_page
4617 'code' => ( $transaction->can('response_code')
4618 ? $transaction->response_code
4621 'headers' => ( $transaction->can('response_headers')
4622 ? $transaction->response_headers
4628 "No additional debugging information available for $processor";
4631 $perror .= "No error_message returned from $processor -- ".
4632 ( ref($t_response) ? Dumper($t_response) : $t_response );
4636 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
4637 && $conf->exists('emaildecline')
4638 && grep { $_ ne 'POST' } $self->invoicing_list
4639 && ! grep { $transaction->error_message =~ /$_/ }
4640 $conf->config('emaildecline-exclude')
4642 my @templ = $conf->config('declinetemplate');
4643 my $template = new Text::Template (
4645 SOURCE => [ map "$_\n", @templ ],
4646 ) or return "($perror) can't create template: $Text::Template::ERROR";
4647 $template->compile()
4648 or return "($perror) can't compile template: $Text::Template::ERROR";
4652 scalar( $conf->config('company_name', $self->agentnum ) ),
4653 'company_address' =>
4654 join("\n", $conf->config('company_address', $self->agentnum ) ),
4655 'error' => $transaction->error_message,
4658 my $error = send_email(
4659 'from' => $conf->config('invoice_from', $self->agentnum ),
4660 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
4661 'subject' => 'Your payment could not be processed',
4662 'body' => [ $template->fill_in(HASH => $templ_hash) ],
4665 $perror .= " (also received error sending decline notification: $error)"
4670 $cust_pay_pending->status('done');
4671 $cust_pay_pending->statustext("declined: $perror");
4672 my $cpp_done_err = $cust_pay_pending->replace;
4673 if ( $cpp_done_err ) {
4674 my $e = "WARNING: $method declined but pending payment not resolved - ".
4675 "error updating status for paypendingnum ".
4676 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4678 $perror = "$e ($perror)";
4686 sub _bop_recurring_billing {
4687 my( $self, %opt ) = @_;
4689 my $method = scalar($conf->config('credit_card-recurring_billing_flag'));
4691 if ( defined($method) && $method eq 'transaction_is_recur' ) {
4693 return 1 if $opt{'trans_is_recur'};
4697 my %hash = ( 'custnum' => $self->custnum,
4702 if qsearch('cust_pay', { %hash, 'payinfo' => $opt{'payinfo'} } )
4703 || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo('CARD',
4714 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
4716 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
4717 via a Business::OnlinePayment realtime gateway. See
4718 L<http://420.am/business-onlinepayment> for supported gateways.
4720 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4722 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
4724 Most gateways require a reference to an original payment transaction to refund,
4725 so you probably need to specify a I<paynum>.
4727 I<amount> defaults to the original amount of the payment if not specified.
4729 I<reason> specifies a reason for the refund.
4731 I<paydate> specifies the expiration date for a credit card overriding the
4732 value from the customer record or the payment record. Specified as yyyy-mm-dd
4734 Implementation note: If I<amount> is unspecified or equal to the amount of the
4735 orignal payment, first an attempt is made to "void" the transaction via
4736 the gateway (to cancel a not-yet settled transaction) and then if that fails,
4737 the normal attempt is made to "refund" ("credit") the transaction via the
4738 gateway is attempted.
4740 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4741 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4742 #if set, will override the value from the customer record.
4744 #If an I<invnum> is specified, this payment (if successful) is applied to the
4745 #specified invoice. If you don't specify an I<invnum> you might want to
4746 #call the B<apply_payments> method.
4750 #some false laziness w/realtime_bop, not enough to make it worth merging
4751 #but some useful small subs should be pulled out
4752 sub realtime_refund_bop {
4755 return $self->_new_realtime_refund_bop(@_)
4756 if $self->_new_bop_required();
4758 my( $method, %options ) = @_;
4760 warn "$me realtime_refund_bop: $method refund\n";
4761 warn " $_ => $options{$_}\n" foreach keys %options;
4764 eval "use Business::OnlinePayment";
4768 # look up the original payment and optionally a gateway for that payment
4772 my $amount = $options{'amount'};
4774 my( $processor, $login, $password, @bop_options ) ;
4775 my( $auth, $order_number ) = ( '', '', '' );
4777 if ( $options{'paynum'} ) {
4779 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
4780 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
4781 or return "Unknown paynum $options{'paynum'}";
4782 $amount ||= $cust_pay->paid;
4784 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
4785 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
4786 $cust_pay->paybatch;
4787 my $gatewaynum = '';
4788 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
4790 if ( $gatewaynum ) { #gateway for the payment to be refunded
4792 my $payment_gateway =
4793 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
4794 die "payment gateway $gatewaynum not found"
4795 unless $payment_gateway;
4797 $processor = $payment_gateway->gateway_module;
4798 $login = $payment_gateway->gateway_username;
4799 $password = $payment_gateway->gateway_password;
4800 @bop_options = $payment_gateway->options;
4802 } else { #try the default gateway
4804 my( $conf_processor, $unused_action );
4805 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
4806 $self->default_payment_gateway($method);
4808 return "processor of payment $options{'paynum'} $processor does not".
4809 " match default processor $conf_processor"
4810 unless $processor eq $conf_processor;
4815 } else { # didn't specify a paynum, so look for agent gateway overrides
4816 # like a normal transaction
4819 if ( $method eq 'CC' ) {
4820 $cardtype = cardtype($self->payinfo);
4821 } elsif ( $method eq 'ECHECK' ) {
4824 $cardtype = $method;
4827 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4828 cardtype => $cardtype,
4830 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4832 taxclass => '', } );
4834 if ( $override ) { #use a payment gateway override
4836 my $payment_gateway = $override->payment_gateway;
4838 $processor = $payment_gateway->gateway_module;
4839 $login = $payment_gateway->gateway_username;
4840 $password = $payment_gateway->gateway_password;
4841 #$action = $payment_gateway->gateway_action;
4842 @bop_options = $payment_gateway->options;
4844 } else { #use the standard settings from the config
4847 ( $processor, $login, $password, $unused_action, @bop_options ) =
4848 $self->default_payment_gateway($method);
4853 return "neither amount nor paynum specified" unless $amount;
4858 'password' => $password,
4859 'order_number' => $order_number,
4860 'amount' => $amount,
4861 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4863 $content{authorization} = $auth
4864 if length($auth); #echeck/ACH transactions have an order # but no auth
4865 #(at least with authorize.net)
4867 my $disable_void_after;
4868 if ($conf->exists('disable_void_after')
4869 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
4870 $disable_void_after = $1;
4873 #first try void if applicable
4874 if ( $cust_pay && $cust_pay->paid == $amount
4876 ( not defined($disable_void_after) )
4877 || ( time < ($cust_pay->_date + $disable_void_after ) )
4880 warn " attempting void\n" if $DEBUG > 1;
4881 my $void = new Business::OnlinePayment( $processor, @bop_options );
4882 $content{'card_number'} = $cust_pay->payinfo
4883 if $cust_pay->payby eq 'CARD'
4884 && $void->can('info') && $void->info('CC_void_requires_card');
4885 $void->content( 'action' => 'void', %content );
4887 if ( $void->is_success ) {
4888 my $error = $cust_pay->void($options{'reason'});
4890 # gah, even with transactions.
4891 my $e = 'WARNING: Card/ACH voided but database not updated - '.
4892 "error voiding payment: $error";
4896 warn " void successful\n" if $DEBUG > 1;
4901 warn " void unsuccessful, trying refund\n"
4905 my $address = $self->address1;
4906 $address .= ", ". $self->address2 if $self->address2;
4908 my($payname, $payfirst, $paylast);
4909 if ( $self->payname && $method ne 'ECHECK' ) {
4910 $payname = $self->payname;
4911 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4912 or return "Illegal payname $payname";
4913 ($payfirst, $paylast) = ($1, $2);
4915 $payfirst = $self->getfield('first');
4916 $paylast = $self->getfield('last');
4917 $payname = "$payfirst $paylast";
4920 my @invoicing_list = $self->invoicing_list_emailonly;
4921 if ( $conf->exists('emailinvoiceautoalways')
4922 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4923 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4924 push @invoicing_list, $self->all_emails;
4927 my $email = ($conf->exists('business-onlinepayment-email-override'))
4928 ? $conf->config('business-onlinepayment-email-override')
4929 : $invoicing_list[0];
4931 my $payip = exists($options{'payip'})
4934 $content{customer_ip} = $payip
4938 if ( $method eq 'CC' ) {
4941 $content{card_number} = $payinfo = $cust_pay->payinfo;
4942 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
4943 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
4944 ($content{expiration} = "$2/$1"); # where available
4946 $content{card_number} = $payinfo = $self->payinfo;
4947 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
4948 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4949 $content{expiration} = "$2/$1";
4952 } elsif ( $method eq 'ECHECK' ) {
4955 $payinfo = $cust_pay->payinfo;
4957 $payinfo = $self->payinfo;
4959 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
4960 $content{bank_name} = $self->payname;
4961 $content{account_type} = 'CHECKING';
4962 $content{account_name} = $payname;
4963 $content{customer_org} = $self->company ? 'B' : 'I';
4964 $content{customer_ssn} = $self->ss;
4965 } elsif ( $method eq 'LEC' ) {
4966 $content{phone} = $payinfo = $self->payinfo;
4970 my $refund = new Business::OnlinePayment( $processor, @bop_options );
4971 my %sub_content = $refund->content(
4972 'action' => 'credit',
4973 'customer_id' => $self->custnum,
4974 'last_name' => $paylast,
4975 'first_name' => $payfirst,
4977 'address' => $address,
4978 'city' => $self->city,
4979 'state' => $self->state,
4980 'zip' => $self->zip,
4981 'country' => $self->country,
4983 'phone' => $self->daytime || $self->night,
4986 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
4990 return "$processor error: ". $refund->error_message
4991 unless $refund->is_success();
4993 my %method2payby = (
4999 my $paybatch = "$processor:". $refund->authorization;
5000 $paybatch .= ':'. $refund->order_number
5001 if $refund->can('order_number') && $refund->order_number;
5003 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
5004 my @cust_bill_pay = $cust_pay->cust_bill_pay;
5005 last unless @cust_bill_pay;
5006 my $cust_bill_pay = pop @cust_bill_pay;
5007 my $error = $cust_bill_pay->delete;
5011 my $cust_refund = new FS::cust_refund ( {
5012 'custnum' => $self->custnum,
5013 'paynum' => $options{'paynum'},
5014 'refund' => $amount,
5016 'payby' => $method2payby{$method},
5017 'payinfo' => $payinfo,
5018 'paybatch' => $paybatch,
5019 'reason' => $options{'reason'} || 'card or ACH refund',
5021 my $error = $cust_refund->insert;
5023 $cust_refund->paynum(''); #try again with no specific paynum
5024 my $error2 = $cust_refund->insert;
5026 # gah, even with transactions.
5027 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
5028 "error inserting refund ($processor): $error2".
5029 " (previously tried insert with paynum #$options{'paynum'}" .
5040 # does the configuration indicate the new bop routines are required?
5042 sub _new_bop_required {
5045 my $botpp = 'Business::OnlineThirdPartyPayment';
5048 if ( ( $conf->exists('business-onlinepayment-namespace')
5049 && $conf->config('business-onlinepayment-namespace') eq $botpp
5051 or scalar( grep { $_->gateway_namespace eq $botpp }
5052 qsearch( 'payment_gateway', { 'disabled' => '' } )
5060 =item realtime_collect [ OPTION => VALUE ... ]
5062 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
5063 via a Business::OnlinePayment or Business::OnlineThirdPartyPayment realtime
5064 gateway. See L<http://420.am/business-onlinepayment> and
5065 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5067 On failure returns an error message.
5069 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.
5071 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>, I<pkgnum>
5073 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>. If none is specified
5074 then it is deduced from the customer record.
5076 If no I<amount> is specified, then the customer balance is used.
5078 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5079 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5080 if set, will override the value from the customer record.
5082 I<description> is a free-text field passed to the gateway. It defaults to
5083 the value defined by the business-onlinepayment-description configuration
5084 option, or "Internet services" if that is unset.
5086 If an I<invnum> is specified, this payment (if successful) is applied to the
5087 specified invoice. If you don't specify an I<invnum> you might want to
5088 call the B<apply_payments> method or set the I<apply> option.
5090 I<apply> can be set to true to apply a resulting payment.
5092 I<quiet> can be set true to surpress email decline notices.
5094 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5095 resulting paynum, if any.
5097 I<payunique> is a unique identifier for this payment.
5099 I<session_id> is a session identifier associated with this payment.
5101 I<depend_jobnum> allows payment capture to unlock export jobs
5105 sub realtime_collect {
5106 my( $self, %options ) = @_;
5109 warn "$me realtime_collect:\n";
5110 warn " $_ => $options{$_}\n" foreach keys %options;
5113 $options{amount} = $self->balance unless exists( $options{amount} );
5114 $options{method} = FS::payby->payby2bop($self->payby)
5115 unless exists( $options{method} );
5117 return $self->realtime_bop({%options});
5121 =item _realtime_bop { [ ARG => VALUE ... ] }
5123 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
5124 via a Business::OnlinePayment realtime gateway. See
5125 L<http://420.am/business-onlinepayment> for supported gateways.
5127 Required arguments in the hashref are I<method>, and I<amount>
5129 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5131 Available optional arguments are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
5133 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5134 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5135 if set, will override the value from the customer record.
5137 I<description> is a free-text field passed to the gateway. It defaults to
5138 the value defined by the business-onlinepayment-description configuration
5139 option, or "Internet services" if that is unset.
5141 If an I<invnum> is specified, this payment (if successful) is applied to the
5142 specified invoice. If you don't specify an I<invnum> you might want to
5143 call the B<apply_payments> method.
5145 I<quiet> can be set true to surpress email decline notices.
5147 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5148 resulting paynum, if any.
5150 I<payunique> is a unique identifier for this payment.
5152 I<session_id> is a session identifier associated with this payment.
5154 I<depend_jobnum> allows payment capture to unlock export jobs
5156 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
5160 # some helper routines
5161 sub _payment_gateway {
5162 my ($self, $options) = @_;
5164 $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
5165 unless exists($options->{payment_gateway});
5167 $options->{payment_gateway};
5171 my ($self, $options) = @_;
5174 'login' => $options->{payment_gateway}->gateway_username,
5175 'password' => $options->{payment_gateway}->gateway_password,
5180 my ($self, $options) = @_;
5182 $options->{payment_gateway}->gatewaynum
5183 ? $options->{payment_gateway}->options
5184 : @{ $options->{payment_gateway}->get('options') };
5188 my ($self, $options) = @_;
5190 unless ( $options->{'description'} ) {
5191 if ( $conf->exists('business-onlinepayment-description') ) {
5192 my $dtempl = $conf->config('business-onlinepayment-description');
5194 my $agent = $self->agent->agent;
5196 $options->{'description'} = eval qq("$dtempl");
5198 $options->{'description'} = 'Internet services';
5202 $options->{payinfo} = $self->payinfo unless exists( $options->{payinfo} );
5203 $options->{invnum} ||= '';
5204 $options->{payname} = $self->payname unless exists( $options->{payname} );
5208 my ($self, $options) = @_;
5211 $content{address} = exists($options->{'address1'})
5212 ? $options->{'address1'}
5214 my $address2 = exists($options->{'address2'})
5215 ? $options->{'address2'}
5217 $content{address} .= ", ". $address2 if length($address2);
5219 my $payip = exists($options->{'payip'}) ? $options->{'payip'} : $self->payip;
5220 $content{customer_ip} = $payip if length($payip);
5222 $content{invoice_number} = $options->{'invnum'}
5223 if exists($options->{'invnum'}) && length($options->{'invnum'});
5225 $content{email_customer} =
5226 ( $conf->exists('business-onlinepayment-email_customer')
5227 || $conf->exists('business-onlinepayment-email-override') );
5229 $content{payfirst} = $self->getfield('first');
5230 $content{paylast} = $self->getfield('last');
5232 $content{account_name} = "$content{payfirst} $content{paylast}"
5233 if $options->{method} eq 'ECHECK';
5235 $content{name} = $options->{payname};
5236 $content{name} = $content{account_name} if exists($content{account_name});
5238 $content{city} = exists($options->{city})
5241 $content{state} = exists($options->{state})
5244 $content{zip} = exists($options->{zip})
5247 $content{country} = exists($options->{country})
5248 ? $options->{country}
5250 $content{referer} = 'http://cleanwhisker.420.am/'; #XXX fix referer :/
5251 $content{phone} = $self->daytime || $self->night;
5256 my %bop_method2payby = (
5262 sub _new_realtime_bop {
5266 if (ref($_[0]) eq 'HASH') {
5267 %options = %{$_[0]};
5269 my ( $method, $amount ) = ( shift, shift );
5271 $options{method} = $method;
5272 $options{amount} = $amount;
5276 warn "$me realtime_bop (new): $options{method} $options{amount}\n";
5277 warn " $_ => $options{$_}\n" foreach keys %options;
5280 return $self->fake_bop(%options) if $options{'fake'};
5282 $self->_bop_defaults(\%options);
5285 # set trans_is_recur based on invnum if there is one
5288 my $trans_is_recur = 0;
5289 if ( $options{'invnum'} ) {
5291 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
5292 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
5295 map { $_->part_pkg }
5297 map { $_->cust_pkg }
5298 $cust_bill->cust_bill_pkg;
5301 if grep { $_->freq ne '0' } @part_pkg;
5309 my $payment_gateway = $self->_payment_gateway( \%options );
5310 my $namespace = $payment_gateway->gateway_namespace;
5312 eval "use $namespace";
5316 # check for banned credit card/ACH
5319 my $ban = qsearchs('banned_pay', {
5320 'payby' => $bop_method2payby{$options{method}},
5321 'payinfo' => md5_base64($options{payinfo}),
5323 return "Banned credit card" if $ban;
5329 my (%bop_content) = $self->_bop_content(\%options);
5331 if ( $options{method} ne 'ECHECK' ) {
5332 $options{payname} =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5333 or return "Illegal payname $options{payname}";
5334 ($bop_content{payfirst}, $bop_content{paylast}) = ($1, $2);
5337 my @invoicing_list = $self->invoicing_list_emailonly;
5338 if ( $conf->exists('emailinvoiceautoalways')
5339 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5340 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5341 push @invoicing_list, $self->all_emails;
5344 my $email = ($conf->exists('business-onlinepayment-email-override'))
5345 ? $conf->config('business-onlinepayment-email-override')
5346 : $invoicing_list[0];
5350 if ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'CC' ) {
5352 $content{card_number} = $options{payinfo};
5353 $paydate = exists($options{'paydate'})
5354 ? $options{'paydate'}
5356 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
5357 $content{expiration} = "$2/$1";
5359 my $paycvv = exists($options{'paycvv'})
5360 ? $options{'paycvv'}
5362 $content{cvv2} = $paycvv
5365 my $paystart_month = exists($options{'paystart_month'})
5366 ? $options{'paystart_month'}
5367 : $self->paystart_month;
5369 my $paystart_year = exists($options{'paystart_year'})
5370 ? $options{'paystart_year'}
5371 : $self->paystart_year;
5373 $content{card_start} = "$paystart_month/$paystart_year"
5374 if $paystart_month && $paystart_year;
5376 my $payissue = exists($options{'payissue'})
5377 ? $options{'payissue'}
5379 $content{issue_number} = $payissue if $payissue;
5381 if ( $self->_bop_recurring_billing( 'payinfo' => $options{'payinfo'},
5382 'trans_is_recur' => $trans_is_recur,
5386 $content{recurring_billing} = 'YES';
5387 $content{acct_code} = 'rebill'
5388 if $conf->exists('credit_card-recurring_billing_acct_code');
5391 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'ECHECK' ){
5392 ( $content{account_number}, $content{routing_code} ) =
5393 split('@', $options{payinfo});
5394 $content{bank_name} = $options{payname};
5395 $content{bank_state} = exists($options{'paystate'})
5396 ? $options{'paystate'}
5397 : $self->getfield('paystate');
5398 $content{account_type} = exists($options{'paytype'})
5399 ? uc($options{'paytype'}) || 'CHECKING'
5400 : uc($self->getfield('paytype')) || 'CHECKING';
5401 $content{customer_org} = $self->company ? 'B' : 'I';
5402 $content{state_id} = exists($options{'stateid'})
5403 ? $options{'stateid'}
5404 : $self->getfield('stateid');
5405 $content{state_id_state} = exists($options{'stateid_state'})
5406 ? $options{'stateid_state'}
5407 : $self->getfield('stateid_state');
5408 $content{customer_ssn} = exists($options{'ss'})
5411 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'LEC' ) {
5412 $content{phone} = $options{payinfo};
5413 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5420 # run transaction(s)
5423 my $balance = exists( $options{'balance'} )
5424 ? $options{'balance'}
5427 $self->select_for_update; #mutex ... just until we get our pending record in
5429 #the checks here are intended to catch concurrent payments
5430 #double-form-submission prevention is taken care of in cust_pay_pending::check
5433 return "The customer's balance has changed; $options{method} transaction aborted."
5434 if $self->balance < $balance;
5435 #&& $self->balance < $options{amount}; #might as well anyway?
5437 #also check and make sure there aren't *other* pending payments for this cust
5439 my @pending = qsearch('cust_pay_pending', {
5440 'custnum' => $self->custnum,
5441 'status' => { op=>'!=', value=>'done' }
5443 return "A payment is already being processed for this customer (".
5444 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
5445 "); $options{method} transaction aborted."
5446 if scalar(@pending);
5448 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
5450 my $cust_pay_pending = new FS::cust_pay_pending {
5451 'custnum' => $self->custnum,
5452 #'invnum' => $options{'invnum'},
5453 'paid' => $options{amount},
5455 'payby' => $bop_method2payby{$options{method}},
5456 'payinfo' => $options{payinfo},
5457 'paydate' => $paydate,
5458 'recurring_billing' => $content{recurring_billing},
5459 'pkgnum' => $options{'pkgnum'},
5461 'gatewaynum' => $payment_gateway->gatewaynum || '',
5462 'session_id' => $options{session_id} || '',
5463 'jobnum' => $options{depend_jobnum} || '',
5465 $cust_pay_pending->payunique( $options{payunique} )
5466 if defined($options{payunique}) && length($options{payunique});
5467 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
5468 return $cpp_new_err if $cpp_new_err;
5470 my( $action1, $action2 ) =
5471 split( /\s*\,\s*/, $payment_gateway->gateway_action );
5473 my $transaction = new $namespace( $payment_gateway->gateway_module,
5474 $self->_bop_options(\%options),
5477 $transaction->content(
5478 'type' => $options{method},
5479 $self->_bop_auth(\%options),
5480 'action' => $action1,
5481 'description' => $options{'description'},
5482 'amount' => $options{amount},
5483 #'invoice_number' => $options{'invnum'},
5484 'customer_id' => $self->custnum,
5486 'reference' => $cust_pay_pending->paypendingnum, #for now
5491 $cust_pay_pending->status('pending');
5492 my $cpp_pending_err = $cust_pay_pending->replace;
5493 return $cpp_pending_err if $cpp_pending_err;
5496 my $BOP_TESTING = 0;
5497 my $BOP_TESTING_SUCCESS = 1;
5499 unless ( $BOP_TESTING ) {
5500 $transaction->submit();
5502 if ( $BOP_TESTING_SUCCESS ) {
5503 $transaction->is_success(1);
5504 $transaction->authorization('fake auth');
5506 $transaction->is_success(0);
5507 $transaction->error_message('fake failure');
5511 if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5513 return { reference => $cust_pay_pending->paypendingnum,
5514 map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
5516 } elsif ( $transaction->is_success() && $action2 ) {
5518 $cust_pay_pending->status('authorized');
5519 my $cpp_authorized_err = $cust_pay_pending->replace;
5520 return $cpp_authorized_err if $cpp_authorized_err;
5522 my $auth = $transaction->authorization;
5523 my $ordernum = $transaction->can('order_number')
5524 ? $transaction->order_number
5528 new Business::OnlinePayment( $payment_gateway->gateway_module,
5529 $self->_bop_options(\%options),
5534 type => $options{method},
5536 $self->_bop_auth(\%options),
5537 order_number => $ordernum,
5538 amount => $options{amount},
5539 authorization => $auth,
5540 description => $options{'description'},
5543 foreach my $field (qw( authorization_source_code returned_ACI
5544 transaction_identifier validation_code
5545 transaction_sequence_num local_transaction_date
5546 local_transaction_time AVS_result_code )) {
5547 $capture{$field} = $transaction->$field() if $transaction->can($field);
5550 $capture->content( %capture );
5554 unless ( $capture->is_success ) {
5555 my $e = "Authorization successful but capture failed, custnum #".
5556 $self->custnum. ': '. $capture->result_code.
5557 ": ". $capture->error_message;
5565 # remove paycvv after initial transaction
5568 #false laziness w/misc/process/payment.cgi - check both to make sure working
5570 if ( defined $self->dbdef_table->column('paycvv')
5571 && length($self->paycvv)
5572 && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
5574 my $error = $self->remove_cvv;
5576 warn "WARNING: error removing cvv: $error\n";
5584 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5596 if (ref($_[0]) eq 'HASH') {
5597 %options = %{$_[0]};
5599 my ( $method, $amount ) = ( shift, shift );
5601 $options{method} = $method;
5602 $options{amount} = $amount;
5605 if ( $options{'fake_failure'} ) {
5606 return "Error: No error; test failure requested with fake_failure";
5610 #if ( $payment_gateway->gatewaynum ) { # agent override
5611 # $paybatch = $payment_gateway->gatewaynum. '-';
5614 #$paybatch .= "$processor:". $transaction->authorization;
5616 #$paybatch .= ':'. $transaction->order_number
5617 # if $transaction->can('order_number')
5618 # && length($transaction->order_number);
5620 my $paybatch = 'FakeProcessor:54:32';
5622 my $cust_pay = new FS::cust_pay ( {
5623 'custnum' => $self->custnum,
5624 'invnum' => $options{'invnum'},
5625 'paid' => $options{amount},
5627 'payby' => $bop_method2payby{$options{method}},
5628 #'payinfo' => $payinfo,
5629 'payinfo' => '4111111111111111',
5630 'paybatch' => $paybatch,
5631 #'paydate' => $paydate,
5632 'paydate' => '2012-05-01',
5634 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
5636 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5639 $cust_pay->invnum(''); #try again with no specific invnum
5640 my $error2 = $cust_pay->insert( $options{'manual'} ?
5641 ( 'manual' => 1 ) : ()
5644 # gah, even with transactions.
5645 my $e = 'WARNING: Card/ACH debited but database not updated - '.
5646 "error inserting (fake!) payment: $error2".
5647 " (previously tried insert with invnum #$options{'invnum'}" .
5654 if ( $options{'paynum_ref'} ) {
5655 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5658 return ''; #no error
5663 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
5665 # Wraps up processing of a realtime credit card, ACH (electronic check) or
5666 # phone bill transaction.
5668 sub _realtime_bop_result {
5669 my( $self, $cust_pay_pending, $transaction, %options ) = @_;
5671 warn "$me _realtime_bop_result: pending transaction ".
5672 $cust_pay_pending->paypendingnum. "\n";
5673 warn " $_ => $options{$_}\n" foreach keys %options;
5676 my $payment_gateway = $options{payment_gateway}
5677 or return "no payment gateway in arguments to _realtime_bop_result";
5679 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
5680 my $cpp_captured_err = $cust_pay_pending->replace;
5681 return $cpp_captured_err if $cpp_captured_err;
5683 if ( $transaction->is_success() ) {
5686 if ( $payment_gateway->gatewaynum ) { # agent override
5687 $paybatch = $payment_gateway->gatewaynum. '-';
5690 $paybatch .= $payment_gateway->gateway_module. ":".
5691 $transaction->authorization;
5693 $paybatch .= ':'. $transaction->order_number
5694 if $transaction->can('order_number')
5695 && length($transaction->order_number);
5697 my $cust_pay = new FS::cust_pay ( {
5698 'custnum' => $self->custnum,
5699 'invnum' => $options{'invnum'},
5700 'paid' => $cust_pay_pending->paid,
5702 'payby' => $cust_pay_pending->payby,
5703 #'payinfo' => $payinfo,
5704 'paybatch' => $paybatch,
5705 'paydate' => $cust_pay_pending->paydate,
5706 'pkgnum' => $cust_pay_pending->pkgnum,
5708 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
5709 $cust_pay->payunique( $options{payunique} )
5710 if defined($options{payunique}) && length($options{payunique});
5712 my $oldAutoCommit = $FS::UID::AutoCommit;
5713 local $FS::UID::AutoCommit = 0;
5716 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
5718 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5721 $cust_pay->invnum(''); #try again with no specific invnum
5722 my $error2 = $cust_pay->insert( $options{'manual'} ?
5723 ( 'manual' => 1 ) : ()
5726 # gah. but at least we have a record of the state we had to abort in
5727 # from cust_pay_pending now.
5728 my $e = "WARNING: $options{method} captured but payment not recorded -".
5729 " error inserting payment (". $payment_gateway->gateway_module.
5731 " (previously tried insert with invnum #$options{'invnum'}" .
5732 ": $error ) - pending payment saved as paypendingnum ".
5733 $cust_pay_pending->paypendingnum. "\n";
5739 my $jobnum = $cust_pay_pending->jobnum;
5741 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5743 unless ( $placeholder ) {
5744 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5745 my $e = "WARNING: $options{method} captured but job $jobnum not ".
5746 "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
5751 $error = $placeholder->delete;
5754 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5755 my $e = "WARNING: $options{method} captured but could not delete ".
5756 "job $jobnum for paypendingnum ".
5757 $cust_pay_pending->paypendingnum. ": $error\n";
5764 if ( $options{'paynum_ref'} ) {
5765 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5768 $cust_pay_pending->status('done');
5769 $cust_pay_pending->statustext('captured');
5770 $cust_pay_pending->paynum($cust_pay->paynum);
5771 my $cpp_done_err = $cust_pay_pending->replace;
5773 if ( $cpp_done_err ) {
5775 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5776 my $e = "WARNING: $options{method} captured but payment not recorded - ".
5777 "error updating status for paypendingnum ".
5778 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5784 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5786 if ( $options{'apply'} ) {
5787 my $apply_error = $self->apply_payments_and_credits;
5788 if ( $apply_error ) {
5789 warn "WARNING: error applying payment: $apply_error\n";
5790 #but we still should return no error cause the payment otherwise went
5795 return ''; #no error
5801 my $perror = $payment_gateway->gateway_module. " error: ".
5802 $transaction->error_message;
5804 my $jobnum = $cust_pay_pending->jobnum;
5806 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5808 if ( $placeholder ) {
5809 my $error = $placeholder->depended_delete;
5810 $error ||= $placeholder->delete;
5811 warn "error removing provisioning jobs after declined paypendingnum ".
5812 $cust_pay_pending->paypendingnum. "\n";
5814 my $e = "error finding job $jobnum for declined paypendingnum ".
5815 $cust_pay_pending->paypendingnum. "\n";
5821 unless ( $transaction->error_message ) {
5824 if ( $transaction->can('response_page') ) {
5826 'page' => ( $transaction->can('response_page')
5827 ? $transaction->response_page
5830 'code' => ( $transaction->can('response_code')
5831 ? $transaction->response_code
5834 'headers' => ( $transaction->can('response_headers')
5835 ? $transaction->response_headers
5841 "No additional debugging information available for ".
5842 $payment_gateway->gateway_module;
5845 $perror .= "No error_message returned from ".
5846 $payment_gateway->gateway_module. " -- ".
5847 ( ref($t_response) ? Dumper($t_response) : $t_response );
5851 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
5852 && $conf->exists('emaildecline')
5853 && grep { $_ ne 'POST' } $self->invoicing_list
5854 && ! grep { $transaction->error_message =~ /$_/ }
5855 $conf->config('emaildecline-exclude')
5857 my @templ = $conf->config('declinetemplate');
5858 my $template = new Text::Template (
5860 SOURCE => [ map "$_\n", @templ ],
5861 ) or return "($perror) can't create template: $Text::Template::ERROR";
5862 $template->compile()
5863 or return "($perror) can't compile template: $Text::Template::ERROR";
5867 scalar( $conf->config('company_name', $self->agentnum ) ),
5868 'company_address' =>
5869 join("\n", $conf->config('company_address', $self->agentnum ) ),
5870 'error' => $transaction->error_message,
5873 my $error = send_email(
5874 'from' => $conf->config('invoice_from', $self->agentnum ),
5875 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
5876 'subject' => 'Your payment could not be processed',
5877 'body' => [ $template->fill_in(HASH => $templ_hash) ],
5880 $perror .= " (also received error sending decline notification: $error)"
5885 $cust_pay_pending->status('done');
5886 $cust_pay_pending->statustext("declined: $perror");
5887 my $cpp_done_err = $cust_pay_pending->replace;
5888 if ( $cpp_done_err ) {
5889 my $e = "WARNING: $options{method} declined but pending payment not ".
5890 "resolved - error updating status for paypendingnum ".
5891 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5893 $perror = "$e ($perror)";
5901 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
5903 Verifies successful third party processing of a realtime credit card,
5904 ACH (electronic check) or phone bill transaction via a
5905 Business::OnlineThirdPartyPayment realtime gateway. See
5906 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5908 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
5910 The additional options I<payname>, I<city>, I<state>,
5911 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5912 if set, will override the value from the customer record.
5914 I<description> is a free-text field passed to the gateway. It defaults to
5915 "Internet services".
5917 If an I<invnum> is specified, this payment (if successful) is applied to the
5918 specified invoice. If you don't specify an I<invnum> you might want to
5919 call the B<apply_payments> method.
5921 I<quiet> can be set true to surpress email decline notices.
5923 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5924 resulting paynum, if any.
5926 I<payunique> is a unique identifier for this payment.
5928 Returns a hashref containing elements bill_error (which will be undefined
5929 upon success) and session_id of any associated session.
5933 sub realtime_botpp_capture {
5934 my( $self, $cust_pay_pending, %options ) = @_;
5936 warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
5937 warn " $_ => $options{$_}\n" foreach keys %options;
5940 eval "use Business::OnlineThirdPartyPayment";
5944 # select the gateway
5947 my $method = FS::payby->payby2bop($cust_pay_pending->payby);
5949 my $payment_gateway = $cust_pay_pending->gatewaynum
5950 ? qsearchs( 'payment_gateway',
5951 { gatewaynum => $cust_pay_pending->gatewaynum }
5953 : $self->agent->payment_gateway( 'method' => $method,
5954 # 'invnum' => $cust_pay_pending->invnum,
5955 # 'payinfo' => $cust_pay_pending->payinfo,
5958 $options{payment_gateway} = $payment_gateway; # for the helper subs
5964 my @invoicing_list = $self->invoicing_list_emailonly;
5965 if ( $conf->exists('emailinvoiceautoalways')
5966 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5967 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5968 push @invoicing_list, $self->all_emails;
5971 my $email = ($conf->exists('business-onlinepayment-email-override'))
5972 ? $conf->config('business-onlinepayment-email-override')
5973 : $invoicing_list[0];
5977 $content{email_customer} =
5978 ( $conf->exists('business-onlinepayment-email_customer')
5979 || $conf->exists('business-onlinepayment-email-override') );
5982 # run transaction(s)
5986 new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
5987 $self->_bop_options(\%options),
5990 $transaction->reference({ %options });
5992 $transaction->content(
5994 $self->_bop_auth(\%options),
5995 'action' => 'Post Authorization',
5996 'description' => $options{'description'},
5997 'amount' => $cust_pay_pending->paid,
5998 #'invoice_number' => $options{'invnum'},
5999 'customer_id' => $self->custnum,
6000 'referer' => 'http://cleanwhisker.420.am/',
6001 'reference' => $cust_pay_pending->paypendingnum,
6003 'phone' => $self->daytime || $self->night,
6005 # plus whatever is required for bogus capture avoidance
6008 $transaction->submit();
6011 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
6014 bill_error => $error,
6015 session_id => $cust_pay_pending->session_id,
6020 =item default_payment_gateway DEPRECATED -- use agent->payment_gateway
6024 sub default_payment_gateway {
6025 my( $self, $method ) = @_;
6027 die "Real-time processing not enabled\n"
6028 unless $conf->exists('business-onlinepayment');
6030 #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
6033 my $bop_config = 'business-onlinepayment';
6034 $bop_config .= '-ach'
6035 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
6036 my ( $processor, $login, $password, $action, @bop_options ) =
6037 $conf->config($bop_config);
6038 $action ||= 'normal authorization';
6039 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
6040 die "No real-time processor is enabled - ".
6041 "did you set the business-onlinepayment configuration value?\n"
6044 ( $processor, $login, $password, $action, @bop_options )
6049 Removes the I<paycvv> field from the database directly.
6051 If there is an error, returns the error, otherwise returns false.
6057 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
6058 or return dbh->errstr;
6059 $sth->execute($self->custnum)
6060 or return $sth->errstr;
6065 =item _new_realtime_refund_bop METHOD [ OPTION => VALUE ... ]
6067 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
6068 via a Business::OnlinePayment realtime gateway. See
6069 L<http://420.am/business-onlinepayment> for supported gateways.
6071 Available methods are: I<CC>, I<ECHECK> and I<LEC>
6073 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
6075 Most gateways require a reference to an original payment transaction to refund,
6076 so you probably need to specify a I<paynum>.
6078 I<amount> defaults to the original amount of the payment if not specified.
6080 I<reason> specifies a reason for the refund.
6082 I<paydate> specifies the expiration date for a credit card overriding the
6083 value from the customer record or the payment record. Specified as yyyy-mm-dd
6085 Implementation note: If I<amount> is unspecified or equal to the amount of the
6086 orignal payment, first an attempt is made to "void" the transaction via
6087 the gateway (to cancel a not-yet settled transaction) and then if that fails,
6088 the normal attempt is made to "refund" ("credit") the transaction via the
6089 gateway is attempted.
6091 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
6092 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
6093 #if set, will override the value from the customer record.
6095 #If an I<invnum> is specified, this payment (if successful) is applied to the
6096 #specified invoice. If you don't specify an I<invnum> you might want to
6097 #call the B<apply_payments> method.
6101 #some false laziness w/realtime_bop, not enough to make it worth merging
6102 #but some useful small subs should be pulled out
6103 sub _new_realtime_refund_bop {
6107 if (ref($_[0]) ne 'HASH') {
6108 %options = %{$_[0]};
6112 $options{method} = $method;
6116 warn "$me realtime_refund_bop (new): $options{method} refund\n";
6117 warn " $_ => $options{$_}\n" foreach keys %options;
6121 # look up the original payment and optionally a gateway for that payment
6125 my $amount = $options{'amount'};
6127 my( $processor, $login, $password, @bop_options, $namespace ) ;
6128 my( $auth, $order_number ) = ( '', '', '' );
6130 if ( $options{'paynum'} ) {
6132 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
6133 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
6134 or return "Unknown paynum $options{'paynum'}";
6135 $amount ||= $cust_pay->paid;
6137 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
6138 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
6139 $cust_pay->paybatch;
6140 my $gatewaynum = '';
6141 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
6143 if ( $gatewaynum ) { #gateway for the payment to be refunded
6145 my $payment_gateway =
6146 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
6147 die "payment gateway $gatewaynum not found"
6148 unless $payment_gateway;
6150 $processor = $payment_gateway->gateway_module;
6151 $login = $payment_gateway->gateway_username;
6152 $password = $payment_gateway->gateway_password;
6153 $namespace = $payment_gateway->gateway_namespace;
6154 @bop_options = $payment_gateway->options;
6156 } else { #try the default gateway
6159 my $payment_gateway =
6160 $self->agent->payment_gateway('method' => $options{method});
6162 ( $conf_processor, $login, $password, $namespace ) =
6163 map { my $method = "gateway_$_"; $payment_gateway->$method }
6164 qw( module username password namespace );
6166 @bop_options = $payment_gateway->gatewaynum
6167 ? $payment_gateway->options
6168 : @{ $payment_gateway->get('options') };
6170 return "processor of payment $options{'paynum'} $processor does not".
6171 " match default processor $conf_processor"
6172 unless $processor eq $conf_processor;
6177 } else { # didn't specify a paynum, so look for agent gateway overrides
6178 # like a normal transaction
6180 my $payment_gateway =
6181 $self->agent->payment_gateway( 'method' => $options{method},
6182 #'payinfo' => $payinfo,
6184 my( $processor, $login, $password, $namespace ) =
6185 map { my $method = "gateway_$_"; $payment_gateway->$method }
6186 qw( module username password namespace );
6188 my @bop_options = $payment_gateway->gatewaynum
6189 ? $payment_gateway->options
6190 : @{ $payment_gateway->get('options') };
6193 return "neither amount nor paynum specified" unless $amount;
6195 eval "use $namespace";
6199 'type' => $options{method},
6201 'password' => $password,
6202 'order_number' => $order_number,
6203 'amount' => $amount,
6204 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
6206 $content{authorization} = $auth
6207 if length($auth); #echeck/ACH transactions have an order # but no auth
6208 #(at least with authorize.net)
6210 my $disable_void_after;
6211 if ($conf->exists('disable_void_after')
6212 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
6213 $disable_void_after = $1;
6216 #first try void if applicable
6217 if ( $cust_pay && $cust_pay->paid == $amount
6219 ( not defined($disable_void_after) )
6220 || ( time < ($cust_pay->_date + $disable_void_after ) )
6223 warn " attempting void\n" if $DEBUG > 1;
6224 my $void = new Business::OnlinePayment( $processor, @bop_options );
6225 $content{'card_number'} = $cust_pay->payinfo
6226 if $cust_pay->payby eq 'CARD'
6227 && $void->can('info') && $void->info('CC_void_requires_card');
6228 $void->content( 'action' => 'void', %content );
6230 if ( $void->is_success ) {
6231 my $error = $cust_pay->void($options{'reason'});
6233 # gah, even with transactions.
6234 my $e = 'WARNING: Card/ACH voided but database not updated - '.
6235 "error voiding payment: $error";
6239 warn " void successful\n" if $DEBUG > 1;
6244 warn " void unsuccessful, trying refund\n"
6248 my $address = $self->address1;
6249 $address .= ", ". $self->address2 if $self->address2;
6251 my($payname, $payfirst, $paylast);
6252 if ( $self->payname && $options{method} ne 'ECHECK' ) {
6253 $payname = $self->payname;
6254 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
6255 or return "Illegal payname $payname";
6256 ($payfirst, $paylast) = ($1, $2);
6258 $payfirst = $self->getfield('first');
6259 $paylast = $self->getfield('last');
6260 $payname = "$payfirst $paylast";
6263 my @invoicing_list = $self->invoicing_list_emailonly;
6264 if ( $conf->exists('emailinvoiceautoalways')
6265 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
6266 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
6267 push @invoicing_list, $self->all_emails;
6270 my $email = ($conf->exists('business-onlinepayment-email-override'))
6271 ? $conf->config('business-onlinepayment-email-override')
6272 : $invoicing_list[0];
6274 my $payip = exists($options{'payip'})
6277 $content{customer_ip} = $payip
6281 if ( $options{method} eq 'CC' ) {
6284 $content{card_number} = $payinfo = $cust_pay->payinfo;
6285 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
6286 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
6287 ($content{expiration} = "$2/$1"); # where available
6289 $content{card_number} = $payinfo = $self->payinfo;
6290 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
6291 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
6292 $content{expiration} = "$2/$1";
6295 } elsif ( $options{method} eq 'ECHECK' ) {
6298 $payinfo = $cust_pay->payinfo;
6300 $payinfo = $self->payinfo;
6302 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
6303 $content{bank_name} = $self->payname;
6304 $content{account_type} = 'CHECKING';
6305 $content{account_name} = $payname;
6306 $content{customer_org} = $self->company ? 'B' : 'I';
6307 $content{customer_ssn} = $self->ss;
6308 } elsif ( $options{method} eq 'LEC' ) {
6309 $content{phone} = $payinfo = $self->payinfo;
6313 my $refund = new Business::OnlinePayment( $processor, @bop_options );
6314 my %sub_content = $refund->content(
6315 'action' => 'credit',
6316 'customer_id' => $self->custnum,
6317 'last_name' => $paylast,
6318 'first_name' => $payfirst,
6320 'address' => $address,
6321 'city' => $self->city,
6322 'state' => $self->state,
6323 'zip' => $self->zip,
6324 'country' => $self->country,
6326 'phone' => $self->daytime || $self->night,
6329 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
6333 return "$processor error: ". $refund->error_message
6334 unless $refund->is_success();
6336 my $paybatch = "$processor:". $refund->authorization;
6337 $paybatch .= ':'. $refund->order_number
6338 if $refund->can('order_number') && $refund->order_number;
6340 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
6341 my @cust_bill_pay = $cust_pay->cust_bill_pay;
6342 last unless @cust_bill_pay;
6343 my $cust_bill_pay = pop @cust_bill_pay;
6344 my $error = $cust_bill_pay->delete;
6348 my $cust_refund = new FS::cust_refund ( {
6349 'custnum' => $self->custnum,
6350 'paynum' => $options{'paynum'},
6351 'refund' => $amount,
6353 'payby' => $bop_method2payby{$options{method}},
6354 'payinfo' => $payinfo,
6355 'paybatch' => $paybatch,
6356 'reason' => $options{'reason'} || 'card or ACH refund',
6358 my $error = $cust_refund->insert;
6360 $cust_refund->paynum(''); #try again with no specific paynum
6361 my $error2 = $cust_refund->insert;
6363 # gah, even with transactions.
6364 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
6365 "error inserting refund ($processor): $error2".
6366 " (previously tried insert with paynum #$options{'paynum'}" .
6377 =item batch_card OPTION => VALUE...
6379 Adds a payment for this invoice to the pending credit card batch (see
6380 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
6381 runs the payment using a realtime gateway.
6386 my ($self, %options) = @_;
6389 if (exists($options{amount})) {
6390 $amount = $options{amount};
6392 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
6394 return '' unless $amount > 0;
6396 my $invnum = delete $options{invnum};
6397 my $payby = $options{invnum} || $self->payby; #dubious
6399 if ($options{'realtime'}) {
6400 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
6406 my $oldAutoCommit = $FS::UID::AutoCommit;
6407 local $FS::UID::AutoCommit = 0;
6410 #this needs to handle mysql as well as Pg, like svc_acct.pm
6411 #(make it into a common function if folks need to do batching with mysql)
6412 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
6413 or return "Cannot lock pay_batch: " . $dbh->errstr;
6417 'payby' => FS::payby->payby2payment($payby),
6420 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
6422 unless ( $pay_batch ) {
6423 $pay_batch = new FS::pay_batch \%pay_batch;
6424 my $error = $pay_batch->insert;
6426 $dbh->rollback if $oldAutoCommit;
6427 die "error creating new batch: $error\n";
6431 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
6432 'batchnum' => $pay_batch->batchnum,
6433 'custnum' => $self->custnum,
6436 foreach (qw( address1 address2 city state zip country payby payinfo paydate
6438 $options{$_} = '' unless exists($options{$_});
6441 my $cust_pay_batch = new FS::cust_pay_batch ( {
6442 'batchnum' => $pay_batch->batchnum,
6443 'invnum' => $invnum || 0, # is there a better value?
6444 # this field should be
6446 # cust_bill_pay_batch now
6447 'custnum' => $self->custnum,
6448 'last' => $self->getfield('last'),
6449 'first' => $self->getfield('first'),
6450 'address1' => $options{address1} || $self->address1,
6451 'address2' => $options{address2} || $self->address2,
6452 'city' => $options{city} || $self->city,
6453 'state' => $options{state} || $self->state,
6454 'zip' => $options{zip} || $self->zip,
6455 'country' => $options{country} || $self->country,
6456 'payby' => $options{payby} || $self->payby,
6457 'payinfo' => $options{payinfo} || $self->payinfo,
6458 'exp' => $options{paydate} || $self->paydate,
6459 'payname' => $options{payname} || $self->payname,
6460 'amount' => $amount, # consolidating
6463 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
6464 if $old_cust_pay_batch;
6467 if ($old_cust_pay_batch) {
6468 $error = $cust_pay_batch->replace($old_cust_pay_batch)
6470 $error = $cust_pay_batch->insert;
6474 $dbh->rollback if $oldAutoCommit;
6478 my $unapplied = $self->total_unapplied_credits
6479 + $self->total_unapplied_payments
6480 + $self->in_transit_payments;
6481 foreach my $cust_bill ($self->open_cust_bill) {
6482 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
6483 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
6484 'invnum' => $cust_bill->invnum,
6485 'paybatchnum' => $cust_pay_batch->paybatchnum,
6486 'amount' => $cust_bill->owed,
6489 if ($unapplied >= $cust_bill_pay_batch->amount){
6490 $unapplied -= $cust_bill_pay_batch->amount;
6493 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
6494 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
6496 $error = $cust_bill_pay_batch->insert;
6498 $dbh->rollback if $oldAutoCommit;
6503 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6507 =item apply_payments_and_credits [ OPTION => VALUE ... ]
6509 Applies unapplied payments and credits.
6511 In most cases, this new method should be used in place of sequential
6512 apply_payments and apply_credits methods.
6514 A hash of optional arguments may be passed. Currently "manual" is supported.
6515 If true, a payment receipt is sent instead of a statement when
6516 'payment_receipt_email' configuration option is set.
6518 If there is an error, returns the error, otherwise returns false.
6522 sub apply_payments_and_credits {
6523 my( $self, %options ) = @_;
6525 local $SIG{HUP} = 'IGNORE';
6526 local $SIG{INT} = 'IGNORE';
6527 local $SIG{QUIT} = 'IGNORE';
6528 local $SIG{TERM} = 'IGNORE';
6529 local $SIG{TSTP} = 'IGNORE';
6530 local $SIG{PIPE} = 'IGNORE';
6532 my $oldAutoCommit = $FS::UID::AutoCommit;
6533 local $FS::UID::AutoCommit = 0;
6536 $self->select_for_update; #mutex
6538 foreach my $cust_bill ( $self->open_cust_bill ) {
6539 my $error = $cust_bill->apply_payments_and_credits(%options);
6541 $dbh->rollback if $oldAutoCommit;
6542 return "Error applying: $error";
6546 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6551 =item apply_credits OPTION => VALUE ...
6553 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
6554 to outstanding invoice balances in chronological order (or reverse
6555 chronological order if the I<order> option is set to B<newest>) and returns the
6556 value of any remaining unapplied credits available for refund (see
6557 L<FS::cust_refund>).
6559 Dies if there is an error.
6567 local $SIG{HUP} = 'IGNORE';
6568 local $SIG{INT} = 'IGNORE';
6569 local $SIG{QUIT} = 'IGNORE';
6570 local $SIG{TERM} = 'IGNORE';
6571 local $SIG{TSTP} = 'IGNORE';
6572 local $SIG{PIPE} = 'IGNORE';
6574 my $oldAutoCommit = $FS::UID::AutoCommit;
6575 local $FS::UID::AutoCommit = 0;
6578 $self->select_for_update; #mutex
6580 unless ( $self->total_unapplied_credits ) {
6581 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6585 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
6586 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
6588 my @invoices = $self->open_cust_bill;
6589 @invoices = sort { $b->_date <=> $a->_date } @invoices
6590 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
6592 if ( $conf->exists('pkg-balances') ) {
6593 # limit @credits to those w/ a pkgnum grepped from $self
6595 foreach my $i (@invoices) {
6596 foreach my $li ( $i->cust_bill_pkg ) {
6597 $pkgnums{$li->pkgnum} = 1;
6600 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
6605 foreach my $cust_bill ( @invoices ) {
6607 if ( !defined($credit) || $credit->credited == 0) {
6608 $credit = pop @credits or last;
6612 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
6613 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
6615 $owed = $cust_bill->owed;
6617 unless ( $owed > 0 ) {
6618 push @credits, $credit;
6622 my $amount = min( $credit->credited, $owed );
6624 my $cust_credit_bill = new FS::cust_credit_bill ( {
6625 'crednum' => $credit->crednum,
6626 'invnum' => $cust_bill->invnum,
6627 'amount' => $amount,
6629 $cust_credit_bill->pkgnum( $credit->pkgnum )
6630 if $conf->exists('pkg-balances') && $credit->pkgnum;
6631 my $error = $cust_credit_bill->insert;
6633 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6637 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6641 my $total_unapplied_credits = $self->total_unapplied_credits;
6643 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6645 return $total_unapplied_credits;
6648 =item apply_payments [ OPTION => VALUE ... ]
6650 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
6651 to outstanding invoice balances in chronological order.
6653 #and returns the value of any remaining unapplied payments.
6655 A hash of optional arguments may be passed. Currently "manual" is supported.
6656 If true, a payment receipt is sent instead of a statement when
6657 'payment_receipt_email' configuration option is set.
6659 Dies if there is an error.
6663 sub apply_payments {
6664 my( $self, %options ) = @_;
6666 local $SIG{HUP} = 'IGNORE';
6667 local $SIG{INT} = 'IGNORE';
6668 local $SIG{QUIT} = 'IGNORE';
6669 local $SIG{TERM} = 'IGNORE';
6670 local $SIG{TSTP} = 'IGNORE';
6671 local $SIG{PIPE} = 'IGNORE';
6673 my $oldAutoCommit = $FS::UID::AutoCommit;
6674 local $FS::UID::AutoCommit = 0;
6677 $self->select_for_update; #mutex
6681 my @payments = sort { $b->_date <=> $a->_date }
6682 grep { $_->unapplied > 0 }
6685 my @invoices = sort { $a->_date <=> $b->_date}
6686 grep { $_->owed > 0 }
6689 if ( $conf->exists('pkg-balances') ) {
6690 # limit @payments to those w/ a pkgnum grepped from $self
6692 foreach my $i (@invoices) {
6693 foreach my $li ( $i->cust_bill_pkg ) {
6694 $pkgnums{$li->pkgnum} = 1;
6697 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
6702 foreach my $cust_bill ( @invoices ) {
6704 if ( !defined($payment) || $payment->unapplied == 0 ) {
6705 $payment = pop @payments or last;
6709 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
6710 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
6712 $owed = $cust_bill->owed;
6714 unless ( $owed > 0 ) {
6715 push @payments, $payment;
6719 my $amount = min( $payment->unapplied, $owed );
6721 my $cust_bill_pay = new FS::cust_bill_pay ( {
6722 'paynum' => $payment->paynum,
6723 'invnum' => $cust_bill->invnum,
6724 'amount' => $amount,
6726 $cust_bill_pay->pkgnum( $payment->pkgnum )
6727 if $conf->exists('pkg-balances') && $payment->pkgnum;
6728 my $error = $cust_bill_pay->insert(%options);
6730 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6734 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6738 my $total_unapplied_payments = $self->total_unapplied_payments;
6740 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6742 return $total_unapplied_payments;
6747 Returns the total owed for this customer on all invoices
6748 (see L<FS::cust_bill/owed>).
6754 $self->total_owed_date(2145859200); #12/31/2037
6757 =item total_owed_date TIME
6759 Returns the total owed for this customer on all invoices with date earlier than
6760 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6761 see L<Time::Local> and L<Date::Parse> for conversion functions.
6765 sub total_owed_date {
6769 # my $custnum = $self->custnum;
6771 # my $owed_sql = FS::cust_bill->owed_sql;
6774 # SELECT SUM($owed_sql) FROM cust_bill
6775 # WHERE custnum = $custnum
6776 # AND _date <= $time
6779 # my $sth = dbh->prepare($sql) or die dbh->errstr;
6780 # $sth->execute() or die $sth->errstr;
6782 # return sprintf( '%.2f', $sth->fetchrow_arrayref->[0] );
6785 foreach my $cust_bill (
6786 grep { $_->_date <= $time }
6787 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6789 $total_bill += $cust_bill->owed;
6791 sprintf( "%.2f", $total_bill );
6795 =item total_owed_pkgnum PKGNUM
6797 Returns the total owed on all invoices for this customer's specific package
6798 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
6802 sub total_owed_pkgnum {
6803 my( $self, $pkgnum ) = @_;
6804 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
6807 =item total_owed_date_pkgnum TIME PKGNUM
6809 Returns the total owed for this customer's specific package when using
6810 experimental package balances on all invoices with date earlier than
6811 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6812 see L<Time::Local> and L<Date::Parse> for conversion functions.
6816 sub total_owed_date_pkgnum {
6817 my( $self, $time, $pkgnum ) = @_;
6820 foreach my $cust_bill (
6821 grep { $_->_date <= $time }
6822 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6824 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
6826 sprintf( "%.2f", $total_bill );
6832 Returns the total amount of all payments.
6839 $total += $_->paid foreach $self->cust_pay;
6840 sprintf( "%.2f", $total );
6843 =item total_unapplied_credits
6845 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6846 customer. See L<FS::cust_credit/credited>.
6848 =item total_credited
6850 Old name for total_unapplied_credits. Don't use.
6854 sub total_credited {
6855 #carp "total_credited deprecated, use total_unapplied_credits";
6856 shift->total_unapplied_credits(@_);
6859 sub total_unapplied_credits {
6861 my $total_credit = 0;
6862 $total_credit += $_->credited foreach $self->cust_credit;
6863 sprintf( "%.2f", $total_credit );
6866 =item total_unapplied_credits_pkgnum PKGNUM
6868 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6869 customer. See L<FS::cust_credit/credited>.
6873 sub total_unapplied_credits_pkgnum {
6874 my( $self, $pkgnum ) = @_;
6875 my $total_credit = 0;
6876 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
6877 sprintf( "%.2f", $total_credit );
6881 =item total_unapplied_payments
6883 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
6884 See L<FS::cust_pay/unapplied>.
6888 sub total_unapplied_payments {
6890 my $total_unapplied = 0;
6891 $total_unapplied += $_->unapplied foreach $self->cust_pay;
6892 sprintf( "%.2f", $total_unapplied );
6895 =item total_unapplied_payments_pkgnum PKGNUM
6897 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
6898 specific package when using experimental package balances. See
6899 L<FS::cust_pay/unapplied>.
6903 sub total_unapplied_payments_pkgnum {
6904 my( $self, $pkgnum ) = @_;
6905 my $total_unapplied = 0;
6906 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
6907 sprintf( "%.2f", $total_unapplied );
6911 =item total_unapplied_refunds
6913 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
6914 customer. See L<FS::cust_refund/unapplied>.
6918 sub total_unapplied_refunds {
6920 my $total_unapplied = 0;
6921 $total_unapplied += $_->unapplied foreach $self->cust_refund;
6922 sprintf( "%.2f", $total_unapplied );
6927 Returns the balance for this customer (total_owed plus total_unrefunded, minus
6928 total_unapplied_credits minus total_unapplied_payments).
6936 + $self->total_unapplied_refunds
6937 - $self->total_unapplied_credits
6938 - $self->total_unapplied_payments
6942 =item balance_date TIME
6944 Returns the balance for this customer, only considering invoices with date
6945 earlier than TIME (total_owed_date minus total_credited minus
6946 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
6947 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
6956 $self->total_owed_date($time)
6957 + $self->total_unapplied_refunds
6958 - $self->total_unapplied_credits
6959 - $self->total_unapplied_payments
6963 =item balance_date_range START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
6965 Returns the balance for this customer, only considering invoices with date
6966 earlier than START_TIME, and optionally not later than END_TIME
6967 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
6969 Times are specified as SQL fragments or numeric
6970 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
6971 L<Date::Parse> for conversion functions. The empty string can be passed
6972 to disable that time constraint completely.
6974 Available options are:
6978 =item unapplied_date
6980 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)
6986 sub balance_date_range {
6988 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
6989 ') FROM cust_main WHERE custnum='. $self->custnum;
6990 sprintf( "%.2f", $self->scalar_sql($sql) );
6993 =item balance_pkgnum PKGNUM
6995 Returns the balance for this customer's specific package when using
6996 experimental package balances (total_owed plus total_unrefunded, minus
6997 total_unapplied_credits minus total_unapplied_payments)
7001 sub balance_pkgnum {
7002 my( $self, $pkgnum ) = @_;
7005 $self->total_owed_pkgnum($pkgnum)
7006 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
7007 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
7008 - $self->total_unapplied_credits_pkgnum($pkgnum)
7009 - $self->total_unapplied_payments_pkgnum($pkgnum)
7013 =item in_transit_payments
7015 Returns the total of requests for payments for this customer pending in
7016 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
7020 sub in_transit_payments {
7022 my $in_transit_payments = 0;
7023 foreach my $pay_batch ( qsearch('pay_batch', {
7026 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
7027 'batchnum' => $pay_batch->batchnum,
7028 'custnum' => $self->custnum,
7030 $in_transit_payments += $cust_pay_batch->amount;
7033 sprintf( "%.2f", $in_transit_payments );
7038 Returns a hash of useful information for making a payment.
7048 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
7049 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
7050 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
7054 For credit card transactions:
7066 For electronic check transactions:
7081 $return{balance} = $self->balance;
7083 $return{payname} = $self->payname
7084 || ( $self->first. ' '. $self->get('last') );
7086 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
7088 $return{payby} = $self->payby;
7089 $return{stateid_state} = $self->stateid_state;
7091 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
7092 $return{card_type} = cardtype($self->payinfo);
7093 $return{payinfo} = $self->paymask;
7095 @return{'month', 'year'} = $self->paydate_monthyear;
7099 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
7100 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
7101 $return{payinfo1} = $payinfo1;
7102 $return{payinfo2} = $payinfo2;
7103 $return{paytype} = $self->paytype;
7104 $return{paystate} = $self->paystate;
7108 #doubleclick protection
7110 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
7116 =item paydate_monthyear
7118 Returns a two-element list consisting of the month and year of this customer's
7119 paydate (credit card expiration date for CARD customers)
7123 sub paydate_monthyear {
7125 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
7127 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
7134 =item tax_exemption TAXNAME
7139 my( $self, $taxname ) = @_;
7141 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
7142 'taxname' => $taxname,
7147 =item cust_main_exemption
7151 sub cust_main_exemption {
7153 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
7156 =item invoicing_list [ ARRAYREF ]
7158 If an arguement is given, sets these email addresses as invoice recipients
7159 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
7160 (except as warnings), so use check_invoicing_list first.
7162 Returns a list of email addresses (with svcnum entries expanded).
7164 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
7165 check it without disturbing anything by passing nothing.
7167 This interface may change in the future.
7171 sub invoicing_list {
7172 my( $self, $arrayref ) = @_;
7175 my @cust_main_invoice;
7176 if ( $self->custnum ) {
7177 @cust_main_invoice =
7178 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7180 @cust_main_invoice = ();
7182 foreach my $cust_main_invoice ( @cust_main_invoice ) {
7183 #warn $cust_main_invoice->destnum;
7184 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
7185 #warn $cust_main_invoice->destnum;
7186 my $error = $cust_main_invoice->delete;
7187 warn $error if $error;
7190 if ( $self->custnum ) {
7191 @cust_main_invoice =
7192 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7194 @cust_main_invoice = ();
7196 my %seen = map { $_->address => 1 } @cust_main_invoice;
7197 foreach my $address ( @{$arrayref} ) {
7198 next if exists $seen{$address} && $seen{$address};
7199 $seen{$address} = 1;
7200 my $cust_main_invoice = new FS::cust_main_invoice ( {
7201 'custnum' => $self->custnum,
7204 my $error = $cust_main_invoice->insert;
7205 warn $error if $error;
7209 if ( $self->custnum ) {
7211 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7218 =item check_invoicing_list ARRAYREF
7220 Checks these arguements as valid input for the invoicing_list method. If there
7221 is an error, returns the error, otherwise returns false.
7225 sub check_invoicing_list {
7226 my( $self, $arrayref ) = @_;
7228 foreach my $address ( @$arrayref ) {
7230 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
7231 return 'Can\'t add FAX invoice destination with a blank FAX number.';
7234 my $cust_main_invoice = new FS::cust_main_invoice ( {
7235 'custnum' => $self->custnum,
7238 my $error = $self->custnum
7239 ? $cust_main_invoice->check
7240 : $cust_main_invoice->checkdest
7242 return $error if $error;
7246 return "Email address required"
7247 if $conf->exists('cust_main-require_invoicing_list_email')
7248 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
7253 =item set_default_invoicing_list
7255 Sets the invoicing list to all accounts associated with this customer,
7256 overwriting any previous invoicing list.
7260 sub set_default_invoicing_list {
7262 $self->invoicing_list($self->all_emails);
7267 Returns the email addresses of all accounts provisioned for this customer.
7274 foreach my $cust_pkg ( $self->all_pkgs ) {
7275 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
7277 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
7278 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
7280 $list{$_}=1 foreach map { $_->email } @svc_acct;
7285 =item invoicing_list_addpost
7287 Adds postal invoicing to this customer. If this customer is already configured
7288 to receive postal invoices, does nothing.
7292 sub invoicing_list_addpost {
7294 return if grep { $_ eq 'POST' } $self->invoicing_list;
7295 my @invoicing_list = $self->invoicing_list;
7296 push @invoicing_list, 'POST';
7297 $self->invoicing_list(\@invoicing_list);
7300 =item invoicing_list_emailonly
7302 Returns the list of email invoice recipients (invoicing_list without non-email
7303 destinations such as POST and FAX).
7307 sub invoicing_list_emailonly {
7309 warn "$me invoicing_list_emailonly called"
7311 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
7314 =item invoicing_list_emailonly_scalar
7316 Returns the list of email invoice recipients (invoicing_list without non-email
7317 destinations such as POST and FAX) as a comma-separated scalar.
7321 sub invoicing_list_emailonly_scalar {
7323 warn "$me invoicing_list_emailonly_scalar called"
7325 join(', ', $self->invoicing_list_emailonly);
7328 =item referral_custnum_cust_main
7330 Returns the customer who referred this customer (or the empty string, if
7331 this customer was not referred).
7333 Note the difference with referral_cust_main method: This method,
7334 referral_custnum_cust_main returns the single customer (if any) who referred
7335 this customer, while referral_cust_main returns an array of customers referred
7340 sub referral_custnum_cust_main {
7342 return '' unless $self->referral_custnum;
7343 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7346 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
7348 Returns an array of customers referred by this customer (referral_custnum set
7349 to this custnum). If DEPTH is given, recurses up to the given depth, returning
7350 customers referred by customers referred by this customer and so on, inclusive.
7351 The default behavior is DEPTH 1 (no recursion).
7353 Note the difference with referral_custnum_cust_main method: This method,
7354 referral_cust_main, returns an array of customers referred BY this customer,
7355 while referral_custnum_cust_main returns the single customer (if any) who
7356 referred this customer.
7360 sub referral_cust_main {
7362 my $depth = @_ ? shift : 1;
7363 my $exclude = @_ ? shift : {};
7366 map { $exclude->{$_->custnum}++; $_; }
7367 grep { ! $exclude->{ $_->custnum } }
7368 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
7372 map { $_->referral_cust_main($depth-1, $exclude) }
7379 =item referral_cust_main_ncancelled
7381 Same as referral_cust_main, except only returns customers with uncancelled
7386 sub referral_cust_main_ncancelled {
7388 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
7391 =item referral_cust_pkg [ DEPTH ]
7393 Like referral_cust_main, except returns a flat list of all unsuspended (and
7394 uncancelled) packages for each customer. The number of items in this list may
7395 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
7399 sub referral_cust_pkg {
7401 my $depth = @_ ? shift : 1;
7403 map { $_->unsuspended_pkgs }
7404 grep { $_->unsuspended_pkgs }
7405 $self->referral_cust_main($depth);
7408 =item referring_cust_main
7410 Returns the single cust_main record for the customer who referred this customer
7411 (referral_custnum), or false.
7415 sub referring_cust_main {
7417 return '' unless $self->referral_custnum;
7418 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7421 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
7423 Applies a credit to this customer. If there is an error, returns the error,
7424 otherwise returns false.
7426 REASON can be a text string, an FS::reason object, or a scalar reference to
7427 a reasonnum. If a text string, it will be automatically inserted as a new
7428 reason, and a 'reason_type' option must be passed to indicate the
7429 FS::reason_type for the new reason.
7431 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
7433 Any other options are passed to FS::cust_credit::insert.
7438 my( $self, $amount, $reason, %options ) = @_;
7440 my $cust_credit = new FS::cust_credit {
7441 'custnum' => $self->custnum,
7442 'amount' => $amount,
7445 if ( ref($reason) ) {
7447 if ( ref($reason) eq 'SCALAR' ) {
7448 $cust_credit->reasonnum( $$reason );
7450 $cust_credit->reasonnum( $reason->reasonnum );
7454 $cust_credit->set('reason', $reason)
7457 $cust_credit->addlinfo( delete $options{'addlinfo'} )
7458 if exists($options{'addlinfo'});
7460 $cust_credit->insert(%options);
7464 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
7466 Creates a one-time charge for this customer. If there is an error, returns
7467 the error, otherwise returns false.
7469 New-style, with a hashref of options:
7471 my $error = $cust_main->charge(
7475 'start_date' => str2time('7/4/2009'),
7476 'pkg' => 'Description',
7477 'comment' => 'Comment',
7478 'additional' => [], #extra invoice detail
7479 'classnum' => 1, #pkg_class
7481 'setuptax' => '', # or 'Y' for tax exempt
7484 'taxclass' => 'Tax class',
7487 'taxproduct' => 2, #part_pkg_taxproduct
7488 'override' => {}, #XXX describe
7490 #will be filled in with the new object
7491 'cust_pkg_ref' => \$cust_pkg,
7493 #generate an invoice immediately
7495 'invoice_terms' => '', #with these terms
7501 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
7507 my ( $amount, $quantity, $start_date, $classnum );
7508 my ( $pkg, $comment, $additional );
7509 my ( $setuptax, $taxclass ); #internal taxes
7510 my ( $taxproduct, $override ); #vendor (CCH) taxes
7511 my $cust_pkg_ref = '';
7512 my ( $bill_now, $invoice_terms ) = ( 0, '' );
7513 if ( ref( $_[0] ) ) {
7514 $amount = $_[0]->{amount};
7515 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
7516 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
7517 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
7518 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
7519 : '$'. sprintf("%.2f",$amount);
7520 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
7521 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
7522 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
7523 $additional = $_[0]->{additional} || [];
7524 $taxproduct = $_[0]->{taxproductnum};
7525 $override = { '' => $_[0]->{tax_override} };
7526 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
7527 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
7528 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
7533 $pkg = @_ ? shift : 'One-time charge';
7534 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
7536 $taxclass = @_ ? shift : '';
7540 local $SIG{HUP} = 'IGNORE';
7541 local $SIG{INT} = 'IGNORE';
7542 local $SIG{QUIT} = 'IGNORE';
7543 local $SIG{TERM} = 'IGNORE';
7544 local $SIG{TSTP} = 'IGNORE';
7545 local $SIG{PIPE} = 'IGNORE';
7547 my $oldAutoCommit = $FS::UID::AutoCommit;
7548 local $FS::UID::AutoCommit = 0;
7551 my $part_pkg = new FS::part_pkg ( {
7553 'comment' => $comment,
7557 'classnum' => ( $classnum ? $classnum : '' ),
7558 'setuptax' => $setuptax,
7559 'taxclass' => $taxclass,
7560 'taxproductnum' => $taxproduct,
7563 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
7564 ( 0 .. @$additional - 1 )
7566 'additional_count' => scalar(@$additional),
7567 'setup_fee' => $amount,
7570 my $error = $part_pkg->insert( options => \%options,
7571 tax_overrides => $override,
7574 $dbh->rollback if $oldAutoCommit;
7578 my $pkgpart = $part_pkg->pkgpart;
7579 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
7580 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
7581 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
7582 $error = $type_pkgs->insert;
7584 $dbh->rollback if $oldAutoCommit;
7589 my $cust_pkg = new FS::cust_pkg ( {
7590 'custnum' => $self->custnum,
7591 'pkgpart' => $pkgpart,
7592 'quantity' => $quantity,
7593 'start_date' => $start_date,
7596 $error = $cust_pkg->insert;
7598 $dbh->rollback if $oldAutoCommit;
7600 } elsif ( $cust_pkg_ref ) {
7601 ${$cust_pkg_ref} = $cust_pkg;
7605 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
7606 'pkg_list' => [ $cust_pkg ],
7609 $dbh->rollback if $oldAutoCommit;
7614 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
7619 #=item charge_postal_fee
7621 #Applies a one time charge this customer. If there is an error,
7622 #returns the error, returns the cust_pkg charge object or false
7623 #if there was no charge.
7627 # This should be a customer event. For that to work requires that bill
7628 # also be a customer event.
7630 sub charge_postal_fee {
7633 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
7634 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
7636 my $cust_pkg = new FS::cust_pkg ( {
7637 'custnum' => $self->custnum,
7638 'pkgpart' => $pkgpart,
7642 my $error = $cust_pkg->insert;
7643 $error ? $error : $cust_pkg;
7648 Returns all the invoices (see L<FS::cust_bill>) for this customer.
7654 map { $_ } #return $self->num_cust_bill unless wantarray;
7655 sort { $a->_date <=> $b->_date }
7656 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
7659 =item open_cust_bill
7661 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
7666 sub open_cust_bill {
7670 'table' => 'cust_bill',
7671 'hashref' => { 'custnum' => $self->custnum, },
7672 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
7673 'order_by' => 'ORDER BY _date ASC',
7678 =item cust_statements
7680 Returns all the statements (see L<FS::cust_statement>) for this customer.
7684 sub cust_statement {
7686 map { $_ } #return $self->num_cust_statement unless wantarray;
7687 sort { $a->_date <=> $b->_date }
7688 qsearch('cust_statement', { 'custnum' => $self->custnum, } )
7693 Returns all the credits (see L<FS::cust_credit>) for this customer.
7699 map { $_ } #return $self->num_cust_credit unless wantarray;
7700 sort { $a->_date <=> $b->_date }
7701 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
7704 =item cust_credit_pkgnum
7706 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
7707 package when using experimental package balances.
7711 sub cust_credit_pkgnum {
7712 my( $self, $pkgnum ) = @_;
7713 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
7714 sort { $a->_date <=> $b->_date }
7715 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
7716 'pkgnum' => $pkgnum,
7723 Returns all the payments (see L<FS::cust_pay>) for this customer.
7729 return $self->num_cust_pay unless wantarray;
7730 sort { $a->_date <=> $b->_date }
7731 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
7736 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
7737 called automatically when the cust_pay method is used in a scalar context.
7743 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
7744 my $sth = dbh->prepare($sql) or die dbh->errstr;
7745 $sth->execute($self->custnum) or die $sth->errstr;
7746 $sth->fetchrow_arrayref->[0];
7749 =item cust_pay_pkgnum
7751 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
7752 package when using experimental package balances.
7756 sub cust_pay_pkgnum {
7757 my( $self, $pkgnum ) = @_;
7758 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
7759 sort { $a->_date <=> $b->_date }
7760 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
7761 'pkgnum' => $pkgnum,
7768 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
7774 map { $_ } #return $self->num_cust_pay_void unless wantarray;
7775 sort { $a->_date <=> $b->_date }
7776 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
7779 =item cust_pay_batch
7781 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
7785 sub cust_pay_batch {
7787 map { $_ } #return $self->num_cust_pay_batch unless wantarray;
7788 sort { $a->paybatchnum <=> $b->paybatchnum }
7789 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
7792 =item cust_pay_pending
7794 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
7795 (without status "done").
7799 sub cust_pay_pending {
7801 return $self->num_cust_pay_pending unless wantarray;
7802 sort { $a->_date <=> $b->_date }
7803 qsearch( 'cust_pay_pending', {
7804 'custnum' => $self->custnum,
7805 'status' => { op=>'!=', value=>'done' },
7810 =item num_cust_pay_pending
7812 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
7813 customer (without status "done"). Also called automatically when the
7814 cust_pay_pending method is used in a scalar context.
7818 sub num_cust_pay_pending {
7820 my $sql = " SELECT COUNT(*) FROM cust_pay_pending ".
7821 " WHERE custnum = ? AND status != 'done' ";
7822 my $sth = dbh->prepare($sql) or die dbh->errstr;
7823 $sth->execute($self->custnum) or die $sth->errstr;
7824 $sth->fetchrow_arrayref->[0];
7829 Returns all the refunds (see L<FS::cust_refund>) for this customer.
7835 map { $_ } #return $self->num_cust_refund unless wantarray;
7836 sort { $a->_date <=> $b->_date }
7837 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
7840 =item display_custnum
7842 Returns the displayed customer number for this customer: agent_custid if
7843 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
7847 sub display_custnum {
7849 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
7850 return $self->agent_custid;
7852 return $self->custnum;
7858 Returns a name string for this customer, either "Company (Last, First)" or
7865 my $name = $self->contact;
7866 $name = $self->company. " ($name)" if $self->company;
7872 Returns a name string for this (service/shipping) contact, either
7873 "Company (Last, First)" or "Last, First".
7879 if ( $self->get('ship_last') ) {
7880 my $name = $self->ship_contact;
7881 $name = $self->ship_company. " ($name)" if $self->ship_company;
7890 Returns a name string for this customer, either "Company" or "First Last".
7896 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
7899 =item ship_name_short
7901 Returns a name string for this (service/shipping) contact, either "Company"
7906 sub ship_name_short {
7908 if ( $self->get('ship_last') ) {
7909 $self->ship_company !~ /^\s*$/
7910 ? $self->ship_company
7911 : $self->ship_contact_firstlast;
7913 $self->name_company_or_firstlast;
7919 Returns this customer's full (billing) contact name only, "Last, First"
7925 $self->get('last'). ', '. $self->first;
7930 Returns this customer's full (shipping) contact name only, "Last, First"
7936 $self->get('ship_last')
7937 ? $self->get('ship_last'). ', '. $self->ship_first
7941 =item contact_firstlast
7943 Returns this customers full (billing) contact name only, "First Last".
7947 sub contact_firstlast {
7949 $self->first. ' '. $self->get('last');
7952 =item ship_contact_firstlast
7954 Returns this customer's full (shipping) contact name only, "First Last".
7958 sub ship_contact_firstlast {
7960 $self->get('ship_last')
7961 ? $self->first. ' '. $self->get('ship_last')
7962 : $self->contact_firstlast;
7967 Returns this customer's full country name
7973 code2country($self->country);
7976 =item geocode DATA_VENDOR
7978 Returns a value for the customer location as encoded by DATA_VENDOR.
7979 Currently this only makes sense for "CCH" as DATA_VENDOR.
7984 my ($self, $data_vendor) = (shift, shift); #always cch for now
7986 my $geocode = $self->get('geocode'); #XXX only one data_vendor for geocode
7987 return $geocode if $geocode;
7989 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
7993 my($zip,$plus4) = split /-/, $self->get("${prefix}zip")
7994 if $self->country eq 'US';
7998 #CCH specific location stuff
7999 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
8001 my @cust_tax_location =
8003 'table' => 'cust_tax_location',
8004 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
8005 'extra_sql' => $extra_sql,
8006 'order_by' => 'ORDER BY plus4hi',#overlapping with distinct ends
8009 $geocode = $cust_tax_location[0]->geocode
8010 if scalar(@cust_tax_location);
8019 Returns a status string for this customer, currently:
8023 =item prospect - No packages have ever been ordered
8025 =item active - One or more recurring packages is active
8027 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
8029 =item suspended - All non-cancelled recurring packages are suspended
8031 =item cancelled - All recurring packages are cancelled
8037 sub status { shift->cust_status(@_); }
8041 for my $status (qw( prospect active inactive suspended cancelled )) {
8042 my $method = $status.'_sql';
8043 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
8044 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
8045 $sth->execute( ($self->custnum) x $numnum )
8046 or die "Error executing 'SELECT $sql': ". $sth->errstr;
8047 return $status if $sth->fetchrow_arrayref->[0];
8051 =item ucfirst_cust_status
8053 =item ucfirst_status
8055 Returns the status with the first character capitalized.
8059 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
8061 sub ucfirst_cust_status {
8063 ucfirst($self->cust_status);
8068 Returns a hex triplet color string for this customer's status.
8072 use vars qw(%statuscolor);
8073 tie %statuscolor, 'Tie::IxHash',
8074 'prospect' => '7e0079', #'000000', #black? naw, purple
8075 'active' => '00CC00', #green
8076 'inactive' => '0000CC', #blue
8077 'suspended' => 'FF9900', #yellow
8078 'cancelled' => 'FF0000', #red
8081 sub statuscolor { shift->cust_statuscolor(@_); }
8083 sub cust_statuscolor {
8085 $statuscolor{$self->cust_status};
8090 Returns an array of hashes representing the customer's RT tickets.
8097 my $num = $conf->config('cust_main-max_tickets') || 10;
8100 if ( $conf->config('ticket_system') ) {
8101 unless ( $conf->config('ticket_system-custom_priority_field') ) {
8103 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
8107 foreach my $priority (
8108 $conf->config('ticket_system-custom_priority_field-values'), ''
8110 last if scalar(@tickets) >= $num;
8112 @{ FS::TicketSystem->customer_tickets( $self->custnum,
8113 $num - scalar(@tickets),
8123 # Return services representing svc_accts in customer support packages
8124 sub support_services {
8126 my %packages = map { $_ => 1 } $conf->config('support_packages');
8128 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
8129 grep { $_->part_svc->svcdb eq 'svc_acct' }
8130 map { $_->cust_svc }
8131 grep { exists $packages{ $_->pkgpart } }
8132 $self->ncancelled_pkgs;
8136 # Return a list of latitude/longitude for one of the services (if any)
8137 sub service_coordinates {
8141 grep { $_->latitude && $_->longitude }
8143 map { $_->cust_svc }
8144 $self->ncancelled_pkgs;
8146 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
8151 =head1 CLASS METHODS
8157 Class method that returns the list of possible status strings for customers
8158 (see L<the status method|/status>). For example:
8160 @statuses = FS::cust_main->statuses();
8165 #my $self = shift; #could be class...
8171 Returns an SQL expression identifying prospective cust_main records (customers
8172 with no packages ever ordered)
8176 use vars qw($select_count_pkgs);
8177 $select_count_pkgs =
8178 "SELECT COUNT(*) FROM cust_pkg
8179 WHERE cust_pkg.custnum = cust_main.custnum";
8181 sub select_count_pkgs_sql {
8185 sub prospect_sql { "
8186 0 = ( $select_count_pkgs )
8191 Returns an SQL expression identifying active cust_main records (customers with
8192 active recurring packages).
8197 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
8203 Returns an SQL expression identifying inactive cust_main records (customers with
8204 no active recurring packages, but otherwise unsuspended/uncancelled).
8208 sub inactive_sql { "
8209 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
8211 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
8217 Returns an SQL expression identifying suspended cust_main records.
8222 sub suspended_sql { susp_sql(@_); }
8224 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
8226 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
8232 Returns an SQL expression identifying cancelled cust_main records.
8236 sub cancelled_sql { cancel_sql(@_); }
8239 my $recurring_sql = FS::cust_pkg->recurring_sql;
8240 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
8243 0 < ( $select_count_pkgs )
8244 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
8245 AND 0 = ( $select_count_pkgs AND $recurring_sql
8246 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
8248 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
8254 =item uncancelled_sql
8256 Returns an SQL expression identifying un-cancelled cust_main records.
8260 sub uncancelled_sql { uncancel_sql(@_); }
8261 sub uncancel_sql { "
8262 ( 0 < ( $select_count_pkgs
8263 AND ( cust_pkg.cancel IS NULL
8264 OR cust_pkg.cancel = 0
8267 OR 0 = ( $select_count_pkgs )
8273 Returns an SQL fragment to retreive the balance.
8278 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
8279 WHERE cust_bill.custnum = cust_main.custnum )
8280 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
8281 WHERE cust_pay.custnum = cust_main.custnum )
8282 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
8283 WHERE cust_credit.custnum = cust_main.custnum )
8284 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
8285 WHERE cust_refund.custnum = cust_main.custnum )
8288 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8290 Returns an SQL fragment to retreive the balance for this customer, only
8291 considering invoices with date earlier than START_TIME, and optionally not
8292 later than END_TIME (total_owed_date minus total_unapplied_credits minus
8293 total_unapplied_payments).
8295 Times are specified as SQL fragments or numeric
8296 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
8297 L<Date::Parse> for conversion functions. The empty string can be passed
8298 to disable that time constraint completely.
8300 Available options are:
8304 =item unapplied_date
8306 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)
8311 set to true to remove all customer comparison clauses, for totals
8316 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
8321 JOIN clause (typically used with the total option)
8327 sub balance_date_sql {
8328 my( $class, $start, $end, %opt ) = @_;
8330 my $owed = FS::cust_bill->owed_sql;
8331 my $unapp_refund = FS::cust_refund->unapplied_sql;
8332 my $unapp_credit = FS::cust_credit->unapplied_sql;
8333 my $unapp_pay = FS::cust_pay->unapplied_sql;
8335 my $j = $opt{'join'} || '';
8337 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
8338 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
8339 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
8340 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
8342 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
8343 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
8344 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
8345 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
8350 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
8352 Returns an SQL fragment to retreive the total unapplied payments for this
8353 customer, only considering invoices with date earlier than START_TIME, and
8354 optionally not later than END_TIME.
8356 Times are specified as SQL fragments or numeric
8357 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
8358 L<Date::Parse> for conversion functions. The empty string can be passed
8359 to disable that time constraint completely.
8361 Available options are:
8365 sub unapplied_payments_date_sql {
8366 my( $class, $start, $end, ) = @_;
8368 my $unapp_pay = FS::cust_pay->unapplied_sql;
8370 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
8371 'unapplied_date'=>1 );
8373 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
8376 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8378 Helper method for balance_date_sql; name (and usage) subject to change
8379 (suggestions welcome).
8381 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
8382 cust_refund, cust_credit or cust_pay).
8384 If TABLE is "cust_bill" or the unapplied_date option is true, only
8385 considers records with date earlier than START_TIME, and optionally not
8386 later than END_TIME .
8390 sub _money_table_where {
8391 my( $class, $table, $start, $end, %opt ) = @_;
8394 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
8395 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
8396 push @where, "$table._date <= $start" if defined($start) && length($start);
8397 push @where, "$table._date > $end" if defined($end) && length($end);
8399 push @where, @{$opt{'where'}} if $opt{'where'};
8400 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
8406 =item search HASHREF
8410 Returns a qsearch hash expression to search for parameters specified in
8411 HASHREF. Valid parameters are
8419 =item cancelled_pkgs
8425 listref of start date, end date
8435 =item current_balance
8437 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
8441 =item flattened_pkgs
8450 my ($class, $params) = @_;
8461 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
8463 "cust_main.agentnum = $1";
8470 #prospect active inactive suspended cancelled
8471 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
8472 my $method = $params->{'status'}. '_sql';
8473 #push @where, $class->$method();
8474 push @where, FS::cust_main->$method();
8478 # parse cancelled package checkbox
8483 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
8484 unless $params->{'cancelled_pkgs'};
8487 # parse without census tract checkbox
8490 push @where, "(censustract = '' or censustract is null)"
8491 if $params->{'no_censustract'};
8497 foreach my $field (qw( signupdate )) {
8499 next unless exists($params->{$field});
8501 my($beginning, $ending) = @{$params->{$field}};
8504 "cust_main.$field IS NOT NULL",
8505 "cust_main.$field >= $beginning",
8506 "cust_main.$field <= $ending";
8508 $orderby ||= "ORDER BY cust_main.$field";
8516 if ( $params->{'classnum'} ) {
8518 my @classnum = ref( $params->{'classnum'} )
8519 ? @{ $params->{'classnum'} }
8520 : ( $params->{'classnum'} );
8522 @classnum = grep /^(\d*)$/, @classnum;
8525 push @where, '( '. join(' OR ', map {
8526 $_ ? "cust_main.classnum = $_"
8527 : "cust_main.classnum IS NULL"
8540 if ( $params->{'payby'} ) {
8542 my @payby = ref( $params->{'payby'} )
8543 ? @{ $params->{'payby'} }
8544 : ( $params->{'payby'} );
8546 @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
8548 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )'
8554 # paydate_year / paydate_month
8557 if ( $params->{'paydate_year'} =~ /^(\d{4})$/ ) {
8559 $params->{'paydate_month'} =~ /^(\d\d?)$/
8560 or die "paydate_year without paydate_month?";
8564 'paydate IS NOT NULL',
8566 "CAST(paydate AS timestamp) < CAST('$year-$month-01' AS timestamp )"
8574 if ( $params->{'invoice_terms'} =~ /^([\w ]+)$/ ) {
8576 if ( $1 eq 'NULL' ) {
8578 "( cust_main.invoice_terms IS NULL OR cust_main.invoice_terms = '' )";
8581 "cust_main.invoice_terms IS NOT NULL",
8582 "cust_main.invoice_terms = '$1'";
8590 if ( $params->{'current_balance'} ) {
8592 #my $balance_sql = $class->balance_sql();
8593 my $balance_sql = FS::cust_main->balance_sql();
8595 my @current_balance =
8596 ref( $params->{'current_balance'} )
8597 ? @{ $params->{'current_balance'} }
8598 : ( $params->{'current_balance'} );
8600 push @where, map { s/current_balance/$balance_sql/; $_ }
8609 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
8611 "cust_main.custbatch = '$1'";
8615 # setup queries, subs, etc. for the search
8618 $orderby ||= 'ORDER BY custnum';
8620 # here is the agent virtualization
8621 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
8623 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
8625 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
8627 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
8629 my $select = join(', ',
8630 'cust_main.custnum',
8631 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
8634 my(@extra_headers) = ();
8635 my(@extra_fields) = ();
8637 if ($params->{'flattened_pkgs'}) {
8639 if ($dbh->{Driver}->{Name} eq 'Pg') {
8641 $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";
8643 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
8644 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
8645 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
8647 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
8648 "omitting packing information from report.";
8651 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";
8653 my $sth = dbh->prepare($header_query) or die dbh->errstr;
8654 $sth->execute() or die $sth->errstr;
8655 my $headerrow = $sth->fetchrow_arrayref;
8656 my $headercount = $headerrow ? $headerrow->[0] : 0;
8657 while($headercount) {
8658 unshift @extra_headers, "Package ". $headercount;
8659 unshift @extra_fields, eval q!sub {my $c = shift;
8660 my @a = split '\|', $c->magic;
8661 my $p = $a[!.--$headercount. q!];
8669 'table' => 'cust_main',
8670 'select' => $select,
8672 'extra_sql' => $extra_sql,
8673 'order_by' => $orderby,
8674 'count_query' => $count_query,
8675 'extra_headers' => \@extra_headers,
8676 'extra_fields' => \@extra_fields,
8681 =item email_search_result HASHREF
8685 Emails a notice to the specified customers.
8687 Valid parameters are those of the L<search> method, plus the following:
8709 Optional job queue job for status updates.
8713 Returns an error message, or false for success.
8715 If an error occurs during any email, stops the enture send and returns that
8716 error. Presumably if you're getting SMTP errors aborting is better than
8717 retrying everything.
8721 sub email_search_result {
8722 my($class, $params) = @_;
8724 my $from = delete $params->{from};
8725 my $subject = delete $params->{subject};
8726 my $html_body = delete $params->{html_body};
8727 my $text_body = delete $params->{text_body};
8729 my $job = delete $params->{'job'};
8731 $params->{'payby'} = [ split(/\0/, $params->{'payby'}) ]
8732 unless ref($params->{'payby'});
8734 my $sql_query = $class->search($params);
8736 my $count_query = delete($sql_query->{'count_query'});
8737 my $count_sth = dbh->prepare($count_query)
8738 or die "Error preparing $count_query: ". dbh->errstr;
8740 or die "Error executing $count_query: ". $count_sth->errstr;
8741 my $count_arrayref = $count_sth->fetchrow_arrayref;
8742 my $num_cust = $count_arrayref->[0];
8744 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
8745 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
8748 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
8750 #eventually order+limit magic to reduce memory use?
8751 foreach my $cust_main ( qsearch($sql_query) ) {
8753 my $to = $cust_main->invoicing_list_emailonly_scalar;
8756 my $error = send_email(
8760 'subject' => $subject,
8761 'html_body' => $html_body,
8762 'text_body' => $text_body,
8765 return $error if $error;
8767 if ( $job ) { #progressbar foo
8769 if ( time - $min_sec > $last ) {
8770 my $error = $job->update_statustext(
8771 int( 100 * $num / $num_cust )
8773 die $error if $error;
8783 use Storable qw(thaw);
8786 sub process_email_search_result {
8788 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
8790 my $param = thaw(decode_base64(shift));
8791 warn Dumper($param) if $DEBUG;
8793 $param->{'job'} = $job;
8795 $param->{'payby'} = [ split(/\0/, $param->{'payby'}) ]
8796 unless ref($param->{'payby'});
8798 my $error = FS::cust_main->email_search_result( $param );
8799 die $error if $error;
8803 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
8805 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
8806 records. Currently, I<first>, I<last>, I<company> and/or I<address1> may be
8807 specified (the appropriate ship_ field is also searched).
8809 Additional options are the same as FS::Record::qsearch
8814 my( $self, $fuzzy, $hash, @opt) = @_;
8819 check_and_rebuild_fuzzyfiles();
8820 foreach my $field ( keys %$fuzzy ) {
8822 my $all = $self->all_X($field);
8823 next unless scalar(@$all);
8826 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
8829 foreach ( keys %match ) {
8830 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
8831 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
8834 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
8837 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
8839 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
8847 Returns a masked version of the named field
8852 my ($self,$field) = @_;
8856 'x'x(length($self->getfield($field))-4).
8857 substr($self->getfield($field), (length($self->getfield($field))-4));
8867 =item smart_search OPTION => VALUE ...
8869 Accepts the following options: I<search>, the string to search for. The string
8870 will be searched for as a customer number, phone number, name or company name,
8871 as an exact, or, in some cases, a substring or fuzzy match (see the source code
8872 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
8873 skip fuzzy matching when an exact match is found.
8875 Any additional options are treated as an additional qualifier on the search
8878 Returns a (possibly empty) array of FS::cust_main objects.
8885 #here is the agent virtualization
8886 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8890 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
8891 my $search = delete $options{'search'};
8892 ( my $alphanum_search = $search ) =~ s/\W//g;
8894 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
8896 #false laziness w/Record::ut_phone
8897 my $phonen = "$1-$2-$3";
8898 $phonen .= " x$4" if $4;
8900 push @cust_main, qsearch( {
8901 'table' => 'cust_main',
8902 'hashref' => { %options },
8903 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8905 join(' OR ', map "$_ = '$phonen'",
8906 qw( daytime night fax
8907 ship_daytime ship_night ship_fax )
8910 " AND $agentnums_sql", #agent virtualization
8913 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
8914 #try looking for matches with extensions unless one was specified
8916 push @cust_main, qsearch( {
8917 'table' => 'cust_main',
8918 'hashref' => { %options },
8919 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8921 join(' OR ', map "$_ LIKE '$phonen\%'",
8923 ship_daytime ship_night )
8926 " AND $agentnums_sql", #agent virtualization
8931 # custnum search (also try agent_custid), with some tweaking options if your
8932 # legacy cust "numbers" have letters
8935 if ( $search =~ /^\s*(\d+)\s*$/
8936 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
8937 && $search =~ /^\s*(\w\w?\d+)\s*$/
8939 || ( $conf->exists('address1-search' )
8940 && $search =~ /^\s*(\d+\-?\w*)\s*$/ #i.e. 1234A or 9432-D
8947 if ( $num =~ /^(\d+)$/ && $num <= 2147483647 ) { #need a bigint custnum? wow
8948 push @cust_main, qsearch( {
8949 'table' => 'cust_main',
8950 'hashref' => { 'custnum' => $num, %options },
8951 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8955 push @cust_main, qsearch( {
8956 'table' => 'cust_main',
8957 'hashref' => { 'agent_custid' => $num, %options },
8958 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8961 if ( $conf->exists('address1-search') ) {
8962 my $len = length($num);
8964 foreach my $prefix ( '', 'ship_' ) {
8965 push @cust_main, qsearch( {
8966 'table' => 'cust_main',
8967 'hashref' => { %options, },
8969 ( keys(%options) ? ' AND ' : ' WHERE ' ).
8970 " LOWER(SUBSTRING(${prefix}address1 FROM 1 FOR $len)) = '$num' ".
8971 " AND $agentnums_sql",
8976 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
8978 my($company, $last, $first) = ( $1, $2, $3 );
8980 # "Company (Last, First)"
8981 #this is probably something a browser remembered,
8982 #so just do an exact search (but case-insensitive, so USPS standardization
8983 #doesn't throw a wrench in the works)
8985 foreach my $prefix ( '', 'ship_' ) {
8986 push @cust_main, qsearch( {
8987 'table' => 'cust_main',
8988 'hashref' => { %options },
8990 ( keys(%options) ? ' AND ' : ' WHERE ' ).
8992 " LOWER(${prefix}first) = ". dbh->quote(lc($first)),
8993 " LOWER(${prefix}last) = ". dbh->quote(lc($last)),
8994 " LOWER(${prefix}company) = ". dbh->quote(lc($company)),
9000 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
9001 # try (ship_){last,company}
9005 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
9006 # # full strings the browser remembers won't work
9007 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
9009 use Lingua::EN::NameParse;
9010 my $NameParse = new Lingua::EN::NameParse(
9012 allow_reversed => 1,
9015 my($last, $first) = ( '', '' );
9016 #maybe disable this too and just rely on NameParse?
9017 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
9019 ($last, $first) = ( $1, $2 );
9021 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
9022 } elsif ( ! $NameParse->parse($value) ) {
9024 my %name = $NameParse->components;
9025 $first = $name{'given_name_1'};
9026 $last = $name{'surname_1'};
9030 if ( $first && $last ) {
9032 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
9035 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
9037 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
9038 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
9041 push @cust_main, qsearch( {
9042 'table' => 'cust_main',
9043 'hashref' => \%options,
9044 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
9047 # or it just be something that was typed in... (try that in a sec)
9051 my $q_value = dbh->quote($value);
9054 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
9055 $sql .= " ( LOWER(last) = $q_value
9056 OR LOWER(company) = $q_value
9057 OR LOWER(ship_last) = $q_value
9058 OR LOWER(ship_company) = $q_value
9060 $sql .= " OR LOWER(address1) = $q_value
9061 OR LOWER(ship_address1) = $q_value
9063 if $conf->exists('address1-search');
9066 push @cust_main, qsearch( {
9067 'table' => 'cust_main',
9068 'hashref' => \%options,
9069 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
9072 #no exact match, trying substring/fuzzy
9073 #always do substring & fuzzy (unless they're explicity config'ed off)
9074 #getting complaints searches are not returning enough
9075 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
9077 #still some false laziness w/search (was search/cust_main.cgi)
9082 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
9083 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
9086 if ( $first && $last ) {
9089 { 'first' => { op=>'ILIKE', value=>"%$first%" },
9090 'last' => { op=>'ILIKE', value=>"%$last%" },
9092 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
9093 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
9100 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
9101 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
9105 if ( $conf->exists('address1-search') ) {
9107 { 'address1' => { op=>'ILIKE', value=>"%$value%" }, },
9108 { 'ship_address1' => { op=>'ILIKE', value=>"%$value%" }, },
9112 foreach my $hashref ( @hashrefs ) {
9114 push @cust_main, qsearch( {
9115 'table' => 'cust_main',
9116 'hashref' => { %$hashref,
9119 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
9128 " AND $agentnums_sql", #extra_sql #agent virtualization
9131 if ( $first && $last ) {
9132 push @cust_main, FS::cust_main->fuzzy_search(
9133 { 'last' => $last, #fuzzy hashref
9134 'first' => $first }, #
9138 foreach my $field ( 'last', 'company' ) {
9140 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
9142 if ( $conf->exists('address1-search') ) {
9144 FS::cust_main->fuzzy_search( { 'address1' => $value }, @fuzopts );
9151 #eliminate duplicates
9153 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
9161 Accepts the following options: I<email>, the email address to search for. The
9162 email address will be searched for as an email invoice destination and as an
9165 #Any additional options are treated as an additional qualifier on the search
9166 #(i.e. I<agentnum>).
9168 Returns a (possibly empty) array of FS::cust_main objects (but usually just
9178 my $email = delete $options{'email'};
9180 #we're only being used by RT at the moment... no agent virtualization yet
9181 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
9185 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
9187 my ( $user, $domain ) = ( $1, $2 );
9189 warn "$me smart_search: searching for $user in domain $domain"
9195 'table' => 'cust_main_invoice',
9196 'hashref' => { 'dest' => $email },
9203 map $_->cust_svc->cust_pkg,
9205 'table' => 'svc_acct',
9206 'hashref' => { 'username' => $user, },
9208 'AND ( SELECT domain FROM svc_domain
9209 WHERE svc_acct.domsvc = svc_domain.svcnum
9210 ) = '. dbh->quote($domain),
9216 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
9218 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
9225 =item check_and_rebuild_fuzzyfiles
9229 sub check_and_rebuild_fuzzyfiles {
9230 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9231 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
9234 =item rebuild_fuzzyfiles
9238 sub rebuild_fuzzyfiles {
9240 use Fcntl qw(:flock);
9242 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9243 mkdir $dir, 0700 unless -d $dir;
9245 foreach my $fuzzy ( @fuzzyfields ) {
9247 open(LOCK,">>$dir/cust_main.$fuzzy")
9248 or die "can't open $dir/cust_main.$fuzzy: $!";
9250 or die "can't lock $dir/cust_main.$fuzzy: $!";
9252 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
9253 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
9255 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
9256 my $sth = dbh->prepare("SELECT $field FROM cust_main".
9257 " WHERE $field != '' AND $field IS NOT NULL");
9258 $sth->execute or die $sth->errstr;
9260 while ( my $row = $sth->fetchrow_arrayref ) {
9261 print CACHE $row->[0]. "\n";
9266 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
9268 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
9279 my( $self, $field ) = @_;
9280 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9281 open(CACHE,"<$dir/cust_main.$field")
9282 or die "can't open $dir/cust_main.$field: $!";
9283 my @array = map { chomp; $_; } <CACHE>;
9288 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
9292 sub append_fuzzyfiles {
9293 #my( $first, $last, $company ) = @_;
9295 &check_and_rebuild_fuzzyfiles;
9297 use Fcntl qw(:flock);
9299 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9301 foreach my $field (@fuzzyfields) {
9306 open(CACHE,">>$dir/cust_main.$field")
9307 or die "can't open $dir/cust_main.$field: $!";
9308 flock(CACHE,LOCK_EX)
9309 or die "can't lock $dir/cust_main.$field: $!";
9311 print CACHE "$value\n";
9313 flock(CACHE,LOCK_UN)
9314 or die "can't unlock $dir/cust_main.$field: $!";
9329 #warn join('-',keys %$param);
9330 my $fh = $param->{filehandle};
9331 my @fields = @{$param->{fields}};
9333 eval "use Text::CSV_XS;";
9336 my $csv = new Text::CSV_XS;
9343 local $SIG{HUP} = 'IGNORE';
9344 local $SIG{INT} = 'IGNORE';
9345 local $SIG{QUIT} = 'IGNORE';
9346 local $SIG{TERM} = 'IGNORE';
9347 local $SIG{TSTP} = 'IGNORE';
9348 local $SIG{PIPE} = 'IGNORE';
9350 my $oldAutoCommit = $FS::UID::AutoCommit;
9351 local $FS::UID::AutoCommit = 0;
9354 #while ( $columns = $csv->getline($fh) ) {
9356 while ( defined($line=<$fh>) ) {
9358 $csv->parse($line) or do {
9359 $dbh->rollback if $oldAutoCommit;
9360 return "can't parse: ". $csv->error_input();
9363 my @columns = $csv->fields();
9364 #warn join('-',@columns);
9367 foreach my $field ( @fields ) {
9368 $row{$field} = shift @columns;
9371 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
9372 unless ( $cust_main ) {
9373 $dbh->rollback if $oldAutoCommit;
9374 return "unknown custnum $row{'custnum'}";
9377 if ( $row{'amount'} > 0 ) {
9378 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
9380 $dbh->rollback if $oldAutoCommit;
9384 } elsif ( $row{'amount'} < 0 ) {
9385 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
9388 $dbh->rollback if $oldAutoCommit;
9398 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
9400 return "Empty file!" unless $imported;
9406 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9408 Sends a templated email notification to the customer (see L<Text::Template>).
9410 OPTIONS is a hash and may include
9412 I<from> - the email sender (default is invoice_from)
9414 I<to> - comma-separated scalar or arrayref of recipients
9415 (default is invoicing_list)
9417 I<subject> - The subject line of the sent email notification
9418 (default is "Notice from company_name")
9420 I<extra_fields> - a hashref of name/value pairs which will be substituted
9423 The following variables are vavailable in the template.
9425 I<$first> - the customer first name
9426 I<$last> - the customer last name
9427 I<$company> - the customer company
9428 I<$payby> - a description of the method of payment for the customer
9429 # would be nice to use FS::payby::shortname
9430 I<$payinfo> - the account information used to collect for this customer
9431 I<$expdate> - the expiration of the customer payment in seconds from epoch
9436 my ($self, $template, %options) = @_;
9438 return unless $conf->exists($template);
9440 my $from = $conf->config('invoice_from', $self->agentnum)
9441 if $conf->exists('invoice_from', $self->agentnum);
9442 $from = $options{from} if exists($options{from});
9444 my $to = join(',', $self->invoicing_list_emailonly);
9445 $to = $options{to} if exists($options{to});
9447 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
9448 if $conf->exists('company_name', $self->agentnum);
9449 $subject = $options{subject} if exists($options{subject});
9451 my $notify_template = new Text::Template (TYPE => 'ARRAY',
9452 SOURCE => [ map "$_\n",
9453 $conf->config($template)]
9455 or die "can't create new Text::Template object: Text::Template::ERROR";
9456 $notify_template->compile()
9457 or die "can't compile template: Text::Template::ERROR";
9459 $FS::notify_template::_template::company_name =
9460 $conf->config('company_name', $self->agentnum);
9461 $FS::notify_template::_template::company_address =
9462 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
9464 my $paydate = $self->paydate || '2037-12-31';
9465 $FS::notify_template::_template::first = $self->first;
9466 $FS::notify_template::_template::last = $self->last;
9467 $FS::notify_template::_template::company = $self->company;
9468 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
9469 my $payby = $self->payby;
9470 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9471 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9473 #credit cards expire at the end of the month/year of their exp date
9474 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9475 $FS::notify_template::_template::payby = 'credit card';
9476 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9477 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9479 }elsif ($payby eq 'COMP') {
9480 $FS::notify_template::_template::payby = 'complimentary account';
9482 $FS::notify_template::_template::payby = 'current method';
9484 $FS::notify_template::_template::expdate = $expire_time;
9486 for (keys %{$options{extra_fields}}){
9488 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
9491 send_email(from => $from,
9493 subject => $subject,
9494 body => $notify_template->fill_in( PACKAGE =>
9495 'FS::notify_template::_template' ),
9500 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9502 Generates a templated notification to the customer (see L<Text::Template>).
9504 OPTIONS is a hash and may include
9506 I<extra_fields> - a hashref of name/value pairs which will be substituted
9507 into the template. These values may override values mentioned below
9508 and those from the customer record.
9510 The following variables are available in the template instead of or in addition
9511 to the fields of the customer record.
9513 I<$payby> - a description of the method of payment for the customer
9514 # would be nice to use FS::payby::shortname
9515 I<$payinfo> - the masked account information used to collect for this customer
9516 I<$expdate> - the expiration of the customer payment method in seconds from epoch
9517 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
9521 sub generate_letter {
9522 my ($self, $template, %options) = @_;
9524 return unless $conf->exists($template);
9526 my $letter_template = new Text::Template
9528 SOURCE => [ map "$_\n", $conf->config($template)],
9529 DELIMITERS => [ '[@--', '--@]' ],
9531 or die "can't create new Text::Template object: Text::Template::ERROR";
9533 $letter_template->compile()
9534 or die "can't compile template: Text::Template::ERROR";
9536 my %letter_data = map { $_ => $self->$_ } $self->fields;
9537 $letter_data{payinfo} = $self->mask_payinfo;
9539 #my $paydate = $self->paydate || '2037-12-31';
9540 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
9542 my $payby = $self->payby;
9543 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9544 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9546 #credit cards expire at the end of the month/year of their exp date
9547 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9548 $letter_data{payby} = 'credit card';
9549 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9550 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9552 }elsif ($payby eq 'COMP') {
9553 $letter_data{payby} = 'complimentary account';
9555 $letter_data{payby} = 'current method';
9557 $letter_data{expdate} = $expire_time;
9559 for (keys %{$options{extra_fields}}){
9560 $letter_data{$_} = $options{extra_fields}->{$_};
9563 unless(exists($letter_data{returnaddress})){
9564 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
9565 $self->agent_template)
9567 if ( length($retadd) ) {
9568 $letter_data{returnaddress} = $retadd;
9569 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
9570 $letter_data{returnaddress} =
9571 join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
9572 $conf->config('company_address', $self->agentnum)
9575 $letter_data{returnaddress} = '~';
9579 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
9581 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
9583 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
9584 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
9588 ) or die "can't open temp file: $!\n";
9590 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
9592 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
9596 =item print_ps TEMPLATE
9598 Returns an postscript letter filled in from TEMPLATE, as a scalar.
9604 my $file = $self->generate_letter(@_);
9605 FS::Misc::generate_ps($file);
9608 =item print TEMPLATE
9610 Prints the filled in template.
9612 TEMPLATE is the name of a L<Text::Template> to fill in and print.
9616 sub queueable_print {
9619 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
9620 or die "invalid customer number: " . $opt{custvnum};
9622 my $error = $self->print( $opt{template} );
9623 die $error if $error;
9627 my ($self, $template) = (shift, shift);
9628 do_print [ $self->print_ps($template) ];
9631 #these three subs should just go away once agent stuff is all config overrides
9633 sub agent_template {
9635 $self->_agent_plandata('agent_templatename');
9638 sub agent_invoice_from {
9640 $self->_agent_plandata('agent_invoice_from');
9643 sub _agent_plandata {
9644 my( $self, $option ) = @_;
9646 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
9647 #agent-specific Conf
9649 use FS::part_event::Condition;
9651 my $agentnum = $self->agentnum;
9654 if ( driver_name =~ /^Pg/i ) {
9656 } elsif ( driver_name =~ /^mysql/i ) {
9659 die "don't know how to use regular expressions in ". driver_name. " databases";
9662 my $part_event_option =
9664 'select' => 'part_event_option.*',
9665 'table' => 'part_event_option',
9667 LEFT JOIN part_event USING ( eventpart )
9668 LEFT JOIN part_event_option AS peo_agentnum
9669 ON ( part_event.eventpart = peo_agentnum.eventpart
9670 AND peo_agentnum.optionname = 'agentnum'
9671 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
9673 LEFT JOIN part_event_condition
9674 ON ( part_event.eventpart = part_event_condition.eventpart
9675 AND part_event_condition.conditionname = 'cust_bill_age'
9677 LEFT JOIN part_event_condition_option
9678 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
9679 AND part_event_condition_option.optionname = 'age'
9682 #'hashref' => { 'optionname' => $option },
9683 #'hashref' => { 'part_event_option.optionname' => $option },
9685 " WHERE part_event_option.optionname = ". dbh->quote($option).
9686 " AND action = 'cust_bill_send_agent' ".
9687 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
9688 " AND peo_agentnum.optionname = 'agentnum' ".
9689 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
9691 CASE WHEN part_event_condition_option.optionname IS NULL
9693 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
9695 , part_event.weight".
9699 unless ( $part_event_option ) {
9700 return $self->agent->invoice_template || ''
9701 if $option eq 'agent_templatename';
9705 $part_event_option->optionvalue;
9710 ## actual sub, not a method, designed to be called from the queue.
9711 ## sets up the customer, and calls the bill_and_collect
9712 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
9713 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
9714 $cust_main->bill_and_collect(
9719 sub _upgrade_data { #class method
9720 my ($class, %opts) = @_;
9722 my $sql = 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL';
9723 my $sth = dbh->prepare($sql) or die dbh->errstr;
9724 $sth->execute or die $sth->errstr;
9734 The delete method should possibly take an FS::cust_main object reference
9735 instead of a scalar customer number.
9737 Bill and collect options should probably be passed as references instead of a
9740 There should probably be a configuration file with a list of allowed credit
9743 No multiple currency support (probably a larger project than just this module).
9745 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
9747 Birthdates rely on negative epoch values.
9749 The payby for card/check batches is broken. With mixed batching, bad
9752 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
9756 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
9757 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
9758 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.