5 #FS::cust_main:_Marketgear when they're ready to move to 2.1
6 use base qw( FS::cust_main::Packages FS::cust_main::Status
7 FS::cust_main::Billing FS::cust_main::Billing_Realtime
8 FS::cust_main::Billing_Discount
9 FS::otaker_Mixin FS::payinfo_Mixin FS::cust_main_Mixin
14 use vars qw( $DEBUG $me $conf
17 $ignore_expired_card $ignore_illegal_zip $ignore_banned_card
22 use Scalar::Util qw( blessed );
23 use Time::Local qw(timelocal);
24 use Storable qw(thaw);
28 use Digest::MD5 qw(md5_base64);
31 use File::Temp; #qw( tempfile );
32 use Business::CreditCard 0.28;
34 use FS::UID qw( getotaker dbh driver_name );
35 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
36 use FS::Misc qw( generate_email send_email generate_ps do_print );
37 use FS::Msgcat qw(gettext);
44 use FS::legacy_cust_bill;
46 use FS::cust_pay_pending;
47 use FS::cust_pay_void;
48 use FS::cust_pay_batch;
51 use FS::part_referral;
52 use FS::cust_main_county;
53 use FS::cust_location;
55 use FS::cust_main_exemption;
56 use FS::cust_tax_adjustment;
57 use FS::cust_tax_location;
59 use FS::cust_main_invoice;
61 use FS::prepay_credit;
67 use FS::payment_gateway;
68 use FS::agent_payment_gateway;
70 use FS::cust_main_note;
71 use FS::cust_attachment;
75 # 1 is mostly method/subroutine entry and options
76 # 2 traces progress of some operations
77 # 3 is even more information including possibly sensitive data
79 $me = '[FS::cust_main]';
82 $ignore_expired_card = 0;
83 $ignore_illegal_zip = 0;
84 $ignore_banned_card = 0;
88 @encrypted_fields = ('payinfo', 'paycvv');
89 sub nohistory_fields { ('payinfo', 'paycvv'); }
91 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
93 #ask FS::UID to run this stuff for us later
94 #$FS::UID::callback{'FS::cust_main'} = sub {
95 install_callback FS::UID sub {
97 #yes, need it for stuff below (prolly should be cached)
102 my ( $hashref, $cache ) = @_;
103 if ( exists $hashref->{'pkgnum'} ) {
104 #@{ $self->{'_pkgnum'} } = ();
105 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
106 $self->{'_pkgnum'} = $subcache;
107 #push @{ $self->{'_pkgnum'} },
108 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
114 FS::cust_main - Object methods for cust_main records
120 $record = new FS::cust_main \%hash;
121 $record = new FS::cust_main { 'column' => 'value' };
123 $error = $record->insert;
125 $error = $new_record->replace($old_record);
127 $error = $record->delete;
129 $error = $record->check;
131 @cust_pkg = $record->all_pkgs;
133 @cust_pkg = $record->ncancelled_pkgs;
135 @cust_pkg = $record->suspended_pkgs;
137 $error = $record->bill;
138 $error = $record->bill %options;
139 $error = $record->bill 'time' => $time;
141 $error = $record->collect;
142 $error = $record->collect %options;
143 $error = $record->collect 'invoice_time' => $time,
148 An FS::cust_main object represents a customer. FS::cust_main inherits from
149 FS::Record. The following fields are currently supported:
155 Primary key (assigned automatically for new customers)
159 Agent (see L<FS::agent>)
163 Advertising source (see L<FS::part_referral>)
175 Cocial security number (optional)
191 (optional, see L<FS::cust_main_county>)
195 (see L<FS::cust_main_county>)
201 (see L<FS::cust_main_county>)
241 (optional, see L<FS::cust_main_county>)
245 (see L<FS::cust_main_county>)
251 (see L<FS::cust_main_county>)
271 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
275 Payment Information (See L<FS::payinfo_Mixin> for data format)
279 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
283 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
287 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
291 Start date month (maestro/solo cards only)
295 Start date year (maestro/solo cards only)
299 Issue number (maestro/solo cards only)
303 Name on card or billing name
307 IP address from which payment information was received
311 Tax exempt, empty or `Y'
315 Order taker (see L<FS::access_user>)
321 =item referral_custnum
323 Referring customer number
327 Enable individual CDR spooling, empty or `Y'
331 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
335 Discourage individual CDR printing, empty or `Y'
339 Allow self-service editing of ticket subjects, empty or 'Y'
341 =item calling_list_exempt
343 Do not call, empty or 'Y'
353 Creates a new customer. To add the customer to the database, see L<"insert">.
355 Note that this stores the hash reference, not a distinct copy of the hash it
356 points to. You can ask the object for a copy with the I<hash> method.
360 sub table { 'cust_main'; }
362 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
364 Adds this customer to the database. If there is an error, returns the error,
365 otherwise returns false.
367 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
368 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
369 are inserted atomicly, or the transaction is rolled back. Passing an empty
370 hash reference is equivalent to not supplying this parameter. There should be
371 a better explanation of this, but until then, here's an example:
374 tie %hash, 'Tie::RefHash'; #this part is important
376 $cust_pkg => [ $svc_acct ],
379 $cust_main->insert( \%hash );
381 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
382 be set as the invoicing list (see L<"invoicing_list">). Errors return as
383 expected and rollback the entire transaction; it is not necessary to call
384 check_invoicing_list first. The invoicing_list is set after the records in the
385 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
386 invoicing_list destination to the newly-created svc_acct. Here's an example:
388 $cust_main->insert( {}, [ $email, 'POST' ] );
390 Currently available options are: I<depend_jobnum>, I<noexport>,
391 I<tax_exemption> and I<prospectnum>.
393 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
394 on the supplied jobnum (they will not run until the specific job completes).
395 This can be used to defer provisioning until some action completes (such
396 as running the customer's credit card successfully).
398 The I<noexport> option is deprecated. If I<noexport> is set true, no
399 provisioning jobs (exports) are scheduled. (You can schedule them later with
400 the B<reexport> method.)
402 The I<tax_exemption> option can be set to an arrayref of tax names.
403 FS::cust_main_exemption records will be created and inserted.
405 If I<prospectnum> is set, moves contacts and locations from that prospect.
411 my $cust_pkgs = @_ ? shift : {};
412 my $invoicing_list = @_ ? shift : '';
414 warn "$me insert called with options ".
415 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
418 local $SIG{HUP} = 'IGNORE';
419 local $SIG{INT} = 'IGNORE';
420 local $SIG{QUIT} = 'IGNORE';
421 local $SIG{TERM} = 'IGNORE';
422 local $SIG{TSTP} = 'IGNORE';
423 local $SIG{PIPE} = 'IGNORE';
425 my $oldAutoCommit = $FS::UID::AutoCommit;
426 local $FS::UID::AutoCommit = 0;
429 my $prepay_identifier = '';
430 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
432 if ( $self->payby eq 'PREPAY' ) {
434 $self->payby('BILL');
435 $prepay_identifier = $self->payinfo;
438 warn " looking up prepaid card $prepay_identifier\n"
441 my $error = $self->get_prepay( $prepay_identifier,
442 'amount_ref' => \$amount,
443 'seconds_ref' => \$seconds,
444 'upbytes_ref' => \$upbytes,
445 'downbytes_ref' => \$downbytes,
446 'totalbytes_ref' => \$totalbytes,
449 $dbh->rollback if $oldAutoCommit;
450 #return "error applying prepaid card (transaction rolled back): $error";
454 $payby = 'PREP' if $amount;
456 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
459 $self->payby('BILL');
460 $amount = $self->paid;
464 warn " inserting $self\n"
467 $self->signupdate(time) unless $self->signupdate;
469 $self->censusyear($conf->config('census_year')||'2012') if $self->censustract;
471 $self->auto_agent_custid()
472 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
474 my $error = $self->SUPER::insert;
476 $dbh->rollback if $oldAutoCommit;
477 #return "inserting cust_main record (transaction rolled back): $error";
481 warn " setting invoicing list\n"
484 if ( $invoicing_list ) {
485 $error = $self->check_invoicing_list( $invoicing_list );
487 $dbh->rollback if $oldAutoCommit;
488 #return "checking invoicing_list (transaction rolled back): $error";
491 $self->invoicing_list( $invoicing_list );
494 warn " setting customer tags\n"
497 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
498 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
499 'custnum' => $self->custnum };
500 my $error = $cust_tag->insert;
502 $dbh->rollback if $oldAutoCommit;
507 my $prospectnum = delete $options{'prospectnum'};
508 if ( $prospectnum ) {
510 warn " moving contacts and locations from prospect $prospectnum\n"
514 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
515 unless ( $prospect_main ) {
516 $dbh->rollback if $oldAutoCommit;
517 return "Unknown prospectnum $prospectnum";
519 $prospect_main->custnum($self->custnum);
520 $prospect_main->disabled('Y');
521 my $error = $prospect_main->replace;
523 $dbh->rollback if $oldAutoCommit;
527 my @contact = $prospect_main->contact;
528 my @cust_location = $prospect_main->cust_location;
529 my @qual = $prospect_main->qual;
531 foreach my $r ( @contact, @cust_location, @qual ) {
533 $r->custnum($self->custnum);
534 my $error = $r->replace;
536 $dbh->rollback if $oldAutoCommit;
543 warn " setting cust_main_exemption\n"
546 my $tax_exemption = delete $options{'tax_exemption'};
547 if ( $tax_exemption ) {
548 foreach my $taxname ( @$tax_exemption ) {
549 my $cust_main_exemption = new FS::cust_main_exemption {
550 'custnum' => $self->custnum,
551 'taxname' => $taxname,
553 my $error = $cust_main_exemption->insert;
555 $dbh->rollback if $oldAutoCommit;
556 return "inserting cust_main_exemption (transaction rolled back): $error";
561 if ( $self->can('start_copy_skel') ) {
562 my $error = $self->start_copy_skel;
564 $dbh->rollback if $oldAutoCommit;
569 warn " ordering packages\n"
572 $error = $self->order_pkgs( $cust_pkgs,
574 'seconds_ref' => \$seconds,
575 'upbytes_ref' => \$upbytes,
576 'downbytes_ref' => \$downbytes,
577 'totalbytes_ref' => \$totalbytes,
580 $dbh->rollback if $oldAutoCommit;
585 $dbh->rollback if $oldAutoCommit;
586 return "No svc_acct record to apply pre-paid time";
588 if ( $upbytes || $downbytes || $totalbytes ) {
589 $dbh->rollback if $oldAutoCommit;
590 return "No svc_acct record to apply pre-paid data";
594 warn " inserting initial $payby payment of $amount\n"
596 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
598 $dbh->rollback if $oldAutoCommit;
599 return "inserting payment (transaction rolled back): $error";
603 unless ( $import || $skip_fuzzyfiles ) {
604 warn " queueing fuzzyfiles update\n"
606 $error = $self->queue_fuzzyfiles_update;
608 $dbh->rollback if $oldAutoCommit;
609 return "updating fuzzy search cache: $error";
613 # FS::geocode_Mixin::after_insert or something?
614 if ( $conf->config('tax_district_method') and !$import ) {
615 # if anything non-empty, try to look it up
616 my $queue = new FS::queue {
617 'job' => 'FS::geocode_Mixin::process_district_update',
618 'custnum' => $self->custnum,
620 my $error = $queue->insert( ref($self), $self->custnum );
622 $dbh->rollback if $oldAutoCommit;
623 return "queueing tax district update: $error";
628 warn " exporting\n" if $DEBUG > 1;
630 my $export_args = $options{'export_args'} || [];
633 map qsearch( 'part_export', {exportnum=>$_} ),
634 $conf->config('cust_main-exports'); #, $agentnum
636 foreach my $part_export ( @part_export ) {
637 my $error = $part_export->export_insert($self, @$export_args);
639 $dbh->rollback if $oldAutoCommit;
640 return "exporting to ". $part_export->exporttype.
641 " (transaction rolled back): $error";
645 #foreach my $depend_jobnum ( @$depend_jobnums ) {
646 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
648 # foreach my $jobnum ( @jobnums ) {
649 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
650 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
652 # my $error = $queue->depend_insert($depend_jobnum);
654 # $dbh->rollback if $oldAutoCommit;
655 # return "error queuing job dependancy: $error";
662 #if ( exists $options{'jobnums'} ) {
663 # push @{ $options{'jobnums'} }, @jobnums;
666 warn " insert complete; committing transaction\n"
669 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
674 use File::CounterFile;
675 sub auto_agent_custid {
678 my $format = $conf->config('cust_main-auto_agent_custid');
680 if ( $format eq '1YMMXXXXXXXX' ) {
682 my $counter = new File::CounterFile 'cust_main.agent_custid';
685 my $ym = 100000000000 + time2str('%y%m00000000', time);
686 if ( $ym > $counter->value ) {
687 $counter->{'value'} = $agent_custid = $ym;
688 $counter->{'updated'} = 1;
690 $agent_custid = $counter->inc;
696 die "Unknown cust_main-auto_agent_custid format: $format";
699 $self->agent_custid($agent_custid);
703 =item PACKAGE METHODS
705 Documentation on customer package methods has been moved to
706 L<FS::cust_main::Packages>.
708 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
710 Recharges this (existing) customer with the specified prepaid card (see
711 L<FS::prepay_credit>), specified either by I<identifier> or as an
712 FS::prepay_credit object. If there is an error, returns the error, otherwise
715 Optionally, five scalar references can be passed as well. They will have their
716 values filled in with the amount, number of seconds, and number of upload,
717 download, and total bytes applied by this prepaid card.
721 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
722 #the only place that uses these args
723 sub recharge_prepay {
724 my( $self, $prepay_credit, $amountref, $secondsref,
725 $upbytesref, $downbytesref, $totalbytesref ) = @_;
727 local $SIG{HUP} = 'IGNORE';
728 local $SIG{INT} = 'IGNORE';
729 local $SIG{QUIT} = 'IGNORE';
730 local $SIG{TERM} = 'IGNORE';
731 local $SIG{TSTP} = 'IGNORE';
732 local $SIG{PIPE} = 'IGNORE';
734 my $oldAutoCommit = $FS::UID::AutoCommit;
735 local $FS::UID::AutoCommit = 0;
738 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
740 my $error = $self->get_prepay( $prepay_credit,
741 'amount_ref' => \$amount,
742 'seconds_ref' => \$seconds,
743 'upbytes_ref' => \$upbytes,
744 'downbytes_ref' => \$downbytes,
745 'totalbytes_ref' => \$totalbytes,
747 || $self->increment_seconds($seconds)
748 || $self->increment_upbytes($upbytes)
749 || $self->increment_downbytes($downbytes)
750 || $self->increment_totalbytes($totalbytes)
751 || $self->insert_cust_pay_prepay( $amount,
753 ? $prepay_credit->identifier
758 $dbh->rollback if $oldAutoCommit;
762 if ( defined($amountref) ) { $$amountref = $amount; }
763 if ( defined($secondsref) ) { $$secondsref = $seconds; }
764 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
765 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
766 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
768 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
773 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
775 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
776 specified either by I<identifier> or as an FS::prepay_credit object.
778 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
779 incremented by the values of the prepaid card.
781 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
782 check or set this customer's I<agentnum>.
784 If there is an error, returns the error, otherwise returns false.
790 my( $self, $prepay_credit, %opt ) = @_;
792 local $SIG{HUP} = 'IGNORE';
793 local $SIG{INT} = 'IGNORE';
794 local $SIG{QUIT} = 'IGNORE';
795 local $SIG{TERM} = 'IGNORE';
796 local $SIG{TSTP} = 'IGNORE';
797 local $SIG{PIPE} = 'IGNORE';
799 my $oldAutoCommit = $FS::UID::AutoCommit;
800 local $FS::UID::AutoCommit = 0;
803 unless ( ref($prepay_credit) ) {
805 my $identifier = $prepay_credit;
807 $prepay_credit = qsearchs(
809 { 'identifier' => $identifier },
814 unless ( $prepay_credit ) {
815 $dbh->rollback if $oldAutoCommit;
816 return "Invalid prepaid card: ". $identifier;
821 if ( $prepay_credit->agentnum ) {
822 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
823 $dbh->rollback if $oldAutoCommit;
824 return "prepaid card not valid for agent ". $self->agentnum;
826 $self->agentnum($prepay_credit->agentnum);
829 my $error = $prepay_credit->delete;
831 $dbh->rollback if $oldAutoCommit;
832 return "removing prepay_credit (transaction rolled back): $error";
835 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
836 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
838 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
843 =item increment_upbytes SECONDS
845 Updates this customer's single or primary account (see L<FS::svc_acct>) by
846 the specified number of upbytes. If there is an error, returns the error,
847 otherwise returns false.
851 sub increment_upbytes {
852 _increment_column( shift, 'upbytes', @_);
855 =item increment_downbytes SECONDS
857 Updates this customer's single or primary account (see L<FS::svc_acct>) by
858 the specified number of downbytes. If there is an error, returns the error,
859 otherwise returns false.
863 sub increment_downbytes {
864 _increment_column( shift, 'downbytes', @_);
867 =item increment_totalbytes SECONDS
869 Updates this customer's single or primary account (see L<FS::svc_acct>) by
870 the specified number of totalbytes. If there is an error, returns the error,
871 otherwise returns false.
875 sub increment_totalbytes {
876 _increment_column( shift, 'totalbytes', @_);
879 =item increment_seconds SECONDS
881 Updates this customer's single or primary account (see L<FS::svc_acct>) by
882 the specified number of seconds. If there is an error, returns the error,
883 otherwise returns false.
887 sub increment_seconds {
888 _increment_column( shift, 'seconds', @_);
891 =item _increment_column AMOUNT
893 Updates this customer's single or primary account (see L<FS::svc_acct>) by
894 the specified number of seconds or bytes. If there is an error, returns
895 the error, otherwise returns false.
899 sub _increment_column {
900 my( $self, $column, $amount ) = @_;
901 warn "$me increment_column called: $column, $amount\n"
904 return '' unless $amount;
906 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
907 $self->ncancelled_pkgs;
910 return 'No packages with primary or single services found'.
911 ' to apply pre-paid time';
912 } elsif ( scalar(@cust_pkg) > 1 ) {
913 #maybe have a way to specify the package/account?
914 return 'Multiple packages found to apply pre-paid time';
917 my $cust_pkg = $cust_pkg[0];
918 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
922 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
925 return 'No account found to apply pre-paid time';
926 } elsif ( scalar(@cust_svc) > 1 ) {
927 return 'Multiple accounts found to apply pre-paid time';
930 my $svc_acct = $cust_svc[0]->svc_x;
931 warn " found service svcnum ". $svc_acct->pkgnum.
932 ' ('. $svc_acct->email. ")\n"
935 $column = "increment_$column";
936 $svc_acct->$column($amount);
940 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
942 Inserts a prepayment in the specified amount for this customer. An optional
943 second argument can specify the prepayment identifier for tracking purposes.
944 If there is an error, returns the error, otherwise returns false.
948 sub insert_cust_pay_prepay {
949 shift->insert_cust_pay('PREP', @_);
952 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
954 Inserts a cash payment in the specified amount for this customer. An optional
955 second argument can specify the payment identifier for tracking purposes.
956 If there is an error, returns the error, otherwise returns false.
960 sub insert_cust_pay_cash {
961 shift->insert_cust_pay('CASH', @_);
964 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
966 Inserts a Western Union payment in the specified amount for this customer. An
967 optional second argument can specify the prepayment identifier for tracking
968 purposes. If there is an error, returns the error, otherwise returns false.
972 sub insert_cust_pay_west {
973 shift->insert_cust_pay('WEST', @_);
976 sub insert_cust_pay {
977 my( $self, $payby, $amount ) = splice(@_, 0, 3);
978 my $payinfo = scalar(@_) ? shift : '';
980 my $cust_pay = new FS::cust_pay {
981 'custnum' => $self->custnum,
982 'paid' => sprintf('%.2f', $amount),
983 #'_date' => #date the prepaid card was purchased???
985 'payinfo' => $payinfo,
993 This method is deprecated. See the I<depend_jobnum> option to the insert and
994 order_pkgs methods for a better way to defer provisioning.
996 Re-schedules all exports by calling the B<reexport> method of all associated
997 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
998 otherwise returns false.
1005 carp "WARNING: FS::cust_main::reexport is deprectated; ".
1006 "use the depend_jobnum option to insert or order_pkgs to delay export";
1008 local $SIG{HUP} = 'IGNORE';
1009 local $SIG{INT} = 'IGNORE';
1010 local $SIG{QUIT} = 'IGNORE';
1011 local $SIG{TERM} = 'IGNORE';
1012 local $SIG{TSTP} = 'IGNORE';
1013 local $SIG{PIPE} = 'IGNORE';
1015 my $oldAutoCommit = $FS::UID::AutoCommit;
1016 local $FS::UID::AutoCommit = 0;
1019 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1020 my $error = $cust_pkg->reexport;
1022 $dbh->rollback if $oldAutoCommit;
1027 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1032 =item delete [ OPTION => VALUE ... ]
1034 This deletes the customer. If there is an error, returns the error, otherwise
1037 This will completely remove all traces of the customer record. This is not
1038 what you want when a customer cancels service; for that, cancel all of the
1039 customer's packages (see L</cancel>).
1041 If the customer has any uncancelled packages, you need to pass a new (valid)
1042 customer number for those packages to be transferred to, as the "new_customer"
1043 option. Cancelled packages will be deleted. Did I mention that this is NOT
1044 what you want when a customer cancels service and that you really should be
1045 looking at L<FS::cust_pkg/cancel>?
1047 You can't delete a customer with invoices (see L<FS::cust_bill>),
1048 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1049 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1050 set the "delete_financials" option to a true value.
1055 my( $self, %opt ) = @_;
1057 local $SIG{HUP} = 'IGNORE';
1058 local $SIG{INT} = 'IGNORE';
1059 local $SIG{QUIT} = 'IGNORE';
1060 local $SIG{TERM} = 'IGNORE';
1061 local $SIG{TSTP} = 'IGNORE';
1062 local $SIG{PIPE} = 'IGNORE';
1064 my $oldAutoCommit = $FS::UID::AutoCommit;
1065 local $FS::UID::AutoCommit = 0;
1068 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1069 $dbh->rollback if $oldAutoCommit;
1070 return "Can't delete a master agent customer";
1073 #use FS::access_user
1074 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1075 $dbh->rollback if $oldAutoCommit;
1076 return "Can't delete a master employee customer";
1079 tie my %financial_tables, 'Tie::IxHash',
1080 'cust_bill' => 'invoices',
1081 'cust_statement' => 'statements',
1082 'cust_credit' => 'credits',
1083 'cust_pay' => 'payments',
1084 'cust_refund' => 'refunds',
1087 foreach my $table ( keys %financial_tables ) {
1089 my @records = $self->$table();
1091 if ( @records && ! $opt{'delete_financials'} ) {
1092 $dbh->rollback if $oldAutoCommit;
1093 return "Can't delete a customer with ". $financial_tables{$table};
1096 foreach my $record ( @records ) {
1097 my $error = $record->delete;
1099 $dbh->rollback if $oldAutoCommit;
1100 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1106 my @cust_pkg = $self->ncancelled_pkgs;
1108 my $new_custnum = $opt{'new_custnum'};
1109 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1110 $dbh->rollback if $oldAutoCommit;
1111 return "Invalid new customer number: $new_custnum";
1113 foreach my $cust_pkg ( @cust_pkg ) {
1114 my %hash = $cust_pkg->hash;
1115 $hash{'custnum'} = $new_custnum;
1116 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1117 my $error = $new_cust_pkg->replace($cust_pkg,
1118 options => { $cust_pkg->options },
1121 $dbh->rollback if $oldAutoCommit;
1126 my @cancelled_cust_pkg = $self->all_pkgs;
1127 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1128 my $error = $cust_pkg->delete;
1130 $dbh->rollback if $oldAutoCommit;
1135 #cust_tax_adjustment in financials?
1136 #cust_pay_pending? ouch
1138 foreach my $table (qw(
1139 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1140 cust_location cust_main_note cust_tax_adjustment
1141 cust_pay_void cust_pay_batch queue cust_tax_exempt
1143 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1144 my $error = $record->delete;
1146 $dbh->rollback if $oldAutoCommit;
1152 my $sth = $dbh->prepare(
1153 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1155 my $errstr = $dbh->errstr;
1156 $dbh->rollback if $oldAutoCommit;
1159 $sth->execute($self->custnum) or do {
1160 my $errstr = $sth->errstr;
1161 $dbh->rollback if $oldAutoCommit;
1167 my $ticket_dbh = '';
1168 if ($conf->config('ticket_system') eq 'RT_Internal') {
1170 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1171 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1172 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1173 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1176 if ( $ticket_dbh ) {
1178 my $ticket_sth = $ticket_dbh->prepare(
1179 'DELETE FROM Links WHERE Target = ?'
1181 my $errstr = $ticket_dbh->errstr;
1182 $dbh->rollback if $oldAutoCommit;
1185 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1187 my $errstr = $ticket_sth->errstr;
1188 $dbh->rollback if $oldAutoCommit;
1192 #check and see if the customer is the only link on the ticket, and
1193 #if so, set the ticket to deleted status in RT?
1194 #maybe someday, for now this will at least fix tickets not displaying
1198 #delete the customer record
1200 my $error = $self->SUPER::delete;
1202 $dbh->rollback if $oldAutoCommit;
1206 # cust_main exports!
1208 #my $export_args = $options{'export_args'} || [];
1211 map qsearch( 'part_export', {exportnum=>$_} ),
1212 $conf->config('cust_main-exports'); #, $agentnum
1214 foreach my $part_export ( @part_export ) {
1215 my $error = $part_export->export_delete( $self ); #, @$export_args);
1217 $dbh->rollback if $oldAutoCommit;
1218 return "exporting to ". $part_export->exporttype.
1219 " (transaction rolled back): $error";
1223 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1228 =item merge NEW_CUSTNUM [ , OPTION => VALUE ... ]
1230 This merges this customer into the provided new custnum, and then deletes the
1231 customer. If there is an error, returns the error, otherwise returns false.
1233 The source customer's name, company name, phone numbers, agent,
1234 referring customer, customer class, advertising source, order taker, and
1235 billing information (except balance) are discarded.
1237 All packages are moved to the target customer. Packages with package locations
1238 are preserved. Packages without package locations are moved to a new package
1239 location with the source customer's service/shipping address.
1241 All invoices, statements, payments, credits and refunds are moved to the target
1242 customer. The source customer's balance is added to the target customer.
1244 All notes, attachments, tickets and customer tags are moved to the target
1247 Change history is not currently moved.
1252 my( $self, $new_custnum, %opt ) = @_;
1254 return "Can't merge a customer into self" if $self->custnum == $new_custnum;
1256 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1257 return "Invalid new customer number: $new_custnum";
1260 local $SIG{HUP} = 'IGNORE';
1261 local $SIG{INT} = 'IGNORE';
1262 local $SIG{QUIT} = 'IGNORE';
1263 local $SIG{TERM} = 'IGNORE';
1264 local $SIG{TSTP} = 'IGNORE';
1265 local $SIG{PIPE} = 'IGNORE';
1267 my $oldAutoCommit = $FS::UID::AutoCommit;
1268 local $FS::UID::AutoCommit = 0;
1271 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1272 $dbh->rollback if $oldAutoCommit;
1273 return "Can't merge a master agent customer";
1276 #use FS::access_user
1277 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1278 $dbh->rollback if $oldAutoCommit;
1279 return "Can't merge a master employee customer";
1282 if ( qsearch('cust_pay_pending', { 'custnum' => $self->custnum,
1283 'status' => { op=>'!=', value=>'done' },
1287 $dbh->rollback if $oldAutoCommit;
1288 return "Can't merge a customer with pending payments";
1291 tie my %financial_tables, 'Tie::IxHash',
1292 'cust_bill' => 'invoices',
1293 'cust_statement' => 'statements',
1294 'cust_credit' => 'credits',
1295 'cust_pay' => 'payments',
1296 'cust_pay_void' => 'voided payments',
1297 'cust_refund' => 'refunds',
1300 foreach my $table ( keys %financial_tables ) {
1302 my @records = $self->$table();
1304 foreach my $record ( @records ) {
1305 $record->custnum($new_custnum);
1306 my $error = $record->replace;
1308 $dbh->rollback if $oldAutoCommit;
1309 return "Error merging ". $financial_tables{$table}. ": $error\n";
1315 my $name = $self->ship_name;
1317 my $locationnum = '';
1318 foreach my $cust_pkg ( $self->all_pkgs ) {
1319 $cust_pkg->custnum($new_custnum);
1321 unless ( $cust_pkg->locationnum ) {
1322 unless ( $locationnum ) {
1323 my $cust_location = new FS::cust_location {
1324 $self->location_hash,
1325 'custnum' => $new_custnum,
1327 my $error = $cust_location->insert;
1329 $dbh->rollback if $oldAutoCommit;
1332 $locationnum = $cust_location->locationnum;
1334 $cust_pkg->locationnum($locationnum);
1337 my $error = $cust_pkg->replace;
1339 $dbh->rollback if $oldAutoCommit;
1343 # add customer (ship) name to svc_phone.phone_name if blank
1344 my @cust_svc = $cust_pkg->cust_svc;
1345 foreach my $cust_svc (@cust_svc) {
1346 my($label, $value, $svcdb) = $cust_svc->label;
1347 next unless $svcdb eq 'svc_phone';
1348 my $svc_phone = $cust_svc->svc_x;
1349 next if $svc_phone->phone_name;
1350 $svc_phone->phone_name($name);
1351 my $error = $svc_phone->replace;
1353 $dbh->rollback if $oldAutoCommit;
1361 # cust_tax_exempt (texas tax exemptions)
1362 # cust_recon (some sort of not-well understood thing for OnPac)
1364 #these are moved over
1365 foreach my $table (qw(
1366 cust_tag cust_location contact cust_attachment cust_main_note
1367 cust_tax_adjustment cust_pay_batch queue
1369 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1370 $record->custnum($new_custnum);
1371 my $error = $record->replace;
1373 $dbh->rollback if $oldAutoCommit;
1379 #these aren't preserved
1380 foreach my $table (qw(
1381 cust_main_exemption cust_main_invoice
1383 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1384 my $error = $record->delete;
1386 $dbh->rollback if $oldAutoCommit;
1393 my $sth = $dbh->prepare(
1394 'UPDATE cust_main SET referral_custnum = ? WHERE referral_custnum = ?'
1396 my $errstr = $dbh->errstr;
1397 $dbh->rollback if $oldAutoCommit;
1400 $sth->execute($new_custnum, $self->custnum) or do {
1401 my $errstr = $sth->errstr;
1402 $dbh->rollback if $oldAutoCommit;
1408 my $ticket_dbh = '';
1409 if ($conf->config('ticket_system') eq 'RT_Internal') {
1411 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1412 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1413 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1414 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1417 if ( $ticket_dbh ) {
1419 my $ticket_sth = $ticket_dbh->prepare(
1420 'UPDATE Links SET Target = ? WHERE Target = ?'
1422 my $errstr = $ticket_dbh->errstr;
1423 $dbh->rollback if $oldAutoCommit;
1426 $ticket_sth->execute('freeside://freeside/cust_main/'.$new_custnum,
1427 'freeside://freeside/cust_main/'.$self->custnum)
1429 my $errstr = $ticket_sth->errstr;
1430 $dbh->rollback if $oldAutoCommit;
1436 #delete the customer record
1438 my $error = $self->delete;
1440 $dbh->rollback if $oldAutoCommit;
1444 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1449 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1452 Replaces the OLD_RECORD with this one in the database. If there is an error,
1453 returns the error, otherwise returns false.
1455 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1456 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1457 expected and rollback the entire transaction; it is not necessary to call
1458 check_invoicing_list first. Here's an example:
1460 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1462 Currently available options are: I<tax_exemption>.
1464 The I<tax_exemption> option can be set to an arrayref of tax names.
1465 FS::cust_main_exemption records will be deleted and inserted as appropriate.
1472 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1474 : $self->replace_old;
1478 warn "$me replace called\n"
1481 my $curuser = $FS::CurrentUser::CurrentUser;
1482 if ( $self->payby eq 'COMP'
1483 && $self->payby ne $old->payby
1484 && ! $curuser->access_right('Complimentary customer')
1487 return "You are not permitted to create complimentary accounts.";
1490 if ( $old->get('geocode') && $old->get('geocode') eq $self->get('geocode')
1491 && $conf->exists('enable_taxproducts')
1494 my $pre = ($conf->exists('tax-ship_address') && $self->ship_zip)
1496 $self->set('geocode', '')
1497 if $old->get($pre.'zip') ne $self->get($pre.'zip')
1498 && length($self->get($pre.'zip')) >= 10;
1501 for my $pre ( grep $old->get($_.'coord_auto'), ( '', 'ship_' ) ) {
1503 $self->set($pre.'coord_auto', '') && next
1504 if $self->get($pre.'latitude') && $self->get($pre.'longitude')
1505 && ( $self->get($pre.'latitude') != $old->get($pre.'latitude')
1506 || $self->get($pre.'longitude') != $old->get($pre.'longitude')
1509 $self->set_coord($pre)
1510 if $old->get($pre.'address1') ne $self->get($pre.'address1')
1511 || $old->get($pre.'city') ne $self->get($pre.'city')
1512 || $old->get($pre.'state') ne $self->get($pre.'state')
1513 || $old->get($pre.'country') ne $self->get($pre.'country');
1517 unless ( $import ) {
1519 if ! $self->coord_auto && ! $self->latitude && ! $self->longitude;
1521 $self->set_coord('ship_')
1522 if $self->has_ship_address && ! $self->ship_coord_auto
1523 && ! $self->ship_latitude && ! $self->ship_longitude;
1526 local($ignore_expired_card) = 1
1527 if $old->payby =~ /^(CARD|DCRD)$/
1528 && $self->payby =~ /^(CARD|DCRD)$/
1529 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1531 local($ignore_banned_card) = 1
1532 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1533 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1534 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1536 if ( $self->censustract ne '' and $self->censustract ne $old->censustract ) {
1537 # update censusyear whenever tract code changes
1538 $self->censusyear($conf->config('census_year')||'2012');
1542 local $SIG{HUP} = 'IGNORE';
1543 local $SIG{INT} = 'IGNORE';
1544 local $SIG{QUIT} = 'IGNORE';
1545 local $SIG{TERM} = 'IGNORE';
1546 local $SIG{TSTP} = 'IGNORE';
1547 local $SIG{PIPE} = 'IGNORE';
1549 my $oldAutoCommit = $FS::UID::AutoCommit;
1550 local $FS::UID::AutoCommit = 0;
1553 my $error = $self->SUPER::replace($old);
1556 $dbh->rollback if $oldAutoCommit;
1560 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1561 my $invoicing_list = shift @param;
1562 $error = $self->check_invoicing_list( $invoicing_list );
1564 $dbh->rollback if $oldAutoCommit;
1567 $self->invoicing_list( $invoicing_list );
1570 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1572 #this could be more efficient than deleting and re-inserting, if it matters
1573 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1574 my $error = $cust_tag->delete;
1576 $dbh->rollback if $oldAutoCommit;
1580 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1581 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1582 'custnum' => $self->custnum };
1583 my $error = $cust_tag->insert;
1585 $dbh->rollback if $oldAutoCommit;
1592 my %options = @param;
1594 my $tax_exemption = delete $options{'tax_exemption'};
1595 if ( $tax_exemption ) {
1597 my %cust_main_exemption =
1598 map { $_->taxname => $_ }
1599 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1601 foreach my $taxname ( @$tax_exemption ) {
1603 next if delete $cust_main_exemption{$taxname};
1605 my $cust_main_exemption = new FS::cust_main_exemption {
1606 'custnum' => $self->custnum,
1607 'taxname' => $taxname,
1609 my $error = $cust_main_exemption->insert;
1611 $dbh->rollback if $oldAutoCommit;
1612 return "inserting cust_main_exemption (transaction rolled back): $error";
1616 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1617 my $error = $cust_main_exemption->delete;
1619 $dbh->rollback if $oldAutoCommit;
1620 return "deleting cust_main_exemption (transaction rolled back): $error";
1626 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1627 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1628 && $self->get('payinfo') !~ /^99\d{14}$/
1630 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1635 # card/check/lec info has changed, want to retry realtime_ invoice events
1636 my $error = $self->retry_realtime;
1638 $dbh->rollback if $oldAutoCommit;
1643 unless ( $import || $skip_fuzzyfiles ) {
1644 $error = $self->queue_fuzzyfiles_update;
1646 $dbh->rollback if $oldAutoCommit;
1647 return "updating fuzzy search cache: $error";
1651 # FS::geocode_Mixin::after_replace ?
1652 # though this will go away anyway once we move customer bill/service
1653 # locations into cust_location
1654 # We can trigger this on any address change--just have to make sure
1655 # not to trigger it on itself.
1656 if ( $conf->config('tax_district_method') and !$import
1657 and ( $self->get('ship_address1') ne $old->get('ship_address1')
1658 or $self->get('address1') ne $old->get('address1') ) ) {
1659 my $queue = new FS::queue {
1660 'job' => 'FS::geocode_Mixin::process_district_update',
1661 'custnum' => $self->custnum,
1663 my $error = $queue->insert( ref($self), $self->custnum );
1665 $dbh->rollback if $oldAutoCommit;
1666 return "queueing tax district update: $error";
1670 # cust_main exports!
1672 my $export_args = $options{'export_args'} || [];
1675 map qsearch( 'part_export', {exportnum=>$_} ),
1676 $conf->config('cust_main-exports'); #, $agentnum
1678 foreach my $part_export ( @part_export ) {
1679 my $error = $part_export->export_replace( $self, $old, @$export_args);
1681 $dbh->rollback if $oldAutoCommit;
1682 return "exporting to ". $part_export->exporttype.
1683 " (transaction rolled back): $error";
1687 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1692 =item queue_fuzzyfiles_update
1694 Used by insert & replace to update the fuzzy search cache
1698 use FS::cust_main::Search;
1699 sub queue_fuzzyfiles_update {
1702 local $SIG{HUP} = 'IGNORE';
1703 local $SIG{INT} = 'IGNORE';
1704 local $SIG{QUIT} = 'IGNORE';
1705 local $SIG{TERM} = 'IGNORE';
1706 local $SIG{TSTP} = 'IGNORE';
1707 local $SIG{PIPE} = 'IGNORE';
1709 my $oldAutoCommit = $FS::UID::AutoCommit;
1710 local $FS::UID::AutoCommit = 0;
1713 my $queue = new FS::queue { 'job' => 'FS::cust_main::Search::append_fuzzyfiles' };
1714 my $error = $queue->insert( map $self->getfield($_), @FS::cust_main::Search::fuzzyfields );
1716 $dbh->rollback if $oldAutoCommit;
1717 return "queueing job (transaction rolled back): $error";
1720 if ( $self->ship_last ) {
1721 $queue = new FS::queue { 'job' => 'FS::cust_main::Search::append_fuzzyfiles' };
1722 $error = $queue->insert( map $self->getfield("ship_$_"), @FS::cust_main::Search::fuzzyfields );
1724 $dbh->rollback if $oldAutoCommit;
1725 return "queueing job (transaction rolled back): $error";
1729 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1736 Checks all fields to make sure this is a valid customer record. If there is
1737 an error, returns the error, otherwise returns false. Called by the insert
1738 and replace methods.
1745 warn "$me check BEFORE: \n". $self->_dump
1749 $self->ut_numbern('custnum')
1750 || $self->ut_number('agentnum')
1751 || $self->ut_textn('agent_custid')
1752 || $self->ut_number('refnum')
1753 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1754 || $self->ut_textn('custbatch')
1755 || $self->ut_name('last')
1756 || $self->ut_name('first')
1757 || $self->ut_snumbern('birthdate')
1758 || $self->ut_snumbern('signupdate')
1759 || $self->ut_textn('company')
1760 || $self->ut_text('address1')
1761 || $self->ut_textn('address2')
1762 || $self->ut_text('city')
1763 || $self->ut_textn('county')
1764 || $self->ut_textn('state')
1765 || $self->ut_country('country')
1766 || $self->ut_coordn('latitude')
1767 || $self->ut_coordn('longitude')
1768 || $self->ut_enum('coord_auto', [ '', 'Y' ])
1769 || $self->ut_numbern('censusyear')
1770 || $self->ut_anything('comments')
1771 || $self->ut_numbern('referral_custnum')
1772 || $self->ut_textn('stateid')
1773 || $self->ut_textn('stateid_state')
1774 || $self->ut_textn('invoice_terms')
1775 || $self->ut_alphan('geocode')
1776 || $self->ut_alphan('district')
1777 || $self->ut_floatn('cdr_termination_percentage')
1778 || $self->ut_floatn('credit_limit')
1779 || $self->ut_numbern('billday')
1780 || $self->ut_enum('edit_subject', [ '', 'Y' ] )
1781 || $self->ut_enum('calling_list_exempt', [ '', 'Y' ] )
1782 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1786 unless $import || ($self->latitude && $self->longitude);
1788 #barf. need message catalogs. i18n. etc.
1789 $error .= "Please select an advertising source."
1790 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1791 return $error if $error;
1793 return "Unknown agent"
1794 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1796 return "Unknown refnum"
1797 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1799 return "Unknown referring custnum: ". $self->referral_custnum
1800 unless ! $self->referral_custnum
1801 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1803 if ( $self->censustract ne '' ) {
1804 $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
1805 or return "Illegal census tract: ". $self->censustract;
1807 $self->censustract("$1.$2");
1810 if ( $self->ss eq '' ) {
1815 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1816 or return "Illegal social security number: ". $self->ss;
1817 $self->ss("$1-$2-$3");
1821 # bad idea to disable, causes billing to fail because of no tax rates later
1822 # except we don't fail any more
1823 unless ( $import ) {
1824 unless ( qsearch('cust_main_county', {
1825 'country' => $self->country,
1828 return "Unknown state/county/country: ".
1829 $self->state. "/". $self->county. "/". $self->country
1830 unless qsearch('cust_main_county',{
1831 'state' => $self->state,
1832 'county' => $self->county,
1833 'country' => $self->country,
1839 $self->ut_phonen('daytime', $self->country)
1840 || $self->ut_phonen('night', $self->country)
1841 || $self->ut_phonen('fax', $self->country)
1842 || $self->ut_phonen('mobile', $self->country)
1844 return $error if $error;
1846 unless ( $ignore_illegal_zip ) {
1847 $error = $self->ut_zip('zip', $self->country);
1848 return $error if $error;
1851 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1852 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1855 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1857 : FS::Msgcat::_gettext('daytime');
1858 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1860 : FS::Msgcat::_gettext('night');
1862 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1864 : FS::Msgcat::_gettext('mobile');
1866 return "$daytime_label, $night_label or $mobile_label is required"
1870 if ( $self->has_ship_address
1871 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1872 $self->addr_fields )
1876 $self->ut_name('ship_last')
1877 || $self->ut_name('ship_first')
1878 || $self->ut_textn('ship_company')
1879 || $self->ut_text('ship_address1')
1880 || $self->ut_textn('ship_address2')
1881 || $self->ut_text('ship_city')
1882 || $self->ut_textn('ship_county')
1883 || $self->ut_textn('ship_state')
1884 || $self->ut_country('ship_country')
1885 || $self->ut_coordn('ship_latitude')
1886 || $self->ut_coordn('ship_longitude')
1887 || $self->ut_enum('ship_coord_auto', [ '', 'Y' ] )
1889 return $error if $error;
1891 $self->set_coord('ship_')
1892 unless $import || ($self->ship_latitude && $self->ship_longitude);
1894 #false laziness with above
1895 unless ( qsearchs('cust_main_county', {
1896 'country' => $self->ship_country,
1899 return "Unknown ship_state/ship_county/ship_country: ".
1900 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1901 unless qsearch('cust_main_county',{
1902 'state' => $self->ship_state,
1903 'county' => $self->ship_county,
1904 'country' => $self->ship_country,
1910 $self->ut_phonen('ship_daytime', $self->ship_country)
1911 || $self->ut_phonen('ship_night', $self->ship_country)
1912 || $self->ut_phonen('ship_fax', $self->ship_country)
1913 || $self->ut_phonen('ship_mobile', $self->ship_country)
1915 return $error if $error;
1917 unless ( $ignore_illegal_zip ) {
1918 $error = $self->ut_zip('ship_zip', $self->ship_country);
1919 return $error if $error;
1921 return "Unit # is required."
1922 if $self->ship_address2 =~ /^\s*$/
1923 && $conf->exists('cust_main-require_address2');
1925 } else { # ship_ info eq billing info, so don't store dup info in database
1927 $self->setfield("ship_$_", '')
1928 foreach $self->addr_fields;
1930 return "Unit # is required."
1931 if $self->address2 =~ /^\s*$/
1932 && $conf->exists('cust_main-require_address2');
1936 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1937 # or return "Illegal payby: ". $self->payby;
1939 FS::payby->can_payby($self->table, $self->payby)
1940 or return "Illegal payby: ". $self->payby;
1942 $error = $self->ut_numbern('paystart_month')
1943 || $self->ut_numbern('paystart_year')
1944 || $self->ut_numbern('payissue')
1945 || $self->ut_textn('paytype')
1947 return $error if $error;
1949 if ( $self->payip eq '' ) {
1952 $error = $self->ut_ip('payip');
1953 return $error if $error;
1956 # If it is encrypted and the private key is not availaible then we can't
1957 # check the credit card.
1958 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1960 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1962 my $payinfo = $self->payinfo;
1963 $payinfo =~ s/\D//g;
1964 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1965 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1967 $self->payinfo($payinfo);
1969 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1971 return gettext('unknown_card_type')
1972 if $self->payinfo !~ /^99\d{14}$/ #token
1973 && cardtype($self->payinfo) eq "Unknown";
1975 unless ( $ignore_banned_card ) {
1976 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1978 if ( $ban->bantype eq 'warn' ) {
1979 #or others depending on value of $ban->reason ?
1980 return '_duplicate_card'.
1981 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1982 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1983 ' (ban# '. $ban->bannum. ')'
1984 unless $self->override_ban_warn;
1986 return 'Banned credit card: banned on '.
1987 time2str('%a %h %o at %r', $ban->_date).
1988 ' by '. $ban->otaker.
1989 ' (ban# '. $ban->bannum. ')';
1994 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1995 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1996 $self->paycvv =~ /^(\d{4})$/
1997 or return "CVV2 (CID) for American Express cards is four digits.";
2000 $self->paycvv =~ /^(\d{3})$/
2001 or return "CVV2 (CVC2/CID) is three digits.";
2008 my $cardtype = cardtype($payinfo);
2009 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
2011 return "Start date or issue number is required for $cardtype cards"
2012 unless $self->paystart_month && $self->paystart_year or $self->payissue;
2014 return "Start month must be between 1 and 12"
2015 if $self->paystart_month
2016 and $self->paystart_month < 1 || $self->paystart_month > 12;
2018 return "Start year must be 1990 or later"
2019 if $self->paystart_year
2020 and $self->paystart_year < 1990;
2022 return "Issue number must be beween 1 and 99"
2024 and $self->payissue < 1 || $self->payissue > 99;
2027 $self->paystart_month('');
2028 $self->paystart_year('');
2029 $self->payissue('');
2032 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
2034 my $payinfo = $self->payinfo;
2035 $payinfo =~ s/[^\d\@\.]//g;
2036 if ( $conf->config('echeck-country') eq 'CA' ) {
2037 $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
2038 or return 'invalid echeck account@branch.bank';
2039 $payinfo = "$1\@$2.$3";
2040 } elsif ( $conf->config('echeck-country') eq 'US' ) {
2041 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
2042 $payinfo = "$1\@$2";
2044 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
2045 $payinfo = "$1\@$2";
2047 $self->payinfo($payinfo);
2050 unless ( $ignore_banned_card ) {
2051 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
2053 if ( $ban->bantype eq 'warn' ) {
2054 #or others depending on value of $ban->reason ?
2055 return '_duplicate_ach' unless $self->override_ban_warn;
2057 return 'Banned ACH account: banned on '.
2058 time2str('%a %h %o at %r', $ban->_date).
2059 ' by '. $ban->otaker.
2060 ' (ban# '. $ban->bannum. ')';
2065 } elsif ( $self->payby eq 'LECB' ) {
2067 my $payinfo = $self->payinfo;
2068 $payinfo =~ s/\D//g;
2069 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
2071 $self->payinfo($payinfo);
2074 } elsif ( $self->payby eq 'BILL' ) {
2076 $error = $self->ut_textn('payinfo');
2077 return "Illegal P.O. number: ". $self->payinfo if $error;
2080 } elsif ( $self->payby eq 'COMP' ) {
2082 my $curuser = $FS::CurrentUser::CurrentUser;
2083 if ( ! $self->custnum
2084 && ! $curuser->access_right('Complimentary customer')
2087 return "You are not permitted to create complimentary accounts."
2090 $error = $self->ut_textn('payinfo');
2091 return "Illegal comp account issuer: ". $self->payinfo if $error;
2094 } elsif ( $self->payby eq 'PREPAY' ) {
2096 my $payinfo = $self->payinfo;
2097 $payinfo =~ s/\W//g; #anything else would just confuse things
2098 $self->payinfo($payinfo);
2099 $error = $self->ut_alpha('payinfo');
2100 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2101 return "Unknown prepayment identifier"
2102 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2107 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2108 return "Expiration date required"
2109 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
2113 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2114 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2115 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2116 ( $m, $y ) = ( $2, "19$1" );
2117 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2118 ( $m, $y ) = ( $3, "20$2" );
2120 return "Illegal expiration date: ". $self->paydate;
2122 $m = sprintf('%02d',$m);
2123 $self->paydate("$y-$m-01");
2124 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2125 return gettext('expired_card')
2127 && !$ignore_expired_card
2128 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2131 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2132 ( ! $conf->exists('require_cardname')
2133 || $self->payby !~ /^(CARD|DCRD)$/ )
2135 $self->payname( $self->first. " ". $self->getfield('last') );
2137 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
2138 or return gettext('illegal_name'). " payname: ". $self->payname;
2142 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2143 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2147 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2149 warn "$me check AFTER: \n". $self->_dump
2152 $self->SUPER::check;
2157 Returns a list of fields which have ship_ duplicates.
2162 qw( last first company
2163 address1 address2 city county state zip country
2165 daytime night fax mobile
2169 =item has_ship_address
2171 Returns true if this customer record has a separate shipping address.
2175 sub has_ship_address {
2177 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
2182 Returns a list of key/value pairs, with the following keys: address1,
2183 adddress2, city, county, state, zip, country, district, and geocode. The
2184 shipping address is used if present.
2190 Returns all locations (see L<FS::cust_location>) for this customer.
2196 qsearch('cust_location', { 'custnum' => $self->custnum } );
2201 Returns all contacts (see L<FS::contact>) for this customer.
2205 #already used :/ sub contact {
2208 qsearch('contact', { 'custnum' => $self->custnum } );
2213 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2214 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2215 on success or a list of errors.
2221 grep { $_->unsuspend } $self->suspended_pkgs;
2226 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2228 Returns a list: an empty list on success or a list of errors.
2234 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2237 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2239 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2240 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2241 of a list of pkgparts; the hashref has the following keys:
2245 =item pkgparts - listref of pkgparts
2247 =item (other options are passed to the suspend method)
2252 Returns a list: an empty list on success or a list of errors.
2256 sub suspend_if_pkgpart {
2258 my (@pkgparts, %opt);
2259 if (ref($_[0]) eq 'HASH'){
2260 @pkgparts = @{$_[0]{pkgparts}};
2265 grep { $_->suspend(%opt) }
2266 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2267 $self->unsuspended_pkgs;
2270 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2272 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2273 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2274 instead of a list of pkgparts; the hashref has the following keys:
2278 =item pkgparts - listref of pkgparts
2280 =item (other options are passed to the suspend method)
2284 Returns a list: an empty list on success or a list of errors.
2288 sub suspend_unless_pkgpart {
2290 my (@pkgparts, %opt);
2291 if (ref($_[0]) eq 'HASH'){
2292 @pkgparts = @{$_[0]{pkgparts}};
2297 grep { $_->suspend(%opt) }
2298 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2299 $self->unsuspended_pkgs;
2302 =item cancel [ OPTION => VALUE ... ]
2304 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2306 Available options are:
2310 =item quiet - can be set true to supress email cancellation notices.
2312 =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.
2314 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2316 =item nobill - can be set true to skip billing if it might otherwise be done.
2320 Always returns a list: an empty list on success or a list of errors.
2324 # nb that dates are not specified as valid options to this method
2327 my( $self, %opt ) = @_;
2329 warn "$me cancel called on customer ". $self->custnum. " with options ".
2330 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2333 return ( 'access denied' )
2334 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2336 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2338 #should try decryption (we might have the private key)
2339 # and if not maybe queue a job for the server that does?
2340 return ( "Can't (yet) ban encrypted credit cards" )
2341 if $self->is_encrypted($self->payinfo);
2343 my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2344 my $error = $ban->insert;
2345 return ( $error ) if $error;
2349 my @pkgs = $self->ncancelled_pkgs;
2351 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2353 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2354 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2358 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2359 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2362 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2365 sub _banned_pay_hashref {
2376 'payby' => $payby2ban{$self->payby},
2377 'payinfo' => $self->payinfo,
2378 #don't ever *search* on reason! #'reason' =>
2382 sub _new_banned_pay_hashref {
2384 my $hr = $self->_banned_pay_hashref;
2385 $hr->{payinfo} = md5_base64($hr->{payinfo});
2391 Returns all notes (see L<FS::cust_main_note>) for this customer.
2396 my($self,$orderby_classnum) = (shift,shift);
2397 my $orderby = "_DATE DESC";
2398 $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2399 qsearch( 'cust_main_note',
2400 { 'custnum' => $self->custnum },
2402 "ORDER BY $orderby",
2408 Returns the agent (see L<FS::agent>) for this customer.
2414 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2419 Returns the agent name (see L<FS::agent>) for this customer.
2425 $self->agent->agent;
2430 Returns any tags associated with this customer, as FS::cust_tag objects,
2431 or an empty list if there are no tags.
2437 qsearch('cust_tag', { 'custnum' => $self->custnum } );
2442 Returns any tags associated with this customer, as FS::part_tag objects,
2443 or an empty list if there are no tags.
2449 map $_->part_tag, $self->cust_tag;
2455 Returns the customer class, as an FS::cust_class object, or the empty string
2456 if there is no customer class.
2462 if ( $self->classnum ) {
2463 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2471 Returns the customer category name, or the empty string if there is no customer
2478 my $cust_class = $self->cust_class;
2480 ? $cust_class->categoryname
2486 Returns the customer class name, or the empty string if there is no customer
2493 my $cust_class = $self->cust_class;
2495 ? $cust_class->classname
2499 =item BILLING METHODS
2501 Documentation on billing methods has been moved to
2502 L<FS::cust_main::Billing>.
2504 =item REALTIME BILLING METHODS
2506 Documentation on realtime billing methods has been moved to
2507 L<FS::cust_main::Billing_Realtime>.
2511 Removes the I<paycvv> field from the database directly.
2513 If there is an error, returns the error, otherwise returns false.
2519 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2520 or return dbh->errstr;
2521 $sth->execute($self->custnum)
2522 or return $sth->errstr;
2527 =item batch_card OPTION => VALUE...
2529 Adds a payment for this invoice to the pending credit card batch (see
2530 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2531 runs the payment using a realtime gateway.
2536 my ($self, %options) = @_;
2539 if (exists($options{amount})) {
2540 $amount = $options{amount};
2542 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2544 return '' unless $amount > 0;
2546 my $invnum = delete $options{invnum};
2547 my $payby = $options{payby} || $self->payby; #still dubious
2549 if ($options{'realtime'}) {
2550 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2556 my $oldAutoCommit = $FS::UID::AutoCommit;
2557 local $FS::UID::AutoCommit = 0;
2560 #this needs to handle mysql as well as Pg, like svc_acct.pm
2561 #(make it into a common function if folks need to do batching with mysql)
2562 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2563 or return "Cannot lock pay_batch: " . $dbh->errstr;
2567 'payby' => FS::payby->payby2payment($payby),
2569 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2571 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2573 unless ( $pay_batch ) {
2574 $pay_batch = new FS::pay_batch \%pay_batch;
2575 my $error = $pay_batch->insert;
2577 $dbh->rollback if $oldAutoCommit;
2578 die "error creating new batch: $error\n";
2582 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2583 'batchnum' => $pay_batch->batchnum,
2584 'custnum' => $self->custnum,
2587 foreach (qw( address1 address2 city state zip country latitude longitude
2588 payby payinfo paydate payname ))
2590 $options{$_} = '' unless exists($options{$_});
2593 my $cust_pay_batch = new FS::cust_pay_batch ( {
2594 'batchnum' => $pay_batch->batchnum,
2595 'invnum' => $invnum || 0, # is there a better value?
2596 # this field should be
2598 # cust_bill_pay_batch now
2599 'custnum' => $self->custnum,
2600 'last' => $self->getfield('last'),
2601 'first' => $self->getfield('first'),
2602 'address1' => $options{address1} || $self->address1,
2603 'address2' => $options{address2} || $self->address2,
2604 'city' => $options{city} || $self->city,
2605 'state' => $options{state} || $self->state,
2606 'zip' => $options{zip} || $self->zip,
2607 'country' => $options{country} || $self->country,
2608 'payby' => $options{payby} || $self->payby,
2609 'payinfo' => $options{payinfo} || $self->payinfo,
2610 'exp' => $options{paydate} || $self->paydate,
2611 'payname' => $options{payname} || $self->payname,
2612 'amount' => $amount, # consolidating
2615 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2616 if $old_cust_pay_batch;
2619 if ($old_cust_pay_batch) {
2620 $error = $cust_pay_batch->replace($old_cust_pay_batch)
2622 $error = $cust_pay_batch->insert;
2626 $dbh->rollback if $oldAutoCommit;
2630 my $unapplied = $self->total_unapplied_credits
2631 + $self->total_unapplied_payments
2632 + $self->in_transit_payments;
2633 foreach my $cust_bill ($self->open_cust_bill) {
2634 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2635 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2636 'invnum' => $cust_bill->invnum,
2637 'paybatchnum' => $cust_pay_batch->paybatchnum,
2638 'amount' => $cust_bill->owed,
2641 if ($unapplied >= $cust_bill_pay_batch->amount){
2642 $unapplied -= $cust_bill_pay_batch->amount;
2645 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2646 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
2648 $error = $cust_bill_pay_batch->insert;
2650 $dbh->rollback if $oldAutoCommit;
2655 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2661 Returns the total owed for this customer on all invoices
2662 (see L<FS::cust_bill/owed>).
2668 $self->total_owed_date(2145859200); #12/31/2037
2671 =item total_owed_date TIME
2673 Returns the total owed for this customer on all invoices with date earlier than
2674 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2675 see L<Time::Local> and L<Date::Parse> for conversion functions.
2679 sub total_owed_date {
2683 my $custnum = $self->custnum;
2685 my $owed_sql = FS::cust_bill->owed_sql;
2688 SELECT SUM($owed_sql) FROM cust_bill
2689 WHERE custnum = $custnum
2693 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2697 =item total_owed_pkgnum PKGNUM
2699 Returns the total owed on all invoices for this customer's specific package
2700 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2704 sub total_owed_pkgnum {
2705 my( $self, $pkgnum ) = @_;
2706 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2709 =item total_owed_date_pkgnum TIME PKGNUM
2711 Returns the total owed for this customer's specific package when using
2712 experimental package balances on all invoices with date earlier than
2713 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2714 see L<Time::Local> and L<Date::Parse> for conversion functions.
2718 sub total_owed_date_pkgnum {
2719 my( $self, $time, $pkgnum ) = @_;
2722 foreach my $cust_bill (
2723 grep { $_->_date <= $time }
2724 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2726 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2728 sprintf( "%.2f", $total_bill );
2734 Returns the total amount of all payments.
2741 $total += $_->paid foreach $self->cust_pay;
2742 sprintf( "%.2f", $total );
2745 =item total_unapplied_credits
2747 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2748 customer. See L<FS::cust_credit/credited>.
2750 =item total_credited
2752 Old name for total_unapplied_credits. Don't use.
2756 sub total_credited {
2757 #carp "total_credited deprecated, use total_unapplied_credits";
2758 shift->total_unapplied_credits(@_);
2761 sub total_unapplied_credits {
2764 my $custnum = $self->custnum;
2766 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2769 SELECT SUM($unapplied_sql) FROM cust_credit
2770 WHERE custnum = $custnum
2773 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2777 =item total_unapplied_credits_pkgnum PKGNUM
2779 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2780 customer. See L<FS::cust_credit/credited>.
2784 sub total_unapplied_credits_pkgnum {
2785 my( $self, $pkgnum ) = @_;
2786 my $total_credit = 0;
2787 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2788 sprintf( "%.2f", $total_credit );
2792 =item total_unapplied_payments
2794 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2795 See L<FS::cust_pay/unapplied>.
2799 sub total_unapplied_payments {
2802 my $custnum = $self->custnum;
2804 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2807 SELECT SUM($unapplied_sql) FROM cust_pay
2808 WHERE custnum = $custnum
2811 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2815 =item total_unapplied_payments_pkgnum PKGNUM
2817 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2818 specific package when using experimental package balances. See
2819 L<FS::cust_pay/unapplied>.
2823 sub total_unapplied_payments_pkgnum {
2824 my( $self, $pkgnum ) = @_;
2825 my $total_unapplied = 0;
2826 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2827 sprintf( "%.2f", $total_unapplied );
2831 =item total_unapplied_refunds
2833 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2834 customer. See L<FS::cust_refund/unapplied>.
2838 sub total_unapplied_refunds {
2840 my $custnum = $self->custnum;
2842 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2845 SELECT SUM($unapplied_sql) FROM cust_refund
2846 WHERE custnum = $custnum
2849 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2855 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2856 total_unapplied_credits minus total_unapplied_payments).
2862 $self->balance_date_range;
2865 =item balance_date TIME
2867 Returns the balance for this customer, only considering invoices with date
2868 earlier than TIME (total_owed_date minus total_credited minus
2869 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2870 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2877 $self->balance_date_range(shift);
2880 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2882 Returns the balance for this customer, optionally considering invoices with
2883 date earlier than START_TIME, and not later than END_TIME
2884 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2886 Times are specified as SQL fragments or numeric
2887 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2888 L<Date::Parse> for conversion functions. The empty string can be passed
2889 to disable that time constraint completely.
2891 Available options are:
2895 =item unapplied_date
2897 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)
2903 sub balance_date_range {
2905 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2906 ') FROM cust_main WHERE custnum='. $self->custnum;
2907 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2910 =item balance_pkgnum PKGNUM
2912 Returns the balance for this customer's specific package when using
2913 experimental package balances (total_owed plus total_unrefunded, minus
2914 total_unapplied_credits minus total_unapplied_payments)
2918 sub balance_pkgnum {
2919 my( $self, $pkgnum ) = @_;
2922 $self->total_owed_pkgnum($pkgnum)
2923 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2924 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2925 - $self->total_unapplied_credits_pkgnum($pkgnum)
2926 - $self->total_unapplied_payments_pkgnum($pkgnum)
2930 =item in_transit_payments
2932 Returns the total of requests for payments for this customer pending in
2933 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
2937 sub in_transit_payments {
2939 my $in_transit_payments = 0;
2940 foreach my $pay_batch ( qsearch('pay_batch', {
2943 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2944 'batchnum' => $pay_batch->batchnum,
2945 'custnum' => $self->custnum,
2947 $in_transit_payments += $cust_pay_batch->amount;
2950 sprintf( "%.2f", $in_transit_payments );
2955 Returns a hash of useful information for making a payment.
2965 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2966 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2967 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2971 For credit card transactions:
2983 For electronic check transactions:
2998 $return{balance} = $self->balance;
3000 $return{payname} = $self->payname
3001 || ( $self->first. ' '. $self->get('last') );
3003 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
3005 $return{payby} = $self->payby;
3006 $return{stateid_state} = $self->stateid_state;
3008 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
3009 $return{card_type} = cardtype($self->payinfo);
3010 $return{payinfo} = $self->paymask;
3012 @return{'month', 'year'} = $self->paydate_monthyear;
3016 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
3017 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
3018 $return{payinfo1} = $payinfo1;
3019 $return{payinfo2} = $payinfo2;
3020 $return{paytype} = $self->paytype;
3021 $return{paystate} = $self->paystate;
3025 #doubleclick protection
3027 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
3033 =item paydate_monthyear
3035 Returns a two-element list consisting of the month and year of this customer's
3036 paydate (credit card expiration date for CARD customers)
3040 sub paydate_monthyear {
3042 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3044 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3053 Returns the exact time in seconds corresponding to the payment method
3054 expiration date. For CARD/DCRD customers this is the end of the month;
3055 for others (COMP is the only other payby that uses paydate) it's the start.
3056 Returns 0 if the paydate is empty or set to the far future.
3062 my ($month, $year) = $self->paydate_monthyear;
3063 return 0 if !$year or $year >= 2037;
3064 if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
3066 if ( $month == 13 ) {
3070 return timelocal(0,0,0,1,$month-1,$year) - 1;
3073 return timelocal(0,0,0,1,$month-1,$year);
3077 =item paydate_epoch_sql
3079 Class method. Returns an SQL expression to obtain the payment expiration date
3080 as a number of seconds.
3084 # Special expiration date behavior for non-CARD/DCRD customers has been
3085 # carefully preserved. Do we really use that?
3086 sub paydate_epoch_sql {
3088 my $table = shift || 'cust_main';
3089 my ($case1, $case2);
3090 if ( driver_name eq 'Pg' ) {
3091 $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
3092 $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
3094 elsif ( lc(driver_name) eq 'mysql' ) {
3095 $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
3096 $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
3099 return "CASE WHEN $table.payby IN('CARD','DCRD')
3105 =item tax_exemption TAXNAME
3110 my( $self, $taxname ) = @_;
3112 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3113 'taxname' => $taxname,
3118 =item cust_main_exemption
3122 sub cust_main_exemption {
3124 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
3127 =item invoicing_list [ ARRAYREF ]
3129 If an arguement is given, sets these email addresses as invoice recipients
3130 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3131 (except as warnings), so use check_invoicing_list first.
3133 Returns a list of email addresses (with svcnum entries expanded).
3135 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3136 check it without disturbing anything by passing nothing.
3138 This interface may change in the future.
3142 sub invoicing_list {
3143 my( $self, $arrayref ) = @_;
3146 my @cust_main_invoice;
3147 if ( $self->custnum ) {
3148 @cust_main_invoice =
3149 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3151 @cust_main_invoice = ();
3153 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3154 #warn $cust_main_invoice->destnum;
3155 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3156 #warn $cust_main_invoice->destnum;
3157 my $error = $cust_main_invoice->delete;
3158 warn $error if $error;
3161 if ( $self->custnum ) {
3162 @cust_main_invoice =
3163 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3165 @cust_main_invoice = ();
3167 my %seen = map { $_->address => 1 } @cust_main_invoice;
3168 foreach my $address ( @{$arrayref} ) {
3169 next if exists $seen{$address} && $seen{$address};
3170 $seen{$address} = 1;
3171 my $cust_main_invoice = new FS::cust_main_invoice ( {
3172 'custnum' => $self->custnum,
3175 my $error = $cust_main_invoice->insert;
3176 warn $error if $error;
3180 if ( $self->custnum ) {
3182 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3189 =item check_invoicing_list ARRAYREF
3191 Checks these arguements as valid input for the invoicing_list method. If there
3192 is an error, returns the error, otherwise returns false.
3196 sub check_invoicing_list {
3197 my( $self, $arrayref ) = @_;
3199 foreach my $address ( @$arrayref ) {
3201 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3202 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3205 my $cust_main_invoice = new FS::cust_main_invoice ( {
3206 'custnum' => $self->custnum,
3209 my $error = $self->custnum
3210 ? $cust_main_invoice->check
3211 : $cust_main_invoice->checkdest
3213 return $error if $error;
3217 return "Email address required"
3218 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3219 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3224 =item set_default_invoicing_list
3226 Sets the invoicing list to all accounts associated with this customer,
3227 overwriting any previous invoicing list.
3231 sub set_default_invoicing_list {
3233 $self->invoicing_list($self->all_emails);
3238 Returns the email addresses of all accounts provisioned for this customer.
3245 foreach my $cust_pkg ( $self->all_pkgs ) {
3246 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3248 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3249 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3251 $list{$_}=1 foreach map { $_->email } @svc_acct;
3256 =item invoicing_list_addpost
3258 Adds postal invoicing to this customer. If this customer is already configured
3259 to receive postal invoices, does nothing.
3263 sub invoicing_list_addpost {
3265 return if grep { $_ eq 'POST' } $self->invoicing_list;
3266 my @invoicing_list = $self->invoicing_list;
3267 push @invoicing_list, 'POST';
3268 $self->invoicing_list(\@invoicing_list);
3271 =item invoicing_list_emailonly
3273 Returns the list of email invoice recipients (invoicing_list without non-email
3274 destinations such as POST and FAX).
3278 sub invoicing_list_emailonly {
3280 warn "$me invoicing_list_emailonly called"
3282 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3285 =item invoicing_list_emailonly_scalar
3287 Returns the list of email invoice recipients (invoicing_list without non-email
3288 destinations such as POST and FAX) as a comma-separated scalar.
3292 sub invoicing_list_emailonly_scalar {
3294 warn "$me invoicing_list_emailonly_scalar called"
3296 join(', ', $self->invoicing_list_emailonly);
3299 =item referral_custnum_cust_main
3301 Returns the customer who referred this customer (or the empty string, if
3302 this customer was not referred).
3304 Note the difference with referral_cust_main method: This method,
3305 referral_custnum_cust_main returns the single customer (if any) who referred
3306 this customer, while referral_cust_main returns an array of customers referred
3311 sub referral_custnum_cust_main {
3313 return '' unless $self->referral_custnum;
3314 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3317 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3319 Returns an array of customers referred by this customer (referral_custnum set
3320 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3321 customers referred by customers referred by this customer and so on, inclusive.
3322 The default behavior is DEPTH 1 (no recursion).
3324 Note the difference with referral_custnum_cust_main method: This method,
3325 referral_cust_main, returns an array of customers referred BY this customer,
3326 while referral_custnum_cust_main returns the single customer (if any) who
3327 referred this customer.
3331 sub referral_cust_main {
3333 my $depth = @_ ? shift : 1;
3334 my $exclude = @_ ? shift : {};
3337 map { $exclude->{$_->custnum}++; $_; }
3338 grep { ! $exclude->{ $_->custnum } }
3339 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3343 map { $_->referral_cust_main($depth-1, $exclude) }
3350 =item referral_cust_main_ncancelled
3352 Same as referral_cust_main, except only returns customers with uncancelled
3357 sub referral_cust_main_ncancelled {
3359 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3362 =item referral_cust_pkg [ DEPTH ]
3364 Like referral_cust_main, except returns a flat list of all unsuspended (and
3365 uncancelled) packages for each customer. The number of items in this list may
3366 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3370 sub referral_cust_pkg {
3372 my $depth = @_ ? shift : 1;
3374 map { $_->unsuspended_pkgs }
3375 grep { $_->unsuspended_pkgs }
3376 $self->referral_cust_main($depth);
3379 =item referring_cust_main
3381 Returns the single cust_main record for the customer who referred this customer
3382 (referral_custnum), or false.
3386 sub referring_cust_main {
3388 return '' unless $self->referral_custnum;
3389 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3392 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3394 Applies a credit to this customer. If there is an error, returns the error,
3395 otherwise returns false.
3397 REASON can be a text string, an FS::reason object, or a scalar reference to
3398 a reasonnum. If a text string, it will be automatically inserted as a new
3399 reason, and a 'reason_type' option must be passed to indicate the
3400 FS::reason_type for the new reason.
3402 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3404 Any other options are passed to FS::cust_credit::insert.
3409 my( $self, $amount, $reason, %options ) = @_;
3411 my $cust_credit = new FS::cust_credit {
3412 'custnum' => $self->custnum,
3413 'amount' => $amount,
3416 if ( ref($reason) ) {
3418 if ( ref($reason) eq 'SCALAR' ) {
3419 $cust_credit->reasonnum( $$reason );
3421 $cust_credit->reasonnum( $reason->reasonnum );
3425 $cust_credit->set('reason', $reason)
3428 for (qw( addlinfo eventnum )) {
3429 $cust_credit->$_( delete $options{$_} )
3430 if exists($options{$_});
3433 $cust_credit->insert(%options);
3437 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3439 Creates a one-time charge for this customer. If there is an error, returns
3440 the error, otherwise returns false.
3442 New-style, with a hashref of options:
3444 my $error = $cust_main->charge(
3448 'start_date' => str2time('7/4/2009'),
3449 'pkg' => 'Description',
3450 'comment' => 'Comment',
3451 'additional' => [], #extra invoice detail
3452 'classnum' => 1, #pkg_class
3454 'setuptax' => '', # or 'Y' for tax exempt
3457 'taxclass' => 'Tax class',
3460 'taxproduct' => 2, #part_pkg_taxproduct
3461 'override' => {}, #XXX describe
3463 #will be filled in with the new object
3464 'cust_pkg_ref' => \$cust_pkg,
3466 #generate an invoice immediately
3468 'invoice_terms' => '', #with these terms
3474 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3480 my ( $amount, $quantity, $start_date, $classnum );
3481 my ( $pkg, $comment, $additional );
3482 my ( $setuptax, $taxclass ); #internal taxes
3483 my ( $taxproduct, $override ); #vendor (CCH) taxes
3485 my $cust_pkg_ref = '';
3486 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3487 if ( ref( $_[0] ) ) {
3488 $amount = $_[0]->{amount};
3489 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3490 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3491 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3492 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3493 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3494 : '$'. sprintf("%.2f",$amount);
3495 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3496 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3497 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3498 $additional = $_[0]->{additional} || [];
3499 $taxproduct = $_[0]->{taxproductnum};
3500 $override = { '' => $_[0]->{tax_override} };
3501 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3502 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3503 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3508 $pkg = @_ ? shift : 'One-time charge';
3509 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3511 $taxclass = @_ ? shift : '';
3515 local $SIG{HUP} = 'IGNORE';
3516 local $SIG{INT} = 'IGNORE';
3517 local $SIG{QUIT} = 'IGNORE';
3518 local $SIG{TERM} = 'IGNORE';
3519 local $SIG{TSTP} = 'IGNORE';
3520 local $SIG{PIPE} = 'IGNORE';
3522 my $oldAutoCommit = $FS::UID::AutoCommit;
3523 local $FS::UID::AutoCommit = 0;
3526 my $part_pkg = new FS::part_pkg ( {
3528 'comment' => $comment,
3532 'classnum' => ( $classnum ? $classnum : '' ),
3533 'setuptax' => $setuptax,
3534 'taxclass' => $taxclass,
3535 'taxproductnum' => $taxproduct,
3538 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3539 ( 0 .. @$additional - 1 )
3541 'additional_count' => scalar(@$additional),
3542 'setup_fee' => $amount,
3545 my $error = $part_pkg->insert( options => \%options,
3546 tax_overrides => $override,
3549 $dbh->rollback if $oldAutoCommit;
3553 my $pkgpart = $part_pkg->pkgpart;
3554 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3555 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3556 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3557 $error = $type_pkgs->insert;
3559 $dbh->rollback if $oldAutoCommit;
3564 my $cust_pkg = new FS::cust_pkg ( {
3565 'custnum' => $self->custnum,
3566 'pkgpart' => $pkgpart,
3567 'quantity' => $quantity,
3568 'start_date' => $start_date,
3569 'no_auto' => $no_auto,
3572 $error = $cust_pkg->insert;
3574 $dbh->rollback if $oldAutoCommit;
3576 } elsif ( $cust_pkg_ref ) {
3577 ${$cust_pkg_ref} = $cust_pkg;
3581 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3582 'pkg_list' => [ $cust_pkg ],
3585 $dbh->rollback if $oldAutoCommit;
3590 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3595 #=item charge_postal_fee
3597 #Applies a one time charge this customer. If there is an error,
3598 #returns the error, returns the cust_pkg charge object or false
3599 #if there was no charge.
3603 # This should be a customer event. For that to work requires that bill
3604 # also be a customer event.
3606 sub charge_postal_fee {
3609 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3610 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3612 my $cust_pkg = new FS::cust_pkg ( {
3613 'custnum' => $self->custnum,
3614 'pkgpart' => $pkgpart,
3618 my $error = $cust_pkg->insert;
3619 $error ? $error : $cust_pkg;
3622 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3624 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3626 Optionally, a list or hashref of additional arguments to the qsearch call can
3633 my $opt = ref($_[0]) ? shift : { @_ };
3635 #return $self->num_cust_bill unless wantarray || keys %$opt;
3637 $opt->{'table'} = 'cust_bill';
3638 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3639 $opt->{'hashref'}{'custnum'} = $self->custnum;
3640 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3642 map { $_ } #behavior of sort undefined in scalar context
3643 sort { $a->_date <=> $b->_date }
3647 =item open_cust_bill
3649 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3654 sub open_cust_bill {
3658 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3664 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3666 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3670 sub legacy_cust_bill {
3673 #return $self->num_legacy_cust_bill unless wantarray;
3675 map { $_ } #behavior of sort undefined in scalar context
3676 sort { $a->_date <=> $b->_date }
3677 qsearch({ 'table' => 'legacy_cust_bill',
3678 'hashref' => { 'custnum' => $self->custnum, },
3679 'order_by' => 'ORDER BY _date ASC',
3683 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3685 Returns all the statements (see L<FS::cust_statement>) for this customer.
3687 Optionally, a list or hashref of additional arguments to the qsearch call can
3692 sub cust_statement {
3694 my $opt = ref($_[0]) ? shift : { @_ };
3696 #return $self->num_cust_statement unless wantarray || keys %$opt;
3698 $opt->{'table'} = 'cust_statement';
3699 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3700 $opt->{'hashref'}{'custnum'} = $self->custnum;
3701 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3703 map { $_ } #behavior of sort undefined in scalar context
3704 sort { $a->_date <=> $b->_date }
3708 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3710 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3712 Optionally, a list or hashref of additional arguments to the qsearch call can
3713 be passed following the SVCDB.
3720 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3721 warn "$me svc_x requires a svcdb";
3724 my $opt = ref($_[0]) ? shift : { @_ };
3726 $opt->{'table'} = $svcdb;
3727 $opt->{'addl_from'} =
3728 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3729 ($opt->{'addl_from'} || '');
3731 my $custnum = $self->custnum;
3732 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3733 my $where = "cust_pkg.custnum = $custnum";
3735 my $extra_sql = $opt->{'extra_sql'} || '';
3736 if ( keys %{ $opt->{'hashref'} } ) {
3737 $extra_sql = " AND $where $extra_sql";
3740 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3741 $extra_sql = "WHERE $where AND $1";
3744 $extra_sql = "WHERE $where $extra_sql";
3747 $opt->{'extra_sql'} = $extra_sql;
3752 # required for use as an eventtable;
3755 $self->svc_x('svc_acct', @_);
3760 Returns all the credits (see L<FS::cust_credit>) for this customer.
3766 map { $_ } #return $self->num_cust_credit unless wantarray;
3767 sort { $a->_date <=> $b->_date }
3768 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3771 =item cust_credit_pkgnum
3773 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3774 package when using experimental package balances.
3778 sub cust_credit_pkgnum {
3779 my( $self, $pkgnum ) = @_;
3780 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3781 sort { $a->_date <=> $b->_date }
3782 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3783 'pkgnum' => $pkgnum,
3790 Returns all the payments (see L<FS::cust_pay>) for this customer.
3796 return $self->num_cust_pay unless wantarray;
3797 sort { $a->_date <=> $b->_date }
3798 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3803 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3804 called automatically when the cust_pay method is used in a scalar context.
3810 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3811 my $sth = dbh->prepare($sql) or die dbh->errstr;
3812 $sth->execute($self->custnum) or die $sth->errstr;
3813 $sth->fetchrow_arrayref->[0];
3816 =item cust_pay_pkgnum
3818 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3819 package when using experimental package balances.
3823 sub cust_pay_pkgnum {
3824 my( $self, $pkgnum ) = @_;
3825 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3826 sort { $a->_date <=> $b->_date }
3827 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3828 'pkgnum' => $pkgnum,
3835 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3841 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3842 sort { $a->_date <=> $b->_date }
3843 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3846 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3848 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
3850 Optionally, a list or hashref of additional arguments to the qsearch call can
3855 sub cust_pay_batch {
3857 my $opt = ref($_[0]) ? shift : { @_ };
3859 #return $self->num_cust_statement unless wantarray || keys %$opt;
3861 $opt->{'table'} = 'cust_pay_batch';
3862 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3863 $opt->{'hashref'}{'custnum'} = $self->custnum;
3864 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3866 map { $_ } #behavior of sort undefined in scalar context
3867 sort { $a->paybatchnum <=> $b->paybatchnum }
3871 =item cust_pay_pending
3873 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3874 (without status "done").
3878 sub cust_pay_pending {
3880 return $self->num_cust_pay_pending unless wantarray;
3881 sort { $a->_date <=> $b->_date }
3882 qsearch( 'cust_pay_pending', {
3883 'custnum' => $self->custnum,
3884 'status' => { op=>'!=', value=>'done' },
3889 =item cust_pay_pending_attempt
3891 Returns all payment attempts / declined payments for this customer, as pending
3892 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3893 a corresponding payment (see L<FS::cust_pay>).
3897 sub cust_pay_pending_attempt {
3899 return $self->num_cust_pay_pending_attempt unless wantarray;
3900 sort { $a->_date <=> $b->_date }
3901 qsearch( 'cust_pay_pending', {
3902 'custnum' => $self->custnum,
3909 =item num_cust_pay_pending
3911 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3912 customer (without status "done"). Also called automatically when the
3913 cust_pay_pending method is used in a scalar context.
3917 sub num_cust_pay_pending {
3920 " SELECT COUNT(*) FROM cust_pay_pending ".
3921 " WHERE custnum = ? AND status != 'done' ",
3926 =item num_cust_pay_pending_attempt
3928 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3929 customer, with status "done" but without a corresp. Also called automatically when the
3930 cust_pay_pending method is used in a scalar context.
3934 sub num_cust_pay_pending_attempt {
3937 " SELECT COUNT(*) FROM cust_pay_pending ".
3938 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3945 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3951 map { $_ } #return $self->num_cust_refund unless wantarray;
3952 sort { $a->_date <=> $b->_date }
3953 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3956 =item display_custnum
3958 Returns the displayed customer number for this customer: agent_custid if
3959 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3963 sub display_custnum {
3966 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3967 if ( my $special = $conf->config('cust_main-custnum-display_special') ) {
3968 if ( $special eq 'CoStAg' ) {
3969 $prefix = uc( join('',
3971 ($self->state =~ /^(..)/),
3972 $prefix || ($self->agent->agent =~ /^(..)/)
3975 elsif ( $special eq 'CoStCl' ) {
3976 $prefix = uc( join('',
3978 ($self->state =~ /^(..)/),
3979 ($self->classnum ? $self->cust_class->classname =~ /^(..)/ : '__')
3982 # add any others here if needed
3985 my $length = $conf->config('cust_main-custnum-display_length');
3986 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3987 return $self->agent_custid;
3988 } elsif ( $prefix ) {
3989 $length = 8 if !defined($length);
3991 sprintf('%0'.$length.'d', $self->custnum)
3992 } elsif ( $length ) {
3993 return sprintf('%0'.$length.'d', $self->custnum);
3995 return $self->custnum;
4001 Returns a name string for this customer, either "Company (Last, First)" or
4008 my $name = $self->contact;
4009 $name = $self->company. " ($name)" if $self->company;
4015 Returns a name string for this (service/shipping) contact, either
4016 "Company (Last, First)" or "Last, First".
4022 if ( $self->get('ship_last') ) {
4023 my $name = $self->ship_contact;
4024 $name = $self->ship_company. " ($name)" if $self->ship_company;
4033 Returns a name string for this customer, either "Company" or "First Last".
4039 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4042 =item ship_name_short
4044 Returns a name string for this (service/shipping) contact, either "Company"
4049 sub ship_name_short {
4051 if ( $self->get('ship_last') ) {
4052 $self->ship_company !~ /^\s*$/
4053 ? $self->ship_company
4054 : $self->ship_contact_firstlast;
4056 $self->name_company_or_firstlast;
4062 Returns this customer's full (billing) contact name only, "Last, First"
4068 $self->get('last'). ', '. $self->first;
4073 Returns this customer's full (shipping) contact name only, "Last, First"
4079 $self->get('ship_last')
4080 ? $self->get('ship_last'). ', '. $self->ship_first
4084 =item contact_firstlast
4086 Returns this customers full (billing) contact name only, "First Last".
4090 sub contact_firstlast {
4092 $self->first. ' '. $self->get('last');
4095 =item ship_contact_firstlast
4097 Returns this customer's full (shipping) contact name only, "First Last".
4101 sub ship_contact_firstlast {
4103 $self->get('ship_last')
4104 ? $self->first. ' '. $self->get('ship_last')
4105 : $self->contact_firstlast;
4110 Returns this customer's full country name
4116 code2country($self->country);
4119 =item geocode DATA_VENDOR
4121 Returns a value for the customer location as encoded by DATA_VENDOR.
4122 Currently this only makes sense for "CCH" as DATA_VENDOR.
4130 Returns a status string for this customer, currently:
4134 =item prospect - No packages have ever been ordered
4136 =item ordered - Recurring packages all are new (not yet billed).
4138 =item active - One or more recurring packages is active
4140 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4142 =item suspended - All non-cancelled recurring packages are suspended
4144 =item cancelled - All recurring packages are cancelled
4148 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4149 cust_main-status_module configuration option.
4153 sub status { shift->cust_status(@_); }
4157 for my $status ( FS::cust_main->statuses() ) {
4158 my $method = $status.'_sql';
4159 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4160 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4161 $sth->execute( ($self->custnum) x $numnum )
4162 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4163 return $status if $sth->fetchrow_arrayref->[0];
4167 =item ucfirst_cust_status
4169 =item ucfirst_status
4171 Returns the status with the first character capitalized.
4175 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4177 sub ucfirst_cust_status {
4179 ucfirst($self->cust_status);
4184 Returns a hex triplet color string for this customer's status.
4188 sub statuscolor { shift->cust_statuscolor(@_); }
4190 sub cust_statuscolor {
4192 __PACKAGE__->statuscolors->{$self->cust_status};
4197 Returns an array of hashes representing the customer's RT tickets.
4204 my $num = $conf->config('cust_main-max_tickets') || 10;
4207 if ( $conf->config('ticket_system') ) {
4208 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4210 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4214 foreach my $priority (
4215 $conf->config('ticket_system-custom_priority_field-values'), ''
4217 last if scalar(@tickets) >= $num;
4219 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4220 $num - scalar(@tickets),
4230 # Return services representing svc_accts in customer support packages
4231 sub support_services {
4233 my %packages = map { $_ => 1 } $conf->config('support_packages');
4235 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4236 grep { $_->part_svc->svcdb eq 'svc_acct' }
4237 map { $_->cust_svc }
4238 grep { exists $packages{ $_->pkgpart } }
4239 $self->ncancelled_pkgs;
4243 # Return a list of latitude/longitude for one of the services (if any)
4244 sub service_coordinates {
4248 grep { $_->latitude && $_->longitude }
4250 map { $_->cust_svc }
4251 $self->ncancelled_pkgs;
4253 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4258 Returns a masked version of the named field
4263 my ($self,$field) = @_;
4267 'x'x(length($self->getfield($field))-4).
4268 substr($self->getfield($field), (length($self->getfield($field))-4));
4274 =head1 CLASS METHODS
4280 Class method that returns the list of possible status strings for customers
4281 (see L<the status method|/status>). For example:
4283 @statuses = FS::cust_main->statuses();
4289 keys %{ $self->statuscolors };
4292 =item cust_status_sql
4294 Returns an SQL fragment to determine the status of a cust_main record, as a
4299 sub cust_status_sql {
4301 for my $status ( FS::cust_main->statuses() ) {
4302 my $method = $status.'_sql';
4303 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4312 Returns an SQL expression identifying prospective cust_main records (customers
4313 with no packages ever ordered)
4317 use vars qw($select_count_pkgs);
4318 $select_count_pkgs =
4319 "SELECT COUNT(*) FROM cust_pkg
4320 WHERE cust_pkg.custnum = cust_main.custnum";
4322 sub select_count_pkgs_sql {
4327 " 0 = ( $select_count_pkgs ) ";
4332 Returns an SQL expression identifying ordered cust_main records (customers with
4333 no active packages, but recurring packages not yet setup or one time charges
4339 FS::cust_main->none_active_sql.
4340 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4345 Returns an SQL expression identifying active cust_main records (customers with
4346 active recurring packages).
4351 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4354 =item none_active_sql
4356 Returns an SQL expression identifying cust_main records with no active
4357 recurring packages. This includes customers of status prospect, ordered,
4358 inactive, and suspended.
4362 sub none_active_sql {
4363 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4368 Returns an SQL expression identifying inactive cust_main records (customers with
4369 no active recurring packages, but otherwise unsuspended/uncancelled).
4374 FS::cust_main->none_active_sql.
4375 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4381 Returns an SQL expression identifying suspended cust_main records.
4386 sub suspended_sql { susp_sql(@_); }
4388 FS::cust_main->none_active_sql.
4389 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4395 Returns an SQL expression identifying cancelled cust_main records.
4399 sub cancel_sql { shift->cancelled_sql(@_); }
4402 =item uncancelled_sql
4404 Returns an SQL expression identifying un-cancelled cust_main records.
4408 sub uncancelled_sql { uncancel_sql(@_); }
4409 sub uncancel_sql { "
4410 ( 0 < ( $select_count_pkgs
4411 AND ( cust_pkg.cancel IS NULL
4412 OR cust_pkg.cancel = 0
4415 OR 0 = ( $select_count_pkgs )
4421 Returns an SQL fragment to retreive the balance.
4426 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4427 WHERE cust_bill.custnum = cust_main.custnum )
4428 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4429 WHERE cust_pay.custnum = cust_main.custnum )
4430 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4431 WHERE cust_credit.custnum = cust_main.custnum )
4432 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4433 WHERE cust_refund.custnum = cust_main.custnum )
4436 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4438 Returns an SQL fragment to retreive the balance for this customer, optionally
4439 considering invoices with date earlier than START_TIME, and not
4440 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4441 total_unapplied_payments).
4443 Times are specified as SQL fragments or numeric
4444 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4445 L<Date::Parse> for conversion functions. The empty string can be passed
4446 to disable that time constraint completely.
4448 Available options are:
4452 =item unapplied_date
4454 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)
4459 set to true to remove all customer comparison clauses, for totals
4464 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4469 JOIN clause (typically used with the total option)
4473 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4474 time will be ignored. Note that START_TIME and END_TIME only limit the date
4475 range for invoices and I<unapplied> payments, credits, and refunds.
4481 sub balance_date_sql {
4482 my( $class, $start, $end, %opt ) = @_;
4484 my $cutoff = $opt{'cutoff'};
4486 my $owed = FS::cust_bill->owed_sql($cutoff);
4487 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4488 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4489 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4491 my $j = $opt{'join'} || '';
4493 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4494 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4495 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4496 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4498 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4499 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4500 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4501 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4506 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4508 Returns an SQL fragment to retreive the total unapplied payments for this
4509 customer, only considering payments with date earlier than START_TIME, and
4510 optionally not later than END_TIME.
4512 Times are specified as SQL fragments or numeric
4513 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4514 L<Date::Parse> for conversion functions. The empty string can be passed
4515 to disable that time constraint completely.
4517 Available options are:
4521 sub unapplied_payments_date_sql {
4522 my( $class, $start, $end, %opt ) = @_;
4524 my $cutoff = $opt{'cutoff'};
4526 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4528 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4529 'unapplied_date'=>1 );
4531 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4534 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4536 Helper method for balance_date_sql; name (and usage) subject to change
4537 (suggestions welcome).
4539 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4540 cust_refund, cust_credit or cust_pay).
4542 If TABLE is "cust_bill" or the unapplied_date option is true, only
4543 considers records with date earlier than START_TIME, and optionally not
4544 later than END_TIME .
4548 sub _money_table_where {
4549 my( $class, $table, $start, $end, %opt ) = @_;
4552 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4553 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4554 push @where, "$table._date <= $start" if defined($start) && length($start);
4555 push @where, "$table._date > $end" if defined($end) && length($end);
4557 push @where, @{$opt{'where'}} if $opt{'where'};
4558 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4564 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4565 use FS::cust_main::Search;
4568 FS::cust_main::Search->search(@_);
4583 #warn join('-',keys %$param);
4584 my $fh = $param->{filehandle};
4585 my $agentnum = $param->{agentnum};
4586 my $format = $param->{format};
4588 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
4591 if ( $format eq 'simple' ) {
4592 @fields = qw( custnum agent_custid amount pkg );
4594 die "unknown format $format";
4597 eval "use Text::CSV_XS;";
4600 my $csv = new Text::CSV_XS;
4607 local $SIG{HUP} = 'IGNORE';
4608 local $SIG{INT} = 'IGNORE';
4609 local $SIG{QUIT} = 'IGNORE';
4610 local $SIG{TERM} = 'IGNORE';
4611 local $SIG{TSTP} = 'IGNORE';
4612 local $SIG{PIPE} = 'IGNORE';
4614 my $oldAutoCommit = $FS::UID::AutoCommit;
4615 local $FS::UID::AutoCommit = 0;
4618 #while ( $columns = $csv->getline($fh) ) {
4620 while ( defined($line=<$fh>) ) {
4622 $csv->parse($line) or do {
4623 $dbh->rollback if $oldAutoCommit;
4624 return "can't parse: ". $csv->error_input();
4627 my @columns = $csv->fields();
4628 #warn join('-',@columns);
4631 foreach my $field ( @fields ) {
4632 $row{$field} = shift @columns;
4635 if ( $row{custnum} && $row{agent_custid} ) {
4636 dbh->rollback if $oldAutoCommit;
4637 return "can't specify custnum with agent_custid $row{agent_custid}";
4641 if ( $row{agent_custid} && $agentnum ) {
4642 %hash = ( 'agent_custid' => $row{agent_custid},
4643 'agentnum' => $agentnum,
4647 if ( $row{custnum} ) {
4648 %hash = ( 'custnum' => $row{custnum} );
4651 unless ( scalar(keys %hash) ) {
4652 $dbh->rollback if $oldAutoCommit;
4653 return "can't find customer without custnum or agent_custid and agentnum";
4656 my $cust_main = qsearchs('cust_main', { %hash } );
4657 unless ( $cust_main ) {
4658 $dbh->rollback if $oldAutoCommit;
4659 my $custnum = $row{custnum} || $row{agent_custid};
4660 return "unknown custnum $custnum";
4663 if ( $row{'amount'} > 0 ) {
4664 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4666 $dbh->rollback if $oldAutoCommit;
4670 } elsif ( $row{'amount'} < 0 ) {
4671 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4674 $dbh->rollback if $oldAutoCommit;
4684 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4686 return "Empty file!" unless $imported;
4692 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4694 Deprecated. Use event notification and message templates
4695 (L<FS::msg_template>) instead.
4697 Sends a templated email notification to the customer (see L<Text::Template>).
4699 OPTIONS is a hash and may include
4701 I<from> - the email sender (default is invoice_from)
4703 I<to> - comma-separated scalar or arrayref of recipients
4704 (default is invoicing_list)
4706 I<subject> - The subject line of the sent email notification
4707 (default is "Notice from company_name")
4709 I<extra_fields> - a hashref of name/value pairs which will be substituted
4712 The following variables are vavailable in the template.
4714 I<$first> - the customer first name
4715 I<$last> - the customer last name
4716 I<$company> - the customer company
4717 I<$payby> - a description of the method of payment for the customer
4718 # would be nice to use FS::payby::shortname
4719 I<$payinfo> - the account information used to collect for this customer
4720 I<$expdate> - the expiration of the customer payment in seconds from epoch
4725 my ($self, $template, %options) = @_;
4727 return unless $conf->exists($template);
4729 my $from = $conf->config('invoice_from', $self->agentnum)
4730 if $conf->exists('invoice_from', $self->agentnum);
4731 $from = $options{from} if exists($options{from});
4733 my $to = join(',', $self->invoicing_list_emailonly);
4734 $to = $options{to} if exists($options{to});
4736 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4737 if $conf->exists('company_name', $self->agentnum);
4738 $subject = $options{subject} if exists($options{subject});
4740 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4741 SOURCE => [ map "$_\n",
4742 $conf->config($template)]
4744 or die "can't create new Text::Template object: Text::Template::ERROR";
4745 $notify_template->compile()
4746 or die "can't compile template: Text::Template::ERROR";
4748 $FS::notify_template::_template::company_name =
4749 $conf->config('company_name', $self->agentnum);
4750 $FS::notify_template::_template::company_address =
4751 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4753 my $paydate = $self->paydate || '2037-12-31';
4754 $FS::notify_template::_template::first = $self->first;
4755 $FS::notify_template::_template::last = $self->last;
4756 $FS::notify_template::_template::company = $self->company;
4757 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4758 my $payby = $self->payby;
4759 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4760 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4762 #credit cards expire at the end of the month/year of their exp date
4763 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4764 $FS::notify_template::_template::payby = 'credit card';
4765 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4766 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4768 }elsif ($payby eq 'COMP') {
4769 $FS::notify_template::_template::payby = 'complimentary account';
4771 $FS::notify_template::_template::payby = 'current method';
4773 $FS::notify_template::_template::expdate = $expire_time;
4775 for (keys %{$options{extra_fields}}){
4777 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4780 send_email(from => $from,
4782 subject => $subject,
4783 body => $notify_template->fill_in( PACKAGE =>
4784 'FS::notify_template::_template' ),
4789 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4791 Generates a templated notification to the customer (see L<Text::Template>).
4793 OPTIONS is a hash and may include
4795 I<extra_fields> - a hashref of name/value pairs which will be substituted
4796 into the template. These values may override values mentioned below
4797 and those from the customer record.
4799 The following variables are available in the template instead of or in addition
4800 to the fields of the customer record.
4802 I<$payby> - a description of the method of payment for the customer
4803 # would be nice to use FS::payby::shortname
4804 I<$payinfo> - the masked account information used to collect for this customer
4805 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4806 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4810 # a lot like cust_bill::print_latex
4811 sub generate_letter {
4812 my ($self, $template, %options) = @_;
4814 return unless $conf->exists($template);
4816 my $letter_template = new Text::Template
4818 SOURCE => [ map "$_\n", $conf->config($template)],
4819 DELIMITERS => [ '[@--', '--@]' ],
4821 or die "can't create new Text::Template object: Text::Template::ERROR";
4823 $letter_template->compile()
4824 or die "can't compile template: Text::Template::ERROR";
4826 my %letter_data = map { $_ => $self->$_ } $self->fields;
4827 $letter_data{payinfo} = $self->mask_payinfo;
4829 #my $paydate = $self->paydate || '2037-12-31';
4830 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4832 my $payby = $self->payby;
4833 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4834 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4836 #credit cards expire at the end of the month/year of their exp date
4837 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4838 $letter_data{payby} = 'credit card';
4839 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4840 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4842 }elsif ($payby eq 'COMP') {
4843 $letter_data{payby} = 'complimentary account';
4845 $letter_data{payby} = 'current method';
4847 $letter_data{expdate} = $expire_time;
4849 for (keys %{$options{extra_fields}}){
4850 $letter_data{$_} = $options{extra_fields}->{$_};
4853 unless(exists($letter_data{returnaddress})){
4854 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4855 $self->agent_template)
4857 if ( length($retadd) ) {
4858 $letter_data{returnaddress} = $retadd;
4859 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4860 $letter_data{returnaddress} =
4861 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4865 ( $conf->config('company_name', $self->agentnum),
4866 $conf->config('company_address', $self->agentnum),
4870 $letter_data{returnaddress} = '~';
4874 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4876 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4878 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4880 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4884 ) or die "can't open temp file: $!\n";
4885 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4886 or die "can't write temp file: $!\n";
4888 $letter_data{'logo_file'} = $lh->filename;
4890 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4894 ) or die "can't open temp file: $!\n";
4896 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4898 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4899 return ($1, $letter_data{'logo_file'});
4903 =item print_ps TEMPLATE
4905 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4911 my($file, $lfile) = $self->generate_letter(@_);
4912 my $ps = FS::Misc::generate_ps($file);
4913 unlink($file.'.tex');
4919 =item print TEMPLATE
4921 Prints the filled in template.
4923 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4927 sub queueable_print {
4930 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4931 or die "invalid customer number: " . $opt{custvnum};
4933 my $error = $self->print( $opt{template} );
4934 die $error if $error;
4938 my ($self, $template) = (shift, shift);
4939 do_print [ $self->print_ps($template) ];
4942 #these three subs should just go away once agent stuff is all config overrides
4944 sub agent_template {
4946 $self->_agent_plandata('agent_templatename');
4949 sub agent_invoice_from {
4951 $self->_agent_plandata('agent_invoice_from');
4954 sub _agent_plandata {
4955 my( $self, $option ) = @_;
4957 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
4958 #agent-specific Conf
4960 use FS::part_event::Condition;
4962 my $agentnum = $self->agentnum;
4964 my $regexp = regexp_sql();
4966 my $part_event_option =
4968 'select' => 'part_event_option.*',
4969 'table' => 'part_event_option',
4971 LEFT JOIN part_event USING ( eventpart )
4972 LEFT JOIN part_event_option AS peo_agentnum
4973 ON ( part_event.eventpart = peo_agentnum.eventpart
4974 AND peo_agentnum.optionname = 'agentnum'
4975 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4977 LEFT JOIN part_event_condition
4978 ON ( part_event.eventpart = part_event_condition.eventpart
4979 AND part_event_condition.conditionname = 'cust_bill_age'
4981 LEFT JOIN part_event_condition_option
4982 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4983 AND part_event_condition_option.optionname = 'age'
4986 #'hashref' => { 'optionname' => $option },
4987 #'hashref' => { 'part_event_option.optionname' => $option },
4989 " WHERE part_event_option.optionname = ". dbh->quote($option).
4990 " AND action = 'cust_bill_send_agent' ".
4991 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
4992 " AND peo_agentnum.optionname = 'agentnum' ".
4993 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
4995 CASE WHEN part_event_condition_option.optionname IS NULL
4997 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
4999 , part_event.weight".
5003 unless ( $part_event_option ) {
5004 return $self->agent->invoice_template || ''
5005 if $option eq 'agent_templatename';
5009 $part_event_option->optionvalue;
5013 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5015 Subroutine (not a method), designed to be called from the queue.
5017 Takes a list of options and values.
5019 Pulls up the customer record via the custnum option and calls bill_and_collect.
5024 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5026 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5027 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5029 $cust_main->bill_and_collect( %args );
5032 sub process_bill_and_collect {
5034 my $param = thaw(decode_base64(shift));
5035 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5036 or die "custnum '$param->{custnum}' not found!\n";
5037 $param->{'job'} = $job;
5038 $param->{'fatal'} = 1; # runs from job queue, will be caught
5039 $param->{'retry'} = 1;
5041 $cust_main->bill_and_collect( %$param );
5044 =item process_censustract_update CUSTNUM
5046 Queueable function to update the census tract to the current year (as set in
5047 the 'census_year' configuration variable) and retrieve the new tract code.
5051 sub process_censustract_update {
5052 eval "use FS::Misc::Geo qw(get_censustract)";
5054 my $custnum = shift;
5055 my $cust_main = qsearchs( 'cust_main', { custnum => $custnum })
5056 or die "custnum '$custnum' not found!\n";
5058 my $new_year = $conf->config('census_year') or return;
5059 my $new_tract = get_censustract({ $cust_main->location_hash }, $new_year);
5060 if ( $new_tract =~ /^\d/ ) {
5061 # then it's a tract code
5062 $cust_main->set('censustract', $new_tract);
5063 $cust_main->set('censusyear', $new_year);
5065 local($ignore_expired_card) = 1;
5066 local($ignore_illegal_zip) = 1;
5067 local($ignore_banned_card) = 1;
5068 local($skip_fuzzyfiles) = 1;
5069 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5070 my $error = $cust_main->replace;
5071 die $error if $error;
5074 # it's an error message
5080 sub _upgrade_data { #class method
5081 my ($class, %opts) = @_;
5084 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5085 'UPDATE cust_main SET signupdate = (SELECT signupdate FROM h_cust_main WHERE signupdate IS NOT NULL AND h_cust_main.custnum = cust_main.custnum ORDER BY historynum DESC LIMIT 1) WHERE signupdate IS NULL',
5087 # fix yyyy-m-dd formatted paydates
5088 if ( driver_name =~ /^mysql/i ) {
5090 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5092 else { # the SQL standard
5094 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5097 push @statements, #fix the weird BILL with a cc# in payinfo problem
5099 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5101 foreach my $sql ( @statements ) {
5102 my $sth = dbh->prepare($sql) or die dbh->errstr;
5103 $sth->execute or die $sth->errstr;
5106 local($ignore_expired_card) = 1;
5107 local($ignore_illegal_zip) = 1;
5108 local($ignore_banned_card) = 1;
5109 local($skip_fuzzyfiles) = 1;
5110 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5111 $class->_upgrade_otaker(%opts);
5121 The delete method should possibly take an FS::cust_main object reference
5122 instead of a scalar customer number.
5124 Bill and collect options should probably be passed as references instead of a
5127 There should probably be a configuration file with a list of allowed credit
5130 No multiple currency support (probably a larger project than just this module).
5132 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5134 Birthdates rely on negative epoch values.
5136 The payby for card/check batches is broken. With mixed batching, bad
5139 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5143 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5144 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5145 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.