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
13 use vars qw( $DEBUG $me $conf
16 $ignore_expired_card $ignore_illegal_zip $ignore_banned_card
17 $skip_fuzzyfiles @fuzzyfields
21 use Scalar::Util qw( blessed );
22 use Time::Local qw(timelocal);
23 use Storable qw(thaw);
27 use Digest::MD5 qw(md5_base64);
30 use File::Temp; #qw( tempfile );
31 use Business::CreditCard 0.28;
33 use FS::UID qw( getotaker dbh driver_name );
34 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
35 use FS::Misc qw( generate_email send_email generate_ps do_print );
36 use FS::Msgcat qw(gettext);
44 use FS::cust_pay_pending;
45 use FS::cust_pay_void;
46 use FS::cust_pay_batch;
49 use FS::part_referral;
50 use FS::cust_main_county;
51 use FS::cust_location;
53 use FS::cust_main_exemption;
54 use FS::cust_tax_adjustment;
55 use FS::cust_tax_location;
57 use FS::cust_main_invoice;
59 use FS::prepay_credit;
65 use FS::payment_gateway;
66 use FS::agent_payment_gateway;
68 use FS::cust_main_note;
69 use FS::cust_attachment;
72 # 1 is mostly method/subroutine entry and options
73 # 2 traces progress of some operations
74 # 3 is even more information including possibly sensitive data
76 $me = '[FS::cust_main]';
79 $ignore_expired_card = 0;
80 $ignore_illegal_zip = 0;
81 $ignore_banned_card = 0;
84 @fuzzyfields = ( 'first', 'last', 'company', 'address1' );
86 @encrypted_fields = ('payinfo', 'paycvv');
87 sub nohistory_fields { ('payinfo', 'paycvv'); }
89 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
91 #ask FS::UID to run this stuff for us later
92 #$FS::UID::callback{'FS::cust_main'} = sub {
93 install_callback FS::UID sub {
95 #yes, need it for stuff below (prolly should be cached)
100 my ( $hashref, $cache ) = @_;
101 if ( exists $hashref->{'pkgnum'} ) {
102 #@{ $self->{'_pkgnum'} } = ();
103 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
104 $self->{'_pkgnum'} = $subcache;
105 #push @{ $self->{'_pkgnum'} },
106 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
112 FS::cust_main - Object methods for cust_main records
118 $record = new FS::cust_main \%hash;
119 $record = new FS::cust_main { 'column' => 'value' };
121 $error = $record->insert;
123 $error = $new_record->replace($old_record);
125 $error = $record->delete;
127 $error = $record->check;
129 @cust_pkg = $record->all_pkgs;
131 @cust_pkg = $record->ncancelled_pkgs;
133 @cust_pkg = $record->suspended_pkgs;
135 $error = $record->bill;
136 $error = $record->bill %options;
137 $error = $record->bill 'time' => $time;
139 $error = $record->collect;
140 $error = $record->collect %options;
141 $error = $record->collect 'invoice_time' => $time,
146 An FS::cust_main object represents a customer. FS::cust_main inherits from
147 FS::Record. The following fields are currently supported:
153 Primary key (assigned automatically for new customers)
157 Agent (see L<FS::agent>)
161 Advertising source (see L<FS::part_referral>)
173 Cocial security number (optional)
189 (optional, see L<FS::cust_main_county>)
193 (see L<FS::cust_main_county>)
199 (see L<FS::cust_main_county>)
235 (optional, see L<FS::cust_main_county>)
239 (see L<FS::cust_main_county>)
245 (see L<FS::cust_main_county>)
261 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
265 Payment Information (See L<FS::payinfo_Mixin> for data format)
269 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
273 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
277 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
281 Start date month (maestro/solo cards only)
285 Start date year (maestro/solo cards only)
289 Issue number (maestro/solo cards only)
293 Name on card or billing name
297 IP address from which payment information was received
301 Tax exempt, empty or `Y'
305 Order taker (see L<FS::access_user>)
311 =item referral_custnum
313 Referring customer number
317 Enable individual CDR spooling, empty or `Y'
321 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
325 Discourage individual CDR printing, empty or `Y'
329 Allow self-service editing of ticket subjects, empty or 'Y'
339 Creates a new customer. To add the customer to the database, see L<"insert">.
341 Note that this stores the hash reference, not a distinct copy of the hash it
342 points to. You can ask the object for a copy with the I<hash> method.
346 sub table { 'cust_main'; }
348 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
350 Adds this customer to the database. If there is an error, returns the error,
351 otherwise returns false.
353 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
354 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
355 are inserted atomicly, or the transaction is rolled back. Passing an empty
356 hash reference is equivalent to not supplying this parameter. There should be
357 a better explanation of this, but until then, here's an example:
360 tie %hash, 'Tie::RefHash'; #this part is important
362 $cust_pkg => [ $svc_acct ],
365 $cust_main->insert( \%hash );
367 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
368 be set as the invoicing list (see L<"invoicing_list">). Errors return as
369 expected and rollback the entire transaction; it is not necessary to call
370 check_invoicing_list first. The invoicing_list is set after the records in the
371 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
372 invoicing_list destination to the newly-created svc_acct. Here's an example:
374 $cust_main->insert( {}, [ $email, 'POST' ] );
376 Currently available options are: I<depend_jobnum>, I<noexport>,
377 I<tax_exemption> and I<prospectnum>.
379 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
380 on the supplied jobnum (they will not run until the specific job completes).
381 This can be used to defer provisioning until some action completes (such
382 as running the customer's credit card successfully).
384 The I<noexport> option is deprecated. If I<noexport> is set true, no
385 provisioning jobs (exports) are scheduled. (You can schedule them later with
386 the B<reexport> method.)
388 The I<tax_exemption> option can be set to an arrayref of tax names.
389 FS::cust_main_exemption records will be created and inserted.
391 If I<prospectnum> is set, moves contacts and locations from that prospect.
397 my $cust_pkgs = @_ ? shift : {};
398 my $invoicing_list = @_ ? shift : '';
400 warn "$me insert called with options ".
401 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
404 local $SIG{HUP} = 'IGNORE';
405 local $SIG{INT} = 'IGNORE';
406 local $SIG{QUIT} = 'IGNORE';
407 local $SIG{TERM} = 'IGNORE';
408 local $SIG{TSTP} = 'IGNORE';
409 local $SIG{PIPE} = 'IGNORE';
411 my $oldAutoCommit = $FS::UID::AutoCommit;
412 local $FS::UID::AutoCommit = 0;
415 my $prepay_identifier = '';
416 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
418 if ( $self->payby eq 'PREPAY' ) {
420 $self->payby('BILL');
421 $prepay_identifier = $self->payinfo;
424 warn " looking up prepaid card $prepay_identifier\n"
427 my $error = $self->get_prepay( $prepay_identifier,
428 'amount_ref' => \$amount,
429 'seconds_ref' => \$seconds,
430 'upbytes_ref' => \$upbytes,
431 'downbytes_ref' => \$downbytes,
432 'totalbytes_ref' => \$totalbytes,
435 $dbh->rollback if $oldAutoCommit;
436 #return "error applying prepaid card (transaction rolled back): $error";
440 $payby = 'PREP' if $amount;
442 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
445 $self->payby('BILL');
446 $amount = $self->paid;
450 warn " inserting $self\n"
453 $self->signupdate(time) unless $self->signupdate;
455 $self->auto_agent_custid()
456 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
458 my $error = $self->SUPER::insert;
460 $dbh->rollback if $oldAutoCommit;
461 #return "inserting cust_main record (transaction rolled back): $error";
465 warn " setting invoicing list\n"
468 if ( $invoicing_list ) {
469 $error = $self->check_invoicing_list( $invoicing_list );
471 $dbh->rollback if $oldAutoCommit;
472 #return "checking invoicing_list (transaction rolled back): $error";
475 $self->invoicing_list( $invoicing_list );
478 warn " setting customer tags\n"
481 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
482 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
483 'custnum' => $self->custnum };
484 my $error = $cust_tag->insert;
486 $dbh->rollback if $oldAutoCommit;
491 my $prospectnum = delete $options{'prospectnum'};
492 if ( $prospectnum ) {
494 warn " moving contacts and locations from prospect $prospectnum\n"
498 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
499 unless ( $prospect_main ) {
500 $dbh->rollback if $oldAutoCommit;
501 return "Unknown prospectnum $prospectnum";
503 $prospect_main->custnum($self->custnum);
504 $prospect_main->disabled('Y');
505 my $error = $prospect_main->replace;
507 $dbh->rollback if $oldAutoCommit;
511 my @contact = $prospect_main->contact;
512 my @cust_location = $prospect_main->cust_location;
513 my @qual = $prospect_main->qual;
515 foreach my $r ( @contact, @cust_location, @qual ) {
517 $r->custnum($self->custnum);
518 my $error = $r->replace;
520 $dbh->rollback if $oldAutoCommit;
527 warn " setting cust_main_exemption\n"
530 my $tax_exemption = delete $options{'tax_exemption'};
531 if ( $tax_exemption ) {
532 foreach my $taxname ( @$tax_exemption ) {
533 my $cust_main_exemption = new FS::cust_main_exemption {
534 'custnum' => $self->custnum,
535 'taxname' => $taxname,
537 my $error = $cust_main_exemption->insert;
539 $dbh->rollback if $oldAutoCommit;
540 return "inserting cust_main_exemption (transaction rolled back): $error";
545 if ( $self->can('start_copy_skel') ) {
546 my $error = $self->start_copy_skel;
548 $dbh->rollback if $oldAutoCommit;
553 warn " ordering packages\n"
556 $error = $self->order_pkgs( $cust_pkgs,
558 'seconds_ref' => \$seconds,
559 'upbytes_ref' => \$upbytes,
560 'downbytes_ref' => \$downbytes,
561 'totalbytes_ref' => \$totalbytes,
564 $dbh->rollback if $oldAutoCommit;
569 $dbh->rollback if $oldAutoCommit;
570 return "No svc_acct record to apply pre-paid time";
572 if ( $upbytes || $downbytes || $totalbytes ) {
573 $dbh->rollback if $oldAutoCommit;
574 return "No svc_acct record to apply pre-paid data";
578 warn " inserting initial $payby payment of $amount\n"
580 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
582 $dbh->rollback if $oldAutoCommit;
583 return "inserting payment (transaction rolled back): $error";
587 unless ( $import || $skip_fuzzyfiles ) {
588 warn " queueing fuzzyfiles update\n"
590 $error = $self->queue_fuzzyfiles_update;
592 $dbh->rollback if $oldAutoCommit;
593 return "updating fuzzy search cache: $error";
598 warn " exporting\n" if $DEBUG > 1;
600 my $export_args = $options{'export_args'} || [];
603 map qsearch( 'part_export', {exportnum=>$_} ),
604 $conf->config('cust_main-exports'); #, $agentnum
606 foreach my $part_export ( @part_export ) {
607 my $error = $part_export->export_insert($self, @$export_args);
609 $dbh->rollback if $oldAutoCommit;
610 return "exporting to ". $part_export->exporttype.
611 " (transaction rolled back): $error";
615 #foreach my $depend_jobnum ( @$depend_jobnums ) {
616 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
618 # foreach my $jobnum ( @jobnums ) {
619 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
620 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
622 # my $error = $queue->depend_insert($depend_jobnum);
624 # $dbh->rollback if $oldAutoCommit;
625 # return "error queuing job dependancy: $error";
632 #if ( exists $options{'jobnums'} ) {
633 # push @{ $options{'jobnums'} }, @jobnums;
636 warn " insert complete; committing transaction\n"
639 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
644 use File::CounterFile;
645 sub auto_agent_custid {
648 my $format = $conf->config('cust_main-auto_agent_custid');
650 if ( $format eq '1YMMXXXXXXXX' ) {
652 my $counter = new File::CounterFile 'cust_main.agent_custid';
655 my $ym = 100000000000 + time2str('%y%m00000000', time);
656 if ( $ym > $counter->value ) {
657 $counter->{'value'} = $agent_custid = $ym;
658 $counter->{'updated'} = 1;
660 $agent_custid = $counter->inc;
666 die "Unknown cust_main-auto_agent_custid format: $format";
669 $self->agent_custid($agent_custid);
673 =item PACKAGE METHODS
675 Documentation on customer package methods has been moved to
676 L<FS::cust_main::Packages>.
678 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
680 Recharges this (existing) customer with the specified prepaid card (see
681 L<FS::prepay_credit>), specified either by I<identifier> or as an
682 FS::prepay_credit object. If there is an error, returns the error, otherwise
685 Optionally, five scalar references can be passed as well. They will have their
686 values filled in with the amount, number of seconds, and number of upload,
687 download, and total bytes applied by this prepaid card.
691 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
692 #the only place that uses these args
693 sub recharge_prepay {
694 my( $self, $prepay_credit, $amountref, $secondsref,
695 $upbytesref, $downbytesref, $totalbytesref ) = @_;
697 local $SIG{HUP} = 'IGNORE';
698 local $SIG{INT} = 'IGNORE';
699 local $SIG{QUIT} = 'IGNORE';
700 local $SIG{TERM} = 'IGNORE';
701 local $SIG{TSTP} = 'IGNORE';
702 local $SIG{PIPE} = 'IGNORE';
704 my $oldAutoCommit = $FS::UID::AutoCommit;
705 local $FS::UID::AutoCommit = 0;
708 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
710 my $error = $self->get_prepay( $prepay_credit,
711 'amount_ref' => \$amount,
712 'seconds_ref' => \$seconds,
713 'upbytes_ref' => \$upbytes,
714 'downbytes_ref' => \$downbytes,
715 'totalbytes_ref' => \$totalbytes,
717 || $self->increment_seconds($seconds)
718 || $self->increment_upbytes($upbytes)
719 || $self->increment_downbytes($downbytes)
720 || $self->increment_totalbytes($totalbytes)
721 || $self->insert_cust_pay_prepay( $amount,
723 ? $prepay_credit->identifier
728 $dbh->rollback if $oldAutoCommit;
732 if ( defined($amountref) ) { $$amountref = $amount; }
733 if ( defined($secondsref) ) { $$secondsref = $seconds; }
734 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
735 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
736 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
738 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
743 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
745 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
746 specified either by I<identifier> or as an FS::prepay_credit object.
748 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
749 incremented by the values of the prepaid card.
751 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
752 check or set this customer's I<agentnum>.
754 If there is an error, returns the error, otherwise returns false.
760 my( $self, $prepay_credit, %opt ) = @_;
762 local $SIG{HUP} = 'IGNORE';
763 local $SIG{INT} = 'IGNORE';
764 local $SIG{QUIT} = 'IGNORE';
765 local $SIG{TERM} = 'IGNORE';
766 local $SIG{TSTP} = 'IGNORE';
767 local $SIG{PIPE} = 'IGNORE';
769 my $oldAutoCommit = $FS::UID::AutoCommit;
770 local $FS::UID::AutoCommit = 0;
773 unless ( ref($prepay_credit) ) {
775 my $identifier = $prepay_credit;
777 $prepay_credit = qsearchs(
779 { 'identifier' => $prepay_credit },
784 unless ( $prepay_credit ) {
785 $dbh->rollback if $oldAutoCommit;
786 return "Invalid prepaid card: ". $identifier;
791 if ( $prepay_credit->agentnum ) {
792 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
793 $dbh->rollback if $oldAutoCommit;
794 return "prepaid card not valid for agent ". $self->agentnum;
796 $self->agentnum($prepay_credit->agentnum);
799 my $error = $prepay_credit->delete;
801 $dbh->rollback if $oldAutoCommit;
802 return "removing prepay_credit (transaction rolled back): $error";
805 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
806 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
808 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
813 =item increment_upbytes SECONDS
815 Updates this customer's single or primary account (see L<FS::svc_acct>) by
816 the specified number of upbytes. If there is an error, returns the error,
817 otherwise returns false.
821 sub increment_upbytes {
822 _increment_column( shift, 'upbytes', @_);
825 =item increment_downbytes SECONDS
827 Updates this customer's single or primary account (see L<FS::svc_acct>) by
828 the specified number of downbytes. If there is an error, returns the error,
829 otherwise returns false.
833 sub increment_downbytes {
834 _increment_column( shift, 'downbytes', @_);
837 =item increment_totalbytes SECONDS
839 Updates this customer's single or primary account (see L<FS::svc_acct>) by
840 the specified number of totalbytes. If there is an error, returns the error,
841 otherwise returns false.
845 sub increment_totalbytes {
846 _increment_column( shift, 'totalbytes', @_);
849 =item increment_seconds SECONDS
851 Updates this customer's single or primary account (see L<FS::svc_acct>) by
852 the specified number of seconds. If there is an error, returns the error,
853 otherwise returns false.
857 sub increment_seconds {
858 _increment_column( shift, 'seconds', @_);
861 =item _increment_column AMOUNT
863 Updates this customer's single or primary account (see L<FS::svc_acct>) by
864 the specified number of seconds or bytes. If there is an error, returns
865 the error, otherwise returns false.
869 sub _increment_column {
870 my( $self, $column, $amount ) = @_;
871 warn "$me increment_column called: $column, $amount\n"
874 return '' unless $amount;
876 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
877 $self->ncancelled_pkgs;
880 return 'No packages with primary or single services found'.
881 ' to apply pre-paid time';
882 } elsif ( scalar(@cust_pkg) > 1 ) {
883 #maybe have a way to specify the package/account?
884 return 'Multiple packages found to apply pre-paid time';
887 my $cust_pkg = $cust_pkg[0];
888 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
892 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
895 return 'No account found to apply pre-paid time';
896 } elsif ( scalar(@cust_svc) > 1 ) {
897 return 'Multiple accounts found to apply pre-paid time';
900 my $svc_acct = $cust_svc[0]->svc_x;
901 warn " found service svcnum ". $svc_acct->pkgnum.
902 ' ('. $svc_acct->email. ")\n"
905 $column = "increment_$column";
906 $svc_acct->$column($amount);
910 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
912 Inserts a prepayment in the specified amount for this customer. An optional
913 second argument can specify the prepayment identifier for tracking purposes.
914 If there is an error, returns the error, otherwise returns false.
918 sub insert_cust_pay_prepay {
919 shift->insert_cust_pay('PREP', @_);
922 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
924 Inserts a cash payment in the specified amount for this customer. An optional
925 second argument can specify the payment identifier for tracking purposes.
926 If there is an error, returns the error, otherwise returns false.
930 sub insert_cust_pay_cash {
931 shift->insert_cust_pay('CASH', @_);
934 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
936 Inserts a Western Union payment in the specified amount for this customer. An
937 optional second argument can specify the prepayment identifier for tracking
938 purposes. If there is an error, returns the error, otherwise returns false.
942 sub insert_cust_pay_west {
943 shift->insert_cust_pay('WEST', @_);
946 sub insert_cust_pay {
947 my( $self, $payby, $amount ) = splice(@_, 0, 3);
948 my $payinfo = scalar(@_) ? shift : '';
950 my $cust_pay = new FS::cust_pay {
951 'custnum' => $self->custnum,
952 'paid' => sprintf('%.2f', $amount),
953 #'_date' => #date the prepaid card was purchased???
955 'payinfo' => $payinfo,
963 This method is deprecated. See the I<depend_jobnum> option to the insert and
964 order_pkgs methods for a better way to defer provisioning.
966 Re-schedules all exports by calling the B<reexport> method of all associated
967 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
968 otherwise returns false.
975 carp "WARNING: FS::cust_main::reexport is deprectated; ".
976 "use the depend_jobnum option to insert or order_pkgs to delay export";
978 local $SIG{HUP} = 'IGNORE';
979 local $SIG{INT} = 'IGNORE';
980 local $SIG{QUIT} = 'IGNORE';
981 local $SIG{TERM} = 'IGNORE';
982 local $SIG{TSTP} = 'IGNORE';
983 local $SIG{PIPE} = 'IGNORE';
985 my $oldAutoCommit = $FS::UID::AutoCommit;
986 local $FS::UID::AutoCommit = 0;
989 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
990 my $error = $cust_pkg->reexport;
992 $dbh->rollback if $oldAutoCommit;
997 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1002 =item delete [ OPTION => VALUE ... ]
1004 This deletes the customer. If there is an error, returns the error, otherwise
1007 This will completely remove all traces of the customer record. This is not
1008 what you want when a customer cancels service; for that, cancel all of the
1009 customer's packages (see L</cancel>).
1011 If the customer has any uncancelled packages, you need to pass a new (valid)
1012 customer number for those packages to be transferred to, as the "new_customer"
1013 option. Cancelled packages will be deleted. Did I mention that this is NOT
1014 what you want when a customer cancels service and that you really should be
1015 looking at L<FS::cust_pkg/cancel>?
1017 You can't delete a customer with invoices (see L<FS::cust_bill>),
1018 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1019 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1020 set the "delete_financials" option to a true value.
1025 my( $self, %opt ) = @_;
1027 local $SIG{HUP} = 'IGNORE';
1028 local $SIG{INT} = 'IGNORE';
1029 local $SIG{QUIT} = 'IGNORE';
1030 local $SIG{TERM} = 'IGNORE';
1031 local $SIG{TSTP} = 'IGNORE';
1032 local $SIG{PIPE} = 'IGNORE';
1034 my $oldAutoCommit = $FS::UID::AutoCommit;
1035 local $FS::UID::AutoCommit = 0;
1038 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1039 $dbh->rollback if $oldAutoCommit;
1040 return "Can't delete a master agent customer";
1043 #use FS::access_user
1044 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1045 $dbh->rollback if $oldAutoCommit;
1046 return "Can't delete a master employee customer";
1049 tie my %financial_tables, 'Tie::IxHash',
1050 'cust_bill' => 'invoices',
1051 'cust_statement' => 'statements',
1052 'cust_credit' => 'credits',
1053 'cust_pay' => 'payments',
1054 'cust_refund' => 'refunds',
1057 foreach my $table ( keys %financial_tables ) {
1059 my @records = $self->$table();
1061 if ( @records && ! $opt{'delete_financials'} ) {
1062 $dbh->rollback if $oldAutoCommit;
1063 return "Can't delete a customer with ". $financial_tables{$table};
1066 foreach my $record ( @records ) {
1067 my $error = $record->delete;
1069 $dbh->rollback if $oldAutoCommit;
1070 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1076 my @cust_pkg = $self->ncancelled_pkgs;
1078 my $new_custnum = $opt{'new_custnum'};
1079 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1080 $dbh->rollback if $oldAutoCommit;
1081 return "Invalid new customer number: $new_custnum";
1083 foreach my $cust_pkg ( @cust_pkg ) {
1084 my %hash = $cust_pkg->hash;
1085 $hash{'custnum'} = $new_custnum;
1086 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1087 my $error = $new_cust_pkg->replace($cust_pkg,
1088 options => { $cust_pkg->options },
1091 $dbh->rollback if $oldAutoCommit;
1096 my @cancelled_cust_pkg = $self->all_pkgs;
1097 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1098 my $error = $cust_pkg->delete;
1100 $dbh->rollback if $oldAutoCommit;
1105 #cust_tax_adjustment in financials?
1106 #cust_pay_pending? ouch
1108 foreach my $table (qw(
1109 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1110 cust_location cust_main_note cust_tax_adjustment
1111 cust_pay_void cust_pay_batch queue cust_tax_exempt
1113 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1114 my $error = $record->delete;
1116 $dbh->rollback if $oldAutoCommit;
1122 my $sth = $dbh->prepare(
1123 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1125 my $errstr = $dbh->errstr;
1126 $dbh->rollback if $oldAutoCommit;
1129 $sth->execute($self->custnum) or do {
1130 my $errstr = $sth->errstr;
1131 $dbh->rollback if $oldAutoCommit;
1137 my $ticket_dbh = '';
1138 if ($conf->config('ticket_system') eq 'RT_Internal') {
1140 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1141 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1142 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1143 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1146 if ( $ticket_dbh ) {
1148 my $ticket_sth = $ticket_dbh->prepare(
1149 'DELETE FROM Links WHERE Target = ?'
1151 my $errstr = $ticket_dbh->errstr;
1152 $dbh->rollback if $oldAutoCommit;
1155 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1157 my $errstr = $ticket_sth->errstr;
1158 $dbh->rollback if $oldAutoCommit;
1162 #check and see if the customer is the only link on the ticket, and
1163 #if so, set the ticket to deleted status in RT?
1164 #maybe someday, for now this will at least fix tickets not displaying
1168 #delete the customer record
1170 my $error = $self->SUPER::delete;
1172 $dbh->rollback if $oldAutoCommit;
1176 # cust_main exports!
1178 #my $export_args = $options{'export_args'} || [];
1181 map qsearch( 'part_export', {exportnum=>$_} ),
1182 $conf->config('cust_main-exports'); #, $agentnum
1184 foreach my $part_export ( @part_export ) {
1185 my $error = $part_export->export_delete( $self ); #, @$export_args);
1187 $dbh->rollback if $oldAutoCommit;
1188 return "exporting to ". $part_export->exporttype.
1189 " (transaction rolled back): $error";
1193 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1198 =item merge NEW_CUSTNUM [ , OPTION => VALUE ... ]
1200 This merges this customer into the provided new custnum, and then deletes the
1201 customer. If there is an error, returns the error, otherwise returns false.
1203 The source customer's name, company name, phone numbers, agent,
1204 referring customer, customer class, advertising source, order taker, and
1205 billing information (except balance) are discarded.
1207 All packages are moved to the target customer. Packages with package locations
1208 are preserved. Packages without package locations are moved to a new package
1209 location with the source customer's service/shipping address.
1211 All invoices, statements, payments, credits and refunds are moved to the target
1212 customer. The source customer's balance is added to the target customer.
1214 All notes, attachments, tickets and customer tags are moved to the target
1217 Change history is not currently moved.
1222 my( $self, $new_custnum, %opt ) = @_;
1224 return "Can't merge a customer into self" if $self->custnum == $new_custnum;
1226 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1227 return "Invalid new customer number: $new_custnum";
1230 local $SIG{HUP} = 'IGNORE';
1231 local $SIG{INT} = 'IGNORE';
1232 local $SIG{QUIT} = 'IGNORE';
1233 local $SIG{TERM} = 'IGNORE';
1234 local $SIG{TSTP} = 'IGNORE';
1235 local $SIG{PIPE} = 'IGNORE';
1237 my $oldAutoCommit = $FS::UID::AutoCommit;
1238 local $FS::UID::AutoCommit = 0;
1241 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1242 $dbh->rollback if $oldAutoCommit;
1243 return "Can't merge a master agent customer";
1246 #use FS::access_user
1247 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1248 $dbh->rollback if $oldAutoCommit;
1249 return "Can't merge a master employee customer";
1252 if ( qsearch('cust_pay_pending', { 'custnum' => $self->custnum,
1253 'status' => { op=>'!=', value=>'done' },
1257 $dbh->rollback if $oldAutoCommit;
1258 return "Can't merge a customer with pending payments";
1261 tie my %financial_tables, 'Tie::IxHash',
1262 'cust_bill' => 'invoices',
1263 'cust_statement' => 'statements',
1264 'cust_credit' => 'credits',
1265 'cust_pay' => 'payments',
1266 'cust_pay_void' => 'voided payments',
1267 'cust_refund' => 'refunds',
1270 foreach my $table ( keys %financial_tables ) {
1272 my @records = $self->$table();
1274 foreach my $record ( @records ) {
1275 $record->custnum($new_custnum);
1276 my $error = $record->replace;
1278 $dbh->rollback if $oldAutoCommit;
1279 return "Error merging ". $financial_tables{$table}. ": $error\n";
1285 my $name = $self->ship_name;
1287 my $locationnum = '';
1288 foreach my $cust_pkg ( $self->all_pkgs ) {
1289 $cust_pkg->custnum($new_custnum);
1291 unless ( $cust_pkg->locationnum ) {
1292 unless ( $locationnum ) {
1293 my $cust_location = new FS::cust_location {
1294 $self->location_hash,
1295 'custnum' => $new_custnum,
1297 my $error = $cust_location->insert;
1299 $dbh->rollback if $oldAutoCommit;
1302 $locationnum = $cust_location->locationnum;
1304 $cust_pkg->locationnum($locationnum);
1307 my $error = $cust_pkg->replace;
1309 $dbh->rollback if $oldAutoCommit;
1313 # add customer (ship) name to svc_phone.phone_name if blank
1314 my @cust_svc = $cust_pkg->cust_svc;
1315 foreach my $cust_svc (@cust_svc) {
1316 my($label, $value, $svcdb) = $cust_svc->label;
1317 next unless $svcdb eq 'svc_phone';
1318 my $svc_phone = $cust_svc->svc_x;
1319 next if $svc_phone->phone_name;
1320 $svc_phone->phone_name($name);
1321 my $error = $svc_phone->replace;
1323 $dbh->rollback if $oldAutoCommit;
1331 # cust_tax_exempt (texas tax exemptions)
1332 # cust_recon (some sort of not-well understood thing for OnPac)
1334 #these are moved over
1335 foreach my $table (qw(
1336 cust_tag cust_location contact cust_attachment cust_main_note
1337 cust_tax_adjustment cust_pay_batch queue
1339 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1340 $record->custnum($new_custnum);
1341 my $error = $record->replace;
1343 $dbh->rollback if $oldAutoCommit;
1349 #these aren't preserved
1350 foreach my $table (qw(
1351 cust_main_exemption cust_main_invoice
1353 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1354 my $error = $record->delete;
1356 $dbh->rollback if $oldAutoCommit;
1363 my $sth = $dbh->prepare(
1364 'UPDATE cust_main SET referral_custnum = ? WHERE referral_custnum = ?'
1366 my $errstr = $dbh->errstr;
1367 $dbh->rollback if $oldAutoCommit;
1370 $sth->execute($new_custnum, $self->custnum) or do {
1371 my $errstr = $sth->errstr;
1372 $dbh->rollback if $oldAutoCommit;
1378 my $ticket_dbh = '';
1379 if ($conf->config('ticket_system') eq 'RT_Internal') {
1381 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1382 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1383 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1384 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1387 if ( $ticket_dbh ) {
1389 my $ticket_sth = $ticket_dbh->prepare(
1390 'UPDATE Links SET Target = ? WHERE Target = ?'
1392 my $errstr = $ticket_dbh->errstr;
1393 $dbh->rollback if $oldAutoCommit;
1396 $ticket_sth->execute('freeside://freeside/cust_main/'.$new_custnum,
1397 'freeside://freeside/cust_main/'.$self->custnum)
1399 my $errstr = $ticket_sth->errstr;
1400 $dbh->rollback if $oldAutoCommit;
1406 #delete the customer record
1408 my $error = $self->delete;
1410 $dbh->rollback if $oldAutoCommit;
1414 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1419 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1422 Replaces the OLD_RECORD with this one in the database. If there is an error,
1423 returns the error, otherwise returns false.
1425 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1426 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1427 expected and rollback the entire transaction; it is not necessary to call
1428 check_invoicing_list first. Here's an example:
1430 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1432 Currently available options are: I<tax_exemption>.
1434 The I<tax_exemption> option can be set to an arrayref of tax names.
1435 FS::cust_main_exemption records will be deleted and inserted as appropriate.
1442 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1444 : $self->replace_old;
1448 warn "$me replace called\n"
1451 my $curuser = $FS::CurrentUser::CurrentUser;
1452 if ( $self->payby eq 'COMP'
1453 && $self->payby ne $old->payby
1454 && ! $curuser->access_right('Complimentary customer')
1457 return "You are not permitted to create complimentary accounts.";
1460 if ( $old->get('geocode') && $old->get('geocode') eq $self->get('geocode')
1461 && $conf->exists('enable_taxproducts')
1464 my $pre = ($conf->exists('tax-ship_address') && $self->ship_zip)
1466 $self->set('geocode', '')
1467 if $old->get($pre.'zip') ne $self->get($pre.'zip')
1468 && length($self->get($pre.'zip')) >= 10;
1471 local($ignore_expired_card) = 1
1472 if $old->payby =~ /^(CARD|DCRD)$/
1473 && $self->payby =~ /^(CARD|DCRD)$/
1474 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1476 local $SIG{HUP} = 'IGNORE';
1477 local $SIG{INT} = 'IGNORE';
1478 local $SIG{QUIT} = 'IGNORE';
1479 local $SIG{TERM} = 'IGNORE';
1480 local $SIG{TSTP} = 'IGNORE';
1481 local $SIG{PIPE} = 'IGNORE';
1483 my $oldAutoCommit = $FS::UID::AutoCommit;
1484 local $FS::UID::AutoCommit = 0;
1487 my $error = $self->SUPER::replace($old);
1490 $dbh->rollback if $oldAutoCommit;
1494 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1495 my $invoicing_list = shift @param;
1496 $error = $self->check_invoicing_list( $invoicing_list );
1498 $dbh->rollback if $oldAutoCommit;
1501 $self->invoicing_list( $invoicing_list );
1504 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1506 #this could be more efficient than deleting and re-inserting, if it matters
1507 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1508 my $error = $cust_tag->delete;
1510 $dbh->rollback if $oldAutoCommit;
1514 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1515 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1516 'custnum' => $self->custnum };
1517 my $error = $cust_tag->insert;
1519 $dbh->rollback if $oldAutoCommit;
1526 my %options = @param;
1528 my $tax_exemption = delete $options{'tax_exemption'};
1529 if ( $tax_exemption ) {
1531 my %cust_main_exemption =
1532 map { $_->taxname => $_ }
1533 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1535 foreach my $taxname ( @$tax_exemption ) {
1537 next if delete $cust_main_exemption{$taxname};
1539 my $cust_main_exemption = new FS::cust_main_exemption {
1540 'custnum' => $self->custnum,
1541 'taxname' => $taxname,
1543 my $error = $cust_main_exemption->insert;
1545 $dbh->rollback if $oldAutoCommit;
1546 return "inserting cust_main_exemption (transaction rolled back): $error";
1550 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1551 my $error = $cust_main_exemption->delete;
1553 $dbh->rollback if $oldAutoCommit;
1554 return "deleting cust_main_exemption (transaction rolled back): $error";
1560 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1561 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1562 && $self->get('payinfo') !~ /^99\d{14}$/
1564 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1569 # card/check/lec info has changed, want to retry realtime_ invoice events
1570 my $error = $self->retry_realtime;
1572 $dbh->rollback if $oldAutoCommit;
1577 unless ( $import || $skip_fuzzyfiles ) {
1578 $error = $self->queue_fuzzyfiles_update;
1580 $dbh->rollback if $oldAutoCommit;
1581 return "updating fuzzy search cache: $error";
1585 # cust_main exports!
1587 my $export_args = $options{'export_args'} || [];
1590 map qsearch( 'part_export', {exportnum=>$_} ),
1591 $conf->config('cust_main-exports'); #, $agentnum
1593 foreach my $part_export ( @part_export ) {
1594 my $error = $part_export->export_replace( $self, $old, @$export_args);
1596 $dbh->rollback if $oldAutoCommit;
1597 return "exporting to ". $part_export->exporttype.
1598 " (transaction rolled back): $error";
1602 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1607 =item queue_fuzzyfiles_update
1609 Used by insert & replace to update the fuzzy search cache
1613 sub queue_fuzzyfiles_update {
1616 local $SIG{HUP} = 'IGNORE';
1617 local $SIG{INT} = 'IGNORE';
1618 local $SIG{QUIT} = 'IGNORE';
1619 local $SIG{TERM} = 'IGNORE';
1620 local $SIG{TSTP} = 'IGNORE';
1621 local $SIG{PIPE} = 'IGNORE';
1623 my $oldAutoCommit = $FS::UID::AutoCommit;
1624 local $FS::UID::AutoCommit = 0;
1627 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1628 my $error = $queue->insert( map $self->getfield($_), @fuzzyfields );
1630 $dbh->rollback if $oldAutoCommit;
1631 return "queueing job (transaction rolled back): $error";
1634 if ( $self->ship_last ) {
1635 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1636 $error = $queue->insert( map $self->getfield("ship_$_"), @fuzzyfields );
1638 $dbh->rollback if $oldAutoCommit;
1639 return "queueing job (transaction rolled back): $error";
1643 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1650 Checks all fields to make sure this is a valid customer record. If there is
1651 an error, returns the error, otherwise returns false. Called by the insert
1652 and replace methods.
1659 warn "$me check BEFORE: \n". $self->_dump
1663 $self->ut_numbern('custnum')
1664 || $self->ut_number('agentnum')
1665 || $self->ut_textn('agent_custid')
1666 || $self->ut_number('refnum')
1667 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1668 || $self->ut_textn('custbatch')
1669 || $self->ut_name('last')
1670 || $self->ut_name('first')
1671 || $self->ut_snumbern('birthdate')
1672 || $self->ut_snumbern('signupdate')
1673 || $self->ut_textn('company')
1674 || $self->ut_text('address1')
1675 || $self->ut_textn('address2')
1676 || $self->ut_text('city')
1677 || $self->ut_textn('county')
1678 || $self->ut_textn('state')
1679 || $self->ut_country('country')
1680 || $self->ut_anything('comments')
1681 || $self->ut_numbern('referral_custnum')
1682 || $self->ut_textn('stateid')
1683 || $self->ut_textn('stateid_state')
1684 || $self->ut_textn('invoice_terms')
1685 || $self->ut_alphan('geocode')
1686 || $self->ut_floatn('cdr_termination_percentage')
1687 || $self->ut_floatn('credit_limit')
1688 || $self->ut_numbern('billday')
1691 #barf. need message catalogs. i18n. etc.
1692 $error .= "Please select an advertising source."
1693 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1694 return $error if $error;
1696 return "Unknown agent"
1697 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1699 return "Unknown refnum"
1700 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1702 return "Unknown referring custnum: ". $self->referral_custnum
1703 unless ! $self->referral_custnum
1704 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1706 if ( $self->censustract ne '' ) {
1707 $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
1708 or return "Illegal census tract: ". $self->censustract;
1710 $self->censustract("$1.$2");
1713 if ( $self->ss eq '' ) {
1718 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1719 or return "Illegal social security number: ". $self->ss;
1720 $self->ss("$1-$2-$3");
1724 # bad idea to disable, causes billing to fail because of no tax rates later
1725 # except we don't fail any more
1726 unless ( $import ) {
1727 unless ( qsearch('cust_main_county', {
1728 'country' => $self->country,
1731 return "Unknown state/county/country: ".
1732 $self->state. "/". $self->county. "/". $self->country
1733 unless qsearch('cust_main_county',{
1734 'state' => $self->state,
1735 'county' => $self->county,
1736 'country' => $self->country,
1742 $self->ut_phonen('daytime', $self->country)
1743 || $self->ut_phonen('night', $self->country)
1744 || $self->ut_phonen('fax', $self->country)
1746 return $error if $error;
1748 unless ( $ignore_illegal_zip ) {
1749 $error = $self->ut_zip('zip', $self->country);
1750 return $error if $error;
1753 if ( $conf->exists('cust_main-require_phone')
1754 && ! length($self->daytime) && ! length($self->night)
1757 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1759 : FS::Msgcat::_gettext('daytime');
1760 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1762 : FS::Msgcat::_gettext('night');
1764 return "$daytime_label or $night_label is required"
1768 if ( $self->has_ship_address
1769 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1770 $self->addr_fields )
1774 $self->ut_name('ship_last')
1775 || $self->ut_name('ship_first')
1776 || $self->ut_textn('ship_company')
1777 || $self->ut_text('ship_address1')
1778 || $self->ut_textn('ship_address2')
1779 || $self->ut_text('ship_city')
1780 || $self->ut_textn('ship_county')
1781 || $self->ut_textn('ship_state')
1782 || $self->ut_country('ship_country')
1784 return $error if $error;
1786 #false laziness with above
1787 unless ( qsearchs('cust_main_county', {
1788 'country' => $self->ship_country,
1791 return "Unknown ship_state/ship_county/ship_country: ".
1792 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1793 unless qsearch('cust_main_county',{
1794 'state' => $self->ship_state,
1795 'county' => $self->ship_county,
1796 'country' => $self->ship_country,
1802 $self->ut_phonen('ship_daytime', $self->ship_country)
1803 || $self->ut_phonen('ship_night', $self->ship_country)
1804 || $self->ut_phonen('ship_fax', $self->ship_country)
1806 return $error if $error;
1808 unless ( $ignore_illegal_zip ) {
1809 $error = $self->ut_zip('ship_zip', $self->ship_country);
1810 return $error if $error;
1812 return "Unit # is required."
1813 if $self->ship_address2 =~ /^\s*$/
1814 && $conf->exists('cust_main-require_address2');
1816 } else { # ship_ info eq billing info, so don't store dup info in database
1818 $self->setfield("ship_$_", '')
1819 foreach $self->addr_fields;
1821 return "Unit # is required."
1822 if $self->address2 =~ /^\s*$/
1823 && $conf->exists('cust_main-require_address2');
1827 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1828 # or return "Illegal payby: ". $self->payby;
1830 FS::payby->can_payby($self->table, $self->payby)
1831 or return "Illegal payby: ". $self->payby;
1833 $error = $self->ut_numbern('paystart_month')
1834 || $self->ut_numbern('paystart_year')
1835 || $self->ut_numbern('payissue')
1836 || $self->ut_textn('paytype')
1838 return $error if $error;
1840 if ( $self->payip eq '' ) {
1843 $error = $self->ut_ip('payip');
1844 return $error if $error;
1847 # If it is encrypted and the private key is not availaible then we can't
1848 # check the credit card.
1849 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1851 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1853 my $payinfo = $self->payinfo;
1854 $payinfo =~ s/\D//g;
1855 $payinfo =~ /^(\d{13,16})$/
1856 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1858 $self->payinfo($payinfo);
1860 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1862 return gettext('unknown_card_type')
1863 if $self->payinfo !~ /^99\d{14}$/ #token
1864 && cardtype($self->payinfo) eq "Unknown";
1866 unless ( $ignore_banned_card ) {
1867 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1869 return 'Banned credit card: banned on '.
1870 time2str('%a %h %o at %r', $ban->_date).
1871 ' by '. $ban->otaker.
1872 ' (ban# '. $ban->bannum. ')';
1876 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1877 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1878 $self->paycvv =~ /^(\d{4})$/
1879 or return "CVV2 (CID) for American Express cards is four digits.";
1882 $self->paycvv =~ /^(\d{3})$/
1883 or return "CVV2 (CVC2/CID) is three digits.";
1890 my $cardtype = cardtype($payinfo);
1891 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1893 return "Start date or issue number is required for $cardtype cards"
1894 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1896 return "Start month must be between 1 and 12"
1897 if $self->paystart_month
1898 and $self->paystart_month < 1 || $self->paystart_month > 12;
1900 return "Start year must be 1990 or later"
1901 if $self->paystart_year
1902 and $self->paystart_year < 1990;
1904 return "Issue number must be beween 1 and 99"
1906 and $self->payissue < 1 || $self->payissue > 99;
1909 $self->paystart_month('');
1910 $self->paystart_year('');
1911 $self->payissue('');
1914 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1916 my $payinfo = $self->payinfo;
1917 $payinfo =~ s/[^\d\@\.]//g;
1918 if ( $conf->exists('cust_main-require-bank-branch') ) {
1919 $payinfo =~ /^(\d+)\@(\d+)\.(\d+)$/ or return 'invalid echeck account@branch.bank';
1920 $payinfo = "$1\@$2.$3";
1922 elsif ( $conf->exists('echeck-nonus') ) {
1923 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1924 $payinfo = "$1\@$2";
1926 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1927 $payinfo = "$1\@$2";
1929 $self->payinfo($payinfo);
1932 unless ( $ignore_banned_card ) {
1933 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1935 return 'Banned ACH account: banned on '.
1936 time2str('%a %h %o at %r', $ban->_date).
1937 ' by '. $ban->otaker.
1938 ' (ban# '. $ban->bannum. ')';
1942 } elsif ( $self->payby eq 'LECB' ) {
1944 my $payinfo = $self->payinfo;
1945 $payinfo =~ s/\D//g;
1946 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1948 $self->payinfo($payinfo);
1951 } elsif ( $self->payby eq 'BILL' ) {
1953 $error = $self->ut_textn('payinfo');
1954 return "Illegal P.O. number: ". $self->payinfo if $error;
1957 } elsif ( $self->payby eq 'COMP' ) {
1959 my $curuser = $FS::CurrentUser::CurrentUser;
1960 if ( ! $self->custnum
1961 && ! $curuser->access_right('Complimentary customer')
1964 return "You are not permitted to create complimentary accounts."
1967 $error = $self->ut_textn('payinfo');
1968 return "Illegal comp account issuer: ". $self->payinfo if $error;
1971 } elsif ( $self->payby eq 'PREPAY' ) {
1973 my $payinfo = $self->payinfo;
1974 $payinfo =~ s/\W//g; #anything else would just confuse things
1975 $self->payinfo($payinfo);
1976 $error = $self->ut_alpha('payinfo');
1977 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1978 return "Unknown prepayment identifier"
1979 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1984 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1985 return "Expiration date required"
1986 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1990 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1991 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1992 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1993 ( $m, $y ) = ( $2, "19$1" );
1994 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1995 ( $m, $y ) = ( $3, "20$2" );
1997 return "Illegal expiration date: ". $self->paydate;
1999 $m = sprintf('%02d',$m);
2000 $self->paydate("$y-$m-01");
2001 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2002 return gettext('expired_card')
2004 && !$ignore_expired_card
2005 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2008 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2009 ( ! $conf->exists('require_cardname')
2010 || $self->payby !~ /^(CARD|DCRD)$/ )
2012 $self->payname( $self->first. " ". $self->getfield('last') );
2014 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
2015 or return gettext('illegal_name'). " payname: ". $self->payname;
2019 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2020 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2024 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2026 warn "$me check AFTER: \n". $self->_dump
2029 $self->SUPER::check;
2034 Returns a list of fields which have ship_ duplicates.
2039 qw( last first company
2040 address1 address2 city county state zip country
2045 =item has_ship_address
2047 Returns true if this customer record has a separate shipping address.
2051 sub has_ship_address {
2053 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
2058 Returns a list of key/value pairs, with the following keys: address1, adddress2,
2059 city, county, state, zip, country, and geocode. The shipping address is used if present.
2065 Returns all locations (see L<FS::cust_location>) for this customer.
2071 qsearch('cust_location', { 'custnum' => $self->custnum } );
2076 Returns all contacts (see L<FS::contact>) for this customer.
2080 #already used :/ sub contact {
2083 qsearch('contact', { 'custnum' => $self->custnum } );
2088 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2089 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2090 on success or a list of errors.
2096 grep { $_->unsuspend } $self->suspended_pkgs;
2101 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2103 Returns a list: an empty list on success or a list of errors.
2109 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2112 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2114 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2115 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2116 of a list of pkgparts; the hashref has the following keys:
2120 =item pkgparts - listref of pkgparts
2122 =item (other options are passed to the suspend method)
2127 Returns a list: an empty list on success or a list of errors.
2131 sub suspend_if_pkgpart {
2133 my (@pkgparts, %opt);
2134 if (ref($_[0]) eq 'HASH'){
2135 @pkgparts = @{$_[0]{pkgparts}};
2140 grep { $_->suspend(%opt) }
2141 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2142 $self->unsuspended_pkgs;
2145 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2147 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2148 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2149 instead of a list of pkgparts; the hashref has the following keys:
2153 =item pkgparts - listref of pkgparts
2155 =item (other options are passed to the suspend method)
2159 Returns a list: an empty list on success or a list of errors.
2163 sub suspend_unless_pkgpart {
2165 my (@pkgparts, %opt);
2166 if (ref($_[0]) eq 'HASH'){
2167 @pkgparts = @{$_[0]{pkgparts}};
2172 grep { $_->suspend(%opt) }
2173 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2174 $self->unsuspended_pkgs;
2177 =item cancel [ OPTION => VALUE ... ]
2179 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2181 Available options are:
2185 =item quiet - can be set true to supress email cancellation notices.
2187 =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.
2189 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2191 =item nobill - can be set true to skip billing if it might otherwise be done.
2195 Always returns a list: an empty list on success or a list of errors.
2199 # nb that dates are not specified as valid options to this method
2202 my( $self, %opt ) = @_;
2204 warn "$me cancel called on customer ". $self->custnum. " with options ".
2205 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2208 return ( 'access denied' )
2209 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2211 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2213 #should try decryption (we might have the private key)
2214 # and if not maybe queue a job for the server that does?
2215 return ( "Can't (yet) ban encrypted credit cards" )
2216 if $self->is_encrypted($self->payinfo);
2218 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
2219 my $error = $ban->insert;
2220 return ( $error ) if $error;
2224 my @pkgs = $self->ncancelled_pkgs;
2226 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2228 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2229 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2233 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2234 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2237 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2240 sub _banned_pay_hashref {
2251 'payby' => $payby2ban{$self->payby},
2252 'payinfo' => md5_base64($self->payinfo),
2253 #don't ever *search* on reason! #'reason' =>
2259 Returns all notes (see L<FS::cust_main_note>) for this customer.
2264 my($self,$orderby_classnum) = (shift,shift);
2265 my $orderby = "_DATE DESC";
2266 $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2267 qsearch( 'cust_main_note',
2268 { 'custnum' => $self->custnum },
2270 "ORDER BY $orderby",
2276 Returns the agent (see L<FS::agent>) for this customer.
2282 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2287 Returns the agent name (see L<FS::agent>) for this customer.
2293 $self->agent->agent;
2298 Returns any tags associated with this customer, as FS::cust_tag objects,
2299 or an empty list if there are no tags.
2305 qsearch('cust_tag', { 'custnum' => $self->custnum } );
2310 Returns any tags associated with this customer, as FS::part_tag objects,
2311 or an empty list if there are no tags.
2317 map $_->part_tag, $self->cust_tag;
2323 Returns the customer class, as an FS::cust_class object, or the empty string
2324 if there is no customer class.
2330 if ( $self->classnum ) {
2331 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2339 Returns the customer category name, or the empty string if there is no customer
2346 my $cust_class = $self->cust_class;
2348 ? $cust_class->categoryname
2354 Returns the customer class name, or the empty string if there is no customer
2361 my $cust_class = $self->cust_class;
2363 ? $cust_class->classname
2367 =item BILLING METHODS
2369 Documentation on billing methods has been moved to
2370 L<FS::cust_main::Billing>.
2372 =item REALTIME BILLING METHODS
2374 Documentation on realtime billing methods has been moved to
2375 L<FS::cust_main::Billing_Realtime>.
2379 Removes the I<paycvv> field from the database directly.
2381 If there is an error, returns the error, otherwise returns false.
2387 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2388 or return dbh->errstr;
2389 $sth->execute($self->custnum)
2390 or return $sth->errstr;
2395 =item batch_card OPTION => VALUE...
2397 Adds a payment for this invoice to the pending credit card batch (see
2398 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2399 runs the payment using a realtime gateway.
2404 my ($self, %options) = @_;
2407 if (exists($options{amount})) {
2408 $amount = $options{amount};
2410 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2412 return '' unless $amount > 0;
2414 my $invnum = delete $options{invnum};
2415 my $payby = $options{payby} || $self->payby; #still dubious
2417 if ($options{'realtime'}) {
2418 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2424 my $oldAutoCommit = $FS::UID::AutoCommit;
2425 local $FS::UID::AutoCommit = 0;
2428 #this needs to handle mysql as well as Pg, like svc_acct.pm
2429 #(make it into a common function if folks need to do batching with mysql)
2430 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2431 or return "Cannot lock pay_batch: " . $dbh->errstr;
2435 'payby' => FS::payby->payby2payment($payby),
2438 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2440 unless ( $pay_batch ) {
2441 $pay_batch = new FS::pay_batch \%pay_batch;
2442 my $error = $pay_batch->insert;
2444 $dbh->rollback if $oldAutoCommit;
2445 die "error creating new batch: $error\n";
2449 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2450 'batchnum' => $pay_batch->batchnum,
2451 'custnum' => $self->custnum,
2454 foreach (qw( address1 address2 city state zip country payby payinfo paydate
2456 $options{$_} = '' unless exists($options{$_});
2459 my $cust_pay_batch = new FS::cust_pay_batch ( {
2460 'batchnum' => $pay_batch->batchnum,
2461 'invnum' => $invnum || 0, # is there a better value?
2462 # this field should be
2464 # cust_bill_pay_batch now
2465 'custnum' => $self->custnum,
2466 'last' => $self->getfield('last'),
2467 'first' => $self->getfield('first'),
2468 'address1' => $options{address1} || $self->address1,
2469 'address2' => $options{address2} || $self->address2,
2470 'city' => $options{city} || $self->city,
2471 'state' => $options{state} || $self->state,
2472 'zip' => $options{zip} || $self->zip,
2473 'country' => $options{country} || $self->country,
2474 'payby' => $options{payby} || $self->payby,
2475 'payinfo' => $options{payinfo} || $self->payinfo,
2476 'exp' => $options{paydate} || $self->paydate,
2477 'payname' => $options{payname} || $self->payname,
2478 'amount' => $amount, # consolidating
2481 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2482 if $old_cust_pay_batch;
2485 if ($old_cust_pay_batch) {
2486 $error = $cust_pay_batch->replace($old_cust_pay_batch)
2488 $error = $cust_pay_batch->insert;
2492 $dbh->rollback if $oldAutoCommit;
2496 my $unapplied = $self->total_unapplied_credits
2497 + $self->total_unapplied_payments
2498 + $self->in_transit_payments;
2499 foreach my $cust_bill ($self->open_cust_bill) {
2500 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2501 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2502 'invnum' => $cust_bill->invnum,
2503 'paybatchnum' => $cust_pay_batch->paybatchnum,
2504 'amount' => $cust_bill->owed,
2507 if ($unapplied >= $cust_bill_pay_batch->amount){
2508 $unapplied -= $cust_bill_pay_batch->amount;
2511 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2512 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
2514 $error = $cust_bill_pay_batch->insert;
2516 $dbh->rollback if $oldAutoCommit;
2521 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2527 Returns the total owed for this customer on all invoices
2528 (see L<FS::cust_bill/owed>).
2534 $self->total_owed_date(2145859200); #12/31/2037
2537 =item total_owed_date TIME
2539 Returns the total owed for this customer on all invoices with date earlier than
2540 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2541 see L<Time::Local> and L<Date::Parse> for conversion functions.
2545 sub total_owed_date {
2549 my $custnum = $self->custnum;
2551 my $owed_sql = FS::cust_bill->owed_sql;
2554 SELECT SUM($owed_sql) FROM cust_bill
2555 WHERE custnum = $custnum
2559 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2563 =item total_owed_pkgnum PKGNUM
2565 Returns the total owed on all invoices for this customer's specific package
2566 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2570 sub total_owed_pkgnum {
2571 my( $self, $pkgnum ) = @_;
2572 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2575 =item total_owed_date_pkgnum TIME PKGNUM
2577 Returns the total owed for this customer's specific package when using
2578 experimental package balances on all invoices with date earlier than
2579 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2580 see L<Time::Local> and L<Date::Parse> for conversion functions.
2584 sub total_owed_date_pkgnum {
2585 my( $self, $time, $pkgnum ) = @_;
2588 foreach my $cust_bill (
2589 grep { $_->_date <= $time }
2590 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2592 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2594 sprintf( "%.2f", $total_bill );
2600 Returns the total amount of all payments.
2607 $total += $_->paid foreach $self->cust_pay;
2608 sprintf( "%.2f", $total );
2611 =item total_unapplied_credits
2613 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2614 customer. See L<FS::cust_credit/credited>.
2616 =item total_credited
2618 Old name for total_unapplied_credits. Don't use.
2622 sub total_credited {
2623 #carp "total_credited deprecated, use total_unapplied_credits";
2624 shift->total_unapplied_credits(@_);
2627 sub total_unapplied_credits {
2630 my $custnum = $self->custnum;
2632 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2635 SELECT SUM($unapplied_sql) FROM cust_credit
2636 WHERE custnum = $custnum
2639 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2643 =item total_unapplied_credits_pkgnum PKGNUM
2645 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2646 customer. See L<FS::cust_credit/credited>.
2650 sub total_unapplied_credits_pkgnum {
2651 my( $self, $pkgnum ) = @_;
2652 my $total_credit = 0;
2653 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2654 sprintf( "%.2f", $total_credit );
2658 =item total_unapplied_payments
2660 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2661 See L<FS::cust_pay/unapplied>.
2665 sub total_unapplied_payments {
2668 my $custnum = $self->custnum;
2670 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2673 SELECT SUM($unapplied_sql) FROM cust_pay
2674 WHERE custnum = $custnum
2677 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2681 =item total_unapplied_payments_pkgnum PKGNUM
2683 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2684 specific package when using experimental package balances. See
2685 L<FS::cust_pay/unapplied>.
2689 sub total_unapplied_payments_pkgnum {
2690 my( $self, $pkgnum ) = @_;
2691 my $total_unapplied = 0;
2692 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2693 sprintf( "%.2f", $total_unapplied );
2697 =item total_unapplied_refunds
2699 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2700 customer. See L<FS::cust_refund/unapplied>.
2704 sub total_unapplied_refunds {
2706 my $custnum = $self->custnum;
2708 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2711 SELECT SUM($unapplied_sql) FROM cust_refund
2712 WHERE custnum = $custnum
2715 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2721 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2722 total_unapplied_credits minus total_unapplied_payments).
2728 $self->balance_date_range;
2731 =item balance_date TIME
2733 Returns the balance for this customer, only considering invoices with date
2734 earlier than TIME (total_owed_date minus total_credited minus
2735 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2736 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2743 $self->balance_date_range(shift);
2746 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2748 Returns the balance for this customer, optionally considering invoices with
2749 date earlier than START_TIME, and not later than END_TIME
2750 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2752 Times are specified as SQL fragments or numeric
2753 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2754 L<Date::Parse> for conversion functions. The empty string can be passed
2755 to disable that time constraint completely.
2757 Available options are:
2761 =item unapplied_date
2763 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)
2769 sub balance_date_range {
2771 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2772 ') FROM cust_main WHERE custnum='. $self->custnum;
2773 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2776 =item balance_pkgnum PKGNUM
2778 Returns the balance for this customer's specific package when using
2779 experimental package balances (total_owed plus total_unrefunded, minus
2780 total_unapplied_credits minus total_unapplied_payments)
2784 sub balance_pkgnum {
2785 my( $self, $pkgnum ) = @_;
2788 $self->total_owed_pkgnum($pkgnum)
2789 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2790 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2791 - $self->total_unapplied_credits_pkgnum($pkgnum)
2792 - $self->total_unapplied_payments_pkgnum($pkgnum)
2796 =item in_transit_payments
2798 Returns the total of requests for payments for this customer pending in
2799 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
2803 sub in_transit_payments {
2805 my $in_transit_payments = 0;
2806 foreach my $pay_batch ( qsearch('pay_batch', {
2809 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2810 'batchnum' => $pay_batch->batchnum,
2811 'custnum' => $self->custnum,
2813 $in_transit_payments += $cust_pay_batch->amount;
2816 sprintf( "%.2f", $in_transit_payments );
2821 Returns a hash of useful information for making a payment.
2831 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2832 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2833 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2837 For credit card transactions:
2849 For electronic check transactions:
2864 $return{balance} = $self->balance;
2866 $return{payname} = $self->payname
2867 || ( $self->first. ' '. $self->get('last') );
2869 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
2871 $return{payby} = $self->payby;
2872 $return{stateid_state} = $self->stateid_state;
2874 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2875 $return{card_type} = cardtype($self->payinfo);
2876 $return{payinfo} = $self->paymask;
2878 @return{'month', 'year'} = $self->paydate_monthyear;
2882 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2883 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2884 $return{payinfo1} = $payinfo1;
2885 $return{payinfo2} = $payinfo2;
2886 $return{paytype} = $self->paytype;
2887 $return{paystate} = $self->paystate;
2891 #doubleclick protection
2893 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2899 =item paydate_monthyear
2901 Returns a two-element list consisting of the month and year of this customer's
2902 paydate (credit card expiration date for CARD customers)
2906 sub paydate_monthyear {
2908 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
2910 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2917 =item tax_exemption TAXNAME
2922 my( $self, $taxname ) = @_;
2924 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
2925 'taxname' => $taxname,
2930 =item cust_main_exemption
2934 sub cust_main_exemption {
2936 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
2939 =item invoicing_list [ ARRAYREF ]
2941 If an arguement is given, sets these email addresses as invoice recipients
2942 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
2943 (except as warnings), so use check_invoicing_list first.
2945 Returns a list of email addresses (with svcnum entries expanded).
2947 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
2948 check it without disturbing anything by passing nothing.
2950 This interface may change in the future.
2954 sub invoicing_list {
2955 my( $self, $arrayref ) = @_;
2958 my @cust_main_invoice;
2959 if ( $self->custnum ) {
2960 @cust_main_invoice =
2961 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
2963 @cust_main_invoice = ();
2965 foreach my $cust_main_invoice ( @cust_main_invoice ) {
2966 #warn $cust_main_invoice->destnum;
2967 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
2968 #warn $cust_main_invoice->destnum;
2969 my $error = $cust_main_invoice->delete;
2970 warn $error if $error;
2973 if ( $self->custnum ) {
2974 @cust_main_invoice =
2975 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
2977 @cust_main_invoice = ();
2979 my %seen = map { $_->address => 1 } @cust_main_invoice;
2980 foreach my $address ( @{$arrayref} ) {
2981 next if exists $seen{$address} && $seen{$address};
2982 $seen{$address} = 1;
2983 my $cust_main_invoice = new FS::cust_main_invoice ( {
2984 'custnum' => $self->custnum,
2987 my $error = $cust_main_invoice->insert;
2988 warn $error if $error;
2992 if ( $self->custnum ) {
2994 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3001 =item check_invoicing_list ARRAYREF
3003 Checks these arguements as valid input for the invoicing_list method. If there
3004 is an error, returns the error, otherwise returns false.
3008 sub check_invoicing_list {
3009 my( $self, $arrayref ) = @_;
3011 foreach my $address ( @$arrayref ) {
3013 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3014 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3017 my $cust_main_invoice = new FS::cust_main_invoice ( {
3018 'custnum' => $self->custnum,
3021 my $error = $self->custnum
3022 ? $cust_main_invoice->check
3023 : $cust_main_invoice->checkdest
3025 return $error if $error;
3029 return "Email address required"
3030 if $conf->exists('cust_main-require_invoicing_list_email')
3031 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3036 =item set_default_invoicing_list
3038 Sets the invoicing list to all accounts associated with this customer,
3039 overwriting any previous invoicing list.
3043 sub set_default_invoicing_list {
3045 $self->invoicing_list($self->all_emails);
3050 Returns the email addresses of all accounts provisioned for this customer.
3057 foreach my $cust_pkg ( $self->all_pkgs ) {
3058 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3060 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3061 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3063 $list{$_}=1 foreach map { $_->email } @svc_acct;
3068 =item invoicing_list_addpost
3070 Adds postal invoicing to this customer. If this customer is already configured
3071 to receive postal invoices, does nothing.
3075 sub invoicing_list_addpost {
3077 return if grep { $_ eq 'POST' } $self->invoicing_list;
3078 my @invoicing_list = $self->invoicing_list;
3079 push @invoicing_list, 'POST';
3080 $self->invoicing_list(\@invoicing_list);
3083 =item invoicing_list_emailonly
3085 Returns the list of email invoice recipients (invoicing_list without non-email
3086 destinations such as POST and FAX).
3090 sub invoicing_list_emailonly {
3092 warn "$me invoicing_list_emailonly called"
3094 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3097 =item invoicing_list_emailonly_scalar
3099 Returns the list of email invoice recipients (invoicing_list without non-email
3100 destinations such as POST and FAX) as a comma-separated scalar.
3104 sub invoicing_list_emailonly_scalar {
3106 warn "$me invoicing_list_emailonly_scalar called"
3108 join(', ', $self->invoicing_list_emailonly);
3111 =item referral_custnum_cust_main
3113 Returns the customer who referred this customer (or the empty string, if
3114 this customer was not referred).
3116 Note the difference with referral_cust_main method: This method,
3117 referral_custnum_cust_main returns the single customer (if any) who referred
3118 this customer, while referral_cust_main returns an array of customers referred
3123 sub referral_custnum_cust_main {
3125 return '' unless $self->referral_custnum;
3126 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3129 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3131 Returns an array of customers referred by this customer (referral_custnum set
3132 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3133 customers referred by customers referred by this customer and so on, inclusive.
3134 The default behavior is DEPTH 1 (no recursion).
3136 Note the difference with referral_custnum_cust_main method: This method,
3137 referral_cust_main, returns an array of customers referred BY this customer,
3138 while referral_custnum_cust_main returns the single customer (if any) who
3139 referred this customer.
3143 sub referral_cust_main {
3145 my $depth = @_ ? shift : 1;
3146 my $exclude = @_ ? shift : {};
3149 map { $exclude->{$_->custnum}++; $_; }
3150 grep { ! $exclude->{ $_->custnum } }
3151 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3155 map { $_->referral_cust_main($depth-1, $exclude) }
3162 =item referral_cust_main_ncancelled
3164 Same as referral_cust_main, except only returns customers with uncancelled
3169 sub referral_cust_main_ncancelled {
3171 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3174 =item referral_cust_pkg [ DEPTH ]
3176 Like referral_cust_main, except returns a flat list of all unsuspended (and
3177 uncancelled) packages for each customer. The number of items in this list may
3178 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3182 sub referral_cust_pkg {
3184 my $depth = @_ ? shift : 1;
3186 map { $_->unsuspended_pkgs }
3187 grep { $_->unsuspended_pkgs }
3188 $self->referral_cust_main($depth);
3191 =item referring_cust_main
3193 Returns the single cust_main record for the customer who referred this customer
3194 (referral_custnum), or false.
3198 sub referring_cust_main {
3200 return '' unless $self->referral_custnum;
3201 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3204 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3206 Applies a credit to this customer. If there is an error, returns the error,
3207 otherwise returns false.
3209 REASON can be a text string, an FS::reason object, or a scalar reference to
3210 a reasonnum. If a text string, it will be automatically inserted as a new
3211 reason, and a 'reason_type' option must be passed to indicate the
3212 FS::reason_type for the new reason.
3214 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3216 Any other options are passed to FS::cust_credit::insert.
3221 my( $self, $amount, $reason, %options ) = @_;
3223 my $cust_credit = new FS::cust_credit {
3224 'custnum' => $self->custnum,
3225 'amount' => $amount,
3228 if ( ref($reason) ) {
3230 if ( ref($reason) eq 'SCALAR' ) {
3231 $cust_credit->reasonnum( $$reason );
3233 $cust_credit->reasonnum( $reason->reasonnum );
3237 $cust_credit->set('reason', $reason)
3240 for (qw( addlinfo eventnum )) {
3241 $cust_credit->$_( delete $options{$_} )
3242 if exists($options{$_});
3245 $cust_credit->insert(%options);
3249 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3251 Creates a one-time charge for this customer. If there is an error, returns
3252 the error, otherwise returns false.
3254 New-style, with a hashref of options:
3256 my $error = $cust_main->charge(
3260 'start_date' => str2time('7/4/2009'),
3261 'pkg' => 'Description',
3262 'comment' => 'Comment',
3263 'additional' => [], #extra invoice detail
3264 'classnum' => 1, #pkg_class
3266 'setuptax' => '', # or 'Y' for tax exempt
3269 'taxclass' => 'Tax class',
3272 'taxproduct' => 2, #part_pkg_taxproduct
3273 'override' => {}, #XXX describe
3275 #will be filled in with the new object
3276 'cust_pkg_ref' => \$cust_pkg,
3278 #generate an invoice immediately
3280 'invoice_terms' => '', #with these terms
3286 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3292 my ( $amount, $quantity, $start_date, $classnum );
3293 my ( $pkg, $comment, $additional );
3294 my ( $setuptax, $taxclass ); #internal taxes
3295 my ( $taxproduct, $override ); #vendor (CCH) taxes
3297 my $cust_pkg_ref = '';
3298 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3299 if ( ref( $_[0] ) ) {
3300 $amount = $_[0]->{amount};
3301 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3302 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3303 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3304 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3305 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3306 : '$'. sprintf("%.2f",$amount);
3307 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3308 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3309 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3310 $additional = $_[0]->{additional} || [];
3311 $taxproduct = $_[0]->{taxproductnum};
3312 $override = { '' => $_[0]->{tax_override} };
3313 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3314 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3315 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3320 $pkg = @_ ? shift : 'One-time charge';
3321 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3323 $taxclass = @_ ? shift : '';
3327 local $SIG{HUP} = 'IGNORE';
3328 local $SIG{INT} = 'IGNORE';
3329 local $SIG{QUIT} = 'IGNORE';
3330 local $SIG{TERM} = 'IGNORE';
3331 local $SIG{TSTP} = 'IGNORE';
3332 local $SIG{PIPE} = 'IGNORE';
3334 my $oldAutoCommit = $FS::UID::AutoCommit;
3335 local $FS::UID::AutoCommit = 0;
3338 my $part_pkg = new FS::part_pkg ( {
3340 'comment' => $comment,
3344 'classnum' => ( $classnum ? $classnum : '' ),
3345 'setuptax' => $setuptax,
3346 'taxclass' => $taxclass,
3347 'taxproductnum' => $taxproduct,
3350 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3351 ( 0 .. @$additional - 1 )
3353 'additional_count' => scalar(@$additional),
3354 'setup_fee' => $amount,
3357 my $error = $part_pkg->insert( options => \%options,
3358 tax_overrides => $override,
3361 $dbh->rollback if $oldAutoCommit;
3365 my $pkgpart = $part_pkg->pkgpart;
3366 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3367 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3368 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3369 $error = $type_pkgs->insert;
3371 $dbh->rollback if $oldAutoCommit;
3376 my $cust_pkg = new FS::cust_pkg ( {
3377 'custnum' => $self->custnum,
3378 'pkgpart' => $pkgpart,
3379 'quantity' => $quantity,
3380 'start_date' => $start_date,
3381 'no_auto' => $no_auto,
3384 $error = $cust_pkg->insert;
3386 $dbh->rollback if $oldAutoCommit;
3388 } elsif ( $cust_pkg_ref ) {
3389 ${$cust_pkg_ref} = $cust_pkg;
3393 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3394 'pkg_list' => [ $cust_pkg ],
3397 $dbh->rollback if $oldAutoCommit;
3402 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3407 #=item charge_postal_fee
3409 #Applies a one time charge this customer. If there is an error,
3410 #returns the error, returns the cust_pkg charge object or false
3411 #if there was no charge.
3415 # This should be a customer event. For that to work requires that bill
3416 # also be a customer event.
3418 sub charge_postal_fee {
3421 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3422 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3424 my $cust_pkg = new FS::cust_pkg ( {
3425 'custnum' => $self->custnum,
3426 'pkgpart' => $pkgpart,
3430 my $error = $cust_pkg->insert;
3431 $error ? $error : $cust_pkg;
3434 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3436 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3438 Optionally, a list or hashref of additional arguments to the qsearch call can
3445 my $opt = ref($_[0]) ? shift : { @_ };
3447 #return $self->num_cust_bill unless wantarray || keys %$opt;
3449 $opt->{'table'} = 'cust_bill';
3450 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3451 $opt->{'hashref'}{'custnum'} = $self->custnum;
3452 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3454 map { $_ } #behavior of sort undefined in scalar context
3455 sort { $a->_date <=> $b->_date }
3459 =item open_cust_bill
3461 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3466 sub open_cust_bill {
3470 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3476 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3478 Returns all the statements (see L<FS::cust_statement>) for this customer.
3480 Optionally, a list or hashref of additional arguments to the qsearch call can
3485 sub cust_statement {
3487 my $opt = ref($_[0]) ? shift : { @_ };
3489 #return $self->num_cust_statement unless wantarray || keys %$opt;
3491 $opt->{'table'} = 'cust_statement';
3492 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3493 $opt->{'hashref'}{'custnum'} = $self->custnum;
3494 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3496 map { $_ } #behavior of sort undefined in scalar context
3497 sort { $a->_date <=> $b->_date }
3503 Returns all the credits (see L<FS::cust_credit>) for this customer.
3509 map { $_ } #return $self->num_cust_credit unless wantarray;
3510 sort { $a->_date <=> $b->_date }
3511 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3514 =item cust_credit_pkgnum
3516 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3517 package when using experimental package balances.
3521 sub cust_credit_pkgnum {
3522 my( $self, $pkgnum ) = @_;
3523 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3524 sort { $a->_date <=> $b->_date }
3525 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3526 'pkgnum' => $pkgnum,
3533 Returns all the payments (see L<FS::cust_pay>) for this customer.
3539 return $self->num_cust_pay unless wantarray;
3540 sort { $a->_date <=> $b->_date }
3541 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3546 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3547 called automatically when the cust_pay method is used in a scalar context.
3553 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3554 my $sth = dbh->prepare($sql) or die dbh->errstr;
3555 $sth->execute($self->custnum) or die $sth->errstr;
3556 $sth->fetchrow_arrayref->[0];
3559 =item cust_pay_pkgnum
3561 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3562 package when using experimental package balances.
3566 sub cust_pay_pkgnum {
3567 my( $self, $pkgnum ) = @_;
3568 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3569 sort { $a->_date <=> $b->_date }
3570 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3571 'pkgnum' => $pkgnum,
3578 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3584 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3585 sort { $a->_date <=> $b->_date }
3586 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3589 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3591 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
3593 Optionally, a list or hashref of additional arguments to the qsearch call can
3598 sub cust_pay_batch {
3600 my $opt = ref($_[0]) ? shift : { @_ };
3602 #return $self->num_cust_statement unless wantarray || keys %$opt;
3604 $opt->{'table'} = 'cust_pay_batch';
3605 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3606 $opt->{'hashref'}{'custnum'} = $self->custnum;
3607 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3609 map { $_ } #behavior of sort undefined in scalar context
3610 sort { $a->paybatchnum <=> $b->paybatchnum }
3614 =item cust_pay_pending
3616 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3617 (without status "done").
3621 sub cust_pay_pending {
3623 return $self->num_cust_pay_pending unless wantarray;
3624 sort { $a->_date <=> $b->_date }
3625 qsearch( 'cust_pay_pending', {
3626 'custnum' => $self->custnum,
3627 'status' => { op=>'!=', value=>'done' },
3632 =item cust_pay_pending_attempt
3634 Returns all payment attempts / declined payments for this customer, as pending
3635 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3636 a corresponding payment (see L<FS::cust_pay>).
3640 sub cust_pay_pending_attempt {
3642 return $self->num_cust_pay_pending_attempt unless wantarray;
3643 sort { $a->_date <=> $b->_date }
3644 qsearch( 'cust_pay_pending', {
3645 'custnum' => $self->custnum,
3652 =item num_cust_pay_pending
3654 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3655 customer (without status "done"). Also called automatically when the
3656 cust_pay_pending method is used in a scalar context.
3660 sub num_cust_pay_pending {
3663 " SELECT COUNT(*) FROM cust_pay_pending ".
3664 " WHERE custnum = ? AND status != 'done' ",
3669 =item num_cust_pay_pending_attempt
3671 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3672 customer, with status "done" but without a corresp. Also called automatically when the
3673 cust_pay_pending method is used in a scalar context.
3677 sub num_cust_pay_pending_attempt {
3680 " SELECT COUNT(*) FROM cust_pay_pending ".
3681 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3688 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3694 map { $_ } #return $self->num_cust_refund unless wantarray;
3695 sort { $a->_date <=> $b->_date }
3696 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3699 =item display_custnum
3701 Returns the displayed customer number for this customer: agent_custid if
3702 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3706 sub display_custnum {
3708 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3709 return $self->agent_custid;
3711 return $self->custnum;
3717 Returns a name string for this customer, either "Company (Last, First)" or
3724 my $name = $self->contact;
3725 $name = $self->company. " ($name)" if $self->company;
3731 Returns a name string for this (service/shipping) contact, either
3732 "Company (Last, First)" or "Last, First".
3738 if ( $self->get('ship_last') ) {
3739 my $name = $self->ship_contact;
3740 $name = $self->ship_company. " ($name)" if $self->ship_company;
3749 Returns a name string for this customer, either "Company" or "First Last".
3755 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
3758 =item ship_name_short
3760 Returns a name string for this (service/shipping) contact, either "Company"
3765 sub ship_name_short {
3767 if ( $self->get('ship_last') ) {
3768 $self->ship_company !~ /^\s*$/
3769 ? $self->ship_company
3770 : $self->ship_contact_firstlast;
3772 $self->name_company_or_firstlast;
3778 Returns this customer's full (billing) contact name only, "Last, First"
3784 $self->get('last'). ', '. $self->first;
3789 Returns this customer's full (shipping) contact name only, "Last, First"
3795 $self->get('ship_last')
3796 ? $self->get('ship_last'). ', '. $self->ship_first
3800 =item contact_firstlast
3802 Returns this customers full (billing) contact name only, "First Last".
3806 sub contact_firstlast {
3808 $self->first. ' '. $self->get('last');
3811 =item ship_contact_firstlast
3813 Returns this customer's full (shipping) contact name only, "First Last".
3817 sub ship_contact_firstlast {
3819 $self->get('ship_last')
3820 ? $self->first. ' '. $self->get('ship_last')
3821 : $self->contact_firstlast;
3826 Returns this customer's full country name
3832 code2country($self->country);
3835 =item geocode DATA_VENDOR
3837 Returns a value for the customer location as encoded by DATA_VENDOR.
3838 Currently this only makes sense for "CCH" as DATA_VENDOR.
3846 Returns a status string for this customer, currently:
3850 =item prospect - No packages have ever been ordered
3852 =item ordered - Recurring packages all are new (not yet billed).
3854 =item active - One or more recurring packages is active
3856 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
3858 =item suspended - All non-cancelled recurring packages are suspended
3860 =item cancelled - All recurring packages are cancelled
3864 Behavior of inactive vs. cancelled edge cases can be adjusted with the
3865 cust_main-status_module configuration option.
3869 sub status { shift->cust_status(@_); }
3873 for my $status ( FS::cust_main->statuses() ) {
3874 my $method = $status.'_sql';
3875 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
3876 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
3877 $sth->execute( ($self->custnum) x $numnum )
3878 or die "Error executing 'SELECT $sql': ". $sth->errstr;
3879 return $status if $sth->fetchrow_arrayref->[0];
3883 =item ucfirst_cust_status
3885 =item ucfirst_status
3887 Returns the status with the first character capitalized.
3891 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
3893 sub ucfirst_cust_status {
3895 ucfirst($self->cust_status);
3900 Returns a hex triplet color string for this customer's status.
3904 sub statuscolor { shift->cust_statuscolor(@_); }
3906 sub cust_statuscolor {
3908 __PACKAGE__->statuscolors->{$self->cust_status};
3913 Returns an array of hashes representing the customer's RT tickets.
3920 my $num = $conf->config('cust_main-max_tickets') || 10;
3923 if ( $conf->config('ticket_system') ) {
3924 unless ( $conf->config('ticket_system-custom_priority_field') ) {
3926 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
3930 foreach my $priority (
3931 $conf->config('ticket_system-custom_priority_field-values'), ''
3933 last if scalar(@tickets) >= $num;
3935 @{ FS::TicketSystem->customer_tickets( $self->custnum,
3936 $num - scalar(@tickets),
3946 # Return services representing svc_accts in customer support packages
3947 sub support_services {
3949 my %packages = map { $_ => 1 } $conf->config('support_packages');
3951 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
3952 grep { $_->part_svc->svcdb eq 'svc_acct' }
3953 map { $_->cust_svc }
3954 grep { exists $packages{ $_->pkgpart } }
3955 $self->ncancelled_pkgs;
3959 # Return a list of latitude/longitude for one of the services (if any)
3960 sub service_coordinates {
3964 grep { $_->latitude && $_->longitude }
3966 map { $_->cust_svc }
3967 $self->ncancelled_pkgs;
3969 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
3974 Returns a masked version of the named field
3979 my ($self,$field) = @_;
3983 'x'x(length($self->getfield($field))-4).
3984 substr($self->getfield($field), (length($self->getfield($field))-4));
3990 =head1 CLASS METHODS
3996 Class method that returns the list of possible status strings for customers
3997 (see L<the status method|/status>). For example:
3999 @statuses = FS::cust_main->statuses();
4005 keys %{ $self->statuscolors };
4008 =item cust_status_sql
4010 Returns an SQL fragment to determine the status of a cust_main record, as a
4015 sub cust_status_sql {
4017 for my $status ( FS::cust_main->statuses() ) {
4018 my $method = $status.'_sql';
4019 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4028 Returns an SQL expression identifying prospective cust_main records (customers
4029 with no packages ever ordered)
4033 use vars qw($select_count_pkgs);
4034 $select_count_pkgs =
4035 "SELECT COUNT(*) FROM cust_pkg
4036 WHERE cust_pkg.custnum = cust_main.custnum";
4038 sub select_count_pkgs_sql {
4043 " 0 = ( $select_count_pkgs ) ";
4048 Returns an SQL expression identifying ordered cust_main records (customers with
4049 no active packages, but recurring packages not yet setup or one time charges
4055 FS::cust_main->none_active_sql.
4056 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4061 Returns an SQL expression identifying active cust_main records (customers with
4062 active recurring packages).
4067 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4070 =item none_active_sql
4072 Returns an SQL expression identifying cust_main records with no active
4073 recurring packages. This includes customers of status prospect, ordered,
4074 inactive, and suspended.
4078 sub none_active_sql {
4079 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4084 Returns an SQL expression identifying inactive cust_main records (customers with
4085 no active recurring packages, but otherwise unsuspended/uncancelled).
4090 FS::cust_main->none_active_sql.
4091 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4097 Returns an SQL expression identifying suspended cust_main records.
4102 sub suspended_sql { susp_sql(@_); }
4104 FS::cust_main->none_active_sql.
4105 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4111 Returns an SQL expression identifying cancelled cust_main records.
4115 sub cancel_sql { shift->cancelled_sql(@_); }
4118 =item uncancelled_sql
4120 Returns an SQL expression identifying un-cancelled cust_main records.
4124 sub uncancelled_sql { uncancel_sql(@_); }
4125 sub uncancel_sql { "
4126 ( 0 < ( $select_count_pkgs
4127 AND ( cust_pkg.cancel IS NULL
4128 OR cust_pkg.cancel = 0
4131 OR 0 = ( $select_count_pkgs )
4137 Returns an SQL fragment to retreive the balance.
4142 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4143 WHERE cust_bill.custnum = cust_main.custnum )
4144 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4145 WHERE cust_pay.custnum = cust_main.custnum )
4146 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4147 WHERE cust_credit.custnum = cust_main.custnum )
4148 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4149 WHERE cust_refund.custnum = cust_main.custnum )
4152 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4154 Returns an SQL fragment to retreive the balance for this customer, optionally
4155 considering invoices with date earlier than START_TIME, and not
4156 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4157 total_unapplied_payments).
4159 Times are specified as SQL fragments or numeric
4160 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4161 L<Date::Parse> for conversion functions. The empty string can be passed
4162 to disable that time constraint completely.
4164 Available options are:
4168 =item unapplied_date
4170 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)
4175 set to true to remove all customer comparison clauses, for totals
4180 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4185 JOIN clause (typically used with the total option)
4189 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4190 time will be ignored. Note that START_TIME and END_TIME only limit the date
4191 range for invoices and I<unapplied> payments, credits, and refunds.
4197 sub balance_date_sql {
4198 my( $class, $start, $end, %opt ) = @_;
4200 my $cutoff = $opt{'cutoff'};
4202 my $owed = FS::cust_bill->owed_sql($cutoff);
4203 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4204 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4205 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4207 my $j = $opt{'join'} || '';
4209 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4210 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4211 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4212 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4214 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4215 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4216 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4217 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4222 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4224 Returns an SQL fragment to retreive the total unapplied payments for this
4225 customer, only considering payments with date earlier than START_TIME, and
4226 optionally not later than END_TIME.
4228 Times are specified as SQL fragments or numeric
4229 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4230 L<Date::Parse> for conversion functions. The empty string can be passed
4231 to disable that time constraint completely.
4233 Available options are:
4237 sub unapplied_payments_date_sql {
4238 my( $class, $start, $end, %opt ) = @_;
4240 my $cutoff = $opt{'cutoff'};
4242 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4244 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4245 'unapplied_date'=>1 );
4247 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4250 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4252 Helper method for balance_date_sql; name (and usage) subject to change
4253 (suggestions welcome).
4255 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4256 cust_refund, cust_credit or cust_pay).
4258 If TABLE is "cust_bill" or the unapplied_date option is true, only
4259 considers records with date earlier than START_TIME, and optionally not
4260 later than END_TIME .
4264 sub _money_table_where {
4265 my( $class, $table, $start, $end, %opt ) = @_;
4268 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4269 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4270 push @where, "$table._date <= $start" if defined($start) && length($start);
4271 push @where, "$table._date > $end" if defined($end) && length($end);
4273 push @where, @{$opt{'where'}} if $opt{'where'};
4274 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4280 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4281 use FS::cust_main::Search;
4284 FS::cust_main::Search->search(@_);
4293 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
4297 use FS::cust_main::Search;
4298 sub append_fuzzyfiles {
4299 #my( $first, $last, $company ) = @_;
4301 FS::cust_main::Search::check_and_rebuild_fuzzyfiles();
4303 use Fcntl qw(:flock);
4305 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
4307 foreach my $field (@fuzzyfields) {
4312 open(CACHE,">>$dir/cust_main.$field")
4313 or die "can't open $dir/cust_main.$field: $!";
4314 flock(CACHE,LOCK_EX)
4315 or die "can't lock $dir/cust_main.$field: $!";
4317 print CACHE "$value\n";
4319 flock(CACHE,LOCK_UN)
4320 or die "can't unlock $dir/cust_main.$field: $!";
4335 #warn join('-',keys %$param);
4336 my $fh = $param->{filehandle};
4337 my $agentnum = $param->{agentnum};
4338 my $format = $param->{format};
4340 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
4343 if ( $format eq 'simple' ) {
4344 @fields = qw( custnum agent_custid amount pkg );
4346 die "unknown format $format";
4349 eval "use Text::CSV_XS;";
4352 my $csv = new Text::CSV_XS;
4359 local $SIG{HUP} = 'IGNORE';
4360 local $SIG{INT} = 'IGNORE';
4361 local $SIG{QUIT} = 'IGNORE';
4362 local $SIG{TERM} = 'IGNORE';
4363 local $SIG{TSTP} = 'IGNORE';
4364 local $SIG{PIPE} = 'IGNORE';
4366 my $oldAutoCommit = $FS::UID::AutoCommit;
4367 local $FS::UID::AutoCommit = 0;
4370 #while ( $columns = $csv->getline($fh) ) {
4372 while ( defined($line=<$fh>) ) {
4374 $csv->parse($line) or do {
4375 $dbh->rollback if $oldAutoCommit;
4376 return "can't parse: ". $csv->error_input();
4379 my @columns = $csv->fields();
4380 #warn join('-',@columns);
4383 foreach my $field ( @fields ) {
4384 $row{$field} = shift @columns;
4387 if ( $row{custnum} && $row{agent_custid} ) {
4388 dbh->rollback if $oldAutoCommit;
4389 return "can't specify custnum with agent_custid $row{agent_custid}";
4393 if ( $row{agent_custid} && $agentnum ) {
4394 %hash = ( 'agent_custid' => $row{agent_custid},
4395 'agentnum' => $agentnum,
4399 if ( $row{custnum} ) {
4400 %hash = ( 'custnum' => $row{custnum} );
4403 unless ( scalar(keys %hash) ) {
4404 $dbh->rollback if $oldAutoCommit;
4405 return "can't find customer without custnum or agent_custid and agentnum";
4408 my $cust_main = qsearchs('cust_main', { %hash } );
4409 unless ( $cust_main ) {
4410 $dbh->rollback if $oldAutoCommit;
4411 my $custnum = $row{custnum} || $row{agent_custid};
4412 return "unknown custnum $custnum";
4415 if ( $row{'amount'} > 0 ) {
4416 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4418 $dbh->rollback if $oldAutoCommit;
4422 } elsif ( $row{'amount'} < 0 ) {
4423 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4426 $dbh->rollback if $oldAutoCommit;
4436 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4438 return "Empty file!" unless $imported;
4444 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4446 Deprecated. Use event notification and message templates
4447 (L<FS::msg_template>) instead.
4449 Sends a templated email notification to the customer (see L<Text::Template>).
4451 OPTIONS is a hash and may include
4453 I<from> - the email sender (default is invoice_from)
4455 I<to> - comma-separated scalar or arrayref of recipients
4456 (default is invoicing_list)
4458 I<subject> - The subject line of the sent email notification
4459 (default is "Notice from company_name")
4461 I<extra_fields> - a hashref of name/value pairs which will be substituted
4464 The following variables are vavailable in the template.
4466 I<$first> - the customer first name
4467 I<$last> - the customer last name
4468 I<$company> - the customer company
4469 I<$payby> - a description of the method of payment for the customer
4470 # would be nice to use FS::payby::shortname
4471 I<$payinfo> - the account information used to collect for this customer
4472 I<$expdate> - the expiration of the customer payment in seconds from epoch
4477 my ($self, $template, %options) = @_;
4479 return unless $conf->exists($template);
4481 my $from = $conf->config('invoice_from', $self->agentnum)
4482 if $conf->exists('invoice_from', $self->agentnum);
4483 $from = $options{from} if exists($options{from});
4485 my $to = join(',', $self->invoicing_list_emailonly);
4486 $to = $options{to} if exists($options{to});
4488 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4489 if $conf->exists('company_name', $self->agentnum);
4490 $subject = $options{subject} if exists($options{subject});
4492 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4493 SOURCE => [ map "$_\n",
4494 $conf->config($template)]
4496 or die "can't create new Text::Template object: Text::Template::ERROR";
4497 $notify_template->compile()
4498 or die "can't compile template: Text::Template::ERROR";
4500 $FS::notify_template::_template::company_name =
4501 $conf->config('company_name', $self->agentnum);
4502 $FS::notify_template::_template::company_address =
4503 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4505 my $paydate = $self->paydate || '2037-12-31';
4506 $FS::notify_template::_template::first = $self->first;
4507 $FS::notify_template::_template::last = $self->last;
4508 $FS::notify_template::_template::company = $self->company;
4509 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4510 my $payby = $self->payby;
4511 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4512 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4514 #credit cards expire at the end of the month/year of their exp date
4515 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4516 $FS::notify_template::_template::payby = 'credit card';
4517 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4518 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4520 }elsif ($payby eq 'COMP') {
4521 $FS::notify_template::_template::payby = 'complimentary account';
4523 $FS::notify_template::_template::payby = 'current method';
4525 $FS::notify_template::_template::expdate = $expire_time;
4527 for (keys %{$options{extra_fields}}){
4529 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4532 send_email(from => $from,
4534 subject => $subject,
4535 body => $notify_template->fill_in( PACKAGE =>
4536 'FS::notify_template::_template' ),
4541 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4543 Generates a templated notification to the customer (see L<Text::Template>).
4545 OPTIONS is a hash and may include
4547 I<extra_fields> - a hashref of name/value pairs which will be substituted
4548 into the template. These values may override values mentioned below
4549 and those from the customer record.
4551 The following variables are available in the template instead of or in addition
4552 to the fields of the customer record.
4554 I<$payby> - a description of the method of payment for the customer
4555 # would be nice to use FS::payby::shortname
4556 I<$payinfo> - the masked account information used to collect for this customer
4557 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4558 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4562 # a lot like cust_bill::print_latex
4563 sub generate_letter {
4564 my ($self, $template, %options) = @_;
4566 return unless $conf->exists($template);
4568 my $letter_template = new Text::Template
4570 SOURCE => [ map "$_\n", $conf->config($template)],
4571 DELIMITERS => [ '[@--', '--@]' ],
4573 or die "can't create new Text::Template object: Text::Template::ERROR";
4575 $letter_template->compile()
4576 or die "can't compile template: Text::Template::ERROR";
4578 my %letter_data = map { $_ => $self->$_ } $self->fields;
4579 $letter_data{payinfo} = $self->mask_payinfo;
4581 #my $paydate = $self->paydate || '2037-12-31';
4582 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4584 my $payby = $self->payby;
4585 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4586 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4588 #credit cards expire at the end of the month/year of their exp date
4589 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4590 $letter_data{payby} = 'credit card';
4591 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4592 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4594 }elsif ($payby eq 'COMP') {
4595 $letter_data{payby} = 'complimentary account';
4597 $letter_data{payby} = 'current method';
4599 $letter_data{expdate} = $expire_time;
4601 for (keys %{$options{extra_fields}}){
4602 $letter_data{$_} = $options{extra_fields}->{$_};
4605 unless(exists($letter_data{returnaddress})){
4606 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4607 $self->agent_template)
4609 if ( length($retadd) ) {
4610 $letter_data{returnaddress} = $retadd;
4611 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4612 $letter_data{returnaddress} =
4613 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4617 ( $conf->config('company_name', $self->agentnum),
4618 $conf->config('company_address', $self->agentnum),
4622 $letter_data{returnaddress} = '~';
4626 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4628 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4630 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4632 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4636 ) or die "can't open temp file: $!\n";
4637 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4638 or die "can't write temp file: $!\n";
4640 $letter_data{'logo_file'} = $lh->filename;
4642 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4646 ) or die "can't open temp file: $!\n";
4648 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4650 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4651 return ($1, $letter_data{'logo_file'});
4655 =item print_ps TEMPLATE
4657 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4663 my($file, $lfile) = $self->generate_letter(@_);
4664 my $ps = FS::Misc::generate_ps($file);
4665 unlink($file.'.tex');
4671 =item print TEMPLATE
4673 Prints the filled in template.
4675 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4679 sub queueable_print {
4682 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4683 or die "invalid customer number: " . $opt{custvnum};
4685 my $error = $self->print( $opt{template} );
4686 die $error if $error;
4690 my ($self, $template) = (shift, shift);
4691 do_print [ $self->print_ps($template) ];
4694 #these three subs should just go away once agent stuff is all config overrides
4696 sub agent_template {
4698 $self->_agent_plandata('agent_templatename');
4701 sub agent_invoice_from {
4703 $self->_agent_plandata('agent_invoice_from');
4706 sub _agent_plandata {
4707 my( $self, $option ) = @_;
4709 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
4710 #agent-specific Conf
4712 use FS::part_event::Condition;
4714 my $agentnum = $self->agentnum;
4716 my $regexp = regexp_sql();
4718 my $part_event_option =
4720 'select' => 'part_event_option.*',
4721 'table' => 'part_event_option',
4723 LEFT JOIN part_event USING ( eventpart )
4724 LEFT JOIN part_event_option AS peo_agentnum
4725 ON ( part_event.eventpart = peo_agentnum.eventpart
4726 AND peo_agentnum.optionname = 'agentnum'
4727 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4729 LEFT JOIN part_event_condition
4730 ON ( part_event.eventpart = part_event_condition.eventpart
4731 AND part_event_condition.conditionname = 'cust_bill_age'
4733 LEFT JOIN part_event_condition_option
4734 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4735 AND part_event_condition_option.optionname = 'age'
4738 #'hashref' => { 'optionname' => $option },
4739 #'hashref' => { 'part_event_option.optionname' => $option },
4741 " WHERE part_event_option.optionname = ". dbh->quote($option).
4742 " AND action = 'cust_bill_send_agent' ".
4743 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
4744 " AND peo_agentnum.optionname = 'agentnum' ".
4745 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
4747 CASE WHEN part_event_condition_option.optionname IS NULL
4749 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
4751 , part_event.weight".
4755 unless ( $part_event_option ) {
4756 return $self->agent->invoice_template || ''
4757 if $option eq 'agent_templatename';
4761 $part_event_option->optionvalue;
4765 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
4767 Subroutine (not a method), designed to be called from the queue.
4769 Takes a list of options and values.
4771 Pulls up the customer record via the custnum option and calls bill_and_collect.
4776 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
4778 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
4779 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
4781 $cust_main->bill_and_collect( %args );
4784 sub process_bill_and_collect {
4786 my $param = thaw(decode_base64(shift));
4787 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
4788 or die "custnum '$param->{custnum}' not found!\n";
4789 $param->{'job'} = $job;
4790 $param->{'fatal'} = 1; # runs from job queue, will be caught
4791 $param->{'retry'} = 1;
4793 $cust_main->bill_and_collect( %$param );
4796 sub _upgrade_data { #class method
4797 my ($class, %opts) = @_;
4800 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
4801 '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',
4803 # fix yyyy-m-dd formatted paydates
4804 if ( driver_name =~ /^mysql$/i ) {
4806 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
4808 else { # the SQL standard
4810 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
4813 foreach my $sql ( @statements ) {
4814 my $sth = dbh->prepare($sql) or die dbh->errstr;
4815 $sth->execute or die $sth->errstr;
4818 local($ignore_expired_card) = 1;
4819 local($ignore_illegal_zip) = 1;
4820 local($ignore_banned_card) = 1;
4821 local($skip_fuzzyfiles) = 1;
4822 $class->_upgrade_otaker(%opts);
4832 The delete method should possibly take an FS::cust_main object reference
4833 instead of a scalar customer number.
4835 Bill and collect options should probably be passed as references instead of a
4838 There should probably be a configuration file with a list of allowed credit
4841 No multiple currency support (probably a larger project than just this module).
4843 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
4845 Birthdates rely on negative epoch values.
4847 The payby for card/check batches is broken. With mixed batching, bad
4850 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
4854 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
4855 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
4856 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.